@algorandfoundation/algokit-utils 10.0.0-alpha.3 → 10.0.0-alpha.31

package/types/composer.mjs

@@ -1,13 +1,13 @@
 import { EMPTY_SIGNATURE, MAX_TRANSACTION_GROUP_SIZE } from "../packages/common/src/constants.mjs";
-import { OnApplicationComplete } from "../packages/transact/src/transactions/app-call.mjs";
-import { TransactionType } from "../packages/transact/src/transactions/transaction-type.mjs";
-import { Transaction, assignFee, calculateFee, decodeTransaction, encodeTransactionRaw, groupTransactions } from "../packages/transact/src/transactions/transaction.mjs";
-import { decodeSignedTransaction, encodeSignedTransactions } from "../packages/transact/src/transactions/signed-transaction.mjs";
-import { makeEmptyTransactionSigner } from "../packages/transact/src/signer.mjs";
 import { AlgoAmount } from "./amount.mjs";
 import { Config } from "../config.mjs";
 import { asJson } from "../util.mjs";
 import { waitForConfirmation } from "../transaction/transaction.mjs";
+import { OnApplicationComplete } from "../packages/transact/src/transactions/app-call.mjs";
+import { TransactionType } from "../packages/transact/src/transactions/transaction-type.mjs";
+import { Transaction, assignFee, calculateFee, decodeTransaction, encodeTransactionRaw, groupTransactions, validateTransaction } from "../packages/transact/src/transactions/transaction.mjs";
+import { decodeSignedTransactions } from "../packages/transact/src/transactions/signed-transaction.mjs";
+import { makeEmptyTransactionSigner } from "../packages/transact/src/signer.mjs";
 import { AppManager } from "./app-manager.mjs";
 import { buildAppCall, buildAppCreate, buildAppUpdate, populateGroupResources, populateTransactionResources } from "../transactions/app-call.mjs";
 import { buildAssetOptIn, buildAssetOptOut, buildAssetTransfer } from "../transactions/asset-transfer.mjs";
@@ -205,6 +205,7 @@ var TransactionComposer = class TransactionComposer {
 	*/
 	addTransaction(transaction, signer) {
 		if (transaction.group) throw new Error("Cannot add a transaction to the composer because it is already in a group");
+		validateTransaction(transaction);
 		this.push({
 			data: {
 				txn: transaction,
@@ -570,6 +571,7 @@ var TransactionComposer = class TransactionComposer {
 	*  // Max fee doesn't make sense with extraFee AND staticFee
 	*  //  already specified, but here for completeness
 	*  maxFee: (3000).microAlgo(),
+	*  rejectVersion: 1,
 	*  // Signer only needed if you want to provide one,
 	*  //  generally you'd register it with AlgorandClient
 	*  //  against the sender and not need to pass it in
@@ -620,6 +622,7 @@ var TransactionComposer = class TransactionComposer {
 	*  // Max fee doesn't make sense with extraFee AND staticFee
 	*  //  already specified, but here for completeness
 	*  maxFee: (3000).microAlgo(),
+	*  rejectVersion: 1,
 	*})
 	* ```
 	*/
@@ -665,6 +668,7 @@ var TransactionComposer = class TransactionComposer {
 	*  // Max fee doesn't make sense with extraFee AND staticFee
 	*  //  already specified, but here for completeness
 	*  maxFee: (3000).microAlgo(),
+	*  rejectVersion: 1,
 	*})
 	* ```
 	*/
@@ -712,6 +716,7 @@ var TransactionComposer = class TransactionComposer {
 	*  // Max fee doesn't make sense with extraFee AND staticFee
 	*  //  already specified, but here for completeness
 	*  maxFee: (3000).microAlgo(),
+	*  rejectVersion: 1,
 	*})
 	* ```
 	*/
@@ -775,6 +780,7 @@ var TransactionComposer = class TransactionComposer {
 	*  // Max fee doesn't make sense with extraFee AND staticFee
 	*  //  already specified, but here for completeness
 	*  maxFee: (3000).microAlgo(),
+	*  rejectVersion: 1,
 	*})
 	* ```
 	*/
@@ -835,6 +841,7 @@ var TransactionComposer = class TransactionComposer {
 	*  // Max fee doesn't make sense with extraFee AND staticFee
 	*  //  already specified, but here for completeness
 	*  maxFee: (3000).microAlgo(),
+	*  rejectVersion: 1,
 	*})
 	* ```
 	*/
@@ -894,6 +901,7 @@ var TransactionComposer = class TransactionComposer {
 	*  // Max fee doesn't make sense with extraFee AND staticFee
 	*  //  already specified, but here for completeness
 	*  maxFee: (3000).microAlgo(),
+	*  rejectVersion: 1,
 	*})
 	* ```
 	*/
@@ -953,6 +961,7 @@ var TransactionComposer = class TransactionComposer {
 	*  // Max fee doesn't make sense with extraFee AND staticFee
 	*  //  already specified, but here for completeness
 	*  maxFee: (3000).microAlgo(),
+	*  rejectVersion: 1,
 	*})
 	* ```
 	*/
@@ -1076,7 +1085,7 @@ var TransactionComposer = class TransactionComposer {
 		if (!this.transactionsWithSigners) {
 			const suggestedParams = await this.getSuggestedParams();
 			const builtTransactions = await this._buildTransactions(suggestedParams);
-			this.rawBuildTransactions = builtTransactions.transactions;
+			this.rawBuildTransactions = builtTransactions.transactions.map((txn) => new Transaction({ ...txn }));
 			const groupAnalysis = (this.composerConfig.coverAppCallInnerTransactionFees || this.composerConfig.populateAppCallResources) && builtTransactions.transactions.some((txn) => txn.type === TransactionType.AppCall) ? await this.analyzeGroupRequirements(builtTransactions.transactions, suggestedParams, this.composerConfig) : void 0;
 			this.populateTransactionAndGroupResources(builtTransactions.transactions, groupAnalysis);
 			this.transactionsWithSigners = builtTransactions.transactions.map((txn, index) => {
@@ -1101,11 +1110,14 @@ var TransactionComposer = class TransactionComposer {
 		const transactions = new Array();
 		let transactionIndex = 0;
 		for (const ctxn of this.txns) if (ctxn.type === "txn") {
+			validateTransaction(ctxn.data.txn);
 			transactions.push(ctxn.data.txn);
 			if (ctxn.data.signer) signers.set(transactionIndex, ctxn.data.signer);
 			transactionIndex++;
 		} else if (ctxn.type === "asyncTxn") {
-			transactions.push(await ctxn.data.txn);
+			const transaction = await ctxn.data.txn;
+			validateTransaction(transaction);
+			transactions.push(transaction);
 			if (ctxn.data.signer) signers.set(transactionIndex, ctxn.data.signer);
 			transactionIndex++;
 		} else {
@@ -1136,7 +1148,7 @@ var TransactionComposer = class TransactionComposer {
 					transaction = buildAssetOptOut(ctxn.data, suggestedParams, defaultValidityWindow);
 					break;
 				case "appCall":
-					if (!("appId" in ctxn.data)) transaction = await buildAppCreate(ctxn.data, this.appManager, suggestedParams, defaultValidityWindow);
+					if (ctxn.data.appId === void 0 || ctxn.data.appId === 0) transaction = await buildAppCreate(ctxn.data, this.appManager, suggestedParams, defaultValidityWindow);
 					else if ("approvalProgram" in ctxn.data && "clearStateProgram" in ctxn.data) transaction = await buildAppUpdate(ctxn.data, this.appManager, suggestedParams, defaultValidityWindow);
 					else transaction = buildAppCall(ctxn.data, suggestedParams, defaultValidityWindow);
 					break;
@@ -1144,7 +1156,7 @@ var TransactionComposer = class TransactionComposer {
 					transaction = buildKeyReg(ctxn.data, suggestedParams, defaultValidityWindow);
 					break;
 				case "methodCall":
-					if (!("appId" in ctxn.data)) transaction = await buildAppCreateMethodCall(ctxn.data, this.appManager, suggestedParams, defaultValidityWindow);
+					if (ctxn.data.appId === void 0 || ctxn.data.appId === 0) transaction = await buildAppCreateMethodCall(ctxn.data, this.appManager, suggestedParams, defaultValidityWindow);
 					else if ("approvalProgram" in ctxn.data && "clearStateProgram" in ctxn.data) transaction = await buildAppUpdateMethodCall(ctxn.data, this.appManager, suggestedParams, defaultValidityWindow);
 					else transaction = await buildAppCallMethodCall(ctxn.data, suggestedParams, defaultValidityWindow);
 					break;
@@ -1156,6 +1168,7 @@ var TransactionComposer = class TransactionComposer {
 				extraFee: ctxn.data.extraFee?.microAlgos,
 				maxFee: ctxn.data.maxFee?.microAlgos
 			});
+			validateTransaction(transaction);
 			transactions.push(transaction);
 			if (ctxn.data.signer) {
 				const signer = "signer" in ctxn.data.signer ? ctxn.data.signer.signer : ctxn.data.signer;
@@ -1312,13 +1325,13 @@ var TransactionComposer = class TransactionComposer {
 			sortedResources.assets?.sort(compare);
 			sortedResources.apps?.sort(compare);
 			sortedResources.boxes?.sort((a, b) => {
-				return compare(`${a.app}-${a.name}`, `${b.app}-${b.name}`);
+				return compare(`${a.appId}-${a.name}`, `${b.appId}-${b.name}`);
 			});
 			sortedResources.appLocals?.sort((a, b) => {
-				return compare(`${a.app}-${a.account}`, `${b.app}-${b.account}`);
+				return compare(`${a.appId}-${a.address}`, `${b.appId}-${b.address}`);
 			});
 			sortedResources.assetHoldings?.sort((a, b) => {
-				return compare(`${a.asset}-${a.account}`, `${b.asset}-${b.account}`);
+				return compare(`${a.assetId}-${a.address}`, `${b.assetId}-${b.address}`);
 			});
 		}
 		return {
@@ -1353,11 +1366,12 @@ var TransactionComposer = class TransactionComposer {
 	* ```
 	*/
 	async send(params) {
-		if (this.composerConfig.coverAppCallInnerTransactionFees !== (params?.coverAppCallInnerTransactionFees ?? false) || this.composerConfig.populateAppCallResources !== (params?.populateAppCallResources ?? true)) {
-			this.composerConfig = {
-				coverAppCallInnerTransactionFees: params?.coverAppCallInnerTransactionFees ?? false,
-				populateAppCallResources: params?.populateAppCallResources ?? true
-			};
+		const effectiveConfig = {
+			coverAppCallInnerTransactionFees: params?.coverAppCallInnerTransactionFees ?? this.composerConfig.coverAppCallInnerTransactionFees,
+			populateAppCallResources: params?.populateAppCallResources ?? this.composerConfig.populateAppCallResources
+		};
+		if (this.composerConfig.coverAppCallInnerTransactionFees !== effectiveConfig.coverAppCallInnerTransactionFees || this.composerConfig.populateAppCallResources !== effectiveConfig.populateAppCallResources) {
+			this.composerConfig = effectiveConfig;
 			this.reset();
 		}
 		try {
@@ -1382,15 +1396,14 @@ var TransactionComposer = class TransactionComposer {
 				},
 				resultOnFailure: true
 			});
-			const group = this.signedTransactions[0].txn.group;
+			const group = this.transactionsWithSigners[0].txn.group;
 			let waitRounds = params?.maxRoundsToWaitForConfirmation;
 			if (waitRounds === void 0) {
 				const firstRound = (await this.getSuggestedParams()).firstValid;
-				const lastRound = this.signedTransactions.reduce((max, txn) => txn.txn.lastValid > max ? txn.txn.lastValid : max, 0n);
+				const lastRound = this.transactionsWithSigners.reduce((max, txn) => txn.txn.lastValid > max ? txn.txn.lastValid : max, 0n);
 				waitRounds = Number(lastRound - firstRound) + 1;
 			}
-			const encodedTxns = encodeSignedTransactions(this.signedTransactions);
-			await this.algod.sendRawTransaction(encodedTxns);
+			await this.algod.sendRawTransaction(this.signedTransactions);
 			if (transactionsToSend.length > 1 && group) Config.getLogger(params?.suppressLog).verbose(`Group transaction (${Buffer.from(group).toString("base64")}) sent with ${transactionsToSend.length} transactions`);
 			else Config.getLogger(params?.suppressLog).verbose(`Sent transaction ID ${transactionsToSend[0].txId()} ${transactionsToSend[0].type} from ${transactionsToSend[0].sender}`);
 			let confirmations = new Array();
@@ -1418,7 +1431,7 @@ var TransactionComposer = class TransactionComposer {
 					txn,
 					signer: makeEmptyTransactionSigner()
 				}));
-				const signedTransactions = await this.signTransactions(transactionsWithEmptySigners);
+				const signedTransactions = decodeSignedTransactions(await this.signTransactions(transactionsWithEmptySigners));
 				const simulateResponse = await this.algod.simulateTransactions({
 					txnGroups: [{ txns: signedTransactions }],
 					allowEmptySignatures: true,
@@ -1445,7 +1458,7 @@ var TransactionComposer = class TransactionComposer {
 		}
 	}
 	async simulate(options) {
-		const { skipSignatures = false, resultOnFailure = false,...rawOptions } = options ?? {};
+		const { skipSignatures = false, resultOnFailure = false, ...rawOptions } = options ?? {};
 		if (skipSignatures) {
 			rawOptions.allowEmptySignatures = true;
 			rawOptions.fixSigners = true;
@@ -1453,7 +1466,7 @@ var TransactionComposer = class TransactionComposer {
 		let transactionsWithSigner;
 		if (!this.transactionsWithSigners) {
 			const builtTransactions = await this.buildTransactions();
-			transactionsWithSigner = (builtTransactions.transactions.length > 0 ? groupTransactions(builtTransactions.transactions) : builtTransactions.transactions).map((txn, index) => ({
+			transactionsWithSigner = (builtTransactions.transactions.length > 1 ? groupTransactions(builtTransactions.transactions) : builtTransactions.transactions).map((txn, index) => ({
 				txn,
 				signer: skipSignatures ? makeEmptyTransactionSigner() : builtTransactions.signers.get(index) ?? makeEmptyTransactionSigner()
 			}));
@@ -1463,7 +1476,7 @@ var TransactionComposer = class TransactionComposer {
 		}));
 		const transactions = transactionsWithSigner.map((e) => e.txn);
 		const simulateRequest = {
-			txnGroups: [{ txns: await this.signTransactions(transactionsWithSigner) }],
+			txnGroups: [{ txns: decodeSignedTransactions(await this.signTransactions(transactionsWithSigner)) }],
 			...rawOptions,
 			...Config.debug ? {
 				allowEmptySignatures: true,
@@ -1482,10 +1495,10 @@ var TransactionComposer = class TransactionComposer {
 		if (simulateResult?.failureMessage && !resultOnFailure) {
 			const errorMessage = `Transaction failed at transaction(s) ${simulateResult.failedAt?.join(", ") || "unknown"} in the group. ${simulateResult.failureMessage}`;
 			const error = new Error(errorMessage);
-			if (Config.debug) await Config.events.emitAsync(EventType.TxnGroupSimulated, { simulateTransaction: simulateResponse });
+			if (Config.debug) await Config.events.emitAsync(EventType.TxnGroupSimulated, { simulateResponse });
 			throw await this.transformError(error);
 		}
-		if (Config.debug && Config.traceAll) await Config.events.emitAsync(EventType.TxnGroupSimulated, { simulateTransaction: simulateResponse });
+		if (Config.debug && Config.traceAll) await Config.events.emitAsync(EventType.TxnGroupSimulated, { simulateResponse });
 		const abiReturns = this.parseAbiReturnValues(simulateResult.txnResults.map((t) => t.txnResult));
 		return {
 			confirmations: simulateResult.txnResults.map((t) => t.txnResult),
@@ -1525,16 +1538,16 @@ var TransactionComposer = class TransactionComposer {
 		});
 		const signerEntries = Array.from(signerGroups);
 		const signedGroups = await Promise.all(signerEntries.map(([signer, indexes]) => signer(transactions, indexes)));
-		const signedTransactions = new Array(transactionsWithSigners.length);
+		const encodedSignedTransactions = new Array(transactionsWithSigners.length).fill(null);
 		signerEntries.forEach(([, indexes], signerIndex) => {
 			const stxs = signedGroups[signerIndex];
 			indexes.forEach((txIndex, stxIndex) => {
-				signedTransactions[txIndex] = decodeSignedTransaction(stxs[stxIndex]);
+				encodedSignedTransactions[txIndex] = stxs[stxIndex] ?? null;
 			});
 		});
-		const unsignedIndexes = signedTransactions.map((stxn, index) => stxn === void 0 ? index : null).filter((index) => index !== null);
+		const unsignedIndexes = encodedSignedTransactions.map((stxn, index) => stxn == null ? index : null).filter((index) => index !== null);
 		if (unsignedIndexes.length > 0) throw new Error(`Transactions at indexes [${unsignedIndexes.join(", ")}] were not signed`);
-		return signedTransactions;
+		return encodedSignedTransactions;
 	}
 	parseAbiReturnValues(confirmations) {
 		const abiReturns = new Array();
@@ -1542,11 +1555,8 @@ var TransactionComposer = class TransactionComposer {
 			const confirmation = confirmations[i];
 			const txn = this.txns[i];
 			if (txn?.type !== "methodCall") continue;
-			const method = txn.data.method;
-			if (method.returns.type !== "void") {
-				const abiReturn = AppManager.getABIReturn(confirmation, method);
-				if (abiReturn !== void 0) abiReturns.push(abiReturn);
-			}
+			const abiReturn = AppManager.getABIReturn(confirmation, txn.data.method);
+			if (abiReturn !== void 0) abiReturns.push(abiReturn);
 		}
 		return abiReturns;
 	}