hollaex-node-lib 2.15.3 → 2.16.0

package/README.md

@@ -12,12 +12,15 @@ const hollaex = require('hollaex-node-lib');
 const client = new hollaex();
 ```
 
-You can pass the `apiURL` and `baseURL` of the HollaEx-Enabled exchange to connect to. You can also pass your `apiKey` and `apiSecret` generated from the HollaEx-Enabled exchange.
+You can pass custom `apiURL`, `wsURL` and `baseURL` of the HollaEx-Enabled exchange to connect to. `apiURL` is `https://api.hollaex.com` for HollaEx Pro and for your custom exchange it would be something like `https://myexchange.com/api`.
+`wsURL` is the websocket URL for the socket connection and you should pass your stream URL. For HollaEx Pro it is `wss://api.hollaex.com/stream` and for your exchange it would be something like `wss://myexchange.com/stream`. `baseURL` is not required and it is set by default to `/v2` unless you need to connect to an older version of HollaEx.
+
+You can also pass your `apiKey` and `apiSecret` generated from the HollaEx-Enabled exchange to use private requests that require authentication. For public endpoints `apiKey` and `apiSecret` are not required.
 
 ```javascript
 const client = new hollaex({
 	apiURL: '<EXCHANGE_API_URL>',
-	baseURL: '<EXCHANGE_BASE_URL>',
+	wsURL: '<EXCHANGE_WS_URL>',
 	apiKey: '<MY_API_KEY>',
 	apiSecret: '<MY_API_SECRET>'
 });
@@ -30,7 +33,7 @@ You can also pass the field `apiExpiresAfter` which is the length of time in sec
 ```javascript
 const client = new hollaex({
 	apiURL: '<EXCHANGE_API_URL>',
-	baseURL: '<EXCHANGE_BASE_URL>',
+	wsURL: '<EXCHANGE_API_URL>',
 	apiKey: '<MY_API_KEY>',
 	apiSecret: '<MY_API_SECRET>'
 });
@@ -109,6 +112,7 @@ client
 | `getExchangeUserReferrer` | <ul><li>**userId**: The identifier of the user to filter by</li></ul> | Retrieve user's referer info by admin |
 | `sendExchangeUserEmail` | <ul><li>**userId**:  The identifier of the user</li><li>**mailType**: The mail type for the email payload</li><li>**data**: The content of the mail</li></ul> | Send email to exchange user account by admin |
 | `sendRawEmail` | <ul><li>**receivers**:  The array of emails to send mail</li><li>**html**: The stringified html content</li><li>**opts.title**:  The title of the mail</li><li>**opts.text**:  The text of the mail</li></ul> | Send email to users with custom html by admin |
+| `getOraclePrice` | <ul><li>**assets**:  Assets to convert</li><li>**opts.quote**: Quote coin to convert to</li><li>**opts.amount**:  Amount to convert</li></ul> | Retrieve price conversion |
 
 
 ### Websocket

package/example/hollaex.js

@@ -3,7 +3,13 @@ require('dotenv').load();
 
 const API_KEY = process.env.API_KEY || '';
 const API_SECRET = process.env.API_SECRET || '';
-const client = new HollaEx({ apiKey: API_KEY, apiSecret: API_SECRET });
+const client = new HollaEx({
+	apiURL: 'https://api.hollaex.com',
+	wsURL: 'wss://api.hollaex.com/stream',
+	baseURL: '/v2',
+	apiKey: API_KEY,
+	apiSecret: API_SECRET
+});
 
 client
 	.getTicker('xht-usdt')
@@ -22,12 +28,12 @@ client
 	symbols : xht-usdt
 */
 
-// client.connect(['orderbook']);
+client.connect(['orderbook:xht-usdt']);
 
-// client.ws.on('message', (data) => {
-// 	data = JSON.parse(data);
-// 	console.log(data);
-// });
+client.ws.on('message', (data) => {
+	data = JSON.parse(data);
+	console.log(data);
+});
 
 
 

package/kit.js

@@ -4,7 +4,7 @@ const WebSocket = require('ws');
 const moment = require('moment');
 const { createRequest, createSignature, generateHeaders, isDatetime, sanitizeDate } = require('./utils');
 const { setWsHeartbeat } = require('ws-heartbeat/client');
-const { each, union, isNumber, isString, isPlainObject, isBoolean, isObject, isArray } = require('lodash');
+const { each, union, isNumber, isString, isPlainObject, isBoolean, isObject } = require('lodash');
 class HollaExKit {
 	constructor(
 		opts = {
@@ -27,10 +27,13 @@ class HollaExKit {
 		};
 		this.ws = null;
 		const [protocol, endpoint] = this.apiUrl.split('://');
-		this.wsUrl =
-			protocol === 'https'
-				? `wss://${endpoint}/stream`
-				: `ws://${endpoint}/stream`;
+		this.wsUrl = (
+			opts.wsURL
+				? opts.wsURL
+				: protocol === 'https'
+					? `wss://${endpoint}/stream`
+					: `ws://${endpoint}/stream`
+		);
 		this.wsEvents = [];
 		this.wsReconnect = true;
 		this.wsReconnectInterval = 5000;
@@ -470,7 +473,7 @@ class HollaExKit {
 			path += `&end_date=${sanitizeDate(opts.endDate)}`;
 		}
 
-		if (isString(opts.format)) {
+		if (isString(opts.format) && ['csv', 'all'].includes(opts.format)) {
 			path += `&format=${opts.format}`;
 		}
 
@@ -672,6 +675,44 @@ class HollaExKit {
 		return createRequest(verb, `${this.apiUrl}${path}`, headers);
 	}
 
+	/**
+	 * Retrieve price conversion
+	 * @param {array} assets - Assets to convert
+	 * @param {string} opts.quote - Quote coin to convert to
+	 * @param {number} opts.amount - Amount to convert
+	 * @return {object} A JSON object with conversion info
+	 */
+	getOraclePrice(
+		assets, 
+		opts = {
+			quote: null,
+			amount: null
+		}
+	) {
+		const verb = 'GET';
+		let path = `${this.baseUrl}/oracle/prices?`;
+
+		if (isArray(assets)) {
+			path += `&assets=${assets}`;
+		}
+
+		if (isString(opts.quote)) {
+			path += `&quote=${opts.quote}`;
+		}
+		
+		if (isNumber(opts.amount)) {
+			path += `&amount=${opts.amount}`;
+		}
+
+		const headers = generateHeaders(
+			this.headers,
+			this.apiSecret,
+			verb,
+			path,
+			this.apiExpiresAfter
+		);
+		return createRequest(verb, `${this.apiUrl}${path}`, headers);
+	}
 
 	/**
 	 * Get admin exchange information
@@ -795,7 +836,7 @@ class HollaExKit {
 			path += `&address=${opts.address}`;
 		}
 
-		if (isString(opts.format) && opts.format === 'csv') {
+		if (isString(opts.format) && ['csv', 'all'].includes(opts.format)) {
 			path += `&format=${opts.format}`;
 		}
 
@@ -913,7 +954,7 @@ class HollaExKit {
 			path += `&waiting=${opts.waiting}`;
 		}
 
-		if (isString(opts.format) && opts.format === 'csv') {
+		if (isString(opts.format) && ['csv', 'all'].includes(opts.format)) {
 			path += `&format=${opts.format}`;
 		}
 
@@ -1371,6 +1412,7 @@ class HollaExKit {
 			orderBy: null,
 			order: null,
 			startDate: null,
+			endDate: null,
 			format: null
 		}
 	) {
@@ -1405,11 +1447,11 @@ class HollaExKit {
 			path += `&start_date=${sanitizeDate(opts.startDate)}`;
 		}
 	
-		if (isDatetime(opts.startDate)) {
-			path += `&end_date=${sanitizeDate(opts.startDate)}`;
+		if (isDatetime(opts.endDate)) {
+			path += `&end_date=${sanitizeDate(opts.endDate)}`;
 		}
 	
-		if (isString(opts.format) && opts.format === 'csv') {
+		if (isString(opts.format) && ['csv', 'all'].includes(opts.format)) {
 			path += `&format=${opts.format}`;
 		}
 	
@@ -1617,7 +1659,7 @@ class HollaExKit {
 			path += `&end_date=${sanitizeDate(opts.endDate)}`;
 		}
 	
-		if (isString(opts.format) && opts.format === 'csv') {
+		if (isString(opts.format) && ['csv', 'all'].includes(opts.format)) {
 			path += `&format=${opts.format}`;
 		}
 	
@@ -1911,7 +1953,7 @@ class HollaExKit {
 			path += `&end_date=${sanitizeDate(opts.endDate)}`;
 		}
 	
-		if (isString(opts.format) && opts.format === 'csv') {
+		if (isString(opts.format) && ['csv', 'all'].includes(opts.format)) {
 			path += `&format=${opts.format}`;
 		}
 	
@@ -2028,7 +2070,7 @@ class HollaExKit {
 			path += `&end_date=${sanitizeDate(opts.endDate)}`;
 		}
 	
-		if (isString(opts.format) && opts.format === 'csv') {
+		if (isString(opts.format) && ['csv', 'all'].includes(opts.format)) {
 			path += `&format=${opts.format}`;
 		}
 	

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "hollaex-node-lib",
-	"version": "2.15.3",
+	"version": "2.16.0",
 	"description": "hollaex api and websocket library for nodejs",
 	"main": "index.js",
 	"dependencies": {