@algorandfoundation/algokit-utils 10.0.0-alpha.4 → 10.0.0-alpha.41

package/amount.js.map

@@ -1 +1 @@
-{"version":3,"file":"amount.js","names":["AlgoAmount","algos","microAlgos"],"sources":["../src/amount.ts"],"sourcesContent":["import { AlgoAmount } from './types/amount'\n\ndeclare global {\n  interface Number {\n    /**\n     * Returns an `AlgoAmount` using this number of microAlgo.\n     */\n    microAlgos(this: number): AlgoAmount\n    /**\n     * Returns an `AlgoAmount` using this number of Algo.\n     */\n    algos(this: number): AlgoAmount\n    /**\n     * Returns an `AlgoAmount` using this number of microAlgo.\n     */\n    microAlgo(this: number): AlgoAmount\n    /**\n     * Returns an `AlgoAmount` using this number of Algo.\n     */\n    algo(this: number): AlgoAmount\n  }\n  interface BigInt {\n    /**\n     * Returns an `AlgoAmount` using this number of microAlgo.\n     */\n    microAlgo(this: bigint): AlgoAmount\n    /**\n     * Returns an `AlgoAmount` using this number of Algo.\n     */\n    algo(this: bigint): AlgoAmount\n  }\n}\n\nNumber.prototype.microAlgos = function () {\n  return AlgoAmount.MicroAlgo(this)\n}\n\nNumber.prototype.algos = function () {\n  return AlgoAmount.Algo(this)\n}\n\nNumber.prototype.microAlgo = function () {\n  return AlgoAmount.MicroAlgo(this)\n}\n\nNumber.prototype.algo = function () {\n  return AlgoAmount.Algo(this)\n}\n\nBigInt.prototype.microAlgo = function () {\n  return AlgoAmount.MicroAlgo(this)\n}\n\nBigInt.prototype.algo = function () {\n  return AlgoAmount.Algo(this)\n}\n\n/** Returns an amount of Algo using AlgoAmount\n * @param algos The amount of Algo\n */\nexport const algos = (algos: number | bigint) => {\n  return AlgoAmount.Algo(algos)\n}\n\n/** Returns an amount of Algo using AlgoAmount\n * @param algos The amount of Algo\n */\nexport const algo = (algos: number | bigint) => {\n  return AlgoAmount.Algo(algos)\n}\n\n/** Returns an amount of µAlgo using AlgoAmount\n * @param microAlgos The amount of µAlgo\n */\nexport const microAlgos = (microAlgos: number | bigint) => {\n  return AlgoAmount.MicroAlgo(microAlgos)\n}\n\n/** Returns an amount of µAlgo using AlgoAmount\n * @param microAlgos The amount of µAlgo\n */\nexport const microAlgo = (microAlgos: number | bigint) => {\n  return AlgoAmount.MicroAlgo(microAlgos)\n}\n\n/** Returns an amount of µAlgo to cover standard fees for the given number of transactions using AlgoAmount\n * @param numberOfTransactions The of standard transaction fees to return the amount of Algo\n */\nexport const transactionFees = (numberOfTransactions: number) => {\n  return AlgoAmount.MicroAlgo(BigInt(numberOfTransactions) * ALGORAND_MIN_TX_FEE.microAlgo)\n}\n\nexport const ALGORAND_MIN_TX_FEE = AlgoAmount.MicroAlgo(1_000)\n"],"mappings":";;;AAiCA,OAAO,UAAU,aAAa,WAAY;AACxC,QAAOA,0BAAW,UAAU,KAAK;;AAGnC,OAAO,UAAU,QAAQ,WAAY;AACnC,QAAOA,0BAAW,KAAK,KAAK;;AAG9B,OAAO,UAAU,YAAY,WAAY;AACvC,QAAOA,0BAAW,UAAU,KAAK;;AAGnC,OAAO,UAAU,OAAO,WAAY;AAClC,QAAOA,0BAAW,KAAK,KAAK;;AAG9B,OAAO,UAAU,YAAY,WAAY;AACvC,QAAOA,0BAAW,UAAU,KAAK;;AAGnC,OAAO,UAAU,OAAO,WAAY;AAClC,QAAOA,0BAAW,KAAK,KAAK;;;;;AAM9B,MAAa,SAAS,YAA2B;AAC/C,QAAOA,0BAAW,KAAKC,QAAM;;;;;AAM/B,MAAa,QAAQ,YAA2B;AAC9C,QAAOD,0BAAW,KAAKC,QAAM;;;;;AAM/B,MAAa,cAAc,iBAAgC;AACzD,QAAOD,0BAAW,UAAUE,aAAW;;;;;AAMzC,MAAa,aAAa,iBAAgC;AACxD,QAAOF,0BAAW,UAAUE,aAAW;;;;;AAMzC,MAAa,mBAAmB,yBAAiC;AAC/D,QAAOF,0BAAW,UAAU,OAAO,qBAAqB,GAAG,oBAAoB,UAAU;;AAG3F,MAAa,sBAAsBA,0BAAW,UAAU,IAAM"}
+{"version":3,"file":"amount.js","names":[],"sources":["../src/amount.ts"],"sourcesContent":["/** Wrapper class to ensure safe, explicit conversion between µAlgo, Algo and numbers */\nexport class AlgoAmount {\n  private amountInMicroAlgo: bigint\n\n  /** Return the amount as a number in µAlgo */\n  get microAlgos() {\n    return this.amountInMicroAlgo\n  }\n\n  /** Return the amount as a number in µAlgo */\n  get microAlgo() {\n    return this.amountInMicroAlgo\n  }\n\n  /** Return the amount as a number in Algo */\n  get algos() {\n    return microalgosToAlgos(Number(this.amountInMicroAlgo))\n  }\n\n  /** Return the amount as a number in Algo */\n  get algo() {\n    return microalgosToAlgos(Number(this.amountInMicroAlgo))\n  }\n\n  /**\n   * Create a new `AlgoAmount` instance.\n   *\n   * @param amount - An object specifying the amount in Algo or µALGO. Use the key 'algo' for Algo amounts and 'microAlgo' for µALGO.\n   * @returns A new instance of `AlgoAmount` representing the specified amount.\n   * @example\n   * ```typescript\n   * const amount = new AlgoAmount({ algo: 5 });\n   * ```\n   */\n  constructor(\n    amount: { algos: number | bigint } | { algo: number | bigint } | { microAlgos: number | bigint } | { microAlgo: number | bigint },\n  ) {\n    this.amountInMicroAlgo =\n      'microAlgos' in amount\n        ? BigInt(amount.microAlgos)\n        : 'microAlgo' in amount\n          ? BigInt(amount.microAlgo)\n          : 'algos' in amount\n            ? BigInt(algosToMicroalgos(Number(amount.algos)))\n            : BigInt(algosToMicroalgos(Number(amount.algo)))\n  }\n\n  toString(): string {\n    return `${this.microAlgo.toLocaleString('en-US')} µALGO`\n  }\n\n  /** valueOf allows you to use `AlgoAmount` in comparison operations such as `<` and `>=` etc.,\n   * but it's not recommended to use this to convert to a number, it's much safer to explicitly call\n   * the algos or microAlgos properties\n   */\n  valueOf(): number {\n    return Number(this.microAlgo)\n  }\n\n  /** Create a `AlgoAmount` object representing the given number of Algo */\n  static Algos(amount: number | bigint) {\n    return new AlgoAmount({ algos: amount })\n  }\n\n  /** Create a `AlgoAmount` object representing the given number of Algo */\n  static Algo(amount: number | bigint) {\n    return new AlgoAmount({ algos: amount })\n  }\n\n  /** Create a `AlgoAmount` object representing the given number of µAlgo */\n  static MicroAlgos(amount: number | bigint) {\n    return new AlgoAmount({ microAlgos: amount })\n  }\n\n  /** Create a `AlgoAmount` object representing the given number of µAlgo */\n  static MicroAlgo(amount: number | bigint) {\n    return new AlgoAmount({ microAlgos: amount })\n  }\n}\n\nconst MICROALGOS_TO_ALGOS_RATIO = 1e6\nconst INVALID_MICROALGOS_ERROR_MSG = 'Microalgos should be positive and less than 2^53 - 1.'\n\n/**\n * microalgosToAlgos converts microalgos to algos\n * @param microalgos - number\n * @returns number\n */\nfunction microalgosToAlgos(microalgos: number) {\n  if (microalgos < 0 || !Number.isSafeInteger(microalgos)) {\n    throw new Error(INVALID_MICROALGOS_ERROR_MSG)\n  }\n  return microalgos / MICROALGOS_TO_ALGOS_RATIO\n}\n\n/**\n * algosToMicroalgos converts algos to microalgos\n * @param algos - number\n * @returns number\n */\nfunction algosToMicroalgos(algos: number) {\n  const microalgos = algos * MICROALGOS_TO_ALGOS_RATIO\n  return Math.round(microalgos)\n}\n\ndeclare global {\n  interface Number {\n    /**\n     * Returns an `AlgoAmount` using this number of microAlgo.\n     */\n    microAlgos(this: number): AlgoAmount\n    /**\n     * Returns an `AlgoAmount` using this number of Algo.\n     */\n    algos(this: number): AlgoAmount\n    /**\n     * Returns an `AlgoAmount` using this number of microAlgo.\n     */\n    microAlgo(this: number): AlgoAmount\n    /**\n     * Returns an `AlgoAmount` using this number of Algo.\n     */\n    algo(this: number): AlgoAmount\n  }\n  interface BigInt {\n    /**\n     * Returns an `AlgoAmount` using this number of microAlgo.\n     */\n    microAlgo(this: bigint): AlgoAmount\n    /**\n     * Returns an `AlgoAmount` using this number of Algo.\n     */\n    algo(this: bigint): AlgoAmount\n  }\n}\n\nNumber.prototype.microAlgos = function () {\n  return AlgoAmount.MicroAlgo(this)\n}\n\nNumber.prototype.algos = function () {\n  return AlgoAmount.Algo(this)\n}\n\nNumber.prototype.microAlgo = function () {\n  return AlgoAmount.MicroAlgo(this)\n}\n\nNumber.prototype.algo = function () {\n  return AlgoAmount.Algo(this)\n}\n\nBigInt.prototype.microAlgo = function () {\n  return AlgoAmount.MicroAlgo(this)\n}\n\nBigInt.prototype.algo = function () {\n  return AlgoAmount.Algo(this)\n}\n\n/** Returns an amount of Algo using AlgoAmount\n * @param algos The amount of Algo\n * @example\n * {@includeCode ./amount.spec.ts#example-algos}\n * @see {@link AlgoAmount}\n */\nexport const algos = (algos: number | bigint) => {\n  return AlgoAmount.Algo(algos)\n}\n\n/** Returns an amount of Algo using AlgoAmount\n * @param algos The amount of Algo\n * @example\n * {@includeCode ./amount.spec.ts#example-algo}\n */\nexport const algo = (algos: number | bigint) => {\n  return AlgoAmount.Algo(algos)\n}\n\n/** Returns an amount of µAlgo using AlgoAmount\n * @param microAlgos The amount of µAlgo\n * @example\n * {@includeCode ./amount.spec.ts#example-microAlgos}\n * @see {@link algos} for Algo denomination\n */\nexport const microAlgos = (microAlgos: number | bigint) => {\n  return AlgoAmount.MicroAlgo(microAlgos)\n}\n\n/** Returns an amount of µAlgo using AlgoAmount\n * @param microAlgos The amount of µAlgo\n * @example\n * {@includeCode ./amount.spec.ts#example-microAlgo}\n */\nexport const microAlgo = (microAlgos: number | bigint) => {\n  return AlgoAmount.MicroAlgo(microAlgos)\n}\n\n/** Returns an amount of µAlgo to cover standard fees for the given number of transactions using AlgoAmount\n * @param numberOfTransactions The of standard transaction fees to return the amount of Algo\n * @example\n * {@includeCode ./amount.spec.ts#example-transactionFees}\n */\nexport const transactionFees = (numberOfTransactions: number) => {\n  return AlgoAmount.MicroAlgo(BigInt(numberOfTransactions) * ALGORAND_MIN_TX_FEE.microAlgo)\n}\n\nexport const ALGORAND_MIN_TX_FEE = AlgoAmount.MicroAlgo(1_000)\n"],"mappings":";;;;AACA,IAAa,aAAb,MAAa,WAAW;CACtB,AAAQ;;CAGR,IAAI,aAAa;AACf,SAAO,KAAK;;;CAId,IAAI,YAAY;AACd,SAAO,KAAK;;;CAId,IAAI,QAAQ;AACV,SAAO,kBAAkB,OAAO,KAAK,kBAAkB,CAAC;;;CAI1D,IAAI,OAAO;AACT,SAAO,kBAAkB,OAAO,KAAK,kBAAkB,CAAC;;;;;;;;;;;;CAa1D,YACE,QACA;AACA,OAAK,oBACH,gBAAgB,SACZ,OAAO,OAAO,WAAW,GACzB,eAAe,SACb,OAAO,OAAO,UAAU,GACxB,WAAW,SACT,OAAO,kBAAkB,OAAO,OAAO,MAAM,CAAC,CAAC,GAC/C,OAAO,kBAAkB,OAAO,OAAO,KAAK,CAAC,CAAC;;CAG1D,WAAmB;AACjB,SAAO,GAAG,KAAK,UAAU,eAAe,QAAQ,CAAC;;;;;;CAOnD,UAAkB;AAChB,SAAO,OAAO,KAAK,UAAU;;;CAI/B,OAAO,MAAM,QAAyB;AACpC,SAAO,IAAI,WAAW,EAAE,OAAO,QAAQ,CAAC;;;CAI1C,OAAO,KAAK,QAAyB;AACnC,SAAO,IAAI,WAAW,EAAE,OAAO,QAAQ,CAAC;;;CAI1C,OAAO,WAAW,QAAyB;AACzC,SAAO,IAAI,WAAW,EAAE,YAAY,QAAQ,CAAC;;;CAI/C,OAAO,UAAU,QAAyB;AACxC,SAAO,IAAI,WAAW,EAAE,YAAY,QAAQ,CAAC;;;AAIjD,MAAM,4BAA4B;AAClC,MAAM,+BAA+B;;;;;;AAOrC,SAAS,kBAAkB,YAAoB;AAC7C,KAAI,aAAa,KAAK,CAAC,OAAO,cAAc,WAAW,CACrD,OAAM,IAAI,MAAM,6BAA6B;AAE/C,QAAO,aAAa;;;;;;;AAQtB,SAAS,kBAAkB,OAAe;CACxC,MAAM,aAAa,QAAQ;AAC3B,QAAO,KAAK,MAAM,WAAW;;AAkC/B,OAAO,UAAU,aAAa,WAAY;AACxC,QAAO,WAAW,UAAU,KAAK;;AAGnC,OAAO,UAAU,QAAQ,WAAY;AACnC,QAAO,WAAW,KAAK,KAAK;;AAG9B,OAAO,UAAU,YAAY,WAAY;AACvC,QAAO,WAAW,UAAU,KAAK;;AAGnC,OAAO,UAAU,OAAO,WAAY;AAClC,QAAO,WAAW,KAAK,KAAK;;AAG9B,OAAO,UAAU,YAAY,WAAY;AACvC,QAAO,WAAW,UAAU,KAAK;;AAGnC,OAAO,UAAU,OAAO,WAAY;AAClC,QAAO,WAAW,KAAK,KAAK;;;;;;;;AAS9B,MAAa,SAAS,UAA2B;AAC/C,QAAO,WAAW,KAAK,MAAM;;;;;;;AAQ/B,MAAa,QAAQ,UAA2B;AAC9C,QAAO,WAAW,KAAK,MAAM;;;;;;;;AAS/B,MAAa,cAAc,eAAgC;AACzD,QAAO,WAAW,UAAU,WAAW;;;;;;;AAQzC,MAAa,aAAa,eAAgC;AACxD,QAAO,WAAW,UAAU,WAAW;;;;;;;AAQzC,MAAa,mBAAmB,yBAAiC;AAC/D,QAAO,WAAW,UAAU,OAAO,qBAAqB,GAAG,oBAAoB,UAAU;;AAG3F,MAAa,sBAAsB,WAAW,UAAU,IAAM"}

package/amount.mjs

@@ -1,6 +1,83 @@
-import { AlgoAmount } from "./types/amount.mjs";
-
 //#region src/amount.ts
+/** Wrapper class to ensure safe, explicit conversion between µAlgo, Algo and numbers */
+var AlgoAmount = class AlgoAmount {
+	amountInMicroAlgo;
+	/** Return the amount as a number in µAlgo */
+	get microAlgos() {
+		return this.amountInMicroAlgo;
+	}
+	/** Return the amount as a number in µAlgo */
+	get microAlgo() {
+		return this.amountInMicroAlgo;
+	}
+	/** Return the amount as a number in Algo */
+	get algos() {
+		return microalgosToAlgos(Number(this.amountInMicroAlgo));
+	}
+	/** Return the amount as a number in Algo */
+	get algo() {
+		return microalgosToAlgos(Number(this.amountInMicroAlgo));
+	}
+	/**
+	* Create a new `AlgoAmount` instance.
+	*
+	* @param amount - An object specifying the amount in Algo or µALGO. Use the key 'algo' for Algo amounts and 'microAlgo' for µALGO.
+	* @returns A new instance of `AlgoAmount` representing the specified amount.
+	* @example
+	* ```typescript
+	* const amount = new AlgoAmount({ algo: 5 });
+	* ```
+	*/
+	constructor(amount) {
+		this.amountInMicroAlgo = "microAlgos" in amount ? BigInt(amount.microAlgos) : "microAlgo" in amount ? BigInt(amount.microAlgo) : "algos" in amount ? BigInt(algosToMicroalgos(Number(amount.algos))) : BigInt(algosToMicroalgos(Number(amount.algo)));
+	}
+	toString() {
+		return `${this.microAlgo.toLocaleString("en-US")} µALGO`;
+	}
+	/** valueOf allows you to use `AlgoAmount` in comparison operations such as `<` and `>=` etc.,
+	* but it's not recommended to use this to convert to a number, it's much safer to explicitly call
+	* the algos or microAlgos properties
+	*/
+	valueOf() {
+		return Number(this.microAlgo);
+	}
+	/** Create a `AlgoAmount` object representing the given number of Algo */
+	static Algos(amount) {
+		return new AlgoAmount({ algos: amount });
+	}
+	/** Create a `AlgoAmount` object representing the given number of Algo */
+	static Algo(amount) {
+		return new AlgoAmount({ algos: amount });
+	}
+	/** Create a `AlgoAmount` object representing the given number of µAlgo */
+	static MicroAlgos(amount) {
+		return new AlgoAmount({ microAlgos: amount });
+	}
+	/** Create a `AlgoAmount` object representing the given number of µAlgo */
+	static MicroAlgo(amount) {
+		return new AlgoAmount({ microAlgos: amount });
+	}
+};
+const MICROALGOS_TO_ALGOS_RATIO = 1e6;
+const INVALID_MICROALGOS_ERROR_MSG = "Microalgos should be positive and less than 2^53 - 1.";
+/**
+* microalgosToAlgos converts microalgos to algos
+* @param microalgos - number
+* @returns number
+*/
+function microalgosToAlgos(microalgos) {
+	if (microalgos < 0 || !Number.isSafeInteger(microalgos)) throw new Error(INVALID_MICROALGOS_ERROR_MSG);
+	return microalgos / MICROALGOS_TO_ALGOS_RATIO;
+}
+/**
+* algosToMicroalgos converts algos to microalgos
+* @param algos - number
+* @returns number
+*/
+function algosToMicroalgos(algos) {
+	const microalgos = algos * MICROALGOS_TO_ALGOS_RATIO;
+	return Math.round(microalgos);
+}
 Number.prototype.microAlgos = function() {
 	return AlgoAmount.MicroAlgo(this);
 };
@@ -21,30 +98,42 @@ BigInt.prototype.algo = function() {
 };
 /** Returns an amount of Algo using AlgoAmount
 * @param algos The amount of Algo
+* @example
+* {@includeCode ./amount.spec.ts#example-algos}
+* @see {@link AlgoAmount}
 */
-const algos = (algos$1) => {
-	return AlgoAmount.Algo(algos$1);
+const algos = (algos) => {
+	return AlgoAmount.Algo(algos);
 };
 /** Returns an amount of Algo using AlgoAmount
 * @param algos The amount of Algo
+* @example
+* {@includeCode ./amount.spec.ts#example-algo}
 */
-const algo = (algos$1) => {
-	return AlgoAmount.Algo(algos$1);
+const algo = (algos) => {
+	return AlgoAmount.Algo(algos);
 };
 /** Returns an amount of µAlgo using AlgoAmount
 * @param microAlgos The amount of µAlgo
+* @example
+* {@includeCode ./amount.spec.ts#example-microAlgos}
+* @see {@link algos} for Algo denomination
 */
-const microAlgos = (microAlgos$1) => {
-	return AlgoAmount.MicroAlgo(microAlgos$1);
+const microAlgos = (microAlgos) => {
+	return AlgoAmount.MicroAlgo(microAlgos);
 };
 /** Returns an amount of µAlgo using AlgoAmount
 * @param microAlgos The amount of µAlgo
+* @example
+* {@includeCode ./amount.spec.ts#example-microAlgo}
 */
-const microAlgo = (microAlgos$1) => {
-	return AlgoAmount.MicroAlgo(microAlgos$1);
+const microAlgo = (microAlgos) => {
+	return AlgoAmount.MicroAlgo(microAlgos);
 };
 /** Returns an amount of µAlgo to cover standard fees for the given number of transactions using AlgoAmount
 * @param numberOfTransactions The of standard transaction fees to return the amount of Algo
+* @example
+* {@includeCode ./amount.spec.ts#example-transactionFees}
 */
 const transactionFees = (numberOfTransactions) => {
 	return AlgoAmount.MicroAlgo(BigInt(numberOfTransactions) * ALGORAND_MIN_TX_FEE.microAlgo);
@@ -52,5 +141,5 @@ const transactionFees = (numberOfTransactions) => {
 const ALGORAND_MIN_TX_FEE = AlgoAmount.MicroAlgo(1e3);
 
 //#endregion
-export { ALGORAND_MIN_TX_FEE, algo, algos, microAlgo, microAlgos, transactionFees };
+export { ALGORAND_MIN_TX_FEE, AlgoAmount, algo, algos, microAlgo, microAlgos, transactionFees };
 //# sourceMappingURL=amount.mjs.map

package/amount.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"amount.mjs","names":["algos","microAlgos"],"sources":["../src/amount.ts"],"sourcesContent":["import { AlgoAmount } from './types/amount'\n\ndeclare global {\n  interface Number {\n    /**\n     * Returns an `AlgoAmount` using this number of microAlgo.\n     */\n    microAlgos(this: number): AlgoAmount\n    /**\n     * Returns an `AlgoAmount` using this number of Algo.\n     */\n    algos(this: number): AlgoAmount\n    /**\n     * Returns an `AlgoAmount` using this number of microAlgo.\n     */\n    microAlgo(this: number): AlgoAmount\n    /**\n     * Returns an `AlgoAmount` using this number of Algo.\n     */\n    algo(this: number): AlgoAmount\n  }\n  interface BigInt {\n    /**\n     * Returns an `AlgoAmount` using this number of microAlgo.\n     */\n    microAlgo(this: bigint): AlgoAmount\n    /**\n     * Returns an `AlgoAmount` using this number of Algo.\n     */\n    algo(this: bigint): AlgoAmount\n  }\n}\n\nNumber.prototype.microAlgos = function () {\n  return AlgoAmount.MicroAlgo(this)\n}\n\nNumber.prototype.algos = function () {\n  return AlgoAmount.Algo(this)\n}\n\nNumber.prototype.microAlgo = function () {\n  return AlgoAmount.MicroAlgo(this)\n}\n\nNumber.prototype.algo = function () {\n  return AlgoAmount.Algo(this)\n}\n\nBigInt.prototype.microAlgo = function () {\n  return AlgoAmount.MicroAlgo(this)\n}\n\nBigInt.prototype.algo = function () {\n  return AlgoAmount.Algo(this)\n}\n\n/** Returns an amount of Algo using AlgoAmount\n * @param algos The amount of Algo\n */\nexport const algos = (algos: number | bigint) => {\n  return AlgoAmount.Algo(algos)\n}\n\n/** Returns an amount of Algo using AlgoAmount\n * @param algos The amount of Algo\n */\nexport const algo = (algos: number | bigint) => {\n  return AlgoAmount.Algo(algos)\n}\n\n/** Returns an amount of µAlgo using AlgoAmount\n * @param microAlgos The amount of µAlgo\n */\nexport const microAlgos = (microAlgos: number | bigint) => {\n  return AlgoAmount.MicroAlgo(microAlgos)\n}\n\n/** Returns an amount of µAlgo using AlgoAmount\n * @param microAlgos The amount of µAlgo\n */\nexport const microAlgo = (microAlgos: number | bigint) => {\n  return AlgoAmount.MicroAlgo(microAlgos)\n}\n\n/** Returns an amount of µAlgo to cover standard fees for the given number of transactions using AlgoAmount\n * @param numberOfTransactions The of standard transaction fees to return the amount of Algo\n */\nexport const transactionFees = (numberOfTransactions: number) => {\n  return AlgoAmount.MicroAlgo(BigInt(numberOfTransactions) * ALGORAND_MIN_TX_FEE.microAlgo)\n}\n\nexport const ALGORAND_MIN_TX_FEE = AlgoAmount.MicroAlgo(1_000)\n"],"mappings":";;;AAiCA,OAAO,UAAU,aAAa,WAAY;AACxC,QAAO,WAAW,UAAU,KAAK;;AAGnC,OAAO,UAAU,QAAQ,WAAY;AACnC,QAAO,WAAW,KAAK,KAAK;;AAG9B,OAAO,UAAU,YAAY,WAAY;AACvC,QAAO,WAAW,UAAU,KAAK;;AAGnC,OAAO,UAAU,OAAO,WAAY;AAClC,QAAO,WAAW,KAAK,KAAK;;AAG9B,OAAO,UAAU,YAAY,WAAY;AACvC,QAAO,WAAW,UAAU,KAAK;;AAGnC,OAAO,UAAU,OAAO,WAAY;AAClC,QAAO,WAAW,KAAK,KAAK;;;;;AAM9B,MAAa,SAAS,YAA2B;AAC/C,QAAO,WAAW,KAAKA,QAAM;;;;;AAM/B,MAAa,QAAQ,YAA2B;AAC9C,QAAO,WAAW,KAAKA,QAAM;;;;;AAM/B,MAAa,cAAc,iBAAgC;AACzD,QAAO,WAAW,UAAUC,aAAW;;;;;AAMzC,MAAa,aAAa,iBAAgC;AACxD,QAAO,WAAW,UAAUA,aAAW;;;;;AAMzC,MAAa,mBAAmB,yBAAiC;AAC/D,QAAO,WAAW,UAAU,OAAO,qBAAqB,GAAG,oBAAoB,UAAU;;AAG3F,MAAa,sBAAsB,WAAW,UAAU,IAAM"}
+{"version":3,"file":"amount.mjs","names":[],"sources":["../src/amount.ts"],"sourcesContent":["/** Wrapper class to ensure safe, explicit conversion between µAlgo, Algo and numbers */\nexport class AlgoAmount {\n  private amountInMicroAlgo: bigint\n\n  /** Return the amount as a number in µAlgo */\n  get microAlgos() {\n    return this.amountInMicroAlgo\n  }\n\n  /** Return the amount as a number in µAlgo */\n  get microAlgo() {\n    return this.amountInMicroAlgo\n  }\n\n  /** Return the amount as a number in Algo */\n  get algos() {\n    return microalgosToAlgos(Number(this.amountInMicroAlgo))\n  }\n\n  /** Return the amount as a number in Algo */\n  get algo() {\n    return microalgosToAlgos(Number(this.amountInMicroAlgo))\n  }\n\n  /**\n   * Create a new `AlgoAmount` instance.\n   *\n   * @param amount - An object specifying the amount in Algo or µALGO. Use the key 'algo' for Algo amounts and 'microAlgo' for µALGO.\n   * @returns A new instance of `AlgoAmount` representing the specified amount.\n   * @example\n   * ```typescript\n   * const amount = new AlgoAmount({ algo: 5 });\n   * ```\n   */\n  constructor(\n    amount: { algos: number | bigint } | { algo: number | bigint } | { microAlgos: number | bigint } | { microAlgo: number | bigint },\n  ) {\n    this.amountInMicroAlgo =\n      'microAlgos' in amount\n        ? BigInt(amount.microAlgos)\n        : 'microAlgo' in amount\n          ? BigInt(amount.microAlgo)\n          : 'algos' in amount\n            ? BigInt(algosToMicroalgos(Number(amount.algos)))\n            : BigInt(algosToMicroalgos(Number(amount.algo)))\n  }\n\n  toString(): string {\n    return `${this.microAlgo.toLocaleString('en-US')} µALGO`\n  }\n\n  /** valueOf allows you to use `AlgoAmount` in comparison operations such as `<` and `>=` etc.,\n   * but it's not recommended to use this to convert to a number, it's much safer to explicitly call\n   * the algos or microAlgos properties\n   */\n  valueOf(): number {\n    return Number(this.microAlgo)\n  }\n\n  /** Create a `AlgoAmount` object representing the given number of Algo */\n  static Algos(amount: number | bigint) {\n    return new AlgoAmount({ algos: amount })\n  }\n\n  /** Create a `AlgoAmount` object representing the given number of Algo */\n  static Algo(amount: number | bigint) {\n    return new AlgoAmount({ algos: amount })\n  }\n\n  /** Create a `AlgoAmount` object representing the given number of µAlgo */\n  static MicroAlgos(amount: number | bigint) {\n    return new AlgoAmount({ microAlgos: amount })\n  }\n\n  /** Create a `AlgoAmount` object representing the given number of µAlgo */\n  static MicroAlgo(amount: number | bigint) {\n    return new AlgoAmount({ microAlgos: amount })\n  }\n}\n\nconst MICROALGOS_TO_ALGOS_RATIO = 1e6\nconst INVALID_MICROALGOS_ERROR_MSG = 'Microalgos should be positive and less than 2^53 - 1.'\n\n/**\n * microalgosToAlgos converts microalgos to algos\n * @param microalgos - number\n * @returns number\n */\nfunction microalgosToAlgos(microalgos: number) {\n  if (microalgos < 0 || !Number.isSafeInteger(microalgos)) {\n    throw new Error(INVALID_MICROALGOS_ERROR_MSG)\n  }\n  return microalgos / MICROALGOS_TO_ALGOS_RATIO\n}\n\n/**\n * algosToMicroalgos converts algos to microalgos\n * @param algos - number\n * @returns number\n */\nfunction algosToMicroalgos(algos: number) {\n  const microalgos = algos * MICROALGOS_TO_ALGOS_RATIO\n  return Math.round(microalgos)\n}\n\ndeclare global {\n  interface Number {\n    /**\n     * Returns an `AlgoAmount` using this number of microAlgo.\n     */\n    microAlgos(this: number): AlgoAmount\n    /**\n     * Returns an `AlgoAmount` using this number of Algo.\n     */\n    algos(this: number): AlgoAmount\n    /**\n     * Returns an `AlgoAmount` using this number of microAlgo.\n     */\n    microAlgo(this: number): AlgoAmount\n    /**\n     * Returns an `AlgoAmount` using this number of Algo.\n     */\n    algo(this: number): AlgoAmount\n  }\n  interface BigInt {\n    /**\n     * Returns an `AlgoAmount` using this number of microAlgo.\n     */\n    microAlgo(this: bigint): AlgoAmount\n    /**\n     * Returns an `AlgoAmount` using this number of Algo.\n     */\n    algo(this: bigint): AlgoAmount\n  }\n}\n\nNumber.prototype.microAlgos = function () {\n  return AlgoAmount.MicroAlgo(this)\n}\n\nNumber.prototype.algos = function () {\n  return AlgoAmount.Algo(this)\n}\n\nNumber.prototype.microAlgo = function () {\n  return AlgoAmount.MicroAlgo(this)\n}\n\nNumber.prototype.algo = function () {\n  return AlgoAmount.Algo(this)\n}\n\nBigInt.prototype.microAlgo = function () {\n  return AlgoAmount.MicroAlgo(this)\n}\n\nBigInt.prototype.algo = function () {\n  return AlgoAmount.Algo(this)\n}\n\n/** Returns an amount of Algo using AlgoAmount\n * @param algos The amount of Algo\n * @example\n * {@includeCode ./amount.spec.ts#example-algos}\n * @see {@link AlgoAmount}\n */\nexport const algos = (algos: number | bigint) => {\n  return AlgoAmount.Algo(algos)\n}\n\n/** Returns an amount of Algo using AlgoAmount\n * @param algos The amount of Algo\n * @example\n * {@includeCode ./amount.spec.ts#example-algo}\n */\nexport const algo = (algos: number | bigint) => {\n  return AlgoAmount.Algo(algos)\n}\n\n/** Returns an amount of µAlgo using AlgoAmount\n * @param microAlgos The amount of µAlgo\n * @example\n * {@includeCode ./amount.spec.ts#example-microAlgos}\n * @see {@link algos} for Algo denomination\n */\nexport const microAlgos = (microAlgos: number | bigint) => {\n  return AlgoAmount.MicroAlgo(microAlgos)\n}\n\n/** Returns an amount of µAlgo using AlgoAmount\n * @param microAlgos The amount of µAlgo\n * @example\n * {@includeCode ./amount.spec.ts#example-microAlgo}\n */\nexport const microAlgo = (microAlgos: number | bigint) => {\n  return AlgoAmount.MicroAlgo(microAlgos)\n}\n\n/** Returns an amount of µAlgo to cover standard fees for the given number of transactions using AlgoAmount\n * @param numberOfTransactions The of standard transaction fees to return the amount of Algo\n * @example\n * {@includeCode ./amount.spec.ts#example-transactionFees}\n */\nexport const transactionFees = (numberOfTransactions: number) => {\n  return AlgoAmount.MicroAlgo(BigInt(numberOfTransactions) * ALGORAND_MIN_TX_FEE.microAlgo)\n}\n\nexport const ALGORAND_MIN_TX_FEE = AlgoAmount.MicroAlgo(1_000)\n"],"mappings":";;AACA,IAAa,aAAb,MAAa,WAAW;CACtB,AAAQ;;CAGR,IAAI,aAAa;AACf,SAAO,KAAK;;;CAId,IAAI,YAAY;AACd,SAAO,KAAK;;;CAId,IAAI,QAAQ;AACV,SAAO,kBAAkB,OAAO,KAAK,kBAAkB,CAAC;;;CAI1D,IAAI,OAAO;AACT,SAAO,kBAAkB,OAAO,KAAK,kBAAkB,CAAC;;;;;;;;;;;;CAa1D,YACE,QACA;AACA,OAAK,oBACH,gBAAgB,SACZ,OAAO,OAAO,WAAW,GACzB,eAAe,SACb,OAAO,OAAO,UAAU,GACxB,WAAW,SACT,OAAO,kBAAkB,OAAO,OAAO,MAAM,CAAC,CAAC,GAC/C,OAAO,kBAAkB,OAAO,OAAO,KAAK,CAAC,CAAC;;CAG1D,WAAmB;AACjB,SAAO,GAAG,KAAK,UAAU,eAAe,QAAQ,CAAC;;;;;;CAOnD,UAAkB;AAChB,SAAO,OAAO,KAAK,UAAU;;;CAI/B,OAAO,MAAM,QAAyB;AACpC,SAAO,IAAI,WAAW,EAAE,OAAO,QAAQ,CAAC;;;CAI1C,OAAO,KAAK,QAAyB;AACnC,SAAO,IAAI,WAAW,EAAE,OAAO,QAAQ,CAAC;;;CAI1C,OAAO,WAAW,QAAyB;AACzC,SAAO,IAAI,WAAW,EAAE,YAAY,QAAQ,CAAC;;;CAI/C,OAAO,UAAU,QAAyB;AACxC,SAAO,IAAI,WAAW,EAAE,YAAY,QAAQ,CAAC;;;AAIjD,MAAM,4BAA4B;AAClC,MAAM,+BAA+B;;;;;;AAOrC,SAAS,kBAAkB,YAAoB;AAC7C,KAAI,aAAa,KAAK,CAAC,OAAO,cAAc,WAAW,CACrD,OAAM,IAAI,MAAM,6BAA6B;AAE/C,QAAO,aAAa;;;;;;;AAQtB,SAAS,kBAAkB,OAAe;CACxC,MAAM,aAAa,QAAQ;AAC3B,QAAO,KAAK,MAAM,WAAW;;AAkC/B,OAAO,UAAU,aAAa,WAAY;AACxC,QAAO,WAAW,UAAU,KAAK;;AAGnC,OAAO,UAAU,QAAQ,WAAY;AACnC,QAAO,WAAW,KAAK,KAAK;;AAG9B,OAAO,UAAU,YAAY,WAAY;AACvC,QAAO,WAAW,UAAU,KAAK;;AAGnC,OAAO,UAAU,OAAO,WAAY;AAClC,QAAO,WAAW,KAAK,KAAK;;AAG9B,OAAO,UAAU,YAAY,WAAY;AACvC,QAAO,WAAW,UAAU,KAAK;;AAGnC,OAAO,UAAU,OAAO,WAAY;AAClC,QAAO,WAAW,KAAK,KAAK;;;;;;;;AAS9B,MAAa,SAAS,UAA2B;AAC/C,QAAO,WAAW,KAAK,MAAM;;;;;;;AAQ/B,MAAa,QAAQ,UAA2B;AAC9C,QAAO,WAAW,KAAK,MAAM;;;;;;;;AAS/B,MAAa,cAAc,eAAgC;AACzD,QAAO,WAAW,UAAU,WAAW;;;;;;;AAQzC,MAAa,aAAa,eAAgC;AACxD,QAAO,WAAW,UAAU,WAAW;;;;;;;AAQzC,MAAa,mBAAmB,yBAAiC;AAC/D,QAAO,WAAW,UAAU,OAAO,qBAAqB,GAAG,oBAAoB,UAAU;;AAG3F,MAAa,sBAAsB,WAAW,UAAU,IAAM"}