@xyo-network/wallet-model 3.13.0 → 3.14.1

package/dist/types/Mnemonic.d.ts

@@ -0,0 +1,27 @@
+import type { WordlistInstance } from './Wordlist.ts';
+export interface MnemonicInstance {
+    /**
+     *  The underlying entropy which the mnemonic encodes.
+     */
+    entropy: string;
+    /**
+     *  The password used for this mnemonic. If no password is used this
+     *  is the empty string (i.e. ``""``) as per the specification.
+     */
+    password: string;
+    /**
+     *  The mnemonic phrase of 12, 15, 18, 21 or 24 words.
+     *
+     *  Use the [[wordlist]] ``split`` method to get the individual words.
+     */
+    phrase: string;
+    /**
+     *  The wordlist for this mnemonic.
+     */
+    wordlist: WordlistInstance;
+    /**
+     *  Returns the seed for the mnemonic.
+     */
+    computeSeed(): string;
+}
+//# sourceMappingURL=Mnemonic.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Mnemonic.d.ts","sourceRoot":"","sources":["../../src/Mnemonic.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAA;AAErD,MAAM,WAAW,gBAAgB;IAE/B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,QAAQ,EAAE,gBAAgB,CAAA;IAE1B;;OAEG;IACH,WAAW,IAAI,MAAM,CAAA;CACtB"}

package/dist/types/Wallet.d.ts

@@ -1,6 +1,6 @@
 import type { Hex } from '@xylabs/hex';
 import type { AccountConfig, AccountInstance, AccountStatic } from '@xyo-network/account-model';
-import type { Mnemonic } from 'ethers';
+import type { MnemonicInstance } from './Mnemonic.ts';
 export interface WalletInstance extends AccountInstance {
     readonly chainCode: string;
     readonly depth: number;
@@ -8,7 +8,7 @@ export interface WalletInstance extends AccountInstance {
     readonly extendedKey: string;
     readonly fingerprint: string;
     readonly index: number;
-    readonly mnemonic?: Mnemonic | null;
+    readonly mnemonic?: MnemonicInstance | null;
     readonly neuter: () => WalletInstance;
     readonly parentFingerprint: string;
     readonly path: string | null;
@@ -18,7 +18,7 @@ export interface WalletInstance extends AccountInstance {
 export interface WalletStatic<T extends WalletInstance = WalletInstance> extends Omit<AccountStatic<T>, 'create'> {
     create(config: AccountConfig): Promise<T>;
     fromExtendedKey(key: string): Promise<T>;
-    fromMnemonic(mnemonic: Mnemonic): Promise<T>;
+    fromMnemonic(mnemonic: MnemonicInstance): Promise<T>;
     fromPhrase(mnemonic: string, path?: string): Promise<T>;
     fromSeed(seed: string | ArrayBufferLike): Promise<T>;
     random(): any;

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

@@ -1 +1 @@
-{"version":3,"file":"Wallet.d.ts","sourceRoot":"","sources":["../../src/Wallet.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,aAAa,CAAA;AACtC,OAAO,KAAK,EACV,aAAa,EAAE,eAAe,EAAE,aAAa,EAC9C,MAAM,4BAA4B,CAAA;AACnC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAA;AAEtC,MAAM,WAAW,cAAe,SAAQ,eAAe;IACrD,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,UAAU,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,cAAc,CAAC,CAAA;IAC9D,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAA;IACnC,QAAQ,CAAC,MAAM,EAAE,MAAM,cAAc,CAAA;IACrC,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAA;IAClC,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,QAAQ,CAAC,UAAU,EAAE,GAAG,CAAA;IACxB,QAAQ,CAAC,SAAS,EAAE,GAAG,CAAA;CACxB;AAED,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,cAAc,GAAG,cAAc,CAAE,SAAQ,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC;IAC/G,MAAM,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;IACzC,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;IACxC,YAAY,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;IAC5C,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;IACvD,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,eAAe,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;IAEpD,MAAM,IAAI,GAAG,CAAA;CACd"}
+{"version":3,"file":"Wallet.d.ts","sourceRoot":"","sources":["../../src/Wallet.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,aAAa,CAAA;AACtC,OAAO,KAAK,EACV,aAAa,EAAE,eAAe,EAAE,aAAa,EAC9C,MAAM,4BAA4B,CAAA;AAEnC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAA;AAErD,MAAM,WAAW,cAAe,SAAQ,eAAe;IACrD,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,UAAU,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,cAAc,CAAC,CAAA;IAC9D,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,QAAQ,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAA;IAC3C,QAAQ,CAAC,MAAM,EAAE,MAAM,cAAc,CAAA;IACrC,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAA;IAClC,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,QAAQ,CAAC,UAAU,EAAE,GAAG,CAAA;IACxB,QAAQ,CAAC,SAAS,EAAE,GAAG,CAAA;CACxB;AAED,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,cAAc,GAAG,cAAc,CAAE,SAAQ,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC;IAC/G,MAAM,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;IACzC,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;IACxC,YAAY,CAAC,QAAQ,EAAE,gBAAgB,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;IACpD,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;IACvD,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,eAAe,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;IAEpD,MAAM,IAAI,GAAG,CAAA;CACd"}

package/dist/types/Wordlist.d.ts

@@ -0,0 +1,24 @@
+export interface WordlistInstance {
+    locale: string;
+    /**
+       *  Maps an 11-bit value into its coresponding word in the list.
+       *
+       *  Sub-classes MUST override this.
+       */
+    getWord(index: number): string;
+    /**
+       *  Maps a word to its corresponding 11-bit value.
+       *
+       *  Sub-classes MUST override this.
+       */
+    getWordIndex(word: string): number;
+    /**
+     *  Sub-classes may override this to provider a language-specific
+     *  method for joining %%words%% into a phrase.
+     *
+     *  By default, %%words%% are joined by a single space.
+     */
+    join(words: Array<string>): string;
+    split(phrase: string): Array<string>;
+}
+//# sourceMappingURL=Wordlist.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Wordlist.d.ts","sourceRoot":"","sources":["../../src/Wordlist.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,MAAM,CAAA;IAEd;;;;SAIK;IACL,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;IAE9B;;;;SAIK;IACL,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;IAElC;;;;;OAKG;IACH,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,MAAM,CAAA;IAElC,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAA;CAErC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/wallet-model",
-  "version": "3.13.0",
+  "version": "3.14.1",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -30,22 +30,13 @@
   "types": "dist/types/index.d.ts",
   "dependencies": {
     "@xylabs/hex": "^4.8.7",
-    "@xyo-network/account-model": "^3.13.0"
+    "@xyo-network/account-model": "^3.14.1"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^6.3.4",
-    "@xylabs/tsconfig": "^6.3.4",
-    "ethers": "6.13.6",
+    "@xylabs/ts-scripts-yarn3": "^6.3.5",
+    "@xylabs/tsconfig": "^6.3.5",
     "typescript": "^5.8.3"
   },
-  "peerDependencies": {
-    "ethers": "^6"
-  },
-  "peerDependenciesMeta": {
-    "ethers": {
-      "optional": true
-    }
-  },
   "publishConfig": {
     "access": "public"
   }

package/src/Mnemonic.ts

@@ -0,0 +1,32 @@
+import type { WordlistInstance } from './Wordlist.ts'
+
+export interface MnemonicInstance {
+
+  /**
+   *  The underlying entropy which the mnemonic encodes.
+   */
+  entropy: string
+
+  /**
+   *  The password used for this mnemonic. If no password is used this
+   *  is the empty string (i.e. ``""``) as per the specification.
+   */
+  password: string
+
+  /**
+   *  The mnemonic phrase of 12, 15, 18, 21 or 24 words.
+   *
+   *  Use the [[wordlist]] ``split`` method to get the individual words.
+   */
+  phrase: string
+
+  /**
+   *  The wordlist for this mnemonic.
+   */
+  wordlist: WordlistInstance
+
+  /**
+   *  Returns the seed for the mnemonic.
+   */
+  computeSeed(): string
+}

package/src/Wallet.ts

@@ -2,7 +2,8 @@ import type { Hex } from '@xylabs/hex'
 import type {
   AccountConfig, AccountInstance, AccountStatic,
 } from '@xyo-network/account-model'
-import type { Mnemonic } from 'ethers'
+
+import type { MnemonicInstance } from './Mnemonic.ts'
 
 export interface WalletInstance extends AccountInstance {
   readonly chainCode: string
@@ -11,7 +12,7 @@ export interface WalletInstance extends AccountInstance {
   readonly extendedKey: string
   readonly fingerprint: string
   readonly index: number
-  readonly mnemonic?: Mnemonic | null
+  readonly mnemonic?: MnemonicInstance | null
   readonly neuter: () => WalletInstance
   readonly parentFingerprint: string
   readonly path: string | null
@@ -22,7 +23,7 @@ export interface WalletInstance extends AccountInstance {
 export interface WalletStatic<T extends WalletInstance = WalletInstance> extends Omit<AccountStatic<T>, 'create'> {
   create(config: AccountConfig): Promise<T>
   fromExtendedKey(key: string): Promise<T>
-  fromMnemonic(mnemonic: Mnemonic): Promise<T>
+  fromMnemonic(mnemonic: MnemonicInstance): Promise<T>
   fromPhrase(mnemonic: string, path?: string): Promise<T>
   fromSeed(seed: string | ArrayBufferLike): Promise<T>
   // eslint-disable-next-line @typescript-eslint/no-explicit-any

package/src/Wordlist.ts

@@ -0,0 +1,28 @@
+export interface WordlistInstance {
+  locale: string
+
+  /**
+     *  Maps an 11-bit value into its coresponding word in the list.
+     *
+     *  Sub-classes MUST override this.
+     */
+  getWord(index: number): string
+
+  /**
+     *  Maps a word to its corresponding 11-bit value.
+     *
+     *  Sub-classes MUST override this.
+     */
+  getWordIndex(word: string): number
+
+  /**
+   *  Sub-classes may override this to provider a language-specific
+   *  method for joining %%words%% into a phrase.
+   *
+   *  By default, %%words%% are joined by a single space.
+   */
+  join(words: Array<string>): string
+
+  split(phrase: string): Array<string>
+
+}