Make hdkey module use a named export

Author: alcuadrado

packages/ethereum-cryptography/README.md

@@ -354,9 +354,10 @@ console.log(sign(msgHash, privateKey).toString("hex"));
 The `hdkey` submodule provides a library for keys derivation according to
 [BIP32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki).
 
-It has the exact same API than the version `1.x` of
+It has almost the exact same API than the version `1.x` of
 [`hdkey` from cryptocoinjs](https://github.com/cryptocoinjs/hdkey),
 but it's backed by this package's primitives, and has built-in TypeScript types.
+Its only difference is that it has to be be used with a named import.
 
 ### Function types
 
@@ -400,14 +401,15 @@ interface Versions {
 ### Example usage
 
 ```js
-const HDKey = require("ethereum-cryptography/hdkey");
+const { HDKey } = require("ethereum-cryptography/hdkey");
 
 const seed = "fffcf9f6f3f0edeae7e4e1dedbd8d5d2cfccc9c6c3c0bdbab7b4b1aeaba8a5a29f9c999693908d8a8784817e7b7875726f6c696663605d5a5754514e4b484542";
 const hdkey = HDKey.fromMasterSeed(Buffer.from(seed, "hex"));
 const childkey = hdkey.derive("m/0/2147483647'/1");
 
 console.log(childkey.privateExtendedKey);
 ```
+
 ## Browser usage
 
 This package works with all the major Javascript bundlers. It is

packages/ethereum-cryptography/src/hdkey.ts

@@ -1,17 +1,17 @@
 import * as hdkeyPure from "./pure/hdkey";
 
-let hdkeyModule: typeof hdkeyPure;
+let hdkey: typeof hdkeyPure.HDKey;
 
 try {
   // tslint:disable-next-line no-implicit-dependencies
-  hdkeyModule = require("ethereum-cryptography-native/hdkey");
+  hdkey = require("ethereum-cryptography-native/hdkey").HDKey;
 } catch {
   // This module is slightly more complicated, as we don't want to use the
   // 100% pure version of hdkey if the native one isn't installed.
 
   // We require this local version of hdkey-without-crypto because it uses
   // the built-in crypto module
-  hdkeyModule = require("./vendor/hdkey-without-crypto");
+  hdkey = require("./vendor/hdkey-without-crypto");
 }
 
-export = hdkeyModule;
+export const HDKey = hdkey;

packages/ethereum-cryptography/src/pure/hdkey.ts

@@ -1,13 +1,13 @@
-interface Versions {
+export interface Versions {
   private: number;
   public: number;
 }
 
-declare class HDKey {
+export declare class HDKeyT {
   public static HARDENED_OFFSET: number;
-  public static fromMasterSeed(seed: Buffer, versions: Versions): HDKey;
-  public static fromExtendedKey(base58key: string, versions: Versions): HDKey;
-  public static fromJSON(json: { xpriv: string }): HDKey;
+  public static fromMasterSeed(seed: Buffer, versions: Versions): HDKeyT;
+  public static fromExtendedKey(base58key: string, versions: Versions): HDKeyT;
+  public static fromJSON(json: { xpriv: string }): HDKeyT;
 
   public versions: Versions;
   public depth: number;
@@ -23,14 +23,14 @@ declare class HDKey {
   public publicExtendedKey: string;
 
   private constructor(versios: Versions);
-  public derive(path: string): HDKey;
-  public deriveChild(index: number): HDKey;
+  public derive(path: string): HDKeyT;
+  public deriveChild(index: number): HDKeyT;
   public sign(hash: Buffer): Buffer;
   public verify(hash: Buffer, signature: Buffer): boolean;
   public wipePrivateData(): this;
   public toJSON(): { xpriv: string; xpub: string };
 }
 
-const hdkey: typeof HDKey = require("./vendor/hdkey-without-crypto");
+const hdkey: typeof HDKeyT = require("./vendor/hdkey-without-crypto");
 
-export = hdkey;
+export const HDKey = hdkey;

packages/ethereum-cryptography/test/node/hdkey.ts

@@ -1,4 +1,4 @@
-import hdkey from "../../src/hdkey";
+import { HDKey } from "../../src/hdkey";
 import { createTests } from "../test-vectors/hdkey";
 
-createTests(hdkey);
+createTests(HDKey);

packages/ethereum-cryptography/test/pure/hdkey.ts

@@ -1,4 +1,4 @@
-import hdkey from "../../src/pure/hdkey";
+import { HDKey } from "../../src/pure/hdkey";
 import { createTests } from "../test-vectors/hdkey";
 
-createTests(hdkey);
+createTests(HDKey);