ref!: deriveKey => deriveAddress

Author: AJ ONeal

README.md

@@ -144,7 +144,7 @@ let DashPhrase = window.DashPhrase;
    ```
 5. Generate an _Address Key_
    ```js
-   let key = await xkey.deriveKey(use);
+   let key = await xkey.deriveAddress(use);
    ```
 6. Generate _WIF_ & _Address_
    ```js
@@ -198,7 +198,7 @@ However, production code will look more like this:
    for (let i = previousIndex; i < last; i += 1) {
      let key;
      try {
-       key = await xkey.deriveKey(i); // xkey from step 2
+       key = await xkey.deriveAddress(i); // xkey from step 2
      } catch (e) {
        last += 1;
        continue;
@@ -255,7 +255,7 @@ However, production code will look more like this:
   Account
     async deriveXKey(use = 0)
   XKey
-    async deriveKey(keyIndex)
+    async deriveAddress(keyIndex)
   Key
     { privateKey, publicKey }
   HDKey
@@ -391,7 +391,7 @@ let xprv =
 
 ```js
 let xkey = await DashHd.fromXKey(xkeyString, options);
-// { deriveKey,
+// { deriveAddress,
 //   versions: v, depth: n, parentFingerprint: p, index: 0,
 //   chainCode: c, privateKey: privOrNull, publicKey: pubBytes }
 ```
@@ -413,7 +413,7 @@ Private Key as in _Wallet Import Format_.
 
 ```js
 let addressIndex = 0;
-let key = await xkey.deriveKey(addressIndex);
+let key = await xkey.deriveAddress(addressIndex);
 ```
 
 ```js
@@ -436,7 +436,7 @@ Public Key as an _Address_.
 
 ```js
 let addressIndex = 0;
-let key = await xkey.deriveKey(addressIndex);
+let key = await xkey.deriveAddress(addressIndex);
 ```
 
 ```js
@@ -602,7 +602,7 @@ Keys can be derived
   let xkey = await account.deriveXKey(use);
 
   let addressIndex = 0;
-  let key = await xkey.deriveKey(addressIndex);
+  let key = await xkey.deriveAddress(addressIndex);
   ```
 
 - by path (not for loops):
@@ -627,7 +627,7 @@ loop at the lowest level that you can. For example:
 let xkey = await account.deriveXKey(use);
 
 for (let addressIndex = 0; addressIndex < 100; addressIndex += 1) {
-  let key = await xkey.deriveKey(addressIndex);
+  let key = await xkey.deriveAddress(addressIndex);
   // ...
 }
 ```
@@ -686,7 +686,7 @@ let xkey = await account.deriveXKey(use);
 
 ### XKey (depth 4)
 
-An non-hardened HD Key with a `deriveKey(addressIndex)` method.
+An non-hardened HD Key with a `deriveAddress(addressIndex)` method.
 
 Represents a non-hardened XPrv or XPub.
 
@@ -704,7 +704,7 @@ let use = DashHd.RECEIVE;
 let xkey = await account.deriveXKey(use);
 
 let addressIndex = 0;
-let key = await xkey.deriveKey(addressIndex);
+let key = await xkey.deriveAddress(addressIndex);
 // { ...,
 //  privateKey: privBytes, publicKey: pubBytes }
 ```
@@ -715,7 +715,7 @@ From an `xprv`:
 let xkey = await account.fromXKey(xprv);
 
 let addressIndex = 0;
-let key = await xkey.deriveKey(addressIndex);
+let key = await xkey.deriveAddress(addressIndex);
 // { ...,
 //  privateKey: privBytes, publicKey: pubBytes }
 ```
@@ -726,7 +726,7 @@ From an `xpub`:
 let xkey = await account.fromXKey(xprv);
 
 let addressIndex = 0;
-let key = await xkey.deriveKey(addressIndex);
+let key = await xkey.deriveAddress(addressIndex);
 // { ...,
 //  privateKey: null, publicKey: pubBytes }
 ```
@@ -752,7 +752,7 @@ let use = DashHd.RECEIVE;
 let xkey = await account.deriveXKey(use);
 
 let addressIndex = 0;
-let key = await xkey.deriveKey(addressIndex);
+let key = await xkey.deriveAddress(addressIndex);
 ```
 
 From an XPrv:
@@ -761,7 +761,7 @@ From an XPrv:
 let xkey = await account.fromXKey(xprv);
 
 let addressIndex = 0;
-let key = await xkey.deriveKey(addressIndex);
+let key = await xkey.deriveAddress(addressIndex);
 // { ...,
 //   privateKey: privBytes, publicKey: pubBytes }
 ```
@@ -772,7 +772,7 @@ From an XPub:
 let xkey = await account.fromXKey(xpub);
 
 let addressIndex = 0;
-let key = await xkey.deriveKey(addressIndex);
+let key = await xkey.deriveAddress(addressIndex);
 // { ...,
 //   privateKey: null, publicKey: pubBytes }
 ```
@@ -953,7 +953,7 @@ This is final piece, which you use for making and receiving payments.
 
    for (let i = index; i < last; i += 1) {
      try {
-       key = await xkey.deriveKey(index);
+       key = await xkey.deriveAddress(index);
      } catch (e) {
        // you may wish to mark the index as failed
      }

dashhd.js

@@ -504,14 +504,14 @@ var DashHd = ("object" === typeof module && exports) || {};
   /** @type {HDCreateXKey} */
   DashHd._createXKey = async function (xkey) {
     Object.assign(xkey, {
-      deriveKey,
+      deriveAddress,
     });
 
     /**
      * @param {Number} index - key index
      * @throws Error - if index cannot produce a valid public key
      */
-    async function deriveKey(index) {
+    async function deriveAddress(index) {
       let key = await DashHd.deriveChild(xkey, index, PUBLIC);
       return key;
     }
@@ -667,7 +667,7 @@ if ("object" === typeof module) {
 
 /**
  * @typedef HDXKeyPartial
- * @prop {HDDeriveKey} deriveKey
+ * @prop {HDDeriveAddress} deriveAddress
  */
 
 /**
@@ -725,7 +725,7 @@ if ("object" === typeof module) {
  */
 
 /**
- * @callback HDDeriveKey
+ * @callback HDDeriveAddress
  * @param {Number} index
  * @returns {Promise<HDKey>}
  * @throws Error - in the rare case the index can't produce a valid public key

test.js

@@ -55,7 +55,7 @@ async function getWalletKeys() {
   console.info();
 
   let addressIndex = 0;
-  let key = await xkey.deriveKey(addressIndex);
+  let key = await xkey.deriveAddress(addressIndex);
   let key1 = await DashHd.derivePath(wallet, "m/44'/5'/0'/0/0");
 
   let wif = await DashHd.toWif(key.privateKey);
@@ -75,7 +75,7 @@ async function getWalletKeys() {
     throw new Error("wallet addr derivation mismatch");
   }
   let xkey2 = await DashHd.fromXKey(xpub);
-  let key2 = await xkey2.deriveKey(addressIndex);
+  let key2 = await xkey2.deriveAddress(addressIndex);
   let addr2 = await DashHd.toAddr(key2.publicKey);
   if (addr !== addr2) {
     throw new Error("wallet xpub addr derivation mismatch");
@@ -114,7 +114,7 @@ async function getWalletKeys() {
   console.info();
 
   addressIndex = 1;
-  key = await xkey.deriveKey(addressIndex);
+  key = await xkey.deriveAddress(addressIndex);
   key1 = await DashHd.derivePath(wallet, "m/44'/5'/1'/1/1");
 
   wif = await DashHd.toWif(key.privateKey);
@@ -134,13 +134,13 @@ async function getWalletKeys() {
     throw new Error("wallet addr derivation mismatch");
   }
   xkey2 = await DashHd.fromXKey(xpub);
-  key2 = await xkey2.deriveKey(addressIndex);
+  key2 = await xkey2.deriveAddress(addressIndex);
   addr2 = await DashHd.toAddr(key2.publicKey);
   if (addr !== addr2) {
     throw new Error("wallet xpub addr derivation mismatch");
   }
   let xkey3 = await DashHd.fromXKey(xprv);
-  let key3 = await xkey3.deriveKey(addressIndex);
+  let key3 = await xkey3.deriveAddress(addressIndex);
   let wif3 = await DashHd.toWif(key3.privateKey);
   if (wif !== wif3) {
     throw new Error("wallet xprv wif derivation mismatch");