ccxt 4.5.1 → 4.5.3

package/js/src/pro/bitfinex.js

@@ -25,6 +25,10 @@ export default class bitfinex extends bitfinexRest {
                 'watchBalance': true,
                 'watchOHLCV': true,
                 'watchOrders': true,
+                'unWatchTicker': true,
+                'unWatchTrades': true,
+                'unWatchOHLCV': true,
+                'unWatchOrderBook': true,
             },
             'urls': {
                 'api': {
@@ -67,6 +71,31 @@ export default class bitfinex extends bitfinexRest {
         }
         return result;
     }
+    async unSubscribe(channel, topic, symbol, params = {}) {
+        await this.loadMarkets();
+        const market = this.market(symbol);
+        const marketId = market['id'];
+        const url = this.urls['api']['ws']['public'];
+        const client = this.client(url);
+        const subMessageHash = channel + ':' + marketId;
+        const messageHash = 'unsubscribe:' + channel + ':' + marketId;
+        const unSubTopic = 'unsubscribe' + ':' + topic + ':' + symbol;
+        const channelId = this.safeString(client.subscriptions, unSubTopic);
+        const request = {
+            'event': 'unsubscribe',
+            'chanId': channelId,
+        };
+        const unSubChanMsg = 'unsubscribe:' + channelId;
+        client.subscriptions[unSubChanMsg] = subMessageHash;
+        const subscription = {
+            'messageHashes': [messageHash],
+            'subMessageHashes': [subMessageHash],
+            'topic': topic,
+            'unsubscribe': true,
+            'symbols': [symbol],
+        };
+        return await this.watch(url, messageHash, this.deepExtend(request, params), messageHash, subscription);
+    }
     async subscribePrivate(messageHash) {
         await this.loadMarkets();
         await this.authenticate();
@@ -105,6 +134,42 @@ export default class bitfinex extends bitfinexRest {
         }
         return this.filterBySinceLimit(ohlcv, since, limit, 0, true);
     }
+    /**
+     * @method
+     * @name bitfinex#unWatchOHLCV
+     * @description unWatches historical candlestick data containing the open, high, low, and close price, and the volume of a market
+     * @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 {bool} true if successfully unsubscribed, false otherwise
+     */
+    async unWatchOHLCV(symbol, timeframe = '1m', params = {}) {
+        await this.loadMarkets();
+        const market = this.market(symbol);
+        symbol = market['symbol'];
+        const interval = this.safeString(this.timeframes, timeframe, timeframe);
+        const channel = 'candles';
+        const subMessageHash = channel + ':' + interval + ':' + market['id'];
+        const messageHash = 'unsubscribe:' + subMessageHash;
+        const url = this.urls['api']['ws']['public'];
+        const client = this.client(url);
+        const subId = 'unsubscribe:trade:' + interval + ':' + market['id']; // trade here because we use the key
+        const channelId = this.safeString(client.subscriptions, subId);
+        const request = {
+            'event': 'unsubscribe',
+            'chanId': channelId,
+        };
+        const unSubChanMsg = 'unsubscribe:' + channelId;
+        client.subscriptions[unSubChanMsg] = subMessageHash;
+        const subscription = {
+            'messageHashes': [messageHash],
+            'subMessageHashes': [subMessageHash],
+            'topic': 'ohlcv',
+            'unsubscribe': true,
+            'symbols': [symbol],
+        };
+        return await this.watch(url, messageHash, this.deepExtend(request, params), messageHash, subscription);
+    }
     handleOHLCV(client, message, subscription) {
         //
         // initial snapshot
@@ -205,6 +270,17 @@ export default class bitfinex extends bitfinexRest {
         }
         return this.filterBySinceLimit(trades, since, limit, 'timestamp', true);
     }
+    /**
+     * @method
+     * @name bitfinex#unWatchTrades
+     * @description unWatches the list of most recent trades for a particular symbol
+     * @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}
+     */
+    async unWatchTrades(symbol, params = {}) {
+        return await this.unSubscribe('trades', 'trades', symbol, params);
+    }
     /**
      * @method
      * @name bitfinex#watchMyTrades
@@ -239,6 +315,17 @@ export default class bitfinex extends bitfinexRest {
     async watchTicker(symbol, params = {}) {
         return await this.subscribe('ticker', symbol, params);
     }
+    /**
+     * @method
+     * @name bitfinex#unWatchTicker
+     * @description unWatches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
+     * @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}
+     */
+    async unWatchTicker(symbol, params = {}) {
+        return await this.unSubscribe('ticker', 'ticker', symbol, params);
+    }
     handleMyTrade(client, message, subscription = {}) {
         //
         // trade execution
@@ -832,6 +919,29 @@ export default class bitfinex extends bitfinexRest {
         //
         return message;
     }
+    handleUnsubscriptionStatus(client, message) {
+        //
+        // {
+        //     "event": "unsubscribed",
+        //     "status": "OK",
+        //     "chanId": CHANNEL_ID
+        // }
+        //
+        const channelId = this.safeString(message, 'chanId');
+        const unSubChannel = 'unsubscribe:' + channelId;
+        const subMessageHash = this.safeString(client.subscriptions, unSubChannel);
+        const subscription = this.safeDict(client.subscriptions, 'unsubscribe:' + subMessageHash);
+        delete client.subscriptions[unSubChannel];
+        const messageHashes = this.safeList(subscription, 'messageHashes', []);
+        const subMessageHashes = this.safeList(subscription, 'subMessageHashes', []);
+        for (let i = 0; i < messageHashes.length; i++) {
+            const messageHash = messageHashes[i];
+            const subHash = subMessageHashes[i];
+            this.cleanUnsubscription(client, subHash, messageHash);
+        }
+        this.cleanCache(subscription);
+        return true;
+    }
     handleSubscriptionStatus(client, message) {
         //
         //     {
@@ -845,8 +955,37 @@ export default class bitfinex extends bitfinexRest {
         //         "pair": "BTCUSD"
         //     }
         //
+        //   {
+        //       event: 'subscribed',
+        //       channel: 'candles',
+        //       chanId: 128306,
+        //       key: 'trade:1m:tBTCUST'
+        //  }
+        //
         const channelId = this.safeString(message, 'chanId');
         client.subscriptions[channelId] = message;
+        // store the opposite direction too for unWatch
+        const mappings = {
+            'book': 'orderbook',
+            'candles': 'ohlcv',
+            'ticker': 'ticker',
+            'trades': 'trades',
+        };
+        const unifiedChannel = this.safeString(mappings, this.safeString(message, 'channel'));
+        if ('key' in message) {
+            // handle ohlcv differently because the message is different
+            const key = this.safeString(message, 'key');
+            const subKeyId = 'unsubscribe:' + key;
+            client.subscriptions[subKeyId] = channelId;
+        }
+        else {
+            const marketId = this.safeString(message, 'symbol');
+            const symbol = this.safeSymbol(marketId);
+            if (unifiedChannel !== undefined) {
+                const subId = 'unsubscribe:' + unifiedChannel + ':' + symbol;
+                client.subscriptions[subId] = channelId;
+            }
+        }
         return message;
     }
     async authenticate(params = {}) {
@@ -1153,6 +1292,7 @@ export default class bitfinex extends bitfinexRest {
                 const methods = {
                     'info': this.handleSystemStatus,
                     'subscribed': this.handleSubscriptionStatus,
+                    'unsubscribed': this.handleUnsubscriptionStatus,
                     'auth': this.handleAuthenticationMessage,
                 };
                 const method = this.safeValue(methods, event);

package/js/src/pro/bitget.d.ts

@@ -69,11 +69,13 @@ export default class bitget extends bitgetRest {
      * @description watches historical candlestick data containing the open, high, low, close price, and the volume of a market
      * @see https://www.bitget.com/api-doc/spot/websocket/public/Candlesticks-Channel
      * @see https://www.bitget.com/api-doc/contract/websocket/public/Candlesticks-Channel
+     * @see https://www.bitget.com/api-doc/uta/websocket/public/Candlesticks-Channel
      * @param {string} symbol unified symbol of the market to fetch OHLCV data for
      * @param {string} timeframe the length of time each candle represents
      * @param {int} [since] timestamp in ms of the earliest candle to fetch
      * @param {int} [limit] the maximum amount of candles to fetch
      * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @param {boolean} [params.uta] set to true for the unified trading account (uta), defaults to false
      * @returns {int[][]} A list of candles ordered as timestamp, open, high, low, close, volume
      */
     watchOHLCV(symbol: string, timeframe?: string, since?: Int, limit?: Int, params?: {}): Promise<OHLCV[]>;
@@ -83,9 +85,11 @@ export default class bitget extends bitgetRest {
      * @description unsubscribe from the ohlcv channel
      * @see https://www.bitget.com/api-doc/spot/websocket/public/Candlesticks-Channel
      * @see https://www.bitget.com/api-doc/contract/websocket/public/Candlesticks-Channel
+     * @see https://www.bitget.com/api-doc/uta/websocket/public/Candlesticks-Channel
      * @param {string} symbol unified symbol of the market to unwatch the ohlcv for
      * @param {string} [timeframe] the period for the ratio, default is 1 minute
      * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @param {boolean} [params.uta] set to true for the unified trading account (uta), defaults to false
      * @returns {object} A dictionary of [order book structures]{@link https://docs.ccxt.com/#/?id=order-book-structure} indexed by market symbols
      */
     unWatchOHLCV(symbol: string, timeframe?: string, params?: {}): Promise<any>;
@@ -138,10 +142,12 @@ export default class bitget extends bitgetRest {
      * @description get the list of most recent trades for a particular symbol
      * @see https://www.bitget.com/api-doc/spot/websocket/public/Trades-Channel
      * @see https://www.bitget.com/api-doc/contract/websocket/public/New-Trades-Channel
+     * @see https://www.bitget.com/api-doc/uta/websocket/public/New-Trades-Channel
      * @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
+     * @param {boolean} [params.uta] set to true for the unified trading account (uta), defaults to false
      * @returns {object[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=public-trades}
      */
     watchTrades(symbol: string, since?: Int, limit?: Int, params?: {}): Promise<Trade[]>;
@@ -151,10 +157,12 @@ export default class bitget extends bitgetRest {
      * @description get the list of most recent trades for a particular symbol
      * @see https://www.bitget.com/api-doc/spot/websocket/public/Trades-Channel
      * @see https://www.bitget.com/api-doc/contract/websocket/public/New-Trades-Channel
+     * @see https://www.bitget.com/api-doc/uta/websocket/public/New-Trades-Channel
      * @param {string[]} symbols 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
+     * @param {boolean} [params.uta] set to true for the unified trading account (uta), defaults to false
      * @returns {object[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=public-trades}
      */
     watchTradesForSymbols(symbols: string[], since?: Int, limit?: Int, params?: {}): Promise<Trade[]>;
@@ -164,8 +172,10 @@ export default class bitget extends bitgetRest {
      * @description unsubscribe from the trades channel
      * @see https://www.bitget.com/api-doc/spot/websocket/public/Trades-Channel
      * @see https://www.bitget.com/api-doc/contract/websocket/public/New-Trades-Channel
+     * @see https://www.bitget.com/api-doc/uta/websocket/public/New-Trades-Channel
      * @param {string} symbol unified symbol of the market to unwatch the trades for
      * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @param {boolean} [params.uta] set to true for the unified trading account (uta), defaults to false
      * @returns {any} status of the unwatch request
      */
     unWatchTrades(symbol: string, params?: {}): Promise<any>;