@algorandfoundation/algokit-utils 6.1.0-beta.1 → 6.1.0-beta.3

package/types/kmd-account-manager.js

@@ -0,0 +1,144 @@
+'use strict';
+
+var algosdk = require('algosdk');
+var config = require('../config.js');
+var types_account = require('./account.js');
+var types_amount = require('./amount.js');
+var types_composer = require('./composer.js');
+
+/** Provides abstractions over a [KMD](https://github.com/algorand/go-algorand/blob/master/daemon/kmd/README.md) instance
+ * that makes it easier to get and manage accounts using KMD. */
+class KmdAccountManager {
+    /**
+     * Create a new KMD manager.
+     * @param clientManager A ClientManager client to use for algod and kmd clients
+     */
+    constructor(clientManager) {
+        this._clientManager = clientManager;
+    }
+    /**
+     * Returns an Algorand signing account with private key loaded from the given KMD wallet (identified by name).
+     *
+     * @param walletName The name of the wallet to retrieve an account from
+     * @param predicate An optional filter to use to find the account (otherwise it will return a random account from the wallet)
+     * @param sender The optional sender address to use this signer for (aka a rekeyed account)
+     * @example Get default funded account in a LocalNet
+     *
+     * ```typescript
+     * const defaultDispenserAccount = await kmdAccountManager.getWalletAccount(
+     *   'unencrypted-default-wallet',
+     *   a => a.status !== 'Offline' && a.amount > 1_000_000_000
+     * )
+     * ```
+     * @returns The signing account (with private key loaded) or undefined if no matching wallet or account was found
+     */
+    async getWalletAccount(walletName, 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    predicate, sender) {
+        const walletsResponse = await this._clientManager.kmd.listWallets();
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const wallet = walletsResponse.wallets.filter((w) => w.name === walletName);
+        if (wallet.length === 0) {
+            return undefined;
+        }
+        const walletId = wallet[0].id;
+        const walletHandle = (await this._clientManager.kmd.initWalletHandle(walletId, '')).wallet_handle_token;
+        const addresses = (await this._clientManager.kmd.listKeys(walletHandle)).addresses;
+        let i = 0;
+        if (predicate) {
+            for (i = 0; i < addresses.length; i++) {
+                const address = addresses[i];
+                const account = await this._clientManager.algod.accountInformation(address).do();
+                if (predicate(account)) {
+                    break;
+                }
+            }
+        }
+        if (i >= addresses.length) {
+            return undefined;
+        }
+        const accountKey = (await this._clientManager.kmd.exportKey(walletHandle, '', addresses[i])).private_key;
+        const accountMnemonic = algosdk.secretKeyToMnemonic(accountKey);
+        const account = algosdk.mnemonicToSecretKey(accountMnemonic);
+        const signingAccount = new types_account.SigningAccount(account, sender);
+        return {
+            account: signingAccount,
+            addr: signingAccount.addr,
+            signer: signingAccount.signer,
+        };
+    }
+    /**
+     * Gets an account with private key loaded from a KMD wallet of the given name, or alternatively creates one with funds in it via a KMD wallet of the given name.
+     *
+     * This is useful to get idempotent accounts from LocalNet without having to specify the private key (which will change when resetting the LocalNet).
+     *
+     * This significantly speeds up local dev time and improves experience since you can write code that *just works* first go without manual config in a fresh LocalNet.
+     *
+     * If this is used via `mnemonicAccountFromEnvironment`, then you can even use the same code that runs on production without changes for local development!
+     *
+     * @param name The name of the wallet to retrieve / create
+     * @param fundWith The number of Algos to fund the account with when it gets created, if not specified then 1000 Algos will be funded from the dispenser account
+     *
+     * @example
+     * ```typescript
+     * // Idempotently get (if exists) or crate (if it doesn't exist yet) an account by name using KMD
+     * // if creating it then fund it with 2 Algos from the default dispenser account
+     * const newAccount = await kmdAccountManager.getOrCreateWalletAccount('account1', (2).algos())
+     * // This will return the same account as above since the name matches
+     * const existingAccount = await kmdAccountManager.getOrCreateWalletAccount('account1')
+     * ```
+     *
+     * @returns An Algorand account with private key loaded - either one that already existed in the given KMD wallet, or a new one that is funded for you
+     */
+    async getOrCreateWalletAccount(name, fundWith) {
+        // Get an existing account from the KMD wallet
+        const existing = await this.getWalletAccount(name);
+        if (existing) {
+            return existing;
+        }
+        // None existed: create the KMD wallet instead
+        const walletId = (await this._clientManager.kmd.createWallet(name, '')).wallet.id;
+        const walletHandle = (await this._clientManager.kmd.initWalletHandle(walletId, '')).wallet_handle_token;
+        await this._clientManager.kmd.generateKey(walletHandle);
+        // Get the account from the new KMD wallet
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        const account = (await this.getWalletAccount(name));
+        config.Config.logger.info(`LocalNet account '${name}' doesn't yet exist; created account ${account.addr} with keys stored in KMD and funding with ${fundWith?.algos ?? 1000} ALGOs`);
+        // Fund the account from the dispenser
+        const dispenser = await this.getLocalNetDispenserAccount();
+        await new types_composer({
+            algod: this._clientManager.algod,
+            getSigner: () => dispenser.signer,
+            getSuggestedParams: () => this._clientManager.algod.getTransactionParams().do(),
+        })
+            .addPayment({
+            amount: fundWith ?? types_amount.AlgoAmount.Algos(1000),
+            receiver: account.addr,
+            sender: dispenser.addr,
+        })
+            .execute();
+        return account;
+    }
+    /**
+     * Returns an Algorand account with private key loaded for the default LocalNet dispenser account (that can be used to fund other accounts).
+     * @example
+     * ```typescript
+     * const dispenser = await kmdAccountManager.getLocalNetDispenserAccount()
+     * ```
+     * @returns The default LocalNet dispenser account
+     */
+    async getLocalNetDispenserAccount() {
+        if (!(await this._clientManager.isLocalNet())) {
+            throw new Error("Can't get LocalNet dispenser account from non LocalNet network");
+        }
+        const dispenser = await this.getWalletAccount('unencrypted-default-wallet', (a) => a.status !== 'Offline' && a.amount > 1000000000);
+        if (!dispenser) {
+            throw new Error("Error retrieving LocalNet dispenser account; couldn't find the default account in KMD");
+        }
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        return dispenser;
+    }
+}
+
+exports.KmdAccountManager = KmdAccountManager;
+//# sourceMappingURL=kmd-account-manager.js.map

package/types/kmd-account-manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"kmd-account-manager.js","sources":["../../src/types/kmd-account-manager.ts"],"sourcesContent":[null],"names":["SigningAccount","Config","AlgokitComposer","AlgoAmount"],"mappings":";;;;;;;;AAOA;AACgE;MACnD,iBAAiB,CAAA;AAG5B;;;AAGG;AACH,IAAA,WAAA,CAAY,aAA4B,EAAA;AACtC,QAAA,IAAI,CAAC,cAAc,GAAG,aAAa,CAAA;KACpC;AAED;;;;;;;;;;;;;;;AAeG;IACI,MAAM,gBAAgB,CAC3B,UAAkB;;AAElB,IAAA,SAAqD,EACrD,MAAe,EAAA;QAEf,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,WAAW,EAAE,CAAA;;AAGnE,QAAA,MAAM,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAM,KAAK,CAAC,CAAC,IAAI,KAAK,UAAU,CAAC,CAAA;AAChF,QAAA,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;AACvB,YAAA,OAAO,SAAS,CAAA;SACjB;QAED,MAAM,QAAQ,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;AAE7B,QAAA,MAAM,YAAY,GAAG,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,gBAAgB,CAAC,QAAQ,EAAE,EAAE,CAAC,EAAE,mBAAmB,CAAA;AACvG,QAAA,MAAM,SAAS,GAAG,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,SAAS,CAAA;QAElF,IAAI,CAAC,GAAG,CAAC,CAAA;QACT,IAAI,SAAS,EAAE;AACb,YAAA,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;AACrC,gBAAA,MAAM,OAAO,GAAG,SAAS,CAAC,CAAC,CAAC,CAAA;AAC5B,gBAAA,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,CAAA;AAChF,gBAAA,IAAI,SAAS,CAAC,OAAO,CAAC,EAAE;oBACtB,MAAK;iBACN;aACF;SACF;AAED,QAAA,IAAI,CAAC,IAAI,SAAS,CAAC,MAAM,EAAE;AACzB,YAAA,OAAO,SAAS,CAAA;SACjB;QAED,MAAM,UAAU,GAAG,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,YAAY,EAAE,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,WAAW,CAAA;QAExG,MAAM,eAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAA;QAE/D,MAAM,OAAO,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAA;QAC5D,MAAM,cAAc,GAAG,IAAIA,4BAAc,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;QAE1D,OAAO;AACL,YAAA,OAAO,EAAE,cAAc;YACvB,IAAI,EAAE,cAAc,CAAC,IAAI;YACzB,MAAM,EAAE,cAAc,CAAC,MAAM;SAC9B,CAAA;KACF;AAED;;;;;;;;;;;;;;;;;;;;;;AAsBG;AACI,IAAA,MAAM,wBAAwB,CACnC,IAAY,EACZ,QAAqB,EAAA;;QAGrB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAA;QAClD,IAAI,QAAQ,EAAE;AACZ,YAAA,OAAO,QAAQ,CAAA;SAChB;;QAGD,MAAM,QAAQ,GAAG,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,CAAA;AACjF,QAAA,MAAM,YAAY,GAAG,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,gBAAgB,CAAC,QAAQ,EAAE,EAAE,CAAC,EAAE,mBAAmB,CAAA;QACvG,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,WAAW,CAAC,YAAY,CAAC,CAAA;;;QAIvD,MAAM,OAAO,IAAI,MAAM,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAE,CAAA;AAEpD,QAAAC,aAAM,CAAC,MAAM,CAAC,IAAI,CAChB,CAAA,kBAAA,EAAqB,IAAI,CAAwC,qCAAA,EAAA,OAAO,CAAC,IAAI,CAAA,0CAAA,EAC3E,QAAQ,EAAE,KAAK,IAAI,IACrB,CAAA,MAAA,CAAQ,CACT,CAAA;;AAGD,QAAA,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,2BAA2B,EAAE,CAAA;QAC1D,MAAM,IAAIC,cAAe,CAAC;AACxB,YAAA,KAAK,EAAE,IAAI,CAAC,cAAc,CAAC,KAAK;AAChC,YAAA,SAAS,EAAE,MAAM,SAAS,CAAC,MAAM;AACjC,YAAA,kBAAkB,EAAE,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,oBAAoB,EAAE,CAAC,EAAE,EAAE;SAChF,CAAC;AACC,aAAA,UAAU,CAAC;YACV,MAAM,EAAE,QAAQ,IAAIC,uBAAU,CAAC,KAAK,CAAC,IAAI,CAAC;YAC1C,QAAQ,EAAE,OAAO,CAAC,IAAI;YACtB,MAAM,EAAE,SAAS,CAAC,IAAI;SACvB,CAAC;AACD,aAAA,OAAO,EAAE,CAAA;AAEZ,QAAA,OAAO,OAAO,CAAA;KACf;AAED;;;;;;;AAOG;AACI,IAAA,MAAM,2BAA2B,GAAA;QACtC,IAAI,EAAE,MAAM,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE,CAAC,EAAE;AAC7C,YAAA,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAA;SAClF;QAED,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,4BAA4B,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,CAAC,MAAM,GAAG,UAAa,CAAC,CAAA;QACtI,IAAI,CAAC,SAAS,EAAE;AACd,YAAA,MAAM,IAAI,KAAK,CAAC,uFAAuF,CAAC,CAAA;SACzG;;AAGD,QAAA,OAAO,SAAS,CAAA;KACjB;AACF;;;;"}

package/types/kmd-account-manager.mjs

@@ -0,0 +1,142 @@
+import algosdk from 'algosdk';
+import { Config } from '../config.mjs';
+import { SigningAccount } from './account.mjs';
+import { AlgoAmount } from './amount.mjs';
+import AlgokitComposer from './composer.mjs';
+
+/** Provides abstractions over a [KMD](https://github.com/algorand/go-algorand/blob/master/daemon/kmd/README.md) instance
+ * that makes it easier to get and manage accounts using KMD. */
+class KmdAccountManager {
+    /**
+     * Create a new KMD manager.
+     * @param clientManager A ClientManager client to use for algod and kmd clients
+     */
+    constructor(clientManager) {
+        this._clientManager = clientManager;
+    }
+    /**
+     * Returns an Algorand signing account with private key loaded from the given KMD wallet (identified by name).
+     *
+     * @param walletName The name of the wallet to retrieve an account from
+     * @param predicate An optional filter to use to find the account (otherwise it will return a random account from the wallet)
+     * @param sender The optional sender address to use this signer for (aka a rekeyed account)
+     * @example Get default funded account in a LocalNet
+     *
+     * ```typescript
+     * const defaultDispenserAccount = await kmdAccountManager.getWalletAccount(
+     *   'unencrypted-default-wallet',
+     *   a => a.status !== 'Offline' && a.amount > 1_000_000_000
+     * )
+     * ```
+     * @returns The signing account (with private key loaded) or undefined if no matching wallet or account was found
+     */
+    async getWalletAccount(walletName, 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    predicate, sender) {
+        const walletsResponse = await this._clientManager.kmd.listWallets();
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const wallet = walletsResponse.wallets.filter((w) => w.name === walletName);
+        if (wallet.length === 0) {
+            return undefined;
+        }
+        const walletId = wallet[0].id;
+        const walletHandle = (await this._clientManager.kmd.initWalletHandle(walletId, '')).wallet_handle_token;
+        const addresses = (await this._clientManager.kmd.listKeys(walletHandle)).addresses;
+        let i = 0;
+        if (predicate) {
+            for (i = 0; i < addresses.length; i++) {
+                const address = addresses[i];
+                const account = await this._clientManager.algod.accountInformation(address).do();
+                if (predicate(account)) {
+                    break;
+                }
+            }
+        }
+        if (i >= addresses.length) {
+            return undefined;
+        }
+        const accountKey = (await this._clientManager.kmd.exportKey(walletHandle, '', addresses[i])).private_key;
+        const accountMnemonic = algosdk.secretKeyToMnemonic(accountKey);
+        const account = algosdk.mnemonicToSecretKey(accountMnemonic);
+        const signingAccount = new SigningAccount(account, sender);
+        return {
+            account: signingAccount,
+            addr: signingAccount.addr,
+            signer: signingAccount.signer,
+        };
+    }
+    /**
+     * Gets an account with private key loaded from a KMD wallet of the given name, or alternatively creates one with funds in it via a KMD wallet of the given name.
+     *
+     * This is useful to get idempotent accounts from LocalNet without having to specify the private key (which will change when resetting the LocalNet).
+     *
+     * This significantly speeds up local dev time and improves experience since you can write code that *just works* first go without manual config in a fresh LocalNet.
+     *
+     * If this is used via `mnemonicAccountFromEnvironment`, then you can even use the same code that runs on production without changes for local development!
+     *
+     * @param name The name of the wallet to retrieve / create
+     * @param fundWith The number of Algos to fund the account with when it gets created, if not specified then 1000 Algos will be funded from the dispenser account
+     *
+     * @example
+     * ```typescript
+     * // Idempotently get (if exists) or crate (if it doesn't exist yet) an account by name using KMD
+     * // if creating it then fund it with 2 Algos from the default dispenser account
+     * const newAccount = await kmdAccountManager.getOrCreateWalletAccount('account1', (2).algos())
+     * // This will return the same account as above since the name matches
+     * const existingAccount = await kmdAccountManager.getOrCreateWalletAccount('account1')
+     * ```
+     *
+     * @returns An Algorand account with private key loaded - either one that already existed in the given KMD wallet, or a new one that is funded for you
+     */
+    async getOrCreateWalletAccount(name, fundWith) {
+        // Get an existing account from the KMD wallet
+        const existing = await this.getWalletAccount(name);
+        if (existing) {
+            return existing;
+        }
+        // None existed: create the KMD wallet instead
+        const walletId = (await this._clientManager.kmd.createWallet(name, '')).wallet.id;
+        const walletHandle = (await this._clientManager.kmd.initWalletHandle(walletId, '')).wallet_handle_token;
+        await this._clientManager.kmd.generateKey(walletHandle);
+        // Get the account from the new KMD wallet
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        const account = (await this.getWalletAccount(name));
+        Config.logger.info(`LocalNet account '${name}' doesn't yet exist; created account ${account.addr} with keys stored in KMD and funding with ${fundWith?.algos ?? 1000} ALGOs`);
+        // Fund the account from the dispenser
+        const dispenser = await this.getLocalNetDispenserAccount();
+        await new AlgokitComposer({
+            algod: this._clientManager.algod,
+            getSigner: () => dispenser.signer,
+            getSuggestedParams: () => this._clientManager.algod.getTransactionParams().do(),
+        })
+            .addPayment({
+            amount: fundWith ?? AlgoAmount.Algos(1000),
+            receiver: account.addr,
+            sender: dispenser.addr,
+        })
+            .execute();
+        return account;
+    }
+    /**
+     * Returns an Algorand account with private key loaded for the default LocalNet dispenser account (that can be used to fund other accounts).
+     * @example
+     * ```typescript
+     * const dispenser = await kmdAccountManager.getLocalNetDispenserAccount()
+     * ```
+     * @returns The default LocalNet dispenser account
+     */
+    async getLocalNetDispenserAccount() {
+        if (!(await this._clientManager.isLocalNet())) {
+            throw new Error("Can't get LocalNet dispenser account from non LocalNet network");
+        }
+        const dispenser = await this.getWalletAccount('unencrypted-default-wallet', (a) => a.status !== 'Offline' && a.amount > 1000000000);
+        if (!dispenser) {
+            throw new Error("Error retrieving LocalNet dispenser account; couldn't find the default account in KMD");
+        }
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        return dispenser;
+    }
+}
+
+export { KmdAccountManager };
+//# sourceMappingURL=kmd-account-manager.mjs.map

package/types/kmd-account-manager.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"kmd-account-manager.mjs","sources":["../../src/types/kmd-account-manager.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;AAOA;AACgE;MACnD,iBAAiB,CAAA;AAG5B;;;AAGG;AACH,IAAA,WAAA,CAAY,aAA4B,EAAA;AACtC,QAAA,IAAI,CAAC,cAAc,GAAG,aAAa,CAAA;KACpC;AAED;;;;;;;;;;;;;;;AAeG;IACI,MAAM,gBAAgB,CAC3B,UAAkB;;AAElB,IAAA,SAAqD,EACrD,MAAe,EAAA;QAEf,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,WAAW,EAAE,CAAA;;AAGnE,QAAA,MAAM,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAM,KAAK,CAAC,CAAC,IAAI,KAAK,UAAU,CAAC,CAAA;AAChF,QAAA,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;AACvB,YAAA,OAAO,SAAS,CAAA;SACjB;QAED,MAAM,QAAQ,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;AAE7B,QAAA,MAAM,YAAY,GAAG,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,gBAAgB,CAAC,QAAQ,EAAE,EAAE,CAAC,EAAE,mBAAmB,CAAA;AACvG,QAAA,MAAM,SAAS,GAAG,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,SAAS,CAAA;QAElF,IAAI,CAAC,GAAG,CAAC,CAAA;QACT,IAAI,SAAS,EAAE;AACb,YAAA,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;AACrC,gBAAA,MAAM,OAAO,GAAG,SAAS,CAAC,CAAC,CAAC,CAAA;AAC5B,gBAAA,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,CAAA;AAChF,gBAAA,IAAI,SAAS,CAAC,OAAO,CAAC,EAAE;oBACtB,MAAK;iBACN;aACF;SACF;AAED,QAAA,IAAI,CAAC,IAAI,SAAS,CAAC,MAAM,EAAE;AACzB,YAAA,OAAO,SAAS,CAAA;SACjB;QAED,MAAM,UAAU,GAAG,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,YAAY,EAAE,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,WAAW,CAAA;QAExG,MAAM,eAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAA;QAE/D,MAAM,OAAO,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAA;QAC5D,MAAM,cAAc,GAAG,IAAI,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;QAE1D,OAAO;AACL,YAAA,OAAO,EAAE,cAAc;YACvB,IAAI,EAAE,cAAc,CAAC,IAAI;YACzB,MAAM,EAAE,cAAc,CAAC,MAAM;SAC9B,CAAA;KACF;AAED;;;;;;;;;;;;;;;;;;;;;;AAsBG;AACI,IAAA,MAAM,wBAAwB,CACnC,IAAY,EACZ,QAAqB,EAAA;;QAGrB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAA;QAClD,IAAI,QAAQ,EAAE;AACZ,YAAA,OAAO,QAAQ,CAAA;SAChB;;QAGD,MAAM,QAAQ,GAAG,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,CAAA;AACjF,QAAA,MAAM,YAAY,GAAG,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,gBAAgB,CAAC,QAAQ,EAAE,EAAE,CAAC,EAAE,mBAAmB,CAAA;QACvG,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,WAAW,CAAC,YAAY,CAAC,CAAA;;;QAIvD,MAAM,OAAO,IAAI,MAAM,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAE,CAAA;AAEpD,QAAA,MAAM,CAAC,MAAM,CAAC,IAAI,CAChB,CAAA,kBAAA,EAAqB,IAAI,CAAwC,qCAAA,EAAA,OAAO,CAAC,IAAI,CAAA,0CAAA,EAC3E,QAAQ,EAAE,KAAK,IAAI,IACrB,CAAA,MAAA,CAAQ,CACT,CAAA;;AAGD,QAAA,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,2BAA2B,EAAE,CAAA;QAC1D,MAAM,IAAI,eAAe,CAAC;AACxB,YAAA,KAAK,EAAE,IAAI,CAAC,cAAc,CAAC,KAAK;AAChC,YAAA,SAAS,EAAE,MAAM,SAAS,CAAC,MAAM;AACjC,YAAA,kBAAkB,EAAE,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,oBAAoB,EAAE,CAAC,EAAE,EAAE;SAChF,CAAC;AACC,aAAA,UAAU,CAAC;YACV,MAAM,EAAE,QAAQ,IAAI,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC;YAC1C,QAAQ,EAAE,OAAO,CAAC,IAAI;YACtB,MAAM,EAAE,SAAS,CAAC,IAAI;SACvB,CAAC;AACD,aAAA,OAAO,EAAE,CAAA;AAEZ,QAAA,OAAO,OAAO,CAAA;KACf;AAED;;;;;;;AAOG;AACI,IAAA,MAAM,2BAA2B,GAAA;QACtC,IAAI,EAAE,MAAM,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE,CAAC,EAAE;AAC7C,YAAA,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAA;SAClF;QAED,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,4BAA4B,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,CAAC,MAAM,GAAG,UAAa,CAAC,CAAA;QACtI,IAAI,CAAC,SAAS,EAAE;AACd,YAAA,MAAM,IAAI,KAAK,CAAC,uFAAuF,CAAC,CAAA;SACzG;;AAGD,QAAA,OAAO,SAAS,CAAA;KACjB;AACF;;;;"}

package/types/network-client.d.ts

@@ -1,5 +1,5 @@
 import type { TokenHeader } from 'algosdk/dist/types/client/urlTokenBaseHTTPClient';
-/** Config for an Algorand SDK client */
+/** Config for an Algorand SDK client. */
 export interface AlgoClientConfig {
     /** Base URL of the server e.g. http://localhost, https://testnet-api.algonode.cloud/, etc. */
     server: string;
@@ -8,7 +8,7 @@ export interface AlgoClientConfig {
     /** The token to use for API authentication (or undefined if none needed) - can be a string, or an object with the header key => value */
     token?: string | TokenHeader;
 }
-/** Config for an algo config */
+/** Configuration for algod, indexer and kmd clients. */
 export interface AlgoConfig {
     /** Algo client configuration */
     algodConfig: AlgoClientConfig;

package/types/network-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"network-client.d.ts","sourceRoot":"","sources":["../../src/types/network-client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kDAAkD,CAAA;AAEnF,wCAAwC;AACxC,MAAM,WAAW,gBAAgB;IAC/B,8FAA8F;IAC9F,MAAM,EAAE,MAAM,CAAA;IACd,2CAA2C;IAC3C,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACtB,yIAAyI;IACzI,KAAK,CAAC,EAAE,MAAM,GAAG,WAAW,CAAA;CAC7B;AAED,gCAAgC;AAChC,MAAM,WAAW,UAAU;IACzB,gCAAgC;IAChC,WAAW,EAAE,gBAAgB,CAAA;IAC7B,mCAAmC;IACnC,aAAa,CAAC,EAAE,gBAAgB,CAAA;IAChC,wBAAwB;IACxB,SAAS,CAAC,EAAE,gBAAgB,CAAA;CAC7B"}
+{"version":3,"file":"network-client.d.ts","sourceRoot":"","sources":["../../src/types/network-client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kDAAkD,CAAA;AAEnF,yCAAyC;AACzC,MAAM,WAAW,gBAAgB;IAC/B,8FAA8F;IAC9F,MAAM,EAAE,MAAM,CAAA;IACd,2CAA2C;IAC3C,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACtB,yIAAyI;IACzI,KAAK,CAAC,EAAE,MAAM,GAAG,WAAW,CAAA;CAC7B;AAED,wDAAwD;AACxD,MAAM,WAAW,UAAU;IACzB,gCAAgC;IAChC,WAAW,EAAE,gBAAgB,CAAA;IAC7B,mCAAmC;IACnC,aAAa,CAAC,EAAE,gBAAgB,CAAA;IAChC,wBAAwB;IACxB,SAAS,CAAC,EAAE,gBAAgB,CAAA;CAC7B"}

package/types/testing.d.ts

@@ -6,6 +6,7 @@ import { SendTransactionFrom } from '../types/transaction';
 import { TransactionSignerAccount } from './account';
 import AlgorandClient from './algorand-client';
 import { TransactionLookupResult } from './indexer';
+import { AlgoConfig } from './network-client';
 import Account = algosdk.Account;
 import Algodv2 = algosdk.Algodv2;
 import Indexer = algosdk.Indexer;
@@ -15,6 +16,8 @@ import Transaction = algosdk.Transaction;
  * Test automation context.
  */
 export interface AlgorandTestAutomationContext {
+    /** An AlgorandClient instance loaded with the current context, including testAccount and any generated accounts loaded as signers */
+    algorand: AlgorandClient;
     /** Algod client instance that will log transactions in `transactionLogger` */
     algod: Algodv2;
     /** Indexer client instance */
@@ -40,16 +43,16 @@ export interface GetTestAccountParams {
     initialFunds: AlgoAmount;
     /** Whether to suppress the log (which includes a mnemonic) or not (default: do not suppress the log) */
     suppressLog?: boolean;
-    /** Optional override for how to get an account; this allows you to retrieve accounts from a known or cached list of accounts. */
-    accountGetter?: (algod: Algodv2, kmd?: Kmd) => Promise<Account>;
+    /** Optional override for how to get a test account; this allows you to retrieve accounts from a known or cached list of accounts. */
+    accountGetter?: (algorand: AlgorandClient) => Promise<Account>;
 }
 /** Configuration for creating an Algorand testing fixture. */
-export interface AlgorandFixtureConfig {
-    /** An optional algod client, if not specified then it will create one against environment variables defined network (if present) or default LocalNet. */
+export interface AlgorandFixtureConfig extends Partial<AlgoConfig> {
+    /** An optional algod client, if not specified then it will create one against `algodConfig` (if present) then environment variables defined network (if present) or default LocalNet. */
     algod?: Algodv2;
-    /** An optional indexer client, if not specified then it will create one against environment variables defined network (if present) or default LocalNet. */
+    /** An optional indexer client, if not specified then it will create one against `indexerConfig` (if present) then environment variables defined network (if present) or default LocalNet. */
     indexer?: Indexer;
-    /** An optional kmd client, if not specified then it will create one against environment variables defined network (if present) or default LocalNet. */
+    /** An optional kmd client, if not specified then it will create one against `kmdConfig` (if present) then environment variables defined network (if present) or default LocalNet. */
     kmd?: Kmd;
     /** The amount of funds to allocate to the default testing account, if not specified then it will get 10 ALGOs. */
     testAccountFunding?: AlgoAmount;

package/types/testing.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"testing.d.ts","sourceRoot":"","sources":["../../src/types/testing.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAA;AAC7B,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAA;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC5C,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAA;AAC1D,OAAO,EAAE,wBAAwB,EAAE,MAAM,WAAW,CAAA;AACpD,OAAO,cAAc,MAAM,mBAAmB,CAAA;AAC9C,OAAO,EAAE,uBAAuB,EAAE,MAAM,WAAW,CAAA;AACnD,OAAO,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;AAChC,OAAO,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;AAChC,OAAO,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;AAChC,OAAO,GAAG,GAAG,OAAO,CAAC,GAAG,CAAA;AACxB,OAAO,WAAW,GAAG,OAAO,CAAC,WAAW,CAAA;AAExC;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,8EAA8E;IAC9E,KAAK,EAAE,OAAO,CAAA;IACd,8BAA8B;IAC9B,OAAO,EAAE,OAAO,CAAA;IAChB,0BAA0B;IAC1B,GAAG,EAAE,GAAG,CAAA;IACR,8FAA8F;IAC9F,iBAAiB,EAAE,iBAAiB,CAAA;IACpC,+DAA+D;IAC/D,WAAW,EAAE,OAAO,GAAG,wBAAwB,CAAA;IAC/C,kEAAkE;IAClE,eAAe,EAAE,CAAC,MAAM,EAAE,oBAAoB,KAAK,OAAO,CAAC,OAAO,GAAG,wBAAwB,CAAC,CAAA;IAC9F,2FAA2F;IAC3F,cAAc,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;IACnC,qEAAqE;IACrE,yBAAyB,EAAE,CAAC,aAAa,EAAE,MAAM,KAAK,OAAO,CAAC,uBAAuB,CAAC,CAAA;CACvF;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,8CAA8C;IAC9C,YAAY,EAAE,UAAU,CAAA;IACxB,wGAAwG;IACxG,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,iIAAiI;IACjI,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;CAChE;AAED,8DAA8D;AAC9D,MAAM,WAAW,qBAAqB;IACpC,yJAAyJ;IACzJ,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,2JAA2J;IAC3J,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,uJAAuJ;IACvJ,GAAG,CAAC,EAAE,GAAG,CAAA;IACT,kHAAkH;IAClH,kBAAkB,CAAC,EAAE,UAAU,CAAA;IAC/B,iIAAiI;IACjI,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;CAChE;AAED,4CAA4C;AAC5C,MAAM,WAAW,eAAe;IAC9B;;;;;;;;;OASG;IACH,IAAI,OAAO,IAAI,6BAA6B,CAAA;IAE5C;;OAEG;IACH,IAAI,QAAQ,IAAI,cAAc,CAAA;IAE9B;;OAEG;IACH,UAAU,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,4EAA4E;IAC5E,YAAY,CAAC,EAAE,CAAC,MAAM,GAAG,WAAW,CAAC,EAAE,CAAA;IACvC,oEAAoE;IACpE,QAAQ,CAAC,EAAE,CAAC,MAAM,GAAG,mBAAmB,CAAC,EAAE,CAAA;IAC3C,yCAAyC;IACzC,IAAI,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,EAAE,CAAA;CACpC;AAED,MAAM,WAAW,wBAAwB;IACvC,oDAAoD;IACpD,IAAI,UAAU,IAAI,UAAU,CAAA;IAC5B;;OAEG;IACH,UAAU,EAAE,MAAM,IAAI,CAAA;IACtB;;OAEG;IACH,SAAS,EAAE,MAAM,IAAI,CAAA;CACtB"}
+{"version":3,"file":"testing.d.ts","sourceRoot":"","sources":["../../src/types/testing.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAA;AAC7B,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAA;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC5C,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAA;AAC1D,OAAO,EAAE,wBAAwB,EAAE,MAAM,WAAW,CAAA;AACpD,OAAO,cAAc,MAAM,mBAAmB,CAAA;AAC9C,OAAO,EAAE,uBAAuB,EAAE,MAAM,WAAW,CAAA;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAC7C,OAAO,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;AAChC,OAAO,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;AAChC,OAAO,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;AAChC,OAAO,GAAG,GAAG,OAAO,CAAC,GAAG,CAAA;AACxB,OAAO,WAAW,GAAG,OAAO,CAAC,WAAW,CAAA;AAExC;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,qIAAqI;IACrI,QAAQ,EAAE,cAAc,CAAA;IACxB,8EAA8E;IAC9E,KAAK,EAAE,OAAO,CAAA;IACd,8BAA8B;IAC9B,OAAO,EAAE,OAAO,CAAA;IAChB,0BAA0B;IAC1B,GAAG,EAAE,GAAG,CAAA;IACR,8FAA8F;IAC9F,iBAAiB,EAAE,iBAAiB,CAAA;IACpC,+DAA+D;IAC/D,WAAW,EAAE,OAAO,GAAG,wBAAwB,CAAA;IAC/C,kEAAkE;IAClE,eAAe,EAAE,CAAC,MAAM,EAAE,oBAAoB,KAAK,OAAO,CAAC,OAAO,GAAG,wBAAwB,CAAC,CAAA;IAC9F,2FAA2F;IAC3F,cAAc,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;IACnC,qEAAqE;IACrE,yBAAyB,EAAE,CAAC,aAAa,EAAE,MAAM,KAAK,OAAO,CAAC,uBAAuB,CAAC,CAAA;CACvF;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,8CAA8C;IAC9C,YAAY,EAAE,UAAU,CAAA;IACxB,wGAAwG;IACxG,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,qIAAqI;IACrI,aAAa,CAAC,EAAE,CAAC,QAAQ,EAAE,cAAc,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;CAC/D;AAED,8DAA8D;AAC9D,MAAM,WAAW,qBAAsB,SAAQ,OAAO,CAAC,UAAU,CAAC;IAChE,yLAAyL;IACzL,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,6LAA6L;IAC7L,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,qLAAqL;IACrL,GAAG,CAAC,EAAE,GAAG,CAAA;IACT,kHAAkH;IAClH,kBAAkB,CAAC,EAAE,UAAU,CAAA;IAC/B,iIAAiI;IACjI,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;CAChE;AAED,4CAA4C;AAC5C,MAAM,WAAW,eAAe;IAC9B;;;;;;;;;OASG;IACH,IAAI,OAAO,IAAI,6BAA6B,CAAA;IAE5C;;OAEG;IACH,IAAI,QAAQ,IAAI,cAAc,CAAA;IAE9B;;OAEG;IACH,UAAU,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,4EAA4E;IAC5E,YAAY,CAAC,EAAE,CAAC,MAAM,GAAG,WAAW,CAAC,EAAE,CAAA;IACvC,oEAAoE;IACpE,QAAQ,CAAC,EAAE,CAAC,MAAM,GAAG,mBAAmB,CAAC,EAAE,CAAA;IAC3C,yCAAyC;IACzC,IAAI,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,EAAE,CAAA;CACpC;AAED,MAAM,WAAW,wBAAwB;IACvC,oDAAoD;IACpD,IAAI,UAAU,IAAI,UAAU,CAAA;IAC5B;;OAEG;IACH,UAAU,EAAE,MAAM,IAAI,CAAA;IACtB;;OAEG;IACH,SAAS,EAAE,MAAM,IAAI,CAAA;CACtB"}