xpi-ts 0.2.22 → 0.2.24

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

@@ -1,3 +1,22 @@
+/**
+ * Unit implementation for Lotus
+ * Migrated from bitcore-lib-xpi with ESM support and BigInt
+ */
+/**
+ * Unit definitions for XPI (Lotus) amounts.
+ *
+ * The `UNITS` object maps unit codes to an array of two numbers:
+ *   [factor, decimals], where:
+ *     - `factor` is the number of satoshis ("base units") in one of the given unit.
+ *     - `decimals` is the number of decimal places typically displayed for the unit.
+ *
+ * Units:
+ *   - XPI:       1,000,000 satoshis per XPI (6 decimal places)
+ *   - mXPI:      1,000 satoshis per mXPI (3 decimal places)
+ *   - uXPI:      100 satoshis per uXPI (2 decimal places)
+ *   - bits:      100 satoshis per bit (synonym for uXPI, 2 decimal places)
+ *   - satoshis:  1 satoshi per satoshi (0 decimal places)
+ */
 declare const UNITS: {
     readonly XPI: readonly [1000000, 6];
     readonly mXPI: readonly [1000, 3];
@@ -10,6 +29,28 @@ export interface UnitData {
     code: string;
 }
 export type UnitCode = keyof typeof UNITS;
+/**
+ * Utility for handling and converting Lotus XPI units.
+ *
+ * Supported units are XPI, mXPI, bits (also named uXPI) and satoshis.
+ * A unit instance can be created with an amount and a unit code, or
+ * alternatively using static methods like {@link Unit.fromXPI}.
+ * It also allows creation from a fiat amount and exchange rate, or
+ * alternatively using the {@link Unit.fromFiat} static method.
+ *
+ * You can query for different representations of a unit instance using its
+ * {@link Unit.to} method, the fixed unit methods like {@link Unit.toSatoshis},
+ * or alternatively using the unit accessors. It can also be converted to a
+ * fiat amount by providing the corresponding XPI/fiat exchange rate.
+ *
+ * @example
+ * ```typescript
+ * const sats = Unit.fromXPI(1.3).toSatoshis()
+ * const mili = Unit.fromMicros(1.3).to(Unit.mXPI)
+ * const bits = Unit.fromFiat(1.3, 350).bits
+ * const xpi = new Unit(1.3, Unit.bits).XPI
+ * ```
+ */
 export declare class Unit {
     private _value;
     static readonly XPI = "XPI";
@@ -18,26 +59,125 @@ export declare class Unit {
     static readonly bits = "bits";
     static readonly satoshis = "satoshis";
     constructor(amount: number, code: UnitCode | number);
+    /**
+     * Returns a Unit instance created from JSON string or object
+     *
+     * @param {Object} data - Object with keys: amount and code
+     * @returns {Unit} A Unit instance
+     */
     static fromObject(data: UnitData): Unit;
+    /**
+     * Returns a Unit instance created from an amount in XPI
+     *
+     * @param {Number} amount - The amount in XPI
+     * @returns {Unit} A Unit instance
+     */
     static fromXPI(amount: number): Unit;
+    /**
+     * Returns a Unit instance created from an amount in mXPI
+     *
+     * @param {Number} amount - The amount in mXPI
+     * @returns {Unit} A Unit instance
+     */
     static fromMillis(amount: number): Unit;
+    /**
+     * Alias for fromMillis
+     */
     static fromMilis: typeof Unit.fromMillis;
+    /**
+     * Returns a Unit instance created from an amount in bits
+     *
+     * @param {Number} amount - The amount in bits
+     * @returns {Unit} A Unit instance
+     */
     static fromMicros(amount: number): Unit;
+    /**
+     * Alias for fromMicros
+     */
     static fromBits: typeof Unit.fromMicros;
+    /**
+     * Returns a Unit instance created from an amount in satoshis
+     *
+     * @param {Number|bigint} amount - The amount in satoshis
+     * @returns {Unit} A Unit instance
+     */
     static fromSatoshis(amount: number | bigint): Unit;
+    /**
+     * Returns a Unit instance created from a fiat amount and exchange rate.
+     *
+     * @param {Number} amount - The amount in fiat
+     * @param {Number} rate - The exchange rate XPI/fiat
+     * @returns {Unit} A Unit instance
+     */
     static fromFiat(amount: number, rate: number): Unit;
     private _from;
+    /**
+     * Returns the value represented in the specified unit
+     *
+     * @param {String|Number} code - The unit code or exchange rate
+     * @returns {Number} The converted value
+     */
     to(code: UnitCode | number): number;
+    /**
+     * Returns the value represented in XPI
+     *
+     * @returns {Number} The value converted to XPI
+     */
     toXPI(): number;
+    /**
+     * Returns the value represented in mXPI
+     *
+     * @returns {Number} The value converted to mXPI
+     */
     toMillis(): number;
+    /**
+     * Alias for toMillis
+     */
     toMilis: () => number;
+    /**
+     * Returns the value represented in bits
+     *
+     * @returns {Number} The value converted to bits
+     */
     toMicros(): number;
+    /**
+     * Alias for toMicros
+     */
     toBits: () => number;
+    /**
+     * Returns the value represented in satoshis
+     *
+     * @returns {bigint} The value converted to satoshis
+     */
     toSatoshis(): bigint;
+    /**
+     * Returns the value represented in fiat
+     *
+     * @param {number} rate - The exchange rate between XPI/currency
+     * @returns {Number} The value converted to fiat
+     */
     atRate(rate: number): number;
+    /**
+     * Returns a the string representation of the value in satoshis
+     *
+     * @returns {string} the value in satoshis
+     */
     toString(): string;
+    /**
+     * Returns a plain object representation of the Unit
+     *
+     * @returns {Object} An object with the keys: amount and code
+     */
     toObject(): UnitData;
+    /**
+     * Alias for toObject
+     */
     toJSON: () => UnitData;
+    /**
+     * Returns a string formatted for the console
+     *
+     * @returns {string} the value in satoshis
+     */
     inspect(): string;
 }
 export {};

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

@@ -1 +1 @@
-{"version":3,"file":"unit.d.ts","sourceRoot":"","sources":["../../../../lib/bitcore/unit.ts"],"names":[],"mappings":"AAwBA,QAAA,MAAM,KAAK;;;;;;CAMD,CAAA;AAEV,MAAM,WAAW,QAAQ;IACvB,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,MAAM,QAAQ,GAAG,MAAM,OAAO,KAAK,CAAA;AAwBzC,qBAAa,IAAI;IACf,OAAO,CAAC,MAAM,CAAS;IAGvB,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAQ;IAC3B,MAAM,CAAC,QAAQ,CAAC,IAAI,UAAS;IAC7B,MAAM,CAAC,QAAQ,CAAC,IAAI,UAAS;IAC7B,MAAM,CAAC,QAAQ,CAAC,IAAI,UAAS;IAC7B,MAAM,CAAC,QAAQ,CAAC,QAAQ,cAAa;gBAEzB,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,GAAG,MAAM;IA2BnD,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI;IAevC,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAUpC,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAOvC,MAAM,CAAC,SAAS,yBAAkB;IAQlC,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAOvC,MAAM,CAAC,QAAQ,yBAAkB;IAQjC,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAclD,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAInD,OAAO,CAAC,KAAK;IAab,EAAE,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,MAAM;IAuBnC,KAAK,IAAI,MAAM;IASf,QAAQ,IAAI,MAAM;IAOlB,OAAO,QAPK,MAAM,CAOK;IAOvB,QAAQ,IAAI,MAAM;IAOlB,MAAM,QAPM,MAAM,CAOI;IAOtB,UAAU,IAAI,MAAM;IAUpB,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAS5B,QAAQ,IAAI,MAAM;IASlB,QAAQ,IAAI,QAAQ;IAUpB,MAAM,QAVM,QAAQ,CAUE;IAOtB,OAAO,IAAI,MAAM;CAGlB"}
+{"version":3,"file":"unit.d.ts","sourceRoot":"","sources":["../../../../lib/bitcore/unit.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAMH;;;;;;;;;;;;;;GAcG;AACH,QAAA,MAAM,KAAK;;;;;;CAMD,CAAA;AAEV,MAAM,WAAW,QAAQ;IACvB,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,MAAM,QAAQ,GAAG,MAAM,OAAO,KAAK,CAAA;AAEzC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,IAAI;IACf,OAAO,CAAC,MAAM,CAAS;IAGvB,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAQ;IAC3B,MAAM,CAAC,QAAQ,CAAC,IAAI,UAAS;IAC7B,MAAM,CAAC,QAAQ,CAAC,IAAI,UAAS;IAC7B,MAAM,CAAC,QAAQ,CAAC,IAAI,UAAS;IAC7B,MAAM,CAAC,QAAQ,CAAC,QAAQ,cAAa;gBAEzB,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,GAAG,MAAM;IAqBnD;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI;IASvC;;;;;OAKG;IACH,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAIpC;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAIvC;;OAEG;IACH,MAAM,CAAC,SAAS,yBAAkB;IAElC;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAIvC;;OAEG;IACH,MAAM,CAAC,QAAQ,yBAAkB;IAEjC;;;;;OAKG;IACH,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAOlD;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAInD,OAAO,CAAC,KAAK;IAOb;;;;;OAKG;IACH,EAAE,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,MAAM;IAkBnC;;;;OAIG;IACH,KAAK,IAAI,MAAM;IAIf;;;;OAIG;IACH,QAAQ,IAAI,MAAM;IAIlB;;OAEG;IACH,OAAO,QAPK,MAAM,CAOK;IAEvB;;;;OAIG;IACH,QAAQ,IAAI,MAAM;IAIlB;;OAEG;IACH,MAAM,QAPM,MAAM,CAOI;IAEtB;;;;OAIG;IACH,UAAU,IAAI,MAAM;IAIpB;;;;;OAKG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAI5B;;;;OAIG;IACH,QAAQ,IAAI,MAAM;IAIlB;;;;OAIG;IACH,QAAQ,IAAI,QAAQ;IAOpB;;OAEG;IACH,MAAM,QAVM,QAAQ,CAUE;IAEtB;;;;OAIG;IACH,OAAO,IAAI,MAAM;CAGlB"}

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

@@ -1,3 +1,7 @@
+/**
+ * URI class for Lotus URI handling
+ * Migrated from bitcore-lib-xpi with ESM support
+ */
 import { Address } from './address.js';
 export interface URIParams {
     address?: string;
@@ -13,17 +17,47 @@ export declare class URI {
     private _message?;
     private _otherParams;
     constructor(data: string | URIParams, knownParams?: string[]);
+    /**
+     * Create URI from string
+     */
     static fromString(data: string): URI;
+    /**
+     * Create URI from object
+     */
     static fromObject(data: URIParams): URI;
+    /**
+     * Check if URI is valid
+     */
     static isValid(data: string | URIParams, knownParams?: string[]): boolean;
     private _fromString;
     private _fromObject;
+    /**
+     * Get the address
+     */
     get address(): Address | undefined;
+    /**
+     * Get the amount
+     */
     get amount(): number | undefined;
+    /**
+     * Get the label
+     */
     get label(): string | undefined;
+    /**
+     * Get the message
+     */
     get message(): string | undefined;
+    /**
+     * Get other parameters
+     */
     get otherParams(): Record<string, string>;
+    /**
+     * Convert to string
+     */
     toString(prefix?: string): string;
+    /**
+     * Convert to object
+     */
     toObject(): URIParams;
 }
 //# sourceMappingURL=uri.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"uri.d.ts","sourceRoot":"","sources":["../../../../lib/bitcore/uri.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAQtC,MAAM,WAAW,SAAS;IACxB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;CAC3C;AAED,qBAAa,GAAG;IACd,OAAO,CAAC,QAAQ,CAAC,CAAS;IAC1B,OAAO,CAAC,OAAO,CAAC,CAAQ;IACxB,OAAO,CAAC,MAAM,CAAC,CAAQ;IACvB,OAAO,CAAC,QAAQ,CAAC,CAAQ;IACzB,OAAO,CAAC,YAAY,CAA6B;gBAErC,IAAI,EAAE,MAAM,GAAG,SAAS,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE;IAa5D,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG;IAOpC,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,SAAS,GAAG,GAAG;IAOvC,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO;IASzE,OAAO,CAAC,WAAW;IAiDnB,OAAO,CAAC,WAAW;IAgCnB,IAAI,OAAO,IAAI,OAAO,GAAG,SAAS,CAEjC;IAKD,IAAI,MAAM,IAAI,MAAM,GAAG,SAAS,CAE/B;IAKD,IAAI,KAAK,IAAI,MAAM,GAAG,SAAS,CAE9B;IAKD,IAAI,OAAO,IAAI,MAAM,GAAG,SAAS,CAEhC;IAKD,IAAI,WAAW,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAExC;IAKD,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM;IAuCjC,QAAQ,IAAI,SAAS;CA0BtB"}
+{"version":3,"file":"uri.d.ts","sourceRoot":"","sources":["../../../../lib/bitcore/uri.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAQtC,MAAM,WAAW,SAAS;IACxB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;CAC3C;AAED,qBAAa,GAAG;IACd,OAAO,CAAC,QAAQ,CAAC,CAAS;IAC1B,OAAO,CAAC,OAAO,CAAC,CAAQ;IACxB,OAAO,CAAC,MAAM,CAAC,CAAQ;IACvB,OAAO,CAAC,QAAQ,CAAC,CAAQ;IACzB,OAAO,CAAC,YAAY,CAA6B;gBAErC,IAAI,EAAE,MAAM,GAAG,SAAS,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE;IAU5D;;OAEG;IACH,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG;IAIpC;;OAEG;IACH,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,SAAS,GAAG,GAAG;IAIvC;;OAEG;IACH,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO;IASzE,OAAO,CAAC,WAAW;IAiDnB,OAAO,CAAC,WAAW;IA6BnB;;OAEG;IACH,IAAI,OAAO,IAAI,OAAO,GAAG,SAAS,CAEjC;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,MAAM,GAAG,SAAS,CAE/B;IAED;;OAEG;IACH,IAAI,KAAK,IAAI,MAAM,GAAG,SAAS,CAE9B;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,MAAM,GAAG,SAAS,CAEhC;IAED;;OAEG;IACH,IAAI,WAAW,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAExC;IAED;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM;IAoCjC;;OAEG;IACH,QAAQ,IAAI,SAAS;CA0BtB"}

package/dist/types/lib/bitcore/util/base32.d.ts

@@ -1,5 +1,60 @@
+/**
+ * Base32 encoding/decoding utility
+ * Migrated from bitcore-lib-xpi with ESM support and TypeScript
+ *
+ * @deprecated This is a legacy module retained for backward compatibility.
+ * Lotus does **not** use Base32 encoding for addresses - Lotus XAddresses use {@link Base58}.
+ *
+ * This module is maintained solely for the CashWeb keyserver compatibility.
+ *
+ * These external services use bech32-style encoding which requires Base32.
+ * For all Lotus-native operations, use {@link Base58} or {@link Base58Check} instead.
+ *
+ * @module base32
+ * @see {@link Base58} For Lotus address encoding
+ * @see {@link Base58Check} For Lotus address encoding with checksum
+ */
+/**
+ * Base32 encoding/decoding utility class.
+ *
+ * @deprecated This class is maintained for CashWeb keyserver compatibility only.
+ * Lotus addresses use {@link Base58}, not Base32. Do not use for new Lotus features.
+ *
+ * @example
+ * ```typescript
+ * // For CashWeb keyserver compatibility only
+ * const encoded = Base32.encode([0, 1, 2, 3])
+ * const decoded = Base32.decode('qpzr')
+ * ```
+ */
 export declare class Base32 {
+    /**
+     * Encodes the given array of 5-bit integers as a base32-encoded string.
+     * Uses the bech32 character set (qpzry9x8gf2tvdw0s3jn54khce6mua7l).
+     *
+     * @param data Array of integers between 0 and 31 inclusive.
+     * @returns Base32-encoded string
+     * @deprecated Only for CashWeb keyserver compatibility
+     *
+     * @example
+     * ```typescript
+     * Base32.encode([0, 1, 2]) // returns 'qpz'
+     * ```
+     */
     static encode(data: number[]): string;
+    /**
+     * Decodes the given base32-encoded string into an array of 5-bit integers.
+     * @deprecated Only for CashWeb keyserver compatibility
+     *
+     * @param base32 Base32-encoded string using bech32 charset
+     * @returns Array of 5-bit integers (0-31)
+     * @throws Error if string contains invalid characters
+     *
+     * @example
+     * ```typescript
+     * Base32.decode('qpzr') // returns [0, 1, 2, 3]
+     * ```
+     */
     static decode(base32: string): number[];
 }
 //# sourceMappingURL=base32.d.ts.map

package/dist/types/lib/bitcore/util/base32.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"base32.d.ts","sourceRoot":"","sources":["../../../../../lib/bitcore/util/base32.ts"],"names":[],"mappings":"AA8EA,qBAAa,MAAM;IAcjB,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM;IA4BrC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE;CAkBxC"}
+{"version":3,"file":"base32.d.ts","sourceRoot":"","sources":["../../../../../lib/bitcore/util/base32.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAkDH;;;;;;;;;;;;GAYG;AACH,qBAAa,MAAM;IACjB;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM;IAerC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE;CAkBxC"}

package/dist/types/lib/bitcore/util/bits.d.ts

@@ -1,5 +1,81 @@
+/**
+ * Copyright 2026 The Lotusia Stewardship
+ * Github: https://github.com/LotusiaStewardship
+ * License: MIT
+ *
+ * Bit manipulation utilities
+ *
+ * These utilities provide functions for converting between boolean bit arrays
+ * and packed byte arrays (LSB-first bit ordering), used primarily for
+ * MerkleBlock flag serialization per Lotus protocol specification.
+ */
+/**
+ * Converts an array of boolean bits into an array of bytes.
+ * Bits are packed LSB-first (least significant bit first) into each byte.
+ *
+ * This matches the Bitcoin/Lotus protocol specification for MerkleBlock
+ * flag serialization as implemented in lotusd (BitsToBytes).
+ *
+ * @param bits - Array of boolean values representing individual bits
+ * @returns Array of bytes with bits packed LSB-first
+ *
+ * @example
+ * ```typescript
+ * const bits = [true, false, true, false, true, false, true, false]
+ * const bytes = bitsToBytes(bits) // [0b01010101] = [0x55]
+ * ```
+ */
 export declare function bitsToBytes(bits: boolean[]): number[];
+/**
+ * Converts an array of bytes into an array of boolean bits.
+ * Bits are extracted LSB-first (least significant bit first) from each byte.
+ *
+ * This matches the Bitcoin/Lotus protocol specification for MerkleBlock
+ * flag deserialization as implemented in lotusd (BytesToBits).
+ *
+ * @param bytes - Array of bytes containing packed bits
+ * @returns Array of boolean values representing individual bits
+ *
+ * @example
+ * ```typescript
+ * const bytes = [0x55, 0xAA]
+ * const bits = bytesToBits(bytes)
+ * // [true, false, true, false, true, false, true, false,
+ * //  false, true, false, true, false, true, false, true]
+ * ```
+ */
 export declare function bytesToBits(bytes: number[]): boolean[];
+/**
+ * Extracts a single bit from a byte array at the specified position.
+ * Uses LSB-first bit ordering consistent with Bitcoin/Lotus protocol.
+ *
+ * @param bytes - Array of bytes containing packed bits
+ * @param position - Bit position (0-indexed, LSB-first)
+ * @returns Boolean value of the bit at the specified position
+ *
+ * @example
+ * ```typescript
+ * const bytes = [0b00001111] // 0x0F
+ * const bit0 = extractBit(bytes, 0) // true (LSB)
+ * const bit4 = extractBit(bytes, 4) // true
+ * const bit7 = extractBit(bytes, 7) // false
+ * ```
+ */
 export declare function extractBit(bytes: number[], position: number): boolean;
+/**
+ * Sets a single bit in a byte array at the specified position.
+ * Uses LSB-first bit ordering consistent with Bitcoin/Lotus protocol.
+ *
+ * @param bytes - Array of bytes to modify
+ * @param position - Bit position (0-indexed, LSB-first)
+ * @param value - Boolean value to set
+ *
+ * @example
+ * ```typescript
+ * const bytes = [0, 0]
+ * setBit(bytes, 0, true)  // bytes = [1, 0] (0x01)
+ * setBit(bytes, 8, true)  // bytes = [1, 1] (0x01, 0x01)
+ * ```
+ */
 export declare function setBit(bytes: number[], position: number, value: boolean): void;
 //# sourceMappingURL=bits.d.ts.map

package/dist/types/lib/bitcore/util/bits.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bits.d.ts","sourceRoot":"","sources":["../../../../../lib/bitcore/util/bits.ts"],"names":[],"mappings":"AA4BA,wBAAgB,WAAW,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,EAAE,CAMrD;AAoBD,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,CAMtD;AAkBD,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAErE;AAiBD,wBAAgB,MAAM,CACpB,KAAK,EAAE,MAAM,EAAE,EACf,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,OAAO,GACb,IAAI,CAQN"}
+{"version":3,"file":"bits.d.ts","sourceRoot":"","sources":["../../../../../lib/bitcore/util/bits.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,EAAE,CAMrD;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,CAMtD;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAErE;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,MAAM,CACpB,KAAK,EAAE,MAAM,EAAE,EACf,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,OAAO,GACb,IAAI,CAQN"}

package/dist/types/lib/bitcore/util/buffer.d.ts

@@ -1,24 +1,159 @@
+/**
+ * Buffer utility module
+ * Provides helper functions for working with Buffer objects
+ * Migrated from bitcore-lib-xpi with ESM support and TypeScript
+ */
 import { Buffer } from 'buffer/';
 export declare class BufferUtil {
+    /** Re-export Buffer class for convenience */
     static Buffer: typeof Buffer;
+    /**
+     * Fill a buffer with a value.
+     *
+     * @param buffer Buffer to fill
+     * @param value Value to fill with
+     * @return Buffer
+     */
     static fill(buffer: Buffer, value: number): Buffer;
+    /**
+     * Return a copy of a buffer
+     *
+     * @param original Original buffer
+     * @return Buffer
+     */
     static copy(original: Buffer): Buffer;
+    /**
+     * Returns true if the given argument is an instance of a buffer. Tests for
+     * both node's Buffer and Uint8Array
+     *
+     * @param arg Argument to test
+     * @return boolean
+     */
     static isBuffer(arg: unknown): arg is Buffer | Uint8Array;
+    /**
+     * Returns a zero-filled byte array
+     *
+     * @param bytes Number of bytes
+     * @return Buffer
+     */
     static emptyBuffer(bytes: number): Buffer;
+    /**
+     * Allocates a new buffer of the specified size.
+     *
+     * @param size - The desired length of the new buffer in bytes
+     * @param fill - Optional value to fill the buffer with (default: 0)
+     * @returns A new buffer of the specified size, filled with the specified value or zeros
+     */
     static alloc(size: number, fill?: string | number | Buffer): Buffer;
+    /**
+     * Concatenates buffers
+     *
+     * Shortcut for Buffer.concat
+     */
     static concat(list: ReadonlyArray<Buffer>, totalLength?: number): Buffer;
+    /**
+     * Check if two buffers are equal
+     */
     static equals(a: Buffer, b: Buffer): boolean;
+    /**
+     * Alias for equals
+     */
     static equal(a: Buffer, b: Buffer): boolean;
+    /**
+     * Transforms a number from 0 to 255 into a Buffer of size 1 with that value
+     *
+     * @param integer Number to convert
+     * @return Buffer
+     */
     static integerAsSingleByteBuffer(integer: number): Buffer;
+    /**
+     * Converts a number to a 4-byte big-endian buffer representation.
+     *
+     * @param integer - Number to convert (32-bit integer)
+     * @returns Buffer of length 4 containing the big-endian representation
+     */
     static integerAsBuffer(integer: number): Buffer;
+    /**
+     * Converts a 4-byte big-endian buffer to a 32-bit integer.
+     *
+     * @param buffer - Buffer to convert (must be at least 4 bytes)
+     * @returns The 32-bit integer value
+     */
     static integerFromBuffer(buffer: Buffer): number;
+    /**
+     * Transforms the first byte of an array into a number ranging from -128 to 127
+     * @param buffer Buffer to convert
+     * @return number
+     */
     static integerFromSingleByteBuffer(buffer: Buffer): number;
+    /**
+     * Transforms a buffer into a string with a number in hexa representation
+     *
+     * Shorthand for buffer.toString('hex')
+     *
+     * @param buffer Buffer to convert
+     * @return string
+     */
     static bufferToHex(buffer: Buffer): string;
+    /**
+     * Reverse a buffer
+     * @param param Buffer to reverse
+     * @return Buffer
+     */
     static reverse(param: Buffer): Buffer;
+    /**
+     * Allocates a new Buffer using an {array} of octets.
+     *
+     * @param array
+     */
     static from(array: any[]): Buffer;
+    /**
+     * When passed a reference to the .buffer property of a TypedArray instance,
+     * the newly created Buffer will share the same allocated memory as the TypedArray.
+     * The optional {byteOffset} and {length} arguments specify a memory range
+     * within the {arrayBuffer} that will be shared by the Buffer.
+     *
+     * @param arrayBuffer The .buffer property of a TypedArray or a new ArrayBuffer()
+     * @param byteOffset
+     * @param length
+     */
     static from(arrayBuffer: ArrayBuffer, byteOffset?: number, length?: number): Buffer;
+    /**
+     * Copies the passed {buffer} data onto a new Buffer instance.
+     *
+     * @param buffer
+     */
     static from(buffer: Buffer | Uint8Array): Buffer;
+    /**
+     * Creates a new Buffer containing the given JavaScript string {str}.
+     * If provided, the {encoding} parameter identifies the character encoding.
+     * If not provided, {encoding} defaults to 'utf8'.
+     *
+     * @param str
+     */
     static from(str: string, encoding?: BufferEncoding): Buffer;
+    /**
+     * Compare two buffers byte-by-byte.
+     *
+     * Performs a lexicographic comparison of two buffers, comparing each byte
+     * sequentially until a difference is found or one buffer ends.
+     *
+     * @param buf1 - First buffer to compare
+     * @param buf2 - Second buffer to compare
+     * @returns 0 if buffers are equal, -1 if buf1 < buf2, 1 if buf1 > buf2
+     *
+     * @example
+     * // Equal buffers
+     * BufferUtil.compare(Buffer.from([1, 2, 3]), Buffer.from([1, 2, 3])) // returns 0
+     *
+     * @example
+     * // First buffer is less
+     * BufferUtil.compare(Buffer.from([1, 2]), Buffer.from([1, 3])) // returns -1
+     *
+     * @example
+     * // First buffer is greater
+     * BufferUtil.compare(Buffer.from([1, 3]), Buffer.from([1, 2])) // returns 1
+     */
     static compare(buf1: Uint8Array, buf2: Uint8Array): number;
 }
 export declare const NULL_HASH: Buffer;

package/dist/types/lib/bitcore/util/buffer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"buffer.d.ts","sourceRoot":"","sources":["../../../../../lib/bitcore/util/buffer.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAChC,qBAAa,UAAU;IAErB,MAAM,CAAC,MAAM,EAAE,OAAO,MAAM,CAAS;IAQrC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM;IAclD,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAarC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,MAAM,GAAG,UAAU;IAUzD,MAAM,CAAC,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAezC,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM;IASnE,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM;IAOxE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO;IAgB5C,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO;IAU3C,MAAM,CAAC,yBAAyB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAUzD,MAAM,CAAC,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAe/C,MAAM,CAAC,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAShD,MAAM,CAAC,2BAA2B,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAY1D,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAS1C,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAQrC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,MAAM;IAWjC,MAAM,CAAC,IAAI,CACT,WAAW,EAAE,WAAW,EACxB,UAAU,CAAC,EAAE,MAAM,EACnB,MAAM,CAAC,EAAE,MAAM,GACd,MAAM;IAMT,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,GAAG,MAAM;IAQhD,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc,GAAG,MAAM;IAqE3D,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,GAAG,MAAM;CAG3D;AAGD,eAAO,MAAM,SAAS,QAAuC,CAAA;AAC7D,eAAO,MAAM,YAAY,QAAkB,CAAA"}
+{"version":3,"file":"buffer.d.ts","sourceRoot":"","sources":["../../../../../lib/bitcore/util/buffer.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAChC,qBAAa,UAAU;IACrB,6CAA6C;IAC7C,MAAM,CAAC,MAAM,EAAE,OAAO,MAAM,CAAS;IACrC;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM;IAQlD;;;;;OAKG;IACH,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAMrC;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,MAAM,GAAG,UAAU;IAIzD;;;;;OAKG;IACH,MAAM,CAAC,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAQzC;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM;IAInE;;;;OAIG;IACH,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM;IAIxE;;OAEG;IACH,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO;IAa5C;;OAEG;IACH,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO;IAI3C;;;;;OAKG;IACH,MAAM,CAAC,yBAAyB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAIzD;;;;;OAKG;IACH,MAAM,CAAC,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAS/C;;;;;OAKG;IACH,MAAM,CAAC,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAIhD;;;;OAIG;IACH,MAAM,CAAC,2BAA2B,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAI1D;;;;;;;OAOG;IACH,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAI1C;;;;OAIG;IACH,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAGrC;;;;OAIG;IACH,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,MAAM;IACjC;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,CACT,WAAW,EAAE,WAAW,EACxB,UAAU,CAAC,EAAE,MAAM,EACnB,MAAM,CAAC,EAAE,MAAM,GACd,MAAM;IACT;;;;OAIG;IACH,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,GAAG,MAAM;IAChD;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc,GAAG,MAAM;IA+C3D;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,GAAG,MAAM;CAG3D;AAGD,eAAO,MAAM,SAAS,QAAuC,CAAA;AAC7D,eAAO,MAAM,YAAY,QAAkB,CAAA"}

package/dist/types/lib/bitcore/util/convertBits.d.ts

@@ -1,2 +1,17 @@
+/**
+ * Convert bits utility
+ * Migrated from bitcore-lib-xpi with ESM support and TypeScript
+ */
+/**
+ * Converts an array of integers made up of `from` bits into an
+ * array of integers made up of `to` bits. The output array is
+ * zero-padded if necessary, unless strict mode is true.
+ * Original by Pieter Wuille: https://github.com/sipa/bech32.
+ *
+ * @param data Array of integers made up of `from` bits.
+ * @param from Length in bits of elements in the input array.
+ * @param to Length in bits of elements in the output array.
+ * @param strict Require the conversion to be completed without padding.
+ */
 export declare function convertBits(data: number[], from: number, to: number, strict?: boolean): number[];
 //# sourceMappingURL=convertBits.d.ts.map

package/dist/types/lib/bitcore/util/convertBits.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"convertBits.d.ts","sourceRoot":"","sources":["../../../../../lib/bitcore/util/convertBits.ts"],"names":[],"mappings":"AAkBA,wBAAgB,WAAW,CACzB,IAAI,EAAE,MAAM,EAAE,EACd,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,OAAe,GACtB,MAAM,EAAE,CAkCV"}
+{"version":3,"file":"convertBits.d.ts","sourceRoot":"","sources":["../../../../../lib/bitcore/util/convertBits.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH;;;;;;;;;;GAUG;AACH,wBAAgB,WAAW,CACzB,IAAI,EAAE,MAAM,EAAE,EACd,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,OAAe,GACtB,MAAM,EAAE,CAkCV"}

package/dist/types/lib/bitcore/util/js.d.ts

@@ -1,8 +1,27 @@
+/**
+ * JavaScript utility functions
+ * Migrated from bitcore-lib-xpi with ESM support
+ */
 export declare class JSUtil {
+    /**
+     * Determines whether a string contains only hexadecimal values
+     */
     static isHexa(value: string): boolean;
+    /**
+     * Test if an argument is a valid JSON object
+     */
     static isValidJSON(arg: string): boolean;
+    /**
+     * Clone an array
+     */
     static cloneArray<T>(arr: T[]): T[];
+    /**
+     * Check if a value is a natural number
+     */
     static isNaturalNumber(value: unknown): boolean;
+    /**
+     * Define immutable properties on an object
+     */
     static defineImmutable(obj: object, properties: Record<string, unknown>): object;
 }
 //# sourceMappingURL=js.d.ts.map

package/dist/types/lib/bitcore/util/js.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"js.d.ts","sourceRoot":"","sources":["../../../../../lib/bitcore/util/js.ts"],"names":[],"mappings":"AAKA,qBAAa,MAAM;IAIjB,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAUrC,MAAM,CAAC,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAexC,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE;IAOnC,MAAM,CAAC,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IAc/C,MAAM,CAAC,eAAe,CACpB,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAClC,MAAM;CAWV"}
+{"version":3,"file":"js.d.ts","sourceRoot":"","sources":["../../../../../lib/bitcore/util/js.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,qBAAa,MAAM;IACjB;;OAEG;IACH,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAOrC;;OAEG;IACH,MAAM,CAAC,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAYxC;;OAEG;IACH,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE;IAInC;;OAEG;IACH,MAAM,CAAC,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IAW/C;;OAEG;IACH,MAAM,CAAC,eAAe,CACpB,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAClC,MAAM;CAWV"}