@btc-vision/bitcoin 6.4.3 → 6.4.5

package/src/payments/p2op.ts

@@ -1,170 +1,195 @@
-import { bech32m } from 'bech32';
-import { Buffer as NBuffer } from 'buffer';
-import { fromBech32 } from '../address.js';
-import { bitcoin as BITCOIN_NETWORK, Network } from '../networks.js';
-import * as bscript from '../script.js';
-import { typeforce as typef } from '../types.js';
-import * as lazy from './lazy.js';
-import { BasePayment, P2OPPayment, PaymentOpts } from './index.js';
-
-const OPS = bscript.OPS;
-const P2OP_WITNESS_VERSION = 0x10;
-const MIN_SIZE = 2;
-const MAX_SIZE = 40;
-
-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;
-
-/**
- * Pay-to-OPNet (P2OP) decoder / encoder.
- *
- *   ▪ witness program =    <deploymentVersion:uint8><hash160:20-bytes|...>
- *   ▪ scriptPubKey   = OP_16 <program>
- *   ▪ address HRP    = network.bech32Opnet, encoded with Bech32m
- *
- * Accepts any combination of { address, output, program }  and returns a
- * fully lazy payment object, mirroring the style of `p2tr`.
- */
-export function p2op(a: Omit<P2OPPaymentParams, 'name'>, opts?: PaymentOpts): P2OPPayment {
-    if (!a.address && !a.output && !a.program) throw new TypeError('Not enough data for p2op');
-
-    opts = Object.assign({ validate: true }, opts || {});
-
-    typef(
-        {
-            address: typef.maybe(typef.String),
-            output: typef.maybe(typef.Buffer),
-            program: typef.maybe(typef.Buffer),
-            network: typef.maybe(typef.Object),
-            deploymentVersion: typef.maybe(typef.Number),
-            hash160: typef.maybe(typef.BufferN(20)),
-        },
-        a,
-    );
-
-    const _address = lazy.value(() => fromBech32(a.address!));
-
-    const network: Network = a.network || BITCOIN_NETWORK;
-    const o: P2OPPayment = {
-        name: 'p2op',
-        network,
-        deploymentVersion: 0,
-    };
-
-    lazy.prop(o, 'program', () => {
-        if (a.program) return a.program;
-
-        if (a.output) {
-            if (a.output[0] !== OPS.OP_16) throw new TypeError('Invalid P2OP script');
-            let pushPos = 1,
-                progLen: number;
-            if (a.output[1] < 0x4c) {
-                progLen = a.output[1];
-                pushPos = 2;
-            } else if (a.output[1] === 0x4c) {
-                progLen = a.output[2];
-                pushPos = 3;
-            } else {
-                throw new TypeError('Unsupported push opcode in P2OP script');
-            }
-            return a.output.slice(pushPos, pushPos + progLen);
-        }
-
-        if (a.address) {
-            const dec = _address();
-            return dec.data;
-        }
-    });
-
-    lazy.prop(o, 'deploymentVersion', () => {
-        if (!o.program) return;
-        return o.program[0];
-    });
-
-    lazy.prop(o, 'hash160', () => {
-        if (!o.program) return;
-        return o.program.slice(1);
-    });
-
-    lazy.prop(o, 'output', () => {
-        if (!o.program) return;
-        return bscript.compile([OPS.OP_16, o.program]);
-    });
-
-    lazy.prop(o, 'address', () => {
-        if (!o.program) return;
-        if (!network.bech32Opnet) {
-            throw new TypeError('Network does not support opnet');
-        }
-
-        const words = bech32m.toWords(o.program);
-        words.unshift(P2OP_WITNESS_VERSION);
-
-        return bech32m.encode(network.bech32Opnet, words);
-    });
-
-    // extended validation
-    if (opts.validate) {
-        let prog: Buffer = NBuffer.alloc(0);
-
-        if (a.address) {
-            const dec = _address();
-            if (network.bech32Opnet !== dec.prefix)
-                throw new TypeError('Invalid prefix or network mismatch');
-            if (dec.version !== P2OP_WITNESS_VERSION)
-                throw new TypeError('Invalid witness version for p2op');
-            if (dec.data.length < MIN_SIZE || dec.data.length > MAX_SIZE)
-                throw new TypeError('Invalid witness program length');
-            prog = dec.data;
-        }
-
-        if (a.program) {
-            if (prog.length && !prog.equals(a.program)) throw new TypeError('Program mismatch');
-            prog = a.program;
-        }
-
-        if (a.output) {
-            const outProg = o.program!;
-            if (prog.length && !prog.equals(outProg))
-                throw new TypeError('Program mismatch (output vs other source)');
-            prog = outProg;
-        }
-
-        if (prog.length < MIN_SIZE || prog.length > MAX_SIZE)
-            throw new TypeError('Witness program must be 2–40 bytes');
-
-        if (a.deploymentVersion !== undefined && a.deploymentVersion !== prog[0])
-            throw new TypeError('deploymentVersion mismatch');
-
-        if (a.hash160 && !a.hash160.equals(prog.slice(1))) throw new TypeError('hash160 mismatch');
-    }
-
-    return Object.assign(o, a);
-}
+import { bech32m } from 'bech32';
+import { Buffer as NBuffer } from 'buffer';
+import { fromBech32 } from '../address.js';
+import { bitcoin as BITCOIN_NETWORK, Network } from '../networks.js';
+import * as bscript from '../script.js';
+import { typeforce as typef } from '../types.js';
+import * as lazy from './lazy.js';
+import { BasePayment, P2OPPayment, PaymentOpts, PaymentType } from './index.js';
+
+const OPS = bscript.OPS;
+const P2OP_WITNESS_VERSION = 0x10;
+const MIN_SIZE = 2;
+const MAX_SIZE = 40;
+
+interface P2OPBase extends BasePayment {
+    name: PaymentType.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;
+
+/**
+ * Pay-to-OPNet (P2OP) decoder / encoder.
+ *
+ *   ▪ witness program =    <deploymentVersion:uint8><hash160:20-bytes|...>
+ *   ▪ scriptPubKey   = OP_16 <program>
+ *   ▪ address HRP    = network.bech32Opnet, encoded with Bech32m
+ *
+ * Accepts any combination of { address, output, program }  and returns a
+ * fully lazy payment object, mirroring the style of `p2tr`.
+ */
+export function p2op(a: Omit<P2OPPaymentParams, 'name'>, opts?: PaymentOpts): P2OPPayment {
+    if (
+        !a.address &&
+        !a.output &&
+        !a.program &&
+        (typeof a.deploymentVersion === 'undefined' || !a.hash160)
+    ) {
+        throw new TypeError('At least one of address, output or program must be provided');
+    }
+
+    opts = Object.assign({ validate: true }, opts || {});
+
+    typef(
+        {
+            address: typef.maybe(typef.String),
+            output: typef.maybe(typef.Buffer),
+            program: typef.maybe(typef.Buffer),
+            network: typef.maybe(typef.Object),
+            deploymentVersion: typef.maybe(typef.Number),
+            hash160: typef.maybe(typef.BufferN(20)),
+        },
+        a,
+    );
+
+    const makeProgramFromParts = (): Buffer | undefined => {
+        if (typeof a.deploymentVersion !== 'undefined' && typeof a.hash160 !== 'undefined') {
+            if (a.hash160.length !== 20) throw new TypeError('hash160 must be exactly 20 bytes');
+            if (a.deploymentVersion < 0 || a.deploymentVersion > 0xff)
+                throw new TypeError('deploymentVersion must fit in one byte');
+            return Buffer.concat([Buffer.of(a.deploymentVersion), a.hash160]);
+        }
+        return undefined;
+    };
+
+    const _address = lazy.value(() => fromBech32(a.address!));
+
+    const network: Network = a.network || BITCOIN_NETWORK;
+    const o: P2OPPayment = {
+        name: PaymentType.P2OP,
+        network,
+        deploymentVersion: 0,
+    };
+
+    lazy.prop(o, 'program', () => {
+        if (a.program) return a.program;
+
+        // NEW: build from deploymentVersion+hash160
+        const fromParts = makeProgramFromParts();
+        if (fromParts) return fromParts;
+
+        if (a.output) {
+            if (a.output[0] !== OPS.OP_16) throw new TypeError('Invalid P2OP script');
+            let pushPos = 1,
+                progLen: number;
+            if (a.output[1] < 0x4c) {
+                progLen = a.output[1];
+                pushPos = 2;
+            } else if (a.output[1] === 0x4c) {
+                progLen = a.output[2];
+                pushPos = 3;
+            } else {
+                throw new TypeError('Unsupported push opcode in P2OP script');
+            }
+            return a.output.slice(pushPos, pushPos + progLen);
+        }
+
+        if (a.address) {
+            const dec = _address();
+            return dec.data;
+        }
+    });
+
+    lazy.prop(o, 'deploymentVersion', () => {
+        if (!o.program) return;
+        return o.program[0];
+    });
+
+    lazy.prop(o, 'hash160', () => {
+        if (!o.program) return;
+        return o.program.slice(1);
+    });
+
+    lazy.prop(o, 'output', () => {
+        if (!o.program) return;
+        return bscript.compile([OPS.OP_16, o.program]);
+    });
+
+    lazy.prop(o, 'address', () => {
+        if (!o.program) return;
+        if (!network.bech32Opnet) {
+            throw new TypeError('Network does not support opnet');
+        }
+
+        const words = bech32m.toWords(o.program);
+        words.unshift(P2OP_WITNESS_VERSION);
+
+        return bech32m.encode(network.bech32Opnet, words);
+    });
+
+    // extended validation
+    if (opts.validate) {
+        let prog: Buffer = NBuffer.alloc(0);
+
+        if (a.address) {
+            const dec = _address();
+            if (network.bech32Opnet !== dec.prefix)
+                throw new TypeError('Invalid prefix or network mismatch');
+            if (dec.version !== P2OP_WITNESS_VERSION)
+                throw new TypeError('Invalid witness version for p2op');
+            if (dec.data.length < MIN_SIZE || dec.data.length > MAX_SIZE)
+                throw new TypeError('Invalid witness program length');
+            prog = dec.data;
+        }
+
+        if (a.program) {
+            if (prog.length && !prog.equals(a.program)) throw new TypeError('Program mismatch');
+            prog = a.program;
+        }
+
+        if (!prog.length && a.deploymentVersion !== undefined && a.hash160) {
+            prog = makeProgramFromParts()!;
+        }
+
+        if (a.output) {
+            const outProg = o.program!;
+            if (prog.length && !prog.equals(outProg))
+                throw new TypeError('Program mismatch (output vs other source)');
+            prog = outProg;
+        }
+
+        if (prog.length < MIN_SIZE || prog.length > MAX_SIZE)
+            throw new TypeError(`Witness program must be 2–40 bytes. Was ${prog.length} bytes`);
+
+        if (a.deploymentVersion !== undefined && a.deploymentVersion !== prog[0])
+            throw new TypeError('deploymentVersion mismatch');
+
+        if (a.hash160 && !a.hash160.equals(prog.slice(1))) throw new TypeError('hash160 mismatch');
+    }
+
+    return Object.assign(o, a);
+}

package/src/payments/p2pk.ts

@@ -1,7 +1,7 @@
 import { bitcoin as BITCOIN_NETWORK } from '../networks.js';
 import * as bscript from '../script.js';
 import { isPoint, typeforce as typef } from '../types.js';
-import { P2PKPayment, PaymentOpts, StackFunction } from './index.js';
+import { P2PKPayment, PaymentOpts, PaymentType, StackFunction } from './index.js';
 import * as lazy from './lazy.js';
 
 const OPS = bscript.OPS;
@@ -39,7 +39,7 @@ export function p2pk(a: Omit<P2PKPayment, 'name'>, opts?: PaymentOpts): P2PKPaym
 
     const network = a.network || BITCOIN_NETWORK;
     const o: P2PKPayment = {
-        name: 'p2pk',
+        name: PaymentType.P2PK,
         network,
         pubkey: undefined,
     };

package/src/payments/p2pkh.ts

@@ -3,7 +3,7 @@ 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 { P2PKHPayment, PaymentOpts, StackFunction } from './index.js';
+import { P2PKHPayment, PaymentOpts, PaymentType, StackFunction } from './index.js';
 import * as lazy from './lazy.js';
 import { decompressPublicKey } from '../psbt/psbtutils.js';
 
@@ -53,7 +53,7 @@ export function p2pkh(a: Omit<P2PKHPayment, 'name'>, opts?: PaymentOpts): P2PKHP
 
     const network = a.network || BITCOIN_NETWORK;
     const o: P2PKHPayment = {
-        name: 'p2pkh',
+        name: PaymentType.P2PKH,
         network,
         hash: undefined,
     };

package/src/payments/p2sh.ts

@@ -3,7 +3,7 @@ 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 { P2SHPayment, Payment, PaymentOpts, ScriptRedeem, Stack, StackFunction } from './index.js';
+import { P2SHPayment, Payment, PaymentOpts, PaymentType, ScriptRedeem, Stack, StackFunction } from './index.js';
 import * as lazy from './lazy.js';
 
 const OPS = bscript.OPS;
@@ -52,8 +52,7 @@ export function p2sh(a: Omit<P2SHPayment, 'name'>, opts?: PaymentOpts): P2SHPaym
 
     const o: P2SHPayment = {
         network,
-        name: 'p2sh',
-        hash: undefined,
+        name: PaymentType.P2SH
     };
 
     const _address = lazy.value(() => {

package/src/payments/p2tr.ts

@@ -13,7 +13,7 @@ import {
     toHashTree,
     tweakKey,
 } from './bip341.js';
-import { P2TRPayment, PaymentOpts } from './index.js';
+import { P2TRPayment, PaymentOpts, PaymentType } from './index.js';
 import * as lazy from './lazy.js';
 
 const OPS = bscript.OPS;
@@ -83,7 +83,7 @@ export function p2tr(a: Omit<P2TRPayment, 'name'>, opts?: PaymentOpts): P2TRPaym
 
     const network = a.network || BITCOIN_NETWORK;
     const o: P2TRPayment = {
-        name: 'p2tr',
+        name: PaymentType.P2TR,
         network,
     };
 

package/src/payments/p2wpkh.ts

@@ -3,7 +3,7 @@ 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 { P2WPKHPayment, PaymentOpts } from './index.js';
+import { P2WPKHPayment, PaymentOpts, PaymentType } from './index.js';
 import * as lazy from './lazy.js';
 
 const OPS = bscript.OPS;
@@ -53,9 +53,8 @@ export function p2wpkh(a: Omit<P2WPKHPayment, 'name'>, opts?: PaymentOpts): P2WP
 
     const network = a.network || BITCOIN_NETWORK;
     const o: P2WPKHPayment = {
-        name: 'p2wpkh',
-        network,
-        hash: undefined,
+        name: PaymentType.P2WPKH,
+        network
     };
 
     lazy.prop(o, 'address', () => {

package/src/payments/p2wsh.ts

@@ -3,7 +3,7 @@ import * as bcrypto from '../crypto.js';
 import { bitcoin as BITCOIN_NETWORK } from '../networks.js';
 import * as bscript from '../script.js';
 import { isPoint, stacksEqual, typeforce as typef } from '../types.js';
-import { P2WSHPayment, PaymentOpts, StackElement, StackFunction } from './index.js';
+import { P2WSHPayment, PaymentOpts, PaymentType, StackElement, StackFunction } from './index.js';
 import * as lazy from './lazy.js';
 
 const OPS = bscript.OPS;
@@ -75,8 +75,7 @@ export function p2wsh(a: Omit<P2WSHPayment, 'name'>, opts?: PaymentOpts): P2WSHP
 
     const o: P2WSHPayment = {
         network,
-        name: 'p2wsh',
-        hash: undefined,
+        name: PaymentType.P2WSH
     };
 
     lazy.prop(o, 'address', () => {

package/src/psbt.ts

@@ -20,7 +20,7 @@ import { BIP32Interface } from 'bip32';
 import { ECPairInterface } from 'ecpair';
 import { fromOutputScript, toOutputScript } from './address.js';
 import { cloneBuffer, reverseBuffer } from './bufferutils.js';
-import { payments } from './index.js';
+import { P2WSHPayment, payments } from './index.js';
 import { bitcoin as btcNetwork, Network } from './networks.js';
 import { tapleafHash } from './payments/bip341.js';
 import { P2SHPayment, Payment, PaymentOpts } from './payments/index.js';
@@ -1514,8 +1514,8 @@ export function prepareFinalScripts(
 
     // Wow, the payments API is very handy
     const payment: payments.Payment = getPayment(script, scriptType, partialSig);
-    const p2wsh = !isP2WSH ? null : payments.p2wsh({ redeem: payment });
-    const p2sh = !isP2SH ? null : payments.p2sh({ redeem: p2wsh || payment });
+    const p2wsh = !isP2WSH ? null : payments.p2wsh({ redeem: payment } as P2WSHPayment);
+    const p2sh = !isP2SH ? null : payments.p2sh({ redeem: p2wsh || payment } as P2SHPayment);
 
     if (isSegwit) {
         if (p2wsh) {
@@ -1771,13 +1771,14 @@ function getPayment(
 ): payments.Payment {
     let payment: payments.Payment;
     switch (scriptType) {
-        case 'multisig':
+        case 'multisig': {
             const sigs = getSortedSigs(script, partialSig);
             payment = payments.p2ms({
                 output: script,
                 signatures: sigs,
             });
             break;
+        }
         case 'pubkey':
             payment = payments.p2pk({
                 output: script,