@btc-vision/bitcoin 6.3.1 → 6.3.3

package/build/payments/p2pkh.js

@@ -0,0 +1,173 @@
+import * as bs58check from 'bs58check';
+import * as bcrypto from '../crypto.js';
+import { bitcoin as BITCOIN_NETWORK } from '../networks.js';
+import * as bscript from '../script.js';
+import { isPoint, typeforce as typef } from '../types.js';
+import * as lazy from './lazy.js';
+import { decompressPublicKey } from '../psbt/psbtutils.js';
+const OPS = bscript.OPS;
+export function p2pkh(a, opts) {
+    if (!a.address && !a.hash && !a.output && !a.pubkey && !a.input) {
+        throw new TypeError('Not enough data');
+    }
+    opts = Object.assign({ validate: true }, opts || {});
+    typef({
+        network: typef.maybe(typef.Object),
+        address: typef.maybe(typef.String),
+        hash: typef.maybe(typef.BufferN(20)),
+        output: typef.maybe(typef.BufferN(25)),
+        pubkey: typef.maybe(isPoint),
+        signature: typef.maybe(bscript.isCanonicalScriptSignature),
+        input: typef.maybe(typef.Buffer),
+    }, a);
+    const _address = lazy.value(() => {
+        const payload = Buffer.from(bs58check.default.decode(a.address));
+        const version = payload.readUInt8(0);
+        const hash = payload.slice(1);
+        return { version, hash };
+    });
+    const _chunks = lazy.value(() => {
+        return bscript.decompile(a.input);
+    });
+    const network = a.network || BITCOIN_NETWORK;
+    const o = { name: 'p2pkh', network };
+    lazy.prop(o, 'address', () => {
+        if (!o.hash)
+            return;
+        const payload = Buffer.allocUnsafe(21);
+        payload.writeUInt8(network.pubKeyHash, 0);
+        o.hash.copy(payload, 1);
+        return bs58check.default.encode(payload);
+    });
+    lazy.prop(o, 'hash', () => {
+        if (a.output)
+            return a.output.slice(3, 23);
+        if (a.address)
+            return _address().hash;
+        if (a.pubkey || o.pubkey)
+            return bcrypto.hash160(a.pubkey || o.pubkey);
+    });
+    lazy.prop(o, 'output', () => {
+        if (!o.hash)
+            return;
+        return bscript.compile([
+            OPS.OP_DUP,
+            OPS.OP_HASH160,
+            o.hash,
+            OPS.OP_EQUALVERIFY,
+            OPS.OP_CHECKSIG,
+        ]);
+    });
+    lazy.prop(o, 'pubkey', () => {
+        if (!a.input)
+            return;
+        return _chunks()[1];
+    });
+    lazy.prop(o, 'signature', () => {
+        if (!a.input)
+            return;
+        return _chunks()[0];
+    });
+    lazy.prop(o, 'input', () => {
+        if (!a.pubkey)
+            return;
+        if (!a.signature)
+            return;
+        let pubKey = a.pubkey;
+        if (a.useHybrid || a.useUncompressed) {
+            const decompressed = decompressPublicKey(a.pubkey);
+            if (a.useUncompressed) {
+                pubKey = decompressed.uncompressed;
+            }
+            else {
+                pubKey = decompressed.hybrid;
+            }
+        }
+        return bscript.compile([a.signature, pubKey]);
+    });
+    lazy.prop(o, 'witness', () => {
+        if (!o.input)
+            return;
+        return [];
+    });
+    if (opts.validate) {
+        let hash = Buffer.from([]);
+        if (a.address) {
+            if (_address().version !== network.pubKeyHash) {
+                throw new TypeError('Invalid version or Network mismatch');
+            }
+            if (_address().hash.length !== 20) {
+                throw new TypeError('Invalid address');
+            }
+            hash = _address().hash;
+        }
+        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 !== 25 ||
+                a.output[0] !== OPS.OP_DUP ||
+                a.output[1] !== OPS.OP_HASH160 ||
+                a.output[2] !== 0x14 ||
+                a.output[23] !== OPS.OP_EQUALVERIFY ||
+                a.output[24] !== OPS.OP_CHECKSIG) {
+                throw new TypeError('Output is invalid');
+            }
+            const hash2 = a.output.slice(3, 23);
+            if (hash.length > 0 && !hash.equals(hash2))
+                throw new TypeError('Hash mismatch');
+            else
+                hash = hash2;
+        }
+        if (a.pubkey) {
+            const pkh = bcrypto.hash160(a.pubkey);
+            let badHash = hash.length > 0 && !hash.equals(pkh);
+            if (badHash) {
+                if ((a.pubkey.length === 33 && (a.pubkey[0] === 0x02 || a.pubkey[0] === 0x03)) ||
+                    (a.pubkey.length === 65 && a.pubkey[0] === 0x04)) {
+                    const uncompressed = decompressPublicKey(a.pubkey);
+                    const pkh2 = bcrypto.hash160(uncompressed.uncompressed);
+                    if (!hash.equals(pkh2)) {
+                        const pkh3 = bcrypto.hash160(uncompressed.hybrid);
+                        badHash = !hash.equals(pkh3);
+                        if (!badHash) {
+                            a.useHybrid = true;
+                        }
+                    }
+                    else {
+                        badHash = false;
+                        a.useUncompressed = true;
+                    }
+                }
+            }
+            if (badHash) {
+                throw new TypeError('Hash mismatch');
+            }
+            else {
+                hash = pkh;
+            }
+        }
+        if (a.input) {
+            const chunks = _chunks();
+            if (chunks.length !== 2)
+                throw new TypeError('Input is invalid');
+            if (!bscript.isCanonicalScriptSignature(chunks[0]))
+                throw new TypeError('Input has invalid signature');
+            if (!isPoint(chunks[1]))
+                throw new TypeError('Input has invalid pubkey');
+            if (a.signature && !a.signature.equals(chunks[0]))
+                throw new TypeError('Signature mismatch');
+            if (a.pubkey && !a.pubkey.equals(chunks[1]))
+                throw new TypeError('Pubkey mismatch');
+            const pkh = bcrypto.hash160(chunks[1]);
+            if (hash.length > 0 && !hash.equals(pkh))
+                throw new TypeError('Hash mismatch (input)');
+        }
+    }
+    return Object.assign(o, a);
+}

package/build/payments/p2sh.d.ts

@@ -0,0 +1,2 @@
+import { Payment, PaymentOpts } from './index.js';
+export declare function p2sh(a: Payment, opts?: PaymentOpts): Payment;

package/build/payments/p2sh.js

@@ -0,0 +1,176 @@
+import * as bs58check from 'bs58check';
+import * as bcrypto from '../crypto.js';
+import { bitcoin as BITCOIN_NETWORK } from '../networks.js';
+import * as bscript from '../script.js';
+import { stacksEqual, typeforce as typef } from '../types.js';
+import * as lazy from './lazy.js';
+const OPS = bscript.OPS;
+export function p2sh(a, opts) {
+    if (!a.address && !a.hash && !a.output && !a.redeem && !a.input) {
+        throw new TypeError('Not enough data');
+    }
+    opts = Object.assign({ validate: true }, opts || {});
+    typef({
+        network: typef.maybe(typef.Object),
+        address: typef.maybe(typef.String),
+        hash: typef.maybe(typef.BufferN(20)),
+        output: typef.maybe(typef.BufferN(23)),
+        redeem: typef.maybe({
+            network: typef.maybe(typef.Object),
+            output: typef.maybe(typef.Buffer),
+            input: typef.maybe(typef.Buffer),
+            witness: typef.maybe(typef.arrayOf(typef.Buffer)),
+        }),
+        input: typef.maybe(typef.Buffer),
+        witness: typef.maybe(typef.arrayOf(typef.Buffer)),
+    }, a);
+    let network = a.network;
+    if (!network) {
+        network = (a.redeem && a.redeem.network) || BITCOIN_NETWORK;
+    }
+    const o = { network };
+    const _address = lazy.value(() => {
+        const payload = Buffer.from(bs58check.default.decode(a.address));
+        const version = payload.readUInt8(0);
+        const hash = payload.slice(1);
+        return { version, hash };
+    });
+    const _chunks = lazy.value(() => {
+        return bscript.decompile(a.input);
+    });
+    const _redeem = lazy.value(() => {
+        const chunks = _chunks();
+        const lastChunk = chunks[chunks.length - 1];
+        return {
+            network,
+            output: lastChunk === OPS.OP_FALSE ? Buffer.from([]) : lastChunk,
+            input: bscript.compile(chunks.slice(0, -1)),
+            witness: a.witness || [],
+        };
+    });
+    lazy.prop(o, 'address', () => {
+        if (!o.hash)
+            return;
+        const payload = Buffer.allocUnsafe(21);
+        payload.writeUInt8(o.network.scriptHash, 0);
+        o.hash.copy(payload, 1);
+        return bs58check.default.encode(payload);
+    });
+    lazy.prop(o, 'hash', () => {
+        if (a.output)
+            return a.output.slice(2, 22);
+        if (a.address)
+            return _address().hash;
+        if (o.redeem && o.redeem.output)
+            return bcrypto.hash160(o.redeem.output);
+    });
+    lazy.prop(o, 'output', () => {
+        if (!o.hash)
+            return;
+        return bscript.compile([OPS.OP_HASH160, o.hash, OPS.OP_EQUAL]);
+    });
+    lazy.prop(o, 'redeem', () => {
+        if (!a.input)
+            return;
+        return _redeem();
+    });
+    lazy.prop(o, 'input', () => {
+        if (!a.redeem || !a.redeem.input || !a.redeem.output)
+            return;
+        return bscript.compile([].concat(bscript.decompile(a.redeem.input), a.redeem.output));
+    });
+    lazy.prop(o, 'witness', () => {
+        if (o.redeem && o.redeem.witness)
+            return o.redeem.witness;
+        if (o.input)
+            return [];
+    });
+    lazy.prop(o, 'name', () => {
+        const nameParts = ['p2sh'];
+        if (o.redeem !== undefined && o.redeem.name !== undefined)
+            nameParts.push(o.redeem.name);
+        return nameParts.join('-');
+    });
+    if (opts.validate) {
+        let hash = Buffer.from([]);
+        if (a.address) {
+            if (_address().version !== network.scriptHash)
+                throw new TypeError('Invalid version or Network mismatch');
+            if (_address().hash.length !== 20)
+                throw new TypeError('Invalid address');
+            hash = _address().hash;
+        }
+        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 !== 23 ||
+                a.output[0] !== OPS.OP_HASH160 ||
+                a.output[1] !== 0x14 ||
+                a.output[22] !== OPS.OP_EQUAL)
+                throw new TypeError('Output is invalid');
+            const hash2 = a.output.slice(2, 22);
+            if (hash.length > 0 && !hash.equals(hash2))
+                throw new TypeError('Hash mismatch');
+            else
+                hash = hash2;
+        }
+        const checkRedeem = (redeem) => {
+            if (redeem.output) {
+                const decompile = bscript.decompile(redeem.output);
+                if (!decompile || decompile.length < 1)
+                    throw new TypeError('Redeem.output too short');
+                if (redeem.output.byteLength > 520)
+                    throw new TypeError('Redeem.output unspendable if larger than 520 bytes');
+                if (bscript.countNonPushOnlyOPs(decompile) > 201)
+                    throw new TypeError('Redeem.output unspendable with more than 201 non-push ops');
+                const hash2 = bcrypto.hash160(redeem.output);
+                if (hash.length > 0 && !hash.equals(hash2))
+                    throw new TypeError('Hash mismatch');
+                else
+                    hash = hash2;
+            }
+            if (redeem.input) {
+                const hasInput = redeem.input.length > 0;
+                const hasWitness = redeem.witness && redeem.witness.length > 0;
+                if (!hasInput && !hasWitness)
+                    throw new TypeError('Empty input');
+                if (hasInput && hasWitness)
+                    throw new TypeError('Input and witness provided');
+                if (hasInput) {
+                    const richunks = bscript.decompile(redeem.input);
+                    if (!bscript.isPushOnly(richunks))
+                        throw new TypeError('Non push-only scriptSig');
+                }
+            }
+        };
+        if (a.input) {
+            const chunks = _chunks();
+            if (!chunks || chunks.length < 1)
+                throw new TypeError('Input too short');
+            if (!Buffer.isBuffer(_redeem().output))
+                throw new TypeError('Input is invalid');
+            checkRedeem(_redeem());
+        }
+        if (a.redeem) {
+            if (a.redeem.network && a.redeem.network !== network)
+                throw new TypeError('Network mismatch');
+            if (a.input) {
+                const redeem = _redeem();
+                if (a.redeem.output && !a.redeem.output.equals(redeem.output))
+                    throw new TypeError('Redeem.output mismatch');
+                if (a.redeem.input && !a.redeem.input.equals(redeem.input))
+                    throw new TypeError('Redeem.input mismatch');
+            }
+            checkRedeem(a.redeem);
+        }
+        if (a.witness) {
+            if (a.redeem && a.redeem.witness && !stacksEqual(a.redeem.witness, a.witness))
+                throw new TypeError('Witness and redeem.witness mismatch');
+        }
+    }
+    return Object.assign(o, a);
+}

package/build/payments/p2tr.d.ts

@@ -0,0 +1,2 @@
+import { Payment, PaymentOpts } from './index.js';
+export declare function p2tr(a: Payment, opts?: PaymentOpts): Payment;

package/build/payments/p2tr.js

@@ -0,0 +1,254 @@
+import { bech32m } from 'bech32';
+import { Buffer as NBuffer } from 'buffer';
+import { fromBech32 } from '../address.js';
+import { getEccLib } from '../ecc_lib.js';
+import { bitcoin as BITCOIN_NETWORK } from '../networks.js';
+import * as bscript from '../script.js';
+import { isTaptree, stacksEqual, TAPLEAF_VERSION_MASK, typeforce as typef } from '../types.js';
+import { findScriptPath, LEAF_VERSION_TAPSCRIPT, rootHashFromPath, tapleafHash, toHashTree, tweakKey, } from './bip341.js';
+import * as lazy from './lazy.js';
+const OPS = bscript.OPS;
+const TAPROOT_WITNESS_VERSION = 0x01;
+const ANNEX_PREFIX = 0x50;
+export function p2tr(a, opts) {
+    if (!a.address &&
+        !a.output &&
+        !a.pubkey &&
+        !a.internalPubkey &&
+        !(a.witness && a.witness.length > 1))
+        throw new TypeError('Not enough data');
+    opts = Object.assign({ validate: true }, opts || {});
+    typef({
+        address: typef.maybe(typef.String),
+        input: typef.maybe(typef.BufferN(0)),
+        network: typef.maybe(typef.Object),
+        output: typef.maybe(typef.BufferN(34)),
+        internalPubkey: typef.maybe(typef.BufferN(32)),
+        hash: typef.maybe(typef.BufferN(32)),
+        pubkey: typef.maybe(typef.BufferN(32)),
+        signature: typef.maybe(typef.anyOf(typef.BufferN(64), typef.BufferN(65))),
+        witness: typef.maybe(typef.arrayOf(typef.Buffer)),
+        scriptTree: typef.maybe(isTaptree),
+        redeem: typef.maybe({
+            output: typef.maybe(typef.Buffer),
+            redeemVersion: typef.maybe(typef.Number),
+            witness: typef.maybe(typef.arrayOf(typef.Buffer)),
+        }),
+        redeemVersion: typef.maybe(typef.Number),
+    }, a);
+    const _address = lazy.value(() => {
+        return fromBech32(a.address);
+    });
+    const _witness = lazy.value(() => {
+        if (!a.witness || !a.witness.length)
+            return;
+        if (a.witness.length >= 2 && a.witness[a.witness.length - 1][0] === ANNEX_PREFIX) {
+            return a.witness.slice(0, -1);
+        }
+        return a.witness.slice();
+    });
+    const _hashTree = lazy.value(() => {
+        if (a.scriptTree)
+            return toHashTree(a.scriptTree);
+        if (a.hash)
+            return { hash: a.hash };
+        return;
+    });
+    const network = a.network || BITCOIN_NETWORK;
+    const o = { name: 'p2tr', network };
+    lazy.prop(o, 'address', () => {
+        if (!o.pubkey)
+            return;
+        const words = bech32m.toWords(o.pubkey);
+        words.unshift(TAPROOT_WITNESS_VERSION);
+        return bech32m.encode(network.bech32, words);
+    });
+    lazy.prop(o, 'hash', () => {
+        const hashTree = _hashTree();
+        if (hashTree)
+            return hashTree.hash;
+        const w = _witness();
+        if (w && w.length > 1) {
+            const controlBlock = w[w.length - 1];
+            const leafVersion = controlBlock[0] & TAPLEAF_VERSION_MASK;
+            const script = w[w.length - 2];
+            const leafHash = tapleafHash({
+                output: script,
+                version: leafVersion,
+            });
+            return rootHashFromPath(controlBlock, leafHash);
+        }
+        return null;
+    });
+    lazy.prop(o, 'output', () => {
+        if (!o.pubkey)
+            return;
+        return bscript.compile([OPS.OP_1, o.pubkey]);
+    });
+    lazy.prop(o, 'redeemVersion', () => {
+        if (a.redeemVersion)
+            return a.redeemVersion;
+        if (a.redeem && a.redeem.redeemVersion !== undefined && a.redeem.redeemVersion !== null) {
+            return a.redeem.redeemVersion;
+        }
+        return LEAF_VERSION_TAPSCRIPT;
+    });
+    lazy.prop(o, 'redeem', () => {
+        const witness = _witness();
+        if (!witness || witness.length < 2)
+            return;
+        return {
+            output: witness[witness.length - 2],
+            witness: witness.slice(0, -2),
+            redeemVersion: witness[witness.length - 1][0] & TAPLEAF_VERSION_MASK,
+        };
+    });
+    lazy.prop(o, 'pubkey', () => {
+        if (a.pubkey)
+            return a.pubkey;
+        if (a.output)
+            return a.output.slice(2);
+        if (a.address)
+            return _address().data;
+        if (o.internalPubkey) {
+            const tweakedKey = tweakKey(o.internalPubkey, o.hash);
+            if (tweakedKey)
+                return tweakedKey.x;
+        }
+    });
+    lazy.prop(o, 'internalPubkey', () => {
+        if (a.internalPubkey)
+            return a.internalPubkey;
+        const witness = _witness();
+        if (witness && witness.length > 1)
+            return witness[witness.length - 1].slice(1, 33);
+    });
+    lazy.prop(o, 'signature', () => {
+        if (a.signature)
+            return a.signature;
+        const witness = _witness();
+        if (!witness || witness.length !== 1)
+            return;
+        return witness[0];
+    });
+    lazy.prop(o, 'witness', () => {
+        if (a.witness)
+            return a.witness;
+        const hashTree = _hashTree();
+        if (hashTree && a.redeem && a.redeem.output && a.internalPubkey) {
+            const leafHash = tapleafHash({
+                output: a.redeem.output,
+                version: o.redeemVersion,
+            });
+            const path = findScriptPath(hashTree, leafHash);
+            if (!path)
+                return;
+            const outputKey = tweakKey(a.internalPubkey, hashTree.hash);
+            if (!outputKey)
+                return;
+            const controlBock = NBuffer.concat([NBuffer.from([o.redeemVersion | outputKey.parity]), a.internalPubkey].concat(path));
+            return [a.redeem.output, controlBock];
+        }
+        if (a.signature)
+            return [a.signature];
+    });
+    if (opts.validate) {
+        let pubkey = NBuffer.from([]);
+        if (a.address) {
+            if (network && network.bech32 !== _address().prefix)
+                throw new TypeError('Invalid prefix or Network mismatch');
+            if (_address().version !== TAPROOT_WITNESS_VERSION)
+                throw new TypeError('Invalid address version');
+            if (_address().data.length !== 32)
+                throw new TypeError('Invalid address data');
+            pubkey = _address().data;
+        }
+        if (a.pubkey) {
+            if (pubkey.length > 0 && !pubkey.equals(a.pubkey))
+                throw new TypeError('Pubkey mismatch');
+            else
+                pubkey = a.pubkey;
+        }
+        if (a.output) {
+            if (a.output.length !== 34 || a.output[0] !== OPS.OP_1 || a.output[1] !== 0x20)
+                throw new TypeError('Output is invalid');
+            if (pubkey.length > 0 && !pubkey.equals(a.output.slice(2)))
+                throw new TypeError('Pubkey mismatch');
+            else
+                pubkey = a.output.slice(2);
+        }
+        if (a.internalPubkey) {
+            const tweakedKey = tweakKey(a.internalPubkey, o.hash);
+            if (pubkey.length > 0 && !pubkey.equals(tweakedKey.x))
+                throw new TypeError('Pubkey mismatch');
+            else
+                pubkey = tweakedKey.x;
+        }
+        const hashTree = _hashTree();
+        if (a.hash && hashTree) {
+            if (!a.hash.equals(hashTree.hash))
+                throw new TypeError('Hash mismatch');
+        }
+        if (a.redeem && a.redeem.output && hashTree) {
+            const leafHash = tapleafHash({
+                output: a.redeem.output,
+                version: o.redeemVersion,
+            });
+            if (!findScriptPath(hashTree, leafHash))
+                throw new TypeError('Redeem script not in tree');
+        }
+        const witness = _witness();
+        if (a.redeem && o.redeem) {
+            if (a.redeem.redeemVersion) {
+                if (a.redeem.redeemVersion !== o.redeem.redeemVersion)
+                    throw new TypeError('Redeem.redeemVersion and witness mismatch');
+            }
+            if (a.redeem.output) {
+                if (bscript.decompile(a.redeem.output).length === 0)
+                    throw new TypeError('Redeem.output is invalid');
+                if (o.redeem.output && !a.redeem.output.equals(o.redeem.output))
+                    throw new TypeError('Redeem.output and witness mismatch');
+            }
+            if (a.redeem.witness) {
+                if (o.redeem.witness && !stacksEqual(a.redeem.witness, o.redeem.witness))
+                    throw new TypeError('Redeem.witness and witness mismatch');
+            }
+        }
+        if (witness && witness.length) {
+            if (witness.length === 1) {
+                if (a.signature && !a.signature.equals(witness[0]))
+                    throw new TypeError('Signature mismatch');
+            }
+            else {
+                const controlBlock = witness[witness.length - 1];
+                if (controlBlock.length < 33)
+                    throw new TypeError(`The control-block length is too small. Got ${controlBlock.length}, expected min 33.`);
+                if ((controlBlock.length - 33) % 32 !== 0)
+                    throw new TypeError(`The control-block length of ${controlBlock.length} is incorrect!`);
+                const m = (controlBlock.length - 33) / 32;
+                if (m > 128)
+                    throw new TypeError(`The script path is too long. Got ${m}, expected max 128.`);
+                const internalPubkey = controlBlock.slice(1, 33);
+                if (a.internalPubkey && !a.internalPubkey.equals(internalPubkey))
+                    throw new TypeError('Internal pubkey mismatch');
+                if (!getEccLib().isXOnlyPoint(internalPubkey))
+                    throw new TypeError('Invalid internalPubkey for p2tr witness');
+                const leafVersion = controlBlock[0] & TAPLEAF_VERSION_MASK;
+                const script = witness[witness.length - 2];
+                const leafHash = tapleafHash({
+                    output: script,
+                    version: leafVersion,
+                });
+                const hash = rootHashFromPath(controlBlock, leafHash);
+                const outputKey = tweakKey(internalPubkey, hash);
+                if (!outputKey)
+                    throw new TypeError('Invalid outputKey for p2tr witness');
+                if (pubkey.length && !pubkey.equals(outputKey.x))
+                    throw new TypeError('Pubkey mismatch for p2tr witness');
+                if (outputKey.parity !== (controlBlock[0] & 1))
+                    throw new Error('Incorrect parity');
+            }
+        }
+    }
+    return Object.assign(o, a);
+}

package/build/payments/p2wpkh.d.ts

@@ -0,0 +1,2 @@
+import { Payment, PaymentOpts } from './index.js';
+export declare function p2wpkh(a: Payment, opts?: PaymentOpts): Payment;