Merge pull request #4625 from MetaMask/initial-trezor-support

Initial trezor support

3 files changed, 228 insertions, 0 deletions

diff --git a/test/e2e/beta/from-import-beta-ui.spec.js b/test/e2e/beta/from-import-beta-ui.spec.js
index b396dc5b9..32f57b157 100644
--- a/test/e2e/beta/from-import-beta-ui.spec.js
+++ b/test/e2e/beta/from-import-beta-ui.spec.js
@@ -321,4 +321,51 @@ describe('Using MetaMask with an existing account', function () {
     })
   })
 
+  describe('Connects to a Hardware wallet', () => {
+    it('choose Connect Hardware Wallet from the account menu', async () => {
+      await driver.findElement(By.css('.account-menu__icon')).click()
+      await delay(regularDelayMs)
+
+      const [connectAccount] = await findElements(driver, By.xpath(`//div[contains(text(), 'Connect Hardware Wallet')]`))
+      await connectAccount.click()
+      await delay(regularDelayMs)
+    })
+
+    it('should open the TREZOR Connect popup', async () => {
+      const connectButtons = await findElements(driver, By.xpath(`//button[contains(text(), 'Connect to Trezor')]`))
+      await connectButtons[0].click()
+      await delay(regularDelayMs)
+      const allWindows = await driver.getAllWindowHandles()
+      switch (process.env.SELENIUM_BROWSER) {
+        case 'chrome':
+          assert.equal(allWindows.length, 2)
+          break
+        default:
+          assert.equal(allWindows.length, 1)
+      }
+    })
+
+    it('should show the "Browser not supported" screen for non Chrome browsers', async () => {
+      if (process.env.SELENIUM_BROWSER !== 'chrome') {
+        const title = await findElements(driver, By.xpath(`//h3[contains(text(), 'Your Browser is not supported...')]`))
+        assert.equal(title.length, 1)
+
+        const downloadChromeButtons = await findElements(driver, By.xpath(`//button[contains(text(), 'Download Google Chrome')]`))
+        assert.equal(downloadChromeButtons.length, 1)
+
+        await downloadChromeButtons[0].click()
+        await delay(regularDelayMs)
+
+        const [newUITab, downloadChromeTab] = await driver.getAllWindowHandles()
+
+        await driver.switchTo().window(downloadChromeTab)
+        await delay(regularDelayMs)
+        const tabUrl = await driver.getCurrentUrl()
+        assert.equal(tabUrl, 'https://www.google.com/chrome/')
+        await driver.close()
+        await delay(regularDelayMs)
+        await driver.switchTo().window(newUITab)
+      }
+    })
+  })
 })
diff --git a/test/unit/app/controllers/metamask-controller-test.js b/test/unit/app/controllers/metamask-controller-test.js
index 0dda4609b..9164fe246 100644
--- a/test/unit/app/controllers/metamask-controller-test.js
+++ b/test/unit/app/controllers/metamask-controller-test.js
@@ -222,6 +222,129 @@ describe('MetaMaskController', function () {
     })
   })
 
+  describe('connectHardware', function () {
+
+    it('should throw if it receives an unknown device name', async function () {
+      try {
+        await metamaskController.connectHardware('Some random device name', 0)
+      } catch (e) {
+        assert.equal(e, 'Error: MetamaskController:connectHardware - Unknown device')
+      }
+    })
+
+    it('should add the Trezor Hardware keyring', async function () {
+      sinon.spy(metamaskController.keyringController, 'addNewKeyring')
+      await metamaskController.connectHardware('trezor', 0).catch((e) => null)
+      const keyrings = await metamaskController.keyringController.getKeyringsByType(
+        'Trezor Hardware'
+      )
+      assert.equal(metamaskController.keyringController.addNewKeyring.getCall(0).args, 'Trezor Hardware')
+      assert.equal(keyrings.length, 1)
+    })
+
+  })
+
+  describe('checkHardwareStatus', function () {
+    it('should throw if it receives an unknown device name', async function () {
+      try {
+        await metamaskController.checkHardwareStatus('Some random device name')
+      } catch (e) {
+        assert.equal(e, 'Error: MetamaskController:checkHardwareStatus - Unknown device')
+      }
+    })
+
+    it('should be locked by default', async function () {
+      await metamaskController.connectHardware('trezor', 0).catch((e) => null)
+      const status = await metamaskController.checkHardwareStatus('trezor')
+      assert.equal(status, false)
+    })
+  })
+
+  describe('forgetDevice', function () {
+    it('should throw if it receives an unknown device name', async function () {
+      try {
+        await metamaskController.forgetDevice('Some random device name')
+      } catch (e) {
+        assert.equal(e, 'Error: MetamaskController:forgetDevice - Unknown device')
+      }
+    })
+
+    it('should wipe all the keyring info', async function () {
+      await metamaskController.connectHardware('trezor', 0).catch((e) => null)
+      await metamaskController.forgetDevice('trezor')
+      const keyrings = await metamaskController.keyringController.getKeyringsByType(
+        'Trezor Hardware'
+      )
+
+      assert.deepEqual(keyrings[0].accounts, [])
+      assert.deepEqual(keyrings[0].page, 0)
+      assert.deepEqual(keyrings[0].isUnlocked(), false)
+    })
+  })
+
+  describe('unlockTrezorAccount', function () {
+    let accountToUnlock
+    let windowOpenStub
+    let addNewAccountStub
+    let getAccountsStub
+    beforeEach(async function () {
+      accountToUnlock = 10
+      windowOpenStub = sinon.stub(window, 'open')
+      windowOpenStub.returns(noop)
+
+      addNewAccountStub = sinon.stub(metamaskController.keyringController, 'addNewAccount')
+      addNewAccountStub.returns({})
+
+      getAccountsStub = sinon.stub(metamaskController.keyringController, 'getAccounts')
+      // Need to return different address to mock the behavior of
+      // adding a new account from the keyring
+      getAccountsStub.onCall(0).returns(Promise.resolve(['0x1']))
+      getAccountsStub.onCall(1).returns(Promise.resolve(['0x2']))
+      getAccountsStub.onCall(2).returns(Promise.resolve(['0x3']))
+      getAccountsStub.onCall(3).returns(Promise.resolve(['0x4']))
+      sinon.spy(metamaskController.preferencesController, 'setAddresses')
+      sinon.spy(metamaskController.preferencesController, 'setSelectedAddress')
+      sinon.spy(metamaskController.preferencesController, 'setAccountLabel')
+      await metamaskController.connectHardware('trezor', 0).catch((e) => null)
+      await metamaskController.unlockTrezorAccount(accountToUnlock).catch((e) => null)
+    })
+
+    afterEach(function () {
+      metamaskController.keyringController.addNewAccount.restore()
+      window.open.restore()
+    })
+
+    it('should set accountToUnlock in the keyring', async function () {
+      const keyrings = await metamaskController.keyringController.getKeyringsByType(
+        'Trezor Hardware'
+      )
+      assert.equal(keyrings[0].unlockedAccount, accountToUnlock)
+    })
+
+
+    it('should call  keyringController.addNewAccount', async function () {
+      assert(metamaskController.keyringController.addNewAccount.calledOnce)
+    })
+
+    it('should call keyringController.getAccounts ', async function () {
+      assert(metamaskController.keyringController.getAccounts.called)
+    })
+
+    it('should call preferencesController.setAddresses', async function () {
+      assert(metamaskController.preferencesController.setAddresses.calledOnce)
+    })
+
+    it('should call preferencesController.setSelectedAddress', async function () {
+      assert(metamaskController.preferencesController.setSelectedAddress.calledOnce)
+    })
+
+    it('should call preferencesController.setAccountLabel', async function () {
+      assert(metamaskController.preferencesController.setAccountLabel.calledOnce)
+    })
+
+
+  })
+
   describe('#setCustomRpc', function () {
     const customRPC = 'https://custom.rpc/'
     let rpcTarget
@@ -362,6 +485,39 @@ describe('MetaMaskController', function () {
     })
   })
 
+  describe('#removeAccount', function () {
+    let ret
+    const addressToRemove = '0x1'
+
+    beforeEach(async function () {
+      sinon.stub(metamaskController.preferencesController, 'removeAddress')
+      sinon.stub(metamaskController.accountTracker, 'removeAccount')
+      sinon.stub(metamaskController.keyringController, 'removeAccount')
+
+      ret = await metamaskController.removeAccount(addressToRemove)
+
+    })
+
+    afterEach(function () {
+      metamaskController.keyringController.removeAccount.restore()
+      metamaskController.accountTracker.removeAccount.restore()
+      metamaskController.preferencesController.removeAddress.restore()
+    })
+
+    it('should call preferencesController.removeAddress', async function () {
+      assert(metamaskController.preferencesController.removeAddress.calledWith(addressToRemove))
+    })
+    it('should call accountTracker.removeAccount', async function () {
+      assert(metamaskController.accountTracker.removeAccount.calledWith(addressToRemove))
+    })
+    it('should call keyringController.removeAccount', async function () {
+      assert(metamaskController.keyringController.removeAccount.calledWith(addressToRemove))
+    })
+    it('should return address', async function () {
+      assert.equal(ret, '0x1')
+    })
+  })
+
   describe('#clearSeedWordCache', function () {
 
     it('should have set seed words', function () {
diff --git a/test/unit/app/controllers/preferences-controller-test.js b/test/unit/app/controllers/preferences-controller-test.js
index e5e751b57..e055500b1 100644
--- a/test/unit/app/controllers/preferences-controller-test.js
+++ b/test/unit/app/controllers/preferences-controller-test.js
@@ -52,6 +52,31 @@ describe('preferences controller', function () {
     })
   })
 
+  describe('removeAddress', function () {
+    it('should remove an address from state', function () {
+      preferencesController.setAddresses([
+        '0xda22le',
+        '0x7e57e2',
+      ])
+
+      preferencesController.removeAddress('0xda22le')
+
+      assert.equal(preferencesController.store.getState().identities['0xda22le'], undefined)
+    })
+
+    it('should switch accounts if the selected address is removed', function () {
+      preferencesController.setAddresses([
+        '0xda22le',
+        '0x7e57e2',
+      ])
+
+      preferencesController.setSelectedAddress('0x7e57e2')
+      preferencesController.removeAddress('0x7e57e2')
+
+      assert.equal(preferencesController.getSelectedAddress(), '0xda22le')
+    })
+  })
+
   describe('setAccountLabel', function () {
     it('should update a label for the given account', function () {
       preferencesController.setAddresses([