@pioneer-platform/blockbook 8.3.13 → 8.3.16

package/lib/index.d.ts

@@ -1,26 +1,186 @@
-declare const TAG = " | blockbook-client | ";
+/**
+ * Blockbook Client Integration Module
+ *
+ * Provides a unified interface for interacting with Blockbook blockchain explorers
+ * across multiple cryptocurrency networks. Handles pagination, retries, and fallbacks.
+ *
+ * @module blockbook-client
+ */
 declare const Blockbook: any;
 declare const log: any;
 declare const fakeUa: any;
 declare const Axios: any;
 declare const https: any;
 declare const nodes: any;
-declare const axios: any;
 declare const axiosRetry: any;
-declare let NOW_NODES_API: string | undefined;
-declare let BLOCKBOOK_URLS: any;
-declare let BLOCKBOOK_SOCKETS: any;
-declare let init_network: (servers?: any[]) => Promise<boolean>;
-declare let get_fees: (coin: string) => Promise<any>;
-declare let get_info_by_pubkey: (coin: string, pubkey: string, page?: string | undefined) => Promise<any>;
-declare let get_txids_by_address: (coin: string, address: string, page?: number) => Promise<any>;
-declare let get_info_by_address: (coin: string, address: string, filter?: string) => Promise<any>;
-declare let get_txs_by_xpub: (coin: string, xpub: string) => Promise<any>;
-declare let broadcast_transaction: (coin: string, hex: string) => Promise<{
-    txid: any;
+declare const TAG = " | blockbook-client | ";
+declare const NOW_NODES_API: string | undefined;
+declare const axios: any;
+interface BlockbookToken {
+    name: string;
+    path?: string;
+    balance?: string;
+    transfers?: number;
+    totalReceived?: string;
+    totalSent?: string;
+}
+interface XpubResponse {
+    page?: number;
+    totalPages?: number;
+    itemsOnPage?: number;
+    address?: string;
+    balance: string;
+    totalReceived: string;
+    totalSent: string;
+    unconfirmedBalance: string;
+    unconfirmedTxs: number;
+    txs: number;
+    addrTxCount?: number;
+    txids?: string[];
+    usedTokens?: number;
+    tokens?: BlockbookToken[];
+    transactions?: any[];
+}
+interface NextIndexes {
+    nextReceiveAddressIndex: number;
+    nextChangeAddressIndex: number;
+}
+interface BlockbookConfig {
+    symbol: string;
+    service: string;
+    websocket?: string;
+}
+interface FeeEstimate {
+    fast?: number;
+    average?: number;
+    slow?: number;
+    blockTime?: number;
+    blockHeight?: number;
+}
+declare let BLOCKBOOK_URLS: Record<string, string>;
+declare let BLOCKBOOK_SOCKETS: Record<string, any>;
+declare const cache: Map<string, {
+    data: any;
+    timestamp: number;
+}>;
+declare const CACHE_TTL = 60000;
+/**
+ * Get cached data if available and not expired
+ */
+declare function getCached(key: string): any | null;
+/**
+ * Store data in cache
+ */
+declare function setCache(key: string, data: any): void;
+/**
+ * Initialize the Blockbook network with seed nodes and custom servers
+ * @param servers Optional array of custom Blockbook server configurations
+ * @returns Promise<boolean> indicating successful initialization
+ */
+declare function init_network(servers?: BlockbookConfig[]): Promise<boolean>;
+/**
+ * Get fee estimates for a specific coin
+ * @param coin Coin symbol (e.g., 'BTC', 'ETH')
+ * @returns Promise<FeeEstimate> containing fee recommendations
+ */
+declare function get_fees(coin: string): Promise<FeeEstimate>;
+/**
+ * Fetch xpub info from Blockbook with tokens, handling pagination and fallbacks.
+ * @param coin Uppercase/anycase coin key resolvable in BLOCKBOOK_URLS (e.g., 'BTC')
+ * @param pubkey xpub/ypub/zpub/tpub/vpub
+ * @param page Starting page number (default 1)
+ * @param pageSize Items per page (default 1000)
+ * @returns Promise<XpubResponse> with complete token information including changeIndex and receiveIndex
+ */
+declare function get_info_by_pubkey(coin: string, pubkey: string, page?: number, pageSize?: number): Promise<XpubResponse & {
+    changeIndex: number;
+    receiveIndex: number;
+}>;
+/**
+ * Compute next indexes from Blockbook tokens array.
+ * Returns the next external (receive) and internal (change) indexes.
+ *
+ * Logic:
+ *  - Consider an address "used" if transfers > 0 OR balance !== '0'
+ *  - Next index = (max used index on that branch) + 1
+ *
+ * @param tokens Array of BlockbookToken objects with path information
+ * @returns Object with nextReceiveAddressIndex and nextChangeAddressIndex
+ */
+declare function computeNextIndexes(tokens: BlockbookToken[]): NextIndexes;
+/**
+ * Convenience function: fetch tokens and return the next indexes directly.
+ * @param coin Coin symbol
+ * @param pubkey Extended public key
+ * @param page Starting page
+ * @param pageSize Items per page
+ * @returns Promise<NextIndexes> with next receive and change indexes
+ */
+declare function get_next_indexes_by_pubkey(coin: string, pubkey: string, page?: number, pageSize?: number): Promise<NextIndexes>;
+/**
+ * Get transaction IDs for a specific address with pagination support
+ * @param coin Coin symbol
+ * @param address Blockchain address
+ * @param page Page number (default 1)
+ * @returns Promise with address info including transaction IDs
+ */
+declare function get_txids_by_address(coin: string, address: string, page?: number): Promise<any>;
+/**
+ * Get detailed information for a specific address
+ * @param coin Coin symbol
+ * @param address Blockchain address
+ * @param filter Detail level filter (default 'all')
+ * @returns Promise with complete address information
+ */
+declare function get_info_by_address(coin: string, address: string, filter?: string): Promise<any>;
+/**
+ * Get all transactions for an extended public key
+ * @param coin Coin symbol
+ * @param xpub Extended public key
+ * @returns Promise with xpub info including all transactions
+ */
+declare function get_txs_by_xpub(coin: string, xpub: string): Promise<XpubResponse>;
+/**
+ * Broadcast a raw transaction to the network
+ * @param coin Coin symbol
+ * @param hex Raw transaction hex
+ * @returns Promise with broadcast result including success status and txid or error
+ */
+declare function broadcast_transaction(coin: string, hex: string): Promise<{
     success: boolean;
+    txid?: string;
+    error?: string;
+    statusCode?: number;
+    resp?: any;
+}>;
+/**
+ * Get detailed information about a specific transaction
+ * @param coin Coin symbol
+ * @param txid Transaction ID
+ * @returns Promise with transaction details
+ */
+declare function get_transaction(coin: string, txid: string): Promise<any>;
+/**
+ * Get UTXOs (Unspent Transaction Outputs) for an extended public key
+ * @param coin Coin symbol
+ * @param xpub Extended public key
+ * @param confirmedOnly Whether to include only confirmed UTXOs (default false)
+ * @returns Promise with array of UTXOs
+ */
+declare function get_utxos_by_xpub(coin: string, xpub: string, confirmedOnly?: boolean): Promise<any[]>;
+/**
+ * Get total balance for an extended public key in BTC (not satoshis)
+ * @param coin Coin symbol
+ * @param xpub Extended public key
+ * @returns Promise with balance in BTC (not satoshis)
+ */
+declare function get_balance_by_xpub(coin: string, xpub: string): Promise<number>;
+/**
+ * Get information about the Blockbook nodes
+ * @returns Promise with node status information
+ */
+declare function get_node_info(): Promise<{
+    initialized: boolean;
+    availableNodes: string[];
+    activeWebsockets: string[];
 }>;
-declare let get_transaction: (coin: string, txid: string) => Promise<any>;
-declare let get_utxos_by_xpub: (coin: string, xpub: string) => Promise<any>;
-declare let get_balance_by_xpub: (coin: string, xpub: any) => Promise<number>;
-declare let get_node_info: () => Promise<boolean>;