feat: transaction pay controller

.github/CODEOWNERS

@@ -27,6 +27,7 @@
 /packages/name-controller                   @MetaMask/confirmations
 /packages/signature-controller              @MetaMask/confirmations
 /packages/transaction-controller            @MetaMask/confirmations
+/packages/transaction-pay-controller        @MetaMask/confirmations
 /packages/user-operation-controller         @MetaMask/confirmations
 
 ## Delegation Team
@@ -147,6 +148,8 @@
 /packages/signature-controller/CHANGELOG.md       @MetaMask/confirmations @MetaMask/core-platform
 /packages/transaction-controller/package.json     @MetaMask/confirmations @MetaMask/core-platform
 /packages/transaction-controller/CHANGELOG.md     @MetaMask/confirmations @MetaMask/core-platform
+/packages/transaction-pay-controller/package.json @MetaMask/confirmations @MetaMask/core-platform
+/packages/transaction-pay-controller/CHANGELOG.md @MetaMask/confirmations @MetaMask/core-platform
 /packages/user-operation-controller/package.json  @MetaMask/confirmations @MetaMask/core-platform
 /packages/user-operation-controller/CHANGELOG.md  @MetaMask/confirmations @MetaMask/core-platform
 /packages/multichain-transactions-controller/package.json @MetaMask/accounts-engineers @MetaMask/core-platform

packages/transaction-controller/package.json

@@ -79,6 +79,7 @@
     "@metamask/gas-fee-controller": "^24.1.0",
     "@metamask/network-controller": "^24.2.1",
     "@metamask/remote-feature-flag-controller": "^1.8.0",
+    "@ts-bridge/cli": "^0.6.1",
     "@types/bn.js": "^5.1.5",
     "@types/jest": "^27.4.1",
     "@types/node": "^16.18.54",

packages/transaction-controller/src/helpers/PendingTransactionTracker.ts

@@ -382,7 +382,12 @@ export class PendingTransactionTracker {
   }
 
   async #checkTransaction(txMeta: TransactionMeta) {
-    const { hash, id } = txMeta;
+    const { hash, id, isIntentComplete } = txMeta;
+
+    if (isIntentComplete) {
+      await this.#onTransactionConfirmed(txMeta);
+      return;
+    }
 
     if (!hash && (await this.#beforeCheckPendingTransaction(txMeta))) {
       const error = new Error(
@@ -450,10 +455,10 @@ export class PendingTransactionTracker {
 
   async #onTransactionConfirmed(
     txMeta: TransactionMeta,
-    receipt: SuccessfulTransactionReceipt,
+    receipt?: SuccessfulTransactionReceipt,
   ) {
     const { id } = txMeta;
-    const { blockHash } = receipt;
+    const { blockHash } = receipt ?? {};
 
     this.#log('Transaction confirmed', id);
 
@@ -463,19 +468,23 @@ export class PendingTransactionTracker {
       return;
     }
 
-    const { baseFeePerGas, timestamp: blockTimestamp } =
-      await this.#getBlockByHash(blockHash, false);
-
     const updatedTxMeta = cloneDeep(txMeta);
-    updatedTxMeta.baseFeePerGas = baseFeePerGas;
-    updatedTxMeta.blockTimestamp = blockTimestamp;
+
+    if (receipt && blockHash) {
+      const { baseFeePerGas, timestamp: blockTimestamp } =
+        await this.#getBlockByHash(blockHash, false);
+
+      updatedTxMeta.baseFeePerGas = baseFeePerGas;
+      updatedTxMeta.blockTimestamp = blockTimestamp;
+      updatedTxMeta.txParams = {
+        ...updatedTxMeta.txParams,
+        gasUsed: receipt.gasUsed,
+      };
+      updatedTxMeta.txReceipt = receipt;
+      updatedTxMeta.verifiedOnBlockchain = true;
+    }
+
     updatedTxMeta.status = TransactionStatus.confirmed;
-    updatedTxMeta.txParams = {
-      ...updatedTxMeta.txParams,
-      gasUsed: receipt.gasUsed,
-    };
-    updatedTxMeta.txReceipt = receipt;
-    updatedTxMeta.verifiedOnBlockchain = true;
 
     this.#updateTransaction(
       updatedTxMeta,

packages/transaction-controller/src/types.ts

@@ -268,6 +268,9 @@ export type TransactionMeta = {
   /** Whether MetaMask will be compensated for the gas fee by the transaction. */
   isGasFeeIncluded?: boolean;
 
+  /** Whether the intent of the transaction was achieved via an alternate route or chain. */
+  isIntentComplete?: boolean;
+
   /**
    * Whether the transaction is an incoming token transfer.
    */

packages/transaction-pay-controller/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- Initial release ([#6820](https://github.com/MetaMask/core/pull/6820))
+
+[Unreleased]: https://github.com/MetaMask/core/

packages/transaction-pay-controller/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2025 MetaMask
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

packages/transaction-pay-controller/README.md

@@ -0,0 +1,19 @@
+# `@metamask/transaction-pay-controller`
+
+Manages alternate payment strategies to provide required funds for transactions in MetaMask.
+
+## Installation
+
+`yarn add @metamask/transaction-pay-controller`
+
+or
+
+`npm install @metamask/transaction-pay-controller`
+
+## Compatibility
+
+This package relies implicitly upon the `EventEmitter` module. This module is available natively in Node.js, but when using this package for the browser, make sure to use a polyfill such as `events`.
+
+## Contributing
+
+This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme).

packages/transaction-pay-controller/jest.config.js

@@ -0,0 +1,26 @@
+/*
+ * For a detailed explanation regarding each configuration property and type check, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+const merge = require('deepmerge');
+const path = require('path');
+
+const baseConfig = require('../../jest.config.packages');
+
+const displayName = path.basename(__dirname);
+
+module.exports = merge(baseConfig, {
+  // The display name when running multiple projects
+  displayName,
+
+  // An object that configures minimum threshold enforcement for coverage results
+  coverageThreshold: {
+    global: {
+      branches: 100,
+      functions: 100,
+      lines: 100,
+      statements: 100,
+    },
+  },
+});

packages/transaction-pay-controller/package.json

@@ -0,0 +1,94 @@
+{
+  "name": "@metamask/transaction-pay-controller",
+  "version": "0.0.0",
+  "description": "Manages alternate payment strategies to provide required funds for transactions in MetaMask",
+  "keywords": [
+    "MetaMask",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/core/tree/main/packages/transaction-pay-controller#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/core/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/core.git"
+  },
+  "license": "MIT",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.cts",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references",
+    "build:docs": "typedoc",
+    "changelog:update": "../../scripts/update-changelog.sh @metamask/transaction-pay-controller",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/transaction-pay-controller",
+    "prepare-manifest:preview": "../../scripts/prepare-preview-manifest.sh",
+    "publish:preview": "yarn npm publish --tag preview",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter",
+    "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache",
+    "test:verbose": "NODE_OPTIONS=--experimental-vm-modules jest --verbose",
+    "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
+  },
+  "dependencies": {
+    "@ethersproject/abi": "^5.7.0",
+    "@ethersproject/contracts": "^5.7.0",
+    "@metamask/base-controller": "^8.4.1",
+    "@metamask/controller-utils": "^11.14.1",
+    "@metamask/metamask-eth-abis": "^3.1.1",
+    "@metamask/utils": "^11.8.1",
+    "bignumber.js": "^9.1.2",
+    "bn.js": "^5.2.1",
+    "immer": "^9.0.6",
+    "lodash": "^4.17.21"
+  },
+  "devDependencies": {
+    "@metamask/assets-controllers": "^79.0.1",
+    "@metamask/auto-changelog": "^3.4.4",
+    "@metamask/bridge-controller": "^49.0.1",
+    "@metamask/bridge-status-controller": "^49.0.1",
+    "@metamask/network-controller": "^24.2.1",
+    "@metamask/remote-feature-flag-controller": "^1.8.0",
+    "@metamask/transaction-controller": "^60.6.1",
+    "@ts-bridge/cli": "^0.6.1",
+    "@types/jest": "^27.4.1",
+    "deepmerge": "^4.2.2",
+    "jest": "^27.5.1",
+    "ts-jest": "^27.1.4",
+    "typedoc": "^0.24.8",
+    "typedoc-plugin-missing-exports": "^2.0.0",
+    "typescript": "~5.2.2"
+  },
+  "peerDependencies": {
+    "@metamask/assets-controllers": "^79.0.0",
+    "@metamask/bridge-controller": "^49.0.0",
+    "@metamask/bridge-status-controller": "^49.0.0",
+    "@metamask/network-controller": "^24.0.0",
+    "@metamask/remote-feature-flag-controller": "^1.5.0",
+    "@metamask/transaction-controller": "^60.0.0"
+  },
+  "engines": {
+    "node": "^18.18 || >=20"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}