coinbase-api 0.3.2 → 0.5.0

package/dist/cjs/lib/websocket/WsStore.js

@@ -0,0 +1,254 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WsStore = void 0;
+exports.isDeepObjectMatch = isDeepObjectMatch;
+const logger_js_1 = require("./logger.js");
+const WsStore_types_js_1 = require("./WsStore.types.js");
+/**
+ * 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;
+}
+const DEFERRED_PROMISE_REF = {
+    CONNECTION_IN_PROGRESS: 'CONNECTION_IN_PROGRESS',
+};
+class WsStore {
+    wsState = {};
+    logger;
+    constructor(logger) {
+        this.logger = logger || logger_js_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_js_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?.close();
+        }
+        delete this.wsState[key];
+    }
+    /* connection websocket */
+    hasExistingActiveConnection(key) {
+        return this.get(key) && this.isWsOpen(key);
+    }
+    getWs(key) {
+        return this.get(key)?.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;
+    }
+    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?.resolve) {
+            promise.resolve(value);
+        }
+        if (removeAfter) {
+            this.removeDeferredPromise(wsKey, promiseRef);
+        }
+    }
+    rejectDeferredPromise(wsKey, promiseRef, value, removeAfter) {
+        const promise = this.getDeferredPromise(wsKey, promiseRef);
+        if (promise?.reject) {
+            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(DEFERRED_PROMISE_REF);
+        for (const promiseRef in deferredPromiseStore) {
+            // Skip reserved keys, such as the connection promise
+            if (reservedKeys.includes(promiseRef)) {
+                continue;
+            }
+            try {
+                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, DEFERRED_PROMISE_REF.CONNECTION_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, DEFERRED_PROMISE_REF.CONNECTION_IN_PROGRESS, throwIfExists);
+    }
+    /** Remove promise designed to track a connection attempt in progress */
+    removeConnectingInProgressPromise(wsKey) {
+        return this.removeDeferredPromise(wsKey, DEFERRED_PROMISE_REF.CONNECTION_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) {
+        // console.log(new Date(), `setConnectionState(${key}, ${state})`);
+        this.get(key, true).connectionState = state;
+    }
+    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_js_1.WsConnectionStateEnum.CONNECTING) ||
+            this.isConnectionState(key, WsStore_types_js_1.WsConnectionStateEnum.RECONNECTING);
+        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;
+    }
+    // Since topics are objects we can't rely on the set to detect duplicates
+    /**
+     * Find matching "topic" request from the store
+     * @param key
+     * @param topic
+     * @returns
+     */
+    getMatchingTopic(key, topic) {
+        // if (typeof topic === 'string') {
+        //   return this.getMatchingTopic(key, { channel: topic });
+        // }
+        const allTopics = this.getTopics(key).values();
+        for (const storedTopic of allTopics) {
+            if (isDeepObjectMatch(topic, storedTopic)) {
+                return storedTopic;
+            }
+        }
+    }
+    addTopic(key, topic) {
+        // console.log(`wsStore.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/dist/cjs/lib/websocket/WsStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WsStore.js","sourceRoot":"","sources":["../../../../src/lib/websocket/WsStore.ts"],"names":[],"mappings":";;;AAaA,8CAkBC;AA7BD,2CAA4C;AAC5C,yDAK4B;AAE5B;;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;AAED,MAAM,oBAAoB,GAAG;IAC3B,sBAAsB,EAAE,wBAAwB;CACxC,CAAC;AAKX,MAAa,OAAO;IAIV,OAAO,GACb,EAAE,CAAC;IACG,MAAM,CAAuB;IAErC,YAAY,MAA4B;QACtC,IAAI,CAAC,MAAM,GAAG,MAAM,IAAI,yBAAa,CAAC;IACxC,CAAC;IAWD,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,wCAAqB,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,EAAE,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,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,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,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,EAAE,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;QAC3D,IAAI,OAAO,EAAE,MAAM,EAAE,CAAC;YACpB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACxB,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;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,oBAAoB,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,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,oBAAoB,CAAC,sBAAsB,CAC5C,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,iCAAiC,CAC/B,KAAY,EACZ,aAAsB;QAEtB,OAAO,IAAI,CAAC,qBAAqB,CAC/B,KAAK,EACL,oBAAoB,CAAC,sBAAsB,EAC3C,aAAa,CACd,CAAC;IACJ,CAAC;IAED,wEAAwE;IACxE,iCAAiC,CAAC,KAAY;QAC5C,OAAO,IAAI,CAAC,qBAAqB,CAC/B,KAAK,EACL,oBAAoB,CAAC,sBAAsB,CAC5C,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,mEAAmE;QACnE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,eAAe,GAAG,KAAK,CAAC;IAC9C,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,wCAAqB,CAAC,UAAU,CAAC;YAC7D,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,wCAAqB,CAAC,YAAY,CAAC,CAAC;QAElE,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,yEAAyE;IACzE;;;;;OAKG;IACH,gBAAgB,CAAC,GAAU,EAAE,KAAiC;QAC5D,mCAAmC;QACnC,2DAA2D;QAC3D,IAAI;QAEJ,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,qDAAqD;QACrD,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;AAjVD,0BAiVC"}

package/dist/cjs/lib/websocket/WsStore.types.d.ts

@@ -0,0 +1,49 @@
+import WebSocket from 'isomorphic-ws';
+export declare enum WsConnectionStateEnum {
+    INITIAL = 0,
+    CONNECTING = 1,
+    CONNECTED = 2,
+    CLOSING = 3,
+    RECONNECTING = 4,
+    ERROR_RECONNECTING = 5
+}
+export interface DeferredPromise<TSuccess = any, TError = any> {
+    resolve?: (value: TSuccess) => TSuccess;
+    reject?: (value: TError) => TError;
+    promise?: Promise<TSuccess>;
+}
+export interface WSConnectedResult {
+    wsKey: string;
+}
+export interface WsStoredState<TWSTopicSubscribeEvent extends string | object> {
+    /** The currently active websocket connection */
+    ws?: WebSocket;
+    /** 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;
+    /** 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 is ready for events (welcome message received after connection) */
+    isReadyForEvents?: boolean;
+    /** 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 knows to automatically reauth if reconnected */
+    didAuthWSAPI?: boolean;
+    /** To reauthenticate on the WS API, which channel do we send to? */
+    WSAPIAuthChannel?: string;
+}

package/dist/cjs/lib/websocket/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";
+    WsConnectionStateEnum[WsConnectionStateEnum["ERROR_RECONNECTING"] = 5] = "ERROR_RECONNECTING";
+    // ERROR = 5,
+})(WsConnectionStateEnum || (exports.WsConnectionStateEnum = WsConnectionStateEnum = {}));
+//# sourceMappingURL=WsStore.types.js.map

package/dist/cjs/lib/websocket/WsStore.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WsStore.types.js","sourceRoot":"","sources":["../../../../src/lib/websocket/WsStore.types.ts"],"names":[],"mappings":";;;AAEA,IAAY,qBAQX;AARD,WAAY,qBAAqB;IAC/B,uEAAW,CAAA;IACX,6EAAc,CAAA;IACd,2EAAa,CAAA;IACb,uEAAW,CAAA;IACX,iFAAgB,CAAA;IAChB,6FAAsB,CAAA;IACtB,aAAa;AACf,CAAC,EARW,qBAAqB,qCAArB,qBAAqB,QAQhC"}

package/dist/cjs/lib/websocket/logger.d.ts

@@ -0,0 +1,6 @@
+export type LogParams = null | any;
+export declare const DefaultLogger: {
+    trace: (..._params: LogParams) => void;
+    info: (...params: LogParams) => void;
+    error: (...params: LogParams) => void;
+};

package/dist/cjs/lib/websocket/logger.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultLogger = void 0;
+exports.DefaultLogger = {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    trace: (..._params) => {
+        // console.log(_params);
+    },
+    info: (...params) => {
+        console.info(params);
+    },
+    error: (...params) => {
+        console.error(params);
+    },
+};
+//# sourceMappingURL=logger.js.map

package/dist/cjs/lib/websocket/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../../../src/lib/websocket/logger.ts"],"names":[],"mappings":";;;AAEa,QAAA,aAAa,GAAG;IAC3B,6DAA6D;IAC7D,KAAK,EAAE,CAAC,GAAG,OAAkB,EAAQ,EAAE;QACrC,wBAAwB;IAC1B,CAAC;IACD,IAAI,EAAE,CAAC,GAAG,MAAiB,EAAQ,EAAE;QACnC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACvB,CAAC;IACD,KAAK,EAAE,CAAC,GAAG,MAAiB,EAAQ,EAAE;QACpC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACxB,CAAC;CACF,CAAC"}

package/dist/cjs/lib/websocket/typeGuards.d.ts

@@ -0,0 +1,27 @@
+import { CBAdvancedTradeErrorEvent, CBAdvancedTradeEvent, CBExchangeBaseEvent } from '../../types/websockets/events.js';
+import { WsExchangeRequestOperation, WsInternationalRequestOperation, WsPrimeRequestOperation } from '../../types/websockets/requests.js';
+import { WsKey } from './websocket-util.js';
+export declare function isCBAdvancedTradeWSEvent(event: unknown): event is CBAdvancedTradeEvent;
+/**
+ * Type guard that checks whether this event is/extends CBExchangeBaseEvent
+ */
+export declare function isCBExchangeWSEvent(event: unknown, wsKey: WsKey): event is CBExchangeBaseEvent;
+/**
+ * Type guard for error-type response events seen for the Advnaced Trade WS channel
+ */
+export declare function isCBAdvancedTradeErrorEvent(event: unknown): event is CBAdvancedTradeErrorEvent;
+/**
+ * Silly type guard for the structure of events being sent to the server
+ * (e.g. when subscribing to a topic)
+ */
+export declare function isCBExchangeWSRequestOperation<TWSTopic extends string = string>(evt: unknown, wsKey: WsKey): evt is WsExchangeRequestOperation<TWSTopic>;
+/**
+ * Silly type guard for the structure of events being sent to the server
+ * (e.g. when subscribing to a topic)
+ */
+export declare function isCBINTXWSRequestOperation<TWSTopic extends string = string>(evt: unknown, wsKey: WsKey): evt is WsInternationalRequestOperation<TWSTopic>;
+/**
+ * Silly type guard for the structure of events being sent to the server
+ * (e.g. when subscribing to a topic)
+ */
+export declare function isCBPrimeWSRequestOperation<TWSTopic extends string = string>(evt: unknown, wsKey: WsKey): evt is WsPrimeRequestOperation<TWSTopic>;

package/dist/cjs/lib/websocket/typeGuards.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isCBAdvancedTradeWSEvent = isCBAdvancedTradeWSEvent;
+exports.isCBExchangeWSEvent = isCBExchangeWSEvent;
+exports.isCBAdvancedTradeErrorEvent = isCBAdvancedTradeErrorEvent;
+exports.isCBExchangeWSRequestOperation = isCBExchangeWSRequestOperation;
+exports.isCBINTXWSRequestOperation = isCBINTXWSRequestOperation;
+exports.isCBPrimeWSRequestOperation = isCBPrimeWSRequestOperation;
+const websocket_util_js_1 = require("./websocket-util.js");
+function isDefinedObject(value) {
+    return typeof value === 'object' || !value;
+}
+function isCBAdvancedTradeWSEvent(event) {
+    if (!isDefinedObject(event)) {
+        return false;
+    }
+    const message = event;
+    return typeof message.channel === 'string';
+}
+/**
+ * Type guard that checks whether this event is/extends CBExchangeBaseEvent
+ */
+function isCBExchangeWSEvent(event, wsKey) {
+    if (!isDefinedObject(event)) {
+        return false;
+    }
+    return (wsKey === websocket_util_js_1.WS_KEY_MAP.exchangeMarketData ||
+        wsKey === websocket_util_js_1.WS_KEY_MAP.exchangeDirectMarketData);
+}
+/**
+ * Type guard for error-type response events seen for the Advnaced Trade WS channel
+ */
+function isCBAdvancedTradeErrorEvent(event) {
+    if (!isDefinedObject(event)) {
+        return false;
+    }
+    const message = event;
+    return message.type === 'error';
+}
+/**
+ * Silly type guard for the structure of events being sent to the server
+ * (e.g. when subscribing to a topic)
+ */
+function isCBExchangeWSRequestOperation(evt, wsKey) {
+    if (!isDefinedObject(evt)) {
+        return false;
+    }
+    const looselyTypedEvent = evt;
+    if (typeof looselyTypedEvent.type !== 'string' ||
+        !Array.isArray(looselyTypedEvent.channels)) {
+        return false;
+    }
+    return (wsKey === websocket_util_js_1.WS_KEY_MAP.exchangeDirectMarketData ||
+        wsKey === websocket_util_js_1.WS_KEY_MAP.exchangeMarketData);
+}
+/**
+ * Silly type guard for the structure of events being sent to the server
+ * (e.g. when subscribing to a topic)
+ */
+function isCBINTXWSRequestOperation(evt, wsKey) {
+    if (!isDefinedObject(evt)) {
+        return false;
+    }
+    const looselyTypedEvent = evt;
+    if (typeof looselyTypedEvent.type !== 'string' ||
+        !Array.isArray(looselyTypedEvent.channels)) {
+        return false;
+    }
+    return wsKey === websocket_util_js_1.WS_KEY_MAP.internationalMarketData;
+}
+/**
+ * Silly type guard for the structure of events being sent to the server
+ * (e.g. when subscribing to a topic)
+ */
+function isCBPrimeWSRequestOperation(evt, wsKey) {
+    if (!isDefinedObject(evt)) {
+        return false;
+    }
+    const looselyTypedEvent = evt;
+    if (typeof looselyTypedEvent.type !== 'string' ||
+        typeof looselyTypedEvent.channel !== 'string') {
+        return false;
+    }
+    return wsKey === websocket_util_js_1.WS_KEY_MAP.internationalMarketData;
+}
+//# sourceMappingURL=typeGuards.js.map

package/dist/cjs/lib/websocket/typeGuards.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typeGuards.js","sourceRoot":"","sources":["../../../../src/lib/websocket/typeGuards.ts"],"names":[],"mappings":";;AAiBA,4DASC;AAKD,kDAYC;AAKD,kEASC;AAMD,wEAoBC;AAMD,gEAkBC;AAMD,kEAkBC;AAxHD,2DAAwD;AAExD,SAAS,eAAe,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC;AAC7C,CAAC;AAED,SAAgB,wBAAwB,CACtC,KAAc;IAEd,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC;QAC5B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,OAAO,GAAG,KAA6B,CAAC;IAC9C,OAAO,OAAO,OAAO,CAAC,OAAO,KAAK,QAAQ,CAAC;AAC7C,CAAC;AAED;;GAEG;AACH,SAAgB,mBAAmB,CACjC,KAAc,EACd,KAAY;IAEZ,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC;QAC5B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,CACL,KAAK,KAAK,8BAAU,CAAC,kBAAkB;QACvC,KAAK,KAAK,8BAAU,CAAC,wBAAwB,CAC9C,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,SAAgB,2BAA2B,CACzC,KAAc;IAEd,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC;QAC5B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,OAAO,GAAG,KAAkC,CAAC;IACnD,OAAO,OAAO,CAAC,IAAI,KAAK,OAAO,CAAC;AAClC,CAAC;AAED;;;GAGG;AACH,SAAgB,8BAA8B,CAE5C,GAAY,EAAE,KAAY;IAC1B,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,iBAAiB,GAAG,GAA2C,CAAC;IAEtE,IACE,OAAO,iBAAiB,CAAC,IAAI,KAAK,QAAQ;QAC1C,CAAC,KAAK,CAAC,OAAO,CAAC,iBAAiB,CAAC,QAAQ,CAAC,EAC1C,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,CACL,KAAK,KAAK,8BAAU,CAAC,wBAAwB;QAC7C,KAAK,KAAK,8BAAU,CAAC,kBAAkB,CACxC,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,SAAgB,0BAA0B,CACxC,GAAY,EACZ,KAAY;IAEZ,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,iBAAiB,GAAG,GAAgD,CAAC;IAE3E,IACE,OAAO,iBAAiB,CAAC,IAAI,KAAK,QAAQ;QAC1C,CAAC,KAAK,CAAC,OAAO,CAAC,iBAAiB,CAAC,QAAQ,CAAC,EAC1C,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,KAAK,KAAK,8BAAU,CAAC,uBAAuB,CAAC;AACtD,CAAC;AAED;;;GAGG;AACH,SAAgB,2BAA2B,CACzC,GAAY,EACZ,KAAY;IAEZ,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,iBAAiB,GAAG,GAAwC,CAAC;IAEnE,IACE,OAAO,iBAAiB,CAAC,IAAI,KAAK,QAAQ;QAC1C,OAAO,iBAAiB,CAAC,OAAO,KAAK,QAAQ,EAC7C,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,KAAK,KAAK,8BAAU,CAAC,uBAAuB,CAAC;AACtD,CAAC"}

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

@@ -0,0 +1,120 @@
+import WebSocket from 'isomorphic-ws';
+import { WsExchangeRequestOperation, WsInternationalRequestOperation } from '../../types/websockets/requests.js';
+/**
+ * Each websocket URL (domain + endpoint) is represented as a "WS Key". Authentication is handled automatically if required.
+ */
+export declare const WS_KEY_MAP: {
+    /**
+     * Market Data is the traditional feed that provides updates for both orders and trades.
+     * Most channels are now available without authentication.
+     *
+     * https://docs.cdp.coinbase.com/advanced-trade/docs/ws-overview
+     */
+    readonly advTradeMarketData: "advTradeMarketData";
+    /**
+     * User Order Data provides updates for the orders of the user.
+     *
+     * https://docs.cdp.coinbase.com/advanced-trade/docs/ws-overview
+     */
+    readonly advTradeUserData: "advTradeUserData";
+    /**
+     * Coinbase Market Data (part of Coinbase Exchange API) is the traditional feed which is available without authentication.
+     *
+     * https://docs.cdp.coinbase.com/exchange/docs/websocket-overview
+     */
+    readonly exchangeMarketData: "exchangeMarketData";
+    /**
+     * Coinbase Direct Market Data has direct access to Coinbase Exchange servers and requires Authentication.
+     *
+     * https://docs.cdp.coinbase.com/exchange/docs/websocket-overview
+     */
+    readonly exchangeDirectMarketData: "exchangeDirectMarketData";
+    /**
+     * The INTX WebSocket feed is publicly available and provides real-time market data updates for orders and trades.
+     * The SDK must authenticate when subscribing to the WebSocket Feed the very first time.
+     *
+     * https://docs.cdp.coinbase.com/intx/docs/websocket-overview
+     */
+    readonly internationalMarketData: "internationalMarketData";
+    /**
+     * The Prime WebSocket feed provides real-time market data updates for orders and trades. To begin
+     * receiving feed messages, you must send a signed subscribe message to the server indicating
+     * which channels and products to receive. The SDK will handle this automatically.
+     *
+     * https://docs.cdp.coinbase.com/prime/docs/websocket-feed
+     */
+    readonly primeMarketData: "primeMarketData";
+};
+/** This is used to differentiate between each of the available websocket streams */
+export type WsKey = (typeof WS_KEY_MAP)[keyof typeof WS_KEY_MAP];
+/**
+ * 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.
+ */
+export interface WsTopicRequest<TWSTopic extends string = string, TWSPayload = any> {
+    topic: TWSTopic;
+    /**
+     * Any parameters to include with the request. These are automatically merged into the request.
+     */
+    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 = any> = WsTopicRequest<TWSTopic, TWSPayload> | string;
+export interface MessageEventLike {
+    target: WebSocket;
+    type: 'message';
+    data: string;
+}
+export declare function isMessageEvent(msg: unknown): msg is MessageEventLike;
+/**
+ * Some exchanges have two livenet environments, some have test environments, some dont. This allows easy flexibility for different exchanges.
+ * Examples:
+ *  - One livenet and one testnet: NetworkMap<'livenet' | 'testnet'>
+ *  - One livenet, sometimes two, one testnet: NetworkMap<'livenet' | 'testnet', 'livenet2'>
+ *  - Only one livenet, no other networks: NetworkMap<'livenet'>
+ */
+type NetworkMap<TRequiredKeys extends string, TOptionalKeys extends string | undefined = undefined> = Record<TRequiredKeys, string> & (TOptionalKeys extends string ? Record<TOptionalKeys, string | undefined> : Record<TRequiredKeys, string>);
+export declare const WS_URL_MAP: Record<WsKey, NetworkMap<'livenet' | 'testnet'>>;
+/**
+ * Merge one or more WS Request operations (e.g. subscribe request) for
+ * CB Exchange into one, allowing them to be sent as one request
+ */
+export declare function getMergedCBExchangeWSRequestOperations<TWSTopic extends string = string>(operations: WsExchangeRequestOperation<TWSTopic>[]): WsExchangeRequestOperation<TWSTopic>;
+/**
+ * Merge one or more WS Request operations (e.g. subscribe request) for
+ * CB Exchange into one, allowing them to be sent as one request
+ */
+export declare function getMergedCBINTXRequestOperations<TWSTopic extends string = string>(operations: WsInternationalRequestOperation<TWSTopic>[]): WsInternationalRequestOperation<TWSTopic>;
+/**
+ * Return sign used to authenticate CB Exchange WS requests
+ */
+export declare function getCBExchangeWSSign(apiSecret: string): Promise<{
+    timestampInSeconds: string;
+    sign: string;
+}>;
+/**
+ * Return sign used to authenticate CB INTX WS requests
+ */
+export declare function getCBInternationalWSSign(apiKey: string, apiSecret: string, apiPassphrase: string): Promise<{
+    timestampInSeconds: string;
+    sign: string;
+}>;
+/**
+ * Return sign used to authenticate CB Prime WS requests
+ */
+export declare function getCBPrimeWSSign(params: {
+    channelName: string;
+    svcAccountId: string;
+    portfolioId: string;
+    apiKey: string;
+    apiSecret: string;
+    product_ids?: string[];
+}): Promise<{
+    timestampInSeconds: string;
+    sign: string;
+}>;
+export {};