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

package/build/payments/embed.js

@@ -1,44 +1,225 @@
+/**
+ * OP_RETURN Embed payment class.
+ *
+ * Embed payments use OP_RETURN to store arbitrary data in the blockchain.
+ * These outputs are provably unspendable.
+ *
+ * @packageDocumentation
+ */
 import { bitcoin as BITCOIN_NETWORK } from '../networks.js';
 import * as bscript from '../script.js';
-import { stacksEqual, typeforce as typef } from '../types.js';
+import { stacksEqual } from '../types.js';
 import { PaymentType } from './types.js';
-import * as lazy from './lazy.js';
 const OPS = bscript.opcodes;
-export function p2data(a, opts) {
-    if (!a.data && !a.output)
-        throw new TypeError('Not enough data');
-    opts = Object.assign({ validate: true }, opts || {});
-    typef({
-        network: typef.maybe(typef.Object),
-        output: typef.maybe(typef.Buffer),
-        data: typef.maybe(typef.arrayOf(typef.Buffer)),
-    }, a);
-    const network = a.network || BITCOIN_NETWORK;
-    const o = { name: PaymentType.Embed, network, data: [] };
-    lazy.prop(o, 'output', () => {
-        if (!a.data)
-            return;
-        return bscript.compile([OPS.OP_RETURN].concat(a.data));
-    });
-    lazy.prop(o, 'data', () => {
-        if (!a.output)
-            return;
-        const script = bscript.decompile(a.output);
-        if (script === null || script === undefined) {
-            return;
-        }
-        return script.slice(1);
-    });
-    if (opts.validate) {
-        if (a.output) {
-            const chunks = bscript.decompile(a.output);
-            if (chunks[0] !== OPS.OP_RETURN)
+/**
+ * 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 class Embed {
+    // Static public fields
+    static NAME = PaymentType.Embed;
+    // Private instance fields
+    #network;
+    #opts;
+    // Input data (provided by user)
+    #inputData;
+    #inputOutput;
+    // Cached computed values
+    #data;
+    #output;
+    // Cache flags
+    #dataComputed = false;
+    #outputComputed = false;
+    /**
+     * 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, opts) {
+        this.#network = params.network ?? BITCOIN_NETWORK;
+        this.#opts = {
+            validate: opts?.validate ?? true,
+            allowIncomplete: opts?.allowIncomplete ?? false,
+        };
+        // Store input data
+        this.#inputData = params.data;
+        this.#inputOutput = params.output;
+        // Validate if requested
+        if (this.#opts.validate) {
+            this.#validate();
+        }
+    }
+    // Public getters
+    /**
+     * Payment type discriminant.
+     */
+    get name() {
+        return PaymentType.Embed;
+    }
+    /**
+     * Network parameters.
+     */
+    get network() {
+        return this.#network;
+    }
+    /**
+     * The embedded data chunks.
+     */
+    get data() {
+        if (!this.#dataComputed) {
+            this.#data = this.#computeData();
+            this.#dataComputed = true;
+        }
+        return this.#data ?? [];
+    }
+    /**
+     * The scriptPubKey: `OP_RETURN {data...}`
+     */
+    get output() {
+        if (!this.#outputComputed) {
+            this.#output = this.#computeOutput();
+            this.#outputComputed = true;
+        }
+        return this.#output;
+    }
+    // Static factory methods
+    /**
+     * 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, network) {
+        return new Embed({ data, network });
+    }
+    /**
+     * 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, network) {
+        return new Embed({ output, network });
+    }
+    // Private computation methods
+    #computeData() {
+        if (this.#inputData) {
+            return this.#inputData;
+        }
+        if (this.#inputOutput) {
+            const script = bscript.decompile(this.#inputOutput);
+            if (script === null || script === undefined) {
+                return undefined;
+            }
+            return script.slice(1);
+        }
+        return undefined;
+    }
+    #computeOutput() {
+        if (this.#inputOutput) {
+            return this.#inputOutput;
+        }
+        if (!this.#inputData) {
+            return undefined;
+        }
+        return bscript.compile([OPS.OP_RETURN].concat(this.#inputData));
+    }
+    // Validation
+    #validate() {
+        if (this.#inputOutput) {
+            const chunks = bscript.decompile(this.#inputOutput);
+            if (!chunks) {
                 throw new TypeError('Output is invalid');
-            if (!chunks.slice(1).every(typef.Buffer))
+            }
+            if (chunks[0] !== OPS.OP_RETURN) {
                 throw new TypeError('Output is invalid');
-            if (a.data && !stacksEqual(a.data, o.data))
+            }
+            if (!chunks.slice(1).every((c) => c instanceof Uint8Array)) {
+                throw new TypeError('Output is invalid');
+            }
+            if (this.#inputData && !stacksEqual(this.#inputData, this.data)) {
                 throw new TypeError('Data mismatch');
+            }
         }
     }
-    return Object.assign(o, a);
+    /**
+     * Converts to a plain EmbedPayment object for backwards compatibility.
+     *
+     * @returns An EmbedPayment object
+     */
+    toPayment() {
+        return {
+            name: this.name,
+            network: this.network,
+            data: this.data,
+            output: this.output,
+        };
+    }
+}
+/**
+ * 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 function p2data(a, opts) {
+    if (!a.data && !a.output) {
+        throw new TypeError('Not enough data');
+    }
+    const instance = new Embed({
+        data: a.data,
+        output: a.output,
+        network: a.network,
+    }, opts);
+    // Return a merged object for backwards compatibility
+    return Object.assign(instance.toPayment(), a);
 }
+//# sourceMappingURL=embed.js.map

package/build/payments/embed.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"embed.js","sourceRoot":"","sources":["../../src/payments/embed.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,OAAO,IAAI,eAAe,EAAgB,MAAM,gBAAgB,CAAC;AAC1E,OAAO,KAAK,OAAO,MAAM,cAAc,CAAC;AACxC,OAAO,EAAE,WAAW,EAAc,MAAM,aAAa,CAAC;AAEtD,OAAO,EAAE,WAAW,EAAuC,MAAM,YAAY,CAAC;AAE9E,MAAM,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;AAE5B;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,OAAO,KAAK;IACd,uBAAuB;IACvB,MAAM,CAAU,IAAI,GAAG,WAAW,CAAC,KAAK,CAAC;IAEzC,0BAA0B;IACjB,QAAQ,CAAU;IAClB,KAAK,CAAwB;IAEtC,gCAAgC;IAChC,UAAU,CAA4B;IACtC,YAAY,CAA0B;IAEtC,yBAAyB;IACzB,KAAK,CAA4B;IACjC,OAAO,CAA0B;IAEjC,cAAc;IACd,aAAa,GAAG,KAAK,CAAC;IACtB,eAAe,GAAG,KAAK,CAAC;IAExB;;;;;;;;;;;OAWG;IACH,YACI,MAIC,EACD,IAAkB;QAElB,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,OAAO,IAAI,eAAe,CAAC;QAClD,IAAI,CAAC,KAAK,GAAG;YACT,QAAQ,EAAE,IAAI,EAAE,QAAQ,IAAI,IAAI;YAChC,eAAe,EAAE,IAAI,EAAE,eAAe,IAAI,KAAK;SAClD,CAAC;QAEF,mBAAmB;QACnB,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC;QAC9B,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC;QAElC,wBAAwB;QACxB,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;YACtB,IAAI,CAAC,SAAS,EAAE,CAAC;QACrB,CAAC;IACL,CAAC;IAED,iBAAiB;IAEjB;;OAEG;IACH,IAAI,IAAI;QACJ,OAAO,WAAW,CAAC,KAAK,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,IAAI,OAAO;QACP,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,IAAI,IAAI;QACJ,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;YACtB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;YACjC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAC9B,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,IAAI,MAAM;QACN,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;YACxB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;YACrC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;QAChC,CAAC;QACD,OAAO,IAAI,CAAC,OAA6B,CAAC;IAC9C,CAAC;IAED,yBAAyB;IAEzB;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAkB,EAAE,OAAiB;QACjD,OAAO,IAAI,KAAK,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,UAAU,CAAC,MAAkB,EAAE,OAAiB;QACnD,OAAO,IAAI,KAAK,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED,8BAA8B;IAE9B,YAAY;QACR,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YAClB,OAAO,IAAI,CAAC,UAAU,CAAC;QAC3B,CAAC;QACD,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACpB,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACpD,IAAI,MAAM,KAAK,IAAI,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBAC1C,OAAO,SAAS,CAAC;YACrB,CAAC;YACD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,CAAiB,CAAC;QAC3C,CAAC;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,cAAc;QACV,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACpB,OAAO,IAAI,CAAC,YAAY,CAAC;QAC7B,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACnB,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,OAAO,OAAO,CAAC,OAAO,CAAE,CAAC,GAAG,CAAC,SAAS,CAAW,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAW,CAAC;IACzF,CAAC;IAED,aAAa;IAEb,SAAS;QACL,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACpB,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACpD,IAAI,CAAC,MAAM,EAAE,CAAC;gBACV,MAAM,IAAI,SAAS,CAAC,mBAAmB,CAAC,CAAC;YAC7C,CAAC;YACD,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,SAAS,EAAE,CAAC;gBAC9B,MAAM,IAAI,SAAS,CAAC,mBAAmB,CAAC,CAAC;YAC7C,CAAC;YACD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,YAAY,UAAU,CAAC,EAAE,CAAC;gBACzD,MAAM,IAAI,SAAS,CAAC,mBAAmB,CAAC,CAAC;YAC7C,CAAC;YAED,IAAI,IAAI,CAAC,UAAU,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC9D,MAAM,IAAI,SAAS,CAAC,eAAe,CAAC,CAAC;YACzC,CAAC;QACL,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,SAAS;QACL,OAAO;YACH,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,MAAM,EAAE,IAAI,CAAC,MAAM;SACtB,CAAC;IACN,CAAC;;AAGL;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,MAAM,CAAC,CAA6B,EAAE,IAAkB;IACpE,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;QACvB,MAAM,IAAI,SAAS,CAAC,iBAAiB,CAAC,CAAC;IAC3C,CAAC;IAED,MAAM,QAAQ,GAAG,IAAI,KAAK,CACtB;QACI,IAAI,EAAE,CAAC,CAAC,IAAI;QACZ,MAAM,EAAE,CAAC,CAAC,MAAM;QAChB,OAAO,EAAE,CAAC,CAAC,OAAO;KACrB,EACD,IAAI,CACP,CAAC;IAEF,qDAAqD;IACrD,OAAO,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,CAAC;AAClD,CAAC"}

package/build/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/build/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/build/payments/index.js

@@ -1,12 +1,22 @@
+/**
+ * Represents a payment object, which is used to create a payment.
+ *
+ * Supports P2PKH、P2SH、P2WPKH、P2WSH、P2TR and so on
+ *
+ * @packageDocumentation
+ */
+// Type exports
 export { PaymentType, } 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';
+// Class exports (new pattern)
+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';
+// BIP341 Taproot utilities
 export { findScriptPath, LEAF_VERSION_TAPSCRIPT, MAX_TAPTREE_DEPTH, rootHashFromPath, tapleafHash, toHashTree, tweakKey, } from './bip341.js';
+//# sourceMappingURL=index.js.map

package/build/payments/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/payments/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,eAAe;AACf,OAAO,EACH,WAAW,GAgBd,MAAM,YAAY,CAAC;AAEpB,8BAA8B;AAC9B,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;AAEvC,2BAA2B;AAC3B,OAAO,EACH,cAAc,EACd,sBAAsB,EACtB,iBAAiB,EACjB,gBAAgB,EAChB,WAAW,EACX,UAAU,EACV,QAAQ,GAEX,MAAM,aAAa,CAAC"}

package/build/payments/p2ms.d.ts

@@ -1,2 +1,160 @@
-import { P2MSPayment, PaymentOpts } from './types.js';
+/**
+ * Pay-to-Multisig (P2MS) payment class.
+ *
+ * P2MS is a bare multisig script where M-of-N signatures are required
+ * to spend the output. The public keys are embedded directly in the script.
+ *
+ * @packageDocumentation
+ */
+import { type Network } from '../networks.js';
+import { type PublicKey, type Script, type Signature } from '../types.js';
+import { type P2MSPayment, type 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/build/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,EAAwB,KAAK,SAAS,EAAE,KAAK,MAAM,EAAE,KAAK,SAAS,EAAc,MAAM,aAAa,CAAC;AAC5G,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;IAsMP;;;;OAIG;IACH,SAAS,IAAI,WAAW;CAa3B;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,EAAE,WAAW,GAAG,WAAW,CAoBlF"}