dexbot 1.1.10

package/dist/modules/node_manager.d.ts

@@ -0,0 +1,215 @@
+/**
+ * modules/node_manager.ts - Multi-Node Health Checking and Failover Management
+ *
+ * Manages a configurable list of BitShares nodes with automatic health checking and
+ * intelligent node selection based on latency and availability.
+ *
+ * ===============================================================================
+ * FEATURES
+ * ===============================================================================
+ *
+ * 1. Node Health Monitoring
+ *    - Periodic health checks for all configured nodes
+ *    - Latency measurement via WebSocket ping
+ *    - Chain ID validation (ensure correct network)
+ *    - Automatic blacklisting of failed nodes
+ *
+ * 2. Intelligent Node Selection
+ *    - Selects lowest-latency healthy node
+ *    - Falls back to slow nodes if no healthy ones available
+ *    - Respects user-preferred node if healthy
+ *
+ * 3. Failover Integration
+ *    - Exports node stats for monitoring
+ *    - Designed to work with the native transport's setNodes() API
+ *    - Automatic recovery when blacklisted nodes become healthy
+ *
+ * ===============================================================================
+ * USAGE
+ * ===============================================================================
+ *
+ * In bitshares_client.ts:
+ *
+ *   const NodeManager = require('./node_manager');
+ *   const nodeManager = new NodeManager(config);
+ *   await nodeManager.checkAllNodes();
+ *   const bestNode = nodeManager.getBestNode();
+ *   nativeClient.setNodes(nodeManager.getHealthyNodes());
+ *   nodeManager.start();  // Begin periodic monitoring
+ *
+ * ===============================================================================
+ */
+interface NodeManagerConfig {
+    list?: string[];
+    blacklistStateFile?: string;
+    stateDir?: string;
+    healthCheck?: {
+        intervalMs?: number;
+        timeoutMs?: number;
+        maxPingMs?: number;
+        blacklistThreshold?: number;
+        enabled?: boolean;
+    };
+    selection?: {
+        strategy?: string;
+        preferredNode?: string | null;
+    };
+    healthCacheFile?: string;
+    [key: string]: any;
+}
+/**
+ * NodeManager - Manages health checking and selection of BitShares nodes
+ *
+ * @class
+ * @param {Object} config - Configuration object
+ * @param {string[]} config.list - List of node URLs to monitor (e.g., wss://dex.iobanker.com/ws)
+ * @param {Object} [config.healthCheck] - Health check settings
+ * @param {number} [config.healthCheck.intervalMs=NODE_MANAGEMENT.HEALTH_CHECK_INTERVAL_MS] - How often to check nodes (milliseconds)
+ * @param {number} [config.healthCheck.timeoutMs=5000] - Timeout for each health check
+ * @param {number} [config.healthCheck.maxPingMs=3000] - Max acceptable latency
+ * @param {number} [config.healthCheck.blacklistThreshold=3] - Failures before blacklist
+ * @param {Object} [config.selection] - Node selection settings
+ * @param {string} [config.selection.strategy="latency"] - Selection strategy
+ * @param {string} [config.selection.preferredNode] - Optional preferred node (if healthy)
+ */
+declare class NodeManager {
+    logger: any;
+    blacklistStateFile: string;
+    healthCacheFile: string;
+    config: any;
+    nodeStats: Map<any, any>;
+    _lastBlacklistWarnMs: Map<any, any>;
+    monitoringActive: boolean;
+    checkIntervalId: any;
+    checkAllNodesPromise: any;
+    expectedChainId: string;
+    BLACKLIST_COOLDOWN_MS: number;
+    constructor(config?: NodeManagerConfig);
+    /**
+     * Initialize tracking for all configured nodes
+     * @private
+     */
+    private initializeNodeStats;
+    /**
+     * Load persisted blacklist state from disk
+     * @private
+     */
+    private loadBlacklistState;
+    /**
+     * Persist blacklisted nodes to disk
+     * @private
+     */
+    private saveBlacklistState;
+    /**
+     * Persist the latest healthy/slow node ordering for lightweight consumers
+     * such as the credential daemon.
+     * @private
+     */
+    private saveHealthCache;
+    /**
+     * Start periodic health monitoring
+     */
+    start(): void;
+    /**
+     * Stop periodic health monitoring
+     */
+    stop(): void;
+    /**
+     * Check all nodes in parallel
+     * @returns {Promise<void>}
+     */
+    checkAllNodes(): Promise<void>;
+    /**
+     * Check a single node's health
+     *
+     * Measures:
+     * 1. WebSocket handshake latency
+     * 2. RPC ping latency (get_chain_id)
+     * 3. Chain ID validation
+     * 4. Classifies as: healthy, slow, or failed
+     *
+     * @param {string} nodeUrl - WebSocket URL of the node
+     * @returns {Promise<Object>} Health check result: { status, latency, error }
+     */
+    checkNode(nodeUrl: string): Promise<{
+        status: string;
+        latency: number | null;
+        error: string | null;
+    }>;
+    _shouldLogBlacklistWarning(nodeUrl: string, errorMessage: string, nowMs?: number): boolean;
+    _clearBlacklistWarningCooldown(nodeUrl?: string | null): void;
+    /**
+     * Connect to a WebSocket with timeout
+     * @private
+     * @param {string} nodeUrl - WebSocket URL
+     * @param {number} timeoutMs - Connection timeout
+     * @returns {Promise<WebSocket>} Connected WebSocket instance
+     */
+    connectWithTimeout(nodeUrl: string, timeoutMs: number): Promise<any>;
+    /**
+     * Query the BitShares chain ID using the Graphene WebSocket RPC protocol.
+     * @private
+     * @param {WebSocket} ws - Connected WebSocket
+     * @param {number} timeoutMs - RPC timeout
+     * @returns {Promise<string>} Chain ID
+     */
+    getChainId(ws: any, timeoutMs: number): Promise<string>;
+    /**
+     * Make a JSON-RPC call to a WebSocket
+     * @private
+     * @param {WebSocket} ws - Connected WebSocket
+     * @param {string} method - RPC method name
+     * @param {Array} params - RPC parameters
+     * @param {number} timeoutMs - RPC timeout
+     * @returns {Promise<any>} RPC result
+     */
+    rpcCall(ws: any, method: string, params: any[], timeoutMs: number): Promise<any>;
+    /**
+     * Get list of healthy nodes sorted by latency (best first)
+     * @returns {string[]} Array of node URLs
+     */
+    getHealthyNodes(): string[];
+    /**
+     * Get the single best (lowest latency) healthy node
+     * @returns {string|null} Best node URL or null if none available
+     */
+    getBestNode(): string | null;
+    /**
+     * Manually blacklist a node (e.g., when it causes a connection failure)
+     * @param {string} nodeUrl - Node URL to blacklist
+     */
+    blacklistNode(nodeUrl: string): void;
+    /**
+     * Reset blacklist for a specific node (allow recovery)
+     * @param {string} nodeUrl - Node URL to reset
+     */
+    resetNode(nodeUrl: string): void;
+    /**
+     * Reset all nodes (allow full recovery)
+     */
+    resetAllNodes(): void;
+    /**
+     * Get current node statistics (for monitoring/logging)
+     * @returns {Array<Object>} Array of node stats
+     */
+    getStats(): Array<{
+        url: string;
+        status: string;
+        latencyMs: number | null;
+        failureCount: number;
+        lastCheckTime: string | null;
+        lastErrorMessage: string | null;
+    }>;
+    /**
+     * Get summary statistics
+     * @returns {Object} Summary stats
+     */
+    getSummary(): {
+        monitoring: boolean;
+        counts: Record<string, number>;
+        bestNode: string | null;
+        avgLatency: number | null;
+    };
+}
+export = NodeManager;
+//# sourceMappingURL=node_manager.d.ts.map

package/dist/modules/node_manager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"node_manager.d.ts","sourceRoot":"","sources":["../../modules/node_manager.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AAaH,UAAU,iBAAiB;IACvB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE;QACV,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAC5B,OAAO,CAAC,EAAE,OAAO,CAAC;KACrB,CAAC;IACF,SAAS,CAAC,EAAE;QACR,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACjC,CAAC;IACF,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB;AAED;;;;;;;;;;;;;;GAcG;AACH,cAAM,WAAW;IACb,MAAM,EAAE,GAAG,CAAC;IACZ,kBAAkB,EAAE,MAAM,CAAC;IAC3B,eAAe,EAAE,MAAM,CAAC;IACxB,MAAM,EAAE,GAAG,CAAC;IACZ,SAAS,EAAE,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IACzB,oBAAoB,EAAE,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IACpC,gBAAgB,EAAE,OAAO,CAAC;IAC1B,eAAe,EAAE,GAAG,CAAC;IACrB,oBAAoB,EAAE,GAAG,CAAC;IAC1B,eAAe,EAAE,MAAM,CAAC;IACxB,qBAAqB,EAAE,MAAM,CAAC;gBAElB,MAAM,GAAE,iBAAsB;IA2C1C;;;OAGG;IACH,OAAO,CAAC,mBAAmB;IAiB3B;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IAmB1B;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IAsB1B;;;;OAIG;IACH,OAAO,CAAC,eAAe;IAQvB;;OAEG;IACH,KAAK,IAAI,IAAI;IAyBb;;OAEG;IACH,IAAI,IAAI,IAAI;IAWZ;;;OAGG;IACG,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IA2CpC;;;;;;;;;;;OAWG;IACG,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAAC;IAqE3G,0BAA0B,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,GAAE,MAAmB,GAAG,OAAO;IAWtG,8BAA8B,CAAC,OAAO,GAAE,MAAM,GAAG,IAAW,GAAG,IAAI;IAcnE;;;;;;OAMG;IACH,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IA2CpE;;;;;;OAMG;IACG,UAAU,CAAC,EAAE,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAM7D;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAsDhF;;;OAGG;IACH,eAAe,IAAI,MAAM,EAAE;IAqB3B;;;OAGG;IACH,WAAW,IAAI,MAAM,GAAG,IAAI;IAK5B;;;OAGG;IACH,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAYpC;;;OAGG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAehC;;OAEG;IACH,aAAa;IAeb;;;OAGG;IACH,QAAQ,IAAI,KAAK,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,YAAY,EAAE,MAAM,CAAC;QAAC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAAC;IAWjK;;;OAGG;IACH,UAAU,IAAI;QAAE,UAAU,EAAE,OAAO,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE;CA2B5H;AAED,SAAS,WAAW,CAAC"}