Lint

Author: paulmillr

src/hdkey.ts

@@ -45,28 +45,55 @@ const toU32 = (n: number) => {
   return buf;
 };
 
-type HDKeyOpt = {
+interface HDKeyOpt {
   versions: Versions;
   depth?: number;
   index?: number;
   parentFingerprint?: number;
   chainCode: Uint8Array;
   publicKey?: Uint8Array;
   privateKey?: Uint8Array | bigint;
-};
+}
 
 export class HDKey {
-  readonly versions: Versions;
-  readonly depth: number = 0;
-  readonly index: number = 0;
-  readonly chainCode: Uint8Array | null = null;
-  readonly parentFingerprint: number = 0;
-  private privKey?: bigint;
-  private privKeyBytes?: Uint8Array;
-  private pubKey?: Uint8Array;
-  private pubHash: Uint8Array | undefined;
+  get fingerprint(): number {
+    if (!this.pubHash) {
+      throw new Error("No publicKey set!");
+    }
+    return fromU32(this.pubHash);
+  }
+  get identifier(): Uint8Array | undefined {
+    return this.pubHash;
+  }
+  get pubKeyHash(): Uint8Array | undefined {
+    return this.pubHash;
+  }
+  get privateKey(): Uint8Array | null {
+    return this.privKeyBytes || null;
+  }
+  get publicKey(): Uint8Array | null {
+    return this.pubKey || null;
+  }
+  get privateExtendedKey(): string {
+    const priv = this.privateKey;
+    if (!priv) {
+      throw new Error("No private key");
+    }
+    return base58c.encode(
+      this.serialize(
+        this.versions.private,
+        concatBytes(new Uint8Array([0]), priv)
+      )
+    );
+  }
+  get publicExtendedKey(): string {
+    if (!this.pubKey) {
+      throw new Error("No public key");
+    }
+    return base58c.encode(this.serialize(this.versions.public, this.pubKey));
+  }
 
-  static fromMasterSeed(
+  public static fromMasterSeed(
     seed: Uint8Array,
     versions: Versions = BITCOIN_VERSIONS
   ): HDKey {
@@ -78,7 +105,7 @@ export class HDKey {
     });
   }
 
-  static fromExtendedKey(
+  public static fromExtendedKey(
     base58key: string,
     versions: Versions = BITCOIN_VERSIONS
   ): HDKey {
@@ -105,9 +132,18 @@ export class HDKey {
     }
   }
 
-  static fromJSON(json: { xpriv: string }): HDKey {
+  public static fromJSON(json: { xpriv: string }): HDKey {
     return HDKey.fromExtendedKey(json.xpriv);
   }
+  public readonly versions: Versions;
+  public readonly depth: number = 0;
+  public readonly index: number = 0;
+  public readonly chainCode: Uint8Array | null = null;
+  public readonly parentFingerprint: number = 0;
+  private privKey?: bigint;
+  private privKeyBytes?: Uint8Array;
+  private pubKey?: Uint8Array;
+  private pubHash: Uint8Array | undefined;
 
   constructor(opt: HDKeyOpt) {
     if (!opt || typeof opt !== "object") {
@@ -118,8 +154,9 @@ export class HDKey {
     this.chainCode = opt.chainCode;
     this.index = opt.index || 0;
     this.parentFingerprint = opt.parentFingerprint || 0;
-    if (opt.publicKey && opt.privateKey)
+    if (opt.publicKey && opt.privateKey) {
       throw new Error("HDKey: publicKey and privateKey at same time.");
+    }
     if (opt.privateKey) {
       if (!secp.utils.isValidPrivateKey(opt.privateKey)) {
         throw new Error("Invalid private key");
@@ -137,42 +174,6 @@ export class HDKey {
     }
     this.pubHash = hash160(this.pubKey);
   }
-  get fingerprint(): number {
-    if (!this.pubHash) {
-      throw new Error("No publicKey set!");
-    }
-    return fromU32(this.pubHash);
-  }
-  get identifier(): Uint8Array | undefined {
-    return this.pubHash;
-  }
-  get pubKeyHash(): Uint8Array | undefined {
-    return this.pubHash;
-  }
-  get privateKey(): Uint8Array | null {
-    return this.privKeyBytes || null;
-  }
-  get publicKey(): Uint8Array | null {
-    return this.pubKey || null;
-  }
-  get privateExtendedKey(): string {
-    const priv = this.privateKey;
-    if (!priv) {
-      throw new Error("No private key");
-    }
-    return base58c.encode(
-      this.serialize(
-        this.versions.private,
-        concatBytes(new Uint8Array([0]), priv)
-      )
-    );
-  }
-  get publicExtendedKey(): string {
-    if (!this.pubKey) {
-      throw new Error("No public key");
-    }
-    return base58c.encode(this.serialize(this.versions.public, this.pubKey));
-  }
 
   public derive(path: string): HDKey {
     if (!/^[mM]'?/.test(path)) {

test/test-vectors/hdkey.ts

@@ -1,5 +1,5 @@
 import * as secp from "@noble/secp256k1";
-import { HDKey, HARDENED_OFFSET } from "../../src/hdkey";
+import { HARDENED_OFFSET, HDKey } from "../../src/hdkey";
 import { hexToBytes, toHex } from "../../src/utils";
 import { deepStrictEqual, throws } from "./assert";
 // https://github.com/cryptocoinjs/hdkey/blob/42637e381bdef0c8f785b14f5b66a80dad969514/test/fixtures/hdkey.json
@@ -160,7 +160,8 @@ describe("hdkey", () => {
 
   describe("- privateKey", () => {
     it("should throw an error if incorrect key size", () => {
-      const seed = "fffcf9f6f3f0edeae7e4e1dedbd8d5d2cfccc9c6c3c0bdbab7b4b1aeaba8a5a29f9c999693908d8a8784817e7b7875726f6c696663605d5a5754514e4b484542";
+      const seed =
+        "fffcf9f6f3f0edeae7e4e1dedbd8d5d2cfccc9c6c3c0bdbab7b4b1aeaba8a5a29f9c999693908d8a8784817e7b7875726f6c696663605d5a5754514e4b484542";
       const hdkey = HDKey.fromMasterSeed(hexToBytes(seed));
       // const hdkey = new HDKey.HDKey();
       throws(() => {
@@ -173,7 +174,8 @@ describe("hdkey", () => {
   describe("- publicKey", () => {
     it("should throw an error if incorrect key size", () => {
       throws(() => {
-        const seed = "fffcf9f6f3f0edeae7e4e1dedbd8d5d2cfccc9c6c3c0bdbab7b4b1aeaba8a5a29f9c999693908d8a8784817e7b7875726f6c696663605d5a5754514e4b484542";
+        const seed =
+          "fffcf9f6f3f0edeae7e4e1dedbd8d5d2cfccc9c6c3c0bdbab7b4b1aeaba8a5a29f9c999693908d8a8784817e7b7875726f6c696663605d5a5754514e4b484542";
         const hdkey = HDKey.fromMasterSeed(hexToBytes(seed));
         // @ts-ignore
         hdkey.publicKey = new Uint8Array([1, 2, 3, 4]);
@@ -183,19 +185,25 @@ describe("hdkey", () => {
     it("should not throw if key is 33 bytes (compressed)", () => {
       const pub = secp.getPublicKey(secp.utils.randomPrivateKey(), true);
       deepStrictEqual(pub.length, 33);
-      const seed = "fffcf9f6f3f0edeae7e4e1dedbd8d5d2cfccc9c6c3c0bdbab7b4b1aeaba8a5a29f9c999693908d8a8784817e7b7875726f6c696663605d5a5754514e4b484542";
+      const seed =
+        "fffcf9f6f3f0edeae7e4e1dedbd8d5d2cfccc9c6c3c0bdbab7b4b1aeaba8a5a29f9c999693908d8a8784817e7b7875726f6c696663605d5a5754514e4b484542";
       const hdkey = HDKey.fromMasterSeed(hexToBytes(seed));
-      // @ts-ignore
-      throws(() => { hdkey.publicKey = pub; });
+      throws(() => {
+        // @ts-ignore
+        hdkey.publicKey = pub;
+      });
     });
 
     it("should not throw if key is 65 bytes (not compressed)", () => {
       const pub = secp.getPublicKey(secp.utils.randomPrivateKey(), false);
       deepStrictEqual(pub.length, 65);
-      const seed = "fffcf9f6f3f0edeae7e4e1dedbd8d5d2cfccc9c6c3c0bdbab7b4b1aeaba8a5a29f9c999693908d8a8784817e7b7875726f6c696663605d5a5754514e4b484542";
+      const seed =
+        "fffcf9f6f3f0edeae7e4e1dedbd8d5d2cfccc9c6c3c0bdbab7b4b1aeaba8a5a29f9c999693908d8a8784817e7b7875726f6c696663605d5a5754514e4b484542";
       const hdkey = HDKey.fromMasterSeed(hexToBytes(seed));
-      // @ts-ignore
-      throws(() => { hdkey.publicKey = pub; });
+      throws(() => {
+        // @ts-ignore
+        hdkey.publicKey = pub;
+      });
     });
   });
 
@@ -347,7 +355,9 @@ describe("hdkey", () => {
       const masterKey = HDKey.fromMasterSeed(hexToBytes(seed));
 
       deepStrictEqual(!!masterKey.privateExtendedKey, true, "xpriv is truthy");
-      throws(() => { (masterKey as any).privateKey = undefined; });
+      throws(() => {
+        (masterKey as any).privateKey = undefined;
+      });
 
       // throws(() => masterKey.privateExtendedKey);
     });