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

package/package.json

@@ -6,7 +6,7 @@
     "**"
   ],
   "name": "@algorandfoundation/algokit-utils",
-  "version": "7.0.0-beta.7",
+  "version": "7.0.0-beta.8",
   "private": false,
   "description": "A set of core Algorand utilities written in TypeScript and released via npm that make it easier to build solutions on Algorand.",
   "author": "Algorand Foundation",

package/types/app-client.d.ts

@@ -1,7 +1,7 @@
 import algosdk from 'algosdk';
 import { AlgorandClientInterface } from './algorand-client-interface';
 import { AlgoAmount } from './amount';
-import { ABIAppCallArgs, ABIReturn, AppCallArgs, AppCallTransactionResult, AppCallType, AppCompilationResult, AppMetadata, AppReference, AppReturn, AppState, AppStorageSchema, BoxName, AppLookup as LegacyAppLookup, OnSchemaBreak, OnUpdate, RawAppCallArgs, SendAppTransactionResult, TealTemplateParams } from './app';
+import { ABIAppCallArgs, ABIReturn, AppCallArgs, AppCallTransactionResult, AppCallType, AppCompilationResult, AppMetadata, AppReference, AppReturn, AppState, AppStorageSchema, BoxName, CompiledTeal, AppLookup as LegacyAppLookup, OnSchemaBreak, OnUpdate, RawAppCallArgs, SendAppTransactionResult, TealTemplateParams } from './app';
 import { ABIStruct, Arc56Contract, Arc56Method } from './app-arc56';
 import { AppLookup } from './app-deployer';
 import { AppManager, BoxIdentifier } from './app-manager';
@@ -176,6 +176,19 @@ export interface SourceMapExport {
     names: string[];
     mappings: string;
 }
+/**
+ * The result of asking an `AppClient` to compile a program.
+ */
+export interface AppClientCompilationResult {
+    /** The compiled bytecode of the approval program, ready to deploy to algod */
+    approvalProgram: Uint8Array;
+    /** The compiled bytecode of the clear state program, ready to deploy to algod */
+    clearStateProgram: Uint8Array;
+    /** The result of compilation of the approval program, including source map, if TEAL code was compiled */
+    approvalProgramCompilationResult?: CompiledTeal;
+    /** The result of compilation of the clear state program, including source map, if TEAL code was compiled */
+    clearStateProgramCompilationResult?: CompiledTeal;
+}
 /** Parameters to create an app client */
 export interface AppClientParams {
     /** The ID of the app instance this client should make calls against. */
@@ -371,40 +384,15 @@ export declare class AppClient {
             sender?: string | undefined;
             method: string;
             args?: (algosdk.ABIValue | AppMethodCallTransactionArgument | ABIStruct | undefined)[] | undefined;
-        } & AppClientCompilationParams) => Promise<({
-            approvalProgram: Uint8Array;
-            compiledApproval: undefined;
-            clearStateProgram: Uint8Array;
-            compiledClear: undefined;
-            lease?: string | Uint8Array | undefined;
-            note?: string | Uint8Array | undefined;
-            maxFee?: AlgoAmount | undefined;
-            signer?: algosdk.TransactionSigner | import("./account").TransactionSignerAccount | undefined;
-            rekeyTo?: string | undefined;
-            staticFee?: AlgoAmount | undefined;
-            extraFee?: AlgoAmount | undefined;
-            validityWindow?: number | undefined;
-            firstValidRound?: bigint | undefined;
-            lastValidRound?: bigint | undefined;
-            onComplete?: algosdk.OnApplicationComplete | undefined;
-            accountReferences?: string[] | undefined;
-            appReferences?: bigint[] | undefined;
-            assetReferences?: bigint[] | undefined;
-            boxReferences?: (BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
-            sender?: string | undefined;
-            method: string;
-            args?: (algosdk.ABIValue | AppMethodCallTransactionArgument | ABIStruct | undefined)[] | undefined;
-            /** Any deploy-time parameters to replace in the TEAL code */
-            deployTimeParams?: TealTemplateParams | undefined;
-            /** Whether or not the contract should have deploy-time immutability control set, undefined = ignore */
-            updatable?: boolean | undefined;
-            /** Whether or not the contract should have deploy-time permanence control set, undefined = ignore */
-            deletable?: boolean | undefined;
-        } | {
+        } & AppClientCompilationParams) => Promise<{
+            /** The compiled bytecode of the approval program, ready to deploy to algod */
             approvalProgram: Uint8Array;
-            compiledApproval: import("./app").CompiledTeal;
+            /** The compiled bytecode of the clear state program, ready to deploy to algod */
             clearStateProgram: Uint8Array;
-            compiledClear: import("./app").CompiledTeal;
+            /** The result of compilation of the approval program, including source map, if TEAL code was compiled */
+            approvalProgramCompilationResult?: CompiledTeal | undefined;
+            /** The result of compilation of the clear state program, including source map, if TEAL code was compiled */
+            clearStateProgramCompilationResult?: CompiledTeal | undefined;
             lease?: string | Uint8Array | undefined;
             note?: string | Uint8Array | undefined;
             maxFee?: AlgoAmount | undefined;
@@ -429,7 +417,7 @@ export declare class AppClient {
             updatable?: boolean | undefined;
             /** Whether or not the contract should have deploy-time permanence control set, undefined = ignore */
             deletable?: boolean | undefined;
-        }) & {
+        } & {
             appId: bigint;
             sender: string;
             method: Arc56Method;
@@ -1033,8 +1021,8 @@ export declare class AppClient {
             method: string;
             args?: (algosdk.ABIValue | AppMethodCallTransactionArgument | ABIStruct | undefined)[] | undefined;
         } & AppClientCompilationParams & SendParams) => Promise<{
-            compiledApproval?: import("./app").CompiledTeal | undefined;
-            compiledClear?: import("./app").CompiledTeal | undefined;
+            compiledApproval?: CompiledTeal | undefined;
+            compiledClear?: CompiledTeal | undefined;
             groupId: string;
             txIds: string[];
             returns?: ABIReturn[] | undefined;
@@ -1193,6 +1181,8 @@ export declare class AppClient {
                 boxReferences?: (BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
                 sender?: string | undefined;
             } & AppClientCompilationParams & SendParams) | undefined) => Promise<{
+                compiledApproval?: CompiledTeal | undefined;
+                compiledClear?: CompiledTeal | undefined;
                 groupId: string;
                 txIds: string[];
                 returns?: ABIReturn[] | undefined;
@@ -1201,8 +1191,6 @@ export declare class AppClient {
                 confirmation: algosdk.modelsv2.PendingTransactionResponse;
                 transaction: algosdk.Transaction;
                 return?: ABIReturn | undefined;
-                compiledApproval?: import("./app").CompiledTeal | undefined;
-                compiledClear?: import("./app").CompiledTeal | undefined;
             }>;
             /** Signs and sends an opt-in call */
             optIn: (params?: ({
@@ -1557,17 +1545,7 @@ export declare class AppClient {
      *
      * Will store any generated source maps for later use in debugging.
      */
-    compile(compilation?: AppClientCompilationParams): Promise<{
-        approvalProgram: Uint8Array;
-        compiledApproval: undefined;
-        clearStateProgram: Uint8Array;
-        compiledClear: undefined;
-    } | {
-        approvalProgram: Uint8Array;
-        compiledApproval: import("./app").CompiledTeal;
-        clearStateProgram: Uint8Array;
-        compiledClear: import("./app").CompiledTeal;
-    }>;
+    compile(compilation?: AppClientCompilationParams): Promise<AppClientCompilationResult>;
     /**
      * Takes an error that may include a logic error from a call to the current app and re-exposes the
      * error to include source code information via the source map and ARC-56 spec.
@@ -1592,17 +1570,7 @@ export declare class AppClient {
      * @param appSpec The app spec for the app
      * @param compilation Any compilation parameters to use
      */
-    static compile(appSpec: Arc56Contract, appManager: AppManager, compilation?: AppClientCompilationParams): Promise<{
-        approvalProgram: Uint8Array;
-        compiledApproval: undefined;
-        clearStateProgram: Uint8Array;
-        compiledClear: undefined;
-    } | {
-        approvalProgram: Uint8Array;
-        compiledApproval: import("./app").CompiledTeal;
-        clearStateProgram: Uint8Array;
-        compiledClear: import("./app").CompiledTeal;
-    }>;
+    static compile(appSpec: Arc56Contract, appManager: AppManager, compilation?: AppClientCompilationParams): Promise<AppClientCompilationResult>;
     /**
      * Returns ABI method arguments ready for a method call params object with default values populated
      * and structs replaced with tuples.
@@ -1669,8 +1637,8 @@ export declare class ApplicationClient {
      * @returns The compiled approval and clear state programs
      */
     compile(compilation?: AppClientCompilationParams): Promise<{
-        approvalCompiled: import("./app").CompiledTeal;
-        clearCompiled: import("./app").CompiledTeal;
+        approvalCompiled: CompiledTeal;
+        clearCompiled: CompiledTeal;
     }>;
     /**
      * Export the current source maps for the app.
@@ -1698,8 +1666,8 @@ export declare class ApplicationClient {
     deploy(deploy?: AppClientDeployParams): Promise<(Partial<AppCompilationResult> & AppMetadata & {
         operationPerformed: "nothing";
     }) | {
-        compiledApproval: import("./app").CompiledTeal;
-        compiledClear: import("./app").CompiledTeal;
+        compiledApproval: CompiledTeal;
+        compiledClear: CompiledTeal;
         confirmation: algosdk.modelsv2.PendingTransactionResponse;
         confirmations: algosdk.modelsv2.PendingTransactionResponse[];
         transaction: algosdk.Transaction;
@@ -1707,7 +1675,7 @@ export declare class ApplicationClient {
         createdRound: number;
         updatedRound: number;
         createdMetadata: import("./app").AppDeployMetadata;
-        deleted: boolean;
+        deleted: boolean; /** Any overrides for the storage schema to request for the created app; by default the schema indicated by the app spec is used. */
         appId: number | bigint;
         appAddress: string;
         name: string;
@@ -1717,8 +1685,8 @@ export declare class ApplicationClient {
         return?: ABIReturn | undefined;
         operationPerformed: "update" | "create";
     } | {
-        compiledApproval: import("./app").CompiledTeal;
-        compiledClear: import("./app").CompiledTeal;
+        compiledApproval: CompiledTeal;
+        compiledClear: CompiledTeal;
         confirmation: algosdk.modelsv2.PendingTransactionResponse;
         confirmations: algosdk.modelsv2.PendingTransactionResponse[];
         transaction: algosdk.Transaction;
@@ -1726,14 +1694,14 @@ export declare class ApplicationClient {
         createdRound: number;
         updatedRound: number;
         createdMetadata: import("./app").AppDeployMetadata;
-        deleted: boolean;
+        deleted: boolean; /** Any overrides for the storage schema to request for the created app; by default the schema indicated by the app spec is used. */
         appId: number | bigint;
         appAddress: string;
         name: string;
         version: string;
         deletable?: boolean | undefined;
         updatable?: boolean | undefined;
-        return?: ABIReturn | undefined;
+        return?: ABIReturn | undefined; /** The optional name override to resolve the app by within the creator account (default: uses the name in the ABI contract) */
         deleteReturn?: ABIReturn | undefined;
         deleteResult: import("./transaction").ConfirmedTransactionResult;
         operationPerformed: "replace";
@@ -1746,8 +1714,8 @@ export declare class ApplicationClient {
      * @returns The details of the created app, or the transaction to create it if `skipSending` and the compilation result
      */
     create(create?: AppClientCreateParams): Promise<{
-        compiledApproval: import("./app").CompiledTeal;
-        compiledClear: import("./app").CompiledTeal;
+        compiledApproval: CompiledTeal;
+        compiledClear: CompiledTeal;
         return?: ABIReturn | undefined;
         transactions: algosdk.Transaction[];
         confirmations?: algosdk.modelsv2.PendingTransactionResponse[] | undefined;
@@ -1764,8 +1732,8 @@ export declare class ApplicationClient {
      * @returns The transaction send result and the compilation result
      */
     update(update?: AppClientUpdateParams): Promise<{
-        compiledApproval: import("./app").CompiledTeal;
-        compiledClear: import("./app").CompiledTeal;
+        compiledApproval: CompiledTeal;
+        compiledClear: CompiledTeal;
         return?: ABIReturn | undefined;
         transactions: algosdk.Transaction[];
         confirmations?: algosdk.modelsv2.PendingTransactionResponse[] | undefined;

package/types/app-client.js

@@ -340,11 +340,11 @@ class AppClient {
      */
     async compile(compilation) {
         const result = await AppClient.compile(this._appSpec, this._algorand.app, compilation);
-        if (result.compiledApproval) {
-            this._approvalSourceMap = result.compiledApproval.sourceMap;
+        if (result.approvalProgramCompilationResult) {
+            this._approvalSourceMap = result.approvalProgramCompilationResult.sourceMap;
         }
-        if (result.compiledClear) {
-            this._clearSourceMap = result.compiledClear.sourceMap;
+        if (result.clearStateProgramCompilationResult) {
+            this._clearSourceMap = result.clearStateProgramCompilationResult.sourceMap;
         }
         return result;
     }
@@ -396,31 +396,29 @@ class AppClient {
             }
             return {
                 approvalProgram: buffer.Buffer.from(appSpec.byteCode.approval, 'base64'),
-                compiledApproval: undefined,
                 clearStateProgram: buffer.Buffer.from(appSpec.byteCode.clear, 'base64'),
-                compiledClear: undefined,
             };
         }
         const approvalTemplate = buffer.Buffer.from(appSpec.source.approval, 'base64').toString('utf-8');
-        const compiledApproval = await appManager.compileTealTemplate(approvalTemplate, deployTimeParams, {
+        const approvalProgramCompilationResult = await appManager.compileTealTemplate(approvalTemplate, deployTimeParams, {
             updatable,
             deletable,
         });
         const clearTemplate = buffer.Buffer.from(appSpec.source.clear, 'base64').toString('utf-8');
-        const compiledClear = await appManager.compileTealTemplate(clearTemplate, deployTimeParams);
+        const clearStateProgramCompilationResult = await appManager.compileTealTemplate(clearTemplate, deployTimeParams);
         if (config.Config.debug) {
             await config.Config.events.emitAsync(types_asyncEventEmitter.EventType.AppCompiled, {
                 sources: [
-                    { compiledTeal: compiledApproval, appName: appSpec.name, fileName: 'approval' },
-                    { compiledTeal: compiledClear, appName: appSpec.name, fileName: 'clear' },
+                    { compiledTeal: approvalProgramCompilationResult, appName: appSpec.name, fileName: 'approval' },
+                    { compiledTeal: clearStateProgramCompilationResult, appName: appSpec.name, fileName: 'clear' },
                 ],
             });
         }
         return {
-            approvalProgram: compiledApproval.compiledBase64ToBytes,
-            compiledApproval,
-            clearStateProgram: compiledClear.compiledBase64ToBytes,
-            compiledClear,
+            approvalProgram: approvalProgramCompilationResult.compiledBase64ToBytes,
+            approvalProgramCompilationResult,
+            clearStateProgram: clearStateProgramCompilationResult.compiledBase64ToBytes,
+            clearStateProgramCompilationResult,
         };
     }
     /**
@@ -542,7 +540,14 @@ class AppClient {
         return {
             /** Signs and sends an update call, including deploy-time TEAL template replacements and compilation if provided */
             update: async (params) => {
-                return await this.handleCallErrors(async () => this._algorand.send.appUpdate(await this.params.bare.update(params)));
+                const compiled = await this.compile(params);
+                return {
+                    ...(await this.handleCallErrors(async () => this._algorand.send.appUpdate(await this.params.bare.update(params)))),
+                    ...{
+                        compiledApproval: compiled.approvalProgramCompilationResult,
+                        compiledClear: compiled.clearStateProgramCompilationResult,
+                    },
+                };
             },
             /** Signs and sends an opt-in call */
             optIn: (params) => {
@@ -614,7 +619,10 @@ class AppClient {
                 const compiled = await this.compile(params);
                 return {
                     ...(await this.handleCallErrors(async () => this.processMethodCallReturn(this._algorand.send.appUpdateMethodCall(await this.params.update({ ...params })), types_appArc56.getArc56Method(params.method, this._appSpec)))),
-                    ...compiled,
+                    ...{
+                        compiledApproval: compiled.approvalProgramCompilationResult,
+                        compiledClear: compiled.clearStateProgramCompilationResult,
+                    },
                 };
             },
             /**
@@ -645,7 +653,9 @@ class AppClient {
                     const result = await this._algorand
                         .newGroup()
                         .addAppCallMethodCall(await this.params.call(params))
-                        .simulate();
+                        .simulate({
+                        allowUnnamedResources: params.populateAppCallResources,
+                    });
                     return this.processMethodCallReturn({
                         ...result,
                         transaction: result.transactions.at(-1),