metamask-extension/app/scripts/controllers/network/pending-middleware.test.js

import { strict as assert } from 'assert';
import { GAS_LIMITS } from '../../../../shared/constants/gas';
import { TRANSACTION_ENVELOPE_TYPES } from '../../../../shared/constants/transaction';
import { txMetaStub } from '../../../../test/stub/tx-meta-stub';
import {
  createPendingNonceMiddleware,
  createPendingTxMiddleware,
} from './middleware/pending';

describe('PendingNonceMiddleware', function () {
  describe('#createPendingNonceMiddleware', function () {
    const getPendingNonce = async () => '0x2';
    const address = '0xF231D46dD78806E1DD93442cf33C7671f8538748';
    const pendingNonceMiddleware = createPendingNonceMiddleware({
      getPendingNonce,
    });

    it('should call next if not a eth_getTransactionCount request', function (done) {
      const req = { method: 'eth_getBlockByNumber' };
      const res = {};
      pendingNonceMiddleware(req, res, () => done());
    });
    it('should call next if not a "pending" block request', function (done) {
      const req = { method: 'eth_getTransactionCount', params: [address] };
      const res = {};
      pendingNonceMiddleware(req, res, () => done());
    });
    it('should fill the result with a the "pending" nonce', function (done) {
      const req = {
        method: 'eth_getTransactionCount',
        params: [address, 'pending'],
      };
      const res = {};
      pendingNonceMiddleware(
        req,
        res,
        () => {
          done(new Error('should not have called next'));
        },
        () => {
          assert(res.result === '0x2');
          done();
        },
      );
    });
  });

  describe('#createPendingTxMiddleware', function () {
    let returnUndefined = true;
    const getPendingTransactionByHash = () =>
      returnUndefined ? undefined : txMetaStub;
    const address = '0xF231D46dD78806E1DD93442cf33C7671f8538748';
    const pendingTxMiddleware = createPendingTxMiddleware({
      getPendingTransactionByHash,
    });
    const spec = {
      accessList: null,
      blockHash: null,
      blockNumber: null,
      from: '0xf231d46dd78806e1dd93442cf33c7671f8538748',
      gas: GAS_LIMITS.SIMPLE,
      gasPrice: '0x1e8480',
      hash:
        '0x2cc5a25744486f7383edebbf32003e5a66e18135799593d6b5cdd2bb43674f09',
      input: '0x',
      nonce: '0x4',
      type: TRANSACTION_ENVELOPE_TYPES.LEGACY,
      to: '0xf231d46dd78806e1dd93442cf33c7671f8538748',
      transactionIndex: null,
      value: '0x0',
      v: '0x2c',
      r: '0x5f973e540f2d3c2f06d3725a626b75247593cb36477187ae07ecfe0a4db3cf57',
      s: '0x0259b52ee8c58baaa385fb05c3f96116e58de89bcc165cb3bfdfc708672fed8a',
    };
    it('should call next if not a eth_getTransactionByHash request', function (done) {
      const req = { method: 'eth_getBlockByNumber' };
      const res = {};
      pendingTxMiddleware(req, res, () => done());
    });

    it('should call next if no pending txMeta is in history', function (done) {
      const req = { method: 'eth_getTransactionByHash', params: [address] };
      const res = {};
      pendingTxMiddleware(req, res, () => done());
    });

    it('should fill the result with a the "pending" tx the result should match the rpc spec', function (done) {
      returnUndefined = false;
      const req = {
        method: 'eth_getTransactionByHash',
        params: [address, 'pending'],
      };
      const res = {};
      pendingTxMiddleware(
        req,
        res,
        () => {
          done(new Error('should not have called next'));
        },
        () => {
          assert.deepStrictEqual(
            res.result,
            spec,
            new Error('result does not match the spec object'),
          );
          done();
        },
      );
    });
  });
});