bitget-api 2.3.6 → 3.0.0

package/dist/mjs/websocket-api-client.js

@@ -0,0 +1,118 @@
+import { WS_KEY_MAP } from './util/websocket-util.js';
+import { WebsocketClientV3 } from './websocket-client-v3.js';
+/**
+ * This is a minimal Websocket API wrapper around the WebsocketClient.
+ *
+ * Note: You can also directly use the sendWSAPIRequest() method to make WS API calls, but some
+ * may find the below methods slightly more intuitive.
+ *
+ * Refer to the WS API promises example for a more detailed example on using sendWSAPIRequest() directly:
+ * https://github.com/tiagosiebler/bitget-api/blob/master/examples/V3/ws-api-trade-raw.ts
+ */
+export class WebsocketAPIClient {
+    wsClient;
+    options;
+    constructor(options, logger) {
+        this.wsClient = new WebsocketClientV3(options, logger);
+        this.options = {
+            attachEventListeners: true,
+            ...options,
+        };
+        this.setupDefaultEventListeners();
+    }
+    getWSClient() {
+        return this.wsClient;
+    }
+    setTimeOffsetMs(newOffset) {
+        return this.getWSClient().setTimeOffsetMs(newOffset);
+    }
+    /*
+     * Bitget WebSocket API Methods
+     * https://www.bitget.com/api-doc/uta/websocket/private/Place-Order-Channel
+     */
+    /**
+     * Submit a new order
+     *
+     * https://www.bitget.com/api-doc/uta/websocket/private/Place-Order-Channel
+     *
+     * @returns
+     */
+    submitNewOrder(category, params) {
+        return this.wsClient.sendWSAPIRequest(WS_KEY_MAP.v3Private, 'place-order', category, params);
+    }
+    /**
+     * Submit a new order
+     *
+     * https://www.bitget.com/api-doc/uta/websocket/private/Batch-Place-Order-Channel
+     *
+     * @returns
+     */
+    placeBatchOrders(category, params) {
+        return this.wsClient.sendWSAPIRequest(WS_KEY_MAP.v3Private, 'batch-place', category, params);
+    }
+    /*
+     * Bitget WebSocket API Methods
+     * https://www.bitget.com/api-doc/uta/websocket/private/Place-Order-Channel
+     */
+    /**
+     * Cancel Order
+     *
+     * https://www.bitget.com/api-doc/uta/websocket/private/Cancel-Order-Channel
+     *
+     * @returns
+     */
+    cancelOrder(category, params) {
+        return this.wsClient.sendWSAPIRequest(WS_KEY_MAP.v3Private, 'cancel-order', category, params);
+    }
+    /**
+     * Batch Cancel Order
+     *
+     * https://www.bitget.com/api-doc/uta/websocket/private/Batch-Cancel-Order-Channel
+     *
+     * @returns
+     */
+    cancelBatchOrders(category, params) {
+        return this.wsClient.sendWSAPIRequest(WS_KEY_MAP.v3Private, 'batch-cancel', category, params);
+    }
+    /**
+     *
+     *
+     *
+     *
+     *
+     *
+     *
+     * Private methods for handling some of the convenience/automation provided by the WS API Client
+     *
+     *
+     *
+     *
+     *
+     *
+     *
+     */
+    setupDefaultEventListeners() {
+        if (this.options.attachEventListeners) {
+            /**
+             * General event handlers for monitoring the WebsocketClient
+             */
+            this.wsClient
+                .on('open', (data) => {
+                console.log(new Date(), 'ws connected', data.wsKey);
+            })
+                .on('reconnect', ({ wsKey }) => {
+                console.log(new Date(), 'ws automatically reconnecting.... ', wsKey);
+            })
+                .on('reconnected', (data) => {
+                console.log(new Date(), 'ws has reconnected ', data?.wsKey);
+            })
+                .on('authenticated', (data) => {
+                console.info(new Date(), 'ws has authenticated ', data?.wsKey);
+            })
+                .on('exception', (data) => {
+                console.error(new Date(), 'ws exception: ', JSON.stringify(data));
+            });
+        }
+    }
+}
+//# sourceMappingURL=websocket-api-client.js.map

package/dist/mjs/websocket-api-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket-api-client.js","sourceRoot":"","sources":["../../src/websocket-api-client.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAkB7D;;;;;;;;GAQG;AACH,MAAM,OAAO,kBAAkB;IACrB,QAAQ,CAAoB;IAE5B,OAAO,CAA+D;IAE9E,YACE,OACyC,EACzC,MAAsB;QAEtB,IAAI,CAAC,QAAQ,GAAG,IAAI,iBAAiB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAEvD,IAAI,CAAC,OAAO,GAAG;YACb,oBAAoB,EAAE,IAAI;YAC1B,GAAG,OAAO;SACX,CAAC;QAEF,IAAI,CAAC,0BAA0B,EAAE,CAAC;IACpC,CAAC;IAEM,WAAW;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAEM,eAAe,CAAC,SAAiB;QACtC,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;IACvD,CAAC;IAED;;;OAGG;IAEH;;;;;;OAMG;IACH,cAAc,CACZ,QAA0B,EAC1B,MAAgC;QAEhC,OAAO,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CACnC,UAAU,CAAC,SAAS,EACpB,aAAa,EACb,QAAQ,EACR,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,gBAAgB,CACd,QAA0B,EAC1B,MAAkC;QAElC,OAAO,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CACnC,UAAU,CAAC,SAAS,EACpB,aAAa,EACb,QAAQ,EACR,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;OAGG;IAEH;;;;;;OAMG;IACH,WAAW,CACT,QAA0B,EAC1B,MAA4B;QAE5B,OAAO,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CACnC,UAAU,CAAC,SAAS,EACpB,cAAc,EACd,QAAQ,EACR,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,iBAAiB,CACf,QAA0B,EAC1B,MAA8B;QAE9B,OAAO,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CACnC,UAAU,CAAC,SAAS,EACpB,cAAc,EACd,QAAQ,EACR,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IAEK,0BAA0B;QAChC,IAAI,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE,CAAC;YACtC;;eAEG;YACH,IAAI,CAAC,QAAQ;iBACV,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;gBACnB,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,EAAE,cAAc,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;YACtD,CAAC,CAAC;iBACD,EAAE,CAAC,WAAW,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE;gBAC7B,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,EAAE,oCAAoC,EAAE,KAAK,CAAC,CAAC;YACvE,CAAC,CAAC;iBACD,EAAE,CAAC,aAAa,EAAE,CAAC,IAAI,EAAE,EAAE;gBAC1B,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,EAAE,qBAAqB,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;YAC9D,CAAC,CAAC;iBACD,EAAE,CAAC,eAAe,EAAE,CAAC,IAAI,EAAE,EAAE;gBAC5B,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,EAAE,uBAAuB,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;YACjE,CAAC,CAAC;iBACD,EAAE,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,EAAE;gBACxB,OAAO,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,EAAE,gBAAgB,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;YACpE,CAAC,CAAC,CAAC;QACP,CAAC;IACH,CAAC;CACF"}

package/{lib/util/BaseWSClient.d.ts → dist/mjs/websocket-client-legacy-v1.d.ts}

@@ -1,10 +1,9 @@
-/// <reference types="node" />
-import EventEmitter from 'events';
+import { EventEmitter } from 'events';
 import WebSocket from 'isomorphic-ws';
-import { WebsocketClientOptions, WSClientConfigurableOptions } from '../types/index';
-import { DefaultLogger } from './logger';
-import WsStore from './WsStore';
-interface WSClientEventMap<WsKey extends string> {
+import { BitgetInstType, WSClientConfigurableOptions, WsKey, WsTopic, WsTopicSubscribeEventArgs } from './types/websockets/ws-general.js';
+import { DefaultLogger } from './util/logger.js';
+export type WsClientEvent = 'open' | 'update' | 'close' | 'exception' | 'reconnect' | 'reconnected' | 'response';
+interface WebsocketClientEvents {
     /** Connection opened. If this connection was previously opened and reconnected, expect the reconnected event instead */
     open: (evt: {
         wsKey: WsKey;
@@ -43,45 +42,44 @@ interface WSClientEventMap<WsKey extends string> {
         event: any;
     }) => void;
 }
-export interface BaseWebsocketClient<TWSKey extends string, TWSTopicSubscribeEventArgs 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 declare interface WebsocketClientLegacyV1 {
+    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 abstract class BaseWebsocketClient<TWSKey extends string, TWSTopicSubscribeEventArgs extends object> extends EventEmitter {
+/**
+ * @deprecated use WebsocketClientV2 instead
+ */
+export declare class WebsocketClientLegacyV1 extends EventEmitter {
+    private logger;
+    private options;
     private wsStore;
-    protected logger: typeof DefaultLogger;
-    protected options: WebsocketClientOptions;
     constructor(options: WSClientConfigurableOptions, logger?: typeof DefaultLogger);
-    protected abstract getWsKeyForTopic(subscribeEvent: TWSTopicSubscribeEventArgs, isPrivate?: boolean): TWSKey;
-    protected abstract isPrivateChannel(subscribeEvent: TWSTopicSubscribeEventArgs): boolean;
-    protected abstract shouldAuthOnConnect(wsKey: TWSKey): boolean;
-    protected abstract getWsUrl(wsKey: TWSKey): string;
-    protected abstract getMaxTopicsPerSubscribeEvent(wsKey: TWSKey): number | null;
-    /**
-     * Request connection of all dependent (public & private) websockets, instead of waiting for automatic connection by library
-     */
-    abstract connectAll(): Promise<WebSocket | undefined>[];
     /**
      * Subscribe to topics & track/persist them. They will be automatically resubscribed to if the connection drops/reconnects.
      * @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: TWSTopicSubscribeEventArgs[] | TWSTopicSubscribeEventArgs, isPrivateTopic?: boolean): void;
+    subscribe(wsTopics: WsTopicSubscribeEventArgs[] | WsTopicSubscribeEventArgs, isPrivateTopic?: boolean): void;
     /**
      * Unsubscribe from topics & remove them from memory. They won't be re-subscribed to if the connection reconnects.
      * @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: TWSTopicSubscribeEventArgs[] | TWSTopicSubscribeEventArgs, isPrivateTopic?: boolean): void;
+    unsubscribe(wsTopics: WsTopicSubscribeEventArgs[] | WsTopicSubscribeEventArgs, isPrivateTopic?: boolean): void;
     /** Get the WsStore that tracks websockets & topics */
-    getWsStore(): WsStore<TWSKey, TWSTopicSubscribeEventArgs>;
-    close(wsKey: TWSKey, force?: boolean): void;
+    getWsStore(): typeof this.wsStore;
+    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>[];
     /**
      * Request connection to a specific websocket, instead of waiting for automatic connection.
      */
-    protected connect(wsKey: TWSKey): Promise<WebSocket | undefined>;
+    private connect;
     private parseWsError;
+    private getWsAuthSignature;
     /** Get a signature, build the auth request and send it */
     private sendAuthRequest;
     private reconnectWithDelay;
@@ -97,7 +95,7 @@ export declare abstract class BaseWebsocketClient<TWSKey extends string, TWSTopi
      * @private Use the `unsubscribe(topics)` method to unsubscribe from topics. Send WS message to unsubscribe from topics.
      */
     private requestUnsubscribeTopics;
-    tryWsSend(wsKey: TWSKey, wsMessage: string): void;
+    tryWsSend(wsKey: WsKey, wsMessage: string): void;
     private connectToWsUrl;
     private onWsOpen;
     /** Handle subscription to private topics _after_ authentication successfully completes asynchronously */
@@ -106,5 +104,24 @@ export declare abstract class BaseWebsocketClient<TWSKey extends string, TWSTopi
     private onWsClose;
     private getWs;
     private setWsState;
+    private getWsUrl;
+    /**
+     * Subscribe to a topic
+     * @param instType instrument type (refer to API docs).
+     * @param topic topic name (e.g. "ticker").
+     * @param instId instrument ID (e.g. "BTCUSDT"). Use "default" for private topics.
+     *
+     * @deprecated use WebsocketClientV2 instead
+     */
+    subscribeTopic(instType: BitgetInstType, topic: WsTopic, instId?: string): void;
+    /**
+     * Unsubscribe from a topic
+     * @param instType instrument type (refer to API docs).
+     * @param topic topic name (e.g. "ticker").
+     * @param instId instrument ID (e.g. "BTCUSDT"). Use "default" for private topics to get all symbols.
+     *
+     * @deprecated use WebsocketClientV2 instead
+     */
+    unsubscribeTopic(instType: BitgetInstType, topic: WsTopic, instId?: string): void;
 }
 export {};