binance 2.15.14 → 3.0.0-beta.1

package/lib/util/websockets/listen-key-state-cache.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListenKeyStateCache = void 0;
+const logger_1 = require("../logger");
+class ListenKeyStateCache {
+    constructor(customLogger) {
+        this.listenKeyStateStore = {};
+        this.logger = customLogger || logger_1.DefaultLogger;
+    }
+    getListenKeyState(listenKey, market) {
+        const state = this.listenKeyStateStore[listenKey];
+        if (state) {
+            return state;
+        }
+        // this.logger.trace(
+        //   `--> getListenKeyState(${market}) -> CREATED NEW listenKeyState for ${listenKey}`,
+        // );
+        this.listenKeyStateStore[listenKey] = {
+            market,
+            lastKeepAlive: 0,
+            keepAliveTimer: undefined,
+            keepAliveRetryTimer: undefined,
+            keepAliveFailures: 0,
+        };
+        return this.listenKeyStateStore[listenKey];
+    }
+    clearUserDataKeepAliveTimer(listenKey) {
+        const state = this.listenKeyStateStore[listenKey];
+        if (!state) {
+            // this.logger.trace(
+            //   `clearUserDataKeepAliveTimer() -> No listenKeyState found for ${listenKey}`,
+            // );
+            return;
+        }
+        if (state.keepAliveTimer) {
+            // this.logger.trace(
+            //   `----> clearUserDataKeepAliveTimer() -> CLEARED old listenKey keepAlive INTERVAL timer for ${listenKey}`,
+            // );
+            clearInterval(state.keepAliveTimer);
+        }
+        else {
+            // this.logger.trace(
+            //   `----> clearUserDataKeepAliveTimer() -> No listen key keepAlive INTERVAL timer to clear for ${listenKey}`,
+            // );
+        }
+        if (state.keepAliveRetryTimer) {
+            // this.logger.trace(
+            //   `----> clearUserDataKeepAliveTimer() -> CLEARED old listen key keepAlive RETRY timer for ${listenKey}`,
+            // );
+            clearTimeout(state.keepAliveRetryTimer);
+        }
+        else {
+            // this.logger.trace(
+            //   `----> clearUserDataKeepAliveTimer() -> No keepAlive RETRY timer to clear for ${listenKey}`,
+            // );
+        }
+    }
+    /**
+     * Remove all state for listen key. Clears timers too, if any exist on this listen key store.
+     */
+    clearAllListenKeyState(listenKey) {
+        // this.logger.trace(
+        //   `clearAllListenKeyState() -> Checking whether we need to clear timers and remove state for ${listenKey}`,
+        // );
+        this.clearUserDataKeepAliveTimer(listenKey);
+        if (this.listenKeyStateStore[listenKey]) {
+            // this.logger.trace(
+            //   `-> clearAllListenKeyState() -> CLEARED ALL listen key state for ${listenKey}`,
+            // );
+        }
+        else {
+            // this.logger.trace(
+            //   `-> clearAllListenKeyState() -> No listen key state to clear ${listenKey}`,
+            // );
+        }
+        delete this.listenKeyStateStore[listenKey];
+    }
+}
+exports.ListenKeyStateCache = ListenKeyStateCache;
+//# sourceMappingURL=listen-key-state-cache.js.map

package/lib/util/websockets/listen-key-state-cache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"listen-key-state-cache.js","sourceRoot":"","sources":["../../../src/util/websockets/listen-key-state-cache.ts"],"names":[],"mappings":";;;AACA,sCAA0C;AAU1C,MAAa,mBAAmB;IAK9B,YAAY,YAA4B;QAFhC,wBAAmB,GAA8C,EAAE,CAAC;QAG1E,IAAI,CAAC,MAAM,GAAG,YAAY,IAAI,sBAAa,CAAC;IAC9C,CAAC;IAEM,iBAAiB,CACtB,SAAiB,EACjB,MAAgB;QAEhB,MAAM,KAAK,GAAG,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,KAAK,EAAE,CAAC;YACV,OAAO,KAAK,CAAC;QACf,CAAC;QAED,qBAAqB;QACrB,uFAAuF;QACvF,KAAK;QACL,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,GAAG;YACpC,MAAM;YACN,aAAa,EAAE,CAAC;YAChB,cAAc,EAAE,SAAS;YACzB,mBAAmB,EAAE,SAAS;YAC9B,iBAAiB,EAAE,CAAC;SACrB,CAAC;QACF,OAAO,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;IAC7C,CAAC;IAEO,2BAA2B,CAAC,SAAiB;QACnD,MAAM,KAAK,GAAG,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,qBAAqB;YACrB,iFAAiF;YACjF,KAAK;YACL,OAAO;QACT,CAAC;QAED,IAAI,KAAK,CAAC,cAAc,EAAE,CAAC;YACzB,qBAAqB;YACrB,8GAA8G;YAC9G,KAAK;YACL,aAAa,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QACtC,CAAC;aAAM,CAAC;YACN,qBAAqB;YACrB,+GAA+G;YAC/G,KAAK;QACP,CAAC;QAED,IAAI,KAAK,CAAC,mBAAmB,EAAE,CAAC;YAC9B,qBAAqB;YACrB,4GAA4G;YAC5G,KAAK;YACL,YAAY,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;QAC1C,CAAC;aAAM,CAAC;YACN,qBAAqB;YACrB,iGAAiG;YACjG,KAAK;QACP,CAAC;IACH,CAAC;IAED;;OAEG;IACI,sBAAsB,CAAC,SAAiB;QAC7C,qBAAqB;QACrB,8GAA8G;QAC9G,KAAK;QACL,IAAI,CAAC,2BAA2B,CAAC,SAAS,CAAC,CAAC;QAE5C,IAAI,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,EAAE,CAAC;YACxC,qBAAqB;YACrB,oFAAoF;YACpF,KAAK;QACP,CAAC;aAAM,CAAC;YACN,qBAAqB;YACrB,gFAAgF;YAChF,KAAK;QACP,CAAC;QAED,OAAO,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;IAC7C,CAAC;CACF;AApFD,kDAoFC"}

package/lib/util/websockets/rest-client-cache.d.ts

@@ -0,0 +1,13 @@
+import { AxiosRequestConfig } from 'axios';
+import { CoinMClient } from '../../coinm-client';
+import { MainClient } from '../../main-client';
+import { PortfolioClient } from '../../portfolio-client';
+import { USDMClient } from '../../usdm-client';
+import { RestClientOptions } from '../requestUtils';
+export declare class RestClientCache {
+    private restClients;
+    getSpotRestClient(restOptions: RestClientOptions, requestOptions?: AxiosRequestConfig, isTestnet?: boolean): MainClient;
+    getUSDMRestClient(restOptions: RestClientOptions, requestOptions?: AxiosRequestConfig, isTestnet?: boolean): USDMClient;
+    getCOINMRestClient(restOptions: RestClientOptions, requestOptions?: AxiosRequestConfig, isTestnet?: boolean): CoinMClient;
+    getPortfolioClient(restOptions: RestClientOptions, requestOptions?: AxiosRequestConfig): PortfolioClient;
+}

package/lib/util/websockets/rest-client-cache.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RestClientCache = void 0;
+const coinm_client_1 = require("../../coinm-client");
+const main_client_1 = require("../../main-client");
+const portfolio_client_1 = require("../../portfolio-client");
+const usdm_client_1 = require("../../usdm-client");
+class RestClientCache {
+    constructor() {
+        this.restClients = {};
+    }
+    getSpotRestClient(restOptions, requestOptions, isTestnet) {
+        if (isTestnet) {
+            if (!this.restClients.spotTestnet) {
+                this.restClients.spotTestnet = new main_client_1.MainClient(Object.assign(Object.assign({}, restOptions), { useTestnet: true }), requestOptions);
+            }
+            return this.restClients.spotTestnet;
+        }
+        if (!this.restClients.spot) {
+            this.restClients.spot = new main_client_1.MainClient(restOptions, requestOptions);
+        }
+        return this.restClients.spot;
+    }
+    getUSDMRestClient(restOptions, requestOptions, isTestnet) {
+        if (isTestnet) {
+            if (!this.restClients.usdmFuturesTestnet) {
+                this.restClients.usdmFuturesTestnet = new usdm_client_1.USDMClient(restOptions, requestOptions, isTestnet);
+            }
+            return this.restClients.usdmFuturesTestnet;
+        }
+        if (!this.restClients.usdmFutures) {
+            this.restClients.usdmFutures = new usdm_client_1.USDMClient(restOptions, requestOptions);
+        }
+        return this.restClients.usdmFutures;
+    }
+    getCOINMRestClient(restOptions, requestOptions, isTestnet) {
+        if (isTestnet) {
+            if (!this.restClients.coinmFuturesTestnet) {
+                this.restClients.coinmFuturesTestnet = new coinm_client_1.CoinMClient(restOptions, requestOptions, isTestnet);
+            }
+            return this.restClients.coinmFuturesTestnet;
+        }
+        if (!this.restClients.coinmFutures) {
+            this.restClients.coinmFutures = new coinm_client_1.CoinMClient(restOptions, requestOptions);
+        }
+        return this.restClients.coinmFutures;
+    }
+    getPortfolioClient(restOptions, requestOptions) {
+        if (!this.restClients.portfolio) {
+            this.restClients.portfolio = new portfolio_client_1.PortfolioClient(restOptions, requestOptions);
+        }
+        return this.restClients.portfolio;
+    }
+}
+exports.RestClientCache = RestClientCache;
+//# sourceMappingURL=rest-client-cache.js.map

package/lib/util/websockets/rest-client-cache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rest-client-cache.js","sourceRoot":"","sources":["../../../src/util/websockets/rest-client-cache.ts"],"names":[],"mappings":";;;AAEA,qDAAiD;AACjD,mDAA+C;AAC/C,6DAAyD;AACzD,mDAA+C;AAe/C,MAAa,eAAe;IAA5B;QACU,gBAAW,GAA6B,EAAE,CAAC;IAoFrD,CAAC;IAlFQ,iBAAiB,CACtB,WAA8B,EAC9B,cAAmC,EACnC,SAAmB;QAEnB,IAAI,SAAS,EAAE,CAAC;YACd,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,CAAC;gBAClC,IAAI,CAAC,WAAW,CAAC,WAAW,GAAG,IAAI,wBAAU,iCACtC,WAAW,KAAE,UAAU,EAAE,IAAI,KAClC,cAAc,CACf,CAAC;YACJ,CAAC;YACD,OAAO,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC;QACtC,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;YAC3B,IAAI,CAAC,WAAW,CAAC,IAAI,GAAG,IAAI,wBAAU,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;QACtE,CAAC;QACD,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IAC/B,CAAC;IAEM,iBAAiB,CACtB,WAA8B,EAC9B,cAAmC,EACnC,SAAmB;QAEnB,IAAI,SAAS,EAAE,CAAC;YACd,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,kBAAkB,EAAE,CAAC;gBACzC,IAAI,CAAC,WAAW,CAAC,kBAAkB,GAAG,IAAI,wBAAU,CAClD,WAAW,EACX,cAAc,EACd,SAAS,CACV,CAAC;YACJ,CAAC;YACD,OAAO,IAAI,CAAC,WAAW,CAAC,kBAAkB,CAAC;QAC7C,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,CAAC;YAClC,IAAI,CAAC,WAAW,CAAC,WAAW,GAAG,IAAI,wBAAU,CAC3C,WAAW,EACX,cAAc,CACf,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC;IACtC,CAAC;IAEM,kBAAkB,CACvB,WAA8B,EAC9B,cAAmC,EACnC,SAAmB;QAEnB,IAAI,SAAS,EAAE,CAAC;YACd,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,mBAAmB,EAAE,CAAC;gBAC1C,IAAI,CAAC,WAAW,CAAC,mBAAmB,GAAG,IAAI,0BAAW,CACpD,WAAW,EACX,cAAc,EACd,SAAS,CACV,CAAC;YACJ,CAAC;YACD,OAAO,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAAC;QAC9C,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE,CAAC;YACnC,IAAI,CAAC,WAAW,CAAC,YAAY,GAAG,IAAI,0BAAW,CAC7C,WAAW,EACX,cAAc,CACf,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC;IACvC,CAAC;IAEM,kBAAkB,CACvB,WAA8B,EAC9B,cAAmC;QAEnC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,CAAC;YAChC,IAAI,CAAC,WAAW,CAAC,SAAS,GAAG,IAAI,kCAAe,CAC9C,WAAW,EACX,cAAc,CACf,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC;IACpC,CAAC;CACF;AArFD,0CAqFC"}

package/lib/util/websockets/user-data-stream-manager.d.ts

@@ -0,0 +1,54 @@
+import { WebsocketClientOptions, WsMarket } from '../../types/websockets/ws-general';
+import { DefaultLogger } from '../logger';
+import { RestClientOptions } from '../requestUtils';
+import { RestClientCache } from './rest-client-cache';
+import { MiscUserDataConnectionState, WsKey, WsTopicRequest } from './websocket-util';
+import { WsStore } from './WsStore';
+import { WSConnectedResult } from './WsStore.types';
+export interface UserDataStreamManagerConfig {
+    logger: DefaultLogger;
+    wsStore: WsStore<WsKey, WsTopicRequest<string>>;
+    restClientCache: RestClientCache;
+    /** Fn pointers so we don't have direct access to the WS client */
+    respawnUserDataFn: (wsKey: WsKey, market: WsMarket, context: {
+        symbol?: string;
+        isTestnet?: boolean;
+        respawnAttempt?: number;
+    }) => Promise<void>;
+    getWsUrlFn(wsKey: WsKey, connectionType: 'market' | 'userData' | 'wsAPI'): Promise<string>;
+    getRestClientOptionsFn: () => RestClientOptions;
+    getWsClientOptionsfn: () => WebsocketClientOptions;
+    closeWsFn: (wsKey: WsKey, force?: boolean) => any;
+    connectFn: (wsKey: WsKey, customUrl?: string | undefined, throwOnError?: boolean) => Promise<WSConnectedResult | undefined>;
+}
+/**
+ * A minimal attempt at separating all the user data stream handling workflows from
+ * the rest of the WS Client logic.
+ *
+ * This abstraction handles:
+ *
+ * - spawning the ws connection with the listen key
+ * - tracking metadata for a connection & the embedded listen key
+ * - handling listen key keep-alive triggers
+ * - handling ws respawn with listen key checks
+ */
+export declare class UserDataStreamManager {
+    private logger;
+    private listenKeyStateCache;
+    private wsStore;
+    private restClientCache;
+    private respawnUserDataStream;
+    private closeWsFn;
+    private connectFn;
+    private getWsUrlFn;
+    private getRestClientOptionsFn;
+    private getWsClientOptionsfn;
+    constructor(config: UserDataStreamManagerConfig);
+    getWsStore(): WsStore<WsKey, WsTopicRequest<string, unknown>>;
+    subscribeGeneralUserDataStreamWithListenKey(wsKey: WsKey, market: WsMarket, listenKey: string, forceNewConnection?: boolean, miscState?: MiscUserDataConnectionState): Promise<WSConnectedResult | undefined>;
+    private setKeepAliveListenKeyTimer;
+    private checkKeepAliveListenKey;
+    teardownUserDataListenKey(listenKey?: string, ws?: WebSocket): void;
+    triggerUserDataReconnectionWorkflow(legacyWsKey: string): Promise<void>;
+    private sendKeepAliveForMarket;
+}

package/lib/util/websockets/user-data-stream-manager.js

@@ -0,0 +1,256 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserDataStreamManager = void 0;
+const typeGuards_1 = require("../typeGuards");
+const listen_key_state_cache_1 = require("./listen-key-state-cache");
+const websocket_util_1 = require("./websocket-util");
+const WsStore_types_1 = require("./WsStore.types");
+/**
+ * A minimal attempt at separating all the user data stream handling workflows from
+ * the rest of the WS Client logic.
+ *
+ * This abstraction handles:
+ *
+ * - spawning the ws connection with the listen key
+ * - tracking metadata for a connection & the embedded listen key
+ * - handling listen key keep-alive triggers
+ * - handling ws respawn with listen key checks
+ */
+class UserDataStreamManager {
+    constructor(config) {
+        this.logger = config.logger;
+        this.wsStore = config.wsStore;
+        this.restClientCache = config.restClientCache;
+        this.respawnUserDataStream = config.respawnUserDataFn;
+        this.closeWsFn = config.closeWsFn;
+        this.connectFn = config.connectFn;
+        this.getWsUrlFn = config.getWsUrlFn;
+        this.getRestClientOptionsFn = config.getRestClientOptionsFn;
+        this.getWsClientOptionsfn = config.getWsClientOptionsfn;
+        this.listenKeyStateCache = new listen_key_state_cache_1.ListenKeyStateCache(this.logger);
+        // this.wsClient = config.wsClient;
+    }
+    // getWSClient(): WebsocketClient {
+    //   return this.wsClient;
+    // }
+    getWsStore() {
+        return this.wsStore;
+    }
+    subscribeGeneralUserDataStreamWithListenKey(wsKey, market, listenKey, forceNewConnection, miscState) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const streamName = 'userData';
+            const symbol = undefined;
+            this.logger.trace('subscribeGeneralUserDataStreamWithListenKey(): ', {
+                wsKey,
+                market,
+                listenKey,
+                forceNewConnection,
+                miscState,
+            });
+            const derivedWsKey = (0, websocket_util_1.getLegacyWsStoreKeyWithContext)(market, streamName, symbol, listenKey, wsKey);
+            const wsState = this.getWsStore().get(derivedWsKey, true);
+            if (!forceNewConnection &&
+                this.getWsStore().isConnectionAttemptInProgress(derivedWsKey)) {
+                const stateLastChangedAt = wsState === null || wsState === void 0 ? void 0 : wsState.connectionStateChangedAt;
+                const timestamp = stateLastChangedAt === null || stateLastChangedAt === void 0 ? void 0 : stateLastChangedAt.getTime();
+                const timestampNow = new Date().getTime();
+                const stateChangedTimeAgo = timestampNow - (timestamp || NaN);
+                this.logger.trace(`Existing ${wsKey} user data connection in progress for listen key. Avoiding duplicate`, { stateLastChangedAt, stateChangedTimeAgo, wsKey, derivedWsKey });
+                return this.getWsStore().getWs(derivedWsKey);
+            }
+            // Prepare the WS state for awareness whether this is a reconnect or fresh connect
+            if (miscState === null || miscState === void 0 ? void 0 : miscState.isReconnecting) {
+                this.getWsStore().setConnectionState(derivedWsKey, WsStore_types_1.WsConnectionStateEnum.RECONNECTING);
+            }
+            // Begin the connection process with the active listen key
+            try {
+                const wsBaseUrl = yield this.getWsUrlFn(wsKey, 'userData');
+                const wsURL = wsBaseUrl + `/${listenKey}`;
+                const throwOnConnectionError = true;
+                const connectResult = yield this.connectFn(derivedWsKey, wsURL, throwOnConnectionError);
+                if (!connectResult) {
+                    this.logger.error('Exception in user data manager, connection error? ', { wsBaseUrl, wsURL, connectResult });
+                    throw new Error('userDataManager->subscribeGeneral()-> connection error?');
+                }
+                // Start & store timer to keep alive listen key (and handle expiration)
+                this.setKeepAliveListenKeyTimer(listenKey, market, connectResult.ws, derivedWsKey);
+                return connectResult.ws;
+            }
+            catch (e) {
+                this.logger.error('Exception in subscribeGeneralUserDataStreamWithListenKey()', Object.assign(Object.assign({}, websocket_util_1.WS_LOGGER_CATEGORY), { wsKey, derivedWsKey, e: (e === null || e === void 0 ? void 0 : e.stack) || e }));
+                // In case any timers already exist, pre-wipe
+                this.listenKeyStateCache.clearAllListenKeyState(listenKey);
+                // So the next attempt doesn't think an attempt is already in progress
+                this.getWsStore().setConnectionState(derivedWsKey, WsStore_types_1.WsConnectionStateEnum.ERROR);
+                throw e;
+            }
+        });
+    }
+    setKeepAliveListenKeyTimer(listenKey, market, ws, wsKey, symbol, isTestnet) {
+        // This MUST happen before fetching listenKey state,
+        // since the getListenKeyState() creates new state,
+        // while clearAllListenKeyState DELETES it
+        this.listenKeyStateCache.clearAllListenKeyState(listenKey);
+        const listenKeyState = this.listenKeyStateCache.getListenKeyState(listenKey, market);
+        // this.logger.trace(
+        //   `----> setKeepAliveListenKeyTimer() -> CREATED NEW keepAliveListenKey INTERVAL timer for ${listenKey}`,
+        // );
+        // Set timer to keep WS alive every 50 minutes
+        const minutes50 = 1000 * 60 * 50;
+        listenKeyState.keepAliveTimer = setInterval(() => this.checkKeepAliveListenKey(listenKey, market, ws, wsKey, symbol, isTestnet), minutes50);
+    }
+    checkKeepAliveListenKey(listenKey, market, ws, derivedWsKey, symbol, isTestnet) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const listenKeyState = this.listenKeyStateCache.getListenKeyState(listenKey, market);
+            const wsKey = (0, websocket_util_1.getRealWsKeyFromDerivedWsKey)(derivedWsKey);
+            try {
+                if (listenKeyState.keepAliveRetryTimer) {
+                    clearTimeout(listenKeyState.keepAliveRetryTimer);
+                    listenKeyState.keepAliveRetryTimer = undefined;
+                    this.logger.trace(`checkKeepAliveListenKey() -> CLEARED old one-off keepAliveRetryTimer timer for ${listenKey}`);
+                }
+                yield this.sendKeepAliveForMarket(listenKey, market, ws, wsKey, derivedWsKey, symbol, isTestnet);
+                listenKeyState.lastKeepAlive = Date.now();
+                listenKeyState.keepAliveFailures = 0;
+                this.logger.info(`Completed keep alive cycle for listenKey(${listenKey}) in market(${market})`, Object.assign(Object.assign({}, websocket_util_1.WS_LOGGER_CATEGORY), { listenKey }));
+            }
+            catch (e) {
+                listenKeyState.keepAliveFailures++;
+                // Reconnect follows a less automatic workflow since this is tied to a listen key (which may need a new one).
+                // - Kill connection first, with instruction NOT to reconnect automatically
+                // - Then respawn a connection with a potentially new listen key (since the old one may be invalid now)
+                const shouldReconnectAfterClose = false;
+                // code: -1125,
+                // message: 'This listenKey does not exist.',
+                const errorCode = e === null || e === void 0 ? void 0 : e.code;
+                if (errorCode === -1125) {
+                    this.logger.error('FATAL: Failed to keep WS alive for listen key - listen key expired/invalid. Respawning with fresh listen key...', Object.assign(Object.assign({}, websocket_util_1.WS_LOGGER_CATEGORY), { listenKey, error: e, errorCode, errorMsg: e === null || e === void 0 ? void 0 : e.message }));
+                    this.closeWsFn(derivedWsKey, shouldReconnectAfterClose);
+                    this.respawnUserDataStream(wsKey, market, { symbol, isTestnet });
+                    return;
+                }
+                // If max failurees reached, tear down and respawn if allowed
+                if (listenKeyState.keepAliveFailures >= 3) {
+                    this.logger.error('FATAL: Failed to keep WS alive for listen key after 3 attempts', Object.assign(Object.assign({}, websocket_util_1.WS_LOGGER_CATEGORY), { listenKey, error: e }));
+                    this.closeWsFn(derivedWsKey, shouldReconnectAfterClose);
+                    this.respawnUserDataStream(wsKey, market, { symbol, isTestnet });
+                    return;
+                }
+                const reconnectDelaySeconds = 1000 * 15;
+                this.logger.info(`Userdata keep alive request failed due to error, trying again with short delay (${reconnectDelaySeconds} seconds)`, Object.assign(Object.assign({}, websocket_util_1.WS_LOGGER_CATEGORY), { listenKey, error: e, keepAliveAttempts: listenKeyState.keepAliveFailures }));
+                this.logger.trace(`checkKeepAliveListenKey() -> CREATED NEW one-off keepAliveRetryTimer  timer for ${listenKey}`);
+                listenKeyState.keepAliveRetryTimer = setTimeout(() => this.checkKeepAliveListenKey(listenKey, market, ws, derivedWsKey, symbol), reconnectDelaySeconds);
+            }
+        });
+    }
+    teardownUserDataListenKey(listenKey, ws) {
+        if (listenKey) {
+            this.listenKeyStateCache.clearAllListenKeyState(listenKey);
+            (0, websocket_util_1.safeTerminateWs)(ws, true);
+        }
+    }
+    triggerUserDataReconnectionWorkflow(legacyWsKey) {
+        return __awaiter(this, void 0, void 0, function* () {
+            console.log(`triggerCustomReconnectionWorkflow(${legacyWsKey})`);
+            if (legacyWsKey.includes('userData')) {
+                const legacyWsKeyContext = (0, websocket_util_1.getLegacyWsKeyContext)(legacyWsKey);
+                if (!legacyWsKeyContext) {
+                    throw new Error(`triggerCustomReconnectionWorkflow(): no context found in supplied wsKey: "${legacyWsKey}"`);
+                }
+                const { market, symbol, isTestnet, listenKey, wsKey } = legacyWsKeyContext;
+                this.logger.info('Preparing to reconnect userData stream...', Object.assign(Object.assign({}, websocket_util_1.WS_LOGGER_CATEGORY), { legacyWsKey,
+                    market,
+                    symbol,
+                    isTestnet,
+                    listenKey,
+                    wsKey }));
+                if (listenKey) {
+                    this.logger.trace('Checking if old listenKey has active timers...', {
+                        listenKey,
+                    });
+                    this.listenKeyStateCache.clearAllListenKeyState(listenKey);
+                }
+                else {
+                    throw new Error('No listenKey stashed in legacyWsKey context???');
+                }
+                this.logger.info('Reconnecting to user data stream...', Object.assign(Object.assign(Object.assign({}, websocket_util_1.WS_LOGGER_CATEGORY), legacyWsKeyContext), { wsKey,
+                    market,
+                    symbol }));
+                // We'll set a new one once the new stream respawns, it might have a diff listenKey in the wsKey
+                this.getWsStore().delete(legacyWsKey);
+                if (!wsKey) {
+                    const errorMessage = 'triggerCustomReconnectionWorkflow(): missing real "wsKey" from legacy context';
+                    this.logger.error(errorMessage, {
+                        legacyWsKeyContext,
+                        legacyWsKey,
+                    });
+                    throw new Error(errorMessage);
+                }
+                this.respawnUserDataStream(wsKey, market, {
+                    symbol,
+                    isTestnet,
+                });
+                return;
+            }
+        });
+    }
+    sendKeepAliveForMarket(listenKey, market, ws, wsKey, deriedWsKey, symbol, isTestnet) {
+        switch (market) {
+            case 'spot':
+                return this.restClientCache
+                    .getSpotRestClient(this.getRestClientOptionsFn(), this.getWsClientOptionsfn().requestOptions)
+                    .keepAliveSpotUserDataListenKey(listenKey);
+            case 'spotTestnet':
+                return this.restClientCache
+                    .getSpotRestClient(this.getRestClientOptionsFn(), this.getWsClientOptionsfn().requestOptions, true)
+                    .keepAliveSpotUserDataListenKey(listenKey);
+            case 'crossMargin':
+                return this.restClientCache
+                    .getSpotRestClient(this.getRestClientOptionsFn(), this.getWsClientOptionsfn().requestOptions)
+                    .keepAliveMarginUserDataListenKey(listenKey);
+            case 'riskDataMargin':
+                return this.restClientCache
+                    .getSpotRestClient(this.getRestClientOptionsFn(), this.getWsClientOptionsfn().requestOptions)
+                    .keepAliveMarginRiskUserDataListenKey(listenKey);
+            case 'isolatedMargin':
+                return this.restClientCache
+                    .getSpotRestClient(this.getRestClientOptionsFn(), this.getWsClientOptionsfn().requestOptions)
+                    .keepAliveIsolatedMarginUserDataListenKey({
+                    listenKey,
+                    symbol: symbol,
+                });
+            case 'coinm':
+            case 'options':
+            case 'optionsTestnet':
+            case 'usdm':
+                return this.restClientCache
+                    .getUSDMRestClient(this.getRestClientOptionsFn(), this.getWsClientOptionsfn().requestOptions)
+                    .keepAliveFuturesUserDataListenKey();
+            case 'usdmTestnet':
+                return this.restClientCache
+                    .getUSDMRestClient(this.getRestClientOptionsFn(), this.getWsClientOptionsfn().requestOptions, isTestnet)
+                    .keepAliveFuturesUserDataListenKey();
+            case 'coinmTestnet':
+                return this.restClientCache
+                    .getCOINMRestClient(this.getRestClientOptionsFn(), this.getWsClientOptionsfn().requestOptions, isTestnet)
+                    .keepAliveFuturesUserDataListenKey();
+            case 'portfoliom':
+                return this.restClientCache
+                    .getPortfolioClient(this.getRestClientOptionsFn(), this.getWsClientOptionsfn().requestOptions)
+                    .keepAlivePMUserDataListenKey();
+            default:
+                throw (0, typeGuards_1.neverGuard)(market, `Failed to send keep alive for user data stream in unhandled market ${market}`);
+        }
+    }
+}
+exports.UserDataStreamManager = UserDataStreamManager;
+//# sourceMappingURL=user-data-stream-manager.js.map

package/lib/util/websockets/user-data-stream-manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-data-stream-manager.js","sourceRoot":"","sources":["../../../src/util/websockets/user-data-stream-manager.ts"],"names":[],"mappings":";;;;;;;;;;;;AAMA,8CAA2C;AAC3C,qEAA+D;AAE/D,qDAS0B;AAE1B,mDAA2E;AAmC3E;;;;;;;;;;GAUG;AACH,MAAa,qBAAqB;IAqBhC,YAAY,MAAmC;QAC7C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,eAAe,CAAC;QAC9C,IAAI,CAAC,qBAAqB,GAAG,MAAM,CAAC,iBAAiB,CAAC;QACtD,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;QAClC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;QAClC,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;QACpC,IAAI,CAAC,sBAAsB,GAAG,MAAM,CAAC,sBAAsB,CAAC;QAC5D,IAAI,CAAC,oBAAoB,GAAG,MAAM,CAAC,oBAAoB,CAAC;QAExD,IAAI,CAAC,mBAAmB,GAAG,IAAI,4CAAmB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAEhE,mCAAmC;IACrC,CAAC;IAED,mCAAmC;IACnC,0BAA0B;IAC1B,IAAI;IAEJ,UAAU;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAEY,2CAA2C,CACtD,KAAY,EACZ,MAAgB,EAChB,SAAiB,EACjB,kBAA4B,EAC5B,SAAuC;;YAEvC,MAAM,UAAU,GAAG,UAAU,CAAC;YAC9B,MAAM,MAAM,GAAG,SAAS,CAAC;YAEzB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,iDAAiD,EAAE;gBACnE,KAAK;gBACL,MAAM;gBACN,SAAS;gBACT,kBAAkB;gBAClB,SAAS;aACV,CAAC,CAAC;YAEH,MAAM,YAAY,GAAG,IAAA,+CAA8B,EACjD,MAAM,EACN,UAAU,EACV,MAAM,EACN,SAAS,EACT,KAAK,CACN,CAAC;YAEF,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC,GAAG,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;YAC1D,IACE,CAAC,kBAAkB;gBACnB,IAAI,CAAC,UAAU,EAAE,CAAC,6BAA6B,CAAC,YAAY,CAAC,EAC7D,CAAC;gBACD,MAAM,kBAAkB,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,wBAAwB,CAAC;gBAC7D,MAAM,SAAS,GAAG,kBAAkB,aAAlB,kBAAkB,uBAAlB,kBAAkB,CAAE,OAAO,EAAE,CAAC;gBAChD,MAAM,YAAY,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;gBAE1C,MAAM,mBAAmB,GAAG,YAAY,GAAG,CAAC,SAAS,IAAI,GAAG,CAAC,CAAC;gBAE9D,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,YAAY,KAAK,sEAAsE,EACvF,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,KAAK,EAAE,YAAY,EAAE,CACjE,CAAC;gBACF,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YAC/C,CAAC;YAED,kFAAkF;YAClF,IAAI,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,cAAc,EAAE,CAAC;gBAC9B,IAAI,CAAC,UAAU,EAAE,CAAC,kBAAkB,CAClC,YAAY,EACZ,qCAAqB,CAAC,YAAY,CACnC,CAAC;YACJ,CAAC;YAED,0DAA0D;YAC1D,IAAI,CAAC;gBACH,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;gBAC3D,MAAM,KAAK,GAAG,SAAS,GAAG,IAAI,SAAS,EAAE,CAAC;gBAE1C,MAAM,sBAAsB,GAAG,IAAI,CAAC;gBACpC,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,SAAS,CACxC,YAAY,EACZ,KAAK,EACL,sBAAsB,CACvB,CAAC;gBAEF,IAAI,CAAC,aAAa,EAAE,CAAC;oBACnB,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,oDAAoD,EACpD,EAAE,SAAS,EAAE,KAAK,EAAE,aAAa,EAAE,CACpC,CAAC;oBACF,MAAM,IAAI,KAAK,CACb,yDAAyD,CAC1D,CAAC;gBACJ,CAAC;gBAED,uEAAuE;gBACvE,IAAI,CAAC,0BAA0B,CAC7B,SAAS,EACT,MAAM,EACN,aAAa,CAAC,EAAE,EAChB,YAAY,CACb,CAAC;gBAEF,OAAO,aAAa,CAAC,EAAE,CAAC;YAC1B,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,4DAA4D,kCACvD,mCAAkB,KAAE,KAAK,EAAE,YAAY,EAAE,CAAC,EAAE,CAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,KAAK,KAAI,CAAC,IAC/D,CAAC;gBAEF,6CAA6C;gBAC7C,IAAI,CAAC,mBAAmB,CAAC,sBAAsB,CAAC,SAAS,CAAC,CAAC;gBAE3D,sEAAsE;gBACtE,IAAI,CAAC,UAAU,EAAE,CAAC,kBAAkB,CAClC,YAAY,EACZ,qCAAqB,CAAC,KAAK,CAC5B,CAAC;gBAEF,MAAM,CAAC,CAAC;YACV,CAAC;QACH,CAAC;KAAA;IAEO,0BAA0B,CAChC,SAAiB,EACjB,MAAgB,EAChB,EAAa,EACb,KAAY,EACZ,MAAe,EACf,SAAmB;QAEnB,oDAAoD;QACpD,mDAAmD;QACnD,0CAA0C;QAC1C,IAAI,CAAC,mBAAmB,CAAC,sBAAsB,CAAC,SAAS,CAAC,CAAC;QAE3D,MAAM,cAAc,GAAG,IAAI,CAAC,mBAAmB,CAAC,iBAAiB,CAC/D,SAAS,EACT,MAAM,CACP,CAAC;QAEF,qBAAqB;QACrB,4GAA4G;QAC5G,KAAK;QAEL,8CAA8C;QAC9C,MAAM,SAAS,GAAG,IAAI,GAAG,EAAE,GAAG,EAAE,CAAC;QACjC,cAAc,CAAC,cAAc,GAAG,WAAW,CACzC,GAAG,EAAE,CACH,IAAI,CAAC,uBAAuB,CAC1B,SAAS,EACT,MAAM,EACN,EAAE,EACF,KAAK,EACL,MAAM,EACN,SAAS,CACV,EACH,SAAS,CAEV,CAAC;IACJ,CAAC;IAEa,uBAAuB,CACnC,SAAiB,EACjB,MAAgB,EAChB,EAAa,EACb,YAAmB,EACnB,MAAe,EACf,SAAmB;;YAEnB,MAAM,cAAc,GAAG,IAAI,CAAC,mBAAmB,CAAC,iBAAiB,CAC/D,SAAS,EACT,MAAM,CACP,CAAC;YAEF,MAAM,KAAK,GAAG,IAAA,6CAA4B,EAAC,YAAY,CAAC,CAAC;YAEzD,IAAI,CAAC;gBACH,IAAI,cAAc,CAAC,mBAAmB,EAAE,CAAC;oBACvC,YAAY,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC;oBACjD,cAAc,CAAC,mBAAmB,GAAG,SAAS,CAAC;oBAE/C,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,kFAAkF,SAAS,EAAE,CAC9F,CAAC;gBACJ,CAAC;gBAED,MAAM,IAAI,CAAC,sBAAsB,CAC/B,SAAS,EACT,MAAM,EACN,EAAE,EACF,KAAK,EACL,YAAY,EACZ,MAAM,EACN,SAAS,CACV,CAAC;gBAEF,cAAc,CAAC,aAAa,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBAC1C,cAAc,CAAC,iBAAiB,GAAG,CAAC,CAAC;gBACrC,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,4CAA4C,SAAS,eAAe,MAAM,GAAG,kCACxE,mCAAkB,KAAE,SAAS,IACnC,CAAC;YACJ,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,cAAc,CAAC,iBAAiB,EAAE,CAAC;gBAEnC,6GAA6G;gBAC7G,2EAA2E;gBAC3E,uGAAuG;gBACvG,MAAM,yBAAyB,GAAG,KAAK,CAAC;gBAExC,eAAe;gBACf,6CAA6C;gBAC7C,MAAM,SAAS,GAAG,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,IAAI,CAAC;gBAC1B,IAAI,SAAS,KAAK,CAAC,IAAI,EAAE,CAAC;oBACxB,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,iHAAiH,kCAE5G,mCAAkB,KACrB,SAAS,EACT,KAAK,EAAE,CAAC,EACR,SAAS,EACT,QAAQ,EAAE,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,OAAO,IAEvB,CAAC;oBAEF,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,yBAAyB,CAAC,CAAC;oBACxD,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;oBAEjE,OAAO;gBACT,CAAC;gBAED,6DAA6D;gBAC7D,IAAI,cAAc,CAAC,iBAAiB,IAAI,CAAC,EAAE,CAAC;oBAC1C,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,gEAAgE,kCAC3D,mCAAkB,KAAE,SAAS,EAAE,KAAK,EAAE,CAAC,IAC7C,CAAC;oBAEF,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,yBAAyB,CAAC,CAAC;oBACxD,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;oBAEjE,OAAO;gBACT,CAAC;gBAED,MAAM,qBAAqB,GAAG,IAAI,GAAG,EAAE,CAAC;gBACxC,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,mFAAmF,qBAAqB,WAAW,kCAE9G,mCAAkB,KACrB,SAAS,EACT,KAAK,EAAE,CAAC,EACR,iBAAiB,EAAE,cAAc,CAAC,iBAAiB,IAEtD,CAAC;gBAEF,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,mFAAmF,SAAS,EAAE,CAC/F,CAAC;gBACF,cAAc,CAAC,mBAAmB,GAAG,UAAU,CAC7C,GAAG,EAAE,CACH,IAAI,CAAC,uBAAuB,CAC1B,SAAS,EACT,MAAM,EACN,EAAE,EACF,YAAY,EACZ,MAAM,CACP,EACH,qBAAqB,CACtB,CAAC;YACJ,CAAC;QACH,CAAC;KAAA;IAED,yBAAyB,CAAC,SAAkB,EAAE,EAAc;QAC1D,IAAI,SAAS,EAAE,CAAC;YACd,IAAI,CAAC,mBAAmB,CAAC,sBAAsB,CAAC,SAAS,CAAC,CAAC;YAC3D,IAAA,gCAAe,EAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC;IAEK,mCAAmC,CACvC,WAAmB;;YAEnB,OAAO,CAAC,GAAG,CAAC,qCAAqC,WAAW,GAAG,CAAC,CAAC;YACjE,IAAI,WAAW,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;gBACrC,MAAM,kBAAkB,GAAG,IAAA,sCAAqB,EAAC,WAAW,CAAC,CAAC;gBAC9D,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBACxB,MAAM,IAAI,KAAK,CACb,6EAA6E,WAAW,GAAG,CAC5F,CAAC;gBACJ,CAAC;gBAED,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,KAAK,EAAE,GACnD,kBAAkB,CAAC;gBAErB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,2CAA2C,kCACvD,mCAAkB,KACrB,WAAW;oBACX,MAAM;oBACN,MAAM;oBACN,SAAS;oBACT,SAAS;oBACT,KAAK,IACL,CAAC;gBAEH,IAAI,SAAS,EAAE,CAAC;oBACd,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,gDAAgD,EAAE;wBAClE,SAAS;qBACV,CAAC,CAAC;oBACH,IAAI,CAAC,mBAAmB,CAAC,sBAAsB,CAAC,SAAS,CAAC,CAAC;gBAC7D,CAAC;qBAAM,CAAC;oBACN,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;gBACpE,CAAC;gBAED,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,qCAAqC,gDACjD,mCAAkB,GAClB,kBAAkB,KACrB,KAAK;oBACL,MAAM;oBACN,MAAM,IACN,CAAC;gBAEH,gGAAgG;gBAChG,IAAI,CAAC,UAAU,EAAE,CAAC,MAAM,CAAC,WAAkB,CAAC,CAAC;gBAE7C,IAAI,CAAC,KAAK,EAAE,CAAC;oBACX,MAAM,YAAY,GAChB,+EAA+E,CAAC;oBAClF,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,EAAE;wBAC9B,kBAAkB;wBAClB,WAAW;qBACZ,CAAC,CAAC;oBACH,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;gBAChC,CAAC;gBAED,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE;oBACxC,MAAM;oBACN,SAAS;iBACV,CAAC,CAAC;gBAEH,OAAO;YACT,CAAC;QACH,CAAC;KAAA;IAEO,sBAAsB,CAC5B,SAAiB,EACjB,MAAgB,EAChB,EAAa,EACb,KAAY,EACZ,WAAmB,EACnB,MAAe,EACf,SAAmB;QAEnB,QAAQ,MAAM,EAAE,CAAC;YACf,KAAK,MAAM;gBACT,OAAO,IAAI,CAAC,eAAe;qBACxB,iBAAiB,CAChB,IAAI,CAAC,sBAAsB,EAAE,EAC7B,IAAI,CAAC,oBAAoB,EAAE,CAAC,cAAc,CAC3C;qBACA,8BAA8B,CAAC,SAAS,CAAC,CAAC;YAC/C,KAAK,aAAa;gBAChB,OAAO,IAAI,CAAC,eAAe;qBACxB,iBAAiB,CAChB,IAAI,CAAC,sBAAsB,EAAE,EAC7B,IAAI,CAAC,oBAAoB,EAAE,CAAC,cAAc,EAC1C,IAAI,CACL;qBACA,8BAA8B,CAAC,SAAS,CAAC,CAAC;YAC/C,KAAK,aAAa;gBAChB,OAAO,IAAI,CAAC,eAAe;qBACxB,iBAAiB,CAChB,IAAI,CAAC,sBAAsB,EAAE,EAC7B,IAAI,CAAC,oBAAoB,EAAE,CAAC,cAAc,CAC3C;qBACA,gCAAgC,CAAC,SAAS,CAAC,CAAC;YACjD,KAAK,gBAAgB;gBACnB,OAAO,IAAI,CAAC,eAAe;qBACxB,iBAAiB,CAChB,IAAI,CAAC,sBAAsB,EAAE,EAC7B,IAAI,CAAC,oBAAoB,EAAE,CAAC,cAAc,CAC3C;qBACA,oCAAoC,CAAC,SAAS,CAAC,CAAC;YACrD,KAAK,gBAAgB;gBACnB,OAAO,IAAI,CAAC,eAAe;qBACxB,iBAAiB,CAChB,IAAI,CAAC,sBAAsB,EAAE,EAC7B,IAAI,CAAC,oBAAoB,EAAE,CAAC,cAAc,CAC3C;qBACA,wCAAwC,CAAC;oBACxC,SAAS;oBACT,MAAM,EAAE,MAAO;iBAChB,CAAC,CAAC;YACP,KAAK,OAAO,CAAC;YACb,KAAK,SAAS,CAAC;YACf,KAAK,gBAAgB,CAAC;YACtB,KAAK,MAAM;gBACT,OAAO,IAAI,CAAC,eAAe;qBACxB,iBAAiB,CAChB,IAAI,CAAC,sBAAsB,EAAE,EAC7B,IAAI,CAAC,oBAAoB,EAAE,CAAC,cAAc,CAC3C;qBACA,iCAAiC,EAAE,CAAC;YACzC,KAAK,aAAa;gBAChB,OAAO,IAAI,CAAC,eAAe;qBACxB,iBAAiB,CAChB,IAAI,CAAC,sBAAsB,EAAE,EAC7B,IAAI,CAAC,oBAAoB,EAAE,CAAC,cAAc,EAC1C,SAAS,CACV;qBACA,iCAAiC,EAAE,CAAC;YACzC,KAAK,cAAc;gBACjB,OAAO,IAAI,CAAC,eAAe;qBACxB,kBAAkB,CACjB,IAAI,CAAC,sBAAsB,EAAE,EAC7B,IAAI,CAAC,oBAAoB,EAAE,CAAC,cAAc,EAC1C,SAAS,CACV;qBACA,iCAAiC,EAAE,CAAC;YACzC,KAAK,YAAY;gBACf,OAAO,IAAI,CAAC,eAAe;qBACxB,kBAAkB,CACjB,IAAI,CAAC,sBAAsB,EAAE,EAC7B,IAAI,CAAC,oBAAoB,EAAE,CAAC,cAAc,CAC3C;qBACA,4BAA4B,EAAE,CAAC;YACpC;gBACE,MAAM,IAAA,uBAAU,EACd,MAAM,EACN,sEAAsE,MAAM,EAAE,CAC/E,CAAC;QACN,CAAC;IACH,CAAC;CACF;AAzcD,sDAycC"}

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

@@ -0,0 +1,124 @@
+import WebSocket from 'isomorphic-ws';
+import { WebsocketClientOptions, WsMarket, WsTopic } from '../../types/websockets/ws-general';
+import { DefaultLogger } from '../logger';
+import { WsRequestOperationBinance } from '../../types/websockets/ws-api';
+export declare const WS_LOGGER_CATEGORY: {
+    category: string;
+};
+/**
+ * These WS Key values correspond to a WS API connection
+ */
+export type WSAPIWsKey = 'mainWSAPI' | 'mainWSAPI2' | 'mainWSAPITestnet' | 'usdmWSAPI' | 'usdmWSAPITestnet';
+export declare const WS_KEY_MAP: {
+    readonly main: "main";
+    readonly main2: "main2";
+    readonly main3: "main3";
+    readonly mainTestnetPublic: "mainTestnetPublic";
+    readonly mainTestnetUserData: "mainTestnetUserData";
+    readonly mainWSAPI: "mainWSAPI";
+    readonly mainWSAPI2: "mainWSAPI2";
+    readonly mainWSAPITestnet: "mainWSAPITestnet";
+    readonly marginRiskUserData: "marginRiskUserData";
+    readonly usdm: "usdm";
+    readonly usdmTestnet: "usdmTestnet";
+    readonly usdmWSAPI: "usdmWSAPI";
+    readonly usdmWSAPITestnet: "usdmWSAPITestnet";
+    readonly coinm: "coinm";
+    readonly coinm2: "coinm2";
+    readonly coinmTestnet: "coinmTestnet";
+    readonly eoptions: "eoptions";
+    readonly portfolioMarginUserData: "portfolioMarginUserData";
+    readonly portfolioMarginProUserData: "portfolioMarginProUserData";
+};
+export type WsKey = (typeof WS_KEY_MAP)[keyof typeof WS_KEY_MAP];
+export declare const WS_KEY_URL_MAP: Record<WsKey, string>;
+export declare function getWsURLSuffix(wsKey: WsKey, connectionType: 'market' | 'userData' | 'wsAPI'): string;
+export declare const WS_AUTH_ON_CONNECT_KEYS: WsKey[];
+/**
+ * Normalised internal format for a request (subscribe/unsubscribe/etc) on a topic, with optional parameters.
+ *
+ * - Topic: the topic this event is for
+ * - Payload: the parameters to include, optional. E.g. auth requires key + sign. Some topics allow configurable parameters.
+ * - Category: required for bybit, since different categories have different public endpoints
+ */
+export interface WsTopicRequest<TWSTopic extends string = string, TWSPayload = unknown> {
+    topic: TWSTopic;
+    payload?: TWSPayload;
+}
+/**
+ * Conveniently allow users to request a topic either as string topics or objects (containing string topic + params)
+ */
+export type WsTopicRequestOrStringTopic<TWSTopic extends string, TWSPayload = unknown> = WsTopicRequest<TWSTopic, TWSPayload> | string;
+export declare function isPrivateWsTopic(topic: string): boolean;
+export declare function getWsKeyForTopic(wsKey: string): WsKey;
+export declare function getWsUrl(wsKey: WsKey, wsClientOptions: WebsocketClientOptions, logger: typeof DefaultLogger): string;
+export declare function getMaxTopicsPerSubscribeEvent(wsKey: WsKey): number | null;
+export declare const WS_ERROR_ENUM: {
+    NOT_AUTHENTICATED_SPOT_V3: string;
+    API_ERROR_GENERIC: string;
+    API_SIGN_AUTH_FAILED: string;
+    USDC_OPTION_AUTH_FAILED: string;
+};
+/**
+ * #305: ws.terminate() is undefined in browsers.
+ * This only works in node.js, not in browsers.
+ * Does nothing if `ws` is undefined. Does nothing in browsers.
+ */
+export declare function safeTerminateWs(ws?: WebSocket | any, fallbackToClose?: boolean): boolean;
+/**
+ * WS API promises are stored using a primary key. This key is constructed using
+ * properties found in every request & reply.
+ *
+ * The counterpart to this is in resolveEmittableEvents
+ */
+export declare function getPromiseRefForWSAPIRequest(wsKey: WsKey, requestEvent: WsRequestOperationBinance<string>): string;
+/**
+ * Users can conveniently pass topics as strings or objects (object has topic name + optional params).
+ *
+ * This method normalises topics into objects (object has topic name + optional params).
+ */
+export declare function getNormalisedTopicRequests(wsTopicRequests: WsTopicRequestOrStringTopic<string>[]): WsTopicRequest<string>[];
+/**
+ * Groups topics in request into per-wsKey groups
+ * @param normalisedTopicRequests
+ * @param wsKey
+ * @param isPrivateTopic
+ * @returns
+ */
+export declare function getTopicsPerWSKey(normalisedTopicRequests: WsTopicRequest[], wsKey: WsKey): {
+    [key in WsKey]?: WsTopicRequest<WsTopic>[];
+};
+export declare function parseEventTypeFromMessage(wsKey: WsKey, parsedMsg?: any): string | undefined;
+export declare function resolveUserDataMarketForWsKey(wsKey: WsKey): WsMarket;
+/**
+ * Used by the legacy subscribe* utility methods to determine which wsKey to route the subscription to.
+ */
+export declare function resolveWsKeyForLegacyMarket(market: 'spot' | 'usdm' | 'coinm'): WsKey;
+/**
+ * Try to resolve event.data. Example circumstance: {"stream":"!forceOrder@arr","data":{"e":"forceOrder","E":1634653599186,"o":{"s":"IOTXUSDT","S":"SELL","o":"LIMIT","f":"IOC","q":"3661","p":"0.06606","ap":"0.06669","X":"FILLED","l":"962","z":"3661","T":1634653599180}}}
+ */
+export declare function parseRawWsMessage(event: any): any;
+export interface MiscUserDataConnectionState {
+    isReconnecting?: boolean;
+    respawnAttempt?: number;
+}
+interface WsContext {
+    symbol: string | undefined;
+    legacyWsKey: string | undefined;
+    wsKey: WsKey | undefined;
+    market: WsMarket;
+    isTestnet: boolean | undefined;
+    isUserData: boolean;
+    streamName: string;
+    listenKey: string | undefined;
+    otherParams: undefined | string[];
+}
+export declare function getContextFromWsKey(legacyWsKey: any): WsContext;
+/**
+ * The legacy WS client creates a deterministic WS Key based on consistent input parameters
+ */
+export declare function getLegacyWsStoreKeyWithContext(market: WsMarket, streamName: string, symbol?: string | undefined, listenKey?: string | undefined, ...otherParams: (string | boolean)[]): any;
+export declare function getLegacyWsKeyContext(wsKey: string): WsContext | undefined;
+export declare function getRealWsKeyFromDerivedWsKey(wsKey: string | WsKey): WsKey;
+export declare function appendEventMarket(wsMsg: any, wsKey: WsKey): void;
+export {};