xpi-ts 0.2.22 → 0.2.24

package/dist/types/lib/bitcore/script/interpreter/interpreter.d.ts

@@ -1,10 +1,81 @@
+/**
+ * Copyright 2025-2026 The Lotusia Stewardship
+ * Github: https://github.com/LotusiaStewardship
+ * License: MIT
+ *
+ * Lotus Script Interpreter
+ *
+ * Client-side script evaluation engine for validating that crafted
+ * transactions will pass lotusd consensus checks before broadcasting.
+ *
+ * This is NOT a consensus implementation. It mirrors lotusd behavior
+ * to give wallets confidence that their transactions are well-formed.
+ * The authoritative interpreter is always lotusd itself.
+ *
+ * Architecture:
+ * - evalScript(): Executes a single script on a stack
+ * - verifyScript(): Orchestrates scriptSig + scriptPubKey evaluation
+ * - SignatureChecker interface: Pluggable signature verification
+ *
+ * Reference: lotusd/src/script/interpreter.cpp
+ *
+ * @module Interpreter
+ */
 import { Script } from '../../script';
 import { ScriptFlags, type ScriptResult, type ScriptExecutionMetrics, type ScriptExecutionData, type SignatureChecker } from './types';
 import type { Buffer } from 'buffer/';
+/** Type alias for stack elements (byte arrays) */
 type StackElement = Buffer;
+/**
+ * Evaluate a script on the given stack.
+ *
+ * This is the core script execution engine. It processes each opcode
+ * sequentially, manipulating the stack according to Lotus consensus
+ * rules. Conditional execution (IF/ELSE/ENDIF) is tracked via the
+ * ConditionStack.
+ *
+ * For client-side validation, this function verifies that a script
+ * will execute successfully under lotusd consensus rules.
+ *
+ * @param stack - The data stack (modified in place)
+ * @param scriptBuf - Raw script bytes to execute
+ * @param flags - Script verification flags
+ * @param checker - Signature verification interface
+ * @param metrics - Execution metrics (modified in place)
+ * @param execdata - Execution data for sighash (modified in place)
+ * @returns ScriptResult indicating success or failure with error code
+ */
 export declare function evalScript(stack: StackElement[], scriptBuf: Buffer, flags: number, checker: SignatureChecker, metrics: ScriptExecutionMetrics, execdata: ScriptExecutionData): ScriptResult;
+/**
+ * Verify a scriptSig + scriptPubKey pair.
+ *
+ * This is the main entry point for client-side transaction validation.
+ * It evaluates scriptSig, then scriptPubKey, handling P2SH and
+ * OP_SCRIPTTYPE (Taproot) dispatch.
+ *
+ * For a wallet building transactions, call this after signing to
+ * confirm the transaction will be accepted by the network.
+ *
+ * @param scriptSig - The unlocking script (raw bytes)
+ * @param scriptPubKey - The locking script (raw bytes)
+ * @param flags - Script verification flags
+ * @param checker - Signature verification interface
+ * @returns ScriptResult with success status and error code
+ */
 export declare function verifyScript(scriptSig: Buffer, scriptPubKey: Buffer, flags: number, checker: SignatureChecker): ScriptResult;
+/**
+ * Class-based wrapper around the functional interpreter API.
+ *
+ * Provides backward compatibility with existing code that expects:
+ * - Static flag constants (e.g., `Interpreter.SCRIPT_ENABLE_SIGHASH_FORKID`)
+ * - An instance `verify()` method with transaction context
+ * - An `errstr` property for error diagnostics
+ *
+ * New code should prefer the functional `evalScript()` / `verifyScript()`
+ * API directly, using `ScriptFlags` enum for flag constants.
+ */
 export declare class Interpreter {
+    /** Last error string from verify(), empty on success */
     errstr: string;
     static SCRIPT_VERIFY_NONE: ScriptFlags;
     static SCRIPT_TAPROOT_KEY_SPEND_PATH: ScriptFlags;
@@ -15,6 +86,21 @@ export declare class Interpreter {
     static SCRIPT_ENABLE_SIGHASH_FORKID: ScriptFlags;
     static SCRIPT_ENABLE_REPLAY_PROTECTION: ScriptFlags;
     static SCRIPT_VERIFY_INPUT_SIGCHECKS: ScriptFlags;
+    /**
+     * Verify a scriptSig + scriptPubKey pair in the context of a transaction.
+     *
+     * This is the high-level entry point used by Transaction.verify().
+     * It constructs a TransactionSignatureChecker from the provided
+     * transaction context and delegates to verifyScript().
+     *
+     * @param scriptSig - The unlocking script
+     * @param scriptPubKey - The locking script
+     * @param tx - The spending transaction
+     * @param nin - The input index being verified
+     * @param flags - Script verification flags
+     * @param satoshis - The value of the output being spent (for BIP143/Lotus sighash)
+     * @returns true if verification succeeds
+     */
     verify(scriptSig: Script, scriptPubKey: Script, tx: any, nin: number, flags: number, satoshis?: bigint): boolean;
 }
 export {};

package/dist/types/lib/bitcore/script/interpreter/interpreter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"interpreter.d.ts","sourceRoot":"","sources":["../../../../../../lib/bitcore/script/interpreter/interpreter.ts"],"names":[],"mappings":"AA8BA,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AAGrC,OAAO,EAQL,WAAW,EACX,KAAK,YAAY,EACjB,KAAK,sBAAsB,EAC3B,KAAK,mBAAmB,EACxB,KAAK,gBAAgB,EACtB,MAAM,SAAS,CAAA;AAchB,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAKrC,KAAK,YAAY,GAAG,MAAM,CAAA;AAsQ1B,wBAAgB,UAAU,CACxB,KAAK,EAAE,YAAY,EAAE,EACrB,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,gBAAgB,EACzB,OAAO,EAAE,sBAAsB,EAC/B,QAAQ,EAAE,mBAAmB,GAC5B,YAAY,CAuGd;AA+xCD,wBAAgB,YAAY,CAC1B,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,MAAM,EACpB,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,gBAAgB,GACxB,YAAY,CAqGd;AAuED,qBAAa,WAAW;IAEtB,MAAM,EAAE,MAAM,CAAK;IAKnB,MAAM,CAAC,kBAAkB,cAA0B;IACnD,MAAM,CAAC,6BAA6B,cAAqC;IACzE,MAAM,CAAC,oCAAoC,cACA;IAC3C,MAAM,CAAC,wCAAwC,cACA;IAC/C,MAAM,CAAC,wBAAwB,cAAgC;IAC/D,MAAM,CAAC,uBAAuB,cAA+B;IAC7D,MAAM,CAAC,4BAA4B,cAAoC;IACvE,MAAM,CAAC,+BAA+B,cAAuC;IAC7E,MAAM,CAAC,6BAA6B,cAAqC;IAiBzE,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,MAAM,EACpB,EAAE,EAAE,GAAG,EACP,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,EACb,QAAQ,CAAC,EAAE,MAAM,GAChB,OAAO;CAeX"}
+{"version":3,"file":"interpreter.d.ts","sourceRoot":"","sources":["../../../../../../lib/bitcore/script/interpreter/interpreter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAQH,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AAGrC,OAAO,EAQL,WAAW,EACX,KAAK,YAAY,EACjB,KAAK,sBAAsB,EAC3B,KAAK,mBAAmB,EACxB,KAAK,gBAAgB,EACtB,MAAM,SAAS,CAAA;AAchB,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAIrC,kDAAkD;AAClD,KAAK,YAAY,GAAG,MAAM,CAAA;AAmP1B;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,UAAU,CACxB,KAAK,EAAE,YAAY,EAAE,EACrB,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,gBAAgB,EACzB,OAAO,EAAE,sBAAsB,EAC/B,QAAQ,EAAE,mBAAmB,GAC5B,YAAY,CAuGd;AA+wCD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,YAAY,CAC1B,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,MAAM,EACpB,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,gBAAgB,GACxB,YAAY,CAqGd;AA4DD;;;;;;;;;;GAUG;AACH,qBAAa,WAAW;IACtB,wDAAwD;IACxD,MAAM,EAAE,MAAM,CAAK;IAKnB,MAAM,CAAC,kBAAkB,cAA0B;IACnD,MAAM,CAAC,6BAA6B,cAAqC;IACzE,MAAM,CAAC,oCAAoC,cACA;IAC3C,MAAM,CAAC,wCAAwC,cACA;IAC/C,MAAM,CAAC,wBAAwB,cAAgC;IAC/D,MAAM,CAAC,uBAAuB,cAA+B;IAC7D,MAAM,CAAC,4BAA4B,cAAoC;IACvE,MAAM,CAAC,+BAA+B,cAAuC;IAC7E,MAAM,CAAC,6BAA6B,cAAqC;IAEzE;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,MAAM,EACpB,EAAE,EAAE,GAAG,EACP,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,EACb,QAAQ,CAAC,EAAE,MAAM,GAChB,OAAO;CAeX"}

package/dist/types/lib/bitcore/script/interpreter/script-num.d.ts

@@ -1,26 +1,134 @@
+/**
+ * Copyright 2025-2026 The Lotusia Stewardship
+ * Github: https://github.com/LotusiaStewardship
+ * License: MIT
+ *
+ * Script Number Arithmetic
+ *
+ * Implements the CScriptNum equivalent for Lotus script evaluation.
+ * Script numbers are signed integers stored as variable-length
+ * little-endian byte arrays with sign-magnitude encoding.
+ *
+ * Lotus uses 8-byte script numbers (int64 range), unlike Bitcoin's
+ * 4-byte limit. The valid range is [-2^63+1, 2^63-1].
+ *
+ * Reference: lotusd/src/script/script.h (CScriptNum)
+ *
+ * @module ScriptNum
+ */
 import type { Buffer } from 'buffer/';
+/**
+ * Error thrown when script number operations overflow or
+ * encounter invalid encodings.
+ */
 export declare class ScriptNumError extends Error {
     constructor(message: string);
 }
+/**
+ * Script number representation for stack-based arithmetic.
+ *
+ * Wraps a bigint value with serialization/deserialization that
+ * matches the lotusd CScriptNum wire format. All arithmetic
+ * operations check for overflow within the int64 range.
+ *
+ * SECURITY: The value INT64_MIN (-2^63) is explicitly excluded
+ * from the valid range to avoid undefined behavior in negation.
+ */
 export declare class ScriptNum {
     private static readonly INT64_MAX;
     private static readonly INT64_MIN_EXCLUSIVE;
+    /** The underlying numeric value */
     readonly value: bigint;
     constructor(value: bigint);
+    /**
+     * Decode a script number from its stack byte representation.
+     *
+     * @param buf - The byte array from the stack
+     * @param requireMinimal - Require minimally-encoded numbers
+     * @param maxSize - Maximum byte length (default: 8)
+     * @returns A new ScriptNum
+     * @throws {ScriptNumError} On overflow or non-minimal encoding
+     */
     static fromBuffer(buf: Buffer, requireMinimal?: boolean, maxSize?: number): ScriptNum;
+    /**
+     * Check if a byte array is minimally encoded as a script number.
+     *
+     * Minimal encoding rules:
+     * - Empty array encodes 0
+     * - No unnecessary leading zero bytes
+     * - Sign bit uses the MSB of the last byte
+     *
+     * @param buf - The byte array to check
+     * @param maxSize - Maximum allowed size
+     * @returns true if minimally encoded
+     */
     static isMinimallyEncoded(buf: Buffer, maxSize?: number): boolean;
+    /**
+     * Minimally encode a byte array in-place.
+     *
+     * Removes unnecessary padding bytes while preserving the
+     * numeric value and sign.
+     *
+     * @param data - Mutable byte array to encode minimally
+     * @returns The minimally encoded buffer
+     */
     static minimallyEncode(data: Buffer): Buffer;
+    /**
+     * Decode a little-endian sign-magnitude byte array to bigint.
+     *
+     * @param buf - The byte array to decode
+     * @returns The decoded numeric value
+     */
     private static decode;
+    /**
+     * Serialize this script number to its stack byte representation.
+     *
+     * @returns Minimally-encoded little-endian sign-magnitude bytes
+     */
     toBuffer(): Buffer;
+    /**
+     * Serialize a bigint value to script number byte format.
+     *
+     * @param value - The numeric value to serialize
+     * @returns Minimally-encoded byte array
+     */
     static serialize(value: bigint): Buffer;
+    /**
+     * Get the value as a regular number (clamped to int32 range).
+     *
+     * @returns The value clamped to [-2^31, 2^31-1]
+     */
     toNumber(): number;
+    /**
+     * Add two script numbers with overflow checking.
+     *
+     * @throws {ScriptNumError} On int64 overflow
+     */
     add(other: ScriptNum): ScriptNum;
+    /**
+     * Subtract two script numbers with overflow checking.
+     *
+     * @throws {ScriptNumError} On int64 overflow
+     */
     sub(other: ScriptNum): ScriptNum;
+    /** Negate this script number */
     negate(): ScriptNum;
+    /** Absolute value */
     abs(): ScriptNum;
+    /** Integer division */
     div(other: ScriptNum): ScriptNum;
+    /** Modulo */
     mod(other: ScriptNum): ScriptNum;
+    /**
+     * Multiply by power of 2 (OP_MULPOW2).
+     *
+     * Equivalent to value * 2^shift for positive shift,
+     * or value / 2^|shift| for negative shift.
+     *
+     * @throws {ScriptNumError} On overflow
+     */
     mulpow2(shift: ScriptNum): ScriptNum;
+    /** Bitwise AND */
     bitwiseAnd(mask: bigint): ScriptNum;
     isZero(): boolean;
     isNegative(): boolean;
@@ -30,6 +138,13 @@ export declare class ScriptNum {
     gte(other: ScriptNum | bigint): boolean;
     eq(other: ScriptNum | bigint): boolean;
     neq(other: ScriptNum | bigint): boolean;
+    /**
+     * Validate that a result is within the valid int64 range.
+     *
+     * INT64_MIN is excluded because negating it causes overflow.
+     *
+     * @throws {ScriptNumError} If value is out of range
+     */
     private static checkOverflow;
 }
 //# sourceMappingURL=script-num.d.ts.map

package/dist/types/lib/bitcore/script/interpreter/script-num.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"script-num.d.ts","sourceRoot":"","sources":["../../../../../../lib/bitcore/script/interpreter/script-num.ts"],"names":[],"mappings":"AAqBA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAMrC,qBAAa,cAAe,SAAQ,KAAK;gBAC3B,OAAO,EAAE,MAAM;CAI5B;AAYD,qBAAa,SAAS;IACpB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAmB;IACpD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,mBAAmB,CAAoB;IAG/D,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;gBAEV,KAAK,EAAE,MAAM;IAazB,MAAM,CAAC,UAAU,CACf,GAAG,EAAE,MAAM,EACX,cAAc,GAAE,OAAc,EAC9B,OAAO,GAAE,MAAmC,GAC3C,SAAS;IAsBZ,MAAM,CAAC,kBAAkB,CACvB,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,MAAmC,GAC3C,OAAO;IA0BV,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAuC5C,OAAO,CAAC,MAAM,CAAC,MAAM;IAwBrB,QAAQ,IAAI,MAAM;IAUlB,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IA6BvC,QAAQ,IAAI,MAAM;IAmBlB,GAAG,CAAC,KAAK,EAAE,SAAS,GAAG,SAAS;IAWhC,GAAG,CAAC,KAAK,EAAE,SAAS,GAAG,SAAS;IAOhC,MAAM,IAAI,SAAS;IAKnB,GAAG,IAAI,SAAS;IAKhB,GAAG,CAAC,KAAK,EAAE,SAAS,GAAG,SAAS;IAKhC,GAAG,CAAC,KAAK,EAAE,SAAS,GAAG,SAAS;IAYhC,OAAO,CAAC,KAAK,EAAE,SAAS,GAAG,SAAS;IA2BpC,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS;IAMnC,MAAM,IAAI,OAAO;IAIjB,UAAU,IAAI,OAAO;IAIrB,EAAE,CAAC,KAAK,EAAE,SAAS,GAAG,MAAM,GAAG,OAAO;IAKtC,EAAE,CAAC,KAAK,EAAE,SAAS,GAAG,MAAM,GAAG,OAAO;IAKtC,GAAG,CAAC,KAAK,EAAE,SAAS,GAAG,MAAM,GAAG,OAAO;IAKvC,GAAG,CAAC,KAAK,EAAE,SAAS,GAAG,MAAM,GAAG,OAAO;IAKvC,EAAE,CAAC,KAAK,EAAE,SAAS,GAAG,MAAM,GAAG,OAAO;IAKtC,GAAG,CAAC,KAAK,EAAE,SAAS,GAAG,MAAM,GAAG,OAAO;IAYvC,OAAO,CAAC,MAAM,CAAC,aAAa;CAK7B"}
+{"version":3,"file":"script-num.d.ts","sourceRoot":"","sources":["../../../../../../lib/bitcore/script/interpreter/script-num.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAIH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAErC;;;GAGG;AACH,qBAAa,cAAe,SAAQ,KAAK;gBAC3B,OAAO,EAAE,MAAM;CAI5B;AAED;;;;;;;;;GASG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAmB;IACpD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,mBAAmB,CAAoB;IAE/D,mCAAmC;IACnC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;gBAEV,KAAK,EAAE,MAAM;IAIzB;;;;;;;;OAQG;IACH,MAAM,CAAC,UAAU,CACf,GAAG,EAAE,MAAM,EACX,cAAc,GAAE,OAAc,EAC9B,OAAO,GAAE,MAAmC,GAC3C,SAAS;IAUZ;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,kBAAkB,CACvB,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,MAAmC,GAC3C,OAAO;IAiBV;;;;;;;;OAQG;IACH,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAiC5C;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,MAAM;IAmBrB;;;;OAIG;IACH,QAAQ,IAAI,MAAM;IAIlB;;;;;OAKG;IACH,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAwBvC;;;;OAIG;IACH,QAAQ,IAAI,MAAM;IAclB;;;;OAIG;IACH,GAAG,CAAC,KAAK,EAAE,SAAS,GAAG,SAAS;IAMhC;;;;OAIG;IACH,GAAG,CAAC,KAAK,EAAE,SAAS,GAAG,SAAS;IAMhC,gCAAgC;IAChC,MAAM,IAAI,SAAS;IAInB,qBAAqB;IACrB,GAAG,IAAI,SAAS;IAIhB,uBAAuB;IACvB,GAAG,CAAC,KAAK,EAAE,SAAS,GAAG,SAAS;IAIhC,aAAa;IACb,GAAG,CAAC,KAAK,EAAE,SAAS,GAAG,SAAS;IAIhC;;;;;;;OAOG;IACH,OAAO,CAAC,KAAK,EAAE,SAAS,GAAG,SAAS;IA0BpC,kBAAkB;IAClB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS;IAMnC,MAAM,IAAI,OAAO;IAIjB,UAAU,IAAI,OAAO;IAIrB,EAAE,CAAC,KAAK,EAAE,SAAS,GAAG,MAAM,GAAG,OAAO;IAKtC,EAAE,CAAC,KAAK,EAAE,SAAS,GAAG,MAAM,GAAG,OAAO;IAKtC,GAAG,CAAC,KAAK,EAAE,SAAS,GAAG,MAAM,GAAG,OAAO;IAKvC,GAAG,CAAC,KAAK,EAAE,SAAS,GAAG,MAAM,GAAG,OAAO;IAKvC,EAAE,CAAC,KAAK,EAAE,SAAS,GAAG,MAAM,GAAG,OAAO;IAKtC,GAAG,CAAC,KAAK,EAAE,SAAS,GAAG,MAAM,GAAG,OAAO;IAKvC;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,CAAC,aAAa;CAK7B"}

package/dist/types/lib/bitcore/script/interpreter/types.d.ts

@@ -1,24 +1,77 @@
+/**
+ * Copyright 2025-2026 The Lotusia Stewardship
+ * Github: https://github.com/LotusiaStewardship
+ * License: MIT
+ *
+ * Script Interpreter Types and Constants
+ *
+ * Defines all types, error codes, script flags, and constants used by
+ * the Lotus script interpreter. These mirror the lotusd consensus rules
+ * but are tailored for client-side transaction validation.
+ *
+ * Reference: lotusd/src/script/script.h, script_flags.h, script_error.h
+ *
+ * @module InterpreterTypes
+ */
 import type { Buffer } from 'buffer/';
+/** Maximum number of bytes pushable to the stack */
 export declare const MAX_SCRIPT_ELEMENT_SIZE = 520;
+/** Maximum number of non-push operations per script */
 export declare const MAX_OPS_PER_SCRIPT = 400;
+/** Maximum number of public keys per multisig */
 export declare const MAX_PUBKEYS_PER_MULTISIG = 20;
+/** Maximum script length in bytes */
 export declare const MAX_SCRIPT_SIZE = 10000;
+/** Maximum number of values on script interpreter stack */
 export declare const MAX_STACK_SIZE = 1000;
+/** Maximum number of bytes OP_NUM2BIN can produce */
 export declare const MAX_NUM2BIN_SIZE = 68;
+/**
+ * Threshold for nLockTime: below this value it is interpreted as
+ * block number, otherwise as UNIX timestamp.
+ */
 export declare const LOCKTIME_THRESHOLD = 500000000;
+/** Maximum element size for CScriptNum (8 bytes = int64 range) */
 export declare const SCRIPTNUM_MAX_ELEMENT_SIZE = 8;
+/**
+ * Script verification flags matching lotusd consensus.
+ *
+ * For client-side validation, the standard set of flags should be used
+ * to ensure crafted transactions will pass node validation.
+ */
 export declare enum ScriptFlags {
     VERIFY_NONE = 0,
+    /** Require Lotus sighash and Schnorr for Taproot key spend */
     TAPROOT_KEY_SPEND_PATH = 1,
+    /** Disable Taproot scripts and SIGHASH_LOTUS */
     DISABLE_TAPROOT_SIGHASH_LOTUS = 2,
+    /** Discourage upgradable NOPs (NOP1, NOP4-NOP10) */
     VERIFY_DISCOURAGE_UPGRADABLE_NOPS = 128,
+    /** Require exactly one stack element after evaluation */
     VERIFY_CLEANSTACK = 256,
+    /** Require OP_IF/NOTIF argument to be exactly 0x01 or empty */
     VERIFY_MINIMALIF = 8192,
+    /** Accept SIGHASH_FORKID or SIGHASH_LOTUS signatures */
     ENABLE_SIGHASH_FORKID = 65536,
+    /** Activate replay protection with different fork id */
     ENABLE_REPLAY_PROTECTION = 131072,
+    /** Require sigchecks in input to satisfy scriptSig length bound */
     VERIFY_INPUT_SIGCHECKS = 4194304
 }
+/**
+ * Standard flags for client-side transaction validation.
+ *
+ * This combination matches what lotusd uses for mempool acceptance,
+ * ensuring crafted transactions will be accepted by the network.
+ */
 export declare const STANDARD_SCRIPT_VERIFY_FLAGS: number;
+/**
+ * Script execution error codes matching lotusd ScriptError enum.
+ *
+ * These provide detailed failure reasons for script evaluation,
+ * enabling client-side wallets to diagnose why a transaction
+ * would be rejected before broadcasting.
+ */
 export declare enum ScriptError {
     OK = "OK",
     UNKNOWN = "UNKNOWN",
@@ -80,22 +133,88 @@ export declare enum ScriptError {
     TAPROOT_LEAF_VERSION_NOT_SUPPORTED = "TAPROOT_LEAF_VERSION_NOT_SUPPORTED",
     TAPROOT_PHASEOUT = "TAPROOT_PHASEOUT"
 }
+/**
+ * Result of script evaluation or verification.
+ *
+ * Provides both the success/failure boolean and a detailed error code
+ * for diagnostics. Client-side wallets can use the error code to
+ * provide meaningful feedback about why a transaction would fail.
+ */
 export interface ScriptResult {
+    /** Whether the script evaluation succeeded */
     success: boolean;
+    /** Detailed error code (ScriptError.OK on success) */
     error: ScriptError;
 }
+/**
+ * Metrics collected during script execution.
+ *
+ * Tracks signature check count for INPUT_SIGCHECKS validation.
+ */
 export interface ScriptExecutionMetrics {
+    /** Number of signature checks performed */
     sigChecks: number;
 }
+/**
+ * Data generated during script execution for sighash computation.
+ *
+ * Reference: lotusd/src/script/script_exec_data.h
+ */
 export interface ScriptExecutionData {
+    /** Opcode position of the last executed OP_CODESEPARATOR */
     codeseparatorPos: number;
+    /** SHA-256d of the complete script being executed */
     executedScriptHash: Buffer;
 }
+/**
+ * Interface for signature verification during script execution.
+ *
+ * Client-side implementations provide transaction context so the
+ * interpreter can verify signatures against the spending transaction.
+ *
+ * Reference: lotusd BaseSignatureChecker / TransactionSignatureChecker
+ */
 export interface SignatureChecker {
+    /**
+     * Verify a raw signature against a sighash
+     *
+     * @param signature - The raw signature bytes (without sighash byte)
+     * @param publicKey - The public key bytes
+     * @param sighash - The 32-byte sighash to verify against
+     * @returns true if the signature is valid
+     */
     verifySignature(signature: Buffer, publicKey: Buffer, sighash: Buffer): boolean;
+    /**
+     * Check a transaction signature (with sighash type byte appended)
+     *
+     * @param signature - Signature with sighash type byte
+     * @param publicKey - The public key bytes
+     * @param execdata - Script execution data for sighash computation
+     * @param scriptCode - The script code for sighash computation
+     * @param flags - Script verification flags
+     * @returns true if the signature is valid
+     */
     checkSignature(signature: Buffer, publicKey: Buffer, execdata: ScriptExecutionData | undefined, scriptCode: Buffer, flags: number): boolean;
+    /**
+     * Check OP_CHECKLOCKTIMEVERIFY constraint
+     *
+     * @param lockTime - The lock time value from the stack
+     * @returns true if the lock time constraint is satisfied
+     */
     checkLockTime(lockTime: bigint): boolean;
+    /**
+     * Check OP_CHECKSEQUENCEVERIFY constraint
+     *
+     * @param sequence - The sequence value from the stack
+     * @returns true if the sequence constraint is satisfied
+     */
     checkSequence(sequence: bigint): boolean;
 }
+/**
+ * A no-op signature checker that always returns false.
+ *
+ * Used when evaluating scripts that should not contain signature
+ * operations (e.g., scriptSig evaluation in isolation).
+ */
 export declare const NULL_SIGNATURE_CHECKER: SignatureChecker;
 //# sourceMappingURL=types.d.ts.map

package/dist/types/lib/bitcore/script/interpreter/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../../lib/bitcore/script/interpreter/types.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAMrC,eAAO,MAAM,uBAAuB,MAAM,CAAA;AAG1C,eAAO,MAAM,kBAAkB,MAAM,CAAA;AAGrC,eAAO,MAAM,wBAAwB,KAAK,CAAA;AAG1C,eAAO,MAAM,eAAe,QAAS,CAAA;AAGrC,eAAO,MAAM,cAAc,OAAQ,CAAA;AAGnC,eAAO,MAAM,gBAAgB,KAAK,CAAA;AAMlC,eAAO,MAAM,kBAAkB,YAAc,CAAA;AAG7C,eAAO,MAAM,0BAA0B,IAAI,CAAA;AAU3C,oBAAY,WAAW;IACrB,WAAW,IAAI;IAGf,sBAAsB,IAAS;IAG/B,6BAA6B,IAAS;IAGtC,iCAAiC,MAAS;IAG1C,iBAAiB,MAAS;IAG1B,gBAAgB,OAAU;IAG1B,qBAAqB,QAAU;IAG/B,wBAAwB,SAAU;IAGlC,sBAAsB,UAAU;CACjC;AAQD,eAAO,MAAM,4BAA4B,QAKL,CAAA;AAWpC,oBAAY,WAAW;IACrB,EAAE,OAAO;IACT,OAAO,YAAY;IACnB,UAAU,eAAe;IACzB,SAAS,cAAc;IAGvB,WAAW,gBAAgB;IAC3B,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,UAAU,eAAe;IACzB,SAAS,cAAc;IACvB,YAAY,iBAAiB;IAC7B,eAAe,oBAAoB;IAGnC,oBAAoB,yBAAyB;IAC7C,oBAAoB,yBAAyB;IAC7C,mBAAmB,wBAAwB;IAC3C,mBAAmB,wBAAwB;IAC3C,iBAAiB,sBAAsB;IAGvC,MAAM,WAAW;IACjB,WAAW,gBAAgB;IAC3B,mBAAmB,wBAAwB;IAC3C,cAAc,mBAAmB;IACjC,kBAAkB,uBAAuB;IACzC,cAAc,mBAAmB;IAGjC,UAAU,eAAe;IACzB,eAAe,oBAAoB;IACnC,uBAAuB,4BAA4B;IACnD,0BAA0B,+BAA+B;IACzD,sBAAsB,2BAA2B;IAGjD,WAAW,gBAAgB;IAC3B,WAAW,gBAAgB;IAG3B,qBAAqB,0BAA0B;IAC/C,iBAAiB,sBAAsB;IAGvC,iBAAiB,sBAAsB;IACvC,oBAAoB,yBAAyB;IAG7C,YAAY,iBAAiB;IAC7B,OAAO,YAAY;IACnB,WAAW,gBAAgB;IAC3B,YAAY,iBAAiB;IAC7B,UAAU,eAAe;IACzB,UAAU,eAAe;IACzB,UAAU,eAAe;IACzB,SAAS,cAAc;IACvB,YAAY,iBAAiB;IAG7B,aAAa,kBAAkB;IAC/B,cAAc,mBAAmB;IAGjC,0BAA0B,+BAA+B;IAGzD,cAAc,mBAAmB;IACjC,eAAe,oBAAoB;IAGnC,oBAAoB,yBAAyB;IAG7C,qBAAqB,0BAA0B;IAC/C,uBAAuB,4BAA4B;IACnD,2BAA2B,gCAAgC;IAG3D,wCAAwC,6CAA6C;IACrF,sCAAsC,2CAA2C;IACjF,+BAA+B,oCAAoC;IACnE,2BAA2B,gCAAgC;IAC3D,0BAA0B,+BAA+B;IACzD,gCAAgC,qCAAqC;IACrE,kCAAkC,uCAAuC;IACzE,gBAAgB,qBAAqB;CACtC;AAWD,MAAM,WAAW,YAAY;IAE3B,OAAO,EAAE,OAAO,CAAA;IAEhB,KAAK,EAAE,WAAW,CAAA;CACnB;AAOD,MAAM,WAAW,sBAAsB;IAErC,SAAS,EAAE,MAAM,CAAA;CAClB;AAOD,MAAM,WAAW,mBAAmB;IAElC,gBAAgB,EAAE,MAAM,CAAA;IAExB,kBAAkB,EAAE,MAAM,CAAA;CAC3B;AAUD,MAAM,WAAW,gBAAgB;IAS/B,eAAe,CACb,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,GACd,OAAO,CAAA;IAYV,cAAc,CACZ,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,mBAAmB,GAAG,SAAS,EACzC,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAA;IAQV,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAA;IAQxC,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAA;CACzC;AAQD,eAAO,MAAM,sBAAsB,EAAE,gBAKpC,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../../lib/bitcore/script/interpreter/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAKrC,oDAAoD;AACpD,eAAO,MAAM,uBAAuB,MAAM,CAAA;AAE1C,uDAAuD;AACvD,eAAO,MAAM,kBAAkB,MAAM,CAAA;AAErC,iDAAiD;AACjD,eAAO,MAAM,wBAAwB,KAAK,CAAA;AAE1C,qCAAqC;AACrC,eAAO,MAAM,eAAe,QAAS,CAAA;AAErC,2DAA2D;AAC3D,eAAO,MAAM,cAAc,OAAQ,CAAA;AAEnC,qDAAqD;AACrD,eAAO,MAAM,gBAAgB,KAAK,CAAA;AAElC;;;GAGG;AACH,eAAO,MAAM,kBAAkB,YAAc,CAAA;AAE7C,kEAAkE;AAClE,eAAO,MAAM,0BAA0B,IAAI,CAAA;AAI3C;;;;;GAKG;AACH,oBAAY,WAAW;IACrB,WAAW,IAAI;IAEf,8DAA8D;IAC9D,sBAAsB,IAAS;IAE/B,gDAAgD;IAChD,6BAA6B,IAAS;IAEtC,oDAAoD;IACpD,iCAAiC,MAAS;IAE1C,yDAAyD;IACzD,iBAAiB,MAAS;IAE1B,+DAA+D;IAC/D,gBAAgB,OAAU;IAE1B,wDAAwD;IACxD,qBAAqB,QAAU;IAE/B,wDAAwD;IACxD,wBAAwB,SAAU;IAElC,mEAAmE;IACnE,sBAAsB,UAAU;CACjC;AAED;;;;;GAKG;AACH,eAAO,MAAM,4BAA4B,QAKL,CAAA;AAIpC;;;;;;GAMG;AACH,oBAAY,WAAW;IACrB,EAAE,OAAO;IACT,OAAO,YAAY;IACnB,UAAU,eAAe;IACzB,SAAS,cAAc;IAGvB,WAAW,gBAAgB;IAC3B,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,UAAU,eAAe;IACzB,SAAS,cAAc;IACvB,YAAY,iBAAiB;IAC7B,eAAe,oBAAoB;IAGnC,oBAAoB,yBAAyB;IAC7C,oBAAoB,yBAAyB;IAC7C,mBAAmB,wBAAwB;IAC3C,mBAAmB,wBAAwB;IAC3C,iBAAiB,sBAAsB;IAGvC,MAAM,WAAW;IACjB,WAAW,gBAAgB;IAC3B,mBAAmB,wBAAwB;IAC3C,cAAc,mBAAmB;IACjC,kBAAkB,uBAAuB;IACzC,cAAc,mBAAmB;IAGjC,UAAU,eAAe;IACzB,eAAe,oBAAoB;IACnC,uBAAuB,4BAA4B;IACnD,0BAA0B,+BAA+B;IACzD,sBAAsB,2BAA2B;IAGjD,WAAW,gBAAgB;IAC3B,WAAW,gBAAgB;IAG3B,qBAAqB,0BAA0B;IAC/C,iBAAiB,sBAAsB;IAGvC,iBAAiB,sBAAsB;IACvC,oBAAoB,yBAAyB;IAG7C,YAAY,iBAAiB;IAC7B,OAAO,YAAY;IACnB,WAAW,gBAAgB;IAC3B,YAAY,iBAAiB;IAC7B,UAAU,eAAe;IACzB,UAAU,eAAe;IACzB,UAAU,eAAe;IACzB,SAAS,cAAc;IACvB,YAAY,iBAAiB;IAG7B,aAAa,kBAAkB;IAC/B,cAAc,mBAAmB;IAGjC,0BAA0B,+BAA+B;IAGzD,cAAc,mBAAmB;IACjC,eAAe,oBAAoB;IAGnC,oBAAoB,yBAAyB;IAG7C,qBAAqB,0BAA0B;IAC/C,uBAAuB,4BAA4B;IACnD,2BAA2B,gCAAgC;IAG3D,wCAAwC,6CAA6C;IACrF,sCAAsC,2CAA2C;IACjF,+BAA+B,oCAAoC;IACnE,2BAA2B,gCAAgC;IAC3D,0BAA0B,+BAA+B;IACzD,gCAAgC,qCAAqC;IACrE,kCAAkC,uCAAuC;IACzE,gBAAgB,qBAAqB;CACtC;AAID;;;;;;GAMG;AACH,MAAM,WAAW,YAAY;IAC3B,8CAA8C;IAC9C,OAAO,EAAE,OAAO,CAAA;IAChB,sDAAsD;IACtD,KAAK,EAAE,WAAW,CAAA;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,2CAA2C;IAC3C,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,4DAA4D;IAC5D,gBAAgB,EAAE,MAAM,CAAA;IACxB,qDAAqD;IACrD,kBAAkB,EAAE,MAAM,CAAA;CAC3B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;;;;OAOG;IACH,eAAe,CACb,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,GACd,OAAO,CAAA;IAEV;;;;;;;;;OASG;IACH,cAAc,CACZ,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,mBAAmB,GAAG,SAAS,EACzC,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAA;IAEV;;;;;OAKG;IACH,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAA;IAExC;;;;;OAKG;IACH,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAA;CACzC;AAED;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,EAAE,gBAKpC,CAAA"}