@metamask-previews/transaction-controller 37.3.0-preview-c77aebdb → 37.3.0-preview-8518e617

package/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- **BREAKING:** Bump `@metamask/network-controller` peer dependency from `^21.0.0` to `^22.0.0` ([#4841](https://github.com/MetaMask/core/pull/4841))
+
 ## [37.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_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_shouldReSimulateDueToThreshold, _TransactionController_shouldReSimulateDueToSecurityAlert, _TransactionController_isSecurityAlertUpdated, _TransactionController_isSimulationUpdated, _TransactionController_shouldReSimulateDueToTxParamUpdate, _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");
@@ -1932,7 +1932,9 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_in
 }, _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 = [];
+    let isReSimulateNeedDueToTxParamsUpdated = false;
+    let isReSimulateNeedDueToSecurityAlert = false;
+    let isReSimulateNeedDueToThreshold = false;
     this.update((state) => {
         const index = state.transactions.findIndex(({ id }) => id === transactionId);
         let transactionMeta = state.transactions[index];
@@ -1942,8 +1944,12 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_in
             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);
+        isReSimulateNeedDueToTxParamsUpdated =
+            __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_shouldReSimulateDueToTxParamUpdate).call(this, transactionMeta);
+        isReSimulateNeedDueToSecurityAlert =
+            __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_shouldReSimulateDueToSecurityAlert).call(this, transactionMeta);
+        isReSimulateNeedDueToThreshold =
+            __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_shouldReSimulateDueToThreshold).call(this, transactionMeta);
         const shouldSkipHistory = this.isHistoryDisabled || skipHistory;
         if (!shouldSkipHistory) {
             transactionMeta = (0, history_1.updateTransactionHistory)(transactionMeta, note ?? 'Transaction updated');
@@ -1951,31 +1957,73 @@ _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);
+    if (isReSimulateNeedDueToTxParamsUpdated ||
+        isReSimulateNeedDueToSecurityAlert ||
+        isReSimulateNeedDueToThreshold) {
+        __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_updateSimulationData).call(this, transactionMeta, {
+            isReSimulatedDueToSecurityAlert: isReSimulateNeedDueToSecurityAlert,
+            isReSimulatedDueToThreshold: isReSimulateNeedDueToThreshold,
+        }).catch((error) => {
+            (0, logger_1.projectLogger)('Error updating simulation data', error);
+            throw error;
+        });
     }
     return transactionMeta;
-}, _TransactionController_checkIfTransactionParamsUpdated = function _TransactionController_checkIfTransactionParamsUpdated(newTransactionMeta) {
+}, _TransactionController_shouldReSimulateDueToThreshold = function _TransactionController_shouldReSimulateDueToThreshold(transactionMeta) {
+    const isSimulationUpdated = __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_isSimulationUpdated).call(this, transactionMeta);
+    if (!isSimulationUpdated) {
+        return false;
+    }
+    const { simulationData, txParams: { value }, } = transactionMeta;
+    const isSimulationDataAvailable = Boolean(simulationData);
+    const simulationNativeBalanceDifference = simulationData?.nativeBalanceChange?.difference;
+    const isTxValueAndSimulationNativeBalanceDefined = value !== undefined && simulationNativeBalanceDifference !== undefined;
+    const isTxValueVsBalanceAbovePercentageThreshold = isTxValueAndSimulationNativeBalanceDefined &&
+        !(0, utils_2.isPercentageDifferenceWithinThreshold)(simulationNativeBalanceDifference, value, 5);
+    return (isSimulationDataAvailable && isTxValueVsBalanceAbovePercentageThreshold);
+}, _TransactionController_shouldReSimulateDueToSecurityAlert = function _TransactionController_shouldReSimulateDueToSecurityAlert(transactionMeta) {
+    const isSecurityAlertUpdated = __classPrivateFieldGet(this, _TransactionController_instances, "m", _TransactionController_isSecurityAlertUpdated).call(this, transactionMeta);
+    if (!isSecurityAlertUpdated) {
+        return false;
+    }
+    const { securityAlertResponse } = transactionMeta;
+    const isMaliciousTransfer = securityAlertResponse?.result_type === types_1.BLOCKAID_RESULT_TYPE_MALICIOUS;
+    return isMaliciousTransfer;
+}, _TransactionController_isSecurityAlertUpdated = function _TransactionController_isSecurityAlertUpdated(newTransactionMeta) {
+    const { id: transactionId, securityAlertResponse: newSecurityAlertResponse, } = (0, lodash_1.cloneDeep)(newTransactionMeta);
+    const { securityAlertResponse: originalSecurityAlertResponse } = (0, lodash_1.cloneDeep)(this.getTransaction(transactionId));
+    return !(0, lodash_1.isEqual)(originalSecurityAlertResponse, newSecurityAlertResponse);
+}, _TransactionController_isSimulationUpdated = function _TransactionController_isSimulationUpdated(newTransactionMeta) {
+    const { id: transactionId, simulationData: newSimulationData } = (0, lodash_1.cloneDeep)(newTransactionMeta);
+    const newTransactionProps = {
+        simulationData: newSimulationData,
+        simulationNativeBalanceDifference: newSimulationData?.nativeBalanceChange?.difference,
+    };
+    const { simulationData: originalSimulationData } = (0, lodash_1.cloneDeep)(this.getTransaction(transactionId));
+    const originalTransactionProps = {
+        simulationData: originalSimulationData,
+        simulationNativeBalanceDifference: originalSimulationData?.nativeBalanceChange?.difference,
+    };
+    // Skip the case where simulationData fetch started
+    const shouldSkip = !newTransactionProps.simulationData;
+    if (shouldSkip) {
+        return false;
+    }
+    return !(0, lodash_1.isEqual)(originalTransactionProps, newTransactionProps);
+}, _TransactionController_shouldReSimulateDueToTxParamUpdate = function _TransactionController_shouldReSimulateDueToTxParamUpdate(newTransactionMeta) {
     const { id: transactionId, txParams: newParams } = newTransactionMeta;
     const originalParams = this.getTransaction(transactionId)?.txParams;
     if (!originalParams || (0, lodash_1.isEqual)(originalParams, newParams)) {
-        return [];
+        return false;
     }
     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);
-            throw error;
-        });
-    }
-}, _TransactionController_updateSimulationData = async function _TransactionController_updateSimulationData(transactionMeta, { traceContext } = {}) {
-    const { id: transactionId, chainId, txParams } = transactionMeta;
+    return ['to', 'value', 'data'].some((param) => updatedProperties.includes(param));
+}, _TransactionController_updateSimulationData = async function _TransactionController_updateSimulationData(transactionMeta, { traceContext, isReSimulatedDueToSecurityAlert, isReSimulatedDueToThreshold, } = {}) {
+    const { id: transactionId, chainId, txParams, simulationData: prevSimulationData, } = transactionMeta;
     const { from, to, value, data } = txParams;
+    const isReSimulatedDueToSecurity = Boolean(isReSimulatedDueToSecurityAlert || isReSimulatedDueToThreshold);
     let simulationData = {
         error: {
             code: types_1.SimulationErrorCode.Disabled,
@@ -1993,7 +2041,15 @@ _TransactionController_internalEvents = new WeakMap(), _TransactionController_in
             to: to,
             value: value,
             data: data,
+        }, {
+            isReSimulatedDueToSecurity,
         }));
+        if (prevSimulationData && !(0, lodash_1.isEqual)(simulationData, prevSimulationData)) {
+            simulationData = {
+                ...simulationData,
+                isReSimulatedDueToSecurity,
+            };
+        }
     }
     const finalTransactionMeta = this.getTransaction(transactionId);
     /* istanbul ignore if */