@metamask-previews/transaction-controller 52.3.0-preview-cff14565 → 52.3.0-preview-8365901

package/CHANGELOG.md

@@ -7,11 +7,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-### Changed
-
-- Throw if `chainId` in `TransactionParams` does not match `networkClientId` when calling `addTransaction` ([#5511](https://github.com/MetaMask/core/pull/5569))
-  - Mark `chainId` in `TransactionParams` as deprecated.
-
 ## [52.3.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_incomingTransactionHelper, _TransactionController_incomingTransactionOptions, _TransactionController_pendingTransactionOptions, _TransactionController_publishBatchHook, _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;
+var _TransactionController_instances, _TransactionController_internalEvents, _TransactionController_methodDataHelper, _TransactionController_incomingTransactionHelper, _TransactionController_incomingTransactionOptions, _TransactionController_pendingTransactionOptions, _TransactionController_publishBatchHook, _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_registerActionHandlers, _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");
@@ -215,10 +215,9 @@ class TransactionController extends base_controller_1.BaseController {
         __classPrivateFieldSet(this, _TransactionController_trace, trace ?? ((_request, fn) => fn?.()), "f");
         this.afterSign = hooks?.afterSign ?? (() => true);
         this.beforeCheckPendingTransaction =
-            hooks?.beforeCheckPendingTransaction ??
-                /* istanbul ignore next */
-                (() => true);
-        this.beforePublish = hooks?.beforePublish ?? (() => true);
+            /* istanbul ignore next */
+            hooks?.beforeCheckPendingTransaction ?? (() => Promise.resolve(true));
+        this.beforePublish = hooks?.beforePublish ?? (() => Promise.resolve(true));
         this.getAdditionalSignArguments =
             hooks?.getAdditionalSignArguments ?? (() => []);
         this.publish =
@@ -294,6 +293,7 @@ class TransactionController extends base_controller_1.BaseController {
         });
         this.onBootCleanup();
         __classPrivateFieldGet(this, _TransactionController_checkForPendingTransactionAndStartPolling, "f").call(this);
+        __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_registerActionHandlers).call(this);
     }
     /**
      * Stops polling and removes listeners to prepare the controller for garbage collection.
@@ -399,7 +399,7 @@ class TransactionController extends base_controller_1.BaseController {
         });
         const delegationAddressPromise = (0, eip7702_1.getDelegationAddress)(txParams.from, ethQuery).catch(() => undefined);
         const isEIP1559Compatible = await this.getEIP1559Compatibility(networkClientId);
-        (0, validation_1.validateTxParams)(txParams, isEIP1559Compatible, chainId);
+        (0, validation_1.validateTxParams)(txParams, isEIP1559Compatible);
         if (!txParams.type) {
             // Determine transaction type based on transaction parameters and network compatibility
             (0, utils_2.setEnvelopeType)(txParams, isEIP1559Compatible);
@@ -682,6 +682,7 @@ class TransactionController extends base_controller_1.BaseController {
             this.onTransactionStatusChange(updatedTransactionMeta);
             // Intentional given potential duration of process.
             this.updatePostBalance(updatedTransactionMeta).catch((error) => {
+                /* istanbul ignore next */
                 (0, logger_1.projectLogger)('Error while updating post balance', error);
                 throw error;
             });
@@ -930,20 +931,16 @@ class TransactionController extends base_controller_1.BaseController {
     /**
      * Update a custodial transaction.
      *
-     * @param transactionId - The ID of the transaction to update.
-     * @param options - The custodial transaction options to update.
-     * @param options.errorMessage - The error message to be assigned in case transaction status update to failed.
-     * @param options.hash - The new hash value to be assigned.
-     * @param options.status - The new status value to be assigned.
+     * @param request - The custodial transaction update request.
+     *
+     * @returns The updated transaction metadata.
      */
-    updateCustodialTransaction(transactionId, { errorMessage, hash, status, }) {
+    updateCustodialTransaction(request) {
+        const { transactionId, errorMessage, hash, status, gasLimit, gasPrice, maxFeePerGas, maxPriorityFeePerGas, nonce, type, } = request;
         const transactionMeta = this.getTransaction(transactionId);
         if (!transactionMeta) {
             throw new Error(`Cannot update custodial transaction as no transaction metadata found`);
         }
-        if (!transactionMeta.custodyId) {
-            throw new Error('Transaction must be a custodian transaction');
-        }
         if (status &&
             ![
                 types_1.TransactionStatus.submitted,
@@ -959,11 +956,27 @@ class TransactionController extends base_controller_1.BaseController {
         if (updatedTransactionMeta.status === types_1.TransactionStatus.failed) {
             updatedTransactionMeta.error = (0, utils_2.normalizeTxError)(new Error(errorMessage));
         }
+        // Update txParams properties with a single pickBy operation
+        updatedTransactionMeta.txParams = (0, lodash_1.merge)({}, updatedTransactionMeta.txParams, (0, lodash_1.pickBy)({
+            gasLimit,
+            gasPrice,
+            maxFeePerGas,
+            maxPriorityFeePerGas,
+            nonce,
+            type,
+        }));
+        // Special case for type change to legacy
+        if (type === types_1.TransactionEnvelopeType.legacy) {
+            delete updatedTransactionMeta.txParams.maxFeePerGas;
+            delete updatedTransactionMeta.txParams.maxPriorityFeePerGas;
+        }
         this.updateTransaction(updatedTransactionMeta, `${controllerName}:updateCustodialTransaction - Custodial transaction updated`);
-        if ([types_1.TransactionStatus.submitted, types_1.TransactionStatus.failed].includes(status)) {
+        if (status &&
+            [types_1.TransactionStatus.submitted, types_1.TransactionStatus.failed].includes(status)) {
             this.messagingSystem.publish(`${controllerName}:transactionFinished`, updatedTransactionMeta);
             __classPrivateFieldGet(this, _TransactionController_internalEvents, "f").emit(`${updatedTransactionMeta.id}:finished`, updatedTransactionMeta);
         }
+        return updatedTransactionMeta;
     }
     /**
      * Search transaction metadata for matching entries.
@@ -1380,7 +1393,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));
-            if (!this.beforePublish(transactionMeta)) {
+            if (!(await this.beforePublish(transactionMeta))) {
                 (0, logger_1.projectLogger)('Skipping publishing transaction based on hook');
                 this.messagingSystem.publish(`${controllerName}:transactionPublishingSkipped`, transactionMeta);
                 return ApprovalState.SkippedViaBeforePublishHook;
@@ -1966,7 +1979,6 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_me
         }),
         hooks: {
             beforeCheckPendingTransaction: this.beforeCheckPendingTransaction.bind(this),
-            beforePublish: this.beforePublish.bind(this),
         },
     });
     __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_addPendingTransactionTrackerListeners).call(this, pendingTransactionTracker);
@@ -2184,6 +2196,8 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_me
         isSimulationEnabled: __classPrivateFieldGet(this, _TransactionController_isSimulationEnabled, "f").call(this),
         txMeta: transactionMeta,
     });
+}, _TransactionController_registerActionHandlers = function _TransactionController_registerActionHandlers() {
+    this.messagingSystem.registerActionHandler(`${controllerName}:updateCustodialTransaction`, this.updateCustodialTransaction.bind(this));
 }, _TransactionController_deleteTransaction = function _TransactionController_deleteTransaction(transactionId) {
     this.update((state) => {
         const transactions = state.transactions.filter(({ id }) => id !== transactionId);