fix: erc20 token balances showing 0

[bergeron]

Description

Fixes an issue where erc20 token balances were incorrectly showing 0. On the repro we have, we noticed a token in state with address 0x0000000000000000000000000000000000000000 on mainnet, which is not a valid erc20 token. This caused the multicall to revert, preventing other balances from updating.

There's a fix in the controller here: MetaMask/core#5083 which will fall back to parallel balanceOf calls if the multicall reverts.

And we're also doing a migration here to remove zero address tokens on mainnet.

Related issues

Manual testing steps

The current version of the wallet should not allow importing an invalid erc20 address through any mechanism, so not easy to reproduce naturally.

The migration can be tested by checking out an older version like git checkout v12.9.0 , upgrading to this branch, verifying the migration ran in background logs, and that your tokens remain.

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.

[github-actions]

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.

[bergeron]

@metamaskbot update-policies

[metamaskbot]

No policy changes

[metamaskbot]

Builds ready [5f01845]

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

Page Load Metrics (1806 ± 57 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	300	2122	1731	351	168
		domContentLoaded	1582	2101	1775	127	61
		load	1630	2123	1806	118	57
		domInteractive	26	91	41	18	9
		backgroundConnect	9	88	34	21	10
		firstReactRender	18	77	39	22	10
		getState	5	53	12	10	5
		initialActions	0	1	0	0	0
		loadScripts	1129	1589	1317	114	55
		setupStore	6	62	17	18	9
		uiStartup	1826	2423	2056	141	68