hollaex-node-lib 2.19.2 → 2.19.4

package/README.md

@@ -92,10 +92,10 @@ client
 | `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 |
+| `mint (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 |
+| `updateMint (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 |
+| `burn (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 |
+| `updateBurn (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 |
@@ -127,6 +127,7 @@ client
 | `deleteExchangeStakesByAdmin` | <ul><li>**id**: ID of the stake pool to delete</li></ul> | Delete exchange stakes for admin |
 | `getExchangeStakersByAdmin` | <ul><li>**opts.id**: Unique identifier for the staker entry</li><li>**opts.user_id**: The ID of the user who has locked funds and staked</li><li>**opts.stake_id**: The ID of the stake pool</li><li>**opts.currency**: The currency in which the user staked</li><li>**opts.reward**: The amount the user has received as rewards</li><li>**opts.slashed**: The amount slashed</li><li>**opts.limit**: Number of elements to return. Default: 50. Maximum: 100</li><li>**opts.page**: Page of data to retrieve</li><li>**opts.order_by**: Field to order data</li><li>**opts.order**: Direction to order (asc/desc)</li><li>**opts.start_date**: Starting date of queried data in ISO8601 format</li><li>**opts.end_date**: Ending date of queried data in ISO8601 format</li><li>**opts.format**: Specify data format (csv/all)</li></ul> | Get exchange stakers of users for admin |
 | `getStakeAnalyticsByAdmin` | <ul><li>No parameters needed</li></ul> | Get staking and unstaking amounts |
+| `disableUserWithdrawalByAdmin` | <ul><li>**user_id**: The ID of the user to disable withdrawals for</li><li>**opts.expiry_date**: ISO date‑time string when the block expires</li></ul> | Block a user’s withdrawal ability |
 
 ### Websocket
 

package/kit.js

@@ -969,6 +969,7 @@ class HollaExKit {
 		}
 
 		if (isString(opts.format) && ['csv', 'all'].includes(opts.format)) {
+			path += '/csv';
 			params += `&format=${opts.format}`;
 		}
 
@@ -1090,6 +1091,7 @@ class HollaExKit {
 		}
 
 		if (isString(opts.format) && ['csv', 'all'].includes(opts.format)) {
+			path += '/csv';
 			params += `&format=${opts.format}`;
 		}
 
@@ -1181,7 +1183,7 @@ class HollaExKit {
 	 * @param {number} opts.fee - The fee to specify
 	 * @return {object} A JSON object with deposit info
 	 */
-	createExchangeDeposit(
+	mint(
 		userId,
 		currency,
 		amount,
@@ -1189,7 +1191,9 @@ class HollaExKit {
 			transactionId: null,
 			status: null,
 			email: null,
-			fee: null
+			fee: null,
+			address: null,
+			description: null
 		}
 	) {
 		const verb = 'POST';
@@ -1217,6 +1221,14 @@ class HollaExKit {
 			data.fee = opts.fee;
 		}
 
+		if (isString(opts.address)) {
+			data.address = opts.address;
+		}
+
+		if (isString(opts.description)) {
+			data.description = opts.description;
+		}
+
 		const headers = generateHeaders(
 			this.headers,
 			this.apiSecret,
@@ -1227,6 +1239,10 @@ class HollaExKit {
 		);
 		return createRequest(verb, `${this.apiUrl}${path}`, headers, { data });
 	}
+	// to support backward compatibility
+	createExchangeDeposit(...args) {
+		return this.mint(...args);
+	}
 
 	/**
 	 * Update exchange deposit by admin
@@ -1241,7 +1257,7 @@ class HollaExKit {
 	 * @param {boolean} opts.email - Email
 	 * @return {object} A JSON object with deposit info
 	 */
-	updateExchangeDeposit(
+	updateMint(
 		transactionId,
 		opts = {
 			updatedTransactionId: null,
@@ -1308,6 +1324,10 @@ class HollaExKit {
 		return createRequest(verb, `${this.apiUrl}${path}`, headers, { data });
 
 	}
+	// to support backward compatibility
+	updateExchangeDeposit(...args) {
+		return this.updateMint(...args);
+	}
 
 	/**
 	 * Create exchange withdrawal by admin
@@ -1320,7 +1340,7 @@ class HollaExKit {
 	 * @param {number} opts.fee - The fee to specify
 	 * @return {object} A JSON object with withdrawal info
 	 */
-	createExchangeWithdrawal(
+	burn(
 		userId,
 		currency,
 		amount,
@@ -1328,7 +1348,9 @@ class HollaExKit {
 			transactionId: null,
 			status: null,
 			email: null,
-			fee: null
+			fee: null,
+			address: null,
+			description: null
 		}
 	) {
 		const verb = 'POST';
@@ -1356,6 +1378,14 @@ class HollaExKit {
 			data.fee = opts.fee;
 		}
 
+		if (isString(opts.address)) {
+			data.address = opts.address;
+		}
+
+		if (isString(opts.description)) {
+			data.description = opts.description;
+		}
+
 		const headers = generateHeaders(
 			this.headers,
 			this.apiSecret,
@@ -1367,6 +1397,11 @@ class HollaExKit {
 		return createRequest(verb, `${this.apiUrl}${path}`, headers, { data });
 	}
 
+	// to support backward compatibility
+	createExchangeWithdrawal(...args) {
+		return this.burn(...args);
+	}
+
 	/**
 	 * Update Exchange Withdrawal
 	 * @param {string} transactionId - Withdrawals with specific transaction ID.
@@ -1380,7 +1415,7 @@ class HollaExKit {
 	 * @param {boolean} opts.email - Email
 	 * @return {object} A JSON object with withdrawal info
 	 */
-	updateExchangeWithdrawal(
+	updateBurn(
 		transactionId,
 		opts = {
 			updatedTransactionId: null,
@@ -1447,6 +1482,11 @@ class HollaExKit {
 		return createRequest(verb, `${this.apiUrl}${path}`, headers, { data });
 	}
 
+	// to support backward compatibility
+	updateExchangeWithdrawal(...args) {
+		return this.updateBurn(...args);
+	}
+
 	/**
 	 * Check exchange deposit status
 	 * @param {number} userId - The identifier of the user
@@ -1593,6 +1633,7 @@ class HollaExKit {
 		}
 
 		if (isString(opts.format) && ['csv', 'all'].includes(opts.format)) {
+			path += '/csv';
 			params += `&format=${opts.format}`;
 		}
 
@@ -1798,7 +1839,7 @@ class HollaExKit {
 		}
 
 		if (isString(opts.bank_key) && isString(opts.bank_value)) {
-			params += `&${opts.bank_key}=${opts.bank_value}`;
+			params += `&bank_key=${opts.bank_key}&bank_value=${opts.bank_value}`;
 		}
 		if (isBoolean(opts.activated)) {
 			params += `&activated=${opts.activated}`;
@@ -1828,6 +1869,7 @@ class HollaExKit {
 		}
 
 		if (isString(opts.format) && ['csv', 'all'].includes(opts.format)) {
+			path += '/csv';
 			params += `&format=${opts.format}`;
 		}
 		if (params.length > 1) path += params;
@@ -1862,7 +1904,7 @@ class HollaExKit {
 
 		if (isString(opts.referral)) {
 			data.referral = opts.referral;
-		};
+		}
 
 		const headers = generateHeaders(
 			this.headers,
@@ -2156,6 +2198,7 @@ class HollaExKit {
 		}
 
 		if (isString(opts.format) && ['csv', 'all'].includes(opts.format)) {
+			path += '/csv';
 			params += `&format=${opts.format}`;
 		}
 
@@ -2276,6 +2319,7 @@ class HollaExKit {
 		}
 
 		if (isString(opts.format) && ['csv', 'all'].includes(opts.format)) {
+			path += '/csv';
 			params += `&format=${opts.format}`;
 		}
 
@@ -2515,6 +2559,7 @@ class HollaExKit {
 		}
 
 		if (isString(opts.format) && ['csv', 'all'].includes(opts.format)) {
+			path += '/csv';
 			path += `&format=${opts.format}`;
 		}
 
@@ -2708,6 +2753,7 @@ class HollaExKit {
 		}
 
 		if (isString(opts.format)) {
+			path += '/csv';
 			params += `&format=${opts.format}`;
 		}
 
@@ -3049,6 +3095,7 @@ class HollaExKit {
 		}
 
 		if (isString(opts.format)) {
+			path += '/csv';
 			params += `&format=${opts.format}`;
 		}
 
@@ -3080,6 +3127,37 @@ class HollaExKit {
 		);
 		return createRequest(verb, `${this.apiUrl}${path}`, headers);
 	}
+
+	/**
+ 	* Block a user’s withdrawal ability
+ 	* @param {number} user_id – The ID of the user to disable withdrawals for
+ 	* @param {string|null} expiry_date – ISO date‑time string when the block expires
+ 	* @return {object} A JSON object { message: "Success" }
+ 	*/
+	disableUserWithdrawalByAdmin(user_id, opts = { expiry_date : null }
+	) {
+		const verb = 'POST';
+		const path = `${this.baseUrl}/admin/user/disable-withdrawal`;
+		const data = {
+			user_id
+		};
+
+		if (opts.expiry_date !== null && isDatetime(opts.expiry_date)) {
+			data.expiry_date = sanitizeDate(opts.expiry_date);
+		}
+
+		const headers = generateHeaders(
+			this.headers,
+			this.apiSecret,
+			verb,
+			path,
+			this.apiExpiresAfter,
+			data
+		);
+
+		return createRequest(verb, `${this.apiUrl}${path}`, headers, { data });
+	}
+
 	/**
 	 * Connect to hollaEx websocket and listen to an event
 	 * @param {array} events - The events to listen to
@@ -3098,7 +3176,7 @@ class HollaExKit {
 				apiExpires
 			);
 			url = `${url}?api-key=${this.apiKey
-				}&api-signature=${signature}&api-expires=${apiExpires}`;
+			}&api-signature=${signature}&api-expires=${apiExpires}`;
 		}
 
 		this.ws = new WebSocket(url);
@@ -3190,41 +3268,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 'usertrade':
-						case 'wallet':
-						case 'deposit':
-						case 'withdrawal':
-						case 'admin':
+						} else {
 							this.ws.send(
 								JSON.stringify({
 									op: 'subscribe',
@@ -3232,11 +3290,31 @@ 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 'usertrade':
+					case 'wallet':
+					case 'deposit':
+					case 'withdrawal':
+					case 'admin':
+						this.ws.send(
+							JSON.stringify({
+								op: 'subscribe',
+								args: [topic]
+							})
+						);
+						if (!this.initialConnection) {
+							this.wsEvents = union(this.wsEvents, [event]);
+						}
+						break;
+					default:
+						break;
 					}
 				}
 			});
@@ -3255,40 +3333,40 @@ 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 'withdrawal':
-						case 'admin':
+					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':
+					case 'withdrawal':
+					case 'admin':
+						this.ws.send(
+							JSON.stringify({
+								op: 'unsubscribe',
+								args: [topic]
+							})
+						);
+						this.wsEvents = this.wsEvents.filter((e) => e !== event);
+						break;
+					default:
+						break;
 					}
 				}
 			});

package/package.json

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