@btc-vision/bitcoin 6.5.6 → 7.0.0-alpha.1

package/browser/payments/bip341.d.ts

@@ -1,23 +1,49 @@
-import { Tapleaf, Taptree } from '../types.js';
+import { Bytes32, Tapleaf, Taptree, XOnlyPublicKey } from '../types.js';
 export declare const LEAF_VERSION_TAPSCRIPT = 192;
 export declare const MAX_TAPTREE_DEPTH = 128;
 interface HashLeaf {
-    hash: Buffer;
+    hash: Bytes32;
 }
 interface HashBranch {
-    hash: Buffer;
+    hash: Bytes32;
     left: HashTree;
     right: HashTree;
 }
 interface TweakedPublicKey {
     parity: number;
-    x: Buffer;
+    x: XOnlyPublicKey;
 }
+/**
+ * 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;
-export declare function rootHashFromPath(controlBlock: Buffer, leafHash: Buffer): Buffer;
+/**
+ * Calculates the root hash from a given control block and leaf hash.
+ * @param controlBlock - The control block.
+ * @param leafHash - The leaf hash.
+ * @returns The root hash.
+ * @throws {TypeError} If the control block length is less than 33.
+ */
+export declare function rootHashFromPath(controlBlock: Uint8Array, leafHash: Uint8Array): Bytes32;
+/**
+ * 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;
-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;
+/**
+ * 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: Bytes32): Bytes32[] | undefined;
+export declare function tapleafHash(leaf: Tapleaf): Bytes32;
+export declare function tapTweakHash(pubKey: XOnlyPublicKey, h: Bytes32 | undefined): Bytes32;
+export declare function tweakKey(pubKey: XOnlyPublicKey, h: Bytes32 | undefined): TweakedPublicKey | null;
 export {};
+//# sourceMappingURL=bip341.d.ts.map

package/browser/payments/bip341.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bip341.d.ts","sourceRoot":"","sources":["../../src/payments/bip341.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAG7E,eAAO,MAAM,sBAAsB,MAAO,CAAC;AAC3C,eAAO,MAAM,iBAAiB,MAAM,CAAC;AAErC,UAAU,QAAQ;IACd,IAAI,EAAE,OAAO,CAAC;CACjB;AAED,UAAU,UAAU;IAChB,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,QAAQ,CAAC;IACf,KAAK,EAAE,QAAQ,CAAC;CACnB;AAED,UAAU,gBAAgB;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,CAAC,EAAE,cAAc,CAAC;CACrB;AAID;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,GAAG,QAAQ,GAAG,UAAU,CAAC;AAE7C;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,YAAY,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,GAAG,OAAO,CAkBxF;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,UAAU,EAAE,OAAO,GAAG,QAAQ,CAYxD;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,EAAE,GAAG,SAAS,CAYnF;AAED,wBAAgB,WAAW,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAMlD;AAED,wBAAgB,YAAY,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,OAAO,CAEpF;AAED,wBAAgB,QAAQ,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,gBAAgB,GAAG,IAAI,CAchG"}

package/browser/payments/embed.d.ts

@@ -1,2 +1,113 @@
-import { EmbedPayment, PaymentOpts } from './types.js';
+import { Network } from '../networks.js';
+import { Script } from '../types.js';
+import { EmbedPayment, PaymentOpts, PaymentType } from './types.js';
+/**
+ * OP_RETURN Embed payment class.
+ *
+ * Creates outputs of the form: `OP_RETURN {data1} {data2} ...`
+ * These outputs are provably unspendable and used for data storage.
+ *
+ * @example
+ * ```typescript
+ * import { Embed } from '@btc-vision/bitcoin';
+ *
+ * // Create from data
+ * const payment = Embed.fromData([Buffer.from('Hello, Bitcoin!')]);
+ * console.log(payment.output); // scriptPubKey with OP_RETURN
+ *
+ * // Decode an existing output
+ * const decoded = Embed.fromOutput(scriptPubKey);
+ * console.log(decoded.data); // array of data chunks
+ * ```
+ */
+export declare class Embed {
+    #private;
+    static readonly NAME: "embed";
+    /**
+     * Creates a new Embed payment instance.
+     *
+     * @param params - Payment parameters
+     * @param params.data - Array of data chunks to embed
+     * @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: {
+        data?: Uint8Array[] | undefined;
+        output?: Uint8Array | undefined;
+        network?: Network | undefined;
+    }, opts?: PaymentOpts);
+    /**
+     * Payment type discriminant.
+     */
+    get name(): typeof PaymentType.Embed;
+    /**
+     * Network parameters.
+     */
+    get network(): Network;
+    /**
+     * The embedded data chunks.
+     */
+    get data(): Uint8Array[];
+    /**
+     * The scriptPubKey: `OP_RETURN {data...}`
+     */
+    get output(): Script | undefined;
+    /**
+     * Creates an Embed payment from data chunks.
+     *
+     * @param data - Array of data chunks to embed
+     * @param network - Network parameters (defaults to mainnet)
+     * @returns A new Embed payment instance
+     *
+     * @example
+     * ```typescript
+     * const payment = Embed.fromData([
+     *   new TextEncoder().encode('Hello'),
+     *   new TextEncoder().encode('Bitcoin')
+     * ]);
+     * ```
+     */
+    static fromData(data: Uint8Array[], network?: Network): Embed;
+    /**
+     * Creates an Embed payment from a scriptPubKey.
+     *
+     * @param output - The scriptPubKey
+     * @param network - Network parameters (defaults to mainnet)
+     * @returns A new Embed payment instance
+     */
+    static fromOutput(output: Uint8Array, network?: Network): Embed;
+    /**
+     * Converts to a plain EmbedPayment object for backwards compatibility.
+     *
+     * @returns An EmbedPayment object
+     */
+    toPayment(): EmbedPayment;
+}
+/**
+ * Creates an OP_RETURN Embed payment object.
+ *
+ * This is the legacy factory function for backwards compatibility.
+ * For new code, prefer using the Embed class directly.
+ *
+ * @param a - The payment object containing the necessary data
+ * @param opts - Optional payment options
+ * @returns The Embed payment object
+ * @throws {TypeError} If the required data is not provided or if the data is invalid
+ *
+ * @example
+ * ```typescript
+ * import { p2data } from '@btc-vision/bitcoin';
+ *
+ * // Create from data
+ * const payment = p2data({ data: [Buffer.from('Hello')] });
+ *
+ * // Decode from output
+ * const decoded = p2data({ output: scriptPubKey });
+ * ```
+ */
 export declare function p2data(a: Omit<EmbedPayment, 'name'>, opts?: PaymentOpts): EmbedPayment;
+//# sourceMappingURL=embed.d.ts.map

package/browser/payments/embed.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"embed.d.ts","sourceRoot":"","sources":["../../src/payments/embed.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAA8B,KAAK,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAE1E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,WAAW,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAI9E;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,KAAK;;IAEd,MAAM,CAAC,QAAQ,CAAC,IAAI,UAAqB;IAkBzC;;;;;;;;;;;OAWG;gBAEC,MAAM,EAAE;QACJ,IAAI,CAAC,EAAE,UAAU,EAAE,GAAG,SAAS,CAAC;QAChC,MAAM,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;QAChC,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;KACjC,EACD,IAAI,CAAC,EAAE,WAAW;IAoBtB;;OAEG;IACH,IAAI,IAAI,IAAI,OAAO,WAAW,CAAC,KAAK,CAEnC;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,OAAO,CAErB;IAED;;OAEG;IACH,IAAI,IAAI,IAAI,UAAU,EAAE,CAMvB;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,MAAM,GAAG,SAAS,CAM/B;IAID;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,UAAU,EAAE,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,KAAK;IAI7D;;;;;;OAMG;IACH,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,KAAK;IAM/D;;;;OAIG;IACH,SAAS,IAAI,YAAY;CAqD5B;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,EAAE,WAAW,GAAG,YAAY,CAgBtF"}

package/browser/payments/index.d.ts

@@ -1,12 +1,19 @@
+/**
+ * Represents a payment object, which is used to create a payment.
+ *
+ * Supports P2PKH、P2SH、P2WPKH、P2WSH、P2TR and so on
+ *
+ * @packageDocumentation
+ */
 export { PaymentType, type BasePayment, type ScriptRedeem, type P2PKPayment, type P2PKHPayment, type P2SHPayment, type P2MSPayment, type P2WPKHPayment, type P2WSHPayment, type P2TRPayment, type P2OPPayment, type P2OPPaymentParams, type EmbedPayment, type Payment, type PaymentCreator, type PaymentOpts, } from './types.js';
-export { p2data } from './embed.js';
-export { prop, value } from './lazy.js';
-export { p2ms } from './p2ms.js';
-export { p2pk } from './p2pk.js';
-export { p2pkh } from './p2pkh.js';
-export { p2sh } from './p2sh.js';
-export { p2tr } from './p2tr.js';
-export { p2wpkh } from './p2wpkh.js';
-export { p2wsh } from './p2wsh.js';
-export { p2op } from './p2op.js';
+export { P2PK, p2pk } from './p2pk.js';
+export { P2PKH, p2pkh } from './p2pkh.js';
+export { P2WPKH, p2wpkh } from './p2wpkh.js';
+export { Embed, p2data } from './embed.js';
+export { P2MS, p2ms } from './p2ms.js';
+export { P2SH, p2sh } from './p2sh.js';
+export { P2WSH, p2wsh } from './p2wsh.js';
+export { P2TR, p2tr } from './p2tr.js';
+export { P2OP, p2op } from './p2op.js';
 export { findScriptPath, LEAF_VERSION_TAPSCRIPT, MAX_TAPTREE_DEPTH, rootHashFromPath, tapleafHash, toHashTree, tweakKey, type HashTree, } from './bip341.js';
+//# sourceMappingURL=index.d.ts.map

package/browser/payments/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/payments/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,EACH,WAAW,EACX,KAAK,WAAW,EAChB,KAAK,YAAY,EACjB,KAAK,WAAW,EAChB,KAAK,YAAY,EACjB,KAAK,WAAW,EAChB,KAAK,WAAW,EAChB,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,WAAW,EAChB,KAAK,WAAW,EAChB,KAAK,iBAAiB,EACtB,KAAK,YAAY,EACjB,KAAK,OAAO,EACZ,KAAK,cAAc,EACnB,KAAK,WAAW,GACnB,MAAM,YAAY,CAAC;AAGpB,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAGvC,OAAO,EACH,cAAc,EACd,sBAAsB,EACtB,iBAAiB,EACjB,gBAAgB,EAChB,WAAW,EACX,UAAU,EACV,QAAQ,EACR,KAAK,QAAQ,GAChB,MAAM,aAAa,CAAC"}

package/browser/payments/p2ms.d.ts

@@ -1,2 +1,152 @@
+import { Network } from '../networks.js';
+import { PublicKey, Script, Signature } from '../types.js';
 import { P2MSPayment, PaymentOpts } from './types.js';
+/**
+ * Pay-to-Multisig (P2MS) payment class.
+ *
+ * Creates locking scripts of the form:
+ * `m {pubKey1} {pubKey2} ... {pubKeyN} n OP_CHECKMULTISIG`
+ *
+ * Spending requires: `OP_0 {sig1} {sig2} ... {sigM}`
+ *
+ * @example
+ * ```typescript
+ * import { P2MS } from '@btc-vision/bitcoin';
+ *
+ * // Create a 2-of-3 multisig
+ * const payment = P2MS.fromPubkeys(2, [pubkey1, pubkey2, pubkey3]);
+ * console.log(payment.output); // scriptPubKey
+ * console.log(payment.m); // 2
+ * console.log(payment.n); // 3
+ *
+ * // Decode an existing output
+ * const decoded = P2MS.fromOutput(scriptPubKey);
+ * console.log(decoded.pubkeys); // array of public keys
+ * ```
+ */
+export declare class P2MS {
+    #private;
+    static readonly NAME: "p2ms";
+    /**
+     * Creates a new P2MS payment instance.
+     *
+     * @param params - Payment parameters
+     * @param params.m - Required number of signatures
+     * @param params.n - Total number of public keys (optional, derived from pubkeys)
+     * @param params.pubkeys - Array of public keys
+     * @param params.signatures - Array of signatures
+     * @param params.output - The scriptPubKey
+     * @param params.input - The scriptSig
+     * @param params.network - Network parameters (defaults to mainnet)
+     * @param opts - Payment options
+     * @param opts.validate - Whether to validate inputs (default: true)
+     * @param opts.allowIncomplete - Allow incomplete signatures (default: false)
+     *
+     * @throws {TypeError} If validation is enabled and data is invalid
+     */
+    constructor(params: {
+        m?: number | undefined;
+        n?: number | undefined;
+        pubkeys?: Uint8Array[] | undefined;
+        signatures?: Uint8Array[] | undefined;
+        output?: Uint8Array | undefined;
+        input?: Uint8Array | undefined;
+        network?: Network | undefined;
+    }, opts?: PaymentOpts);
+    /**
+     * Payment type discriminant.
+     */
+    get name(): string;
+    /**
+     * Network parameters.
+     */
+    get network(): Network;
+    /**
+     * Required number of signatures (M in M-of-N).
+     */
+    get m(): number | undefined;
+    /**
+     * Total number of public keys (N in M-of-N).
+     */
+    get n(): number | undefined;
+    /**
+     * Array of public keys.
+     */
+    get pubkeys(): PublicKey[] | undefined;
+    /**
+     * Array of signatures.
+     */
+    get signatures(): Signature[] | undefined;
+    /**
+     * The scriptPubKey: `m {pubkeys} n OP_CHECKMULTISIG`
+     */
+    get output(): Script | undefined;
+    /**
+     * The scriptSig: `OP_0 {signatures}`
+     */
+    get input(): Script | undefined;
+    /**
+     * Witness stack (empty for P2MS as it's not a SegWit type).
+     */
+    get witness(): Uint8Array[] | undefined;
+    /**
+     * Creates a P2MS payment from public keys.
+     *
+     * @param m - Required number of signatures
+     * @param pubkeys - Array of public keys
+     * @param network - Network parameters (defaults to mainnet)
+     * @returns A new P2MS payment instance
+     *
+     * @example
+     * ```typescript
+     * // Create a 2-of-3 multisig
+     * const payment = P2MS.fromPubkeys(2, [pubkey1, pubkey2, pubkey3]);
+     * ```
+     */
+    static fromPubkeys(m: number, pubkeys: PublicKey[], network?: Network): P2MS;
+    /**
+     * Creates a P2MS payment from a scriptPubKey.
+     *
+     * @param output - The scriptPubKey
+     * @param network - Network parameters (defaults to mainnet)
+     * @returns A new P2MS payment instance
+     */
+    static fromOutput(output: Uint8Array, network?: Network): P2MS;
+    /**
+     * Creates a P2MS payment from signatures (for spending).
+     *
+     * @param signatures - Array of signatures
+     * @param m - Required number of signatures (optional)
+     * @param pubkeys - Array of public keys (optional, for validation)
+     * @param network - Network parameters (defaults to mainnet)
+     * @returns A new P2MS payment instance
+     */
+    static fromSignatures(signatures: Signature[], m?: number, pubkeys?: PublicKey[], network?: Network): P2MS;
+    /**
+     * Converts to a plain P2MSPayment object for backwards compatibility.
+     *
+     * @returns A P2MSPayment object
+     */
+    toPayment(): P2MSPayment;
+}
+/**
+ * Creates a Pay-to-Multisig (P2MS) payment object.
+ *
+ * This is the legacy factory function for backwards compatibility.
+ * For new code, prefer using the P2MS class directly.
+ *
+ * @param a - The payment object containing the necessary data
+ * @param opts - Optional payment options
+ * @returns The P2MS payment object
+ * @throws {TypeError} If the required data is not provided or if the data is invalid
+ *
+ * @example
+ * ```typescript
+ * import { p2ms } from '@btc-vision/bitcoin';
+ *
+ * // Create a 2-of-3 multisig
+ * const payment = p2ms({ m: 2, pubkeys: [pubkey1, pubkey2, pubkey3] });
+ * ```
+ */
 export declare function p2ms(a: Omit<P2MSPayment, 'name'>, opts?: PaymentOpts): P2MSPayment;
+//# sourceMappingURL=p2ms.d.ts.map

package/browser/payments/p2ms.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"p2ms.d.ts","sourceRoot":"","sources":["../../src/payments/p2ms.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAA8B,KAAK,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAE1E,OAAO,EAEH,KAAK,SAAS,EACd,KAAK,MAAM,EACX,KAAK,SAAS,EAGjB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,WAAW,EAAe,MAAM,YAAY,CAAC;AAK7E;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,IAAI;;IAEb,MAAM,CAAC,QAAQ,CAAC,IAAI,SAAoB;IAoCxC;;;;;;;;;;;;;;;;OAgBG;gBAEC,MAAM,EAAE;QACJ,CAAC,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QACvB,CAAC,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QACvB,OAAO,CAAC,EAAE,UAAU,EAAE,GAAG,SAAS,CAAC;QACnC,UAAU,CAAC,EAAE,UAAU,EAAE,GAAG,SAAS,CAAC;QACtC,MAAM,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;QAChC,KAAK,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;QAC/B,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;KACjC,EACD,IAAI,CAAC,EAAE,WAAW;IAwBtB;;OAEG;IACH,IAAI,IAAI,IAAI,MAAM,CAOjB;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,OAAO,CAErB;IAED;;OAEG;IACH,IAAI,CAAC,IAAI,MAAM,GAAG,SAAS,CAM1B;IAED;;OAEG;IACH,IAAI,CAAC,IAAI,MAAM,GAAG,SAAS,CAM1B;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,SAAS,EAAE,GAAG,SAAS,CAMrC;IAED;;OAEG;IACH,IAAI,UAAU,IAAI,SAAS,EAAE,GAAG,SAAS,CAMxC;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,OAAO,IAAI,UAAU,EAAE,GAAG,SAAS,CAMtC;IAID;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI;IAI5E;;;;;;OAMG;IACH,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI;IAI9D;;;;;;;;OAQG;IACH,MAAM,CAAC,cAAc,CACjB,UAAU,EAAE,SAAS,EAAE,EACvB,CAAC,CAAC,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,SAAS,EAAE,EACrB,OAAO,CAAC,EAAE,OAAO,GAClB,IAAI;IAMP;;;;OAIG;IACH,SAAS,IAAI,WAAW;CA6M3B;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,EAAE,WAAW,GAAG,WAAW,CAoBlF"}

package/browser/payments/p2op.d.ts

@@ -1,25 +1,151 @@
-import { BasePayment, P2OPPayment, PaymentOpts, PaymentType } from './types.js';
-interface P2OPBase extends BasePayment {
-    name: PaymentType.P2OP;
+import { Network } from '../networks.js';
+import { Bytes20 } from '../types.js';
+import { P2OPPayment, PaymentOpts, PaymentType } 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/browser/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,KAAK,WAAW,EAAE,KAAK,WAAW,EAAE,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;IAM9D;;;;OAIG;IACH,SAAS,IAAI,WAAW;CA2L3B;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"}