ccxt-ir 4.9.32 → 4.11.0

package/js/src/src/pro/okcoin.js

@@ -0,0 +1,763 @@
+// ----------------------------------------------------------------------------
+
+// PLEASE DO NOT EDIT THIS FILE, IT IS GENERATED AND WILL BE OVERWRITTEN:
+// https://github.com/ccxt/ccxt/blob/master/CONTRIBUTING.md#how-to-contribute-code
+// EDIT THE CORRESPONDENT .ts FILE INSTEAD
+
+//  ---------------------------------------------------------------------------
+import okcoinRest from '../okcoin.js';
+import { ArgumentsRequired, AuthenticationError } from '../base/errors.js';
+import { ArrayCache, ArrayCacheByTimestamp, ArrayCacheBySymbolById } from '../base/ws/Cache.js';
+import { sha256 } from '../static_dependencies/noble-hashes/sha256.js';
+//  ---------------------------------------------------------------------------
+export default class okcoin extends okcoinRest {
+    describe() {
+        return this.deepExtend(super.describe(), {
+            'has': {
+                'ws': true,
+                'watchTicker': true,
+                'watchTickers': false,
+                'watchOrderBook': true,
+                'watchOrders': true,
+                'watchTrades': true,
+                'watchTradesForSymbols': false,
+                'watchBalance': true,
+                'watchOHLCV': true,
+            },
+            'urls': {
+                'api': {
+                    'ws': 'wss://real.okcoin.com:8443/ws/v3',
+                },
+                'logo': 'https://user-images.githubusercontent.com/1294454/27766791-89ffb502-5ee5-11e7-8a5b-c5950b68ac65.jpg',
+                'www': 'https://www.okcoin.com',
+                'doc': 'https://www.okcoin.com/docs/en/',
+                'fees': 'https://www.okcoin.com/coin-fees',
+                'referral': 'https://www.okcoin.com/account/register?flag=activity&channelId=600001513',
+            },
+            'options': {
+                'fetchMarkets': ['spot'],
+                'watchOrders': 'order',
+                'watchOrderBook': {
+                    'limit': 400,
+                    'type': 'spot',
+                    'depth': 'depth_l2_tbt', // depth5, depth
+                },
+                'watchBalance': 'spot',
+                'ws': {
+                    'inflate': true,
+                },
+            },
+            'streaming': {
+                // okex does not support built-in ws protocol-level ping-pong
+                // instead it requires a custom text-based ping-pong
+                'ping': this.ping,
+                'keepAlive': 20000,
+            },
+        });
+    }
+    async subscribe(channel, symbol, params = {}) {
+        await this.loadMarkets();
+        const market = this.market(symbol);
+        const url = this.urls['api']['ws'];
+        const messageHash = market['type'] + '/' + channel + ':' + market['id'];
+        const request = {
+            'op': 'subscribe',
+            'args': [messageHash],
+        };
+        return await this.watch(url, messageHash, this.deepExtend(request, params), messageHash);
+    }
+    /**
+     * @method
+     * @name okcoin#watchTrades
+     * @description get the list of most recent trades for a particular symbol
+     * @see https://www.okcoin.com/docs-v5/en/#websocket-api-public-channel-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
+     * @returns {object[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=public-trades}
+     */
+    async watchTrades(symbol, since = undefined, limit = undefined, params = {}) {
+        await this.loadMarkets();
+        symbol = this.symbol(symbol);
+        const trades = await this.subscribe('trade', symbol, params);
+        if (this.newUpdates) {
+            limit = trades.getLimit(symbol, limit);
+        }
+        return this.filterBySinceLimit(trades, since, limit, 'timestamp', true);
+    }
+    /**
+     * @method
+     * @name okcoin#watchOrders
+     * @description watches information on multiple orders made by the user
+     * @see https://www.okcoin.com/docs-v5/en/#websocket-api-private-channel-order-channel
+     * @param {string} symbol unified market symbol of the market orders were made in
+     * @param {int} [since] the earliest time in ms to fetch orders for
+     * @param {int} [limit] the maximum number of order structures to retrieve
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {object[]} a list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
+     */
+    async watchOrders(symbol = undefined, since = undefined, limit = undefined, params = {}) {
+        await this.loadMarkets();
+        await this.authenticate();
+        if (symbol !== undefined) {
+            symbol = this.symbol(symbol);
+        }
+        const orderType = this.safeString(this.options, 'watchOrders', 'order');
+        const trades = await this.subscribe(orderType, symbol, params);
+        if (this.newUpdates) {
+            limit = trades.getLimit(symbol, limit);
+        }
+        return this.filterBySinceLimit(trades, since, limit, 'timestamp', true);
+    }
+    handleOrders(client, message, subscription = undefined) {
+        //
+        // {
+        //     "table": "spot/order",
+        //     "data": [
+        //       {
+        //         "client_oid": '',
+        //         "created_at": "2022-03-04T16:44:58.530Z",
+        //         "event_code": "0",
+        //         "event_message": '',
+        //         "fee": '',
+        //         "fee_currency": '',
+        //         "filled_notional": "0",
+        //         "filled_size": "0",
+        //         "instrument_id": "LTC-USD",
+        //         "last_amend_result": '',
+        //         "last_fill_id": "0",
+        //         "last_fill_px": "0",
+        //         "last_fill_qty": "0",
+        //         "last_fill_time": "1970-01-01T00:00:00.000Z",
+        //         "last_request_id": '',
+        //         "margin_trading": "1",
+        //         "notional": '',
+        //         "order_id": "8629537900471296",
+        //         "order_type": "0",
+        //         "price": "1500",
+        //         "rebate": '',
+        //         "rebate_currency": '',
+        //         "side": "sell",
+        //         "size": "0.0133",
+        //         "state": "0",
+        //         "status": "open",
+        //         "timestamp": "2022-03-04T16:44:58.530Z",
+        //         "type": "limit"
+        //       }
+        //     ]
+        //   }
+        //
+        const table = this.safeString(message, 'table');
+        const orders = this.safeValue(message, 'data', []);
+        const ordersLength = orders.length;
+        if (ordersLength > 0) {
+            const limit = this.safeInteger(this.options, 'ordersLimit', 1000);
+            if (this.orders === undefined) {
+                this.orders = new ArrayCacheBySymbolById(limit);
+            }
+            const stored = this.orders;
+            const marketIds = {};
+            const parsed = this.parseOrders(orders);
+            for (let i = 0; i < parsed.length; i++) {
+                const order = parsed[i];
+                stored.append(order);
+                const symbol = order['symbol'];
+                const market = this.market(symbol);
+                marketIds[market['id']] = true;
+            }
+            const keys = Object.keys(marketIds);
+            for (let i = 0; i < keys.length; i++) {
+                const messageHash = table + ':' + keys[i];
+                client.resolve(this.orders, messageHash);
+            }
+        }
+    }
+    /**
+     * @method
+     * @name okcoin#watchTicker
+     * @description watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
+     * @see https://www.okcoin.com/docs-v5/en/#websocket-api-public-channel-tickers-channel
+     * @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 watchTicker(symbol, params = {}) {
+        return await this.subscribe('ticker', symbol, params);
+    }
+    handleTrade(client, message) {
+        //
+        //     {
+        //         "table": "spot/trade",
+        //         "data": [
+        //             {
+        //                 "side": "buy",
+        //                 "trade_id": "30770973",
+        //                 "price": "4665.4",
+        //                 "size": "0.019",
+        //                 "instrument_id": "BTC-USDT",
+        //                 "timestamp": "2020-03-16T13:41:46.526Z"
+        //             }
+        //         ]
+        //     }
+        //
+        const table = this.safeString(message, 'table');
+        const data = this.safeValue(message, 'data', []);
+        const tradesLimit = this.safeInteger(this.options, 'tradesLimit', 1000);
+        for (let i = 0; i < data.length; i++) {
+            const trade = this.parseTrade(data[i]);
+            const symbol = trade['symbol'];
+            const marketId = this.safeString(trade['info'], 'instrument_id');
+            const messageHash = table + ':' + marketId;
+            let stored = this.safeValue(this.trades, symbol);
+            if (stored === undefined) {
+                stored = new ArrayCache(tradesLimit);
+                this.trades[symbol] = stored;
+            }
+            stored.append(trade);
+            client.resolve(stored, messageHash);
+        }
+        return message;
+    }
+    handleTicker(client, message) {
+        //
+        //     {
+        //         "table": "spot/ticker",
+        //         "data": [
+        //             {
+        //                 "last": "4634.1",
+        //                 "open_24h": "5305.6",
+        //                 "best_bid": "4631.6",
+        //                 "high_24h": "5950",
+        //                 "low_24h": "4448.8",
+        //                 "base_volume_24h": "147913.11435388",
+        //                 "quote_volume_24h": "756850119.99108082",
+        //                 "best_ask": "4631.7",
+        //                 "instrument_id": "BTC-USDT",
+        //                 "timestamp": "2020-03-16T13:16:25.677Z",
+        //                 "best_bid_size": "0.12348942",
+        //                 "best_ask_size": "0.00100014",
+        //                 "last_qty": "0.00331822"
+        //             }
+        //         ]
+        //     }
+        //
+        const table = this.safeString(message, 'table');
+        const data = this.safeValue(message, 'data', []);
+        for (let i = 0; i < data.length; i++) {
+            const ticker = this.parseTicker(data[i]);
+            const symbol = ticker['symbol'];
+            const marketId = this.safeString(ticker['info'], 'instrument_id');
+            const messageHash = table + ':' + marketId;
+            this.tickers[symbol] = ticker;
+            client.resolve(ticker, messageHash);
+        }
+        return message;
+    }
+    /**
+     * @method
+     * @name okcoin#watchOHLCV
+     * @description watches historical candlestick data containing the open, high, low, and close price, and the volume of a market
+     * @see https://www.okcoin.com/docs-v5/en/#websocket-api-public-channel-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
+     * @returns {int[][]} A list of candles ordered as timestamp, open, high, low, close, volume
+     */
+    async watchOHLCV(symbol, timeframe = '1m', since = undefined, limit = undefined, params = {}) {
+        await this.loadMarkets();
+        symbol = this.symbol(symbol);
+        const interval = this.safeString(this.timeframes, timeframe, timeframe);
+        const name = 'candle' + interval + 's';
+        const ohlcv = await this.subscribe(name, symbol, params);
+        if (this.newUpdates) {
+            limit = ohlcv.getLimit(symbol, limit);
+        }
+        return this.filterBySinceLimit(ohlcv, since, limit, 0, true);
+    }
+    handleOHLCV(client, message) {
+        //
+        //     {
+        //         "table": "spot/candle60s",
+        //         "data": [
+        //             {
+        //                 "candle": [
+        //                     "2020-03-16T14:29:00.000Z",
+        //                     "4948.3",
+        //                     "4966.7",
+        //                     "4939.1",
+        //                     "4945.3",
+        //                     "238.36021657"
+        //                 ],
+        //                 "instrument_id": "BTC-USDT"
+        //             }
+        //         ]
+        //     }
+        //
+        const table = this.safeString(message, 'table');
+        const data = this.safeValue(message, 'data', []);
+        const parts = table.split('/');
+        const part1 = this.safeString(parts, 1);
+        let interval = part1.replace('candle', '');
+        interval = interval.replace('s', '');
+        // use a reverse lookup in a static map instead
+        const timeframe = this.findTimeframe(interval);
+        for (let i = 0; i < data.length; i++) {
+            const marketId = this.safeString(data[i], 'instrument_id');
+            const candle = this.safeValue(data[i], 'candle');
+            const market = this.safeMarket(marketId);
+            const symbol = market['symbol'];
+            const parsed = this.parseOHLCV(candle, market);
+            this.ohlcvs[symbol] = this.safeValue(this.ohlcvs, symbol, {});
+            let stored = this.safeValue(this.ohlcvs[symbol], timeframe);
+            if (stored === undefined) {
+                const limit = this.safeInteger(this.options, 'OHLCVLimit', 1000);
+                stored = new ArrayCacheByTimestamp(limit);
+                this.ohlcvs[symbol][timeframe] = stored;
+            }
+            stored.append(parsed);
+            const messageHash = table + ':' + marketId;
+            client.resolve(stored, messageHash);
+        }
+    }
+    /**
+     * @method
+     * @name okcoin#watchOrderBook
+     * @description watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
+     * @see https://www.okcoin.com/docs-v5/en/#websocket-api-public-channel-order-book-channel
+     * @param {string} symbol unified symbol of the market to fetch the order book for
+     * @param {int} [limit] the maximum amount of order book entries to return
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {object} A dictionary of [order book structures]{@link https://docs.ccxt.com/#/?id=order-book-structure} indexed by market symbols
+     */
+    async watchOrderBook(symbol, limit = undefined, params = {}) {
+        const options = this.safeValue(this.options, 'watchOrderBook', {});
+        const depth = this.safeString(options, 'depth', 'depth_l2_tbt');
+        const orderbook = await this.subscribe(depth, symbol, params);
+        return orderbook.limit();
+    }
+    handleDelta(bookside, delta) {
+        const price = this.safeFloat(delta, 0);
+        const amount = this.safeFloat(delta, 1);
+        bookside.store(price, amount);
+    }
+    handleDeltas(bookside, deltas) {
+        for (let i = 0; i < deltas.length; i++) {
+            this.handleDelta(bookside, deltas[i]);
+        }
+    }
+    handleOrderBookMessage(client, message, orderbook) {
+        //
+        //     {
+        //         "instrument_id": "BTC-USDT",
+        //         "asks": [
+        //             ["4568.5", "0.49723138", "2"],
+        //             ["4568.7", "0.5013", "1"],
+        //             ["4569.1", "0.4398", "1"],
+        //         ],
+        //         "bids": [
+        //             ["4568.4", "0.84187666", "5"],
+        //             ["4568.3", "0.75661506", "6"],
+        //             ["4567.8", "2.01", "2"],
+        //         ],
+        //         "timestamp": "2020-03-16T11:11:43.388Z",
+        //         "checksum": 473370408
+        //     }
+        //
+        const asks = this.safeValue(message, 'asks', []);
+        const bids = this.safeValue(message, 'bids', []);
+        this.handleDeltas(orderbook['asks'], asks);
+        this.handleDeltas(orderbook['bids'], bids);
+        const timestamp = this.parse8601(this.safeString(message, 'timestamp'));
+        orderbook['timestamp'] = timestamp;
+        orderbook['datetime'] = this.iso8601(timestamp);
+        return orderbook;
+    }
+    handleOrderBook(client, message) {
+        //
+        // first message (snapshot)
+        //
+        //     {
+        //         "table": "spot/depth",
+        //         "action": "partial",
+        //         "data": [
+        //             {
+        //                 "instrument_id": "BTC-USDT",
+        //                 "asks": [
+        //                     ["4568.5", "0.49723138", "2"],
+        //                     ["4568.7", "0.5013", "1"],
+        //                     ["4569.1", "0.4398", "1"],
+        //                 ],
+        //                 "bids": [
+        //                     ["4568.4", "0.84187666", "5"],
+        //                     ["4568.3", "0.75661506", "6"],
+        //                     ["4567.8", "2.01", "2"],
+        //                 ],
+        //                 "timestamp": "2020-03-16T11:11:43.388Z",
+        //                 "checksum": 473370408
+        //             }
+        //         ]
+        //     }
+        //
+        // subsequent updates
+        //
+        //     {
+        //         "table": "spot/depth",
+        //         "action": "update",
+        //         "data": [
+        //             {
+        //                 "instrument_id":   "BTC-USDT",
+        //                 "asks": [
+        //                     ["4598.8", "0", "0"],
+        //                     ["4599.1", "0", "0"],
+        //                     ["4600.3", "0", "0"],
+        //                 ],
+        //                 "bids": [
+        //                     ["4598.5", "0.08", "1"],
+        //                     ["4598.2", "0.0337323", "1"],
+        //                     ["4598.1", "0.12681801", "3"],
+        //                 ],
+        //                 "timestamp": "2020-03-16T11:20:35.139Z",
+        //                 "checksum": 740786981
+        //             }
+        //         ]
+        //     }
+        //
+        const action = this.safeString(message, 'action');
+        const data = this.safeValue(message, 'data', []);
+        const table = this.safeString(message, 'table');
+        if (action === 'partial') {
+            for (let i = 0; i < data.length; i++) {
+                const update = data[i];
+                const marketId = this.safeString(update, 'instrument_id');
+                const market = this.safeMarket(marketId);
+                const symbol = market['symbol'];
+                const options = this.safeValue(this.options, 'watchOrderBook', {});
+                // default limit is 400 bidasks
+                const limit = this.safeInteger(options, 'limit', 400);
+                const orderbook = this.orderBook({}, limit);
+                this.orderbooks[symbol] = orderbook;
+                this.handleOrderBookMessage(client, update, orderbook);
+                const messageHash = table + ':' + marketId;
+                client.resolve(orderbook, messageHash);
+            }
+        }
+        else {
+            for (let i = 0; i < data.length; i++) {
+                const update = data[i];
+                const marketId = this.safeString(update, 'instrument_id');
+                const market = this.safeMarket(marketId);
+                const symbol = market['symbol'];
+                if (symbol in this.orderbooks) {
+                    const orderbook = this.orderbooks[symbol];
+                    this.handleOrderBookMessage(client, update, orderbook);
+                    const messageHash = table + ':' + marketId;
+                    client.resolve(orderbook, messageHash);
+                }
+            }
+        }
+        return message;
+    }
+    async authenticate(params = {}) {
+        this.checkRequiredCredentials();
+        const url = this.urls['api']['ws'];
+        const messageHash = 'login';
+        const client = this.client(url);
+        let future = this.safeValue(client.subscriptions, messageHash);
+        if (future === undefined) {
+            future = client.future('authenticated');
+            const timestamp = this.seconds().toString();
+            const method = 'GET';
+            const path = '/users/self/verify';
+            const auth = timestamp + method + path;
+            const signature = this.hmac(this.encode(auth), this.encode(this.secret), sha256, 'base64');
+            const request = {
+                'op': messageHash,
+                'args': [
+                    this.apiKey,
+                    this.password,
+                    timestamp,
+                    signature,
+                ],
+            };
+            this.spawn(this.watch, url, messageHash, request, messageHash, future);
+        }
+        return await future;
+    }
+    /**
+     * @method
+     * @name okcoin#watchBalance
+     * @description watch balance and get the amount of funds available for trading or funds locked in orders
+     * @see https://www.okcoin.com/docs-v5/en/#websocket-api-private-channel-account-channel
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {object} a [balance structure]{@link https://docs.ccxt.com/#/?id=balance-structure}
+     */
+    async watchBalance(params = {}) {
+        const defaultType = this.safeString2(this.options, 'watchBalance', 'defaultType');
+        const type = this.safeString(params, 'type', defaultType);
+        if (type === undefined) {
+            throw new ArgumentsRequired(this.id + " watchBalance requires a type parameter (one of 'spot', 'margin', 'futures', 'swap')");
+        }
+        // const query = this.omit (params, 'type');
+        const negotiation = await this.authenticate();
+        return await this.subscribeToUserAccount(negotiation, params);
+    }
+    async subscribeToUserAccount(negotiation, params = {}) {
+        const defaultType = this.safeString2(this.options, 'watchBalance', 'defaultType');
+        const type = this.safeString(params, 'type', defaultType);
+        if (type === undefined) {
+            throw new ArgumentsRequired(this.id + " watchBalance requires a type parameter (one of 'spot', 'margin', 'futures', 'swap')");
+        }
+        await this.loadMarkets();
+        const currencyId = this.safeString(params, 'currency');
+        const code = this.safeString(params, 'code', this.safeCurrencyCode(currencyId));
+        let currency = undefined;
+        if (code !== undefined) {
+            currency = this.currency(code);
+        }
+        const symbol = this.safeString(params, 'symbol');
+        const market = this.market(symbol);
+        const marketUndefined = (market === undefined);
+        const currencyUndefined = (currency === undefined);
+        if (type === 'spot') {
+            if (currencyUndefined) {
+                throw new ArgumentsRequired(this.id + " watchBalance requires a 'currency' (id) or a unified 'code' parameter for " + type + ' accounts');
+            }
+        }
+        else if ((type === 'margin') || (type === 'swap') || (type === 'option')) {
+            if (marketUndefined) {
+                throw new ArgumentsRequired(this.id + " watchBalance requires a 'instrument_id' (id) or a unified 'symbol' parameter for " + type + ' accounts');
+            }
+        }
+        else if (type === 'futures') {
+            if (currencyUndefined && marketUndefined) {
+                throw new ArgumentsRequired(this.id + " watchBalance requires a 'currency' (id), or unified 'code', or 'instrument_id' (id), or unified 'symbol' parameter for " + type + ' accounts');
+            }
+        }
+        let suffix = undefined;
+        if (!currencyUndefined) {
+            suffix = currency['id'];
+        }
+        else if (!marketUndefined) {
+            suffix = market['id'];
+        }
+        const accountType = (type === 'margin') ? 'spot' : type;
+        const account = (type === 'margin') ? 'margin_account' : 'account';
+        const messageHash = accountType + '/' + account;
+        const subscriptionHash = messageHash + ':' + suffix;
+        const url = this.urls['api']['ws'];
+        const request = {
+            'op': 'subscribe',
+            'args': [subscriptionHash],
+        };
+        const query = this.omit(params, ['currency', 'code', 'instrument_id', 'symbol', 'type']);
+        return await this.watch(url, messageHash, this.deepExtend(request, query), subscriptionHash);
+    }
+    handleBalance(client, message) {
+        //
+        // spot
+        //
+        //     {
+        //         "table": "spot/account",
+        //         "data": [
+        //             {
+        //                 "available": "11.044827320825",
+        //                 "currency": "USDT",
+        //                 "id": '',
+        //                 "balance": "11.044827320825",
+        //                 "hold": "0"
+        //             }
+        //         ]
+        //     }
+        //
+        // margin
+        //
+        //     {
+        //         "table": "spot/margin_account",
+        //         "data": [
+        //             {
+        //                 "maint_margin_ratio": "0.08",
+        //                 "liquidation_price": "0",
+        //                 "currency:USDT": { available: "0", balance: "0", borrowed: "0", hold: "0", lending_fee: "0" },
+        //                 "tiers": "1",
+        //                 "instrument_id":   "ETH-USDT",
+        //                 "currency:ETH": { available: "0", balance: "0", borrowed: "0", hold: "0", lending_fee: "0" }
+        //             }
+        //         ]
+        //     }
+        //
+        const table = this.safeString(message, 'table');
+        const parts = table.split('/');
+        const data = this.safeValue(message, 'data', []);
+        this.balance['info'] = data;
+        let type = this.safeString(parts, 0);
+        if (type === 'spot') {
+            const part1 = this.safeString(parts, 1);
+            if (part1 === 'margin_account') {
+                type = 'margin';
+            }
+        }
+        for (let i = 0; i < data.length; i++) {
+            const balance = this.parseBalanceByType(type, data);
+            const oldBalance = this.safeValue(this.balance, type, {});
+            const newBalance = this.deepExtend(oldBalance, balance);
+            this.balance[type] = this.safeBalance(newBalance);
+            client.resolve(this.balance[type], table);
+        }
+    }
+    handleSubscriptionStatus(client, message) {
+        //
+        //     {"event":"subscribe","channel":"spot/depth:BTC-USDT"}
+        //
+        // const channel = this.safeString (message, 'channel');
+        // client.subscriptions[channel] = message;
+        return message;
+    }
+    handleAuthenticate(client, message) {
+        //
+        //     { event: "login", success: true }
+        //
+        client.resolve(message, 'authenticated');
+        return message;
+    }
+    ping(client) {
+        // okex does not support built-in ws protocol-level ping-pong
+        // instead it requires custom text-based ping-pong
+        return 'ping';
+    }
+    handlePong(client, message) {
+        client.lastPong = this.milliseconds();
+        return message;
+    }
+    handleErrorMessage(client, message) {
+        //
+        //     { event: "error", message: "Invalid sign", errorCode: 30013 }
+        //     {"event":"error","message":"Unrecognized request: {\"event\":\"subscribe\",\"channel\":\"spot/depth:BTC-USDT\"}","errorCode":30039}
+        //     { event: "error", message: "Channel spot/order doesn't exist", errorCode: 30040 }
+        //
+        const errorCode = this.safeString(message, 'errorCode');
+        try {
+            if (errorCode !== undefined) {
+                const feedback = this.id + ' ' + this.json(message);
+                this.throwExactlyMatchedException(this.exceptions['exact'], errorCode, feedback);
+                const messageString = this.safeValue(message, 'message');
+                if (messageString !== undefined) {
+                    this.throwBroadlyMatchedException(this.exceptions['broad'], messageString, feedback);
+                }
+            }
+        }
+        catch (e) {
+            if (e instanceof AuthenticationError) {
+                client.reject(e, 'authenticated');
+                const method = 'login';
+                if (method in client.subscriptions) {
+                    delete client.subscriptions[method];
+                }
+                return false;
+            }
+        }
+        return message;
+    }
+    handleMessage(client, message) {
+        if (!this.handleErrorMessage(client, message)) {
+            return;
+        }
+        //
+        //     {"event":"error","message":"Unrecognized request: {\"event\":\"subscribe\",\"channel\":\"spot/depth:BTC-USDT\"}","errorCode":30039}
+        //     {"event":"subscribe","channel":"spot/depth:BTC-USDT"}
+        //     {
+        //         "table": "spot/depth",
+        //         "action": "partial",
+        //         "data": [
+        //             {
+        //                 "instrument_id":   "BTC-USDT",
+        //                 "asks": [
+        //                     ["5301.8", "0.03763319", "1"],
+        //                     ["5302.4", "0.00305", "2"],
+        //                 ],
+        //                 "bids": [
+        //                     ["5301.7", "0.58911427", "6"],
+        //                     ["5301.6", "0.01222922", "4"],
+        //                 ],
+        //                 "timestamp": "2020-03-16T03:25:00.440Z",
+        //                 "checksum": -2088736623
+        //             }
+        //         ]
+        //     }
+        // {
+        //     "table":"spot/order",
+        //     "data":[
+        //         {
+        //             "client_oid":"",
+        //             "filled_notional":"0",
+        //             "filled_size":"0",
+        //             "instrument_id":"ETC-USDT",
+        //             "last_fill_px":"0",
+        //             "last_fill_qty":"0",
+        //             "last_fill_time":"1970-01-01T00:00:00.000Z",
+        //             "margin_trading":"1",
+        //             "notional":"",
+        //             "order_id":"3576398568830976",
+        //             "order_type":"0",
+        //             "price":"5.826",
+        //             "side":"buy",
+        //             "size":"0.1",
+        //             "state":"0",
+        //             "status":"open",
+        //             "fee_currency":"ETC",
+        //             "fee":"-0.01",
+        //             "rebate_currency":"open",
+        //             "rebate":"0.05",
+        //             "timestamp":"2019-09-24T06:45:11.394Z",
+        //             "type":"limit",
+        //             "created_at":"2019-09-24T06:45:11.394Z"
+        //         }
+        //     ]
+        // }
+        //
+        if (message === 'pong') {
+            this.handlePong(client, message);
+            return;
+        }
+        const table = this.safeString(message, 'table');
+        if (table === undefined) {
+            const event = this.safeString(message, 'event');
+            if (event !== undefined) {
+                const methods = {
+                    // 'info': this.handleSystemStatus,
+                    // 'book': 'handleOrderBook',
+                    'login': this.handleAuthenticate,
+                    'subscribe': this.handleSubscriptionStatus,
+                };
+                const method = this.safeValue(methods, event);
+                if (method !== undefined) {
+                    method.call(this, client, message);
+                }
+            }
+        }
+        else {
+            const parts = table.split('/');
+            const name = this.safeString(parts, 1);
+            const methods = {
+                'depth': this.handleOrderBook,
+                'depth5': this.handleOrderBook,
+                'depth_l2_tbt': this.handleOrderBook,
+                'ticker': this.handleTicker,
+                'trade': this.handleTrade,
+                'account': this.handleBalance,
+                'margin_account': this.handleBalance,
+                'order': this.handleOrders,
+                // ...
+            };
+            let method = this.safeValue(methods, name);
+            if (name.indexOf('candle') >= 0) {
+                method = this.handleOHLCV;
+            }
+            if (method !== undefined) {
+                method.call(this, client, message);
+            }
+        }
+    }
+}