chore: replace `web3-stream-provider` with `StreamProvider` from `@metamask/providers` #29650

cryptodev-2s · 2025-01-12T13:37:35Z

Description

We use global.ethereumProvider in various places in the UI as an Ethereum provider, but it doesn't support EIP-1193 (it is missing events and the request method). We should replace the existing legacy provider with one that is compatible with EIP-1193.

This PR replaces web3-stream-provider with StreamProvider from @metamask/providers which is EIP-1193 compatible (only).

Related issues

Fixes: #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-12T13:37:46Z

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-12T13:37:50Z

@metamaskbot update-policies

socket-security · 2025-01-12T13:39:31Z

Updated and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/@metamask/[email protected] 🔁 npm/@metamask/[email protected]	None	`0`	35.7 kB	metamaskbot

🚮 Removed packages: npm/[email protected]

View full report↗︎

metamaskbot · 2025-01-12T13:48:34Z

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-12T18:00:26Z

@metamaskbot update-policies

metamaskbot · 2025-01-12T18:11:18Z

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-13T13:25:45Z

@metamaskbot update-policies

metamaskbot · 2025-01-13T13:36:36Z

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-15T13:43:48Z

@metamaskbot update-policies

metamaskbot · 2025-01-15T13:54:24Z

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

.yarn/patches/@metamask-providers-npm-18.2.0-3616fe3170.patch

cryptodev-2s · 2025-01-21T15:16:53Z

@metamaskbot update-policies

metamaskbot · 2025-01-21T15:27:35Z

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-21T16:06:10Z

Builds ready [b35e0c7]

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, 13
- ui: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
- content-script: 0
- offscreen: 0

Page Load Metrics (1660 ± 74 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	394	1996	1598	319	153
		domContentLoaded	1368	1928	1625	152	73
		load	1433	1977	1660	155	74
		domInteractive	23	131	43	27	13
		backgroundConnect	6	91	32	24	11
		firstReactRender	15	95	32	27	13
		getState	4	88	13	20	10
		initialActions	0	1	0	0	0
		loadScripts	937	1453	1192	138	66
		setupStore	7	69	15	18	9
		uiStartup	1571	2217	1905	191	92

Bundle size diffs [🚀 Bundle size reduced!]

background: -41.98 KiB (-0.71%)
ui: 80.36 KiB (1.01%)
common: 41.7 KiB (0.47%)

.yarn/patches/@metamask-providers-npm-18.2.0-3616fe3170.patch

metamaskbot · 2025-01-22T01:14:35Z

Builds ready [c83882d]

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, 13
- ui: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
- content-script: 0
- offscreen: 0

Page Load Metrics (1447 ± 36 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1361	1718	1450	80	38
		domContentLoaded	1353	1670	1429	69	33
		load	1363	1709	1447	75	36
		domInteractive	23	63	34	13	6
		backgroundConnect	6	44	19	12	6
		firstReactRender	14	95	37	24	12
		getState	4	59	13	16	7
		initialActions	0	1	0	0	0
		loadScripts	972	1269	1049	73	35
		setupStore	6	39	10	7	3
		uiStartup	1554	1948	1670	110	53

Bundle size diffs [🚀 Bundle size reduced!]

background: -41.98 KiB (-0.71%)
ui: 80.25 KiB (1.01%)
common: 41.94 KiB (0.48%)

metamaskbot · 2025-01-22T12:18:17Z

Builds ready [a486419]

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, 13
- ui: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
- content-script: 0
- offscreen: 0

Page Load Metrics (1788 ± 74 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	424	2221	1721	331	159
		domContentLoaded	1439	2194	1758	143	69
		load	1447	2222	1788	154	74
		domInteractive	26	121	43	24	12
		backgroundConnect	7	77	27	19	9
		firstReactRender	16	99	37	26	12
		getState	5	67	25	21	10
		initialActions	0	48	3	10	5
		loadScripts	1072	1448	1295	81	39
		setupStore	8	71	27	23	11
		uiStartup	1687	2604	2108	200	96

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

background: -41.98 KiB (-0.71%)
ui: 80.23 KiB (1.01%)
common: 41.99 KiB (0.48%)

mcmire · 2025-01-22T15:53:53Z

@cryptodev-2s Can you explain the problem that this solves in the PR description? I know that this is explained in the original ticket, but putting it in the commit message would save a step if we need to look this up later.

cryptodev-2s · 2025-01-22T16:45:34Z

@metamaskbot update-policies

metamaskbot · 2025-01-22T16:58:27Z

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-22T16:59:22Z

@metamaskbot update-policies

metamaskbot · 2025-01-22T17:11:46Z

No policy changes

metamaskbot · 2025-01-22T17:33:10Z

Builds ready [78283c9]

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, 13
- ui: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
- content-script: 0
- offscreen: 0

Page Load Metrics (1652 ± 81 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	647	1999	1576	250	120
		domContentLoaded	1445	2083	1629	158	76
		load	1454	2126	1652	168	81
		domInteractive	24	56	34	9	4
		backgroundConnect	7	75	23	19	9
		firstReactRender	15	98	37	30	14
		getState	5	60	20	21	10
		initialActions	0	1	0	0	0
		loadScripts	1020	1639	1187	147	71
		setupStore	8	72	19	19	9
		uiStartup	1658	2407	1988	225	108

Bundle size diffs [🚀 Bundle size reduced!]

background: -80.83 KiB (-1.36%)
ui: 120.77 KiB (1.52%)
common: 41.99 KiB (0.48%)

mcmire

I admit I do not totally understand how we are using streams, so forgive my perhaps dumb questions.

app/scripts/lib/stream-utils.js

app/scripts/ui.js

metamaskbot · 2025-01-22T21:37:55Z

Builds ready [1c55067]

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, 13
- ui: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
- content-script: 0
- offscreen: 0

Page Load Metrics (1806 ± 99 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	174	2362	1478	642	308
		domContentLoaded	1507	2299	1788	200	96
		load	1517	2359	1806	207	99
		domInteractive	24	86	50	16	8
		backgroundConnect	7	59	20	16	8
		firstReactRender	16	109	54	30	14
		getState	4	59	16	17	8
		initialActions	0	1	0	0	0
		loadScripts	1116	1784	1322	160	77
		setupStore	8	60	21	20	10
		uiStartup	1731	2757	2137	290	139

Bundle size diffs [🚀 Bundle size reduced!]

background: -81.27 KiB (-1.37%)
ui: 121.1 KiB (1.52%)
common: 42.33 KiB (0.48%)

socket-security · 2025-01-22T22:15:18Z

👍 Dependency issues cleared. Learn more about Socket for GitHub ↗︎

This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored.

View full report↗︎

metamaskbot · 2025-01-22T22:48:01Z

Builds ready [a75ce9e]

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, 13
- ui: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
- content-script: 0
- offscreen: 0

Page Load Metrics (1715 ± 77 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1466	2121	1722	157	75
		domContentLoaded	1456	2037	1693	149	72
		load	1465	2127	1715	160	77
		domInteractive	25	112	40	23	11
		backgroundConnect	7	87	24	22	11
		firstReactRender	15	76	37	24	12
		getState	5	46	9	9	4
		initialActions	0	1	0	0	0
		loadScripts	1077	1549	1275	131	63
		setupStore	8	84	28	25	12
		uiStartup	1691	2452	1996	187	90

Bundle size diffs [🚀 Bundle size reduced!]

background: -81.27 KiB (-1.37%)
ui: 121.1 KiB (1.52%)
common: 42.32 KiB (0.48%)

app/scripts/lib/stream-utils.js

mcmire

After reviewing the differences between StreamProvider from web3-stream-provider and @metamask/providers and the discussion in this PR, I have enough to wrap my head around this PR. Looks good to me, although it would be nice to have a second opinion.

metamaskbot · 2025-01-23T16:05:47Z

Builds ready [fd71f0a]

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, 13
- ui: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
- content-script: 0
- offscreen: 0

Page Load Metrics (1812 ± 111 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1557	2360	1815	226	108
		domContentLoaded	1523	2200	1772	214	103
		load	1528	2367	1812	230	111
		domInteractive	26	97	43	21	10
		backgroundConnect	8	171	43	37	18
		firstReactRender	15	95	44	29	14
		getState	5	98	25	24	12
		initialActions	0	1	0	0	0
		loadScripts	1078	1656	1318	170	82
		setupStore	7	57	12	11	5
		uiStartup	1746	3067	2104	330	158

Bundle size diffs [🚀 Bundle size reduced!]

background: -41.98 KiB (-0.71%)
ui: 121.33 KiB (1.52%)
common: 41.7 KiB (0.46%)

cryptodev-2s added the team-wallet-framework label Jan 12, 2025

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

cryptodev-2s marked this pull request as draft January 12, 2025 13:37

cryptodev-2s force-pushed the cryptodev2s/remove-eth-query-package branch from 6f611fc to 7066fe8 Compare January 13, 2025 12:09

cryptodev-2s force-pushed the cryptodev2s/remove-web3-stream-provider-2 branch from 2bb3610 to db8cbbf Compare January 13, 2025 13:25

cryptodev-2s force-pushed the cryptodev2s/remove-web3-stream-provider-2 branch from f544f7f to 3ed696d Compare January 13, 2025 14:10

cryptodev-2s force-pushed the cryptodev2s/remove-eth-query-package branch from 3acfcd6 to 0e2c767 Compare January 14, 2025 18:51

cryptodev-2s mentioned this pull request Jan 14, 2025

chore: remove @metamask/eth-query package #29649

Merged

7 tasks

Base automatically changed from cryptodev2s/remove-eth-query-package to main January 15, 2025 13:23

cryptodev-2s force-pushed the cryptodev2s/remove-web3-stream-provider-2 branch from 3ed696d to 52f8812 Compare January 15, 2025 13:43

cryptodev-2s mentioned this pull request Jan 15, 2025

chore: replace web3-stream-provider with StreamProvider from @metamask/providers #28967

Closed

7 tasks

cryptodev-2s commented Jan 15, 2025

View reviewed changes

.yarn/patches/@metamask-providers-npm-18.2.0-3616fe3170.patch Outdated Show resolved Hide resolved

cryptodev-2s commented Jan 15, 2025

View reviewed changes

.yarn/patches/@metamask-providers-npm-18.2.0-3616fe3170.patch Outdated Show resolved Hide resolved

cryptodev-2s force-pushed the cryptodev2s/remove-web3-stream-provider-2 branch 3 times, most recently from e45f12d to f60316b Compare January 21, 2025 15:16

cryptodev-2s force-pushed the cryptodev2s/remove-web3-stream-provider-2 branch from b35e0c7 to c16a7bc Compare January 21, 2025 21:58

cryptodev-2s added 2 commits January 22, 2025 01:14

chore: bump @metamask/eth-token-tracker to 10.0.2

d5eda2d

fix: stream wrapper orphent

c83882d

cryptodev-2s force-pushed the cryptodev2s/remove-web3-stream-provider-2 branch from c16a7bc to c83882d Compare January 22, 2025 00:14

cryptodev-2s commented Jan 22, 2025

View reviewed changes

.yarn/patches/@metamask-providers-npm-18.2.0-3616fe3170.patch Outdated Show resolved Hide resolved

cryptodev-2s requested a review from Gudahtt January 22, 2025 00:16

refactor: improve duplex error handling

a486419

fix: remove providers patch

84767fa

cryptodev-2s force-pushed the cryptodev2s/remove-web3-stream-provider-2 branch from 5ba1eeb to 84767fa Compare January 22, 2025 16:56

Update LavaMoat policies

78283c9

mcmire reviewed Jan 22, 2025

View reviewed changes

app/scripts/lib/stream-utils.js Outdated Show resolved Hide resolved

app/scripts/lib/stream-utils.js Outdated Show resolved Hide resolved

app/scripts/ui.js Outdated Show resolved Hide resolved

fix: provider message unwrap

1c55067

feat: use PassThrough

a75ce9e

cryptodev-2s requested a review from mcmire January 22, 2025 22:36

cryptodev-2s commented Jan 22, 2025

View reviewed changes

app/scripts/lib/stream-utils.js Outdated Show resolved Hide resolved

mcmire previously approved these changes Jan 22, 2025

View reviewed changes

fix: patch providers

1554213

cryptodev-2s dismissed mcmire’s stale review via 1554213 January 23, 2025 15:31

Merge branch 'main' into cryptodev2s/remove-web3-stream-provider-2

fd71f0a

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: replace `web3-stream-provider` with `StreamProvider` from `@metamask/providers` #29650

chore: replace `web3-stream-provider` with `StreamProvider` from `@metamask/providers` #29650

cryptodev-2s commented Jan 12, 2025 •

edited

Loading

github-actions bot commented Jan 12, 2025

cryptodev-2s commented Jan 12, 2025

socket-security bot commented Jan 12, 2025 •

edited

Loading

metamaskbot commented Jan 12, 2025

cryptodev-2s commented Jan 12, 2025

metamaskbot commented Jan 12, 2025

cryptodev-2s commented Jan 13, 2025

metamaskbot commented Jan 13, 2025

cryptodev-2s commented Jan 15, 2025

metamaskbot commented Jan 15, 2025

cryptodev-2s commented Jan 21, 2025

metamaskbot commented Jan 21, 2025

metamaskbot commented Jan 21, 2025

metamaskbot commented Jan 22, 2025

metamaskbot commented Jan 22, 2025

mcmire commented Jan 22, 2025

cryptodev-2s commented Jan 22, 2025

metamaskbot commented Jan 22, 2025

cryptodev-2s commented Jan 22, 2025

metamaskbot commented Jan 22, 2025

metamaskbot commented Jan 22, 2025

mcmire left a comment

metamaskbot commented Jan 22, 2025

socket-security bot commented Jan 22, 2025 •

edited

Loading

metamaskbot commented Jan 22, 2025

mcmire left a comment

metamaskbot commented Jan 23, 2025

chore: replace web3-stream-provider with StreamProvider from @metamask/providers #29650

Are you sure you want to change the base?

chore: replace web3-stream-provider with StreamProvider from @metamask/providers #29650

Conversation

cryptodev-2s commented Jan 12, 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 12, 2025

cryptodev-2s commented Jan 12, 2025

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

metamaskbot commented Jan 12, 2025

cryptodev-2s commented Jan 12, 2025

metamaskbot commented Jan 12, 2025

cryptodev-2s commented Jan 13, 2025

metamaskbot commented Jan 13, 2025

cryptodev-2s commented Jan 15, 2025

metamaskbot commented Jan 15, 2025

cryptodev-2s commented Jan 21, 2025

metamaskbot commented Jan 21, 2025

metamaskbot commented Jan 21, 2025

metamaskbot commented Jan 22, 2025

metamaskbot commented Jan 22, 2025

mcmire commented Jan 22, 2025

cryptodev-2s commented Jan 22, 2025

metamaskbot commented Jan 22, 2025

cryptodev-2s commented Jan 22, 2025

metamaskbot commented Jan 22, 2025

metamaskbot commented Jan 22, 2025

mcmire left a comment

Choose a reason for hiding this comment

metamaskbot commented Jan 22, 2025

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

metamaskbot commented Jan 22, 2025

mcmire left a comment

Choose a reason for hiding this comment

metamaskbot commented Jan 23, 2025

chore: replace `web3-stream-provider` with `StreamProvider` from `@metamask/providers` #29650

chore: replace `web3-stream-provider` with `StreamProvider` from `@metamask/providers` #29650

cryptodev-2s commented Jan 12, 2025 •

edited

Loading

socket-security bot commented Jan 12, 2025 •

edited

Loading

socket-security bot commented Jan 22, 2025 •

edited

Loading