@autonomys/auto-utils 1.5.17 → 1.5.19

package/README.md

@@ -71,6 +71,8 @@ import { activateWallet } from '@autonomys/auto-utils'
   const { api, accounts } = await activateWallet({
     mnemonic,
     networkId: 'mainnet', // Optional: specify the network ID
+    // Optional derivation path (useful for ethereum BIP44):
+    // derivationPath: "m/44'/60'/0'/0/0",
   })
 
   const account = accounts[0]
@@ -263,6 +265,27 @@ import { activateDomain } from '@autonomys/auto-utils'
 
 ---
 
+#### **Setup a Wallet with Ethereum BIP44**
+
+```typescript
+import { setupWallet } from '@autonomys/auto-utils'
+
+const mnemonic = 'your mnemonic phrase here'
+
+// Default behavior derives from master (m)
+const ethMaster = setupWallet({ mnemonic, type: 'ethereum' })
+
+// To derive using BIP44 path
+const ethBip44 = setupWallet({
+  mnemonic,
+  type: 'ethereum',
+  derivationPath: "m/44'/60'/0'/0/0",
+})
+
+console.log(ethMaster.address)
+console.log(ethBip44.address)
+```
+
 ### 5. Address Utilities
 
 #### **Convert Address Formats**

package/dist/constants/token.d.ts

@@ -1,6 +1,8 @@
 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_CONSENSUS_EXISTENTIAL_DEPOSIT_SHANNONS: bigint;
+export declare const DEFAULT_DOMAIN_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;AAG9C,eAAO,MAAM,8CAA8C,QAAyB,CAAA;AAGpF,eAAO,MAAM,2CAA2C,QAAwB,CAAA;AAEhF,eAAO,MAAM,aAAa;;;;CAIzB,CAAA;AAED,eAAO,MAAM,aAAa;;;;CAIzB,CAAA"}

package/dist/constants/token.js

@@ -1,9 +1,13 @@
 "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_DOMAIN_EXISTENTIAL_DEPOSIT_SHANNONS = exports.DEFAULT_CONSENSUS_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';
+// Existential deposit for Autonomys Network consensus chain
+exports.DEFAULT_CONSENSUS_EXISTENTIAL_DEPOSIT_SHANNONS = BigInt(10000000000000); // 0.00001 AI3
+// Existential deposit for Autonomys Network domains/EVM
+exports.DEFAULT_DOMAIN_EXISTENTIAL_DEPOSIT_SHANNONS = BigInt(1000000000000); // 0.000001 AI3
 exports.DEFAULT_TOKEN = {
     decimals: exports.DEFAULT_TOKEN_DECIMALS,
     symbol: exports.DEFAULT_TOKEN_SYMBOL,

package/dist/number.d.ts

@@ -171,4 +171,148 @@ 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 consensus chain 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 is for the consensus chain specifically. For domains/EVM, use `meetsDomainExistentialDepositAi3`.
+ * For direct Shannon (BigInt) validation, use `meetsConsensusExistentialDepositShannons` instead.
+ *
+ * For Autonomys Network consensus chain, the existential deposit is 0.00001 AI3 (10,000,000,000,000 Shannons).
+ *
+ * @param amount - AI3 amount as a decimal string (e.g., "1.5", "0.00001")
+ * @returns true if the amount meets or exceeds the consensus chain existential deposit requirement
+ * @throws Error if the amount format is invalid (same validation as ai3ToShannons)
+ * @see meetsConsensusExistentialDepositShannons - for direct Shannon (BigInt) validation
+ * @see meetsDomainExistentialDepositAi3 - for domain/EVM existential deposit validation
+ *
+ * @example
+ * import { meetsConsensusExistentialDepositAi3, DEFAULT_CONSENSUS_EXISTENTIAL_DEPOSIT_SHANNONS, shannonsToAi3 } from '@autonomys/auto-utils'
+ *
+ * // Check if amount meets consensus ED requirement
+ * const amount = "0.00001"
+ * if (meetsConsensusExistentialDepositAi3(amount)) {
+ *   console.log('Amount meets consensus existential deposit requirement')
+ * } else {
+ *   const minRequired = shannonsToAi3(DEFAULT_CONSENSUS_EXISTENTIAL_DEPOSIT_SHANNONS)
+ *   console.log(`Amount too low. Minimum required: ${minRequired} AI3 for consensus`)
+ * }
+ *
+ * // Examples of different amounts
+ * console.log(meetsConsensusExistentialDepositAi3("0.000005")) // false - below ED
+ * console.log(meetsConsensusExistentialDepositAi3("0.00001"))  // true - exactly at ED
+ * console.log(meetsConsensusExistentialDepositAi3("0.00002"))  // true - above ED
+ * console.log(meetsConsensusExistentialDepositAi3("1"))         // true - well above ED
+ */
+export declare const meetsConsensusExistentialDepositAi3: (amount: string) => boolean;
+/**
+ * Checks if a Shannon amount meets the Autonomys Network consensus chain existential deposit requirement.
+ *
+ * This is the Shannon-based version of `meetsConsensusExistentialDepositAi3` 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 consensus chain, the existential deposit is 10,000,000,000,000 Shannons (0.00001 AI3).
+ *
+ * @param amount - Shannon amount as BigInt (smallest units)
+ * @returns true if the amount meets or exceeds the consensus chain existential deposit requirement
+ * @see meetsDomainExistentialDepositShannons - for domain/EVM existential deposit validation
+ *
+ * @example
+ * import { meetsConsensusExistentialDepositShannons, DEFAULT_CONSENSUS_EXISTENTIAL_DEPOSIT_SHANNONS } from '@autonomys/auto-utils'
+ *
+ * // Check if Shannon amount meets consensus ED requirement
+ * const shannons = BigInt('10000000000000') // 0.00001 AI3
+ * if (meetsConsensusExistentialDepositShannons(shannons)) {
+ *   console.log('Amount meets consensus existential deposit requirement')
+ * }
+ *
+ * // Examples with different Shannon amounts
+ * console.log(meetsConsensusExistentialDepositShannons(BigInt('9999999999999'))) // false - below ED
+ * console.log(meetsConsensusExistentialDepositShannons(BigInt('10000000000000'))) // true - exactly at ED
+ * console.log(meetsConsensusExistentialDepositShannons(BigInt('20000000000000'))) // true - above ED
+ * console.log(meetsConsensusExistentialDepositShannons(BigInt('1000000000000000000'))) // true - 1 AI3
+ *
+ * // Works with the constant directly
+ * console.log(meetsConsensusExistentialDepositShannons(DEFAULT_CONSENSUS_EXISTENTIAL_DEPOSIT_SHANNONS)) // true
+ *
+ * // Handles negative amounts
+ * console.log(meetsConsensusExistentialDepositShannons(BigInt('-10000000000000'))) // false
+ */
+export declare const meetsConsensusExistentialDepositShannons: (amount: bigint) => boolean;
+/**
+ * Checks if an AI3 amount meets the Autonomys Network domain/EVM 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 is for domains/EVM specifically. For consensus chain, use `meetsConsensusExistentialDepositAi3`.
+ * For direct Shannon (BigInt) validation, use `meetsDomainExistentialDepositShannons` instead.
+ *
+ * For Autonomys Network domains/EVM, 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 domain/EVM existential deposit requirement
+ * @throws Error if the amount format is invalid (same validation as ai3ToShannons)
+ * @see meetsDomainExistentialDepositShannons - for direct Shannon (BigInt) validation
+ * @see meetsConsensusExistentialDepositAi3 - for consensus chain existential deposit validation
+ *
+ * @example
+ * import { meetsDomainExistentialDepositAi3, DEFAULT_DOMAIN_EXISTENTIAL_DEPOSIT_SHANNONS, shannonsToAi3 } from '@autonomys/auto-utils'
+ *
+ * // Check if amount meets domain/EVM ED requirement
+ * const amount = "0.000001"
+ * if (meetsDomainExistentialDepositAi3(amount)) {
+ *   console.log('Amount meets domain existential deposit requirement')
+ * } else {
+ *   const minRequired = shannonsToAi3(DEFAULT_DOMAIN_EXISTENTIAL_DEPOSIT_SHANNONS)
+ *   console.log(`Amount too low. Minimum required: ${minRequired} AI3 for domains`)
+ * }
+ *
+ * // Examples of different amounts
+ * console.log(meetsDomainExistentialDepositAi3("0.0000005")) // false - below ED
+ * console.log(meetsDomainExistentialDepositAi3("0.000001"))  // true - exactly at ED
+ * console.log(meetsDomainExistentialDepositAi3("0.000002"))  // true - above ED
+ * console.log(meetsDomainExistentialDepositAi3("1"))         // true - well above ED
+ */
+export declare const meetsDomainExistentialDepositAi3: (amount: string) => boolean;
+/**
+ * Checks if a Shannon amount meets the Autonomys Network domain/EVM existential deposit requirement.
+ *
+ * This is the Shannon-based version of `meetsDomainExistentialDepositAi3` 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 domains/EVM, 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 domain/EVM existential deposit requirement
+ * @see meetsConsensusExistentialDepositShannons - for consensus chain existential deposit validation
+ *
+ * @example
+ * import { meetsDomainExistentialDepositShannons, DEFAULT_DOMAIN_EXISTENTIAL_DEPOSIT_SHANNONS } from '@autonomys/auto-utils'
+ *
+ * // Check if Shannon amount meets domain/EVM ED requirement
+ * const shannons = BigInt('1000000000000') // 0.000001 AI3
+ * if (meetsDomainExistentialDepositShannons(shannons)) {
+ *   console.log('Amount meets domain existential deposit requirement')
+ * }
+ *
+ * // Examples with different Shannon amounts
+ * console.log(meetsDomainExistentialDepositShannons(BigInt('999999999999'))) // false - below ED
+ * console.log(meetsDomainExistentialDepositShannons(BigInt('1000000000000'))) // true - exactly at ED
+ * console.log(meetsDomainExistentialDepositShannons(BigInt('2000000000000'))) // true - above ED
+ * console.log(meetsDomainExistentialDepositShannons(BigInt('1000000000000000000'))) // true - 1 AI3
+ *
+ * // Works with the constant directly
+ * console.log(meetsDomainExistentialDepositShannons(DEFAULT_DOMAIN_EXISTENTIAL_DEPOSIT_SHANNONS)) // true
+ *
+ * // Handles negative amounts
+ * console.log(meetsDomainExistentialDepositShannons(BigInt('-1000000000000'))) // false
+ */
+export declare const meetsDomainExistentialDepositShannons: (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":"AAOA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,eAAO,MAAM,mCAAmC,GAAI,QAAQ,MAAM,KAAG,OAEpE,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,eAAO,MAAM,wCAAwC,GAAI,QAAQ,MAAM,KAAG,OAEzE,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,eAAO,MAAM,gCAAgC,GAAI,QAAQ,MAAM,KAAG,OAEjE,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,eAAO,MAAM,qCAAqC,GAAI,QAAQ,MAAM,KAAG,OAEtE,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.meetsDomainExistentialDepositShannons = exports.meetsDomainExistentialDepositAi3 = exports.meetsConsensusExistentialDepositShannons = exports.meetsConsensusExistentialDepositAi3 = 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,159 @@ 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 consensus chain 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 is for the consensus chain specifically. For domains/EVM, use `meetsDomainExistentialDepositAi3`.
+ * For direct Shannon (BigInt) validation, use `meetsConsensusExistentialDepositShannons` instead.
+ *
+ * For Autonomys Network consensus chain, the existential deposit is 0.00001 AI3 (10,000,000,000,000 Shannons).
+ *
+ * @param amount - AI3 amount as a decimal string (e.g., "1.5", "0.00001")
+ * @returns true if the amount meets or exceeds the consensus chain existential deposit requirement
+ * @throws Error if the amount format is invalid (same validation as ai3ToShannons)
+ * @see meetsConsensusExistentialDepositShannons - for direct Shannon (BigInt) validation
+ * @see meetsDomainExistentialDepositAi3 - for domain/EVM existential deposit validation
+ *
+ * @example
+ * import { meetsConsensusExistentialDepositAi3, DEFAULT_CONSENSUS_EXISTENTIAL_DEPOSIT_SHANNONS, shannonsToAi3 } from '@autonomys/auto-utils'
+ *
+ * // Check if amount meets consensus ED requirement
+ * const amount = "0.00001"
+ * if (meetsConsensusExistentialDepositAi3(amount)) {
+ *   console.log('Amount meets consensus existential deposit requirement')
+ * } else {
+ *   const minRequired = shannonsToAi3(DEFAULT_CONSENSUS_EXISTENTIAL_DEPOSIT_SHANNONS)
+ *   console.log(`Amount too low. Minimum required: ${minRequired} AI3 for consensus`)
+ * }
+ *
+ * // Examples of different amounts
+ * console.log(meetsConsensusExistentialDepositAi3("0.000005")) // false - below ED
+ * console.log(meetsConsensusExistentialDepositAi3("0.00001"))  // true - exactly at ED
+ * console.log(meetsConsensusExistentialDepositAi3("0.00002"))  // true - above ED
+ * console.log(meetsConsensusExistentialDepositAi3("1"))         // true - well above ED
+ */
+const meetsConsensusExistentialDepositAi3 = (amount) => {
+    return (0, exports.meetsConsensusExistentialDepositShannons)((0, exports.ai3ToShannons)(amount));
+};
+exports.meetsConsensusExistentialDepositAi3 = meetsConsensusExistentialDepositAi3;
+/**
+ * Checks if a Shannon amount meets the Autonomys Network consensus chain existential deposit requirement.
+ *
+ * This is the Shannon-based version of `meetsConsensusExistentialDepositAi3` 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 consensus chain, the existential deposit is 10,000,000,000,000 Shannons (0.00001 AI3).
+ *
+ * @param amount - Shannon amount as BigInt (smallest units)
+ * @returns true if the amount meets or exceeds the consensus chain existential deposit requirement
+ * @see meetsDomainExistentialDepositShannons - for domain/EVM existential deposit validation
+ *
+ * @example
+ * import { meetsConsensusExistentialDepositShannons, DEFAULT_CONSENSUS_EXISTENTIAL_DEPOSIT_SHANNONS } from '@autonomys/auto-utils'
+ *
+ * // Check if Shannon amount meets consensus ED requirement
+ * const shannons = BigInt('10000000000000') // 0.00001 AI3
+ * if (meetsConsensusExistentialDepositShannons(shannons)) {
+ *   console.log('Amount meets consensus existential deposit requirement')
+ * }
+ *
+ * // Examples with different Shannon amounts
+ * console.log(meetsConsensusExistentialDepositShannons(BigInt('9999999999999'))) // false - below ED
+ * console.log(meetsConsensusExistentialDepositShannons(BigInt('10000000000000'))) // true - exactly at ED
+ * console.log(meetsConsensusExistentialDepositShannons(BigInt('20000000000000'))) // true - above ED
+ * console.log(meetsConsensusExistentialDepositShannons(BigInt('1000000000000000000'))) // true - 1 AI3
+ *
+ * // Works with the constant directly
+ * console.log(meetsConsensusExistentialDepositShannons(DEFAULT_CONSENSUS_EXISTENTIAL_DEPOSIT_SHANNONS)) // true
+ *
+ * // Handles negative amounts
+ * console.log(meetsConsensusExistentialDepositShannons(BigInt('-10000000000000'))) // false
+ */
+const meetsConsensusExistentialDepositShannons = (amount) => {
+    return amount >= token_1.DEFAULT_CONSENSUS_EXISTENTIAL_DEPOSIT_SHANNONS;
+};
+exports.meetsConsensusExistentialDepositShannons = meetsConsensusExistentialDepositShannons;
+/**
+ * Checks if an AI3 amount meets the Autonomys Network domain/EVM 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 is for domains/EVM specifically. For consensus chain, use `meetsConsensusExistentialDepositAi3`.
+ * For direct Shannon (BigInt) validation, use `meetsDomainExistentialDepositShannons` instead.
+ *
+ * For Autonomys Network domains/EVM, 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 domain/EVM existential deposit requirement
+ * @throws Error if the amount format is invalid (same validation as ai3ToShannons)
+ * @see meetsDomainExistentialDepositShannons - for direct Shannon (BigInt) validation
+ * @see meetsConsensusExistentialDepositAi3 - for consensus chain existential deposit validation
+ *
+ * @example
+ * import { meetsDomainExistentialDepositAi3, DEFAULT_DOMAIN_EXISTENTIAL_DEPOSIT_SHANNONS, shannonsToAi3 } from '@autonomys/auto-utils'
+ *
+ * // Check if amount meets domain/EVM ED requirement
+ * const amount = "0.000001"
+ * if (meetsDomainExistentialDepositAi3(amount)) {
+ *   console.log('Amount meets domain existential deposit requirement')
+ * } else {
+ *   const minRequired = shannonsToAi3(DEFAULT_DOMAIN_EXISTENTIAL_DEPOSIT_SHANNONS)
+ *   console.log(`Amount too low. Minimum required: ${minRequired} AI3 for domains`)
+ * }
+ *
+ * // Examples of different amounts
+ * console.log(meetsDomainExistentialDepositAi3("0.0000005")) // false - below ED
+ * console.log(meetsDomainExistentialDepositAi3("0.000001"))  // true - exactly at ED
+ * console.log(meetsDomainExistentialDepositAi3("0.000002"))  // true - above ED
+ * console.log(meetsDomainExistentialDepositAi3("1"))         // true - well above ED
+ */
+const meetsDomainExistentialDepositAi3 = (amount) => {
+    return (0, exports.meetsDomainExistentialDepositShannons)((0, exports.ai3ToShannons)(amount));
+};
+exports.meetsDomainExistentialDepositAi3 = meetsDomainExistentialDepositAi3;
+/**
+ * Checks if a Shannon amount meets the Autonomys Network domain/EVM existential deposit requirement.
+ *
+ * This is the Shannon-based version of `meetsDomainExistentialDepositAi3` 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 domains/EVM, 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 domain/EVM existential deposit requirement
+ * @see meetsConsensusExistentialDepositShannons - for consensus chain existential deposit validation
+ *
+ * @example
+ * import { meetsDomainExistentialDepositShannons, DEFAULT_DOMAIN_EXISTENTIAL_DEPOSIT_SHANNONS } from '@autonomys/auto-utils'
+ *
+ * // Check if Shannon amount meets domain/EVM ED requirement
+ * const shannons = BigInt('1000000000000') // 0.000001 AI3
+ * if (meetsDomainExistentialDepositShannons(shannons)) {
+ *   console.log('Amount meets domain existential deposit requirement')
+ * }
+ *
+ * // Examples with different Shannon amounts
+ * console.log(meetsDomainExistentialDepositShannons(BigInt('999999999999'))) // false - below ED
+ * console.log(meetsDomainExistentialDepositShannons(BigInt('1000000000000'))) // true - exactly at ED
+ * console.log(meetsDomainExistentialDepositShannons(BigInt('2000000000000'))) // true - above ED
+ * console.log(meetsDomainExistentialDepositShannons(BigInt('1000000000000000000'))) // true - 1 AI3
+ *
+ * // Works with the constant directly
+ * console.log(meetsDomainExistentialDepositShannons(DEFAULT_DOMAIN_EXISTENTIAL_DEPOSIT_SHANNONS)) // true
+ *
+ * // Handles negative amounts
+ * console.log(meetsDomainExistentialDepositShannons(BigInt('-1000000000000'))) // false
+ */
+const meetsDomainExistentialDepositShannons = (amount) => {
+    return amount >= token_1.DEFAULT_DOMAIN_EXISTENTIAL_DEPOSIT_SHANNONS;
+};
+exports.meetsDomainExistentialDepositShannons = meetsDomainExistentialDepositShannons;

package/dist/types/wallet.d.ts

@@ -18,7 +18,9 @@ export type MnemonicOrURI = Mnemonic | URI;
 export type WalletType = {
     type?: KeypairType;
 };
-export type SetupWalletParams = MnemonicOrURI & WalletType;
+export type SetupWalletParams = MnemonicOrURI & WalletType & {
+    derivationPath?: string;
+};
 export type Wallet = {
     keyringPair?: KeyringPair;
     injectedAccount?: InjectedAccountWithMeta;
@@ -28,7 +30,9 @@ export type Wallet = {
 export interface GeneratedWallet extends Wallet {
     mnemonic: string;
 }
-export type ActivateWalletParams = (NetworkParams | DomainParams) & MnemonicOrURI & ExtraActivationOptions & WalletType;
+export type ActivateWalletParams = (NetworkParams | DomainParams) & MnemonicOrURI & ExtraActivationOptions & WalletType & {
+    derivationPath?: string;
+};
 export type WalletActivated = {
     api: ApiPromise;
     accounts: InjectedAccountWithMeta[] & KeyringPair[];

package/dist/types/wallet.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"wallet.d.ts","sourceRoot":"","sources":["../../src/types/wallet.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAC/C,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAC7F,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAA;AAC/E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAA;AAC9D,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,WAAW,CAAA;AAE5D,MAAM,MAAM,QAAQ,GAAG;IACrB,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,GAAG,GAAG;IAChB,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,GAAG,CAAC,EAAE,UAAU,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,GAAG,CAAA;AAE1C,MAAM,MAAM,UAAU,GAAG;IACvB,IAAI,CAAC,EAAE,WAAW,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG,aAAa,GAAG,UAAU,CAAA;AAE1D,MAAM,MAAM,MAAM,GAAG;IACnB,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,eAAe,CAAC,EAAE,uBAAuB,CAAA;IACzC,OAAO,EAAE,MAAM,CAAA;IACf,aAAa,EAAE,MAAM,CAAA;CACtB,CAAA;AAED,MAAM,WAAW,eAAgB,SAAQ,MAAM;IAC7C,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,MAAM,oBAAoB,GAAG,CAAC,aAAa,GAAG,YAAY,CAAC,GAC/D,aAAa,GACb,sBAAsB,GACtB,UAAU,CAAA;AAEZ,MAAM,MAAM,eAAe,GAAG;IAC5B,GAAG,EAAE,UAAU,CAAA;IACf,QAAQ,EAAE,uBAAuB,EAAE,GAAG,WAAW,EAAE,CAAA;IACnD,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,cAAc,GAAG,aAAa,CAAC,SAAS,CAAC,CAAA;AAErD,MAAM,MAAM,GAAG,GAAG,UAAU,GAAG,cAAc,CAAA;AAE7C,YAAY,EACV,aAAa,EACb,aAAa,EACb,UAAU,EACV,uBAAuB,EACvB,WAAW,EACX,WAAW,EACX,MAAM,EACN,YAAY,GACb,CAAA"}
+{"version":3,"file":"wallet.d.ts","sourceRoot":"","sources":["../../src/types/wallet.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAC/C,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAC7F,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAA;AAC/E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAA;AAC9D,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,WAAW,CAAA;AAE5D,MAAM,MAAM,QAAQ,GAAG;IACrB,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,GAAG,GAAG;IAChB,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,GAAG,CAAC,EAAE,UAAU,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,GAAG,CAAA;AAE1C,MAAM,MAAM,UAAU,GAAG;IACvB,IAAI,CAAC,EAAE,WAAW,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG,aAAa,GAC3C,UAAU,GAAG;IACX,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB,CAAA;AAEH,MAAM,MAAM,MAAM,GAAG;IACnB,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,eAAe,CAAC,EAAE,uBAAuB,CAAA;IACzC,OAAO,EAAE,MAAM,CAAA;IACf,aAAa,EAAE,MAAM,CAAA;CACtB,CAAA;AAED,MAAM,WAAW,eAAgB,SAAQ,MAAM;IAC7C,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,MAAM,oBAAoB,GAAG,CAAC,aAAa,GAAG,YAAY,CAAC,GAC/D,aAAa,GACb,sBAAsB,GACtB,UAAU,GAAG;IACX,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB,CAAA;AAEH,MAAM,MAAM,eAAe,GAAG;IAC5B,GAAG,EAAE,UAAU,CAAA;IACf,QAAQ,EAAE,uBAAuB,EAAE,GAAG,WAAW,EAAE,CAAA;IACnD,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,cAAc,GAAG,aAAa,CAAC,SAAS,CAAC,CAAA;AAErD,MAAM,MAAM,GAAG,GAAG,UAAU,GAAG,cAAc,CAAA;AAE7C,YAAY,EACV,aAAa,EACb,aAAa,EACb,UAAU,EACV,uBAAuB,EACvB,WAAW,EACX,WAAW,EACX,MAAM,EACN,YAAY,GACb,CAAA"}

package/dist/wallet.d.ts

@@ -27,6 +27,14 @@ import type { ActivateWalletParams, ApiPromise, GeneratedWallet, KeypairType, Se
  * })
  * console.log(ethWallet.address) // Ethereum-format address (0x...)
  *
+ * // Setup ethereum wallet with BIP44 derivation path
+ * const ethBip44 = setupWallet({
+ *   mnemonic: 'abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about',
+ *   type: 'ethereum',
+ *   derivationPath: "m/44'/60'/0'/0/0",
+ * })
+ * console.log(ethBip44.address) // Matches MetaMask default derivation
+ *
  * // Setup development wallet from URI
  * const aliceWallet = setupWallet({ uri: '//Alice' })
  * console.log(aliceWallet.address) // Alice's development address
@@ -91,22 +99,22 @@ export declare const generateWallet: (type?: KeypairType) => GeneratedWallet;
  * console.log('Account address:', accounts[0].address)
  *
  * // Activate on specific network
- * const { api: taurusApi, accounts: taurusAccounts } = await activateWallet({
+ * const { api: mainnetApi, accounts: mainnetAccounts } = await activateWallet({
  *   mnemonic: 'your mnemonic here',
- *   networkId: 'taurus'
+ *   networkId: 'mainnet'
  * })
  *
  * // Activate on domain
  * const { api: domainApi, accounts: domainAccounts } = await activateWallet({
  *   uri: '//Alice',
- *   networkId: 'taurus',
+ *   networkId: 'mainnet',
  *   domainId: '0' // Auto-EVM domain
  * })
  *
  * // Activate with ethereum key type
  * const { api: ethApi, accounts: ethAccounts } = await activateWallet({
  *   mnemonic: 'your mnemonic here',
- *   networkId: 'taurus',
+ *   networkId: 'mainnet',
  *   type: 'ethereum'
  * })
  *
@@ -144,7 +152,7 @@ export declare const activateWallet: (params: ActivateWalletParams) => Promise<W
  * console.log('Created', wallets.length, 'mock wallets')
  *
  * // Create mock wallets for testnet
- * const testWallets = await mockWallets({ networkId: 'taurus' })
+ * const testWallets = await mockWallets({ networkId: 'mainnet' })
  *
  * // Create mock wallets with existing API
  * const api = await activate({ networkId: 'localhost' })
@@ -152,7 +160,7 @@ export declare const activateWallet: (params: ActivateWalletParams) => Promise<W
  *
  * // Create ethereum-type mock wallets
  * const ethWallets = await mockWallets(
- *   { networkId: 'taurus' },
+ *   { networkId: 'mainnet' },
  *   undefined,
  *   'ethereum'
  * )

package/dist/wallet.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"wallet.d.ts","sourceRoot":"","sources":["../src/wallet.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,YAAY,EAAY,aAAa,EAAO,MAAM,SAAS,CAAA;AACzE,OAAO,KAAK,EACV,oBAAoB,EACpB,UAAU,EACV,eAAe,EACf,WAAW,EACX,iBAAiB,EACjB,MAAM,EACN,eAAe,EAChB,MAAM,gBAAgB,CAAA;AAEvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,eAAO,MAAM,WAAW,GAAI,QAAQ,iBAAiB,KAAG,MAkBvD,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,eAAO,MAAM,cAAc,GAAI,OAAM,WAAuB,KAAG,eAU9D,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG;AACH,eAAO,MAAM,cAAc,GAAU,QAAQ,oBAAoB,KAAG,OAAO,CAAC,eAAe,CAmC1F,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,eAAO,MAAM,WAAW,GACtB,UAAS,aAAa,GAAG,YAA+C,EACxE,MAAM,UAAU,EAChB,OAAO,WAAW,KACjB,OAAO,CAAC,eAAe,EAAE,CAa3B,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,eAAO,MAAM,aAAa,GAAI,MAAM,MAAM,EAAE,SAAS,eAAe,EAAE,KAAG,eAClB,CAAA"}
+{"version":3,"file":"wallet.d.ts","sourceRoot":"","sources":["../src/wallet.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,YAAY,EAAY,aAAa,EAAO,MAAM,SAAS,CAAA;AACzE,OAAO,KAAK,EACV,oBAAoB,EACpB,UAAU,EACV,eAAe,EACf,WAAW,EACX,iBAAiB,EACjB,MAAM,EACN,eAAe,EAChB,MAAM,gBAAgB,CAAA;AAEvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,eAAO,MAAM,WAAW,GAAI,QAAQ,iBAAiB,KAAG,MAoBvD,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,eAAO,MAAM,cAAc,GAAI,OAAM,WAAuB,KAAG,eAU9D,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG;AACH,eAAO,MAAM,cAAc,GAAU,QAAQ,oBAAoB,KAAG,OAAO,CAAC,eAAe,CAmC1F,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,eAAO,MAAM,WAAW,GACtB,UAAS,aAAa,GAAG,YAA+C,EACxE,MAAM,UAAU,EAChB,OAAO,WAAW,KACjB,OAAO,CAAC,eAAe,EAAE,CAa3B,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,eAAO,MAAM,aAAa,GAAI,MAAM,MAAM,EAAE,SAAS,eAAe,EAAE,KAAG,eAClB,CAAA"}

package/dist/wallet.js

@@ -68,6 +68,14 @@ const wallet_1 = require("./constants/wallet");
  * })
  * console.log(ethWallet.address) // Ethereum-format address (0x...)
  *
+ * // Setup ethereum wallet with BIP44 derivation path
+ * const ethBip44 = setupWallet({
+ *   mnemonic: 'abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about',
+ *   type: 'ethereum',
+ *   derivationPath: "m/44'/60'/0'/0/0",
+ * })
+ * console.log(ethBip44.address) // Matches MetaMask default derivation
+ *
  * // Setup development wallet from URI
  * const aliceWallet = setupWallet({ uri: '//Alice' })
  * console.log(aliceWallet.address) // Alice's development address
@@ -89,7 +97,9 @@ const setupWallet = (params) => {
     }
     else if (params.mnemonic) {
         // Treat as mnemonic
-        keyringPair = keyring.addFromUri(params.mnemonic);
+        const base = params.mnemonic;
+        const withPath = params.derivationPath ? `${base}/${params.derivationPath}` : base;
+        keyringPair = keyring.addFromUri(withPath);
     }
     else
         throw new Error('Invalid mnemonic or private key');
@@ -162,22 +172,22 @@ exports.generateWallet = generateWallet;
  * console.log('Account address:', accounts[0].address)
  *
  * // Activate on specific network
- * const { api: taurusApi, accounts: taurusAccounts } = await activateWallet({
+ * const { api: mainnetApi, accounts: mainnetAccounts } = await activateWallet({
  *   mnemonic: 'your mnemonic here',
- *   networkId: 'taurus'
+ *   networkId: 'mainnet'
  * })
  *
  * // Activate on domain
  * const { api: domainApi, accounts: domainAccounts } = await activateWallet({
  *   uri: '//Alice',
- *   networkId: 'taurus',
+ *   networkId: 'mainnet',
  *   domainId: '0' // Auto-EVM domain
  * })
  *
  * // Activate with ethereum key type
  * const { api: ethApi, accounts: ethAccounts } = await activateWallet({
  *   mnemonic: 'your mnemonic here',
- *   networkId: 'taurus',
+ *   networkId: 'mainnet',
  *   type: 'ethereum'
  * })
  *
@@ -250,7 +260,7 @@ exports.activateWallet = activateWallet;
  * console.log('Created', wallets.length, 'mock wallets')
  *
  * // Create mock wallets for testnet
- * const testWallets = await mockWallets({ networkId: 'taurus' })
+ * const testWallets = await mockWallets({ networkId: 'mainnet' })
  *
  * // Create mock wallets with existing API
  * const api = await activate({ networkId: 'localhost' })
@@ -258,7 +268,7 @@ exports.activateWallet = activateWallet;
  *
  * // Create ethereum-type mock wallets
  * const ethWallets = await mockWallets(
- *   { networkId: 'taurus' },
+ *   { networkId: 'mainnet' },
  *   undefined,
  *   'ethereum'
  * )

package/package.json

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