@algorandfoundation/algokit-utils 1.0.0-beta.4 → 1.0.0-beta.40

package/transaction.d.ts

@@ -0,0 +1,121 @@
+import algosdk, { Algodv2, AtomicTransactionComposer, SuggestedParams, Transaction } from 'algosdk';
+import { PendingTransactionResponse } from './types/algod';
+import { AlgoAmount } from './types/amount';
+import { AtomicTransactionComposerToSend, SendAtomicTransactionComposerResults, SendTransactionFrom, SendTransactionParams, SendTransactionResult, TransactionGroupToSend, TransactionNote } from './types/transaction';
+/** 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
+ */
+export declare function encodeTransactionNote(note?: TransactionNote): Uint8Array | undefined;
+/**
+ * Returns the public address of the given transaction sender.
+ * @param sender A transaction sender
+ * @returns The public address
+ */
+export declare const getSenderAddress: (sender: SendTransactionFrom) => string;
+/**
+ * Returns a `TransactionSigner` for the given transaction sender.
+ * This function has memoization, so will return the same transaction signer for a given sender.
+ * @param sender A transaction sender
+ * @returns A transaction signer
+ */
+export declare const getSenderTransactionSigner: (val: SendTransactionFrom) => algosdk.TransactionSigner;
+/**
+ * Signs a single transaction by the given signer.
+ * @param transaction The transaction to sign
+ * @param signer The signer to sign
+ * @returns The signed transaction as a `Uint8Array`
+ */
+export declare const signTransaction: (transaction: Transaction, signer: SendTransactionFrom) => Promise<Uint8Array>;
+/** Prepares a transaction for sending and then (if instructed) signs and sends the given transaction to the chain.
+ *
+ * @param send The details for the transaction to prepare/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 `undefined`) confirmation (`confirmation`)
+ */
+export declare const sendTransaction: (send: {
+    transaction: Transaction;
+    from: SendTransactionFrom;
+    sendParams?: SendTransactionParams;
+}, algod: Algodv2) => Promise<SendTransactionResult>;
+/**
+ * Signs and sends transactions that have been collected by an `AtomicTransactionComposer`.
+ * @param atcSend The parameters controlling the send, including:
+ *  * `atc` The `AtomicTransactionComposer`
+ *  * `sendParams` The parameters to control the send behaviour
+ * @param algod An algod client
+ * @returns An object with transaction IDs, transactions, group transaction ID (`groupTransactionId`) if more than 1 transaction sent, and (if `skipWaiting` is `false` or unset) confirmation (`confirmation`)
+ */
+export declare const sendAtomicTransactionComposer: (atcSend: AtomicTransactionComposerToSend, algod: Algodv2) => Promise<SendAtomicTransactionComposerResults>;
+/**
+ * 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
+ */
+export declare function performAtomicTransactionComposerDryrun(atc: AtomicTransactionComposer, algod: Algodv2): Promise<algosdk.DryrunResult>;
+/**
+ * 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 transaction IDs, transactions, group transaction ID (`groupTransactionId`) if more than 1 transaction sent, and (if `skipWaiting` is `false` or unset) confirmation (`confirmation`)
+ */
+export declare const sendGroupOfTransactions: (groupSend: TransactionGroupToSend, algod: Algodv2) => Promise<Omit<SendAtomicTransactionComposerResults, "returns">>;
+/**
+ * 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
+ */
+export declare const waitForConfirmation: (transactionId: string, maxRoundsToWait: number, algod: Algodv2) => Promise<PendingTransactionResponse>;
+/**
+ * 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 or suggested params object about to be used to create a transaction
+ * @param maxAcceptableFee The maximum acceptable fee to pay
+ */
+export declare function capTransactionFee(transaction: algosdk.Transaction | SuggestedParams, maxAcceptableFee: AlgoAmount): void;
+/**
+ * Allows for control of fees on a `Transaction` or `SuggestedParams` object
+ * @param transaction The transaction or suggested params
+ * @param feeControl The fee control parameters
+ */
+export declare function controlFees<T extends SuggestedParams | Transaction>(transaction: T, feeControl: {
+    fee?: AlgoAmount;
+    maxFee?: AlgoAmount;
+}): T;
+/**
+ * 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
+ */
+export declare function getTransactionParams(params: SuggestedParams | undefined, algod: Algodv2): Promise<algosdk.SuggestedParams>;
+/**
+ * Returns the array of transactions currently present in the given `AtomicTransactionComposer`
+ * @param atc The atomic transaction composer
+ * @returns The array of transactions with signers
+ */
+export declare function getAtomicTransactionComposerTransactions(atc: AtomicTransactionComposer): algosdk.TransactionWithSigner[];
+//# sourceMappingURL=transaction.d.ts.map

package/transaction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.d.ts","sourceRoot":"","sources":["../src/transaction.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,EAAE,EAAE,OAAO,EAAE,yBAAyB,EAAE,eAAe,EAAE,WAAW,EAAqB,MAAM,SAAS,CAAA;AAGtH,OAAO,EAAE,0BAA0B,EAAE,MAAM,eAAe,CAAA;AAC1D,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAE3C,OAAO,EACL,+BAA+B,EAC/B,oCAAoC,EACpC,mBAAmB,EACnB,qBAAqB,EACrB,qBAAqB,EACrB,sBAAsB,EACtB,eAAe,EAChB,MAAM,qBAAqB,CAAA;AAE5B;;;;;;;;;;;GAWG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,CAAC,EAAE,eAAe,GAAG,UAAU,GAAG,SAAS,CAcpF;AAED;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,WAAqB,mBAAmB,WAEpE,CAAA;AAWD;;;;;GAKG;AACH,eAAO,MAAM,0BAA0B,yDAMrC,CAAA;AAEF;;;;;GAKG;AACH,eAAO,MAAM,eAAe,gBAAuB,WAAW,UAAU,mBAAmB,wBAQ1F,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe,SACpB;IACJ,WAAW,EAAE,WAAW,CAAA;IACxB,IAAI,EAAE,mBAAmB,CAAA;IACzB,UAAU,CAAC,EAAE,qBAAqB,CAAA;CACnC,SACM,OAAO,KACb,QAAQ,qBAAqB,CA2B/B,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,6BAA6B,YAA4B,+BAA+B,SAAS,OAAO,kDA+EpH,CAAA;AAED;;;;;GAKG;AACH,wBAAsB,sCAAsC,CAAC,GAAG,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,iCAO1G;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,uBAAuB,cAA8B,sBAAsB,SAAS,OAAO,mEAgCvG,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,mBAAmB,kBACf,MAAM,mBACJ,MAAM,SAChB,OAAO,KACb,QAAQ,0BAA0B,CAkCpC,CAAA;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,OAAO,CAAC,WAAW,GAAG,eAAe,EAAE,gBAAgB,EAAE,UAAU,QAgBjH;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,eAAe,GAAG,WAAW,EACjE,WAAW,EAAE,CAAC,EACd,UAAU,EAAE;IAAE,GAAG,CAAC,EAAE,UAAU,CAAC;IAAC,MAAM,CAAC,EAAE,UAAU,CAAA;CAAE,KAatD;AAED;;;;;GAKG;AACH,wBAAsB,oBAAoB,CAAC,MAAM,EAAE,eAAe,GAAG,SAAS,EAAE,KAAK,EAAE,OAAO,oCAE7F;AAED;;;;GAIG;AACH,wBAAgB,wCAAwC,CAAC,GAAG,EAAE,yBAAyB,mCAMtF"}

package/transaction.js

@@ -0,0 +1,364 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAtomicTransactionComposerTransactions = exports.getTransactionParams = exports.controlFees = exports.capTransactionFee = exports.waitForConfirmation = exports.sendGroupOfTransactions = exports.performAtomicTransactionComposerDryrun = exports.sendAtomicTransactionComposer = exports.sendTransaction = exports.signTransaction = exports.getSenderTransactionSigner = exports.getSenderAddress = exports.encodeTransactionNote = void 0;
+const algosdk_1 = __importStar(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;
+const memoize = (fn) => {
+    const cache = new Map();
+    const cached = function (val) {
+        return cache.has(val) ? cache.get(val) : cache.set(val, fn.call(this, val)) && cache.get(val);
+    };
+    cached.cache = cache;
+    return cached;
+};
+/**
+ * Returns a `TransactionSigner` for the given transaction sender.
+ * This function has memoization, so will return the same transaction signer for a given sender.
+ * @param sender A transaction sender
+ * @returns A transaction signer
+ */
+exports.getSenderTransactionSigner = memoize(function (sender) {
+    return 'signer' in sender
+        ? sender.signer
+        : 'lsig' in sender
+            ? algosdk_1.default.makeLogicSigAccountTransactionSigner(sender)
+            : algosdk_1.default.makeBasicAccountTransactionSigner(sender);
+});
+/**
+ * Signs a single transaction by the given signer.
+ * @param transaction The transaction to sign
+ * @param signer The signer to sign
+ * @returns The signed transaction as a `Uint8Array`
+ */
+const signTransaction = async (transaction, signer) => {
+    return 'sk' in signer
+        ? transaction.signTxn(signer.sk)
+        : 'lsig' in signer
+            ? algosdk_1.default.signLogicSigTransactionObject(transaction, signer).blob
+            : 'sign' in signer
+                ? signer.sign(transaction)
+                : (await signer.signer([transaction], [0]))[0];
+};
+exports.signTransaction = signTransaction;
+/** Prepares a transaction for sending and then (if instructed) signs and sends the given transaction to the chain.
+ *
+ * @param send The details for the transaction to prepare/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 `undefined`) confirmation (`confirmation`)
+ */
+const sendTransaction = async function (send, algod) {
+    const { transaction, from, sendParams } = send;
+    const { skipSending, skipWaiting, fee, maxFee, suppressLog, maxRoundsToWaitForConfirmation, atc } = sendParams ?? {};
+    controlFees(transaction, { fee, maxFee });
+    if (atc) {
+        atc.addTransaction({ txn: transaction, signer: (0, exports.getSenderTransactionSigner)(from) });
+        return { transaction };
+    }
+    if (skipSending) {
+        return { transaction };
+    }
+    const signedTransaction = await (0, exports.signTransaction)(transaction, from);
+    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;
+/**
+ * Signs and sends transactions that have been collected by an `AtomicTransactionComposer`.
+ * @param atcSend The parameters controlling the send, including:
+ *  * `atc` The `AtomicTransactionComposer`
+ *  * `sendParams` The parameters to control the send behaviour
+ * @param algod An algod client
+ * @returns An object with transaction IDs, transactions, group transaction ID (`groupTransactionId`) if more than 1 transaction sent, and (if `skipWaiting` is `false` or unset) confirmation (`confirmation`)
+ */
+const sendAtomicTransactionComposer = async function (atcSend, algod) {
+    const { atc, sendParams } = atcSend;
+    const transactionsWithSigner = atc.buildGroup();
+    const transactionsToSend = transactionsWithSigner.map((t) => {
+        return t.txn;
+    });
+    let groupId = undefined;
+    if (transactionsToSend.length > 1) {
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        groupId = transactionsToSend[0].group ? buffer_1.Buffer.from(transactionsToSend[0].group).toString('base64') : '';
+        _1.Config.getLogger(sendParams?.suppressLog).info(`Sending group of ${transactionsToSend.length} transactions (${groupId})`, {
+            transactionsToSend,
+        });
+        _1.Config.getLogger(sendParams?.suppressLog).debug(`Transaction IDs (${groupId})`, transactionsToSend.map((t) => t.txID()));
+    }
+    try {
+        const result = await atc.execute(algod, sendParams?.maxRoundsToWaitForConfirmation ?? 5);
+        if (transactionsToSend.length > 1) {
+            _1.Config.getLogger(sendParams?.suppressLog).info(`Group transaction (${groupId}) sent with ${transactionsToSend.length} transactions`);
+        }
+        else {
+            _1.Config.getLogger(sendParams?.suppressLog).info(`Sent transaction ID ${transactionsToSend[0].txID()} ${transactionsToSend[0].type} from ${algosdk_1.default.encodeAddress(transactionsToSend[0].from.publicKey)}`);
+        }
+        let confirmations = undefined;
+        if (!sendParams?.skipWaiting) {
+            confirmations = await Promise.all(transactionsToSend.map(async (t) => (await algod.pendingTransactionInformation(t.txID()).do())));
+        }
+        return {
+            groupId,
+            confirmations,
+            txIds: transactionsToSend.map((t) => t.txID()),
+            transactions: transactionsToSend,
+            returns: result.methodResults.map((r) => ({
+                decodeError: r.decodeError,
+                returnValue: r.returnValue,
+                rawReturnValue: r.rawReturnValue,
+            })),
+        };
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    }
+    catch (e) {
+        if (_1.Config.debug && typeof e === 'object') {
+            e.traces = [];
+            _1.Config.logger.debug('Received error executing Atomic Transaction Composer and debug flag enabled; attempting dry run to get more information');
+            const dryrun = await performAtomicTransactionComposerDryrun(atc, algod);
+            for (const txn of dryrun.txns) {
+                if (txn.appCallRejected()) {
+                    e.traces.push({
+                        trace: txn.appTrace(),
+                        cost: txn.cost,
+                        logs: txn.logs,
+                        messages: txn.appCallMessages,
+                    });
+                }
+            }
+        }
+        throw e;
+    }
+};
+exports.sendAtomicTransactionComposer = sendAtomicTransactionComposer;
+/**
+ * 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_1.default.decodeSignedTransaction(t);
+    });
+    const dryrun = await algosdk_1.default.createDryrun({ client: algod, txns });
+    return new algosdk_1.default.DryrunResult(await algod.dryrun(dryrun).do());
+}
+exports.performAtomicTransactionComposerDryrun = performAtomicTransactionComposerDryrun;
+/**
+ * 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 transaction IDs, transactions, group transaction ID (`groupTransactionId`) if more than 1 transaction sent, and (if `skipWaiting` is `false` or unset) confirmation (`confirmation`)
+ */
+const sendGroupOfTransactions = async function (groupSend, algod) {
+    const { transactions, signer, sendParams } = groupSend;
+    const defaultTransactionSigner = signer ? (0, exports.getSenderTransactionSigner)(signer) : undefined;
+    const transactionsWithSigner = await Promise.all(transactions.map(async (t) => {
+        if ('signer' in t)
+            return {
+                txn: t.transaction,
+                signer: (0, exports.getSenderTransactionSigner)(t.signer),
+                sender: t.signer,
+            };
+        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 parameter was provided.`);
+        }
+        return {
+            txn,
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            signer: defaultTransactionSigner,
+            sender: signer,
+        };
+    }));
+    const atc = new algosdk_1.AtomicTransactionComposer();
+    transactionsWithSigner.forEach((txn) => atc.addTransaction(txn));
+    return (await (0, exports.sendAtomicTransactionComposer)({ atc, sendParams }, algod));
+};
+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 or suggested params object about to be used to create a transaction
+ * @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;
+/**
+ * Allows for control of fees on a `Transaction` or `SuggestedParams` object
+ * @param transaction The transaction or suggested params
+ * @param feeControl The fee control parameters
+ */
+function controlFees(transaction, feeControl) {
+    const { fee, maxFee } = feeControl;
+    if (fee) {
+        transaction.fee = fee.microAlgos;
+        transaction.flatFee = true;
+    }
+    if (maxFee !== undefined) {
+        capTransactionFee(transaction, maxFee);
+    }
+    return transaction;
+}
+exports.controlFees = controlFees;
+/**
+ * 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 ? { ...params } : await algod.getTransactionParams().do();
+}
+exports.getTransactionParams = getTransactionParams;
+/**
+ * Returns the array of transactions currently present in the given `AtomicTransactionComposer`
+ * @param atc The atomic transaction composer
+ * @returns The array of transactions with signers
+ */
+function getAtomicTransactionComposerTransactions(atc) {
+    try {
+        return atc.clone().buildGroup();
+    }
+    catch {
+        return [];
+    }
+}
+exports.getAtomicTransactionComposerTransactions = getAtomicTransactionComposerTransactions;
+//# sourceMappingURL=transaction.js.map

package/transaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.js","sourceRoot":"","sources":["../src/transaction.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mDAAsH;AACtH,mCAA+B;AAC/B,yBAA2B;AAc3B;;;;;;;;;;;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,MAAM,OAAO,GAAG,CAA2B,EAAiB,EAAE,EAAE;IAC9D,MAAM,KAAK,GAAG,IAAI,GAAG,EAAE,CAAA;IACvB,MAAM,MAAM,GAAG,UAAyB,GAAM;QAC5C,OAAO,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IAC/F,CAAC,CAAA;IACD,MAAM,CAAC,KAAK,GAAG,KAAK,CAAA;IACpB,OAAO,MAAuB,CAAA;AAChC,CAAC,CAAA;AAED;;;;;GAKG;AACU,QAAA,0BAA0B,GAAG,OAAO,CAAC,UAAU,MAA2B;IACrF,OAAO,QAAQ,IAAI,MAAM;QACvB,CAAC,CAAC,MAAM,CAAC,MAAM;QACf,CAAC,CAAC,MAAM,IAAI,MAAM;YAClB,CAAC,CAAC,iBAAO,CAAC,oCAAoC,CAAC,MAAM,CAAC;YACtD,CAAC,CAAC,iBAAO,CAAC,iCAAiC,CAAC,MAAM,CAAC,CAAA;AACvD,CAAC,CAAC,CAAA;AAEF;;;;;GAKG;AACI,MAAM,eAAe,GAAG,KAAK,EAAE,WAAwB,EAAE,MAA2B,EAAE,EAAE;IAC7F,OAAO,IAAI,IAAI,MAAM;QACnB,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAChC,CAAC,CAAC,MAAM,IAAI,MAAM;YAClB,CAAC,CAAC,iBAAO,CAAC,6BAA6B,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC,IAAI;YACjE,CAAC,CAAC,MAAM,IAAI,MAAM;gBAClB,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC;gBAC1B,CAAC,CAAC,CAAC,MAAM,MAAM,CAAC,MAAM,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;AAClD,CAAC,CAAA;AARY,QAAA,eAAe,mBAQ3B;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,EAAE,GAAG,UAAU,IAAI,EAAE,CAAA;IAEpH,WAAW,CAAC,WAAW,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,CAAA;IAEzC,IAAI,GAAG,EAAE;QACP,GAAG,CAAC,cAAc,CAAC,EAAE,GAAG,EAAE,WAAW,EAAE,MAAM,EAAE,IAAA,kCAA0B,EAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAClF,OAAO,EAAE,WAAW,EAAE,CAAA;KACvB;IAED,IAAI,WAAW,EAAE;QACf,OAAO,EAAE,WAAW,EAAE,CAAA;KACvB;IAED,MAAM,iBAAiB,GAAG,MAAM,IAAA,uBAAe,EAAC,WAAW,EAAE,IAAI,CAAC,CAAA;IAElE,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;AAlCY,QAAA,eAAe,mBAkC3B;AAED;;;;;;;GAOG;AACI,MAAM,6BAA6B,GAAG,KAAK,WAAW,OAAwC,EAAE,KAAc;IACnH,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,GAAG,OAAO,CAAA;IAEnC,MAAM,sBAAsB,GAAG,GAAG,CAAC,UAAU,EAAE,CAAA;IAE/C,MAAM,kBAAkB,GAAG,sBAAsB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QAC1D,OAAO,CAAC,CAAC,GAAG,CAAA;IACd,CAAC,CAAC,CAAA;IACF,IAAI,OAAO,GAAuB,SAAS,CAAA;IAC3C,IAAI,kBAAkB,CAAC,MAAM,GAAG,CAAC,EAAE;QACjC,oEAAoE;QACpE,OAAO,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,eAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;QACxG,SAAM,CAAC,SAAS,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,IAAI,CAAC,oBAAoB,kBAAkB,CAAC,MAAM,kBAAkB,OAAO,GAAG,EAAE;YACxH,kBAAkB;SACnB,CAAC,CAAA;QAEF,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;KACF;IAED,IAAI;QACF,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,UAAU,EAAE,8BAA8B,IAAI,CAAC,CAAC,CAAA;QAExF,IAAI,kBAAkB,CAAC,MAAM,GAAG,CAAC,EAAE;YACjC,SAAM,CAAC,SAAS,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,IAAI,CAAC,sBAAsB,OAAO,eAAe,kBAAkB,CAAC,MAAM,eAAe,CAAC,CAAA;SACrI;aAAM;YACL,SAAM,CAAC,SAAS,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,IAAI,CAC5C,uBAAuB,kBAAkB,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,kBAAkB,CAAC,CAAC,CAAC,CAAC,IAAI,SAAS,iBAAO,CAAC,aAAa,CAC7G,kBAAkB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CACrC,EAAE,CACJ,CAAA;SACF;QAED,IAAI,aAAa,GAA6C,SAAS,CAAA;QACvE,IAAI,CAAC,UAAU,EAAE,WAAW,EAAE;YAC5B,aAAa,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,kBAAkB,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,KAAK,CAAC,6BAA6B,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,CAA+B,CAAC,CAC9H,CAAA;SACF;QAED,OAAO;YACL,OAAO;YACP,aAAa;YACb,KAAK,EAAE,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YAC9C,YAAY,EAAE,kBAAkB;YAChC,OAAO,EAAE,MAAM,CAAC,aAAa,CAAC,GAAG,CAC/B,CAAC,CAAC,EAAE,EAAE,CACJ,CAAC;gBACC,WAAW,EAAE,CAAC,CAAC,WAAW;gBAC1B,WAAW,EAAE,CAAC,CAAC,WAAW;gBAC1B,cAAc,EAAE,CAAC,CAAC,cAAc;aACnB,CAAA,CAClB;SACsC,CAAA;QACzC,8DAA8D;KAC/D;IAAC,OAAO,CAAM,EAAE;QACf,IAAI,SAAM,CAAC,KAAK,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE;YACzC,CAAC,CAAC,MAAM,GAAG,EAAE,CAAA;YACb,SAAM,CAAC,MAAM,CAAC,KAAK,CACjB,yHAAyH,CAC1H,CAAA;YACD,MAAM,MAAM,GAAG,MAAM,sCAAsC,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;YAEvE,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,EAAE;gBAC7B,IAAI,GAAG,CAAC,eAAe,EAAE,EAAE;oBACzB,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;wBACZ,KAAK,EAAE,GAAG,CAAC,QAAQ,EAAE;wBACrB,IAAI,EAAE,GAAG,CAAC,IAAI;wBACd,IAAI,EAAE,GAAG,CAAC,IAAI;wBACd,QAAQ,EAAE,GAAG,CAAC,eAAe;qBAC9B,CAAC,CAAA;iBACH;aACF;SACF;QAED,MAAM,CAAC,CAAA;KACR;AACH,CAAC,CAAA;AA/EY,QAAA,6BAA6B,iCA+EzC;AAED;;;;;GAKG;AACI,KAAK,UAAU,sCAAsC,CAAC,GAA8B,EAAE,KAAc;IACzG,MAAM,kBAAkB,GAAG,MAAM,GAAG,CAAC,gBAAgB,EAAE,CAAA;IACvD,MAAM,IAAI,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QACxC,OAAO,iBAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAA;IAC3C,CAAC,CAAC,CAAA;IACF,MAAM,MAAM,GAAG,MAAM,iBAAO,CAAC,YAAY,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;IAClE,OAAO,IAAI,iBAAO,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;AAClE,CAAC;AAPD,wFAOC;AAED;;;;;;;;GAQG;AACI,MAAM,uBAAuB,GAAG,KAAK,WAAW,SAAiC,EAAE,KAAc;IACtG,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,SAAS,CAAA;IAEtD,MAAM,wBAAwB,GAAG,MAAM,CAAC,CAAC,CAAC,IAAA,kCAA0B,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAExF,MAAM,sBAAsB,GAAG,MAAM,OAAO,CAAC,GAAG,CAC9C,YAAY,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;QAC3B,IAAI,QAAQ,IAAI,CAAC;YACf,OAAO;gBACL,GAAG,EAAE,CAAC,CAAC,WAAW;gBAClB,MAAM,EAAE,IAAA,kCAA0B,EAAC,CAAC,CAAC,MAAM,CAAC;gBAC5C,MAAM,EAAE,CAAC,CAAC,MAAM;aACjB,CAAA;QAEH,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,wEAAwE,CAAC,CAAA;SACnI;QAED,OAAO;YACL,GAAG;YACH,oEAAoE;YACpE,MAAM,EAAE,wBAAyB;YACjC,MAAM,EAAE,MAAM;SACf,CAAA;IACH,CAAC,CAAC,CACH,CAAA;IAED,MAAM,GAAG,GAAG,IAAI,mCAAyB,EAAE,CAAA;IAC3C,sBAAsB,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAA;IAEhE,OAAO,CAAC,MAAM,IAAA,qCAA6B,EAAC,EAAE,GAAG,EAAE,UAAU,EAAE,EAAE,KAAK,CAAC,CAA0D,CAAA;AACnI,CAAC,CAAA;AAhCY,QAAA,uBAAuB,2BAgCnC;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,WAAkD,EAAE,gBAA4B;IAChH,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;;;;GAIG;AACH,SAAgB,WAAW,CACzB,WAAc,EACd,UAAqD;IAErD,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,UAAU,CAAA;IAClC,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,OAAO,WAAW,CAAA;AACpB,CAAC;AAfD,kCAeC;AAED;;;;;GAKG;AACI,KAAK,UAAU,oBAAoB,CAAC,MAAmC,EAAE,KAAc;IAC5F,OAAO,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,oBAAoB,EAAE,CAAC,EAAE,EAAE,CAAA;AACzE,CAAC;AAFD,oDAEC;AAED;;;;GAIG;AACH,SAAgB,wCAAwC,CAAC,GAA8B;IACrF,IAAI;QACF,OAAO,GAAG,CAAC,KAAK,EAAE,CAAC,UAAU,EAAE,CAAA;KAChC;IAAC,MAAM;QACN,OAAO,EAAE,CAAA;KACV;AACH,CAAC;AAND,4FAMC"}

package/transfer.d.ts

@@ -0,0 +1,22 @@
+import { Algodv2, Kmd } 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).
+ *
+ * https://developer.algorand.org/docs/get-details/accounts/#minimum-balance
+ *
+ * @param funding The funding configuration
+ * @param algod An algod client
+ * @param kmd An optional kmd client
+ * @returns undefined if nothing was needed or the transaction send result
+ */
+export declare function ensureFunded(funding: EnsureFundedParams, algod: Algodv2, kmd?: Kmd): 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,GAAG,EAAE,MAAM,SAAS,CAAA;AAG/C,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;;;;;;;;;GASG;AACH,wBAAsB,YAAY,CAAC,OAAO,EAAE,kBAAkB,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,qBAAqB,GAAG,SAAS,CAAC,CAiCrI"}

package/transfer.js

@@ -0,0 +1,67 @@
+"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: typeof to === 'string' ? to : (0, transaction_1.getSenderAddress)(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).
+ *
+ * https://developer.algorand.org/docs/get-details/accounts/#minimum-balance
+ *
+ * @param funding The funding configuration
+ * @param algod An algod client
+ * @param kmd An optional kmd client
+ * @returns undefined if nothing was needed or the transaction send result
+ */
+async function ensureFunded(funding, algod, kmd) {
+    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.microAlgos);
+    if (minSpendingBalance > currentSpendingBalance) {
+        const from = fundingSource ?? (await (0, _1.getDispenserAccount)(algod, kmd));
+        const minFundAmount = (0, _1.microAlgos)(minSpendingBalance.microAlgos - currentSpendingBalance.microAlgos);
+        const fundAmount = (0, _1.microAlgos)(Math.max(minFundAmount.microAlgos, minFundingIncrement?.microAlgos ?? 0));
+        _1.Config.getLogger(sendParams.suppressLog).info(`Funding ${addressToFund} ${fundAmount} from ${(0, transaction_1.getSenderAddress)(from)} to reach minimum spend amount of ${minSpendingBalance} (balance = ${balance}, min_balance_req = ${minimumBalanceRequirement})`);
+        return await transferAlgos({
+            from,
+            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,sDAA+C;AAC/C,yBAA4D;AAC5D,+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,OAAO,EAAE,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAA,8BAAgB,EAAC,EAAE,CAAC;QACtD,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;;;;;;;;;GASG;AACI,KAAK,UAAU,YAAY,CAAC,OAA2B,EAAE,KAAc,EAAE,GAAS;IACvF,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,yBAAyB,CAAC,UAAU,CAAC,CAAA;IAEzF,IAAI,kBAAkB,GAAG,sBAAsB,EAAE;QAC/C,MAAM,IAAI,GAAG,aAAa,IAAI,CAAC,MAAM,IAAA,sBAAmB,EAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAA;QACrE,MAAM,aAAa,GAAG,IAAA,aAAU,EAAC,kBAAkB,CAAC,UAAU,GAAG,sBAAsB,CAAC,UAAU,CAAC,CAAA;QACnG,MAAM,UAAU,GAAG,IAAA,aAAU,EAAC,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,UAAU,EAAE,mBAAmB,EAAE,UAAU,IAAI,CAAC,CAAC,CAAC,CAAA;QACvG,SAAM,CAAC,SAAS,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,IAAI,CAC3C,WAAW,aAAa,IAAI,UAAU,SAAS,IAAA,8BAAgB,EAC7D,IAAI,CACL,qCAAqC,kBAAkB,eAAe,OAAO,uBAAuB,yBAAyB,GAAG,CAClI,CAAA;QACD,OAAO,MAAM,aAAa,CACxB;YACE,IAAI;YACJ,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;AAjCD,oCAiCC"}