@bitcoinerlab/descriptors 3.0.6 → 3.1.0

package/dist/applyPR2137.js

@@ -1,153 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.applyPR2137 = void 0;
-//While this PR is not merged: https://github.com/bitcoinjs/bitcoinjs-lib/pull/2137
-//The Async functions have not been "fixed"
-//Note that a further fix (look for FIX BITCOINERLAB) was done
-const bitcoinjs_lib_1 = require("bitcoinjs-lib");
-const bip174_1 = require("bip174");
-const bitcoinjs_lib_internals_1 = require("./bitcoinjs-lib-internals");
-const uint8array_tools_1 = require("uint8array-tools");
-const toXOnly = (pubKey) => pubKey.length === 32 ? pubKey : pubKey.slice(1, 33);
-function range(n) {
-    return [...Array(n).keys()];
-}
-function tapBranchHash(a, b) {
-    return bitcoinjs_lib_1.crypto.taggedHash('TapBranch', (0, uint8array_tools_1.concat)([a, b]));
-}
-function calculateScriptTreeMerkleRoot(leafHashes) {
-    if (!leafHashes || leafHashes.length === 0) {
-        return undefined;
-    }
-    const leafHashCopies = leafHashes.map(leafHash => Uint8Array.from(leafHash));
-    // sort the leaf nodes
-    leafHashCopies.sort(uint8array_tools_1.compare);
-    // create the initial hash node
-    let currentLevel = leafHashCopies;
-    // build Merkle Tree
-    while (currentLevel.length > 1) {
-        const nextLevel = [];
-        for (let i = 0; i < currentLevel.length; i += 2) {
-            const left = currentLevel[i];
-            if (!left)
-                throw new Error('Invalid tapleaf hash tree level');
-            const right = i + 1 < currentLevel.length ? (currentLevel[i + 1] ?? left) : left;
-            nextLevel.push(i + 1 < currentLevel.length ? tapBranchHash(left, right) : left);
-        }
-        currentLevel = nextLevel;
-    }
-    return currentLevel[0];
-}
-function getTweakSignersFromHD(inputIndex, inputs, hdKeyPair) {
-    const input = (0, bip174_1.checkForInput)(inputs, inputIndex);
-    if (!input.tapBip32Derivation || input.tapBip32Derivation.length === 0) {
-        throw new Error('Need tapBip32Derivation to sign with HD');
-    }
-    const myDerivations = input.tapBip32Derivation
-        .map(bipDv => {
-        if ((0, uint8array_tools_1.compare)(bipDv.masterFingerprint, hdKeyPair.fingerprint) === 0) {
-            return bipDv;
-        }
-        else {
-            return;
-        }
-    })
-        .filter(v => !!v);
-    if (myDerivations.length === 0) {
-        throw new Error('Need one tapBip32Derivation masterFingerprint to match the HDSigner fingerprint');
-    }
-    const signers = myDerivations.map(bipDv => {
-        const node = hdKeyPair.derivePath(bipDv.path);
-        if ((0, uint8array_tools_1.compare)(bipDv.pubkey, toXOnly(node.publicKey)) !== 0) {
-            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, bitcoinjs_lib_internals_1.tapTweakHash)(toXOnly(node.publicKey), h);
-        return node.tweak(tweakValue);
-    });
-    return signers;
-}
-function getSignersFromHD(inputIndex, inputs, hdKeyPair) {
-    const input = (0, bip174_1.checkForInput)(inputs, inputIndex);
-    if ((0, bitcoinjs_lib_internals_1.isTaprootInput)(input)) {
-        return getTweakSignersFromHD(inputIndex, inputs, hdKeyPair);
-    }
-    if (!input.bip32Derivation || input.bip32Derivation.length === 0) {
-        throw new Error('Need bip32Derivation to sign with HD');
-    }
-    const myDerivations = input.bip32Derivation
-        .map(bipDv => {
-        if ((0, uint8array_tools_1.compare)(bipDv.masterFingerprint, hdKeyPair.fingerprint) === 0) {
-            return bipDv;
-        }
-        else {
-            return;
-        }
-    })
-        .filter(v => !!v);
-    if (myDerivations.length === 0) {
-        throw new Error('Need one bip32Derivation masterFingerprint to match the HDSigner fingerprint');
-    }
-    const signers = myDerivations.map(bipDv => {
-        const node = hdKeyPair.derivePath(bipDv.path);
-        if ((0, uint8array_tools_1.compare)(bipDv.pubkey, node.publicKey) !== 0) {
-            throw new Error('pubkey did not match bip32Derivation');
-        }
-        return node;
-    });
-    return signers;
-}
-const applyPR2137 = (psbt) => {
-    psbt.signInputHD = function signInputHD(inputIndex, hdKeyPair, sighashTypes) {
-        if (!hdKeyPair || !hdKeyPair.publicKey || !hdKeyPair.fingerprint) {
-            throw new Error('Need HDSigner to sign input');
-        }
-        const signers = getSignersFromHD(inputIndex, this.data.inputs, hdKeyPair);
-        const results = [];
-        for (const signer of signers) {
-            try {
-                this.signInput(inputIndex, signer, sighashTypes);
-                results.push(true);
-            }
-            catch (err) {
-                void err;
-                results.push(false);
-            }
-        }
-        if (results.every(v => v === false)) {
-            throw new Error('No inputs were signed');
-        }
-        return this;
-    };
-    psbt.signAllInputsHD = function signAllInputsHD(hdKeyPair, sighashTypes) {
-        if (!hdKeyPair || !hdKeyPair.publicKey || !hdKeyPair.fingerprint) {
-            throw new Error('Need HDSigner to sign input');
-        }
-        const results = [];
-        for (const i of range(psbt.data.inputs.length)) {
-            try {
-                psbt.signInputHD(i, hdKeyPair, sighashTypes);
-                results.push(true);
-            }
-            catch (err) {
-                void err;
-                results.push(false);
-            }
-        }
-        if (results.every(v => v === false)) {
-            throw new Error('No inputs were signed');
-        }
-        return psbt;
-    };
-};
-exports.applyPR2137 = applyPR2137;

package/dist/bitcoinjs-lib-internals.d.ts

@@ -1,10 +0,0 @@
-import type { PsbtInput } from 'bip174';
-type Tapleaf = {
-    output: Uint8Array;
-    version?: number;
-};
-export declare function tapleafHash(leaf: Tapleaf): Uint8Array;
-export declare function tapTweakHash(pubKey: Uint8Array, h?: Uint8Array): Uint8Array;
-export declare function witnessStackToScriptWitness(witness: Uint8Array[]): Uint8Array;
-export declare function isTaprootInput(input: PsbtInput | undefined): boolean;
-export {};

package/dist/bitcoinjs-lib-internals.js

@@ -1,60 +0,0 @@
-"use strict";
-/*
- * Reimplements a small subset of bitcoinjs-lib internal helpers.
- * Keep this module free of deep imports (for example `bitcoinjs-lib/src/*`)
- * so it works consistently across Node.js, browser bundlers (including
- * CodeSandbox), and React Native/Metro.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.tapleafHash = tapleafHash;
-exports.tapTweakHash = tapTweakHash;
-exports.witnessStackToScriptWitness = witnessStackToScriptWitness;
-exports.isTaprootInput = isTaprootInput;
-const bitcoinjs_lib_1 = require("bitcoinjs-lib");
-const varuint_bitcoin_1 = require("varuint-bitcoin");
-const uint8array_tools_1 = require("uint8array-tools");
-const TAPROOT_LEAF_VERSION_TAPSCRIPT = 0xc0;
-const OP_1 = 0x51;
-const PUSH_DATA_32 = 0x20;
-function serializeScript(script) {
-    const { buffer: encodedLength } = (0, varuint_bitcoin_1.encode)(script.length);
-    return (0, uint8array_tools_1.concat)([encodedLength, script]);
-}
-function isP2TRScript(script) {
-    return (script instanceof Uint8Array &&
-        script.length === 34 &&
-        script[0] === OP_1 &&
-        script[1] === PUSH_DATA_32);
-}
-function tapleafHash(leaf) {
-    const version = leaf.version || TAPROOT_LEAF_VERSION_TAPSCRIPT;
-    return bitcoinjs_lib_1.crypto.taggedHash('TapLeaf', (0, uint8array_tools_1.concat)([Uint8Array.from([version]), serializeScript(leaf.output)]));
-}
-function tapTweakHash(pubKey, h) {
-    return bitcoinjs_lib_1.crypto.taggedHash('TapTweak', (0, uint8array_tools_1.concat)(h ? [pubKey, h] : [pubKey]));
-}
-function witnessStackToScriptWitness(witness) {
-    let buffer = new Uint8Array(0);
-    const writeSlice = (slice) => {
-        buffer = (0, uint8array_tools_1.concat)([buffer, slice]);
-    };
-    const writeVarInt = (value) => {
-        const { buffer: encoded } = (0, varuint_bitcoin_1.encode)(value);
-        writeSlice(encoded);
-    };
-    const writeVarSlice = (slice) => {
-        writeVarInt(slice.length);
-        writeSlice(slice);
-    };
-    writeVarInt(witness.length);
-    witness.forEach(writeVarSlice);
-    return buffer;
-}
-function isTaprootInput(input) {
-    return (!!input &&
-        !!(input.tapInternalKey ||
-            input.tapMerkleRoot ||
-            (input.tapLeafScript && input.tapLeafScript.length > 0) ||
-            (input.tapBip32Derivation && input.tapBip32Derivation.length > 0) ||
-            isP2TRScript(input.witnessUtxo?.script)));
-}

package/dist/checksum.d.ts

@@ -1,6 +0,0 @@
-export declare const CHECKSUM_CHARSET: string;
-/**
- * Implements the Bitcoin descriptor's checksum algorithm described in
- * {@link https://github.com/bitcoin/bitcoin/blob/master/src/script/descriptor.cpp}
- */
-export declare const DescriptorChecksum: (span: string) => string;

package/dist/checksum.js

@@ -1,58 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DescriptorChecksum = exports.CHECKSUM_CHARSET = void 0;
-// Converted to Javascript by Jose-Luis Landabaso, 2023 - https://bitcoinerlab.com
-// Source: https://github.com/bitcoin/bitcoin/blob/master/src/script/descriptor.cpp
-// Distributed under the MIT software license
-const PolyMod = (c, val) => {
-    const c0 = c >> 35n;
-    c = ((c & 0x7ffffffffn) << 5n) ^ val;
-    if (c0 & 1n)
-        c ^= 0xf5dee51989n;
-    if (c0 & 2n)
-        c ^= 0xa9fdca3312n;
-    if (c0 & 4n)
-        c ^= 0x1bab10e32dn;
-    if (c0 & 8n)
-        c ^= 0x3706b1677an;
-    if (c0 & 16n)
-        c ^= 0x644d626ffdn;
-    return c;
-};
-exports.CHECKSUM_CHARSET = 'qpzry9x8gf2tvdw0s3jn54khce6mua7l';
-/**
- * Implements the Bitcoin descriptor's checksum algorithm described in
- * {@link https://github.com/bitcoin/bitcoin/blob/master/src/script/descriptor.cpp}
- */
-const DescriptorChecksum = (span) => {
-    const INPUT_CHARSET = '0123456789()[],\'/*abcdefgh@:$%{}IJKLMNOPQRSTUVWXYZ&+-.;<=>?!^_|~ijklmnopqrstuvwxyzABCDEFGH`#"\\ ';
-    let c = 1n;
-    let cls = 0n;
-    let clscount = 0n;
-    for (const ch of span) {
-        const pos = BigInt(INPUT_CHARSET.indexOf(ch));
-        if (pos === -1n)
-            return '';
-        c = PolyMod(c, pos & 31n);
-        cls = cls * 3n + (pos >> 5n);
-        if (++clscount === 3n) {
-            c = PolyMod(c, cls);
-            cls = 0n;
-            clscount = 0n;
-        }
-    }
-    if (clscount > 0n)
-        c = PolyMod(c, cls);
-    for (let j = 0; j < 8; ++j)
-        c = PolyMod(c, 0n);
-    c ^= 1n;
-    let ret = '';
-    for (let j = 0; j < 8; ++j) {
-        const index = (c >> (5n * (7n - BigInt(j)))) & 31n;
-        if (index < 0 || index > Number.MAX_SAFE_INTEGER)
-            throw new Error(`Error: could not compute checksum, invalid index ${index}`);
-        ret += exports.CHECKSUM_CHARSET[Number(index)];
-    }
-    return ret;
-};
-exports.DescriptorChecksum = DescriptorChecksum;