@autonomys/auto-utils 1.5.17 → 1.5.18

package/dist/constants/token.d.ts

@@ -1,6 +1,7 @@
 export declare const DEFAULT_TOKEN_DECIMALS = 18;
 export declare const DEFAULT_TOKEN_SYMBOL = "AI3";
 export declare const DEFAULT_TOKEN_NAME = "Auto Token";
+export declare const DEFAULT_EXISTENTIAL_DEPOSIT_SHANNONS: bigint;
 export declare const DEFAULT_TOKEN: {
     decimals: number;
     symbol: string;

package/dist/constants/token.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"token.d.ts","sourceRoot":"","sources":["../../src/constants/token.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,sBAAsB,KAAK,CAAA;AAExC,eAAO,MAAM,oBAAoB,QAAQ,CAAA;AAEzC,eAAO,MAAM,kBAAkB,eAAe,CAAA;AAE9C,eAAO,MAAM,aAAa;;;;CAIzB,CAAA;AAED,eAAO,MAAM,aAAa;;;;CAIzB,CAAA"}
+{"version":3,"file":"token.d.ts","sourceRoot":"","sources":["../../src/constants/token.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,sBAAsB,KAAK,CAAA;AAExC,eAAO,MAAM,oBAAoB,QAAQ,CAAA;AAEzC,eAAO,MAAM,kBAAkB,eAAe,CAAA;AAE9C,eAAO,MAAM,oCAAoC,QAAwB,CAAA;AAEzE,eAAO,MAAM,aAAa;;;;CAIzB,CAAA;AAED,eAAO,MAAM,aAAa;;;;CAIzB,CAAA"}

package/dist/constants/token.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TESTNET_TOKEN = exports.DEFAULT_TOKEN = exports.DEFAULT_TOKEN_NAME = exports.DEFAULT_TOKEN_SYMBOL = exports.DEFAULT_TOKEN_DECIMALS = void 0;
+exports.TESTNET_TOKEN = exports.DEFAULT_TOKEN = exports.DEFAULT_EXISTENTIAL_DEPOSIT_SHANNONS = exports.DEFAULT_TOKEN_NAME = exports.DEFAULT_TOKEN_SYMBOL = exports.DEFAULT_TOKEN_DECIMALS = void 0;
 exports.DEFAULT_TOKEN_DECIMALS = 18;
 exports.DEFAULT_TOKEN_SYMBOL = 'AI3';
 exports.DEFAULT_TOKEN_NAME = 'Auto Token';
+exports.DEFAULT_EXISTENTIAL_DEPOSIT_SHANNONS = BigInt(1000000000000);
 exports.DEFAULT_TOKEN = {
     decimals: exports.DEFAULT_TOKEN_DECIMALS,
     symbol: exports.DEFAULT_TOKEN_SYMBOL,

package/dist/number.d.ts

@@ -171,4 +171,80 @@ export declare const ai3ToShannons: (ai3Amount: string, options?: {
 export declare const shannonsToAi3: (shannons: bigint | string, options?: {
     trimTrailingZeros?: boolean;
 }) => string;
+/**
+ * Checks if an AI3 amount meets the Autonomys Network existential deposit requirement.
+ *
+ * The existential deposit (ED) is the minimum balance required to keep an account active
+ * on the Autonomys Network. Accounts with balances below the ED may be reaped (removed)
+ * by the network, and their funds will be destroyed to prevent storage bloat.
+ *
+ * This function accepts AI3 amounts as strings and performs string-to-BigInt conversion.
+ * For direct Shannon (BigInt) validation, use `meetsExistentialDepositShannons` instead.
+ *
+ * For Autonomys Network, the existential deposit is 0.000001 AI3 (1,000,000,000,000 Shannons).
+ *
+ * @param amount - AI3 amount as a decimal string (e.g., "1.5", "0.000001")
+ * @returns true if the amount meets or exceeds the existential deposit requirement
+ * @throws Error if the amount format is invalid (same validation as ai3ToShannons)
+ * @see meetsExistentialDepositShannons - for direct Shannon (BigInt) validation
+ *
+ * @example
+ * import { meetsExistentialDepositAi3 } from '@autonomys/auto-utils'
+ *
+ * // Check if amount meets ED requirement
+ * const amount = "0.000001"
+ * if (meetsExistentialDepositAi3(amount)) {
+ *   console.log('Amount meets existential deposit requirement')
+ * } else {
+ *   console.log(`Amount too low. Minimum required: 0.000001 AI3`)
+ * }
+ *
+ * // Examples of different amounts
+ * console.log(meetsExistentialDepositAi3("0.0000005")) // false - below ED
+ * console.log(meetsExistentialDepositAi3("0.000001"))  // true - exactly at ED
+ * console.log(meetsExistentialDepositAi3("0.000002"))  // true - above ED
+ * console.log(meetsExistentialDepositAi3("1"))         // true - well above ED
+ *
+ * // Will throw error for invalid formats
+ * try {
+ *   meetsExistentialDepositAi3("invalid")
+ * } catch (error) {
+ *   console.error("Invalid amount format")
+ * }
+ */
+export declare const meetsExistentialDepositAi3: (amount: string) => boolean;
+/**
+ * Checks if a Shannon amount meets the Autonomys Network existential deposit requirement.
+ *
+ * This is the Shannon-based version of `meetsExistentialDepositAi3` that works directly with
+ * BigInt values in the smallest units (Shannons). It's more efficient when you already
+ * have amounts in Shannon units and don't need string parsing.
+ *
+ * For Autonomys Network, the existential deposit is 1,000,000,000,000 Shannons (0.000001 AI3).
+ *
+ * @param amount - Shannon amount as BigInt (smallest units)
+ * @returns true if the amount meets or exceeds the existential deposit requirement
+ *
+ * @example
+ * import { meetsExistentialDepositShannons, DEFAULT_EXISTENTIAL_DEPOSIT_SHANNONS } from '@autonomys/auto-utils'
+ *
+ * // Check if Shannon amount meets ED requirement
+ * const shannons = BigInt('1000000000000') // 0.000001 AI3
+ * if (meetsExistentialDepositShannons(shannons)) {
+ *   console.log('Amount meets existential deposit requirement')
+ * }
+ *
+ * // Examples with different Shannon amounts
+ * console.log(meetsExistentialDepositShannons(BigInt('999999999999'))) // false - below ED
+ * console.log(meetsExistentialDepositShannons(BigInt('1000000000000'))) // true - exactly at ED
+ * console.log(meetsExistentialDepositShannons(BigInt('2000000000000'))) // true - above ED
+ * console.log(meetsExistentialDepositShannons(BigInt('1000000000000000000'))) // true - 1 AI3
+ *
+ * // Works with the constant directly
+ * console.log(meetsExistentialDepositShannons(DEFAULT_EXISTENTIAL_DEPOSIT_SHANNONS)) // true
+ *
+ * // Handles negative amounts
+ * console.log(meetsExistentialDepositShannons(BigInt('-1000000000000'))) // false
+ */
+export declare const meetsExistentialDepositShannons: (amount: bigint) => boolean;
 //# sourceMappingURL=number.d.ts.map

package/dist/number.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"number.d.ts","sourceRoot":"","sources":["../src/number.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,gBAAgB,GAC3B,QAAQ,MAAM,GAAG,MAAM,EACvB,WAAU,MAA+B,oBAI1C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,eAAO,MAAM,iBAAiB,GAC5B,QAAQ,MAAM,GAAG,MAAM,EACvB,WAAU,MAA+B,oBAI1C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,kBAAkB,GAAI,OAAO,MAAM,EAAE,iBAAY,WAU7D,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,UAAU,GACrB,OAAO,MAAM,EACb,WAAU,MAA+B,EACzC,UAAS;IAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,UAAU,GAAG,OAAO,GAAG,MAAM,CAAA;CAAO,KACnE,MA2DF,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,WAAW,GACtB,OAAO,MAAM,GAAG,MAAM,EACtB,WAAU,MAA+B,EACzC,UAAS;IAAE,iBAAiB,CAAC,EAAE,OAAO,CAAA;CAAO,KAC5C,MAkBF,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,aAAa,GACxB,WAAW,MAAM,EACjB,UAAS;IAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,UAAU,GAAG,OAAO,GAAG,MAAM,CAAA;CAAO,KACnE,MAAgE,CAAA;AAEnE;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,aAAa,GACxB,UAAU,MAAM,GAAG,MAAM,EACzB,UAAS;IAAE,iBAAiB,CAAC,EAAE,OAAO,CAAA;CAAO,KAC5C,MAAgE,CAAA"}
+{"version":3,"file":"number.d.ts","sourceRoot":"","sources":["../src/number.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,gBAAgB,GAC3B,QAAQ,MAAM,GAAG,MAAM,EACvB,WAAU,MAA+B,oBAI1C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,eAAO,MAAM,iBAAiB,GAC5B,QAAQ,MAAM,GAAG,MAAM,EACvB,WAAU,MAA+B,oBAI1C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,kBAAkB,GAAI,OAAO,MAAM,EAAE,iBAAY,WAU7D,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,UAAU,GACrB,OAAO,MAAM,EACb,WAAU,MAA+B,EACzC,UAAS;IAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,UAAU,GAAG,OAAO,GAAG,MAAM,CAAA;CAAO,KACnE,MA2DF,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,WAAW,GACtB,OAAO,MAAM,GAAG,MAAM,EACtB,WAAU,MAA+B,EACzC,UAAS;IAAE,iBAAiB,CAAC,EAAE,OAAO,CAAA;CAAO,KAC5C,MAkBF,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,aAAa,GACxB,WAAW,MAAM,EACjB,UAAS;IAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,UAAU,GAAG,OAAO,GAAG,MAAM,CAAA;CAAO,KACnE,MAAgE,CAAA;AAEnE;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,aAAa,GACxB,UAAU,MAAM,GAAG,MAAM,EACzB,UAAS;IAAE,iBAAiB,CAAC,EAAE,OAAO,CAAA;CAAO,KAC5C,MAAgE,CAAA;AAEnE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,eAAO,MAAM,0BAA0B,GAAI,QAAQ,MAAM,KAAG,OAE3D,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,+BAA+B,GAAI,QAAQ,MAAM,KAAG,OAEhE,CAAA"}

package/dist/number.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.shannonsToAi3 = exports.ai3ToShannons = exports.formatUnits = exports.parseUnits = exports.formatSpacePledged = exports.formatTokenAmount = exports.parseTokenAmount = void 0;
+exports.meetsExistentialDepositShannons = exports.meetsExistentialDepositAi3 = exports.shannonsToAi3 = exports.ai3ToShannons = exports.formatUnits = exports.parseUnits = exports.formatSpacePledged = exports.formatTokenAmount = exports.parseTokenAmount = void 0;
 const number_1 = require("./constants/number");
 const token_1 = require("./constants/token");
 /**
@@ -263,3 +263,85 @@ exports.ai3ToShannons = ai3ToShannons;
  */
 const shannonsToAi3 = (shannons, options = {}) => (0, exports.formatUnits)(shannons, token_1.DEFAULT_TOKEN_DECIMALS, options);
 exports.shannonsToAi3 = shannonsToAi3;
+/**
+ * Checks if an AI3 amount meets the Autonomys Network existential deposit requirement.
+ *
+ * The existential deposit (ED) is the minimum balance required to keep an account active
+ * on the Autonomys Network. Accounts with balances below the ED may be reaped (removed)
+ * by the network, and their funds will be destroyed to prevent storage bloat.
+ *
+ * This function accepts AI3 amounts as strings and performs string-to-BigInt conversion.
+ * For direct Shannon (BigInt) validation, use `meetsExistentialDepositShannons` instead.
+ *
+ * For Autonomys Network, the existential deposit is 0.000001 AI3 (1,000,000,000,000 Shannons).
+ *
+ * @param amount - AI3 amount as a decimal string (e.g., "1.5", "0.000001")
+ * @returns true if the amount meets or exceeds the existential deposit requirement
+ * @throws Error if the amount format is invalid (same validation as ai3ToShannons)
+ * @see meetsExistentialDepositShannons - for direct Shannon (BigInt) validation
+ *
+ * @example
+ * import { meetsExistentialDepositAi3 } from '@autonomys/auto-utils'
+ *
+ * // Check if amount meets ED requirement
+ * const amount = "0.000001"
+ * if (meetsExistentialDepositAi3(amount)) {
+ *   console.log('Amount meets existential deposit requirement')
+ * } else {
+ *   console.log(`Amount too low. Minimum required: 0.000001 AI3`)
+ * }
+ *
+ * // Examples of different amounts
+ * console.log(meetsExistentialDepositAi3("0.0000005")) // false - below ED
+ * console.log(meetsExistentialDepositAi3("0.000001"))  // true - exactly at ED
+ * console.log(meetsExistentialDepositAi3("0.000002"))  // true - above ED
+ * console.log(meetsExistentialDepositAi3("1"))         // true - well above ED
+ *
+ * // Will throw error for invalid formats
+ * try {
+ *   meetsExistentialDepositAi3("invalid")
+ * } catch (error) {
+ *   console.error("Invalid amount format")
+ * }
+ */
+const meetsExistentialDepositAi3 = (amount) => {
+    return (0, exports.meetsExistentialDepositShannons)((0, exports.ai3ToShannons)(amount));
+};
+exports.meetsExistentialDepositAi3 = meetsExistentialDepositAi3;
+/**
+ * Checks if a Shannon amount meets the Autonomys Network existential deposit requirement.
+ *
+ * This is the Shannon-based version of `meetsExistentialDepositAi3` that works directly with
+ * BigInt values in the smallest units (Shannons). It's more efficient when you already
+ * have amounts in Shannon units and don't need string parsing.
+ *
+ * For Autonomys Network, the existential deposit is 1,000,000,000,000 Shannons (0.000001 AI3).
+ *
+ * @param amount - Shannon amount as BigInt (smallest units)
+ * @returns true if the amount meets or exceeds the existential deposit requirement
+ *
+ * @example
+ * import { meetsExistentialDepositShannons, DEFAULT_EXISTENTIAL_DEPOSIT_SHANNONS } from '@autonomys/auto-utils'
+ *
+ * // Check if Shannon amount meets ED requirement
+ * const shannons = BigInt('1000000000000') // 0.000001 AI3
+ * if (meetsExistentialDepositShannons(shannons)) {
+ *   console.log('Amount meets existential deposit requirement')
+ * }
+ *
+ * // Examples with different Shannon amounts
+ * console.log(meetsExistentialDepositShannons(BigInt('999999999999'))) // false - below ED
+ * console.log(meetsExistentialDepositShannons(BigInt('1000000000000'))) // true - exactly at ED
+ * console.log(meetsExistentialDepositShannons(BigInt('2000000000000'))) // true - above ED
+ * console.log(meetsExistentialDepositShannons(BigInt('1000000000000000000'))) // true - 1 AI3
+ *
+ * // Works with the constant directly
+ * console.log(meetsExistentialDepositShannons(DEFAULT_EXISTENTIAL_DEPOSIT_SHANNONS)) // true
+ *
+ * // Handles negative amounts
+ * console.log(meetsExistentialDepositShannons(BigInt('-1000000000000'))) // false
+ */
+const meetsExistentialDepositShannons = (amount) => {
+    return amount >= token_1.DEFAULT_EXISTENTIAL_DEPOSIT_SHANNONS;
+};
+exports.meetsExistentialDepositShannons = meetsExistentialDepositShannons;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autonomys/auto-utils",
-  "version": "1.5.17",
+  "version": "1.5.18",
   "license": "MIT",
   "main": "dist/index.js",
   "repository": {
@@ -39,5 +39,5 @@
     "ts-jest": "^29.3.1",
     "typescript": "^5.8.3"
   },
-  "gitHead": "890e12b9cc437f3f4409b74663a77b854bf048aa"
+  "gitHead": "b339864e15c46187ddcc75ebeed3d8170fbe7c9e"
 }