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

package/asset-manager.js

@@ -0,0 +1,170 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_constants = require('./packages/common/src/constants.js');
+const require_config = require('./config.js');
+const require_util = require('./util.js');
+
+//#region src/asset-manager.ts
+/**
+* Allows management of asset information.
+* @see {@link AlgorandClient} for the main entry point that provides access to this manager
+*/
+var AssetManager = class {
+	_algod;
+	_newGroup;
+	/**
+	* Create a new asset manager.
+	* @param algod An algod client
+	* @param newGroup A function that creates a new `TransactionComposer` transaction group
+	* @example Create a new asset manager
+	* ```typescript
+	* const assetManager = new AssetManager(algod, () => new TransactionComposer({algod, () => signer, () => suggestedParams}))
+	* ```
+	*/
+	constructor(algod, newGroup) {
+		this._algod = algod;
+		this._newGroup = newGroup;
+	}
+	/**
+	* Returns the current asset information for the asset with the given ID.
+	*
+	* @example
+	* ```typescript
+	* const assetInfo = await assetManager.getById(12353n);
+	* ```
+	*
+	* @param assetId The ID of the asset
+	* @returns The asset information
+	*/
+	async getById(assetId) {
+		const asset = await this._algod.assetById(assetId);
+		return {
+			assetId: BigInt(asset.id),
+			total: BigInt(asset.params.total),
+			decimals: Number(asset.params.decimals),
+			assetName: asset.params.name,
+			assetNameAsBytes: asset.params.nameB64,
+			unitName: asset.params.unitName,
+			unitNameAsBytes: asset.params.unitNameB64,
+			url: asset.params.url,
+			urlAsBytes: asset.params.urlB64,
+			creator: asset.params.creator,
+			manager: asset.params.manager,
+			clawback: asset.params.clawback,
+			freeze: asset.params.freeze,
+			reserve: asset.params.reserve,
+			defaultFrozen: asset.params.defaultFrozen,
+			metadataHash: asset.params.metadataHash
+		};
+	}
+	/**
+	* Returns the given sender account's asset holding for a given asset.
+	*
+	* @example
+	* ```typescript
+	* const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+	* const assetId = 123345n;
+	* const accountInfo = await assetManager.getAccountInformation(address, assetId);
+	* ```
+	*
+	* [Response data schema details](https://dev.algorand.co/reference/rest-apis/algod/#accountassetinformation)
+	* @param sender The address of the sender/account to look up
+	* @param assetId The ID of the asset to return a holding for
+	* @returns The account asset holding information
+	*/
+	async getAccountInformation(sender, assetId) {
+		const info = await this._algod.accountAssetInformation(sender.toString(), assetId);
+		return {
+			assetId: BigInt(assetId),
+			balance: BigInt(info.assetHolding?.amount ?? 0),
+			frozen: info.assetHolding?.isFrozen === true,
+			round: BigInt(info["round"])
+		};
+	}
+	/**
+	* Opt an account in to a list of Algorand Standard Assets.
+	*
+	* Transactions will be sent in batches of 16 as transaction groups.
+	*
+	* @param account The account to opt-in
+	* @param assetIds The list of asset IDs to opt-in to
+	* @param options Any parameters to control the transaction or execution of the transaction
+	* @example Example using AlgorandClient
+	* ```typescript
+	* // Basic example
+	* assetManager.bulkOptIn("ACCOUNTADDRESS", [12345n, 67890n])
+	* // With configuration
+	* assetManager.bulkOptIn("ACCOUNTADDRESS", [12345n, 67890n], { maxFee: (1000).microAlgo(), suppressLog: true })
+	* ```
+	* @returns An array of records matching asset ID to transaction ID of the opt in
+	*/
+	async bulkOptIn(account, assetIds, options) {
+		const results = [];
+		for (const assetGroup of require_util.chunkArray(assetIds, require_constants.MAX_TRANSACTION_GROUP_SIZE)) {
+			const composer = this._newGroup();
+			for (const assetId of assetGroup) composer.addAssetOptIn({
+				...options,
+				sender: account,
+				assetId: BigInt(assetId)
+			});
+			const result = await composer.send(options);
+			require_config.Config.getLogger(options?.suppressLog).info(`Successfully opted in ${account} for assets ${assetGroup.join(", ")} with transaction IDs ${result.txIds.join(", ")}\n  Grouped under ${result.groupId} in round ${result.confirmations?.[0]?.confirmedRound}.`);
+			assetGroup.forEach((assetId, index) => {
+				results.push({
+					assetId: BigInt(assetId),
+					transactionId: result.txIds[index]
+				});
+			});
+		}
+		return results;
+	}
+	/**
+	* Opt an account out of a list of Algorand Standard Assets.
+	*
+	* Transactions will be sent in batches of 16 as transaction groups.
+	*
+	* @param account The account to opt-in
+	* @param assetIds The list of asset IDs to opt-out of
+	* @param options Any parameters to control the transaction or execution of the transaction
+	* @example Example using AlgorandClient
+	* ```typescript
+	* // Basic example
+	* assetManager.bulkOptOut("ACCOUNTADDRESS", [12345n, 67890n])
+	* // With configuration
+	* assetManager.bulkOptOut("ACCOUNTADDRESS", [12345n, 67890n], { ensureZeroBalance: true, maxFee: (1000).microAlgo(), suppressLog: true })
+	* ```
+	* @returns An array of records matching asset ID to transaction ID of the opt in
+	*/
+	async bulkOptOut(account, assetIds, options) {
+		const results = [];
+		for (const assetGroup of require_util.chunkArray(assetIds, require_constants.MAX_TRANSACTION_GROUP_SIZE)) {
+			const composer = this._newGroup();
+			const notOptedInAssetIds = [];
+			const nonZeroBalanceAssetIds = [];
+			for (const assetId of assetGroup) if (options?.ensureZeroBalance !== false) try {
+				if ((await this.getAccountInformation(account, assetId)).balance !== 0n) nonZeroBalanceAssetIds.push(BigInt(assetId));
+			} catch {
+				notOptedInAssetIds.push(BigInt(assetId));
+			}
+			if (notOptedInAssetIds.length > 0 || nonZeroBalanceAssetIds.length > 0) throw new Error(`Account ${account}${notOptedInAssetIds.length > 0 ? ` is not opted-in to Asset${notOptedInAssetIds.length > 1 ? "s" : ""} ${notOptedInAssetIds.join(", ")}` : ""}${nonZeroBalanceAssetIds.length > 0 ? ` has non-zero balance for Asset${nonZeroBalanceAssetIds.length > 1 ? "s" : ""} ${nonZeroBalanceAssetIds.join(", ")}` : ""}; can't opt-out.`);
+			for (const assetId of assetGroup) composer.addAssetOptOut({
+				...options,
+				creator: (await this.getById(BigInt(assetId))).creator,
+				sender: account,
+				assetId: BigInt(assetId)
+			});
+			const result = await composer.send(options);
+			require_config.Config.getLogger(options?.suppressLog).info(`Successfully opted ${account} out of assets ${assetGroup.join(", ")} with transaction IDs ${result.txIds.join(", ")}\n  Grouped under ${result.groupId} in round ${result.confirmations?.[0]?.confirmedRound}.`);
+			assetGroup.forEach((assetId, index) => {
+				results.push({
+					assetId: BigInt(assetId),
+					transactionId: result.txIds[index]
+				});
+			});
+		}
+		return results;
+	}
+};
+
+//#endregion
+exports.AssetManager = AssetManager;
+//# sourceMappingURL=asset-manager.js.map

package/asset-manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"asset-manager.js","names":["chunkArray","MAX_TRANSACTION_GROUP_SIZE"],"sources":["../src/asset-manager.ts"],"sourcesContent":["import { AlgodClient } from '@algorandfoundation/algokit-algod-client'\nimport { Address, MAX_TRANSACTION_GROUP_SIZE } from '@algorandfoundation/algokit-common'\nimport { AccountAssetInformation } from './account'\nimport { CommonTransactionParams, TransactionComposer, TransactionComposerConfig } from './composer'\nimport { Config } from './config'\nimport { SendParams } from './transaction/types'\nimport { chunkArray } from './util'\n\n/** Individual result from performing a bulk opt-in or bulk opt-out for an account against a series of assets. */\nexport interface BulkAssetOptInOutResult {\n  /** The ID of the asset opted into / out of */\n  assetId: bigint\n  /** The transaction ID of the resulting opt in / out */\n  transactionId: string\n}\n\n/** Information about an asset. */\nexport interface AssetInformation {\n  /** The ID of the asset. */\n  assetId: bigint\n\n  /** The address of the account that created the asset.\n   *\n   * This is the address where the parameters for this asset can be found,\n   * and also the address where unwanted asset units can be sent when\n   * closing out an asset position and opting-out of the asset.\n   */\n  creator: string\n\n  /** The total amount of the smallest divisible (decimal) units that were created of the asset.\n   *\n   * For example, if `decimals` is, say, 2, then for every 100 `total` there is 1 whole unit.\n   */\n  total: bigint\n\n  /** The amount of decimal places the asset was created with.\n   *\n   * * If 0, the asset is not divisible;\n   * * If 1, the base unit of the asset is in tenths;\n   * * If 2, the base unit of the asset is in hundredths;\n   * * If 3, the base unit of the asset is in thousandths;\n   * * and so on up to 19 decimal places.\n   */\n  decimals: number\n\n  /** Whether the asset was frozen by default for all accounts.\n   *\n   * If `true` then for anyone apart from the creator to hold the\n   * asset it needs to be unfrozen per account using an asset freeze\n   * transaction from the `freeze` account.\n   */\n  defaultFrozen?: boolean\n\n  /** The address of the optional account that can manage the configuration of the asset and destroy it.\n   *\n   * If not set the asset is permanently immutable.\n   */\n  manager?: string\n\n  /**\n   * The address of the optional account that holds the reserve (uncirculated supply) units of the asset.\n   *\n   * This address has no specific authority in the protocol itself and is informational only.\n   *\n   * Some standards like [ARC-19](https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0019.md)\n   * rely on this field to hold meaningful data.\n   *\n   * It can be used in the case where you want to signal to holders of your asset that the uncirculated units\n   * of the asset reside in an account that is different from the default creator account.\n   *\n   * If not set the field is permanently empty.\n   */\n  reserve?: string\n\n  /**\n   * The address of the optional account that can be used to freeze or unfreeze holdings of this asset for any account.\n   *\n   * If empty, freezing is not permitted.\n   *\n   * If not set the field is permanently empty.\n   */\n  freeze?: string\n\n  /**\n   * The address of the optional account that can clawback holdings of this asset from any account.\n   *\n   * The clawback account has the ability to **unconditionally take assets from any account**.\n   *\n   * If empty, clawback is not permitted.\n   *\n   * If not set the field is permanently empty.\n   */\n  clawback?: string\n\n  /** The optional name of the unit of this asset (e.g. ticker name).\n   *\n   * Max size is 8 bytes.\n   */\n  unitName?: string\n\n  /** The optional name of the unit of this asset (e.g. ticker name).\n   *\n   * Max size is 8 bytes.\n   */\n  unitNameAsBytes?: Uint8Array\n\n  /** The optional name of the asset.\n   *\n   * Max size is 32 bytes.\n   */\n  assetName?: string\n\n  /** The optional name of the asset.\n   *\n   * Max size is 32 bytes.\n   */\n  assetNameAsBytes?: Uint8Array\n\n  /** Optional URL where more information about the asset can be retrieved (e.g. metadata).\n   *\n   * Max size is 96 bytes.\n   */\n  url?: string\n\n  /** Optional URL where more information about the asset can be retrieved (e.g. metadata).\n   *\n   * Max size is 96 bytes.\n   */\n  urlAsBytes?: Uint8Array\n\n  /** 32-byte hash of some metadata that is relevant to the asset and/or asset holders.\n   *\n   * The format of this metadata is up to the application.\n   */\n  metadataHash?: Uint8Array\n}\n\n/**\n * Allows management of asset information.\n * @see {@link AlgorandClient} for the main entry point that provides access to this manager\n */\nexport class AssetManager {\n  private _algod: AlgodClient\n  private _newGroup: () => TransactionComposer\n\n  /**\n   * Create a new asset manager.\n   * @param algod An algod client\n   * @param newGroup A function that creates a new `TransactionComposer` transaction group\n   * @example Create a new asset manager\n   * ```typescript\n   * const assetManager = new AssetManager(algod, () => new TransactionComposer({algod, () => signer, () => suggestedParams}))\n   * ```\n   */\n  constructor(algod: AlgodClient, newGroup: (config?: TransactionComposerConfig) => TransactionComposer) {\n    this._algod = algod\n    this._newGroup = newGroup\n  }\n\n  /**\n   * Returns the current asset information for the asset with the given ID.\n   *\n   * @example\n   * ```typescript\n   * const assetInfo = await assetManager.getById(12353n);\n   * ```\n   *\n   * @param assetId The ID of the asset\n   * @returns The asset information\n   */\n  public async getById(assetId: bigint): Promise<AssetInformation> {\n    const asset = await this._algod.assetById(assetId)\n\n    return {\n      assetId: BigInt(asset.id),\n      total: BigInt(asset.params.total),\n      decimals: Number(asset.params.decimals),\n      assetName: asset.params.name,\n      assetNameAsBytes: asset.params.nameB64,\n      unitName: asset.params.unitName,\n      unitNameAsBytes: asset.params.unitNameB64,\n      url: asset.params.url,\n      urlAsBytes: asset.params.urlB64,\n      creator: asset.params.creator,\n      manager: asset.params.manager,\n      clawback: asset.params.clawback,\n      freeze: asset.params.freeze,\n      reserve: asset.params.reserve,\n      defaultFrozen: asset.params.defaultFrozen,\n      metadataHash: asset.params.metadataHash,\n    }\n  }\n\n  /**\n   * Returns the given sender account's asset holding for a given asset.\n   *\n   * @example\n   * ```typescript\n   * const address = \"XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA\";\n   * const assetId = 123345n;\n   * const accountInfo = await assetManager.getAccountInformation(address, assetId);\n   * ```\n   *\n   * [Response data schema details](https://dev.algorand.co/reference/rest-apis/algod/#accountassetinformation)\n   * @param sender The address of the sender/account to look up\n   * @param assetId The ID of the asset to return a holding for\n   * @returns The account asset holding information\n   */\n  public async getAccountInformation(sender: string | Address, assetId: bigint): Promise<AccountAssetInformation> {\n    const info = await this._algod.accountAssetInformation(sender.toString(), assetId)\n\n    return {\n      assetId: BigInt(assetId),\n      balance: BigInt(info.assetHolding?.amount ?? 0),\n      frozen: info.assetHolding?.isFrozen === true,\n      round: BigInt(info['round']),\n    }\n  }\n\n  /**\n   * Opt an account in to a list of Algorand Standard Assets.\n   *\n   * Transactions will be sent in batches of 16 as transaction groups.\n   *\n   * @param account The account to opt-in\n   * @param assetIds The list of asset IDs to opt-in to\n   * @param options Any parameters to control the transaction or execution of the transaction\n   * @example Example using AlgorandClient\n   * ```typescript\n   * // Basic example\n   * assetManager.bulkOptIn(\"ACCOUNTADDRESS\", [12345n, 67890n])\n   * // With configuration\n   * assetManager.bulkOptIn(\"ACCOUNTADDRESS\", [12345n, 67890n], { maxFee: (1000).microAlgo(), suppressLog: true })\n   * ```\n   * @returns An array of records matching asset ID to transaction ID of the opt in\n   */\n  async bulkOptIn(\n    account: string | Address,\n    assetIds: bigint[],\n    options?: Omit<CommonTransactionParams, 'sender'> & SendParams,\n  ): Promise<BulkAssetOptInOutResult[]> {\n    const results: BulkAssetOptInOutResult[] = []\n\n    for (const assetGroup of chunkArray(assetIds, MAX_TRANSACTION_GROUP_SIZE)) {\n      const composer = this._newGroup()\n\n      for (const assetId of assetGroup) {\n        composer.addAssetOptIn({\n          ...options,\n          sender: account,\n          assetId: BigInt(assetId),\n        })\n      }\n\n      const result = await composer.send(options)\n\n      Config.getLogger(options?.suppressLog).info(\n        `Successfully opted in ${account} for assets ${assetGroup.join(', ')} with transaction IDs ${result.txIds.join(', ')}` +\n          `\\n  Grouped under ${result.groupId} in round ${result.confirmations?.[0]?.confirmedRound}.`,\n      )\n\n      assetGroup.forEach((assetId, index) => {\n        results.push({ assetId: BigInt(assetId), transactionId: result.txIds[index] })\n      })\n    }\n\n    return results\n  }\n\n  /**\n   * Opt an account out of a list of Algorand Standard Assets.\n   *\n   * Transactions will be sent in batches of 16 as transaction groups.\n   *\n   * @param account The account to opt-in\n   * @param assetIds The list of asset IDs to opt-out of\n   * @param options Any parameters to control the transaction or execution of the transaction\n   * @example Example using AlgorandClient\n   * ```typescript\n   * // Basic example\n   * assetManager.bulkOptOut(\"ACCOUNTADDRESS\", [12345n, 67890n])\n   * // With configuration\n   * assetManager.bulkOptOut(\"ACCOUNTADDRESS\", [12345n, 67890n], { ensureZeroBalance: true, maxFee: (1000).microAlgo(), suppressLog: true })\n   * ```\n   * @returns An array of records matching asset ID to transaction ID of the opt in\n   */\n  async bulkOptOut(\n    account: string | Address,\n    assetIds: bigint[],\n    options?: Omit<CommonTransactionParams, 'sender'> &\n      SendParams & {\n        /** Whether or not to check if the account has a zero balance for each asset first or not.\n         *\n         * Defaults to `true`.\n         *\n         * If this is set to `true` and the account has an asset balance it will throw an error.\n         *\n         * If this is set to `false` and the account has an asset balance it will lose those assets to the asset creator.\n         */\n        ensureZeroBalance?: boolean\n      },\n  ): Promise<BulkAssetOptInOutResult[]> {\n    const results: BulkAssetOptInOutResult[] = []\n\n    for (const assetGroup of chunkArray(assetIds, MAX_TRANSACTION_GROUP_SIZE)) {\n      const composer = this._newGroup()\n\n      const notOptedInAssetIds: bigint[] = []\n      const nonZeroBalanceAssetIds: bigint[] = []\n      for (const assetId of assetGroup) {\n        if (options?.ensureZeroBalance !== false) {\n          try {\n            const accountAssetInfo = await this.getAccountInformation(account, assetId)\n            if (accountAssetInfo.balance !== 0n) {\n              nonZeroBalanceAssetIds.push(BigInt(assetId))\n            }\n          } catch {\n            notOptedInAssetIds.push(BigInt(assetId))\n          }\n        }\n      }\n\n      if (notOptedInAssetIds.length > 0 || nonZeroBalanceAssetIds.length > 0) {\n        throw new Error(\n          `Account ${account}${notOptedInAssetIds.length > 0 ? ` is not opted-in to Asset${notOptedInAssetIds.length > 1 ? 's' : ''} ${notOptedInAssetIds.join(', ')}` : ''}${\n            nonZeroBalanceAssetIds.length > 0\n              ? ` has non-zero balance for Asset${nonZeroBalanceAssetIds.length > 1 ? 's' : ''} ${nonZeroBalanceAssetIds.join(', ')}`\n              : ''\n          }; can't opt-out.`,\n        )\n      }\n\n      for (const assetId of assetGroup) {\n        composer.addAssetOptOut({\n          ...options,\n          creator: (await this.getById(BigInt(assetId))).creator,\n          sender: account,\n          assetId: BigInt(assetId),\n        })\n      }\n\n      const result = await composer.send(options)\n\n      Config.getLogger(options?.suppressLog).info(\n        `Successfully opted ${account} out of assets ${assetGroup.join(', ')} with transaction IDs ${result.txIds.join(', ')}` +\n          `\\n  Grouped under ${result.groupId} in round ${result.confirmations?.[0]?.confirmedRound}.`,\n      )\n\n      assetGroup.forEach((assetId, index) => {\n        results.push({ assetId: BigInt(assetId), transactionId: result.txIds[index] })\n      })\n    }\n\n    return results\n  }\n}\n"],"mappings":";;;;;;;;;;AA6IA,IAAa,eAAb,MAA0B;CACxB,AAAQ;CACR,AAAQ;;;;;;;;;;CAWR,YAAY,OAAoB,UAAuE;AACrG,OAAK,SAAS;AACd,OAAK,YAAY;;;;;;;;;;;;;CAcnB,MAAa,QAAQ,SAA4C;EAC/D,MAAM,QAAQ,MAAM,KAAK,OAAO,UAAU,QAAQ;AAElD,SAAO;GACL,SAAS,OAAO,MAAM,GAAG;GACzB,OAAO,OAAO,MAAM,OAAO,MAAM;GACjC,UAAU,OAAO,MAAM,OAAO,SAAS;GACvC,WAAW,MAAM,OAAO;GACxB,kBAAkB,MAAM,OAAO;GAC/B,UAAU,MAAM,OAAO;GACvB,iBAAiB,MAAM,OAAO;GAC9B,KAAK,MAAM,OAAO;GAClB,YAAY,MAAM,OAAO;GACzB,SAAS,MAAM,OAAO;GACtB,SAAS,MAAM,OAAO;GACtB,UAAU,MAAM,OAAO;GACvB,QAAQ,MAAM,OAAO;GACrB,SAAS,MAAM,OAAO;GACtB,eAAe,MAAM,OAAO;GAC5B,cAAc,MAAM,OAAO;GAC5B;;;;;;;;;;;;;;;;;CAkBH,MAAa,sBAAsB,QAA0B,SAAmD;EAC9G,MAAM,OAAO,MAAM,KAAK,OAAO,wBAAwB,OAAO,UAAU,EAAE,QAAQ;AAElF,SAAO;GACL,SAAS,OAAO,QAAQ;GACxB,SAAS,OAAO,KAAK,cAAc,UAAU,EAAE;GAC/C,QAAQ,KAAK,cAAc,aAAa;GACxC,OAAO,OAAO,KAAK,SAAS;GAC7B;;;;;;;;;;;;;;;;;;;CAoBH,MAAM,UACJ,SACA,UACA,SACoC;EACpC,MAAM,UAAqC,EAAE;AAE7C,OAAK,MAAM,cAAcA,wBAAW,UAAUC,6CAA2B,EAAE;GACzE,MAAM,WAAW,KAAK,WAAW;AAEjC,QAAK,MAAM,WAAW,WACpB,UAAS,cAAc;IACrB,GAAG;IACH,QAAQ;IACR,SAAS,OAAO,QAAQ;IACzB,CAAC;GAGJ,MAAM,SAAS,MAAM,SAAS,KAAK,QAAQ;AAE3C,yBAAO,UAAU,SAAS,YAAY,CAAC,KACrC,yBAAyB,QAAQ,cAAc,WAAW,KAAK,KAAK,CAAC,wBAAwB,OAAO,MAAM,KAAK,KAAK,qBAC7F,OAAO,QAAQ,YAAY,OAAO,gBAAgB,IAAI,eAAe,GAC7F;AAED,cAAW,SAAS,SAAS,UAAU;AACrC,YAAQ,KAAK;KAAE,SAAS,OAAO,QAAQ;KAAE,eAAe,OAAO,MAAM;KAAQ,CAAC;KAC9E;;AAGJ,SAAO;;;;;;;;;;;;;;;;;;;CAoBT,MAAM,WACJ,SACA,UACA,SAYoC;EACpC,MAAM,UAAqC,EAAE;AAE7C,OAAK,MAAM,cAAcD,wBAAW,UAAUC,6CAA2B,EAAE;GACzE,MAAM,WAAW,KAAK,WAAW;GAEjC,MAAM,qBAA+B,EAAE;GACvC,MAAM,yBAAmC,EAAE;AAC3C,QAAK,MAAM,WAAW,WACpB,KAAI,SAAS,sBAAsB,MACjC,KAAI;AAEF,SADyB,MAAM,KAAK,sBAAsB,SAAS,QAAQ,EACtD,YAAY,GAC/B,wBAAuB,KAAK,OAAO,QAAQ,CAAC;WAExC;AACN,uBAAmB,KAAK,OAAO,QAAQ,CAAC;;AAK9C,OAAI,mBAAmB,SAAS,KAAK,uBAAuB,SAAS,EACnE,OAAM,IAAI,MACR,WAAW,UAAU,mBAAmB,SAAS,IAAI,4BAA4B,mBAAmB,SAAS,IAAI,MAAM,GAAG,GAAG,mBAAmB,KAAK,KAAK,KAAK,KAC7J,uBAAuB,SAAS,IAC5B,kCAAkC,uBAAuB,SAAS,IAAI,MAAM,GAAG,GAAG,uBAAuB,KAAK,KAAK,KACnH,GACL,kBACF;AAGH,QAAK,MAAM,WAAW,WACpB,UAAS,eAAe;IACtB,GAAG;IACH,UAAU,MAAM,KAAK,QAAQ,OAAO,QAAQ,CAAC,EAAE;IAC/C,QAAQ;IACR,SAAS,OAAO,QAAQ;IACzB,CAAC;GAGJ,MAAM,SAAS,MAAM,SAAS,KAAK,QAAQ;AAE3C,yBAAO,UAAU,SAAS,YAAY,CAAC,KACrC,sBAAsB,QAAQ,iBAAiB,WAAW,KAAK,KAAK,CAAC,wBAAwB,OAAO,MAAM,KAAK,KAAK,qBAC7F,OAAO,QAAQ,YAAY,OAAO,gBAAgB,IAAI,eAAe,GAC7F;AAED,cAAW,SAAS,SAAS,UAAU;AACrC,YAAQ,KAAK;KAAE,SAAS,OAAO,QAAQ;KAAE,eAAe,OAAO,MAAM;KAAQ,CAAC;KAC9E;;AAGJ,SAAO"}

package/asset-manager.mjs

@@ -0,0 +1,169 @@
+import { MAX_TRANSACTION_GROUP_SIZE } from "./packages/common/src/constants.mjs";
+import { Config } from "./config.mjs";
+import { chunkArray } from "./util.mjs";
+
+//#region src/asset-manager.ts
+/**
+* Allows management of asset information.
+* @see {@link AlgorandClient} for the main entry point that provides access to this manager
+*/
+var AssetManager = class {
+	_algod;
+	_newGroup;
+	/**
+	* Create a new asset manager.
+	* @param algod An algod client
+	* @param newGroup A function that creates a new `TransactionComposer` transaction group
+	* @example Create a new asset manager
+	* ```typescript
+	* const assetManager = new AssetManager(algod, () => new TransactionComposer({algod, () => signer, () => suggestedParams}))
+	* ```
+	*/
+	constructor(algod, newGroup) {
+		this._algod = algod;
+		this._newGroup = newGroup;
+	}
+	/**
+	* Returns the current asset information for the asset with the given ID.
+	*
+	* @example
+	* ```typescript
+	* const assetInfo = await assetManager.getById(12353n);
+	* ```
+	*
+	* @param assetId The ID of the asset
+	* @returns The asset information
+	*/
+	async getById(assetId) {
+		const asset = await this._algod.assetById(assetId);
+		return {
+			assetId: BigInt(asset.id),
+			total: BigInt(asset.params.total),
+			decimals: Number(asset.params.decimals),
+			assetName: asset.params.name,
+			assetNameAsBytes: asset.params.nameB64,
+			unitName: asset.params.unitName,
+			unitNameAsBytes: asset.params.unitNameB64,
+			url: asset.params.url,
+			urlAsBytes: asset.params.urlB64,
+			creator: asset.params.creator,
+			manager: asset.params.manager,
+			clawback: asset.params.clawback,
+			freeze: asset.params.freeze,
+			reserve: asset.params.reserve,
+			defaultFrozen: asset.params.defaultFrozen,
+			metadataHash: asset.params.metadataHash
+		};
+	}
+	/**
+	* Returns the given sender account's asset holding for a given asset.
+	*
+	* @example
+	* ```typescript
+	* const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+	* const assetId = 123345n;
+	* const accountInfo = await assetManager.getAccountInformation(address, assetId);
+	* ```
+	*
+	* [Response data schema details](https://dev.algorand.co/reference/rest-apis/algod/#accountassetinformation)
+	* @param sender The address of the sender/account to look up
+	* @param assetId The ID of the asset to return a holding for
+	* @returns The account asset holding information
+	*/
+	async getAccountInformation(sender, assetId) {
+		const info = await this._algod.accountAssetInformation(sender.toString(), assetId);
+		return {
+			assetId: BigInt(assetId),
+			balance: BigInt(info.assetHolding?.amount ?? 0),
+			frozen: info.assetHolding?.isFrozen === true,
+			round: BigInt(info["round"])
+		};
+	}
+	/**
+	* Opt an account in to a list of Algorand Standard Assets.
+	*
+	* Transactions will be sent in batches of 16 as transaction groups.
+	*
+	* @param account The account to opt-in
+	* @param assetIds The list of asset IDs to opt-in to
+	* @param options Any parameters to control the transaction or execution of the transaction
+	* @example Example using AlgorandClient
+	* ```typescript
+	* // Basic example
+	* assetManager.bulkOptIn("ACCOUNTADDRESS", [12345n, 67890n])
+	* // With configuration
+	* assetManager.bulkOptIn("ACCOUNTADDRESS", [12345n, 67890n], { maxFee: (1000).microAlgo(), suppressLog: true })
+	* ```
+	* @returns An array of records matching asset ID to transaction ID of the opt in
+	*/
+	async bulkOptIn(account, assetIds, options) {
+		const results = [];
+		for (const assetGroup of chunkArray(assetIds, MAX_TRANSACTION_GROUP_SIZE)) {
+			const composer = this._newGroup();
+			for (const assetId of assetGroup) composer.addAssetOptIn({
+				...options,
+				sender: account,
+				assetId: BigInt(assetId)
+			});
+			const result = await composer.send(options);
+			Config.getLogger(options?.suppressLog).info(`Successfully opted in ${account} for assets ${assetGroup.join(", ")} with transaction IDs ${result.txIds.join(", ")}\n  Grouped under ${result.groupId} in round ${result.confirmations?.[0]?.confirmedRound}.`);
+			assetGroup.forEach((assetId, index) => {
+				results.push({
+					assetId: BigInt(assetId),
+					transactionId: result.txIds[index]
+				});
+			});
+		}
+		return results;
+	}
+	/**
+	* Opt an account out of a list of Algorand Standard Assets.
+	*
+	* Transactions will be sent in batches of 16 as transaction groups.
+	*
+	* @param account The account to opt-in
+	* @param assetIds The list of asset IDs to opt-out of
+	* @param options Any parameters to control the transaction or execution of the transaction
+	* @example Example using AlgorandClient
+	* ```typescript
+	* // Basic example
+	* assetManager.bulkOptOut("ACCOUNTADDRESS", [12345n, 67890n])
+	* // With configuration
+	* assetManager.bulkOptOut("ACCOUNTADDRESS", [12345n, 67890n], { ensureZeroBalance: true, maxFee: (1000).microAlgo(), suppressLog: true })
+	* ```
+	* @returns An array of records matching asset ID to transaction ID of the opt in
+	*/
+	async bulkOptOut(account, assetIds, options) {
+		const results = [];
+		for (const assetGroup of chunkArray(assetIds, MAX_TRANSACTION_GROUP_SIZE)) {
+			const composer = this._newGroup();
+			const notOptedInAssetIds = [];
+			const nonZeroBalanceAssetIds = [];
+			for (const assetId of assetGroup) if (options?.ensureZeroBalance !== false) try {
+				if ((await this.getAccountInformation(account, assetId)).balance !== 0n) nonZeroBalanceAssetIds.push(BigInt(assetId));
+			} catch {
+				notOptedInAssetIds.push(BigInt(assetId));
+			}
+			if (notOptedInAssetIds.length > 0 || nonZeroBalanceAssetIds.length > 0) throw new Error(`Account ${account}${notOptedInAssetIds.length > 0 ? ` is not opted-in to Asset${notOptedInAssetIds.length > 1 ? "s" : ""} ${notOptedInAssetIds.join(", ")}` : ""}${nonZeroBalanceAssetIds.length > 0 ? ` has non-zero balance for Asset${nonZeroBalanceAssetIds.length > 1 ? "s" : ""} ${nonZeroBalanceAssetIds.join(", ")}` : ""}; can't opt-out.`);
+			for (const assetId of assetGroup) composer.addAssetOptOut({
+				...options,
+				creator: (await this.getById(BigInt(assetId))).creator,
+				sender: account,
+				assetId: BigInt(assetId)
+			});
+			const result = await composer.send(options);
+			Config.getLogger(options?.suppressLog).info(`Successfully opted ${account} out of assets ${assetGroup.join(", ")} with transaction IDs ${result.txIds.join(", ")}\n  Grouped under ${result.groupId} in round ${result.confirmations?.[0]?.confirmedRound}.`);
+			assetGroup.forEach((assetId, index) => {
+				results.push({
+					assetId: BigInt(assetId),
+					transactionId: result.txIds[index]
+				});
+			});
+		}
+		return results;
+	}
+};
+
+//#endregion
+export { AssetManager };
+//# sourceMappingURL=asset-manager.mjs.map

package/asset-manager.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"asset-manager.mjs","names":[],"sources":["../src/asset-manager.ts"],"sourcesContent":["import { AlgodClient } from '@algorandfoundation/algokit-algod-client'\nimport { Address, MAX_TRANSACTION_GROUP_SIZE } from '@algorandfoundation/algokit-common'\nimport { AccountAssetInformation } from './account'\nimport { CommonTransactionParams, TransactionComposer, TransactionComposerConfig } from './composer'\nimport { Config } from './config'\nimport { SendParams } from './transaction/types'\nimport { chunkArray } from './util'\n\n/** Individual result from performing a bulk opt-in or bulk opt-out for an account against a series of assets. */\nexport interface BulkAssetOptInOutResult {\n  /** The ID of the asset opted into / out of */\n  assetId: bigint\n  /** The transaction ID of the resulting opt in / out */\n  transactionId: string\n}\n\n/** Information about an asset. */\nexport interface AssetInformation {\n  /** The ID of the asset. */\n  assetId: bigint\n\n  /** The address of the account that created the asset.\n   *\n   * This is the address where the parameters for this asset can be found,\n   * and also the address where unwanted asset units can be sent when\n   * closing out an asset position and opting-out of the asset.\n   */\n  creator: string\n\n  /** The total amount of the smallest divisible (decimal) units that were created of the asset.\n   *\n   * For example, if `decimals` is, say, 2, then for every 100 `total` there is 1 whole unit.\n   */\n  total: bigint\n\n  /** The amount of decimal places the asset was created with.\n   *\n   * * If 0, the asset is not divisible;\n   * * If 1, the base unit of the asset is in tenths;\n   * * If 2, the base unit of the asset is in hundredths;\n   * * If 3, the base unit of the asset is in thousandths;\n   * * and so on up to 19 decimal places.\n   */\n  decimals: number\n\n  /** Whether the asset was frozen by default for all accounts.\n   *\n   * If `true` then for anyone apart from the creator to hold the\n   * asset it needs to be unfrozen per account using an asset freeze\n   * transaction from the `freeze` account.\n   */\n  defaultFrozen?: boolean\n\n  /** The address of the optional account that can manage the configuration of the asset and destroy it.\n   *\n   * If not set the asset is permanently immutable.\n   */\n  manager?: string\n\n  /**\n   * The address of the optional account that holds the reserve (uncirculated supply) units of the asset.\n   *\n   * This address has no specific authority in the protocol itself and is informational only.\n   *\n   * Some standards like [ARC-19](https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0019.md)\n   * rely on this field to hold meaningful data.\n   *\n   * It can be used in the case where you want to signal to holders of your asset that the uncirculated units\n   * of the asset reside in an account that is different from the default creator account.\n   *\n   * If not set the field is permanently empty.\n   */\n  reserve?: string\n\n  /**\n   * The address of the optional account that can be used to freeze or unfreeze holdings of this asset for any account.\n   *\n   * If empty, freezing is not permitted.\n   *\n   * If not set the field is permanently empty.\n   */\n  freeze?: string\n\n  /**\n   * The address of the optional account that can clawback holdings of this asset from any account.\n   *\n   * The clawback account has the ability to **unconditionally take assets from any account**.\n   *\n   * If empty, clawback is not permitted.\n   *\n   * If not set the field is permanently empty.\n   */\n  clawback?: string\n\n  /** The optional name of the unit of this asset (e.g. ticker name).\n   *\n   * Max size is 8 bytes.\n   */\n  unitName?: string\n\n  /** The optional name of the unit of this asset (e.g. ticker name).\n   *\n   * Max size is 8 bytes.\n   */\n  unitNameAsBytes?: Uint8Array\n\n  /** The optional name of the asset.\n   *\n   * Max size is 32 bytes.\n   */\n  assetName?: string\n\n  /** The optional name of the asset.\n   *\n   * Max size is 32 bytes.\n   */\n  assetNameAsBytes?: Uint8Array\n\n  /** Optional URL where more information about the asset can be retrieved (e.g. metadata).\n   *\n   * Max size is 96 bytes.\n   */\n  url?: string\n\n  /** Optional URL where more information about the asset can be retrieved (e.g. metadata).\n   *\n   * Max size is 96 bytes.\n   */\n  urlAsBytes?: Uint8Array\n\n  /** 32-byte hash of some metadata that is relevant to the asset and/or asset holders.\n   *\n   * The format of this metadata is up to the application.\n   */\n  metadataHash?: Uint8Array\n}\n\n/**\n * Allows management of asset information.\n * @see {@link AlgorandClient} for the main entry point that provides access to this manager\n */\nexport class AssetManager {\n  private _algod: AlgodClient\n  private _newGroup: () => TransactionComposer\n\n  /**\n   * Create a new asset manager.\n   * @param algod An algod client\n   * @param newGroup A function that creates a new `TransactionComposer` transaction group\n   * @example Create a new asset manager\n   * ```typescript\n   * const assetManager = new AssetManager(algod, () => new TransactionComposer({algod, () => signer, () => suggestedParams}))\n   * ```\n   */\n  constructor(algod: AlgodClient, newGroup: (config?: TransactionComposerConfig) => TransactionComposer) {\n    this._algod = algod\n    this._newGroup = newGroup\n  }\n\n  /**\n   * Returns the current asset information for the asset with the given ID.\n   *\n   * @example\n   * ```typescript\n   * const assetInfo = await assetManager.getById(12353n);\n   * ```\n   *\n   * @param assetId The ID of the asset\n   * @returns The asset information\n   */\n  public async getById(assetId: bigint): Promise<AssetInformation> {\n    const asset = await this._algod.assetById(assetId)\n\n    return {\n      assetId: BigInt(asset.id),\n      total: BigInt(asset.params.total),\n      decimals: Number(asset.params.decimals),\n      assetName: asset.params.name,\n      assetNameAsBytes: asset.params.nameB64,\n      unitName: asset.params.unitName,\n      unitNameAsBytes: asset.params.unitNameB64,\n      url: asset.params.url,\n      urlAsBytes: asset.params.urlB64,\n      creator: asset.params.creator,\n      manager: asset.params.manager,\n      clawback: asset.params.clawback,\n      freeze: asset.params.freeze,\n      reserve: asset.params.reserve,\n      defaultFrozen: asset.params.defaultFrozen,\n      metadataHash: asset.params.metadataHash,\n    }\n  }\n\n  /**\n   * Returns the given sender account's asset holding for a given asset.\n   *\n   * @example\n   * ```typescript\n   * const address = \"XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA\";\n   * const assetId = 123345n;\n   * const accountInfo = await assetManager.getAccountInformation(address, assetId);\n   * ```\n   *\n   * [Response data schema details](https://dev.algorand.co/reference/rest-apis/algod/#accountassetinformation)\n   * @param sender The address of the sender/account to look up\n   * @param assetId The ID of the asset to return a holding for\n   * @returns The account asset holding information\n   */\n  public async getAccountInformation(sender: string | Address, assetId: bigint): Promise<AccountAssetInformation> {\n    const info = await this._algod.accountAssetInformation(sender.toString(), assetId)\n\n    return {\n      assetId: BigInt(assetId),\n      balance: BigInt(info.assetHolding?.amount ?? 0),\n      frozen: info.assetHolding?.isFrozen === true,\n      round: BigInt(info['round']),\n    }\n  }\n\n  /**\n   * Opt an account in to a list of Algorand Standard Assets.\n   *\n   * Transactions will be sent in batches of 16 as transaction groups.\n   *\n   * @param account The account to opt-in\n   * @param assetIds The list of asset IDs to opt-in to\n   * @param options Any parameters to control the transaction or execution of the transaction\n   * @example Example using AlgorandClient\n   * ```typescript\n   * // Basic example\n   * assetManager.bulkOptIn(\"ACCOUNTADDRESS\", [12345n, 67890n])\n   * // With configuration\n   * assetManager.bulkOptIn(\"ACCOUNTADDRESS\", [12345n, 67890n], { maxFee: (1000).microAlgo(), suppressLog: true })\n   * ```\n   * @returns An array of records matching asset ID to transaction ID of the opt in\n   */\n  async bulkOptIn(\n    account: string | Address,\n    assetIds: bigint[],\n    options?: Omit<CommonTransactionParams, 'sender'> & SendParams,\n  ): Promise<BulkAssetOptInOutResult[]> {\n    const results: BulkAssetOptInOutResult[] = []\n\n    for (const assetGroup of chunkArray(assetIds, MAX_TRANSACTION_GROUP_SIZE)) {\n      const composer = this._newGroup()\n\n      for (const assetId of assetGroup) {\n        composer.addAssetOptIn({\n          ...options,\n          sender: account,\n          assetId: BigInt(assetId),\n        })\n      }\n\n      const result = await composer.send(options)\n\n      Config.getLogger(options?.suppressLog).info(\n        `Successfully opted in ${account} for assets ${assetGroup.join(', ')} with transaction IDs ${result.txIds.join(', ')}` +\n          `\\n  Grouped under ${result.groupId} in round ${result.confirmations?.[0]?.confirmedRound}.`,\n      )\n\n      assetGroup.forEach((assetId, index) => {\n        results.push({ assetId: BigInt(assetId), transactionId: result.txIds[index] })\n      })\n    }\n\n    return results\n  }\n\n  /**\n   * Opt an account out of a list of Algorand Standard Assets.\n   *\n   * Transactions will be sent in batches of 16 as transaction groups.\n   *\n   * @param account The account to opt-in\n   * @param assetIds The list of asset IDs to opt-out of\n   * @param options Any parameters to control the transaction or execution of the transaction\n   * @example Example using AlgorandClient\n   * ```typescript\n   * // Basic example\n   * assetManager.bulkOptOut(\"ACCOUNTADDRESS\", [12345n, 67890n])\n   * // With configuration\n   * assetManager.bulkOptOut(\"ACCOUNTADDRESS\", [12345n, 67890n], { ensureZeroBalance: true, maxFee: (1000).microAlgo(), suppressLog: true })\n   * ```\n   * @returns An array of records matching asset ID to transaction ID of the opt in\n   */\n  async bulkOptOut(\n    account: string | Address,\n    assetIds: bigint[],\n    options?: Omit<CommonTransactionParams, 'sender'> &\n      SendParams & {\n        /** Whether or not to check if the account has a zero balance for each asset first or not.\n         *\n         * Defaults to `true`.\n         *\n         * If this is set to `true` and the account has an asset balance it will throw an error.\n         *\n         * If this is set to `false` and the account has an asset balance it will lose those assets to the asset creator.\n         */\n        ensureZeroBalance?: boolean\n      },\n  ): Promise<BulkAssetOptInOutResult[]> {\n    const results: BulkAssetOptInOutResult[] = []\n\n    for (const assetGroup of chunkArray(assetIds, MAX_TRANSACTION_GROUP_SIZE)) {\n      const composer = this._newGroup()\n\n      const notOptedInAssetIds: bigint[] = []\n      const nonZeroBalanceAssetIds: bigint[] = []\n      for (const assetId of assetGroup) {\n        if (options?.ensureZeroBalance !== false) {\n          try {\n            const accountAssetInfo = await this.getAccountInformation(account, assetId)\n            if (accountAssetInfo.balance !== 0n) {\n              nonZeroBalanceAssetIds.push(BigInt(assetId))\n            }\n          } catch {\n            notOptedInAssetIds.push(BigInt(assetId))\n          }\n        }\n      }\n\n      if (notOptedInAssetIds.length > 0 || nonZeroBalanceAssetIds.length > 0) {\n        throw new Error(\n          `Account ${account}${notOptedInAssetIds.length > 0 ? ` is not opted-in to Asset${notOptedInAssetIds.length > 1 ? 's' : ''} ${notOptedInAssetIds.join(', ')}` : ''}${\n            nonZeroBalanceAssetIds.length > 0\n              ? ` has non-zero balance for Asset${nonZeroBalanceAssetIds.length > 1 ? 's' : ''} ${nonZeroBalanceAssetIds.join(', ')}`\n              : ''\n          }; can't opt-out.`,\n        )\n      }\n\n      for (const assetId of assetGroup) {\n        composer.addAssetOptOut({\n          ...options,\n          creator: (await this.getById(BigInt(assetId))).creator,\n          sender: account,\n          assetId: BigInt(assetId),\n        })\n      }\n\n      const result = await composer.send(options)\n\n      Config.getLogger(options?.suppressLog).info(\n        `Successfully opted ${account} out of assets ${assetGroup.join(', ')} with transaction IDs ${result.txIds.join(', ')}` +\n          `\\n  Grouped under ${result.groupId} in round ${result.confirmations?.[0]?.confirmedRound}.`,\n      )\n\n      assetGroup.forEach((assetId, index) => {\n        results.push({ assetId: BigInt(assetId), transactionId: result.txIds[index] })\n      })\n    }\n\n    return results\n  }\n}\n"],"mappings":";;;;;;;;;AA6IA,IAAa,eAAb,MAA0B;CACxB,AAAQ;CACR,AAAQ;;;;;;;;;;CAWR,YAAY,OAAoB,UAAuE;AACrG,OAAK,SAAS;AACd,OAAK,YAAY;;;;;;;;;;;;;CAcnB,MAAa,QAAQ,SAA4C;EAC/D,MAAM,QAAQ,MAAM,KAAK,OAAO,UAAU,QAAQ;AAElD,SAAO;GACL,SAAS,OAAO,MAAM,GAAG;GACzB,OAAO,OAAO,MAAM,OAAO,MAAM;GACjC,UAAU,OAAO,MAAM,OAAO,SAAS;GACvC,WAAW,MAAM,OAAO;GACxB,kBAAkB,MAAM,OAAO;GAC/B,UAAU,MAAM,OAAO;GACvB,iBAAiB,MAAM,OAAO;GAC9B,KAAK,MAAM,OAAO;GAClB,YAAY,MAAM,OAAO;GACzB,SAAS,MAAM,OAAO;GACtB,SAAS,MAAM,OAAO;GACtB,UAAU,MAAM,OAAO;GACvB,QAAQ,MAAM,OAAO;GACrB,SAAS,MAAM,OAAO;GACtB,eAAe,MAAM,OAAO;GAC5B,cAAc,MAAM,OAAO;GAC5B;;;;;;;;;;;;;;;;;CAkBH,MAAa,sBAAsB,QAA0B,SAAmD;EAC9G,MAAM,OAAO,MAAM,KAAK,OAAO,wBAAwB,OAAO,UAAU,EAAE,QAAQ;AAElF,SAAO;GACL,SAAS,OAAO,QAAQ;GACxB,SAAS,OAAO,KAAK,cAAc,UAAU,EAAE;GAC/C,QAAQ,KAAK,cAAc,aAAa;GACxC,OAAO,OAAO,KAAK,SAAS;GAC7B;;;;;;;;;;;;;;;;;;;CAoBH,MAAM,UACJ,SACA,UACA,SACoC;EACpC,MAAM,UAAqC,EAAE;AAE7C,OAAK,MAAM,cAAc,WAAW,UAAU,2BAA2B,EAAE;GACzE,MAAM,WAAW,KAAK,WAAW;AAEjC,QAAK,MAAM,WAAW,WACpB,UAAS,cAAc;IACrB,GAAG;IACH,QAAQ;IACR,SAAS,OAAO,QAAQ;IACzB,CAAC;GAGJ,MAAM,SAAS,MAAM,SAAS,KAAK,QAAQ;AAE3C,UAAO,UAAU,SAAS,YAAY,CAAC,KACrC,yBAAyB,QAAQ,cAAc,WAAW,KAAK,KAAK,CAAC,wBAAwB,OAAO,MAAM,KAAK,KAAK,qBAC7F,OAAO,QAAQ,YAAY,OAAO,gBAAgB,IAAI,eAAe,GAC7F;AAED,cAAW,SAAS,SAAS,UAAU;AACrC,YAAQ,KAAK;KAAE,SAAS,OAAO,QAAQ;KAAE,eAAe,OAAO,MAAM;KAAQ,CAAC;KAC9E;;AAGJ,SAAO;;;;;;;;;;;;;;;;;;;CAoBT,MAAM,WACJ,SACA,UACA,SAYoC;EACpC,MAAM,UAAqC,EAAE;AAE7C,OAAK,MAAM,cAAc,WAAW,UAAU,2BAA2B,EAAE;GACzE,MAAM,WAAW,KAAK,WAAW;GAEjC,MAAM,qBAA+B,EAAE;GACvC,MAAM,yBAAmC,EAAE;AAC3C,QAAK,MAAM,WAAW,WACpB,KAAI,SAAS,sBAAsB,MACjC,KAAI;AAEF,SADyB,MAAM,KAAK,sBAAsB,SAAS,QAAQ,EACtD,YAAY,GAC/B,wBAAuB,KAAK,OAAO,QAAQ,CAAC;WAExC;AACN,uBAAmB,KAAK,OAAO,QAAQ,CAAC;;AAK9C,OAAI,mBAAmB,SAAS,KAAK,uBAAuB,SAAS,EACnE,OAAM,IAAI,MACR,WAAW,UAAU,mBAAmB,SAAS,IAAI,4BAA4B,mBAAmB,SAAS,IAAI,MAAM,GAAG,GAAG,mBAAmB,KAAK,KAAK,KAAK,KAC7J,uBAAuB,SAAS,IAC5B,kCAAkC,uBAAuB,SAAS,IAAI,MAAM,GAAG,GAAG,uBAAuB,KAAK,KAAK,KACnH,GACL,kBACF;AAGH,QAAK,MAAM,WAAW,WACpB,UAAS,eAAe;IACtB,GAAG;IACH,UAAU,MAAM,KAAK,QAAQ,OAAO,QAAQ,CAAC,EAAE;IAC/C,QAAQ;IACR,SAAS,OAAO,QAAQ;IACzB,CAAC;GAGJ,MAAM,SAAS,MAAM,SAAS,KAAK,QAAQ;AAE3C,UAAO,UAAU,SAAS,YAAY,CAAC,KACrC,sBAAsB,QAAQ,iBAAiB,WAAW,KAAK,KAAK,CAAC,wBAAwB,OAAO,MAAM,KAAK,KAAK,qBAC7F,OAAO,QAAQ,YAAY,OAAO,gBAAgB,IAAI,eAAe,GAC7F;AAED,cAAW,SAAS,SAAS,UAAU;AACrC,YAAQ,KAAK;KAAE,SAAS,OAAO,QAAQ;KAAE,eAAe,OAAO,MAAM;KAAQ,CAAC;KAC9E;;AAGJ,SAAO"}

package/async-event-emitter.d.ts

@@ -0,0 +1,16 @@
+import { EventDataMap, EventType } from "./lifecycle-events.js";
+
+//#region src/async-event-emitter.d.ts
+type AsyncEventListener<T = unknown> = (event: T, eventName: string | symbol) => Promise<void> | void;
+declare class AsyncEventEmitter {
+  private listenerWrapperMap;
+  private listenerMap;
+  emitAsync<K extends string | symbol>(eventName: K, event: K extends EventType ? EventDataMap[K] : unknown): Promise<void>;
+  on<K extends string | symbol>(eventName: K, listener: AsyncEventListener<K extends EventType ? EventDataMap[K] : unknown>): AsyncEventEmitter;
+  once<K extends string | symbol>(eventName: K, listener: AsyncEventListener<K extends EventType ? EventDataMap[K] : unknown>): AsyncEventEmitter;
+  removeListener(eventName: string | symbol, listener: AsyncEventListener): AsyncEventEmitter;
+  off: (eventName: string | symbol, listener: AsyncEventListener) => AsyncEventEmitter;
+}
+//#endregion
+export { AsyncEventEmitter, AsyncEventListener };
+//# sourceMappingURL=async-event-emitter.d.ts.map

package/async-event-emitter.js

@@ -0,0 +1,39 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+
+//#region src/async-event-emitter.ts
+var AsyncEventEmitter = class {
+	listenerWrapperMap = /* @__PURE__ */ new WeakMap();
+	listenerMap = {};
+	async emitAsync(eventName, event) {
+		for (const listener of this.listenerMap[eventName] ?? []) await listener(event, eventName);
+	}
+	on(eventName, listener) {
+		if (!this.listenerMap[eventName]) this.listenerMap[eventName] = [];
+		this.listenerMap[eventName].push(listener);
+		return this;
+	}
+	once(eventName, listener) {
+		const wrappedListener = async (event, eventName) => {
+			try {
+				return await listener(event, eventName);
+			} finally {
+				this.removeListener(eventName, wrappedListener);
+			}
+		};
+		this.listenerWrapperMap.set(listener, wrappedListener);
+		return this.on(eventName, wrappedListener);
+	}
+	removeListener(eventName, listener) {
+		const wrappedListener = this.listenerWrapperMap.get(listener);
+		if (wrappedListener) {
+			this.listenerWrapperMap.delete(listener);
+			if (this.listenerMap[eventName]?.indexOf(wrappedListener) !== -1) this.listenerMap[eventName].splice(this.listenerMap[eventName].indexOf(wrappedListener), 1);
+		} else if (this.listenerMap[eventName]?.indexOf(listener) !== -1) this.listenerMap[eventName].splice(this.listenerMap[eventName].indexOf(listener), 1);
+		return this;
+	}
+	off = this.removeListener;
+};
+
+//#endregion
+exports.AsyncEventEmitter = AsyncEventEmitter;
+//# sourceMappingURL=async-event-emitter.js.map

package/async-event-emitter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"async-event-emitter.js","names":[],"sources":["../src/async-event-emitter.ts"],"sourcesContent":["import { EventDataMap, EventType } from './lifecycle-events'\n\nexport type AsyncEventListener<T = unknown> = (event: T, eventName: string | symbol) => Promise<void> | void\n\nexport class AsyncEventEmitter {\n  private listenerWrapperMap = new WeakMap<AsyncEventListener, AsyncEventListener>()\n  private listenerMap: Record<string | symbol, AsyncEventListener[]> = {}\n\n  async emitAsync<K extends string | symbol>(eventName: K, event: K extends EventType ? EventDataMap[K] : unknown): Promise<void> {\n    for (const listener of this.listenerMap[eventName] ?? []) {\n      await listener(event, eventName)\n    }\n  }\n\n  on<K extends string | symbol>(\n    eventName: K,\n    listener: AsyncEventListener<K extends EventType ? EventDataMap[K] : unknown>,\n  ): AsyncEventEmitter {\n    if (!this.listenerMap[eventName]) this.listenerMap[eventName] = []\n    this.listenerMap[eventName].push(listener as AsyncEventListener)\n    return this\n  }\n\n  once<K extends string | symbol>(\n    eventName: K,\n    listener: AsyncEventListener<K extends EventType ? EventDataMap[K] : unknown>,\n  ): AsyncEventEmitter {\n    const wrappedListener: AsyncEventListener = async (event, eventName) => {\n      try {\n        return await (listener as AsyncEventListener)(event, eventName)\n      } finally {\n        this.removeListener(eventName, wrappedListener)\n      }\n    }\n    this.listenerWrapperMap.set(listener as AsyncEventListener, wrappedListener)\n    return this.on(eventName, wrappedListener as AsyncEventListener<K extends EventType ? EventDataMap[K] : unknown>)\n  }\n\n  removeListener(eventName: string | symbol, listener: AsyncEventListener): AsyncEventEmitter {\n    const wrappedListener = this.listenerWrapperMap.get(listener)\n    if (wrappedListener) {\n      this.listenerWrapperMap.delete(listener)\n      if (this.listenerMap[eventName]?.indexOf(wrappedListener) !== -1) {\n        this.listenerMap[eventName].splice(this.listenerMap[eventName].indexOf(wrappedListener), 1)\n      }\n    } else {\n      if (this.listenerMap[eventName]?.indexOf(listener) !== -1) {\n        this.listenerMap[eventName].splice(this.listenerMap[eventName].indexOf(listener), 1)\n      }\n    }\n\n    return this\n  }\n\n  off = this.removeListener\n}\n"],"mappings":";;;AAIA,IAAa,oBAAb,MAA+B;CAC7B,AAAQ,qCAAqB,IAAI,SAAiD;CAClF,AAAQ,cAA6D,EAAE;CAEvE,MAAM,UAAqC,WAAc,OAAuE;AAC9H,OAAK,MAAM,YAAY,KAAK,YAAY,cAAc,EAAE,CACtD,OAAM,SAAS,OAAO,UAAU;;CAIpC,GACE,WACA,UACmB;AACnB,MAAI,CAAC,KAAK,YAAY,WAAY,MAAK,YAAY,aAAa,EAAE;AAClE,OAAK,YAAY,WAAW,KAAK,SAA+B;AAChE,SAAO;;CAGT,KACE,WACA,UACmB;EACnB,MAAM,kBAAsC,OAAO,OAAO,cAAc;AACtE,OAAI;AACF,WAAO,MAAO,SAAgC,OAAO,UAAU;aACvD;AACR,SAAK,eAAe,WAAW,gBAAgB;;;AAGnD,OAAK,mBAAmB,IAAI,UAAgC,gBAAgB;AAC5E,SAAO,KAAK,GAAG,WAAW,gBAAuF;;CAGnH,eAAe,WAA4B,UAAiD;EAC1F,MAAM,kBAAkB,KAAK,mBAAmB,IAAI,SAAS;AAC7D,MAAI,iBAAiB;AACnB,QAAK,mBAAmB,OAAO,SAAS;AACxC,OAAI,KAAK,YAAY,YAAY,QAAQ,gBAAgB,KAAK,GAC5D,MAAK,YAAY,WAAW,OAAO,KAAK,YAAY,WAAW,QAAQ,gBAAgB,EAAE,EAAE;aAGzF,KAAK,YAAY,YAAY,QAAQ,SAAS,KAAK,GACrD,MAAK,YAAY,WAAW,OAAO,KAAK,YAAY,WAAW,QAAQ,SAAS,EAAE,EAAE;AAIxF,SAAO;;CAGT,MAAM,KAAK"}

package/async-event-emitter.mjs

@@ -0,0 +1,37 @@
+//#region src/async-event-emitter.ts
+var AsyncEventEmitter = class {
+	listenerWrapperMap = /* @__PURE__ */ new WeakMap();
+	listenerMap = {};
+	async emitAsync(eventName, event) {
+		for (const listener of this.listenerMap[eventName] ?? []) await listener(event, eventName);
+	}
+	on(eventName, listener) {
+		if (!this.listenerMap[eventName]) this.listenerMap[eventName] = [];
+		this.listenerMap[eventName].push(listener);
+		return this;
+	}
+	once(eventName, listener) {
+		const wrappedListener = async (event, eventName) => {
+			try {
+				return await listener(event, eventName);
+			} finally {
+				this.removeListener(eventName, wrappedListener);
+			}
+		};
+		this.listenerWrapperMap.set(listener, wrappedListener);
+		return this.on(eventName, wrappedListener);
+	}
+	removeListener(eventName, listener) {
+		const wrappedListener = this.listenerWrapperMap.get(listener);
+		if (wrappedListener) {
+			this.listenerWrapperMap.delete(listener);
+			if (this.listenerMap[eventName]?.indexOf(wrappedListener) !== -1) this.listenerMap[eventName].splice(this.listenerMap[eventName].indexOf(wrappedListener), 1);
+		} else if (this.listenerMap[eventName]?.indexOf(listener) !== -1) this.listenerMap[eventName].splice(this.listenerMap[eventName].indexOf(listener), 1);
+		return this;
+	}
+	off = this.removeListener;
+};
+
+//#endregion
+export { AsyncEventEmitter };
+//# sourceMappingURL=async-event-emitter.mjs.map

package/async-event-emitter.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"async-event-emitter.mjs","names":[],"sources":["../src/async-event-emitter.ts"],"sourcesContent":["import { EventDataMap, EventType } from './lifecycle-events'\n\nexport type AsyncEventListener<T = unknown> = (event: T, eventName: string | symbol) => Promise<void> | void\n\nexport class AsyncEventEmitter {\n  private listenerWrapperMap = new WeakMap<AsyncEventListener, AsyncEventListener>()\n  private listenerMap: Record<string | symbol, AsyncEventListener[]> = {}\n\n  async emitAsync<K extends string | symbol>(eventName: K, event: K extends EventType ? EventDataMap[K] : unknown): Promise<void> {\n    for (const listener of this.listenerMap[eventName] ?? []) {\n      await listener(event, eventName)\n    }\n  }\n\n  on<K extends string | symbol>(\n    eventName: K,\n    listener: AsyncEventListener<K extends EventType ? EventDataMap[K] : unknown>,\n  ): AsyncEventEmitter {\n    if (!this.listenerMap[eventName]) this.listenerMap[eventName] = []\n    this.listenerMap[eventName].push(listener as AsyncEventListener)\n    return this\n  }\n\n  once<K extends string | symbol>(\n    eventName: K,\n    listener: AsyncEventListener<K extends EventType ? EventDataMap[K] : unknown>,\n  ): AsyncEventEmitter {\n    const wrappedListener: AsyncEventListener = async (event, eventName) => {\n      try {\n        return await (listener as AsyncEventListener)(event, eventName)\n      } finally {\n        this.removeListener(eventName, wrappedListener)\n      }\n    }\n    this.listenerWrapperMap.set(listener as AsyncEventListener, wrappedListener)\n    return this.on(eventName, wrappedListener as AsyncEventListener<K extends EventType ? EventDataMap[K] : unknown>)\n  }\n\n  removeListener(eventName: string | symbol, listener: AsyncEventListener): AsyncEventEmitter {\n    const wrappedListener = this.listenerWrapperMap.get(listener)\n    if (wrappedListener) {\n      this.listenerWrapperMap.delete(listener)\n      if (this.listenerMap[eventName]?.indexOf(wrappedListener) !== -1) {\n        this.listenerMap[eventName].splice(this.listenerMap[eventName].indexOf(wrappedListener), 1)\n      }\n    } else {\n      if (this.listenerMap[eventName]?.indexOf(listener) !== -1) {\n        this.listenerMap[eventName].splice(this.listenerMap[eventName].indexOf(listener), 1)\n      }\n    }\n\n    return this\n  }\n\n  off = this.removeListener\n}\n"],"mappings":";AAIA,IAAa,oBAAb,MAA+B;CAC7B,AAAQ,qCAAqB,IAAI,SAAiD;CAClF,AAAQ,cAA6D,EAAE;CAEvE,MAAM,UAAqC,WAAc,OAAuE;AAC9H,OAAK,MAAM,YAAY,KAAK,YAAY,cAAc,EAAE,CACtD,OAAM,SAAS,OAAO,UAAU;;CAIpC,GACE,WACA,UACmB;AACnB,MAAI,CAAC,KAAK,YAAY,WAAY,MAAK,YAAY,aAAa,EAAE;AAClE,OAAK,YAAY,WAAW,KAAK,SAA+B;AAChE,SAAO;;CAGT,KACE,WACA,UACmB;EACnB,MAAM,kBAAsC,OAAO,OAAO,cAAc;AACtE,OAAI;AACF,WAAO,MAAO,SAAgC,OAAO,UAAU;aACvD;AACR,SAAK,eAAe,WAAW,gBAAgB;;;AAGnD,OAAK,mBAAmB,IAAI,UAAgC,gBAAgB;AAC5E,SAAO,KAAK,GAAG,WAAW,gBAAuF;;CAGnH,eAAe,WAA4B,UAAiD;EAC1F,MAAM,kBAAkB,KAAK,mBAAmB,IAAI,SAAS;AAC7D,MAAI,iBAAiB;AACnB,QAAK,mBAAmB,OAAO,SAAS;AACxC,OAAI,KAAK,YAAY,YAAY,QAAQ,gBAAgB,KAAK,GAC5D,MAAK,YAAY,WAAW,OAAO,KAAK,YAAY,WAAW,QAAQ,gBAAgB,EAAE,EAAE;aAGzF,KAAK,YAAY,YAAY,QAAQ,SAAS,KAAK,GACrD,MAAK,YAAY,WAAW,OAAO,KAAK,YAAY,WAAW,QAAQ,SAAS,EAAE,EAAE;AAIxF,SAAO;;CAGT,MAAM,KAAK"}