@algorandfoundation/algokit-utils 10.0.0-alpha.31 → 10.0.0-alpha.32

package/kmd-account-manager.js

@@ -0,0 +1,167 @@
+const require_rolldown_runtime = require('./_virtual/rolldown_runtime.js');
+const require_address = require('./packages/common/src/address.js');
+const require_amount = require('./amount.js');
+const require_config = require('./config.js');
+const require_signer = require('./packages/transact/src/signer.js');
+const require_composer = require('./composer.js');
+const require_client_manager = require('./client-manager.js');
+let tweetnacl = require("tweetnacl");
+tweetnacl = require_rolldown_runtime.__toESM(tweetnacl);
+
+//#region src/kmd-account-manager.ts
+/** 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. */
+var KmdAccountManager = class {
+	_clientManager;
+	_kmd;
+	/**
+	* Create a new KMD manager.
+	* @param clientManager A ClientManager client to use for algod and kmd clients
+	*/
+	constructor(clientManager) {
+		this._clientManager = clientManager;
+		try {
+			this._kmd = clientManager.kmd;
+		} catch {
+			this._kmd = void 0;
+		}
+	}
+	async kmd() {
+		if (this._kmd === void 0) {
+			if (await this._clientManager.isLocalNet()) {
+				const { kmdConfig } = require_client_manager.ClientManager.getConfigFromEnvironmentOrLocalNet();
+				if (kmdConfig) {
+					this._kmd = require_client_manager.ClientManager.getKmdClient(kmdConfig);
+					return this._kmd;
+				}
+			}
+			this._kmd = null;
+		}
+		if (!this._kmd) throw new Error("Attempt to use Kmd client in AlgoKit instance with no Kmd configured");
+		return this._kmd;
+	}
+	/**
+	* 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, predicate, sender) {
+		return this.findWalletAccount(walletName, predicate, sender);
+	}
+	async findWalletAccount(walletName, predicateOrAddress, sender) {
+		const kmd = await this.kmd();
+		const wallet = (await kmd.listWallets()).wallets.filter((w) => w.name === walletName);
+		if (wallet.length === 0) return;
+		const walletHandle = (await kmd.initWalletHandle({
+			walletId: wallet[0].id,
+			walletPassword: ""
+		})).walletHandleToken;
+		let matchedAddress = void 0;
+		if (predicateOrAddress && typeof predicateOrAddress === "string") matchedAddress = require_address.Address.fromString(predicateOrAddress);
+		else {
+			const addresses = (await kmd.listKeysInWallet({ walletHandleToken: walletHandle })).addresses;
+			if (addresses.length > 0) if (predicateOrAddress && typeof predicateOrAddress === "function") {
+				for (let i = 0; i < addresses.length; i++) if (predicateOrAddress(await this._clientManager.algod.accountInformation(addresses[i]))) {
+					matchedAddress = addresses[i];
+					break;
+				}
+			} else matchedAddress = addresses[0];
+		}
+		if (!matchedAddress) return;
+		const accountKey = (await kmd.exportKey({
+			walletHandleToken: walletHandle,
+			address: matchedAddress
+		})).privateKey;
+		const keys = tweetnacl.default.sign.keyPair.fromSecretKey(accountKey);
+		const rawSigner = async (bytesToSign) => {
+			return tweetnacl.default.sign.detached(bytesToSign, keys.secretKey);
+		};
+		return require_signer.generateAddressWithSigners({
+			ed25519Pubkey: keys.publicKey,
+			sendingAddress: require_address.getOptionalAddress(sender),
+			rawEd25519Signer: rawSigner
+		});
+	}
+	/**
+	* 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 Algo to fund the account with when it gets created, if not specified then 1000 ALGO will be funded from the dispenser account
+	*
+	* @example
+	* ```typescript
+	* // Idempotently get (if exists) or create (if it doesn't exist yet) an account by name using KMD
+	* // if creating it then fund it with 2 ALGO from the default dispenser account
+	* const newAccount = await kmdAccountManager.getOrCreateWalletAccount('account1', (2).algo())
+	* // 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) {
+		const existing = await this.getWalletAccount(name);
+		if (existing) return existing;
+		const kmd = await this.kmd();
+		const walletId = (await kmd.createWallet({
+			walletName: name,
+			walletPassword: ""
+		})).wallet.id;
+		const walletHandle = (await kmd.initWalletHandle({
+			walletId,
+			walletPassword: ""
+		})).walletHandleToken;
+		await kmd.generateKey({ walletHandleToken: walletHandle });
+		const account = await this.getWalletAccount(name);
+		require_config.Config.logger.info(`LocalNet account '${name}' doesn't yet exist; created account ${account.addr} with keys stored in KMD and funding with ${fundWith?.algo ?? 1e3} ALGO`);
+		const dispenser = await this.getLocalNetDispenserAccount();
+		await new require_composer.TransactionComposer({
+			algod: this._clientManager.algod,
+			getSigner: () => dispenser.signer,
+			getSuggestedParams: () => this._clientManager.algod.suggestedParams()
+		}).addPayment({
+			amount: fundWith ?? require_amount.AlgoAmount.Algo(1e3),
+			receiver: account.addr,
+			sender: dispenser.addr
+		}).send();
+		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 dispenserAddresses = (await this._clientManager.algod.genesis()).alloc.filter((a) => a.comment === "Wallet1").map((a) => a.addr);
+		if (dispenserAddresses.length > 0) {
+			const dispenser = await this.findWalletAccount("unencrypted-default-wallet", dispenserAddresses[0]);
+			if (dispenser) return dispenser;
+		}
+		throw new Error("Error retrieving LocalNet dispenser account; couldn't find the default account in KMD");
+	}
+};
+
+//#endregion
+exports.KmdAccountManager = KmdAccountManager;
+//# sourceMappingURL=kmd-account-manager.js.map

package/kmd-account-manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"kmd-account-manager.js","names":["ClientManager","matchedAddress: Address | undefined","Address","nacl","generateAddressWithSigners","getOptionalAddress","TransactionComposer","AlgoAmount"],"sources":["../src/kmd-account-manager.ts"],"sourcesContent":["import { Account } from '@algorandfoundation/algokit-algod-client'\nimport { Address, getOptionalAddress } from '@algorandfoundation/algokit-common'\nimport { KmdClient } from '@algorandfoundation/algokit-kmd-client'\nimport { AddressWithTransactionSigner, generateAddressWithSigners } from '@algorandfoundation/algokit-transact'\nimport nacl from 'tweetnacl'\nimport { AlgoAmount } from './amount'\nimport { ClientManager } from './client-manager'\nimport { TransactionComposer } from './composer'\nimport { Config } from './config'\n\n/** Provides abstractions over a [KMD](https://github.com/algorand/go-algorand/blob/master/daemon/kmd/README.md) instance\n * that makes it easier to get and manage accounts using KMD. */\nexport class KmdAccountManager {\n  private _clientManager: Omit<ClientManager, 'kmd'>\n  private _kmd?: KmdClient | null\n\n  /**\n   * Create a new KMD manager.\n   * @param clientManager A ClientManager client to use for algod and kmd clients\n   */\n  constructor(clientManager: ClientManager) {\n    this._clientManager = clientManager\n    try {\n      this._kmd = clientManager.kmd\n    } catch {\n      this._kmd = undefined\n    }\n  }\n\n  async kmd(): Promise<KmdClient> {\n    if (this._kmd === undefined) {\n      if (await this._clientManager.isLocalNet()) {\n        const { kmdConfig } = ClientManager.getConfigFromEnvironmentOrLocalNet()\n        if (kmdConfig) {\n          this._kmd = ClientManager.getKmdClient(kmdConfig)\n          return this._kmd\n        }\n      }\n      this._kmd = null\n    }\n\n    if (!this._kmd) {\n      throw new Error('Attempt to use Kmd client in AlgoKit instance with no Kmd configured')\n    }\n\n    return this._kmd\n  }\n\n  /**\n   * Returns an Algorand signing account with private key loaded from the given KMD wallet (identified by name).\n   *\n   * @param walletName The name of the wallet to retrieve an account from\n   * @param predicate An optional filter to use to find the account (otherwise it will return a random account from the wallet)\n   * @param sender The optional sender address to use this signer for (aka a rekeyed account)\n   * @example Get default funded account in a LocalNet\n   *\n   * ```typescript\n   * const defaultDispenserAccount = await kmdAccountManager.getWalletAccount(\n   *   'unencrypted-default-wallet',\n   *   a => a.status !== 'Offline' && a.amount > 1_000_000_000\n   * )\n   * ```\n   * @returns The signing account (with private key loaded) or undefined if no matching wallet or account was found\n   */\n  public async getWalletAccount(\n    walletName: string,\n    predicate?: (account: Account) => boolean,\n    sender?: string | Address,\n  ): Promise<AddressWithTransactionSigner | undefined> {\n    return this.findWalletAccount(walletName, predicate, sender)\n  }\n\n  private async findWalletAccount(\n    walletName: string,\n    predicateOrAddress?: ((account: Account) => boolean) | string,\n    sender?: string | Address,\n  ): Promise<AddressWithTransactionSigner | undefined> {\n    const kmd = await this.kmd()\n    const walletsResponse = await kmd.listWallets()\n    const wallet = walletsResponse.wallets.filter((w) => w.name === walletName)\n    if (wallet.length === 0) {\n      return undefined\n    }\n    const walletId = wallet[0].id\n    const walletHandle = (await kmd.initWalletHandle({ walletId, walletPassword: '' })).walletHandleToken\n\n    let matchedAddress: Address | undefined = undefined\n    if (predicateOrAddress && typeof predicateOrAddress === 'string') {\n      matchedAddress = Address.fromString(predicateOrAddress)\n    } else {\n      const addresses = (await kmd.listKeysInWallet({ walletHandleToken: walletHandle })).addresses\n      if (addresses.length > 0) {\n        if (predicateOrAddress && typeof predicateOrAddress === 'function') {\n          for (let i = 0; i < addresses.length; i++) {\n            const account = await this._clientManager.algod.accountInformation(addresses[i])\n            if (predicateOrAddress(account)) {\n              matchedAddress = addresses[i]\n              break\n            }\n          }\n        } else {\n          matchedAddress = addresses[0]\n        }\n      }\n    }\n\n    if (!matchedAddress) {\n      return undefined\n    }\n\n    const accountKey = (await kmd.exportKey({ walletHandleToken: walletHandle, address: matchedAddress })).privateKey\n    const keys = nacl.sign.keyPair.fromSecretKey(accountKey)\n    const rawSigner = async (bytesToSign: Uint8Array): Promise<Uint8Array> => {\n      return nacl.sign.detached(bytesToSign, keys.secretKey)\n    }\n\n    return generateAddressWithSigners({\n      ed25519Pubkey: keys.publicKey,\n      sendingAddress: getOptionalAddress(sender),\n      rawEd25519Signer: rawSigner,\n    })\n  }\n\n  /**\n   * 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.\n   *\n   * This is useful to get idempotent accounts from LocalNet without having to specify the private key (which will change when resetting the LocalNet).\n   *\n   * 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.\n   *\n   * If this is used via `mnemonicAccountFromEnvironment`, then you can even use the same code that runs on production without changes for local development!\n   *\n   * @param name The name of the wallet to retrieve / create\n   * @param fundWith The number of Algo to fund the account with when it gets created, if not specified then 1000 ALGO will be funded from the dispenser account\n   *\n   * @example\n   * ```typescript\n   * // Idempotently get (if exists) or create (if it doesn't exist yet) an account by name using KMD\n   * // if creating it then fund it with 2 ALGO from the default dispenser account\n   * const newAccount = await kmdAccountManager.getOrCreateWalletAccount('account1', (2).algo())\n   * // This will return the same account as above since the name matches\n   * const existingAccount = await kmdAccountManager.getOrCreateWalletAccount('account1')\n   * ```\n   *\n   * @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\n   */\n  public async getOrCreateWalletAccount(name: string, fundWith?: AlgoAmount): Promise<AddressWithTransactionSigner> {\n    // Get an existing account from the KMD wallet\n    const existing = await this.getWalletAccount(name)\n    if (existing) {\n      return existing\n    }\n\n    const kmd = await this.kmd()\n\n    // None existed: create the KMD wallet instead\n    const walletId = (await kmd.createWallet({ walletName: name, walletPassword: '' })).wallet.id\n    const walletHandle = (await kmd.initWalletHandle({ walletId, walletPassword: '' })).walletHandleToken\n    await kmd.generateKey({ walletHandleToken: walletHandle })\n\n    // Get the account from the new KMD wallet\n    const account = (await this.getWalletAccount(name))!\n\n    Config.logger.info(\n      `LocalNet account '${name}' doesn't yet exist; created account ${account.addr} with keys stored in KMD and funding with ${\n        fundWith?.algo ?? 1000\n      } ALGO`,\n    )\n\n    // Fund the account from the dispenser\n    const dispenser = await this.getLocalNetDispenserAccount()\n    await new TransactionComposer({\n      algod: this._clientManager.algod,\n      getSigner: () => dispenser.signer,\n      getSuggestedParams: () => this._clientManager.algod.suggestedParams(),\n    })\n      .addPayment({ amount: fundWith ?? AlgoAmount.Algo(1000), receiver: account.addr, sender: dispenser.addr })\n      .send()\n\n    return account\n  }\n\n  /**\n   * Returns an Algorand account with private key loaded for the default LocalNet dispenser account (that can be used to fund other accounts).\n   * @example\n   * ```typescript\n   * const dispenser = await kmdAccountManager.getLocalNetDispenserAccount()\n   * ```\n   * @returns The default LocalNet dispenser account\n   */\n  public async getLocalNetDispenserAccount() {\n    if (!(await this._clientManager.isLocalNet())) {\n      throw new Error(\"Can't get LocalNet dispenser account from non LocalNet network\")\n    }\n    const genesisResponse = await this._clientManager.algod.genesis()\n    const dispenserAddresses = genesisResponse.alloc.filter((a) => a.comment === 'Wallet1').map((a) => a.addr)\n    if (dispenserAddresses.length > 0) {\n      const dispenser = await this.findWalletAccount('unencrypted-default-wallet', dispenserAddresses[0])\n      if (dispenser) {\n        return dispenser\n      }\n    }\n\n    throw new Error(\"Error retrieving LocalNet dispenser account; couldn't find the default account in KMD\")\n  }\n}\n"],"mappings":";;;;;;;;;;;;;AAYA,IAAa,oBAAb,MAA+B;CAC7B,AAAQ;CACR,AAAQ;;;;;CAMR,YAAY,eAA8B;AACxC,OAAK,iBAAiB;AACtB,MAAI;AACF,QAAK,OAAO,cAAc;UACpB;AACN,QAAK,OAAO;;;CAIhB,MAAM,MAA0B;AAC9B,MAAI,KAAK,SAAS,QAAW;AAC3B,OAAI,MAAM,KAAK,eAAe,YAAY,EAAE;IAC1C,MAAM,EAAE,cAAcA,qCAAc,oCAAoC;AACxE,QAAI,WAAW;AACb,UAAK,OAAOA,qCAAc,aAAa,UAAU;AACjD,YAAO,KAAK;;;AAGhB,QAAK,OAAO;;AAGd,MAAI,CAAC,KAAK,KACR,OAAM,IAAI,MAAM,uEAAuE;AAGzF,SAAO,KAAK;;;;;;;;;;;;;;;;;;CAmBd,MAAa,iBACX,YACA,WACA,QACmD;AACnD,SAAO,KAAK,kBAAkB,YAAY,WAAW,OAAO;;CAG9D,MAAc,kBACZ,YACA,oBACA,QACmD;EACnD,MAAM,MAAM,MAAM,KAAK,KAAK;EAE5B,MAAM,UADkB,MAAM,IAAI,aAAa,EAChB,QAAQ,QAAQ,MAAM,EAAE,SAAS,WAAW;AAC3E,MAAI,OAAO,WAAW,EACpB;EAGF,MAAM,gBAAgB,MAAM,IAAI,iBAAiB;GAAE,UADlC,OAAO,GAAG;GACkC,gBAAgB;GAAI,CAAC,EAAE;EAEpF,IAAIC,iBAAsC;AAC1C,MAAI,sBAAsB,OAAO,uBAAuB,SACtD,kBAAiBC,wBAAQ,WAAW,mBAAmB;OAClD;GACL,MAAM,aAAa,MAAM,IAAI,iBAAiB,EAAE,mBAAmB,cAAc,CAAC,EAAE;AACpF,OAAI,UAAU,SAAS,EACrB,KAAI,sBAAsB,OAAO,uBAAuB,YACtD;SAAK,IAAI,IAAI,GAAG,IAAI,UAAU,QAAQ,IAEpC,KAAI,mBADY,MAAM,KAAK,eAAe,MAAM,mBAAmB,UAAU,GAAG,CACjD,EAAE;AAC/B,sBAAiB,UAAU;AAC3B;;SAIJ,kBAAiB,UAAU;;AAKjC,MAAI,CAAC,eACH;EAGF,MAAM,cAAc,MAAM,IAAI,UAAU;GAAE,mBAAmB;GAAc,SAAS;GAAgB,CAAC,EAAE;EACvG,MAAM,OAAOC,kBAAK,KAAK,QAAQ,cAAc,WAAW;EACxD,MAAM,YAAY,OAAO,gBAAiD;AACxE,UAAOA,kBAAK,KAAK,SAAS,aAAa,KAAK,UAAU;;AAGxD,SAAOC,0CAA2B;GAChC,eAAe,KAAK;GACpB,gBAAgBC,mCAAmB,OAAO;GAC1C,kBAAkB;GACnB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;CA0BJ,MAAa,yBAAyB,MAAc,UAA8D;EAEhH,MAAM,WAAW,MAAM,KAAK,iBAAiB,KAAK;AAClD,MAAI,SACF,QAAO;EAGT,MAAM,MAAM,MAAM,KAAK,KAAK;EAG5B,MAAM,YAAY,MAAM,IAAI,aAAa;GAAE,YAAY;GAAM,gBAAgB;GAAI,CAAC,EAAE,OAAO;EAC3F,MAAM,gBAAgB,MAAM,IAAI,iBAAiB;GAAE;GAAU,gBAAgB;GAAI,CAAC,EAAE;AACpF,QAAM,IAAI,YAAY,EAAE,mBAAmB,cAAc,CAAC;EAG1D,MAAM,UAAW,MAAM,KAAK,iBAAiB,KAAK;AAElD,wBAAO,OAAO,KACZ,qBAAqB,KAAK,uCAAuC,QAAQ,KAAK,4CAC5E,UAAU,QAAQ,IACnB,OACF;EAGD,MAAM,YAAY,MAAM,KAAK,6BAA6B;AAC1D,QAAM,IAAIC,qCAAoB;GAC5B,OAAO,KAAK,eAAe;GAC3B,iBAAiB,UAAU;GAC3B,0BAA0B,KAAK,eAAe,MAAM,iBAAiB;GACtE,CAAC,CACC,WAAW;GAAE,QAAQ,YAAYC,0BAAW,KAAK,IAAK;GAAE,UAAU,QAAQ;GAAM,QAAQ,UAAU;GAAM,CAAC,CACzG,MAAM;AAET,SAAO;;;;;;;;;;CAWT,MAAa,8BAA8B;AACzC,MAAI,CAAE,MAAM,KAAK,eAAe,YAAY,CAC1C,OAAM,IAAI,MAAM,iEAAiE;EAGnF,MAAM,sBADkB,MAAM,KAAK,eAAe,MAAM,SAAS,EACtB,MAAM,QAAQ,MAAM,EAAE,YAAY,UAAU,CAAC,KAAK,MAAM,EAAE,KAAK;AAC1G,MAAI,mBAAmB,SAAS,GAAG;GACjC,MAAM,YAAY,MAAM,KAAK,kBAAkB,8BAA8B,mBAAmB,GAAG;AACnG,OAAI,UACF,QAAO;;AAIX,QAAM,IAAI,MAAM,wFAAwF"}

package/kmd-account-manager.mjs

@@ -0,0 +1,165 @@
+import { Address, getOptionalAddress } from "./packages/common/src/address.mjs";
+import { AlgoAmount } from "./amount.mjs";
+import { Config } from "./config.mjs";
+import { generateAddressWithSigners } from "./packages/transact/src/signer.mjs";
+import { TransactionComposer } from "./composer.mjs";
+import { ClientManager } from "./client-manager.mjs";
+import nacl from "tweetnacl";
+
+//#region src/kmd-account-manager.ts
+/** 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. */
+var KmdAccountManager = class {
+	_clientManager;
+	_kmd;
+	/**
+	* Create a new KMD manager.
+	* @param clientManager A ClientManager client to use for algod and kmd clients
+	*/
+	constructor(clientManager) {
+		this._clientManager = clientManager;
+		try {
+			this._kmd = clientManager.kmd;
+		} catch {
+			this._kmd = void 0;
+		}
+	}
+	async kmd() {
+		if (this._kmd === void 0) {
+			if (await this._clientManager.isLocalNet()) {
+				const { kmdConfig } = ClientManager.getConfigFromEnvironmentOrLocalNet();
+				if (kmdConfig) {
+					this._kmd = ClientManager.getKmdClient(kmdConfig);
+					return this._kmd;
+				}
+			}
+			this._kmd = null;
+		}
+		if (!this._kmd) throw new Error("Attempt to use Kmd client in AlgoKit instance with no Kmd configured");
+		return this._kmd;
+	}
+	/**
+	* 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, predicate, sender) {
+		return this.findWalletAccount(walletName, predicate, sender);
+	}
+	async findWalletAccount(walletName, predicateOrAddress, sender) {
+		const kmd = await this.kmd();
+		const wallet = (await kmd.listWallets()).wallets.filter((w) => w.name === walletName);
+		if (wallet.length === 0) return;
+		const walletHandle = (await kmd.initWalletHandle({
+			walletId: wallet[0].id,
+			walletPassword: ""
+		})).walletHandleToken;
+		let matchedAddress = void 0;
+		if (predicateOrAddress && typeof predicateOrAddress === "string") matchedAddress = Address.fromString(predicateOrAddress);
+		else {
+			const addresses = (await kmd.listKeysInWallet({ walletHandleToken: walletHandle })).addresses;
+			if (addresses.length > 0) if (predicateOrAddress && typeof predicateOrAddress === "function") {
+				for (let i = 0; i < addresses.length; i++) if (predicateOrAddress(await this._clientManager.algod.accountInformation(addresses[i]))) {
+					matchedAddress = addresses[i];
+					break;
+				}
+			} else matchedAddress = addresses[0];
+		}
+		if (!matchedAddress) return;
+		const accountKey = (await kmd.exportKey({
+			walletHandleToken: walletHandle,
+			address: matchedAddress
+		})).privateKey;
+		const keys = nacl.sign.keyPair.fromSecretKey(accountKey);
+		const rawSigner = async (bytesToSign) => {
+			return nacl.sign.detached(bytesToSign, keys.secretKey);
+		};
+		return generateAddressWithSigners({
+			ed25519Pubkey: keys.publicKey,
+			sendingAddress: getOptionalAddress(sender),
+			rawEd25519Signer: rawSigner
+		});
+	}
+	/**
+	* 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 Algo to fund the account with when it gets created, if not specified then 1000 ALGO will be funded from the dispenser account
+	*
+	* @example
+	* ```typescript
+	* // Idempotently get (if exists) or create (if it doesn't exist yet) an account by name using KMD
+	* // if creating it then fund it with 2 ALGO from the default dispenser account
+	* const newAccount = await kmdAccountManager.getOrCreateWalletAccount('account1', (2).algo())
+	* // 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) {
+		const existing = await this.getWalletAccount(name);
+		if (existing) return existing;
+		const kmd = await this.kmd();
+		const walletId = (await kmd.createWallet({
+			walletName: name,
+			walletPassword: ""
+		})).wallet.id;
+		const walletHandle = (await kmd.initWalletHandle({
+			walletId,
+			walletPassword: ""
+		})).walletHandleToken;
+		await kmd.generateKey({ walletHandleToken: walletHandle });
+		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?.algo ?? 1e3} ALGO`);
+		const dispenser = await this.getLocalNetDispenserAccount();
+		await new TransactionComposer({
+			algod: this._clientManager.algod,
+			getSigner: () => dispenser.signer,
+			getSuggestedParams: () => this._clientManager.algod.suggestedParams()
+		}).addPayment({
+			amount: fundWith ?? AlgoAmount.Algo(1e3),
+			receiver: account.addr,
+			sender: dispenser.addr
+		}).send();
+		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 dispenserAddresses = (await this._clientManager.algod.genesis()).alloc.filter((a) => a.comment === "Wallet1").map((a) => a.addr);
+		if (dispenserAddresses.length > 0) {
+			const dispenser = await this.findWalletAccount("unencrypted-default-wallet", dispenserAddresses[0]);
+			if (dispenser) return dispenser;
+		}
+		throw new Error("Error retrieving LocalNet dispenser account; couldn't find the default account in KMD");
+	}
+};
+
+//#endregion
+export { KmdAccountManager };
+//# sourceMappingURL=kmd-account-manager.mjs.map

package/kmd-account-manager.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"kmd-account-manager.mjs","names":["matchedAddress: Address | undefined"],"sources":["../src/kmd-account-manager.ts"],"sourcesContent":["import { Account } from '@algorandfoundation/algokit-algod-client'\nimport { Address, getOptionalAddress } from '@algorandfoundation/algokit-common'\nimport { KmdClient } from '@algorandfoundation/algokit-kmd-client'\nimport { AddressWithTransactionSigner, generateAddressWithSigners } from '@algorandfoundation/algokit-transact'\nimport nacl from 'tweetnacl'\nimport { AlgoAmount } from './amount'\nimport { ClientManager } from './client-manager'\nimport { TransactionComposer } from './composer'\nimport { Config } from './config'\n\n/** Provides abstractions over a [KMD](https://github.com/algorand/go-algorand/blob/master/daemon/kmd/README.md) instance\n * that makes it easier to get and manage accounts using KMD. */\nexport class KmdAccountManager {\n  private _clientManager: Omit<ClientManager, 'kmd'>\n  private _kmd?: KmdClient | null\n\n  /**\n   * Create a new KMD manager.\n   * @param clientManager A ClientManager client to use for algod and kmd clients\n   */\n  constructor(clientManager: ClientManager) {\n    this._clientManager = clientManager\n    try {\n      this._kmd = clientManager.kmd\n    } catch {\n      this._kmd = undefined\n    }\n  }\n\n  async kmd(): Promise<KmdClient> {\n    if (this._kmd === undefined) {\n      if (await this._clientManager.isLocalNet()) {\n        const { kmdConfig } = ClientManager.getConfigFromEnvironmentOrLocalNet()\n        if (kmdConfig) {\n          this._kmd = ClientManager.getKmdClient(kmdConfig)\n          return this._kmd\n        }\n      }\n      this._kmd = null\n    }\n\n    if (!this._kmd) {\n      throw new Error('Attempt to use Kmd client in AlgoKit instance with no Kmd configured')\n    }\n\n    return this._kmd\n  }\n\n  /**\n   * Returns an Algorand signing account with private key loaded from the given KMD wallet (identified by name).\n   *\n   * @param walletName The name of the wallet to retrieve an account from\n   * @param predicate An optional filter to use to find the account (otherwise it will return a random account from the wallet)\n   * @param sender The optional sender address to use this signer for (aka a rekeyed account)\n   * @example Get default funded account in a LocalNet\n   *\n   * ```typescript\n   * const defaultDispenserAccount = await kmdAccountManager.getWalletAccount(\n   *   'unencrypted-default-wallet',\n   *   a => a.status !== 'Offline' && a.amount > 1_000_000_000\n   * )\n   * ```\n   * @returns The signing account (with private key loaded) or undefined if no matching wallet or account was found\n   */\n  public async getWalletAccount(\n    walletName: string,\n    predicate?: (account: Account) => boolean,\n    sender?: string | Address,\n  ): Promise<AddressWithTransactionSigner | undefined> {\n    return this.findWalletAccount(walletName, predicate, sender)\n  }\n\n  private async findWalletAccount(\n    walletName: string,\n    predicateOrAddress?: ((account: Account) => boolean) | string,\n    sender?: string | Address,\n  ): Promise<AddressWithTransactionSigner | undefined> {\n    const kmd = await this.kmd()\n    const walletsResponse = await kmd.listWallets()\n    const wallet = walletsResponse.wallets.filter((w) => w.name === walletName)\n    if (wallet.length === 0) {\n      return undefined\n    }\n    const walletId = wallet[0].id\n    const walletHandle = (await kmd.initWalletHandle({ walletId, walletPassword: '' })).walletHandleToken\n\n    let matchedAddress: Address | undefined = undefined\n    if (predicateOrAddress && typeof predicateOrAddress === 'string') {\n      matchedAddress = Address.fromString(predicateOrAddress)\n    } else {\n      const addresses = (await kmd.listKeysInWallet({ walletHandleToken: walletHandle })).addresses\n      if (addresses.length > 0) {\n        if (predicateOrAddress && typeof predicateOrAddress === 'function') {\n          for (let i = 0; i < addresses.length; i++) {\n            const account = await this._clientManager.algod.accountInformation(addresses[i])\n            if (predicateOrAddress(account)) {\n              matchedAddress = addresses[i]\n              break\n            }\n          }\n        } else {\n          matchedAddress = addresses[0]\n        }\n      }\n    }\n\n    if (!matchedAddress) {\n      return undefined\n    }\n\n    const accountKey = (await kmd.exportKey({ walletHandleToken: walletHandle, address: matchedAddress })).privateKey\n    const keys = nacl.sign.keyPair.fromSecretKey(accountKey)\n    const rawSigner = async (bytesToSign: Uint8Array): Promise<Uint8Array> => {\n      return nacl.sign.detached(bytesToSign, keys.secretKey)\n    }\n\n    return generateAddressWithSigners({\n      ed25519Pubkey: keys.publicKey,\n      sendingAddress: getOptionalAddress(sender),\n      rawEd25519Signer: rawSigner,\n    })\n  }\n\n  /**\n   * 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.\n   *\n   * This is useful to get idempotent accounts from LocalNet without having to specify the private key (which will change when resetting the LocalNet).\n   *\n   * 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.\n   *\n   * If this is used via `mnemonicAccountFromEnvironment`, then you can even use the same code that runs on production without changes for local development!\n   *\n   * @param name The name of the wallet to retrieve / create\n   * @param fundWith The number of Algo to fund the account with when it gets created, if not specified then 1000 ALGO will be funded from the dispenser account\n   *\n   * @example\n   * ```typescript\n   * // Idempotently get (if exists) or create (if it doesn't exist yet) an account by name using KMD\n   * // if creating it then fund it with 2 ALGO from the default dispenser account\n   * const newAccount = await kmdAccountManager.getOrCreateWalletAccount('account1', (2).algo())\n   * // This will return the same account as above since the name matches\n   * const existingAccount = await kmdAccountManager.getOrCreateWalletAccount('account1')\n   * ```\n   *\n   * @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\n   */\n  public async getOrCreateWalletAccount(name: string, fundWith?: AlgoAmount): Promise<AddressWithTransactionSigner> {\n    // Get an existing account from the KMD wallet\n    const existing = await this.getWalletAccount(name)\n    if (existing) {\n      return existing\n    }\n\n    const kmd = await this.kmd()\n\n    // None existed: create the KMD wallet instead\n    const walletId = (await kmd.createWallet({ walletName: name, walletPassword: '' })).wallet.id\n    const walletHandle = (await kmd.initWalletHandle({ walletId, walletPassword: '' })).walletHandleToken\n    await kmd.generateKey({ walletHandleToken: walletHandle })\n\n    // Get the account from the new KMD wallet\n    const account = (await this.getWalletAccount(name))!\n\n    Config.logger.info(\n      `LocalNet account '${name}' doesn't yet exist; created account ${account.addr} with keys stored in KMD and funding with ${\n        fundWith?.algo ?? 1000\n      } ALGO`,\n    )\n\n    // Fund the account from the dispenser\n    const dispenser = await this.getLocalNetDispenserAccount()\n    await new TransactionComposer({\n      algod: this._clientManager.algod,\n      getSigner: () => dispenser.signer,\n      getSuggestedParams: () => this._clientManager.algod.suggestedParams(),\n    })\n      .addPayment({ amount: fundWith ?? AlgoAmount.Algo(1000), receiver: account.addr, sender: dispenser.addr })\n      .send()\n\n    return account\n  }\n\n  /**\n   * Returns an Algorand account with private key loaded for the default LocalNet dispenser account (that can be used to fund other accounts).\n   * @example\n   * ```typescript\n   * const dispenser = await kmdAccountManager.getLocalNetDispenserAccount()\n   * ```\n   * @returns The default LocalNet dispenser account\n   */\n  public async getLocalNetDispenserAccount() {\n    if (!(await this._clientManager.isLocalNet())) {\n      throw new Error(\"Can't get LocalNet dispenser account from non LocalNet network\")\n    }\n    const genesisResponse = await this._clientManager.algod.genesis()\n    const dispenserAddresses = genesisResponse.alloc.filter((a) => a.comment === 'Wallet1').map((a) => a.addr)\n    if (dispenserAddresses.length > 0) {\n      const dispenser = await this.findWalletAccount('unencrypted-default-wallet', dispenserAddresses[0])\n      if (dispenser) {\n        return dispenser\n      }\n    }\n\n    throw new Error(\"Error retrieving LocalNet dispenser account; couldn't find the default account in KMD\")\n  }\n}\n"],"mappings":";;;;;;;;;;;AAYA,IAAa,oBAAb,MAA+B;CAC7B,AAAQ;CACR,AAAQ;;;;;CAMR,YAAY,eAA8B;AACxC,OAAK,iBAAiB;AACtB,MAAI;AACF,QAAK,OAAO,cAAc;UACpB;AACN,QAAK,OAAO;;;CAIhB,MAAM,MAA0B;AAC9B,MAAI,KAAK,SAAS,QAAW;AAC3B,OAAI,MAAM,KAAK,eAAe,YAAY,EAAE;IAC1C,MAAM,EAAE,cAAc,cAAc,oCAAoC;AACxE,QAAI,WAAW;AACb,UAAK,OAAO,cAAc,aAAa,UAAU;AACjD,YAAO,KAAK;;;AAGhB,QAAK,OAAO;;AAGd,MAAI,CAAC,KAAK,KACR,OAAM,IAAI,MAAM,uEAAuE;AAGzF,SAAO,KAAK;;;;;;;;;;;;;;;;;;CAmBd,MAAa,iBACX,YACA,WACA,QACmD;AACnD,SAAO,KAAK,kBAAkB,YAAY,WAAW,OAAO;;CAG9D,MAAc,kBACZ,YACA,oBACA,QACmD;EACnD,MAAM,MAAM,MAAM,KAAK,KAAK;EAE5B,MAAM,UADkB,MAAM,IAAI,aAAa,EAChB,QAAQ,QAAQ,MAAM,EAAE,SAAS,WAAW;AAC3E,MAAI,OAAO,WAAW,EACpB;EAGF,MAAM,gBAAgB,MAAM,IAAI,iBAAiB;GAAE,UADlC,OAAO,GAAG;GACkC,gBAAgB;GAAI,CAAC,EAAE;EAEpF,IAAIA,iBAAsC;AAC1C,MAAI,sBAAsB,OAAO,uBAAuB,SACtD,kBAAiB,QAAQ,WAAW,mBAAmB;OAClD;GACL,MAAM,aAAa,MAAM,IAAI,iBAAiB,EAAE,mBAAmB,cAAc,CAAC,EAAE;AACpF,OAAI,UAAU,SAAS,EACrB,KAAI,sBAAsB,OAAO,uBAAuB,YACtD;SAAK,IAAI,IAAI,GAAG,IAAI,UAAU,QAAQ,IAEpC,KAAI,mBADY,MAAM,KAAK,eAAe,MAAM,mBAAmB,UAAU,GAAG,CACjD,EAAE;AAC/B,sBAAiB,UAAU;AAC3B;;SAIJ,kBAAiB,UAAU;;AAKjC,MAAI,CAAC,eACH;EAGF,MAAM,cAAc,MAAM,IAAI,UAAU;GAAE,mBAAmB;GAAc,SAAS;GAAgB,CAAC,EAAE;EACvG,MAAM,OAAO,KAAK,KAAK,QAAQ,cAAc,WAAW;EACxD,MAAM,YAAY,OAAO,gBAAiD;AACxE,UAAO,KAAK,KAAK,SAAS,aAAa,KAAK,UAAU;;AAGxD,SAAO,2BAA2B;GAChC,eAAe,KAAK;GACpB,gBAAgB,mBAAmB,OAAO;GAC1C,kBAAkB;GACnB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;CA0BJ,MAAa,yBAAyB,MAAc,UAA8D;EAEhH,MAAM,WAAW,MAAM,KAAK,iBAAiB,KAAK;AAClD,MAAI,SACF,QAAO;EAGT,MAAM,MAAM,MAAM,KAAK,KAAK;EAG5B,MAAM,YAAY,MAAM,IAAI,aAAa;GAAE,YAAY;GAAM,gBAAgB;GAAI,CAAC,EAAE,OAAO;EAC3F,MAAM,gBAAgB,MAAM,IAAI,iBAAiB;GAAE;GAAU,gBAAgB;GAAI,CAAC,EAAE;AACpF,QAAM,IAAI,YAAY,EAAE,mBAAmB,cAAc,CAAC;EAG1D,MAAM,UAAW,MAAM,KAAK,iBAAiB,KAAK;AAElD,SAAO,OAAO,KACZ,qBAAqB,KAAK,uCAAuC,QAAQ,KAAK,4CAC5E,UAAU,QAAQ,IACnB,OACF;EAGD,MAAM,YAAY,MAAM,KAAK,6BAA6B;AAC1D,QAAM,IAAI,oBAAoB;GAC5B,OAAO,KAAK,eAAe;GAC3B,iBAAiB,UAAU;GAC3B,0BAA0B,KAAK,eAAe,MAAM,iBAAiB;GACtE,CAAC,CACC,WAAW;GAAE,QAAQ,YAAY,WAAW,KAAK,IAAK;GAAE,UAAU,QAAQ;GAAM,QAAQ,UAAU;GAAM,CAAC,CACzG,MAAM;AAET,SAAO;;;;;;;;;;CAWT,MAAa,8BAA8B;AACzC,MAAI,CAAE,MAAM,KAAK,eAAe,YAAY,CAC1C,OAAM,IAAI,MAAM,iEAAiE;EAGnF,MAAM,sBADkB,MAAM,KAAK,eAAe,MAAM,SAAS,EACtB,MAAM,QAAQ,MAAM,EAAE,YAAY,UAAU,CAAC,KAAK,MAAM,EAAE,KAAK;AAC1G,MAAI,mBAAmB,SAAS,GAAG;GACjC,MAAM,YAAY,MAAM,KAAK,kBAAkB,8BAA8B,mBAAmB,GAAG;AACnG,OAAI,UACF,QAAO;;AAIX,QAAM,IAAI,MAAM,wFAAwF"}

package/lifecycle-events.d.ts

@@ -0,0 +1,14 @@
+import { AVMTracesEventData, TealSourcesDebugEventData } from "./debugging.js";
+
+//#region src/lifecycle-events.d.ts
+declare enum EventType {
+  TxnGroupSimulated = "TxnGroupSimulated",
+  AppCompiled = "AppCompiled",
+}
+type EventDataMap = {
+  [EventType.TxnGroupSimulated]: AVMTracesEventData;
+  [EventType.AppCompiled]: TealSourcesDebugEventData;
+};
+//#endregion
+export { EventDataMap, EventType };
+//# sourceMappingURL=lifecycle-events.d.ts.map

package/lifecycle-events.js

@@ -0,0 +1,11 @@
+
+//#region src/lifecycle-events.ts
+let EventType = /* @__PURE__ */ function(EventType$1) {
+	EventType$1["TxnGroupSimulated"] = "TxnGroupSimulated";
+	EventType$1["AppCompiled"] = "AppCompiled";
+	return EventType$1;
+}({});
+
+//#endregion
+exports.EventType = EventType;
+//# sourceMappingURL=lifecycle-events.js.map

package/lifecycle-events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lifecycle-events.js","names":[],"sources":["../src/lifecycle-events.ts"],"sourcesContent":["import { AVMTracesEventData, TealSourcesDebugEventData } from './debugging'\n\nexport enum EventType {\n  TxnGroupSimulated = 'TxnGroupSimulated',\n  AppCompiled = 'AppCompiled',\n}\n\nexport type EventDataMap = {\n  [EventType.TxnGroupSimulated]: AVMTracesEventData\n  [EventType.AppCompiled]: TealSourcesDebugEventData\n}\n"],"mappings":";;AAEA,IAAY,kDAAL;AACL;AACA"}

package/lifecycle-events.mjs

@@ -0,0 +1,10 @@
+//#region src/lifecycle-events.ts
+let EventType = /* @__PURE__ */ function(EventType$1) {
+	EventType$1["TxnGroupSimulated"] = "TxnGroupSimulated";
+	EventType$1["AppCompiled"] = "AppCompiled";
+	return EventType$1;
+}({});
+
+//#endregion
+export { EventType };
+//# sourceMappingURL=lifecycle-events.mjs.map

package/lifecycle-events.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"lifecycle-events.mjs","names":[],"sources":["../src/lifecycle-events.ts"],"sourcesContent":["import { AVMTracesEventData, TealSourcesDebugEventData } from './debugging'\n\nexport enum EventType {\n  TxnGroupSimulated = 'TxnGroupSimulated',\n  AppCompiled = 'AppCompiled',\n}\n\nexport type EventDataMap = {\n  [EventType.TxnGroupSimulated]: AVMTracesEventData\n  [EventType.AppCompiled]: TealSourcesDebugEventData\n}\n"],"mappings":";AAEA,IAAY,kDAAL;AACL;AACA"}

package/logging.d.ts

@@ -0,0 +1,13 @@
+import { Logger } from "./packages/common/src/logger.js";
+
+//#region src/logging.d.ts
+/** A logger implementation that writes to console */
+declare const consoleLogger: Logger;
+declare const infoConsoleLogger: Logger;
+declare const verboseConsoleLogger: Logger;
+declare const warningConsoleLogger: Logger;
+/** A logger implementation that does nothing */
+declare const nullLogger: Logger;
+//#endregion
+export { type Logger, consoleLogger, infoConsoleLogger, nullLogger, verboseConsoleLogger, warningConsoleLogger };
+//# sourceMappingURL=logging.d.ts.map

package/logging.js

@@ -0,0 +1,47 @@
+
+//#region src/logging.ts
+/** A logger implementation that writes to console */
+const consoleLogger = {
+	error: console.error,
+	warn: console.warn,
+	info: console.info,
+	verbose: () => {},
+	debug: console.debug
+};
+const infoConsoleLogger = {
+	error: console.error,
+	warn: console.warn,
+	info: console.info,
+	verbose: () => {},
+	debug: () => {}
+};
+const verboseConsoleLogger = {
+	error: console.error,
+	warn: console.warn,
+	info: console.info,
+	verbose: console.trace,
+	debug: console.debug
+};
+const warningConsoleLogger = {
+	error: console.error,
+	warn: console.warn,
+	info: () => {},
+	verbose: () => {},
+	debug: () => {}
+};
+/** A logger implementation that does nothing */
+const nullLogger = {
+	error: function(message, ...optionalParams) {},
+	warn: function(message, ...optionalParams) {},
+	info: function(message, ...optionalParams) {},
+	verbose: function(message, ...optionalParams) {},
+	debug: function(message, ...optionalParams) {}
+};
+
+//#endregion
+exports.consoleLogger = consoleLogger;
+exports.infoConsoleLogger = infoConsoleLogger;
+exports.nullLogger = nullLogger;
+exports.verboseConsoleLogger = verboseConsoleLogger;
+exports.warningConsoleLogger = warningConsoleLogger;
+//# sourceMappingURL=logging.js.map

package/logging.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logging.js","names":["consoleLogger: Logger","infoConsoleLogger: Logger","verboseConsoleLogger: Logger","warningConsoleLogger: Logger","nullLogger: Logger"],"sources":["../src/logging.ts"],"sourcesContent":["/* eslint-disable unused-imports/no-unused-vars */\n/* eslint-disable no-console */\n\nimport type { Logger } from '@algorandfoundation/algokit-common'\nexport type { Logger } from '@algorandfoundation/algokit-common'\n\n/** A logger implementation that writes to console */\nexport const consoleLogger: Logger = {\n  error: console.error,\n  warn: console.warn,\n  info: console.info,\n  verbose: () => {},\n  debug: console.debug,\n}\n\nexport const infoConsoleLogger: Logger = {\n  error: console.error,\n  warn: console.warn,\n  info: console.info,\n  verbose: () => {},\n  debug: () => {},\n}\n\nexport const verboseConsoleLogger: Logger = {\n  error: console.error,\n  warn: console.warn,\n  info: console.info,\n  verbose: console.trace,\n  debug: console.debug,\n}\n\nexport const warningConsoleLogger: Logger = {\n  error: console.error,\n  warn: console.warn,\n  info: () => {},\n  verbose: () => {},\n  debug: () => {},\n}\n\n/** A logger implementation that does nothing */\nexport const nullLogger: Logger = {\n  error: function (message: string, ...optionalParams: unknown[]): void {},\n  warn: function (message: string, ...optionalParams: unknown[]): void {},\n  info: function (message: string, ...optionalParams: unknown[]): void {},\n  verbose: function (message: string, ...optionalParams: unknown[]): void {},\n  debug: function (message: string, ...optionalParams: unknown[]): void {},\n}\n"],"mappings":";;;AAOA,MAAaA,gBAAwB;CACnC,OAAO,QAAQ;CACf,MAAM,QAAQ;CACd,MAAM,QAAQ;CACd,eAAe;CACf,OAAO,QAAQ;CAChB;AAED,MAAaC,oBAA4B;CACvC,OAAO,QAAQ;CACf,MAAM,QAAQ;CACd,MAAM,QAAQ;CACd,eAAe;CACf,aAAa;CACd;AAED,MAAaC,uBAA+B;CAC1C,OAAO,QAAQ;CACf,MAAM,QAAQ;CACd,MAAM,QAAQ;CACd,SAAS,QAAQ;CACjB,OAAO,QAAQ;CAChB;AAED,MAAaC,uBAA+B;CAC1C,OAAO,QAAQ;CACf,MAAM,QAAQ;CACd,YAAY;CACZ,eAAe;CACf,aAAa;CACd;;AAGD,MAAaC,aAAqB;CAChC,OAAO,SAAU,SAAiB,GAAG,gBAAiC;CACtE,MAAM,SAAU,SAAiB,GAAG,gBAAiC;CACrE,MAAM,SAAU,SAAiB,GAAG,gBAAiC;CACrE,SAAS,SAAU,SAAiB,GAAG,gBAAiC;CACxE,OAAO,SAAU,SAAiB,GAAG,gBAAiC;CACvE"}

package/logging.mjs

@@ -0,0 +1,42 @@
+//#region src/logging.ts
+/** A logger implementation that writes to console */
+const consoleLogger = {
+	error: console.error,
+	warn: console.warn,
+	info: console.info,
+	verbose: () => {},
+	debug: console.debug
+};
+const infoConsoleLogger = {
+	error: console.error,
+	warn: console.warn,
+	info: console.info,
+	verbose: () => {},
+	debug: () => {}
+};
+const verboseConsoleLogger = {
+	error: console.error,
+	warn: console.warn,
+	info: console.info,
+	verbose: console.trace,
+	debug: console.debug
+};
+const warningConsoleLogger = {
+	error: console.error,
+	warn: console.warn,
+	info: () => {},
+	verbose: () => {},
+	debug: () => {}
+};
+/** A logger implementation that does nothing */
+const nullLogger = {
+	error: function(message, ...optionalParams) {},
+	warn: function(message, ...optionalParams) {},
+	info: function(message, ...optionalParams) {},
+	verbose: function(message, ...optionalParams) {},
+	debug: function(message, ...optionalParams) {}
+};
+
+//#endregion
+export { consoleLogger, infoConsoleLogger, nullLogger, verboseConsoleLogger, warningConsoleLogger };
+//# sourceMappingURL=logging.mjs.map

package/logging.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"logging.mjs","names":["consoleLogger: Logger","infoConsoleLogger: Logger","verboseConsoleLogger: Logger","warningConsoleLogger: Logger","nullLogger: Logger"],"sources":["../src/logging.ts"],"sourcesContent":["/* eslint-disable unused-imports/no-unused-vars */\n/* eslint-disable no-console */\n\nimport type { Logger } from '@algorandfoundation/algokit-common'\nexport type { Logger } from '@algorandfoundation/algokit-common'\n\n/** A logger implementation that writes to console */\nexport const consoleLogger: Logger = {\n  error: console.error,\n  warn: console.warn,\n  info: console.info,\n  verbose: () => {},\n  debug: console.debug,\n}\n\nexport const infoConsoleLogger: Logger = {\n  error: console.error,\n  warn: console.warn,\n  info: console.info,\n  verbose: () => {},\n  debug: () => {},\n}\n\nexport const verboseConsoleLogger: Logger = {\n  error: console.error,\n  warn: console.warn,\n  info: console.info,\n  verbose: console.trace,\n  debug: console.debug,\n}\n\nexport const warningConsoleLogger: Logger = {\n  error: console.error,\n  warn: console.warn,\n  info: () => {},\n  verbose: () => {},\n  debug: () => {},\n}\n\n/** A logger implementation that does nothing */\nexport const nullLogger: Logger = {\n  error: function (message: string, ...optionalParams: unknown[]): void {},\n  warn: function (message: string, ...optionalParams: unknown[]): void {},\n  info: function (message: string, ...optionalParams: unknown[]): void {},\n  verbose: function (message: string, ...optionalParams: unknown[]): void {},\n  debug: function (message: string, ...optionalParams: unknown[]): void {},\n}\n"],"mappings":";;AAOA,MAAaA,gBAAwB;CACnC,OAAO,QAAQ;CACf,MAAM,QAAQ;CACd,MAAM,QAAQ;CACd,eAAe;CACf,OAAO,QAAQ;CAChB;AAED,MAAaC,oBAA4B;CACvC,OAAO,QAAQ;CACf,MAAM,QAAQ;CACd,MAAM,QAAQ;CACd,eAAe;CACf,aAAa;CACd;AAED,MAAaC,uBAA+B;CAC1C,OAAO,QAAQ;CACf,MAAM,QAAQ;CACd,MAAM,QAAQ;CACd,SAAS,QAAQ;CACjB,OAAO,QAAQ;CAChB;AAED,MAAaC,uBAA+B;CAC1C,OAAO,QAAQ;CACf,MAAM,QAAQ;CACd,YAAY;CACZ,eAAe;CACf,aAAa;CACd;;AAGD,MAAaC,aAAqB;CAChC,OAAO,SAAU,SAAiB,GAAG,gBAAiC;CACtE,MAAM,SAAU,SAAiB,GAAG,gBAAiC;CACrE,MAAM,SAAU,SAAiB,GAAG,gBAAiC;CACrE,SAAS,SAAU,SAAiB,GAAG,gBAAiC;CACxE,OAAO,SAAU,SAAiB,GAAG,gBAAiC;CACvE"}

package/logic-error.d.ts

@@ -0,0 +1,39 @@
+//#region src/logic-error.d.ts
+/**
+ * Details about a smart contract logic error
+ */
+interface LogicErrorDetails {
+  /** The ID of the transaction with the logic error */
+  txId: string;
+  /** The program counter where the error was */
+  pc: number;
+  /** The error message */
+  msg: string;
+  /** The full error description */
+  desc: string;
+  /** Any trace information included in the error */
+  traces: Record<string, unknown>[];
+}
+/** Wraps key functionality around processing logic errors */
+declare class LogicError extends Error {
+  /** Takes an error message and parses out the details of any logic errors in there.
+   * @param error The error message to parse
+   * @returns The logic error details if any, or undefined
+   */
+  static parseLogicError(error: any): LogicErrorDetails | undefined;
+  led: LogicErrorDetails;
+  program: string[];
+  lines: number;
+  teal_line: number;
+  stack?: string;
+  /**
+   * Create a new logic error object.
+   * @param errorDetails The details of the logic error
+   * @param program The TEAL source code, split by line
+   * @param getLineForPc The source map of the TEAL source code
+   */
+  constructor(errorDetails: LogicErrorDetails, program: string[], getLineForPc: (pc: number) => number | undefined);
+}
+//#endregion
+export { LogicError, LogicErrorDetails };
+//# sourceMappingURL=logic-error.d.ts.map

package/logic-error.js

@@ -0,0 +1,54 @@
+
+//#region src/logic-error.ts
+const LOGIC_ERROR = /transaction ([A-Z0-9]+): logic eval error: (.*). Details: .*pc=([0-9]+).*/;
+const INNER_LOGIC_ERROR = /inner tx (\d+) failed:.*?pc=([0-9]+)/;
+/** Wraps key functionality around processing logic errors */
+var LogicError = class extends Error {
+	/** Takes an error message and parses out the details of any logic errors in there.
+	* @param error The error message to parse
+	* @returns The logic error details if any, or undefined
+	*/
+	static parseLogicError(error) {
+		const errorMessage = error.message;
+		const res = LOGIC_ERROR.exec(errorMessage);
+		const innerRes = INNER_LOGIC_ERROR.exec(errorMessage);
+		if (res === null || res.length <= 3) return void 0;
+		return {
+			txId: res[1],
+			msg: res[2],
+			desc: errorMessage,
+			pc: parseInt(innerRes?.[2] ?? res[3] ?? "0"),
+			traces: error.traces
+		};
+	}
+	led;
+	program;
+	lines = 5;
+	teal_line = 0;
+	stack;
+	/**
+	* Create a new logic error object.
+	* @param errorDetails The details of the logic error
+	* @param program The TEAL source code, split by line
+	* @param getLineForPc The source map of the TEAL source code
+	*/
+	constructor(errorDetails, program, getLineForPc) {
+		super();
+		this.led = errorDetails;
+		this.program = program;
+		const line = getLineForPc(errorDetails.pc);
+		this.teal_line = line === void 0 ? 0 : line;
+		this.message = `${this.led.msg}. at:${line}. ${this.led.desc}`;
+		if (this.teal_line > 0) {
+			const start = this.teal_line > this.lines ? this.teal_line - this.lines : 0;
+			const stop = program.length > this.teal_line + this.lines ? this.teal_line + this.lines : program.length;
+			const stack_lines = program.slice(start, stop);
+			stack_lines[stack_lines.length / 2] += " <--- Error";
+			this.stack = stack_lines.join("\n");
+		}
+	}
+};
+
+//#endregion
+exports.LogicError = LogicError;
+//# sourceMappingURL=logic-error.js.map