fix: preserve transaction type of batched transactions #6056

micaelae · 2025-07-01T20:53:50Z

Explanation

When a batch of transactions with specific TransactionType values is submitted (example: bridgeApproval, swap, bridge), the txs get published with generic types like contractInteraction and approve, and the requested types are not preserved

The type values are needed in the swaps and bridge experiences in order to track and display accurate transaction statuses so they need to be propagated

References

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

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

bfullam · 2025-07-02T08:14:51Z

@metamaskbot publish-preview

github-actions · 2025-07-02T08:20:14Z

Preview builds have been published. See these instructions for more information about preview builds.

Expand for full list of packages and versions.

{
  "@metamask-previews/account-tree-controller": "0.4.0-preview-9cc92e6f",
  "@metamask-previews/accounts-controller": "31.0.0-preview-9cc92e6f",
  "@metamask-previews/address-book-controller": "6.1.0-preview-9cc92e6f",
  "@metamask-previews/announcement-controller": "7.0.3-preview-9cc92e6f",
  "@metamask-previews/app-metadata-controller": "1.0.0-preview-9cc92e6f",
  "@metamask-previews/approval-controller": "7.1.3-preview-9cc92e6f",
  "@metamask-previews/assets-controllers": "69.0.0-preview-9cc92e6f",
  "@metamask-previews/base-controller": "8.0.1-preview-9cc92e6f",
  "@metamask-previews/bridge-controller": "34.0.0-preview-9cc92e6f",
  "@metamask-previews/bridge-status-controller": "33.0.0-preview-9cc92e6f",
  "@metamask-previews/build-utils": "3.0.3-preview-9cc92e6f",
  "@metamask-previews/chain-agnostic-permission": "1.0.0-preview-9cc92e6f",
  "@metamask-previews/composable-controller": "11.0.0-preview-9cc92e6f",
  "@metamask-previews/controller-utils": "11.10.0-preview-9cc92e6f",
  "@metamask-previews/delegation-controller": "0.5.0-preview-9cc92e6f",
  "@metamask-previews/earn-controller": "2.0.1-preview-9cc92e6f",
  "@metamask-previews/eip1193-permission-middleware": "1.0.0-preview-9cc92e6f",
  "@metamask-previews/ens-controller": "17.0.0-preview-9cc92e6f",
  "@metamask-previews/error-reporting-service": "2.0.0-preview-9cc92e6f",
  "@metamask-previews/eth-json-rpc-provider": "4.1.8-preview-9cc92e6f",
  "@metamask-previews/foundryup": "1.0.0-preview-9cc92e6f",
  "@metamask-previews/gas-fee-controller": "24.0.0-preview-9cc92e6f",
  "@metamask-previews/json-rpc-engine": "10.0.3-preview-9cc92e6f",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.7-preview-9cc92e6f",
  "@metamask-previews/keyring-controller": "22.0.2-preview-9cc92e6f",
  "@metamask-previews/logging-controller": "6.0.4-preview-9cc92e6f",
  "@metamask-previews/message-manager": "12.0.1-preview-9cc92e6f",
  "@metamask-previews/multichain-api-middleware": "1.0.0-preview-9cc92e6f",
  "@metamask-previews/multichain-network-controller": "0.9.0-preview-9cc92e6f",
  "@metamask-previews/multichain-transactions-controller": "3.0.0-preview-9cc92e6f",
  "@metamask-previews/name-controller": "8.0.3-preview-9cc92e6f",
  "@metamask-previews/network-controller": "24.0.0-preview-9cc92e6f",
  "@metamask-previews/notification-services-controller": "12.0.0-preview-9cc92e6f",
  "@metamask-previews/permission-controller": "11.0.6-preview-9cc92e6f",
  "@metamask-previews/permission-log-controller": "3.0.3-preview-9cc92e6f",
  "@metamask-previews/phishing-controller": "12.6.0-preview-9cc92e6f",
  "@metamask-previews/polling-controller": "14.0.0-preview-9cc92e6f",
  "@metamask-previews/preferences-controller": "18.4.0-preview-9cc92e6f",
  "@metamask-previews/profile-sync-controller": "19.0.0-preview-9cc92e6f",
  "@metamask-previews/rate-limit-controller": "6.0.3-preview-9cc92e6f",
  "@metamask-previews/remote-feature-flag-controller": "1.6.0-preview-9cc92e6f",
  "@metamask-previews/sample-controllers": "1.0.0-preview-9cc92e6f",
  "@metamask-previews/seedless-onboarding-controller": "1.0.0-preview-9cc92e6f",
  "@metamask-previews/selected-network-controller": "23.0.0-preview-9cc92e6f",
  "@metamask-previews/signature-controller": "31.0.0-preview-9cc92e6f",
  "@metamask-previews/token-search-discovery-controller": "3.3.0-preview-9cc92e6f",
  "@metamask-previews/transaction-controller": "58.1.0-preview-9cc92e6f",
  "@metamask-previews/user-operation-controller": "37.0.0-preview-9cc92e6f"
}

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

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

packages/transaction-controller/CHANGELOG.md

…etadata

packages/transaction-controller/src/types.ts

matthewwalsh0 · 2025-07-14T13:28:16Z

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

+        expect(publishBatchHook.mock.calls[0][0].transactions[0].type).toBe(
+          TransactionType.swap,
+        );
+        expect(publishBatchHook.mock.calls[0][0].transactions[1].type).toBe(


Rather than asserting the hook is called with the type, ideally the hook wouldn't know, and instead we could verify that addTransaction is called multiple times with the correct types?

Good call - I updated the test to do this! I also removed the type key from the PublishBatchHookTransaction type, which I added for this test.

matthewwalsh0 · 2025-07-22T09:53:21Z

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

@@ -837,6 +932,50 @@ describe('Batch Utils', () => {
          PUBLISH_BATCH_HOOK_PARAMS,
        );
      });
+      //   const publishBatchHook: jest.MockedFn<PublishBatchHook> = jest.fn();


not sure how this happened - will update

OGPoyraz · 2025-07-23T12:42:07Z

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

@@ -606,6 +607,7 @@ async function processTransactionWithHook(
      networkClientId,
      publishHook,
      requireApproval: false,
+      type,


Hey @micaelae , I was debugging the metric issues due to swaps and bridge transaction events and origin was also not preserving to the individual batched transactions. If you don't mind we could add origin here too. Otherwise source will be dapp in metrics which is incorrect.

Given the age of this PR, are we okay to do that in a separate PR @OGPoyraz ?

The PR was merged before I could add this. Can you open a new PR for this change?

All good, we will do it in a separate fix!

OGPoyraz · 2025-07-23T12:46:05Z

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

@@ -606,6 +607,7 @@ async function processTransactionWithHook(
      networkClientId,
      publishHook,
      requireApproval: false,
+      type,


On another note if we are correctly preserving the type with this fix now - do we want to remove this temporary type update from bridge-status-controller? https://github.com/MetaMask/core/blob/main/packages/bridge-status-controller/src/utils/transaction.ts#L355

Yes! I have a draft for removing this, will just need to re-test once this version is published

cursor

Bug: Inconsistent Transaction Type Handling

The processTransactionWithHook function has two issues concerning the type field:

It inconsistently returns the type field: it's included for new transactions but omitted for existing ones, leading to inconsistent object shapes.
Additionally, when the type field is returned, it creates a type mismatch with the hookTransactions array, which expects PublishBatchHookTransaction (a type intentionally designed to omit the type field).

packages/transaction-controller/src/utils/batch.ts#L564-L584

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

Lines 564 to 584 in eede76b

    
           if (existingTransaction) { 
        
             const { id, onPublish, signedTransaction } = existingTransaction; 
        
             const transactionMeta = getTransaction(id); 
        
             updateTransaction({ transactionId: id }, (_transactionMeta) => { 
        
               _transactionMeta.batchId = batchId; 
        
             }); 
        
             publishHook(transactionMeta, signedTransaction) 
        
               .then(onPublish) 
        
               .catch(() => { 
        
                 // Intentionally empty 
        
               }); 
        
             log('Processed existing transaction with hook', { 
        
               id, 
        
               params, 
        
             }); 
        
             return {

packages/transaction-controller/src/utils/batch.ts#L636-L641

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

Lines 636 to 641 in eede76b

    
           return { 
        
             id, 
        
             params: newParams, 
        
             type, 
        
           };

Fix in Cursor • Fix in Web

Was this report helpful? Give feedback by reacting with 👍 or 👎

fix: preserve transaction type of batched transactions

3dc5441

micaelae requested review from a team as code owners July 1, 2025 20:53

chore: update changelog

9cc92e6

This comment was marked as outdated.

Sign in to view

micaelae commented Jul 1, 2025

View reviewed changes

packages/transaction-controller/src/utils/batch.ts Outdated Show resolved Hide resolved

bfullam previously approved these changes Jul 1, 2025

View reviewed changes

micaelae mentioned this pull request Jul 2, 2025

feat: submit swap STX with addTransactionBatch #6058

Merged

4 tasks

matthewwalsh0 requested changes Jul 2, 2025

View reviewed changes

chore: resolve PR comments

51e299e

micaelae dismissed bfullam’s stale review via 51e299e July 2, 2025 14:19

This comment was marked as outdated.

Sign in to view

micaelae and others added 2 commits July 9, 2025 18:09

Merge branch 'main' into batched-tx-types

b19678c

chore: rename type usages

242887c

This comment was marked as outdated.

Sign in to view

micaelae added 3 commits July 9, 2025 18:41

chore: add unit test for 7702-enabled batch transactions

c466dfb

chore: add type to PublishBatchHookTransaction and NestedTransactionM…

34d6594

…etadata

fix: unit test

e252d70

This comment was marked as outdated.

Sign in to view

chore: update changelog

958a0d2

This comment was marked as outdated.

Sign in to view

vinistevam previously approved these changes Jul 11, 2025

View reviewed changes

Merge branch 'main' into batched-tx-types

71b21dc

micaelae requested a review from a team as a code owner July 11, 2025 08:39

micaelae enabled auto-merge (squash) July 11, 2025 08:40

matthewwalsh0 requested changes Jul 14, 2025

View reviewed changes

fix: update batch tx unit test

b5ec8c5

micaelae dismissed vinistevam’s stale review via b5ec8c5 July 21, 2025 19:30

Merge branch 'main' into batched-tx-types

a4d7362

matthewwalsh0 requested changes Jul 22, 2025

View reviewed changes

micaelae and others added 2 commits July 22, 2025 08:53

fix: removed commented unit tests

8652acc

Merge branch 'main' into batched-tx-types

95253f5

OGPoyraz reviewed Jul 23, 2025

View reviewed changes

matthewwalsh0 approved these changes Jul 23, 2025

View reviewed changes

Merge branch 'main' into batched-tx-types

eede76b

cursor bot reviewed Jul 23, 2025

View reviewed changes

micaelae merged commit cb4c666 into main Jul 23, 2025
218 of 219 checks passed

micaelae deleted the batched-tx-types branch July 23, 2025 14:19


	if (existingTransaction) {
	const { id, onPublish, signedTransaction } = existingTransaction;
	const transactionMeta = getTransaction(id);

	updateTransaction({ transactionId: id }, (_transactionMeta) => {
	_transactionMeta.batchId = batchId;
	});

	publishHook(transactionMeta, signedTransaction)
	.then(onPublish)
	.catch(() => {
	// Intentionally empty
	});

	log('Processed existing transaction with hook', {
	id,
	params,
	});

	return {

Uh oh!

fix: preserve transaction type of batched transactions #6056

fix: preserve transaction type of batched transactions #6056

Conversation

micaelae commented Jul 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation

References

Changelog

Checklist

Uh oh!

This comment was marked as outdated.

Uh oh!

Uh oh!

bfullam commented Jul 2, 2025

Uh oh!

github-actions bot commented Jul 2, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

OGPoyraz Jul 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

OGPoyraz Jul 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Bug: Inconsistent Transaction Type Handling

Uh oh!

Uh oh!

Uh oh!

micaelae commented Jul 1, 2025 •

edited

Loading

OGPoyraz Jul 23, 2025 •

edited

Loading

OGPoyraz Jul 23, 2025 •

edited

Loading