Adds `transactionBatches` into transaction controller state #5793

vinistevam · 2025-05-13T16:28:22Z

Explanation

This PR introduces support for batch transactions in the Transaction Controller by adding a new ApprovalType and extending the state to handle TransactionBatches. These changes enable enhanced metadata management for sequential batch flows, including UI updates for gas estimation and future automation capabilities.

Changes

Controller Utils

Added a new ApprovalType to the enum: TransactionBatch, to support batch transactions.

Transaction Controller

Introduced a new state property: transactionBatches, to store metadata for transaction batches.
Added a private method: #addBatchMetadata, responsible for populating batch-specific metadata.
Created a new type: TransactionBatchMeta, to manage metadata for transaction batches.
Added the #trimBatchTransactionsForState method to handle TransactionBatchMeta.
Update unit tests

Rationale

The introduction of TransactionBatchMeta allows for a clean separation of metadata for batch transactions, which conceptually differ from individual transactions. This ensures:

Accurate metadata at the time of batch creation, as TransactionMeta for individual transactions may not yet exist.
Future support for advanced features such as transaction simulations and dynamic gas fee updates for batches, enabling better client-side functionality and automation.

These changes lay the groundwork for improved handling of batch transactions and pave the way for future enhancements.

References

Related to https://github.com/MetaMask/MetaMask-planning/issues/4697

Changelog

Checklist

I've updated the test suite for new or updated code as appropriate
I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
I've communicated my changes to consumers by updating changelogs for packages I've changed, highlighting breaking changes as necessary
I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes

…a publish batch hook

matthewwalsh0 · 2025-05-14T17:04:38Z

packages/controller-utils/src/constants.ts

@@ -169,6 +169,7 @@ export enum ApprovalType {
  WalletConnect = 'wallet_connect',
  WalletRequestPermissions = 'wallet_requestPermissions',
  WatchAsset = 'wallet_watchAsset',
+  TransactionBatch = 'transaction_batch',


Minor, alphabetical?

matthewwalsh0 · 2025-05-14T17:06:17Z

packages/transaction-controller/src/TransactionController.ts

@@ -2596,6 +2606,15 @@ export class TransactionController extends BaseController<
    });
  }

+  #addBatchMetadata(transactionBatchMeta: TransactionBatchMeta) {


In the interest of modularity, could we provide the update callback directly so the state is encapsulated within the batch module?

Removed #addBatchMetadata as we agreed to not persist the transactionBatches for now.

matthewwalsh0 · 2025-05-14T17:07:47Z

packages/transaction-controller/src/TransactionController.ts

+   * @param transactions - The transactions to be applied to the state.
+   * @returns The trimmed list of transactions.
+   */
+  #trimBatchTransactionsForState(


Can this also go in batch.ts file for the sake for modularity?

Plus can we simplify this to just add at the end, and delete from the start once we exceed some limit?

Removed #trimBatchTransactionsForState, becasue we are not saving the transactionBatches yet

matthewwalsh0 · 2025-05-14T17:07:59Z

packages/transaction-controller/src/types.ts

@@ -490,6 +490,39 @@ export type TransactionMeta = {
  };
 };

+export type TransactionBatchMeta = {


JSDoc for type itself?

matthewwalsh0 · 2025-05-14T17:08:20Z

packages/transaction-controller/src/types.ts

+  id: string;
+
+  /**
+   * Data for any nested transactions.


Technically not "nested" as that is EIP-7702 only.

matthewwalsh0 · 2025-05-14T17:10:14Z

packages/transaction-controller/src/utils/batch.ts

  const batchId = generateBatchId();
+
+  if (requireApproval) {
+    const txBatchMeta: TransactionBatchMeta = {


Assuming this will grow, should we create a newBatchMetadata function to just return the object?

Created newBatchMetadata function.

matthewwalsh0 · 2025-05-14T17:11:07Z

packages/transaction-controller/src/utils/batch.ts

+async function requestApproval(
+  txBatchMeta: TransactionBatchMeta,
+  messenger: TransactionControllerMessenger,
+  { shouldShowRequest }: { shouldShowRequest: boolean },


As we only have one usage, should we remove this property and hardcode below?

matthewwalsh0 · 2025-05-14T17:15:09Z

packages/transaction-controller/src/utils/batch.ts

+      id,
+      origin: origin || ORIGIN_METAMASK,
+      requestData,
+      expectsResult: true,


If we're setting expectsResult to true, it means the client will wait until we call one of the result callbacks.

Meaning we need to invoke success or error returned from this function once the batch is complete or failed.

So, should I save the resultCallbacks and call success when tx is confirmed or error when tx fails, similar to the pattern of collectHook?
Applied fixes.

packages/transaction-controller/CHANGELOG.md

matthewwalsh0 · 2025-05-14T17:17:51Z

packages/transaction-controller/src/types.ts

@@ -490,6 +490,39 @@ export type TransactionMeta = {
  };
 };

+export type TransactionBatchMeta = {


Should we export this in index.ts?

Done, type exported.

matthewwalsh0 · 2025-05-14T17:19:38Z

packages/transaction-controller/src/utils/batch.ts

  const batchId = generateBatchId();
+
+  if (requireApproval) {


Should we also check useHook is true at this stage as EIP-7702 uses the standard confirmation?

Co-authored-by: Matthew Walsh <[email protected]>

…:MetaMask/core into feat/add-batch-transaction-approval-type

vinistevam added 3 commits May 13, 2025 17:18

add transaction batch approval type

60076b1

add transactionBatches into the state

a8c3d14

populate transactionBatches when process a batch transaction using …

423a43e

…a publish batch hook

vinistevam added the team-confirmations label May 13, 2025

vinistevam and others added 6 commits May 14, 2025 06:31

change logs and lint

2cc016a

Merge branch 'main' into feat/add-batch-transaction-approval-type

0f88df1

fix: push types

fe47147

Add trimBatchTransactionsForState and fix unit tests

955cf57

use 'transaction_batch' for now util releases utils controller

7c803e5

Merge branch 'main' into feat/add-batch-transaction-approval-type

1047465

vinistevam force-pushed the feat/add-batch-transaction-approval-type branch 2 times, most recently from c3f8a6b to 49e9a89 Compare May 14, 2025 16:13

vinistevam marked this pull request as ready for review May 14, 2025 16:14

vinistevam requested review from a team as code owners May 14, 2025 16:14

wip

e62592d

pedronfigueiredo force-pushed the feat/add-batch-transaction-approval-type branch from 31069c4 to e62592d Compare May 14, 2025 16:24

matthewwalsh0 requested changes May 14, 2025

View reviewed changes

matthewwalsh0 reviewed May 14, 2025

View reviewed changes

vinistevam and others added 7 commits May 15, 2025 08:34

Update packages/transaction-controller/CHANGELOG.md

18b66e6

Co-authored-by: Matthew Walsh <[email protected]>

fix: applied suggestions

f024fe5

Merge branch 'feat/add-batch-transaction-approval-type' of github.com…

0b658c2

…:MetaMask/core into feat/add-batch-transaction-approval-type

remove time property

4dbad19

Merge branch 'main' into feat/add-batch-transaction-approval-type

74d94de

fix changelog

0614743

Merge branch 'main' into feat/add-batch-transaction-approval-type

d23d089

vinistevam changed the title ~~Adds and populate transactionBatches into transaction controller state~~ Adds transactionBatches into transaction controller state May 19, 2025

vinistevam added 3 commits May 20, 2025 14:00

Merge branch 'main' into feat/add-batch-transaction-approval-type

9f3ac61

fix: unit test after merge

ccbc815

fix: add more coverage

e281412

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds `transactionBatches` into transaction controller state #5793

Adds `transactionBatches` into transaction controller state #5793

vinistevam commented May 13, 2025 •

edited by pedronfigueiredo

Loading

matthewwalsh0 May 14, 2025

vinistevam May 15, 2025

matthewwalsh0 May 14, 2025

vinistevam May 15, 2025

matthewwalsh0 May 14, 2025

vinistevam May 15, 2025

matthewwalsh0 May 14, 2025

matthewwalsh0 May 14, 2025

vinistevam May 15, 2025

matthewwalsh0 May 14, 2025

vinistevam May 15, 2025

matthewwalsh0 May 14, 2025

vinistevam May 15, 2025

matthewwalsh0 May 14, 2025

vinistevam May 15, 2025

matthewwalsh0 May 14, 2025

vinistevam May 15, 2025

matthewwalsh0 May 14, 2025

vinistevam May 15, 2025

Adds transactionBatches into transaction controller state #5793

Are you sure you want to change the base?

Adds transactionBatches into transaction controller state #5793

Conversation

vinistevam commented May 13, 2025 • edited by pedronfigueiredo Loading

Explanation

Changes

Controller Utils

Transaction Controller

Rationale

References

Changelog

Checklist

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

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

Choose a reason for hiding this comment

Adds `transactionBatches` into transaction controller state #5793

Adds `transactionBatches` into transaction controller state #5793

vinistevam commented May 13, 2025 •

edited by pedronfigueiredo

Loading