Merge pull request #20 from bitholla/develop

Develop

Author: abeikverdi

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 bitHolla
+Copyright (c) 2020 bitHolla
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -10,10 +10,15 @@ const HollaEx = require('hollaex-node-lib');
 var client = new HollaEx();
 ```
 
-You can pass your `apiKey` and `apiSecret` generated from the site as follows:
+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.
 
 ```node
-var client = new HollaEx({ apiKey: <MY_API_KEY>, apiSecret: <MY_API_SECRET> });
+var client = new HollaEx({
+	apiURL: <EXCHANGE_API_URL>,
+	baseURL: <EXCHANGE_BASE_URL>,
+	apiKey: <MY_API_KEY>,
+	apiSecret: <MY_API_SECRET>
+});
 ```
 
 You can also pass the field `apiExpiresAfter` which is the length of time in seconds each request is valid for. The default value is `60`.
@@ -25,7 +30,13 @@ There is a list of functions you can call which will be added later and they are
 ### Example:
 
 ```node
-var client = new HollaEx({ apiKey: <MY_API_KEY>, apiSecret: <MY_API_SECRET> });
+var client = new HollaEx({
+	apiURL: <EXCHANGE_API_URL>,
+	baseURL: <EXCHANGE_BASE_URL>,
+	apiKey: <MY_API_KEY>,
+	apiSecret: <MY_API_SECRET>
+});
+
 client
 	.getTicker('xht-usdt')
 	.then((res) => {
@@ -59,23 +70,56 @@ client
 
 ### Websocket
 
+#### Connecting
+
 You can connect and subscribe to different websocket channels for realtime updates.
 
+To connect, use the `connect` function with the channel you want to subscribe to as the parameter.
+
 ```node
 const socket = client.connect('orderbook');
-socket.on('orderbook', (data) => {
+```
+
+To disconnect the websocket, call `disconnect` on the socket connection.
+
+```node
+socket.disconnect();
+```
+
+#### Channels
+
+Here is the list of channels you can subscribe to:
+
+- `orderbook`
+- `trades`
+- `user` (Private updates for the user such as balance, user orders etc as explained below)
+- `all` (Subscribes to all events)
+
+For public channels (`orderbook`, `trades`), you can subscribe to specific symbols as follows:
+`orderbook:xht-usdt`, `trades:xht-usdt`.
+
+#### Events
+
+After connecting to the websocket, you can listen for events coming from the server by using the `on` function.
+
+```node
+socket.on(<EVENT>, (data) => {
 	console.log(data);
 });
 ```
 
-You can only subscribe to specific symbols as follows:
-`orderbook:xht-usdt`
-Here is the list of events you can subscribe:
+Public channels (`orderbook`, `trades`) emit events named after the respective channel. For example, the `orderbook` channel emits the event `orderbook`.
+
+The private channel `user` emits the events `userInfo`, `userOrder`, `userTrade`, `userWallet`, and `userUpdate`.
+
+Each channel also emits a `disconnect`, `reconnect`, `error`, `connect_error`, and `connect_timeout` event.
+- `disconnect` is emitted once when the websocket connection is disconnected from the server.
+- `reconnect` is emitted once when the server connection is reconnected.
+- `error` is emitted when there is an error thrown by the socket connection.
+- `connect_error` is emitted when there is an error while the socket connects.
+- `connect_timeout` is emitted when the socket connection times out.
 
-- orderbook
-- trades
-- user (Private updates for the user such as balance, user orders etc as explained below)
-- all (It subscribes to all events)
+##### Private Events
 
 When you subscribe to private updates on user you should listen for the events as follows:
 

index.js

@@ -351,8 +351,14 @@ class Socket extends EventEmitter {
 					this.ioLink[this.ioLink.length - 1].on('error', (error) => {
 						this.emit('error', error);
 					});
+					this.ioLink[this.ioLink.length - 1].on('connect_error', (data) => {
+						this.emit('connect_error', `Socket Connection Error: ${data}.`);
+					});
+					this.ioLink[this.ioLink.length - 1].on('connect_timeout', (data) => {
+						this.emit('connect_timeout', `Socket Connection Timeout : ${data}.`);
+					});
 					this.ioLink[this.ioLink.length - 1].once('disconnect', (data) => {
-						this.emit('disconnect', `Soscket.io disconnected from server due to: ${data}.`);
+						this.emit('disconnect', `Socket Disconnect: ${data}.`);
 						this.subs = this._events;
 						this.removeAllListeners();
 					});
@@ -380,16 +386,22 @@ class Socket extends EventEmitter {
 						this.emit('userOrder', data);
 					});
 					this.ioLink[this.ioLink.length - 1].on('trades', (data) => {
-						this.emit('userTrades', data);
+						this.emit('userTrade', data);
 					});
 					this.ioLink[this.ioLink.length - 1].on('update', (data) => {
 						this.emit('userUpdate', data);
 					});
 					this.ioLink[this.ioLink.length - 1].on('error', (error) => {
 						this.emit('error', error);
 					});
+					this.ioLink[this.ioLink.length - 1].on('connect_error', (data) => {
+						this.emit('connect_error', `Socket Connection Error: ${data}.`);
+					});
+					this.ioLink[this.ioLink.length - 1].on('connect_timeout', (data) => {
+						this.emit('connect_timeout', `Socket Connection Timeout : ${data}.`);
+					});
 					this.ioLink[this.ioLink.length - 1].once('disconnect', (data) => {
-						this.emit('disconnect', `Socket.io disconnected from server due to: ${data}.`);
+						this.emit('disconnect', `Socket Disconnect: ${data}.`);
 						this.subs = this._events;
 						this.removeAllListeners();
 					});
@@ -433,8 +445,14 @@ class Socket extends EventEmitter {
 					this.ioLink[this.ioLink.length - 1].on('error', (error) => {
 						this.emit('error', error);
 					});
+					this.ioLink[this.ioLink.length - 1].on('connect_error', (data) => {
+						this.emit('connect_error', `Socket Connection Error: ${data}.`);
+					});
+					this.ioLink[this.ioLink.length - 1].on('connect_timeout', (data) => {
+						this.emit('connect_timeout', `Socket Connection Timeout : ${data}.`);
+					});
 					this.ioLink[this.ioLink.length - 1].once('disconnect', (data) => {
-						this.emit('disconnect', `Socket.io disconnected from server due to: ${data}.`);
+						this.emit('disconnect', `Socket Disconnect: ${data}.`);
 						this.subs = this._events;
 						this.removeAllListeners();
 					});

package.json

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