refactor: connection Flow to use CAIP25 Permission format #29824

ffmcgee725 · 2025-01-21T12:34:49Z

Description

Related issues

Fixes:

Manual testing steps

Send the following request

await window.ethereum.request({
 "method": "wallet_requestPermissions",
 "params": [
  {
    
    "eth_accounts": {
        "caveats": [
            {
                "type": "restrictReturnedAccounts",
                "value": []
            }
        ]
    },
    "endowment:permitted-chains": {
        "caveats": [
            {
                "type": "restrictNetworkSwitching",
                "value": []
            }
        ]
    }
  }
],
});

Wallet extension UI should prompt user to give permissions to accounts / chains and edit if desired or confirm to proceed.

Screenshots/Recordings

Screen.Recording.2025-01-23.at.17.18.17.mov

NOTE: Don't mind different screens in the UI, this vid is outdated and all UI screens are same as main branch

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.

ui/pages/permissions-connect/connect-page/connect-page.tsx

ui/components/multichain/pages/review-permissions-page/site-cell/site-cell.tsx

ui/pages/permissions-connect/connect-page/connect-page.tsx

…r (wip)

…n request is cancelled

…ons implementation to be fully caip25 compliant

ui/pages/permissions-connect/connect-page/utils.ts

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

jiexi · 2025-01-24T18:30:07Z

ui/components/app/permission-page-container/permission-page-container.component.js

@@ -47,6 +53,7 @@ export default class PermissionPageContainer extends Component {
    }),
    history: PropTypes.object.isRequired,
    connectPath: PropTypes.string.isRequired,
+    defaultAccount: PropTypes.string,


sorry, nit. This should be isRequired. There should always be a value we can use for this

resolved in 8d5968e

jiexi · 2025-01-24T18:30:24Z

ui/components/app/permission-page-container/permission-page-container.component.js

@@ -55,6 +62,7 @@ export default class PermissionPageContainer extends Component {
    selectedAccounts: [],
    allAccountsSelected: false,
    currentPermissions: {},
+    defaultAccount: '',


can get rid of this default given the defaultAccount value must be provided

resolved in 8d5968e

…tainer

adonesky1 · 2025-01-24T19:48:26Z

ui/pages/permissions-connect/connect-page/utils.ts

+ * @param hexChainIds - The list of permitted chains.
+ * @returns The granted permissions with the target name of the {@link Caip25EndowmentPermissionName}.
+ */
+export function parseCaip25PermissionsResponse(


[nit] - I think parse maybe is a confusing word for this.

maybe just keep it pretty generic/straightforward:

Suggested change

export function parseCaip25PermissionsResponse(

export function getApprovedSessionsScopes(

resolved in ecad6ee

…sionsResponse'

github-actions · 2025-01-24T19:59:53Z

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.

adonesky1

LGTM

…hain.spec.js

…allet_switchEthereumNetwork

…ding wallet_switchEthereumChain request

metamaskbot · 2025-01-26T01:51:00Z

Builds ready [ae0bdb4]

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

Page Load Metrics (1747 ± 70 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1541	2120	1744	145	69
		domContentLoaded	1531	2063	1717	136	65
		load	1543	2118	1747	145	70
		domInteractive	24	206	44	39	19
		backgroundConnect	9	87	27	21	10
		firstReactRender	17	168	48	37	18
		getState	5	61	20	21	10
		initialActions	0	1	0	0	0
		loadScripts	1100	1531	1271	113	54
		setupStore	8	61	17	17	8
		uiStartup	1713	2481	2034	207	99

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

background: 490 Bytes (0.01%)
ui: 1.24 KiB (0.02%)
common: -409 Bytes (-0.00%)

metamaskbot · 2025-01-26T02:31:14Z

Builds ready [bfccd6e]

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

Page Load Metrics (1666 ± 78 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	466	2063	1607	309	148
		domContentLoaded	1486	2003	1643	156	75
		load	1497	2057	1666	163	78
		domInteractive	24	87	35	15	7
		backgroundConnect	8	56	28	18	9
		firstReactRender	15	98	47	27	13
		getState	4	53	12	13	6
		initialActions	0	1	0	0	0
		loadScripts	1057	1494	1190	137	66
		setupStore	7	52	12	9	4
		uiStartup	1693	2329	1906	185	89

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

background: 490 Bytes (0.01%)
ui: 1.13 KiB (0.01%)
common: -259 Bytes (-0.00%)

ffmcgee725 requested a review from a team January 21, 2025 12:34

metamaskbot added the team-wallet-api-platform label Jan 21, 2025

ffmcgee725 commented Jan 21, 2025

View reviewed changes

ui/pages/permissions-connect/connect-page/connect-page.tsx Outdated Show resolved Hide resolved

ffmcgee725 commented Jan 21, 2025

View reviewed changes

ui/components/multichain/pages/review-permissions-page/site-cell/site-cell.tsx Outdated Show resolved Hide resolved

ffmcgee725 commented Jan 21, 2025

View reviewed changes

ui/pages/permissions-connect/connect-page/connect-page.tsx Outdated Show resolved Hide resolved

ffmcgee725 commented Jan 21, 2025

View reviewed changes

ui/pages/permissions-connect/connect-page/connect-page.tsx Outdated Show resolved Hide resolved

ffmcgee725 added 2 commits January 21, 2025 18:43

refactor: send transformed caip25 compliant data to ApprovalControlle…

0ce5acc

…r (wip)

fix: fix payload sent to UI after Jiexi sesh

4c7d343

adonesky1 added the sip26 label Jan 22, 2025

ffmcgee725 added 11 commits January 22, 2025 20:39

refactor: send transformed caip25 compliant data to ApprovalController

9b84b2b

fix: handle common edge case with empty caveats

8b48878

docs: document utility UI functions for caip25 connection flow

f3209cd

test: unit test for UI utility functions

f793fee

Merge branch 'main' into jc/caip25-permission-refactor-main

3c2ea45

lint

7c919bc

test: fix metamask controller caip25 unit tests

c88ffae

fix: address 'undefined' request object in connect-page component whe…

b244570

…n request is cancelled

docs: minor update

49814b8

refactor: address 'background-api.js' requestAccountsAndChainPermissi…

cea8fa8

…ons implementation to be fully caip25 compliant

Merge branch 'main' into jc/caip25-permission-refactor-main

f771a58

ffmcgee725 changed the base branch from jl/caip-multichain-migrate-core to main January 23, 2025 16:13

ffmcgee725 force-pushed the jc/caip25-permission-refactor branch from 5218ea4 to f771a58 Compare January 23, 2025 16:13

ffmcgee725 changed the title ~~Refactor Connection Flow to use CAIP25 Permission format~~ Refactor: Connection Flow to use CAIP25 Permission format Jan 23, 2025

ffmcgee725 changed the title ~~Refactor: Connection Flow to use CAIP25 Permission format~~ refactor: Connection Flow to use CAIP25 Permission format Jan 23, 2025

ffmcgee725 changed the title ~~refactor: Connection Flow to use CAIP25 Permission format~~ refactor: connection Flow to use CAIP25 Permission format Jan 23, 2025

ffmcgee725 commented Jan 23, 2025

View reviewed changes

ui/pages/permissions-connect/connect-page/utils.ts Outdated Show resolved Hide resolved

ffmcgee725 added 4 commits January 23, 2025 17:28

docs: remove outdated comments

5040491

fix: fix UI reroute

d885ecf

docs: task for future

a93dbdb

Merge branch 'main' into jc/caip25-permission-refactor

9e11d21

jiexi reviewed Jan 24, 2025

View reviewed changes

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

test: minor test refactor

22b8227

jiexi reviewed Jan 24, 2025

View reviewed changes

refactor: all redux state passed to container for permission page con…

8d5968e

…tainer

ffmcgee725 requested review from jiexi and adonesky1 January 24, 2025 19:20

adonesky1 reviewed Jan 24, 2025

View reviewed changes

refactor: rename 'parseCaip25PermissionsResponse' to 'getCaip25Permis…

ecad6ee

…sionsResponse'

jiexi previously approved these changes Jan 24, 2025

View reviewed changes

ffmcgee725 dismissed jiexi’s stale review via ecad6ee January 24, 2025 19:52

jiexi previously approved these changes Jan 24, 2025

View reviewed changes

ffmcgee725 requested a review from adonesky1 January 24, 2025 19:54

Merge branch 'main' into jc/caip25-permission-refactor

262d8f7

adonesky1 previously approved these changes Jan 24, 2025

View reviewed changes

fix: fix issues raised by e2e tests (wip)

e49c99f

ffmcgee725 dismissed stale reviews from adonesky1 and jiexi via e49c99f January 25, 2025 01:33

ffmcgee725 added 6 commits January 25, 2025 04:07

docs: document findings for failing test/e2e/json-rpc/switchEthereumC…

6e57d3c

…hain.spec.js

docs: document problem continuation

1de4c5e

fix: possible solution for permission.js file (wip)

7bb7dad

fix: fix UI bug for properly rendering chain instead of accounts on w…

5e3fd1f

…allet_switchEthereumNetwork

fix: consistently fetch pendingPermissionsFromOrigin to check for pen…

ae0bdb4

…ding wallet_switchEthereumChain request

Merge branch 'main' into jc/caip25-permission-refactor

a1620d4

refactor: code clean up

bfccd6e

ffmcgee725 requested review from adonesky1 and jiexi January 26, 2025 02:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: connection Flow to use CAIP25 Permission format #29824

refactor: connection Flow to use CAIP25 Permission format #29824

ffmcgee725 commented Jan 21, 2025 •

edited

Loading

jiexi Jan 24, 2025

ffmcgee725 Jan 24, 2025 •

edited

Loading

jiexi Jan 24, 2025

ffmcgee725 Jan 24, 2025

adonesky1 Jan 24, 2025

ffmcgee725 Jan 24, 2025

github-actions bot commented Jan 24, 2025

adonesky1 left a comment

metamaskbot commented Jan 26, 2025

metamaskbot commented Jan 26, 2025

	export function parseCaip25PermissionsResponse(
	export function getApprovedSessionsScopes(

refactor: connection Flow to use CAIP25 Permission format #29824

Are you sure you want to change the base?

refactor: connection Flow to use CAIP25 Permission format #29824

Conversation

ffmcgee725 commented Jan 21, 2025 • edited Loading

Description

Related issues

Manual testing steps

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

jiexi Jan 24, 2025

Choose a reason for hiding this comment

ffmcgee725 Jan 24, 2025 • edited Loading

Choose a reason for hiding this comment

jiexi Jan 24, 2025

Choose a reason for hiding this comment

ffmcgee725 Jan 24, 2025

Choose a reason for hiding this comment

adonesky1 Jan 24, 2025

Choose a reason for hiding this comment

ffmcgee725 Jan 24, 2025

Choose a reason for hiding this comment

github-actions bot commented Jan 24, 2025

adonesky1 left a comment

Choose a reason for hiding this comment

metamaskbot commented Jan 26, 2025

metamaskbot commented Jan 26, 2025

ffmcgee725 commented Jan 21, 2025 •

edited

Loading

ffmcgee725 Jan 24, 2025 •

edited

Loading