@btc-vision/bitcoin 6.5.5 → 7.0.0-alpha.0

package/build/payments/p2wsh.d.ts

@@ -1,2 +1,156 @@
-import { P2WSHPayment, PaymentOpts } from './types.js';
+/**
+ * Pay-to-Witness-Script-Hash (P2WSH) payment class.
+ *
+ * P2WSH is the native SegWit version of P2SH. The witness program is
+ * a 32-byte SHA256 hash of the script, and spending requires the witness
+ * stack with the script and its inputs.
+ *
+ * @packageDocumentation
+ */
+import { type Network } from '../networks.js';
+import type { Bytes32, Script } from '../types.js';
+import { type P2WSHPayment, type PaymentOpts, type ScriptRedeem } from './types.js';
+/**
+ * Pay-to-Witness-Script-Hash (P2WSH) payment class.
+ *
+ * Creates locking scripts of the form: `OP_0 {sha256(redeemScript)}`
+ * Spending witness: `[{redeemScriptSig...}, {redeemScript}]`
+ *
+ * @example
+ * ```typescript
+ * import { P2WSH, P2MS } from '@btc-vision/bitcoin';
+ *
+ * // Wrap a multisig in P2WSH
+ * const multisig = P2MS.fromPubkeys(2, [pubkey1, pubkey2, pubkey3]);
+ * const p2wsh = P2WSH.fromRedeem({ output: multisig.output });
+ * console.log(p2wsh.address); // bc1q... bech32 address
+ *
+ * // Decode an existing output
+ * const decoded = P2WSH.fromOutput(scriptPubKey);
+ * console.log(decoded.hash); // 32-byte witness program
+ * ```
+ */
+export declare class P2WSH {
+    #private;
+    static readonly NAME: "p2wsh";
+    /**
+     * Creates a new P2WSH payment instance.
+     *
+     * @param params - Payment parameters
+     * @param params.address - Bech32 encoded address
+     * @param params.hash - 32-byte witness program (SHA256 of script)
+     * @param params.output - The scriptPubKey
+     * @param params.redeem - The redeem script information
+     * @param params.witness - The witness stack
+     * @param params.network - Network parameters (defaults to mainnet)
+     * @param opts - Payment options
+     * @param opts.validate - Whether to validate inputs (default: true)
+     *
+     * @throws {TypeError} If validation is enabled and data is invalid
+     */
+    constructor(params: {
+        address?: string | undefined;
+        hash?: Uint8Array | undefined;
+        output?: Uint8Array | undefined;
+        redeem?: ScriptRedeem | undefined;
+        witness?: Uint8Array[] | undefined;
+        network?: Network | undefined;
+    }, opts?: PaymentOpts);
+    /**
+     * Payment type discriminant.
+     */
+    get name(): string;
+    /**
+     * Network parameters.
+     */
+    get network(): Network;
+    /**
+     * Bech32 encoded address (bc1q... for mainnet).
+     */
+    get address(): string | undefined;
+    /**
+     * 32-byte witness program (SHA256 of redeem script).
+     */
+    get hash(): Bytes32 | undefined;
+    /**
+     * The scriptPubKey: `OP_0 {32-byte hash}`
+     */
+    get output(): Script | undefined;
+    /**
+     * The scriptSig (always empty for native SegWit).
+     */
+    get input(): Script | undefined;
+    /**
+     * The redeem script information.
+     */
+    get redeem(): ScriptRedeem | undefined;
+    /**
+     * Witness stack: `[{scriptSig...}, {redeemScript}]`
+     */
+    get witness(): Uint8Array[] | undefined;
+    /**
+     * Creates a P2WSH payment from a redeem script.
+     *
+     * @param redeem - The redeem script information
+     * @param network - Network parameters (defaults to mainnet)
+     * @returns A new P2WSH payment instance
+     *
+     * @example
+     * ```typescript
+     * const p2wsh = P2WSH.fromRedeem({ output: redeemScript });
+     * ```
+     */
+    static fromRedeem(redeem: ScriptRedeem, network?: Network): P2WSH;
+    /**
+     * Creates a P2WSH payment from a bech32 address.
+     *
+     * @param address - Bech32 encoded address
+     * @param network - Network parameters (defaults to mainnet)
+     * @returns A new P2WSH payment instance
+     */
+    static fromAddress(address: string, network?: Network): P2WSH;
+    /**
+     * Creates a P2WSH payment from a 32-byte witness program.
+     *
+     * @param hash - 32-byte witness program (SHA256 of script)
+     * @param network - Network parameters (defaults to mainnet)
+     * @returns A new P2WSH payment instance
+     */
+    static fromHash(hash: Bytes32, network?: Network): P2WSH;
+    /**
+     * Creates a P2WSH payment from a scriptPubKey.
+     *
+     * @param output - The scriptPubKey
+     * @param network - Network parameters (defaults to mainnet)
+     * @returns A new P2WSH payment instance
+     */
+    static fromOutput(output: Uint8Array, network?: Network): P2WSH;
+    /**
+     * Converts to a plain P2WSHPayment object for backwards compatibility.
+     *
+     * @returns A P2WSHPayment object
+     */
+    toPayment(): P2WSHPayment;
+}
+/**
+ * Creates a Pay-to-Witness-Script-Hash (P2WSH) payment object.
+ *
+ * This is the legacy factory function for backwards compatibility.
+ * For new code, prefer using the P2WSH class directly.
+ *
+ * @param a - The payment object containing the necessary data
+ * @param opts - Optional payment options
+ * @returns The P2WSH payment object
+ * @throws {TypeError} If the required data is not provided or if the data is invalid
+ *
+ * @example
+ * ```typescript
+ * import { p2wsh, p2ms } from '@btc-vision/bitcoin';
+ *
+ * // Wrap a multisig in P2WSH
+ * const multisig = p2ms({ m: 2, pubkeys: [pk1, pk2, pk3] });
+ * const payment = p2wsh({ redeem: multisig });
+ * ```
+ */
 export declare function p2wsh(a: Omit<P2WSHPayment, 'name'>, opts?: PaymentOpts): P2WSHPayment;
+//# sourceMappingURL=p2wsh.d.ts.map

package/build/payments/p2wsh.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"p2wsh.d.ts","sourceRoot":"","sources":["../../src/payments/p2wsh.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH,OAAO,EAA8B,KAAK,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAG1E,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAEnD,OAAO,EAAe,KAAK,YAAY,EAAE,KAAK,WAAW,EAAE,KAAK,YAAY,EAAE,MAAM,YAAY,CAAC;AAejG;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,KAAK;;IAEd,MAAM,CAAC,QAAQ,CAAC,IAAI,UAAqB;IAqCzC;;;;;;;;;;;;;;OAcG;gBAEC,MAAM,EAAE;QACJ,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAC7B,IAAI,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;QAC9B,MAAM,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;QAChC,MAAM,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;QAClC,OAAO,CAAC,EAAE,UAAU,EAAE,GAAG,SAAS,CAAC;QACnC,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;KACjC,EACD,IAAI,CAAC,EAAE,WAAW;IA4BtB;;OAEG;IACH,IAAI,IAAI,IAAI,MAAM,CAMjB;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,OAAO,CAErB;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,MAAM,GAAG,SAAS,CAMhC;IAED;;OAEG;IACH,IAAI,IAAI,IAAI,OAAO,GAAG,SAAS,CAM9B;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,MAAM,GAAG,SAAS,CAM/B;IAED;;OAEG;IACH,IAAI,KAAK,IAAI,MAAM,GAAG,SAAS,CAM9B;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,YAAY,GAAG,SAAS,CAMrC;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,UAAU,EAAE,GAAG,SAAS,CAMtC;IAID;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,KAAK;IAIjE;;;;;;OAMG;IACH,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,KAAK;IAI7D;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,KAAK;IAIxD;;;;;;OAMG;IACH,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,KAAK;IAuP/D;;;;OAIG;IACH,SAAS,IAAI,YAAY;CAe5B;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,EAAE,WAAW,GAAG,YAAY,CAqBrF"}