trd-utils 0.0.3__py3-none-any.whl → 0.0.5__py3-none-any.whl

trd_utils/{bx_ultra → exchanges/bx_ultra}/bx_ultra_client.py

@@ -1,8 +1,10 @@
 """BxUltra exchange subclass"""
 
+import asyncio
 from decimal import Decimal
 import json
 import logging
+from typing import Type
 import uuid
 
 import httpx
@@ -10,9 +12,10 @@ import httpx
 import time
 from pathlib import Path
 
-from .common_utils import do_ultra_ss
-from .bx_types import (
+from trd_utils.exchanges.bx_ultra.bx_utils import do_ultra_ss
+from trd_utils.exchanges.bx_ultra.bx_types import (
     AssetsInfoResponse,
+    ContractOrdersHistoryResponse,
     ContractsListResponse,
     CopyTraderTradePositionsResponse,
     HintListResponse,
@@ -24,8 +27,11 @@ from .bx_types import (
     UserFavoriteQuotationResponse,
     ZenDeskABStatusResponse,
     ZoneModuleListResponse,
+    BxApiResponse,
 )
-from ..cipher import AESCipher
+from trd_utils.cipher import AESCipher
+
+from trd_utils.exchanges.exchange_base import ExchangeBase
 
 PLATFORM_ID_ANDROID = "10"
 PLATFORM_ID_WEB = "30"
@@ -42,25 +48,16 @@ TG_APP_VERSION = "5.0.15"
 logger = logging.getLogger(__name__)
 
 
-class BXUltraClient:
+class BXUltraClient(ExchangeBase):
     ###########################################################
     # region client parameters
     we_api_base_host: str = "\u0061pi-\u0061pp.w\u0065-\u0061pi.com"
     we_api_base_url: str = "https://\u0061pi-\u0061pp.w\u0065-\u0061pi.com/\u0061pi"
-
     original_base_host: str = "https://\u0062ing\u0078.co\u006d"
-
     qq_os_base_host: str = "https://\u0061pi-\u0061pp.\u0071\u0071-os.com"
     qq_os_base_url: str = "https://\u0061pi-\u0061pp.\u0071\u0071-os.com/\u0061pi"
 
-    device_id: str = None
-    trace_id: str = None
-    app_version: str = "4.28.3"
-    platform_id: str = "10"
-    install_channel: str = "officialAPK"
-    channel_header: str = "officialAPK"
     origin_header: str = "https://\u0062ing\u0078.co\u006d"
-    authorization_token: str = None
     app_id: str = "30004"
     main_app_id: str = "10009"
     trade_env: str = "real"
@@ -69,12 +66,6 @@ class BXUltraClient:
     device_brand: str = "SM-N976N"
     platform_lang: str = "en"
     sys_lang: str = "en"
-    user_agent: str = "okhttp/4.12.0"
-    x_requested_with: str = None
-    httpx_client: httpx.AsyncClient = None
-    account_name: str = "default"
-
-    _fav_letter: str = "^"
 
     # endregion
     ###########################################################
@@ -87,6 +78,7 @@ class BXUltraClient:
         app_version: str = ANDROID_APP_VERSION,
         http_verify: bool = True,
         fav_letter: str = "^",
+        sessions_dir: str = "sessions",
     ):
         self.httpx_client = httpx.AsyncClient(
             verify=http_verify, http2=True, http1=False
@@ -97,13 +89,15 @@ class BXUltraClient:
         self.app_version = app_version
         self._fav_letter = fav_letter
 
-        self.read_from_session_file(f"{self.account_name}.bx")
+        self.read_from_session_file(f"{sessions_dir}/{self.account_name}.bx")
 
     # endregion
     ###########################################################
     # region api/coin/v1
     async def get_zone_module_info(
-        self, only_one_position: int = 0, biz_type: int = 10
+        self,
+        only_one_position: int = 0,
+        biz_type: int = 10,
     ) -> ZoneModuleListResponse:
         """
         Fetches and returns zone module info from the API.
@@ -116,101 +110,113 @@ class BXUltraClient:
         }
         headers = self.get_headers(params)
         headers["Only_one_position"] = f"{only_one_position}"
-        response = await self.httpx_client.get(
+        return await self.invoke_get(
             f"{self.we_api_base_url}/coin/v1/zone/module-info",
             headers=headers,
             params=params,
+            model=ZoneModuleListResponse,
         )
-        return ZoneModuleListResponse.deserialize(response.json(parse_float=Decimal))
 
     async def get_user_favorite_quotation(
-        self, only_one_position: int = 0, biz_type: int = 1
-    ):
+        self,
+        only_one_position: int = 0,
+        biz_type: int = 1,
+    ) -> UserFavoriteQuotationResponse:
         params = {
             "bizType": f"{biz_type}",
         }
         headers = self.get_headers(params)
         headers["Only_one_position"] = f"{only_one_position}"
-        response = await self.httpx_client.get(
+        return await self.invoke_get(
             f"{self.we_api_base_url}/coin/v1/user/favorite/quotation",
             headers=headers,
             params=params,
-        )
-        return UserFavoriteQuotationResponse.deserialize(
-            response.json(parse_float=Decimal)
+            model=UserFavoriteQuotationResponse,
         )
 
-    async def get_quotation_rank(self, only_one_position: int = 0, order_flag: int = 0):
+    async def get_quotation_rank(
+        self,
+        only_one_position: int = 0,
+        order_flag: int = 0,
+    ) -> QuotationRankResponse:
         params = {
             "orderFlag": f"{order_flag}",
         }
         headers = self.get_headers(params)
         headers["Only_one_position"] = f"{only_one_position}"
-        response = await self.httpx_client.get(
+        return await self.invoke_get(
             f"{self.we_api_base_url}/coin/v1/rank/quotation-rank",
             headers=headers,
             params=params,
+            model=QuotationRankResponse,
         )
-        return QuotationRankResponse.deserialize(response.json(parse_float=Decimal))
 
-    async def get_hot_search(self, only_one_position: int = 0, biz_type: int = 30):
+    async def get_hot_search(
+        self,
+        only_one_position: int = 0,
+        biz_type: int = 30,
+    ) -> HotSearchResponse:
         params = {
             "bizType": f"{biz_type}",
         }
         headers = self.get_headers(params)
         headers["Only_one_position"] = f"{only_one_position}"
-        response = await self.httpx_client.get(
+        return await self.invoke_get(
             f"{self.we_api_base_url}/coin/v1/quotation/hot-search",
             headers=headers,
             params=params,
+            model=HotSearchResponse,
         )
-        return HotSearchResponse.deserialize(response.json(parse_float=Decimal))
 
-    async def get_homepage(self, only_one_position: int = 0, biz_type: int = 30):
+    async def get_homepage(
+        self,
+        only_one_position: int = 0,
+        biz_type: int = 30,
+    ) -> HomePageResponse:
         params = {
             "biz-type": f"{biz_type}",
         }
         headers = self.get_headers(params)
         headers["Only_one_position"] = f"{only_one_position}"
-        response = await self.httpx_client.get(
+        return await self.invoke_get(
             f"{self.we_api_base_url}/coin/v1/discovery/homepage",
             headers=headers,
             params=params,
+            model=HomePageResponse,
         )
-        return HomePageResponse.deserialize(response.json(parse_float=Decimal))
 
     # endregion
     ###########################################################
     # region customer
-    async def get_zendesk_ab_status(self):
+    async def get_zendesk_ab_status(self) -> ZenDeskABStatusResponse:
         headers = self.get_headers()
-        response = await self.httpx_client.get(
+        return await self.invoke_get(
             f"{self.we_api_base_url}/customer/v1/zendesk/ab-status",
             headers=headers,
+            model=ZenDeskABStatusResponse,
         )
-        return ZenDeskABStatusResponse.deserialize(response.json(parse_float=Decimal))
 
     # endregion
     ###########################################################
     # region platform-tool
     async def get_hint_list(self) -> HintListResponse:
         headers = self.get_headers()
-        response = await self.httpx_client.get(
+        return await self.invoke_get(
             f"{self.we_api_base_url}/platform-tool/v1/hint/list",
             headers=headers,
+            model=HintListResponse,
         )
-        return HintListResponse.deserialize(response.json(parse_float=Decimal))
 
     # endregion
     ###########################################################
     # region asset-manager
     async def get_assets_info(self) -> AssetsInfoResponse:
         headers = self.get_headers(needs_auth=True)
-        response = await self.httpx_client.get(
+        return await self.invoke_get(
             f"{self.we_api_base_url}/asset-manager/v1/assets/account-total-overview",
             headers=headers,
+            model=AssetsInfoResponse,
         )
-        return AssetsInfoResponse.deserialize(response.json(parse_float=Decimal))
 
     # endregion
     ###########################################################
@@ -234,12 +240,140 @@ class BXUltraClient:
         if margin_coin_name:
             params["marginCoinName"] = margin_coin_name
         headers = self.get_headers(params, needs_auth=True)
-        response = await self.httpx_client.get(
+        return await self.invoke_get(
             f"{self.we_api_base_url}/v4/contract/order/hold",
             headers=headers,
             params=params,
+            model=ContractsListResponse,
+        )
+
+    async def get_contract_order_history(
+        self,
+        fund_type: int = 1,
+        paging_size: int = 10,
+        page_id: int = 0,
+        from_order_no: int = 0,
+        margin_coin_name: str = "USDT",
+        margin_type: int = 0,
+    ) -> ContractOrdersHistoryResponse:
+        params = {
+            "fundType": f"{fund_type}",
+            "pagingSize": f"{paging_size}",
+            "pageId": f"{page_id}",
+            "marginCoinName": margin_coin_name,
+            "marginType": f"{margin_type}",
+        }
+        if from_order_no:
+            params["fromOrderNo"] = f"{from_order_no}"
+
+        headers = self.get_headers(params, needs_auth=True)
+        return await self.invoke_get(
+            f"{self.we_api_base_url}/v2/contract/order/history",
+            headers=headers,
+            params=params,
+            model=ContractOrdersHistoryResponse,
+        )
+
+    async def get_today_contract_earnings(
+        self,
+        margin_coin_name: str = "USDT",
+        page_size: int = 10,
+        max_total_size: int = 500,
+        delay_per_fetch: float = 1.0,
+    ) -> Decimal:
+        """
+        Fetches today's earnings from the contract orders.
+        NOTE: This method is a bit slow due to the API rate limiting.
+        NOTE: If the user has not opened ANY contract orders today,
+            this method will return None.
+        """
+        return await self._get_period_contract_earnings(
+            period="day",
+            margin_coin_name=margin_coin_name,
+            page_size=page_size,
+            max_total_size=max_total_size,
+            delay_per_fetch=delay_per_fetch,
+        )
+
+    async def get_this_week_contract_earnings(
+        self,
+        margin_coin_name: str = "USDT",
+        page_size: int = 10,
+        max_total_size: int = 500,
+        delay_per_fetch: float = 1.0,
+    ) -> Decimal:
+        """
+        Fetches this week's earnings from the contract orders.
+        NOTE: This method is a bit slow due to the API rate limiting.
+        NOTE: If the user has not opened ANY contract orders this week,
+            this method will return None.
+        """
+        return await self._get_period_contract_earnings(
+            period="week",
+            margin_coin_name=margin_coin_name,
+            page_size=page_size,
+            max_total_size=max_total_size,
+            delay_per_fetch=delay_per_fetch,
+        )
+
+    async def get_this_month_contract_earnings(
+        self,
+        margin_coin_name: str = "USDT",
+        page_size: int = 10,
+        max_total_size: int = 500,
+        delay_per_fetch: float = 1.0,
+    ) -> Decimal:
+        """
+        Fetches this month's earnings from the contract orders.
+        NOTE: This method is a bit slow due to the API rate limiting.
+        NOTE: If the user has not opened ANY contract orders this week,
+            this method will return None.
+        """
+        return await self._get_period_contract_earnings(
+            period="month",
+            margin_coin_name=margin_coin_name,
+            page_size=page_size,
+            max_total_size=max_total_size,
+            delay_per_fetch=delay_per_fetch,
         )
-        return ContractsListResponse.deserialize(response.json(parse_float=Decimal))
+
+    async def _get_period_contract_earnings(
+        self,
+        period: str,
+        margin_coin_name: str = "USDT",
+        page_size: int = 10,
+        max_total_size: int = 500,
+        delay_per_fetch: float = 1.0,
+    ) -> Decimal:
+        total_fetched = 0
+        total_earnings = Decimal("0.00")
+        has_earned_any = False
+        while total_fetched < max_total_size:
+            current_page = total_fetched // page_size
+            result = await self.get_contract_order_history(
+                page_id=current_page,
+                paging_size=page_size,
+                margin_coin_name=margin_coin_name,
+            )
+            if period == "day":
+                temp_earnings = result.get_today_earnings()
+            elif period == "week":
+                temp_earnings = result.get_this_week_earnings()
+            elif period == "month":
+                temp_earnings = result.get_this_month_earnings()
+            if temp_earnings is None:
+                # all ended
+                break
+            total_earnings += temp_earnings
+            has_earned_any = True
+            total_fetched += page_size
+            if result.get_orders_len() < page_size:
+                break
+            await asyncio.sleep(delay_per_fetch)
+
+        if not has_earned_any:
+            return None
+        return total_earnings
 
     # endregion
     ###########################################################
@@ -260,13 +394,11 @@ class BXUltraClient:
             "copyTradeLabelType": f"{copy_trade_label_type}",
         }
         headers = self.get_headers(params)
-        response = await self.httpx_client.get(
+        return await self.invoke_get(
             f"{self.we_api_base_url}/copy-trade-facade/v2/real/trader/positions",
             headers=headers,
             params=params,
-        )
-        return CopyTraderTradePositionsResponse.deserialize(
-            response.json(parse_float=Decimal)
+            model=CopyTraderTradePositionsResponse,
         )
 
     async def search_copy_traders(
@@ -298,25 +430,25 @@ class BXUltraClient:
             "nickName": nick_name,
         }
         headers = self.get_headers(payload)
-        response = await self.httpx_client.post(
+        return await self.invoke_post(
             f"{self.we_api_base_url}/v6/copy-trade/search/search",
             headers=headers,
             params=params,
-            content=json.dumps(payload, separators=(",", ":"), sort_keys=True),
+            content=payload,
+            model=SearchCopyTradersResponse,
         )
-        return SearchCopyTradersResponse.deserialize(response.json(parse_float=Decimal))
 
     # endregion
     ###########################################################
     # region welfare
     async def do_daily_check_in(self):
         headers = self.get_headers(needs_auth=True)
-        response = await self.httpx_client.post(
+        return await self.invoke_post(
             f"{self.original_base_host}/api/act-operation/v1/welfare/sign-in/do",
             headers=headers,
             content="",
+            model=None,
         )
-        return response.json()
 
     # endregion
     ###########################################################
@@ -352,7 +484,7 @@ class BXUltraClient:
                 payload_data=payload,
             ),
             "Timestamp": f"{the_timestamp}",
-            # 'Accept-Encoding': 'gzip, deflate',
+            'Accept-Encoding': 'gzip, deflate',
             "User-Agent": self.user_agent,
             "Connection": "close",
             "appsiteid": "0",
@@ -365,6 +497,51 @@ class BXUltraClient:
             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[BxApiResponse] | None = None,
+        parse_float=Decimal,
+    ) -> "BxApiResponse":
+        """
+        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[BxApiResponse] | None = None,
+        parse_float=Decimal,
+    ) -> "BxApiResponse":
+        """
+        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("BXUltraClient closed")

trd_utils/{bx_ultra/common_utils.py → exchanges/bx_ultra/bx_utils.py}

@@ -1,9 +1,7 @@
 import hashlib
 import json
 import uuid
-from decimal import Decimal
 
-default_quantize = Decimal("1.00")
 
 default_e: str = (
     "\u0039\u0035\u0064\u0036\u0035\u0063\u0037\u0033\u0064\u0063\u0035"
@@ -17,12 +15,6 @@ long_accept_header1: str = (
     + "image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7"
 )
 
-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")
-
 def do_ultra_ss(
     e_param: str,
     se_param: str,

trd_utils/exchanges/exchange_base.py

@@ -0,0 +1,76 @@
+
+from decimal import Decimal
+from typing import Any
+from abc import ABC
+
+import httpx
+
+
+class ExchangeBase(ABC):
+    ###########################################################
+    # region client parameters
+    user_agent: str = "okhttp/4.12.0"
+    x_requested_with: str = None
+    httpx_client: httpx.AsyncClient = None
+    account_name: str = "default"
+    sessions_dir: str = "sessions"
+
+    authorization_token: str = None
+    device_id: str = None
+    trace_id: str = None
+    app_version: str = "4.28.3"
+    platform_id: str = "10"
+    install_channel: str = "officialAPK"
+    channel_header: str = "officialAPK"
+
+    _fav_letter: str = "^"
+    # endregion
+    ###########################################################
+    # region client helper methods
+    def get_headers(self, payload=None, needs_auth: bool = False) -> dict:
+        pass
+
+    async def invoke_get(
+        self,
+        url: str,
+        headers: dict | None,
+        params: dict | None,
+        model: Any,
+        parse_float=Decimal,
+    ) -> Any:
+        """
+        Invokes the specific request to the specific url with the specific params and headers.
+        """
+        pass
+
+    async def invoke_post(
+        self,
+        url: str,
+        headers: dict | None = None,
+        params: dict | None = None,
+        content: str | bytes = "",
+        model: None = None,
+        parse_float=Decimal,
+    ):
+        """
+        Invokes the specific request to the specific url with the specific params and headers.
+        """
+        pass
+
+    async def aclose(self) -> None:
+        pass
+
+    def read_from_session_file(self, file_path: str) -> None:
+        """
+        Reads from session file; if it doesn't exist, creates it.
+        """
+        pass
+
+    def _save_session_file(self, file_path: str) -> None:
+        """
+        Saves current information to the session file.
+        """
+        pass
+
+    # endregion
+    ###########################################################