@metamask/transaction-controller 48.2.0 → 50.0.0

package/CHANGELOG.md

@@ -7,6 +7,48 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [50.0.0]
+
+### Added
+
+- Add additional metadata for batch metrics ([#5488](https://github.com/MetaMask/core/pull/5488))
+  - Add `delegationAddress` to `TransactionMetadata`.
+  - Add `NestedTransactionMetadata` type containing `BatchTransactionParams` and `type`.
+  - Add optional `type` to `TransactionBatchSingleRequest`.
+- Verify EIP-7702 contract address using signatures ([#5472](https://github.com/MetaMask/core/pull/5472))
+  - Add optional `publicKeyEIP7702` property to constructor.
+  - Add dependency on `^5.7.0` of `@ethersproject/wallet`.
+
+### Changed
+
+- **BREAKING:** Bump `@metamask/accounts-controller` peer dependency to `^26.1.0` ([#5481](https://github.com/MetaMask/core/pull/5481))
+- **BREAKING:** Add additional metadata for batch metrics ([#5488](https://github.com/MetaMask/core/pull/5488))
+  - Change `error` in `TransactionMetadata` to optional for all statuses.
+  - Change `nestedTransactions` in `TransactionMetadata` to array of `NestedTransactionMetadata`.
+- Throw if `addTransactionBatch` called with external origin and size limit exceeded ([#5489](https://github.com/MetaMask/core/pull/5489))
+- Verify EIP-7702 contract address using signatures ([#5472](https://github.com/MetaMask/core/pull/5472))
+  - Use new `contracts` property from feature flags instead of `contractAddresses`.
+
+## [49.0.0]
+
+### Added
+
+- Add `revertDelegation` to `TransactionType` ([#5468](https://github.com/MetaMask/core/pull/5468))
+- Add optional batch ID to metadata ([#5462](https://github.com/MetaMask/core/pull/5462))
+  - Add optional `batchId` property to `TransactionMeta`.
+  - Add optional `transactionHash` to `TransactionReceipt`.
+  - Add optional `data` to `Log`.
+  - Add optional `batchId` to `TransactionBatchRequest`.
+  - Add optional `batchId` to `addTransaction` options.
+  - Throw if `batchId` already exists on a transaction.
+
+### Changed
+
+- **BREAKING:** Add optional batch ID to metadata ([#5462](https://github.com/MetaMask/core/pull/5462))
+  - Change `batchId` in `TransactionBatchResult` to `Hex`.
+  - Return `batchId` from `addTransactionBatch` if provided.
+  - Generate random batch ID if no `batchId` provided.
+
 ## [48.2.0]
 
 ### Changed
@@ -1338,7 +1380,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
     All changes listed after this point were applied to this package following the monorepo conversion.
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@48.2.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@50.0.0...HEAD
+[50.0.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@49.0.0...@metamask/transaction-controller@50.0.0
+[49.0.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@48.2.0...@metamask/transaction-controller@49.0.0
 [48.2.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@48.1.0...@metamask/transaction-controller@48.2.0
 [48.1.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@48.0.0...@metamask/transaction-controller@48.1.0
 [48.0.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@47.0.0...@metamask/transaction-controller@48.0.0

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_getInternalAccounts, _TransactionController_updateSubmitHistory, _TransactionController_updateGasEstimate;
+var _TransactionController_instances, _TransactionController_internalEvents, _TransactionController_methodDataHelper, _TransactionController_incomingTransactionChainIds, _TransactionController_incomingTransactionHelper, _TransactionController_incomingTransactionOptions, _TransactionController_pendingTransactionOptions, _TransactionController_publicKeyEIP7702, _TransactionController_trace, _TransactionController_transactionHistoryLimit, _TransactionController_isFirstTimeInteractionEnabled, _TransactionController_isSimulationEnabled, _TransactionController_testGasFeeFlows, _TransactionController_multichainTrackingHelper, _TransactionController_retryTransaction, _TransactionController_rejectTransaction, _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, _TransactionController_updateGasEstimate, _TransactionController_deleteTransaction, _TransactionController_isRejectError, _TransactionController_rejectTransactionAndThrow;
 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");
@@ -156,7 +156,7 @@ class TransactionController extends base_controller_1.BaseController {
      * @param options - The controller options.
      */
     constructor(options) {
-        const { disableHistory, disableSendFlowHistory, disableSwaps, getCurrentAccountEIP1559Compatibility, getCurrentNetworkEIP1559Compatibility, getExternalPendingTransactions, getGasFeeEstimates, getNetworkClientRegistry, getNetworkState, getPermittedAccounts, getSavedGasFees, incomingTransactions = {}, isFirstTimeInteractionEnabled, isSimulationEnabled, messenger, pendingTransactions = {}, securityProviderRequest, sign, state, testGasFeeFlows, trace, transactionHistoryLimit = 40, hooks, } = options;
+        const { disableHistory, disableSendFlowHistory, disableSwaps, getCurrentAccountEIP1559Compatibility, getCurrentNetworkEIP1559Compatibility, getExternalPendingTransactions, getGasFeeEstimates, getNetworkClientRegistry, getNetworkState, getPermittedAccounts, getSavedGasFees, incomingTransactions = {}, isFirstTimeInteractionEnabled, isSimulationEnabled, messenger, pendingTransactions = {}, publicKeyEIP7702, securityProviderRequest, sign, state, testGasFeeFlows, trace, transactionHistoryLimit = 40, hooks, } = options;
         super({
             name: controllerName,
             metadata,
@@ -175,6 +175,7 @@ class TransactionController extends base_controller_1.BaseController {
         _TransactionController_incomingTransactionHelper.set(this, void 0);
         _TransactionController_incomingTransactionOptions.set(this, void 0);
         _TransactionController_pendingTransactionOptions.set(this, void 0);
+        _TransactionController_publicKeyEIP7702.set(this, void 0);
         this.signAbortCallbacks = new Map();
         _TransactionController_trace.set(this, void 0);
         _TransactionController_transactionHistoryLimit.set(this, void 0);
@@ -205,6 +206,7 @@ class TransactionController extends base_controller_1.BaseController {
         this.securityProviderRequest = securityProviderRequest;
         __classPrivateFieldSet(this, _TransactionController_incomingTransactionOptions, incomingTransactions, "f");
         __classPrivateFieldSet(this, _TransactionController_pendingTransactionOptions, pendingTransactions, "f");
+        __classPrivateFieldSet(this, _TransactionController_publicKeyEIP7702, publicKeyEIP7702, "f");
         __classPrivateFieldSet(this, _TransactionController_transactionHistoryLimit, transactionHistoryLimit, "f");
         this.sign = sign;
         __classPrivateFieldSet(this, _TransactionController_testGasFeeFlows, testGasFeeFlows === true, "f");
@@ -320,6 +322,7 @@ class TransactionController extends base_controller_1.BaseController {
             getEthQuery: (networkClientId) => __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getEthQuery).call(this, { networkClientId }),
             getInternalAccounts: __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getInternalAccounts).bind(this),
             messenger: this.messagingSystem,
+            publicKeyEIP7702: __classPrivateFieldGet(this, _TransactionController_publicKeyEIP7702, "f"),
             request,
         });
     }
@@ -334,6 +337,7 @@ class TransactionController extends base_controller_1.BaseController {
             address,
             getEthQuery: (chainId) => __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getEthQuery).call(this, { chainId }),
             messenger: this.messagingSystem,
+            publicKeyEIP7702: __classPrivateFieldGet(this, _TransactionController_publicKeyEIP7702, "f"),
         });
     }
     /**
@@ -344,6 +348,7 @@ class TransactionController extends base_controller_1.BaseController {
      * @param txParams - Standard parameters for an Ethereum transaction.
      * @param options - Additional options to control how the transaction is added.
      * @param options.actionId - Unique ID to prevent duplicate requests.
+     * @param options.batchId - A custom ID for the batch this transaction belongs to.
      * @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.
@@ -361,11 +366,15 @@ class TransactionController extends base_controller_1.BaseController {
      */
     async addTransaction(txParams, options) {
         (0, logger_1.projectLogger)('Adding transaction', txParams, options);
-        const { actionId, deviceConfirmedOn, method, nestedTransactions, networkClientId, origin, requireApproval, securityAlertResponse, sendFlowHistory, swaps = {}, traceContext, type, } = options;
+        const { actionId, batchId, 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}`);
         }
+        const chainId = __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getChainId).call(this, networkClientId);
+        const ethQuery = __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getEthQuery).call(this, {
+            networkClientId,
+        });
         const permittedAddresses = origin === undefined
             ? undefined
             : await this.getPermittedAccounts?.(origin);
@@ -381,14 +390,17 @@ class TransactionController extends base_controller_1.BaseController {
             txParams,
             type,
         });
+        const delegationAddressPromise = (0, eip7702_1.getDelegationAddress)(txParams.from, ethQuery).catch(() => undefined);
         const isEIP1559Compatible = await this.getEIP1559Compatibility(networkClientId);
         (0, validation_1.validateTxParams)(txParams, isEIP1559Compatible);
+        const isDuplicateBatchId = batchId?.length &&
+            this.state.transactions.some((tx) => tx.batchId?.toLowerCase() === batchId?.toLowerCase());
+        if (isDuplicateBatchId) {
+            throw rpc_errors_1.rpcErrors.invalidInput('Batch ID already exists');
+        }
         const dappSuggestedGasFees = this.generateDappSuggestedGasFees(txParams, origin);
-        const chainId = __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getChainId).call(this, networkClientId);
-        const ethQuery = __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_getEthQuery).call(this, {
-            networkClientId,
-        });
         const transactionType = type ?? (await (0, transaction_type_1.determineTransactionType)(txParams, ethQuery)).type;
+        const delegationAddress = await delegationAddressPromise;
         const existingTransactionMeta = this.getTransactionWithActionId(actionId);
         // If a request to add a transaction with the same actionId is submitted again, a new transaction will not be created for it.
         let addedTransactionMeta = existingTransactionMeta
@@ -396,8 +408,10 @@ class TransactionController extends base_controller_1.BaseController {
             : {
                 // Add actionId to txMeta to check if same actionId is seen again
                 actionId,
+                batchId,
                 chainId,
                 dappSuggestedGasFees,
+                delegationAddress,
                 deviceConfirmedOn,
                 id: (0, uuid_1.v1)(),
                 isFirstTimeInteraction: undefined,
@@ -432,7 +446,7 @@ class TransactionController extends base_controller_1.BaseController {
             }
             addedTransactionMeta = (0, swaps_1.updateSwapsTransaction)(addedTransactionMeta, transactionType, swaps, {
                 isSwapsDisabled: this.isSwapsDisabled,
-                cancelTransaction: this.cancelTransaction.bind(this),
+                cancelTransaction: __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_rejectTransaction).bind(this),
                 messenger: this.messagingSystem,
             });
             this.addMetadata(addedTransactionMeta);
@@ -1232,18 +1246,13 @@ class TransactionController extends base_controller_1.BaseController {
                         actionId,
                     });
                 }
-                // TODO: Replace `any` with type
-                // eslint-disable-next-line @typescript-eslint/no-explicit-any
             }
-            catch (error) {
+            catch (rawError) {
+                const error = rawError;
                 const { isCompleted: isTxCompleted } = this.isTransactionCompleted(transactionId);
                 if (!isTxCompleted) {
-                    if (error?.code === rpc_errors_1.errorCodes.provider.userRejectedRequest) {
-                        this.cancelTransaction(transactionId, actionId);
-                        throw rpc_errors_1.providerErrors.userRejectedRequest({
-                            message: 'MetaMask Tx Signature: User denied transaction signature.',
-                            data: error?.data,
-                        });
+                    if (__classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_isRejectError).call(this, error)) {
+                        __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_rejectTransactionAndThrow).call(this, transactionId, actionId, error);
                     }
                     else {
                         this.failTransaction(meta, error, actionId);
@@ -1254,8 +1263,9 @@ class TransactionController extends base_controller_1.BaseController {
         const finalMeta = await finishedPromise;
         switch (finalMeta?.status) {
             case types_1.TransactionStatus.failed:
-                resultCallbacks?.error(finalMeta.error);
-                throw rpc_errors_1.rpcErrors.internal(finalMeta.error.message);
+                const error = finalMeta.error;
+                resultCallbacks?.error(error);
+                throw rpc_errors_1.rpcErrors.internal(error.message);
             case types_1.TransactionStatus.submitted:
                 resultCallbacks?.success();
                 return finalMeta.hash;
@@ -1382,34 +1392,6 @@ class TransactionController extends base_controller_1.BaseController {
         }
         return transactionHash;
     }
-    /**
-     * Cancels a transaction based on its ID by setting its status to "rejected"
-     * and emitting a `<tx.id>:finished` hub event.
-     *
-     * @param transactionId - The ID of the transaction to cancel.
-     * @param actionId - The actionId passed from UI
-     */
-    cancelTransaction(transactionId, actionId) {
-        const transactionMeta = this.state.transactions.find(({ id }) => id === transactionId);
-        if (!transactionMeta) {
-            return;
-        }
-        this.update((state) => {
-            const transactions = state.transactions.filter(({ id }) => id !== transactionId);
-            state.transactions = this.trimTransactionsForState(transactions);
-        });
-        const updatedTransactionMeta = {
-            ...transactionMeta,
-            status: types_1.TransactionStatus.rejected,
-        };
-        this.messagingSystem.publish(`${controllerName}:transactionFinished`, updatedTransactionMeta);
-        __classPrivateFieldGet(this, _TransactionController_internalEvents, "f").emit(`${transactionMeta.id}:finished`, updatedTransactionMeta);
-        this.messagingSystem.publish(`${controllerName}:transactionRejected`, {
-            transactionMeta: updatedTransactionMeta,
-            actionId,
-        });
-        this.onTransactionStatusChange(updatedTransactionMeta);
-    }
     /**
      * Trim the amount of transactions that are set on the state. Checks
      * if the length of the tx history is longer then desired persistence
@@ -1787,7 +1769,7 @@ class TransactionController extends base_controller_1.BaseController {
     }
 }
 exports.TransactionController = TransactionController;
-_TransactionController_internalEvents = new WeakMap(), _TransactionController_methodDataHelper = new WeakMap(), _TransactionController_incomingTransactionChainIds = new WeakMap(), _TransactionController_incomingTransactionHelper = new WeakMap(), _TransactionController_incomingTransactionOptions = new WeakMap(), _TransactionController_pendingTransactionOptions = new WeakMap(), _TransactionController_trace = new WeakMap(), _TransactionController_transactionHistoryLimit = new WeakMap(), _TransactionController_isFirstTimeInteractionEnabled = new WeakMap(), _TransactionController_isSimulationEnabled = new WeakMap(), _TransactionController_testGasFeeFlows = new WeakMap(), _TransactionController_multichainTrackingHelper = new WeakMap(), _TransactionController_checkForPendingTransactionAndStartPolling = new WeakMap(), _TransactionController_instances = new WeakSet(), _TransactionController_retryTransaction = async function _TransactionController_retryTransaction({ actionId, afterSubmit, estimatedBaseFee, gasValues, label, prepareTransactionParams, rate, transactionId, transactionType, }) {
+_TransactionController_internalEvents = new WeakMap(), _TransactionController_methodDataHelper = new WeakMap(), _TransactionController_incomingTransactionChainIds = new WeakMap(), _TransactionController_incomingTransactionHelper = new WeakMap(), _TransactionController_incomingTransactionOptions = new WeakMap(), _TransactionController_pendingTransactionOptions = new WeakMap(), _TransactionController_publicKeyEIP7702 = new WeakMap(), _TransactionController_trace = new WeakMap(), _TransactionController_transactionHistoryLimit = new WeakMap(), _TransactionController_isFirstTimeInteractionEnabled = new WeakMap(), _TransactionController_isSimulationEnabled = new WeakMap(), _TransactionController_testGasFeeFlows = new WeakMap(), _TransactionController_multichainTrackingHelper = new WeakMap(), _TransactionController_checkForPendingTransactionAndStartPolling = new WeakMap(), _TransactionController_instances = new WeakSet(), _TransactionController_retryTransaction = async function _TransactionController_retryTransaction({ actionId, afterSubmit, estimatedBaseFee, gasValues, label, prepareTransactionParams, rate, transactionId, transactionType, }) {
     // If transaction is found for same action id, do not create a new transaction.
     if (this.getTransactionWithActionId(actionId)) {
         return;
@@ -1852,6 +1834,24 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_me
         actionId,
     });
     afterSubmit?.(newTransactionMeta);
+}, _TransactionController_rejectTransaction = function _TransactionController_rejectTransaction(transactionId, actionId, error) {
+    const transactionMeta = this.getTransaction(transactionId);
+    if (!transactionMeta) {
+        return;
+    }
+    __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_deleteTransaction).call(this, transactionId);
+    const updatedTransactionMeta = {
+        ...transactionMeta,
+        status: types_1.TransactionStatus.rejected,
+        error: (0, utils_2.normalizeTxError)(error ?? rpc_errors_1.providerErrors.userRejectedRequest()),
+    };
+    this.messagingSystem.publish(`${controllerName}:transactionFinished`, updatedTransactionMeta);
+    __classPrivateFieldGet(this, _TransactionController_internalEvents, "f").emit(`${transactionMeta.id}:finished`, updatedTransactionMeta);
+    this.messagingSystem.publish(`${controllerName}:transactionRejected`, {
+        transactionMeta: updatedTransactionMeta,
+        actionId,
+    });
+    this.onTransactionStatusChange(updatedTransactionMeta);
 }, _TransactionController_getChainId = function _TransactionController_getChainId(networkClientId) {
     return __classPrivateFieldGet(this, _TransactionController_multichainTrackingHelper, "f").getNetworkClient({ networkClientId })
         .configuration.chainId;
@@ -2099,5 +2099,24 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_me
         isCustomNetwork,
         txMeta: transactionMeta,
     });
+}, _TransactionController_deleteTransaction = function _TransactionController_deleteTransaction(transactionId) {
+    this.update((state) => {
+        const transactions = state.transactions.filter(({ id }) => id !== transactionId);
+        state.transactions = this.trimTransactionsForState(transactions);
+    });
+}, _TransactionController_isRejectError = function _TransactionController_isRejectError(error) {
+    return [
+        rpc_errors_1.errorCodes.provider.userRejectedRequest,
+        rpc_errors_1.errorCodes.rpc.methodNotSupported,
+    ].includes(error.code);
+}, _TransactionController_rejectTransactionAndThrow = function _TransactionController_rejectTransactionAndThrow(transactionId, actionId, error) {
+    __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_rejectTransaction).call(this, transactionId, actionId, error);
+    if (error.code === rpc_errors_1.errorCodes.provider.userRejectedRequest) {
+        throw rpc_errors_1.providerErrors.userRejectedRequest({
+            message: 'MetaMask Tx Signature: User denied transaction signature.',
+            data: error?.data,
+        });
+    }
+    throw error;
 };
 //# sourceMappingURL=TransactionController.cjs.map