bybit-api 4.5.3 → 4.6.1

package/lib/util/BaseWSClient.d.ts

@@ -1,6 +1,6 @@
 import EventEmitter from 'events';
 import WebSocket from 'isomorphic-ws';
-import { MessageEventLike, WebsocketClientOptions, WSClientConfigurableOptions, WsMarket } from '../types';
+import { MessageEventLike, WebsocketClientOptions, WSClientConfigurableOptions, WsMarket, WsTopic } from '../types';
 import { WsOperation } from '../types/websockets/ws-api';
 import { DefaultLogger } from './logger';
 import { WSConnectedResult, WsTopicRequest, WsTopicRequestOrStringTopic } from './websockets';
@@ -11,6 +11,8 @@ interface WSClientEventMap<WsKey extends string> {
     open: (evt: {
         wsKey: WsKey;
         event: any;
+        wsUrl: string;
+        ws: WebSocket;
     }) => void;
     /** Reconnecting a dropped connection */
     reconnect: (evt: {
@@ -21,6 +23,8 @@ interface WSClientEventMap<WsKey extends string> {
     reconnected: (evt: {
         wsKey: WsKey;
         event: any;
+        wsUrl: string;
+        ws: WebSocket;
     }) => void;
     /** Connection closed */
     close: (evt: {
@@ -55,15 +59,18 @@ interface WSClientEventMap<WsKey extends string> {
         isWSAPIResponse?: boolean;
     }) => void;
 }
+/**
+ * Internally normalised structure for incoming WS events sorted into eventType categories
+ */
+export interface EmittableEvent<TEventType extends keyof WSClientEventMap<string> = keyof WSClientEventMap<string>> {
+    eventType: TEventType | 'pong' | 'connectionReady' | 'connectionReadyForAuth';
+    event: Parameters<WSClientEventMap<string>[TEventType]>[0];
+    isWSAPIResponse?: boolean;
+}
 export interface BaseWebsocketClient<TWSKey extends string, TWSRequestEvent extends object> {
     on<U extends keyof WSClientEventMap<TWSKey>>(event: U, listener: WSClientEventMap<TWSKey>[U]): this;
     emit<U extends keyof WSClientEventMap<TWSKey>>(event: U, ...args: Parameters<WSClientEventMap<TWSKey>[U]>): boolean;
 }
-export interface EmittableEvent<TEvent = any> {
-    eventType: 'response' | 'update' | 'exception' | 'authenticated';
-    event: TEvent;
-    isWSAPIResponse?: boolean;
-}
 /**
  * A midflight WS request event (e.g. subscribe to these topics).
  *
@@ -86,33 +93,39 @@ TWSKey extends string, TWSRequestEvent extends object> extends EventEmitter {
      * State store to track a list of topics (topic requests) we are expected to be subscribed to if reconnected
      */
     private wsStore;
-    logger: typeof DefaultLogger;
+    logger: DefaultLogger;
     protected options: WebsocketClientOptions;
     private wsApiRequestId;
     private timeOffsetMs;
+    private WS_LOGGER_CATEGORY;
     /**
      * A nested wsKey->request key store.
      * pendingTopicSubscriptionRequests[wsKey][requestKey] = WsKeyPendingTopicSubscriptions<TWSRequestEvent>
      */
     private pendingTopicSubscriptionRequests;
-    constructor(options?: WSClientConfigurableOptions, logger?: typeof DefaultLogger);
+    constructor(options?: WSClientConfigurableOptions & {
+        wsLoggerCategory: string;
+    }, logger?: DefaultLogger);
     /**
      * Return true if this wsKey connection should automatically authenticate immediately after connecting
      */
     protected abstract isAuthOnConnectWsKey(wsKey: TWSKey): boolean;
+    protected abstract isCustomReconnectionNeeded(wsKey: TWSKey): boolean;
+    protected abstract triggerCustomReconnectionWorkflow(wsKey: TWSKey): Promise<void>;
     protected abstract sendPingEvent(wsKey: TWSKey, ws: WebSocket): void;
     protected abstract sendPongEvent(wsKey: TWSKey, ws: WebSocket): void;
     protected abstract isWsPing(data: any): boolean;
     protected abstract isWsPong(data: any): boolean;
-    protected abstract getWsAuthRequestEvent(wsKey: TWSKey): Promise<object>;
-    protected abstract isPrivateTopicRequest(request: WsTopicRequest<string>, wsKey: TWSKey): boolean;
+    protected abstract authPrivateConnectionsOnConnect(_wsKey: TWSKey): boolean;
+    protected abstract getWsAuthRequestEvent(wsKey: TWSKey, eventToAuth?: object): Promise<object | string | 'waitForEvent' | void>;
+    protected abstract isPrivateTopicRequest(request: WsTopicRequest<WsTopic>, wsKey: TWSKey): boolean;
     protected abstract getPrivateWSKeys(): TWSKey[];
     protected abstract getWsUrl(wsKey: TWSKey): Promise<string>;
     protected abstract getMaxTopicsPerSubscribeEvent(wsKey: TWSKey): number | null;
     /**
      * @returns one or more correctly structured request events for performing a operations over WS. This can vary per exchange spec.
      */
-    protected abstract getWsRequestEvents(market: WsMarket, operation: WsOperation, requests: WsTopicRequest<string>[], wsKey: TWSKey): Promise<MidflightWsRequestEvent<TWSRequestEvent>[]>;
+    protected abstract getWsRequestEvents(market: WsMarket, operation: WsOperation, requests: WsTopicRequest<WsTopic>[], wsKey: TWSKey): Promise<MidflightWsRequestEvent<TWSRequestEvent>[]>;
     /**
      * Abstraction called to sort ws events into emittable event types (response to a request, data update, etc)
      */
@@ -158,7 +171,7 @@ TWSKey extends string, TWSRequestEvent extends object> extends EventEmitter {
      */
     private sortTopicRequestsIntoPublicPrivate;
     /** Get the WsStore that tracks websockets & topics */
-    getWsStore(): WsStore<TWSKey, WsTopicRequest<string>>;
+    getWsStore(): WsStore<TWSKey, WsTopicRequest<WsTopic>>;
     close(wsKey: TWSKey, force?: boolean): void;
     closeAll(force?: boolean): void;
     isConnected(wsKey: TWSKey): boolean;
@@ -189,7 +202,7 @@ TWSKey extends string, TWSRequestEvent extends object> extends EventEmitter {
      *
      * Events are automatically split into smaller batches, by this method, if needed.
      */
-    protected getWsOperationEventsForTopics(topics: WsTopicRequest<string>[], wsKey: TWSKey, operation: WsOperation): Promise<MidflightWsRequestEvent<TWSRequestEvent>[]>;
+    protected getWsOperationEventsForTopics(topics: WsTopicRequest<WsTopic>[], wsKey: TWSKey, operation: WsOperation): Promise<MidflightWsRequestEvent<TWSRequestEvent>[]>;
     /**
      * Simply builds and sends subscribe events for a list of topics for a ws key
      *
@@ -207,12 +220,23 @@ TWSKey extends string, TWSRequestEvent extends object> extends EventEmitter {
      */
     tryWsSend(wsKey: TWSKey, wsMessage: string, throwExceptions?: boolean): void;
     private onWsOpen;
+    private resolveConnectionInProgressPromise;
+    /**
+     * Called automatically once a connection is ready.
+     * - Some exchanges are ready immediately after the connections open.
+     * - Some exchanges send an event to confirm the connection is ready for us.
+     *
+     * This method is called to act when the connection is ready. Use `requireConnectionReadyConfirmation` to control how this is called.
+     */
+    private onWsReadyForEvents;
     /**
      * Handle subscription to private topics _after_ authentication successfully completes asynchronously.
      *
      * Only used for exchanges that require auth before sending private topic subscription requests
      */
     private onWsAuthenticated;
+    private onWsPing;
+    private onWsPong;
     private onWsMessage;
     private onWsClose;
     private getWs;