@algorandfoundation/algokit-utils 7.0.0-beta.6 → 7.0.0-beta.8

package/types/app-client.d.ts

@@ -1,16 +1,14 @@
-/// <reference types="node" />
 import algosdk from 'algosdk';
-import { Buffer } from 'buffer';
 import { AlgorandClientInterface } from './algorand-client-interface';
 import { AlgoAmount } from './amount';
-import { ABIAppCallArgs, ABIReturn, AppCallArgs, AppCallTransactionResult, AppCallType, AppCompilationResult, AppMetadata, AppReference, AppReturn, AppState, AppStorageSchema, BoxName, AppLookup as LegacyAppLookup, OnSchemaBreak, OnUpdate, RawAppCallArgs, SendAppTransactionResult, TealTemplateParams } from './app';
+import { ABIAppCallArgs, ABIReturn, AppCallArgs, AppCallTransactionResult, AppCallType, AppCompilationResult, AppMetadata, AppReference, AppReturn, AppState, AppStorageSchema, BoxName, CompiledTeal, AppLookup as LegacyAppLookup, OnSchemaBreak, OnUpdate, RawAppCallArgs, SendAppTransactionResult, TealTemplateParams } from './app';
 import { ABIStruct, Arc56Contract, Arc56Method } from './app-arc56';
 import { AppLookup } from './app-deployer';
 import { AppManager, BoxIdentifier } from './app-manager';
 import { AppSpec } from './app-spec';
 import AlgoKitComposer, { AppCallMethodCall, AppCallParams, AppDeleteMethodCall, AppDeleteParams, AppMethodCall, AppMethodCallTransactionArgument, CommonAppCallParams, PaymentParams } from './composer';
 import { Expand } from './expand';
-import { ExecuteParams, SendTransactionFrom, SendTransactionParams, TransactionNote } from './transaction';
+import { SendParams, SendTransactionFrom, SendTransactionParams, TransactionNote } from './transaction';
 import ABIMethod = algosdk.ABIMethod;
 import ABIMethodParams = algosdk.ABIMethodParams;
 import ABIType = algosdk.ABIType;
@@ -178,6 +176,19 @@ export interface SourceMapExport {
     names: string[];
     mappings: string;
 }
+/**
+ * The result of asking an `AppClient` to compile a program.
+ */
+export interface AppClientCompilationResult {
+    /** The compiled bytecode of the approval program, ready to deploy to algod */
+    approvalProgram: Uint8Array;
+    /** The compiled bytecode of the clear state program, ready to deploy to algod */
+    clearStateProgram: Uint8Array;
+    /** The result of compilation of the approval program, including source map, if TEAL code was compiled */
+    approvalProgramCompilationResult?: CompiledTeal;
+    /** The result of compilation of the clear state program, including source map, if TEAL code was compiled */
+    clearStateProgramCompilationResult?: CompiledTeal;
+}
 /** Parameters to create an app client */
 export interface AppClientParams {
     /** The ID of the app instance this client should make calls against. */
@@ -207,12 +218,12 @@ export type CallOnComplete = {
     /** On-complete of the call; defaults to no-op */
     onComplete?: Exclude<OnApplicationComplete, OnApplicationComplete.UpdateApplicationOC>;
 };
-/** AppClient parameters for a bare app call */
+/** AppClient common parameters for a bare app call */
 export type AppClientBareCallParams = Expand<Omit<CommonAppCallParams, 'appId' | 'sender' | 'onComplete'> & {
     /** The address of the account sending the transaction, if undefined then the app client's defaultSender is used. */
     sender?: string;
 }>;
-/** AppClient parameters for an ABI method call */
+/** AppClient common parameters for an ABI method call */
 export type AppClientMethodCallParams = Expand<Omit<CommonAppCallParams, 'appId' | 'sender' | 'method' | 'args'> & {
     /** The address of the account sending the transaction, if undefined then the app client's defaultSender is used. */
     sender?: string;
@@ -228,13 +239,13 @@ export type AppClientMethodCallParams = Expand<Omit<CommonAppCallParams, 'appId'
      * * An ARC-56 struct
      * * 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)
      */
     args?: (ABIValue | ABIStruct | AppMethodCallTransactionArgument | undefined)[];
 }>;
 /** Parameters for funding an app account */
-export type FundAppParams = Expand<Omit<PaymentParams, 'receiver' | 'sender'> & ExecuteParams & {
+export type FundAppParams = Expand<Omit<PaymentParams, 'receiver' | 'sender'> & SendParams & {
     /** The optional sender to send the transaction from, will use the application client's default sender by default if specified */
     sender?: string;
 }>;
@@ -249,6 +260,8 @@ export type ResolveAppClientByCreatorAndName = Expand<Omit<AppClientParams, 'app
     /** Whether or not to ignore the `AppDeployer` lookup cache and force an on-chain lookup, default: use any cached value */
     ignoreCache?: boolean;
 }>;
+/** Resolve an app client instance by looking up the current network. */
+export type ResolveAppClientByNetwork = Expand<Omit<AppClientParams, 'appId'>>;
 /** ARC-56/ARC-32 application client that allows you to manage calls and
  * state for a specific deployed instance of an app (with a known app ID). */
 export declare class AppClient {
@@ -264,7 +277,7 @@ export declare class AppClient {
     private _globalStateMethods;
     private _boxStateMethods;
     private _paramsMethods;
-    private _transactionsMethods;
+    private _createTransactionsMethods;
     private _sendMethods;
     constructor(params: AppClientParams);
     /** Start a new `AlgoKitComposer` transaction group */
@@ -274,7 +287,7 @@ export declare class AppClient {
      * using AlgoKit app deployment semantics (i.e. looking for the app creation transaction note).
      * @param params The parameters to create the app client
      */
-    static fromCreatorAndName(params: Expand<ResolveAppClientByCreatorAndName>): Promise<AppClient>;
+    static fromCreatorAndName(params: ResolveAppClientByCreatorAndName): Promise<AppClient>;
     /**
      * Returns an `AppClient` instance for the current network based on
      * pre-determined network-specific app IDs specified in the ARC-56 app spec.
@@ -282,7 +295,7 @@ export declare class AppClient {
      * 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
      */
-    static fromNetwork(params: Expand<Omit<AppClientParams, 'appId'>>): Promise<AppClient>;
+    static fromNetwork(params: ResolveAppClientByNetwork): Promise<AppClient>;
     /**
      * Takes a string or parsed JSON object that could be ARC-32 or ARC-56 format and
      * normalises it into a parsed ARC-56 contract object.
@@ -298,7 +311,21 @@ export declare class AppClient {
     get appName(): string;
     /** The ARC-56 app spec being used */
     get appSpec(): Arc56Contract;
-    /** Get parameters to define transactions to the current app */
+    /** Get parameters to create transactions for the current app.
+     *
+     * A good mental model for this is that these parameters represent a deferred transaction creation.
+     * @example Create a transaction in the future using Algorand Client
+     * ```typescript
+     * const myMethodCall = appClient.params.call({method: 'my_method', args: [123, 'hello']})
+     * // ...
+     * await algorand.send.AppMethodCall(myMethodCall)
+     * ```
+     * @example Define a nested transaction as an ABI argument
+     * ```typescript
+     * const myMethodCall = appClient.params.call({method: 'my_method', args: [123, 'hello']})
+     * await appClient.send.call({method: 'my_method2', args: [myMethodCall]})
+     * ```
+     */
     get params(): {
         /** Return params for a payment transaction to fund the app account */
         fundAppAccount: (params: {
@@ -357,40 +384,15 @@ export declare class AppClient {
             sender?: string | undefined;
             method: string;
             args?: (algosdk.ABIValue | AppMethodCallTransactionArgument | ABIStruct | undefined)[] | undefined;
-        } & AppClientCompilationParams) => Promise<({
-            approvalProgram: Buffer;
-            clearStateProgram: Buffer;
-            compiledApproval?: undefined;
-            compiledClear?: undefined;
-            lease?: string | Uint8Array | undefined;
-            note?: string | Uint8Array | undefined;
-            maxFee?: AlgoAmount | undefined;
-            signer?: algosdk.TransactionSigner | import("./account").TransactionSignerAccount | undefined;
-            rekeyTo?: string | undefined;
-            staticFee?: AlgoAmount | undefined;
-            extraFee?: AlgoAmount | undefined;
-            validityWindow?: number | undefined;
-            firstValidRound?: bigint | undefined;
-            lastValidRound?: bigint | undefined;
-            onComplete?: algosdk.OnApplicationComplete | undefined;
-            accountReferences?: string[] | undefined;
-            appReferences?: bigint[] | undefined;
-            assetReferences?: bigint[] | undefined;
-            boxReferences?: (BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
-            sender?: string | undefined;
-            method: string;
-            args?: (algosdk.ABIValue | AppMethodCallTransactionArgument | ABIStruct | undefined)[] | undefined;
-            /** Any deploy-time parameters to replace in the TEAL code */
-            deployTimeParams?: TealTemplateParams | undefined;
-            /** Whether or not the contract should have deploy-time immutability control set, undefined = ignore */
-            updatable?: boolean | undefined;
-            /** Whether or not the contract should have deploy-time permanence control set, undefined = ignore */
-            deletable?: boolean | undefined;
-        } | {
+        } & AppClientCompilationParams) => Promise<{
+            /** The compiled bytecode of the approval program, ready to deploy to algod */
             approvalProgram: Uint8Array;
-            compiledApproval: import("./app").CompiledTeal;
+            /** The compiled bytecode of the clear state program, ready to deploy to algod */
             clearStateProgram: Uint8Array;
-            compiledClear: import("./app").CompiledTeal;
+            /** The result of compilation of the approval program, including source map, if TEAL code was compiled */
+            approvalProgramCompilationResult?: CompiledTeal | undefined;
+            /** The result of compilation of the clear state program, including source map, if TEAL code was compiled */
+            clearStateProgramCompilationResult?: CompiledTeal | undefined;
             lease?: string | Uint8Array | undefined;
             note?: string | Uint8Array | undefined;
             maxFee?: AlgoAmount | undefined;
@@ -415,7 +417,7 @@ export declare class AppClient {
             updatable?: boolean | undefined;
             /** Whether or not the contract should have deploy-time permanence control set, undefined = ignore */
             deletable?: boolean | undefined;
-        }) & {
+        } & {
             appId: bigint;
             sender: string;
             method: Arc56Method;
@@ -490,7 +492,7 @@ export declare class AppClient {
             sender?: string | undefined;
             method: string;
             args?: (algosdk.ABIValue | AppMethodCallTransactionArgument | ABIStruct | undefined)[] | undefined;
-        }) => AppCallMethodCall;
+        }) => Promise<AppCallMethodCall>;
         /** Return params for an delete ABI call */
         delete: (params: {
             lease?: string | Uint8Array | undefined;
@@ -511,7 +513,7 @@ export declare class AppClient {
             sender?: string | undefined;
             method: string;
             args?: (algosdk.ABIValue | AppMethodCallTransactionArgument | ABIStruct | undefined)[] | undefined;
-        }) => AppDeleteMethodCall;
+        }) => Promise<AppDeleteMethodCall>;
         /** Return params for an close out ABI call */
         closeOut: (params: {
             lease?: string | Uint8Array | undefined;
@@ -532,7 +534,7 @@ export declare class AppClient {
             sender?: string | undefined;
             method: string;
             args?: (algosdk.ABIValue | AppMethodCallTransactionArgument | ABIStruct | undefined)[] | undefined;
-        }) => AppCallMethodCall;
+        }) => Promise<AppCallMethodCall>;
         /** Return params for an ABI call */
         call: (params: {
             lease?: string | Uint8Array | undefined;
@@ -553,9 +555,9 @@ export declare class AppClient {
             sender?: string | undefined;
             method: string;
             args?: (algosdk.ABIValue | AppMethodCallTransactionArgument | ABIStruct | undefined)[] | undefined;
-        } & CallOnComplete) => AppCallMethodCall;
+        } & CallOnComplete) => Promise<AppCallMethodCall>;
     } & {
-        /** Interact with bare (non-ABI) call parameters */ bare: {
+        /** Interact with bare (raw) call parameters */ bare: {
             /** Return params for an update call, including deploy-time TEAL template replacements and compilation if provided */
             update: (params?: ({
                 lease?: string | Uint8Array | undefined;
@@ -693,8 +695,8 @@ export declare class AppClient {
             } & CallOnComplete) | undefined) => AppCallParams;
         };
     };
-    /** Get transactions for the current app */
-    get transactions(): {
+    /** Create transactions for the current app */
+    get createTransaction(): {
         /** Return transaction for a payment transaction to fund the app account */
         fundAppAccount: (params: {
             lease?: string | Uint8Array | undefined;
@@ -850,7 +852,7 @@ export declare class AppClient {
             signers: Map<number, algosdk.TransactionSigner>;
         }>;
     } & {
-        /** Interact with bare (non-ABI) call transactions */ bare: {
+        /** Interact with bare (raw) call transactions */ bare: {
             /** Returns a transaction for an update call, including deploy-time TEAL template replacements and compilation if provided */
             update: (params?: ({
                 lease?: string | Uint8Array | undefined;
@@ -967,7 +969,7 @@ export declare class AppClient {
             } & CallOnComplete) | undefined) => Promise<algosdk.Transaction>;
         };
     };
-    /** Send calls to the current app */
+    /** Send transactions to the current app */
     get send(): {
         /** Sign and send transactions for a payment transaction to fund the app account */
         fundAppAccount: (params: {
@@ -987,7 +989,7 @@ export declare class AppClient {
             suppressLog?: boolean | undefined;
             populateAppCallResources?: boolean | undefined;
             sender?: string | undefined;
-        } & ExecuteParams) => Promise<{
+        } & SendParams) => Promise<{
             groupId: string;
             txIds: string[];
             returns?: ABIReturn[] | undefined;
@@ -1018,9 +1020,9 @@ export declare class AppClient {
             sender?: string | undefined;
             method: string;
             args?: (algosdk.ABIValue | AppMethodCallTransactionArgument | ABIStruct | undefined)[] | undefined;
-        } & AppClientCompilationParams & ExecuteParams) => Promise<{
-            compiledApproval?: import("./app").CompiledTeal | undefined;
-            compiledClear?: import("./app").CompiledTeal | undefined;
+        } & AppClientCompilationParams & SendParams) => Promise<{
+            compiledApproval?: CompiledTeal | undefined;
+            compiledClear?: CompiledTeal | undefined;
             groupId: string;
             txIds: string[];
             returns?: ABIReturn[] | undefined;
@@ -1052,7 +1054,7 @@ export declare class AppClient {
             sender?: string | undefined;
             method: string;
             args?: (algosdk.ABIValue | AppMethodCallTransactionArgument | ABIStruct | undefined)[] | undefined;
-        } & ExecuteParams) => Promise<{
+        } & SendParams) => Promise<Omit<{
             groupId: string;
             txIds: string[];
             returns?: ABIReturn[] | undefined;
@@ -1060,8 +1062,8 @@ export declare class AppClient {
             transactions: algosdk.Transaction[];
             confirmation: algosdk.modelsv2.PendingTransactionResponse;
             transaction: algosdk.Transaction;
-            return?: algosdk.ABIValue | ABIStruct | undefined;
-        }>;
+            return?: ABIReturn | undefined;
+        }, "return"> & AppReturn<algosdk.ABIValue | ABIStruct | undefined>>;
         /**
          * Sign and send transactions for a delete ABI call
          */
@@ -1084,7 +1086,7 @@ export declare class AppClient {
             sender?: string | undefined;
             method: string;
             args?: (algosdk.ABIValue | AppMethodCallTransactionArgument | ABIStruct | undefined)[] | undefined;
-        } & ExecuteParams) => Promise<{
+        } & SendParams) => Promise<Omit<{
             groupId: string;
             txIds: string[];
             returns?: ABIReturn[] | undefined;
@@ -1092,8 +1094,8 @@ export declare class AppClient {
             transactions: algosdk.Transaction[];
             confirmation: algosdk.modelsv2.PendingTransactionResponse;
             transaction: algosdk.Transaction;
-            return?: algosdk.ABIValue | ABIStruct | undefined;
-        }>;
+            return?: ABIReturn | undefined;
+        }, "return"> & AppReturn<algosdk.ABIValue | ABIStruct | undefined>>;
         /**
          * Sign and send transactions for a close out ABI call
          */
@@ -1116,7 +1118,7 @@ export declare class AppClient {
             sender?: string | undefined;
             method: string;
             args?: (algosdk.ABIValue | AppMethodCallTransactionArgument | ABIStruct | undefined)[] | undefined;
-        } & ExecuteParams) => Promise<{
+        } & SendParams) => Promise<Omit<{
             groupId: string;
             txIds: string[];
             returns?: ABIReturn[] | undefined;
@@ -1124,8 +1126,8 @@ export declare class AppClient {
             transactions: algosdk.Transaction[];
             confirmation: algosdk.modelsv2.PendingTransactionResponse;
             transaction: algosdk.Transaction;
-            return?: algosdk.ABIValue | ABIStruct | undefined;
-        }>;
+            return?: ABIReturn | undefined;
+        }, "return"> & AppReturn<algosdk.ABIValue | ABIStruct | undefined>>;
         /**
          * Sign and send transactions for a call (defaults to no-op)
          */
@@ -1148,7 +1150,7 @@ export declare class AppClient {
             sender?: string | undefined;
             method: string;
             args?: (algosdk.ABIValue | AppMethodCallTransactionArgument | ABIStruct | undefined)[] | undefined;
-        } & CallOnComplete & ExecuteParams) => Promise<{
+        } & CallOnComplete & SendParams) => Promise<Omit<{
             groupId: string;
             txIds: string[];
             returns?: ABIReturn[] | undefined;
@@ -1156,10 +1158,10 @@ export declare class AppClient {
             transactions: algosdk.Transaction[];
             confirmation: algosdk.modelsv2.PendingTransactionResponse;
             transaction: algosdk.Transaction;
-            return?: algosdk.ABIValue | ABIStruct | undefined;
-        }>;
+            return?: ABIReturn | undefined;
+        }, "return"> & AppReturn<algosdk.ABIValue | ABIStruct | undefined>>;
     } & {
-        /** Interact with bare (non-ABI) calls */ bare: {
+        /** Interact with bare (raw) calls */ bare: {
             /** Signs and sends an update call, including deploy-time TEAL template replacements and compilation if provided */
             update: (params?: ({
                 lease?: string | Uint8Array | undefined;
@@ -1178,7 +1180,9 @@ export declare class AppClient {
                 assetReferences?: bigint[] | undefined;
                 boxReferences?: (BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
                 sender?: string | undefined;
-            } & AppClientCompilationParams & ExecuteParams) | undefined) => Promise<{
+            } & AppClientCompilationParams & SendParams) | undefined) => Promise<{
+                compiledApproval?: CompiledTeal | undefined;
+                compiledClear?: CompiledTeal | undefined;
                 groupId: string;
                 txIds: string[];
                 returns?: ABIReturn[] | undefined;
@@ -1187,8 +1191,6 @@ export declare class AppClient {
                 confirmation: algosdk.modelsv2.PendingTransactionResponse;
                 transaction: algosdk.Transaction;
                 return?: ABIReturn | undefined;
-                compiledApproval?: import("./app").CompiledTeal | undefined;
-                compiledClear?: import("./app").CompiledTeal | undefined;
             }>;
             /** Signs and sends an opt-in call */
             optIn: (params?: ({
@@ -1208,7 +1210,7 @@ export declare class AppClient {
                 assetReferences?: bigint[] | undefined;
                 boxReferences?: (BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
                 sender?: string | undefined;
-            } & ExecuteParams) | undefined) => Promise<{
+            } & SendParams) | undefined) => Promise<{
                 groupId: string;
                 txIds: string[];
                 returns?: ABIReturn[] | undefined;
@@ -1236,7 +1238,7 @@ export declare class AppClient {
                 assetReferences?: bigint[] | undefined;
                 boxReferences?: (BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
                 sender?: string | undefined;
-            } & ExecuteParams) | undefined) => Promise<{
+            } & SendParams) | undefined) => Promise<{
                 groupId: string;
                 txIds: string[];
                 returns?: ABIReturn[] | undefined;
@@ -1264,7 +1266,7 @@ export declare class AppClient {
                 assetReferences?: bigint[] | undefined;
                 boxReferences?: (BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
                 sender?: string | undefined;
-            } & ExecuteParams) | undefined) => Promise<{
+            } & SendParams) | undefined) => Promise<{
                 groupId: string;
                 txIds: string[];
                 returns?: ABIReturn[] | undefined;
@@ -1292,7 +1294,7 @@ export declare class AppClient {
                 assetReferences?: bigint[] | undefined;
                 boxReferences?: (BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
                 sender?: string | undefined;
-            } & ExecuteParams) | undefined) => Promise<{
+            } & SendParams) | undefined) => Promise<{
                 groupId: string;
                 txIds: string[];
                 returns?: ABIReturn[] | undefined;
@@ -1320,7 +1322,7 @@ export declare class AppClient {
                 assetReferences?: bigint[] | undefined;
                 boxReferences?: (BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
                 sender?: string | undefined;
-            } & CallOnComplete & ExecuteParams) | undefined) => Promise<{
+            } & CallOnComplete & SendParams) | undefined) => Promise<{
                 groupId: string;
                 txIds: string[];
                 returns?: ABIReturn[] | undefined;
@@ -1332,6 +1334,7 @@ export declare class AppClient {
             }>;
         };
     };
+    /** Get state (local, global, box) from the current app */
     get state(): {
         /**
          * Methods to access local state for the current app
@@ -1433,6 +1436,8 @@ export declare class AppClient {
     };
     /**
      * Funds Algo into the app account for this app.
+     *
+     * An alias for `appClient.send.fundAppAccount(params)`.
      * @param params The parameters for the funding transaction
      * @returns The result of the funding
      */
@@ -1514,7 +1519,7 @@ export declare class AppClient {
      */
     importSourceMaps(sourceMaps: AppSourceMaps): void;
     /**
-     * Returns the ABI Method for the given method name string for the app represented by this application client instance
+     * Returns the ABI Method spec for the given method string for the app represented by this application client instance
      * @param methodNameOrSignature The method name or method signature to call if an ABI call is being emitted.
      * e.g. `my_method` or `my_method(unit64,string)bytes`
      * @returns A tuple with: [ARC-56 `Method`, algosdk `ABIMethod`]
@@ -1522,15 +1527,25 @@ export declare class AppClient {
     getABIMethod(methodNameOrSignature: string): Arc56Method;
     /**
      * Checks for decode errors on the SendAppTransactionResult and maps the return value to the specified type
-     * on the ARC-56 method.
+     * on the ARC-56 method, replacing the `return` property with the decoded type.
      *
-     * If the return type is a struct then the struct will be returned.
+     * If the return type is an ARC-56 struct then the struct will be returned.
      *
      * @param result The SendAppTransactionResult to be mapped
      * @param method The method that was called
      * @returns The smart contract response with an updated return value
      */
-    parseMethodCallReturn<TReturn extends Uint8Array | ABIValue | ABIStruct | undefined, TResult extends SendAppTransactionResult = SendAppTransactionResult>(result: Promise<TResult> | TResult, method: Arc56Method): Promise<Expand<Omit<TResult, 'return'> & AppReturn<TReturn>>>;
+    processMethodCallReturn<TReturn extends Uint8Array | ABIValue | ABIStruct | undefined, TResult extends SendAppTransactionResult = SendAppTransactionResult>(result: Promise<TResult> | TResult, method: Arc56Method): Promise<Omit<TResult, 'return'> & AppReturn<TReturn>>;
+    /**
+     * Compiles the approval and clear state programs (if TEAL templates provided),
+     * performing any provided deploy-time parameter replacement and stores
+     * the source maps.
+     *
+     * If no TEAL templates provided it will use any byte code provided in the app spec.
+     *
+     * Will store any generated source maps for later use in debugging.
+     */
+    compile(compilation?: AppClientCompilationParams): Promise<AppClientCompilationResult>;
     /**
      * Takes an error that may include a logic error from a call to the current app and re-exposes the
      * error to include source code information via the source map and ARC-56 spec.
@@ -1555,17 +1570,7 @@ export declare class AppClient {
      * @param appSpec The app spec for the app
      * @param compilation Any compilation parameters to use
      */
-    static compile(appSpec: Arc56Contract, appManager: AppManager, compilation?: AppClientCompilationParams): Promise<{
-        approvalProgram: Buffer;
-        clearStateProgram: Buffer;
-        compiledApproval?: undefined;
-        compiledClear?: undefined;
-    } | {
-        approvalProgram: Uint8Array;
-        compiledApproval: import("./app").CompiledTeal;
-        clearStateProgram: Uint8Array;
-        compiledClear: import("./app").CompiledTeal;
-    }>;
+    static compile(appSpec: Arc56Contract, appManager: AppManager, compilation?: AppClientCompilationParams): Promise<AppClientCompilationResult>;
     /**
      * Returns ABI method arguments ready for a method call params object with default values populated
      * and structs replaced with tuples.
@@ -1574,25 +1579,14 @@ export declare class AppClient {
      * @param methodNameOrSignature The method name or method signature to call if an ABI call is being emitted.
      * e.g. `my_method` or `my_method(unit64,string)bytes`
      * @param args The arguments to the method with `undefined` for any that should be populated with a default value
-     * @param appSpec The app spec for the app
      */
-    static getABIArgsWithDefaultValues(methodNameOrSignature: string, args: AppClientMethodCallParams['args'] | undefined, appSpec: Arc56Contract): AppMethodCall<CommonAppCallParams>['args'];
+    private getABIArgsWithDefaultValues;
     private getBareParamsMethods;
-    private getBareTransactionsMethods;
+    private getBareCreateTransactionMethods;
     private getBareSendMethods;
     private getMethodCallParamsMethods;
     private getMethodCallSendMethods;
-    private getMethodCallTransactionsMethods;
-    /**
-     * Compiles the approval and clear state programs (if TEAL templates provided),
-     * performing any provided deploy-time parameter replacement and stores
-     * the source maps.
-     *
-     * If no TEAL templates provided it will use any byte code provided in the app spec.
-     *
-     * Will store any generated source maps for later use in debugging.
-     */
-    private compile;
+    private getMethodCallCreateTransactionMethods;
     /** Returns the sender for a call, using the `defaultSender`
      * if none provided and throws an error if neither provided */
     private getSender;
@@ -1643,8 +1637,8 @@ export declare class ApplicationClient {
      * @returns The compiled approval and clear state programs
      */
     compile(compilation?: AppClientCompilationParams): Promise<{
-        approvalCompiled: import("./app").CompiledTeal;
-        clearCompiled: import("./app").CompiledTeal;
+        approvalCompiled: CompiledTeal;
+        clearCompiled: CompiledTeal;
     }>;
     /**
      * Export the current source maps for the app.
@@ -1672,8 +1666,8 @@ export declare class ApplicationClient {
     deploy(deploy?: AppClientDeployParams): Promise<(Partial<AppCompilationResult> & AppMetadata & {
         operationPerformed: "nothing";
     }) | {
-        compiledApproval: import("./app").CompiledTeal;
-        compiledClear: import("./app").CompiledTeal;
+        compiledApproval: CompiledTeal;
+        compiledClear: CompiledTeal;
         confirmation: algosdk.modelsv2.PendingTransactionResponse;
         confirmations: algosdk.modelsv2.PendingTransactionResponse[];
         transaction: algosdk.Transaction;
@@ -1681,7 +1675,7 @@ export declare class ApplicationClient {
         createdRound: number;
         updatedRound: number;
         createdMetadata: import("./app").AppDeployMetadata;
-        deleted: boolean;
+        deleted: boolean; /** Any overrides for the storage schema to request for the created app; by default the schema indicated by the app spec is used. */
         appId: number | bigint;
         appAddress: string;
         name: string;
@@ -1691,8 +1685,8 @@ export declare class ApplicationClient {
         return?: ABIReturn | undefined;
         operationPerformed: "update" | "create";
     } | {
-        compiledApproval: import("./app").CompiledTeal;
-        compiledClear: import("./app").CompiledTeal;
+        compiledApproval: CompiledTeal;
+        compiledClear: CompiledTeal;
         confirmation: algosdk.modelsv2.PendingTransactionResponse;
         confirmations: algosdk.modelsv2.PendingTransactionResponse[];
         transaction: algosdk.Transaction;
@@ -1700,20 +1694,17 @@ export declare class ApplicationClient {
         createdRound: number;
         updatedRound: number;
         createdMetadata: import("./app").AppDeployMetadata;
-        deleted: boolean;
+        deleted: boolean; /** Any overrides for the storage schema to request for the created app; by default the schema indicated by the app spec is used. */
         appId: number | bigint;
         appAddress: string;
         name: string;
         version: string;
         deletable?: boolean | undefined;
         updatable?: boolean | undefined;
-        return?: ABIReturn | undefined;
+        return?: ABIReturn | undefined; /** The optional name override to resolve the app by within the creator account (default: uses the name in the ABI contract) */
         deleteReturn?: ABIReturn | undefined;
         deleteResult: import("./transaction").ConfirmedTransactionResult;
-        operationPerformed: "replace"; /** The mechanism to find an existing app instance metadata for the given creator and name; either:
-         *  * An indexer instance to search the creator account apps; or
-         *  * The cached value of the existing apps for the given creator from `getCreatorAppsByName`
-         */
+        operationPerformed: "replace";
     }>;
     /**
      * @deprecated Use `create` from an `AppFactory` instance instead.
@@ -1723,8 +1714,8 @@ export declare class ApplicationClient {
      * @returns The details of the created app, or the transaction to create it if `skipSending` and the compilation result
      */
     create(create?: AppClientCreateParams): Promise<{
-        compiledApproval: import("./app").CompiledTeal;
-        compiledClear: import("./app").CompiledTeal;
+        compiledApproval: CompiledTeal;
+        compiledClear: CompiledTeal;
         return?: ABIReturn | undefined;
         transactions: algosdk.Transaction[];
         confirmations?: algosdk.modelsv2.PendingTransactionResponse[] | undefined;
@@ -1734,15 +1725,15 @@ export declare class ApplicationClient {
         appAddress: string;
     }>;
     /**
-     * @deprecated Use `appClient.send.update` or `appClient.transactions.update` from an `AppClient` instance instead.
+     * @deprecated Use `appClient.send.update` or `appClient.createTransaction.update` from an `AppClient` instance instead.
      *
      * Updates the smart contract app.
      * @param update The parameters to update the app with
      * @returns The transaction send result and the compilation result
      */
     update(update?: AppClientUpdateParams): Promise<{
-        compiledApproval: import("./app").CompiledTeal;
-        compiledClear: import("./app").CompiledTeal;
+        compiledApproval: CompiledTeal;
+        compiledClear: CompiledTeal;
         return?: ABIReturn | undefined;
         transactions: algosdk.Transaction[];
         confirmations?: algosdk.modelsv2.PendingTransactionResponse[] | undefined;
@@ -1750,7 +1741,7 @@ export declare class ApplicationClient {
         confirmation?: algosdk.modelsv2.PendingTransactionResponse | undefined;
     }>;
     /**
-     * @deprecated Use `appClient.send.call` or `appClient.transactions.call` from an `AppClient` instance instead.
+     * @deprecated Use `appClient.send.call` or `appClient.createTransaction.call` from an `AppClient` instance instead.
      *
      * Issues a no_op (normal) call to the app.
      * @param call The call details.
@@ -1758,7 +1749,7 @@ export declare class ApplicationClient {
      */
     call(call?: AppClientCallParams): Promise<AppCallTransactionResult>;
     /**
-     * @deprecated Use `appClient.send.optIn` or `appClient.transactions.optIn` from an `AppClient` instance instead.
+     * @deprecated Use `appClient.send.optIn` or `appClient.createTransaction.optIn` from an `AppClient` instance instead.
      *
      * Issues a opt_in call to the app.
      * @param call The call details.
@@ -1766,7 +1757,7 @@ export declare class ApplicationClient {
      */
     optIn(call?: AppClientCallParams): Promise<AppCallTransactionResult>;
     /**
-     * @deprecated Use `appClient.send.closeOut` or `appClient.transactions.closeOut` from an `AppClient` instance instead.
+     * @deprecated Use `appClient.send.closeOut` or `appClient.createTransaction.closeOut` from an `AppClient` instance instead.
      *
      * Issues a close_out call to the app.
      * @param call The call details.
@@ -1774,7 +1765,7 @@ export declare class ApplicationClient {
      */
     closeOut(call?: AppClientCallParams): Promise<AppCallTransactionResult>;
     /**
-     * @deprecated Use `appClient.send.clearState` or `appClient.transactions.clearState` from an `AppClient` instance instead.
+     * @deprecated Use `appClient.send.clearState` or `appClient.createTransaction.clearState` from an `AppClient` instance instead.
      *
      * Issues a clear_state call to the app.
      * @param call The call details.
@@ -1782,7 +1773,7 @@ export declare class ApplicationClient {
      */
     clearState(call?: AppClientClearStateParams): Promise<AppCallTransactionResult>;
     /**
-     * @deprecated Use `appClient.send.delete` or `appClient.transactions.delete` from an `AppClient` instance instead.
+     * @deprecated Use `appClient.send.delete` or `appClient.createTransaction.delete` from an `AppClient` instance instead.
      *
      * Issues a delete_application call to the app.
      * @param call The call details.
@@ -1790,7 +1781,7 @@ export declare class ApplicationClient {
      */
     delete(call?: AppClientCallParams): Promise<AppCallTransactionResult>;
     /**
-     * @deprecated Use `appClient.send.call` or `appClient.transactions.call` from an `AppClient` instance instead.
+     * @deprecated Use `appClient.send.call` or `appClient.createTransaction.call` from an `AppClient` instance instead.
      *
      * Issues a call to the app with the given call type.
      * @param call The call details.