@algorandfoundation/algokit-utils 9.2.0-beta.7 → 10.0.0-alpha.1

package/transactions/asset-config.d.ts

@@ -0,0 +1,177 @@
+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.
+ */
+type AssetCreateParams = CommonTransactionParams & {
+  /** The total amount of the smallest divisible (decimal) unit to create.
+   *
+   * For example, if `decimals` is, say, 2, then for every 100 `total` there would be 1 whole unit.
+   *
+   * This field can only be specified upon asset creation.
+   */
+  total: bigint;
+  /** The amount of decimal places the asset should have.
+   *
+   * If unspecified then the asset will be in whole units (i.e. `0`).
+   *
+   * * If 0, the asset is not divisible;
+   * * If 1, the base unit of the asset is in tenths;
+   * * If 2, the base unit of the asset is in hundredths;
+   * * If 3, the base unit of the asset is in thousandths;
+   * * and so on up to 19 decimal places.
+   *
+   * This field can only be specified upon asset creation.
+   */
+  decimals?: number;
+  /** The optional name of the asset.
+   *
+   * Max size is 32 bytes.
+   *
+   * This field can only be specified upon asset creation.
+   */
+  assetName?: string;
+  /** The optional name of the unit of this asset (e.g. ticker name).
+   *
+   * Max size is 8 bytes.
+   *
+   * This field can only be specified upon asset creation.
+   */
+  unitName?: string;
+  /** Specifies an optional URL where more information about the asset can be retrieved (e.g. metadata).
+   *
+   * Max size is 96 bytes.
+   *
+   * This field can only be specified upon asset creation.
+   */
+  url?: string;
+  /** 32-byte hash of some metadata that is relevant to your asset and/or asset holders.
+   *
+   * The format of this metadata is up to the application.
+   *
+   * This field can only be specified upon asset creation.
+   */
+  metadataHash?: string | Uint8Array;
+  /** Whether the asset is frozen by default for all accounts.
+   * Defaults to `false`.
+   *
+   * If `true` then for anyone apart from the creator to hold the
+   * asset it needs to be unfrozen per account using an asset freeze
+   * transaction from the `freeze` account, which must be set on creation.
+   *
+   * This field can only be specified upon asset creation.
+   */
+  defaultFrozen?: boolean;
+  /** 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`.
+   *
+   * If not set (`undefined` or `""`) at asset creation or subsequently set to empty by the `manager` the asset becomes permanently immutable.
+   */
+  manager?: ReadableAddress;
+  /**
+   * The address of the optional account that holds the reserve (uncirculated supply) units of the asset.
+   *
+   * This address has no specific authority in the protocol itself and is informational only.
+   *
+   * Some standards like [ARC-19](https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0019.md)
+   * rely on this field to hold meaningful data.
+   *
+   * It can be used in the case where you want to signal to holders of your asset that the uncirculated units
+   * of the asset reside in an account that is different from the default creator account.
+   *
+   * If not set (`undefined` or `""`) at asset creation or subsequently set to empty by the manager the field is permanently empty.
+   */
+  reserve?: ReadableAddress;
+  /**
+   * The address of the optional account that can be used to freeze or unfreeze holdings of this asset for any account.
+   *
+   * If empty, freezing is not permitted.
+   *
+   * If not set (`undefined` or `""`) at asset creation or subsequently set to empty by the manager the field is permanently empty.
+   */
+  freeze?: ReadableAddress;
+  /**
+   * The address of the optional account that can clawback holdings of this asset from any account.
+   *
+   * **This field should be used with caution** as the clawback account has the ability to **unconditionally take assets from any account**.
+   *
+   * If empty, clawback is not permitted.
+   *
+   * If not set (`undefined` or `""`) at asset creation or subsequently set to empty by the manager the field is permanently empty.
+   */
+  clawback?: ReadableAddress;
+};
+/** Parameters to define an asset reconfiguration transaction.
+ *
+ * **Note:** The manager, reserve, freeze, and clawback addresses
+ * are immutably empty if they are not set. If manager is not set then
+ * all fields are immutable from that point forward.
+ */
+type AssetConfigParams = CommonTransactionParams & {
+  /** 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`.
+   *
+   * If not set (`undefined` or `""`) the asset will become permanently immutable.
+   */
+  manager?: ReadableAddress;
+  /**
+   * The address of the optional account that holds the reserve (uncirculated supply) units of the asset.
+   *
+   * This address has no specific authority in the protocol itself and is informational only.
+   *
+   * Some standards like [ARC-19](https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0019.md)
+   * rely on this field to hold meaningful data.
+   *
+   * It can be used in the case where you want to signal to holders of your asset that the uncirculated units
+   * of the asset reside in an account that is different from the default creator account.
+   *
+   * If not set (`undefined` or `""`) the field will become permanently empty.
+   */
+  reserve?: ReadableAddress;
+  /**
+   * The address of the optional account that can be used to freeze or unfreeze holdings of this asset for any account.
+   *
+   * If empty, freezing is not permitted.
+   *
+   * If not set (`undefined` or `""`) the field will become permanently empty.
+   */
+  freeze?: ReadableAddress;
+  /**
+   * The address of the optional account that can clawback holdings of this asset from any account.
+   *
+   * **This field should be used with caution** as the clawback account has the ability to **unconditionally take assets from any account**.
+   *
+   * If empty, clawback is not permitted.
+   *
+   * If not set (`undefined` or `""`) the field will become permanently empty.
+   */
+  clawback?: ReadableAddress;
+};
+/** 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 */
+  account: ReadableAddress;
+  /** Whether the assets in the account should be frozen */
+  frozen: boolean;
+};
+/** Parameters to define an asset destroy transaction.
+ *
+ * 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;
+};
+//#endregion
+export { AssetConfigParams, AssetCreateParams, AssetDestroyParams, AssetFreezeParams };
+//# sourceMappingURL=asset-config.d.ts.map

package/transactions/asset-config.js

@@ -0,0 +1,64 @@
+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({
+		...require_common.buildTransactionCommonData(params, suggestedParams, defaultValidityWindow),
+		type: require_transaction_type.TransactionType.AssetConfig,
+		assetConfig: {
+			assetId: 0n,
+			total: params.total,
+			decimals: params.decimals,
+			defaultFrozen: params.defaultFrozen,
+			assetName: params.assetName,
+			unitName: params.unitName,
+			url: params.url,
+			metadataHash: require_common.ensureString(params.metadataHash),
+			manager: require_address.getOptionalAddress(params.manager),
+			reserve: require_address.getOptionalAddress(params.reserve),
+			freeze: require_address.getOptionalAddress(params.freeze),
+			clawback: require_address.getOptionalAddress(params.clawback)
+		}
+	});
+};
+const buildAssetConfig = (params, suggestedParams, defaultValidityWindow) => {
+	return new require_transaction.Transaction({
+		...require_common.buildTransactionCommonData(params, suggestedParams, defaultValidityWindow),
+		type: require_transaction_type.TransactionType.AssetConfig,
+		assetConfig: {
+			assetId: params.assetId,
+			manager: require_address.getOptionalAddress(params.manager),
+			reserve: require_address.getOptionalAddress(params.reserve),
+			freeze: require_address.getOptionalAddress(params.freeze),
+			clawback: require_address.getOptionalAddress(params.clawback)
+		}
+	});
+};
+const buildAssetFreeze = (params, suggestedParams, defaultValidityWindow) => {
+	return new require_transaction.Transaction({
+		...require_common.buildTransactionCommonData(params, suggestedParams, defaultValidityWindow),
+		type: require_transaction_type.TransactionType.AssetFreeze,
+		assetFreeze: {
+			assetId: params.assetId,
+			freezeTarget: require_address.getAddress(params.account),
+			frozen: params.frozen
+		}
+	});
+};
+const buildAssetDestroy = (params, suggestedParams, defaultValidityWindow) => {
+	return new require_transaction.Transaction({
+		...require_common.buildTransactionCommonData(params, suggestedParams, defaultValidityWindow),
+		type: require_transaction_type.TransactionType.AssetConfig,
+		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

@@ -0,0 +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  account: 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.account),\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,QAAQ;GACxC,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"}

package/transactions/asset-config.mjs

@@ -0,0 +1,61 @@
+import { getAddress, getOptionalAddress } from "../packages/common/src/address.mjs";
+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({
+		...buildTransactionCommonData(params, suggestedParams, defaultValidityWindow),
+		type: TransactionType.AssetConfig,
+		assetConfig: {
+			assetId: 0n,
+			total: params.total,
+			decimals: params.decimals,
+			defaultFrozen: params.defaultFrozen,
+			assetName: params.assetName,
+			unitName: params.unitName,
+			url: params.url,
+			metadataHash: ensureString(params.metadataHash),
+			manager: getOptionalAddress(params.manager),
+			reserve: getOptionalAddress(params.reserve),
+			freeze: getOptionalAddress(params.freeze),
+			clawback: getOptionalAddress(params.clawback)
+		}
+	});
+};
+const buildAssetConfig = (params, suggestedParams, defaultValidityWindow) => {
+	return new Transaction({
+		...buildTransactionCommonData(params, suggestedParams, defaultValidityWindow),
+		type: TransactionType.AssetConfig,
+		assetConfig: {
+			assetId: params.assetId,
+			manager: getOptionalAddress(params.manager),
+			reserve: getOptionalAddress(params.reserve),
+			freeze: getOptionalAddress(params.freeze),
+			clawback: getOptionalAddress(params.clawback)
+		}
+	});
+};
+const buildAssetFreeze = (params, suggestedParams, defaultValidityWindow) => {
+	return new Transaction({
+		...buildTransactionCommonData(params, suggestedParams, defaultValidityWindow),
+		type: TransactionType.AssetFreeze,
+		assetFreeze: {
+			assetId: params.assetId,
+			freezeTarget: getAddress(params.account),
+			frozen: params.frozen
+		}
+	});
+};
+const buildAssetDestroy = (params, suggestedParams, defaultValidityWindow) => {
+	return new Transaction({
+		...buildTransactionCommonData(params, suggestedParams, defaultValidityWindow),
+		type: TransactionType.AssetConfig,
+		assetConfig: { assetId: params.assetId }
+	});
+};
+
+//#endregion
+export { buildAssetConfig, buildAssetCreate, buildAssetDestroy, buildAssetFreeze };
+//# sourceMappingURL=asset-config.mjs.map

package/transactions/asset-config.mjs.map

@@ -0,0 +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  account: 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.account),\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,QAAQ;GACxC,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

@@ -0,0 +1,44 @@
+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). */
+  receiver: ReadableAddress;
+  /** Optional address of an account to clawback the asset from.
+   *
+   * Requires the sender to be the clawback account.
+   *
+   * **Warning:** Be careful with this parameter as it can lead to unexpected loss of funds if not used correctly.
+   */
+  clawbackTarget?: ReadableAddress;
+  /** Optional address of an account to close the asset position to.
+   *
+   * **Warning:** Be careful with this parameter as it can lead to loss of funds if not used correctly.
+   */
+  closeAssetTo?: ReadableAddress;
+};
+/** Parameters to define an asset opt-in transaction. */
+type AssetOptInParams = CommonTransactionParams & {
+  /** 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;
+  /**
+   * The address of the asset creator account to close the asset
+   *   position to (any remaining asset units will be sent to this account).
+   */
+  creator: ReadableAddress;
+};
+//#endregion
+export { AssetOptInParams, AssetOptOutParams, AssetTransferParams };
+//# sourceMappingURL=asset-transfer.d.ts.map

package/transactions/asset-transfer.js

@@ -0,0 +1,50 @@
+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({
+		...require_common.buildTransactionCommonData(params, suggestedParams, defaultValidityWindow),
+		type: require_transaction_type.TransactionType.AssetTransfer,
+		assetTransfer: {
+			assetId: params.assetId,
+			amount: params.amount,
+			receiver: require_address.getAddress(params.receiver),
+			assetSender: require_address.getOptionalAddress(params.clawbackTarget),
+			closeRemainderTo: require_address.getOptionalAddress(params.closeAssetTo)
+		}
+	});
+};
+const buildAssetOptIn = (params, suggestedParams, defaultValidityWindow) => {
+	const commonData = require_common.buildTransactionCommonData(params, suggestedParams, defaultValidityWindow);
+	return new require_transaction.Transaction({
+		...commonData,
+		type: require_transaction_type.TransactionType.AssetTransfer,
+		assetTransfer: {
+			assetId: params.assetId,
+			amount: 0n,
+			receiver: commonData.sender
+		}
+	});
+};
+const buildAssetOptOut = (params, suggestedParams, defaultValidityWindow) => {
+	const commonData = require_common.buildTransactionCommonData(params, suggestedParams, defaultValidityWindow);
+	return new require_transaction.Transaction({
+		...commonData,
+		type: require_transaction_type.TransactionType.AssetTransfer,
+		assetTransfer: {
+			assetId: params.assetId,
+			amount: 0n,
+			receiver: commonData.sender,
+			closeRemainderTo: require_address.getOptionalAddress(params.creator)
+		}
+	});
+};
+
+//#endregion
+exports.buildAssetOptIn = buildAssetOptIn;
+exports.buildAssetOptOut = buildAssetOptOut;
+exports.buildAssetTransfer = buildAssetTransfer;
+//# sourceMappingURL=asset-transfer.js.map

package/transactions/asset-transfer.js.map

@@ -0,0 +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"}

package/transactions/asset-transfer.mjs

@@ -0,0 +1,48 @@
+import { getAddress, getOptionalAddress } from "../packages/common/src/address.mjs";
+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({
+		...buildTransactionCommonData(params, suggestedParams, defaultValidityWindow),
+		type: TransactionType.AssetTransfer,
+		assetTransfer: {
+			assetId: params.assetId,
+			amount: params.amount,
+			receiver: getAddress(params.receiver),
+			assetSender: getOptionalAddress(params.clawbackTarget),
+			closeRemainderTo: getOptionalAddress(params.closeAssetTo)
+		}
+	});
+};
+const buildAssetOptIn = (params, suggestedParams, defaultValidityWindow) => {
+	const commonData = buildTransactionCommonData(params, suggestedParams, defaultValidityWindow);
+	return new Transaction({
+		...commonData,
+		type: TransactionType.AssetTransfer,
+		assetTransfer: {
+			assetId: params.assetId,
+			amount: 0n,
+			receiver: commonData.sender
+		}
+	});
+};
+const buildAssetOptOut = (params, suggestedParams, defaultValidityWindow) => {
+	const commonData = buildTransactionCommonData(params, suggestedParams, defaultValidityWindow);
+	return new Transaction({
+		...commonData,
+		type: TransactionType.AssetTransfer,
+		assetTransfer: {
+			assetId: params.assetId,
+			amount: 0n,
+			receiver: commonData.sender,
+			closeRemainderTo: getOptionalAddress(params.creator)
+		}
+	});
+};
+
+//#endregion
+export { buildAssetOptIn, buildAssetOptOut, buildAssetTransfer };
+//# sourceMappingURL=asset-transfer.mjs.map

package/transactions/asset-transfer.mjs.map

@@ -0,0 +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"}

package/transactions/common.d.ts

@@ -0,0 +1,48 @@
+import { ReadableAddress } from "../packages/common/src/address.js";
+import { AddressWithTransactionSigner, SendingAddress, TransactionSigner } from "../packages/transact/src/signer.js";
+import { AlgoAmount } from "../types/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 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).
+   */
+  signer?: TransactionSigner | AddressWithTransactionSigner;
+  /** Change the signing key of the sender to the given address.
+   *
+   * **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. */
+  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. */
+  validityWindow?: number | bigint;
+  /**
+   * Set the first round this transaction is valid.
+   * If left undefined, the value from algod will be used.
+   *
+   * 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. */
+  lastValidRound?: bigint;
+};
+//#endregion
+export { CommonTransactionParams };
+//# sourceMappingURL=common.d.ts.map

package/transactions/common.js

@@ -0,0 +1,31 @@
+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;
+	const encoder = new TextEncoder();
+	return typeof data === "string" ? encoder.encode(data) : data;
+};
+const buildTransactionCommonData = (commonParams, suggestedParams, defaultValidityWindow) => {
+	const firstValid = commonParams.firstValidRound ?? suggestedParams.firstValid;
+	const lease = commonParams.lease === void 0 ? void 0 : require_transaction.encodeLease(commonParams.lease);
+	const note = ensureString(commonParams.note);
+	return {
+		sender: require_address.getAddress(commonParams.sender),
+		rekeyTo: require_address.getOptionalAddress(commonParams.rekeyTo),
+		note,
+		lease,
+		fee: commonParams.staticFee?.microAlgos,
+		genesisId: suggestedParams.genesisId,
+		genesisHash: suggestedParams.genesisHash,
+		firstValid,
+		lastValid: commonParams.lastValidRound ?? (commonParams.validityWindow !== void 0 ? firstValid + BigInt(commonParams.validityWindow) : firstValid + defaultValidityWindow),
+		group: void 0
+	};
+};
+
+//#endregion
+exports.buildTransactionCommonData = buildTransactionCommonData;
+exports.ensureString = ensureString;
+//# sourceMappingURL=common.js.map

package/transactions/common.js.map

@@ -0,0 +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 { encodeLease } from '../transaction'\nimport { AlgoAmount } from '../types/amount'\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"}

package/transactions/common.mjs

@@ -0,0 +1,30 @@
+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;
+	const encoder = new TextEncoder();
+	return typeof data === "string" ? encoder.encode(data) : data;
+};
+const buildTransactionCommonData = (commonParams, suggestedParams, defaultValidityWindow) => {
+	const firstValid = commonParams.firstValidRound ?? suggestedParams.firstValid;
+	const lease = commonParams.lease === void 0 ? void 0 : encodeLease(commonParams.lease);
+	const note = ensureString(commonParams.note);
+	return {
+		sender: getAddress(commonParams.sender),
+		rekeyTo: getOptionalAddress(commonParams.rekeyTo),
+		note,
+		lease,
+		fee: commonParams.staticFee?.microAlgos,
+		genesisId: suggestedParams.genesisId,
+		genesisHash: suggestedParams.genesisHash,
+		firstValid,
+		lastValid: commonParams.lastValidRound ?? (commonParams.validityWindow !== void 0 ? firstValid + BigInt(commonParams.validityWindow) : firstValid + defaultValidityWindow),
+		group: void 0
+	};
+};
+
+//#endregion
+export { buildTransactionCommonData, ensureString };
+//# sourceMappingURL=common.mjs.map