chore(keyring-controller): replace ethereumjs-util with @ethereumjs/util and @metamask/utils

- test(keyring-controller): Update expected error message when importing invalid key

Author: legobeat

packages/keyring-controller/package.json

@@ -31,6 +31,7 @@
     "test:watch": "jest --watch"
   },
   "dependencies": {
+    "@ethereumjs/util": "^8.1.0",
     "@keystonehq/metamask-airgapped-keyring": "^0.13.1",
     "@metamask/base-controller": "^4.1.1",
     "@metamask/browser-passworder": "^4.3.0",
@@ -41,7 +42,6 @@
     "@metamask/message-manager": "^7.3.8",
     "@metamask/utils": "^8.3.0",
     "async-mutex": "^0.2.6",
-    "ethereumjs-util": "^7.0.10",
     "ethereumjs-wallet": "^1.0.1",
     "immer": "^9.0.6"
   },
@@ -71,9 +71,6 @@
     "registry": "https://registry.npmjs.org/"
   },
   "lavamoat": {
-    "allowScripts": {
-      "ethereumjs-util>ethereum-cryptography>keccak": false,
-      "ethereumjs-util>ethereum-cryptography>secp256k1": false
-    }
+    "allowScripts": {}
   }
 }

packages/keyring-controller/src/KeyringController.test.ts

@@ -15,12 +15,12 @@ import type { EthKeyring } from '@metamask/keyring-api';
 import { wordlist } from '@metamask/scure-bip39/dist/wordlists/english';
 import type { KeyringClass } from '@metamask/utils';
 import {
+  bytesToHex,
   isValidHexAddress,
   type Hex,
   type Keyring,
   type Json,
 } from '@metamask/utils';
-import { bufferToHex } from 'ethereumjs-util';
 import * as sinon from 'sinon';
 import * as uuid from 'uuid';
 
@@ -985,9 +985,7 @@ describe('KeyringController', () => {
                 AccountImportStrategy.privateKey,
                 ['123'],
               ),
-            ).rejects.toThrow(
-              'Expected private key to be an Uint8Array with length 32',
-            );
+            ).rejects.toThrow('Cannot import invalid private key.');
 
             await expect(
               controller.importAccountWithStrategy(
@@ -1273,7 +1271,7 @@ describe('KeyringController', () => {
     describe('when the keyring for the given address supports signPersonalMessage', () => {
       it('should sign personal message', async () => {
         await withController(async ({ controller, initialState }) => {
-          const data = bufferToHex(Buffer.from('Hello from test', 'utf8'));
+          const data = bytesToHex(Buffer.from('Hello from test', 'utf8'));
           const account = initialState.keyrings[0].accounts[0];
           const signature = await controller.signPersonalMessage({
             data,
@@ -2344,7 +2342,7 @@ describe('KeyringController', () => {
           ),
         );
 
-        const data = bufferToHex(
+        const data = bytesToHex(
           Buffer.from('Example `personal_sign` message', 'utf8'),
         );
         const qrKeyring = signProcessKeyringController.state.keyrings.find(

packages/keyring-controller/src/KeyringController.ts

@@ -1,4 +1,5 @@
 import type { TxData, TypedTransaction } from '@ethereumjs/tx';
+import { isValidPrivate, toBuffer, getBinarySize } from '@ethereumjs/util';
 import type {
   MetaMaskKeyring as QRKeyring,
   IKeyringState as IQRKeyringState,
@@ -27,22 +28,16 @@ import type {
   KeyringClass,
 } from '@metamask/utils';
 import {
+  add0x,
   assertIsStrictHexString,
+  bytesToHex,
   hasProperty,
   isObject,
   isValidHexAddress,
   isValidJson,
   remove0x,
 } from '@metamask/utils';
 import { Mutex } from 'async-mutex';
-import {
-  addHexPrefix,
-  bufferToHex,
-  isValidPrivate,
-  toBuffer,
-  stripHexPrefix,
-  getBinarySize,
-} from 'ethereumjs-util';
 import Wallet, { thirdparty as importers } from 'ethereumjs-wallet';
 import type { Patch } from 'immer';
 
@@ -1059,7 +1054,7 @@ export class KeyringController extends BaseController<
         if (!importedKey) {
           throw new Error('Cannot import an empty key.');
         }
-        const prefixed = addHexPrefix(importedKey);
+        const prefixed = add0x(importedKey);
 
         let bufferedPrivateKey;
         try {
@@ -1076,7 +1071,7 @@ export class KeyringController extends BaseController<
           throw new Error('Cannot import invalid private key.');
         }
 
-        privateKey = stripHexPrefix(prefixed);
+        privateKey = remove0x(prefixed);
         break;
       case 'json':
         let wallet;
@@ -1086,7 +1081,7 @@ export class KeyringController extends BaseController<
         } catch (e) {
           wallet = wallet || (await Wallet.fromV3(input, password, true));
         }
-        privateKey = bufferToHex(wallet.getPrivateKey());
+        privateKey = bytesToHex(wallet.getPrivateKey());
         break;
       default:
         throw new Error(`Unexpected import strategy: '${strategy}'`);

yarn.lock

@@ -2236,6 +2236,7 @@ __metadata:
   dependencies:
     "@ethereumjs/common": ^3.2.0
     "@ethereumjs/tx": ^4.2.0
+    "@ethereumjs/util": ^8.1.0
     "@keystonehq/bc-ur-registry-eth": ^0.9.0
     "@keystonehq/metamask-airgapped-keyring": ^0.13.1
     "@lavamoat/allow-scripts": ^2.3.1
@@ -2252,7 +2253,6 @@ __metadata:
     "@types/jest": ^27.4.1
     async-mutex: ^0.2.6
     deepmerge: ^4.2.2
-    ethereumjs-util: ^7.0.10
     ethereumjs-wallet: ^1.0.1
     immer: ^9.0.6
     jest: ^27.5.1