@btc-vision/bitcoin 7.0.0-beta.0 → 7.0.0-beta.1

package/src/psbt/bip371.ts

@@ -11,6 +11,7 @@ import {
     LEAF_VERSION_TAPSCRIPT,
     MAX_TAPTREE_DEPTH,
     rootHashFromPath,
+    rootHashFromPathP2MR,
     tapleafHash,
     tweakKey,
 } from '../payments/bip341.js';
@@ -20,6 +21,7 @@ import type { Bytes32, Tapleaf, Taptree, XOnlyPublicKey } from '../types.js';
 import { isTapleaf, isTaptree } from '../types.js';
 import { concat, equals } from '../io/index.js';
 import {
+    isP2MR,
     isP2TR,
     pubkeyPositionInScript,
     signatureBlocksAction,
@@ -55,16 +57,31 @@ export function tapScriptFinalizer(
             .concat(new Uint8Array(tapLeaf.controlBlock));
         return { finalScriptWitness: witnessStackToScriptWitness(witness) };
     } catch (err) {
-        throw new Error(`Can not finalize taproot input #${inputIndex}: ${err}`);
+        throw new Error(`Can not finalize taproot input #${inputIndex}: ${err}`, { cause: err });
     }
 }
 
+/**
+ * Serializes a taproot (Schnorr) signature, optionally appending the sighash type byte.
+ * If sighashType is SIGHASH_DEFAULT (0x00) or not provided, no byte is appended (per BIP 341).
+ * Used for both P2TR key-path/script-path and P2MR script-path signatures.
+ * @param sig - The 64-byte Schnorr signature.
+ * @param sighashType - Optional sighash type. Omit or pass 0 for SIGHASH_DEFAULT.
+ * @returns The serialized signature (64 or 65 bytes).
+ */
 export function serializeTaprootSignature(sig: Uint8Array, sighashType?: number): Uint8Array {
     const sighashTypeByte = sighashType ? new Uint8Array([sighashType]) : new Uint8Array(0);
 
     return concat([sig, sighashTypeByte]);
 }
 
+/**
+ * Determines whether a PSBT input should be handled as a taproot-style input.
+ * Returns true for both P2TR (SegWit v1, BIP 341) and P2MR (SegWit v2, BIP 360) inputs.
+ * This is the gateway check that routes inputs to taproot signing and finalization logic.
+ * @param input - The PSBT input to check.
+ * @returns True if the input has taproot/P2MR fields or a P2TR/P2MR witnessUtxo script.
+ */
 export function isTaprootInput(input: PsbtInput): boolean {
     return (
         input &&
@@ -73,11 +90,31 @@ export function isTaprootInput(input: PsbtInput): boolean {
             input.tapMerkleRoot ||
             (input.tapLeafScript && input.tapLeafScript.length) ||
             (input.tapBip32Derivation && input.tapBip32Derivation.length) ||
-            (input.witnessUtxo && isP2TR(new Uint8Array(input.witnessUtxo.script)))
+            (input.witnessUtxo &&
+                (isP2TR(new Uint8Array(input.witnessUtxo.script)) ||
+                    isP2MR(new Uint8Array(input.witnessUtxo.script))))
         )
     );
 }
 
+/**
+ * Checks if the input is spending a P2MR (Pay-to-Merkle-Root, BIP 360) output.
+ * Requires `witnessUtxo` to be set on the input; returns false otherwise.
+ * P2MR uses SegWit version 2 with scriptPubKey: `OP_2 <32-byte merkle_root>`.
+ * @param input - The PSBT input to check.
+ * @returns True if the witnessUtxo script is a valid P2MR output.
+ */
+export function isP2MRInput(input: PsbtInput): boolean {
+    return !!(input.witnessUtxo && isP2MR(new Uint8Array(input.witnessUtxo.script)));
+}
+
+/**
+ * Determines whether a PSBT output should be handled as a taproot-style output.
+ * Returns true for both P2TR (BIP 341) and P2MR (BIP 360) outputs.
+ * @param output - The PSBT output to check.
+ * @param script - Optional output script to test against P2TR/P2MR patterns.
+ * @returns True if the output has taproot fields or a P2TR/P2MR script.
+ */
 export function isTaprootOutput(output: PsbtOutput, script?: Uint8Array): boolean {
     return (
         output &&
@@ -85,7 +122,7 @@ export function isTaprootOutput(output: PsbtOutput, script?: Uint8Array): boolea
             output.tapInternalKey ||
             output.tapTree ||
             (output.tapBip32Derivation && output.tapBip32Derivation.length) ||
-            (script && isP2TR(script))
+            (script && (isP2TR(script) || isP2MR(script)))
         )
     );
 }
@@ -324,20 +361,21 @@ function checkMixedTaprootAndNonTaprootOutputFields(
  * @throws {Error} - If the tap leaf is not part of the tap tree.
  */
 function checkIfTapLeafInTree(inputData: PsbtInput, newInputData: PsbtInput, action: string): void {
+    const p2mrInput = isP2MRInput(inputData) || isP2MRInput(newInputData);
     if (newInputData.tapMerkleRoot) {
         const merkleRoot = new Uint8Array(newInputData.tapMerkleRoot);
         const newLeafsInTree = (newInputData.tapLeafScript || []).every((l) =>
-            isTapLeafInTree(l, merkleRoot),
+            isTapLeafInTree(l, merkleRoot, p2mrInput),
         );
         const oldLeafsInTree = (inputData.tapLeafScript || []).every((l) =>
-            isTapLeafInTree(l, merkleRoot),
+            isTapLeafInTree(l, merkleRoot, p2mrInput),
         );
         if (!newLeafsInTree || !oldLeafsInTree)
             throw new Error(`Invalid arguments for Psbt.${action}. Tapleaf not part of taptree.`);
     } else if (inputData.tapMerkleRoot) {
         const merkleRoot = new Uint8Array(inputData.tapMerkleRoot);
         const newLeafsInTree = (newInputData.tapLeafScript || []).every((l) =>
-            isTapLeafInTree(l, merkleRoot),
+            isTapLeafInTree(l, merkleRoot, p2mrInput),
         );
         if (!newLeafsInTree)
             throw new Error(`Invalid arguments for Psbt.${action}. Tapleaf not part of taptree.`);
@@ -345,12 +383,24 @@ function checkIfTapLeafInTree(inputData: PsbtInput, newInputData: PsbtInput, act
 }
 
 /**
- * Checks if a TapLeafScript is present in a Merkle tree.
- * @param tapLeaf The TapLeafScript to check.
- * @param merkleRoot The Merkle root of the tree. If not provided, the function assumes the TapLeafScript is present.
- * @returns A boolean indicating whether the TapLeafScript is present in the tree.
+ * Checks if a TapLeafScript is present in a Merkle tree by recomputing the root
+ * from the control block's merkle path.
+ *
+ * Handles both P2TR and P2MR control block formats:
+ * - P2TR: 33 + 32*m bytes (1 control byte + 32-byte internal pubkey + merkle path)
+ * - P2MR: 1 + 32*m bytes (1 control byte + merkle path, no internal pubkey)
+ *
+ * When `p2mr` is explicitly true, only the P2MR format is tried. When false and
+ * the input type is unknown (witnessUtxo not yet set), both formats are tried as
+ * their lengths overlap at 33, 65, 97... bytes. The merkle root is used to
+ * disambiguate which interpretation is correct.
+ *
+ * @param tapLeaf - The TapLeafScript to check (includes script, leafVersion, controlBlock).
+ * @param merkleRoot - The expected Merkle root. If not provided, returns true (no validation).
+ * @param p2mr - If true, use P2MR control block format exclusively.
+ * @returns True if the leaf's control block produces the expected merkle root.
  */
-function isTapLeafInTree(tapLeaf: TapLeafScript, merkleRoot?: Uint8Array): boolean {
+function isTapLeafInTree(tapLeaf: TapLeafScript, merkleRoot?: Uint8Array, p2mr = false): boolean {
     if (!merkleRoot) return true;
 
     const leafHash = tapleafHash({
@@ -358,8 +408,29 @@ function isTapLeafInTree(tapLeaf: TapLeafScript, merkleRoot?: Uint8Array): boole
         version: tapLeaf.leafVersion,
     });
 
-    const rootHash = rootHashFromPath(new Uint8Array(tapLeaf.controlBlock), leafHash);
-    return equals(rootHash, merkleRoot);
+    const controlBlock = new Uint8Array(tapLeaf.controlBlock);
+
+    if (p2mr) {
+        return equals(rootHashFromPathP2MR(controlBlock, leafHash), merkleRoot);
+    }
+
+    // When the input type isn't known yet (witnessUtxo not set), try P2TR first,
+    // then fall back to P2MR. Control block lengths overlap (33, 65, ...) between
+    // P2TR (33 + 32*m) and P2MR (1 + 32*m), so we verify against the merkle root.
+    const isValidP2TRLength = controlBlock.length >= 33 && (controlBlock.length - 33) % 32 === 0;
+    const isValidP2MRLength = controlBlock.length >= 1 && (controlBlock.length - 1) % 32 === 0;
+
+    if (isValidP2TRLength) {
+        const rootHash = rootHashFromPath(controlBlock, leafHash);
+        if (equals(rootHash, merkleRoot)) return true;
+    }
+
+    if (isValidP2MRLength) {
+        const rootHash = rootHashFromPathP2MR(controlBlock, leafHash);
+        if (equals(rootHash, merkleRoot)) return true;
+    }
+
+    return false;
 }
 
 /**

package/src/psbt/psbtutils.ts

@@ -5,6 +5,7 @@ import { p2ms } from '../payments/p2ms.js';
 import { p2pk } from '../payments/p2pk.js';
 import { p2pkh } from '../payments/p2pkh.js';
 import { p2sh } from '../payments/p2sh.js';
+import { p2mr } from '../payments/p2mr.js';
 import { p2tr } from '../payments/p2tr.js';
 import { p2wpkh } from '../payments/p2wpkh.js';
 import { p2wsh } from '../payments/p2wsh.js';
@@ -34,6 +35,7 @@ export const isP2WPKH = isPaymentFactory(p2wpkh);
 export const isP2WSHScript = isPaymentFactory(p2wsh);
 export const isP2SHScript = isPaymentFactory(p2sh);
 export const isP2TR = isPaymentFactory(p2tr);
+export const isP2MR = isPaymentFactory(p2mr);
 export const isP2OP = isPaymentFactory(p2op);
 export const isP2A = (script: Uint8Array): boolean => {
     return (

package/src/psbt.ts

@@ -17,6 +17,7 @@ import * as payments from './payments/index.js';
 import {
     checkTaprootInputFields,
     checkTaprootOutputFields,
+    isP2MRInput,
     isTaprootInput,
     serializeTaprootSignature,
     tapScriptFinalizer,
@@ -420,7 +421,7 @@ export class Psbt {
         if (hasAddress) {
             const { address } = outputData as PsbtOutputExtendedAddress;
             const { network } = this.#opts;
-            const script = toOutputScript(address, network) as Script;
+            const script = toOutputScript(address, network);
             outputData = Object.assign({}, outputData, { script });
         }
         checkTaprootOutputFields(outputData, outputData, 'addOutput');
@@ -921,7 +922,8 @@ export class Psbt {
         if (!input.witnessUtxo)
             throw new Error(`Cannot finalize input #${inputIndex}. Missing witness utxo.`);
 
-        if (input.tapKeySig) {
+        // P2MR has no key-path spend — always use script-path finalization
+        if (input.tapKeySig && !isP2MRInput(input)) {
             const payment = payments.p2tr({
                 output: input.witnessUtxo.script as Script,
                 signature: input.tapKeySig as SchnorrSignature,

package/src/pubkey.ts

@@ -55,7 +55,7 @@ export function decompressPublicKey(realPubKey: PublicKey): UncompressedPublicKe
     try {
         point = Point.fromHex(toHex(realPubKey));
     } catch (err) {
-        throw new Error('Invalid secp256k1 public key bytes. Cannot parse.');
+        throw new Error('Invalid secp256k1 public key bytes. Cannot parse.', { cause: err });
     }
 
     const xBuf = bigIntTo32Bytes(point.x);

package/test/bitcoin.core.spec.ts

@@ -1,5 +1,5 @@
 import assert from 'assert';
-import base58 from 'bs58';
+import { base58 } from '@scure/base';
 import { describe, it } from 'vitest';
 import * as bitcoin from '../src/index.js';
 import type { Bytes20, Satoshi, Script } from '../src/types.js';

package/test/fixtures/p2mr.json

@@ -0,0 +1,270 @@
+{
+    "valid": [
+        {
+            "description": "output and hash from address",
+            "arguments": {
+                "address": "bc1z4rf73uru6qdyrv9w3nq9f3dwqlqmec4sdwj03hexu7n7r7dkehjs592djq"
+            },
+            "options": {},
+            "expected": {
+                "name": "p2mr",
+                "hash": "a8d3e8f07cd01a41b0ae8cc054c5ae07c1bce2b06ba4f8df26e7a7e1f9b6cde5",
+                "output": "OP_2 a8d3e8f07cd01a41b0ae8cc054c5ae07c1bce2b06ba4f8df26e7a7e1f9b6cde5",
+                "input": null,
+                "witness": null
+            }
+        },
+        {
+            "description": "address and hash from output",
+            "arguments": {
+                "output": "OP_2 a8d3e8f07cd01a41b0ae8cc054c5ae07c1bce2b06ba4f8df26e7a7e1f9b6cde5"
+            },
+            "options": {},
+            "expected": {
+                "name": "p2mr",
+                "address": "bc1z4rf73uru6qdyrv9w3nq9f3dwqlqmec4sdwj03hexu7n7r7dkehjs592djq",
+                "hash": "a8d3e8f07cd01a41b0ae8cc054c5ae07c1bce2b06ba4f8df26e7a7e1f9b6cde5",
+                "input": null,
+                "witness": null
+            }
+        },
+        {
+            "description": "address and output from hash",
+            "arguments": {
+                "hash": "a8d3e8f07cd01a41b0ae8cc054c5ae07c1bce2b06ba4f8df26e7a7e1f9b6cde5"
+            },
+            "options": {},
+            "expected": {
+                "name": "p2mr",
+                "address": "bc1z4rf73uru6qdyrv9w3nq9f3dwqlqmec4sdwj03hexu7n7r7dkehjs592djq",
+                "output": "OP_2 a8d3e8f07cd01a41b0ae8cc054c5ae07c1bce2b06ba4f8df26e7a7e1f9b6cde5",
+                "input": null,
+                "witness": null
+            }
+        },
+        {
+            "description": "hash, output and address from single-leaf scriptTree",
+            "arguments": {
+                "scriptTree": {
+                    "output": "OP_1"
+                }
+            },
+            "options": {},
+            "expected": {
+                "name": "p2mr",
+                "hash": "a85b2107f791b26a84e7586c28cec7cb61202ed3d01944d832500f363782d675",
+                "output": "OP_2 a85b2107f791b26a84e7586c28cec7cb61202ed3d01944d832500f363782d675",
+                "address": "bc1z4pdjzplhjxex4p88tpkz3nk8edsjqtkn6qv5fkpj2q8nvduz6e6sy82nl4",
+                "input": null,
+                "witness": null
+            }
+        },
+        {
+            "description": "hash, address, output and witness from single-leaf scriptTree with redeem",
+            "arguments": {
+                "scriptTree": {
+                    "output": "OP_1"
+                },
+                "redeem": {
+                    "output": "OP_1"
+                }
+            },
+            "options": {},
+            "expected": {
+                "name": "p2mr",
+                "hash": "a85b2107f791b26a84e7586c28cec7cb61202ed3d01944d832500f363782d675",
+                "output": "OP_2 a85b2107f791b26a84e7586c28cec7cb61202ed3d01944d832500f363782d675",
+                "address": "bc1z4pdjzplhjxex4p88tpkz3nk8edsjqtkn6qv5fkpj2q8nvduz6e6sy82nl4",
+                "input": null,
+                "witness": [
+                    "51",
+                    "c1"
+                ]
+            }
+        },
+        {
+            "description": "hash, address, output from two-leaf scriptTree",
+            "arguments": {
+                "scriptTree": [
+                    {
+                        "output": "OP_1"
+                    },
+                    {
+                        "output": "OP_0 OP_1"
+                    }
+                ]
+            },
+            "options": {},
+            "expected": {
+                "name": "p2mr",
+                "hash": "9bc8cefc93017c588ec645d256d21f16897a33e3d107402dcb50868d6e5701a6",
+                "output": "OP_2 9bc8cefc93017c588ec645d256d21f16897a33e3d107402dcb50868d6e5701a6",
+                "address": "bc1zn0yvalynq9793rkxghf9d5slz6yh5vlr6yr5qtwt2zrg6mjhqxnq2qq9vy",
+                "input": null,
+                "witness": null
+            }
+        },
+        {
+            "description": "witness from two-leaf scriptTree spending second leaf",
+            "arguments": {
+                "scriptTree": [
+                    {
+                        "output": "OP_1"
+                    },
+                    {
+                        "output": "OP_0 OP_1"
+                    }
+                ],
+                "redeem": {
+                    "output": "OP_0 OP_1"
+                }
+            },
+            "options": {},
+            "expected": {
+                "name": "p2mr",
+                "hash": "9bc8cefc93017c588ec645d256d21f16897a33e3d107402dcb50868d6e5701a6",
+                "output": "OP_2 9bc8cefc93017c588ec645d256d21f16897a33e3d107402dcb50868d6e5701a6",
+                "address": "bc1zn0yvalynq9793rkxghf9d5slz6yh5vlr6yr5qtwt2zrg6mjhqxnq2qq9vy",
+                "input": null,
+                "witness": [
+                    "0051",
+                    "c1a85b2107f791b26a84e7586c28cec7cb61202ed3d01944d832500f363782d675"
+                ]
+            }
+        },
+        {
+            "description": "hash, output and address from witness (script-path spend)",
+            "arguments": {
+                "witness": [
+                    "0051",
+                    "c1a85b2107f791b26a84e7586c28cec7cb61202ed3d01944d832500f363782d675"
+                ]
+            },
+            "options": {},
+            "expected": {
+                "name": "p2mr",
+                "hash": "9bc8cefc93017c588ec645d256d21f16897a33e3d107402dcb50868d6e5701a6",
+                "output": "OP_2 9bc8cefc93017c588ec645d256d21f16897a33e3d107402dcb50868d6e5701a6",
+                "address": "bc1zn0yvalynq9793rkxghf9d5slz6yh5vlr6yr5qtwt2zrg6mjhqxnq2qq9vy",
+                "input": null
+            }
+        },
+        {
+            "description": "three-leaf tree spending leaf C",
+            "arguments": {
+                "scriptTree": [
+                    [
+                        {
+                            "output": "OP_1"
+                        },
+                        {
+                            "output": "OP_0 OP_1"
+                        }
+                    ],
+                    {
+                        "output": "OP_2 OP_ADD"
+                    }
+                ],
+                "redeem": {
+                    "output": "OP_2 OP_ADD"
+                }
+            },
+            "options": {},
+            "expected": {
+                "name": "p2mr",
+                "hash": "51308a6978377038d26b9a24a9fd36dca763006b667b7ac7d33a3de513ed19ac",
+                "output": "OP_2 51308a6978377038d26b9a24a9fd36dca763006b667b7ac7d33a3de513ed19ac",
+                "address": "bc1z2ycg56tcxacr35ntngj2nlfkmjnkxqrtveah437n8g772yldrxkq3620s4",
+                "input": null,
+                "witness": [
+                    "5293",
+                    "c19bc8cefc93017c588ec645d256d21f16897a33e3d107402dcb50868d6e5701a6"
+                ]
+            }
+        },
+        {
+            "description": "three-leaf tree spending leaf A (deeper path)",
+            "arguments": {
+                "scriptTree": [
+                    [
+                        {
+                            "output": "OP_1"
+                        },
+                        {
+                            "output": "OP_0 OP_1"
+                        }
+                    ],
+                    {
+                        "output": "OP_2 OP_ADD"
+                    }
+                ],
+                "redeem": {
+                    "output": "OP_1"
+                }
+            },
+            "options": {},
+            "expected": {
+                "name": "p2mr",
+                "hash": "51308a6978377038d26b9a24a9fd36dca763006b667b7ac7d33a3de513ed19ac",
+                "output": "OP_2 51308a6978377038d26b9a24a9fd36dca763006b667b7ac7d33a3de513ed19ac",
+                "address": "bc1z2ycg56tcxacr35ntngj2nlfkmjnkxqrtveah437n8g772yldrxkq3620s4",
+                "input": null,
+                "witness": [
+                    "51",
+                    "c16a44dcd1309c36cb52f2cd8797d947b9b06dddf666fb9b8c6e8d8fb0bc41cd1b3173603d1ef3328ba80b0ba7d35aba099b2f96674473d80cab75944befa3daec"
+                ]
+            }
+        },
+        {
+            "description": "single leaf with non-default version (0xfa)",
+            "arguments": {
+                "scriptTree": {
+                    "output": "OP_1",
+                    "version": 250
+                },
+                "redeem": {
+                    "output": "OP_1"
+                },
+                "redeemVersion": 250
+            },
+            "options": {},
+            "expected": {
+                "name": "p2mr",
+                "hash": "eb0c727d7160a3e717c3ec0cb3e7a2da50e62926a04f2f369eadb91c0f7fd825",
+                "output": "OP_2 eb0c727d7160a3e717c3ec0cb3e7a2da50e62926a04f2f369eadb91c0f7fd825",
+                "address": "bc1zavx8ylt3vz37w97rasxt8eazmfgwv2fx5p8j7d574ku3crmlmqjsgtmlz6",
+                "input": null,
+                "redeemVersion": 250,
+                "witness": [
+                    "51",
+                    "fb"
+                ]
+            }
+        }
+    ],
+    "invalid": [],
+    "dynamic": {
+        "depends": {
+            "output": [
+                "hash",
+                "address"
+            ],
+            "address": [
+                "hash",
+                "output"
+            ],
+            "hash": [
+                "output",
+                "address"
+            ]
+        },
+        "details": [
+            {
+                "description": "p2mr round-trip",
+                "hash": "a8d3e8f07cd01a41b0ae8cc054c5ae07c1bce2b06ba4f8df26e7a7e1f9b6cde5",
+                "output": "OP_2 a8d3e8f07cd01a41b0ae8cc054c5ae07c1bce2b06ba4f8df26e7a7e1f9b6cde5",
+                "address": "bc1z4rf73uru6qdyrv9w3nq9f3dwqlqmec4sdwj03hexu7n7r7dkehjs592djq"
+            }
+        ]
+    }
+}

package/test/integration/taproot.spec.ts

@@ -423,10 +423,12 @@ describe('bitcoinjs-lib (transaction with taproot)', () => {
             await regtestUtils.broadcast(hex);
             throw new Error('Broadcast should fail.');
         } catch (err) {
-            if ((err as any).message !== 'non-BIP68-final')
+            if ((err as Error).message !== 'non-BIP68-final') {
                 throw new Error(
-                    'Expected OP_CHECKSEQUENCEVERIFY validation to fail. But it faild with: ' + err,
+                    `Expected OP_CHECKSEQUENCEVERIFY validation to fail. But it faild with: ${err}`,
+                    { cause: err },
                 );
+            }
         }
         await regtestUtils.mine(10);
         await regtestUtils.broadcast(hex);
@@ -672,7 +674,9 @@ function buildLeafIndexFinalizer(
             ];
             return { finalScriptWitness: witnessStackToScriptWitness(witness) };
         } catch (err) {
-            throw new Error(`Can not finalize taproot input #${inputIndex}: ${err}`);
+            throw new Error(`Can not finalize taproot input #${inputIndex}: ${err}`, {
+                cause: err,
+            });
         }
     };
 }