@btc-vision/bitcoin 6.3.1 → 6.3.3

package/src/payments/{p2tr.js → p2tr.ts}

@@ -1,18 +1,25 @@
-'use strict';
-Object.defineProperty(exports, '__esModule', { value: true });
-exports.p2tr = void 0;
-const buffer_1 = require('buffer');
-const networks_1 = require('../networks');
-const bscript = require('../script');
-const types_1 = require('../types');
-const ecc_lib_1 = require('../ecc_lib');
-const bip341_1 = require('./bip341');
-const lazy = require('./lazy');
-const bech32_1 = require('bech32');
-const address_1 = require('../address');
+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 { Payment, PaymentOpts } from './index.js';
+import * as lazy from './lazy.js';
+
 const OPS = bscript.OPS;
 const TAPROOT_WITNESS_VERSION = 0x01;
 const ANNEX_PREFIX = 0x50;
+
 /**
  * Creates a Pay-to-Taproot (P2TR) payment object.
  *
@@ -21,7 +28,7 @@ const ANNEX_PREFIX = 0x50;
  * @returns The P2TR payment object.
  * @throws {TypeError} If the provided data is invalid or insufficient.
  */
-function p2tr(a, opts) {
+export function p2tr(a: Payment, opts?: PaymentOpts): Payment {
     if (
         !a.address &&
         !a.output &&
@@ -30,81 +37,74 @@ function p2tr(a, opts) {
         !(a.witness && a.witness.length > 1)
     )
         throw new TypeError('Not enough data');
+
     opts = Object.assign({ validate: true }, opts || {});
-    (0, types_1.typeforce)(
+
+    typef(
         {
-            address: types_1.typeforce.maybe(types_1.typeforce.String),
-            input: types_1.typeforce.maybe(types_1.typeforce.BufferN(0)),
-            network: types_1.typeforce.maybe(types_1.typeforce.Object),
-            output: types_1.typeforce.maybe(types_1.typeforce.BufferN(34)),
-            internalPubkey: types_1.typeforce.maybe(
-                types_1.typeforce.BufferN(32),
-            ),
-            hash: types_1.typeforce.maybe(types_1.typeforce.BufferN(32)),
-            pubkey: types_1.typeforce.maybe(types_1.typeforce.BufferN(32)),
-            signature: types_1.typeforce.maybe(
-                types_1.typeforce.anyOf(
-                    types_1.typeforce.BufferN(64),
-                    types_1.typeforce.BufferN(65),
-                ),
-            ),
-            witness: types_1.typeforce.maybe(
-                types_1.typeforce.arrayOf(types_1.typeforce.Buffer),
-            ),
-            scriptTree: types_1.typeforce.maybe(types_1.isTaptree),
-            redeem: types_1.typeforce.maybe({
-                output: types_1.typeforce.maybe(types_1.typeforce.Buffer),
-                redeemVersion: types_1.typeforce.maybe(
-                    types_1.typeforce.Number,
-                ),
-                witness: types_1.typeforce.maybe(
-                    types_1.typeforce.arrayOf(types_1.typeforce.Buffer),
-                ),
+            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)), // merkle root hash, the tweak
+            pubkey: typef.maybe(typef.BufferN(32)), // tweaked with `hash` from `internalPubkey`
+            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), // tapleaf script
+                redeemVersion: typef.maybe(typef.Number), // tapleaf version
+                witness: typef.maybe(typef.arrayOf(typef.Buffer)),
             }),
-            redeemVersion: types_1.typeforce.maybe(types_1.typeforce.Number),
+            redeemVersion: typef.maybe(typef.Number),
         },
         a,
     );
+
     const _address = lazy.value(() => {
-        return (0, address_1.fromBech32)(a.address);
+        return fromBech32(a.address!);
     });
+
     // remove annex if present, ignored by taproot
     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
-        ) {
+        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 (0, bip341_1.toHashTree)(a.scriptTree);
+        if (a.scriptTree) return toHashTree(a.scriptTree);
         if (a.hash) return { hash: a.hash };
         return;
     });
-    const network = a.network || networks_1.bitcoin;
-    const o = { name: 'p2tr', network };
+
+    const network = a.network || BITCOIN_NETWORK;
+    const o: Payment = { name: 'p2tr', network };
+
     lazy.prop(o, 'address', () => {
         if (!o.pubkey) return;
-        const words = bech32_1.bech32m.toWords(o.pubkey);
+
+        const words = bech32m.toWords(o.pubkey);
         words.unshift(TAPROOT_WITNESS_VERSION);
-        return bech32_1.bech32m.encode(network.bech32, words);
+        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] & types_1.TAPLEAF_VERSION_MASK;
+            const leafVersion = controlBlock[0] & TAPLEAF_VERSION_MASK;
             const script = w[w.length - 2];
-            const leafHash = (0, bip341_1.tapleafHash)({
+            const leafHash = tapleafHash({
                 output: script,
                 version: leafVersion,
             });
-            return (0, bip341_1.rootHashFromPath)(controlBlock, leafHash);
+            return rootHashFromPath(controlBlock, leafHash);
         }
         return null;
     });
@@ -114,23 +114,20 @@ function p2tr(a, opts) {
     });
     lazy.prop(o, 'redeemVersion', () => {
         if (a.redeemVersion) return a.redeemVersion;
-        if (
-            a.redeem &&
-            a.redeem.redeemVersion !== undefined &&
-            a.redeem.redeemVersion !== null
-        ) {
+        if (a.redeem && a.redeem.redeemVersion !== undefined && a.redeem.redeemVersion !== null) {
             return a.redeem.redeemVersion;
         }
-        return bip341_1.LEAF_VERSION_TAPSCRIPT;
+
+        return LEAF_VERSION_TAPSCRIPT;
     });
     lazy.prop(o, 'redeem', () => {
         const witness = _witness(); // witness without annex
         if (!witness || witness.length < 2) return;
+
         return {
             output: witness[witness.length - 2],
             witness: witness.slice(0, -2),
-            redeemVersion:
-                witness[witness.length - 1][0] & types_1.TAPLEAF_VERSION_MASK,
+            redeemVersion: witness[witness.length - 1][0] & TAPLEAF_VERSION_MASK,
         };
     });
     lazy.prop(o, 'pubkey', () => {
@@ -138,15 +135,14 @@ function p2tr(a, opts) {
         if (a.output) return a.output.slice(2);
         if (a.address) return _address().data;
         if (o.internalPubkey) {
-            const tweakedKey = (0, bip341_1.tweakKey)(o.internalPubkey, o.hash);
+            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);
+        if (witness && witness.length > 1) return witness[witness.length - 1].slice(1, 33);
     });
     lazy.prop(o, 'signature', () => {
         if (a.signature) return a.signature;
@@ -154,109 +150,105 @@ function p2tr(a, opts) {
         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 = (0, bip341_1.tapleafHash)({
+            const leafHash = tapleafHash({
                 output: a.redeem.output,
                 version: o.redeemVersion,
             });
-            const path = (0, bip341_1.findScriptPath)(hashTree, leafHash);
+            const path = findScriptPath(hashTree, leafHash);
             if (!path) return;
-            const outputKey = (0, bip341_1.tweakKey)(
-                a.internalPubkey,
-                hashTree.hash,
-            );
+            const outputKey = tweakKey(a.internalPubkey, hashTree.hash);
             if (!outputKey) return;
-            const controlBock = buffer_1.Buffer.concat(
-                [
-                    buffer_1.Buffer.from([o.redeemVersion | outputKey.parity]),
-                    a.internalPubkey,
-                ].concat(path),
+            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];
     });
+
     // extended validation
     if (opts.validate) {
-        let pubkey = buffer_1.Buffer.from([]);
+        let pubkey: Buffer = 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');
+            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
-            )
+            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 = (0, bip341_1.tweakKey)(a.internalPubkey, o.hash);
-            if (pubkey.length > 0 && !pubkey.equals(tweakedKey.x))
+            const tweakedKey = tweakKey(a.internalPubkey, o.hash);
+            if (pubkey.length > 0 && !pubkey.equals(tweakedKey!.x))
                 throw new TypeError('Pubkey mismatch');
-            else pubkey = tweakedKey.x;
+            else pubkey = tweakedKey!.x;
         }
+
         /*if (pubkey && pubkey.length) {
             if (!getEccLib().isXOnlyPoint(pubkey))
                 throw new TypeError('Invalid pubkey for p2tr');
         }*/
+
         const hashTree = _hashTree();
+
         if (a.hash && hashTree) {
-            if (!a.hash.equals(hashTree.hash))
-                throw new TypeError('Hash mismatch');
+            if (!a.hash.equals(hashTree.hash)) throw new TypeError('Hash mismatch');
         }
+
         if (a.redeem && a.redeem.output && hashTree) {
-            const leafHash = (0, bip341_1.tapleafHash)({
+            const leafHash = tapleafHash({
                 output: a.redeem.output,
                 version: o.redeemVersion,
             });
-            if (!(0, bip341_1.findScriptPath)(hashTree, leafHash))
+            if (!findScriptPath(hashTree, leafHash))
                 throw new TypeError('Redeem script not in tree');
         }
+
         const witness = _witness();
+
         // compare the provided redeem data with the one computed from 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',
-                    );
+                    throw new TypeError('Redeem.redeemVersion and witness mismatch');
             }
+
             if (a.redeem.output) {
-                if (bscript.decompile(a.redeem.output).length === 0)
+                if (bscript.decompile(a.redeem.output)!.length === 0)
                     throw new TypeError('Redeem.output is invalid');
+
                 // output redeem is constructed from the witness
                 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 &&
-                    !(0, types_1.stacksEqual)(
-                        a.redeem.witness,
-                        o.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) {
                 // key spending
@@ -269,47 +261,44 @@ function p2tr(a, opts) {
                     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.`,
-                    );
+                    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)
-                )
+                if (a.internalPubkey && !a.internalPubkey.equals(internalPubkey))
                     throw new TypeError('Internal pubkey mismatch');
-                if (!(0, ecc_lib_1.getEccLib)().isXOnlyPoint(internalPubkey))
-                    throw new TypeError(
-                        'Invalid internalPubkey for p2tr witness',
-                    );
-                const leafVersion =
-                    controlBlock[0] & types_1.TAPLEAF_VERSION_MASK;
+
+                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 = (0, bip341_1.tapleafHash)({
+
+                const leafHash = tapleafHash({
                     output: script,
                     version: leafVersion,
                 });
-                const hash = (0, bip341_1.rootHashFromPath)(
-                    controlBlock,
-                    leafHash,
-                );
-                const outputKey = (0, bip341_1.tweakKey)(internalPubkey, hash);
+                const hash = rootHashFromPath(controlBlock, leafHash);
+
+                const outputKey = tweakKey(internalPubkey, hash);
                 if (!outputKey)
                     // todo: needs test data
                     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');
+
+                if (outputKey.parity !== (controlBlock[0] & 1)) throw new Error('Incorrect parity');
             }
         }
     }
+
     return Object.assign(o, a);
 }
-exports.p2tr = p2tr;

package/src/payments/{p2wpkh.js → p2wpkh.ts}

@@ -1,14 +1,15 @@
-'use strict';
-Object.defineProperty(exports, '__esModule', { value: true });
-exports.p2wpkh = 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');
+import { bech32 } from 'bech32';
+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 { Payment, PaymentOpts } from './index.js';
+import * as lazy from './lazy.js';
+
 const OPS = bscript.OPS;
+
 const EMPTY_BUFFER = Buffer.alloc(0);
+
 // witness: {signature} {pubKey}
 // input: <>
 // output: OP_0 {pubKeyHash}
@@ -20,49 +21,50 @@ const EMPTY_BUFFER = Buffer.alloc(0);
  * @returns The p2wpkh payment object.
  * @throws {TypeError} If the required data is missing or invalid.
  */
-function p2wpkh(a, opts) {
+export function p2wpkh(a: Payment, opts?: PaymentOpts): Payment {
     if (!a.address && !a.hash && !a.output && !a.pubkey && !a.witness)
         throw new TypeError('Not enough data');
     opts = Object.assign({ validate: true }, opts || {});
-    (0, types_1.typeforce)(
+
+    typef(
         {
-            address: types_1.typeforce.maybe(types_1.typeforce.String),
-            hash: types_1.typeforce.maybe(types_1.typeforce.BufferN(20)),
-            input: types_1.typeforce.maybe(types_1.typeforce.BufferN(0)),
-            network: types_1.typeforce.maybe(types_1.typeforce.Object),
-            output: types_1.typeforce.maybe(types_1.typeforce.BufferN(22)),
-            pubkey: types_1.typeforce.maybe(types_1.isPoint),
-            signature: types_1.typeforce.maybe(
-                bscript.isCanonicalScriptSignature,
-            ),
-            witness: types_1.typeforce.maybe(
-                types_1.typeforce.arrayOf(types_1.typeforce.Buffer),
-            ),
+            address: typef.maybe(typef.String),
+            hash: typef.maybe(typef.BufferN(20)),
+            input: typef.maybe(typef.BufferN(0)),
+            network: typef.maybe(typef.Object),
+            output: typef.maybe(typef.BufferN(22)),
+            pubkey: typef.maybe(isPoint),
+            signature: typef.maybe(bscript.isCanonicalScriptSignature),
+            witness: typef.maybe(typef.arrayOf(typef.Buffer)),
         },
         a,
     );
+
     const _address = lazy.value(() => {
-        const result = bech32_1.bech32.decode(a.address);
+        const result = bech32.decode(a.address!);
         const version = result.words.shift();
-        const data = bech32_1.bech32.fromWords(result.words);
+        const data = bech32.fromWords(result.words);
         return {
             version,
             prefix: result.prefix,
             data: Buffer.from(data),
         };
     });
-    const network = a.network || networks_1.bitcoin;
-    const o = { name: 'p2wpkh', network };
+
+    const network = a.network || BITCOIN_NETWORK;
+    const o: Payment = { name: 'p2wpkh', network };
+
     lazy.prop(o, 'address', () => {
         if (!o.hash) return;
-        const words = bech32_1.bech32.toWords(o.hash);
+
+        const words = bech32.toWords(o.hash);
         words.unshift(0x00);
-        return bech32_1.bech32.encode(network.bech32, words);
+        return bech32.encode(network.bech32, words);
     });
     lazy.prop(o, 'hash', () => {
         if (a.output) return a.output.slice(2, 22);
         if (a.address) return _address().data;
-        if (a.pubkey || o.pubkey) return bcrypto.hash160(a.pubkey || o.pubkey);
+        if (a.pubkey || o.pubkey) return bcrypto.hash160(a.pubkey! || o.pubkey!);
     });
     lazy.prop(o, 'output', () => {
         if (!o.hash) return;
@@ -86,61 +88,54 @@ function p2wpkh(a, opts) {
         if (!a.signature) return;
         return [a.signature, a.pubkey];
     });
+
     // extended validation
     if (opts.validate) {
-        let hash = Buffer.from([]);
+        let hash: Buffer = Buffer.from([]);
         if (a.address) {
             if (network && network.bech32 !== _address().prefix)
                 throw new TypeError('Invalid prefix or Network mismatch');
-            if (_address().version !== 0x00)
-                throw new TypeError('Invalid address version');
-            if (_address().data.length !== 20)
-                throw new TypeError('Invalid address data');
+            if (_address().version !== 0x00) throw new TypeError('Invalid address version');
+            if (_address().data.length !== 20) 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');
+            if (hash.length > 0 && !hash.equals(a.hash)) throw new TypeError('Hash mismatch');
             else hash = a.hash;
         }
+
         if (a.output) {
-            if (
-                a.output.length !== 22 ||
-                a.output[0] !== OPS.OP_0 ||
-                a.output[1] !== 0x14
-            )
+            if (a.output.length !== 22 || a.output[0] !== OPS.OP_0 || a.output[1] !== 0x14)
                 throw new TypeError('Output is invalid');
             if (hash.length > 0 && !hash.equals(a.output.slice(2)))
                 throw new TypeError('Hash mismatch');
             else hash = a.output.slice(2);
         }
+
         if (a.pubkey) {
             const pkh = bcrypto.hash160(a.pubkey);
-            if (hash.length > 0 && !hash.equals(pkh))
-                throw new TypeError('Hash mismatch');
+            if (hash.length > 0 && !hash.equals(pkh)) throw new TypeError('Hash mismatch');
             else hash = pkh;
-            if (!(0, types_1.isPoint)(a.pubkey) || a.pubkey.length !== 33)
+            if (!isPoint(a.pubkey) || a.pubkey.length !== 33)
                 throw new TypeError('Invalid pubkey for p2wpkh');
         }
+
         if (a.witness) {
-            if (a.witness.length !== 2)
-                throw new TypeError('Witness is invalid');
+            if (a.witness.length !== 2) throw new TypeError('Witness is invalid');
             if (!bscript.isCanonicalScriptSignature(a.witness[0]))
                 throw new TypeError('Witness has invalid signature');
-            if (
-                !(0, types_1.isPoint)(a.witness[1]) ||
-                a.witness[1].length !== 33
-            )
+            if (!isPoint(a.witness[1]) || a.witness[1].length !== 33)
                 throw new TypeError('Witness has invalid pubkey');
+
             if (a.signature && !a.signature.equals(a.witness[0]))
                 throw new TypeError('Signature mismatch');
-            if (a.pubkey && !a.pubkey.equals(a.witness[1]))
-                throw new TypeError('Pubkey mismatch');
+            if (a.pubkey && !a.pubkey.equals(a.witness[1])) throw new TypeError('Pubkey mismatch');
+
             const pkh = bcrypto.hash160(a.witness[1]);
-            if (hash.length > 0 && !hash.equals(pkh))
-                throw new TypeError('Hash mismatch');
+            if (hash.length > 0 && !hash.equals(pkh)) throw new TypeError('Hash mismatch');
         }
     }
+
     return Object.assign(o, a);
 }
-exports.p2wpkh = p2wpkh;