refactor: websocket method links, fix: rest order list link

Author: Insmael

lib/client.ts

@@ -593,7 +593,7 @@ export class Client {
    * - For an OTOCO order list, the secondary orders have the same restrictions as an OCO order
    * - Default is ORDER_TYPE.Limit
    *
-   * https://api.exchange.cryptomkt.com/#create-new-spot-order-list-2
+   * https://api.exchange.cryptomkt.com/#create-new-spot-order-list
    *
    * @param {string} params.order_list_id Order list identifier. If omitted, it will be generated by the system upon order list creation. Must be equal to client_order_id of the first order in the request.
    * @param {string} params.contingency_type Order list type.

lib/websocket/marketDataClient.ts

@@ -548,7 +548,7 @@ export class MarketDataClient extends WSClientBase {
    * 
    * batch subscriptions have a joined update for all currencies
    * 
-   * https://api.exchange.cryptomkt.com/#subscribe-to-price-rates
+   * https://api.exchange.cryptomkt.com/#subscribe-to-price-rates-in-batches
    * 
    * @param {function} callback recieves a feed of price rates as a map of them, indexed by currency id, and the type of notification, only DATA
    * @param {PRICE_RATE_SPEED} speed The speed of the feed. '1s' or '3s'

lib/websocket/tradingClient.ts

@@ -218,32 +218,32 @@ export class TradingClient extends AuthClient {
    * @param {string} params.currency The currency code to query the balance
    * @return A promise that resolves with the spot trading balance of a currency
    */
-  async getSpotTradingBalanceOfCurrency(params: {
+  async getSpotTradingBalance(params: {
     currency: string;
   }): Promise<Balance> {
     return this.makeRequest<Balance>({ method: "spot_balance", params });
   }
 
   /**
-   * Get the personal trading commission rates for all symbols
+   * Get the personal trading fee rates for all symbols
    *
    * https://api.exchange.cryptomkt.com/#get-spot-fees
    *
    * @return A promise that resolves with a list of commission rates
    */
-  async getSpotCommissions(): Promise<Commission[]> {
+  async getSpotFees(): Promise<Commission[]> {
     return this.makeRequest<Commission[]>({ method: "spot_fees" });
   }
 
   /**
-   * Get the personal trading commission rate of a symbol
+   * Get the personal trading fee rate of a symbol
    *
    * https://api.exchange.cryptomkt.com/#get-spot-fee
    *
    * @param {string} params.symbol The symbol of the commission rate
    * @return A promise that resolves with the commission rate of a symbol
    */
-  async getSpotCommissionOfSymbol(params: {
+  async getSpotFee(params: {
     symbol: string;
   }): Promise<Commission> {
     return this.makeRequest<Commission>({ method: "spot_fee", params });

lib/websocket/walletClient.ts

@@ -42,7 +42,7 @@ export class WalletClient extends AuthClient {
    *
    * Requires the "Payment information" API key Access Right
    *
-   * https://api.exchange.cryptomkt.com/#wallet-balance
+   * https://api.exchange.cryptomkt.com/#request-wallet-balance
    *
    * @return A promise that resolves with a list of wallet balances
    */
@@ -55,12 +55,12 @@ export class WalletClient extends AuthClient {
    *
    * Requires the "Payment information" API key Access Right
    *
-   * https://api.exchange.cryptomkt.com/#wallet-balance
+   * https://api.exchange.cryptomkt.com/#request-wallet-balance
    *
    * @param {string} currency The currency code to query the balance
    * @return A promise that resolves with the wallet balance of the currency
    */
-  async getWalletBalanceOfCurrency(currency: string): Promise<Balance> {
+  async getWalletBalance(currency: string): Promise<Balance> {
     const response = await this.makeRequest<Balance>({ method: "wallet_balance", params: { currency } });
     return { available: response.available, reserved: response.reserved, currency: currency };
   }
@@ -78,7 +78,7 @@ export class WalletClient extends AuthClient {
    *
    * Requires the "Payment information" API key Access Right
    *
-   * https://api.exchange.cryptomkt.com/#get-transactions-history
+   * https://api.exchange.cryptomkt.com/#get-transactions
    *
    * @param {string[]} [params.tx_ids] Optional. List of transaction identifiers to query
    * @param {TRANSACTION_TYPE[]} [params.transaction_types] Optional. List of types to query. valid types are: 'DEPOSIT', 'WITHDRAW', 'TRANSFER' and 'SWAP'
@@ -92,6 +92,7 @@ export class WalletClient extends AuthClient {
    * @param {SORT} [params.sort] Optional. Sort direction. 'ASC' or 'DESC'. Default is 'DESC'
    * @param {number} [params.limit] Optional. Transactions per query. Defaul is 100. Max is 1000
    * @param {number} [params.offset] Optional. Default is 0. Max is 100000
+   * @param {Boolean} [params.group_transactions] Flag indicating whether the returned transactions will be parts of a single operation. Default is false
    * @return A promise that resolves with a list of transactions
    */
   getTransactions(params: {
@@ -108,6 +109,7 @@ export class WalletClient extends AuthClient {
     sort?: SORT;
     limit?: number;
     offset?: number;
+    group_transactions?: Boolean;
   }): Promise<Transaction[]> {
     const clean_params: any = { ...params }
     clean_params.currencies = params.currencies?.join(", ")
@@ -142,7 +144,7 @@ export class WalletClient extends AuthClient {
   /**
    * unsubscribe to the transaction feed.
    *
-   * https://api.exchange.cryptomkt.com/#subscription-to-the-transactions
+   * https://api.exchange.cryptomkt.com/#subscribe-to-transactions
    *
    * @return {Promise<Boolean>} A Promise of the unsubscription result. True if unsubscribed
    */
@@ -158,7 +160,7 @@ export class WalletClient extends AuthClient {
    * the first notification has a snapshot of the wallet. further notifications
    * are updates of the wallet
    *
-   * https://api.exchange.cryptomkt.com/#subscription-to-the-balance
+   * https://api.exchange.cryptomkt.com/#subscribe-to-wallet-balances
    *
    * @param {function} callback A function that recieves notifications with a list of balances, and the type of notification (either SNAPSHOT or UPDATE)
    * @return {Promise<Boolean>} A Promise of the subscription result. True if subscribed
@@ -185,7 +187,7 @@ export class WalletClient extends AuthClient {
   /**
    * unsubscribe to the balance feed.
    *
-   * https://api.exchange.cryptomkt.com/#subscription-to-the-balance
+   * https://api.exchange.cryptomkt.com/#subscribe-to-wallet-balances
    *
    * @return {Promise<Boolean>} A Promise of the unsubscription result. True if unsubscribed
    */