bybit-api 2.4.0-beta.2 → 3.0.2

package/lib/util/websocket-util.d.ts

@@ -6,7 +6,7 @@ interface NetworkMapV3 {
     testnet2?: string;
 }
 declare type PublicPrivateNetwork = 'public' | 'private';
-export declare const WS_BASE_URL_MAP: Record<APIMarket, Record<PublicPrivateNetwork, NetworkMapV3>>;
+export declare const WS_BASE_URL_MAP: Record<APIMarket | 'unifiedPerpUSDT' | 'unifiedPerpUSDC', Record<PublicPrivateNetwork, NetworkMapV3>>;
 export declare const WS_KEY_MAP: {
     readonly inverse: "inverse";
     readonly linearPrivate: "linearPrivate";
@@ -19,10 +19,15 @@ export declare const WS_KEY_MAP: {
     readonly usdcOptionPublic: "usdcOptionPublic";
     readonly usdcPerpPrivate: "usdcPerpPrivate";
     readonly usdcPerpPublic: "usdcPerpPublic";
+    readonly unifiedPrivate: "unifiedPrivate";
+    readonly unifiedOptionPublic: "unifiedOptionPublic";
+    readonly unifiedPerpUSDTPublic: "unifiedPerpUSDTPublic";
+    readonly unifiedPerpUSDCPublic: "unifiedPerpUSDCPublic";
 };
 export declare const WS_AUTH_ON_CONNECT_KEYS: WsKey[];
 export declare const PUBLIC_WS_KEYS: string[];
 export declare function getWsKeyForTopic(market: APIMarket, topic: string, isPrivate?: boolean): WsKey;
+export declare function getMaxTopicsPerSubscribeEvent(market: APIMarket): number | null;
 export declare function getUsdcWsKeyForTopic(topic: string, subGroup: 'option' | 'perp'): WsKey;
 export declare const WS_ERROR_ENUM: {
     NOT_AUTHENTICATED_SPOT_V3: string;

package/lib/util/websocket-util.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.neverGuard = exports.WS_ERROR_ENUM = exports.getUsdcWsKeyForTopic = exports.getWsKeyForTopic = exports.PUBLIC_WS_KEYS = exports.WS_AUTH_ON_CONNECT_KEYS = exports.WS_KEY_MAP = exports.WS_BASE_URL_MAP = void 0;
+exports.neverGuard = exports.WS_ERROR_ENUM = exports.getUsdcWsKeyForTopic = exports.getMaxTopicsPerSubscribeEvent = exports.getWsKeyForTopic = exports.PUBLIC_WS_KEYS = exports.WS_AUTH_ON_CONNECT_KEYS = exports.WS_KEY_MAP = exports.WS_BASE_URL_MAP = void 0;
 exports.WS_BASE_URL_MAP = {
     inverse: {
         public: {
@@ -70,6 +70,46 @@ exports.WS_BASE_URL_MAP = {
             testnet: 'wss://stream-testnet.bybit.com/trade/option/usdc/private/v1',
         },
     },
+    unifiedOption: {
+        public: {
+            livenet: 'wss://stream.bybit.com/option/usdc/public/v3',
+            testnet: 'wss://stream-testnet.bybit.com/option/usdc/public/v3',
+        },
+        private: {
+            livenet: 'wss://stream.bybit.com/unified/private/v3',
+            testnet: 'wss://stream-testnet.bybit.com/unified/private/v3',
+        },
+    },
+    unifiedPerp: {
+        public: {
+            livenet: 'useBaseSpecificEndpoint',
+            testnet: 'useBaseSpecificEndpoint',
+        },
+        private: {
+            livenet: 'wss://stream.bybit.com/unified/private/v3',
+            testnet: 'wss://stream-testnet.bybit.com/unified/private/v3',
+        },
+    },
+    unifiedPerpUSDT: {
+        public: {
+            livenet: 'wss://stream.bybit.com/contract/usdt/public/v3',
+            testnet: 'wss://stream-testnet.bybit.com/contract/usdt/public/v3',
+        },
+        private: {
+            livenet: 'useUnifiedEndpoint',
+            testnet: 'useUnifiedEndpoint',
+        },
+    },
+    unifiedPerpUSDC: {
+        public: {
+            livenet: 'wss://stream.bybit.com/contract/usdc/public/v3',
+            testnet: 'wss://stream-testnet.bybit.com/contract/usdc/public/v3',
+        },
+        private: {
+            livenet: 'useUnifiedEndpoint',
+            testnet: 'useUnifiedEndpoint',
+        },
+    },
 };
 exports.WS_KEY_MAP = {
     inverse: 'inverse',
@@ -83,6 +123,10 @@ exports.WS_KEY_MAP = {
     usdcOptionPublic: 'usdcOptionPublic',
     usdcPerpPrivate: 'usdcPerpPrivate',
     usdcPerpPublic: 'usdcPerpPublic',
+    unifiedPrivate: 'unifiedPrivate',
+    unifiedOptionPublic: 'unifiedOptionPublic',
+    unifiedPerpUSDTPublic: 'unifiedPerpUSDTPublic',
+    unifiedPerpUSDCPublic: 'unifiedPerpUSDCPublic',
 };
 exports.WS_AUTH_ON_CONNECT_KEYS = [
     exports.WS_KEY_MAP.spotV3Private,
@@ -95,6 +139,9 @@ exports.PUBLIC_WS_KEYS = [
     exports.WS_KEY_MAP.spotV3Public,
     exports.WS_KEY_MAP.usdcOptionPublic,
     exports.WS_KEY_MAP.usdcPerpPublic,
+    exports.WS_KEY_MAP.unifiedOptionPublic,
+    exports.WS_KEY_MAP.unifiedPerpUSDTPublic,
+    exports.WS_KEY_MAP.unifiedPerpUSDCPublic,
 ];
 /** Used to automatically determine if a sub request should be to the public or private ws (when there's two) */
 const PRIVATE_TOPICS = [
@@ -160,12 +207,50 @@ function getWsKeyForTopic(market, topic, isPrivate) {
                 ? exports.WS_KEY_MAP.usdcPerpPrivate
                 : exports.WS_KEY_MAP.usdcPerpPublic;
         }
+        case 'unifiedOption': {
+            return isPrivateTopic
+                ? exports.WS_KEY_MAP.unifiedPrivate
+                : exports.WS_KEY_MAP.unifiedOptionPublic;
+        }
+        case 'unifiedPerp': {
+            if (isPrivateTopic) {
+                return exports.WS_KEY_MAP.unifiedPrivate;
+            }
+            const upperTopic = topic.toUpperCase();
+            if (upperTopic.indexOf('USDT') !== -1) {
+                return exports.WS_KEY_MAP.unifiedPerpUSDTPublic;
+            }
+            if (upperTopic.indexOf('USDC') !== -1) {
+                return exports.WS_KEY_MAP.unifiedPerpUSDCPublic;
+            }
+            throw new Error(`Failed to determine wskey for unified perps topic: "${topic}`);
+        }
         default: {
             throw neverGuard(market, `getWsKeyForTopic(): Unhandled market`);
         }
     }
 }
 exports.getWsKeyForTopic = getWsKeyForTopic;
+function getMaxTopicsPerSubscribeEvent(market) {
+    switch (market) {
+        case 'inverse':
+        case 'linear':
+        case 'usdcOption':
+        case 'usdcPerp':
+        case 'unifiedOption':
+        case 'unifiedPerp':
+        case 'spot': {
+            return null;
+        }
+        case 'spotv3': {
+            return 10;
+        }
+        default: {
+            throw neverGuard(market, `getWsKeyForTopic(): Unhandled market`);
+        }
+    }
+}
+exports.getMaxTopicsPerSubscribeEvent = getMaxTopicsPerSubscribeEvent;
 function getUsdcWsKeyForTopic(topic, subGroup) {
     const isPrivateTopic = PRIVATE_TOPICS.includes(topic);
     if (subGroup === 'option') {

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

@@ -1 +1 @@
-{"version":3,"file":"websocket-util.js","sourceRoot":"","sources":["../../src/util/websocket-util.ts"],"names":[],"mappings":";;;AAWa,QAAA,eAAe,GAGxB;IACF,OAAO,EAAE;QACP,MAAM,EAAE;YACN,OAAO,EAAE,iCAAiC;YAC1C,OAAO,EAAE,yCAAyC;SACnD;QACD,OAAO,EAAE;YACP,OAAO,EAAE,iCAAiC;YAC1C,OAAO,EAAE,yCAAyC;SACnD;KACF;IACD,MAAM,EAAE;QACN,MAAM,EAAE;YACN,OAAO,EAAE,wCAAwC;YACjD,QAAQ,EAAE,yCAAyC;YACnD,OAAO,EAAE,gDAAgD;SAC1D;QACD,OAAO,EAAE;YACP,OAAO,EAAE,yCAAyC;YAClD,QAAQ,EAAE,0CAA0C;YACpD,OAAO,EAAE,iDAAiD;SAC3D;KACF;IACD,IAAI,EAAE;QACJ,MAAM,EAAE;YACN,OAAO,EAAE,yCAAyC;YAClD,QAAQ,EAAE,yCAAyC;YACnD,OAAO,EAAE,iDAAiD;YAC1D,QAAQ,EAAE,iDAAiD;SAC5D;QACD,OAAO,EAAE;YACP,OAAO,EAAE,gCAAgC;YACzC,OAAO,EAAE,wCAAwC;SAClD;KACF;IACD,MAAM,EAAE;QACN,MAAM,EAAE;YACN,OAAO,EAAE,uCAAuC;YAChD,OAAO,EAAE,+CAA+C;SACzD;QACD,OAAO,EAAE;YACP,OAAO,EAAE,wCAAwC;YACjD,OAAO,EAAE,gDAAgD;SAC1D;KACF;IACD,UAAU,EAAE;QACV,MAAM,EAAE;YACN,OAAO,EAAE,oDAAoD;YAC7D,QAAQ,EAAE,qDAAqD;YAC/D,OAAO,EAAE,4DAA4D;SACtE;QACD,OAAO,EAAE;YACP,OAAO,EAAE,qDAAqD;YAC9D,QAAQ,EAAE,sDAAsD;YAChE,OAAO,EAAE,6DAA6D;SACvE;KACF;IACD,QAAQ,EAAE;QACR,MAAM,EAAE;YACN,OAAO,EAAE,wDAAwD;YACjE,QAAQ,EAAE,yDAAyD;YACnE,OAAO,EAAE,gEAAgE;SAC1E;QACD,OAAO,EAAE;YACP,OAAO,EAAE,qDAAqD;YAC9D,QAAQ,EAAE,sDAAsD;YAChE,OAAO,EAAE,6DAA6D;SACvE;KACF;CACF,CAAC;AAEW,QAAA,UAAU,GAAG;IACxB,OAAO,EAAE,SAAS;IAClB,aAAa,EAAE,eAAe;IAC9B,YAAY,EAAE,cAAc;IAC5B,WAAW,EAAE,aAAa;IAC1B,UAAU,EAAE,YAAY;IACxB,aAAa,EAAE,eAAe;IAC9B,YAAY,EAAE,cAAc;IAC5B,iBAAiB,EAAE,mBAAmB;IACtC,gBAAgB,EAAE,kBAAkB;IACpC,eAAe,EAAE,iBAAiB;IAClC,cAAc,EAAE,gBAAgB;CACxB,CAAC;AAEE,QAAA,uBAAuB,GAAY;IAC9C,kBAAU,CAAC,aAAa;IACxB,kBAAU,CAAC,iBAAiB;IAC5B,kBAAU,CAAC,eAAe;CAC3B,CAAC;AAEW,QAAA,cAAc,GAAG;IAC5B,kBAAU,CAAC,YAAY;IACvB,kBAAU,CAAC,UAAU;IACrB,kBAAU,CAAC,YAAY;IACvB,kBAAU,CAAC,gBAAgB;IAC3B,kBAAU,CAAC,cAAc;CACd,CAAC;AAEd,gHAAgH;AAChH,MAAM,cAAc,GAAG;IACrB,UAAU;IACV,WAAW;IACX,OAAO;IACP,YAAY;IACZ,QAAQ;IACR,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;CAC7B,CAAC;AAEF,SAAgB,gBAAgB,CAC9B,MAAiB,EACjB,KAAa,EACb,SAAmB;IAEnB,MAAM,cAAc,GAAG,SAAS,KAAK,IAAI,IAAI,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC5E,QAAQ,MAAM,EAAE;QACd,KAAK,SAAS,CAAC,CAAC;YACd,OAAO,kBAAU,CAAC,OAAO,CAAC;SAC3B;QACD,KAAK,QAAQ,CAAC,CAAC;YACb,OAAO,cAAc;gBACnB,CAAC,CAAC,kBAAU,CAAC,aAAa;gBAC1B,CAAC,CAAC,kBAAU,CAAC,YAAY,CAAC;SAC7B;QACD,KAAK,MAAM,CAAC,CAAC;YACX,OAAO,cAAc,CAAC,CAAC,CAAC,kBAAU,CAAC,WAAW,CAAC,CAAC,CAAC,kBAAU,CAAC,UAAU,CAAC;SACxE;QACD,KAAK,QAAQ,CAAC,CAAC;YACb,OAAO,cAAc;gBACnB,CAAC,CAAC,kBAAU,CAAC,aAAa;gBAC1B,CAAC,CAAC,kBAAU,CAAC,YAAY,CAAC;SAC7B;QACD,KAAK,YAAY,CAAC,CAAC;YACjB,OAAO,cAAc;gBACnB,CAAC,CAAC,kBAAU,CAAC,iBAAiB;gBAC9B,CAAC,CAAC,kBAAU,CAAC,gBAAgB,CAAC;SACjC;QACD,KAAK,UAAU,CAAC,CAAC;YACf,OAAO,cAAc;gBACnB,CAAC,CAAC,kBAAU,CAAC,eAAe;gBAC5B,CAAC,CAAC,kBAAU,CAAC,cAAc,CAAC;SAC/B;QACD,OAAO,CAAC,CAAC;YACP,MAAM,UAAU,CAAC,MAAM,EAAE,sCAAsC,CAAC,CAAC;SAClE;KACF;AACH,CAAC;AArCD,4CAqCC;AAED,SAAgB,oBAAoB,CAClC,KAAa,EACb,QAA2B;IAE3B,MAAM,cAAc,GAAG,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACtD,IAAI,QAAQ,KAAK,QAAQ,EAAE;QACzB,OAAO,cAAc;YACnB,CAAC,CAAC,kBAAU,CAAC,iBAAiB;YAC9B,CAAC,CAAC,kBAAU,CAAC,gBAAgB,CAAC;KACjC;IACD,OAAO,cAAc;QACnB,CAAC,CAAC,kBAAU,CAAC,iBAAiB;QAC9B,CAAC,CAAC,kBAAU,CAAC,gBAAgB,CAAC;IAChC,wBAAwB;IACxB,iCAAiC;IACjC,iCAAiC;AACnC,CAAC;AAhBD,oDAgBC;AAEY,QAAA,aAAa,GAAG;IAC3B,yBAAyB,EAAE,OAAO;IAClC,iBAAiB,EAAE,OAAO;IAC1B,oBAAoB,EAAE,OAAO;IAC7B,uBAAuB,EAAE,SAAS;CACnC,CAAC;AAEF,SAAgB,UAAU,CAAC,CAAQ,EAAE,GAAW;IAC9C,OAAO,IAAI,KAAK,CAAC,kCAAkC,GAAG,EAAE,CAAC,CAAC;AAC5D,CAAC;AAFD,gCAEC"}
+{"version":3,"file":"websocket-util.js","sourceRoot":"","sources":["../../src/util/websocket-util.ts"],"names":[],"mappings":";;;AAWa,QAAA,eAAe,GAGxB;IACF,OAAO,EAAE;QACP,MAAM,EAAE;YACN,OAAO,EAAE,iCAAiC;YAC1C,OAAO,EAAE,yCAAyC;SACnD;QACD,OAAO,EAAE;YACP,OAAO,EAAE,iCAAiC;YAC1C,OAAO,EAAE,yCAAyC;SACnD;KACF;IACD,MAAM,EAAE;QACN,MAAM,EAAE;YACN,OAAO,EAAE,wCAAwC;YACjD,QAAQ,EAAE,yCAAyC;YACnD,OAAO,EAAE,gDAAgD;SAC1D;QACD,OAAO,EAAE;YACP,OAAO,EAAE,yCAAyC;YAClD,QAAQ,EAAE,0CAA0C;YACpD,OAAO,EAAE,iDAAiD;SAC3D;KACF;IACD,IAAI,EAAE;QACJ,MAAM,EAAE;YACN,OAAO,EAAE,yCAAyC;YAClD,QAAQ,EAAE,yCAAyC;YACnD,OAAO,EAAE,iDAAiD;YAC1D,QAAQ,EAAE,iDAAiD;SAC5D;QACD,OAAO,EAAE;YACP,OAAO,EAAE,gCAAgC;YACzC,OAAO,EAAE,wCAAwC;SAClD;KACF;IACD,MAAM,EAAE;QACN,MAAM,EAAE;YACN,OAAO,EAAE,uCAAuC;YAChD,OAAO,EAAE,+CAA+C;SACzD;QACD,OAAO,EAAE;YACP,OAAO,EAAE,wCAAwC;YACjD,OAAO,EAAE,gDAAgD;SAC1D;KACF;IACD,UAAU,EAAE;QACV,MAAM,EAAE;YACN,OAAO,EAAE,oDAAoD;YAC7D,QAAQ,EAAE,qDAAqD;YAC/D,OAAO,EAAE,4DAA4D;SACtE;QACD,OAAO,EAAE;YACP,OAAO,EAAE,qDAAqD;YAC9D,QAAQ,EAAE,sDAAsD;YAChE,OAAO,EAAE,6DAA6D;SACvE;KACF;IACD,QAAQ,EAAE;QACR,MAAM,EAAE;YACN,OAAO,EAAE,wDAAwD;YACjE,QAAQ,EAAE,yDAAyD;YACnE,OAAO,EAAE,gEAAgE;SAC1E;QACD,OAAO,EAAE;YACP,OAAO,EAAE,qDAAqD;YAC9D,QAAQ,EAAE,sDAAsD;YAChE,OAAO,EAAE,6DAA6D;SACvE;KACF;IACD,aAAa,EAAE;QACb,MAAM,EAAE;YACN,OAAO,EAAE,8CAA8C;YACvD,OAAO,EAAE,sDAAsD;SAChE;QACD,OAAO,EAAE;YACP,OAAO,EAAE,2CAA2C;YACpD,OAAO,EAAE,mDAAmD;SAC7D;KACF;IACD,WAAW,EAAE;QACX,MAAM,EAAE;YACN,OAAO,EAAE,yBAAyB;YAClC,OAAO,EAAE,yBAAyB;SACnC;QACD,OAAO,EAAE;YACP,OAAO,EAAE,2CAA2C;YACpD,OAAO,EAAE,mDAAmD;SAC7D;KACF;IACD,eAAe,EAAE;QACf,MAAM,EAAE;YACN,OAAO,EAAE,gDAAgD;YACzD,OAAO,EAAE,wDAAwD;SAClE;QACD,OAAO,EAAE;YACP,OAAO,EAAE,oBAAoB;YAC7B,OAAO,EAAE,oBAAoB;SAC9B;KACF;IACD,eAAe,EAAE;QACf,MAAM,EAAE;YACN,OAAO,EAAE,gDAAgD;YACzD,OAAO,EAAE,wDAAwD;SAClE;QACD,OAAO,EAAE;YACP,OAAO,EAAE,oBAAoB;YAC7B,OAAO,EAAE,oBAAoB;SAC9B;KACF;CACF,CAAC;AAEW,QAAA,UAAU,GAAG;IACxB,OAAO,EAAE,SAAS;IAClB,aAAa,EAAE,eAAe;IAC9B,YAAY,EAAE,cAAc;IAC5B,WAAW,EAAE,aAAa;IAC1B,UAAU,EAAE,YAAY;IACxB,aAAa,EAAE,eAAe;IAC9B,YAAY,EAAE,cAAc;IAC5B,iBAAiB,EAAE,mBAAmB;IACtC,gBAAgB,EAAE,kBAAkB;IACpC,eAAe,EAAE,iBAAiB;IAClC,cAAc,EAAE,gBAAgB;IAChC,cAAc,EAAE,gBAAgB;IAChC,mBAAmB,EAAE,qBAAqB;IAC1C,qBAAqB,EAAE,uBAAuB;IAC9C,qBAAqB,EAAE,uBAAuB;CACtC,CAAC;AAEE,QAAA,uBAAuB,GAAY;IAC9C,kBAAU,CAAC,aAAa;IACxB,kBAAU,CAAC,iBAAiB;IAC5B,kBAAU,CAAC,eAAe;CAC3B,CAAC;AAEW,QAAA,cAAc,GAAG;IAC5B,kBAAU,CAAC,YAAY;IACvB,kBAAU,CAAC,UAAU;IACrB,kBAAU,CAAC,YAAY;IACvB,kBAAU,CAAC,gBAAgB;IAC3B,kBAAU,CAAC,cAAc;IACzB,kBAAU,CAAC,mBAAmB;IAC9B,kBAAU,CAAC,qBAAqB;IAChC,kBAAU,CAAC,qBAAqB;CACrB,CAAC;AAEd,gHAAgH;AAChH,MAAM,cAAc,GAAG;IACrB,UAAU;IACV,WAAW;IACX,OAAO;IACP,YAAY;IACZ,QAAQ;IACR,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;CAC7B,CAAC;AAEF,SAAgB,gBAAgB,CAC9B,MAAiB,EACjB,KAAa,EACb,SAAmB;IAEnB,MAAM,cAAc,GAAG,SAAS,KAAK,IAAI,IAAI,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC5E,QAAQ,MAAM,EAAE;QACd,KAAK,SAAS,CAAC,CAAC;YACd,OAAO,kBAAU,CAAC,OAAO,CAAC;SAC3B;QACD,KAAK,QAAQ,CAAC,CAAC;YACb,OAAO,cAAc;gBACnB,CAAC,CAAC,kBAAU,CAAC,aAAa;gBAC1B,CAAC,CAAC,kBAAU,CAAC,YAAY,CAAC;SAC7B;QACD,KAAK,MAAM,CAAC,CAAC;YACX,OAAO,cAAc,CAAC,CAAC,CAAC,kBAAU,CAAC,WAAW,CAAC,CAAC,CAAC,kBAAU,CAAC,UAAU,CAAC;SACxE;QACD,KAAK,QAAQ,CAAC,CAAC;YACb,OAAO,cAAc;gBACnB,CAAC,CAAC,kBAAU,CAAC,aAAa;gBAC1B,CAAC,CAAC,kBAAU,CAAC,YAAY,CAAC;SAC7B;QACD,KAAK,YAAY,CAAC,CAAC;YACjB,OAAO,cAAc;gBACnB,CAAC,CAAC,kBAAU,CAAC,iBAAiB;gBAC9B,CAAC,CAAC,kBAAU,CAAC,gBAAgB,CAAC;SACjC;QACD,KAAK,UAAU,CAAC,CAAC;YACf,OAAO,cAAc;gBACnB,CAAC,CAAC,kBAAU,CAAC,eAAe;gBAC5B,CAAC,CAAC,kBAAU,CAAC,cAAc,CAAC;SAC/B;QACD,KAAK,eAAe,CAAC,CAAC;YACpB,OAAO,cAAc;gBACnB,CAAC,CAAC,kBAAU,CAAC,cAAc;gBAC3B,CAAC,CAAC,kBAAU,CAAC,mBAAmB,CAAC;SACpC;QACD,KAAK,aAAa,CAAC,CAAC;YAClB,IAAI,cAAc,EAAE;gBAClB,OAAO,kBAAU,CAAC,cAAc,CAAC;aAClC;YAED,MAAM,UAAU,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;YACvC,IAAI,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE;gBACrC,OAAO,kBAAU,CAAC,qBAAqB,CAAC;aACzC;YAED,IAAI,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE;gBACrC,OAAO,kBAAU,CAAC,qBAAqB,CAAC;aACzC;YAED,MAAM,IAAI,KAAK,CACb,uDAAuD,KAAK,EAAE,CAC/D,CAAC;SACH;QACD,OAAO,CAAC,CAAC;YACP,MAAM,UAAU,CAAC,MAAM,EAAE,sCAAsC,CAAC,CAAC;SAClE;KACF;AACH,CAAC;AA5DD,4CA4DC;AAED,SAAgB,6BAA6B,CAC3C,MAAiB;IAEjB,QAAQ,MAAM,EAAE;QACd,KAAK,SAAS,CAAC;QACf,KAAK,QAAQ,CAAC;QACd,KAAK,YAAY,CAAC;QAClB,KAAK,UAAU,CAAC;QAChB,KAAK,eAAe,CAAC;QACrB,KAAK,aAAa,CAAC;QACnB,KAAK,MAAM,CAAC,CAAC;YACX,OAAO,IAAI,CAAC;SACb;QACD,KAAK,QAAQ,CAAC,CAAC;YACb,OAAO,EAAE,CAAC;SACX;QACD,OAAO,CAAC,CAAC;YACP,MAAM,UAAU,CAAC,MAAM,EAAE,sCAAsC,CAAC,CAAC;SAClE;KACF;AACH,CAAC;AApBD,sEAoBC;AAED,SAAgB,oBAAoB,CAClC,KAAa,EACb,QAA2B;IAE3B,MAAM,cAAc,GAAG,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACtD,IAAI,QAAQ,KAAK,QAAQ,EAAE;QACzB,OAAO,cAAc;YACnB,CAAC,CAAC,kBAAU,CAAC,iBAAiB;YAC9B,CAAC,CAAC,kBAAU,CAAC,gBAAgB,CAAC;KACjC;IACD,OAAO,cAAc;QACnB,CAAC,CAAC,kBAAU,CAAC,iBAAiB;QAC9B,CAAC,CAAC,kBAAU,CAAC,gBAAgB,CAAC;IAChC,wBAAwB;IACxB,iCAAiC;IACjC,iCAAiC;AACnC,CAAC;AAhBD,oDAgBC;AAEY,QAAA,aAAa,GAAG;IAC3B,yBAAyB,EAAE,OAAO;IAClC,iBAAiB,EAAE,OAAO;IAC1B,oBAAoB,EAAE,OAAO;IAC7B,uBAAuB,EAAE,SAAS;CACnC,CAAC;AAEF,SAAgB,UAAU,CAAC,CAAQ,EAAE,GAAW;IAC9C,OAAO,IAAI,KAAK,CAAC,kCAAkC,GAAG,EAAE,CAAC,CAAC;AAC5D,CAAC;AAFD,gCAEC"}

package/lib/websocket-client.d.ts

@@ -1,29 +1,37 @@
 /// <reference types="node" />
 import { EventEmitter } from 'events';
 import WebSocket from 'isomorphic-ws';
+import WsStore from './util/WsStore';
 import { KlineInterval, WSClientConfigurableOptions, WsKey, WsTopic } from './types';
 import { DefaultLogger } from './util';
-export declare type WsClientEvent = 'open' | 'update' | 'close' | 'errorEvent' | 'reconnect' | 'reconnected' | 'response';
+export declare type WsClientEvent = 'open' | 'update' | 'close' | 'error' | 'reconnect' | 'reconnected' | 'response';
 interface WebsocketClientEvents {
+    /** Connection opened. If this connection was previously opened and reconnected, expect the reconnected event instead */
     open: (evt: {
         wsKey: WsKey;
         event: any;
     }) => void;
+    /** Reconnecting a dropped connection */
     reconnect: (evt: {
         wsKey: WsKey;
         event: any;
     }) => void;
+    /** Successfully reconnected a connection that dropped */
     reconnected: (evt: {
         wsKey: WsKey;
         event: any;
     }) => void;
+    /** Connection closed */
     close: (evt: {
         wsKey: WsKey;
         event: any;
     }) => void;
+    /** Received reply to websocket command (e.g. after subscribing to topics) */
     response: (response: any) => void;
+    /** Received data for topic */
     update: (response: any) => void;
-    errorEvent: (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;
@@ -36,19 +44,32 @@ export declare class WebsocketClient extends EventEmitter {
     private wsStore;
     constructor(options: WSClientConfigurableOptions, logger?: typeof DefaultLogger);
     /**
-     * Only used if we fetch exchange time before attempting auth.
-     * Disabled by default.
+     * 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: WsTopic[] | WsTopic, 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: WsTopic[] | WsTopic, isPrivateTopic?: boolean): void;
+    /**
+     * @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
      */
-    prepareRESTClient(): void;
+    private prepareRESTClient;
+    /** Get the WsStore that tracks websockets & topics */
+    getWsStore(): WsStore;
     isTestnet(): boolean;
-    close(wsKey: WsKey): void;
-    closeAll(): void;
+    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>[];
-    connectPublic(): Promise<WebSocket | undefined>;
+    connectPublic(): Promise<WebSocket | undefined>[];
     connectPrivate(): Promise<WebSocket | undefined>;
     private connect;
     private parseWsError;
@@ -64,11 +85,11 @@ export declare class WebsocketClient extends EventEmitter {
     private clearPingTimer;
     private clearPongTimer;
     /**
-     * Send WS message to subscribe to topics.
+     * @private Use the `subscribe(topics)` method to subscribe to topics. Send WS message to subscribe to topics.
      */
     private requestSubscribeTopics;
     /**
-     * Send WS message to unsubscribe from topics.
+     * @private Use the `unsubscribe(topics)` method to unsubscribe from topics. Send WS message to unsubscribe from topics.
      */
     private requestUnsubscribeTopics;
     tryWsSend(wsKey: WsKey, wsMessage: string): void;
@@ -81,18 +102,6 @@ export declare class WebsocketClient extends EventEmitter {
     private setWsState;
     private getWsUrl;
     private wrongMarketError;
-    /**
-     * Add topic/topics to WS subscription list
-     * @param wsTopics topic or list of topics
-     * @param isPrivateTopic optional - the library will try to detect private topics, you can use this to mark a topic as private (if the topic isn't recognised yet)
-     */
-    subscribe(wsTopics: WsTopic[] | WsTopic, isPrivateTopic?: boolean): void;
-    /**
-     * Remove topic/topics from WS subscription list
-     * @param wsTopics topic or list of topics
-     * @param isPrivateTopic optional - the library will try to detect private topics, you can use this to mark a topic as private (if the topic isn't recognised yet)
-     */
-    unsubscribe(wsTopics: WsTopic[] | WsTopic, isPrivateTopic?: boolean): void;
     /** @deprecated use "market: 'spotv3" client */
     subscribePublicSpotTrades(symbol: string, binary?: boolean): void;
     /** @deprecated use "market: 'spotv3" client */