@btc-vision/bitcoin 6.4.2 → 6.4.3

package/browser/payments/embed.d.ts

@@ -1,2 +1,2 @@
-import { Payment, PaymentOpts } from './index.js';
-export declare function p2data(a: Payment, opts?: PaymentOpts): Payment;
+import { EmbedPayment, PaymentOpts } from './index.js';
+export declare function p2data(a: Omit<EmbedPayment, 'name'>, opts?: PaymentOpts): EmbedPayment;

package/browser/payments/index.d.ts

@@ -11,33 +11,78 @@ export * from './p2tr.js';
 export * from './p2wpkh.js';
 export * from './p2wsh.js';
 export * from './p2op.js';
-export interface Payment {
+export interface BasePayment {
     name?: string;
     network?: Network;
     output?: Buffer;
-    data?: Buffer[];
+    input?: Buffer;
+    address?: string;
+    witness?: Buffer[];
+    redeem?: ScriptRedeem;
+    useHybrid?: boolean;
+    useUncompressed?: boolean;
+}
+export interface ScriptRedeem extends BasePayment {
+    output?: Buffer;
+    redeemVersion?: number;
+    network?: Network;
+}
+export interface P2PKPayment extends BasePayment {
+    name: 'p2pk';
+    pubkey?: Buffer;
+    signature?: Buffer;
+}
+export interface P2PKHPayment extends BasePayment {
+    name: 'p2pkh';
+    hash?: Buffer;
+    pubkey?: Buffer;
+    signature?: Buffer;
+}
+export interface P2SHPayment extends BasePayment {
+    name: 'p2sh';
+    hash?: Buffer;
+    signatures?: Buffer[];
+}
+export interface P2MSPayment extends BasePayment {
+    name: 'p2ms';
     m?: number;
     n?: number;
     pubkeys?: Buffer[];
-    input?: Buffer;
     signatures?: Buffer[];
-    internalPubkey?: Buffer;
+}
+export interface P2WPKHPayment extends BasePayment {
+    name: 'p2wpkh';
+    hash?: Buffer;
     pubkey?: Buffer;
     signature?: Buffer;
-    address?: string;
+}
+export interface P2WSHPayment extends BasePayment {
+    name: 'p2wsh';
+    hash?: Buffer;
+    redeem?: ScriptRedeem;
+}
+export interface P2TRPayment extends BasePayment {
+    name: 'p2tr';
+    pubkey?: Buffer;
+    internalPubkey?: Buffer;
     hash?: Buffer;
-    redeem?: Payment;
-    redeemVersion?: number;
     scriptTree?: Taptree;
-    witness?: Buffer[];
-    useHybrid?: boolean;
-    useUncompressed?: boolean;
+    signature?: Buffer;
+    redeemVersion?: number;
+    redeem?: ScriptRedeem;
+}
+export interface P2OPPayment extends BasePayment {
+    name: 'p2op';
     program?: Buffer;
-    deploymentVersion?: number;
+    deploymentVersion: number | undefined;
     hash160?: Buffer;
 }
-export type PaymentCreator = (a: Payment, opts?: PaymentOpts) => Payment;
-export type PaymentFunction = () => Payment;
+export interface EmbedPayment extends BasePayment {
+    name: 'embed';
+    data: Buffer[];
+}
+export type Payment = P2PKPayment | P2PKHPayment | P2SHPayment | P2MSPayment | P2WPKHPayment | P2WSHPayment | P2TRPayment | P2OPPayment | EmbedPayment | ScriptRedeem;
+export type PaymentCreator = <T extends BasePayment>(a: T, opts?: PaymentOpts) => T;
 export interface PaymentOpts {
     validate?: boolean;
     allowIncomplete?: boolean;

package/browser/payments/lazy.d.ts

@@ -1,2 +1,2 @@
-export declare function prop(object: {}, name: string, f: () => any): void;
+export declare function prop<T extends {}>(object: T, name: string, f: () => T[keyof T]): void;
 export declare function value<T>(f: () => T): () => T;

package/browser/payments/p2ms.d.ts

@@ -1,2 +1,2 @@
-import { Payment, PaymentOpts } from './index.js';
-export declare function p2ms(a: Payment, opts?: PaymentOpts): Payment;
+import { P2MSPayment, PaymentOpts } from './index.js';
+export declare function p2ms(a: Omit<P2MSPayment, 'name'>, opts?: PaymentOpts): P2MSPayment;

package/browser/payments/p2op.d.ts

@@ -1,2 +1,25 @@
-import { Payment, PaymentOpts } from './index.js';
-export declare function p2op(a: Payment, opts?: PaymentOpts): Payment;
+import { BasePayment, P2OPPayment, PaymentOpts } from './index.js';
+interface P2OPBase extends BasePayment {
+    name: 'p2op';
+}
+interface P2OP_fromOutput extends P2OPBase {
+    output: Buffer;
+    program?: undefined;
+    deploymentVersion?: undefined;
+    hash160?: undefined;
+}
+interface P2OP_fromProgram extends P2OPBase {
+    program: Buffer;
+    output?: undefined;
+    deploymentVersion?: never;
+    hash160?: never;
+}
+interface P2OP_fromParts extends P2OPBase {
+    deploymentVersion: number;
+    hash160: Buffer;
+    output?: undefined;
+    program?: undefined;
+}
+export type P2OPPaymentParams = P2OP_fromOutput | P2OP_fromProgram | P2OP_fromParts;
+export declare function p2op(a: Omit<P2OPPaymentParams, 'name'>, opts?: PaymentOpts): P2OPPayment;
+export {};

package/browser/payments/p2pk.d.ts

@@ -1,2 +1,2 @@
-import { Payment, PaymentOpts } from './index.js';
-export declare function p2pk(a: Payment, opts?: PaymentOpts): Payment;
+import { P2PKPayment, PaymentOpts } from './index.js';
+export declare function p2pk(a: Omit<P2PKPayment, 'name'>, opts?: PaymentOpts): P2PKPayment;

package/browser/payments/p2pkh.d.ts

@@ -1,2 +1,2 @@
-import { Payment, PaymentOpts } from './index.js';
-export declare function p2pkh(a: Payment, opts?: PaymentOpts): Payment;
+import { P2PKHPayment, PaymentOpts } from './index.js';
+export declare function p2pkh(a: Omit<P2PKHPayment, 'name'>, opts?: PaymentOpts): P2PKHPayment;

package/browser/payments/p2sh.d.ts

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

package/browser/payments/p2tr.d.ts

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

package/browser/payments/p2wpkh.d.ts

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

package/browser/payments/p2wsh.d.ts

@@ -1,2 +1,2 @@
-import { Payment, PaymentOpts } from './index.js';
-export declare function p2wsh(a: Payment, opts?: PaymentOpts): Payment;
+import { P2WSHPayment, PaymentOpts } from './index.js';
+export declare function p2wsh(a: Omit<P2WSHPayment, 'name'>, opts?: PaymentOpts): P2WSHPayment;

package/build/address.js

@@ -181,7 +181,6 @@ export function toOutputScript(address, network) {
                     throw new Error(address + ' has an invalid prefix');
                 return payments.p2op({
                     program: decodeBech32.data,
-                    deploymentVersion: decodeBech32.version,
                     network,
                 }).output;
             }

package/build/payments/embed.d.ts

@@ -1,2 +1,2 @@
-import { Payment, PaymentOpts } from './index.js';
-export declare function p2data(a: Payment, opts?: PaymentOpts): Payment;
+import { EmbedPayment, PaymentOpts } from './index.js';
+export declare function p2data(a: Omit<EmbedPayment, 'name'>, opts?: PaymentOpts): EmbedPayment;

package/build/payments/embed.js

@@ -13,7 +13,7 @@ export function p2data(a, opts) {
         data: typef.maybe(typef.arrayOf(typef.Buffer)),
     }, a);
     const network = a.network || BITCOIN_NETWORK;
-    const o = { name: 'embed', network };
+    const o = { name: 'embed', network, data: [] };
     lazy.prop(o, 'output', () => {
         if (!a.data)
             return;
@@ -22,7 +22,11 @@ export function p2data(a, opts) {
     lazy.prop(o, 'data', () => {
         if (!a.output)
             return;
-        return bscript.decompile(a.output).slice(1);
+        const script = bscript.decompile(a.output);
+        if (script === null || script === undefined) {
+            return;
+        }
+        return script.slice(1);
     });
     if (opts.validate) {
         if (a.output) {

package/build/payments/index.d.ts

@@ -11,33 +11,78 @@ export * from './p2tr.js';
 export * from './p2wpkh.js';
 export * from './p2wsh.js';
 export * from './p2op.js';
-export interface Payment {
+export interface BasePayment {
     name?: string;
     network?: Network;
     output?: Buffer;
-    data?: Buffer[];
+    input?: Buffer;
+    address?: string;
+    witness?: Buffer[];
+    redeem?: ScriptRedeem;
+    useHybrid?: boolean;
+    useUncompressed?: boolean;
+}
+export interface ScriptRedeem extends BasePayment {
+    output?: Buffer;
+    redeemVersion?: number;
+    network?: Network;
+}
+export interface P2PKPayment extends BasePayment {
+    name: 'p2pk';
+    pubkey?: Buffer;
+    signature?: Buffer;
+}
+export interface P2PKHPayment extends BasePayment {
+    name: 'p2pkh';
+    hash?: Buffer;
+    pubkey?: Buffer;
+    signature?: Buffer;
+}
+export interface P2SHPayment extends BasePayment {
+    name: 'p2sh';
+    hash?: Buffer;
+    signatures?: Buffer[];
+}
+export interface P2MSPayment extends BasePayment {
+    name: 'p2ms';
     m?: number;
     n?: number;
     pubkeys?: Buffer[];
-    input?: Buffer;
     signatures?: Buffer[];
-    internalPubkey?: Buffer;
+}
+export interface P2WPKHPayment extends BasePayment {
+    name: 'p2wpkh';
+    hash?: Buffer;
     pubkey?: Buffer;
     signature?: Buffer;
-    address?: string;
+}
+export interface P2WSHPayment extends BasePayment {
+    name: 'p2wsh';
+    hash?: Buffer;
+    redeem?: ScriptRedeem;
+}
+export interface P2TRPayment extends BasePayment {
+    name: 'p2tr';
+    pubkey?: Buffer;
+    internalPubkey?: Buffer;
     hash?: Buffer;
-    redeem?: Payment;
-    redeemVersion?: number;
     scriptTree?: Taptree;
-    witness?: Buffer[];
-    useHybrid?: boolean;
-    useUncompressed?: boolean;
+    signature?: Buffer;
+    redeemVersion?: number;
+    redeem?: ScriptRedeem;
+}
+export interface P2OPPayment extends BasePayment {
+    name: 'p2op';
     program?: Buffer;
-    deploymentVersion?: number;
+    deploymentVersion: number | undefined;
     hash160?: Buffer;
 }
-export type PaymentCreator = (a: Payment, opts?: PaymentOpts) => Payment;
-export type PaymentFunction = () => Payment;
+export interface EmbedPayment extends BasePayment {
+    name: 'embed';
+    data: Buffer[];
+}
+export type Payment = P2PKPayment | P2PKHPayment | P2SHPayment | P2MSPayment | P2WPKHPayment | P2WSHPayment | P2TRPayment | P2OPPayment | EmbedPayment | ScriptRedeem;
+export type PaymentCreator = <T extends BasePayment>(a: T, opts?: PaymentOpts) => T;
 export interface PaymentOpts {
     validate?: boolean;
     allowIncomplete?: boolean;

package/build/payments/lazy.d.ts

@@ -1,2 +1,2 @@
-export declare function prop(object: {}, name: string, f: () => any): void;
+export declare function prop<T extends {}>(object: T, name: string, f: () => T[keyof T]): void;
 export declare function value<T>(f: () => T): () => T;

package/build/payments/p2ms.d.ts

@@ -1,2 +1,2 @@
-import { Payment, PaymentOpts } from './index.js';
-export declare function p2ms(a: Payment, opts?: PaymentOpts): Payment;
+import { P2MSPayment, PaymentOpts } from './index.js';
+export declare function p2ms(a: Omit<P2MSPayment, 'name'>, opts?: PaymentOpts): P2MSPayment;

package/build/payments/p2ms.js

@@ -22,7 +22,10 @@ export function p2ms(a, opts) {
         input: typef.maybe(typef.Buffer),
     }, a);
     const network = a.network || BITCOIN_NETWORK;
-    const o = { network };
+    const o = {
+        network,
+        name: 'p2ms',
+    };
     let chunks = [];
     let decoded = false;
     function decode(output) {
@@ -63,7 +66,10 @@ export function p2ms(a, opts) {
     lazy.prop(o, 'signatures', () => {
         if (!a.input)
             return;
-        return bscript.decompile(a.input).slice(1);
+        const decompiled = bscript.decompile(a.input);
+        if (decompiled === null || decompiled === undefined)
+            return;
+        return decompiled.slice(1);
     });
     lazy.prop(o, 'input', () => {
         if (!a.signatures)

package/build/payments/p2op.d.ts

@@ -1,2 +1,25 @@
-import { Payment, PaymentOpts } from './index.js';
-export declare function p2op(a: Payment, opts?: PaymentOpts): Payment;
+import { BasePayment, P2OPPayment, PaymentOpts } from './index.js';
+interface P2OPBase extends BasePayment {
+    name: 'p2op';
+}
+interface P2OP_fromOutput extends P2OPBase {
+    output: Buffer;
+    program?: undefined;
+    deploymentVersion?: undefined;
+    hash160?: undefined;
+}
+interface P2OP_fromProgram extends P2OPBase {
+    program: Buffer;
+    output?: undefined;
+    deploymentVersion?: never;
+    hash160?: never;
+}
+interface P2OP_fromParts extends P2OPBase {
+    deploymentVersion: number;
+    hash160: Buffer;
+    output?: undefined;
+    program?: undefined;
+}
+export type P2OPPaymentParams = P2OP_fromOutput | P2OP_fromProgram | P2OP_fromParts;
+export declare function p2op(a: Omit<P2OPPaymentParams, 'name'>, opts?: PaymentOpts): P2OPPayment;
+export {};

package/build/payments/p2op.js

@@ -23,7 +23,11 @@ export function p2op(a, opts) {
     }, a);
     const _address = lazy.value(() => fromBech32(a.address));
     const network = a.network || BITCOIN_NETWORK;
-    const o = { name: 'p2op', network };
+    const o = {
+        name: 'p2op',
+        network,
+        deploymentVersion: 0,
+    };
     lazy.prop(o, 'program', () => {
         if (a.program)
             return a.program;

package/build/payments/p2pk.d.ts

@@ -1,2 +1,2 @@
-import { Payment, PaymentOpts } from './index.js';
-export declare function p2pk(a: Payment, opts?: PaymentOpts): Payment;
+import { P2PKPayment, PaymentOpts } from './index.js';
+export declare function p2pk(a: Omit<P2PKPayment, 'name'>, opts?: PaymentOpts): P2PKPayment;

package/build/payments/p2pk.js

@@ -18,7 +18,11 @@ export function p2pk(a, opts) {
         return bscript.decompile(a.input);
     });
     const network = a.network || BITCOIN_NETWORK;
-    const o = { name: 'p2pk', network };
+    const o = {
+        name: 'p2pk',
+        network,
+        pubkey: undefined,
+    };
     lazy.prop(o, 'output', () => {
         if (!a.pubkey)
             return;

package/build/payments/p2pkh.d.ts

@@ -1,2 +1,2 @@
-import { Payment, PaymentOpts } from './index.js';
-export declare function p2pkh(a: Payment, opts?: PaymentOpts): Payment;
+import { P2PKHPayment, PaymentOpts } from './index.js';
+export declare function p2pkh(a: Omit<P2PKHPayment, 'name'>, opts?: PaymentOpts): P2PKHPayment;

package/build/payments/p2pkh.js

@@ -30,7 +30,11 @@ export function p2pkh(a, opts) {
         return bscript.decompile(a.input);
     });
     const network = a.network || BITCOIN_NETWORK;
-    const o = { name: 'p2pkh', network };
+    const o = {
+        name: 'p2pkh',
+        network,
+        hash: undefined,
+    };
     lazy.prop(o, 'address', () => {
         if (!o.hash)
             return;

package/build/payments/p2sh.d.ts

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

package/build/payments/p2sh.js

@@ -28,7 +28,11 @@ export function p2sh(a, opts) {
     if (!network) {
         network = (a.redeem && a.redeem.network) || BITCOIN_NETWORK;
     }
-    const o = { network };
+    const o = {
+        network,
+        name: 'p2sh',
+        hash: undefined,
+    };
     const _address = lazy.value(() => {
         const payload = Buffer.from(bs58check.default.decode(a.address));
         const version = payload.readUInt8(0);

package/build/payments/p2tr.d.ts

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

package/build/payments/p2tr.js

@@ -55,7 +55,10 @@ export function p2tr(a, opts) {
         return;
     });
     const network = a.network || BITCOIN_NETWORK;
-    const o = { name: 'p2tr', network };
+    const o = {
+        name: 'p2tr',
+        network,
+    };
     lazy.prop(o, 'address', () => {
         if (!o.pubkey)
             return;
@@ -78,7 +81,7 @@ export function p2tr(a, opts) {
             });
             return rootHashFromPath(controlBlock, leafHash);
         }
-        return null;
+        return undefined;
     });
     lazy.prop(o, 'output', () => {
         if (!o.pubkey)

package/build/payments/p2wpkh.d.ts

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

package/build/payments/p2wpkh.js

@@ -31,7 +31,11 @@ export function p2wpkh(a, opts) {
         };
     });
     const network = a.network || BITCOIN_NETWORK;
-    const o = { name: 'p2wpkh', network };
+    const o = {
+        name: 'p2wpkh',
+        network,
+        hash: undefined,
+    };
     lazy.prop(o, 'address', () => {
         if (!o.hash)
             return;

package/build/payments/p2wsh.d.ts

@@ -1,2 +1,2 @@
-import { Payment, PaymentOpts } from './index.js';
-export declare function p2wsh(a: Payment, opts?: PaymentOpts): Payment;
+import { P2WSHPayment, PaymentOpts } from './index.js';
+export declare function p2wsh(a: Omit<P2WSHPayment, 'name'>, opts?: PaymentOpts): P2WSHPayment;

package/build/payments/p2wsh.js

@@ -49,7 +49,11 @@ export function p2wsh(a, opts) {
     if (!network) {
         network = (a.redeem && a.redeem.network) || BITCOIN_NETWORK;
     }
-    const o = { network };
+    const o = {
+        network,
+        name: 'p2wsh',
+        hash: undefined,
+    };
     lazy.prop(o, 'address', () => {
         if (!o.hash)
             return;

package/build/psbt.js

@@ -676,7 +676,9 @@ function canFinalize(input, script, scriptType) {
         case 'witnesspubkeyhash':
             return hasSigs(1, input.partialSig);
         case 'multisig':
-            const p2ms = payments.p2ms({ output: script });
+            const p2ms = payments.p2ms({
+                output: script,
+            });
             return hasSigs(p2ms.m, input.partialSig, p2ms.pubkeys);
         case 'nonstandard':
             return true;

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@btc-vision/bitcoin",
     "type": "module",
-    "version": "6.4.2",
+    "version": "6.4.3",
     "description": "Client-side Bitcoin JavaScript library",
     "engines": {
         "node": ">=16.0.0"