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 two noted items 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.
CHANGED: for dapps that were granted chain permissions via the wallet_addEthereum or wallet_switchEthereumChain flows without account permissions, these permissions will be removed with this migration. We think this ok because:
- This is a very uncommon scenario for dapps to request chain switches without account permissions.
- These permissions can be regained very trivially with subsequent chain switch requests.

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

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

jiexi · 2024-10-16T21:14:21Z

@metamaskbot update-policies

metamaskbot · 2024-10-16T21:25:50Z

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/lib/rpc-method-middleware/handlers/wallet-revokePermissions.ts

sonarqubecloud · 2024-10-16T23:04:15Z

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

jiexi · 2024-10-17T15:55:28Z

@metamaskbot update-policies

metamaskbot · 2024-10-17T16:06:49Z

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

metamaskbot · 2025-01-15T18:00:49Z

Builds ready [29d2381]

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 (1566 ± 46 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1369	1741	1572	104	50
		domContentLoaded	1361	1694	1544	89	43
		load	1370	1703	1566	96	46
		domInteractive	19	89	37	19	9
		backgroundConnect	5	58	23	16	8
		firstReactRender	15	100	47	31	15
		getState	5	96	22	27	13
		initialActions	0	1	0	0	0
		loadScripts	984	1248	1136	86	41
		setupStore	6	80	19	22	11
		uiStartup	1556	2330	1892	225	108

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

background: 15.13 KiB (0.26%)
ui: 691 Bytes (0.01%)
common: 132.64 KiB (1.57%)

app/scripts/metamask-controller.js

app/scripts/migrations/138.ts

# Conflicts: # app/scripts/migrations/137.test.ts # app/scripts/migrations/137.ts # package.json

…o caip25-permission-migration

Co-authored-by: Mark Stacey <[email protected]>

…o caip25-permission-migration

ui/selectors/permissions.js

app/scripts/migrations/138.ts

metamaskbot · 2025-01-15T22:49:16Z

Builds ready [2f0a4e5]

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 (1637 ± 74 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	324	1961	1579	323	155
		domContentLoaded	1398	1951	1606	152	73
		load	1401	1960	1637	154	74
		domInteractive	19	164	42	32	16
		backgroundConnect	5	78	32	24	11
		firstReactRender	15	100	32	25	12
		getState	4	37	10	9	4
		initialActions	0	1	0	0	0
		loadScripts	1013	1560	1210	135	65
		setupStore	6	56	18	20	10
		uiStartup	1675	2255	1869	174	83

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

background: 16.22 KiB (0.28%)
ui: 691 Bytes (0.01%)
common: 132.64 KiB (1.57%)

app/scripts/migrations/138.test.ts

ui/ducks/bridge/selectors.ts

Gudahtt · 2025-01-15T22:57:24Z

ui/components/multichain/edit-accounts-modal/edit-accounts-modal.tsx

@@ -60,7 +60,7 @@ export const EditAccountsModal: React.FC<EditAccountsModalProps> = ({

  useEffect(() => {
    setSelectedAccountAddresses(defaultSelectedAccountAddresses);
-  }, [defaultSelectedAccountAddresses]);
+  }, [JSON.stringify(defaultSelectedAccountAddresses)]);


Why is this being stringified? Both here and in edit-networks-modal, I see the same change made in both places

this change can be moved into main. It's because this component can sometimes rerender while you're using it and your checkboxes get overwritten with the default selected again

Gudahtt · 2025-01-15T23:23:33Z

test/e2e/tests/account/snap-account-signatures-and-disconnects.spec.ts

Nit: I think this can be made separately against main as well

Gudahtt · 2025-01-15T23:34:07Z

test/e2e/tests/network/deprecated-networks.spec.js

Nit: The changes here and in switch-custom-network can probably be reverted (I think they were needed for the previous version of withPermissionControllerConnectedToTestDapp)

Gudahtt · 2025-01-15T23:36:53Z

test/e2e/json-rpc/wallet_requestPermissions.spec.ts

+          .sort();
+
+        assert.deepStrictEqual(grantedPermissionNames, [
+          'endowment:permitted-chains',


Recording something we discussed on a call: We should verify whether the order has changed here

Gudahtt · 2025-01-15T23:38:41Z

test/e2e/fixture-builder.js

-                    '0xbee150bdc171c7d4190891e78234f791a3ac7b24',
-                    '0xa5c5293e124d04e2f85e8553851001fd2f192647',
-                    '0xb9504634e5788208933b51ae7440b478bfadf865',
+                    'eip155:1337:0xbee150bdc171c7d4190891e78234f791a3ac7b24',


These prefixes don't need to be here, they're added by the migration

Gudahtt · 2025-01-15T23:38:59Z

test/e2e/fixture-builder.js

@@ -1257,16 +1252,16 @@ class FixtureBuilder {
                },
              ],
              date: 1708029792962,
+              id: 'oKXoF_MNlffiR2u1Y3mDE',


Nit: Maybe we can revert these re-order changes to minimize the diff

Gudahtt · 2025-01-15T23:39:40Z

test/e2e/fixture-builder.js

@@ -657,6 +643,11 @@ class FixtureBuilder {
          lastSelected: 1665507800000,
          name: 'Account 2',
        },
+        [ERC_4337_ACCOUNT]: {


Curious why this was added

Gudahtt · 2025-01-15T23:43:57Z

test/e2e/tests/account/snap-account-signatures.spec.ts

          await new TestDapp(driver).openTestDappPage();
+
+          await driver.findClickableElement({ text: 'Connect', tag: 'button' });


Nit: I see that the changes here are different than the prior file, despite the changes being similar in nature. The previous file uses connectAccount on the test dapp instance rather than running these connect steps one by one. Worth considering which approach we prefer, if they are indeed equivalent.

…o caip25-permission-migration

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

jiexi commented Oct 15, 2024

View reviewed changes

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

jiexi commented Oct 15, 2024

View reviewed changes

app/scripts/lib/rpc-method-middleware/handlers/ethereum-chain-utils.js Outdated Show resolved Hide resolved

jiexi commented Oct 15, 2024

View reviewed changes

app/scripts/lib/rpc-method-middleware/handlers/wallet-requestPermissions.ts Outdated Show resolved Hide resolved

jiexi commented Oct 15, 2024

View reviewed changes

app/scripts/lib/rpc-method-middleware/handlers/wallet-revokePermissions.ts Outdated Show resolved Hide resolved

jiexi commented Oct 15, 2024

View reviewed changes

app/scripts/controllers/permissions/background-api.js Outdated Show resolved Hide resolved

jiexi commented Oct 16, 2024

View reviewed changes

app/scripts/lib/rpc-method-middleware/handlers/wallet-revokePermissions.ts Outdated Show resolved Hide resolved

lint

29d2381

Gudahtt reviewed Jan 15, 2025

View reviewed changes

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

Gudahtt reviewed Jan 15, 2025

View reviewed changes

jiexi and others added 16 commits January 15, 2025 10:44

Merge branch 'main' into caip25-permission-migration

236b2d4

# Conflicts: # app/scripts/migrations/137.test.ts # app/scripts/migrations/137.ts # package.json

jsdoc captureKeyringTypesWithMissingIdentities

9d73bd9

Merge remote-tracking branch 'origin/caip25-permission-migration' int…

89ed1b3

…o caip25-permission-migration

jsdoc sortAccountsByLastSelected

eb67f19

Merge branch 'main' into caip25-permission-migration

c86e052

Update app/scripts/migrations/138.ts

ea4294a

Co-authored-by: Mark Stacey <[email protected]>

Update app/scripts/migrations/138.ts

fdeb41e

Co-authored-by: Mark Stacey <[email protected]>

Update app/scripts/migrations/138.ts

28094b5

Co-authored-by: Mark Stacey <[email protected]>

add comment/link for BUILT_IN_NETWORKS

ab87b63

address feedback / cleanup migration

9cdf8b7

bail out of migration when encountering any data malformation

43a0749

make malformation checks against networkConfigurations more strict

134f730

Merge branch 'main' into caip25-permission-migration

27b7353

Merge remote-tracking branch 'origin/caip25-permission-migration' int…

8bdde06

…o caip25-permission-migration

lint

b2581f4

Trigger

6a6b1bf

Gudahtt reviewed Jan 15, 2025

View reviewed changes

ui/selectors/permissions.js Show resolved Hide resolved

jiexi added 2 commits January 15, 2025 14:04

add isNonEmptyArrayOfStrings to migration

b213d94

Merge branch 'main' into caip25-permission-migration

2f0a4e5

Gudahtt reviewed Jan 15, 2025

View reviewed changes

app/scripts/migrations/138.ts Show resolved Hide resolved

Gudahtt reviewed Jan 15, 2025

View reviewed changes

Update test/e2e/tests/request-queuing/ui.spec.js

0de03cc

Gudahtt reviewed Jan 15, 2025

View reviewed changes

jiexi added 2 commits January 15, 2025 15:52

Revert ui/ducks/bridge/selectors.ts

9233f06

Merge remote-tracking branch 'origin/caip25-permission-migration' int…

dcdee7f

…o caip25-permission-migration

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

jiexi commented Oct 14, 2024 •

edited by adonesky1

Loading

github-actions bot commented Oct 14, 2024

socket-security bot commented Oct 14, 2024 •

edited

Loading

socket-security bot commented Oct 14, 2024 •

edited

Loading

jiexi commented Oct 14, 2024

jiexi commented Oct 15, 2024

metamaskbot commented Oct 15, 2024

jiexi commented Oct 15, 2024

metamaskbot commented Oct 15, 2024

jiexi commented Oct 15, 2024

jiexi commented Oct 15, 2024

jiexi commented Oct 15, 2024

jiexi commented Oct 15, 2024

metamaskbot commented Oct 15, 2024

jiexi commented Oct 16, 2024

metamaskbot commented Oct 16, 2024

sonarqubecloud bot commented Oct 16, 2024

jiexi commented Oct 17, 2024

metamaskbot commented Oct 17, 2024

metamaskbot commented Jan 15, 2025

metamaskbot commented Jan 15, 2025

Gudahtt Jan 15, 2025

jiexi Jan 15, 2025

Gudahtt Jan 15, 2025

Gudahtt Jan 15, 2025

Gudahtt Jan 15, 2025

Gudahtt Jan 15, 2025

Gudahtt Jan 15, 2025

Gudahtt Jan 15, 2025

Gudahtt Jan 15, 2025

		await new TestDapp(driver).openTestDappPage();

		await driver.findClickableElement({ text: 'Connect', tag: 'button' });

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

Are you sure you want to change the base?

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

Conversation

jiexi commented Oct 14, 2024 • edited by adonesky1 Loading

Description

Related issues

Manual testing steps

Locked Wallet Behavior with dapp connected

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

github-actions bot commented Oct 14, 2024

socket-security bot commented Oct 14, 2024 • edited Loading

socket-security bot commented Oct 14, 2024 • edited Loading

jiexi commented Oct 14, 2024

jiexi commented Oct 15, 2024

metamaskbot commented Oct 15, 2024

jiexi commented Oct 15, 2024

metamaskbot commented Oct 15, 2024

jiexi commented Oct 15, 2024

jiexi commented Oct 15, 2024

jiexi commented Oct 15, 2024

jiexi commented Oct 15, 2024

metamaskbot commented Oct 15, 2024

jiexi commented Oct 16, 2024

metamaskbot commented Oct 16, 2024

sonarqubecloud bot commented Oct 16, 2024

Quality Gate passed

jiexi commented Oct 17, 2024

metamaskbot commented Oct 17, 2024

metamaskbot commented Jan 15, 2025

metamaskbot commented Jan 15, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jiexi commented Oct 14, 2024 •

edited by adonesky1

Loading

socket-security bot commented Oct 14, 2024 •

edited

Loading

socket-security bot commented Oct 14, 2024 •

edited

Loading