@btc-vision/bitcoin 6.3.1 → 6.3.3

package/src/index.d.ts

@@ -1,42 +0,0 @@
-import * as address from './address';
-import * as crypto from './crypto';
-import * as networks from './networks';
-import * as payments from './payments';
-import * as script from './script';
-import { PsbtInput as _PsbtInput, PsbtInputUpdate as _PsbtInputUpdate, PsbtOutput as _PsbtOutput, TapBip32Derivation as _TapBip32Derivation, TapInternalKey as _TapInternalKey, TapKeySig as _TapKeySig, TapLeaf as _TapLeaf, TapLeafScript as _TapLeafScript, TapMerkleRoot as _TapMerkleRoot, TapScriptSig as _TapScriptSig, TapTree as _TapTree } from 'bip174/src/lib/interfaces';
-export { address, crypto, networks, payments, script };
-export { Block } from './block';
-/** @hidden */
-export { TaggedHashPrefix } from './crypto';
-export * from './psbt';
-/** @hidden */
-export { OPS as opcodes } from './ops';
-export { Transaction } from './transaction';
-/** @hidden */
-export { Network } from './networks';
-/** @hidden */
-export { Payment, PaymentCreator, PaymentOpts, Stack, StackElement, } from './payments';
-export { Input as TxInput, Output as TxOutput } from './transaction';
-export { initEccLib } from './ecc_lib';
-export interface PsbtInput extends _PsbtInput {
-}
-export interface PsbtOutput extends _PsbtOutput {
-}
-export interface TapInternalKey extends _TapInternalKey {
-}
-export interface TapLeaf extends _TapLeaf {
-}
-export interface TapScriptSig extends _TapScriptSig {
-}
-export interface TapKeySig extends _TapKeySig {
-}
-export interface TapTree extends _TapTree {
-}
-export interface TapMerkleRoot extends _TapMerkleRoot {
-}
-export interface TapLeafScript extends _TapLeafScript {
-}
-export interface TapBip32Derivation extends _TapBip32Derivation {
-}
-export interface PsbtInputUpdate extends _PsbtInputUpdate {
-}

package/src/index.js

@@ -1,87 +0,0 @@
-'use strict';
-var __createBinding =
-    (this && this.__createBinding) ||
-    (Object.create
-        ? function (o, m, k, k2) {
-              if (k2 === undefined) k2 = k;
-              var desc = Object.getOwnPropertyDescriptor(m, k);
-              if (
-                  !desc ||
-                  ('get' in desc
-                      ? !m.__esModule
-                      : desc.writable || desc.configurable)
-              ) {
-                  desc = {
-                      enumerable: true,
-                      get: function () {
-                          return m[k];
-                      },
-                  };
-              }
-              Object.defineProperty(o, k2, desc);
-          }
-        : function (o, m, k, k2) {
-              if (k2 === undefined) k2 = k;
-              o[k2] = m[k];
-          });
-var __exportStar =
-    (this && this.__exportStar) ||
-    function (m, exports) {
-        for (var p in m)
-            if (
-                p !== 'default' &&
-                !Object.prototype.hasOwnProperty.call(exports, p)
-            )
-                __createBinding(exports, m, p);
-    };
-Object.defineProperty(exports, '__esModule', { value: true });
-exports.initEccLib =
-    exports.Transaction =
-    exports.opcodes =
-    exports.Block =
-    exports.script =
-    exports.payments =
-    exports.networks =
-    exports.crypto =
-    exports.address =
-        void 0;
-const address = require('./address');
-exports.address = address;
-const crypto = require('./crypto');
-exports.crypto = crypto;
-const networks = require('./networks');
-exports.networks = networks;
-const payments = require('./payments');
-exports.payments = payments;
-const script = require('./script');
-exports.script = script;
-var block_1 = require('./block');
-Object.defineProperty(exports, 'Block', {
-    enumerable: true,
-    get: function () {
-        return block_1.Block;
-    },
-});
-__exportStar(require('./psbt'), exports);
-/** @hidden */
-var ops_1 = require('./ops');
-Object.defineProperty(exports, 'opcodes', {
-    enumerable: true,
-    get: function () {
-        return ops_1.OPS;
-    },
-});
-var transaction_1 = require('./transaction');
-Object.defineProperty(exports, 'Transaction', {
-    enumerable: true,
-    get: function () {
-        return transaction_1.Transaction;
-    },
-});
-var ecc_lib_1 = require('./ecc_lib');
-Object.defineProperty(exports, 'initEccLib', {
-    enumerable: true,
-    get: function () {
-        return ecc_lib_1.initEccLib;
-    },
-});

package/src/merkle.d.ts

@@ -1,10 +0,0 @@
-/// <reference types="node" />
-/**
- * Calculates the Merkle root of an array of buffers using a specified digest function.
- *
- * @param values - The array of buffers.
- * @param digestFn - The digest function used to calculate the hash of the concatenated buffers.
- * @returns The Merkle root as a buffer.
- * @throws {TypeError} If the values parameter is not an array or the digestFn parameter is not a function.
- */
-export declare function fastMerkleRoot(values: Buffer[], digestFn: (b: Buffer) => Buffer): Buffer;

package/src/networks.d.ts

@@ -1,83 +0,0 @@
-/**
- * Represents a Bitcoin network configuration，including messagePrefix, bech32, bip32, pubKeyHash, scriptHash, wif.
- * Support bitcoin、bitcoin testnet and bitcoin regtest.
- * @packageDocumentation
- */
-export interface Bip32 {
-    public: number;
-    private: number;
-}
-export interface Network {
-    wif: number;
-    bip32: Bip32;
-    messagePrefix: string;
-    bech32: string;
-    pubKeyHash: number;
-    scriptHash: number;
-}
-/**
- * Represents the Bitcoin network configuration.
- */
-export declare const bitcoin: Network;
-/**
- * Represents the regtest network configuration.
- */
-export declare const regtest: Network;
-/**
- * Represents the testnet network configuration.
- */
-export declare const testnet: Network;
-/**
- * Represents the Dogecoin mainnet configuration.
- *
- * Prefixes from:
- * - P2PKH: 0x1e (30 decimal) - addresses start with 'D'
- * - P2SH: 0x16 (22 decimal) - addresses often start with '9' or 'A'
- * - WIF: 0x9e (158 decimal)
- * - BIP32:
- *   - public: 0x02facafd
- *   - private: 0x02fac398
- * Message prefix:
- *   - Dogecoin uses "\x19Dogecoin Signed Message:\n"
- */
-export declare const dogecoin: Network;
-/**
- * Represents the Dogecoin testnet configuration.
- *
- * Prefixes from Dogecoin testnet chainparams:
- * - P2PKH: 0x71 (113 decimal)
- * - P2SH: 0xc4 (196 decimal)
- * - WIF: 0xf1 (241 decimal)
- * - BIP32:
- *   - public: 0x0432a9a8
- *   - private: 0x0432a243
- * Message prefix:
- *   - Same as mainnet: "\x19Dogecoin Signed Message:\n"
- */
-export declare const dogecoinTestnet: Network;
-/**
- * Litecoin mainnet configuration.
- */
-export declare const litecoin: Network;
-/**
- * Litecoin testnet configuration.
- */
-export declare const litecoinTestnet: Network;
-/**
- * Bitcoin Cash mainnet configuration (legacy).
- * Note: Bitcoin Cash uses Cashaddr starting with 'q' or 'p',
- * but we retain the legacy prefixes for compatibility.
- */
-export declare const bitcoinCash: Network;
-/**
- * Bitcoin Cash testnet configuration (legacy).
- */
-export declare const bitcoinCashTestnet: Network;
-/**
- * Dash mainnet configuration.
- */
-export declare const dash: Network;
-/**
- * Dash testnet configuration.
- */
-export declare const dashTestnet: Network;

package/src/payments/bip341.d.ts

@@ -1,49 +0,0 @@
-/// <reference types="node" />
-import { Tapleaf, Taptree } from '../types';
-export declare const LEAF_VERSION_TAPSCRIPT = 192;
-export declare const MAX_TAPTREE_DEPTH = 128;
-interface HashLeaf {
-    hash: Buffer;
-}
-interface HashBranch {
-    hash: Buffer;
-    left: HashTree;
-    right: HashTree;
-}
-interface TweakedPublicKey {
-    parity: number;
-    x: Buffer;
-}
-/**
- * Binary tree representing leaf, branch, and root node hashes of a Taptree.
- * Each node contains a hash, and potentially left and right branch hashes.
- * This tree is used for 2 purposes: Providing the root hash for tweaking,
- * and calculating merkle inclusion proofs when constructing a control block.
- */
-export type HashTree = HashLeaf | HashBranch;
-/**
- * Calculates the root hash from a given control block and leaf hash.
- * @param controlBlock - The control block buffer.
- * @param leafHash - The leaf hash buffer.
- * @returns The root hash buffer.
- * @throws {TypeError} If the control block length is less than 33.
- */
-export declare function rootHashFromPath(controlBlock: Buffer, leafHash: Buffer): Buffer;
-/**
- * Build a hash tree of merkle nodes from the scripts binary tree.
- * @param scriptTree - the tree of scripts to pairwise hash.
- */
-export declare function toHashTree(scriptTree: Taptree): HashTree;
-/**
- * Given a HashTree, finds the path from a particular hash to the root.
- * @param node - the root of the tree
- * @param hash - the hash to search for
- * @returns - array of sibling hashes, from leaf (inclusive) to root
- * (exclusive) needed to prove inclusion of the specified hash. undefined if no
- * path is found
- */
-export declare function findScriptPath(node: HashTree, hash: Buffer): Buffer[] | undefined;
-export declare function tapleafHash(leaf: Tapleaf): Buffer;
-export declare function tapTweakHash(pubKey: Buffer, h: Buffer | undefined): Buffer;
-export declare function tweakKey(pubKey: Buffer, h: Buffer | undefined): TweakedPublicKey | null;
-export {};

package/src/payments/bip341.js

@@ -1,124 +0,0 @@
-'use strict';
-Object.defineProperty(exports, '__esModule', { value: true });
-exports.tweakKey =
-    exports.tapTweakHash =
-    exports.tapleafHash =
-    exports.findScriptPath =
-    exports.toHashTree =
-    exports.rootHashFromPath =
-    exports.MAX_TAPTREE_DEPTH =
-    exports.LEAF_VERSION_TAPSCRIPT =
-        void 0;
-const buffer_1 = require('buffer');
-const ecc_lib_1 = require('../ecc_lib');
-const bcrypto = require('../crypto');
-const bufferutils_1 = require('../bufferutils');
-const types_1 = require('../types');
-exports.LEAF_VERSION_TAPSCRIPT = 0xc0;
-exports.MAX_TAPTREE_DEPTH = 128;
-const isHashBranch = ht => 'left' in ht && 'right' in ht;
-/**
- * Calculates the root hash from a given control block and leaf hash.
- * @param controlBlock - The control block buffer.
- * @param leafHash - The leaf hash buffer.
- * @returns The root hash buffer.
- * @throws {TypeError} If the control block length is less than 33.
- */
-function rootHashFromPath(controlBlock, leafHash) {
-    if (controlBlock.length < 33)
-        throw new TypeError(
-            `The control-block length is too small. Got ${controlBlock.length}, expected min 33.`,
-        );
-    const m = (controlBlock.length - 33) / 32;
-    let kj = leafHash;
-    for (let j = 0; j < m; j++) {
-        const ej = controlBlock.slice(33 + 32 * j, 65 + 32 * j);
-        if (kj.compare(ej) < 0) {
-            kj = tapBranchHash(kj, ej);
-        } else {
-            kj = tapBranchHash(ej, kj);
-        }
-    }
-    return kj;
-}
-exports.rootHashFromPath = rootHashFromPath;
-/**
- * Build a hash tree of merkle nodes from the scripts binary tree.
- * @param scriptTree - the tree of scripts to pairwise hash.
- */
-function toHashTree(scriptTree) {
-    if ((0, types_1.isTapleaf)(scriptTree))
-        return { hash: tapleafHash(scriptTree) };
-    const hashes = [toHashTree(scriptTree[0]), toHashTree(scriptTree[1])];
-    hashes.sort((a, b) => a.hash.compare(b.hash));
-    const [left, right] = hashes;
-    return {
-        hash: tapBranchHash(left.hash, right.hash),
-        left,
-        right,
-    };
-}
-exports.toHashTree = toHashTree;
-/**
- * Given a HashTree, finds the path from a particular hash to the root.
- * @param node - the root of the tree
- * @param hash - the hash to search for
- * @returns - array of sibling hashes, from leaf (inclusive) to root
- * (exclusive) needed to prove inclusion of the specified hash. undefined if no
- * path is found
- */
-function findScriptPath(node, hash) {
-    if (isHashBranch(node)) {
-        const leftPath = findScriptPath(node.left, hash);
-        if (leftPath !== undefined) return [...leftPath, node.right.hash];
-        const rightPath = findScriptPath(node.right, hash);
-        if (rightPath !== undefined) return [...rightPath, node.left.hash];
-    } else if (node.hash.equals(hash)) {
-        return [];
-    }
-    return undefined;
-}
-exports.findScriptPath = findScriptPath;
-function tapleafHash(leaf) {
-    const version = leaf.version || exports.LEAF_VERSION_TAPSCRIPT;
-    return bcrypto.taggedHash(
-        'TapLeaf',
-        buffer_1.Buffer.concat([
-            buffer_1.Buffer.from([version]),
-            serializeScript(leaf.output),
-        ]),
-    );
-}
-exports.tapleafHash = tapleafHash;
-function tapTweakHash(pubKey, h) {
-    return bcrypto.taggedHash(
-        'TapTweak',
-        buffer_1.Buffer.concat(h ? [pubKey, h] : [pubKey]),
-    );
-}
-exports.tapTweakHash = tapTweakHash;
-function tweakKey(pubKey, h) {
-    if (!buffer_1.Buffer.isBuffer(pubKey)) return null;
-    if (pubKey.length !== 32) return null;
-    if (h && h.length !== 32) return null;
-    const tweakHash = tapTweakHash(pubKey, h);
-    const res = (0, ecc_lib_1.getEccLib)().xOnlyPointAddTweak(
-        pubKey,
-        tweakHash,
-    );
-    if (!res || res.xOnlyPubkey === null) return null;
-    return {
-        parity: res.parity,
-        x: buffer_1.Buffer.from(res.xOnlyPubkey),
-    };
-}
-exports.tweakKey = tweakKey;
-function tapBranchHash(a, b) {
-    return bcrypto.taggedHash('TapBranch', buffer_1.Buffer.concat([a, b]));
-}
-function serializeScript(s) {
-    const varintLen = bufferutils_1.varuint.encodingLength(s.length);
-    const buffer = buffer_1.Buffer.allocUnsafe(varintLen); // better
-    bufferutils_1.varuint.encode(s.length, buffer);
-    return buffer_1.Buffer.concat([buffer, s]);
-}

package/src/payments/embed.d.ts

@@ -1,9 +0,0 @@
-import { Payment, PaymentOpts } from './index';
-/**
- * Embeds data in a Bitcoin payment.
- * @param a - The payment object.
- * @param opts - Optional payment options.
- * @returns The modified payment object.
- * @throws {TypeError} If there is not enough data or if the output is invalid.
- */
-export declare function p2data(a: Payment, opts?: PaymentOpts): Payment;

package/src/payments/embed.js

@@ -1,54 +0,0 @@
-'use strict';
-Object.defineProperty(exports, '__esModule', { value: true });
-exports.p2data = void 0;
-const networks_1 = require('../networks');
-const bscript = require('../script');
-const types_1 = require('../types');
-const lazy = require('./lazy');
-const OPS = bscript.OPS;
-// output: OP_RETURN ...
-/**
- * Embeds data in a Bitcoin payment.
- * @param a - The payment object.
- * @param opts - Optional payment options.
- * @returns The modified payment object.
- * @throws {TypeError} If there is not enough data or if the output is invalid.
- */
-function p2data(a, opts) {
-    if (!a.data && !a.output) 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),
-            output: types_1.typeforce.maybe(types_1.typeforce.Buffer),
-            data: types_1.typeforce.maybe(
-                types_1.typeforce.arrayOf(types_1.typeforce.Buffer),
-            ),
-        },
-        a,
-    );
-    const network = a.network || networks_1.bitcoin;
-    const o = { name: 'embed', network };
-    lazy.prop(o, 'output', () => {
-        if (!a.data) return;
-        return bscript.compile([OPS.OP_RETURN].concat(a.data));
-    });
-    lazy.prop(o, 'data', () => {
-        if (!a.output) return;
-        return bscript.decompile(a.output).slice(1);
-    });
-    // extended validation
-    if (opts.validate) {
-        if (a.output) {
-            const chunks = bscript.decompile(a.output);
-            if (chunks[0] !== OPS.OP_RETURN)
-                throw new TypeError('Output is invalid');
-            if (!chunks.slice(1).every(types_1.typeforce.Buffer))
-                throw new TypeError('Output is invalid');
-            if (a.data && !(0, types_1.stacksEqual)(a.data, o.data))
-                throw new TypeError('Data mismatch');
-        }
-    }
-    return Object.assign(o, a);
-}
-exports.p2data = p2data;

package/src/payments/index.js

@@ -1,69 +0,0 @@
-'use strict';
-Object.defineProperty(exports, '__esModule', { value: true });
-exports.p2tr =
-    exports.p2wsh =
-    exports.p2wpkh =
-    exports.p2sh =
-    exports.p2pkh =
-    exports.p2pk =
-    exports.p2ms =
-    exports.embed =
-        void 0;
-const embed_1 = require('./embed');
-Object.defineProperty(exports, 'embed', {
-    enumerable: true,
-    get: function () {
-        return embed_1.p2data;
-    },
-});
-const p2ms_1 = require('./p2ms');
-Object.defineProperty(exports, 'p2ms', {
-    enumerable: true,
-    get: function () {
-        return p2ms_1.p2ms;
-    },
-});
-const p2pk_1 = require('./p2pk');
-Object.defineProperty(exports, 'p2pk', {
-    enumerable: true,
-    get: function () {
-        return p2pk_1.p2pk;
-    },
-});
-const p2pkh_1 = require('./p2pkh');
-Object.defineProperty(exports, 'p2pkh', {
-    enumerable: true,
-    get: function () {
-        return p2pkh_1.p2pkh;
-    },
-});
-const p2sh_1 = require('./p2sh');
-Object.defineProperty(exports, 'p2sh', {
-    enumerable: true,
-    get: function () {
-        return p2sh_1.p2sh;
-    },
-});
-const p2wpkh_1 = require('./p2wpkh');
-Object.defineProperty(exports, 'p2wpkh', {
-    enumerable: true,
-    get: function () {
-        return p2wpkh_1.p2wpkh;
-    },
-});
-const p2wsh_1 = require('./p2wsh');
-Object.defineProperty(exports, 'p2wsh', {
-    enumerable: true,
-    get: function () {
-        return p2wsh_1.p2wsh;
-    },
-});
-const p2tr_1 = require('./p2tr');
-Object.defineProperty(exports, 'p2tr', {
-    enumerable: true,
-    get: function () {
-        return p2tr_1.p2tr;
-    },
-});
-// TODO
-// witness commitment

package/src/payments/p2ms.d.ts

@@ -1,9 +0,0 @@
-import { Payment, PaymentOpts } from './index';
-/**
- * Represents a function that creates a Pay-to-Multisig (P2MS) payment object.
- * @param a - The payment object.
- * @param opts - Optional payment options.
- * @returns The created payment object.
- * @throws {TypeError} If the provided data is not valid.
- */
-export declare function p2ms(a: Payment, opts?: PaymentOpts): Payment;

package/src/payments/p2pk.d.ts

@@ -1,10 +0,0 @@
-import { Payment, PaymentOpts } from './index';
-/**
- * Creates a pay-to-public-key (P2PK) payment object.
- *
- * @param a - The payment object containing the necessary data.
- * @param opts - Optional payment options.
- * @returns The P2PK payment object.
- * @throws {TypeError} If the required data is not provided or if the data is invalid.
- */
-export declare function p2pk(a: Payment, opts?: PaymentOpts): Payment;

package/src/payments/p2pkh.d.ts

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