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

package/build/payments/p2sh.js

@@ -1,180 +1,530 @@
+/**
+ * Pay-to-Script-Hash (P2SH) payment class.
+ *
+ * P2SH allows spending to be based on a hash of a script, with the actual
+ * script revealed only at spend time. This enables complex spending conditions
+ * while keeping addresses short.
+ *
+ * @packageDocumentation
+ */
 import * as bs58check from 'bs58check';
 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 { PaymentType } from './types.js';
-import * as lazy from './lazy.js';
+import { stacksEqual } from '../types.js';
+import { alloc, equals } from '../io/index.js';
+import { PaymentType, } from './types.js';
 const OPS = bscript.opcodes;
-export function p2sh(a, opts) {
-    if (!a.address && !a.hash && !a.output && !a.redeem && !a.input) {
-        throw new TypeError('Not enough data');
+/**
+ * Pay-to-Script-Hash (P2SH) payment class.
+ *
+ * Creates locking scripts of the form:
+ * `OP_HASH160 {hash160(redeemScript)} OP_EQUAL`
+ *
+ * Spending requires: `{redeemScriptSig...} {redeemScript}`
+ *
+ * @example
+ * ```typescript
+ * import { P2SH, P2MS } from '@btc-vision/bitcoin';
+ *
+ * // Wrap a multisig in P2SH
+ * const multisig = P2MS.fromPubkeys(2, [pubkey1, pubkey2, pubkey3]);
+ * const p2sh = P2SH.fromRedeem({ output: multisig.output });
+ * console.log(p2sh.address); // 3... address
+ *
+ * // Decode an existing output
+ * const decoded = P2SH.fromOutput(scriptPubKey);
+ * console.log(decoded.hash); // 20-byte script hash
+ * ```
+ */
+export class P2SH {
+    // Static public fields
+    static NAME = PaymentType.P2SH;
+    // Private instance fields
+    #network;
+    #opts;
+    // Input data (provided by user)
+    #inputAddress;
+    #inputHash;
+    #inputOutput;
+    #inputInput;
+    #inputRedeem;
+    #inputWitness;
+    // Cached computed values
+    #address;
+    #hash;
+    #output;
+    #input;
+    #redeem;
+    #witness;
+    // Cache flags
+    #addressComputed = false;
+    #hashComputed = false;
+    #outputComputed = false;
+    #inputComputed = false;
+    #redeemComputed = false;
+    #witnessComputed = false;
+    // Decoded address cache
+    #decodedAddress;
+    #decodedAddressComputed = false;
+    // Decoded input chunks cache
+    #inputChunks;
+    #inputChunksComputed = false;
+    // Derived redeem from input
+    #derivedRedeem;
+    #derivedRedeemComputed = false;
+    /**
+     * Creates a new P2SH payment instance.
+     *
+     * @param params - Payment parameters
+     * @param params.address - Base58Check encoded address (3...)
+     * @param params.hash - 20-byte script hash
+     * @param params.output - The scriptPubKey
+     * @param params.input - The scriptSig
+     * @param params.redeem - The redeem script information
+     * @param params.witness - The witness stack (for wrapped SegWit)
+     * @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) {
+        // Derive network from redeem if not specified
+        let network = params.network;
+        if (!network) {
+            network = (params.redeem && params.redeem.network) || BITCOIN_NETWORK;
+        }
+        this.#network = network;
+        this.#opts = {
+            validate: opts?.validate ?? true,
+            allowIncomplete: opts?.allowIncomplete ?? false,
+        };
+        // Store input data
+        this.#inputAddress = params.address;
+        this.#inputHash = params.hash;
+        this.#inputOutput = params.output;
+        this.#inputInput = params.input;
+        this.#inputRedeem = params.redeem;
+        this.#inputWitness = params.witness;
+        // Validate if requested
+        if (this.#opts.validate) {
+            this.#validate();
+        }
+    }
+    // Public getters
+    /**
+     * Payment type discriminant.
+     */
+    get name() {
+        const r = this.redeem;
+        if (r !== undefined && r.name !== undefined) {
+            return `p2sh-${r.name}`;
+        }
+        return PaymentType.P2SH;
+    }
+    /**
+     * Network parameters.
+     */
+    get network() {
+        return this.#network;
+    }
+    /**
+     * Base58Check encoded address (3... for mainnet).
+     */
+    get address() {
+        if (!this.#addressComputed) {
+            this.#address = this.#computeAddress();
+            this.#addressComputed = true;
+        }
+        return this.#address;
+    }
+    /**
+     * 20-byte script hash (HASH160 of redeem script).
+     */
+    get hash() {
+        if (!this.#hashComputed) {
+            this.#hash = this.#computeHash();
+            this.#hashComputed = true;
+        }
+        return this.#hash;
+    }
+    /**
+     * The scriptPubKey: `OP_HASH160 {hash} OP_EQUAL`
+     */
+    get output() {
+        if (!this.#outputComputed) {
+            this.#output = this.#computeOutput();
+            this.#outputComputed = true;
+        }
+        return this.#output;
+    }
+    /**
+     * The scriptSig: `{redeemScriptSig...} {redeemScript}`
+     */
+    get input() {
+        if (!this.#inputComputed) {
+            this.#input = this.#computeInput();
+            this.#inputComputed = true;
+        }
+        return this.#input;
+    }
+    /**
+     * The redeem script information.
+     */
+    get redeem() {
+        if (!this.#redeemComputed) {
+            this.#redeem = this.#computeRedeem();
+            this.#redeemComputed = true;
+        }
+        return this.#redeem;
+    }
+    /**
+     * The witness stack (for wrapped SegWit).
+     */
+    get witness() {
+        if (!this.#witnessComputed) {
+            this.#witness = this.#computeWitness();
+            this.#witnessComputed = true;
+        }
+        return this.#witness;
+    }
+    // Static factory methods
+    /**
+     * Creates a P2SH payment from a redeem script.
+     *
+     * @param redeem - The redeem script information
+     * @param network - Network parameters (defaults to mainnet)
+     * @returns A new P2SH payment instance
+     *
+     * @example
+     * ```typescript
+     * const p2sh = P2SH.fromRedeem({ output: redeemScript });
+     * ```
+     */
+    static fromRedeem(redeem, network) {
+        return new P2SH({ redeem, network });
+    }
+    /**
+     * Creates a P2SH payment from a Base58Check address.
+     *
+     * @param address - Base58Check encoded address
+     * @param network - Network parameters (defaults to mainnet)
+     * @returns A new P2SH payment instance
+     */
+    static fromAddress(address, network) {
+        return new P2SH({ address, network });
+    }
+    /**
+     * Creates a P2SH payment from a 20-byte script hash.
+     *
+     * @param hash - 20-byte script hash
+     * @param network - Network parameters (defaults to mainnet)
+     * @returns A new P2SH payment instance
+     */
+    static fromHash(hash, network) {
+        return new P2SH({ hash, network });
     }
-    opts = Object.assign({ validate: true }, opts || {});
-    typef({
-        network: typef.maybe(typef.Object),
-        address: typef.maybe(typef.String),
-        hash: typef.maybe(typef.BufferN(20)),
-        output: typef.maybe(typef.BufferN(23)),
-        redeem: typef.maybe({
-            network: typef.maybe(typef.Object),
-            output: typef.maybe(typef.Buffer),
-            input: typef.maybe(typef.Buffer),
-            witness: typef.maybe(typef.arrayOf(typef.Buffer)),
-        }),
-        input: typef.maybe(typef.Buffer),
-        witness: typef.maybe(typef.arrayOf(typef.Buffer)),
-    }, a);
-    let network = a.network;
-    if (!network) {
-        network = (a.redeem && a.redeem.network) || BITCOIN_NETWORK;
-    }
-    const o = {
-        network,
-        name: PaymentType.P2SH,
-    };
-    const _address = lazy.value(() => {
-        const payload = Buffer.from(bs58check.default.decode(a.address));
-        const version = payload.readUInt8(0);
-        const hash = payload.subarray(1);
-        return { version, hash };
-    });
-    const _chunks = lazy.value(() => {
-        return bscript.decompile(a.input);
-    });
-    const _redeem = lazy.value(() => {
-        const chunks = _chunks();
-        const lastChunk = chunks[chunks.length - 1];
+    /**
+     * Creates a P2SH payment from a scriptPubKey.
+     *
+     * @param output - The scriptPubKey
+     * @param network - Network parameters (defaults to mainnet)
+     * @returns A new P2SH payment instance
+     */
+    static fromOutput(output, network) {
+        return new P2SH({ output, network });
+    }
+    // Private helper methods
+    /**
+     * Converts to a plain P2SHPayment object for backwards compatibility.
+     *
+     * @returns A P2SHPayment object
+     */
+    toPayment() {
         return {
-            network,
-            output: lastChunk === OPS.OP_FALSE ? Buffer.from([]) : lastChunk,
-            input: bscript.compile(chunks.slice(0, -1)),
-            witness: a.witness || [],
+            name: this.name,
+            network: this.network,
+            address: this.address,
+            hash: this.hash,
+            output: this.output,
+            input: this.input,
+            redeem: this.redeem,
+            witness: this.witness,
         };
-    });
-    lazy.prop(o, 'address', () => {
-        if (!o.hash)
-            return;
-        const payload = Buffer.allocUnsafe(21);
-        payload.writeUInt8(o.network.scriptHash, 0);
-        o.hash.copy(payload, 1);
+    }
+    #getDecodedAddress() {
+        if (!this.#decodedAddressComputed) {
+            if (this.#inputAddress) {
+                const payload = new Uint8Array(bs58check.default.decode(this.#inputAddress));
+                this.#decodedAddress = {
+                    version: payload[0],
+                    hash: payload.subarray(1),
+                };
+            }
+            this.#decodedAddressComputed = true;
+        }
+        return this.#decodedAddress;
+    }
+    #getInputChunks() {
+        if (!this.#inputChunksComputed) {
+            if (this.#inputInput) {
+                this.#inputChunks = bscript.decompile(this.#inputInput) ?? undefined;
+            }
+            this.#inputChunksComputed = true;
+        }
+        return this.#inputChunks;
+    }
+    // Private computation methods
+    #getDerivedRedeem() {
+        if (!this.#derivedRedeemComputed) {
+            const chunks = this.#getInputChunks();
+            if (chunks) {
+                const lastChunk = chunks[chunks.length - 1];
+                this.#derivedRedeem = {
+                    network: this.#network,
+                    output: (lastChunk === OPS.OP_FALSE
+                        ? new Uint8Array(0)
+                        : lastChunk),
+                    input: bscript.compile(chunks.slice(0, -1)),
+                    witness: this.#inputWitness || [],
+                };
+            }
+            this.#derivedRedeemComputed = true;
+        }
+        return this.#derivedRedeem;
+    }
+    #computeAddress() {
+        if (this.#inputAddress) {
+            return this.#inputAddress;
+        }
+        const h = this.hash;
+        if (!h)
+            return undefined;
+        const payload = alloc(21);
+        payload[0] = this.#network.scriptHash;
+        payload.set(h, 1);
         return bs58check.default.encode(payload);
-    });
-    lazy.prop(o, 'hash', () => {
-        if (a.output)
-            return a.output.subarray(2, 22);
-        if (a.address)
-            return _address().hash;
-        if (o.redeem && o.redeem.output)
-            return bcrypto.hash160(o.redeem.output);
-    });
-    lazy.prop(o, 'output', () => {
-        if (!o.hash)
-            return;
-        return bscript.compile([OPS.OP_HASH160, o.hash, OPS.OP_EQUAL]);
-    });
-    lazy.prop(o, 'redeem', () => {
-        if (!a.input)
-            return;
-        return _redeem();
-    });
-    lazy.prop(o, 'input', () => {
-        if (!a.redeem || !a.redeem.input || !a.redeem.output)
-            return;
-        return bscript.compile([].concat(bscript.decompile(a.redeem.input), a.redeem.output));
-    });
-    lazy.prop(o, 'witness', () => {
-        if (o.redeem && o.redeem.witness)
-            return o.redeem.witness;
-        if (o.input)
+    }
+    #computeHash() {
+        if (this.#inputHash) {
+            return this.#inputHash;
+        }
+        if (this.#inputOutput) {
+            return this.#inputOutput.subarray(2, 22);
+        }
+        if (this.#inputAddress) {
+            return this.#getDecodedAddress()?.hash;
+        }
+        const r = this.redeem;
+        if (r && r.output) {
+            return bcrypto.hash160(r.output);
+        }
+        return undefined;
+    }
+    #computeOutput() {
+        if (this.#inputOutput) {
+            return this.#inputOutput;
+        }
+        const h = this.hash;
+        if (!h)
+            return undefined;
+        return bscript.compile([OPS.OP_HASH160, h, OPS.OP_EQUAL]);
+    }
+    #computeInput() {
+        if (this.#inputInput) {
+            return this.#inputInput;
+        }
+        const r = this.#inputRedeem;
+        if (!r || !r.input || !r.output) {
+            return undefined;
+        }
+        return bscript.compile([].concat(bscript.decompile(r.input), r.output));
+    }
+    #computeRedeem() {
+        if (this.#inputRedeem) {
+            return this.#inputRedeem;
+        }
+        if (this.#inputInput) {
+            return this.#getDerivedRedeem();
+        }
+        return undefined;
+    }
+    // Validation
+    #computeWitness() {
+        if (this.#inputWitness) {
+            return this.#inputWitness;
+        }
+        const r = this.redeem;
+        if (r && r.witness) {
+            return r.witness;
+        }
+        if (this.input) {
             return [];
-    });
-    lazy.prop(o, 'name', () => {
-        const nameParts = ['p2sh'];
-        if (o.redeem !== undefined && o.redeem.name !== undefined)
-            nameParts.push(o.redeem.name);
-        return nameParts.join('-');
-    });
-    if (opts.validate) {
-        let hash = Buffer.from([]);
-        if (a.address) {
-            if (_address().version !== network.scriptHash)
+        }
+        return undefined;
+    }
+    #checkRedeem(redeem) {
+        // Is the redeem output empty/invalid?
+        if (redeem.output) {
+            const decompile = bscript.decompile(redeem.output);
+            if (!decompile || decompile.length < 1) {
+                throw new TypeError('Redeem.output too short');
+            }
+            if (redeem.output.byteLength > 520) {
+                throw new TypeError('Redeem.output unspendable if larger than 520 bytes');
+            }
+            if (bscript.countNonPushOnlyOPs(decompile) > 201) {
+                throw new TypeError('Redeem.output unspendable with more than 201 non-push ops');
+            }
+        }
+        if (redeem.input) {
+            const hasInput = redeem.input.length > 0;
+            const hasWitness = redeem.witness && redeem.witness.length > 0;
+            if (!hasInput && !hasWitness) {
+                throw new TypeError('Empty input');
+            }
+            if (hasInput && hasWitness) {
+                throw new TypeError('Input and witness provided');
+            }
+            if (hasInput) {
+                const richunks = bscript.decompile(redeem.input);
+                if (!bscript.isPushOnly(richunks)) {
+                    throw new TypeError('Non push-only scriptSig');
+                }
+            }
+        }
+    }
+    #validate() {
+        let hash = new Uint8Array(0);
+        if (this.#inputAddress) {
+            const addr = this.#getDecodedAddress();
+            if (!addr) {
+                throw new TypeError('Invalid address');
+            }
+            if (addr.version !== this.#network.scriptHash) {
                 throw new TypeError('Invalid version or Network mismatch');
-            if (_address().hash.length !== 20)
+            }
+            if (addr.hash.length !== 20) {
                 throw new TypeError('Invalid address');
-            hash = _address().hash;
+            }
+            hash = addr.hash;
         }
-        if (a.hash) {
-            if (hash.length > 0 && !hash.equals(a.hash))
+        if (this.#inputHash) {
+            if (hash.length > 0 && !equals(hash, this.#inputHash)) {
                 throw new TypeError('Hash mismatch');
-            else
-                hash = a.hash;
-        }
-        if (a.output) {
-            if (a.output.length !== 23 ||
-                a.output[0] !== OPS.OP_HASH160 ||
-                a.output[1] !== 0x14 ||
-                a.output[22] !== OPS.OP_EQUAL)
+            }
+            else {
+                hash = this.#inputHash;
+            }
+        }
+        if (this.#inputOutput) {
+            if (this.#inputOutput.length !== 23 ||
+                this.#inputOutput[0] !== OPS.OP_HASH160 ||
+                this.#inputOutput[1] !== 0x14 ||
+                this.#inputOutput[22] !== OPS.OP_EQUAL) {
                 throw new TypeError('Output is invalid');
-            const hash2 = a.output.subarray(2, 22);
-            if (hash.length > 0 && !hash.equals(hash2))
+            }
+            const hash2 = this.#inputOutput.subarray(2, 22);
+            if (hash.length > 0 && !equals(hash, hash2)) {
                 throw new TypeError('Hash mismatch');
-            else
+            }
+            else {
                 hash = hash2;
+            }
         }
-        const checkRedeem = (redeem) => {
-            if (redeem.output) {
-                const decompile = bscript.decompile(redeem.output);
-                if (!decompile || decompile.length < 1)
-                    throw new TypeError('Redeem.output too short');
-                if (redeem.output.byteLength > 520)
-                    throw new TypeError('Redeem.output unspendable if larger than 520 bytes');
-                if (bscript.countNonPushOnlyOPs(decompile) > 201)
-                    throw new TypeError('Redeem.output unspendable with more than 201 non-push ops');
-                const hash2 = bcrypto.hash160(redeem.output);
-                if (hash.length > 0 && !hash.equals(hash2))
+        if (this.#inputInput) {
+            const chunks = this.#getInputChunks();
+            if (!chunks || chunks.length < 1) {
+                throw new TypeError('Input too short');
+            }
+            const derived = this.#getDerivedRedeem();
+            if (!derived || !(derived.output instanceof Uint8Array)) {
+                throw new TypeError('Input is invalid');
+            }
+            this.#checkRedeem(derived);
+            // Match hash against redeem output
+            if (derived.output) {
+                const hash2 = bcrypto.hash160(derived.output);
+                if (hash.length > 0 && !equals(hash, hash2)) {
                     throw new TypeError('Hash mismatch');
-                else
+                }
+                else {
                     hash = hash2;
-            }
-            if (redeem.input) {
-                const hasInput = redeem.input.length > 0;
-                const hasWitness = redeem.witness && redeem.witness.length > 0;
-                if (!hasInput && !hasWitness)
-                    throw new TypeError('Empty input');
-                if (hasInput && hasWitness)
-                    throw new TypeError('Input and witness provided');
-                if (hasInput) {
-                    const richunks = bscript.decompile(redeem.input);
-                    if (!bscript.isPushOnly(richunks))
-                        throw new TypeError('Non push-only scriptSig');
                 }
             }
-        };
-        if (a.input) {
-            const chunks = _chunks();
-            if (!chunks || chunks.length < 1)
-                throw new TypeError('Input too short');
-            if (!Buffer.isBuffer(_redeem().output))
-                throw new TypeError('Input is invalid');
-            checkRedeem(_redeem());
         }
-        if (a.redeem) {
-            if (a.redeem.network && a.redeem.network !== network)
+        if (this.#inputRedeem) {
+            if (this.#inputRedeem.network && this.#inputRedeem.network !== this.#network) {
                 throw new TypeError('Network mismatch');
-            if (a.input) {
-                const redeem = _redeem();
-                if (a.redeem.output && !a.redeem.output.equals(redeem.output))
-                    throw new TypeError('Redeem.output mismatch');
-                if (a.redeem.input && !a.redeem.input.equals(redeem.input))
-                    throw new TypeError('Redeem.input mismatch');
             }
-            checkRedeem(a.redeem);
+            if (this.#inputInput) {
+                const derived = this.#getDerivedRedeem();
+                if (derived) {
+                    if (this.#inputRedeem.output &&
+                        derived.output &&
+                        !equals(this.#inputRedeem.output, derived.output)) {
+                        throw new TypeError('Redeem.output mismatch');
+                    }
+                    if (this.#inputRedeem.input &&
+                        derived.input &&
+                        !equals(this.#inputRedeem.input, derived.input)) {
+                        throw new TypeError('Redeem.input mismatch');
+                    }
+                }
+            }
+            this.#checkRedeem(this.#inputRedeem);
+            // Match hash against redeem output
+            if (this.#inputRedeem.output) {
+                const hash2 = bcrypto.hash160(this.#inputRedeem.output);
+                if (hash.length > 0 && !equals(hash, hash2)) {
+                    throw new TypeError('Hash mismatch');
+                }
+            }
         }
-        if (a.witness) {
-            if (a.redeem && a.redeem.witness && !stacksEqual(a.redeem.witness, a.witness))
+        if (this.#inputWitness) {
+            if (this.#inputRedeem &&
+                this.#inputRedeem.witness &&
+                !stacksEqual(this.#inputRedeem.witness, this.#inputWitness)) {
                 throw new TypeError('Witness and redeem.witness mismatch');
+            }
         }
     }
-    return Object.assign(o, a);
 }
+/**
+ * Creates a Pay-to-Script-Hash (P2SH) payment object.
+ *
+ * This is the legacy factory function for backwards compatibility.
+ * For new code, prefer using the P2SH class directly.
+ *
+ * @param a - The payment object containing the necessary data
+ * @param opts - Optional payment options
+ * @returns The P2SH payment object
+ * @throws {TypeError} If the required data is not provided or if the data is invalid
+ *
+ * @example
+ * ```typescript
+ * import { p2sh, p2ms } from '@btc-vision/bitcoin';
+ *
+ * // Wrap a multisig in P2SH
+ * const multisig = p2ms({ m: 2, pubkeys: [pk1, pk2, pk3] });
+ * const payment = p2sh({ redeem: multisig });
+ * ```
+ */
+export function p2sh(a, opts) {
+    if (!a.address && !a.hash && !a.output && !a.redeem && !a.input) {
+        throw new TypeError('Not enough data');
+    }
+    const instance = new P2SH({
+        address: a.address,
+        hash: a.hash,
+        output: a.output,
+        input: a.input,
+        redeem: a.redeem,
+        witness: a.witness,
+        network: a.network,
+    }, opts);
+    // Return a merged object for backwards compatibility
+    return Object.assign(instance.toPayment(), a);
+}
+//# sourceMappingURL=p2sh.js.map