ccxt 4.3.94 → 4.3.96

package/dist/cjs/src/pro/cryptocom.js

@@ -80,6 +80,20 @@ class cryptocom extends cryptocom$1 {
          */
         return await this.watchOrderBookForSymbols([symbol], limit, params);
     }
+    async unWatchOrderBook(symbol, params = {}) {
+        /**
+         * @method
+         * @name cryptocom#unWatchOrderBook
+         * @description unWatches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
+         * @see https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#book-instrument_name
+         * @param {string} symbol unified symbol of the market to fetch the order book for
+         * @param {object} [params] extra parameters specific to the exchange API endpoint
+         * @param {string} [params.bookSubscriptionType] The subscription type. Allowed values: SNAPSHOT full snapshot. This is the default if not specified. SNAPSHOT_AND_UPDATE delta updates
+         * @param {int} [params.bookUpdateFrequency] Book update interval in ms. Allowed values: 100 for snapshot subscription 10 for delta subscription
+         * @returns {object} A dictionary of [order book structures]{@link https://docs.ccxt.com/#/?id=order-book-structure} indexed by market symbols
+         */
+        return await this.unWatchOrderBookForSymbols([symbol], params);
+    }
     async watchOrderBookForSymbols(symbols, limit = undefined, params = {}) {
         /**
          * @method
@@ -127,6 +141,52 @@ class cryptocom extends cryptocom$1 {
         const orderbook = await this.watchPublicMultiple(messageHashes, topics, params);
         return orderbook.limit();
     }
+    async unWatchOrderBookForSymbols(symbols, params = {}) {
+        /**
+         * @method
+         * @name cryptocom#unWatchOrderBookForSymbols
+         * @description unWatches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
+         * @see https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#book-instrument_name
+         * @param {string[]} symbols unified array of symbols
+         * @param {object} [params] extra parameters specific to the exchange API endpoint
+         * @param {int} [params.limit] orderbook limit, default is 50
+         * @param {string} [params.bookSubscriptionType] The subscription type. Allowed values: SNAPSHOT full snapshot. This is the default if not specified. SNAPSHOT_AND_UPDATE delta updates
+         * @param {int} [params.bookUpdateFrequency] Book update interval in ms. Allowed values: 100 for snapshot subscription 10 for delta subscription
+         * @returns {object} A dictionary of [order book structures]{@link https://docs.ccxt.com/#/?id=order-book-structure} indexed by market symbols
+         */
+        await this.loadMarkets();
+        symbols = this.marketSymbols(symbols);
+        const topics = [];
+        const subMessageHashes = [];
+        const messageHashes = [];
+        const limit = this.safeInteger(params, 'limit', 50);
+        const topicParams = this.safeValue(params, 'params');
+        if (topicParams === undefined) {
+            params['params'] = {};
+        }
+        let bookSubscriptionType = undefined;
+        let bookSubscriptionType2 = undefined;
+        [bookSubscriptionType, params] = this.handleOptionAndParams(params, 'watchOrderBook', 'bookSubscriptionType', 'SNAPSHOT_AND_UPDATE');
+        [bookSubscriptionType2, params] = this.handleOptionAndParams(params, 'watchOrderBookForSymbols', 'bookSubscriptionType', bookSubscriptionType);
+        params['params']['bookSubscriptionType'] = bookSubscriptionType2;
+        let bookUpdateFrequency = undefined;
+        let bookUpdateFrequency2 = undefined;
+        [bookUpdateFrequency, params] = this.handleOptionAndParams(params, 'watchOrderBook', 'bookUpdateFrequency');
+        [bookUpdateFrequency2, params] = this.handleOptionAndParams(params, 'watchOrderBookForSymbols', 'bookUpdateFrequency', bookUpdateFrequency);
+        if (bookUpdateFrequency2 !== undefined) {
+            params['params']['bookSubscriptionType'] = bookUpdateFrequency2;
+        }
+        for (let i = 0; i < symbols.length; i++) {
+            const symbol = symbols[i];
+            const market = this.market(symbol);
+            const currentTopic = 'book' + '.' + market['id'] + '.' + limit.toString();
+            const messageHash = 'orderbook:' + market['symbol'];
+            subMessageHashes.push(messageHash);
+            messageHashes.push('unsubscribe:' + messageHash);
+            topics.push(currentTopic);
+        }
+        return await this.unWatchPublicMultiple('orderbook', symbols, messageHashes, subMessageHashes, topics, params);
+    }
     handleDelta(bookside, delta) {
         const price = this.safeFloat(delta, 0);
         const amount = this.safeFloat(delta, 1);
@@ -247,6 +307,20 @@ class cryptocom extends cryptocom$1 {
          */
         return await this.watchTradesForSymbols([symbol], since, limit, params);
     }
+    async unWatchTrades(symbol, params = {}) {
+        /**
+         * @method
+         * @name cryptocom#unWatchTrades
+         * @description get the list of most recent trades for a particular symbol
+         * @see https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#trade-instrument_name
+         * @param {string} symbol unified symbol of the market to fetch trades for
+         * @param {int} [since] timestamp in ms of the earliest trade to fetch
+         * @param {int} [limit] the maximum amount of trades to fetch
+         * @param {object} [params] extra parameters specific to the exchange API endpoint
+         * @returns {object[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=public-trades}
+         */
+        return await this.unWatchTradesForSymbols([symbol], params);
+    }
     async watchTradesForSymbols(symbols, since = undefined, limit = undefined, params = {}) {
         /**
          * @method
@@ -276,6 +350,29 @@ class cryptocom extends cryptocom$1 {
         }
         return this.filterBySinceLimit(trades, since, limit, 'timestamp', true);
     }
+    async unWatchTradesForSymbols(symbols, params = {}) {
+        /**
+         * @method
+         * @name cryptocom#unWatchTradesForSymbols
+         * @description get the list of most recent trades for a particular symbol
+         * @see https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#trade-instrument_name
+         * @param {string} symbol unified symbol of the market to fetch trades for
+         * @param {object} [params] extra parameters specific to the exchange API endpoint
+         * @returns {object[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=public-trades}
+         */
+        await this.loadMarkets();
+        symbols = this.marketSymbols(symbols);
+        const topics = [];
+        const messageHashes = [];
+        for (let i = 0; i < symbols.length; i++) {
+            const symbol = symbols[i];
+            const market = this.market(symbol);
+            const currentTopic = 'trade' + '.' + market['id'];
+            messageHashes.push('unsubscribe:trades:' + market['symbol']);
+            topics.push(currentTopic);
+        }
+        return await this.unWatchPublicMultiple('trade', symbols, messageHashes, topics, topics, params);
+    }
     handleTrades(client, message) {
         //
         // {
@@ -364,6 +461,22 @@ class cryptocom extends cryptocom$1 {
         const messageHash = 'ticker' + '.' + market['id'];
         return await this.watchPublic(messageHash, params);
     }
+    async unWatchTicker(symbol, params = {}) {
+        /**
+         * @method
+         * @name cryptocom#unWatchTicker
+         * @description unWatches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
+         * @see https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#ticker-instrument_name
+         * @param {string} symbol unified symbol of the market to fetch the ticker for
+         * @param {object} [params] extra parameters specific to the exchange API endpoint
+         * @returns {object} a [ticker structure]{@link https://docs.ccxt.com/#/?id=ticker-structure}
+         */
+        await this.loadMarkets();
+        const market = this.market(symbol);
+        const subMessageHash = 'ticker' + '.' + market['id'];
+        const messageHash = 'unsubscribe:ticker:' + market['symbol'];
+        return await this.unWatchPublicMultiple('ticker', [market['symbol']], [messageHash], [subMessageHash], [subMessageHash], params);
+    }
     handleTicker(client, message) {
         //
         // {
@@ -423,6 +536,28 @@ class cryptocom extends cryptocom$1 {
         }
         return this.filterBySinceLimit(ohlcv, since, limit, 0, true);
     }
+    async unWatchOHLCV(symbol, timeframe = '1m', params = {}) {
+        /**
+         * @method
+         * @name cryptocom#unWatchOHLCV
+         * @description unWatches historical candlestick data containing the open, high, low, and close price, and the volume of a market
+         * @see https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#candlestick-time_frame-instrument_name
+         * @param {string} symbol unified symbol of the market to fetch OHLCV data for
+         * @param {string} timeframe the length of time each candle represents
+         * @param {object} [params] extra parameters specific to the exchange API endpoint
+         * @returns {int[][]} A list of candles ordered as timestamp, open, high, low, close, volume
+         */
+        await this.loadMarkets();
+        const market = this.market(symbol);
+        symbol = market['symbol'];
+        const interval = this.safeString(this.timeframes, timeframe, timeframe);
+        const subMessageHash = 'candlestick' + '.' + interval + '.' + market['id'];
+        const messageHash = 'unsubscribe:ohlcv:' + market['symbol'] + ':' + timeframe;
+        const subExtend = {
+            'symbolsAndTimeframes': [[market['symbol'], timeframe]],
+        };
+        return await this.unWatchPublicMultiple('ohlcv', [market['symbol']], [messageHash], [subMessageHash], [subMessageHash], params, subExtend);
+    }
     handleOHLCV(client, message) {
         //
         //  {
@@ -853,6 +988,27 @@ class cryptocom extends cryptocom$1 {
         const message = this.deepExtend(request, params);
         return await this.watchMultiple(url, messageHashes, message, messageHashes);
     }
+    async unWatchPublicMultiple(topic, symbols, messageHashes, subMessageHashes, topics, params = {}, subExtend = {}) {
+        const url = this.urls['api']['ws']['public'];
+        const id = this.nonce();
+        const request = {
+            'method': 'unsubscribe',
+            'params': {
+                'channels': topics,
+            },
+            'nonce': id,
+            'id': id.toString(),
+        };
+        const subscription = {
+            'id': id.toString(),
+            'topic': topic,
+            'symbols': symbols,
+            'subMessageHashes': subMessageHashes,
+            'messageHashes': messageHashes,
+        };
+        const message = this.deepExtend(request, params);
+        return await this.watchMultiple(url, messageHashes, message, messageHashes, this.extend(subscription, subExtend));
+    }
     async watchPrivateRequest(nonce, params = {}) {
         await this.authenticate();
         const url = this.urls['api']['ws']['private'];
@@ -972,6 +1128,9 @@ class cryptocom extends cryptocom$1 {
         //           "channel":"ticker",
         //           "data":[ { } ]
         //
+        // handle unsubscribe
+        // {"id":1725448572836,"method":"unsubscribe","code":0}
+        //
         if (this.handleErrorMessage(client, message)) {
             return;
         }
@@ -985,6 +1144,7 @@ class cryptocom extends cryptocom$1 {
             'private/cancel-all-orders': this.handleCancelAllOrders,
             'private/close-position': this.handleOrder,
             'subscribe': this.handleSubscribe,
+            'unsubscribe': this.handleUnsubscribe,
         };
         const callMethod = this.safeValue(methods, method);
         if (callMethod !== undefined) {
@@ -1025,6 +1185,70 @@ class cryptocom extends cryptocom$1 {
         const future = this.safeValue(client.futures, 'authenticated');
         future.resolve(true);
     }
+    handleUnsubscribe(client, message) {
+        const id = this.safeString(message, 'id');
+        const keys = Object.keys(client.subscriptions);
+        for (let i = 0; i < keys.length; i++) {
+            const messageHash = keys[i];
+            if (!(messageHash in client.subscriptions)) {
+                continue;
+                // the previous iteration can have deleted the messageHash from the subscriptions
+            }
+            if (messageHash.startsWith('unsubscribe')) {
+                const subscription = client.subscriptions[messageHash];
+                const subId = this.safeString(subscription, 'id');
+                if (id !== subId) {
+                    continue;
+                }
+                const messageHashes = this.safeList(subscription, 'messageHashes', []);
+                const subMessageHashes = this.safeList(subscription, 'subMessageHashes', []);
+                for (let j = 0; j < messageHashes.length; j++) {
+                    const unsubHash = messageHashes[j];
+                    const subHash = subMessageHashes[j];
+                    if (unsubHash in client.subscriptions) {
+                        delete client.subscriptions[unsubHash];
+                    }
+                    if (subHash in client.subscriptions) {
+                        delete client.subscriptions[subHash];
+                    }
+                    const error = new errors.UnsubscribeError(this.id + ' ' + subHash);
+                    client.reject(error, subHash);
+                    client.resolve(true, unsubHash);
+                }
+                this.cleanCache(subscription);
+            }
+        }
+    }
+    cleanCache(subscription) {
+        const topic = this.safeString(subscription, 'topic');
+        const symbols = this.safeList(subscription, 'symbols', []);
+        const symbolsLength = symbols.length;
+        if (topic === 'ohlcv') {
+            const symbolsAndTimeFrames = this.safeList(subscription, 'symbolsAndTimeframes', []);
+            for (let i = 0; i < symbolsAndTimeFrames.length; i++) {
+                const symbolAndTimeFrame = symbolsAndTimeFrames[i];
+                const symbol = this.safeString(symbolAndTimeFrame, 0);
+                const timeframe = this.safeString(symbolAndTimeFrame, 1);
+                if (timeframe in this.ohlcvs[symbol]) {
+                    delete this.ohlcvs[symbol][timeframe];
+                }
+            }
+        }
+        else if (symbolsLength > 0) {
+            for (let i = 0; i < symbols.length; i++) {
+                const symbol = symbols[i];
+                if (topic === 'trade') {
+                    delete this.trades[symbol];
+                }
+                else if (topic === 'orderbook') {
+                    delete this.orderbooks[symbol];
+                }
+                else if (topic === 'ticker') {
+                    delete this.tickers[symbol];
+                }
+            }
+        }
+    }
 }
 
 module.exports = cryptocom;