hollaex-node-lib 2.14.1 → 2.15.1

package/README.md

@@ -77,6 +77,38 @@ client
 | `cancelOrder` | <ul><li>**orderId**: HollaEx Network order ID</li></ul> | Cancel a specific order with its ID |
 | `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 |
 
+### Available admin functions:
+
+| Command | Parameters | Description |
+| - | - | - |
+| `getExchangeInfo` |  | Get admin exchange information
+| `getExchangeDeposits` | <ul><li>**opts.userId**: The identifier of the user to filter by</li><li>**opts.currency**: The currency to filter by, pass undefined to receive data on all currencies</li><li>**opts.limit**: Amount of deposits per page. Maximum: 50. Default: 50</li><li>**opts.page**: Page of deposit data. Default: 1</li><li>**opts.orderBy**: The field to order data by e.g. amount, id.</li><li>**opts.order**: Ascending (asc) or descending (desc).</li><li>**opts.startDate**: Start date of query in ISO8601 format.</li><li>**opts.endDate**: End date of query in ISO8601 format.</li><li>**opts.status**: Confirmed status of the deposits to get. Leave blank to get all confirmed and unconfirmed deposits</li><li>**opts.dismissed**: Dismissed status of the deposits to get. Leave blank to get all dismissed and undismissed </li>deposits<li>**opts.rejected**: Rejected status of the deposits to get. Leave blank to get all rejected and unrejected deposits</li><li>**opts.processing**: Processing status of the deposits to get. Leave blank to get all processing and unprocessing deposits </li><li>**opts.waiting**: Waiting status of the deposits to get. Leave blank to get all waiting and unwaiting deposits</li><li>**opts.transactionId**: Deposits with specific transaction ID.</li><li>**opts.address**: Deposits with specific address.</li><li>**opts.format**: Custom format of data set. Enum: ['all', 'csv']</li></ul> | Retrieve list of the user's deposits by admin |
+| `getExchangeWithdrawals` | <ul><li>**opts.userId**: The identifier of the user to filter by</li><li>**opts.currency**: The currency to filter by, pass undefined to receive data on all currencies</li><li>**opts.status**: Confirmed status of the withdrawals to get. Leave blank to get all confirmed and unconfirmed withdrawals</li><li>**opts.dismissed**: Dismissed status of the withdrawals to get. Leave blank to get all dismissed and undismissed withdrawals</li><li>**opts.rejected**: Rejected status of the withdrawals to get. Leave blank to get all rejected and unrejected withdrawals</li><li>**opts.processing**: Processing status of the withdrawals to get. Leave blank to get all processing and unprocessing withdrawals</li><li>**opts.waiting**: Waiting status of the withdrawals to get. Leave blank to get all waiting and unwaiting withdrawals</li><li>**opts.limit**: Amount of withdrawals per page. Maximum: 50. Default: 50</li><li>**opts.page**: Page of withdrawal data. Default: 1</li><li>**opts.orderBy**: The field to order data by e.g. amount, id.</li><li>**opts.order**: Ascending (asc) or descending (desc).</li><li>**opts.startDate**: Start date of query in ISO8601 format.</li><li>**opts.endDate**: End date of query in ISO8601 format.</li><li>**opts.transactionId**: Withdrawals with specific transaction ID.</li><li>**opts.address**: Withdrawals with specific address.</li><li>**opts.format**: Custom format of data set. Enum: ['all', 'csv']</li></ul> | Retrieve list of the user's withdrawals by admin |
+| `getExchangeBalance` | | Retrieve admin's wallet balance |
+| `transferExchangeAsset` | <ul><li>**senderId**: The identifier of the sender</li><li>**receiverId**: The identifier of the receiver</li><li>**currency**: The currency to specify</li><li>**amount**: The amount to specify</li><li>**opts.description**: The description field</li><li>**opts.email**: The email field</li></ul> | Transfer exchange asset by admin |
+| `createExchangeDeposit` | <ul><li>**userId**: The identifier of the user</li><li>**currency**: The currency to specify</li><li>**amount**: The amount to specify</li><li>**opts.transactionId**: deposit with specific transaction ID.</li><li>**opts.status**: The status field to confirm the deposit</li><li>**opts.email**: The email field</li><li>**opts.fee**: The fee to specify</li></ul> | Create exchange deposit by admin |
+| `updateExchangeDeposit` | <ul><li>**transactionId**: Deposits with specific transaction ID.</li><li>**opts.updatedTransactionId**: Deposits with updated transaction id</li><li>**opts.updatedAddress**: Deposits with updated address</li><li>**opts.status**: Confirmed status of the deposits to set. </li><li>**opts.dismissed**: Dismissed status of the deposits to set.</li><li>**opts.rejected**: Rejected status of the deposits to set. </li><li>**opts.processing**: Processing status of the deposits to set. </li><li>**opts.waiting**: Waiting status of the deposits to set.</li><li>**opts.email**: Email</li></ul> | Update exchange deposit by admin |
+| `createExchangeWithdrawal` | <ul><li>**userId**: The identifier of the user</li><li>**currency**: The currency to specify</li><li>**amount**: The amount to specify</li><li>**opts.transactionId**: Withdrawal with specific transaction ID.</li><li>**opts.status**: The status field to confirm the withdrawal</li><li>**opts.email**: The email field</li><li>**opts.fee**: The fee to specify</li></ul> | Create exchange withdrawal by admin |
+| `updateExchangeWithdrawal` | <ul><li>**transactionId**: Withdrawals with specific transaction ID.</li><li>**opts.updatedTransactionId**: Withdrawals with updated transaction id</li><li>**opts.updatedAddress**: Withdrawals with updated address</li><li>**opts.status**: Confirmed status of the withdrawals to set. </li><li>**opts.dismissed**: Dismissed status of the withdrawals to set.</li><li>**opts.rejected**: Rejected status of the withdrawals to set. </li><li>**opts.processing**: Processing status of the withdrawals to set.</li><li>**opts.waiting**: Waiting status of the withdrawals to set.</li><li>**opts.email**: Email</li></ul> | Update Exchange Withdrawal |
+| `checkExchangeDepositStatus` | <ul><li>**userId**: The identifier of the user</li><li>**currency**: The currency to filter by, pass undefined to receive data on all currencies</li><li>**transactionId**: Deposits with specific transaction ID.</li><li>**address**: Deposits with specific address.</li><li>**network**: The network info</li><li>**opts.isTestnet**: The info on whether it's a testnet or not</li></ul> | Check exchange deposit status |
+| `settleExchangeFees` | <ul><li>**opts.userId**: The identifier of the user</li></ul> | Set exchange fees by admin |
+| `getExchangeTrades` | <ul><li>**opts.userId**: The identifier of the user</li><li>**opts.side**: The order side (buy or side)</li><li>**opts.limit**: Amount of trades per page. Maximum: 50. Default: 50</li><li>**opts.page**: Page of trades data. Default: 1</li><li>**opts.symbol**: The symbol-pair to filter by, pass undefined to receive data on all currencies</li><li>**opts.orderBy**: The field to trade data by e.g. amount, id.</li><li>**opts.order**: Ascending (asc) or descending (desc).</li><li>**opts.startDate**: Start date of query in ISO8601 format.</li><li>**opts.endDate**: End date of query in ISO8601 format.</li><li>**opts.format**: Custom format of data set. Enum: ['all', 'csv']</li></ul> | Retrieve user's trades by admin |
+| `getExchangeOrders` | <ul><li>**opts.userId**: The identifier of the user</li><li>**opts.side**: The order side (buy or side)</li><li>**opts.status**: The order's status e.g open, filled, canceled etc</li><li>**opts.open**: The info on whether the order is active or not </li><li>**opts.side**: The order side (buy or side)</li><li>**opts.limit**: Amount of orders per page. Maximum: 50. Default: 50</li><li>**opts.page**: Page of order data. Default: 1</li><li>**opts.symbol**: The symbol-pair to filter by, pass undefined to receive data on all currencies</li><li>**opts.orderBy:** The field to order data by e.g. amount, id.</li><li>**opts.order:** Ascending (asc) or descending (desc).</li><li>**opts.startDate:** Start date of query in ISO8601 format.</li><li>**opts.endDate:** End date of query in ISO8601 format.</li></ul> | Retrieve user's orders by admin |
+| `cancelExchangeUserOrder` | <ul><li>**userId**: The identifier of the user</li><li>**orderId**: The identifier of the order</li></ul> | Cancel user's order by order id |
+| `getExchangeUsers` | <ul><li>**opts**: Optional parameters</li><li>**opts.userId**: The identifier of the user to filter by</li><li>**opts.search**: The search text to filter by, pass undefined to receive data on all fields</li><li>**opts.pending**: The pending field to filter by, pass undefined to receive all data</li><li>**opts.pendingType**: Th pending type info to filter by, pass undefined to receive data</li><li>**opts.limit**: Amount of users per page. Maximum: 50. Default: 50</li><li>**opts.page**: Page of user data. Default: 1</li><li>**opts.orderBy**: The field to order data by e.g. amount, id.</li><li>**opts.order**: Ascending (asc) or descending (desc).</li><li>**opts.startDate**: Start date of query in ISO8601 format.</li><li>**opts.endDate**: End date of query in ISO8601 format.</li><li>**opts.format**: Custom format of data set. Enum: ['all', 'csv']</li></ul> | Retrieve list of the user info by admin |
+| `createExchangeUser` | <ul><li>**email**: The mail address for the user</li<li>**password**: The password for the user</li></ul> | Create exchange user |
+| `updateExchangeUser` | <ul><li>**userId**: The identifier of the user to filter by</li><li>**opts.meta**: The field to update user meta info</li><li>**opts.overwrite**: the field to set overwrite option along with meta object</li><li>**opts.role**: The field to update user role ('admin', 'supervisor', 'support', 'kyc', 'communicator', 'user')</li><li>**opts.note**: The field to update user note </li><li>**opts.verification_level**: The field to set user's verification level</li></ul> | Update exchange user |
+| `createExchangeUserWallet` | <ul><li>**userId**: The identifier of the user</li><li>**crypto**: The coin for the wallet e.g btc, eth</li><li>**opts.network**: The network info </li></ul> | Create wallet for exchange user |
+| `getExchangeUserWallet` | <ul><li>**opts.userId**: The identifier of the user to filter by</li><li>**opts.limit**: Amount of users per page. Maximum: 50. Default: 50</li><li>**opts.currency**: The currency to filter by</li><li>**opts.page**: Page of user data. Default: 1</li><li>**opts.orderBy**: The field to order data by e.g. amount, id.</li><li>**opts.order**: Ascending (asc) or descending (desc).</li><li>**opts.startDate**: Start date of query in ISO8601 format.</li><li>**opts.endDate**: End date of query in ISO8601 format.</li><li>**opts.address**: Address of crypto</li><li>**opts.isValid**: Specify whether or not wallet is valid</li><li>**opts.network**: Crypto network of currency</li><li>**opts.format**: Custom format of data set. Enum: ['all', 'csv']</li></ul> | Retrieve users' wallets by admin |
+| `getExchangeUserBalance` | <ul><li>**userId**: The identifier of the user</li></ul> | Retrieve user's login info by admin |
+| `createExchangeUserBank` | <ul><li>**userId**: The identifier of the user</li><li>**bankAccount**: Array of objects with bank account info</li></ul> | Create bank account for user by admin |
+| `getExchangeUserLogins` | <ul><li>**opts.userId**: The identifier of the user</li><li>**opts.limit**: Amount of logins per page. Maximum: 50. Default: 50</li><li>**opts.page**: Page of referral data. Default: 1</li><li>**opts.orderBy**: The field to order data by e.g. amount, id.</li><li>**opts.order**: Ascending (asc) or descending (desc).</li><li>**opts.startDate**: Start date of query in ISO8601 format.</li><li>**opts.endDate**: End date of query in ISO8601 format.</li></ul> | Retrieve user's login info by admin |
+| `deactivateExchangeUser` | <ul><li>**userId**: The identifier of the user to deactivate their exchange account</li></ul> | Deactivate exchange user account by admin |
+| `deactivateExchangeUserOtp` | <ul><li>**userId**: The identifier of the user to deactivate their otp</li></ul> | Deactivate user otp by admin |
+| `getExchangeUserReferrals` | <ul><li>**userId**: The identifier of the user to filter by</li><li>**opts.limit**: Amount of referrals per page. Maximum: 50. Default: 50</li><li>**opts.page**: Page of referral data. Default: 1</li><li>**opts.orderBy**: The field to order data by e.g. amount, id.</li><li>**opts.order**: Ascending (asc) or descending (desc).</li><li>**opts.startDate**: Start date of query in ISO8601 format.</li><li>**opts.endDate**: End date of query in ISO8601 format.</li></ul> | Retrieve user's referrals info by admin |
+| `getExchangeUserReferrer` | <ul><li>**userId**: The identifier of the user to filter by</li></ul> | Retrieve user's referer info by admin |
+
+
 ### Websocket
 
 #### Functions
@@ -111,10 +143,15 @@ client.unsubscribe(['orderbook']);
 
 Here is the list of channels you can subscribe to:
 
-- `orderbook`
-- `trades`
+- `orderbook` (Available publicly)
+- `trade` (Available publicly)
 - `order` (Only available with authentication. Receive order updates)
+- `usertrade` (Only available with authentication. Receive user trades)
 - `wallet` (Only available with authentication. Receive balance updates)
+- `deposit` (Only available with authentication. Receive deposit notifications)
+- `withdrawal` (Only available with authentication. Receive withdrawal notifications)
+- `admin` (Only available with authentication for the exchange administrator. Receive exchange operations such as deposits and withdrawals of all users)
+
 
 For public channels (`orderbook`, `trade`), you can subscribe to specific symbols as follows:
 `orderbook:xht-usdt`, `trade:xht-usdt`. Not passing a symbol will subscribe to all symbols.
@@ -309,6 +346,41 @@ These are exapmles of data responses from the server.
 		"time": 1608022610
 	}
 	```
+- **deposit**: Updates related to the user's private information are as follows:
+
+	```json
+	{
+		"topic": "deposit",
+		"action": "insert",
+		"user_id": 1,
+		"data": {
+			"amount": 1,
+			"currency": "xht",
+			"status": "COMPLETED",
+			 "transaction_id": "123",
+			...
+		},
+		"time": 1608021684
+	}
+	```
+- **withdrawal**: Updates related to the user's private information are as follows:
+
+	```json
+	{
+		"topic": "withdrawal",
+		"action": "insert",
+		"user_id": 1,
+		"data": {
+			"amount": 1,
+			"currency": "xht",
+			"status": "COMPLETED",
+			 "transaction_id": "123",
+			...
+		},
+		"time": 1608021684
+	}
+	```
+
 ## Example
 
 You can run the example by going to example folder and running:

package/example/hollaex.js

@@ -1,27 +1,19 @@
 const HollaEx = require('../index');
 require('dotenv').load();
 
-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);
-// 	});
+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);
+	});
 
 // connect to websocket
 /*
@@ -30,7 +22,7 @@ const client = new HollaEx({ apiURL: 'https://api.sandbox.hollaex.com', apiKey:
 	symbols : xht-usdt
 */
 
-client.connect(['usertrade']);
+client.connect(['trade']);
 
 client.ws.on('message', (data) => {
 	data = JSON.parse(data);
@@ -38,11 +30,7 @@ client.ws.on('message', (data) => {
 });
 
 
-client.ws.on('error', (error) => {
-	console.log(error);
-});
-
 
-// setTimeout(() => {
-// 	client.disconnect();
-// }, 10000);
+setTimeout(() => {
+	client.disconnect();
+}, 10000);