metamask-extension feat: Migrate eth_accounts and permittedChains to CAIP-25 endowment

Description

This PR replaces the replaces the internal eth_accounts and endowment:permittedChains permission structure with a CAIP-25 endowment. It adds adapter logic to translate to and from the new internal CAIP-25 permissions. This change should be transparent to wallet users and to dapps except for one case, see below. This change is required in order to support CAIP-25 and CAIP-27 requests in a follow-up PR that enables the Multichain API.

Related issues

Related: https://github.com/MetaMask/core/pull/4784

Manual testing steps

There should be no user or dapp facing difference in behavior except in wallet_revokePermissions, see below.

When calling wallet_revokePermissions and specifying either eth_accounts or endowment:permitted-chains, the entire CAIP-25 permission will be revoked. It will appear to the dapp as if both eth_accounts and endowment:permitted-chains were revoked.

await window.ethereum.request({
 "method": "wallet_revokePermissions",
 "params": [
  {
    eth_accounts: {}
  }
],
});

await window.ethereum.request({
 "method": "wallet_revokePermissions",
 "params": [
  {
    'endowment:permitted-chains': {}
  }
],
});

await window.ethereum.request({
 "method": "wallet_getPermissions",
 "params": [],
});

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.

Oct 14 '24 19:10 jiexi

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.

Oct 14 '24 19:10 github-actions[bot]

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

Package	New capabilities	Transitives	Size	Publisher
npm/@metamask/[email protected] 🔁 npm/@metamask/[email protected]	None	`0`	270 kB	metamaskbot
npm/@metamask/[email protected]	None	`0`	318 kB	metamaskbot
npm/@open-rpc/[email protected] 🔁 npm/@open-rpc/[email protected]	None	`0`	38.4 kB	belfordz

🚮 Removed packages: npm/@json-schema-spec/[email protected], npm/@json-schema-tools/[email protected]

View full report↗︎

Oct 14 '24 19:10 socket-security[bot]

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

View full report↗︎

Oct 14 '24 19:10 socket-security[bot]

@metamask-bot update-policies

Oct 14 '24 20:10 jiexi

@metamaskbot update-policies

Oct 15 '24 18:10 jiexi

Policies updated.
👀 Please review the diff for suspicious new powers.

🧠 Learn how: https://lavamoat.github.io/guides/policy-diff/#what-to-look-for-when-reviewing-a-policy-diff

Oct 15 '24 18:10 metamaskbot

@metamaskbot update-policies

Oct 15 '24 20:10 jiexi

Policies updated.
👀 Please review the diff for suspicious new powers.

🧠 Learn how: https://lavamoat.github.io/guides/policy-diff/#what-to-look-for-when-reviewing-a-policy-diff

Oct 15 '24 20:10 metamaskbot

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

i know that mcmire guy

Oct 15 '24 21:10 jiexi

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

i still know that mcmire fellow

Oct 15 '24 21:10 jiexi

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

the fetch isn't new, but even then it's fine because it fetches caller supplied url

Oct 15 '24 21:10 jiexi

@metamaskbot update-policies

Oct 15 '24 21:10 jiexi

Policies updated.
👀 Please review the diff for suspicious new powers.

🧠 Learn how: https://lavamoat.github.io/guides/policy-diff/#what-to-look-for-when-reviewing-a-policy-diff

Oct 15 '24 21:10 metamaskbot

@metamaskbot update-policies

Oct 16 '24 21:10 jiexi

Policies updated.
👀 Please review the diff for suspicious new powers.

🧠 Learn how: https://lavamoat.github.io/guides/policy-diff/#what-to-look-for-when-reviewing-a-policy-diff

Oct 16 '24 21:10 metamaskbot

Quality Gate passed

Issues
15 New issues
0 Accepted issues

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

See analysis details on SonarCloud

Oct 16 '24 23:10 sonarqubecloud[bot]

@metamaskbot update-policies

Oct 17 '24 15:10 jiexi

Policies updated.
👀 Please review the diff for suspicious new powers.

🧠 Learn how: https://lavamoat.github.io/guides/policy-diff/#what-to-look-for-when-reviewing-a-policy-diff

Oct 17 '24 16:10 metamaskbot

@metamaskbot update-policies

Oct 17 '24 20:10 adonesky1

Policies updated.
👀 Please review the diff for suspicious new powers.

🧠 Learn how: https://lavamoat.github.io/guides/policy-diff/#what-to-look-for-when-reviewing-a-policy-diff

Oct 17 '24 20:10 metamaskbot

@metamaskbot update-policies

Oct 17 '24 21:10 jiexi

Policies updated.
👀 Please review the diff for suspicious new powers.

🧠 Learn how: https://lavamoat.github.io/guides/policy-diff/#what-to-look-for-when-reviewing-a-policy-diff

Oct 17 '24 21:10 metamaskbot

@metamaskbot update-policies

Oct 18 '24 14:10 adonesky1

Policies updated.
👀 Please review the diff for suspicious new powers.

🧠 Learn how: https://lavamoat.github.io/guides/policy-diff/#what-to-look-for-when-reviewing-a-policy-diff

Oct 18 '24 14:10 metamaskbot

@metamaskbot update-policies

Oct 21 '24 18:10 jiexi

Policies updated.
👀 Please review the diff for suspicious new powers.

🧠 Learn how: https://lavamoat.github.io/guides/policy-diff/#what-to-look-for-when-reviewing-a-policy-diff

Oct 21 '24 18:10 metamaskbot

Builds ready [25bfb4f]

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

Page Load Metrics (1840 ± 119 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	353	2589	1673	465	223
		domContentLoaded	1595	2318	1793	186	89
		load	1605	2709	1840	248	119
		domInteractive	16	125	57	26	13
		backgroundConnect	8	293	43	63	30
		firstReactRender	48	206	92	48	23
		getState	5	196	33	43	21
		initialActions	0	0	0	0	0
		loadScripts	1139	1753	1342	147	71
		setupStore	11	163	35	36	17
		uiStartup	1768	3708	2105	406	195

Bundle size diffs [🚀 Bundle size reduced!]

background: -25.19 KiB (-0.50%)
ui: 593 Bytes (0.01%)
common: -120.86 KiB (-1.53%)

Oct 21 '24 21:10 metamaskbot

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

author is known. access is acceptable

Oct 22 '24 23:10 jiexi

Builds ready [7f70c0b]

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

Page Load Metrics (2111 ± 140 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1675	2746	2110	296	142
		domContentLoaded	1661	2675	2074	282	135
		load	1676	2766	2111	291	140
		domInteractive	21	109	53	22	11
		backgroundConnect	9	92	35	25	12
		firstReactRender	47	289	105	56	27
		getState	4	68	28	23	11
		initialActions	0	1	0	0	0
		loadScripts	1210	2028	1522	241	116
		setupStore	11	86	34	24	12
		uiStartup	1855	3373	2364	369	177

Bundle size diffs [🚀 Bundle size reduced!]

background: -25.19 KiB (-0.57%)
ui: 593 Bytes (0.01%)
common: -120.86 KiB (-1.53%)

Oct 22 '24 23:10 metamaskbot

@metamaskbot update-policies

Oct 23 '24 17:10 jiexi

metamask-extension metamask-extension copied to clipboard

feat: Migrate eth_accounts and permittedChains to CAIP-25 endowment

Description

Related issues

Manual testing steps

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

Quality Gate passed

metamask-extension
metamask-extension copied to clipboard