crypto-ws-api 2.0.19__tar.gz → 2.1.0__tar.gz

{crypto_ws_api-2.0.19 → crypto_ws_api-2.1.0}/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 2.1.0 - 2025-06-22
+✨ refactor(ws_session.py): simplify `ws_login` and `request` methods by removing redundant `send_api_key` parameter.
+
+## 2.0.21 - 2025-06-22
+🔧 fix(README.md): Improve documentation layout for better readability  
+🔧 fix(ws_session.py): Handle `asyncio.CancelledError` gracefully in `start_wss` method  
+🔧 fix(ws_session.py): Replace `asyncio.CancelledError` with `KeyboardInterrupt` exception in `handle_request` method  
+🔧 fix(demo.py): Remove unnecessary `asyncio.CancelledError` handling to clean up error logging  
+🔧 fix(ws_api.toml.template): Update testnet URL for Binance websocket API 
+
+## 2.0.20 - 2025-04-24
+* On `Binance` now API key type [Ed25519](https://www.binance.com/en/support/faq/detail/6b9a63f1e3384cf48a2eedb82767a69a) is used instead of `HMAC`
+✨ feat(ws_session): implement `compose_binance_ws_auth` for Binance WebSocket authentication  
+🔧 fix(ws_session): update `generate_signature` for improved signature handling  
+🔧 fix(ws_session): handle `None` return in `request` method  
+🚀 chore(requirements): add `cryptography` dependency for signature handling  
+🔧 fix(pyproject): require Python version 3.10 or higher  
+
 ## 2.0.19 - 2025-03-28
 ### Fix
 * `ws_session.ws_login`: Incorrect exit from authentication procedure in case of unsuccessful attempt

{crypto_ws_api-2.0.19 → crypto_ws_api-2.1.0}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.3
 Name: crypto-ws-api
-Version: 2.0.19
+Version: 2.1.0
 Summary: Crypto WS API connector for ASYNC requests
 Author-email: Jerry Fedorenko <jerry.fedorenko@yahoo.com>
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Classifier: Programming Language :: Python :: 3
 Classifier: Development Status :: 5 - Production/Stable
@@ -16,6 +16,7 @@ Requires-Dist: platformdirs==4.3.6
 Requires-Dist: toml~=0.10.2
 Requires-Dist: websockets==15.0.1
 Requires-Dist: ujson~=5.10.0
+Requires-Dist: cryptography~=44.0.2
 Project-URL: Source, https://github.com/DogsTailFarmer/crypto-ws-api
 
 <h1 align="center"><img align="center" src="https://user-images.githubusercontent.com/77513676/250364389-cbedc171-a930-4467-a0cd-21627a6a41ed.svg" width="75">Crypto WS API connector for ASYNC requests</h1>
@@ -25,14 +26,15 @@ Project-URL: Source, https://github.com/DogsTailFarmer/crypto-ws-api
 <h3 align="center">Provides of connection management, keepalive and rate limits control</h3>
 
 ***
-<a href="https://pypi.org/project/crypto-ws-api/"><img src="https://img.shields.io/pypi/v/crypto-ws-api" alt="PyPI version"></a>
-<a href="https://codeclimate.com/github/DogsTailFarmer/crypto-ws-api/maintainability"><img src="https://api.codeclimate.com/v1/badges/2d2a654ba393eb88d911/maintainability" /></a>
+<h1 align="center"><a href="https://pypi.org/project/crypto-ws-api/"><img src="https://img.shields.io/pypi/v/crypto-ws-api" alt="PyPI version"></a>
 <a href="https://app.deepsource.com/gh/DogsTailFarmer/crypto-ws-api/?ref=repository-badge}" target="_blank"><img alt="DeepSource" title="DeepSource" src="https://app.deepsource.com/gh/DogsTailFarmer/crypto-ws-api.svg/?label=resolved+issues&token=TXghPzbi0YWhkCLU8Q1tmDyQ"/></a>
 <a href="https://app.deepsource.com/gh/DogsTailFarmer/crypto-ws-api/?ref=repository-badge}" target="_blank"><img alt="DeepSource" title="DeepSource" src="https://app.deepsource.com/gh/DogsTailFarmer/crypto-ws-api.svg/?label=active+issues&token=TXghPzbi0YWhkCLU8Q1tmDyQ"/></a>
 <a href="https://sonarcloud.io/summary/new_code?id=DogsTailFarmer_crypto-ws-api" target="_blank"><img alt="sonarcloud" title="sonarcloud" src="https://sonarcloud.io/api/project_badges/measure?project=DogsTailFarmer_crypto-ws-api&metric=alert_status"/></a>
 <a href="https://pepy.tech/project/crypto-ws-api" target="_blank"><img alt="Downloads" title="Downloads" src="https://static.pepy.tech/badge/crypto-ws-api"/></a>
+</h1>
+
 ***
-For :heavy_check_mark:Binance, :heavy_check_mark:OKX, :heavy_check_mark:Bitfinex, :heavy_check_mark:HTX
+For :heavy_check_mark:[Binance](https://accounts.binance.com/en/register?ref=FXQ6HY5O), :heavy_check_mark:[OKX](https://okx.com/join/2607649), :heavy_check_mark:[Bitfinex](https://www.bitfinex.com/sign-up?refcode=v_4az2nCP), :heavy_check_mark:[HTX](https://www.htx.com/invite/en-us/1f?invite_code=9uaw3223)
 ***
 
 ## Features

{crypto_ws_api-2.0.19 → crypto_ws_api-2.1.0}/README.md

@@ -5,14 +5,15 @@
 <h3 align="center">Provides of connection management, keepalive and rate limits control</h3>
 
 ***
-<a href="https://pypi.org/project/crypto-ws-api/"><img src="https://img.shields.io/pypi/v/crypto-ws-api" alt="PyPI version"></a>
-<a href="https://codeclimate.com/github/DogsTailFarmer/crypto-ws-api/maintainability"><img src="https://api.codeclimate.com/v1/badges/2d2a654ba393eb88d911/maintainability" /></a>
+<h1 align="center"><a href="https://pypi.org/project/crypto-ws-api/"><img src="https://img.shields.io/pypi/v/crypto-ws-api" alt="PyPI version"></a>
 <a href="https://app.deepsource.com/gh/DogsTailFarmer/crypto-ws-api/?ref=repository-badge}" target="_blank"><img alt="DeepSource" title="DeepSource" src="https://app.deepsource.com/gh/DogsTailFarmer/crypto-ws-api.svg/?label=resolved+issues&token=TXghPzbi0YWhkCLU8Q1tmDyQ"/></a>
 <a href="https://app.deepsource.com/gh/DogsTailFarmer/crypto-ws-api/?ref=repository-badge}" target="_blank"><img alt="DeepSource" title="DeepSource" src="https://app.deepsource.com/gh/DogsTailFarmer/crypto-ws-api.svg/?label=active+issues&token=TXghPzbi0YWhkCLU8Q1tmDyQ"/></a>
 <a href="https://sonarcloud.io/summary/new_code?id=DogsTailFarmer_crypto-ws-api" target="_blank"><img alt="sonarcloud" title="sonarcloud" src="https://sonarcloud.io/api/project_badges/measure?project=DogsTailFarmer_crypto-ws-api&metric=alert_status"/></a>
 <a href="https://pepy.tech/project/crypto-ws-api" target="_blank"><img alt="Downloads" title="Downloads" src="https://static.pepy.tech/badge/crypto-ws-api"/></a>
+</h1>
+
 ***
-For :heavy_check_mark:Binance, :heavy_check_mark:OKX, :heavy_check_mark:Bitfinex, :heavy_check_mark:HTX
+For :heavy_check_mark:[Binance](https://accounts.binance.com/en/register?ref=FXQ6HY5O), :heavy_check_mark:[OKX](https://okx.com/join/2607649), :heavy_check_mark:[Bitfinex](https://www.bitfinex.com/sign-up?refcode=v_4az2nCP), :heavy_check_mark:[HTX](https://www.htx.com/invite/en-us/1f?invite_code=9uaw3223)
 ***
 
 ## Features

{crypto_ws_api-2.0.19 → crypto_ws_api-2.1.0}/crypto_ws_api/__init__.py

@@ -13,7 +13,7 @@ __maintainer__ = "Jerry Fedorenko"
 __contact__ = "https://github.com/DogsTailFarmer"
 __email__ = "jerry.fedorenko@yahoo.com"
 __credits__ = ["https://github.com/DanyaSWorlD"]
-__version__ = "2.0.19"
+__version__ = "2.1.0"
 
 from pathlib import Path
 import shutil

{crypto_ws_api-2.0.19 → crypto_ws_api-2.1.0}/crypto_ws_api/demo.py

@@ -66,8 +66,6 @@ async def get_time(user_session: UserWSSession, _trade_id):
         )
         if res is None:
             logger.warning(CONST_1)
-    except asyncio.CancelledError:
-        pass  # Task cancellation should not be logged as an error
     except Exception as _ex:
         logger.error(CONST_2, _ex)
     else:
@@ -87,8 +85,6 @@ async def current_average_price(user_session: UserWSSession, _trade_id):
         )
         if res is None:
             logger.warning(CONST_1)
-    except asyncio.CancelledError:
-        pass  # Task cancellation should not be logged as an error
     except Exception as _ex:
         logger.error(CONST_2, _ex)
     else:
@@ -101,13 +97,10 @@ async def account_information(user_session: UserWSSession, _trade_id):
         res = await user_session.handle_request(
             _trade_id,
             "account.status",
-            send_api_key=True,
             _signed=True
         )
         if res is None:
             logger.warning(CONST_1)
-    except asyncio.CancelledError:
-        pass  # Task cancellation should not be logged as an error
     except Exception as _ex:
         logger.error(CONST_2, _ex)
     else:

crypto_ws_api-2.1.0/crypto_ws_api/ws_api.toml.template

@@ -0,0 +1,25 @@
+# Parameters for crypto-ws-api connector
+# Copyright © 2023-2025 Jerry Fedorenko aka VM
+# __version__ = "2.0.21"
+
+# region endpoint
+[endpoint]
+    [endpoint.binance]
+        ws_api = 'wss://ws-api.binance.com:443/ws-api/v3'
+        ws_api_test = 'wss://ws-api.testnet.binance.vision:9443/ws-api/v3'
+# endregion
+
+# region Binance accounts
+# How to Generate an Ed25519 Key Pair and Register then on Binance:
+# https://www.binance.com/en/support/faq/detail/6b9a63f1e3384cf48a2eedb82767a69a
+[[accounts]]
+    exchange = 'binance'
+    name = 'Demo - Binance'
+    api_key = '*********** Place API key there ************'
+    api_secret = """
+-----BEGIN PRIVATE KEY-----
+*********** Place Private Ed25519 key there ************
+-----END PRIVATE KEY-----
+"""
+    test_net = true
+# endregion

{crypto_ws_api-2.0.19 → crypto_ws_api-2.1.0}/crypto_ws_api/ws_session.py

@@ -15,6 +15,7 @@ import string
 import random
 from datetime import datetime, timezone
 from urllib.parse import urlencode, urlparse
+from cryptography.hazmat.primitives.serialization import load_pem_private_key
 
 from websockets.asyncio.client import connect
 from websockets import ConnectionClosed
@@ -49,20 +50,40 @@ def set_logger(name, log_file, file_level=logging.INFO, propagate=False):
 
 logger = set_logger(__name__, Path(LOG_PATH, 'ws_session.log'))
 
+
 def generate_signature(exchange: str, secret: str, data: str) -> str:
-    digest_func = hashlib.sha384 if exchange == 'bitfinex' else hashlib.sha256
-    encoding = "ascii" if exchange == 'binance_ws' else "utf-8"
-    key = secret.encode(encoding=encoding)
-    signature = hmac.new(
-        bytes(key) if exchange == 'bybit' else key,
-        data.encode(encoding=encoding),
-        digest_func
-    )
+    encoding = "utf-8"
+    if exchange == 'binance':
+        signature = load_pem_private_key(
+            data=bytes(secret, encoding=encoding), password=None).sign(data.encode("ascii")
+            )
+    else:
+        digest_func = hashlib.sha384 if exchange == 'bitfinex' else hashlib.sha256
+        key = secret.encode(encoding=encoding)
+        signature = hmac.new(
+            bytes(key) if exchange == 'bybit' else key,
+            data.encode(encoding=encoding),
+            digest_func
+        )
     if exchange in {"huobi", "okx"}:
-        return base64.b64encode(signature.digest()).decode()
+        signature = signature.digest()
+
+    if exchange in {"binance", "huobi", "okx"}:
+        return base64.b64encode(signature).decode()
     else:
         return signature.hexdigest()
 
+def compose_binance_ws_auth(_id: str, api_key: str, api_secret: str) -> dict:
+    req = {"id": _id, "method": "session.logon"}
+    params = {
+        "apiKey": api_key,
+        "timestamp": int(time.time() * 1000)
+    }
+    payload = '&'.join(f"{key}={value}" for key, value in sorted(params.items()))
+    params["signature"] = generate_signature('binance', api_secret, payload)
+    req["params"] = params
+    return req
+
 def compose_htx_ws_auth(endpoint, exchange, api_key, api_secret):
     _params = {
         "accessKey": api_key,
@@ -98,7 +119,6 @@ class UserWSS:
         "_api_secret",
         "_passphrase",
         "_ws",
-        "_listen_key",
         "_retry_after",
         "ws_id",
         "operational_status",
@@ -120,7 +140,6 @@ class UserWSS:
         self._api_secret = api_secret
         self._passphrase = passphrase
         self._ws = None
-        self._listen_key = None
         self._response_pool = {}
         self._retry_after = int(time.time() * 1000) - 1
         self.ws_id = ws_id
@@ -148,7 +167,7 @@ class UserWSS:
     async def _ws_listener(self):
         self.tasks_manage(self.ws_login())
         async for msg in self._ws:
-            # logger.info(f"_ws_listener: msg: {self.ws_id}: {msg}")
+            # logger.info(f"_ws_listener: ws_id: {self.ws_id} msg: {msg}")
             if isinstance(msg, str):
                 try:
                     _msg = json.loads(msg)
@@ -172,40 +191,39 @@ class UserWSS:
             else:
                 logger.warning(f"UserWSS: {self.ws_id}: {msg}")
                 await self.stop()
-        logger.warning(f"UserWSS: {self.ws_id}: _ws_listener stopped")
-        await self.stop()
 
     async def start_wss(self):
-        async for self._ws in connect(
-                self.endpoint,
-                logger=self.logger,
-                ping_interval=None if self.exchange == 'huobi' else 20
-        ):
-            try:
-                await self._ws_listener()
-            except ConnectionClosed as ex:
-                if ex.rcvd and ex.rcvd.code == 4000:
-                    logger.info(f"WSS closed for {self.ws_id}")
-                    break
-                else:
-                    self.operational_status = False
-                    [task.cancel() for task in self.tasks if not task.done()]
-                    self.tasks.clear()
-                    logger.warning(f"Restart UserWSS for {self.ws_id}")
-                    continue
-            except Exception as ex:
-                logger.error(f"UserWSS start other exception: {ex}")
+        try:
+            async for self._ws in connect(
+                    self.endpoint,
+                    logger=self.logger,
+                    ping_interval=None if self.exchange in ('binance', 'huobi') else 20
+            ):
+                try:
+                    await self._ws_listener()
+                except ConnectionClosed as ex:
+                    if ex.rcvd and ex.rcvd.code == 4000:
+                        logger.info(f"WSS closed for {self.ws_id}")
+                        break
+                    else:
+                        self.operational_status = False
+                        [task.cancel() for task in self.tasks if not task.done()]
+                        self.tasks.clear()
+                        logger.warning(f"Restart UserWSS for {self.ws_id}")
+                        continue
+                except Exception as ex:
+                    logger.error(f"UserWSS start other exception: {ex}")
+        except asyncio.CancelledError:
+            await self.stop()
+            raise
 
     async def ws_login(self):
-        res = await self.request(CONST_WS_START, send_api_key=True)
+        res = await self.request(CONST_WS_START)
         if res is None:
             logger.warning(f"UserWSS: Not 'logged in' for {self.ws_id}")
             await self.stop()
         else:
-            if self.exchange == 'binance':
-                self._listen_key = res.get('listenKey')
-                self.tasks_manage(self.heartbeat(), f"heartbeat-{self.ws_id}")
-            elif self.exchange == 'huobi':
+            if self.exchange == 'huobi':
                 self.tasks_manage(self.htx_keepalive(), f"htx_keepalive-{self.ws_id}")
 
             self.operational_status = True
@@ -213,10 +231,10 @@ class UserWSS:
             self.tasks_manage(self._keepalive(), f"keepalive-{self.ws_id}")
             logger.info(f"UserWSS: 'logged in' for {self.ws_id}")
 
-    async def request(self, method, _params=None, send_api_key=False, _signed=False):
+    async def request(self, method, _params=None, _signed=False):
         """
         Construct and handling request/response to WS API endpoint, use a description of the methods on
-        https://developers.binance.com/docs/binance-trading-api/websocket_api#request-format
+        https://developers.binance.com/docs/binance-spot-api-docs/websocket-api
         :return: result: {} or None if temporary Out-of-Service state
         """
         if self.request_limit_reached:
@@ -235,7 +253,7 @@ class UserWSS:
         else:
             _id = ''.join(e for e in r_id if e.isalnum())[-ID_LEN_LIMIT.get(self.exchange, 64):]
         await self._ws.send(
-            json.dumps(self.compose_request(_id, send_api_key, method, params, _signed))
+            json.dumps(self.compose_request(_id, method, params, _signed))
         )
         await asyncio.sleep(0)
         try:
@@ -243,8 +261,7 @@ class UserWSS:
         except asyncio.exceptions.TimeoutError:
             logger.warning(f"UserWSS: get response timeout error: {self.ws_id}")
             await self.stop()
-        except asyncio.CancelledError:
-            pass  # Task cancellation should not be logged as an error
+            return None
         else:
             return res
 
@@ -256,10 +273,11 @@ class UserWSS:
                 return self._response_pool.pop(_id)
             elif f"NoneResponse{self.ws_id}" in self._response_pool:
                 return self._response_pool.pop(f"NoneResponse{self.ws_id}", None)
+        return None
 
-    def compose_request(self, _id, send_api_key, method, params, signed):
+    def compose_request(self, _id, method, params, signed):
         if self.exchange == "binance":
-            return self._compose_binance_request(_id, send_api_key, method, params, signed)
+            return self._compose_binance_request(_id, method, params, signed)
         elif self.exchange == "okx":
             return self._compose_okx_request(_id, method, params)
         elif self.exchange == "bitfinex":
@@ -275,18 +293,17 @@ class UserWSS:
         else:
             return {"cid": _id, "ch": method, "params": params}
 
-    def _compose_binance_request(self, _id, send_api_key, method, params, signed):
-        req = {"id": _id, "method": method}
-        params = params or {}
-        if send_api_key:
-            params["apiKey"] = self._api_key
-        if signed:
-            params["timestamp"] = int(time.time() * 1000)
-            payload = '&'.join(f"{key}={value}" for key, value in sorted(params.items()))
-            params["signature"] = generate_signature('binance_ws', self._api_secret, payload)
-        if params:
-            req["params"] = params
-        return req
+    def _compose_binance_request(self, _id, method, params, signed):
+        if method == CONST_WS_START:
+            return compose_binance_ws_auth(_id, self._api_key, self._api_secret)
+        else:
+            req = {"id": _id, "method": method}
+            params = params or {}
+            if signed:
+                params["timestamp"] = int(time.time() * 1000)
+            if params:
+                req["params"] = params
+            return req
 
     def _compose_okx_request(self, _id, method, params):
         if method == CONST_WS_START:
@@ -329,18 +346,6 @@ class UserWSS:
                 logger.info(f"UserWSS order handling status restored for {self.ws_id}")
             await asyncio.sleep(interval)
 
-    async def heartbeat(self, interval=60 * 30):
-        params = {
-            "listenKey": self._listen_key,
-        }
-        while self.operational_status is not None:
-            await self.request(
-                "userDataStream.ping",
-                params,
-                send_api_key=True,
-            )
-            await asyncio.sleep(interval)
-
     async def htx_keepalive(self, interval=60):
         await asyncio.sleep(interval * 10)
         while True:
@@ -395,9 +400,10 @@ class UserWSS:
             if msg.get('code') == 200 or msg.get('status') == 'ok':
                 return msg
 
-            await self.htx_error_handle(msg)
+            self.htx_error_handle(msg)
+        return None
 
-    async def htx_error_handle(self, msg):
+    def htx_error_handle(self, msg):
         if msg.get('code') == 500:
             logger.warning(f"An issue occurred on exchange's side: {msg}")
         elif msg.get('code') in {429, 4000}:
@@ -474,13 +480,13 @@ class UserWSS:
     async def binance_error_handle(self, msg):
         error_msg = msg.get('error')
         logger.error(f"Malformed request: status: {error_msg}")
-        if msg.get('status') == 403:
+        if msg.get('status') in (401, 403):
             await self.stop()
         if msg.get('status') in (418, 429):
             self._retry_after = error_msg.get('data', {}).get('retryAfter', int((time.time() + TIMEOUT) * 1000))
             self.request_limit_reached = True
 
-    def _handle_rate_limits(self, rate_limits: []):
+    def _handle_rate_limits(self, rate_limits: list):
         def retry_after():
             return (int(time.time() / interval) + 1) * interval * 1000
         for rl in rate_limits:
@@ -521,11 +527,14 @@ class UserWSSession:
         trade_id: str,
         method: str,
         _params=None,
-        send_api_key=False,
         _signed=False,
     ):
 
-        ws_id = f"{self.exchange}-{trade_id}-{method}"
+        ws_id = f"{self.exchange}-{trade_id}"
+        if self.exchange in ('binance', 'vertex'):
+            ws_id = f"{ws_id}{'_ST' if _signed else '_SF'}"
+        else:
+            ws_id = f"{ws_id}-{method}"
 
         if ws_id in self.user_wss:
             user_wss = self.user_wss[ws_id]
@@ -557,8 +566,8 @@ class UserWSSession:
             duration += DELAY
 
         try:
-            return await user_wss.request(method=method, _params=_params, send_api_key=send_api_key, _signed=_signed)
-        except asyncio.CancelledError:
+            return await user_wss.request(method=method, _params=_params, _signed=_signed)
+        except KeyboardInterrupt:
             pass  # Task cancellation should not be logged as an error
         except Exception as ex:
             logger.error(f"crypto_ws_api.ws_session.handle_request(): {ex}")

{crypto_ws_api-2.0.19 → crypto_ws_api-2.1.0}/pyproject.toml

@@ -14,14 +14,15 @@ classifiers=["Programming Language :: Python :: 3",
              "Operating System :: Microsoft :: Windows",
              "Operating System :: MacOS"]
 dynamic = ["version", "description"]
-requires-python = ">=3.8"
+requires-python = ">=3.10"
 
 dependencies = [
     "shortuuid~=1.0.13",
     "platformdirs==4.3.6",
     "toml~=0.10.2",
     "websockets==15.0.1",
-    "ujson~=5.10.0"
+    "ujson~=5.10.0",
+    "cryptography~=44.0.2"
 ]
 
 [tool.flit.module]

{crypto_ws_api-2.0.19 → crypto_ws_api-2.1.0}/requirements.txt

@@ -2,4 +2,5 @@ shortuuid~=1.0.13
 platformdirs==4.3.6
 toml~=0.10.2
 websockets==15.0.1
-ujson~=5.10.0
+ujson~=5.10.0
+cryptography~=44.0.2

crypto_ws_api-2.0.19/crypto_ws_api/ws_api.toml.template

@@ -1,19 +0,0 @@
-# Parameters for crypto-ws-api connector
-# Copyright © 2023 Jerry Fedorenko aka VM
-# __version__ = "1.0.0"
-
-# region endpoint
-[endpoint]
-    [endpoint.binance]
-        ws_api = 'wss://ws-api.binance.com:443/ws-api/v3'
-        ws_api_test = 'wss://testnet.binance.vision/ws-api/v3'
-# endregion
-
-# region Binance accounts
-[[accounts]]
-    exchange = 'binance'
-    name = 'Demo - Binance'
-    api_key = '*********** Place API key there ************'
-    api_secret = '*********** Place secret API key there ************'
-    test_net = true
-# endregion