@metamask/eth-hd-keyring 4.0.0 → 4.0.1

package/CHANGELOG.md

@@ -6,6 +6,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [4.0.1]
+### Added
+- Add tests to get coverage to 100% ([#62](https://github.com/MetaMask/eth-hd-keyring/pull/62))
+
+### Fixed
+- Fix bug where an unexpected error would occur if the mnemonic passed to `_initFromMnemonic` was a buffer array ([#62](https://github.com/MetaMask/eth-hd-keyring/pull/62))
+
 ## [4.0.0]
 ### Changed
 - **BREAKING**: Do not allow re-initialization of keyring instance ([#55](https://github.com/MetaMask/eth-hd-keyring/pull/55))
@@ -14,7 +21,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add `@lavamoat/allow-scripts` ([#47](https://github.com/MetaMask/eth-hd-keyring/pull/47))
     - We now have an allowlist for all post-install scripts. The standard setup script has been added, along with new contributor documentation in the README to explain this script.
 - Obfuscate serialized mnemonic ([#59](https://github.com/MetaMask/eth-hd-keyring/pull/59))
-- Package name changed from `eth-hd-keyring` to `@metamask/eth-hd-keyring`
+    - Class variable `mnemonic` on `HdKeyring` can now be either type `Buffer` or type `string`.
+- Package name changed from `eth-hd-keyring` to `@metamask/eth-hd-keyring`.
 
-[Unreleased]: https://github.com/MetaMask/eth-hd-keyring/compare/v4.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/eth-hd-keyring/compare/v4.0.1...HEAD
+[4.0.1]: https://github.com/MetaMask/eth-hd-keyring/compare/v4.0.0...v4.0.1
 [4.0.0]: https://github.com/MetaMask/eth-hd-keyring/releases/tag/v4.0.0

package/index.js

@@ -38,8 +38,7 @@ class HdKeyring extends SimpleKeyring {
         'Eth-Hd-Keyring: Secret recovery phrase already provided',
       );
     }
-
-    this.opts = opts || {};
+    this.opts = opts;
     this.wallets = [];
     this.mnemonic = null;
     this.root = null;
@@ -116,7 +115,7 @@ class HdKeyring extends SimpleKeyring {
     }
 
     // eslint-disable-next-line node/no-sync
-    const seed = bip39.mnemonicToSeedSync(mnemonic);
+    const seed = bip39.mnemonicToSeedSync(this.mnemonic);
     this.hdWallet = hdkey.fromMasterSeed(seed);
     this.root = this.hdWallet.derivePath(this.hdPath);
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/eth-hd-keyring",
-  "version": "4.0.0",
+  "version": "4.0.1",
   "description": "A simple standard interface for a seed phrase generated set of Ethereum accounts.",
   "keywords": [
     "ethereum",

package/test/index.js

@@ -25,7 +25,7 @@ describe('hd-keyring', () => {
   });
 
   describe('constructor', () => {
-    it('constructs', async () => {
+    it('constructs with a typeof string mnemonic', async () => {
       keyring = new HdKeyring({
         mnemonic: sampleMnemonic,
         numberOfAccounts: 2,
@@ -36,6 +36,28 @@ describe('hd-keyring', () => {
       expect(accounts[1]).toStrictEqual(secondAcct);
     });
 
+    it('constructs with a typeof array mnemonic', async () => {
+      keyring = new HdKeyring({
+        mnemonic: Array.from(Buffer.from(sampleMnemonic, 'utf8').values()),
+        numberOfAccounts: 2,
+      });
+
+      const accounts = await keyring.getAccounts();
+      expect(accounts[0]).toStrictEqual(firstAcct);
+      expect(accounts[1]).toStrictEqual(secondAcct);
+    });
+
+    it('constructs with a typeof buffer mnemonic', async () => {
+      keyring = new HdKeyring({
+        mnemonic: Buffer.from(sampleMnemonic, 'utf8'),
+        numberOfAccounts: 2,
+      });
+
+      const accounts = await keyring.getAccounts();
+      expect(accounts[0]).toStrictEqual(firstAcct);
+      expect(accounts[1]).toStrictEqual(secondAcct);
+    });
+
     it('throws on invalid mnemonic', () => {
       expect(
         () =>
@@ -99,12 +121,19 @@ describe('hd-keyring', () => {
   });
 
   describe('#serialize mnemonic.', () => {
-    it('serializes mnemonic class variable into a buffer array and does not add accounts', async () => {
+    it('serializes mnemonic stored as a buffer in a class variable into a buffer array and does not add accounts', async () => {
       keyring.generateRandomMnemonic();
       const output = await keyring.serialize();
       expect(output.numberOfAccounts).toBe(0);
       expect(Array.isArray(output.mnemonic)).toBe(true);
     });
+
+    it('serializes mnemonic stored as a string in a class variable into a buffer array and does not add accounts', async () => {
+      keyring.mnemonic = sampleMnemonic;
+      const output = await keyring.serialize();
+      expect(output.numberOfAccounts).toBe(0);
+      expect(Array.isArray(output.mnemonic)).toBe(true);
+    });
   });
 
   describe('#deserialize a private key', () => {
@@ -133,6 +162,12 @@ describe('hd-keyring', () => {
         await keyring.addAccounts();
         expect(keyring.wallets).toHaveLength(1);
       });
+
+      it('throws an error when no SRP has been generated yet', async () => {
+        expect(() => keyring.addAccounts()).toThrow(
+          'Eth-Hd-Keyring: No secret recovery phrase provided',
+        );
+      });
     });
 
     describe('with a numeric argument', () => {