Auto-detect tokens #3034 (#4683)

* detect tokens polling

* network store to detect token

* tests for spec

* passtest-lint

* fix lint

* improve tests

* detect tokens through infura

* detect tokens when submit password and new account selected

* keyring unlocked detect and unit tests

* add changelog

1 files changed, 120 insertions, 0 deletions

diff --git a/test/unit/app/controllers/detect-tokens-test.js b/test/unit/app/controllers/detect-tokens-test.js
new file mode 100644
index 000000000..dcb3c431f
--- /dev/null
+++ b/test/unit/app/controllers/detect-tokens-test.js
@@ -0,0 +1,120 @@
+const assert = require('assert')
+const sinon = require('sinon')
+const ObservableStore = require('obs-store')
+const DetectTokensController = require('../../../../app/scripts/controllers/detect-tokens')
+const NetworkController = require('../../../../app/scripts/controllers/network/network')
+const PreferencesController = require('../../../../app/scripts/controllers/preferences')
+
+describe('DetectTokensController', () => {
+    const sandbox = sinon.createSandbox()
+    let clock
+    let keyringMemStore
+    before(async () => {
+      keyringMemStore = new ObservableStore({ isUnlocked: false})
+    })
+      after(() => {
+        sandbox.restore()
+  })
+
+  it('should poll on correct interval', async () => {
+    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 () => {
+    clock = sandbox.useFakeTimers()
+    const network = new NetworkController()
+    network.setProviderType('mainnet')
+    const preferences = new PreferencesController()
+    const controller = new DetectTokensController({ preferences: preferences, network: network, keyringMemStore: keyringMemStore })
+    controller.isActive = true
+
+    var 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 in test network', async () => {
+    const network = new NetworkController()
+    network.setProviderType('rinkeby')
+    const preferences = new PreferencesController()
+    const controller = new DetectTokensController({ preferences: preferences, network: network, keyringMemStore: keyringMemStore })
+    controller.isActive = true
+
+    var stub = sandbox.stub(controller, 'detectTokenBalance')
+        .withArgs('0x0D262e5dC4A06a0F1c90cE79C7a60C09DfC884E4').returns(true)
+        .withArgs('0xBC86727E770de68B1060C91f6BB6945c73e10388').returns(true)
+
+    await controller.detectNewTokens()
+    sandbox.assert.notCalled(stub)
+  })
+
+  it('should only check and add tokens while in main network', async () => {
+    const network = new NetworkController()
+    network.setProviderType('mainnet')
+    const preferences = new PreferencesController()
+    const controller = new DetectTokensController({ preferences: preferences, network: network, keyringMemStore: keyringMemStore })
+    controller.isActive = true
+
+    sandbox.stub(controller, 'detectTokenBalance')
+        .withArgs('0x0D262e5dC4A06a0F1c90cE79C7a60C09DfC884E4')
+        .returns(preferences.addToken('0x0d262e5dc4a06a0f1c90ce79c7a60c09dfc884e4', 'J8T', 8))
+        .withArgs('0xBC86727E770de68B1060C91f6BB6945c73e10388')
+        .returns(preferences.addToken('0xbc86727e770de68b1060c91f6bb6945c73e10388', 'XNK', 18))
+
+    await controller.detectNewTokens()
+    assert.deepEqual(preferences.store.getState().tokens, [{address: '0x0d262e5dc4a06a0f1c90ce79c7a60c09dfc884e4', decimals: 8, symbol: 'J8T'},
+        {address: '0xbc86727e770de68b1060c91f6bb6945c73e10388', decimals: 18, symbol: 'XNK'}])
+  })
+
+  it('should not detect same token while in main network', async () => {
+    const network = new NetworkController()
+    network.setProviderType('mainnet')
+    const preferences = new PreferencesController()
+    preferences.addToken('0x0d262e5dc4a06a0f1c90ce79c7a60c09dfc884e4', 'J8T', 8)
+    const controller = new DetectTokensController({ preferences: preferences, network: network, keyringMemStore: keyringMemStore })
+    controller.isActive = true
+
+    sandbox.stub(controller, 'detectTokenBalance')
+      .withArgs('0x0D262e5dC4A06a0F1c90cE79C7a60C09DfC884E4')
+      .returns(preferences.addToken('0x0d262e5dc4a06a0f1c90ce79c7a60c09dfc884e4', 'J8T', 8))
+      .withArgs('0xBC86727E770de68B1060C91f6BB6945c73e10388')
+      .returns(preferences.addToken('0xbc86727e770de68b1060c91f6bb6945c73e10388', 'XNK', 18))
+
+    await controller.detectNewTokens()
+    assert.deepEqual(preferences.store.getState().tokens, [{address: '0x0d262e5dc4a06a0f1c90ce79c7a60c09dfc884e4', decimals: 8, symbol: 'J8T'},
+        {address: '0xbc86727e770de68b1060c91f6bb6945c73e10388', decimals: 18, symbol: 'XNK'}])
+  })
+
+  it('should trigger detect new tokens when change address', async () => {
+    const network = new NetworkController()
+    network.setProviderType('mainnet')
+    const preferences = new PreferencesController()
+    const controller = new DetectTokensController({ preferences: preferences, network: network, keyringMemStore: keyringMemStore })
+    controller.isActive = true
+    var stub = sandbox.stub(controller, 'detectNewTokens')
+    await preferences.setSelectedAddress('0xbc86727e770de68b1060c91f6bb6945c73e10388')
+    sandbox.assert.called(stub)
+  })
+
+  it('should trigger detect new tokens when submit password', async () => {
+    const network = new NetworkController()
+    network.setProviderType('mainnet')
+    const preferences = new PreferencesController()
+    const controller = new DetectTokensController({ preferences: preferences, network: network, keyringMemStore: keyringMemStore })
+    controller.isActive = true
+    controller.selectedAddress = '0x0'
+    var stub = sandbox.stub(controller, 'detectNewTokens')
+    await controller._keyringMemStore.updateState({ isUnlocked: true })
+    sandbox.assert.called(stub)
+  })
+})