Merge pull request #61 from swan-bitcoin/jdf/caravan-upgrade

upgrade to caravan from (deprecated) unchained-bitcoin, add taproot support

Author: turkycat

.circleci/config.yml

@@ -1 +1 @@
-14.7.0
+20.12.2

.nvmrc

@@ -3,7 +3,7 @@
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
 
 A small JavaScript library and accompanying tool that derives bitcoin addresses from extended public keys. Built upon
-[unchained-bitcoin](https://github.com/unchained-capital/unchained-bitcoin)
+[caravan](https://github.com/caravan-bitcoin/caravan)
 and [bitcoinjs-lib](https://github.com/bitcoinjs/bitcoinjs-lib).
 
 For more details refer to the individual packages:
@@ -17,6 +17,7 @@ For more details refer to the individual packages:
 - [BIP 44](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki) - Multi-Account Hierarchy for Deterministic Wallets
 - [BIP 49](https://github.com/bitcoin/bips/blob/master/bip-0049.mediawiki) - Derivation scheme for P2WPKH-nested-in-P2SH based accounts
 - [BIP 84](https://github.com/bitcoin/bips/blob/master/bip-0084.mediawiki) - Derivation scheme for P2WPKH based accounts
+- [BIP 86](https://github.com/bitcoin/bips/blob/master/bip-0086.mediawiki) - Key Derivation for Single Key P2TR Outputs
 
 Samourai Wallet wrote a short summary on the differences between [BIP 44, BIP 49, BIP 84](https://samourai.kayako.com/article/65-bip-44-bip-49-and-bip84) and [XPUB's, YPUB's, ZPUB's](https://samourai.kayako.com/article/49-xpub-s-ypub-s-zpub-s). For a detailed explanation on derivation paths refer to [learn me a bitcoin](https://learnmeabitcoin.com/technical/derivation-paths).
 

README.md

@@ -53,7 +53,7 @@
     "test": "echo \"Warning: no test specified\""
   },
   "dependencies": {
-    "@swan-bitcoin/xpub-lib": "^0.1.4",
+    "@swan-bitcoin/xpub-lib": "^0.2.0",
     "commander": "^6.1.0"
   },
   "devDependencies": {

packages/xpub-cli/package.json

@@ -1,15 +1,14 @@
 #!/usr/bin/env node
 
-import {
-  NETWORKS,
+const {
+  Network,
   isValidAddress,
   isValidExtPubKey,
   addressFromExtPubKey,
   addressesFromExtPubKey,
   Purpose,
-} from "@swan-bitcoin/xpub-lib"
-
-import { version } from "../package.json"
+} = require("@swan-bitcoin/xpub-lib")
+const { version } = require("../package.json")
 
 function parsePurpose(purpose) {
   switch (purpose.toLowerCase()) {
@@ -22,6 +21,9 @@ function parsePurpose(purpose) {
     case "p2wpkh": {
       return Purpose.P2WPKH
     }
+    case "p2tr": {
+      return Purpose.P2TR
+    }
     default: {
       return undefined
     }
@@ -45,7 +47,7 @@ program
   .description("derive address(es) from an extended public key")
   .option(
     "-p, --purpose <purpose>",
-    "derivation purpose which dictates the address type ['p2pkh', 'p2sh', 'p2wpkh']",
+    "derivation purpose which dictates the address type ['p2pkh', 'p2sh', 'p2wpkh', 'p2tr']",
     "p2wpkh"
   ) // use `choices` once this feature is released: https://github.com/tj/commander.js/issues/518
   .option(
@@ -54,8 +56,8 @@ program
     1
   )
   .option(
-    "-c, --accountNumber <accountNumber>",
-    "the account number as defined in BIP 44",
+    "-c, --change <change>",
+    "the change index to use (0 = external aka receive, 1 = internal aka change / other)",
     0
   )
   .option(
@@ -70,7 +72,7 @@ program
       cmdObj.help()
     }
 
-    const network = cmdObj.testnet ? NETWORKS.TESTNET : NETWORKS.MAINNET
+    const network = cmdObj.testnet ? Network.TESTNET : Network.MAINNET
     if (!isValidExtPubKey(extPubKey, network)) {
       console.error(`error: invalid extended public key '${extPubKey}'`)
       process.exitCode = 1
@@ -80,16 +82,16 @@ program
     const purpose = cmdObj.purpose
       ? parsePurpose(cmdObj.purpose)
       : Purpose.P2WPKH // default to P2WPKH
-    const keyIndex = cmdObj.keyIndex ? cmdObj.keyIndex : 0 // default to P2WPKH
-    const accountNumber = cmdObj.accountNumber ? cmdObj.accountNumber : 0 // default to P2WPKH
+    const change = cmdObj.change ? cmdObj.change : 0 // default to external chain
+    const keyIndex = cmdObj.keyIndex ? cmdObj.keyIndex : 0 // default to first index
 
     if (cmdObj.addressCount > 1) {
       // Multiple addresses
       const { addressCount } = cmdObj
       const addresses = addressesFromExtPubKey({
         extPubKey,
         addressCount,
-        accountNumber,
+        change,
         purpose,
         network,
       })
@@ -100,7 +102,7 @@ program
       // Single address
       const address = addressFromExtPubKey({
         extPubKey,
-        accountNumber,
+        change,
         keyIndex,
         purpose,
         network,
@@ -123,7 +125,7 @@ program
       cmdObj.help()
     }
 
-    const network = cmdObj.testnet ? NETWORKS.TESTNET : NETWORKS.MAINNET
+    const network = cmdObj.testnet ? Network.TESTNET : Network.MAINNET
     let isValid = false
     let type = ""
     if (cmdObj.checkAddress) {