Merge branch 'develop'

Author: ppbustamante

.gitignore

@@ -64,3 +64,5 @@ typings/
 
 # End of https://www.gitignore.io/api/node
 test.js
+
+.idea

README.md

@@ -60,7 +60,8 @@ example();
 ```
 ***Expected output***
 ```javascript
-//Any of the 3 ways to call the function should return an output like this
+//  Any of the 3 ways to call the function should return an output like this:
+
 response: {
     status: 'success',
     data: [
@@ -83,9 +84,7 @@ var client   = new Client({'apiKey': mykey, 'apiSecret': mysecret});
 client.getMarkets()
     .then((obj) => {
         const data = obj.data;
-        data.forEach((market) => {
-			console.log(data);
-		});
+        console.log(data);
     }).catch((err) => {
         console.error(err);
     })
@@ -106,8 +105,10 @@ client.getMarkets()
 
 **Obtain Book**
 ```javascript
-//receives a Js object. "market" and "side" are mandatory (ex: {"market": "XLMCLP","side":"sell"}).
-client.getBook(dictionary, (err, output) => {
+//  Receives a Js object. "market" and "side" are mandatory. 
+//  Example: {"market": "XLMCLP", "side": "sell"}
+
+client.getBook(object, (err, output) => {
    if(err){
    console.log('error');
    }
@@ -144,12 +145,15 @@ client.getBook(dictionary, (err, output) => {
       timestamp: '2020-02-21T04:32:26.686000'
     }
     ...    
-   	]
+    ]
 ```
+
 **Obtain ticker info**
 ```javascript
-//receives a Js object that contains the market. (ex: {"market":"XLMARS"})
-client.getTicker(market, (err, output) => {
+//  Receives a Js object that contains the market.
+//  Example: {"market": "XLMARS"}
+
+client.getTicker(object, (err, output) => {
    if(err){
    console.log('error');
    }
@@ -224,10 +228,16 @@ client.getAccount()
   ]
 }
 ```
+
 **Create an order**
 ```javascript
-//receives a Js object. "market","type","side" and "amount" are mandatory. (ex: {"amount": 1, "market": "XLMCLP", "price": 50.5, "type": "limit", "side": "sell"}).
-client.createOrder(order, (err, output) => {
+//  Receives a Js object. "market", "type", "side" and "amount" are mandatory.
+//  (Example: {"amount": 1, "market": "XLMCLP", "price": 50.5, "type": "limit", "side": "sell"}
+//  Note that "side" can be either "sell" or "buy", also "type" can be "limit", "stop-limit" or "market". 
+//  If you want to execute an "stop-limit" order you need to specify the "limit" amount.
+//  Example: {"amount": 1, "market": "XLMCLP", "price": 50.5, "type": "stop-limit", "limit": 50, "side": "sell"}
+
+client.createOrder(object, (err, output) => {
    if(err){
    console.log('error');
    }
@@ -258,8 +268,10 @@ response: {
 
 **Create multiple orders**
 ```javascript
-//receives object array that contains multiple orders. "market","type","side" and "amount" are mandatory. (ex: [{"amount": 1, "market": "XLMCLP", "price": 50.5, "type": "limit", "side": "sell"},{Order2},...]).
-client.createMultiOrders(orders, (err, output) => {
+//  Receives object array that contains multiple orders. "market", "type", "side" and "amount" are mandatory.
+//  Example: [{"amount": 1, "market": "XLMCLP", "price": 50.5, "type": "limit", "side": "sell"}, {Order2},...]
+
+client.createMultiOrders(object, (err, output) => {
    if(err){
    console.log('error');
    }
@@ -269,18 +281,20 @@ client.createMultiOrders(orders, (err, output) => {
 ***Expected output***
 ```javascript
 response: {
-	status: 'success',
-	data: {
-	created: [{Order1},{Order2},...],
-	not_created: [] 
+  status: 'success',
+  data: {
+  created: [{Order1},{Order2},...],
+  not_created: [] 
     }
   }
 ```
 
 **Obtain active orders**
 ```javascript
-//receives a Js object that contains the market (ex: {"market":"XLMCLP"})
-client.getActiveOrders(market, (err, output) => {
+//  Receives a Js object that contains the market
+//  Example: {"market":"XLMCLP"}
+
+client.getActiveOrders(object, (err, output) => {
    if(err){
    console.log('error');
    }
@@ -330,8 +344,10 @@ client.getActiveOrders(market, (err, output) => {
 
 **Cancel an order**
 ```javascript
-//receives object that contains the order's ID (ex: {"id":"O000004"}).
-client.cancelOrder(order, (err, output) => {
+//  Receives object that contains the order's ID.
+//  Example: {"id":"O000004"}
+
+client.cancelOrder(object, (err, output) => {
    if(err){
    console.log('error');
    }
@@ -358,10 +374,13 @@ response: {
     }
   }
 ```
+
 **Cancel multiple orders**
 ```javascript
-//receives object array that contains multiple order's IDs (ex: [{"id":"O000001"},{"id":"O000002"},...]).
-client.cancelMultiOrders(orders, (err, output) => {
+//  Receives object array that contains multiple order's IDs. 
+//  Example: [{"id":"O000001"},{"id":"O000002"},...]
+
+client.cancelMultiOrders(object, (err, output) => {
    if(err){
    console.log('error');
    }
@@ -372,18 +391,21 @@ client.cancelMultiOrders(orders, (err, output) => {
 ```javascript
 response: {
 status: 'success',
-data: { canceled: [{Order1},{Order2},...], not_canceled: [] } }
+data: { canceled: [{Order1},{Order2},...], not_canceled: [] }
+}
 ```
+
 **Make a transfer**
 ```javascript
-//receives a Js object. "currency", "address", and "amount" are mandatory. (ex: {"currency":'ETH',"address":'0xf2ec...',"amount":0.02}).
-client.transfer(transfer, (err, output) => {
+//  Receives a Js object. "currency", "address", and "amount" are mandatory.
+//  Example: {"currency": "ETH", "address": "0xf2ec...", "amount": 0.02}
+
+client.transfer(object, (err, output) => {
    if(err){
    console.log('error');
    }
    console.log(output);
 });
-
 ```
 ***Expected output***
 ```javascript
@@ -392,8 +414,10 @@ client.transfer(transfer, (err, output) => {
 
 **Obtain executed orders**
 ```javascript
-//receives a Js object that contains the market (ex: {"market":"XLMCLP"})
-client.getExecutedOrders(market, (err, output) => {
+//  Receives a Js object that contains the market.
+//  Example: {"market":"XLMCLP"}
+
+client.getExecutedOrders(object, (err, output) => {
    if(err){
    console.log('error');
    }
@@ -434,8 +458,10 @@ client.getExecutedOrders(market, (err, output) => {
 
 **Obtain order status**
 ```javascript
-//receives a Js object that contains the ID (ex: {"id":"O000005"})
-client.getOrderStatus(id, (err, output) => {
+//  Receives a Js object that contains the ID.
+//  Example: {"id":"O000005"}
+
+client.getOrderStatus(object, (err, output) => {
    if(err){
    console.log('error');
    }
@@ -474,7 +500,6 @@ client.getBalance((err, output) => {
     console.log(output);
 });
 ```
-
 ***Expected Output***
 ```javascript
 {
@@ -498,13 +523,16 @@ client.getBalance((err, output) => {
 
 ## Using socket
 
+Cryptomarket's API v2 integrates Socket.IO! You can now receive real-time events connecting to the sockets.
+
 ### Get socket instance
 
 ```javascript
 var { Client } = require('cryptomarket');
 var client = new Client({'apiKey': mykey, 'apiSecret': mysecret});
 
 var socket;
+
 client.socket.connect()
     .then((skt) => {
         socket = skt
@@ -514,7 +542,7 @@ client.socket.connect()
 
 //or
 
-var socket= await client.socket.connect();
+var socket = await client.socket.connect();
 ```
 
 ### Receive socket events
@@ -531,7 +559,8 @@ socket.unsubscribe('ETHCLP');
 
 **Receive open book info**
 ```javascript
-// Subscription required*
+// Subscription required.
+
 socket.on('open-book', (data) => {
     console.log('open-book', data);
 });
@@ -552,7 +581,8 @@ open-book {
 
 **Receive Historical book info**
 ```javascript
-// Subscription required*
+//  Subscription required.
+
 socket.on('historical-book', (data) => {
     console.log('historical-book', data);
 });
@@ -601,7 +631,8 @@ socket.on('historical-book', (data) => {
 
 **Receive candles info**
 ```javascript
-// Subscription required*
+// Subscription required.
+
 socket.on('candles', (data) => {
     console.log('candles', data);
 });
@@ -673,7 +704,7 @@ ticker {
 }
 ```
 
-**Receive balance info**
+**Receive Your Balance info**
 ```javascript
 socket.on('balance', (data) => {
     console.log('balance', data);
@@ -698,7 +729,7 @@ balance {
 ```
 
 
-**Receive user orders info**
+**Receive Your Orders info**
 ```javascript
 socket.on('open-orders', (data) => {
     console.log('open-orders', data);
@@ -727,13 +758,12 @@ open-orders [
 ]
 ```
 
-**Receive historical user orders info**
+**Receive Your Historical orders info**
 ```javascript
 socket.on('historical-orders', (data) => {
     console.log('historical-orders', data);
 });
 ```
-
 ***Expected Output***
 ```javascript
 historical-orders [
@@ -774,8 +804,7 @@ historical-orders [
   ]
 ```
 
-
-**Receive User´s operated volume**
+**Receive Your operated volume**
 ```javascript
 socket.on('operated', (data) => {
     console.log('operated', data);

lib/Socket.js

@@ -23,6 +23,7 @@ class Socket {
 		this.historicalBookData = {};
 		this.candlesData = {};
 		this.boardData = {};
+		this.transports = ['websocket', 'polling'];
 	}
 
 	_deepClone(data) {
@@ -45,6 +46,7 @@ class Socket {
 			reconnectionAttempts: 1,
 			reconnectionDelay: 1000,
 			reconnectionDelayMax: 15000,
+			transports: this.transports,
 		});
 	}
 
@@ -434,19 +436,26 @@ class Socket {
 		});
 	}
 
-	connect() {
+	connect(...transports) {
+		if (!_.isEmpty(transports)) {
+			this.transports = transports.filter(
+				(transport) => transport === 'polling' || transport === 'websocket',
+			);
+			if (_.isEmpty(this.transports)) {
+				return Promise.reject(new Error('Invalid transports'));
+			}
+		}
 		this.socketClient = socket(this.urlWorker, {
 			forceNew: false,
 			reconnectionAttempts: 1,
 			reconnectionDelay: 1000,
 			reconnectionDelayMax: 15000,
+			transports: this.transports,
 		});
 
 		this._setupGeneralEvents();
 		this._setupWorkerEvents();
 
-		// GENERAL METHODS
-		// ===============================================================================
 		return new Promise((resolve, reject) => {
 			// Fired upon a connection including a successful reconnection.
 			this.socketClient.on('connect', () => {

package-lock.json

@@ -1,6 +1,6 @@
 {
 	"name": "cryptomarket",
-	"version": "1.0.2",
+	"version": "1.0.3",
 	"description": "The CryptoMarket for Node.js",
 	"homepage": "https://www.cryptomkt.com",
 	"main": "./index.js",