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

package/README.md

@@ -0,0 +1,38 @@
+# AlgoKit TypeScript Utilities
+
+A set of core Algorand utilities written in TypeScript and released via npm that make it easier to build solutions on Algorand. This project is part of [AlgoKit](https://github.com/algorandfoundation/algokit-cli).
+
+The goal of this library is to provide intuitive, productive utility functions that make it easier, quicker and safer to build applications on Algorand. Largely these functions wrap the underlying Algorand SDK, but provide a higher level interface with sensible defaults and capabilities for common tasks.
+
+Note: If you prefer Python there's an equivalent [Python utility library](https://github.com/algorandfoundation/algokit-utils-py).
+
+[Install](#install) | [Documentation](docs/README.md)
+
+## Install
+
+This library can be installed from NPM using your favourite npm client, e.g.:
+
+```
+npm install @algorandfoundation/algokit-utils
+```
+
+## Guiding principles
+
+This library follows the [Guiding Principles of AlgoKit](https://github.com/algorandfoundation/algokit-cli/docs/algokit.md#guiding-principles).
+
+## Contributing
+
+This is an open source project managed by the Algorand Foundation. See the [AlgoKit contributing page](https://github.com/algorandfoundation/algokit-cli/blob/main/CONTRIBUTING.MD) to learn about making improvements.
+
+To successfully run the tests in this repository you need to be running LocalNet via [AlgoKit](https://github.com/algorandfoundation/algokit-cli) and also have package dependencies and `.env.template` copied to `.env` (both of which `algokit bootstrap all` can do for you):
+
+```
+algokit bootstrap all
+algokit localnet start
+```
+
+To run tests you can use VS Code, or:
+
+```
+npm run test
+```

package/account.d.ts

@@ -1,10 +1,28 @@
-import algosdk, { Account, Algodv2, Kmd } from 'algosdk';
-import { AlgoAmount } from './algo-amount';
-import { SigningAccount } from './transaction';
+import algosdk, { Account, Algodv2, Kmd, MultisigMetadata, TransactionSigner } from 'algosdk';
+import { MultisigAccount, SigningAccount, TransactionSignerAccount } from './types/account';
+import { AlgoAmount } from './types/amount';
+import { SendTransactionFrom } from './types/transaction';
 /**
- * The account name identifier used for fund dispensing in test environments
+ * 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 const DISPENSER_ACCOUNT = "DISPENSER";
+export declare function multisigAccount(multisigParams: MultisigMetadata, signingAccounts: (Account | SigningAccount)[]): MultisigAccount;
+/**
+ * Returns an account wrapper that supports a rekeyed account.
+ * @param signer 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 SigningAccount wrapper
+ */
+export declare function rekeyedAccount(signer: 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 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.
@@ -12,24 +30,30 @@ export declare const DISPENSER_ACCOUNT = "DISPENSER";
  * @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 getAccountFromMnemonic(mnemonicSecret: string): Account;
+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**,
+ * * **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
+ *   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)
  * ```
  *
@@ -37,39 +61,20 @@ export declare function getAccountFromMnemonic(mnemonicSecret: string): Account;
  *
  * @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}
+ *   * `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
  * @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}
+ * @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
  * @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>;
-/**
- * Parameters for the getTestAccount function.
- */
-interface GetTestAccountParams {
-    /** Initial funds to ensure the account has */
-    initialFunds: AlgoAmount;
-    /** Whether to suppress the log (which includes a mnemonic) or not (default: do not supress the log) */
-    suppressLog?: boolean;
-}
-/**
- * Creates an ephemeral Algorand account for the purposes of testing.
- * Returns a newly created random test account that is funded from the dispenser @see {getDispenserAccount}
- * DO NOT USE THIS TO CREATE A MAINNET ACCOUNT!
- * Note: By default this will log the mnemonic of the account.
- * @param param0 The config for the test account to generate
- * @param algod An algod client
- * @returns The account, with private key loaded
- */
-export declare function getTestAccount({ suppressLog, initialFunds }: GetTestAccountParams, algod: Algodv2): Promise<Account>;
 /** 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;
+export declare function getAccountAddressAsUint8Array(account: SendTransactionFrom | 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
@@ -77,11 +82,11 @@ export declare function getAccountAddressAsUint8Array(account: Account | string)
 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}
+ * If running on LocalNet then it will return the default dispenser account automatically,
+ *  otherwise it will load the account mnemonic stored in process.env.DISPENSER_MNEMONIC
  *
  * @param algod An algod client
+ * @param kmd A KMD client, if not specified then a default KMD client will be loaded from environment variables
  */
-export declare function getDispenserAccount(algod: Algodv2): Promise<algosdk.Account | SigningAccount>;
-export {};
+export declare function getDispenserAccount(algod: Algodv2, kmd?: Kmd): Promise<algosdk.Account | SigningAccount>;
 //# sourceMappingURL=account.d.ts.map

package/account.d.ts.map

@@ -1 +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,MAAM,SAAS,CAAA;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAI1C,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAG9C;;GAEG;AACH,eAAO,MAAM,iBAAiB,cAAc,CAAA;AAE5C;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAGtE;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;;GAEG;AACH,UAAU,oBAAoB;IAC5B,8CAA8C;IAC9C,YAAY,EAAE,UAAU,CAAA;IACxB,uGAAuG;IACvG,WAAW,CAAC,EAAE,OAAO,CAAA;CACtB;AAED;;;;;;;;GAQG;AACH,wBAAsB,cAAc,CAAC,EAAE,WAAW,EAAE,YAAY,EAAE,EAAE,oBAAoB,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAmB1H;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;;;;;;GAMG;AACH,wBAAsB,mBAAmB,CAAC,KAAK,EAAE,OAAO,6CAIvD"}
+{"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;AAK7F,OAAO,EAAqB,eAAe,EAAE,cAAc,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAA;AAC9G,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAC3C,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAEzD;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,cAAc,EAAE,gBAAgB,EAAE,eAAe,EAAE,CAAC,OAAO,GAAG,cAAc,CAAC,EAAE,mBAE9G;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,kBAE7D;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,mBAAmB,GAAG,MAAM,cAElF;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

@@ -3,17 +3,43 @@ 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.getTestAccount = exports.getAccount = exports.getAccountFromMnemonic = exports.DISPENSER_ACCOUNT = void 0;
+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 config_1 = require("./config");
+const _1 = require("./");
 const localnet_1 = require("./localnet");
 const network_client_1 = require("./network-client");
 const transaction_1 = require("./transaction");
-const transfer_1 = require("./transfer");
+const account_1 = require("./types/account");
 /**
- * The account name identifier used for fund dispensing in test environments
+ * 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
  */
-exports.DISPENSER_ACCOUNT = 'DISPENSER';
+function multisigAccount(multisigParams, signingAccounts) {
+    return new account_1.MultisigAccount(multisigParams, signingAccounts);
+}
+exports.multisigAccount = multisigAccount;
+/**
+ * Returns an account wrapper that supports a rekeyed account.
+ * @param signer 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 SigningAccount wrapper
+ */
+function rekeyedAccount(signer, sender) {
+    return new account_1.SigningAccount(signer, 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 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.
@@ -21,28 +47,38 @@ exports.DISPENSER_ACCOUNT = 'DISPENSER';
  * @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 getAccountFromMnemonic(mnemonicSecret) {
+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.getAccountFromMnemonic = getAccountFromMnemonic;
+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**,
+ * * **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
+ *   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)
  * ```
  *
@@ -50,9 +86,9 @@ exports.getAccountFromMnemonic = getAccountFromMnemonic;
  *
  * @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}
+ *   * `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
  * @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}
+ * @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
  * @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) {
@@ -71,12 +107,12 @@ async function getAccount(account, algod, kmdClient) {
     const envKey = `${name.toUpperCase()}_MNEMONIC`;
     if (process.env[envKey]) {
         // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        const signer = getAccountFromMnemonic(process.env[envKey]);
+        const signer = mnemonicAccount(process.env[envKey]);
         const senderKey = `${name.toUpperCase()}_SENDER`;
         if (process.env[senderKey]) {
-            config_1.AlgoKitConfig.logger.debug(`Using rekeyed account ${signer.addr} for sender ${process.env[senderKey]} for ${name} account`);
+            _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 transaction_1.SigningAccount(signer, process.env[senderKey]);
+            return new account_1.SigningAccount(signer, process.env[senderKey]);
         }
         else {
             return signer;
@@ -90,34 +126,12 @@ async function getAccount(account, algod, kmdClient) {
     throw `Missing environment variable ${envKey} when looking for account ${name}`;
 }
 exports.getAccount = getAccount;
-/**
- * Creates an ephemeral Algorand account for the purposes of testing.
- * Returns a newly created random test account that is funded from the dispenser @see {getDispenserAccount}
- * DO NOT USE THIS TO CREATE A MAINNET ACCOUNT!
- * Note: By default this will log the mnemonic of the account.
- * @param param0 The config for the test account to generate
- * @param algod An algod client
- * @returns The account, with private key loaded
- */
-async function getTestAccount({ suppressLog, initialFunds }, algod) {
-    const account = algosdk_1.default.generateAccount();
-    config_1.AlgoKitConfig.getLogger(suppressLog).info(`New test account created with address '${account.addr}' and mnemonic '${algosdk_1.default.secretKeyToMnemonic(account.sk)}'.`);
-    // If we are running against LocalNet 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);
-    const dispenser = canFundFromDefaultAccount ? await (0, localnet_1.getLocalNetDispenserAccount)(algod) : await getAccount(exports.DISPENSER_ACCOUNT, algod);
-    await (0, transfer_1.transferAlgos)({ from: dispenser, to: account.addr, amount: initialFunds, note: 'Funding test account', suppressLog }, algod);
-    const accountInfo = await algod.accountInformation(account.addr).do();
-    config_1.AlgoKitConfig.getLogger(suppressLog).info('Test account funded; account balance: %d µAlgos', accountInfo.amount);
-    return account;
-}
-exports.getTestAccount = getTestAccount;
 /** 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;
+    return algosdk_1.default.decodeAddress(typeof account === 'string' ? account : (0, transaction_1.getSenderAddress)(account)).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
@@ -130,15 +144,16 @@ function getAccountAddressAsString(addressEncodedInB64) {
 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}
+ * If running on LocalNet then it will return the default dispenser account automatically,
+ *  otherwise it will load the account mnemonic stored in process.env.DISPENSER_MNEMONIC
  *
  * @param algod An algod client
+ * @param kmd A KMD client, if not specified then a default KMD client will be loaded from environment variables
  */
-async function getDispenserAccount(algod) {
-    // 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
+async function getDispenserAccount(algod, kmd) {
+    // If we are running against LocalNet 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) : await getAccount(exports.DISPENSER_ACCOUNT, 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

@@ -1 +1 @@
-{"version":3,"file":"account.js","sourceRoot":"","sources":["../src/account.ts"],"names":[],"mappings":";;;;;;AAAA,sDAAwD;AAExD,qCAAwC;AACxC,yCAAqF;AACrF,qDAA6C;AAC7C,+CAA8C;AAC9C,yCAA0C;AAE1C;;GAEG;AACU,QAAA,iBAAiB,GAAG,WAAW,CAAA;AAE5C;;;;;;GAMG;AACH,SAAgB,sBAAsB,CAAC,cAAsB;IAC3D,iGAAiG;IACjG,OAAO,iBAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAA;AACpD,CAAC;AAHD,wDAGC;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,sBAAsB,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAE,CAAC,CAAA;QAC3D,MAAM,SAAS,GAAG,GAAG,IAAI,CAAC,WAAW,EAAE,SAAS,CAAA;QAChD,IAAI,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE;YAC1B,sBAAa,CAAC,MAAM,CAAC,KAAK,CAAC,yBAAyB,MAAM,CAAC,IAAI,eAAe,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,QAAQ,IAAI,UAAU,CAAC,CAAA;YAC3H,oEAAoE;YACpE,OAAO,IAAI,4BAAc,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;AAYD;;;;;;;;GAQG;AACI,KAAK,UAAU,cAAc,CAAC,EAAE,WAAW,EAAE,YAAY,EAAwB,EAAE,KAAc;IACtG,MAAM,OAAO,GAAG,iBAAO,CAAC,eAAe,EAAE,CAAA;IAEzC,sBAAa,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,IAAI,CACvC,0CAA0C,OAAO,CAAC,IAAI,mBAAmB,iBAAO,CAAC,mBAAmB,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CACrH,CAAA;IAED,8EAA8E;IAC9E,iHAAiH;IACjH,MAAM,yBAAyB,GAAG,MAAM,IAAA,2BAAU,EAAC,KAAK,CAAC,CAAA;IACzD,MAAM,SAAS,GAAG,yBAAyB,CAAC,CAAC,CAAC,MAAM,IAAA,sCAA2B,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,UAAU,CAAC,yBAAiB,EAAE,KAAK,CAAC,CAAA;IAEnI,MAAM,IAAA,wBAAa,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,sBAAsB,EAAE,WAAW,EAAE,EAAE,KAAK,CAAC,CAAA;IAElI,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,kBAAkB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,CAAA;IAErE,sBAAa,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,iDAAiD,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAEhH,OAAO,OAAO,CAAA;AAChB,CAAC;AAnBD,wCAmBC;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;;;;;;GAMG;AACI,KAAK,UAAU,mBAAmB,CAAC,KAAc;IACtD,6LAA6L;IAC7L,MAAM,yBAAyB,GAAG,MAAM,IAAA,2BAAU,EAAC,KAAK,CAAC,CAAA;IACzD,OAAO,yBAAyB,CAAC,CAAC,CAAC,MAAM,IAAA,sCAA2B,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,UAAU,CAAC,yBAAiB,EAAE,KAAK,CAAC,CAAA;AAC1H,CAAC;AAJD,kDAIC"}
+{"version":3,"file":"account.js","sourceRoot":"","sources":["../src/account.ts"],"names":[],"mappings":";;;;;;AAAA,sDAA6F;AAC7F,yBAA2B;AAC3B,yCAAqF;AACrF,qDAA6C;AAC7C,+CAAgD;AAChD,6CAA8G;AAI9G;;;;;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,MAAe,EAAE,MAAc;IAC5D,OAAO,IAAI,wBAAc,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;AAC3C,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,OAAqC;IACjF,OAAO,iBAAO,CAAC,aAAa,CAAC,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAA,8BAAgB,EAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAA;AAC3G,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,4LAA4L;IAC5L,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,20 @@
+import { AlgoAmount } from './types/amount';
+declare global {
+    interface Number {
+        microAlgos(this: number): AlgoAmount;
+        algos(this: number): AlgoAmount;
+    }
+}
+/** Returns an amount of Algos using AlgoAmount
+ * @param algos The amount in Algos
+ */
+export declare const algos: (algos: number) => AlgoAmount;
+/** Returns an amount of µAlgos using AlgoAmount
+ * @param microAlgos The amount in µAlgos
+ */
+export declare const microAlgos: (microAlgos: number) => AlgoAmount;
+/** Returns an amount of µAlgos to cover standard fees for the given number of transactions using AlgoAmount
+ * @param numberOfTransactions The of standard transaction fees to return the amount of ALGOs
+ */
+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,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,CAAA;QACpC,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,CAAA;KAChC;CACF;AAUD;;GAEG;AACH,eAAO,MAAM,KAAK,UAAW,MAAM,eAElC,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,UAAU,eAAgB,MAAM,eAE5C,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,eAAe,yBAA0B,MAAM,eAE3D,CAAA"}

package/amount.js

@@ -0,0 +1,36 @@
+"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");
+Number.prototype.microAlgos = function () {
+    return amount_1.AlgoAmount.MicroAlgos(this);
+};
+Number.prototype.algos = function () {
+    return amount_1.AlgoAmount.Algos(this);
+};
+/** Returns an amount of Algos using AlgoAmount
+ * @param algos The amount in Algos
+ */
+const algos = (algos) => {
+    return amount_1.AlgoAmount.Algos(algos);
+};
+exports.algos = algos;
+/** Returns an amount of µAlgos using AlgoAmount
+ * @param microAlgos The amount in µAlgos
+ */
+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 AlgoAmount
+ * @param numberOfTransactions The of standard transaction fees to return the amount of ALGOs
+ */
+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;AAS3C,MAAM,CAAC,SAAS,CAAC,UAAU,GAAG;IAC5B,OAAO,mBAAU,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;AACpC,CAAC,CAAA;AAED,MAAM,CAAC,SAAS,CAAC,KAAK,GAAG;IACvB,OAAO,mBAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;AAC/B,CAAC,CAAA;AAED;;GAEG;AACI,MAAM,KAAK,GAAG,CAAC,KAAa,EAAE,EAAE;IACrC,OAAO,mBAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;AAChC,CAAC,CAAA;AAFY,QAAA,KAAK,SAEjB;AAED;;GAEG;AACI,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;;GAEG;AACI,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-client.d.ts

@@ -0,0 +1,14 @@
+import { Algodv2 } from 'algosdk';
+import { ApplicationClient, AppSpecAppDetails } from './types/app-client';
+/**
+ * @deprecated Use `algokit.getAppClient`
+ */
+export declare const getApplicationClient: typeof getAppClient;
+/**
+ * Create a new ApplicationClient instance
+ * @param appDetails The details of the app
+ * @param algod An algod instance
+ * @returns The application client
+ */
+export declare function getAppClient(appDetails: AppSpecAppDetails, algod: Algodv2): ApplicationClient;
+//# sourceMappingURL=app-client.d.ts.map

package/app-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-client.d.ts","sourceRoot":"","sources":["../src/app-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AACjC,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAEzE;;GAEG;AACH,eAAO,MAAM,oBAAoB,qBAAe,CAAA;AAEhD;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,UAAU,EAAE,iBAAiB,EAAE,KAAK,EAAE,OAAO,qBAEzE"}

package/app-client.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAppClient = exports.getApplicationClient = void 0;
+const app_client_1 = require("./types/app-client");
+/**
+ * @deprecated Use `algokit.getAppClient`
+ */
+exports.getApplicationClient = getAppClient;
+/**
+ * Create a new ApplicationClient instance
+ * @param appDetails The details of the app
+ * @param algod An algod instance
+ * @returns The application client
+ */
+function getAppClient(appDetails, algod) {
+    return new app_client_1.ApplicationClient(appDetails, algod);
+}
+exports.getAppClient = getAppClient;
+//# sourceMappingURL=app-client.js.map

package/app-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-client.js","sourceRoot":"","sources":["../src/app-client.ts"],"names":[],"mappings":";;;AACA,mDAAyE;AAEzE;;GAEG;AACU,QAAA,oBAAoB,GAAG,YAAY,CAAA;AAEhD;;;;;GAKG;AACH,SAAgB,YAAY,CAAC,UAA6B,EAAE,KAAc;IACxE,OAAO,IAAI,8BAAiB,CAAC,UAAU,EAAE,KAAK,CAAC,CAAA;AACjD,CAAC;AAFD,oCAEC"}

package/app-deploy.d.ts

@@ -0,0 +1,95 @@
+import { Algodv2, Indexer } from 'algosdk';
+import { ApplicationStateSchema } from './types/algod';
+import { ABIReturn, AppCompilationResult, AppDeploymentParams, AppDeployMetadata, AppLookup, AppMetadata, CompiledTeal, TealTemplateParams } from './types/app';
+import { Arc2TransactionNote, ConfirmedTransactionResult, ConfirmedTransactionResults, SendTransactionFrom } from './types/transaction';
+/**
+ * Idempotently deploy (create, update/delete if changed) an app against the given name via the given creator account, including deploy-time template placeholder substitutions.
+ *
+ * To understand the architecture decisions behind this functionality please see https://github.com/algorandfoundation/algokit-cli/blob/main/docs/architecture-decisions/2023-01-12_smart-contract-deployment.md
+ *
+ * **Note:** When using the return from this function be sure to check `operationPerformed` to get access to various return properties like `transaction`, `confirmation` and `deleteResult`.
+ *
+ * **Note:** if there is a breaking state schema change to an existing app (and `onSchemaBreak` is set to `'replace'`) the existing app will be deleted and re-created.
+ *
+ * **Note:** if there is an update (different TEAL code) to an existing app (and `onUpdate` is set to `'replace'`) the existing app will be deleted and re-created.
+ * @param deployment The arguments to control the app deployment
+ * @param algod An algod client
+ * @param indexer An indexer client, needed if `existingDeployments` not passed in
+ * @returns The app reference of the new/existing app
+ */
+export declare function deployApp(deployment: AppDeploymentParams, algod: Algodv2, indexer?: Indexer): Promise<Partial<AppCompilationResult> & ((ConfirmedTransactionResults & AppMetadata & {
+    return?: ABIReturn;
+    operationPerformed: 'create' | 'update';
+}) | (ConfirmedTransactionResults & AppMetadata & {
+    return?: ABIReturn;
+    deleteReturn?: ABIReturn;
+    deleteResult: ConfirmedTransactionResult;
+    operationPerformed: 'replace';
+}) | (AppMetadata & {
+    operationPerformed: 'nothing';
+}))>;
+/** Returns true is there is a breaking change in the application state schema from before to after.
+ *  i.e. if the schema becomes larger, since applications can't ask for more schema after creation.
+ *  Otherwise, there is no error, the app just doesn't store data in the extra schema :(
+ *
+ * @param before The existing schema
+ * @param after The new schema
+ * @returns Whether or not there is a breaking change
+ */
+export declare function isSchemaIsBroken(before: ApplicationStateSchema, after: ApplicationStateSchema): boolean;
+/**
+ * Returns a lookup of name => app metadata (id, address, ...metadata) for all apps created by the given account that have an `AppDeployNote` in the transaction note of the creation transaction.
+ *
+ * **Note:** It's recommended this is only called once and then stored since it's a somewhat expensive operation (multiple indexer calls).
+ *
+ * @param creatorAccount The account (with private key loaded) or string address of an account that is the creator of the apps you want to search for
+ * @param indexer An indexer client
+ * @returns A name-based lookup of the app information (id, address)
+ */
+export declare function getCreatorAppsByName(creatorAccount: SendTransactionFrom | string, indexer: Indexer): Promise<AppLookup>;
+/**
+ * Return the transaction note for an app deployment.
+ * @param metadata The metadata of the deployment
+ * @returns The transaction note as a utf-8 string
+ */
+export declare function getAppDeploymentTransactionNote(metadata: AppDeployMetadata): Arc2TransactionNote;
+/**
+ * Replaces deploy-time deployment control parameters within the given teal code.
+ *
+ * * `TMPL_UPDATABLE` for updatability / immutability control
+ * * `TMPL_DELETABLE` for deletability / permanence control
+ *
+ * Note: If these values are not undefined, but the corresponding `TMPL_*` value
+ *  isn't in the teal code it will throw an exception.
+ *
+ * @param tealCode The TEAL code to substitute
+ * @param params The deploy-time deployment control parameter value to replace
+ * @returns The replaced TEAL code
+ */
+export declare function replaceDeployTimeControlParams(tealCode: string, params: {
+    updatable?: boolean;
+    deletable?: boolean;
+}): string;
+/**
+ * Performs template substitution of a teal file.
+ *
+ * Looks for `TMPL_{parameter}` for template replacements.
+ *
+ * @param tealCode The TEAL logic to compile
+ * @param templateParams Any parameters to replace in the .teal file before compiling
+ * @returns The TEAL code with replacements
+ */
+export declare function performTemplateSubstitution(tealCode: string, templateParams?: TealTemplateParams): string;
+/**
+ * Performs template substitution of a teal file and compiles it, returning the compiled result.
+ *
+ * Looks for `TMPL_{parameter}` for template replacements.
+ *
+ * @param tealCode The TEAL logic to compile
+ * @param algod An algod client
+ * @param templateParams Any parameters to replace in the .teal file before compiling
+ * @param deploymentMetadata The deployment metadata the app will be deployed with
+ * @returns The information about the compiled code
+ */
+export declare function performTemplateSubstitutionAndCompile(tealCode: string, algod: Algodv2, templateParams?: TealTemplateParams, deploymentMetadata?: AppDeployMetadata): Promise<CompiledTeal>;
+//# sourceMappingURL=app-deploy.d.ts.map

package/app-deploy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-deploy.d.ts","sourceRoot":"","sources":["../src/app-deploy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAoD,OAAO,EAAmB,MAAM,SAAS,CAAA;AAK7G,OAAO,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAA;AACtD,OAAO,EACL,SAAS,EACT,oBAAoB,EACpB,mBAAmB,EACnB,iBAAiB,EACjB,SAAS,EACT,WAAW,EAEX,YAAY,EAIZ,kBAAkB,EAEnB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,mBAAmB,EAAE,0BAA0B,EAAE,2BAA2B,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAEvI;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,SAAS,CAC7B,UAAU,EAAE,mBAAmB,EAC/B,KAAK,EAAE,OAAO,EACd,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CACR,OAAO,CAAC,oBAAoB,CAAC,GAC3B,CACI,CAAC,2BAA2B,GAAG,WAAW,GAAG;IAAE,MAAM,CAAC,EAAE,SAAS,CAAC;IAAC,kBAAkB,EAAE,QAAQ,GAAG,QAAQ,CAAA;CAAE,CAAC,GAC7G,CAAC,2BAA2B,GAC1B,WAAW,GAAG;IACZ,MAAM,CAAC,EAAE,SAAS,CAAA;IAClB,YAAY,CAAC,EAAE,SAAS,CAAA;IACxB,YAAY,EAAE,0BAA0B,CAAA;IACxC,kBAAkB,EAAE,SAAS,CAAA;CAC9B,CAAC,GACJ,CAAC,WAAW,GAAG;IAAE,kBAAkB,EAAE,SAAS,CAAA;CAAE,CAAC,CACpD,CACJ,CA2UA;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,sBAAsB,EAAE,KAAK,EAAE,sBAAsB,WAE7F;AAED;;;;;;;;GAQG;AACH,wBAAsB,oBAAoB,CAAC,cAAc,EAAE,mBAAmB,GAAG,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,CAoG7H;AAED;;;;GAIG;AACH,wBAAgB,+BAA+B,CAAC,QAAQ,EAAE,iBAAiB,GAAG,mBAAmB,CAMhG;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,8BAA8B,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE;IAAE,SAAS,CAAC,EAAE,OAAO,CAAC;IAAC,SAAS,CAAC,EAAE,OAAO,CAAA;CAAE,UAoBpH;AAED;;;;;;;;GAQG;AACH,wBAAgB,2BAA2B,CAAC,QAAQ,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,kBAAkB,UAiBhG;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,qCAAqC,CACzD,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,OAAO,EACd,cAAc,CAAC,EAAE,kBAAkB,EACnC,kBAAkB,CAAC,EAAE,iBAAiB,GACrC,OAAO,CAAC,YAAY,CAAC,CAQvB"}