From a3a2df098b3a67ec2da036ae469cb54709f0fd71 Mon Sep 17 00:00:00 2001
From: Leonid Logvinov <logvinov.leon@gmail.com>
Date: Mon, 18 Dec 2017 15:56:31 +0100
Subject: Add a comment

---
 packages/subproviders/src/types.ts | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'packages/subproviders/src')

diff --git a/packages/subproviders/src/types.ts b/packages/subproviders/src/types.ts
index 02855dd4c..c5ccf1fda 100644
--- a/packages/subproviders/src/types.ts
+++ b/packages/subproviders/src/types.ts
@@ -10,6 +10,8 @@ export interface LedgerCommunicationClient {
  * NodeJs and Browser communication are supported.
  */
 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: (derivationPath: string, askForDeviceConfirmation: boolean,
                        shouldGetChainCode: true) => Promise<LedgerGetAddressResult>;
     signPersonalMessage_async: (derivationPath: string, messageHex: string) => Promise<ECSignature>;
-- 
cgit v1.2.3