feat: update api

Author: HinsonSIDAN

README.md

@@ -51,11 +51,11 @@ The Market client allows you to interact with market-related endpoints.
 
 ```python
 # Get market depth
-market_depth = api.market.get_depth("ADAUSDX")
+market_depth = api.market.get_depth("ADAUSDM")
 print(market_depth_response)
 
 # Get market price
-market_price_response = api.market.get_market_price("ADAUSDX")
+market_price_response = api.market.get_market_price("ADAUSDM")
 print(market_price_response)
 ```
 
@@ -66,7 +66,7 @@ The Order client allows you to interact with order-related endpoints.
 ```python
 # Build place order transaction
 place_order_request = BuildPlaceOrderTransactionRequest(pair="BTC/USD", amount=1, price=50000)
-place_order_response = api.order.build_place_order_transaction(symbol="ADAUSDX", amount=50, price=0.75, type="limit")
+place_order_response = api.order.build_place_order_transaction(symbol="ADAUSDM", amount=50, price=0.75, type="limit")
 print(place_order_response)
 
 # Submit place order transaction

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "deltadefi"
-version = "0.0.9"
+version = "0.0.10"
 classifiers = [
     "Intended Audience :: Developers",
     "License :: OSI Approved :: Apache Software License",

src/deltadefi/clients/accounts.py

@@ -1,10 +1,11 @@
 #
-from typing import List
+from typing import List, Literal
 
 from sidan_gin import Asset, UTxO
 
 from deltadefi.api import API
 from deltadefi.lib.utils import check_required_parameter, check_required_parameters
+from deltadefi.models.models import OrderStatusType
 from deltadefi.responses import (
     BuildDepositTransactionResponse,
     BuildWithdrawalTransactionResponse,
@@ -71,15 +72,26 @@ def get_withdrawal_records(self, **kwargs) -> GetWithdrawalRecordsResponse:
         url_path = "/withdrawal-records"
         return self.send_request("GET", self.group_url_path + url_path, kwargs)
 
-    def get_order_records(self, **kwargs) -> GetOrderRecordResponse:
+    def get_order_records(
+        self, status: OrderStatusType, **kwargs
+    ) -> GetOrderRecordResponse:
         """
         Get order records.
 
+        Args:
+            status: The status of the order records to retrieve. It can be "openOrder",
+                    "orderHistory", or "tradingHistory".
+            limit: Optional; The maximum number of records to return. Defaults to 10, max 250.
+            page: Optional; The page number for pagination. Defaults to 1.
+
         Returns:
             A GetOrderRecordResponse object containing the order records.
         """
+        check_required_parameter(status, "status")
+        payload = {"status": status, **kwargs}
+
         url_path = "/order-records"
-        return self.send_request("GET", self.group_url_path + url_path, kwargs)
+        return self.send_request("GET", self.group_url_path + url_path, payload)
 
     def get_account_balance(self, **kwargs) -> GetAccountBalanceResponse:
         """

src/deltadefi/clients/clients.py

@@ -66,9 +66,6 @@ def post_order(
         Raises:
             ValueError: If the wallet is not initialized.
         """
-        print(
-            f"post_order: symbol={symbol}, side={side}, type={type}, quantity={quantity}, kwargs={kwargs}"
-        )
         if not hasattr(self, "wallet") or self.wallet is None:
             raise ValueError("Wallet is not initialized")
 

src/deltadefi/clients/order.py

@@ -4,7 +4,6 @@
 from deltadefi.responses import (
     BuildCancelOrderTransactionResponse,
     BuildPlaceOrderTransactionResponse,
-    SubmitCancelOrderTransactionResponse,
     SubmitPlaceOrderTransactionResponse,
 )
 
@@ -105,17 +104,12 @@ def submit_place_order_transaction(
         url_path = "/submit"
         return self.send_request("POST", self.group_url_path + url_path, payload)
 
-    def submit_cancel_order_transaction(
-        self, signed_tx: str, **kwargs
-    ) -> SubmitCancelOrderTransactionResponse:
+    def submit_cancel_order_transaction(self, signed_tx: str, **kwargs):
         """
         Submit a cancel order transaction.
 
         Args:
             data: A SubmitCancelOrderTransactionRequest object containing the cancel order details.
-
-        Returns:
-            A SubmitCancelOrderTransactionResponse object containing the submitted cancel order transaction.
         """
         check_required_parameter(signed_tx, "signed_tx")
         payload = {"signed_tx": signed_tx, **kwargs}

src/deltadefi/constants/constants.py

@@ -1,6 +1,6 @@
 from typing import Literal
 
-TradingPair = Literal["ADAUSDX"]
+TradingPair = Literal["ADAUSDM"]
 TradingSide = Literal["buy", "sell"]
 TradingType = Literal["limit", "market"]
 TimeInForce = Literal["GTC"]

src/deltadefi/models/models.py

@@ -1,9 +1,11 @@
 from dataclasses import dataclass
 from typing import List, Literal
 
-from sidan_gin import Asset
+OrderStatusType = Literal["openOrder", "orderHistory", "tradingHistory"]
 
-OrderStatus = Literal["building", "open", "closed", "failed"]
+OrderStatus = Literal[
+    "open", "fully_filled", "partially_filled", "cancelled", "partially_cancelled"
+]
 
 OrderSide = Literal["buy", "sell"]
 
@@ -20,6 +22,13 @@
 }
 
 
+@dataclass
+class AssetRecord:
+    asset: str
+    asset_unit: str
+    qty: float
+
+
 @dataclass
 class TransactionStatus:
     building = "building"
@@ -50,19 +59,34 @@ class OrderJSON:
 class DepositRecord:
     created_at: str
     status: TransactionStatus
-    assets: List[Asset]
+    assets: List[AssetRecord]
     tx_hash: str
 
 
 @dataclass
 class WithdrawalRecord:
     created_at: str
     status: TransactionStatus
-    assets: List[Asset]
+    assets: List[AssetRecord]
 
 
 @dataclass
 class AssetBalance:
     asset: str
     free: int
     locked: int
+
+
+@dataclass
+class OrderFillingRecordJSON:
+    execution_id: str
+    order_id: str
+    status: OrderStatus
+    symbol: str
+    executed_qty: str
+    side: OrderSide
+    type: OrderType
+    fee_charged: str
+    fee_unit: str
+    executed_price: float
+    created_time: int

src/deltadefi/responses/accounts.py

@@ -4,6 +4,7 @@
 from deltadefi.models.models import (
     AssetBalance,
     DepositRecord,
+    OrderFillingRecordJSON,
     OrderJSON,
     WithdrawalRecord,
 )
@@ -43,6 +44,7 @@ class GetWithdrawalRecordsResponse(List[WithdrawalRecord]):
 @dataclass
 class GetOrderRecordResponse(TypedDict):
     orders: List[OrderJSON]
+    order_filling_records: List[OrderFillingRecordJSON]
 
 
 @dataclass

src/deltadefi/responses/responses.py

@@ -61,8 +61,3 @@ class PostOrderResponse(SubmitPlaceOrderTransactionResponse):
 @dataclass
 class BuildCancelOrderTransactionResponse(TypedDict):
     tx_hex: str
-
-
-@dataclass
-class SubmitCancelOrderTransactionResponse(TypedDict):
-    tx_hash: str

tests/clients/test_accounts.py

@@ -29,6 +29,12 @@ def test_get_account_balance(self):
         response: GetAccountBalanceResponse = self.api.accounts.get_account_balance()
         print(f"response: {response}")
 
+    def test_get_order_records(self):
+        response: GetAccountBalanceResponse = self.api.accounts.get_order_records(
+            "openOrder"
+        )
+        print(f"response: {response}")
+
     # # Assert
     # print(f"response: {response}")
     # self.assertIn("token", response)