@rabby-wallet/eth-hd-keyring 4.2.0 → 4.3.0-beta.2

package/index.ts

@@ -4,7 +4,13 @@ import SimpleKeyring from '@rabby-wallet/eth-simple-keyring';
 import * as bip39 from '@scure/bip39';
 import { wordlist } from '@scure/bip39/wordlists/english';
 import * as sigUtil from 'eth-sig-util';
-import { bytesToHex, publicToAddress, privateToPublic } from '@ethereumjs/util';
+import {
+  bytesToHex,
+  publicToAddress,
+  privateToPublic,
+  hexToBytes,
+} from '@ethereumjs/util';
+import slip39 from 'slip39';
 
 // Options:
 const type = 'HD Key Tree';
@@ -43,6 +49,7 @@ interface DeserializeOption {
   accounts?: string[];
   accountDetails?: Record<string, AccountDetail>;
   publicKey?: string;
+  isSlip39?: boolean;
 }
 
 interface AccountDetail {
@@ -70,6 +77,7 @@ class HdKeyring extends SimpleKeyring {
   accounts: string[] = [];
   accountDetails: Record<string, AccountDetail> = {};
   passphrase?: string = '';
+  isSlip39 = false;
 
   /* PUBLIC METHODS */
   constructor(opts: DeserializeOption = {} as any) {
@@ -91,6 +99,7 @@ class HdKeyring extends SimpleKeyring {
       accounts: this.accounts,
       accountDetails: this.accountDetails,
       publicKey: this.publicKey,
+      isSlip39: this.isSlip39,
     });
   }
 
@@ -105,6 +114,7 @@ class HdKeyring extends SimpleKeyring {
     this.accounts = opts.accounts || [];
     this.accountDetails = opts.accountDetails || {};
     this.publicKey = opts.publicKey || '';
+    this.isSlip39 = opts.isSlip39 || false;
 
     if (opts.mnemonic) {
       this.mnemonic = opts.mnemonic;
@@ -119,9 +129,9 @@ class HdKeyring extends SimpleKeyring {
     return Promise.resolve([]);
   }
 
-  initFromMnemonic(mnemonic, passphrase?: string) {
+  initFromMnemonic(mnemonic: string, passphrase?: string) {
     this.mnemonic = mnemonic;
-    const seed = bip39.mnemonicToSeedSync(mnemonic, passphrase);
+    const seed = this.getSeed(mnemonic, passphrase);
     this.hdWallet = HDKey.fromMasterSeed(seed);
     if (!this.publicKey) {
       this.publicKey = this.calcBasePublicKey(this.hdWallet!);
@@ -357,7 +367,7 @@ class HdKeyring extends SimpleKeyring {
    * if passphrase is correct, the publicKey will be the same as the stored one
    */
   checkPassphrase(passphrase: string) {
-    const seed = bip39.mnemonicToSeedSync(this.mnemonic!, passphrase);
+    const seed = this.getSeed(this.mnemonic!, passphrase);
     const hdWallet = HDKey.fromMasterSeed(seed);
     const publicKey = this.calcBasePublicKey(hdWallet);
 
@@ -383,6 +393,43 @@ class HdKeyring extends SimpleKeyring {
     const hdPath = this.getHDPathBase(hdPathType);
     this.setHdPath(hdPath);
   }
+
+  getSeed(mnemonic: string, passphrase?: string) {
+    if (HdKeyring.checkMnemonicIsSlip39(mnemonic)) {
+      this.isSlip39 = true;
+      return this.slip39MnemonicToSeedSync(mnemonic, passphrase);
+    }
+    return bip39.mnemonicToSeedSync(mnemonic, passphrase);
+  }
+
+  slip39MnemonicToSeedSync(mnemonic: string, passphrase?: string) {
+    const secretShares = mnemonic.split('\n');
+    const secretBytes = slip39.recoverSecret(secretShares, passphrase);
+    const seed = hexToBytes(bytesToHex(secretBytes));
+
+    return seed;
+  }
+
+  static checkMnemonicIsSlip39(mnemonic: string) {
+    const arr = mnemonic.split('\n');
+    try {
+      HdKeyring.slip39DecodeMnemonics(arr);
+      return true;
+    } catch (e) {
+      return false;
+    }
+  }
+
+  static slip39DecodeMnemonics(shares: string[]) {
+    return slip39.decodeMnemonics(shares);
+  }
+
+  static validateMnemonic(mnemonic: string) {
+    if (this.checkMnemonicIsSlip39(mnemonic)) {
+      return true;
+    }
+    return bip39.validateMnemonic(mnemonic, wordlist);
+  }
 }
 
 export default HdKeyring;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rabby-wallet/eth-hd-keyring",
-  "version": "4.2.0",
+  "version": "4.3.0-beta.2",
   "description": "A simple standard interface for a seed phrase generated set of Ethereum accounts.",
   "keywords": [
     "ethereum",
@@ -18,7 +18,7 @@
   "author": "Dan Finlay",
   "main": "dist/index.js",
   "scripts": {
-    "build": "tsc",
+    "build": "tsup index.ts",
     "setup": "yarn install && yarn allow-scripts",
     "lint:eslint": "eslint . --cache --ext js,ts",
     "lint:misc": "prettier '**/*.json' '**/*.md' '!CHANGELOG.md' '**/*.yml' --ignore-path .gitignore",
@@ -32,7 +32,8 @@
     "@rabby-wallet/eth-simple-keyring": "^5.0.1",
     "@scure/bip39": "^1.2.1",
     "eth-sig-util": "^3.0.1",
-    "ethereum-cryptography": "^2.1.2"
+    "ethereum-cryptography": "^2.1.2",
+    "slip39": "^0.1.9"
   },
   "devDependencies": {
     "@lavamoat/allow-scripts": "^1.0.6",
@@ -47,8 +48,10 @@
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^3.3.1",
     "mocha": "^8.1.3",
+    "patch-package": "^8.0.0",
     "prettier": "^2.4.1",
     "prettier-plugin-packagejson": "^2.2.12",
+    "tsup": "^8.1.0",
     "typescript": "^4.4.4"
   },
   "engines": {
@@ -64,5 +67,11 @@
       "keccak": false,
       "secp256k1": false
     }
+  },
+  "tsup": {
+    "dts": true,
+    "noExternal": [
+      "slip39"
+    ]
   }
 }

package/patches/slip39+0.1.9.patch

@@ -0,0 +1,48 @@
+diff --git a/node_modules/slip39/src/slip39.js b/node_modules/slip39/src/slip39.js
+index aff1c16..bd3ba54 100644
+--- a/node_modules/slip39/src/slip39.js
++++ b/node_modules/slip39/src/slip39.js
+@@ -180,6 +180,10 @@ class Slip39 {
+     return slipHelper.validateMnemonic(mnemonic);
+   }
+ 
++  static decodeMnemonics = slipHelper.decodeMnemonics;
++
++  static decodeMnemonic = slipHelper.decodeMnemonic;
++
+   fromPath(path) {
+     this.validatePath(path);
+ 
+diff --git a/node_modules/slip39/src/slip39_helper.js b/node_modules/slip39/src/slip39_helper.js
+index 8bcb956..3bf2210 100644
+--- a/node_modules/slip39/src/slip39_helper.js
++++ b/node_modules/slip39/src/slip39_helper.js
+@@ -100,21 +100,6 @@ Array.prototype.slip39Generate = function (m, v = (_) => _) {
+   return this;
+ };
+ 
+-Array.prototype.toHexString = function () {
+-  return Array.prototype.map
+-    .call(this, function (byte) {
+-      return ("0" + (byte & 0xff).toString(16)).slice(-2);
+-    })
+-    .join("");
+-};
+-
+-Array.prototype.toByteArray = function (hexString) {
+-  for (let i = 0; i < hexString.length; i = i + 2) {
+-    this.push(parseInt(hexString.substr(i, 2), 16));
+-  }
+-  return this;
+-};
+-
+ const BIGINT_WORD_BITS = BigInt(8);
+ 
+ function decodeBigInt(bytes) {
+@@ -1886,4 +1871,6 @@ exports = module.exports = {
+   crypt,
+   bitsToBytes,
+   WORD_LIST,
++  decodeMnemonics,
++  decodeMnemonic,
+ };