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

package/dispenser-client.js

@@ -0,0 +1,129 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_util = require('./util.js');
+
+//#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) {
+	DispenserAssetName[DispenserAssetName["Algo"] = 0] = "Algo";
+	return DispenserAssetName;
+}(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.
+*
+* Methods:
+* - `fund` - Sends a funding request to the dispenser API to fund the specified address with the given amount of Algo.
+* - `refund` - Sends a refund request to the dispenser API for the specified refundTxnId.
+* - `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 = require_util.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
+exports.TestNetDispenserApiClient = TestNetDispenserApiClient;
+//# sourceMappingURL=dispenser-client.js.map

package/dispenser-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dispenser-client.js","names":["asJson"],"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 * Methods:\n * - `fund` - Sends a funding request to the dispenser API to fund the specified address with the given amount of Algo.\n * - `refund` - Sends a refund request to the dispenser API for the specified refundTxnId.\n * - `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,kEAAL;AACE;;EADG;AAIL,MAAM,kBAAkB,GACrB,mBAAmB,OAAO;CACzB,SAAS;CACT,UAAU;CACV,aAAa;CACd,EACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmDD,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,MAAM,cAA2B;GACvB;GACR,SAJc,EAAE,eAAe,UAAU,aAAa;GAKtD,QAAQ,YAAY,QAAQ,KAAK,iBAAiB,IAAK;GACxD;AAED,MAAI,KACF,aAAY,OAAOA,oBAAO,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/dispenser-client.mjs

@@ -0,0 +1,128 @@
+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) {
+	DispenserAssetName[DispenserAssetName["Algo"] = 0] = "Algo";
+	return DispenserAssetName;
+}(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.
+*
+* Methods:
+* - `fund` - Sends a funding request to the dispenser API to fund the specified address with the given amount of Algo.
+* - `refund` - Sends a refund request to the dispenser API for the specified refundTxnId.
+* - `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":[],"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 * Methods:\n * - `fund` - Sends a funding request to the dispenser API to fund the specified address with the given amount of Algo.\n * - `refund` - Sends a refund request to the dispenser API for the specified refundTxnId.\n * - `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,kEAAL;AACE;;EADG;AAIL,MAAM,kBAAkB,GACrB,mBAAmB,OAAO;CACzB,SAAS;CACT,UAAU;CACV,aAAa;CACd,EACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmDD,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,MAAM,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,10 +1,31 @@
 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 { AccountAssetInformation, AccountInformation } from "./account.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 { Config } from "./config.js";
-import { indexer_lookup_d_exports } from "./indexer-lookup.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, indexer_lookup_d_exports as indexer, microAlgo, microAlgos, performTransactionComposerSimulate, populateAppCallResources, prepareGroupForSending, sendTransactionComposer, transactionFees, waitForConfirmation };
+import { AppDeployMetadata, AppState, BoxName, CompiledTeal, OnSchemaBreak, OnUpdate, SendAppCreateTransactionResult, SendAppUpdateTransactionResult, TealTemplateParams } from "./app.js";
+import { AppInformation, AppManager, BoxIdentifier, BoxReference, BoxValueRequestParams, BoxValuesRequestParams } from "./app-manager.js";
+import { AppCreateParams, AppDeleteParams, AppUpdateParams } from "./transactions/app-call.js";
+import { AppCreateMethodCall, AppDeleteMethodCall, AppUpdateMethodCall } from "./transactions/method-call.js";
+import { BuiltTransactions, ErrorTransformer, RawSimulateOptions, SimulateOptions, SkipSignaturesSimulateOptions, TransactionComposer, TransactionComposerConfig, TransactionComposerParams } from "./composer.js";
+import { AlgorandClientTransactionCreator } from "./algorand-client-transaction-creator.js";
+import { AssetInformation, AssetManager, BulkAssetOptInOutResult } from "./asset-manager.js";
+import { AlgorandClientTransactionSender } from "./algorand-client-transaction-sender.js";
+import { AppDeployParams, AppDeployResult, AppDeployer, AppLookup, AppMetadata, DeployAppDeleteMethodCall, DeployAppDeleteParams, DeployAppUpdateMethodCall, DeployAppUpdateParams } from "./app-deployer.js";
+import { AlgoClientConfig, AlgoConfig, NetworkDetails, genesisIdIsLocalNet } from "./network-client.js";
+import { LocalNetManager, NetworkManager, WaitUntilTimestampOptions } from "./network-manager.js";
+import { AlgorandClient } from "./algorand-client.js";
+import { AppClient, AppClientParams, ResolveAppClientByCreatorAndName } from "./app-client.js";
+import { AppFactory, AppFactoryParams } from "./app-factory.js";
+import { TestNetDispenserApiClient } from "./dispenser-client.js";
+import { AlgoSdkClients, ClientAppClientByNetworkParams, ClientAppClientParams, ClientAppFactoryParams, ClientManager, ClientResolveAppClientByCreatorAndNameParams, ClientTypedAppClientByCreatorAndNameParams, ClientTypedAppClientByNetworkParams, ClientTypedAppClientParams, ClientTypedAppFactoryParams, TypedAppClient, TypedAppFactory } from "./client-manager.js";
+import { KmdAccountManager } from "./kmd-account-manager.js";
+import { AccountManager, EnsureFundedResult, getAccountTransactionSigner } from "./account-manager.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 { AsyncEventEmitter } from "./async-event-emitter.js";
+import { Config, UpdatableConfig } from "./updatable-config.js";
+import { Config as Config$1 } from "./config.js";
+import { LookupAssetHoldingsOptions } from "./indexer.js";
+export { ALGOKIT_DIR, ALGORAND_MIN_TX_FEE, ALGORAND_ZERO_ADDRESS_STRING, AVMTracesEventData, type AccountAssetInformation, type AccountInformation, AccountManager, AdditionalTransactionComposerContext, Address, type Addressable, AlgoAmount, type AlgoClientConfig, type AlgoConfig, type Config as AlgoKitConfig, type AlgoSdkClients, AlgorandClient, AlgorandClientTransactionCreator, AlgorandClientTransactionSender, AppClient, type AppClientParams, type AppCreateMethodCall, type AppCreateParams, type AppDeleteMethodCall, type AppDeleteParams, type AppDeployMetadata, type AppDeployParams, type AppDeployResult, AppDeployer, AppFactory, type AppFactoryParams, type AppInformation, type AppLookup, AppManager, type AppMetadata, type AppState, type AppUpdateMethodCall, type AppUpdateParams, Arc2TransactionNote, type AssetInformation, AssetManager, AsyncEventEmitter, type BoxIdentifier, type BoxName, type BoxReference, type BoxValueRequestParams, type BoxValuesRequestParams, type BuiltTransactions, type BulkAssetOptInOutResult, type ClientAppClientByNetworkParams, type ClientAppClientParams, type ClientAppFactoryParams, ClientManager, type ClientResolveAppClientByCreatorAndNameParams, type ClientTypedAppClientByCreatorAndNameParams, type ClientTypedAppClientByNetworkParams, type ClientTypedAppClientParams, type ClientTypedAppFactoryParams, type CompiledTeal, Config$1 as Config, ConfirmedTransactionResult, ConfirmedTransactionResults, DEFAULT_MAX_SEARCH_DEPTH, type DeployAppDeleteMethodCall, type DeployAppDeleteParams, type DeployAppUpdateMethodCall, type DeployAppUpdateParams, type EnsureFundedResult, type ErrorTransformer, EventDataMap, EventType, KmdAccountManager, LocalNetManager, type LookupAssetHoldingsOptions, type NetworkDetails, NetworkManager, type OnSchemaBreak, type OnUpdate, type RawSimulateOptions, type ReadableAddress, type ResolveAppClientByCreatorAndName, SOURCES_DIR, type SendAppCreateTransactionResult, type SendAppUpdateTransactionResult, SendParams, SendSingleTransactionResult, SendTransactionComposerResults, SendTransactionFrom, SendTransactionParams, SendTransactionResult, SendTransactionResults, type SimulateOptions, type SkipSignaturesSimulateOptions, TEAL_FILE_EXT, TEAL_SOURCEMAP_EXT, TealSourceDebugEventData, TealSourcesDebugEventData, type TealTemplateParams, TestNetDispenserApiClient, TransactionComposer, type TransactionComposerConfig, type TransactionComposerParams, TransactionComposerToSend, TransactionGroupToSend, TransactionNote, TransactionNoteData, TransactionToSign, TransactionWithSigner, type TypedAppClient, type TypedAppFactory, UpdatableConfig, type WaitUntilTimestampOptions, algo, algos, decodeAddress, encodeAddress, encodeLease, genesisIdIsLocalNet, getAccountTransactionSigner, getAddress, getApplicationAddress, getOptionalAddress, microAlgo, microAlgos, performTransactionComposerSimulate, populateAppCallResources, prepareGroupForSending, sendTransactionComposer, transactionFees, waitForConfirmation };

package/index.js

@@ -1,38 +1,67 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 const require_address = require('./packages/common/src/address.js');
 const require_amount = require('./amount.js');
+const require_async_event_emitter = require('./async-event-emitter.js');
+const require_updatable_config = require('./updatable-config.js');
 const require_config = require('./config.js');
-const require_indexer_lookup = require('./indexer-lookup.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_app_manager = require('./app-manager.js');
+const require_lifecycle_events = require('./lifecycle-events.js');
+const require_network_client = require('./network-client.js');
+const require_composer = require('./composer.js');
+const require_app_client = require('./app-client.js');
+const require_app_factory = require('./app-factory.js');
+const require_dispenser_client = require('./dispenser-client.js');
+const require_client_manager = require('./client-manager.js');
+const require_kmd_account_manager = require('./kmd-account-manager.js');
+const require_account_manager = require('./account-manager.js');
+const require_algorand_client_transaction_creator = require('./algorand-client-transaction-creator.js');
+const require_algorand_client_transaction_sender = require('./algorand-client-transaction-sender.js');
+const require_app_deployer = require('./app-deployer.js');
+const require_asset_manager = require('./asset-manager.js');
+const require_network_manager = require('./network-manager.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.AccountManager = require_account_manager.AccountManager;
 exports.Address = require_address.Address;
+exports.AlgoAmount = require_amount.AlgoAmount;
 exports.AlgorandClient = require_algorand_client.AlgorandClient;
+exports.AlgorandClientTransactionCreator = require_algorand_client_transaction_creator.AlgorandClientTransactionCreator;
+exports.AlgorandClientTransactionSender = require_algorand_client_transaction_sender.AlgorandClientTransactionSender;
+exports.AppClient = require_app_client.AppClient;
+exports.AppDeployer = require_app_deployer.AppDeployer;
+exports.AppFactory = require_app_factory.AppFactory;
+exports.AppManager = require_app_manager.AppManager;
+exports.AssetManager = require_asset_manager.AssetManager;
+exports.AsyncEventEmitter = require_async_event_emitter.AsyncEventEmitter;
+exports.ClientManager = require_client_manager.ClientManager;
 exports.Config = require_config.Config;
 exports.DEFAULT_MAX_SEARCH_DEPTH = require_debugging.DEFAULT_MAX_SEARCH_DEPTH;
 exports.EventType = require_lifecycle_events.EventType;
+exports.KmdAccountManager = require_kmd_account_manager.KmdAccountManager;
+exports.LocalNetManager = require_network_manager.LocalNetManager;
+exports.NetworkManager = require_network_manager.NetworkManager;
 exports.SOURCES_DIR = require_debugging.SOURCES_DIR;
 exports.TEAL_FILE_EXT = require_debugging.TEAL_FILE_EXT;
 exports.TEAL_SOURCEMAP_EXT = require_debugging.TEAL_SOURCEMAP_EXT;
+exports.TestNetDispenserApiClient = require_dispenser_client.TestNetDispenserApiClient;
+exports.TransactionComposer = require_composer.TransactionComposer;
+exports.UpdatableConfig = require_updatable_config.UpdatableConfig;
 exports.algo = require_amount.algo;
 exports.algos = require_amount.algos;
 exports.decodeAddress = require_address.decodeAddress;
 exports.encodeAddress = require_address.encodeAddress;
 exports.encodeLease = require_transaction.encodeLease;
+exports.genesisIdIsLocalNet = require_network_client.genesisIdIsLocalNet;
+exports.getAccountTransactionSigner = require_account_manager.getAccountTransactionSigner;
 exports.getAddress = require_address.getAddress;
 exports.getApplicationAddress = require_address.getApplicationAddress;
 exports.getOptionalAddress = require_address.getOptionalAddress;
-Object.defineProperty(exports, 'indexer', {
-  enumerable: true,
-  get: function () {
-    return require_indexer_lookup.indexer_lookup_exports;
-  }
-});
 exports.microAlgo = require_amount.microAlgo;
 exports.microAlgos = require_amount.microAlgos;
 exports.performTransactionComposerSimulate = require_perform_transaction_composer_simulate.performTransactionComposerSimulate;

package/index.mjs

@@ -1,11 +1,26 @@
 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 { AsyncEventEmitter } from "./async-event-emitter.mjs";
+import { UpdatableConfig } from "./updatable-config.mjs";
 import { Config } from "./config.mjs";
-import { indexer_lookup_exports } from "./indexer-lookup.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 { AppManager } from "./app-manager.mjs";
+import { EventType } from "./lifecycle-events.mjs";
+import { genesisIdIsLocalNet } from "./network-client.mjs";
+import { TransactionComposer } from "./composer.mjs";
+import { AppClient } from "./app-client.mjs";
+import { AppFactory } from "./app-factory.mjs";
+import { TestNetDispenserApiClient } from "./dispenser-client.mjs";
+import { ClientManager } from "./client-manager.mjs";
+import { KmdAccountManager } from "./kmd-account-manager.mjs";
+import { AccountManager, getAccountTransactionSigner } from "./account-manager.mjs";
+import { AlgorandClientTransactionCreator } from "./algorand-client-transaction-creator.mjs";
+import { AlgorandClientTransactionSender } from "./algorand-client-transaction-sender.mjs";
+import { AppDeployer } from "./app-deployer.mjs";
+import { AssetManager } from "./asset-manager.mjs";
+import { LocalNetManager, NetworkManager } from "./network-manager.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, indexer_lookup_exports as indexer, microAlgo, microAlgos, performTransactionComposerSimulate, populateAppCallResources, prepareGroupForSending, sendTransactionComposer, transactionFees, waitForConfirmation };
+export { ALGOKIT_DIR, ALGORAND_MIN_TX_FEE, ALGORAND_ZERO_ADDRESS_STRING, AccountManager, Address, AlgoAmount, AlgorandClient, AlgorandClientTransactionCreator, AlgorandClientTransactionSender, AppClient, AppDeployer, AppFactory, AppManager, AssetManager, AsyncEventEmitter, ClientManager, Config, DEFAULT_MAX_SEARCH_DEPTH, EventType, KmdAccountManager, LocalNetManager, NetworkManager, SOURCES_DIR, TEAL_FILE_EXT, TEAL_SOURCEMAP_EXT, TestNetDispenserApiClient, TransactionComposer, UpdatableConfig, algo, algos, decodeAddress, encodeAddress, encodeLease, genesisIdIsLocalNet, getAccountTransactionSigner, getAddress, getApplicationAddress, getOptionalAddress, microAlgo, microAlgos, performTransactionComposerSimulate, populateAppCallResources, prepareGroupForSending, sendTransactionComposer, transactionFees, waitForConfirmation };

package/indexer-client/index.d.ts

@@ -2,7 +2,6 @@ import { ClientConfig } from "../packages/indexer_client/src/core/client-config.
 import { ApiRequestOptions, BaseHttpRequest, inputValueAsString } from "../packages/indexer_client/src/core/base-http-request.js";
 import { FetchHttpRequest } from "../packages/indexer_client/src/core/fetch-http-request.js";
 import { ApiError } from "../packages/indexer_client/src/core/api-error.js";
-import { decodeJson, decodeMsgpack, encodeJson, encodeMsgpack } from "../packages/indexer_client/src/core/model-runtime.js";
 import { AccountParticipation } from "../packages/indexer_client/src/models/account-participation.js";
 import { ApplicationStateSchema } from "../packages/indexer_client/src/models/application-state-schema.js";
 import { TealValue } from "../packages/indexer_client/src/models/teal-value.js";
@@ -75,4 +74,5 @@ import { TransactionResponse } from "../packages/indexer_client/src/models/trans
 import { TransactionsResponse } from "../packages/indexer_client/src/models/transactions-response.js";
 import { IndexerApi } from "../packages/indexer_client/src/apis/api-service.js";
 import { IndexerClient } from "../packages/indexer_client/src/client.js";
-export { Account, AccountParticipation, AccountResponse, AccountStateDelta, AccountsResponse, ApiError, ApiRequestOptions, Application, ApplicationLocalState, ApplicationLocalStatesResponse, ApplicationLogData, ApplicationLogsResponse, ApplicationParams, ApplicationResponse, ApplicationStateSchema, ApplicationsResponse, Asset, AssetBalancesResponse, AssetHolding, AssetHoldingsResponse, AssetParams, AssetResponse, AssetsResponse, BaseHttpRequest, Block, BlockHeadersResponse, BlockRewards, BlockUpgradeState, BlockUpgradeVote, Box, BoxDescriptor, BoxReference, BoxesResponse, ClientConfig, EvalDelta, EvalDeltaKeyValue, FetchHttpRequest, HashFactory, HbProofFields, HealthCheck, HoldingRef, IndexerApi, IndexerClient, IndexerStateProofMessage, LocalsRef, MerkleArrayProof, MiniAssetHolding, OnCompletion, ParticipationUpdates, ResourceRef, StateDelta, StateProofFields, StateProofParticipant, StateProofReveal, StateProofSigSlot, StateProofSignature, StateProofTracking, StateProofVerifier, StateSchema, TealKeyValue, TealKeyValueStore, TealValue, Transaction, TransactionApplication, TransactionAssetConfig, TransactionAssetFreeze, TransactionAssetTransfer, TransactionHeartbeat, TransactionKeyreg, TransactionPayment, TransactionResponse, TransactionSignature, TransactionSignatureLogicsig, TransactionSignatureMultisig, TransactionSignatureMultisigSubsignature, TransactionStateProof, TransactionsResponse, decodeJson, decodeMsgpack, encodeJson, encodeMsgpack, inputValueAsString };
+import { SearchForTransactionsCriteria, executePaginatedRequest, lookupAccountCreatedApplicationByAddress, lookupAssetHoldings, searchTransactions } from "./indexer-lookup.js";
+export { Account, AccountParticipation, AccountResponse, AccountStateDelta, AccountsResponse, ApiError, ApiRequestOptions, Application, ApplicationLocalState, ApplicationLocalStatesResponse, ApplicationLogData, ApplicationLogsResponse, ApplicationParams, ApplicationResponse, ApplicationStateSchema, ApplicationsResponse, Asset, AssetBalancesResponse, AssetHolding, AssetHoldingsResponse, AssetParams, AssetResponse, AssetsResponse, BaseHttpRequest, Block, BlockHeadersResponse, BlockRewards, BlockUpgradeState, BlockUpgradeVote, Box, BoxDescriptor, BoxReference, BoxesResponse, ClientConfig, EvalDelta, EvalDeltaKeyValue, FetchHttpRequest, HashFactory, HbProofFields, HealthCheck, HoldingRef, IndexerApi, IndexerClient, IndexerStateProofMessage, LocalsRef, MerkleArrayProof, MiniAssetHolding, OnCompletion, ParticipationUpdates, ResourceRef, SearchForTransactionsCriteria, StateDelta, StateProofFields, StateProofParticipant, StateProofReveal, StateProofSigSlot, StateProofSignature, StateProofTracking, StateProofVerifier, StateSchema, TealKeyValue, TealKeyValueStore, TealValue, Transaction, TransactionApplication, TransactionAssetConfig, TransactionAssetFreeze, TransactionAssetTransfer, TransactionHeartbeat, TransactionKeyreg, TransactionPayment, TransactionResponse, TransactionSignature, TransactionSignatureLogicsig, TransactionSignatureMultisig, TransactionSignatureMultisigSubsignature, TransactionStateProof, TransactionsResponse, executePaginatedRequest, inputValueAsString, lookupAccountCreatedApplicationByAddress, lookupAssetHoldings, searchTransactions };

package/indexer-client/index.js

@@ -1,17 +1,18 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 const require_base_http_request = require('../packages/indexer_client/src/core/base-http-request.js');
 const require_api_error = require('../packages/indexer_client/src/core/api-error.js');
 const require_fetch_http_request = require('../packages/indexer_client/src/core/fetch-http-request.js');
-const require_model_runtime = require('../packages/indexer_client/src/core/model-runtime.js');
 const require_api_service = require('../packages/indexer_client/src/apis/api-service.js');
 const require_client = require('../packages/indexer_client/src/client.js');
+const require_indexer_lookup = require('./indexer-lookup.js');
 
 exports.ApiError = require_api_error.ApiError;
 exports.BaseHttpRequest = require_base_http_request.BaseHttpRequest;
 exports.FetchHttpRequest = require_fetch_http_request.FetchHttpRequest;
 exports.IndexerApi = require_api_service.IndexerApi;
 exports.IndexerClient = require_client.IndexerClient;
-exports.decodeJson = require_model_runtime.decodeJson;
-exports.decodeMsgpack = require_model_runtime.decodeMsgpack;
-exports.encodeJson = require_model_runtime.encodeJson;
-exports.encodeMsgpack = require_model_runtime.encodeMsgpack;
-exports.inputValueAsString = require_base_http_request.inputValueAsString;
+exports.executePaginatedRequest = require_indexer_lookup.executePaginatedRequest;
+exports.inputValueAsString = require_base_http_request.inputValueAsString;
+exports.lookupAccountCreatedApplicationByAddress = require_indexer_lookup.lookupAccountCreatedApplicationByAddress;
+exports.lookupAssetHoldings = require_indexer_lookup.lookupAssetHoldings;
+exports.searchTransactions = require_indexer_lookup.searchTransactions;

package/indexer-client/index.mjs

@@ -1,8 +1,8 @@
 import { BaseHttpRequest, inputValueAsString } from "../packages/indexer_client/src/core/base-http-request.mjs";
 import { ApiError } from "../packages/indexer_client/src/core/api-error.mjs";
 import { FetchHttpRequest } from "../packages/indexer_client/src/core/fetch-http-request.mjs";
-import { decodeJson, decodeMsgpack, encodeJson, encodeMsgpack } from "../packages/indexer_client/src/core/model-runtime.mjs";
 import { IndexerApi } from "../packages/indexer_client/src/apis/api-service.mjs";
 import { IndexerClient } from "../packages/indexer_client/src/client.mjs";
+import { executePaginatedRequest, lookupAccountCreatedApplicationByAddress, lookupAssetHoldings, searchTransactions } from "./indexer-lookup.mjs";
 
-export { ApiError, BaseHttpRequest, FetchHttpRequest, IndexerApi, IndexerClient, decodeJson, decodeMsgpack, encodeJson, encodeMsgpack, inputValueAsString };
+export { ApiError, BaseHttpRequest, FetchHttpRequest, IndexerApi, IndexerClient, executePaginatedRequest, inputValueAsString, lookupAccountCreatedApplicationByAddress, lookupAssetHoldings, searchTransactions };

package/{indexer-lookup.d.ts → indexer-client/indexer-lookup.d.ts}

@@ -1,14 +1,11 @@
-import { Address } from "./packages/common/src/address.js";
-import { Application } from "./packages/indexer_client/src/models/application.js";
-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 { Address } from "../packages/common/src/address.js";
+import { Application } from "../packages/indexer_client/src/models/application.js";
+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 "../indexer.js";
 
-//#region src/indexer-lookup.d.ts
-declare namespace indexer_lookup_d_exports {
-  export { SearchForTransactionsCriteria, executePaginatedRequest, lookupAccountCreatedApplicationByAddress, lookupAssetHoldings, searchTransactions };
-}
+//#region src/indexer-client/indexer-lookup.d.ts
 type SearchForTransactionsCriteria = Omit<NonNullable<Parameters<IndexerClient['searchForTransactions']>[0]>, 'limit' | 'next'>;
 /**
  * Looks up applications that were created by the given address; will automatically paginate through all data.
@@ -38,5 +35,5 @@ declare function lookupAssetHoldings(indexer: IndexerClient, assetId: number | b
 declare function searchTransactions(indexer: IndexerClient, searchCriteria: SearchForTransactionsCriteria, paginationLimit?: number): Promise<TransactionsResponse>;
 declare function executePaginatedRequest<TResult, TRequest extends Promise<any>>(extractItems: (response: any) => TResult[], buildRequest: (nextToken?: string) => TRequest): Promise<TResult[]>;
 //#endregion
-export { indexer_lookup_d_exports };
+export { SearchForTransactionsCriteria, executePaginatedRequest, lookupAccountCreatedApplicationByAddress, lookupAssetHoldings, searchTransactions };
 //# sourceMappingURL=indexer-lookup.d.ts.map

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

@@ -1,12 +1,5 @@
-import { __export } from "./_virtual/rolldown_runtime.mjs";
 
-//#region src/indexer-lookup.ts
-var indexer_lookup_exports = /* @__PURE__ */ __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,5 +93,8 @@ async function executePaginatedRequest(extractItems, buildRequest) {
 }
 
 //#endregion
-export { indexer_lookup_exports, lookupAccountCreatedApplicationByAddress, searchTransactions };
-//# sourceMappingURL=indexer-lookup.mjs.map
+exports.executePaginatedRequest = executePaginatedRequest;
+exports.lookupAccountCreatedApplicationByAddress = lookupAccountCreatedApplicationByAddress;
+exports.lookupAssetHoldings = lookupAssetHoldings;
+exports.searchTransactions = searchTransactions;
+//# sourceMappingURL=indexer-lookup.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"indexer-lookup.js","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"}