@algorandfoundation/algokit-utils 10.0.0-alpha.31 → 10.0.0-alpha.32

package/app-factory.d.ts

@@ -0,0 +1,965 @@
+import { Address, ReadableAddress } from "./packages/common/src/address.js";
+import { Expand } from "./packages/common/src/expand.js";
+import { ABIValue } from "./packages/abi/src/abi-value.js";
+import { Arc56Contract } from "./packages/abi/src/arc56-contract.js";
+import { ABIMethod, ABIReturn } from "./packages/abi/src/abi-method.js";
+import { OnApplicationComplete, ResourceReference } from "./packages/transact/src/transactions/app-call.js";
+import { Transaction } from "./packages/transact/src/transactions/transaction.js";
+import { AddressWithTransactionSigner, SendingAddress, TransactionSigner } from "./packages/transact/src/signer.js";
+import { PendingTransactionResponse } from "./packages/algod_client/src/models/pending-transaction-response.js";
+import { AlgoAmount } from "./amount.js";
+import { ConfirmedTransactionResult, SendParams } from "./transaction/types.js";
+import { TransactionWithSigner } from "./transaction/transaction.js";
+import { AppDeployMetadata, CompiledTeal, TealTemplateParams } from "./app.js";
+import { BoxIdentifier, BoxReference } from "./app-manager.js";
+import { AppMethodCallParams } from "./transactions/app-call.js";
+import { AppMethodCall, AppMethodCallTransactionArgument } from "./transactions/method-call.js";
+import { AppDeployParams } from "./app-deployer.js";
+import { AlgorandClient } from "./algorand-client.js";
+import { AppSpec } from "./app-spec.js";
+import { AppClient, AppClientBareCallParams, AppClientCompilationParams, AppClientCompilationResult, AppClientMethodCallParams, AppClientParams, AppSourceMaps, ResolveAppClientByCreatorAndName } from "./app-client.js";
+
+//#region src/app-factory.d.ts
+/** Parameters to create an app client */
+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: AlgorandClient;
+  /**
+   * 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?: ReadableAddress;
+  /** Optional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from `AlgorandClient`). */
+  defaultSigner?: TransactionSigner;
+  /** 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 */
+type CreateOnComplete = {
+  onComplete?: Exclude<OnApplicationComplete, OnApplicationComplete.ClearState>;
+};
+/** Specifies a schema used for creating an app */
+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;
+};
+/** Params to specify a bare (raw) create call for an app */
+type AppFactoryCreateParams = Expand<AppClientBareCallParams & AppClientCompilationParams & CreateOnComplete & CreateSchema>;
+/** Params to specify a create method call for an app */
+type AppFactoryCreateMethodCallParams = Expand<AppClientMethodCallParams & AppClientCompilationParams & CreateOnComplete & CreateSchema>;
+/** Params to get an app client by ID from an app factory. */
+type AppFactoryAppClientParams = Expand<Omit<AppClientParams, 'algorand' | 'appSpec'>>;
+/** Params to get an app client by creator address and name from an app factory. */
+type AppFactoryResolveAppClientByCreatorAndNameParams = Expand<Omit<ResolveAppClientByCreatorAndName, 'algorand' | 'appSpec'>>;
+/** Parameters to define a deployment for an `AppFactory` */
+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;
+  /** Override the app name for this deployment */
+  appName?: string;
+}>;
+/**
+ * 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.
+ */
+declare class AppFactory {
+  private _appSpec;
+  private _appName;
+  private _algorand;
+  private _version;
+  private _defaultSender?;
+  private _defaultSigner?;
+  private _deployTimeParams?;
+  private _updatable?;
+  private _deletable?;
+  private _approvalSourceMap;
+  private _clearSourceMap;
+  private _paramsMethods;
+  /**
+   * Create a new app factory.
+   * @param params The parameters to create the app factory
+   * @returns The `AppFactory` instance
+   * @example
+   * ```typescript
+   * const appFactory = new AppFactory({
+   *   appSpec: appSpec,
+   *   algorand: AlgorandClient.mainNet(),
+   * })
+   */
+  constructor(params: AppFactoryParams);
+  /** The name of the app (from the ARC-32 / ARC-56 app spec or override). */
+  get appName(): string;
+  /** The ARC-56 app spec being used */
+  get appSpec(): Arc56Contract;
+  /** Return the algorand client this factory is using. */
+  get algorand(): AlgorandClient;
+  /** Get parameters to create transactions (create and deploy related calls) for the current app.
+   *
+   * A good mental model for this is that these parameters represent a deferred transaction creation.
+   * @example Create a transaction in the future using Algorand Client
+   * ```typescript
+   * const createAppParams = appFactory.params.create({method: 'create_method', args: [123, 'hello']})
+   * // ...
+   * await algorand.send.AppCreateMethodCall(createAppParams)
+   * ```
+   * @example Define a nested transaction as an ABI argument
+   * ```typescript
+   * const createAppParams = appFactory.params.create({method: 'create_method', args: [123, 'hello']})
+   * await appClient.send.call({method: 'my_method', args: [createAppParams]})
+   * ```
+   */
+  get params(): {
+    /** Return params for a create ABI call, including deploy-time TEAL template replacements and compilation if provided */
+    create: (params: {
+      signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
+      rekeyTo?: ReadableAddress | undefined;
+      note?: string | Uint8Array | undefined;
+      lease?: string | Uint8Array | undefined;
+      staticFee?: AlgoAmount | undefined;
+      extraFee?: AlgoAmount | undefined;
+      maxFee?: AlgoAmount | undefined;
+      validityWindow?: number | bigint | undefined;
+      firstValidRound?: bigint | undefined;
+      lastValidRound?: bigint | undefined;
+      onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.UpdateApplication | OnApplicationComplete.DeleteApplication | undefined;
+      accountReferences?: ReadableAddress[] | undefined;
+      appReferences?: bigint[] | undefined;
+      assetReferences?: bigint[] | undefined;
+      boxReferences?: (BoxIdentifier | BoxReference)[] | undefined;
+      accessReferences?: ResourceReference[] | undefined;
+      rejectVersion?: number | undefined;
+      sender?: ReadableAddress | undefined;
+      method: string;
+      args?: (ABIValue | AppMethodCallTransactionArgument | 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<{
+      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;
+      };
+      approvalProgram: Uint8Array;
+      clearStateProgram: Uint8Array;
+      signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
+      rekeyTo?: ReadableAddress | undefined;
+      note?: string | Uint8Array | undefined;
+      lease?: string | Uint8Array | undefined;
+      staticFee?: AlgoAmount | undefined;
+      extraFee?: AlgoAmount | undefined;
+      maxFee?: AlgoAmount | undefined;
+      validityWindow?: number | bigint | undefined;
+      firstValidRound?: bigint | undefined;
+      lastValidRound?: bigint | undefined;
+      onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.UpdateApplication | OnApplicationComplete.DeleteApplication | undefined;
+      accountReferences?: ReadableAddress[] | undefined;
+      appReferences?: bigint[] | undefined;
+      assetReferences?: bigint[] | undefined;
+      boxReferences?: (BoxIdentifier | BoxReference)[] | undefined;
+      accessReferences?: ResourceReference[] | undefined;
+      rejectVersion?: number | undefined;
+      sender?: ReadableAddress | undefined;
+      method: string;
+      args?: (ABIValue | AppMethodCallTransactionArgument | undefined)[] | undefined;
+      updatable?: boolean | undefined;
+      deletable?: boolean | undefined;
+      extraProgramPages?: number | undefined;
+    } & {
+      sender: Address;
+      signer: AddressWithTransactionSigner | TransactionSigner | undefined;
+      method: ABIMethod;
+      args: (ABIValue | TransactionWithSigner | Transaction | AppMethodCall<{
+        sender: SendingAddress;
+        signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
+        rekeyTo?: ReadableAddress | undefined;
+        note?: string | Uint8Array | undefined;
+        lease?: string | Uint8Array | undefined;
+        staticFee?: AlgoAmount | undefined;
+        extraFee?: AlgoAmount | undefined;
+        maxFee?: AlgoAmount | undefined;
+        validityWindow?: number | bigint | undefined;
+        firstValidRound?: bigint | undefined;
+        lastValidRound?: bigint | undefined;
+        appId: bigint;
+        onComplete?: OnApplicationComplete.UpdateApplication | undefined;
+        args?: Uint8Array[] | undefined;
+        accountReferences?: ReadableAddress[] | undefined;
+        appReferences?: bigint[] | undefined;
+        assetReferences?: bigint[] | undefined;
+        boxReferences?: (BoxIdentifier | BoxReference)[] | undefined;
+        accessReferences?: ResourceReference[] | undefined;
+        rejectVersion?: number | undefined;
+        approvalProgram: string | Uint8Array;
+        clearStateProgram: string | Uint8Array;
+      }> | AppMethodCall<AppMethodCallParams> | AppMethodCall<{
+        sender: SendingAddress;
+        signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
+        rekeyTo?: ReadableAddress | undefined;
+        note?: string | Uint8Array | undefined;
+        lease?: string | Uint8Array | undefined;
+        staticFee?: AlgoAmount | undefined;
+        extraFee?: AlgoAmount | undefined;
+        maxFee?: AlgoAmount | undefined;
+        validityWindow?: number | bigint | undefined;
+        firstValidRound?: bigint | undefined;
+        lastValidRound?: bigint | undefined;
+        onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.UpdateApplication | OnApplicationComplete.DeleteApplication | undefined;
+        args?: Uint8Array[] | undefined;
+        accountReferences?: ReadableAddress[] | undefined;
+        appReferences?: bigint[] | undefined;
+        assetReferences?: bigint[] | undefined;
+        boxReferences?: (BoxIdentifier | BoxReference)[] | undefined;
+        accessReferences?: ResourceReference[] | undefined;
+        rejectVersion?: number | undefined;
+        appId?: 0 | undefined;
+        approvalProgram: string | Uint8Array;
+        clearStateProgram: string | Uint8Array;
+        schema?: {
+          globalInts: number;
+          globalByteSlices: number;
+          localInts: number;
+          localByteSlices: number;
+        } | undefined;
+        extraProgramPages?: number | undefined;
+      }> | Promise<Transaction> | undefined)[] | undefined;
+      onComplete: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.UpdateApplication | OnApplicationComplete.DeleteApplication;
+    }>;
+    /** Return params for a deployment update ABI call */
+    deployUpdate: (params: {
+      signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
+      rekeyTo?: ReadableAddress | undefined;
+      note?: string | Uint8Array | undefined;
+      lease?: string | Uint8Array | undefined;
+      staticFee?: AlgoAmount | undefined;
+      extraFee?: AlgoAmount | undefined;
+      maxFee?: AlgoAmount | undefined;
+      validityWindow?: number | bigint | undefined;
+      firstValidRound?: bigint | undefined;
+      lastValidRound?: bigint | undefined;
+      onComplete?: OnApplicationComplete | undefined;
+      accountReferences?: ReadableAddress[] | undefined;
+      appReferences?: bigint[] | undefined;
+      assetReferences?: bigint[] | undefined;
+      boxReferences?: (BoxIdentifier | BoxReference)[] | undefined;
+      accessReferences?: ResourceReference[] | undefined;
+      rejectVersion?: number | undefined;
+      sender?: ReadableAddress | undefined;
+      method: string;
+      args?: (ABIValue | AppMethodCallTransactionArgument | undefined)[] | undefined;
+    }) => {
+      signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
+      rekeyTo?: ReadableAddress | undefined;
+      note?: string | Uint8Array | undefined;
+      lease?: string | Uint8Array | undefined;
+      staticFee?: AlgoAmount | undefined;
+      extraFee?: AlgoAmount | undefined;
+      maxFee?: AlgoAmount | undefined;
+      validityWindow?: number | bigint | undefined;
+      firstValidRound?: bigint | undefined;
+      lastValidRound?: bigint | undefined;
+      onComplete?: OnApplicationComplete | undefined;
+      accountReferences?: ReadableAddress[] | undefined;
+      appReferences?: bigint[] | undefined;
+      assetReferences?: bigint[] | undefined;
+      boxReferences?: (BoxIdentifier | BoxReference)[] | undefined;
+      accessReferences?: ResourceReference[] | undefined;
+      rejectVersion?: number | undefined;
+      sender?: ReadableAddress | undefined;
+      method: string;
+      args?: (ABIValue | AppMethodCallTransactionArgument | undefined)[] | undefined;
+    } & {
+      sender: Address;
+      signer: AddressWithTransactionSigner | TransactionSigner | undefined;
+      method: ABIMethod;
+      args: (ABIValue | TransactionWithSigner | Transaction | AppMethodCall<{
+        sender: SendingAddress;
+        signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
+        rekeyTo?: ReadableAddress | undefined;
+        note?: string | Uint8Array | undefined;
+        lease?: string | Uint8Array | undefined;
+        staticFee?: AlgoAmount | undefined;
+        extraFee?: AlgoAmount | undefined;
+        maxFee?: AlgoAmount | undefined;
+        validityWindow?: number | bigint | undefined;
+        firstValidRound?: bigint | undefined;
+        lastValidRound?: bigint | undefined;
+        appId: bigint;
+        onComplete?: OnApplicationComplete.UpdateApplication | undefined;
+        args?: Uint8Array[] | undefined;
+        accountReferences?: ReadableAddress[] | undefined;
+        appReferences?: bigint[] | undefined;
+        assetReferences?: bigint[] | undefined;
+        boxReferences?: (BoxIdentifier | BoxReference)[] | undefined;
+        accessReferences?: ResourceReference[] | undefined;
+        rejectVersion?: number | undefined;
+        approvalProgram: string | Uint8Array;
+        clearStateProgram: string | Uint8Array;
+      }> | AppMethodCall<AppMethodCallParams> | AppMethodCall<{
+        sender: SendingAddress;
+        signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
+        rekeyTo?: ReadableAddress | undefined;
+        note?: string | Uint8Array | undefined;
+        lease?: string | Uint8Array | undefined;
+        staticFee?: AlgoAmount | undefined;
+        extraFee?: AlgoAmount | undefined;
+        maxFee?: AlgoAmount | undefined;
+        validityWindow?: number | bigint | undefined;
+        firstValidRound?: bigint | undefined;
+        lastValidRound?: bigint | undefined;
+        onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.UpdateApplication | OnApplicationComplete.DeleteApplication | undefined;
+        args?: Uint8Array[] | undefined;
+        accountReferences?: ReadableAddress[] | undefined;
+        appReferences?: bigint[] | undefined;
+        assetReferences?: bigint[] | undefined;
+        boxReferences?: (BoxIdentifier | BoxReference)[] | undefined;
+        accessReferences?: ResourceReference[] | undefined;
+        rejectVersion?: number | undefined;
+        appId?: 0 | undefined;
+        approvalProgram: string | Uint8Array;
+        clearStateProgram: string | Uint8Array;
+        schema?: {
+          globalInts: number;
+          globalByteSlices: number;
+          localInts: number;
+          localByteSlices: number;
+        } | undefined;
+        extraProgramPages?: number | undefined;
+      }> | Promise<Transaction> | undefined)[] | undefined;
+      onComplete: OnApplicationComplete.UpdateApplication;
+    };
+    /** Return params for a deployment delete ABI call */
+    deployDelete: (params: {
+      signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
+      rekeyTo?: ReadableAddress | undefined;
+      note?: string | Uint8Array | undefined;
+      lease?: string | Uint8Array | undefined;
+      staticFee?: AlgoAmount | undefined;
+      extraFee?: AlgoAmount | undefined;
+      maxFee?: AlgoAmount | undefined;
+      validityWindow?: number | bigint | undefined;
+      firstValidRound?: bigint | undefined;
+      lastValidRound?: bigint | undefined;
+      onComplete?: OnApplicationComplete | undefined;
+      accountReferences?: ReadableAddress[] | undefined;
+      appReferences?: bigint[] | undefined;
+      assetReferences?: bigint[] | undefined;
+      boxReferences?: (BoxIdentifier | BoxReference)[] | undefined;
+      accessReferences?: ResourceReference[] | undefined;
+      rejectVersion?: number | undefined;
+      sender?: ReadableAddress | undefined;
+      method: string;
+      args?: (ABIValue | AppMethodCallTransactionArgument | undefined)[] | undefined;
+    }) => {
+      signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
+      rekeyTo?: ReadableAddress | undefined;
+      note?: string | Uint8Array | undefined;
+      lease?: string | Uint8Array | undefined;
+      staticFee?: AlgoAmount | undefined;
+      extraFee?: AlgoAmount | undefined;
+      maxFee?: AlgoAmount | undefined;
+      validityWindow?: number | bigint | undefined;
+      firstValidRound?: bigint | undefined;
+      lastValidRound?: bigint | undefined;
+      onComplete?: OnApplicationComplete | undefined;
+      accountReferences?: ReadableAddress[] | undefined;
+      appReferences?: bigint[] | undefined;
+      assetReferences?: bigint[] | undefined;
+      boxReferences?: (BoxIdentifier | BoxReference)[] | undefined;
+      accessReferences?: ResourceReference[] | undefined;
+      rejectVersion?: number | undefined;
+      sender?: ReadableAddress | undefined;
+      method: string;
+      args?: (ABIValue | AppMethodCallTransactionArgument | undefined)[] | undefined;
+    } & {
+      sender: Address;
+      signer: AddressWithTransactionSigner | TransactionSigner | undefined;
+      method: ABIMethod;
+      args: (ABIValue | TransactionWithSigner | Transaction | AppMethodCall<{
+        sender: SendingAddress;
+        signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
+        rekeyTo?: ReadableAddress | undefined;
+        note?: string | Uint8Array | undefined;
+        lease?: string | Uint8Array | undefined;
+        staticFee?: AlgoAmount | undefined;
+        extraFee?: AlgoAmount | undefined;
+        maxFee?: AlgoAmount | undefined;
+        validityWindow?: number | bigint | undefined;
+        firstValidRound?: bigint | undefined;
+        lastValidRound?: bigint | undefined;
+        appId: bigint;
+        onComplete?: OnApplicationComplete.UpdateApplication | undefined;
+        args?: Uint8Array[] | undefined;
+        accountReferences?: ReadableAddress[] | undefined;
+        appReferences?: bigint[] | undefined;
+        assetReferences?: bigint[] | undefined;
+        boxReferences?: (BoxIdentifier | BoxReference)[] | undefined;
+        accessReferences?: ResourceReference[] | undefined;
+        rejectVersion?: number | undefined;
+        approvalProgram: string | Uint8Array;
+        clearStateProgram: string | Uint8Array;
+      }> | AppMethodCall<AppMethodCallParams> | AppMethodCall<{
+        sender: SendingAddress;
+        signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
+        rekeyTo?: ReadableAddress | undefined;
+        note?: string | Uint8Array | undefined;
+        lease?: string | Uint8Array | undefined;
+        staticFee?: AlgoAmount | undefined;
+        extraFee?: AlgoAmount | undefined;
+        maxFee?: AlgoAmount | undefined;
+        validityWindow?: number | bigint | undefined;
+        firstValidRound?: bigint | undefined;
+        lastValidRound?: bigint | undefined;
+        onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.UpdateApplication | OnApplicationComplete.DeleteApplication | undefined;
+        args?: Uint8Array[] | undefined;
+        accountReferences?: ReadableAddress[] | undefined;
+        appReferences?: bigint[] | undefined;
+        assetReferences?: bigint[] | undefined;
+        boxReferences?: (BoxIdentifier | BoxReference)[] | undefined;
+        accessReferences?: ResourceReference[] | undefined;
+        rejectVersion?: number | undefined;
+        appId?: 0 | undefined;
+        approvalProgram: string | Uint8Array;
+        clearStateProgram: string | Uint8Array;
+        schema?: {
+          globalInts: number;
+          globalByteSlices: number;
+          localInts: number;
+          localByteSlices: number;
+        } | undefined;
+        extraProgramPages?: number | undefined;
+      }> | Promise<Transaction> | undefined)[] | undefined;
+      onComplete: OnApplicationComplete.DeleteApplication;
+    };
+    bare: {
+      /** Return params for a create bare call, including deploy-time TEAL template replacements and compilation if provided */
+      create: (params?: {
+        signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
+        rekeyTo?: ReadableAddress | undefined;
+        note?: string | Uint8Array | undefined;
+        lease?: string | Uint8Array | undefined;
+        staticFee?: AlgoAmount | undefined;
+        extraFee?: AlgoAmount | undefined;
+        maxFee?: AlgoAmount | undefined;
+        validityWindow?: number | bigint | undefined;
+        firstValidRound?: bigint | undefined;
+        lastValidRound?: bigint | undefined;
+        args?: Uint8Array[] | undefined;
+        accountReferences?: ReadableAddress[] | undefined;
+        appReferences?: bigint[] | undefined;
+        assetReferences?: bigint[] | undefined;
+        boxReferences?: (BoxIdentifier | BoxReference)[] | undefined;
+        accessReferences?: ResourceReference[] | undefined;
+        rejectVersion?: number | undefined;
+        sender?: ReadableAddress | undefined;
+        deployTimeParams?: TealTemplateParams | undefined;
+        updatable?: boolean | undefined;
+        deletable?: boolean | undefined;
+        onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.UpdateApplication | OnApplicationComplete.DeleteApplication | 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: Uint8Array;
+        clearStateProgram: Uint8Array;
+        compiledApproval?: CompiledTeal | undefined;
+        compiledClear?: CompiledTeal | 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;
+        };
+        signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
+        rekeyTo?: ReadableAddress | undefined;
+        note?: string | Uint8Array | undefined;
+        lease?: string | Uint8Array | undefined;
+        staticFee?: AlgoAmount | undefined;
+        extraFee?: AlgoAmount | undefined;
+        maxFee?: AlgoAmount | undefined;
+        validityWindow?: number | bigint | undefined;
+        firstValidRound?: bigint | undefined;
+        lastValidRound?: bigint | undefined;
+        args?: Uint8Array[] | undefined;
+        accountReferences?: ReadableAddress[] | undefined;
+        appReferences?: bigint[] | undefined;
+        assetReferences?: bigint[] | undefined;
+        boxReferences?: (BoxIdentifier | BoxReference)[] | undefined;
+        accessReferences?: ResourceReference[] | undefined;
+        rejectVersion?: number | undefined;
+        sender?: ReadableAddress | undefined;
+        updatable?: boolean | undefined;
+        deletable?: boolean | undefined;
+        onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.UpdateApplication | OnApplicationComplete.DeleteApplication | undefined;
+        extraProgramPages?: number | undefined;
+      } & {
+        sender: Address;
+        signer: AddressWithTransactionSigner | TransactionSigner | undefined;
+        onComplete: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.UpdateApplication | OnApplicationComplete.DeleteApplication;
+      }>;
+      /** Return params for a deployment update bare call */
+      deployUpdate: (params?: {
+        signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
+        rekeyTo?: ReadableAddress | undefined;
+        note?: string | Uint8Array | undefined;
+        lease?: string | Uint8Array | undefined;
+        staticFee?: AlgoAmount | undefined;
+        extraFee?: AlgoAmount | undefined;
+        maxFee?: AlgoAmount | undefined;
+        validityWindow?: number | bigint | undefined;
+        firstValidRound?: bigint | undefined;
+        lastValidRound?: bigint | undefined;
+        args?: Uint8Array[] | undefined;
+        accountReferences?: ReadableAddress[] | undefined;
+        appReferences?: bigint[] | undefined;
+        assetReferences?: bigint[] | undefined;
+        boxReferences?: (BoxIdentifier | BoxReference)[] | undefined;
+        accessReferences?: ResourceReference[] | undefined;
+        rejectVersion?: number | undefined;
+        sender?: ReadableAddress | undefined;
+      } | undefined) => {
+        signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
+        rekeyTo?: ReadableAddress | undefined;
+        note?: string | Uint8Array | undefined;
+        lease?: string | Uint8Array | undefined;
+        staticFee?: AlgoAmount | undefined;
+        extraFee?: AlgoAmount | undefined;
+        maxFee?: AlgoAmount | undefined;
+        validityWindow?: number | bigint | undefined;
+        firstValidRound?: bigint | undefined;
+        lastValidRound?: bigint | undefined;
+        args?: Uint8Array[] | undefined;
+        accountReferences?: ReadableAddress[] | undefined;
+        appReferences?: bigint[] | undefined;
+        assetReferences?: bigint[] | undefined;
+        boxReferences?: (BoxIdentifier | BoxReference)[] | undefined;
+        accessReferences?: ResourceReference[] | undefined;
+        rejectVersion?: number | undefined;
+        sender?: ReadableAddress | undefined;
+      } & {
+        sender: Address;
+        signer: AddressWithTransactionSigner | TransactionSigner | undefined;
+        onComplete: OnApplicationComplete.UpdateApplication;
+      };
+      /** Return params for a deployment delete bare call */
+      deployDelete: (params?: {
+        signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
+        rekeyTo?: ReadableAddress | undefined;
+        note?: string | Uint8Array | undefined;
+        lease?: string | Uint8Array | undefined;
+        staticFee?: AlgoAmount | undefined;
+        extraFee?: AlgoAmount | undefined;
+        maxFee?: AlgoAmount | undefined;
+        validityWindow?: number | bigint | undefined;
+        firstValidRound?: bigint | undefined;
+        lastValidRound?: bigint | undefined;
+        args?: Uint8Array[] | undefined;
+        accountReferences?: ReadableAddress[] | undefined;
+        appReferences?: bigint[] | undefined;
+        assetReferences?: bigint[] | undefined;
+        boxReferences?: (BoxIdentifier | BoxReference)[] | undefined;
+        accessReferences?: ResourceReference[] | undefined;
+        rejectVersion?: number | undefined;
+        sender?: ReadableAddress | undefined;
+      } | undefined) => {
+        signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
+        rekeyTo?: ReadableAddress | undefined;
+        note?: string | Uint8Array | undefined;
+        lease?: string | Uint8Array | undefined;
+        staticFee?: AlgoAmount | undefined;
+        extraFee?: AlgoAmount | undefined;
+        maxFee?: AlgoAmount | undefined;
+        validityWindow?: number | bigint | undefined;
+        firstValidRound?: bigint | undefined;
+        lastValidRound?: bigint | undefined;
+        args?: Uint8Array[] | undefined;
+        accountReferences?: ReadableAddress[] | undefined;
+        appReferences?: bigint[] | undefined;
+        assetReferences?: bigint[] | undefined;
+        boxReferences?: (BoxIdentifier | BoxReference)[] | undefined;
+        accessReferences?: ResourceReference[] | undefined;
+        rejectVersion?: number | undefined;
+        sender?: ReadableAddress | undefined;
+      } & {
+        sender: Address;
+        signer: AddressWithTransactionSigner | TransactionSigner | undefined;
+        onComplete: OnApplicationComplete.DeleteApplication;
+      };
+    };
+  };
+  /** Create transactions for the current app */
+  readonly createTransaction: {
+    /** Create bare (raw) transactions for the current app */
+    bare: {
+      /**
+       * Create a create app call transaction using a bare (raw) create call.
+       *
+       * Performs deploy-time TEAL template placeholder substitutions (if specified).
+       * @param params The parameters to create the create call transaction
+       * @returns The create call transaction
+       */
+      create: (params?: AppFactoryCreateParams) => Promise<Transaction>;
+    };
+    /**
+     * Create a create app call transaction using an ABI create call.
+     *
+     * Performs deploy-time TEAL template placeholder substitutions (if specified).
+     * @param params The parameters to create the create call transaction
+     * @returns The create call transaction
+     */
+    create: (params: AppFactoryCreateMethodCallParams) => Promise<{
+      transactions: Transaction[];
+      methodCalls: Map<number, ABIMethod>;
+      signers: Map<number, TransactionSigner>;
+    }>;
+  };
+  /** Send transactions to the current app */
+  readonly send: {
+    /** Send bare (raw) transactions for the current app */
+    bare: {
+      /**
+       * Creates an instance of the app using a bare (raw) create call 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 & SendParams) => Promise<{
+        appClient: AppClient;
+        result: {
+          compiledApproval?: CompiledTeal | undefined;
+          compiledClear?: CompiledTeal | undefined;
+          return: undefined;
+          groupId: string | undefined;
+          txIds: string[];
+          returns?: ABIReturn[] | undefined;
+          confirmations: PendingTransactionResponse[];
+          transactions: Transaction[];
+          confirmation: PendingTransactionResponse;
+          transaction: Transaction;
+          appId: bigint;
+          appAddress: Address;
+        };
+      }>;
+    };
+    /**
+     * 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: AppFactoryCreateMethodCallParams & SendParams) => Promise<{
+      appClient: AppClient;
+      result: {
+        compiledApproval?: CompiledTeal | undefined;
+        compiledClear?: CompiledTeal | undefined;
+        return: ABIValue | undefined;
+        groupId: string | undefined;
+        txIds: string[];
+        returns?: ABIReturn[] | undefined;
+        confirmations: PendingTransactionResponse[];
+        transactions: Transaction[];
+        confirmation: PendingTransactionResponse;
+        transaction: Transaction;
+        appId: bigint;
+        appAddress: Address;
+      };
+    }>;
+  };
+  /**
+   * 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
+   * @example
+   * ```ts
+   * const { appClient, result } = await factory.deploy({
+   *   createParams: {
+   *     sender: 'SENDER_ADDRESS',
+   *     approvalProgram: 'APPROVAL PROGRAM',
+   *     clearStateProgram: 'CLEAR PROGRAM',
+   *     schema: {
+   *       globalByteSlices: 0,
+   *       globalInts: 0,
+   *       localByteSlices: 0,
+   *       localInts: 0
+   *     }
+   *   },
+   *   updateParams: {
+   *     sender: 'SENDER_ADDRESS'
+   *   },
+   *   deleteParams: {
+   *     sender: 'SENDER_ADDRESS'
+   *   },
+   *   onSchemaBreak: 'append',
+   *   onUpdate: 'append'
+   *  })
+   * ```
+   */
+  deploy(params: AppFactoryDeployParams): Promise<{
+    appClient: AppClient;
+    result: {
+      return: ABIValue | undefined;
+      deleteReturn: ABIValue | undefined;
+      compiledApproval?: CompiledTeal | undefined;
+      compiledClear?: CompiledTeal | undefined;
+      operationPerformed: "create";
+      createdRound: bigint;
+      updatedRound: bigint;
+      createdMetadata: AppDeployMetadata;
+      deleted: boolean;
+      name: string;
+      version: string;
+      deletable?: boolean | undefined;
+      updatable?: boolean | undefined;
+      groupId: string | undefined;
+      txIds: string[];
+      returns?: ABIReturn[] | undefined;
+      confirmations: PendingTransactionResponse[];
+      transactions: Transaction[];
+      confirmation: PendingTransactionResponse;
+      transaction: Transaction;
+      appId: bigint;
+      appAddress: Address;
+    } | {
+      return: ABIValue | undefined;
+      deleteReturn: ABIValue | undefined;
+      compiledApproval?: CompiledTeal | undefined;
+      compiledClear?: CompiledTeal | undefined;
+      operationPerformed: "update";
+      appId: bigint;
+      appAddress: Address;
+      createdRound: bigint;
+      updatedRound: bigint;
+      createdMetadata: AppDeployMetadata;
+      deleted: boolean;
+      name: string;
+      version: string;
+      deletable?: boolean | undefined;
+      updatable?: boolean | undefined;
+      groupId: string | undefined;
+      txIds: string[];
+      returns?: ABIReturn[] | undefined;
+      confirmations: PendingTransactionResponse[];
+      transactions: Transaction[];
+      confirmation: PendingTransactionResponse;
+      transaction: Transaction;
+    } | {
+      return: ABIValue | undefined;
+      deleteReturn: ABIValue | undefined;
+      compiledApproval?: CompiledTeal | undefined;
+      compiledClear?: CompiledTeal | undefined;
+      operationPerformed: "replace";
+      createdRound: bigint;
+      updatedRound: bigint;
+      createdMetadata: AppDeployMetadata;
+      deleted: boolean;
+      name: string;
+      version: string;
+      deletable?: boolean | undefined;
+      updatable?: boolean | undefined;
+      groupId: string | undefined;
+      txIds: string[];
+      returns?: ABIReturn[] | undefined;
+      confirmations: PendingTransactionResponse[];
+      transactions: Transaction[];
+      confirmation: PendingTransactionResponse;
+      transaction: Transaction;
+      appId: bigint;
+      appAddress: Address;
+      deleteResult: ConfirmedTransactionResult;
+    } | {
+      return: ABIValue | undefined;
+      deleteReturn: ABIValue | undefined;
+      compiledApproval?: CompiledTeal | undefined;
+      compiledClear?: CompiledTeal | undefined;
+      operationPerformed: "nothing";
+      appId: bigint;
+      appAddress: Address;
+      createdRound: bigint;
+      updatedRound: bigint;
+      createdMetadata: 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` instance
+   * @example
+   * ```typescript
+   * const appClient = factory.getAppClientById({ appId: 12345n })
+   * ```
+   */
+  getAppClientById(params: AppFactoryAppClientParams): 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` instance
+   * @example
+   * ```typescript
+   * const appClient = factory.getAppClientByCreatorAndName({ creatorAddress: 'CREATOR_ADDRESS', appName: 'my_app' })
+   * ```
+   */
+  getAppClientByCreatorAndName(params: AppFactoryResolveAppClientByCreatorAndNameParams): 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.
+   * @param compilation Optional compilation parameters to use for the compilation
+   * @returns The compilation result
+   * @example
+   * ```typescript
+   * const result = await factory.compile()
+   * ```
+   */
+  compile(compilation?: AppClientCompilationParams): Promise<AppClientCompilationResult>;
+  private getBareParams;
+  private getABIParams;
+  private getCreateABIArgsWithDefaultValues;
+  /** Returns the sender for a call, using the `defaultSender`
+   * if none provided and throws an error if neither provided */
+  private getSender;
+  /** Returns the signer for a call, using the provided signer or the `defaultSigner`
+   * if no signer was provided and the sender resolves to the default sender, the call will use default signer
+   * or `undefined` otherwise (so the signer is resolved from `AlgorandClient`) */
+  private getSigner;
+}
+//#endregion
+export { AppFactory, AppFactoryAppClientParams, AppFactoryCreateMethodCallParams, AppFactoryCreateParams, AppFactoryDeployParams, AppFactoryParams, AppFactoryResolveAppClientByCreatorAndNameParams, CreateOnComplete, CreateSchema };
+//# sourceMappingURL=app-factory.d.ts.map