mainnet-js 0.4.30 → 0.4.31

package/src/wallet/Wif.test.ts

@@ -3,7 +3,7 @@ import { bchParam } from "../chain";
 import { BalanceResponse } from "../util/balanceObjectFromSatoshi";
 import { UnitEnum } from "../enum";
 import { initProviders, disconnectProviders } from "../network/Connection";
-import { DUST_UTXO_THRESHOLD as DUST } from "../constant";
+import { DERIVATION_PATHS, DUST_UTXO_THRESHOLD as DUST } from "../constant";
 import { delay } from "../util/delay";
 import { OpReturnData, SendResponse } from "./model";
 import { ElectrumRawTransaction } from "../network/interface";
@@ -183,6 +183,9 @@ describe(`Mnemonic wallet creation`, () => {
         "04aaeb52dd7494c361049de67cc680e83ebcbbbdbeb13637d92cd845f70308af5e9370164133294e5fd1679672fe7866c307daf97281a28f66dca7cbb52919824f",
       publicKeyHash: "d986ed01b7a22225a70edbf2ba7cfb63a15cb3aa",
 
+      parentXPubKey:
+        "xpub6BosfCnifzxcFwrSzQiqu2DBVTshkCXacvNsWGYJVVhhawA7d4R5WSWGFNbi8Aw6ZRc1brxMyWMzG3DSSSSoekkudhUd9yLb6qx39T9nMdj",
+      parentDerivationPath: "m/44'/0'/0'",
       derivationPath: "m/44'/0'/0'/0/0",
       seed: "abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about",
 
@@ -208,6 +211,7 @@ describe(`Mnemonic wallet creation`, () => {
       "abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about"
     );
     expect(w.getSeed().derivationPath).toBe("m/44'/145'/0'/0/0");
+    expect(w.getSeed().parentDerivationPath).toBe("m/44'/145'/0'");
   });
   test("Expect '11x abandon about' to have the correct key, seed and path from regtest wallet", async () => {
     let w = await RegTestWallet.fromId(
@@ -226,6 +230,172 @@ describe(`Mnemonic wallet creation`, () => {
   });
 });
 
+describe(`XPubKey path derivation`, () => {
+  test("Expect '11x abandon about' to have the correct xpubs for common derivation paths, seed and path", async () => {
+    let w = await Wallet.fromId(
+      "seed:mainnet:abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about"
+    );
+    let commonPaths = await w.deriveHdPaths(DERIVATION_PATHS);
+    expect(commonPaths).toStrictEqual([
+      {
+        path: "m/0",
+        xPubKey:
+          "xpub68jrRzQfUmwSaf5Y37Yd5uwfnMRxiR14M3HBonDr91GB7GKEh7R9Mvu2UeCtbASfXZ9FdNo9FwFx6a37HNXUDiXVQFXuadXmevRBa3y7rL8",
+      },
+      {
+        path: "m/0'",
+        xPubKey:
+          "xpub68jrRzQopSUQm76hJ6TNtiJMJfhj38u1X12xCzExrw388hcN443UVnYpswdUkV7vPJ3KayiCdp3Q5E23s4wvkucohVTh7eSstJdBFyn2DMx",
+      },
+      {
+        path: "m/0'/0",
+        xPubKey:
+          "xpub6A7PsGUCo9qsn1jhZVB68WKWU9bTt1Wu7fzRqhczRbJ3u3xsF1bJmWBL1MvygTtrfmvNw1adLzmRjQHtDCJDXAHFa4K3wELpGGqEXL4e6d4",
+      },
+      {
+        path: "m/0'/0'",
+        xPubKey:
+          "xpub6A7PsGUM8pNqwy9AceVuFK6KxY88FhvFMRGP9fjEDKA3P4WpR1zyHH3Lmczj7eorx4RbDC4Qttd8C7HhLA2W9LsxxZzXo1DMCwJFb3zZKZ8",
+      },
+      {
+        path: "m/0'/0'/0'",
+        xPubKey:
+          "xpub6BiChRN7aqq51RA7RnAmKhqKdGckPncrHWLrj1xoj6ZMfdMJ1dX4Ysh9V3yEhpFCpC3BapjR83xPKY693XXTEU6qgWU3qZs78WBHA15uhYf",
+      },
+      {
+        path: "m/44'/0'/0'",
+        xPubKey:
+          "xpub6BosfCnifzxcFwrSzQiqu2DBVTshkCXacvNsWGYJVVhhawA7d4R5WSWGFNbi8Aw6ZRc1brxMyWMzG3DSSSSoekkudhUd9yLb6qx39T9nMdj",
+      },
+      {
+        path: "m/44'/0'/0'/0",
+        xPubKey:
+          "xpub6ELHKXNimKbxMCytPh7EdC2QXx46T9qLDJWGnTraz1H9kMMFdcduoU69wh9cxP12wDxqAAfbaESWGYt5rREsX1J8iR2TEunvzvddduAPYcY",
+      },
+      {
+        path: "m/44'/145'/0'",
+        xPubKey:
+          "xpub6ByHsPNSQXTWZ7PLESMY2FufyYWtLXagSUpMQq7Un96SiThZH2iJB1X7pwviH1WtKVeDP6K8d6xxFzzoaFzF3s8BKCZx8oEDdDkNnp4owAZ",
+      },
+      {
+        path: "m/44'/145'/0'/0",
+        xPubKey:
+          "xpub6F2iaK2JUPcgrZ6RTGH6t8VybLPu1XzfrHsDsaKvK6NfULznU6i6aw6ZoefDW2DpNruSLw73RwQg46qvpqB3eryeJJ2tkFCF4Z6gbr8Pjja",
+      },
+      {
+        path: "m/44'/245'/0",
+        xPubKey:
+          "xpub6Ch34ms5osevEtkEZX81n8EG4c6vgHWGH1gQXBG2uf2Tihb1eed4H1wozLfZB31mV9JD7mymYTQxcLKFFjZHdM5NGdH2Ud1ksSkfwSFjjCg",
+      },
+      {
+        path: "m/44'/245'/0'",
+        xPubKey:
+          "xpub6Ch34msE9YBtQV7pZrLyRXHwocrpJtNN4KDG8bbyxyhGmEM5MirtqkiH4h9dvnVJ3MekET3w2Fkvej3fyo8WLz9bRPyDynDf6NXNfuydhv1",
+      },
+      {
+        path: "m/44'/245'/0'/0",
+        xPubKey:
+          "xpub6FFeETss5Zwkw78NDAibKEaGxigU3bgYzLihcqbQqqTyb6jorR9mgR9AexYydxmiPU8koAf5ndaQPjPWK3sDz1wjBjf2TkLbD982S9PWd9Z",
+      },
+    ]);
+  });
+  test("Expect '11x abandon about' to return 'protected' for root path", async () => {
+    expect.assertions(1);
+    try {
+      let w = await Wallet.fromId(
+        "seed:mainnet:abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about"
+      );
+      let commonPaths = await w.deriveHdPaths(["m"]);
+    } catch (e: any) {
+      expect(e.message).toBe(
+        "Storing or sharing of parent public key may lead to loss of funds. Storing or sharing *root* parent public keys is strongly discouraged, although all parent keys have risk. See: https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki#implications"
+      );
+    }
+  });
+
+  test("Expect '11x abandon about' to have the correct xpubs for common derivation paths, seed and path", async () => {
+    let w = await Wallet.fromId(
+      "seed:mainnet:abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about"
+    );
+    let commonPaths = await w.getXPubKeys();
+    expect(commonPaths).toStrictEqual([
+      {
+        path: "m/0",
+        xPubKey:
+          "xpub68jrRzQfUmwSaf5Y37Yd5uwfnMRxiR14M3HBonDr91GB7GKEh7R9Mvu2UeCtbASfXZ9FdNo9FwFx6a37HNXUDiXVQFXuadXmevRBa3y7rL8",
+      },
+      {
+        path: "m/0'",
+        xPubKey:
+          "xpub68jrRzQopSUQm76hJ6TNtiJMJfhj38u1X12xCzExrw388hcN443UVnYpswdUkV7vPJ3KayiCdp3Q5E23s4wvkucohVTh7eSstJdBFyn2DMx",
+      },
+      {
+        path: "m/0'/0",
+        xPubKey:
+          "xpub6A7PsGUCo9qsn1jhZVB68WKWU9bTt1Wu7fzRqhczRbJ3u3xsF1bJmWBL1MvygTtrfmvNw1adLzmRjQHtDCJDXAHFa4K3wELpGGqEXL4e6d4",
+      },
+      {
+        path: "m/0'/0'",
+        xPubKey:
+          "xpub6A7PsGUM8pNqwy9AceVuFK6KxY88FhvFMRGP9fjEDKA3P4WpR1zyHH3Lmczj7eorx4RbDC4Qttd8C7HhLA2W9LsxxZzXo1DMCwJFb3zZKZ8",
+      },
+      {
+        path: "m/0'/0'/0'",
+        xPubKey:
+          "xpub6BiChRN7aqq51RA7RnAmKhqKdGckPncrHWLrj1xoj6ZMfdMJ1dX4Ysh9V3yEhpFCpC3BapjR83xPKY693XXTEU6qgWU3qZs78WBHA15uhYf",
+      },
+      {
+        path: "m/44'/0'/0'",
+        xPubKey:
+          "xpub6BosfCnifzxcFwrSzQiqu2DBVTshkCXacvNsWGYJVVhhawA7d4R5WSWGFNbi8Aw6ZRc1brxMyWMzG3DSSSSoekkudhUd9yLb6qx39T9nMdj",
+      },
+      {
+        path: "m/44'/0'/0'/0",
+        xPubKey:
+          "xpub6ELHKXNimKbxMCytPh7EdC2QXx46T9qLDJWGnTraz1H9kMMFdcduoU69wh9cxP12wDxqAAfbaESWGYt5rREsX1J8iR2TEunvzvddduAPYcY",
+      },
+      {
+        path: "m/44'/145'/0'",
+        xPubKey:
+          "xpub6ByHsPNSQXTWZ7PLESMY2FufyYWtLXagSUpMQq7Un96SiThZH2iJB1X7pwviH1WtKVeDP6K8d6xxFzzoaFzF3s8BKCZx8oEDdDkNnp4owAZ",
+      },
+      {
+        path: "m/44'/145'/0'/0",
+        xPubKey:
+          "xpub6F2iaK2JUPcgrZ6RTGH6t8VybLPu1XzfrHsDsaKvK6NfULznU6i6aw6ZoefDW2DpNruSLw73RwQg46qvpqB3eryeJJ2tkFCF4Z6gbr8Pjja",
+      },
+      {
+        path: "m/44'/245'/0",
+        xPubKey:
+          "xpub6Ch34ms5osevEtkEZX81n8EG4c6vgHWGH1gQXBG2uf2Tihb1eed4H1wozLfZB31mV9JD7mymYTQxcLKFFjZHdM5NGdH2Ud1ksSkfwSFjjCg",
+      },
+      {
+        path: "m/44'/245'/0'",
+        xPubKey:
+          "xpub6Ch34msE9YBtQV7pZrLyRXHwocrpJtNN4KDG8bbyxyhGmEM5MirtqkiH4h9dvnVJ3MekET3w2Fkvej3fyo8WLz9bRPyDynDf6NXNfuydhv1",
+      },
+      {
+        path: "m/44'/245'/0'/0",
+        xPubKey:
+          "xpub6FFeETss5Zwkw78NDAibKEaGxigU3bgYzLihcqbQqqTyb6jorR9mgR9AexYydxmiPU8koAf5ndaQPjPWK3sDz1wjBjf2TkLbD982S9PWd9Z",
+      },
+    ]);
+  });
+  test("Expect '11x abandon about' to return 'protected' for root path", async () => {
+    expect.assertions(1);
+    try {
+      let w = await Wallet.fromId(
+        "seed:mainnet:abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about"
+      );
+      let commonPaths = await w.getXPubKeys(["m"]);
+    } catch (e: any) {
+      expect(e.message).toBe(
+        "Storing or sharing of parent public key may lead to loss of funds. Storing or sharing *root* parent public keys is strongly discouraged, although all parent keys have risk. See: https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki#implications"
+      );
+    }
+  });
+});
+
 describe(`Watch only Wallets`, () => {
   test("Create a watch only testnet wallet from string id", async () => {
     let w = await TestNetWallet.fromId(
@@ -242,6 +412,8 @@ describe(`Watch only Wallets`, () => {
       isTestnet: true,
       name: "",
       network: "testnet",
+      parentDerivationPath: undefined,
+      parentXPubKey: undefined,
       privateKey: undefined,
       privateKeyWif: undefined,
       publicKey: undefined,

package/src/wallet/Wif.ts

@@ -1,11 +1,18 @@
 //#region Imports
 // Stable
-import { instantiateSecp256k1, instantiateSha256 } from "@bitauth/libauth";
+import {
+  deriveHdPublicNodeIdentifier,
+  encodeHdPublicKey,
+  HdKeyNetwork,
+  instantiateSecp256k1,
+  instantiateSha256,
+} from "@bitauth/libauth";
 
 // Unstable?
 import {
   binToHex,
   CashAddressNetworkPrefix,
+  deriveHdPublicNode,
   decodePrivateKeyWif,
   encodePrivateKeyWif,
   deriveHdPrivateNodeFromSeed,
@@ -40,6 +47,7 @@ import {
   SendResponse,
   UtxoItem,
   UtxoResponse,
+  XPubKey,
 } from "./model";
 
 import {
@@ -92,7 +100,8 @@ import { generateRandomBytes } from "../util/randomBytes";
 import { SignedMessageI, SignedMessage } from "../message";
 import ElectrumNetworkProvider from "../network/ElectrumNetworkProvider";
 import { amountInSatoshi } from "../util/amountInSatoshi";
-import { DUST_UTXO_THRESHOLD } from "../constant";
+import { getXPubKey } from "../util/getXPubKey";
+import { DERIVATION_PATHS, DUST_UTXO_THRESHOLD } from "../constant";
 
 //#endregion Imports
 
@@ -105,6 +114,8 @@ const sha256Promise = instantiateSha256();
 export class Wallet extends BaseWallet {
   cashaddr?: string;
   derivationPath: string = "m/44'/0'/0'/0/0";
+  parentDerivationPath: string = "m/44'/0'/0'";
+  parentXPubKey?: string;
   privateKey?: Uint8Array;
   publicKeyCompressed?: Uint8Array;
   privateKeyWif?: string;
@@ -186,6 +197,10 @@ export class Wallet extends BaseWallet {
       network: this.network as any,
       seed: this.mnemonic ? this.getSeed().seed : undefined,
       derivationPath: this.mnemonic ? this.getSeed().derivationPath : undefined,
+      parentDerivationPath: this.mnemonic
+        ? this.getSeed().parentDerivationPath
+        : undefined,
+      parentXPubKey: this.parentXPubKey ? this.parentXPubKey : undefined,
       publicKey: this.publicKey ? binToHex(this.publicKey!) : undefined,
       publicKeyHash: binToHex(this.publicKeyHash!),
       privateKey: this.privateKey ? binToHex(this.privateKey!) : undefined,
@@ -319,19 +334,25 @@ export class Wallet extends BaseWallet {
   }
 
   private async _generateMnemonic() {
-    const crypto = await instantiateBIP32Crypto();
     this.mnemonic = generateMnemonic();
     let seed = mnemonicToSeedSync(this.mnemonic!);
+    let network = this.isTestnet ? "testnet" : "mainnet";
+    this.parentXPubKey = await getXPubKey(
+      seed,
+      this.parentDerivationPath,
+      network
+    );
+
+    const crypto = await instantiateBIP32Crypto();
     let hdNode = deriveHdPrivateNodeFromSeed(crypto, seed);
     if (!hdNode.valid) {
       throw Error("Invalid private key derived from mnemonic seed");
     }
 
-    let zerothChild = deriveHdPath(
-      crypto,
-      hdNode,
-      this.derivationPath
-    ) as HdPrivateNodeValid;
+    let zerothChild = deriveHdPath(crypto, hdNode, this.derivationPath);
+    if (typeof zerothChild === "string") {
+      throw Error(zerothChild);
+    }
     this.privateKey = zerothChild.privateKey;
 
     this.walletType = WalletTypeEnum.Seed;
@@ -353,6 +374,18 @@ export class Wallet extends BaseWallet {
     return super.fromId(walletId);
   };
 
+  public async getXPubKeys(paths?) {
+    if (this.mnemonic) {
+      if (paths) {
+        let xPubKeys = await this.deriveHdPaths(paths);
+        return [xPubKeys];
+      } else {
+        return await this.deriveHdPaths(DERIVATION_PATHS);
+      }
+    } else {
+      throw Error("xpubkeys can only be derived from seed type wallets.");
+    }
+  }
   // Initialize wallet from a mnemonic phrase
   protected async fromSeed(
     mnemonic: string,
@@ -369,20 +402,73 @@ export class Wallet extends BaseWallet {
     }
     if (derivationPath) {
       this.derivationPath = derivationPath;
+
+      // If the derivation path is for the first account child, set the parent derivation path
+      let path = derivationPath.split("/");
+      if (path.slice(-2).join("/") == "0/0") {
+        this.parentDerivationPath = path.slice(0, -2).join("/");
+      }
     }
 
-    let zerothChild = deriveHdPath(
-      crypto,
-      hdNode,
-      this.derivationPath
-    ) as HdPrivateNodeValid;
+    let zerothChild = deriveHdPath(crypto, hdNode, this.derivationPath);
+    if (typeof zerothChild === "string") {
+      throw Error(zerothChild);
+    }
     this.privateKey = zerothChild.privateKey;
 
+    let network = this.isTestnet ? "testnet" : "mainnet";
+    this.parentXPubKey = await getXPubKey(
+      seed,
+      this.parentDerivationPath,
+      network
+    );
+
     this.walletType = WalletTypeEnum.Seed;
     await this.deriveInfo();
     return this;
   }
 
+  // Get common xpub paths from zerothChild privateKey
+  public async deriveHdPaths(hdPaths: string[]): Promise<any[]> {
+    const crypto = await instantiateBIP32Crypto();
+    let seed = mnemonicToSeedSync(this.mnemonic!);
+    let hdNode = deriveHdPrivateNodeFromSeed(crypto, seed);
+    if (!hdNode.valid) {
+      throw Error("Invalid private key derived from mnemonic seed");
+    }
+
+    let result: any[] = [];
+
+    for (const path of hdPaths) {
+      if (path === "m") {
+        throw Error(
+          "Storing or sharing of parent public key may lead to loss of funds. Storing or sharing *root* parent public keys is strongly discouraged, although all parent keys have risk. See: https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki#implications"
+        );
+      }
+      let childNode = deriveHdPath(crypto, hdNode, path);
+      if (typeof childNode === "string") {
+        throw Error(childNode);
+      }
+      let node = deriveHdPublicNode(crypto, childNode);
+      if (typeof node === "string") {
+        throw Error(node);
+      }
+      let xPubKey = encodeHdPublicKey(crypto, {
+        network: this.network as HdKeyNetwork,
+        node: node,
+      });
+      let key = new XPubKey({
+        path: path,
+        xPubKey: xPubKey,
+      });
+
+      result.push(await key.ready());
+    }
+    return await Promise.all(result).then((result) => {
+      return result;
+    });
+  }
+
   // Initialize a watch only wallet from a cash addr
   protected async watchOnly(address: string): Promise<this> {
     this.walletType = WalletTypeEnum.Watch;
@@ -417,8 +503,7 @@ export class Wallet extends BaseWallet {
     const sha256 = await sha256Promise;
     let wifResult = decodePrivateKeyWif(sha256, secret);
 
-    const hasError = typeof wifResult === "string";
-    if (hasError) {
+    if (typeof wifResult === "string") {
       throw Error(wifResult as string);
     }
     let resultData: PrivateKeyI = wifResult as PrivateKeyI;

package/src/wallet/createWallet.test.ts

@@ -66,6 +66,8 @@ describe(`Named Wallets`, () => {
       isTestnet: true,
       name: "",
       network: "testnet",
+      parentDerivationPath: undefined,
+      parentXPubKey: undefined,
       privateKey: undefined,
       privateKeyWif: undefined,
       publicKey: undefined,

package/src/wallet/interface.ts

@@ -23,6 +23,7 @@ export interface WalletResponseI {
   privkey?: string;
   seed?: string;
   derivationPath?: string;
+  parentDerivationPath?: string;
 }
 
 export interface WalletInfoI {
@@ -32,6 +33,8 @@ export interface WalletInfoI {
   network: NetworkEnum;
   seed?: string;
   derivationPath?: string;
+  parentDerivationPath?: string;
+  parentXPubKey?: string;
   publicKey?: string;
   publicKeyHash?: string;
   privateKey?: string;
@@ -52,6 +55,7 @@ export interface SendRequestOptionsI {
 export interface MnemonicI {
   seed: string;
   derivationPath: string;
+  parentDerivationPath: string;
 }
 
 export interface WalletI {

package/src/wallet/model.ts

@@ -159,3 +159,25 @@ export class SendResponse {
     this.explorerUrl = explorerUrl;
   }
 }
+
+export class XPubKey {
+  path: string;
+  xPubKey: string;
+
+  constructor({ path, xPubKey }: { path: string; xPubKey: string }) {
+    this.path = path;
+    this.xPubKey = xPubKey;
+  }
+
+  public async ready() {
+    await this.xPubKey;
+    return this.asObject();
+  }
+
+  public asObject() {
+    return {
+      path: this.path,
+      xPubKey: this.xPubKey,
+    };
+  }
+}