trd-utils 0.0.21__tar.gz → 0.0.23__tar.gz

{trd_utils-0.0.21 → trd_utils-0.0.23}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: trd_utils
-Version: 0.0.21
+Version: 0.0.23
 Summary: Common Basic Utils for Python3. By ALiwoto.
 Keywords: utils,trd_utils,basic-utils,common-utils
 Author: ALiwoto

{trd_utils-0.0.21 → trd_utils-0.0.23}/pyproject.toml

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

trd_utils-0.0.23/trd_utils/__init__.py

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

{trd_utils-0.0.21 → trd_utils-0.0.23}/trd_utils/exchanges/__init__.py

@@ -1,4 +1,3 @@
-
 from .exchange_base import ExchangeBase
 from .base_types import (
     UnifiedTraderInfo,
@@ -8,6 +7,7 @@ from .base_types import (
 from .blofin import BlofinClient
 from .bx_ultra import BXUltraClient
 from .hyperliquid import HyperLiquidClient
+from .okx import OkxClient
 
 
 __all__ = [
@@ -18,4 +18,5 @@ __all__ = [
     "BXUltraClient",
     "BlofinClient",
     "HyperLiquidClient",
-]
+    "OkxClient",
+]

{trd_utils-0.0.21 → trd_utils-0.0.23}/trd_utils/exchanges/blofin/blofin_types.py

@@ -1,17 +1,11 @@
-# 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,
-# )
 
+###########################################################
+
+# region common types
 
 
 class BlofinApiResponse(BaseModel):
@@ -26,30 +20,44 @@ class BlofinApiResponse(BaseModel):
         return f"code: {self.code}; timestamp: {self.timestamp}"
 
 
+# endregion
+
 ###########################################################
 
+# region api-config types
+
+
 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
 
+
+# endregion
+
 ###########################################################
 
+# region copy-trader types
+
 
 class CopyTraderInfoResult(BaseModel):
     aum: str = None
@@ -79,9 +87,11 @@ class CopyTraderInfoResult(BaseModel):
     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
@@ -136,14 +146,23 @@ class CopyTraderSingleOrderInfo(BaseModel):
     position_change_history: Any = None
     user_id: Any = None
 
+
 class CopyTraderOrderListResponse(BlofinApiResponse):
     data: list[CopyTraderSingleOrderInfo] = None
 
+
 class CopyTraderAllOrderList(CopyTraderOrderListResponse):
     total_count: int = None
 
+
 class CopyTraderOrderHistoryResponse(BlofinApiResponse):
     data: list[CopyTraderSingleOrderInfo] = None
 
+
 class CopyTraderAllOrderHistory(CopyTraderOrderHistoryResponse):
     total_count: int = None
+
+
+# endregion
+
+###########################################################

{trd_utils-0.0.21 → trd_utils-0.0.23}/trd_utils/exchanges/exchange_base.py

@@ -1,6 +1,6 @@
 from decimal import Decimal
 import json
-from typing import Any, Type
+from typing import Type
 from abc import ABC
 
 import httpx
@@ -72,6 +72,7 @@ class ExchangeBase(ABC):
         params: dict | None = None,
         model_type: Type[BaseModel] | None = None,
         parse_float=Decimal,
+        raw_data: bool = False,
     ) -> "BaseModel":
         """
         Invokes the specific request to the specific url with the specific params and headers.
@@ -81,6 +82,12 @@ class ExchangeBase(ABC):
             headers=headers,
             params=params,
         )
+        if raw_data:
+            return response.content
+
+        if not model_type:
+            return response.json()
+
         return model_type.deserialize(response.json(parse_float=parse_float))
 
     async def invoke_post(
@@ -91,6 +98,7 @@ class ExchangeBase(ABC):
         content: dict | str | bytes = "",
         model_type: Type[BaseModel] | None = None,
         parse_float=Decimal,
+        raw_data: bool = False,
     ) -> "BaseModel":
         """
         Invokes the specific request to the specific url with the specific params and headers.
@@ -105,6 +113,9 @@ class ExchangeBase(ABC):
             params=params,
             content=content,
         )
+        if raw_data:
+            return response.content
+
         if not model_type:
             return response.json()
 

{trd_utils-0.0.21 → trd_utils-0.0.23}/trd_utils/exchanges/hyperliquid/hyperliquid_client.py

@@ -2,7 +2,6 @@
 from decimal import Decimal
 import json
 import logging
-from typing import Type
 import httpx
 
 from pathlib import Path
@@ -11,7 +10,7 @@ from trd_utils.cipher import AESCipher
 from trd_utils.common_utils.wallet_utils import shorten_wallet_address
 from trd_utils.exchanges.base_types import UnifiedPositionInfo, UnifiedTraderInfo, UnifiedTraderPositions
 from trd_utils.exchanges.exchange_base import ExchangeBase
-from trd_utils.exchanges.hyperliquid.hyperliquid_types import HyperLiquidApiResponse, TraderPositionsInfoResponse
+from trd_utils.exchanges.hyperliquid.hyperliquid_types import TraderPositionsInfoResponse
 
 logger = logging.getLogger(__name__)
 

{trd_utils-0.0.21 → trd_utils-0.0.23}/trd_utils/exchanges/hyperliquid/hyperliquid_types.py

@@ -58,19 +58,8 @@ class PositionInfo(BaseModel):
         In any case, we will have to somehow fake it in order to be able to compare
         it with other positions...
         """
-        entry = self.entry_px
-        if entry > 100:
-            entry = round(entry, 1)
-        elif entry > 10:
-            entry = round(entry, 2)
-        elif entry > 1:
-            entry = round(entry, 3)
-        elif entry > 0.1:
-            entry = round(entry, 4)
-        elif entry > 0.01:
-            entry = round(entry, 5)
         return (
-            f"{self.coin}-{self.leverage.value}{self.entry_px}"
+            f"{self.coin}-{self.leverage.value}-{1 if self.szi > 0 else 0}"
         ).encode("utf-8").hex()
 
     def get_leverage(self) -> str:

trd_utils-0.0.23/trd_utils/exchanges/okx/__init__.py

@@ -0,0 +1,6 @@
+from .okx_client import OkxClient
+
+
+__all__ = [
+    "OkxClient",
+]

trd_utils-0.0.23/trd_utils/exchanges/okx/okx_client.py

@@ -0,0 +1,209 @@
+import json
+import logging
+import time
+import httpx
+
+from pathlib import Path
+
+from trd_utils.cipher import AESCipher
+from trd_utils.exchanges.base_types import (
+    UnifiedPositionInfo,
+    UnifiedTraderInfo,
+    UnifiedTraderPositions,
+)
+from trd_utils.exchanges.exchange_base import ExchangeBase
+from trd_utils.exchanges.okx.okx_types import (
+    AppContextUserInfo,
+    CurrentUserPositionsResponse,
+    UserInfoHtmlParser,
+    UserInfoInitialProps,
+)
+
+logger = logging.getLogger(__name__)
+
+BASE_PROFILE_URL = "https://www.okx.com/copy-trading/account/"
+
+
+class OkxClient(ExchangeBase):
+    ###########################################################
+    # region client parameters
+    okx_api_base_host: str = "https://www.okx.com"
+    okx_api_base_url: str = "https://www.okx.com"
+    okx_api_v5_url: str = "https://www.okx.com/priapi/v5"
+    origin_header: str = "https://www.okx.com"
+
+    # endregion
+    ###########################################################
+    # region client constructor
+    def __init__(
+        self,
+        account_name: str = "default",
+        http_verify: bool = True,
+        fav_letter: str = "^",
+        read_session_file: bool = False,
+        sessions_dir: str = "sessions",
+        use_http1: bool = True,
+        use_http2: bool = False,
+    ):
+        # it looks like hyperliquid's api endpoints don't support http2 :(
+        self.httpx_client = httpx.AsyncClient(
+            verify=http_verify,
+            http1=use_http1,
+            http2=use_http2,
+        )
+        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}.okx")
+
+    # endregion
+    ###########################################################
+    # region positions endpoints
+    async def get_trader_positions(
+        self,
+        uid: int | str,
+    ) -> CurrentUserPositionsResponse:
+        params = {
+            "uniqueName": f"{uid}",
+            "t": f"{int(time.time() * 1000)}",
+        }
+        headers = self.get_headers()
+        return await self.invoke_get(
+            f"{self.okx_api_v5_url}/ecotrade/public/community/user/position-current",
+            headers=headers,
+            params=params,
+            model_type=CurrentUserPositionsResponse,
+        )
+
+    # endregion
+    ###########################################################
+    # region another-thing
+
+    async def get_copy_trader_info(
+        self,
+        uid: int | str,
+    ) -> UserInfoInitialProps:
+        params = {
+            "tab": "trade",
+        }
+        headers = self.get_headers()
+        result: bytes = await self.invoke_get(
+            f"{self.okx_api_base_host}/copy-trading/account/{uid}",
+            headers=headers,
+            params=params,
+            model_type=AppContextUserInfo,
+            raw_data=True,
+        )
+        parser = UserInfoHtmlParser("__app_data_for_ssr__")
+        parser.feed(result.decode("utf-8"))
+        if not parser.found_value:
+            raise ValueError("Okx API returned invalid response")
+
+        return AppContextUserInfo(
+            **(json.loads(parser.found_value)["appContext"]),
+        ).initial_props
+
+    # endregion
+    ###########################################################
+    # region client helper methods
+    def get_headers(self, payload=None, needs_auth: bool = False) -> dict:
+        the_headers = {
+            # "Host": self.hyperliquid_api_base_host,
+            "Content-Type": "application/json",
+            "Accept": "application/json",
+            "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
+
+    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.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,
+            "user_agent": self.user_agent,
+        }
+        aes = AESCipher(key=f"bf_{self.account_name}_bf", fav_letter=self._fav_letter)
+        target_path = Path(file_path)
+        if not target_path.exists():
+            target_path.mkdir(parents=True)
+        target_path.write_text(aes.encrypt(json.dumps(json_data)))
+
+    # endregion
+    ###########################################################
+    # region unified methods
+    async def get_unified_trader_positions(
+        self,
+        uid: int | str,
+    ) -> UnifiedTraderPositions:
+        result = await self.get_trader_positions(
+            uid=uid,
+        )
+        unified_result = UnifiedTraderPositions()
+        unified_result.positions = []
+        for position in result.data[0].pos_data:
+            unified_pos = UnifiedPositionInfo()
+            unified_pos.position_id = position.pos_id
+            unified_pos.position_pnl = round(position.realized_pnl, 3)
+            unified_pos.position_side = position.get_side()
+            unified_pos.margin_mode = position.mgn_mode
+            unified_pos.position_leverage = position.lever
+            unified_pos.position_pair = position.get_pair()
+            unified_pos.open_time = position.c_time
+            unified_pos.open_price = position.avg_px
+            unified_pos.open_price_unit = position.quote_ccy
+            unified_result.positions.append(unified_pos)
+
+        return unified_result
+
+    async def get_unified_trader_info(
+        self,
+        uid: int | str,
+    ) -> UnifiedTraderInfo:
+        result = await self.get_copy_trader_info(
+            uid=uid,
+        )
+        account_info = result.pre_process.leader_account_info
+        overview = result.overview_data
+
+        unified_info = UnifiedTraderInfo()
+        unified_info.trader_id = account_info.unique_name or uid
+        unified_info.trader_name = account_info.en_nick_name or account_info.nick_name
+        unified_info.trader_url = f"{BASE_PROFILE_URL}{uid}"
+        unified_info.win_rate = overview.win_rate
+
+        return unified_info
+
+    # endregion
+    ###########################################################

trd_utils-0.0.23/trd_utils/exchanges/okx/okx_types.py

@@ -0,0 +1,197 @@
+from datetime import datetime
+from decimal import Decimal
+from html.parser import HTMLParser
+from typing import Any
+from trd_utils.types_helper import BaseModel
+
+
+###########################################################
+
+# region common types
+
+
+class OkxApiResponse(BaseModel):
+    code: int = None
+    msg: str = None
+
+    def __str__(self):
+        return f"code: {self.code}; timestamp: {self.timestamp}; {getattr(self, 'data', None)}"
+
+    def __repr__(self):
+        return self.__str__()
+
+
+# endregion
+
+###########################################################
+
+# region user-positions types
+
+
+class UserPositionInfo(BaseModel):
+    alias: str = None
+    avg_px: Decimal = None
+    be_px: Decimal = None
+    c_time: datetime = None
+    fee: Decimal = None
+    funding_fee: Decimal = None
+    inst_id: str = None
+    inst_type: str = None
+    last: Decimal = None
+    lever: Decimal = None
+    liq_px: Decimal = None
+    margin: Decimal = None
+    mark_px: Decimal = None
+    mgn_mode: str = None
+    mgn_ratio: Decimal = None
+    notional_usd: int = None
+    pnl: Decimal = None
+    pos: Decimal = None
+    pos_ccy: str = None
+    pos_id: str = None
+    pos_side: str = None  # not that position side
+    quote_ccy: str = None
+    realized_pnl: Decimal = None
+    upl: Decimal = None
+    upl_ratio: Decimal = None
+
+    def get_side(self) -> str:
+        if self.pos > 0:
+            return "LONG"
+        return "SHORT"
+    
+    def get_pair(self) -> str:
+        my_inst = self.inst_id.split("-")
+        if len(my_inst) > 1:
+            if my_inst[1] == "USD":
+                my_inst[1] = "USDT"
+
+            return f"{my_inst[0]}/{my_inst[1]}"
+        # fallback to USDT
+        return f"{self.pos_ccy}/USDT"
+        
+
+
+class CurrentUserPositionsResult(BaseModel):
+    long_lever: Decimal = None
+    short_lever: Decimal = None
+    pos_data: list[UserPositionInfo] = None
+
+
+class CurrentUserPositionsResponse(OkxApiResponse):
+    data: list[CurrentUserPositionsResult] = None
+
+
+# endregion
+
+###########################################################
+
+# region User Info types
+
+
+class UserOverviewData(BaseModel):
+    ccy: str = None
+    equity: Decimal = None
+    max_retreat: Decimal = None
+    onboard_duration: int = None
+    pnl: Decimal = None
+    pnl_ratio: Decimal = None
+    risk_reward_ratio: str = None
+    win_rate: Decimal = None
+    withdrawal: Decimal = None
+
+
+class AuthInfo(BaseModel):
+    is_new_user: bool = None
+    user_guidance: bool = None
+    is_show_smart_copy: bool = None
+    is_cr_market_white_list_user: bool = None
+    is_show_min_entry_mount: bool = None
+    is_show_trader_tier: bool = None
+    auth_info_has_loaded: bool = None
+
+
+class LeaderAccountInfo(BaseModel):
+    unique_name: str = None
+    api_trader: int = None
+    portrait: str = None
+    nick_name: str = None
+    en_nick_name: str = None
+    sign: str = None
+    translated_bio: str = None
+    en_sign: str = None
+    day: int = None
+    count: str = None
+    followee_num: int = None
+    target_id: str = None
+    role_type: int = None
+    spot_role_type: int = None
+    public_status: int = None
+    country_id: str = None
+    is_strategy_lead: bool = None
+    is_signal_trader: bool = None
+    country_name: str = None
+    show_country_tag: bool = None
+    is_chinese: bool = None
+    is_followed: bool = None
+    tier: Any = None
+
+
+class PreProcessUerInfo(BaseModel):
+    leader_account_info: LeaderAccountInfo = None
+    auth_info: AuthInfo = None
+
+
+class UserInfoInitialProps(BaseModel):
+    overview_data: UserOverviewData = None
+    pre_process: PreProcessUerInfo = None
+
+
+class AppContextUserInfo(BaseModel):
+    """
+    The class which holds an AppContext related to a certain user's info
+    on the exchange.
+    """
+
+    initial_props: UserInfoInitialProps = None
+    is_ssr: bool = None
+    faas_use_ssr: bool = None
+    use_ssr: bool = None
+    is_ssr_success: bool = None
+    dsn: str = None
+    template_config: None = None
+    version: str = None
+    project: str = None
+    url_key: str = None
+    trace_id: str = None
+    enable_rtl: bool = None
+    is_apm_proxy_off: int = None
+    is_yandex_off: int = None
+    is_web_worker_enable: int = None
+
+
+class UserInfoHtmlParser(HTMLParser):
+    target_data_id: str = None
+    found_value: str = None
+    current_tag_has_target: bool = None
+
+    def __init__(self, target_data_id: str, **kwargs):
+        super().__init__(**kwargs)
+        self.target_data_id = target_data_id
+        self.found_value = None
+        self.current_tag_has_target = False
+
+    def handle_starttag(self, tag: str, attrs: list[tuple[str, str | None]]):
+        attrs_dict = dict(attrs)
+        if "data-id" in attrs_dict and attrs_dict["data-id"] == self.target_data_id:
+            self.current_tag_has_target = True
+
+    def handle_data(self, data: str):
+        if self.current_tag_has_target:
+            self.found_value = data
+            self.current_tag_has_target = False
+
+
+# endregion
+
+###########################################################

{trd_utils-0.0.21 → trd_utils-0.0.23}/trd_utils/types_helper/base_model.py

@@ -251,7 +251,10 @@ class BaseModel:
             elif expected_type is datetime.datetime:
                 try:
                     if isinstance(value, str):
-                        value = dateutil.parser.parse(value)
+                        if value.isdigit():
+                            value = dt_from_ts(int(value))
+                        else:
+                            value = dateutil.parser.parse(value)
                     elif isinstance(value, int):
                         value = dt_from_ts(value)
                 except Exception as ex:

trd_utils-0.0.21/trd_utils/__init__.py

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