bitget-api 2.3.6 → 3.0.0

package/{lib → dist/cjs}/util/type-guards.js

@@ -1,12 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.assertMarginType = exports.isWsFuturesPositionsSnapshotEvent = exports.isWsFuturesAccountSnapshotEvent = exports.isWsPositionsSnapshotEvent = exports.isWsAccountSnapshotEvent = void 0;
+exports.isWsAccountSnapshotEvent = isWsAccountSnapshotEvent;
+exports.isWsPositionsSnapshotEvent = isWsPositionsSnapshotEvent;
+exports.isWsFuturesAccountSnapshotEvent = isWsFuturesAccountSnapshotEvent;
+exports.isWsFuturesPositionsSnapshotEvent = isWsFuturesPositionsSnapshotEvent;
+exports.assertMarginType = assertMarginType;
+exports.isWSAPIResponse = isWSAPIResponse;
 /** TypeGuard: event has a string "action" property */
 function isWsEvent(event) {
     return (typeof event === 'object' &&
         event &&
-        typeof event['action'] === 'string' &&
-        event['data']);
+        (typeof event)['action'] === 'string' &&
+        (typeof event)['data']);
 }
 /** TypeGuard: event has "action === snapshot" */
 function isWsSnapshotEvent(event) {
@@ -15,8 +20,8 @@ function isWsSnapshotEvent(event) {
 /** TypeGuard: event has a string channel name */
 function isWsChannelEvent(event) {
     if (typeof event['arg'] === 'object' &&
-        event.arg &&
-        typeof (event === null || event === void 0 ? void 0 : event.arg['channel']) === 'string') {
+        event['arg'] &&
+        typeof (typeof event['arg'])['channel'] === 'string') {
         return true;
     }
     return false;
@@ -28,7 +33,6 @@ function isWsAccountSnapshotEvent(event) {
         event.arg.channel === 'account' &&
         Array.isArray(event.data));
 }
-exports.isWsAccountSnapshotEvent = isWsAccountSnapshotEvent;
 /** TypeGuard: event is a positions update */
 function isWsPositionsSnapshotEvent(event) {
     return (isWsSnapshotEvent(event) &&
@@ -36,17 +40,14 @@ function isWsPositionsSnapshotEvent(event) {
         event.arg.channel === 'positions' &&
         Array.isArray(event.data));
 }
-exports.isWsPositionsSnapshotEvent = isWsPositionsSnapshotEvent;
 /** TypeGuard: event is a UMCBL account update (balance) */
 function isWsFuturesAccountSnapshotEvent(event) {
     return isWsAccountSnapshotEvent(event) && event.arg.instType === 'umcbl';
 }
-exports.isWsFuturesAccountSnapshotEvent = isWsFuturesAccountSnapshotEvent;
 /** TypeGuard: event is a UMCBL positions update */
 function isWsFuturesPositionsSnapshotEvent(event) {
     return isWsPositionsSnapshotEvent(event) && event.arg.instType === 'umcbl';
 }
-exports.isWsFuturesPositionsSnapshotEvent = isWsFuturesPositionsSnapshotEvent;
 /**
  * Simple guard for non-TypeScript users, throw a runtime error if value doesn't match type
  */
@@ -56,5 +57,14 @@ function assertMarginType(marginType) {
     }
     return true;
 }
-exports.assertMarginType = assertMarginType;
+function isWSAPIResponse(msg) {
+    if (typeof msg !== 'object' || !msg) {
+        return false;
+    }
+    if (typeof msg['event'] !== 'string' ||
+        typeof msg['id'] !== 'string') {
+        return false;
+    }
+    return true;
+}
 //# sourceMappingURL=type-guards.js.map

package/dist/cjs/util/type-guards.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-guards.js","sourceRoot":"","sources":["../../../src/util/type-guards.ts"],"names":[],"mappings":";;AAuCA,4DASC;AAGD,gEASC;AAGD,0EAIC;AAGD,8EAIC;AAKD,4CAKC;AAED,0CAeC;AA1FD,sDAAsD;AACtD,SAAS,SAAS,CAAC,KAAc;IAC/B,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK;QACL,CAAC,OAAO,KAAa,CAAA,CAAC,QAAQ,CAAC,KAAK,QAAQ;QAC5C,CAAC,OAAO,KAAa,CAAA,CAAC,MAAM,CAAC,CAC9B,CAAC;AACJ,CAAC;AAED,iDAAiD;AACjD,SAAS,iBAAiB,CAAC,KAAc;IACvC,OAAO,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,KAAK,UAAU,CAAC;AACzD,CAAC;AAED,iDAAiD;AACjD,SAAS,gBAAgB,CAAC,KAAkB;IAC1C,IACE,OAAO,KAAK,CAAC,KAAK,CAAC,KAAK,QAAQ;QAChC,KAAK,CAAC,KAAK,CAAC;QACZ,OAAO,CAAC,OAAO,KAAK,CAAC,KAAK,CAAS,CAAA,CAAC,SAAS,CAAC,KAAK,QAAQ,EAC3D,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,sDAAsD;AACtD,SAAgB,wBAAwB,CACtC,KAAc;IAEd,OAAO,CACL,iBAAiB,CAAC,KAAK,CAAC;QACxB,gBAAgB,CAAC,KAAK,CAAC;QACvB,KAAK,CAAC,GAAG,CAAC,OAAO,KAAK,SAAS;QAC/B,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAC1B,CAAC;AACJ,CAAC;AAED,6CAA6C;AAC7C,SAAgB,0BAA0B,CACxC,KAAc;IAEd,OAAO,CACL,iBAAiB,CAAC,KAAK,CAAC;QACxB,gBAAgB,CAAC,KAAK,CAAC;QACvB,KAAK,CAAC,GAAG,CAAC,OAAO,KAAK,WAAW;QACjC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAC1B,CAAC;AACJ,CAAC;AAED,2DAA2D;AAC3D,SAAgB,+BAA+B,CAC7C,KAAc;IAEd,OAAO,wBAAwB,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,QAAQ,KAAK,OAAO,CAAC;AAC3E,CAAC;AAED,mDAAmD;AACnD,SAAgB,iCAAiC,CAC/C,KAAc;IAEd,OAAO,0BAA0B,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,QAAQ,KAAK,OAAO,CAAC;AAC7E,CAAC;AAED;;GAEG;AACH,SAAgB,gBAAgB,CAAC,UAAkB;IACjD,IAAI,UAAU,KAAK,UAAU,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC1D,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;IACrE,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAgB,eAAe,CAC7B,GAAY;IAEZ,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,GAAG,EAAE,CAAC;QACpC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IACE,OAAQ,GAAW,CAAC,OAAO,CAAC,KAAK,QAAQ;QACzC,OAAQ,GAAW,CAAC,IAAI,CAAC,KAAK,QAAQ,EACtC,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC"}

package/dist/cjs/util/webCryptoAPI.d.ts

@@ -0,0 +1,14 @@
+export type SignEncodeMethod = 'hex' | 'base64';
+export type SignAlgorithm = 'SHA-256' | 'SHA-512';
+/**
+ * Similar to node crypto's `createHash()` function
+ */
+type KeyType = 'HMAC' | 'RSASSA-PKCS1-v1_5' | 'Ed25519';
+export declare function getSignKeyType(secret: string): KeyType;
+/**
+ * Sign a message, with a secret, using the Web Crypto API
+ *
+ * Ed25519 is stable as of v23.5.0, but also not available in all browsers
+ */
+export declare function signMessage(message: string, secret: string, method: SignEncodeMethod, algorithm: SignAlgorithm, _pemEncodeMethod?: SignEncodeMethod): Promise<string>;
+export {};

package/dist/cjs/util/webCryptoAPI.js

@@ -0,0 +1,80 @@
+"use strict";
+/* eslint-disable @typescript-eslint/no-unused-vars */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSignKeyType = getSignKeyType;
+exports.signMessage = signMessage;
+const websocket_util_js_1 = require("./websocket-util.js");
+function bufferToB64(buffer) {
+    let binary = '';
+    const bytes = new Uint8Array(buffer);
+    const len = bytes.byteLength;
+    for (let i = 0; i < len; i++) {
+        binary += String.fromCharCode(bytes[i]);
+    }
+    return globalThis.btoa(binary);
+}
+function getSignKeyType(secret) {
+    if (secret.includes('PRIVATE KEY')) {
+        // Sometimes, not always, RSA keys include "RSA" in the header. That's a definite RSA key.
+        if (secret.includes('RSA PRIVATE KEY')) {
+            return 'RSASSA-PKCS1-v1_5';
+        }
+        // RSA keys are significantly longer than Ed25519 keys. 150 accounts for length of header & footer
+        if (secret.length <= 150) {
+            return 'Ed25519';
+        }
+        return 'RSASSA-PKCS1-v1_5';
+    }
+    return 'HMAC';
+}
+async function importKey(pem, type, algorithm, encoder) {
+    switch (type) {
+        case 'Ed25519':
+        case 'RSASSA-PKCS1-v1_5': {
+            // const prefixRSA = /-----BEGIN RSA PRIVATE KEY-----/;
+            // const prefixEd25519 = /-----BEGIN PRIVATE KEY-----/;
+            // const suffixRSA = /-----END RSA PRIVATE KEY-----/;
+            // const suffixEd25519 = /-----END PRIVATE KEY-----/;
+            // const base64Key = pem
+            //   .replace(prefixEd25519, '')
+            //   .replace(prefixRSA, '')
+            //   .replace(suffixEd25519, '')
+            //   .replace(suffixRSA, '')
+            //   .replace(/\s+/g, ''); // Remove spaces and newlines
+            const base64Key = pem.replace(/(?:-----BEGIN RSA PRIVATE KEY-----|-----BEGIN PRIVATE KEY-----|-----END RSA PRIVATE KEY-----|-----END PRIVATE KEY-----|\s+)/g, '');
+            const binaryKey = Uint8Array.from(atob(base64Key), (c) => c.charCodeAt(0));
+            return globalThis.crypto.subtle.importKey('pkcs8', binaryKey.buffer, { name: type, hash: { name: algorithm } }, false, ['sign']);
+        }
+        case 'HMAC': {
+            return globalThis.crypto.subtle.importKey('raw', encoder.encode(pem), { name: type, hash: algorithm }, false, ['sign']);
+        }
+        default: {
+            throw (0, websocket_util_js_1.neverGuard)(type, `Unhandled key type: "${type}"`);
+        }
+    }
+}
+/**
+ * Sign a message, with a secret, using the Web Crypto API
+ *
+ * Ed25519 is stable as of v23.5.0, but also not available in all browsers
+ */
+async function signMessage(message, secret, method, algorithm, _pemEncodeMethod = method) {
+    const encoder = new TextEncoder();
+    const signKeyType = getSignKeyType(secret);
+    const key = await importKey(secret, signKeyType, algorithm, encoder);
+    const buffer = await globalThis.crypto.subtle.sign({ name: signKeyType }, key, encoder.encode(message));
+    switch (method) {
+        case 'hex': {
+            return Array.from(new Uint8Array(buffer))
+                .map((byte) => byte.toString(16).padStart(2, '0'))
+                .join('');
+        }
+        case 'base64': {
+            return bufferToB64(buffer);
+        }
+        default: {
+            throw (0, websocket_util_js_1.neverGuard)(method, `Unhandled sign method: "${method}"`);
+        }
+    }
+}
+//# sourceMappingURL=webCryptoAPI.js.map

package/dist/cjs/util/webCryptoAPI.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webCryptoAPI.js","sourceRoot":"","sources":["../../../src/util/webCryptoAPI.ts"],"names":[],"mappings":";AAAA,sDAAsD;;AAiDtD,wCAeC;AA6DD,kCAgCC;AA3JD,2DAAiD;AAEjD,SAAS,WAAW,CAAC,MAAmB;IACtC,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;IACrC,MAAM,GAAG,GAAG,KAAK,CAAC,UAAU,CAAC;IAC7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC7B,MAAM,IAAI,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1C,CAAC;IACD,OAAO,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AACjC,CAAC;AAqCD,SAAgB,cAAc,CAAC,MAAc;IAC3C,IAAI,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;QACnC,0FAA0F;QAC1F,IAAI,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,CAAC;YACvC,OAAO,mBAAmB,CAAC;QAC7B,CAAC;QAED,kGAAkG;QAClG,IAAI,MAAM,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;YACzB,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,mBAAmB,CAAC;IAC7B,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,KAAK,UAAU,SAAS,CACtB,GAAW,EACX,IAAa,EACb,SAAwB,EACxB,OAAoB;IAEpB,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,SAAS,CAAC;QACf,KAAK,mBAAmB,CAAC,CAAC,CAAC;YACzB,uDAAuD;YACvD,uDAAuD;YAEvD,qDAAqD;YACrD,qDAAqD;YAErD,wBAAwB;YACxB,gCAAgC;YAChC,4BAA4B;YAC5B,gCAAgC;YAChC,4BAA4B;YAC5B,wDAAwD;YAExD,MAAM,SAAS,GAAG,GAAG,CAAC,OAAO,CAC3B,8HAA8H,EAC9H,EAAE,CACH,CAAC;YAEF,MAAM,SAAS,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CACvD,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAChB,CAAC;YAEF,OAAO,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,CACvC,OAAO,EACP,SAAS,CAAC,MAAM,EAChB,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EACzC,KAAK,EACL,CAAC,MAAM,CAAC,CACT,CAAC;QACJ,CAAC;QACD,KAAK,MAAM,CAAC,CAAC,CAAC;YACZ,OAAO,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,CACvC,KAAK,EACL,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,EACnB,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,EAC/B,KAAK,EACL,CAAC,MAAM,CAAC,CACT,CAAC;QACJ,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,IAAA,8BAAU,EAAC,IAAI,EAAE,wBAAwB,IAAI,GAAG,CAAC,CAAC;QAC1D,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,WAAW,CAC/B,OAAe,EACf,MAAc,EACd,MAAwB,EACxB,SAAwB,EACxB,mBAAqC,MAAM;IAE3C,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;IAElC,MAAM,WAAW,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;IAE3C,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IAErE,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAChD,EAAE,IAAI,EAAE,WAAW,EAAE,EACrB,GAAG,EACH,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CACxB,CAAC;IAEF,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,KAAK,CAAC,CAAC,CAAC;YACX,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;iBACtC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;iBACjD,IAAI,CAAC,EAAE,CAAC,CAAC;QACd,CAAC;QACD,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,OAAO,WAAW,CAAC,MAAM,CAAC,CAAC;QAC7B,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,IAAA,8BAAU,EAAC,MAAM,EAAE,2BAA2B,MAAM,GAAG,CAAC,CAAC;QACjE,CAAC;IACH,CAAC;AACH,CAAC"}

package/dist/cjs/util/websocket-util.d.ts

@@ -0,0 +1,88 @@
+import { WSAPIRequestBitgetV3 } from '../types/websockets/ws-api.js';
+import { WebsocketClientOptions, WsKey, WsPrivateTopicV2, WsPrivateTopicV3, WsTopicSubscribeEventArgs, WsTopicSubscribePublicArgsV2 } from '../types/websockets/ws-general.js';
+import { DefaultLogger } from './logger.js';
+export declare const WS_LOGGER_CATEGORY: {
+    category: string;
+};
+/**
+ * Some exchanges have two livenet environments, some have test environments, some dont. This allows easy flexibility for different exchanges.
+ * Examples:
+ *  - One livenet and one testnet: NetworkMap<'livenet' | 'testnet'>
+ *  - One livenet, sometimes two, one testnet: NetworkMap<'livenet' | 'testnet', 'livenet2'>
+ *  - Only one livenet, no other networks: NetworkMap<'livenet'>
+ */
+type NetworkMap<TRequiredKeys extends string, TOptionalKeys extends string | undefined = undefined> = Record<TRequiredKeys, string> & (TOptionalKeys extends string ? Record<TOptionalKeys, string | undefined> : Record<TRequiredKeys, string>);
+export declare const WS_BASE_URL_MAP: Record<WsKey, Record<'all', NetworkMap<'livenet' | 'demo'>>>;
+/** Should be one WS key per unique URL */
+export declare const WS_KEY_MAP: {
+    readonly spotv1: "spotv1";
+    readonly mixv1: "mixv1";
+    readonly v2Public: "v2Public";
+    readonly v2Private: "v2Private";
+    readonly v3Public: "v3Public";
+    readonly v3Private: "v3Private";
+};
+/** Any WS keys in this list will trigger auth on connect, if credentials are available */
+export declare const WS_AUTH_ON_CONNECT_KEYS: WsKey[];
+/** Any WS keys in this list will ALWAYS skip the authentication process, even if credentials are available */
+export declare const PUBLIC_WS_KEYS: WsKey[];
+/**
+ * Used to automatically determine if a sub request should be to a public or private ws (when there's two separate connections).
+ * Unnecessary if there's only one connection to handle both public & private topics.
+ */
+export declare const PRIVATE_TOPICS: string[];
+export declare const PRIVATE_TOPICS_V2: WsPrivateTopicV2[];
+export declare const PRIVATE_TOPICS_V3: WsPrivateTopicV3[];
+export declare function getWsUrl(wsKey: WsKey, options: WebsocketClientOptions, logger: DefaultLogger): Promise<string>;
+/**
+ * Normalised internal format for a request (subscribe/unsubscribe/etc) on a topic, with optional parameters.
+ *
+ * - Topic: the topic this event is for
+ * - Payload: the parameters to include, optional. E.g. auth requires key + sign. Some topics allow configurable parameters.
+ * - Category: required for bybit, since different categories have different public endpoints
+ */
+export interface WsTopicRequest<TWSTopic extends string = string, TWSPayload = unknown> {
+    topic: TWSTopic;
+    payload?: TWSPayload;
+}
+/**
+ * Conveniently allow users to request a topic either as string topics or objects (containing string topic + params)
+ */
+export type WsTopicRequestOrStringTopic<TWSTopic extends string, TWSPayload = unknown> = WsTopicRequest<TWSTopic, TWSPayload> | string;
+export declare function isPrivateChannel<TChannel extends string>(channel: TChannel): boolean;
+export declare function getWsKeyForTopicV1(subscribeEvent: WsTopicSubscribeEventArgs, _isPrivate?: boolean): WsKey;
+export declare function getWsKeyForTopicV2(subscribeEvent: WsTopicSubscribePublicArgsV2, isPrivate?: boolean): WsKey;
+/** Force subscription requests to be sent in smaller batches, if a number is returned */
+export declare function getMaxTopicsPerSubscribeEvent(wsKey: WsKey): number | null;
+export declare const WS_ERROR_ENUM: {
+    INVALID_ACCESS_KEY: number;
+};
+export declare function neverGuard(x: never, msg: string): Error;
+/**
+ * #305: ws.terminate() is undefined in browsers.
+ * This only works in node.js, not in browsers.
+ * Does nothing if `ws` is undefined. Does nothing in browsers.
+ */
+export declare function safeTerminateWs(ws?: WebSocket | any, fallbackToClose?: boolean): boolean;
+/**
+ * Users can conveniently pass topics as strings or objects (object has topic name + optional params).
+ *
+ * This method normalises topics into objects (object has topic name + optional params).
+ */
+export declare function getNormalisedTopicRequests(wsTopicRequests: WsTopicRequestOrStringTopic<string>[]): WsTopicRequest<string>[];
+/**
+ * WebSocket.ping() is not available in browsers. This is a simple check used to
+ * disable heartbeats in browers, for exchanges that use native WebSocket ping/pong frames.
+ */
+export declare function isWSPingFrameAvailable(): boolean;
+/**
+ * WebSocket.pong() is not available in browsers. This is a simple check used to
+ * disable heartbeats in browers, for exchanges that use native WebSocket ping/pong frames.
+ */
+export declare function isWSPongFrameAvailable(): boolean;
+/**
+ * WS API promises are stored using a primary key. This key is constructed using
+ * properties found in every request & reply.
+ */
+export declare function getPromiseRefForWSAPIRequest(requestEvent: WSAPIRequestBitgetV3<unknown>): string;
+export {};

package/dist/cjs/util/websocket-util.js

@@ -0,0 +1,241 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WS_ERROR_ENUM = exports.PRIVATE_TOPICS_V3 = exports.PRIVATE_TOPICS_V2 = exports.PRIVATE_TOPICS = exports.PUBLIC_WS_KEYS = exports.WS_AUTH_ON_CONNECT_KEYS = exports.WS_KEY_MAP = exports.WS_BASE_URL_MAP = exports.WS_LOGGER_CATEGORY = void 0;
+exports.getWsUrl = getWsUrl;
+exports.isPrivateChannel = isPrivateChannel;
+exports.getWsKeyForTopicV1 = getWsKeyForTopicV1;
+exports.getWsKeyForTopicV2 = getWsKeyForTopicV2;
+exports.getMaxTopicsPerSubscribeEvent = getMaxTopicsPerSubscribeEvent;
+exports.neverGuard = neverGuard;
+exports.safeTerminateWs = safeTerminateWs;
+exports.getNormalisedTopicRequests = getNormalisedTopicRequests;
+exports.isWSPingFrameAvailable = isWSPingFrameAvailable;
+exports.isWSPongFrameAvailable = isWSPongFrameAvailable;
+exports.getPromiseRefForWSAPIRequest = getPromiseRefForWSAPIRequest;
+exports.WS_LOGGER_CATEGORY = { category: 'bitget-ws' };
+exports.WS_BASE_URL_MAP = {
+    mixv1: {
+        all: {
+            livenet: 'wss://ws.bitget.com/mix/v1/stream',
+            demo: 'NotSupportedForV1',
+        },
+    },
+    spotv1: {
+        all: {
+            livenet: 'wss://ws.bitget.com/spot/v1/stream',
+            demo: 'NotSupportedForV1',
+        },
+    },
+    v2Public: {
+        all: {
+            livenet: 'wss://ws.bitget.com/v2/ws/public',
+            demo: 'wss://wspap.bitget.com/v2/ws/public',
+        },
+    },
+    v2Private: {
+        all: {
+            livenet: 'wss://ws.bitget.com/v2/ws/private',
+            demo: 'wss://wspap.bitget.com/v2/ws/private',
+        },
+    },
+    v3Public: {
+        all: {
+            livenet: 'wss://ws.bitget.com/v3/ws/public',
+            demo: 'wss://wspap.bitget.com/v3/ws/public',
+        },
+    },
+    v3Private: {
+        all: {
+            livenet: 'wss://ws.bitget.com/v3/ws/private',
+            demo: 'wss://wspap.bitget.com/v3/ws/private',
+        },
+    },
+};
+/** Should be one WS key per unique URL */
+exports.WS_KEY_MAP = {
+    spotv1: 'spotv1',
+    mixv1: 'mixv1',
+    v2Public: 'v2Public',
+    v2Private: 'v2Private',
+    v3Public: 'v3Public',
+    v3Private: 'v3Private',
+};
+/** Any WS keys in this list will trigger auth on connect, if credentials are available */
+exports.WS_AUTH_ON_CONNECT_KEYS = [
+    exports.WS_KEY_MAP.spotv1,
+    exports.WS_KEY_MAP.mixv1,
+    exports.WS_KEY_MAP.v2Private,
+    exports.WS_KEY_MAP.v3Private,
+];
+/** Any WS keys in this list will ALWAYS skip the authentication process, even if credentials are available */
+exports.PUBLIC_WS_KEYS = [];
+/**
+ * Used to automatically determine if a sub request should be to a public or private ws (when there's two separate connections).
+ * Unnecessary if there's only one connection to handle both public & private topics.
+ */
+exports.PRIVATE_TOPICS = ['account', 'orders', 'positions', 'ordersAlgo'];
+exports.PRIVATE_TOPICS_V2 = [
+    'account',
+    'orders',
+    'positions',
+    'orders-algo',
+    'positions-history',
+    'orders-crossed',
+    'account-crossed',
+    'account-isolated',
+    'orders-isolated',
+];
+exports.PRIVATE_TOPICS_V3 = [
+    'account',
+    'position',
+    'fill',
+    'order',
+];
+async function getWsUrl(wsKey, options, logger) {
+    if (options.wsUrl) {
+        return options.wsUrl;
+    }
+    const isDemoTrading = options.demoTrading;
+    const networkKey = isDemoTrading ? 'demo' : 'livenet';
+    switch (wsKey) {
+        case exports.WS_KEY_MAP.spotv1:
+        case exports.WS_KEY_MAP.mixv1: {
+            throw new Error('Use the WebsocketClient instead of WebsocketClientV2 for V1 websockets');
+        }
+        case exports.WS_KEY_MAP.v2Private: {
+            return exports.WS_BASE_URL_MAP.v2Private.all[networkKey];
+        }
+        case exports.WS_KEY_MAP.v2Public: {
+            return exports.WS_BASE_URL_MAP.v2Public.all[networkKey];
+        }
+        case exports.WS_KEY_MAP.v3Private: {
+            return exports.WS_BASE_URL_MAP.v3Private.all[networkKey];
+        }
+        case exports.WS_KEY_MAP.v3Public: {
+            return exports.WS_BASE_URL_MAP.v3Public.all[networkKey];
+        }
+        default: {
+            logger.error('getWsUrl(): Unhandled wsKey: ', {
+                ...exports.WS_LOGGER_CATEGORY,
+                wsKey,
+            });
+            throw neverGuard(wsKey, 'getWsUrl(): Unhandled wsKey');
+        }
+    }
+}
+function isPrivateChannel(channel) {
+    return (exports.PRIVATE_TOPICS.includes(channel) ||
+        exports.PRIVATE_TOPICS_V2.includes(channel) ||
+        exports.PRIVATE_TOPICS_V3.includes(channel));
+}
+function getWsKeyForTopicV1(subscribeEvent, 
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+_isPrivate) {
+    const instType = subscribeEvent.instType.toUpperCase();
+    switch (instType) {
+        case 'SP':
+        case 'SPBL': {
+            return exports.WS_KEY_MAP.spotv1;
+        }
+        case 'MC':
+        case 'UMCBL':
+        case 'DMCBL': {
+            return exports.WS_KEY_MAP.mixv1;
+        }
+        default: {
+            throw neverGuard(instType, `getWsKeyForTopicV1(): Unhandled market ${'instrumentId'}`);
+        }
+    }
+}
+function getWsKeyForTopicV2(subscribeEvent, isPrivate) {
+    return isPrivate || isPrivateChannel(subscribeEvent.channel)
+        ? exports.WS_KEY_MAP.v2Private
+        : exports.WS_KEY_MAP.v2Public;
+}
+/** Force subscription requests to be sent in smaller batches, if a number is returned */
+function getMaxTopicsPerSubscribeEvent(wsKey) {
+    switch (wsKey) {
+        case 'mixv1':
+        case 'spotv1':
+        case 'v2Public':
+        case 'v2Private':
+        case 'v3Public':
+        case 'v3Private': {
+            // Technically there doesn't seem to be a documented cap, but there is a size limit per request. Doesn't hurt to batch requests.
+            return 15;
+        }
+        default: {
+            throw neverGuard(wsKey, 'getWsKeyForTopic(): Unhandled wsKey');
+        }
+    }
+}
+exports.WS_ERROR_ENUM = {
+    INVALID_ACCESS_KEY: 30011,
+};
+function neverGuard(x, msg) {
+    return new Error(`Unhandled value exception "${x}", ${msg}`);
+}
+/**
+ * #305: ws.terminate() is undefined in browsers.
+ * This only works in node.js, not in browsers.
+ * Does nothing if `ws` is undefined. Does nothing in browsers.
+ */
+function safeTerminateWs(ws, fallbackToClose) {
+    if (!ws) {
+        return false;
+    }
+    if (typeof ws['terminate'] === 'function') {
+        ws.terminate();
+        return true;
+    }
+    else if (fallbackToClose) {
+        ws.close();
+    }
+    return false;
+}
+/**
+ * Users can conveniently pass topics as strings or objects (object has topic name + optional params).
+ *
+ * This method normalises topics into objects (object has topic name + optional params).
+ */
+function getNormalisedTopicRequests(wsTopicRequests) {
+    const normalisedTopicRequests = [];
+    for (const wsTopicRequest of wsTopicRequests) {
+        // passed as string, convert to object
+        if (typeof wsTopicRequest === 'string') {
+            const topicRequest = {
+                topic: wsTopicRequest,
+                payload: undefined,
+            };
+            normalisedTopicRequests.push(topicRequest);
+            continue;
+        }
+        // already a normalised object, thanks to user
+        normalisedTopicRequests.push(wsTopicRequest);
+    }
+    return normalisedTopicRequests;
+}
+/**
+ * WebSocket.ping() is not available in browsers. This is a simple check used to
+ * disable heartbeats in browers, for exchanges that use native WebSocket ping/pong frames.
+ */
+function isWSPingFrameAvailable() {
+    return typeof WebSocket.prototype['ping'] === 'function';
+}
+/**
+ * WebSocket.pong() is not available in browsers. This is a simple check used to
+ * disable heartbeats in browers, for exchanges that use native WebSocket ping/pong frames.
+ */
+function isWSPongFrameAvailable() {
+    return typeof WebSocket.prototype['pong'] === 'function';
+}
+/**
+ * WS API promises are stored using a primary key. This key is constructed using
+ * properties found in every request & reply.
+ */
+function getPromiseRefForWSAPIRequest(requestEvent) {
+    // Responses don't have any other info we can use to connect them to the request. Just the "id" field...
+    const promiseRef = [requestEvent.id].join('_');
+    return promiseRef;
+}
+//# sourceMappingURL=websocket-util.js.map

package/dist/cjs/util/websocket-util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket-util.js","sourceRoot":"","sources":["../../../src/util/websocket-util.ts"],"names":[],"mappings":";;;AAqHA,4BAuCC;AAyBD,4CAQC;AAED,gDAuBC;AAED,gDAOC;AAGD,sEAeC;AAMD,gCAEC;AAOD,0CAeC;AAMD,gEAoBC;AAMD,wDAEC;AAMD,wDAEC;AAMD,oEAMC;AAzTY,QAAA,kBAAkB,GAAG,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;AAiB/C,QAAA,eAAe,GAGxB;IACF,KAAK,EAAE;QACL,GAAG,EAAE;YACH,OAAO,EAAE,mCAAmC;YAC5C,IAAI,EAAE,mBAAmB;SAC1B;KACF;IACD,MAAM,EAAE;QACN,GAAG,EAAE;YACH,OAAO,EAAE,oCAAoC;YAC7C,IAAI,EAAE,mBAAmB;SAC1B;KACF;IACD,QAAQ,EAAE;QACR,GAAG,EAAE;YACH,OAAO,EAAE,kCAAkC;YAC3C,IAAI,EAAE,qCAAqC;SAC5C;KACF;IACD,SAAS,EAAE;QACT,GAAG,EAAE;YACH,OAAO,EAAE,mCAAmC;YAC5C,IAAI,EAAE,sCAAsC;SAC7C;KACF;IACD,QAAQ,EAAE;QACR,GAAG,EAAE;YACH,OAAO,EAAE,kCAAkC;YAC3C,IAAI,EAAE,qCAAqC;SAC5C;KACF;IACD,SAAS,EAAE;QACT,GAAG,EAAE;YACH,OAAO,EAAE,mCAAmC;YAC5C,IAAI,EAAE,sCAAsC;SAC7C;KACF;CACF,CAAC;AAEF,0CAA0C;AAC7B,QAAA,UAAU,GAAG;IACxB,MAAM,EAAE,QAAQ;IAChB,KAAK,EAAE,OAAO;IACd,QAAQ,EAAE,UAAU;IACpB,SAAS,EAAE,WAAW;IACtB,QAAQ,EAAE,UAAU;IACpB,SAAS,EAAE,WAAW;CACd,CAAC;AAEX,0FAA0F;AAC7E,QAAA,uBAAuB,GAAY;IAC9C,kBAAU,CAAC,MAAM;IACjB,kBAAU,CAAC,KAAK;IAChB,kBAAU,CAAC,SAAS;IACpB,kBAAU,CAAC,SAAS;CACrB,CAAC;AAEF,8GAA8G;AACjG,QAAA,cAAc,GAAG,EAAa,CAAC;AAE5C;;;GAGG;AACU,QAAA,cAAc,GAAG,CAAC,SAAS,EAAE,QAAQ,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC;AAElE,QAAA,iBAAiB,GAAuB;IACnD,SAAS;IACT,QAAQ;IACR,WAAW;IACX,aAAa;IACb,mBAAmB;IACnB,gBAAgB;IAChB,iBAAiB;IACjB,kBAAkB;IAClB,iBAAiB;CAClB,CAAC;AAEW,QAAA,iBAAiB,GAAuB;IACnD,SAAS;IACT,UAAU;IACV,MAAM;IACN,OAAO;CACR,CAAC;AAEK,KAAK,UAAU,QAAQ,CAC5B,KAAY,EACZ,OAA+B,EAC/B,MAAqB;IAErB,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;QAClB,OAAO,OAAO,CAAC,KAAK,CAAC;IACvB,CAAC;IAED,MAAM,aAAa,GAAG,OAAO,CAAC,WAAW,CAAC;IAC1C,MAAM,UAAU,GAAuB,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;IAE1E,QAAQ,KAAK,EAAE,CAAC;QACd,KAAK,kBAAU,CAAC,MAAM,CAAC;QACvB,KAAK,kBAAU,CAAC,KAAK,CAAC,CAAC,CAAC;YACtB,MAAM,IAAI,KAAK,CACb,wEAAwE,CACzE,CAAC;QACJ,CAAC;QACD,KAAK,kBAAU,CAAC,SAAS,CAAC,CAAC,CAAC;YAC1B,OAAO,uBAAe,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACnD,CAAC;QACD,KAAK,kBAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;YACzB,OAAO,uBAAe,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAClD,CAAC;QACD,KAAK,kBAAU,CAAC,SAAS,CAAC,CAAC,CAAC;YAC1B,OAAO,uBAAe,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACnD,CAAC;QACD,KAAK,kBAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;YACzB,OAAO,uBAAe,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAClD,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,CAAC,KAAK,CAAC,+BAA+B,EAAE;gBAC5C,GAAG,0BAAkB;gBACrB,KAAK;aACN,CAAC,CAAC;YACH,MAAM,UAAU,CAAC,KAAK,EAAE,6BAA6B,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;AACH,CAAC;AAyBD,SAAgB,gBAAgB,CAC9B,OAAiB;IAEjB,OAAO,CACL,sBAAc,CAAC,QAAQ,CAAC,OAAO,CAAC;QAChC,yBAAiB,CAAC,QAAQ,CAAC,OAAc,CAAC;QAC1C,yBAAiB,CAAC,QAAQ,CAAC,OAAc,CAAC,CAC3C,CAAC;AACJ,CAAC;AAED,SAAgB,kBAAkB,CAChC,cAAyC;AACzC,6DAA6D;AAC7D,UAAoB;IAEpB,MAAM,QAAQ,GAAG,cAAc,CAAC,QAAQ,CAAC,WAAW,EAAoB,CAAC;IACzE,QAAQ,QAAQ,EAAE,CAAC;QACjB,KAAK,IAAI,CAAC;QACV,KAAK,MAAM,CAAC,CAAC,CAAC;YACZ,OAAO,kBAAU,CAAC,MAAM,CAAC;QAC3B,CAAC;QACD,KAAK,IAAI,CAAC;QACV,KAAK,OAAO,CAAC;QACb,KAAK,OAAO,CAAC,CAAC,CAAC;YACb,OAAO,kBAAU,CAAC,KAAK,CAAC;QAC1B,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,UAAU,CACd,QAAQ,EACR,0CAA0C,cAAc,EAAE,CAC3D,CAAC;QACJ,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAgB,kBAAkB,CAChC,cAA4C,EAC5C,SAAmB;IAEnB,OAAO,SAAS,IAAI,gBAAgB,CAAC,cAAc,CAAC,OAAO,CAAC;QAC1D,CAAC,CAAC,kBAAU,CAAC,SAAS;QACtB,CAAC,CAAC,kBAAU,CAAC,QAAQ,CAAC;AAC1B,CAAC;AAED,yFAAyF;AACzF,SAAgB,6BAA6B,CAAC,KAAY;IACxD,QAAQ,KAAK,EAAE,CAAC;QACd,KAAK,OAAO,CAAC;QACb,KAAK,QAAQ,CAAC;QACd,KAAK,UAAU,CAAC;QAChB,KAAK,WAAW,CAAC;QACjB,KAAK,UAAU,CAAC;QAChB,KAAK,WAAW,CAAC,CAAC,CAAC;YACjB,gIAAgI;YAChI,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,UAAU,CAAC,KAAK,EAAE,qCAAqC,CAAC,CAAC;QACjE,CAAC;IACH,CAAC;AACH,CAAC;AAEY,QAAA,aAAa,GAAG;IAC3B,kBAAkB,EAAE,KAAK;CAC1B,CAAC;AAEF,SAAgB,UAAU,CAAC,CAAQ,EAAE,GAAW;IAC9C,OAAO,IAAI,KAAK,CAAC,8BAA8B,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;AAC/D,CAAC;AAED;;;;GAIG;AACH,SAAgB,eAAe,CAC7B,EAAoB,EACpB,eAAyB;IAEzB,IAAI,CAAC,EAAE,EAAE,CAAC;QACR,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,OAAO,EAAE,CAAC,WAAW,CAAC,KAAK,UAAU,EAAE,CAAC;QAC1C,EAAE,CAAC,SAAS,EAAE,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;SAAM,IAAI,eAAe,EAAE,CAAC;QAC3B,EAAE,CAAC,KAAK,EAAE,CAAC;IACb,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AACD;;;;GAIG;AACH,SAAgB,0BAA0B,CACxC,eAAsD;IAEtD,MAAM,uBAAuB,GAA6B,EAAE,CAAC;IAE7D,KAAK,MAAM,cAAc,IAAI,eAAe,EAAE,CAAC;QAC7C,sCAAsC;QACtC,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;YACvC,MAAM,YAAY,GAA2B;gBAC3C,KAAK,EAAE,cAAc;gBACrB,OAAO,EAAE,SAAS;aACnB,CAAC;YACF,uBAAuB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAC3C,SAAS;QACX,CAAC;QAED,8CAA8C;QAC9C,uBAAuB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC/C,CAAC;IACD,OAAO,uBAAuB,CAAC;AACjC,CAAC;AAED;;;GAGG;AACH,SAAgB,sBAAsB;IACpC,OAAO,OAAQ,SAAS,CAAC,SAAiB,CAAC,MAAM,CAAC,KAAK,UAAU,CAAC;AACpE,CAAC;AAED;;;GAGG;AACH,SAAgB,sBAAsB;IACpC,OAAO,OAAQ,SAAS,CAAC,SAAiB,CAAC,MAAM,CAAC,KAAK,UAAU,CAAC;AACpE,CAAC;AAED;;;GAGG;AACH,SAAgB,4BAA4B,CAC1C,YAA2C;IAE3C,wGAAwG;IACxG,MAAM,UAAU,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC/C,OAAO,UAAU,CAAC;AACpB,CAAC"}

package/dist/cjs/websocket-api-client.d.ts

@@ -0,0 +1,89 @@
+import { CancelOrderRequestV3 } from './types/request/v3/trade.js';
+import { CancelOrderResponseV3 } from './types/response/v3/trade.js';
+import { WSAPIResponse } from './types/websockets/ws-api.js';
+import { WSAPIPlaceOrderRequestV3 } from './types/websockets/ws-api-request.js';
+import { WSAPIPlaceOrderResponseV3 } from './types/websockets/ws-api-response.js';
+import { BitgetInstTypeV3, WSClientConfigurableOptions } from './types/websockets/ws-general.js';
+import { DefaultLogger } from './util/logger.js';
+import { WebsocketClientV3 } from './websocket-client-v3.js';
+/**
+ * Configurable options specific to only the REST-like WebsocketAPIClient
+ */
+export interface WSAPIClientConfigurableOptions {
+    /**
+     * Default: true
+     *
+     * Attach default event listeners, which will console log any high level
+     * events (opened/reconnecting/reconnected/etc).
+     *
+     * If you disable this, you should set your own event listeners
+     * on the embedded WS Client `wsApiClient.getWSClient().on(....)`.
+     */
+    attachEventListeners: boolean;
+}
+/**
+ * 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 declare class WebsocketAPIClient {
+    private wsClient;
+    private options;
+    constructor(options?: WSClientConfigurableOptions & Partial<WSAPIClientConfigurableOptions>, logger?: DefaultLogger);
+    getWSClient(): WebsocketClientV3;
+    setTimeOffsetMs(newOffset: number): void;
+    /**
+     * Submit a new order
+     *
+     * https://www.bitget.com/api-doc/uta/websocket/private/Place-Order-Channel
+     *
+     * @returns
+     */
+    submitNewOrder(category: BitgetInstTypeV3, params: WSAPIPlaceOrderRequestV3): Promise<WSAPIResponse<[WSAPIPlaceOrderResponseV3], 'place-order'>>;
+    /**
+     * Submit a new order
+     *
+     * https://www.bitget.com/api-doc/uta/websocket/private/Batch-Place-Order-Channel
+     *
+     * @returns
+     */
+    placeBatchOrders(category: BitgetInstTypeV3, params: WSAPIPlaceOrderRequestV3[]): Promise<WSAPIResponse<WSAPIPlaceOrderResponseV3[], 'batch-place'>>;
+    /**
+     * Cancel Order
+     *
+     * https://www.bitget.com/api-doc/uta/websocket/private/Cancel-Order-Channel
+     *
+     * @returns
+     */
+    cancelOrder(category: BitgetInstTypeV3, params: CancelOrderRequestV3): Promise<WSAPIResponse<[CancelOrderResponseV3], 'cancel-order'>>;
+    /**
+     * Batch Cancel Order
+     *
+     * https://www.bitget.com/api-doc/uta/websocket/private/Batch-Cancel-Order-Channel
+     *
+     * @returns
+     */
+    cancelBatchOrders(category: BitgetInstTypeV3, params: CancelOrderRequestV3[]): Promise<WSAPIResponse<CancelOrderResponseV3[], 'batch-cancel'>>;
+    /**
+     *
+     *
+     *
+     *
+     *
+     *
+     *
+     * Private methods for handling some of the convenience/automation provided by the WS API Client
+     *
+     *
+     *
+     *
+     *
+     *
+     *
+     */
+    private setupDefaultEventListeners;
+}