xpi-ts 0.2.22 → 0.2.24

package/dist/types/lib/bitcore/transaction/outpoint.d.ts

@@ -1,32 +1,142 @@
+/**
+ * COutPoint - A combination of a transaction hash and an index n into its vout
+ *
+ * Faithful TypeScript implementation of lotusd/src/primitives/transaction.h COutPoint.
+ * An outpoint uniquely identifies a specific output of a previous transaction.
+ *
+ * Serialization format (36 bytes):
+ *   - txid: 32 bytes (uint256, little-endian)
+ *   - n: 4 bytes (uint32_t, little-endian)
+ *
+ * Reference: lotusd/src/primitives/transaction.h lines 22-54
+ */
 import { BufferReader } from '../encoding/bufferreader.js';
 import { BufferWriter } from '../encoding/bufferwriter.js';
 import type { Buffer } from 'buffer/';
+/** Serialized size of an outpoint in bytes */
 export declare const OUTPOINT_SIZE = 36;
+/**
+ * Data for constructing an OutPoint from an object
+ */
 export interface OutPointData {
+    /** Transaction ID as hex string (big-endian display order) */
     txid: string;
+    /** Output index within the transaction */
     outputIndex: number;
 }
+/**
+ * Serialized representation of an OutPoint
+ */
 export interface OutPointObject {
+    /** Transaction ID as hex string (big-endian display order) */
     txid: string;
+    /** Output index within the transaction */
     outputIndex: number;
 }
+/**
+ * An outpoint - a combination of a transaction hash and an index n into its
+ * vout.
+ *
+ * Reference: lotusd COutPoint (primitives/transaction.h)
+ */
 export declare class OutPoint {
+    /**
+     * Sentinel value for null output index.
+     * Matches lotusd COutPoint::NULL_INDEX = std::numeric_limits<uint32_t>::max()
+     */
     static readonly NULL_INDEX: number;
+    /** Transaction ID (32 bytes, stored as internal little-endian buffer) */
     private _txid;
+    /** Output index within the transaction (uint32) */
     private _n;
+    /**
+     * Create a new OutPoint
+     *
+     * @param txid - Transaction ID as 32-byte Buffer (little-endian) or hex string (big-endian display order)
+     * @param n - Output index (uint32), defaults to NULL_INDEX
+     */
     constructor(txid?: Buffer | string, n?: number);
+    /**
+     * Create an OutPoint from a data object
+     *
+     * @param data - Object with txid (hex string) and outputIndex
+     * @returns New OutPoint instance
+     */
     static fromObject(data: OutPointData): OutPoint;
+    /**
+     * Deserialize an OutPoint from a buffer
+     *
+     * @param buf - Buffer containing serialized outpoint (36 bytes)
+     * @returns New OutPoint instance
+     */
     static fromBuffer(buf: Buffer): OutPoint;
+    /**
+     * Deserialize an OutPoint from a BufferReader
+     *
+     * Reads: txid (32 bytes LE) + n (4 bytes LE)
+     * Matches lotusd SERIALIZE_METHODS(COutPoint, obj) { READWRITE(obj.txid, obj.n); }
+     *
+     * @param reader - BufferReader positioned at the outpoint data
+     * @returns New OutPoint instance
+     */
     static fromBufferReader(reader: BufferReader): OutPoint;
+    /**
+     * Check if this is a null outpoint (all-zero txid and NULL_INDEX)
+     *
+     * Matches lotusd: bool IsNull() const { return txid.IsNull() && n == NULL_INDEX; }
+     */
     isNull(): boolean;
+    /**
+     * Get the transaction ID as a hex string (big-endian display order)
+     *
+     * Matches lotusd: const TxId &GetTxId() const
+     */
     getTxId(): string;
+    /**
+     * Get the transaction ID as a Buffer (internal little-endian)
+     */
     getTxIdBuffer(): Buffer;
+    /**
+     * Get the output index
+     *
+     * Matches lotusd: uint32_t GetN() const
+     */
     getN(): number;
+    /**
+     * Serialize to a Buffer (36 bytes)
+     *
+     * Format: txid (32 bytes LE) + n (4 bytes LE)
+     * Matches lotusd SERIALIZE_METHODS
+     */
     toBuffer(): Buffer;
+    /**
+     * Write serialized outpoint to a BufferWriter
+     *
+     * @param writer - BufferWriter to write to
+     * @returns The BufferWriter for chaining
+     */
     toBufferWriter(writer: BufferWriter): BufferWriter;
+    /**
+     * Convert to a plain object
+     */
     toObject(): OutPointObject;
+    /**
+     * String representation matching lotusd COutPoint::ToString()
+     *
+     * Format: "COutPoint(txid_prefix, n)"
+     */
     toString(): string;
+    /**
+     * Compare two outpoints for equality
+     *
+     * Matches lotusd: friend bool operator==(const COutPoint &a, const COutPoint &b)
+     */
     equals(other: OutPoint): boolean;
+    /**
+     * Compare two outpoints for ordering (less-than)
+     *
+     * Matches lotusd: friend bool operator<(const COutPoint &a, const COutPoint &b)
+     */
     lessThan(other: OutPoint): boolean;
 }
 //# sourceMappingURL=outpoint.d.ts.map

package/dist/types/lib/bitcore/transaction/outpoint.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"outpoint.d.ts","sourceRoot":"","sources":["../../../../../lib/bitcore/transaction/outpoint.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAE1D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAGrC,eAAO,MAAM,aAAa,KAAK,CAAA;AAK/B,MAAM,WAAW,YAAY;IAE3B,IAAI,EAAE,MAAM,CAAA;IAEZ,WAAW,EAAE,MAAM,CAAA;CACpB;AAKD,MAAM,WAAW,cAAc;IAE7B,IAAI,EAAE,MAAM,CAAA;IAEZ,WAAW,EAAE,MAAM,CAAA;CACpB;AAQD,qBAAa,QAAQ;IAKnB,MAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAa;IAG/C,OAAO,CAAC,KAAK,CAAQ;IAGrB,OAAO,CAAC,EAAE,CAAQ;gBAQN,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAC,EAAE,MAAM;IAiC9C,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,YAAY,GAAG,QAAQ;IAU/C,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ;IAcxC,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE,YAAY,GAAG,QAAQ;IAcvD,MAAM,IAAI,OAAO;IAWjB,OAAO,IAAI,MAAM;IAOjB,aAAa,IAAI,MAAM;IASvB,IAAI,IAAI,MAAM;IAUd,QAAQ,IAAI,MAAM;IAYlB,cAAc,CAAC,MAAM,EAAE,YAAY,GAAG,YAAY;IASlD,QAAQ,IAAI,cAAc;IAY1B,QAAQ,IAAI,MAAM;IASlB,MAAM,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO;IAShC,QAAQ,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO;CAInC"}
+{"version":3,"file":"outpoint.d.ts","sourceRoot":"","sources":["../../../../../lib/bitcore/transaction/outpoint.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAE1D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAErC,8CAA8C;AAC9C,eAAO,MAAM,aAAa,KAAK,CAAA;AAE/B;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,8DAA8D;IAC9D,IAAI,EAAE,MAAM,CAAA;IACZ,0CAA0C;IAC1C,WAAW,EAAE,MAAM,CAAA;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,8DAA8D;IAC9D,IAAI,EAAE,MAAM,CAAA;IACZ,0CAA0C;IAC1C,WAAW,EAAE,MAAM,CAAA;CACpB;AAED;;;;;GAKG;AACH,qBAAa,QAAQ;IACnB;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAa;IAE/C,yEAAyE;IACzE,OAAO,CAAC,KAAK,CAAQ;IAErB,mDAAmD;IACnD,OAAO,CAAC,EAAE,CAAQ;IAElB;;;;;OAKG;gBACS,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAC,EAAE,MAAM;IA2B9C;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,YAAY,GAAG,QAAQ;IAI/C;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ;IAKxC;;;;;;;;OAQG;IACH,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE,YAAY,GAAG,QAAQ;IASvD;;;;OAIG;IACH,MAAM,IAAI,OAAO;IAMjB;;;;OAIG;IACH,OAAO,IAAI,MAAM;IAIjB;;OAEG;IACH,aAAa,IAAI,MAAM;IAIvB;;;;OAIG;IACH,IAAI,IAAI,MAAM;IAId;;;;;OAKG;IACH,QAAQ,IAAI,MAAM;IAMlB;;;;;OAKG;IACH,cAAc,CAAC,MAAM,EAAE,YAAY,GAAG,YAAY;IAMlD;;OAEG;IACH,QAAQ,IAAI,cAAc;IAO1B;;;;OAIG;IACH,QAAQ,IAAI,MAAM;IAIlB;;;;OAIG;IACH,MAAM,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO;IAIhC;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO;CAInC"}

package/dist/types/lib/bitcore/transaction/output.d.ts

@@ -13,6 +13,9 @@ export interface OutputObject {
     script: string;
     asm: string;
 }
+/**
+ * Represents a transaction output
+ */
 export declare class Output {
     satoshis: number;
     private _satoshisBN;
@@ -20,31 +23,111 @@ export declare class Output {
     private _script?;
     constructor(args: OutputData);
     static create(args: OutputData): Output;
+    /**
+     * Parse satoshis from various input types
+     */
     private _parseSatoshis;
+    /**
+     * Get the BN representation of satoshis
+     */
     get satoshisBN(): BN;
+    /**
+     * Set the BN representation of satoshis
+     */
     set satoshisBN(value: BN);
+    /**
+     * Get the script for this output
+     */
     get script(): Script;
+    /**
+     * Get the script buffer
+     */
     get scriptBuffer(): Buffer;
+    /**
+     * Set the script from a buffer
+     */
     setScriptFromBuffer(buffer: Buffer): void;
+    /**
+     * Set the script for this output
+     */
     setScript(script: Script | Buffer | string): Output;
+    /**
+     * Get the amount in XPI
+     */
     getXPI(): number;
+    /**
+     * Set the amount from XPI
+     */
     setXPI(xpi: number): Output;
+    /**
+     * Check if this output is valid
+     */
     isValid(): boolean;
+    /**
+     * Check if this output is dust (too small to be economical)
+     */
     isDust(dustThreshold?: number): boolean;
+    /**
+     * Check if satoshis are invalid
+     */
     invalidSatoshis(): string | false;
+    /**
+     * Check if this is an OP_RETURN output
+     */
     isOpReturn(): boolean;
+    /**
+     * Convert to object representation
+     */
     toObject(): OutputObject;
+    /**
+     * Convert to JSON
+     *
+     * @alias Output.toObject
+     */
     toJSON: () => OutputObject;
+    /**
+     * Debug representation
+     */
     inspect(): string;
+    /**
+     * Create from buffer reader
+     */
     static fromBufferReader(br: BufferReader): Output;
+    /**
+     * Serialize to buffer
+     */
     toBuffer(): Buffer;
+    /**
+     * Serialize to buffer writer
+     */
     toBufferWriter(writer?: BufferWriter): BufferWriter;
+    /**
+     * Get the size of this output in bytes
+     */
     getSize(): number;
+    /**
+     * Clone this output
+     */
     clone(): Output;
+    /**
+     * Create from object
+     */
     static fromObject(data: OutputData): Output;
+    /**
+     * Check if this output is a Pay-to-Public-Key-Hash output
+     */
     isPayToPublicKeyHash(): boolean;
+    /**
+     * Check if this output is a Pay-to-Script-Hash output
+     */
     isPayToScriptHash(): boolean;
+    /**
+     * Check if this output is a Pay-to-Taproot output
+     */
     isPayToTaproot(): boolean;
+    /**
+     * Get the address for this output (if applicable)
+     */
     getAddress(): string | null;
 }
 //# sourceMappingURL=output.d.ts.map

package/dist/types/lib/bitcore/transaction/output.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"output.d.ts","sourceRoot":"","sources":["../../../../../lib/bitcore/transaction/output.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AACrC,OAAO,EAAE,EAAE,EAAE,MAAM,iBAAiB,CAAA;AAGpC,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAG1D,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AAKrC,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,EAAE,GAAG,MAAM,CAAA;IACxC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAA;IACjC,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,MAAM,CAAA;CACZ;AAKD,qBAAa,MAAM;IAEjB,QAAQ,EAAG,MAAM,CAAA;IACjB,OAAO,CAAC,WAAW,CAAK;IACxB,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,OAAO,CAAC,CAAQ;gBAEZ,IAAI,EAAE,UAAU;IA0B5B,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM;IAOvC,OAAO,CAAC,cAAc;IAiCtB,IAAI,UAAU,IAAI,EAAE,CAEnB;IAKD,IAAI,UAAU,CAAC,KAAK,EAAE,EAAE,EAOvB;IAKD,IAAI,MAAM,IAAI,MAAM,CAOnB;IAKD,IAAI,YAAY,IAAI,MAAM,CAEzB;IAKD,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAiBzC,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM;IAoBnD,MAAM,IAAI,MAAM;IAOhB,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAS3B,OAAO,IAAI,OAAO;IAWlB,MAAM,CAAC,aAAa,GAAE,MAAY,GAAG,OAAO;IAO5C,eAAe,IAAI,MAAM,GAAG,KAAK;IAgBjC,UAAU,IAAI,OAAO;IAerB,QAAQ,IAAI,YAAY;IAaxB,MAAM,QAbM,YAAY,CAaF;IAKtB,OAAO,IAAI,MAAM;IAajB,MAAM,CAAC,gBAAgB,CAAC,EAAE,EAAE,YAAY,GAAG,MAAM;IAejD,QAAQ,IAAI,MAAM;IAWlB,cAAc,CAAC,MAAM,CAAC,EAAE,YAAY,GAAG,YAAY;IAcnD,OAAO,IAAI,MAAM;IAWjB,KAAK,IAAI,MAAM;IAUf,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM;IAO3C,oBAAoB,IAAI,OAAO;IAO/B,iBAAiB,IAAI,OAAO;IAO5B,cAAc,IAAI,OAAO;IAOzB,UAAU,IAAI,MAAM,GAAG,IAAI;CAQ5B"}
+{"version":3,"file":"output.d.ts","sourceRoot":"","sources":["../../../../../lib/bitcore/transaction/output.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AACrC,OAAO,EAAE,EAAE,EAAE,MAAM,iBAAiB,CAAA;AAGpC,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAG1D,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AAKrC,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,EAAE,GAAG,MAAM,CAAA;IACxC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAA;IACjC,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,MAAM,CAAA;CACZ;AAED;;GAEG;AACH,qBAAa,MAAM;IAEjB,QAAQ,EAAG,MAAM,CAAA;IACjB,OAAO,CAAC,WAAW,CAAK;IACxB,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,OAAO,CAAC,CAAQ;gBAEZ,IAAI,EAAE,UAAU;IA0B5B,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM;IAIvC;;OAEG;IACH,OAAO,CAAC,cAAc;IA8BtB;;OAEG;IACH,IAAI,UAAU,IAAI,EAAE,CAEnB;IAED;;OAEG;IACH,IAAI,UAAU,CAAC,KAAK,EAAE,EAAE,EAOvB;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,MAAM,CAOnB;IAED;;OAEG;IACH,IAAI,YAAY,IAAI,MAAM,CAEzB;IAED;;OAEG;IACH,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAczC;;OAEG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM;IAiBnD;;OAEG;IACH,MAAM,IAAI,MAAM;IAIhB;;OAEG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAM3B;;OAEG;IACH,OAAO,IAAI,OAAO;IAQlB;;OAEG;IACH,MAAM,CAAC,aAAa,GAAE,MAAY,GAAG,OAAO;IAI5C;;OAEG;IACH,eAAe,IAAI,MAAM,GAAG,KAAK;IAajC;;OAEG;IACH,UAAU,IAAI,OAAO;IAYrB;;OAEG;IACH,QAAQ,IAAI,YAAY;IAQxB;;;;OAIG;IACH,MAAM,QAbM,YAAY,CAaF;IAEtB;;OAEG;IACH,OAAO,IAAI,MAAM;IAUjB;;OAEG;IACH,MAAM,CAAC,gBAAgB,CAAC,EAAE,EAAE,YAAY,GAAG,MAAM;IAYjD;;OAEG;IACH,QAAQ,IAAI,MAAM;IAQlB;;OAEG;IACH,cAAc,CAAC,MAAM,CAAC,EAAE,YAAY,GAAG,YAAY;IAWnD;;OAEG;IACH,OAAO,IAAI,MAAM;IAQjB;;OAEG;IACH,KAAK,IAAI,MAAM;IAOf;;OAEG;IACH,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM;IAI3C;;OAEG;IACH,oBAAoB,IAAI,OAAO;IAI/B;;OAEG;IACH,iBAAiB,IAAI,OAAO;IAI5B;;OAEG;IACH,cAAc,IAAI,OAAO;IAIzB;;OAEG;IACH,UAAU,IAAI,MAAM,GAAG,IAAI;CAQ5B"}

package/dist/types/lib/bitcore/transaction/sighash.d.ts

@@ -7,6 +7,7 @@ import { PrivateKey } from '../privatekey';
 import { PublicKey } from '../publickey';
 import type { Buffer } from 'buffer/';
 export interface TransactionLike {
+    /** This array is also used */
     inputs: Array<{
         prevTxId: Buffer;
         outputIndex: number;
@@ -23,11 +24,79 @@ export interface TransactionLike {
     version?: number;
     nLockTime?: number;
 }
+/**
+ * Calculate the sighash for a transaction
+ *
+ * This function routes to the appropriate sighash algorithm based on flags:
+ * - SIGHASH_LOTUS (0x60): Lotus sighash with merkle trees
+ * - SIGHASH_FORKID (0x40): BIP143 sighash
+ * - Legacy (0x00): Original Bitcoin sighash
+ *
+ * Note: SIGHASH_LOTUS requires spent outputs for all inputs to be available
+ * in the transaction.spentOutputs property.
+ *
+ * @param transaction - The transaction being signed (must have spentOutputs for LOTUS)
+ * @param sighashType - Signature hash type flags
+ * @param inputNumber - Index of input being signed
+ * @param subscript - Script being executed/signed
+ * @param satoshisBN - Value of output being spent (required for FORKID/LOTUS)
+ * @param flags - Script validation flags
+ * @returns 32-byte signature hash
+ */
 declare function sighash(transaction: TransactionLike, sighashType: number, inputNumber: number, subscript: Script, satoshisBN?: BN, flags?: number): Buffer;
+/**
+ * Sign a transaction input
+ *
+ * Generates a cryptographic signature for a transaction input using the specified
+ * signing method (ECDSA or Schnorr) and sighash algorithm.
+ *
+ * Sighash Algorithm Selection:
+ * - If SIGHASH_LOTUS flag is set: Uses Lotus sighash (requires transaction.spentOutputs)
+ * - If SIGHASH_FORKID flag is set: Uses BIP143 sighash
+ * - Otherwise: Uses legacy Bitcoin sighash
+ *
+ * @param transaction - The transaction being signed (must have spentOutputs for LOTUS)
+ * @param privateKey - Private key to sign with
+ * @param sighashType - Signature hash type (e.g., SIGHASH_ALL | SIGHASH_FORKID)
+ * @param inputIndex - Index of the input being signed
+ * @param subscript - The script being executed/signed
+ * @param satoshisBN - Value of the output being spent
+ * @param flags - Script validation flags
+ * @param signingMethod - 'ecdsa' (default) or 'schnorr'
+ * @returns Signature object with nhashtype set
+ * @throws Error if SIGHASH_LOTUS is used without transaction.spentOutputs
+ */
 declare function sign(transaction: TransactionLike, privateKey: PrivateKey, sighashType: number, inputIndex: number, subscript: Script, satoshisBN?: BN, flags?: number, signingMethod?: 'ecdsa' | 'schnorr'): Signature;
+/**
+ * Verify a transaction signature
+ *
+ * Verifies that a signature is valid for the specified transaction input.
+ * Automatically uses the correct sighash algorithm based on the signature's
+ * nhashtype field (LOTUS, FORKID, or legacy).
+ *
+ * @param transaction - The transaction being verified (must have spentOutputs for LOTUS)
+ * @param signature - The signature to verify (must have nhashtype set)
+ * @param publicKey - Public key to verify against
+ * @param inputIndex - Index of the input being verified
+ * @param subscript - The script being executed
+ * @param satoshisBN - Value of the output being spent
+ * @param flags - Script validation flags
+ * @param signingMethod - 'ecdsa' (default) or 'schnorr'
+ * @returns true if signature is valid, false otherwise
+ * @throws Error if SIGHASH_LOTUS is used without transaction.spentOutputs
+ */
 declare function verify(transaction: TransactionLike, signature: Signature, publicKey: PublicKey, inputIndex: number, subscript: Script, satoshisBN?: BN, flags?: number, signingMethod?: 'ecdsa' | 'schnorr'): boolean;
+/**
+ * Default sign flags
+ */
 export declare const DEFAULT_SIGN_FLAGS: number;
+/**
+ * Constants
+ */
 export declare const SIGHASH_SINGLE_BUG = "0000000000000000000000000000000000000000000000000000000000000001";
 export declare const BITS_64_ON = "ffffffffffffffff";
+/**
+ * @namespace Signing
+ */
 export { sighash, sign, verify };
 //# sourceMappingURL=sighash.d.ts.map

package/dist/types/lib/bitcore/transaction/sighash.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sighash.d.ts","sourceRoot":"","sources":["../../../../../lib/bitcore/transaction/sighash.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAC/C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEjC,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAA;AACvD,OAAO,EAAE,EAAE,EAAE,MAAM,cAAc,CAAA;AAOjC,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAC1C,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAGxC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAErC,MAAM,WAAW,eAAe;IAE9B,MAAM,EAAE,KAAK,CAAC;QACZ,QAAQ,EAAE,MAAM,CAAA;QAChB,WAAW,EAAE,MAAM,CAAA;QACnB,cAAc,EAAE,MAAM,CAAA;QACtB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KACvB,CAAC,CAAA;IACF,OAAO,EAAE,KAAK,CAAC;QACb,QAAQ,EAAE,MAAM,CAAA;QAChB,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,cAAc,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAAA;KAC3C,CAAC,CAAA;IACF,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IACvB,QAAQ,IAAI,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAsZD,iBAAS,OAAO,CACd,WAAW,EAAE,eAAe,EAC5B,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM,EACjB,UAAU,CAAC,EAAE,EAAE,EACf,KAAK,CAAC,EAAE,MAAM,GACb,MAAM,CA6HR;AAwBD,iBAAS,IAAI,CACX,WAAW,EAAE,eAAe,EAC5B,UAAU,EAAE,UAAU,EACtB,WAAW,EAAE,MAAM,EACnB,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EACjB,UAAU,CAAC,EAAE,EAAE,EACf,KAAK,CAAC,EAAE,MAAM,EACd,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,GAClC,SAAS,CAwBX;AAoBD,iBAAS,MAAM,CACb,WAAW,EAAE,eAAe,EAC5B,SAAS,EAAE,SAAS,EACpB,SAAS,EAAE,SAAS,EACpB,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EACjB,UAAU,CAAC,EAAE,EAAE,EACf,KAAK,CAAC,EAAE,MAAM,EACd,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,GAClC,OAAO,CA6BT;AA4DD,eAAO,MAAM,kBAAkB,QAA2B,CAAA;AAK1D,eAAO,MAAM,kBAAkB,qEAA2B,CAAA;AAC1D,eAAO,MAAM,UAAU,qBAAmB,CAAA;AAK1C,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAA"}
+{"version":3,"file":"sighash.d.ts","sourceRoot":"","sources":["../../../../../lib/bitcore/transaction/sighash.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAC/C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEjC,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAA;AACvD,OAAO,EAAE,EAAE,EAAE,MAAM,cAAc,CAAA;AAOjC,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAC1C,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAGxC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAErC,MAAM,WAAW,eAAe;IAC9B,8BAA8B;IAC9B,MAAM,EAAE,KAAK,CAAC;QACZ,QAAQ,EAAE,MAAM,CAAA;QAChB,WAAW,EAAE,MAAM,CAAA;QACnB,cAAc,EAAE,MAAM,CAAA;QACtB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KACvB,CAAC,CAAA;IACF,OAAO,EAAE,KAAK,CAAC;QACb,QAAQ,EAAE,MAAM,CAAA;QAChB,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,cAAc,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAAA;KAC3C,CAAC,CAAA;IACF,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IACvB,QAAQ,IAAI,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAmYD;;;;;;;;;;;;;;;;;;GAkBG;AACH,iBAAS,OAAO,CACd,WAAW,EAAE,eAAe,EAC5B,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM,EACjB,UAAU,CAAC,EAAE,EAAE,EACf,KAAK,CAAC,EAAE,MAAM,GACb,MAAM,CA6HR;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,iBAAS,IAAI,CACX,WAAW,EAAE,eAAe,EAC5B,UAAU,EAAE,UAAU,EACtB,WAAW,EAAE,MAAM,EACnB,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EACjB,UAAU,CAAC,EAAE,EAAE,EACf,KAAK,CAAC,EAAE,MAAM,EACd,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,GAClC,SAAS,CAwBX;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,iBAAS,MAAM,CACb,WAAW,EAAE,eAAe,EAC5B,SAAS,EAAE,SAAS,EACpB,SAAS,EAAE,SAAS,EACpB,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EACjB,UAAU,CAAC,EAAE,EAAE,EACf,KAAK,CAAC,EAAE,MAAM,EACd,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,GAClC,OAAO,CA6BT;AAyDD;;GAEG;AACH,eAAO,MAAM,kBAAkB,QAA2B,CAAA;AAE1D;;GAEG;AACH,eAAO,MAAM,kBAAkB,qEAA2B,CAAA;AAC1D,eAAO,MAAM,UAAU,qBAAmB,CAAA;AAE1C;;GAEG;AACH,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAA"}

package/dist/types/lib/bitcore/transaction/signature.d.ts

@@ -17,25 +17,123 @@ export interface TransactionSignatureObject {
     signature: string;
     sigtype: number;
 }
+/**
+ * Represents a digital signature within a transaction input, including identifying information and the signature itself.
+ *
+ * The `TransactionSignature` class wraps a low-level cryptography `Signature` class and includes additional context,
+ * such as which input/output the signature is for, the signer public key, and the sighash type.
+ *
+ * CRITICAL: This class maintains automatic synchronization of the sighash type (nhashtype) between
+ * the TransactionSignature.sigtype and the inner Signature.nhashtype. This ensures that signature
+ * verification and serialization always use the correct sighash type.
+ *
+ * It automatically detects and parses ECDSA (DER format) and Schnorr signatures, supports serialization/deserialization,
+ * and provides basic validation logic.
+ *
+ * @example
+ * const tsig = new TransactionSignature({
+ *   publicKey: pubkey,
+ *   prevTxId: txid,
+ *   outputIndex: 0,
+ *   inputIndex: 0,
+ *   signature: sigBuf, // Buffer, Signature, or hex
+ *   sigtype: Signature.SIGHASH_ALL,
+ * });
+ */
 export declare class TransactionSignature {
+    /** Public key of the signer */
     publicKey: PublicKey;
+    /** Previous transaction id for the referenced UTXO (as Buffer) */
     prevTxId: Buffer;
+    /** Index of the output in the previous transaction being spent */
     outputIndex: number;
+    /** Index of this input in the current transaction */
     inputIndex: number;
+    /** Signature hash type used for this signature (see Signature.SIGHASH_*) */
     private _sigtype;
+    /** Signature value; can be Schnorr or ECDSA, as a Signature object */
     private _signature;
+    /**
+     * Get the signature object
+     * @returns The inner Signature object
+     */
     get signature(): Signature;
+    /**
+     * Set the signature object and automatically sync nhashtype
+     * @param sig The signature to set
+     */
     set signature(sig: Signature);
+    /**
+     * Get the sighash type
+     * @returns The sighash type value
+     */
     get sigtype(): number;
+    /**
+     * Set the sighash type and automatically sync to inner signature
+     * @param type The sighash type value
+     */
     set sigtype(type: number);
+    /**
+     * Creates a new TransactionSignature instance.
+     *
+     * @param arg - The signature data. Must be a TransactionSignatureData, another TransactionSignature, or (never used) string.
+     * @throws {BitcoreError} If required arguments are missing or invalid.
+     */
     constructor(arg?: TransactionSignatureData | TransactionSignature);
+    /**
+     * Initialize a TransactionSignature instance from an object.
+     *
+     * This method will set all required properties of the TransactionSignature, including
+     * parsing and detecting whether the signature uses Schnorr or ECDSA encoding.
+     *
+     * @param arg - The object containing properties to initialize the TransactionSignature.
+     * @returns The TransactionSignature instance with all fields set.
+     * @throws {BitcoreError} If required or invalid arguments are supplied.
+     *
+     * Signature parsing process:
+     *   - If the signature is already a Signature instance, it is directly assigned.
+     *   - If the signature is a Buffer, it detects type (Schnorr/ECDSA) based on length and content,
+     *     optionally stripping a possible sighash byte for type detection.
+     *   - If the signature is a string, it is parsed from hex; type detection is performed similarly.
+     */
     private _fromObject;
+    /**
+     * Validates the input object for TransactionSignature construction.
+     *
+     * @param arg - The object to validate.
+     * @throws {BitcoreError} If required fields are missing or invalid.
+     * @private
+     */
     private _checkObjectArgs;
+    /**
+     * Converts signature to plain JS object representation.
+     * @returns The object with all signature fields as string/number types.
+     */
     toObject(): TransactionSignatureObject;
+    /**
+     * Converts signature to a plain object suitable for JSON serialization.
+     */
     toJSON: () => TransactionSignatureObject;
+    /**
+     * Factory for constructing a TransactionSignature from an object.
+     * @param obj - The signature data.
+     * @returns New TransactionSignature instance.
+     */
     static fromObject(obj: TransactionSignatureData): TransactionSignature;
+    /**
+     * Clone this transaction signature.
+     * @returns Deep copy of this TransactionSignature.
+     */
     clone(): TransactionSignature;
+    /**
+     * Checks if this signature has all required fields and format.
+     * @returns True if the signature is structurally valid.
+     */
     isValid(): boolean;
+    /**
+     * Returns a human-readable string representation.
+     * @returns Format like "TransactionSignature(0:0)".
+     */
     toString(): string;
 }
 //# sourceMappingURL=signature.d.ts.map

package/dist/types/lib/bitcore/transaction/signature.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"signature.d.ts","sourceRoot":"","sources":["../../../../../lib/bitcore/transaction/signature.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAkB,MAAM,cAAc,CAAA;AAExD,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAE/C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAErC,MAAM,WAAW,wBAAwB;IACvC,SAAS,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,CAAA;IACtC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAA;IACzB,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,CAAA;IACtC,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,0BAA0B;IACzC,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,CAAA;CAChB;AAyBD,qBAAa,oBAAoB;IAE/B,SAAS,EAAG,SAAS,CAAA;IAErB,QAAQ,EAAG,MAAM,CAAA;IAEjB,WAAW,EAAG,MAAM,CAAA;IAEpB,UAAU,EAAG,MAAM,CAAA;IAEnB,OAAO,CAAC,QAAQ,CAAS;IAEzB,OAAO,CAAC,UAAU,CAAY;IAM9B,IAAI,SAAS,IAAI,SAAS,CAEzB;IAMD,IAAI,SAAS,CAAC,GAAG,EAAE,SAAS,EAM3B;IAMD,IAAI,OAAO,IAAI,MAAM,CAEpB;IAMD,IAAI,OAAO,CAAC,IAAI,EAAE,MAAM,EAMvB;gBAQW,GAAG,CAAC,EAAE,wBAAwB,GAAG,oBAAoB;IA8BjE,OAAO,CAAC,WAAW;IAiEnB,OAAO,CAAC,gBAAgB;IAqDxB,QAAQ,IAAI,0BAA0B;IActC,MAAM,QAdM,0BAA0B,CAchB;IAOtB,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,wBAAwB,GAAG,oBAAoB;IAQtE,KAAK,IAAI,oBAAoB;IAe7B,OAAO,IAAI,OAAO;IAkBlB,QAAQ,IAAI,MAAM;CAGnB"}
+{"version":3,"file":"signature.d.ts","sourceRoot":"","sources":["../../../../../lib/bitcore/transaction/signature.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAkB,MAAM,cAAc,CAAA;AAExD,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAE/C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAErC,MAAM,WAAW,wBAAwB;IACvC,SAAS,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,CAAA;IACtC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAA;IACzB,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,CAAA;IACtC,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,0BAA0B;IACzC,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,CAAA;CAChB;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,oBAAoB;IAC/B,+BAA+B;IAC/B,SAAS,EAAG,SAAS,CAAA;IACrB,kEAAkE;IAClE,QAAQ,EAAG,MAAM,CAAA;IACjB,kEAAkE;IAClE,WAAW,EAAG,MAAM,CAAA;IACpB,qDAAqD;IACrD,UAAU,EAAG,MAAM,CAAA;IACnB,4EAA4E;IAC5E,OAAO,CAAC,QAAQ,CAAS;IACzB,sEAAsE;IACtE,OAAO,CAAC,UAAU,CAAY;IAE9B;;;OAGG;IACH,IAAI,SAAS,IAAI,SAAS,CAEzB;IAED;;;OAGG;IACH,IAAI,SAAS,CAAC,GAAG,EAAE,SAAS,EAM3B;IAED;;;OAGG;IACH,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED;;;OAGG;IACH,IAAI,OAAO,CAAC,IAAI,EAAE,MAAM,EAMvB;IAED;;;;;OAKG;gBACS,GAAG,CAAC,EAAE,wBAAwB,GAAG,oBAAoB;IAcjE;;;;;;;;;;;;;;;OAeG;IACH,OAAO,CAAC,WAAW;IA0DnB;;;;;;OAMG;IACH,OAAO,CAAC,gBAAgB;IAiDxB;;;OAGG;IACH,QAAQ,IAAI,0BAA0B;IAWtC;;OAEG;IACH,MAAM,QAdM,0BAA0B,CAchB;IAEtB;;;;OAIG;IACH,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,wBAAwB,GAAG,oBAAoB;IAItE;;;OAGG;IACH,KAAK,IAAI,oBAAoB;IAW7B;;;OAGG;IACH,OAAO,IAAI,OAAO;IAclB;;;OAGG;IACH,QAAQ,IAAI,MAAM;CAGnB"}