@rabby-wallet/eth-hd-keyring 3.6.11 → 4.0.0-alpha

package/dist/index.js

@@ -31,10 +31,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const ethereumjs_wallet_1 = require("ethereumjs-wallet");
+// import Wallet, { hdkey } from 'ethereumjs-wallet';
+const hdkey_1 = require("ethereum-cryptography/hdkey");
 const eth_simple_keyring_1 = __importDefault(require("@rabby-wallet/eth-simple-keyring"));
-const bip39 = __importStar(require("bip39"));
+const bip39 = __importStar(require("@scure/bip39"));
+const english_1 = require("@scure/bip39/wordlists/english");
 const sigUtil = __importStar(require("eth-sig-util"));
+const util_1 = require("@ethereumjs/util");
 // Options:
 const hdPathString = "m/44'/60'/0'/0";
 const type = 'HD Key Tree';
@@ -53,6 +56,7 @@ class HdKeyring extends eth_simple_keyring_1.default {
         this.page = 0;
         this.perPage = 5;
         this.byImport = false;
+        this.publicKey = '';
         this.deserialize(opts);
     }
     serialize() {
@@ -62,6 +66,7 @@ class HdKeyring extends eth_simple_keyring_1.default {
             hdPath: this.hdPath,
             byImport: this.byImport,
             index: this.index,
+            publicKey: this.publicKey,
         });
     }
     deserialize(opts = {}) {
@@ -71,6 +76,7 @@ class HdKeyring extends eth_simple_keyring_1.default {
         this.hdPath = opts.hdPath || hdPathString;
         this.byImport = !!opts.byImport;
         this.index = opts.index || 0;
+        this.publicKey = opts.publicKey || '';
         if (opts.mnemonic) {
             this.initFromMnemonic(opts.mnemonic);
         }
@@ -79,16 +85,26 @@ class HdKeyring extends eth_simple_keyring_1.default {
         }
         return Promise.resolve([]);
     }
+    initPublicKey() {
+        this.root = this.hdWallet.derive(this.hdPath);
+        this.publicKey = (0, util_1.bytesToHex)(this.root.publicKey);
+    }
+    getPublicKey() {
+        return this.publicKey;
+    }
     initFromMnemonic(mnemonic) {
         this.mnemonic = mnemonic;
         this._index2wallet = {};
         const seed = bip39.mnemonicToSeedSync(mnemonic);
-        this.hdWallet = ethereumjs_wallet_1.hdkey.fromMasterSeed(seed);
-        this.root = this.hdWallet.derivePath(this.hdPath);
+        this.hdWallet = hdkey_1.HDKey.fromMasterSeed(seed);
+        this.root = this.hdWallet.derive(this.hdPath);
+        if (!this.publicKey) {
+            this.initPublicKey();
+        }
     }
     addAccounts(numberOfAccounts = 1) {
         if (!this.root) {
-            this.initFromMnemonic(bip39.generateMnemonic());
+            this.initFromMnemonic(bip39.generateMnemonic(english_1.wordlist));
         }
         let count = numberOfAccounts;
         let currentIdx = 0;
@@ -106,7 +122,7 @@ class HdKeyring extends eth_simple_keyring_1.default {
             }
         }
         const hexWallets = newWallets.map((w) => {
-            return sigUtil.normalize(w.getAddress().toString('hex'));
+            return sigUtil.normalize(this._addressfromPublicKey(w.publicKey));
         });
         return Promise.resolve(hexWallets);
     }
@@ -169,7 +185,7 @@ class HdKeyring extends eth_simple_keyring_1.default {
     }
     getAccounts() {
         return Promise.resolve(this.wallets.map((w) => {
-            return sigUtil.normalize(w.getAddress().toString('hex'));
+            return sigUtil.normalize(this._addressfromPublicKey(w.publicKey));
         }));
     }
     getIndexByAddress(address) {
@@ -184,12 +200,18 @@ class HdKeyring extends eth_simple_keyring_1.default {
     _addressFromIndex(i) {
         if (!this._index2wallet[i]) {
             const child = this.root.deriveChild(i);
-            const wallet = child.getWallet();
-            const address = sigUtil.normalize(wallet.getAddress().toString('hex'));
+            const wallet = {
+                publicKey: (0, util_1.privateToPublic)(child.privateKey),
+                privateKey: child.privateKey,
+            };
+            const address = sigUtil.normalize(this._addressfromPublicKey(wallet.publicKey));
             this._index2wallet[i] = [address, wallet];
         }
         return this._index2wallet[i];
     }
+    _addressfromPublicKey(publicKey) {
+        return (0, util_1.bytesToHex)((0, util_1.publicToAddress)(publicKey, true)).toLowerCase();
+    }
 }
 HdKeyring.type = type;
 exports.default = HdKeyring;

package/index.ts

@@ -1,18 +1,31 @@
-import Wallet, { hdkey } from 'ethereumjs-wallet';
+// import Wallet, { hdkey } from 'ethereumjs-wallet';
+import { HDKey } from 'ethereum-cryptography/hdkey';
 import SimpleKeyring from '@rabby-wallet/eth-simple-keyring';
-import * as bip39 from 'bip39';
+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';
 
 // Options:
 const hdPathString = "m/44'/60'/0'/0";
 const type = 'HD Key Tree';
 
+interface Wallet {
+  publicKey: Uint8Array;
+  privateKey: Uint8Array;
+}
+
 interface DeserializeOption {
   hdPath?: string;
   mnemonic?: string;
   activeIndexes?: number[];
   byImport?: boolean;
   index?: number;
+  publicKey?: string;
 }
 
 class HdKeyring extends SimpleKeyring {
@@ -21,8 +34,8 @@ class HdKeyring extends SimpleKeyring {
   type = type;
   mnemonic: string | null = null;
   hdPath = hdPathString;
-  hdWallet?: hdkey;
-  root: hdkey | null = null;
+  hdWallet?: HDKey;
+  root: HDKey | null = null;
   wallets: Wallet[] = [];
   _index2wallet: Record<number, [string, Wallet]> = {};
   activeIndexes: number[] = [];
@@ -30,6 +43,7 @@ class HdKeyring extends SimpleKeyring {
   page = 0;
   perPage = 5;
   byImport = false;
+  publicKey: string = '';
 
   /* PUBLIC METHODS */
   constructor(opts = {}) {
@@ -44,6 +58,7 @@ class HdKeyring extends SimpleKeyring {
       hdPath: this.hdPath,
       byImport: this.byImport,
       index: this.index,
+      publicKey: this.publicKey,
     });
   }
 
@@ -54,6 +69,7 @@ class HdKeyring extends SimpleKeyring {
     this.hdPath = opts.hdPath || hdPathString;
     this.byImport = !!opts.byImport;
     this.index = opts.index || 0;
+    this.publicKey = opts.publicKey || '';
 
     if (opts.mnemonic) {
       this.initFromMnemonic(opts.mnemonic);
@@ -66,23 +82,36 @@ class HdKeyring extends SimpleKeyring {
     return Promise.resolve([]);
   }
 
+  private initPublicKey() {
+    this.root = this.hdWallet!.derive(this.hdPath);
+    this.publicKey = bytesToHex(this.root.publicKey);
+  }
+
+  getPublicKey() {
+    return this.publicKey;
+  }
+
   initFromMnemonic(mnemonic) {
     this.mnemonic = mnemonic;
     this._index2wallet = {};
     const seed = bip39.mnemonicToSeedSync(mnemonic);
-    this.hdWallet = hdkey.fromMasterSeed(seed);
-    this.root = this.hdWallet!.derivePath(this.hdPath);
+    this.hdWallet = HDKey.fromMasterSeed(seed);
+    this.root = this.hdWallet!.derive(this.hdPath);
+
+    if (!this.publicKey) {
+      this.initPublicKey();
+    }
   }
 
   addAccounts(numberOfAccounts = 1) {
     if (!this.root) {
-      this.initFromMnemonic(bip39.generateMnemonic());
+      this.initFromMnemonic(bip39.generateMnemonic(wordlist));
     }
 
     let count = numberOfAccounts;
     let currentIdx = 0;
     const newWallets: Wallet[] = [];
-
+    
     while (count) {
       const [, wallet] = this._addressFromIndex(currentIdx);
       if (this.wallets.includes(wallet)) {
@@ -96,7 +125,7 @@ class HdKeyring extends SimpleKeyring {
     }
 
     const hexWallets = newWallets.map((w) => {
-      return sigUtil.normalize(w.getAddress().toString('hex'));
+      return sigUtil.normalize(this._addressfromPublicKey(w.publicKey));
     });
 
     return Promise.resolve(hexWallets);
@@ -178,7 +207,7 @@ class HdKeyring extends SimpleKeyring {
   getAccounts() {
     return Promise.resolve(
       this.wallets.map((w) => {
-        return sigUtil.normalize(w.getAddress().toString('hex'));
+        return sigUtil.normalize(this._addressfromPublicKey(w.publicKey));
       }),
     );
   }
@@ -197,13 +226,22 @@ class HdKeyring extends SimpleKeyring {
   _addressFromIndex(i: number): [string, Wallet] {
     if (!this._index2wallet[i]) {
       const child = this.root!.deriveChild(i);
-      const wallet = child.getWallet();
-      const address = sigUtil.normalize(wallet.getAddress().toString('hex'));
+      const wallet = {
+        publicKey: privateToPublic(child.privateKey),
+        privateKey: child.privateKey,
+      };
+      const address = sigUtil.normalize(
+        this._addressfromPublicKey(wallet.publicKey),
+      );
       this._index2wallet[i] = [address, wallet];
     }
 
     return this._index2wallet[i];
   }
+
+  _addressfromPublicKey(publicKey: Uint8Array) {
+    return bytesToHex(publicToAddress(publicKey, true)).toLowerCase();
+  }
 }
 
 export default HdKeyring;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rabby-wallet/eth-hd-keyring",
-  "version": "3.6.11",
+  "version": "4.0.0-alpha",
   "description": "A simple standard interface for a seed phrase generated set of Ethereum accounts.",
   "keywords": [
     "ethereum",
@@ -27,12 +27,12 @@
     "test": "mocha"
   },
   "dependencies": {
+    "@ethereumjs/util": "^9.0.0",
     "@metamask/eth-sig-util": "^4.0.0",
-    "@rabby-wallet/eth-simple-keyring": "^4.2.1",
-    "bip39": "^3.0.4",
+    "@rabby-wallet/eth-simple-keyring": "5.0.0-alpha",
+    "@scure/bip39": "^1.2.1",
     "eth-sig-util": "^3.0.1",
-    "ethereumjs-util": "^7.0.9",
-    "ethereumjs-wallet": "^1.0.1"
+    "ethereum-cryptography": "^2.1.2"
   },
   "devDependencies": {
     "@lavamoat/allow-scripts": "^1.0.6",

package/test/index.js

@@ -8,6 +8,7 @@ const {
   SignTypedDataVersion,
 } = require('@metamask/eth-sig-util');
 const ethUtil = require('ethereumjs-util');
+const newEthUtil = require('@ethereumjs/util');
 const HdKeyring = require('..').default;
 // Sample account:
 const privKeyHex =
@@ -109,19 +110,20 @@ describe('hd-keyring', function () {
   describe('#getAccounts', function () {
     it('calls getAddress on each wallet', function (done) {
       // Push a mock wallet
-      const desiredOutput = 'foo';
+      const desiredOutput = '0x410264A247892c3b2912AeE58236036A82CA209e';
       keyring.wallets.push({
-        getAddress() {
-          return {
-            toString() {
-              return desiredOutput;
-            },
-          };
-        },
+        publicKey: newEthUtil.importPublic(
+          newEthUtil.hexToBytes(
+            '0x0220381189b226eae955cf7331b649be61b6ec55ea678cb30c7371e9e07dc200bd',
+          ),
+        ),
+        privateKey: newEthUtil.hexToBytes(
+          '0x504560704904af362cab963188f571bccb1498f6ab5113b6bd8d76b6c53a963e',
+        ),
       });
 
       keyring.getAccounts().then((output) => {
-        assert.equal(output[0], `0x${desiredOutput}`);
+        assert.equal(output[0].toLowerCase(), desiredOutput.toLowerCase());
         assert.equal(output.length, 1);
         done();
       });