@algorandfoundation/algokit-utils 10.0.0-alpha.44 → 10.0.0-alpha.46

package/app-client.d.ts

@@ -26,9 +26,7 @@ import { AppSpec } from "./app-spec.js";
 //#region src/app-client.d.ts
 /** Configuration to resolve app by creator and name `getCreatorAppsByName` */
 type ResolveAppByCreatorAndNameBase = {
-  /** The address of the app creator account to resolve the app by */
-  creatorAddress: ReadableAddress;
-  /** The optional name override to resolve the app by within the creator account (default: uses the name in the ABI contract) */
+  /** The address of the app creator account to resolve the app by */creatorAddress: ReadableAddress; /** The optional name override to resolve the app by within the creator account (default: uses the name in the ABI contract) */
   name?: string;
   /** The mechanism to find an existing app instance metadata for the given creator and name; either:
    *  * An indexer instance to search the creator account apps; or
@@ -38,8 +36,7 @@ type ResolveAppByCreatorAndNameBase = {
 };
 /** Configuration to resolve app by creator and name `getCreatorAppsByName` */
 type ResolveAppByCreatorAndName = ResolveAppByCreatorAndNameBase & {
-  /** How the app ID is resolved, either by `'id'` or `'creatorAndName'`; must be `'creatorAndName'` if you want to use `deploy` */
-  resolveBy: 'creatorAndName';
+  /** How the app ID is resolved, either by `'id'` or `'creatorAndName'`; must be `'creatorAndName'` if you want to use `deploy` */resolveBy: 'creatorAndName';
 };
 /** Configuration to resolve app by ID */
 interface ResolveAppByIdBase {
@@ -54,9 +51,7 @@ interface ResolveAppById extends ResolveAppByIdBase {
 }
 /** The details of an AlgoKit Utils deployed app */
 type AppDetailsBase = {
-  /** Default sender to use for transactions issued by this application client */
-  sender?: SendTransactionFrom;
-  /** Default suggested params object to use */
+  /** Default sender to use for transactions issued by this application client */sender?: SendTransactionFrom; /** Default suggested params object to use */
   params?: SuggestedParams;
   /** Optionally provide any deploy-time parameters to replace in the TEAL code; if specified here will get
    * used in calls to `deploy`, `create` and `update` unless overridden in those calls
@@ -148,13 +143,11 @@ interface AppClientCompilationParams {
 }
 /** On-complete action parameter for creating a contract using ApplicationClient */
 type AppClientCreateOnComplete = {
-  /** Override the on-completion action for the create call; defaults to NoOp */
-  onCompleteAction?: Exclude<OnApplicationComplete, OnApplicationComplete.ClearState>;
+  /** Override the on-completion action for the create call; defaults to NoOp */onCompleteAction?: Exclude<OnApplicationComplete, OnApplicationComplete.ClearState>;
 };
 /** Parameters for creating a contract using ApplicationClient */
 type AppClientCreateParams = AppClientCallParams & AppClientCompilationParams & AppClientCreateOnComplete & {
-  /** Any overrides for the storage schema to request for the created app; by default the schema indicated by the app spec is used. */
-  schema?: Partial<AppStorageSchema>;
+  /** Any overrides for the storage schema to request for the created app; by default the schema indicated by the app spec is used. */schema?: Partial<AppStorageSchema>;
 };
 /** Parameters for updating a contract using ApplicationClient */
 type AppClientUpdateParams = AppClientCallParams & AppClientCompilationParams;
@@ -222,18 +215,15 @@ interface AppClientParams {
 type CloneAppClientParams = Expand<Partial<Omit<AppClientParams, 'algorand' | 'appSpec'>>>;
 /** onComplete parameter for a non-update app call */
 type CallOnComplete = {
-  /** On-complete of the call; defaults to no-op */
-  onComplete?: Exclude<OnApplicationComplete, OnApplicationComplete.UpdateApplication>;
+  /** On-complete of the call; defaults to no-op */onComplete?: Exclude<OnApplicationComplete, OnApplicationComplete.UpdateApplication>;
 };
 /** AppClient common parameters for a bare app call */
 type AppClientBareCallParams = Expand<Omit<CommonAppCallParams, 'appId' | 'sender' | 'onComplete'> & {
-  /** The address of the account sending the transaction, if undefined then the app client's defaultSender is used. */
-  sender?: ReadableAddress;
+  /** The address of the account sending the transaction, if undefined then the app client's defaultSender is used. */sender?: ReadableAddress;
 }>;
 /** AppClient common parameters for an ABI method call */
 type AppClientMethodCallParams = Expand<Omit<CommonAppCallParams, 'appId' | 'sender' | 'method' | 'args'> & {
-  /** The address of the account sending the transaction, if undefined then the app client's defaultSender is used. */
-  sender?: ReadableAddress;
+  /** The address of the account sending the transaction, if undefined then the app client's defaultSender is used. */sender?: ReadableAddress;
   /** The method name or method signature to call if an ABI call is being emitted
    * @example Method name
    * `my_method`
@@ -254,18 +244,15 @@ type AppClientMethodCallParams = Expand<Omit<CommonAppCallParams, 'appId' | 'sen
 }>;
 /** Parameters for funding an app account */
 type FundAppParams = Expand<Omit<PaymentParams, 'receiver' | 'sender'> & SendParams & {
-  /** The optional sender to send the transaction from, will use the application client's default sender by default if specified */
-  sender?: ReadableAddress;
+  /** The optional sender to send the transaction from, will use the application client's default sender by default if specified */sender?: ReadableAddress;
 }>;
 /** Resolve an app client instance by looking up an app created by the given creator with the given name */
 type ResolveAppClientByCreatorAndName = Expand<Omit<AppClientParams, 'appId'> & {
-  /** The address of the creator account for the app */
-  creatorAddress: ReadableAddress;
+  /** The address of the creator account for the app */creatorAddress: ReadableAddress;
   /** An optional cached app lookup that matches a name to on-chain details;
    * either this is needed or indexer is required to be passed in to this `ClientManager` on construction.
    */
-  appLookupCache?: AppLookup$1;
-  /** Whether or not to ignore the `AppDeployer` lookup cache and force an on-chain lookup, default: use any cached value */
+  appLookupCache?: AppLookup$1; /** Whether or not to ignore the `AppDeployer` lookup cache and force an on-chain lookup, default: use any cached value */
   ignoreCache?: boolean;
 }>;
 /** Resolve an app client instance by looking up the current network. */
@@ -414,9 +401,7 @@ declare class AppClient {
      * @returns The parameters which can be used to create an update ABI method call
      */
     update: (params: AppClientMethodCallParams & AppClientCompilationParams) => Promise<{
-      /** The compiled bytecode of the approval program, ready to deploy to algod */
-      approvalProgram: Uint8Array;
-      /** The compiled bytecode of the clear state program, ready to deploy to algod */
+      /** The compiled bytecode of the approval program, ready to deploy to algod */approvalProgram: Uint8Array; /** The compiled bytecode of the clear state program, ready to deploy to algod */
       clearStateProgram: Uint8Array;
       compiledApproval?: CompiledTeal | undefined;
       compiledClear?: CompiledTeal | undefined;
@@ -443,14 +428,12 @@ declare class AppClient {
        * `my_method`
        * @example Method signature
        * `my_method(unit64,string)bytes`
-       */ | undefined;
+       */
+      | undefined;
       method: string;
-      args?: (ABIValue | AppMethodCallTransactionArgument | undefined)[];
-      /** Any deploy-time parameters to replace in the TEAL code */
-      deployTimeParams?: TealTemplateParams;
-      /** Whether or not the contract should have deploy-time immutability control set, undefined = ignore */
-      updatable?: boolean;
-      /** Whether or not the contract should have deploy-time permanence control set, undefined = ignore */
+      args?: (ABIValue | AppMethodCallTransactionArgument | undefined)[]; /** Any deploy-time parameters to replace in the TEAL code */
+      deployTimeParams?: TealTemplateParams; /** Whether or not the contract should have deploy-time immutability control set, undefined = ignore */
+      updatable?: boolean; /** Whether or not the contract should have deploy-time permanence control set, undefined = ignore */
       deletable?: boolean;
     } & {
       appId: bigint;
@@ -458,7 +441,7 @@ declare class AppClient {
       signer: AddressWithTransactionSigner | TransactionSigner | undefined;
       method: ABIMethod;
       onComplete: OnApplicationComplete.UpdateApplication;
-      args: (Transaction | ABIValue | TransactionWithSigner | AppMethodCall<{
+      args: (Transaction | TransactionWithSigner | ABIValue | AppMethodCall<{
         signer?: (TransactionSigner | AddressWithTransactionSigner) | undefined;
         sender: SendingAddress;
         rekeyTo?: ReadableAddress | undefined;
@@ -520,6 +503,7 @@ declare class AppClient {
      */
     optIn: (params: AppClientMethodCallParams) => Promise<{
       signer?: (TransactionSigner | AddressWithTransactionSigner) | undefined;
+      appId: bigint;
       sender: SendingAddress;
       rekeyTo?: ReadableAddress | undefined;
       note?: (Uint8Array | string) | undefined;
@@ -530,7 +514,6 @@ declare class AppClient {
       validityWindow?: number | bigint | undefined;
       firstValidRound?: bigint | undefined;
       lastValidRound?: bigint | undefined;
-      appId: bigint;
       onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.DeleteApplication | undefined;
       accountReferences?: ReadableAddress[] | undefined;
       appReferences?: bigint[] | undefined;
@@ -548,6 +531,7 @@ declare class AppClient {
      */
     delete: (params: AppClientMethodCallParams) => Promise<{
       signer?: (TransactionSigner | AddressWithTransactionSigner) | undefined;
+      appId: bigint;
       sender: SendingAddress;
       rekeyTo?: ReadableAddress | undefined;
       note?: (Uint8Array | string) | undefined;
@@ -558,7 +542,6 @@ declare class AppClient {
       validityWindow?: number | bigint | undefined;
       firstValidRound?: bigint | undefined;
       lastValidRound?: bigint | undefined;
-      appId: bigint;
       onComplete?: OnApplicationComplete.DeleteApplication | undefined;
       accountReferences?: ReadableAddress[] | undefined;
       appReferences?: bigint[] | undefined;
@@ -575,6 +558,7 @@ declare class AppClient {
      */
     closeOut: (params: AppClientMethodCallParams) => Promise<{
       signer?: (TransactionSigner | AddressWithTransactionSigner) | undefined;
+      appId: bigint;
       sender: SendingAddress;
       rekeyTo?: ReadableAddress | undefined;
       note?: (Uint8Array | string) | undefined;
@@ -585,7 +569,6 @@ declare class AppClient {
       validityWindow?: number | bigint | undefined;
       firstValidRound?: bigint | undefined;
       lastValidRound?: bigint | undefined;
-      appId: bigint;
       onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.DeleteApplication | undefined;
       accountReferences?: ReadableAddress[] | undefined;
       appReferences?: bigint[] | undefined;
@@ -602,6 +585,7 @@ declare class AppClient {
      */
     call: (params: AppClientMethodCallParams & CallOnComplete) => Promise<{
       signer?: (TransactionSigner | AddressWithTransactionSigner) | undefined;
+      appId: bigint;
       sender: SendingAddress;
       rekeyTo?: ReadableAddress | undefined;
       note?: (Uint8Array | string) | undefined;
@@ -612,7 +596,6 @@ declare class AppClient {
       validityWindow?: number | bigint | undefined;
       firstValidRound?: bigint | undefined;
       lastValidRound?: bigint | undefined;
-      appId: bigint;
       onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.DeleteApplication | undefined;
       accountReferences?: ReadableAddress[] | undefined;
       appReferences?: bigint[] | undefined;
@@ -1002,16 +985,11 @@ declare class AppClient {
    * @returns The new error, or if there was no logic error or source map then the wrapped error with source details
    */
   static exposeLogicError(e: Error, appSpec: Arc56Contract, details: {
-    /** Whether or not the code was running the clear state program (defaults to approval program) */isClearStateProgram?: boolean;
-    /** Approval program source map */
-    approvalSourceMap?: ProgramSourceMap;
-    /** Clear state program source map */
-    clearSourceMap?: ProgramSourceMap;
-    /** program bytes */
-    program?: Uint8Array;
-    /** ARC56 approval source info */
-    approvalSourceInfo?: ProgramSourceInfo;
-    /** ARC56 clear source info */
+    /** Whether or not the code was running the clear state program (defaults to approval program) */isClearStateProgram?: boolean; /** Approval program source map */
+    approvalSourceMap?: ProgramSourceMap; /** Clear state program source map */
+    clearSourceMap?: ProgramSourceMap; /** program bytes */
+    program?: Uint8Array; /** ARC56 approval source info */
+    approvalSourceInfo?: ProgramSourceInfo; /** ARC56 clear source info */
     clearSourceInfo?: ProgramSourceInfo;
   }): Error;
   /**

package/app-client.js

@@ -1,17 +1,16 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-const require_runtime = require('./_virtual/_rolldown/runtime.js');
-const require_address = require('./packages/common/src/address.js');
-const require_sourcemap = require('./packages/common/src/sourcemap.js');
-const require_app_call = require('./packages/transact/src/transactions/app-call.js');
-const require_config = require('./config.js');
-const require_util = require('./util.js');
-const require_lifecycle_events = require('./lifecycle-events.js');
-const require_abi_method = require('./packages/abi/src/abi-method.js');
-const require_arc56_contract = require('./packages/abi/src/arc56-contract.js');
-const require_app_spec = require('./app-spec.js');
-const require_logic_error = require('./logic-error.js');
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+require("./_virtual/_rolldown/runtime.js");
+const require_address = require("./packages/common/src/address.js");
+const require_sourcemap = require("./packages/common/src/sourcemap.js");
+const require_app_call = require("./packages/transact/src/transactions/app-call.js");
+const require_config = require("./config.js");
+const require_util = require("./util.js");
+const require_lifecycle_events = require("./lifecycle-events.js");
+const require_abi_method = require("./packages/abi/src/abi-method.js");
+const require_arc56_contract = require("./packages/abi/src/arc56-contract.js");
+const require_app_spec = require("./app-spec.js");
+const require_logic_error = require("./logic-error.js");
 let buffer = require("buffer");
-
 //#region src/app-client.ts
 /** The maximum opcode budget for a simulate call as per https://github.com/algorand/go-algorand/blob/807b29a91c371d225e12b9287c5d56e9b33c4e4c/ledger/simulation/trace.go#L104 */
 const MAX_SIMULATE_OPCODE_BUDGET = 2e4 * 16;
@@ -906,7 +905,7 @@ var AppClient = class AppClient {
 		return stateMethods;
 	}
 };
-
 //#endregion
 exports.AppClient = AppClient;
+
 //# sourceMappingURL=app-client.js.map