import { strict as assert } from 'assert'; import sinon from 'sinon'; import nock from 'nock'; import { ObservableStore } from '@metamask/obs-store'; import BigNumber from 'bignumber.js'; import { ControllerMessenger, TokenListController, TokensController, } from '@metamask/controllers'; import { MAINNET, MAINNET_NETWORK_ID, ROPSTEN, } from '../../../shared/constants/network'; import { toChecksumHexAddress } from '../../../shared/modules/hexstring-utils'; import DetectTokensController from './detect-tokens'; import NetworkController from './network'; import PreferencesController from './preferences'; const tokenIconsApiBaseUrl = 'https://static.metaswap.codefi.network/api/v1/tokenIcons'; describe('DetectTokensController', function () { let tokenListController; const sandbox = sinon.createSandbox(); let keyringMemStore, network, preferences, provider, tokensController; const noop = () => undefined; const networkControllerProviderConfig = { getAccounts: noop, }; beforeEach(async function () { keyringMemStore = new ObservableStore({ isUnlocked: false }); network = new NetworkController(); network.setInfuraProjectId('foo'); network.initializeProvider(networkControllerProviderConfig); provider = network.getProviderAndBlockTracker().provider; preferences = new PreferencesController({ network, provider }); tokensController = new TokensController({ onPreferencesStateChange: preferences.store.subscribe.bind( preferences.store, ), onNetworkStateChange: network.store.subscribe.bind(network.store), }); preferences.setAddresses([ '0x7e57e2', '0xbc86727e770de68b1060c91f6bb6945c73e10388', ]); preferences.setUseTokenDetection(true); sandbox .stub(network, 'getLatestBlock') .callsFake(() => Promise.resolve({})); sandbox .stub(tokensController, '_instantiateNewEthersProvider') .returns(null); sandbox .stub(tokensController, '_detectIsERC721') .returns(Promise.resolve(false)); nock('https://token-api.metaswap.codefi.network') .get(`/tokens/1`) .reply(200, [ { address: '0xc011a73ee8576fb46f5e1c5751ca3b9fe0af2a6f', symbol: 'SNX', decimals: 18, occurrences: 11, aggregators: [ 'paraswap', 'pmm', 'airswapLight', 'zeroEx', 'bancor', 'coinGecko', 'zapper', 'kleros', 'zerion', 'cmc', 'oneInch', ], name: 'Synthetix', iconUrl: 'https://airswap-token-images.s3.amazonaws.com/SNX.png', }, { address: '0x514910771af9ca656af840dff83e8264ecf986ca', symbol: 'LINK', decimals: 18, occurrences: 11, aggregators: [ 'paraswap', 'pmm', 'airswapLight', 'zeroEx', 'bancor', 'coinGecko', 'zapper', 'kleros', 'zerion', 'cmc', 'oneInch', ], name: 'Chainlink', iconUrl: 'https://s3.amazonaws.com/airswap-token-images/LINK.png', }, { address: '0x1f573d6fb3f13d689ff844b4ce37794d79a7ff1c', symbol: 'BNT', decimals: 18, occurrences: 11, aggregators: [ 'paraswap', 'pmm', 'airswapLight', 'zeroEx', 'bancor', 'coinGecko', 'zapper', 'kleros', 'zerion', 'cmc', 'oneInch', ], name: 'Bancor', iconUrl: 'https://s3.amazonaws.com/airswap-token-images/BNT.png', }, ]) .get(`/tokens/3`) .reply(200, { error: 'ChainId 3 is not supported' }) .persist(); const tokenListMessenger = new ControllerMessenger().getRestricted({ name: 'TokenListController', }); tokenListController = new TokenListController({ chainId: '1', onNetworkStateChange: sinon.spy(), onPreferencesStateChange: sinon.spy(), messenger: tokenListMessenger, }); await tokenListController.start(); }); after(function () { sandbox.restore(); }); it('should poll on correct interval', async function () { const stub = sinon.stub(global, 'setInterval'); new DetectTokensController({ interval: 1337 }); // eslint-disable-line no-new assert.strictEqual(stub.getCall(0).args[1], 1337); stub.restore(); }); it('should be called on every polling period', async function () { const clock = sandbox.useFakeTimers(); network.setProviderType(MAINNET); const controller = new DetectTokensController({ preferences, network, keyringMemStore, tokenList: tokenListController, tokensController, }); controller.isOpen = true; controller.isUnlocked = true; const stub = sandbox.stub(controller, 'detectNewTokens'); clock.tick(1); sandbox.assert.notCalled(stub); clock.tick(180000); sandbox.assert.called(stub); clock.tick(180000); sandbox.assert.calledTwice(stub); clock.tick(180000); sandbox.assert.calledThrice(stub); }); it('should not check tokens while on test network', async function () { sandbox.useFakeTimers(); network.setProviderType(ROPSTEN); const tokenListMessengerRopsten = new ControllerMessenger().getRestricted({ name: 'TokenListController', }); tokenListController = new TokenListController({ chainId: '3', onNetworkStateChange: sinon.spy(), onPreferencesStateChange: sinon.spy(), messenger: tokenListMessengerRopsten, }); await tokenListController.start(); const controller = new DetectTokensController({ preferences, network, keyringMemStore, tokenList: tokenListController, tokensController, }); controller.isOpen = true; controller.isUnlocked = true; const stub = sandbox.stub(controller, '_getTokenBalances'); await controller.detectNewTokens(); sandbox.assert.notCalled(stub); }); it('should skip adding tokens listed in hiddenTokens array', async function () { sandbox.useFakeTimers(); network.setProviderType(MAINNET); const controller = new DetectTokensController({ preferences, network, keyringMemStore, tokenList: tokenListController, tokensController, }); controller.isOpen = true; controller.isUnlocked = true; const { tokenList } = tokenListController.state; const erc20ContractAddresses = Object.keys(tokenList); const existingTokenAddress = erc20ContractAddresses[0]; const existingToken = tokenList[existingTokenAddress]; await tokensController.addToken( existingTokenAddress, existingToken.symbol, existingToken.decimals, ); const tokenAddressToSkip = erc20ContractAddresses[1]; const tokenToSkip = tokenList[tokenAddressToSkip]; await tokensController.addToken( tokenAddressToSkip, tokenToSkip.symbol, tokenToSkip.decimals, ); sandbox .stub(controller, '_getTokenBalances') .callsFake((tokensToDetect) => tokensToDetect.map((token) => token === tokenAddressToSkip ? new BigNumber(10) : 0, ), ); await tokensController.ignoreTokens([tokenAddressToSkip]); await controller.detectNewTokens(); assert.deepEqual(tokensController.state.tokens, [ { address: toChecksumHexAddress(existingTokenAddress), decimals: existingToken.decimals, symbol: existingToken.symbol, aggregators: [], image: `${tokenIconsApiBaseUrl}/${MAINNET_NETWORK_ID}/${existingTokenAddress}.png`, isERC721: false, }, ]); }); it('should check and add tokens while on main network', async function () { sandbox.useFakeTimers(); network.setProviderType(MAINNET); const controller = new DetectTokensController({ preferences, network, keyringMemStore, tokenList: tokenListController, tokensController, }); controller.isOpen = true; controller.isUnlocked = true; const { tokenList } = tokenListController.state; const erc20ContractAddresses = Object.keys(tokenList); const existingTokenAddress = erc20ContractAddresses[0]; const existingToken = tokenList[existingTokenAddress]; await tokensController.addToken( existingTokenAddress, existingToken.symbol, existingToken.decimals, ); const tokenAddressToAdd = erc20ContractAddresses[1]; const tokenToAdd = tokenList[tokenAddressToAdd]; const contractAddressesToDetect = erc20ContractAddresses.filter( (address) => address !== existingTokenAddress, ); const indexOfTokenToAdd = contractAddressesToDetect.indexOf( tokenAddressToAdd, ); const balances = new Array(contractAddressesToDetect.length); balances[indexOfTokenToAdd] = new BigNumber(10); sandbox .stub(controller, '_getTokenBalances') .returns(Promise.resolve(balances)); await controller.detectNewTokens(); assert.deepEqual(tokensController.state.tokens, [ { address: toChecksumHexAddress(existingTokenAddress), decimals: existingToken.decimals, symbol: existingToken.symbol, isERC721: false, aggregators: [], image: `${tokenIconsApiBaseUrl}/${MAINNET_NETWORK_ID}/${existingTokenAddress}.png`, }, { address: toChecksumHexAddress(tokenAddressToAdd), decimals: tokenToAdd.decimals, symbol: tokenToAdd.symbol, isERC721: false, aggregators: [], image: `${tokenIconsApiBaseUrl}/${MAINNET_NETWORK_ID}/${tokenAddressToAdd}.png`, }, ]); }); it('should check and add tokens while on non-default Mainnet', async function () { sandbox.useFakeTimers(); network.setRpcTarget('https://some-fake-RPC-endpoint.metamask.io', '0x1'); const controller = new DetectTokensController({ preferences, network, keyringMemStore, tokenList: tokenListController, tokensController, }); controller.isOpen = true; controller.isUnlocked = true; const { tokenList } = tokenListController.state; const erc20ContractAddresses = Object.keys(tokenList); const existingTokenAddress = erc20ContractAddresses[0]; const existingToken = tokenList[existingTokenAddress]; await tokensController.addToken( existingTokenAddress, existingToken.symbol, existingToken.decimals, ); const tokenAddressToAdd = erc20ContractAddresses[1]; const tokenToAdd = tokenList[tokenAddressToAdd]; const contractAddressesToDetect = erc20ContractAddresses.filter( (address) => address !== existingTokenAddress, ); const indexOfTokenToAdd = contractAddressesToDetect.indexOf( tokenAddressToAdd, ); const balances = new Array(contractAddressesToDetect.length); balances[indexOfTokenToAdd] = new BigNumber(10); sandbox .stub(controller, '_getTokenBalances') .returns(Promise.resolve(balances)); await controller.detectNewTokens(); assert.deepEqual(tokensController.state.tokens, [ { address: toChecksumHexAddress(existingTokenAddress), decimals: existingToken.decimals, symbol: existingToken.symbol, image: `${tokenIconsApiBaseUrl}/${MAINNET_NETWORK_ID}/${existingTokenAddress}.png`, isERC721: false, aggregators: [], }, { address: toChecksumHexAddress(tokenAddressToAdd), decimals: tokenToAdd.decimals, symbol: tokenToAdd.symbol, image: `${tokenIconsApiBaseUrl}/${MAINNET_NETWORK_ID}/${tokenAddressToAdd}.png`, isERC721: false, aggregators: [], }, ]); }); it('should trigger detect new tokens when change address', async function () { sandbox.useFakeTimers(); const controller = new DetectTokensController({ preferences, network, keyringMemStore, tokenList: tokenListController, tokensController, }); controller.isOpen = true; controller.isUnlocked = true; const stub = sandbox.stub(controller, 'detectNewTokens'); await preferences.setSelectedAddress( '0xbc86727e770de68b1060c91f6bb6945c73e10388', ); sandbox.assert.called(stub); }); it('should trigger detect new tokens when submit password', async function () { sandbox.useFakeTimers(); const controller = new DetectTokensController({ preferences, network, keyringMemStore, tokenList: tokenListController, tokensController, }); controller.isOpen = true; controller.selectedAddress = '0x0'; const stub = sandbox.stub(controller, 'detectNewTokens'); await controller._keyringMemStore.updateState({ isUnlocked: true }); sandbox.assert.called(stub); }); it('should not trigger detect new tokens when not unlocked', async function () { const clock = sandbox.useFakeTimers(); network.setProviderType(MAINNET); const controller = new DetectTokensController({ preferences, network, keyringMemStore, tokenList: tokenListController, tokensController, }); controller.isOpen = true; controller.isUnlocked = false; const stub = sandbox.stub(controller, '_getTokenBalances'); clock.tick(180000); sandbox.assert.notCalled(stub); }); it('should not trigger detect new tokens when not open', async function () { const clock = sandbox.useFakeTimers(); network.setProviderType(MAINNET); const controller = new DetectTokensController({ preferences, network, keyringMemStore, tokensController, }); // trigger state update from preferences controller await preferences.setSelectedAddress( '0xbc86727e770de68b1060c91f6bb6945c73e10388', ); controller.isOpen = false; controller.isUnlocked = true; const stub = sandbox.stub(controller, '_getTokenBalances'); clock.tick(180000); sandbox.assert.notCalled(stub); }); });