feat: converted candles

Author: Insmael

README.md

@@ -20,39 +20,39 @@ This sdk makes use of the [api version 3](https://api.exchange.cryptomkt.com) of
 
 ## rest client
 
-```javascript
+```typescript
 const { Client } = require("cryptomarket");
 
 // instance a client
-let apiKey = "AB32B3201";
-let apiSecret = "21b12401";
-let client = new Client(apiKey, apiSecret);
+const apiKey = "AB32B3201";
+const apiSecret = "21b12401";
+const client = new Client(apiKey, apiSecret);
 
 // get currencies
-let currencies = await client.getCurrencies();
+const currencies = await client.getCurrencies();
 
 // get order books
-let orderBook = await client.getOrderBook("EOSETH");
+const orderBook = await client.getOrderBook("EOSETH");
 
 // get your account balances
-let accountBalances = await client.getWalletBalances();
+const accountBalances = await client.getWalletBalances();
 
 // get your trading balances
-let tradingBalances = await client.getSpotTradingBalances();
+const tradingBalances = await client.getSpotTradingBalances();
 
 // move balance from wallet to spot trading
-let result = await client.transferBetweenWalletAndExchange({
+const result = await client.transferBetweenWalletAndExchange({
   currency: "EOS",
   amount: "3.2",
   source: Account.Wallet,
   destination: Account.Spot,
 });
 
 // get your active orders
-let orders = await client.getAllActiveSpotOrders("EOSETH");
+const activeOrders = await client.getAllActiveSpotOrders("EOSETH");
 
 // create a new order
-let newOrder = await client.createOrder({
+const newOrder = await client.createOrder({
   symbol: "EOSETH",
   side: "buy",
   quantity: "10",

lib/client.ts

@@ -37,6 +37,8 @@ import {
   Trade,
   Transaction,
 } from "./models";
+import { ConvertedCandlesBySymbol } from "./models/ConvertedCandle";
+import { ConvertedCandles } from "./models/ConvertedCandles";
 import { fromCamelCaseToSnakeCase, fromSnakeCaseToCamelCase } from "./paramStyleConverter"
 
 
@@ -394,9 +396,9 @@ export class Client {
   /**
    * Get candles for all symbols or for specified symbols
    *
-   * Candels are used for OHLC representation
+   * Candles are used for OHLC representation
    *
-   *  The result contains candles with non-zero volume only (no trades = no candles).
+   * The result contains candles with non-zero volume only (no trades = no candles).
    *
    * Requires no API key Access Rights.
    *
@@ -426,9 +428,9 @@ export class Client {
   /**
    * Get candles for a symbol
    *
-   * Candels are used for OHLC representation
+   * Candles are used for OHLC representation
    *
-   *  The result contains candles with non-zero volume only (no trades = no candles).
+   * The result contains candles with non-zero volume only (no trades = no candles).
    *
    * Requires no API key Access Rights.
    *
@@ -459,6 +461,79 @@ export class Client {
     return this.get(`public/candles/${symbol}`, params);
   }
 
+  /**
+   * Gets candles regarding the last price converted to the target currency for all symbols or for the specified symbols
+   *
+   * Candles are used for OHLC representation
+   *
+   * The result contains candles with non-zero volume only (no trades = no candles).
+   * 
+   * Conversion from the symbol quote currency to the target currency is the mean of "best" bid price and "best" ask price in the order book. If there is no "best" bid or ask price, the last price is returned.
+   *
+   * Requires no API key Access Rights.
+   *
+   * https://api.exchange.cryptomkt.com/#candles
+   *
+   * @param {object} [params]
+   * @param {string[]} [params.targetCurrency] Target currency for conversion
+   * @param {string[]} [params.symbols] Optional. A list of symbol ids
+   * @param {PERIOD} [params.period] Optional. A valid tick interval. 'M1' (one minute), 'M3', 'M5', 'M15', 'M30', 'H1' (one hour), 'H4', 'D1' (one day), 'D7', '1M' (one month). Default is 'M30'
+   * @param {SORT} [params.sort] Optional. Sort direction. 'ASC' or 'DESC'. Default is 'DESC'
+   * @param {string} [params.from] Optional. Initial value of the queried interval. As Datetime
+   * @param {string} [params.till] Optional. Last value of the queried interval. As Datetime
+   * @param {number} [params.limit] Optional. Candles per query. Defaul is 10. Min is 1. Max is 1000
+   *
+   * @return A class with the targetCurrency and data with a map with a list of candles for each symbol of the query. indexed by symbol.
+   */
+  getConvertedCandles(params?: {
+    targetCurrency: string;
+    symbols?: string[];
+    period?: PERIOD;
+    sort?: SORT;
+    from?: string;
+    till?: string;
+    limit?: number;
+  }): Promise<ConvertedCandles> {
+    return this.get("public/converted/candles", params);
+  }
+
+  /**
+   * Gets candles regarding the last price converted to the target currency for the specified symbol
+   *
+   * Candles are used for OHLC representation
+   *
+   * The result contains candles with non-zero volume only (no trades = no candles).
+   * 
+   * Conversion from the symbol quote currency to the target currency is the mean of "best" bid price and "best" ask price in the order book. If there is no "best" bid or ask price, the last price is returned.
+   *
+   * Requires no API key Access Rights.
+   *
+   * https://api.exchange.cryptomkt.com/#candles
+   *
+   * @param {string[]} symbol A symbol id
+   * @param {object} params
+   * @param {string[]} params.targetCurrency Target currency for conversion
+   * @param {PERIOD} [params.period] Optional. A valid tick interval. 'M1' (one minute), 'M3', 'M5', 'M15', 'M30', 'H1' (one hour), 'H4', 'D1' (one day), 'D7', '1M' (one month). Default is 'M30'
+   * @param {SORT} [params.sort] Optional. Sort direction. 'ASC' or 'DESC'. Default is 'DESC'
+   * @param {string} [params.from] Optional. Initial value of the queried interval. As Datetime
+   * @param {string} [params.till] Optional. Last value of the queried interval. As Datetime
+   * @param {number} [params.limit] Optional. Candles per query. Defaul is 10. Min is 1. Max is 1000
+   *
+   * @return An object with the targetCurrency and data with a list of candles for the symbol of the query.
+   */
+  getConvertedCandlesBySymbol(
+    symbol: string,
+    params?: {
+      targetCurrency: string;
+      period?: PERIOD;
+      sort?: SORT;
+      from?: string;
+      till?: string;
+      limit?: number;
+    }): Promise<ConvertedCandlesBySymbol> {
+    return this.get(`public/converted/candles/${symbol}`, params);
+  }
+
   /////////////////////////
   // AUTHENTICATED CALLS //
   /////////////////////////

lib/models/ConvertedCandle.ts

@@ -0,0 +1,6 @@
+import { Candle } from "./Candle";
+
+export interface ConvertedCandlesBySymbol {
+  targetCurrency: string;
+  data: Candle[];
+}

lib/models/ConvertedCandles.ts

@@ -0,0 +1,6 @@
+import { Candle } from "./Candle";
+
+export interface ConvertedCandles {
+  targetCurrency: string;
+  data: { [key: string]: Candle[] };
+}

lib/paramStyleConverter.ts

@@ -39,13 +39,12 @@ const convertObjectKeysToCamelCase = (obj: { [x: string]: any }): { [x: string]:
 }
 
 
-const camelCaseToSnakeCase = (camelCase: string) => {
-  return camelCase.replace(/([A-Z])/g, letter => `_${letter.toLowerCase()}`);
-}
+const camelCaseToSnakeCase = (camelCase: string) => camelCase
+  .replace(/([A-Z])/g, letter => `_${letter.toLowerCase()}`)
+
 
-const snakeCaseToCamelCase = (value: string) =>
-  value.replace(/([_][a-z])/g, _letter => _letter.replace('_', '').toUpperCase()
-  );
+const snakeCaseToCamelCase = (value: string) => value
+  .replace(/([_][a-z])/g, _letter => _letter.replace('_', '').toUpperCase());
 
 const isObject = (value: any) => {
   return typeof (value) == "object";

lib/websocket/clientBase.ts

@@ -109,6 +109,7 @@ export class WSClientBase {
     this.ws.send(JSON.stringify(payload));
     return withTimeout(this.requestTimeoutMs, promise);
   }
+  
   protected requestList({ method, params: paramsRaw = {}, responseCount = 1 }: { method: any; params?: {}; responseCount?: number; }): Promise<unknown> {
     const params = fromCamelCaseToSnakeCase(paramsRaw)
     const { id, promise } = this.multiResponsePromiseFactory.newMultiResponsePromise(responseCount);

lib/websocket/marketDataClient.ts

@@ -74,7 +74,7 @@ export class MarketDataClient extends WSClientBase {
     const promise = new Promise(function (resolve, reject) {
       emitter.once(ID.toString(), function (response) {
         if ("error" in response) {
-          reject(new CryptomarketAPIException(response));
+          reject(new CryptomarketAPIException(response.error));
           return;
         }
         resolve(response.result);
@@ -159,7 +159,7 @@ export class MarketDataClient extends WSClientBase {
   /**
    * subscribe to a feed of candles
    *
-   * subscription is for all symbols or for the specified symbols
+   * subscription is for the specified symbols
    *
    * normal subscriptions have one update message per symbol
    *
@@ -171,9 +171,9 @@ export class MarketDataClient extends WSClientBase {
    * https://api.exchange.cryptomkt.com/#subscribe-to-candles
    *
    * @param {function} callback a function that recieves notifications as a dict of candles indexed by symbol, and the type of notification (either SNAPSHOT or UPDATE)
-   * @param {PERIOD} [params.period] Optional. A valid tick interval. 'M1' (one minute), 'M3', 'M5', 'M15', 'M30', 'H1' (one hour), 'H4', 'D1' (one day), 'D7', '1M' (one month). Default is 'M30'
-   * @param {string[]} [params.symbols] Optional. A list of symbol ids
-   * @param {number} params.limit Number of historical entries returned in the first feed. Min is 0. Max is 1000. Default is 0
+   * @param {PERIOD} params.period A valid tick interval. 'M1' (one minute), 'M3', 'M5', 'M15', 'M30', 'H1' (one hour), 'H4', 'D1' (one day), 'D7', '1M' (one month). 
+   * @param {string[]} params.symbols A list of symbol ids
+   * @param {number} [params.limit] Optional. Number of historical entries returned in the first feed. Min is 0. Max is 1000. Default is 0
    * @return A promise that resolves when subscribed with a list of the successfully subscribed symbols
    */
   subscribeToCandles({
@@ -193,6 +193,41 @@ export class MarketDataClient extends WSClientBase {
     });
   }
 
+  /**
+   * subscribes to a feed of candles regarding the last price converted to the target currency * for the specified symbols
+   *
+   * subscription is only for the specified symbols
+   *
+   * normal subscriptions have one update message per symbol
+   *
+   * Requires no API key Access Rights
+   *
+   * https://api.exchange.cryptomkt.com/#subscribe-to-converted-candles
+   *
+   * @param {function} callback a function that recieves notifications as a dict of candles indexed by symbol, and the type of notification (either SNAPSHOT or UPDATE)
+   * @param {function} params.targetCurrency Target currency for conversion
+   * @param {PERIOD} params.period A valid tick interval. 'M1' (one minute), 'M3', 'M5', 'M15', 'M30', 'H1' (one hour), 'H4', 'D1' (one day), 'D7', '1M' (one month). Default is 'M30'
+   * @param {string[]} params.symbols A list of symbol ids
+   * @param {number} [params.limit] Optional. Number of historical entries returned in the first feed. Min is 0. Max is 1000. Default is 0
+   * @return A promise that resolves when subscribed with a list of the successfully subscribed symbols
+   */
+  subscribeToConvertedCandles({
+    callback,
+    params: { period, ...params },
+  }: {
+    callback: (
+      notification: { [x: string]: WSCandle[] },
+      type: NOTIFICATION_TYPE
+    ) => any;
+    params: { targetCurrency: string, period: PERIOD; symbols: string[]; limit?: number };
+  }): Promise<string[]> {
+    return this.makeSubscription({
+      channel: `converted/candles/${period}`,
+      callback: parseMapListInterceptor(callback, parseWSCandle),
+      params,
+    });
+  }
+
   /**
    * subscribe to a feed of mini tickers
    *

test/rest/marketData.test.ts

@@ -251,4 +251,42 @@ describe("Rest client test", () => {
       assert(goodList(goodCandle, candles), "not good candles");
     });
   });
+  describe("Get Converted candles", () => {
+    it("for all symbols", async function () {
+      this.timeout(0);
+      let candles = await client.getConvertedCandles({ targetCurrency: "ETH" });
+      assert(!emptyDict(candles), "empty list of candles");
+      assert(
+        goodDict((candleList) => goodList(goodCandle, candleList), candles.data),
+        "not good candles"
+      );
+    });
+    it("for 2 symbols", async function () {
+      this.timeout(0);
+      let candles = await client.getConvertedCandles({
+        targetCurrency: "ETH",
+        symbols: ["EOSETH", "PAXGBTC"],
+        period: PERIOD._1_HOUR,
+        limit: 2,
+      });
+      assert(dictSize(candles, 2), "wrong number of symbols");
+      assert(
+        goodDict((candleList) => goodList(goodCandle, candleList), candles.data),
+        "not good candles"
+      );
+    });
+  });
+  describe("Get converted candles Of Symbol", () => {
+    it("with period and limit", async function () {
+      this.timeout(0);
+      let candles = await client.getConvertedCandlesBySymbol("ADAETH", {
+        targetCurrency: "BTC",
+        period: PERIOD._30_MINUTES,
+        limit: 2,
+      });
+      assert(listSize(candles.data, 2), "wrong number of candles");
+      assert(goodList(goodCandle, candles.data), "not good candles");
+    });
+  });
 });
+

test/rest/walletManagement.test.ts

@@ -154,9 +154,12 @@ describe("wallet management", () => {
     it("cro belongs", async function () {
       this.timeout(0);
       let croAddress = await client.getDepositCryptoAddress("CRO");
+      console.log(croAddress)
       let result = await client.checkIfCryptoAddressBelongsToCurrentAccount(
         croAddress.address
       );
+
+      console.log(result)
       assert(result === true, "does not belong");
     });
     it.skip("eos belongs", async function () {

test/websocket/marketData.test.ts

@@ -39,7 +39,6 @@ describe("websocket market data client", function () {
 
   describe("subscribe to candles", function () {
     it("gets a feed of candles", async function () {
-      // TODO: unknown state
       this.timeout(0);
       await wsclient.connect();
       await wsclient.subscribeToCandles({
@@ -54,6 +53,24 @@ describe("websocket market data client", function () {
     });
   });
 
+
+  describe.only("subscribe to converted candles", function () {
+    it("gets a feed of candles", async function () {
+      this.timeout(0);
+      await wsclient.connect();
+      await wsclient.subscribeToConvertedCandles({
+        callback: checkGoodMapListValues(goodWSCandle),
+        params: {
+          period: PERIOD._1_MINUTE,
+          targetCurrency: "BTC",
+          symbols: ["EOSETH", "ETHBTC"],
+          limit: 3,
+        },
+      });
+      await timeout(3 * SECOND);
+    });
+  });
+
   describe("subscribe to mini ticker", function () {
     it("gets a feed of mini tickers (with are candles)", async function () {
       this.timeout(0);