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

package/transaction/transaction.mjs

@@ -1,4 +1,4 @@
-import algosdk from 'algosdk';
+import algosdk, { TransactionType, stringifyJSON, Address } from 'algosdk';
 import { Buffer } from 'buffer';
 import { Config } from '../config.mjs';
 import { EventType } from '../types/lifecycle-events.mjs';
@@ -6,7 +6,6 @@ import { toNumber } from '../util.mjs';
 import { performAtomicTransactionComposerSimulate } from './perform-atomic-transaction-composer-simulate.mjs';
 
 var AtomicTransactionComposer = algosdk.AtomicTransactionComposer;
-var modelsv2 = algosdk.modelsv2;
 const MAX_TRANSACTION_GROUP_SIZE = 16;
 const MAX_APP_CALL_FOREIGN_REFERENCES = 8;
 const MAX_APP_CALL_ACCOUNT_REFERENCES = 4;
@@ -87,7 +86,7 @@ function encodeLease(lease) {
  * @returns The public address
  */
 const getSenderAddress = function (sender) {
-    return typeof sender === 'string' ? sender : 'addr' in sender ? sender.addr : sender.address();
+    return typeof sender === 'string' ? sender : 'addr' in sender ? sender.addr.toString() : sender.address().toString();
 };
 /**
  * @deprecated Use `AlgorandClient` / `TransactionComposer` to construct transactions instead or
@@ -260,7 +259,7 @@ async function populateAppCallResources(atc, algod) {
     const unnamedResourcesAccessed = await getUnnamedAppCallResourcesAccessed(atc, algod);
     const group = atc.buildGroup();
     unnamedResourcesAccessed.txns.forEach((r, i) => {
-        if (r === undefined)
+        if (r === undefined || group[i].txn.type !== TransactionType.appl)
             return;
         if (r.boxes || r.extraBoxRefs)
             throw Error('Unexpected boxes at the transaction level');
@@ -268,22 +267,19 @@ async function populateAppCallResources(atc, algod) {
             throw Error('Unexpected app local at the transaction level');
         if (r.assetHoldings)
             throw Error('Unexpected asset holding at the transaction level');
-        // Do accounts first because the account limit is 4
-        r.accounts?.forEach((a) => {
-            group[i].txn.appAccounts = [...(group[i].txn.appAccounts ?? []), algosdk.decodeAddress(a)];
-        });
-        r.apps?.forEach((a) => {
-            group[i].txn.appForeignApps = [...(group[i].txn.appForeignApps ?? []), Number(a)];
-        });
-        r.assets?.forEach((a) => {
-            group[i].txn.appForeignAssets = [...(group[i].txn.appForeignAssets ?? []), Number(a)];
-        });
-        const accounts = group[i].txn.appAccounts?.length || 0;
+        group[i].txn['applicationCall'] = {
+            ...group[i].txn.applicationCall,
+            accounts: [...(group[i].txn?.applicationCall?.accounts ?? []), ...(r.accounts ?? [])],
+            foreignApps: [...(group[i].txn?.applicationCall?.foreignApps ?? []), ...(r.apps ?? [])],
+            foreignAssets: [...(group[i].txn?.applicationCall?.foreignAssets ?? []), ...(r.assets ?? [])],
+            boxes: [...(group[i].txn?.applicationCall?.boxes ?? []), ...(r.boxes ?? [])],
+        };
+        const accounts = group[i].txn.applicationCall?.accounts?.length ?? 0;
         if (accounts > MAX_APP_CALL_ACCOUNT_REFERENCES)
             throw Error(`Account reference limit of ${MAX_APP_CALL_ACCOUNT_REFERENCES} exceeded in transaction ${i}`);
-        const assets = group[i].txn.appForeignAssets?.length || 0;
-        const apps = group[i].txn.appForeignApps?.length || 0;
-        const boxes = group[i].txn.boxes?.length || 0;
+        const assets = group[i].txn.applicationCall?.foreignAssets?.length ?? 0;
+        const apps = group[i].txn.applicationCall?.foreignApps?.length ?? 0;
+        const boxes = group[i].txn.applicationCall?.boxes?.length ?? 0;
         if (accounts + assets + apps + boxes > MAX_APP_CALL_FOREIGN_REFERENCES) {
             throw Error(`Resource reference limit of ${MAX_APP_CALL_FOREIGN_REFERENCES} exceeded in transaction ${i}`);
         }
@@ -292,10 +288,10 @@ async function populateAppCallResources(atc, algod) {
         const isApplBelowLimit = (t) => {
             if (t.txn.type !== algosdk.TransactionType.appl)
                 return false;
-            const accounts = t.txn.appAccounts?.length || 0;
-            const assets = t.txn.appForeignAssets?.length || 0;
-            const apps = t.txn.appForeignApps?.length || 0;
-            const boxes = t.txn.boxes?.length || 0;
+            const accounts = t.txn.applicationCall?.accounts?.length ?? 0;
+            const assets = t.txn.applicationCall?.foreignAssets?.length ?? 0;
+            const apps = t.txn.applicationCall?.foreignApps?.length ?? 0;
+            const boxes = t.txn.applicationCall?.boxes?.length ?? 0;
             return accounts + assets + apps + boxes < MAX_APP_CALL_FOREIGN_REFERENCES;
         };
         // If this is a asset holding or app local, first try to find a transaction that already has the account available
@@ -306,22 +302,26 @@ async function populateAppCallResources(atc, algod) {
                     return false;
                 return (
                 // account is in the foreign accounts array
-                t.txn.appAccounts?.map((a) => algosdk.encodeAddress(a.publicKey)).includes(account) ||
+                t.txn.applicationCall?.accounts?.map((a) => a.toString()).includes(account.toString()) ||
                     // account is available as an app account
-                    t.txn.appForeignApps?.map((a) => algosdk.getApplicationAddress(a)).includes(account) ||
+                    t.txn.applicationCall?.foreignApps?.map((a) => algosdk.getApplicationAddress(a).toString()).includes(account.toString()) ||
                     // account is available since it's in one of the fields
-                    Object.values(t.txn)
-                        .map((f) => JSON.stringify(f))
-                        .includes(JSON.stringify(algosdk.decodeAddress(account))));
+                    Object.values(t.txn).some((f) => stringifyJSON(f, (_, v) => (v instanceof Address ? v.toString() : v))?.includes(account.toString())));
             });
             if (txnIndex > -1) {
                 if (type === 'assetHolding') {
                     const { asset } = reference;
-                    txns[txnIndex].txn.appForeignAssets = [...(txns[txnIndex].txn.appForeignAssets ?? []), Number(asset)];
+                    txns[txnIndex].txn['applicationCall'] = {
+                        ...txns[txnIndex].txn.applicationCall,
+                        foreignAssets: [...(txns[txnIndex].txn?.applicationCall?.foreignAssets ?? []), ...[asset]],
+                    };
                 }
                 else {
                     const { app } = reference;
-                    txns[txnIndex].txn.appForeignApps = [...(txns[txnIndex].txn.appForeignApps ?? []), Number(app)];
+                    txns[txnIndex].txn['applicationCall'] = {
+                        ...txns[txnIndex].txn.applicationCall,
+                        foreignApps: [...(txns[txnIndex].txn?.applicationCall?.foreignApps ?? []), ...[app]],
+                    };
                 }
                 return;
             }
@@ -330,20 +330,23 @@ async function populateAppCallResources(atc, algod) {
                 if (!isApplBelowLimit(t))
                     return false;
                 // check if there is space in the accounts array
-                if ((t.txn.appAccounts?.length || 0) >= MAX_APP_CALL_ACCOUNT_REFERENCES)
+                if ((t.txn.applicationCall?.accounts?.length ?? 0) >= MAX_APP_CALL_ACCOUNT_REFERENCES)
                     return false;
                 if (type === 'assetHolding') {
                     const { asset } = reference;
-                    return t.txn.appForeignAssets?.includes(Number(asset));
+                    return t.txn.applicationCall?.foreignAssets?.includes(asset);
                 }
                 else {
                     const { app } = reference;
-                    return t.txn.appForeignApps?.includes(Number(app)) || t.txn.appIndex === Number(app);
+                    return t.txn.applicationCall?.foreignApps?.includes(app) || t.txn.applicationCall?.appIndex === app;
                 }
             });
             if (txnIndex > -1) {
                 const { account } = reference;
-                txns[txnIndex].txn.appAccounts = [...(txns[txnIndex].txn.appAccounts ?? []), algosdk.decodeAddress(account)];
+                txns[txnIndex].txn['applicationCall'] = {
+                    ...txns[txnIndex].txn.applicationCall,
+                    accounts: [...(txns[txnIndex].txn?.applicationCall?.accounts ?? []), ...[account]],
+                };
                 return;
             }
         }
@@ -354,10 +357,13 @@ async function populateAppCallResources(atc, algod) {
                 if (!isApplBelowLimit(t))
                     return false;
                 // If the app is in the foreign array OR the app being called, then we know it's available
-                return t.txn.appForeignApps?.includes(Number(app)) || t.txn.appIndex === Number(app);
+                return t.txn.applicationCall?.foreignApps?.includes(app) || t.txn.applicationCall?.appIndex === app;
             });
             if (txnIndex > -1) {
-                txns[txnIndex].txn.boxes = [...(txns[txnIndex].txn.boxes ?? []), { appIndex: Number(app), name }];
+                txns[txnIndex].txn['applicationCall'] = {
+                    ...txns[txnIndex].txn.applicationCall,
+                    boxes: [...(txns[txnIndex].txn?.applicationCall?.boxes ?? []), ...[{ appIndex: app, name }]],
+                };
                 return;
             }
         }
@@ -365,12 +371,12 @@ async function populateAppCallResources(atc, algod) {
         const txnIndex = txns.findIndex((t) => {
             if (t.txn.type !== algosdk.TransactionType.appl)
                 return false;
-            const accounts = t.txn.appAccounts?.length || 0;
+            const accounts = t.txn.applicationCall?.accounts?.length ?? 0;
             if (type === 'account')
                 return accounts < MAX_APP_CALL_ACCOUNT_REFERENCES;
-            const assets = t.txn.appForeignAssets?.length || 0;
-            const apps = t.txn.appForeignApps?.length || 0;
-            const boxes = t.txn.boxes?.length || 0;
+            const assets = t.txn.applicationCall?.foreignAssets?.length ?? 0;
+            const apps = t.txn.applicationCall?.foreignApps?.length ?? 0;
+            const boxes = t.txn.applicationCall?.boxes?.length ?? 0;
             // If we're adding local state or asset holding, we need space for the acocunt and the other reference
             if (type === 'assetHolding' || type === 'appLocal') {
                 return accounts + assets + apps + boxes < MAX_APP_CALL_FOREIGN_REFERENCES - 1 && accounts < MAX_APP_CALL_ACCOUNT_REFERENCES;
@@ -385,30 +391,57 @@ async function populateAppCallResources(atc, algod) {
             throw Error('No more transactions below reference limit. Add another app call to the group.');
         }
         if (type === 'account') {
-            txns[txnIndex].txn.appAccounts = [...(txns[txnIndex].txn.appAccounts ?? []), algosdk.decodeAddress(reference)];
+            txns[txnIndex].txn['applicationCall'] = {
+                ...txns[txnIndex].txn.applicationCall,
+                accounts: [...(txns[txnIndex].txn?.applicationCall?.accounts ?? []), ...[reference]],
+            };
         }
         else if (type === 'app') {
-            txns[txnIndex].txn.appForeignApps = [...(txns[txnIndex].txn.appForeignApps ?? []), Number(reference)];
+            txns[txnIndex].txn['applicationCall'] = {
+                ...txns[txnIndex].txn.applicationCall,
+                foreignApps: [
+                    ...(txns[txnIndex].txn?.applicationCall?.foreignApps ?? []),
+                    ...[typeof reference === 'bigint' ? reference : BigInt(reference)],
+                ],
+            };
         }
         else if (type === 'box') {
             const { app, name } = reference;
-            txns[txnIndex].txn.boxes = [...(txns[txnIndex].txn.boxes ?? []), { appIndex: Number(app), name }];
+            txns[txnIndex].txn['applicationCall'] = {
+                ...txns[txnIndex].txn.applicationCall,
+                boxes: [...(txns[txnIndex].txn?.applicationCall?.boxes ?? []), ...[{ appIndex: app, name }]],
+            };
             if (app.toString() !== '0') {
-                txns[txnIndex].txn.appForeignApps = [...(txns[txnIndex].txn.appForeignApps ?? []), Number(app)];
+                txns[txnIndex].txn['applicationCall'] = {
+                    ...txns[txnIndex].txn.applicationCall,
+                    foreignApps: [...(txns[txnIndex].txn?.applicationCall?.foreignApps ?? []), ...[app]],
+                };
             }
         }
         else if (type === 'assetHolding') {
             const { asset, account } = reference;
-            txns[txnIndex].txn.appForeignAssets = [...(txns[txnIndex].txn.appForeignAssets ?? []), Number(asset)];
-            txns[txnIndex].txn.appAccounts = [...(txns[txnIndex].txn.appAccounts ?? []), algosdk.decodeAddress(account)];
+            txns[txnIndex].txn['applicationCall'] = {
+                ...txns[txnIndex].txn.applicationCall,
+                foreignAssets: [...(txns[txnIndex].txn?.applicationCall?.foreignAssets ?? []), ...[asset]],
+                accounts: [...(txns[txnIndex].txn?.applicationCall?.accounts ?? []), ...[account]],
+            };
         }
         else if (type === 'appLocal') {
             const { app, account } = reference;
-            txns[txnIndex].txn.appAccounts = [...(txns[txnIndex].txn.appAccounts ?? []), algosdk.decodeAddress(account)];
-            txns[txnIndex].txn.appForeignApps = [...(txns[txnIndex].txn.appForeignApps ?? []), Number(app)];
+            txns[txnIndex].txn['applicationCall'] = {
+                ...txns[txnIndex].txn.applicationCall,
+                foreignApps: [...(txns[txnIndex].txn?.applicationCall?.foreignApps ?? []), ...[app]],
+                accounts: [...(txns[txnIndex].txn?.applicationCall?.accounts ?? []), ...[account]],
+            };
         }
         else if (type === 'asset') {
-            txns[txnIndex].txn.appForeignAssets = [...(txns[txnIndex].txn.appForeignAssets ?? []), Number(reference)];
+            txns[txnIndex].txn['applicationCall'] = {
+                ...txns[txnIndex].txn.applicationCall,
+                foreignAssets: [
+                    ...(txns[txnIndex].txn?.applicationCall?.foreignAssets ?? []),
+                    ...[typeof reference === 'bigint' ? reference : BigInt(reference)],
+                ],
+            };
         }
     };
     const g = unnamedResourcesAccessed.group;
@@ -467,20 +500,14 @@ async function populateAppCallResources(atc, algod) {
 const sendAtomicTransactionComposer = async function (atcSend, algod) {
     const { atc: givenAtc, sendParams, ...executeParams } = atcSend;
     let atc;
-    // const hasAppCalls = () =>
-    //   givenAtc
-    //     .buildGroup()
-    //     .map((t) => t.txn.type)
-    //     .includes(algosdk.TransactionType.appl)
     atc = givenAtc;
     try {
+        const transactionsWithSigner = atc.buildGroup();
         // If populateAppCallResources is true OR if populateAppCallResources is undefined and there are app calls, then populate resources
-        // NOTE: Temporary false by default until this algod bug is fixed: https://github.com/algorand/go-algorand/issues/5914
         const populateResources = executeParams?.populateAppCallResources ?? sendParams?.populateAppCallResources ?? Config.populateAppCallResources;
-        if (populateResources) {
+        if (populateResources && transactionsWithSigner.map((t) => t.txn.type).includes(algosdk.TransactionType.appl)) {
             atc = await populateAppCallResources(givenAtc, algod);
         }
-        const transactionsWithSigner = atc.buildGroup();
         const transactionsToSend = transactionsWithSigner.map((t) => {
             return t.txn;
         });
@@ -504,11 +531,11 @@ const sendAtomicTransactionComposer = async function (atcSend, algod) {
             Config.getLogger(executeParams?.suppressLog ?? sendParams?.suppressLog).verbose(`Group transaction (${groupId}) sent with ${transactionsToSend.length} transactions`);
         }
         else {
-            Config.getLogger(executeParams?.suppressLog ?? sendParams?.suppressLog).verbose(`Sent transaction ID ${transactionsToSend[0].txID()} ${transactionsToSend[0].type} from ${algosdk.encodeAddress(transactionsToSend[0].from.publicKey)}`);
+            Config.getLogger(executeParams?.suppressLog ?? sendParams?.suppressLog).verbose(`Sent transaction ID ${transactionsToSend[0].txID()} ${transactionsToSend[0].type} from ${transactionsToSend[0].sender.toString()}`);
         }
         let confirmations = undefined;
         if (!sendParams?.skipWaiting) {
-            confirmations = await Promise.all(transactionsToSend.map(async (t) => modelsv2.PendingTransactionResponse.from_obj_for_encoding(await algod.pendingTransactionInformation(t.txID()).do())));
+            confirmations = await Promise.all(transactionsToSend.map(async (t) => await algod.pendingTransactionInformation(t.txID()).do()));
         }
         return {
             groupId,
@@ -528,6 +555,9 @@ const sendAtomicTransactionComposer = async function (atcSend, algod) {
             // Remove headers as it doesn't have anything useful.
             delete e.response?.headers;
             err.response = e.response;
+            // body property very noisy
+            if (e.response && 'body' in e.response)
+                delete err.response.body;
             err.name = e.name;
         }
         if (Config.debug && typeof e === 'object') {
@@ -543,7 +573,7 @@ const sendAtomicTransactionComposer = async function (atcSend, algod) {
             if (simulate && simulate.txnGroups[0].failedAt) {
                 for (const txn of simulate.txnGroups[0].txnResults) {
                     err.traces.push({
-                        trace: txn.execTrace?.get_obj_for_encoding(),
+                        trace: txn.execTrace?.toEncodingData(),
                         appBudget: txn.appBudgetConsumed,
                         logicSigBudget: txn.logicSigBudgetConsumed,
                         logs: txn.txnResult.logs,
@@ -597,22 +627,6 @@ function getABIReturnValue(result) {
             : result.returnValue,
     };
 }
-/**
- * @deprecated Use `performAtomicTransactionComposerSimulate`, dry-run is a deprecated Algorand feature.
- *
- * Performs a dry run of the transactions loaded into the given AtomicTransactionComposer`
- * @param atc The AtomicTransactionComposer` with transaction(s) loaded
- * @param algod An Algod client
- * @returns The dryrun result
- */
-async function performAtomicTransactionComposerDryrun(atc, algod) {
-    const signedTransactions = await atc.gatherSignatures();
-    const txns = signedTransactions.map((t) => {
-        return algosdk.decodeSignedTransaction(t);
-    });
-    const dryrun = await algosdk.createDryrun({ client: algod, txns });
-    return new algosdk.DryrunResult(await algod.dryrun(dryrun).do());
-}
 /**
  * @deprecated Use `TransactionComposer` (`algorand.newGroup()`) or `AtomicTransactionComposer` to construct and send group transactions instead.
  *
@@ -665,7 +679,7 @@ const waitForConfirmation = async function (transactionId, maxRoundsToWait, algo
         throw new Error(`Invalid timeout, received ${maxRoundsToWait}, expected > 0`);
     }
     // Get current round
-    const status = modelsv2.NodeStatusResponse.from_obj_for_encoding(await algod.status().do());
+    const status = await algod.status().do();
     if (status === undefined) {
         throw new Error('Unable to get node status');
     }
@@ -674,7 +688,7 @@ const waitForConfirmation = async function (transactionId, maxRoundsToWait, algo
     let currentRound = startRound;
     while (currentRound < startRound + BigInt(maxRoundsToWait)) {
         try {
-            const pendingInfo = modelsv2.PendingTransactionResponse.from_obj_for_encoding(await algod.pendingTransactionInformation(transactionId).do());
+            const pendingInfo = await algod.pendingTransactionInformation(transactionId).do();
             if (pendingInfo !== undefined) {
                 const confirmedRound = pendingInfo.confirmedRound;
                 if (confirmedRound && confirmedRound > 0) {
@@ -712,17 +726,19 @@ const waitForConfirmation = async function (transactionId, maxRoundsToWait, algo
  */
 function capTransactionFee(transaction, maxAcceptableFee) {
     // If a flat fee hasn't already been defined
-    if (!transaction.flatFee) {
+    if (!('flatFee' in transaction) || !transaction.flatFee) {
         // Once a transaction has been constructed by algosdk, transaction.fee indicates what the total transaction fee
         // Will be based on the current suggested fee-per-byte value.
         if (transaction.fee > maxAcceptableFee.microAlgo) {
             throw new Error(`Cancelled transaction due to high network congestion fees. Algorand suggested fees would cause this transaction to cost ${transaction.fee} µALGO. Cap for this transaction is ${maxAcceptableFee.microAlgo} µALGO.`);
         }
-        else if (transaction.fee > algosdk.ALGORAND_MIN_TX_FEE) {
+        else if (transaction.fee > 1000000) {
             Config.logger.warn(`Algorand network congestion fees are in effect. This transaction will incur a fee of ${transaction.fee} µALGO.`);
         }
         // Now set the flat on the transaction. Otherwise the network may increase the fee above our cap and perform the transaction.
-        transaction.flatFee = true;
+        if ('flatFee' in transaction) {
+            transaction.flatFee = true;
+        }
     }
 }
 /**
@@ -736,7 +752,9 @@ function controlFees(transaction, feeControl) {
     const { fee, maxFee } = feeControl;
     if (fee) {
         transaction.fee = Number(fee.microAlgo);
-        transaction.flatFee = true;
+        if ('flatFee' in transaction) {
+            transaction.flatFee = true;
+        }
     }
     if (maxFee !== undefined) {
         capTransactionFee(transaction, maxFee);
@@ -752,7 +770,18 @@ function controlFees(transaction, feeControl) {
  * @returns The suggested transaction parameters
  */
 async function getTransactionParams(params, algod) {
-    return params ? { ...params } : await algod.getTransactionParams().do();
+    if (params) {
+        return { ...params };
+    }
+    const p = await algod.getTransactionParams().do();
+    return {
+        fee: p.fee,
+        firstValid: p.firstValid,
+        lastValid: p.lastValid,
+        genesisID: p.genesisID,
+        genesisHash: p.genesisHash,
+        minFee: p.minFee,
+    };
 }
 /**
  * @deprecated Use `atc.clone().buildGroup()` instead.
@@ -770,5 +799,5 @@ function getAtomicTransactionComposerTransactions(atc) {
     }
 }
 
-export { MAX_APP_CALL_ACCOUNT_REFERENCES, MAX_APP_CALL_FOREIGN_REFERENCES, MAX_TRANSACTION_GROUP_SIZE, capTransactionFee, controlFees, encodeLease, encodeTransactionNote, getABIReturnValue, getAtomicTransactionComposerTransactions, getSenderAddress, getSenderTransactionSigner, getTransactionParams, getTransactionWithSigner, performAtomicTransactionComposerDryrun, populateAppCallResources, sendAtomicTransactionComposer, sendGroupOfTransactions, sendTransaction, signTransaction, waitForConfirmation };
+export { MAX_APP_CALL_ACCOUNT_REFERENCES, MAX_APP_CALL_FOREIGN_REFERENCES, MAX_TRANSACTION_GROUP_SIZE, capTransactionFee, controlFees, encodeLease, encodeTransactionNote, getABIReturnValue, getAtomicTransactionComposerTransactions, getSenderAddress, getSenderTransactionSigner, getTransactionParams, getTransactionWithSigner, populateAppCallResources, sendAtomicTransactionComposer, sendGroupOfTransactions, sendTransaction, signTransaction, waitForConfirmation };
 //# sourceMappingURL=transaction.mjs.map