deps: upgrade from ethereumjs-util to @ethereumjs/util

.storybook/main.js

@@ -59,6 +59,9 @@ module.exports = {
     config.resolve.alias['@ethereumjs/util'] = require.resolve(
       '../ui/__mocks__/ethereumjs-util.js',
     );
+    config.resolve.alias['ethereumjs-util'] = require.resolve(
+      '../ui/__mocks__/ethereumjs-util.js',
+    );
     config.resolve.alias['./useNftCollectionsMetadata'] = require.resolve(
       '../ui/__mocks__/useNftCollectionsMetadata.js',
     );

app/scripts/controllers/bridge/constants.ts

@@ -1,4 +1,4 @@
-import { zeroAddress } from 'ethereumjs-util';
+import { zeroAddress } from '@ethereumjs/util';
 import { Hex } from '@metamask/utils';
 import {
   BRIDGE_DEFAULT_SLIPPAGE,

app/scripts/lib/createRPCMethodTrackingMiddleware.js

@@ -1,6 +1,6 @@
 import { ApprovalType, detectSIWE } from '@metamask/controller-utils';
 import { errorCodes } from '@metamask/rpc-errors';
-import { isValidAddress } from 'ethereumjs-util';
+import { isValidAddress } from '@ethereumjs/util';
 import { MESSAGE_TYPE, ORIGIN_METAMASK } from '../../../shared/constants/app';
 import {
   MetaMetricsEventCategory,

app/scripts/lib/transaction/decode/four-byte.ts

@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 
-import { addHexPrefix } from 'ethereumjs-util';
+import { addHexPrefix } from '@ethereumjs/util';
 import { Interface, ParamType } from '@ethersproject/abi';
 import { Hex, createProjectLogger } from '@metamask/utils';
 import {

app/scripts/lib/transaction/decode/proxy.ts

@@ -1,7 +1,7 @@
 import { query } from '@metamask/controller-utils';
 import EthQuery from '@metamask/eth-query';
 import { Hex } from '@metamask/utils';
-import { addHexPrefix, stripHexPrefix } from 'ethereumjs-util';
+import { addHexPrefix, stripHexPrefix } from '@ethereumjs/util';
 
 const IMPLEMENTATION_STORAGE_SLOTS = [
   // org.zeppelinos.proxy.implementation

app/scripts/lib/transaction/decode/uniswap.ts

@@ -1,6 +1,6 @@
 import { Interface, TransactionDescription } from '@ethersproject/abi';
 import { Hex } from '@metamask/utils';
-import { addHexPrefix, stripHexPrefix } from 'ethereumjs-util';
+import { addHexPrefix, stripHexPrefix } from '@ethereumjs/util';
 import { CHAIN_IDS } from '../../../../../shared/constants/network';
 import { UNISWAP_ROUTER_COMMANDS } from './uniswap-commands';
 

app/scripts/lib/transaction/metrics.ts

@@ -1,7 +1,7 @@
 import EthQuery, { Provider } from '@metamask/eth-query';
 import { FetchGasFeeEstimateOptions } from '@metamask/gas-fee-controller';
 import { BigNumber } from 'bignumber.js';
-import { isHexString } from 'ethereumjs-util';
+import { isHexString } from '@ethereumjs/util';
 
 import { SmartTransaction } from '@metamask/smart-transactions-controller/dist/types';
 import {

app/scripts/lib/transaction/util.ts

@@ -11,7 +11,7 @@ import {
   UserOperationController,
 } from '@metamask/user-operation-controller';
 import type { Hex } from '@metamask/utils';
-import { addHexPrefix } from 'ethereumjs-util';
+import { addHexPrefix } from '@ethereumjs/util';
 import { PPOMController } from '@metamask/ppom-validator';
 
 import {

app/scripts/migrations/105.test.ts

@@ -1,7 +1,7 @@
 import { v4 as uuid } from 'uuid';
 import { sha256 } from '@noble/hashes/sha256';
 import { InternalAccount } from '@metamask/keyring-internal-api';
-import { toBuffer } from 'ethereumjs-util';
+import { hexToBytes } from '@noble/hashes/utils';
 import { ETH_EOA_METHODS } from '../../../shared/constants/eth-methods';
 import { migrate } from './105';
 
@@ -19,7 +19,7 @@ global.sentry = {
 
 function addressToUUID(address: string): string {
   return uuid({
-    random: sha256(toBuffer(address)).slice(0, 16),
+    random: sha256(hexToBytes(address)).slice(0, 16),
   });
 }
 

app/scripts/migrations/105.ts

@@ -1,7 +1,7 @@
 import { EthAccountType } from '@metamask/keyring-api';
 import { InternalAccount } from '@metamask/keyring-internal-api';
 import { sha256 } from '@noble/hashes/sha256';
-import { toBuffer } from 'ethereumjs-util';
+import { hexToBytes } from '@noble/hashes/utils';
 import { v4 as uuid } from 'uuid';
 import { cloneDeep } from 'lodash';
 import { ETH_EOA_METHODS } from '../../../shared/constants/eth-methods';
@@ -89,7 +89,7 @@ function createInternalAccountsForAccountsController(
 
   Object.values(identities).forEach((identity) => {
     const expectedId = uuid({
-      random: sha256(toBuffer(identity.address)).slice(0, 16),
+      random: sha256(hexToBytes(identity.address)).slice(0, 16),
     });
 
     accounts[expectedId] = {

package.json

@@ -175,14 +175,7 @@
     "eslint@npm:^8.7.0": "patch:eslint@npm%3A8.57.0#~/.yarn/patches/eslint-npm-8.57.0-4286e12a3a.patch",
     "eth-query@^2.1.2": "patch:eth-query@npm%3A2.1.2#./.yarn/patches/eth-query-npm-2.1.2-7c6adc825f.patch",
     "eth-query@^2.1.0": "patch:eth-query@npm%3A2.1.2#./.yarn/patches/eth-query-npm-2.1.2-7c6adc825f.patch",
-    "ethereumjs-util@^7.0.10": "patch:ethereumjs-util@npm%3A7.1.5#./.yarn/patches/ethereumjs-util-npm-7.1.5-5bb4d00000.patch",
-    "ethereumjs-util@^7.1.5": "patch:ethereumjs-util@npm%3A7.1.5#./.yarn/patches/ethereumjs-util-npm-7.1.5-5bb4d00000.patch",
-    "ethereumjs-util@^7.1.4": "patch:ethereumjs-util@npm%3A7.1.5#./.yarn/patches/ethereumjs-util-npm-7.1.5-5bb4d00000.patch",
-    "ethereumjs-util@^7.0.9": "patch:ethereumjs-util@npm%3A7.1.5#./.yarn/patches/ethereumjs-util-npm-7.1.5-5bb4d00000.patch",
-    "ethereumjs-util@^7.1.0": "patch:ethereumjs-util@npm%3A7.1.5#./.yarn/patches/ethereumjs-util-npm-7.1.5-5bb4d00000.patch",
-    "ethereumjs-util@^7.0.2": "patch:ethereumjs-util@npm%3A7.1.5#./.yarn/patches/ethereumjs-util-npm-7.1.5-5bb4d00000.patch",
-    "ethereumjs-util@^7.0.8": "patch:ethereumjs-util@npm%3A7.1.5#./.yarn/patches/ethereumjs-util-npm-7.1.5-5bb4d00000.patch",
-    "ethereumjs-util@^7.0.7": "patch:ethereumjs-util@npm%3A7.1.5#./.yarn/patches/ethereumjs-util-npm-7.1.5-5bb4d00000.patch",
+    "ethereumjs-util@^7.1.2": "patch:ethereumjs-util@npm%3A7.1.5#./.yarn/patches/ethereumjs-util-npm-7.1.5-5bb4d00000.patch",
     "fast-json-patch@^2.2.1": "patch:fast-json-patch@npm%3A2.2.1#./.yarn/patches/fast-json-patch-npm-2.2.1-63b021bb37.patch",
     "fast-json-patch@^2.0.6": "patch:fast-json-patch@npm%3A2.2.1#./.yarn/patches/fast-json-patch-npm-2.2.1-63b021bb37.patch",
     "gulp-sourcemaps@^3.0.0": "patch:gulp-sourcemaps@npm%3A3.0.0#./.yarn/patches/gulp-sourcemaps-npm-3.0.0-1ae0fbef6d.patch",
@@ -256,6 +249,7 @@
     "@blockaid/ppom_release": "^1.5.3",
     "@ensdomains/content-hash": "^2.5.7",
     "@ethereumjs/tx": "^4.1.1",
+    "@ethereumjs/util": "^8.1.0",
     "@ethersproject/abi": "^5.6.4",
     "@ethersproject/bignumber": "^5.7.0",
     "@ethersproject/bytes": "^5.7.0",
@@ -384,7 +378,6 @@
     "eth-lattice-keyring": "^0.12.4",
     "eth-method-registry": "^4.0.0",
     "ethereum-cryptography": "^2.2.1",
-    "ethereumjs-util": "^7.0.10",
     "extension-port-stream": "^3.0.0",
     "fast-json-patch": "^3.1.1",
     "fuse.js": "^3.2.0",
@@ -704,7 +697,7 @@
       "eth-json-rpc-filters>eth-json-rpc-middleware>ethereumjs-util>keccak": false,
       "eth-json-rpc-filters>eth-json-rpc-middleware>ethereumjs-util>secp256k1": false,
       "eth-lattice-keyring>gridplus-sdk": false,
-      "ethereumjs-util>ethereum-cryptography>keccak": false,
+      "@ethereumjs/util>ethereum-cryptography>keccak": false,
       "ganache>@trufflesuite/bigint-buffer": false,
       "ganache>@trufflesuite/uws-js-unofficial>bufferutil": false,
       "ganache>@trufflesuite/uws-js-unofficial>utf-8-validate": false,
@@ -713,7 +706,6 @@
       "ganache>leveldown": false,
       "ganache>secp256k1": false,
       "ganache>utf-8-validate": false,
-      "ethereumjs-util>ethereum-cryptography>secp256k1": false,
       "gulp-watch>chokidar>fsevents": false,
       "gulp>glob-watcher>chokidar>fsevents": false,
       "webpack>watchpack>watchpack-chokidar2>chokidar>fsevents": false,
@@ -760,6 +752,7 @@
       "core-js-pure": true,
       "resolve-url-loader>es6-iterator>d>es5-ext": false,
       "resolve-url-loader>es6-iterator>d>es5-ext>esniff>es5-ext": false,
+      "@metamask/keyring-controller>ethereumjs-wallet>ethereum-cryptography>keccak": false,
       "level>classic-level": false,
       "jest-preview": false,
       "@metamask/solana-wallet-snap>@solana/web3.js>bigint-buffer": false,

shared/constants/gas.ts

@@ -1,4 +1,4 @@
-import { addHexPrefix } from 'ethereumjs-util';
+import { addHexPrefix } from '@ethereumjs/util';
 
 const ONE_HUNDRED_THOUSAND = 100000;
 const MIN_GAS_LIMIT_DEC = '21000';

shared/modules/Numeric.ts

@@ -1,7 +1,7 @@
 import { BigNumber } from 'bignumber.js';
 import BN from 'bn.js';
 import { isHexString, isNullOrUndefined } from '@metamask/utils';
-import { addHexPrefix } from 'ethereumjs-util';
+import { addHexPrefix } from '@ethereumjs/util';
 import { EtherDenomination } from '../constants/common';
 import { stripHexPrefix } from './hexstring-utils';
 
@@ -11,7 +11,7 @@ export type NumericValue = string | number | BN | BigNumber;
 export type NumericBase = 10 | 16;
 
 /**
- * All variations of isHexString from our own utilities and ethereumjs-utils
+ * All variations of isHexString from our own utilities and @ethereumjs/utils
  * return false for a '-' prefixed hex string. This utility method strips the
  * possible '-' from the string before testing its validity so that negative
  * hex values can be properly handled.

shared/modules/bridge-utils/balance.test.ts

@@ -1,5 +1,5 @@
 import { BigNumber } from 'ethers';
-import { zeroAddress } from 'ethereumjs-util';
+import { zeroAddress } from '@ethereumjs/util';
 import { createTestProviderTools } from '../../../test/stub/provider';
 import { CHAIN_IDS } from '../../constants/network';
 import { Numeric } from '../Numeric';

shared/modules/bridge-utils/balance.ts

@@ -1,6 +1,6 @@
 import { Web3Provider } from '@ethersproject/providers';
 import { Hex } from '@metamask/utils';
-import { zeroAddress } from 'ethereumjs-util';
+import { zeroAddress } from '@ethereumjs/util';
 import { getAddress } from 'ethers/lib/utils';
 import { HttpProvider } from '../../../types/global';
 import { fetchTokenBalance } from '../../lib/token-util';

shared/modules/bridge-utils/bridge.util.test.ts

@@ -1,4 +1,4 @@
-import { zeroAddress } from 'ethereumjs-util';
+import { zeroAddress } from '@ethereumjs/util';
 import fetchWithCache from '../../lib/fetch-with-cache';
 import { CHAIN_IDS } from '../../constants/network';
 import mockBridgeQuotesErc20Erc20 from '../../../test/data/bridge/mock-quotes-erc20-erc20.json';

shared/modules/buffer-utils.js

@@ -1,12 +1,12 @@
-import { toBuffer as ethUtilToBuffer, isHexString } from 'ethereumjs-util';
+import { toBuffer as ethUtilToBuffer, isHexString } from '@ethereumjs/util';
 
 /**
- * Returns a buffer from the provided input, via ethereumjs-util.toBuffer but
+ * Returns a buffer from the provided input, via @ethereumjs/util.toBuffer but
  * additionally handling non hex strings. This is a failsafe as in most cases
  * we should be primarily dealing with hex prefixed strings with this utility
  * but we do not want to break the extension for users.
  *
- * @param {import('ethereumjs-util').ToBufferInputTypes | string} input
+ * @param {import('@ethereumjs/util').ToBufferInputTypes | string} input
  * @returns {Buffer}
  */
 export function toBuffer(input) {

shared/modules/conversion.utils.ts

@@ -1,7 +1,7 @@
 import { Hex } from '@metamask/utils';
 import { BigNumber } from 'bignumber.js';
 import BN from 'bn.js';
-import { addHexPrefix } from 'ethereumjs-util';
+import { addHexPrefix } from '@ethereumjs/util';
 import { EtherDenomination } from '../constants/common';
 import { Numeric, NumericValue } from './Numeric';
 

shared/modules/gas.utils.test.js

@@ -1,4 +1,4 @@
-const { addHexPrefix } = require('ethereumjs-util');
+const { addHexPrefix } = require('@ethereumjs/util');
 const {
   getMaximumGasTotalInHexWei,
   getMinimumGasTotalInHexWei,

shared/modules/hexstring-utils.test.js

@@ -1,4 +1,4 @@
-import { toChecksumAddress } from 'ethereumjs-util';
+import { toChecksumAddress } from '@ethereumjs/util';
 import { isPossibleAddress, isValidHexAddress } from './hexstring-utils';
 
 describe('hexstring utils', function () {

shared/modules/hexstring-utils.ts

@@ -6,7 +6,7 @@ import {
   toChecksumAddress,
   zeroAddress,
   isHexPrefixed,
-} from 'ethereumjs-util';
+} from '@ethereumjs/util';
 
 export const BURN_ADDRESS = zeroAddress();
 
@@ -26,7 +26,7 @@ export function isEmptyHexString(value: string): boolean {
 
 /**
  * Validates that the input is a hex address. This utility method is a thin
- * wrapper around ethereumjs-util.isValidAddress, with the exception that it
+ * wrapper around @ethereumjs/util.isValidAddress, with the exception that it
  * does not throw an error when provided values that are not hex strings. In
  * addition, and by default, this method will return true for hex strings that
  * meet the length requirement of a hex address, but are not prefixed with `0x`
@@ -80,13 +80,13 @@ export function toChecksumHexAddress(address: string) {
   if (!address) {
     // our internal checksumAddress function that this method replaces would
     // return an empty string for nullish input. If any direct usages of
-    // ethereumjs-util.toChecksumAddress were called with nullish input it
+    // @ethereumjs/util.toChecksumAddress were called with nullish input it
     // would have resulted in an error on version 5.1.
     return '';
   }
   const hexPrefixed = addHexPrefix(address);
   if (!isHexString(hexPrefixed)) {
-    // Version 5.1 of ethereumjs-utils would have returned '0xY' for input 'y'
+    // Version 5.1 of @ethereumjs/utils would have returned '0xY' for input 'y'
     // but we shouldn't waste effort trying to change case on a clearly invalid
     // string. Instead just return the hex prefixed original string which most
     // closely mimics the original behavior.

shared/modules/transaction.utils.ts

@@ -1,4 +1,4 @@
-import { isHexString } from 'ethereumjs-util';
+import { isHexString } from '@ethereumjs/util';
 import { Interface } from '@ethersproject/abi';
 import {
   abiERC721,

test/e2e/tests/tokens/token-list.spec.ts

@@ -1,7 +1,7 @@
 import { strict as assert } from 'assert';
 import { Mockttp } from 'mockttp';
 import { Context } from 'mocha';
-import { zeroAddress } from 'ethereumjs-util';
+import { zeroAddress } from '@ethereumjs/util';
 import { CHAIN_IDS } from '../../../../shared/constants/network';
 import { toChecksumHexAddress } from '../../../../shared/modules/hexstring-utils';
 import FixtureBuilder from '../../fixture-builder';

test/stub/keyring-bridge.js

@@ -1,6 +1,6 @@
 import { Transaction } from '@ethereumjs/tx';
 import { signTypedData, SignTypedDataVersion } from '@metamask/eth-sig-util';
-import { bufferToHex } from 'ethereumjs-util';
+import { bufferToHex } from '@ethereumjs/util';
 import { addHexPrefix, Common } from './keyring-utils';
 
 // BIP32 Public Key: xpub6ELgkkwgfoky9h9fFu4Auvx6oHvJ6XfwiS1NE616fe9Uf4H3JHtLGjCePVkb6RFcyDCqVvjXhNXbDNDqs6Kjoxw7pTAeP1GSEiLHmA5wYa9

ui/__mocks__/ethereumjs-util.js

@@ -1,6 +1,33 @@
-// eslint-disable-next-line import/no-extraneous-dependencies, node/no-extraneous-require
-const util = require('ethereumjs-util');
+// Vendored from @ethereumjs/[email protected] / [email protected]
+
+/**
+ * Converts a `Buffer` into a `0x`-prefixed hex `String`.
+ *
+ * @param buf - `Buffer` object to convert
+ */
+const bufferToHex = function (buf) {
+  // buf = toBuffer(buf);
+  return `0x${buf.toString('hex')}`;
+};
+
+/**
+ * Returns a buffer filled with 0s.
+ *
+ * @param bytes - the number of bytes the buffer should be
+ */
+const zeros = function (bytes) {
+  return Buffer.allocUnsafe(bytes).fill(0);
+};
+
+/**
+ * Returns the zero address.
+ */
+const zeroAddress = function () {
+  const addressLength = 20;
+  const addr = zeros(addressLength);
+  return bufferToHex(addr);
+};
 
 module.exports = {
-  ...util,
+  zeroAddress,
 };

ui/components/app/currency-input/hooks/useTokenExchangeRate.tsx

@@ -1,5 +1,5 @@
 import { useMemo, useState } from 'react';
-import { toChecksumAddress } from 'ethereumjs-util';
+import { toChecksumAddress } from '@ethereumjs/util';
 import { shallowEqual, useSelector } from 'react-redux';
 import { getCurrentChainId } from '../../../../../shared/modules/selectors/networks';
 import { getTokenExchangeRates } from '../../../../selectors';

ui/components/app/name/name-details/name-details.tsx

@@ -15,7 +15,7 @@ import {
 } from '@metamask/name-controller';
 import { useDispatch, useSelector } from 'react-redux';
 import { isEqual } from 'lodash';
-import { toChecksumAddress } from 'ethereumjs-util';
+import { toChecksumAddress } from '@ethereumjs/util';
 import {
   Box,
   Button,

ui/components/app/name/name.tsx

@@ -7,7 +7,7 @@ import React, {
 } from 'react';
 import { NameType } from '@metamask/name-controller';
 import classnames from 'classnames';
-import { toChecksumAddress } from 'ethereumjs-util';
+import { toChecksumAddress } from '@ethereumjs/util';
 import { Box, Icon, IconName, IconSize, Text } from '../../component-library';
 import { shortenAddress, shortenString } from '../../../helpers/utils/util';
 import { MetaMetricsContext } from '../../../contexts/metametrics';

ui/components/app/wallet-overview/aggregated-percentage-overview-cross-chains.tsx

@@ -1,7 +1,7 @@
 import React, { useMemo } from 'react';
 import { useSelector } from 'react-redux';
 
-import { toChecksumAddress } from 'ethereumjs-util';
+import { toChecksumAddress } from '@ethereumjs/util';
 import { getNativeTokenAddress } from '@metamask/assets-controllers';
 import { Hex } from '@metamask/utils';
 import {

ui/components/app/wallet-overview/aggregated-percentage-overview.tsx

@@ -1,7 +1,7 @@
 import React, { useMemo } from 'react';
 import { useSelector } from 'react-redux';
 
-import { toChecksumAddress } from 'ethereumjs-util';
+import { toChecksumAddress } from '@ethereumjs/util';
 import { getNativeTokenAddress } from '@metamask/assets-controllers';
 import { getCurrentCurrency } from '../../../ducks/metamask/metamask';
 import {

ui/components/multichain/asset-picker-amount/asset-picker-modal/asset-picker-modal.tsx

@@ -2,13 +2,13 @@ import React, { useState, useCallback, useMemo } from 'react';
 
 import { useSelector } from 'react-redux';
 import { isEqual, uniqBy } from 'lodash';
+import { zeroAddress } from '@ethereumjs/util';
 import {
   Token,
   TokenListMap,
   TokenListToken,
 } from '@metamask/assets-controllers';
 import { Hex } from '@metamask/utils';
-import { zeroAddress } from 'ethereumjs-util';
 import {
   Modal,
   ModalContent,