add balance subscription

redo subscription logic

Author: Insmael

lib/websocket/accountClient.js

@@ -5,7 +5,21 @@ const { AuthClient } = require("./authClient")
  */
 class AccountClient extends AuthClient {
     constructor(apiKey, apiSecret) {
-        super("wss://api.exchange.cryptomkt.com/api/2/ws/account", apiKey, apiSecret)
+        super(
+            "wss://api.exchange.cryptomkt.com/api/2/ws/account", 
+            apiKey, 
+            apiSecret,
+            {
+                // transaction
+                "unsubscribeTransactions":"transaction",
+                "subscribeTransactions":"transaction",
+                "updateTransaction":"transaction",
+                // balance
+                "unsubscribeBalance":"balance", 
+                "subscribeBalance":"balance",
+                "balance":"balance",
+            },
+        )
     }
 
     /**
@@ -84,6 +98,30 @@ class AccountClient extends AuthClient {
         return this.sendUnsubscription('unsubscribeTransactions')
     }
 
+    /**
+     * Subscribe to a feed of the balances of the account
+     * 
+     * https://api.exchange.cryptomkt.com/#subscription-to-the-balance
+     * 
+     * @param {function} callback A function to call with the feed data. It takes one argument.
+     * @return {Promise<Boolean>} A Promise of the subscription result. True if success
+     */
+     subscribeToBalance(callback) {
+        this.checkDefined({callback})
+        return this.sendSubscription('subscribeBalance', callback)
+    }
+
+    /**
+     * unsubscribe to the balance feed.
+     * 
+     * https://api.exchange.cryptomkt.com/#subscription-to-the-balance
+     * 
+     * @return {Promise<Boolean>} A Promise of the unsubscription result. True if success
+     */
+    unsubscribeToBalance() {
+        return this.sendUnsubscription('unsubscribeBalance')
+    }
+
 }
 
 module.exports = {

lib/websocket/authClient.js

@@ -2,8 +2,8 @@ const CryptoJS = require('crypto-js')
 const { WSClientBase } = require("./clientBase")
 
 class AuthClient extends WSClientBase {
-    constructor(url, apiKey, apiSecret) {
-        super(url)
+    constructor(url, apiKey, apiSecret, subscriptionKeys={}) {
+        super(url, subscriptionKeys=subscriptionKeys)
         this.apiKey = apiKey
         this.apiSecret = apiSecret
     }

lib/websocket/clientBase.js

@@ -2,12 +2,11 @@ const WebSocket = require('ws');
 const { EventEmitter } = require('events');
 
 const { ArgumentFormatException, CryptomarketAPIException, CryptomarketSDKException } = require('../exceptions')
-const methods = require("./methods.json");
 
 class WSClientBase {
-    constructor(uri) {
-        this.uri = uri
-        this.methods = methods
+    constructor(uri, subscriptionKeys={}) {
+        this.uri = uri;
+        this.subscriptionKeys = subscriptionKeys;
         this.emitter = new EventEmitter();
         this.nextId = 1
     }
@@ -93,8 +92,8 @@ class WSClientBase {
     }
 
     handleNotification(notification) {
-        let key = this.buildKey()
-        this.emitter.emit(key, notification["params"])
+        let key = this.buildKey(notification.method)
+        this.emitter.emit(key, notification.params)
     }
 
     handleResponse(response) {
@@ -103,8 +102,9 @@ class WSClientBase {
         this.emitter.emit(id, response)
     }
 
-    buildKey() {
-        return "subscription"
+    buildKey(method, params) {
+        if (method in this.subscriptionKeys) this.subscriptionKeys[method];
+        return ""
     }
 }
 

lib/websocket/methods.json

@@ -1,15 +1,36 @@
 const {WSClientBase} = require('./clientBase')
 const { OrderbookCache } = require('./orderbook_cache')
-const methods = require("./methods.json")
 
 /**
  * PublicClient connects via websocket to cryptomarket to get market information of the exchange.
  */
 class PublicClient extends WSClientBase {
     constructor() {
-        super("wss://api.exchange.cryptomkt.com/api/2/ws/public")
+        super(
+            "wss://api.exchange.cryptomkt.com/api/2/ws/public",
+            {
+                // tickers
+                "subscribeTicker":"tickers",
+                "unsubscribeTicker":"tickers",
+                "ticker":"tickers",
+                // orderbook
+                "subscribeOrderbook":"orderbooks",
+                "unsubscribeOrderbook":"orderbooks",
+                "snapshotOrderbook":"orderbooks",
+                "updateOrderbook":"orderbooks",
+                // trades
+                "subscribeTrades":"trades",
+                "unsubscribeTrades":"trades",
+                "snapshotTrades":"trades",
+                "updateTrades":"trades",
+                // candles
+                "subscribeCandles":"candles",
+                "unsubscribeCandles":"candles",
+                "snapshotCandles":"candles",
+                "updateCandles":"candles",
+            }
+        )
         this.obCache = new OrderbookCache()
-        this.methods = methods
     }
 
     handleNotification(notification) {
@@ -34,19 +55,19 @@ class PublicClient extends WSClientBase {
     }
 
     isOrderbookFeed(method) {
-        return this.methods[method] === "orderbooks"
+        return this.subscriptionKeys[method] === "orderbooks"
     }
 
     isTradesFeed(method) {
-        return this.methods[method] === "trades"
+        return this.subscriptionKeys[method] === "trades"
     }
 
     isCandlesFeed(method) {
-        return this.methods[method] === "candles"
+        return this.subscriptionKeys[method] === "candles"
     }
 
     buildKey(method, params) {
-        let methodKey = this.methods[method]
+        let methodKey = this.subscriptionKeys[method]
         let symbol = ('symbol' in params) ? params['symbol'] : ''
         let period = ('period' in params) ? params['period'] : ''
         let key = methodKey + ':' + symbol + ':' + period

lib/websocket/publicClient.js

@@ -5,7 +5,18 @@ const { AuthClient } = require("./authClient")
  */
 class TradingClient extends AuthClient {
     constructor(apiKey, apiSecret) {
-        super("wss://api.exchange.cryptomkt.com/api/2/ws/trading", apiKey, apiSecret)
+        super(
+            "wss://api.exchange.cryptomkt.com/api/2/ws/trading", 
+            apiKey, 
+            apiSecret, 
+            {
+                // reports
+                "subscribeReports":"reports",
+                "unsubscribeReports":"reports",
+                "activeOrders":"reports",
+                "report":"reports",
+            }
+        )
     }
 
     /**