@algorandfoundation/algokit-utils 1.0.0-beta.8 → 1.0.0

package/transaction.js

@@ -0,0 +1,256 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTransactionParams = exports.capTransactionFee = exports.waitForConfirmation = exports.sendGroupOfTransactions = exports.sendTransaction = exports.getSenderAddress = exports.encodeTransactionNote = void 0;
+const algosdk_1 = __importDefault(require("algosdk"));
+const buffer_1 = require("buffer");
+const _1 = require("./");
+/** Encodes a transaction note into a byte array ready to be included in an Algorand transaction.
+ *
+ * @param note The transaction note
+ * @returns the transaction note ready for inclusion in a transaction
+ *
+ *  Case on the value of `data` this either either be:
+ *   * `null` | `undefined`: `undefined`
+ *   * `string`: The string value
+ *   * Uint8Array: passthrough
+ *   * Arc2TransactionNote object: ARC-0002 compatible transaction note
+ *   * Else: The object/value converted into a JSON string representation
+ */
+function encodeTransactionNote(note) {
+    if (note == null || typeof note === 'undefined') {
+        return undefined;
+    }
+    else if (typeof note === 'object' && note.constructor === Uint8Array) {
+        return note;
+    }
+    else if (typeof note === 'object' && 'dAppName' in note) {
+        const arc2Payload = `${note.dAppName}:${note.format}${typeof note.data === 'string' ? note.data : JSON.stringify(note.data)}`;
+        const encoder = new TextEncoder();
+        return encoder.encode(arc2Payload);
+    }
+    else {
+        const n = typeof note === 'string' ? note : JSON.stringify(note);
+        const encoder = new TextEncoder();
+        return encoder.encode(n);
+    }
+}
+exports.encodeTransactionNote = encodeTransactionNote;
+/**
+ * Returns the public address of the given transaction sender.
+ * @param sender A transaction sender
+ * @returns The public address
+ */
+const getSenderAddress = function (sender) {
+    return 'addr' in sender ? sender.addr : sender.address();
+};
+exports.getSenderAddress = getSenderAddress;
+/** Signs and sends the given transaction to the chain
+ *
+ * @param send The details for the transaction to send, including:
+ *   * `transaction`: The unsigned transaction
+ *   * `from`: The account to sign the transaction with: either an account with private key loaded or a logic signature account
+ *   * `config`: The sending configuration for this transaction
+ * @param algod An algod client
+ *
+ * @returns An object with transaction (`transaction`) and (if `skipWaiting` is `false` or unset) confirmation (`confirmation`)
+ */
+const sendTransaction = async function (send, algod) {
+    const { transaction, from, sendParams } = send;
+    const { skipSending, skipWaiting, fee, maxFee, suppressLog, maxRoundsToWaitForConfirmation } = sendParams ?? {};
+    if (fee) {
+        transaction.fee = fee.microAlgos;
+        transaction.flatFee = true;
+    }
+    if (maxFee !== undefined) {
+        capTransactionFee(transaction, maxFee);
+    }
+    if (skipSending) {
+        return { transaction };
+    }
+    const signedTransaction = 'sk' in from
+        ? transaction.signTxn(from.sk)
+        : 'lsig' in from
+            ? algosdk_1.default.signLogicSigTransactionObject(transaction, from).blob
+            : 'signer' in from
+                ? (await from.signer([transaction], [0]))[0]
+                : from.sign(transaction);
+    await algod.sendRawTransaction(signedTransaction).do();
+    _1.Config.getLogger(suppressLog).info(`Sent transaction ID ${transaction.txID()} ${transaction.type} from ${(0, exports.getSenderAddress)(from)}`);
+    let confirmation = undefined;
+    if (!skipWaiting) {
+        confirmation = await (0, exports.waitForConfirmation)(transaction.txID(), maxRoundsToWaitForConfirmation ?? 5, algod);
+    }
+    return { transaction, confirmation };
+};
+exports.sendTransaction = sendTransaction;
+const groupBy = (array, predicate) => array.reduce((acc, value, id, array) => {
+    var _a;
+    ;
+    (acc[_a = predicate(value, id, array)] || (acc[_a] = [])).push(value);
+    return acc;
+}, {});
+/**
+ * Signs and sends a group of [up to 16](https://developer.algorand.org/docs/get-details/atomic_transfers/#create-transactions) transactions to the chain
+ *
+ * @param groupSend The group details to send, with:
+ *   * `transactions`: The array of transactions to send along with their signing account
+ *   * `sendParams`: The parameters to dictate how the group is sent
+ * @param algod An algod client
+ * @returns An object with group transaction ID (`groupTransactionId`) and (if `skipWaiting` is `false` or unset) confirmation (`confirmation`)
+ */
+const sendGroupOfTransactions = async function (groupSend, algod) {
+    const { transactions, signer, sendParams } = groupSend;
+    const transactionsWithSigner = await Promise.all(transactions.map(async (t) => {
+        if ('signer' in t)
+            return t;
+        const txn = 'then' in t ? (await t).transaction : t;
+        if (!signer) {
+            throw new Error(`Attempt to send transaction ${txn.txID()} as part of a group transaction, but no signer was provided.`);
+        }
+        return {
+            transaction: txn,
+            signer: signer,
+        };
+    }));
+    const transactionsToSend = transactionsWithSigner.map((t) => {
+        return t.transaction;
+    });
+    const group = algosdk_1.default.assignGroupID(transactionsToSend);
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    const groupId = buffer_1.Buffer.from(group[0].group).toString('base64');
+    _1.Config.getLogger(sendParams?.suppressLog).info(`Sending group of transactions (${groupId})`, { transactionsToSend });
+    // Sign transactions either using TransactionSigners, or not
+    let signedTransactions;
+    if (transactionsWithSigner.find((t) => 'signer' in t.signer)) {
+        // Validate all or nothing for transaction signers
+        if (transactionsWithSigner.find((t) => !('signer' in t.signer))) {
+            throw new Error("When issuing a group transaction the signers should either all be TransactionSignerAccount's or all not. " +
+                'Received at least one TransactionSignerAccount, but not all of them so failing the send.');
+        }
+        // Group transaction signers by signer
+        const groupedBySigner = groupBy(transactionsWithSigner.map((t, i) => ({
+            signer: t.signer,
+            id: i,
+        })), (t) => t.signer.addr);
+        // Perform the signature, grouped by signer
+        const signed = (await Promise.all(Object.values(groupedBySigner).map(async (signature) => {
+            const indexes = signature.map((s) => s.id);
+            const signed = await signature[0].signer.signer(group, indexes);
+            return signed.map((txn, i) => ({
+                txn,
+                id: indexes[i],
+            }));
+        }))).flatMap((a) => a);
+        // Extract the signed transactions in order
+        signedTransactions = signed.sort((s1, s2) => s1.id - s2.id).map((s) => s.txn);
+    }
+    else {
+        signedTransactions = group.map((groupedTransaction, id) => {
+            const signer = transactionsWithSigner[id].signer;
+            return 'sk' in signer
+                ? groupedTransaction.signTxn(signer.sk)
+                : 'lsig' in signer
+                    ? algosdk_1.default.signLogicSigTransactionObject(groupedTransaction, signer).blob
+                    : 'sign' in signer
+                        ? signer.sign(groupedTransaction)
+                        : // This bit will never happen because above if statement
+                            new Uint8Array();
+        });
+    }
+    _1.Config.getLogger(sendParams?.suppressLog).debug(`Signer IDs (${groupId})`, transactionsWithSigner.map((t) => (0, exports.getSenderAddress)(t.signer)));
+    _1.Config.getLogger(sendParams?.suppressLog).debug(`Transaction IDs (${groupId})`, transactionsToSend.map((t) => t.txID()));
+    // https://developer.algorand.org/docs/rest-apis/algod/v2/#post-v2transactions
+    await algod.sendRawTransaction(signedTransactions).do();
+    _1.Config.getLogger(sendParams?.suppressLog).info(`Group transaction (${groupId}) sent with ${transactionsToSend.length} transactions`);
+    let confirmations = undefined;
+    if (!sendParams?.skipWaiting) {
+        confirmations = await Promise.all(transactionsToSend.map(async (t) => await (0, exports.waitForConfirmation)(t.txID(), sendParams?.maxRoundsToWaitForConfirmation ?? 5, algod)));
+    }
+    return {
+        groupId,
+        confirmations,
+        txIds: transactionsToSend.map((t) => t.txID()),
+    };
+};
+exports.sendGroupOfTransactions = sendGroupOfTransactions;
+/**
+ * Wait until the transaction is confirmed or rejected, or until `timeout`
+ * number of rounds have passed.
+ *
+ * @param algod An algod client
+ * @param transactionId The transaction ID to wait for
+ * @param maxRoundsToWait Maximum number of rounds to wait
+ *
+ * @return Pending transaction information
+ * @throws Throws an error if the transaction is not confirmed or rejected in the next `timeout` rounds
+ */
+const waitForConfirmation = async function (transactionId, maxRoundsToWait, algod) {
+    if (maxRoundsToWait < 0) {
+        throw new Error(`Invalid timeout, received ${maxRoundsToWait}, expected > 0`);
+    }
+    // Get current round
+    const status = await algod.status().do();
+    if (status === undefined) {
+        throw new Error('Unable to get node status');
+    }
+    // Loop for up to `timeout` rounds looking for a confirmed transaction
+    const startRound = status['last-round'] + 1;
+    let currentRound = startRound;
+    while (currentRound < startRound + maxRoundsToWait) {
+        const pendingInfo = (await algod.pendingTransactionInformation(transactionId).do());
+        if (pendingInfo !== undefined) {
+            const confirmedRound = pendingInfo['confirmed-round'];
+            if (confirmedRound && confirmedRound > 0) {
+                return pendingInfo;
+            }
+            else {
+                const poolError = pendingInfo['pool-error'];
+                if (poolError != null && poolError.length > 0) {
+                    // If there was a pool error, then the transaction has been rejected!
+                    throw new Error(`Transaction ${transactionId} was rejected; pool error: ${poolError}`);
+                }
+            }
+        }
+        await algod.statusAfterBlock(currentRound).do();
+        currentRound++;
+    }
+    throw new Error(`Transaction ${transactionId} not confirmed after ${maxRoundsToWait} rounds`);
+};
+exports.waitForConfirmation = waitForConfirmation;
+/**
+ * Limit the acceptable fee to a defined amount of µALGOs.
+ * This also sets the transaction to be flatFee to ensure the transaction only succeeds at
+ * the estimated rate.
+ * @param transaction The transaction to cap
+ * @param maxAcceptableFee The maximum acceptable fee to pay
+ */
+function capTransactionFee(transaction, maxAcceptableFee) {
+    // If a flat fee hasn't already been defined
+    if (!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.microAlgos) {
+            throw new Error(`Cancelled transaction due to high network congestion fees. Algorand suggested fees would cause this transaction to cost ${transaction.fee} µALGOs. Cap for this transaction is ${maxAcceptableFee.microAlgos} µALGOs.`);
+        }
+        else if (transaction.fee > algosdk_1.default.ALGORAND_MIN_TX_FEE) {
+            _1.Config.logger.warn(`Algorand network congestion fees are in effect. This transaction will incur a fee of ${transaction.fee} µALGOs.`);
+        }
+        // Now set the flat on the transaction. Otherwise the network may increase the fee above our cap and perform the transaction.
+        transaction.flatFee = true;
+    }
+}
+exports.capTransactionFee = capTransactionFee;
+/**
+ * Returns suggested transaction parameters from algod unless some are already provided.
+ * @param params Optionally provide parameters to use
+ * @param algod Algod algod
+ * @returns The suggested transaction parameters
+ */
+async function getTransactionParams(params, algod) {
+    return params ?? (await algod.getTransactionParams().do());
+}
+exports.getTransactionParams = getTransactionParams;
+//# sourceMappingURL=transaction.js.map

package/transaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.js","sourceRoot":"","sources":["../src/transaction.ts"],"names":[],"mappings":";;;;;;AAAA,sDAAwE;AACxE,mCAA+B;AAC/B,yBAA2B;AAY3B;;;;;;;;;;;GAWG;AACH,SAAgB,qBAAqB,CAAC,IAAsB;IAC1D,IAAI,IAAI,IAAI,IAAI,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE;QAC/C,OAAO,SAAS,CAAA;KACjB;SAAM,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,WAAW,KAAK,UAAU,EAAE;QACtE,OAAO,IAAI,CAAA;KACZ;SAAM,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,UAAU,IAAI,IAAI,EAAE;QACzD,MAAM,WAAW,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,MAAM,GAAG,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAA;QAC7H,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAA;QACjC,OAAO,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;KACnC;SAAM;QACL,MAAM,CAAC,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;QAChE,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAA;QACjC,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;KACzB;AACH,CAAC;AAdD,sDAcC;AAED;;;;GAIG;AACI,MAAM,gBAAgB,GAAG,UAAU,MAA2B;IACnE,OAAO,MAAM,IAAI,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,CAAA;AAC1D,CAAC,CAAA;AAFY,QAAA,gBAAgB,oBAE5B;AAED;;;;;;;;;GASG;AACI,MAAM,eAAe,GAAG,KAAK,WAClC,IAIC,EACD,KAAc;IAEd,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,IAAI,CAAA;IAC9C,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,8BAA8B,EAAE,GAAG,UAAU,IAAI,EAAE,CAAA;IAE/G,IAAI,GAAG,EAAE;QACP,WAAW,CAAC,GAAG,GAAG,GAAG,CAAC,UAAU,CAAA;QAChC,WAAW,CAAC,OAAO,GAAG,IAAI,CAAA;KAC3B;IAED,IAAI,MAAM,KAAK,SAAS,EAAE;QACxB,iBAAiB,CAAC,WAAW,EAAE,MAAM,CAAC,CAAA;KACvC;IAED,IAAI,WAAW,EAAE;QACf,OAAO,EAAE,WAAW,EAAE,CAAA;KACvB;IAED,MAAM,iBAAiB,GACrB,IAAI,IAAI,IAAI;QACV,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QAC9B,CAAC,CAAC,MAAM,IAAI,IAAI;YAChB,CAAC,CAAC,iBAAO,CAAC,6BAA6B,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC,IAAI;YAC/D,CAAC,CAAC,QAAQ,IAAI,IAAI;gBAClB,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC5C,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;IAC5B,MAAM,KAAK,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,CAAC,EAAE,EAAE,CAAA;IAEtD,SAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,uBAAuB,WAAW,CAAC,IAAI,EAAE,IAAI,WAAW,CAAC,IAAI,SAAS,IAAA,wBAAgB,EAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IAElI,IAAI,YAAY,GAA2C,SAAS,CAAA;IACpE,IAAI,CAAC,WAAW,EAAE;QAChB,YAAY,GAAG,MAAM,IAAA,2BAAmB,EAAC,WAAW,CAAC,IAAI,EAAE,EAAE,8BAA8B,IAAI,CAAC,EAAE,KAAK,CAAC,CAAA;KACzG;IAED,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,CAAA;AACtC,CAAC,CAAA;AA1CY,QAAA,eAAe,mBA0C3B;AAED,MAAM,OAAO,GAAG,CAAI,KAAU,EAAE,SAAuD,EAAE,EAAE,CACzF,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE;;IACrC,CAAC;IAAA,CAAC,GAAG,MAAC,SAAS,CAAC,KAAK,EAAE,EAAE,EAAE,KAAK,CAAC,MAA/B,GAAG,OAAkC,EAAE,EAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACtD,OAAO,GAAG,CAAA;AACZ,CAAC,EAAE,EAA4B,CAAC,CAAA;AAElC;;;;;;;;GAQG;AACI,MAAM,uBAAuB,GAAG,KAAK,WAAW,SAAiC,EAAE,KAAc;IACtG,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,SAAS,CAAA;IAEtD,MAAM,sBAAsB,GAAG,MAAM,OAAO,CAAC,GAAG,CAC9C,YAAY,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;QAC3B,IAAI,QAAQ,IAAI,CAAC;YAAE,OAAO,CAAC,CAAA;QAE3B,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAA;QACnD,IAAI,CAAC,MAAM,EAAE;YACX,MAAM,IAAI,KAAK,CAAC,+BAA+B,GAAG,CAAC,IAAI,EAAE,8DAA8D,CAAC,CAAA;SACzH;QAED,OAAO;YACL,WAAW,EAAE,GAAG;YAChB,MAAM,EAAE,MAAM;SACf,CAAA;IACH,CAAC,CAAC,CACH,CAAA;IACD,MAAM,kBAAkB,GAAG,sBAAsB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QAC1D,OAAO,CAAC,CAAC,WAAW,CAAA;IACtB,CAAC,CAAC,CAAA;IAEF,MAAM,KAAK,GAAG,iBAAO,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAA;IACvD,oEAAoE;IACpE,MAAM,OAAO,GAAG,eAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAM,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;IAE/D,SAAM,CAAC,SAAS,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,IAAI,CAAC,kCAAkC,OAAO,GAAG,EAAE,EAAE,kBAAkB,EAAE,CAAC,CAAA;IAEpH,4DAA4D;IAC5D,IAAI,kBAAgC,CAAA;IACpC,IAAI,sBAAsB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,IAAI,CAAC,CAAC,MAAM,CAAC,EAAE;QAC5D,kDAAkD;QAClD,IAAI,sBAAsB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE;YAC/D,MAAM,IAAI,KAAK,CACb,2GAA2G;gBACzG,0FAA0F,CAC7F,CAAA;SACF;QAED,sCAAsC;QACtC,MAAM,eAAe,GAAG,OAAO,CAC7B,sBAAsB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;YACpC,MAAM,EAAE,CAAC,CAAC,MAAkC;YAC5C,EAAE,EAAE,CAAC;SACN,CAAC,CAAC,EACH,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CACrB,CAAA;QAED,2CAA2C;QAC3C,MAAM,MAAM,GAAG,CACb,MAAM,OAAO,CAAC,GAAG,CACf,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE;YACrD,MAAM,OAAO,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;YAC1C,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;YAC/D,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;gBAC7B,GAAG;gBACH,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC;aACf,CAAC,CAAC,CAAA;QACL,CAAC,CAAC,CACH,CACF,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAA;QAEnB,2CAA2C;QAC3C,kBAAkB,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;KAC9E;SAAM;QACL,kBAAkB,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,kBAAkB,EAAE,EAAE,EAAE,EAAE;YACxD,MAAM,MAAM,GAAG,sBAAsB,CAAC,EAAE,CAAC,CAAC,MAAM,CAAA;YAChD,OAAO,IAAI,IAAI,MAAM;gBACnB,CAAC,CAAC,kBAAkB,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;gBACvC,CAAC,CAAC,MAAM,IAAI,MAAM;oBAClB,CAAC,CAAC,iBAAO,CAAC,6BAA6B,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC,IAAI;oBACxE,CAAC,CAAC,MAAM,IAAI,MAAM;wBAClB,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC;wBACjC,CAAC,CAAC,wDAAwD;4BACxD,IAAI,UAAU,EAAE,CAAA;QACtB,CAAC,CAAC,CAAA;KACH;IAED,SAAM,CAAC,SAAS,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,KAAK,CAC7C,eAAe,OAAO,GAAG,EACzB,sBAAsB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAA,wBAAgB,EAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAC9D,CAAA;IAED,SAAM,CAAC,SAAS,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,KAAK,CAC7C,oBAAoB,OAAO,GAAG,EAC9B,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CACxC,CAAA;IAED,8EAA8E;IAC9E,MAAM,KAAK,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,CAAC,EAAE,EAAE,CAAA;IAEvD,SAAM,CAAC,SAAS,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,IAAI,CAAC,sBAAsB,OAAO,eAAe,kBAAkB,CAAC,MAAM,eAAe,CAAC,CAAA;IAEpI,IAAI,aAAa,GAA6C,SAAS,CAAA;IACvE,IAAI,CAAC,UAAU,EAAE,WAAW,EAAE;QAC5B,aAAa,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,kBAAkB,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,MAAM,IAAA,2BAAmB,EAAC,CAAC,CAAC,IAAI,EAAE,EAAE,UAAU,EAAE,8BAA8B,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC,CACjI,CAAA;KACF;IAED,OAAO;QACL,OAAO;QACP,aAAa;QACb,KAAK,EAAE,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;KAC/C,CAAA;AACH,CAAC,CAAA;AAzGY,QAAA,uBAAuB,2BAyGnC;AAED;;;;;;;;;;GAUG;AACI,MAAM,mBAAmB,GAAG,KAAK,WACtC,aAAqB,EACrB,eAAuB,EACvB,KAAc;IAEd,IAAI,eAAe,GAAG,CAAC,EAAE;QACvB,MAAM,IAAI,KAAK,CAAC,6BAA6B,eAAe,gBAAgB,CAAC,CAAA;KAC9E;IAED,oBAAoB;IACpB,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAA;IACxC,IAAI,MAAM,KAAK,SAAS,EAAE;QACxB,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;KAC7C;IAED,sEAAsE;IACtE,MAAM,UAAU,GAAG,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,CAAA;IAC3C,IAAI,YAAY,GAAG,UAAU,CAAA;IAC7B,OAAO,YAAY,GAAG,UAAU,GAAG,eAAe,EAAE;QAClD,MAAM,WAAW,GAAG,CAAC,MAAM,KAAK,CAAC,6BAA6B,CAAC,aAAa,CAAC,CAAC,EAAE,EAAE,CAA+B,CAAA;QACjH,IAAI,WAAW,KAAK,SAAS,EAAE;YAC7B,MAAM,cAAc,GAAG,WAAW,CAAC,iBAAiB,CAAC,CAAA;YACrD,IAAI,cAAc,IAAI,cAAc,GAAG,CAAC,EAAE;gBACxC,OAAO,WAAW,CAAA;aACnB;iBAAM;gBACL,MAAM,SAAS,GAAG,WAAW,CAAC,YAAY,CAAC,CAAA;gBAC3C,IAAI,SAAS,IAAI,IAAI,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE;oBAC7C,qEAAqE;oBACrE,MAAM,IAAI,KAAK,CAAC,eAAe,aAAa,8BAA8B,SAAS,EAAE,CAAC,CAAA;iBACvF;aACF;SACF;QAED,MAAM,KAAK,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,EAAE,EAAE,CAAA;QAC/C,YAAY,EAAE,CAAA;KACf;IAED,MAAM,IAAI,KAAK,CAAC,eAAe,aAAa,wBAAwB,eAAe,SAAS,CAAC,CAAA;AAC/F,CAAC,CAAA;AAtCY,QAAA,mBAAmB,uBAsC/B;AAED;;;;;;GAMG;AACH,SAAgB,iBAAiB,CAAC,WAAgC,EAAE,gBAA4B;IAC9F,4CAA4C;IAC5C,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE;QACxB,+GAA+G;QAC/G,6DAA6D;QAC7D,IAAI,WAAW,CAAC,GAAG,GAAG,gBAAgB,CAAC,UAAU,EAAE;YACjD,MAAM,IAAI,KAAK,CACb,2HAA2H,WAAW,CAAC,GAAG,wCAAwC,gBAAgB,CAAC,UAAU,UAAU,CACxN,CAAA;SACF;aAAM,IAAI,WAAW,CAAC,GAAG,GAAG,iBAAO,CAAC,mBAAmB,EAAE;YACxD,SAAM,CAAC,MAAM,CAAC,IAAI,CAAC,wFAAwF,WAAW,CAAC,GAAG,UAAU,CAAC,CAAA;SACtI;QAED,6HAA6H;QAC7H,WAAW,CAAC,OAAO,GAAG,IAAI,CAAA;KAC3B;AACH,CAAC;AAhBD,8CAgBC;AAED;;;;;GAKG;AACI,KAAK,UAAU,oBAAoB,CAAC,MAAmC,EAAE,KAAc;IAC5F,OAAO,MAAM,IAAI,CAAC,MAAM,KAAK,CAAC,oBAAoB,EAAE,CAAC,EAAE,EAAE,CAAC,CAAA;AAC5D,CAAC;AAFD,oDAEC"}

package/transfer.d.ts

@@ -0,0 +1,21 @@
+import { Algodv2 } from 'algosdk';
+import { SendTransactionResult } from './types/transaction';
+import { AlgoTransferParams, EnsureFundedParams } from './types/transfer';
+/**
+ * Transfer ALGOs between two accounts.
+ * @param transfer The transfer definition
+ * @param algod An algod client
+ * @returns The transaction object and optionally the confirmation if it was sent to the chain (`skipSending` is `false` or unset)
+ */
+export declare function transferAlgos(transfer: AlgoTransferParams, algod: Algodv2): Promise<SendTransactionResult>;
+/**
+ * Funds a given account using a funding source such that it has a certain amount of algos free to spend (accounting for ALGOs locked in minimum balance requirement).
+ *
+ * @see https://developer.algorand.org/docs/get-details/accounts/#minimum-balance
+ *
+ * @param funding The funding configuration
+ * @param algod An algod client
+ * @returns undefined if nothing was needed or the transaction send result
+ */
+export declare function ensureFunded(funding: EnsureFundedParams, algod: Algodv2): Promise<SendTransactionResult | undefined>;
+//# sourceMappingURL=transfer.d.ts.map

package/transfer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transfer.d.ts","sourceRoot":"","sources":["../src/transfer.ts"],"names":[],"mappings":"AAAA,OAAgB,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AAG1C,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAA;AAC3D,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAA;AAEzE;;;;;GAKG;AACH,wBAAsB,aAAa,CAAC,QAAQ,EAAE,kBAAkB,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAkBhH;AAED;;;;;;;;GAQG;AACH,wBAAsB,YAAY,CAAC,OAAO,EAAE,kBAAkB,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,qBAAqB,GAAG,SAAS,CAAC,CAgC1H"}

package/transfer.js

@@ -0,0 +1,65 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensureFunded = exports.transferAlgos = void 0;
+const algosdk_1 = __importDefault(require("algosdk"));
+const _1 = require("./");
+const transaction_1 = require("./transaction");
+/**
+ * Transfer ALGOs between two accounts.
+ * @param transfer The transfer definition
+ * @param algod An algod client
+ * @returns The transaction object and optionally the confirmation if it was sent to the chain (`skipSending` is `false` or unset)
+ */
+async function transferAlgos(transfer, algod) {
+    const { from, to, amount, note, transactionParams, ...sendParams } = transfer;
+    const transaction = algosdk_1.default.makePaymentTxnWithSuggestedParamsFromObject({
+        from: (0, transaction_1.getSenderAddress)(from),
+        to: to,
+        amount: amount.microAlgos,
+        note: (0, transaction_1.encodeTransactionNote)(note),
+        suggestedParams: await (0, transaction_1.getTransactionParams)(transactionParams, algod),
+        closeRemainderTo: undefined,
+        rekeyTo: undefined,
+    });
+    if (!sendParams.skipSending) {
+        _1.Config.getLogger(sendParams.suppressLog).debug(`Transferring ${amount.microAlgos}µALGOs from ${(0, transaction_1.getSenderAddress)(from)} to ${to}`);
+    }
+    return (0, transaction_1.sendTransaction)({ transaction, from, sendParams }, algod);
+}
+exports.transferAlgos = transferAlgos;
+/**
+ * Funds a given account using a funding source such that it has a certain amount of algos free to spend (accounting for ALGOs locked in minimum balance requirement).
+ *
+ * @see https://developer.algorand.org/docs/get-details/accounts/#minimum-balance
+ *
+ * @param funding The funding configuration
+ * @param algod An algod client
+ * @returns undefined if nothing was needed or the transaction send result
+ */
+async function ensureFunded(funding, algod) {
+    const { accountToFund, fundingSource, minSpendingBalance, minFundingIncrement, transactionParams, note, ...sendParams } = funding;
+    const addressToFund = typeof accountToFund === 'string' ? accountToFund : (0, transaction_1.getSenderAddress)(accountToFund);
+    const accountInfo = await algod.accountInformation(addressToFund).do();
+    const balance = Number(accountInfo.amount);
+    const minimumBalanceRequirement = (0, _1.microAlgos)(Number(accountInfo['min-balance']));
+    const currentSpendingBalance = (0, _1.microAlgos)(balance - +minimumBalanceRequirement);
+    if (minSpendingBalance > currentSpendingBalance) {
+        const minFundAmount = (0, _1.microAlgos)(+minSpendingBalance - +currentSpendingBalance);
+        const fundAmount = (0, _1.microAlgos)(Math.max(+minFundAmount, minFundingIncrement?.microAlgos ?? 0));
+        _1.Config.getLogger(sendParams.suppressLog).info(`Funding ${addressToFund} ${fundAmount} from ${(0, transaction_1.getSenderAddress)(fundingSource)} to reach minimum spend amount of ${minSpendingBalance} (balance = ${balance}, min_balance_req = ${minimumBalanceRequirement})`);
+        return await transferAlgos({
+            from: fundingSource,
+            to: addressToFund,
+            note: note ?? 'Funding account to meet minimum requirement',
+            amount: fundAmount,
+            transactionParams,
+            ...sendParams,
+        }, algod);
+    }
+    return undefined;
+}
+exports.ensureFunded = ensureFunded;
+//# sourceMappingURL=transfer.js.map

package/transfer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transfer.js","sourceRoot":"","sources":["../src/transfer.ts"],"names":[],"mappings":";;;;;;AAAA,sDAA0C;AAC1C,yBAAuC;AACvC,+CAA8G;AAI9G;;;;;GAKG;AACI,KAAK,UAAU,aAAa,CAAC,QAA4B,EAAE,KAAc;IAC9E,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,GAAG,UAAU,EAAE,GAAG,QAAQ,CAAA;IAE7E,MAAM,WAAW,GAAG,iBAAO,CAAC,2CAA2C,CAAC;QACtE,IAAI,EAAE,IAAA,8BAAgB,EAAC,IAAI,CAAC;QAC5B,EAAE,EAAE,EAAE;QACN,MAAM,EAAE,MAAM,CAAC,UAAU;QACzB,IAAI,EAAE,IAAA,mCAAqB,EAAC,IAAI,CAAC;QACjC,eAAe,EAAE,MAAM,IAAA,kCAAoB,EAAC,iBAAiB,EAAE,KAAK,CAAC;QACrE,gBAAgB,EAAE,SAAS;QAC3B,OAAO,EAAE,SAAS;KACnB,CAAC,CAAA;IAEF,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE;QAC3B,SAAM,CAAC,SAAS,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,gBAAgB,MAAM,CAAC,UAAU,eAAe,IAAA,8BAAgB,EAAC,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;KAClI;IAED,OAAO,IAAA,6BAAe,EAAC,EAAE,WAAW,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,KAAK,CAAC,CAAA;AAClE,CAAC;AAlBD,sCAkBC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,YAAY,CAAC,OAA2B,EAAE,KAAc;IAC5E,MAAM,EAAE,aAAa,EAAE,aAAa,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,IAAI,EAAE,GAAG,UAAU,EAAE,GAAG,OAAO,CAAA;IAEjI,MAAM,aAAa,GAAG,OAAO,aAAa,KAAK,QAAQ,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,IAAA,8BAAgB,EAAC,aAAa,CAAC,CAAA;IAEzG,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,kBAAkB,CAAC,aAAa,CAAC,CAAC,EAAE,EAAE,CAAA;IACtE,MAAM,OAAO,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;IAC1C,MAAM,yBAAyB,GAAG,IAAA,aAAU,EAAC,MAAM,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC,CAAA;IAChF,MAAM,sBAAsB,GAAG,IAAA,aAAU,EAAC,OAAO,GAAG,CAAC,yBAAyB,CAAC,CAAA;IAE/E,IAAI,kBAAkB,GAAG,sBAAsB,EAAE;QAC/C,MAAM,aAAa,GAAG,IAAA,aAAU,EAAC,CAAC,kBAAkB,GAAG,CAAC,sBAAsB,CAAC,CAAA;QAC/E,MAAM,UAAU,GAAG,IAAA,aAAU,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC,aAAa,EAAE,mBAAmB,EAAE,UAAU,IAAI,CAAC,CAAC,CAAC,CAAA;QAC7F,SAAM,CAAC,SAAS,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,IAAI,CAC3C,WAAW,aAAa,IAAI,UAAU,SAAS,IAAA,8BAAgB,EAC7D,aAAa,CACd,qCAAqC,kBAAkB,eAAe,OAAO,uBAAuB,yBAAyB,GAAG,CAClI,CAAA;QACD,OAAO,MAAM,aAAa,CACxB;YACE,IAAI,EAAE,aAAa;YACnB,EAAE,EAAE,aAAa;YACjB,IAAI,EAAE,IAAI,IAAI,6CAA6C;YAC3D,MAAM,EAAE,UAAU;YAClB,iBAAiB;YACjB,GAAG,UAAU;SACd,EACD,KAAK,CACN,CAAA;KACF;IAED,OAAO,SAAS,CAAA;AAClB,CAAC;AAhCD,oCAgCC"}

package/types/account.d.ts

@@ -0,0 +1,52 @@
+import algosdk, { Account, MultisigMetadata, Transaction, TransactionSigner } from 'algosdk';
+/**
+ * The account name identifier used for fund dispensing in test environments
+ */
+export declare const DISPENSER_ACCOUNT = "DISPENSER";
+/** Account wrapper that supports partial or full multisig signing. */
+export declare class MultisigAccount {
+    _params: algosdk.MultisigMetadata;
+    _signingAccounts: (algosdk.Account | SigningAccount)[];
+    _addr: string;
+    /** The parameters for the multisig account */
+    get params(): Readonly<algosdk.MultisigMetadata>;
+    /** The list of accounts that are present to sign */
+    get signingAccounts(): Readonly<(algosdk.Account | SigningAccount)[]>;
+    /** The address of the multisig account */
+    get addr(): Readonly<string>;
+    constructor(multisigParams: MultisigMetadata, signingAccounts: (Account | SigningAccount)[]);
+    /**
+     * Sign the given transaction
+     * @param transaction Either a transaction object or a raw, partially signed transaction
+     * @returns The transaction signed by the present signers
+     */
+    sign(transaction: Transaction | Uint8Array): Uint8Array;
+}
+/** Account wrapper that supports a rekeyed account */
+export declare class SigningAccount implements Account {
+    private _account;
+    private _sender;
+    /**
+     * Algorand address of the sender
+     */
+    get addr(): Readonly<string>;
+    /**
+     * Secret key belonging to the signer
+     */
+    get sk(): Readonly<Uint8Array>;
+    /**
+     * Algorand account of the underlying signing account
+     */
+    get signer(): Account;
+    /**
+     * Algorand account of the sender address and signer private key
+     */
+    get sender(): Account;
+    constructor(account: Account, sender: string | undefined);
+}
+/** A wrapper around @see {TransactionSigner} that also has the sender address. */
+export interface TransactionSignerAccount {
+    addr: Readonly<string>;
+    signer: TransactionSigner;
+}
+//# sourceMappingURL=account.d.ts.map

package/types/account.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"account.d.ts","sourceRoot":"","sources":["../../src/types/account.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,EAAE,EAAE,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAE5F;;GAEG;AACH,eAAO,MAAM,iBAAiB,cAAc,CAAA;AAE5C,sEAAsE;AACtE,qBAAa,eAAe;IAC1B,OAAO,EAAE,OAAO,CAAC,gBAAgB,CAAA;IACjC,gBAAgB,EAAE,CAAC,OAAO,CAAC,OAAO,GAAG,cAAc,CAAC,EAAE,CAAA;IACtD,KAAK,EAAE,MAAM,CAAA;IAEb,8CAA8C;IAC9C,IAAI,MAAM,IAAI,QAAQ,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAE/C;IAED,oDAAoD;IACpD,IAAI,eAAe,IAAI,QAAQ,CAAC,CAAC,OAAO,CAAC,OAAO,GAAG,cAAc,CAAC,EAAE,CAAC,CAEpE;IAED,0CAA0C;IAC1C,IAAI,IAAI,IAAI,QAAQ,CAAC,MAAM,CAAC,CAE3B;gBAEW,cAAc,EAAE,gBAAgB,EAAE,eAAe,EAAE,CAAC,OAAO,GAAG,cAAc,CAAC,EAAE;IAM3F;;;;OAIG;IACI,IAAI,CAAC,WAAW,EAAE,WAAW,GAAG,UAAU,GAAG,UAAU;CAY/D;AAED,sDAAsD;AACtD,qBAAa,cAAe,YAAW,OAAO;IAC5C,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,OAAO,CAAQ;IAEvB;;OAEG;IACH,IAAI,IAAI,IAAI,QAAQ,CAAC,MAAM,CAAC,CAE3B;IAED;;OAEG;IACH,IAAI,EAAE,IAAI,QAAQ,CAAC,UAAU,CAAC,CAE7B;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,OAAO,CAKpB;gBAEW,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,GAAG,SAAS;CAIzD;AAED,kFAAkF;AAClF,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;IACtB,MAAM,EAAE,iBAAiB,CAAA;CAC1B"}

package/types/account.js

@@ -0,0 +1,86 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SigningAccount = exports.MultisigAccount = exports.DISPENSER_ACCOUNT = void 0;
+const algosdk_1 = __importDefault(require("algosdk"));
+/**
+ * The account name identifier used for fund dispensing in test environments
+ */
+exports.DISPENSER_ACCOUNT = 'DISPENSER';
+/** Account wrapper that supports partial or full multisig signing. */
+class MultisigAccount {
+    /** The parameters for the multisig account */
+    get params() {
+        return this._params;
+    }
+    /** The list of accounts that are present to sign */
+    get signingAccounts() {
+        return this._signingAccounts;
+    }
+    /** The address of the multisig account */
+    get addr() {
+        return this._addr;
+    }
+    constructor(multisigParams, signingAccounts) {
+        this._params = multisigParams;
+        this._signingAccounts = signingAccounts;
+        this._addr = algosdk_1.default.multisigAddress(multisigParams);
+    }
+    /**
+     * Sign the given transaction
+     * @param transaction Either a transaction object or a raw, partially signed transaction
+     * @returns The transaction signed by the present signers
+     */
+    sign(transaction) {
+        let signedTxn = 'from' in transaction ? undefined : transaction;
+        for (const signer of this._signingAccounts) {
+            if (signedTxn) {
+                signedTxn = algosdk_1.default.appendSignMultisigTransaction(signedTxn, this._params, signer.sk).blob;
+            }
+            else {
+                signedTxn = algosdk_1.default.signMultisigTransaction(transaction, this._params, signer.sk).blob;
+            }
+        }
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        return signedTxn;
+    }
+}
+exports.MultisigAccount = MultisigAccount;
+/** Account wrapper that supports a rekeyed account */
+class SigningAccount {
+    /**
+     * Algorand address of the sender
+     */
+    get addr() {
+        return this._sender;
+    }
+    /**
+     * Secret key belonging to the signer
+     */
+    get sk() {
+        return this._account.sk;
+    }
+    /**
+     * Algorand account of the underlying signing account
+     */
+    get signer() {
+        return this._account;
+    }
+    /**
+     * Algorand account of the sender address and signer private key
+     */
+    get sender() {
+        return {
+            addr: this._sender,
+            sk: this._account.sk,
+        };
+    }
+    constructor(account, sender) {
+        this._account = account;
+        this._sender = sender ?? account.addr;
+    }
+}
+exports.SigningAccount = SigningAccount;
+//# sourceMappingURL=account.js.map

package/types/account.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"account.js","sourceRoot":"","sources":["../../src/types/account.ts"],"names":[],"mappings":";;;;;;AAAA,sDAA4F;AAE5F;;GAEG;AACU,QAAA,iBAAiB,GAAG,WAAW,CAAA;AAE5C,sEAAsE;AACtE,MAAa,eAAe;IAK1B,8CAA8C;IAC9C,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;IAED,oDAAoD;IACpD,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,gBAAgB,CAAA;IAC9B,CAAC;IAED,0CAA0C;IAC1C,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAA;IACnB,CAAC;IAED,YAAY,cAAgC,EAAE,eAA6C;QACzF,IAAI,CAAC,OAAO,GAAG,cAAc,CAAA;QAC7B,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAA;QACvC,IAAI,CAAC,KAAK,GAAG,iBAAO,CAAC,eAAe,CAAC,cAAc,CAAC,CAAA;IACtD,CAAC;IAED;;;;OAIG;IACI,IAAI,CAAC,WAAqC;QAC/C,IAAI,SAAS,GAAG,MAAM,IAAI,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAA;QAC/D,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,gBAAgB,EAAE;YAC1C,IAAI,SAAS,EAAE;gBACb,SAAS,GAAG,iBAAO,CAAC,6BAA6B,CAAC,SAAS,EAAE,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,CAAA;aAC3F;iBAAM;gBACL,SAAS,GAAG,iBAAO,CAAC,uBAAuB,CAAC,WAA0B,EAAE,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,CAAA;aACtG;SACF;QACD,oEAAoE;QACpE,OAAO,SAAU,CAAA;IACnB,CAAC;CACF;AA3CD,0CA2CC;AAED,sDAAsD;AACtD,MAAa,cAAc;IAIzB;;OAEG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;IAED;;OAEG;IACH,IAAI,EAAE;QACJ,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAA;IACzB,CAAC;IAED;;OAEG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,QAAQ,CAAA;IACtB,CAAC;IAED;;OAEG;IACH,IAAI,MAAM;QACR,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,OAAO;YAClB,EAAE,EAAE,IAAI,CAAC,QAAQ,CAAC,EAAE;SACrB,CAAA;IACH,CAAC;IAED,YAAY,OAAgB,EAAE,MAA0B;QACtD,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAA;QACvB,IAAI,CAAC,OAAO,GAAG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAA;IACvC,CAAC;CACF;AAvCD,wCAuCC"}

package/types/algo-http-client-with-retry.d.ts

@@ -0,0 +1,14 @@
+import { BaseHTTPClientResponse, Query } from 'algosdk/dist/types/client/baseHTTPClient';
+import { URLTokenBaseHTTPClient } from './urlTokenBaseHTTPClient';
+/** A HTTP Client that wraps the Algorand SDK HTTP Client with retries */
+export declare class AlgoHttpClientWithRetry extends URLTokenBaseHTTPClient {
+    private static readonly MAX_TRIES;
+    private static readonly MAX_BACKOFF_MS;
+    private static readonly RETRY_STATUS_CODES;
+    private static readonly RETRY_ERROR_CODES;
+    private callWithRetry;
+    get(relativePath: string, query?: Query<string>, requestHeaders?: Record<string, string>): Promise<BaseHTTPClientResponse>;
+    post(relativePath: string, data: Uint8Array, query?: Query<string>, requestHeaders?: Record<string, string>): Promise<BaseHTTPClientResponse>;
+    delete(relativePath: string, data: Uint8Array, query?: Query<string>, requestHeaders?: Record<string, string>): Promise<BaseHTTPClientResponse>;
+}
+//# sourceMappingURL=algo-http-client-with-retry.d.ts.map

package/types/algo-http-client-with-retry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"algo-http-client-with-retry.d.ts","sourceRoot":"","sources":["../../src/types/algo-http-client-with-retry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,KAAK,EAAE,MAAM,0CAA0C,CAAA;AAExF,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAA;AAEjE,yEAAyE;AACzE,qBAAa,uBAAwB,SAAQ,sBAAsB;IACjE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAI;IACrC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAQ;IAI9C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,kBAAkB,CAAsC;IAChF,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAUxC;YAEa,aAAa;IA6BrB,GAAG,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,cAAc,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAI9H,IAAI,CACR,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,UAAU,EAChB,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,EACrB,cAAc,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,GAC1C,OAAO,CAAC,sBAAsB,CAAC;IAI5B,MAAM,CACV,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,UAAU,EAChB,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,EACrB,cAAc,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,GAC1C,OAAO,CAAC,sBAAsB,CAAC;CAGnC"}

package/types/algo-http-client-with-retry.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AlgoHttpClientWithRetry = void 0;
+const __1 = require("../");
+const urlTokenBaseHTTPClient_1 = require("./urlTokenBaseHTTPClient");
+/** A HTTP Client that wraps the Algorand SDK HTTP Client with retries */
+class AlgoHttpClientWithRetry extends urlTokenBaseHTTPClient_1.URLTokenBaseHTTPClient {
+    async callWithRetry(func) {
+        let response;
+        let numTries = 1;
+        do {
+            try {
+                response = await func();
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            }
+            catch (err) {
+                if (numTries >= AlgoHttpClientWithRetry.MAX_TRIES) {
+                    throw err;
+                }
+                // Only retry for one of the hardcoded conditions
+                if (!(AlgoHttpClientWithRetry.RETRY_ERROR_CODES.includes(err.code) || AlgoHttpClientWithRetry.RETRY_STATUS_CODES.includes(err.status))) {
+                    throw err;
+                }
+                // Retry immediately the first time, then exponentially backoff.
+                const delayTimeMs = numTries == 1 ? 0 : Math.min(1000 * Math.pow(2, numTries - 1), AlgoHttpClientWithRetry.MAX_BACKOFF_MS);
+                if (delayTimeMs > 0) {
+                    await new Promise((r) => setTimeout(r, delayTimeMs));
+                }
+                __1.Config.logger.warn(`algosdk request failed ${numTries} times. Retrying in ${delayTimeMs}ms: ${err}`);
+            }
+        } while (!response && ++numTries <= AlgoHttpClientWithRetry.MAX_TRIES);
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        return response;
+    }
+    async get(relativePath, query, requestHeaders = {}) {
+        return await this.callWithRetry(() => super.get(relativePath, query, requestHeaders));
+    }
+    async post(relativePath, data, query, requestHeaders = {}) {
+        return await this.callWithRetry(() => super.post(relativePath, data, query, requestHeaders));
+    }
+    async delete(relativePath, data, query, requestHeaders = {}) {
+        return await this.callWithRetry(() => super.delete(relativePath, data, query, requestHeaders));
+    }
+}
+exports.AlgoHttpClientWithRetry = AlgoHttpClientWithRetry;
+AlgoHttpClientWithRetry.MAX_TRIES = 5;
+AlgoHttpClientWithRetry.MAX_BACKOFF_MS = 10000;
+// These lists come from https://visionmedia.github.io/superagent/#retrying-requests
+// which is the underlying library used by algosdk - but the CloudFlare specific 52X status codes have been removed
+AlgoHttpClientWithRetry.RETRY_STATUS_CODES = [408, 413, 429, 500, 502, 503, 504];
+AlgoHttpClientWithRetry.RETRY_ERROR_CODES = [
+    'ETIMEDOUT',
+    'ECONNRESET',
+    'EADDRINUSE',
+    'ECONNREFUSED',
+    'EPIPE',
+    'ENOTFOUND',
+    'ENETUNREACH',
+    'EAI_AGAIN',
+    'EPROTO', // We get this intermittently with AlgoNode API
+];
+//# sourceMappingURL=algo-http-client-with-retry.js.map

package/types/algo-http-client-with-retry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"algo-http-client-with-retry.js","sourceRoot":"","sources":["../../src/types/algo-http-client-with-retry.ts"],"names":[],"mappings":";;;AACA,2BAA4B;AAC5B,qEAAiE;AAEjE,yEAAyE;AACzE,MAAa,uBAAwB,SAAQ,+CAAsB;IAmBzD,KAAK,CAAC,aAAa,CAAC,IAA2C;QACrE,IAAI,QAA4C,CAAA;QAChD,IAAI,QAAQ,GAAG,CAAC,CAAA;QAChB,GAAG;YACD,IAAI;gBACF,QAAQ,GAAG,MAAM,IAAI,EAAE,CAAA;gBACvB,8DAA8D;aAC/D;YAAC,OAAO,GAAQ,EAAE;gBACjB,IAAI,QAAQ,IAAI,uBAAuB,CAAC,SAAS,EAAE;oBACjD,MAAM,GAAG,CAAA;iBACV;gBACD,iDAAiD;gBACjD,IACE,CAAC,CAAC,uBAAuB,CAAC,iBAAiB,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,uBAAuB,CAAC,kBAAkB,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,EAClI;oBACA,MAAM,GAAG,CAAA;iBACV;gBACD,gEAAgE;gBAChE,MAAM,WAAW,GAAG,QAAQ,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,GAAG,CAAC,CAAC,EAAE,uBAAuB,CAAC,cAAc,CAAC,CAAA;gBAC1H,IAAI,WAAW,GAAG,CAAC,EAAE;oBACnB,MAAM,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAA;iBACrD;gBACD,UAAM,CAAC,MAAM,CAAC,IAAI,CAAC,0BAA0B,QAAQ,uBAAuB,WAAW,OAAO,GAAG,EAAE,CAAC,CAAA;aACrG;SACF,QAAQ,CAAC,QAAQ,IAAI,EAAE,QAAQ,IAAI,uBAAuB,CAAC,SAAS,EAAC;QACtE,oEAAoE;QACpE,OAAO,QAAS,CAAA;IAClB,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,YAAoB,EAAE,KAAqB,EAAE,iBAAyC,EAAE;QAChG,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,YAAY,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC,CAAA;IACvF,CAAC;IAED,KAAK,CAAC,IAAI,CACR,YAAoB,EACpB,IAAgB,EAChB,KAAqB,EACrB,iBAAyC,EAAE;QAE3C,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC,CAAA;IAC9F,CAAC;IAED,KAAK,CAAC,MAAM,CACV,YAAoB,EACpB,IAAgB,EAChB,KAAqB,EACrB,iBAAyC,EAAE;QAE3C,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,YAAY,EAAE,IAAI,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC,CAAA;IAChG,CAAC;;AApEH,0DAqEC;AApEyB,iCAAS,GAAG,CAAC,CAAA;AACb,sCAAc,GAAG,KAAK,CAAA;AAE9C,oFAAoF;AACpF,mHAAmH;AAC3F,0CAAkB,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;AACxD,yCAAiB,GAAG;IAC1C,WAAW;IACX,YAAY;IACZ,YAAY;IACZ,cAAc;IACd,OAAO;IACP,WAAW;IACX,aAAa;IACb,WAAW;IACX,QAAQ,EAAE,+CAA+C;CAC1D,CAAA"}