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

package/types/app-factory.d.ts

@@ -0,0 +1,967 @@
+/// <reference types="node" />
+import algosdk from 'algosdk';
+import { AlgorandClientInterface } from './algorand-client-interface';
+import { AppReturn, SendAppTransactionResult, TealTemplateParams } from './app';
+import { ABIStruct, Arc56Contract, Arc56Method } from './app-arc56';
+import { AppClient, AppClientBareCallParams, AppClientCompilationParams, AppClientMethodCallParams, AppClientParams, AppSourceMaps, ResolveAppClientByCreatorAndName } from './app-client';
+import { AppDeployParams } from './app-deployer';
+import { AppSpec } from './app-spec';
+import { Expand } from './expand';
+import { ExecuteParams } from './transaction';
+import OnApplicationComplete = algosdk.OnApplicationComplete;
+import ABIValue = algosdk.ABIValue;
+/** Parameters to create an app client */
+export interface AppFactoryParams {
+    /** The ARC-56 or ARC-32 application spec as either:
+     *  * Parsed JSON ARC-56 `Contract`
+     *  * Parsed JSON ARC-32 `AppSpec`
+     *  * Raw JSON string (in either ARC-56 or ARC-32 format)
+     */
+    appSpec: Arc56Contract | AppSpec | string;
+    /** `AlgorandClient` instance */
+    algorand: AlgorandClientInterface;
+    /**
+     * Optional override for the app name; used for on-chain metadata and lookups.
+     * Defaults to the ARC-32/ARC-56 app spec name.
+     */
+    appName?: string;
+    /** Optional address to use for the account to use as the default sender for calls. */
+    defaultSender?: string;
+    /** The version of app that is / will be deployed; defaults to 1.0 */
+    version?: string;
+    /**
+     * Whether or not the contract should have deploy-time immutability control set, undefined = ignore.
+     * If specified here will get used in calls to `deploy` and `create` calls unless overridden in those calls.
+     *
+     * Useful if you want to vend multiple contracts from the same factory without specifying this value
+     * for each call.
+     */
+    updatable?: boolean;
+    /**
+     * Whether or not the contract should have deploy-time permanence control set, undefined = ignore.
+     * If specified here will get used in calls to `deploy` and `create` calls unless overridden in those calls.
+     *
+     * Useful if you want to vend multiple contracts from the same factory without specifying this value
+     * for each call.
+     */
+    deletable?: boolean;
+    /**
+     * Optional deploy-time TEAL template replacement parameters.
+     * If specified here will get used in calls to `deploy` and `create` calls unless overridden in those calls.
+     *
+     * Useful if you want to vend multiple contracts from the same factory without specifying this value
+     * for each call.
+     */
+    deployTimeParams?: TealTemplateParams;
+}
+/** onComplete parameter for a create app call */
+export type CreateOnComplete = {
+    onComplete?: Exclude<OnApplicationComplete, OnApplicationComplete.ClearStateOC>;
+};
+/** Specifies a schema used for creating an app */
+export type CreateSchema = {
+    /** The state schema for the app. This is immutable once the app is created. By default uses the ARC32/ARC-56 spec. */
+    schema?: {
+        /** The number of integers saved in global state. */
+        globalInts: number;
+        /** The number of byte slices saved in global state. */
+        globalByteSlices: number;
+        /** The number of integers saved in local state. */
+        localInts: number;
+        /** The number of byte slices saved in local state. */
+        localByteSlices: number;
+    };
+    /** 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 a create call for an `AppFactory` */
+export type AppFactoryCreateParams = Expand<AppClientMethodCallParams & AppClientCompilationParams & CreateOnComplete & ExecuteParams & CreateSchema> | Expand<AppClientBareCallParams & AppClientCompilationParams & CreateOnComplete & ExecuteParams & CreateSchema>;
+/** Parameters to define a deployment for an `AppFactory` */
+export type AppFactoryDeployParams = Expand<Omit<AppDeployParams, 'createParams' | 'updateParams' | 'deleteParams' | 'metadata'> & {
+    /** Create transaction parameters to use if a create needs to be issued as part of deployment */
+    createParams?: Expand<AppClientMethodCallParams & CreateOnComplete & CreateSchema> | Expand<AppClientBareCallParams & CreateOnComplete & CreateSchema>;
+    /** Update transaction parameters to use if a create needs to be issued as part of deployment */
+    updateParams?: AppClientMethodCallParams | AppClientBareCallParams;
+    /** Delete transaction parameters to use if a create needs to be issued as part of deployment */
+    deleteParams?: AppClientMethodCallParams | AppClientBareCallParams;
+    /**
+     * Whether or not the contract should have deploy-time immutability control set.
+     * `undefined` = use AppFactory constructor value if set or base it on the app spec.
+     */
+    updatable?: boolean;
+    /**
+     * Whether or not the contract should have deploy-time permanence control set.
+     * `undefined` = use AppFactory constructor value if set or base it on the app spec.
+     */
+    deletable?: boolean;
+}>;
+/**
+ * ARC-56/ARC-32 app factory that, for a given app spec, allows you to create
+ * and deploy one or more app instances and to create one or more app clients
+ * to interact with those (or other) app instances.
+ */
+export declare class AppFactory {
+    private _appSpec;
+    private _appName;
+    private _algorand;
+    private _version;
+    private _defaultSender?;
+    private _deployTimeParams?;
+    private _updatable?;
+    private _deletable?;
+    private _approvalSourceMap;
+    private _clearSourceMap;
+    private _paramsMethods;
+    constructor(params: AppFactoryParams);
+    /** Get parameters to define create and deploy related calls to the current app */
+    get params(): {
+        /** Return params for a create ABI call, including deploy-time TEAL template replacements and compilation if provided */
+        create: (params: {
+            lease?: string | Uint8Array | undefined;
+            note?: string | Uint8Array | undefined;
+            maxFee?: import("./amount").AlgoAmount | undefined;
+            signer?: algosdk.TransactionSigner | import("./account").TransactionSignerAccount | undefined;
+            rekeyTo?: string | undefined;
+            staticFee?: import("./amount").AlgoAmount | undefined;
+            extraFee?: import("./amount").AlgoAmount | undefined;
+            validityWindow?: number | undefined;
+            firstValidRound?: bigint | undefined;
+            lastValidRound?: bigint | undefined;
+            onComplete?: algosdk.OnApplicationComplete.NoOpOC | algosdk.OnApplicationComplete.OptInOC | algosdk.OnApplicationComplete.CloseOutOC | algosdk.OnApplicationComplete.UpdateApplicationOC | algosdk.OnApplicationComplete.DeleteApplicationOC | undefined;
+            accountReferences?: string[] | undefined;
+            appReferences?: bigint[] | undefined;
+            assetReferences?: bigint[] | undefined;
+            boxReferences?: (import("./app-manager").BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
+            sender?: string | undefined;
+            method: string;
+            args?: (algosdk.ABIValue | import("./composer").AppMethodCallTransactionArgument | ABIStruct | undefined)[] | undefined;
+            deployTimeParams?: TealTemplateParams | undefined;
+            updatable?: boolean | undefined;
+            deletable?: boolean | undefined;
+            schema?: {
+                /** The number of integers saved in global state. */
+                globalInts: number;
+                /** The number of byte slices saved in global state. */
+                globalByteSlices: number;
+                /** The number of integers saved in local state. */
+                localInts: number;
+                /** The number of byte slices saved in local state. */
+                localByteSlices: number;
+            } | undefined;
+            extraProgramPages?: number | undefined;
+        }) => Promise<({
+            approvalProgram: Buffer;
+            clearStateProgram: Buffer;
+            compiledApproval?: undefined;
+            compiledClear?: undefined;
+            deployTimeParams: TealTemplateParams | undefined;
+            schema: {
+                /** The number of integers saved in global state. */
+                globalInts: number;
+                /** The number of byte slices saved in global state. */
+                globalByteSlices: number;
+                /** The number of integers saved in local state. */
+                localInts: number;
+                /** The number of byte slices saved in local state. */
+                localByteSlices: number;
+            };
+            lease?: string | Uint8Array | undefined;
+            note?: string | Uint8Array | undefined;
+            maxFee?: import("./amount").AlgoAmount | undefined;
+            signer?: algosdk.TransactionSigner | import("./account").TransactionSignerAccount | undefined;
+            rekeyTo?: string | undefined;
+            staticFee?: import("./amount").AlgoAmount | undefined;
+            extraFee?: import("./amount").AlgoAmount | undefined;
+            validityWindow?: number | undefined;
+            firstValidRound?: bigint | undefined;
+            lastValidRound?: bigint | undefined;
+            onComplete?: algosdk.OnApplicationComplete.NoOpOC | algosdk.OnApplicationComplete.OptInOC | algosdk.OnApplicationComplete.CloseOutOC | algosdk.OnApplicationComplete.UpdateApplicationOC | algosdk.OnApplicationComplete.DeleteApplicationOC | undefined;
+            accountReferences?: string[] | undefined;
+            appReferences?: bigint[] | undefined;
+            assetReferences?: bigint[] | undefined;
+            boxReferences?: (import("./app-manager").BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
+            sender?: string | undefined;
+            method: string;
+            args?: (algosdk.ABIValue | import("./composer").AppMethodCallTransactionArgument | ABIStruct | undefined)[] | undefined;
+            updatable?: boolean | undefined;
+            deletable?: boolean | undefined;
+            extraProgramPages?: number | undefined;
+        } | {
+            approvalProgram: Uint8Array;
+            compiledApproval: import("./app").CompiledTeal;
+            clearStateProgram: Uint8Array;
+            compiledClear: import("./app").CompiledTeal;
+            deployTimeParams: TealTemplateParams | undefined;
+            schema: {
+                /** The number of integers saved in global state. */
+                globalInts: number;
+                /** The number of byte slices saved in global state. */
+                globalByteSlices: number;
+                /** The number of integers saved in local state. */
+                localInts: number;
+                /** The number of byte slices saved in local state. */
+                localByteSlices: number;
+            };
+            lease?: string | Uint8Array | undefined;
+            note?: string | Uint8Array | undefined;
+            maxFee?: import("./amount").AlgoAmount | undefined;
+            signer?: algosdk.TransactionSigner | import("./account").TransactionSignerAccount | undefined;
+            rekeyTo?: string | undefined;
+            staticFee?: import("./amount").AlgoAmount | undefined;
+            extraFee?: import("./amount").AlgoAmount | undefined;
+            validityWindow?: number | undefined;
+            firstValidRound?: bigint | undefined;
+            lastValidRound?: bigint | undefined;
+            onComplete?: algosdk.OnApplicationComplete.NoOpOC | algosdk.OnApplicationComplete.OptInOC | algosdk.OnApplicationComplete.CloseOutOC | algosdk.OnApplicationComplete.UpdateApplicationOC | algosdk.OnApplicationComplete.DeleteApplicationOC | undefined;
+            accountReferences?: string[] | undefined;
+            appReferences?: bigint[] | undefined;
+            assetReferences?: bigint[] | undefined;
+            boxReferences?: (import("./app-manager").BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
+            sender?: string | undefined;
+            method: string;
+            args?: (algosdk.ABIValue | import("./composer").AppMethodCallTransactionArgument | ABIStruct | undefined)[] | undefined;
+            updatable?: boolean | undefined;
+            deletable?: boolean | undefined;
+            extraProgramPages?: number | undefined;
+        }) & {
+            sender: string;
+            method: Arc56Method;
+            args: (algosdk.Transaction | algosdk.ABIValue | algosdk.TransactionWithSigner | Promise<algosdk.Transaction> | import("./composer").AppMethodCall<{
+                lease?: string | Uint8Array | undefined;
+                note?: string | Uint8Array | undefined;
+                maxFee?: import("./amount").AlgoAmount | undefined;
+                args?: Uint8Array[] | undefined;
+                signer?: algosdk.TransactionSigner | import("./account").TransactionSignerAccount | undefined;
+                sender: string;
+                rekeyTo?: string | undefined;
+                staticFee?: import("./amount").AlgoAmount | undefined;
+                extraFee?: import("./amount").AlgoAmount | undefined;
+                validityWindow?: number | undefined;
+                firstValidRound?: bigint | undefined;
+                lastValidRound?: bigint | undefined;
+                onComplete?: algosdk.OnApplicationComplete.NoOpOC | algosdk.OnApplicationComplete.OptInOC | algosdk.OnApplicationComplete.CloseOutOC | algosdk.OnApplicationComplete.UpdateApplicationOC | algosdk.OnApplicationComplete.DeleteApplicationOC | undefined;
+                accountReferences?: string[] | undefined;
+                appReferences?: bigint[] | undefined;
+                assetReferences?: bigint[] | undefined;
+                boxReferences?: (import("./app-manager").BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
+                approvalProgram: string | Uint8Array;
+                clearStateProgram: string | Uint8Array;
+                schema?: {
+                    globalInts: number;
+                    globalByteSlices: number;
+                    localInts: number;
+                    localByteSlices: number;
+                } | undefined;
+                extraProgramPages?: number | undefined;
+            }> | import("./composer").AppMethodCall<{
+                sender: string;
+                signer?: algosdk.TransactionSigner | import("./account").TransactionSignerAccount | undefined;
+                rekeyTo?: string | undefined;
+                note?: string | Uint8Array | undefined;
+                lease?: string | Uint8Array | undefined;
+                staticFee?: import("./amount").AlgoAmount | undefined;
+                extraFee?: import("./amount").AlgoAmount | undefined;
+                maxFee?: import("./amount").AlgoAmount | undefined;
+                validityWindow?: number | undefined;
+                firstValidRound?: bigint | undefined;
+                lastValidRound?: bigint | undefined;
+                appId: bigint;
+                onComplete?: algosdk.OnApplicationComplete.UpdateApplicationOC | undefined;
+                args?: Uint8Array[] | undefined;
+                accountReferences?: string[] | undefined;
+                appReferences?: bigint[] | undefined;
+                assetReferences?: bigint[] | undefined;
+                boxReferences?: (import("./app-manager").BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
+                approvalProgram: string | Uint8Array;
+                clearStateProgram: string | Uint8Array;
+            }> | import("./composer").AppMethodCall<import("./composer").AppMethodCallParams>)[] | undefined;
+            onComplete: algosdk.OnApplicationComplete.NoOpOC | algosdk.OnApplicationComplete.OptInOC | algosdk.OnApplicationComplete.CloseOutOC | algosdk.OnApplicationComplete.UpdateApplicationOC | algosdk.OnApplicationComplete.DeleteApplicationOC;
+        }>;
+        /** Return params for a deployment update ABI call */
+        deployUpdate: (params: {
+            lease?: string | Uint8Array | undefined;
+            note?: string | Uint8Array | undefined;
+            maxFee?: import("./amount").AlgoAmount | undefined;
+            signer?: algosdk.TransactionSigner | import("./account").TransactionSignerAccount | undefined;
+            rekeyTo?: string | undefined;
+            staticFee?: import("./amount").AlgoAmount | undefined;
+            extraFee?: import("./amount").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?: (import("./app-manager").BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
+            sender?: string | undefined;
+            method: string;
+            args?: (algosdk.ABIValue | import("./composer").AppMethodCallTransactionArgument | ABIStruct | undefined)[] | undefined;
+        }) => {
+            lease?: string | Uint8Array | undefined;
+            note?: string | Uint8Array | undefined;
+            maxFee?: import("./amount").AlgoAmount | undefined;
+            signer?: algosdk.TransactionSigner | import("./account").TransactionSignerAccount | undefined;
+            rekeyTo?: string | undefined;
+            staticFee?: import("./amount").AlgoAmount | undefined;
+            extraFee?: import("./amount").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?: (import("./app-manager").BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
+            sender?: string | undefined;
+            method: string;
+            args?: (algosdk.ABIValue | import("./composer").AppMethodCallTransactionArgument | ABIStruct | undefined)[] | undefined;
+        } & {
+            sender: string;
+            method: Arc56Method;
+            args: (algosdk.Transaction | algosdk.ABIValue | algosdk.TransactionWithSigner | Promise<algosdk.Transaction> | import("./composer").AppMethodCall<{
+                lease?: string | Uint8Array | undefined;
+                note?: string | Uint8Array | undefined;
+                maxFee?: import("./amount").AlgoAmount | undefined;
+                args?: Uint8Array[] | undefined;
+                signer?: algosdk.TransactionSigner | import("./account").TransactionSignerAccount | undefined;
+                sender: string;
+                rekeyTo?: string | undefined;
+                staticFee?: import("./amount").AlgoAmount | undefined;
+                extraFee?: import("./amount").AlgoAmount | undefined;
+                validityWindow?: number | undefined;
+                firstValidRound?: bigint | undefined;
+                lastValidRound?: bigint | undefined;
+                onComplete?: algosdk.OnApplicationComplete.NoOpOC | algosdk.OnApplicationComplete.OptInOC | algosdk.OnApplicationComplete.CloseOutOC | algosdk.OnApplicationComplete.UpdateApplicationOC | algosdk.OnApplicationComplete.DeleteApplicationOC | undefined;
+                accountReferences?: string[] | undefined;
+                appReferences?: bigint[] | undefined;
+                assetReferences?: bigint[] | undefined;
+                boxReferences?: (import("./app-manager").BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
+                approvalProgram: string | Uint8Array;
+                clearStateProgram: string | Uint8Array;
+                schema?: {
+                    globalInts: number;
+                    globalByteSlices: number;
+                    localInts: number;
+                    localByteSlices: number;
+                } | undefined;
+                extraProgramPages?: number | undefined;
+            }> | import("./composer").AppMethodCall<{
+                sender: string;
+                signer?: algosdk.TransactionSigner | import("./account").TransactionSignerAccount | undefined;
+                rekeyTo?: string | undefined;
+                note?: string | Uint8Array | undefined;
+                lease?: string | Uint8Array | undefined;
+                staticFee?: import("./amount").AlgoAmount | undefined;
+                extraFee?: import("./amount").AlgoAmount | undefined;
+                maxFee?: import("./amount").AlgoAmount | undefined;
+                validityWindow?: number | undefined;
+                firstValidRound?: bigint | undefined;
+                lastValidRound?: bigint | undefined;
+                appId: bigint;
+                onComplete?: algosdk.OnApplicationComplete.UpdateApplicationOC | undefined;
+                args?: Uint8Array[] | undefined;
+                accountReferences?: string[] | undefined;
+                appReferences?: bigint[] | undefined;
+                assetReferences?: bigint[] | undefined;
+                boxReferences?: (import("./app-manager").BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
+                approvalProgram: string | Uint8Array;
+                clearStateProgram: string | Uint8Array;
+            }> | import("./composer").AppMethodCall<import("./composer").AppMethodCallParams>)[] | undefined;
+            onComplete: algosdk.OnApplicationComplete.UpdateApplicationOC;
+        };
+        /** Return params for a deployment delete ABI call */
+        deployDelete: (params: {
+            lease?: string | Uint8Array | undefined;
+            note?: string | Uint8Array | undefined;
+            maxFee?: import("./amount").AlgoAmount | undefined;
+            signer?: algosdk.TransactionSigner | import("./account").TransactionSignerAccount | undefined;
+            rekeyTo?: string | undefined;
+            staticFee?: import("./amount").AlgoAmount | undefined;
+            extraFee?: import("./amount").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?: (import("./app-manager").BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
+            sender?: string | undefined;
+            method: string;
+            args?: (algosdk.ABIValue | import("./composer").AppMethodCallTransactionArgument | ABIStruct | undefined)[] | undefined;
+        }) => {
+            lease?: string | Uint8Array | undefined;
+            note?: string | Uint8Array | undefined;
+            maxFee?: import("./amount").AlgoAmount | undefined;
+            signer?: algosdk.TransactionSigner | import("./account").TransactionSignerAccount | undefined;
+            rekeyTo?: string | undefined;
+            staticFee?: import("./amount").AlgoAmount | undefined;
+            extraFee?: import("./amount").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?: (import("./app-manager").BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
+            sender?: string | undefined;
+            method: string;
+            args?: (algosdk.ABIValue | import("./composer").AppMethodCallTransactionArgument | ABIStruct | undefined)[] | undefined;
+        } & {
+            sender: string;
+            method: Arc56Method;
+            args: (algosdk.Transaction | algosdk.ABIValue | algosdk.TransactionWithSigner | Promise<algosdk.Transaction> | import("./composer").AppMethodCall<{
+                lease?: string | Uint8Array | undefined;
+                note?: string | Uint8Array | undefined;
+                maxFee?: import("./amount").AlgoAmount | undefined;
+                args?: Uint8Array[] | undefined;
+                signer?: algosdk.TransactionSigner | import("./account").TransactionSignerAccount | undefined;
+                sender: string;
+                rekeyTo?: string | undefined;
+                staticFee?: import("./amount").AlgoAmount | undefined;
+                extraFee?: import("./amount").AlgoAmount | undefined;
+                validityWindow?: number | undefined;
+                firstValidRound?: bigint | undefined;
+                lastValidRound?: bigint | undefined;
+                onComplete?: algosdk.OnApplicationComplete.NoOpOC | algosdk.OnApplicationComplete.OptInOC | algosdk.OnApplicationComplete.CloseOutOC | algosdk.OnApplicationComplete.UpdateApplicationOC | algosdk.OnApplicationComplete.DeleteApplicationOC | undefined;
+                accountReferences?: string[] | undefined;
+                appReferences?: bigint[] | undefined;
+                assetReferences?: bigint[] | undefined;
+                boxReferences?: (import("./app-manager").BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
+                approvalProgram: string | Uint8Array;
+                clearStateProgram: string | Uint8Array;
+                schema?: {
+                    globalInts: number;
+                    globalByteSlices: number;
+                    localInts: number;
+                    localByteSlices: number;
+                } | undefined;
+                extraProgramPages?: number | undefined;
+            }> | import("./composer").AppMethodCall<{
+                sender: string;
+                signer?: algosdk.TransactionSigner | import("./account").TransactionSignerAccount | undefined;
+                rekeyTo?: string | undefined;
+                note?: string | Uint8Array | undefined;
+                lease?: string | Uint8Array | undefined;
+                staticFee?: import("./amount").AlgoAmount | undefined;
+                extraFee?: import("./amount").AlgoAmount | undefined;
+                maxFee?: import("./amount").AlgoAmount | undefined;
+                validityWindow?: number | undefined;
+                firstValidRound?: bigint | undefined;
+                lastValidRound?: bigint | undefined;
+                appId: bigint;
+                onComplete?: algosdk.OnApplicationComplete.UpdateApplicationOC | undefined;
+                args?: Uint8Array[] | undefined;
+                accountReferences?: string[] | undefined;
+                appReferences?: bigint[] | undefined;
+                assetReferences?: bigint[] | undefined;
+                boxReferences?: (import("./app-manager").BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
+                approvalProgram: string | Uint8Array;
+                clearStateProgram: string | Uint8Array;
+            }> | import("./composer").AppMethodCall<import("./composer").AppMethodCallParams>)[] | undefined;
+            onComplete: algosdk.OnApplicationComplete.DeleteApplicationOC;
+        };
+        bare: {
+            /** Return params for a create bare call, including deploy-time TEAL template replacements and compilation if provided */
+            create: (params?: {
+                lease?: string | Uint8Array | undefined;
+                note?: string | Uint8Array | undefined;
+                maxFee?: import("./amount").AlgoAmount | undefined;
+                args?: Uint8Array[] | undefined;
+                signer?: algosdk.TransactionSigner | import("./account").TransactionSignerAccount | undefined;
+                rekeyTo?: string | undefined;
+                staticFee?: import("./amount").AlgoAmount | undefined;
+                extraFee?: import("./amount").AlgoAmount | undefined;
+                validityWindow?: number | undefined;
+                firstValidRound?: bigint | undefined;
+                lastValidRound?: bigint | undefined;
+                accountReferences?: string[] | undefined;
+                appReferences?: bigint[] | undefined;
+                assetReferences?: bigint[] | undefined;
+                boxReferences?: (import("./app-manager").BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
+                sender?: string | undefined;
+                deployTimeParams?: TealTemplateParams | undefined;
+                updatable?: boolean | undefined;
+                deletable?: boolean | undefined;
+                onComplete?: algosdk.OnApplicationComplete.NoOpOC | algosdk.OnApplicationComplete.OptInOC | algosdk.OnApplicationComplete.CloseOutOC | algosdk.OnApplicationComplete.UpdateApplicationOC | algosdk.OnApplicationComplete.DeleteApplicationOC | undefined;
+                schema?: {
+                    /** The number of integers saved in global state. */
+                    globalInts: number;
+                    /** The number of byte slices saved in global state. */
+                    globalByteSlices: number;
+                    /** The number of integers saved in local state. */
+                    localInts: number;
+                    /** The number of byte slices saved in local state. */
+                    localByteSlices: number;
+                } | undefined;
+                extraProgramPages?: number | undefined;
+            } | undefined) => Promise<({
+                approvalProgram: Buffer;
+                clearStateProgram: Buffer;
+                compiledApproval?: undefined;
+                compiledClear?: undefined;
+                deployTimeParams: TealTemplateParams | undefined;
+                schema: {
+                    /** The number of integers saved in global state. */
+                    globalInts: number;
+                    /** The number of byte slices saved in global state. */
+                    globalByteSlices: number;
+                    /** The number of integers saved in local state. */
+                    localInts: number;
+                    /** The number of byte slices saved in local state. */
+                    localByteSlices: number;
+                };
+                lease?: string | Uint8Array | undefined;
+                note?: string | Uint8Array | undefined;
+                maxFee?: import("./amount").AlgoAmount | undefined;
+                args?: Uint8Array[] | undefined;
+                signer?: algosdk.TransactionSigner | import("./account").TransactionSignerAccount | undefined;
+                rekeyTo?: string | undefined;
+                staticFee?: import("./amount").AlgoAmount | undefined;
+                extraFee?: import("./amount").AlgoAmount | undefined;
+                validityWindow?: number | undefined;
+                firstValidRound?: bigint | undefined;
+                lastValidRound?: bigint | undefined;
+                accountReferences?: string[] | undefined;
+                appReferences?: bigint[] | undefined;
+                assetReferences?: bigint[] | undefined;
+                boxReferences?: (import("./app-manager").BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
+                sender?: string | undefined;
+                updatable?: boolean | undefined;
+                deletable?: boolean | undefined;
+                onComplete?: algosdk.OnApplicationComplete.NoOpOC | algosdk.OnApplicationComplete.OptInOC | algosdk.OnApplicationComplete.CloseOutOC | algosdk.OnApplicationComplete.UpdateApplicationOC | algosdk.OnApplicationComplete.DeleteApplicationOC | undefined;
+                extraProgramPages?: number | undefined;
+            } | {
+                approvalProgram: Uint8Array;
+                compiledApproval: import("./app").CompiledTeal;
+                clearStateProgram: Uint8Array;
+                compiledClear: import("./app").CompiledTeal;
+                deployTimeParams: TealTemplateParams | undefined;
+                schema: {
+                    /** The number of integers saved in global state. */
+                    globalInts: number;
+                    /** The number of byte slices saved in global state. */
+                    globalByteSlices: number;
+                    /** The number of integers saved in local state. */
+                    localInts: number;
+                    /** The number of byte slices saved in local state. */
+                    localByteSlices: number;
+                };
+                lease?: string | Uint8Array | undefined;
+                note?: string | Uint8Array | undefined;
+                maxFee?: import("./amount").AlgoAmount | undefined;
+                args?: Uint8Array[] | undefined;
+                signer?: algosdk.TransactionSigner | import("./account").TransactionSignerAccount | undefined;
+                rekeyTo?: string | undefined;
+                staticFee?: import("./amount").AlgoAmount | undefined;
+                extraFee?: import("./amount").AlgoAmount | undefined;
+                validityWindow?: number | undefined;
+                firstValidRound?: bigint | undefined;
+                lastValidRound?: bigint | undefined;
+                accountReferences?: string[] | undefined;
+                appReferences?: bigint[] | undefined;
+                assetReferences?: bigint[] | undefined;
+                boxReferences?: (import("./app-manager").BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
+                sender?: string | undefined;
+                updatable?: boolean | undefined;
+                deletable?: boolean | undefined;
+                onComplete?: algosdk.OnApplicationComplete.NoOpOC | algosdk.OnApplicationComplete.OptInOC | algosdk.OnApplicationComplete.CloseOutOC | algosdk.OnApplicationComplete.UpdateApplicationOC | algosdk.OnApplicationComplete.DeleteApplicationOC | undefined;
+                extraProgramPages?: number | undefined;
+            }) & {
+                sender: string;
+                onComplete: algosdk.OnApplicationComplete.NoOpOC | algosdk.OnApplicationComplete.OptInOC | algosdk.OnApplicationComplete.CloseOutOC | algosdk.OnApplicationComplete.UpdateApplicationOC | algosdk.OnApplicationComplete.DeleteApplicationOC;
+            }>;
+            /** Return params for a deployment update bare call */
+            deployUpdate: (params?: {
+                lease?: string | Uint8Array | undefined;
+                note?: string | Uint8Array | undefined;
+                maxFee?: import("./amount").AlgoAmount | undefined;
+                args?: Uint8Array[] | undefined;
+                signer?: algosdk.TransactionSigner | import("./account").TransactionSignerAccount | undefined;
+                rekeyTo?: string | undefined;
+                staticFee?: import("./amount").AlgoAmount | undefined;
+                extraFee?: import("./amount").AlgoAmount | undefined;
+                validityWindow?: number | undefined;
+                firstValidRound?: bigint | undefined;
+                lastValidRound?: bigint | undefined;
+                accountReferences?: string[] | undefined;
+                appReferences?: bigint[] | undefined;
+                assetReferences?: bigint[] | undefined;
+                boxReferences?: (import("./app-manager").BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
+                sender?: string | undefined;
+            } | undefined) => {
+                lease?: string | Uint8Array | undefined;
+                note?: string | Uint8Array | undefined;
+                maxFee?: import("./amount").AlgoAmount | undefined;
+                args?: Uint8Array[] | undefined;
+                signer?: algosdk.TransactionSigner | import("./account").TransactionSignerAccount | undefined;
+                rekeyTo?: string | undefined;
+                staticFee?: import("./amount").AlgoAmount | undefined;
+                extraFee?: import("./amount").AlgoAmount | undefined;
+                validityWindow?: number | undefined;
+                firstValidRound?: bigint | undefined;
+                lastValidRound?: bigint | undefined;
+                accountReferences?: string[] | undefined;
+                appReferences?: bigint[] | undefined;
+                assetReferences?: bigint[] | undefined;
+                boxReferences?: (import("./app-manager").BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
+                sender?: string | undefined;
+            } & {
+                sender: string;
+                onComplete: algosdk.OnApplicationComplete.UpdateApplicationOC;
+            };
+            /** Return params for a deployment delete bare call */
+            deployDelete: (params?: {
+                lease?: string | Uint8Array | undefined;
+                note?: string | Uint8Array | undefined;
+                maxFee?: import("./amount").AlgoAmount | undefined;
+                args?: Uint8Array[] | undefined;
+                signer?: algosdk.TransactionSigner | import("./account").TransactionSignerAccount | undefined;
+                rekeyTo?: string | undefined;
+                staticFee?: import("./amount").AlgoAmount | undefined;
+                extraFee?: import("./amount").AlgoAmount | undefined;
+                validityWindow?: number | undefined;
+                firstValidRound?: bigint | undefined;
+                lastValidRound?: bigint | undefined;
+                accountReferences?: string[] | undefined;
+                appReferences?: bigint[] | undefined;
+                assetReferences?: bigint[] | undefined;
+                boxReferences?: (import("./app-manager").BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
+                sender?: string | undefined;
+            } | undefined) => {
+                lease?: string | Uint8Array | undefined;
+                note?: string | Uint8Array | undefined;
+                maxFee?: import("./amount").AlgoAmount | undefined;
+                args?: Uint8Array[] | undefined;
+                signer?: algosdk.TransactionSigner | import("./account").TransactionSignerAccount | undefined;
+                rekeyTo?: string | undefined;
+                staticFee?: import("./amount").AlgoAmount | undefined;
+                extraFee?: import("./amount").AlgoAmount | undefined;
+                validityWindow?: number | undefined;
+                firstValidRound?: bigint | undefined;
+                lastValidRound?: bigint | undefined;
+                accountReferences?: string[] | undefined;
+                appReferences?: bigint[] | undefined;
+                assetReferences?: bigint[] | undefined;
+                boxReferences?: (import("./app-manager").BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
+                sender?: string | undefined;
+            } & {
+                sender: string;
+                onComplete: algosdk.OnApplicationComplete.DeleteApplicationOC;
+            };
+        };
+    };
+    /**
+     * Creates an instance of the app and returns the result of the creation
+     * transaction and an app client to interact with that app instance.
+     *
+     * Performs deploy-time TEAL template placeholder substitutions (if specified).
+     * @param params The parameters to create the app
+     * @returns The app client and the result of the creation transaction
+     */
+    create(params?: AppFactoryCreateParams): Promise<{
+        app: AppClient;
+        result: {
+            compiledApproval?: import("./app").CompiledTeal | undefined;
+            compiledClear?: import("./app").CompiledTeal | undefined;
+            appId: bigint;
+            groupId: string;
+            txIds: string[];
+            returns?: import("./app").ABIReturn[] | undefined;
+            confirmations: algosdk.modelsv2.PendingTransactionResponse[];
+            transactions: algosdk.Transaction[];
+            confirmation: algosdk.modelsv2.PendingTransactionResponse;
+            transaction: algosdk.Transaction;
+            appAddress: string;
+            return?: algosdk.ABIValue | ABIStruct | undefined;
+        } | {
+            compiledApproval?: import("./app").CompiledTeal | undefined;
+            compiledClear?: import("./app").CompiledTeal | undefined;
+            return: undefined;
+            groupId: string;
+            txIds: string[];
+            returns?: import("./app").ABIReturn[] | undefined;
+            confirmations: algosdk.modelsv2.PendingTransactionResponse[];
+            transactions: algosdk.Transaction[];
+            confirmation: algosdk.modelsv2.PendingTransactionResponse;
+            transaction: algosdk.Transaction;
+            appId: bigint;
+            appAddress: string;
+        };
+    }>;
+    /**
+     * Idempotently deploy (create if not exists, update if changed) an app against the given name for the given creator account, including deploy-time TEAL template placeholder substitutions (if specified).
+     *
+     * **Note:** When using the return from this function be sure to check `operationPerformed` to get access to various return properties like `transaction`, `confirmation` and `deleteResult`.
+     *
+     * **Note:** if there is a breaking state schema change to an existing app (and `onSchemaBreak` is set to `'replace'`) the existing app will be deleted and re-created.
+     *
+     * **Note:** if there is an update (different TEAL code) to an existing app (and `onUpdate` is set to `'replace'`) the existing app will be deleted and re-created.
+     * @param params The arguments to control the app deployment
+     * @returns The app client and the result of the deployment
+     */
+    deploy(params: AppFactoryDeployParams): Promise<{
+        app: AppClient;
+        result: {
+            return: algosdk.ABIValue | ABIStruct | undefined;
+            deleteReturn: algosdk.ABIValue | ABIStruct | undefined;
+            approvalProgram: Buffer;
+            clearStateProgram: Buffer;
+            compiledApproval?: import("./app").CompiledTeal | undefined;
+            compiledClear?: import("./app").CompiledTeal | undefined;
+            operationPerformed: "create";
+            version: string;
+            name: string;
+            deleted: boolean;
+            createdRound: bigint;
+            updatedRound: bigint;
+            createdMetadata: import("./app").AppDeployMetadata;
+            deletable?: boolean | undefined;
+            updatable?: boolean | undefined;
+            groupId: string;
+            txIds: string[];
+            returns?: import("./app").ABIReturn[] | undefined;
+            confirmations: algosdk.modelsv2.PendingTransactionResponse[];
+            transactions: algosdk.Transaction[];
+            confirmation: algosdk.modelsv2.PendingTransactionResponse;
+            transaction: algosdk.Transaction;
+            appId: bigint;
+            appAddress: string;
+        } | {
+            return: algosdk.ABIValue | ABIStruct | undefined;
+            deleteReturn: algosdk.ABIValue | ABIStruct | undefined;
+            approvalProgram: Uint8Array;
+            compiledApproval: import("./app").CompiledTeal;
+            clearStateProgram: Uint8Array;
+            compiledClear: import("./app").CompiledTeal;
+            operationPerformed: "create";
+            version: string;
+            name: string;
+            deleted: boolean;
+            createdRound: bigint;
+            updatedRound: bigint;
+            createdMetadata: import("./app").AppDeployMetadata;
+            deletable?: boolean | undefined;
+            updatable?: boolean | undefined;
+            groupId: string;
+            txIds: string[];
+            returns?: import("./app").ABIReturn[] | undefined;
+            confirmations: algosdk.modelsv2.PendingTransactionResponse[];
+            transactions: algosdk.Transaction[];
+            confirmation: algosdk.modelsv2.PendingTransactionResponse;
+            transaction: algosdk.Transaction;
+            appId: bigint;
+            appAddress: string;
+        } | {
+            return: algosdk.ABIValue | ABIStruct | undefined;
+            deleteReturn: algosdk.ABIValue | ABIStruct | undefined;
+            approvalProgram: Buffer;
+            clearStateProgram: Buffer;
+            compiledApproval?: import("./app").CompiledTeal | undefined;
+            compiledClear?: import("./app").CompiledTeal | undefined;
+            operationPerformed: "update";
+            appId: bigint;
+            appAddress: string;
+            createdRound: bigint;
+            updatedRound: bigint;
+            createdMetadata: import("./app").AppDeployMetadata;
+            deleted: boolean;
+            name: string;
+            version: string;
+            deletable?: boolean | undefined;
+            updatable?: boolean | undefined;
+            groupId: string;
+            txIds: string[];
+            returns?: import("./app").ABIReturn[] | undefined;
+            confirmations: algosdk.modelsv2.PendingTransactionResponse[];
+            transactions: algosdk.Transaction[];
+            confirmation: algosdk.modelsv2.PendingTransactionResponse;
+            transaction: algosdk.Transaction;
+        } | {
+            return: algosdk.ABIValue | ABIStruct | undefined;
+            deleteReturn: algosdk.ABIValue | ABIStruct | undefined;
+            approvalProgram: Uint8Array;
+            compiledApproval: import("./app").CompiledTeal;
+            clearStateProgram: Uint8Array;
+            compiledClear: import("./app").CompiledTeal;
+            operationPerformed: "update";
+            appId: bigint;
+            appAddress: string;
+            createdRound: bigint;
+            updatedRound: bigint;
+            createdMetadata: import("./app").AppDeployMetadata;
+            deleted: boolean;
+            name: string;
+            version: string;
+            deletable?: boolean | undefined;
+            updatable?: boolean | undefined;
+            groupId: string;
+            txIds: string[];
+            returns?: import("./app").ABIReturn[] | undefined;
+            confirmations: algosdk.modelsv2.PendingTransactionResponse[];
+            transactions: algosdk.Transaction[];
+            confirmation: algosdk.modelsv2.PendingTransactionResponse;
+            transaction: algosdk.Transaction;
+        } | {
+            return: algosdk.ABIValue | ABIStruct | undefined;
+            deleteReturn: algosdk.ABIValue | ABIStruct | undefined;
+            approvalProgram: Buffer;
+            clearStateProgram: Buffer;
+            compiledApproval?: import("./app").CompiledTeal | undefined;
+            compiledClear?: import("./app").CompiledTeal | undefined;
+            operationPerformed: "replace";
+            version: string;
+            name: string;
+            deleted: boolean;
+            createdRound: bigint;
+            updatedRound: bigint;
+            createdMetadata: import("./app").AppDeployMetadata;
+            deletable?: boolean | undefined;
+            updatable?: boolean | undefined;
+            groupId: string;
+            txIds: string[];
+            returns?: import("./app").ABIReturn[] | undefined;
+            confirmations: algosdk.modelsv2.PendingTransactionResponse[];
+            transactions: algosdk.Transaction[];
+            confirmation: algosdk.modelsv2.PendingTransactionResponse;
+            transaction: algosdk.Transaction;
+            appId: bigint;
+            appAddress: string;
+            deleteResult: import("./transaction").ConfirmedTransactionResult;
+        } | {
+            return: algosdk.ABIValue | ABIStruct | undefined;
+            deleteReturn: algosdk.ABIValue | ABIStruct | undefined;
+            approvalProgram: Uint8Array;
+            compiledApproval: import("./app").CompiledTeal;
+            clearStateProgram: Uint8Array;
+            compiledClear: import("./app").CompiledTeal;
+            operationPerformed: "replace";
+            version: string;
+            name: string;
+            deleted: boolean;
+            createdRound: bigint;
+            updatedRound: bigint;
+            createdMetadata: import("./app").AppDeployMetadata;
+            deletable?: boolean | undefined;
+            updatable?: boolean | undefined;
+            groupId: string;
+            txIds: string[];
+            returns?: import("./app").ABIReturn[] | undefined;
+            confirmations: algosdk.modelsv2.PendingTransactionResponse[];
+            transactions: algosdk.Transaction[];
+            confirmation: algosdk.modelsv2.PendingTransactionResponse;
+            transaction: algosdk.Transaction;
+            appId: bigint;
+            appAddress: string;
+            deleteResult: import("./transaction").ConfirmedTransactionResult;
+        } | {
+            return: algosdk.ABIValue | ABIStruct | undefined;
+            deleteReturn: algosdk.ABIValue | ABIStruct | undefined;
+            approvalProgram: Buffer;
+            clearStateProgram: Buffer;
+            compiledApproval?: undefined;
+            compiledClear?: undefined;
+            operationPerformed: "nothing";
+            appId: bigint;
+            appAddress: string;
+            createdRound: bigint;
+            updatedRound: bigint;
+            createdMetadata: import("./app").AppDeployMetadata;
+            deleted: boolean;
+            name: string;
+            version: string;
+            deletable?: boolean | undefined;
+            updatable?: boolean | undefined;
+        } | {
+            return: algosdk.ABIValue | ABIStruct | undefined;
+            deleteReturn: algosdk.ABIValue | ABIStruct | undefined;
+            approvalProgram: Uint8Array;
+            compiledApproval: import("./app").CompiledTeal;
+            clearStateProgram: Uint8Array;
+            compiledClear: import("./app").CompiledTeal;
+            operationPerformed: "nothing";
+            appId: bigint;
+            appAddress: string;
+            createdRound: bigint;
+            updatedRound: bigint;
+            createdMetadata: import("./app").AppDeployMetadata;
+            deleted: boolean;
+            name: string;
+            version: string;
+            deletable?: boolean | undefined;
+            updatable?: boolean | undefined;
+        };
+    }>;
+    /**
+     * Returns a new `AppClient` client for an app instance of the given ID.
+     *
+     * Automatically populates appName, defaultSender and source maps from the factory
+     * if not specified in the params.
+     * @param params The parameters to create the app client
+     * @returns The `AppClient`
+     */
+    getAppClientById(params: Expand<Omit<AppClientParams, 'algorand' | 'appSpec'>>): AppClient;
+    /**
+     * Returns a new `AppClient` client, resolving the app by creator address and name
+     * using AlgoKit app deployment semantics (i.e. looking for the app creation transaction note).
+     *
+     * Automatically populates appName, defaultSender and source maps from the factory
+     * if not specified in the params.
+     * @param params The parameters to create the app client
+     * @returns The `AppClient`
+     */
+    getAppClientByCreatorAddressAndName(params: Expand<Omit<AppClientParams, 'algorand' | 'appSpec' | 'appId'> & ResolveAppClientByCreatorAndName>): Promise<AppClient>;
+    /**
+     * 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.
+     * @param e The error to parse
+     * @param isClearStateProgram Whether or not the code was running the clear state program (defaults to approval program)
+     * @returns The new error, or if there was no logic error or source map then the wrapped error with source details
+     */
+    exposeLogicError(e: Error, isClearStateProgram?: boolean): Error;
+    /**
+     * Export the current source maps for the app.
+     * @returns The source maps
+     */
+    exportSourceMaps(): AppSourceMaps;
+    /**
+     * Import source maps for the app.
+     * @param sourceMaps The source maps to import
+     */
+    importSourceMaps(sourceMaps: AppSourceMaps): void;
+    private getDeployTimeControl;
+    private getParamsMethods;
+    /** Make the given call and catch any errors, augmenting with debugging information before re-throwing. */
+    private handleCallErrors;
+    /**
+     * 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 getBareParams;
+    private getABIParams;
+    /** Returns the sender for a call, using the `defaultSender`
+     * if none provided and throws an error if neither provided */
+    private getSender;
+    /**
+     * Checks for decode errors on the SendAppTransactionResult and maps the return value to the specified type
+     * on the ARC-56 method.
+     *
+     * If the return type is a 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>>>;
+}
+//# sourceMappingURL=app-factory.d.ts.map