bybit-api 3.10.30 → 4.0.0-beta.0

package/lib/util/websockets/websocket-util.js

@@ -0,0 +1,280 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WS_ERROR_ENUM = exports.WS_BASE_URL_MAP = exports.PUBLIC_WS_KEYS = exports.WS_AUTH_ON_CONNECT_KEYS = exports.WS_KEY_MAP = exports.WS_LOGGER_CATEGORY = void 0;
+exports.isPrivateWsTopic = isPrivateWsTopic;
+exports.getWsKeyForTopic = getWsKeyForTopic;
+exports.getWsUrl = getWsUrl;
+exports.getMaxTopicsPerSubscribeEvent = getMaxTopicsPerSubscribeEvent;
+exports.safeTerminateWs = safeTerminateWs;
+exports.getPromiseRefForWSAPIRequest = getPromiseRefForWSAPIRequest;
+exports.getNormalisedTopicRequests = getNormalisedTopicRequests;
+exports.getTopicsPerWSKey = getTopicsPerWSKey;
+const typeGuards_1 = require("../typeGuards");
+exports.WS_LOGGER_CATEGORY = { category: 'bybit-ws' };
+exports.WS_KEY_MAP = {
+    v5SpotPublic: 'v5SpotPublic',
+    v5LinearPublic: 'v5LinearPublic',
+    v5InversePublic: 'v5InversePublic',
+    v5OptionPublic: 'v5OptionPublic',
+    v5Private: 'v5Private',
+    /**
+     * The V5 Websocket API (for sending orders over WS)
+     */
+    v5PrivateTrade: 'v5PrivateTrade',
+};
+exports.WS_AUTH_ON_CONNECT_KEYS = [
+    exports.WS_KEY_MAP.v5Private,
+    exports.WS_KEY_MAP.v5PrivateTrade,
+];
+exports.PUBLIC_WS_KEYS = [
+    exports.WS_KEY_MAP.v5SpotPublic,
+    exports.WS_KEY_MAP.v5LinearPublic,
+    exports.WS_KEY_MAP.v5InversePublic,
+    exports.WS_KEY_MAP.v5OptionPublic,
+];
+/** Used to automatically determine if a sub request should be to the public or private ws (when there's two) */
+const PRIVATE_TOPICS = [
+    'stop_order',
+    'outboundAccountInfo',
+    'executionReport',
+    'ticketInfo',
+    // copy trading apis
+    'copyTradePosition',
+    'copyTradeOrder',
+    'copyTradeExecution',
+    'copyTradeWallet',
+    // usdc options
+    'user.openapi.option.position',
+    'user.openapi.option.trade',
+    'user.order',
+    'user.openapi.option.order',
+    'user.service',
+    'user.openapi.greeks',
+    'user.mmp.event',
+    // usdc perps
+    'user.openapi.perp.position',
+    'user.openapi.perp.trade',
+    'user.openapi.perp.order',
+    'user.service',
+    // unified margin
+    'user.position.unifiedAccount',
+    'user.execution.unifiedAccount',
+    'user.order.unifiedAccount',
+    'user.wallet.unifiedAccount',
+    'user.greeks.unifiedAccount',
+    // contract v3
+    'user.position.contractAccount',
+    'user.execution.contractAccount',
+    'user.order.contractAccount',
+    'user.wallet.contractAccount',
+    // v5
+    'position',
+    'execution',
+    'order',
+    'wallet',
+    'greeks',
+];
+exports.WS_BASE_URL_MAP = {
+    v5: {
+        public: {
+            livenet: 'public topics are routed internally via the public wskeys',
+            testnet: 'public topics are routed internally via the public wskeys',
+        },
+        private: {
+            livenet: 'wss://stream.bybit.com/v5/private',
+            testnet: 'wss://stream-testnet.bybit.com/v5/private',
+        },
+    },
+    v5PrivateTrade: {
+        public: {
+            livenet: 'public topics are routed internally via the public wskeys',
+            testnet: 'public topics are routed internally via the public wskeys',
+        },
+        private: {
+            livenet: 'wss://stream.bybit.com/v5/trade',
+            testnet: 'wss://stream-testnet.bybit.com/v5/trade',
+        },
+    },
+    v5SpotPublic: {
+        public: {
+            livenet: 'wss://stream.bybit.com/v5/public/spot',
+            testnet: 'wss://stream-testnet.bybit.com/v5/public/spot',
+        },
+    },
+    v5LinearPublic: {
+        public: {
+            livenet: 'wss://stream.bybit.com/v5/public/linear',
+            testnet: 'wss://stream-testnet.bybit.com/v5/public/linear',
+        },
+    },
+    v5InversePublic: {
+        public: {
+            livenet: 'wss://stream.bybit.com/v5/public/inverse',
+            testnet: 'wss://stream-testnet.bybit.com/v5/public/inverse',
+        },
+    },
+    v5OptionPublic: {
+        public: {
+            livenet: 'wss://stream.bybit.com/v5/public/option',
+            testnet: 'wss://stream-testnet.bybit.com/v5/public/option',
+        },
+    },
+};
+function isPrivateWsTopic(topic) {
+    return PRIVATE_TOPICS.includes(topic);
+}
+function getWsKeyForTopic(market, topic, isPrivate, category) {
+    const isPrivateTopic = isPrivate === true || PRIVATE_TOPICS.includes(topic);
+    switch (market) {
+        case 'v5': {
+            if (isPrivateTopic) {
+                return exports.WS_KEY_MAP.v5Private;
+            }
+            switch (category) {
+                case 'spot': {
+                    return exports.WS_KEY_MAP.v5SpotPublic;
+                }
+                case 'linear': {
+                    return exports.WS_KEY_MAP.v5LinearPublic;
+                }
+                case 'inverse': {
+                    return exports.WS_KEY_MAP.v5InversePublic;
+                }
+                case 'option': {
+                    return exports.WS_KEY_MAP.v5OptionPublic;
+                }
+                case undefined: {
+                    throw new Error('Category cannot be undefined');
+                }
+                default: {
+                    throw (0, typeGuards_1.neverGuard)(category, 'getWsKeyForTopic(v5): Unhandled v5 category');
+                }
+            }
+        }
+        default: {
+            throw (0, typeGuards_1.neverGuard)(market, 'getWsKeyForTopic(): Unhandled market');
+        }
+    }
+}
+function getWsUrl(wsKey, wsClientOptions, logger) {
+    const wsUrl = wsClientOptions.wsUrl;
+    if (wsUrl) {
+        return wsUrl;
+    }
+    // https://bybit-exchange.github.io/docs/v5/demo
+    const isDemoTrading = wsClientOptions.demoTrading;
+    if (isDemoTrading) {
+        return 'wss://stream-demo.bybit.com/v5/private';
+    }
+    const isTestnet = wsClientOptions.testnet;
+    const networkKey = isTestnet ? 'testnet' : 'livenet';
+    switch (wsKey) {
+        case exports.WS_KEY_MAP.v5Private: {
+            return exports.WS_BASE_URL_MAP.v5.private[networkKey];
+        }
+        case exports.WS_KEY_MAP.v5PrivateTrade: {
+            return exports.WS_BASE_URL_MAP[wsKey].private[networkKey];
+        }
+        case exports.WS_KEY_MAP.v5SpotPublic: {
+            return exports.WS_BASE_URL_MAP.v5SpotPublic.public[networkKey];
+        }
+        case exports.WS_KEY_MAP.v5LinearPublic: {
+            return exports.WS_BASE_URL_MAP.v5LinearPublic.public[networkKey];
+        }
+        case exports.WS_KEY_MAP.v5InversePublic: {
+            return exports.WS_BASE_URL_MAP.v5InversePublic.public[networkKey];
+        }
+        case exports.WS_KEY_MAP.v5OptionPublic: {
+            return exports.WS_BASE_URL_MAP.v5OptionPublic.public[networkKey];
+        }
+        default: {
+            logger.error('getWsUrl(): Unhandled wsKey: ', {
+                category: 'bybit-ws',
+                wsKey,
+            });
+            throw (0, typeGuards_1.neverGuard)(wsKey, 'getWsUrl(): Unhandled wsKey');
+        }
+    }
+}
+function getMaxTopicsPerSubscribeEvent(market, wsKey) {
+    switch (market) {
+        case 'v5': {
+            if (wsKey === exports.WS_KEY_MAP.v5SpotPublic) {
+                return 10;
+            }
+            return null;
+        }
+        default: {
+            throw (0, typeGuards_1.neverGuard)(market, 'getWsKeyForTopic(): Unhandled market');
+        }
+    }
+}
+exports.WS_ERROR_ENUM = {
+    NOT_AUTHENTICATED_SPOT_V3: '-1004',
+    API_ERROR_GENERIC: '10001',
+    API_SIGN_AUTH_FAILED: '10003',
+    USDC_OPTION_AUTH_FAILED: '3303006',
+};
+/**
+ * #305: ws.terminate() is undefined in browsers.
+ * This only works in node.js, not in browsers.
+ * Does nothing if `ws` is undefined.
+ */
+function safeTerminateWs(ws) {
+    // #305: ws.terminate() undefined in browsers
+    if (ws && typeof ws['terminate'] === 'function') {
+        ws.terminate();
+    }
+}
+/**
+ * WS API promises are stored using a primary key. This key is constructed using
+ * properties found in every request & reply.
+ */
+function getPromiseRefForWSAPIRequest(requestEvent) {
+    const promiseRef = [requestEvent.op, requestEvent.reqId].join('_');
+    return promiseRef;
+}
+/**
+ * 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;
+}
+/**
+ * Groups topics in request into per-wsKey groups
+ * @param normalisedTopicRequests
+ * @param wsKey
+ * @param isPrivateTopic
+ * @returns
+ */
+function getTopicsPerWSKey(market, normalisedTopicRequests, wsKey, isPrivateTopic) {
+    const perWsKeyTopics = {};
+    // Sort into per wsKey arrays, in case topics are mixed together for different wsKeys
+    for (const topicRequest of normalisedTopicRequests) {
+        const derivedWsKey = wsKey ||
+            getWsKeyForTopic(market, topicRequest.topic, isPrivateTopic, topicRequest.category);
+        if (!perWsKeyTopics[derivedWsKey] ||
+            !Array.isArray(perWsKeyTopics[derivedWsKey])) {
+            perWsKeyTopics[derivedWsKey] = [];
+        }
+        perWsKeyTopics[derivedWsKey].push(topicRequest);
+    }
+    return perWsKeyTopics;
+}
+//# sourceMappingURL=websocket-util.js.map

package/lib/util/websockets/websocket-util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket-util.js","sourceRoot":"","sources":["../../../src/util/websockets/websocket-util.ts"],"names":[],"mappings":";;;AAyLA,4CAEC;AAED,4CAyCC;AAED,4BA8CC;AAED,sEAeC;AAcD,0CAKC;AAKD,oEAKC;AAOD,gEAoBC;AASD,8CAgCC;AA7XD,8CAA2C;AAE9B,QAAA,kBAAkB,GAAG,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC;AAE9C,QAAA,UAAU,GAAG;IACxB,YAAY,EAAE,cAAc;IAC5B,cAAc,EAAE,gBAAgB;IAChC,eAAe,EAAE,iBAAiB;IAClC,cAAc,EAAE,gBAAgB;IAChC,SAAS,EAAE,WAAW;IACtB;;OAEG;IACH,cAAc,EAAE,gBAAgB;CACxB,CAAC;AAEE,QAAA,uBAAuB,GAAY;IAC9C,kBAAU,CAAC,SAAS;IACpB,kBAAU,CAAC,cAAc;CAC1B,CAAC;AAEW,QAAA,cAAc,GAAG;IAC5B,kBAAU,CAAC,YAAY;IACvB,kBAAU,CAAC,cAAc;IACzB,kBAAU,CAAC,eAAe;IAC1B,kBAAU,CAAC,cAAc;CACd,CAAC;AAEd,gHAAgH;AAChH,MAAM,cAAc,GAAG;IACrB,YAAY;IACZ,qBAAqB;IACrB,iBAAiB;IACjB,YAAY;IACZ,oBAAoB;IACpB,mBAAmB;IACnB,gBAAgB;IAChB,oBAAoB;IACpB,iBAAiB;IACjB,eAAe;IACf,8BAA8B;IAC9B,2BAA2B;IAC3B,YAAY;IACZ,2BAA2B;IAC3B,cAAc;IACd,qBAAqB;IACrB,gBAAgB;IAChB,aAAa;IACb,4BAA4B;IAC5B,yBAAyB;IACzB,yBAAyB;IACzB,cAAc;IACd,iBAAiB;IACjB,8BAA8B;IAC9B,+BAA+B;IAC/B,2BAA2B;IAC3B,4BAA4B;IAC5B,4BAA4B;IAC5B,cAAc;IACd,+BAA+B;IAC/B,gCAAgC;IAChC,4BAA4B;IAC5B,6BAA6B;IAC7B,KAAK;IACL,UAAU;IACV,WAAW;IACX,OAAO;IACP,QAAQ;IACR,QAAQ;CACT,CAAC;AAkDW,QAAA,eAAe,GAQtB;IACJ,EAAE,EAAE;QACF,MAAM,EAAE;YACN,OAAO,EAAE,2DAA2D;YACpE,OAAO,EAAE,2DAA2D;SACrE;QACD,OAAO,EAAE;YACP,OAAO,EAAE,mCAAmC;YAC5C,OAAO,EAAE,2CAA2C;SACrD;KACF;IACD,cAAc,EAAE;QACd,MAAM,EAAE;YACN,OAAO,EAAE,2DAA2D;YACpE,OAAO,EAAE,2DAA2D;SACrE;QACD,OAAO,EAAE;YACP,OAAO,EAAE,iCAAiC;YAC1C,OAAO,EAAE,yCAAyC;SACnD;KACF;IACD,YAAY,EAAE;QACZ,MAAM,EAAE;YACN,OAAO,EAAE,uCAAuC;YAChD,OAAO,EAAE,+CAA+C;SACzD;KACF;IACD,cAAc,EAAE;QACd,MAAM,EAAE;YACN,OAAO,EAAE,yCAAyC;YAClD,OAAO,EAAE,iDAAiD;SAC3D;KACF;IACD,eAAe,EAAE;QACf,MAAM,EAAE;YACN,OAAO,EAAE,0CAA0C;YACnD,OAAO,EAAE,kDAAkD;SAC5D;KACF;IACD,cAAc,EAAE;QACd,MAAM,EAAE;YACN,OAAO,EAAE,yCAAyC;YAClD,OAAO,EAAE,iDAAiD;SAC3D;KACF;CACF,CAAC;AAEF,SAAgB,gBAAgB,CAAC,KAAa;IAC5C,OAAO,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AACxC,CAAC;AAED,SAAgB,gBAAgB,CAC9B,MAAiB,EACjB,KAAa,EACb,SAAmB,EACnB,QAAqB;IAErB,MAAM,cAAc,GAAG,SAAS,KAAK,IAAI,IAAI,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC5E,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,IAAI,CAAC,CAAC,CAAC;YACV,IAAI,cAAc,EAAE,CAAC;gBACnB,OAAO,kBAAU,CAAC,SAAS,CAAC;YAC9B,CAAC;YAED,QAAQ,QAAQ,EAAE,CAAC;gBACjB,KAAK,MAAM,CAAC,CAAC,CAAC;oBACZ,OAAO,kBAAU,CAAC,YAAY,CAAC;gBACjC,CAAC;gBACD,KAAK,QAAQ,CAAC,CAAC,CAAC;oBACd,OAAO,kBAAU,CAAC,cAAc,CAAC;gBACnC,CAAC;gBACD,KAAK,SAAS,CAAC,CAAC,CAAC;oBACf,OAAO,kBAAU,CAAC,eAAe,CAAC;gBACpC,CAAC;gBACD,KAAK,QAAQ,CAAC,CAAC,CAAC;oBACd,OAAO,kBAAU,CAAC,cAAc,CAAC;gBACnC,CAAC;gBACD,KAAK,SAAS,CAAC,CAAC,CAAC;oBACf,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;gBAClD,CAAC;gBACD,OAAO,CAAC,CAAC,CAAC;oBACR,MAAM,IAAA,uBAAU,EACd,QAAQ,EACR,6CAA6C,CAC9C,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,IAAA,uBAAU,EAAC,MAAM,EAAE,sCAAsC,CAAC,CAAC;QACnE,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAgB,QAAQ,CACtB,KAAY,EACZ,eAAuC,EACvC,MAA4B;IAE5B,MAAM,KAAK,GAAG,eAAe,CAAC,KAAK,CAAC;IACpC,IAAI,KAAK,EAAE,CAAC;QACV,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gDAAgD;IAChD,MAAM,aAAa,GAAG,eAAe,CAAC,WAAW,CAAC;IAClD,IAAI,aAAa,EAAE,CAAC;QAClB,OAAO,wCAAwC,CAAC;IAClD,CAAC;IAED,MAAM,SAAS,GAAG,eAAe,CAAC,OAAO,CAAC;IAC1C,MAAM,UAAU,GAAG,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;IAErD,QAAQ,KAAK,EAAE,CAAC;QACd,KAAK,kBAAU,CAAC,SAAS,CAAC,CAAC,CAAC;YAC1B,OAAO,uBAAe,CAAC,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAChD,CAAC;QACD,KAAK,kBAAU,CAAC,cAAc,CAAC,CAAC,CAAC;YAC/B,OAAO,uBAAe,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QACpD,CAAC;QACD,KAAK,kBAAU,CAAC,YAAY,CAAC,CAAC,CAAC;YAC7B,OAAO,uBAAe,CAAC,YAAY,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACzD,CAAC;QACD,KAAK,kBAAU,CAAC,cAAc,CAAC,CAAC,CAAC;YAC/B,OAAO,uBAAe,CAAC,cAAc,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAC3D,CAAC;QACD,KAAK,kBAAU,CAAC,eAAe,CAAC,CAAC,CAAC;YAChC,OAAO,uBAAe,CAAC,eAAe,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAC5D,CAAC;QACD,KAAK,kBAAU,CAAC,cAAc,CAAC,CAAC,CAAC;YAC/B,OAAO,uBAAe,CAAC,cAAc,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAC3D,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,CAAC,KAAK,CAAC,+BAA+B,EAAE;gBAC5C,QAAQ,EAAE,UAAU;gBACpB,KAAK;aACN,CAAC,CAAC;YACH,MAAM,IAAA,uBAAU,EAAC,KAAK,EAAE,6BAA6B,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAgB,6BAA6B,CAC3C,MAAiB,EACjB,KAAY;IAEZ,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,IAAI,CAAC,CAAC,CAAC;YACV,IAAI,KAAK,KAAK,kBAAU,CAAC,YAAY,EAAE,CAAC;gBACtC,OAAO,EAAE,CAAC;YACZ,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,IAAA,uBAAU,EAAC,MAAM,EAAE,sCAAsC,CAAC,CAAC;QACnE,CAAC;IACH,CAAC;AACH,CAAC;AAEY,QAAA,aAAa,GAAG;IAC3B,yBAAyB,EAAE,OAAO;IAClC,iBAAiB,EAAE,OAAO;IAC1B,oBAAoB,EAAE,OAAO;IAC7B,uBAAuB,EAAE,SAAS;CACnC,CAAC;AAEF;;;;GAIG;AACH,SAAgB,eAAe,CAAC,EAAwB;IACtD,6CAA6C;IAC7C,IAAI,EAAE,IAAI,OAAO,EAAE,CAAC,WAAW,CAAC,KAAK,UAAU,EAAE,CAAC;QAChD,EAAE,CAAC,SAAS,EAAE,CAAC;IACjB,CAAC;AACH,CAAC;AACD;;;GAGG;AACH,SAAgB,4BAA4B,CAC1C,YAAmC;IAEnC,MAAM,UAAU,GAAG,CAAC,YAAY,CAAC,EAAE,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACnE,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;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;;;;;;GAMG;AACH,SAAgB,iBAAiB,CAC/B,MAAiB,EACjB,uBAAyC,EACzC,KAAa,EACb,cAAwB;IAIxB,MAAM,cAAc,GAAmD,EAAE,CAAC;IAE1E,qFAAqF;IACrF,KAAK,MAAM,YAAY,IAAI,uBAAuB,EAAE,CAAC;QACnD,MAAM,YAAY,GAChB,KAAK;YACL,gBAAgB,CACd,MAAM,EACN,YAAY,CAAC,KAAK,EAClB,cAAc,EACd,YAAY,CAAC,QAAQ,CACtB,CAAC;QAEJ,IACE,CAAC,cAAc,CAAC,YAAY,CAAC;YAC7B,CAAC,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC,EAC5C,CAAC;YACD,cAAc,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC;QACpC,CAAC;QAED,cAAc,CAAC,YAAY,CAAE,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACnD,CAAC;IAED,OAAO,cAAc,CAAC;AACxB,CAAC"}

package/lib/websocket-client.d.ts

@@ -1,144 +1,137 @@
-/// <reference types="node" />
-import { EventEmitter } from 'events';
 import WebSocket from 'isomorphic-ws';
-import { CategoryV5, KlineInterval, WSClientConfigurableOptions, WsKey, WsTopic } from './types';
-import { DefaultLogger } from './util';
-import WsStore from './util/WsStore';
-export 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;
-    /** 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;
-    private restClient?;
-    private options;
-    private wsStore;
-    private pendingTopicsSubscriptions;
-    constructor(options: WSClientConfigurableOptions, logger?: typeof DefaultLogger);
-    /** Get the WsStore that tracks websockets & topics */
-    getWsStore(): WsStore;
-    isTestnet(): boolean;
+import { CategoryV5, MessageEventLike, WsKey, WsMarket, WsTopic } from './types';
+import { WSConnectedResult, WS_KEY_MAP, WsTopicRequest } from './util';
+import { BaseWebsocketClient, EmittableEvent, MidflightWsRequestEvent } from './util/BaseWSClient';
+import { Exact, WSAPIOperation, WsAPIOperationResponseMap, WsAPITopicRequestParamMap, WsAPIWsKeyTopicMap, WsOperation, WsRequestOperationBybit } from './types/websockets/ws-api';
+export declare class WebsocketClient extends BaseWebsocketClient<WsKey, WsRequestOperationBybit<WsTopic>> {
+    /**
+     * Request connection of all dependent (public & private) websockets, instead of waiting
+     * for automatic connection by SDK.
+     */
+    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>;
+    connectPublic(): Promise<WSConnectedResult | undefined>[];
+    connectPrivate(): Promise<WebSocket | undefined>;
     /**
      * Subscribe to V5 topics & track/persist them.
      * @param wsTopics - topic or list of topics
-     * @param category - the API category this topic is for (e.g. "linear"). The value is only important when connecting to public topics and will be ignored for private 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)
+     * @param category - the API category this topic is for (e.g. "linear").
+     * The value is only important when connecting to public topics and will be ignored for private 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)
      */
-    subscribeV5(wsTopics: WsTopic[] | WsTopic, category: CategoryV5, isPrivateTopic?: boolean): Promise<void>;
+    subscribeV5(wsTopics: WsTopic[] | WsTopic, category: CategoryV5, isPrivateTopic?: boolean): Promise<unknown>[];
     /**
-     * Subscribe to V1-V3 topics & track/persist them.
+     * Unsubscribe from V5 topics & remove them from memory. They won't be re-subscribed to if the
+     * connection reconnects.
      *
-     * Note: for public V5 topics use the `subscribeV5()` method.
-     *
-     * Topics will be automatically resubscribed to if the connection resets/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)
+     * @param category - the API category this topic is for (e.g. "linear"). The value is only
+     * important when connecting to public topics and will be ignored for private 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): Promise<void>;
-    private upsertPendingTopicsSubscriptions;
+    unsubscribeV5(wsTopics: WsTopic[] | WsTopic, category: CategoryV5, isPrivateTopic?: boolean): Promise<unknown>[];
     /**
-     * Unsubscribe from V5 topics & remove them from memory. They won't be re-subscribed to if the connection reconnects.
-     * @param wsTopics - topic or list of topics
-     * @param category - the API category this topic is for (e.g. "linear"). The value is only important when connecting to public topics and will be ignored for private 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)
+     * Note: subscribeV5() might be simpler to use. The end result is the same.
+     *
+     * 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: (WsTopicRequest<WsTopic> | WsTopic) | (WsTopicRequest<WsTopic> | WsTopic)[], wsKey?: WsKey): void;
+    /**
+     * Note: unsubscribe() might be simpler to use. The end result is the same.
+     * 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: (WsTopicRequest<WsTopic> | WsTopic) | (WsTopicRequest<WsTopic> | WsTopic)[], wsKey?: WsKey): void;
+    /**
+     *
+     *
+     *
+     * WS API Methods - similar to the REST API, but via WebSockets
+     * https://bybit-exchange.github.io/docs/v5/websocket/trade/guideline
+     *
+     *
+     *
      */
-    unsubscribeV5(wsTopics: WsTopic[] | WsTopic, category: CategoryV5, isPrivateTopic?: boolean): void;
-    private removeTopicPendingSubscription;
-    private clearTopicsPendingSubscriptions;
     /**
-     * Unsubscribe from V1-V3 topics & remove them from memory. They won't be re-subscribed to if the connection reconnects.
+     * Send a Websocket API command/request on a connection. Returns a promise that resolves on reply.
+     *
+     * WS API Documentation for list of operations and parameters:
+     * https://bybit-exchange.github.io/docs/v5/websocket/trade/guideline
      *
-     * Note: For public V5 topics, use `unsubscribeV5()` instead!
+     * Returned promise is rejected if:
+     * - an exception is detected in the reply, OR
+     * - the connection disconnects for any reason (even if automatic reconnect will happen).
      *
-     * @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)
+     * Authentication is automatic. If you didn't request authentication yourself, there might
+     * be a small delay after your first request, while the SDK automatically authenticates.
+     *
+     * @param wsKey - The connection this event is for. Currently only "v5PrivateTrade" is supported
+     * for Bybit, since that is the dedicated WS API connection.
+     * @param operation - The command being sent, e.g. "order.create" to submit a new order.
+     * @param params - Any request parameters for the command. E.g. `OrderParamsV5` to submit a new
+     * order. Only send parameters for the request body. Everything else is automatically handled.
+     * @returns Promise - tries to resolve with async WS API response. Rejects if disconnected or exception is seen in async WS API response
      */
-    unsubscribe(wsTopics: WsTopic[] | WsTopic, isPrivateTopic?: boolean): void;
+    sendWSAPIRequest<TWSKey extends keyof WsAPIWsKeyTopicMap, TWSOperation extends WsAPIWsKeyTopicMap[TWSKey], TWSParams extends Exact<WsAPITopicRequestParamMap[TWSOperation]>>(wsKey: TWSKey, operation: TWSOperation, ...params: TWSParams extends undefined ? [] : [TWSParams]): Promise<WsAPIOperationResponseMap[TWSOperation]>;
+    sendWSAPIRequest<TWSOpreation extends WSAPIOperation = 'order.create'>(wsKey: typeof WS_KEY_MAP.v5PrivateTrade, operation: TWSOpreation, params: WsAPITopicRequestParamMap[TWSOpreation]): Promise<WsAPIOperationResponseMap[TWSOpreation]>;
+    sendWSAPIRequest<TWSOpreation extends WSAPIOperation = 'order.amend'>(wsKey: typeof WS_KEY_MAP.v5PrivateTrade, operation: TWSOpreation, params: WsAPITopicRequestParamMap[TWSOpreation]): Promise<WsAPIOperationResponseMap[TWSOpreation]>;
+    sendWSAPIRequest<TWSOpreation extends WSAPIOperation = 'order.cancel'>(wsKey: typeof WS_KEY_MAP.v5PrivateTrade, operation: TWSOpreation, params: WsAPITopicRequestParamMap[TWSOpreation]): Promise<WsAPIOperationResponseMap[TWSOpreation]>;
     /**
-     * @private 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
+     *
+     *
+     * Internal methods - not intended for public use
+     *
+     *
      */
-    private prepareRESTClient;
-    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
+     * @returns The WS URL to connect to for this WS key
      */
-    connectAll(): Promise<WebSocket | undefined>[];
-    connectPublic(): Promise<WebSocket | undefined>[];
-    connectPrivate(): Promise<WebSocket | undefined>;
-    private connect;
-    private parseWsError;
+    protected getWsUrl(wsKey: WsKey): Promise<string>;
     /**
      * Return params required to make authorized request
      */
-    private getAuthParams;
-    private sendAuthRequest;
+    private getWsAuthURLSuffix;
+    private signMessage;
+    protected getWsAuthRequestEvent(wsKey: WsKey): Promise<WsRequestOperationBybit<string>>;
     private getWsAuthSignature;
-    private reconnectWithDelay;
-    private ping;
+    private signWSAPIRequest;
+    protected sendPingEvent(wsKey: WsKey): void;
+    protected sendPongEvent(wsKey: WsKey): void;
+    /** Force subscription requests to be sent in smaller batches, if a number is returned */
+    protected getMaxTopicsPerSubscribeEvent(wsKey: WsKey): number | null;
     /**
-     * Closes a connection, if it's even open. If open, this will trigger a reconnect asynchronously.
-     * If closed, trigger a reconnect immediately
+     * @returns one or more correctly structured request events for performing a operations over WS. This can vary per exchange spec.
      */
-    private executeReconnectableClose;
-    private clearTimers;
-    private clearPingTimer;
-    private clearPongTimer;
-    private clearReconnectTimer;
+    protected getWsRequestEvents(market: WsMarket, operation: WsOperation, requests: WsTopicRequest<string>[], wsKey: WsKey): Promise<MidflightWsRequestEvent<WsRequestOperationBybit<WsTopic>>[]>;
+    protected getPrivateWSKeys(): WsKey[];
+    protected isAuthOnConnectWsKey(wsKey: WsKey): boolean;
     /**
-     * @private Use the `subscribe(topics)` method to subscribe to topics. Send WS message to subscribe to topics.
+     * Determines if a topic is for a private channel, using a hardcoded list of strings
      */
-    private requestSubscribeTopics;
+    protected isPrivateTopicRequest(request: WsTopicRequest<string>): boolean;
+    protected isWsPing(msg: any): boolean;
+    protected isWsPong(msg: any): boolean;
     /**
-     * @private Use the `unsubscribe(topics)` method to unsubscribe from topics. Send WS message to unsubscribe from topics.
+     * Abstraction called to sort ws events into emittable event types (response to a request, data update, etc)
      */
-    private requestUnsubscribeTopics;
-    tryWsSend(wsKey: WsKey, wsMessage: string): void;
-    private connectToWsUrl;
-    private onWsOpen;
-    private onWsMessage;
-    private updatePendingTopicSubscriptionStatus;
-    private onWsClose;
-    private getWs;
-    private setWsState;
-    private wrongMarketError;
-    /** @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;
+    protected resolveEmittableEvents(wsKey: WsKey, event: MessageEventLike): EmittableEvent[];
 }
-export {};