@algorandfoundation/algokit-utils 10.0.0-alpha.45 → 10.0.0-alpha.46

package/transactions/asset-config.d.ts

@@ -2,7 +2,6 @@ import { ReadableAddress } from "../packages/common/src/address.js";
 import { CommonTransactionParams } from "./common.js";
 
 //#region src/transactions/asset-config.d.ts
-
 /** Parameters to define an asset create transaction.
  *
  * The account that sends this transaction will automatically be opted in to the asset and will hold all units after creation.
@@ -113,8 +112,7 @@ type AssetCreateParams = CommonTransactionParams & {
  * all fields are immutable from that point forward.
  */
 type AssetConfigParams = CommonTransactionParams & {
-  /** ID of the asset to reconfigure */
-  assetId: bigint;
+  /** ID of the asset to reconfigure */assetId: bigint;
   /** The address of the optional account that can manage the configuration of the asset and destroy it.
    *
    * The configuration fields it can change are `manager`, `reserve`, `clawback`, and `freeze`.
@@ -157,11 +155,8 @@ type AssetConfigParams = CommonTransactionParams & {
 };
 /** Parameters to define an asset freeze transaction. */
 type AssetFreezeParams = CommonTransactionParams & {
-  /** The ID of the asset to freeze/unfreeze */
-  assetId: bigint;
-  /** The address of the account to freeze or unfreeze */
-  freezeTarget: ReadableAddress;
-  /** Whether the assets in the account should be frozen */
+  /** The ID of the asset to freeze/unfreeze */assetId: bigint; /** The address of the account to freeze or unfreeze */
+  freezeTarget: ReadableAddress; /** Whether the assets in the account should be frozen */
   frozen: boolean;
 };
 /** Parameters to define an asset destroy transaction.
@@ -169,8 +164,7 @@ type AssetFreezeParams = CommonTransactionParams & {
  * Created assets can be destroyed only by the asset manager account. All of the assets must be owned by the creator of the asset before the asset can be deleted.
  */
 type AssetDestroyParams = CommonTransactionParams & {
-  /** ID of the asset to destroy */
-  assetId: bigint;
+  /** ID of the asset to destroy */assetId: bigint;
 };
 //#endregion
 export { AssetConfigParams, AssetCreateParams, AssetDestroyParams, AssetFreezeParams };

package/transactions/asset-config.js

@@ -1,8 +1,7 @@
-const require_address = require('../packages/common/src/address.js');
-const require_transaction_type = require('../packages/transact/src/transactions/transaction-type.js');
-const require_transaction = require('../packages/transact/src/transactions/transaction.js');
-const require_common = require('./common.js');
-
+const require_address = require("../packages/common/src/address.js");
+const require_transaction_type = require("../packages/transact/src/transactions/transaction-type.js");
+const require_transaction = require("../packages/transact/src/transactions/transaction.js");
+const require_common = require("./common.js");
 //#region src/transactions/asset-config.ts
 const buildAssetCreate = (params, suggestedParams, defaultValidityWindow) => {
 	return new require_transaction.Transaction({
@@ -55,10 +54,10 @@ const buildAssetDestroy = (params, suggestedParams, defaultValidityWindow) => {
 		assetConfig: { assetId: params.assetId }
 	});
 };
-
 //#endregion
 exports.buildAssetConfig = buildAssetConfig;
 exports.buildAssetCreate = buildAssetCreate;
 exports.buildAssetDestroy = buildAssetDestroy;
 exports.buildAssetFreeze = buildAssetFreeze;
+
 //# sourceMappingURL=asset-config.js.map

package/transactions/asset-config.js.map

@@ -1 +1 @@
-{"version":3,"file":"asset-config.js","names":["Transaction","buildTransactionCommonData","TransactionType","ensureString","getOptionalAddress","getAddress"],"sources":["../../src/transactions/asset-config.ts"],"sourcesContent":["import { SuggestedParams } from '@algorandfoundation/algokit-algod-client'\nimport { ReadableAddress, getAddress, getOptionalAddress } from '@algorandfoundation/algokit-common'\nimport { Transaction, TransactionType } from '@algorandfoundation/algokit-transact'\nimport { CommonTransactionParams, buildTransactionCommonData, ensureString } from './common'\n\n/** Parameters to define an asset create transaction.\n *\n * The account that sends this transaction will automatically be opted in to the asset and will hold all units after creation.\n */\nexport type AssetCreateParams = CommonTransactionParams & {\n  /** The total amount of the smallest divisible (decimal) unit to create.\n   *\n   * For example, if `decimals` is, say, 2, then for every 100 `total` there would be 1 whole unit.\n   *\n   * This field can only be specified upon asset creation.\n   */\n  total: bigint\n\n  /** The amount of decimal places the asset should have.\n   *\n   * If unspecified then the asset will be in whole units (i.e. `0`).\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   * This field can only be specified upon asset creation.\n   */\n  decimals?: number\n\n  /** The optional name of the asset.\n   *\n   * Max size is 32 bytes.\n   *\n   * This field can only be specified upon asset creation.\n   */\n  assetName?: 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   * This field can only be specified upon asset creation.\n   */\n  unitName?: string\n\n  /** Specifies an optional URL where more information about the asset can be retrieved (e.g. metadata).\n   *\n   * Max size is 96 bytes.\n   *\n   * This field can only be specified upon asset creation.\n   */\n  url?: string\n\n  /** 32-byte hash of some metadata that is relevant to your asset and/or asset holders.\n   *\n   * The format of this metadata is up to the application.\n   *\n   * This field can only be specified upon asset creation.\n   */\n  metadataHash?: string | Uint8Array\n\n  /** Whether the asset is frozen by default for all accounts.\n   * Defaults to `false`.\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, which must be set on creation.\n   *\n   * This field can only be specified upon asset creation.\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   * The configuration fields it can change are `manager`, `reserve`, `clawback`, and `freeze`.\n   *\n   * If not set (`undefined` or `\"\"`) at asset creation or subsequently set to empty by the `manager` the asset becomes permanently immutable.\n   */\n  manager?: ReadableAddress\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 (`undefined` or `\"\"`) at asset creation or subsequently set to empty by the manager the field is permanently empty.\n   */\n  reserve?: ReadableAddress\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 (`undefined` or `\"\"`) at asset creation or subsequently set to empty by the manager the field is permanently empty.\n   */\n  freeze?: ReadableAddress\n\n  /**\n   * The address of the optional account that can clawback holdings of this asset from any account.\n   *\n   * **This field should be used with caution** as 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 (`undefined` or `\"\"`) at asset creation or subsequently set to empty by the manager the field is permanently empty.\n   */\n  clawback?: ReadableAddress\n}\n\n/** Parameters to define an asset reconfiguration transaction.\n *\n * **Note:** The manager, reserve, freeze, and clawback addresses\n * are immutably empty if they are not set. If manager is not set then\n * all fields are immutable from that point forward.\n */\nexport type AssetConfigParams = CommonTransactionParams & {\n  /** ID of the asset to reconfigure */\n  assetId: bigint\n  /** The address of the optional account that can manage the configuration of the asset and destroy it.\n   *\n   * The configuration fields it can change are `manager`, `reserve`, `clawback`, and `freeze`.\n   *\n   * If not set (`undefined` or `\"\"`) the asset will become permanently immutable.\n   */\n  manager?: ReadableAddress\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 (`undefined` or `\"\"`) the field will become permanently empty.\n   */\n  reserve?: ReadableAddress\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 (`undefined` or `\"\"`) the field will become permanently empty.\n   */\n  freeze?: ReadableAddress\n  /**\n   * The address of the optional account that can clawback holdings of this asset from any account.\n   *\n   * **This field should be used with caution** as 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 (`undefined` or `\"\"`) the field will become permanently empty.\n   */\n  clawback?: ReadableAddress\n}\n\n/** Parameters to define an asset freeze transaction. */\nexport type AssetFreezeParams = CommonTransactionParams & {\n  /** The ID of the asset to freeze/unfreeze */\n  assetId: bigint\n  /** The address of the account to freeze or unfreeze */\n  freezeTarget: ReadableAddress\n  /** Whether the assets in the account should be frozen */\n  frozen: boolean\n}\n\n/** Parameters to define an asset destroy transaction.\n *\n * Created assets can be destroyed only by the asset manager account. All of the assets must be owned by the creator of the asset before the asset can be deleted.\n */\nexport type AssetDestroyParams = CommonTransactionParams & {\n  /** ID of the asset to destroy */\n  assetId: bigint\n}\n\nexport const buildAssetCreate = (\n  params: AssetCreateParams,\n  suggestedParams: SuggestedParams,\n  defaultValidityWindow: bigint,\n): Transaction => {\n  const commonData = buildTransactionCommonData(params, suggestedParams, defaultValidityWindow)\n  return new Transaction({\n    ...commonData,\n    type: TransactionType.AssetConfig,\n    assetConfig: {\n      assetId: 0n, // Asset creation always uses ID 0\n      total: params.total,\n      decimals: params.decimals,\n      defaultFrozen: params.defaultFrozen,\n      assetName: params.assetName,\n      unitName: params.unitName,\n      url: params.url,\n      metadataHash: ensureString(params.metadataHash),\n      manager: getOptionalAddress(params.manager),\n      reserve: getOptionalAddress(params.reserve),\n      freeze: getOptionalAddress(params.freeze),\n      clawback: getOptionalAddress(params.clawback),\n    },\n  })\n}\n\nexport const buildAssetConfig = (\n  params: AssetConfigParams,\n  suggestedParams: SuggestedParams,\n  defaultValidityWindow: bigint,\n): Transaction => {\n  const commonData = buildTransactionCommonData(params, suggestedParams, defaultValidityWindow)\n  return new Transaction({\n    ...commonData,\n    type: TransactionType.AssetConfig,\n    assetConfig: {\n      assetId: params.assetId,\n      manager: getOptionalAddress(params.manager),\n      reserve: getOptionalAddress(params.reserve),\n      freeze: getOptionalAddress(params.freeze),\n      clawback: getOptionalAddress(params.clawback),\n    },\n  })\n}\n\nexport const buildAssetFreeze = (\n  params: AssetFreezeParams,\n  suggestedParams: SuggestedParams,\n  defaultValidityWindow: bigint,\n): Transaction => {\n  const commonData = buildTransactionCommonData(params, suggestedParams, defaultValidityWindow)\n  return new Transaction({\n    ...commonData,\n    type: TransactionType.AssetFreeze,\n    assetFreeze: {\n      assetId: params.assetId,\n      freezeTarget: getAddress(params.freezeTarget),\n      frozen: params.frozen,\n    },\n  })\n}\n\nexport const buildAssetDestroy = (\n  params: AssetDestroyParams,\n  suggestedParams: SuggestedParams,\n  defaultValidityWindow: bigint,\n): Transaction => {\n  const commonData = buildTransactionCommonData(params, suggestedParams, defaultValidityWindow)\n  return new Transaction({\n    ...commonData,\n    type: TransactionType.AssetConfig,\n    assetConfig: {\n      assetId: params.assetId,\n    },\n  })\n}\n"],"mappings":";;;;;;AA4LA,MAAa,oBACX,QACA,iBACA,0BACgB;AAEhB,QAAO,IAAIA,gCAAY;EACrB,GAFiBC,0CAA2B,QAAQ,iBAAiB,sBAAsB;EAG3F,MAAMC,yCAAgB;EACtB,aAAa;GACX,SAAS;GACT,OAAO,OAAO;GACd,UAAU,OAAO;GACjB,eAAe,OAAO;GACtB,WAAW,OAAO;GAClB,UAAU,OAAO;GACjB,KAAK,OAAO;GACZ,cAAcC,4BAAa,OAAO,aAAa;GAC/C,SAASC,mCAAmB,OAAO,QAAQ;GAC3C,SAASA,mCAAmB,OAAO,QAAQ;GAC3C,QAAQA,mCAAmB,OAAO,OAAO;GACzC,UAAUA,mCAAmB,OAAO,SAAS;GAC9C;EACF,CAAC;;AAGJ,MAAa,oBACX,QACA,iBACA,0BACgB;AAEhB,QAAO,IAAIJ,gCAAY;EACrB,GAFiBC,0CAA2B,QAAQ,iBAAiB,sBAAsB;EAG3F,MAAMC,yCAAgB;EACtB,aAAa;GACX,SAAS,OAAO;GAChB,SAASE,mCAAmB,OAAO,QAAQ;GAC3C,SAASA,mCAAmB,OAAO,QAAQ;GAC3C,QAAQA,mCAAmB,OAAO,OAAO;GACzC,UAAUA,mCAAmB,OAAO,SAAS;GAC9C;EACF,CAAC;;AAGJ,MAAa,oBACX,QACA,iBACA,0BACgB;AAEhB,QAAO,IAAIJ,gCAAY;EACrB,GAFiBC,0CAA2B,QAAQ,iBAAiB,sBAAsB;EAG3F,MAAMC,yCAAgB;EACtB,aAAa;GACX,SAAS,OAAO;GAChB,cAAcG,2BAAW,OAAO,aAAa;GAC7C,QAAQ,OAAO;GAChB;EACF,CAAC;;AAGJ,MAAa,qBACX,QACA,iBACA,0BACgB;AAEhB,QAAO,IAAIL,gCAAY;EACrB,GAFiBC,0CAA2B,QAAQ,iBAAiB,sBAAsB;EAG3F,MAAMC,yCAAgB;EACtB,aAAa,EACX,SAAS,OAAO,SACjB;EACF,CAAC"}
+{"version":3,"file":"asset-config.js","names":["Transaction","buildTransactionCommonData","TransactionType","ensureString","getOptionalAddress","getAddress"],"sources":["../../src/transactions/asset-config.ts"],"sourcesContent":["import { SuggestedParams } from '@algorandfoundation/algokit-algod-client'\nimport { ReadableAddress, getAddress, getOptionalAddress } from '@algorandfoundation/algokit-common'\nimport { Transaction, TransactionType } from '@algorandfoundation/algokit-transact'\nimport { CommonTransactionParams, buildTransactionCommonData, ensureString } from './common'\n\n/** Parameters to define an asset create transaction.\n *\n * The account that sends this transaction will automatically be opted in to the asset and will hold all units after creation.\n */\nexport type AssetCreateParams = CommonTransactionParams & {\n  /** The total amount of the smallest divisible (decimal) unit to create.\n   *\n   * For example, if `decimals` is, say, 2, then for every 100 `total` there would be 1 whole unit.\n   *\n   * This field can only be specified upon asset creation.\n   */\n  total: bigint\n\n  /** The amount of decimal places the asset should have.\n   *\n   * If unspecified then the asset will be in whole units (i.e. `0`).\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   * This field can only be specified upon asset creation.\n   */\n  decimals?: number\n\n  /** The optional name of the asset.\n   *\n   * Max size is 32 bytes.\n   *\n   * This field can only be specified upon asset creation.\n   */\n  assetName?: 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   * This field can only be specified upon asset creation.\n   */\n  unitName?: string\n\n  /** Specifies an optional URL where more information about the asset can be retrieved (e.g. metadata).\n   *\n   * Max size is 96 bytes.\n   *\n   * This field can only be specified upon asset creation.\n   */\n  url?: string\n\n  /** 32-byte hash of some metadata that is relevant to your asset and/or asset holders.\n   *\n   * The format of this metadata is up to the application.\n   *\n   * This field can only be specified upon asset creation.\n   */\n  metadataHash?: string | Uint8Array\n\n  /** Whether the asset is frozen by default for all accounts.\n   * Defaults to `false`.\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, which must be set on creation.\n   *\n   * This field can only be specified upon asset creation.\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   * The configuration fields it can change are `manager`, `reserve`, `clawback`, and `freeze`.\n   *\n   * If not set (`undefined` or `\"\"`) at asset creation or subsequently set to empty by the `manager` the asset becomes permanently immutable.\n   */\n  manager?: ReadableAddress\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 (`undefined` or `\"\"`) at asset creation or subsequently set to empty by the manager the field is permanently empty.\n   */\n  reserve?: ReadableAddress\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 (`undefined` or `\"\"`) at asset creation or subsequently set to empty by the manager the field is permanently empty.\n   */\n  freeze?: ReadableAddress\n\n  /**\n   * The address of the optional account that can clawback holdings of this asset from any account.\n   *\n   * **This field should be used with caution** as 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 (`undefined` or `\"\"`) at asset creation or subsequently set to empty by the manager the field is permanently empty.\n   */\n  clawback?: ReadableAddress\n}\n\n/** Parameters to define an asset reconfiguration transaction.\n *\n * **Note:** The manager, reserve, freeze, and clawback addresses\n * are immutably empty if they are not set. If manager is not set then\n * all fields are immutable from that point forward.\n */\nexport type AssetConfigParams = CommonTransactionParams & {\n  /** ID of the asset to reconfigure */\n  assetId: bigint\n  /** The address of the optional account that can manage the configuration of the asset and destroy it.\n   *\n   * The configuration fields it can change are `manager`, `reserve`, `clawback`, and `freeze`.\n   *\n   * If not set (`undefined` or `\"\"`) the asset will become permanently immutable.\n   */\n  manager?: ReadableAddress\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 (`undefined` or `\"\"`) the field will become permanently empty.\n   */\n  reserve?: ReadableAddress\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 (`undefined` or `\"\"`) the field will become permanently empty.\n   */\n  freeze?: ReadableAddress\n  /**\n   * The address of the optional account that can clawback holdings of this asset from any account.\n   *\n   * **This field should be used with caution** as 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 (`undefined` or `\"\"`) the field will become permanently empty.\n   */\n  clawback?: ReadableAddress\n}\n\n/** Parameters to define an asset freeze transaction. */\nexport type AssetFreezeParams = CommonTransactionParams & {\n  /** The ID of the asset to freeze/unfreeze */\n  assetId: bigint\n  /** The address of the account to freeze or unfreeze */\n  freezeTarget: ReadableAddress\n  /** Whether the assets in the account should be frozen */\n  frozen: boolean\n}\n\n/** Parameters to define an asset destroy transaction.\n *\n * Created assets can be destroyed only by the asset manager account. All of the assets must be owned by the creator of the asset before the asset can be deleted.\n */\nexport type AssetDestroyParams = CommonTransactionParams & {\n  /** ID of the asset to destroy */\n  assetId: bigint\n}\n\nexport const buildAssetCreate = (\n  params: AssetCreateParams,\n  suggestedParams: SuggestedParams,\n  defaultValidityWindow: bigint,\n): Transaction => {\n  const commonData = buildTransactionCommonData(params, suggestedParams, defaultValidityWindow)\n  return new Transaction({\n    ...commonData,\n    type: TransactionType.AssetConfig,\n    assetConfig: {\n      assetId: 0n, // Asset creation always uses ID 0\n      total: params.total,\n      decimals: params.decimals,\n      defaultFrozen: params.defaultFrozen,\n      assetName: params.assetName,\n      unitName: params.unitName,\n      url: params.url,\n      metadataHash: ensureString(params.metadataHash),\n      manager: getOptionalAddress(params.manager),\n      reserve: getOptionalAddress(params.reserve),\n      freeze: getOptionalAddress(params.freeze),\n      clawback: getOptionalAddress(params.clawback),\n    },\n  })\n}\n\nexport const buildAssetConfig = (\n  params: AssetConfigParams,\n  suggestedParams: SuggestedParams,\n  defaultValidityWindow: bigint,\n): Transaction => {\n  const commonData = buildTransactionCommonData(params, suggestedParams, defaultValidityWindow)\n  return new Transaction({\n    ...commonData,\n    type: TransactionType.AssetConfig,\n    assetConfig: {\n      assetId: params.assetId,\n      manager: getOptionalAddress(params.manager),\n      reserve: getOptionalAddress(params.reserve),\n      freeze: getOptionalAddress(params.freeze),\n      clawback: getOptionalAddress(params.clawback),\n    },\n  })\n}\n\nexport const buildAssetFreeze = (\n  params: AssetFreezeParams,\n  suggestedParams: SuggestedParams,\n  defaultValidityWindow: bigint,\n): Transaction => {\n  const commonData = buildTransactionCommonData(params, suggestedParams, defaultValidityWindow)\n  return new Transaction({\n    ...commonData,\n    type: TransactionType.AssetFreeze,\n    assetFreeze: {\n      assetId: params.assetId,\n      freezeTarget: getAddress(params.freezeTarget),\n      frozen: params.frozen,\n    },\n  })\n}\n\nexport const buildAssetDestroy = (\n  params: AssetDestroyParams,\n  suggestedParams: SuggestedParams,\n  defaultValidityWindow: bigint,\n): Transaction => {\n  const commonData = buildTransactionCommonData(params, suggestedParams, defaultValidityWindow)\n  return new Transaction({\n    ...commonData,\n    type: TransactionType.AssetConfig,\n    assetConfig: {\n      assetId: params.assetId,\n    },\n  })\n}\n"],"mappings":";;;;;AA4LA,MAAa,oBACX,QACA,iBACA,0BACgB;AAEhB,QAAO,IAAIA,oBAAAA,YAAY;EACrB,GAFiBC,eAAAA,2BAA2B,QAAQ,iBAAiB,sBAAsB;EAG3F,MAAMC,yBAAAA,gBAAgB;EACtB,aAAa;GACX,SAAS;GACT,OAAO,OAAO;GACd,UAAU,OAAO;GACjB,eAAe,OAAO;GACtB,WAAW,OAAO;GAClB,UAAU,OAAO;GACjB,KAAK,OAAO;GACZ,cAAcC,eAAAA,aAAa,OAAO,aAAa;GAC/C,SAASC,gBAAAA,mBAAmB,OAAO,QAAQ;GAC3C,SAASA,gBAAAA,mBAAmB,OAAO,QAAQ;GAC3C,QAAQA,gBAAAA,mBAAmB,OAAO,OAAO;GACzC,UAAUA,gBAAAA,mBAAmB,OAAO,SAAS;GAC9C;EACF,CAAC;;AAGJ,MAAa,oBACX,QACA,iBACA,0BACgB;AAEhB,QAAO,IAAIJ,oBAAAA,YAAY;EACrB,GAFiBC,eAAAA,2BAA2B,QAAQ,iBAAiB,sBAAsB;EAG3F,MAAMC,yBAAAA,gBAAgB;EACtB,aAAa;GACX,SAAS,OAAO;GAChB,SAASE,gBAAAA,mBAAmB,OAAO,QAAQ;GAC3C,SAASA,gBAAAA,mBAAmB,OAAO,QAAQ;GAC3C,QAAQA,gBAAAA,mBAAmB,OAAO,OAAO;GACzC,UAAUA,gBAAAA,mBAAmB,OAAO,SAAS;GAC9C;EACF,CAAC;;AAGJ,MAAa,oBACX,QACA,iBACA,0BACgB;AAEhB,QAAO,IAAIJ,oBAAAA,YAAY;EACrB,GAFiBC,eAAAA,2BAA2B,QAAQ,iBAAiB,sBAAsB;EAG3F,MAAMC,yBAAAA,gBAAgB;EACtB,aAAa;GACX,SAAS,OAAO;GAChB,cAAcG,gBAAAA,WAAW,OAAO,aAAa;GAC7C,QAAQ,OAAO;GAChB;EACF,CAAC;;AAGJ,MAAa,qBACX,QACA,iBACA,0BACgB;AAEhB,QAAO,IAAIL,oBAAAA,YAAY;EACrB,GAFiBC,eAAAA,2BAA2B,QAAQ,iBAAiB,sBAAsB;EAG3F,MAAMC,yBAAAA,gBAAgB;EACtB,aAAa,EACX,SAAS,OAAO,SACjB;EACF,CAAC"}

package/transactions/asset-config.mjs

@@ -2,7 +2,6 @@ import { getAddress, getOptionalAddress } from "../packages/common/src/address.m
 import { TransactionType } from "../packages/transact/src/transactions/transaction-type.mjs";
 import { Transaction } from "../packages/transact/src/transactions/transaction.mjs";
 import { buildTransactionCommonData, ensureString } from "./common.mjs";
-
 //#region src/transactions/asset-config.ts
 const buildAssetCreate = (params, suggestedParams, defaultValidityWindow) => {
 	return new Transaction({
@@ -55,7 +54,7 @@ const buildAssetDestroy = (params, suggestedParams, defaultValidityWindow) => {
 		assetConfig: { assetId: params.assetId }
 	});
 };
-
 //#endregion
 export { buildAssetConfig, buildAssetCreate, buildAssetDestroy, buildAssetFreeze };
+
 //# sourceMappingURL=asset-config.mjs.map

package/transactions/asset-config.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"asset-config.mjs","names":[],"sources":["../../src/transactions/asset-config.ts"],"sourcesContent":["import { SuggestedParams } from '@algorandfoundation/algokit-algod-client'\nimport { ReadableAddress, getAddress, getOptionalAddress } from '@algorandfoundation/algokit-common'\nimport { Transaction, TransactionType } from '@algorandfoundation/algokit-transact'\nimport { CommonTransactionParams, buildTransactionCommonData, ensureString } from './common'\n\n/** Parameters to define an asset create transaction.\n *\n * The account that sends this transaction will automatically be opted in to the asset and will hold all units after creation.\n */\nexport type AssetCreateParams = CommonTransactionParams & {\n  /** The total amount of the smallest divisible (decimal) unit to create.\n   *\n   * For example, if `decimals` is, say, 2, then for every 100 `total` there would be 1 whole unit.\n   *\n   * This field can only be specified upon asset creation.\n   */\n  total: bigint\n\n  /** The amount of decimal places the asset should have.\n   *\n   * If unspecified then the asset will be in whole units (i.e. `0`).\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   * This field can only be specified upon asset creation.\n   */\n  decimals?: number\n\n  /** The optional name of the asset.\n   *\n   * Max size is 32 bytes.\n   *\n   * This field can only be specified upon asset creation.\n   */\n  assetName?: 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   * This field can only be specified upon asset creation.\n   */\n  unitName?: string\n\n  /** Specifies an optional URL where more information about the asset can be retrieved (e.g. metadata).\n   *\n   * Max size is 96 bytes.\n   *\n   * This field can only be specified upon asset creation.\n   */\n  url?: string\n\n  /** 32-byte hash of some metadata that is relevant to your asset and/or asset holders.\n   *\n   * The format of this metadata is up to the application.\n   *\n   * This field can only be specified upon asset creation.\n   */\n  metadataHash?: string | Uint8Array\n\n  /** Whether the asset is frozen by default for all accounts.\n   * Defaults to `false`.\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, which must be set on creation.\n   *\n   * This field can only be specified upon asset creation.\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   * The configuration fields it can change are `manager`, `reserve`, `clawback`, and `freeze`.\n   *\n   * If not set (`undefined` or `\"\"`) at asset creation or subsequently set to empty by the `manager` the asset becomes permanently immutable.\n   */\n  manager?: ReadableAddress\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 (`undefined` or `\"\"`) at asset creation or subsequently set to empty by the manager the field is permanently empty.\n   */\n  reserve?: ReadableAddress\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 (`undefined` or `\"\"`) at asset creation or subsequently set to empty by the manager the field is permanently empty.\n   */\n  freeze?: ReadableAddress\n\n  /**\n   * The address of the optional account that can clawback holdings of this asset from any account.\n   *\n   * **This field should be used with caution** as 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 (`undefined` or `\"\"`) at asset creation or subsequently set to empty by the manager the field is permanently empty.\n   */\n  clawback?: ReadableAddress\n}\n\n/** Parameters to define an asset reconfiguration transaction.\n *\n * **Note:** The manager, reserve, freeze, and clawback addresses\n * are immutably empty if they are not set. If manager is not set then\n * all fields are immutable from that point forward.\n */\nexport type AssetConfigParams = CommonTransactionParams & {\n  /** ID of the asset to reconfigure */\n  assetId: bigint\n  /** The address of the optional account that can manage the configuration of the asset and destroy it.\n   *\n   * The configuration fields it can change are `manager`, `reserve`, `clawback`, and `freeze`.\n   *\n   * If not set (`undefined` or `\"\"`) the asset will become permanently immutable.\n   */\n  manager?: ReadableAddress\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 (`undefined` or `\"\"`) the field will become permanently empty.\n   */\n  reserve?: ReadableAddress\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 (`undefined` or `\"\"`) the field will become permanently empty.\n   */\n  freeze?: ReadableAddress\n  /**\n   * The address of the optional account that can clawback holdings of this asset from any account.\n   *\n   * **This field should be used with caution** as 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 (`undefined` or `\"\"`) the field will become permanently empty.\n   */\n  clawback?: ReadableAddress\n}\n\n/** Parameters to define an asset freeze transaction. */\nexport type AssetFreezeParams = CommonTransactionParams & {\n  /** The ID of the asset to freeze/unfreeze */\n  assetId: bigint\n  /** The address of the account to freeze or unfreeze */\n  freezeTarget: ReadableAddress\n  /** Whether the assets in the account should be frozen */\n  frozen: boolean\n}\n\n/** Parameters to define an asset destroy transaction.\n *\n * Created assets can be destroyed only by the asset manager account. All of the assets must be owned by the creator of the asset before the asset can be deleted.\n */\nexport type AssetDestroyParams = CommonTransactionParams & {\n  /** ID of the asset to destroy */\n  assetId: bigint\n}\n\nexport const buildAssetCreate = (\n  params: AssetCreateParams,\n  suggestedParams: SuggestedParams,\n  defaultValidityWindow: bigint,\n): Transaction => {\n  const commonData = buildTransactionCommonData(params, suggestedParams, defaultValidityWindow)\n  return new Transaction({\n    ...commonData,\n    type: TransactionType.AssetConfig,\n    assetConfig: {\n      assetId: 0n, // Asset creation always uses ID 0\n      total: params.total,\n      decimals: params.decimals,\n      defaultFrozen: params.defaultFrozen,\n      assetName: params.assetName,\n      unitName: params.unitName,\n      url: params.url,\n      metadataHash: ensureString(params.metadataHash),\n      manager: getOptionalAddress(params.manager),\n      reserve: getOptionalAddress(params.reserve),\n      freeze: getOptionalAddress(params.freeze),\n      clawback: getOptionalAddress(params.clawback),\n    },\n  })\n}\n\nexport const buildAssetConfig = (\n  params: AssetConfigParams,\n  suggestedParams: SuggestedParams,\n  defaultValidityWindow: bigint,\n): Transaction => {\n  const commonData = buildTransactionCommonData(params, suggestedParams, defaultValidityWindow)\n  return new Transaction({\n    ...commonData,\n    type: TransactionType.AssetConfig,\n    assetConfig: {\n      assetId: params.assetId,\n      manager: getOptionalAddress(params.manager),\n      reserve: getOptionalAddress(params.reserve),\n      freeze: getOptionalAddress(params.freeze),\n      clawback: getOptionalAddress(params.clawback),\n    },\n  })\n}\n\nexport const buildAssetFreeze = (\n  params: AssetFreezeParams,\n  suggestedParams: SuggestedParams,\n  defaultValidityWindow: bigint,\n): Transaction => {\n  const commonData = buildTransactionCommonData(params, suggestedParams, defaultValidityWindow)\n  return new Transaction({\n    ...commonData,\n    type: TransactionType.AssetFreeze,\n    assetFreeze: {\n      assetId: params.assetId,\n      freezeTarget: getAddress(params.freezeTarget),\n      frozen: params.frozen,\n    },\n  })\n}\n\nexport const buildAssetDestroy = (\n  params: AssetDestroyParams,\n  suggestedParams: SuggestedParams,\n  defaultValidityWindow: bigint,\n): Transaction => {\n  const commonData = buildTransactionCommonData(params, suggestedParams, defaultValidityWindow)\n  return new Transaction({\n    ...commonData,\n    type: TransactionType.AssetConfig,\n    assetConfig: {\n      assetId: params.assetId,\n    },\n  })\n}\n"],"mappings":";;;;;;AA4LA,MAAa,oBACX,QACA,iBACA,0BACgB;AAEhB,QAAO,IAAI,YAAY;EACrB,GAFiB,2BAA2B,QAAQ,iBAAiB,sBAAsB;EAG3F,MAAM,gBAAgB;EACtB,aAAa;GACX,SAAS;GACT,OAAO,OAAO;GACd,UAAU,OAAO;GACjB,eAAe,OAAO;GACtB,WAAW,OAAO;GAClB,UAAU,OAAO;GACjB,KAAK,OAAO;GACZ,cAAc,aAAa,OAAO,aAAa;GAC/C,SAAS,mBAAmB,OAAO,QAAQ;GAC3C,SAAS,mBAAmB,OAAO,QAAQ;GAC3C,QAAQ,mBAAmB,OAAO,OAAO;GACzC,UAAU,mBAAmB,OAAO,SAAS;GAC9C;EACF,CAAC;;AAGJ,MAAa,oBACX,QACA,iBACA,0BACgB;AAEhB,QAAO,IAAI,YAAY;EACrB,GAFiB,2BAA2B,QAAQ,iBAAiB,sBAAsB;EAG3F,MAAM,gBAAgB;EACtB,aAAa;GACX,SAAS,OAAO;GAChB,SAAS,mBAAmB,OAAO,QAAQ;GAC3C,SAAS,mBAAmB,OAAO,QAAQ;GAC3C,QAAQ,mBAAmB,OAAO,OAAO;GACzC,UAAU,mBAAmB,OAAO,SAAS;GAC9C;EACF,CAAC;;AAGJ,MAAa,oBACX,QACA,iBACA,0BACgB;AAEhB,QAAO,IAAI,YAAY;EACrB,GAFiB,2BAA2B,QAAQ,iBAAiB,sBAAsB;EAG3F,MAAM,gBAAgB;EACtB,aAAa;GACX,SAAS,OAAO;GAChB,cAAc,WAAW,OAAO,aAAa;GAC7C,QAAQ,OAAO;GAChB;EACF,CAAC;;AAGJ,MAAa,qBACX,QACA,iBACA,0BACgB;AAEhB,QAAO,IAAI,YAAY;EACrB,GAFiB,2BAA2B,QAAQ,iBAAiB,sBAAsB;EAG3F,MAAM,gBAAgB;EACtB,aAAa,EACX,SAAS,OAAO,SACjB;EACF,CAAC"}
+{"version":3,"file":"asset-config.mjs","names":[],"sources":["../../src/transactions/asset-config.ts"],"sourcesContent":["import { SuggestedParams } from '@algorandfoundation/algokit-algod-client'\nimport { ReadableAddress, getAddress, getOptionalAddress } from '@algorandfoundation/algokit-common'\nimport { Transaction, TransactionType } from '@algorandfoundation/algokit-transact'\nimport { CommonTransactionParams, buildTransactionCommonData, ensureString } from './common'\n\n/** Parameters to define an asset create transaction.\n *\n * The account that sends this transaction will automatically be opted in to the asset and will hold all units after creation.\n */\nexport type AssetCreateParams = CommonTransactionParams & {\n  /** The total amount of the smallest divisible (decimal) unit to create.\n   *\n   * For example, if `decimals` is, say, 2, then for every 100 `total` there would be 1 whole unit.\n   *\n   * This field can only be specified upon asset creation.\n   */\n  total: bigint\n\n  /** The amount of decimal places the asset should have.\n   *\n   * If unspecified then the asset will be in whole units (i.e. `0`).\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   * This field can only be specified upon asset creation.\n   */\n  decimals?: number\n\n  /** The optional name of the asset.\n   *\n   * Max size is 32 bytes.\n   *\n   * This field can only be specified upon asset creation.\n   */\n  assetName?: 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   * This field can only be specified upon asset creation.\n   */\n  unitName?: string\n\n  /** Specifies an optional URL where more information about the asset can be retrieved (e.g. metadata).\n   *\n   * Max size is 96 bytes.\n   *\n   * This field can only be specified upon asset creation.\n   */\n  url?: string\n\n  /** 32-byte hash of some metadata that is relevant to your asset and/or asset holders.\n   *\n   * The format of this metadata is up to the application.\n   *\n   * This field can only be specified upon asset creation.\n   */\n  metadataHash?: string | Uint8Array\n\n  /** Whether the asset is frozen by default for all accounts.\n   * Defaults to `false`.\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, which must be set on creation.\n   *\n   * This field can only be specified upon asset creation.\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   * The configuration fields it can change are `manager`, `reserve`, `clawback`, and `freeze`.\n   *\n   * If not set (`undefined` or `\"\"`) at asset creation or subsequently set to empty by the `manager` the asset becomes permanently immutable.\n   */\n  manager?: ReadableAddress\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 (`undefined` or `\"\"`) at asset creation or subsequently set to empty by the manager the field is permanently empty.\n   */\n  reserve?: ReadableAddress\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 (`undefined` or `\"\"`) at asset creation or subsequently set to empty by the manager the field is permanently empty.\n   */\n  freeze?: ReadableAddress\n\n  /**\n   * The address of the optional account that can clawback holdings of this asset from any account.\n   *\n   * **This field should be used with caution** as 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 (`undefined` or `\"\"`) at asset creation or subsequently set to empty by the manager the field is permanently empty.\n   */\n  clawback?: ReadableAddress\n}\n\n/** Parameters to define an asset reconfiguration transaction.\n *\n * **Note:** The manager, reserve, freeze, and clawback addresses\n * are immutably empty if they are not set. If manager is not set then\n * all fields are immutable from that point forward.\n */\nexport type AssetConfigParams = CommonTransactionParams & {\n  /** ID of the asset to reconfigure */\n  assetId: bigint\n  /** The address of the optional account that can manage the configuration of the asset and destroy it.\n   *\n   * The configuration fields it can change are `manager`, `reserve`, `clawback`, and `freeze`.\n   *\n   * If not set (`undefined` or `\"\"`) the asset will become permanently immutable.\n   */\n  manager?: ReadableAddress\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 (`undefined` or `\"\"`) the field will become permanently empty.\n   */\n  reserve?: ReadableAddress\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 (`undefined` or `\"\"`) the field will become permanently empty.\n   */\n  freeze?: ReadableAddress\n  /**\n   * The address of the optional account that can clawback holdings of this asset from any account.\n   *\n   * **This field should be used with caution** as 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 (`undefined` or `\"\"`) the field will become permanently empty.\n   */\n  clawback?: ReadableAddress\n}\n\n/** Parameters to define an asset freeze transaction. */\nexport type AssetFreezeParams = CommonTransactionParams & {\n  /** The ID of the asset to freeze/unfreeze */\n  assetId: bigint\n  /** The address of the account to freeze or unfreeze */\n  freezeTarget: ReadableAddress\n  /** Whether the assets in the account should be frozen */\n  frozen: boolean\n}\n\n/** Parameters to define an asset destroy transaction.\n *\n * Created assets can be destroyed only by the asset manager account. All of the assets must be owned by the creator of the asset before the asset can be deleted.\n */\nexport type AssetDestroyParams = CommonTransactionParams & {\n  /** ID of the asset to destroy */\n  assetId: bigint\n}\n\nexport const buildAssetCreate = (\n  params: AssetCreateParams,\n  suggestedParams: SuggestedParams,\n  defaultValidityWindow: bigint,\n): Transaction => {\n  const commonData = buildTransactionCommonData(params, suggestedParams, defaultValidityWindow)\n  return new Transaction({\n    ...commonData,\n    type: TransactionType.AssetConfig,\n    assetConfig: {\n      assetId: 0n, // Asset creation always uses ID 0\n      total: params.total,\n      decimals: params.decimals,\n      defaultFrozen: params.defaultFrozen,\n      assetName: params.assetName,\n      unitName: params.unitName,\n      url: params.url,\n      metadataHash: ensureString(params.metadataHash),\n      manager: getOptionalAddress(params.manager),\n      reserve: getOptionalAddress(params.reserve),\n      freeze: getOptionalAddress(params.freeze),\n      clawback: getOptionalAddress(params.clawback),\n    },\n  })\n}\n\nexport const buildAssetConfig = (\n  params: AssetConfigParams,\n  suggestedParams: SuggestedParams,\n  defaultValidityWindow: bigint,\n): Transaction => {\n  const commonData = buildTransactionCommonData(params, suggestedParams, defaultValidityWindow)\n  return new Transaction({\n    ...commonData,\n    type: TransactionType.AssetConfig,\n    assetConfig: {\n      assetId: params.assetId,\n      manager: getOptionalAddress(params.manager),\n      reserve: getOptionalAddress(params.reserve),\n      freeze: getOptionalAddress(params.freeze),\n      clawback: getOptionalAddress(params.clawback),\n    },\n  })\n}\n\nexport const buildAssetFreeze = (\n  params: AssetFreezeParams,\n  suggestedParams: SuggestedParams,\n  defaultValidityWindow: bigint,\n): Transaction => {\n  const commonData = buildTransactionCommonData(params, suggestedParams, defaultValidityWindow)\n  return new Transaction({\n    ...commonData,\n    type: TransactionType.AssetFreeze,\n    assetFreeze: {\n      assetId: params.assetId,\n      freezeTarget: getAddress(params.freezeTarget),\n      frozen: params.frozen,\n    },\n  })\n}\n\nexport const buildAssetDestroy = (\n  params: AssetDestroyParams,\n  suggestedParams: SuggestedParams,\n  defaultValidityWindow: bigint,\n): Transaction => {\n  const commonData = buildTransactionCommonData(params, suggestedParams, defaultValidityWindow)\n  return new Transaction({\n    ...commonData,\n    type: TransactionType.AssetConfig,\n    assetConfig: {\n      assetId: params.assetId,\n    },\n  })\n}\n"],"mappings":";;;;;AA4LA,MAAa,oBACX,QACA,iBACA,0BACgB;AAEhB,QAAO,IAAI,YAAY;EACrB,GAFiB,2BAA2B,QAAQ,iBAAiB,sBAAsB;EAG3F,MAAM,gBAAgB;EACtB,aAAa;GACX,SAAS;GACT,OAAO,OAAO;GACd,UAAU,OAAO;GACjB,eAAe,OAAO;GACtB,WAAW,OAAO;GAClB,UAAU,OAAO;GACjB,KAAK,OAAO;GACZ,cAAc,aAAa,OAAO,aAAa;GAC/C,SAAS,mBAAmB,OAAO,QAAQ;GAC3C,SAAS,mBAAmB,OAAO,QAAQ;GAC3C,QAAQ,mBAAmB,OAAO,OAAO;GACzC,UAAU,mBAAmB,OAAO,SAAS;GAC9C;EACF,CAAC;;AAGJ,MAAa,oBACX,QACA,iBACA,0BACgB;AAEhB,QAAO,IAAI,YAAY;EACrB,GAFiB,2BAA2B,QAAQ,iBAAiB,sBAAsB;EAG3F,MAAM,gBAAgB;EACtB,aAAa;GACX,SAAS,OAAO;GAChB,SAAS,mBAAmB,OAAO,QAAQ;GAC3C,SAAS,mBAAmB,OAAO,QAAQ;GAC3C,QAAQ,mBAAmB,OAAO,OAAO;GACzC,UAAU,mBAAmB,OAAO,SAAS;GAC9C;EACF,CAAC;;AAGJ,MAAa,oBACX,QACA,iBACA,0BACgB;AAEhB,QAAO,IAAI,YAAY;EACrB,GAFiB,2BAA2B,QAAQ,iBAAiB,sBAAsB;EAG3F,MAAM,gBAAgB;EACtB,aAAa;GACX,SAAS,OAAO;GAChB,cAAc,WAAW,OAAO,aAAa;GAC7C,QAAQ,OAAO;GAChB;EACF,CAAC;;AAGJ,MAAa,qBACX,QACA,iBACA,0BACgB;AAEhB,QAAO,IAAI,YAAY;EACrB,GAFiB,2BAA2B,QAAQ,iBAAiB,sBAAsB;EAG3F,MAAM,gBAAgB;EACtB,aAAa,EACX,SAAS,OAAO,SACjB;EACF,CAAC"}

package/transactions/asset-transfer.d.ts

@@ -2,14 +2,10 @@ import { ReadableAddress } from "../packages/common/src/address.js";
 import { CommonTransactionParams } from "./common.js";
 
 //#region src/transactions/asset-transfer.d.ts
-
 /** Parameters to define an asset transfer transaction. */
 type AssetTransferParams = CommonTransactionParams & {
-  /** ID of the asset to transfer. */
-  assetId: bigint;
-  /** Amount of the asset to transfer (in smallest divisible (decimal) units). */
-  amount: bigint;
-  /** The address of the account that will receive the asset unit(s). */
+  /** ID of the asset to transfer. */assetId: bigint; /** Amount of the asset to transfer (in smallest divisible (decimal) units). */
+  amount: bigint; /** The address of the account that will receive the asset unit(s). */
   receiver: ReadableAddress;
   /** Optional address of an account to clawback the asset from.
    *
@@ -26,13 +22,11 @@ type AssetTransferParams = CommonTransactionParams & {
 };
 /** Parameters to define an asset opt-in transaction. */
 type AssetOptInParams = CommonTransactionParams & {
-  /** ID of the asset that will be opted-in to. */
-  assetId: bigint;
+  /** ID of the asset that will be opted-in to. */assetId: bigint;
 };
 /** Parameters to define an asset opt-out transaction. */
 type AssetOptOutParams = CommonTransactionParams & {
-  /** ID of the asset that will be opted-out of. */
-  assetId: bigint;
+  /** ID of the asset that will be opted-out of. */assetId: bigint;
   /**
    * The address of the asset creator account to close the asset
    *   position to (any remaining asset units will be sent to this account).

package/transactions/asset-transfer.js

@@ -1,8 +1,7 @@
-const require_address = require('../packages/common/src/address.js');
-const require_transaction_type = require('../packages/transact/src/transactions/transaction-type.js');
-const require_transaction = require('../packages/transact/src/transactions/transaction.js');
-const require_common = require('./common.js');
-
+const require_address = require("../packages/common/src/address.js");
+const require_transaction_type = require("../packages/transact/src/transactions/transaction-type.js");
+const require_transaction = require("../packages/transact/src/transactions/transaction.js");
+const require_common = require("./common.js");
 //#region src/transactions/asset-transfer.ts
 const buildAssetTransfer = (params, suggestedParams, defaultValidityWindow) => {
 	return new require_transaction.Transaction({
@@ -42,9 +41,9 @@ const buildAssetOptOut = (params, suggestedParams, defaultValidityWindow) => {
 		}
 	});
 };
-
 //#endregion
 exports.buildAssetOptIn = buildAssetOptIn;
 exports.buildAssetOptOut = buildAssetOptOut;
 exports.buildAssetTransfer = buildAssetTransfer;
+
 //# sourceMappingURL=asset-transfer.js.map

package/transactions/asset-transfer.js.map

@@ -1 +1 @@
-{"version":3,"file":"asset-transfer.js","names":["Transaction","buildTransactionCommonData","TransactionType","getAddress","getOptionalAddress"],"sources":["../../src/transactions/asset-transfer.ts"],"sourcesContent":["import { SuggestedParams } from '@algorandfoundation/algokit-algod-client'\nimport { ReadableAddress, getAddress, getOptionalAddress } from '@algorandfoundation/algokit-common'\nimport { Transaction, TransactionType } from '@algorandfoundation/algokit-transact'\nimport { CommonTransactionParams, buildTransactionCommonData } from './common'\n\n/** Parameters to define an asset transfer transaction. */\nexport type AssetTransferParams = CommonTransactionParams & {\n  /** ID of the asset to transfer. */\n  assetId: bigint\n  /** Amount of the asset to transfer (in smallest divisible (decimal) units). */\n  amount: bigint\n  /** The address of the account that will receive the asset unit(s). */\n  receiver: ReadableAddress\n  /** Optional address of an account to clawback the asset from.\n   *\n   * Requires the sender to be the clawback account.\n   *\n   * **Warning:** Be careful with this parameter as it can lead to unexpected loss of funds if not used correctly.\n   */\n  clawbackTarget?: ReadableAddress\n  /** Optional address of an account to close the asset position to.\n   *\n   * **Warning:** Be careful with this parameter as it can lead to loss of funds if not used correctly.\n   */\n  closeAssetTo?: ReadableAddress\n}\n\n/** Parameters to define an asset opt-in transaction. */\nexport type AssetOptInParams = CommonTransactionParams & {\n  /** ID of the asset that will be opted-in to. */\n  assetId: bigint\n}\n\n/** Parameters to define an asset opt-out transaction. */\nexport type AssetOptOutParams = CommonTransactionParams & {\n  /** ID of the asset that will be opted-out of. */\n  assetId: bigint\n  /**\n   * The address of the asset creator account to close the asset\n   *   position to (any remaining asset units will be sent to this account).\n   */\n  creator: ReadableAddress\n}\n\nexport const buildAssetTransfer = (\n  params: AssetTransferParams,\n  suggestedParams: SuggestedParams,\n  defaultValidityWindow: bigint,\n): Transaction => {\n  const commonData = buildTransactionCommonData(params, suggestedParams, defaultValidityWindow)\n  return new Transaction({\n    ...commonData,\n    type: TransactionType.AssetTransfer,\n    assetTransfer: {\n      assetId: params.assetId,\n      amount: params.amount,\n      receiver: getAddress(params.receiver),\n      assetSender: getOptionalAddress(params.clawbackTarget),\n      closeRemainderTo: getOptionalAddress(params.closeAssetTo),\n    },\n  })\n}\n\nexport const buildAssetOptIn = (params: AssetOptInParams, suggestedParams: SuggestedParams, defaultValidityWindow: bigint): Transaction => {\n  const commonData = buildTransactionCommonData(params, suggestedParams, defaultValidityWindow)\n  return new Transaction({\n    ...commonData,\n    type: TransactionType.AssetTransfer,\n    assetTransfer: {\n      assetId: params.assetId,\n      amount: 0n,\n      receiver: commonData.sender,\n    },\n  })\n}\n\nexport const buildAssetOptOut = (\n  params: AssetOptOutParams,\n  suggestedParams: SuggestedParams,\n  defaultValidityWindow: bigint,\n): Transaction => {\n  const commonData = buildTransactionCommonData(params, suggestedParams, defaultValidityWindow)\n  return new Transaction({\n    ...commonData,\n    type: TransactionType.AssetTransfer,\n    assetTransfer: {\n      assetId: params.assetId,\n      amount: 0n,\n      receiver: commonData.sender,\n      closeRemainderTo: getOptionalAddress(params.creator),\n    },\n  })\n}\n"],"mappings":";;;;;;AA4CA,MAAa,sBACX,QACA,iBACA,0BACgB;AAEhB,QAAO,IAAIA,gCAAY;EACrB,GAFiBC,0CAA2B,QAAQ,iBAAiB,sBAAsB;EAG3F,MAAMC,yCAAgB;EACtB,eAAe;GACb,SAAS,OAAO;GAChB,QAAQ,OAAO;GACf,UAAUC,2BAAW,OAAO,SAAS;GACrC,aAAaC,mCAAmB,OAAO,eAAe;GACtD,kBAAkBA,mCAAmB,OAAO,aAAa;GAC1D;EACF,CAAC;;AAGJ,MAAa,mBAAmB,QAA0B,iBAAkC,0BAA+C;CACzI,MAAM,aAAaH,0CAA2B,QAAQ,iBAAiB,sBAAsB;AAC7F,QAAO,IAAID,gCAAY;EACrB,GAAG;EACH,MAAME,yCAAgB;EACtB,eAAe;GACb,SAAS,OAAO;GAChB,QAAQ;GACR,UAAU,WAAW;GACtB;EACF,CAAC;;AAGJ,MAAa,oBACX,QACA,iBACA,0BACgB;CAChB,MAAM,aAAaD,0CAA2B,QAAQ,iBAAiB,sBAAsB;AAC7F,QAAO,IAAID,gCAAY;EACrB,GAAG;EACH,MAAME,yCAAgB;EACtB,eAAe;GACb,SAAS,OAAO;GAChB,QAAQ;GACR,UAAU,WAAW;GACrB,kBAAkBE,mCAAmB,OAAO,QAAQ;GACrD;EACF,CAAC"}
+{"version":3,"file":"asset-transfer.js","names":["Transaction","buildTransactionCommonData","TransactionType","getAddress","getOptionalAddress"],"sources":["../../src/transactions/asset-transfer.ts"],"sourcesContent":["import { SuggestedParams } from '@algorandfoundation/algokit-algod-client'\nimport { ReadableAddress, getAddress, getOptionalAddress } from '@algorandfoundation/algokit-common'\nimport { Transaction, TransactionType } from '@algorandfoundation/algokit-transact'\nimport { CommonTransactionParams, buildTransactionCommonData } from './common'\n\n/** Parameters to define an asset transfer transaction. */\nexport type AssetTransferParams = CommonTransactionParams & {\n  /** ID of the asset to transfer. */\n  assetId: bigint\n  /** Amount of the asset to transfer (in smallest divisible (decimal) units). */\n  amount: bigint\n  /** The address of the account that will receive the asset unit(s). */\n  receiver: ReadableAddress\n  /** Optional address of an account to clawback the asset from.\n   *\n   * Requires the sender to be the clawback account.\n   *\n   * **Warning:** Be careful with this parameter as it can lead to unexpected loss of funds if not used correctly.\n   */\n  clawbackTarget?: ReadableAddress\n  /** Optional address of an account to close the asset position to.\n   *\n   * **Warning:** Be careful with this parameter as it can lead to loss of funds if not used correctly.\n   */\n  closeAssetTo?: ReadableAddress\n}\n\n/** Parameters to define an asset opt-in transaction. */\nexport type AssetOptInParams = CommonTransactionParams & {\n  /** ID of the asset that will be opted-in to. */\n  assetId: bigint\n}\n\n/** Parameters to define an asset opt-out transaction. */\nexport type AssetOptOutParams = CommonTransactionParams & {\n  /** ID of the asset that will be opted-out of. */\n  assetId: bigint\n  /**\n   * The address of the asset creator account to close the asset\n   *   position to (any remaining asset units will be sent to this account).\n   */\n  creator: ReadableAddress\n}\n\nexport const buildAssetTransfer = (\n  params: AssetTransferParams,\n  suggestedParams: SuggestedParams,\n  defaultValidityWindow: bigint,\n): Transaction => {\n  const commonData = buildTransactionCommonData(params, suggestedParams, defaultValidityWindow)\n  return new Transaction({\n    ...commonData,\n    type: TransactionType.AssetTransfer,\n    assetTransfer: {\n      assetId: params.assetId,\n      amount: params.amount,\n      receiver: getAddress(params.receiver),\n      assetSender: getOptionalAddress(params.clawbackTarget),\n      closeRemainderTo: getOptionalAddress(params.closeAssetTo),\n    },\n  })\n}\n\nexport const buildAssetOptIn = (params: AssetOptInParams, suggestedParams: SuggestedParams, defaultValidityWindow: bigint): Transaction => {\n  const commonData = buildTransactionCommonData(params, suggestedParams, defaultValidityWindow)\n  return new Transaction({\n    ...commonData,\n    type: TransactionType.AssetTransfer,\n    assetTransfer: {\n      assetId: params.assetId,\n      amount: 0n,\n      receiver: commonData.sender,\n    },\n  })\n}\n\nexport const buildAssetOptOut = (\n  params: AssetOptOutParams,\n  suggestedParams: SuggestedParams,\n  defaultValidityWindow: bigint,\n): Transaction => {\n  const commonData = buildTransactionCommonData(params, suggestedParams, defaultValidityWindow)\n  return new Transaction({\n    ...commonData,\n    type: TransactionType.AssetTransfer,\n    assetTransfer: {\n      assetId: params.assetId,\n      amount: 0n,\n      receiver: commonData.sender,\n      closeRemainderTo: getOptionalAddress(params.creator),\n    },\n  })\n}\n"],"mappings":";;;;;AA4CA,MAAa,sBACX,QACA,iBACA,0BACgB;AAEhB,QAAO,IAAIA,oBAAAA,YAAY;EACrB,GAFiBC,eAAAA,2BAA2B,QAAQ,iBAAiB,sBAAsB;EAG3F,MAAMC,yBAAAA,gBAAgB;EACtB,eAAe;GACb,SAAS,OAAO;GAChB,QAAQ,OAAO;GACf,UAAUC,gBAAAA,WAAW,OAAO,SAAS;GACrC,aAAaC,gBAAAA,mBAAmB,OAAO,eAAe;GACtD,kBAAkBA,gBAAAA,mBAAmB,OAAO,aAAa;GAC1D;EACF,CAAC;;AAGJ,MAAa,mBAAmB,QAA0B,iBAAkC,0BAA+C;CACzI,MAAM,aAAaH,eAAAA,2BAA2B,QAAQ,iBAAiB,sBAAsB;AAC7F,QAAO,IAAID,oBAAAA,YAAY;EACrB,GAAG;EACH,MAAME,yBAAAA,gBAAgB;EACtB,eAAe;GACb,SAAS,OAAO;GAChB,QAAQ;GACR,UAAU,WAAW;GACtB;EACF,CAAC;;AAGJ,MAAa,oBACX,QACA,iBACA,0BACgB;CAChB,MAAM,aAAaD,eAAAA,2BAA2B,QAAQ,iBAAiB,sBAAsB;AAC7F,QAAO,IAAID,oBAAAA,YAAY;EACrB,GAAG;EACH,MAAME,yBAAAA,gBAAgB;EACtB,eAAe;GACb,SAAS,OAAO;GAChB,QAAQ;GACR,UAAU,WAAW;GACrB,kBAAkBE,gBAAAA,mBAAmB,OAAO,QAAQ;GACrD;EACF,CAAC"}

package/transactions/asset-transfer.mjs

@@ -2,7 +2,6 @@ import { getAddress, getOptionalAddress } from "../packages/common/src/address.m
 import { TransactionType } from "../packages/transact/src/transactions/transaction-type.mjs";
 import { Transaction } from "../packages/transact/src/transactions/transaction.mjs";
 import { buildTransactionCommonData } from "./common.mjs";
-
 //#region src/transactions/asset-transfer.ts
 const buildAssetTransfer = (params, suggestedParams, defaultValidityWindow) => {
 	return new Transaction({
@@ -42,7 +41,7 @@ const buildAssetOptOut = (params, suggestedParams, defaultValidityWindow) => {
 		}
 	});
 };
-
 //#endregion
 export { buildAssetOptIn, buildAssetOptOut, buildAssetTransfer };
+
 //# sourceMappingURL=asset-transfer.mjs.map

package/transactions/asset-transfer.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"asset-transfer.mjs","names":[],"sources":["../../src/transactions/asset-transfer.ts"],"sourcesContent":["import { SuggestedParams } from '@algorandfoundation/algokit-algod-client'\nimport { ReadableAddress, getAddress, getOptionalAddress } from '@algorandfoundation/algokit-common'\nimport { Transaction, TransactionType } from '@algorandfoundation/algokit-transact'\nimport { CommonTransactionParams, buildTransactionCommonData } from './common'\n\n/** Parameters to define an asset transfer transaction. */\nexport type AssetTransferParams = CommonTransactionParams & {\n  /** ID of the asset to transfer. */\n  assetId: bigint\n  /** Amount of the asset to transfer (in smallest divisible (decimal) units). */\n  amount: bigint\n  /** The address of the account that will receive the asset unit(s). */\n  receiver: ReadableAddress\n  /** Optional address of an account to clawback the asset from.\n   *\n   * Requires the sender to be the clawback account.\n   *\n   * **Warning:** Be careful with this parameter as it can lead to unexpected loss of funds if not used correctly.\n   */\n  clawbackTarget?: ReadableAddress\n  /** Optional address of an account to close the asset position to.\n   *\n   * **Warning:** Be careful with this parameter as it can lead to loss of funds if not used correctly.\n   */\n  closeAssetTo?: ReadableAddress\n}\n\n/** Parameters to define an asset opt-in transaction. */\nexport type AssetOptInParams = CommonTransactionParams & {\n  /** ID of the asset that will be opted-in to. */\n  assetId: bigint\n}\n\n/** Parameters to define an asset opt-out transaction. */\nexport type AssetOptOutParams = CommonTransactionParams & {\n  /** ID of the asset that will be opted-out of. */\n  assetId: bigint\n  /**\n   * The address of the asset creator account to close the asset\n   *   position to (any remaining asset units will be sent to this account).\n   */\n  creator: ReadableAddress\n}\n\nexport const buildAssetTransfer = (\n  params: AssetTransferParams,\n  suggestedParams: SuggestedParams,\n  defaultValidityWindow: bigint,\n): Transaction => {\n  const commonData = buildTransactionCommonData(params, suggestedParams, defaultValidityWindow)\n  return new Transaction({\n    ...commonData,\n    type: TransactionType.AssetTransfer,\n    assetTransfer: {\n      assetId: params.assetId,\n      amount: params.amount,\n      receiver: getAddress(params.receiver),\n      assetSender: getOptionalAddress(params.clawbackTarget),\n      closeRemainderTo: getOptionalAddress(params.closeAssetTo),\n    },\n  })\n}\n\nexport const buildAssetOptIn = (params: AssetOptInParams, suggestedParams: SuggestedParams, defaultValidityWindow: bigint): Transaction => {\n  const commonData = buildTransactionCommonData(params, suggestedParams, defaultValidityWindow)\n  return new Transaction({\n    ...commonData,\n    type: TransactionType.AssetTransfer,\n    assetTransfer: {\n      assetId: params.assetId,\n      amount: 0n,\n      receiver: commonData.sender,\n    },\n  })\n}\n\nexport const buildAssetOptOut = (\n  params: AssetOptOutParams,\n  suggestedParams: SuggestedParams,\n  defaultValidityWindow: bigint,\n): Transaction => {\n  const commonData = buildTransactionCommonData(params, suggestedParams, defaultValidityWindow)\n  return new Transaction({\n    ...commonData,\n    type: TransactionType.AssetTransfer,\n    assetTransfer: {\n      assetId: params.assetId,\n      amount: 0n,\n      receiver: commonData.sender,\n      closeRemainderTo: getOptionalAddress(params.creator),\n    },\n  })\n}\n"],"mappings":";;;;;;AA4CA,MAAa,sBACX,QACA,iBACA,0BACgB;AAEhB,QAAO,IAAI,YAAY;EACrB,GAFiB,2BAA2B,QAAQ,iBAAiB,sBAAsB;EAG3F,MAAM,gBAAgB;EACtB,eAAe;GACb,SAAS,OAAO;GAChB,QAAQ,OAAO;GACf,UAAU,WAAW,OAAO,SAAS;GACrC,aAAa,mBAAmB,OAAO,eAAe;GACtD,kBAAkB,mBAAmB,OAAO,aAAa;GAC1D;EACF,CAAC;;AAGJ,MAAa,mBAAmB,QAA0B,iBAAkC,0BAA+C;CACzI,MAAM,aAAa,2BAA2B,QAAQ,iBAAiB,sBAAsB;AAC7F,QAAO,IAAI,YAAY;EACrB,GAAG;EACH,MAAM,gBAAgB;EACtB,eAAe;GACb,SAAS,OAAO;GAChB,QAAQ;GACR,UAAU,WAAW;GACtB;EACF,CAAC;;AAGJ,MAAa,oBACX,QACA,iBACA,0BACgB;CAChB,MAAM,aAAa,2BAA2B,QAAQ,iBAAiB,sBAAsB;AAC7F,QAAO,IAAI,YAAY;EACrB,GAAG;EACH,MAAM,gBAAgB;EACtB,eAAe;GACb,SAAS,OAAO;GAChB,QAAQ;GACR,UAAU,WAAW;GACrB,kBAAkB,mBAAmB,OAAO,QAAQ;GACrD;EACF,CAAC"}
+{"version":3,"file":"asset-transfer.mjs","names":[],"sources":["../../src/transactions/asset-transfer.ts"],"sourcesContent":["import { SuggestedParams } from '@algorandfoundation/algokit-algod-client'\nimport { ReadableAddress, getAddress, getOptionalAddress } from '@algorandfoundation/algokit-common'\nimport { Transaction, TransactionType } from '@algorandfoundation/algokit-transact'\nimport { CommonTransactionParams, buildTransactionCommonData } from './common'\n\n/** Parameters to define an asset transfer transaction. */\nexport type AssetTransferParams = CommonTransactionParams & {\n  /** ID of the asset to transfer. */\n  assetId: bigint\n  /** Amount of the asset to transfer (in smallest divisible (decimal) units). */\n  amount: bigint\n  /** The address of the account that will receive the asset unit(s). */\n  receiver: ReadableAddress\n  /** Optional address of an account to clawback the asset from.\n   *\n   * Requires the sender to be the clawback account.\n   *\n   * **Warning:** Be careful with this parameter as it can lead to unexpected loss of funds if not used correctly.\n   */\n  clawbackTarget?: ReadableAddress\n  /** Optional address of an account to close the asset position to.\n   *\n   * **Warning:** Be careful with this parameter as it can lead to loss of funds if not used correctly.\n   */\n  closeAssetTo?: ReadableAddress\n}\n\n/** Parameters to define an asset opt-in transaction. */\nexport type AssetOptInParams = CommonTransactionParams & {\n  /** ID of the asset that will be opted-in to. */\n  assetId: bigint\n}\n\n/** Parameters to define an asset opt-out transaction. */\nexport type AssetOptOutParams = CommonTransactionParams & {\n  /** ID of the asset that will be opted-out of. */\n  assetId: bigint\n  /**\n   * The address of the asset creator account to close the asset\n   *   position to (any remaining asset units will be sent to this account).\n   */\n  creator: ReadableAddress\n}\n\nexport const buildAssetTransfer = (\n  params: AssetTransferParams,\n  suggestedParams: SuggestedParams,\n  defaultValidityWindow: bigint,\n): Transaction => {\n  const commonData = buildTransactionCommonData(params, suggestedParams, defaultValidityWindow)\n  return new Transaction({\n    ...commonData,\n    type: TransactionType.AssetTransfer,\n    assetTransfer: {\n      assetId: params.assetId,\n      amount: params.amount,\n      receiver: getAddress(params.receiver),\n      assetSender: getOptionalAddress(params.clawbackTarget),\n      closeRemainderTo: getOptionalAddress(params.closeAssetTo),\n    },\n  })\n}\n\nexport const buildAssetOptIn = (params: AssetOptInParams, suggestedParams: SuggestedParams, defaultValidityWindow: bigint): Transaction => {\n  const commonData = buildTransactionCommonData(params, suggestedParams, defaultValidityWindow)\n  return new Transaction({\n    ...commonData,\n    type: TransactionType.AssetTransfer,\n    assetTransfer: {\n      assetId: params.assetId,\n      amount: 0n,\n      receiver: commonData.sender,\n    },\n  })\n}\n\nexport const buildAssetOptOut = (\n  params: AssetOptOutParams,\n  suggestedParams: SuggestedParams,\n  defaultValidityWindow: bigint,\n): Transaction => {\n  const commonData = buildTransactionCommonData(params, suggestedParams, defaultValidityWindow)\n  return new Transaction({\n    ...commonData,\n    type: TransactionType.AssetTransfer,\n    assetTransfer: {\n      assetId: params.assetId,\n      amount: 0n,\n      receiver: commonData.sender,\n      closeRemainderTo: getOptionalAddress(params.creator),\n    },\n  })\n}\n"],"mappings":";;;;;AA4CA,MAAa,sBACX,QACA,iBACA,0BACgB;AAEhB,QAAO,IAAI,YAAY;EACrB,GAFiB,2BAA2B,QAAQ,iBAAiB,sBAAsB;EAG3F,MAAM,gBAAgB;EACtB,eAAe;GACb,SAAS,OAAO;GAChB,QAAQ,OAAO;GACf,UAAU,WAAW,OAAO,SAAS;GACrC,aAAa,mBAAmB,OAAO,eAAe;GACtD,kBAAkB,mBAAmB,OAAO,aAAa;GAC1D;EACF,CAAC;;AAGJ,MAAa,mBAAmB,QAA0B,iBAAkC,0BAA+C;CACzI,MAAM,aAAa,2BAA2B,QAAQ,iBAAiB,sBAAsB;AAC7F,QAAO,IAAI,YAAY;EACrB,GAAG;EACH,MAAM,gBAAgB;EACtB,eAAe;GACb,SAAS,OAAO;GAChB,QAAQ;GACR,UAAU,WAAW;GACtB;EACF,CAAC;;AAGJ,MAAa,oBACX,QACA,iBACA,0BACgB;CAChB,MAAM,aAAa,2BAA2B,QAAQ,iBAAiB,sBAAsB;AAC7F,QAAO,IAAI,YAAY;EACrB,GAAG;EACH,MAAM,gBAAgB;EACtB,eAAe;GACb,SAAS,OAAO;GAChB,QAAQ;GACR,UAAU,WAAW;GACrB,kBAAkB,mBAAmB,OAAO,QAAQ;GACrD;EACF,CAAC"}

package/transactions/common.d.ts

@@ -5,8 +5,7 @@ import { AlgoAmount } from "../amount.js";
 //#region src/transactions/common.d.ts
 /** Common parameters for defining a transaction. */
 type CommonTransactionParams = {
-  /** The address sending the transaction, optionally with an attached signer. */
-  sender: SendingAddress;
+  /** The address sending the transaction, optionally with an attached signer. */sender: SendingAddress;
   /** The function used to sign transaction(s); if not specified then
    *  an attempt will be made to find a registered signer for the
    *  given `sender` or use a default signer (if configured).
@@ -16,22 +15,17 @@ type CommonTransactionParams = {
    *
    * **Warning:** Please be careful with this parameter and be sure to read the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying).
    */
-  rekeyTo?: ReadableAddress;
-  /** Note to attach to the transaction. Max of 1000 bytes. */
+  rekeyTo?: ReadableAddress; /** Note to attach to the transaction. Max of 1000 bytes. */
   note?: Uint8Array | string;
   /** Prevent multiple transactions with the same lease being included within the validity window.
    *
    * A [lease](https://dev.algorand.co/concepts/transactions/leases)
    *  enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).
    */
-  lease?: Uint8Array | string;
-  /** The static transaction fee. In most cases you want to use `extraFee` unless setting the fee to 0 to be covered by another transaction. */
-  staticFee?: AlgoAmount;
-  /** The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees. */
-  extraFee?: AlgoAmount;
-  /** Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods. */
-  maxFee?: AlgoAmount;
-  /** How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used. */
+  lease?: Uint8Array | string; /** The static transaction fee. In most cases you want to use `extraFee` unless setting the fee to 0 to be covered by another transaction. */
+  staticFee?: AlgoAmount; /** The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees. */
+  extraFee?: AlgoAmount; /** Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods. */
+  maxFee?: AlgoAmount; /** How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used. */
   validityWindow?: number | bigint;
   /**
    * Set the first round this transaction is valid.
@@ -39,8 +33,7 @@ type CommonTransactionParams = {
    *
    * We recommend you only set this when you intentionally want this to be some time in the future.
    */
-  firstValidRound?: bigint;
-  /** The last round this transaction is valid. It is recommended to use `validityWindow` instead. */
+  firstValidRound?: bigint; /** The last round this transaction is valid. It is recommended to use `validityWindow` instead. */
   lastValidRound?: bigint;
 };
 //#endregion

package/transactions/common.js

@@ -1,6 +1,5 @@
-const require_address = require('../packages/common/src/address.js');
-const require_transaction = require('../transaction/transaction.js');
-
+const require_address = require("../packages/common/src/address.js");
+const require_transaction = require("../transaction/transaction.js");
 //#region src/transactions/common.ts
 const ensureString = (data) => {
 	if (data === void 0) return void 0;
@@ -24,8 +23,8 @@ const buildTransactionCommonData = (commonParams, suggestedParams, defaultValidi
 		group: void 0
 	};
 };
-
 //#endregion
 exports.buildTransactionCommonData = buildTransactionCommonData;
 exports.ensureString = ensureString;
+
 //# sourceMappingURL=common.js.map

package/transactions/common.js.map

@@ -1 +1 @@
-{"version":3,"file":"common.js","names":["encodeLease","getAddress","getOptionalAddress"],"sources":["../../src/transactions/common.ts"],"sourcesContent":["import { SuggestedParams } from '@algorandfoundation/algokit-algod-client'\nimport { Address, ReadableAddress, getAddress, getOptionalAddress } from '@algorandfoundation/algokit-common'\nimport { AddressWithTransactionSigner, SendingAddress, TransactionSigner } from '@algorandfoundation/algokit-transact'\nimport { AlgoAmount } from '../amount'\nimport { encodeLease } from '../transaction'\n\n/** Common parameters for defining a transaction. */\nexport type CommonTransactionParams = {\n  /** The address sending the transaction, optionally with an attached signer. */\n  sender: SendingAddress\n  /** The function used to sign transaction(s); if not specified then\n   *  an attempt will be made to find a registered signer for the\n   *  given `sender` or use a default signer (if configured).\n   */\n  signer?: TransactionSigner | AddressWithTransactionSigner\n  /** Change the signing key of the sender to the given address.\n   *\n   * **Warning:** Please be careful with this parameter and be sure to read the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying).\n   */\n  rekeyTo?: ReadableAddress\n  /** Note to attach to the transaction. Max of 1000 bytes. */\n  note?: Uint8Array | string\n  /** Prevent multiple transactions with the same lease being included within the validity window.\n   *\n   * A [lease](https://dev.algorand.co/concepts/transactions/leases)\n   *  enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).\n   */\n  lease?: Uint8Array | string\n  /** The static transaction fee. In most cases you want to use `extraFee` unless setting the fee to 0 to be covered by another transaction. */\n  staticFee?: AlgoAmount\n  /** The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees. */\n  extraFee?: AlgoAmount\n  /** Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods. */\n  maxFee?: AlgoAmount\n  /** How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used. */\n  validityWindow?: number | bigint\n  /**\n   * Set the first round this transaction is valid.\n   * If left undefined, the value from algod will be used.\n   *\n   * We recommend you only set this when you intentionally want this to be some time in the future.\n   */\n  firstValidRound?: bigint\n  /** The last round this transaction is valid. It is recommended to use `validityWindow` instead. */\n  lastValidRound?: bigint\n}\n\nexport type TransactionCommonData = {\n  sender: Address\n  fee?: bigint\n  firstValid: bigint\n  lastValid: bigint\n  genesisHash?: Uint8Array\n  genesisId?: string\n  note?: Uint8Array\n  rekeyTo?: Address\n  lease?: Uint8Array\n  group?: Uint8Array\n}\n\nexport const ensureString = (data?: string | Uint8Array) => {\n  if (data === undefined) return undefined\n  const encoder = new TextEncoder()\n  return typeof data === 'string' ? encoder.encode(data) : data\n}\n\nexport const buildTransactionCommonData = (\n  commonParams: CommonTransactionParams,\n  suggestedParams: SuggestedParams,\n  defaultValidityWindow: bigint,\n) => {\n  const firstValid = commonParams.firstValidRound ?? suggestedParams.firstValid\n  const lease = commonParams.lease === undefined ? undefined : encodeLease(commonParams.lease)\n  const note = ensureString(commonParams.note)\n\n  return {\n    sender: getAddress(commonParams.sender),\n    rekeyTo: getOptionalAddress(commonParams.rekeyTo),\n    note: note,\n    lease: lease,\n    fee: commonParams.staticFee?.microAlgos,\n    genesisId: suggestedParams.genesisId,\n    genesisHash: suggestedParams.genesisHash,\n    firstValid,\n    lastValid:\n      commonParams.lastValidRound ??\n      (commonParams.validityWindow !== undefined ? firstValid + BigInt(commonParams.validityWindow) : firstValid + defaultValidityWindow),\n    group: undefined,\n  } satisfies TransactionCommonData\n}\n"],"mappings":";;;;AA4DA,MAAa,gBAAgB,SAA+B;AAC1D,KAAI,SAAS,OAAW,QAAO;CAC/B,MAAM,UAAU,IAAI,aAAa;AACjC,QAAO,OAAO,SAAS,WAAW,QAAQ,OAAO,KAAK,GAAG;;AAG3D,MAAa,8BACX,cACA,iBACA,0BACG;CACH,MAAM,aAAa,aAAa,mBAAmB,gBAAgB;CACnE,MAAM,QAAQ,aAAa,UAAU,SAAY,SAAYA,gCAAY,aAAa,MAAM;CAC5F,MAAM,OAAO,aAAa,aAAa,KAAK;AAE5C,QAAO;EACL,QAAQC,2BAAW,aAAa,OAAO;EACvC,SAASC,mCAAmB,aAAa,QAAQ;EAC3C;EACC;EACP,KAAK,aAAa,WAAW;EAC7B,WAAW,gBAAgB;EAC3B,aAAa,gBAAgB;EAC7B;EACA,WACE,aAAa,mBACZ,aAAa,mBAAmB,SAAY,aAAa,OAAO,aAAa,eAAe,GAAG,aAAa;EAC/G,OAAO;EACR"}
+{"version":3,"file":"common.js","names":["encodeLease","getAddress","getOptionalAddress"],"sources":["../../src/transactions/common.ts"],"sourcesContent":["import { SuggestedParams } from '@algorandfoundation/algokit-algod-client'\nimport { Address, ReadableAddress, getAddress, getOptionalAddress } from '@algorandfoundation/algokit-common'\nimport { AddressWithTransactionSigner, SendingAddress, TransactionSigner } from '@algorandfoundation/algokit-transact'\nimport { AlgoAmount } from '../amount'\nimport { encodeLease } from '../transaction'\n\n/** Common parameters for defining a transaction. */\nexport type CommonTransactionParams = {\n  /** The address sending the transaction, optionally with an attached signer. */\n  sender: SendingAddress\n  /** The function used to sign transaction(s); if not specified then\n   *  an attempt will be made to find a registered signer for the\n   *  given `sender` or use a default signer (if configured).\n   */\n  signer?: TransactionSigner | AddressWithTransactionSigner\n  /** Change the signing key of the sender to the given address.\n   *\n   * **Warning:** Please be careful with this parameter and be sure to read the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying).\n   */\n  rekeyTo?: ReadableAddress\n  /** Note to attach to the transaction. Max of 1000 bytes. */\n  note?: Uint8Array | string\n  /** Prevent multiple transactions with the same lease being included within the validity window.\n   *\n   * A [lease](https://dev.algorand.co/concepts/transactions/leases)\n   *  enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).\n   */\n  lease?: Uint8Array | string\n  /** The static transaction fee. In most cases you want to use `extraFee` unless setting the fee to 0 to be covered by another transaction. */\n  staticFee?: AlgoAmount\n  /** The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees. */\n  extraFee?: AlgoAmount\n  /** Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods. */\n  maxFee?: AlgoAmount\n  /** How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used. */\n  validityWindow?: number | bigint\n  /**\n   * Set the first round this transaction is valid.\n   * If left undefined, the value from algod will be used.\n   *\n   * We recommend you only set this when you intentionally want this to be some time in the future.\n   */\n  firstValidRound?: bigint\n  /** The last round this transaction is valid. It is recommended to use `validityWindow` instead. */\n  lastValidRound?: bigint\n}\n\nexport type TransactionCommonData = {\n  sender: Address\n  fee?: bigint\n  firstValid: bigint\n  lastValid: bigint\n  genesisHash?: Uint8Array\n  genesisId?: string\n  note?: Uint8Array\n  rekeyTo?: Address\n  lease?: Uint8Array\n  group?: Uint8Array\n}\n\nexport const ensureString = (data?: string | Uint8Array) => {\n  if (data === undefined) return undefined\n  const encoder = new TextEncoder()\n  return typeof data === 'string' ? encoder.encode(data) : data\n}\n\nexport const buildTransactionCommonData = (\n  commonParams: CommonTransactionParams,\n  suggestedParams: SuggestedParams,\n  defaultValidityWindow: bigint,\n) => {\n  const firstValid = commonParams.firstValidRound ?? suggestedParams.firstValid\n  const lease = commonParams.lease === undefined ? undefined : encodeLease(commonParams.lease)\n  const note = ensureString(commonParams.note)\n\n  return {\n    sender: getAddress(commonParams.sender),\n    rekeyTo: getOptionalAddress(commonParams.rekeyTo),\n    note: note,\n    lease: lease,\n    fee: commonParams.staticFee?.microAlgos,\n    genesisId: suggestedParams.genesisId,\n    genesisHash: suggestedParams.genesisHash,\n    firstValid,\n    lastValid:\n      commonParams.lastValidRound ??\n      (commonParams.validityWindow !== undefined ? firstValid + BigInt(commonParams.validityWindow) : firstValid + defaultValidityWindow),\n    group: undefined,\n  } satisfies TransactionCommonData\n}\n"],"mappings":";;;AA4DA,MAAa,gBAAgB,SAA+B;AAC1D,KAAI,SAAS,KAAA,EAAW,QAAO,KAAA;CAC/B,MAAM,UAAU,IAAI,aAAa;AACjC,QAAO,OAAO,SAAS,WAAW,QAAQ,OAAO,KAAK,GAAG;;AAG3D,MAAa,8BACX,cACA,iBACA,0BACG;CACH,MAAM,aAAa,aAAa,mBAAmB,gBAAgB;CACnE,MAAM,QAAQ,aAAa,UAAU,KAAA,IAAY,KAAA,IAAYA,oBAAAA,YAAY,aAAa,MAAM;CAC5F,MAAM,OAAO,aAAa,aAAa,KAAK;AAE5C,QAAO;EACL,QAAQC,gBAAAA,WAAW,aAAa,OAAO;EACvC,SAASC,gBAAAA,mBAAmB,aAAa,QAAQ;EAC3C;EACC;EACP,KAAK,aAAa,WAAW;EAC7B,WAAW,gBAAgB;EAC3B,aAAa,gBAAgB;EAC7B;EACA,WACE,aAAa,mBACZ,aAAa,mBAAmB,KAAA,IAAY,aAAa,OAAO,aAAa,eAAe,GAAG,aAAa;EAC/G,OAAO,KAAA;EACR"}

package/transactions/common.mjs

@@ -1,6 +1,5 @@
 import { getAddress, getOptionalAddress } from "../packages/common/src/address.mjs";
 import { encodeLease } from "../transaction/transaction.mjs";
-
 //#region src/transactions/common.ts
 const ensureString = (data) => {
 	if (data === void 0) return void 0;
@@ -24,7 +23,7 @@ const buildTransactionCommonData = (commonParams, suggestedParams, defaultValidi
 		group: void 0
 	};
 };
-
 //#endregion
 export { buildTransactionCommonData, ensureString };
+
 //# sourceMappingURL=common.mjs.map

package/transactions/common.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"common.mjs","names":[],"sources":["../../src/transactions/common.ts"],"sourcesContent":["import { SuggestedParams } from '@algorandfoundation/algokit-algod-client'\nimport { Address, ReadableAddress, getAddress, getOptionalAddress } from '@algorandfoundation/algokit-common'\nimport { AddressWithTransactionSigner, SendingAddress, TransactionSigner } from '@algorandfoundation/algokit-transact'\nimport { AlgoAmount } from '../amount'\nimport { encodeLease } from '../transaction'\n\n/** Common parameters for defining a transaction. */\nexport type CommonTransactionParams = {\n  /** The address sending the transaction, optionally with an attached signer. */\n  sender: SendingAddress\n  /** The function used to sign transaction(s); if not specified then\n   *  an attempt will be made to find a registered signer for the\n   *  given `sender` or use a default signer (if configured).\n   */\n  signer?: TransactionSigner | AddressWithTransactionSigner\n  /** Change the signing key of the sender to the given address.\n   *\n   * **Warning:** Please be careful with this parameter and be sure to read the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying).\n   */\n  rekeyTo?: ReadableAddress\n  /** Note to attach to the transaction. Max of 1000 bytes. */\n  note?: Uint8Array | string\n  /** Prevent multiple transactions with the same lease being included within the validity window.\n   *\n   * A [lease](https://dev.algorand.co/concepts/transactions/leases)\n   *  enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).\n   */\n  lease?: Uint8Array | string\n  /** The static transaction fee. In most cases you want to use `extraFee` unless setting the fee to 0 to be covered by another transaction. */\n  staticFee?: AlgoAmount\n  /** The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees. */\n  extraFee?: AlgoAmount\n  /** Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods. */\n  maxFee?: AlgoAmount\n  /** How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used. */\n  validityWindow?: number | bigint\n  /**\n   * Set the first round this transaction is valid.\n   * If left undefined, the value from algod will be used.\n   *\n   * We recommend you only set this when you intentionally want this to be some time in the future.\n   */\n  firstValidRound?: bigint\n  /** The last round this transaction is valid. It is recommended to use `validityWindow` instead. */\n  lastValidRound?: bigint\n}\n\nexport type TransactionCommonData = {\n  sender: Address\n  fee?: bigint\n  firstValid: bigint\n  lastValid: bigint\n  genesisHash?: Uint8Array\n  genesisId?: string\n  note?: Uint8Array\n  rekeyTo?: Address\n  lease?: Uint8Array\n  group?: Uint8Array\n}\n\nexport const ensureString = (data?: string | Uint8Array) => {\n  if (data === undefined) return undefined\n  const encoder = new TextEncoder()\n  return typeof data === 'string' ? encoder.encode(data) : data\n}\n\nexport const buildTransactionCommonData = (\n  commonParams: CommonTransactionParams,\n  suggestedParams: SuggestedParams,\n  defaultValidityWindow: bigint,\n) => {\n  const firstValid = commonParams.firstValidRound ?? suggestedParams.firstValid\n  const lease = commonParams.lease === undefined ? undefined : encodeLease(commonParams.lease)\n  const note = ensureString(commonParams.note)\n\n  return {\n    sender: getAddress(commonParams.sender),\n    rekeyTo: getOptionalAddress(commonParams.rekeyTo),\n    note: note,\n    lease: lease,\n    fee: commonParams.staticFee?.microAlgos,\n    genesisId: suggestedParams.genesisId,\n    genesisHash: suggestedParams.genesisHash,\n    firstValid,\n    lastValid:\n      commonParams.lastValidRound ??\n      (commonParams.validityWindow !== undefined ? firstValid + BigInt(commonParams.validityWindow) : firstValid + defaultValidityWindow),\n    group: undefined,\n  } satisfies TransactionCommonData\n}\n"],"mappings":";;;;AA4DA,MAAa,gBAAgB,SAA+B;AAC1D,KAAI,SAAS,OAAW,QAAO;CAC/B,MAAM,UAAU,IAAI,aAAa;AACjC,QAAO,OAAO,SAAS,WAAW,QAAQ,OAAO,KAAK,GAAG;;AAG3D,MAAa,8BACX,cACA,iBACA,0BACG;CACH,MAAM,aAAa,aAAa,mBAAmB,gBAAgB;CACnE,MAAM,QAAQ,aAAa,UAAU,SAAY,SAAY,YAAY,aAAa,MAAM;CAC5F,MAAM,OAAO,aAAa,aAAa,KAAK;AAE5C,QAAO;EACL,QAAQ,WAAW,aAAa,OAAO;EACvC,SAAS,mBAAmB,aAAa,QAAQ;EAC3C;EACC;EACP,KAAK,aAAa,WAAW;EAC7B,WAAW,gBAAgB;EAC3B,aAAa,gBAAgB;EAC7B;EACA,WACE,aAAa,mBACZ,aAAa,mBAAmB,SAAY,aAAa,OAAO,aAAa,eAAe,GAAG,aAAa;EAC/G,OAAO;EACR"}
+{"version":3,"file":"common.mjs","names":[],"sources":["../../src/transactions/common.ts"],"sourcesContent":["import { SuggestedParams } from '@algorandfoundation/algokit-algod-client'\nimport { Address, ReadableAddress, getAddress, getOptionalAddress } from '@algorandfoundation/algokit-common'\nimport { AddressWithTransactionSigner, SendingAddress, TransactionSigner } from '@algorandfoundation/algokit-transact'\nimport { AlgoAmount } from '../amount'\nimport { encodeLease } from '../transaction'\n\n/** Common parameters for defining a transaction. */\nexport type CommonTransactionParams = {\n  /** The address sending the transaction, optionally with an attached signer. */\n  sender: SendingAddress\n  /** The function used to sign transaction(s); if not specified then\n   *  an attempt will be made to find a registered signer for the\n   *  given `sender` or use a default signer (if configured).\n   */\n  signer?: TransactionSigner | AddressWithTransactionSigner\n  /** Change the signing key of the sender to the given address.\n   *\n   * **Warning:** Please be careful with this parameter and be sure to read the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying).\n   */\n  rekeyTo?: ReadableAddress\n  /** Note to attach to the transaction. Max of 1000 bytes. */\n  note?: Uint8Array | string\n  /** Prevent multiple transactions with the same lease being included within the validity window.\n   *\n   * A [lease](https://dev.algorand.co/concepts/transactions/leases)\n   *  enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).\n   */\n  lease?: Uint8Array | string\n  /** The static transaction fee. In most cases you want to use `extraFee` unless setting the fee to 0 to be covered by another transaction. */\n  staticFee?: AlgoAmount\n  /** The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees. */\n  extraFee?: AlgoAmount\n  /** Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods. */\n  maxFee?: AlgoAmount\n  /** How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used. */\n  validityWindow?: number | bigint\n  /**\n   * Set the first round this transaction is valid.\n   * If left undefined, the value from algod will be used.\n   *\n   * We recommend you only set this when you intentionally want this to be some time in the future.\n   */\n  firstValidRound?: bigint\n  /** The last round this transaction is valid. It is recommended to use `validityWindow` instead. */\n  lastValidRound?: bigint\n}\n\nexport type TransactionCommonData = {\n  sender: Address\n  fee?: bigint\n  firstValid: bigint\n  lastValid: bigint\n  genesisHash?: Uint8Array\n  genesisId?: string\n  note?: Uint8Array\n  rekeyTo?: Address\n  lease?: Uint8Array\n  group?: Uint8Array\n}\n\nexport const ensureString = (data?: string | Uint8Array) => {\n  if (data === undefined) return undefined\n  const encoder = new TextEncoder()\n  return typeof data === 'string' ? encoder.encode(data) : data\n}\n\nexport const buildTransactionCommonData = (\n  commonParams: CommonTransactionParams,\n  suggestedParams: SuggestedParams,\n  defaultValidityWindow: bigint,\n) => {\n  const firstValid = commonParams.firstValidRound ?? suggestedParams.firstValid\n  const lease = commonParams.lease === undefined ? undefined : encodeLease(commonParams.lease)\n  const note = ensureString(commonParams.note)\n\n  return {\n    sender: getAddress(commonParams.sender),\n    rekeyTo: getOptionalAddress(commonParams.rekeyTo),\n    note: note,\n    lease: lease,\n    fee: commonParams.staticFee?.microAlgos,\n    genesisId: suggestedParams.genesisId,\n    genesisHash: suggestedParams.genesisHash,\n    firstValid,\n    lastValid:\n      commonParams.lastValidRound ??\n      (commonParams.validityWindow !== undefined ? firstValid + BigInt(commonParams.validityWindow) : firstValid + defaultValidityWindow),\n    group: undefined,\n  } satisfies TransactionCommonData\n}\n"],"mappings":";;;AA4DA,MAAa,gBAAgB,SAA+B;AAC1D,KAAI,SAAS,KAAA,EAAW,QAAO,KAAA;CAC/B,MAAM,UAAU,IAAI,aAAa;AACjC,QAAO,OAAO,SAAS,WAAW,QAAQ,OAAO,KAAK,GAAG;;AAG3D,MAAa,8BACX,cACA,iBACA,0BACG;CACH,MAAM,aAAa,aAAa,mBAAmB,gBAAgB;CACnE,MAAM,QAAQ,aAAa,UAAU,KAAA,IAAY,KAAA,IAAY,YAAY,aAAa,MAAM;CAC5F,MAAM,OAAO,aAAa,aAAa,KAAK;AAE5C,QAAO;EACL,QAAQ,WAAW,aAAa,OAAO;EACvC,SAAS,mBAAmB,aAAa,QAAQ;EAC3C;EACC;EACP,KAAK,aAAa,WAAW;EAC7B,WAAW,gBAAgB;EAC3B,aAAa,gBAAgB;EAC7B;EACA,WACE,aAAa,mBACZ,aAAa,mBAAmB,KAAA,IAAY,aAAa,OAAO,aAAa,eAAe,GAAG,aAAa;EAC/G,OAAO,KAAA;EACR"}

package/transactions/fee-coverage.js

@@ -1,4 +1,3 @@
-
 //#region src/transactions/fee-coverage.ts
 let FeeDeltaType = /* @__PURE__ */ function(FeeDeltaType) {
 	FeeDeltaType[FeeDeltaType["Deficit"] = 0] = "Deficit";
@@ -107,9 +106,9 @@ function calculateInnerFeeDelta(innerTransactions, minTransactionFee = 1000n, ac
 		return currentFeeDelta;
 	}, acc);
 }
-
 //#endregion
 exports.FeeDelta = FeeDelta;
 exports.FeePriority = FeePriority;
 exports.calculateInnerFeeDelta = calculateInnerFeeDelta;
+
 //# sourceMappingURL=fee-coverage.js.map

package/transactions/fee-coverage.js.map

@@ -1 +1 @@
-{"version":3,"file":"fee-coverage.js","names":[],"sources":["../../src/transactions/fee-coverage.ts"],"sourcesContent":["import { PendingTransactionResponse } from '@algorandfoundation/algokit-algod-client'\n\nexport enum FeeDeltaType {\n  Deficit,\n  Surplus,\n}\n\nexport type DeficitFeeDelta = {\n  type: FeeDeltaType.Deficit\n  data: bigint\n}\n\nexport type SurplusFeeDelta = {\n  type: FeeDeltaType.Surplus\n  data: bigint\n}\n\nexport type FeeDelta = DeficitFeeDelta | SurplusFeeDelta\nexport const FeeDelta = {\n  fromBigInt(value: bigint): FeeDelta | undefined {\n    if (value > 0n) {\n      return { type: FeeDeltaType.Deficit, data: value }\n    } else if (value < 0n) {\n      return { type: FeeDeltaType.Surplus, data: -value }\n    }\n    return undefined\n  },\n  toBigInt(delta: FeeDelta): bigint {\n    return delta.type === FeeDeltaType.Deficit ? delta.data : -delta.data\n  },\n  isDeficit(delta: FeeDelta): boolean {\n    return delta.type === FeeDeltaType.Deficit\n  },\n  isSurplus(delta: FeeDelta): boolean {\n    return delta.type === FeeDeltaType.Surplus\n  },\n  amount(delta: FeeDelta): bigint {\n    return delta.data\n  },\n  add(lhs: FeeDelta, rhs: FeeDelta): FeeDelta | undefined {\n    return FeeDelta.fromBigInt(FeeDelta.toBigInt(lhs) + FeeDelta.toBigInt(rhs))\n  },\n}\n\nclass CoveredPriority {\n  getPriorityType(): number {\n    return 0\n  }\n\n  getDeficitAmount(): bigint {\n    return 0n\n  }\n\n  compare(other: FeePriority): number {\n    const typeDiff = this.getPriorityType() - other.getPriorityType()\n    if (typeDiff !== 0) {\n      return typeDiff\n    }\n    // For same type (which can only be Covered), they're equal\n    return 0\n  }\n\n  equals(other: FeePriority): boolean {\n    return other instanceof CoveredPriority\n  }\n}\n\nclass ModifiableDeficitPriority {\n  constructor(public readonly deficit: bigint) {}\n\n  getPriorityType(): number {\n    return 1\n  }\n\n  getDeficitAmount(): bigint {\n    return this.deficit\n  }\n\n  compare(other: FeePriority): number {\n    const typeDiff = this.getPriorityType() - other.getPriorityType()\n    if (typeDiff !== 0) {\n      return typeDiff\n    }\n    // For same type, compare deficit amounts (larger deficit = higher priority)\n    if (other instanceof ModifiableDeficitPriority) {\n      return Number(this.deficit - other.deficit)\n    }\n    return 0\n  }\n\n  equals(other: FeePriority): boolean {\n    return other instanceof ModifiableDeficitPriority && this.deficit === other.deficit\n  }\n}\n\nclass ImmutableDeficitPriority {\n  constructor(public readonly deficit: bigint) {}\n\n  getPriorityType(): number {\n    return 2\n  }\n\n  getDeficitAmount(): bigint {\n    return this.deficit\n  }\n\n  compare(other: FeePriority): number {\n    const typeDiff = this.getPriorityType() - other.getPriorityType()\n    if (typeDiff !== 0) {\n      return typeDiff\n    }\n    // For same type, compare deficit amounts (larger deficit = higher priority)\n    if (other instanceof ImmutableDeficitPriority) {\n      return Number(this.deficit - other.deficit)\n    }\n    return 0\n  }\n\n  equals(other: FeePriority): boolean {\n    return other instanceof ImmutableDeficitPriority && this.deficit === other.deficit\n  }\n}\n\n// Priority levels for fee coverage with deficit amounts\n// ImmutableDeficit > ModifiableDeficit > Covered\n// Within same priority type, larger deficits have higher priority\nexport type FeePriority = CoveredPriority | ModifiableDeficitPriority | ImmutableDeficitPriority\nexport const FeePriority = {\n  Covered: new CoveredPriority(),\n  ModifiableDeficit(deficit: bigint): ModifiableDeficitPriority {\n    return new ModifiableDeficitPriority(deficit)\n  },\n  ImmutableDeficit(deficit: bigint): ImmutableDeficitPriority {\n    return new ImmutableDeficitPriority(deficit)\n  },\n} as const\n\nexport function calculateInnerFeeDelta(\n  innerTransactions?: PendingTransactionResponse[],\n  minTransactionFee: bigint = 1000n,\n  acc?: FeeDelta,\n): FeeDelta | undefined {\n  if (!innerTransactions) {\n    return acc\n  }\n\n  // Surplus inner transaction fees do not pool up to the parent transaction.\n  // Additionally surplus inner transaction fees only pool from sibling transactions\n  // that are sent prior to a given inner transaction, hence why we iterate in reverse order.\n  return innerTransactions.reduceRight((acc, innerTxn) => {\n    const recursiveDelta = calculateInnerFeeDelta(innerTxn.innerTxns, minTransactionFee, acc)\n\n    // Inner transactions don't require per byte fees\n    const txnFeeDelta = FeeDelta.fromBigInt(minTransactionFee - (innerTxn.txn.txn.fee ?? 0n))\n\n    const currentFeeDelta = FeeDelta.fromBigInt(\n      (recursiveDelta ? FeeDelta.toBigInt(recursiveDelta) : 0n) + (txnFeeDelta ? FeeDelta.toBigInt(txnFeeDelta) : 0n),\n    )\n\n    // If after the recursive inner fee calculations we have a surplus,\n    // return undefined to avoid pooling up surplus fees, which is not allowed.\n    if (currentFeeDelta && FeeDelta.isSurplus(currentFeeDelta)) {\n      return undefined\n    }\n\n    return currentFeeDelta\n  }, acc)\n}\n"],"mappings":";;AAEA,IAAY,sDAAL;AACL;AACA;;;AAcF,MAAa,WAAW;CACtB,WAAW,OAAqC;AAC9C,MAAI,QAAQ,GACV,QAAO;GAAE,MAAM,aAAa;GAAS,MAAM;GAAO;WACzC,QAAQ,GACjB,QAAO;GAAE,MAAM,aAAa;GAAS,MAAM,CAAC;GAAO;;CAIvD,SAAS,OAAyB;AAChC,SAAO,MAAM,SAAS,aAAa,UAAU,MAAM,OAAO,CAAC,MAAM;;CAEnE,UAAU,OAA0B;AAClC,SAAO,MAAM,SAAS,aAAa;;CAErC,UAAU,OAA0B;AAClC,SAAO,MAAM,SAAS,aAAa;;CAErC,OAAO,OAAyB;AAC9B,SAAO,MAAM;;CAEf,IAAI,KAAe,KAAqC;AACtD,SAAO,SAAS,WAAW,SAAS,SAAS,IAAI,GAAG,SAAS,SAAS,IAAI,CAAC;;CAE9E;AAED,IAAM,kBAAN,MAAM,gBAAgB;CACpB,kBAA0B;AACxB,SAAO;;CAGT,mBAA2B;AACzB,SAAO;;CAGT,QAAQ,OAA4B;EAClC,MAAM,WAAW,KAAK,iBAAiB,GAAG,MAAM,iBAAiB;AACjE,MAAI,aAAa,EACf,QAAO;AAGT,SAAO;;CAGT,OAAO,OAA6B;AAClC,SAAO,iBAAiB;;;AAI5B,IAAM,4BAAN,MAAM,0BAA0B;CAC9B,YAAY,AAAgB,SAAiB;EAAjB;;CAE5B,kBAA0B;AACxB,SAAO;;CAGT,mBAA2B;AACzB,SAAO,KAAK;;CAGd,QAAQ,OAA4B;EAClC,MAAM,WAAW,KAAK,iBAAiB,GAAG,MAAM,iBAAiB;AACjE,MAAI,aAAa,EACf,QAAO;AAGT,MAAI,iBAAiB,0BACnB,QAAO,OAAO,KAAK,UAAU,MAAM,QAAQ;AAE7C,SAAO;;CAGT,OAAO,OAA6B;AAClC,SAAO,iBAAiB,6BAA6B,KAAK,YAAY,MAAM;;;AAIhF,IAAM,2BAAN,MAAM,yBAAyB;CAC7B,YAAY,AAAgB,SAAiB;EAAjB;;CAE5B,kBAA0B;AACxB,SAAO;;CAGT,mBAA2B;AACzB,SAAO,KAAK;;CAGd,QAAQ,OAA4B;EAClC,MAAM,WAAW,KAAK,iBAAiB,GAAG,MAAM,iBAAiB;AACjE,MAAI,aAAa,EACf,QAAO;AAGT,MAAI,iBAAiB,yBACnB,QAAO,OAAO,KAAK,UAAU,MAAM,QAAQ;AAE7C,SAAO;;CAGT,OAAO,OAA6B;AAClC,SAAO,iBAAiB,4BAA4B,KAAK,YAAY,MAAM;;;AAQ/E,MAAa,cAAc;CACzB,SAAS,IAAI,iBAAiB;CAC9B,kBAAkB,SAA4C;AAC5D,SAAO,IAAI,0BAA0B,QAAQ;;CAE/C,iBAAiB,SAA2C;AAC1D,SAAO,IAAI,yBAAyB,QAAQ;;CAE/C;AAED,SAAgB,uBACd,mBACA,oBAA4B,OAC5B,KACsB;AACtB,KAAI,CAAC,kBACH,QAAO;AAMT,QAAO,kBAAkB,aAAa,KAAK,aAAa;EACtD,MAAM,iBAAiB,uBAAuB,SAAS,WAAW,mBAAmB,IAAI;EAGzF,MAAM,cAAc,SAAS,WAAW,qBAAqB,SAAS,IAAI,IAAI,OAAO,IAAI;EAEzF,MAAM,kBAAkB,SAAS,YAC9B,iBAAiB,SAAS,SAAS,eAAe,GAAG,OAAO,cAAc,SAAS,SAAS,YAAY,GAAG,IAC7G;AAID,MAAI,mBAAmB,SAAS,UAAU,gBAAgB,CACxD;AAGF,SAAO;IACN,IAAI"}
+{"version":3,"file":"fee-coverage.js","names":[],"sources":["../../src/transactions/fee-coverage.ts"],"sourcesContent":["import { PendingTransactionResponse } from '@algorandfoundation/algokit-algod-client'\n\nexport enum FeeDeltaType {\n  Deficit,\n  Surplus,\n}\n\nexport type DeficitFeeDelta = {\n  type: FeeDeltaType.Deficit\n  data: bigint\n}\n\nexport type SurplusFeeDelta = {\n  type: FeeDeltaType.Surplus\n  data: bigint\n}\n\nexport type FeeDelta = DeficitFeeDelta | SurplusFeeDelta\nexport const FeeDelta = {\n  fromBigInt(value: bigint): FeeDelta | undefined {\n    if (value > 0n) {\n      return { type: FeeDeltaType.Deficit, data: value }\n    } else if (value < 0n) {\n      return { type: FeeDeltaType.Surplus, data: -value }\n    }\n    return undefined\n  },\n  toBigInt(delta: FeeDelta): bigint {\n    return delta.type === FeeDeltaType.Deficit ? delta.data : -delta.data\n  },\n  isDeficit(delta: FeeDelta): boolean {\n    return delta.type === FeeDeltaType.Deficit\n  },\n  isSurplus(delta: FeeDelta): boolean {\n    return delta.type === FeeDeltaType.Surplus\n  },\n  amount(delta: FeeDelta): bigint {\n    return delta.data\n  },\n  add(lhs: FeeDelta, rhs: FeeDelta): FeeDelta | undefined {\n    return FeeDelta.fromBigInt(FeeDelta.toBigInt(lhs) + FeeDelta.toBigInt(rhs))\n  },\n}\n\nclass CoveredPriority {\n  getPriorityType(): number {\n    return 0\n  }\n\n  getDeficitAmount(): bigint {\n    return 0n\n  }\n\n  compare(other: FeePriority): number {\n    const typeDiff = this.getPriorityType() - other.getPriorityType()\n    if (typeDiff !== 0) {\n      return typeDiff\n    }\n    // For same type (which can only be Covered), they're equal\n    return 0\n  }\n\n  equals(other: FeePriority): boolean {\n    return other instanceof CoveredPriority\n  }\n}\n\nclass ModifiableDeficitPriority {\n  constructor(public readonly deficit: bigint) {}\n\n  getPriorityType(): number {\n    return 1\n  }\n\n  getDeficitAmount(): bigint {\n    return this.deficit\n  }\n\n  compare(other: FeePriority): number {\n    const typeDiff = this.getPriorityType() - other.getPriorityType()\n    if (typeDiff !== 0) {\n      return typeDiff\n    }\n    // For same type, compare deficit amounts (larger deficit = higher priority)\n    if (other instanceof ModifiableDeficitPriority) {\n      return Number(this.deficit - other.deficit)\n    }\n    return 0\n  }\n\n  equals(other: FeePriority): boolean {\n    return other instanceof ModifiableDeficitPriority && this.deficit === other.deficit\n  }\n}\n\nclass ImmutableDeficitPriority {\n  constructor(public readonly deficit: bigint) {}\n\n  getPriorityType(): number {\n    return 2\n  }\n\n  getDeficitAmount(): bigint {\n    return this.deficit\n  }\n\n  compare(other: FeePriority): number {\n    const typeDiff = this.getPriorityType() - other.getPriorityType()\n    if (typeDiff !== 0) {\n      return typeDiff\n    }\n    // For same type, compare deficit amounts (larger deficit = higher priority)\n    if (other instanceof ImmutableDeficitPriority) {\n      return Number(this.deficit - other.deficit)\n    }\n    return 0\n  }\n\n  equals(other: FeePriority): boolean {\n    return other instanceof ImmutableDeficitPriority && this.deficit === other.deficit\n  }\n}\n\n// Priority levels for fee coverage with deficit amounts\n// ImmutableDeficit > ModifiableDeficit > Covered\n// Within same priority type, larger deficits have higher priority\nexport type FeePriority = CoveredPriority | ModifiableDeficitPriority | ImmutableDeficitPriority\nexport const FeePriority = {\n  Covered: new CoveredPriority(),\n  ModifiableDeficit(deficit: bigint): ModifiableDeficitPriority {\n    return new ModifiableDeficitPriority(deficit)\n  },\n  ImmutableDeficit(deficit: bigint): ImmutableDeficitPriority {\n    return new ImmutableDeficitPriority(deficit)\n  },\n} as const\n\nexport function calculateInnerFeeDelta(\n  innerTransactions?: PendingTransactionResponse[],\n  minTransactionFee: bigint = 1000n,\n  acc?: FeeDelta,\n): FeeDelta | undefined {\n  if (!innerTransactions) {\n    return acc\n  }\n\n  // Surplus inner transaction fees do not pool up to the parent transaction.\n  // Additionally surplus inner transaction fees only pool from sibling transactions\n  // that are sent prior to a given inner transaction, hence why we iterate in reverse order.\n  return innerTransactions.reduceRight((acc, innerTxn) => {\n    const recursiveDelta = calculateInnerFeeDelta(innerTxn.innerTxns, minTransactionFee, acc)\n\n    // Inner transactions don't require per byte fees\n    const txnFeeDelta = FeeDelta.fromBigInt(minTransactionFee - (innerTxn.txn.txn.fee ?? 0n))\n\n    const currentFeeDelta = FeeDelta.fromBigInt(\n      (recursiveDelta ? FeeDelta.toBigInt(recursiveDelta) : 0n) + (txnFeeDelta ? FeeDelta.toBigInt(txnFeeDelta) : 0n),\n    )\n\n    // If after the recursive inner fee calculations we have a surplus,\n    // return undefined to avoid pooling up surplus fees, which is not allowed.\n    if (currentFeeDelta && FeeDelta.isSurplus(currentFeeDelta)) {\n      return undefined\n    }\n\n    return currentFeeDelta\n  }, acc)\n}\n"],"mappings":";AAEA,IAAY,eAAL,yBAAA,cAAA;AACL,cAAA,aAAA,aAAA,KAAA;AACA,cAAA,aAAA,aAAA,KAAA;;KACD;AAaD,MAAa,WAAW;CACtB,WAAW,OAAqC;AAC9C,MAAI,QAAQ,GACV,QAAO;GAAE,MAAM,aAAa;GAAS,MAAM;GAAO;WACzC,QAAQ,GACjB,QAAO;GAAE,MAAM,aAAa;GAAS,MAAM,CAAC;GAAO;;CAIvD,SAAS,OAAyB;AAChC,SAAO,MAAM,SAAS,aAAa,UAAU,MAAM,OAAO,CAAC,MAAM;;CAEnE,UAAU,OAA0B;AAClC,SAAO,MAAM,SAAS,aAAa;;CAErC,UAAU,OAA0B;AAClC,SAAO,MAAM,SAAS,aAAa;;CAErC,OAAO,OAAyB;AAC9B,SAAO,MAAM;;CAEf,IAAI,KAAe,KAAqC;AACtD,SAAO,SAAS,WAAW,SAAS,SAAS,IAAI,GAAG,SAAS,SAAS,IAAI,CAAC;;CAE9E;AAED,IAAM,kBAAN,MAAM,gBAAgB;CACpB,kBAA0B;AACxB,SAAO;;CAGT,mBAA2B;AACzB,SAAO;;CAGT,QAAQ,OAA4B;EAClC,MAAM,WAAW,KAAK,iBAAiB,GAAG,MAAM,iBAAiB;AACjE,MAAI,aAAa,EACf,QAAO;AAGT,SAAO;;CAGT,OAAO,OAA6B;AAClC,SAAO,iBAAiB;;;AAI5B,IAAM,4BAAN,MAAM,0BAA0B;CAC9B,YAAY,SAAiC;AAAjB,OAAA,UAAA;;CAE5B,kBAA0B;AACxB,SAAO;;CAGT,mBAA2B;AACzB,SAAO,KAAK;;CAGd,QAAQ,OAA4B;EAClC,MAAM,WAAW,KAAK,iBAAiB,GAAG,MAAM,iBAAiB;AACjE,MAAI,aAAa,EACf,QAAO;AAGT,MAAI,iBAAiB,0BACnB,QAAO,OAAO,KAAK,UAAU,MAAM,QAAQ;AAE7C,SAAO;;CAGT,OAAO,OAA6B;AAClC,SAAO,iBAAiB,6BAA6B,KAAK,YAAY,MAAM;;;AAIhF,IAAM,2BAAN,MAAM,yBAAyB;CAC7B,YAAY,SAAiC;AAAjB,OAAA,UAAA;;CAE5B,kBAA0B;AACxB,SAAO;;CAGT,mBAA2B;AACzB,SAAO,KAAK;;CAGd,QAAQ,OAA4B;EAClC,MAAM,WAAW,KAAK,iBAAiB,GAAG,MAAM,iBAAiB;AACjE,MAAI,aAAa,EACf,QAAO;AAGT,MAAI,iBAAiB,yBACnB,QAAO,OAAO,KAAK,UAAU,MAAM,QAAQ;AAE7C,SAAO;;CAGT,OAAO,OAA6B;AAClC,SAAO,iBAAiB,4BAA4B,KAAK,YAAY,MAAM;;;AAQ/E,MAAa,cAAc;CACzB,SAAS,IAAI,iBAAiB;CAC9B,kBAAkB,SAA4C;AAC5D,SAAO,IAAI,0BAA0B,QAAQ;;CAE/C,iBAAiB,SAA2C;AAC1D,SAAO,IAAI,yBAAyB,QAAQ;;CAE/C;AAED,SAAgB,uBACd,mBACA,oBAA4B,OAC5B,KACsB;AACtB,KAAI,CAAC,kBACH,QAAO;AAMT,QAAO,kBAAkB,aAAa,KAAK,aAAa;EACtD,MAAM,iBAAiB,uBAAuB,SAAS,WAAW,mBAAmB,IAAI;EAGzF,MAAM,cAAc,SAAS,WAAW,qBAAqB,SAAS,IAAI,IAAI,OAAO,IAAI;EAEzF,MAAM,kBAAkB,SAAS,YAC9B,iBAAiB,SAAS,SAAS,eAAe,GAAG,OAAO,cAAc,SAAS,SAAS,YAAY,GAAG,IAC7G;AAID,MAAI,mBAAmB,SAAS,UAAU,gBAAgB,CACxD;AAGF,SAAO;IACN,IAAI"}

package/transactions/fee-coverage.mjs

@@ -106,7 +106,7 @@ function calculateInnerFeeDelta(innerTransactions, minTransactionFee = 1000n, ac
 		return currentFeeDelta;
 	}, acc);
 }
-
 //#endregion
 export { FeeDelta, FeePriority, calculateInnerFeeDelta };
+
 //# sourceMappingURL=fee-coverage.mjs.map

package/transactions/fee-coverage.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"fee-coverage.mjs","names":[],"sources":["../../src/transactions/fee-coverage.ts"],"sourcesContent":["import { PendingTransactionResponse } from '@algorandfoundation/algokit-algod-client'\n\nexport enum FeeDeltaType {\n  Deficit,\n  Surplus,\n}\n\nexport type DeficitFeeDelta = {\n  type: FeeDeltaType.Deficit\n  data: bigint\n}\n\nexport type SurplusFeeDelta = {\n  type: FeeDeltaType.Surplus\n  data: bigint\n}\n\nexport type FeeDelta = DeficitFeeDelta | SurplusFeeDelta\nexport const FeeDelta = {\n  fromBigInt(value: bigint): FeeDelta | undefined {\n    if (value > 0n) {\n      return { type: FeeDeltaType.Deficit, data: value }\n    } else if (value < 0n) {\n      return { type: FeeDeltaType.Surplus, data: -value }\n    }\n    return undefined\n  },\n  toBigInt(delta: FeeDelta): bigint {\n    return delta.type === FeeDeltaType.Deficit ? delta.data : -delta.data\n  },\n  isDeficit(delta: FeeDelta): boolean {\n    return delta.type === FeeDeltaType.Deficit\n  },\n  isSurplus(delta: FeeDelta): boolean {\n    return delta.type === FeeDeltaType.Surplus\n  },\n  amount(delta: FeeDelta): bigint {\n    return delta.data\n  },\n  add(lhs: FeeDelta, rhs: FeeDelta): FeeDelta | undefined {\n    return FeeDelta.fromBigInt(FeeDelta.toBigInt(lhs) + FeeDelta.toBigInt(rhs))\n  },\n}\n\nclass CoveredPriority {\n  getPriorityType(): number {\n    return 0\n  }\n\n  getDeficitAmount(): bigint {\n    return 0n\n  }\n\n  compare(other: FeePriority): number {\n    const typeDiff = this.getPriorityType() - other.getPriorityType()\n    if (typeDiff !== 0) {\n      return typeDiff\n    }\n    // For same type (which can only be Covered), they're equal\n    return 0\n  }\n\n  equals(other: FeePriority): boolean {\n    return other instanceof CoveredPriority\n  }\n}\n\nclass ModifiableDeficitPriority {\n  constructor(public readonly deficit: bigint) {}\n\n  getPriorityType(): number {\n    return 1\n  }\n\n  getDeficitAmount(): bigint {\n    return this.deficit\n  }\n\n  compare(other: FeePriority): number {\n    const typeDiff = this.getPriorityType() - other.getPriorityType()\n    if (typeDiff !== 0) {\n      return typeDiff\n    }\n    // For same type, compare deficit amounts (larger deficit = higher priority)\n    if (other instanceof ModifiableDeficitPriority) {\n      return Number(this.deficit - other.deficit)\n    }\n    return 0\n  }\n\n  equals(other: FeePriority): boolean {\n    return other instanceof ModifiableDeficitPriority && this.deficit === other.deficit\n  }\n}\n\nclass ImmutableDeficitPriority {\n  constructor(public readonly deficit: bigint) {}\n\n  getPriorityType(): number {\n    return 2\n  }\n\n  getDeficitAmount(): bigint {\n    return this.deficit\n  }\n\n  compare(other: FeePriority): number {\n    const typeDiff = this.getPriorityType() - other.getPriorityType()\n    if (typeDiff !== 0) {\n      return typeDiff\n    }\n    // For same type, compare deficit amounts (larger deficit = higher priority)\n    if (other instanceof ImmutableDeficitPriority) {\n      return Number(this.deficit - other.deficit)\n    }\n    return 0\n  }\n\n  equals(other: FeePriority): boolean {\n    return other instanceof ImmutableDeficitPriority && this.deficit === other.deficit\n  }\n}\n\n// Priority levels for fee coverage with deficit amounts\n// ImmutableDeficit > ModifiableDeficit > Covered\n// Within same priority type, larger deficits have higher priority\nexport type FeePriority = CoveredPriority | ModifiableDeficitPriority | ImmutableDeficitPriority\nexport const FeePriority = {\n  Covered: new CoveredPriority(),\n  ModifiableDeficit(deficit: bigint): ModifiableDeficitPriority {\n    return new ModifiableDeficitPriority(deficit)\n  },\n  ImmutableDeficit(deficit: bigint): ImmutableDeficitPriority {\n    return new ImmutableDeficitPriority(deficit)\n  },\n} as const\n\nexport function calculateInnerFeeDelta(\n  innerTransactions?: PendingTransactionResponse[],\n  minTransactionFee: bigint = 1000n,\n  acc?: FeeDelta,\n): FeeDelta | undefined {\n  if (!innerTransactions) {\n    return acc\n  }\n\n  // Surplus inner transaction fees do not pool up to the parent transaction.\n  // Additionally surplus inner transaction fees only pool from sibling transactions\n  // that are sent prior to a given inner transaction, hence why we iterate in reverse order.\n  return innerTransactions.reduceRight((acc, innerTxn) => {\n    const recursiveDelta = calculateInnerFeeDelta(innerTxn.innerTxns, minTransactionFee, acc)\n\n    // Inner transactions don't require per byte fees\n    const txnFeeDelta = FeeDelta.fromBigInt(minTransactionFee - (innerTxn.txn.txn.fee ?? 0n))\n\n    const currentFeeDelta = FeeDelta.fromBigInt(\n      (recursiveDelta ? FeeDelta.toBigInt(recursiveDelta) : 0n) + (txnFeeDelta ? FeeDelta.toBigInt(txnFeeDelta) : 0n),\n    )\n\n    // If after the recursive inner fee calculations we have a surplus,\n    // return undefined to avoid pooling up surplus fees, which is not allowed.\n    if (currentFeeDelta && FeeDelta.isSurplus(currentFeeDelta)) {\n      return undefined\n    }\n\n    return currentFeeDelta\n  }, acc)\n}\n"],"mappings":";AAEA,IAAY,sDAAL;AACL;AACA;;;AAcF,MAAa,WAAW;CACtB,WAAW,OAAqC;AAC9C,MAAI,QAAQ,GACV,QAAO;GAAE,MAAM,aAAa;GAAS,MAAM;GAAO;WACzC,QAAQ,GACjB,QAAO;GAAE,MAAM,aAAa;GAAS,MAAM,CAAC;GAAO;;CAIvD,SAAS,OAAyB;AAChC,SAAO,MAAM,SAAS,aAAa,UAAU,MAAM,OAAO,CAAC,MAAM;;CAEnE,UAAU,OAA0B;AAClC,SAAO,MAAM,SAAS,aAAa;;CAErC,UAAU,OAA0B;AAClC,SAAO,MAAM,SAAS,aAAa;;CAErC,OAAO,OAAyB;AAC9B,SAAO,MAAM;;CAEf,IAAI,KAAe,KAAqC;AACtD,SAAO,SAAS,WAAW,SAAS,SAAS,IAAI,GAAG,SAAS,SAAS,IAAI,CAAC;;CAE9E;AAED,IAAM,kBAAN,MAAM,gBAAgB;CACpB,kBAA0B;AACxB,SAAO;;CAGT,mBAA2B;AACzB,SAAO;;CAGT,QAAQ,OAA4B;EAClC,MAAM,WAAW,KAAK,iBAAiB,GAAG,MAAM,iBAAiB;AACjE,MAAI,aAAa,EACf,QAAO;AAGT,SAAO;;CAGT,OAAO,OAA6B;AAClC,SAAO,iBAAiB;;;AAI5B,IAAM,4BAAN,MAAM,0BAA0B;CAC9B,YAAY,AAAgB,SAAiB;EAAjB;;CAE5B,kBAA0B;AACxB,SAAO;;CAGT,mBAA2B;AACzB,SAAO,KAAK;;CAGd,QAAQ,OAA4B;EAClC,MAAM,WAAW,KAAK,iBAAiB,GAAG,MAAM,iBAAiB;AACjE,MAAI,aAAa,EACf,QAAO;AAGT,MAAI,iBAAiB,0BACnB,QAAO,OAAO,KAAK,UAAU,MAAM,QAAQ;AAE7C,SAAO;;CAGT,OAAO,OAA6B;AAClC,SAAO,iBAAiB,6BAA6B,KAAK,YAAY,MAAM;;;AAIhF,IAAM,2BAAN,MAAM,yBAAyB;CAC7B,YAAY,AAAgB,SAAiB;EAAjB;;CAE5B,kBAA0B;AACxB,SAAO;;CAGT,mBAA2B;AACzB,SAAO,KAAK;;CAGd,QAAQ,OAA4B;EAClC,MAAM,WAAW,KAAK,iBAAiB,GAAG,MAAM,iBAAiB;AACjE,MAAI,aAAa,EACf,QAAO;AAGT,MAAI,iBAAiB,yBACnB,QAAO,OAAO,KAAK,UAAU,MAAM,QAAQ;AAE7C,SAAO;;CAGT,OAAO,OAA6B;AAClC,SAAO,iBAAiB,4BAA4B,KAAK,YAAY,MAAM;;;AAQ/E,MAAa,cAAc;CACzB,SAAS,IAAI,iBAAiB;CAC9B,kBAAkB,SAA4C;AAC5D,SAAO,IAAI,0BAA0B,QAAQ;;CAE/C,iBAAiB,SAA2C;AAC1D,SAAO,IAAI,yBAAyB,QAAQ;;CAE/C;AAED,SAAgB,uBACd,mBACA,oBAA4B,OAC5B,KACsB;AACtB,KAAI,CAAC,kBACH,QAAO;AAMT,QAAO,kBAAkB,aAAa,KAAK,aAAa;EACtD,MAAM,iBAAiB,uBAAuB,SAAS,WAAW,mBAAmB,IAAI;EAGzF,MAAM,cAAc,SAAS,WAAW,qBAAqB,SAAS,IAAI,IAAI,OAAO,IAAI;EAEzF,MAAM,kBAAkB,SAAS,YAC9B,iBAAiB,SAAS,SAAS,eAAe,GAAG,OAAO,cAAc,SAAS,SAAS,YAAY,GAAG,IAC7G;AAID,MAAI,mBAAmB,SAAS,UAAU,gBAAgB,CACxD;AAGF,SAAO;IACN,IAAI"}
+{"version":3,"file":"fee-coverage.mjs","names":[],"sources":["../../src/transactions/fee-coverage.ts"],"sourcesContent":["import { PendingTransactionResponse } from '@algorandfoundation/algokit-algod-client'\n\nexport enum FeeDeltaType {\n  Deficit,\n  Surplus,\n}\n\nexport type DeficitFeeDelta = {\n  type: FeeDeltaType.Deficit\n  data: bigint\n}\n\nexport type SurplusFeeDelta = {\n  type: FeeDeltaType.Surplus\n  data: bigint\n}\n\nexport type FeeDelta = DeficitFeeDelta | SurplusFeeDelta\nexport const FeeDelta = {\n  fromBigInt(value: bigint): FeeDelta | undefined {\n    if (value > 0n) {\n      return { type: FeeDeltaType.Deficit, data: value }\n    } else if (value < 0n) {\n      return { type: FeeDeltaType.Surplus, data: -value }\n    }\n    return undefined\n  },\n  toBigInt(delta: FeeDelta): bigint {\n    return delta.type === FeeDeltaType.Deficit ? delta.data : -delta.data\n  },\n  isDeficit(delta: FeeDelta): boolean {\n    return delta.type === FeeDeltaType.Deficit\n  },\n  isSurplus(delta: FeeDelta): boolean {\n    return delta.type === FeeDeltaType.Surplus\n  },\n  amount(delta: FeeDelta): bigint {\n    return delta.data\n  },\n  add(lhs: FeeDelta, rhs: FeeDelta): FeeDelta | undefined {\n    return FeeDelta.fromBigInt(FeeDelta.toBigInt(lhs) + FeeDelta.toBigInt(rhs))\n  },\n}\n\nclass CoveredPriority {\n  getPriorityType(): number {\n    return 0\n  }\n\n  getDeficitAmount(): bigint {\n    return 0n\n  }\n\n  compare(other: FeePriority): number {\n    const typeDiff = this.getPriorityType() - other.getPriorityType()\n    if (typeDiff !== 0) {\n      return typeDiff\n    }\n    // For same type (which can only be Covered), they're equal\n    return 0\n  }\n\n  equals(other: FeePriority): boolean {\n    return other instanceof CoveredPriority\n  }\n}\n\nclass ModifiableDeficitPriority {\n  constructor(public readonly deficit: bigint) {}\n\n  getPriorityType(): number {\n    return 1\n  }\n\n  getDeficitAmount(): bigint {\n    return this.deficit\n  }\n\n  compare(other: FeePriority): number {\n    const typeDiff = this.getPriorityType() - other.getPriorityType()\n    if (typeDiff !== 0) {\n      return typeDiff\n    }\n    // For same type, compare deficit amounts (larger deficit = higher priority)\n    if (other instanceof ModifiableDeficitPriority) {\n      return Number(this.deficit - other.deficit)\n    }\n    return 0\n  }\n\n  equals(other: FeePriority): boolean {\n    return other instanceof ModifiableDeficitPriority && this.deficit === other.deficit\n  }\n}\n\nclass ImmutableDeficitPriority {\n  constructor(public readonly deficit: bigint) {}\n\n  getPriorityType(): number {\n    return 2\n  }\n\n  getDeficitAmount(): bigint {\n    return this.deficit\n  }\n\n  compare(other: FeePriority): number {\n    const typeDiff = this.getPriorityType() - other.getPriorityType()\n    if (typeDiff !== 0) {\n      return typeDiff\n    }\n    // For same type, compare deficit amounts (larger deficit = higher priority)\n    if (other instanceof ImmutableDeficitPriority) {\n      return Number(this.deficit - other.deficit)\n    }\n    return 0\n  }\n\n  equals(other: FeePriority): boolean {\n    return other instanceof ImmutableDeficitPriority && this.deficit === other.deficit\n  }\n}\n\n// Priority levels for fee coverage with deficit amounts\n// ImmutableDeficit > ModifiableDeficit > Covered\n// Within same priority type, larger deficits have higher priority\nexport type FeePriority = CoveredPriority | ModifiableDeficitPriority | ImmutableDeficitPriority\nexport const FeePriority = {\n  Covered: new CoveredPriority(),\n  ModifiableDeficit(deficit: bigint): ModifiableDeficitPriority {\n    return new ModifiableDeficitPriority(deficit)\n  },\n  ImmutableDeficit(deficit: bigint): ImmutableDeficitPriority {\n    return new ImmutableDeficitPriority(deficit)\n  },\n} as const\n\nexport function calculateInnerFeeDelta(\n  innerTransactions?: PendingTransactionResponse[],\n  minTransactionFee: bigint = 1000n,\n  acc?: FeeDelta,\n): FeeDelta | undefined {\n  if (!innerTransactions) {\n    return acc\n  }\n\n  // Surplus inner transaction fees do not pool up to the parent transaction.\n  // Additionally surplus inner transaction fees only pool from sibling transactions\n  // that are sent prior to a given inner transaction, hence why we iterate in reverse order.\n  return innerTransactions.reduceRight((acc, innerTxn) => {\n    const recursiveDelta = calculateInnerFeeDelta(innerTxn.innerTxns, minTransactionFee, acc)\n\n    // Inner transactions don't require per byte fees\n    const txnFeeDelta = FeeDelta.fromBigInt(minTransactionFee - (innerTxn.txn.txn.fee ?? 0n))\n\n    const currentFeeDelta = FeeDelta.fromBigInt(\n      (recursiveDelta ? FeeDelta.toBigInt(recursiveDelta) : 0n) + (txnFeeDelta ? FeeDelta.toBigInt(txnFeeDelta) : 0n),\n    )\n\n    // If after the recursive inner fee calculations we have a surplus,\n    // return undefined to avoid pooling up surplus fees, which is not allowed.\n    if (currentFeeDelta && FeeDelta.isSurplus(currentFeeDelta)) {\n      return undefined\n    }\n\n    return currentFeeDelta\n  }, acc)\n}\n"],"mappings":";AAEA,IAAY,eAAL,yBAAA,cAAA;AACL,cAAA,aAAA,aAAA,KAAA;AACA,cAAA,aAAA,aAAA,KAAA;;KACD;AAaD,MAAa,WAAW;CACtB,WAAW,OAAqC;AAC9C,MAAI,QAAQ,GACV,QAAO;GAAE,MAAM,aAAa;GAAS,MAAM;GAAO;WACzC,QAAQ,GACjB,QAAO;GAAE,MAAM,aAAa;GAAS,MAAM,CAAC;GAAO;;CAIvD,SAAS,OAAyB;AAChC,SAAO,MAAM,SAAS,aAAa,UAAU,MAAM,OAAO,CAAC,MAAM;;CAEnE,UAAU,OAA0B;AAClC,SAAO,MAAM,SAAS,aAAa;;CAErC,UAAU,OAA0B;AAClC,SAAO,MAAM,SAAS,aAAa;;CAErC,OAAO,OAAyB;AAC9B,SAAO,MAAM;;CAEf,IAAI,KAAe,KAAqC;AACtD,SAAO,SAAS,WAAW,SAAS,SAAS,IAAI,GAAG,SAAS,SAAS,IAAI,CAAC;;CAE9E;AAED,IAAM,kBAAN,MAAM,gBAAgB;CACpB,kBAA0B;AACxB,SAAO;;CAGT,mBAA2B;AACzB,SAAO;;CAGT,QAAQ,OAA4B;EAClC,MAAM,WAAW,KAAK,iBAAiB,GAAG,MAAM,iBAAiB;AACjE,MAAI,aAAa,EACf,QAAO;AAGT,SAAO;;CAGT,OAAO,OAA6B;AAClC,SAAO,iBAAiB;;;AAI5B,IAAM,4BAAN,MAAM,0BAA0B;CAC9B,YAAY,SAAiC;AAAjB,OAAA,UAAA;;CAE5B,kBAA0B;AACxB,SAAO;;CAGT,mBAA2B;AACzB,SAAO,KAAK;;CAGd,QAAQ,OAA4B;EAClC,MAAM,WAAW,KAAK,iBAAiB,GAAG,MAAM,iBAAiB;AACjE,MAAI,aAAa,EACf,QAAO;AAGT,MAAI,iBAAiB,0BACnB,QAAO,OAAO,KAAK,UAAU,MAAM,QAAQ;AAE7C,SAAO;;CAGT,OAAO,OAA6B;AAClC,SAAO,iBAAiB,6BAA6B,KAAK,YAAY,MAAM;;;AAIhF,IAAM,2BAAN,MAAM,yBAAyB;CAC7B,YAAY,SAAiC;AAAjB,OAAA,UAAA;;CAE5B,kBAA0B;AACxB,SAAO;;CAGT,mBAA2B;AACzB,SAAO,KAAK;;CAGd,QAAQ,OAA4B;EAClC,MAAM,WAAW,KAAK,iBAAiB,GAAG,MAAM,iBAAiB;AACjE,MAAI,aAAa,EACf,QAAO;AAGT,MAAI,iBAAiB,yBACnB,QAAO,OAAO,KAAK,UAAU,MAAM,QAAQ;AAE7C,SAAO;;CAGT,OAAO,OAA6B;AAClC,SAAO,iBAAiB,4BAA4B,KAAK,YAAY,MAAM;;;AAQ/E,MAAa,cAAc;CACzB,SAAS,IAAI,iBAAiB;CAC9B,kBAAkB,SAA4C;AAC5D,SAAO,IAAI,0BAA0B,QAAQ;;CAE/C,iBAAiB,SAA2C;AAC1D,SAAO,IAAI,yBAAyB,QAAQ;;CAE/C;AAED,SAAgB,uBACd,mBACA,oBAA4B,OAC5B,KACsB;AACtB,KAAI,CAAC,kBACH,QAAO;AAMT,QAAO,kBAAkB,aAAa,KAAK,aAAa;EACtD,MAAM,iBAAiB,uBAAuB,SAAS,WAAW,mBAAmB,IAAI;EAGzF,MAAM,cAAc,SAAS,WAAW,qBAAqB,SAAS,IAAI,IAAI,OAAO,IAAI;EAEzF,MAAM,kBAAkB,SAAS,YAC9B,iBAAiB,SAAS,SAAS,eAAe,GAAG,OAAO,cAAc,SAAS,SAAS,YAAY,GAAG,IAC7G;AAID,MAAI,mBAAmB,SAAS,UAAU,gBAAgB,CACxD;AAGF,SAAO;IACN,IAAI"}

package/transactions/key-registration.d.ts

@@ -1,26 +1,18 @@
 import { CommonTransactionParams } from "./common.js";
 
 //#region src/transactions/key-registration.d.ts
-
 /** Parameters to define an online key registration transaction. */
 type OnlineKeyRegistrationParams = CommonTransactionParams & {
-  /** The root participation public key */
-  voteKey: Uint8Array;
-  /** The VRF public key */
-  selectionKey: Uint8Array;
-  /** The first round that the participation key is valid. Not to be confused with the `firstValid` round of the keyreg transaction */
-  voteFirst: bigint;
-  /** The last round that the participation key is valid. Not to be confused with the `lastValid` round of the keyreg transaction */
-  voteLast: bigint;
-  /** This is the dilution for the 2-level participation key. It determines the interval (number of rounds) for generating new ephemeral keys */
-  voteKeyDilution: bigint;
-  /** The 64 byte state proof public key commitment */
+  /** The root participation public key */voteKey: Uint8Array; /** The VRF public key */
+  selectionKey: Uint8Array; /** The first round that the participation key is valid. Not to be confused with the `firstValid` round of the keyreg transaction */
+  voteFirst: bigint; /** The last round that the participation key is valid. Not to be confused with the `lastValid` round of the keyreg transaction */
+  voteLast: bigint; /** This is the dilution for the 2-level participation key. It determines the interval (number of rounds) for generating new ephemeral keys */
+  voteKeyDilution: bigint; /** The 64 byte state proof public key commitment */
   stateProofKey: Uint8Array;
 };
 /** Parameters to define an offline key registration transaction. */
 type OfflineKeyRegistrationParams = CommonTransactionParams & {
-  /** Prevent this account from ever participating again. The account will also no longer earn rewards */
-  preventAccountFromEverParticipatingAgain?: boolean;
+  /** Prevent this account from ever participating again. The account will also no longer earn rewards */preventAccountFromEverParticipatingAgain?: boolean;
 };
 //#endregion
 export { OfflineKeyRegistrationParams, OnlineKeyRegistrationParams };