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

package/build/payments/p2op.d.ts

@@ -1,25 +1,159 @@
-import { BasePayment, P2OPPayment, PaymentOpts, PaymentType } from './types.js';
-interface P2OPBase extends BasePayment {
-    name: PaymentType.P2OP;
+/**
+ * Pay-to-OPNet (P2OP) payment class.
+ *
+ * P2OP is a custom witness version 16 output type for the OPNet network.
+ * The witness program contains a deployment version and hash160.
+ *
+ * @packageDocumentation
+ */
+import { type Network } from '../networks.js';
+import type { Bytes20 } from '../types.js';
+import { PaymentType, type P2OPPayment, type PaymentOpts } from './types.js';
+/**
+ * Pay-to-OPNet (P2OP) payment class.
+ *
+ * Creates locking scripts of the form: `OP_16 {program}`
+ * where program = `{deploymentVersion:uint8}{hash160:20-bytes|...}`
+ *
+ * @example
+ * ```typescript
+ * import { P2OP } from '@btc-vision/bitcoin';
+ *
+ * // Create from program
+ * const payment = P2OP.fromProgram(program);
+ * console.log(payment.address); // opnet address
+ *
+ * // Create from deployment version and hash160
+ * const fromParts = P2OP.fromParts(deploymentVersion, hash160);
+ *
+ * // Decode an existing output
+ * const decoded = P2OP.fromOutput(scriptPubKey);
+ * console.log(decoded.program);
+ * ```
+ */
+export declare class P2OP {
+    #private;
+    static readonly NAME: "p2op";
+    /**
+     * Creates a new P2OP payment instance.
+     *
+     * @param params - Payment parameters
+     * @param params.address - Bech32m encoded OPNet address
+     * @param params.program - Witness program (2-40 bytes)
+     * @param params.deploymentVersion - Deployment version (0-255)
+     * @param params.hash160 - 20-byte hash
+     * @param params.output - The scriptPubKey
+     * @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;
+        program?: Uint8Array | undefined;
+        deploymentVersion?: number | undefined;
+        hash160?: Uint8Array | undefined;
+        output?: Uint8Array | undefined;
+        network?: Network | undefined;
+    }, opts?: PaymentOpts);
+    /**
+     * Payment type discriminant.
+     */
+    get name(): typeof PaymentType.P2OP;
+    /**
+     * Network parameters.
+     */
+    get network(): Network;
+    /**
+     * Bech32m encoded OPNet address.
+     */
+    get address(): string | undefined;
+    /**
+     * Witness program (2-40 bytes).
+     * Format: `{deploymentVersion:uint8}{hash160:20-bytes|...}`
+     */
+    get program(): Uint8Array | undefined;
+    /**
+     * Deployment version (first byte of program).
+     */
+    get deploymentVersion(): number | undefined;
+    /**
+     * Hash160 (remaining bytes of program).
+     */
+    get hash160(): Bytes20 | undefined;
+    /**
+     * The scriptPubKey: `OP_16 {program}`
+     */
+    get output(): Uint8Array | undefined;
+    /**
+     * Creates a P2OP payment from a witness program.
+     *
+     * @param program - Witness program (2-40 bytes)
+     * @param network - Network parameters (defaults to mainnet)
+     * @returns A new P2OP payment instance
+     */
+    static fromProgram(program: Uint8Array, network?: Network): P2OP;
+    /**
+     * Creates a P2OP payment from deployment version and hash160.
+     *
+     * @param deploymentVersion - Deployment version (0-255)
+     * @param hash160 - 20-byte hash
+     * @param network - Network parameters (defaults to mainnet)
+     * @returns A new P2OP payment instance
+     */
+    static fromParts(deploymentVersion: number, hash160: Uint8Array, network?: Network): P2OP;
+    /**
+     * Creates a P2OP payment from an OPNet address.
+     *
+     * @param address - Bech32m encoded OPNet address
+     * @param network - Network parameters (defaults to mainnet)
+     * @returns A new P2OP payment instance
+     */
+    static fromAddress(address: string, network?: Network): P2OP;
+    /**
+     * Creates a P2OP payment from a scriptPubKey.
+     *
+     * @param output - The scriptPubKey
+     * @param network - Network parameters (defaults to mainnet)
+     * @returns A new P2OP payment instance
+     */
+    static fromOutput(output: Uint8Array, network?: Network): P2OP;
+    /**
+     * Converts to a plain P2OPPayment object for backwards compatibility.
+     *
+     * @returns A P2OPPayment object
+     */
+    toPayment(): P2OPPayment;
 }
-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 {};
+/**
+ * Creates a Pay-to-OPNet (P2OP) payment object.
+ *
+ * This is the legacy factory function for backwards compatibility.
+ * For new code, prefer using the P2OP class directly.
+ *
+ * @param a - The payment object containing the necessary data
+ * @param opts - Optional payment options
+ * @returns The P2OP payment object
+ * @throws {TypeError} If the required data is not provided or if the data is invalid
+ *
+ * @example
+ * ```typescript
+ * import { p2op } from '@btc-vision/bitcoin';
+ *
+ * // Create from program
+ * const payment = p2op({ program });
+ *
+ * // Create from parts
+ * const fromParts = p2op({ deploymentVersion: 0, hash160 });
+ * ```
+ */
+export declare function p2op(a: {
+    address?: string;
+    program?: Uint8Array;
+    deploymentVersion?: number;
+    hash160?: Uint8Array;
+    output?: Uint8Array;
+    network?: Network;
+}, opts?: PaymentOpts): P2OPPayment;
+//# sourceMappingURL=p2op.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"p2op.d.ts","sourceRoot":"","sources":["../../src/payments/p2op.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAIH,OAAO,EAA8B,KAAK,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAG1E,OAAO,KAAK,EAAE,OAAO,EAAU,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,KAAK,WAAW,EAAE,KAAK,WAAW,EAAE,MAAM,YAAY,CAAC;AAO7E;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,IAAI;;IAEb,MAAM,CAAC,QAAQ,CAAC,IAAI,SAAoB;IA+BxC;;;;;;;;;;;;;;OAcG;gBAEC,MAAM,EAAE;QACJ,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAC7B,OAAO,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;QACjC,iBAAiB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QACvC,OAAO,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;QACjC,MAAM,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;QAChC,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;KACjC,EACD,IAAI,CAAC,EAAE,WAAW;IAuBtB;;OAEG;IACH,IAAI,IAAI,IAAI,OAAO,WAAW,CAAC,IAAI,CAElC;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,OAAO,CAErB;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,MAAM,GAAG,SAAS,CAMhC;IAED;;;OAGG;IACH,IAAI,OAAO,IAAI,UAAU,GAAG,SAAS,CAMpC;IAED;;OAEG;IACH,IAAI,iBAAiB,IAAI,MAAM,GAAG,SAAS,CAM1C;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,OAAO,GAAG,SAAS,CAMjC;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,UAAU,GAAG,SAAS,CAMnC;IAID;;;;;;OAMG;IACH,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI;IAIhE;;;;;;;OAOG;IACH,MAAM,CAAC,SAAS,CAAC,iBAAiB,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI;IAIzF;;;;;;OAMG;IACH,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI;IAI5D;;;;;;OAMG;IACH,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI;IAsL9D;;;;OAIG;IACH,SAAS,IAAI,WAAW;CAW3B;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,IAAI,CAChB,CAAC,EAAE;IACC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;CACrB,EACD,IAAI,CAAC,EAAE,WAAW,GACnB,WAAW,CAwBb"}