hdkey docs

Author: paulmillr

README.md

@@ -221,7 +221,8 @@ const sig = hdkey3.sign(hash);
 hdkey3.verify(hash, sig);
 ```
 
-Note: do not set `privateKey` and `publicKey` directly, you will get wrong keys.
+Note: `chainCode` property is essentially a private part
+of a secret "master" key, it should be guarded from unauthorized access.
 
 The full API is:
 
@@ -232,26 +233,25 @@ class HDKey {
   public static fromExtendedKey(base58key: string, versions: Versions): HDKey;
   public static fromJSON(json: { xpriv: string }): HDKey;
 
-  public versions: Versions;
-  public depth: number;
-  public index: number;
-  public chainCode: Uint8Array | null;
-  public privateKey: Uint8Array | null;
-  public publicKey: Uint8Array | null;
-  public fingerprint: number;
-  public parentFingerprint: number;
-  public pubKeyHash: Uint8Array | undefined;
-  public identifier: Uint8Array | undefined;
-  public privateExtendedKey: string;
-  public publicExtendedKey: string;
-
-  private constructor(versios: Versions);
-  public derive(path: string): HDKey;
-  public deriveChild(index: number): HDKey;
-  public sign(hash: Uint8Array): Uint8Array;
-  public verify(hash: Uint8Array, signature: Uint8Array): boolean;
-  public wipePrivateData(): this;
-  public toJSON(): { xpriv: string; xpub: string };
+  readonly versions: Versions;
+  readonly depth: number = 0;
+  readonly index: number = 0;
+  readonly chainCode: Uint8Array | null = null;
+  readonly parentFingerprint: number = 0;
+
+  get fingerprint(): number;
+  get identifier(): Uint8Array | undefined;
+  get pubKeyHash(): Uint8Array | undefined;
+  get privateKey(): Uint8Array | null;
+  get publicKey(): Uint8Array | null;
+  get privateExtendedKey(): string;
+  get publicExtendedKey(): string;
+
+  derive(path: string): HDKey;
+  deriveChild(index: number): HDKey;
+  sign(hash: Uint8Array): Uint8Array;
+  verify(hash: Uint8Array, signature: Uint8Array): boolean;
+  wipePrivateData(): this;
 }
 
 interface Versions {