bybit-api 2.3.2 → 2.4.0-beta.1

package/lib/util/BaseRestClient.js

@@ -16,12 +16,21 @@ const axios_1 = __importDefault(require("axios"));
 const node_support_1 = require("./node-support");
 const requestUtils_1 = require("./requestUtils");
 class BaseRestClient {
-    constructor(key, secret, baseUrl, options = {}, requestOptions = {}, clientType) {
+    /**
+     * Create an instance of the REST client
+     * @param {string} key - your API key
+     * @param {string} secret - your API secret
+     * @param {boolean} [useLivenet=false]
+     * @param {RestClientOptions} [restClientOptions={}] options to configure REST API connectivity
+     * @param {AxiosRequestConfig} [requestOptions={}] HTTP networking options for axios
+     */
+    constructor(key, secret, useLivenet = false, options = {}, requestOptions = {}) {
+        const baseUrl = requestUtils_1.getRestBaseUrl(useLivenet, options);
         this.timeOffset = null;
         this.syncTimePromise = null;
-        this.clientType = clientType;
+        this.clientType = this.getClientType();
         this.options = Object.assign({ recv_window: 5000, 
-            /** Throw errors if any params are undefined */
+            /** Throw errors if any request params are empty */
             strict_param_validation: false, 
             /** Disable time sync by default */
             enable_time_sync: false, 
@@ -30,7 +39,7 @@ class BaseRestClient {
         this.globalRequestOptions = Object.assign(Object.assign({ 
             // in ms == 5 minutes by default
             timeout: 1000 * 60 * 5 }, requestOptions), { headers: {
-                'x-referer': 'bybitapinode',
+                'x-referer': requestUtils_1.agentSource,
             } });
         this.baseUrl = baseUrl;
         if (key && !secret) {
@@ -46,6 +55,9 @@ class BaseRestClient {
     isSpotClient() {
         return this.clientType === requestUtils_1.REST_CLIENT_TYPE_ENUM.spot;
     }
+    isUSDCClient() {
+        return this.clientType === requestUtils_1.REST_CLIENT_TYPE_ENUM.v3;
+    }
     get(endpoint, params) {
         return this._call('GET', endpoint, params, true);
     }
@@ -61,7 +73,7 @@ class BaseRestClient {
     deletePrivate(endpoint, params) {
         return this._call('DELETE', endpoint, params, false);
     }
-    prepareSignParams(params, isPublicApi) {
+    prepareSignParams(method, signMethod, params, isPublicApi) {
         return __awaiter(this, void 0, void 0, function* () {
             if (isPublicApi) {
                 return {
@@ -75,27 +87,54 @@ class BaseRestClient {
             if (this.timeOffset === null) {
                 yield this.syncTime();
             }
-            return this.signRequest(params);
+            return this.signRequest(params, method, signMethod);
         });
     }
-    /**
-     * @private Make a HTTP request to a specific endpoint. Private endpoints are automatically signed.
-     */
-    _call(method, endpoint, params, isPublicApi) {
+    /** Returns an axios request object. Handles signing process automatically if this is a private API call */
+    buildRequest(method, url, params, isPublicApi) {
         return __awaiter(this, void 0, void 0, function* () {
-            const options = Object.assign(Object.assign({}, this.globalRequestOptions), { url: [this.baseUrl, endpoint].join(endpoint.startsWith('/') ? '' : '/'), method: method, json: true });
+            const options = Object.assign(Object.assign({}, this.globalRequestOptions), { url: url, method: method });
             for (const key in params) {
                 if (typeof params[key] === 'undefined') {
                     delete params[key];
                 }
             }
-            const signResult = yield this.prepareSignParams(params, isPublicApi);
-            if (method === 'GET' || this.isSpotClient()) {
-                options.params = signResult.paramsWithSign;
+            if (isPublicApi) {
+                return Object.assign(Object.assign({}, options), { params: params });
+            }
+            // USDC Options uses a different way of authenticating requests (headers instead of params)
+            if (this.isUSDCClient()) {
+                if (!options.headers) {
+                    options.headers = {};
+                }
+                const signResult = yield this.prepareSignParams(method, 'usdc', params, isPublicApi);
+                options.headers['X-BAPI-SIGN-TYPE'] = 2;
+                options.headers['X-BAPI-API-KEY'] = this.key;
+                options.headers['X-BAPI-TIMESTAMP'] = signResult.timestamp;
+                options.headers['X-BAPI-SIGN'] = signResult.sign;
+                options.headers['X-BAPI-RECV-WINDOW'] = signResult.recvWindow;
+                if (method === 'GET') {
+                    return Object.assign(Object.assign({}, options), { params: signResult.originalParams });
+                }
+                return Object.assign(Object.assign({}, options), { data: signResult.originalParams });
             }
-            else {
-                options.data = signResult.paramsWithSign;
+            const signResult = yield this.prepareSignParams(method, 'keyInBody', params, isPublicApi);
+            if (method === 'GET' || this.isSpotClient()) {
+                return Object.assign(Object.assign({}, options), { params: signResult.paramsWithSign });
             }
+            return Object.assign(Object.assign({}, options), { data: signResult.paramsWithSign });
+        });
+    }
+    /**
+     * @private Make a HTTP request to a specific endpoint. Private endpoints are automatically signed.
+     */
+    _call(method, endpoint, params, isPublicApi) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // Sanity check to make sure it's only ever prefixed by one forward slash
+            const requestUrl = [this.baseUrl, endpoint].join(endpoint.startsWith('/') ? '' : '/');
+            // Build a request and handle signature process
+            const options = yield this.buildRequest(method, requestUrl, params, isPublicApi);
+            // Dispatch request
             return axios_1.default(options)
                 .then((response) => {
                 if (response.status == 200) {
@@ -135,25 +174,50 @@ class BaseRestClient {
     /**
      * @private sign request and set recv window
      */
-    signRequest(data) {
+    signRequest(data, method, signMethod) {
         return __awaiter(this, void 0, void 0, function* () {
+            const timestamp = Date.now() + (this.timeOffset || 0);
             const res = {
-                originalParams: Object.assign(Object.assign({}, data), { api_key: this.key, timestamp: Date.now() + (this.timeOffset || 0) }),
+                originalParams: Object.assign({}, data),
                 sign: '',
+                timestamp,
+                recvWindow: 0,
+                serializedParams: '',
             };
-            // Optional, set to 5000 by default. Increase if timestamp/recv_window errors are seen.
-            if (this.options.recv_window && !res.originalParams.recv_window) {
-                if (this.isSpotClient()) {
-                    res.originalParams.recvWindow = this.options.recv_window;
-                }
-                else {
-                    res.originalParams.recv_window = this.options.recv_window;
-                }
+            if (!this.key || !this.secret) {
+                return res;
+            }
+            const key = this.key;
+            const recvWindow = res.originalParams.recv_window || this.options.recv_window || 5000;
+            const strictParamValidation = this.options.strict_param_validation;
+            // In case the parent function needs it (e.g. USDC uses a header)
+            res.recvWindow = recvWindow;
+            // usdc is different for some reason
+            if (signMethod === 'usdc') {
+                const signRequestParams = method === 'GET'
+                    ? requestUtils_1.serializeParams(res.originalParams, strictParamValidation)
+                    : JSON.stringify(res.originalParams);
+                const paramsStr = timestamp + key + recvWindow + signRequestParams;
+                res.sign = yield node_support_1.signMessage(paramsStr, this.secret);
+                return res;
             }
-            if (this.key && this.secret) {
-                const serializedParams = requestUtils_1.serializeParams(res.originalParams, this.options.strict_param_validation);
-                res.sign = yield node_support_1.signMessage(serializedParams, this.secret);
+            // spot/v2 derivatives
+            if (signMethod === 'keyInBody') {
+                res.originalParams.api_key = key;
+                res.originalParams.timestamp = timestamp;
+                // Optional, set to 5000 by default. Increase if timestamp/recv_window errors are seen.
+                if (recvWindow) {
+                    if (this.isSpotClient()) {
+                        res.originalParams.recvWindow = recvWindow;
+                    }
+                    else {
+                        res.originalParams.recv_window = recvWindow;
+                    }
+                }
+                res.serializedParams = requestUtils_1.serializeParams(res.originalParams, strictParamValidation);
+                res.sign = yield node_support_1.signMessage(res.serializedParams, this.secret);
                 res.paramsWithSign = Object.assign(Object.assign({}, res.originalParams), { sign: res.sign });
+                return res;
             }
             return res;
         });

package/lib/util/BaseRestClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"BaseRestClient.js","sourceRoot":"","sources":["../../src/util/BaseRestClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,kDAAyE;AAEzE,iDAA6C;AAC7C,iDAMwB;AA0BxB,MAA8B,cAAc;IAa1C,YACE,GAAuB,EACvB,MAA0B,EAC1B,OAAe,EACf,UAA6B,EAAE,EAC/B,iBAAqC,EAAE,EACvC,UAA0B;QAE1B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACvB,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;QAE5B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAE7B,IAAI,CAAC,OAAO,mBACV,WAAW,EAAE,IAAI;YAEjB,+CAA+C;YAC/C,uBAAuB,EAAE,KAAK;YAC9B,mCAAmC;YACnC,gBAAgB,EAAE,KAAK;YACvB,gFAAgF;YAChF,gBAAgB,EAAE,OAAO,IACtB,OAAO,CACX,CAAC;QAEF,IAAI,CAAC,oBAAoB;YACvB,gCAAgC;YAChC,OAAO,EAAE,IAAI,GAAG,EAAE,GAAG,CAAC,IAEnB,cAAc,KACjB,OAAO,EAAE;gBACP,WAAW,EAAE,cAAc;aAC5B,GACF,CAAC;QAEF,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAEvB,IAAI,GAAG,IAAI,CAAC,MAAM,EAAE;YAClB,MAAM,IAAI,KAAK,CACb,yDAAyD,CAC1D,CAAC;SACH;QAED,IAAI,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE;YACjC,IAAI,CAAC,QAAQ,EAAE,CAAC;YAChB,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAiB,CAAC,CAAC;SACxE;QAED,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAEO,YAAY;QAClB,OAAO,IAAI,CAAC,UAAU,KAAK,oCAAqB,CAAC,IAAI,CAAC;IACxD,CAAC;IAED,GAAG,CAAC,QAAgB,EAAE,MAAY;QAChC,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IACnD,CAAC;IAED,IAAI,CAAC,QAAgB,EAAE,MAAY;QACjC,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IACpD,CAAC;IAED,UAAU,CAAC,QAAgB,EAAE,MAAY;QACvC,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IACpD,CAAC;IAED,WAAW,CAAC,QAAgB,EAAE,MAAY;QACxC,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IACrD,CAAC;IAED,aAAa,CAAC,QAAgB,EAAE,MAAY;QAC1C,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IACvD,CAAC;IAEa,iBAAiB,CAAC,MAAY,EAAE,WAAqB;;YACjE,IAAI,WAAW,EAAE;gBACf,OAAO;oBACL,cAAc,EAAE,MAAM;oBACtB,cAAc,EAAE,MAAM;iBACvB,CAAC;aACH;YAED,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;gBAC7B,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;aACvE;YAED,IAAI,IAAI,CAAC,UAAU,KAAK,IAAI,EAAE;gBAC5B,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;aACvB;YAED,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAClC,CAAC;KAAA;IAED;;OAEG;IACW,KAAK,CACjB,MAAc,EACd,QAAgB,EAChB,MAAY,EACZ,WAAqB;;YAErB,MAAM,OAAO,mCACR,IAAI,CAAC,oBAAoB,KAC5B,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,EACvE,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,IAAI,GACX,CAAC;YAEF,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;gBACxB,IAAI,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,WAAW,EAAE;oBACtC,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;iBACpB;aACF;YAED,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;YAErE,IAAI,MAAM,KAAK,KAAK,IAAI,IAAI,CAAC,YAAY,EAAE,EAAE;gBAC3C,OAAO,CAAC,MAAM,GAAG,UAAU,CAAC,cAAc,CAAC;aAC5C;iBAAM;gBACL,OAAO,CAAC,IAAI,GAAG,UAAU,CAAC,cAAc,CAAC;aAC1C;YAED,OAAO,eAAK,CAAC,OAAO,CAAC;iBAClB,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;gBACjB,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE;oBAC1B,OAAO,QAAQ,CAAC,IAAI,CAAC;iBACtB;gBAED,MAAM,QAAQ,CAAC;YACjB,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1C,CAAC;KAAA;IAED;;OAEG;IACH,cAAc,CAAC,CAAM;QACnB,IAAI,IAAI,CAAC,OAAO,CAAC,gBAAgB,KAAK,KAAK,EAAE;YAC3C,MAAM,CAAC,CAAC;SACT;QAED,uEAAuE;QACvE,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE;YACf,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE;gBACd,MAAM,CAAC,CAAC,OAAO,CAAC;aACjB;YAED,wCAAwC;YACxC,MAAM,CAAC,CAAC;SACT;QAED,mEAAmE;QACnE,qCAAqC;QACrC,MAAM,QAAQ,GAAkB,CAAC,CAAC,QAAQ,CAAC;QAC3C,MAAM;YACJ,IAAI,EAAE,QAAQ,CAAC,MAAM;YACrB,OAAO,EAAE,QAAQ,CAAC,UAAU;YAC5B,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,OAAO,EAAE,QAAQ,CAAC,OAAO;YACzB,cAAc,EAAE,IAAI,CAAC,OAAO;SAC7B,CAAC;IACJ,CAAC;IAED;;OAEG;IACW,WAAW,CACvB,IAA8B;;YAE9B,MAAM,GAAG,GAAqB;gBAC5B,cAAc,kCACT,IAAI,KACP,OAAO,EAAE,IAAI,CAAC,GAAG,EACjB,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,CAAC,GAC/C;gBACD,IAAI,EAAE,EAAE;aACT,CAAC;YAEF,uFAAuF;YACvF,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,WAAW,EAAE;gBAC/D,IAAI,IAAI,CAAC,YAAY,EAAE,EAAE;oBACvB,GAAG,CAAC,cAAc,CAAC,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC;iBAC1D;qBAAM;oBACL,GAAG,CAAC,cAAc,CAAC,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC;iBAC3D;aACF;YAED,IAAI,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,MAAM,EAAE;gBAC3B,MAAM,gBAAgB,GAAG,8BAAe,CACtC,GAAG,CAAC,cAAc,EAClB,IAAI,CAAC,OAAO,CAAC,uBAAuB,CACrC,CAAC;gBACF,GAAG,CAAC,IAAI,GAAG,MAAM,0BAAW,CAAC,gBAAgB,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;gBAC5D,GAAG,CAAC,cAAc,mCACb,GAAG,CAAC,cAAc,KACrB,IAAI,EAAE,GAAG,CAAC,IAAI,GACf,CAAC;aACH;YAED,OAAO,GAAG,CAAC;QACb,CAAC;KAAA;IAED;;OAEG;IACK,QAAQ,CAAC,KAAe;QAC9B,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE;YAC5C,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC;YACpB,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;SAC/B;QAED,IAAI,IAAI,CAAC,eAAe,KAAK,IAAI,EAAE;YACjC,OAAO,IAAI,CAAC,eAAe,CAAC;SAC7B;QAED,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;YAC5D,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC;YACzB,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED;;OAEG;IACG,eAAe;;YACnB,IAAI;gBACF,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBACzB,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;gBAEhD,IAAI,CAAC,UAAU,IAAI,KAAK,CAAC,UAAU,CAAC,EAAE;oBACpC,MAAM,IAAI,KAAK,CACb,2CAA2C,UAAU,YAAY,OAAO,UAAU,GAAG,CACtF,CAAC;iBACH;gBAED,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBACvB,MAAM,WAAW,GAAG,UAAU,GAAG,IAAI,CAAC;gBAEtC,MAAM,QAAQ,GAAG,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;gBACnC,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,GAAG,GAAG,GAAG,QAAQ,CAAC,CAAC;aAChD;YAAC,OAAO,CAAC,EAAE;gBACV,OAAO,CAAC,KAAK,CAAC,mCAAmC,EAAE,CAAC,CAAC,CAAC;gBACtD,OAAO,CAAC,CAAC;aACV;QACH,CAAC;KAAA;CACF;AAvQD,iCAuQC"}
+{"version":3,"file":"BaseRestClient.js","sourceRoot":"","sources":["../../src/util/BaseRestClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,kDAAyE;AAEzE,iDAA6C;AAC7C,iDAOwB;AAoCxB,MAA8B,cAAc;IAgB1C;;;;;;;OAOG;IACH,YACE,GAAwB,EACxB,MAA2B,EAC3B,aAAsB,KAAK,EAC3B,UAA6B,EAAE,EAC/B,iBAAqC,EAAE;QAEvC,MAAM,OAAO,GAAG,6BAAc,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QACpD,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACvB,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;QAE5B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;QAEvC,IAAI,CAAC,OAAO,mBACV,WAAW,EAAE,IAAI;YACjB,mDAAmD;YACnD,uBAAuB,EAAE,KAAK;YAC9B,mCAAmC;YACnC,gBAAgB,EAAE,KAAK;YACvB,gFAAgF;YAChF,gBAAgB,EAAE,OAAO,IACtB,OAAO,CACX,CAAC;QAEF,IAAI,CAAC,oBAAoB;YACvB,gCAAgC;YAChC,OAAO,EAAE,IAAI,GAAG,EAAE,GAAG,CAAC,IAEnB,cAAc,KACjB,OAAO,EAAE;gBACP,WAAW,EAAE,0BAAW;aACzB,GACF,CAAC;QAEF,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAEvB,IAAI,GAAG,IAAI,CAAC,MAAM,EAAE;YAClB,MAAM,IAAI,KAAK,CACb,yDAAyD,CAC1D,CAAC;SACH;QAED,IAAI,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE;YACjC,IAAI,CAAC,QAAQ,EAAE,CAAC;YAChB,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAiB,CAAC,CAAC;SACxE;QAED,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAEO,YAAY;QAClB,OAAO,IAAI,CAAC,UAAU,KAAK,oCAAqB,CAAC,IAAI,CAAC;IACxD,CAAC;IAEO,YAAY;QAClB,OAAO,IAAI,CAAC,UAAU,KAAK,oCAAqB,CAAC,EAAE,CAAC;IACtD,CAAC;IAED,GAAG,CAAC,QAAgB,EAAE,MAAY;QAChC,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IACnD,CAAC;IAED,IAAI,CAAC,QAAgB,EAAE,MAAY;QACjC,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IACpD,CAAC;IAED,UAAU,CAAC,QAAgB,EAAE,MAAY;QACvC,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IACpD,CAAC;IAED,WAAW,CAAC,QAAgB,EAAE,MAAY;QACxC,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IACrD,CAAC;IAED,aAAa,CAAC,QAAgB,EAAE,MAAY;QAC1C,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IACvD,CAAC;IAca,iBAAiB,CAC7B,MAAc,EACd,UAAsB,EACtB,MAAgB,EAChB,WAAqB;;YAErB,IAAI,WAAW,EAAE;gBACf,OAAO;oBACL,cAAc,EAAE,MAAM;oBACtB,cAAc,EAAE,MAAM;iBACvB,CAAC;aACH;YAED,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;gBAC7B,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;aACvE;YAED,IAAI,IAAI,CAAC,UAAU,KAAK,IAAI,EAAE;gBAC5B,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;aACvB;YAED,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;QACtD,CAAC;KAAA;IAED,2GAA2G;IAC7F,YAAY,CACxB,MAAc,EACd,GAAW,EACX,MAAY,EACZ,WAAqB;;YAErB,MAAM,OAAO,mCACR,IAAI,CAAC,oBAAoB,KAC5B,GAAG,EAAE,GAAG,EACR,MAAM,EAAE,MAAM,GACf,CAAC;YAEF,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;gBACxB,IAAI,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,WAAW,EAAE;oBACtC,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;iBACpB;aACF;YAED,IAAI,WAAW,EAAE;gBACf,uCACK,OAAO,KACV,MAAM,EAAE,MAAM,IACd;aACH;YAED,2FAA2F;YAC3F,IAAI,IAAI,CAAC,YAAY,EAAE,EAAE;gBACvB,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;oBACpB,OAAO,CAAC,OAAO,GAAG,EAAE,CAAC;iBACtB;gBAED,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAC7C,MAAM,EACN,MAAM,EACN,MAAM,EACN,WAAW,CACZ,CAAC;gBAEF,OAAO,CAAC,OAAO,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;gBACxC,OAAO,CAAC,OAAO,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC;gBAC7C,OAAO,CAAC,OAAO,CAAC,kBAAkB,CAAC,GAAG,UAAU,CAAC,SAAS,CAAC;gBAC3D,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC;gBACjD,OAAO,CAAC,OAAO,CAAC,oBAAoB,CAAC,GAAG,UAAU,CAAC,UAAU,CAAC;gBAE9D,IAAI,MAAM,KAAK,KAAK,EAAE;oBACpB,uCACK,OAAO,KACV,MAAM,EAAE,UAAU,CAAC,cAAc,IACjC;iBACH;gBAED,uCACK,OAAO,KACV,IAAI,EAAE,UAAU,CAAC,cAAc,IAC/B;aACH;YAED,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAC7C,MAAM,EACN,WAAW,EACX,MAAM,EACN,WAAW,CACZ,CAAC;YAEF,IAAI,MAAM,KAAK,KAAK,IAAI,IAAI,CAAC,YAAY,EAAE,EAAE;gBAC3C,uCACK,OAAO,KACV,MAAM,EAAE,UAAU,CAAC,cAAc,IACjC;aACH;YAED,uCACK,OAAO,KACV,IAAI,EAAE,UAAU,CAAC,cAAc,IAC/B;QACJ,CAAC;KAAA;IAED;;OAEG;IACW,KAAK,CACjB,MAAc,EACd,QAAgB,EAChB,MAAY,EACZ,WAAqB;;YAErB,yEAAyE;YACzE,MAAM,UAAU,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,IAAI,CAC9C,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CACpC,CAAC;YAEF,+CAA+C;YAC/C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,YAAY,CACrC,MAAM,EACN,UAAU,EACV,MAAM,EACN,WAAW,CACZ,CAAC;YAEF,mBAAmB;YACnB,OAAO,eAAK,CAAC,OAAO,CAAC;iBAClB,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;gBACjB,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE;oBAC1B,OAAO,QAAQ,CAAC,IAAI,CAAC;iBACtB;gBAED,MAAM,QAAQ,CAAC;YACjB,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1C,CAAC;KAAA;IAED;;OAEG;IACH,cAAc,CAAC,CAAM;QACnB,IAAI,IAAI,CAAC,OAAO,CAAC,gBAAgB,KAAK,KAAK,EAAE;YAC3C,MAAM,CAAC,CAAC;SACT;QAED,uEAAuE;QACvE,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE;YACf,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE;gBACd,MAAM,CAAC,CAAC,OAAO,CAAC;aACjB;YAED,wCAAwC;YACxC,MAAM,CAAC,CAAC;SACT;QAED,mEAAmE;QACnE,qCAAqC;QACrC,MAAM,QAAQ,GAAkB,CAAC,CAAC,QAAQ,CAAC;QAC3C,MAAM;YACJ,IAAI,EAAE,QAAQ,CAAC,MAAM;YACrB,OAAO,EAAE,QAAQ,CAAC,UAAU;YAC5B,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,OAAO,EAAE,QAAQ,CAAC,OAAO;YACzB,cAAc,EAAE,IAAI,CAAC,OAAO;SAC7B,CAAC;IACJ,CAAC;IAED;;OAEG;IACW,WAAW,CACvB,IAAO,EACP,MAAc,EACd,UAAsB;;YAEtB,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,CAAC,CAAC;YAEtD,MAAM,GAAG,GAAqB;gBAC5B,cAAc,oBACT,IAAI,CACR;gBACD,IAAI,EAAE,EAAE;gBACR,SAAS;gBACT,UAAU,EAAE,CAAC;gBACb,gBAAgB,EAAE,EAAE;aACrB,CAAC;YAEF,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;gBAC7B,OAAO,GAAG,CAAC;aACZ;YACD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;YACrB,MAAM,UAAU,GACd,GAAG,CAAC,cAAc,CAAC,WAAW,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,IAAI,IAAI,CAAC;YACrE,MAAM,qBAAqB,GAAG,IAAI,CAAC,OAAO,CAAC,uBAAuB,CAAC;YAEnE,iEAAiE;YACjE,GAAG,CAAC,UAAU,GAAG,UAAU,CAAC;YAE5B,oCAAoC;YACpC,IAAI,UAAU,KAAK,MAAM,EAAE;gBACzB,MAAM,iBAAiB,GACrB,MAAM,KAAK,KAAK;oBACd,CAAC,CAAC,8BAAe,CAAC,GAAG,CAAC,cAAc,EAAE,qBAAqB,CAAC;oBAC5D,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;gBAEzC,MAAM,SAAS,GAAG,SAAS,GAAG,GAAG,GAAG,UAAU,GAAG,iBAAiB,CAAC;gBACnE,GAAG,CAAC,IAAI,GAAG,MAAM,0BAAW,CAAC,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;gBACrD,OAAO,GAAG,CAAC;aACZ;YAED,sBAAsB;YACtB,IAAI,UAAU,KAAK,WAAW,EAAE;gBAC9B,GAAG,CAAC,cAAc,CAAC,OAAO,GAAG,GAAG,CAAC;gBACjC,GAAG,CAAC,cAAc,CAAC,SAAS,GAAG,SAAS,CAAC;gBAEzC,uFAAuF;gBACvF,IAAI,UAAU,EAAE;oBACd,IAAI,IAAI,CAAC,YAAY,EAAE,EAAE;wBACvB,GAAG,CAAC,cAAc,CAAC,UAAU,GAAG,UAAU,CAAC;qBAC5C;yBAAM;wBACL,GAAG,CAAC,cAAc,CAAC,WAAW,GAAG,UAAU,CAAC;qBAC7C;iBACF;gBAED,GAAG,CAAC,gBAAgB,GAAG,8BAAe,CACpC,GAAG,CAAC,cAAc,EAClB,qBAAqB,CACtB,CAAC;gBACF,GAAG,CAAC,IAAI,GAAG,MAAM,0BAAW,CAAC,GAAG,CAAC,gBAAgB,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;gBAChE,GAAG,CAAC,cAAc,mCACb,GAAG,CAAC,cAAc,KACrB,IAAI,EAAE,GAAG,CAAC,IAAI,GACf,CAAC;gBACF,OAAO,GAAG,CAAC;aACZ;YAED,OAAO,GAAG,CAAC;QACb,CAAC;KAAA;IAED;;OAEG;IACK,QAAQ,CAAC,KAAe;QAC9B,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE;YAC5C,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC;YACpB,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;SAC/B;QAED,IAAI,IAAI,CAAC,eAAe,KAAK,IAAI,EAAE;YACjC,OAAO,IAAI,CAAC,eAAe,CAAC;SAC7B;QAED,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;YAC5D,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC;YACzB,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED;;OAEG;IACG,eAAe;;YACnB,IAAI;gBACF,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBACzB,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;gBAEhD,IAAI,CAAC,UAAU,IAAI,KAAK,CAAC,UAAU,CAAC,EAAE;oBACpC,MAAM,IAAI,KAAK,CACb,2CAA2C,UAAU,YAAY,OAAO,UAAU,GAAG,CACtF,CAAC;iBACH;gBAED,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBACvB,MAAM,WAAW,GAAG,UAAU,GAAG,IAAI,CAAC;gBAEtC,MAAM,QAAQ,GAAG,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;gBACnC,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,GAAG,GAAG,GAAG,QAAQ,CAAC,CAAC;aAChD;YAAC,OAAO,CAAC,EAAE;gBACV,OAAO,CAAC,KAAK,CAAC,mCAAmC,EAAE,CAAC,CAAC,CAAC;gBACtD,OAAO,CAAC,CAAC;aACV;QACH,CAAC;KAAA;CACF;AA9YD,iCA8YC"}

package/lib/util/WsStore.d.ts

@@ -1,30 +1,50 @@
-import { WsConnectionState } from '../websocket-client';
-import { DefaultLogger } from '../logger';
 import WebSocket from 'isomorphic-ws';
+import { DefaultLogger } from './logger';
+export declare enum WsConnectionStateEnum {
+    INITIAL = 0,
+    CONNECTING = 1,
+    CONNECTED = 2,
+    CLOSING = 3,
+    RECONNECTING = 4
+}
+/** A "topic" is always a string */
 declare type WsTopic = string;
+/**
+ * A "Set" is used to ensure we only subscribe to a topic once (tracking a list of unique topics we're expected to be connected to)
+ * TODO: do any WS topics allow parameters? If so, we need a way to track those (see FTX implementation)
+ */
 declare type WsTopicList = Set<WsTopic>;
 interface WsStoredState {
+    /** The currently active websocket connection */
     ws?: WebSocket;
-    connectionState?: WsConnectionState;
+    /** The current lifecycle state of the connection (enum) */
+    connectionState?: WsConnectionStateEnum;
+    /** A timer that will send an upstream heartbeat (ping) when it expires */
     activePingTimer?: ReturnType<typeof setTimeout> | undefined;
+    /** A timer tracking that an upstream heartbeat was sent, expecting a reply before it expires */
     activePongTimer?: ReturnType<typeof setTimeout> | undefined;
+    /**
+     * All the topics we are expected to be subscribed to (and we automatically resubscribe to if the connection drops)
+     */
     subscribedTopics: WsTopicList;
 }
 export default class WsStore {
     private wsState;
     private logger;
     constructor(logger: typeof DefaultLogger);
-    get(key: string, createIfMissing?: boolean): WsStoredState | undefined;
+    /** Get WS stored state for key, optionally create if missing */
+    get(key: string, createIfMissing?: true): WsStoredState;
+    get(key: string, createIfMissing?: false): WsStoredState | undefined;
     getKeys(): string[];
     create(key: string): WsStoredState | undefined;
     delete(key: string): void;
-    hasExistingActiveConnection(key: string): boolean | undefined;
+    hasExistingActiveConnection(key: string): boolean;
     getWs(key: string): WebSocket | undefined;
     setWs(key: string, wsConnection: WebSocket): WebSocket;
     isWsOpen(key: string): boolean;
-    getConnectionState(key: string): WsConnectionState;
-    setConnectionState(key: string, state: WsConnectionState): void;
-    isConnectionState(key: string, state: WsConnectionState): boolean;
+    getConnectionState(key: string): WsConnectionStateEnum;
+    setConnectionState(key: string, state: WsConnectionStateEnum): void;
+    isConnectionState(key: string, state: WsConnectionStateEnum): boolean;
     getTopics(key: string): WsTopicList;
     getTopicsByKey(): Record<string, WsTopicList>;
     addTopic(key: string, topic: WsTopic): WsTopicList;

package/lib/util/WsStore.js

@@ -1,7 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const websocket_client_1 = require("../websocket-client");
-const logger_1 = require("../logger");
+exports.WsConnectionStateEnum = void 0;
+const logger_1 = require("./logger");
+var WsConnectionStateEnum;
+(function (WsConnectionStateEnum) {
+    WsConnectionStateEnum[WsConnectionStateEnum["INITIAL"] = 0] = "INITIAL";
+    WsConnectionStateEnum[WsConnectionStateEnum["CONNECTING"] = 1] = "CONNECTING";
+    WsConnectionStateEnum[WsConnectionStateEnum["CONNECTED"] = 2] = "CONNECTED";
+    WsConnectionStateEnum[WsConnectionStateEnum["CLOSING"] = 3] = "CLOSING";
+    WsConnectionStateEnum[WsConnectionStateEnum["RECONNECTING"] = 4] = "RECONNECTING";
+})(WsConnectionStateEnum = exports.WsConnectionStateEnum || (exports.WsConnectionStateEnum = {}));
 class WsStore {
     constructor(logger) {
         this.logger = logger || logger_1.DefaultLogger;
@@ -24,7 +32,7 @@ class WsStore {
         }
         this.wsState[key] = {
             subscribedTopics: new Set(),
-            connectionState: websocket_client_1.WsConnectionState.READY_STATE_INITIAL,
+            connectionState: WsConnectionStateEnum.INITIAL,
         };
         return this.get(key);
     }

package/lib/util/WsStore.js.map

@@ -1 +1 @@
-{"version":3,"file":"WsStore.js","sourceRoot":"","sources":["../../src/util/WsStore.ts"],"names":[],"mappings":";;AAAA,0DAAwD;AACxD,sCAA0C;AAe1C,MAAqB,OAAO;IAI1B,YAAY,MAA4B;QACtC,IAAI,CAAC,MAAM,GAAG,MAAM,IAAI,sBAAa,CAAC;QACtC,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;IACpB,CAAC;IAED,GAAG,CAAC,GAAW,EAAE,eAAyB;QACxC,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACrB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;SAC1B;QAED,IAAI,eAAe,EAAE;YACnB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;SACzB;IACH,CAAC;IAED,OAAO;QACL,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACnC,CAAC;IAED,MAAM,CAAC,GAAW;QAChB,IAAI,IAAI,CAAC,2BAA2B,CAAC,GAAG,CAAC,EAAE;YACzC,IAAI,CAAC,MAAM,CAAC,OAAO,CACjB,gEAAgE,EAChE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAChB,CAAC;SACH;QACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG;YAClB,gBAAgB,EAAE,IAAI,GAAG,EAAE;YAC3B,eAAe,EAAE,oCAAiB,CAAC,mBAAmB;SACvD,CAAC;QACF,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IAED,MAAM,CAAC,GAAW;QAChB,IAAI,IAAI,CAAC,2BAA2B,CAAC,GAAG,CAAC,EAAE;YACzC,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC3B,IAAI,CAAC,MAAM,CAAC,OAAO,CACjB,oDAAoD,EACpD,EAAE,CACH,CAAC;YACF,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,KAAK,GAAG;SACb;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC3B,CAAC;IAED,0BAA0B;IAE1B,2BAA2B,CAAC,GAAW;QACrC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC7C,CAAC;IAED,KAAK,CAAC,GAAW;;QACf,aAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,0CAAE,EAAE,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,GAAW,EAAE,YAAuB;QACxC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YACtB,IAAI,CAAC,MAAM,CAAC,OAAO,CACjB,gEAAgE,EAChE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAChB,CAAC;SACH;QACD,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAE,CAAC,EAAE,GAAG,YAAY,CAAC;QACvC,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,sBAAsB;IAEtB,QAAQ,CAAC,GAAW;QAClB,MAAM,kBAAkB,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC3C,OAAO,CACL,CAAC,CAAC,kBAAkB;YACpB,kBAAkB,CAAC,UAAU,KAAK,kBAAkB,CAAC,IAAI,CAC1D,CAAC;IACJ,CAAC;IAED,kBAAkB,CAAC,GAAW;QAC5B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAE,CAAC,eAAgB,CAAC;IAC/C,CAAC;IAED,kBAAkB,CAAC,GAAW,EAAE,KAAwB;QACtD,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAE,CAAC,eAAe,GAAG,KAAK,CAAC;IAC/C,CAAC;IAED,iBAAiB,CAAC,GAAW,EAAE,KAAwB;QACrD,OAAO,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,KAAK,KAAK,CAAC;IAChD,CAAC;IAED,uBAAuB;IAEvB,SAAS,CAAC,GAAW;QACnB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAE,CAAC,gBAAgB,CAAC;IAC/C,CAAC;IAED,cAAc;QACZ,MAAM,MAAM,GAAG,EAAE,CAAC;QAClB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE;YACjC,MAAM,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;SACzC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,QAAQ,CAAC,GAAW,EAAE,KAAc;QAClC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACxC,CAAC;IAED,WAAW,CAAC,GAAW,EAAE,KAAc;QACrC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC;CACF;AAjHD,0BAiHC"}
+{"version":3,"file":"WsStore.js","sourceRoot":"","sources":["../../src/util/WsStore.ts"],"names":[],"mappings":";;;AAEA,qCAAyC;AAEzC,IAAY,qBAMX;AAND,WAAY,qBAAqB;IAC/B,uEAAW,CAAA;IACX,6EAAc,CAAA;IACd,2EAAa,CAAA;IACb,uEAAW,CAAA;IACX,iFAAgB,CAAA;AAClB,CAAC,EANW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAMhC;AAyBD,MAAqB,OAAO;IAI1B,YAAY,MAA4B;QACtC,IAAI,CAAC,MAAM,GAAG,MAAM,IAAI,sBAAa,CAAC;QACtC,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;IACpB,CAAC;IAKD,GAAG,CAAC,GAAW,EAAE,eAAyB;QACxC,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACrB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;SAC1B;QAED,IAAI,eAAe,EAAE;YACnB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;SACzB;IACH,CAAC;IAED,OAAO;QACL,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACnC,CAAC;IAED,MAAM,CAAC,GAAW;QAChB,IAAI,IAAI,CAAC,2BAA2B,CAAC,GAAG,CAAC,EAAE;YACzC,IAAI,CAAC,MAAM,CAAC,OAAO,CACjB,gEAAgE,EAChE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAChB,CAAC;SACH;QACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG;YAClB,gBAAgB,EAAE,IAAI,GAAG,EAAE;YAC3B,eAAe,EAAE,qBAAqB,CAAC,OAAO;SAC/C,CAAC;QACF,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IAED,MAAM,CAAC,GAAW;QAChB,IAAI,IAAI,CAAC,2BAA2B,CAAC,GAAG,CAAC,EAAE;YACzC,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC3B,IAAI,CAAC,MAAM,CAAC,OAAO,CACjB,oDAAoD,EACpD,EAAE,CACH,CAAC;YACF,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,KAAK,GAAG;SACb;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC3B,CAAC;IAED,0BAA0B;IAE1B,2BAA2B,CAAC,GAAW;QACrC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC7C,CAAC;IAED,KAAK,CAAC,GAAW;;QACf,aAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,0CAAE,EAAE,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,GAAW,EAAE,YAAuB;QACxC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YACtB,IAAI,CAAC,MAAM,CAAC,OAAO,CACjB,gEAAgE,EAChE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAChB,CAAC;SACH;QACD,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAE,CAAC,EAAE,GAAG,YAAY,CAAC;QACvC,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,sBAAsB;IAEtB,QAAQ,CAAC,GAAW;QAClB,MAAM,kBAAkB,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC3C,OAAO,CACL,CAAC,CAAC,kBAAkB;YACpB,kBAAkB,CAAC,UAAU,KAAK,kBAAkB,CAAC,IAAI,CAC1D,CAAC;IACJ,CAAC;IAED,kBAAkB,CAAC,GAAW;QAC5B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAE,CAAC,eAAgB,CAAC;IAC/C,CAAC;IAED,kBAAkB,CAAC,GAAW,EAAE,KAA4B;QAC1D,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAE,CAAC,eAAe,GAAG,KAAK,CAAC;IAC/C,CAAC;IAED,iBAAiB,CAAC,GAAW,EAAE,KAA4B;QACzD,OAAO,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,KAAK,KAAK,CAAC;IAChD,CAAC;IAED,uBAAuB;IAEvB,SAAS,CAAC,GAAW;QACnB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,gBAAgB,CAAC;IAC9C,CAAC;IAED,cAAc;QACZ,MAAM,MAAM,GAAG,EAAE,CAAC;QAClB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE;YACjC,MAAM,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;SACzC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,QAAQ,CAAC,GAAW,EAAE,KAAc;QAClC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACxC,CAAC;IAED,WAAW,CAAC,GAAW,EAAE,KAAc;QACrC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC;CACF;AApHD,0BAoHC"}

package/lib/util/index.d.ts

@@ -0,0 +1,5 @@
+export * from './BaseRestClient';
+export * from './requestUtils';
+export * from './WsStore';
+export * from './logger';
+export * from './websocket-util';

package/lib/util/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./BaseRestClient"), exports);
+__exportStar(require("./requestUtils"), exports);
+__exportStar(require("./WsStore"), exports);
+__exportStar(require("./logger"), exports);
+__exportStar(require("./websocket-util"), exports);
+//# sourceMappingURL=index.js.map

package/lib/util/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/util/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mDAAiC;AACjC,iDAA+B;AAC/B,4CAA0B;AAC1B,2CAAyB;AACzB,mDAAiC"}

package/lib/util/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/util/logger.ts"],"names":[],"mappings":";;;AAEa,QAAA,aAAa,GAAG;IAC3B,KAAK,EAAE,CAAC,GAAG,MAAiB,EAAQ,EAAE;QACpC,uBAAuB;IACzB,CAAC;IACD,KAAK,EAAE,CAAC,GAAG,MAAiB,EAAQ,EAAE;QACpC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACtB,CAAC;IACD,MAAM,EAAE,CAAC,GAAG,MAAiB,EAAQ,EAAE;QACrC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACtB,CAAC;IACD,IAAI,EAAE,CAAC,GAAG,MAAiB,EAAQ,EAAE;QACnC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACvB,CAAC;IACD,OAAO,EAAE,CAAC,GAAG,MAAiB,EAAQ,EAAE;QACtC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACxB,CAAC;IACD,KAAK,EAAE,CAAC,GAAG,MAAiB,EAAQ,EAAE;QACpC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACxB,CAAC;CACF,CAAC"}

package/lib/util/requestUtils.d.ts

@@ -19,13 +19,17 @@ export interface RestClientOptions {
 }
 export declare function serializeParams(params?: object, strict_validation?: boolean): string;
 export declare function getRestBaseUrl(useLivenet: boolean, restInverseOptions: RestClientOptions): string;
-export declare function isPublicEndpoint(endpoint: string): boolean;
 export declare function isWsPong(response: any): any;
 export declare const agentSource = "bybitapinode";
+/**
+ * Used to switch how authentication/requests work under the hood (primarily for SPOT since it's different there)
+ */
 export declare const REST_CLIENT_TYPE_ENUM: {
+    readonly accountAsset: "accountAsset";
     readonly inverse: "inverse";
     readonly inverseFutures: "inverseFutures";
     readonly linear: "linear";
     readonly spot: "spot";
+    readonly v3: "v3";
 };
 export declare type RestClientType = typeof REST_CLIENT_TYPE_ENUM[keyof typeof REST_CLIENT_TYPE_ENUM];

package/lib/util/requestUtils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.REST_CLIENT_TYPE_ENUM = exports.agentSource = exports.isWsPong = exports.isPublicEndpoint = exports.getRestBaseUrl = exports.serializeParams = void 0;
+exports.REST_CLIENT_TYPE_ENUM = exports.agentSource = exports.isWsPong = exports.getRestBaseUrl = exports.serializeParams = void 0;
 function serializeParams(params = {}, strict_validation = false) {
     return Object.keys(params)
         .sort()
@@ -15,7 +15,7 @@ function serializeParams(params = {}, strict_validation = false) {
 }
 exports.serializeParams = serializeParams;
 function getRestBaseUrl(useLivenet, restInverseOptions) {
-    const baseUrlsInverse = {
+    const exchangeBaseUrls = {
         livenet: 'https://api.bybit.com',
         testnet: 'https://api-testnet.bybit.com',
     };
@@ -23,27 +23,11 @@ function getRestBaseUrl(useLivenet, restInverseOptions) {
         return restInverseOptions.baseUrl;
     }
     if (useLivenet === true) {
-        return baseUrlsInverse.livenet;
+        return exchangeBaseUrls.livenet;
     }
-    return baseUrlsInverse.testnet;
+    return exchangeBaseUrls.testnet;
 }
 exports.getRestBaseUrl = getRestBaseUrl;
-function isPublicEndpoint(endpoint) {
-    const publicPrefixes = [
-        'v2/public',
-        'public/linear',
-        'spot/quote/v1',
-        'spot/v1/symbols',
-        'spot/v1/time',
-    ];
-    for (const prefix of publicPrefixes) {
-        if (endpoint.startsWith(prefix)) {
-            return true;
-        }
-    }
-    return false;
-}
-exports.isPublicEndpoint = isPublicEndpoint;
 function isWsPong(response) {
     if (response.pong || response.ping) {
         return true;
@@ -55,10 +39,15 @@ function isWsPong(response) {
 }
 exports.isWsPong = isWsPong;
 exports.agentSource = 'bybitapinode';
+/**
+ * Used to switch how authentication/requests work under the hood (primarily for SPOT since it's different there)
+ */
 exports.REST_CLIENT_TYPE_ENUM = {
+    accountAsset: 'accountAsset',
     inverse: 'inverse',
     inverseFutures: 'inverseFutures',
     linear: 'linear',
     spot: 'spot',
+    v3: 'v3',
 };
 //# sourceMappingURL=requestUtils.js.map

package/lib/util/requestUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"requestUtils.js","sourceRoot":"","sources":["../../src/util/requestUtils.ts"],"names":[],"mappings":";;;AA0BA,SAAgB,eAAe,CAC7B,SAAiB,EAAE,EACnB,iBAAiB,GAAG,KAAK;IAEzB,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;SACvB,IAAI,EAAE;SACN,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACX,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAC1B,IAAI,iBAAiB,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,WAAW,EAAE;YAC9D,MAAM,IAAI,KAAK,CACb,uDAAuD,CACxD,CAAC;SACH;QACD,OAAO,GAAG,GAAG,IAAI,KAAK,EAAE,CAAC;IAC3B,CAAC,CAAC;SACD,IAAI,CAAC,GAAG,CAAC,CAAC;AACf,CAAC;AAhBD,0CAgBC;AAED,SAAgB,cAAc,CAC5B,UAAmB,EACnB,kBAAqC;IAErC,MAAM,eAAe,GAAG;QACtB,OAAO,EAAE,uBAAuB;QAChC,OAAO,EAAE,+BAA+B;KACzC,CAAC;IAEF,IAAI,kBAAkB,CAAC,OAAO,EAAE;QAC9B,OAAO,kBAAkB,CAAC,OAAO,CAAC;KACnC;IAED,IAAI,UAAU,KAAK,IAAI,EAAE;QACvB,OAAO,eAAe,CAAC,OAAO,CAAC;KAChC;IACD,OAAO,eAAe,CAAC,OAAO,CAAC;AACjC,CAAC;AAjBD,wCAiBC;AAED,SAAgB,gBAAgB,CAAC,QAAgB;IAC/C,MAAM,cAAc,GAAG;QACrB,WAAW;QACX,eAAe;QACf,eAAe;QACf,iBAAiB;QACjB,cAAc;KACf,CAAC;IAEF,KAAK,MAAM,MAAM,IAAI,cAAc,EAAE;QACnC,IAAI,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;YAC/B,OAAO,IAAI,CAAC;SACb;KACF;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAfD,4CAeC;AAED,SAAgB,QAAQ,CAAC,QAAa;IACpC,IAAI,QAAQ,CAAC,IAAI,IAAI,QAAQ,CAAC,IAAI,EAAE;QAClC,OAAO,IAAI,CAAC;KACb;IACD,OAAO,CACL,QAAQ,CAAC,OAAO;QAChB,QAAQ,CAAC,OAAO,CAAC,EAAE,KAAK,MAAM;QAC9B,QAAQ,CAAC,OAAO,KAAK,MAAM;QAC3B,QAAQ,CAAC,OAAO,KAAK,IAAI,CAC1B,CAAC;AACJ,CAAC;AAVD,4BAUC;AAEY,QAAA,WAAW,GAAG,cAAc,CAAC;AAE7B,QAAA,qBAAqB,GAAG;IACnC,OAAO,EAAE,SAAS;IAClB,cAAc,EAAE,gBAAgB;IAChC,MAAM,EAAE,QAAQ;IAChB,IAAI,EAAE,MAAM;CACJ,CAAC"}
+{"version":3,"file":"requestUtils.js","sourceRoot":"","sources":["../../src/util/requestUtils.ts"],"names":[],"mappings":";;;AA0BA,SAAgB,eAAe,CAC7B,SAAiB,EAAE,EACnB,iBAAiB,GAAG,KAAK;IAEzB,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;SACvB,IAAI,EAAE;SACN,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACX,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAC1B,IAAI,iBAAiB,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,WAAW,EAAE;YAC9D,MAAM,IAAI,KAAK,CACb,uDAAuD,CACxD,CAAC;SACH;QACD,OAAO,GAAG,GAAG,IAAI,KAAK,EAAE,CAAC;IAC3B,CAAC,CAAC;SACD,IAAI,CAAC,GAAG,CAAC,CAAC;AACf,CAAC;AAhBD,0CAgBC;AAED,SAAgB,cAAc,CAC5B,UAAmB,EACnB,kBAAqC;IAErC,MAAM,gBAAgB,GAAG;QACvB,OAAO,EAAE,uBAAuB;QAChC,OAAO,EAAE,+BAA+B;KACzC,CAAC;IAEF,IAAI,kBAAkB,CAAC,OAAO,EAAE;QAC9B,OAAO,kBAAkB,CAAC,OAAO,CAAC;KACnC;IAED,IAAI,UAAU,KAAK,IAAI,EAAE;QACvB,OAAO,gBAAgB,CAAC,OAAO,CAAC;KACjC;IACD,OAAO,gBAAgB,CAAC,OAAO,CAAC;AAClC,CAAC;AAjBD,wCAiBC;AAED,SAAgB,QAAQ,CAAC,QAAa;IACpC,IAAI,QAAQ,CAAC,IAAI,IAAI,QAAQ,CAAC,IAAI,EAAE;QAClC,OAAO,IAAI,CAAC;KACb;IACD,OAAO,CACL,QAAQ,CAAC,OAAO;QAChB,QAAQ,CAAC,OAAO,CAAC,EAAE,KAAK,MAAM;QAC9B,QAAQ,CAAC,OAAO,KAAK,MAAM;QAC3B,QAAQ,CAAC,OAAO,KAAK,IAAI,CAC1B,CAAC;AACJ,CAAC;AAVD,4BAUC;AAEY,QAAA,WAAW,GAAG,cAAc,CAAC;AAE1C;;GAEG;AACU,QAAA,qBAAqB,GAAG;IACnC,YAAY,EAAE,cAAc;IAC5B,OAAO,EAAE,SAAS;IAClB,cAAc,EAAE,gBAAgB;IAChC,MAAM,EAAE,QAAQ;IAChB,IAAI,EAAE,MAAM;IACZ,EAAE,EAAE,IAAI;CACA,CAAC"}

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

@@ -0,0 +1,8 @@
+import { WsKey } from '../types';
+export declare const wsKeyInverse = "inverse";
+export declare const wsKeyLinearPrivate = "linearPrivate";
+export declare const wsKeyLinearPublic = "linearPublic";
+export declare const wsKeySpotPrivate = "spotPrivate";
+export declare const wsKeySpotPublic = "spotPublic";
+export declare function getLinearWsKeyForTopic(topic: string): WsKey;
+export declare function getSpotWsKeyForTopic(topic: string): WsKey;

package/lib/util/websocket-util.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSpotWsKeyForTopic = exports.getLinearWsKeyForTopic = exports.wsKeySpotPublic = exports.wsKeySpotPrivate = exports.wsKeyLinearPublic = exports.wsKeyLinearPrivate = exports.wsKeyInverse = void 0;
+exports.wsKeyInverse = 'inverse';
+exports.wsKeyLinearPrivate = 'linearPrivate';
+exports.wsKeyLinearPublic = 'linearPublic';
+exports.wsKeySpotPrivate = 'spotPrivate';
+exports.wsKeySpotPublic = 'spotPublic';
+function getLinearWsKeyForTopic(topic) {
+    const privateLinearTopics = [
+        'position',
+        'execution',
+        'order',
+        'stop_order',
+        'wallet',
+    ];
+    if (privateLinearTopics.includes(topic)) {
+        return exports.wsKeyLinearPrivate;
+    }
+    return exports.wsKeyLinearPublic;
+}
+exports.getLinearWsKeyForTopic = getLinearWsKeyForTopic;
+function getSpotWsKeyForTopic(topic) {
+    const privateLinearTopics = [
+        'position',
+        'execution',
+        'order',
+        'stop_order',
+        'outboundAccountInfo',
+        'executionReport',
+        'ticketInfo',
+    ];
+    if (privateLinearTopics.includes(topic)) {
+        return exports.wsKeySpotPrivate;
+    }
+    return exports.wsKeySpotPublic;
+}
+exports.getSpotWsKeyForTopic = getSpotWsKeyForTopic;
+//# sourceMappingURL=websocket-util.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"websocket-util.js","sourceRoot":"","sources":["../../src/util/websocket-util.ts"],"names":[],"mappings":";;;AAEa,QAAA,YAAY,GAAG,SAAS,CAAC;AACzB,QAAA,kBAAkB,GAAG,eAAe,CAAC;AACrC,QAAA,iBAAiB,GAAG,cAAc,CAAC;AACnC,QAAA,gBAAgB,GAAG,aAAa,CAAC;AACjC,QAAA,eAAe,GAAG,YAAY,CAAC;AAE5C,SAAgB,sBAAsB,CAAC,KAAa;IAClD,MAAM,mBAAmB,GAAG;QAC1B,UAAU;QACV,WAAW;QACX,OAAO;QACP,YAAY;QACZ,QAAQ;KACT,CAAC;IACF,IAAI,mBAAmB,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;QACvC,OAAO,0BAAkB,CAAC;KAC3B;IAED,OAAO,yBAAiB,CAAC;AAC3B,CAAC;AAbD,wDAaC;AAED,SAAgB,oBAAoB,CAAC,KAAa;IAChD,MAAM,mBAAmB,GAAG;QAC1B,UAAU;QACV,WAAW;QACX,OAAO;QACP,YAAY;QACZ,qBAAqB;QACrB,iBAAiB;QACjB,YAAY;KACb,CAAC;IAEF,IAAI,mBAAmB,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;QACvC,OAAO,wBAAgB,CAAC;KACzB;IAED,OAAO,uBAAe,CAAC;AACzB,CAAC;AAhBD,oDAgBC"}

package/lib/websocket-client.d.ts

@@ -1,62 +1,8 @@
 /// <reference types="node" />
 import { EventEmitter } from 'events';
 import WebSocket from 'isomorphic-ws';
-import { DefaultLogger } from './logger';
-import { KlineInterval } from './types/shared';
-import { RestClientOptions } from './util/requestUtils';
-export declare enum WsConnectionState {
-    READY_STATE_INITIAL = 0,
-    READY_STATE_CONNECTING = 1,
-    READY_STATE_CONNECTED = 2,
-    READY_STATE_CLOSING = 3,
-    READY_STATE_RECONNECTING = 4
-}
-export declare type APIMarket = 'inverse' | 'linear' | 'spot';
-export declare type WsPublicInverseTopic = 'orderBookL2_25' | 'orderBookL2_200' | 'trade' | 'insurance' | 'instrument_info' | 'klineV2';
-export declare type WsPublicUSDTPerpTopic = 'orderBookL2_25' | 'orderBookL2_200' | 'trade' | 'insurance' | 'instrument_info' | 'kline';
-export declare type WsPublicSpotV1Topic = 'trade' | 'realtimes' | 'kline' | 'depth' | 'mergedDepth' | 'diffDepth';
-export declare type WsPublicSpotV2Topic = 'depth' | 'kline' | 'trade' | 'bookTicker' | 'realtimes';
-export declare type WsPublicTopics = WsPublicInverseTopic | WsPublicUSDTPerpTopic | WsPublicSpotV1Topic | WsPublicSpotV2Topic | string;
-export declare type WsPrivateInverseTopic = 'position' | 'execution' | 'order' | 'stop_order';
-export declare type WsPrivateUSDTPerpTopic = 'position' | 'execution' | 'order' | 'stop_order' | 'wallet';
-export declare type WsPrivateSpotTopic = 'outboundAccountInfo' | 'executionReport' | 'ticketInfo';
-export declare type WsPrivateTopic = WsPrivateInverseTopic | WsPrivateUSDTPerpTopic | WsPrivateSpotTopic | string;
-export declare type WsTopic = WsPublicTopics | WsPrivateTopic;
-export interface WSClientConfigurableOptions {
-    key?: string;
-    secret?: string;
-    livenet?: boolean;
-    /**
-     * @deprecated Use the property { market: 'linear' } instead
-     */
-    linear?: boolean;
-    market?: APIMarket;
-    pongTimeout?: number;
-    pingInterval?: number;
-    reconnectTimeout?: number;
-    restOptions?: RestClientOptions;
-    requestOptions?: any;
-    wsUrl?: string;
-    /** If true, fetch server time before trying to authenticate (disabled by default) */
-    fetchTimeOffsetBeforeAuth?: boolean;
-}
-export interface WebsocketClientOptions extends WSClientConfigurableOptions {
-    livenet: boolean;
-    /**
-     * @deprecated Use the property { market: 'linear' } instead
-     */
-    linear?: boolean;
-    market?: APIMarket;
-    pongTimeout: number;
-    pingInterval: number;
-    reconnectTimeout: number;
-}
-export declare const wsKeyInverse = "inverse";
-export declare const wsKeyLinearPrivate = "linearPrivate";
-export declare const wsKeyLinearPublic = "linearPublic";
-export declare const wsKeySpotPrivate = "spotPrivate";
-export declare const wsKeySpotPublic = "spotPublic";
-export declare type WsKey = 'inverse' | 'linearPrivate' | 'linearPublic' | 'spotPrivate' | 'spotPublic';
+import { DefaultLogger } from './util/logger';
+import { KlineInterval, WSClientConfigurableOptions, WsKey, WsTopic } from './types';
 export declare interface WebsocketClient {
     on(event: 'open' | 'reconnected', listener: ({ wsKey: WsKey, event: any }: {
         wsKey: any;
@@ -69,6 +15,7 @@ export declare interface WebsocketClient {
 }
 export declare class WebsocketClient extends EventEmitter {
     private logger;
+    /** Purely used */
     private restClient;
     private options;
     private wsStore;
@@ -77,6 +24,8 @@ export declare class WebsocketClient extends EventEmitter {
     isLinear(): boolean;
     isSpot(): boolean;
     isInverse(): boolean;
+    /** USDC, spot v3, unified margin, account asset */
+    isV3(): boolean;
     /**
      * Add topic/topics to WS subscription list
      */
@@ -87,7 +36,7 @@ export declare class WebsocketClient extends EventEmitter {
     unsubscribe(wsTopics: WsTopic[] | WsTopic): void;
     close(wsKey: WsKey): void;
     /**
-     * Request connection of all dependent websockets, instead of waiting for automatic connection by library
+     * Request connection of all dependent (public & private) websockets, instead of waiting for automatic connection by library
      */
     connectAll(): Promise<WebSocket | undefined>[] | undefined;
     connectPublic(): Promise<WebSocket | undefined> | undefined;
@@ -118,7 +67,6 @@ export declare class WebsocketClient extends EventEmitter {
     private onWsError;
     private onWsClose;
     private onWsMessageResponse;
-    private onWsMessageUpdate;
     private getWs;
     private setWsState;
     private getWsUrl;