fix: update missing snake_case names

Author: Insmael

README.md

@@ -124,7 +124,7 @@ console.log(balanceList);
 let clientOrderID = Math.floor(Date.now() / 1000).toString();
 // make a spot order
 const report = await tradingClient.createSpotOrder({
-  client_order_id: clientOrderID,
+  clientOrderId: clientOrderID,
   symbol: "EOSETH",
   side: "sell",
   quantity: "0.01",

lib/client.ts

@@ -547,7 +547,7 @@ export class Client {
    * @param {string} [params.stopPrice] Required for 'stopLimit' and 'stopMarket' orders. stop price of the order
    * @param {string} [params.expireTime] Required for orders with timeInForce = GDT
    * @param {boolean} [params.strictValidate] Optional. If False, the server rounds half down for tickerSize and quantityIncrement. Example of ETHBTC: tickSize = '0.000001', then price '0.046016' is valid, '0.0460165' is invalid
-   * @param {boolean} [params.postOnly] Optional. If True, your post_only order causes a match with a pre-existing order as a taker, then the order will be cancelled
+   * @param {boolean} [params.postOnly] Optional. If True, your postOnly order causes a match with a pre-existing order as a taker, then the order will be cancelled
    * @param {string} [params.takeRate] Optional. Liquidity taker fee, a fraction of order volume, such as 0.001 (for 0.1% fee). Can only increase the fee. Used for fee markup.
    * @param {string} [params.makeRate] Optional. Liquidity provider fee, a fraction of order volume, such as 0.001 (for 0.1% fee). Can only increase the fee. Used for fee markup.
    *
@@ -607,7 +607,7 @@ export class Client {
    *
    * https://api.exchange.cryptomkt.com/#create-new-spot-order-list
    *
-   * @param {string} params.orderListId 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.orderListId Order list identifier. If omitted, it will be generated by the system upon order list creation. Must be equal to clientOrderId of the first order in the request.
    * @param {string} params.contingencyType Order list type.
    * @param {OrderRequest[]} params.orders Orders in the list.
    * @return A promise that resolves with a list of reports of the created orders
@@ -627,12 +627,12 @@ export class Client {
    *
    * https://api.exchange.cryptomkt.com/#replace-spot-order
    *
-   * @param {string} clientOrderId  client_order_id of the old order
+   * @param {string} clientOrderId  clientOrderId of the old order
    * @param {object} params Parameters
-   * @param {string} params.newClientOrderId client_order_id for the new order.
+   * @param {string} params.newClientOrderId clientOrderId for the new order.
    * @param {string} params.quantity Order quantity.
    * @param {string} [params.price] Required if order type is limit, stopLimit, or takeProfitLimit. Order price.
-   * @param {boolean} [params.strictValidate] Optional. Price and quantity will be checked for incrementation within the symbol’s tick size and quantity step. See the symbol's tick_size and quantity_increment.
+   * @param {boolean} [params.strictValidate] Optional. Price and quantity will be checked for incrementation within the symbol’s tick size and quantity step. See the symbol's tickSize and quantityIncrement.
    *
    * @returns the new spot order
    */
@@ -668,7 +668,7 @@ export class Client {
    *
    * https://api.exchange.cryptomkt.com/#cancel-spot-order
    *
-   * @param {string} clientOrderId the client_order_id of the order to cancel
+   * @param {string} clientOrderId the clientOrderId of the order to cancel
    *
    * @return The canceled order
    */
@@ -750,7 +750,7 @@ export class Client {
    * https://api.exchange.cryptomkt.com/#spot-trades-history
    *
    * @param {object} [params]
-   * @param {string} [params.order_id] Optional. Order unique identifier as assigned by the exchange
+   * @param {string} [params.orderId] Optional. Order unique identifier as assigned by the exchange
    * @param {string} [params.symbol] Optional. Filter trades by symbol
    * @param {SORT} [params.sort] Optional. Sort direction. 'ASC' or 'DESC'. Default is 'DESC'
    * @param {SORT_BY} [params.by] Optional. Sorting type.'timestamp' or 'id'. Default is 'id'
@@ -761,7 +761,7 @@ export class Client {
    * @return A list of trades
    */
   getSpotTradesHistory(params?: {
-    order_id?: string;
+    orderId?: string;
     symbol?: string;
     sort?: SORT;
     by?: SORT_BY;
@@ -828,11 +828,12 @@ export class Client {
    * https://api.exchange.cryptomkt.com/#get-deposit-crypto-address
    *
    * @param {string} currency currency to get the address
+   * @param {string} [networkCode] Optional. network code
    *
    * @return the currency address
    */
-  async getDepositCryptoAddress(currency: string, network_code?: string): Promise<Address> {
-    const addressList = await this.get(`wallet/crypto/address`, { currency });
+  async getDepositCryptoAddress(currency: string, networkCode?: string): Promise<Address> {
+    const addressList = await this.get(`wallet/crypto/address`, { currency, networkCode });
     return addressList[0];
   }
 
@@ -843,7 +844,7 @@ export class Client {
    * Existing addresses may still receive funds. 
    * For some tokens (e.g., Ethereum tokens), 
    * a single address is generated per base currency with additional 
-   * identifiers which differ for each address: payment_id or public_key. 
+   * identifiers which differ for each address: paymentId or publicKey. 
    * As a result, generating a new address for such a token 
    * will change the current address for an entire base currency accordingly.
    * 
@@ -920,9 +921,9 @@ export class Client {
    * @param {string} [params.paymentId] Optional.
    * @param {boolean} [params.includeFee] Optional. If true then the total spent amount includes fees. Default false
    * @param {boolean} [params.autoCommit] Optional. If false then you should commit or rollback transaction in an hour. Used in two phase commit schema. Default true
-   * @param {USE_OFFCHAIN} [params.use_offchain] Whether the withdrawal may be committed offchain. 'never', 'optionally', 'required'
+   * @param {USE_OFFCHAIN} [params.useOffchain] Whether the withdrawal may be committed offchain. 'never', 'optionally', 'required'
 Accepted values: never, optionally, required
-   * @param {string} [params.public_comment] Optional. Maximum length is 255.
+   * @param {string} [params.publicComment] Optional. Maximum length is 255.
    *
    * @return The transaction id, asigned by the exchange
    */
@@ -1129,9 +1130,9 @@ Accepted values: wallet, spot. Must not be the same as source
    * @param {TRANSACTION_STATUS[]} [params.statuses] Optional. List of statuses to query. valid subtypes are: 'CREATED', 'PENDING', 'FAILED', 'SUCCESS' and 'ROLLED_BACK'
    * @param {string[]} [params.currencies] Optional. List of currencies of the transactions
    * @param {string[]} [params.networks] Optional. List of network codes
-   * @param {SORT_BY} [params.orderBy] Optional. Defines the sorting type.'created_at' or 'id'. Default is 'created_at'
-   * @param {string} [params.from] Optional. Interval initial value when ordering by 'created_at'. As Datetime
-   * @param {string} [params.till] Optional. Interval end value when ordering by 'created_at'. As Datetime
+   * @param {SORT_BY} [params.orderBy] Optional. Defines the sorting type.'createdAt' or 'id'. Default is 'createdAt'
+   * @param {string} [params.from] Optional. Interval initial value when ordering by 'createdAt'. As Datetime
+   * @param {string} [params.till] Optional. Interval end value when ordering by 'createdAt'. As Datetime
    * @param {string} [params.idFrom] Optional. Interval initial value when ordering by id. Min is 0
    * @param {string} [params.idTill] Optional. Interval end value when ordering by id. Min is 0
    * @param {string} [params.sort] Optional. Sort direction. 'ASC' or 'DESC'. Default is 'DESC'.
@@ -1283,9 +1284,7 @@ Accepted values: wallet, spot. Must not be the same as source
    * @return true if the activation was successful
    */
   async activateSubAccounts(subAccountIds: string[]): Promise<boolean> {
-    const response = await this.post("sub-account/activate", {
-      sub_account_ids: subAccountIds,
-    });
+    const response = await this.post("sub-account/activate", { subAccountIds });
     return response["result"];
   }
 
@@ -1349,7 +1348,7 @@ Accepted values: wallet, spot. Must not be the same as source
   async changeACLSettings(params: {
     subAccountIds: string[];
     depositAddressGenerationEnabled?: boolean;
-    withdraw_enabled?: boolean;
+    withdrawEnabled?: boolean;
     description?: string;
     createdAt?: string;
     updatedAt?: string;

lib/httpClient.ts

@@ -32,13 +32,13 @@ export class HttpClient {
   }
 
 
-  private prepareRequest(params_raw: any, method: HTTP_METHOD, publicMethod: boolean, endpoint: string): { url: URL, opts: Map<string, string> } {
-    if (params_raw === undefined || params_raw === null) {
-      params_raw = {}
+  private prepareRequest(paramsRaw: any, method: HTTP_METHOD, publicMethod: boolean, endpoint: string): { url: URL, opts: Map<string, string> } {
+    if (paramsRaw === undefined || paramsRaw === null) {
+      paramsRaw = {}
     }
     let url = new URL(this.apiPath + endpoint);
-    this.removeNulls(params_raw);
-    const params: [string, string][] = Object.entries(params_raw)
+    this.removeNulls(paramsRaw);
+    const params: [string, string][] = Object.entries(paramsRaw)
       .map(([k, v]) => [k, String(v)])
     let rawQuery = new URLSearchParams(params);
     rawQuery.sort();
@@ -54,7 +54,7 @@ export class HttpClient {
     let credentialParams = query
     if (method === HTTP_METHOD.POST) {
       opts.headers["Content-Type"] = "application/json";
-      credentialParams = JSON.stringify(params_raw)
+      credentialParams = JSON.stringify(paramsRaw)
     }
     if (method === HTTP_METHOD.PATCH) {
       opts.headers["Content-Type"] = "application/x-www-form-urlencoded";
@@ -71,8 +71,8 @@ export class HttpClient {
     return { url, opts };
   }
 
-  private removeNulls(params_raw: any) {
-    Object.keys(params_raw).forEach(key => (params_raw[key] === undefined || params_raw[key] == null) ? delete params_raw[key] : {});
+  private removeNulls(paramsRaw: any) {
+    Object.keys(paramsRaw).forEach(key => (paramsRaw[key] === undefined || paramsRaw[key] == null) ? delete paramsRaw[key] : {});
   }
 
   private async makeFetch(url: URL, opts: any): Promise<any> {

lib/websocket/authClient.ts

@@ -3,7 +3,7 @@ import { WSClientBase } from "./clientBase";
 
 interface AuthPayload {
   type: string
-  api_key: string
+  apiKey: string
   timestamp: number
   window?: number
   signature: string
@@ -53,7 +53,7 @@ export class AuthClient extends WSClientBase {
     const timestamp = Math.floor(Date.now());
     const payload: AuthPayload = {
       type: "HS256",
-      api_key: this.apiKey,
+      apiKey: this.apiKey,
       timestamp: timestamp,
       signature: "",
     };

lib/websocket/marketDataClient.ts

@@ -555,7 +555,7 @@ export class MarketDataClient extends WSClientBase {
    * 
    * @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} params.speed The speed of the feed. '1s' or '3s'
-   * @param {string} params.target_currency quote currency of the rate
+   * @param {string} params.targetCurrency quote currency of the rate
    * @param {string} params.currencies Optional. a list of base currencies to get rates. If omitted, subscribe to all currencies
    * @return A promise that resolves when subscribed with a list of the successfully subscribed currencies
    */
@@ -569,7 +569,7 @@ export class MarketDataClient extends WSClientBase {
     ) => any;
     params: {
       speed: PRICE_RATE_SPEED;
-      target_currency: string,
+      targetCurrency: string,
       currencies?: string[];
     };
   }): Promise<string[]> {

lib/websocket/tradingClient.ts

@@ -75,7 +75,7 @@ export class TradingClient extends AuthClient {
    * @param {TIME_IN_FORCE} [params.timeInForce] Optional. 'GTC', 'IOC', 'FOK', 'Day', 'GTD'. Default to 'GTC'
    * @param {string} [params.expireTime] Optional. Required for orders with timeInForce = GDT
    * @param {boolean} [params.strictValidate] Optional. If False, the server rounds half down for tickerSize and quantityIncrement. Example of ETHBTC: tickSize = '0.000001', then price '0.046016' is valid, '0.0460165' is invalid
-   * @param {boolean} [params.postOnly] Optional. If True, your post_only order causes a match with a pre-existing order as a taker, then the order will be cancelled
+   * @param {boolean} [params.postOnly] Optional. If True, your postOnly order causes a match with a pre-existing order as a taker, then the order will be cancelled
    * @param {string} [params.takeRate] Optional. Liquidity taker fee, a fraction of order volume, such as 0.001 (for 0.1% fee). Can only increase the fee. Used for fee markup.
    * @param {string} [params.makeRate] Optional. Liquidity provider fee, a fraction of order volume, such as 0.001 (for 0.1% fee). Can only increase the fee. Used for fee markup.
    * @return A promise that resolves with a report of the new order
@@ -134,7 +134,7 @@ export class TradingClient extends AuthClient {
    *
    * https://api.exchange.cryptomkt.com/#create-new-spot-order-list-2
    *
-   * @param {string} params.orderListId 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.orderListId Order list identifier. If omitted, it will be generated by the system upon order list creation. Must be equal to clientOrderId of the first order in the request.
    * @param {string} params.contingencyType Order list type.
    * @param {OrderRequest[]} params.orders Orders in the list.
    * @return A promise that resolves with a list all reports created
@@ -163,7 +163,7 @@ export class TradingClient extends AuthClient {
   async cancelSpotOrder(clientOrderId: string): Promise<Report> {
     const report = await this.makeRequest<Report>({
       method: "spot_cancel_order",
-      params: { client_order_id: clientOrderId },
+      params: { clientOrderId },
     });
     return fromSnakeCaseToCamelCase(report)
   }
@@ -177,7 +177,7 @@ export class TradingClient extends AuthClient {
    * @param {string} params.newClientOrderId the new client order id for the modified order. must be unique within the trading day
    * @param {string} params.quantity new order quantity
    * @param {string} params.price new order price
-   * @param {boolean} [params.strictValidate]  price and quantity will be checked for the incrementation with tick size and quantity step. See symbol's tick_size and quantity_increment
+   * @param {boolean} [params.strictValidate]  price and quantity will be checked for the incrementation with tick size and quantity step. See symbol's tickSize and quantityIncrement
    * @return A promise that resolves with a report of the modified order
    */
   async replaceSpotOrder(params: {

lib/websocket/walletClient.ts

@@ -85,11 +85,11 @@ export class WalletClient extends AuthClient {
    * @param {TRANSACTION_TYPE[]} [params.transactionTypes] Optional. List of types to query. valid types are: 'DEPOSIT', 'WITHDRAW', 'TRANSFER' and 'SWAP'
    * @param {TRANSACTION_SUBTYPE[]} [params.transactionSubtyes] Optional. List of subtypes to query. valid subtypes are: 'UNCLASSIFIED', 'BLOCKCHAIN', 'AIRDROP', 'AFFILIATE', 'STAKING', 'BUY_CRYPTO', 'OFFCHAIN', 'FIAT', 'SUB_ACCOUNT', 'WALLET_TO_SPOT', 'SPOT_TO_WALLET', 'WALLET_TO_DERIVATIVES', 'DERIVATIVES_TO_WALLET', 'CHAIN_SWITCH_FROM', 'CHAIN_SWITCH_TO' and 'INSTANT_EXCHANGE'
    * @param {TRANSACTION_STATUS[]} [params.transactionStatuses] Optional. List of statuses to query. valid subtypes are: 'CREATED', 'PENDING', 'FAILED', 'SUCCESS' and 'ROLLED_BACK'
-   * @param {string} [params.from] Optional. Interval initial value when ordering by 'created_at'. As Datetime
-   * @param {string} [params.till] Optional. Interval end value when ordering by 'created_at'. As Datetime
+   * @param {string} [params.from] Optional. Interval initial value when ordering by 'createdAt'. As Datetime
+   * @param {string} [params.till] Optional. Interval end value when ordering by 'createdAt'. As Datetime
    * @param {string} [params.idFrom] Optional. Interval initial value when ordering by id. Min is 0
    * @param {string} [params.idTill] Optional. Interval end value when ordering by id. Min is 0
-   * @param {SORT_BY} [params.orderBy] Optional. sorting parameter.'created_at' or 'id'. Default is 'created_at'
+   * @param {SORT_BY} [params.orderBy] Optional. sorting parameter.'createdAt' or 'id'. Default is 'createdAt'
    * @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
@@ -112,11 +112,11 @@ export class WalletClient extends AuthClient {
     offset?: number;
     groupTransactions?: Boolean;
   }): Promise<Transaction[]> {
-    const clean_params: any = { ...params }
-    clean_params.currencies = params.currencies?.join(", ")
+    const cleanParams: any = { ...params }
+    cleanParams.currencies = params.currencies?.join(", ")
     const transactions = await this.makeRequest<Transaction[]>({
       method: "get_transactions",
-      params: clean_params
+      params: cleanParams
     });
     return fromSnakeCaseToCamelCase(transactions)
   }

test/rest/spotTrading.test.ts

@@ -157,19 +157,19 @@ describe("spot trading", () => {
       this.timeout(0);
       await timeout(3 * SECOND)
 
-       let order_list_id = Date.now().toString();
+      let firstOrderId = Date.now().toString();
       await client.createNewSpotOrderList({
-        // order_list_id: order_list_id,
+        orderListId: firstOrderId,
         contingencyType: CONTINGENCY.ALL_OR_NONE,
         orders: [
           {
+            clientOrderId: firstOrderId,
             symbol: 'EOSETH',
             side: SIDE.SELL,
             type: ORDER_TYPE.LIMIT,
             timeInForce: TIME_IN_FORCE.FOK,
             quantity: '0.1',
             price: '1000',
-            // client_order_id: order_list_id
           },
           {
             symbol: 'EOSUSDT',