@metamask/transaction-controller 38.0.0 → 38.1.0

package/CHANGELOG.md

@@ -7,6 +7,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [38.1.0]
+
+### Added
+
+- Automatically re-simulate transactions based on security criteria ([#4792](https://github.com/MetaMask/core/pull/4792))
+  - If the security provider marks the transaction as malicious.
+  - If the simulated native balance change does not match the `value`.
+  - Set new `isUpdatedAfterSecurityCheck` property to `true` if the subsequent simulation response has changed.
+
+### Changed
+
+- Bump `@metamask/eth-json-rpc-provider` from `^4.1.5` to `^4.1.6` ([#4862](https://github.com/MetaMask/core/pull/4862))
+- Bump `@metamask/approval-controller` from `^7.1.0` to `^7.1.1` ([#4862](https://github.com/MetaMask/core/pull/4862))
+- Bump `@metamask/controller-utils` from `^11.4.0` to `^11.4.1` ([#4862](https://github.com/MetaMask/core/pull/4862))
+- Bump `@metamask/base-controller` from `7.0.1` to `^7.0.2` ([#4862](https://github.com/MetaMask/core/pull/4862))
+
 ## [38.0.0]
 
 ### Changed
@@ -1072,7 +1088,8 @@ 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@38.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@38.1.0...HEAD
+[38.1.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@38.0.0...@metamask/transaction-controller@38.1.0
 [38.0.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@37.3.0...@metamask/transaction-controller@38.0.0
 [37.3.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@37.2.0...@metamask/transaction-controller@37.3.0
 [37.2.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@37.1.0...@metamask/transaction-controller@37.2.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_incomingTransactionOptions, _TransactionController_pendingTransactionOptions, _TransactionController_trace, _TransactionController_transactionHistoryLimit, _TransactionController_isSimulationEnabled, _TransactionController_testGasFeeFlows, _TransactionController_multichainTrackingHelper, _TransactionController_retryTransaction, _TransactionController_createNonceTracker, _TransactionController_createIncomingTransactionHelper, _TransactionController_createPendingTransactionTracker, _TransactionController_checkForPendingTransactionAndStartPolling, _TransactionController_stopAllTracking, _TransactionController_removeIncomingTransactionHelperListeners, _TransactionController_addIncomingTransactionHelperListeners, _TransactionController_removePendingTransactionTrackerListeners, _TransactionController_addPendingTransactionTrackerListeners, _TransactionController_getNonceTrackerPendingTransactions, _TransactionController_getGasFeeFlows, _TransactionController_getLayer1GasFeeFlows, _TransactionController_updateTransactionInternal, _TransactionController_checkIfTransactionParamsUpdated, _TransactionController_onTransactionParamsUpdated, _TransactionController_updateSimulationData, _TransactionController_onGasFeePollerTransactionUpdate, _TransactionController_getNetworkClientId, _TransactionController_getGlobalNetworkClientId, _TransactionController_getGlobalChainId, _TransactionController_isCustomNetwork, _TransactionController_getSelectedAccount, _TransactionController_updateSubmitHistory;
+var _TransactionController_instances, _TransactionController_internalEvents, _TransactionController_incomingTransactionOptions, _TransactionController_pendingTransactionOptions, _TransactionController_trace, _TransactionController_transactionHistoryLimit, _TransactionController_isSimulationEnabled, _TransactionController_testGasFeeFlows, _TransactionController_multichainTrackingHelper, _TransactionController_retryTransaction, _TransactionController_createNonceTracker, _TransactionController_createIncomingTransactionHelper, _TransactionController_createPendingTransactionTracker, _TransactionController_checkForPendingTransactionAndStartPolling, _TransactionController_stopAllTracking, _TransactionController_removeIncomingTransactionHelperListeners, _TransactionController_addIncomingTransactionHelperListeners, _TransactionController_removePendingTransactionTrackerListeners, _TransactionController_addPendingTransactionTrackerListeners, _TransactionController_getNonceTrackerPendingTransactions, _TransactionController_getGasFeeFlows, _TransactionController_getLayer1GasFeeFlows, _TransactionController_updateTransactionInternal, _TransactionController_updateSimulationData, _TransactionController_onGasFeePollerTransactionUpdate, _TransactionController_getNetworkClientId, _TransactionController_getGlobalNetworkClientId, _TransactionController_getGlobalChainId, _TransactionController_isCustomNetwork, _TransactionController_getSelectedAccount, _TransactionController_updateSubmitHistory;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TransactionController = exports.ApprovalState = exports.SPEED_UP_RATE = exports.CANCEL_RATE = exports.HARDFORK = void 0;
 const common_1 = require("@ethereumjs/common");
@@ -50,6 +50,7 @@ const gas_flow_1 = require("./utils/gas-flow.cjs");
 const history_1 = require("./utils/history.cjs");
 const layer1_gas_fee_flow_1 = require("./utils/layer1-gas-fee-flow.cjs");
 const nonce_1 = require("./utils/nonce.cjs");
+const resimulate_1 = require("./utils/resimulate.cjs");
 const retry_1 = require("./utils/retry.cjs");
 const simulation_1 = require("./utils/simulation.cjs");
 const swaps_1 = require("./utils/swaps.cjs");
@@ -1931,19 +1932,21 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_in
     return [new LineaGasFeeFlow_1.LineaGasFeeFlow(), new DefaultGasFeeFlow_1.DefaultGasFeeFlow()];
 }, _TransactionController_getLayer1GasFeeFlows = function _TransactionController_getLayer1GasFeeFlows() {
     return [new OptimismLayer1GasFeeFlow_1.OptimismLayer1GasFeeFlow(), new ScrollLayer1GasFeeFlow_1.ScrollLayer1GasFeeFlow()];
-}, _TransactionController_updateTransactionInternal = function _TransactionController_updateTransactionInternal({ transactionId, note, skipHistory, skipValidation, }, callback) {
-    let updatedTransactionParams = [];
+}, _TransactionController_updateTransactionInternal = function _TransactionController_updateTransactionInternal({ transactionId, note, skipHistory, skipValidation, skipResimulateCheck, }, callback) {
+    let resimulateResponse;
     this.update((state) => {
         const index = state.transactions.findIndex(({ id }) => id === transactionId);
         let transactionMeta = state.transactions[index];
+        const originalTransactionMeta = (0, lodash_1.cloneDeep)(transactionMeta);
         // eslint-disable-next-line n/callback-return
         transactionMeta = callback(transactionMeta) ?? transactionMeta;
         if (skipValidation !== true) {
             transactionMeta.txParams = (0, utils_2.normalizeTransactionParams)(transactionMeta.txParams);
             (0, validation_1.validateTxParams)(transactionMeta.txParams);
         }
-        updatedTransactionParams =
-            __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_checkIfTransactionParamsUpdated).call(this, transactionMeta);
+        if (!skipResimulateCheck && __classPrivateFieldGet(this, _TransactionController_isSimulationEnabled, "f").call(this)) {
+            resimulateResponse = (0, resimulate_1.shouldResimulate)(originalTransactionMeta, transactionMeta);
+        }
         const shouldSkipHistory = this.isHistoryDisabled || skipHistory;
         if (!shouldSkipHistory) {
             transactionMeta = (0, history_1.updateTransactionHistory)(transactionMeta, note ?? 'Transaction updated');
@@ -1951,30 +1954,17 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_in
         state.transactions[index] = transactionMeta;
     });
     const transactionMeta = this.getTransaction(transactionId);
-    if (updatedTransactionParams.length > 0) {
-        __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_onTransactionParamsUpdated).call(this, transactionMeta, updatedTransactionParams);
-    }
-    return transactionMeta;
-}, _TransactionController_checkIfTransactionParamsUpdated = function _TransactionController_checkIfTransactionParamsUpdated(newTransactionMeta) {
-    const { id: transactionId, txParams: newParams } = newTransactionMeta;
-    const originalParams = this.getTransaction(transactionId)?.txParams;
-    if (!originalParams || (0, lodash_1.isEqual)(originalParams, newParams)) {
-        return [];
-    }
-    const params = Object.keys(newParams);
-    const updatedProperties = params.filter((param) => newParams[param] !== originalParams[param]);
-    (0, logger_1.projectLogger)('Transaction parameters have been updated', transactionId, updatedProperties, originalParams, newParams);
-    return updatedProperties;
-}, _TransactionController_onTransactionParamsUpdated = function _TransactionController_onTransactionParamsUpdated(transactionMeta, updatedParams) {
-    if (['to', 'value', 'data'].some((param) => updatedParams.includes(param))) {
-        (0, logger_1.projectLogger)('Updating simulation data due to transaction parameter update');
-        __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_updateSimulationData).call(this, transactionMeta).catch((error) => {
-            (0, logger_1.projectLogger)('Error updating simulation data', error);
+    if (resimulateResponse?.resimulate) {
+        __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_updateSimulationData).call(this, transactionMeta, {
+            blockTime: resimulateResponse.blockTime,
+        }).catch((error) => {
+            (0, logger_1.projectLogger)('Error during re-simulation', error);
             throw error;
         });
     }
-}, _TransactionController_updateSimulationData = async function _TransactionController_updateSimulationData(transactionMeta, { traceContext } = {}) {
-    const { id: transactionId, chainId, txParams } = transactionMeta;
+    return transactionMeta;
+}, _TransactionController_updateSimulationData = async function _TransactionController_updateSimulationData(transactionMeta, { blockTime, traceContext, } = {}) {
+    const { id: transactionId, chainId, txParams, simulationData: prevSimulationData, } = transactionMeta;
     const { from, to, value, data } = txParams;
     let simulationData = {
         error: {
@@ -1984,16 +1974,23 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_in
         tokenBalanceChanges: [],
     };
     if (__classPrivateFieldGet(this, _TransactionController_isSimulationEnabled, "f").call(this)) {
-        __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_updateTransactionInternal).call(this, { transactionId, skipHistory: true }, (txMeta) => {
-            txMeta.simulationData = undefined;
-        });
         simulationData = await __classPrivateFieldGet(this, _TransactionController_trace, "f").call(this, { name: 'Simulate', parentContext: traceContext }, () => (0, simulation_1.getSimulationData)({
             chainId,
             from: from,
             to: to,
             value: value,
             data: data,
+        }, {
+            blockTime,
         }));
+        if (blockTime &&
+            prevSimulationData &&
+            (0, resimulate_1.hasSimulationDataChanged)(prevSimulationData, simulationData)) {
+            simulationData = {
+                ...simulationData,
+                isUpdatedAfterSecurityCheck: true,
+            };
+        }
     }
     const finalTransactionMeta = this.getTransaction(transactionId);
     /* istanbul ignore if */
@@ -2004,6 +2001,7 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_in
     __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_updateTransactionInternal).call(this, {
         transactionId,
         note: 'TransactionController#updateSimulationData - Update simulation data',
+        skipResimulateCheck: Boolean(blockTime),
     }, (txMeta) => {
         txMeta.simulationData = simulationData;
     });