chore: remove `@metamask/ethjs` package #29620

cryptodev-2s · 2025-01-09T21:38:26Z

Description

This PR introduces the following changes:
• Removes the @metamask/ethjs package.
• Replaces the global variable global.eth with the existing global.ethereumProvider (an instance of StreamProvider from web3-stream-provider package).
• Updates all instances of getCode to use a manual sendAsync call for the eth_getCode method, as StreamProvider does not include getCode, unlike ethjs.
• Substitutes the use of ethjs contracts with Contract instances from the @ethersproject/contracts library.
• Removal of @metamask/ethjs-contract and @metamask/ethjs-query packages.

The purpose of this PR is to simplify and break down the process of replacing web3-stream-provider (issue), which uses the legacy sendAsync method and is not EIP-1193 compliant, with StreamProvider from @metamask/providers, which fully adheres to the EIP-1193 Specs.

Related issues

Fixes: partially completes #28774

Manual testing steps

Screenshots/Recordings

Before

After

Pre-merge author checklist

I've followed MetaMask Contributor Docs and MetaMask Extension Coding Standards.
I've completed the PR template to the best of my ability
I’ve included tests if applicable
I’ve documented my code using JSDoc format if applicable
I’ve applied the right labels on the PR (see labeling guidelines). Not required for external contributors.

Pre-merge reviewer checklist

I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed).
I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

github-actions · 2025-01-09T21:38:41Z

CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes.

cryptodev-2s · 2025-01-09T21:38:46Z

@metamaskbot update-policies

socket-security · 2025-01-09T21:40:59Z

Removed dependencies detected. Learn more about Socket for GitHub ↗︎

🚮 Removed packages: npm/@metamask/[email protected], npm/@metamask/[email protected], npm/[email protected]

View full report↗︎

metamaskbot · 2025-01-09T21:45:28Z

Policy update failed. You can review the logs or retry the policy update here

cryptodev-2s · 2025-01-09T21:49:08Z

@metamaskbot update-policies

metamaskbot · 2025-01-09T21:59:46Z

Policies updated.
👀 Please review the diff for suspicious new powers.

🧠 Learn how: https://lavamoat.github.io/guides/policy-diff/#what-to-look-for-when-reviewing-a-policy-diff

cryptodev-2s · 2025-01-10T14:22:16Z

ui/ducks/send/helpers.js

@@ -405,19 +404,6 @@ export function getRoundedGasPrice(gasPriceEstimate) {
  return getGasPriceInHexWei(gasPriceAsNumber);
 }

-export async function getERC20Balance(token, accountAddress) {


Removed as not in use

cryptodev-2s · 2025-01-10T14:23:15Z

ui/ducks/send/send.test.js

@@ -90,15 +89,6 @@ const mockStore = createMockStore([thunk]);
 const mockAddress1 = '0xdafea492d9c6733ae3d56b7ed1adb60692c98123';
 const mockNftAddress1 = 'f4831105676a5fc024684d056390b8bc529daf51c7';

-jest.mock('./send', () => {


removed as getERC20Balance not in use and has been removed from helpers

cryptodev-2s · 2025-01-10T22:59:58Z

ui/helpers/utils/token-util.js

  try {
-    const result = await token.symbol();
-    return result[0];
+    const code = await contract.provider.getCode(tokenAddress);


The @metamask/ethjs library is more lenient and permits interactions with non-existent contracts. This is why token.symbol() previously worked and returned an empty string (""). Now that we’ve removed ethjs, we need to first verify if the contract exists before attempting such calls.

metamaskbot · 2025-01-10T23:30:18Z

Builds ready [c54a5c9]

builds: chrome, firefox
builds (flask): chrome, firefox
builds (MMI): chrome
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Bundle Size Stats
mv2: E2e Actions Stats
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5, 6, 7
- common: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12
- ui: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
- content-script: 0
- offscreen: 0

Page Load Metrics (1800 ± 90 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	321	2173	1737	374	180
		domContentLoaded	1523	2138	1764	179	86
		load	1573	2162	1800	187	90
		domInteractive	25	86	34	13	6
		backgroundConnect	9	89	32	22	11
		firstReactRender	16	102	41	26	12
		getState	5	47	14	14	7
		initialActions	0	0	0	0	0
		loadScripts	1144	1565	1319	133	64
		setupStore	6	87	18	22	11
		uiStartup	1769	2646	2074	257	124

Bundle size diffs [🚨 Warning! Bundle size has increased!]

background: -177 Bytes (-0.00%)
ui: -5.55 KiB (-0.07%)
common: 342 Bytes (0.00%)

mikesposito · 2025-01-13T09:43:50Z

There's this other ethjs-contract usage we can get rid of, which would allow to also remove is as a dependency from package.json:

metamask-extension/app/scripts/lib/ens-ipfs/resolver.js

Line 3 in c54a5c9

import EthContract from '@metamask/ethjs-contract';

cryptodev-2s · 2025-01-13T10:56:29Z

@metamaskbot update-policies

metamaskbot · 2025-01-13T11:07:43Z

Policies updated.
👀 Please review the diff for suspicious new powers.

🧠 Learn how: https://lavamoat.github.io/guides/policy-diff/#what-to-look-for-when-reviewing-a-policy-diff

metamaskbot · 2025-01-13T11:44:35Z

Builds ready [d6ec3e4]

builds: chrome, firefox
builds (flask): chrome, firefox
builds (MMI): chrome
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Bundle Size Stats
mv2: E2e Actions Stats
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5, 6, 7
- common: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12
- ui: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
- content-script: 0
- offscreen: 0

Page Load Metrics (1680 ± 111 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1410	2405	1689	235	113
		domContentLoaded	1402	2301	1644	219	105
		load	1411	2369	1680	232	111
		domInteractive	21	66	32	11	5
		backgroundConnect	9	74	37	22	10
		firstReactRender	15	99	39	27	13
		getState	5	94	21	22	11
		initialActions	0	1	0	0	0
		loadScripts	976	1650	1220	165	79
		setupStore	6	53	14	14	7
		uiStartup	1628	2725	1950	316	152

Bundle size diffs [🚨 Warning! Bundle size has increased!]

background: -310 Bytes (-0.01%)
ui: -5.55 KiB (-0.07%)
common: 625 Bytes (0.01%)

mikesposito

Just curious: why removing ethjs-* packages is a prerequisite for the provider work?

cryptodev-2s · 2025-01-13T11:56:03Z

Just curious: why removing ethjs-* packages is a prerequisite for the provider work?

The removal of @metamask/ethjs is necessary as it is not EIP-1193 compliant. This is required for the following PR: https://github.com/MetaMask/metamask-extension/pull/29650/files#diff-5a9d964db9d7c2fe207e21470884b2710e54723e0c1e6e6f7fd264706604fd6cR14. This PR replaces web3-stream-provider with StreamProvider from @metamask/providers, which exclusively supports EIP-1193 compliance.

cryptodev-2s self-assigned this Jan 9, 2025

cryptodev-2s requested a review from a team as a code owner January 9, 2025 21:38

cryptodev-2s marked this pull request as draft January 9, 2025 21:38

metamaskbot added the team-wallet-framework label Jan 9, 2025

cryptodev-2s changed the title ~~chore: remove ethjs~~ chore: remove @metamask/ethjs package Jan 9, 2025

cryptodev-2s force-pushed the cryptodev2s/remove-ethsjs branch 2 times, most recently from 345f6b1 to 0f60b67 Compare January 10, 2025 14:05

cryptodev-2s commented Jan 10, 2025

View reviewed changes

cryptodev-2s force-pushed the cryptodev2s/remove-ethsjs branch 2 times, most recently from 4b84fee to c54a5c9 Compare January 10, 2025 22:54

cryptodev-2s commented Jan 10, 2025

View reviewed changes

cryptodev-2s marked this pull request as ready for review January 10, 2025 23:01

cryptodev-2s requested review from a team as code owners January 10, 2025 23:01

cryptodev-2s and others added 5 commits January 13, 2025 11:57

chore: remove ethjs

af5408e

Update LavaMoat policies

067e934

fix: ethers contract results

8c56b05

refactor: remove unused code

f9d103e

fix: gracefully handle addresses with no contract

1993235

chore: remove @metamask/ethjs-contract & @metamask/ethjs-query

6b3c256

cryptodev-2s force-pushed the cryptodev2s/remove-ethsjs branch from f43efd9 to 6b3c256 Compare January 13, 2025 10:57

Update LavaMoat policies

d6ec3e4

mikesposito reviewed Jan 13, 2025

View reviewed changes

cryptodev-2s requested a review from mikesposito January 13, 2025 11:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: remove `@metamask/ethjs` package #29620

chore: remove `@metamask/ethjs` package #29620

cryptodev-2s commented Jan 9, 2025 •

edited

Loading

github-actions bot commented Jan 9, 2025

cryptodev-2s commented Jan 9, 2025

socket-security bot commented Jan 9, 2025 •

edited

Loading

metamaskbot commented Jan 9, 2025

cryptodev-2s commented Jan 9, 2025

metamaskbot commented Jan 9, 2025

cryptodev-2s Jan 10, 2025 •

edited

Loading

cryptodev-2s Jan 10, 2025

cryptodev-2s Jan 10, 2025

metamaskbot commented Jan 10, 2025

mikesposito commented Jan 13, 2025

cryptodev-2s commented Jan 13, 2025

metamaskbot commented Jan 13, 2025

metamaskbot commented Jan 13, 2025

mikesposito left a comment

cryptodev-2s commented Jan 13, 2025

chore: remove @metamask/ethjs package #29620

Are you sure you want to change the base?

chore: remove @metamask/ethjs package #29620

Conversation

cryptodev-2s commented Jan 9, 2025 • edited Loading

Description

Related issues

Manual testing steps

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

github-actions bot commented Jan 9, 2025

cryptodev-2s commented Jan 9, 2025

socket-security bot commented Jan 9, 2025 • edited Loading

metamaskbot commented Jan 9, 2025

cryptodev-2s commented Jan 9, 2025

metamaskbot commented Jan 9, 2025

cryptodev-2s Jan 10, 2025 • edited Loading

Choose a reason for hiding this comment

cryptodev-2s Jan 10, 2025

Choose a reason for hiding this comment

cryptodev-2s Jan 10, 2025

Choose a reason for hiding this comment

metamaskbot commented Jan 10, 2025

mikesposito commented Jan 13, 2025

cryptodev-2s commented Jan 13, 2025

metamaskbot commented Jan 13, 2025

metamaskbot commented Jan 13, 2025

mikesposito left a comment

Choose a reason for hiding this comment

cryptodev-2s commented Jan 13, 2025

chore: remove `@metamask/ethjs` package #29620

chore: remove `@metamask/ethjs` package #29620

cryptodev-2s commented Jan 9, 2025 •

edited

Loading

socket-security bot commented Jan 9, 2025 •

edited

Loading

cryptodev-2s Jan 10, 2025 •

edited

Loading