Merge pull request #29 from cryptomkt/feat/update-january-2025

Feat/update january 2025

Author: ppbustamante

cryptomarket/client.py

@@ -10,7 +10,7 @@
                                       Commission, Currency, Fee, Order,
                                       OrderBook, Price, PriceHistory,
                                       SubAccount, Symbol, Ticker, Trade,
-                                      Transaction)
+                                      Transaction, WhitelistedAddress)
 from cryptomarket.dataclasses.aclSettings import ACLSettings
 from cryptomarket.dataclasses.convertedCandles import ConvertedCandles
 from cryptomarket.dataclasses.convertedCandlesOfSymbol import \
@@ -748,6 +748,7 @@ def replace_spot_order(
         new_client_order_id: str,
         quantity: str,
         price: Optional[str] = None,
+        stop_price: Optional[str] = None,
         strict_validate: Optional[bool] = None
     ) -> Order:
         """Replaces a spot order
@@ -761,13 +762,14 @@ def replace_spot_order(
         :param client order id: client order id of the old order
         :param new client order id: client order id for the new order
         :param quantity: Order quantity
-        :param strict validate: 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 price: Required if order type is 'limit', 'stopLimit', or 'takeProfitLimit'. Order price
+        :param stop price: Required if order type is 'stopLimit', 'stopMarket', 'takeProfitLimit', or 'takeProfitMarket'. Order stop price
+        :param strict validate: 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
 
         :return: The new spot order
         """
         params = args.DictBuilder().new_client_order_id(new_client_order_id).quantity(
-            quantity).price(price).strict_validate(strict_validate).build()
+            quantity).price(price).stop_price(stop_price).strict_validate(strict_validate).build()
         response = self._patch(
             endpoint=f'spot/order/{client_order_id}', params=params)
         return from_dict(data_class=Order, data=response, config=Config(cast=[Enum]))
@@ -934,6 +936,18 @@ def get_wallet_balance_of_currency(self, currency: Optional[str] = None) -> Bala
         response = self._get(endpoint=f'wallet/balance/{currency}')
         return from_dict(data_class=Balance, data=response)
 
+    def get_whitelisted_addresses(self) -> List[WhitelistedAddress]:
+        """Gets the list of whitelisted addresses
+
+        Requires the "Payment information" API key Access Right
+
+        https://api.exchange.cryptomkt.com/#get-whitelisted-addresses
+
+        :return: A list of addresses
+        """
+        response = self._get(endpoint=f'wallet/crypto/address/white-list')
+        return [from_dict(data_class=WhitelistedAddress, data=data) for data in response]
+
     def get_deposit_crypto_addresses(self) -> List[Address]:
         """Get the current addresses of the user
 
@@ -1109,7 +1123,9 @@ def get_estimate_withdrawal_fees(self, fee_requests: List[args.FeeRequest]) -> L
 
         :return: A list of expected withdrawal fees
         """
-        params = [asdict(fee_request) for fee_request in fee_requests]
+        params = [args.clean_nones(asdict(fee_request))
+                  for fee_request
+                  in fee_requests]
         result = self._post(
             endpoint='wallet/crypto/fees/estimate', params=params)
         return [Fee.from_dict(fee_data) for fee_data in result]
@@ -1123,11 +1139,24 @@ def get_bulk_estimate_withdrawal_fees(self, fee_requests: List[args.FeeRequest])
 
         :return: A list of expected withdrawal fees
         """
-        params = [asdict(fee_request) for fee_request in fee_requests]
+        params = [args.clean_nones(asdict(fee_request))
+                  for fee_request
+                  in fee_requests]
         result = self._post(
             endpoint='wallet/crypto/fee/estimate/bulk', params=params)
         return [Fee.from_dict(fee_data) for fee_data in result]
 
+    def get_withdrawal_fees_hash(self) -> str:
+        """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
+        """
+        return self._get(endpoint='wallet/crypto/fee/withdraw/hash')['hash']
+
     # def get_estimate_deposit_fee(self, currency: str, amount: str, network_code: Optional[str] = None) -> str:
     #     """Get an estimate of the Deposit fee
 
@@ -1443,6 +1472,49 @@ def transfer_funds(
             amount).currency(currency).type(type).build()
         return self._post(endpoint='sub-account/transfer', params=params)['result']
 
+    def transfer_to_super_account(self, amount: str, currency: str) -> str:
+        """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 amount:   the amount of currency to transfer
+        :param currency: the currency to transfer
+        :return: The transaction id of the tranfer
+        """
+        params = args.DictBuilder().amount(amount).currency(currency).build()
+        return self._post(endpoint='sub-account/transfer/sub-to-super', params=params)['result']
+
+    def transfer_to_another_subaccount(self, sub_account_id: str, amount: str, currency: str) -> str:
+        """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 sub_account_id: Identifier of a subaccount
+        :param amount:   the amount of currency to transfer
+        :param currency: the currency to transfer
+        :return: The transaction id of the tranfer
+        """
+        params = args.DictBuilder().sub_account_id(sub_account_id).amount(
+            amount).currency(currency).build()
+        return self._post(endpoint='sub-account/transfer/sub-to-sub', params=params)['result']
+
     def get_ACL_settings(self, sub_account_ids: List[str]) -> List[ACLSettings]:
         """Get a list of withdrawal settings for all sub-accounts or for the specified sub-accounts
 

cryptomarket/dataclasses/__init__.py

@@ -31,6 +31,7 @@
 from .wsTrade import WSTrade
 from .wsPriceRate import WSPriceRate
 from .fee import Fee
+from .whitelistedAddress import WhitelistedAddress
 __all__ = [
     ACLSettings,
     Address,
@@ -66,4 +67,5 @@
     WSPriceRate,
     SubAccount, 
     Fee,
+    WhitelistedAddress
 ]

cryptomarket/dataclasses/order.py

@@ -19,6 +19,7 @@ class Order:
     quantity_cumulative: str
     created_at: str
     updated_at: str
+    price_average: str
     price: Optional[str] = None
     expire_time: Optional[str] = None
     stop_price: Optional[str] = None

cryptomarket/dataclasses/price.py

@@ -4,6 +4,6 @@
 
 @dataclass
 class Price:
-    price: str
     timestamp: str
+    price: Optional[str] = None
     currency: Optional[str] = None

cryptomarket/dataclasses/whitelistedAddress.py

@@ -0,0 +1,10 @@
+from dataclasses import dataclass
+from typing import Optional
+
+
+@dataclass
+class WhitelistedAddress:
+    address: str
+    currency: str
+    name: str
+    network: str

cryptomarket/websockets/trading_client.py

@@ -335,6 +335,7 @@ def replace_spot_order(
         new_client_order_id: str,
         quantiy: str,
         price: str,
+        stop_price: Optional[str] = None,
         strict_validate: Optional[bool] = None,
         callback: Optional[Callback[Report]] = None
     ):
@@ -346,11 +347,12 @@ def replace_spot_order(
         :param new_client_order_id: the new client order id for the modified order. must be unique within the trading day
         :param quantity: new order quantity
         :param price: new order price
+        :param stop price: Required if order type is 'stopLimit', 'stopMarket', 'takeProfitLimit', or 'takeProfitMarket'. Order stop price
         :param strict_validate:  price and quantity will be checked for the incrementation with tick size and quantity step. See symbol's tick_size and quantity_increment
         :param callback: A callable of two arguments, takes either a CryptomarketAPIException, or a report of the new version of the order
         """
         params = args.DictBuilder().client_order_id(client_order_id).new_client_order_id(
-            new_client_order_id).quantity(quantiy).price(price).strict_validate(strict_validate).build()
+            new_client_order_id).quantity(quantiy).price(price).stop_price(stop_price).strict_validate(strict_validate).build()
         intercept_response_callback: InterceptResponseCallback = None
         if callback:
             def intercept_result(err, response):

tests/websockets/test_helpers.py

@@ -1,13 +1,21 @@
 import time
 from dataclasses import asdict
-from typing import Any, Dict, List
+from typing import Any, Callable, Dict, List
 
 from cryptomarket.dataclasses import (Balance, OrderBookLevel, Report,
                                       WSCandle, WSMiniTicker, WSOrderBook,
                                       WSOrderBookTop, WSPublicTrade, WSTicker,
                                       WSTrade)
+from cryptomarket.dataclasses.commission import Commission
 from cryptomarket.dataclasses.wsPriceRate import WSPriceRate
-from tests.rest.test_helpers import good_list
+
+
+def good_list(check_fn: Callable[[Any], bool], list: List[Any]) -> bool:
+    for elem in list:
+        if not check_fn(elem):
+            print(elem)
+            return False
+    return True
 
 
 def defined(a_dict, key):
@@ -19,6 +27,28 @@ def defined(a_dict, key):
     return True
 
 
+def good_balance(balance: Balance) -> bool:
+    return good_dict(
+        asdict(balance),
+        [
+            "currency",
+            "available",
+            "reserved",
+        ]
+    )
+
+
+def good_trading_commission(commission: Commission) -> bool:
+    return good_dict(
+        asdict(commission),
+        [
+            "symbol",
+            "take_rate",
+            "make_rate",
+        ]
+    )
+
+
 def good_dict(a_dict: Dict[str, Any], fields: List[str]) -> bool:
     if not isinstance(a_dict, dict):
         return False

tests/websockets/test_market_data_subs.py

@@ -7,8 +7,7 @@
                                       WSOrderBookTop, WSTicker, WSTrade)
 from cryptomarket.dataclasses.wsPriceRate import WSPriceRate
 from cryptomarket.websockets import MarketDataClient
-from tests.rest.test_helpers import good_list
-from tests.websockets.test_helpers import Veredict, good_candle_list, good_mini_ticker, good_orderbook_top, good_price_rate, good_wsorder_book, good_wsticker, good_wstrade
+from test_helpers import *
 
 SECOND = 1
 MINUTE = 60

tests/websockets/test_trading_client.py

@@ -7,7 +7,6 @@
 from test_helpers import *
 
 from cryptomarket.websockets import TradingClient
-from tests.rest.test_helpers import good_balance, good_trading_commission
 
 with open('/home/ismael/cryptomarket/keys.json') as fd:
     keys = json.load(fd)