feat: added AccountWatcher as preinstalled snap and added to menu list #26402

k-g-j · 2024-08-13T21:13:29Z

Description

This PR adds a new button in the Add Account Menu to direct users to the Account Watcher Homepage. The new feature is hidden behind an Experimental Feature toggle that is off by default for a stealthy launch.

Key changes include:

Added a new menu item in the Add Account Menu for watching Ethereum accounts.
Implemented an Experimental Feature toggle for "Watch Ethereum Accounts (Beta)".
Added metric tracking for the toggle state.
Ensured the toggle is disabled by default.

Note: flow and code changes based on support creation of Bitcoin testnet accounts

Related issues

Fixes: https://github.com/MetaMask/accounts-planning/issues/468#issue-2331781414

Manual testing steps

Go to Settings > Experimental
Locate the "Watch Ethereum Accounts (Beta)" toggle
Enable the toggle
Navigate to the Add Account Menu
Verify that the new "Watch Ethereum account (Beta)" option is visible
Click on the new option and confirm it redirects to the Account Watcher Homepage
Watch an Ethereum account or ENS (mainnet)
Navigate back to Account Watcher Homepage and press the back arrow in the modal header. It should redirect you to the default wallet page.
Disable the toggle in Settings > Experimental
Verify that the "Watch Ethereum Account" option is no longer visible in the Add Account Menu

Screenshots/Recordings

Screen.Recording.2024-08-15.at.12.15.12.PM.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-08-13T21:13: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.

socket-security · 2024-08-13T21:15:10Z

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

Package	New capabilities	Transitives	Size	Publisher
npm/@metamask/account-watcher@4.1.0	network	`0`	993 kB	metamaskbot
npm/@noble/curves@1.4.2	None	`0`	1.5 MB	paulmillr
npm/@scure/base@1.1.7	None	`0`	122 kB	paulmillr
npm/@scure/bip32@1.4.0	None	`0`	58.7 kB	paulmillr
npm/@scure/bip39@1.3.0	None	`0`	374 kB	paulmillr
npm/ethereum-cryptography@2.2.1	None	`0`	83.7 kB	paulmillr

🚮 Removed packages: npm/@noble/curves@1.3.0, npm/@scure/base@1.1.6, npm/@scure/bip32@1.3.3, npm/@scure/bip39@1.2.2, npm/ethereum-cryptography@2.1.3

View full report↗︎

socket-security · 2024-08-13T21:15:13Z

👍 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/account-watcher@4.1.0

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

…s toggle

k-g-j · 2024-08-13T21:37:38Z

@SocketSecurity ignore npm/@metamask/account-watcher@4.0.2

codecov · 2024-08-13T22:48:02Z

Codecov Report

Attention: Patch coverage is 44.00000% with 14 lines in your changes missing coverage. Please review.

Project coverage is 69.95%. Comparing base (81af2e8) to head (0efea14).

Files	Patch %	Lines
...multichain/account-list-menu/account-list-menu.tsx	55.56%	4 Missing ⚠️
ui/store/actions.ts	0.00%	4 Missing ⚠️
...gs/experimental-tab/experimental-tab.component.tsx	57.14%	3 Missing ⚠️
app/scripts/controllers/preferences.js	0.00%	2 Missing ⚠️
...ngs/experimental-tab/experimental-tab.container.ts	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop   #26402      +/-   ##
===========================================
- Coverage    69.96%   69.95%   -0.01%     
===========================================
  Files         1405     1405              
  Lines        48996    49019      +23     
  Branches     13697    13700       +3     
===========================================
+ Hits         34280    34289       +9     
- Misses       14716    14730      +14

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

metamaskbot · 2024-08-13T23:00:57Z

Builds ready [9efcdff]

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 (150 ± 211 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	62	232	85	36	17
		domContentLoaded	8	71	18	17	8
		load	38	2068	150	440	211
		domInteractive	8	71	18	17	8

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

background: 435 Bytes (0.01%)
ui: 2.46 KiB (0.03%)
common: 470.04 KiB (6.67%)

metamaskbot · 2024-08-14T14:03:42Z

Builds ready [03a01d9]

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 (415 ± 326 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	70	378	115	70	33
		domContentLoaded	9	89	21	17	8
		load	39	1802	415	679	326
		domInteractive	9	89	20	17	8

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

background: 435 Bytes (0.01%)
ui: 2.46 KiB (0.03%)
common: 470.04 KiB (6.67%)

metamaskbot · 2024-08-14T14:43:01Z

Builds ready [b14b0b0]

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 (765 ± 577 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	74	380	139	62	30
		domContentLoaded	9	78	27	20	9
		load	47	3313	765	1202	577
		domInteractive	9	78	26	20	9

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

background: 435 Bytes (0.01%)
ui: 2.46 KiB (0.03%)
common: 470.04 KiB (6.67%)

metamaskbot · 2024-08-14T16:57:22Z

Builds ready [5789263]

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 (153 ± 189 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	79	200	102	27	13
		domContentLoaded	10	55	20	13	6
		load	45	1863	153	393	189
		domInteractive	10	55	20	13	6

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

background: 435 Bytes (0.01%)
ui: 2.46 KiB (0.03%)
common: 470.04 KiB (6.67%)

k-g-j · 2024-08-14T22:25:10Z

@SocketSecurity ignore npm/@metamask/account-watcher@4.0.3

metamaskbot · 2024-08-14T22:38:44Z

Builds ready [e08a9b1]

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 (206 ± 222 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	77	297	135	60	29
		domContentLoaded	9	84	32	21	10
		load	55	2216	206	463	222
		domInteractive	9	84	32	21	10

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

background: 435 Bytes (0.01%)
ui: 2.46 KiB (0.03%)
common: 470.05 KiB (6.67%)

k-g-j · 2024-08-16T17:14:49Z

@SocketSecurity ignore npm/@metamask/account-watcher@4.1.0

This reverts commit 96f81e7.

k-g-j · 2024-08-19T17:35:15Z

@metamaskbot update-policies

metamaskbot · 2024-08-19T17:46:24Z

Policies updated

sonarcloud · 2024-08-19T17:48:56Z

Quality Gate passed

Issues
0 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

metamaskbot · 2024-08-19T18:32:20Z

Builds ready [0efea14]

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 (82 ± 13 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	70	167	108	29	14
		domContentLoaded	38	139	77	31	15
		load	45	140	82	28	13
		domInteractive	9	62	29	15	7

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

background: 28.56 KiB (0.86%)
ui: 2.58 KiB (0.04%)
common: 350.3 KiB (4.46%)

owencraston

Retested with the prod builds and everything looks good to me. Good work!

Screen.Recording.2024-08-19.at.2.58.10.PM.mov

Screen.Recording.2024-08-19.at.3.02.06.PM.1080.mov

jpuri

Changes in code owned by confirmations team look good 👍

feat: added AccountWatcher as preinstalled snap and added to menu list

51a5320

metamaskbot added the team-accounts label Aug 13, 2024

feat: put 'Watch Ethereum account (Beta)' behind experimental setting…

9293af3

…s toggle

k-g-j added area-snaps area-accounts Relating to how sensitive account data is managed and stored. labels Aug 13, 2024

k-g-j marked this pull request as ready for review August 13, 2024 21:36

k-g-j requested review from a team as code owners August 13, 2024 21:36

Merge branch 'develop' into feat/add-account-watcher-snap

0497284

k-g-j and others added 3 commits August 13, 2024 17:42

feat: renamed metric to 'WatchEthereumAccountsToggled'

6169fe0

Merge branch 'develop' into feat/add-account-watcher-snap

9aca5a6

fix: setupSentry state

9efcdff

Merge branch 'develop' into feat/add-account-watcher-snap

03a01d9

k-g-j and others added 2 commits August 14, 2024 10:07

feat: updated copy and changed to eye icon

64c5b1c

Merge branch 'develop' into feat/add-account-watcher-snap

b14b0b0

k-g-j added 2 commits August 14, 2024 12:04

Merge branch 'develop' into feat/add-account-watcher-snap

d0aab2f

Merge branch 'develop' into feat/add-account-watcher-snap

5789263

feat: updated account-watcher to 4.0.3

e08a9b1

k-g-j and others added 4 commits August 16, 2024 09:50

Merge branch 'develop' into feat/add-account-watcher-snap

38961fd

Merge branch 'develop' into feat/add-account-watcher-snap

e6c625e

Merge branch 'develop' into feat/add-account-watcher-snap

3296f93

feat: updated account-watcher to 4.1.0 with hidden flag

35c1736

k-g-j and others added 3 commits August 19, 2024 10:46

Merge branch 'develop' into feat/add-account-watcher-snap

db054fd

Merge branch 'develop' into feat/add-account-watcher-snap

9674570

chore: update lavamoat

1bd6ac0

k-g-j requested a review from a team as a code owner August 19, 2024 15:18

k-g-j and others added 6 commits August 19, 2024 11:44

Merge branch 'develop' into feat/add-account-watcher-snap

6051869

feat: updated lavamoat policy to match develop

bacdef4

fix: yarn.lock

e647d43

fix: yarn dedupe

43479d3

feat: updated lavamoat policies

96f81e7

Revert "feat: updated lavamoat policies"

9f79954

This reverts commit 96f81e7.

Update LavaMoat policies

0efea14

owencraston approved these changes Aug 19, 2024

View reviewed changes

jpuri approved these changes Aug 20, 2024

View reviewed changes

matthewwalsh0 approved these changes Aug 20, 2024

View reviewed changes

FrederikBolding approved these changes Aug 20, 2024

View reviewed changes

k-g-j merged commit f6fc55e into develop Aug 20, 2024
78 checks passed

k-g-j deleted the feat/add-account-watcher-snap branch August 20, 2024 19:56

github-actions bot locked and limited conversation to collaborators Aug 20, 2024

metamaskbot added the release-12.5.0 Issue or pull request that will be included in release 12.5.0 label Aug 20, 2024

gauthierpetetin added release-12.4.0 Issue or pull request that will be included in release 12.4.0 and removed release-12.5.0 Issue or pull request that will be included in release 12.5.0 labels Sep 11, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: added AccountWatcher as preinstalled snap and added to menu list #26402

feat: added AccountWatcher as preinstalled snap and added to menu list #26402

k-g-j commented Aug 13, 2024 •

edited

Loading

github-actions bot commented Aug 13, 2024

socket-security bot commented Aug 13, 2024 •

edited

Loading

socket-security bot commented Aug 13, 2024 •

edited

Loading

k-g-j commented Aug 13, 2024

codecov bot commented Aug 13, 2024 •

edited

Loading

metamaskbot commented Aug 13, 2024

metamaskbot commented Aug 14, 2024

metamaskbot commented Aug 14, 2024

metamaskbot commented Aug 14, 2024

k-g-j commented Aug 14, 2024

metamaskbot commented Aug 14, 2024

k-g-j commented Aug 16, 2024

k-g-j commented Aug 19, 2024

metamaskbot commented Aug 19, 2024

sonarcloud bot commented Aug 19, 2024

metamaskbot commented Aug 19, 2024

owencraston left a comment •

edited

Loading

jpuri left a comment

feat: added AccountWatcher as preinstalled snap and added to menu list #26402

feat: added AccountWatcher as preinstalled snap and added to menu list #26402

Conversation

k-g-j commented Aug 13, 2024 • edited Loading

Description

Related issues

Manual testing steps

Screenshots/Recordings

Pre-merge author checklist

Pre-merge reviewer checklist

github-actions bot commented Aug 13, 2024

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

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

Next steps

k-g-j commented Aug 13, 2024

codecov bot commented Aug 13, 2024 • edited Loading

Codecov Report

metamaskbot commented Aug 13, 2024

metamaskbot commented Aug 14, 2024

metamaskbot commented Aug 14, 2024

metamaskbot commented Aug 14, 2024

k-g-j commented Aug 14, 2024

metamaskbot commented Aug 14, 2024

k-g-j commented Aug 16, 2024

k-g-j commented Aug 19, 2024

metamaskbot commented Aug 19, 2024

sonarcloud bot commented Aug 19, 2024

Quality Gate passed

metamaskbot commented Aug 19, 2024

owencraston left a comment • edited Loading

Choose a reason for hiding this comment

jpuri left a comment

Choose a reason for hiding this comment

k-g-j commented Aug 13, 2024 •

edited

Loading

socket-security bot commented Aug 13, 2024 •

edited

Loading

socket-security bot commented Aug 13, 2024 •

edited

Loading

codecov bot commented Aug 13, 2024 •

edited

Loading

owencraston left a comment •

edited

Loading