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

package/types/app-client.mjs

@@ -50,6 +50,7 @@ class AppClient {
         this._appName = params.appName ?? this._appSpec.name;
         this._algorand = params.algorand;
         this._defaultSender = params.defaultSender;
+        this._defaultSigner = params.defaultSigner;
         this._approvalSourceMap = params.approvalSourceMap;
         this._clearSourceMap = params.clearSourceMap;
         this._localStateMethods = (address) => this.getStateMethods(() => this.getLocalState(address), () => this._appSpec.state.keys.local, () => this._appSpec.state.maps.local);
@@ -145,6 +146,10 @@ class AppClient {
     get appSpec() {
         return this._appSpec;
     }
+    /** A reference to the underlying `AlgorandClient` this app client is using. */
+    get algorand() {
+        return this._algorand;
+    }
     /** Get parameters to create transactions for the current app.
      *
      * A good mental model for this is that these parameters represent a deferred transaction creation.
@@ -338,11 +343,11 @@ class AppClient {
      */
     async compile(compilation) {
         const result = await AppClient.compile(this._appSpec, this._algorand.app, compilation);
-        if (result.approvalProgramCompilationResult) {
-            this._approvalSourceMap = result.approvalProgramCompilationResult.sourceMap;
+        if (result.compiledApproval) {
+            this._approvalSourceMap = result.compiledApproval.sourceMap;
         }
-        if (result.clearStateProgramCompilationResult) {
-            this._clearSourceMap = result.clearStateProgramCompilationResult.sourceMap;
+        if (result.compiledClear) {
+            this._clearSourceMap = result.compiledClear.sourceMap;
         }
         return result;
     }
@@ -398,25 +403,25 @@ class AppClient {
             };
         }
         const approvalTemplate = Buffer.from(appSpec.source.approval, 'base64').toString('utf-8');
-        const approvalProgramCompilationResult = await appManager.compileTealTemplate(approvalTemplate, deployTimeParams, {
+        const compiledApproval = await appManager.compileTealTemplate(approvalTemplate, deployTimeParams, {
             updatable,
             deletable,
         });
         const clearTemplate = Buffer.from(appSpec.source.clear, 'base64').toString('utf-8');
-        const clearStateProgramCompilationResult = await appManager.compileTealTemplate(clearTemplate, deployTimeParams);
+        const compiledClear = await appManager.compileTealTemplate(clearTemplate, deployTimeParams);
         if (Config.debug) {
             await Config.events.emitAsync(EventType.AppCompiled, {
                 sources: [
-                    { compiledTeal: approvalProgramCompilationResult, appName: appSpec.name, fileName: 'approval' },
-                    { compiledTeal: clearStateProgramCompilationResult, appName: appSpec.name, fileName: 'clear' },
+                    { compiledTeal: compiledApproval, appName: appSpec.name, fileName: 'approval' },
+                    { compiledTeal: compiledClear, appName: appSpec.name, fileName: 'clear' },
                 ],
             });
         }
         return {
-            approvalProgram: approvalProgramCompilationResult.compiledBase64ToBytes,
-            approvalProgramCompilationResult,
-            clearStateProgram: clearStateProgramCompilationResult.compiledBase64ToBytes,
-            clearStateProgramCompilationResult,
+            approvalProgram: compiledApproval.compiledBase64ToBytes,
+            compiledApproval,
+            clearStateProgram: compiledClear.compiledBase64ToBytes,
+            compiledClear,
         };
     }
     /**
@@ -541,10 +546,7 @@ class AppClient {
                 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,
-                    },
+                    ...compiled,
                 };
             },
             /** Signs and sends an opt-in call */
@@ -576,6 +578,7 @@ class AppClient {
                 return {
                     ...params,
                     sender: this.getSender(params.sender),
+                    signer: this.getSigner(params.sender, params.signer),
                     receiver: this.appAddress,
                 };
             },
@@ -617,10 +620,7 @@ class AppClient {
                 const compiled = await this.compile(params);
                 return {
                     ...(await this.handleCallErrors(async () => this.processMethodCallReturn(this._algorand.send.appUpdateMethodCall(await this.params.update({ ...params })), getArc56Method(params.method, this._appSpec)))),
-                    ...{
-                        compiledApproval: compiled.approvalProgramCompilationResult,
-                        compiledClear: compiled.clearStateProgramCompilationResult,
-                    },
+                    ...compiled,
                 };
             },
             /**
@@ -653,6 +653,8 @@ class AppClient {
                         .addAppCallMethodCall(await this.params.call(params))
                         .simulate({
                         allowUnnamedResources: params.populateAppCallResources,
+                        // Simulate calls for a readonly method shouldn't invoke signing
+                        skipSignatures: true,
                     });
                     return this.processMethodCallReturn({
                         ...result,
@@ -704,7 +706,7 @@ class AppClient {
             },
         };
     }
-    /** Returns the sender for a call, using the `defaultSender`
+    /** Returns the sender for a call, using the provided sender or using the `defaultSender`
      * if none provided and throws an error if neither provided */
     getSender(sender) {
         if (!sender && !this._defaultSender) {
@@ -712,11 +714,18 @@ class AppClient {
         }
         return sender ?? this._defaultSender;
     }
+    /** Returns the signer for a call, using the provided signer or the `defaultSigner`
+     * if no signer was provided and the call will use default sender
+     * or `undefined` otherwise (so the signer is resolved from `AlgorandClient`) */
+    getSigner(sender, signer) {
+        return signer ?? (!sender ? this._defaultSigner : undefined);
+    }
     getBareParams(params, onComplete) {
         return {
             ...params,
             appId: this._appId,
             sender: this.getSender(params?.sender),
+            signer: this.getSigner(params?.sender, params?.signer),
             onComplete,
         };
     }
@@ -728,6 +737,7 @@ class AppClient {
             ...params,
             appId: this._appId,
             sender: sender,
+            signer: this.getSigner(params.sender, params.signer),
             method,
             onComplete,
             args,