fix: Add simulation retrigger

packages/notification-services-controller/package.json

@@ -102,7 +102,7 @@
  "@contentful/rich-text-html-renderer": "^16.5.2",
  "@metamask/base-controller": "^7.0.1",
  "@metamask/controller-utils": "^11.3.0",
- "bignumber.js": "^4.1.0",
+ "bignumber.js": "^9.1.2",
  "firebase": "^10.11.0",
  "loglevel": "^1.8.1",
  "uuid": "^8.3.2"

packages/transaction-controller/package.json

@@ -61,6 +61,7 @@
  "@metamask/rpc-errors": "^6.3.1",
  "@metamask/utils": "^9.1.0",
  "async-mutex": "^0.5.0",
+ "bignumber.js": "^9.1.2",
  "bn.js": "^5.2.1",
  "eth-method-registry": "^4.0.0",
  "fast-json-patch": "^3.1.1",

packages/transaction-controller/src/TransactionController.test.ts

@@ -36,6 +36,7 @@ import { errorCodes, providerErrors, rpcErrors } from '@metamask/rpc-errors';
 import type { Hex } from '@metamask/utils';
 import { createDeferredPromise } from '@metamask/utils';
 import assert from 'assert';
+import { merge } from 'lodash';
 import * as uuidModule from 'uuid';
 
 import { FakeBlockTracker } from '../../../tests/fake-block-tracker';
@@ -73,6 +74,7 @@ import type {
  SubmitHistoryEntry,
 } from './types';
 import {
+ BLOCKAID_RESULT_TYPE_MALICIOUS,
  GasFeeEstimateType,
  SimulationErrorCode,
  SimulationTokenStandard,
@@ -5030,6 +5032,230 @@ describe('TransactionController', () => {
  'Cannot update security alert response as no transaction metadata found',
  );
  });
+
+ describe('should not trigger simulation data update', () => {
+ it('when simulationData is not available', async () => {
+ const transactionMeta = TRANSACTION_META_MOCK;
+
+ const { controller } = setupController({
+ options: {
+ state: {
+ transactions: [transactionMeta],
+ },
+ },
+ });
+
+ controller.updateSecurityAlertResponse(transactionMeta.id, {
+ reason: 'NA',
+ // This is API specific hence naming convention is not followed.
+ // eslint-disable-next-line @typescript-eslint/naming-convention
+ result_type: BLOCKAID_RESULT_TYPE_MALICIOUS,
+ });
+
+ expect(getSimulationDataMock).toHaveBeenCalledTimes(0);
+ });
+
+ it('when security alert response type is not malicious', async () => {
+ const transactionMetaWithSimulationData = merge(
+ {},
+ TRANSACTION_META_MOCK,
+ {
+ txParams: {
+ value: '0x0',
+ },
+ simulationData: {
+ tokenBalanceChanges: [],
+ nativeBalanceChange: {
+ difference: '0x0',
+ },
+ },
+ },
+ );
+
+ getSimulationDataMock.mockResolvedValueOnce(SIMULATION_DATA_MOCK);
+
+ const { controller } = setupController({
+ options: {
+ state: {
+ transactions: [transactionMetaWithSimulationData],
+ },
+ },
+ });
+
+ controller.updateSecurityAlertResponse(
+ transactionMetaWithSimulationData.id,
+ {
+ reason: 'NA',
+ // This is API specific hence naming convention is not followed.
+ // eslint-disable-next-line @typescript-eslint/naming-convention
+ result_type: 'warning',
+ },
+ );
+
+ expect(getSimulationDataMock).toHaveBeenCalledTimes(0);
+ });
+
+ it('when transaction value and simulated native balance change within threshold', async () => {
+ const transactionMetaWithSimulationData = merge(
+ {},
+ TRANSACTION_META_MOCK,
+ {
+ txParams: {
+ value: '0x12345678',
+ },
+ simulationData: {
+ tokenBalanceChanges: [],
+ nativeBalanceChange: {
+ difference: '0x12345178',
+ },
+ },
+ },
+ );
+
+ getSimulationDataMock.mockResolvedValueOnce(SIMULATION_DATA_MOCK);
+
+ const { controller } = setupController({
+ options: {
+ state: {
+ transactions: [transactionMetaWithSimulationData],
+ },
+ },
+ });
+
+ controller.updateSecurityAlertResponse(
+ transactionMetaWithSimulationData.id,
+ {
+ reason: 'NA',
+ // This is API specific hence naming convention is not followed.
+ // eslint-disable-next-line @typescript-eslint/naming-convention
+ result_type: BLOCKAID_RESULT_TYPE_MALICIOUS,
+ },
+ );
+
+ expect(getSimulationDataMock).toHaveBeenCalledTimes(0);
+ });
+ });
+
+ it('should retrigger simulation data update when result_type is malicious and simulated transaction value above threshold', async () => {
+ const transactionMetaWithSimulationData = merge(
+ {},
+ TRANSACTION_META_MOCK,
+ {
+ txParams: {
+ value: '0x012',
+ },
+ simulationData: {
+ tokenBalanceChanges: [],
+ nativeBalanceChange: {
+ difference: '0x012345',
+ },
+ },
+ },
+ );
+
+ getSimulationDataMock.mockResolvedValueOnce(SIMULATION_DATA_MOCK);
+
+ const { controller } = setupController({
+ options: {
+ state: {
+ transactions: [transactionMetaWithSimulationData],
+ },
+ },
+ });
+
+ controller.updateSecurityAlertResponse(
+ transactionMetaWithSimulationData.id,
+ {
+ reason: 'NA',
+ // This is API specific hence naming convention is not followed.
+ // eslint-disable-next-line @typescript-eslint/naming-convention
+ result_type: BLOCKAID_RESULT_TYPE_MALICIOUS,
+ },
+ );
+
+ await flushPromises();
+
+ expect(getSimulationDataMock).toHaveBeenCalledTimes(1);
+ });
+
+ describe('should mark simulationDataChanged after security alert update', () => {
+ it('as true if simulationData updated', async () => {
+ // Assume that previous simulationData tells that transaction has no token balance changes
+ const transactionMetaWithSimulationData = merge(
+ {},
+ TRANSACTION_META_MOCK,
+ {
+ txParams: {
+ value: '0x0',
+ },
+ simulationData: {
+ tokenBalanceChanges: [],
+ nativeBalanceChange: {
+ difference: '0x012345',
+ },
+ },
+ },
+ );
+
+ getSimulationDataMock.mockResolvedValueOnce(SIMULATION_DATA_MOCK);
+
+ const { controller } = setupController({
+ options: {
+ state: {
+ transactions: [transactionMetaWithSimulationData],
+ },
+ },
+ });
+
+ controller.updateSecurityAlertResponse(
+ transactionMetaWithSimulationData.id,
+ {
+ reason: 'NA',
+ // This is API specific hence naming convention is not followed.
+ // eslint-disable-next-line @typescript-eslint/naming-convention
+ result_type: BLOCKAID_RESULT_TYPE_MALICIOUS,
+ },
+ );
+
+ await flushPromises();
+
+ expect(
+ controller.state.transactions[0].simulationData
+ ?.isReSimulatedDueToSecurityAlert,
+ ).toBe(true);
+ });
+
+ it('as undefined if current and new simulationData equality check is false', async () => {
+ // Assume that previous simulationData tells that transaction has some token balance changes
+ const transactionMeta = merge({}, TRANSACTION_META_MOCK, {
+ simulationData: SIMULATION_DATA_MOCK,
+ });
+
+ getSimulationDataMock.mockResolvedValueOnce(SIMULATION_DATA_MOCK);
+
+ const { controller } = setupController({
+ options: {
+ state: {
+ transactions: [transactionMeta],
+ },
+ },
+ });
+
+ controller.updateSecurityAlertResponse(transactionMeta.id, {
+ reason: 'NA',
+ // This is API specific hence naming convention is not followed.
+ // eslint-disable-next-line @typescript-eslint/naming-convention
+ result_type: BLOCKAID_RESULT_TYPE_MALICIOUS,
+ });
+
+ await flushPromises();
+
+ expect(
+ controller.state.transactions[0].simulationData
+ ?.isReSimulatedDueToSecurityAlert,
+ ).toBeUndefined();
+ });
+ });
  });
 
  describe('updateCustodialTransaction', () => {