feat: Add Multichain API to Flask #27782

jiexi · 2024-10-10T22:50:25Z

Description

This branch adds support for the Multichain API to the Flask build of the Extension.

The existing API (via injected provider) should be completely unchanged.

(Very Briefly) What is the MetaMask Multichain API

Concurrent connection to any number of chains (no network switching)
Unified entry point for all chain ecosystems (EVM, BTC, Solana, Cosmos, Polkadot etc)
Accessible (on extension for chromium based browsers) via externally_connectable. Not accessible via an injected global like window.ethereum

Key Documents/Standards

mip = MetaMask Improvement Proposal

MIP-5 (Overview of the Multichain API)
- CAIP-25 (new connection request API)
- CAIP-27 (new request API, envelope with target scope/chainId included)
MIP-6 (Overview of how the Multichain API’s EVM support diverges from the 1193 injected provider)

Manual testing steps

yarn start:flask

Then

(RECOMMENDED) Use the Multichain Test Dapp

Video Demo for Interacting w/ Multichain Test Dapp

OR

Form requests manually

Pre-merge author checklist

I’ve followed MetaMask 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-10T22:50:37Z

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.

jiexi · 2024-10-14T16:08:58Z

@metamaskbot update-policies

metamaskbot · 2024-10-14T16:20:15Z

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

socket-security · 2024-10-14T17:46:27Z

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

shanejonas · 2024-10-15T15:20:41Z

this PR needs the patches from here: https://github.com/MetaMask/metamask-extension/pull/27847/files#r1801195961

jiexi · 2024-10-15T16:21:43Z

~~REMINDER: check the original feature branch PR for unresolved comments~~

.circleci/config.yml

html-report-caip27/index.html

app/scripts/lib/rpc-method-middleware/handlers/wallet-createSession/handler.js

app/scripts/metamask-controller.test.js

shared/modules/caip-stream.test.ts

test/e2e/api-specs/transform.ts

jiexi · 2024-10-15T23:06:22Z

~~TODO: Convert BARAD_DUR flag into flask feature flag~~

Done here #29003

## **Description**  [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/27940?quickstart=1) ## **Related issues** Fixes: #27782 (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/develop/.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/develop/.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.

jiexi · 2024-10-17T21:13:22Z

@metamaskbot update-policies

metamaskbot · 2024-10-17T21:24:42Z

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

metamaskbot · 2024-10-17T21:36:10Z

❌ Multichain API Spec Test Failed. View the report here.

socket-security · 2024-10-17T23:04:28Z

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

Package	New capabilities	Transitives	Size	Publisher
npm/@metamask/[email protected]	None	`0`	1.69 MB	metamaskbot
npm/@open-rpc/[email protected] ➜ 2.2.4	Transitive: environment, eval	`+5`	1.33 MB	belfordz

🚮 Removed packages: npm/[email protected]

View full report↗︎

metamaskbot · 2024-10-17T23:15:49Z

❌ Multichain API Spec Test Failed. View the report here.

…iddleware

metamaskbot · 2025-03-07T20:11:17Z

Builds ready [63f0ba4]

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, 8
- 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
- content-script: 0
- offscreen: 0

Page Load Metrics (1797 ± 138 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1535	2784	1787	251	121
		domContentLoaded	1491	2543	1732	206	99
		load	1536	2951	1797	288	138
		domInteractive	24	54	29	6	3
		backgroundConnect	11	399	66	84	40
		firstReactRender	14	108	35	25	12
		getState	5	158	33	37	18
		initialActions	0	1	0	0	0
		loadScripts	1120	1953	1319	163	78
		setupStore	7	62	17	15	7
		uiStartup	1733	4486	2144	586	281

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

background: 6.39 KiB (0.10%)
ui: 0 Bytes (0.00%)
common: 1.98 KiB (0.02%)

metamaskbot · 2025-03-07T21:03:23Z

Builds ready [c700391]

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, 8
- 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
- content-script: 0
- offscreen: 0

Page Load Metrics (1978 ± 109 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1732	2492	1960	193	93
		domContentLoaded	1696	2238	1879	140	67
		load	1735	2679	1978	227	109
		domInteractive	17	102	44	21	10
		backgroundConnect	13	422	97	99	47
		firstReactRender	15	107	41	27	13
		getState	6	344	58	76	36
		initialActions	0	1	0	0	0
		loadScripts	1241	1694	1426	104	50
		setupStore	8	116	21	26	13
		uiStartup	1902	4222	2410	565	271

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

background: 6.39 KiB (0.10%)
ui: 0 Bytes (0.00%)
common: 1.98 KiB (0.02%)

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

…questPermissions` instead of `ApprovalController.addAndShowApprovalRequest` (#30908)  ## **Description** We created a merger for the `Caip25Permission` specification in order to enable `wallet_addEthereumChain` and `wallet_switchEthereumChain` to call to the `PermissionController` rather than the `ApprovalController` for incremental permission requests (i.e. for the permittedChains flow). PRs implementing these changes core: MetaMask/core#5283 extension: #30042 We also changed `eth_requestAccounts` and `wallet_requestPermissions` handlers to call the `PermissionController`, but we should now do the change to `wallet_createSession` handler as well and address [this feedback on the Flask Multichain PR](#27782) (at the moment this is only available on the [Flask Multichain PR](#27782))  [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/30908?quickstart=1) ## **Related issues** Fixes: ## **Manual testing steps** ``` yarn start:flask ``` Then **(RECOMMENDED)** Use the [Multichain Test Dapp](https://metamask.github.io/test-dapp-multichain/latest/) - [Video Demo for Interacting w/ Multichain Test Dapp](https://drive.google.com/file/d/113iM80dZItEAGkobJkBh17h68Y5dgTS-/view) **OR** [Form requests manually](https://docs.google.com/document/d/1uq7N8Pt5ZrBQiPa0QFoGYGCnvDeTwhNK3ilOqUGX9JQ/edit?usp=sharing) ## **Screenshots/Recordings**  ### **Before**  ### **After**  ## **Pre-merge author checklist** - [x] 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). - [x] I've completed the PR template to the best of my ability - [x] I’ve included tests if applicable - [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format if applicable - [x] 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** - [x] I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed). - [x] 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-03-11T19:34:21Z

Builds ready [45ea711]

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, 8
- 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
- content-script: 0
- offscreen: 0

Page Load Metrics (1869 ± 106 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1604	2581	1855	211	101
		domContentLoaded	1580	2181	1765	126	60
		load	1604	2609	1869	220	106
		domInteractive	24	84	36	18	9
		backgroundConnect	11	756	108	166	79
		firstReactRender	15	92	40	25	12
		getState	5	103	31	31	15
		initialActions	0	1	0	0	0
		loadScripts	1189	1620	1343	95	46
		setupStore	7	61	21	17	8
		uiStartup	1805	3616	2291	502	241

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

background: 6.29 KiB (0.10%)
ui: 0 Bytes (0.00%)
common: 1.98 KiB (0.02%)

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

jiexi mentioned this pull request Oct 10, 2024

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

Merged

4 tasks

jiexi changed the base branch from caip-multichain to caip25-permission-migration October 15, 2024 16:18

jiexi changed the title ~~Multichain: migrate to core package~~ feat: CAIP Multichain Oct 15, 2024

jiexi mentioned this pull request Oct 15, 2024

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

Closed

7 tasks

jiexi changed the title ~~feat: CAIP Multichain~~ feat: CAIP Multichain (New) Oct 15, 2024