feat: Implement the publishBatch hook for smart transactions #31267

dan437 · 2025-03-25T10:51:25Z

Description

This PR implements the publishBatch hook for smart transactions, which will be used when submitting multiple transactions at once, e.g. when a user choose their gas token for a transaction.

We can test this end to end once UI for the Transaction Confirmation page is merged. Then we might need to do some final tweaks if needed.

Related issues

Fixes:

Manual testing steps

Once the UI on the Transaction Confirmation page is ready (e.g. when you do a Send transaction), you will be able to choose a gas token to be used for transaction fees

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 · 2025-03-25T10:51:43Z

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/lib/transaction/smart-transactions.ts

metamaskbot · 2025-03-25T11:28:21Z

Builds ready [23830c0]

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 (2344 ± 239 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1562	2996	2158	385	185
		domContentLoaded	1535	2877	1968	331	159
		load	1567	3233	2344	497	239
		domInteractive	26	107	46	25	12
		backgroundConnect	34	1272	406	284	136
		firstReactRender	39	697	124	136	65
		getState	23	795	225	200	96
		initialActions	0	1	0	0	0
		loadScripts	1126	1797	1372	184	88
		setupStore	9	299	124	100	48
		uiStartup	1746	26662	5802	5225	2509

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

background: 2.23 KiB (0.03%)
ui: 0 Bytes (0.00%)
common: 0 Bytes (0.00%)

app/scripts/controller-init/confirmations/transaction-controller-init.ts

metamaskbot · 2025-03-25T14:21:23Z

Builds ready [47992dd]

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 (3313 ± 1472 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1602	16225	3049	3055	1467
		domContentLoaded	1535	15819	2771	3019	1450
		load	1610	16502	3313	3065	1472
		domInteractive	25	198	54	46	22
		backgroundConnect	78	1159	551	258	124
		firstReactRender	42	265	121	58	28
		getState	40	741	309	214	103
		initialActions	0	1	0	0	0
		loadScripts	1127	14756	2094	2914	1399
		setupStore	20	502	167	124	60
		uiStartup	2096	17398	6703	3678	1766

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

background: 2.23 KiB (0.03%)
ui: 0 Bytes (0.00%)
common: 0 Bytes (0.00%)

Use the PublishBatchHookRequest type Signed-off-by: dan437 <[email protected]> Make transactionMeta mandatory for submitBatch, export getTransactionById, refactoring Signed-off-by: dan437 <[email protected]>

Signed-off-by: dan437 <[email protected]>

metamaskbot · 2025-03-27T16:45:37Z

Builds ready [68a7c06]

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

UI Startup Metrics (1272 ± 60 ms)

Platform	BuildType	Page	Metric	Mean (ms)	Min (ms)	Max (ms)	Std Dev (ms)	P 75 (ms)	P 95 (ms)
Chrome	Browserify	Home	uiStartup	1272	1145	1425	60	1318	1373
			load	1114	1009	1271	57	1148	1217
			domContentLoaded	1108	1002	1266	57	1143	1211
			domInteractive	18	13	47	6	17	33
			firstPaint	776	83	1270	435	217	287
			backgroundConnect	11	7	54	7	9	10
			firstReactRender	21	14	62	8	22	44
			getState	11	4	34	7	7	9
			initialActions	0	0	1	0	0	1
			loadScripts	843	727	993	56	873	950
			setupStore	8	5	27	3	7	9
	Webpack	Home	uiStartup	923	838	1066	56	946	963
			load	793	604	910	58	826	882
			domContentLoaded	787	599	903	58	821	874
			domInteractive	15	12	46	7	13	35
			firstPaint	438	55	868	325	817	860
			backgroundConnect	15	11	31	4	15	25
			firstReactRender	13	12	26	1	13	14
			getState	6	3	12	1	6	7
			initialActions	0	0	1	0	0	0
			loadScripts	785	589	893	58	820	864
			setupStore	7	4	10	1	8	9
Firefox	Browserify	Home	uiStartup	1400	1216	2062	159	1452	1816
			load	1254	1067	1905	154	1311	1659
			domContentLoaded	1254	1067	1905	154	1310	1659
			domInteractive	106	43	282	33	86	95
			firstPaint	NaN	NaN	NaN	NaN	NaN	NaN
			backgroundConnect	26	17	120	13	25	47
			firstReactRender	25	19	69	9	25	51
			getState	7	3	39	4	7	8
			initialActions	0	0	1	0	0	1
			loadScripts	1229	1047	1882	153	1291	1637
			setupStore	6	4	14	2	6	7
	Webpack	Home	uiStartup	986	841	1545	167	891	979
			load	865	737	1393	151	802	900
			domContentLoaded	865	736	1393	151	802	900
			domInteractive	117	33	198	28	144	95
			firstPaint	NaN	NaN	NaN	NaN	NaN	NaN
			backgroundConnect	21	14	82	11	23	38
			firstReactRender	19	16	34	2	19	24
			getState	9	4	73	10	7	9
			initialActions	0	0	1	0	0	1
			loadScripts	847	722	1367	146	817	977
			setupStore	7	4	79	7	7	8

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

background: 2.31 KiB (0.04%)
ui: 0 Bytes (0%)
common: 0 Bytes (0%)

app/scripts/controller-init/confirmations/transaction-controller-init.ts

app/scripts/controller-init/messengers/transaction-controller-messenger.ts

app/scripts/lib/transaction/smart-transactions.ts

dan437 · 2025-03-27T18:29:41Z

Thanks a lot for great feedback, @matthewwalsh0 . It seems the PR got approved and automatically merged for today's release candidate, since it's very high priority. I will send a follow up PR which addresses your comments and get that cherry picked into the RC.

dan437 requested a review from a team as a code owner March 25, 2025 10:51

dan437 added the team-transactions Transactions team label Mar 25, 2025

dan437 commented Mar 25, 2025

View reviewed changes

app/scripts/lib/transaction/smart-transactions.ts Outdated Show resolved Hide resolved

dan437 commented Mar 25, 2025

View reviewed changes

app/scripts/lib/transaction/smart-transactions.ts Outdated Show resolved Hide resolved

dan437 marked this pull request as draft March 25, 2025 10:55

dan437 force-pushed the submit-batch branch from 23830c0 to 47992dd Compare March 25, 2025 13:44

dan437 commented Mar 25, 2025

View reviewed changes

app/scripts/controller-init/confirmations/transaction-controller-init.ts Show resolved Hide resolved

dan437 force-pushed the submit-batch branch 2 times, most recently from 4b6e916 to 9143c77 Compare March 26, 2025 15:45

Implement the publishBatch hook for smart transactions

e994666

Use the PublishBatchHookRequest type Signed-off-by: dan437 <[email protected]> Make transactionMeta mandatory for submitBatch, export getTransactionById, refactoring Signed-off-by: dan437 <[email protected]>

dan437 force-pushed the submit-batch branch from 9143c77 to e994666 Compare March 27, 2025 15:14

dan437 added 2 commits March 27, 2025 16:16

End an existing approval flow before starting a new one

2e568f5

Signed-off-by: dan437 <[email protected]>

Add a new test

24cf268

Signed-off-by: dan437 <[email protected]>

dan437 marked this pull request as ready for review March 27, 2025 15:22

dan437 requested review from httpJunkie and klejeune March 27, 2025 15:24

Use type PublishBatchHookTransaction

68a7c06

Signed-off-by: dan437 <[email protected]>

klejeune approved these changes Mar 27, 2025

View reviewed changes

httpJunkie approved these changes Mar 27, 2025

View reviewed changes

dan437 enabled auto-merge March 27, 2025 16:43

matthewwalsh0 approved these changes Mar 27, 2025

View reviewed changes

dan437 added this pull request to the merge queue Mar 27, 2025

auto-merge was automatically disabled March 27, 2025 17:53
Pull Request is not mergeable

Merged via the queue into main with commit ce7aa93 Mar 27, 2025
147 checks passed

dan437 deleted the submit-batch branch March 27, 2025 18:20

github-actions bot locked and limited conversation to collaborators Mar 27, 2025

metamaskbot added the release-12.17.0 Issue or pull request that will be included in release 12.17.0 label Mar 27, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: Implement the publishBatch hook for smart transactions #31267

feat: Implement the publishBatch hook for smart transactions #31267

dan437 commented Mar 25, 2025 •

edited by github-actions bot

Loading

Uh oh!

github-actions bot commented Mar 25, 2025

Uh oh!

Uh oh!

Uh oh!

metamaskbot commented Mar 25, 2025

Uh oh!

Uh oh!

metamaskbot commented Mar 25, 2025

Uh oh!

metamaskbot commented Mar 27, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dan437 commented Mar 27, 2025

Uh oh!

Uh oh!

feat: Implement the publishBatch hook for smart transactions #31267

feat: Implement the publishBatch hook for smart transactions #31267

Conversation

dan437 commented Mar 25, 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 Mar 25, 2025

Uh oh!

Uh oh!

Uh oh!

metamaskbot commented Mar 25, 2025

Uh oh!

Uh oh!

metamaskbot commented Mar 25, 2025

Uh oh!

metamaskbot commented Mar 27, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dan437 commented Mar 27, 2025

Uh oh!

Uh oh!

dan437 commented Mar 25, 2025 •

edited by github-actions bot

Loading