@btc-vision/bitcoin 6.3.0

package/src/payments/p2wsh.d.ts

@@ -0,0 +1,10 @@
+import { Payment, PaymentOpts } from './index';
+/**
+ * Creates a Pay-to-Witness-Script-Hash (P2WSH) payment object.
+ *
+ * @param a - The payment object containing the necessary data.
+ * @param opts - Optional payment options.
+ * @returns The P2WSH payment object.
+ * @throws {TypeError} If the required data is missing or invalid.
+ */
+export declare function p2wsh(a: Payment, opts?: PaymentOpts): Payment;

package/src/payments/p2wsh.js

@@ -0,0 +1,226 @@
+'use strict';
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.p2wsh = void 0;
+const bcrypto = require('../crypto');
+const networks_1 = require('../networks');
+const bscript = require('../script');
+const types_1 = require('../types');
+const lazy = require('./lazy');
+const bech32_1 = require('bech32');
+const OPS = bscript.OPS;
+const EMPTY_BUFFER = Buffer.alloc(0);
+function chunkHasUncompressedPubkey(chunk) {
+    if (
+        Buffer.isBuffer(chunk) &&
+        chunk.length === 65 &&
+        chunk[0] === 0x04 &&
+        (0, types_1.isPoint)(chunk)
+    ) {
+        return true;
+    } else {
+        return false;
+    }
+}
+// input: <>
+// witness: [redeemScriptSig ...] {redeemScript}
+// output: OP_0 {sha256(redeemScript)}
+/**
+ * Creates a Pay-to-Witness-Script-Hash (P2WSH) payment object.
+ *
+ * @param a - The payment object containing the necessary data.
+ * @param opts - Optional payment options.
+ * @returns The P2WSH payment object.
+ * @throws {TypeError} If the required data is missing or invalid.
+ */
+function p2wsh(a, opts) {
+    if (!a.address && !a.hash && !a.output && !a.redeem && !a.witness)
+        throw new TypeError('Not enough data');
+    opts = Object.assign({ validate: true }, opts || {});
+    (0, types_1.typeforce)(
+        {
+            network: types_1.typeforce.maybe(types_1.typeforce.Object),
+            address: types_1.typeforce.maybe(types_1.typeforce.String),
+            hash: types_1.typeforce.maybe(types_1.typeforce.BufferN(32)),
+            output: types_1.typeforce.maybe(types_1.typeforce.BufferN(34)),
+            redeem: types_1.typeforce.maybe({
+                input: types_1.typeforce.maybe(types_1.typeforce.Buffer),
+                network: types_1.typeforce.maybe(types_1.typeforce.Object),
+                output: types_1.typeforce.maybe(types_1.typeforce.Buffer),
+                witness: types_1.typeforce.maybe(
+                    types_1.typeforce.arrayOf(types_1.typeforce.Buffer),
+                ),
+            }),
+            input: types_1.typeforce.maybe(types_1.typeforce.BufferN(0)),
+            witness: types_1.typeforce.maybe(
+                types_1.typeforce.arrayOf(types_1.typeforce.Buffer),
+            ),
+        },
+        a,
+    );
+    const _address = lazy.value(() => {
+        const result = bech32_1.bech32.decode(a.address);
+        const version = result.words.shift();
+        const data = bech32_1.bech32.fromWords(result.words);
+        return {
+            version,
+            prefix: result.prefix,
+            data: Buffer.from(data),
+        };
+    });
+    const _rchunks = lazy.value(() => {
+        return bscript.decompile(a.redeem.input);
+    });
+    let network = a.network;
+    if (!network) {
+        network = (a.redeem && a.redeem.network) || networks_1.bitcoin;
+    }
+    const o = { network };
+    lazy.prop(o, 'address', () => {
+        if (!o.hash) return;
+        const words = bech32_1.bech32.toWords(o.hash);
+        words.unshift(0x00);
+        return bech32_1.bech32.encode(network.bech32, words);
+    });
+    lazy.prop(o, 'hash', () => {
+        if (a.output) return a.output.slice(2);
+        if (a.address) return _address().data;
+        if (o.redeem && o.redeem.output) return bcrypto.sha256(o.redeem.output);
+    });
+    lazy.prop(o, 'output', () => {
+        if (!o.hash) return;
+        return bscript.compile([OPS.OP_0, o.hash]);
+    });
+    lazy.prop(o, 'redeem', () => {
+        if (!a.witness) return;
+        return {
+            output: a.witness[a.witness.length - 1],
+            input: EMPTY_BUFFER,
+            witness: a.witness.slice(0, -1),
+        };
+    });
+    lazy.prop(o, 'input', () => {
+        if (!o.witness) return;
+        return EMPTY_BUFFER;
+    });
+    lazy.prop(o, 'witness', () => {
+        // transform redeem input to witness stack?
+        if (
+            a.redeem &&
+            a.redeem.input &&
+            a.redeem.input.length > 0 &&
+            a.redeem.output &&
+            a.redeem.output.length > 0
+        ) {
+            const stack = bscript.toStack(_rchunks());
+            // assign, and blank the existing input
+            o.redeem = Object.assign({ witness: stack }, a.redeem);
+            o.redeem.input = EMPTY_BUFFER;
+            return [].concat(stack, a.redeem.output);
+        }
+        if (!a.redeem) return;
+        if (!a.redeem.output) return;
+        if (!a.redeem.witness) return;
+        return [].concat(a.redeem.witness, a.redeem.output);
+    });
+    lazy.prop(o, 'name', () => {
+        const nameParts = ['p2wsh'];
+        if (o.redeem !== undefined && o.redeem.name !== undefined)
+            nameParts.push(o.redeem.name);
+        return nameParts.join('-');
+    });
+    // extended validation
+    if (opts.validate) {
+        let hash = Buffer.from([]);
+        if (a.address) {
+            if (_address().prefix !== network.bech32)
+                throw new TypeError('Invalid prefix or Network mismatch');
+            if (_address().version !== 0x00)
+                throw new TypeError('Invalid address version');
+            if (_address().data.length !== 32)
+                throw new TypeError('Invalid address data');
+            hash = _address().data;
+        }
+        if (a.hash) {
+            if (hash.length > 0 && !hash.equals(a.hash))
+                throw new TypeError('Hash mismatch');
+            else hash = a.hash;
+        }
+        if (a.output) {
+            if (
+                a.output.length !== 34 ||
+                a.output[0] !== OPS.OP_0 ||
+                a.output[1] !== 0x20
+            )
+                throw new TypeError('Output is invalid');
+            const hash2 = a.output.slice(2);
+            if (hash.length > 0 && !hash.equals(hash2))
+                throw new TypeError('Hash mismatch');
+            else hash = hash2;
+        }
+        if (a.redeem) {
+            if (a.redeem.network && a.redeem.network !== network)
+                throw new TypeError('Network mismatch');
+            // is there two redeem sources?
+            if (
+                a.redeem.input &&
+                a.redeem.input.length > 0 &&
+                a.redeem.witness &&
+                a.redeem.witness.length > 0
+            )
+                throw new TypeError('Ambiguous witness source');
+            // is the redeem output non-empty/valid?
+            if (a.redeem.output) {
+                const decompile = bscript.decompile(a.redeem.output);
+                if (!decompile || decompile.length < 1)
+                    throw new TypeError('Redeem.output is invalid');
+                if (a.redeem.output.byteLength > 3600)
+                    throw new TypeError(
+                        'Redeem.output unspendable if larger than 3600 bytes',
+                    );
+                if (bscript.countNonPushOnlyOPs(decompile) > 201)
+                    throw new TypeError(
+                        'Redeem.output unspendable with more than 201 non-push ops',
+                    );
+                // match hash against other sources
+                const hash2 = bcrypto.sha256(a.redeem.output);
+                if (hash.length > 0 && !hash.equals(hash2))
+                    throw new TypeError('Hash mismatch');
+                else hash = hash2;
+            }
+            if (a.redeem.input && !bscript.isPushOnly(_rchunks()))
+                throw new TypeError('Non push-only scriptSig');
+            if (
+                a.witness &&
+                a.redeem.witness &&
+                !(0, types_1.stacksEqual)(a.witness, a.redeem.witness)
+            )
+                throw new TypeError('Witness and redeem.witness mismatch');
+            if (
+                (a.redeem.input &&
+                    _rchunks().some(chunkHasUncompressedPubkey)) ||
+                (a.redeem.output &&
+                    (bscript.decompile(a.redeem.output) || []).some(
+                        chunkHasUncompressedPubkey,
+                    ))
+            ) {
+                throw new TypeError(
+                    'redeem.input or redeem.output contains uncompressed pubkey',
+                );
+            }
+        }
+        if (a.witness && a.witness.length > 0) {
+            const wScript = a.witness[a.witness.length - 1];
+            if (a.redeem && a.redeem.output && !a.redeem.output.equals(wScript))
+                throw new TypeError('Witness and redeem.output mismatch');
+            if (
+                a.witness.some(chunkHasUncompressedPubkey) ||
+                (bscript.decompile(wScript) || []).some(
+                    chunkHasUncompressedPubkey,
+                )
+            )
+                throw new TypeError('Witness contains uncompressed pubkey');
+        }
+    }
+    return Object.assign(o, a);
+}
+exports.p2wsh = p2wsh;

package/src/psbt/bip371.d.ts

@@ -0,0 +1,42 @@
+/// <reference types="node" />
+import { Taptree } from '../types';
+import { PsbtInput, PsbtOutput, TapLeaf } from 'bip174/src/lib/interfaces';
+export declare const toXOnly: (pubKey: Buffer) => Buffer;
+/**
+ * Default tapscript finalizer. It searches for the `tapLeafHashToFinalize` if provided.
+ * Otherwise it will search for the tapleaf that has at least one signature and has the shortest path.
+ * @param inputIndex the position of the PSBT input.
+ * @param input the PSBT input.
+ * @param tapLeafHashToFinalize optional, if provided the finalizer will search for a tapleaf that has this hash
+ *                              and will try to build the finalScriptWitness.
+ * @returns the finalScriptWitness or throws an exception if no tapleaf found.
+ */
+export declare function tapScriptFinalizer(inputIndex: number, input: PsbtInput, tapLeafHashToFinalize?: Buffer): {
+    finalScriptWitness: Buffer | undefined;
+};
+export declare function serializeTaprootSignature(sig: Buffer, sighashType?: number): Buffer;
+export declare function isTaprootInput(input: PsbtInput): boolean;
+export declare function isTaprootOutput(output: PsbtOutput, script?: Buffer): boolean;
+export declare function checkTaprootInputFields(inputData: PsbtInput, newInputData: PsbtInput, action: string): void;
+export declare function checkTaprootOutputFields(outputData: PsbtOutput, newOutputData: PsbtOutput, action: string): void;
+export declare function tweakInternalPubKey(inputIndex: number, input: PsbtInput): Buffer;
+/**
+ * Convert a binary tree to a BIP371 type list. Each element of the list is (according to BIP371):
+ * One or more tuples representing the depth, leaf version, and script for a leaf in the Taproot tree,
+ * allowing the entire tree to be reconstructed. The tuples must be in depth first search order so that
+ * the tree is correctly reconstructed.
+ * @param tree the binary tap tree
+ * @returns a list of BIP 371 tapleaves
+ */
+export declare function tapTreeToList(tree: Taptree): TapLeaf[];
+/**
+ * Convert a BIP371 TapLeaf list to a TapTree (binary).
+ * @param leaves a list of tapleaves where each element of the list is (according to BIP371):
+ * One or more tuples representing the depth, leaf version, and script for a leaf in the Taproot tree,
+ * allowing the entire tree to be reconstructed. The tuples must be in depth first search order so that
+ * the tree is correctly reconstructed.
+ * @returns the corresponding taptree, or throws an exception if the tree cannot be reconstructed
+ */
+export declare function tapTreeFromList(leaves?: TapLeaf[]): Taptree;
+export declare function checkTaprootInputForSigs(input: PsbtInput, action: string): boolean;
+export declare function getTapKeySigFromWithness(finalScriptWitness?: Buffer): Buffer | undefined;