@btc-vision/bitcoin 6.3.0 → 6.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@btc-vision/bitcoin",
-    "version": "6.3.0",
+    "version": "6.3.1",
     "description": "Client-side Bitcoin JavaScript library",
     "main": "./src/index.js",
     "types": "./src/index.d.ts",

package/src/networks.d.ts

@@ -27,3 +27,57 @@ export declare const regtest: Network;
  * Represents the testnet network configuration.
  */
 export declare const testnet: Network;
+/**
+ * Represents the Dogecoin mainnet configuration.
+ *
+ * Prefixes from:
+ * - P2PKH: 0x1e (30 decimal) - addresses start with 'D'
+ * - P2SH: 0x16 (22 decimal) - addresses often start with '9' or 'A'
+ * - WIF: 0x9e (158 decimal)
+ * - BIP32:
+ *   - public: 0x02facafd
+ *   - private: 0x02fac398
+ * Message prefix:
+ *   - Dogecoin uses "\x19Dogecoin Signed Message:\n"
+ */
+export declare const dogecoin: Network;
+/**
+ * Represents the Dogecoin testnet configuration.
+ *
+ * Prefixes from Dogecoin testnet chainparams:
+ * - P2PKH: 0x71 (113 decimal)
+ * - P2SH: 0xc4 (196 decimal)
+ * - WIF: 0xf1 (241 decimal)
+ * - BIP32:
+ *   - public: 0x0432a9a8
+ *   - private: 0x0432a243
+ * Message prefix:
+ *   - Same as mainnet: "\x19Dogecoin Signed Message:\n"
+ */
+export declare const dogecoinTestnet: Network;
+/**
+ * Litecoin mainnet configuration.
+ */
+export declare const litecoin: Network;
+/**
+ * Litecoin testnet configuration.
+ */
+export declare const litecoinTestnet: Network;
+/**
+ * Bitcoin Cash mainnet configuration (legacy).
+ * Note: Bitcoin Cash uses Cashaddr starting with 'q' or 'p',
+ * but we retain the legacy prefixes for compatibility.
+ */
+export declare const bitcoinCash: Network;
+/**
+ * Bitcoin Cash testnet configuration (legacy).
+ */
+export declare const bitcoinCashTestnet: Network;
+/**
+ * Dash mainnet configuration.
+ */
+export declare const dash: Network;
+/**
+ * Dash testnet configuration.
+ */
+export declare const dashTestnet: Network;

package/src/networks.js

@@ -2,7 +2,18 @@
 // https://en.bitcoin.it/wiki/List_of_address_prefixes
 // Dogecoin BIP32 is a proposed standard: https://bitcointalk.org/index.php?topic=409731
 Object.defineProperty(exports, '__esModule', { value: true });
-exports.testnet = exports.regtest = exports.bitcoin = void 0;
+exports.dashTestnet =
+    exports.dash =
+    exports.bitcoinCashTestnet =
+    exports.bitcoinCash =
+    exports.litecoinTestnet =
+    exports.litecoin =
+    exports.dogecoinTestnet =
+    exports.dogecoin =
+    exports.testnet =
+    exports.regtest =
+    exports.bitcoin =
+        void 0;
 /**
  * Represents the Bitcoin network configuration.
  */
@@ -69,3 +80,141 @@ exports.testnet = {
     scriptHash: 0xc4,
     wif: 0xef,
 };
+/**
+ * Represents the Dogecoin mainnet configuration.
+ *
+ * Prefixes from:
+ * - P2PKH: 0x1e (30 decimal) - addresses start with 'D'
+ * - P2SH: 0x16 (22 decimal) - addresses often start with '9' or 'A'
+ * - WIF: 0x9e (158 decimal)
+ * - BIP32:
+ *   - public: 0x02facafd
+ *   - private: 0x02fac398
+ * Message prefix:
+ *   - Dogecoin uses "\x19Dogecoin Signed Message:\n"
+ */
+exports.dogecoin = {
+    messagePrefix: '\x19Dogecoin Signed Message:\n',
+    bech32: '',
+    bip32: {
+        public: 0x02facafd,
+        private: 0x02fac398,
+    },
+    pubKeyHash: 0x1e,
+    scriptHash: 0x16,
+    wif: 0x9e,
+};
+/**
+ * Represents the Dogecoin testnet configuration.
+ *
+ * Prefixes from Dogecoin testnet chainparams:
+ * - P2PKH: 0x71 (113 decimal)
+ * - P2SH: 0xc4 (196 decimal)
+ * - WIF: 0xf1 (241 decimal)
+ * - BIP32:
+ *   - public: 0x0432a9a8
+ *   - private: 0x0432a243
+ * Message prefix:
+ *   - Same as mainnet: "\x19Dogecoin Signed Message:\n"
+ */
+exports.dogecoinTestnet = {
+    messagePrefix: '\x19Dogecoin Signed Message:\n',
+    bech32: '',
+    bip32: {
+        public: 0x0432a9a8,
+        private: 0x0432a243,
+    },
+    pubKeyHash: 0x71,
+    scriptHash: 0xc4,
+    wif: 0xf1,
+};
+/**
+ * Litecoin mainnet configuration.
+ */
+exports.litecoin = {
+    messagePrefix: '\x19Litecoin Signed Message:\n',
+    bech32: 'ltc',
+    bip32: {
+        public: 0x019da462,
+        private: 0x019d9cfe,
+    },
+    pubKeyHash: 0x30,
+    scriptHash: 0x32,
+    wif: 0xb0,
+};
+/**
+ * Litecoin testnet configuration.
+ */
+exports.litecoinTestnet = {
+    messagePrefix: '\x19Litecoin Signed Message:\n',
+    bech32: 'tltc',
+    bip32: {
+        public: 0x0436ef7d,
+        private: 0x0436f6e1,
+    },
+    pubKeyHash: 0x6f,
+    scriptHash: 0x3a,
+    wif: 0xef,
+};
+/**
+ * Bitcoin Cash mainnet configuration (legacy).
+ * Note: Bitcoin Cash uses Cashaddr starting with 'q' or 'p',
+ * but we retain the legacy prefixes for compatibility.
+ */
+exports.bitcoinCash = {
+    messagePrefix: '\x18Bitcoin Signed Message:\n',
+    // Cashaddr prefix differs from bech32 for general usage, but we can set it similarly.
+    // Actual cashaddr prefix is "bitcoincash", but this field is for bech32 which BCH doesn't fully use for segwit (it doesn't have segwit).
+    bech32: 'bitcoincash',
+    bip32: {
+        public: 0x0488b21e,
+        private: 0x0488ade4,
+    },
+    pubKeyHash: 0x00,
+    scriptHash: 0x05,
+    wif: 0x80,
+};
+/**
+ * Bitcoin Cash testnet configuration (legacy).
+ */
+exports.bitcoinCashTestnet = {
+    messagePrefix: '\x18Bitcoin Signed Message:\n',
+    bech32: 'bchtest',
+    bip32: {
+        public: 0x043587cf,
+        private: 0x04358394,
+    },
+    pubKeyHash: 0x6f,
+    scriptHash: 0xc4,
+    wif: 0xef,
+};
+/**
+ * Dash mainnet configuration.
+ */
+exports.dash = {
+    // Historically Dash used DarkCoin message prefix, and most implementations use this:
+    // As of Dash Core 0.17, this has not changed in code.
+    messagePrefix: '\x19DarkCoin Signed Message:\n',
+    bech32: '',
+    bip32: {
+        public: 0x02fe52cc,
+        private: 0x02fe52f8,
+    },
+    pubKeyHash: 0x4c,
+    scriptHash: 0x10,
+    wif: 0xcc,
+};
+/**
+ * Dash testnet configuration.
+ */
+exports.dashTestnet = {
+    messagePrefix: '\x19DarkCoin Signed Message:\n',
+    bech32: '',
+    bip32: {
+        public: 0x3a8061a0,
+        private: 0x3a805837,
+    },
+    pubKeyHash: 0x8c,
+    scriptHash: 0x13,
+    wif: 0xef,
+};

package/src/psbt/bip371.d.ts

@@ -39,4 +39,4 @@ export declare function tapTreeToList(tree: Taptree): TapLeaf[];
  */
 export declare function tapTreeFromList(leaves?: TapLeaf[]): Taptree;
 export declare function checkTaprootInputForSigs(input: PsbtInput, action: string): boolean;
-export declare function getTapKeySigFromWithness(finalScriptWitness?: Buffer): Buffer | undefined;
+export declare function getTapKeySigFromWitness(finalScriptWitness?: Buffer): Buffer | undefined;

package/src/psbt/bip371.js

@@ -1,6 +1,6 @@
 'use strict';
 Object.defineProperty(exports, '__esModule', { value: true });
-exports.getTapKeySigFromWithness =
+exports.getTapKeySigFromWitness =
     exports.checkTaprootInputForSigs =
     exports.tapTreeFromList =
     exports.tapTreeToList =
@@ -165,7 +165,7 @@ function tapTreeFromList(leaves = []) {
             output: leaves[0].script,
             version: leaves[0].leafVersion,
         };
-    return instertLeavesInTree(leaves);
+    return insertLeavesInTree(leaves);
 }
 exports.tapTreeFromList = tapTreeFromList;
 function checkTaprootInputForSigs(input, action) {
@@ -192,20 +192,20 @@ function extractTaprootSigs(input) {
     if (input.tapScriptSig)
         sigs.push(...input.tapScriptSig.map(s => s.signature));
     if (!sigs.length) {
-        const finalTapKeySig = getTapKeySigFromWithness(
+        const finalTapKeySig = getTapKeySigFromWitness(
             input.finalScriptWitness,
         );
         if (finalTapKeySig) sigs.push(finalTapKeySig);
     }
     return sigs;
 }
-function getTapKeySigFromWithness(finalScriptWitness) {
+function getTapKeySigFromWitness(finalScriptWitness) {
     if (!finalScriptWitness) return;
     const witness = finalScriptWitness.slice(2);
     // todo: add schnorr signature validation
     if (witness.length === 64 || witness.length === 65) return witness;
 }
-exports.getTapKeySigFromWithness = getTapKeySigFromWithness;
+exports.getTapKeySigFromWitness = getTapKeySigFromWitness;
 function _tapTreeToList(tree, leaves = [], depth = 0) {
     if (depth > bip341_1.MAX_TAPTREE_DEPTH)
         throw new Error('Max taptree depth exceeded.');
@@ -222,15 +222,15 @@ function _tapTreeToList(tree, leaves = [], depth = 0) {
     if (tree[1]) _tapTreeToList(tree[1], leaves, depth + 1);
     return leaves;
 }
-function instertLeavesInTree(leaves) {
+function insertLeavesInTree(leaves) {
     let tree;
     for (const leaf of leaves) {
-        tree = instertLeafInTree(leaf, tree);
+        tree = insertLeafInTree(leaf, tree);
         if (!tree) throw new Error(`No room left to insert tapleaf in tree`);
     }
     return tree;
 }
-function instertLeafInTree(leaf, tree, depth = 0) {
+function insertLeafInTree(leaf, tree, depth = 0) {
     if (depth > bip341_1.MAX_TAPTREE_DEPTH)
         throw new Error('Max taptree depth exceeded.');
     if (leaf.depth === depth) {
@@ -242,9 +242,9 @@ function instertLeafInTree(leaf, tree, depth = 0) {
         return;
     }
     if ((0, types_1.isTapleaf)(tree)) return;
-    const leftSide = instertLeafInTree(leaf, tree && tree[0], depth + 1);
+    const leftSide = insertLeafInTree(leaf, tree && tree[0], depth + 1);
     if (leftSide) return [leftSide, tree && tree[1]];
-    const rightSide = instertLeafInTree(leaf, tree && tree[1], depth + 1);
+    const rightSide = insertLeafInTree(leaf, tree && tree[1], depth + 1);
     if (rightSide) return [tree && tree[0], rightSide];
 }
 function checkMixedTaprootAndNonTaprootInputFields(

package/src/psbt.d.ts

@@ -123,6 +123,10 @@ export declare class Psbt {
     addUnknownKeyValToInput(inputIndex: number, keyVal: KeyValue): this;
     addUnknownKeyValToOutput(outputIndex: number, keyVal: KeyValue): this;
     clearFinalizedInput(inputIndex: number): this;
+    checkTaprootHashesForSig(inputIndex: number, input: PsbtInput, keyPair: Signer | SignerAlternative | SignerAsync | BIP32Interface | ECPairInterface, tapLeafHashToSign?: Buffer, allowedSighashTypes?: number[]): {
+        hash: Buffer;
+        leafHash?: Buffer;
+    }[];
     private _finalizeInput;
     private _finalizeTaprootInput;
     private _validateSignaturesOfInput;
@@ -131,7 +135,6 @@ export declare class Psbt {
     private _signTaprootInput;
     private _signInputAsync;
     private _signTaprootInputAsync;
-    private checkTaprootHashesForSig;
 }
 export interface PsbtOptsOptional {
     network?: Network;

package/src/psbt.js

@@ -541,8 +541,9 @@ class Psbt {
         });
     }
     signInput(inputIndex, keyPair, sighashTypes) {
-        if (!keyPair || !keyPair.publicKey)
+        if (!keyPair || !keyPair.publicKey) {
             throw new Error('Need Signer to sign input');
+        }
         const input = (0, utils_1.checkForInput)(this.data.inputs, inputIndex);
         if ((0, bip371_1.isTaprootInput)(input)) {
             return this._signTaprootInput(
@@ -556,10 +557,11 @@ class Psbt {
         return this._signInput(inputIndex, keyPair, sighashTypes);
     }
     signTaprootInput(inputIndex, keyPair, tapLeafHashToSign, sighashTypes) {
-        if (!keyPair || !keyPair.publicKey)
+        if (!keyPair || !keyPair.publicKey) {
             throw new Error('Need Signer to sign input');
+        }
         const input = (0, utils_1.checkForInput)(this.data.inputs, inputIndex);
-        if ((0, bip371_1.isTaprootInput)(input))
+        if ((0, bip371_1.isTaprootInput)(input)) {
             return this._signTaprootInput(
                 inputIndex,
                 input,
@@ -567,6 +569,7 @@ class Psbt {
                 tapLeafHashToSign,
                 sighashTypes,
             );
+        }
         throw new Error(`Input #${inputIndex} is not of type Taproot.`);
     }
     signInputAsync(inputIndex, keyPair, sighashTypes) {
@@ -667,6 +670,34 @@ class Psbt {
         this.data.clearFinalizedInput(inputIndex);
         return this;
     }
+    checkTaprootHashesForSig(
+        inputIndex,
+        input,
+        keyPair,
+        tapLeafHashToSign,
+        allowedSighashTypes,
+    ) {
+        if (typeof keyPair.signSchnorr !== 'function')
+            throw new Error(
+                `Need Schnorr Signer to sign taproot input #${inputIndex}.`,
+            );
+        const hashesForSig = getTaprootHashesForSig(
+            inputIndex,
+            input,
+            this.data.inputs,
+            keyPair.publicKey,
+            this.__CACHE,
+            tapLeafHashToSign,
+            allowedSighashTypes,
+        );
+        if (!hashesForSig || !hashesForSig.length)
+            throw new Error(
+                `Can not sign for input #${inputIndex} with the key ${keyPair.publicKey.toString(
+                    'hex',
+                )}`,
+            );
+        return hashesForSig;
+    }
     _finalizeInput(inputIndex, input, finalScriptsFunc = getFinalScripts) {
         const { script, isP2SH, isP2WSH, isSegwit } = getScriptFromInput(
             inputIndex,
@@ -701,7 +732,7 @@ class Psbt {
     ) {
         if (!input.witnessUtxo)
             throw new Error(
-                `Cannot finalize input #${inputIndex}. Missing withness utxo.`,
+                `Cannot finalize input #${inputIndex}. Missing witness utxo.`,
             );
         // Check key spend first. Increased privacy and reduced block space.
         if (input.tapKeySig) {
@@ -955,34 +986,6 @@ class Psbt {
             this.data.updateInput(inputIndex, v);
         }
     }
-    checkTaprootHashesForSig(
-        inputIndex,
-        input,
-        keyPair,
-        tapLeafHashToSign,
-        allowedSighashTypes,
-    ) {
-        if (typeof keyPair.signSchnorr !== 'function')
-            throw new Error(
-                `Need Schnorr Signer to sign taproot input #${inputIndex}.`,
-            );
-        const hashesForSig = getTaprootHashesForSig(
-            inputIndex,
-            input,
-            this.data.inputs,
-            keyPair.publicKey,
-            this.__CACHE,
-            tapLeafHashToSign,
-            allowedSighashTypes,
-        );
-        if (!hashesForSig || !hashesForSig.length)
-            throw new Error(
-                `Can not sign for input #${inputIndex} with the key ${keyPair.publicKey.toString(
-                    'hex',
-                )}`,
-            );
-        return hashesForSig;
-    }
 }
 exports.Psbt = Psbt;
 /**