@algorandfoundation/algokit-utils 9.2.0 → 10.0.0-alpha.10

package/packages/transact/src/transactions/asset-config.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"asset-config.mjs","names":[],"sources":["../../../../../packages/transact/src/transactions/asset-config.ts"],"sourcesContent":["import {\n  MAX_ASSET_DECIMALS,\n  MAX_ASSET_NAME_LENGTH,\n  MAX_ASSET_UNIT_NAME_LENGTH,\n  MAX_ASSET_URL_LENGTH,\n  Address,\n} from '@algorandfoundation/algokit-common'\nimport { TransactionValidationError, TransactionValidationErrorType } from './common'\n\n/**\n * Represents an asset configuration transaction that creates, reconfigures, or destroys assets.\n */\nexport type AssetConfigTransactionFields = {\n  /**\n   * ID of the asset to operate on.\n   *\n   * For asset creation, this must be 0.\n   * For asset reconfiguration this is the ID of the existing asset to be reconfigured,\n   * For asset destroy this is the ID of the existing asset to be destroyed.\n   */\n  assetId: bigint\n\n  /**\n   * The total amount of the smallest divisible (decimal) unit to create.\n   *\n   * Required when creating a new asset.\n   * For example, if creating a asset with 2 decimals and wanting a total supply of 100 units, this value should be 10000.\n   *\n   * This field can only be specified upon asset creation.\n   */\n  total?: bigint\n\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   * * 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   *\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  /**\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  /**\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  /**\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  /**\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  /**\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?: Uint8Array\n\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 or set to the Zero address the asset becomes permanently immutable.\n   */\n  manager?: Address\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 or set to the Zero address the field is permanently empty.\n   */\n  reserve?: Address\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 or set to the Zero address the field is permanently empty.\n   */\n  freeze?: Address\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 or set to the Zero address the field is permanently empty.\n   */\n  clawback?: Address\n}\n\n/**\n * Validate asset configuration transaction fields\n */\nexport function validateAssetConfigTransaction(assetConfig: AssetConfigTransactionFields): TransactionValidationError[] {\n  const errors = new Array<TransactionValidationError>()\n\n  if (assetConfig.assetId === 0n) {\n    // Asset creation\n    errors.push(...validateAssetCreation(assetConfig))\n  } else {\n    // Asset configuration or destruction\n    errors.push(...validateAssetConfiguration(assetConfig))\n  }\n\n  return errors\n}\n\n/**\n * Validate asset creation fields\n */\nfunction validateAssetCreation(assetConfig: AssetConfigTransactionFields): TransactionValidationError[] {\n  const errors = new Array<TransactionValidationError>()\n\n  if (assetConfig.total === undefined) {\n    errors.push({\n      type: TransactionValidationErrorType.RequiredField,\n      data: 'Total',\n    })\n  }\n\n  if (assetConfig.decimals !== undefined && assetConfig.decimals > MAX_ASSET_DECIMALS) {\n    errors.push({\n      type: TransactionValidationErrorType.FieldTooLong,\n      data: {\n        field: 'Decimals',\n        actual: assetConfig.decimals,\n        max: MAX_ASSET_DECIMALS,\n        unit: 'decimal places',\n      },\n    })\n  }\n\n  if (assetConfig.unitName && assetConfig.unitName.length > MAX_ASSET_UNIT_NAME_LENGTH) {\n    errors.push({\n      type: TransactionValidationErrorType.FieldTooLong,\n      data: {\n        field: 'Unit name',\n        actual: assetConfig.unitName.length,\n        max: MAX_ASSET_UNIT_NAME_LENGTH,\n        unit: 'bytes',\n      },\n    })\n  }\n\n  if (assetConfig.assetName && assetConfig.assetName.length > MAX_ASSET_NAME_LENGTH) {\n    errors.push({\n      type: TransactionValidationErrorType.FieldTooLong,\n      data: {\n        field: 'Asset name',\n        actual: assetConfig.assetName.length,\n        max: MAX_ASSET_NAME_LENGTH,\n        unit: 'bytes',\n      },\n    })\n  }\n\n  if (assetConfig.url && assetConfig.url.length > MAX_ASSET_URL_LENGTH) {\n    errors.push({\n      type: TransactionValidationErrorType.FieldTooLong,\n      data: {\n        field: 'Url',\n        actual: assetConfig.url.length,\n        max: MAX_ASSET_URL_LENGTH,\n        unit: 'bytes',\n      },\n    })\n  }\n\n  return errors\n}\n\n/**\n * Validate asset configuration fields\n */\nfunction validateAssetConfiguration(assetConfig: AssetConfigTransactionFields): TransactionValidationError[] {\n  const errors = new Array<TransactionValidationError>()\n\n  const hasAssetParams =\n    assetConfig.total !== undefined ||\n    assetConfig.decimals !== undefined ||\n    assetConfig.defaultFrozen !== undefined ||\n    assetConfig.assetName !== undefined ||\n    assetConfig.unitName !== undefined ||\n    assetConfig.url !== undefined ||\n    assetConfig.metadataHash !== undefined ||\n    assetConfig.manager !== undefined ||\n    assetConfig.reserve !== undefined ||\n    assetConfig.freeze !== undefined ||\n    assetConfig.clawback !== undefined\n\n  if (hasAssetParams) {\n    // These fields are immutable after creation\n    if (assetConfig.total !== undefined) {\n      errors.push({\n        type: TransactionValidationErrorType.ImmutableField,\n        data: 'Total',\n      })\n    }\n    if (assetConfig.decimals !== undefined) {\n      errors.push({\n        type: TransactionValidationErrorType.ImmutableField,\n        data: 'Decimals',\n      })\n    }\n    if (assetConfig.defaultFrozen !== undefined) {\n      errors.push({\n        type: TransactionValidationErrorType.ImmutableField,\n        data: 'Default frozen',\n      })\n    }\n    if (assetConfig.assetName !== undefined) {\n      errors.push({\n        type: TransactionValidationErrorType.ImmutableField,\n        data: 'Asset name',\n      })\n    }\n    if (assetConfig.unitName !== undefined) {\n      errors.push({\n        type: TransactionValidationErrorType.ImmutableField,\n        data: 'Unit name',\n      })\n    }\n    if (assetConfig.url !== undefined) {\n      errors.push({\n        type: TransactionValidationErrorType.ImmutableField,\n        data: 'Url',\n      })\n    }\n    if (assetConfig.metadataHash !== undefined) {\n      errors.push({\n        type: TransactionValidationErrorType.ImmutableField,\n        data: 'Metadata hash',\n      })\n    }\n  }\n\n  return errors\n}\n"],"mappings":";;;;;;;AA+IA,SAAgB,+BAA+B,aAAyE;CACtH,MAAM,SAAS,IAAI,OAAmC;AAEtD,KAAI,YAAY,YAAY,GAE1B,QAAO,KAAK,GAAG,sBAAsB,YAAY,CAAC;KAGlD,QAAO,KAAK,GAAG,2BAA2B,YAAY,CAAC;AAGzD,QAAO;;;;;AAMT,SAAS,sBAAsB,aAAyE;CACtG,MAAM,SAAS,IAAI,OAAmC;AAEtD,KAAI,YAAY,UAAU,OACxB,QAAO,KAAK;EACV,MAAM,+BAA+B;EACrC,MAAM;EACP,CAAC;AAGJ,KAAI,YAAY,aAAa,UAAa,YAAY,WAAW,mBAC/D,QAAO,KAAK;EACV,MAAM,+BAA+B;EACrC,MAAM;GACJ,OAAO;GACP,QAAQ,YAAY;GACpB,KAAK;GACL,MAAM;GACP;EACF,CAAC;AAGJ,KAAI,YAAY,YAAY,YAAY,SAAS,SAAS,2BACxD,QAAO,KAAK;EACV,MAAM,+BAA+B;EACrC,MAAM;GACJ,OAAO;GACP,QAAQ,YAAY,SAAS;GAC7B,KAAK;GACL,MAAM;GACP;EACF,CAAC;AAGJ,KAAI,YAAY,aAAa,YAAY,UAAU,SAAS,sBAC1D,QAAO,KAAK;EACV,MAAM,+BAA+B;EACrC,MAAM;GACJ,OAAO;GACP,QAAQ,YAAY,UAAU;GAC9B,KAAK;GACL,MAAM;GACP;EACF,CAAC;AAGJ,KAAI,YAAY,OAAO,YAAY,IAAI,SAAS,qBAC9C,QAAO,KAAK;EACV,MAAM,+BAA+B;EACrC,MAAM;GACJ,OAAO;GACP,QAAQ,YAAY,IAAI;GACxB,KAAK;GACL,MAAM;GACP;EACF,CAAC;AAGJ,QAAO;;;;;AAMT,SAAS,2BAA2B,aAAyE;CAC3G,MAAM,SAAS,IAAI,OAAmC;AAetD,KAZE,YAAY,UAAU,UACtB,YAAY,aAAa,UACzB,YAAY,kBAAkB,UAC9B,YAAY,cAAc,UAC1B,YAAY,aAAa,UACzB,YAAY,QAAQ,UACpB,YAAY,iBAAiB,UAC7B,YAAY,YAAY,UACxB,YAAY,YAAY,UACxB,YAAY,WAAW,UACvB,YAAY,aAAa,QAEP;AAElB,MAAI,YAAY,UAAU,OACxB,QAAO,KAAK;GACV,MAAM,+BAA+B;GACrC,MAAM;GACP,CAAC;AAEJ,MAAI,YAAY,aAAa,OAC3B,QAAO,KAAK;GACV,MAAM,+BAA+B;GACrC,MAAM;GACP,CAAC;AAEJ,MAAI,YAAY,kBAAkB,OAChC,QAAO,KAAK;GACV,MAAM,+BAA+B;GACrC,MAAM;GACP,CAAC;AAEJ,MAAI,YAAY,cAAc,OAC5B,QAAO,KAAK;GACV,MAAM,+BAA+B;GACrC,MAAM;GACP,CAAC;AAEJ,MAAI,YAAY,aAAa,OAC3B,QAAO,KAAK;GACV,MAAM,+BAA+B;GACrC,MAAM;GACP,CAAC;AAEJ,MAAI,YAAY,QAAQ,OACtB,QAAO,KAAK;GACV,MAAM,+BAA+B;GACrC,MAAM;GACP,CAAC;AAEJ,MAAI,YAAY,iBAAiB,OAC/B,QAAO,KAAK;GACV,MAAM,+BAA+B;GACrC,MAAM;GACP,CAAC;;AAIN,QAAO"}

package/packages/transact/src/transactions/asset-freeze.d.ts

@@ -0,0 +1,35 @@
+import { Address } from "../../../common/src/address.js";
+import { TransactionValidationError } from "./common.js";
+
+//#region packages/transact/src/transactions/asset-freeze.d.ts
+
+/**
+ * Represents an asset freeze transaction that freezes or unfreezes asset holdings.
+ *
+ * Asset freeze transactions are used by the asset freeze account to control
+ * whether a specific account can transfer a particular asset.
+ */
+type AssetFreezeTransactionFields = {
+  /**
+   * The ID of the asset being frozen/unfrozen.
+   */
+  assetId: bigint;
+  /**
+   * The target account whose asset holdings will be affected.
+   */
+  freezeTarget: Address;
+  /**
+   * The new freeze status.
+   *
+   * `true` to freeze the asset holdings (prevent transfers),
+   * `false` to unfreeze the asset holdings (allow transfers).
+   */
+  frozen: boolean;
+};
+/**
+ * Validate asset freeze transaction fields
+ */
+declare function validateAssetFreezeTransaction(assetFreeze: AssetFreezeTransactionFields): TransactionValidationError[];
+//#endregion
+export { AssetFreezeTransactionFields, validateAssetFreezeTransaction };
+//# sourceMappingURL=asset-freeze.d.ts.map

package/packages/transact/src/transactions/asset-freeze.js

@@ -0,0 +1,18 @@
+const require_common = require('./common.js');
+
+//#region packages/transact/src/transactions/asset-freeze.ts
+/**
+* Validate asset freeze transaction fields
+*/
+function validateAssetFreezeTransaction(assetFreeze) {
+	const errors = new Array();
+	if (assetFreeze.assetId === 0n) errors.push({
+		type: require_common.TransactionValidationErrorType.ZeroValueField,
+		data: "Asset ID"
+	});
+	return errors;
+}
+
+//#endregion
+exports.validateAssetFreezeTransaction = validateAssetFreezeTransaction;
+//# sourceMappingURL=asset-freeze.js.map

package/packages/transact/src/transactions/asset-freeze.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"asset-freeze.js","names":["TransactionValidationErrorType"],"sources":["../../../../../packages/transact/src/transactions/asset-freeze.ts"],"sourcesContent":["import { Address } from '@algorandfoundation/algokit-common'\nimport { TransactionValidationError, TransactionValidationErrorType } from './common'\n\n/**\n * Represents an asset freeze transaction that freezes or unfreezes asset holdings.\n *\n * Asset freeze transactions are used by the asset freeze account to control\n * whether a specific account can transfer a particular asset.\n */\nexport type AssetFreezeTransactionFields = {\n  /**\n   * The ID of the asset being frozen/unfrozen.\n   */\n  assetId: bigint\n\n  /**\n   * The target account whose asset holdings will be affected.\n   */\n  freezeTarget: Address\n\n  /**\n   * The new freeze status.\n   *\n   * `true` to freeze the asset holdings (prevent transfers),\n   * `false` to unfreeze the asset holdings (allow transfers).\n   */\n  frozen: boolean\n}\n\n/**\n * Validate asset freeze transaction fields\n */\nexport function validateAssetFreezeTransaction(assetFreeze: AssetFreezeTransactionFields): TransactionValidationError[] {\n  const errors = new Array<TransactionValidationError>()\n\n  if (assetFreeze.assetId === 0n) {\n    errors.push({\n      type: TransactionValidationErrorType.ZeroValueField,\n      data: 'Asset ID',\n    })\n  }\n\n  return errors\n}\n"],"mappings":";;;;;;AAgCA,SAAgB,+BAA+B,aAAyE;CACtH,MAAM,SAAS,IAAI,OAAmC;AAEtD,KAAI,YAAY,YAAY,GAC1B,QAAO,KAAK;EACV,MAAMA,8CAA+B;EACrC,MAAM;EACP,CAAC;AAGJ,QAAO"}

package/packages/transact/src/transactions/asset-freeze.mjs

@@ -0,0 +1,18 @@
+import { TransactionValidationErrorType } from "./common.mjs";
+
+//#region packages/transact/src/transactions/asset-freeze.ts
+/**
+* Validate asset freeze transaction fields
+*/
+function validateAssetFreezeTransaction(assetFreeze) {
+	const errors = new Array();
+	if (assetFreeze.assetId === 0n) errors.push({
+		type: TransactionValidationErrorType.ZeroValueField,
+		data: "Asset ID"
+	});
+	return errors;
+}
+
+//#endregion
+export { validateAssetFreezeTransaction };
+//# sourceMappingURL=asset-freeze.mjs.map

package/packages/transact/src/transactions/asset-freeze.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"asset-freeze.mjs","names":[],"sources":["../../../../../packages/transact/src/transactions/asset-freeze.ts"],"sourcesContent":["import { Address } from '@algorandfoundation/algokit-common'\nimport { TransactionValidationError, TransactionValidationErrorType } from './common'\n\n/**\n * Represents an asset freeze transaction that freezes or unfreezes asset holdings.\n *\n * Asset freeze transactions are used by the asset freeze account to control\n * whether a specific account can transfer a particular asset.\n */\nexport type AssetFreezeTransactionFields = {\n  /**\n   * The ID of the asset being frozen/unfrozen.\n   */\n  assetId: bigint\n\n  /**\n   * The target account whose asset holdings will be affected.\n   */\n  freezeTarget: Address\n\n  /**\n   * The new freeze status.\n   *\n   * `true` to freeze the asset holdings (prevent transfers),\n   * `false` to unfreeze the asset holdings (allow transfers).\n   */\n  frozen: boolean\n}\n\n/**\n * Validate asset freeze transaction fields\n */\nexport function validateAssetFreezeTransaction(assetFreeze: AssetFreezeTransactionFields): TransactionValidationError[] {\n  const errors = new Array<TransactionValidationError>()\n\n  if (assetFreeze.assetId === 0n) {\n    errors.push({\n      type: TransactionValidationErrorType.ZeroValueField,\n      data: 'Asset ID',\n    })\n  }\n\n  return errors\n}\n"],"mappings":";;;;;;AAgCA,SAAgB,+BAA+B,aAAyE;CACtH,MAAM,SAAS,IAAI,OAAmC;AAEtD,KAAI,YAAY,YAAY,GAC1B,QAAO,KAAK;EACV,MAAM,+BAA+B;EACrC,MAAM;EACP,CAAC;AAGJ,QAAO"}

package/packages/transact/src/transactions/asset-transfer.d.ts

@@ -0,0 +1,56 @@
+import { Address } from "../../../common/src/address.js";
+import { TransactionValidationError } from "./common.js";
+
+//#region packages/transact/src/transactions/asset-transfer.d.ts
+
+/**
+ * Represents an asset transfer transaction that moves ASAs between accounts.
+ *
+ * Asset transfer transactions are used to transfer Algorand Standard Assets (ASAs)
+ * from one account to another.
+ */
+type AssetTransferTransactionFields = {
+  /**
+   * The ID of the asset being transferred.
+   */
+  assetId: bigint;
+  /**
+   * The amount of the asset to transfer.
+   *
+   * An integer value representing the number of units (to their smallest denomination) of
+   * the asset that are being transferred.
+   * In other words, the asset decimals don't play a role in this value.
+   * It should be up to the caller (or a higher abstraction) to handle the conversion based on
+   * the asset decimals.
+   */
+  amount: bigint;
+  /**
+   * The address of the account that will receive the asset.
+   *
+   * The receiver must have opted-in to the asset before they can receive it.
+   */
+  receiver: Address;
+  /**
+   * Optional address of the account that actually holds the asset being transferred.
+   *
+   * If provided, this indicates that the transaction is a clawback operation,
+   * where the sender is the asset clawback address and is forcibly moving assets
+   * from this account to the receiver.
+   */
+  assetSender?: Address;
+  /**
+   * Optional address to send all remaining asset units to after the transfer.
+   *
+   * If specified, this indicates that the sender is closing out their position in the asset,
+   * and all remaining units of this asset owned by the sender will be transferred to this address.
+   * This effectively removes the asset from the sender's account.
+   */
+  closeRemainderTo?: Address;
+};
+/**
+ * Validate asset transfer transaction fields
+ */
+declare function validateAssetTransferTransaction(assetTransfer: AssetTransferTransactionFields): TransactionValidationError[];
+//#endregion
+export { AssetTransferTransactionFields, validateAssetTransferTransaction };
+//# sourceMappingURL=asset-transfer.d.ts.map

package/packages/transact/src/transactions/asset-transfer.js

@@ -0,0 +1,18 @@
+const require_common = require('./common.js');
+
+//#region packages/transact/src/transactions/asset-transfer.ts
+/**
+* Validate asset transfer transaction fields
+*/
+function validateAssetTransferTransaction(assetTransfer) {
+	const errors = new Array();
+	if (assetTransfer.assetId === 0n) errors.push({
+		type: require_common.TransactionValidationErrorType.ZeroValueField,
+		data: "Asset ID"
+	});
+	return errors;
+}
+
+//#endregion
+exports.validateAssetTransferTransaction = validateAssetTransferTransaction;
+//# sourceMappingURL=asset-transfer.js.map

package/packages/transact/src/transactions/asset-transfer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"asset-transfer.js","names":["TransactionValidationErrorType"],"sources":["../../../../../packages/transact/src/transactions/asset-transfer.ts"],"sourcesContent":["import { Address } from '@algorandfoundation/algokit-common'\nimport { TransactionValidationError, TransactionValidationErrorType } from './common'\n\n/**\n * Represents an asset transfer transaction that moves ASAs between accounts.\n *\n * Asset transfer transactions are used to transfer Algorand Standard Assets (ASAs)\n * from one account to another.\n */\nexport type AssetTransferTransactionFields = {\n  /**\n   * The ID of the asset being transferred.\n   */\n  assetId: bigint\n\n  /**\n   * The amount of the asset to transfer.\n   *\n   * An integer value representing the number of units (to their smallest denomination) of\n   * the asset that are being transferred.\n   * In other words, the asset decimals don't play a role in this value.\n   * It should be up to the caller (or a higher abstraction) to handle the conversion based on\n   * the asset decimals.\n   */\n  amount: bigint\n\n  /**\n   * The address of the account that will receive the asset.\n   *\n   * The receiver must have opted-in to the asset before they can receive it.\n   */\n  receiver: Address\n\n  /**\n   * Optional address of the account that actually holds the asset being transferred.\n   *\n   * If provided, this indicates that the transaction is a clawback operation,\n   * where the sender is the asset clawback address and is forcibly moving assets\n   * from this account to the receiver.\n   */\n  assetSender?: Address\n\n  /**\n   * Optional address to send all remaining asset units to after the transfer.\n   *\n   * If specified, this indicates that the sender is closing out their position in the asset,\n   * and all remaining units of this asset owned by the sender will be transferred to this address.\n   * This effectively removes the asset from the sender's account.\n   */\n  closeRemainderTo?: Address\n}\n\n/**\n * Validate asset transfer transaction fields\n */\nexport function validateAssetTransferTransaction(assetTransfer: AssetTransferTransactionFields): TransactionValidationError[] {\n  const errors = new Array<TransactionValidationError>()\n\n  if (assetTransfer.assetId === 0n) {\n    errors.push({\n      type: TransactionValidationErrorType.ZeroValueField,\n      data: 'Asset ID',\n    })\n  }\n\n  return errors\n}\n"],"mappings":";;;;;;AAuDA,SAAgB,iCAAiC,eAA6E;CAC5H,MAAM,SAAS,IAAI,OAAmC;AAEtD,KAAI,cAAc,YAAY,GAC5B,QAAO,KAAK;EACV,MAAMA,8CAA+B;EACrC,MAAM;EACP,CAAC;AAGJ,QAAO"}

package/packages/transact/src/transactions/asset-transfer.mjs

@@ -0,0 +1,18 @@
+import { TransactionValidationErrorType } from "./common.mjs";
+
+//#region packages/transact/src/transactions/asset-transfer.ts
+/**
+* Validate asset transfer transaction fields
+*/
+function validateAssetTransferTransaction(assetTransfer) {
+	const errors = new Array();
+	if (assetTransfer.assetId === 0n) errors.push({
+		type: TransactionValidationErrorType.ZeroValueField,
+		data: "Asset ID"
+	});
+	return errors;
+}
+
+//#endregion
+export { validateAssetTransferTransaction };
+//# sourceMappingURL=asset-transfer.mjs.map

package/packages/transact/src/transactions/asset-transfer.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"asset-transfer.mjs","names":[],"sources":["../../../../../packages/transact/src/transactions/asset-transfer.ts"],"sourcesContent":["import { Address } from '@algorandfoundation/algokit-common'\nimport { TransactionValidationError, TransactionValidationErrorType } from './common'\n\n/**\n * Represents an asset transfer transaction that moves ASAs between accounts.\n *\n * Asset transfer transactions are used to transfer Algorand Standard Assets (ASAs)\n * from one account to another.\n */\nexport type AssetTransferTransactionFields = {\n  /**\n   * The ID of the asset being transferred.\n   */\n  assetId: bigint\n\n  /**\n   * The amount of the asset to transfer.\n   *\n   * An integer value representing the number of units (to their smallest denomination) of\n   * the asset that are being transferred.\n   * In other words, the asset decimals don't play a role in this value.\n   * It should be up to the caller (or a higher abstraction) to handle the conversion based on\n   * the asset decimals.\n   */\n  amount: bigint\n\n  /**\n   * The address of the account that will receive the asset.\n   *\n   * The receiver must have opted-in to the asset before they can receive it.\n   */\n  receiver: Address\n\n  /**\n   * Optional address of the account that actually holds the asset being transferred.\n   *\n   * If provided, this indicates that the transaction is a clawback operation,\n   * where the sender is the asset clawback address and is forcibly moving assets\n   * from this account to the receiver.\n   */\n  assetSender?: Address\n\n  /**\n   * Optional address to send all remaining asset units to after the transfer.\n   *\n   * If specified, this indicates that the sender is closing out their position in the asset,\n   * and all remaining units of this asset owned by the sender will be transferred to this address.\n   * This effectively removes the asset from the sender's account.\n   */\n  closeRemainderTo?: Address\n}\n\n/**\n * Validate asset transfer transaction fields\n */\nexport function validateAssetTransferTransaction(assetTransfer: AssetTransferTransactionFields): TransactionValidationError[] {\n  const errors = new Array<TransactionValidationError>()\n\n  if (assetTransfer.assetId === 0n) {\n    errors.push({\n      type: TransactionValidationErrorType.ZeroValueField,\n      data: 'Asset ID',\n    })\n  }\n\n  return errors\n}\n"],"mappings":";;;;;;AAuDA,SAAgB,iCAAiC,eAA6E;CAC5H,MAAM,SAAS,IAAI,OAAmC;AAEtD,KAAI,cAAc,YAAY,GAC5B,QAAO,KAAK;EACV,MAAM,+BAA+B;EACrC,MAAM;EACP,CAAC;AAGJ,QAAO"}

package/packages/transact/src/transactions/common.d.ts

@@ -0,0 +1,37 @@
+//#region packages/transact/src/transactions/common.d.ts
+declare enum TransactionValidationErrorType {
+  RequiredField = 0,
+  FieldTooLong = 1,
+  ImmutableField = 2,
+  ZeroValueField = 3,
+  ArbitraryConstraint = 4,
+}
+type TransactionValidationError = RequiredFieldValidationError | FieldTooLongValidationError | ImmutableFieldValidationError | ZeroValueFieldValidationError | ArbitraryConstraintValidationError;
+type RequiredFieldValidationError = {
+  type: TransactionValidationErrorType.RequiredField;
+  data: string;
+};
+type FieldTooLongValidationError = {
+  type: TransactionValidationErrorType.FieldTooLong;
+  data: {
+    field: string;
+    actual: number;
+    max: number;
+    unit: string;
+  };
+};
+type ImmutableFieldValidationError = {
+  type: TransactionValidationErrorType.ImmutableField;
+  data: string;
+};
+type ZeroValueFieldValidationError = {
+  type: TransactionValidationErrorType.ZeroValueField;
+  data: string;
+};
+type ArbitraryConstraintValidationError = {
+  type: TransactionValidationErrorType.ArbitraryConstraint;
+  data: string;
+};
+//#endregion
+export { TransactionValidationError };
+//# sourceMappingURL=common.d.ts.map

package/packages/transact/src/transactions/common.js

@@ -0,0 +1,24 @@
+
+//#region packages/transact/src/transactions/common.ts
+let TransactionValidationErrorType = /* @__PURE__ */ function(TransactionValidationErrorType$1) {
+	TransactionValidationErrorType$1[TransactionValidationErrorType$1["RequiredField"] = 0] = "RequiredField";
+	TransactionValidationErrorType$1[TransactionValidationErrorType$1["FieldTooLong"] = 1] = "FieldTooLong";
+	TransactionValidationErrorType$1[TransactionValidationErrorType$1["ImmutableField"] = 2] = "ImmutableField";
+	TransactionValidationErrorType$1[TransactionValidationErrorType$1["ZeroValueField"] = 3] = "ZeroValueField";
+	TransactionValidationErrorType$1[TransactionValidationErrorType$1["ArbitraryConstraint"] = 4] = "ArbitraryConstraint";
+	return TransactionValidationErrorType$1;
+}({});
+function getValidationErrorMessage(validationError) {
+	switch (validationError.type) {
+		case TransactionValidationErrorType.RequiredField: return `${validationError.data} is required`;
+		case TransactionValidationErrorType.FieldTooLong: return `${validationError.data.field} cannot exceed ${validationError.data.max} ${validationError.data.unit}, got ${validationError.data.actual}`;
+		case TransactionValidationErrorType.ImmutableField: return `${validationError.data} is immutable and cannot be changed`;
+		case TransactionValidationErrorType.ZeroValueField: return `${validationError.data} must not be 0`;
+		case TransactionValidationErrorType.ArbitraryConstraint: return validationError.data;
+	}
+}
+
+//#endregion
+exports.TransactionValidationErrorType = TransactionValidationErrorType;
+exports.getValidationErrorMessage = getValidationErrorMessage;
+//# sourceMappingURL=common.js.map

package/packages/transact/src/transactions/common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.js","names":[],"sources":["../../../../../packages/transact/src/transactions/common.ts"],"sourcesContent":["export enum TransactionValidationErrorType {\n  RequiredField,\n  FieldTooLong,\n  ImmutableField,\n  ZeroValueField,\n  ArbitraryConstraint,\n}\n\nexport type TransactionValidationError =\n  | RequiredFieldValidationError\n  | FieldTooLongValidationError\n  | ImmutableFieldValidationError\n  | ZeroValueFieldValidationError\n  | ArbitraryConstraintValidationError\n\ntype RequiredFieldValidationError = {\n  type: TransactionValidationErrorType.RequiredField\n  data: string\n}\n\ntype FieldTooLongValidationError = {\n  type: TransactionValidationErrorType.FieldTooLong\n  data: {\n    field: string\n    actual: number\n    max: number\n    unit: string\n  }\n}\n\ntype ImmutableFieldValidationError = {\n  type: TransactionValidationErrorType.ImmutableField\n  data: string\n}\n\ntype ZeroValueFieldValidationError = {\n  type: TransactionValidationErrorType.ZeroValueField\n  data: string\n}\n\ntype ArbitraryConstraintValidationError = {\n  type: TransactionValidationErrorType.ArbitraryConstraint\n  data: string\n}\n\nexport function getValidationErrorMessage(validationError: TransactionValidationError): string {\n  switch (validationError.type) {\n    case TransactionValidationErrorType.RequiredField:\n      return `${validationError.data} is required`\n    case TransactionValidationErrorType.FieldTooLong:\n      return `${validationError.data.field} cannot exceed ${validationError.data.max} ${validationError.data.unit}, got ${validationError.data.actual}`\n    case TransactionValidationErrorType.ImmutableField:\n      return `${validationError.data} is immutable and cannot be changed`\n    case TransactionValidationErrorType.ZeroValueField:\n      return `${validationError.data} must not be 0`\n    case TransactionValidationErrorType.ArbitraryConstraint:\n      return validationError.data\n  }\n}\n"],"mappings":";;AAAA,IAAY,4FAAL;AACL;AACA;AACA;AACA;AACA;;;AAwCF,SAAgB,0BAA0B,iBAAqD;AAC7F,SAAQ,gBAAgB,MAAxB;EACE,KAAK,+BAA+B,cAClC,QAAO,GAAG,gBAAgB,KAAK;EACjC,KAAK,+BAA+B,aAClC,QAAO,GAAG,gBAAgB,KAAK,MAAM,iBAAiB,gBAAgB,KAAK,IAAI,GAAG,gBAAgB,KAAK,KAAK,QAAQ,gBAAgB,KAAK;EAC3I,KAAK,+BAA+B,eAClC,QAAO,GAAG,gBAAgB,KAAK;EACjC,KAAK,+BAA+B,eAClC,QAAO,GAAG,gBAAgB,KAAK;EACjC,KAAK,+BAA+B,oBAClC,QAAO,gBAAgB"}

package/packages/transact/src/transactions/common.mjs

@@ -0,0 +1,22 @@
+//#region packages/transact/src/transactions/common.ts
+let TransactionValidationErrorType = /* @__PURE__ */ function(TransactionValidationErrorType$1) {
+	TransactionValidationErrorType$1[TransactionValidationErrorType$1["RequiredField"] = 0] = "RequiredField";
+	TransactionValidationErrorType$1[TransactionValidationErrorType$1["FieldTooLong"] = 1] = "FieldTooLong";
+	TransactionValidationErrorType$1[TransactionValidationErrorType$1["ImmutableField"] = 2] = "ImmutableField";
+	TransactionValidationErrorType$1[TransactionValidationErrorType$1["ZeroValueField"] = 3] = "ZeroValueField";
+	TransactionValidationErrorType$1[TransactionValidationErrorType$1["ArbitraryConstraint"] = 4] = "ArbitraryConstraint";
+	return TransactionValidationErrorType$1;
+}({});
+function getValidationErrorMessage(validationError) {
+	switch (validationError.type) {
+		case TransactionValidationErrorType.RequiredField: return `${validationError.data} is required`;
+		case TransactionValidationErrorType.FieldTooLong: return `${validationError.data.field} cannot exceed ${validationError.data.max} ${validationError.data.unit}, got ${validationError.data.actual}`;
+		case TransactionValidationErrorType.ImmutableField: return `${validationError.data} is immutable and cannot be changed`;
+		case TransactionValidationErrorType.ZeroValueField: return `${validationError.data} must not be 0`;
+		case TransactionValidationErrorType.ArbitraryConstraint: return validationError.data;
+	}
+}
+
+//#endregion
+export { TransactionValidationErrorType, getValidationErrorMessage };
+//# sourceMappingURL=common.mjs.map

package/packages/transact/src/transactions/common.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.mjs","names":[],"sources":["../../../../../packages/transact/src/transactions/common.ts"],"sourcesContent":["export enum TransactionValidationErrorType {\n  RequiredField,\n  FieldTooLong,\n  ImmutableField,\n  ZeroValueField,\n  ArbitraryConstraint,\n}\n\nexport type TransactionValidationError =\n  | RequiredFieldValidationError\n  | FieldTooLongValidationError\n  | ImmutableFieldValidationError\n  | ZeroValueFieldValidationError\n  | ArbitraryConstraintValidationError\n\ntype RequiredFieldValidationError = {\n  type: TransactionValidationErrorType.RequiredField\n  data: string\n}\n\ntype FieldTooLongValidationError = {\n  type: TransactionValidationErrorType.FieldTooLong\n  data: {\n    field: string\n    actual: number\n    max: number\n    unit: string\n  }\n}\n\ntype ImmutableFieldValidationError = {\n  type: TransactionValidationErrorType.ImmutableField\n  data: string\n}\n\ntype ZeroValueFieldValidationError = {\n  type: TransactionValidationErrorType.ZeroValueField\n  data: string\n}\n\ntype ArbitraryConstraintValidationError = {\n  type: TransactionValidationErrorType.ArbitraryConstraint\n  data: string\n}\n\nexport function getValidationErrorMessage(validationError: TransactionValidationError): string {\n  switch (validationError.type) {\n    case TransactionValidationErrorType.RequiredField:\n      return `${validationError.data} is required`\n    case TransactionValidationErrorType.FieldTooLong:\n      return `${validationError.data.field} cannot exceed ${validationError.data.max} ${validationError.data.unit}, got ${validationError.data.actual}`\n    case TransactionValidationErrorType.ImmutableField:\n      return `${validationError.data} is immutable and cannot be changed`\n    case TransactionValidationErrorType.ZeroValueField:\n      return `${validationError.data} must not be 0`\n    case TransactionValidationErrorType.ArbitraryConstraint:\n      return validationError.data\n  }\n}\n"],"mappings":";AAAA,IAAY,4FAAL;AACL;AACA;AACA;AACA;AACA;;;AAwCF,SAAgB,0BAA0B,iBAAqD;AAC7F,SAAQ,gBAAgB,MAAxB;EACE,KAAK,+BAA+B,cAClC,QAAO,GAAG,gBAAgB,KAAK;EACjC,KAAK,+BAA+B,aAClC,QAAO,GAAG,gBAAgB,KAAK,MAAM,iBAAiB,gBAAgB,KAAK,IAAI,GAAG,gBAAgB,KAAK,KAAK,QAAQ,gBAAgB,KAAK;EAC3I,KAAK,+BAA+B,eAClC,QAAO,GAAG,gBAAgB,KAAK;EACjC,KAAK,+BAA+B,eAClC,QAAO,GAAG,gBAAgB,KAAK;EACjC,KAAK,+BAA+B,oBAClC,QAAO,gBAAgB"}

package/packages/transact/src/transactions/heartbeat.d.ts

@@ -0,0 +1,37 @@
+import { Address } from "../../../common/src/address.js";
+
+//#region packages/transact/src/transactions/heartbeat.d.ts
+
+/**
+ * Heartbeat transaction specific fields
+ */
+type HeartbeatTransactionFields = {
+  /** Heartbeat address */
+  address: Address;
+  /** Heartbeat proof */
+  proof: HeartbeatProof;
+  /** Heartbeat seed */
+  seed: Uint8Array;
+  /** Heartbeat vote ID */
+  voteId: Uint8Array;
+  /** Heartbeat key dilution */
+  keyDilution: bigint;
+};
+/**
+ * Heartbeat proof structure
+ */
+type HeartbeatProof = {
+  /** Signature (64 bytes) */
+  sig: Uint8Array;
+  /** Public key (32 bytes) */
+  pk: Uint8Array;
+  /** Public key 2 (32 bytes) */
+  pk2: Uint8Array;
+  /** Public key 1 signature (64 bytes) */
+  pk1Sig: Uint8Array;
+  /** Public key 2 signature (64 bytes) */
+  pk2Sig: Uint8Array;
+};
+//#endregion
+export { HeartbeatProof, HeartbeatTransactionFields };
+//# sourceMappingURL=heartbeat.d.ts.map

package/packages/transact/src/transactions/key-registration.d.ts

@@ -0,0 +1,45 @@
+import { TransactionValidationError } from "./common.js";
+
+//#region packages/transact/src/transactions/key-registration.d.ts
+
+/**
+ * Represents a key registration transaction that registers an account online or offline
+ * for participation in Algorand consensus.
+ */
+type KeyRegistrationTransactionFields = {
+  /**
+   * Root participation public key (32 bytes).
+   */
+  voteKey?: Uint8Array;
+  /**
+   * VRF public key (32 bytes).
+   */
+  selectionKey?: Uint8Array;
+  /**
+   * State proof key (64 bytes).
+   */
+  stateProofKey?: Uint8Array;
+  /**
+   * First round for which the participation key is valid.
+   */
+  voteFirst?: bigint;
+  /**
+   * Last round for which the participation key is valid.
+   */
+  voteLast?: bigint;
+  /**
+   * Key dilution for the 2-level participation key.
+   */
+  voteKeyDilution?: bigint;
+  /**
+   * Mark account as non-reward earning.
+   */
+  nonParticipation?: boolean;
+};
+/**
+ * Validate key registration transaction fields
+ */
+declare function validateKeyRegistrationTransaction(keyReg: KeyRegistrationTransactionFields): TransactionValidationError[];
+//#endregion
+export { KeyRegistrationTransactionFields, validateKeyRegistrationTransaction };
+//# sourceMappingURL=key-registration.d.ts.map

package/packages/transact/src/transactions/key-registration.js

@@ -0,0 +1,54 @@
+const require_common = require('./common.js');
+
+//#region packages/transact/src/transactions/key-registration.ts
+/**
+* Validate key registration transaction fields
+*/
+function validateKeyRegistrationTransaction(keyReg) {
+	const errors = new Array();
+	if (keyReg.voteKey !== void 0 || keyReg.selectionKey !== void 0 || keyReg.stateProofKey !== void 0 || keyReg.voteFirst !== void 0 || keyReg.voteLast !== void 0 || keyReg.voteKeyDilution !== void 0) errors.push(...validateOnlineKeyRegistration(keyReg));
+	return errors;
+}
+/**
+* Validate online key registration fields
+*/
+function validateOnlineKeyRegistration(keyReg) {
+	const errors = new Array();
+	if (!keyReg.voteKey) errors.push({
+		type: require_common.TransactionValidationErrorType.RequiredField,
+		data: "Vote key"
+	});
+	if (!keyReg.selectionKey) errors.push({
+		type: require_common.TransactionValidationErrorType.RequiredField,
+		data: "Selection key"
+	});
+	if (!keyReg.stateProofKey) errors.push({
+		type: require_common.TransactionValidationErrorType.RequiredField,
+		data: "State proof key"
+	});
+	if (keyReg.voteFirst === void 0) errors.push({
+		type: require_common.TransactionValidationErrorType.RequiredField,
+		data: "Vote first"
+	});
+	if (keyReg.voteLast === void 0) errors.push({
+		type: require_common.TransactionValidationErrorType.RequiredField,
+		data: "Vote last"
+	});
+	if (keyReg.voteFirst !== void 0 && keyReg.voteLast !== void 0 && keyReg.voteFirst >= keyReg.voteLast) errors.push({
+		type: require_common.TransactionValidationErrorType.ArbitraryConstraint,
+		data: "Vote first must be less than vote last"
+	});
+	if (keyReg.voteKeyDilution === void 0) errors.push({
+		type: require_common.TransactionValidationErrorType.RequiredField,
+		data: "Vote key dilution"
+	});
+	if (keyReg.nonParticipation === true) errors.push({
+		type: require_common.TransactionValidationErrorType.ArbitraryConstraint,
+		data: "Online key registration cannot have non participation flag set"
+	});
+	return errors;
+}
+
+//#endregion
+exports.validateKeyRegistrationTransaction = validateKeyRegistrationTransaction;
+//# sourceMappingURL=key-registration.js.map

package/packages/transact/src/transactions/key-registration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"key-registration.js","names":["TransactionValidationErrorType"],"sources":["../../../../../packages/transact/src/transactions/key-registration.ts"],"sourcesContent":["import { TransactionValidationError, TransactionValidationErrorType } from './common'\n\n/**\n * Represents a key registration transaction that registers an account online or offline\n * for participation in Algorand consensus.\n */\nexport type KeyRegistrationTransactionFields = {\n  /**\n   * Root participation public key (32 bytes).\n   */\n  voteKey?: Uint8Array\n\n  /**\n   * VRF public key (32 bytes).\n   */\n  selectionKey?: Uint8Array\n\n  /**\n   * State proof key (64 bytes).\n   */\n  stateProofKey?: Uint8Array\n\n  /**\n   * First round for which the participation key is valid.\n   */\n  voteFirst?: bigint\n\n  /**\n   * Last round for which the participation key is valid.\n   */\n  voteLast?: bigint\n\n  /**\n   * Key dilution for the 2-level participation key.\n   */\n  voteKeyDilution?: bigint\n\n  /**\n   * Mark account as non-reward earning.\n   */\n  nonParticipation?: boolean\n}\n\n/**\n * Validate key registration transaction fields\n */\nexport function validateKeyRegistrationTransaction(keyReg: KeyRegistrationTransactionFields): TransactionValidationError[] {\n  const errors = new Array<TransactionValidationError>()\n\n  const hasAnyParticipationFields =\n    keyReg.voteKey !== undefined ||\n    keyReg.selectionKey !== undefined ||\n    keyReg.stateProofKey !== undefined ||\n    keyReg.voteFirst !== undefined ||\n    keyReg.voteLast !== undefined ||\n    keyReg.voteKeyDilution !== undefined\n\n  if (hasAnyParticipationFields) {\n    // Online key registration\n    errors.push(...validateOnlineKeyRegistration(keyReg))\n  }\n  // Offline key registration has no specific validation requirements\n  return errors\n}\n\n/**\n * Validate online key registration fields\n */\nfunction validateOnlineKeyRegistration(keyReg: KeyRegistrationTransactionFields): TransactionValidationError[] {\n  const errors = new Array<TransactionValidationError>()\n\n  if (!keyReg.voteKey) {\n    errors.push({\n      type: TransactionValidationErrorType.RequiredField,\n      data: 'Vote key',\n    })\n  }\n  if (!keyReg.selectionKey) {\n    errors.push({\n      type: TransactionValidationErrorType.RequiredField,\n      data: 'Selection key',\n    })\n  }\n  if (!keyReg.stateProofKey) {\n    errors.push({\n      type: TransactionValidationErrorType.RequiredField,\n      data: 'State proof key',\n    })\n  }\n  if (keyReg.voteFirst === undefined) {\n    errors.push({\n      type: TransactionValidationErrorType.RequiredField,\n      data: 'Vote first',\n    })\n  }\n  if (keyReg.voteLast === undefined) {\n    errors.push({\n      type: TransactionValidationErrorType.RequiredField,\n      data: 'Vote last',\n    })\n  }\n  if (keyReg.voteFirst !== undefined && keyReg.voteLast !== undefined && keyReg.voteFirst >= keyReg.voteLast) {\n    errors.push({\n      type: TransactionValidationErrorType.ArbitraryConstraint,\n      data: 'Vote first must be less than vote last',\n    })\n  }\n  if (keyReg.voteKeyDilution === undefined) {\n    errors.push({\n      type: TransactionValidationErrorType.RequiredField,\n      data: 'Vote key dilution',\n    })\n  }\n  if (keyReg.nonParticipation === true) {\n    errors.push({\n      type: TransactionValidationErrorType.ArbitraryConstraint,\n      data: 'Online key registration cannot have non participation flag set',\n    })\n  }\n\n  return errors\n}\n"],"mappings":";;;;;;AA8CA,SAAgB,mCAAmC,QAAwE;CACzH,MAAM,SAAS,IAAI,OAAmC;AAUtD,KAPE,OAAO,YAAY,UACnB,OAAO,iBAAiB,UACxB,OAAO,kBAAkB,UACzB,OAAO,cAAc,UACrB,OAAO,aAAa,UACpB,OAAO,oBAAoB,OAI3B,QAAO,KAAK,GAAG,8BAA8B,OAAO,CAAC;AAGvD,QAAO;;;;;AAMT,SAAS,8BAA8B,QAAwE;CAC7G,MAAM,SAAS,IAAI,OAAmC;AAEtD,KAAI,CAAC,OAAO,QACV,QAAO,KAAK;EACV,MAAMA,8CAA+B;EACrC,MAAM;EACP,CAAC;AAEJ,KAAI,CAAC,OAAO,aACV,QAAO,KAAK;EACV,MAAMA,8CAA+B;EACrC,MAAM;EACP,CAAC;AAEJ,KAAI,CAAC,OAAO,cACV,QAAO,KAAK;EACV,MAAMA,8CAA+B;EACrC,MAAM;EACP,CAAC;AAEJ,KAAI,OAAO,cAAc,OACvB,QAAO,KAAK;EACV,MAAMA,8CAA+B;EACrC,MAAM;EACP,CAAC;AAEJ,KAAI,OAAO,aAAa,OACtB,QAAO,KAAK;EACV,MAAMA,8CAA+B;EACrC,MAAM;EACP,CAAC;AAEJ,KAAI,OAAO,cAAc,UAAa,OAAO,aAAa,UAAa,OAAO,aAAa,OAAO,SAChG,QAAO,KAAK;EACV,MAAMA,8CAA+B;EACrC,MAAM;EACP,CAAC;AAEJ,KAAI,OAAO,oBAAoB,OAC7B,QAAO,KAAK;EACV,MAAMA,8CAA+B;EACrC,MAAM;EACP,CAAC;AAEJ,KAAI,OAAO,qBAAqB,KAC9B,QAAO,KAAK;EACV,MAAMA,8CAA+B;EACrC,MAAM;EACP,CAAC;AAGJ,QAAO"}

package/packages/transact/src/transactions/key-registration.mjs

@@ -0,0 +1,54 @@
+import { TransactionValidationErrorType } from "./common.mjs";
+
+//#region packages/transact/src/transactions/key-registration.ts
+/**
+* Validate key registration transaction fields
+*/
+function validateKeyRegistrationTransaction(keyReg) {
+	const errors = new Array();
+	if (keyReg.voteKey !== void 0 || keyReg.selectionKey !== void 0 || keyReg.stateProofKey !== void 0 || keyReg.voteFirst !== void 0 || keyReg.voteLast !== void 0 || keyReg.voteKeyDilution !== void 0) errors.push(...validateOnlineKeyRegistration(keyReg));
+	return errors;
+}
+/**
+* Validate online key registration fields
+*/
+function validateOnlineKeyRegistration(keyReg) {
+	const errors = new Array();
+	if (!keyReg.voteKey) errors.push({
+		type: TransactionValidationErrorType.RequiredField,
+		data: "Vote key"
+	});
+	if (!keyReg.selectionKey) errors.push({
+		type: TransactionValidationErrorType.RequiredField,
+		data: "Selection key"
+	});
+	if (!keyReg.stateProofKey) errors.push({
+		type: TransactionValidationErrorType.RequiredField,
+		data: "State proof key"
+	});
+	if (keyReg.voteFirst === void 0) errors.push({
+		type: TransactionValidationErrorType.RequiredField,
+		data: "Vote first"
+	});
+	if (keyReg.voteLast === void 0) errors.push({
+		type: TransactionValidationErrorType.RequiredField,
+		data: "Vote last"
+	});
+	if (keyReg.voteFirst !== void 0 && keyReg.voteLast !== void 0 && keyReg.voteFirst >= keyReg.voteLast) errors.push({
+		type: TransactionValidationErrorType.ArbitraryConstraint,
+		data: "Vote first must be less than vote last"
+	});
+	if (keyReg.voteKeyDilution === void 0) errors.push({
+		type: TransactionValidationErrorType.RequiredField,
+		data: "Vote key dilution"
+	});
+	if (keyReg.nonParticipation === true) errors.push({
+		type: TransactionValidationErrorType.ArbitraryConstraint,
+		data: "Online key registration cannot have non participation flag set"
+	});
+	return errors;
+}
+
+//#endregion
+export { validateKeyRegistrationTransaction };
+//# sourceMappingURL=key-registration.mjs.map

package/packages/transact/src/transactions/key-registration.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"key-registration.mjs","names":[],"sources":["../../../../../packages/transact/src/transactions/key-registration.ts"],"sourcesContent":["import { TransactionValidationError, TransactionValidationErrorType } from './common'\n\n/**\n * Represents a key registration transaction that registers an account online or offline\n * for participation in Algorand consensus.\n */\nexport type KeyRegistrationTransactionFields = {\n  /**\n   * Root participation public key (32 bytes).\n   */\n  voteKey?: Uint8Array\n\n  /**\n   * VRF public key (32 bytes).\n   */\n  selectionKey?: Uint8Array\n\n  /**\n   * State proof key (64 bytes).\n   */\n  stateProofKey?: Uint8Array\n\n  /**\n   * First round for which the participation key is valid.\n   */\n  voteFirst?: bigint\n\n  /**\n   * Last round for which the participation key is valid.\n   */\n  voteLast?: bigint\n\n  /**\n   * Key dilution for the 2-level participation key.\n   */\n  voteKeyDilution?: bigint\n\n  /**\n   * Mark account as non-reward earning.\n   */\n  nonParticipation?: boolean\n}\n\n/**\n * Validate key registration transaction fields\n */\nexport function validateKeyRegistrationTransaction(keyReg: KeyRegistrationTransactionFields): TransactionValidationError[] {\n  const errors = new Array<TransactionValidationError>()\n\n  const hasAnyParticipationFields =\n    keyReg.voteKey !== undefined ||\n    keyReg.selectionKey !== undefined ||\n    keyReg.stateProofKey !== undefined ||\n    keyReg.voteFirst !== undefined ||\n    keyReg.voteLast !== undefined ||\n    keyReg.voteKeyDilution !== undefined\n\n  if (hasAnyParticipationFields) {\n    // Online key registration\n    errors.push(...validateOnlineKeyRegistration(keyReg))\n  }\n  // Offline key registration has no specific validation requirements\n  return errors\n}\n\n/**\n * Validate online key registration fields\n */\nfunction validateOnlineKeyRegistration(keyReg: KeyRegistrationTransactionFields): TransactionValidationError[] {\n  const errors = new Array<TransactionValidationError>()\n\n  if (!keyReg.voteKey) {\n    errors.push({\n      type: TransactionValidationErrorType.RequiredField,\n      data: 'Vote key',\n    })\n  }\n  if (!keyReg.selectionKey) {\n    errors.push({\n      type: TransactionValidationErrorType.RequiredField,\n      data: 'Selection key',\n    })\n  }\n  if (!keyReg.stateProofKey) {\n    errors.push({\n      type: TransactionValidationErrorType.RequiredField,\n      data: 'State proof key',\n    })\n  }\n  if (keyReg.voteFirst === undefined) {\n    errors.push({\n      type: TransactionValidationErrorType.RequiredField,\n      data: 'Vote first',\n    })\n  }\n  if (keyReg.voteLast === undefined) {\n    errors.push({\n      type: TransactionValidationErrorType.RequiredField,\n      data: 'Vote last',\n    })\n  }\n  if (keyReg.voteFirst !== undefined && keyReg.voteLast !== undefined && keyReg.voteFirst >= keyReg.voteLast) {\n    errors.push({\n      type: TransactionValidationErrorType.ArbitraryConstraint,\n      data: 'Vote first must be less than vote last',\n    })\n  }\n  if (keyReg.voteKeyDilution === undefined) {\n    errors.push({\n      type: TransactionValidationErrorType.RequiredField,\n      data: 'Vote key dilution',\n    })\n  }\n  if (keyReg.nonParticipation === true) {\n    errors.push({\n      type: TransactionValidationErrorType.ArbitraryConstraint,\n      data: 'Online key registration cannot have non participation flag set',\n    })\n  }\n\n  return errors\n}\n"],"mappings":";;;;;;AA8CA,SAAgB,mCAAmC,QAAwE;CACzH,MAAM,SAAS,IAAI,OAAmC;AAUtD,KAPE,OAAO,YAAY,UACnB,OAAO,iBAAiB,UACxB,OAAO,kBAAkB,UACzB,OAAO,cAAc,UACrB,OAAO,aAAa,UACpB,OAAO,oBAAoB,OAI3B,QAAO,KAAK,GAAG,8BAA8B,OAAO,CAAC;AAGvD,QAAO;;;;;AAMT,SAAS,8BAA8B,QAAwE;CAC7G,MAAM,SAAS,IAAI,OAAmC;AAEtD,KAAI,CAAC,OAAO,QACV,QAAO,KAAK;EACV,MAAM,+BAA+B;EACrC,MAAM;EACP,CAAC;AAEJ,KAAI,CAAC,OAAO,aACV,QAAO,KAAK;EACV,MAAM,+BAA+B;EACrC,MAAM;EACP,CAAC;AAEJ,KAAI,CAAC,OAAO,cACV,QAAO,KAAK;EACV,MAAM,+BAA+B;EACrC,MAAM;EACP,CAAC;AAEJ,KAAI,OAAO,cAAc,OACvB,QAAO,KAAK;EACV,MAAM,+BAA+B;EACrC,MAAM;EACP,CAAC;AAEJ,KAAI,OAAO,aAAa,OACtB,QAAO,KAAK;EACV,MAAM,+BAA+B;EACrC,MAAM;EACP,CAAC;AAEJ,KAAI,OAAO,cAAc,UAAa,OAAO,aAAa,UAAa,OAAO,aAAa,OAAO,SAChG,QAAO,KAAK;EACV,MAAM,+BAA+B;EACrC,MAAM;EACP,CAAC;AAEJ,KAAI,OAAO,oBAAoB,OAC7B,QAAO,KAAK;EACV,MAAM,+BAA+B;EACrC,MAAM;EACP,CAAC;AAEJ,KAAI,OAAO,qBAAqB,KAC9B,QAAO,KAAK;EACV,MAAM,+BAA+B;EACrC,MAAM;EACP,CAAC;AAGJ,QAAO"}

package/packages/transact/src/transactions/payment.d.ts

@@ -0,0 +1,32 @@
+import { Address } from "../../../common/src/address.js";
+
+//#region packages/transact/src/transactions/payment.d.ts
+
+/**
+ * Represents a payment transaction that transfers ALGO between accounts.
+ *
+ * Payment transactions are used to transfer ALGO between accounts.
+ */
+type PaymentTransactionFields = {
+  /**
+   * The address of the account receiving the ALGO payment.
+   */
+  receiver: Address;
+  /**
+   * The amount of microALGO to send.
+   *
+   * Specified in microALGO (1 ALGO = 1,000,000 microALGO).
+   */
+  amount: bigint;
+  /**
+   * Optional address to send all remaining funds to after the transfer.
+   *
+   * If specified, this indicates that the sender account should be closed after the transaction,
+   * and all remaining funds (minus fees) should be transferred to the specified address.
+   * This effectively removes the sender account from the ledger.
+   */
+  closeRemainderTo?: Address;
+};
+//#endregion
+export { PaymentTransactionFields };
+//# sourceMappingURL=payment.d.ts.map

package/packages/transact/src/transactions/reference-types-meta.d.ts

@@ -0,0 +1,26 @@
+import { ObjectModelMetadata } from "../../../common/src/codecs/types.js";
+import { BoxReference, HoldingReference, LocalsReference } from "./app-call.js";
+
+//#region packages/transact/src/transactions/reference-types-meta.d.ts
+
+/**
+ * Metadata for BoxReference
+ *
+ * Maps wire format (app, name) to BoxReference (appId, name)
+ */
+declare const BoxReferenceMeta: ObjectModelMetadata<BoxReference>;
+/**
+ * Metadata for HoldingReference
+ *
+ * Maps wire format (account, asset) to HoldingReference (address, assetId)
+ */
+declare const HoldingReferenceMeta: ObjectModelMetadata<HoldingReference>;
+/**
+ * Metadata for LocalsReference
+ *
+ * Maps wire format (account, app) to LocalsReference (address, appId)
+ */
+declare const LocalsReferenceMeta: ObjectModelMetadata<LocalsReference>;
+//#endregion
+export { BoxReferenceMeta, HoldingReferenceMeta, LocalsReferenceMeta };
+//# sourceMappingURL=reference-types-meta.d.ts.map