chore: standardize updates between websockets and socket.io

* chore: function structures

* chore: return accepted and streamed microblocks on socket.io block updates

* chore: move ws-rpc and socket-io to ws/ directory

* feat: add individual tx updates to socket.io

* fix: use updated microblock txs query function

* chore: add new schemas for block, microblock, mempool rpcs

* feat: handle new block, microblock, mempool websocket updates

* fix: socket.io type imports

* chore: add test for websocket mempool update

* chore: add test for block updates

* chore: add microblock update test

* chore: remove additional properties from rpc schemas

* chore: add client support for new websocket events

Author: rafaelcr

client/src/socket-io/index.ts

@@ -113,6 +113,14 @@ export class StacksApiSocketClient {
     this.handleSubscription(`address-stx-balance:${address}` as const, false);
   }
 
+  subscribeTransaction(txId: string) {
+    return this.handleSubscription(`transaction:${txId}` as const, true);
+  }
+
+  unsubscribeTransaction(txId: string) {
+    this.handleSubscription(`transaction:${txId}` as const, false);
+  }
+
   logEvents() {
     this.socket.on('connect', () => console.log('socket connected'));
     this.socket.on('disconnect', reason => console.warn('disconnected', reason));

client/src/ws/index.ts

@@ -8,6 +8,12 @@ import {
   RpcAddressBalanceSubscriptionParams,
   RpcAddressBalanceNotificationParams,
   RpcSubscriptionType,
+  Block,
+  RpcBlockSubscriptionParams,
+  Microblock,
+  Transaction,
+  RpcMicroblockSubscriptionParams,
+  RpcMempoolSubscriptionParams,
 } from '@stacks/stacks-blockchain-api-types';
 import { BASE_PATH } from '../generated/runtime';
 
@@ -26,6 +32,9 @@ export class StacksApiWebSocketClient {
   >();
 
   eventEmitter = new EventEmitter<{
+    block: (event: Block) => void;
+    microblock: (event: Microblock) => void;
+    mempool: (event: Transaction) => void;
     txUpdate: (event: RpcTxUpdateNotificationParams) => any;
     addressTxUpdate: (event: RpcAddressTxNotificationParams) => void;
     addressBalanceUpdate: (event: RpcAddressBalanceNotificationParams) => void;
@@ -95,6 +104,15 @@ export class StacksApiWebSocketClient {
           data.params as RpcAddressBalanceNotificationParams
         );
         break;
+      case 'block':
+        this.eventEmitter.emit('block', data.params as Block);
+        break;
+      case 'microblock':
+        this.eventEmitter.emit('microblock', data.params as Microblock);
+        break;
+      case 'mempool':
+        this.eventEmitter.emit('mempool', data.params as Transaction);
+        break;
     }
   }
 
@@ -106,6 +124,51 @@ export class StacksApiWebSocketClient {
     });
   }
 
+  async subscribeBlocks(update: (event: Block) => any): Promise<Subscription> {
+    const params: RpcBlockSubscriptionParams = { event: 'block' };
+    await this.rpcCall('subscribe', params);
+    const listener = (event: Block) => {
+      update(event);
+    };
+    this.eventEmitter.addListener('block', listener);
+    return {
+      unsubscribe: () => {
+        this.eventEmitter.removeListener('block', listener);
+        return this.rpcCall('unsubscribe', params);
+      },
+    };
+  }
+
+  async subscribeMicroblocks(update: (event: Microblock) => any): Promise<Subscription> {
+    const params: RpcMicroblockSubscriptionParams = { event: 'microblock' };
+    await this.rpcCall('subscribe', params);
+    const listener = (event: Microblock) => {
+      update(event);
+    };
+    this.eventEmitter.addListener('microblock', listener);
+    return {
+      unsubscribe: () => {
+        this.eventEmitter.removeListener('microblock', listener);
+        return this.rpcCall('unsubscribe', params);
+      },
+    };
+  }
+
+  async subscribeMempool(update: (event: Transaction) => any): Promise<Subscription> {
+    const params: RpcMempoolSubscriptionParams = { event: 'mempool' };
+    await this.rpcCall('subscribe', params);
+    const listener = (event: Transaction) => {
+      update(event);
+    };
+    this.eventEmitter.addListener('mempool', listener);
+    return {
+      unsubscribe: () => {
+        this.eventEmitter.removeListener('mempool', listener);
+        return this.rpcCall('unsubscribe', params);
+      },
+    };
+  }
+
   async subscribeTxUpdates(
     txId: string,
     update: (event: RpcTxUpdateNotificationParams) => any

docs/entities/ws-rpc/rpc-address-balance-notification-params.schema.json

@@ -7,6 +7,7 @@
     "address",
     "balance"
   ],
+  "additionalProperties": false,
   "properties": {
     "address": {
       "type": "string"

docs/entities/ws-rpc/rpc-address-balance-notification-response.schema.json

@@ -8,6 +8,7 @@
     "method",
     "params"
   ],
+  "additionalProperties": false,
   "properties": {
     "jsonrpc": {
       "type": "string",

docs/entities/ws-rpc/rpc-address-balance-subscription-params.schema.json

@@ -7,6 +7,7 @@
     "event",
     "address"
   ],
+  "additionalProperties": false,
   "properties": {
     "event": {
       "type": "string",

docs/entities/ws-rpc/rpc-address-balance-subscription-request.schema.json

@@ -9,6 +9,7 @@
     "method",
     "params"
   ],
+  "additionalProperties": false,
   "properties": {
     "jsonrpc": {
       "type": "string",

docs/entities/ws-rpc/rpc-address-tx-notification-params.schema.json

@@ -9,6 +9,7 @@
     "tx_type",
     "tx_status"
   ],
+  "additionalProperties": false,
   "properties": {
     "address": {
       "type": "string"

docs/entities/ws-rpc/rpc-address-tx-notification-response.schema.json

@@ -8,6 +8,7 @@
     "method",
     "params"
   ],
+  "additionalProperties": false,
   "properties": {
     "jsonrpc": {
       "type": "string",

docs/entities/ws-rpc/rpc-address-tx-subscription-params.schema.json

@@ -7,6 +7,7 @@
     "event",
     "address"
   ],
+  "additionalProperties": false,
   "properties": {
     "event": {
       "type": "string",

docs/entities/ws-rpc/rpc-address-tx-subscription-request.schema.json

@@ -9,6 +9,7 @@
     "method",
     "params"
   ],
+  "additionalProperties": false,
   "properties": {
     "jsonrpc": {
       "type": "string",