trd-utils 0.0.14__py3-none-any.whl → 0.0.16__py3-none-any.whl

trd_utils/exchanges/hyperliquid/hyperliquid_client.py

@@ -0,0 +1,138 @@
+
+from decimal import Decimal
+import json
+import logging
+from typing import Type
+import httpx
+
+from pathlib import Path
+
+from trd_utils.cipher import AESCipher
+from trd_utils.exchanges.exchange_base import ExchangeBase
+from trd_utils.exchanges.hyperliquid.hyperliquid_types import HyperLiquidApiResponse, TraderPositionsInfoResponse
+
+logger = logging.getLogger(__name__)
+
+
+class HyperLiquidClient(ExchangeBase):
+    ###########################################################
+    # region client parameters
+    hyperliquid_api_base_host: str = "https://api.hyperliquid.xyz"
+    hyperliquid_api_base_url: str = "https://api.hyperliquid.xyz"
+    origin_header: str = "app.hyperliquid.xy"
+
+    # 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}.hl")
+
+    # endregion
+    ###########################################################
+    # region info endpoints
+    async def get_trader_positions_info(
+        self,
+        uid: int | str,
+    ) -> TraderPositionsInfoResponse:
+        payload = {
+            "type": "clearinghouseState",
+            "user": f"{uid}",
+        }
+        headers = self.get_headers()
+        return await self.invoke_post(
+            f"{self.hyperliquid_api_base_host}/info",
+            headers=headers,
+            content=payload,
+            model=TraderPositionsInfoResponse,
+        )
+
+    #endregion
+    ###########################################################
+    # region another-thing
+    # async def get_another_thing_info(self, uid: int) -> AnotherThingInfoResponse:
+    #     payload = {
+    #         "uid": uid,
+    #     }
+    #     headers = self.get_headers()
+    #     return await self.invoke_post(
+    #         f"{self.hyperliquid_api_base_url}/another-thing/info",
+    #         headers=headers,
+    #         content=payload,
+    #         model=CopyTraderInfoResponse,
+    #     )
+
+    # 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)
+        target_path.write_text(aes.encrypt(json.dumps(json_data)))
+
+    # endregion
+    ###########################################################

trd_utils/exchanges/hyperliquid/hyperliquid_types.py

@@ -0,0 +1,109 @@
+from decimal import Decimal
+from trd_utils.types_helper import BaseModel
+
+
+###########################################################
+
+
+# region Common types
+
+
+class HyperLiquidApiResponse(BaseModel):
+    time: int = None
+
+
+# endregion
+
+###########################################################
+
+
+# region info types
+
+
+class CumFundingInfo(BaseModel):
+    all_time: str = None
+    since_open: str = None
+    since_change: str = None
+
+
+class LeverageInfo(BaseModel):
+    type: str = None
+    value: int = None
+
+
+class PositionInfo(BaseModel):
+    coin: str = None
+    szi: Decimal = None
+    leverage: LeverageInfo = None
+    entry_px: Decimal = None
+    position_value: Decimal = None
+    unrealized_pnl: Decimal = None
+    return_on_equity: Decimal = None
+    liquidation_px: Decimal = None
+    margin_used: Decimal = None
+    max_leverage: int = None
+    cum_funding: CumFundingInfo = None
+
+    def get_side(self) -> str:
+        if self.szi > 0:
+            return "LONG"
+        elif self.szi < 0:
+            return "SHORT"
+        return "UNKNOWN_SIDE"
+
+    def get_position_id(self) -> str:
+        """
+        As far as I know, the API endpoint does not return the position id,
+        maybe it only returns it to the account owner?
+        In any case, we will have to somehow fake it in order to be able to compare
+        it with other positions...
+        """
+        return (
+            f"{self.coin}-{self.leverage.value}{self.entry_px}"
+        ).encode("utf-8").hex()
+
+    def get_leverage(self) -> str:
+        return f"{self.leverage.value}x ({self.leverage.type})"
+
+    def __repr__(self):
+        return (
+            f"{self.get_side()} {self.get_leverage()} {self.coin} "
+            f"Margin: {self.margin_used}, PNL: {self.unrealized_pnl}"
+        )
+
+    def __str__(self):
+        return self.__repr__()
+
+
+class AssetPosition(BaseModel):
+    type: str = None
+    position: PositionInfo = None
+
+    def __repr__(self):
+        return f"{self.position}; {self.type}"
+
+    def __str__(self):
+        return self.__str__()
+    
+    def get_position_id(self) -> str:
+        return self.position.get_position_id()
+
+
+class MarginSummaryInfo(BaseModel):
+    account_value: Decimal = None
+    total_ntl_pos: Decimal = None
+    total_raw_usd: Decimal = None
+    total_margin_used: Decimal = None
+
+
+class TraderPositionsInfoResponse(BaseModel):
+    margin_summary: MarginSummaryInfo = None
+    cross_margin_summary: MarginSummaryInfo = None
+    cross_maintenance_margin_used: Decimal = None
+    withdrawable: Decimal = None
+    asset_positions: list[AssetPosition] = None
+
+
+# endregion
+
+###########################################################

trd_utils/types_helper/__init__.py

@@ -2,5 +2,5 @@ from .base_model import BaseModel
 
 
 __all__ = [
-    BaseModel,
+    "BaseModel",
 ]

trd_utils/types_helper/base_model.py

@@ -138,7 +138,7 @@ def generic_obj_to_value(
         return expected_type(**value)
 
     if not expected_type_args:
-        if isinstance(value, expected_type):
+        if value is None or isinstance(value, expected_type):
             return value
         return expected_type(value)
 

{trd_utils-0.0.14.dist-info → trd_utils-0.0.16.dist-info}/METADATA

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

trd_utils-0.0.16.dist-info/RECORD

@@ -0,0 +1,31 @@
+trd_utils/__init__.py,sha256=TpbNgwUz9GdaWu47KkuekhUKxSBLfBCjqfgHJ3CAzUc,25
+trd_utils/cipher/__init__.py,sha256=V05KNuzQwCic-ihMVHlC8sENaJGc3I8MCb4pg4849X8,1765
+trd_utils/common_utils/float_utils.py,sha256=W-jv7nzjl88xwGB6gsEXmDDhF6DseOrrVT2qx7OvyCo,266
+trd_utils/date_utils/__init__.py,sha256=Erg_E1TfKWNpiuZFm_NXRjCwoRMfxpPS2-mJK6V4lFM,77
+trd_utils/date_utils/datetime_helpers.py,sha256=Ai9rDCLoMg2dRH8NIBTJQgUSfNQp15Vtp6a1IQwHEbw,366
+trd_utils/exchanges/README.md,sha256=UwkpsfcoLCJaMvJe4yBsFkDpf8P6DOLYhtybb6xWMLc,6738
+trd_utils/exchanges/__init__.py,sha256=x74_8-P7ktZyL-1AuAU_SDQD8eKZMPh1gfkLzPuS1xY,440
+trd_utils/exchanges/base_types.py,sha256=bPsRUetQIHdW7ESMAQcjvX-Z2uixtCC93Vb-XnX6FFs,3229
+trd_utils/exchanges/blofin/__init__.py,sha256=X4r9o4Nyjla4UeOBG8lrgtnGYO2aErFMKaJ7yQrFasE,76
+trd_utils/exchanges/blofin/blofin_client.py,sha256=q9NrAalg8KtyBkDrFKA0Vkq0iw2aIK7SQugzVpPJHds,12261
+trd_utils/exchanges/blofin/blofin_types.py,sha256=LnK3LEVlqU3Vg0Cg1jNmb5GGHQImwI6LCKaDw-aQa6A,4059
+trd_utils/exchanges/bx_ultra/__init__.py,sha256=8Ssy-eOemQR32Nv1-FoPHm87nRqRO4Fm2PU5GHEFKfQ,80
+trd_utils/exchanges/bx_ultra/bx_types.py,sha256=muHLa9lEjIOIDLQCb6xdyxSoQiIMSHErVe0NCoAS-RI,31017
+trd_utils/exchanges/bx_ultra/bx_ultra_client.py,sha256=VcHBhyckn99T8bI_se9u2vyfOHl3w8VPuLrjE16-sQU,24978
+trd_utils/exchanges/bx_ultra/bx_utils.py,sha256=PwapomwDW33arVmKIDj6cL-aP0ptu4BYy_lOCqSAPOo,1392
+trd_utils/exchanges/exchange_base.py,sha256=ZY_9vL9LXtAbAmlWygdVyy0wC-QDla-JGWZ8HMRlkk8,4266
+trd_utils/exchanges/hyperliquid/README.md,sha256=-qaxmDt_9NTus2xRuzyFGkKgYDWgWk7ufHVTSkyn3t4,105
+trd_utils/exchanges/hyperliquid/__init__.py,sha256=QhwGRcneGFHREM-MMdYpbcx-aWdsWsu2WznHzx7LaUM,92
+trd_utils/exchanges/hyperliquid/hyperliquid_client.py,sha256=tEYys_w0sGzxzGdLAUIfl14YTh-zapYwxH0K3B5jBxM,4683
+trd_utils/exchanges/hyperliquid/hyperliquid_types.py,sha256=ueL7Q4yOAK4orlUqeLVNRk6u1AG83pDeGJasTeT3774,2666
+trd_utils/html_utils/__init__.py,sha256=1WWs8C7JszRjTkmzIRLHpxWECHur_DrulTPGIeX88oM,426
+trd_utils/html_utils/html_formats.py,sha256=unKsvOiiDmYTTaM0DYZEUNLEUzWQKKrqASJXvY54kvU,2299
+trd_utils/tradingview/__init__.py,sha256=H0QYb-O5qvy7qC3yswtlcSWLmeBnaS6oJ3JtjvmaV_Y,154
+trd_utils/tradingview/tradingview_client.py,sha256=g_eWYaCRQAL8Kvd-r6AnAdbH7Jha6C_GAyCuxh-RQUU,3917
+trd_utils/tradingview/tradingview_types.py,sha256=z21MXPVdWHAduEl3gSeMIRhxtBN9yK-jPYHfZSMIbSA,6144
+trd_utils/types_helper/__init__.py,sha256=lLbUiW1jUV1gjzTMFLthwkvF0hwauH-F_J2JZq--1U0,67
+trd_utils/types_helper/base_model.py,sha256=cdkvzkjZ1RE__GY98YvhtALHKMux9M4uzcdd8ofQNYU,10617
+trd_utils-0.0.16.dist-info/LICENSE,sha256=J1EP2xt87RjjmsTV1jTjHDQMLIM9FjdwEftTpw8hyv4,1067
+trd_utils-0.0.16.dist-info/METADATA,sha256=vUC58vdFOVmQuZeOra-BglRiwTjzItdZBtEYTCzvOvE,1095
+trd_utils-0.0.16.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+trd_utils-0.0.16.dist-info/RECORD,,

trd_utils-0.0.14.dist-info/RECORD

@@ -1,23 +0,0 @@
-trd_utils/__init__.py,sha256=Q91tBCajUFOuF7TB9Y-VDxL4Kg7YxglI35Ypj_Aww5A,25
-trd_utils/cipher/__init__.py,sha256=V05KNuzQwCic-ihMVHlC8sENaJGc3I8MCb4pg4849X8,1765
-trd_utils/common_utils/float_utils.py,sha256=W-jv7nzjl88xwGB6gsEXmDDhF6DseOrrVT2qx7OvyCo,266
-trd_utils/exchanges/__init__.py,sha256=SQJt5cIXh305miWuDumkOLZHzqDUyOqSmlhTT9Xc9RY,180
-trd_utils/exchanges/blofin/__init__.py,sha256=dQkY9aSbI5fZJDOSbkrbrbpHSbWbJjLEmjpkXxDMDD4,74
-trd_utils/exchanges/blofin/blofin_client.py,sha256=SoA272BtqvG8FpxZYpwWx-flJxHEm1-qVMzklmDYZkQ,11611
-trd_utils/exchanges/blofin/blofin_types.py,sha256=8uTJEMYL3Tq3Q_-yAZ4naGKQdQCgyjVn7bE1GRIr8kA,3845
-trd_utils/exchanges/bx_ultra/__init__.py,sha256=8Ssy-eOemQR32Nv1-FoPHm87nRqRO4Fm2PU5GHEFKfQ,80
-trd_utils/exchanges/bx_ultra/bx_types.py,sha256=muHLa9lEjIOIDLQCb6xdyxSoQiIMSHErVe0NCoAS-RI,31017
-trd_utils/exchanges/bx_ultra/bx_ultra_client.py,sha256=UtWbS__FYyYbYgGvxIrpIkuXLaD4nppP_AyEZWOe5ec,22591
-trd_utils/exchanges/bx_ultra/bx_utils.py,sha256=PwapomwDW33arVmKIDj6cL-aP0ptu4BYy_lOCqSAPOo,1392
-trd_utils/exchanges/exchange_base.py,sha256=SQERi-z9nvDAzuM4oZ3_v-wYWiw_eZV75jmAL2E4MG4,1976
-trd_utils/html_utils/__init__.py,sha256=1WWs8C7JszRjTkmzIRLHpxWECHur_DrulTPGIeX88oM,426
-trd_utils/html_utils/html_formats.py,sha256=unKsvOiiDmYTTaM0DYZEUNLEUzWQKKrqASJXvY54kvU,2299
-trd_utils/tradingview/__init__.py,sha256=H0QYb-O5qvy7qC3yswtlcSWLmeBnaS6oJ3JtjvmaV_Y,154
-trd_utils/tradingview/tradingview_client.py,sha256=g_eWYaCRQAL8Kvd-r6AnAdbH7Jha6C_GAyCuxh-RQUU,3917
-trd_utils/tradingview/tradingview_types.py,sha256=z21MXPVdWHAduEl3gSeMIRhxtBN9yK-jPYHfZSMIbSA,6144
-trd_utils/types_helper/__init__.py,sha256=VlEXDzOyn6fYH-dE86EGJ6u_el08QvdyOtJkj-0EAVA,65
-trd_utils/types_helper/base_model.py,sha256=uy3s_AzMBxCVQEIMQYZZw9a5go327oOEGIl1iIZP-gs,10600
-trd_utils-0.0.14.dist-info/LICENSE,sha256=J1EP2xt87RjjmsTV1jTjHDQMLIM9FjdwEftTpw8hyv4,1067
-trd_utils-0.0.14.dist-info/METADATA,sha256=h6G9UoCSP4YXQfiguu3LwASCqAPx69JOJMncTkYxG44,1095
-trd_utils-0.0.14.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-trd_utils-0.0.14.dist-info/RECORD,,