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 and updated dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/@babel/[email protected] 🔁 npm/@babel/[email protected]	None	`0`	10.7 kB	nicolo-ribaudo
npm/@metamask/[email protected] 🔁 npm/@metamask/[email protected]	None	`0`	0 B
npm/@types/[email protected]	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/[email protected]	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/[email protected] or ignore all packages with @SocketSecurity ignore-all

@SocketSecurity ignore npm/@types/[email protected]

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

FrederikBolding · 2024-08-15T13:30:28Z

builds.yml

@@ -26,7 +26,7 @@ buildTypes:
      - SEGMENT_WRITE_KEY_REF: SEGMENT_PROD_WRITE_KEY
      - ALLOW_LOCAL_SNAPS: false
      - REQUIRE_SNAPS_ALLOWLIST: true
-      - IFRAME_EXECUTION_ENVIRONMENT_URL: https://execution.metamask.io/iframe/6.5.0/index.html
+      - IFRAME_EXECUTION_ENVIRONMENT_URL: http://localhost:6363


Should be reverted before merge

FrederikBolding · 2024-08-15T13:30:38Z

package.json

@@ -350,7 +350,7 @@
    "@metamask/rpc-errors": "^6.2.1",
    "@metamask/safe-event-emitter": "^3.1.1",
    "@metamask/scure-bip39": "^2.0.3",
-    "@metamask/selected-network-controller": "^15.0.2",
+    "@metamask/selected-network-controller": "npm:@metamask-previews/selected-network-controller@17.0.0-preview-55328a6",


Should be reverted before merge

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%)

app/scripts/migrations/140.ts

adonesky1 · 2025-01-21T21:26:49Z

app/scripts/migrations/140.ts

+    SelectedNetworkController: selectedNetworkControllerState,
+  } = state;
+  if (!networkControllerState || !isObject(networkControllerState)) {
+    log.warn(


🤔 where do these logs go? I'm more familiar with the pattern of sending these logs to sentry via:
global.sentry?.captureException(...). Like here for example.

Not sure. I copied this from another migration, but I see now that the Sentry pattern is used in others. I'll swap it out for that.

adonesky1 · 2025-01-21T21:28:48Z

app/scripts/migrations/140.ts

+  >((accumulator, [key, subject]) => {
+    const permissionKeys = Object.keys(subject.permissions);
+    const needsMigration =
+      permissionKeys.includes(SnapEndowments.EthereumProvider) &&


I'm assuming this permission can only be granted to Snaps? Otherwise we could be overwriting permissions for non-snaps subjects?

Yes, it can only be granted to Snaps.

https://github.com/MetaMask/snaps/blob/d71d6d892eb474d9a8df22dacb2ed5149957c7f0/packages/snaps-rpc-methods/src/endowments/ethereum-provider.ts#L41

jiexi · 2025-01-21T23:42:25Z

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

@@ -201,13 +204,13 @@ export async function switchChain(
      if (!ethChainIds.includes(chainId)) {
        await requestPermittedChainsPermissionIncrementalForOrigin({
          chainId,
-          autoApprove: isAddFlow,
+          autoApprove: isAddFlow || isSnapId(origin),


i have a PR here that replaces the isAddFlow param with one named autoApprove. Perhaps this isSnapId check can happen outside the switchChain helper that way we don't need to pass origin in?

Makes sense. I didn't want to use isAddFlow since it's not an add flow, but autoApprove sounds good.

i managed to not link the PR lol. Here it is

#29837

app/scripts/migrations/140.ts

…rrent network

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

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

adonesky1 reviewed Jan 21, 2025

View reviewed changes

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

adonesky1 reviewed Jan 21, 2025

View reviewed changes

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

adonesky1 reviewed Jan 21, 2025

View reviewed changes

jiexi reviewed Jan 21, 2025

View reviewed changes

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

Mrtenz added 5 commits January 22, 2025 12:27

Add support for custom network per Snap

dd12133

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

e334eba

…rrent network

Dedupe yarn.lock

0a86ca6

Add test for Snap calling wallet_switchEthereumChain

be1621b

Remove Snap checks

49ac07d

Mrtenz force-pushed the mrtenz/snap-networks branch from 5b07c03 to 49ac07d Compare January 22, 2025 11:29

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

FrederikBolding Aug 15, 2024

FrederikBolding 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

adonesky1 Jan 21, 2025

Mrtenz Jan 22, 2025

adonesky1 Jan 21, 2025

Mrtenz Jan 22, 2025 •

edited

Loading

jiexi Jan 21, 2025 •

edited

Loading

Mrtenz Jan 22, 2025

jiexi Jan 22, 2025

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

FrederikBolding Aug 15, 2024

Choose a reason for hiding this comment

FrederikBolding Aug 15, 2024

Choose a reason for hiding this comment

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

adonesky1 Jan 21, 2025

Choose a reason for hiding this comment

Mrtenz Jan 22, 2025

Choose a reason for hiding this comment

adonesky1 Jan 21, 2025

Choose a reason for hiding this comment

Mrtenz Jan 22, 2025 • edited Loading

Choose a reason for hiding this comment

jiexi Jan 21, 2025 • edited Loading

Choose a reason for hiding this comment

Mrtenz Jan 22, 2025

Choose a reason for hiding this comment

jiexi Jan 22, 2025

Choose a reason for hiding this comment

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

Mrtenz Jan 22, 2025 •

edited

Loading

jiexi Jan 21, 2025 •

edited

Loading