refactor: Add MultichainRouter to new controller instantiation pattern #31951

jiexi · 2025-04-14T20:26:51Z

Description

Cleans up the MultichainRouter instantiation by moving it int othe new controller instantiation pattern.

Related issues

See: https://github.com/orgs/MetaMask/projects/146/views/6?pane=issue&itemId=105350449&issue=MetaMask%7CMetaMask-planning%7C4599

Manual testing steps

No user facing changes

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.

…new-pattern

github-actions · 2025-04-14T20:27:05Z

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.

app/scripts/multichain-router-messenger.ts

app/scripts/controller-init/messengers/multichain/multichain-router-messenger.ts

adonesky1 · 2025-04-14T21:24:47Z

app/scripts/controller-init/multichain/multichain-router-init.ts

+    messenger: controllerMessenger,
+    // Binding the call to provide the selector only giving the controller the option to pass the operation
+    withSnapKeyring: (...args) =>
+      // @ts-expect-error mistmatch with the withSnapKeyring signature and withKeyring.


Is there an issue tracking this mismatch we can link?

i don't think we need an issue tracking this specifically. Frederik is aware that this hook needs to be called from the messenger inside the MultichainRouter implementation which will allow us to remove it here and resolves the type issue

metamaskbot · 2025-04-15T14:51:37Z

Builds ready [bed7cd6]

builds: chrome, firefox
builds (flask): chrome, firefox
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
bundle size: Bundle Size Stats
user-actions-benchmark: User Actions Stats
storybook: Storybook
typescript migration: Dashboard
all CircleCI 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, 14
- ui: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
- content-script: 0
- offscreen: 0

UI Startup Metrics (1191 ± 62 ms)

Platform	BuildType	Page	Metric	Mean (ms)	Min (ms)	Max (ms)	Std Dev (ms)	P 75 (ms)	P 95 (ms)
Chrome	Browserify	Home	uiStartup	1191	1074	1407	62	1220	1314
			load	1032	944	1213	54	1061	1159
			domContentLoaded	1026	941	1205	53	1054	1150
			domInteractive	17	13	63	9	16	29
			firstPaint	701	130	1213	401	1029	1103
			backgroundConnect	7	4	16	2	7	10
			firstReactRender	21	16	44	6	21	34
			getState	13	5	65	9	17	28
			initialActions	0	0	1	0	0	1
			loadScripts	787	714	951	51	818	916
			setupStore	7	5	18	2	7	13
	Webpack	Home	uiStartup	2118	1729	2550	160	2207	2343
			load	1622	1266	1994	129	1709	1796
			domContentLoaded	1614	1261	1983	129	1703	1792
			domInteractive	15	11	44	7	13	39
			firstPaint	184	75	480	69	203	334
			backgroundConnect	28	9	356	36	26	58
			firstReactRender	221	55	390	123	345	369
			getState	13	4	194	20	14	27
			initialActions	6	1	279	28	3	5
			loadScripts	1609	1258	1959	128	1700	1791
			setupStore	17	6	44	8	19	34
Firefox	Browserify	Home	uiStartup	1345	1166	1665	102	1410	1558
			load	1201	1047	1525	105	1255	1417
			domContentLoaded	1201	1047	1525	105	1255	1417
			domInteractive	102	39	239	32	112	152
			firstPaint	NaN	NaN	NaN	NaN	NaN	NaN
			backgroundConnect	20	13	121	13	20	38
			firstReactRender	22	19	32	3	23	28
			getState	7	3	20	2	7	10
			initialActions	0	0	1	0	0	1
			loadScripts	1182	1023	1509	106	1241	1400
			setupStore	6	4	35	4	6	8
	Webpack	Home	uiStartup	1497	1332	1970	129	1573	1787
			load	1281	1136	1710	119	1336	1521
			domContentLoaded	1281	1136	1710	119	1336	1521
			domInteractive	80	43	239	27	90	136
			firstPaint	NaN	NaN	NaN	NaN	NaN	NaN
			backgroundConnect	22	14	73	8	23	41
			firstReactRender	35	29	56	5	37	44
			getState	10	5	59	8	8	30
			initialActions	1	0	2	1	1	1
			loadScripts	1262	1120	1692	119	1320	1494
			setupStore	9	5	41	6	8	25

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

background: 1.46 KiB (0.03%)
ui: 2 Bytes (0%)
common: -1 Bytes (0%)

adonesky1

LGTM

…new-pattern

metamaskbot · 2025-04-17T21:05:17Z

Builds ready [3aa4834]

builds: chrome, firefox
builds (beta): chrome
builds (flask): chrome, firefox
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
bundle size: Bundle Size Stats
user-actions-benchmark: User Actions Stats
storybook: Storybook
typescript migration: Dashboard
all CircleCI 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, 14
- ui: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
- content-script: 0
- offscreen: 0

UI Startup Metrics (1221 ± 67 ms)

Platform	BuildType	Page	Metric	Mean (ms)	Min (ms)	Max (ms)	Std Dev (ms)	P 75 (ms)	P 95 (ms)
Chrome	Browserify	Home	uiStartup	1221	1099	1407	67	1271	1341
			load	1055	947	1266	63	1099	1168
			domContentLoaded	1050	944	1260	63	1094	1163
			domInteractive	18	13	63	7	17	29
			firstPaint	738	70	1268	414	1062	1163
			backgroundConnect	7	4	22	3	8	12
			firstReactRender	21	14	63	6	22	34
			getState	14	5	45	9	20	33
			initialActions	0	0	1	0	0	1
			loadScripts	810	709	1003	61	843	924
			setupStore	8	5	18	2	8	12
	Webpack	Home	uiStartup	2174	1801	2706	160	2268	2439
			load	1688	1391	2041	120	1784	1854
			domContentLoaded	1681	1387	2031	120	1775	1850
			domInteractive	16	11	56	10	14	48
			firstPaint	187	78	418	65	228	319
			backgroundConnect	32	10	366	49	31	64
			firstReactRender	206	58	386	121	330	362
			getState	15	4	182	19	15	35
			initialActions	3	1	8	1	4	6
			loadScripts	1677	1385	2007	120	1772	1848
			setupStore	23	6	293	39	22	43
Firefox	Browserify	Home	uiStartup	1377	1204	1731	112	1441	1585
			load	1226	1039	1564	112	1299	1429
			domContentLoaded	1225	1039	1563	112	1299	1429
			domInteractive	104	37	235	31	119	172
			firstPaint	NaN	NaN	NaN	NaN	NaN	NaN
			backgroundConnect	25	13	199	23	22	74
			firstReactRender	24	19	52	5	24	33
			getState	8	4	57	6	8	11
			initialActions	0	0	2	0	0	1
			loadScripts	1203	1024	1469	110	1285	1402
			setupStore	7	4	45	6	6	22
	Webpack	Home	uiStartup	1565	1365	2050	148	1620	1943
			load	1338	1181	1793	132	1383	1680
			domContentLoaded	1338	1181	1792	132	1383	1679
			domInteractive	86	37	257	30	94	130
			firstPaint	NaN	NaN	NaN	NaN	NaN	NaN
			backgroundConnect	23	14	66	9	23	46
			firstReactRender	37	30	56	5	39	47
			getState	9	4	62	7	9	29
			initialActions	1	0	4	1	1	1
			loadScripts	1318	1167	1775	131	1365	1644
			setupStore	9	5	30	4	9	21

cc: @HowardBraham
Benchmark value 33 exceeds gate value 31 for chrome browserify home p95 getState
Benchmark value 187 exceeds gate value 175 for chrome webpack home mean firstPaint
Benchmark value 319 exceeds gate value 310 for chrome webpack home p95 firstPaint
Benchmark value 74 exceeds gate value 70 for firefox browserify home p95 backgroundConnect
Benchmark value 1943 exceeds gate value 1935 for firefox webpack home p95 uiStartup
Benchmark value 1680 exceeds gate value 1660 for firefox webpack home p95 load
Benchmark value 1679 exceeds gate value 1660 for firefox webpack home p95 domContentLoaded
Benchmark value 46 exceeds gate value 45 for firefox webpack home p95 backgroundConnect
Benchmark value 1644 exceeds gate value 1630 for firefox webpack home p95 loadScripts
Sum of mean exceeds: 12ms | Sum of p95 exceeds: 77ms
Sum of all benchmark exceeds: 89ms

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

background: 1.46 KiB (0.03%)
ui: 5 Bytes (0%)
common: 11 Bytes (0%)

FrederikBolding · 2025-04-22T08:44:34Z

app/scripts/controller-init/multichain/multichain-router-init.ts

+  const controller = new MultichainRouter({
+    messenger: controllerMessenger,
+    // Binding the call to provide the selector only giving the controller the option to pass the operation
+    withSnapKeyring: (...args) =>


We will need to rethink this as we had to make a change to this function to unblock the release.

jiexi added 5 commits April 10, 2025 15:30

WIP

b6f44f4

use init messenger

4c0b3f9

Merge branch 'main' into jl/refactor-multichain-router-instantiation-…

9a02d74

…new-pattern

add init messenger

1ad185f

use init helper

a8fc501

metamaskbot added the team-wallet-api-platform label Apr 14, 2025

adonesky1 reviewed Apr 14, 2025

View reviewed changes

app/scripts/multichain-router-messenger.ts Outdated Show resolved Hide resolved

adonesky1 reviewed Apr 14, 2025

View reviewed changes

app/scripts/controller-init/messengers/multichain/multichain-router-messenger.ts Outdated Show resolved Hide resolved

adonesky1 reviewed Apr 14, 2025

View reviewed changes

app/scripts/controller-init/messengers/multichain/multichain-router-messenger.ts Outdated Show resolved Hide resolved

adonesky1 reviewed Apr 14, 2025

View reviewed changes

jiexi added 3 commits April 14, 2025 14:56

address comments

f8b1c3f

add missing spec and const

05624a6

add null entries for state in init

bed7cd6

jiexi added this to PR review queue Apr 15, 2025

github-project-automation bot moved this to Needs dev review in PR review queue Apr 15, 2025

adonesky1 approved these changes Apr 16, 2025

View reviewed changes

Merge branch 'main' into jl/refactor-multichain-router-instantiation-…

3aa4834

…new-pattern

jiexi added the no-changelog no-changelog Indicates no external facing user changes, therefore no changelog documentation needed label Apr 17, 2025

FrederikBolding reviewed Apr 22, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

refactor: Add MultichainRouter to new controller instantiation pattern #31951

refactor: Add MultichainRouter to new controller instantiation pattern #31951

jiexi commented Apr 14, 2025 •

edited by github-actions bot

Loading

Uh oh!

github-actions bot commented Apr 14, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

adonesky1 Apr 14, 2025

Uh oh!

jiexi Apr 14, 2025

Uh oh!

metamaskbot commented Apr 15, 2025

Uh oh!

adonesky1 left a comment

Uh oh!

metamaskbot commented Apr 17, 2025

Uh oh!

FrederikBolding Apr 22, 2025

Uh oh!

Uh oh!

refactor: Add MultichainRouter to new controller instantiation pattern #31951

Are you sure you want to change the base?

refactor: Add MultichainRouter to new controller instantiation pattern #31951

Conversation

jiexi commented Apr 14, 2025 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related issues

Manual testing steps

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

Uh oh!

github-actions bot commented Apr 14, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

adonesky1 Apr 14, 2025

Choose a reason for hiding this comment

Uh oh!

jiexi Apr 14, 2025

Choose a reason for hiding this comment

Uh oh!

metamaskbot commented Apr 15, 2025

Uh oh!

adonesky1 left a comment

Choose a reason for hiding this comment

Uh oh!

metamaskbot commented Apr 17, 2025

Uh oh!

FrederikBolding Apr 22, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jiexi commented Apr 14, 2025 •

edited by github-actions bot

Loading