binance 2.15.14 → 3.0.0-beta.1

package/lib/util/webCryptoAPI.js

@@ -0,0 +1,120 @@
+"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.getSignKeyType = getSignKeyType;
+exports.signMessage = signMessage;
+const typeGuards_1 = require("./typeGuards");
+function bufferToB64(buffer) {
+    let binary = '';
+    const bytes = new Uint8Array(buffer);
+    const len = bytes.byteLength;
+    for (let i = 0; i < len; i++) {
+        binary += String.fromCharCode(bytes[i]);
+    }
+    return globalThis.btoa(binary);
+}
+function getSignKeyType(secret) {
+    if (secret.includes('PRIVATE KEY')) {
+        if (secret.includes('RSA PRIVATE KEY')) {
+            return 'RSASSA-PKCS1-v1_5';
+        }
+        return 'Ed25519';
+    }
+    return 'HMAC';
+}
+// async function importEd25519PrivateKey(
+//   pem: string,
+//   algorithm: SignAlgorithm,
+// ): Promise<CryptoKey> {
+//   const base64Key = pem
+//     .replace(/-----BEGIN PRIVATE KEY-----/, '')
+//     .replace(/-----END PRIVATE KEY-----/, '')
+//     .replace(/\s+/g, ''); // Remove spaces and newlines
+//   const binaryKey = Uint8Array.from(atob(base64Key), (c) => c.charCodeAt(0));
+//   return crypto.subtle.importKey(
+//     'pkcs8',
+//     binaryKey.buffer,
+//     { name: 'Ed25519', hash: { name: algorithm } },
+//     false,
+//     ['sign'],
+//   );
+// }
+// async function importRSAPrivateKey(
+//   pem: string,
+//   algorithm: SignAlgorithm,
+// ): Promise<CryptoKey> {
+//   const base64Key = pem
+//     .replace(/-----BEGIN RSA PRIVATE KEY-----/, '')
+//     .replace(/-----END RSA PRIVATE KEY-----/, '')
+//     .replace(/\s+/g, ''); // Remove spaces and newlines
+//   const binaryKey = Uint8Array.from(atob(base64Key), (c) => c.charCodeAt(0));
+//   return crypto.subtle.importKey(
+//     'pkcs8',
+//     binaryKey.buffer,
+//     { name: 'RSASSA-PKCS1-v1_5', hash: { name: algorithm } },
+//     false,
+//     ['sign'],
+//   );
+// }
+function importKey(pem, type, algorithm, encoder) {
+    return __awaiter(this, void 0, void 0, function* () {
+        switch (type) {
+            case 'Ed25519':
+            case 'RSASSA-PKCS1-v1_5': {
+                const prefix = type === 'Ed25519'
+                    ? /-----BEGIN PRIVATE KEY-----/
+                    : /-----BEGIN RSA PRIVATE KEY-----/;
+                const suffix = type === 'Ed25519'
+                    ? /-----END PRIVATE KEY-----/
+                    : /-----END RSA PRIVATE KEY-----/;
+                const base64Key = pem
+                    .replace(prefix, '')
+                    .replace(suffix, '')
+                    .replace(/\s+/g, ''); // Remove spaces and newlines
+                const binaryKey = Uint8Array.from(atob(base64Key), (c) => c.charCodeAt(0));
+                return crypto.subtle.importKey('pkcs8', binaryKey.buffer, { name: type, hash: { name: algorithm } }, false, ['sign']);
+            }
+            case 'HMAC': {
+                return globalThis.crypto.subtle.importKey('raw', encoder.encode(pem), { name: type, hash: algorithm }, false, ['sign']);
+            }
+            default: {
+                throw (0, typeGuards_1.neverGuard)(type, `Unhandled key type: "${type}"`);
+            }
+        }
+    });
+}
+/**
+ * Sign a message, with a secret, using the Web Crypto API
+ *
+ * Ed25519 is stable as of v23.5.0, but also not available in all browsers
+ */
+function signMessage(message_1, secret_1, method_1, algorithm_1) {
+    return __awaiter(this, arguments, void 0, function* (message, secret, method, algorithm, pemEncodeMethod = method) {
+        const encoder = new TextEncoder();
+        const signKeyType = getSignKeyType(secret);
+        const key = yield importKey(secret, signKeyType, algorithm, encoder);
+        const buffer = yield globalThis.crypto.subtle.sign({ name: signKeyType }, key, encoder.encode(message));
+        switch (method) {
+            case 'hex': {
+                return Array.from(new Uint8Array(buffer))
+                    .map((byte) => byte.toString(16).padStart(2, '0'))
+                    .join('');
+            }
+            case 'base64': {
+                return bufferToB64(buffer);
+            }
+            default: {
+                throw (0, typeGuards_1.neverGuard)(method, `Unhandled sign method: "${method}"`);
+            }
+        }
+    });
+}
+//# sourceMappingURL=webCryptoAPI.js.map

package/lib/util/webCryptoAPI.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webCryptoAPI.js","sourceRoot":"","sources":["../../src/util/webCryptoAPI.ts"],"names":[],"mappings":";;;;;;;;;;;AA+CA,wCASC;AAkGD,kCAgCC;AA1LD,6CAA0C;AAE1C,SAAS,WAAW,CAAC,MAAmB;IACtC,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;IACrC,MAAM,GAAG,GAAG,KAAK,CAAC,UAAU,CAAC;IAC7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC7B,MAAM,IAAI,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1C,CAAC;IACD,OAAO,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AACjC,CAAC;AAqCD,SAAgB,cAAc,CAAC,MAAc;IAC3C,IAAI,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;QACnC,IAAI,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,CAAC;YACvC,OAAO,mBAAmB,CAAC;QAC7B,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,0CAA0C;AAC1C,iBAAiB;AACjB,8BAA8B;AAC9B,0BAA0B;AAC1B,0BAA0B;AAC1B,kDAAkD;AAClD,gDAAgD;AAChD,0DAA0D;AAE1D,gFAAgF;AAEhF,oCAAoC;AACpC,eAAe;AACf,wBAAwB;AACxB,sDAAsD;AACtD,aAAa;AACb,gBAAgB;AAChB,OAAO;AACP,IAAI;AAEJ,sCAAsC;AACtC,iBAAiB;AACjB,8BAA8B;AAC9B,0BAA0B;AAC1B,0BAA0B;AAC1B,sDAAsD;AACtD,oDAAoD;AACpD,0DAA0D;AAE1D,gFAAgF;AAEhF,oCAAoC;AACpC,eAAe;AACf,wBAAwB;AACxB,gEAAgE;AAChE,aAAa;AACb,gBAAgB;AAChB,OAAO;AACP,IAAI;AAEJ,SAAe,SAAS,CACtB,GAAW,EACX,IAAa,EACb,SAAwB,EACxB,OAAoB;;QAEpB,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,SAAS,CAAC;YACf,KAAK,mBAAmB,CAAC,CAAC,CAAC;gBACzB,MAAM,MAAM,GACV,IAAI,KAAK,SAAS;oBAChB,CAAC,CAAC,6BAA6B;oBAC/B,CAAC,CAAC,iCAAiC,CAAC;gBAExC,MAAM,MAAM,GACV,IAAI,KAAK,SAAS;oBAChB,CAAC,CAAC,2BAA2B;oBAC7B,CAAC,CAAC,+BAA+B,CAAC;gBAEtC,MAAM,SAAS,GAAG,GAAG;qBAClB,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;qBACnB,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;qBACnB,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,6BAA6B;gBAErD,MAAM,SAAS,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CACvD,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAChB,CAAC;gBAEF,OAAO,MAAM,CAAC,MAAM,CAAC,SAAS,CAC5B,OAAO,EACP,SAAS,CAAC,MAAM,EAChB,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EACzC,KAAK,EACL,CAAC,MAAM,CAAC,CACT,CAAC;YACJ,CAAC;YACD,KAAK,MAAM,CAAC,CAAC,CAAC;gBACZ,OAAO,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,CACvC,KAAK,EACL,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,EACnB,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,EAC/B,KAAK,EACL,CAAC,MAAM,CAAC,CACT,CAAC;YACJ,CAAC;YACD,OAAO,CAAC,CAAC,CAAC;gBACR,MAAM,IAAA,uBAAU,EAAC,IAAI,EAAE,wBAAwB,IAAI,GAAG,CAAC,CAAC;YAC1D,CAAC;QACH,CAAC;IACH,CAAC;CAAA;AAED;;;;GAIG;AACH,SAAsB,WAAW;yDAC/B,OAAe,EACf,MAAc,EACd,MAAwB,EACxB,SAAwB,EACxB,kBAAoC,MAAM;QAE1C,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;QAElC,MAAM,WAAW,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;QAE3C,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QAErE,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAChD,EAAE,IAAI,EAAE,WAAW,EAAE,EACrB,GAAG,EACH,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CACxB,CAAC;QAEF,QAAQ,MAAM,EAAE,CAAC;YACf,KAAK,KAAK,CAAC,CAAC,CAAC;gBACX,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;qBACtC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;qBACjD,IAAI,CAAC,EAAE,CAAC,CAAC;YACd,CAAC;YACD,KAAK,QAAQ,CAAC,CAAC,CAAC;gBACd,OAAO,WAAW,CAAC,MAAM,CAAC,CAAC;YAC7B,CAAC;YACD,OAAO,CAAC,CAAC,CAAC;gBACR,MAAM,IAAA,uBAAU,EAAC,MAAM,EAAE,2BAA2B,MAAM,GAAG,CAAC,CAAC;YACjE,CAAC;QACH,CAAC;IACH,CAAC;CAAA"}

package/lib/util/websockets/WsStore.d.ts

@@ -0,0 +1,74 @@
+import WebSocket from 'isomorphic-ws';
+import { DefaultLogger } from '../logger';
+import { DeferredPromise, WSConnectedResult, WsConnectionStateEnum, WsStoredState } from './WsStore.types';
+/**
+ * Simple comparison of two objects, only checks 1-level deep (nested objects won't match)
+ */
+export declare function isDeepObjectMatch(object1: unknown, object2: unknown): boolean;
+export declare const DEFERRED_PROMISE_REF: {
+    readonly CONNECTION_IN_PROGRESS: "CONNECTION_IN_PROGRESS";
+    readonly AUTHENTICATION_IN_PROGRESS: "AUTHENTICATION_IN_PROGRESS";
+};
+type DeferredPromiseRef = (typeof DEFERRED_PROMISE_REF)[keyof typeof DEFERRED_PROMISE_REF];
+export declare class WsStore<WsKey extends string, TWSTopicSubscribeEventArgs extends string | object> {
+    private wsState;
+    private logger;
+    constructor(logger: DefaultLogger);
+    /** Get WS stored state for key, optionally create if missing */
+    get(key: WsKey, createIfMissing?: true): WsStoredState<TWSTopicSubscribeEventArgs>;
+    get(key: WsKey, createIfMissing?: false): WsStoredState<TWSTopicSubscribeEventArgs> | undefined;
+    getKeys(): WsKey[];
+    create(key: WsKey): WsStoredState<TWSTopicSubscribeEventArgs> | undefined;
+    delete(key: WsKey): void;
+    hasExistingActiveConnection(key: WsKey): boolean;
+    getWs(key: WsKey): WebSocket | undefined;
+    setWs(key: WsKey, wsConnection: WebSocket): WebSocket;
+    /**
+     * deferred promises
+     */
+    getDeferredPromise<TSuccessResult = any>(wsKey: WsKey, promiseRef: string | DeferredPromiseRef): DeferredPromise<TSuccessResult> | undefined;
+    createDeferredPromise<TSuccessResult = any>(wsKey: WsKey, promiseRef: string | DeferredPromiseRef, throwIfExists: boolean): DeferredPromise<TSuccessResult>;
+    resolveDeferredPromise(wsKey: WsKey, promiseRef: string | DeferredPromiseRef, value: unknown, removeAfter: boolean): void;
+    rejectDeferredPromise(wsKey: WsKey, promiseRef: string | DeferredPromiseRef, value: unknown, removeAfter: boolean): void;
+    removeDeferredPromise(wsKey: WsKey, promiseRef: string | DeferredPromiseRef): void;
+    rejectAllDeferredPromises(wsKey: WsKey, reason: string): void;
+    /** Get promise designed to track a connection attempt in progress. Resolves once connected. */
+    getConnectionInProgressPromise(wsKey: WsKey): DeferredPromise<WSConnectedResult> | undefined;
+    getAuthenticationInProgressPromise(wsKey: WsKey): DeferredPromise<WSConnectedResult & {
+        event: any;
+    }> | undefined;
+    /**
+     * Create a deferred promise designed to track a connection attempt in progress.
+     *
+     * Will throw if existing promise is found.
+     */
+    createConnectionInProgressPromise(wsKey: WsKey, throwIfExists: boolean): DeferredPromise<WSConnectedResult>;
+    createAuthenticationInProgressPromise(wsKey: WsKey, throwIfExists: boolean): DeferredPromise<WSConnectedResult & {
+        event: any;
+    }>;
+    /** Remove promise designed to track a connection attempt in progress */
+    removeConnectingInProgressPromise(wsKey: WsKey): void;
+    removeAuthenticationInProgressPromise(wsKey: WsKey): void;
+    isWsOpen(key: WsKey): boolean;
+    getConnectionState(key: WsKey): WsConnectionStateEnum;
+    setConnectionState(key: WsKey, state: WsConnectionStateEnum): void;
+    isConnectionState(key: WsKey, state: WsConnectionStateEnum): boolean;
+    /**
+     * Check if we're currently in the process of opening a connection for any reason. Safer than only checking "CONNECTING" as the state
+     * @param key
+     * @returns
+     */
+    isConnectionAttemptInProgress(key: WsKey): boolean;
+    getTopics(key: WsKey): Set<TWSTopicSubscribeEventArgs>;
+    getTopicsByKey(): Record<string, Set<TWSTopicSubscribeEventArgs>>;
+    /**
+     * Find matching "topic" request from the store
+     * @param key
+     * @param topic
+     * @returns
+     */
+    getMatchingTopic(key: WsKey, topic: TWSTopicSubscribeEventArgs): TWSTopicSubscribeEventArgs | undefined;
+    addTopic(key: WsKey, topic: TWSTopicSubscribeEventArgs): Set<TWSTopicSubscribeEventArgs>;
+    deleteTopic(key: WsKey, topic: TWSTopicSubscribeEventArgs): Set<TWSTopicSubscribeEventArgs>;
+}
+export {};

package/lib/util/websockets/WsStore.js

@@ -0,0 +1,279 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WsStore = exports.DEFERRED_PROMISE_REF = void 0;
+exports.isDeepObjectMatch = isDeepObjectMatch;
+const logger_1 = require("../logger");
+const WsStore_types_1 = require("./WsStore.types");
+/**
+ * Simple comparison of two objects, only checks 1-level deep (nested objects won't match)
+ */
+function isDeepObjectMatch(object1, object2) {
+    if (typeof object1 === 'string' && typeof object2 === 'string') {
+        return object1 === object2;
+    }
+    if (typeof object1 !== 'object' || typeof object2 !== 'object') {
+        return false;
+    }
+    for (const key in object1) {
+        const value1 = object1[key];
+        const value2 = object2[key];
+        if (value1 !== value2) {
+            return false;
+        }
+    }
+    return true;
+}
+exports.DEFERRED_PROMISE_REF = {
+    CONNECTION_IN_PROGRESS: 'CONNECTION_IN_PROGRESS',
+    AUTHENTICATION_IN_PROGRESS: 'AUTHENTICATION_IN_PROGRESS',
+};
+class WsStore {
+    constructor(logger) {
+        this.wsState = {};
+        this.logger = logger || logger_1.DefaultLogger;
+    }
+    get(key, createIfMissing) {
+        if (this.wsState[key]) {
+            return this.wsState[key];
+        }
+        if (createIfMissing) {
+            return this.create(key);
+        }
+    }
+    getKeys() {
+        return Object.keys(this.wsState);
+    }
+    create(key) {
+        if (this.hasExistingActiveConnection(key)) {
+            this.logger.info('WsStore setConnection() overwriting existing open connection: ', this.getWs(key));
+        }
+        this.wsState[key] = {
+            subscribedTopics: new Set(),
+            connectionState: WsStore_types_1.WsConnectionStateEnum.INITIAL,
+            deferredPromiseStore: {},
+        };
+        return this.get(key);
+    }
+    delete(key) {
+        // TODO: should we allow this at all? Perhaps block this from happening...
+        if (this.hasExistingActiveConnection(key)) {
+            const ws = this.getWs(key);
+            this.logger.info('WsStore deleting state for connection still open: ', ws);
+            ws === null || ws === void 0 ? void 0 : ws.close();
+        }
+        delete this.wsState[key];
+    }
+    /* connection websocket */
+    hasExistingActiveConnection(key) {
+        return this.get(key) && this.isWsOpen(key);
+    }
+    getWs(key) {
+        var _a;
+        return (_a = this.get(key)) === null || _a === void 0 ? void 0 : _a.ws;
+    }
+    setWs(key, wsConnection) {
+        if (this.isWsOpen(key)) {
+            this.logger.info('WsStore setConnection() overwriting existing open connection: ', this.getWs(key));
+        }
+        this.get(key, true).ws = wsConnection;
+        return wsConnection;
+    }
+    /**
+     * deferred promises
+     */
+    getDeferredPromise(wsKey, promiseRef) {
+        const storeForKey = this.get(wsKey);
+        if (!storeForKey) {
+            return;
+        }
+        const deferredPromiseStore = storeForKey.deferredPromiseStore;
+        return deferredPromiseStore[promiseRef];
+    }
+    createDeferredPromise(wsKey, promiseRef, throwIfExists) {
+        const existingPromise = this.getDeferredPromise(wsKey, promiseRef);
+        if (existingPromise) {
+            if (throwIfExists) {
+                throw new Error(`Promise exists for "${wsKey}"`);
+            }
+            else {
+                // console.log('existing promise');
+                return existingPromise;
+            }
+        }
+        // console.log('create promise');
+        const createIfMissing = true;
+        const storeForKey = this.get(wsKey, createIfMissing);
+        // TODO: Once stable, use Promise.withResolvers in future
+        const deferredPromise = {};
+        deferredPromise.promise = new Promise((resolve, reject) => {
+            deferredPromise.resolve = resolve;
+            deferredPromise.reject = reject;
+        });
+        const deferredPromiseStore = storeForKey.deferredPromiseStore;
+        deferredPromiseStore[promiseRef] = deferredPromise;
+        return deferredPromise;
+    }
+    resolveDeferredPromise(wsKey, promiseRef, value, removeAfter) {
+        const promise = this.getDeferredPromise(wsKey, promiseRef);
+        if (promise === null || promise === void 0 ? void 0 : promise.resolve) {
+            promise.resolve(value);
+        }
+        if (removeAfter) {
+            this.removeDeferredPromise(wsKey, promiseRef);
+        }
+    }
+    rejectDeferredPromise(wsKey, promiseRef, value, removeAfter) {
+        const promise = this.getDeferredPromise(wsKey, promiseRef);
+        if (promise === null || promise === void 0 ? void 0 : promise.reject) {
+            this.logger.trace(`rejectDeferredPromise(): rejecting ${wsKey}/${promiseRef}/${value}`);
+            promise.reject(value);
+        }
+        if (removeAfter) {
+            this.removeDeferredPromise(wsKey, promiseRef);
+        }
+    }
+    removeDeferredPromise(wsKey, promiseRef) {
+        const storeForKey = this.get(wsKey);
+        if (!storeForKey) {
+            return;
+        }
+        const deferredPromise = storeForKey.deferredPromiseStore[promiseRef];
+        if (deferredPromise) {
+            // Just in case it's pending
+            if (deferredPromise.resolve) {
+                deferredPromise.resolve('promiseRemoved');
+            }
+            delete storeForKey.deferredPromiseStore[promiseRef];
+        }
+    }
+    rejectAllDeferredPromises(wsKey, reason) {
+        const storeForKey = this.get(wsKey);
+        const deferredPromiseStore = storeForKey.deferredPromiseStore;
+        if (!storeForKey || !deferredPromiseStore) {
+            return;
+        }
+        const reservedKeys = Object.values(exports.DEFERRED_PROMISE_REF);
+        for (const promiseRef in deferredPromiseStore) {
+            // Skip reserved keys, such as the connection promise
+            if (reservedKeys.includes(promiseRef)) {
+                continue;
+            }
+            try {
+                this.logger.trace(`rejectAllDeferredPromises(): rejecting ${wsKey}/${promiseRef}/${reason}`);
+                this.rejectDeferredPromise(wsKey, promiseRef, reason, true);
+            }
+            catch (e) {
+                this.logger.error('rejectAllDeferredPromises(): Exception rejecting deferred promise', { wsKey: wsKey, reason, promiseRef, exception: e });
+            }
+        }
+    }
+    /** Get promise designed to track a connection attempt in progress. Resolves once connected. */
+    getConnectionInProgressPromise(wsKey) {
+        return this.getDeferredPromise(wsKey, exports.DEFERRED_PROMISE_REF.CONNECTION_IN_PROGRESS);
+    }
+    getAuthenticationInProgressPromise(wsKey) {
+        return this.getDeferredPromise(wsKey, exports.DEFERRED_PROMISE_REF.AUTHENTICATION_IN_PROGRESS);
+    }
+    /**
+     * Create a deferred promise designed to track a connection attempt in progress.
+     *
+     * Will throw if existing promise is found.
+     */
+    createConnectionInProgressPromise(wsKey, throwIfExists) {
+        return this.createDeferredPromise(wsKey, exports.DEFERRED_PROMISE_REF.CONNECTION_IN_PROGRESS, throwIfExists);
+    }
+    createAuthenticationInProgressPromise(wsKey, throwIfExists) {
+        return this.createDeferredPromise(wsKey, exports.DEFERRED_PROMISE_REF.AUTHENTICATION_IN_PROGRESS, throwIfExists);
+    }
+    /** Remove promise designed to track a connection attempt in progress */
+    removeConnectingInProgressPromise(wsKey) {
+        return this.removeDeferredPromise(wsKey, exports.DEFERRED_PROMISE_REF.CONNECTION_IN_PROGRESS);
+    }
+    removeAuthenticationInProgressPromise(wsKey) {
+        return this.removeDeferredPromise(wsKey, exports.DEFERRED_PROMISE_REF.AUTHENTICATION_IN_PROGRESS);
+    }
+    /* connection state */
+    isWsOpen(key) {
+        const existingConnection = this.getWs(key);
+        return (!!existingConnection &&
+            existingConnection.readyState === existingConnection.OPEN);
+    }
+    getConnectionState(key) {
+        return this.get(key, true).connectionState;
+    }
+    setConnectionState(key, state) {
+        this.get(key, true).connectionState = state;
+        this.get(key, true).connectionStateChangedAt = new Date();
+    }
+    isConnectionState(key, state) {
+        return this.getConnectionState(key) === state;
+    }
+    /**
+     * Check if we're currently in the process of opening a connection for any reason. Safer than only checking "CONNECTING" as the state
+     * @param key
+     * @returns
+     */
+    isConnectionAttemptInProgress(key) {
+        const isConnectionInProgress = this.isConnectionState(key, WsStore_types_1.WsConnectionStateEnum.CONNECTING) ||
+            this.isConnectionState(key, WsStore_types_1.WsConnectionStateEnum.RECONNECTING);
+        if (isConnectionInProgress) {
+            const wsState = this.get(key, true);
+            const stateLastChangedAt = wsState === null || wsState === void 0 ? void 0 : wsState.connectionStateChangedAt;
+            const stateChangedAtTimestamp = stateLastChangedAt === null || stateLastChangedAt === void 0 ? void 0 : stateLastChangedAt.getTime();
+            if (stateChangedAtTimestamp) {
+                const timestampNow = new Date().getTime();
+                const stateChangedTimeAgo = timestampNow - stateChangedAtTimestamp;
+                const stateChangeTimeout = 15000; // allow a max 15 second timeout since the last state change before assuming stuck;
+                if (stateChangedTimeAgo >= stateChangeTimeout) {
+                    const msg = 'State change timed out, reconnect workflow stuck?';
+                    this.logger.error(msg, { key, wsState });
+                    this.setConnectionState(key, WsStore_types_1.WsConnectionStateEnum.ERROR);
+                }
+            }
+        }
+        return isConnectionInProgress;
+    }
+    /* subscribed topics */
+    getTopics(key) {
+        return this.get(key, true).subscribedTopics;
+    }
+    getTopicsByKey() {
+        const result = {};
+        for (const refKey in this.wsState) {
+            result[refKey] = this.getTopics(refKey);
+        }
+        return result;
+    }
+    /**
+     * Find matching "topic" request from the store
+     * @param key
+     * @param topic
+     * @returns
+     */
+    getMatchingTopic(key, topic) {
+        const allTopics = this.getTopics(key).values();
+        for (const storedTopic of allTopics) {
+            if (isDeepObjectMatch(topic, storedTopic)) {
+                return storedTopic;
+            }
+        }
+    }
+    addTopic(key, topic) {
+        // Check for duplicate topic. If already tracked, don't store this one
+        const existingTopic = this.getMatchingTopic(key, topic);
+        if (existingTopic) {
+            return this.getTopics(key);
+        }
+        return this.getTopics(key).add(topic);
+    }
+    deleteTopic(key, topic) {
+        // Check if we're subscribed to a topic like this
+        const storedTopic = this.getMatchingTopic(key, topic);
+        if (storedTopic) {
+            this.getTopics(key).delete(storedTopic);
+        }
+        return this.getTopics(key);
+    }
+}
+exports.WsStore = WsStore;
+//# sourceMappingURL=WsStore.js.map

package/lib/util/websockets/WsStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WsStore.js","sourceRoot":"","sources":["../../../src/util/websockets/WsStore.ts"],"names":[],"mappings":";;;AAcA,8CAkBC;AA7BD,sCAA0C;AAC1C,mDAKyB;AAEzB;;GAEG;AACH,SAAgB,iBAAiB,CAAC,OAAgB,EAAE,OAAgB;IAClE,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAC/D,OAAO,OAAO,KAAK,OAAO,CAAC;IAC7B,CAAC;IAED,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAC/D,OAAO,KAAK,CAAC;IACf,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;QAC1B,MAAM,MAAM,GAAI,OAAe,CAAC,GAAG,CAAC,CAAC;QACrC,MAAM,MAAM,GAAI,OAAe,CAAC,GAAG,CAAC,CAAC;QAErC,IAAI,MAAM,KAAK,MAAM,EAAE,CAAC;YACtB,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAEY,QAAA,oBAAoB,GAAG;IAClC,sBAAsB,EAAE,wBAAwB;IAChD,0BAA0B,EAAE,4BAA4B;CAChD,CAAC;AAKX,MAAa,OAAO;IASlB,YAAY,MAAqB;QALzB,YAAO,GACb,EAAE,CAAC;QAKH,IAAI,CAAC,MAAM,GAAG,MAAM,IAAI,sBAAa,CAAC;IACxC,CAAC;IAaD,GAAG,CACD,GAAU,EACV,eAAyB;QAEzB,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YACtB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC3B,CAAC;QAED,IAAI,eAAe,EAAE,CAAC;YACpB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC1B,CAAC;IACH,CAAC;IAED,OAAO;QACL,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAY,CAAC;IAC9C,CAAC;IAED,MAAM,CAAC,GAAU;QACf,IAAI,IAAI,CAAC,2BAA2B,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1C,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,gEAAgE,EAChE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAChB,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG;YAClB,gBAAgB,EAAE,IAAI,GAAG,EAA8B;YACvD,eAAe,EAAE,qCAAqB,CAAC,OAAO;YAC9C,oBAAoB,EAAE,EAAE;SACzB,CAAC;QACF,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IAED,MAAM,CAAC,GAAU;QACf,0EAA0E;QAC1E,IAAI,IAAI,CAAC,2BAA2B,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1C,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC3B,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,oDAAoD,EACpD,EAAE,CACH,CAAC;YACF,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,KAAK,EAAE,CAAC;QACd,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC3B,CAAC;IAED,0BAA0B;IAE1B,2BAA2B,CAAC,GAAU;QACpC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC7C,CAAC;IAED,KAAK,CAAC,GAAU;;QACd,OAAO,MAAA,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,0CAAE,EAAE,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,GAAU,EAAE,YAAuB;QACvC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YACvB,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,gEAAgE,EAChE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAChB,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,EAAE,GAAG,YAAY,CAAC;QACtC,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;OAEG;IAEH,kBAAkB,CAChB,KAAY,EACZ,UAAuC;QAEvC,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACpC,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,OAAO;QACT,CAAC;QAED,MAAM,oBAAoB,GAAG,WAAW,CAAC,oBAAoB,CAAC;QAC9D,OAAO,oBAAoB,CAAC,UAAU,CAAC,CAAC;IAC1C,CAAC;IAED,qBAAqB,CACnB,KAAY,EACZ,UAAuC,EACvC,aAAsB;QAEtB,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,CAC7C,KAAK,EACL,UAAU,CACX,CAAC;QACF,IAAI,eAAe,EAAE,CAAC;YACpB,IAAI,aAAa,EAAE,CAAC;gBAClB,MAAM,IAAI,KAAK,CAAC,uBAAuB,KAAK,GAAG,CAAC,CAAC;YACnD,CAAC;iBAAM,CAAC;gBACN,mCAAmC;gBACnC,OAAO,eAAe,CAAC;YACzB,CAAC;QACH,CAAC;QAED,iCAAiC;QACjC,MAAM,eAAe,GAAG,IAAI,CAAC;QAC7B,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC;QAErD,yDAAyD;QACzD,MAAM,eAAe,GAAoB,EAAE,CAAC;QAE5C,eAAe,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACxD,eAAe,CAAC,OAAO,GAAG,OAAO,CAAC;YAClC,eAAe,CAAC,MAAM,GAAG,MAAM,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,MAAM,oBAAoB,GAAG,WAAW,CAAC,oBAAoB,CAAC;QAE9D,oBAAoB,CAAC,UAAU,CAAC,GAAG,eAAe,CAAC;QAEnD,OAAO,eAAe,CAAC;IACzB,CAAC;IAED,sBAAsB,CACpB,KAAY,EACZ,UAAuC,EACvC,KAAc,EACd,WAAoB;QAEpB,MAAM,OAAO,GAAG,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QAC3D,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,EAAE,CAAC;YACrB,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC;QACD,IAAI,WAAW,EAAE,CAAC;YAChB,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QAChD,CAAC;IACH,CAAC;IAED,qBAAqB,CACnB,KAAY,EACZ,UAAuC,EACvC,KAAc,EACd,WAAoB;QAEpB,MAAM,OAAO,GAAG,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QAE3D,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,EAAE,CAAC;YACpB,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,sCAAsC,KAAK,IAAI,UAAU,IAAI,KAAK,EAAE,CACrE,CAAC;YACF,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACxB,CAAC;QAED,IAAI,WAAW,EAAE,CAAC;YAChB,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QAChD,CAAC;IACH,CAAC;IAED,qBAAqB,CACnB,KAAY,EACZ,UAAuC;QAEvC,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACpC,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,OAAO;QACT,CAAC;QAED,MAAM,eAAe,GAAG,WAAW,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QACrE,IAAI,eAAe,EAAE,CAAC;YACpB,4BAA4B;YAC5B,IAAI,eAAe,CAAC,OAAO,EAAE,CAAC;gBAC5B,eAAe,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;YAC5C,CAAC;YAED,OAAO,WAAW,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QACtD,CAAC;IACH,CAAC;IAED,yBAAyB,CAAC,KAAY,EAAE,MAAc;QACpD,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACpC,MAAM,oBAAoB,GAAG,WAAW,CAAC,oBAAoB,CAAC;QAC9D,IAAI,CAAC,WAAW,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC1C,OAAO;QACT,CAAC;QAED,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,4BAAoB,CAAa,CAAC;QAErE,KAAK,MAAM,UAAU,IAAI,oBAAoB,EAAE,CAAC;YAC9C,qDAAqD;YACrD,IAAI,YAAY,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;gBACtC,SAAS;YACX,CAAC;YAED,IAAI,CAAC;gBACH,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,0CAA0C,KAAK,IAAI,UAAU,IAAI,MAAM,EAAE,CAC1E,CAAC;gBACF,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;YAC9D,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,mEAAmE,EACnE,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,EAAE,CACnD,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED,+FAA+F;IAC/F,8BAA8B,CAC5B,KAAY;QAEZ,OAAO,IAAI,CAAC,kBAAkB,CAC5B,KAAK,EACL,4BAAoB,CAAC,sBAAsB,CAC5C,CAAC;IACJ,CAAC;IAED,kCAAkC,CAChC,KAAY;QAEZ,OAAO,IAAI,CAAC,kBAAkB,CAC5B,KAAK,EACL,4BAAoB,CAAC,0BAA0B,CAChD,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,iCAAiC,CAC/B,KAAY,EACZ,aAAsB;QAEtB,OAAO,IAAI,CAAC,qBAAqB,CAC/B,KAAK,EACL,4BAAoB,CAAC,sBAAsB,EAC3C,aAAa,CACd,CAAC;IACJ,CAAC;IAED,qCAAqC,CACnC,KAAY,EACZ,aAAsB;QAEtB,OAAO,IAAI,CAAC,qBAAqB,CAC/B,KAAK,EACL,4BAAoB,CAAC,0BAA0B,EAC/C,aAAa,CACd,CAAC;IACJ,CAAC;IAED,wEAAwE;IACxE,iCAAiC,CAAC,KAAY;QAC5C,OAAO,IAAI,CAAC,qBAAqB,CAC/B,KAAK,EACL,4BAAoB,CAAC,sBAAsB,CAC5C,CAAC;IACJ,CAAC;IAED,qCAAqC,CAAC,KAAY;QAChD,OAAO,IAAI,CAAC,qBAAqB,CAC/B,KAAK,EACL,4BAAoB,CAAC,0BAA0B,CAChD,CAAC;IACJ,CAAC;IAED,sBAAsB;IAEtB,QAAQ,CAAC,GAAU;QACjB,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,GAAU;QAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,eAAgB,CAAC;IAC9C,CAAC;IAED,kBAAkB,CAAC,GAAU,EAAE,KAA4B;QACzD,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,eAAe,GAAG,KAAK,CAAC;QAC5C,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,wBAAwB,GAAG,IAAI,IAAI,EAAE,CAAC;IAC5D,CAAC;IAED,iBAAiB,CAAC,GAAU,EAAE,KAA4B;QACxD,OAAO,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,KAAK,KAAK,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACH,6BAA6B,CAAC,GAAU;QACtC,MAAM,sBAAsB,GAC1B,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,qCAAqB,CAAC,UAAU,CAAC;YAC7D,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,qCAAqB,CAAC,YAAY,CAAC,CAAC;QAElE,IAAI,sBAAsB,EAAE,CAAC;YAC3B,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YACpC,MAAM,kBAAkB,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,wBAAwB,CAAC;YAC7D,MAAM,uBAAuB,GAAG,kBAAkB,aAAlB,kBAAkB,uBAAlB,kBAAkB,CAAE,OAAO,EAAE,CAAC;YAC9D,IAAI,uBAAuB,EAAE,CAAC;gBAC5B,MAAM,YAAY,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;gBAC1C,MAAM,mBAAmB,GAAG,YAAY,GAAG,uBAAuB,CAAC;gBACnE,MAAM,kBAAkB,GAAG,KAAK,CAAC,CAAC,mFAAmF;gBACrH,IAAI,mBAAmB,IAAI,kBAAkB,EAAE,CAAC;oBAC9C,MAAM,GAAG,GAAG,mDAAmD,CAAC;oBAChE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;oBACzC,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,qCAAqB,CAAC,KAAK,CAAC,CAAC;gBAC5D,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,sBAAsB,CAAC;IAChC,CAAC;IAED,uBAAuB;IAEvB,SAAS,CAAC,GAAU;QAClB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,gBAAgB,CAAC;IAC9C,CAAC;IAED,cAAc;QACZ,MAAM,MAAM,GAAQ,EAAE,CAAC;QACvB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAClC,MAAM,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,MAAe,CAAC,CAAC;QACnD,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACH,gBAAgB,CAAC,GAAU,EAAE,KAAiC;QAC5D,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC;QAC/C,KAAK,MAAM,WAAW,IAAI,SAAS,EAAE,CAAC;YACpC,IAAI,iBAAiB,CAAC,KAAK,EAAE,WAAW,CAAC,EAAE,CAAC;gBAC1C,OAAO,WAAW,CAAC;YACrB,CAAC;QACH,CAAC;IACH,CAAC;IAED,QAAQ,CAAC,GAAU,EAAE,KAAiC;QACpD,sEAAsE;QACtE,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACxD,IAAI,aAAa,EAAE,CAAC;YAClB,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAC7B,CAAC;QACD,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACxC,CAAC;IAED,WAAW,CAAC,GAAU,EAAE,KAAiC;QACvD,iDAAiD;QACjD,MAAM,WAAW,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACtD,IAAI,WAAW,EAAE,CAAC;YAChB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAC1C,CAAC;QAED,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;CACF;AArYD,0BAqYC"}

package/lib/util/websockets/WsStore.types.d.ts

@@ -0,0 +1,53 @@
+import WebSocket from 'isomorphic-ws';
+export declare enum WsConnectionStateEnum {
+    INITIAL = 0,
+    CONNECTING = 1,
+    CONNECTED = 2,
+    CLOSING = 3,
+    RECONNECTING = 4,
+    ERROR = 5
+}
+export interface DeferredPromise<TSuccess = any, TError = any> {
+    resolve?: (value: TSuccess) => TSuccess;
+    reject?: (value: TError) => TError;
+    promise?: Promise<TSuccess>;
+}
+export interface WSConnectedResult {
+    wsKey: string;
+    ws: WebSocket;
+}
+export interface WsStoredState<TWSTopicSubscribeEvent extends string | object> {
+    /** The currently active websocket connection */
+    ws?: WebSocket;
+    /** The current lifecycle state of the connection (enum) */
+    connectionState?: WsConnectionStateEnum;
+    connectionStateChangedAt?: Date;
+    /** 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;
+    /** If a reconnection is in progress, this will have the timer for the delayed reconnect */
+    activeReconnectTimer?: ReturnType<typeof setTimeout> | undefined;
+    /**
+     * When a connection attempt is in progress (even for reconnect), a promise is stored here.
+     *
+     * This promise will resolve once connected (and will then get removed);
+     */
+    deferredPromiseStore: Record<string, DeferredPromise>;
+    /**
+     * All the topics we are expected to be subscribed to on this connection (and we automatically resubscribe to if the connection drops)
+     *
+     * A "Set" and a deep-object-match are used to ensure we only subscribe to a
+     * topic once (tracking a list of unique topics we're expected to be connected to)
+     */
+    subscribedTopics: Set<TWSTopicSubscribeEvent>;
+    /** Whether this connection has completed authentication (only applies to private connections) */
+    isAuthenticated?: boolean;
+    /**
+     * Whether this connection has completed authentication before for the Websocket API, so it k
+     * nows to automatically reauth if reconnected
+     */
+    didAuthWSAPI?: boolean;
+    /** To reauthenticate on the WS API, which channel do we send to? */
+    WSAPIAuthChannel?: string;
+}

package/lib/util/websockets/WsStore.types.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WsConnectionStateEnum = void 0;
+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";
+    // ERROR_RECONNECTING = 5,
+    WsConnectionStateEnum[WsConnectionStateEnum["ERROR"] = 5] = "ERROR";
+})(WsConnectionStateEnum || (exports.WsConnectionStateEnum = WsConnectionStateEnum = {}));
+//# sourceMappingURL=WsStore.types.js.map

package/lib/util/websockets/WsStore.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WsStore.types.js","sourceRoot":"","sources":["../../../src/util/websockets/WsStore.types.ts"],"names":[],"mappings":";;;AAGA,IAAY,qBAQX;AARD,WAAY,qBAAqB;IAC/B,uEAAW,CAAA;IACX,6EAAc,CAAA;IACd,2EAAa,CAAA;IACb,uEAAW,CAAA;IACX,iFAAgB,CAAA;IAChB,0BAA0B;IAC1B,mEAAS,CAAA;AACX,CAAC,EARW,qBAAqB,qCAArB,qBAAqB,QAQhC"}

package/lib/util/websockets/listen-key-state-cache.d.ts

@@ -0,0 +1,21 @@
+import { WsMarket } from '../../types/websockets/ws-general';
+import { DefaultLogger } from '../logger';
+interface ListenKeyPersistenceState {
+    keepAliveTimer: ReturnType<typeof setInterval> | undefined;
+    keepAliveRetryTimer: ReturnType<typeof setTimeout> | undefined;
+    lastKeepAlive: number;
+    market: WsMarket;
+    keepAliveFailures: number;
+}
+export declare class ListenKeyStateCache {
+    private logger;
+    private listenKeyStateStore;
+    constructor(customLogger?: DefaultLogger);
+    getListenKeyState(listenKey: string, market: WsMarket): ListenKeyPersistenceState;
+    private clearUserDataKeepAliveTimer;
+    /**
+     * Remove all state for listen key. Clears timers too, if any exist on this listen key store.
+     */
+    clearAllListenKeyState(listenKey: string): void;
+}
+export {};