feat(snaps): Add support for custom network per Snap #26389

Mrtenz · 2024-08-13T13:55:08Z

Description

Like with websites, we want to support a custom network per Snap rather than relying on the globally selected network. For Snaps, the permission for the network to switch to is automatically granted.

Blocked by:

Todo

Revert execution environment URL.
Remove preview version for selected-network-controller.

Manual testing steps

Build the extension with CHAIN_PERMISSIONS=true.
Use wallet_switchEthereumChain in a Snap.
The Snap should now use the new network, without any permission requests.

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.

socket-security · 2024-08-13T13:56:37Z

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

Package	New capabilities	Transitives	Size	Publisher
npm/@types/nanoid@3.0.0	None	`0`	1.63 kB	types

View full report↗︎

socket-security · 2024-08-13T13:56:40Z

🚨 Potential security issues detected. Learn more about Socket for GitHub ↗︎

To accept the risk, merge this PR and you will not be notified again.

Alert	Package	Note	Source	CI
Deprecated	npm/@types/nanoid@3.0.0	Reason: This is a stub types definition. nanoid provides its own type definitions, so you do not need this installed.	`package.json` `yarn.lock`	⚠︎

View full report↗︎

Next steps

What is a deprecated package?

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

Research the state of the package and determine if there are non-deprecated versions that can be used, or if it should be replaced with a new, supported solution.

Take a deeper look at the dependency

Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support [AT] socket [DOT] dev.

Remove the package

If you happen to install a dependency that Socket reports as Known Malware you should immediately remove it and select a different dependency. For other alert types, you may may wish to investigate alternative packages or consider if there are other ways to mitigate the specific risk posed by the dependency.

Mark a package as acceptable risk

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of ecosystem/package-name@version specifiers. e.g. @SocketSecurity ignore npm/foo@1.0.0 or ignore all packages with @SocketSecurity ignore-all

@SocketSecurity ignore npm/@types/nanoid@3.0.0

sonarqubecloud · 2024-08-15T08:31:44Z

Quality Gate passed

Issues
2 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

builds.yml

package.json

app/scripts/lib/rpc-method-middleware/handlers/ethereum-chain-utils.js

app/scripts/metamask-controller.js

app/scripts/migrations/126.ts

app/scripts/migrations/126.test.ts

github-actions · 2024-10-28T10:05:20Z

This PR has been automatically marked as stale because it has not had recent activity in the last 60 days. It will be closed in 14 days. Thank you for your contributions.

github-actions · 2024-11-11T10:05:23Z

This PR was closed because there has been no follow up activity in the last 14 days. Thank you for your contributions.

github-actions · 2025-01-17T12:42:44Z

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.

app/scripts/metamask-controller.js

FrederikBolding · 2025-01-17T13:32:21Z

@adonesky1 or @jiexi should review this PR too

app/scripts/migrations/139.ts

metamaskbot · 2025-01-21T14:07:40Z

Builds ready [b74b5a8]

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 (1927 ± 202 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	306	3026	1663	678	326
		domContentLoaded	1505	2969	1899	411	197
		load	1522	3032	1927	421	202
		domInteractive	25	188	51	36	17
		backgroundConnect	7	81	27	25	12
		firstReactRender	15	75	46	23	11
		getState	5	52	14	14	7
		initialActions	0	1	0	0	0
		loadScripts	1078	1987	1395	291	140
		setupStore	6	51	14	13	6
		uiStartup	1698	3208	2208	492	236

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

background: 54 Bytes (0.00%)
ui: 0 Bytes (0.00%)
common: 0 Bytes (0.00%)

…rrent network

Co-authored-by: Frederik Bolding <frederik.bolding@gmail.com>

Co-authored-by: Alex Donesky <adonesky@gmail.com>

metamaskbot · 2025-04-07T13:09:21Z

Builds ready [507a83f]

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

UI Startup Metrics (1231 ± 61 ms)

Platform	BuildType	Page	Metric	Mean (ms)	Min (ms)	Max (ms)	Std Dev (ms)	P 75 (ms)	P 95 (ms)
Chrome	Browserify	Home	uiStartup	1231	1093	1473	61	1263	1348
			load	1076	950	1254	62	1141	982
			domContentLoaded	1070	944	1241	61	1146	993
			domInteractive	17	13	65	8	16	29
			firstPaint	780	82	1249	408	241	973
			backgroundConnect	11	6	137	13	9	10
			firstReactRender	21	13	74	8	21	39
			getState	13	5	41	8	7	8
			initialActions	0	0	1	0	0	0
			loadScripts	816	691	984	61	846	936
			setupStore	8	4	24	3	7	9
	Webpack	Home	uiStartup	2189	1695	2639	228	2377	2513
			load	1733	1290	2274	215	1854	2175
			domContentLoaded	1726	1285	2269	215	1850	2171
			domInteractive	18	12	134	15	14	42
			firstPaint	163	67	383	64	263	93
			backgroundConnect	36	11	276	40	36	68
			firstReactRender	145	52	429	109	75	96
			getState	16	4	265	31	7	9
			initialActions	3	1	9	1	3	6
			loadScripts	1717	1276	2265	213	1838	2166
			setupStore	22	6	279	39	7	9
Firefox	Browserify	Home	uiStartup	1409	1214	1944	156	1451	1775
			load	1266	1073	1779	151	1311	1619
			domContentLoaded	1265	1072	1778	151	1311	1618
			domInteractive	102	37	317	40	90	97
			firstPaint	NaN	NaN	NaN	NaN	NaN	NaN
			backgroundConnect	28	17	247	24	28	36
			firstReactRender	22	19	48	4	22	28
			getState	8	4	39	5	8	9
			initialActions	0	0	2	0	0	1
			loadScripts	1239	1052	1753	147	1282	1594
			setupStore	7	4	51	7	6	7
	Webpack	Home	uiStartup	1526	1343	2067	159	1588	1935
			load	1318	1165	1833	149	1388	1703
			domContentLoaded	1317	1165	1833	149	1388	1702
			domInteractive	92	40	197	22	90	98
			firstPaint	NaN	NaN	NaN	NaN	NaN	NaN
			backgroundConnect	25	17	50	6	27	42
			firstReactRender	35	28	61	6	38	48
			getState	9	4	66	7	8	9
			initialActions	1	0	2	1	1	1
			loadScripts	1295	1142	1812	148	1370	1680
			setupStore	8	5	23	3	8	9

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

background: 1.29 MiB (24.96%)
ui: 9 Bytes (0%)
common: 130 Bytes (0%)

metamaskbot · 2025-04-07T14:09:18Z

Builds ready [1673965]

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

UI Startup Metrics (1231 ± 68 ms)

Platform	BuildType	Page	Metric	Mean (ms)	Min (ms)	Max (ms)	Std Dev (ms)	P 75 (ms)	P 95 (ms)
Chrome	Browserify	Home	uiStartup	1231	1102	1512	68	1265	1333
			load	1082	968	1315	65	1144	986
			domContentLoaded	1074	964	1307	67	1164	993
			domInteractive	16	12	45	5	16	27
			firstPaint	728	96	1200	435	196	975
			backgroundConnect	11	6	74	8	9	10
			firstReactRender	20	15	42	5	21	31
			getState	12	5	32	7	7	9
			initialActions	0	0	1	0	0	0
			loadScripts	821	703	1055	66	853	907
			setupStore	8	5	17	2	7	8
	Webpack	Home	uiStartup	2268	1867	2694	183	2402	2551
			load	1791	1359	2300	188	1873	2182
			domContentLoaded	1784	1351	2296	187	1867	2177
			domInteractive	18	13	83	13	15	55
			firstPaint	174	65	350	68	273	89
			backgroundConnect	39	12	281	42	41	65
			firstReactRender	188	56	426	119	61	90
			getState	18	4	209	28	6	9
			initialActions	3	1	8	1	4	6
			loadScripts	1767	1347	2282	170	1855	2035
			setupStore	24	6	273	37	44	8
Firefox	Browserify	Home	uiStartup	1390	1174	1996	165	1445	1793
			load	1247	1049	1850	158	1314	1615
			domContentLoaded	1247	1049	1850	158	1314	1615
			domInteractive	100	38	159	23	89	98
			firstPaint	NaN	NaN	NaN	NaN	NaN	NaN
			backgroundConnect	25	16	56	8	26	43
			firstReactRender	22	19	34	3	24	28
			getState	8	4	53	7	7	9
			initialActions	0	0	1	0	0	1
			loadScripts	1224	1027	1827	157	1295	1583
			setupStore	6	4	13	2	6	7
	Webpack	Home	uiStartup	1558	1351	2067	166	1620	1976
			load	1344	1148	1799	154	1408	1749
			domContentLoaded	1344	1147	1799	154	1408	1749
			domInteractive	99	40	176	26	89	95
			firstPaint	NaN	NaN	NaN	NaN	NaN	NaN
			backgroundConnect	26	18	54	7	28	45
			firstReactRender	36	29	54	6	38	48
			getState	8	4	32	4	8	9
			initialActions	1	0	2	1	1	1
			loadScripts	1321	1127	1768	153	1386	1710
			setupStore	8	5	42	5	8	9

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

background: 1.3 MiB (25.04%)
ui: 12 Bytes (0%)
common: 400 Bytes (0%)

adonesky1 · 2025-04-21T18:46:21Z

Could you explain a bit more directly in the PR description how to:

Use wallet_switchEthereumChain in a Snap.

?

metamaskbot added the INVALID-PR-TEMPLATE PR's body doesn't match template label Aug 13, 2024

metamaskbot added the team-snaps-platform Snaps Platform team label Aug 13, 2024

Mrtenz changed the title ~~Add support for custom network per Snap~~ feat(snaps): Add support for custom network per Snap Aug 14, 2024

Mrtenz force-pushed the mrtenz/snap-networks branch from 38edd7a to 7f2494b Compare August 15, 2024 08:29

FrederikBolding reviewed Aug 15, 2024

View reviewed changes

builds.yml Outdated Show resolved Hide resolved

FrederikBolding reviewed Aug 15, 2024

View reviewed changes

package.json Outdated Show resolved Hide resolved

FrederikBolding reviewed Aug 15, 2024

View reviewed changes

app/scripts/lib/rpc-method-middleware/handlers/ethereum-chain-utils.js Outdated Show resolved Hide resolved

FrederikBolding reviewed Aug 29, 2024

View reviewed changes

app/scripts/metamask-controller.js Outdated Show resolved Hide resolved

FrederikBolding reviewed Aug 29, 2024

View reviewed changes

app/scripts/migrations/126.ts Outdated Show resolved Hide resolved

FrederikBolding reviewed Aug 29, 2024

View reviewed changes

app/scripts/migrations/126.ts Outdated Show resolved Hide resolved

FrederikBolding reviewed Aug 29, 2024

View reviewed changes

app/scripts/migrations/126.test.ts Outdated Show resolved Hide resolved

github-actions bot added the stale issues and PRs marked as stale label Oct 28, 2024

github-actions bot closed this Nov 11, 2024

Mrtenz reopened this Jan 15, 2025

Mrtenz removed the stale issues and PRs marked as stale label Jan 15, 2025

Mrtenz force-pushed the mrtenz/snap-networks branch from 6453f80 to cf763b1 Compare January 17, 2025 12:42

Mrtenz changed the base branch from develop to main January 17, 2025 12:42

FrederikBolding requested a review from adonesky1 January 17, 2025 13:21

FrederikBolding reviewed Jan 17, 2025

View reviewed changes

app/scripts/metamask-controller.js Outdated Show resolved Hide resolved

FrederikBolding requested a review from jiexi January 17, 2025 13:32

FrederikBolding reviewed Jan 21, 2025

View reviewed changes

app/scripts/migrations/139.ts Outdated Show resolved Hide resolved

Mrtenz force-pushed the mrtenz/snap-networks branch from 0110271 to b74b5a8 Compare January 21, 2025 13:33

Mrtenz and others added 22 commits April 7, 2025 14:20

Add support for custom network per Snap

36f18f5

Add migration adding permission to the Snap and setting the Snap's cu…

3160975

…rrent network

Add test for Snap calling wallet_switchEthereumChain

2aff456

Remove Snap checks

060e556

Remove obsolete tests

51d9037

Fix test

560b008

Update app/scripts/migrations/144.ts

4e3101e

Co-authored-by: Frederik Bolding <frederik.bolding@gmail.com>

Update app/scripts/migrations/144.ts

012aca3

Co-authored-by: Frederik Bolding <frederik.bolding@gmail.com>

Update documentation

d2a57b2

Update test

7d05210

Update app/scripts/migrations/144.ts

33a1f14

Co-authored-by: Alex Donesky <adonesky@gmail.com>

Add missing new line

1ce6347

Address PR feedback

9fc1a97

Fix lint error

9fd45e9

Fix test

83165dc

Update app/scripts/migrations/151.ts

b52403b

Co-authored-by: Alex Donesky <adonesky@gmail.com>

Rename getCaveat function

c1e67fd

Rename caveatValue variable

d1ec8fa

Rename configurationChainId variable

486f165

Add comment explaining use of Object.entries

a42591d

Update existing permission in test

437090f

Use network client ID instead of chain ID

507a83f

Mrtenz force-pushed the mrtenz/snap-networks branch from aa7b725 to 507a83f Compare April 7, 2025 12:34

Mrtenz added 2 commits April 7, 2025 15:31

Add migration to index.js again

42190e2

Fix lint error

1673965

Mrtenz requested review from jiexi and adonesky1 April 7, 2025 13:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(snaps): Add support for custom network per Snap #26389

feat(snaps): Add support for custom network per Snap #26389

Mrtenz commented Aug 13, 2024 •

edited

Loading

socket-security bot commented Aug 13, 2024 •

edited

Loading

socket-security bot commented Aug 13, 2024 •

edited

Loading

sonarqubecloud bot commented Aug 15, 2024

github-actions bot commented Oct 28, 2024

github-actions bot commented Nov 11, 2024

github-actions bot commented Jan 17, 2025

FrederikBolding commented Jan 17, 2025

metamaskbot commented Jan 21, 2025

metamaskbot commented Apr 7, 2025

metamaskbot commented Apr 7, 2025

adonesky1 commented Apr 21, 2025 •

edited

Loading

feat(snaps): Add support for custom network per Snap #26389

Are you sure you want to change the base?

feat(snaps): Add support for custom network per Snap #26389

Conversation

Mrtenz commented Aug 13, 2024 • edited Loading

Description

Todo

Manual testing steps

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

socket-security bot commented Aug 13, 2024 • edited Loading

socket-security bot commented Aug 13, 2024 • edited Loading

Next steps

sonarqubecloud bot commented Aug 15, 2024

Quality Gate passed

github-actions bot commented Oct 28, 2024

github-actions bot commented Nov 11, 2024

github-actions bot commented Jan 17, 2025

FrederikBolding commented Jan 17, 2025

metamaskbot commented Jan 21, 2025

metamaskbot commented Apr 7, 2025

metamaskbot commented Apr 7, 2025

adonesky1 commented Apr 21, 2025 • edited Loading

Mrtenz commented Aug 13, 2024 •

edited

Loading

socket-security bot commented Aug 13, 2024 •

edited

Loading

socket-security bot commented Aug 13, 2024 •

edited

Loading

adonesky1 commented Apr 21, 2025 •

edited

Loading