@algorandfoundation/algokit-utils 6.2.1 → 7.0.0-alpha.1

package/types/asset-manager.d.ts

@@ -0,0 +1,205 @@
+import algosdk, { Address } from 'algosdk';
+import { AccountAssetInformation } from './account';
+import { CommonTransactionParams, TransactionComposer } from './composer';
+import { SendParams } from './transaction';
+/** Individual result from performing a bulk opt-in or bulk opt-out for an account against a series of assets. */
+export interface BulkAssetOptInOutResult {
+    /** The ID of the asset opted into / out of */
+    assetId: bigint;
+    /** The transaction ID of the resulting opt in / out */
+    transactionId: string;
+}
+/** Information about an asset. */
+export interface AssetInformation {
+    /** The ID of the asset. */
+    assetId: bigint;
+    /** The address of the account that created the asset.
+     *
+     * This is the address where the parameters for this asset can be found,
+     * and also the address where unwanted asset units can be sent when
+     * closing out an asset position and opting-out of the asset.
+     */
+    creator: string;
+    /** The total amount of the smallest divisible (decimal) units that were created of the asset.
+     *
+     * For example, if `decimals` is, say, 2, then for every 100 `total` there is 1 whole unit.
+     */
+    total: bigint;
+    /** The amount of decimal places the asset was created with.
+     *
+     * * If 0, the asset is not divisible;
+     * * If 1, the base unit of the asset is in tenths;
+     * * If 2, the base unit of the asset is in hundredths;
+     * * If 3, the base unit of the asset is in thousandths;
+     * * and so on up to 19 decimal places.
+     */
+    decimals: number;
+    /** Whether the asset was frozen by default for all accounts.
+     *
+     * If `true` then for anyone apart from the creator to hold the
+     * asset it needs to be unfrozen per account using an asset freeze
+     * transaction from the `freeze` account.
+     */
+    defaultFrozen?: boolean;
+    /** The address of the optional account that can manage the configuration of the asset and destroy it.
+     *
+     * If not set the asset is permanently immutable.
+     */
+    manager?: string;
+    /**
+     * The address of the optional account that holds the reserve (uncirculated supply) units of the asset.
+     *
+     * This address has no specific authority in the protocol itself and is informational only.
+     *
+     * Some standards like [ARC-19](https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0019.md)
+     * rely on this field to hold meaningful data.
+     *
+     * It can be used in the case where you want to signal to holders of your asset that the uncirculated units
+     * of the asset reside in an account that is different from the default creator account.
+     *
+     * If not set the field is permanently empty.
+     */
+    reserve?: string;
+    /**
+     * The address of the optional account that can be used to freeze or unfreeze holdings of this asset for any account.
+     *
+     * If empty, freezing is not permitted.
+     *
+     * If not set the field is permanently empty.
+     */
+    freeze?: string;
+    /**
+     * The address of the optional account that can clawback holdings of this asset from any account.
+     *
+     * The clawback account has the ability to **unconditionally take assets from any account**.
+     *
+     * If empty, clawback is not permitted.
+     *
+     * If not set the field is permanently empty.
+     */
+    clawback?: string;
+    /** The optional name of the unit of this asset (e.g. ticker name).
+     *
+     * Max size is 8 bytes.
+     */
+    unitName?: string;
+    /** The optional name of the unit of this asset (e.g. ticker name).
+     *
+     * Max size is 8 bytes.
+     */
+    unitNameAsBytes?: Uint8Array;
+    /** The optional name of the asset.
+     *
+     * Max size is 32 bytes.
+     */
+    assetName?: string;
+    /** The optional name of the asset.
+     *
+     * Max size is 32 bytes.
+     */
+    assetNameAsBytes?: Uint8Array;
+    /** Optional URL where more information about the asset can be retrieved (e.g. metadata).
+     *
+     * Max size is 96 bytes.
+     */
+    url?: string;
+    /** Optional URL where more information about the asset can be retrieved (e.g. metadata).
+     *
+     * Max size is 96 bytes.
+     */
+    urlAsBytes?: Uint8Array;
+    /** 32-byte hash of some metadata that is relevant to the asset and/or asset holders.
+     *
+     * The format of this metadata is up to the application.
+     */
+    metadataHash?: Uint8Array;
+}
+/** Allows management of asset information. */
+export declare class AssetManager {
+    private _algod;
+    private _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: algosdk.Algodv2, newGroup: () => TransactionComposer);
+    /**
+     * 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
+     */
+    getById(assetId: bigint): Promise<AssetInformation>;
+    /**
+     * Returns the given sender account's asset holding for a given asset.
+     *
+     * @example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const assetId = 123345n;
+     * const accountInfo = await algorand.asset.getAccountInformation(address, assetId);
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2accountsaddressassetsasset-id)
+     * @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
+     */
+    getAccountInformation(sender: string | Address, assetId: bigint): Promise<AccountAssetInformation>;
+    /**
+     * 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
+     * algorand.asset.bulkOptIn("ACCOUNTADDRESS", [12345n, 67890n])
+     * // With configuration
+     * algorand.asset.bulkOptIn("ACCOUNTADDRESS", [12345n, 67890n], { maxFee: (1000).microAlgo(), suppressLog: true })
+     * ```
+     * @returns An array of records matching asset ID to transaction ID of the opt in
+     */
+    bulkOptIn(account: string | Address, assetIds: bigint[], options?: Omit<CommonTransactionParams, 'sender'> & SendParams): Promise<BulkAssetOptInOutResult[]>;
+    /**
+     * 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
+     * algorand.asset.bulkOptOut("ACCOUNTADDRESS", [12345n, 67890n])
+     * // With configuration
+     * algorand.asset.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
+     */
+    bulkOptOut(account: string | Address, assetIds: bigint[], options?: Omit<CommonTransactionParams, 'sender'> & SendParams & {
+        /** Whether or not to check if the account has a zero balance for each asset first or not.
+         *
+         * Defaults to `true`.
+         *
+         * If this is set to `true` and the account has an asset balance it will throw an error.
+         *
+         * If this is set to `false` and the account has an asset balance it will lose those assets to the asset creator.
+         */
+        ensureZeroBalance?: boolean;
+    }): Promise<BulkAssetOptInOutResult[]>;
+}

package/types/asset-manager.js

@@ -0,0 +1,176 @@
+'use strict';
+
+var config = require('../src/config.js');
+var util = require('../src/util.js');
+var types_composer = require('./composer.js');
+
+/** Allows management of asset information. */
+class AssetManager {
+    /**
+     * 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.getAssetByID(Number(assetId)).do();
+        return {
+            assetId: BigInt(asset.index),
+            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 algorand.asset.getAccountInformation(address, assetId);
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2accountsaddressassetsasset-id)
+     * @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, Number(assetId)).do();
+        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
+     * algorand.asset.bulkOptIn("ACCOUNTADDRESS", [12345n, 67890n])
+     * // With configuration
+     * algorand.asset.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 util.chunkArray(assetIds, types_composer.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.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
+     * algorand.asset.bulkOptOut("ACCOUNTADDRESS", [12345n, 67890n])
+     * // With configuration
+     * algorand.asset.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 util.chunkArray(assetIds, types_composer.MAX_TRANSACTION_GROUP_SIZE)) {
+            const composer = this._newGroup();
+            const notOptedInAssetIds = [];
+            const nonZeroBalanceAssetIds = [];
+            for (const assetId of assetGroup) {
+                if (options?.ensureZeroBalance !== false) {
+                    try {
+                        const accountAssetInfo = await this.getAccountInformation(account, assetId);
+                        if (accountAssetInfo.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.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;
+    }
+}
+
+exports.AssetManager = AssetManager;
+//# sourceMappingURL=asset-manager.js.map

package/types/asset-manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"asset-manager.js","sources":["../../src/types/asset-manager.ts"],"sourcesContent":["import algosdk, { Address } from 'algosdk'\nimport { Config } from '../config'\nimport { chunkArray } from '../util'\nimport { AccountAssetInformation } from './account'\nimport { CommonTransactionParams, MAX_TRANSACTION_GROUP_SIZE, TransactionComposer } from './composer'\nimport { SendParams } from './transaction'\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/** Allows management of asset information. */\nexport class AssetManager {\n  private _algod: algosdk.Algodv2\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: algosdk.Algodv2, newGroup: () => 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.getAssetByID(Number(assetId)).do()\n\n    return {\n      assetId: BigInt(asset.index),\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 algorand.asset.getAccountInformation(address, assetId);\n   * ```\n   *\n   * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2accountsaddressassetsasset-id)\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, Number(assetId)).do()\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   * algorand.asset.bulkOptIn(\"ACCOUNTADDRESS\", [12345n, 67890n])\n   * // With configuration\n   * algorand.asset.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   * algorand.asset.bulkOptOut(\"ACCOUNTADDRESS\", [12345n, 67890n])\n   * // With configuration\n   * algorand.asset.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"],"names":["chunkArray","MAX_TRANSACTION_GROUP_SIZE","Config"],"mappings":";;;;;;AAwIA;MACa,YAAY,CAAA;AAIvB;;;;;;;;AAQG;IACH,WAAY,CAAA,KAAsB,EAAE,QAAmC,EAAA;AACrE,QAAA,IAAI,CAAC,MAAM,GAAG,KAAK,CAAA;AACnB,QAAA,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAA;KAC1B;AAED;;;;;;;;;;AAUG;IACI,MAAM,OAAO,CAAC,OAAe,EAAA;AAClC,QAAA,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAA;QAElE,OAAO;AACL,YAAA,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;YAC5B,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC;YACjC,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC;AACvC,YAAA,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI;AAC5B,YAAA,gBAAgB,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO;AACtC,YAAA,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,QAAQ;AAC/B,YAAA,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,WAAW;AACzC,YAAA,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG;AACrB,YAAA,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM;AAC/B,YAAA,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO;AAC7B,YAAA,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO;AAC7B,YAAA,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,QAAQ;AAC/B,YAAA,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM;AAC3B,YAAA,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO;AAC7B,YAAA,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,aAAa;AACzC,YAAA,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,YAAY;SACxC,CAAA;KACF;AAED;;;;;;;;;;;;;;AAcG;AACI,IAAA,MAAM,qBAAqB,CAAC,MAAwB,EAAE,OAAe,EAAA;AAC1E,QAAA,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,uBAAuB,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAA;QAEpF,OAAO;AACL,YAAA,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC;YACxB,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,IAAI,CAAC,CAAC;AAC/C,YAAA,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,KAAK,IAAI;AAC5C,YAAA,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SAC7B,CAAA;KACF;AAED;;;;;;;;;;;;;;;;AAgBG;AACH,IAAA,MAAM,SAAS,CACb,OAAyB,EACzB,QAAkB,EAClB,OAA8D,EAAA;QAE9D,MAAM,OAAO,GAA8B,EAAE,CAAA;QAE7C,KAAK,MAAM,UAAU,IAAIA,eAAU,CAAC,QAAQ,EAAEC,yCAA0B,CAAC,EAAE;AACzE,YAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,EAAE,CAAA;AAEjC,YAAA,KAAK,MAAM,OAAO,IAAI,UAAU,EAAE;gBAChC,QAAQ,CAAC,aAAa,CAAC;AACrB,oBAAA,GAAG,OAAO;AACV,oBAAA,MAAM,EAAE,OAAO;AACf,oBAAA,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC;AACzB,iBAAA,CAAC,CAAA;aACH;YAED,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;AAE3C,YAAAC,aAAM,CAAC,SAAS,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,IAAI,CACzC,CAAyB,sBAAA,EAAA,OAAO,CAAe,YAAA,EAAA,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA,sBAAA,EAAyB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAE,CAAA;AACpH,gBAAA,CAAA,kBAAA,EAAqB,MAAM,CAAC,OAAO,CAAA,UAAA,EAAa,MAAM,CAAC,aAAa,GAAG,CAAC,CAAC,EAAE,cAAc,CAAA,CAAA,CAAG,CAC/F,CAAA;YAED,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,KAAI;gBACpC,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,aAAa,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;AAChF,aAAC,CAAC,CAAA;SACH;AAED,QAAA,OAAO,OAAO,CAAA;KACf;AAED;;;;;;;;;;;;;;;;AAgBG;AACH,IAAA,MAAM,UAAU,CACd,OAAyB,EACzB,QAAkB,EAClB,OAWG,EAAA;QAEH,MAAM,OAAO,GAA8B,EAAE,CAAA;QAE7C,KAAK,MAAM,UAAU,IAAIF,eAAU,CAAC,QAAQ,EAAEC,yCAA0B,CAAC,EAAE;AACzE,YAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,EAAE,CAAA;YAEjC,MAAM,kBAAkB,GAAa,EAAE,CAAA;YACvC,MAAM,sBAAsB,GAAa,EAAE,CAAA;AAC3C,YAAA,KAAK,MAAM,OAAO,IAAI,UAAU,EAAE;AAChC,gBAAA,IAAI,OAAO,EAAE,iBAAiB,KAAK,KAAK,EAAE;AACxC,oBAAA,IAAI;wBACF,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;AAC3E,wBAAA,IAAI,gBAAgB,CAAC,OAAO,KAAK,EAAE,EAAE;4BACnC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAA;yBAC7C;qBACF;AAAC,oBAAA,MAAM;wBACN,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAA;qBACzC;iBACF;aACF;AAED,YAAA,IAAI,kBAAkB,CAAC,MAAM,GAAG,CAAC,IAAI,sBAAsB,CAAC,MAAM,GAAG,CAAC,EAAE;gBACtE,MAAM,IAAI,KAAK,CACb,CAAA,QAAA,EAAW,OAAO,CAAG,EAAA,kBAAkB,CAAC,MAAM,GAAG,CAAC,GAAG,CAA4B,yBAAA,EAAA,kBAAkB,CAAC,MAAM,GAAG,CAAC,GAAG,GAAG,GAAG,EAAE,IAAI,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAE,CAAA,GAAG,EAAE,GAC/J,sBAAsB,CAAC,MAAM,GAAG,CAAC;sBAC7B,kCAAkC,sBAAsB,CAAC,MAAM,GAAG,CAAC,GAAG,GAAG,GAAG,EAAE,CAAI,CAAA,EAAA,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAE,CAAA;AACvH,sBAAE,EACN,CAAkB,gBAAA,CAAA,CACnB,CAAA;aACF;AAED,YAAA,KAAK,MAAM,OAAO,IAAI,UAAU,EAAE;gBAChC,QAAQ,CAAC,cAAc,CAAC;AACtB,oBAAA,GAAG,OAAO;AACV,oBAAA,OAAO,EAAE,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,OAAO;AACtD,oBAAA,MAAM,EAAE,OAAO;AACf,oBAAA,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC;AACzB,iBAAA,CAAC,CAAA;aACH;YAED,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;AAE3C,YAAAC,aAAM,CAAC,SAAS,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,IAAI,CACzC,CAAsB,mBAAA,EAAA,OAAO,CAAkB,eAAA,EAAA,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA,sBAAA,EAAyB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAE,CAAA;AACpH,gBAAA,CAAA,kBAAA,EAAqB,MAAM,CAAC,OAAO,CAAA,UAAA,EAAa,MAAM,CAAC,aAAa,GAAG,CAAC,CAAC,EAAE,cAAc,CAAA,CAAA,CAAG,CAC/F,CAAA;YAED,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,KAAI;gBACpC,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,aAAa,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;AAChF,aAAC,CAAC,CAAA;SACH;AAED,QAAA,OAAO,OAAO,CAAA;KACf;AACF;;;;"}

package/types/asset-manager.mjs

@@ -0,0 +1,174 @@
+import { Config } from '../src/config.mjs';
+import { chunkArray } from '../src/util.mjs';
+import { MAX_TRANSACTION_GROUP_SIZE } from './composer.mjs';
+
+/** Allows management of asset information. */
+class AssetManager {
+    /**
+     * 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.getAssetByID(Number(assetId)).do();
+        return {
+            assetId: BigInt(asset.index),
+            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 algorand.asset.getAccountInformation(address, assetId);
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2accountsaddressassetsasset-id)
+     * @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, Number(assetId)).do();
+        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
+     * algorand.asset.bulkOptIn("ACCOUNTADDRESS", [12345n, 67890n])
+     * // With configuration
+     * algorand.asset.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
+     * algorand.asset.bulkOptOut("ACCOUNTADDRESS", [12345n, 67890n])
+     * // With configuration
+     * algorand.asset.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 {
+                        const accountAssetInfo = await this.getAccountInformation(account, assetId);
+                        if (accountAssetInfo.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;
+    }
+}
+
+export { AssetManager };
+//# sourceMappingURL=asset-manager.mjs.map

package/types/asset-manager.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"asset-manager.mjs","sources":["../../src/types/asset-manager.ts"],"sourcesContent":["import algosdk, { Address } from 'algosdk'\nimport { Config } from '../config'\nimport { chunkArray } from '../util'\nimport { AccountAssetInformation } from './account'\nimport { CommonTransactionParams, MAX_TRANSACTION_GROUP_SIZE, TransactionComposer } from './composer'\nimport { SendParams } from './transaction'\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/** Allows management of asset information. */\nexport class AssetManager {\n  private _algod: algosdk.Algodv2\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: algosdk.Algodv2, newGroup: () => 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.getAssetByID(Number(assetId)).do()\n\n    return {\n      assetId: BigInt(asset.index),\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 algorand.asset.getAccountInformation(address, assetId);\n   * ```\n   *\n   * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2accountsaddressassetsasset-id)\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, Number(assetId)).do()\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   * algorand.asset.bulkOptIn(\"ACCOUNTADDRESS\", [12345n, 67890n])\n   * // With configuration\n   * algorand.asset.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   * algorand.asset.bulkOptOut(\"ACCOUNTADDRESS\", [12345n, 67890n])\n   * // With configuration\n   * algorand.asset.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"],"names":[],"mappings":";;;;AAwIA;MACa,YAAY,CAAA;AAIvB;;;;;;;;AAQG;IACH,WAAY,CAAA,KAAsB,EAAE,QAAmC,EAAA;AACrE,QAAA,IAAI,CAAC,MAAM,GAAG,KAAK,CAAA;AACnB,QAAA,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAA;KAC1B;AAED;;;;;;;;;;AAUG;IACI,MAAM,OAAO,CAAC,OAAe,EAAA;AAClC,QAAA,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAA;QAElE,OAAO;AACL,YAAA,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;YAC5B,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC;YACjC,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC;AACvC,YAAA,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI;AAC5B,YAAA,gBAAgB,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO;AACtC,YAAA,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,QAAQ;AAC/B,YAAA,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,WAAW;AACzC,YAAA,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG;AACrB,YAAA,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM;AAC/B,YAAA,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO;AAC7B,YAAA,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO;AAC7B,YAAA,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,QAAQ;AAC/B,YAAA,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM;AAC3B,YAAA,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO;AAC7B,YAAA,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,aAAa;AACzC,YAAA,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,YAAY;SACxC,CAAA;KACF;AAED;;;;;;;;;;;;;;AAcG;AACI,IAAA,MAAM,qBAAqB,CAAC,MAAwB,EAAE,OAAe,EAAA;AAC1E,QAAA,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,uBAAuB,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAA;QAEpF,OAAO;AACL,YAAA,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC;YACxB,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,IAAI,CAAC,CAAC;AAC/C,YAAA,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,KAAK,IAAI;AAC5C,YAAA,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SAC7B,CAAA;KACF;AAED;;;;;;;;;;;;;;;;AAgBG;AACH,IAAA,MAAM,SAAS,CACb,OAAyB,EACzB,QAAkB,EAClB,OAA8D,EAAA;QAE9D,MAAM,OAAO,GAA8B,EAAE,CAAA;QAE7C,KAAK,MAAM,UAAU,IAAI,UAAU,CAAC,QAAQ,EAAE,0BAA0B,CAAC,EAAE;AACzE,YAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,EAAE,CAAA;AAEjC,YAAA,KAAK,MAAM,OAAO,IAAI,UAAU,EAAE;gBAChC,QAAQ,CAAC,aAAa,CAAC;AACrB,oBAAA,GAAG,OAAO;AACV,oBAAA,MAAM,EAAE,OAAO;AACf,oBAAA,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC;AACzB,iBAAA,CAAC,CAAA;aACH;YAED,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;AAE3C,YAAA,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,IAAI,CACzC,CAAyB,sBAAA,EAAA,OAAO,CAAe,YAAA,EAAA,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA,sBAAA,EAAyB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAE,CAAA;AACpH,gBAAA,CAAA,kBAAA,EAAqB,MAAM,CAAC,OAAO,CAAA,UAAA,EAAa,MAAM,CAAC,aAAa,GAAG,CAAC,CAAC,EAAE,cAAc,CAAA,CAAA,CAAG,CAC/F,CAAA;YAED,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,KAAI;gBACpC,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,aAAa,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;AAChF,aAAC,CAAC,CAAA;SACH;AAED,QAAA,OAAO,OAAO,CAAA;KACf;AAED;;;;;;;;;;;;;;;;AAgBG;AACH,IAAA,MAAM,UAAU,CACd,OAAyB,EACzB,QAAkB,EAClB,OAWG,EAAA;QAEH,MAAM,OAAO,GAA8B,EAAE,CAAA;QAE7C,KAAK,MAAM,UAAU,IAAI,UAAU,CAAC,QAAQ,EAAE,0BAA0B,CAAC,EAAE;AACzE,YAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,EAAE,CAAA;YAEjC,MAAM,kBAAkB,GAAa,EAAE,CAAA;YACvC,MAAM,sBAAsB,GAAa,EAAE,CAAA;AAC3C,YAAA,KAAK,MAAM,OAAO,IAAI,UAAU,EAAE;AAChC,gBAAA,IAAI,OAAO,EAAE,iBAAiB,KAAK,KAAK,EAAE;AACxC,oBAAA,IAAI;wBACF,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;AAC3E,wBAAA,IAAI,gBAAgB,CAAC,OAAO,KAAK,EAAE,EAAE;4BACnC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAA;yBAC7C;qBACF;AAAC,oBAAA,MAAM;wBACN,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAA;qBACzC;iBACF;aACF;AAED,YAAA,IAAI,kBAAkB,CAAC,MAAM,GAAG,CAAC,IAAI,sBAAsB,CAAC,MAAM,GAAG,CAAC,EAAE;gBACtE,MAAM,IAAI,KAAK,CACb,CAAA,QAAA,EAAW,OAAO,CAAG,EAAA,kBAAkB,CAAC,MAAM,GAAG,CAAC,GAAG,CAA4B,yBAAA,EAAA,kBAAkB,CAAC,MAAM,GAAG,CAAC,GAAG,GAAG,GAAG,EAAE,IAAI,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAE,CAAA,GAAG,EAAE,GAC/J,sBAAsB,CAAC,MAAM,GAAG,CAAC;sBAC7B,kCAAkC,sBAAsB,CAAC,MAAM,GAAG,CAAC,GAAG,GAAG,GAAG,EAAE,CAAI,CAAA,EAAA,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAE,CAAA;AACvH,sBAAE,EACN,CAAkB,gBAAA,CAAA,CACnB,CAAA;aACF;AAED,YAAA,KAAK,MAAM,OAAO,IAAI,UAAU,EAAE;gBAChC,QAAQ,CAAC,cAAc,CAAC;AACtB,oBAAA,GAAG,OAAO;AACV,oBAAA,OAAO,EAAE,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,OAAO;AACtD,oBAAA,MAAM,EAAE,OAAO;AACf,oBAAA,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC;AACzB,iBAAA,CAAC,CAAA;aACH;YAED,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;AAE3C,YAAA,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,IAAI,CACzC,CAAsB,mBAAA,EAAA,OAAO,CAAkB,eAAA,EAAA,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA,sBAAA,EAAyB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAE,CAAA;AACpH,gBAAA,CAAA,kBAAA,EAAqB,MAAM,CAAC,OAAO,CAAA,UAAA,EAAa,MAAM,CAAC,aAAa,GAAG,CAAC,CAAC,EAAE,cAAc,CAAA,CAAA,CAAG,CAC/F,CAAA;YAED,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,KAAI;gBACpC,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,aAAa,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;AAChF,aAAC,CAAC,CAAA;SACH;AAED,QAAA,OAAO,OAAO,CAAA;KACf;AACF;;;;"}