hollaex-node-lib 2.1.0 → 2.14.0

package/kit.js

@@ -2,10 +2,9 @@
 
 const WebSocket = require('ws');
 const moment = require('moment');
-const { createRequest, createSignature, generateHeaders } = require('./utils');
+const { createRequest, createSignature, generateHeaders, isDatetime, sanitizeDate } = require('./utils');
 const { setWsHeartbeat } = require('ws-heartbeat/client');
 const { each, union, isNumber, isString, isPlainObject, isBoolean } = require('lodash');
-
 class HollaExKit {
 	constructor(
 		opts = {
@@ -178,10 +177,10 @@ class HollaExKit {
 	 * @param {boolean} opts.waiting - Waiting status of the deposits to get. Leave blank to get all waiting and unwaiting deposits
 	 * @param {number} opts.limit - Amount of trades per page. Maximum: 50. Default: 50
 	 * @param {number} opts.page - Page of trades data. Default: 1
-	 * @param {string} opts.orderBy - The field to order data by e.g. amount, id. Default: id
-	 * @param {string} opts.order - Ascending (asc) or descending (desc). Default: asc
-	 * @param {string} opts.startDate - Start date of query in ISO8601 format. Default: 0
-	 * @param {string} opts.endDate - End date of query in ISO8601 format: Default: current time in ISO8601 format
+	 * @param {string} opts.orderBy - The field to order data by e.g. amount, id.
+	 * @param {string} opts.order - Ascending (asc) or descending (desc).
+	 * @param {string} opts.startDate - Start date of query in ISO8601 format.
+	 * @param {string} opts.endDate - End date of query in ISO8601 format.
 	 * @param {string} opts.transactionId - Deposits with specific transaction ID.
 	 * @param {string} opts.address - Deposits with specific address.
 	 * @return {object} A JSON object with the keys count(total number of user's deposits) and data(array of deposits as objects with keys id(number), type(string), amount(number), transaction_id(string), currency(string), created_at(string), status(boolean), fee(number), dismissed(boolean), rejected(boolean), description(string))
@@ -194,12 +193,12 @@ class HollaExKit {
 			rejected: null,
 			processing: null,
 			waiting: null,
-			limit: 50,
-			page: 1,
-			orderBy: 'id',
-			order: 'asc',
-			startDate: 0,
-			endDate: moment().toISOString(),
+			limit: null,
+			page: null,
+			orderBy: null,
+			order: null,
+			startDate: null,
+			endDate: null,
 			transactionId: null,
 			address: null
 		}
@@ -227,12 +226,12 @@ class HollaExKit {
 			path += `&order=${opts.order}`;
 		}
 
-		if (isString(opts.startDate)) {
-			path += `&start_date=${opts.startDate}`;
+		if (isDatetime(opts.startDate)) {
+			path += `&start_date=${sanitizeDate(opts.startDate)}`;
 		}
 
-		if (isString(opts.endDate)) {
-			path += `&end_date=${opts.endDate}`;
+		if (isDatetime(opts.endDate)) {
+			path += `&end_date=${sanitizeDate(opts.endDate)}`;
 		}
 
 		if (isString(opts.address)) {
@@ -285,10 +284,10 @@ class HollaExKit {
 	 * @param {boolean} opts.waiting - Waiting status of the withdrawals to get. Leave blank to get all waiting and unwaiting withdrawals
 	 * @param {number} opts.limit - Amount of trades per page. Maximum: 50. Default: 50
 	 * @param {number} opts.page - Page of trades data. Default: 1
-	 * @param {string} opts.orderBy - The field to order data by e.g. amount, id. Default: id
-	 * @param {string} opts.order - Ascending (asc) or descending (desc). Default: asc
-	 * @param {string} opts.startDate - Start date of query in ISO8601 format. Default: 0
-	 * @param {string} opts.endDate - End date of query in ISO8601 format: Default: current time in ISO8601 format
+	 * @param {string} opts.orderBy - The field to order data by e.g. amount, id.
+	 * @param {string} opts.order - Ascending (asc) or descending (desc).
+	 * @param {string} opts.startDate - Start date of query in ISO8601 format.
+	 * @param {string} opts.endDate - End date of query in ISO8601 format.
 	 * @param {string} opts.transactionId - Withdrawals with specific transaction ID.
 	 * @param {string} opts.address - Withdrawals with specific address.
 	 * @return {object} A JSON object with the keys count(total number of user's withdrawals) and data(array of withdrawals as objects with keys id(number), type(string), amount(number), transaction_id(string), currency(string), created_at(string), status(boolean), fee(number), dismissed(boolean), rejected(boolean), description(string))
@@ -301,12 +300,12 @@ class HollaExKit {
 			rejected: null,
 			processing: null,
 			waiting: null,
-			limit: 50,
-			page: 1,
-			orderBy: 'id',
-			order: 'asc',
-			startDate: 0,
-			endDate: moment().toISOString(),
+			limit: null,
+			page: null,
+			orderBy: null,
+			order: null,
+			startDate: null,
+			endDate: null,
 			transactionId: null,
 			address: null
 		}
@@ -334,12 +333,12 @@ class HollaExKit {
 			path += `&order=${opts.order}`;
 		}
 
-		if (isString(opts.startDate)) {
-			path += `&start_date=${opts.startDate}`;
+		if (isDatetime(opts.startDate)) {
+			path += `&start_date=${sanitizeDate(opts.startDate)}`;
 		}
 
-		if (isString(opts.endDate)) {
-			path += `&end_date=${opts.endDate}`;
+		if (isDatetime(opts.endDate)) {
+			path += `&end_date=${sanitizeDate(opts.endDate)}`;
 		}
 
 		if (isString(opts.address)) {
@@ -381,31 +380,25 @@ class HollaExKit {
 	}
 
 	/**
-	 * Make a withdrawal request
+	 * Make a withdrawal
 	 * @param {string} currency - The currency to withdrawal
 	 * @param {number} amount - The amount of currency to withdrawal
 	 * @param {string} address - The recipient's wallet address
 	 * @param {object} opts - Optional parameters.
 	 * @param {string} opts.network - Crypto network of currency being withdrawn.
-	 * @param {string} opts.otpCode - Otp code for user if otp is enabled.
 	 * @return {object} A JSON object {message:"Success"}
 	 */
-	requestWithdrawal(currency, amount, address, opts = {
+	makeWithdrawal(currency, amount, address, opts = {
 		network: null,
-		otpCode: null
 	}) {
 		const verb = 'POST';
-		const path = `${this.baseUrl}/user/request-withdrawal`;
+		const path = `${this.baseUrl}/user/withdrawal`;
 		const data = {
 			currency,
 			amount,
 			address
 		};
 
-		if (opts.network) {
-			data.otp_code = opts.otpCode;
-		}
-
 		if (opts.network) {
 			data.network = opts.network;
 		}
@@ -418,30 +411,32 @@ class HollaExKit {
 			this.apiExpiresAfter,
 			data
 		);
-		return createRequest(verb, `${this.apiUrl}${path}`, headers, data);
+		return createRequest(verb, `${this.apiUrl}${path}`, headers, { data });
 	}
 
 	/**
 	 * Retrieve list of the user's completed trades
 	 * @param {object} opts - Optional parameters
 	 * @param {string} opts.symbol - The symbol-pair to filter by, pass undefined to receive data on all currencies
-	 * @param {number} opts.limit - Amount of trades per page. Maximum: 50. Default: 50
-	 * @param {number} opts.page - Page of trades data. Default: 1
+	 * @param {number} opts.limit - Amount of trades per page
+	 * @param {number} opts.page - Page of trades data
 	 * @param {string} opts.orderBy - The field to order data by e.g. amount, id. Default: id
 	 * @param {string} opts.order - Ascending (asc) or descending (desc). Default: desc
-	 * @param {string} opts.startDate - Start date of query in ISO8601 format. Default: 0
-	 * @param {string} opts.endDate - End date of query in ISO8601 format: Default: current time in ISO8601 format
+	 * @param {string} opts.startDate - Start date of query in ISO8601 format
+	 * @param {string} opts.endDate - End date of query in ISO8601 format
+	 * @param {string} opts.format - Custom format of data set. Enum: ['all', 'csv']
 	 * @return {object} A JSON object with the keys count(total number of user's completed trades) and data(array of up to the user's last 50 completed trades as objects with keys side(string), symbol(string), size(number), price(number), timestamp(string), and fee(number))
 	 */
 	getUserTrades(
 		opts = {
 			symbol: null,
-			limit: 50,
-			page: 1,
-			orderBy: 'id',
-			order: 'desc',
-			startDate: 0,
-			endDate: moment().toISOString()
+			limit: null,
+			page: null,
+			orderBy: null,
+			order: null,
+			startDate: null,
+			endDate: null,
+			format: null
 		}
 	) {
 		const verb = 'GET';
@@ -467,12 +462,16 @@ class HollaExKit {
 			path += `&order=${opts.order}`;
 		}
 
-		if (isString(opts.startDate)) {
-			path += `&start_date=${opts.startDate}`;
+		if (isDatetime(opts.startDate)) {
+			path += `&start_date=${sanitizeDate(opts.startDate)}`;
+		}
+
+		if (isDatetime(opts.endDate)) {
+			path += `&end_date=${sanitizeDate(opts.endDate)}`;
 		}
 
-		if (isString(opts.endDate)) {
-			path += `&end_date=${opts.endDate}`;
+		if (isString(opts.format)) {
+			path += `&format=${opts.format}`;
 		}
 
 		const headers = generateHeaders(
@@ -482,6 +481,7 @@ class HollaExKit {
 			path,
 			this.apiExpiresAfter
 		);
+
 		return createRequest(verb, `${this.apiUrl}${path}`, headers);
 	}
 
@@ -510,10 +510,10 @@ class HollaExKit {
 	 * @param {string} opts.symbol - The currency pair symbol to filter by e.g. 'hex-usdt', leave empty to retrieve information of orders of all symbols
 	 * @param {number} opts.limit - Amount of trades per page. Maximum: 50. Default: 50
 	 * @param {number} opts.page - Page of trades data. Default: 1
-	 * @param {string} opts.orderBy - The field to order data by e.g. amount, id. Default: id
-	 * @param {string} opts.order - Ascending (asc) or descending (desc). Default: desc
-	 * @param {string} opts.startDate - Start date of query in ISO8601 format. Default: 0
-	 * @param {string} opts.endDate - End date of query in ISO8601 format: Default: current time in ISO8601 format
+	 * @param {string} opts.orderBy - The field to order data by e.g. amount, id.
+	 * @param {string} opts.order - Ascending (asc) or descending (desc).
+	 * @param {string} opts.startDate - Start date of query in ISO8601 format.
+	 * @param {string} opts.endDate - End date of query in ISO8601 format.
 	 * @return {object} A JSON array of objects containing the user's active orders
 	 */
 	getOrders(
@@ -522,12 +522,12 @@ class HollaExKit {
 			side: null,
 			status: null,
 			open: null,
-			limit: 50,
-			page: 1,
-			orderBy: 'id',
-			order: 'desc',
-			startDate: 0,
-			endDate: moment().toISOString()
+			limit: null,
+			page: null,
+			orderBy: null,
+			order: null,
+			startDate: null,
+			endDate: null
 		}
 	) {
 		const verb = 'GET';
@@ -565,12 +565,12 @@ class HollaExKit {
 			path += `&order=${opts.order}`;
 		}
 
-		if (isString(opts.startDate)) {
-			path += `&start_date=${opts.startDate}`;
+		if (isDatetime(opts.startDate)) {
+			path += `&start_date=${sanitizeDate(opts.startDate)}`;
 		}
 
-		if (isString(opts.endDate)) {
-			path += `&end_date=${opts.endDate}`;
+		if (isDatetime(opts.endDate)) {
+			path += `&end_date=${sanitizeDate(opts.endDate)}`;
 		}
 
 		const headers = generateHeaders(
@@ -593,6 +593,8 @@ class HollaExKit {
 	 * @param {object} opts - Optional parameters
 	 * @param {number} opts.stop - Stop order price
 	 * @param {object} opts.meta - Additional meta parameters in an object
+	 * @param {boolean} opts.meta.post_only - Whether or not the order should only be made if market maker.
+	 * @param {string} opts.meta.note - Additional note to add to order data.
 	 * @return {object} The new order as a JSON object with keys symbol(string), side(string), size(number), type(string), price(number), id(string), created_by(number), and filled(number)
 	 */
 	createOrder(
@@ -626,7 +628,7 @@ class HollaExKit {
 			this.apiExpiresAfter,
 			data
 		);
-		return createRequest(verb, `${this.apiUrl}${path}`, headers, data);
+		return createRequest(verb, `${this.apiUrl}${path}`, headers, { data });
 	}
 
 	/**
@@ -648,19 +650,17 @@ class HollaExKit {
 	}
 
 	/**
-	 * Cancel all the user's active orders, can filter by currency pair symbol
-	 * @param {object} opts - Optional parameters
-	 * @param {string} opts.symbol - The currency pair symbol to filter by e.g. 'hex-usdt', leave empty to cancel orders of all symbols
+	 * Cancel all the active orders of a user, filtered by currency pair symbol
+	 * @param {string} symbol - The currency pair symbol to filter by e.g. 'hex-usdt'
 	 * @return {array} A JSON array of objects containing the cancelled orders
 	 */
-	cancelAllOrders(opts = { symbol: null }) {
-		const verb = 'DELETE';
-		let path = `${this.baseUrl}/order/all`;
-
-		if (isString(opts.symbol)) {
-			path += `?symbol=${opts.symbol}`;
+	cancelAllOrders(symbol) {
+		if (!isString(symbol)) {
+			throw new Error('You must provide a symbol to cancel all orders for');
 		}
 
+		const verb = 'DELETE';
+		let path = `${this.baseUrl}/order/all?symbol=${symbol}`;
 		const headers = generateHeaders(
 			this.headers,
 			this.apiSecret,
@@ -668,6 +668,7 @@ class HollaExKit {
 			path,
 			this.apiExpiresAfter
 		);
+
 		return createRequest(verb, `${this.apiUrl}${path}`, headers);
 	}
 
@@ -782,38 +783,21 @@ class HollaExKit {
 				if (!this.wsEvents.includes(event) || this.initialConnection) {
 					const [topic, symbol] = event.split(':');
 					switch (topic) {
-						case 'orderbook':
-						case 'trade':
-							if (symbol) {
-								if (!this.wsEvents.includes(topic)) {
-									this.ws.send(
-										JSON.stringify({
-											op: 'subscribe',
-											args: [`${topic}:${symbol}`]
-										})
-									);
-									if (!this.initialConnection) {
-										this.wsEvents = union(this.wsEvents, [event]);
-									}
-								}
-							} else {
+					case 'orderbook':
+					case 'trade':
+						if (symbol) {
+							if (!this.wsEvents.includes(topic)) {
 								this.ws.send(
 									JSON.stringify({
 										op: 'subscribe',
-										args: [topic]
+										args: [`${topic}:${symbol}`]
 									})
 								);
 								if (!this.initialConnection) {
-									this.wsEvents = this.wsEvents.filter(
-										(e) => !e.includes(`${topic}:`)
-									);
 									this.wsEvents = union(this.wsEvents, [event]);
 								}
 							}
-							break;
-						case 'order':
-						case 'wallet':
-						case 'deposit':
+						} else {
 							this.ws.send(
 								JSON.stringify({
 									op: 'subscribe',
@@ -821,11 +805,28 @@ class HollaExKit {
 								})
 							);
 							if (!this.initialConnection) {
+								this.wsEvents = this.wsEvents.filter(
+									(e) => !e.includes(`${topic}:`)
+								);
 								this.wsEvents = union(this.wsEvents, [event]);
 							}
-							break;
-						default:
-							break;
+						}
+						break;
+					case 'order':
+					case 'wallet':
+					case 'deposit':
+						this.ws.send(
+							JSON.stringify({
+								op: 'subscribe',
+								args: [topic]
+							})
+						);
+						if (!this.initialConnection) {
+							this.wsEvents = union(this.wsEvents, [event]);
+						}
+						break;
+					default:
+						break;
 					}
 				}
 			});
@@ -844,38 +845,38 @@ class HollaExKit {
 				if (this.wsEvents.includes(event)) {
 					const [topic, symbol] = event.split(':');
 					switch (topic) {
-						case 'orderbook':
-						case 'trade':
-							if (symbol) {
-								this.ws.send(
-									JSON.stringify({
-										op: 'unsubscribe',
-										args: [`${topic}:${symbol}`]
-									})
-								);
-							} else {
-								this.ws.send(
-									JSON.stringify({
-										op: 'unsubscribe',
-										args: [topic]
-									})
-								);
-							}
-							this.wsEvents = this.wsEvents.filter((e) => e !== event);
-							break;
-						case 'order':
-						case 'wallet':
-						case 'deposit':
+					case 'orderbook':
+					case 'trade':
+						if (symbol) {
+							this.ws.send(
+								JSON.stringify({
+									op: 'unsubscribe',
+									args: [`${topic}:${symbol}`]
+								})
+							);
+						} else {
 							this.ws.send(
 								JSON.stringify({
 									op: 'unsubscribe',
 									args: [topic]
 								})
 							);
-							this.wsEvents = this.wsEvents.filter((e) => e !== event);
-							break;
-						default:
-							break;
+						}
+						this.wsEvents = this.wsEvents.filter((e) => e !== event);
+						break;
+					case 'order':
+					case 'wallet':
+					case 'deposit':
+						this.ws.send(
+							JSON.stringify({
+								op: 'unsubscribe',
+								args: [topic]
+							})
+						);
+						this.wsEvents = this.wsEvents.filter((e) => e !== event);
+						break;
+					default:
+						break;
 					}
 				}
 			});

package/package.json

@@ -1,9 +1,11 @@
 {
 	"name": "hollaex-node-lib",
-	"version": "2.1.0",
+	"version": "2.14.0",
 	"description": "hollaex api and websocket library for nodejs",
 	"main": "index.js",
 	"dependencies": {
+		"file-type": "16.5.2",
+		"is-base64": "1.1.0",
 		"lodash": "4.17.13",
 		"moment": "2.24.0",
 		"request": "2.88.0",
@@ -15,19 +17,27 @@
 		"chai": "4.2.0",
 		"dotenv": "6.2.0",
 		"eslint": "5.13.0",
-		"mocha": "5.2.0",
-		"prettier": "1.16.4"
+		"husky": "4.3.8",
+		"lint-staged": "12.1.3",
+		"mocha": "5.2.0"
 	},
 	"scripts": {
 		"start": "node index.js",
 		"test": "mocha test/test.js --timeout 10000",
-		"prettier": "prettier --config .prettierrc.json --ignore-path .prettierignore.json --write \"./**/*.{js,json,css,scss,md}\"",
-		"eslint": "eslint --config .eslintrc.json ./"
+		"lint": "eslint --fix ."
+	},
+	"husky": {
+		"hooks": {
+			"pre-commit": "lint-staged"
+		}
+	},
+	"lint-staged": {
+		"*.js": "eslint --fix"
 	},
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/bitholla/hollaex-node-lib"
 	},
 	"author": "bitHolla Inc",
-	"license": "ISC"
+	"license": "MIT"
 }

package/utils.js

@@ -1,14 +1,23 @@
 const rp = require('request-promise');
 const crypto = require('crypto');
 const moment = require('moment');
+const { isDate } = require('lodash');
 
-const createRequest = (verb, url, headers, data) => {
+const createRequest = (verb, url, headers, opts = { data: null, formData: null }) => {
 	const requestObj = {
 		headers,
 		url,
-		body: data,
 		json: true
 	};
+
+	if (opts.data) {
+		requestObj.body = opts.data;
+	}
+
+	if (opts.formData) {
+		requestObj.formData = opts.formData;
+	}
+
 	return rp[verb.toLowerCase()](requestObj);
 };
 
@@ -46,10 +55,31 @@ const parameterError = (parameter, msg) => {
 	return new Error(`Parameter ${parameter} error: ${msg}`);
 };
 
+const isDatetime = (date, formats = [ moment.ISO_8601 ]) => {
+	return moment(date, formats, true).isValid();
+};
+
+const sanitizeDate = (date) => {
+	let result = date;
+	if (isDate(result)) {
+		result = moment(result).toISOString();
+	}
+
+	return result;
+};
+
+const isUrl = (url) => {
+	const pattern = /^(^|\s)((http(s)?:\/\/)?[\w-]+(\.[\w-]+)+\.?(:\d+)?(\/\S*)?)$/;
+	return pattern.test(url);
+};
+
 module.exports = {
 	createRequest,
 	createSignature,
 	generateHeaders,
 	checkKit,
-	parameterError
+	parameterError,
+	isDatetime,
+	sanitizeDate,
+	isUrl
 };

package/.prettierignore.json

@@ -1 +0,0 @@
-{}

package/.prettierrc.json

@@ -1,8 +0,0 @@
-{
-	"tabWidth": 2,
-	"useTabs": true,
-	"semi": true,
-	"singleQuote": true,
-	"bracketSpacing": true,
-	"arrowParens": "always"
-}