ccxt 4.3.84 → 4.3.86

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

@@ -439,6 +439,35 @@ class bitget extends bitget$1 {
          */
         return await this.watchOrderBookForSymbols([symbol], limit, params);
     }
+    async unWatchOrderBook(symbol, params = {}) {
+        /**
+         * @method
+         * @name bitget#unWatchOrderBook
+         * @description unsubscribe from the orderbook channel
+         * @see https://www.bitget.com/api-doc/spot/websocket/public/Depth-Channel
+         * @see https://www.bitget.com/api-doc/contract/websocket/public/Order-Book-Channel
+         * @param {string} symbol unified symbol of the market to fetch the order book for
+         * @param {int} [params.limit] orderbook limit, default is undefined
+         * @returns {object} A dictionary of [order book structures]{@link https://docs.ccxt.com/#/?id=order-book-structure} indexed by market symbols
+         */
+        await this.loadMarkets();
+        const market = this.market(symbol);
+        const messageHash = 'unsubscribe:orderbook:' + market['symbol'];
+        let channel = 'books';
+        const limit = this.safeInteger(params, 'limit');
+        if ((limit === 1) || (limit === 5) || (limit === 15)) {
+            params = this.omit(params, 'limit');
+            channel += limit.toString();
+        }
+        let instType = undefined;
+        [instType, params] = this.getInstType(market, params);
+        const args = {
+            'instType': instType,
+            'channel': channel,
+            'instId': market['id'],
+        };
+        return await this.unWatchPublic(messageHash, args, params);
+    }
     async watchOrderBookForSymbols(symbols, limit = undefined, params = {}) {
         /**
          * @method
@@ -562,10 +591,11 @@ class bitget extends bitget$1 {
                 const calculatedChecksum = this.crc32(payload, true);
                 const responseChecksum = this.safeInteger(rawOrderBook, 'checksum');
                 if (calculatedChecksum !== responseChecksum) {
-                    delete client.subscriptions[messageHash];
-                    delete this.orderbooks[symbol];
-                    const error = new errors.ChecksumError(this.id + ' ' + this.orderbookChecksumMessage(symbol));
-                    client.reject(error, messageHash);
+                    // if (messageHash in client.subscriptions) {
+                    //     // delete client.subscriptions[messageHash];
+                    //     // delete this.orderbooks[symbol];
+                    // }
+                    this.spawn(this.handleCheckSumError, client, symbol, messageHash);
                     return;
                 }
             }
@@ -578,6 +608,11 @@ class bitget extends bitget$1 {
         }
         client.resolve(this.orderbooks[symbol], messageHash);
     }
+    async handleCheckSumError(client, symbol, messageHash) {
+        await this.unWatchOrderBook(symbol);
+        const error = new errors.ChecksumError(this.id + ' ' + this.orderbookChecksumMessage(symbol));
+        client.reject(error, messageHash);
+    }
     handleDelta(bookside, delta) {
         const bidAsk = this.parseBidAsk(delta, 0, 1);
         // we store the string representations in the orderbook for checksum calculation
@@ -1624,6 +1659,15 @@ class bitget extends bitget$1 {
         const message = this.extend(request, params);
         return await this.watch(url, messageHash, message, messageHash);
     }
+    async unWatchPublic(messageHash, args, params = {}) {
+        const url = this.urls['api']['ws']['public'];
+        const request = {
+            'op': 'unsubscribe',
+            'args': [args],
+        };
+        const message = this.extend(request, params);
+        return await this.watch(url, messageHash, message, messageHash);
+    }
     async watchPublicMultiple(messageHashes, argsArray, params = {}) {
         const url = this.urls['api']['ws']['public'];
         const request = {
@@ -1744,6 +1788,17 @@ class bitget extends bitget$1 {
         //        "event": "subscribe",
         //        "arg": { instType: 'SPOT', channel: "account", instId: "default" }
         //    }
+        // unsubscribe
+        //    {
+        //        "op":"unsubscribe",
+        //        "args":[
+        //          {
+        //            "instType":"USDT-FUTURES",
+        //            "channel":"ticker",
+        //            "instId":"BTCUSDT"
+        //          }
+        //        ]
+        //    }
         //
         if (this.handleErrorMessage(client, message)) {
             return;
@@ -1766,6 +1821,10 @@ class bitget extends bitget$1 {
             this.handleSubscriptionStatus(client, message);
             return;
         }
+        if (event === 'unsubscribe') {
+            this.handleUnSubscriptionStatus(client, message);
+            return;
+        }
         const methods = {
             'ticker': this.handleTicker,
             'trade': this.handleTrades,
@@ -1809,6 +1868,56 @@ class bitget extends bitget$1 {
         //
         return message;
     }
+    handleUnSubscriptionStatus(client, message) {
+        //
+        //  {
+        //      "op":"unsubscribe",
+        //      "args":[
+        //        {
+        //          "instType":"USDT-FUTURES",
+        //          "channel":"ticker",
+        //          "instId":"BTCUSDT"
+        //        },
+        //        {
+        //          "instType":"USDT-FUTURES",
+        //          "channel":"candle1m",
+        //          "instId":"BTCUSDT"
+        //        }
+        //      ]
+        //  }
+        //  or
+        // {"event":"unsubscribe","arg":{"instType":"SPOT","channel":"books","instId":"BTCUSDT"}}
+        //
+        let argsList = this.safeList(message, 'args');
+        if (argsList === undefined) {
+            argsList = [this.safeDict(message, 'arg', {})];
+        }
+        for (let i = 0; i < argsList.length; i++) {
+            const arg = argsList[i];
+            const channel = this.safeString(arg, 'channel');
+            if (channel === 'books') {
+                // for now only unWatchOrderBook is supporteod
+                const instType = this.safeStringLower(arg, 'instType');
+                const type = (instType === 'spot') ? 'spot' : 'contract';
+                const instId = this.safeString(arg, 'instId');
+                const market = this.safeMarket(instId, undefined, undefined, type);
+                const symbol = market['symbol'];
+                const messageHash = 'unsubscribe:orderbook:' + market['symbol'];
+                const subMessageHash = 'orderbook:' + symbol;
+                if (symbol in this.orderbooks) {
+                    delete this.orderbooks[symbol];
+                }
+                if (subMessageHash in client.subscriptions) {
+                    delete client.subscriptions[subMessageHash];
+                }
+                if (messageHash in client.subscriptions) {
+                    delete client.subscriptions[messageHash];
+                }
+                client.resolve(true, messageHash);
+            }
+        }
+        return message;
+    }
 }
 
 module.exports = bitget;