bitget-api 2.3.6 → 3.0.0

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

@@ -0,0 +1,335 @@
+import { BaseWebsocketClient, } from './util/BaseWSClient.js';
+import { isWsPong } from './util/requestUtils.js';
+import { signMessage, } from './util/webCryptoAPI.js';
+import { getMaxTopicsPerSubscribeEvent, getNormalisedTopicRequests, getWsUrl, isPrivateChannel, WS_AUTH_ON_CONNECT_KEYS, WS_KEY_MAP, } from './util/websocket-util.js';
+const WS_LOGGER_CATEGORY = { category: 'bitget-ws' };
+const COIN_CHANNELS = [
+    'account',
+    'account-crossed',
+    'account-isolated',
+];
+export class WebsocketClientV2 extends BaseWebsocketClient {
+    /**
+     * Request connection of all dependent (public & private) websockets, instead of waiting for automatic connection by library
+     */
+    connectAll() {
+        return [
+            this.connect(WS_KEY_MAP.v2Private),
+            this.connect(WS_KEY_MAP.v2Public),
+        ];
+    }
+    /** Some private channels use `coin` instead of `instId`. This method handles building the sub/unsub request */
+    getSubRequest(instType, topic, coin = 'default') {
+        if (isPrivateChannel(topic)) {
+            if (COIN_CHANNELS.includes(topic)) {
+                const subscribeRequest = {
+                    topic,
+                    payload: {
+                        instType,
+                        coin,
+                    },
+                };
+                return subscribeRequest;
+            }
+            const subscribeRequest = {
+                topic,
+                payload: {
+                    instType,
+                    instId: coin,
+                },
+            };
+            return subscribeRequest;
+        }
+        const subscribeRequest = {
+            topic,
+            payload: {
+                instType,
+                instId: coin,
+            },
+        };
+        return subscribeRequest;
+    }
+    /**
+     * 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.
+     */
+    subscribeTopic(instType, topic, coin = 'default') {
+        const subRequest = this.getSubRequest(instType, topic, coin);
+        const isPrivateTopic = isPrivateChannel(topic);
+        const wsKey = isPrivateTopic ? WS_KEY_MAP.v2Private : WS_KEY_MAP.v2Public;
+        return this.subscribe(subRequest, wsKey);
+    }
+    /**
+     * 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.
+     */
+    unsubscribeTopic(instType, topic, coin = 'default') {
+        const subRequest = this.getSubRequest(instType, topic, coin);
+        const isPrivateTopic = isPrivateChannel(topic);
+        const wsKey = isPrivateTopic ? WS_KEY_MAP.v2Private : WS_KEY_MAP.v2Public;
+        return this.unsubscribe(subRequest, wsKey);
+    }
+    /**
+     * Request subscription to one or more topics. Pass topics as either an array of strings,
+     * or array of objects (if the topic has parameters).
+     *
+     * Objects should be formatted as {topic: string, params: object, category: CategoryV5}.
+     *
+     * - Subscriptions are automatically routed to the correct websocket connection.
+     * - Authentication/connection is automatic.
+     * - Resubscribe after network issues is automatic.
+     *
+     * Call `unsubscribe(topics)` to remove topics
+     */
+    subscribe(requests, wsKey) {
+        const topicRequests = Array.isArray(requests) ? requests : [requests];
+        const normalisedTopicRequests = getNormalisedTopicRequests(topicRequests);
+        return this.subscribeTopicsForWsKey(normalisedTopicRequests, wsKey);
+    }
+    /**
+     * Unsubscribe from one or more topics. Similar to subscribe() but in reverse.
+     *
+     * - Requests are automatically routed to the correct websocket connection.
+     * - These topics will be removed from the topic cache, so they won't be subscribed to again.
+     */
+    unsubscribe(requests, wsKey) {
+        const topicRequests = Array.isArray(requests) ? requests : [requests];
+        const normalisedTopicRequests = getNormalisedTopicRequests(topicRequests);
+        return this.unsubscribeTopicsForWsKey(normalisedTopicRequests, wsKey);
+    }
+    /**
+     *
+     *
+     * Internal methods required to integrate with the BaseWSClient
+     *
+     *
+     */
+    sendPingEvent(wsKey) {
+        this.tryWsSend(wsKey, 'ping');
+    }
+    sendPongEvent(wsKey) {
+        this.tryWsSend(wsKey, 'pong');
+    }
+    isWsPing(data) {
+        if (data?.data === 'ping') {
+            return true;
+        }
+        return false;
+    }
+    isWsPong(data) {
+        return isWsPong(data);
+    }
+    isPrivateTopicRequest(_request, wsKey) {
+        return WS_AUTH_ON_CONNECT_KEYS.includes(wsKey);
+    }
+    getPrivateWSKeys() {
+        return WS_AUTH_ON_CONNECT_KEYS;
+    }
+    isAuthOnConnectWsKey(wsKey) {
+        return WS_AUTH_ON_CONNECT_KEYS.includes(wsKey);
+    }
+    async getWsUrl(wsKey) {
+        return getWsUrl(wsKey, this.options, this.logger);
+    }
+    getMaxTopicsPerSubscribeEvent(wsKey) {
+        return getMaxTopicsPerSubscribeEvent(wsKey);
+    }
+    /**
+     * @returns one or more correctly structured request events for performing a operations over WS. This can vary per exchange spec.
+     */
+    async getWsRequestEvents(operation, requests) {
+        const wsRequestBuildingErrors = [];
+        const topics = requests.map((r) => r.topic + ',' + Object.values(r.payload || {}).join(','));
+        // Previously used to track topics in a request. Keeping this for subscribe/unsubscribe requests, no need for incremental values
+        const req_id = ['subscribe', 'unsubscribe'].includes(operation) && topics.length
+            ? topics.join(',')
+            : this.getNewRequestId().toFixed();
+        /**
+          {
+            "op":"subscribe",
+            "args":[
+                {
+                    "instType":"SPOT",
+                    "channel":"ticker",
+                    "instId":"BTCUSDT"
+                },
+                {
+                    "instType":"SPOT",
+                    "channel":"candle5m",
+                    "instId":"BTCUSDT"
+                }
+            ]
+          }
+        */
+        const wsEvent = {
+            op: operation,
+            args: requests.map((request) => {
+                // const request = {
+                //   topic: 'ticker',
+                //   payload: { instType: 'SPOT', instId: 'BTCUSDT' },
+                // };
+                // becomes:
+                // const request = {
+                //   channel: 'ticker',
+                //   instType: 'SPOT',
+                //   instId: 'BTCUSDT',
+                // };
+                return {
+                    channel: request.topic,
+                    ...request.payload,
+                };
+            }),
+        };
+        const midflightWsEvent = {
+            requestKey: req_id,
+            requestEvent: wsEvent,
+        };
+        if (wsRequestBuildingErrors.length) {
+            const label = wsRequestBuildingErrors.length === requests.length ? 'all' : 'some';
+            this.logger.error(`Failed to build/send ${wsRequestBuildingErrors.length} event(s) for ${label} WS requests due to exceptions`, {
+                ...WS_LOGGER_CATEGORY,
+                wsRequestBuildingErrors,
+                wsRequestBuildingErrorsStringified: JSON.stringify(wsRequestBuildingErrors, null, 2),
+            });
+        }
+        return [midflightWsEvent];
+    }
+    async getWsAuthSignature(wsKey) {
+        const { apiKey, apiSecret, apiPass, recvWindow } = this.options;
+        if (!apiKey || !apiSecret || !apiPass) {
+            this.logger.error('Cannot authenticate websocket, either api key, secret or passphrase missing.', { ...WS_LOGGER_CATEGORY, wsKey });
+            throw new Error('Cannot auth - missing api or secret or pass in config');
+        }
+        this.logger.trace("Getting auth'd request params", {
+            ...WS_LOGGER_CATEGORY,
+            wsKey,
+        });
+        const signatureExpiresAt = ((Date.now() + recvWindow) / 1000).toFixed(0);
+        const signature = await this.signMessage(signatureExpiresAt + 'GET' + '/user/verify', apiSecret, 'base64', 'SHA-256');
+        return {
+            expiresAt: +signatureExpiresAt,
+            signature,
+        };
+    }
+    async signMessage(paramsStr, secret, method, algorithm) {
+        if (typeof this.options.customSignMessageFn === 'function') {
+            return this.options.customSignMessageFn(paramsStr, secret);
+        }
+        return await signMessage(paramsStr, secret, method, algorithm);
+    }
+    async getWsAuthRequestEvent(wsKey) {
+        try {
+            const { apiKey, apiSecret, apiPass } = this.options;
+            const { signature, expiresAt } = await this.getWsAuthSignature(wsKey);
+            if (!apiKey || !apiSecret || !apiPass) {
+                this.logger.error('Cannot authenticate websocket, either api key, secret or passphrase missing.', { ...WS_LOGGER_CATEGORY, wsKey });
+                throw new Error('Cannot auth - missing api or secret or pass in config');
+            }
+            const request = {
+                op: 'login',
+                args: [
+                    {
+                        apiKey,
+                        passphrase: apiPass,
+                        timestamp: expiresAt,
+                        sign: signature,
+                    },
+                ],
+            };
+            return request;
+        }
+        catch (e) {
+            this.logger.error(e, { ...WS_LOGGER_CATEGORY, wsKey });
+            throw e;
+        }
+    }
+    /**
+     * Abstraction called to sort ws events into emittable event types (response to a request, data update, etc)
+     */
+    resolveEmittableEvents(wsKey, event) {
+        const results = [];
+        try {
+            const msg = JSON.parse(event.data);
+            const emittableEvent = { ...msg, wsKey };
+            // v2 event processing
+            if (typeof msg === 'object') {
+                if (typeof msg['code'] === 'number') {
+                    // v2 authentication event
+                    if (msg.event === 'login' && msg.code === 0) {
+                        results.push({
+                            eventType: 'response',
+                            event: emittableEvent,
+                        });
+                        results.push({
+                            eventType: 'authenticated',
+                            event: emittableEvent,
+                        });
+                        return results;
+                    }
+                }
+                if (msg['event']) {
+                    results.push({
+                        eventType: 'response',
+                        event: emittableEvent,
+                    });
+                    if (msg.event === 'error') {
+                        this.logger.error('WS Error received', {
+                            ...WS_LOGGER_CATEGORY,
+                            wsKey,
+                            message: msg || 'no message',
+                            // messageType: typeof msg,
+                            // messageString: JSON.stringify(msg),
+                            event,
+                        });
+                        results.push({
+                            eventType: 'exception',
+                            event: emittableEvent,
+                        });
+                    }
+                    return results;
+                }
+                if (msg['arg']) {
+                    results.push({
+                        eventType: 'update',
+                        event: emittableEvent,
+                    });
+                    return results;
+                }
+            }
+            this.logger.info('Unhandled/unrecognised ws event message', {
+                ...WS_LOGGER_CATEGORY,
+                message: msg || 'no message',
+                // messageType: typeof msg,
+                // messageString: JSON.stringify(msg),
+                event,
+                wsKey,
+            });
+            // fallback emit anyway
+            results.push({
+                eventType: 'update',
+                event: emittableEvent,
+            });
+            return results;
+        }
+        catch (e) {
+            this.logger.error('Failed to parse ws event message', {
+                ...WS_LOGGER_CATEGORY,
+                error: e,
+                event,
+                wsKey,
+            });
+        }
+        return results;
+    }
+    /**
+     * @deprecrated not supported by Bitget's V2 API offering
+     */
+    async sendWSAPIRequest() {
+        return;
+    }
+}
+//# sourceMappingURL=websocket-client-v2.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"websocket-client-v2.js","sourceRoot":"","sources":["../../src/websocket-client-v2.ts"],"names":[],"mappings":"AAWA,OAAO,EACL,mBAAmB,GAGpB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAClD,OAAO,EAGL,WAAW,GACZ,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,6BAA6B,EAC7B,0BAA0B,EAC1B,QAAQ,EACR,gBAAgB,EAChB,uBAAuB,EACvB,UAAU,GAEX,MAAM,0BAA0B,CAAC;AAGlC,MAAM,kBAAkB,GAAG,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;AAErD,MAAM,aAAa,GAAgB;IACjC,SAAS;IACT,iBAAiB;IACjB,kBAAkB;CACnB,CAAC;AAEF,MAAM,OAAO,iBAAkB,SAAQ,mBAGtC;IACC;;OAEG;IACI,UAAU;QACf,OAAO;YACL,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC;YAClC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC;SAClC,CAAC;IACJ,CAAC;IAED,+GAA+G;IACvG,aAAa,CACnB,QAA0B,EAC1B,KAAgB,EAChB,OAAe,SAAS;QAExB,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5B,IAAI,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBAClC,MAAM,gBAAgB,GAA2B;oBAC/C,KAAK;oBACL,OAAO,EAAE;wBACP,QAAQ;wBACR,IAAI;qBACL;iBACF,CAAC;gBACF,OAAO,gBAAgB,CAAC;YAC1B,CAAC;YAED,MAAM,gBAAgB,GAA2B;gBAC/C,KAAK;gBACL,OAAO,EAAE;oBACP,QAAQ;oBACR,MAAM,EAAE,IAAI;iBACb;aACF,CAAC;YAEF,OAAO,gBAAgB,CAAC;QAC1B,CAAC;QAED,MAAM,gBAAgB,GAA2B;YAC/C,KAAK;YACL,OAAO,EAAE;gBACP,QAAQ;gBACR,MAAM,EAAE,IAAI;aACb;SACF,CAAC;QACF,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAED;;;;;OAKG;IACI,cAAc,CACnB,QAA0B,EAC1B,KAAgB,EAChB,OAAe,SAAS;QAExB,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;QAC7D,MAAM,cAAc,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;QAC/C,MAAM,KAAK,GAAG,cAAc,CAAC,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC;QAE1E,OAAO,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACI,gBAAgB,CACrB,QAA0B,EAC1B,KAAgB,EAChB,OAAe,SAAS;QAExB,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;QAE7D,MAAM,cAAc,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;QAC/C,MAAM,KAAK,GAAG,cAAc,CAAC,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC;QAE1E,OAAO,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;;;;;;OAWG;IACI,SAAS,CACd,QAEsD,EACtD,KAAY;QAEZ,MAAM,aAAa,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;QACtE,MAAM,uBAAuB,GAAG,0BAA0B,CAAC,aAAa,CAAC,CAAC;QAC1E,OAAO,IAAI,CAAC,uBAAuB,CAAC,uBAAuB,EAAE,KAAK,CAAC,CAAC;IACtE,CAAC;IAED;;;;;OAKG;IACI,WAAW,CAChB,QAEsD,EACtD,KAAY;QAEZ,MAAM,aAAa,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;QACtE,MAAM,uBAAuB,GAAG,0BAA0B,CAAC,aAAa,CAAC,CAAC;QAE1E,OAAO,IAAI,CAAC,yBAAyB,CAAC,uBAAuB,EAAE,KAAK,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;OAMG;IAEO,aAAa,CAAC,KAAY;QAClC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAChC,CAAC;IAES,aAAa,CAAC,KAAY;QAClC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAChC,CAAC;IAES,QAAQ,CAAC,IAAS;QAC1B,IAAI,IAAI,EAAE,IAAI,KAAK,MAAM,EAAE,CAAC;YAC1B,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAES,QAAQ,CAAC,IAAS;QAC1B,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAES,qBAAqB,CAC7B,QAAgC,EAChC,KAAY;QAEZ,OAAO,uBAAuB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACjD,CAAC;IAES,gBAAgB;QACxB,OAAO,uBAAuB,CAAC;IACjC,CAAC;IAES,oBAAoB,CAAC,KAAY;QACzC,OAAO,uBAAuB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACjD,CAAC;IAES,KAAK,CAAC,QAAQ,CAAC,KAAY;QACnC,OAAO,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACpD,CAAC;IAES,6BAA6B,CAAC,KAAY;QAClD,OAAO,6BAA6B,CAAC,KAAK,CAAC,CAAC;IAC9C,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,kBAAkB,CAChC,SAAsB,EACtB,QAA0C;QAE1C,MAAM,uBAAuB,GAAc,EAAE,CAAC;QAE9C,MAAM,MAAM,GAAG,QAAQ,CAAC,GAAG,CACzB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAChE,CAAC;QAEF,gIAAgI;QAChI,MAAM,MAAM,GACV,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,MAAM,CAAC,MAAM;YAC/D,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;YAClB,CAAC,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC,OAAO,EAAE,CAAC;QAEvC;;;;;;;;;;;;;;;;UAgBE;QACF,MAAM,OAAO,GAAqC;YAChD,EAAE,EAAE,SAAS;YACb,IAAI,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;gBAC7B,oBAAoB;gBACpB,qBAAqB;gBACrB,sDAAsD;gBACtD,KAAK;gBACL,WAAW;gBACX,oBAAoB;gBACpB,uBAAuB;gBACvB,sBAAsB;gBACtB,uBAAuB;gBACvB,KAAK;gBACL,OAAO;oBACL,OAAO,EAAE,OAAO,CAAC,KAAK;oBACtB,GAAG,OAAO,CAAC,OAAO;iBACnB,CAAC;YACJ,CAAC,CAAC;SACH,CAAC;QAEF,MAAM,gBAAgB,GAElB;YACF,UAAU,EAAE,MAAM;YAClB,YAAY,EAAE,OAAO;SACtB,CAAC;QAEF,IAAI,uBAAuB,CAAC,MAAM,EAAE,CAAC;YACnC,MAAM,KAAK,GACT,uBAAuB,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC;YAEtE,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,wBAAwB,uBAAuB,CAAC,MAAM,iBAAiB,KAAK,gCAAgC,EAC5G;gBACE,GAAG,kBAAkB;gBACrB,uBAAuB;gBACvB,kCAAkC,EAAE,IAAI,CAAC,SAAS,CAChD,uBAAuB,EACvB,IAAI,EACJ,CAAC,CACF;aACF,CACF,CAAC;QACJ,CAAC;QAED,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC5B,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAC9B,KAAY;QAEZ,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QAEhE,IAAI,CAAC,MAAM,IAAI,CAAC,SAAS,IAAI,CAAC,OAAO,EAAE,CAAC;YACtC,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,8EAA8E,EAC9E,EAAE,GAAG,kBAAkB,EAAE,KAAK,EAAE,CACjC,CAAC;YACF,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;QAC3E,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,+BAA+B,EAAE;YACjD,GAAG,kBAAkB;YACrB,KAAK;SACN,CAAC,CAAC;QAEH,MAAM,kBAAkB,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAEzE,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,WAAW,CACtC,kBAAkB,GAAG,KAAK,GAAG,cAAc,EAC3C,SAAS,EACT,QAAQ,EACR,SAAS,CACV,CAAC;QAEF,OAAO;YACL,SAAS,EAAE,CAAC,kBAAkB;YAC9B,SAAS;SACV,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,WAAW,CACvB,SAAiB,EACjB,MAAc,EACd,MAAwB,EACxB,SAAwB;QAExB,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,mBAAmB,KAAK,UAAU,EAAE,CAAC;YAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAC7D,CAAC;QACD,OAAO,MAAM,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;IACjE,CAAC;IAES,KAAK,CAAC,qBAAqB,CACnC,KAAY;QAEZ,IAAI,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;YACpD,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAEtE,IAAI,CAAC,MAAM,IAAI,CAAC,SAAS,IAAI,CAAC,OAAO,EAAE,CAAC;gBACtC,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,8EAA8E,EAC9E,EAAE,GAAG,kBAAkB,EAAE,KAAK,EAAE,CACjC,CAAC;gBACF,MAAM,IAAI,KAAK,CACb,uDAAuD,CACxD,CAAC;YACJ,CAAC;YAED,MAAM,OAAO,GAAqD;gBAChE,EAAE,EAAE,OAAO;gBACX,IAAI,EAAE;oBACJ;wBACE,MAAM;wBACN,UAAU,EAAE,OAAO;wBACnB,SAAS,EAAE,SAAS;wBACpB,IAAI,EAAE,SAAS;qBAChB;iBACF;aACF,CAAC;YAEF,OAAO,OAAO,CAAC;QACjB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,GAAG,kBAAkB,EAAE,KAAK,EAAE,CAAC,CAAC;YACvD,MAAM,CAAC,CAAC;QACV,CAAC;IACH,CAAC;IAED;;OAEG;IACO,sBAAsB,CAC9B,KAAY,EACZ,KAAuB;QAEvB,MAAM,OAAO,GAAqB,EAAE,CAAC;QAErC,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACnC,MAAM,cAAc,GAAG,EAAE,GAAG,GAAG,EAAE,KAAK,EAAE,CAAC;YAEzC,sBAAsB;YACtB,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;gBAC5B,IAAI,OAAO,GAAG,CAAC,MAAM,CAAC,KAAK,QAAQ,EAAE,CAAC;oBACpC,0BAA0B;oBAC1B,IAAI,GAAG,CAAC,KAAK,KAAK,OAAO,IAAI,GAAG,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;wBAC5C,OAAO,CAAC,IAAI,CAAC;4BACX,SAAS,EAAE,UAAU;4BACrB,KAAK,EAAE,cAAc;yBACtB,CAAC,CAAC;wBACH,OAAO,CAAC,IAAI,CAAC;4BACX,SAAS,EAAE,eAAe;4BAC1B,KAAK,EAAE,cAAc;yBACtB,CAAC,CAAC;wBACH,OAAO,OAAO,CAAC;oBACjB,CAAC;gBACH,CAAC;gBAED,IAAI,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;oBACjB,OAAO,CAAC,IAAI,CAAC;wBACX,SAAS,EAAE,UAAU;wBACrB,KAAK,EAAE,cAAc;qBACtB,CAAC,CAAC;oBAEH,IAAI,GAAG,CAAC,KAAK,KAAK,OAAO,EAAE,CAAC;wBAC1B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,mBAAmB,EAAE;4BACrC,GAAG,kBAAkB;4BACrB,KAAK;4BACL,OAAO,EAAE,GAAG,IAAI,YAAY;4BAC5B,2BAA2B;4BAC3B,sCAAsC;4BACtC,KAAK;yBACN,CAAC,CAAC;wBACH,OAAO,CAAC,IAAI,CAAC;4BACX,SAAS,EAAE,WAAW;4BACtB,KAAK,EAAE,cAAc;yBACtB,CAAC,CAAC;oBACL,CAAC;oBAED,OAAO,OAAO,CAAC;gBACjB,CAAC;gBAED,IAAI,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;oBACf,OAAO,CAAC,IAAI,CAAC;wBACX,SAAS,EAAE,QAAQ;wBACnB,KAAK,EAAE,cAAc;qBACtB,CAAC,CAAC;oBACH,OAAO,OAAO,CAAC;gBACjB,CAAC;YACH,CAAC;YAED,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,yCAAyC,EAAE;gBAC1D,GAAG,kBAAkB;gBACrB,OAAO,EAAE,GAAG,IAAI,YAAY;gBAC5B,2BAA2B;gBAC3B,sCAAsC;gBACtC,KAAK;gBACL,KAAK;aACN,CAAC,CAAC;YAEH,uBAAuB;YACvB,OAAO,CAAC,IAAI,CAAC;gBACX,SAAS,EAAE,QAAQ;gBACnB,KAAK,EAAE,cAAc;aACtB,CAAC,CAAC;YACH,OAAO,OAAO,CAAC;QACjB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,kCAAkC,EAAE;gBACpD,GAAG,kBAAkB;gBACrB,KAAK,EAAE,CAAC;gBACR,KAAK;gBACL,KAAK;aACN,CAAC,CAAC;QACL,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,gBAAgB;QACpB,OAAO;IACT,CAAC;CACF"}

package/dist/mjs/websocket-client-v3.d.ts

@@ -0,0 +1,84 @@
+import { WsAPIOperationResponseMap, WSAPIRequestFlags, WsAPITopicRequestParamMap, WsAPIWsKeyTopicMap, WSOperation, WSOperationLoginParams, WsRequestOperationBitget } from './types/websockets/ws-api.js';
+import { MessageEventLike } from './types/websockets/ws-events.js';
+import { BitgetInstTypeV3, WsKey, WsTopicV3 } from './types/websockets/ws-general.js';
+import { BaseWebsocketClient, EmittableEvent, MidflightWsRequestEvent } from './util/BaseWSClient.js';
+import { WsTopicRequest } from './util/websocket-util.js';
+import { WSConnectedResult } from './util/WsStore.types.js';
+/**
+ * WebSocket client dedicated to the unified account (V3) WebSockets.
+ *
+ * Your Bitget account needs to be upgraded to unified account mode, to use the account-level WebSocket topics.
+ */
+export declare class WebsocketClientV3 extends BaseWebsocketClient<WsKey, WsRequestOperationBitget<object>> {
+    /**
+     * Request connection of all dependent (public & private) websockets, instead of waiting for automatic connection by library
+     */
+    connectAll(): Promise<WSConnectedResult | undefined>[];
+    /**
+     * Ensures the WS API connection is active and ready.
+     *
+     * You do not need to call this, but if you call this before making any WS API requests,
+     * it can accelerate the first request (by preparing the connection in advance).
+     */
+    connectWSAPI(): Promise<unknown>;
+    /**
+     * Request subscription to one or more topics. Pass topics as either an array of strings,
+     * or array of objects (if the topic has parameters).
+     *
+     * Objects should be formatted as {topic: string, params: object, category: CategoryV5}.
+     *
+     * - Subscriptions are automatically routed to the correct websocket connection.
+     * - Authentication/connection is automatic.
+     * - Resubscribe after network issues is automatic.
+     *
+     * Call `unsubscribe(topics)` to remove topics
+     */
+    subscribe<TWSPayload extends {
+        instType?: BitgetInstTypeV3;
+    }>(requests: (WsTopicRequest<WsTopicV3, TWSPayload> | WsTopicV3) | (WsTopicRequest<WsTopicV3, TWSPayload> | WsTopicV3)[], wsKey: WsKey): Promise<unknown>;
+    /**
+     * Unsubscribe from one or more topics. Similar to subscribe() but in reverse.
+     *
+     * - Requests are automatically routed to the correct websocket connection.
+     * - These topics will be removed from the topic cache, so they won't be subscribed to again.
+     */
+    unsubscribe<TWSPayload extends {
+        instType?: BitgetInstTypeV3;
+    }>(requests: (WsTopicRequest<WsTopicV3, TWSPayload> | WsTopicV3) | (WsTopicRequest<WsTopicV3, TWSPayload> | WsTopicV3)[], wsKey: WsKey): Promise<unknown>;
+    /**
+     *
+     *
+     * Internal methods required to integrate with the BaseWSClient
+     *
+     *
+     */
+    protected sendPingEvent(wsKey: WsKey): void;
+    protected sendPongEvent(wsKey: WsKey): void;
+    protected isWsPing(data: any): boolean;
+    protected isWsPong(data: any): boolean;
+    protected isPrivateTopicRequest(_request: WsTopicRequest<string>, wsKey: WsKey): boolean;
+    protected getPrivateWSKeys(): WsKey[];
+    protected isAuthOnConnectWsKey(wsKey: WsKey): boolean;
+    protected getWsUrl(wsKey: WsKey): Promise<string>;
+    protected getMaxTopicsPerSubscribeEvent(wsKey: WsKey): number | null;
+    /**
+     * @returns one or more correctly structured request events for performing a operations over WS. This can vary per exchange spec.
+     */
+    protected getWsRequestEvents(operation: WSOperation, requests: WsTopicRequest<string, object>[]): Promise<MidflightWsRequestEvent<WsRequestOperationBitget<object>>[]>;
+    private getWsAuthSignature;
+    private signMessage;
+    protected getWsAuthRequestEvent(wsKey: WsKey): Promise<WsRequestOperationBitget<WSOperationLoginParams>>;
+    /**
+     * Abstraction called to sort ws events into emittable event types (response to a request, data update, etc)
+     */
+    protected resolveEmittableEvents(wsKey: WsKey, event: MessageEventLike): EmittableEvent[];
+    /**
+     * V3/UTA supports order placement via WebSockets. This is the WS API:
+     * https://www.bitget.com/api-doc/uta/websocket/private/Place-Order-Channel
+     *
+     * @returns a promise that resolves/rejects when a matching response arrives
+     */
+    sendWSAPIRequest<TWSKey extends keyof WsAPIWsKeyTopicMap, TWSOperation extends WsAPIWsKeyTopicMap[TWSKey], TWSParams extends WsAPITopicRequestParamMap[TWSOperation], TWSAPIResponse extends WsAPIOperationResponseMap[TWSOperation] = WsAPIOperationResponseMap[TWSOperation]>(wsKey: WsKey, operation: TWSOperation, category: BitgetInstTypeV3, params: TWSParams & {
+        signRequest?: boolean;
+    }, requestFlags?: WSAPIRequestFlags): Promise<TWSAPIResponse>;
+}