xpi-ts 0.2.23 → 0.3.1

package/dist/types/lib/bitcore/block/block.d.ts

@@ -1,49 +1,263 @@
+/**
+ * Block implementation for the Lotus blockchain
+ *
+ * Represents a complete Lotus block (CBlock in lotusd) containing a header,
+ * extended metadata fields, and transactions.
+ *
+ * Serialization order:
+ *   CBlockHeader(160 bytes) + varint(metadata count) + metadata fields +
+ *   varint(tx count) + transactions
+ *
+ * Lotus merkle tree construction:
+ *   Each transaction contributes two leaves: txhash (SHA256d of serialized tx)
+ *   and txid (merkle-based identifier). These are combined per-transaction as
+ *   SHA256d(txhash || txid) before building the merkle tree.
+ *
+ * @see lotusd: src/primitives/block.h, src/primitives/block.cpp
+ */
 import { Buffer } from 'buffer/';
 import { BufferReader } from '../encoding/bufferreader.js';
 import { BufferWriter } from '../encoding/bufferwriter.js';
 import { Transaction } from '../transaction/index.js';
 import { BlockHeader, type BlockHeaderData, type BlockHeaderObject } from './blockheader.js';
 import { MerkleBlock } from './merkleblock.js';
+/**
+ * Block data interface for construction (internal format).
+ * Used when creating a Block from deserialized data or objects.
+ */
 export interface BlockData {
+    /** Block header (BlockHeader instance or BlockHeaderData) */
     header?: BlockHeader | BlockHeaderData;
+    /** Array of transactions in this block */
     transactions?: Transaction[];
 }
+/**
+ * Block object interface for serialization/JSON.
+ * All values converted to serializable formats.
+ */
 export interface BlockObject {
+    /** Block hash (big-endian hex) */
     id: string;
+    /** Block hash (big-endian hex, alias for id) */
     hash: string;
+    /** Serialized block header object */
     header: BlockHeaderObject;
+    /** Array of serialized transaction objects */
     transactions: unknown[];
 }
+/**
+ * Represents a complete Lotus blockchain block.
+ *
+ * A Block extends the BlockHeader with metadata and transactions, providing
+ * methods for serialization, merkle tree computation, and validation.
+ *
+ * @example
+ * ```typescript
+ * // Create from hex string
+ * const block = Block.fromString(hexString)
+ *
+ * // Create from buffer
+ * const block = Block.fromBuffer(buffer)
+ *
+ * // Access block hash
+ * console.log(block.id)
+ *
+ * // Validate merkle root
+ * if (block.validMerkleRoot()) {
+ *   console.log('Merkle root is valid')
+ * }
+ *
+ * // Create SPV proof for specific transactions
+ * const merkleBlock = block.toMerkleBlock(['txid1...'])
+ * ```
+ */
 export declare class Block {
+    /** Maximum block size (32 MiB) */
     static readonly MAX_BLOCK_SIZE: number;
+    /** 32-byte zero hash constant */
     static readonly NULL_HASH: Buffer;
+    /** Block header */
     header: BlockHeader;
+    /** Transactions in this block */
     transactions: Transaction[];
+    /** Cached block hash */
     private _id?;
+    /**
+     * Create a new Block
+     *
+     * @param serialized - Input data: BlockData object, Block instance,
+     *                     Buffer, or hex string
+     *
+     * @example
+     * ```typescript
+     * // From hex string
+     * const block = new Block(hexString)
+     *
+     * // From object
+     * const block = new Block({ header: headerData, transactions: [] })
+     *
+     * // Empty block
+     * const block = new Block()
+     * ```
+     */
     constructor(serialized?: BlockData | Block | Buffer | string);
+    /**
+     * Create a shallow copy of a block by serializing and deserializing it.
+     *
+     * @param block - Block to copy
+     * @returns New Block instance with the same data
+     */
     static shallowCopy(block: Block): Block;
+    /**
+     * Create a Block from an object containing header and transactions.
+     *
+     * @param obj - BlockData object
+     * @returns New Block instance
+     */
     static fromObject(obj: BlockData): Block;
+    /**
+     * Create a Block from a BufferReader.
+     *
+     * @param br - BufferReader positioned at block data
+     * @returns New Block instance
+     */
     static fromBufferReader(br: BufferReader): Block;
+    /**
+     * Create a Block from a Buffer.
+     *
+     * @param buf - Buffer containing serialized block data
+     * @returns New Block instance
+     */
     static fromBuffer(buf: Buffer): Block;
+    /**
+     * Create a Block from a hex string.
+     *
+     * @param str - Hex-encoded serialized block
+     * @returns New Block instance
+     */
     static fromString(str: string): Block;
+    /**
+     * Create a Block from raw block data (e.g., from disk or network).
+     *
+     * @param data - Raw block data as Buffer or binary string
+     * @returns New Block instance
+     */
     static fromRawBlock(data: Buffer | string): Block;
+    /**
+     * Convert to a plain JavaScript object.
+     *
+     * @returns BlockObject with all values serialized
+     */
     toObject(): BlockObject;
+    /**
+     * Convert to JSON (alias for toObject)
+     */
     toJSON(): BlockObject;
+    /**
+     * Serialize the block to a Buffer.
+     *
+     * Format: header + varint(0 metadata) + varint(tx count) + transactions
+     *
+     * @returns Buffer containing serialized block data
+     */
     toBuffer(): Buffer;
+    /**
+     * Serialize the block to a hex string.
+     *
+     * @returns Hex-encoded serialized block
+     */
     toString(): string;
+    /**
+     * Write block data to a BufferWriter.
+     *
+     * Serializes header, metadata vector (currently empty), and transactions
+     * to match lotusd CBlock serialization format.
+     *
+     * @param bw - Optional BufferWriter to reuse
+     * @returns BufferWriter containing the serialized block data
+     */
     toBufferWriter(bw?: BufferWriter): BufferWriter;
+    /**
+     * Compute combined transaction hashes for merkle tree construction.
+     *
+     * In Lotus, each transaction contributes two identifiers:
+     * - **hash**: SHA256d of the serialized transaction data
+     * - **txid**: Merkle-based identifier (inputs/outputs merkle roots)
+     *
+     * These are combined as SHA256d(hash || txid) per transaction.
+     *
+     * @returns Array of 32-byte hash buffers, one per transaction.
+     *          Returns [NULL_HASH] if the block has no transactions.
+     */
     getTransactionHashes(): Buffer[];
+    /**
+     * Build the full merkle tree from transaction hashes.
+     *
+     * Constructs the tree by iteratively hashing pairs of nodes. If a level
+     * has an odd number of elements, a null hash is appended to make it even.
+     *
+     * @returns Array of Buffers representing all tree nodes.
+     *          The merkle root is the last element.
+     */
     getMerkleTree(): Buffer[];
+    /**
+     * Compute the merkle root from the transactions in this block.
+     *
+     * @returns 32-byte merkle root buffer
+     */
     getMerkleRoot(): Buffer;
+    /**
+     * Verify that the computed merkle root matches the header merkle root.
+     *
+     * @returns True if the merkle roots match
+     */
     validMerkleRoot(): boolean;
+    /**
+     * Create a MerkleBlock containing a partial merkle tree for specific
+     * transactions. Used for SPV (Simplified Payment Verification).
+     *
+     * @param txids - Array of transaction IDs to include in the proof
+     * @returns MerkleBlock with partial merkle tree
+     *
+     * @throws {TypeError} If txids is empty or contains invalid format
+     * @throws {Error} If block has no transactions
+     */
     toMerkleBlock(txids: string[]): MerkleBlock;
+    /**
+     * Block hash in display format (big-endian hex).
+     * Delegates to the header hash computation.
+     */
     get hash(): string;
+    /**
+     * Block ID (alias for hash)
+     */
     get id(): string;
+    /**
+     * String representation for console/debugging
+     */
     inspect(): string;
+    /**
+     * Dispatch construction from Buffer or object.
+     */
     private static _from;
+    /**
+     * Create BlockData from an object, normalizing header and transactions.
+     */
     private static _fromObject;
+    /**
+     * Read a complete block from a BufferReader.
+     *
+     * Reads: header + metadata vector + transaction vector
+     * (matches lotusd CBlock serialization)
+     */
     private static _readFromBuffer;
+    /**
+     * Initialize an empty block with default header and no transactions.
+     */
     private _initEmpty;
+    /**
+     * Deserialize block from a hex string (instance method).
+     */
     private _fromString;
 }
 //# sourceMappingURL=block.d.ts.map

package/dist/types/lib/bitcore/block/block.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"block.d.ts","sourceRoot":"","sources":["../../../../../lib/bitcore/block/block.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAGhC,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAG1D,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAGrD,OAAO,EACL,WAAW,EACX,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACvB,MAAM,kBAAkB,CAAA;AACzB,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAM9C,MAAM,WAAW,SAAS;IAExB,MAAM,CAAC,EAAE,WAAW,GAAG,eAAe,CAAA;IAEtC,YAAY,CAAC,EAAE,WAAW,EAAE,CAAA;CAC7B;AAMD,MAAM,WAAW,WAAW;IAE1B,EAAE,EAAE,MAAM,CAAA;IAEV,IAAI,EAAE,MAAM,CAAA;IAEZ,MAAM,EAAE,iBAAiB,CAAA;IAEzB,YAAY,EAAE,OAAO,EAAE,CAAA;CACxB;AA4BD,qBAAa,KAAK;IAEhB,MAAM,CAAC,QAAQ,CAAC,cAAc,SAAmB;IAEjD,MAAM,CAAC,QAAQ,CAAC,SAAS,SAAY;IAGrC,MAAM,EAAG,WAAW,CAAA;IAGpB,YAAY,EAAG,WAAW,EAAE,CAAA;IAG5B,OAAO,CAAC,GAAG,CAAC,CAAQ;gBAoBR,UAAU,CAAC,EAAE,SAAS,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM;IA2B5D,MAAM,CAAC,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK;IAUvC,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,SAAS,GAAG,KAAK;IAWxC,MAAM,CAAC,gBAAgB,CAAC,EAAE,EAAE,YAAY,GAAG,KAAK;IAYhD,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK;IAUrC,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK;IAUrC,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK;IAkBjD,QAAQ,IAAI,WAAW;IAavB,MAAM,IAAI,WAAW;IAWrB,QAAQ,IAAI,MAAM;IASlB,QAAQ,IAAI,MAAM;IAalB,cAAc,CAAC,EAAE,CAAC,EAAE,YAAY,GAAG,YAAY;IA8B/C,oBAAoB,IAAI,MAAM,EAAE;IAsBhC,aAAa,IAAI,MAAM,EAAE;IAwBzB,aAAa,IAAI,MAAM;IAUvB,eAAe,IAAI,OAAO;IAgB1B,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,WAAW;IAoE3C,IAAI,IAAI,IAAI,MAAM,CAKjB;IAKD,IAAI,EAAE,IAAI,MAAM,CAEf;IAKD,OAAO,IAAI,MAAM;IAWjB,OAAO,CAAC,MAAM,CAAC,KAAK;IAYpB,OAAO,CAAC,MAAM,CAAC,WAAW;IA0B1B,OAAO,CAAC,MAAM,CAAC,eAAe;IA2B9B,OAAO,CAAC,UAAU;IAQlB,OAAO,CAAC,WAAW;CAMpB"}
+{"version":3,"file":"block.d.ts","sourceRoot":"","sources":["../../../../../lib/bitcore/block/block.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAGhC,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAG1D,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAGrD,OAAO,EACL,WAAW,EACX,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACvB,MAAM,kBAAkB,CAAA;AACzB,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAE9C;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,6DAA6D;IAC7D,MAAM,CAAC,EAAE,WAAW,GAAG,eAAe,CAAA;IACtC,0CAA0C;IAC1C,YAAY,CAAC,EAAE,WAAW,EAAE,CAAA;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,kCAAkC;IAClC,EAAE,EAAE,MAAM,CAAA;IACV,gDAAgD;IAChD,IAAI,EAAE,MAAM,CAAA;IACZ,qCAAqC;IACrC,MAAM,EAAE,iBAAiB,CAAA;IACzB,8CAA8C;IAC9C,YAAY,EAAE,OAAO,EAAE,CAAA;CACxB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,qBAAa,KAAK;IAChB,kCAAkC;IAClC,MAAM,CAAC,QAAQ,CAAC,cAAc,SAAmB;IACjD,iCAAiC;IACjC,MAAM,CAAC,QAAQ,CAAC,SAAS,SAAY;IAErC,mBAAmB;IACnB,MAAM,EAAG,WAAW,CAAA;IAEpB,iCAAiC;IACjC,YAAY,EAAG,WAAW,EAAE,CAAA;IAE5B,wBAAwB;IACxB,OAAO,CAAC,GAAG,CAAC,CAAQ;IAEpB;;;;;;;;;;;;;;;;;OAiBG;gBACS,UAAU,CAAC,EAAE,SAAS,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM;IAqB5D;;;;;OAKG;IACH,MAAM,CAAC,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK;IAIvC;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,SAAS,GAAG,KAAK;IAKxC;;;;;OAKG;IACH,MAAM,CAAC,gBAAgB,CAAC,EAAE,EAAE,YAAY,GAAG,KAAK;IAMhD;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK;IAIrC;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK;IAIrC;;;;;OAKG;IACH,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK;IAajD;;;;OAIG;IACH,QAAQ,IAAI,WAAW;IAUvB;;OAEG;IACH,MAAM,IAAI,WAAW;IAIrB;;;;;;OAMG;IACH,QAAQ,IAAI,MAAM;IAIlB;;;;OAIG;IACH,QAAQ,IAAI,MAAM;IAIlB;;;;;;;;OAQG;IACH,cAAc,CAAC,EAAE,CAAC,EAAE,YAAY,GAAG,YAAY;IAkB/C;;;;;;;;;;;OAWG;IACH,oBAAoB,IAAI,MAAM,EAAE;IAahC;;;;;;;;OAQG;IACH,aAAa,IAAI,MAAM,EAAE;IAmBzB;;;;OAIG;IACH,aAAa,IAAI,MAAM;IAKvB;;;;OAIG;IACH,eAAe,IAAI,OAAO;IAM1B;;;;;;;;;OASG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,WAAW;IAgE3C;;;OAGG;IACH,IAAI,IAAI,IAAI,MAAM,CAKjB;IAED;;OAEG;IACH,IAAI,EAAE,IAAI,MAAM,CAEf;IAED;;OAEG;IACH,OAAO,IAAI,MAAM;IAQjB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,KAAK;IASpB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,WAAW;IAoB1B;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,eAAe;IAwB9B;;OAEG;IACH,OAAO,CAAC,UAAU;IAKlB;;OAEG;IACH,OAAO,CAAC,WAAW;CAMpB"}

package/dist/types/lib/bitcore/block/blockheader.d.ts

@@ -1,80 +1,300 @@
+/**
+ * BlockHeader implementation for the Lotus blockchain
+ *
+ * Represents the header portion of a Lotus block (CBlockHeader in lotusd).
+ * Implements the Lotus-specific 3-layer hashing algorithm and custom field
+ * sizes for time (6 bytes), size (7 bytes), nonce (8 bytes), etc.
+ *
+ * Serialization order (160 bytes total):
+ *   prevHash(32) + bits(4) + time(6) + reserved(2) + nonce(8) +
+ *   version(1) + size(7) + height(4) + epochBlock(32) +
+ *   merkleRoot(32) + extendedMetadata(32)
+ *
+ * Hash algorithm (3-layer SHA256):
+ *   Layer 3: SHA256(version || size || height || epochBlock || merkleRoot || extendedMetadata)
+ *   Layer 2: SHA256(bits || time || reserved || nonce || layer3Hash)
+ *   Layer 1: SHA256(prevHash || layer2Hash)
+ *
+ * @see lotusd: src/primitives/block.h, src/primitives/block.cpp
+ */
 import { Buffer } from 'buffer/';
 import { BufferReader } from '../encoding/bufferreader.js';
 import { BufferWriter } from '../encoding/bufferwriter.js';
 import { BN } from '../crypto/bn.js';
+/**
+ * Block header data interface for internal/deserialized format.
+ * Uses native types: Buffer for hashes, BN for large numbers.
+ */
 export interface BlockHeaderData {
+    /** Hash of the previous block (32 bytes, little-endian) */
     prevHash?: Buffer;
+    /** Compact representation of the target difficulty */
     bits?: number;
+    /** Block timestamp in seconds since Unix epoch */
     time?: number;
+    /** Reserved field for future use (always 0) */
     reserved?: number;
+    /** Nonce used for proof of work (8 bytes) */
     nonce?: BN;
+    /** Block header version number (1 byte, always 0x01) */
     version?: number;
+    /** Advertised block size (7 bytes) */
     size?: BN;
+    /** Block height in the chain */
     height?: number;
+    /** Hash of the epoch block (32 bytes, little-endian) */
     epochBlock?: Buffer;
+    /** Merkle root of all transactions (32 bytes, little-endian) */
     merkleRoot?: Buffer;
+    /** Extended metadata hash (32 bytes, little-endian) */
     extendedMetadata?: Buffer;
+    /** Precomputed block hash for validation (display format, big-endian hex) */
     hash?: string;
 }
+/**
+ * Block header object interface for serialization/JSON.
+ * All values are converted to serializable formats (strings and numbers).
+ * Hash fields are in display format (big-endian hex).
+ */
 export interface BlockHeaderObject {
+    /** Computed block hash (big-endian hex) */
     hash: string;
+    /** Hash of the previous block (big-endian hex) */
     prevHash: string;
+    /** Compact representation of the target difficulty */
     bits: number;
+    /** Block timestamp in seconds since Unix epoch */
     time: number;
+    /** Reserved field for future use */
     reserved: number;
+    /** Nonce as decimal string */
     nonce: string;
+    /** Block header version number */
     version: number;
+    /** Advertised block size as number */
     size: number;
+    /** Block height in the chain */
     height: number;
+    /** Hash of the epoch block (big-endian hex) */
     epochBlock: string;
+    /** Merkle root of all transactions (big-endian hex) */
     merkleRoot: string;
+    /** Extended metadata hash (big-endian hex) */
     extendedMetadata: string;
 }
+/**
+ * Represents a Lotus blockchain block header.
+ *
+ * Implements the CBlockHeader structure from lotusd with Lotus-specific
+ * features including 3-layer SHA256 hashing, 6-byte timestamps, 7-byte
+ * block sizes, and epoch block references.
+ *
+ * @example
+ * ```typescript
+ * // Create from buffer
+ * const header = BlockHeader.fromBuffer(headerBuffer)
+ *
+ * // Get block hash
+ * console.log(header.id)
+ *
+ * // Validate proof of work
+ * if (header.validProofOfWork()) {
+ *   console.log('Valid PoW')
+ * }
+ *
+ * // Serialize to buffer
+ * const buffer = header.toBuffer()
+ * ```
+ */
 export declare class BlockHeader {
+    /** Start buffer position in raw block data */
     static readonly START_OF_HEADER = 0;
+    /** Maximum time offset (2 hours) a block timestamp can be ahead of current time */
     static readonly MAX_TIME_OFFSET: number;
+    /** Largest possible hash value (2^256) for difficulty calculations */
     static readonly LARGEST_HASH: BN;
+    /** Total serialized size of a block header */
     static readonly HEADER_SIZE = 160;
+    /** Number of blocks per epoch */
     static readonly EPOCH_NUM_BLOCKS = 5040;
+    /** Constants structure for backward compatibility */
     static readonly Constants: {
         START_OF_HEADER: number;
         MAX_TIME_OFFSET: number;
         LARGEST_HASH: BN;
     };
+    /** Hash of the previous block (32 bytes, little-endian) */
     readonly prevHash: Buffer;
+    /** Compact target difficulty */
     readonly bits: number;
+    /** Block timestamp in seconds since Unix epoch */
     readonly time: number;
+    /** Alias for time (backward compatibility) */
     readonly timestamp: number;
+    /** Reserved field (always 0) */
     readonly reserved: number;
+    /** Nonce used for proof of work */
     readonly nonce: BN;
+    /** Header version (always 0x01) */
     readonly version: number;
+    /** Advertised block size */
     readonly size: BN;
+    /** Block height in the chain */
     readonly height: number;
+    /** Hash of the epoch block (32 bytes, little-endian) */
     readonly epochBlock: Buffer;
+    /** Merkle root of transactions (32 bytes, little-endian) */
     readonly merkleRoot: Buffer;
+    /** Extended metadata hash (32 bytes, little-endian) */
     readonly extendedMetadata: Buffer;
+    /** Cached block hash (big-endian hex, display format) */
     private _id?;
+    /**
+     * Create a new BlockHeader
+     *
+     * @param arg - BlockHeaderData object or existing BlockHeader instance
+     *
+     * @example
+     * ```typescript
+     * // Empty header with defaults
+     * const header = new BlockHeader()
+     *
+     * // From deserialized data
+     * const header = new BlockHeader({ prevHash: buf, bits: 0x1d00ffff, ... })
+     * ```
+     */
     constructor(arg?: BlockHeaderData | BlockHeader);
+    /**
+     * Create from a BlockHeaderObject (serialized/JSON format).
+     * Hash fields are expected in display format (big-endian hex strings).
+     *
+     * @param obj - BlockHeaderObject with display-format hashes
+     * @returns New BlockHeader instance
+     */
     static fromObject(obj: BlockHeaderObject): BlockHeader;
+    /**
+     * Create from raw block data (binary string or Buffer)
+     *
+     * @param data - Raw block data
+     * @returns New BlockHeader instance
+     */
     static fromRawBlock(data: Buffer | string): BlockHeader;
+    /**
+     * Create from a Buffer containing a serialized block header
+     *
+     * @param buf - Buffer with serialized header data
+     * @returns New BlockHeader instance
+     */
     static fromBuffer(buf: Buffer): BlockHeader;
+    /**
+     * Create from a hex string
+     *
+     * @param str - Hex-encoded serialized block header
+     * @returns New BlockHeader instance
+     */
     static fromString(str: string): BlockHeader;
+    /**
+     * Create from a BufferReader
+     *
+     * @param br - BufferReader positioned at the start of header data
+     * @returns New BlockHeader instance
+     */
     static fromBufferReader(br: BufferReader): BlockHeader;
+    /**
+     * Convert to a plain JavaScript object (serializable format).
+     * Hash fields are in display format (big-endian hex).
+     *
+     * @returns BlockHeaderObject with all values as strings/numbers
+     */
     toObject(): BlockHeaderObject;
+    /**
+     * Convert to JSON (alias for toObject)
+     */
     toJSON(): BlockHeaderObject;
+    /**
+     * Serialize to a Buffer (160 bytes)
+     *
+     * @returns Buffer containing the serialized block header
+     */
     toBuffer(): Buffer;
+    /**
+     * Serialize to a hex string
+     *
+     * @returns Hex-encoded serialized block header
+     */
     toString(): string;
+    /**
+     * Write header fields to a BufferWriter.
+     *
+     * Serialization order matches lotusd CBlockHeader::SERIALIZE_METHODS:
+     *   prevHash(32) + bits(4) + time(6) + reserved(2) + nonce(8) +
+     *   version(1) + size(7) + height(4) + epochBlock(32) +
+     *   merkleRoot(32) + extendedMetadata(32)
+     *
+     * @param bw - Optional BufferWriter to reuse
+     * @returns BufferWriter containing the serialized data
+     */
     toBufferWriter(bw?: BufferWriter): BufferWriter;
+    /**
+     * Block hash in display format (big-endian hex).
+     * Computed using the Lotus 3-layer SHA256 algorithm.
+     */
     get hash(): string;
+    /**
+     * Block ID (alias for hash)
+     */
     get id(): string;
+    /**
+     * Calculate the target difficulty from compact bits encoding.
+     *
+     * @param bits - Optional compact bits value (defaults to this.bits)
+     * @returns Target as a BN value
+     */
     getTargetDifficulty(bits?: number): BN;
+    /**
+     * Calculate the human-readable difficulty value.
+     *
+     * @returns Difficulty as a floating-point number
+     */
     getDifficulty(): number;
+    /**
+     * Check if the block timestamp is not too far in the future.
+     *
+     * @returns True if the timestamp is within the acceptable range
+     */
     validTimestamp(): boolean;
+    /**
+     * Check if the proof-of-work hash satisfies the target difficulty.
+     *
+     * @returns True if the block hash is below the target
+     */
     validProofOfWork(): boolean;
+    /**
+     * String representation for console/debugging
+     */
     inspect(): string;
+    /**
+     * Compute the block hash using the Lotus 3-layer SHA256 algorithm.
+     *
+     * Layer 3: SHA256(nHeaderVersion || vSize || nHeight || hashEpochBlock || hashMerkleRoot || hashExtendedMetadata)
+     * Layer 2: SHA256(nBits || vTime || nReserved || nNonce || layer3Hash)
+     * Layer 1: SHA256(hashPrevBlock || layer2Hash)
+     *
+     * @returns 32-byte hash buffer (little-endian)
+     */
     private _computeHash;
+    /**
+     * Normalize BlockHeaderData input, filling in defaults for missing fields.
+     */
     private static _normalizeData;
+    /**
+     * Create default header data (all zeroes).
+     */
     private static _defaultData;
+    /**
+     * Read header fields from a BufferReader.
+     * Order matches lotusd CBlockHeader serialization.
+     */
     private static _readFromBuffer;
 }
 //# sourceMappingURL=blockheader.d.ts.map

package/dist/types/lib/bitcore/block/blockheader.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"blockheader.d.ts","sourceRoot":"","sources":["../../../../../lib/bitcore/block/blockheader.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAGhC,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAE1D,OAAO,EAAE,EAAE,EAAE,MAAM,iBAAiB,CAAA;AAepC,MAAM,WAAW,eAAe;IAE9B,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB,KAAK,CAAC,EAAE,EAAE,CAAA;IAEV,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB,IAAI,CAAC,EAAE,EAAE,CAAA;IAET,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAEzB,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAOD,MAAM,WAAW,iBAAiB;IAEhC,IAAI,EAAE,MAAM,CAAA;IAEZ,QAAQ,EAAE,MAAM,CAAA;IAEhB,IAAI,EAAE,MAAM,CAAA;IAEZ,IAAI,EAAE,MAAM,CAAA;IAEZ,QAAQ,EAAE,MAAM,CAAA;IAEhB,KAAK,EAAE,MAAM,CAAA;IAEb,OAAO,EAAE,MAAM,CAAA;IAEf,IAAI,EAAE,MAAM,CAAA;IAEZ,MAAM,EAAE,MAAM,CAAA;IAEd,UAAU,EAAE,MAAM,CAAA;IAElB,UAAU,EAAE,MAAM,CAAA;IAElB,gBAAgB,EAAE,MAAM,CAAA;CACzB;AA0BD,qBAAa,WAAW;IAEtB,MAAM,CAAC,QAAQ,CAAC,eAAe,KAAI;IAGnC,MAAM,CAAC,QAAQ,CAAC,eAAe,SAAc;IAG7C,MAAM,CAAC,QAAQ,CAAC,YAAY,KAG3B;IAGD,MAAM,CAAC,QAAQ,CAAC,WAAW,OAAc;IAGzC,MAAM,CAAC,QAAQ,CAAC,gBAAgB,QAAmB;IAGnD,MAAM,CAAC,QAAQ,CAAC,SAAS;;;;MAOxB;IAGD,QAAQ,CAAC,QAAQ,EAAG,MAAM,CAAA;IAE1B,QAAQ,CAAC,IAAI,EAAG,MAAM,CAAA;IAEtB,QAAQ,CAAC,IAAI,EAAG,MAAM,CAAA;IAEtB,QAAQ,CAAC,SAAS,EAAG,MAAM,CAAA;IAE3B,QAAQ,CAAC,QAAQ,EAAG,MAAM,CAAA;IAE1B,QAAQ,CAAC,KAAK,EAAG,EAAE,CAAA;IAEnB,QAAQ,CAAC,OAAO,EAAG,MAAM,CAAA;IAEzB,QAAQ,CAAC,IAAI,EAAG,EAAE,CAAA;IAElB,QAAQ,CAAC,MAAM,EAAG,MAAM,CAAA;IAExB,QAAQ,CAAC,UAAU,EAAG,MAAM,CAAA;IAE5B,QAAQ,CAAC,UAAU,EAAG,MAAM,CAAA;IAE5B,QAAQ,CAAC,gBAAgB,EAAG,MAAM,CAAA;IAGlC,OAAO,CAAC,GAAG,CAAC,CAAQ;gBAgBR,GAAG,CAAC,EAAE,eAAe,GAAG,WAAW;IAyC/C,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,iBAAiB,GAAG,WAAW;IA0CtD,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,WAAW;IAevD,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW;IAU3C,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW;IAU3C,MAAM,CAAC,gBAAgB,CAAC,EAAE,EAAE,YAAY,GAAG,WAAW;IAetD,QAAQ,IAAI,iBAAiB;IAsB7B,MAAM,IAAI,iBAAiB;IAS3B,QAAQ,IAAI,MAAM;IASlB,QAAQ,IAAI,MAAM;IAelB,cAAc,CAAC,EAAE,CAAC,EAAE,YAAY,GAAG,YAAY;IA0B/C,IAAI,IAAI,IAAI,MAAM,CAMjB;IAKD,IAAI,EAAE,IAAI,MAAM,CAEf;IAYD,mBAAmB,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,EAAE;IAgBtC,aAAa,IAAI,MAAM;IAuBvB,cAAc,IAAI,OAAO;IAUzB,gBAAgB,IAAI,OAAO;IAS3B,OAAO,IAAI,MAAM;IAiBjB,OAAO,CAAC,YAAY;IA8BpB,OAAO,CAAC,MAAM,CAAC,cAAc;IAoB7B,OAAO,CAAC,MAAM,CAAC,YAAY;IAoB3B,OAAO,CAAC,MAAM,CAAC,eAAe;CAe/B"}
+{"version":3,"file":"blockheader.d.ts","sourceRoot":"","sources":["../../../../../lib/bitcore/block/blockheader.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAGhC,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAE1D,OAAO,EAAE,EAAE,EAAE,MAAM,iBAAiB,CAAA;AAWpC;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,2DAA2D;IAC3D,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,sDAAsD;IACtD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,kDAAkD;IAClD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,6CAA6C;IAC7C,KAAK,CAAC,EAAE,EAAE,CAAA;IACV,wDAAwD;IACxD,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,sCAAsC;IACtC,IAAI,CAAC,EAAE,EAAE,CAAA;IACT,gCAAgC;IAChC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,wDAAwD;IACxD,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,gEAAgE;IAChE,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,uDAAuD;IACvD,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,6EAA6E;IAC7E,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,2CAA2C;IAC3C,IAAI,EAAE,MAAM,CAAA;IACZ,kDAAkD;IAClD,QAAQ,EAAE,MAAM,CAAA;IAChB,sDAAsD;IACtD,IAAI,EAAE,MAAM,CAAA;IACZ,kDAAkD;IAClD,IAAI,EAAE,MAAM,CAAA;IACZ,oCAAoC;IACpC,QAAQ,EAAE,MAAM,CAAA;IAChB,8BAA8B;IAC9B,KAAK,EAAE,MAAM,CAAA;IACb,kCAAkC;IAClC,OAAO,EAAE,MAAM,CAAA;IACf,sCAAsC;IACtC,IAAI,EAAE,MAAM,CAAA;IACZ,gCAAgC;IAChC,MAAM,EAAE,MAAM,CAAA;IACd,+CAA+C;IAC/C,UAAU,EAAE,MAAM,CAAA;IAClB,uDAAuD;IACvD,UAAU,EAAE,MAAM,CAAA;IAClB,8CAA8C;IAC9C,gBAAgB,EAAE,MAAM,CAAA;CACzB;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,WAAW;IACtB,8CAA8C;IAC9C,MAAM,CAAC,QAAQ,CAAC,eAAe,KAAI;IAEnC,mFAAmF;IACnF,MAAM,CAAC,QAAQ,CAAC,eAAe,SAAc;IAE7C,sEAAsE;IACtE,MAAM,CAAC,QAAQ,CAAC,YAAY,KAG3B;IAED,8CAA8C;IAC9C,MAAM,CAAC,QAAQ,CAAC,WAAW,OAAc;IAEzC,iCAAiC;IACjC,MAAM,CAAC,QAAQ,CAAC,gBAAgB,QAAmB;IAEnD,qDAAqD;IACrD,MAAM,CAAC,QAAQ,CAAC,SAAS;;;;MAOxB;IAED,2DAA2D;IAC3D,QAAQ,CAAC,QAAQ,EAAG,MAAM,CAAA;IAC1B,gCAAgC;IAChC,QAAQ,CAAC,IAAI,EAAG,MAAM,CAAA;IACtB,kDAAkD;IAClD,QAAQ,CAAC,IAAI,EAAG,MAAM,CAAA;IACtB,8CAA8C;IAC9C,QAAQ,CAAC,SAAS,EAAG,MAAM,CAAA;IAC3B,gCAAgC;IAChC,QAAQ,CAAC,QAAQ,EAAG,MAAM,CAAA;IAC1B,mCAAmC;IACnC,QAAQ,CAAC,KAAK,EAAG,EAAE,CAAA;IACnB,mCAAmC;IACnC,QAAQ,CAAC,OAAO,EAAG,MAAM,CAAA;IACzB,4BAA4B;IAC5B,QAAQ,CAAC,IAAI,EAAG,EAAE,CAAA;IAClB,gCAAgC;IAChC,QAAQ,CAAC,MAAM,EAAG,MAAM,CAAA;IACxB,wDAAwD;IACxD,QAAQ,CAAC,UAAU,EAAG,MAAM,CAAA;IAC5B,4DAA4D;IAC5D,QAAQ,CAAC,UAAU,EAAG,MAAM,CAAA;IAC5B,uDAAuD;IACvD,QAAQ,CAAC,gBAAgB,EAAG,MAAM,CAAA;IAElC,yDAAyD;IACzD,OAAO,CAAC,GAAG,CAAC,CAAQ;IAEpB;;;;;;;;;;;;;OAaG;gBACS,GAAG,CAAC,EAAE,eAAe,GAAG,WAAW;IAkC/C;;;;;;OAMG;IACH,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,iBAAiB,GAAG,WAAW;IAoCtD;;;;;OAKG;IACH,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,WAAW;IASvD;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW;IAI3C;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW;IAI3C;;;;;OAKG;IACH,MAAM,CAAC,gBAAgB,CAAC,EAAE,EAAE,YAAY,GAAG,WAAW;IAStD;;;;;OAKG;IACH,QAAQ,IAAI,iBAAiB;IAmB7B;;OAEG;IACH,MAAM,IAAI,iBAAiB;IAI3B;;;;OAIG;IACH,QAAQ,IAAI,MAAM;IAIlB;;;;OAIG;IACH,QAAQ,IAAI,MAAM;IAIlB;;;;;;;;;;OAUG;IACH,cAAc,CAAC,EAAE,CAAC,EAAE,YAAY,GAAG,YAAY;IAsB/C;;;OAGG;IACH,IAAI,IAAI,IAAI,MAAM,CAMjB;IAED;;OAEG;IACH,IAAI,EAAE,IAAI,MAAM,CAEf;IAMD;;;;;OAKG;IACH,mBAAmB,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,EAAE;IAWtC;;;;OAIG;IACH,aAAa,IAAI,MAAM;IAkBvB;;;;OAIG;IACH,cAAc,IAAI,OAAO;IAKzB;;;;OAIG;IACH,gBAAgB,IAAI,OAAO;IAM3B;;OAEG;IACH,OAAO,IAAI,MAAM;IAQjB;;;;;;;;OAQG;IACH,OAAO,CAAC,YAAY;IA2BpB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,cAAc;IAiB7B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,YAAY;IAgB3B;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,eAAe;CAe/B"}