@algorandfoundation/algokit-utils 7.0.0-beta.2 → 7.0.0-beta.20

package/types/client-manager.mjs

@@ -1,6 +1,7 @@
 import algosdk from 'algosdk';
 import { AlgoHttpClientWithRetry } from './algo-http-client-with-retry.mjs';
-import { ApplicationClient } from './app-client.mjs';
+import { AppClient } from './app-client.mjs';
+import { AppFactory } from './app-factory.mjs';
 import { TestNetDispenserApiClient } from './dispenser-client.mjs';
 import { genesisIdIsLocalNet } from './network-client.mjs';
 
@@ -29,7 +30,7 @@ class ClientManager {
      * const clientManager = new ClientManager({ algodConfig, indexerConfig, kmdConfig })
      * ```
      */
-    constructor(clientsOrConfig) {
+    constructor(clientsOrConfig, algorandClient) {
         const _clients = 'algod' in clientsOrConfig
             ? clientsOrConfig
             : {
@@ -40,6 +41,7 @@ class ClientManager {
         this._algod = _clients.algod;
         this._indexer = _clients.indexer;
         this._kmd = _clients.kmd;
+        this._algorand = algorandClient;
     }
     /** Returns an algosdk Algod API client. */
     get algod() {
@@ -150,32 +152,105 @@ class ClientManager {
         return new TestNetDispenserApiClient(params ? { ...params, authToken: '' } : undefined);
     }
     /**
-     * Returns a new `ApplicationClient` client, resolving the app by creator address and name.
-     * @param details The details to resolve the app by creator address and name
-     * @param cachedAppLookup A cached app lookup that matches a name to on-chain details; either this is needed or indexer is required to be passed in to this manager on construction.
-     * @returns The `ApplicationClient`
+     * Returns a new `AppFactory` client
+     * @example Basic example
+     * ```typescript
+     * const factory = algorand.client.getAppFactory({
+     *   appSpec: '{/* ARC-56 or ARC-32 compatible JSON *\/}',
+     * })
+     * ```
+     * @example Advanced example
+     * ```typescript
+     * const factory = algorand.client.getAppFactory({
+     *   appSpec: parsedAppSpec_AppSpec_or_Arc56Contract,
+     *   defaultSender: "SENDERADDRESS",
+     *   appName: "OverriddenAppName",
+     *   version: "2.0.0",
+     *   updatable: true,
+     *   deletable: false,
+     *   deployTimeParams: { ONE: 1, TWO: 'value' }
+     * })
+     * ```
      */
-    getAppClientByCreatorAndName(details, cachedAppLookup) {
-        return new ApplicationClient({ ...details, resolveBy: 'creatorAndName', findExistingUsing: cachedAppLookup ?? this.indexer }, this._algod);
+    getAppFactory(params) {
+        if (!this._algorand) {
+            throw new Error('Attempt to get app factory from a ClientManager without an Algorand client');
+        }
+        return new AppFactory({ ...params, algorand: this._algorand });
     }
     /**
-     * Returns a new `ApplicationClient` client, resolving the app by app ID.
-     * @param details The details to resolve the app by ID
-     * @returns The `ApplicationClient`
+     * Returns a new `AppClient` client for managing calls and state for an ARC-32/ARC-56 app.
+     * This method resolves the app ID by looking up the creator address and name
+     * using AlgoKit app deployment semantics (i.e. looking for the app creation transaction note).
+     * @param params The parameters to create the app client
+     * @example Basic
+     * ```typescript
+     * const appClient = algorand.client.getAppClientByCreatorAndName({
+     *   appSpec: '{/* ARC-56 or ARC-32 compatible JSON *\}',
+     *   // appId resolved by looking for app ID of named app by this creator
+     *   creatorAddress: 'CREATORADDRESS',
+     * })
+     * ```
+     * @returns The `AppClient`
+     */
+    getAppClientByCreatorAndName(params) {
+        if (!this._algorand) {
+            throw new Error('Attempt to get app client from a ClientManager without an Algorand client');
+        }
+        return AppClient.fromCreatorAndName({
+            ...params,
+            algorand: this._algorand,
+        });
+    }
+    /**
+     * Returns a new `AppClient` client for managing calls and state for an ARC-32/ARC-56 app.
+     * @param params The parameters to create the app client
+     * @example Basic
+     * ```typescript
+     * const appClient = algorand.client.getAppClientById({
+     *   appSpec: '{/* ARC-56 or ARC-32 compatible JSON *\}',
+     *   appId: 12345n,
+     * })
+     * ```
+     * @returns The `AppClient`
+     */
+    getAppClientById(params) {
+        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 });
+    }
+    /**
+     * Returns a new `AppClient` client for managing calls and state for an ARC-56 app.
+     * This method resolves the app ID for the current network based on
+     * pre-determined network-specific app IDs specified in the ARC-56 app spec.
+     *
+     * If no IDs are in the app spec or the network isn't recognised, an error is thrown.
+     * @param params The parameters to create the app client
+     * @example Basic
+     * ```typescript
+     * const appClient = algorand.client.getAppClientByNetwork({
+     *   appSpec: '{/* ARC-56 or ARC-32 compatible JSON *\}',
+     *   // appId resolved by using ARC-56 spec to find app ID for current network
+     * })
+     * ```
+     * @returns The `AppClient`
      */
-    getAppClientById(details) {
-        return new ApplicationClient({ ...details, resolveBy: 'id' }, this._algod);
+    async getAppClientByNetwork(params) {
+        if (!this._algorand) {
+            throw new Error('Attempt to get app client from a ClientManager without an Algorand client');
+        }
+        return AppClient.fromNetwork({ ...params, algorand: this._algorand });
     }
     /**
      * Returns a new typed client, resolving the app by creator address and name.
      * @param typedClient The typed client type to use
-     * @param details The details to resolve the app by creator address and name
-     * @param cachedAppLookup A cached app lookup that matches a name to on-chain details; either this is needed or indexer is required to be passed in to this manager on construction.
-     * @example Use name in ARC-32 app spec
+     * @param params The params to resolve the app by creator address and name
+     * @example Use name in ARC-32 / ARC-56 app spec
      * ```typescript
      * const appClient = algorand.client.getTypedAppClientByCreatorAndName(MyContractClient, {
      *   creatorAddress: "CREATORADDRESS",
-     *   sender: alice,
+     *   defaultSender: alice,
      * })
      * ```
      * @example Specify name
@@ -183,29 +258,74 @@ class ClientManager {
      * const appClient = algorand.client.getTypedAppClientByCreatorAndName(MyContractClient, {
      *   creatorAddress: "CREATORADDRESS",
      *   name: "contract-name",
-     *   sender: alice,
+     *   defaultSender: alice,
      * })
      * ```
      * @returns The typed client instance
      */
-    getTypedAppClientByCreatorAndName(typedClient, details, cachedAppLookup) {
-        return new typedClient({ ...details, resolveBy: 'creatorAndName', findExistingUsing: cachedAppLookup ?? this.indexer }, this._algod);
+    async getTypedAppClientByCreatorAndName(typedClient, params) {
+        if (!this._algorand) {
+            throw new Error('Attempt to get app client from a ClientManager without an Algorand client');
+        }
+        return typedClient.fromCreatorAndName({ ...params, algorand: this._algorand });
     }
     /**
      * Returns a new typed client, resolving the app by app ID.
      * @param typedClient The typed client type to use
-     * @param details The details to resolve the app by ID
+     * @param params The params to resolve the app by ID
      * @example
      * ```typescript
      * const appClient = algorand.client.getTypedAppClientById(MyContractClient, {
-     *   id: 12345,
+     *   appId: 12345n,
+     *   defaultSender: alice,
+     * })
+     * ```
+     * @returns The typed client instance
+     */
+    getTypedAppClientById(typedClient, params) {
+        if (!this._algorand) {
+            throw new Error('Attempt to get app client from a ClientManager without an Algorand client');
+        }
+        return new typedClient({ ...params, algorand: this._algorand });
+    }
+    /**
+     * Returns a new typed client, resolves the app ID for the current network based on
+     * pre-determined network-specific app IDs specified in the ARC-56 app spec.
+     *
+     * If no IDs are in the app spec or the network isn't recognised, an error is thrown.
+     * @param typedClient The typed client type to use
+     * @param params The params to resolve the app by network
+     * @example
+     * ```typescript
+     * const appClient = algorand.client.getTypedAppClientByNetwork(MyContractClient, {
+     *   defaultSender: alice,
+     * })
+     * ```
+     * @returns The typed client instance
+     */
+    getTypedAppClientByNetwork(typedClient, params) {
+        if (!this._algorand) {
+            throw new Error('Attempt to get app client from a ClientManager without an Algorand client');
+        }
+        return typedClient.fromNetwork({ ...params, algorand: this._algorand });
+    }
+    /**
+     * Returns a new typed app factory.
+     * @param typedFactory The typed factory type to use
+     * @param params The params to resolve the factory by
+     * @example
+     * ```typescript
+     * const appFactory = algorand.client.getTypedAppFactory(MyContractClient, {
      *   sender: alice,
      * })
      * ```
      * @returns The typed client instance
      */
-    getTypedAppClientById(typedClient, details) {
-        return new typedClient({ ...details, resolveBy: 'id' }, this._algod);
+    getTypedAppFactory(typedFactory, params) {
+        if (!this._algorand) {
+            throw new Error('Attempt to get app factory from a ClientManager without an Algorand client');
+        }
+        return new typedFactory({ ...params, algorand: this._algorand });
     }
     /**
      * Retrieve client configurations from environment variables when defined or get defaults (expects to be called from a Node.js environment)

package/types/client-manager.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"client-manager.mjs","sources":["../../src/types/client-manager.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;AAcA,IAAO,GAAG,GAAG,OAAO,CAAC,GAAG,CAAA;AACxB,IAAO,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;AAEhC,IAAO,WAAW,GAAG,OAAO,CAAC,WAAW,CAAA;AA0BxC;MACa,aAAa,CAAA;AAKxB;;;;;;;;;;;;;;;;;;;AAmBG;AACH,IAAA,WAAA,CAAY,eAA4C,EAAA;AACtD,QAAA,MAAM,QAAQ,GACZ,OAAO,IAAI,eAAe;AACxB,cAAE,eAAe;AACjB,cAAE;gBACE,KAAK,EAAE,aAAa,CAAC,cAAc,CAAC,eAAe,CAAC,WAAW,CAAC;AAChE,gBAAA,OAAO,EAAE,eAAe,CAAC,aAAa,GAAG,aAAa,CAAC,gBAAgB,CAAC,eAAe,CAAC,aAAa,CAAC,GAAG,SAAS;AAClH,gBAAA,GAAG,EAAE,eAAe,CAAC,SAAS,GAAG,aAAa,CAAC,YAAY,CAAC,eAAe,CAAC,SAAS,CAAC,GAAG,SAAS;aACnG,CAAA;AACP,QAAA,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAA;AAC5B,QAAA,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAA;AAChC,QAAA,IAAI,CAAC,IAAI,GAAG,QAAQ,CAAC,GAAG,CAAA;KACzB;;AAGD,IAAA,IAAW,KAAK,GAAA;QACd,OAAO,IAAI,CAAC,MAAM,CAAA;KACnB;;AAGD,IAAA,IAAW,OAAO,GAAA;QAChB,IAAI,CAAC,IAAI,CAAC,QAAQ;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,8EAA8E,CAAC,CAAA;QACnH,OAAO,IAAI,CAAC,QAAQ,CAAA;KACrB;;AAGD,IAAA,IAAW,gBAAgB,GAAA;QACzB,OAAO,IAAI,CAAC,QAAQ,CAAA;KACrB;;AAGD,IAAA,IAAW,GAAG,GAAA;QACZ,IAAI,CAAC,IAAI,CAAC,IAAI;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,sEAAsE,CAAC,CAAA;QACvG,OAAO,IAAI,CAAC,IAAI,CAAA;KACjB;AAGD;;;;;;;;AAQG;AACI,IAAA,MAAM,OAAO,GAAA;AAClB,QAAA,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE;AAC5B,YAAA,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,MAAM,CAAC,oBAAoB,EAAE,CAAC,EAAE,EAAE,CAAA;SAClE;AAED,QAAA,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAA;QAC5C,OAAO;AACL,YAAA,SAAS,EAAE,CAAC,cAAc,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC;AAC/E,YAAA,SAAS,EAAE,CAAC,cAAc,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC;YAC/E,UAAU,EAAE,aAAa,CAAC,mBAAmB,CAAC,MAAM,CAAC,SAAS,CAAC;YAC/D,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,WAAW,EAAE,MAAM,CAAC,WAAW;SAChC,CAAA;KACF;AAED;;;;AAIG;IACI,OAAO,mBAAmB,CAAC,SAAiB,EAAA;AACjD,QAAA,OAAO,mBAAmB,CAAC,SAAS,CAAC,CAAA;KACtC;AAED;;;AAGG;AACI,IAAA,MAAM,UAAU,GAAA;QACrB,OAAO,CAAC,MAAM,IAAI,CAAC,OAAO,EAAE,EAAE,UAAU,CAAA;KACzC;AAED;;;AAGG;AACI,IAAA,MAAM,SAAS,GAAA;QACpB,OAAO,CAAC,MAAM,IAAI,CAAC,OAAO,EAAE,EAAE,SAAS,CAAA;KACxC;AAED;;;AAGG;AACI,IAAA,MAAM,SAAS,GAAA;QACpB,OAAO,CAAC,MAAM,IAAI,CAAC,OAAO,EAAE,EAAE,SAAS,CAAA;KACxC;AAED;;;;;;;;;;;;;;;AAeG;AACI,IAAA,mBAAmB,CAAC,MAAuC,EAAA;AAChE,QAAA,OAAO,IAAI,yBAAyB,CAAC,MAAM,CAAC,CAAA;KAC7C;AAED;;;;;;;;;;;;;;AAcG;AACI,IAAA,kCAAkC,CAAC,MAA2D,EAAA;QACnG,OAAO,IAAI,yBAAyB,CAAC,MAAM,GAAG,EAAE,GAAG,MAAM,EAAE,SAAS,EAAE,EAAE,EAAE,GAAG,SAAS,CAAC,CAAA;KACxF;AAED;;;;;AAKG;IACI,4BAA4B,CAAC,OAAyC,EAAE,eAA2B,EAAA;QACxG,OAAO,IAAI,iBAAiB,CAC1B,EAAE,GAAG,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,eAAe,IAAI,IAAI,CAAC,OAAO,EAAE,EAC/F,IAAI,CAAC,MAAM,CACZ,CAAA;KACF;AAED;;;;AAIG;AACI,IAAA,gBAAgB,CAAC,OAA6B,EAAA;AACnD,QAAA,OAAO,IAAI,iBAAiB,CAAC,EAAE,GAAG,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;KAC3E;AAED;;;;;;;;;;;;;;;;;;;;;AAqBG;AACI,IAAA,iCAAiC,CACtC,WAAoC,EACpC,OAA8C,EAC9C,eAA2B,EAAA;QAE3B,OAAO,IAAI,WAAW,CAAC,EAAE,GAAG,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,eAAe,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;KACrI;AAED;;;;;;;;;;;;AAYG;IACI,qBAAqB,CAAU,WAAoC,EAAE,OAAkC,EAAA;AAC5G,QAAA,OAAO,IAAI,WAAW,CAAC,EAAE,GAAG,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;KACrE;AAED;;;;;;;;;;;;;;;;AAgBG;AACI,IAAA,OAAO,kCAAkC,GAAA;QAC9C,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE;AAC5B,YAAA,MAAM,IAAI,KAAK,CAAC,mGAAmG,CAAC,CAAA;SACrH;AACD,QAAA,MAAM,CAAC,WAAW,EAAE,aAAa,EAAE,SAAS,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,YAAY;AACtE,cAAE;gBACE,aAAa,CAAC,6BAA6B,EAAE;AAC7C,gBAAA,OAAO,CAAC,GAAG,CAAC,cAAc,GAAG,aAAa,CAAC,+BAA+B,EAAE,GAAG,SAAS;gBACxF,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC;AAC5F,sBAAE,EAAE,GAAG,aAAa,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,IAAI,MAAM,EAAE;AAC9F,sBAAE,SAAS;AACd,aAAA;AACH,cAAE;AACE,gBAAA,aAAa,CAAC,wBAAwB,CAAC,OAAO,CAAC;AAC/C,gBAAA,aAAa,CAAC,wBAAwB,CAAC,SAAS,CAAC;AACjD,gBAAA,aAAa,CAAC,wBAAwB,CAAC,KAAK,CAAC;aAC9C,CAAA;QAEL,OAAO;YACL,WAAW;YACX,aAAa;YACb,SAAS;SACV,CAAA;KACF;AAED;;;AAGG;AACI,IAAA,OAAO,6BAA6B,GAAA;QACzC,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE;AAC5B,YAAA,MAAM,IAAI,KAAK,CAAC,kGAAkG,CAAC,CAAA;SACpH;AAED,QAAA,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE;AAC7B,YAAA,MAAM,IAAI,KAAK,CAAC,yGAAyG,CAAC,CAAA;SAC3H;QAED,OAAO;AACL,YAAA,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,YAAY;AAChC,YAAA,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,UAAU;AAC5B,YAAA,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,WAAW;SAC/B,CAAA;KACF;AAED;;;;AAIG;AACI,IAAA,OAAO,+BAA+B,GAAA;QAC3C,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE;AAC5B,YAAA,MAAM,IAAI,KAAK,CAAC,oGAAoG,CAAC,CAAA;SACtH;AAED,QAAA,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE;AAC/B,YAAA,MAAM,IAAI,KAAK,CAAC,6GAA6G,CAAC,CAAA;SAC/H;QAED,OAAO;AACL,YAAA,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,cAAc;AAClC,YAAA,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,YAAY;AAC9B,YAAA,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,aAAa;SACjC,CAAA;KACF;AAED;;;;AAIG;AACI,IAAA,OAAO,iBAAiB,CAAC,OAA8B,EAAE,MAA2B,EAAA;QACzF,OAAO;AACL,YAAA,MAAM,EAAE,CAAA,QAAA,EAAW,OAAO,CAAA,CAAA,EAAI,MAAM,KAAK,OAAO,GAAG,KAAK,GAAG,KAAK,CAAkB,gBAAA,CAAA;AAClF,YAAA,IAAI,EAAE,GAAG;SACV,CAAA;KACF;AAED;;;AAGG;IACI,OAAO,wBAAwB,CAAC,YAAkD,EAAA;QACvF,OAAO;AACL,YAAA,MAAM,EAAE,CAAkB,gBAAA,CAAA;AAC1B,YAAA,IAAI,EAAE,YAAY,KAAK,OAAO,GAAG,IAAI,GAAG,YAAY,KAAK,SAAS,GAAG,IAAI,GAAG,YAAY,KAAK,KAAK,GAAG,IAAI,GAAG,YAAY;AACxH,YAAA,KAAK,EAAE,kEAAkE;SAC1E,CAAA;KACF;AAED;;;;;;;;;;;;;;;;;;;AAmBG;IACI,OAAO,cAAc,CAAC,MAAwB,EAAA;QACnD,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,CAAA;QACtC,MAAM,WAAW,GAAG,OAAO,KAAK,KAAK,QAAQ,GAAG,EAAE,kBAAkB,EAAE,KAAK,EAAE,GAAG,KAAK,IAAI,EAAE,CAAA;QAC3F,MAAM,mBAAmB,GAAG,IAAI,uBAAuB,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,CAAC,CAAA;QAClF,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAA;KACxD;AAED;;;;;;;;;AASG;AACI,IAAA,OAAO,6BAA6B,GAAA;QACzC,OAAO,aAAa,CAAC,cAAc,CAAC,aAAa,CAAC,6BAA6B,EAAE,CAAC,CAAA;KACnF;AAED;;;;;;;;;;;;;;;;;;;;;;;;AAwBG;AACI,IAAA,OAAO,gBAAgB,CAAC,MAAwB,EAAE,mBAAiC,EAAA;QACxF,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,CAAA;QACtC,MAAM,WAAW,GAAG,OAAO,KAAK,KAAK,QAAQ,GAAG,EAAE,qBAAqB,EAAE,KAAK,EAAE,GAAG,KAAK,IAAI,EAAE,CAAA;QAC9F,MAAM,mBAAmB,GAAG,IAAI,uBAAuB,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,CAAC,CAAA;AAClF,QAAA,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,mBAAmB,CAAC,CAAA;;QAEhD,OAAO,CAAC,cAAc,CAAC,mBAAmB,IAAI,WAAW,CAAC,KAAK,CAAC,CAAA;AAChE,QAAA,OAAO,OAAO,CAAA;KACf;AAED;;;;;;;;;;;AAWG;IACI,OAAO,+BAA+B,CAAC,mBAAiC,EAAA;QAC7E,OAAO,aAAa,CAAC,gBAAgB,CAAC,aAAa,CAAC,+BAA+B,EAAE,EAAE,mBAAmB,CAAC,CAAA;KAC5G;AAED;;;;;;;;;;AAUG;IACI,OAAO,YAAY,CAAC,MAAwB,EAAA;QACjD,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,CAAA;QACtC,OAAO,IAAI,GAAG,CAAC,KAAe,EAAE,MAAM,EAAE,IAAI,CAAC,CAAA;KAC9C;AAED;;;;;;;;AAQG;AACI,IAAA,OAAO,2BAA2B,GAAA;;;QAGvC,OAAO,aAAa,CAAC,YAAY,CAAC,EAAE,GAAG,aAAa,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,IAAI,MAAM,EAAE,CAAC,CAAA;KAChI;AACF;;;;"}
+{"version":3,"file":"client-manager.mjs","sources":["../../src/types/client-manager.ts"],"sourcesContent":["import algosdk from 'algosdk'\nimport { SuggestedParamsWithMinFee } from 'algosdk/dist/types/types/transactions/base'\nimport { AlgoHttpClientWithRetry } from './algo-http-client-with-retry'\nimport { AlgorandClientInterface } from './algorand-client-interface'\nimport { AppClient, AppClientParams, ResolveAppClientByCreatorAndName } from './app-client'\nimport { AppFactory, AppFactoryParams } from './app-factory'\nimport { TestNetDispenserApiClient, TestNetDispenserApiClientParams } from './dispenser-client'\nimport { Expand } from './expand'\nimport { AlgoClientConfig, AlgoConfig, NetworkDetails, genesisIdIsLocalNet } from './network-client'\nimport Kmd = algosdk.Kmd\nimport Indexer = algosdk.Indexer\nimport Algodv2 = algosdk.Algodv2\nimport IntDecoding = algosdk.IntDecoding\n\n/** Clients from algosdk that interact with the official Algorand APIs */\nexport interface AlgoSdkClients {\n  /** Algod client, see https://developer.algorand.org/docs/rest-apis/algod/ */\n  algod: algosdk.Algodv2\n  /** Optional indexer client, see https://developer.algorand.org/docs/rest-apis/indexer/ */\n  indexer?: algosdk.Indexer\n  /** Optional KMD client, see https://developer.algorand.org/docs/rest-apis/kmd/ */\n  kmd?: algosdk.Kmd\n}\n\n/** Params to get an app factory from `ClientManager`. */\nexport type ClientAppFactoryParams = Expand<Omit<AppFactoryParams, 'algorand'>>\n\n/** Params to get an app client by creator address and name from `ClientManager`. */\nexport type ClientResolveAppClientByCreatorAndNameParams = Expand<Omit<ResolveAppClientByCreatorAndName, 'algorand'>>\n\n/** Params to get an app client by ID from `ClientManager`. */\nexport type ClientAppClientParams = Expand<Omit<AppClientParams, 'algorand'>>\n\n/** Params to get an app client by network from `ClientManager`. */\nexport type ClientAppClientByNetworkParams = Expand<Omit<AppClientParams, 'algorand' | 'appId'>>\n\n/** Params to get a typed app client by creator address and name from `ClientManager`. */\nexport type ClientTypedAppClientByCreatorAndNameParams = Expand<Omit<ResolveAppClientByCreatorAndName, 'algorand' | 'appSpec'>>\n\n/** Params to get a typed app client by ID from `ClientManager`. */\nexport type ClientTypedAppClientParams = Expand<Omit<AppClientParams, 'algorand' | 'appSpec'>>\n\n/** Params to get a typed app client by network from `ClientManager`. */\nexport type ClientTypedAppClientByNetworkParams = Expand<Omit<AppClientParams, 'algorand' | 'appSpec' | 'appId'>>\n\n/** Params to get a typed app factory from `ClientManager`. */\nexport type ClientTypedAppFactoryParams = Expand<Omit<AppFactoryParams, 'algorand' | 'appSpec'>>\n\n/** Exposes access to various API clients. */\nexport class ClientManager {\n  private _algod: algosdk.Algodv2\n  private _indexer?: algosdk.Indexer\n  private _kmd?: algosdk.Kmd\n  private _algorand?: AlgorandClientInterface\n\n  /**\n   * algosdk clients or config for interacting with the official Algorand APIs.\n   * @param clientsOrConfig The clients or config to use\n   * @example Algod client only\n   * ```typescript\n   * const clientManager = new ClientManager({ algod: algodClient })\n   * ```\n   * @example All clients\n   * ```typescript\n   * const clientManager = new ClientManager({ algod: algodClient, indexer: indexerClient, kmd: kmdClient })\n   * ```\n   * @example Algod config only\n   * ```typescript\n   * const clientManager = new ClientManager({ algodConfig })\n   * ```\n   * @example All client configs\n   * ```typescript\n   * const clientManager = new ClientManager({ algodConfig, indexerConfig, kmdConfig })\n   * ```\n   */\n  constructor(clientsOrConfig: AlgoConfig | AlgoSdkClients, algorandClient?: AlgorandClientInterface) {\n    const _clients =\n      'algod' in clientsOrConfig\n        ? clientsOrConfig\n        : {\n            algod: ClientManager.getAlgodClient(clientsOrConfig.algodConfig),\n            indexer: clientsOrConfig.indexerConfig ? ClientManager.getIndexerClient(clientsOrConfig.indexerConfig) : undefined,\n            kmd: clientsOrConfig.kmdConfig ? ClientManager.getKmdClient(clientsOrConfig.kmdConfig) : undefined,\n          }\n    this._algod = _clients.algod\n    this._indexer = _clients.indexer\n    this._kmd = _clients.kmd\n    this._algorand = algorandClient\n  }\n\n  /** Returns an algosdk Algod API client. */\n  public get algod(): algosdk.Algodv2 {\n    return this._algod\n  }\n\n  /** Returns an algosdk Indexer API client or throws an error if it's not been provided. */\n  public get indexer(): algosdk.Indexer {\n    if (!this._indexer) throw new Error('Attempt to use Indexer client in AlgoKit instance with no Indexer configured')\n    return this._indexer\n  }\n\n  /** Returns an algosdk Indexer API client or `undefined` if it's not been provided. */\n  public get indexerIfPresent(): algosdk.Indexer | undefined {\n    return this._indexer\n  }\n\n  /** Returns an algosdk KMD API client or throws an error if it's not been provided. */\n  public get kmd(): algosdk.Kmd {\n    if (!this._kmd) throw new Error('Attempt to use Kmd client in AlgoKit instance with no Kmd configured')\n    return this._kmd\n  }\n\n  private _getNetworkPromise: Promise<SuggestedParamsWithMinFee> | undefined\n  /**\n   * Get details about the current network.\n   * @example Getting genesis ID\n   * ```typescript\n   * const network = await networkClient.network()\n   * const genesisId = network.genesisId\n   * ```\n   * @returns The current network details\n   */\n  public async network(): Promise<NetworkDetails> {\n    if (!this._getNetworkPromise) {\n      this._getNetworkPromise = this._algod.getTransactionParams().do()\n    }\n\n    const params = await this._getNetworkPromise\n    return {\n      isTestNet: ['testnet-v1.0', 'testnet-v1', 'testnet'].includes(params.genesisID),\n      isMainNet: ['mainnet-v1.0', 'mainnet-v1', 'mainnet'].includes(params.genesisID),\n      isLocalNet: ClientManager.genesisIdIsLocalNet(params.genesisID),\n      genesisId: params.genesisID,\n      genesisHash: params.genesisHash,\n    }\n  }\n\n  /**\n   * Returns true if the given network genesisId is associated with a LocalNet network.\n   * @param genesisId The network genesis ID\n   * @returns Whether the given genesis ID is associated with a LocalNet network\n   */\n  public static genesisIdIsLocalNet(genesisId: string) {\n    return genesisIdIsLocalNet(genesisId)\n  }\n\n  /**\n   * Returns true if the current network is LocalNet.\n   * @returns True if the current network is LocalNet.\n   */\n  public async isLocalNet() {\n    return (await this.network()).isLocalNet\n  }\n\n  /**\n   * Returns true if the current network is TestNet.\n   * @returns True if the current network is TestNet.\n   */\n  public async isTestNet() {\n    return (await this.network()).isTestNet\n  }\n\n  /**\n   * Returns true if the current network is MainNet.\n   * @returns True if the current network is MainNet.\n   */\n  public async isMainNet() {\n    return (await this.network()).isMainNet\n  }\n\n  /**\n   * Returns a TestNet Dispenser API client.\n   *\n   * Refer to [docs](https://github.com/algorandfoundation/algokit/blob/main/docs/testnet_api.md) on guidance to obtain an access token.\n   *\n   * @param params An object containing parameters for the TestNetDispenserApiClient class.\n   * @example\n   * const client = clientManager.getTestNetDispenser(\n   *     {\n   *       authToken: 'your_auth_token',\n   *       requestTimeout: 15,\n   *     }\n   * )\n   *\n   * @returns An instance of the TestNetDispenserApiClient class.\n   */\n  public getTestNetDispenser(params: TestNetDispenserApiClientParams) {\n    return new TestNetDispenserApiClient(params)\n  }\n\n  /**\n   * Returns a TestNet Dispenser API client, loading the auth token from `process.env.ALGOKIT_DISPENSER_ACCESS_TOKEN`.\n   *\n   * Refer to [docs](https://github.com/algorandfoundation/algokit/blob/main/docs/testnet_api.md) on guidance to obtain an access token.\n   *\n   * @param params An object containing parameters for the TestNetDispenserApiClient class.\n   * @example\n   * const client = clientManager.getTestNetDispenserFromEnvironment(\n   *     {\n   *       requestTimeout: 15,\n   *     }\n   * )\n   *\n   * @returns An instance of the TestNetDispenserApiClient class.\n   */\n  public getTestNetDispenserFromEnvironment(params?: Omit<TestNetDispenserApiClientParams, 'authToken'>) {\n    return new TestNetDispenserApiClient(params ? { ...params, authToken: '' } : undefined)\n  }\n\n  /**\n   * Returns a new `AppFactory` client\n   * @example Basic example\n   * ```typescript\n   * const factory = algorand.client.getAppFactory({\n   *   appSpec: '{/* ARC-56 or ARC-32 compatible JSON *\\/}',\n   * })\n   * ```\n   * @example Advanced example\n   * ```typescript\n   * const factory = algorand.client.getAppFactory({\n   *   appSpec: parsedAppSpec_AppSpec_or_Arc56Contract,\n   *   defaultSender: \"SENDERADDRESS\",\n   *   appName: \"OverriddenAppName\",\n   *   version: \"2.0.0\",\n   *   updatable: true,\n   *   deletable: false,\n   *   deployTimeParams: { ONE: 1, TWO: 'value' }\n   * })\n   * ```\n   */\n  public getAppFactory(params: ClientAppFactoryParams) {\n    if (!this._algorand) {\n      throw new Error('Attempt to get app factory from a ClientManager without an Algorand client')\n    }\n\n    return new AppFactory({ ...params, algorand: this._algorand })\n  }\n\n  /**\n   * Returns a new `AppClient` client for managing calls and state for an ARC-32/ARC-56 app.\n   * This method resolves the app ID by looking up the creator address and name\n   * using AlgoKit app deployment semantics (i.e. looking for the app creation transaction note).\n   * @param params The parameters to create the app client\n   * @example Basic\n   * ```typescript\n   * const appClient = algorand.client.getAppClientByCreatorAndName({\n   *   appSpec: '{/* ARC-56 or ARC-32 compatible JSON *\\}',\n   *   // appId resolved by looking for app ID of named app by this creator\n   *   creatorAddress: 'CREATORADDRESS',\n   * })\n   * ```\n   * @returns The `AppClient`\n   */\n  public getAppClientByCreatorAndName(params: ClientResolveAppClientByCreatorAndNameParams) {\n    if (!this._algorand) {\n      throw new Error('Attempt to get app client from a ClientManager without an Algorand client')\n    }\n\n    return AppClient.fromCreatorAndName({\n      ...params,\n      algorand: this._algorand,\n    })\n  }\n\n  /**\n   * Returns a new `AppClient` client for managing calls and state for an ARC-32/ARC-56 app.\n   * @param params The parameters to create the app client\n   * @example Basic\n   * ```typescript\n   * const appClient = algorand.client.getAppClientById({\n   *   appSpec: '{/* ARC-56 or ARC-32 compatible JSON *\\}',\n   *   appId: 12345n,\n   * })\n   * ```\n   * @returns The `AppClient`\n   */\n  public getAppClientById(params: ClientAppClientParams) {\n    if (!this._algorand) {\n      throw new Error('Attempt to get app client from a ClientManager without an Algorand client')\n    }\n    return new AppClient({ ...params, algorand: this._algorand })\n  }\n\n  /**\n   * Returns a new `AppClient` client for managing calls and state for an ARC-56 app.\n   * This method resolves the app ID for the current network based on\n   * pre-determined network-specific app IDs specified in the ARC-56 app spec.\n   *\n   * If no IDs are in the app spec or the network isn't recognised, an error is thrown.\n   * @param params The parameters to create the app client\n   * @example Basic\n   * ```typescript\n   * const appClient = algorand.client.getAppClientByNetwork({\n   *   appSpec: '{/* ARC-56 or ARC-32 compatible JSON *\\}',\n   *   // appId resolved by using ARC-56 spec to find app ID for current network\n   * })\n   * ```\n   * @returns The `AppClient`\n   */\n  public async getAppClientByNetwork(params: ClientAppClientByNetworkParams) {\n    if (!this._algorand) {\n      throw new Error('Attempt to get app client from a ClientManager without an Algorand client')\n    }\n    return AppClient.fromNetwork({ ...params, algorand: this._algorand })\n  }\n\n  /**\n   * Returns a new typed client, resolving the app by creator address and name.\n   * @param typedClient The typed client type to use\n   * @param params The params to resolve the app by creator address and name\n   * @example Use name in ARC-32 / ARC-56 app spec\n   * ```typescript\n   * const appClient = algorand.client.getTypedAppClientByCreatorAndName(MyContractClient, {\n   *   creatorAddress: \"CREATORADDRESS\",\n   *   defaultSender: alice,\n   * })\n   * ```\n   * @example Specify name\n   * ```typescript\n   * const appClient = algorand.client.getTypedAppClientByCreatorAndName(MyContractClient, {\n   *   creatorAddress: \"CREATORADDRESS\",\n   *   name: \"contract-name\",\n   *   defaultSender: alice,\n   * })\n   * ```\n   * @returns The typed client instance\n   */\n  public async getTypedAppClientByCreatorAndName<TClient extends TypedAppClient<InstanceType<TClient>>>(\n    typedClient: TClient,\n    params: ClientTypedAppClientByCreatorAndNameParams,\n  ) {\n    if (!this._algorand) {\n      throw new Error('Attempt to get app client from a ClientManager without an Algorand client')\n    }\n\n    return typedClient.fromCreatorAndName({ ...params, algorand: this._algorand })\n  }\n\n  /**\n   * Returns a new typed client, resolving the app by app ID.\n   * @param typedClient The typed client type to use\n   * @param params The params to resolve the app by ID\n   * @example\n   * ```typescript\n   * const appClient = algorand.client.getTypedAppClientById(MyContractClient, {\n   *   appId: 12345n,\n   *   defaultSender: alice,\n   * })\n   * ```\n   * @returns The typed client instance\n   */\n  public getTypedAppClientById<TClient extends TypedAppClient<InstanceType<TClient>>>(\n    typedClient: TClient,\n    params: ClientTypedAppClientParams,\n  ) {\n    if (!this._algorand) {\n      throw new Error('Attempt to get app client from a ClientManager without an Algorand client')\n    }\n\n    return new typedClient({ ...params, algorand: this._algorand })\n  }\n\n  /**\n   * Returns a new typed client, resolves the app ID for the current network based on\n   * pre-determined network-specific app IDs specified in the ARC-56 app spec.\n   *\n   * If no IDs are in the app spec or the network isn't recognised, an error is thrown.\n   * @param typedClient The typed client type to use\n   * @param params The params to resolve the app by network\n   * @example\n   * ```typescript\n   * const appClient = algorand.client.getTypedAppClientByNetwork(MyContractClient, {\n   *   defaultSender: alice,\n   * })\n   * ```\n   * @returns The typed client instance\n   */\n  public getTypedAppClientByNetwork<TClient extends TypedAppClient<InstanceType<TClient>>>(\n    typedClient: TClient,\n    params?: ClientTypedAppClientByNetworkParams,\n  ) {\n    if (!this._algorand) {\n      throw new Error('Attempt to get app client from a ClientManager without an Algorand client')\n    }\n\n    return typedClient.fromNetwork({ ...params, algorand: this._algorand })\n  }\n\n  /**\n   * Returns a new typed app factory.\n   * @param typedFactory The typed factory type to use\n   * @param params The params to resolve the factory by\n   * @example\n   * ```typescript\n   * const appFactory = algorand.client.getTypedAppFactory(MyContractClient, {\n   *   sender: alice,\n   * })\n   * ```\n   * @returns The typed client instance\n   */\n  public getTypedAppFactory<TClient>(typedFactory: TypedAppFactory<TClient>, params?: ClientTypedAppFactoryParams) {\n    if (!this._algorand) {\n      throw new Error('Attempt to get app factory from a ClientManager without an Algorand client')\n    }\n\n    return new typedFactory({ ...params, algorand: this._algorand })\n  }\n\n  /**\n   * Retrieve client configurations from environment variables when defined or get defaults (expects to be called from a Node.js environment)\n   *\n   * If both `process.env.INDEXER_SERVER` and `process.env.ALGOD_SERVER` is defined it will use both along with optional `process.env.ALGOD_PORT`, `process.env.ALGOD_TOKEN`, `process.env.INDEXER_PORT` and `process.env.INDEXER_TOKEN`.\n   *\n   * If only `process.env.ALGOD_SERVER` is defined it will use this along with optional `process.env.ALGOD_PORT` and `process.env.ALGOD_TOKEN` and leave indexer as `undefined`.\n   *\n   * If only `process.env.INDEXER_SERVER` is defined it will use the default (LocalNet) configuration for both algod and indexer.\n   *\n   * It will return a KMD configuration that uses `process.env.KMD_PORT` (or port 4002) if `process.env.ALGOD_SERVER` is defined,\n   * otherwise it will use the default LocalNet config unless it detects testnet or mainnet.\n   * @example\n   * ```typescript\n   * const config = ClientManager.getConfigFromEnvironmentOrLocalNet()\n   * ```\n   * @returns The config for algod, indexer and kmd\n   */\n  public static getConfigFromEnvironmentOrLocalNet(): AlgoConfig {\n    if (!process || !process.env) {\n      throw new Error('Attempt to get default client configuration from a non Node.js context; supply the config instead')\n    }\n    const [algodConfig, indexerConfig, kmdConfig] = process.env.ALGOD_SERVER\n      ? [\n          ClientManager.getAlgodConfigFromEnvironment(),\n          process.env.INDEXER_SERVER ? ClientManager.getIndexerConfigFromEnvironment() : undefined,\n          !process.env.ALGOD_SERVER.includes('mainnet') && !process.env.ALGOD_SERVER.includes('testnet')\n            ? { ...ClientManager.getAlgodConfigFromEnvironment(), port: process?.env?.KMD_PORT ?? '4002' }\n            : undefined,\n        ]\n      : [\n          ClientManager.getDefaultLocalNetConfig('algod'),\n          ClientManager.getDefaultLocalNetConfig('indexer'),\n          ClientManager.getDefaultLocalNetConfig('kmd'),\n        ]\n\n    return {\n      algodConfig,\n      indexerConfig,\n      kmdConfig,\n    }\n  }\n\n  /** Retrieve the algod configuration from environment variables (expects to be called from a Node.js environment)\n   *\n   * Expects `process.env.ALGOD_SERVER` to be defined, and you can also specify `process.env.ALGOD_PORT` and `process.env.ALGOD_TOKEN`.\n   */\n  public static getAlgodConfigFromEnvironment(): AlgoClientConfig {\n    if (!process || !process.env) {\n      throw new Error('Attempt to get default algod configuration from a non Node.js context; supply the config instead')\n    }\n\n    if (!process.env.ALGOD_SERVER) {\n      throw new Error('Attempt to get default algod configuration without specifying ALGOD_SERVER in the environment variables')\n    }\n\n    return {\n      server: process.env.ALGOD_SERVER,\n      port: process.env.ALGOD_PORT,\n      token: process.env.ALGOD_TOKEN,\n    }\n  }\n\n  /**\n   * Retrieve the indexer configuration from environment variables (expects to be called from a Node.js environment).\n   *\n   * Expects `process.env.INDEXER_SERVER` to be defined, and you can also specify `process.env.INDEXER_PORT` and `process.env.INDEXER_TOKEN`.\n   */\n  public static getIndexerConfigFromEnvironment(): AlgoClientConfig {\n    if (!process || !process.env) {\n      throw new Error('Attempt to get default indexer configuration from a non Node.js context; supply the config instead')\n    }\n\n    if (!process.env.INDEXER_SERVER) {\n      throw new Error('Attempt to get default indexer configuration without specifying INDEXER_SERVER in the environment variables')\n    }\n\n    return {\n      server: process.env.INDEXER_SERVER,\n      port: process.env.INDEXER_PORT,\n      token: process.env.INDEXER_TOKEN,\n    }\n  }\n\n  /** Returns the Algorand configuration to point to the free tier of the AlgoNode service.\n   *\n   * @param network Which network to connect to - TestNet or MainNet\n   * @param config Which algod config to return - Algod or Indexer\n   */\n  public static getAlgoNodeConfig(network: 'testnet' | 'mainnet', config: 'algod' | 'indexer'): AlgoClientConfig {\n    return {\n      server: `https://${network}-${config === 'algod' ? 'api' : 'idx'}.algonode.cloud/`,\n      port: 443,\n    }\n  }\n\n  /** Returns the Algorand configuration to point to the default LocalNet.\n   *\n   * @param configOrPort Which algod config to return - algod, kmd, or indexer OR a port number\n   */\n  public static getDefaultLocalNetConfig(configOrPort: 'algod' | 'indexer' | 'kmd' | number): AlgoClientConfig {\n    return {\n      server: `http://localhost`,\n      port: configOrPort === 'algod' ? 4001 : configOrPort === 'indexer' ? 8980 : configOrPort === 'kmd' ? 4002 : configOrPort,\n      token: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa',\n    }\n  }\n\n  /**\n   * Returns an algod SDK client that automatically retries on idempotent calls.\n   *\n   * @param config The config of the client\n   * @example AlgoNode (testnet)\n   * ```typescript\n   *  const algod = ClientManager.getAlgodClient(ClientManager.getAlgoNodeConfig('testnet', 'algod'))\n   *  await algod.healthCheck().do()\n   * ```\n   * @example AlgoNode (mainnet)\n   * ```typescript\n   *  const algod = ClientManager.getAlgodClient(ClientManager.getAlgoNodeConfig('mainnet', 'algod'))\n   *  await algod.healthCheck().do()\n   * ```\n   * @example Custom (e.g. default LocalNet)\n   * ```typescript\n   *  const algod = ClientManager.getAlgodClient({server: 'http://localhost', port: '4001', token: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'})\n   *  await algod.healthCheck().do()\n   * ```\n   */\n  public static getAlgodClient(config: AlgoClientConfig): Algodv2 {\n    const { token, server, port } = config\n    const tokenHeader = typeof token === 'string' ? { 'X-Algo-API-Token': token } : token ?? {}\n    const httpClientWithRetry = new AlgoHttpClientWithRetry(tokenHeader, server, port)\n    return new algosdk.Algodv2(httpClientWithRetry, server)\n  }\n\n  /**\n   * Returns an algod SDK client that automatically retries on idempotent calls loaded from environment variables (expects to be called from a Node.js environment).\n   *\n   * @example\n   *  ```typescript\n   *  // Uses process.env.ALGOD_SERVER, process.env.ALGOD_PORT and process.env.ALGOD_TOKEN\n   *  const algod = ClientManager.getAlgodClientFromEnvironment()\n   *  await algod.healthCheck().do()\n   *  ```\n   */\n  public static getAlgodClientFromEnvironment(): Algodv2 {\n    return ClientManager.getAlgodClient(ClientManager.getAlgodConfigFromEnvironment())\n  }\n\n  /**\n   * Returns an indexer SDK client that automatically retries on idempotent calls\n   *\n   * @param config The config of the client\n   * @param overrideIntDecoding Override the default int decoding for responses, uses MIXED by default to avoid lost precision for big integers\n   * @example AlgoNode (testnet)\n   * ```typescript\n   *  const indexer = ClientManager.getIndexerClient(ClientManager.getAlgoNodeConfig('testnet', 'indexer'))\n   *  await indexer.makeHealthCheck().do()\n   * ```\n   * @example AlgoNode (mainnet)\n   * ```typescript\n   *  const indexer = ClientManager.getIndexerClient(ClientManager.getAlgoNodeConfig('mainnet', 'indexer'))\n   *  await indexer.makeHealthCheck().do()\n   * ```\n   * @example Custom (e.g. default LocalNet, although we recommend loading this into a .env and using the Default option instead)\n   * ```typescript\n   *  const indexer = ClientManager.getIndexerClient({server: 'http://localhost', port: '8980', token: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'})\n   *  await indexer.makeHealthCheck().do()\n   * ```\n   * @example Override int decoding for responses\n   * ```typescript\n   *  const indexer = ClientManager.getIndexerClient(config, IntDecoding.BIGINT)\n   * ```\n   */\n  public static getIndexerClient(config: AlgoClientConfig, overrideIntDecoding?: IntDecoding): Indexer {\n    const { token, server, port } = config\n    const tokenHeader = typeof token === 'string' ? { 'X-Indexer-API-Token': token } : token ?? {}\n    const httpClientWithRetry = new AlgoHttpClientWithRetry(tokenHeader, server, port)\n    const indexer = new Indexer(httpClientWithRetry)\n    // Use mixed int decoding by default so bigints don't have lost precision\n    indexer.setIntEncoding(overrideIntDecoding ?? IntDecoding.MIXED)\n    return indexer\n  }\n\n  /**\n   * Returns an indexer SDK client that automatically retries on idempotent calls loaded from environment variables (expects to be called from a Node.js environment).\n   *\n   * @param overrideIntDecoding Override the default int decoding for responses, uses MIXED by default to avoid lost precision for big integers\n   * @example\n   *\n   *  ```typescript\n   *  // Uses process.env.INDEXER_SERVER, process.env.INDEXER_PORT and process.env.INDEXER_TOKEN\n   *  const indexer = ClientManager.getIndexerClientFromEnvironment()\n   *  await indexer.makeHealthCheck().do()\n   *  ```\n   */\n  public static getIndexerClientFromEnvironment(overrideIntDecoding?: IntDecoding): Indexer {\n    return ClientManager.getIndexerClient(ClientManager.getIndexerConfigFromEnvironment(), overrideIntDecoding)\n  }\n\n  /**\n   * Returns a KMD SDK client.\n   *\n   * KMD client allows you to export private keys, which is useful to (for instance) get the default account in a LocalNet network.\n   *\n   * @param config The config for the client\n   * @example Custom (e.g. default LocalNet, although we recommend loading this into a .env and using the Default option instead)\n   * ```typescript\n   *  const kmd = ClientManager.getKmdClient({server: 'http://localhost', port: '4002', token: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'})\n   * ```\n   */\n  public static getKmdClient(config: AlgoClientConfig): Kmd {\n    const { token, server, port } = config\n    return new Kmd(token as string, server, port)\n  }\n\n  /**\n   * Returns a KMD SDK client that automatically retries on idempotent calls loaded from environment variables (expects to be called from a Node.js environment).\n   *\n   * @example\n   *  ```typescript\n   *  // Uses process.env.ALGOD_SERVER, process.env.KMD_PORT (or if not specified: port 4002) and process.env.ALGOD_TOKEN\n   *  const kmd = ClientManager.getKmdClientFromEnvironment()\n   *  ```\n   */\n  public static getKmdClientFromEnvironment(): Kmd {\n    // We can only use Kmd on the LocalNet otherwise it's not exposed so this makes some assumptions\n    // (e.g. same token and server as algod and port 4002 by default)\n    return ClientManager.getKmdClient({ ...ClientManager.getAlgodConfigFromEnvironment(), port: process?.env?.KMD_PORT ?? '4002' })\n  }\n}\n\n/**\n * Interface to identify a typed client that can be used to interact with an application.\n */\nexport interface TypedAppClient<TClient> {\n  new (params: Omit<AppClientParams, 'appSpec'>): TClient\n  fromNetwork(params: Omit<AppClientParams, 'appId' | 'appSpec'>): Promise<TClient>\n  fromCreatorAndName(params: Omit<ResolveAppClientByCreatorAndName, 'appSpec'>): Promise<TClient>\n}\n\n/**\n * Interface to identify a typed factory that can be used to create and deploy an application.\n */\nexport interface TypedAppFactory<TClient> {\n  new (params: Omit<AppFactoryParams, 'appSpec'>): TClient\n}\n"],"names":[],"mappings":";;;;;;;AASA,IAAO,GAAG,GAAG,OAAO,CAAC,GAAG,CAAA;AACxB,IAAO,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;AAEhC,IAAO,WAAW,GAAG,OAAO,CAAC,WAAW,CAAA;AAoCxC;MACa,aAAa,CAAA;AAMxB;;;;;;;;;;;;;;;;;;;AAmBG;IACH,WAAY,CAAA,eAA4C,EAAE,cAAwC,EAAA;AAChG,QAAA,MAAM,QAAQ,GACZ,OAAO,IAAI,eAAe;AACxB,cAAE,eAAe;AACjB,cAAE;gBACE,KAAK,EAAE,aAAa,CAAC,cAAc,CAAC,eAAe,CAAC,WAAW,CAAC;AAChE,gBAAA,OAAO,EAAE,eAAe,CAAC,aAAa,GAAG,aAAa,CAAC,gBAAgB,CAAC,eAAe,CAAC,aAAa,CAAC,GAAG,SAAS;AAClH,gBAAA,GAAG,EAAE,eAAe,CAAC,SAAS,GAAG,aAAa,CAAC,YAAY,CAAC,eAAe,CAAC,SAAS,CAAC,GAAG,SAAS;aACnG,CAAA;AACP,QAAA,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAA;AAC5B,QAAA,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAA;AAChC,QAAA,IAAI,CAAC,IAAI,GAAG,QAAQ,CAAC,GAAG,CAAA;AACxB,QAAA,IAAI,CAAC,SAAS,GAAG,cAAc,CAAA;KAChC;;AAGD,IAAA,IAAW,KAAK,GAAA;QACd,OAAO,IAAI,CAAC,MAAM,CAAA;KACnB;;AAGD,IAAA,IAAW,OAAO,GAAA;QAChB,IAAI,CAAC,IAAI,CAAC,QAAQ;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,8EAA8E,CAAC,CAAA;QACnH,OAAO,IAAI,CAAC,QAAQ,CAAA;KACrB;;AAGD,IAAA,IAAW,gBAAgB,GAAA;QACzB,OAAO,IAAI,CAAC,QAAQ,CAAA;KACrB;;AAGD,IAAA,IAAW,GAAG,GAAA;QACZ,IAAI,CAAC,IAAI,CAAC,IAAI;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,sEAAsE,CAAC,CAAA;QACvG,OAAO,IAAI,CAAC,IAAI,CAAA;KACjB;AAGD;;;;;;;;AAQG;AACI,IAAA,MAAM,OAAO,GAAA;AAClB,QAAA,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE;AAC5B,YAAA,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,MAAM,CAAC,oBAAoB,EAAE,CAAC,EAAE,EAAE,CAAA;SAClE;AAED,QAAA,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAA;QAC5C,OAAO;AACL,YAAA,SAAS,EAAE,CAAC,cAAc,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC;AAC/E,YAAA,SAAS,EAAE,CAAC,cAAc,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC;YAC/E,UAAU,EAAE,aAAa,CAAC,mBAAmB,CAAC,MAAM,CAAC,SAAS,CAAC;YAC/D,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,WAAW,EAAE,MAAM,CAAC,WAAW;SAChC,CAAA;KACF;AAED;;;;AAIG;IACI,OAAO,mBAAmB,CAAC,SAAiB,EAAA;AACjD,QAAA,OAAO,mBAAmB,CAAC,SAAS,CAAC,CAAA;KACtC;AAED;;;AAGG;AACI,IAAA,MAAM,UAAU,GAAA;QACrB,OAAO,CAAC,MAAM,IAAI,CAAC,OAAO,EAAE,EAAE,UAAU,CAAA;KACzC;AAED;;;AAGG;AACI,IAAA,MAAM,SAAS,GAAA;QACpB,OAAO,CAAC,MAAM,IAAI,CAAC,OAAO,EAAE,EAAE,SAAS,CAAA;KACxC;AAED;;;AAGG;AACI,IAAA,MAAM,SAAS,GAAA;QACpB,OAAO,CAAC,MAAM,IAAI,CAAC,OAAO,EAAE,EAAE,SAAS,CAAA;KACxC;AAED;;;;;;;;;;;;;;;AAeG;AACI,IAAA,mBAAmB,CAAC,MAAuC,EAAA;AAChE,QAAA,OAAO,IAAI,yBAAyB,CAAC,MAAM,CAAC,CAAA;KAC7C;AAED;;;;;;;;;;;;;;AAcG;AACI,IAAA,kCAAkC,CAAC,MAA2D,EAAA;QACnG,OAAO,IAAI,yBAAyB,CAAC,MAAM,GAAG,EAAE,GAAG,MAAM,EAAE,SAAS,EAAE,EAAE,EAAE,GAAG,SAAS,CAAC,CAAA;KACxF;AAED;;;;;;;;;;;;;;;;;;;;AAoBG;AACI,IAAA,aAAa,CAAC,MAA8B,EAAA;AACjD,QAAA,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;AACnB,YAAA,MAAM,IAAI,KAAK,CAAC,4EAA4E,CAAC,CAAA;SAC9F;AAED,QAAA,OAAO,IAAI,UAAU,CAAC,EAAE,GAAG,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,CAAA;KAC/D;AAED;;;;;;;;;;;;;;AAcG;AACI,IAAA,4BAA4B,CAAC,MAAoD,EAAA;AACtF,QAAA,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;AACnB,YAAA,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC,CAAA;SAC7F;QAED,OAAO,SAAS,CAAC,kBAAkB,CAAC;AAClC,YAAA,GAAG,MAAM;YACT,QAAQ,EAAE,IAAI,CAAC,SAAS;AACzB,SAAA,CAAC,CAAA;KACH;AAED;;;;;;;;;;;AAWG;AACI,IAAA,gBAAgB,CAAC,MAA6B,EAAA;AACnD,QAAA,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;AACnB,YAAA,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC,CAAA;SAC7F;AACD,QAAA,OAAO,IAAI,SAAS,CAAC,EAAE,GAAG,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,CAAA;KAC9D;AAED;;;;;;;;;;;;;;;AAeG;IACI,MAAM,qBAAqB,CAAC,MAAsC,EAAA;AACvE,QAAA,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;AACnB,YAAA,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC,CAAA;SAC7F;AACD,QAAA,OAAO,SAAS,CAAC,WAAW,CAAC,EAAE,GAAG,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,CAAA;KACtE;AAED;;;;;;;;;;;;;;;;;;;;AAoBG;AACI,IAAA,MAAM,iCAAiC,CAC5C,WAAoB,EACpB,MAAkD,EAAA;AAElD,QAAA,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;AACnB,YAAA,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC,CAAA;SAC7F;AAED,QAAA,OAAO,WAAW,CAAC,kBAAkB,CAAC,EAAE,GAAG,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,CAAA;KAC/E;AAED;;;;;;;;;;;;AAYG;IACI,qBAAqB,CAC1B,WAAoB,EACpB,MAAkC,EAAA;AAElC,QAAA,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;AACnB,YAAA,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC,CAAA;SAC7F;AAED,QAAA,OAAO,IAAI,WAAW,CAAC,EAAE,GAAG,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,CAAA;KAChE;AAED;;;;;;;;;;;;;;AAcG;IACI,0BAA0B,CAC/B,WAAoB,EACpB,MAA4C,EAAA;AAE5C,QAAA,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;AACnB,YAAA,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC,CAAA;SAC7F;AAED,QAAA,OAAO,WAAW,CAAC,WAAW,CAAC,EAAE,GAAG,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,CAAA;KACxE;AAED;;;;;;;;;;;AAWG;IACI,kBAAkB,CAAU,YAAsC,EAAE,MAAoC,EAAA;AAC7G,QAAA,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;AACnB,YAAA,MAAM,IAAI,KAAK,CAAC,4EAA4E,CAAC,CAAA;SAC9F;AAED,QAAA,OAAO,IAAI,YAAY,CAAC,EAAE,GAAG,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,CAAA;KACjE;AAED;;;;;;;;;;;;;;;;AAgBG;AACI,IAAA,OAAO,kCAAkC,GAAA;QAC9C,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE;AAC5B,YAAA,MAAM,IAAI,KAAK,CAAC,mGAAmG,CAAC,CAAA;SACrH;AACD,QAAA,MAAM,CAAC,WAAW,EAAE,aAAa,EAAE,SAAS,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,YAAY;AACtE,cAAE;gBACE,aAAa,CAAC,6BAA6B,EAAE;AAC7C,gBAAA,OAAO,CAAC,GAAG,CAAC,cAAc,GAAG,aAAa,CAAC,+BAA+B,EAAE,GAAG,SAAS;gBACxF,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC;AAC5F,sBAAE,EAAE,GAAG,aAAa,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,IAAI,MAAM,EAAE;AAC9F,sBAAE,SAAS;AACd,aAAA;AACH,cAAE;AACE,gBAAA,aAAa,CAAC,wBAAwB,CAAC,OAAO,CAAC;AAC/C,gBAAA,aAAa,CAAC,wBAAwB,CAAC,SAAS,CAAC;AACjD,gBAAA,aAAa,CAAC,wBAAwB,CAAC,KAAK,CAAC;aAC9C,CAAA;QAEL,OAAO;YACL,WAAW;YACX,aAAa;YACb,SAAS;SACV,CAAA;KACF;AAED;;;AAGG;AACI,IAAA,OAAO,6BAA6B,GAAA;QACzC,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE;AAC5B,YAAA,MAAM,IAAI,KAAK,CAAC,kGAAkG,CAAC,CAAA;SACpH;AAED,QAAA,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE;AAC7B,YAAA,MAAM,IAAI,KAAK,CAAC,yGAAyG,CAAC,CAAA;SAC3H;QAED,OAAO;AACL,YAAA,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,YAAY;AAChC,YAAA,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,UAAU;AAC5B,YAAA,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,WAAW;SAC/B,CAAA;KACF;AAED;;;;AAIG;AACI,IAAA,OAAO,+BAA+B,GAAA;QAC3C,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE;AAC5B,YAAA,MAAM,IAAI,KAAK,CAAC,oGAAoG,CAAC,CAAA;SACtH;AAED,QAAA,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE;AAC/B,YAAA,MAAM,IAAI,KAAK,CAAC,6GAA6G,CAAC,CAAA;SAC/H;QAED,OAAO;AACL,YAAA,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,cAAc;AAClC,YAAA,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,YAAY;AAC9B,YAAA,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,aAAa;SACjC,CAAA;KACF;AAED;;;;AAIG;AACI,IAAA,OAAO,iBAAiB,CAAC,OAA8B,EAAE,MAA2B,EAAA;QACzF,OAAO;AACL,YAAA,MAAM,EAAE,CAAA,QAAA,EAAW,OAAO,CAAA,CAAA,EAAI,MAAM,KAAK,OAAO,GAAG,KAAK,GAAG,KAAK,CAAkB,gBAAA,CAAA;AAClF,YAAA,IAAI,EAAE,GAAG;SACV,CAAA;KACF;AAED;;;AAGG;IACI,OAAO,wBAAwB,CAAC,YAAkD,EAAA;QACvF,OAAO;AACL,YAAA,MAAM,EAAE,CAAkB,gBAAA,CAAA;AAC1B,YAAA,IAAI,EAAE,YAAY,KAAK,OAAO,GAAG,IAAI,GAAG,YAAY,KAAK,SAAS,GAAG,IAAI,GAAG,YAAY,KAAK,KAAK,GAAG,IAAI,GAAG,YAAY;AACxH,YAAA,KAAK,EAAE,kEAAkE;SAC1E,CAAA;KACF;AAED;;;;;;;;;;;;;;;;;;;AAmBG;IACI,OAAO,cAAc,CAAC,MAAwB,EAAA;QACnD,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,CAAA;QACtC,MAAM,WAAW,GAAG,OAAO,KAAK,KAAK,QAAQ,GAAG,EAAE,kBAAkB,EAAE,KAAK,EAAE,GAAG,KAAK,IAAI,EAAE,CAAA;QAC3F,MAAM,mBAAmB,GAAG,IAAI,uBAAuB,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,CAAC,CAAA;QAClF,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAA;KACxD;AAED;;;;;;;;;AASG;AACI,IAAA,OAAO,6BAA6B,GAAA;QACzC,OAAO,aAAa,CAAC,cAAc,CAAC,aAAa,CAAC,6BAA6B,EAAE,CAAC,CAAA;KACnF;AAED;;;;;;;;;;;;;;;;;;;;;;;;AAwBG;AACI,IAAA,OAAO,gBAAgB,CAAC,MAAwB,EAAE,mBAAiC,EAAA;QACxF,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,CAAA;QACtC,MAAM,WAAW,GAAG,OAAO,KAAK,KAAK,QAAQ,GAAG,EAAE,qBAAqB,EAAE,KAAK,EAAE,GAAG,KAAK,IAAI,EAAE,CAAA;QAC9F,MAAM,mBAAmB,GAAG,IAAI,uBAAuB,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,CAAC,CAAA;AAClF,QAAA,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,mBAAmB,CAAC,CAAA;;QAEhD,OAAO,CAAC,cAAc,CAAC,mBAAmB,IAAI,WAAW,CAAC,KAAK,CAAC,CAAA;AAChE,QAAA,OAAO,OAAO,CAAA;KACf;AAED;;;;;;;;;;;AAWG;IACI,OAAO,+BAA+B,CAAC,mBAAiC,EAAA;QAC7E,OAAO,aAAa,CAAC,gBAAgB,CAAC,aAAa,CAAC,+BAA+B,EAAE,EAAE,mBAAmB,CAAC,CAAA;KAC5G;AAED;;;;;;;;;;AAUG;IACI,OAAO,YAAY,CAAC,MAAwB,EAAA;QACjD,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,CAAA;QACtC,OAAO,IAAI,GAAG,CAAC,KAAe,EAAE,MAAM,EAAE,IAAI,CAAC,CAAA;KAC9C;AAED;;;;;;;;AAQG;AACI,IAAA,OAAO,2BAA2B,GAAA;;;QAGvC,OAAO,aAAa,CAAC,YAAY,CAAC,EAAE,GAAG,aAAa,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,IAAI,MAAM,EAAE,CAAC,CAAA;KAChI;AACF;;;;"}

package/types/composer.d.ts

@@ -3,10 +3,18 @@ import { TransactionSignerAccount } from './account';
 import { AlgoAmount } from './amount';
 import { AppManager, BoxIdentifier, BoxReference } from './app-manager';
 import { Expand } from './expand';
-import { Arc2TransactionNote, SendAtomicTransactionComposerResults } from './transaction';
+import { Arc2TransactionNote, SendAtomicTransactionComposerResults, SendParams } from './transaction';
 import Transaction = algosdk.Transaction;
+import TransactionSigner = algosdk.TransactionSigner;
 import TransactionWithSigner = algosdk.TransactionWithSigner;
+import SimulateResponse = algosdk.modelsv2.SimulateResponse;
+import modelsv2 = algosdk.modelsv2;
 export declare const MAX_TRANSACTION_GROUP_SIZE = 16;
+/** Options to control a simulate request */
+export type SimulateOptions = Expand<Omit<ConstructorParameters<typeof modelsv2.SimulateRequest>[0], 'txnGroups'>> & {
+    /** Whether or not to skip signatures for all built transactions and use an empty signer instead. */
+    skipSignatures?: boolean;
+};
 /** Common parameters for defining a transaction. */
 export type CommonTransactionParams = {
     /** The address of the account sending the transaction. */
@@ -283,7 +291,7 @@ export type OnlineKeyRegistrationParams = CommonTransactionParams & {
 export type CommonAppCallParams = CommonTransactionParams & {
     /** ID of the application; 0 if the application is being created. */
     appId: bigint;
-    /** The [on-complete](https://developer.algorand.org/docs/get-details/dapps/avm/teal/specification/#oncomplete) action of the call. */
+    /** The [on-complete](https://developer.algorand.org/docs/get-details/dapps/avm/teal/specification/#oncomplete) action of the call; defaults to no-op. */
     onComplete?: algosdk.OnApplicationComplete;
     /** Any [arguments to pass to the smart contract call](https://developer.algorand.org/docs/get-details/dapps/avm/teal/#argument-passing). */
     args?: Uint8Array[];
@@ -300,6 +308,7 @@ export type CommonAppCallParams = CommonTransactionParams & {
      */
     boxReferences?: (BoxReference | BoxIdentifier)[];
 };
+/** Parameters to define an app create transaction */
 export type AppCreateParams = Expand<Omit<CommonAppCallParams, 'appId'> & {
     onComplete?: Exclude<algosdk.OnApplicationComplete, algosdk.OnApplicationComplete.ClearStateOC>;
     /** The program to execute for all OnCompletes other than ClearState as raw teal that will be compiled (string) or compiled teal (encoded as a byte array (Uint8Array)). */
@@ -317,9 +326,12 @@ export type AppCreateParams = Expand<Omit<CommonAppCallParams, 'appId'> & {
         /** The number of byte slices saved in local state. */
         localByteSlices: number;
     };
-    /** Number of extra pages required for the programs. This is immutable once the app is created. */
+    /** Number of extra pages required for the programs.
+     * Defaults to the number needed for the programs in this call if not specified.
+     * This is immutable once the app is created. */
     extraProgramPages?: number;
 }>;
+/** Parameters to define an app update transaction */
 export type AppUpdateParams = Expand<CommonAppCallParams & {
     onComplete?: algosdk.OnApplicationComplete.UpdateApplicationOC;
     /** The program to execute for all OnCompletes other than ClearState as raw teal (string) or compiled teal (base 64 encoded as a byte array (Uint8Array)) */
@@ -331,14 +343,25 @@ export type AppUpdateParams = Expand<CommonAppCallParams & {
 export type AppCallParams = CommonAppCallParams & {
     onComplete?: Exclude<algosdk.OnApplicationComplete, algosdk.OnApplicationComplete.UpdateApplicationOC>;
 };
+/** Common parameters to define an ABI method call transaction. */
+export type AppMethodCallParams = CommonAppCallParams & {
+    onComplete?: Exclude<algosdk.OnApplicationComplete, algosdk.OnApplicationComplete.UpdateApplicationOC | algosdk.OnApplicationComplete.ClearStateOC>;
+};
 /** Parameters to define an application delete call transaction. */
 export type AppDeleteParams = CommonAppCallParams & {
     onComplete?: algosdk.OnApplicationComplete.DeleteApplicationOC;
 };
+/** Parameters to define an ABI method call create transaction. */
 export type AppCreateMethodCall = AppMethodCall<AppCreateParams>;
+/** Parameters to define an ABI method call update transaction. */
 export type AppUpdateMethodCall = AppMethodCall<AppUpdateParams>;
+/** Parameters to define an ABI method call delete transaction. */
 export type AppDeleteMethodCall = AppMethodCall<AppDeleteParams>;
-export type AppCallMethodCall = AppMethodCall<AppCallParams>;
+/** Parameters to define an ABI method call transaction. */
+export type AppCallMethodCall = AppMethodCall<AppMethodCallParams>;
+/** Types that can be used to define a transaction argument for an ABI call transaction. */
+export type AppMethodCallTransactionArgument = TransactionWithSigner | Transaction | Promise<Transaction> | AppMethodCall<AppCreateParams> | AppMethodCall<AppUpdateParams> | AppMethodCall<AppMethodCallParams>;
+/** Parameters to define an ABI method call. */
 export type AppMethodCall<T> = Expand<Omit<T, 'args'>> & {
     /** The ABI method to call */
     method: algosdk.ABIMethod;
@@ -346,22 +369,42 @@ export type AppMethodCall<T> = Expand<Omit<T, 'args'>> & {
      * * An ABI value
      * * A transaction with explicit signer
      * * A transaction (where the signer will be automatically assigned)
-     * * An unawaited transaction (e.g. from algorand.transactions.transactionType())
+     * * An unawaited transaction (e.g. from algorand.createTransaction.{transactionType}())
      * * Another method call (via method call params object)
+     * * undefined (this represents a placeholder transaction argument that is fulfilled by another method call argument)
      */
-    args?: (algosdk.ABIValue | TransactionWithSigner | Transaction | Promise<Transaction> | AppMethodCall<AppCreateParams> | AppMethodCall<AppUpdateParams> | AppMethodCall<AppCallParams>)[];
+    args?: (algosdk.ABIValue | TransactionWithSigner | Transaction | Promise<Transaction> | AppMethodCall<AppCreateParams> | AppMethodCall<AppUpdateParams> | AppMethodCall<AppMethodCallParams> | undefined)[];
 };
-/** Parameters to configure transaction execution. */
-export interface ExecuteParams {
-    /** The number of rounds to wait for confirmation. By default until the latest lastValid has past. */
-    maxRoundsToWaitForConfirmation?: number;
-    /** Whether to suppress log messages from transaction send, default: do not suppress. */
-    suppressLog?: boolean;
-    /** Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to `Config.populateAppCallResources`. */
-    populateAppCallResources?: boolean;
-}
-/** Parameters to create an `AlgoKitComposer`. */
-export type AlgoKitComposerParams = {
+export type Txn = (PaymentParams & {
+    type: 'pay';
+}) | (AssetCreateParams & {
+    type: 'assetCreate';
+}) | (AssetConfigParams & {
+    type: 'assetConfig';
+}) | (AssetFreezeParams & {
+    type: 'assetFreeze';
+}) | (AssetDestroyParams & {
+    type: 'assetDestroy';
+}) | (AssetTransferParams & {
+    type: 'assetTransfer';
+}) | (AssetOptInParams & {
+    type: 'assetOptIn';
+}) | (AssetOptOutParams & {
+    type: 'assetOptOut';
+}) | ((AppCallParams | AppCreateParams | AppUpdateParams) & {
+    type: 'appCall';
+}) | (OnlineKeyRegistrationParams & {
+    type: 'keyReg';
+}) | (algosdk.TransactionWithSigner & {
+    type: 'txnWithSigner';
+}) | {
+    atc: algosdk.AtomicTransactionComposer;
+    type: 'atc';
+} | ((AppCallMethodCall | AppCreateMethodCall | AppUpdateMethodCall) & {
+    type: 'methodCall';
+});
+/** Parameters to create an `TransactionComposer`. */
+export type TransactionComposerParams = {
     /** The algod client to use to get suggestedParams and send the transaction group */
     algod: algosdk.Algodv2;
     /** The function used to get the TransactionSigner for a given address */
@@ -378,7 +421,7 @@ export type AlgoKitComposerParams = {
      */
     appManager?: AppManager;
 };
-/** Set of transactions built by `AlgoKitComposer`. */
+/** Set of transactions built by `TransactionComposer`. */
 export interface BuiltTransactions {
     /** The built transactions */
     transactions: algosdk.Transaction[];
@@ -388,7 +431,7 @@ export interface BuiltTransactions {
     signers: Map<number, algosdk.TransactionSigner>;
 }
 /** AlgoKit Composer helps you compose and execute transactions as a transaction group. */
-export default class AlgoKitComposer {
+export default class TransactionComposer {
     /** Signer used to represent a lack of signer */
     private static NULL_SIGNER;
     /** The ATC used to compose the group */
@@ -409,58 +452,65 @@ export default class AlgoKitComposer {
     private defaultValidityWindowIsExplicit;
     private appManager;
     /**
-     * Create an `AlgoKitComposer`.
+     * Create an `TransactionComposer`.
      * @param params The configuration for this composer
      */
-    constructor(params: AlgoKitComposerParams);
+    constructor(params: TransactionComposerParams);
+    /**
+     * Add a pre-built transaction to the transaction group.
+     * @param transaction The pre-built transaction
+     * @param signer Optional signer override for the transaction
+     * @returns The composer so you can chain method calls
+     */
+    addTransaction(transaction: Transaction, signer?: TransactionSigner): TransactionComposer;
     /**
      * Add a payment transaction to the transaction group.
      * @param params The payment transaction parameters
      * @returns The composer so you can chain method calls
      */
-    addPayment(params: PaymentParams): AlgoKitComposer;
+    addPayment(params: PaymentParams): TransactionComposer;
     /**
      * Add an asset create transaction to the transaction group.
      * @param params The asset create transaction parameters
      * @returns The composer so you can chain method calls
      */
-    addAssetCreate(params: AssetCreateParams): AlgoKitComposer;
+    addAssetCreate(params: AssetCreateParams): TransactionComposer;
     /**
      * Add an asset config transaction to the transaction group.
      * @param params The asset config transaction parameters
      * @returns The composer so you can chain method calls
      */
-    addAssetConfig(params: AssetConfigParams): AlgoKitComposer;
+    addAssetConfig(params: AssetConfigParams): TransactionComposer;
     /**
      * Add an asset freeze transaction to the transaction group.
      * @param params The asset freeze transaction parameters
      * @returns The composer so you can chain method calls
      */
-    addAssetFreeze(params: AssetFreezeParams): AlgoKitComposer;
+    addAssetFreeze(params: AssetFreezeParams): TransactionComposer;
     /**
      * Add an asset destroy transaction to the transaction group.
      * @param params The asset destroy transaction parameters
      * @returns The composer so you can chain method calls
      */
-    addAssetDestroy(params: AssetDestroyParams): AlgoKitComposer;
+    addAssetDestroy(params: AssetDestroyParams): TransactionComposer;
     /**
      * Add an asset transfer transaction to the transaction group.
      * @param params The asset transfer transaction parameters
      * @returns The composer so you can chain method calls
      */
-    addAssetTransfer(params: AssetTransferParams): AlgoKitComposer;
+    addAssetTransfer(params: AssetTransferParams): TransactionComposer;
     /**
      * Add an asset opt-in transaction to the transaction group.
      * @param params The asset opt-in transaction parameters
      * @returns The composer so you can chain method calls
      */
-    addAssetOptIn(params: AssetOptInParams): AlgoKitComposer;
+    addAssetOptIn(params: AssetOptInParams): TransactionComposer;
     /**
      * Add an asset opt-out transaction to the transaction group.
      * @param params The asset opt-out transaction parameters
      * @returns The composer so you can chain method calls
      */
-    addAssetOptOut(params: AssetOptOutParams): AlgoKitComposer;
+    addAssetOptOut(params: AssetOptOutParams): TransactionComposer;
     /**
      * Add an application create transaction to the transaction group.
      *
@@ -468,7 +518,7 @@ export default class AlgoKitComposer {
      * @param params The application create transaction parameters
      * @returns The composer so you can chain method calls
      */
-    addAppCreate(params: AppCreateParams): AlgoKitComposer;
+    addAppCreate(params: AppCreateParams): TransactionComposer;
     /**
      * Add an application update transaction to the transaction group.
      *
@@ -476,7 +526,7 @@ export default class AlgoKitComposer {
      * @param params The application update transaction parameters
      * @returns The composer so you can chain method calls
      */
-    addAppUpdate(params: AppUpdateParams): AlgoKitComposer;
+    addAppUpdate(params: AppUpdateParams): TransactionComposer;
     /**
      * Add an application delete transaction to the transaction group.
      *
@@ -484,7 +534,7 @@ export default class AlgoKitComposer {
      * @param params The application delete transaction parameters
      * @returns The composer so you can chain method calls
      */
-    addAppDelete(params: AppDeleteParams): AlgoKitComposer;
+    addAppDelete(params: AppDeleteParams): TransactionComposer;
     /**
      * Add an application call transaction to the transaction group.
      *
@@ -494,7 +544,7 @@ export default class AlgoKitComposer {
      * @param params The application call transaction parameters
      * @returns The composer so you can chain method calls
      */
-    addAppCall(params: AppCallParams): AlgoKitComposer;
+    addAppCall(params: AppCallParams): TransactionComposer;
     /**
      * Add an ABI method create application call transaction to the transaction group.
      *
@@ -532,13 +582,13 @@ export default class AlgoKitComposer {
      * @param params The online key registration transaction parameters
      * @returns The composer so you can chain method calls
      */
-    addOnlineKeyRegistration(params: OnlineKeyRegistrationParams): AlgoKitComposer;
+    addOnlineKeyRegistration(params: OnlineKeyRegistrationParams): TransactionComposer;
     /**
      * Add the transactions within an `AtomicTransactionComposer` to the transaction group.
      * @param atc The `AtomicTransactionComposer` to build transactions from and add to the group
      * @returns The composer so you can chain method calls
      */
-    addAtc(atc: algosdk.AtomicTransactionComposer): AlgoKitComposer;
+    addAtc(atc: algosdk.AtomicTransactionComposer): TransactionComposer;
     /** Build an ATC and return transactions ready to be incorporated into a broader set of transactions this composer is composing */
     private buildAtc;
     private commonTxnBuildStep;
@@ -594,11 +644,34 @@ export default class AlgoKitComposer {
         methodCalls: any;
     }>;
     /**
+     * Compose the atomic transaction group and send it to the network.
+     * @param params The parameters to control execution with
+     * @returns The execution result
+     */
+    send(params?: SendParams): Promise<SendAtomicTransactionComposerResults>;
+    /**
+     * @deprecated Use `send` instead.
+     *
      * Compose the atomic transaction group and send it to the network
+     *
+     * An alias for `composer.send(params)`.
      * @param params The parameters to control execution with
      * @returns The execution result
      */
-    execute(params?: ExecuteParams): Promise<SendAtomicTransactionComposerResults>;
+    execute(params?: SendParams): Promise<SendAtomicTransactionComposerResults>;
+    /**
+     * Compose the atomic transaction group and simulate sending it to the network
+     * @returns The simulation result
+     */
+    simulate(options?: SimulateOptions): Promise<SendAtomicTransactionComposerResults & {
+        simulateResponse: SimulateResponse;
+    }>;
+    /**
+     * Create an encoded transaction note that follows the ARC-2 spec.
+     *
+     * https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0002.md
+     * @param note The ARC-2 transaction note data
+     * @returns The binary encoded transaction note
+     */
     static arc2Note(note: Arc2TransactionNote): Uint8Array;
 }
-//# sourceMappingURL=composer.d.ts.map