Update tests, remove unused code

Signed-off-by: dan437 <80175477+dan437@users.noreply.github.com>

Author: dan437

jest.config.js

@@ -2,7 +2,7 @@ module.exports = {
   collectCoverage: true,
   // Ensures that we collect coverage from all source files, not just tested
   // ones.
-  collectCoverageFrom: ['./src/**.ts'],
+  collectCoverageFrom: ['./src/**.ts', '!./src/index.ts'],
   coverageReporters: ['text', 'html'],
   coverageThreshold: {
     global: {

src/SmartTransactionsController.test.ts

@@ -24,7 +24,6 @@ import type {
 import {
   type TransactionParams,
   TransactionStatus,
-  TransactionType,
 } from '@metamask/transaction-controller';
 import nock from 'nock';
 import * as sinon from 'sinon';
@@ -55,15 +54,21 @@ type RootMessenger = Messenger<MockAnyNamespace, AllActions, AllEvents>;
 jest.mock('@metamask/eth-query', () => {
   const EthQuery = jest.requireActual('@metamask/eth-query');
   return class FakeEthQuery extends EthQuery {
-    sendAsync = jest.fn(({ method }, callback) => {
+    sendAsync = jest.fn(({ method, params }, callback) => {
       switch (method) {
         case 'eth_getBalance': {
           callback(null, '0x1000');
           break;
         }
 
         case 'eth_getTransactionReceipt': {
-          callback(null, { blockNumber: '123' });
+          // Return null if txHash is empty/falsy
+          const txHash = params?.[0];
+          if (txHash) {
+            callback(null, { blockNumber: '123' });
+          } else {
+            callback(null, null);
+          }
           break;
         }
 
@@ -307,37 +312,6 @@ const testHistory = [
   },
 ];
 
-const createTransactionMeta = (
-  status: TransactionStatus = TransactionStatus.signed,
-) => {
-  return {
-    hash: txHash,
-    status,
-    id: '1',
-    txParams: {
-      from: addressFrom,
-      to: '0x1678a085c290ebd122dc42cba69373b5953b831d',
-      gasPrice: '0x77359400',
-      gas: '0x7b0d',
-      nonce: '0x4b',
-    },
-    type: TransactionType.simpleSend,
-    chainId: ChainId.mainnet,
-    time: 1624408066355,
-    defaultGasEstimates: {
-      gas: '0x7b0d',
-      gasPrice: '0x77359400',
-    },
-    error: {
-      name: 'Error',
-      message: 'Details of the error',
-    },
-    securityProviderResponse: {
-      flagAsDangerous: 0,
-    },
-  };
-};
-
 const ethereumChainIdDec = parseInt(ChainId.mainnet, 16);
 const sepoliaChainIdDec = parseInt(ChainId.sepolia, 16);
 
@@ -459,6 +433,7 @@ describe('SmartTransactionsController', () => {
 
         controller.timeoutHandle = setTimeout(() => ({}));
 
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises
         controller.poll(1000);
 
         expect(updateSmartTransactionsSpy).toHaveBeenCalled();
@@ -1395,6 +1370,147 @@ describe('SmartTransactionsController', () => {
         },
       );
     });
+
+    it('confirms a smart transaction with SUCCESS status', async () => {
+      const { smartTransactionsState } =
+        getDefaultSmartTransactionsControllerState();
+      const pendingStx = {
+        ...createStateAfterPending()[0],
+        history: testHistory,
+      };
+      await withController(
+        {
+          options: {
+            state: {
+              smartTransactionsState: {
+                ...smartTransactionsState,
+                smartTransactions: {
+                  [ChainId.mainnet]: [pendingStx] as SmartTransaction[],
+                },
+              },
+            },
+          },
+        },
+        async ({ controller }) => {
+          const updateTransaction = {
+            ...pendingStx,
+            statusMetadata: {
+              ...pendingStx.statusMetadata,
+              minedHash: txHash,
+            },
+            status: SmartTransactionStatuses.SUCCESS,
+          };
+
+          controller.updateSmartTransaction(
+            updateTransaction as SmartTransaction,
+            {
+              networkClientId: NetworkType.mainnet,
+            },
+          );
+          await flushPromises();
+
+          expect(
+            controller.state.smartTransactionsState.smartTransactions[
+              ChainId.mainnet
+            ][0].confirmed,
+          ).toBe(true);
+        },
+      );
+    });
+
+    it('confirms a smart transaction with REVERTED status', async () => {
+      const { smartTransactionsState } =
+        getDefaultSmartTransactionsControllerState();
+      const pendingStx = {
+        ...createStateAfterPending()[0],
+        history: testHistory,
+      };
+      await withController(
+        {
+          options: {
+            state: {
+              smartTransactionsState: {
+                ...smartTransactionsState,
+                smartTransactions: {
+                  [ChainId.mainnet]: [pendingStx] as SmartTransaction[],
+                },
+              },
+            },
+          },
+        },
+        async ({ controller }) => {
+          const updateTransaction = {
+            ...pendingStx,
+            statusMetadata: {
+              ...pendingStx.statusMetadata,
+              minedHash: txHash,
+            },
+            status: SmartTransactionStatuses.REVERTED,
+          };
+
+          controller.updateSmartTransaction(
+            updateTransaction as SmartTransaction,
+            {
+              networkClientId: NetworkType.mainnet,
+            },
+          );
+          await flushPromises();
+
+          expect(
+            controller.state.smartTransactionsState.smartTransactions[
+              ChainId.mainnet
+            ][0].confirmed,
+          ).toBe(true);
+        },
+      );
+    });
+
+    it('does not confirm a smart transaction that does not have a minedHash', async () => {
+      const { smartTransactionsState } =
+        getDefaultSmartTransactionsControllerState();
+      const pendingStx = {
+        ...createStateAfterPending()[0],
+        history: testHistory,
+      };
+      await withController(
+        {
+          options: {
+            state: {
+              smartTransactionsState: {
+                ...smartTransactionsState,
+                smartTransactions: {
+                  [ChainId.mainnet]: [pendingStx] as SmartTransaction[],
+                },
+              },
+            },
+          },
+        },
+        async ({ controller }) => {
+          const updateTransaction = {
+            ...pendingStx,
+            statusMetadata: {
+              ...pendingStx.statusMetadata,
+              minedHash: '',
+            },
+            status: SmartTransactionStatuses.SUCCESS,
+          };
+
+          controller.updateSmartTransaction(
+            updateTransaction as SmartTransaction,
+            {
+              networkClientId: NetworkType.mainnet,
+            },
+          );
+          await flushPromises();
+
+          expect(
+            controller.state.smartTransactionsState.smartTransactions[
+              ChainId.mainnet
+            ][0].confirmed,
+          ).toBeUndefined();
+        },
+      );
+    });
   });
 
   describe('cancelSmartTransaction', () => {
@@ -2577,6 +2693,7 @@ async function withController<ReturnValue>(
       triggerNetworStateChange,
     });
   } finally {
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
     controller.stop();
     controller.stopAllPolling();
   }

src/utils.ts

@@ -8,7 +8,6 @@ import type {
 } from '@metamask/transaction-controller';
 import { TransactionStatus } from '@metamask/transaction-controller';
 import { BigNumber } from 'bignumber.js';
-import jsonDiffer from 'fast-json-patch';
 import _ from 'lodash';
 
 // Ignoring TypeScript errors here because this import is disallowed for production builds, because
@@ -114,57 +113,6 @@ export const calculateStatus = (stxStatus: SmartTransactionsStatus) => {
   return SmartTransactionStatuses.UNKNOWN;
 };
 
-/**
-  Generates an array of history objects sense the previous state.
-  The object has the keys
-    op (the operation performed),
-    path (the key and if a nested object then each key will be separated with a `/`)
-    value
-  with the first entry having the note and a timestamp when the change took place
-  @param previousState - the previous state of the object
-  @param newState - the update object
-  @param [note] - a optional note for the state change
-  @returns
-*/
-export function generateHistoryEntry(
-  previousState: any,
-  newState: any,
-  note: string,
-) {
-  const entry: any = jsonDiffer.compare(previousState, newState);
-  // Add a note to the first op, since it breaks if we append it to the entry
-  if (entry[0]) {
-    if (note) {
-      entry[0].note = note;
-    }
-
-    entry[0].timestamp = Date.now();
-  }
-  return entry;
-}
-
-/**
-  Recovers previous txMeta state obj
-  @returns
-*/
-export function replayHistory(_shortHistory: any) {
-  const shortHistory = _.cloneDeep(_shortHistory);
-  return shortHistory.reduce(
-    (val: any, entry: any) => jsonDiffer.applyPatch(val, entry).newDocument,
-  );
-}
-
-/**
- * Snapshot {@code txMeta}
- * @param txMeta - the tx metadata object
- * @returns a deep clone without history
- */
-export function snapshotFromTxMeta(txMeta: any) {
-  const shallow = { ...txMeta };
-  delete shallow.history;
-  return _.cloneDeep(shallow);
-}
-
 /**
  * Returns processing time for an STX in seconds.
  * @param smartTransactionSubmittedtime