@algorandfoundation/algokit-utils 7.0.0 → 8.0.0-beta.1

package/types/composer.mjs

@@ -1,4 +1,4 @@
-import algosdk from 'algosdk';
+import algosdk, { Address } from 'algosdk';
 import { Config } from '../config.mjs';
 import { encodeLease, sendAtomicTransactionComposer, getABIReturnValue } from '../transaction/transaction.mjs';
 import { APP_PAGE_MAX_SIZE } from './app.mjs';
@@ -8,8 +8,10 @@ import { genesisIdIsLocalNet } from './network-client.mjs';
 
 var AtomicTransactionComposer = algosdk.AtomicTransactionComposer;
 var isTransactionWithSigner = algosdk.isTransactionWithSigner;
-var encodeAddress = algosdk.encodeAddress;
 var modelsv2 = algosdk.modelsv2;
+const address = (address) => {
+    return typeof address === 'string' ? Address.fromString(address) : address;
+};
 const MAX_TRANSACTION_GROUP_SIZE = 16;
 /** TransactionComposer helps you compose and execute transactions as a transaction group. */
 class TransactionComposer {
@@ -25,7 +27,7 @@ class TransactionComposer {
         /** Transactions that have not yet been composed */
         this.txns = [];
         /** The default transaction validity window */
-        this.defaultValidityWindow = 10;
+        this.defaultValidityWindow = 10n;
         /** Whether the validity window was explicitly set on construction */
         this.defaultValidityWindowIsExplicit = false;
         this.algod = params.algod;
@@ -45,7 +47,7 @@ class TransactionComposer {
     addTransaction(transaction, signer) {
         this.txns.push({
             txn: transaction,
-            signer: signer ?? this.getSigner(algosdk.encodeAddress(transaction.from.publicKey)),
+            signer: signer ?? this.getSigner(transaction.sender),
             type: 'txnWithSigner',
         });
         return this;
@@ -240,13 +242,11 @@ class TransactionComposer {
         return this;
     }
     /** Build an ATC and return transactions ready to be incorporated into a broader set of transactions this composer is composing */
-    buildAtc(atc, processTransaction) {
+    buildAtc(atc) {
         const group = atc.buildGroup();
         const txnWithSigners = group.map((ts, idx) => {
             // Remove underlying group ID from the transaction since it will be re-grouped when this TransactionComposer is built
             ts.txn.group = undefined;
-            // Process transaction if a function is provided
-            ts.txn = processTransaction?.(ts.txn, idx) ?? ts.txn;
             // If this was a method call stash the ABIMethod for later
             if (atc['methodCalls'].get(idx)) {
                 this.txnMethodMap.set(ts.txn.txID(), atc['methodCalls'].get(idx));
@@ -255,39 +255,42 @@ class TransactionComposer {
         });
         return txnWithSigners;
     }
-    commonTxnBuildStep(params, txn, suggestedParams) {
+    commonTxnBuildStep(buildTxn, params, txnParams) {
+        // We are going to mutate suggested params, let's create a clone first
+        txnParams.suggestedParams = { ...txnParams.suggestedParams };
         if (params.lease)
-            txn.addLease(encodeLease(params.lease));
+            txnParams.lease = encodeLease(params.lease);
         if (params.rekeyTo)
-            txn.addRekey(params.rekeyTo);
+            txnParams.rekeyTo = address(params.rekeyTo);
         const encoder = new TextEncoder();
         if (params.note)
-            txn.note = typeof params.note === 'string' ? encoder.encode(params.note) : params.note;
+            txnParams.note = (typeof params.note === 'string' ? encoder.encode(params.note) : params.note);
         if (params.firstValidRound) {
-            txn.firstRound = Number(params.firstValidRound);
+            txnParams.suggestedParams.firstValid = params.firstValidRound;
         }
         if (params.lastValidRound) {
-            txn.lastRound = Number(params.lastValidRound);
+            txnParams.suggestedParams.lastValid = params.lastValidRound;
         }
         else {
             // If the validity window isn't set in this transaction or by default and we are pointing at
             //  LocalNet set a bigger window to avoid dead transactions
-            const window = params.validityWindow ??
-                (!this.defaultValidityWindowIsExplicit && genesisIdIsLocalNet(suggestedParams.genesisID) ? 1000 : this.defaultValidityWindow);
-            txn.lastRound = txn.firstRound + window;
+            const window = params.validityWindow
+                ? BigInt(params.validityWindow)
+                : !this.defaultValidityWindowIsExplicit && genesisIdIsLocalNet(txnParams.suggestedParams.genesisID ?? 'unknown')
+                    ? 1000n
+                    : this.defaultValidityWindow;
+            txnParams.suggestedParams.lastValid = BigInt(txnParams.suggestedParams.firstValid) + window;
         }
         if (params.staticFee !== undefined && params.extraFee !== undefined) {
             throw Error('Cannot set both staticFee and extraFee');
         }
         if (params.staticFee !== undefined) {
-            txn.fee = Number(params.staticFee.microAlgo);
+            txnParams.suggestedParams.fee = params.staticFee.microAlgo;
+            txnParams.suggestedParams.flatFee = true;
         }
-        else {
-            txn.fee = txn.estimateSize() * suggestedParams.fee || algosdk.ALGORAND_MIN_TX_FEE;
-            if (params.extraFee)
-                txn.fee += Number(params.extraFee.microAlgo);
-        }
-        txn.flatFee = true;
+        const txn = buildTxn(txnParams);
+        if (params.extraFee)
+            txn.fee += params.extraFee.microAlgo;
         if (params.maxFee !== undefined && txn.fee > params.maxFee.microAlgo) {
             throw Error(`Transaction fee ${txn.fee} µALGO is greater than maxFee ${params.maxFee}`);
         }
@@ -342,7 +345,7 @@ class TransactionComposer {
                         ? 'signer' in params.signer
                             ? params.signer.signer
                             : params.signer
-                        : this.getSigner(encodeAddress(txn.from.publicKey))
+                        : this.getSigner(txn.sender)
                     : TransactionComposer.NULL_SIGNER,
             });
         }
@@ -359,7 +362,7 @@ class TransactionComposer {
                 ? (await this.appManager.compileTeal(params.clearStateProgram)).compiledBase64ToBytes
                 : params.clearStateProgram
             : undefined;
-        methodAtc.addMethodCall({
+        const txnParams = {
             appID: appId,
             sender: params.sender,
             suggestedParams,
@@ -394,43 +397,45 @@ class TransactionComposer {
             note: undefined,
             lease: undefined,
             rekeyTo: undefined,
-        });
+        };
+        // Build the transaction
+        this.commonTxnBuildStep((txnParams) => {
+            methodAtc.addMethodCall(txnParams);
+            return methodAtc.buildGroup()[methodAtc.count() - 1].txn;
+        }, params, txnParams);
         // Process the ATC to get a set of transactions ready for broader grouping
-        //  and with the common build step to set fees and validity rounds
-        return this.buildAtc(methodAtc, (txn, idx) => idx === methodAtc.count() - 1 ? this.commonTxnBuildStep(params, txn, suggestedParams) : txn);
+        return this.buildAtc(methodAtc);
     }
     buildPayment(params, suggestedParams) {
-        const txn = algosdk.makePaymentTxnWithSuggestedParamsFromObject({
-            from: params.sender,
-            to: params.receiver,
+        return this.commonTxnBuildStep(algosdk.makePaymentTxnWithSuggestedParamsFromObject, params, {
+            sender: params.sender,
+            receiver: params.receiver,
             amount: params.amount.microAlgo,
             closeRemainderTo: params.closeRemainderTo,
             suggestedParams,
         });
-        return this.commonTxnBuildStep(params, txn, suggestedParams);
     }
     buildAssetCreate(params, suggestedParams) {
-        const txn = algosdk.makeAssetCreateTxnWithSuggestedParamsFromObject({
-            from: params.sender,
+        return this.commonTxnBuildStep(algosdk.makeAssetCreateTxnWithSuggestedParamsFromObject, params, {
+            sender: params.sender,
             total: params.total,
             decimals: params.decimals ?? 0,
             assetName: params.assetName,
             unitName: params.unitName,
             assetURL: params.url,
             defaultFrozen: params.defaultFrozen ?? false,
-            assetMetadataHash: params.metadataHash,
+            assetMetadataHash: typeof params.metadataHash === 'string' ? Buffer.from(params.metadataHash, 'utf-8') : params.metadataHash,
             manager: params.manager,
             reserve: params.reserve,
             freeze: params.freeze,
             clawback: params.clawback,
             suggestedParams,
         });
-        return this.commonTxnBuildStep(params, txn, suggestedParams);
     }
     buildAssetConfig(params, suggestedParams) {
-        const txn = algosdk.makeAssetConfigTxnWithSuggestedParamsFromObject({
-            from: params.sender,
-            assetIndex: Number(params.assetId),
+        return this.commonTxnBuildStep(algosdk.makeAssetConfigTxnWithSuggestedParamsFromObject, params, {
+            sender: params.sender,
+            assetIndex: params.assetId,
             suggestedParams,
             manager: params.manager,
             reserve: params.reserve,
@@ -438,40 +443,36 @@ class TransactionComposer {
             clawback: params.clawback,
             strictEmptyAddressChecking: false,
         });
-        return this.commonTxnBuildStep(params, txn, suggestedParams);
     }
     buildAssetDestroy(params, suggestedParams) {
-        const txn = algosdk.makeAssetDestroyTxnWithSuggestedParamsFromObject({
-            from: params.sender,
-            assetIndex: Number(params.assetId),
+        return this.commonTxnBuildStep(algosdk.makeAssetDestroyTxnWithSuggestedParamsFromObject, params, {
+            sender: params.sender,
+            assetIndex: params.assetId,
             suggestedParams,
         });
-        return this.commonTxnBuildStep(params, txn, suggestedParams);
     }
     buildAssetFreeze(params, suggestedParams) {
-        const txn = algosdk.makeAssetFreezeTxnWithSuggestedParamsFromObject({
-            from: params.sender,
-            assetIndex: Number(params.assetId),
+        return this.commonTxnBuildStep(algosdk.makeAssetFreezeTxnWithSuggestedParamsFromObject, params, {
+            sender: params.sender,
+            assetIndex: params.assetId,
             freezeTarget: params.account,
-            freezeState: params.frozen,
+            frozen: params.frozen,
             suggestedParams,
         });
-        return this.commonTxnBuildStep(params, txn, suggestedParams);
     }
     buildAssetTransfer(params, suggestedParams) {
-        const txn = algosdk.makeAssetTransferTxnWithSuggestedParamsFromObject({
-            from: params.sender,
-            to: params.receiver,
-            assetIndex: Number(params.assetId),
+        return this.commonTxnBuildStep(algosdk.makeAssetTransferTxnWithSuggestedParamsFromObject, params, {
+            sender: params.sender,
+            receiver: params.receiver,
+            assetIndex: params.assetId,
             amount: params.amount,
             suggestedParams,
             closeRemainderTo: params.closeAssetTo,
-            revocationTarget: params.clawbackTarget,
+            assetSender: params.clawbackTarget,
         });
-        return this.commonTxnBuildStep(params, txn, suggestedParams);
     }
     async buildAppCall(params, suggestedParams) {
-        const appId = Number('appId' in params ? params.appId : 0n);
+        const appId = 'appId' in params ? params.appId : 0n;
         const approvalProgram = 'approvalProgram' in params
             ? typeof params.approvalProgram === 'string'
                 ? (await this.appManager.compileTeal(params.approvalProgram)).compiledBase64ToBytes
@@ -483,7 +484,7 @@ class TransactionComposer {
                 : params.clearStateProgram
             : undefined;
         const sdkParams = {
-            from: params.sender,
+            sender: params.sender,
             suggestedParams,
             appArgs: params.args,
             onComplete: params.onComplete ?? algosdk.OnApplicationComplete.NoOpOC,
@@ -494,12 +495,11 @@ class TransactionComposer {
             approvalProgram,
             clearProgram: clearStateProgram,
         };
-        let txn;
-        if (appId === 0) {
+        if (appId === 0n) {
             if (sdkParams.approvalProgram === undefined || sdkParams.clearProgram === undefined) {
                 throw new Error('approvalProgram and clearStateProgram are required for application creation');
             }
-            txn = algosdk.makeApplicationCreateTxnFromObject({
+            return this.commonTxnBuildStep(algosdk.makeApplicationCreateTxnFromObject, params, {
                 ...sdkParams,
                 extraPages: 'extraProgramPages' in params
                     ? (params.extraProgramPages ?? Math.floor((approvalProgram.length + clearStateProgram.length) / APP_PAGE_MAX_SIZE))
@@ -513,38 +513,28 @@ class TransactionComposer {
             });
         }
         else {
-            txn = algosdk.makeApplicationCallTxnFromObject({ ...sdkParams, appIndex: appId });
+            return this.commonTxnBuildStep(algosdk.makeApplicationCallTxnFromObject, params, { ...sdkParams, appIndex: appId });
         }
-        return this.commonTxnBuildStep(params, txn, suggestedParams);
     }
     buildKeyReg(params, suggestedParams) {
-        let txn;
         if ('voteKey' in params) {
-            // algosdk throws when voteFirst is 0, so we need to set it to 1, then switch back to 0 after creating the transaction
-            const voteFirst = params.voteFirst === 0n ? 1n : params.voteFirst;
-            txn = algosdk.makeKeyRegistrationTxnWithSuggestedParamsFromObject({
-                from: params.sender,
+            return this.commonTxnBuildStep(algosdk.makeKeyRegistrationTxnWithSuggestedParamsFromObject, params, {
+                sender: params.sender,
                 voteKey: params.voteKey,
                 selectionKey: params.selectionKey,
-                voteFirst: Number(voteFirst),
-                voteLast: Number(params.voteLast),
-                voteKeyDilution: Number(params.voteKeyDilution),
+                voteFirst: params.voteFirst,
+                voteLast: params.voteLast,
+                voteKeyDilution: params.voteKeyDilution,
                 suggestedParams,
                 nonParticipation: false,
                 stateProofKey: params.stateProofKey,
             });
-            if (params.voteFirst === 0n) {
-                txn.voteFirst = 0;
-            }
-        }
-        else {
-            txn = algosdk.makeKeyRegistrationTxnWithSuggestedParamsFromObject({
-                from: params.sender,
-                suggestedParams,
-                nonParticipation: params.preventAccountFromEverParticipatingAgain,
-            });
         }
-        return this.commonTxnBuildStep(params, txn, suggestedParams);
+        return this.commonTxnBuildStep(algosdk.makeKeyRegistrationTxnWithSuggestedParamsFromObject, params, {
+            sender: params.sender,
+            suggestedParams,
+            nonParticipation: params.preventAccountFromEverParticipatingAgain,
+        });
     }
     /** Builds all transaction types apart from `txnWithSigner`, `atc` and `methodCall` since those ones can have custom signers that need to be retrieved. */
     async buildTxn(txn, suggestedParams) {
@@ -677,9 +667,9 @@ class TransactionComposer {
         const group = (await this.build()).transactions;
         let waitRounds = params?.maxRoundsToWaitForConfirmation;
         if (waitRounds === undefined) {
-            const lastRound = group.reduce((max, txn) => Math.max(txn.txn.lastRound, max), 0);
-            const { firstRound } = await this.getSuggestedParams();
-            waitRounds = lastRound - firstRound + 1;
+            const lastRound = group.reduce((max, txn) => (txn.txn.lastValid > max ? txn.txn.lastValid : BigInt(max)), 0n);
+            const { firstValid: firstRound } = await this.getSuggestedParams();
+            waitRounds = Number(BigInt(lastRound) - BigInt(firstRound)) + 1;
         }
         return await sendAtomicTransactionComposer({
             atc: this.atc,