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

package/dispenser-client.mjs

@@ -0,0 +1,127 @@
+import { asJson } from "./util.mjs";
+
+//#region src/dispenser-client.ts
+const DISPENSER_BASE_URL = "https://api.dispenser.algorandfoundation.tools";
+const DEFAULT_DISPENSER_REQUEST_TIMEOUT = 15;
+const DISPENSER_ACCESS_TOKEN_KEY = "ALGOKIT_DISPENSER_ACCESS_TOKEN";
+var DispenserAssetName = /* @__PURE__ */ function(DispenserAssetName$1) {
+	DispenserAssetName$1[DispenserAssetName$1["Algo"] = 0] = "Algo";
+	return DispenserAssetName$1;
+}(DispenserAssetName || {});
+const dispenserAssets = { [DispenserAssetName.Algo]: {
+	assetId: 0,
+	decimals: 6,
+	description: "Algo"
+} };
+/**
+* `TestNetDispenserApiClient` is a class that provides methods to interact with the [Algorand TestNet Dispenser API](https://github.com/algorandfoundation/algokit/blob/main/docs/testnet_api.md).
+* It allows you to fund an address with Algo, refund a transaction, and get the funding limit for the Algo asset.
+*
+* The class requires an authentication token and a request timeout to be initialized. The authentication token can be provided
+* either directly as a parameter or through an `ALGOKIT_DISPENSER_ACCESS_TOKEN` environment variable. If neither is provided, an error is thrown.
+*
+* The request timeout can be provided as a parameter. If not provided, a default value is used.
+*
+* @property {string} authToken - The authentication token used for API requests.
+* @property {number} requestTimeout - The timeout for API requests, in seconds.
+*
+* @method fund - Sends a funding request to the dispenser API to fund the specified address with the given amount of Algo.
+* @method refund - Sends a refund request to the dispenser API for the specified refundTxnId.
+* @method limit - Sends a request to the dispenser API to get the funding limit for the Algo asset.
+*
+* @example
+* ```typescript
+* const client = new TestNetDispenserApiClient({ authToken: 'your_auth_token', requestTimeout: 30 });
+* const fundResponse = await client.fund('your_address', 100);
+* const limitResponse = await client.getLimit();
+* await client.refund('your_transaction_id');
+* ```
+*
+* @throws {Error} If neither the environment variable 'ALGOKIT_DISPENSER_ACCESS_TOKEN' nor the authToken parameter were provided.
+*/
+var TestNetDispenserApiClient = class {
+	_authToken;
+	_requestTimeout;
+	constructor(params) {
+		const authTokenFromEnv = process?.env?.[DISPENSER_ACCESS_TOKEN_KEY];
+		if (params?.authToken) this._authToken = params.authToken;
+		else if (authTokenFromEnv) this._authToken = authTokenFromEnv;
+		else throw new Error(`Can't init AlgoKit TestNet Dispenser API client because neither environment variable ${DISPENSER_ACCESS_TOKEN_KEY} or the authToken were provided.`);
+		this._requestTimeout = params?.requestTimeout || DEFAULT_DISPENSER_REQUEST_TIMEOUT;
+	}
+	get authToken() {
+		return this._authToken;
+	}
+	get requestTimeout() {
+		return this._requestTimeout;
+	}
+	/**
+	* Processes a dispenser API request.
+	*
+	* @param authToken - The authentication token.
+	* @param urlSuffix - The URL suffix for the API request.
+	* @param body - The request body.
+	* @param method - The HTTP method.
+	*
+	* @returns The API response.
+	*/
+	async processDispenserRequest(authToken, urlSuffix, body = null, method = "POST") {
+		const requestArgs = {
+			method,
+			headers: { Authorization: `Bearer ${authToken}` },
+			signal: AbortSignal.timeout(this.requestTimeout * 1e3)
+		};
+		if (body) requestArgs.body = asJson(body);
+		const response = await fetch(`${DISPENSER_BASE_URL}/${urlSuffix}`, requestArgs);
+		if (!response.ok) {
+			let error_message = `Error processing dispenser API request: ${response.status}`;
+			let error_response = null;
+			try {
+				error_response = await response.json();
+			} catch {}
+			if (error_response && error_response.code) error_message = error_response.code;
+			else if (response.status === 400) error_message = (await response.json()).message;
+			throw new Error(error_message);
+		}
+		return response;
+	}
+	/**
+	* Sends a funding request to the dispenser API to fund the specified address with the given amount of Algo.
+	*
+	* @param address - The address to fund.
+	* @param amount - The amount of µAlgo to fund.
+	*
+	* @returns DispenserFundResponse: An object containing the transaction ID and funded amount.
+	*/
+	async fund(address, amount) {
+		const content = await (await this.processDispenserRequest(this.authToken, `fund/${dispenserAssets[DispenserAssetName.Algo].assetId}`, {
+			receiver: typeof address === "string" ? address : address.toString(),
+			amount: Number(amount),
+			assetID: dispenserAssets[DispenserAssetName.Algo].assetId
+		}, "POST")).json();
+		return {
+			txId: content.txID,
+			amount: content.amount
+		};
+	}
+	/**
+	* Sends a refund request to the dispenser API for the specified refundTxnId.
+	*
+	* @param refundTxnId - The transaction ID to refund.
+	*/
+	async refund(refundTxnId) {
+		await this.processDispenserRequest(this.authToken, "refund", { refundTransactionID: refundTxnId }, "POST");
+	}
+	/**
+	* Sends a request to the dispenser API to get the funding limit for the Algo asset.
+	*
+	* @returns DispenserLimitResponse: An object containing the funding limit amount.
+	*/
+	async getLimit() {
+		return { amount: (await (await this.processDispenserRequest(this.authToken, `fund/${dispenserAssets[DispenserAssetName.Algo].assetId}/limit`, null, "GET")).json()).amount };
+	}
+};
+
+//#endregion
+export { TestNetDispenserApiClient };
+//# sourceMappingURL=dispenser-client.mjs.map

package/dispenser-client.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"dispenser-client.mjs","names":["requestArgs: RequestInit"],"sources":["../src/dispenser-client.ts"],"sourcesContent":["import { Address } from '@algorandfoundation/algokit-common'\nimport { asJson } from './util'\n\nconst DISPENSER_BASE_URL = 'https://api.dispenser.algorandfoundation.tools'\nconst DEFAULT_DISPENSER_REQUEST_TIMEOUT = 15\nconst DISPENSER_ACCESS_TOKEN_KEY = 'ALGOKIT_DISPENSER_ACCESS_TOKEN'\n\ninterface ErrorResponse {\n  code?: string\n}\n\nenum DispenserAssetName {\n  Algo = 0,\n}\n\nconst dispenserAssets = {\n  [DispenserAssetName.Algo]: {\n    assetId: 0,\n    decimals: 6,\n    description: 'Algo',\n  },\n}\n\n/** The TestNet Dispenser API response when funding. */\nexport interface DispenserFundResponse {\n  /** The ID of the transaction that was issued to fund the account. */\n  txId: string\n  /** The number of µAlgo that was funded. */\n  amount: number\n}\n\n/** The TestNet Dispenser API response when getting the current limit.  */\nexport interface DispenserLimitResponse {\n  /** The limit, in µAlgo, that you can currently fund. */\n  amount: number\n}\n\n/** The parameters to construct a TestNet Dispenser API client. */\nexport interface TestNetDispenserApiClientParams {\n  /** The API auth token */\n  authToken: string\n  /** The request timeout in seconds */\n  requestTimeout?: number\n}\n\n/**\n * `TestNetDispenserApiClient` is a class that provides methods to interact with the [Algorand TestNet Dispenser API](https://github.com/algorandfoundation/algokit/blob/main/docs/testnet_api.md).\n * It allows you to fund an address with Algo, refund a transaction, and get the funding limit for the Algo asset.\n *\n * The class requires an authentication token and a request timeout to be initialized. The authentication token can be provided\n * either directly as a parameter or through an `ALGOKIT_DISPENSER_ACCESS_TOKEN` environment variable. If neither is provided, an error is thrown.\n *\n * The request timeout can be provided as a parameter. If not provided, a default value is used.\n *\n * @property {string} authToken - The authentication token used for API requests.\n * @property {number} requestTimeout - The timeout for API requests, in seconds.\n *\n * @method fund - Sends a funding request to the dispenser API to fund the specified address with the given amount of Algo.\n * @method refund - Sends a refund request to the dispenser API for the specified refundTxnId.\n * @method limit - Sends a request to the dispenser API to get the funding limit for the Algo asset.\n *\n * @example\n * ```typescript\n * const client = new TestNetDispenserApiClient({ authToken: 'your_auth_token', requestTimeout: 30 });\n * const fundResponse = await client.fund('your_address', 100);\n * const limitResponse = await client.getLimit();\n * await client.refund('your_transaction_id');\n * ```\n *\n * @throws {Error} If neither the environment variable 'ALGOKIT_DISPENSER_ACCESS_TOKEN' nor the authToken parameter were provided.\n */\nexport class TestNetDispenserApiClient {\n  private _authToken: string\n  private _requestTimeout: number\n\n  constructor(params?: TestNetDispenserApiClientParams) {\n    const authTokenFromEnv = process?.env?.[DISPENSER_ACCESS_TOKEN_KEY]\n\n    if (params?.authToken) {\n      this._authToken = params.authToken\n    } else if (authTokenFromEnv) {\n      this._authToken = authTokenFromEnv\n    } else {\n      throw new Error(\n        `Can't init AlgoKit TestNet Dispenser API client because neither environment variable ${DISPENSER_ACCESS_TOKEN_KEY} or the authToken were provided.`,\n      )\n    }\n\n    this._requestTimeout = params?.requestTimeout || DEFAULT_DISPENSER_REQUEST_TIMEOUT\n  }\n\n  get authToken(): string {\n    return this._authToken\n  }\n\n  get requestTimeout(): number {\n    return this._requestTimeout\n  }\n\n  /**\n   * Processes a dispenser API request.\n   *\n   * @param authToken - The authentication token.\n   * @param urlSuffix - The URL suffix for the API request.\n   * @param body - The request body.\n   * @param method - The HTTP method.\n   *\n   * @returns The API response.\n   */\n  private async processDispenserRequest(\n    authToken: string,\n    urlSuffix: string,\n    body: Record<string, string | number> | null = null,\n    method = 'POST',\n  ): Promise<Response> {\n    const headers = { Authorization: `Bearer ${authToken}` }\n\n    const requestArgs: RequestInit = {\n      method: method,\n      headers: headers,\n      signal: AbortSignal.timeout(this.requestTimeout * 1000),\n    }\n\n    if (body) {\n      requestArgs.body = asJson(body)\n    }\n\n    const response = await fetch(`${DISPENSER_BASE_URL}/${urlSuffix}`, requestArgs)\n    if (!response.ok) {\n      let error_message = `Error processing dispenser API request: ${response.status}`\n      let error_response = null\n      try {\n        error_response = await response.json()\n      } catch {\n        // suppress exception\n      }\n\n      if (error_response && (error_response as ErrorResponse).code) {\n        error_message = (error_response as ErrorResponse).code!\n      } else if (response.status === 400) {\n        const errorResponse = (await response.json()) as { message: string }\n        error_message = errorResponse.message\n      }\n\n      throw new Error(error_message)\n    }\n    return response\n  }\n\n  /**\n   * Sends a funding request to the dispenser API to fund the specified address with the given amount of Algo.\n   *\n   * @param address - The address to fund.\n   * @param amount - The amount of µAlgo to fund.\n   *\n   * @returns DispenserFundResponse: An object containing the transaction ID and funded amount.\n   */\n  async fund(address: string | Address, amount: number | bigint): Promise<DispenserFundResponse> {\n    const response = await this.processDispenserRequest(\n      this.authToken,\n      `fund/${dispenserAssets[DispenserAssetName.Algo].assetId}`,\n      {\n        receiver: typeof address === 'string' ? address : address.toString(),\n        amount: Number(amount),\n        assetID: dispenserAssets[DispenserAssetName.Algo].assetId,\n      },\n      'POST',\n    )\n\n    const content = (await response.json()) as { txID: string; amount: number }\n    return { txId: content.txID, amount: content.amount }\n  }\n\n  /**\n   * Sends a refund request to the dispenser API for the specified refundTxnId.\n   *\n   * @param refundTxnId - The transaction ID to refund.\n   */\n  async refund(refundTxnId: string): Promise<void> {\n    await this.processDispenserRequest(this.authToken, 'refund', { refundTransactionID: refundTxnId }, 'POST')\n  }\n\n  /**\n   * Sends a request to the dispenser API to get the funding limit for the Algo asset.\n   *\n   * @returns DispenserLimitResponse: An object containing the funding limit amount.\n   */\n  async getLimit(): Promise<DispenserLimitResponse> {\n    const response = await this.processDispenserRequest(\n      this.authToken,\n      `fund/${dispenserAssets[DispenserAssetName.Algo].assetId}/limit`,\n      null,\n      'GET',\n    )\n    const content = (await response.json()) as { amount: number }\n\n    return { amount: content.amount }\n  }\n}\n"],"mappings":";;;AAGA,MAAM,qBAAqB;AAC3B,MAAM,oCAAoC;AAC1C,MAAM,6BAA6B;AAMnC,IAAK,oEAAL;AACE;;EADG;AAIL,MAAM,kBAAkB,GACrB,mBAAmB,OAAO;CACzB,SAAS;CACT,UAAU;CACV,aAAa;CACd,EACF;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkDD,IAAa,4BAAb,MAAuC;CACrC,AAAQ;CACR,AAAQ;CAER,YAAY,QAA0C;EACpD,MAAM,mBAAmB,SAAS,MAAM;AAExC,MAAI,QAAQ,UACV,MAAK,aAAa,OAAO;WAChB,iBACT,MAAK,aAAa;MAElB,OAAM,IAAI,MACR,wFAAwF,2BAA2B,kCACpH;AAGH,OAAK,kBAAkB,QAAQ,kBAAkB;;CAGnD,IAAI,YAAoB;AACtB,SAAO,KAAK;;CAGd,IAAI,iBAAyB;AAC3B,SAAO,KAAK;;;;;;;;;;;;CAad,MAAc,wBACZ,WACA,WACA,OAA+C,MAC/C,SAAS,QACU;EAGnB,MAAMA,cAA2B;GACvB;GACR,SAJc,EAAE,eAAe,UAAU,aAAa;GAKtD,QAAQ,YAAY,QAAQ,KAAK,iBAAiB,IAAK;GACxD;AAED,MAAI,KACF,aAAY,OAAO,OAAO,KAAK;EAGjC,MAAM,WAAW,MAAM,MAAM,GAAG,mBAAmB,GAAG,aAAa,YAAY;AAC/E,MAAI,CAAC,SAAS,IAAI;GAChB,IAAI,gBAAgB,2CAA2C,SAAS;GACxE,IAAI,iBAAiB;AACrB,OAAI;AACF,qBAAiB,MAAM,SAAS,MAAM;WAChC;AAIR,OAAI,kBAAmB,eAAiC,KACtD,iBAAiB,eAAiC;YACzC,SAAS,WAAW,IAE7B,kBADuB,MAAM,SAAS,MAAM,EACd;AAGhC,SAAM,IAAI,MAAM,cAAc;;AAEhC,SAAO;;;;;;;;;;CAWT,MAAM,KAAK,SAA2B,QAAyD;EAY7F,MAAM,UAAW,OAXA,MAAM,KAAK,wBAC1B,KAAK,WACL,QAAQ,gBAAgB,mBAAmB,MAAM,WACjD;GACE,UAAU,OAAO,YAAY,WAAW,UAAU,QAAQ,UAAU;GACpE,QAAQ,OAAO,OAAO;GACtB,SAAS,gBAAgB,mBAAmB,MAAM;GACnD,EACD,OACD,EAE+B,MAAM;AACtC,SAAO;GAAE,MAAM,QAAQ;GAAM,QAAQ,QAAQ;GAAQ;;;;;;;CAQvD,MAAM,OAAO,aAAoC;AAC/C,QAAM,KAAK,wBAAwB,KAAK,WAAW,UAAU,EAAE,qBAAqB,aAAa,EAAE,OAAO;;;;;;;CAQ5G,MAAM,WAA4C;AAShD,SAAO,EAAE,SAFQ,OANA,MAAM,KAAK,wBAC1B,KAAK,WACL,QAAQ,gBAAgB,mBAAmB,MAAM,QAAQ,SACzD,MACA,MACD,EAC+B,MAAM,EAEb,QAAQ"}

package/expand.d.ts

@@ -0,0 +1,2 @@
+import { Expand } from "./packages/common/src/expand.js";
+export { type Expand };

package/index.d.ts

@@ -1,9 +1,10 @@
 import { ALGORAND_ZERO_ADDRESS_STRING, Address, Addressable, ReadableAddress, decodeAddress, encodeAddress, getAddress, getApplicationAddress, getOptionalAddress } from "./packages/common/src/address.js";
-import { ALGORAND_MIN_TX_FEE, algo, algos, microAlgo, microAlgos, transactionFees } from "./amount.js";
+import { ALGORAND_MIN_TX_FEE, AlgoAmount, algo, algos, microAlgo, microAlgos, transactionFees } from "./amount.js";
 import { performTransactionComposerSimulate } from "./transaction/perform-transaction-composer-simulate.js";
+import { AdditionalTransactionComposerContext, Arc2TransactionNote, ConfirmedTransactionResult, ConfirmedTransactionResults, SendParams, SendSingleTransactionResult, SendTransactionComposerResults, SendTransactionFrom, SendTransactionParams, SendTransactionResult, SendTransactionResults, TransactionComposerToSend, TransactionGroupToSend, TransactionNote, TransactionNoteData, TransactionToSign } from "./transaction/types.js";
 import { TransactionWithSigner, encodeLease, populateAppCallResources, prepareGroupForSending, sendTransactionComposer, waitForConfirmation } from "./transaction/transaction.js";
-import { ALGOKIT_DIR, AVMTracesEventData, DEFAULT_MAX_SEARCH_DEPTH, SOURCES_DIR, TEAL_FILE_EXT, TEAL_SOURCEMAP_EXT, TealSourceDebugEventData, TealSourcesDebugEventData } from "./types/debugging.js";
-import { EventDataMap, EventType } from "./types/lifecycle-events.js";
+import { AlgorandClient } from "./algorand-client.js";
+import { ALGOKIT_DIR, AVMTracesEventData, DEFAULT_MAX_SEARCH_DEPTH, SOURCES_DIR, TEAL_FILE_EXT, TEAL_SOURCEMAP_EXT, TealSourceDebugEventData, TealSourcesDebugEventData } from "./debugging.js";
+import { EventDataMap, EventType } from "./lifecycle-events.js";
 import { Config } from "./config.js";
-import { AlgorandClient } from "./types/algorand-client.js";
-export { ALGOKIT_DIR, ALGORAND_MIN_TX_FEE, ALGORAND_ZERO_ADDRESS_STRING, AVMTracesEventData, Address, type Addressable, AlgorandClient, Config, DEFAULT_MAX_SEARCH_DEPTH, EventDataMap, EventType, type ReadableAddress, SOURCES_DIR, TEAL_FILE_EXT, TEAL_SOURCEMAP_EXT, TealSourceDebugEventData, TealSourcesDebugEventData, TransactionWithSigner, algo, algos, decodeAddress, encodeAddress, encodeLease, getAddress, getApplicationAddress, getOptionalAddress, microAlgo, microAlgos, performTransactionComposerSimulate, populateAppCallResources, prepareGroupForSending, sendTransactionComposer, transactionFees, waitForConfirmation };
+export { ALGOKIT_DIR, ALGORAND_MIN_TX_FEE, ALGORAND_ZERO_ADDRESS_STRING, AVMTracesEventData, AdditionalTransactionComposerContext, Address, type Addressable, AlgoAmount, AlgorandClient, Arc2TransactionNote, Config, ConfirmedTransactionResult, ConfirmedTransactionResults, DEFAULT_MAX_SEARCH_DEPTH, EventDataMap, EventType, type ReadableAddress, SOURCES_DIR, SendParams, SendSingleTransactionResult, SendTransactionComposerResults, SendTransactionFrom, SendTransactionParams, SendTransactionResult, SendTransactionResults, TEAL_FILE_EXT, TEAL_SOURCEMAP_EXT, TealSourceDebugEventData, TealSourcesDebugEventData, TransactionComposerToSend, TransactionGroupToSend, TransactionNote, TransactionNoteData, TransactionToSign, TransactionWithSigner, algo, algos, decodeAddress, encodeAddress, encodeLease, getAddress, getApplicationAddress, getOptionalAddress, microAlgo, microAlgos, performTransactionComposerSimulate, populateAppCallResources, prepareGroupForSending, sendTransactionComposer, transactionFees, waitForConfirmation };

package/index.js

@@ -3,14 +3,15 @@ const require_amount = require('./amount.js');
 const require_config = require('./config.js');
 const require_perform_transaction_composer_simulate = require('./transaction/perform-transaction-composer-simulate.js');
 const require_transaction = require('./transaction/transaction.js');
-const require_lifecycle_events = require('./types/lifecycle-events.js');
-const require_algorand_client = require('./types/algorand-client.js');
-const require_debugging = require('./types/debugging.js');
+const require_lifecycle_events = require('./lifecycle-events.js');
+const require_algorand_client = require('./algorand-client.js');
+const require_debugging = require('./debugging.js');
 
 exports.ALGOKIT_DIR = require_debugging.ALGOKIT_DIR;
 exports.ALGORAND_MIN_TX_FEE = require_amount.ALGORAND_MIN_TX_FEE;
 exports.ALGORAND_ZERO_ADDRESS_STRING = require_address.ALGORAND_ZERO_ADDRESS_STRING;
 exports.Address = require_address.Address;
+exports.AlgoAmount = require_amount.AlgoAmount;
 exports.AlgorandClient = require_algorand_client.AlgorandClient;
 exports.Config = require_config.Config;
 exports.DEFAULT_MAX_SEARCH_DEPTH = require_debugging.DEFAULT_MAX_SEARCH_DEPTH;

package/index.mjs

@@ -1,10 +1,10 @@
 import { ALGORAND_ZERO_ADDRESS_STRING, Address, decodeAddress, encodeAddress, getAddress, getApplicationAddress, getOptionalAddress } from "./packages/common/src/address.mjs";
-import { ALGORAND_MIN_TX_FEE, algo, algos, microAlgo, microAlgos, transactionFees } from "./amount.mjs";
+import { ALGORAND_MIN_TX_FEE, AlgoAmount, algo, algos, microAlgo, microAlgos, transactionFees } from "./amount.mjs";
 import { Config } from "./config.mjs";
 import { performTransactionComposerSimulate } from "./transaction/perform-transaction-composer-simulate.mjs";
 import { encodeLease, populateAppCallResources, prepareGroupForSending, sendTransactionComposer, waitForConfirmation } from "./transaction/transaction.mjs";
-import { EventType } from "./types/lifecycle-events.mjs";
-import { AlgorandClient } from "./types/algorand-client.mjs";
-import { ALGOKIT_DIR, DEFAULT_MAX_SEARCH_DEPTH, SOURCES_DIR, TEAL_FILE_EXT, TEAL_SOURCEMAP_EXT } from "./types/debugging.mjs";
+import { EventType } from "./lifecycle-events.mjs";
+import { AlgorandClient } from "./algorand-client.mjs";
+import { ALGOKIT_DIR, DEFAULT_MAX_SEARCH_DEPTH, SOURCES_DIR, TEAL_FILE_EXT, TEAL_SOURCEMAP_EXT } from "./debugging.mjs";
 
-export { ALGOKIT_DIR, ALGORAND_MIN_TX_FEE, ALGORAND_ZERO_ADDRESS_STRING, Address, AlgorandClient, Config, DEFAULT_MAX_SEARCH_DEPTH, EventType, SOURCES_DIR, TEAL_FILE_EXT, TEAL_SOURCEMAP_EXT, algo, algos, decodeAddress, encodeAddress, encodeLease, getAddress, getApplicationAddress, getOptionalAddress, microAlgo, microAlgos, performTransactionComposerSimulate, populateAppCallResources, prepareGroupForSending, sendTransactionComposer, transactionFees, waitForConfirmation };
+export { ALGOKIT_DIR, ALGORAND_MIN_TX_FEE, ALGORAND_ZERO_ADDRESS_STRING, Address, AlgoAmount, AlgorandClient, Config, DEFAULT_MAX_SEARCH_DEPTH, EventType, SOURCES_DIR, TEAL_FILE_EXT, TEAL_SOURCEMAP_EXT, algo, algos, decodeAddress, encodeAddress, encodeLease, getAddress, getApplicationAddress, getOptionalAddress, microAlgo, microAlgos, performTransactionComposerSimulate, populateAppCallResources, prepareGroupForSending, sendTransactionComposer, transactionFees, waitForConfirmation };

package/indexer-client/indexer-lookup.d.ts

@@ -3,7 +3,7 @@ import { Application } from "../packages/indexer_client/src/models/application.j
 import { MiniAssetHolding } from "../packages/indexer_client/src/models/mini-asset-holding.js";
 import { TransactionsResponse } from "../packages/indexer_client/src/models/transactions-response.js";
 import { IndexerClient } from "../packages/indexer_client/src/client.js";
-import { LookupAssetHoldingsOptions } from "../types/indexer.js";
+import { LookupAssetHoldingsOptions } from "../indexer.js";
 
 //#region src/indexer-client/indexer-lookup.d.ts
 type SearchForTransactionsCriteria = Omit<NonNullable<Parameters<IndexerClient['searchForTransactions']>[0]>, 'limit' | 'next'>;

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

@@ -1 +1 @@
-{"version":3,"file":"indexer-lookup.js","names":["nextToken: string | undefined"],"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 '../types/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,IAAIA,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"}
+{"version":3,"file":"indexer-lookup.js","names":["nextToken: string | undefined"],"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,IAAIA,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-client/indexer-lookup.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"indexer-lookup.mjs","names":["nextToken: string | undefined"],"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 '../types/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,IAAIA,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"}
+{"version":3,"file":"indexer-lookup.mjs","names":["nextToken: string | undefined"],"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,IAAIA,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,38 @@
+
+//#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$1) {
+	ApplicationOnComplete$1["noop"] = "noop";
+	ApplicationOnComplete$1["optin"] = "optin";
+	ApplicationOnComplete$1["closeout"] = "closeout";
+	ApplicationOnComplete$1["clear"] = "clear";
+	ApplicationOnComplete$1["update"] = "update";
+	ApplicationOnComplete$1["delete"] = "delete";
+	return ApplicationOnComplete$1;
+}({});
+/** Type of signature used by an account */
+let SignatureType = /* @__PURE__ */ function(SignatureType$1) {
+	/** Normal signature */
+	SignatureType$1["sig"] = "sig";
+	/** Multisig */
+	SignatureType$1["msig"] = "msig";
+	/** Logic signature */
+	SignatureType$1["lsig"] = "lsig";
+	return SignatureType$1;
+}({});
+/** Delegation status of the account */
+let AccountStatus = /* @__PURE__ */ function(AccountStatus$1) {
+	/** Indicates that the associated account is delegated */
+	AccountStatus$1["Offline"] = "Offline";
+	/** Indicates that the associated account used as part of the delegation pool */
+	AccountStatus$1["Online"] = "Online";
+	/** Indicates that the associated account is neither a delegator nor a delegate */
+	AccountStatus$1["NotParticipating"] = "NotParticipating";
+	return AccountStatus$1;
+}({});
+
+//#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,0EAAL;AACL;AACA;AACA;AACA;AACA;AACA;;;;AAIF,IAAY,0DAAL;;AAEL;;AAEA;;AAEA;;;;AAIF,IAAY,0DAAL;;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$1) {
+	ApplicationOnComplete$1["noop"] = "noop";
+	ApplicationOnComplete$1["optin"] = "optin";
+	ApplicationOnComplete$1["closeout"] = "closeout";
+	ApplicationOnComplete$1["clear"] = "clear";
+	ApplicationOnComplete$1["update"] = "update";
+	ApplicationOnComplete$1["delete"] = "delete";
+	return ApplicationOnComplete$1;
+}({});
+/** Type of signature used by an account */
+let SignatureType = /* @__PURE__ */ function(SignatureType$1) {
+	/** Normal signature */
+	SignatureType$1["sig"] = "sig";
+	/** Multisig */
+	SignatureType$1["msig"] = "msig";
+	/** Logic signature */
+	SignatureType$1["lsig"] = "lsig";
+	return SignatureType$1;
+}({});
+/** Delegation status of the account */
+let AccountStatus = /* @__PURE__ */ function(AccountStatus$1) {
+	/** Indicates that the associated account is delegated */
+	AccountStatus$1["Offline"] = "Offline";
+	/** Indicates that the associated account used as part of the delegation pool */
+	AccountStatus$1["Online"] = "Online";
+	/** Indicates that the associated account is neither a delegator nor a delegate */
+	AccountStatus$1["NotParticipating"] = "NotParticipating";
+	return AccountStatus$1;
+}({});
+
+//#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,0EAAL;AACL;AACA;AACA;AACA;AACA;AACA;;;;AAIF,IAAY,0DAAL;;AAEL;;AAEA;;AAEA;;;;AAIF,IAAY,0DAAL;;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