metamask-extension/test/unit/app/controllers/transactions/tx-state-manager-test.js

import { strict as assert } from 'assert'
import sinon from 'sinon'
import TxStateManager from '../../../../../app/scripts/controllers/transactions/tx-state-manager'
import { snapshotFromTxMeta } from '../../../../../app/scripts/controllers/transactions/lib/tx-state-history-helpers'

const noop = () => true

describe('TransactionStateManager', function () {
  let txStateManager
  const currentNetworkId = '42'
  const otherNetworkId = '2'

  beforeEach(function () {
    txStateManager = new TxStateManager({
      initState: {
        transactions: [],
      },
      txHistoryLimit: 10,
      getNetwork: () => currentNetworkId,
    })
  })

  describe('#setTxStatusSigned', function () {
    it('sets the tx status to signed', function () {
      const tx = { id: 1, status: 'unapproved', metamaskNetworkId: currentNetworkId, txParams: {} }
      txStateManager.addTx(tx, noop)
      txStateManager.setTxStatusSigned(1)
      const result = txStateManager.getTxList()
      assert.ok(Array.isArray(result))
      assert.equal(result.length, 1)
      assert.equal(result[0].status, 'signed')
    })

    it('should emit a signed event to signal the execution of callback', function () {
      const tx = { id: 1, status: 'unapproved', metamaskNetworkId: currentNetworkId, txParams: {} }
      const clock = sinon.useFakeTimers()
      const noop = sinon.spy()

      txStateManager.addTx(tx)
      txStateManager.on('1:signed', noop)
      txStateManager.setTxStatusSigned(1)
      clock.runAll()
      clock.restore()

      assert.ok(noop.calledOnce)
    })
  })

  describe('#setTxStatusRejected', function () {
    it('sets the tx status to rejected and removes it from history', function () {
      const tx = { id: 1, status: 'unapproved', metamaskNetworkId: currentNetworkId, txParams: {} }
      txStateManager.addTx(tx)
      txStateManager.setTxStatusRejected(1)
      const result = txStateManager.getTxList()
      assert.ok(Array.isArray(result))
      assert.equal(result.length, 0)
    })

    it('should emit a rejected event to signal the execution of callback', function () {
      const tx = { id: 1, status: 'unapproved', metamaskNetworkId: currentNetworkId, txParams: {} }
      const clock = sinon.useFakeTimers()
      const noop = sinon.spy()

      txStateManager.addTx(tx)
      txStateManager.on('1:rejected', noop)
      txStateManager.setTxStatusRejected(1)
      clock.runAll()
      clock.restore()

      assert.ok(noop.calledOnce)
    })
  })

  describe('#getFullTxList', function () {
    it('when new should return empty array', function () {
      const result = txStateManager.getTxList()
      assert.ok(Array.isArray(result))
      assert.equal(result.length, 0)
    })
  })

  describe('#getTxList', function () {
    it('when new should return empty array', function () {
      const result = txStateManager.getTxList()
      assert.ok(Array.isArray(result))
      assert.equal(result.length, 0)
    })

    it('should return a full list of transactions', function () {
      const submittedTx = {
        id: 0,
        metamaskNetworkId: currentNetworkId,
        time: 0,
        txParams: {
          from: '0xAddress',
          to: '0xRecipient',
          nonce: '0x0',
        },
        status: 'submitted',
      }

      const confirmedTx = {
        id: 3,
        metamaskNetworkId: currentNetworkId,
        time: 3,
        txParams: {
          from: '0xAddress',
          to: '0xRecipient',
          nonce: '0x3',
        },
        status: 'confirmed',
      }

      const txm = new TxStateManager({
        initState: {
          transactions: [
            submittedTx,
            confirmedTx,
          ],
        },
        getNetwork: () => currentNetworkId,
      })

      assert.deepEqual(txm.getTxList(), [
        submittedTx,
        confirmedTx,
      ])
    })

    it('should return a list of transactions, limited by N unique nonces when there are NO duplicates', function () {
      const submittedTx0 = {
        id: 0,
        metamaskNetworkId: currentNetworkId,
        time: 0,
        txParams: {
          from: '0xAddress',
          to: '0xRecipient',
          nonce: '0x0',
        },
        status: 'submitted',
      }

      const unapprovedTx1 = {
        id: 1,
        metamaskNetworkId: currentNetworkId,
        time: 1,
        txParams: {
          from: '0xAddress',
          to: '0xRecipient',
          nonce: '0x1',
        },
        status: 'unapproved',
      }

      const approvedTx2 = {
        id: 2,
        metamaskNetworkId: currentNetworkId,
        time: 2,
        txParams: {
          from: '0xAddress',
          to: '0xRecipient',
          nonce: '0x2',
        },
        status: 'approved',
      }

      const confirmedTx3 = {
        id: 3,
        metamaskNetworkId: currentNetworkId,
        time: 3,
        txParams: {
          from: '0xAddress',
          to: '0xRecipient',
          nonce: '0x3',
        },
        status: 'confirmed',
      }

      const txm = new TxStateManager({
        initState: {
          transactions: [
            submittedTx0,
            unapprovedTx1,
            approvedTx2,
            confirmedTx3,
          ],
        },
        getNetwork: () => currentNetworkId,
      })

      assert.deepEqual(txm.getTxList(2), [
        approvedTx2,
        confirmedTx3,
      ])
    })

    it('should return a list of transactions, limited by N unique nonces when there ARE duplicates', function () {
      const submittedTx0s = [
        {
          id: 0,
          metamaskNetworkId: currentNetworkId,
          time: 0,
          txParams: {
            from: '0xAddress',
            to: '0xRecipient',
            nonce: '0x0',
          },
          status: 'submitted',
        },
        {
          id: 0,
          metamaskNetworkId: currentNetworkId,
          time: 0,
          txParams: {
            from: '0xAddress',
            to: '0xRecipient',
            nonce: '0x0',
          },
          status: 'submitted',
        },
      ]

      const unapprovedTx1 = {
        id: 1,
        metamaskNetworkId: currentNetworkId,
        time: 1,
        txParams: {
          from: '0xAddress',
          to: '0xRecipient',
          nonce: '0x1',
        },
        status: 'unapproved',
      }

      const approvedTx2s = [
        {
          id: 2,
          metamaskNetworkId: currentNetworkId,
          time: 2,
          txParams: {
            from: '0xAddress',
            to: '0xRecipient',
            nonce: '0x2',
          },
          status: 'approved',
        },
        {
          id: 2,
          metamaskNetworkId: currentNetworkId,
          time: 2,
          txParams: {
            from: '0xAddress',
            to: '0xRecipient',
            nonce: '0x2',
          },
          status: 'approved',
        },
      ]

      const failedTx3s = [
        {
          id: 3,
          metamaskNetworkId: currentNetworkId,
          time: 3,
          txParams: {
            from: '0xAddress',
            to: '0xRecipient',
            nonce: '0x3',
          },
          status: 'failed',
        },
        {
          id: 3,
          metamaskNetworkId: currentNetworkId,
          time: 3,
          txParams: {
            from: '0xAddress',
            to: '0xRecipient',
            nonce: '0x3',
          },
          status: 'failed',
        },
      ]

      const txm = new TxStateManager({
        initState: {
          transactions: [
            ...submittedTx0s,
            unapprovedTx1,
            ...approvedTx2s,
            ...failedTx3s,
          ],
        },
        getNetwork: () => currentNetworkId,
      })

      assert.deepEqual(txm.getTxList(2), [
        ...approvedTx2s,
        ...failedTx3s,
      ])
    })
  })

  describe('#addTx', function () {
    it('adds a tx returned in getTxList', function () {
      const tx = { id: 1, status: 'confirmed', metamaskNetworkId: currentNetworkId, txParams: {} }
      txStateManager.addTx(tx, noop)
      const result = txStateManager.getTxList()
      assert.ok(Array.isArray(result))
      assert.equal(result.length, 1)
      assert.equal(result[0].id, 1)
    })

    it('throws error and does not add tx if txParams are invalid', function () {
      const validTxParams = {
        from: '0x0dcd5d886577d5081b0c52e242ef29e70be3e7bc',
        to: '0x0039f22efb07a647557c7c5d17854cfd6d489ef3',
        nonce: '0x3',
        gas: '0x77359400',
        gasPrice: '0x77359400',
        value: '0x0',
        data: '0x0',
      }
      const invalidValues = [1, true, {}, Symbol('1')]

      Object.keys(validTxParams).forEach((key) => {
        for (const value of invalidValues) {
          const tx = {
            id: 1,
            status: 'unapproved',
            metamaskNetworkId: currentNetworkId,
            txParams: {
              ...validTxParams,
              [key]: value,
            },
          }
          assert.throws(txStateManager.addTx.bind(txStateManager, tx), 'addTx should throw error')
          const result = txStateManager.getTxList()
          assert.ok(Array.isArray(result), 'txList should be an array')
          assert.equal(result.length, 0, 'txList should be empty')
        }
      })
    })

    it('does not override txs from other networks', function () {
      const tx = { id: 1, status: 'confirmed', metamaskNetworkId: currentNetworkId, txParams: {} }
      const tx2 = { id: 2, status: 'confirmed', metamaskNetworkId: otherNetworkId, txParams: {} }
      txStateManager.addTx(tx, noop)
      txStateManager.addTx(tx2, noop)
      const result = txStateManager.getFullTxList()
      const result2 = txStateManager.getTxList()
      assert.equal(result.length, 2, 'txs were deleted')
      assert.equal(result2.length, 1, 'incorrect number of txs on network.')
    })

    it('cuts off early txs beyond a limit', function () {
      const limit = txStateManager.txHistoryLimit
      for (let i = 0; i < limit + 1; i++) {
        const tx = { id: i, time: new Date(), status: 'confirmed', metamaskNetworkId: currentNetworkId, txParams: {} }
        txStateManager.addTx(tx, noop)
      }
      const result = txStateManager.getTxList()
      assert.equal(result.length, limit, `limit of ${limit} txs enforced`)
      assert.equal(result[0].id, 1, 'early txs truncated')
    })

    it('cuts off early txs beyond a limit whether or not it is confirmed or rejected', function () {
      const limit = txStateManager.txHistoryLimit
      for (let i = 0; i < limit + 1; i++) {
        const tx = { id: i, time: new Date(), status: 'rejected', metamaskNetworkId: currentNetworkId, txParams: {} }
        txStateManager.addTx(tx, noop)
      }
      const result = txStateManager.getTxList()
      assert.equal(result.length, limit, `limit of ${limit} txs enforced`)
      assert.equal(result[0].id, 1, 'early txs truncated')
    })

    it('cuts off early txs beyond a limit but does not cut unapproved txs', function () {
      const unconfirmedTx = { id: 0, time: new Date(), status: 'unapproved', metamaskNetworkId: currentNetworkId, txParams: {} }
      txStateManager.addTx(unconfirmedTx, noop)
      const limit = txStateManager.txHistoryLimit
      for (let i = 1; i < limit + 1; i++) {
        const tx = { id: i, time: new Date(), status: 'confirmed', metamaskNetworkId: currentNetworkId, txParams: {} }
        txStateManager.addTx(tx, noop)
      }
      const result = txStateManager.getTxList()
      assert.equal(result.length, limit, `limit of ${limit} txs enforced`)
      assert.equal(result[0].id, 0, 'first tx should still be there')
      assert.equal(result[0].status, 'unapproved', 'first tx should be unapproved')
      assert.equal(result[1].id, 2, 'early txs truncated')
    })
  })

  describe('#updateTx', function () {
    it('replaces the tx with the same id', function () {
      txStateManager.addTx({ id: '1', status: 'unapproved', metamaskNetworkId: currentNetworkId, txParams: {} }, noop)
      txStateManager.addTx({ id: '2', status: 'confirmed', metamaskNetworkId: currentNetworkId, txParams: {} }, noop)
      const txMeta = txStateManager.getTx('1')
      txMeta.hash = 'foo'
      txStateManager.updateTx(txMeta)
      const result = txStateManager.getTx('1')
      assert.equal(result.hash, 'foo')
    })

    it('throws error and does not update tx if txParams are invalid', function () {
      const validTxParams = {
        from: '0x0dcd5d886577d5081b0c52e242ef29e70be3e7bc',
        to: '0x0039f22efb07a647557c7c5d17854cfd6d489ef3',
        nonce: '0x3',
        gas: '0x77359400',
        gasPrice: '0x77359400',
        value: '0x0',
        data: '0x0',
      }
      const invalidValues = [1, true, {}, Symbol('1')]

      txStateManager.addTx({ id: 1, status: 'unapproved', metamaskNetworkId: currentNetworkId, txParams: validTxParams })

      Object.keys(validTxParams).forEach((key) => {
        for (const value of invalidValues) {
          const originalTx = txStateManager.getTx(1)
          const newTx = {
            ...originalTx,
            txParams: {
              ...originalTx.txParams,
              [key]: value,
            },
          }
          assert.throws(txStateManager.updateTx.bind(txStateManager, newTx), 'updateTx should throw an error')
          const result = txStateManager.getTx(1)
          assert.deepEqual(result, originalTx, 'tx should not be updated')
        }
      })
    })

    it('updates gas price and adds history items', function () {
      const originalGasPrice = '0x01'
      const desiredGasPrice = '0x02'

      const txMeta = {
        id: '1',
        status: 'unapproved',
        metamaskNetworkId: currentNetworkId,
        txParams: {
          gasPrice: originalGasPrice,
        },
      }

      txStateManager.addTx(txMeta)
      const updatedTx = txStateManager.getTx('1')
      // verify tx was initialized correctly
      assert.equal(updatedTx.history.length, 1, 'one history item (initial)')
      assert.equal(Array.isArray(updatedTx.history[0]), false, 'first history item is initial state')
      assert.deepEqual(updatedTx.history[0], snapshotFromTxMeta(updatedTx), 'first history item is initial state')
      // modify value and updateTx
      updatedTx.txParams.gasPrice = desiredGasPrice
      const before = new Date().getTime()
      txStateManager.updateTx(updatedTx)
      const after = new Date().getTime()
      // check updated value
      const result = txStateManager.getTx('1')
      assert.equal(result.txParams.gasPrice, desiredGasPrice, 'gas price updated')
      // validate history was updated
      assert.equal(result.history.length, 2, 'two history items (initial + diff)')
      assert.equal(result.history[1].length, 1, 'two history state items (initial + diff)')

      const expectedEntry = { op: 'replace', path: '/txParams/gasPrice', value: desiredGasPrice }
      assert.deepEqual(result.history[1][0].op, expectedEntry.op, 'two history items (initial + diff) operation')
      assert.deepEqual(result.history[1][0].path, expectedEntry.path, 'two history items (initial + diff) path')
      assert.deepEqual(result.history[1][0].value, expectedEntry.value, 'two history items (initial + diff) value')
      assert.ok(result.history[1][0].timestamp >= before && result.history[1][0].timestamp <= after)
    })

    it('does NOT add empty history items', function () {
      const txMeta = {
        id: '1',
        status: 'unapproved',
        metamaskNetworkId: currentNetworkId,
        txParams: {
          gasPrice: '0x01',
        },
      }

      txStateManager.addTx(txMeta)
      txStateManager.updateTx(txMeta)

      const { history } = txStateManager.getTx('1')
      assert.equal(history.length, 1, 'two history items (initial + diff)')
    })
  })

  describe('#getUnapprovedTxList', function () {
    it('returns unapproved txs in a hash', function () {
      txStateManager.addTx({ id: '1', status: 'unapproved', metamaskNetworkId: currentNetworkId, txParams: {} }, noop)
      txStateManager.addTx({ id: '2', status: 'confirmed', metamaskNetworkId: currentNetworkId, txParams: {} }, noop)
      const result = txStateManager.getUnapprovedTxList()
      assert.equal(typeof result, 'object')
      assert.equal(result['1'].status, 'unapproved')
      assert.equal(result['2'], undefined)
    })
  })

  describe('#getTx', function () {
    it('returns a tx with the requested id', function () {
      txStateManager.addTx({ id: '1', status: 'unapproved', metamaskNetworkId: currentNetworkId, txParams: {} }, noop)
      txStateManager.addTx({ id: '2', status: 'confirmed', metamaskNetworkId: currentNetworkId, txParams: {} }, noop)
      assert.equal(txStateManager.getTx('1').status, 'unapproved')
      assert.equal(txStateManager.getTx('2').status, 'confirmed')
    })
  })

  describe('#getFilteredTxList', function () {
    it('returns a tx with the requested data', function () {
      const txMetas = [
        { id: 0, status: 'unapproved', txParams: { from: '0xaa', to: '0xbb' }, metamaskNetworkId: currentNetworkId },
        { id: 1, status: 'unapproved', txParams: { from: '0xaa', to: '0xbb' }, metamaskNetworkId: currentNetworkId },
        { id: 2, status: 'unapproved', txParams: { from: '0xaa', to: '0xbb' }, metamaskNetworkId: currentNetworkId },
        { id: 3, status: 'unapproved', txParams: { from: '0xbb', to: '0xaa' }, metamaskNetworkId: currentNetworkId },
        { id: 4, status: 'unapproved', txParams: { from: '0xbb', to: '0xaa' }, metamaskNetworkId: currentNetworkId },
        { id: 5, status: 'confirmed', txParams: { from: '0xaa', to: '0xbb' }, metamaskNetworkId: currentNetworkId },
        { id: 6, status: 'confirmed', txParams: { from: '0xaa', to: '0xbb' }, metamaskNetworkId: currentNetworkId },
        { id: 7, status: 'confirmed', txParams: { from: '0xbb', to: '0xaa' }, metamaskNetworkId: currentNetworkId },
        { id: 8, status: 'confirmed', txParams: { from: '0xbb', to: '0xaa' }, metamaskNetworkId: currentNetworkId },
        { id: 9, status: 'confirmed', txParams: { from: '0xbb', to: '0xaa' }, metamaskNetworkId: currentNetworkId },
      ]
      txMetas.forEach((txMeta) => txStateManager.addTx(txMeta, noop))
      let filterParams

      filterParams = { status: 'unapproved', from: '0xaa' }
      assert.equal(txStateManager.getFilteredTxList(filterParams).length, 3, `getFilteredTxList - ${JSON.stringify(filterParams)}`)
      filterParams = { status: 'unapproved', to: '0xaa' }
      assert.equal(txStateManager.getFilteredTxList(filterParams).length, 2, `getFilteredTxList - ${JSON.stringify(filterParams)}`)
      filterParams = { status: 'confirmed', from: '0xbb' }
      assert.equal(txStateManager.getFilteredTxList(filterParams).length, 3, `getFilteredTxList - ${JSON.stringify(filterParams)}`)
      filterParams = { status: 'confirmed' }
      assert.equal(txStateManager.getFilteredTxList(filterParams).length, 5, `getFilteredTxList - ${JSON.stringify(filterParams)}`)
      filterParams = { from: '0xaa' }
      assert.equal(txStateManager.getFilteredTxList(filterParams).length, 5, `getFilteredTxList - ${JSON.stringify(filterParams)}`)
      filterParams = { to: '0xaa' }
      assert.equal(txStateManager.getFilteredTxList(filterParams).length, 5, `getFilteredTxList - ${JSON.stringify(filterParams)}`)
      filterParams = { status: (status) => status !== 'confirmed' }
      assert.equal(txStateManager.getFilteredTxList(filterParams).length, 5, `getFilteredTxList - ${JSON.stringify(filterParams)}`)
    })
  })

  describe('#wipeTransactions', function () {

    const specificAddress = '0xaa'
    const otherAddress = '0xbb'

    it('should remove only the transactions from a specific address', function () {

      const txMetas = [
        { id: 0, status: 'unapproved', txParams: { from: specificAddress, to: otherAddress }, metamaskNetworkId: currentNetworkId },
        { id: 1, status: 'confirmed', txParams: { from: otherAddress, to: specificAddress }, metamaskNetworkId: currentNetworkId },
        { id: 2, status: 'confirmed', txParams: { from: otherAddress, to: specificAddress }, metamaskNetworkId: currentNetworkId },
      ]
      txMetas.forEach((txMeta) => txStateManager.addTx(txMeta, noop))

      txStateManager.wipeTransactions(specificAddress)

      const transactionsFromCurrentAddress = txStateManager.getTxList().filter((txMeta) => txMeta.txParams.from === specificAddress)
      const transactionsFromOtherAddresses = txStateManager.getTxList().filter((txMeta) => txMeta.txParams.from !== specificAddress)

      assert.equal(transactionsFromCurrentAddress.length, 0)
      assert.equal(transactionsFromOtherAddresses.length, 2)
    })

    it('should not remove the transactions from other networks', function () {
      const txMetas = [
        { id: 0, status: 'unapproved', txParams: { from: specificAddress, to: otherAddress }, metamaskNetworkId: currentNetworkId },
        { id: 1, status: 'confirmed', txParams: { from: specificAddress, to: otherAddress }, metamaskNetworkId: otherNetworkId },
        { id: 2, status: 'confirmed', txParams: { from: specificAddress, to: otherAddress }, metamaskNetworkId: otherNetworkId },
      ]

      txMetas.forEach((txMeta) => txStateManager.addTx(txMeta, noop))

      txStateManager.wipeTransactions(specificAddress)

      const txsFromCurrentNetworkAndAddress = txStateManager.getTxList().filter((txMeta) => txMeta.txParams.from === specificAddress)
      const txFromOtherNetworks = txStateManager.getFullTxList().filter((txMeta) => txMeta.metamaskNetworkId === otherNetworkId)

      assert.equal(txsFromCurrentNetworkAndAddress.length, 0)
      assert.equal(txFromOtherNetworks.length, 2)
    })
  })

  describe('#_removeTx', function () {
    it('should remove the transaction from the storage', function () {
      txStateManager._saveTxList([ { id: 1 } ])
      txStateManager._removeTx(1)
      assert.ok(!txStateManager.getFullTxList().length, 'txList should be empty')
    })

    it('should only remove the transaction with ID 1 from the storage', function () {
      txStateManager._saveTxList([ { id: 1 }, { id: 2 } ])
      txStateManager._removeTx(1)
      assert.equal(txStateManager.getFullTxList()[0].id, 2, 'txList should have a id of 2')
    })
  })

  describe('#clearUnapprovedTxs', function () {
    it('removes unapproved transactions', function () {
      const txMetas = [
        { id: 0, status: 'unapproved', txParams: { from: '0xaa', to: '0xbb' }, metamaskNetworkId: currentNetworkId },
        { id: 1, status: 'unapproved', txParams: { from: '0xaa', to: '0xbb' }, metamaskNetworkId: currentNetworkId },
        { id: 2, status: 'confirmed', txParams: { from: '0xaa', to: '0xbb' }, metamaskNetworkId: otherNetworkId },
        { id: 3, status: 'confirmed', txParams: { from: '0xaa', to: '0xbb' }, metamaskNetworkId: otherNetworkId },
      ]

      txMetas.forEach((txMeta) => txStateManager.addTx(txMeta, noop))

      txStateManager.clearUnapprovedTxs()

      const unapprovedTxList = txStateManager.getFullTxList().filter((tx) => tx.status === 'unapproved')

      assert.equal(unapprovedTxList.length, 0)
    })
  })
})