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

package/account.d.ts

@@ -0,0 +1,91 @@
+import algosdk, { Account, Algodv2, Kmd, MultisigMetadata, TransactionSigner } from 'algosdk';
+import { MultisigAccount, SigningAccount, TransactionSignerAccount } from './types/account';
+import { AlgoAmount } from './types/amount';
+/**
+ * Returns an account wrapper that supports partial or full multisig signing.
+ * @param multisigParams The parameters that define the multisig account
+ * @param signingAccounts The signers that are currently present
+ * @returns A multisig account wrapper
+ */
+export declare function multisigAccount(multisigParams: MultisigMetadata, signingAccounts: (Account | SigningAccount)[]): MultisigAccount;
+/**
+ * Returns an account wrapper that supports a rekeyed account.
+ * @param account The account, with private key loaded, that is signing
+ * @param sender The address of the rekeyed account that will act as a sender
+ * @returns The @see SigningAccount wrapper
+ */
+export declare function rekeyedAccount(account: Account, sender: string): SigningAccount;
+/**
+ * Returns an account wrapper that supports a transaction signer with associated sender address.
+ * @param signer The transaction signer
+ * @param sender The address of sender account
+ * @returns The @see SigningAccount wrapper
+ */
+export declare function transactionSignerAccount(signer: TransactionSigner, sender: string): TransactionSignerAccount;
+/** Returns an Algorand account with secret key loaded (i.e. that can sign transactions) by taking the mnemonic secret.
+ *
+ * This is a wrapper around algosdk.mnemonicToSecretKey to provide a more friendly/obvious name.
+ *
+ * @param mnemonicSecret The mnemonic secret representing the private key of an account; **Note: Be careful how the mnemonic is handled**,
+ *  never commit it into source control and ideally load it from the environment (ideally via a secret storage service) rather than the file system.
+ */
+export declare function mnemonicAccount(mnemonicSecret: string): Account;
+/** Returns a new, random Algorand account with secret key loaded.
+ *
+ * This is a wrapper around algosdk.generateAccount to provide a more friendly/obvious name.
+ *
+ */
+export declare function randomAccount(): Account;
+/**
+ * Returns an Algorand account with private key loaded by convention based on the given name identifier.
+ *
+ * Note: This function expects to run in a Node.js environment.
+ *
+ * ## Convention:
+ * * **Non-LocalNet:** will load process.env['\{NAME\}_MNEMONIC'] as a mnemonic secret; **Note: Be careful how the mnemonic is handled**,
+ *  never commit it into source control and ideally load it via a secret storage service rather than the file system.
+ *   If process.env['\{NAME\}_SENDER'] is defined then it will use that for the sender address (i.e. to support rekeyed accounts)
+ * * **LocalNet:** will load the account from a KMD wallet called \{NAME\} and if that wallet doesn't exist it will create it and fund the account for you
+ *
+ * This allows you to write code that will work seamlessly in production and local development (LocalNet) without manual config locally (including when you reset the LocalNet).
+ *
+ * @example Default
+ *
+ * If you have a mnemonic secret loaded into `process.env.ACCOUNT_MNEMONIC` then you can call the following to get that private key loaded into an account object:
+ * ```typescript
+ * const account = await getAccount('ACCOUNT', algod)
+ * ```
+ *
+ * If that code runs against LocalNet then a wallet called `ACCOUNT` will automatically be created with an account that is automatically funded with 1000 (default) ALGOs from the default LocalNet dispenser.
+ *
+ * @param account The details of the account to get, wither the name identifier (string) or an object with:
+ *   * `name`: The name identifier of the account
+ *   * `fundWith`: The amount to fund the account with it it gets created (when targeting LocalNet), if not specified then 1000 Algos will be funded from the dispenser account @see {getDispenserAccount}
+ * @param algod An algod client
+ * @param kmdClient An optional KMD client to use to create an account (when targeting LocalNet), if not specified then a default KMD client will be loaded from environment variables @see {getAlgoKmdClient}
+ * @returns The requested account with private key loaded from the environment variables or when targeting LocalNet from KMD (idempotently creating and funding the account)
+ */
+export declare function getAccount(account: {
+    name: string;
+    fundWith?: AlgoAmount;
+} | string, algod: Algodv2, kmdClient?: Kmd): Promise<Account | SigningAccount>;
+/** Returns an account's address as a byte array
+ *
+ * @param account Either an account (with private key loaded) or the string address of an account
+ */
+export declare function getAccountAddressAsUint8Array(account: Account | string): Uint8Array;
+/** Returns the string address of an Algorand account from a base64 encoded version of the underlying byte array of the address public key
+ *
+ * @param addressEncodedInB64 The base64 encoded version of the underlying byte array of the address public key
+ */
+export declare function getAccountAddressAsString(addressEncodedInB64: string): string;
+/** Returns an account (with private key loaded) that can act as a dispenser
+ *
+ * If running on Sandbox then it will return the default dispenser account automatically,
+ *  otherwise it will load the account mnemonic stored in process.env.DISPENSER_MNEMONIC @see {getAccount}
+ *
+ * @param algod An algod client
+ * @param kmd A KMD client, if not specified then a default KMD client will be loaded from environment variables @see {getAlgoKmdClient}
+ */
+export declare function getDispenserAccount(algod: Algodv2, kmd?: Kmd): Promise<algosdk.Account | SigningAccount>;
+//# sourceMappingURL=account.d.ts.map

package/account.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"account.d.ts","sourceRoot":"","sources":["../src/account.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAI7F,OAAO,EAAqB,eAAe,EAAE,cAAc,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAA;AAC9G,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAE3C;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,cAAc,EAAE,gBAAgB,EAAE,eAAe,EAAE,CAAC,OAAO,GAAG,cAAc,CAAC,EAAE,mBAE9G;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,kBAE9D;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,GAAG,wBAAwB,CAE5G;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAG/D;AAED;;;;GAIG;AACH,wBAAgB,aAAa,IAAI,OAAO,CAGvC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAsB,UAAU,CAC9B,OAAO,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,UAAU,CAAA;CAAE,GAAG,MAAM,EACzD,KAAK,EAAE,OAAO,EACd,SAAS,CAAC,EAAE,GAAG,GACd,OAAO,CAAC,OAAO,GAAG,cAAc,CAAC,CAmCnC;AAED;;;GAGG;AACH,wBAAgB,6BAA6B,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,cAEtE;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,CAAC,mBAAmB,EAAE,MAAM,GAAG,MAAM,CAE7E;AAED;;;;;;;GAOG;AACH,wBAAsB,mBAAmB,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,6CAIlE"}

package/account.js

@@ -0,0 +1,158 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDispenserAccount = exports.getAccountAddressAsString = exports.getAccountAddressAsUint8Array = exports.getAccount = exports.randomAccount = exports.mnemonicAccount = exports.transactionSignerAccount = exports.rekeyedAccount = exports.multisigAccount = void 0;
+const algosdk_1 = __importDefault(require("algosdk"));
+const _1 = require("./");
+const localnet_1 = require("./localnet");
+const network_client_1 = require("./network-client");
+const account_1 = require("./types/account");
+/**
+ * Returns an account wrapper that supports partial or full multisig signing.
+ * @param multisigParams The parameters that define the multisig account
+ * @param signingAccounts The signers that are currently present
+ * @returns A multisig account wrapper
+ */
+function multisigAccount(multisigParams, signingAccounts) {
+    return new account_1.MultisigAccount(multisigParams, signingAccounts);
+}
+exports.multisigAccount = multisigAccount;
+/**
+ * Returns an account wrapper that supports a rekeyed account.
+ * @param account The account, with private key loaded, that is signing
+ * @param sender The address of the rekeyed account that will act as a sender
+ * @returns The @see SigningAccount wrapper
+ */
+function rekeyedAccount(account, sender) {
+    return new account_1.SigningAccount(account, sender);
+}
+exports.rekeyedAccount = rekeyedAccount;
+/**
+ * Returns an account wrapper that supports a transaction signer with associated sender address.
+ * @param signer The transaction signer
+ * @param sender The address of sender account
+ * @returns The @see SigningAccount wrapper
+ */
+function transactionSignerAccount(signer, sender) {
+    return { addr: sender, signer };
+}
+exports.transactionSignerAccount = transactionSignerAccount;
+/** Returns an Algorand account with secret key loaded (i.e. that can sign transactions) by taking the mnemonic secret.
+ *
+ * This is a wrapper around algosdk.mnemonicToSecretKey to provide a more friendly/obvious name.
+ *
+ * @param mnemonicSecret The mnemonic secret representing the private key of an account; **Note: Be careful how the mnemonic is handled**,
+ *  never commit it into source control and ideally load it from the environment (ideally via a secret storage service) rather than the file system.
+ */
+function mnemonicAccount(mnemonicSecret) {
+    // This method is confusingly named, so this function provides a more dev friendly "wrapper" name
+    return algosdk_1.default.mnemonicToSecretKey(mnemonicSecret);
+}
+exports.mnemonicAccount = mnemonicAccount;
+/** Returns a new, random Algorand account with secret key loaded.
+ *
+ * This is a wrapper around algosdk.generateAccount to provide a more friendly/obvious name.
+ *
+ */
+function randomAccount() {
+    // This method is confusingly named, so this function provides a more dev friendly "wrapper" name
+    return algosdk_1.default.generateAccount();
+}
+exports.randomAccount = randomAccount;
+/**
+ * Returns an Algorand account with private key loaded by convention based on the given name identifier.
+ *
+ * Note: This function expects to run in a Node.js environment.
+ *
+ * ## Convention:
+ * * **Non-LocalNet:** will load process.env['\{NAME\}_MNEMONIC'] as a mnemonic secret; **Note: Be careful how the mnemonic is handled**,
+ *  never commit it into source control and ideally load it via a secret storage service rather than the file system.
+ *   If process.env['\{NAME\}_SENDER'] is defined then it will use that for the sender address (i.e. to support rekeyed accounts)
+ * * **LocalNet:** will load the account from a KMD wallet called \{NAME\} and if that wallet doesn't exist it will create it and fund the account for you
+ *
+ * This allows you to write code that will work seamlessly in production and local development (LocalNet) without manual config locally (including when you reset the LocalNet).
+ *
+ * @example Default
+ *
+ * If you have a mnemonic secret loaded into `process.env.ACCOUNT_MNEMONIC` then you can call the following to get that private key loaded into an account object:
+ * ```typescript
+ * const account = await getAccount('ACCOUNT', algod)
+ * ```
+ *
+ * If that code runs against LocalNet then a wallet called `ACCOUNT` will automatically be created with an account that is automatically funded with 1000 (default) ALGOs from the default LocalNet dispenser.
+ *
+ * @param account The details of the account to get, wither the name identifier (string) or an object with:
+ *   * `name`: The name identifier of the account
+ *   * `fundWith`: The amount to fund the account with it it gets created (when targeting LocalNet), if not specified then 1000 Algos will be funded from the dispenser account @see {getDispenserAccount}
+ * @param algod An algod client
+ * @param kmdClient An optional KMD client to use to create an account (when targeting LocalNet), if not specified then a default KMD client will be loaded from environment variables @see {getAlgoKmdClient}
+ * @returns The requested account with private key loaded from the environment variables or when targeting LocalNet from KMD (idempotently creating and funding the account)
+ */
+async function getAccount(account, algod, kmdClient) {
+    let name;
+    let fundWith = undefined;
+    if (typeof account === 'string') {
+        name = account;
+    }
+    else {
+        name = account.name;
+        fundWith = account.fundWith;
+    }
+    if (!process || !process.env) {
+        throw new Error('Attempt to get account with private key from a non Node.js context; not supported!');
+    }
+    const envKey = `${name.toUpperCase()}_MNEMONIC`;
+    if (process.env[envKey]) {
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        const signer = mnemonicAccount(process.env[envKey]);
+        const senderKey = `${name.toUpperCase()}_SENDER`;
+        if (process.env[senderKey]) {
+            _1.Config.logger.debug(`Using rekeyed account ${signer.addr} for sender ${process.env[senderKey]} for ${name} account`);
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            return new account_1.SigningAccount(signer, process.env[senderKey]);
+        }
+        else {
+            return signer;
+        }
+    }
+    if (await (0, network_client_1.isLocalNet)(algod)) {
+        const account = await (0, localnet_1.getOrCreateKmdWalletAccount)({ name, fundWith }, algod, kmdClient);
+        process.env[envKey] = algosdk_1.default.secretKeyToMnemonic(account.sk);
+        return account;
+    }
+    throw `Missing environment variable ${envKey} when looking for account ${name}`;
+}
+exports.getAccount = getAccount;
+/** Returns an account's address as a byte array
+ *
+ * @param account Either an account (with private key loaded) or the string address of an account
+ */
+function getAccountAddressAsUint8Array(account) {
+    return algosdk_1.default.decodeAddress(typeof account === 'string' ? account : account.addr).publicKey;
+}
+exports.getAccountAddressAsUint8Array = getAccountAddressAsUint8Array;
+/** Returns the string address of an Algorand account from a base64 encoded version of the underlying byte array of the address public key
+ *
+ * @param addressEncodedInB64 The base64 encoded version of the underlying byte array of the address public key
+ */
+function getAccountAddressAsString(addressEncodedInB64) {
+    return algosdk_1.default.encodeAddress(Buffer.from(addressEncodedInB64, 'base64'));
+}
+exports.getAccountAddressAsString = getAccountAddressAsString;
+/** Returns an account (with private key loaded) that can act as a dispenser
+ *
+ * If running on Sandbox then it will return the default dispenser account automatically,
+ *  otherwise it will load the account mnemonic stored in process.env.DISPENSER_MNEMONIC @see {getAccount}
+ *
+ * @param algod An algod client
+ * @param kmd A KMD client, if not specified then a default KMD client will be loaded from environment variables @see {getAlgoKmdClient}
+ */
+async function getDispenserAccount(algod, kmd) {
+    // If we are running against a sandbox we can use the default account within it, otherwise use an automation account specified via environment variables and ensure it's populated with ALGOs
+    const canFundFromDefaultAccount = await (0, network_client_1.isLocalNet)(algod);
+    return canFundFromDefaultAccount ? await (0, localnet_1.getLocalNetDispenserAccount)(algod, kmd) : await getAccount(account_1.DISPENSER_ACCOUNT, algod);
+}
+exports.getDispenserAccount = getDispenserAccount;
+//# sourceMappingURL=account.js.map

package/account.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"account.js","sourceRoot":"","sources":["../src/account.ts"],"names":[],"mappings":";;;;;;AAAA,sDAA6F;AAC7F,yBAA2B;AAC3B,yCAAqF;AACrF,qDAA6C;AAC7C,6CAA8G;AAG9G;;;;;GAKG;AACH,SAAgB,eAAe,CAAC,cAAgC,EAAE,eAA6C;IAC7G,OAAO,IAAI,yBAAe,CAAC,cAAc,EAAE,eAAe,CAAC,CAAA;AAC7D,CAAC;AAFD,0CAEC;AAED;;;;;GAKG;AACH,SAAgB,cAAc,CAAC,OAAgB,EAAE,MAAc;IAC7D,OAAO,IAAI,wBAAc,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;AAC5C,CAAC;AAFD,wCAEC;AAED;;;;;GAKG;AACH,SAAgB,wBAAwB,CAAC,MAAyB,EAAE,MAAc;IAChF,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,CAAA;AACjC,CAAC;AAFD,4DAEC;AAED;;;;;;GAMG;AACH,SAAgB,eAAe,CAAC,cAAsB;IACpD,iGAAiG;IACjG,OAAO,iBAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAA;AACpD,CAAC;AAHD,0CAGC;AAED;;;;GAIG;AACH,SAAgB,aAAa;IAC3B,iGAAiG;IACjG,OAAO,iBAAO,CAAC,eAAe,EAAE,CAAA;AAClC,CAAC;AAHD,sCAGC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACI,KAAK,UAAU,UAAU,CAC9B,OAAyD,EACzD,KAAc,EACd,SAAe;IAEf,IAAI,IAAY,CAAA;IAChB,IAAI,QAAQ,GAA2B,SAAS,CAAA;IAChD,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;QAC/B,IAAI,GAAG,OAAO,CAAA;KACf;SAAM;QACL,IAAI,GAAG,OAAO,CAAC,IAAI,CAAA;QACnB,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAA;KAC5B;IAED,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE;QAC5B,MAAM,IAAI,KAAK,CAAC,oFAAoF,CAAC,CAAA;KACtG;IAED,MAAM,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,EAAE,WAAW,CAAA;IAC/C,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;QACvB,oEAAoE;QACpE,MAAM,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAE,CAAC,CAAA;QACpD,MAAM,SAAS,GAAG,GAAG,IAAI,CAAC,WAAW,EAAE,SAAS,CAAA;QAChD,IAAI,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE;YAC1B,SAAM,CAAC,MAAM,CAAC,KAAK,CAAC,yBAAyB,MAAM,CAAC,IAAI,eAAe,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,QAAQ,IAAI,UAAU,CAAC,CAAA;YACpH,oEAAoE;YACpE,OAAO,IAAI,wBAAc,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,SAAS,CAAE,CAAC,CAAA;SAC3D;aAAM;YACL,OAAO,MAAM,CAAA;SACd;KACF;IAED,IAAI,MAAM,IAAA,2BAAU,EAAC,KAAK,CAAC,EAAE;QAC3B,MAAM,OAAO,GAAG,MAAM,IAAA,sCAA2B,EAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,SAAS,CAAC,CAAA;QACvF,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,iBAAO,CAAC,mBAAmB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;QAC7D,OAAO,OAAO,CAAA;KACf;IAED,MAAM,gCAAgC,MAAM,6BAA6B,IAAI,EAAE,CAAA;AACjF,CAAC;AAvCD,gCAuCC;AAED;;;GAGG;AACH,SAAgB,6BAA6B,CAAC,OAAyB;IACrE,OAAO,iBAAO,CAAC,aAAa,CAAC,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,SAAS,CAAA;AAC9F,CAAC;AAFD,sEAEC;AAED;;;GAGG;AACH,SAAgB,yBAAyB,CAAC,mBAA2B;IACnE,OAAO,iBAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,mBAAmB,EAAE,QAAQ,CAAC,CAAC,CAAA;AAC1E,CAAC;AAFD,8DAEC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,mBAAmB,CAAC,KAAc,EAAE,GAAS;IACjE,6LAA6L;IAC7L,MAAM,yBAAyB,GAAG,MAAM,IAAA,2BAAU,EAAC,KAAK,CAAC,CAAA;IACzD,OAAO,yBAAyB,CAAC,CAAC,CAAC,MAAM,IAAA,sCAA2B,EAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,UAAU,CAAC,2BAAiB,EAAE,KAAK,CAAC,CAAA;AAC/H,CAAC;AAJD,kDAIC"}

package/amount.d.ts

@@ -0,0 +1,8 @@
+import { AlgoAmount } from './types/amount';
+/** Returns an amount of Algos using @see AlgoAmount */
+export declare const algos: (algos: number) => AlgoAmount;
+/** Returns an amount of µAlgos using @see AlgoAmount */
+export declare const microAlgos: (microAlgos: number) => AlgoAmount;
+/** Returns an amount of µAlgos to cover standard fees for the given number of transactions using @see AlgoAmount */
+export declare const transactionFees: (numberOfTransactions: number) => AlgoAmount;
+//# sourceMappingURL=amount.d.ts.map

package/amount.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"amount.d.ts","sourceRoot":"","sources":["../src/amount.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAE3C,uDAAuD;AACvD,eAAO,MAAM,KAAK,UAAW,MAAM,eAElC,CAAA;AAED,wDAAwD;AACxD,eAAO,MAAM,UAAU,eAAgB,MAAM,eAE5C,CAAA;AAED,oHAAoH;AACpH,eAAO,MAAM,eAAe,yBAA0B,MAAM,eAE3D,CAAA"}

package/amount.js

@@ -0,0 +1,24 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transactionFees = exports.microAlgos = exports.algos = void 0;
+const algosdk_1 = __importDefault(require("algosdk"));
+const amount_1 = require("./types/amount");
+/** Returns an amount of Algos using @see AlgoAmount */
+const algos = (algos) => {
+    return amount_1.AlgoAmount.Algos(algos);
+};
+exports.algos = algos;
+/** Returns an amount of µAlgos using @see AlgoAmount */
+const microAlgos = (microAlgos) => {
+    return amount_1.AlgoAmount.MicroAlgos(microAlgos);
+};
+exports.microAlgos = microAlgos;
+/** Returns an amount of µAlgos to cover standard fees for the given number of transactions using @see AlgoAmount */
+const transactionFees = (numberOfTransactions) => {
+    return amount_1.AlgoAmount.MicroAlgos(numberOfTransactions * algosdk_1.default.ALGORAND_MIN_TX_FEE);
+};
+exports.transactionFees = transactionFees;
+//# sourceMappingURL=amount.js.map

package/amount.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"amount.js","sourceRoot":"","sources":["../src/amount.ts"],"names":[],"mappings":";;;;;;AAAA,sDAA6B;AAC7B,2CAA2C;AAE3C,uDAAuD;AAChD,MAAM,KAAK,GAAG,CAAC,KAAa,EAAE,EAAE;IACrC,OAAO,mBAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;AAChC,CAAC,CAAA;AAFY,QAAA,KAAK,SAEjB;AAED,wDAAwD;AACjD,MAAM,UAAU,GAAG,CAAC,UAAkB,EAAE,EAAE;IAC/C,OAAO,mBAAU,CAAC,UAAU,CAAC,UAAU,CAAC,CAAA;AAC1C,CAAC,CAAA;AAFY,QAAA,UAAU,cAEtB;AAED,oHAAoH;AAC7G,MAAM,eAAe,GAAG,CAAC,oBAA4B,EAAE,EAAE;IAC9D,OAAO,mBAAU,CAAC,UAAU,CAAC,oBAAoB,GAAG,iBAAO,CAAC,mBAAmB,CAAC,CAAA;AAClF,CAAC,CAAA;AAFY,QAAA,eAAe,mBAE3B"}

package/app.d.ts

@@ -0,0 +1,108 @@
+import algosdk, { ABIValue, Algodv2 } from 'algosdk';
+import { ApplicationResponse, EvalDelta, PendingTransactionResponse, TealValue } from './types/algod';
+import { ABIReturn, AppCallArgs, AppCallParams, AppCallTransactionResult, AppCompilationResult, AppReference, AppState, BoxName, BoxValueRequestParams, BoxValuesRequestParams, CompiledTeal, CreateAppParams, UpdateAppParams } from './types/app';
+import { SendTransactionFrom } from './types/transaction';
+/**
+ * Creates a smart contract app, returns the details of the created app.
+ * @param create The parameters to create the app with
+ * @param algod An algod client
+ * @returns The details of the created app, or the transaction to create it if `skipSending`
+ */
+export declare function createApp(create: CreateAppParams, algod: Algodv2): Promise<Partial<AppCompilationResult> & AppCallTransactionResult & AppReference>;
+/**
+ * Updates a smart contract app.
+ * @param update The parameters to update the app with
+ * @param algod An algod client
+ * @returns The transaction
+ */
+export declare function updateApp(update: UpdateAppParams, algod: Algodv2): Promise<Partial<AppCompilationResult> & AppCallTransactionResult>;
+/**
+ * Issues a call to a given app.
+ * @param call The call details.
+ * @param algod An algod client
+ * @returns The result of the call
+ */
+export declare function callApp(call: AppCallParams, algod: Algodv2): Promise<AppCallTransactionResult>;
+export declare function getABIReturn(args?: AppCallArgs, confirmation?: PendingTransactionResponse): ABIReturn | undefined;
+/**
+ * Returns the current global state values for the given app ID
+ * @param appId The ID of the app return global state for
+ * @param algod An algod client instance
+ * @returns The current global state
+ */
+export declare function getAppGlobalState(appId: number, algod: Algodv2): Promise<AppState>;
+/**
+ * Returns the current global state values for the given app ID and account
+ * @param appId The ID of the app return global state for
+ * @param account Either the string address of an account or an account object for the account to get local state for the given app
+ * @param algod An algod client instance
+ * @returns The current local state for the given (app, account) combination
+ */
+export declare function getAppLocalState(appId: number, account: string | SendTransactionFrom, algod: Algodv2): Promise<AppState>;
+/**
+ * Returns the names of the boxes for the given app.
+ * @param appId The ID of the app return box names for
+ * @param algod An algod client instance
+ * @returns The current box names
+ */
+export declare function getAppBoxNames(appId: number, algod: Algodv2): Promise<BoxName[]>;
+/**
+ * Returns the value of the given box name for the given app.
+ * @param appId The ID of the app return box names for
+ * @param boxName The name of the box to return either as a string, binary array or @see BoxName
+ * @param algod An algod client instance
+ * @returns The current box value as a byte array
+ */
+export declare function getAppBoxValue(appId: number, boxName: string | Uint8Array | BoxName, algod: Algodv2): Promise<Uint8Array>;
+/**
+ * Returns the value of the given box names for the given app.
+ * @param appId The ID of the app return box names for
+ * @param boxNames The names of the boxes to return either as a string, binary array or @see BoxName
+ * @param algod An algod client instance
+ * @returns The current box values as a byte array in the same order as the passed in box names
+ */
+export declare function getAppBoxValues(appId: number, boxNames: (string | Uint8Array | BoxName)[], algod: Algodv2): Promise<Uint8Array[]>;
+/**
+ * Returns the value of the given box name for the given app decoded based on the given ABI type.
+ * @param request The parameters for the box value request
+ * @param algod An algod client instance
+ * @returns The current box value as an ABI value
+ */
+export declare function getAppBoxValueFromABIType(request: BoxValueRequestParams, algod: Algodv2): Promise<ABIValue>;
+/**
+ * Returns the value of the given box names for the given app decoded based on the given ABI type.
+ * @param request The parameters for the box value request
+ * @param algod An algod client instance
+ * @returns The current box values as an ABI value in the same order as the passed in box names
+ */
+export declare function getAppBoxValuesFromABIType(request: BoxValuesRequestParams, algod: Algodv2): Promise<ABIValue[]>;
+export declare function decodeAppState(state: {
+    key: string;
+    value: TealValue | EvalDelta;
+}[]): AppState;
+/** Returns the app args ready to load onto an app @see {Transaction} object */
+export declare function getAppArgsForTransaction(args?: AppCallArgs): {
+    accounts: string[] | undefined;
+    appArgs: Uint8Array[] | undefined;
+    boxes: algosdk.BoxReference[] | undefined;
+    foreignApps: number[] | undefined;
+    foreignAssets: number[] | undefined;
+    lease: Uint8Array | undefined;
+} | undefined;
+/**
+ * Gets the current data for the given app from algod.
+ *
+ * @param appId The id of the app
+ * @param algod An algod client
+ * @returns The data about the app
+ */
+export declare function getAppByIndex(appId: number, algod: Algodv2): Promise<ApplicationResponse>;
+/**
+ * Compiles the given TEAL using algod and returns the result.
+ *
+ * @param algod An algod client
+ * @param tealCode The TEAL code
+ * @returns The information about the compiled file
+ */
+export declare function compileTeal(tealCode: string, algod: Algodv2): Promise<CompiledTeal>;
+//# sourceMappingURL=app.d.ts.map

package/app.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,EAAE,EAEd,QAAQ,EACR,OAAO,EAMR,MAAM,SAAS,CAAA;AAIhB,OAAO,EAAE,mBAAmB,EAAE,SAAS,EAAE,0BAA0B,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AACrG,OAAO,EACL,SAAS,EAET,WAAW,EACX,aAAa,EACb,wBAAwB,EACxB,oBAAoB,EACpB,YAAY,EACZ,QAAQ,EAER,OAAO,EACP,qBAAqB,EACrB,sBAAsB,EACtB,YAAY,EACZ,eAAe,EACf,eAAe,EAChB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAEzD;;;;;GAKG;AACH,wBAAsB,SAAS,CAC7B,MAAM,EAAE,eAAe,EACvB,KAAK,EAAE,OAAO,GACb,OAAO,CAAC,OAAO,CAAC,oBAAoB,CAAC,GAAG,wBAAwB,GAAG,YAAY,CAAC,CA2ClF;AAED;;;;;GAKG;AACH,wBAAsB,SAAS,CAC7B,MAAM,EAAE,eAAe,EACvB,KAAK,EAAE,OAAO,GACb,OAAO,CAAC,OAAO,CAAC,oBAAoB,CAAC,GAAG,wBAAwB,CAAC,CA6BnE;AAED;;;;;GAKG;AACH,wBAAsB,OAAO,CAAC,IAAI,EAAE,aAAa,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAqCpG;AAED,wBAAgB,YAAY,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,YAAY,CAAC,EAAE,0BAA0B,GAAG,SAAS,GAAG,SAAS,CA6BjH;AAED;;;;;GAKG;AACH,wBAAsB,iBAAiB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,qBAQpE;AAED;;;;;;GAMG;AACH,wBAAsB,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,mBAAmB,EAAE,KAAK,EAAE,OAAO,qBAS1G;AAED;;;;;GAKG;AACH,wBAAsB,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,CAStF;AAED;;;;;;GAMG;AACH,wBAAsB,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,UAAU,GAAG,OAAO,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,CAI/H;AAED;;;;;;GAMG;AACH,wBAAsB,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,MAAM,GAAG,UAAU,GAAG,OAAO,CAAC,EAAE,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAEvI;AAED;;;;;GAKG;AACH,wBAAsB,yBAAyB,CAAC,OAAO,EAAE,qBAAqB,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,CAIjH;AAED;;;;;GAKG;AACH,wBAAsB,0BAA0B,CAAC,OAAO,EAAE,sBAAsB,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAGrH;AAID,wBAAgB,cAAc,CAAC,KAAK,EAAE;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,SAAS,GAAG,SAAS,CAAA;CAAE,EAAE,GAAG,QAAQ,CAwC/F;AAED,+EAA+E;AAC/E,wBAAgB,wBAAwB,CAAC,IAAI,CAAC,EAAE,WAAW;;;;;;;cA4E1D;AAED;;;;;;GAMG;AACH,wBAAsB,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,gCAEhE;AAED;;;;;;GAMG;AACH,wBAAsB,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC,CASzF"}