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

package/transfer.js

@@ -3,9 +3,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.transferAlgos = void 0;
+exports.ensureFunded = exports.transferAlgos = void 0;
 const algosdk_1 = __importDefault(require("algosdk"));
-const config_1 = require("./config");
+const _1 = require("./");
 const transaction_1 = require("./transaction");
 /**
  * Transfer ALGOs between two accounts.
@@ -25,9 +25,41 @@ async function transferAlgos(transfer, algod) {
         rekeyTo: undefined,
     });
     if (!sendParams.skipSending) {
-        config_1.AlgoKitConfig.getLogger(sendParams.suppressLog).debug(`Transferring ${amount.microAlgos}µALGOs from ${(0, transaction_1.getSenderAddress)(from)} to ${to}`);
+        _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

@@ -1 +1 @@
-{"version":3,"file":"transfer.js","sourceRoot":"","sources":["../src/transfer.ts"],"names":[],"mappings":";;;;;;AAAA,sDAA2D;AAE3D,qCAAwC;AACxC,+CASsB;AAetB;;;;;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,sBAAa,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;KACzI;IAED,OAAO,IAAA,6BAAe,EAAC,EAAE,WAAW,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,KAAK,CAAC,CAAA;AAClE,CAAC;AAlBD,sCAkBC"}
+{"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.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/{algo-http-client-with-retry.js → types/algo-http-client-with-retry.js}

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AlgoHttpClientWithRetry = void 0;
-const config_1 = require("./config");
+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 {
@@ -26,7 +26,7 @@ class AlgoHttpClientWithRetry extends urlTokenBaseHTTPClient_1.URLTokenBaseHTTPC
                 if (delayTimeMs > 0) {
                     await new Promise((r) => setTimeout(r, delayTimeMs));
                 }
-                config_1.AlgoKitConfig.logger.warn(`algosdk request failed ${numTries} times. Retrying in ${delayTimeMs}ms: ${err}`);
+                __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

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"}

package/types/algod.d.ts

@@ -2,7 +2,7 @@ import { EncodedSignedTransaction } from 'algosdk';
 /** The response from the pending transaction API @see https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2transactionspendingtxid */
 export interface PendingTransactionResponse {
     /**
-     * The application index if the transaction was found and it created an
+     * The application id if the transaction was found and it created an
      * application.
      */
     'application-index'?: number;
@@ -11,7 +11,7 @@ export interface PendingTransactionResponse {
      */
     'asset-closing-amount'?: number;
     /**
-     * The asset index if the transaction was found and it created an asset.
+     * The asset id if the transaction was found and it created an asset.
      */
     'asset-index'?: number;
     /**
@@ -61,18 +61,32 @@ export interface PendingTransactionResponse {
     txn: EncodedSignedTransaction;
 }
 /** Represents a TEAL value delta @see https://developer.algorand.org/docs/rest-apis/algod/v2/#evaldelta */
-interface EvalDelta {
-    action: number;
+export type EvalDelta = {
+    /**
+     * Value `1` refers to **bytes**, value `2` refers to **uint**
+     */
+    action: 1;
+    /**
+     * Bytes value.
+     */
     bytes: string;
-    uint: number;
-}
+} | {
+    /**
+     * Value `1` refers to **bytes**, value `2` refers to **uint**
+     */
+    action: 2;
+    /**
+     * Uint value.
+     */
+    uint: number | bigint;
+};
 /** The response from the application API @see https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2applicationsapplication-id */
 export interface ApplicationResponse {
     id: number;
     params: ApplicationParams;
 }
 /** Stores the global information associated with an application @see https://developer.algorand.org/docs/rest-apis/algod/v2/#applicationparams */
-interface ApplicationParams {
+export interface ApplicationParams {
     /** Address of the account that created the app */
     creator: string;
     /** Base64 encoded TEAL approval program */
@@ -94,7 +108,7 @@ interface ApplicationParams {
 /**
  * Represents a TEAL value @see https://developer.algorand.org/docs/rest-apis/algod/v2/#tealvalue
  */
-type TealValue = {
+export type TealValue = {
     /**
      * (tt) value type. Value `1` refers to **bytes**, value `2` refers to **uint**
      */
@@ -120,5 +134,4 @@ export interface ApplicationStateSchema {
     /** [nui] num of uints */
     'num-uint': number;
 }
-export {};
 //# sourceMappingURL=algod.d.ts.map

package/types/algod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"algod.d.ts","sourceRoot":"","sources":["../../src/types/algod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAA;AAElD,+IAA+I;AAC/I,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAA;IAC/B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE,CAAA;IAClD;;OAEG;IACH,YAAY,CAAC,EAAE,0BAA0B,EAAE,CAAA;IAC3C;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE,CAAA;IACjD;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,EAAE,CAAA;IACnB;4GACwG;IACxG,YAAY,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB;;OAEG;IACH,GAAG,EAAE,wBAAwB,CAAA;CAC9B;AAED,2GAA2G;AAC3G,UAAU,SAAS;IACjB,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;CACb;AAED,0IAA0I;AAC1I,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,iBAAiB,CAAA;CAC1B;AAED,kJAAkJ;AAClJ,UAAU,iBAAiB;IACzB,kDAAkD;IAClD,OAAO,EAAE,MAAM,CAAA;IACf,2CAA2C;IAC3C,kBAAkB,EAAE,MAAM,CAAA;IAC1B,8CAA8C;IAC9C,qBAAqB,EAAE,MAAM,CAAA;IAC7B,+DAA+D;IAC/D,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B,kCAAkC;IAClC,cAAc,CAAC,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,SAAS,CAAA;KAAE,EAAE,CAAA;IACpD,0BAA0B;IAC1B,qBAAqB,CAAC,EAAE,sBAAsB,CAAA;IAC9C,yBAAyB;IACzB,oBAAoB,CAAC,EAAE,sBAAsB,CAAA;CAC9C;AAED;;GAEG;AACH,KAAK,SAAS,GACV;IACE;;OAEG;IACH,IAAI,EAAE,CAAC,CAAA;IACP;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;CACd,GACD;IACE;;OAEG;IACH,IAAI,EAAE,CAAC,CAAA;IAEP;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;CACtB,CAAA;AAEL,2JAA2J;AAC3J,MAAM,WAAW,sBAAsB;IACrC,+BAA+B;IAC/B,gBAAgB,EAAE,MAAM,CAAA;IACxB,yBAAyB;IACzB,UAAU,EAAE,MAAM,CAAA;CACnB"}
+{"version":3,"file":"algod.d.ts","sourceRoot":"","sources":["../../src/types/algod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAA;AAElD,+IAA+I;AAC/I,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAA;IAC/B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE,CAAA;IAClD;;OAEG;IACH,YAAY,CAAC,EAAE,0BAA0B,EAAE,CAAA;IAC3C;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE,CAAA;IACjD;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,EAAE,CAAA;IACnB;4GACwG;IACxG,YAAY,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB;;OAEG;IACH,GAAG,EAAE,wBAAwB,CAAA;CAC9B;AAED,2GAA2G;AAC3G,MAAM,MAAM,SAAS,GACjB;IACE;;OAEG;IACH,MAAM,EAAE,CAAC,CAAA;IACT;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;CACd,GACD;IACE;;OAEG;IACH,MAAM,EAAE,CAAC,CAAA;IAET;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;CACtB,CAAA;AAEL,0IAA0I;AAC1I,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,iBAAiB,CAAA;CAC1B;AAED,kJAAkJ;AAClJ,MAAM,WAAW,iBAAiB;IAChC,kDAAkD;IAClD,OAAO,EAAE,MAAM,CAAA;IACf,2CAA2C;IAC3C,kBAAkB,EAAE,MAAM,CAAA;IAC1B,8CAA8C;IAC9C,qBAAqB,EAAE,MAAM,CAAA;IAC7B,+DAA+D;IAC/D,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B,kCAAkC;IAClC,cAAc,CAAC,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,SAAS,CAAA;KAAE,EAAE,CAAA;IACpD,0BAA0B;IAC1B,qBAAqB,CAAC,EAAE,sBAAsB,CAAA;IAC9C,yBAAyB;IACzB,oBAAoB,CAAC,EAAE,sBAAsB,CAAA;CAC9C;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,GACjB;IACE;;OAEG;IACH,IAAI,EAAE,CAAC,CAAA;IACP;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;CACd,GACD;IACE;;OAEG;IACH,IAAI,EAAE,CAAC,CAAA;IAEP;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;CACtB,CAAA;AAEL,2JAA2J;AAC3J,MAAM,WAAW,sBAAsB;IACrC,+BAA+B;IAC/B,gBAAgB,EAAE,MAAM,CAAA;IACxB,yBAAyB;IACzB,UAAU,EAAE,MAAM,CAAA;CACnB"}

package/{algo-amount.d.ts → types/amount.d.ts}

@@ -10,9 +10,11 @@ export declare class AlgoAmount {
     } | {
         microAlgos: number;
     });
+    toString(): string;
+    valueOf(): number;
     /** Create a @see {AlgoAmount} object representing the given number of Algos */
     static Algos(amount: number): AlgoAmount;
     /** Create a @see {AlgoAmount} object representing the given number of µAlgos */
     static MicroAlgos(amount: number): AlgoAmount;
 }
-//# sourceMappingURL=algo-amount.d.ts.map
+//# sourceMappingURL=amount.d.ts.map

package/types/amount.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"amount.d.ts","sourceRoot":"","sources":["../../src/types/amount.ts"],"names":[],"mappings":"AAEA,0FAA0F;AAC1F,qBAAa,UAAU;IACrB,OAAO,CAAC,kBAAkB,CAAA;IAE1B,8CAA8C;IAC9C,IAAI,UAAU,WAEb;IAED,6CAA6C;IAC7C,IAAI,KAAK,WAER;gBAEW,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE;IAI9D,QAAQ,IAAI,MAAM;IAIlB,OAAO,IAAI,MAAM;IAIjB,+EAA+E;IAC/E,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM;IAI3B,gFAAgF;IAChF,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM;CAGjC"}

package/{algo-amount.js → types/amount.js}

@@ -18,6 +18,12 @@ class AlgoAmount {
     constructor(amount) {
         this.amountInMicroAlgos = 'microAlgos' in amount ? amount.microAlgos : algosdk_1.default.algosToMicroalgos(amount.algos);
     }
+    toString() {
+        return `${this.microAlgos.toLocaleString('en-US')} µALGO${this.microAlgos === 1 ? '' : 's'}`;
+    }
+    valueOf() {
+        return this.microAlgos;
+    }
     /** Create a @see {AlgoAmount} object representing the given number of Algos */
     static Algos(amount) {
         return new AlgoAmount({ algos: amount });
@@ -28,4 +34,4 @@ class AlgoAmount {
     }
 }
 exports.AlgoAmount = AlgoAmount;
-//# sourceMappingURL=algo-amount.js.map
+//# sourceMappingURL=amount.js.map

package/types/amount.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"amount.js","sourceRoot":"","sources":["../../src/types/amount.ts"],"names":[],"mappings":";;;;;;AAAA,sDAA6B;AAE7B,0FAA0F;AAC1F,MAAa,UAAU;IAGrB,8CAA8C;IAC9C,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,kBAAkB,CAAA;IAChC,CAAC;IAED,6CAA6C;IAC7C,IAAI,KAAK;QACP,OAAO,iBAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAA;IAC3D,CAAC;IAED,YAAY,MAAkD;QAC5D,IAAI,CAAC,kBAAkB,GAAG,YAAY,IAAI,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,iBAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IAChH,CAAC;IAED,QAAQ;QACN,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,OAAO,CAAC,SAAS,IAAI,CAAC,UAAU,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAA;IAC9F,CAAC;IAED,OAAO;QACL,OAAO,IAAI,CAAC,UAAU,CAAA;IACxB,CAAC;IAED,+EAA+E;IAC/E,MAAM,CAAC,KAAK,CAAC,MAAc;QACzB,OAAO,IAAI,UAAU,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAA;IAC1C,CAAC;IAED,gFAAgF;IAChF,MAAM,CAAC,UAAU,CAAC,MAAc;QAC9B,OAAO,IAAI,UAAU,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC,CAAA;IAC/C,CAAC;CACF;AAlCD,gCAkCC"}

package/types/app.d.ts

@@ -0,0 +1,279 @@
+import { ABIArgument, ABIMethod, ABIMethodParams, ABIType, ABIValue, Address, SourceMap, SuggestedParams, Transaction } from 'algosdk';
+import { SendTransactionFrom, SendTransactionParams, SendTransactionResult, TransactionNote, TransactionToSign } from './transaction';
+/** The name of the TEAL template variable for deploy-time immutability control */
+export declare const UPDATABLE_TEMPLATE_NAME = "TMPL_UPDATABLE";
+/** The name of the TEAL template variable for deploy-time permanence control */
+export declare const DELETABLE_TEMPLATE_NAME = "TMPL_DELETABLE";
+/** The app create/update ARC-2 transaction note prefix */
+export declare const APP_DEPLOY_NOTE_DAPP = "ALGOKIT_DEPLOYER";
+/** The maximum number of bytes in a single app code page */
+export declare const APP_PAGE_MAX_SIZE = 2048;
+/** First 4 bytes of SHA-512/256 hash of "return" for retrieving ABI return values */
+export declare const ABI_RETURN_PREFIX: Uint8Array;
+/** Information about an Algorand app */
+export interface AppReference {
+    /** The id of the app */
+    appId: number;
+    /** The Algorand address of the account associated with the app */
+    appAddress: string;
+}
+/**
+ * A grouping of the app ID and name of the box in an Uint8Array
+ */
+export interface BoxReference {
+    /**
+     * A unique application id
+     */
+    appId: number;
+    /**
+     * Name of box to reference
+     */
+    name: Uint8Array | string;
+}
+/**
+ * App call args with raw values (minus some processing like encoding strings as binary)
+ */
+export interface RawAppCallArgs {
+    /** The address of any accounts to load in */
+    accounts?: (string | Address)[];
+    /** Any application arguments to pass through */
+    appArgs?: (Uint8Array | string)[];
+    /** Any box references to load */
+    boxes?: BoxReference[];
+    /** IDs of any apps to load into the foreignApps array */
+    apps?: number[];
+    /** IDs of any assets to load into the foreignAssets array */
+    assets?: number[];
+    /** The optional lease for the transaction */
+    lease?: string | Uint8Array;
+}
+export type ABIAppCallArg = ABIArgument | TransactionToSign | Transaction;
+/**
+ * App call args for an ABI call
+ */
+export interface ABIAppCallArgs {
+    /** The ABI method to call, either:
+     *  * `method_name` e.g. `hello`; or
+     *  * `method_signature` e.g. `hello(string)string`
+     **/
+    method: ABIMethodParams | ABIMethod;
+    /** The ABI args to pass in */
+    args: ABIAppCallArg[];
+    /** The optional lease for the transaction */
+    lease?: string | Uint8Array;
+    /** Any box references to load either as the box name (if for the current app) or the reference with app id */
+    boxes?: (BoxReference | Uint8Array | string)[];
+}
+/** Arguments to pass to an app call either:
+ *   * The raw app call values to pass through into the transaction (after processing); or
+ *   * An ABI method definition (method and args)
+ **/
+export type AppCallArgs = RawAppCallArgs | ABIAppCallArgs;
+/** Base interface for common data passed to an app create or update. */
+interface CreateOrUpdateAppParams extends SendTransactionParams {
+    /** The account (with private key loaded) that will send the µALGOs */
+    from: SendTransactionFrom;
+    /** The approval program as raw teal (string) or compiled teal, base 64 encoded as a byte array (Uint8Array) */
+    approvalProgram: Uint8Array | string;
+    /** The clear state program as raw teal (string) or compiled teal, base 64 encoded as a byte array (Uint8Array) */
+    clearStateProgram: Uint8Array | string;
+    /** Optional transaction parameters */
+    transactionParams?: SuggestedParams;
+    /** The (optional) transaction note */
+    note?: TransactionNote;
+    /** The arguments passed in to the app call */
+    args?: AppCallArgs;
+}
+/** Parameters that are passed in when creating an app. */
+export interface CreateAppParams extends CreateOrUpdateAppParams {
+    /** The storage schema to request for the created app */
+    schema: AppStorageSchema;
+}
+/** Parameters that are passed in when updating an app. */
+export interface UpdateAppParams extends CreateOrUpdateAppParams {
+    /** The id of the app to update */
+    appId: number;
+}
+export interface AppCallParams extends SendTransactionParams {
+    /** The id of the app to call */
+    appId: number;
+    /** The type of call, everything except create (@see createApp ) and update (@see updateApp ) */
+    callType: 'optin' | 'closeout' | 'clearstate' | 'delete' | 'normal';
+    /** The account to make the call from */
+    from: SendTransactionFrom;
+    /** Optional transaction parameters */
+    transactionParams?: SuggestedParams;
+    /** The (optional) transaction note */
+    note?: TransactionNote;
+    /** The arguments passed in to the app call */
+    args?: AppCallArgs;
+}
+/** Parameters representing the storage schema of an app. */
+export interface AppStorageSchema {
+    /** Restricts number of ints in per-user local state */
+    localInts: number;
+    /** Restricts number of byte slices in per-user local state */
+    localByteSlices: number;
+    /** Restricts number of ints in global state */
+    globalInts: number;
+    /** Restricts number of byte slices in global state */
+    globalByteSlices: number;
+    /** Any extra pages that are needed for the smart contract; if left blank then the right number of pages will be calculated based on the teal code size */
+    extraPages?: number;
+}
+/** Information about a compiled teal program */
+export interface CompiledTeal {
+    /** Original TEAL code */
+    teal: string;
+    /** The compiled code */
+    compiled: string;
+    /** The has returned by the compiler */
+    compiledHash: string;
+    /** The base64 encoded code as a byte array */
+    compiledBase64ToBytes: Uint8Array;
+    /** Source map from the compilation */
+    sourceMap: SourceMap;
+}
+/** Result from calling an app */
+export interface AppCallTransactionResult extends SendTransactionResult {
+    /** If an ABI method was called the processed return value */
+    return?: ABIReturn;
+}
+/** The return value of an ABI method call */
+export type ABIReturn = {
+    rawReturnValue: Uint8Array;
+    returnValue: ABIValue;
+    decodeError: undefined;
+} | {
+    rawReturnValue: undefined;
+    returnValue: undefined;
+    decodeError: Error;
+};
+/**
+ * The payload of the metadata to add to the transaction note when deploying an app, noting it will be prefixed with @see {APP_DEPLOY_NOTE_PREFIX}.
+ */
+export interface AppDeployMetadata {
+    /** The unique name identifier of the app within the creator account */
+    name: string;
+    /** The version of app that is / will be deployed */
+    version: string;
+    /** Whether or not the app is deletable / permanent / unspecified */
+    deletable?: boolean;
+    /** Whether or not the app is updatable / immutable / unspecified */
+    updatable?: boolean;
+}
+/** The metadata that can be collected about a deployed app */
+export interface AppMetadata extends AppReference, AppDeployMetadata {
+    /** The round the app was created */
+    createdRound: number;
+    /** The last round that the app was updated */
+    updatedRound: number;
+    /** The metadata when the app was created */
+    createdMetadata: AppDeployMetadata;
+    /** Whether or not the app is deleted */
+    deleted: boolean;
+}
+/** A lookup of name -> Algorand app for a creator */
+export interface AppLookup {
+    creator: Readonly<string>;
+    apps: Readonly<{
+        [name: string]: AppMetadata;
+    }>;
+}
+/** Dictionary of deploy-time parameters to replace in a teal template.
+ *
+ * Note: Looks for `TMPL_{parameter}` for template replacements i.e. you can leave out the `TMPL_`.
+ *
+ */
+export interface TealTemplateParams {
+    [key: string]: string | bigint | number | Uint8Array;
+}
+/** What action to perform when deploying an app and an update is detected in the TEAL code */
+export declare enum OnUpdate {
+    /** Fail the deployment */
+    Fail = 0,
+    /** Update the app */
+    UpdateApp = 1,
+    /** Delete the app and create a new one in its place */
+    ReplaceApp = 2
+}
+/** What action to perform when deploying an app and a breaking schema change is detected */
+export declare enum OnSchemaBreak {
+    /** Fail the deployment */
+    Fail = 0,
+    /** Delete the app and create a new one in its place */
+    ReplaceApp = 1
+}
+/** The parameters to deploy an app */
+export interface AppDeploymentParams extends Omit<CreateAppParams, 'args' | 'note' | 'skipSending' | 'skipWaiting'> {
+    /** The deployment metadata */
+    metadata: AppDeployMetadata;
+    /** Any deploy-time parameters to replace in the TEAL code */
+    deployTimeParams?: TealTemplateParams;
+    /** What action to perform if a schema break is detected */
+    onSchemaBreak?: 'replace' | 'fail' | OnSchemaBreak;
+    /** What action to perform if a TEAL update is detected */
+    onUpdate?: 'update' | 'replace' | 'fail' | OnUpdate;
+    /** Optional cached value of the existing apps for the given creator */
+    existingDeployments?: AppLookup;
+    /** Any args to pass to any create transaction that is issued as part of deployment */
+    createArgs?: AppCallArgs;
+    /** Any args to pass to any update transaction that is issued as part of deployment */
+    updateArgs?: AppCallArgs;
+    /** Any args to pass to any delete transaction that is issued as part of deployment */
+    deleteArgs?: AppCallArgs;
+}
+/** The result of compiling the approval and clear TEAL for an app */
+export interface AppCompilationResult {
+    /** The compilation result of approval */
+    compiledApproval: CompiledTeal;
+    /** The compilation result of clear */
+    compiledClear: CompiledTeal;
+}
+/** Object holding app state values */
+export interface AppState {
+    [key: string]: {
+        value: number | bigint;
+        keyRaw: Uint8Array;
+        keyBase64: string;
+    } | {
+        value: string;
+        valueRaw: Uint8Array;
+        valueBase64: string;
+        keyRaw: Uint8Array;
+        keyBase64: string;
+    };
+}
+/** The name of a box storage box */
+export interface BoxName {
+    /** Name in UTF-8 */
+    name: string;
+    /** Name in binary bytes */
+    nameRaw: Uint8Array;
+    /** Name in Base64 */
+    nameBase64: string;
+}
+/**
+ * Parameters to get and decode a box value as an ABI type.
+ */
+export interface BoxValueRequestParams {
+    /** The ID of the app return box names for */
+    appId: number;
+    /** The name of the box to return either as a string, binary array or @see BoxName */
+    boxName: string | Uint8Array | BoxName;
+    /** The ABI type to decode the value using */
+    type: ABIType;
+}
+/**
+ * Parameters to get and decode a box value as an ABI type.
+ */
+export interface BoxValuesRequestParams {
+    /** The ID of the app return box names for */
+    appId: number;
+    /** The names of the boxes to return either as a string, binary array or @see BoxName */
+    boxNames: (string | Uint8Array | BoxName)[];
+    /** The ABI type to decode the value using */
+    type: ABIType;
+}
+export {};
+//# sourceMappingURL=app.d.ts.map