feat: detect incoming transactions using accounts API (#4927)

Remove polling on each new block via `PollingBlockTracker`.
Polling will occur every 30 seconds and support multiple chains simultaneously.
Remove `etherscan` util and `EtherscanRemoteTransactionSource`.
Create `accounts-api` util and `AccountsApiRemoteTransactionSource`.
Remove `ETHERSCAN_SUPPORTED_NETWORKS` constant.
Replace block number based query optimisation with cursors.
Use single instance of `IncomingTransactionHelper`.
Remove `IncomingTransactionHelper` instance creation from `MultichainTrackingHelper`.
Move caching logic inside `RemoteTransactionSource` via `getCache` and `updateCache` properties.

Author: matthewwalsh0

packages/transaction-controller/CHANGELOG.md

@@ -7,6 +7,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Retrieve incoming transactions using Accounts API ([#4927](https://github.com/MetaMask/core/pull/4927))
+  - Add `INCOMING_TRANSACTIONS_SUPPORTED_CHAIN_IDS` constant.
+
+### Changed
+
+- **BREAKING:** Retrieve incoming transactions using Accounts API ([#4927](https://github.com/MetaMask/core/pull/4927))
+  - Rename `TransactionControllerIncomingTransactionBlockReceivedEvent` to `TransactionControllerIncomingTransactionsReceivedEvent`.
+  - Replace `networkClientIds` argument with `chainIds` in following methods:
+    - `startIncomingTransactionPolling`
+    - `stopIncomingTransactionPolling`
+    - `updateIncomingTransactions`
+
+### Removed
+
+- **BREAKING:** Retrieve incoming transactions using Accounts API ([#4927](https://github.com/MetaMask/core/pull/4927))
+  - Remove `ETHERSCAN_SUPPORTED_NETWORKS` constant.
+  - Remove types:
+    - `EtherscanTransactionMeta`
+    - `RemoteTransactionSource`
+    - `RemoteTransactionSourceRequest`
+
 ## [41.1.0]
 
 ### Added

packages/transaction-controller/jest.config.js

@@ -17,10 +17,10 @@ module.exports = merge(baseConfig, {
   // An object that configures minimum threshold enforcement for coverage results
   coverageThreshold: {
     global: {
-      branches: 93.23,
-      functions: 97.61,
-      lines: 98.26,
-      statements: 98.28,
+      branches: 91.76,
+      functions: 94.76,
+      lines: 96.83,
+      statements: 96.82,
     },
   },
 

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

@@ -657,11 +657,6 @@ describe('TransactionController', () => {
       (controller as any).update(() => state);
     }
 
-    multichainTrackingHelperClassMock.mock.calls[0][0].createIncomingTransactionHelper(
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      {} as any,
-    );
-
     multichainTrackingHelperClassMock.mock.calls[0][0].createPendingTransactionTracker(
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
       {} as any,
@@ -777,6 +772,8 @@ describe('TransactionController', () => {
   }
 
   beforeEach(() => {
+    jest.resetAllMocks();
+
     jest.spyOn(Date, 'now').mockImplementation(() => {
       timeCounter += 1;
       return timeCounter;
@@ -2613,21 +2610,6 @@ describe('TransactionController', () => {
       expect(controller.state.transactions).toHaveLength(1);
       expect(controller.state.transactions[0].id).toBe('4');
     });
-  });
-
-  describe('handleMethodData', () => {
-    it('invokes helper', async () => {
-      const { controller } = setupController();
-
-      methodDataHelperMock.lookup.mockResolvedValueOnce(METHOD_DATA_MOCK);
-
-      const result = await controller.handleMethodData(
-        'mockMethodData',
-        NETWORK_CLIENT_ID_MOCK,
-      );
-
-      expect(result).toStrictEqual(METHOD_DATA_MOCK);
-    });
 
     it('updates state when helper emits update event', async () => {
       const { controller } = setupController();
@@ -4106,41 +4088,13 @@ describe('TransactionController', () => {
 
       // TODO: Replace `any` with type
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      await (incomingTransactionHelperMock.hub.on as any).mock.calls[0][1]({
-        added: [TRANSACTION_META_MOCK, TRANSACTION_META_2_MOCK],
-        updated: [],
-      });
-
-      expect(controller.state.transactions).toStrictEqual([
-        { ...TRANSACTION_META_MOCK, networkClientId: NETWORK_CLIENT_ID_MOCK },
-        { ...TRANSACTION_META_2_MOCK, networkClientId: NETWORK_CLIENT_ID_MOCK },
+      await (incomingTransactionHelperMock.hub.on as any).mock.calls[0][1]([
+        TRANSACTION_META_MOCK,
+        TRANSACTION_META_2_MOCK,
       ]);
-    });
-
-    it('updates existing transactions in state', async () => {
-      const { controller } = setupController({
-        options: {
-          state: {
-            transactions: [TRANSACTION_META_MOCK, TRANSACTION_META_2_MOCK],
-          },
-        },
-      });
-
-      const updatedTransaction = {
-        ...TRANSACTION_META_MOCK,
-        networkClientId: NETWORK_CLIENT_ID_MOCK,
-        status: 'failed',
-      };
-
-      // TODO: Replace `any` with type
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      await (incomingTransactionHelperMock.hub.on as any).mock.calls[0][1]({
-        added: [],
-        updated: [updatedTransaction],
-      });
 
       expect(controller.state.transactions).toStrictEqual([
-        updatedTransaction,
+        { ...TRANSACTION_META_MOCK, networkClientId: NETWORK_CLIENT_ID_MOCK },
         { ...TRANSACTION_META_2_MOCK, networkClientId: NETWORK_CLIENT_ID_MOCK },
       ]);
     });
@@ -4152,58 +4106,74 @@ describe('TransactionController', () => {
 
       // TODO: Replace `any` with type
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      await (incomingTransactionHelperMock.hub.on as any).mock.calls[0][1]({
-        added: [TRANSACTION_META_MOCK, TRANSACTION_META_2_MOCK],
-        updated: [],
-      });
+      await (incomingTransactionHelperMock.hub.on as any).mock.calls[0][1]([
+        TRANSACTION_META_MOCK,
+        TRANSACTION_META_2_MOCK,
+      ]);
 
       expect(controller.state.transactions).toStrictEqual([
         { ...TRANSACTION_META_2_MOCK, networkClientId: NETWORK_CLIENT_ID_MOCK },
       ]);
     });
-  });
 
-  describe('on incoming transaction helper lastFetchedBlockNumbers event', () => {
-    it('updates state', async () => {
-      const { controller } = setupController();
+    it('publishes TransactionController:incomingTransactionsReceived', async () => {
+      const listener = jest.fn();
 
-      const lastFetchedBlockNumbers = {
-        key: 234,
-      };
+      const { messenger } = setupController();
+      messenger.subscribe(
+        'TransactionController:incomingTransactionsReceived',
+        listener,
+      );
 
       // TODO: Replace `any` with type
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      await (incomingTransactionHelperMock.hub.on as any).mock.calls[1][1]({
-        lastFetchedBlockNumbers,
-        blockNumber: 123,
-      });
+      await (incomingTransactionHelperMock.hub.on as any).mock.calls[0][1]([
+        TRANSACTION_META_MOCK,
+        TRANSACTION_META_2_MOCK,
+      ]);
 
-      expect(controller.state.lastFetchedBlockNumbers).toStrictEqual(
-        lastFetchedBlockNumbers,
-      );
+      expect(listener).toHaveBeenCalledTimes(1);
+      expect(listener).toHaveBeenCalledWith([
+        { ...TRANSACTION_META_MOCK, networkClientId: NETWORK_CLIENT_ID_MOCK },
+        { ...TRANSACTION_META_2_MOCK, networkClientId: NETWORK_CLIENT_ID_MOCK },
+      ]);
     });
 
-    it('publishes TransactionController:incomingTransactionBlockReceived', async () => {
-      const blockNumber = 123;
+    it('does not publish TransactionController:incomingTransactionsReceived if no new transactions', async () => {
       const listener = jest.fn();
 
       const { messenger } = setupController();
+
       messenger.subscribe(
-        'TransactionController:incomingTransactionBlockReceived',
+        'TransactionController:incomingTransactionsReceived',
         listener,
       );
 
       // TODO: Replace `any` with type
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      await (incomingTransactionHelperMock.hub.on as any).mock.calls[1][1]({
-        lastFetchedBlockNumbers: {
-          key: 234,
+      await (incomingTransactionHelperMock.hub.on as any).mock.calls[0][1]([]);
+
+      expect(listener).toHaveBeenCalledTimes(0);
+    });
+  });
+
+  describe('on incoming transaction helper updateCache call', () => {
+    it('updates state', async () => {
+      const { controller } = setupController();
+      const key = 'testKey';
+      const value = 123;
+
+      // TODO: Replace `any` with type
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      incomingTransactionHelperClassMock.mock.calls[0][0].updateCache(
+        (cache) => {
+          cache[key] = value;
         },
-        blockNumber,
-      });
+      );
 
-      expect(listener).toHaveBeenCalledTimes(1);
-      expect(listener).toHaveBeenCalledWith(blockNumber);
+      expect(controller.state.lastFetchedBlockNumbers).toStrictEqual({
+        [key]: value,
+      });
     });
   });