@algorandfoundation/algokit-utils 10.0.0-alpha.4 → 10.0.0-alpha.41

package/{indexer-lookup.js → indexer-client/indexer-lookup.mjs}

@@ -1,12 +1,4 @@
-const require_rolldown_runtime = require('./_virtual/rolldown_runtime.js');
-
-//#region src/indexer-lookup.ts
-var indexer_lookup_exports = /* @__PURE__ */ require_rolldown_runtime.__export({
-	executePaginatedRequest: () => executePaginatedRequest,
-	lookupAccountCreatedApplicationByAddress: () => lookupAccountCreatedApplicationByAddress,
-	lookupAssetHoldings: () => lookupAssetHoldings,
-	searchTransactions: () => searchTransactions
-});
+//#region src/indexer-client/indexer-lookup.ts
 const DEFAULT_INDEXER_MAX_API_RESOURCES_PER_ACCOUNT = 1e3;
 /**
 * Looks up applications that were created by the given address; will automatically paginate through all data.
@@ -100,12 +92,5 @@ async function executePaginatedRequest(extractItems, buildRequest) {
 }
 
 //#endregion
-Object.defineProperty(exports, 'indexer_lookup_exports', {
-  enumerable: true,
-  get: function () {
-    return indexer_lookup_exports;
-  }
-});
-exports.lookupAccountCreatedApplicationByAddress = lookupAccountCreatedApplicationByAddress;
-exports.searchTransactions = searchTransactions;
-//# sourceMappingURL=indexer-lookup.js.map
+export { executePaginatedRequest, lookupAccountCreatedApplicationByAddress, lookupAssetHoldings, searchTransactions };
+//# sourceMappingURL=indexer-lookup.mjs.map

package/indexer-client/indexer-lookup.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexer-lookup.mjs","names":[],"sources":["../../src/indexer-client/indexer-lookup.ts"],"sourcesContent":["import { Address } from '@algorandfoundation/algokit-common'\nimport {\n  Application,\n  ApplicationsResponse,\n  AssetBalancesResponse,\n  IndexerClient,\n  MiniAssetHolding,\n  TransactionsResponse,\n} from '@algorandfoundation/algokit-indexer-client'\nimport { LookupAssetHoldingsOptions } from '../indexer'\nexport type SearchForTransactionsCriteria = Omit<NonNullable<Parameters<IndexerClient['searchForTransactions']>[0]>, 'limit' | 'next'>\n\nconst DEFAULT_INDEXER_MAX_API_RESOURCES_PER_ACCOUNT = 1000 //MaxAPIResourcesPerAccount: This is the default maximum, though may be provider specific\n\n/**\n * Looks up applications that were created by the given address; will automatically paginate through all data.\n * @param indexer An indexer instance\n * @param address The address of the creator to look up\n * @param getAll Whether or not to include deleted applications. Default true.\n * @param paginationLimit The number of records to return per paginated request, default 1000\n * @returns The list of application results\n */\nexport async function lookupAccountCreatedApplicationByAddress(\n  indexer: IndexerClient,\n  address: string | Address,\n  getAll: boolean = true,\n  paginationLimit?: number,\n): Promise<Application[]> {\n  return await executePaginatedRequest(\n    (response: ApplicationsResponse | { message: string }) => {\n      if ('message' in response) {\n        throw { status: 404, ...response }\n      }\n      return response.applications\n    },\n    (nextToken) => {\n      return indexer.lookupAccountCreatedApplications(address, {\n        includeAll: getAll,\n        limit: paginationLimit ?? DEFAULT_INDEXER_MAX_API_RESOURCES_PER_ACCOUNT,\n        ...(nextToken && { next: nextToken }),\n      })\n    },\n  )\n}\n\n/**\n * Looks up asset holdings for the given asset; will automatically paginate through all data.\n * @param indexer An indexer instance\n * @param assetId The ID of the asset to look up holdings for\n * @param options Optional options to control the lookup\n * @param paginationLimit The number of records to return per paginated request, default 1000\n * @returns The list of application results\n */\nexport async function lookupAssetHoldings(\n  indexer: IndexerClient,\n  assetId: number | bigint,\n  options?: LookupAssetHoldingsOptions,\n  paginationLimit?: number,\n): Promise<MiniAssetHolding[]> {\n  return await executePaginatedRequest(\n    (response: AssetBalancesResponse | { message: string }) => {\n      if ('message' in response) {\n        throw { status: 404, ...response }\n      }\n      return response.balances\n    },\n    (nextToken) => {\n      return indexer.lookupAssetBalances(assetId, {\n        limit: paginationLimit ?? DEFAULT_INDEXER_MAX_API_RESOURCES_PER_ACCOUNT,\n        ...(options?.currencyGreaterThan !== undefined && { currencyGreaterThan: options.currencyGreaterThan }),\n        ...(options?.currencyLessThan !== undefined && { currencyLessThan: options.currencyLessThan }),\n        ...(options?.includeAll !== undefined && { includeAll: options.includeAll }),\n        ...(nextToken && { next: nextToken }),\n      })\n    },\n  )\n}\n\n/**\n * Allows transactions to be searched for the given criteria.\n * @param indexer An indexer client\n * @param searchCriteria The criteria to search for\n * @param paginationLimit The number of records to return per paginated request, default 1000\n * @returns The search results\n */\nexport async function searchTransactions(\n  indexer: IndexerClient,\n  searchCriteria: SearchForTransactionsCriteria,\n  paginationLimit?: number,\n): Promise<TransactionsResponse> {\n  let currentRound = 0n\n  const transactions = await executePaginatedRequest(\n    (response: TransactionsResponse | { message: string }) => {\n      if ('message' in response) {\n        throw { status: 404, ...response }\n      }\n      if (response.currentRound > currentRound) {\n        currentRound = response.currentRound\n      }\n      return response.transactions\n    },\n    (nextToken) => {\n      return indexer.searchForTransactions({\n        ...searchCriteria,\n        limit: paginationLimit ?? DEFAULT_INDEXER_MAX_API_RESOURCES_PER_ACCOUNT,\n        next: nextToken,\n      })\n    },\n  )\n\n  return {\n    currentRound,\n    nextToken: undefined,\n    transactions,\n  } satisfies TransactionsResponse\n}\n\n// https://dev.algorand.co/reference/rest-apis/indexer\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport async function executePaginatedRequest<TResult, TRequest extends Promise<any>>(\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  extractItems: (response: any) => TResult[],\n  buildRequest: (nextToken?: string) => TRequest,\n): Promise<TResult[]> {\n  const results = []\n\n  let nextToken: string | undefined = undefined\n  while (true) {\n    const request = buildRequest(nextToken)\n    const response = await request\n    const items = extractItems(response)\n    if (items == null || items.length === 0) {\n      break\n    }\n    results.push(...items)\n    nextToken = response['nextToken']\n    if (!nextToken) {\n      break\n    }\n  }\n\n  return results\n}\n"],"mappings":";AAYA,MAAM,gDAAgD;;;;;;;;;AAUtD,eAAsB,yCACpB,SACA,SACA,SAAkB,MAClB,iBACwB;AACxB,QAAO,MAAM,yBACV,aAAyD;AACxD,MAAI,aAAa,SACf,OAAM;GAAE,QAAQ;GAAK,GAAG;GAAU;AAEpC,SAAO,SAAS;KAEjB,cAAc;AACb,SAAO,QAAQ,iCAAiC,SAAS;GACvD,YAAY;GACZ,OAAO,mBAAmB;GAC1B,GAAI,aAAa,EAAE,MAAM,WAAW;GACrC,CAAC;GAEL;;;;;;;;;;AAWH,eAAsB,oBACpB,SACA,SACA,SACA,iBAC6B;AAC7B,QAAO,MAAM,yBACV,aAA0D;AACzD,MAAI,aAAa,SACf,OAAM;GAAE,QAAQ;GAAK,GAAG;GAAU;AAEpC,SAAO,SAAS;KAEjB,cAAc;AACb,SAAO,QAAQ,oBAAoB,SAAS;GAC1C,OAAO,mBAAmB;GAC1B,GAAI,SAAS,wBAAwB,UAAa,EAAE,qBAAqB,QAAQ,qBAAqB;GACtG,GAAI,SAAS,qBAAqB,UAAa,EAAE,kBAAkB,QAAQ,kBAAkB;GAC7F,GAAI,SAAS,eAAe,UAAa,EAAE,YAAY,QAAQ,YAAY;GAC3E,GAAI,aAAa,EAAE,MAAM,WAAW;GACrC,CAAC;GAEL;;;;;;;;;AAUH,eAAsB,mBACpB,SACA,gBACA,iBAC+B;CAC/B,IAAI,eAAe;CACnB,MAAM,eAAe,MAAM,yBACxB,aAAyD;AACxD,MAAI,aAAa,SACf,OAAM;GAAE,QAAQ;GAAK,GAAG;GAAU;AAEpC,MAAI,SAAS,eAAe,aAC1B,gBAAe,SAAS;AAE1B,SAAO,SAAS;KAEjB,cAAc;AACb,SAAO,QAAQ,sBAAsB;GACnC,GAAG;GACH,OAAO,mBAAmB;GAC1B,MAAM;GACP,CAAC;GAEL;AAED,QAAO;EACL;EACA,WAAW;EACX;EACD;;AAKH,eAAsB,wBAEpB,cACA,cACoB;CACpB,MAAM,UAAU,EAAE;CAElB,IAAI,YAAgC;AACpC,QAAO,MAAM;EAEX,MAAM,WAAW,MADD,aAAa,UAAU;EAEvC,MAAM,QAAQ,aAAa,SAAS;AACpC,MAAI,SAAS,QAAQ,MAAM,WAAW,EACpC;AAEF,UAAQ,KAAK,GAAG,MAAM;AACtB,cAAY,SAAS;AACrB,MAAI,CAAC,UACH;;AAIJ,QAAO"}

package/indexer.d.ts

@@ -0,0 +1,40 @@
+//#region src/indexer.d.ts
+/** Options when looking up an asset's account holdings, https://dev.algorand.co/reference/rest-apis/indexer#get-v2assetsasset-idbalances */
+interface LookupAssetHoldingsOptions {
+  /** Results should have a decimal units amount less than this value. */
+  currencyLessThan?: number | bigint;
+  /** Results should have a decimal units amount greater than this value. */
+  currencyGreaterThan?: number | bigint;
+  /** Include all items including closed accounts and opted-out asset holdings. */
+  includeAll?: boolean;
+}
+/** Defines the what additional actions occur with the transaction https://dev.algorand.co/reference/rest-apis/indexer/#oncompletion */
+declare enum ApplicationOnComplete {
+  noop = "noop",
+  optin = "optin",
+  closeout = "closeout",
+  clear = "clear",
+  update = "update",
+  delete = "delete",
+}
+/** Type of signature used by an account */
+declare enum SignatureType {
+  /** Normal signature */
+  sig = "sig",
+  /** Multisig */
+  msig = "msig",
+  /** Logic signature */
+  lsig = "lsig",
+}
+/** Delegation status of the account */
+declare enum AccountStatus {
+  /** Indicates that the associated account is delegated */
+  Offline = "Offline",
+  /** Indicates that the associated account used as part of the delegation pool */
+  Online = "Online",
+  /** Indicates that the associated account is neither a delegator nor a delegate */
+  NotParticipating = "NotParticipating",
+}
+//#endregion
+export { AccountStatus, ApplicationOnComplete, LookupAssetHoldingsOptions, SignatureType };
+//# sourceMappingURL=indexer.d.ts.map

package/indexer.js

@@ -0,0 +1,39 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+
+//#region src/indexer.ts
+/** Defines the what additional actions occur with the transaction https://dev.algorand.co/reference/rest-apis/indexer/#oncompletion */
+let ApplicationOnComplete = /* @__PURE__ */ function(ApplicationOnComplete) {
+	ApplicationOnComplete["noop"] = "noop";
+	ApplicationOnComplete["optin"] = "optin";
+	ApplicationOnComplete["closeout"] = "closeout";
+	ApplicationOnComplete["clear"] = "clear";
+	ApplicationOnComplete["update"] = "update";
+	ApplicationOnComplete["delete"] = "delete";
+	return ApplicationOnComplete;
+}({});
+/** Type of signature used by an account */
+let SignatureType = /* @__PURE__ */ function(SignatureType) {
+	/** Normal signature */
+	SignatureType["sig"] = "sig";
+	/** Multisig */
+	SignatureType["msig"] = "msig";
+	/** Logic signature */
+	SignatureType["lsig"] = "lsig";
+	return SignatureType;
+}({});
+/** Delegation status of the account */
+let AccountStatus = /* @__PURE__ */ function(AccountStatus) {
+	/** Indicates that the associated account is delegated */
+	AccountStatus["Offline"] = "Offline";
+	/** Indicates that the associated account used as part of the delegation pool */
+	AccountStatus["Online"] = "Online";
+	/** Indicates that the associated account is neither a delegator nor a delegate */
+	AccountStatus["NotParticipating"] = "NotParticipating";
+	return AccountStatus;
+}({});
+
+//#endregion
+exports.AccountStatus = AccountStatus;
+exports.ApplicationOnComplete = ApplicationOnComplete;
+exports.SignatureType = SignatureType;
+//# sourceMappingURL=indexer.js.map

package/indexer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexer.js","names":[],"sources":["../src/indexer.ts"],"sourcesContent":["/** Options when looking up an asset's account holdings, https://dev.algorand.co/reference/rest-apis/indexer#get-v2assetsasset-idbalances */\nexport interface LookupAssetHoldingsOptions {\n  /** Results should have a decimal units amount less than this value. */\n  currencyLessThan?: number | bigint\n  /** Results should have a decimal units amount greater than this value. */\n  currencyGreaterThan?: number | bigint\n  /** Include all items including closed accounts and opted-out asset holdings. */\n  includeAll?: boolean\n}\n\n/** Defines the what additional actions occur with the transaction https://dev.algorand.co/reference/rest-apis/indexer/#oncompletion */\nexport enum ApplicationOnComplete {\n  noop = 'noop',\n  optin = 'optin',\n  closeout = 'closeout',\n  clear = 'clear',\n  update = 'update',\n  delete = 'delete',\n}\n\n/** Type of signature used by an account */\nexport enum SignatureType {\n  /** Normal signature */\n  sig = 'sig',\n  /** Multisig */\n  msig = 'msig',\n  /** Logic signature */\n  lsig = 'lsig',\n}\n\n/** Delegation status of the account */\nexport enum AccountStatus {\n  /** Indicates that the associated account is delegated */\n  Offline = 'Offline',\n  /** Indicates that the associated account used as part of the delegation pool */\n  Online = 'Online',\n  /** Indicates that the associated account is neither a delegator nor a delegate */\n  NotParticipating = 'NotParticipating',\n}\n"],"mappings":";;;;AAWA,IAAY,wEAAL;AACL;AACA;AACA;AACA;AACA;AACA;;;;AAIF,IAAY,wDAAL;;AAEL;;AAEA;;AAEA;;;;AAIF,IAAY,wDAAL;;AAEL;;AAEA;;AAEA"}

package/indexer.mjs

@@ -0,0 +1,35 @@
+//#region src/indexer.ts
+/** Defines the what additional actions occur with the transaction https://dev.algorand.co/reference/rest-apis/indexer/#oncompletion */
+let ApplicationOnComplete = /* @__PURE__ */ function(ApplicationOnComplete) {
+	ApplicationOnComplete["noop"] = "noop";
+	ApplicationOnComplete["optin"] = "optin";
+	ApplicationOnComplete["closeout"] = "closeout";
+	ApplicationOnComplete["clear"] = "clear";
+	ApplicationOnComplete["update"] = "update";
+	ApplicationOnComplete["delete"] = "delete";
+	return ApplicationOnComplete;
+}({});
+/** Type of signature used by an account */
+let SignatureType = /* @__PURE__ */ function(SignatureType) {
+	/** Normal signature */
+	SignatureType["sig"] = "sig";
+	/** Multisig */
+	SignatureType["msig"] = "msig";
+	/** Logic signature */
+	SignatureType["lsig"] = "lsig";
+	return SignatureType;
+}({});
+/** Delegation status of the account */
+let AccountStatus = /* @__PURE__ */ function(AccountStatus) {
+	/** Indicates that the associated account is delegated */
+	AccountStatus["Offline"] = "Offline";
+	/** Indicates that the associated account used as part of the delegation pool */
+	AccountStatus["Online"] = "Online";
+	/** Indicates that the associated account is neither a delegator nor a delegate */
+	AccountStatus["NotParticipating"] = "NotParticipating";
+	return AccountStatus;
+}({});
+
+//#endregion
+export { AccountStatus, ApplicationOnComplete, SignatureType };
+//# sourceMappingURL=indexer.mjs.map

package/indexer.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexer.mjs","names":[],"sources":["../src/indexer.ts"],"sourcesContent":["/** Options when looking up an asset's account holdings, https://dev.algorand.co/reference/rest-apis/indexer#get-v2assetsasset-idbalances */\nexport interface LookupAssetHoldingsOptions {\n  /** Results should have a decimal units amount less than this value. */\n  currencyLessThan?: number | bigint\n  /** Results should have a decimal units amount greater than this value. */\n  currencyGreaterThan?: number | bigint\n  /** Include all items including closed accounts and opted-out asset holdings. */\n  includeAll?: boolean\n}\n\n/** Defines the what additional actions occur with the transaction https://dev.algorand.co/reference/rest-apis/indexer/#oncompletion */\nexport enum ApplicationOnComplete {\n  noop = 'noop',\n  optin = 'optin',\n  closeout = 'closeout',\n  clear = 'clear',\n  update = 'update',\n  delete = 'delete',\n}\n\n/** Type of signature used by an account */\nexport enum SignatureType {\n  /** Normal signature */\n  sig = 'sig',\n  /** Multisig */\n  msig = 'msig',\n  /** Logic signature */\n  lsig = 'lsig',\n}\n\n/** Delegation status of the account */\nexport enum AccountStatus {\n  /** Indicates that the associated account is delegated */\n  Offline = 'Offline',\n  /** Indicates that the associated account used as part of the delegation pool */\n  Online = 'Online',\n  /** Indicates that the associated account is neither a delegator nor a delegate */\n  NotParticipating = 'NotParticipating',\n}\n"],"mappings":";;AAWA,IAAY,wEAAL;AACL;AACA;AACA;AACA;AACA;AACA;;;;AAIF,IAAY,wDAAL;;AAEL;;AAEA;;AAEA;;;;AAIF,IAAY,wDAAL;;AAEL;;AAEA;;AAEA"}

package/instance-of.d.ts

@@ -0,0 +1,8 @@
+//#region src/instance-of.d.ts
+/**
+ * A type that represents the interface of the class given as the generic parameter
+ */
+type InterfaceOf<ClassType> = { [Member in keyof ClassType]: ClassType[Member] };
+//#endregion
+export { InterfaceOf };
+//# sourceMappingURL=instance-of.d.ts.map

package/kmd-account-manager.d.ts

@@ -0,0 +1,74 @@
+import { Address } from "./packages/common/src/address.js";
+import { AddressWithTransactionSigner } from "./packages/transact/src/signer.js";
+import { Account } from "./packages/algod_client/src/models/account.js";
+import { AlgoAmount } from "./amount.js";
+import { KmdClient } from "./packages/kmd_client/src/client.js";
+import { ClientManager } from "./client-manager.js";
+
+//#region src/kmd-account-manager.d.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. */
+declare class KmdAccountManager {
+  private _clientManager;
+  private _kmd?;
+  /**
+   * Create a new KMD manager.
+   * @param clientManager A ClientManager client to use for algod and kmd clients
+   */
+  constructor(clientManager: ClientManager);
+  kmd(): Promise<KmdClient>;
+  /**
+   * 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
+   */
+  getWalletAccount(walletName: string, predicate?: (account: Account) => boolean, sender?: string | Address): Promise<AddressWithTransactionSigner | undefined>;
+  private findWalletAccount;
+  /**
+   * 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
+   */
+  getOrCreateWalletAccount(name: string, fundWith?: AlgoAmount): Promise<AddressWithTransactionSigner>;
+  /**
+   * 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
+   */
+  getLocalNetDispenserAccount(): Promise<AddressWithTransactionSigner>;
+}
+//#endregion
+export { KmdAccountManager };
+//# sourceMappingURL=kmd-account-manager.d.ts.map

package/kmd-account-manager.js

@@ -0,0 +1,168 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_runtime = require('./_virtual/_rolldown/runtime.js');
+const require_address = require('./packages/common/src/address.js');
+const require_signer = require('./packages/transact/src/signer.js');
+const require_amount = require('./amount.js');
+const require_config = require('./config.js');
+const require_composer = require('./composer.js');
+const require_client_manager = require('./client-manager.js');
+let tweetnacl = require("tweetnacl");
+tweetnacl = require_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","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,IAAI,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 { generateAddressWithSigners } from "./packages/transact/src/signer.mjs";
+import { AlgoAmount } from "./amount.mjs";
+import { Config } from "./config.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":[],"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,IAAI,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"}