Merge pull request #437 from 0xProject/feature/subproviders/update-ledgerco

Update ledgerco packages

4 files changed, 43 insertions, 50 deletions

diff --git a/packages/subproviders/src/globals.d.ts b/packages/subproviders/src/globals.d.ts
index 6f344dcd3..d59ee9e67 100644
--- a/packages/subproviders/src/globals.d.ts
+++ b/packages/subproviders/src/globals.d.ts
@@ -32,32 +32,38 @@ interface ECSignature {
     r: string;
     s: string;
 }
-declare module 'ledgerco' {
-    interface comm {
-        close_async(): Promise<void>;
-    }
-    export class comm_node implements comm {
-        public static create_async(timeoutMilliseconds?: number): Promise<comm_node>;
-        public close_async(): Promise<void>;
-    }
-    export class comm_u2f implements comm {
-        public static create_async(): Promise<comm_u2f>;
-        public close_async(): Promise<void>;
-    }
-    export class eth {
-        public comm: comm;
-        constructor(comm: comm);
-        public getAddress_async(
+
+interface LedgerTransport {
+    close(): Promise<void>;
+}
+
+declare module '@ledgerhq/hw-app-eth' {
+    class Eth {
+        public transport: LedgerTransport;
+        constructor(transport: LedgerTransport);
+        public getAddress(
             path: string,
-            display?: boolean,
-            chaincode?: boolean,
+            boolDisplay?: boolean,
+            boolChaincode?: boolean,
         ): Promise<{ publicKey: string; address: string; chainCode: string }>;
-        public signTransaction_async(path: string, rawTxHex: string): Promise<ECSignatureString>;
-        public getAppConfiguration_async(): Promise<{
-            arbitraryDataEnabled: number;
-            version: string;
-        }>;
-        public signPersonalMessage_async(path: string, messageHex: string): Promise<ECSignature>;
+        public signTransaction(path: string, rawTxHex: string): Promise<ECSignatureString>;
+        public getAppConfiguration(): Promise<{ arbitraryDataEnabled: number; version: string }>;
+        public signPersonalMessage(path: string, messageHex: string): Promise<ECSignature>;
+    }
+    export default Eth;
+}
+
+declare module '@ledgerhq/hw-transport-u2f' {
+    export default class TransportU2F implements LedgerTransport {
+        public static create(): Promise<LedgerTransport>;
+        public close(): Promise<void>;
+    }
+}
+
+declare module '@ledgerhq/hw-transport-node-hid' {
+    export default class TransportNodeHid implements LedgerTransport {
+        public static create(): Promise<LedgerTransport>;
+        public close(): Promise<void>;
     }
 }
 
diff --git a/packages/subproviders/src/index.ts b/packages/subproviders/src/index.ts
index 4da405ec0..e22b6f5f3 100644
--- a/packages/subproviders/src/index.ts
+++ b/packages/subproviders/src/index.ts
@@ -1,8 +1,5 @@
-import {
-    comm_node as LedgerNodeCommunication,
-    comm_u2f as LedgerBrowserCommunication,
-    eth as LedgerEthereumClientFn,
-} from 'ledgerco';
+import Eth from '@ledgerhq/hw-app-eth';
+import TransportU2F from '@ledgerhq/hw-transport-u2f';
 
 import { LedgerEthereumClient } from './types';
 
@@ -19,17 +16,7 @@ export { ECSignature, LedgerWalletSubprovider, LedgerCommunicationClient, NonceS
  * @return LedgerEthereumClient A browser client
  */
 export async function ledgerEthereumBrowserClientFactoryAsync(): Promise<LedgerEthereumClient> {
-    const ledgerConnection = await LedgerBrowserCommunication.create_async();
-    const ledgerEthClient = new LedgerEthereumClientFn(ledgerConnection);
-    return ledgerEthClient;
-}
-
-/**
- * A factory for creating a LedgerEthereumClient usable in a Node.js context.
- * @return LedgerEthereumClient A Node.js client
- */
-export async function ledgerEthereumNodeJsClientFactoryAsync(): Promise<LedgerEthereumClient> {
-    const ledgerConnection = await LedgerNodeCommunication.create_async();
-    const ledgerEthClient = new LedgerEthereumClientFn(ledgerConnection);
+    const ledgerConnection = await TransportU2F.create();
+    const ledgerEthClient = new Eth(ledgerConnection);
     return ledgerEthClient;
 }
diff --git a/packages/subproviders/src/subproviders/ledger.ts b/packages/subproviders/src/subproviders/ledger.ts
index 85cdf0efc..0a84caae3 100644
--- a/packages/subproviders/src/subproviders/ledger.ts
+++ b/packages/subproviders/src/subproviders/ledger.ts
@@ -134,7 +134,7 @@ export class LedgerSubprovider extends Subprovider {
 
         let ledgerResponse;
         try {
-            ledgerResponse = await this._ledgerClientIfExists.getAddress_async(
+            ledgerResponse = await this._ledgerClientIfExists.getAddress(
                 this._derivationPath,
                 this._shouldAlwaysAskForConfirmation,
                 SHOULD_GET_CHAIN_CODE,
@@ -173,7 +173,7 @@ export class LedgerSubprovider extends Subprovider {
         const txHex = tx.serialize().toString('hex');
         try {
             const derivationPath = this._getDerivationPath();
-            const result = await this._ledgerClientIfExists.signTransaction_async(derivationPath, txHex);
+            const result = await this._ledgerClientIfExists.signTransaction(derivationPath, txHex);
             // Store signature in transaction
             tx.r = Buffer.from(result.r, 'hex');
             tx.s = Buffer.from(result.s, 'hex');
@@ -199,7 +199,7 @@ export class LedgerSubprovider extends Subprovider {
         this._ledgerClientIfExists = await this._createLedgerClientAsync();
         try {
             const derivationPath = this._getDerivationPath();
-            const result = await this._ledgerClientIfExists.signPersonalMessage_async(
+            const result = await this._ledgerClientIfExists.signPersonalMessage(
                 derivationPath,
                 ethUtil.stripHexPrefix(data),
             );
@@ -236,7 +236,7 @@ export class LedgerSubprovider extends Subprovider {
             this._connectionLock.signal();
             return;
         }
-        await this._ledgerClientIfExists.comm.close_async();
+        await this._ledgerClientIfExists.transport.close();
         this._ledgerClientIfExists = undefined;
         this._connectionLock.signal();
     }
diff --git a/packages/subproviders/src/types.ts b/packages/subproviders/src/types.ts
index 65b7f6c8f..f49ac6107 100644
--- a/packages/subproviders/src/types.ts
+++ b/packages/subproviders/src/types.ts
@@ -1,7 +1,7 @@
 import * as _ from 'lodash';
 
 export interface LedgerCommunicationClient {
-    close_async: () => Promise<void>;
+    close: () => Promise<void>;
 }
 
 /*
@@ -12,14 +12,14 @@ export interface LedgerCommunicationClient {
 export interface LedgerEthereumClient {
     // shouldGetChainCode is defined as `true` instead of `boolean` because other types rely on the assumption
     // that we get back the chain code and we don't have dependent types to express it properly
-    getAddress_async: (
+    getAddress: (
         derivationPath: string,
         askForDeviceConfirmation: boolean,
         shouldGetChainCode: true,
     ) => Promise<LedgerGetAddressResult>;
-    signPersonalMessage_async: (derivationPath: string, messageHex: string) => Promise<ECSignature>;
-    signTransaction_async: (derivationPath: string, txHex: string) => Promise<ECSignatureString>;
-    comm: LedgerCommunicationClient;
+    signTransaction: (derivationPath: string, rawTxHex: string) => Promise<ECSignatureString>;
+    signPersonalMessage: (derivationPath: string, messageHex: string) => Promise<ECSignature>;
+    transport: LedgerCommunicationClient;
 }
 
 export interface ECSignatureString {