fix: mark transactions as failed for cancelled / unknown smart transa…

…ctions (#12664) ## **Description** Resolves an issue with stuck transactions for some users who used smart transactions, which was caused by having [this PR](#12274) in the 7.36.0 release even when it was marked for 7.37.0 by metamaskbot. ## **Related issues** Fixes: ## **Manual testing steps** 1. Cancelled transaction stuck thanks to super low gas settings 2. All other submitted transactions afterwards as well with the invalid_nonce error. 3. Upgrade to 7.37.1 and see all cancelled tx 4. Try a new tx ## **Screenshots/Recordings**  ### **Before** https://consensys.slack.com/archives/C084S32G337/p1734034013370979 ### **After** https://consensys.slack.com/archives/C084S32G337/p1734039388196979 ## **Pre-merge author checklist** - [ ] I’ve followed [MetaMask Contributor Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Mobile Coding Standards](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/CODING_GUIDELINES.md). - [ ] I've completed the PR template to the best of my ability - [ ] I’ve included tests if applicable - [ ] I’ve documented my code using [JSDoc](https://jsdoc.app/) format if applicable - [ ] I’ve applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/LABELING_GUIDELINES.md)). Not required for external contributors. ## **Pre-merge reviewer checklist** - [ ] I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed). - [ ] I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.
MetaMask · Dec 12, 2024 · cfb77b9 · cfb77b9
1 parent ea18201
commit cfb77b9
Show file tree

Hide file tree

Showing 3 changed files with 391 additions and 0 deletions.
diff --git a/app/store/migrations/063.test.ts b/app/store/migrations/063.test.ts
@@ -0,0 +1,297 @@
+import migrate from './063';
+import { merge } from 'lodash';
+import { captureException } from '@sentry/react-native';
+import initialRootState from '../../util/test/initial-root-state';
+import { SmartTransactionStatuses } from '@metamask/smart-transactions-controller/dist/types';
+import { TransactionStatus, CHAIN_IDS } from '@metamask/transaction-controller';
+
+const expectedState = {
+  engine: {
+    backgroundState: {
+      TransactionController: {
+        transactions: [
+          {
+            chainId: CHAIN_IDS.MAINNET,
+            id: '1',
+            origin: 'test.com',
+            status: TransactionStatus.confirmed,
+            time: 1631714312,
+            txParams: {
+              from: '0x1',
+            },
+            hash: '0x2',
+            rawTx: '0x3',
+          },
+          {
+            chainId: CHAIN_IDS.LINEA_MAINNET,
+            id: '2',
+            origin: 'test.com',
+            status: TransactionStatus.confirmed,
+            time: 1631714312,
+            txParams: {
+              from: '0x1',
+            },
+            hash: '0x3',
+          },
+          {
+            chainId: CHAIN_IDS.MAINNET,
+            id: '3',
+            origin: 'test2.com',
+            status: TransactionStatus.failed,
+            time: 1631714313,
+            txParams: {
+              from: '0x6',
+            },
+            hash: '0x4',
+            rawTx: '0x5',
+            error: {
+              name: 'SmartTransactionCancelled',
+              message:
+                'Smart transaction cancelled. Previous status: submitted',
+            },
+          },
+          {
+            chainId: CHAIN_IDS.MAINNET,
+            id: '4',
+            origin: 'test2.com',
+            status: TransactionStatus.failed,
+            time: 1631714313,
+            txParams: {
+              from: '0x6',
+            },
+            hash: '0x5',
+            rawTx: '0x6',
+            error: {
+              name: 'SmartTransactionCancelled',
+              message: 'Smart transaction cancelled. Previous status: signed',
+            },
+          },
+          {
+            chainId: CHAIN_IDS.MAINNET,
+            id: '5',
+            origin: 'test2.com',
+            status: TransactionStatus.failed,
+            time: 1631714313,
+            txParams: {
+              from: '0x6',
+            },
+            hash: '0x6',
+            rawTx: '0x7',
+            error: {
+              name: 'SmartTransactionCancelled',
+              message: 'Smart transaction cancelled. Previous status: signed',
+            },
+          },
+        ],
+      },
+      SmartTransactionsController: {
+        smartTransactionsState: {
+          smartTransactions: {
+            [CHAIN_IDS.MAINNET]: [
+              {
+                txHash: '0x2',
+                status: SmartTransactionStatuses.SUCCESS,
+              },
+              {
+                txHash: '0x4',
+                status: SmartTransactionStatuses.CANCELLED,
+              },
+              {
+                txHash: '0x5',
+                status: SmartTransactionStatuses.CANCELLED,
+              },
+              {
+                txHash: '0x6',
+                status: SmartTransactionStatuses.UNKNOWN,
+              },
+            ],
+          },
+        },
+      },
+    },
+  },
+};
+
+jest.mock('@sentry/react-native', () => ({
+  captureException: jest.fn(),
+}));
+const mockedCaptureException = jest.mocked(captureException);
+
+describe('Migration #63', () => {
+  beforeEach(() => {
+    jest.restoreAllMocks();
+    jest.resetAllMocks();
+  });
+
+  const invalidStates = [
+    {
+      state: null,
+      errorMessage: "FATAL ERROR: Migration 63: Invalid state error: 'object'",
+      scenario: 'state is invalid',
+    },
+    {
+      state: merge({}, initialRootState, {
+        engine: null,
+      }),
+      errorMessage:
+        "FATAL ERROR: Migration 63: Invalid engine state error: 'object'",
+      scenario: 'engine state is invalid',
+    },
+    {
+      state: merge({}, initialRootState, {
+        engine: {
+          backgroundState: null,
+        },
+      }),
+      errorMessage:
+        "FATAL ERROR: Migration 63: Invalid engine backgroundState error: 'object'",
+      scenario: 'backgroundState is invalid',
+    },
+    {
+      state: merge({}, initialRootState, {
+        engine: {
+          backgroundState: { TransactionController: null },
+        },
+      }),
+      errorMessage: "Migration 63: Invalid TransactionController state: 'null'",
+      scenario: 'transactionController is invalid',
+    },
+    {
+      state: merge({}, initialRootState, {
+        engine: {
+          backgroundState: { SmartTransactionsController: null },
+        },
+      }),
+      errorMessage:
+        "Migration 63: Invalid SmartTransactionsController state: 'null'",
+      scenario: 'smartTransactionsController is invalid',
+    },
+    {
+      state: merge({}, initialRootState, {
+        engine: {
+          backgroundState: {
+            SmartTransactionsController: {
+              smartTransactionsState: { smartTransactions: null },
+            },
+          },
+        },
+      }),
+      errorMessage:
+        "Migration 63: Missing smart transactions property from SmartTransactionsController: 'object'",
+      scenario:
+        'smartTransactionsController.smartTransactionsState.smartTransactions is invalid',
+    },
+  ];
+  it.each(invalidStates)(
+    'captures exception if $scenario',
+    ({ errorMessage, state }) => {
+      const newState = migrate(state);
+
+      expect(newState).toStrictEqual(state);
+      expect(mockedCaptureException).toHaveBeenCalledWith(expect.any(Error));
+      expect(mockedCaptureException.mock.calls[0][0].message).toBe(
+        errorMessage,
+      );
+    },
+  );
+
+  it('applies migration, changes transaction status to failed if a smart transaction was cancelled or unknown', () => {
+    const oldState = {
+      engine: {
+        backgroundState: {
+          TransactionController: {
+            transactions: [
+              {
+                chainId: CHAIN_IDS.MAINNET,
+                id: '1',
+                origin: 'test.com',
+                status: TransactionStatus.confirmed,
+                time: 1631714312,
+                txParams: {
+                  from: '0x1',
+                },
+                hash: '0x2',
+                rawTx: '0x3',
+              },
+              {
+                chainId: CHAIN_IDS.LINEA_MAINNET,
+                id: '2',
+                origin: 'test.com',
+                status: TransactionStatus.confirmed,
+                time: 1631714312,
+                txParams: {
+                  from: '0x1',
+                },
+                hash: '0x3',
+              },
+              {
+                chainId: CHAIN_IDS.MAINNET,
+                id: '3',
+                origin: 'test2.com',
+                status: TransactionStatus.submitted,
+                time: 1631714313,
+                txParams: {
+                  from: '0x6',
+                },
+                hash: '0x4',
+                rawTx: '0x5',
+              },
+              {
+                chainId: CHAIN_IDS.MAINNET,
+                id: '4',
+                origin: 'test2.com',
+                status: TransactionStatus.signed,
+                time: 1631714313,
+                txParams: {
+                  from: '0x6',
+                },
+                hash: '0x5',
+                rawTx: '0x6',
+              },
+              {
+                chainId: CHAIN_IDS.MAINNET,
+                id: '5',
+                origin: 'test2.com',
+                status: TransactionStatus.signed,
+                time: 1631714313,
+                txParams: {
+                  from: '0x6',
+                },
+                hash: '0x6',
+                rawTx: '0x7',
+              },
+            ],
+          },
+          SmartTransactionsController: {
+            smartTransactionsState: {
+              smartTransactions: {
+                [CHAIN_IDS.MAINNET]: [
+                  {
+                    txHash: '0x2',
+                    status: SmartTransactionStatuses.SUCCESS,
+                  },
+                  {
+                    txHash: '0x4',
+                    status: SmartTransactionStatuses.CANCELLED,
+                  },
+                  {
+                    txHash: '0x5',
+                    status: SmartTransactionStatuses.CANCELLED,
+                  },
+                  {
+                    txHash: '0x6',
+                    status: SmartTransactionStatuses.UNKNOWN,
+                  },
+                ],
+              },
+            },
+          },
+        },
+      },
+    };
+
+    const newState = migrate(oldState);
+
+    expect(newState).toStrictEqual(expectedState);
+  });
+});
diff --git a/app/store/migrations/063.ts b/app/store/migrations/063.ts
@@ -0,0 +1,92 @@
+import { isObject } from '@metamask/utils';
+import { captureException } from '@sentry/react-native';
+import { ensureValidState } from './util';
+import { SmartTransactionStatuses } from '@metamask/smart-transactions-controller/dist/types';
+import { TransactionStatus, CHAIN_IDS } from '@metamask/transaction-controller';
+
+export default function migrate(state: unknown) {
+  if (!ensureValidState(state, 63)) {
+    return state;
+  }
+
+  if (!isObject(state.engine.backgroundState.TransactionController)) {
+    captureException(
+      new Error(
+        `Migration 63: Invalid TransactionController state: '${state.engine.backgroundState.TransactionController}'`,
+      ),
+    );
+    return state;
+  }
+
+  if (!isObject(state.engine.backgroundState.SmartTransactionsController)) {
+    captureException(
+      new Error(
+        `Migration 63: Invalid SmartTransactionsController state: '${state.engine.backgroundState.SmartTransactionsController}'`,
+      ),
+    );
+    return state;
+  }
+
+  const transactionControllerState =
+    state.engine.backgroundState.TransactionController;
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  const smartTransactionsControllerState = state.engine.backgroundState.SmartTransactionsController as any;
+
+  if (!Array.isArray(transactionControllerState.transactions)) {
+    captureException(
+      new Error(
+        `Migration 63: Missing transactions property from TransactionController: '${typeof state
+          .engine.backgroundState.TransactionController}'`,
+      ),
+    );
+    return state;
+  }
+  const smartTransactions =
+    smartTransactionsControllerState?.smartTransactionsState?.smartTransactions;
+  if (!isObject(smartTransactions)) {
+    captureException(
+      new Error(
+        `Migration 63: Missing smart transactions property from SmartTransactionsController: '${typeof state
+          .engine.backgroundState.SmartTransactionsController?.smartTransactionsState}'`,
+      ),
+    );
+    return state;
+  }
+
+  const ethereumMainnetSmartTransactions = smartTransactions[CHAIN_IDS.MAINNET];
+  if (
+    !Array.isArray(ethereumMainnetSmartTransactions) ||
+    ethereumMainnetSmartTransactions.length === 0
+  ) {
+    // If there are no smart transactions, we can skip this migration.
+    return state;
+  }
+
+  const smartTransactionTxHashesForUpdate: Record<string, boolean> = {};
+  ethereumMainnetSmartTransactions.forEach((smartTransaction) => {
+    if (
+      smartTransaction.txHash &&
+      (smartTransaction.status === SmartTransactionStatuses.CANCELLED ||
+        smartTransaction.status === SmartTransactionStatuses.UNKNOWN)
+    ) {
+      smartTransactionTxHashesForUpdate[smartTransaction.txHash.toLowerCase()] = true;
+    }
+  });
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  transactionControllerState.transactions.forEach((transaction: any) => {
+    if (!transaction.hash || transaction.status === TransactionStatus.failed) {
+      return;
+    }
+    const previousStatus = transaction.status;
+    if (smartTransactionTxHashesForUpdate[transaction.hash.toLowerCase()]) {
+      transaction.status = TransactionStatus.failed;
+      transaction.error = {
+        name: 'SmartTransactionCancelled',
+        message: `Smart transaction cancelled. Previous status: ${previousStatus}`,
+      };
+    }
+  });
+
+  return state;
+}