@shapeshiftoss/unchained-client 9.1.0 → 9.3.0

package/dist/websocket.js

@@ -10,25 +10,119 @@ const logger = new logger_1.Logger({
     namespace: ['unchained-client', 'websocket'],
     level: process.env.LOG_LEVEL
 });
+const NORMAL_CLOSURE_CODE = 1000;
 class Client {
     constructor(url) {
         this.pingInterval = 10000;
+        this.retryAttempts = 5;
+        this.retryCount = 0;
         this.txs = {};
         this.url = url;
         this.connections = {
             txs: undefined
         };
     }
+    async initialize() {
+        const ws = new isomorphic_ws_1.default(this.url);
+        this.connections.txs = { ws };
+        // wait for connection to open with handshake timeout
+        await new Promise((resolve, reject) => {
+            setTimeout(() => reject(new Error('timeout while trying to connect')), 5000);
+            ws.onopen = ({ target }) => this.onOpen(target, resolve, reject);
+            ws.onclose = (event) => this.onClose(event, resolve, reject);
+            ws.onerror = (event) => this.onError(event);
+            ws.onmessage = (event) => this.onMessage(event);
+        });
+    }
+    onOpen(ws, resolve, reject) {
+        this.retryCount = 0;
+        const interval = setInterval(() => {
+            // browsers do not support ping/pong frame, send ping payload instead
+            const payload = { subscriptionId: '', method: 'ping' };
+            ws.send(JSON.stringify(payload));
+        }, this.pingInterval);
+        this.heartbeat('txs');
+        if (this.connections.txs) {
+            this.connections.txs.interval = interval;
+        }
+        else {
+            this.connections.txs = { ws, interval };
+        }
+        try {
+            // subscribe to all subscriptions
+            Object.entries(this.txs).forEach(([id, { data }]) => {
+                const payload = { subscriptionId: id, method: 'subscribe', data };
+                ws.send(JSON.stringify(payload));
+            });
+            resolve(true);
+        }
+        catch (err) {
+            reject(err);
+        }
+    }
+    onClose(event, resolve, reject) {
+        var _a, _b;
+        logger.warn({ fn: 'onClose', code: event.code, reason: event.reason, type: event.type }, 'websocket closed');
+        ((_a = this.connections.txs) === null || _a === void 0 ? void 0 : _a.pingTimeout) && clearTimeout(this.connections.txs.pingTimeout);
+        ((_b = this.connections.txs) === null || _b === void 0 ? void 0 : _b.interval) && clearInterval(this.connections.txs.interval);
+        // attempt reconnect logic on non standard exit codes
+        if (event.code !== NORMAL_CLOSURE_CODE) {
+            if (++this.retryCount >= this.retryAttempts) {
+                reject(new Error('failed to reconnect, connection closed'));
+                return;
+            }
+            setTimeout(() => this.initialize(), 500 * this.retryCount ** 2);
+        }
+        resolve(false);
+    }
+    onError(event) {
+        if (!event.message)
+            return;
+        logger.error({ fn: 'onError', err: event.error, message: event.message, type: event.type }, 'websocket error');
+        // send connection errors to all subscription onError handlers
+        Object.entries(this.txs).forEach(([id, sub]) => {
+            var _a;
+            (_a = sub.onError) === null || _a === void 0 ? void 0 : _a.call(sub, { subscriptionId: id, type: 'error', message: event.message });
+        });
+    }
+    onMessage(event) {
+        var _a, _b, _c, _d;
+        if (event.type !== 'message')
+            return;
+        // trigger heartbeat keep alive on pong response
+        if (event.data === 'pong') {
+            this.heartbeat('txs');
+            return;
+        }
+        try {
+            const message = JSON.parse(event.data.toString());
+            const subscriptionId = this.getDefaultSubscriptionId();
+            // narrow type to ErrorResponse if key `type` exists and forward to correct onError handler
+            if ('type' in message) {
+                return (_b = (_a = this.txs[message.subscriptionId || subscriptionId]) === null || _a === void 0 ? void 0 : _a.onError) === null || _b === void 0 ? void 0 : _b.call(_a, message);
+            }
+            // forward the transaction message to the correct onMessage handler
+            (_d = (_c = this.txs[message.subscriptionId || subscriptionId]) === null || _c === void 0 ? void 0 : _c.onMessage) === null || _d === void 0 ? void 0 : _d.call(_c, message);
+        }
+        catch (err) {
+            logger.warn(`failed to handle onmessage event: ${JSON.stringify(event)}: ${err}`);
+        }
+    }
     heartbeat(topic) {
         const connection = this.connections[topic];
         if (!connection)
             return;
         connection.pingTimeout && clearTimeout(connection.pingTimeout);
         connection.pingTimeout = setTimeout(() => {
+            var _a;
             logger.warn({ fn: 'pingTimeout' }, `${topic} heartbeat failed`);
-            connection === null || connection === void 0 ? void 0 : connection.ws.close();
+            (_a = connection.ws) === null || _a === void 0 ? void 0 : _a.close();
         }, this.pingInterval + 5000);
     }
+    // for websocket connections that do not return the subscriptionId on the message, use the initial subscriptionId as the default
+    getDefaultSubscriptionId() {
+        return Object.keys(this.txs)[0];
+    }
     /**
      * Subscribe to transaction history and updates for newly confirmed and pending transactions.
      *
@@ -42,95 +136,20 @@ class Client {
      * @param [onError] optional handler for any error messages associated with `subscriptionId`
      */
     async subscribeTxs(subscriptionId, data, onMessage, onError) {
-        // keep track of the onMessage and onError handlers associated with each subscriptionId
-        this.txs[subscriptionId] = { onMessage, onError, data: undefined };
-        if (this.connections.txs) {
-            if (this.connections.txs.ws.readyState === 1) {
-                // subscribe if connection exists and is ready
-                this.connections.txs.ws.send(JSON.stringify({ subscriptionId, method: 'subscribe', data }));
-            }
-            else {
-                // queue up unique addresses for subscriptions if connection exists, but is not ready yet
-                const txsData = this.txs[subscriptionId].data;
-                this.txs[subscriptionId].data = txsData
-                    ? { ...txsData, addresses: [...new Set(...txsData.addresses, ...data.addresses)] }
-                    : data;
-            }
-            return;
+        var _a, _b, _c, _d;
+        const addresses = [
+            ...new Set([...((_c = (_b = (_a = this.txs[subscriptionId]) === null || _a === void 0 ? void 0 : _a.data) === null || _b === void 0 ? void 0 : _b.addresses) !== null && _c !== void 0 ? _c : []), ...data.addresses])
+        ];
+        // keep track of all subscribed addresses and onMessage/onError handlers associated with each subscriptionId
+        this.txs[subscriptionId] = { onMessage, onError, data: { topic: 'txs', addresses } };
+        // initialize websocket connection if one does not already exist
+        if (!((_d = this.connections.txs) === null || _d === void 0 ? void 0 : _d.ws)) {
+            return this.initialize();
+        }
+        // subscribe if connection exists and is ready
+        if (this.connections.txs.ws.readyState === isomorphic_ws_1.default.OPEN) {
+            this.connections.txs.ws.send(JSON.stringify({ subscriptionId, method: 'subscribe', data }));
         }
-        const ws = new isomorphic_ws_1.default(this.url);
-        const interval = setInterval(() => {
-            // browsers do not support ping/pong frame, send ping payload instead
-            const payload = { subscriptionId: '', method: 'ping' };
-            ws.send(JSON.stringify(payload));
-        }, this.pingInterval);
-        this.connections.txs = { ws, interval };
-        // send connection errors to all subscription onError handlers
-        ws.onerror = (event) => {
-            Object.entries(this.txs).forEach(([id, sub]) => {
-                sub.onError && sub.onError({ subscriptionId: id, type: 'error', message: event.message });
-            });
-        };
-        // clear heartbeat timeout on close
-        ws.onclose = () => {
-            var _a, _b;
-            ((_a = this.connections.txs) === null || _a === void 0 ? void 0 : _a.pingTimeout) && clearTimeout(this.connections.txs.pingTimeout);
-            ((_b = this.connections.txs) === null || _b === void 0 ? void 0 : _b.interval) && clearInterval(this.connections.txs.interval);
-        };
-        ws.onmessage = (event) => {
-            var _a, _b;
-            if (!event)
-                return;
-            if (event.type !== 'message')
-                return;
-            if (event.data === 'pong') {
-                // trigger heartbeat keep alive on pong response
-                this.heartbeat('txs');
-                return;
-            }
-            try {
-                const message = JSON.parse(event.data.toString());
-                // narrow type to ErrorResponse if key `type` exists and forward to correct onError handler
-                if ('type' in message) {
-                    const onErrorHandler = (_a = this.txs[message.subscriptionId || subscriptionId]) === null || _a === void 0 ? void 0 : _a.onError;
-                    onErrorHandler && onErrorHandler(message);
-                    return;
-                }
-                // forward the transaction message to the correct onMessage handler
-                const onMessageHandler = (_b = this.txs[message.subscriptionId || subscriptionId]) === null || _b === void 0 ? void 0 : _b.onMessage;
-                onMessageHandler && onMessageHandler(message);
-            }
-            catch (err) {
-                logger.warn(`failed to handle onmessage event: ${JSON.stringify(event)}: ${err}`);
-            }
-        };
-        // wait for the connection to open
-        const openConnection = new Promise((resolve, reject) => {
-            ws.onopen = () => {
-                this.heartbeat('txs');
-                try {
-                    // subscribe to all queued subscriptions
-                    Object.values(this.txs).forEach((tx) => {
-                        if (!tx.data)
-                            return;
-                        const payload = { subscriptionId, method: 'subscribe', data: tx.data };
-                        ws.send(JSON.stringify(payload));
-                        delete this.txs[subscriptionId].data;
-                    });
-                    // subscribe to initial subscription
-                    const payload = { subscriptionId, method: 'subscribe', data };
-                    ws.send(JSON.stringify(payload));
-                    resolve(true);
-                }
-                catch (err) {
-                    reject(err);
-                }
-            };
-        });
-        const connectionTimeout = new Promise((_, reject) => {
-            setTimeout(() => reject(new Error('timeout while trying to connect')), 5000);
-        });
-        await Promise.race([openConnection, connectionTimeout]);
     }
     /**
      * Unsubscribe from transaction history and updates for newly confirmed and pending transactions.
@@ -146,19 +165,27 @@ class Client {
      * @param data.addresses list of addresses to unsubscribe from
      */
     unsubscribeTxs(subscriptionId, data) {
-        var _a, _b, _c;
-        if (((_a = this.connections.txs) === null || _a === void 0 ? void 0 : _a.ws.readyState) !== isomorphic_ws_1.default.OPEN)
+        var _a, _b, _c, _d, _e;
+        if (((_b = (_a = this.connections.txs) === null || _a === void 0 ? void 0 : _a.ws) === null || _b === void 0 ? void 0 : _b.readyState) !== isomorphic_ws_1.default.OPEN)
             return;
         if (!subscriptionId)
             this.txs = {};
-        if (subscriptionId && !(data === null || data === void 0 ? void 0 : data.addresses.length))
-            delete this.txs[subscriptionId];
+        if (subscriptionId && this.txs[subscriptionId]) {
+            // unsubscribe addresses from the current subscribed address set if addresses provided
+            if ((_c = data === null || data === void 0 ? void 0 : data.addresses) === null || _c === void 0 ? void 0 : _c.length) {
+                this.txs[subscriptionId].data.addresses = this.txs[subscriptionId].data.addresses.filter((address) => !data.addresses.includes(address));
+            }
+            else {
+                // delete subscription if no addresses provided
+                delete this.txs[subscriptionId];
+            }
+        }
         const payload = {
             subscriptionId: subscriptionId !== null && subscriptionId !== void 0 ? subscriptionId : '',
             method: 'unsubscribe',
-            data: { topic: 'txs', addresses: (_b = data === null || data === void 0 ? void 0 : data.addresses) !== null && _b !== void 0 ? _b : [] }
+            data: { topic: 'txs', addresses: (_d = data === null || data === void 0 ? void 0 : data.addresses) !== null && _d !== void 0 ? _d : [] }
         };
-        (_c = this.connections.txs) === null || _c === void 0 ? void 0 : _c.ws.send(JSON.stringify(payload));
+        (_e = this.connections.txs) === null || _e === void 0 ? void 0 : _e.ws.send(JSON.stringify(payload));
     }
     /**
      * Close and unsubscribe from any subscriptions
@@ -169,9 +196,9 @@ class Client {
      */
     close(topic) {
         const closeTxs = () => {
-            var _a;
+            var _a, _b;
             this.unsubscribeTxs();
-            (_a = this.connections.txs) === null || _a === void 0 ? void 0 : _a.ws.close();
+            (_b = (_a = this.connections.txs) === null || _a === void 0 ? void 0 : _a.ws) === null || _b === void 0 ? void 0 : _b.close(NORMAL_CLOSURE_CODE);
         };
         // close all connections if no topic is provided
         if (!topic) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shapeshiftoss/unchained-client",
-  "version": "9.1.0",
+  "version": "9.3.0",
   "license": "MIT",
   "main": "dist/index.js",
   "source": "src/index.ts",