@bitcoinerlab/descriptors 2.3.4 → 2.3.6

package/dist/applyPR2137.js

@@ -55,6 +55,16 @@ function getTweakSignersFromHD(inputIndex, inputs, hdKeyPair) {
         if (!bipDv.pubkey.equals(toXOnly(node.publicKey))) {
             throw new Error('pubkey did not match tapBip32Derivation');
         }
+        //FIX BITCOINERLAB:
+        //The 3 lines below detect script-path spends and disable key-path tweaking.
+        //Reasoning:
+        //- In Taproot, key-path spends require tweaking the internal key.
+        //- Script-path spends MUST NOT tweak the key; signatures use the raw internal key.
+        const input = inputs[inputIndex];
+        if (!input)
+            throw new Error('could not find the input');
+        if (input.tapLeafScript && input.tapLeafScript.length > 0)
+            return node;
         const h = calculateScriptTreeMerkleRoot(bipDv.leafHashes);
         const tweakValue = (0, bip341_1.tapTweakHash)(toXOnly(node.publicKey), h);
         return node.tweak(tweakValue);

package/dist/descriptors.js

@@ -132,6 +132,22 @@ function evaluate({ descriptor, checksumRequired, index }) {
     }
     return evaluatedDescriptor;
 }
+// Helper: parse sortedmulti(M, k1, k2,...)
+function parseSortedMulti(inner) {
+    // inner: "2,key1,key2,key3"
+    const parts = inner.split(',').map(p => p.trim());
+    if (parts.length < 2)
+        throw new Error(`sortedmulti(): must contain M and at least one key: ${inner}`);
+    const m = Number(parts[0]);
+    if (!Number.isInteger(m) || m < 1 || m > 20)
+        throw new Error(`sortedmulti(): invalid M=${parts[0]}`);
+    const keyExpressions = parts.slice(1);
+    if (keyExpressions.length < m)
+        throw new Error(`sortedmulti(): M cannot exceed number of keys: ${inner}`);
+    if (keyExpressions.length > 20)
+        throw new Error(`sortedmulti(): descriptors support up to 20 keys (per BIP 380/383).`);
+    return { m, keyExpressions };
+}
 /**
  * Constructs the necessary functions and classes for working with descriptors
  * using an external elliptic curve (ecc) library.
@@ -359,6 +375,97 @@ function DescriptorsFactory(ecc) {
                 payment = p2wpkh({ pubkey, network });
             }
         }
+        // sortedmulti script expressions
+        // sh(sortedmulti())
+        else if (canonicalExpression.match(RE.reShSortedMultiAnchored)) {
+            isSegwit = false;
+            isTaproot = false;
+            const inner = canonicalExpression.match(RE.reShSortedMultiAnchored)?.[1];
+            if (!inner)
+                throw new Error(`Error extracting sortedmulti() in ${descriptor}`);
+            const { m, keyExpressions } = parseSortedMulti(inner);
+            const pKEs = keyExpressions.map(k => parseKeyExpression({ keyExpression: k, network, isSegwit: false }));
+            const map = {};
+            pKEs.forEach((pke, i) => (map['@' + i] = pke));
+            expansionMap = map;
+            expandedExpression =
+                'sh(sortedmulti(' +
+                    [m, ...Object.keys(expansionMap).map(k => k)].join(',') +
+                    '))';
+            if (!isCanonicalRanged) {
+                const pubkeys = pKEs.map(p => {
+                    if (!p.pubkey)
+                        throw new Error(`Error: key has no pubkey`);
+                    return p.pubkey;
+                });
+                pubkeys.sort((a, b) => a.compare(b));
+                const redeem = bitcoinjs_lib_1.payments.p2ms({ m, pubkeys, network });
+                redeemScript = redeem.output;
+                if (!redeemScript)
+                    throw new Error(`Error creating redeemScript`);
+                payment = bitcoinjs_lib_1.payments.p2sh({ redeem, network });
+            }
+        }
+        // wsh(sortedmulti())
+        else if (canonicalExpression.match(RE.reWshSortedMultiAnchored)) {
+            isSegwit = true;
+            isTaproot = false;
+            const inner = canonicalExpression.match(RE.reWshSortedMultiAnchored)?.[1];
+            if (!inner)
+                throw new Error(`Error extracting sortedmulti() in ${descriptor}`);
+            const { m, keyExpressions } = parseSortedMulti(inner);
+            const pKEs = keyExpressions.map(k => parseKeyExpression({ keyExpression: k, network, isSegwit: true }));
+            const map = {};
+            pKEs.forEach((pke, i) => (map['@' + i] = pke));
+            expansionMap = map;
+            expandedExpression =
+                'wsh(sortedmulti(' +
+                    [m, ...Object.keys(expansionMap).map(k => k)].join(',') +
+                    '))';
+            if (!isCanonicalRanged) {
+                const pubkeys = pKEs.map(p => {
+                    if (!p.pubkey)
+                        throw new Error(`Error: key has no pubkey`);
+                    return p.pubkey;
+                });
+                pubkeys.sort((a, b) => a.compare(b));
+                const redeem = bitcoinjs_lib_1.payments.p2ms({ m, pubkeys, network });
+                witnessScript = redeem.output;
+                if (!witnessScript)
+                    throw new Error(`Error computing witnessScript`);
+                payment = bitcoinjs_lib_1.payments.p2wsh({ redeem, network });
+            }
+        }
+        // sh(wsh(sortedmulti()))
+        else if (canonicalExpression.match(RE.reShWshSortedMultiAnchored)) {
+            isSegwit = true;
+            isTaproot = false;
+            const inner = canonicalExpression.match(RE.reShWshSortedMultiAnchored)?.[1];
+            if (!inner)
+                throw new Error(`Error extracting sortedmulti() in ${descriptor}`);
+            const { m, keyExpressions } = parseSortedMulti(inner);
+            const pKEs = keyExpressions.map(k => parseKeyExpression({ keyExpression: k, network, isSegwit: true }));
+            const map = {};
+            pKEs.forEach((pke, i) => (map['@' + i] = pke));
+            expansionMap = map;
+            expandedExpression =
+                'sh(wsh(sortedmulti(' +
+                    [m, ...Object.keys(expansionMap).map(k => k)].join(',') +
+                    ')))';
+            if (!isCanonicalRanged) {
+                const pubkeys = pKEs.map(p => {
+                    if (!p.pubkey)
+                        throw new Error(`Error: key has no pubkey`);
+                    return p.pubkey;
+                });
+                pubkeys.sort((a, b) => a.compare(b));
+                const redeem = bitcoinjs_lib_1.payments.p2ms({ m, pubkeys, network });
+                const wsh = bitcoinjs_lib_1.payments.p2wsh({ redeem, network });
+                witnessScript = redeem.output;
+                redeemScript = wsh.output;
+                payment = bitcoinjs_lib_1.payments.p2sh({ redeem: wsh, network });
+            }
+        }
         //sh(wsh(miniscript))
         else if (canonicalExpression.match(RE.reShWshMiniscriptAnchored)) {
             isSegwit = true;

package/dist/re.d.ts

@@ -14,6 +14,8 @@ export declare const reXprvKey: string;
 export declare const reNonSegwitKeyExp: string;
 export declare const reSegwitKeyExp: string;
 export declare const reTaprootKeyExp: string;
+export declare const reNonSegwitSortedMulti: string;
+export declare const reSegwitSortedMulti: string;
 export declare const anchorStartAndEnd: (re: string) => string;
 export declare const rePkAnchored: string;
 export declare const reAddrAnchored: string;
@@ -21,6 +23,9 @@ export declare const rePkhAnchored: string;
 export declare const reWpkhAnchored: string;
 export declare const reShWpkhAnchored: string;
 export declare const reTrSingleKeyAnchored: string;
+export declare const reShSortedMultiAnchored: string;
+export declare const reWshSortedMultiAnchored: string;
+export declare const reShWshSortedMultiAnchored: string;
 export declare const reShMiniscriptAnchored: string;
 export declare const reShWshMiniscriptAnchored: string;
 export declare const reWshMiniscriptAnchored: string;

package/dist/re.js

@@ -2,7 +2,7 @@
 // Copyright (c) 2025 Jose-Luis Landabaso - https://bitcoinerlab.com
 // Distributed under the MIT software license
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.reWshMiniscriptAnchored = exports.reShWshMiniscriptAnchored = exports.reShMiniscriptAnchored = exports.reTrSingleKeyAnchored = exports.reShWpkhAnchored = exports.reWpkhAnchored = exports.rePkhAnchored = exports.reAddrAnchored = exports.rePkAnchored = exports.anchorStartAndEnd = exports.reTaprootKeyExp = exports.reSegwitKeyExp = exports.reNonSegwitKeyExp = exports.reXprvKey = exports.reXpubKey = exports.rePath = exports.reXprv = exports.reXpub = exports.reWIF = exports.reTaprootPubKey = exports.reSegwitPubKey = exports.reNonSegwitPubKey = exports.reChecksum = exports.reOrigin = exports.reMasterFingerprint = exports.reOriginPath = void 0;
+exports.reWshMiniscriptAnchored = exports.reShWshMiniscriptAnchored = exports.reShMiniscriptAnchored = exports.reShWshSortedMultiAnchored = exports.reWshSortedMultiAnchored = exports.reShSortedMultiAnchored = exports.reTrSingleKeyAnchored = exports.reShWpkhAnchored = exports.reWpkhAnchored = exports.rePkhAnchored = exports.reAddrAnchored = exports.rePkAnchored = exports.anchorStartAndEnd = exports.reSegwitSortedMulti = exports.reNonSegwitSortedMulti = exports.reTaprootKeyExp = exports.reSegwitKeyExp = exports.reNonSegwitKeyExp = exports.reXprvKey = exports.reXpubKey = exports.rePath = exports.reXprv = exports.reXpub = exports.reWIF = exports.reTaprootPubKey = exports.reSegwitPubKey = exports.reNonSegwitPubKey = exports.reChecksum = exports.reOrigin = exports.reMasterFingerprint = exports.reOriginPath = void 0;
 const checksum_1 = require("./checksum");
 //Regular expressions cheat sheet:
 //https://www.keycdn.com/support/regex-cheat-sheet
@@ -55,6 +55,8 @@ const rePkh = String.raw `pkh\(${exports.reNonSegwitKeyExp}\)`;
 const reWpkh = String.raw `wpkh\(${exports.reSegwitKeyExp}\)`;
 const reShWpkh = String.raw `sh\(wpkh\(${exports.reSegwitKeyExp}\)\)`;
 const reTrSingleKey = String.raw `tr\(${exports.reTaprootKeyExp}\)`; // TODO: tr(KEY,TREE) not yet supported. TrSingleKey used for tr(KEY)
+exports.reNonSegwitSortedMulti = String.raw `sortedmulti\(((?:1|2|3|4|5|6|7|8|9|10|11|12|13|14|15|16|17|18|19|20)(?:,${exports.reNonSegwitKeyExp})+)\)`;
+exports.reSegwitSortedMulti = String.raw `sortedmulti\(((?:1|2|3|4|5|6|7|8|9|10|11|12|13|14|15|16|17|18|19|20)(?:,${exports.reSegwitKeyExp})+)\)`;
 const reMiniscript = String.raw `(.*?)`; //Matches anything. We assert later in the code that miniscripts are valid and sane.
 //RegExp makers:
 const makeReSh = (re) => String.raw `sh\(${re}\)`;
@@ -69,6 +71,9 @@ exports.rePkhAnchored = (0, exports.anchorStartAndEnd)(composeChecksum(rePkh));
 exports.reWpkhAnchored = (0, exports.anchorStartAndEnd)(composeChecksum(reWpkh));
 exports.reShWpkhAnchored = (0, exports.anchorStartAndEnd)(composeChecksum(reShWpkh));
 exports.reTrSingleKeyAnchored = (0, exports.anchorStartAndEnd)(composeChecksum(reTrSingleKey));
+exports.reShSortedMultiAnchored = (0, exports.anchorStartAndEnd)(composeChecksum(makeReSh(exports.reNonSegwitSortedMulti)));
+exports.reWshSortedMultiAnchored = (0, exports.anchorStartAndEnd)(composeChecksum(makeReWsh(exports.reSegwitSortedMulti)));
+exports.reShWshSortedMultiAnchored = (0, exports.anchorStartAndEnd)(composeChecksum(makeReShWsh(exports.reSegwitSortedMulti)));
 exports.reShMiniscriptAnchored = (0, exports.anchorStartAndEnd)(composeChecksum(makeReSh(reMiniscript)));
 exports.reShWshMiniscriptAnchored = (0, exports.anchorStartAndEnd)(composeChecksum(makeReShWsh(reMiniscript)));
 exports.reWshMiniscriptAnchored = (0, exports.anchorStartAndEnd)(composeChecksum(makeReWsh(reMiniscript)));

package/dist/signers.js

@@ -34,15 +34,20 @@ function range(n) {
  */
 function signInputECPair({ psbt, index, ecpair }) {
     //psbt.signInput(index, ecpair); <- Replaced for the code below
-    //that can handle taroot inputs automatically.
+    //that can handle taproot inputs automatically.
     //See https://github.com/bitcoinjs/bitcoinjs-lib/pull/2137#issuecomment-2713264848
     const input = psbt.data.inputs[index];
     if (!input)
         throw new Error('Invalid index');
     if ((0, bip371_1.isTaprootInput)(input)) {
-        const hash = (0, bip341_1.tapTweakHash)(Buffer.from(ecpair.publicKey.slice(1, 33)), undefined);
-        const tweakedEcpair = ecpair.tweak(hash);
-        psbt.signInput(index, tweakedEcpair);
+        // If script-path (tapLeafScript present) -> DO NOT TWEAK
+        if (input.tapLeafScript && input.tapLeafScript.length > 0)
+            psbt.signInput(index, ecpair);
+        else {
+            const hash = (0, bip341_1.tapTweakHash)(Buffer.from(ecpair.publicKey.slice(1, 33)), undefined);
+            const tweakedEcpair = ecpair.tweak(hash);
+            psbt.signInput(index, tweakedEcpair);
+        }
     }
     else
         psbt.signInput(index, ecpair);

package/package.json

@@ -2,7 +2,7 @@
   "name": "@bitcoinerlab/descriptors",
   "description": "This library parses and creates Bitcoin Miniscript Descriptors and generates Partially Signed Bitcoin Transactions (PSBTs). It provides PSBT finalizers and signers for single-signature, BIP32 and Hardware Wallets.",
   "homepage": "https://github.com/bitcoinerlab/descriptors",
-  "version": "2.3.4",
+  "version": "2.3.6",
   "author": "Jose-Luis Landabaso",
   "license": "MIT",
   "repository": {
@@ -36,13 +36,13 @@
     "build": "npm run build:src && npm run build:test",
     "lint": "./node_modules/@bitcoinerlab/configs/scripts/lint.sh",
     "ensureTester": "./node_modules/@bitcoinerlab/configs/scripts/ensureTester.sh",
-    "test:integration:soft": "npm run ensureTester && node test/integration/standardOutputs.js && echo \"\\n\\n\" && node test/integration/miniscript.js",
+    "test:integration:soft": "npm run ensureTester && node test/integration/standardOutputs.js && echo \"\n\n\" && node test/integration/miniscript.js && echo \"\n\n\" && node test/integration/sortedmulti.js",
     "test:integration:ledger": "npm run ensureTester && node test/integration/ledger.js",
-    "test:integration:deprecated": "npm run ensureTester && node test/integration/standardOutputs-deprecated.js && echo \"\\n\\n\" && node test/integration/miniscript-deprecated.js && echo \"\\n\\n\" && node test/integration/ledger-deprecated.js",
+    "test:integration:deprecated": "npm run ensureTester && node test/integration/standardOutputs-deprecated.js && echo \"\n\n\" && node test/integration/miniscript-deprecated.js && echo \"\n\n\" && node test/integration/ledger-deprecated.js",
     "test:unit": "jest",
     "test": "npm run lint && npm run build && npm run test:unit && npm run test:integration:soft",
     "testledger": "npm run lint && npm run build && npm run test:integration:ledger",
-    "prepublishOnly": "npm run test && echo \"\\n\\n\" && npm run test:integration:deprecated && npm run test:integration:ledger"
+    "prepublishOnly": "npm run test && echo \"\n\n\" && npm run test:integration:deprecated && npm run test:integration:ledger"
   },
   "files": [
     "dist"