@metamask-previews/transaction-controller 46.0.0-preview-ea165590 → 46.0.0-preview-7a21cbc

package/CHANGELOG.md

@@ -7,6 +7,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Support atomic batch transactions ([#5306](https://github.com/MetaMask/core/pull/5306))
+  - Add methods:
+    - `addTransactionBatch`
+    - `isAtomicBatchSupported`
+  - Add `batch` to `TransactionType`.
+  - Add `nestedTransactions` to `TransactionMeta`.
+  - Add new types:
+    - `BatchTransactionParams`
+    - `TransactionBatchSingleRequest`
+    - `TransactionBatchRequest`
+    - `TransactionBatchResult`
+  - Add dependency on `@metamask/remote-feature-flag-controller:^1.4.0`.
+
+### Changed
+
+- **BREAKING:** Support atomic batch transactions ([#5306](https://github.com/MetaMask/core/pull/5306))
+  - Require `AccountsController:getState` action permission in messenger.
+  - Require `RemoteFeatureFlagController:getState` action permission in messenger.
+
 ## [46.0.0]
 
 ### Added

package/dist/TransactionController.cjs

@@ -13,7 +13,7 @@ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-var _TransactionController_instances, _TransactionController_internalEvents, _TransactionController_methodDataHelper, _TransactionController_incomingTransactionChainIds, _TransactionController_incomingTransactionHelper, _TransactionController_incomingTransactionOptions, _TransactionController_pendingTransactionOptions, _TransactionController_trace, _TransactionController_transactionHistoryLimit, _TransactionController_isFirstTimeInteractionEnabled, _TransactionController_isSimulationEnabled, _TransactionController_testGasFeeFlows, _TransactionController_multichainTrackingHelper, _TransactionController_retryTransaction, _TransactionController_getChainId, _TransactionController_getNetworkClientId, _TransactionController_getEthQuery, _TransactionController_getProvider, _TransactionController_createNonceTracker, _TransactionController_createPendingTransactionTracker, _TransactionController_checkForPendingTransactionAndStartPolling, _TransactionController_stopAllTracking, _TransactionController_addIncomingTransactionHelperListeners, _TransactionController_removePendingTransactionTrackerListeners, _TransactionController_addPendingTransactionTrackerListeners, _TransactionController_getNonceTrackerPendingTransactions, _TransactionController_getGasFeeFlows, _TransactionController_getLayer1GasFeeFlows, _TransactionController_updateTransactionInternal, _TransactionController_updateFirstTimeInteraction, _TransactionController_updateSimulationData, _TransactionController_onGasFeePollerTransactionUpdate, _TransactionController_getSelectedAccount, _TransactionController_updateSubmitHistory;
+var _TransactionController_instances, _TransactionController_internalEvents, _TransactionController_methodDataHelper, _TransactionController_incomingTransactionChainIds, _TransactionController_incomingTransactionHelper, _TransactionController_incomingTransactionOptions, _TransactionController_pendingTransactionOptions, _TransactionController_trace, _TransactionController_transactionHistoryLimit, _TransactionController_isFirstTimeInteractionEnabled, _TransactionController_isSimulationEnabled, _TransactionController_testGasFeeFlows, _TransactionController_multichainTrackingHelper, _TransactionController_retryTransaction, _TransactionController_getChainId, _TransactionController_getNetworkClientId, _TransactionController_getEthQuery, _TransactionController_getProvider, _TransactionController_createNonceTracker, _TransactionController_createPendingTransactionTracker, _TransactionController_checkForPendingTransactionAndStartPolling, _TransactionController_stopAllTracking, _TransactionController_addIncomingTransactionHelperListeners, _TransactionController_removePendingTransactionTrackerListeners, _TransactionController_addPendingTransactionTrackerListeners, _TransactionController_getNonceTrackerPendingTransactions, _TransactionController_getGasFeeFlows, _TransactionController_getLayer1GasFeeFlows, _TransactionController_updateTransactionInternal, _TransactionController_updateFirstTimeInteraction, _TransactionController_updateSimulationData, _TransactionController_onGasFeePollerTransactionUpdate, _TransactionController_getSelectedAccount, _TransactionController_getInternalAccounts, _TransactionController_updateSubmitHistory;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TransactionController = exports.ApprovalState = exports.SPEED_UP_RATE = exports.CANCEL_RATE = void 0;
 const base_controller_1 = require("@metamask/base-controller");
@@ -44,6 +44,7 @@ const PendingTransactionTracker_1 = require("./helpers/PendingTransactionTracker
 const ResimulateHelper_1 = require("./helpers/ResimulateHelper.cjs");
 const logger_1 = require("./logger.cjs");
 const types_1 = require("./types.cjs");
+const batch_1 = require("./utils/batch.cjs");
 const eip7702_1 = require("./utils/eip7702.cjs");
 const external_transactions_1 = require("./utils/external-transactions.cjs");
 const gas_1 = require("./utils/gas.cjs");
@@ -328,6 +329,34 @@ class TransactionController extends base_controller_1.BaseController {
     async handleMethodData(fourBytePrefix, networkClientId) {
         return __classPrivateFieldGet(this, _TransactionController_methodDataHelper, "f").lookup(fourBytePrefix, networkClientId);
     }
+    /**
+     * Add a batch of transactions to be submitted after approval.
+     *
+     * @param request - Request object containing the transactions to add.
+     * @returns Result object containing the generated batch ID.
+     */
+    async addTransactionBatch(request) {
+        return await (0, batch_1.addTransactionBatch)({
+            addTransaction: this.addTransaction.bind(this),
+            getChainId: __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getChainId).bind(this),
+            getEthQuery: (networkClientId) => __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getEthQuery).call(this, { networkClientId }),
+            messenger: this.messagingSystem,
+            request,
+        });
+    }
+    /**
+     * Determine which chains support atomic batch transactions with the given account address.
+     *
+     * @param address - The address of the account to check.
+     * @returns  The supported chain IDs.
+     */
+    async isAtomicBatchSupported(address) {
+        return (0, batch_1.isAtomicBatchSupported)({
+            address,
+            getEthQuery: (chainId) => __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getEthQuery).call(this, { chainId }),
+            messenger: this.messagingSystem,
+        });
+    }
     /**
      * Add a new unapproved transaction to state. Parameters will be validated, a
      * unique transaction id will be generated, and gas and gasPrice will be calculated
@@ -338,6 +367,7 @@ class TransactionController extends base_controller_1.BaseController {
      * @param options.actionId - Unique ID to prevent duplicate requests.
      * @param options.deviceConfirmedOn - An enum to indicate what device confirmed the transaction.
      * @param options.method - RPC method that requested the transaction.
+     * @param options.nestedTransactions - Params for any nested transactions encoded in the data.
      * @param options.origin - The origin of the transaction request, such as a dApp hostname.
      * @param options.requireApproval - Whether the transaction requires approval by the user, defaults to true unless explicitly disabled.
      * @param options.securityAlertResponse - Response from security validator.
@@ -352,7 +382,7 @@ class TransactionController extends base_controller_1.BaseController {
      */
     async addTransaction(txParams, options) {
         (0, logger_1.projectLogger)('Adding transaction', txParams, options);
-        const { actionId, deviceConfirmedOn, method, networkClientId, origin, requireApproval, securityAlertResponse, sendFlowHistory, swaps = {}, traceContext, type, } = options;
+        const { actionId, deviceConfirmedOn, method, nestedTransactions, networkClientId, origin, requireApproval, securityAlertResponse, sendFlowHistory, swaps = {}, traceContext, type, } = options;
         txParams = (0, utils_2.normalizeTransactionParams)(txParams);
         if (!__classPrivateFieldGet(this, _TransactionController_multichainTrackingHelper, "f").has(networkClientId)) {
             throw new Error(`Network client not found - ${networkClientId}`);
@@ -361,12 +391,15 @@ class TransactionController extends base_controller_1.BaseController {
             ? undefined
             : await this.getPermittedAccounts?.(origin);
         const selectedAddress = __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getSelectedAccount).call(this).address;
+        const internalAccounts = __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getInternalAccounts).call(this);
         await (0, validation_1.validateTransactionOrigin)({
             from: txParams.from,
+            internalAccounts,
             origin,
             permittedAddresses,
             selectedAddress,
             txParams,
+            type,
         });
         const isEIP1559Compatible = await this.getEIP1559Compatibility(networkClientId);
         (0, validation_1.validateTxParams)(txParams, isEIP1559Compatible);
@@ -388,6 +421,7 @@ class TransactionController extends base_controller_1.BaseController {
                 deviceConfirmedOn,
                 id: (0, uuid_1.v1)(),
                 isFirstTimeInteraction: undefined,
+                nestedTransactions,
                 networkClientId,
                 origin,
                 securityAlertResponse,
@@ -1183,7 +1217,10 @@ class TransactionController extends base_controller_1.BaseController {
                 if (!isTxCompleted) {
                     if (error?.code === rpc_errors_1.errorCodes.provider.userRejectedRequest) {
                         this.cancelTransaction(transactionId, actionId);
-                        throw rpc_errors_1.providerErrors.userRejectedRequest('MetaMask Tx Signature: User denied transaction signature.');
+                        throw rpc_errors_1.providerErrors.userRejectedRequest({
+                            message: 'MetaMask Tx Signature: User denied transaction signature.',
+                            data: error?.data,
+                        });
                     }
                     else {
                         this.failTransaction(meta, error, actionId);
@@ -1251,7 +1288,7 @@ class TransactionController extends base_controller_1.BaseController {
                 }
             });
             this.onTransactionStatusChange(transactionMeta);
-            const rawTx = await __classPrivateFieldGet(this, _TransactionController_trace, "f").call(this, { name: 'Sign', parentContext: traceContext }, () => this.signTransaction(transactionMeta, transactionMeta.txParams));
+            const rawTx = await __classPrivateFieldGet(this, _TransactionController_trace, "f").call(this, { name: 'Sign', parentContext: traceContext }, () => this.signTransaction(transactionMeta));
             if (!this.beforePublish(transactionMeta)) {
                 (0, logger_1.projectLogger)('Skipping publishing transaction based on hook');
                 this.messagingSystem.publish(`${controllerName}:transactionPublishingSkipped`, transactionMeta);
@@ -1618,7 +1655,8 @@ class TransactionController extends base_controller_1.BaseController {
         const currentAccountIsEIP1559Compatible = await this.getCurrentAccountEIP1559Compatibility();
         return (currentNetworkIsEIP1559Compatible && currentAccountIsEIP1559Compatible);
     }
-    async signTransaction(transactionMeta, txParams) {
+    async signTransaction(transactionMeta) {
+        const { txParams } = transactionMeta;
         (0, logger_1.projectLogger)('Signing transaction', txParams);
         const { authorizationList, from } = txParams;
         const finalTxParams = { ...txParams };
@@ -1647,6 +1685,7 @@ class TransactionController extends base_controller_1.BaseController {
         const transactionMetaWithRsv = {
             ...this.updateTransactionMetaRSV(transactionMetaFromHook, signedTx),
             status: types_1.TransactionStatus.signed,
+            txParams: finalTxParams,
         };
         this.updateTransaction(transactionMetaWithRsv, 'TransactionController#approveTransaction - Transaction signed');
         this.onTransactionStatusChange(transactionMetaWithRsv);
@@ -1992,6 +2031,11 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_me
     });
 }, _TransactionController_getSelectedAccount = function _TransactionController_getSelectedAccount() {
     return this.messagingSystem.call('AccountsController:getSelectedAccount');
+}, _TransactionController_getInternalAccounts = function _TransactionController_getInternalAccounts() {
+    const state = this.messagingSystem.call('AccountsController:getState');
+    return Object.values(state.internalAccounts?.accounts ?? {})
+        .filter((account) => account.type === 'eip155:eoa')
+        .map((account) => account.address);
 }, _TransactionController_updateSubmitHistory = function _TransactionController_updateSubmitHistory(transactionMeta, hash) {
     const { chainId, networkClientId, origin, rawTx, txParams } = transactionMeta;
     const { networkConfigurationsByChainId } = this.getNetworkState();