otx-btc-wallet-connectors 0.1.0

package/dist/utils/index.d.mts

@@ -0,0 +1,398 @@
+import { BitcoinNetwork } from 'otx-btc-wallet-core';
+export { G as GeneratePsbtOptions, l as GeneratePsbtResult, b as bytesToHex, k as deriveAddressFromPublicKey, f as finalizeAllInputs, a as finalizeAndBroadcast, g as generatePsbtForSend, c as getAddressType, d as getBitcoinJsNetwork, j as getDustThreshold, e as getInputVBytes, i as getOutputVBytes, h as hexToBytes, s as selectUtxos, t as toXOnly } from '../psbt-builder-CFOs69Z5.mjs';
+import 'bitcoinjs-lib';
+
+/**
+ * UTXO (Unspent Transaction Output) interface
+ */
+interface Utxo {
+    txid: string;
+    vout: number;
+    value: number;
+    status: {
+        confirmed: boolean;
+        block_height?: number;
+        block_hash?: string;
+        block_time?: number;
+    };
+}
+/**
+ * UTXO with raw transaction hex (needed for Ledger signing)
+ */
+interface UtxoWithTx extends Utxo {
+    txHex: string;
+}
+/**
+ * Fee rates response
+ */
+interface FeeRates {
+    fastest: number;
+    halfHour: number;
+    hour: number;
+    economy: number;
+    minimum: number;
+}
+/**
+ * Transaction details
+ */
+interface Transaction {
+    txid: string;
+    version: number;
+    locktime: number;
+    size: number;
+    weight: number;
+    fee: number;
+    status: {
+        confirmed: boolean;
+        block_height?: number;
+        block_hash?: string;
+        block_time?: number;
+    };
+}
+/**
+ * Full transaction with inputs and outputs (for Trezor refTxs)
+ */
+interface FullTransaction extends Transaction {
+    vin: Array<{
+        txid: string;
+        vout: number;
+        sequence: number;
+        scriptsig: string;
+        scriptsig_asm?: string;
+        witness?: string[];
+        prevout?: {
+            scriptpubkey: string;
+            scriptpubkey_asm?: string;
+            scriptpubkey_type?: string;
+            scriptpubkey_address?: string;
+            value: number;
+        };
+    }>;
+    vout: Array<{
+        scriptpubkey: string;
+        scriptpubkey_asm?: string;
+        scriptpubkey_type?: string;
+        scriptpubkey_address?: string;
+        value: number;
+    }>;
+}
+/**
+ * Address balance
+ */
+interface AddressBalance {
+    address: string;
+    chain_stats: {
+        funded_txo_count: number;
+        funded_txo_sum: number;
+        spent_txo_count: number;
+        spent_txo_sum: number;
+        tx_count: number;
+    };
+    mempool_stats: {
+        funded_txo_count: number;
+        funded_txo_sum: number;
+        spent_txo_count: number;
+        spent_txo_sum: number;
+        tx_count: number;
+    };
+}
+/**
+ * Bitcoin service interface that both Mempool and Blockstream services implement
+ */
+interface IBtcService {
+    readonly name: string;
+    readonly network: BitcoinNetwork;
+    setNetwork(network: BitcoinNetwork): void;
+    getUtxos(address: string): Promise<Utxo[]>;
+    getUtxosWithTxHex(address: string): Promise<UtxoWithTx[]>;
+    getTxHex(txid: string): Promise<string>;
+    getTransaction(txid: string): Promise<Transaction>;
+    getFullTransaction(txid: string): Promise<FullTransaction>;
+    broadcastTransaction(txHex: string): Promise<string>;
+    getBalance(address: string): Promise<number>;
+    getConfirmedBalance(address: string): Promise<number>;
+    getAddressInfo(address: string): Promise<AddressBalance>;
+    getFeeRates(): Promise<FeeRates>;
+}
+/**
+ * Network-specific endpoint URLs
+ */
+interface NetworkEndpoints {
+    mainnet?: string;
+    testnet?: string;
+    testnet4?: string;
+    signet?: string;
+}
+/**
+ * Configuration for BtcService endpoints
+ *
+ * @example
+ * ```typescript
+ * // Use custom mempool instance
+ * const config: BtcServiceConfig = {
+ *   mempool: {
+ *     mainnet: 'https://my-mempool.com/api',
+ *     testnet: 'https://my-mempool.com/testnet/api',
+ *   }
+ * };
+ *
+ * // Or use only one provider
+ * const config: BtcServiceConfig = {
+ *   preferredProvider: 'mempool',
+ *   mempool: {
+ *     mainnet: 'https://custom-mempool.example.com/api',
+ *   }
+ * };
+ * ```
+ */
+interface BtcServiceConfig {
+    /**
+     * Custom Mempool.space API endpoints
+     * Default: https://mempool.space/api (mainnet)
+     */
+    mempool?: NetworkEndpoints;
+    /**
+     * Custom Blockstream.info API endpoints
+     * Default: https://blockstream.info/api (mainnet)
+     */
+    blockstream?: NetworkEndpoints;
+    /**
+     * Preferred provider to use ('mempool' | 'blockstream' | 'race')
+     * - 'mempool': Only use Mempool API
+     * - 'blockstream': Only use Blockstream API
+     * - 'race': Use both and return fastest response (default)
+     */
+    preferredProvider?: 'mempool' | 'blockstream' | 'race';
+}
+
+/**
+ * Mempool.space Bitcoin Service
+ *
+ * @see https://mempool.space/docs/api
+ *
+ * @example
+ * ```typescript
+ * // Default usage
+ * const service = new MempoolService('mainnet');
+ *
+ * // With custom endpoints
+ * const service = new MempoolService('mainnet', {
+ *   mainnet: 'https://my-mempool-proxy.com/api',
+ *   testnet: 'https://my-mempool-proxy.com/testnet/api',
+ * });
+ * ```
+ */
+declare class MempoolService implements IBtcService {
+    readonly name = "mempool";
+    private _network;
+    private _customEndpoints;
+    constructor(network?: BitcoinNetwork, customEndpoints?: NetworkEndpoints);
+    get network(): BitcoinNetwork;
+    private get baseUrl();
+    setNetwork(network: BitcoinNetwork): void;
+    /**
+     * Set custom endpoints for this service
+     */
+    setCustomEndpoints(endpoints: NetworkEndpoints): void;
+    /**
+     * Get current endpoints configuration
+     */
+    getEndpoints(): Record<BitcoinNetwork, string>;
+    getUtxos(address: string): Promise<Utxo[]>;
+    getUtxosWithTxHex(address: string): Promise<UtxoWithTx[]>;
+    getTxHex(txid: string): Promise<string>;
+    getTransaction(txid: string): Promise<Transaction>;
+    getFullTransaction(txid: string): Promise<FullTransaction>;
+    broadcastTransaction(txHex: string): Promise<string>;
+    getAddressInfo(address: string): Promise<AddressBalance>;
+    getBalance(address: string): Promise<number>;
+    getConfirmedBalance(address: string): Promise<number>;
+    getFeeRates(): Promise<FeeRates>;
+}
+
+/**
+ * Blockstream.info Bitcoin Service
+ *
+ * @see https://github.com/Blockstream/esplora/blob/master/API.md
+ *
+ * @example
+ * ```typescript
+ * // Default usage
+ * const service = new BlockstreamService('mainnet');
+ *
+ * // With custom endpoints
+ * const service = new BlockstreamService('mainnet', {
+ *   mainnet: 'https://my-esplora-proxy.com/api',
+ *   testnet: 'https://my-esplora-proxy.com/testnet/api',
+ * });
+ * ```
+ */
+declare class BlockstreamService implements IBtcService {
+    readonly name = "blockstream";
+    private _network;
+    private _customEndpoints;
+    constructor(network?: BitcoinNetwork, customEndpoints?: NetworkEndpoints);
+    get network(): BitcoinNetwork;
+    private get baseUrl();
+    setNetwork(network: BitcoinNetwork): void;
+    /**
+     * Set custom endpoints for this service
+     */
+    setCustomEndpoints(endpoints: NetworkEndpoints): void;
+    /**
+     * Get current endpoints configuration
+     */
+    getEndpoints(): Record<BitcoinNetwork, string>;
+    getUtxos(address: string): Promise<Utxo[]>;
+    getUtxosWithTxHex(address: string): Promise<UtxoWithTx[]>;
+    getTxHex(txid: string): Promise<string>;
+    getTransaction(txid: string): Promise<Transaction>;
+    getFullTransaction(txid: string): Promise<FullTransaction>;
+    broadcastTransaction(txHex: string): Promise<string>;
+    getAddressInfo(address: string): Promise<AddressBalance>;
+    getBalance(address: string): Promise<number>;
+    getConfirmedBalance(address: string): Promise<number>;
+    getFeeRates(): Promise<FeeRates>;
+}
+
+/**
+ * Configure global BtcService settings
+ *
+ * @example
+ * ```typescript
+ * import { configureBtcService } from 'otx-btc-wallet-connectors';
+ *
+ * // Use custom mempool instance
+ * configureBtcService({
+ *   mempool: {
+ *     mainnet: 'https://my-mempool.com/api',
+ *     testnet: 'https://my-mempool.com/testnet/api',
+ *   }
+ * });
+ *
+ * // Use only mempool provider (no race)
+ * configureBtcService({
+ *   preferredProvider: 'mempool',
+ *   mempool: {
+ *     mainnet: 'https://custom-api.example.com/api',
+ *   }
+ * });
+ *
+ * // Reset to defaults
+ * configureBtcService({});
+ * ```
+ */
+declare function configureBtcService(config: BtcServiceConfig): void;
+/**
+ * Get current global BtcService configuration
+ */
+declare function getBtcServiceConfig(): BtcServiceConfig;
+/**
+ * Bitcoin Service that combines Mempool and Blockstream APIs
+ * Uses Promise.race for reliability and speed
+ *
+ * @example
+ * ```typescript
+ * // Default usage
+ * const btcService = new BtcService('mainnet');
+ *
+ * // With custom configuration
+ * const btcService = new BtcService('mainnet', {
+ *   mempool: {
+ *     mainnet: 'https://my-mempool-proxy.com/api',
+ *   },
+ *   preferredProvider: 'mempool', // Only use mempool
+ * });
+ *
+ * // Get balance (uses fastest responding API if preferredProvider is 'race')
+ * const balance = await btcService.getBalance('bc1q...');
+ *
+ * // Get UTXOs with tx hex (for Ledger signing)
+ * const utxos = await btcService.getUtxosWithTxHex('bc1q...');
+ *
+ * // Broadcast transaction
+ * const txid = await btcService.broadcastTransaction(signedTxHex);
+ * ```
+ */
+declare class BtcService implements IBtcService {
+    readonly name = "btc-service";
+    private _network;
+    private _mempool;
+    private _blockstream;
+    private _config;
+    constructor(network?: BitcoinNetwork, config?: BtcServiceConfig);
+    get network(): BitcoinNetwork;
+    /**
+     * Get the underlying Mempool service for direct access
+     */
+    get mempool(): MempoolService;
+    /**
+     * Get the underlying Blockstream service for direct access
+     */
+    get blockstream(): BlockstreamService;
+    /**
+     * Get current configuration
+     */
+    get config(): BtcServiceConfig;
+    setNetwork(network: BitcoinNetwork): void;
+    /**
+     * Update configuration
+     */
+    setConfig(config: BtcServiceConfig): void;
+    /**
+     * Execute method based on preferred provider setting
+     */
+    private executeWithProvider;
+    getUtxos(address: string): Promise<Utxo[]>;
+    getUtxosWithTxHex(address: string): Promise<UtxoWithTx[]>;
+    getTxHex(txid: string): Promise<string>;
+    getTransaction(txid: string): Promise<Transaction>;
+    getFullTransaction(txid: string): Promise<FullTransaction>;
+    broadcastTransaction(txHex: string): Promise<string>;
+    getAddressInfo(address: string): Promise<AddressBalance>;
+    getBalance(address: string): Promise<number>;
+    getConfirmedBalance(address: string): Promise<number>;
+    getFeeRates(): Promise<FeeRates>;
+}
+/**
+ * Get UTXOs for an address
+ */
+declare function getUtxos(address: string, network?: BitcoinNetwork): Promise<Utxo[]>;
+/**
+ * Get UTXOs with raw transaction hex
+ */
+declare function getUtxosWithTxHex(address: string, network?: BitcoinNetwork): Promise<UtxoWithTx[]>;
+/**
+ * Get raw transaction hex
+ */
+declare function getTxHex(txid: string, network?: BitcoinNetwork): Promise<string>;
+/**
+ * Get transaction details
+ */
+declare function getTransaction(txid: string, network?: BitcoinNetwork): Promise<Transaction>;
+/**
+ * Get full transaction with inputs and outputs (for Trezor refTxs)
+ */
+declare function getFullTransaction(txid: string, network?: BitcoinNetwork): Promise<FullTransaction>;
+/**
+ * Broadcast a signed transaction
+ */
+declare function broadcastTransaction(txHex: string, network?: BitcoinNetwork): Promise<string>;
+/**
+ * Get address info
+ */
+declare function getAddressInfo(address: string, network?: BitcoinNetwork): Promise<AddressBalance>;
+/**
+ * Get balance for an address
+ */
+declare function getBalance(address: string, network?: BitcoinNetwork): Promise<number>;
+/**
+ * Get confirmed balance for an address
+ */
+declare function getConfirmedBalance(address: string, network?: BitcoinNetwork): Promise<number>;
+/**
+ * Get current fee rates
+ */
+declare function getFeeRates(network?: BitcoinNetwork): Promise<FeeRates>;
+
+export { type AddressBalance, BlockstreamService, BtcService, type BtcServiceConfig, type FeeRates, type FullTransaction, type IBtcService, MempoolService, type NetworkEndpoints, type Transaction, type Utxo, type UtxoWithTx, broadcastTransaction, configureBtcService, getAddressInfo, getBalance, getBtcServiceConfig, getConfirmedBalance, getFeeRates, getFullTransaction, getTransaction, getTxHex, getUtxos, getUtxosWithTxHex };