@proton/ccxt
Version:
A JavaScript / TypeScript / Python / C# / PHP cryptocurrency trading library with support for 130+ exchanges
380 lines (377 loc) • 16.4 kB
JavaScript
// ----------------------------------------------------------------------------
// 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 hitbtcRest from '../hitbtc.js';
import { ArrayCache, ArrayCacheByTimestamp } from '../base/ws/Cache.js';
// ---------------------------------------------------------------------------
export default class hitbtc extends hitbtcRest {
describe() {
return this.deepExtend(super.describe(), {
'has': {
'ws': true,
'watchTicker': true,
'watchTickers': false,
'watchTrades': true,
'watchOrderBook': true,
'watchBalance': false,
'watchOHLCV': true,
},
'urls': {
'api': {
'ws': 'wss://api.hitbtc.com/api/2/ws',
},
},
'options': {
'tradesLimit': 1000,
'methods': {
'orderbook': 'subscribeOrderbook',
'ticker': 'subscribeTicker',
'trades': 'subscribeTrades',
'ohlcv': 'subscribeCandles',
},
},
});
}
async watchPublic(symbol, channel, timeframe = undefined, params = {}) {
await this.loadMarkets();
const marketId = this.marketId(symbol);
const url = this.urls['api']['ws'];
let messageHash = channel + ':' + marketId;
if (timeframe !== undefined) {
messageHash += ':' + timeframe;
}
const methods = this.safeValue(this.options, 'methods', {});
const method = this.safeString(methods, channel, channel);
const requestId = this.nonce();
const subscribe = {
'method': method,
'params': {
'symbol': marketId,
},
'id': requestId,
};
const request = this.deepExtend(subscribe, params);
return await this.watch(url, messageHash, request, messageHash);
}
async watchOrderBook(symbol, limit = undefined, params = {}) {
/**
* @method
* @name hitbtc#watchOrderBook
* @description watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
* @param {string} symbol unified symbol of the market to fetch the order book for
* @param {int|undefined} limit the maximum amount of order book entries to return
* @param {object} params extra parameters specific to the hitbtc api endpoint
* @returns {object} A dictionary of [order book structures]{@link https://docs.ccxt.com/#/?id=order-book-structure} indexed by market symbols
*/
const orderbook = await this.watchPublic(symbol, 'orderbook', undefined, params);
return orderbook.limit();
}
handleOrderBookSnapshot(client, message) {
//
// {
// jsonrpc: "2.0",
// method: "snapshotOrderbook",
// params: {
// ask: [
// { price: "6927.75", size: "0.11991" },
// { price: "6927.76", size: "0.06200" },
// { price: "6927.85", size: "0.01000" },
// ],
// bid: [
// { price: "6926.18", size: "0.16898" },
// { price: "6926.17", size: "0.06200" },
// { price: "6925.97", size: "0.00125" },
// ],
// symbol: "BTCUSD",
// sequence: 494854,
// timestamp: "2020-04-03T08:58:53.460Z"
// }
// }
//
const params = this.safeValue(message, 'params', {});
const marketId = this.safeString(params, 'symbol');
const market = this.safeMarket(marketId);
const symbol = market['symbol'];
const timestamp = this.parse8601(this.safeString(params, 'timestamp'));
const nonce = this.safeInteger(params, 'sequence');
if (symbol in this.orderbooks) {
delete this.orderbooks[symbol];
}
const snapshot = this.parseOrderBook(params, symbol, timestamp, 'bid', 'ask', 'price', 'size');
const orderbook = this.orderBook(snapshot);
orderbook['nonce'] = nonce;
this.orderbooks[symbol] = orderbook;
const messageHash = 'orderbook:' + marketId;
client.resolve(orderbook, messageHash);
}
handleOrderBookUpdate(client, message) {
//
// {
// jsonrpc: "2.0",
// method: "updateOrderbook",
// params: {
// ask: [
// { price: "6940.65", size: "0.00000" },
// { price: "6940.66", size: "6.00000" },
// { price: "6943.52", size: "0.04707" },
// ],
// bid: [
// { price: "6938.40", size: "0.11991" },
// { price: "6938.39", size: "0.00073" },
// { price: "6936.65", size: "0.00000" },
// ],
// symbol: "BTCUSD",
// sequence: 497872,
// timestamp: "2020-04-03T09:03:56.685Z"
// }
// }
//
const params = this.safeValue(message, 'params', {});
const marketId = this.safeString(params, 'symbol');
const market = this.safeMarket(marketId);
const symbol = market['symbol'];
if (symbol in this.orderbooks) {
const timestamp = this.parse8601(this.safeString(params, 'timestamp'));
const nonce = this.safeInteger(params, 'sequence');
const orderbook = this.orderbooks[symbol];
const asks = this.safeValue(params, 'ask', []);
const bids = this.safeValue(params, 'bid', []);
this.handleDeltas(orderbook['asks'], asks);
this.handleDeltas(orderbook['bids'], bids);
orderbook['timestamp'] = timestamp;
orderbook['datetime'] = this.iso8601(timestamp);
orderbook['nonce'] = nonce;
this.orderbooks[symbol] = orderbook;
const messageHash = 'orderbook:' + marketId;
client.resolve(orderbook, messageHash);
}
}
handleDelta(bookside, delta) {
const price = this.safeFloat(delta, 'price');
const amount = this.safeFloat(delta, 'size');
bookside.store(price, amount);
}
handleDeltas(bookside, deltas) {
for (let i = 0; i < deltas.length; i++) {
this.handleDelta(bookside, deltas[i]);
}
}
async watchTicker(symbol, params = {}) {
/**
* @method
* @name hitbtc#watchTicker
* @description watches 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 hitbtc api endpoint
* @returns {object} a [ticker structure]{@link https://docs.ccxt.com/#/?id=ticker-structure}
*/
return await this.watchPublic(symbol, 'ticker', undefined, params);
}
handleTicker(client, message) {
//
// {
// jsonrpc: '2.0',
// method: 'ticker',
// params: {
// ask: '6983.22',
// bid: '6980.77',
// last: '6980.77',
// open: '6650.05',
// low: '6606.45',
// high: '7223.11',
// volume: '79264.33941',
// volumeQuote: '540183372.5134832',
// timestamp: '2020-04-03T10:02:18.943Z',
// symbol: 'BTCUSD'
// }
// }
//
const params = this.safeValue(message, 'params');
const marketId = this.safeValue(params, 'symbol');
const market = this.safeMarket(marketId);
const symbol = market['symbol'];
const result = this.parseTicker(params, market);
this.tickers[symbol] = result;
const method = this.safeValue(message, 'method');
const messageHash = method + ':' + marketId;
client.resolve(result, messageHash);
}
async watchTrades(symbol, since = undefined, limit = undefined, params = {}) {
/**
* @method
* @name hitbtc#watchTrades
* @description get the list of most recent trades for a particular symbol
* @param {string} symbol unified symbol of the market to fetch trades for
* @param {int|undefined} since timestamp in ms of the earliest trade to fetch
* @param {int|undefined} limit the maximum amount of trades to fetch
* @param {object} params extra parameters specific to the hitbtc api endpoint
* @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades}
*/
const trades = await this.watchPublic(symbol, 'trades', undefined, params);
if (this.newUpdates) {
limit = trades.getLimit(symbol, limit);
}
return this.filterBySinceLimit(trades, since, limit, 'timestamp', true);
}
handleTrades(client, message) {
//
// {
// jsonrpc: '2.0',
// method: 'snapshotTrades', // updateTrades
// params: {
// data: [
// {
// id: 814145791,
// price: '6957.20',
// quantity: '0.02779',
// side: 'buy',
// timestamp: '2020-04-03T10:28:20.032Z'
// },
// {
// id: 814145792,
// price: '6957.20',
// quantity: '0.12918',
// side: 'buy',
// timestamp: '2020-04-03T10:28:20.039Z'
// },
// ],
// symbol: 'BTCUSD'
// }
// }
//
const params = this.safeValue(message, 'params', {});
const data = this.safeValue(params, 'data', []);
const marketId = this.safeString(params, 'symbol');
const market = this.safeMarket(marketId);
const symbol = market['symbol'];
const messageHash = 'trades:' + marketId;
const tradesLimit = this.safeInteger(this.options, 'tradesLimit', 1000);
let stored = this.safeValue(this.trades, symbol);
if (stored === undefined) {
stored = new ArrayCache(tradesLimit);
this.trades[symbol] = stored;
}
if (Array.isArray(data)) {
const trades = this.parseTrades(data, market);
for (let i = 0; i < trades.length; i++) {
stored.append(trades[i]);
}
}
else {
const trade = this.parseTrade(message, market);
stored.append(trade);
}
client.resolve(stored, messageHash);
return message;
}
async watchOHLCV(symbol, timeframe = '1m', since = undefined, limit = undefined, params = {}) {
/**
* @method
* @name hitbtc#watchOHLCV
* @description watches 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 {int|undefined} since timestamp in ms of the earliest candle to fetch
* @param {int|undefined} limit the maximum amount of candles to fetch
* @param {object} params extra parameters specific to the hitbtc api endpoint
* @returns {[[int]]} A list of candles ordered as timestamp, open, high, low, close, volume
*/
// if (limit === undefined) {
// limit = 100;
// }
const period = this.safeString(this.timeframes, timeframe, timeframe);
const request = {
'params': {
'period': period,
// 'limit': limit,
},
};
const requestParams = this.deepExtend(request, params);
const ohlcv = await this.watchPublic(symbol, 'ohlcv', period, requestParams);
if (this.newUpdates) {
limit = ohlcv.getLimit(symbol, limit);
}
return this.filterBySinceLimit(ohlcv, since, limit, 0, true);
}
handleOHLCV(client, message) {
//
// {
// jsonrpc: '2.0',
// method: 'snapshotCandles', // updateCandles
// params: {
// data: [
// {
// timestamp: '2020-04-05T00:06:00.000Z',
// open: '6869.40',
// close: '6867.16',
// min: '6863.17',
// max: '6869.4',
// volume: '0.08947',
// volumeQuote: '614.4195442'
// },
// {
// timestamp: '2020-04-05T00:07:00.000Z',
// open: '6867.54',
// close: '6859.26',
// min: '6858.85',
// max: '6867.54',
// volume: '1.7766',
// volumeQuote: '12191.5880395'
// },
// ],
// symbol: 'BTCUSD',
// period: 'M1'
// }
// }
//
const params = this.safeValue(message, 'params', {});
const data = this.safeValue(params, 'data', []);
const marketId = this.safeString(params, 'symbol');
const market = this.safeMarket(marketId);
const symbol = market['symbol'];
const period = this.safeString(params, 'period');
const timeframe = this.findTimeframe(period);
const messageHash = 'ohlcv:' + marketId + ':' + period;
for (let i = 0; i < data.length; i++) {
const candle = data[i];
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);
client.resolve(stored, messageHash);
}
return message;
}
handleNotification(client, message) {
//
// { jsonrpc: '2.0', result: true, id: null }
//
return message;
}
handleMessage(client, message) {
const methods = {
'snapshotOrderbook': this.handleOrderBookSnapshot,
'updateOrderbook': this.handleOrderBookUpdate,
'ticker': this.handleTicker,
'snapshotTrades': this.handleTrades,
'updateTrades': this.handleTrades,
'snapshotCandles': this.handleOHLCV,
'updateCandles': this.handleOHLCV,
};
const event = this.safeString(message, 'method');
const method = this.safeValue(methods, event);
if (method === undefined) {
this.handleNotification(client, message);
}
else {
method.call(this, client, message);
}
}
}