feat: Migrate eth_accounts and permittedChains to CAIP-25 endowment #27847

jiexi · 2024-10-14T19:51:23Z

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~~ two cases, 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: MetaMask/core#4784

Manual testing steps

There should be no user or dapp facing difference in behavior except:

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.
When calling wallet_getPermissions for a permitted dapp when the wallet is locked, eth_accounts should be returned in addition to endowment:permitted-chains. Currently there is a regression on main where only endowment:permitted-chains gets returned when the wallet is locked.

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": [],
});

Locked Wallet Behavior with dapp connected

Other than the one noted item below, this behavior matches that in main

eth_accounts returns []
wallet_getPermissions returns permissions incl eth_accounts
wallet_revokePermissions works as usual and revokes eth_accounts and revoke permitted-chains together
- Note this fixes a regression in main where eth_accounts and permitted-chains aren't revoked as a pair if either is revoked
eth_requestAccounts prompts for unlock, after unlock returns accounts if any are permitted, otherwise shows connection prompt
wallet_requestPermissions prompts for unlock
signature methods fails with method or accounts not authorized
non-signature methods work as usual
accountsChanged empty array on lock. no event after revokePermissions which makes sense since the dapp was told empty array on lock and now it's actually empty array so no changes have occurred as far as the dapp should be concerned.

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 · 2024-10-14T19:51:35Z

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-10-14T19:52:52Z

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

Package	New capabilities	Transitives	Size	Publisher
npm/@metamask/[email protected]	None	`0`	270 kB	metamaskbot
npm/@metamask/[email protected]	None	`0`	318 kB	metamaskbot
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], npm/@metamask/[email protected], npm/@open-rpc/[email protected]

View full report↗︎

socket-security · 2024-10-14T19:52:53Z

👍 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↗︎

jiexi · 2024-10-14T20:05:06Z

@metamask-bot update-policies

.yarn/patches/@json-schema-spec-json-pointer-npm-0.1.2-3d06119887.patch

.yarn/patches/@json-schema-tools-reference-resolver-npm-1.2.6-4e1497c16d.patch

jiexi · 2024-10-15T18:15:55Z

@metamaskbot update-policies

metamaskbot · 2024-10-15T18:27:48Z

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

app/scripts/metamask-controller.js

app/scripts/lib/rpc-method-middleware/handlers/ethereum-chain-utils.js

app/scripts/lib/rpc-method-middleware/handlers/wallet-requestPermissions.ts

app/scripts/lib/rpc-method-middleware/handlers/wallet-revokePermissions.ts

app/scripts/controllers/permissions/background-api.js

jiexi · 2024-10-15T20:30:34Z

@metamaskbot update-policies

metamaskbot · 2024-10-15T20:42:06Z

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

jiexi · 2024-10-15T21:11:10Z

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

i know that mcmire guy

jiexi · 2024-10-15T21:11:43Z

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

i still know that mcmire fellow

jiexi · 2024-10-15T21:14:05Z

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

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

jiexi · 2024-10-15T21:28:59Z

@metamaskbot update-policies

metamaskbot · 2024-10-15T21:40:14Z

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

# Conflicts: # ui/pages/permissions-connect/connect-page/connect-page.tsx

Gudahtt · 2025-01-08T22:35:28Z

app/scripts/lib/rpc-method-middleware/handlers/add-ethereum-chain.js

  },
 ) {
  let validParams;
  try {
-    validParams = validateAddEthereumChainParams(req.params[0], end);


Nit: Looks like we could remove the superfluous end parameter in a separate PR, it appears to be unused on main as well

PR against main here #29619

app/scripts/lib/rpc-method-middleware/handlers/add-ethereum-chain.test.js

Gudahtt · 2025-01-09T14:18:59Z

app/scripts/lib/rpc-method-middleware/handlers/request-accounts.ts

Great to see this converted to TypeScript, though perhaps we could do this in a separate PR as well, to reduce the impact of this one.

sure! 30b1773

Gudahtt · 2025-01-09T14:25:35Z

app/scripts/metamask-controller.js

   *
   * @param {string} origin - The origin whose exposed accounts to retrieve.
-   * @param {boolean} [suppressUnauthorizedError] - Suppresses the unauthorized error.
+   * @param {boolean} ignoreLock - If accounts should be returned even if the wallet is locked.


Perhaps we can use an options object here instead, so that this is a named parameter. When reading the request-accounts method middleware, I was unsure what getAccounts(true) meant.

app/scripts/lib/rpc-method-middleware/handlers/request-accounts.ts

app/scripts/lib/rpc-method-middleware/handlers/wallet-requestPermissions.ts

Gudahtt · 2025-01-09T15:27:35Z

app/scripts/lib/rpc-method-middleware/handlers/wallet-requestPermissions.ts

+  res.result = Object.values(grantedPermissions).filter(
+    (value) => value !== undefined,
+  ) as Json;


Nit: We can avoid type casting like this:

Suggested change

res.result = Object.values(grantedPermissions).filter(

(value) => value !== undefined,

) as Json;

res.result = Object.values(grantedPermissions).filter(

(

permission: ValidPermission<string, Caveat<string, Json>> | undefined,

): permission is ValidPermission<string, Caveat<string, Json>> =>

permission !== undefined,

);

A bit verbose, and still doesn't really validate that the return type matches the operation, but it does make a lot more clear what type transformation we're making here. And it preserves more type information.

Where do these undefined values come from anyway 🤔 I'm guessing it's because the controller considers it a valid possibility that the user would approve a set of zero permissions? But our UI doesn't allow that. Curious. Maybe we can find a way to update the type later to better reflect what it does.

I've never actually seen undefined at runtime. Types seem to suggest this is possible though, but the types might just be incorrect.

I took this change from Elliot's suggestion

#27847 (comment)

app/scripts/lib/rpc-method-middleware/handlers/wallet-revokePermissions.ts

Gudahtt · 2025-01-09T15:44:30Z

app/scripts/lib/rpc-method-middleware/handlers/wallet-revokePermissions.ts

+      ({ type }) => type === Caip25CaveatType,
+    )?.value as Caip25CaveatValue | undefined;
+
+    if (caip25CaveatValue?.isMultichainOrigin) {


Do we still need this? I'm not sure why we'd want to throw an error in this case. This is what I thought we were trying to avoid - introducing obstacles to simultaneous use of both APIs.

wallet_requestPermissions leave as is, that being the CAIP-25 permission is always replaced in it's entirety

wallet_add/switchEthereumChain switching, remove the isMultichainOrigin check

wallet_revokePermissions, remove the isMultichainOrigin check

Done here

8a3bc99

…rant (#29613)  ## **Description** Restores wallet_requestPermissions atomicity by delaying CAIP-25 grant until after other grants if they are requested [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/29613?quickstart=1) ## **Related issues** Fixes: ## **Manual testing steps** 1. Go to this page... 2. 3. ## **Screenshots/Recordings**  ### **Before**  ### **After**  ## **Pre-merge author checklist** - [ ] I've followed [MetaMask Contributor Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Extension Coding Standards](https://github.com/MetaMask/metamask-extension/blob/main/.github/guidelines/CODING_GUIDELINES.md). - [ ] 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](https://jsdoc.app/) format if applicable - [ ] I’ve applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-extension/blob/main/.github/guidelines/LABELING_GUIDELINES.md)). 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.

metamaskbot · 2025-01-09T20:00:57Z

Builds ready [368fccb]

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

Page Load Metrics (1753 ± 69 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	308	2205	1670	348	167
		domContentLoaded	1470	2086	1724	146	70
		load	1483	2092	1753	144	69
		domInteractive	26	195	51	41	20
		backgroundConnect	10	76	35	21	10
		firstReactRender	16	78	46	25	12
		getState	5	66	14	14	7
		initialActions	0	1	0	0	0
		loadScripts	1012	1573	1277	129	62
		setupStore	6	57	11	11	5
		uiStartup	1658	2356	1982	172	82

…o caip25-permission-migration

…rmissions.ts Co-authored-by: Mark Stacey <[email protected]>

…o caip25-permission-migration

…ePermissions

metamaskbot · 2025-01-09T23:39:56Z

Builds ready [30b1773]

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

Page Load Metrics (1694 ± 109 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1397	2253	1702	243	117
		domContentLoaded	1388	2163	1671	230	110
		load	1397	2183	1694	227	109
		domInteractive	20	74	40	18	9
		backgroundConnect	9	65	26	15	7
		firstReactRender	15	111	35	29	14
		getState	4	86	20	23	11
		initialActions	0	1	0	0	0
		loadScripts	995	1645	1263	181	87
		setupStore	6	70	21	22	11
		uiStartup	1571	2983	1975	395	190

## **Description** Removes tests that are no longer applicable pertaining to permitted chains. [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/29618?quickstart=1) ## **Related issues** See: #27847 (comment) ## **Manual testing steps** 1. Go to this page... 2. 3. ## **Screenshots/Recordings**  ### **Before**  ### **After**  ## **Pre-merge author checklist** - [ ] I've followed [MetaMask Contributor Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Extension Coding Standards](https://github.com/MetaMask/metamask-extension/blob/main/.github/guidelines/CODING_GUIDELINES.md). - [ ] 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](https://jsdoc.app/) format if applicable - [ ] I’ve applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-extension/blob/main/.github/guidelines/LABELING_GUIDELINES.md)). 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.

FrederikBolding · 2025-01-10T10:37:26Z

app/scripts/migrations/137.ts

+          `Migration ${version}: Invalid subject for origin "${origin}" of type ${typeof subject}`,
+        ),
+      );
+      return state;


Perhaps @Gudahtt can chime in here, but seems dangerous to bail out of the migration with a potentially partially modified state.

yeah hmmm should these be continue instead?

pushing a PR with suggested change

)  ## **Description** Removes unused `end` param in the ethereum-chain-util helpers * validateChainId * validateAddEthereumChainParams * validateSwitchEthereumChainParams [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/29619?quickstart=1) Extending E2E timeout to get past "no timings found" error: ``` flags = { "circleci": { "timeoutMinutes": 30 } } ``` ## **Related issues** See: #27847 (comment) ## **Manual testing steps** 1. Go to this page... 2. 3. ## **Screenshots/Recordings**  ### **Before**  ### **After**  ## **Pre-merge author checklist** - [ ] I've followed [MetaMask Contributor Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Extension Coding Standards](https://github.com/MetaMask/metamask-extension/blob/main/.github/guidelines/CODING_GUIDELINES.md). - [ ] 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](https://jsdoc.app/) format if applicable - [ ] I’ve applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-extension/blob/main/.github/guidelines/LABELING_GUIDELINES.md)). 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.

## **Description**  [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/29634?quickstart=1) ## **Related issues** Fixes: ## **Manual testing steps** 1. Go to this page... 2. 3. ## **Screenshots/Recordings**  ### **Before**  ### **After**  ## **Pre-merge author checklist** - [ ] I've followed [MetaMask Contributor Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Extension Coding Standards](https://github.com/MetaMask/metamask-extension/blob/main/.github/guidelines/CODING_GUIDELINES.md). - [ ] 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](https://jsdoc.app/) format if applicable - [ ] I’ve applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-extension/blob/main/.github/guidelines/LABELING_GUIDELINES.md)). 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.

…o caip25-permission-migration

metamaskbot · 2025-01-10T19:01:14Z

Builds ready [c1cbb26]

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

Page Load Metrics (1669 ± 56 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	436	2117	1612	293	141
		domContentLoaded	1532	2090	1642	119	57
		load	1561	2106	1669	117	56
		domInteractive	25	88	38	19	9
		backgroundConnect	10	64	30	18	9
		firstReactRender	16	75	40	24	11
		getState	5	44	11	8	4
		initialActions	0	1	0	0	0
		loadScripts	1121	1602	1223	103	49
		setupStore	6	13	8	2	1
		uiStartup	1760	2303	1873	112	54

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

background: 15.31 KiB (0.27%)
ui: 691 Bytes (0.01%)
common: 132.64 KiB (1.58%)

metamaskbot · 2025-01-10T20:01:46Z

Builds ready [70b9f05]

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

Page Load Metrics (1567 ± 38 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1480	1751	1567	79	38
		domContentLoaded	1471	1704	1549	72	34
		load	1480	1744	1567	79	38
		domInteractive	25	73	36	16	8
		backgroundConnect	7	57	18	14	7
		firstReactRender	15	101	52	36	17
		getState	5	71	14	18	9
		initialActions	0	1	0	0	0
		loadScripts	1033	1304	1132	72	35
		setupStore	6	72	18	21	10
		uiStartup	1682	2460	1916	206	99

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

background: 15.31 KiB (0.27%)
ui: 691 Bytes (0.01%)
common: 132.64 KiB (1.58%)

github-actions bot added the team-wallet-api-platform label Oct 14, 2024

shanejonas reviewed Oct 15, 2024

View reviewed changes

.yarn/patches/@json-schema-spec-json-pointer-npm-0.1.2-3d06119887.patch Show resolved Hide resolved

shanejonas reviewed Oct 15, 2024

View reviewed changes

.yarn/patches/@json-schema-tools-reference-resolver-npm-1.2.6-4e1497c16d.patch Show resolved Hide resolved

This was referenced Oct 15, 2024

feat: CAIP Multichain (OLD ignore. Only for reference now) #25665

Closed

feat: CAIP Multichain (New) #27782

Draft

jiexi mentioned this pull request Oct 15, 2024

feat: Add CAIP-25 permission and adapters to @metamask/multichain MetaMask/core#4784

Merged

4 tasks