@metamask/keyring-controller - npm Package Compare versions

Comparing version 2.0.0 to 3.0.0

CHANGELOG.md

@@ -9,2 +9,8 @@ # Changelog
 
+## [3.0.0]
+### Changed
+- **BREAKING:**: Bump eth-keyring-controller version to @metamask/eth-keyring-controller v10 ([#1072](https://github.com/MetaMask/core.git/pull/1072))
+  - `exportSeedPhrase` now returns a `Uint8Array` typed SRP (can be converted to a string using [this approach](https://github.com/MetaMask/eth-hd-keyring/blob/53b0570559595ba5b3fd8c80e900d847cd6dee3d/index.js#L40)).  It was previously a Buffer.
+  - The HD keyring included with the keyring controller has been updated from v4 to v6. See [the `eth-hd-keyring` changelog entries for v5 and v6](https://github.com/MetaMask/eth-hd-keyring/blob/main/CHANGELOG.md#600) for further details on breaking changes.
+
 ## [2.0.0]
@@ -30,5 +36,6 @@ ### Changed
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/keyring-controller@2.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/keyring-controller@3.0.0...HEAD
+[3.0.0]: https://github.com/MetaMask/core/compare/@metamask/keyring-controller@2.0.0...@metamask/keyring-controller@3.0.0
 [2.0.0]: https://github.com/MetaMask/core/compare/@metamask/keyring-controller@1.0.1...@metamask/keyring-controller@2.0.0
 [1.0.1]: https://github.com/MetaMask/core/compare/@metamask/keyring-controller@1.0.0...@metamask/keyring-controller@1.0.1
 [1.0.0]: https://github.com/MetaMask/core/releases/tag/@metamask/keyring-controller@1.0.0

dist/KeyringController.d.ts

@@ -58,3 +58,3 @@ import { MetaMaskKeyring as QRKeyring, IKeyringState as IQRKeyringState } from '@keystonehq/metamask-airgapped-keyring';
     encryptor?: any;
-    keyringTypes?: any[];
+    keyringBuilders?: any[];
 }
@@ -61,0 +61,0 @@ /**

dist/KeyringController.js

@@ -45,5 +45,2 @@ "use strict";
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 var _KeyringController_keyring;
@@ -55,3 +52,3 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const ethereumjs_wallet_1 = __importStar(require("ethereumjs-wallet"));
-const eth_keyring_controller_1 = __importDefault(require("eth-keyring-controller"));
+const eth_keyring_controller_1 = require("@metamask/eth-keyring-controller");
 const async_mutex_1 = require("async-mutex");
@@ -118,3 +115,3 @@ const base_controller_1 = require("@metamask/base-controller");
         _KeyringController_keyring.set(this, void 0);
-        __classPrivateFieldSet(this, _KeyringController_keyring, new eth_keyring_controller_1.default(Object.assign({ initState: state }, config)), "f");
+        __classPrivateFieldSet(this, _KeyringController_keyring, new eth_keyring_controller_1.KeyringController(Object.assign({ initState: state }, config)), "f");
         this.defaultState = Object.assign(Object.assign({}, __classPrivateFieldGet(this, _KeyringController_keyring, "f").store.getState()), { keyrings: [] });
@@ -351,2 +348,5 @@ this.removeIdentity = removeIdentity;
     signMessage(messageParams) {
+        if (!messageParams.data) {
+            throw new Error("Can't sign an empty message");
+        }
         return __classPrivateFieldGet(this, _KeyringController_keyring, "f").signMessage(messageParams);
@@ -493,8 +493,9 @@ }
             }
-            const TestKeyringClass = __classPrivateFieldGet(this, _KeyringController_keyring, "f").getKeyringClassForType(KeyringTypes.hd);
-            const testKeyring = new TestKeyringClass({
+            const hdKeyringBuilder = __classPrivateFieldGet(this, _KeyringController_keyring, "f").getKeyringBuilderForType(KeyringTypes.hd);
+            const hdKeyring = hdKeyringBuilder();
+            hdKeyring.deserialize({
                 mnemonic: seedWords,
                 numberOfAccounts: accounts.length,
             });
-            const testAccounts = yield testKeyring.getAccounts();
+            const testAccounts = yield hdKeyring.getAccounts();
             /* istanbul ignore if */
@@ -501,0 +502,0 @@ if (testAccounts.length !== accounts.length) {

package.json

 {
   "name": "@metamask/keyring-controller",
-  "version": "2.0.0",
+  "version": "3.0.0",
   "description": "Stores identities seen in the wallet and manages interactions such as signing",
@@ -35,2 +35,3 @@ "keywords": [
     "@metamask/controller-utils": "^2.0.0",
+    "@metamask/eth-keyring-controller": "^10.0.0",
     "@metamask/eth-sig-util": "^5.0.2",
@@ -40,3 +41,2 @@ "@metamask/message-manager": "^1.0.2",
     "async-mutex": "^0.2.6",
-    "eth-keyring-controller": "^7.0.2",
     "ethereumjs-util": "^7.0.10",
@@ -43,0 +43,0 @@ "ethereumjs-wallet": "^1.0.1"

No alert changes

Improved metrics

Total package byte prevSize

86017

increased by1.34%

Lines of code

994

increased by0.1%

Dependency changes

• + Added@metamask/eth-keyring-controller@^10.0.0

• + Added@chainsafe/as-sha256@0.3.1(transitive)

• + Added@chainsafe/persistent-merkle-tree@0.4.2(transitive)

• + Added@chainsafe/ssz@0.9.4(transitive)

• + Added@ethereumjs/common@3.2.0(transitive)

• + Added@ethereumjs/tx@4.2.0(transitive)

• + Added@ethereumjs/util@8.0.5(transitive)

• + Added@metamask/abi-utils@1.2.0(transitive)

• + Added@metamask/browser-passworder@4.3.0(transitive)

• + Added@metamask/eth-hd-keyring@6.0.2(transitive)

• + Added@metamask/eth-keyring-controller@10.0.1(transitive)

• + Added@metamask/eth-sig-util@5.0.26.0.2(transitive)

• + Added@metamask/eth-simple-keyring@5.1.1(transitive)

• + Added@metamask/scure-bip39@2.1.1(transitive)

• + Added@metamask/superstruct@3.1.0(transitive)

• + Added@metamask/utils@3.6.05.0.28.5.0(transitive)

• + Added@noble/hashes@1.2.01.3.31.7.1(transitive)

• + Added@noble/secp256k1@1.7.1(transitive)

• + Added@scure/bip32@1.1.5(transitive)

• + Added@scure/bip39@1.1.1(transitive)

• + Added@types/debug@4.1.12(transitive)

• + Added@types/ms@2.1.0(transitive)

• + Added@types/node@22.13.5(transitive)

• + Addedcase@1.6.3(transitive)

• + Addeddebug@4.4.0(transitive)

• + Addedethereum-cryptography@1.2.0(transitive)

• + Addedms@2.1.3(transitive)

• + Addedpony-cause@2.1.11(transitive)

• + Addedsemver@7.7.1(transitive)

• + Addedsuperstruct@1.0.4(transitive)

• + Addedundici-types@6.20.0(transitive)

• + Addeduuid@9.0.1(transitive)

• - Removedeth-keyring-controller@^7.0.2

• - Removed@metamask/bip39@4.0.0(transitive)

• - Removed@metamask/eth-hd-keyring@4.0.2(transitive)

• - Removed@metamask/eth-sig-util@4.0.1(transitive)

• - Removed@types/node@11.11.6(transitive)

• - Removedbrowser-passworder@2.0.3(transitive)

• - Removedbrowserify-unibabel@3.0.0(transitive)

• - Removedeth-keyring-controller@7.0.2(transitive)

• - Removedeth-simple-keyring@4.2.0(transitive)

• - Removedevents@1.1.1(transitive)