x10-python-trading-starknet 2.0.0__tar.gz → 2.1.0__tar.gz

{x10_python_trading_starknet-2.0.0 → x10_python_trading_starknet-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: x10-python-trading-starknet
-Version: 2.0.0
+Version: 2.1.0
 Summary: Python client for X10 API
 Home-page: https://github.com/x10xchange/python_sdk
 Author: X10

{x10_python_trading_starknet-2.0.0 → x10_python_trading_starknet-2.1.0}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "x10-python-trading-starknet"
-version = "2.0.0"
+version = "2.1.0"
 description = "Python client for X10 API"
 authors = ["X10 <tech@ex10.org>"]
 repository = "https://github.com/x10xchange/python_sdk"

{x10_python_trading_starknet-2.0.0 → x10_python_trading_starknet-2.1.0}/x10/clients/rest/modules/account_module.py

@@ -14,7 +14,7 @@ from x10.models.base import EmptyModel
 from x10.models.bridge import BridgesConfigModel, QuoteModel
 from x10.models.client import ClientModel
 from x10.models.fee import TradingFeeModel
-from x10.models.order import OpenOrderModel, OrderSide, OrderType
+from x10.models.order import OpenOrderModel, OrderSide, OrderType, Sort
 from x10.models.position import PositionHistoryModel, PositionModel, PositionSide
 from x10.models.trade import AccountTradeModel, TradeType
 from x10.models.transfer import TransferResponseModel
@@ -97,6 +97,7 @@ class AccountModule(BaseModule):
         order_side: Optional[OrderSide] = None,
         cursor: Optional[int] = None,
         limit: Optional[int] = None,
+        sort: Optional[Sort] = None,
     ) -> WrappedApiResponseModel[List[OpenOrderModel]]:
         """
         https://api.docs.extended.exchange/#get-orders-history
@@ -104,7 +105,14 @@ class AccountModule(BaseModule):
 
         url = self._get_url(
             "/user/orders/history",
-            query={"market": market_names, "type": order_type, "side": order_side, "cursor": cursor, "limit": limit},
+            query={
+                "market": market_names,
+                "type": order_type,
+                "side": order_side,
+                "cursor": cursor,
+                "limit": limit,
+                "sort": sort,
+            },
         )
         return await send_get_request(await self._get_session(), url, List[OpenOrderModel], api_key=self._get_api_key())
 

{x10_python_trading_starknet-2.0.0 → x10_python_trading_starknet-2.1.0}/x10/clients/rest/modules/base_module.py

@@ -30,7 +30,10 @@ class BaseModule:
         self.__session = None
 
     def _get_url(self, path: str, *, query: Optional[Dict] = None, **path_params) -> str:
-        return get_url(f"{self.__config.endpoints.api_base_url}{path}", query=query, **path_params)
+        return get_url(f"{self._get_base_url()}{path}", query=query, **path_params)
+
+    def _get_base_url(self) -> str:
+        return self.__config.endpoints.api_base_url
 
     def _get_config(self) -> Config:
         return self.__config

x10_python_trading_starknet-2.1.0/x10/clients/rest/modules/builder_module.py

@@ -0,0 +1,22 @@
+from typing import List, Optional
+
+from x10.clients.rest.modules.base_module import BaseModule
+from x10.models.trade import BuilderTradeModel
+from x10.utils.http import WrappedApiResponseModel, send_get_request
+
+
+class BuilderModule(BaseModule):
+    async def get_trades(
+        self,
+        cursor: Optional[int] = None,
+        limit: Optional[int] = None,
+    ) -> WrappedApiResponseModel[List[BuilderTradeModel]]:
+        """
+        Returns the trades attributed to the authenticated builder, newest first.
+        The response is paginated by trade id via the `cursor`.
+        """
+
+        url = self._get_url("/builder/trades", query={"cursor": cursor, "limit": limit})
+        return await send_get_request(
+            await self._get_session(), url, List[BuilderTradeModel], api_key=self._get_api_key()
+        )

{x10_python_trading_starknet-2.0.0 → x10_python_trading_starknet-2.1.0}/x10/clients/rest/modules/order_management_module.py

@@ -72,3 +72,6 @@ class OrderManagementModule(BaseModule):
             json=request_model.to_api_request_json(exclude_none=True),
             api_key=self._get_api_key(),
         )
+
+    def _get_base_url(self) -> str:
+        return self._get_config().endpoints.api_base_order_management_url

{x10_python_trading_starknet-2.0.0 → x10_python_trading_starknet-2.1.0}/x10/clients/rest/rest_api_client.py

@@ -3,6 +3,7 @@ from decimal import Decimal
 from typing import Dict, Optional
 
 from x10.clients.rest.modules.account_module import AccountModule
+from x10.clients.rest.modules.builder_module import BuilderModule
 from x10.clients.rest.modules.info_module import InfoModule
 from x10.clients.rest.modules.order_management_module import OrderManagementModule
 from x10.clients.rest.modules.testnet_module import TestnetModule
@@ -41,6 +42,7 @@ class RestApiClient:
     __order_management_module: OrderManagementModule
     __vault_module: VaultModule
     __testnet_module: TestnetModule
+    __builder_module: BuilderModule
 
     async def place_order(
         self,
@@ -106,6 +108,7 @@ class RestApiClient:
         await self.__order_management_module.close_session()
         await self.__vault_module.close_session()
         await self.__testnet_module.close_session()
+        await self.__builder_module.close_session()
 
     async def __aenter__(self):
         return self
@@ -131,6 +134,7 @@ class RestApiClient:
             api_key=api_key,
         )
         self.__testnet_module = TestnetModule(config, api_key=api_key, account_module=self.__account_module)
+        self.__builder_module = BuilderModule(config, api_key=api_key)
 
     @property
     def config(self):
@@ -159,3 +163,7 @@ class RestApiClient:
     @property
     def vault(self):
         return self.__vault_module
+
+    @property
+    def builder(self):
+        return self.__builder_module

{x10_python_trading_starknet-2.0.0 → x10_python_trading_starknet-2.1.0}/x10/config.py

@@ -36,6 +36,7 @@ class EndpointsConfig:
 
     chain_rpc_url: str
     api_base_url: str
+    api_base_order_management_url: str
     stream_url: str
     onboarding_url: str
 
@@ -66,6 +67,7 @@ TESTNET_CONFIG = Config(
     endpoints=EndpointsConfig(
         chain_rpc_url="https://rpc.sepolia.org",
         api_base_url="https://api.starknet.sepolia.extended.exchange/api/v1",
+        api_base_order_management_url="https://api.starknet.sepolia.extended.exchange/api/v1",
         stream_url="wss://api.starknet.sepolia.extended.exchange/stream.extended.exchange/v1",
         onboarding_url="https://api.starknet.sepolia.extended.exchange",
         asset_operations_contract="",
@@ -87,6 +89,7 @@ MAINNET_CONFIG = Config(
     endpoints=EndpointsConfig(
         chain_rpc_url="",
         api_base_url="https://api.starknet.extended.exchange/api/v1",
+        api_base_order_management_url="https://api.starknet.extended.exchange/api/v1",
         stream_url="wss://api.starknet.extended.exchange/stream.extended.exchange/v1",
         onboarding_url="https://api.starknet.extended.exchange",
         asset_operations_contract="",

{x10_python_trading_starknet-2.0.0 → x10_python_trading_starknet-2.1.0}/x10/models/order.py

@@ -17,11 +17,17 @@ class OrderSide(StrEnum):
     SELL = "SELL"
 
 
+class Sort(StrEnum):
+    ID = "ID"
+    UPDATED_AT = "UPDATED_AT"
+
+
 class OrderType(StrEnum):
     LIMIT = "LIMIT"
     CONDITIONAL = "CONDITIONAL"
     MARKET = "MARKET"
     TPSL = "TPSL"
+    TWAP = "TWAP"
 
 
 class OrderTpslType(StrEnum):

{x10_python_trading_starknet-2.0.0 → x10_python_trading_starknet-2.1.0}/x10/models/trade.py

@@ -1,4 +1,5 @@
 from decimal import Decimal
+from typing import Optional
 
 from pydantic import AliasChoices, Field
 from strenum import StrEnum
@@ -36,3 +37,22 @@ class AccountTradeModel(X10BaseModel):
     is_taker: bool
     trade_type: TradeType
     created_time: int
+
+
+class BuilderTradeModel(X10BaseModel):
+    """
+    A trade as seen by a builder. Only the side (maker/taker) that belongs to the
+    requesting builder is populated; the counterparty side is masked with `None`.
+    """
+
+    id: int
+    time: int
+    volume: Decimal
+    maker_id: Optional[int] = None
+    taker_id: Optional[int] = None
+    maker_builder_id: Optional[int] = None
+    taker_builder_id: Optional[int] = None
+    maker_fee: Optional[Decimal] = None
+    taker_fee: Optional[Decimal] = None
+    maker_builder_fee: Optional[Decimal] = None
+    taker_builder_fee: Optional[Decimal] = None