trd-utils 0.0.3__tar.gz → 0.0.5__tar.gz

{trd_utils-0.0.3 → trd_utils-0.0.5}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 ALi.w
+Copyright (c) 2024-2025 ALi.w
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{trd_utils-0.0.3 → trd_utils-0.0.5}/PKG-INFO

@@ -1,8 +1,7 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: trd_utils
-Version: 0.0.3
+Version: 0.0.5
 Summary: Common Basic Utils for Python3. By ALiwoto.
-Home-page: https://github.com/ALiwoto/trd_utils
 Keywords: utils,trd_utils,basic-utils,common-utils
 Author: ALiwoto
 Author-email: aminnimaj@gmail.com
@@ -20,9 +19,20 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: cryptography (>=41.0.7)
 Requires-Dist: httpx (>=0.21.0)
+Project-URL: Homepage, https://github.com/ALiwoto/trd_utils
 Description-Content-Type: text/markdown
 
 # Trd Utils
 
 Basic common utils for Python.
 
+## How to run tests
+
+Use this command first:
+
+```bash
+pip install -e .
+```
+
+Then run the tests in vscode.
+

trd_utils-0.0.5/README.md

@@ -0,0 +1,13 @@
+# Trd Utils
+
+Basic common utils for Python.
+
+## How to run tests
+
+Use this command first:
+
+```bash
+pip install -e .
+```
+
+Then run the tests in vscode.

{trd_utils-0.0.3 → trd_utils-0.0.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "trd_utils"
-version = "0.0.3"
+version = "0.0.5"
 description = "Common Basic Utils for Python3. By ALiwoto."
 authors = ["ALiwoto <aminnimaj@gmail.com>"]
 packages = [

trd_utils-0.0.5/trd_utils/__init__.py

@@ -0,0 +1,3 @@
+
+__version__ = "0.0.5"
+

trd_utils-0.0.5/trd_utils/common_utils/float_utils.py

@@ -0,0 +1,11 @@
+
+from decimal import Decimal
+
+
+default_quantize = Decimal("1.00")
+
+def dec_to_str(dec_value: Decimal) -> str:
+    return format(dec_value.quantize(default_quantize), "f")
+
+def dec_to_normalize(dec_value: Decimal) -> str:
+    return format(dec_value.normalize(), "f")

trd_utils-0.0.5/trd_utils/exchanges/__init__.py

@@ -0,0 +1,11 @@
+
+from .exchange_base import ExchangeBase
+from .blofin import BlofinClient
+from .bx_ultra import BXUltraClient
+
+
+__all__ = [
+    ExchangeBase,
+    BXUltraClient,
+    BlofinClient,
+]

trd_utils-0.0.5/trd_utils/exchanges/blofin/__init__.py

@@ -0,0 +1,6 @@
+
+from .blofin_client import BlofinClient
+
+__all__ = [
+    BlofinClient,
+]

trd_utils-0.0.5/trd_utils/exchanges/blofin/blofin_client.py

@@ -0,0 +1,238 @@
+from decimal import Decimal
+import json
+import logging
+from typing import Type
+import httpx
+
+import time
+from pathlib import Path
+
+from trd_utils.exchanges.blofin.blofin_types import (
+    BlofinApiResponse,
+    CmsColorResponse,
+    CopyTraderInfoResponse,
+    CopyTraderOrderHistoryResponse,
+    CopyTraderOrderListResponse,
+    ShareConfigResponse,
+)
+from trd_utils.cipher import AESCipher
+from trd_utils.exchanges.exchange_base import ExchangeBase
+
+logger = logging.getLogger(__name__)
+
+
+class BlofinClient(ExchangeBase):
+    ###########################################################
+    # region client parameters
+    blofin_api_base_host: str = "https://\u0062lofin.co\u006d"
+    blofin_api_base_url: str = "https://\u0062lofin.co\u006d/uapi/v1"
+    origin_header: str = "https://\u0062lofin.co\u006d"
+
+    timezone: str = "Etc/UTC"
+
+    # endregion
+    ###########################################################
+    # region client constructor
+    def __init__(
+        self,
+        account_name: str = "default",
+        http_verify: bool = True,
+        fav_letter: str = "^",
+        read_session_file: bool = True,
+        sessions_dir: str = "sessions",
+    ):
+        self.httpx_client = httpx.AsyncClient(
+            verify=http_verify,
+            http2=True,
+            http1=False,
+        )
+        self.account_name = account_name
+        self._fav_letter = fav_letter
+        self.sessions_dir = sessions_dir
+
+        if read_session_file:
+            self.read_from_session_file(f"{sessions_dir}/{self.account_name}.bf")
+
+    # endregion
+    ###########################################################
+    # region v1/cms/
+    async def get_share_config(self) -> ShareConfigResponse:
+        headers = self.get_headers()
+        return await self.invoke_get(
+            f"{self.blofin_api_base_url}/cms/share_config",
+            headers=headers,
+            model=ShareConfigResponse,
+        )
+
+    async def get_cms_color(self) -> CmsColorResponse:
+        headers = self.get_headers()
+        return await self.invoke_get(
+            f"{self.blofin_api_base_url}/cms/color",
+            headers=headers,
+            model=CmsColorResponse,
+        )
+
+    # endregion
+    ###########################################################
+    # region copy/trader
+    async def get_copy_trader_info(self, uid: int) -> CopyTraderInfoResponse:
+        payload = {
+            "uid": uid,
+        }
+        headers = self.get_headers()
+        return await self.invoke_post(
+            f"{self.blofin_api_base_url}/copy/trader/info",
+            headers=headers,
+            content=payload,
+            model=CopyTraderInfoResponse,
+        )
+
+    async def get_copy_trader_order_list(
+        self,
+        from_param: int,
+        limit_param: 0,
+        uid: int,
+    ) -> CopyTraderOrderListResponse:
+        payload = {
+            "from": from_param,
+            "limit": limit_param,
+            "uid": uid,
+        }
+        headers = self.get_headers()
+        return await self.invoke_post(
+            f"{self.blofin_api_base_url}/copy/trader/order/list",
+            headers=headers,
+            content=payload,
+            model=CopyTraderOrderListResponse,
+        )
+    
+    async def get_copy_trader_order_history(
+        self,
+        from_param: int,
+        limit_param: 0,
+        uid: int,
+    ) -> CopyTraderOrderHistoryResponse:
+        payload = {
+            "from": from_param,
+            "limit": limit_param,
+            "uid": uid,
+        }
+        headers = self.get_headers()
+        return await self.invoke_post(
+            f"{self.blofin_api_base_url}/copy/trader/order/history",
+            headers=headers,
+            content=payload,
+            model=CopyTraderOrderHistoryResponse,
+        )
+
+    # endregion
+    ###########################################################
+    # region client helper methods
+    def get_headers(self, payload=None, needs_auth: bool = False) -> dict:
+        the_timestamp = int(time.time() * 1000)
+        the_headers = {
+            # "Host": self.blofin_api_base_host,
+            "Content-Type": "application/json",
+            "Accept": "application/json",
+            "Origin": self.origin_header,
+            "X-Tz": self.timezone,
+            "Fp-Request-Id": f"{the_timestamp}.n1fDrN",
+            "Accept-Encoding": "gzip, deflate, br, zstd",
+            "User-Agent": self.user_agent,
+            "Connection": "close",
+            "appsiteid": "0",
+        }
+
+        if self.x_requested_with:
+            the_headers["X-Requested-With"] = self.x_requested_with
+
+        if needs_auth:
+            the_headers["Authorization"] = f"Bearer {self.authorization_token}"
+        return the_headers
+
+    async def invoke_get(
+        self,
+        url: str,
+        headers: dict | None = None,
+        params: dict | None = None,
+        model: Type[BlofinApiResponse] | None = None,
+        parse_float=Decimal,
+    ) -> "BlofinApiResponse":
+        """
+        Invokes the specific request to the specific url with the specific params and headers.
+        """
+        response = await self.httpx_client.get(
+            url=url,
+            headers=headers,
+            params=params,
+        )
+        return model.deserialize(response.json(parse_float=parse_float))
+
+    async def invoke_post(
+        self,
+        url: str,
+        headers: dict | None = None,
+        params: dict | None = None,
+        content: dict | str | bytes = "",
+        model: Type[BlofinApiResponse] | None = None,
+        parse_float=Decimal,
+    ) -> "BlofinApiResponse":
+        """
+        Invokes the specific request to the specific url with the specific params and headers.
+        """
+
+        if isinstance(content, dict):
+            content = json.dumps(content, separators=(",", ":"), sort_keys=True)
+
+        response = await self.httpx_client.post(
+            url=url,
+            headers=headers,
+            params=params,
+            content=content,
+        )
+        if not model:
+            return response.json()
+
+        return model.deserialize(response.json(parse_float=parse_float))
+
+    async def aclose(self) -> None:
+        await self.httpx_client.aclose()
+        logger.info("BlofinClient closed")
+        return True
+
+    def read_from_session_file(self, file_path: str) -> None:
+        """
+        Reads from session file; if it doesn't exist, creates it.
+        """
+        # check if path exists
+        target_path = Path(file_path)
+        if not target_path.exists():
+            return self._save_session_file(file_path=file_path)
+
+        aes = AESCipher(key=f"bf_{self.account_name}_bf", fav_letter=self._fav_letter)
+        content = aes.decrypt(target_path.read_text()).decode("utf-8")
+        json_data: dict = json.loads(content)
+
+        self.authorization_token = json_data.get(
+            "authorization_token",
+            self.authorization_token,
+        )
+        self.timezone = json_data.get("timezone", self.timezone)
+        self.user_agent = json_data.get("user_agent", self.user_agent)
+
+    def _save_session_file(self, file_path: str) -> None:
+        """
+        Saves current information to the session file.
+        """
+
+        json_data = {
+            "authorization_token": self.authorization_token,
+            "timezone": self.timezone,
+            "user_agent": self.user_agent,
+        }
+        aes = AESCipher(key=f"bf_{self.account_name}_bf", fav_letter=self._fav_letter)
+        target_path = Path(file_path)
+        target_path.write_text(aes.encrypt(json.dumps(json_data)))
+
+    # endregion
+    ###########################################################

trd_utils-0.0.5/trd_utils/exchanges/blofin/blofin_types.py

@@ -0,0 +1,144 @@
+# from typing import Any, Optional
+# from decimal import Decimal
+# from datetime import datetime, timedelta
+# import pytz
+
+from decimal import Decimal
+from typing import Any
+from trd_utils.types_helper import BaseModel
+
+# from trd_utils.common_utils.float_utils import (
+#     dec_to_str,
+#     dec_to_normalize,
+# )
+
+
+
+class BlofinApiResponse(BaseModel):
+    code: int = None
+    timestamp: int = None
+    msg: str = None
+
+    def __str__(self):
+        return f"code: {self.code}; timestamp: {self.timestamp}"
+
+    def __repr__(self):
+        return f"code: {self.code}; timestamp: {self.timestamp}"
+
+
+###########################################################
+
+class PnlShareListInfo(BaseModel):
+    background_color: str = None
+    background_img_up: str = None
+    background_img_down: str = None
+
+class ShareConfigResult(BaseModel):
+    pnl_share_list: list[PnlShareListInfo] = None
+
+class ShareConfigResponse(BlofinApiResponse):
+    data: ShareConfigResult = None
+
+class CmsColorResult(BaseModel):
+    color: str = None
+    city: str = None
+    country: str = None
+    ip: str = None
+
+class CmsColorResponse(BlofinApiResponse):
+    data: CmsColorResult = None
+
+###########################################################
+
+
+class CopyTraderInfoResult(BaseModel):
+    aum: str = None
+    can_copy: bool = None
+    copier_whitelist: bool = None
+    follow_state: int = None
+    followers: int = None
+    followers_max: int = None
+    forbidden_follow_type: int = None
+    hidden_all: bool = None
+    hidden_order: bool = None
+    joined_date: int = None
+    max_draw_down: Decimal = None
+    nick_name: str = None
+    order_amount_limit: None
+    profile: str = None
+    profit_sharing_ratio: Decimal = None
+    real_pnl: Decimal = None
+    roi_d7: Decimal = None
+    self_introduction: str = None
+    sharing_period: str = None
+    source: int = None
+    uid: int = None
+    whitelist_copier: bool = None
+    win_rate: Decimal = None
+
+    def get_profile_url(self) -> str:
+        return f"https://blofin.com/copy-trade/details/{self.uid}"
+
+class CopyTraderInfoResponse(BlofinApiResponse):
+    data: CopyTraderInfoResult = None
+
+class CopyTraderSingleOrderInfo(BaseModel):
+    id: int = None
+    symbol: str = None
+    leverage: int = None
+    order_side: str = None
+    avg_open_price: str = None
+    quantity: str = None
+    quantity_cont: None
+    open_time: int = None
+    close_time: Any = None
+    avg_close_price: Decimal = None
+    real_pnl: Any = None
+    close_type: Any = None
+    roe: Decimal = None
+    followers_profit: Decimal = None
+    followers: Any = None
+    order_id: Any = None
+    sharing: Any = None
+    order_state: None
+    trader_name: None
+    mark_price: None
+    tp_trigger_price: None
+    tp_order_type: None
+    sl_trigger_price: None
+    sl_order_type: None
+    margin_mode: str = None
+    time_in_force: None
+    position_side: str = None
+    order_category: None
+    price: None
+    fill_quantity: None
+    fill_quantity_cont: None
+    pnl: None
+    cancel_source: None
+    order_type: None
+    order_open_state: None
+    amount: None
+    filled_amount: None
+    create_time: None
+    update_time: None
+    open_fee: None
+    close_fee: None
+    id_md5: None
+    tp_sl: None
+    trader_uid: None
+    available_quantity: None
+    available_quantity_cont: None
+    show_in_kline: None
+    unrealized_pnl: None
+    unrealized_pnl_ratio: None
+    broker_id: None
+    position_change_history: None
+    user_id: None
+
+class CopyTraderOrderListResponse(BlofinApiResponse):
+    data: list[CopyTraderSingleOrderInfo] = None
+
+
+class CopyTraderOrderHistoryResponse(BlofinApiResponse):
+    data: list[CopyTraderSingleOrderInfo] = None

{trd_utils-0.0.3/trd_utils → trd_utils-0.0.5/trd_utils/exchanges}/bx_ultra/bx_types.py

@@ -1,8 +1,11 @@
 from typing import Any, Optional
-from ..types_helper import BaseModel
 from decimal import Decimal
+from datetime import datetime, timedelta
+import pytz
 
-from .common_utils import (
+from trd_utils.types_helper import BaseModel
+
+from trd_utils.common_utils.float_utils import (
     dec_to_str,
     dec_to_normalize,
 )
@@ -690,6 +693,7 @@ class ContractOrderInfo(BaseModel):
     close_type: int = None
     status: ContractOrderStatus = None
     open_date: str = None
+    close_date: str = None
     fees: Decimal = None
     lever_fee: Decimal = None
     name: str = None
@@ -730,7 +734,8 @@ class ContractOrderInfo(BaseModel):
         return self.sys_force_price
     
     def get_profit_str(self) -> str:
-        profit_or_loss = self.current_price - self.display_price
+        last_price = self.current_price or self.display_close_price
+        profit_or_loss = last_price - self.display_price
         profit_percentage = (profit_or_loss / self.display_price) * 100
         profit_percentage *= 1 if self.is_long() else -1
         return dec_to_str(profit_percentage * self.lever_times)
@@ -755,8 +760,10 @@ class ContractOrderInfo(BaseModel):
         if self.sys_force_price:
             result_str += f"liquidation: {dec_to_normalize(self.sys_force_price)}{separator}"
         
-        result_str += f"current price: {dec_to_normalize(self.current_price)}{separator}"
-        
+        if self.current_price:
+            result_str += f"current price: {dec_to_normalize(self.current_price)}{separator}"
+        elif self.display_close_price:
+            result_str += f"close price: {dec_to_normalize(self.display_close_price)}{separator}"
         profit_str = self.get_profit_str()
         result_str += f"profit: {profit_str}%"
 
@@ -768,6 +775,11 @@ class ContractOrderInfo(BaseModel):
     def __repr__(self):
         return self.to_str()
 
+class ClosedContractOrderInfo(ContractOrderInfo):
+    close_type_name: str = None
+    gross_earnings: Decimal = None
+    position_order: int = None
+
 class MarginStatInfo(BaseModel):
     name: str = None
     margin_coin_name: str = None
@@ -783,3 +795,87 @@ class ContractsListResult(BaseModel):
 
 class ContractsListResponse(BxApiResponse):
     data: ContractsListResult = None
+
+class ContractOrdersHistoryResult(BaseModel):
+    orders: list[ClosedContractOrderInfo] = None
+    page_id: int = None
+
+class ContractOrdersHistoryResponse(BxApiResponse):
+    data: ContractOrdersHistoryResult = None
+
+    def get_today_earnings(self, timezone: Any = pytz.UTC) -> Decimal:
+        """
+        Returns the total earnings for today.
+        NOTE: This function will return None if there are no orders for today.
+        """
+        found_any_for_today: bool = False
+        today_earnings = Decimal("0.00")
+        today = datetime.now(timezone).date()
+        for current_order in self.data.orders:
+            # check if the date is for today
+            closed_date = datetime.strptime(
+                current_order.close_date,
+                '%Y-%m-%dT%H:%M:%S.%f%z',
+            ).astimezone(timezone).date()
+            if closed_date == today:
+                today_earnings += current_order.gross_earnings
+                found_any_for_today = True
+        
+        if not found_any_for_today:
+            return None
+
+        return today_earnings
+    
+    def get_this_week_earnings(self, timezone: Any = pytz.UTC) -> Decimal:
+        """
+        Returns the total earnings for this week.
+        NOTE: This function will return None if there are no orders for this week.
+        """
+        found_any_for_week: bool = False
+        week_earnings = Decimal("0.00")
+        today = datetime.now(timezone).date()
+        week_start = today - timedelta(days=today.weekday())
+        for current_order in self.data.orders:
+            # check if the date is for this week
+            closed_date = datetime.strptime(
+                current_order.close_date,
+                '%Y-%m-%dT%H:%M:%S.%f%z',
+            ).astimezone(timezone).date()
+            if closed_date >= week_start:
+                week_earnings += current_order.gross_earnings
+                found_any_for_week = True
+        
+        if not found_any_for_week:
+            return None
+
+        return week_earnings
+
+    def get_this_month_earnings(self, timezone: Any = pytz.UTC) -> Decimal:
+        """
+        Returns the total earnings for this month.
+        NOTE: This function will return None if there are no orders for this month.
+        """
+        found_any_for_month: bool = False
+        month_earnings = Decimal("0.00")
+        today = datetime.now(timezone).date()
+        month_start = today.replace(day=1)
+        for current_order in self.data.orders:
+            # check if the date is for this month
+            closed_date = datetime.strptime(
+                current_order.close_date,
+                '%Y-%m-%dT%H:%M:%S.%f%z',
+            ).astimezone(timezone).date()
+            if closed_date >= month_start:
+                month_earnings += current_order.gross_earnings
+                found_any_for_month = True
+        
+        if not found_any_for_month:
+            return None
+
+        return month_earnings
+
+    def get_orders_len(self) -> int:
+        if not self.data or not self.data.orders:
+            return 0
+        return len(self.data.orders)
+