hollaex-node-lib 2.12.0 → 2.14.1

package/README.md

@@ -69,13 +69,13 @@ client
 | `getBalance` | | User's wallet balance |
 | `getDeposits` | <ul><li>**opts**: Object with additional params</li><li>**opts.currency**: (_optional_) Filter data set by asset</li><li>**opts.status**: (_optional_) Filter data set `status`</li><li>**opts.dismissed**: (_optional_) Filter data set `dismissed`</li><li>**opts.rejected**: (_optional_) Filter data set `rejected`</li><li>**opts.processing**: (_optional_) Filter data set `processing`</li><li>**opts.waiting**: (_optional_) Filter data set `waiting`</li><li>**opts.limit**: (_optional_, _default_=`50`, _max_=`50`) Number of items to get</li><li>**opts.page**: (_optional_, _default_=`1`) Page number of data</li><li>**opts.orderBy**: (_optional_) Field to order data by</li><li>**opts.order**: (_optional_, _enum_=[`asc`, `desc`]) Specify ascending or descending order</li><li>**opts.startDate**: (_optional_, _format_=`ISO8601`) Start date of data set</li><li>**opts.endDate**: (_optional_,  _format_=`ISO8601`) End date of data set</li><li>**opts.transactionId**: (_optional_) Filter data set by TXID</li><li>**opts.address**: (_optional_) Filter data set by address</li></ul> | User's list of all deposits |
 | `getWithdrawals` | <ul><li>**opts**: Object with additional params</li><li>**opts.currency**: (_optional_) Filter data set by asset</li><li>**opts.status**: (_optional_) Filter data set `status`</li><li>**opts.dismissed**: (_optional_) Filter data set `dismissed`</li><li>**opts.rejected**: (_optional_) Filter data set `rejected`</li><li>**opts.processing**: (_optional_) Filter data set `processing`</li><li>**opts.waiting**: (_optional_) Filter data set `waiting`</li><li>**opts.limit**: (_optional_, _default_=`50`, _max_=`50`) Number of items to get</li><li>**opts.page**: (_optional_, _default_=`1`) Page number of data</li><li>**opts.orderBy**: (_optional_) Field to order data by</li><li>**opts.order**: (_optional_, _enum_=[`asc`, `desc`]) Specify ascending or descending order</li><li>**opts.startDate**: (_optional_, _format_=`ISO8601`) Start date of data set</li><li>**opts.endDate**: (_optional_,  _format_=`ISO8601`) End date of data set</li><li>**opts.transactionId**: (_optional_) Filter data set by TXID</li><li>**opts.address**: (_optional_) Filter data set by address</li></ul> | User's list of all withdrawals |
-| `requestWithdrawal` | <ul><li>**currency**: Currency code e.g. `xht`</li><li>**amount**: Withdrawal amount</li><li>**address**: Address to withdrawal to</li><li>**opts**: Object with additional params</li><li>**opts.network**: (_required if asset has multiple networks_) Blockchain network to create address for e.g. `trx`</li><li>**opts.otpCode**: (_required if user has otp enabled_) User otp code</li></ul> | Create a new withdrawal request |
+| `makeWithdrawal` | <ul><li>**currency**: Currency code e.g. `xht`</li><li>**amount**: Withdrawal amount</li><li>**address**: Address to withdrawal to</li><li>**opts**: Object with additional params</li><li>**opts.network**: (_required if asset has multiple networks_) Blockchain network to create address for e.g. `trx`</li></ul> | Create a new withdrawal request |
 | `getUserTrades` | <ul><li>**opts**: Object with additional params</li><li>**opts.symbol**: (_optional_) HollaEx trading symbol e.g. `xht-usdt`</li><li>**opts.limit**: (_optional_, _default_=`50`, _max_=`50`) Number of items to get</li><li>**opts.page**: (_optional_, _default_=`1`) Page number of data</li><li>**opts.orderBy**: (_optional_) Field to order data by</li><li>**opts.order**: (_optional_, _enum_=[`asc`, `desc`]) Specify ascending or descending order</li><li>**opts.startDate**: (_optional_, _format_=`ISO8601`) Start date of data set</li><li>**opts.endDate**: (_optional_,  _format_=`ISO8601`) End date of data set</li></ul> | User's list of all trades |
 | `getOrder` | <ul><li>**orderId**: HollaEx Network Order ID</li></ul> | Get specific information about a certain order |
 | `getOrders` | <ul><li>**opts**: Object with additional params</li><li>**opts.symbol**: (_optional_) HollaEx trading symbol e.g. `xht-usdt`</li><li>**opts.side**: (_optional_, _enum_=[`buy`, `sell`]) Order side</li><li>**opts.status**: (_optional_) Filter data set `status`</li><li>**opts.limit**: (_optional_, _default_=`50`, _max_=`50`) Number of items to get</li><li>**opts.page**: (_optional_, _default_=`1`) Page number of data</li><li>**opts.orderBy**: (_optional_) Field to order data by</li><li>**opts.order**: (_optional_, _enum_=[`asc`, `desc`])</li><li>**opts.startDate**: (_optional_, _format_=`ISO8601`) Start date of data set</li><li>**opts.endDate**: (_optional_,  _format_=`ISO8601`) End date of data set</li></ul> | Get the list of all user orders. It can be filter by passing the symbol |
 | `createOrder` | <ul><li>**symbol**: HollaEx trading symbol e.g. `xht-usdt`</li><li>**side** (_enum_=[`buy`, `sell`]): Order side</li><li>**size**: Size of order to place</li><li>**type**: (_enum_=[`market`, `limit`] Order type</li><li>**price**: (_required if limit order type_) Order price</li><li>**opts**: Object with additional params</li><li>**opts.stop**: (_optional_) Stop price for order</li><li>**opts.meta**: (_optional_) Object with additional meta configurations</li><li>**opts.meta.post_only**: (_optional_, _default_=`false`) Make post only order </li><li>**opts.meta.note**: (_optional_) Custom note for order</li></ul> | Create a new order |
 | `cancelOrder` | <ul><li>**orderId**: HollaEx Network order ID</li></ul> | Cancel a specific order with its ID |
-| `cancelAllOrders` | <ul><li>**opts**: Object with additional params</li><li>**opts.symbol**: (_optional_) HollaEx trading symbol e.g. `xht-usdt`</li></ul> | Cancel all open order. It can be filter by passing the symbol |
+| `cancelAllOrders` | <ul><li>**symbol**: HollaEx trading symbol e.g. `xht-usdt`</li></ul> | Cancel all the active orders of a user, filtered by currency pair symbol |
 
 ### Websocket
 

package/example/hollaex.js

@@ -1,19 +1,27 @@
 const HollaEx = require('../index');
 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 });
-
-client
-	.getTicker('xht-usdt')
-	.then((data) => {
-		console.log(data);
-		console.log('The volume is', data.volume);
-	})
-	.catch((err) => {
-		console.log(err);
-	});
+const API_KEY = process.env.API_KEY || 'b28d81e806535350d83b48e952d0e2ed8ffcc6ef';
+const API_SECRET = process.env.API_SECRET || '73879b785c50e235a0e2e972a899eba56968bc42c956f68e87';
+const client = new HollaEx({ apiURL: 'https://api.sandbox.hollaex.com', apiKey: API_KEY, apiSecret: API_SECRET });
+
+// client
+// 	.createOrder(
+// 		'xht-usdt',
+// 		'buy',
+// 		0.1,
+// 		'market',
+// 		// 0
+// 	)
+// 	.then(async (data) => {
+// 		console.log(data);
+// 		// console.log('The volume is', data.volume);
+// 		// const withdrawal = await client.makeWithdrawal('xht', 1, '0x97e13fccfe2edab7e8077d0f2ac69fe984cfe7f7', { network: 'eth' });
+// 		// console.log(withdrawal);
+// 	})
+// 	.catch((err) => {
+// 		console.log(err);
+// 	});
 
 // connect to websocket
 /*
@@ -22,7 +30,7 @@ client
 	symbols : xht-usdt
 */
 
-client.connect(['orderbook']);
+client.connect(['usertrade']);
 
 client.ws.on('message', (data) => {
 	data = JSON.parse(data);
@@ -30,7 +38,11 @@ client.ws.on('message', (data) => {
 });
 
 
+client.ws.on('error', (error) => {
+	console.log(error);
+});
+
 
-setTimeout(() => {
-	client.disconnect();
-}, 10000);
+// setTimeout(() => {
+// 	client.disconnect();
+// }, 10000);

package/kit.js

@@ -380,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;
 		}
@@ -656,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,
@@ -676,6 +668,7 @@ class HollaExKit {
 			path,
 			this.apiExpiresAfter
 		);
+
 		return createRequest(verb, `${this.apiUrl}${path}`, headers);
 	}
 
@@ -820,6 +813,7 @@ class HollaExKit {
 						}
 						break;
 					case 'order':
+					case 'usertrade':
 					case 'wallet':
 					case 'deposit':
 						this.ws.send(

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "hollaex-node-lib",
-	"version": "2.12.0",
+	"version": "2.14.1",
 	"description": "hollaex api and websocket library for nodejs",
 	"main": "index.js",
 	"dependencies": {
@@ -36,8 +36,7 @@
 	},
 	"repository": {
 		"type": "git",
-		"url": "https://github.com/bitholla/hollaex-node-lib"
+		"url": "https://github.com/hollaex/hollaex-node-lib"
 	},
-	"author": "bitHolla Inc",
 	"license": "MIT"
 }