metamask-extension/app/scripts/controllers/incoming-transactions.test.js

import { strict as assert } from 'assert';
import sinon from 'sinon';
import proxyquire from 'proxyquire';
import nock from 'nock';
import { cloneDeep } from 'lodash';

import waitUntilCalled from '../../../test/lib/wait-until-called';
import {
  ETHERSCAN_SUPPORTED_NETWORKS,
  CHAIN_IDS,
  NETWORK_TYPES,
  NETWORK_IDS,
} from '../../../shared/constants/network';
import {
  TransactionType,
  TransactionStatus,
} from '../../../shared/constants/transaction';
import { MILLISECOND } from '../../../shared/constants/time';

const IncomingTransactionsController = proxyquire('./incoming-transactions', {
  '../../../shared/modules/random-id': { default: () => 54321 },
}).default;

const FAKE_CHAIN_ID = '0x1338';
const MOCK_SELECTED_ADDRESS = '0x0101';
const SET_STATE_TIMEOUT = MILLISECOND * 10;

const EXISTING_INCOMING_TX = { id: 777, hash: '0x123456' };
const PREPOPULATED_INCOMING_TXS_BY_HASH = {
  [EXISTING_INCOMING_TX.hash]: EXISTING_INCOMING_TX,
};
const PREPOPULATED_BLOCKS_BY_NETWORK = {
  [CHAIN_IDS.GOERLI]: 1,
  [CHAIN_IDS.MAINNET]: 3,
  [CHAIN_IDS.SEPOLIA]: 6,
};
const EMPTY_BLOCKS_BY_NETWORK = Object.keys(
  ETHERSCAN_SUPPORTED_NETWORKS,
).reduce((network, chainId) => {
  network[chainId] = null;
  return network;
}, {});

function getEmptyInitState() {
  return {
    incomingTransactions: {},
    incomingTxLastFetchedBlockByChainId: EMPTY_BLOCKS_BY_NETWORK,
  };
}

function getNonEmptyInitState() {
  return {
    incomingTransactions: PREPOPULATED_INCOMING_TXS_BY_HASH,
    incomingTxLastFetchedBlockByChainId: PREPOPULATED_BLOCKS_BY_NETWORK,
  };
}

function getMockNetworkControllerMethods(chainId = FAKE_CHAIN_ID) {
  return {
    getCurrentChainId: () => chainId,
    onNetworkDidChange: sinon.spy(),
  };
}

function getMockPreferencesController({
  showIncomingTransactions = true,
} = {}) {
  return {
    getSelectedAddress: sinon.stub().returns(MOCK_SELECTED_ADDRESS),
    store: {
      getState: sinon.stub().returns({
        featureFlags: {
          showIncomingTransactions,
        },
      }),
      subscribe: sinon.spy(),
    },
  };
}

function getMockOnboardingController() {
  return {
    store: {
      getState: sinon.stub().returns({
        completedOnboarding: true,
      }),
      subscribe: sinon.spy(),
    },
  };
}

function getMockBlockTracker() {
  return {
    addListener: sinon.stub().callsArgWithAsync(1, '0xa'),
    removeListener: sinon.spy(),
    testProperty: 'fakeBlockTracker',
    getCurrentBlock: () => '0xa',
  };
}

/**
 * @typedef {import(
 *  '../../../../app/scripts/controllers/incoming-transactions'
 * ).EtherscanTransaction} EtherscanTransaction
 */

/**
 * Returns a transaction object matching the expected format returned
 * by the Etherscan API
 *
 * @param {object} [params] - options bag
 * @param {string} [params.toAddress] - The hex-prefixed address of the recipient
 * @param {number} [params.blockNumber] - The block number for the transaction
 * @param {boolean} [params.useEIP1559] - Use EIP-1559 gas fields
 * @param params.hash
 * @returns {EtherscanTransaction}
 */
const getFakeEtherscanTransaction = ({
  toAddress = MOCK_SELECTED_ADDRESS,
  blockNumber = 10,
  useEIP1559 = false,
  hash = '0xfake',
} = {}) => {
  if (useEIP1559) {
    return {
      blockNumber: blockNumber.toString(),
      from: '0xfake',
      gas: '0',
      maxFeePerGas: '10',
      maxPriorityFeePerGas: '1',
      hash,
      isError: '0',
      nonce: '100',
      timeStamp: '16000000000000',
      to: toAddress,
      value: '0',
    };
  }
  return {
    blockNumber: blockNumber.toString(),
    from: '0xfake',
    gas: '0',
    gasPrice: '0',
    hash: '0xfake',
    isError: '0',
    nonce: '100',
    timeStamp: '16000000000000',
    to: toAddress,
    value: '0',
  };
};

function nockEtherscanApiForAllChains(mockResponse) {
  Object.values(ETHERSCAN_SUPPORTED_NETWORKS).forEach(
    ({ domain, subdomain }) => {
      nock(`https://${domain}.${subdomain}`)
        .get(/api.+/u)
        .reply(200, JSON.stringify(mockResponse));
    },
  );
}

describe('IncomingTransactionsController', function () {
  afterEach(function () {
    sinon.restore();
    nock.cleanAll();
  });

  describe('constructor', function () {
    it('should set up correct store, listeners and properties in the constructor', function () {
      const mockedNetworkMethods = getMockNetworkControllerMethods();
      const incomingTransactionsController = new IncomingTransactionsController(
        {
          blockTracker: getMockBlockTracker(),
          ...mockedNetworkMethods,
          preferencesController: getMockPreferencesController(),
          onboardingController: getMockOnboardingController(),
          initState: {},
        },
      );
      sinon.spy(incomingTransactionsController, '_update');

      assert.deepStrictEqual(
        incomingTransactionsController.store.getState(),
        getEmptyInitState(),
      );

      assert(mockedNetworkMethods.onNetworkDidChange.calledOnce);
      const networkControllerListenerCallback =
        mockedNetworkMethods.onNetworkDidChange.getCall(0).args[0];
      assert.strictEqual(incomingTransactionsController._update.callCount, 0);
      networkControllerListenerCallback('testNetworkType');
      assert.strictEqual(incomingTransactionsController._update.callCount, 1);
      assert.deepStrictEqual(
        incomingTransactionsController._update.getCall(0).args[0],
        '0x0101',
      );

      incomingTransactionsController._update.resetHistory();
    });

    it('should set the store to a provided initial state', function () {
      const incomingTransactionsController = new IncomingTransactionsController(
        {
          blockTracker: getMockBlockTracker(),
          ...getMockNetworkControllerMethods(),
          preferencesController: getMockPreferencesController(),
          onboardingController: getMockOnboardingController(),
          initState: getNonEmptyInitState(),
        },
      );

      assert.deepStrictEqual(
        incomingTransactionsController.store.getState(),
        getNonEmptyInitState(),
      );
    });
  });

  describe('update events', function () {
    it('should set up a listener for the latest block', async function () {
      const incomingTransactionsController = new IncomingTransactionsController(
        {
          blockTracker: getMockBlockTracker(),
          ...getMockNetworkControllerMethods(),
          preferencesController: getMockPreferencesController(),
          onboardingController: getMockOnboardingController(),
          initState: {},
        },
      );

      incomingTransactionsController.start();

      assert(
        incomingTransactionsController.blockTracker.addListener.calledOnce,
      );
      assert.strictEqual(
        incomingTransactionsController.blockTracker.addListener.getCall(0)
          .args[0],
        'latest',
      );
    });

    it('should update upon latest block when started and on supported network', async function () {
      const incomingTransactionsController = new IncomingTransactionsController(
        {
          blockTracker: getMockBlockTracker(),
          ...getMockNetworkControllerMethods(CHAIN_IDS.GOERLI),
          preferencesController: getMockPreferencesController(),
          onboardingController: getMockOnboardingController(),
          initState: getNonEmptyInitState(),
        },
      );
      const startBlock =
        getNonEmptyInitState().incomingTxLastFetchedBlockByChainId[
          CHAIN_IDS.GOERLI
        ];
      nock('https://api-goerli.etherscan.io')
        .get(
          `/api?module=account&action=txlist&address=${MOCK_SELECTED_ADDRESS}&tag=latest&page=1&startBlock=${startBlock}`,
        )
        .reply(
          200,
          JSON.stringify({
            status: '1',
            result: [
              getFakeEtherscanTransaction(),
              getFakeEtherscanTransaction({
                hash: '0xfakeeip1559',
                useEIP1559: true,
              }),
            ],
          }),
        );
      const updateStateStub = sinon.stub(
        incomingTransactionsController.store,
        'updateState',
      );
      const updateStateCalled = waitUntilCalled(
        updateStateStub,
        incomingTransactionsController.store,
      );

      incomingTransactionsController.start();
      await updateStateCalled();

      const actualState = incomingTransactionsController.store.getState();
      const generatedTxId = actualState?.incomingTransactions?.['0xfake']?.id;

      const actualStateWithoutGenerated = cloneDeep(actualState);
      delete actualStateWithoutGenerated?.incomingTransactions?.['0xfake']?.id;
      delete actualStateWithoutGenerated?.incomingTransactions?.[
        '0xfakeeip1559'
      ]?.id;

      assert.ok(
        typeof generatedTxId === 'number' && generatedTxId > 0,
        'Generated transaction ID should be a positive number',
      );
      assert.deepStrictEqual(
        actualStateWithoutGenerated,
        {
          incomingTransactions: {
            ...getNonEmptyInitState().incomingTransactions,
            '0xfake': {
              blockNumber: '10',
              hash: '0xfake',
              metamaskNetworkId: NETWORK_IDS.GOERLI,
              chainId: CHAIN_IDS.GOERLI,
              status: TransactionStatus.confirmed,
              time: 16000000000000000,
              type: TransactionType.incoming,
              txParams: {
                from: '0xfake',
                gas: '0x0',
                gasPrice: '0x0',
                nonce: '0x64',
                to: '0x0101',
                value: '0x0',
              },
            },
            '0xfakeeip1559': {
              blockNumber: '10',
              hash: '0xfakeeip1559',
              metamaskNetworkId: NETWORK_IDS.GOERLI,
              chainId: CHAIN_IDS.GOERLI,
              status: TransactionStatus.confirmed,
              time: 16000000000000000,
              type: TransactionType.incoming,
              txParams: {
                from: '0xfake',
                gas: '0x0',
                maxFeePerGas: '0xa',
                maxPriorityFeePerGas: '0x1',
                nonce: '0x64',
                to: '0x0101',
                value: '0x0',
              },
            },
          },
          incomingTxLastFetchedBlockByChainId: {
            ...getNonEmptyInitState().incomingTxLastFetchedBlockByChainId,
            [CHAIN_IDS.GOERLI]: 11,
          },
        },
        'State should have been updated after first block was received',
      );
    });

    it('should not update upon latest block when started and not on supported network', async function () {
      const incomingTransactionsController = new IncomingTransactionsController(
        {
          blockTracker: getMockBlockTracker(),
          ...getMockNetworkControllerMethods(),
          preferencesController: getMockPreferencesController(),
          onboardingController: getMockOnboardingController(),
          initState: getNonEmptyInitState(),
        },
      );
      // reply with a valid request for any supported network, so that this test has every opportunity to fail
      nockEtherscanApiForAllChains({
        status: '1',
        result: [getFakeEtherscanTransaction()],
      });

      const updateStateStub = sinon.stub(
        incomingTransactionsController.store,
        'updateState',
      );
      const updateStateCalled = waitUntilCalled(
        updateStateStub,
        incomingTransactionsController.store,
      );
      const putStateStub = sinon.stub(
        incomingTransactionsController.store,
        'putState',
      );
      const putStateCalled = waitUntilCalled(
        putStateStub,
        incomingTransactionsController.store,
      );

      incomingTransactionsController.start();

      try {
        await Promise.race([
          updateStateCalled(),
          putStateCalled(),
          new Promise((_, reject) => {
            setTimeout(() => reject(new Error('TIMEOUT')), SET_STATE_TIMEOUT);
          }),
        ]);
        assert.fail('Update state should not have been called');
      } catch (error) {
        assert(error.message === 'TIMEOUT', 'TIMEOUT error should be thrown');
      }
    });

    it('should not update upon latest block when started and incoming transactions disabled', async function () {
      const incomingTransactionsController = new IncomingTransactionsController(
        {
          blockTracker: getMockBlockTracker(),
          ...getMockNetworkControllerMethods(),
          preferencesController: getMockPreferencesController({
            showIncomingTransactions: false,
          }),
          onboardingController: getMockOnboardingController(),
          initState: getNonEmptyInitState(),
        },
      );
      // reply with a valid request for any supported network, so that this test has every opportunity to fail
      nockEtherscanApiForAllChains({
        status: '1',
        result: [getFakeEtherscanTransaction()],
      });
      const updateStateStub = sinon.stub(
        incomingTransactionsController.store,
        'updateState',
      );
      const updateStateCalled = waitUntilCalled(
        updateStateStub,
        incomingTransactionsController.store,
      );
      const putStateStub = sinon.stub(
        incomingTransactionsController.store,
        'putState',
      );
      const putStateCalled = waitUntilCalled(
        putStateStub,
        incomingTransactionsController.store,
      );

      incomingTransactionsController.start();

      try {
        await Promise.race([
          updateStateCalled(),
          putStateCalled(),
          new Promise((_, reject) => {
            setTimeout(() => reject(new Error('TIMEOUT')), SET_STATE_TIMEOUT);
          }),
        ]);
        assert.fail('Update state should not have been called');
      } catch (error) {
        assert(error.message === 'TIMEOUT', 'TIMEOUT error should be thrown');
      }
    });

    it('should not update upon latest block when not started', async function () {
      const incomingTransactionsController = new IncomingTransactionsController(
        {
          blockTracker: getMockBlockTracker(),
          ...getMockNetworkControllerMethods(CHAIN_IDS.GOERLI),
          preferencesController: getMockPreferencesController(),
          onboardingController: getMockOnboardingController(),
          initState: getNonEmptyInitState(),
        },
      );
      // reply with a valid request for any supported network, so that this test has every opportunity to fail
      nockEtherscanApiForAllChains({
        status: '1',
        result: [getFakeEtherscanTransaction()],
      });
      const updateStateStub = sinon.stub(
        incomingTransactionsController.store,
        'updateState',
      );
      const updateStateCalled = waitUntilCalled(
        updateStateStub,
        incomingTransactionsController.store,
      );
      const putStateStub = sinon.stub(
        incomingTransactionsController.store,
        'putState',
      );
      const putStateCalled = waitUntilCalled(
        putStateStub,
        incomingTransactionsController.store,
      );

      try {
        await Promise.race([
          updateStateCalled(),
          putStateCalled(),
          new Promise((_, reject) => {
            setTimeout(() => reject(new Error('TIMEOUT')), SET_STATE_TIMEOUT);
          }),
        ]);
        assert.fail('Update state should not have been called');
      } catch (error) {
        assert(error.message === 'TIMEOUT', 'TIMEOUT error should be thrown');
      }
    });

    it('should not update upon latest block when stopped', async function () {
      const incomingTransactionsController = new IncomingTransactionsController(
        {
          blockTracker: getMockBlockTracker(),
          ...getMockNetworkControllerMethods(CHAIN_IDS.GOERLI),
          preferencesController: getMockPreferencesController(),
          onboardingController: getMockOnboardingController(),
          initState: getNonEmptyInitState(),
        },
      );
      // reply with a valid request for any supported network, so that this test has every opportunity to fail
      nockEtherscanApiForAllChains({
        status: '1',
        result: [getFakeEtherscanTransaction()],
      });
      const updateStateStub = sinon.stub(
        incomingTransactionsController.store,
        'updateState',
      );
      const updateStateCalled = waitUntilCalled(
        updateStateStub,
        incomingTransactionsController.store,
      );
      const putStateStub = sinon.stub(
        incomingTransactionsController.store,
        'putState',
      );
      const putStateCalled = waitUntilCalled(
        putStateStub,
        incomingTransactionsController.store,
      );

      incomingTransactionsController.stop();

      try {
        await Promise.race([
          updateStateCalled(),
          putStateCalled(),
          new Promise((_, reject) => {
            setTimeout(() => reject(new Error('TIMEOUT')), SET_STATE_TIMEOUT);
          }),
        ]);
        assert.fail('Update state should not have been called');
      } catch (error) {
        assert(error.message === 'TIMEOUT', 'TIMEOUT error should be thrown');
      }
    });

    it('should update when the selected address changes and on supported network', async function () {
      const incomingTransactionsController = new IncomingTransactionsController(
        {
          blockTracker: getMockBlockTracker(),
          ...getMockNetworkControllerMethods(CHAIN_IDS.GOERLI),
          preferencesController: getMockPreferencesController(),
          onboardingController: getMockOnboardingController(),
          initState: getNonEmptyInitState(),
        },
      );
      const NEW_MOCK_SELECTED_ADDRESS = `${MOCK_SELECTED_ADDRESS}9`;
      const startBlock =
        getNonEmptyInitState().incomingTxLastFetchedBlockByChainId[
          CHAIN_IDS.GOERLI
        ];
      nock('https://api-goerli.etherscan.io')
        .get(
          `/api?module=account&action=txlist&address=${NEW_MOCK_SELECTED_ADDRESS}&tag=latest&page=1&startBlock=${startBlock}`,
        )
        .reply(
          200,
          JSON.stringify({
            status: '1',
            result: [
              getFakeEtherscanTransaction({
                toAddress: NEW_MOCK_SELECTED_ADDRESS,
              }),
            ],
          }),
        );
      const updateStateStub = sinon.stub(
        incomingTransactionsController.store,
        'updateState',
      );
      const updateStateCalled = waitUntilCalled(
        updateStateStub,
        incomingTransactionsController.store,
      );

      const subscription =
        incomingTransactionsController.preferencesController.store.subscribe.getCall(
          1,
        ).args[0];
      // The incoming transactions controller will always skip the first event
      // We need to call subscription twice to test the event handling
      // TODO: stop skipping the first event
      await subscription({ selectedAddress: MOCK_SELECTED_ADDRESS });
      await subscription({ selectedAddress: NEW_MOCK_SELECTED_ADDRESS });
      await updateStateCalled();

      const actualState = incomingTransactionsController.store.getState();
      const generatedTxId = actualState?.incomingTransactions?.['0xfake']?.id;

      const actualStateWithoutGenerated = cloneDeep(actualState);
      delete actualStateWithoutGenerated?.incomingTransactions?.['0xfake']?.id;

      assert.ok(
        typeof generatedTxId === 'number' && generatedTxId > 0,
        'Generated transaction ID should be a positive number',
      );
      assert.deepStrictEqual(
        actualStateWithoutGenerated,
        {
          incomingTransactions: {
            ...getNonEmptyInitState().incomingTransactions,
            '0xfake': {
              blockNumber: '10',
              hash: '0xfake',
              metamaskNetworkId: NETWORK_IDS.GOERLI,
              chainId: CHAIN_IDS.GOERLI,
              status: TransactionStatus.confirmed,
              time: 16000000000000000,
              type: TransactionType.incoming,
              txParams: {
                from: '0xfake',
                gas: '0x0',
                gasPrice: '0x0',
                nonce: '0x64',
                to: '0x01019',
                value: '0x0',
              },
            },
          },
          incomingTxLastFetchedBlockByChainId: {
            ...getNonEmptyInitState().incomingTxLastFetchedBlockByChainId,
            [CHAIN_IDS.GOERLI]: 11,
          },
        },
        'State should have been updated after first block was received',
      );
    });

    it('should not update when the selected address changes and not on supported network', async function () {
      const incomingTransactionsController = new IncomingTransactionsController(
        {
          blockTracker: { ...getMockBlockTracker() },
          ...getMockNetworkControllerMethods(),
          preferencesController: getMockPreferencesController(),
          onboardingController: getMockOnboardingController(),
          initState: getNonEmptyInitState(),
        },
      );
      const NEW_MOCK_SELECTED_ADDRESS = `${MOCK_SELECTED_ADDRESS}9`;
      // reply with a valid request for any supported network, so that this test has every opportunity to fail
      nockEtherscanApiForAllChains({
        status: '1',
        result: [
          getFakeEtherscanTransaction({ toAddress: NEW_MOCK_SELECTED_ADDRESS }),
        ],
      });
      const updateStateStub = sinon.stub(
        incomingTransactionsController.store,
        'updateState',
      );
      const updateStateCalled = waitUntilCalled(
        updateStateStub,
        incomingTransactionsController.store,
      );
      const putStateStub = sinon.stub(
        incomingTransactionsController.store,
        'putState',
      );
      const putStateCalled = waitUntilCalled(
        putStateStub,
        incomingTransactionsController.store,
      );

      const subscription =
        incomingTransactionsController.preferencesController.store.subscribe.getCall(
          1,
        ).args[0];
      // The incoming transactions controller will always skip the first event
      // We need to call subscription twice to test the event handling
      // TODO: stop skipping the first event
      await subscription({ selectedAddress: MOCK_SELECTED_ADDRESS });
      await subscription({ selectedAddress: NEW_MOCK_SELECTED_ADDRESS });

      try {
        await Promise.race([
          updateStateCalled(),
          putStateCalled(),
          new Promise((_, reject) => {
            setTimeout(() => reject(new Error('TIMEOUT')), SET_STATE_TIMEOUT);
          }),
        ]);
        assert.fail('Update state should not have been called');
      } catch (error) {
        assert(error.message === 'TIMEOUT', 'TIMEOUT error should be thrown');
      }
    });

    it('should update when switching to a supported network', async function () {
      const mockedNetworkMethods = getMockNetworkControllerMethods(
        CHAIN_IDS.GOERLI,
      );
      const incomingTransactionsController = new IncomingTransactionsController(
        {
          blockTracker: getMockBlockTracker(),
          ...mockedNetworkMethods,
          preferencesController: getMockPreferencesController(),
          onboardingController: getMockOnboardingController(),
          initState: getNonEmptyInitState(),
        },
      );
      const startBlock =
        getNonEmptyInitState().incomingTxLastFetchedBlockByChainId[
          CHAIN_IDS.GOERLI
        ];
      nock('https://api-goerli.etherscan.io')
        .get(
          `/api?module=account&action=txlist&address=${MOCK_SELECTED_ADDRESS}&tag=latest&page=1&startBlock=${startBlock}`,
        )
        .reply(
          200,
          JSON.stringify({
            status: '1',
            result: [getFakeEtherscanTransaction()],
          }),
        );
      const updateStateStub = sinon.stub(
        incomingTransactionsController.store,
        'updateState',
      );
      const updateStateCalled = waitUntilCalled(
        updateStateStub,
        incomingTransactionsController.store,
      );

      const subscription =
        mockedNetworkMethods.onNetworkDidChange.getCall(0).args[0];
      await subscription(CHAIN_IDS.GOERLI);
      await updateStateCalled();

      const actualState = incomingTransactionsController.store.getState();
      const generatedTxId = actualState?.incomingTransactions?.['0xfake']?.id;

      const actualStateWithoutGenerated = cloneDeep(actualState);
      delete actualStateWithoutGenerated?.incomingTransactions?.['0xfake']?.id;

      assert.ok(
        typeof generatedTxId === 'number' && generatedTxId > 0,
        'Generated transaction ID should be a positive number',
      );
      assert.deepStrictEqual(
        actualStateWithoutGenerated,
        {
          incomingTransactions: {
            ...getNonEmptyInitState().incomingTransactions,
            '0xfake': {
              blockNumber: '10',
              hash: '0xfake',
              metamaskNetworkId: NETWORK_IDS.GOERLI,
              chainId: CHAIN_IDS.GOERLI,
              status: TransactionStatus.confirmed,
              time: 16000000000000000,
              type: TransactionType.incoming,
              txParams: {
                from: '0xfake',
                gas: '0x0',
                gasPrice: '0x0',
                nonce: '0x64',
                to: '0x0101',
                value: '0x0',
              },
            },
          },
          incomingTxLastFetchedBlockByChainId: {
            ...getNonEmptyInitState().incomingTxLastFetchedBlockByChainId,
            [CHAIN_IDS.GOERLI]: 11,
          },
        },
        'State should have been updated after first block was received',
      );
    });

    it('should not update when switching to an unsupported network', async function () {
      const mockedNetworkMethods = getMockNetworkControllerMethods(
        CHAIN_IDS.GOERLI,
      );
      const incomingTransactionsController = new IncomingTransactionsController(
        {
          blockTracker: getMockBlockTracker(),
          ...mockedNetworkMethods,
          preferencesController: getMockPreferencesController(),
          onboardingController: getMockOnboardingController(),
          initState: getNonEmptyInitState(),
        },
      );
      // reply with a valid request for any supported network, so that this test has every opportunity to fail
      nockEtherscanApiForAllChains({
        status: '1',
        result: [getFakeEtherscanTransaction()],
      });
      const updateStateStub = sinon.stub(
        incomingTransactionsController.store,
        'updateState',
      );
      const updateStateCalled = waitUntilCalled(
        updateStateStub,
        incomingTransactionsController.store,
      );
      const putStateStub = sinon.stub(
        incomingTransactionsController.store,
        'putState',
      );
      const putStateCalled = waitUntilCalled(
        putStateStub,
        incomingTransactionsController.store,
      );

      const subscription =
        mockedNetworkMethods.onNetworkDidChange.getCall(0).args[0];

      incomingTransactionsController.getCurrentChainId = () => FAKE_CHAIN_ID;
      await subscription();

      try {
        await Promise.race([
          updateStateCalled(),
          putStateCalled(),
          new Promise((_, reject) => {
            setTimeout(() => reject(new Error('TIMEOUT')), SET_STATE_TIMEOUT);
          }),
        ]);
        assert.fail('Update state should not have been called');
      } catch (error) {
        assert(error.message === 'TIMEOUT', 'TIMEOUT error should be thrown');
      }
    });
  });

  describe('_update', function () {
    describe('when state is empty (initialized)', function () {
      it('should use provided block number and update the latest block seen', async function () {
        const incomingTransactionsController =
          new IncomingTransactionsController({
            blockTracker: getMockBlockTracker(),
            ...getMockNetworkControllerMethods(CHAIN_IDS.GOERLI),
            preferencesController: getMockPreferencesController(),
            onboardingController: getMockOnboardingController(),
            initState: getEmptyInitState(),
            getCurrentChainId: () => CHAIN_IDS.GOERLI,
          });
        sinon.spy(incomingTransactionsController.store, 'updateState');

        incomingTransactionsController._getNewIncomingTransactions = sinon
          .stub()
          .returns([]);

        await incomingTransactionsController._update('fakeAddress', 999);
        assert(
          incomingTransactionsController._getNewIncomingTransactions.calledOnce,
        );
        assert.deepStrictEqual(
          incomingTransactionsController._getNewIncomingTransactions.getCall(0)
            .args,
          ['fakeAddress', 999, CHAIN_IDS.GOERLI],
        );
        assert.deepStrictEqual(
          incomingTransactionsController.store.updateState.getCall(0).args[0],
          {
            incomingTxLastFetchedBlockByChainId: {
              ...EMPTY_BLOCKS_BY_NETWORK,
              [CHAIN_IDS.GOERLI]: 1000,
            },
            incomingTransactions: {},
          },
        );
      });

      it('should update the last fetched block for network to highest block seen in incoming txs', async function () {
        const incomingTransactionsController =
          new IncomingTransactionsController({
            blockTracker: getMockBlockTracker(),
            ...getMockNetworkControllerMethods(CHAIN_IDS.GOERLI),
            preferencesController: getMockPreferencesController(),
            onboardingController: getMockOnboardingController(),
            initState: getEmptyInitState(),
            getCurrentChainId: () => CHAIN_IDS.GOERLI,
          });

        const NEW_TRANSACTION_ONE = {
          id: 555,
          hash: '0xfff',
          blockNumber: 444,
        };
        const NEW_TRANSACTION_TWO = {
          id: 556,
          hash: '0xffa',
          blockNumber: 443,
        };

        sinon.spy(incomingTransactionsController.store, 'updateState');

        incomingTransactionsController._getNewIncomingTransactions = sinon
          .stub()
          .returns([NEW_TRANSACTION_ONE, NEW_TRANSACTION_TWO]);
        await incomingTransactionsController._update('fakeAddress', 10);

        assert(incomingTransactionsController.store.updateState.calledOnce);

        assert.deepStrictEqual(
          incomingTransactionsController._getNewIncomingTransactions.getCall(0)
            .args,
          ['fakeAddress', 10, CHAIN_IDS.GOERLI],
        );

        assert.deepStrictEqual(
          incomingTransactionsController.store.updateState.getCall(0).args[0],
          {
            incomingTxLastFetchedBlockByChainId: {
              ...EMPTY_BLOCKS_BY_NETWORK,
              [CHAIN_IDS.GOERLI]: 445,
            },
            incomingTransactions: {
              [NEW_TRANSACTION_ONE.hash]: NEW_TRANSACTION_ONE,
              [NEW_TRANSACTION_TWO.hash]: NEW_TRANSACTION_TWO,
            },
          },
        );
      });
    });

    describe('when state is populated with prior data for network', function () {
      it('should use the last fetched block for the current network and increment by 1 in state', async function () {
        const incomingTransactionsController =
          new IncomingTransactionsController({
            blockTracker: getMockBlockTracker(),
            ...getMockNetworkControllerMethods(CHAIN_IDS.GOERLI),
            preferencesController: getMockPreferencesController(),
            onboardingController: getMockOnboardingController(),
            initState: getNonEmptyInitState(),
            getCurrentChainId: () => CHAIN_IDS.GOERLI,
          });
        sinon.spy(incomingTransactionsController.store, 'updateState');
        incomingTransactionsController._getNewIncomingTransactions = sinon
          .stub()
          .returns([]);

        await incomingTransactionsController._update('fakeAddress', 999);

        assert(
          incomingTransactionsController._getNewIncomingTransactions.calledOnce,
        );

        assert.deepStrictEqual(
          incomingTransactionsController._getNewIncomingTransactions.getCall(0)
            .args,
          ['fakeAddress', 1, CHAIN_IDS.GOERLI],
        );

        assert.deepStrictEqual(
          incomingTransactionsController.store.updateState.getCall(0).args[0],
          {
            incomingTxLastFetchedBlockByChainId: {
              ...PREPOPULATED_BLOCKS_BY_NETWORK,
              [CHAIN_IDS.GOERLI]:
                PREPOPULATED_BLOCKS_BY_NETWORK[CHAIN_IDS.GOERLI] + 1,
            },
            incomingTransactions: PREPOPULATED_INCOMING_TXS_BY_HASH,
          },
        );
      });
    });

    it('should update the last fetched block for network to highest block seen in incoming txs', async function () {
      const incomingTransactionsController = new IncomingTransactionsController(
        {
          blockTracker: getMockBlockTracker(),
          ...getMockNetworkControllerMethods(CHAIN_IDS.GOERLI),
          preferencesController: getMockPreferencesController(),
          onboardingController: getMockOnboardingController(),
          initState: getNonEmptyInitState(),
          getCurrentChainId: () => CHAIN_IDS.GOERLI,
        },
      );

      const NEW_TRANSACTION_ONE = {
        id: 555,
        hash: '0xfff',
        blockNumber: 444,
      };
      const NEW_TRANSACTION_TWO = {
        id: 556,
        hash: '0xffa',
        blockNumber: 443,
      };

      sinon.spy(incomingTransactionsController.store, 'updateState');

      incomingTransactionsController._getNewIncomingTransactions = sinon
        .stub()
        .returns([NEW_TRANSACTION_ONE, NEW_TRANSACTION_TWO]);
      await incomingTransactionsController._update('fakeAddress', 10);

      assert(incomingTransactionsController.store.updateState.calledOnce);

      assert.deepStrictEqual(
        incomingTransactionsController._getNewIncomingTransactions.getCall(0)
          .args,
        ['fakeAddress', 1, CHAIN_IDS.GOERLI],
      );

      assert.deepStrictEqual(
        incomingTransactionsController.store.updateState.getCall(0).args[0],
        {
          incomingTxLastFetchedBlockByChainId: {
            ...PREPOPULATED_BLOCKS_BY_NETWORK,
            [CHAIN_IDS.GOERLI]: 445,
          },
          incomingTransactions: {
            ...PREPOPULATED_INCOMING_TXS_BY_HASH,
            [NEW_TRANSACTION_ONE.hash]: NEW_TRANSACTION_ONE,
            [NEW_TRANSACTION_TWO.hash]: NEW_TRANSACTION_TWO,
          },
        },
      );
    });
  });

  describe('_getNewIncomingTransactions', function () {
    const ADDRESS_TO_FETCH_FOR = '0xfakeaddress';
    const FETCHED_TX = getFakeEtherscanTransaction({
      toAddress: ADDRESS_TO_FETCH_FOR,
    });
    const mockFetch = sinon.stub().returns(
      Promise.resolve({
        json: () => Promise.resolve({ status: '1', result: [FETCHED_TX] }),
      }),
    );
    let tempFetch;
    beforeEach(function () {
      tempFetch = window.fetch;
      window.fetch = mockFetch;
    });

    afterEach(function () {
      window.fetch = tempFetch;
      mockFetch.resetHistory();
    });

    it('should call fetch with the expected url when passed an address, block number and supported chainId', async function () {
      const incomingTransactionsController = new IncomingTransactionsController(
        {
          blockTracker: getMockBlockTracker(),
          ...getMockNetworkControllerMethods(CHAIN_IDS.GOERLI),
          preferencesController: getMockPreferencesController(),
          onboardingController: getMockOnboardingController(),
          initState: getNonEmptyInitState(),
        },
      );

      await incomingTransactionsController._getNewIncomingTransactions(
        ADDRESS_TO_FETCH_FOR,
        '789',
        CHAIN_IDS.GOERLI,
      );

      assert(mockFetch.calledOnce);
      assert.strictEqual(
        mockFetch.getCall(0).args[0],
        `https://api-${NETWORK_TYPES.GOERLI}.etherscan.io/api?module=account&action=txlist&address=0xfakeaddress&tag=latest&page=1&startBlock=789`,
      );
    });

    it('should call fetch with the expected url when passed an address, block number and MAINNET chainId', async function () {
      const incomingTransactionsController = new IncomingTransactionsController(
        {
          blockTracker: getMockBlockTracker(),
          ...getMockNetworkControllerMethods(CHAIN_IDS.MAINNET),
          preferencesController: getMockPreferencesController(),
          onboardingController: getMockOnboardingController(),
          initState: getNonEmptyInitState(),
        },
      );

      await incomingTransactionsController._getNewIncomingTransactions(
        ADDRESS_TO_FETCH_FOR,
        '789',
        CHAIN_IDS.MAINNET,
      );

      assert(mockFetch.calledOnce);
      assert.strictEqual(
        mockFetch.getCall(0).args[0],
        `https://api.etherscan.io/api?module=account&action=txlist&address=0xfakeaddress&tag=latest&page=1&startBlock=789`,
      );
    });

    it('should call fetch with the expected url when passed an address and supported chainId, but a falsy block number', async function () {
      const incomingTransactionsController = new IncomingTransactionsController(
        {
          blockTracker: getMockBlockTracker(),
          ...getMockNetworkControllerMethods(CHAIN_IDS.GOERLI),
          preferencesController: getMockPreferencesController(),
          onboardingController: getMockOnboardingController(),
          initState: getNonEmptyInitState(),
        },
      );

      await incomingTransactionsController._getNewIncomingTransactions(
        ADDRESS_TO_FETCH_FOR,
        null,
        CHAIN_IDS.GOERLI,
      );

      assert(mockFetch.calledOnce);
      assert.strictEqual(
        mockFetch.getCall(0).args[0],
        `https://api-${NETWORK_TYPES.GOERLI}.etherscan.io/api?module=account&action=txlist&address=0xfakeaddress&tag=latest&page=1`,
      );
    });

    it('should return an array of normalized transactions', async function () {
      const incomingTransactionsController = new IncomingTransactionsController(
        {
          blockTracker: getMockBlockTracker(),
          ...getMockNetworkControllerMethods(CHAIN_IDS.GOERLI),
          preferencesController: getMockPreferencesController(),
          onboardingController: getMockOnboardingController(),
          initState: getNonEmptyInitState(),
        },
      );

      const result =
        await incomingTransactionsController._getNewIncomingTransactions(
          ADDRESS_TO_FETCH_FOR,
          '789',
          CHAIN_IDS.GOERLI,
        );

      assert(mockFetch.calledOnce);
      assert.deepStrictEqual(result, [
        incomingTransactionsController._normalizeTxFromEtherscan(
          FETCHED_TX,
          CHAIN_IDS.GOERLI,
        ),
      ]);
    });

    it('should return empty tx array if status is 0', async function () {
      const mockFetchStatusZero = sinon.stub().returns(
        Promise.resolve({
          json: () => Promise.resolve({ status: '0', result: [FETCHED_TX] }),
        }),
      );
      const tempFetchStatusZero = window.fetch;
      window.fetch = mockFetchStatusZero;
      const incomingTransactionsController = new IncomingTransactionsController(
        {
          blockTracker: getMockBlockTracker(),
          ...getMockNetworkControllerMethods(CHAIN_IDS.GOERLI),
          preferencesController: getMockPreferencesController(),
          onboardingController: getMockOnboardingController(),
          initState: getNonEmptyInitState(),
        },
      );

      const result =
        await incomingTransactionsController._getNewIncomingTransactions(
          ADDRESS_TO_FETCH_FOR,
          '789',
          CHAIN_IDS.GOERLI,
        );
      assert.deepStrictEqual(result, []);
      window.fetch = tempFetchStatusZero;
      mockFetchStatusZero.reset();
    });

    it('should return empty tx array if result array is empty', async function () {
      const mockFetchEmptyResult = sinon.stub().returns(
        Promise.resolve({
          json: () => Promise.resolve({ status: '1', result: [] }),
        }),
      );
      const tempFetchEmptyResult = window.fetch;
      window.fetch = mockFetchEmptyResult;
      const incomingTransactionsController = new IncomingTransactionsController(
        {
          blockTracker: getMockBlockTracker(),
          ...getMockNetworkControllerMethods(CHAIN_IDS.GOERLI),
          preferencesController: getMockPreferencesController(),
          onboardingController: getMockOnboardingController(),
          initState: getNonEmptyInitState(),
        },
      );

      const result =
        await incomingTransactionsController._getNewIncomingTransactions(
          ADDRESS_TO_FETCH_FOR,
          '789',
          CHAIN_IDS.GOERLI,
        );
      assert.deepStrictEqual(result, []);
      window.fetch = tempFetchEmptyResult;
      mockFetchEmptyResult.reset();
    });
  });

  describe('_normalizeTxFromEtherscan', function () {
    it('should return the expected data when the tx is in error', function () {
      const incomingTransactionsController = new IncomingTransactionsController(
        {
          blockTracker: getMockBlockTracker(),
          ...getMockNetworkControllerMethods(CHAIN_IDS.GOERLI),
          preferencesController: getMockPreferencesController(),
          onboardingController: getMockOnboardingController(),
          initState: getNonEmptyInitState(),
        },
      );

      const result = incomingTransactionsController._normalizeTxFromEtherscan(
        {
          timeStamp: '4444',
          isError: '1',
          blockNumber: 333,
          from: '0xa',
          gas: '11',
          gasPrice: '12',
          nonce: '13',
          to: '0xe',
          value: '15',
          hash: '0xg',
        },
        CHAIN_IDS.GOERLI,
      );

      assert.deepStrictEqual(result, {
        blockNumber: 333,
        id: 54321,
        metamaskNetworkId: NETWORK_IDS.GOERLI,
        chainId: CHAIN_IDS.GOERLI,
        status: TransactionStatus.failed,
        time: 4444000,
        txParams: {
          from: '0xa',
          gas: '0xb',
          gasPrice: '0xc',
          nonce: '0xd',
          to: '0xe',
          value: '0xf',
        },
        hash: '0xg',
        type: TransactionType.incoming,
      });
    });

    it('should return the expected data when the tx is not in error', function () {
      const incomingTransactionsController = new IncomingTransactionsController(
        {
          blockTracker: getMockBlockTracker(),
          ...getMockNetworkControllerMethods(CHAIN_IDS.GOERLI),
          preferencesController: getMockPreferencesController(),
          onboardingController: getMockOnboardingController(),
          initState: getNonEmptyInitState(),
        },
      );

      const result = incomingTransactionsController._normalizeTxFromEtherscan(
        {
          timeStamp: '4444',
          isError: '0',
          blockNumber: 333,
          from: '0xa',
          gas: '11',
          gasPrice: '12',
          nonce: '13',
          to: '0xe',
          value: '15',
          hash: '0xg',
        },
        CHAIN_IDS.GOERLI,
      );

      assert.deepStrictEqual(result, {
        blockNumber: 333,
        id: 54321,
        metamaskNetworkId: NETWORK_IDS.GOERLI,
        chainId: CHAIN_IDS.GOERLI,
        status: TransactionStatus.confirmed,
        time: 4444000,
        txParams: {
          from: '0xa',
          gas: '0xb',
          gasPrice: '0xc',
          nonce: '0xd',
          to: '0xe',
          value: '0xf',
        },
        hash: '0xg',
        type: TransactionType.incoming,
      });
    });

    it('should return the expected data when the tx uses EIP-1559 fields', function () {
      const incomingTransactionsController = new IncomingTransactionsController(
        {
          blockTracker: getMockBlockTracker(),
          ...getMockNetworkControllerMethods(CHAIN_IDS.GOERLI),
          preferencesController: getMockPreferencesController(),
          onboardingController: getMockOnboardingController(),
          initState: getNonEmptyInitState(),
        },
      );

      const result = incomingTransactionsController._normalizeTxFromEtherscan(
        {
          timeStamp: '4444',
          isError: '0',
          blockNumber: 333,
          from: '0xa',
          gas: '11',
          maxFeePerGas: '12',
          maxPriorityFeePerGas: '1',
          nonce: '13',
          to: '0xe',
          value: '15',
          hash: '0xg',
        },
        CHAIN_IDS.GOERLI,
      );

      assert.deepStrictEqual(result, {
        blockNumber: 333,
        id: 54321,
        metamaskNetworkId: NETWORK_IDS.GOERLI,
        chainId: CHAIN_IDS.GOERLI,
        status: TransactionStatus.confirmed,
        time: 4444000,
        txParams: {
          from: '0xa',
          gas: '0xb',
          maxFeePerGas: '0xc',
          maxPriorityFeePerGas: '0x1',
          nonce: '0xd',
          to: '0xe',
          value: '0xf',
        },
        hash: '0xg',
        type: TransactionType.incoming,
      });
    });
  });
});