feat: always use snaps to resolve domains; include preinstalled ENS resolver snap #26242

mirceanis · 2024-07-31T07:46:06Z

Description

The embedded ENS resolution logic is being replaced by snaps that use endowment:name-lookup.
This change-set also includes a preinstalled snap that does ENS resolution including ENS multi-coin functionality.

The ENS resolver snap will use the Ethereum provider from the extension on Ethereum mainnet and ENS supported testnets and will revert to an Infura JSON-RPC when the extension is connected to other networks. On other networks it tries to resolve the network-specific ENS address and if none exists will try to resolve the mainnet address (with a ⚠️ warning) as long as that address appears to be an externally owned account.

Most of the relevant changes are in domains.js.
Since the preinstalled snap uses ethers v6 while the extension depends on ethers v5.7 there are some changes in the lavamoat policies. Also, the more recent ethers version requires a different set of mocks, requiring a small change in the e2e test.

Related issues

fixes https://github.com/MetaMask/MetaMask-planning/issues/2403
closes #18035
fixes #18648
fixes #22797
fixes #8556
fixes MetaMask/specifications#11

Manual testing steps

While on Ethereum mainnet, start a send flow
Type an ENS name in the recipient field(example vitalik.eth), pick the resulting address. (this should be identical to previous behavior)
Switch to a L2
Type an EOA ENS name in the recipient field (example vitalik.eth), observe an address being resolved with a ⚠️warning.
Type an ENS name that would resolve to a contract on mainnet (example uniswap.eth). Observe No resolution for domain provided. error.

Screenshots/Recordings

Before

After

after.mov

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 · 2024-07-31T07:46:19Z

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.

…esolver snap fixes MetaMask/MetaMask-planning#2403 Signed-off-by: Mircea Nistor <mirceanis@gmail.com>

socket-security · 2024-07-31T16:22:20Z

👍 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.

Ignoring: npm/@metamask/ens-resolver-snap@0.1.2

View full report↗︎

Next steps

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

…straction/contracts Signed-off-by: Mircea Nistor <mirceanis@gmail.com>

mirceanis · 2024-08-01T09:16:05Z

@SocketSecurity ignore npm/@metamask/ens-resolver-snap@0.1.1

…enerated on CI Signed-off-by: Mircea Nistor <mirceanis@gmail.com>

Signed-off-by: Mircea Nistor <mirceanis@gmail.com>

codecov · 2024-08-02T13:53:52Z

Codecov Report

Attention: Patch coverage is 33.33333% with 20 lines in your changes missing coverage. Please review.

Project coverage is 70.05%. Comparing base (ca6fd53) to head (0afeb71).
Report is 23 commits behind head on develop.

Files with missing lines	Patch %	Lines
ui/ducks/domains.js	5.26%	18 Missing ⚠️
...s/send/components/domain-input-resolution-cell.tsx	0.00%	2 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop   #26242      +/-   ##
===========================================
+ Coverage    69.96%   70.05%   +0.09%     
===========================================
  Files         1442     1442              
  Lines        50100    50009      -91     
  Branches     14006    13965      -41     
===========================================
- Hits         35049    35029      -20     
+ Misses       15051    14980      -71

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

app/scripts/metamask-controller.actions.test.js

mirceanis · 2024-08-02T14:01:22Z

package.json

@@ -560,6 +561,7 @@
    "eslint-plugin-react-hooks": "^4.2.0",
    "eslint-plugin-storybook": "^0.6.15",
    "eta": "^3.2.0",
+    "ethers": "5.7.0",


Not directly used, but expected by @account-abstraction/contracts during tests.
Without this, tests would fail as the transitive ethers v6+ would get used.

ui/ducks/domains.js

metamaskbot · 2024-08-02T14:06:14Z

Builds ready [83e07e3]

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

Page Load Metrics (539 ± 370 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	77	490	169	113	54
		domContentLoaded	9	148	40	34	16
		load	48	2103	539	770	370
		domInteractive	9	148	40	34	16

Bundle size diffs [🚀 Bundle size reduced!]

background: -105 Bytes (-0.00%)
ui: 0 Bytes (0.00%)
common: -849 Bytes (-0.01%)

…2403-resolve-on-l2 # Conflicts: # lavamoat/browserify/beta/policy.json # lavamoat/browserify/flask/policy.json # lavamoat/browserify/main/policy.json # lavamoat/browserify/mmi/policy.json

Signed-off-by: Mircea Nistor <mirceanis@gmail.com>

metamaskbot · 2024-08-12T12:59:38Z

Builds ready [546b2bc]

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

Page Load Metrics (319 ± 271 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	67	274	126	66	32
		domContentLoaded	9	164	41	50	24
		load	40	1735	319	563	271
		domInteractive	9	164	41	50	24

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

background: 10.63 KiB (0.30%)
ui: 0 Bytes (0.00%)
common: 24.74 KiB (0.35%)

app/scripts/metamask-controller.actions.test.js

ui/pages/confirmations/send/send-content/add-recipient/domain-input.container.js

…2403-resolve-on-l2

…2403-resolve-on-l2 # Conflicts: # app/_locales/en/messages.json

Signed-off-by: Mircea Nistor <mirceanis@gmail.com>

This reverts commit 606b389.

…2403-resolve-on-l2

danjm · 2024-09-17T19:14:56Z

@metamaskbot update-policies

metamaskbot · 2024-09-17T19:27:18Z

No policy changes

metamaskbot · 2024-09-17T20:34:25Z

Builds ready [0afeb71]

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

Page Load Metrics (1746 ± 80 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	288	2094	1660	349	168
		domContentLoaded	1482	2068	1733	168	81
		load	1500	2084	1746	166	80
		domInteractive	24	65	33	12	6

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

background: 249.42 KiB (7.07%)
ui: 74.95 KiB (1.04%)
common: 91.5 KiB (1.14%)

…2403-resolve-on-l2 # Conflicts: # lavamoat/browserify/beta/policy.json # lavamoat/browserify/flask/policy.json # lavamoat/browserify/main/policy.json # lavamoat/browserify/mmi/policy.json

Signed-off-by: Mircea Nistor <mirceanis@gmail.com>

sonarcloud · 2024-09-18T10:33:55Z

Quality Gate passed

Issues
1 New issue
0 Accepted issues

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

See analysis details on SonarCloud

metamaskbot · 2024-09-18T12:49:36Z

Builds ready [2dcdfe4]

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

Page Load Metrics (1744 ± 53 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	235	1930	1591	454	218
		domContentLoaded	1509	1921	1719	103	49
		load	1519	2008	1744	111	53
		domInteractive	13	151	40	28	14

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

background: 249.42 KiB (7.05%)
ui: 74.95 KiB (1.04%)
common: 91.5 KiB (1.14%)

hmalik88

LGTM

jpuri

Change in files owned by confirmations team look good.

weizman

lgtm (strictly policies):

new globals:
- fetch and WebSocket introduced by a different version of the pkg (so they're not new)
- define is also already used previously
- could not find other new globals that may be risky
new packages
- packages consumption seems fine too, just a reorg
I only checked main/policy.json, assuming the rest are similar (worth a check @mirceanis)

mirceanis force-pushed the feat/2403-resolve-on-l2 branch 2 times, most recently from 5962a95 to 81fb9c0 Compare July 31, 2024 14:01

feat: always use snaps to resolve domains; include preinstalled ENS r…

19fbf60

…esolver snap fixes MetaMask/MetaMask-planning#2403 Signed-off-by: Mircea Nistor <mirceanis@gmail.com>

mirceanis force-pushed the feat/2403-resolve-on-l2 branch from 81fb9c0 to 19fbf60 Compare July 31, 2024 16:21

mirceanis force-pushed the feat/2403-resolve-on-l2 branch from 70e86ff to 5cf7905 Compare August 1, 2024 08:59

chore(deps): add ethers@5.7.0 dev dependency, expected by @account-ab…

6682719

…straction/contracts Signed-off-by: Mircea Nistor <mirceanis@gmail.com>

mirceanis force-pushed the feat/2403-resolve-on-l2 branch from 5cf7905 to 6682719 Compare August 1, 2024 09:12

mirceanis added area-snaps area-multichain team-wallet-ux labels Aug 1, 2024

chore(ci): manually update lavamoat policy to match the one getting g…

962b056

…enerated on CI Signed-off-by: Mircea Nistor <mirceanis@gmail.com>

mirceanis force-pushed the feat/2403-resolve-on-l2 branch from 534452a to 962b056 Compare August 1, 2024 10:27

refactor: guard the use of ENS snap by BUILD_FLASK flag

83e07e3

Signed-off-by: Mircea Nistor <mirceanis@gmail.com>

mirceanis mentioned this pull request Aug 2, 2024

Unfence name lookup for stable MetaMask/snaps#2621

Closed

mirceanis commented Aug 2, 2024

View reviewed changes

mirceanis marked this pull request as ready for review August 2, 2024 14:17

mirceanis requested review from a team as code owners August 2, 2024 14:17

mirceanis added 2 commits August 12, 2024 13:30

Merge remote-tracking branch 'refs/remotes/origin/develop' into feat/…

ea9817a

…2403-resolve-on-l2 # Conflicts: # lavamoat/browserify/beta/policy.json # lavamoat/browserify/flask/policy.json # lavamoat/browserify/main/policy.json # lavamoat/browserify/mmi/policy.json

chore: rebuild lavamoat policies

546b2bc

Signed-off-by: Mircea Nistor <mirceanis@gmail.com>

jonybur requested changes Aug 12, 2024

View reviewed changes

app/scripts/metamask-controller.actions.test.js Show resolved Hide resolved

ui/pages/confirmations/send/send-content/add-recipient/domain-input.container.js Outdated Show resolved Hide resolved

jonybur previously approved these changes Aug 14, 2024

View reviewed changes

mirceanis added 3 commits September 12, 2024 12:31

Merge remote-tracking branch 'refs/remotes/origin/develop' into feat/…

35cf667

…2403-resolve-on-l2

Merge remote-tracking branch 'refs/remotes/origin/develop' into feat/…

7f38e75

…2403-resolve-on-l2

Merge remote-tracking branch 'refs/remotes/origin/develop' into feat/…

572c18a

…2403-resolve-on-l2 # Conflicts: # app/_locales/en/messages.json

mirceanis force-pushed the feat/2403-resolve-on-l2 branch from e88bd56 to 572c18a Compare September 13, 2024 10:53

mirceanis added 4 commits September 13, 2024 12:58

style: fix linter error

becba2a

Signed-off-by: Mircea Nistor <mirceanis@gmail.com>

test: temporarily increase webdriver default timeout

606b389

Signed-off-by: Mircea Nistor <mirceanis@gmail.com>

test: revert webdriver default timeout

2fe6852

This reverts commit 606b389.

Merge remote-tracking branch 'refs/remotes/origin/develop' into feat/…

0afeb71

…2403-resolve-on-l2

mirceanis mentioned this pull request Sep 18, 2024

Support ENS resolution on any EVM compatible chain (including L2s) #18648

Closed

mirceanis added 2 commits September 18, 2024 12:02

Merge remote-tracking branch 'refs/remotes/origin/develop' into feat/…

7a75085

…2403-resolve-on-l2 # Conflicts: # lavamoat/browserify/beta/policy.json # lavamoat/browserify/flask/policy.json # lavamoat/browserify/main/policy.json # lavamoat/browserify/mmi/policy.json

chore: rebuild policies

2dcdfe4

Signed-off-by: Mircea Nistor <mirceanis@gmail.com>

mirceanis mentioned this pull request Sep 18, 2024

[ENHANCEMENT] Add support for ENS on Sepolia #22797

Closed

9 tasks

mirceanis added the team-identity label Sep 18, 2024

hmalik88 approved these changes Sep 18, 2024

View reviewed changes

mirceanis mentioned this pull request Sep 18, 2024

Feat/resolve on l2 cleanup #26571

Closed

7 tasks

matthewwalsh0 approved these changes Sep 18, 2024

View reviewed changes

jpuri approved these changes Sep 18, 2024

View reviewed changes

weizman approved these changes Sep 18, 2024

View reviewed changes

NidhiKJha approved these changes Sep 18, 2024

View reviewed changes

mirceanis merged commit 5e08c06 into develop Sep 18, 2024
89 checks passed

mirceanis deleted the feat/2403-resolve-on-l2 branch September 18, 2024 16:09

github-actions bot locked and limited conversation to collaborators Sep 18, 2024

metamaskbot added the release-12.6.0 Issue or pull request that will be included in release 12.6.0 label Sep 18, 2024

metamaskbot added release-12.5.0 Issue or pull request that will be included in release 12.5.0 and removed release-12.6.0 Issue or pull request that will be included in release 12.6.0 labels Sep 29, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: always use snaps to resolve domains; include preinstalled ENS resolver snap #26242

feat: always use snaps to resolve domains; include preinstalled ENS resolver snap #26242

mirceanis commented Jul 31, 2024 •

edited

Loading

github-actions bot commented Jul 31, 2024

socket-security bot commented Jul 31, 2024 •

edited

Loading

mirceanis commented Aug 1, 2024

codecov bot commented Aug 2, 2024 •

edited

Loading

mirceanis Aug 2, 2024

metamaskbot commented Aug 2, 2024

metamaskbot commented Aug 12, 2024

danjm commented Sep 17, 2024

metamaskbot commented Sep 17, 2024

metamaskbot commented Sep 17, 2024

sonarcloud bot commented Sep 18, 2024

metamaskbot commented Sep 18, 2024

hmalik88 left a comment

jpuri left a comment

weizman left a comment

feat: always use snaps to resolve domains; include preinstalled ENS resolver snap #26242

feat: always use snaps to resolve domains; include preinstalled ENS resolver snap #26242

Conversation

mirceanis commented Jul 31, 2024 • edited Loading

Description

Related issues

Manual testing steps

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

github-actions bot commented Jul 31, 2024

socket-security bot commented Jul 31, 2024 • edited Loading

Next steps

mirceanis commented Aug 1, 2024

codecov bot commented Aug 2, 2024 • edited Loading

Codecov Report

mirceanis Aug 2, 2024

Choose a reason for hiding this comment

metamaskbot commented Aug 2, 2024

metamaskbot commented Aug 12, 2024

danjm commented Sep 17, 2024

metamaskbot commented Sep 17, 2024

metamaskbot commented Sep 17, 2024

sonarcloud bot commented Sep 18, 2024

Quality Gate passed

metamaskbot commented Sep 18, 2024

hmalik88 left a comment

Choose a reason for hiding this comment

jpuri left a comment

Choose a reason for hiding this comment

weizman left a comment

Choose a reason for hiding this comment

mirceanis commented Jul 31, 2024 •

edited

Loading

socket-security bot commented Jul 31, 2024 •

edited

Loading

codecov bot commented Aug 2, 2024 •

edited

Loading