feat: price rate subscription

Author: Insmael

cryptomarket/args.py

@@ -99,6 +99,11 @@ class TickerSpeed(Checker):
     _3_SECONDS = '3s'
 
 
+class PriceRateSpeed(Checker):
+    _1_SECOND = '1s'
+    _3_SECONDS = '3s'
+
+
 class OrderbookSpeed(Checker):
     _100_MILISECONDS = '100ms'
     _500_MILISECONDS = '500ms'
@@ -376,6 +381,9 @@ def public_comment(self, val: str):
     def symbols_as_list(self, val: List[str]):
         return self.add('symbols', val)
 
+    def currencies_as_list(self, val: List[str]):
+        return self.add('currencies', val)
+
     def transaction_type(self, val: List[str]):
         return self.add_cheking(TransactionType, 'type', val)
 
@@ -434,6 +442,9 @@ def sub_account_id(self, val: str):
     def subscription_mode(self, val: str):
         return self.add_cheking(SubscriptionMode, 'mode', val)
 
+    def target_currency(self, val: str):
+        return self.add('target_currency', val)
+
     def type(self, val: str):
         return self.add('type', val)
 

cryptomarket/dataclasses/__init__.py

@@ -23,13 +23,13 @@
 from .tradeOfOrder import TradeOfOrder
 from .transaction import Transaction
 from .wsCandle import WSCandle
-from .wsminiTicker import WSMiniTicker
+from .wsMiniTicker import WSMiniTicker
 from .wsOrderBook import WSOrderBook
 from .wsOrderBookTop import WSOrderBookTop
 from .wsPublicTrade import WSPublicTrade
 from .wsTicker import WSTicker
 from .wsTrade import WSTrade
-
+from .wsPriceRate import WSPriceRate
 __all__ = [
     ACLSettings,
     Address,
@@ -62,5 +62,6 @@
     WSPublicTrade,
     WSTicker,
     WSTrade,
+    WSPriceRate,
     SubAccount
 ]

cryptomarket/dataclasses/wsminiTicker.py cryptomarket/dataclasses/wsMiniTicker.pycryptomarket/dataclasses/wsminiTicker.py renamed to cryptomarket/dataclasses/wsMiniTicker.py

@@ -0,0 +1,9 @@
+from dataclasses import dataclass
+
+
+@dataclass
+class WSPriceRate:
+    t: int
+    """Timestamp in milliseconds"""
+    r: str
+    """rate"""

cryptomarket/dataclasses/wsPriceRate.py

@@ -5,9 +5,10 @@
 
 import cryptomarket.args as args
 from cryptomarket.dataclasses.wsCandle import WSCandle
-from cryptomarket.dataclasses.wsminiTicker import WSMiniTicker
+from cryptomarket.dataclasses.wsMiniTicker import WSMiniTicker
 from cryptomarket.dataclasses.wsOrderBook import WSOrderBook
 from cryptomarket.dataclasses.wsOrderBookTop import WSOrderBookTop
+from cryptomarket.dataclasses.wsPriceRate import WSPriceRate
 from cryptomarket.dataclasses.wsTicker import WSTicker
 from cryptomarket.dataclasses.wsTrade import WSTrade
 from cryptomarket.exceptions import CryptomarketAPIException
@@ -485,3 +486,38 @@ def intercept_feed(feed, feed_type):
             params=params,
             result_callback=result_callback
         )
+
+    def subscribe_to_price_rates(
+        self,
+        callback: Callable[[Dict[str, WSPriceRate]], None],
+        speed: Union[args.PriceRateSpeed, Literal['1s', '3s']],
+        target_currency: Optional[str],
+        currencies: Optional[List[str]] = None,
+        result_callback: Optional[Callable[[
+            Union[CryptomarketAPIException, None], Union[List[str], None]], None]] = None,
+    ):
+        """subscribe to a feed of price rates
+
+        subscription is for all currencies or specified currencies (bases), against a target currency (quote). indexed by currency id (bases)
+
+        https://api.exchange.cryptomkt.com/#subscribe-to-price-rates
+
+        :param callback: callable that recieves a dict of mini tickers, indexed by symbol.
+        :param speed: The speed of the feed. '1s' or '3s'
+        :param target_currency: quote currency for the price rates
+        :param currencies: Optional. A list of currencies ids (as bases) to subscribe to. If not provided it subscribes to all currencies
+        :param result_callback: A callable of two arguments, takes either a CryptomarketAPIException, or the list of correctly subscribed currencies
+        """
+        if currencies is None:
+            currencies = ['*']
+        params = args.DictBuilder().currencies_as_list(currencies).speed(speed).target_currency(target_currency).build()
+
+        def intercept_feed(feed, feed_type):
+            callback({key: from_dict(data_class=WSPriceRate, data=feed[key])
+                      for key in feed})
+        self._send_channeled_subscription(
+            channel=f'price/rate/{speed}',
+            callback=intercept_feed,
+            params=params,
+            result_callback=result_callback
+        )

cryptomarket/websockets/market_data_client.py

@@ -0,0 +1,47 @@
+import json
+import time
+from typing import Dict, List
+from cryptomarket.args import TickerSpeed
+from cryptomarket.dataclasses.wsTicker import WSTicker
+from cryptomarket.dataclasses.wsTrade import WSTrade
+from cryptomarket.websockets.wallet_client import WalletClient
+
+
+with open('/home/ismael/cryptomarket/keys.json') as fd:
+    keys = json.load(fd)
+
+
+def print_report(exception, report):
+    if exception is not None:
+        print('exception')
+        print(exception)
+    if report is not None:
+        print('report')
+        print(report)
+
+
+if __name__ == '__main__':
+    from cryptomarket.websockets import TradingClient
+
+    client = WalletClient(keys['apiKey'], keys['apiSecret'], window=15_000)
+    client.connect()
+
+    # subscribe to wallet transactions
+    def callback(transaction):
+        print(transaction)
+    client.subscribe_to_transactions(callback)
+
+    # unsubscribe from wallet transactions
+    err = client.unsubscribe_to_transactions()
+
+    # get wallet balances
+    def callback(err, balances):
+        if err:
+            print(err)
+            return
+        print(balances)
+    client.get_wallet_balances(callback)
+
+    time.sleep(5)
+
+    client.close()

tests/rest/test_test.py

@@ -6,6 +6,7 @@
                                       WSCandle, WSMiniTicker, WSOrderBook,
                                       WSOrderBookTop, WSPublicTrade, WSTicker,
                                       WSTrade)
+from cryptomarket.dataclasses.wsPriceRate import WSPriceRate
 from tests.rest.test_helpers import good_list
 
 
@@ -124,6 +125,16 @@ def good_orderbook_top(orderbook_top: WSOrderBookTop) -> bool:
     )
 
 
+def good_price_rate(price_rate: WSPriceRate) -> bool:
+    return good_dict(
+        asdict(price_rate),
+        [
+            "t",
+            "r",
+        ]
+    )
+
+
 def good_candle(candle: WSCandle) -> bool:
     return good_dict(
         asdict(candle),

tests/websockets/test_helpers.py

@@ -1,5 +1,6 @@
 import time
 import unittest
+from cryptomarket.dataclasses.wsPriceRate import WSPriceRate
 
 from test_helpers import *
 
@@ -167,6 +168,23 @@ def callback(top_of_orderbooks_of_symbol: Dict[str, WSOrderBookTop]):
         if Veredict.failed:
             self.fail(Veredict.message)
 
+    def test_subscribe_to_price_rates(self):
+        def callback(price_rates: Dict[str, WSPriceRate]):
+            for currency in price_rates:
+                price_rate = price_rates[currency]
+                if not good_price_rate(price_rate):
+                    Veredict.fail("not a good mini ticker")
+        self.ws.subscribe_to_price_rates(
+            callback=callback,
+            speed=args.PriceRateSpeed._1_SECOND,
+            target_currency="BTC",
+            currencies=["EOS", "ETH"],
+            result_callback=result_callback
+        )
+        time.sleep(20*SECOND)
+        if Veredict.failed:
+            self.fail(Veredict.message)
+
 
 if __name__ == '__main__':
     unittest.main()