fix: always use remote token list for default petnames by matthewwalsh0 · Pull Request #23919 · MetaMask/metamask-extension

matthewwalsh0 · 2024-04-09T19:50:06Z

Description

Petnames (and by extension transaction simulations) rely on the token list to display default token names and symbols.

With the Autodetect tokens preference disabled, static data for ~600 tokens is available on mainnet and no token data is available on other chains. When enabled, data for ~4000 tokens is available on mainnet.

In order to provide the most default token names possible, this PR forces the use of the remote token list for petnames, and therefore enables token list polling if any of the following preferences are enabled:

Autodetect tokens (Token Detection)
Allow nicknames (Petnames)
Estimate balance changes (Transaction Simulations)

To ensure the necessary privacy control, the Allow nicknames toggle has also been added to the onboarding settings.

At the technical level, this includes:

Removing all TokenListController logic from the PreferencesController to keep it decoupled from individual domain.
Adding an equivalent listener in the MetamaskController.
Adding an optional forceRemote argument to the getTokenList selector.
Using the above argument in the useDisplayName hook.
Updating impacted unit and E2E tests.

Related issues

Fixes: #2339

Manual testing steps

Remote Token List

Disable Autodetect tokens.
Disable Estimate balance changes.
Enable Allow nicknames.
Add Optimism network.
Switch to Optimism network.
Go to test dApp.
Use send form to create transaction targeting Tether USD (0x94b008aa00579c1307b0ef2c499ad98a8ce58e58).
Verify the default token name is displayed in the petnames component.
Repeat with permutations of the three preferences and network.

Onboarding Setting

Install fresh extension.
Go to onboarding settings.
Disable Allow nicknames.
Verify nicknames are disabled in experimental settings.

Screenshots/Recordings

Before

After

Pre-merge author checklist

I’ve followed MetaMask 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.

Use remote token list if petnames enabled.

Use token list polling if simulations enabled.

metamaskbot · 2024-04-09T21:02:56Z

Builds ready [cf3fce5]

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

Page Load Metrics (1045 ± 514 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	70	336	117	61	29
		domContentLoaded	10	96	29	19	9
		load	58	2370	1045	1071	514
		domInteractive	10	96	29	19	9

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

background: 709 Bytes (0.02%)
ui: 28 Bytes (0.00%)
common: 0 Bytes (0.00%)

codecov · 2024-04-10T09:19:09Z

Codecov Report

Attention: Patch coverage is 76.36364% with 13 lines in your changes are missing coverage. Please review.

Project coverage is 67.52%. Comparing base (6bd3de7) to head (f9da548).

Files	Patch %	Lines
ui/selectors/selectors.js	35.71%	9 Missing ⚠️
app/scripts/metamask-controller.js	89.19%	4 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop   #23919      +/-   ##
===========================================
+ Coverage    67.47%   67.52%   +0.05%     
===========================================
  Files         1244     1244              
  Lines        48777    48830      +53     
  Branches     12724    12741      +17     
===========================================
+ Hits         32910    32972      +62     
+ Misses       15867    15858       -9

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

metamaskbot · 2024-04-10T09:22:07Z

Builds ready [58e1387]

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

Page Load Metrics (766 ± 451 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	66	210	104	34	16
		domContentLoaded	9	55	23	11	5
		load	53	2165	766	940	451
		domInteractive	9	55	23	11	5

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

background: 709 Bytes (0.02%)
ui: 3 Bytes (0.00%)
common: 25 Bytes (0.00%)

app/scripts/metamask-controller.js

sleepytanya · 2024-04-10T19:22:10Z

Token names are displayed when any of the following toggles enabled and not visible when all three toggles are off:

Autodetect tokens (Security and Privacy)
Allow nicknames (Experimental)
Estimate balance changes (Security and Privacy)

tokenNames.mov

metamaskbot · 2024-04-11T09:38:34Z

Builds ready [94bab65]

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

Page Load Metrics (886 ± 469 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	56	198	125	36	17
		domContentLoaded	8	69	27	14	7
		load	45	2328	886	976	469
		domInteractive	8	69	27	14	7

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

background: 709 Bytes (0.02%)
ui: 239 Bytes (0.00%)
common: 25 Bytes (0.00%)

metamaskbot · 2024-04-11T12:47:14Z

Builds ready [f9da548]

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

Page Load Metrics (893 ± 527 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	71	154	105	23	11
		domContentLoaded	10	62	24	12	6
		load	59	2531	893	1098	527
		domInteractive	10	62	24	12	6

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

background: 709 Bytes (0.02%)
ui: 239 Bytes (0.00%)
common: 25 Bytes (0.00%)

sleepytanya · 2024-04-11T15:21:29Z

New toggle in the onboarding settings:

Chrome

onboardingToggle.mov

Firefox

onboardingFF.mov

matthewwalsh0 added 7 commits April 8, 2024 20:24

Hide totals if simulation successful

7883bf3

Use remote token list if petnames enabled.

Remove logging

d62f0a0

Fix unit tests

ebac2cb

Fix E2E test

eb9d4c8

Update transaction controller version

94ff761

Use token list polling if simulations enabled.

Add unit tests

c7e6ce5

Revert hide total changes

afc45be

matthewwalsh0 added the team-confirmations-system-deprecated DEPRECATED: please use "team-confirmations" instead label Apr 9, 2024

Revert unnecessary changes

cf3fce5

matthewwalsh0 marked this pull request as ready for review April 9, 2024 21:20

matthewwalsh0 requested a review from a team as a code owner April 9, 2024 21:20

matthewwalsh0 added 2 commits April 9, 2024 22:20

Merge branch 'develop' into fix/petnames-force-remote-token-list

45a2b7e

Merge branch 'develop' into fix/petnames-force-remote-token-list

58e1387

Merge branch 'develop' into fix/petnames-force-remote-token-list

cd1c547

cryptotavares reviewed Apr 10, 2024

View reviewed changes

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

cryptotavares previously approved these changes Apr 10, 2024

View reviewed changes

vinistevam previously approved these changes Apr 10, 2024

View reviewed changes

sleepytanya added the QA Passed label Apr 10, 2024

Add petnames toggle to onboarding settings

374da8f

matthewwalsh0 dismissed stale reviews from vinistevam and cryptotavares via 374da8f April 10, 2024 19:48

matthewwalsh0 added 3 commits April 10, 2024 21:08

Fix onboarding settings

7338bd6

Fix unit tests

3a04920

Merge branch 'develop' into fix/petnames-force-remote-token-list

94bab65

Merge branch 'develop' into fix/petnames-force-remote-token-list

f9da548

vinistevam approved these changes Apr 11, 2024

View reviewed changes

cryptotavares approved these changes Apr 11, 2024

View reviewed changes

matthewwalsh0 merged commit 324b55b into develop Apr 11, 2024

matthewwalsh0 deleted the fix/petnames-force-remote-token-list branch April 11, 2024 15:46

github-actions bot locked and limited conversation to collaborators Apr 11, 2024

metamaskbot added the release-11.15.0 Issue or pull request that will be included in release 11.15.0 label Apr 11, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: always use remote token list for default petnames#23919

fix: always use remote token list for default petnames#23919
matthewwalsh0 merged 16 commits intodevelopfrom
fix/petnames-force-remote-token-list

matthewwalsh0 commented Apr 9, 2024 •

edited

Loading

Uh oh!

metamaskbot commented Apr 9, 2024

Uh oh!

codecov bot commented Apr 10, 2024 •

edited

Loading

Uh oh!

metamaskbot commented Apr 10, 2024

Uh oh!

Uh oh!

sleepytanya commented Apr 10, 2024 •

edited

Loading

Uh oh!

metamaskbot commented Apr 11, 2024

Uh oh!

metamaskbot commented Apr 11, 2024

Uh oh!

sleepytanya commented Apr 11, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

matthewwalsh0 commented Apr 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related issues

Manual testing steps

Remote Token List

Onboarding Setting

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

Uh oh!

metamaskbot commented Apr 9, 2024

Uh oh!

codecov bot commented Apr 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

metamaskbot commented Apr 10, 2024

Uh oh!

Uh oh!

sleepytanya commented Apr 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

metamaskbot commented Apr 11, 2024

Uh oh!

metamaskbot commented Apr 11, 2024

Uh oh!

sleepytanya commented Apr 11, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

matthewwalsh0 commented Apr 9, 2024 •

edited

Loading

codecov bot commented Apr 10, 2024 •

edited

Loading

sleepytanya commented Apr 10, 2024 •

edited

Loading