experimental stratum job visualization

backend/src/api/services/stratum.ts

@@ -0,0 +1,101 @@
+import { WebSocket } from 'ws';
+import logger from '../../logger';
+import websocketHandler from '../websocket-handler';
+
+export interface StratumJob {
+  pool: number;
+  height: number;
+  coinbase: string;
+  scriptsig: string;
+  reward: number;
+  jobId: string;
+  extraNonce: string;
+  extraNonce2Size: number;
+  prevHash: string;
+  coinbase1: string;
+  coinbase2: string;
+  merkleBranches: string[];
+  version: string;
+  bits: string;
+  time: string;
+  timestamp: number;
+  cleanJobs: boolean;
+  received: number;
+}
+
+function isStratumJob(obj: any): obj is StratumJob {
+  return obj
+    && typeof obj === 'object'
+    && 'pool' in obj
+    && 'prevHash' in obj
+    && 'height' in obj
+    && 'received' in obj
+    && 'version' in obj
+    && 'timestamp' in obj
+    && 'bits' in obj
+    && 'merkleBranches' in obj
+    && 'cleanJobs' in obj;
+}
+
+class StratumApi {
+  private ws: WebSocket | null = null;
+  private runWebsocketLoop: boolean = false;
+  private startedWebsocketLoop: boolean = false;
+  private websocketConnected: boolean = false;
+  private jobs: Record<string, StratumJob> = {};
+
+  public constructor() {}
+
+  public getJobs(): Record<string, StratumJob> {
+    return this.jobs;
+  }
+
+  private handleWebsocketMessage(msg: any): void {
+    if (isStratumJob(msg)) {
+      this.jobs[msg.pool] = msg;
+      websocketHandler.handleNewStratumJob(this.jobs[msg.pool]);
+    }
+  }
+
+  public async connectWebsocket(): Promise<void> {
+    this.runWebsocketLoop = true;
+    if (this.startedWebsocketLoop) {
+      return;
+    }
+    while (this.runWebsocketLoop) {
+      this.startedWebsocketLoop = true;
+      if (!this.ws) {
+        this.ws = new WebSocket(`http://localhost:3333`);
+        this.websocketConnected = true;
+
+        this.ws.on('open', () => {
+          logger.info('Stratum websocket opened');
+        });
+
+        this.ws.on('error', (error) => {
+          logger.err('Stratum websocket error: ' + error);
+          this.ws = null;
+          this.websocketConnected = false;
+        });
+
+        this.ws.on('close', () => {
+          logger.info('Stratum websocket closed');
+          this.ws = null;
+          this.websocketConnected = false;
+        });
+
+        this.ws.on('message', (data, isBinary) => {
+          try {
+            const parsedMsg = JSON.parse((isBinary ? data : data.toString()) as string);
+            this.handleWebsocketMessage(parsedMsg);
+          } catch (e) {
+            logger.warn('Failed to parse stratum websocket message: ' + (e instanceof Error ? e.message : e));
+          }
+        });
+      }
+      await new Promise(resolve => setTimeout(resolve, 5000));
+    }
+  }
+}
+
+export default new StratumApi();

backend/src/api/websocket-handler.ts

@@ -38,6 +38,7 @@ interface AddressTransactions {
 import bitcoinSecondClient from './bitcoin/bitcoin-second-client';
 import { calculateMempoolTxCpfp } from './cpfp';
 import { getRecentFirstSeen } from '../utils/file-read';
+import stratumApi, { StratumJob } from './services/stratum';
 
 // valid 'want' subscriptions
 const wantable = [
@@ -403,6 +404,16 @@ class WebsocketHandler {
             delete client['track-mempool'];
           }
 
+          if (parsedMessage && parsedMessage['track-stratum'] != null) {
+            if (parsedMessage['track-stratum']) {
+              const sub = parsedMessage['track-stratum'];
+              client['track-stratum'] = sub;
+              response['stratumJobs'] = this.socketData['stratumJobs'];
+            } else {
+              client['track-stratum'] = false;
+            }
+          }
+
           if (Object.keys(response).length) {
             client.send(this.serializeResponse(response));
           }
@@ -1384,6 +1395,23 @@ class WebsocketHandler {
     await statistics.runStatistics();
   }
 
+  public handleNewStratumJob(job: StratumJob): void {
+    this.updateSocketDataFields({ 'stratumJobs': stratumApi.getJobs() });
+
+    for (const server of this.webSocketServers) {
+      server.clients.forEach((client) => {
+        if (client.readyState !== WebSocket.OPEN) {
+          return;
+        }
+        if (client['track-stratum'] && (client['track-stratum'] === 'all' || client['track-stratum'] === job.pool)) {
+          client.send(JSON.stringify({
+            'stratumJob': job
+        }));
+        }
+      });
+    }
+  }
+
   // takes a dictionary of JSON serialized values
   // and zips it together into a valid JSON object
   private serializeResponse(response): string {