@metamask/eth-ledger-bridge-keyring 0.8.0 → 0.11.0

package/CHANGELOG.md

@@ -0,0 +1,39 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [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))
+
+## [0.9.0]
+### Changed
+- `updateTransportMethod` no longer defaults its parameter to false, and now names the param sent with the `'ledger-update-transport'` message `transportType`. This better is to support the use of an enum, instead of a boolean, for specifying transport preferences.  ([#114](https://github.com/MetaMask/eth-ledger-bridge-keyring/pull/114))
+
+## [0.8.0]
+### Added
+- Allow ledger-bridge iframe to connect Ledger wia WebHID, when it is supported by the current browser ([#107](https://github.com/MetaMask/eth-ledger-bridge-keyring/pull/107))
+
+### Changed
+- Reject with an Error object if unlocking is not successful  ([#104](https://github.com/MetaMask/eth-ledger-bridge-keyring/pull/104))
+- Ensure that logs of errors only have a single `Error:` string in the message ([#105](https://github.com/MetaMask/eth-ledger-bridge-keyring/pull/105))
+
+## [0.7.0]
+### Changed
+- Remove unused `events` and `ethereumjs-tx` dependencies ([#101](https://github.com/MetaMask/eth-ledger-bridge-keyring/pull/101), [#102](https://github.com/MetaMask/eth-ledger-bridge-keyring/pull/102))
+- Update eth-ledger-bridge-keyring to support EIP-1559 transactions ([#98](https://github.com/MetaMask/eth-ledger-bridge-keyring/pull/98), [#97](https://github.com/MetaMask/eth-ledger-bridge-keyring/pull/97), [#96](https://github.com/MetaMask/eth-ledger-bridge-keyring/pull/96))
+
+## [0.6.0]
+### Added
+- Support new versions of ethereumjs/tx ([#68](https://github.com/MetaMask/eth-ledger-bridge-keyring/pull/68))

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)
   }
@@ -191,22 +201,36 @@ class LedgerBridgeKeyring extends EventEmitter {
     delete this.accountDetails[ethUtil.toChecksumAddress(address)]
   }
 
-  updateTransportMethod (useLedgerLive = false) {
+  attemptMakeApp () {
     return new Promise((resolve, reject) => {
-      // If the iframe isn't loaded yet, let's store the desired useLedgerLive value and
+      this._sendMessage({
+        action: 'ledger-make-app',
+      }, ({ success, error }) => {
+        if (success) {
+          resolve(true)
+        } else {
+          reject(error)
+        }
+      })
+    })
+  }
+
+  updateTransportMethod (transportType) {
+    return new Promise((resolve, reject) => {
+      // If the iframe isn't loaded yet, let's store the desired transportType value and
       // optimistically return a successful promise
       if (!this.iframeLoaded) {
         this.delayedPromise = {
           resolve,
           reject,
-          useLedgerLive,
+          transportType,
         }
         return
       }
 
       this._sendMessage({
         action: 'ledger-update-transport',
-        params: { useLedgerLive },
+        params: { transportType },
       }, ({ success }) => {
         if (success) {
           resolve(true)
@@ -432,7 +456,7 @@ class LedgerBridgeKeyring extends EventEmitter {
       if (this.delayedPromise) {
         try {
           const result = await this.updateTransportMethod(
-            this.delayedPromise.useLedgerLive,
+            this.delayedPromise.transportType,
           )
           this.delayedPromise.resolve(result)
         } catch (e) {
@@ -453,18 +477,28 @@ 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, '*')
+  }
+
+  _setupListener () {
     const 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)

package/package.json

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