Merge branch 'develop'

Author: Pedro Pablo Bustamante Barrera

README.md

@@ -4,21 +4,21 @@
 
 [sign up in CryptoMarket](https://www.cryptomkt.com/account/register).
 
-# Installation
+## Installation
 
 To install Cryptomarket use npm
 
-```
-npm install cryptomarket@3.2.1
+```bash
+npm install cryptomarket@3.3.0
 ```
 
-# Documentation
+## Documentation
 
 This sdk makes use of the [api version 3](https://api.exchange.cryptomkt.com) of cryptomarket.
 
-# Quick Start
+## Quick Start
 
-## rest client
+### Rest client
 
 ```typescript
 const { Client } = require("cryptomarket");
@@ -60,7 +60,7 @@ const newOrder = await client.createOrder({
 });
 ```
 
-## websocket client
+### Websocket client
 
 There are three websocket clients, the market data client, the spot trading client and the wallet client.
 The market data client requires no authentication, while the spot trading client and the wallet client do require it.
@@ -70,7 +70,7 @@ All websocket methods return promises. Subscriptions also take in a function of
 The documentation of a specific subscriptions explains with of this types of
 notification uses.
 
-### MarketDataClient
+#### MarketDataClient
 
 Example of use of the market data client
 
@@ -102,7 +102,7 @@ await marketDataClient.subscribeToPartialOrderBook(
 
 ```
 
-### SpotTradingClient
+#### SpotTradingClient
 
 Example of use of the spot trading client
 
@@ -133,7 +133,7 @@ const report = await tradingClient.createSpotOrder({
 console.log(report);
 ```
 
-### WalletClient
+#### WalletClient
 
 Example of use of the wallet client
 
@@ -157,7 +157,7 @@ await walletClient.subscribeToTransactions((notification, type) => {
 });
 ```
 
-## error handling
+### Error handling
 
 ```typescript
 
@@ -187,11 +187,11 @@ try {
 }
 ```
 
-# Constants
+## Constants
 
 All constants used for calls are in the `constants` module.
 
-# Checkout our other SDKs
+## Checkout our other SDKs
 
 [python sdk](https://github.com/cryptomkt/cryptomkt-python)
 

lib/client.ts

@@ -19,6 +19,7 @@ import { HttpClient } from "./httpClient";
 import {
   ACLSettings,
   Address,
+  WhitelistAddress,
   AmountLock,
   Balance,
   Candle,
@@ -824,6 +825,7 @@ export class Client {
    * @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 {string} [params.stopPrice]  Required if order type is stopLimit, stopMarket, takeProfitLimit, or takeProfitMarket. 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 tickSize and quantityIncrement.
    *
    * @returns the new spot order
@@ -834,6 +836,7 @@ export class Client {
       newClientOrderId: string;
       quantity: string;
       price?: string;
+      stop_price?: string;
       strictValidate?: boolean;
     }
   ): Promise<Order> {
@@ -999,6 +1002,19 @@ export class Client {
     return balance;
   }
 
+  /**
+   * Gets the list of whitelisted addresses
+   * 
+   * Requires the "Payment information" API key Access Right
+   * 
+   * https://api.exchange.cryptomkt.com/#get-whitelisted-addresses
+   * 
+   * @return the list of white listed addresses
+   */
+  getWhitelistedAddresses(): Promise<WhitelistAddress[]> {
+    return this.get(`wallet/crypto/address/white-list`);
+  }
+
   /**
    * Get the current addresses of the user
    *
@@ -1197,6 +1213,21 @@ Accepted values: never, optionally, required
     return this.post("wallet/crypto/fee/estimate/bulk", feeRequests);
   }
 
+
+  /**
+   * Gets the hash of withdrawal fees
+   * 
+   * Requires the "Payment information" API key Access Right
+   * 
+   * https://api.exchange.cryptomkt.com/#get-withdrawal-fees-hash
+   *
+   * @return the fees hash
+   */
+  async getWithdrawalFeesHash(): Promise<String[]> {
+    const response = await this.get("wallet/crypto/fee/withdraw/hash");
+    return response['hash'];
+  }
+
   /**
    * Get an estimate of a withdrawal fee
    *
@@ -1220,20 +1251,20 @@ Accepted values: never, optionally, required
     return response["fee"];
   }
 
-//   /**
-//  * Get estimates of deposit fees
-//  *
-//  * Requires the "Payment information" API key Access Right.
-//  *
-//  * https://api.exchange.cryptomkt.com/#bulk-estimate-deposit-fee
-//  *
-//  * @param {FeeRequest[]} feeRequests A list of fee requests
-//  *
-//  * @return The list of requested fees
-//  */
-//   async getBulkEstimateDepositFees(feeRequests: FeeRequest[]): Promise<Fee[]> {
-//     return this.post("wallet/crypto/fee/deposit/estimate/bulk", feeRequests);
-//   }
+  //   /**
+  //  * Get estimates of deposit fees
+  //  *
+  //  * Requires the "Payment information" API key Access Right.
+  //  *
+  //  * https://api.exchange.cryptomkt.com/#bulk-estimate-deposit-fee
+  //  *
+  //  * @param {FeeRequest[]} feeRequests A list of fee requests
+  //  *
+  //  * @return The list of requested fees
+  //  */
+  //   async getBulkEstimateDepositFees(feeRequests: FeeRequest[]): Promise<Fee[]> {
+  //     return this.post("wallet/crypto/fee/deposit/estimate/bulk", feeRequests);
+  //   }
 
   // /**
   //  * Get an estimate of a deposit fee
@@ -1559,6 +1590,63 @@ Accepted values: wallet, spot. Must not be the same as source
     return response["response"];
   }
 
+  /**
+   * Creates and commits a transfer from a subaccount to its super account
+   * 
+   * Call is being sent by a subaccount
+   * 
+   * Created but not committed transfer will reserve pending amount on the sender
+   * wallet affecting their ability to withdraw or transfer crypto to another
+   * account. Incomplete withdrawals affect subaccount transfers the same way
+   * 
+   * Requires the "Withdraw cryptocurrencies" API key Access Right
+   * 
+   * https://api.exchange.cryptomkt.com/#transfer-to-super-account
+   *
+   * @param {object} params Parameters
+   * @param {number} params.amount the amount of currency to transfer
+   * @param {string} params.currency the currency to transfer
+   *
+   * @return The transaction ID of the tranfer
+   */
+  async transferToSuperAccount(params: {
+    amount: number;
+    currency: string;
+  }): Promise<string> {
+    const response = await this.post("sub-account/transfer/sub-to-super", params);
+    return response["response"];
+  }
+
+  /**
+   * Creates and commits a transfer between the user (subaccount) and another
+   * subaccount.
+   * 
+   * Call is being sent by a subaccount
+   * 
+   * Created but not committed transfer will reserve pending amount on the sender
+   * wallet affecting their ability to withdraw or transfer crypto to another
+   * account. Incomplete withdrawals affect subaccount transfers the same way
+   * 
+   * Requires the "Withdraw cryptocurrencies" API key Access Right
+   * 
+   * https://api.exchange.cryptomkt.com/#transfer-across-subaccounts
+   *
+   * @param {object} params Parameters
+   * @param {number} params.subAccountId The account ID of the account to transfer to
+   * @param {number} params.amount the amount of currency to transfer
+   * @param {string} params.currency the currency to transfer
+   *
+   * @return The transaction ID of the tranfer
+   */
+  async transferToAnotherSubAccount(params: {
+    subAccountId: number;
+    amount: number;
+    currency: string;
+  }): Promise<string> {
+    const response = await this.post("sub-account/transfer/sub-to-sub", params);
+    return response["response"];
+  }
+
   /**
    * Returns a list of withdrawal settings for sub-accounts listed
    *

lib/models.ts

@@ -23,4 +23,5 @@ export * from "./models/WSCandle";
 export * from "./models/WSTicker";
 export * from "./models/WSTrades";
 export * from "./models/Fee";
-export * from "./models/FeeRequest";
+export * from "./models/FeeRequest";
+export * from "./models/WhitelistAddress";

lib/models/Address.ts

@@ -1,7 +1,7 @@
 export interface Address {
   address: string;
   currency: string;
-  paymentId: string;
-  publicKey: string;
-  netwokdCode: string;
+  paymentId?: string;
+  publicKey?: string;
+  networkCode?: string;
 }

lib/models/Order.ts

@@ -26,6 +26,7 @@ export interface Order {
   originalClientOrderId: string;
   orderListId: string;
   contingencyType: CONTINGENCY;
+  priceAverage: string;
 }
 
 export interface OrderRequest {

lib/models/Price.ts

@@ -1,5 +1,5 @@
 export interface Price {
-  currency: string;
-  price: string;
+  currency?: string;
+  price?: string;
   timestamp: string;
 }

lib/models/WhitelistAddress.ts

@@ -0,0 +1,6 @@
+export interface WhitelistAddress {
+  address: string;
+  currency: string;
+  name: string;
+  network: string;
+}

lib/websocket/tradingClient.ts

@@ -177,6 +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 {string} [params.stopPrice]  Required if order type is stopLimit, stopMarket, takeProfitLimit, or takeProfitMarket. Order price
    * @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
    */
@@ -185,6 +186,7 @@ export class TradingClient extends AuthClient {
     newClientOrderId: string;
     quantity: string;
     price: string;
+    stop_price?: string;
     strictValidate?: Boolean;
   }): Promise<Report> {
     const report = await this.makeRequest<Report>({

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "cryptomarket",
-  "version": "3.2.1",
+  "version": "3.3.0",
   "description": "The CryptoMarket for Node.js",
   "homepage": "https://www.cryptomkt.com",
   "engines": {
@@ -39,7 +39,7 @@
     "bigdecimal": "0.6.1",
     "crypto-js": "4.2.0",
     "node-fetch": "^2.6.1",
-    "ws": "^7.4.0"
+    "ws": "8.18.0"
   },
   "devDependencies": {
     "@types/chai": "4.3.11",