refactor: remove algorandClient getter from app client and app factory

Author: PatrickDinh

src/transaction/transaction.spec.ts

@@ -315,7 +315,7 @@ describe('transaction', () => {
         note: 'txn2',
       } satisfies Parameters<(typeof appClient1)['send']['call']>[0]
 
-      const result = await appClient1.algorand
+      const result = await appClient1
         .newGroup()
         .addAppCallMethodCall(await appClient1.params.call(txn1Params))
         .addAppCallMethodCall(await appClient1.params.call(txn2Params))
@@ -406,7 +406,7 @@ describe('transaction', () => {
       const { testAccount } = localnet.context
       const expectedFee = 8000n
 
-      const result = await appClient1.algorand
+      const result = await appClient1
         .newGroup()
         .addPayment({
           sender: testAccount.addr,
@@ -432,7 +432,7 @@ describe('transaction', () => {
 
     test('alters fee, allocating surplus fees to the most fee constrained transaction first', async () => {
       const { testAccount } = localnet.context
-      const result = await appClient1.algorand
+      const result = await appClient1
         .newGroup()
         .addAppCallMethodCall(
           await appClient1.params.call({
@@ -520,7 +520,7 @@ describe('transaction', () => {
     test('throws when maxFee is below the calculated fee', async () => {
       await expect(
         async () =>
-          await appClient1.algorand
+          await appClient1
             .newGroup()
             .addAppCallMethodCall(
               await appClient1.params.call({
@@ -581,7 +581,7 @@ describe('transaction', () => {
     test('throws when staticFee is below the calculated fee', async () => {
       await expect(
         async () =>
-          await appClient1.algorand
+          await appClient1
             .newGroup()
             .addAppCallMethodCall(
               await appClient1.params.call({
@@ -607,7 +607,7 @@ describe('transaction', () => {
       const { testAccount } = localnet.context
       await expect(
         async () =>
-          await appClient1.algorand
+          await appClient1
             .newGroup()
             .addAppCallMethodCall(
               await appClient1.params.call({
@@ -787,12 +787,12 @@ const resourcePopulationTests = (version: 8 | 9) => () => {
   let alice: Address & Account
 
   describe('accounts', () => {
-    test('addressBalance: invalid Account reference', async () => {
+    test('addressBalance: unavailable Account', async () => {
       const { testAccount } = fixture.context
       alice = testAccount
       await expect(
         appClient.send.call({ method: 'addressBalance', args: [testAccount.toString()], populateAppCallResources: false }),
-      ).rejects.toThrow('invalid Account reference')
+      ).rejects.toThrow('unavailable Account')
     })
 
     test('addressBalance', async () => {
@@ -846,7 +846,7 @@ const resourcePopulationTests = (version: 8 | 9) => () => {
   })
 
   describe('cross-product references', () => {
-    const hasAssetErrorMsg = version === 8 ? 'invalid Account reference' : 'unavailable Account'
+    const hasAssetErrorMsg = 'unavailable Account'
 
     test(`hasAsset: ${hasAssetErrorMsg}`, async () => {
       const { testAccount } = fixture.context
@@ -885,14 +885,14 @@ const resourcePopulationTests = (version: 8 | 9) => () => {
   })
 
   describe('sendTransaction', () => {
-    test('addressBalance: invalid Account reference', async () => {
+    test('addressBalance: unavailable Account', async () => {
       await expect(
         appClient.send.call({
           method: 'addressBalance',
           args: [algosdk.generateAccount().addr.toString()],
           populateAppCallResources: false,
         }),
-      ).rejects.toThrow('invalid Account reference')
+      ).rejects.toThrow('unavailable Account')
     })
 
     test('addressBalance', async () => {

src/types/app-client.spec.ts

@@ -957,14 +957,14 @@ describe('app-client', () => {
       args: ['test'],
     }
 
-    const simulateResult = await appClient.algorand
+    const simulateResult = await appClient
       .newGroup()
       .addAppCallMethodCall(appCall1Params)
       .addPayment(paymentParams)
       .addAppCallMethodCall(appCall2Params)
       .simulate({ skipSignatures: true })
 
-    const sendResult = await appClient.algorand
+    const sendResult = await appClient
       .newGroup()
       .addAppCallMethodCall(appCall1Params)
       .addPayment(paymentParams)

src/types/app-client.ts

@@ -46,14 +46,14 @@ import {
   ABIStruct,
   Arc56Contract,
   Arc56Method,
+  ProgramSourceInfo,
+  StorageKey,
+  StorageMap,
   getABIDecodedValue,
   getABIEncodedValue,
   getABITupleFromABIStruct,
   getArc56Method,
   getArc56ReturnValue,
-  ProgramSourceInfo,
-  StorageKey,
-  StorageMap,
 } from './app-arc56'
 import { AppLookup } from './app-deployer'
 import { AppManager, BoxIdentifier } from './app-manager'
@@ -69,6 +69,7 @@ import {
   AppUpdateParams,
   CommonAppCallParams,
   PaymentParams,
+  TransactionComposer,
 } from './composer'
 import { Expand } from './expand'
 import { EventType } from './lifecycle-events'
@@ -343,6 +344,7 @@ export interface AppClientParams {
   approvalSourceMap?: SourceMap
   /** Optional source map for the clear state program */
   clearSourceMap?: SourceMap
+  newGroup: () => TransactionComposer
 }
 
 /** Parameters to clone an app client */
@@ -502,6 +504,7 @@ export class AppClient {
   }
   private _lastCompiled: { clear?: Uint8Array; approval?: Uint8Array }
 
+  private _newGroup: () => TransactionComposer
   /**
    * Create a new app client.
    * @param params The parameters to create the app client
@@ -557,6 +560,7 @@ export class AppClient {
       /** Send bare (raw) transactions to the current app */
       bare: this.getBareSendMethods(),
     }
+    this._newGroup = params.newGroup
   }
 
   /**
@@ -579,6 +583,7 @@ export class AppClient {
       defaultSigner: this._defaultSigner,
       approvalSourceMap: this._approvalSourceMap,
       clearSourceMap: this._clearSourceMap,
+      newGroup: this._newGroup,
       ...params,
     })
   }
@@ -680,11 +685,6 @@ export class AppClient {
     return this._appSpec
   }
 
-  /** A reference to the underlying `AlgorandClient` this app client is using. */
-  public get algorand(): AlgorandClient {
-    return this._algorand
-  }
-
   /** Get parameters to create transactions for the current app.
    *
    * A good mental model for this is that these parameters represent a deferred transaction creation.
@@ -714,6 +714,10 @@ export class AppClient {
     return this._sendMethods
   }
 
+  public get newGroup() {
+    return this._newGroup
+  }
+
   /** Get state (local, global, box) from the current app */
   public get state() {
     return {

src/types/app-factory-and-client.spec.ts

@@ -4,12 +4,12 @@ import { afterEach, beforeAll, beforeEach, describe, expect, it, test } from 'vi
 import * as algokit from '..'
 import arc56Json from '../../tests/example-contracts/arc56_templates/artifacts/Templates.arc56_draft.json'
 import byteArraysAr56Json from '../../tests/example-contracts/byte_arrays/artifacts/ByteArrays.arc56.json'
+import deployErrorAppArc56Json from '../../tests/example-contracts/deploy_error/artifacts/DeployError.arc56.json'
 import largeAppArc56Json from '../../tests/example-contracts/extra-pages/large.arc56.json'
 import smallAppArc56Json from '../../tests/example-contracts/extra-pages/small.arc56.json'
 import errorInnerAppArc56Json from '../../tests/example-contracts/inner_error/artifacts/InnerApp.arc56.json'
 import errorMiddleAppArc56Json from '../../tests/example-contracts/inner_error/artifacts/MiddleApp.arc56.json'
 import errorOuterAppArc56Json from '../../tests/example-contracts/inner_error/artifacts/OuterApp.arc56.json'
-import deployErrorAppArc56Json from '../../tests/example-contracts/deploy_error/artifacts/DeployError.arc56.json'
 import nestedStruct from '../../tests/example-contracts/nested_struct/artifacts/NestedStruct.arc56.json'
 import { getTestingAppContract } from '../../tests/example-contracts/testing-app/contract'
 import { algoKitLogCaptureFixture, algorandFixture } from '../testing'
@@ -832,7 +832,7 @@ describe('ARC56: app-factory-and-app-client', () => {
 
     try {
       // Don't use the app client to call, but since we've instantiated one the error transformer should be registered
-      await appClient.algorand
+      await appClient
         .newGroup()
         .addAppCallMethodCall({ appId: appClient.appId, method: appClient.getABIMethod('throwError')!, sender: testAccount })
         .send()

src/types/app-factory.ts

@@ -217,11 +217,6 @@ export class AppFactory {
     return this._appSpec
   }
 
-  /** Return the algorand client this factory is using. */
-  get algorand() {
-    return this._algorand
-  }
-
   /** Get parameters to create transactions (create and deploy related calls) for the current app.
    *
    * A good mental model for this is that these parameters represent a deferred transaction creation.
@@ -293,6 +288,7 @@ export class AppFactory {
         return {
           appClient: this.getAppClientById({
             appId: result.appId,
+            newGroup: () => this._algorand.newGroup(),
           }),
           result: {
             ...result,
@@ -324,6 +320,7 @@ export class AppFactory {
       return {
         appClient: this.getAppClientById({
           appId: result.appId,
+          newGroup: () => this._algorand.newGroup(),
         }),
         result: {
           ...result,
@@ -376,7 +373,10 @@ export class AppFactory {
 
     // Compile using a appID 0 AppClient so we can register the error handler and use the programs
     // to identify the app within the error handler (because we can't use app ID 0)
-    const tempAppClient = this.getAppClientById({ appId: 0n })
+    const tempAppClient = this.getAppClientById({
+      appId: 0n,
+      newGroup: this._algorand.newGroup,
+    })
     const compiled = await tempAppClient.compile({ deployTimeParams, updatable, deletable })
 
     const deployResult = await this._algorand.appDeployer.deploy({
@@ -402,6 +402,7 @@ export class AppFactory {
     const appClient = this.getAppClientById({
       appId: deployResult.appId,
       appName: params.appName,
+      newGroup: () => this._algorand.newGroup(),
     })
     const result = {
       ...deployResult,

src/types/client-manager.ts

@@ -27,7 +27,7 @@ export type ClientAppFactoryParams = Expand<Omit<AppFactoryParams, 'algorand'>>
 export type ClientResolveAppClientByCreatorAndNameParams = Expand<Omit<ResolveAppClientByCreatorAndName, 'algorand'>>
 
 /** Params to get an app client by ID from `ClientManager`. */
-export type ClientAppClientParams = Expand<Omit<AppClientParams, 'algorand'>>
+export type ClientAppClientParams = Expand<Omit<AppClientParams, 'algorand' | 'newGroup'>>
 
 /** Params to get an app client by network from `ClientManager`. */
 export type ClientAppClientByNetworkParams = Expand<Omit<AppClientParams, 'algorand' | 'appId'>>
@@ -308,7 +308,7 @@ export class ClientManager {
     if (!this._algorand) {
       throw new Error('Attempt to get app client from a ClientManager without an Algorand client')
     }
-    return new AppClient({ ...params, algorand: this._algorand })
+    return new AppClient({ ...params, algorand: this._algorand, newGroup: () => this._algorand!.newGroup() })
   }
 
   /**
@@ -413,7 +413,7 @@ export class ClientManager {
       throw new Error('Attempt to get app client from a ClientManager without an Algorand client')
     }
 
-    return typedClient.fromNetwork({ ...params, algorand: this._algorand })
+    return typedClient.fromNetwork({ ...params, algorand: this._algorand, newGroup: () => this._algorand!.newGroup() })
   }
 
   /**