@metamask/eth-ledger-bridge-keyring 0.10.0 → 0.13.0

package/CHANGELOG.md

@@ -7,6 +7,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.13.0]
+### Added
+- hdk.publicKey and hdk.chainCode should not be updated when unlocking using hdPath for an account.  ([#146](https://github.com/MetaMask/eth-ledger-bridge-keyring/pull/146))
+
+## [0.12.0]
+### Added
+- Add a new `destroy` method which will remove the `message` event listener from window.  ([#145](https://github.com/MetaMask/eth-ledger-bridge-keyring/pull/145))
+
+## [0.11.0]
+### Added
+- Add a new `isConnected` method which allows determining if the device is last known to be connected.  ([#131](https://github.com/MetaMask/eth-ledger-bridge-keyring/pull/131))
+### Changed
+- Messaging now runs off of message IDs instead of assuming the response received is from the last message sent, which will not always been true.  ([#132](https://github.com/MetaMask/eth-ledger-bridge-keyring/pull/132))
+
 ## [0.10.0]
 ### Added
 - Add a new `attemptMakeApp` method which allows clients to attempt a creation of the Ledger transport for the purposes of detecting/catching potential connection errors.  ([#126](https://github.com/MetaMask/eth-ledger-bridge-keyring/pull/126))

package/index.js

@@ -18,6 +18,8 @@ const NETWORK_API_URLS = {
   mainnet: 'https://api.etherscan.io',
 }
 
+const CONNECTION_EVENT = 'ledger-connection-change'
+
 class LedgerBridgeKeyring extends EventEmitter {
   constructor (opts = {}) {
     super()
@@ -36,6 +38,10 @@ class LedgerBridgeKeyring extends EventEmitter {
 
     this.iframeLoaded = false
     this._setupIframe()
+
+    this.currentMessageId = 0
+    this.messageCallbacks = {}
+    this._setupListener()
   }
 
   serialize () {
@@ -97,6 +103,10 @@ class LedgerBridgeKeyring extends EventEmitter {
     return Boolean(this.hdk && this.hdk.publicKey)
   }
 
+  isConnected () {
+    return this.isDeviceConnected
+  }
+
   setAccountToUnlock (index) {
     this.unlockedAccount = parseInt(index, 10)
   }
@@ -109,7 +119,7 @@ class LedgerBridgeKeyring extends EventEmitter {
     this.hdPath = hdPath
   }
 
-  unlock (hdPath) {
+  unlock (hdPath, updateHdk = true) {
     if (this.isUnlocked() && !hdPath) {
       return Promise.resolve('already unlocked')
     }
@@ -123,8 +133,10 @@ class LedgerBridgeKeyring extends EventEmitter {
       },
       ({ success, payload }) => {
         if (success) {
-          this.hdk.publicKey = Buffer.from(payload.publicKey, 'hex')
-          this.hdk.chainCode = Buffer.from(payload.chainCode, 'hex')
+          if (updateHdk) {
+            this.hdk.publicKey = Buffer.from(payload.publicKey, 'hex')
+            this.hdk.chainCode = Buffer.from(payload.chainCode, 'hex')
+          }
           resolve(payload.address)
         } else {
           reject(payload.error || new Error('Unknown error'))
@@ -363,7 +375,7 @@ class LedgerBridgeKeyring extends EventEmitter {
       throw new Error(`Ledger: Account for address '${checksummedAddress}' not found`)
     }
     const { hdPath } = this.accountDetails[checksummedAddress]
-    const unlockedAddress = await this.unlock(hdPath)
+    const unlockedAddress = await this.unlock(hdPath, false)
 
     // unlock resolves to the address for the given hdPath as reported by the ledger device
     // if that address is not the requested address, then this account belongs to a different device or seed
@@ -467,21 +479,35 @@ class LedgerBridgeKeyring extends EventEmitter {
 
   _sendMessage (msg, cb) {
     msg.target = 'LEDGER-IFRAME'
+
+    this.currentMessageId += 1
+    msg.messageId = this.currentMessageId
+
+    this.messageCallbacks[this.currentMessageId] = cb
     this.iframe.contentWindow.postMessage(msg, '*')
-    const eventListener = ({ origin, data }) => {
+  }
+
+  _setupListener () {
+    this._eventListener = ({ origin, data }) => {
       if (origin !== this._getOrigin()) {
         return false
       }
 
-      if (data && data.action && data.action === `${msg.action}-reply` && cb) {
-        cb(data)
-        return undefined
+      if (data) {
+        if (this.messageCallbacks[data.messageId]) {
+          this.messageCallbacks[data.messageId](data)
+        } else if (data.action === CONNECTION_EVENT) {
+          this.isDeviceConnected = data.payload.connected
+        }
       }
 
-      window.removeEventListener('message', eventListener)
       return undefined
     }
-    window.addEventListener('message', eventListener)
+    window.addEventListener('message', this._eventListener)
+  }
+
+  destroy () {
+    window.removeEventListener('message', this._eventListener)
   }
 
   async __getPage (increment) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/eth-ledger-bridge-keyring",
-  "version": "0.10.0",
+  "version": "0.13.0",
   "description": "A MetaMask compatible keyring, for ledger hardware wallets",
   "main": "index.js",
   "files": [