bybit-api 2.4.0-beta.1 → 3.0.1

package/lib/websocket-client.d.ts

@@ -1,52 +1,70 @@
 /// <reference types="node" />
 import { EventEmitter } from 'events';
 import WebSocket from 'isomorphic-ws';
-import { DefaultLogger } from './util/logger';
 import { KlineInterval, WSClientConfigurableOptions, WsKey, WsTopic } from './types';
-export declare interface WebsocketClient {
-    on(event: 'open' | 'reconnected', listener: ({ wsKey: WsKey, event: any }: {
-        wsKey: any;
+import { DefaultLogger } from './util';
+export declare type WsClientEvent = 'open' | 'update' | 'close' | 'error' | 'reconnect' | 'reconnected' | 'response';
+interface WebsocketClientEvents {
+    /** Connection opened. If this connection was previously opened and reconnected, expect the reconnected event instead */
+    open: (evt: {
+        wsKey: WsKey;
+        event: any;
+    }) => void;
+    /** Reconnecting a dropped connection */
+    reconnect: (evt: {
+        wsKey: WsKey;
+        event: any;
+    }) => void;
+    /** Successfully reconnected a connection that dropped */
+    reconnected: (evt: {
+        wsKey: WsKey;
+        event: any;
+    }) => void;
+    /** Connection closed */
+    close: (evt: {
+        wsKey: WsKey;
         event: any;
-    }) => void): this;
-    on(event: 'response' | 'update' | 'error', listener: (response: any) => void): this;
-    on(event: 'reconnect' | 'close', listener: ({ wsKey: WsKey }: {
-        wsKey: any;
-    }) => void): this;
+    }) => void;
+    /** Received reply to websocket command (e.g. after subscribing to topics) */
+    response: (response: any) => void;
+    /** Received data for topic */
+    update: (response: any) => void;
+    /** Exception from ws client OR custom listeners */
+    error: (response: any) => void;
+}
+export declare interface WebsocketClient {
+    on<U extends keyof WebsocketClientEvents>(event: U, listener: WebsocketClientEvents[U]): this;
+    emit<U extends keyof WebsocketClientEvents>(event: U, ...args: Parameters<WebsocketClientEvents[U]>): boolean;
 }
 export declare class WebsocketClient extends EventEmitter {
     private logger;
-    /** Purely used */
-    private restClient;
+    private restClient?;
     private options;
     private wsStore;
     constructor(options: WSClientConfigurableOptions, logger?: typeof DefaultLogger);
-    isLivenet(): boolean;
-    isLinear(): boolean;
-    isSpot(): boolean;
-    isInverse(): boolean;
-    /** USDC, spot v3, unified margin, account asset */
-    isV3(): boolean;
-    /**
-     * Add topic/topics to WS subscription list
-     */
-    subscribe(wsTopics: WsTopic[] | WsTopic): void;
     /**
-     * Remove topic/topics from WS subscription list
+     * Only used if we fetch exchange time before attempting auth.
+     * Disabled by default.
+     * I've removed this for ftx and it's working great, tempted to remove this here
      */
-    unsubscribe(wsTopics: WsTopic[] | WsTopic): void;
-    close(wsKey: WsKey): void;
+    prepareRESTClient(): void;
+    isTestnet(): boolean;
+    close(wsKey: WsKey, force?: boolean): void;
+    closeAll(force?: boolean): void;
     /**
      * Request connection of all dependent (public & private) websockets, instead of waiting for automatic connection by library
      */
-    connectAll(): Promise<WebSocket | undefined>[] | undefined;
-    connectPublic(): Promise<WebSocket | undefined> | undefined;
-    connectPrivate(): Promise<WebSocket | undefined> | undefined;
+    connectAll(): Promise<WebSocket | undefined>[];
+    connectPublic(): Promise<WebSocket | undefined>[];
+    connectPrivate(): Promise<WebSocket | undefined>;
     private connect;
     private parseWsError;
     /**
      * Return params required to make authorized request
      */
     private getAuthParams;
+    private sendAuthRequest;
+    private getWsAuthSignature;
     private reconnectWithDelay;
     private ping;
     private clearTimers;
@@ -60,20 +78,35 @@ export declare class WebsocketClient extends EventEmitter {
      * Send WS message to unsubscribe from topics.
      */
     private requestUnsubscribeTopics;
-    private tryWsSend;
+    tryWsSend(wsKey: WsKey, wsMessage: string): void;
     private connectToWsUrl;
     private onWsOpen;
     private onWsMessage;
     private onWsError;
     private onWsClose;
-    private onWsMessageResponse;
     private getWs;
     private setWsState;
     private getWsUrl;
-    private getWsKeyForTopic;
     private wrongMarketError;
+    /**
+     * Add topic/topics to WS subscription list
+     * @param wsTopics topic or list of topics
+     * @param isPrivateTopic optional - the library will try to detect private topics, you can use this to mark a topic as private (if the topic isn't recognised yet)
+     */
+    subscribe(wsTopics: WsTopic[] | WsTopic, isPrivateTopic?: boolean): void;
+    /**
+     * Remove topic/topics from WS subscription list
+     * @param wsTopics topic or list of topics
+     * @param isPrivateTopic optional - the library will try to detect private topics, you can use this to mark a topic as private (if the topic isn't recognised yet)
+     */
+    unsubscribe(wsTopics: WsTopic[] | WsTopic, isPrivateTopic?: boolean): void;
+    /** @deprecated use "market: 'spotv3" client */
     subscribePublicSpotTrades(symbol: string, binary?: boolean): void;
+    /** @deprecated use "market: 'spotv3" client */
     subscribePublicSpotTradingPair(symbol: string, binary?: boolean): void;
+    /** @deprecated use "market: 'spotv3" client */
     subscribePublicSpotV1Kline(symbol: string, candleSize: KlineInterval, binary?: boolean): void;
+    /** @deprecated use "market: 'spotv3" client */
     subscribePublicSpotOrderbook(symbol: string, depth: 'full' | 'merge' | 'delta', dumpScale?: number, binary?: boolean): void;
 }
+export {};