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

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

@@ -0,0 +1,338 @@
+import { concatArrays } from "../../../common/src/array.mjs";
+import { MAX_TRANSACTION_GROUP_SIZE, SIGNATURE_ENCODING_INCR, TRANSACTION_DOMAIN_SEPARATOR, TRANSACTION_GROUP_DOMAIN_SEPARATOR, TRANSACTION_ID_LENGTH } from "../../../common/src/constants.mjs";
+import { Address } from "../../../common/src/address.mjs";
+import { Codec } from "../../../common/src/codecs/codec.mjs";
+import { hash } from "../../../common/src/crypto.mjs";
+import { decodeMsgpack, encodeMsgpack } from "../../../common/src/msgpack.mjs";
+import { getValidationErrorMessage } from "./common.mjs";
+import { validateAppCallTransaction } from "./app-call.mjs";
+import { validateAssetConfigTransaction } from "./asset-config.mjs";
+import { validateAssetFreezeTransaction } from "./asset-freeze.mjs";
+import { validateAssetTransferTransaction } from "./asset-transfer.mjs";
+import { validateKeyRegistrationTransaction } from "./key-registration.mjs";
+import { TransactionType } from "./transaction-type.mjs";
+import { transactionParamsCodec } from "./transaction-meta.mjs";
+import base32 from "hi-base32";
+
+//#region packages/transact/src/transactions/transaction.ts
+/** Symbol used for instanceof checks across packages (CJS/ESM) */
+const TXN_SYMBOL = Symbol.for("algokit_transact:Transaction");
+/**
+* Represents a complete Algorand transaction.
+*/
+var Transaction = class {
+	/** @internal */
+	[TXN_SYMBOL];
+	/**
+	* The type of transaction
+	*/
+	type;
+	/**
+	* The account that authorized the transaction.
+	*
+	* Fees are deducted from this account.
+	*/
+	sender;
+	/**
+	* Optional transaction fee in microALGO.
+	*
+	* When not set, the fee will be interpreted as 0 by the network.
+	*/
+	fee;
+	/**
+	* First round for when the transaction is valid.
+	*/
+	firstValid;
+	/**
+	* Last round for when the transaction is valid.
+	*
+	* After this round, the transaction will be expired.
+	*/
+	lastValid;
+	/**
+	* Hash of the genesis block of the network.
+	*
+	* Used to identify which network the transaction is for.
+	*/
+	genesisHash;
+	/**
+	* Genesis ID of the network.
+	*
+	* A human-readable string used alongside genesis hash to identify the network.
+	*/
+	genesisId;
+	/**
+	* Optional user-defined note field.
+	*
+	* Can contain arbitrary data up to 1KB in size.
+	*/
+	note;
+	/**
+	* Optional authorized account for future transactions.
+	*
+	* If set, only this account will be used for transaction authorization going forward.
+	* Reverting back control to the original address must be done by setting this field to
+	* the original address.
+	*/
+	rekeyTo;
+	/**
+	* Optional lease value to enforce mutual transaction exclusion.
+	*
+	* When a transaction with a non-empty lease field is confirmed, the lease is acquired.
+	* A lease X is acquired by the sender, generating the (sender, X) lease.
+	* The lease is kept active until the last_valid round of the transaction has elapsed.
+	* No other transaction sent by the same sender can be confirmed until the lease expires.
+	*/
+	lease;
+	/**
+	* Optional group ID for atomic transaction grouping.
+	*
+	* Transactions with the same group ID must execute together or not at all.
+	*/
+	group;
+	/**
+	* Payment specific fields
+	*/
+	payment;
+	/**
+	* Asset transfer specific fields
+	*/
+	assetTransfer;
+	/**
+	* Asset config specific fields
+	*/
+	assetConfig;
+	/**
+	* App call specific fields
+	*/
+	appCall;
+	/**
+	* Key registration specific fields
+	*/
+	keyRegistration;
+	/**
+	* Asset freeze specific fields
+	*/
+	assetFreeze;
+	/**
+	* Heartbeat specific fields
+	*/
+	heartbeat;
+	/**
+	* State proof specific fields
+	*/
+	stateProof;
+	constructor(params) {
+		this[TXN_SYMBOL] = true;
+		this.type = params.type;
+		this.sender = params.sender;
+		this.fee = params.fee;
+		this.firstValid = params.firstValid;
+		this.lastValid = params.lastValid;
+		this.genesisHash = params.genesisHash;
+		this.genesisId = params.genesisId;
+		this.note = params.note;
+		this.rekeyTo = params.rekeyTo;
+		this.lease = params.lease;
+		this.group = params.group;
+		this.payment = params.payment;
+		this.assetTransfer = params.assetTransfer;
+		this.assetConfig = params.assetConfig;
+		this.appCall = params.appCall;
+		this.keyRegistration = params.keyRegistration;
+		this.assetFreeze = params.assetFreeze;
+		this.heartbeat = params.heartbeat;
+		this.stateProof = params.stateProof;
+	}
+	rawTxId() {
+		if (this.genesisHash === void 0) throw new Error("Cannot compute transaction id without genesis hash");
+		return hash(encodeTransaction(this));
+	}
+	/**
+	* Get the transaction ID as a base32-encoded string.
+	*/
+	txId() {
+		const rawTxId = this.rawTxId();
+		return base32.encode(rawTxId).slice(0, TRANSACTION_ID_LENGTH);
+	}
+	static [Symbol.hasInstance](obj) {
+		return Boolean(obj && typeof obj === "object" && TXN_SYMBOL in obj && obj[TXN_SYMBOL]);
+	}
+};
+/**
+* Codec for Transaction class.
+* Handles encoding/decoding between Transaction class instances and wire format.
+*/
+var TransactionCodec = class extends Codec {
+	defaultValue() {
+		return new Transaction({
+			type: TransactionType.Unknown,
+			sender: Address.zeroAddress(),
+			firstValid: 0n,
+			lastValid: 0n
+		});
+	}
+	toEncoded(value, format) {
+		return transactionParamsCodec.encode({ ...value }, format);
+	}
+	fromEncoded(value, format) {
+		return new Transaction(transactionParamsCodec.decode(value, format));
+	}
+	isDefaultValue(_) {
+		return false;
+	}
+};
+const transactionCodec = new TransactionCodec();
+/**
+* Get the transaction type from the encoded transaction.
+* This is particularly useful when decoding a transaction that has an unknown type
+*/
+function getEncodedTransactionType(encoded_transaction) {
+	return decodeTransaction(encoded_transaction).type;
+}
+/**
+* Encode the transaction with the domain separation (e.g. "TX") prefix
+*
+* @param transaction - The transaction to encode
+* @returns The MsgPack encoded bytes or an error if encoding fails.
+*/
+function encodeTransaction(transaction) {
+	const rawBytes = encodeTransactionRaw(transaction);
+	return concatArrays(new TextEncoder().encode(TRANSACTION_DOMAIN_SEPARATOR), rawBytes);
+}
+/**
+* Encode transactions with the domain separation (e.g. "TX") prefix
+*
+* @param transactions - A collection of transactions to encode
+* @returns A collection of MsgPack encoded bytes or an error if encoding fails.
+*/
+function encodeTransactions(transactions) {
+	return transactions.map((tx) => encodeTransaction(tx));
+}
+/**
+* Validate a transaction
+*/
+function validateTransaction(transaction) {
+	if ([
+		transaction.payment,
+		transaction.assetTransfer,
+		transaction.assetConfig,
+		transaction.appCall,
+		transaction.keyRegistration,
+		transaction.assetFreeze,
+		transaction.heartbeat,
+		transaction.stateProof
+	].filter((field) => field !== void 0).length > 1) throw new Error("Multiple transaction type specific fields set");
+	let typeName = "Transaction";
+	const errors = new Array();
+	if (transaction.assetTransfer) {
+		typeName = "Asset transfer";
+		errors.push(...validateAssetTransferTransaction(transaction.assetTransfer));
+	} else if (transaction.assetConfig) {
+		typeName = "Asset config";
+		errors.push(...validateAssetConfigTransaction(transaction.assetConfig));
+	} else if (transaction.appCall) {
+		typeName = "App call";
+		errors.push(...validateAppCallTransaction(transaction.appCall));
+	} else if (transaction.keyRegistration) {
+		typeName = "Key registration";
+		errors.push(...validateKeyRegistrationTransaction(transaction.keyRegistration));
+	} else if (transaction.assetFreeze) {
+		typeName = "Asset freeze";
+		errors.push(...validateAssetFreezeTransaction(transaction.assetFreeze));
+	}
+	if (errors.length > 0) {
+		const errorMessages = errors.map((e) => getValidationErrorMessage(e));
+		throw new Error(`${typeName} validation failed: ${errorMessages.join("\n")}`);
+	}
+}
+/**
+* Encode the transaction without the domain separation (e.g. "TX") prefix
+* This is useful for encoding the transaction for signing with tools that automatically add "TX" prefix to the transaction bytes.
+*/
+function encodeTransactionRaw(transaction) {
+	validateTransaction(transaction);
+	return encodeMsgpack(transactionCodec.encode(transaction, "msgpack"));
+}
+/**
+* Decodes MsgPack bytes into a transaction.
+*
+* # Parameters
+* * `encoded_transaction` - MsgPack encoded bytes representing a transaction.
+*
+* # Returns
+* A decoded transaction or an error if decoding fails.
+*/
+function decodeTransaction(encoded_transaction) {
+	if (encoded_transaction.length === 0) throw new Error("attempted to decode 0 bytes");
+	const prefixBytes = new TextEncoder().encode(TRANSACTION_DOMAIN_SEPARATOR);
+	let hasPrefix = true;
+	if (encoded_transaction.length < prefixBytes.length) hasPrefix = false;
+	else for (let i = 0; i < prefixBytes.length; i++) if (encoded_transaction[i] !== prefixBytes[i]) {
+		hasPrefix = false;
+		break;
+	}
+	const decodedData = decodeMsgpack(hasPrefix ? encoded_transaction.slice(prefixBytes.length) : encoded_transaction);
+	return transactionCodec.decode(decodedData, "msgpack");
+}
+/**
+* Decodes a collection of MsgPack bytes into a transaction collection.
+*
+* # Parameters
+* * `encoded_transaction` - A collection of MsgPack encoded bytes, each representing a transaction.
+*
+* # Returns
+* A collection of decoded transactions or an error if decoding fails.
+*/
+function decodeTransactions(encoded_transactions) {
+	return encoded_transactions.map((et) => decodeTransaction(et));
+}
+/**
+* Return the size of the transaction in bytes as if it was already signed and encoded.
+* This is useful for estimating the fee for the transaction.
+*/
+function estimateTransactionSize(transaction) {
+	const encoded = encodeTransactionRaw(transaction);
+	return BigInt(encoded.length + SIGNATURE_ENCODING_INCR);
+}
+/**
+* Groups a collection of transactions by calculating and assigning the group to each transaction.
+*/
+function groupTransactions(transactions) {
+	const group = computeGroup(transactions);
+	return transactions.map((tx) => new Transaction({
+		...tx,
+		group
+	}));
+}
+function assignFee(transaction, feeParams) {
+	const fee = calculateFee(transaction, feeParams);
+	return new Transaction({
+		...transaction,
+		fee
+	});
+}
+function computeGroup(transactions) {
+	if (transactions.length === 0) throw new Error("Transaction group size cannot be 0");
+	if (transactions.length > MAX_TRANSACTION_GROUP_SIZE) throw new Error(`Transaction group size exceeds the max limit of ${MAX_TRANSACTION_GROUP_SIZE}`);
+	const txHashes = transactions.map((tx) => {
+		if (tx.group) throw new Error("Transactions must not already be grouped");
+		return hash(encodeTransaction(tx));
+	});
+	return hash(concatArrays(new TextEncoder().encode(TRANSACTION_GROUP_DOMAIN_SEPARATOR), encodeMsgpack({ txlist: txHashes })));
+}
+function calculateFee(transaction, feeParams) {
+	let calculatedFee = 0n;
+	if (feeParams.feePerByte > 0n) {
+		const estimatedSize = estimateTransactionSize(transaction);
+		calculatedFee = feeParams.feePerByte * BigInt(estimatedSize);
+	}
+	if (calculatedFee < feeParams.minFee) calculatedFee = feeParams.minFee;
+	if (feeParams.extraFee) calculatedFee += feeParams.extraFee;
+	if (feeParams.maxFee && calculatedFee > feeParams.maxFee) throw new Error(`Transaction fee ${calculatedFee} µALGO is greater than maxFee ${feeParams.maxFee} µALGO`);
+	return calculatedFee;
+}
+
+//#endregion
+export { Transaction, assignFee, calculateFee, decodeTransaction, decodeTransactions, encodeTransaction, encodeTransactionRaw, encodeTransactions, estimateTransactionSize, getEncodedTransactionType, groupTransactions, transactionCodec, validateTransaction };
+//# sourceMappingURL=transaction.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.mjs","names":[],"sources":["../../../../../packages/transact/src/transactions/transaction.ts"],"sourcesContent":["import type { EncodingFormat, WireObject } from '@algorandfoundation/algokit-common'\nimport {\n  Address,\n  Codec,\n  MAX_TRANSACTION_GROUP_SIZE,\n  SIGNATURE_ENCODING_INCR,\n  TRANSACTION_DOMAIN_SEPARATOR,\n  TRANSACTION_GROUP_DOMAIN_SEPARATOR,\n  TRANSACTION_ID_LENGTH,\n  concatArrays,\n  decodeMsgpack,\n  encodeMsgpack,\n  hash,\n} from '@algorandfoundation/algokit-common'\nimport base32 from 'hi-base32'\nimport { AppCallTransactionFields, validateAppCallTransaction } from './app-call'\nimport { AssetConfigTransactionFields, validateAssetConfigTransaction } from './asset-config'\nimport { AssetFreezeTransactionFields, validateAssetFreezeTransaction } from './asset-freeze'\nimport { AssetTransferTransactionFields, validateAssetTransferTransaction } from './asset-transfer'\nimport { TransactionValidationError, getValidationErrorMessage } from './common'\nimport { HeartbeatTransactionFields } from './heartbeat'\nimport { KeyRegistrationTransactionFields, validateKeyRegistrationTransaction } from './key-registration'\nimport { PaymentTransactionFields } from './payment'\nimport { StateProofTransactionFields } from './state-proof'\nimport { transactionParamsCodec } from './transaction-meta'\nimport { TransactionType } from './transaction-type'\n\n/** Symbol used for instanceof checks across packages (CJS/ESM) */\nexport const TXN_SYMBOL = Symbol.for('algokit_transact:Transaction')\n\n/**\n * Represents the parameters for a complete Algorand transaction.\n *\n * This structure contains the fields that are present in every transaction,\n * regardless of transaction type, plus transaction-type-specific fields.\n */\nexport type TransactionParams = {\n  /**\n   * The type of transaction\n   */\n  type: TransactionType\n\n  /**\n   * The account that authorized the transaction.\n   *\n   * Fees are deducted from this account.\n   */\n  sender: Address\n\n  /**\n   * Optional transaction fee in microALGO.\n   *\n   * When not set, the fee will be interpreted as 0 by the network.\n   */\n  fee?: bigint\n\n  /**\n   * First round for when the transaction is valid.\n   */\n  firstValid: bigint\n\n  /**\n   * Last round for when the transaction is valid.\n   *\n   * After this round, the transaction will be expired.\n   */\n  lastValid: bigint\n\n  /**\n   * Hash of the genesis block of the network.\n   *\n   * Used to identify which network the transaction is for.\n   */\n  genesisHash?: Uint8Array\n\n  /**\n   * Genesis ID of the network.\n   *\n   * A human-readable string used alongside genesis hash to identify the network.\n   */\n  genesisId?: string\n\n  /**\n   * Optional user-defined note field.\n   *\n   * Can contain arbitrary data up to 1KB in size.\n   */\n  note?: Uint8Array\n\n  /**\n   * Optional authorized account for future transactions.\n   *\n   * If set, only this account will be used for transaction authorization going forward.\n   * Reverting back control to the original address must be done by setting this field to\n   * the original address.\n   */\n  rekeyTo?: Address\n\n  /**\n   * Optional lease value to enforce mutual transaction exclusion.\n   *\n   * When a transaction with a non-empty lease field is confirmed, the lease is acquired.\n   * A lease X is acquired by the sender, generating the (sender, X) lease.\n   * The lease is kept active until the last_valid round of the transaction has elapsed.\n   * No other transaction sent by the same sender can be confirmed until the lease expires.\n   */\n  lease?: Uint8Array\n\n  /**\n   * Optional group ID for atomic transaction grouping.\n   *\n   * Transactions with the same group ID must execute together or not at all.\n   */\n  group?: Uint8Array\n\n  /**\n   * Payment specific fields\n   */\n  payment?: PaymentTransactionFields\n\n  /**\n   * Asset transfer specific fields\n   */\n  assetTransfer?: AssetTransferTransactionFields\n\n  /**\n   * Asset config specific fields\n   */\n  assetConfig?: AssetConfigTransactionFields\n\n  /**\n   * App call specific fields\n   */\n  appCall?: AppCallTransactionFields\n\n  /**\n   * Key registration specific fields\n   */\n  keyRegistration?: KeyRegistrationTransactionFields\n\n  /**\n   * Asset freeze specific fields\n   */\n  assetFreeze?: AssetFreezeTransactionFields\n\n  /**\n   * Heartbeat specific fields\n   */\n  heartbeat?: HeartbeatTransactionFields\n\n  /**\n   * State proof specific fields\n   */\n  stateProof?: StateProofTransactionFields\n}\n\n/**\n * Represents a complete Algorand transaction.\n */\nexport class Transaction implements TransactionParams {\n  /** @internal */\n  [TXN_SYMBOL]: boolean\n\n  /**\n   * The type of transaction\n   */\n  type: TransactionType\n\n  /**\n   * The account that authorized the transaction.\n   *\n   * Fees are deducted from this account.\n   */\n  sender: Address\n\n  /**\n   * Optional transaction fee in microALGO.\n   *\n   * When not set, the fee will be interpreted as 0 by the network.\n   */\n  fee?: bigint\n\n  /**\n   * First round for when the transaction is valid.\n   */\n  firstValid: bigint\n\n  /**\n   * Last round for when the transaction is valid.\n   *\n   * After this round, the transaction will be expired.\n   */\n  lastValid: bigint\n\n  /**\n   * Hash of the genesis block of the network.\n   *\n   * Used to identify which network the transaction is for.\n   */\n  genesisHash?: Uint8Array\n\n  /**\n   * Genesis ID of the network.\n   *\n   * A human-readable string used alongside genesis hash to identify the network.\n   */\n  genesisId?: string\n\n  /**\n   * Optional user-defined note field.\n   *\n   * Can contain arbitrary data up to 1KB in size.\n   */\n  note?: Uint8Array\n\n  /**\n   * Optional authorized account for future transactions.\n   *\n   * If set, only this account will be used for transaction authorization going forward.\n   * Reverting back control to the original address must be done by setting this field to\n   * the original address.\n   */\n  rekeyTo?: Address\n\n  /**\n   * Optional lease value to enforce mutual transaction exclusion.\n   *\n   * When a transaction with a non-empty lease field is confirmed, the lease is acquired.\n   * A lease X is acquired by the sender, generating the (sender, X) lease.\n   * The lease is kept active until the last_valid round of the transaction has elapsed.\n   * No other transaction sent by the same sender can be confirmed until the lease expires.\n   */\n  lease?: Uint8Array\n\n  /**\n   * Optional group ID for atomic transaction grouping.\n   *\n   * Transactions with the same group ID must execute together or not at all.\n   */\n  group?: Uint8Array\n\n  /**\n   * Payment specific fields\n   */\n  payment?: PaymentTransactionFields\n\n  /**\n   * Asset transfer specific fields\n   */\n  assetTransfer?: AssetTransferTransactionFields\n\n  /**\n   * Asset config specific fields\n   */\n  assetConfig?: AssetConfigTransactionFields\n\n  /**\n   * App call specific fields\n   */\n  appCall?: AppCallTransactionFields\n\n  /**\n   * Key registration specific fields\n   */\n  keyRegistration?: KeyRegistrationTransactionFields\n\n  /**\n   * Asset freeze specific fields\n   */\n  assetFreeze?: AssetFreezeTransactionFields\n\n  /**\n   * Heartbeat specific fields\n   */\n  heartbeat?: HeartbeatTransactionFields\n\n  /**\n   * State proof specific fields\n   */\n  stateProof?: StateProofTransactionFields\n\n  constructor(params: TransactionParams) {\n    this[TXN_SYMBOL] = true\n    this.type = params.type\n    this.sender = params.sender\n    this.fee = params.fee\n    this.firstValid = params.firstValid\n    this.lastValid = params.lastValid\n    this.genesisHash = params.genesisHash\n    this.genesisId = params.genesisId\n    this.note = params.note\n    this.rekeyTo = params.rekeyTo\n    this.lease = params.lease\n    this.group = params.group\n    this.payment = params.payment\n    this.assetTransfer = params.assetTransfer\n    this.assetConfig = params.assetConfig\n    this.appCall = params.appCall\n    this.keyRegistration = params.keyRegistration\n    this.assetFreeze = params.assetFreeze\n    this.heartbeat = params.heartbeat\n    this.stateProof = params.stateProof\n  }\n\n  private rawTxId(): Uint8Array {\n    if (this.genesisHash === undefined) {\n      throw new Error('Cannot compute transaction id without genesis hash')\n    }\n\n    const encodedBytes = encodeTransaction(this)\n    return hash(encodedBytes)\n  }\n\n  /**\n   * Get the transaction ID as a base32-encoded string.\n   */\n  txId(): string {\n    const rawTxId = this.rawTxId()\n\n    return base32.encode(rawTxId).slice(0, TRANSACTION_ID_LENGTH)\n  }\n\n  static [Symbol.hasInstance](obj: unknown) {\n    return Boolean(obj && typeof obj === 'object' && TXN_SYMBOL in obj && obj[TXN_SYMBOL as keyof typeof obj])\n  }\n}\n\n/**\n * Codec for Transaction class.\n * Handles encoding/decoding between Transaction class instances and wire format.\n */\nclass TransactionCodec extends Codec<Transaction, Record<string, unknown>, WireObject> {\n  public defaultValue(): Transaction {\n    return new Transaction({\n      type: TransactionType.Unknown,\n      sender: Address.zeroAddress(),\n      firstValid: 0n,\n      lastValid: 0n,\n    })\n  }\n\n  protected toEncoded(value: Transaction, format: EncodingFormat): Record<string, unknown> {\n    return transactionParamsCodec.encode({ ...value }, format)\n  }\n\n  protected fromEncoded(value: WireObject, format: EncodingFormat): Transaction {\n    const params = transactionParamsCodec.decode(value, format)\n    return new Transaction(params)\n  }\n\n  public isDefaultValue(_: Transaction): boolean {\n    return false\n  }\n}\n\nexport const transactionCodec = new TransactionCodec()\n\nexport type FeeParams = {\n  feePerByte: bigint\n  minFee: bigint\n  extraFee?: bigint\n  maxFee?: bigint\n}\n\n/**\n * Get the transaction type from the encoded transaction.\n * This is particularly useful when decoding a transaction that has an unknown type\n */\nexport function getEncodedTransactionType(encoded_transaction: Uint8Array): TransactionType {\n  const decoded = decodeTransaction(encoded_transaction)\n  return decoded.type\n}\n\n/**\n * Encode the transaction with the domain separation (e.g. \"TX\") prefix\n *\n * @param transaction - The transaction to encode\n * @returns The MsgPack encoded bytes or an error if encoding fails.\n */\nexport function encodeTransaction(transaction: Transaction): Uint8Array {\n  const rawBytes = encodeTransactionRaw(transaction)\n\n  // Add domain separation prefix\n  const prefixBytes = new TextEncoder().encode(TRANSACTION_DOMAIN_SEPARATOR)\n  return concatArrays(prefixBytes, rawBytes)\n}\n\n/**\n * Encode transactions with the domain separation (e.g. \"TX\") prefix\n *\n * @param transactions - A collection of transactions to encode\n * @returns A collection of MsgPack encoded bytes or an error if encoding fails.\n */\nexport function encodeTransactions(transactions: Transaction[]): Uint8Array[] {\n  return transactions.map((tx) => encodeTransaction(tx))\n}\n\n/**\n * Validate a transaction\n */\nexport function validateTransaction(transaction: Transaction): void {\n  // Validate that only one transaction type specific field is set\n  const typeFields = [\n    transaction.payment,\n    transaction.assetTransfer,\n    transaction.assetConfig,\n    transaction.appCall,\n    transaction.keyRegistration,\n    transaction.assetFreeze,\n    transaction.heartbeat,\n    transaction.stateProof,\n  ]\n\n  const setFieldsCount = typeFields.filter((field) => field !== undefined).length\n\n  if (setFieldsCount > 1) {\n    throw new Error('Multiple transaction type specific fields set')\n  }\n\n  // Perform type-specific validation where applicable\n  let typeName = 'Transaction'\n  const errors = new Array<TransactionValidationError>()\n  if (transaction.assetTransfer) {\n    typeName = 'Asset transfer'\n    errors.push(...validateAssetTransferTransaction(transaction.assetTransfer))\n  } else if (transaction.assetConfig) {\n    typeName = 'Asset config'\n    errors.push(...validateAssetConfigTransaction(transaction.assetConfig))\n  } else if (transaction.appCall) {\n    typeName = 'App call'\n    errors.push(...validateAppCallTransaction(transaction.appCall))\n  } else if (transaction.keyRegistration) {\n    typeName = 'Key registration'\n    errors.push(...validateKeyRegistrationTransaction(transaction.keyRegistration))\n  } else if (transaction.assetFreeze) {\n    typeName = 'Asset freeze'\n    errors.push(...validateAssetFreezeTransaction(transaction.assetFreeze))\n  }\n\n  if (errors.length > 0) {\n    const errorMessages = errors.map((e) => getValidationErrorMessage(e))\n    throw new Error(`${typeName} validation failed: ${errorMessages.join('\\n')}`)\n  }\n}\n\n/**\n * Encode the transaction without the domain separation (e.g. \"TX\") prefix\n * This is useful for encoding the transaction for signing with tools that automatically add \"TX\" prefix to the transaction bytes.\n */\nexport function encodeTransactionRaw(transaction: Transaction): Uint8Array {\n  validateTransaction(transaction)\n  const encodingData = transactionCodec.encode(transaction, 'msgpack')\n  return encodeMsgpack(encodingData)\n}\n\n/**\n * Decodes MsgPack bytes into a transaction.\n *\n * # Parameters\n * * `encoded_transaction` - MsgPack encoded bytes representing a transaction.\n *\n * # Returns\n * A decoded transaction or an error if decoding fails.\n */\nexport function decodeTransaction(encoded_transaction: Uint8Array): Transaction {\n  if (encoded_transaction.length === 0) {\n    throw new Error('attempted to decode 0 bytes')\n  }\n\n  const prefixBytes = new TextEncoder().encode(TRANSACTION_DOMAIN_SEPARATOR)\n  // Check if the transaction has the domain separation prefix\n  let hasPrefix = true\n  if (encoded_transaction.length < prefixBytes.length) {\n    hasPrefix = false\n  } else {\n    for (let i = 0; i < prefixBytes.length; i++) {\n      if (encoded_transaction[i] !== prefixBytes[i]) {\n        hasPrefix = false\n        break\n      }\n    }\n  }\n\n  const decodedData = decodeMsgpack(hasPrefix ? encoded_transaction.slice(prefixBytes.length) : encoded_transaction)\n  return transactionCodec.decode(decodedData, 'msgpack')\n}\n\n/**\n * Decodes a collection of MsgPack bytes into a transaction collection.\n *\n * # Parameters\n * * `encoded_transaction` - A collection of MsgPack encoded bytes, each representing a transaction.\n *\n * # Returns\n * A collection of decoded transactions or an error if decoding fails.\n */\nexport function decodeTransactions(encoded_transactions: Uint8Array[]): Transaction[] {\n  return encoded_transactions.map((et) => decodeTransaction(et))\n}\n\n/**\n * Return the size of the transaction in bytes as if it was already signed and encoded.\n * This is useful for estimating the fee for the transaction.\n */\nexport function estimateTransactionSize(transaction: Transaction): bigint {\n  const encoded = encodeTransactionRaw(transaction)\n  return BigInt(encoded.length + SIGNATURE_ENCODING_INCR)\n}\n\n/**\n * Groups a collection of transactions by calculating and assigning the group to each transaction.\n */\nexport function groupTransactions(transactions: Transaction[]): Transaction[] {\n  const group = computeGroup(transactions)\n  return transactions.map(\n    (tx) =>\n      new Transaction({\n        ...tx,\n        group,\n      }),\n  )\n}\n\nexport function assignFee(transaction: Transaction, feeParams: FeeParams): Transaction {\n  const fee = calculateFee(transaction, feeParams)\n  return new Transaction({\n    ...transaction,\n    fee,\n  })\n}\n\nfunction computeGroup(transactions: Transaction[]): Uint8Array {\n  if (transactions.length === 0) {\n    throw new Error('Transaction group size cannot be 0')\n  }\n\n  if (transactions.length > MAX_TRANSACTION_GROUP_SIZE) {\n    throw new Error(`Transaction group size exceeds the max limit of ${MAX_TRANSACTION_GROUP_SIZE}`)\n  }\n\n  const txHashes = transactions.map((tx) => {\n    if (tx.group) {\n      throw new Error('Transactions must not already be grouped')\n    }\n\n    const encodedBytes = encodeTransaction(tx)\n    return hash(encodedBytes)\n  })\n\n  const prefixBytes = new TextEncoder().encode(TRANSACTION_GROUP_DOMAIN_SEPARATOR)\n  const encodedBytes = encodeMsgpack({\n    txlist: txHashes,\n  })\n\n  const prefixedBytes = concatArrays(prefixBytes, encodedBytes)\n  return hash(prefixedBytes)\n}\n\nexport function calculateFee(transaction: Transaction, feeParams: FeeParams): bigint {\n  let calculatedFee = 0n\n\n  if (feeParams.feePerByte > 0n) {\n    const estimatedSize = estimateTransactionSize(transaction)\n    calculatedFee = feeParams.feePerByte * BigInt(estimatedSize)\n  }\n\n  if (calculatedFee < feeParams.minFee) {\n    calculatedFee = feeParams.minFee\n  }\n\n  if (feeParams.extraFee) {\n    calculatedFee += feeParams.extraFee\n  }\n\n  if (feeParams.maxFee && calculatedFee > feeParams.maxFee) {\n    throw new Error(`Transaction fee ${calculatedFee} µALGO is greater than maxFee ${feeParams.maxFee} µALGO`)\n  }\n\n  return calculatedFee\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AA4BA,MAAa,aAAa,OAAO,IAAI,+BAA+B;;;;AAmIpE,IAAa,cAAb,MAAsD;;CAEpD,CAAC;;;;CAKD;;;;;;CAOA;;;;;;CAOA;;;;CAKA;;;;;;CAOA;;;;;;CAOA;;;;;;CAOA;;;;;;CAOA;;;;;;;;CASA;;;;;;;;;CAUA;;;;;;CAOA;;;;CAKA;;;;CAKA;;;;CAKA;;;;CAKA;;;;CAKA;;;;CAKA;;;;CAKA;;;;CAKA;CAEA,YAAY,QAA2B;AACrC,OAAK,cAAc;AACnB,OAAK,OAAO,OAAO;AACnB,OAAK,SAAS,OAAO;AACrB,OAAK,MAAM,OAAO;AAClB,OAAK,aAAa,OAAO;AACzB,OAAK,YAAY,OAAO;AACxB,OAAK,cAAc,OAAO;AAC1B,OAAK,YAAY,OAAO;AACxB,OAAK,OAAO,OAAO;AACnB,OAAK,UAAU,OAAO;AACtB,OAAK,QAAQ,OAAO;AACpB,OAAK,QAAQ,OAAO;AACpB,OAAK,UAAU,OAAO;AACtB,OAAK,gBAAgB,OAAO;AAC5B,OAAK,cAAc,OAAO;AAC1B,OAAK,UAAU,OAAO;AACtB,OAAK,kBAAkB,OAAO;AAC9B,OAAK,cAAc,OAAO;AAC1B,OAAK,YAAY,OAAO;AACxB,OAAK,aAAa,OAAO;;CAG3B,AAAQ,UAAsB;AAC5B,MAAI,KAAK,gBAAgB,OACvB,OAAM,IAAI,MAAM,qDAAqD;AAIvE,SAAO,KADc,kBAAkB,KAAK,CACnB;;;;;CAM3B,OAAe;EACb,MAAM,UAAU,KAAK,SAAS;AAE9B,SAAO,OAAO,OAAO,QAAQ,CAAC,MAAM,GAAG,sBAAsB;;CAG/D,QAAQ,OAAO,aAAa,KAAc;AACxC,SAAO,QAAQ,OAAO,OAAO,QAAQ,YAAY,cAAc,OAAO,IAAI,YAAgC;;;;;;;AAQ9G,IAAM,mBAAN,cAA+B,MAAwD;CACrF,AAAO,eAA4B;AACjC,SAAO,IAAI,YAAY;GACrB,MAAM,gBAAgB;GACtB,QAAQ,QAAQ,aAAa;GAC7B,YAAY;GACZ,WAAW;GACZ,CAAC;;CAGJ,AAAU,UAAU,OAAoB,QAAiD;AACvF,SAAO,uBAAuB,OAAO,EAAE,GAAG,OAAO,EAAE,OAAO;;CAG5D,AAAU,YAAY,OAAmB,QAAqC;AAE5E,SAAO,IAAI,YADI,uBAAuB,OAAO,OAAO,OAAO,CAC7B;;CAGhC,AAAO,eAAe,GAAyB;AAC7C,SAAO;;;AAIX,MAAa,mBAAmB,IAAI,kBAAkB;;;;;AAatD,SAAgB,0BAA0B,qBAAkD;AAE1F,QADgB,kBAAkB,oBAAoB,CACvC;;;;;;;;AASjB,SAAgB,kBAAkB,aAAsC;CACtE,MAAM,WAAW,qBAAqB,YAAY;AAIlD,QAAO,aADa,IAAI,aAAa,CAAC,OAAO,6BAA6B,EACzC,SAAS;;;;;;;;AAS5C,SAAgB,mBAAmB,cAA2C;AAC5E,QAAO,aAAa,KAAK,OAAO,kBAAkB,GAAG,CAAC;;;;;AAMxD,SAAgB,oBAAoB,aAAgC;AAelE,KAbmB;EACjB,YAAY;EACZ,YAAY;EACZ,YAAY;EACZ,YAAY;EACZ,YAAY;EACZ,YAAY;EACZ,YAAY;EACZ,YAAY;EACb,CAEiC,QAAQ,UAAU,UAAU,OAAU,CAAC,SAEpD,EACnB,OAAM,IAAI,MAAM,gDAAgD;CAIlE,IAAI,WAAW;CACf,MAAM,SAAS,IAAI,OAAmC;AACtD,KAAI,YAAY,eAAe;AAC7B,aAAW;AACX,SAAO,KAAK,GAAG,iCAAiC,YAAY,cAAc,CAAC;YAClE,YAAY,aAAa;AAClC,aAAW;AACX,SAAO,KAAK,GAAG,+BAA+B,YAAY,YAAY,CAAC;YAC9D,YAAY,SAAS;AAC9B,aAAW;AACX,SAAO,KAAK,GAAG,2BAA2B,YAAY,QAAQ,CAAC;YACtD,YAAY,iBAAiB;AACtC,aAAW;AACX,SAAO,KAAK,GAAG,mCAAmC,YAAY,gBAAgB,CAAC;YACtE,YAAY,aAAa;AAClC,aAAW;AACX,SAAO,KAAK,GAAG,+BAA+B,YAAY,YAAY,CAAC;;AAGzE,KAAI,OAAO,SAAS,GAAG;EACrB,MAAM,gBAAgB,OAAO,KAAK,MAAM,0BAA0B,EAAE,CAAC;AACrE,QAAM,IAAI,MAAM,GAAG,SAAS,sBAAsB,cAAc,KAAK,KAAK,GAAG;;;;;;;AAQjF,SAAgB,qBAAqB,aAAsC;AACzE,qBAAoB,YAAY;AAEhC,QAAO,cADc,iBAAiB,OAAO,aAAa,UAAU,CAClC;;;;;;;;;;;AAYpC,SAAgB,kBAAkB,qBAA8C;AAC9E,KAAI,oBAAoB,WAAW,EACjC,OAAM,IAAI,MAAM,8BAA8B;CAGhD,MAAM,cAAc,IAAI,aAAa,CAAC,OAAO,6BAA6B;CAE1E,IAAI,YAAY;AAChB,KAAI,oBAAoB,SAAS,YAAY,OAC3C,aAAY;KAEZ,MAAK,IAAI,IAAI,GAAG,IAAI,YAAY,QAAQ,IACtC,KAAI,oBAAoB,OAAO,YAAY,IAAI;AAC7C,cAAY;AACZ;;CAKN,MAAM,cAAc,cAAc,YAAY,oBAAoB,MAAM,YAAY,OAAO,GAAG,oBAAoB;AAClH,QAAO,iBAAiB,OAAO,aAAa,UAAU;;;;;;;;;;;AAYxD,SAAgB,mBAAmB,sBAAmD;AACpF,QAAO,qBAAqB,KAAK,OAAO,kBAAkB,GAAG,CAAC;;;;;;AAOhE,SAAgB,wBAAwB,aAAkC;CACxE,MAAM,UAAU,qBAAqB,YAAY;AACjD,QAAO,OAAO,QAAQ,SAAS,wBAAwB;;;;;AAMzD,SAAgB,kBAAkB,cAA4C;CAC5E,MAAM,QAAQ,aAAa,aAAa;AACxC,QAAO,aAAa,KACjB,OACC,IAAI,YAAY;EACd,GAAG;EACH;EACD,CAAC,CACL;;AAGH,SAAgB,UAAU,aAA0B,WAAmC;CACrF,MAAM,MAAM,aAAa,aAAa,UAAU;AAChD,QAAO,IAAI,YAAY;EACrB,GAAG;EACH;EACD,CAAC;;AAGJ,SAAS,aAAa,cAAyC;AAC7D,KAAI,aAAa,WAAW,EAC1B,OAAM,IAAI,MAAM,qCAAqC;AAGvD,KAAI,aAAa,SAAS,2BACxB,OAAM,IAAI,MAAM,mDAAmD,6BAA6B;CAGlG,MAAM,WAAW,aAAa,KAAK,OAAO;AACxC,MAAI,GAAG,MACL,OAAM,IAAI,MAAM,2CAA2C;AAI7D,SAAO,KADc,kBAAkB,GAAG,CACjB;GACzB;AAQF,QAAO,KADe,aALF,IAAI,aAAa,CAAC,OAAO,mCAAmC,EAC3D,cAAc,EACjC,QAAQ,UACT,CAAC,CAE2D,CACnC;;AAG5B,SAAgB,aAAa,aAA0B,WAA8B;CACnF,IAAI,gBAAgB;AAEpB,KAAI,UAAU,aAAa,IAAI;EAC7B,MAAM,gBAAgB,wBAAwB,YAAY;AAC1D,kBAAgB,UAAU,aAAa,OAAO,cAAc;;AAG9D,KAAI,gBAAgB,UAAU,OAC5B,iBAAgB,UAAU;AAG5B,KAAI,UAAU,SACZ,kBAAiB,UAAU;AAG7B,KAAI,UAAU,UAAU,gBAAgB,UAAU,OAChD,OAAM,IAAI,MAAM,mBAAmB,cAAc,gCAAgC,UAAU,OAAO,QAAQ;AAG5G,QAAO"}

package/sdk/index.d.ts

@@ -0,0 +1,10 @@
+import { INVALID_MICROALGOS_ERROR_MSG, algosToMicroalgos, microalgosToAlgos } from "../packages/sdk/src/convert.js";
+import { base64ToBytes, bytesToBase64, bytesToHex, bytesToString, coerceToBytes, hexToBytes } from "../packages/sdk/src/encoding/binarydata.js";
+import { IntDecoding } from "../packages/sdk/src/types/intDecoding.js";
+import { ERROR_CONTAINS_EMPTY_STRING, Encodable, EncodableClass, EncodeJSONOptions, JSONEncodingData, MsgpackEncodingData, MsgpackRawStringProvider, PrepareJSONOptions, Schema, decodeJSON, decodeMsgpack, decodeObj, encodeJSON, encodeMsgpack, encodeObj, jsonEncodingDataToMsgpackEncodingData, msgpackEncodingDataToJSONEncodingData, msgpackRawDecode, msgpackRawDecodeAsMap, msgpackRawEncode } from "../packages/sdk/src/encoding/encoding.js";
+import { decodeUint64, encodeUint64 } from "../packages/sdk/src/encoding/uint64.js";
+import { PcLineLocation, ProgramSourceMap, SourceLocation } from "../packages/sdk/src/logic/sourcemap.js";
+import { ENCODED_MULTISIG_SCHEMA, ENCODED_SUBSIG_SCHEMA, EncodedMultisig, EncodedSubsig, encodedMultiSigFromEncodingData, encodedMultiSigToEncodingData, encodedSubsigFromEncodingData, encodedSubsigToEncodingData } from "../packages/sdk/src/types/transactions/encoded.js";
+import { ParseJSONOptions, arrayEqual, concatArrays, ensureBigInt, ensureSafeInteger, ensureSafeUnsignedInteger, ensureUint64, isNode, isReactNative, parseJSON, removeUndefinedProperties, stringifyJSON } from "../packages/sdk/src/utils/utils.js";
+import { ERROR_INVALID_MICROALGOS, ERROR_MULTISIG_BAD_SENDER, MULTISIG_BAD_SENDER_ERROR_MSG, signBytes, signTransaction } from "../packages/sdk/src/index.js";
+export { ENCODED_MULTISIG_SCHEMA, ENCODED_SUBSIG_SCHEMA, ERROR_CONTAINS_EMPTY_STRING, ERROR_INVALID_MICROALGOS, ERROR_MULTISIG_BAD_SENDER, Encodable, EncodableClass, EncodeJSONOptions, EncodedMultisig, EncodedSubsig, INVALID_MICROALGOS_ERROR_MSG, IntDecoding, JSONEncodingData, MULTISIG_BAD_SENDER_ERROR_MSG, MsgpackEncodingData, MsgpackRawStringProvider, ParseJSONOptions, PcLineLocation, PrepareJSONOptions, ProgramSourceMap, Schema, SourceLocation, algosToMicroalgos, arrayEqual, base64ToBytes, bytesToBase64, bytesToHex, bytesToString, coerceToBytes, concatArrays, decodeJSON, decodeMsgpack, decodeObj, decodeUint64, encodeJSON, encodeMsgpack, encodeObj, encodeUint64, encodedMultiSigFromEncodingData, encodedMultiSigToEncodingData, encodedSubsigFromEncodingData, encodedSubsigToEncodingData, ensureBigInt, ensureSafeInteger, ensureSafeUnsignedInteger, ensureUint64, hexToBytes, isNode, isReactNative, jsonEncodingDataToMsgpackEncodingData, microalgosToAlgos, msgpackEncodingDataToJSONEncodingData, msgpackRawDecode, msgpackRawDecodeAsMap, msgpackRawEncode, parseJSON, removeUndefinedProperties, signBytes, signTransaction, stringifyJSON };

package/sdk/index.js

@@ -0,0 +1,59 @@
+const require_convert = require('../packages/sdk/src/convert.js');
+const require_intDecoding = require('../packages/sdk/src/types/intDecoding.js');
+const require_utils = require('../packages/sdk/src/utils/utils.js');
+const require_binarydata = require('../packages/sdk/src/encoding/binarydata.js');
+const require_encoding = require('../packages/sdk/src/encoding/encoding.js');
+const require_uint64 = require('../packages/sdk/src/encoding/uint64.js');
+const require_sourcemap = require('../packages/sdk/src/logic/sourcemap.js');
+const require_encoded = require('../packages/sdk/src/types/transactions/encoded.js');
+const require_index = require('../packages/sdk/src/index.js');
+
+exports.ENCODED_MULTISIG_SCHEMA = require_encoded.ENCODED_MULTISIG_SCHEMA;
+exports.ENCODED_SUBSIG_SCHEMA = require_encoded.ENCODED_SUBSIG_SCHEMA;
+exports.ERROR_CONTAINS_EMPTY_STRING = require_encoding.ERROR_CONTAINS_EMPTY_STRING;
+exports.ERROR_INVALID_MICROALGOS = require_index.ERROR_INVALID_MICROALGOS;
+exports.ERROR_MULTISIG_BAD_SENDER = require_index.ERROR_MULTISIG_BAD_SENDER;
+exports.INVALID_MICROALGOS_ERROR_MSG = require_convert.INVALID_MICROALGOS_ERROR_MSG;
+exports.IntDecoding = require_intDecoding;
+exports.MULTISIG_BAD_SENDER_ERROR_MSG = require_index.MULTISIG_BAD_SENDER_ERROR_MSG;
+exports.MsgpackRawStringProvider = require_encoding.MsgpackRawStringProvider;
+exports.ProgramSourceMap = require_sourcemap.ProgramSourceMap;
+exports.Schema = require_encoding.Schema;
+exports.algosToMicroalgos = require_convert.algosToMicroalgos;
+exports.arrayEqual = require_utils.arrayEqual;
+exports.base64ToBytes = require_binarydata.base64ToBytes;
+exports.bytesToBase64 = require_binarydata.bytesToBase64;
+exports.bytesToHex = require_binarydata.bytesToHex;
+exports.bytesToString = require_binarydata.bytesToString;
+exports.coerceToBytes = require_binarydata.coerceToBytes;
+exports.concatArrays = require_utils.concatArrays;
+exports.decodeJSON = require_encoding.decodeJSON;
+exports.decodeMsgpack = require_encoding.decodeMsgpack;
+exports.decodeObj = require_encoding.decodeObj;
+exports.decodeUint64 = require_uint64.decodeUint64;
+exports.encodeJSON = require_encoding.encodeJSON;
+exports.encodeMsgpack = require_encoding.encodeMsgpack;
+exports.encodeObj = require_encoding.encodeObj;
+exports.encodeUint64 = require_uint64.encodeUint64;
+exports.encodedMultiSigFromEncodingData = require_encoded.encodedMultiSigFromEncodingData;
+exports.encodedMultiSigToEncodingData = require_encoded.encodedMultiSigToEncodingData;
+exports.encodedSubsigFromEncodingData = require_encoded.encodedSubsigFromEncodingData;
+exports.encodedSubsigToEncodingData = require_encoded.encodedSubsigToEncodingData;
+exports.ensureBigInt = require_utils.ensureBigInt;
+exports.ensureSafeInteger = require_utils.ensureSafeInteger;
+exports.ensureSafeUnsignedInteger = require_utils.ensureSafeUnsignedInteger;
+exports.ensureUint64 = require_utils.ensureUint64;
+exports.hexToBytes = require_binarydata.hexToBytes;
+exports.isNode = require_utils.isNode;
+exports.isReactNative = require_utils.isReactNative;
+exports.jsonEncodingDataToMsgpackEncodingData = require_encoding.jsonEncodingDataToMsgpackEncodingData;
+exports.microalgosToAlgos = require_convert.microalgosToAlgos;
+exports.msgpackEncodingDataToJSONEncodingData = require_encoding.msgpackEncodingDataToJSONEncodingData;
+exports.msgpackRawDecode = require_encoding.msgpackRawDecode;
+exports.msgpackRawDecodeAsMap = require_encoding.msgpackRawDecodeAsMap;
+exports.msgpackRawEncode = require_encoding.msgpackRawEncode;
+exports.parseJSON = require_utils.parseJSON;
+exports.removeUndefinedProperties = require_utils.removeUndefinedProperties;
+exports.signBytes = require_index.signBytes;
+exports.signTransaction = require_index.signTransaction;
+exports.stringifyJSON = require_utils.stringifyJSON;

package/sdk/index.mjs

@@ -0,0 +1,11 @@
+import { INVALID_MICROALGOS_ERROR_MSG, algosToMicroalgos, microalgosToAlgos } from "../packages/sdk/src/convert.mjs";
+import intDecoding_default from "../packages/sdk/src/types/intDecoding.mjs";
+import { arrayEqual, concatArrays, ensureBigInt, ensureSafeInteger, ensureSafeUnsignedInteger, ensureUint64, isNode, isReactNative, parseJSON, removeUndefinedProperties, stringifyJSON } from "../packages/sdk/src/utils/utils.mjs";
+import { base64ToBytes, bytesToBase64, bytesToHex, bytesToString, coerceToBytes, hexToBytes } from "../packages/sdk/src/encoding/binarydata.mjs";
+import { ERROR_CONTAINS_EMPTY_STRING, MsgpackRawStringProvider, Schema, decodeJSON, decodeMsgpack, decodeObj, encodeJSON, encodeMsgpack, encodeObj, jsonEncodingDataToMsgpackEncodingData, msgpackEncodingDataToJSONEncodingData, msgpackRawDecode, msgpackRawDecodeAsMap, msgpackRawEncode } from "../packages/sdk/src/encoding/encoding.mjs";
+import { decodeUint64, encodeUint64 } from "../packages/sdk/src/encoding/uint64.mjs";
+import { ProgramSourceMap } from "../packages/sdk/src/logic/sourcemap.mjs";
+import { ENCODED_MULTISIG_SCHEMA, ENCODED_SUBSIG_SCHEMA, encodedMultiSigFromEncodingData, encodedMultiSigToEncodingData, encodedSubsigFromEncodingData, encodedSubsigToEncodingData } from "../packages/sdk/src/types/transactions/encoded.mjs";
+import { ERROR_INVALID_MICROALGOS, ERROR_MULTISIG_BAD_SENDER, MULTISIG_BAD_SENDER_ERROR_MSG, signBytes, signTransaction } from "../packages/sdk/src/index.mjs";
+
+export { ENCODED_MULTISIG_SCHEMA, ENCODED_SUBSIG_SCHEMA, ERROR_CONTAINS_EMPTY_STRING, ERROR_INVALID_MICROALGOS, ERROR_MULTISIG_BAD_SENDER, INVALID_MICROALGOS_ERROR_MSG, intDecoding_default as IntDecoding, MULTISIG_BAD_SENDER_ERROR_MSG, MsgpackRawStringProvider, ProgramSourceMap, Schema, algosToMicroalgos, arrayEqual, base64ToBytes, bytesToBase64, bytesToHex, bytesToString, coerceToBytes, concatArrays, decodeJSON, decodeMsgpack, decodeObj, decodeUint64, encodeJSON, encodeMsgpack, encodeObj, encodeUint64, encodedMultiSigFromEncodingData, encodedMultiSigToEncodingData, encodedSubsigFromEncodingData, encodedSubsigToEncodingData, ensureBigInt, ensureSafeInteger, ensureSafeUnsignedInteger, ensureUint64, hexToBytes, isNode, isReactNative, jsonEncodingDataToMsgpackEncodingData, microalgosToAlgos, msgpackEncodingDataToJSONEncodingData, msgpackRawDecode, msgpackRawDecodeAsMap, msgpackRawEncode, parseJSON, removeUndefinedProperties, signBytes, signTransaction, stringifyJSON };

package/testing/account.d.ts

@@ -1,10 +1,12 @@
-import algosdk, { Address } from 'algosdk';
-import { AlgorandClient } from '../';
-import { TransactionSignerAccount } from '../types/account';
-import { GetTestAccountParams } from '../types/testing';
-import Account = algosdk.Account;
-import Algodv2 = algosdk.Algodv2;
-import Kmd = algosdk.Kmd;
+import { Address } from "../packages/common/src/address.js";
+import { AddressWithSigners, AddressWithTransactionSigner } from "../packages/transact/src/signer.js";
+import { AlgodClient } from "../packages/algod_client/src/client.js";
+import { KmdClient } from "../packages/kmd_client/src/client.js";
+import { AlgorandClient } from "../types/algorand-client.js";
+import { GetTestAccountParams } from "../types/testing.js";
+
+//#region src/testing/account.d.ts
+
 /**
  * @deprecated Use `getTestAccount(params, algorandClient)` instead. The `algorandClient` object can be created using `AlgorandClient.fromClients({ algod, kmd })`.
  *
@@ -17,7 +19,7 @@ import Kmd = algosdk.Kmd;
  * @param kmd A KMD client, if not specified then a default KMD client will be loaded from environment variables and if not found fallback to the default LocalNet KMD client
  * @returns The account, with private key loaded
  */
-export declare function getTestAccount(params: GetTestAccountParams, algod: Algodv2, kmd?: Kmd): Promise<Address & Account & TransactionSignerAccount>;
+declare function getTestAccount(params: GetTestAccountParams, algod: AlgodClient, kmd?: KmdClient): Promise<Address & AddressWithTransactionSigner>;
 /**
  * Creates an ephemeral Algorand account for the purposes of testing.
  * Returns a newly created random test account that is funded from the dispenser
@@ -27,4 +29,7 @@ export declare function getTestAccount(params: GetTestAccountParams, algod: Algo
  * @param algorand An AlgorandClient client
  * @returns The account, with private key loaded
  */
-export declare function getTestAccount(params: GetTestAccountParams, algorand: AlgorandClient): Promise<Address & Account & TransactionSignerAccount>;
+declare function getTestAccount(params: GetTestAccountParams, algorand: AlgorandClient): Promise<Address & AddressWithSigners>;
+//#endregion
+export { getTestAccount };
+//# sourceMappingURL=account.d.ts.map

package/testing/account.js

@@ -1,36 +1,32 @@
-'use strict';
-
-var algosdk = require('algosdk');
-var types_algorandClient = require('../types/algorand-client.js');
-var config = require('../config.js');
+const require_address = require('../packages/common/src/address.js');
+const require_config = require('../config.js');
+const require_algorand_client = require('../types/algorand-client.js');
 
+//#region src/testing/account.ts
 async function getTestAccount({ suppressLog, initialFunds, accountGetter }, algodOrAlgorandClient, kmd) {
-    const algorand = algodOrAlgorandClient instanceof types_algorandClient.AlgorandClient
-        ? algodOrAlgorandClient
-        : types_algorandClient.AlgorandClient.fromClients({
-            algod: algodOrAlgorandClient,
-            kmd,
-        });
-    const account = accountGetter ? await accountGetter(algorand) : algosdk.generateAccount();
-    config.Config.getLogger(suppressLog).info(`New test account created with address '${account.addr}' and mnemonic '${algosdk.secretKeyToMnemonic(account.sk)}'.`);
-    const dispenser = await algorand.account.dispenserFromEnvironment();
-    await algorand.send.payment({
-        sender: dispenser,
-        receiver: account.addr,
-        amount: initialFunds,
-        note: 'Funding test account',
-        suppressLog,
-    });
-    const accountInfo = await algorand.account.getInformation(account.addr);
-    config.Config.getLogger(suppressLog).info('Test account funded; account balance: %d µALGO', accountInfo.balance.microAlgo);
-    algorand.setSignerFromAccount(account);
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    const address = algosdk.Address.fromString(account.addr.toString());
-    address.addr = account.addr;
-    address.sk = account.sk;
-    address.signer = algorand.account.getSigner(address);
-    return address;
+	const algorand = algodOrAlgorandClient instanceof require_algorand_client.AlgorandClient ? algodOrAlgorandClient : require_algorand_client.AlgorandClient.fromClients({
+		algod: algodOrAlgorandClient,
+		kmd
+	});
+	const account = accountGetter ? await accountGetter(algorand) : algorand.account.random();
+	require_config.Config.getLogger(suppressLog).info(`New test account created with address '${account.addr}'.`);
+	const dispenser = await algorand.account.dispenserFromEnvironment();
+	await algorand.send.payment({
+		sender: dispenser,
+		receiver: account.addr,
+		amount: initialFunds,
+		note: "Funding test account",
+		suppressLog
+	});
+	const accountInfo = await algorand.account.getInformation(account.addr);
+	require_config.Config.getLogger(suppressLog).info("Test account funded; account balance: %d µALGO", accountInfo.balance.microAlgo);
+	algorand.setSignerFromAccount(account);
+	const address = require_address.Address.fromString(account.addr.toString());
+	address.addr = account.addr;
+	address.signer = algorand.account.getSigner(address);
+	return address;
 }
 
+//#endregion
 exports.getTestAccount = getTestAccount;
-//# sourceMappingURL=account.js.map
+//# sourceMappingURL=account.js.map

package/testing/account.js.map

@@ -1 +1 @@
-{"version":3,"file":"account.js","sources":["../../src/testing/account.ts"],"sourcesContent":["import algosdk, { Address } from 'algosdk'\nimport { AlgorandClient, Config } from '../'\nimport { TransactionSignerAccount } from '../types/account'\nimport { GetTestAccountParams } from '../types/testing'\nimport Account = algosdk.Account\nimport Algodv2 = algosdk.Algodv2\nimport Kmd = algosdk.Kmd\n\n/**\n * @deprecated Use `getTestAccount(params, algorandClient)` instead. The `algorandClient` object can be created using `AlgorandClient.fromClients({ algod, kmd })`.\n *\n * Creates an ephemeral Algorand account for the purposes of testing.\n * Returns a newly created random test account that is funded from the dispenser\n * DO NOT USE THIS TO CREATE A MAINNET ACCOUNT!\n * Note: By default this will log the mnemonic of the account.\n * @param params The config for the test account to generate\n * @param algod An algod client\n * @param kmd A KMD client, if not specified then a default KMD client will be loaded from environment variables and if not found fallback to the default LocalNet KMD client\n * @returns The account, with private key loaded\n */\nexport async function getTestAccount(\n  params: GetTestAccountParams,\n  algod: Algodv2,\n  kmd?: Kmd,\n): Promise<Address & Account & TransactionSignerAccount>\n/**\n * Creates an ephemeral Algorand account for the purposes of testing.\n * Returns a newly created random test account that is funded from the dispenser\n * DO NOT USE THIS TO CREATE A MAINNET ACCOUNT!\n * Note: By default this will log the mnemonic of the account.\n * @param params The config for the test account to generate\n * @param algorand An AlgorandClient client\n * @returns The account, with private key loaded\n */\nexport async function getTestAccount(\n  params: GetTestAccountParams,\n  algorand: AlgorandClient,\n): Promise<Address & Account & TransactionSignerAccount>\nexport async function getTestAccount(\n  { suppressLog, initialFunds, accountGetter }: GetTestAccountParams,\n  algodOrAlgorandClient: Algodv2 | AlgorandClient,\n  kmd?: Kmd,\n): Promise<Address & Account & TransactionSignerAccount> {\n  const algorand =\n    algodOrAlgorandClient instanceof AlgorandClient\n      ? algodOrAlgorandClient\n      : AlgorandClient.fromClients({\n          algod: algodOrAlgorandClient,\n          kmd,\n        })\n\n  const account = accountGetter ? await accountGetter(algorand) : algosdk.generateAccount()\n\n  Config.getLogger(suppressLog).info(\n    `New test account created with address '${account.addr}' and mnemonic '${algosdk.secretKeyToMnemonic(account.sk)}'.`,\n  )\n\n  const dispenser = await algorand.account.dispenserFromEnvironment()\n\n  await algorand.send.payment({\n    sender: dispenser,\n    receiver: account.addr,\n    amount: initialFunds,\n    note: 'Funding test account',\n    suppressLog,\n  })\n\n  const accountInfo = await algorand.account.getInformation(account.addr)\n\n  Config.getLogger(suppressLog).info('Test account funded; account balance: %d µALGO', accountInfo.balance.microAlgo)\n\n  algorand.setSignerFromAccount(account)\n\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  const address = Address.fromString(account.addr.toString()) as any\n  address.addr = account.addr\n  address.sk = account.sk\n  address.signer = algorand.account.getSigner(address)\n\n  return address\n}\n"],"names":["AlgorandClient","Config","Address"],"mappings":";;;;;;AAsCO,eAAe,cAAc,CAClC,EAAE,WAAW,EAAE,YAAY,EAAE,aAAa,EAAwB,EAClE,qBAA+C,EAC/C,GAAS,EAAA;AAET,IAAA,MAAM,QAAQ,GACZ,qBAAqB,YAAYA;AAC/B,UAAE;AACF,UAAEA,mCAAc,CAAC,WAAW,CAAC;AACzB,YAAA,KAAK,EAAE,qBAAqB;YAC5B,GAAG;AACJ,SAAA,CAAC;AAER,IAAA,MAAM,OAAO,GAAG,aAAa,GAAG,MAAM,aAAa,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,eAAe,EAAE;IAEzFC,aAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,IAAI,CAChC,CAAA,uCAAA,EAA0C,OAAO,CAAC,IAAI,CAAmB,gBAAA,EAAA,OAAO,CAAC,mBAAmB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAI,EAAA,CAAA,CACrH;IAED,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,wBAAwB,EAAE;AAEnE,IAAA,MAAM,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC;AAC1B,QAAA,MAAM,EAAE,SAAS;QACjB,QAAQ,EAAE,OAAO,CAAC,IAAI;AACtB,QAAA,MAAM,EAAE,YAAY;AACpB,QAAA,IAAI,EAAE,sBAAsB;QAC5B,WAAW;AACZ,KAAA,CAAC;AAEF,IAAA,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC;AAEvE,IAAAA,aAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,gDAAgD,EAAE,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC;AAEnH,IAAA,QAAQ,CAAC,oBAAoB,CAAC,OAAO,CAAC;;AAGtC,IAAA,MAAM,OAAO,GAAGC,eAAO,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAQ;AAClE,IAAA,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI;AAC3B,IAAA,OAAO,CAAC,EAAE,GAAG,OAAO,CAAC,EAAE;IACvB,OAAO,CAAC,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC;AAEpD,IAAA,OAAO,OAAO;AAChB;;;;"}
+{"version":3,"file":"account.js","names":["AlgorandClient","Address"],"sources":["../../src/testing/account.ts"],"sourcesContent":["import { AlgodClient } from '@algorandfoundation/algokit-algod-client'\nimport { Address } from '@algorandfoundation/algokit-common'\nimport { AddressWithSigners, AddressWithTransactionSigner } from '@algorandfoundation/algokit-transact'\nimport { KmdClient } from '@algorandfoundation/algokit-kmd-client'\nimport { AlgorandClient, Config } from '../'\nimport { GetTestAccountParams } from '../types/testing'\n\n/**\n * @deprecated Use `getTestAccount(params, algorandClient)` instead. The `algorandClient` object can be created using `AlgorandClient.fromClients({ algod, kmd })`.\n *\n * Creates an ephemeral Algorand account for the purposes of testing.\n * Returns a newly created random test account that is funded from the dispenser\n * DO NOT USE THIS TO CREATE A MAINNET ACCOUNT!\n * Note: By default this will log the mnemonic of the account.\n * @param params The config for the test account to generate\n * @param algod An algod client\n * @param kmd A KMD client, if not specified then a default KMD client will be loaded from environment variables and if not found fallback to the default LocalNet KMD client\n * @returns The account, with private key loaded\n */\nexport async function getTestAccount(\n  params: GetTestAccountParams,\n  algod: AlgodClient,\n  kmd?: KmdClient,\n): Promise<Address & AddressWithTransactionSigner>\n/**\n * Creates an ephemeral Algorand account for the purposes of testing.\n * Returns a newly created random test account that is funded from the dispenser\n * DO NOT USE THIS TO CREATE A MAINNET ACCOUNT!\n * Note: By default this will log the mnemonic of the account.\n * @param params The config for the test account to generate\n * @param algorand An AlgorandClient client\n * @returns The account, with private key loaded\n */\nexport async function getTestAccount(params: GetTestAccountParams, algorand: AlgorandClient): Promise<Address & AddressWithSigners>\nexport async function getTestAccount(\n  { suppressLog, initialFunds, accountGetter }: GetTestAccountParams,\n  algodOrAlgorandClient: AlgodClient | AlgorandClient,\n  kmd?: KmdClient,\n): Promise<Address & AddressWithTransactionSigner> {\n  const algorand =\n    algodOrAlgorandClient instanceof AlgorandClient\n      ? algodOrAlgorandClient\n      : AlgorandClient.fromClients({\n          algod: algodOrAlgorandClient,\n          kmd,\n        })\n\n  const account = accountGetter ? await accountGetter(algorand) : algorand.account.random()\n\n  Config.getLogger(suppressLog).info(`New test account created with address '${account.addr}'.`)\n\n  const dispenser = await algorand.account.dispenserFromEnvironment()\n\n  await algorand.send.payment({\n    sender: dispenser,\n    receiver: account.addr,\n    amount: initialFunds,\n    note: 'Funding test account',\n    suppressLog,\n  })\n\n  const accountInfo = await algorand.account.getInformation(account.addr)\n\n  Config.getLogger(suppressLog).info('Test account funded; account balance: %d µALGO', accountInfo.balance.microAlgo)\n\n  algorand.setSignerFromAccount(account)\n\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  const address = Address.fromString(account.addr.toString()) as any\n  address.addr = account.addr\n  address.signer = algorand.account.getSigner(address)\n\n  return address\n}\n"],"mappings":";;;;;AAkCA,eAAsB,eACpB,EAAE,aAAa,cAAc,iBAC7B,uBACA,KACiD;CACjD,MAAM,WACJ,iCAAiCA,yCAC7B,wBACAA,uCAAe,YAAY;EACzB,OAAO;EACP;EACD,CAAC;CAER,MAAM,UAAU,gBAAgB,MAAM,cAAc,SAAS,GAAG,SAAS,QAAQ,QAAQ;AAEzF,uBAAO,UAAU,YAAY,CAAC,KAAK,0CAA0C,QAAQ,KAAK,IAAI;CAE9F,MAAM,YAAY,MAAM,SAAS,QAAQ,0BAA0B;AAEnE,OAAM,SAAS,KAAK,QAAQ;EAC1B,QAAQ;EACR,UAAU,QAAQ;EAClB,QAAQ;EACR,MAAM;EACN;EACD,CAAC;CAEF,MAAM,cAAc,MAAM,SAAS,QAAQ,eAAe,QAAQ,KAAK;AAEvE,uBAAO,UAAU,YAAY,CAAC,KAAK,kDAAkD,YAAY,QAAQ,UAAU;AAEnH,UAAS,qBAAqB,QAAQ;CAGtC,MAAM,UAAUC,wBAAQ,WAAW,QAAQ,KAAK,UAAU,CAAC;AAC3D,SAAQ,OAAO,QAAQ;AACvB,SAAQ,SAAS,SAAS,QAAQ,UAAU,QAAQ;AAEpD,QAAO"}