metamask-extension/ui/app/selectors/tests/send.test.js

import assert from 'assert';
import sinon from 'sinon';
import {
  accountsWithSendEtherInfoSelector,
  getCurrentAccountWithSendEtherInfo,
} from '..';
import { TRANSACTION_STATUSES } from '../../../../shared/constants/transaction';
import {
  getBlockGasLimit,
  getConversionRate,
  getCurrentNetwork,
  getNativeCurrency,
  getGasLimit,
  getGasPrice,
  getGasTotal,
  getPrimaryCurrency,
  getSendToken,
  getSendTokenContract,
  getSendAmount,
  sendAmountIsInError,
  getSendEditingTransactionId,
  getSendErrors,
  getSendFrom,
  getSendFromBalance,
  getSendFromObject,
  getSendHexDataFeatureFlagState,
  getSendMaxModeState,
  getSendTo,
  getSendToAccounts,
  getTokenBalance,
  getUnapprovedTxs,
  gasFeeIsInError,
  getGasLoadingError,
  getGasButtonGroupShown,
  getTitleKey,
  isSendFormInError,
} from '../send';
import mockState from './send-selectors-test-data';

describe('send selectors', function () {
  const tempGlobalEth = { ...global.eth };
  beforeEach(function () {
    global.eth = {
      contract: sinon.stub().returns({
        at: (address) => `mockAt:${address}`,
      }),
    };
  });

  afterEach(function () {
    global.eth = tempGlobalEth;
  });

  describe('accountsWithSendEtherInfoSelector()', function () {
    it('should return an array of account objects with name info from identities', function () {
      assert.deepStrictEqual(accountsWithSendEtherInfoSelector(mockState), [
        {
          code: '0x',
          balance: '0x47c9d71831c76efe',
          nonce: '0x1b',
          address: '0xfdea65c8e26263f6d9a1b5de9555d2931a33b825',
          name: 'Send Account 1',
        },
        {
          code: '0x',
          balance: '0x37452b1315889f80',
          nonce: '0xa',
          address: '0xc5b8dbac4c1d3f152cdeb400e2313f309c410acb',
          name: 'Send Account 2',
        },
        {
          code: '0x',
          balance: '0x30c9d71831c76efe',
          nonce: '0x1c',
          address: '0x2f8d4a878cfa04a6e60d46362f5644deab66572d',
          name: 'Send Account 3',
        },
        {
          code: '0x',
          balance: '0x0',
          nonce: '0x0',
          address: '0xd85a4b6a394794842887b8284293d69163007bbb',
          name: 'Send Account 4',
        },
      ]);
    });
  });

  describe('getBlockGasLimit', function () {
    it('should return the current block gas limit', function () {
      assert.deepStrictEqual(getBlockGasLimit(mockState), '0x4c1878');
    });
  });

  describe('getConversionRate()', function () {
    it('should return the eth conversion rate', function () {
      assert.deepStrictEqual(getConversionRate(mockState), 1200.88200327);
    });
  });

  describe('getCurrentAccountWithSendEtherInfo()', function () {
    it('should return the currently selected account with identity info', function () {
      assert.deepStrictEqual(getCurrentAccountWithSendEtherInfo(mockState), {
        code: '0x',
        balance: '0x0',
        nonce: '0x0',
        address: '0xd85a4b6a394794842887b8284293d69163007bbb',
        name: 'Send Account 4',
      });
    });
  });

  describe('getNativeCurrency()', function () {
    it('should return the ticker symbol of the selected network', function () {
      assert.strictEqual(getNativeCurrency(mockState), 'ETH');
    });
  });

  describe('getCurrentNetwork()', function () {
    it('should return the id of the currently selected network', function () {
      assert.strictEqual(getCurrentNetwork(mockState), '3');
    });
  });

  describe('getGasLimit()', function () {
    it('should return the send.gasLimit', function () {
      assert.strictEqual(getGasLimit(mockState), '0xFFFF');
    });
  });

  describe('getGasPrice()', function () {
    it('should return the send.gasPrice', function () {
      assert.strictEqual(getGasPrice(mockState), '0xaa');
    });
  });

  describe('getGasTotal()', function () {
    it('should return the send.gasTotal', function () {
      assert.strictEqual(getGasTotal(mockState), 'a9ff56');
    });
  });

  describe('getPrimaryCurrency()', function () {
    it('should return the symbol of the send token', function () {
      assert.strictEqual(
        getPrimaryCurrency({
          metamask: { send: { token: { symbol: 'DEF' } } },
        }),
        'DEF',
      );
    });
  });

  describe('getSendToken()', function () {
    it('should return the current send token if set', function () {
      assert.deepStrictEqual(
        getSendToken({
          metamask: {
            send: {
              token: {
                address: '0x8d6b81208414189a58339873ab429b6c47ab92d3',
                decimals: 4,
                symbol: 'DEF',
              },
            },
          },
        }),
        {
          address: '0x8d6b81208414189a58339873ab429b6c47ab92d3',
          decimals: 4,
          symbol: 'DEF',
        },
      );
    });
  });

  describe('getSendTokenContract()', function () {
    it('should return the contract at the send token address', function () {
      assert.strictEqual(
        getSendTokenContract({
          metamask: {
            send: {
              token: {
                address: '0x8d6b81208414189a58339873ab429b6c47ab92d3',
                decimals: 4,
                symbol: 'DEF',
              },
            },
          },
        }),
        'mockAt:0x8d6b81208414189a58339873ab429b6c47ab92d3',
      );
    });

    it('should return null if send token is not set', function () {
      const modifiedMetamaskState = { ...mockState.metamask, send: {} };
      assert.strictEqual(
        getSendTokenContract({ ...mockState, metamask: modifiedMetamaskState }),
        null,
      );
    });
  });

  describe('getSendAmount()', function () {
    it('should return the send.amount', function () {
      assert.strictEqual(getSendAmount(mockState), '0x080');
    });
  });

  describe('getSendEditingTransactionId()', function () {
    it('should return the send.editingTransactionId', function () {
      assert.strictEqual(getSendEditingTransactionId(mockState), 97531);
    });
  });

  describe('getSendErrors()', function () {
    it('should return the send.errors', function () {
      assert.deepStrictEqual(getSendErrors(mockState), { someError: null });
    });
  });

  describe('getSendHexDataFeatureFlagState()', function () {
    it('should return the sendHexData feature flag state', function () {
      assert.deepStrictEqual(getSendHexDataFeatureFlagState(mockState), true);
    });
  });

  describe('getSendFrom()', function () {
    it('should return the send.from', function () {
      assert.deepStrictEqual(
        getSendFrom(mockState),
        '0xc5b8dbac4c1d3f152cdeb400e2313f309c410acb',
      );
    });
  });

  describe('getSendFromBalance()', function () {
    it('should get the send.from balance if it exists', function () {
      assert.strictEqual(getSendFromBalance(mockState), '0x37452b1315889f80');
    });

    it('should get the selected account balance if the send.from does not exist', function () {
      const editedMockState = {
        metamask: {
          ...mockState.metamask,
          send: {
            from: null,
          },
        },
      };
      assert.strictEqual(getSendFromBalance(editedMockState), '0x0');
    });
  });

  describe('getSendFromObject()', function () {
    it('should return send.from if it exists', function () {
      assert.deepStrictEqual(getSendFromObject(mockState), {
        address: '0xc5b8dbac4c1d3f152cdeb400e2313f309c410acb',
        balance: '0x37452b1315889f80',
        code: '0x',
        nonce: '0xa',
      });
    });

    it('should return the current account if send.from does not exist', function () {
      const editedMockState = {
        metamask: {
          ...mockState.metamask,
          send: {
            from: null,
          },
        },
      };
      assert.deepStrictEqual(getSendFromObject(editedMockState), {
        code: '0x',
        balance: '0x0',
        nonce: '0x0',
        address: '0xd85a4b6a394794842887b8284293d69163007bbb',
      });
    });
  });

  describe('getSendMaxModeState()', function () {
    it('should return send.maxModeOn', function () {
      assert.strictEqual(getSendMaxModeState(mockState), false);
    });
  });

  describe('getSendTo()', function () {
    it('should return send.to', function () {
      assert.strictEqual(getSendTo(mockState), '0x987fedabc');
    });
  });

  describe('getSendToAccounts()', function () {
    it('should return an array including all the users accounts and the address book', function () {
      assert.deepStrictEqual(getSendToAccounts(mockState), [
        {
          code: '0x',
          balance: '0x47c9d71831c76efe',
          nonce: '0x1b',
          address: '0xfdea65c8e26263f6d9a1b5de9555d2931a33b825',
          name: 'Send Account 1',
        },
        {
          code: '0x',
          balance: '0x37452b1315889f80',
          nonce: '0xa',
          address: '0xc5b8dbac4c1d3f152cdeb400e2313f309c410acb',
          name: 'Send Account 2',
        },
        {
          code: '0x',
          balance: '0x30c9d71831c76efe',
          nonce: '0x1c',
          address: '0x2f8d4a878cfa04a6e60d46362f5644deab66572d',
          name: 'Send Account 3',
        },
        {
          code: '0x',
          balance: '0x0',
          nonce: '0x0',
          address: '0xd85a4b6a394794842887b8284293d69163007bbb',
          name: 'Send Account 4',
        },
        {
          address: '0x06195827297c7a80a443b6894d3bdb8824b43896',
          name: 'Address Book Account 1',
          chainId: '0x3',
        },
      ]);
    });
  });

  describe('getTokenBalance()', function () {
    it('should', function () {
      assert.strictEqual(getTokenBalance(mockState), 3434);
    });
  });

  describe('getUnapprovedTxs()', function () {
    it('should return the unapproved txs', function () {
      assert.deepStrictEqual(getUnapprovedTxs(mockState), {
        4768706228115573: {
          id: 4768706228115573,
          time: 1487363153561,
          status: TRANSACTION_STATUSES.UNAPPROVED,
          gasMultiplier: 1,
          metamaskNetworkId: '3',
          txParams: {
            from: '0xc5b8dbac4c1d3f152cdeb400e2313f309c410acb',
            to: '0x18a3462427bcc9133bb46e88bcbe39cd7ef0e761',
            value: '0xde0b6b3a7640000',
            metamaskId: 4768706228115573,
            metamaskNetworkId: '3',
            gas: '0x5209',
          },
          txFee: '17e0186e60800',
          txValue: 'de0b6b3a7640000',
          maxCost: 'de234b52e4a0800',
          gasPrice: '4a817c800',
        },
      });
    });
  });

  describe('send-amount-row selectors', function () {
    describe('sendAmountIsInError()', function () {
      it('should return true if send.errors.amount is truthy', function () {
        const state = {
          send: {
            errors: {
              amount: 'abc',
            },
          },
        };

        assert.strictEqual(sendAmountIsInError(state), true);
      });

      it('should return false if send.errors.amount is falsy', function () {
        const state = {
          send: {
            errors: {
              amount: null,
            },
          },
        };

        assert.strictEqual(sendAmountIsInError(state), false);
      });
    });
  });

  describe('send-gas-row selectors', function () {
    describe('getGasLoadingError()', function () {
      it('should return send.errors.gasLoading', function () {
        const state = {
          send: {
            errors: {
              gasLoading: 'abc',
            },
          },
        };

        assert.strictEqual(getGasLoadingError(state), 'abc');
      });
    });

    describe('gasFeeIsInError()', function () {
      it('should return true if send.errors.gasFee is truthy', function () {
        const state = {
          send: {
            errors: {
              gasFee: 'def',
            },
          },
        };

        assert.strictEqual(gasFeeIsInError(state), true);
      });

      it('should return false send.errors.gasFee is falsely', function () {
        const state = {
          send: {
            errors: {
              gasFee: null,
            },
          },
        };

        assert.strictEqual(gasFeeIsInError(state), false);
      });
    });

    describe('getGasButtonGroupShown()', function () {
      it('should return send.gasButtonGroupShown', function () {
        const state = {
          send: {
            gasButtonGroupShown: 'foobar',
          },
        };

        assert.strictEqual(getGasButtonGroupShown(state), 'foobar');
      });
    });
  });

  describe('send-header selectors', function () {
    const getMetamaskSendMockState = (send) => {
      return {
        metamask: {
          send: { ...send },
        },
      };
    };

    describe('getTitleKey()', function () {
      it('should return the correct key when "to" is empty', function () {
        assert.strictEqual(
          getTitleKey(getMetamaskSendMockState({})),
          'addRecipient',
        );
      });

      it('should return the correct key when getSendEditingTransactionId is truthy', function () {
        assert.strictEqual(
          getTitleKey(
            getMetamaskSendMockState({
              to: true,
              editingTransactionId: true,
              token: {},
            }),
          ),
          'edit',
        );
      });

      it('should return the correct key when getSendEditingTransactionId is falsy and getSendToken is truthy', function () {
        assert.strictEqual(
          getTitleKey(
            getMetamaskSendMockState({
              to: true,
              editingTransactionId: false,
              token: {},
            }),
          ),
          'sendTokens',
        );
      });

      it('should return the correct key when getSendEditingTransactionId is falsy and getSendToken is falsy', function () {
        assert.strictEqual(
          getTitleKey(
            getMetamaskSendMockState({
              to: true,
              editingTransactionId: false,
              token: null,
            }),
          ),
          'sendETH',
        );
      });
    });
  });

  describe('send-footer selectors', function () {
    const getSendMockState = (send) => {
      return {
        send: { ...send },
      };
    };

    describe('isSendFormInError()', function () {
      it('should return true if any of the values of the object returned by getSendErrors are truthy', function () {
        assert.strictEqual(
          isSendFormInError(
            getSendMockState({
              errors: [true],
            }),
          ),
          true,
        );
      });

      it('should return false if all of the values of the object returned by getSendErrors are falsy', function () {
        assert.strictEqual(
          isSendFormInError(
            getSendMockState({
              errors: [],
            }),
          ),
          false,
        );
        assert.strictEqual(
          isSendFormInError(
            getSendMockState({
              errors: [false],
            }),
          ),
          false,
        );
      });
    });
  });
});