chore(): more refactoring around base ws architecture

Author: tiagosiebler

src/types/websockets/index.ts

@@ -1,3 +1,4 @@
 export * from './request';
+export * from './ws-api';
 export * from './ws-events';
 export * from './ws-general';

src/types/websockets/request.ts

@@ -13,8 +13,6 @@ export type WsTradeOp =
   | 'amend-order'
   | 'batch-amend-order';
 
-export type WsRequestOp = 'login' | 'subscribe' | 'unsubscribe';
-
 export type WsPrivateChannel =
   | 'account'
   | 'positions'
@@ -171,11 +169,6 @@ export type WsBusinessChannel =
 
 export type WsChannel = WsPublicChannel | WsPrivateChannel | WsBusinessChannel;
 
-export interface WsBaseRequest {
-  op: WsRequestOp;
-  args: any[];
-}
-
 /** Used to trigger order actions over websockets (e.g. placing & cancelling orders) */
 export interface WsTradeBaseRequest {
   op: WsTradeOp;
@@ -303,24 +296,3 @@ export type WsChannelSubUnSubRequestArg =
   | WsPublicChannelArgOptionSummary
   | WsPublicChannelArgStatus
   | WsPublicChannelArgLiquidationOrders;
-
-/**
- *
- * Top level requests with args
- *
- */
-
-export interface WsSubRequest extends WsBaseRequest {
-  op: 'subscribe';
-  args: WsChannelSubUnSubRequestArg[];
-}
-
-export interface WsUnsubRequest extends WsBaseRequest {
-  op: 'unsubscribe';
-  args: WsChannelSubUnSubRequestArg[];
-}
-
-export interface WsAuthRequest extends WsBaseRequest {
-  op: 'login';
-  args: WsAuthRequestArg[];
-}

src/types/websockets/ws-api.ts

@@ -1,4 +1,5 @@
 import { WS_KEY_MAP, WsKey } from '../../util';
+import { WsAuthRequestArg, WsChannelSubUnSubRequestArg } from './request';
 
 export interface WSAPIRequestFlags {
   /** If true, will skip auth requirement for WS API connection */
@@ -7,6 +8,47 @@ export interface WSAPIRequestFlags {
 
 export type WSOperation = 'subscribe' | 'unsubscribe' | 'login';
 
+/**
+ *
+ * Top level requests with args
+ *
+ */
+
+/**
+
+/**
+ * request looks like this:
+{
+  "id": "1512",
+  "op": "subscribe",
+  "args": [
+    {
+      "channel": "tickers",
+      "instId": "BTC-USDT"
+    }
+  ]
+}
+ */
+export interface WsRequestOperationOKX<TWSRequestArg> {
+  id: string;
+  op: WSOperation;
+  args?: TWSRequestArg[];
+}
+
+export interface WsSubRequest
+  extends WsRequestOperationOKX<WsChannelSubUnSubRequestArg> {
+  op: 'subscribe';
+}
+
+export interface WsUnsubRequest
+  extends WsRequestOperationOKX<WsChannelSubUnSubRequestArg> {
+  op: 'unsubscribe';
+}
+
+export interface WsAuthRequest extends WsRequestOperationOKX<WsAuthRequestArg> {
+  op: 'login';
+}
+
 // When new WS API operations are added, make sure to also update WS_API_Operations[] below
 export type WSAPIOperation =
   | 'place-order'
@@ -21,6 +63,7 @@ export const WS_API_Operations: WSAPIOperation[] = [
   'batch-cancel',
 ];
 
+// TODO:
 export interface WSAPIRequestOKX<TSomething> {
   id: 1;
   empty: TSomething;

src/util/BaseWSClient.ts

@@ -24,7 +24,7 @@ import { WSConnectedResult, WsConnectionStateEnum } from './WsStore.types';
 
 export interface WSClientEventMap<
   WsKey extends string,
-  TUpdateEventData = any,
+  TWSUpdateEventData = any,
 > {
   /** Connection opened. If this connection was previously opened and reconnected, expect the reconnected event instead */
   open: (evt: {
@@ -55,7 +55,7 @@ export interface WSClientEventMap<
   update: (response: any & { wsKey: WsKey }) => void;
 
   /** Exception from ws client OR custom listeners (e.g. if you throw inside your event handler) */
-  exception: (response: TUpdateEventData & { wsKey: WsKey }) => void;
+  exception: (response: TWSUpdateEventData & { wsKey: WsKey }) => void;
 
   /** Confirmation that a connection successfully authenticated */
   authenticated: (event: { wsKey: WsKey; event: any }) => void;
@@ -66,15 +66,16 @@ export interface BaseWebsocketClient<
   TWSKey extends string,
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   TWSRequestEvent extends object,
+  TWSUpdateEventData = any,
 > {
-  on<U extends keyof WSClientEventMap<TWSKey>>(
+  on<U extends keyof WSClientEventMap<TWSKey, TWSUpdateEventData>>(
     event: U,
-    listener: WSClientEventMap<TWSKey>[U],
+    listener: WSClientEventMap<TWSKey, TWSUpdateEventData>[U],
   ): this;
 
-  emit<U extends keyof WSClientEventMap<TWSKey>>(
+  emit<U extends keyof WSClientEventMap<TWSKey, TWSUpdateEventData>>(
     event: U,
-    ...args: Parameters<WSClientEventMap<TWSKey>[U]>
+    ...args: Parameters<WSClientEventMap<TWSKey, TWSUpdateEventData>[U]>
   ): boolean;
 }
 
@@ -177,7 +178,8 @@ export abstract class BaseWebsocketClient<
       market: 'GLOBAL',
 
       demoTrading: false,
-      pongTimeout: 1000,
+
+      pongTimeout: 2000,
       pingInterval: 10000,
       reconnectTimeout: 500,
 

src/util/websocket-util.ts

@@ -344,7 +344,7 @@ export function getWsUrlForWsKey(
   }
 }
 
-export function getMaxTopicsPerSubscribeEvent(
+export function getMaxTopicsPerSubscribeEventForMarket(
   market: APIMarket,
 ): number | null {
   switch (market) {

src/websocket-client-legacy.ts

@@ -16,7 +16,7 @@ import {
 } from './types';
 import {
   DefaultLogger,
-  getMaxTopicsPerSubscribeEvent,
+  getMaxTopicsPerSubscribeEventForMarket,
   getWsKeyForTopicChannel,
   isConnCountEvent,
   isWsDataEvent,
@@ -43,7 +43,7 @@ import WsStore from './util/WsStore';
 import { WsConnectionStateEnum } from './util/WsStore.types';
 
 // Type safety for on and emit handlers: https://stackoverflow.com/a/61609010/880837
-export declare interface WebsocketClient {
+export declare interface WebsocketClientLegacy {
   on<U extends keyof WSClientEventMap<WsKey, WsDataEvent>>(
     event: U,
     listener: WSClientEventMap<WsKey>[U],
@@ -55,17 +55,14 @@ export declare interface WebsocketClient {
   ): boolean;
 }
 
-export class WebsocketClient extends EventEmitter {
-  private logger: typeof DefaultLogger;
+export class WebsocketClientLegacy extends EventEmitter {
+  private logger: DefaultLogger;
 
   private options: WebsocketClientOptions;
 
   private wsStore: WsStore<WsKey, WsChannelSubUnSubRequestArg>;
 
-  constructor(
-    options: WSClientConfigurableOptions,
-    logger?: typeof DefaultLogger,
-  ) {
+  constructor(options: WSClientConfigurableOptions, logger?: DefaultLogger) {
     super();
 
     this.logger = logger || DefaultLogger;
@@ -87,7 +84,7 @@ export class WebsocketClient extends EventEmitter {
 
     if ((this.options.market as any) === 'demo') {
       throw new Error(
-        'ERROR: to use demo trading, set the "demoTrading: true" flag in the constructor',
+        'ERROR: to use demo trading, set the "demoTrading: true" flag in the constructor. The "demo" market is not valid any more.',
       );
     }
   }
@@ -296,7 +293,7 @@ export class WebsocketClient extends EventEmitter {
    */
   private async getWsAuthRequest(
     wsKey: WsKey,
-  ): Promise<WsAuthRequest | undefined> {
+  ): Promise<Omit<WsAuthRequest, 'id'> | undefined> {
     const isPublicWsKey = PUBLIC_WS_KEYS.includes(wsKey);
     const accounts = this.options.accounts;
     const hasAccountsToAuth = !!accounts?.length;
@@ -339,7 +336,7 @@ export class WebsocketClient extends EventEmitter {
         (request): request is WsAuthRequestArg => !!request,
       );
 
-      const authParams: WsAuthRequest = {
+      const authParams: Omit<WsAuthRequest, 'id'> = {
         op: 'login',
         args: authRequests,
       };
@@ -539,7 +536,7 @@ export class WebsocketClient extends EventEmitter {
       return;
     }
 
-    const maxTopicsPerEvent = getMaxTopicsPerSubscribeEvent(
+    const maxTopicsPerEvent = getMaxTopicsPerSubscribeEventForMarket(
       this.options.market,
     );
     if (maxTopicsPerEvent && topics.length > maxTopicsPerEvent) {
@@ -557,7 +554,7 @@ export class WebsocketClient extends EventEmitter {
       return;
     }
 
-    const request: WsSubRequest = {
+    const request: Omit<WsSubRequest, 'id'> = {
       op: 'subscribe',
       args: topics,
     };
@@ -578,7 +575,7 @@ export class WebsocketClient extends EventEmitter {
       return;
     }
 
-    const maxTopicsPerEvent = getMaxTopicsPerSubscribeEvent(
+    const maxTopicsPerEvent = getMaxTopicsPerSubscribeEventForMarket(
       this.options.market,
     );
     if (maxTopicsPerEvent && topics.length > maxTopicsPerEvent) {
@@ -596,7 +593,7 @@ export class WebsocketClient extends EventEmitter {
       return;
     }
 
-    const request: WsUnsubRequest = {
+    const request: Omit<WsUnsubRequest, 'id'> = {
       op: 'unsubscribe',
       args: topics,
     };