Merge pull request #2 from deltadefi-protocol/doc

add doc

Author: AnsonSIDAN

README.md

@@ -1 +1,108 @@
-# python-sdk
+# DeltaDeFi Python SDK
+
+The DeltaDeFi Python SDK provides a convenient way to interact with the DeltaDeFi API. This SDK allows developers to easily integrate DeltaDeFi's features into their Python applications.
+
+## Installation
+
+To install the SDK, use `pip`:
+
+```sh
+pip install deltadefi-python-sdk
+```
+
+## Requirements
+
+- Python 3.11 or higher
+
+## Usage
+
+### Initialization
+
+To use the SDK, you need to initialize the ApiClient with your API configuration and wallet.
+
+```python
+from deltadefi.api_resources.api_config import ApiConfig
+from deltadefi.clients.clients import ApiClient
+from sidan_gin import HDWallet
+
+# Initialize API configuration
+config = ApiConfig(
+    network="mainnet",
+    jwt="your_jwt_token",
+    apiKey="your_api_key",
+    signingKey="your_signing_key"
+)
+
+# Initialize HDWallet
+wallet = HDWallet("your_wallet_mnemonic")
+
+# Initialize ApiClient
+api_client = ApiClient(config=config, wallet=wallet)
+```
+
+### Accounts
+
+The Accounts client allows you to interact with account-related endpoints.
+
+```python
+from deltadefi.clients.accounts import Accounts
+
+accounts_client = api_client.accounts
+
+# Sign in
+sign_in_request = SignInRequest(auth_key="your_auth_key", wallet_address="your_wallet_address")
+sign_in_response = accounts_client.sign_in(sign_in_request)
+print(sign_in_response)
+
+# Get account balance
+account_balance = accounts_client.get_account_balance()
+print(account_balance)
+```
+
+### Markets
+
+The Markets client allows you to interact with market-related endpoints.
+
+```python
+from deltadefi.clients.markets import Markets
+
+markets_client = api_client.markets
+
+# Get market depth
+market_depth_request = GetMarketDepthRequest(pair="BTC/USD")
+market_depth_response = markets_client.getDepth(market_depth_request)
+print(market_depth_response)
+
+# Get market price
+market_price_request = GetMarketPriceRequest(pair="BTC/USD")
+market_price_response = markets_client.getMarketPrice(market_price_request)
+print(market_price_response)
+```
+
+### Orders
+
+The Orders client allows you to interact with order-related endpoints.
+
+```python
+from deltadefi.clients.orders import Orders
+
+orders_client = api_client.orders
+
+# Build place order transaction
+place_order_request = BuildPlaceOrderTransactionRequest(pair="BTC/USD", amount=1, price=50000)
+place_order_response = orders_client.build_place_order_transaction(place_order_request)
+print(place_order_response)
+
+# Submit place order transaction
+submit_order_request = SubmitPlaceOrderTransactionRequest(order_id="order_id")
+submit_order_response = orders_client.submit_place_order_transaction(submit_order_request)
+print(submit_order_response)
+```
+
+## License
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
+
+```
+http://www.apache.org/licenses/LICENSE-2.0
+```

src/deltadefi/clients/accounts.py

@@ -23,10 +23,29 @@
 
 
 class Accounts:
+    """
+    Accounts client for interacting with the DeltaDeFi API.
+    """
+
     def __init__(self, api_client):
+        """
+        Initialize the Accounts client.
+
+        Args:
+            api_client: An instance of the ApiClient.
+        """
         self.api_client = api_client
 
     def sign_in(self, data: SignInRequest) -> SignInResponse:
+        """
+        Sign in to the DeltaDeFi API.
+
+        Args:
+            data: A SignInRequest object containing the authentication key and wallet address.
+
+        Returns:
+            A SignInResponse object containing the sign-in response.
+        """
         auth_key = data["auth_key"]
         wallet_address = data["wallet_address"]
         headers = {
@@ -42,6 +61,12 @@ def sign_in(self, data: SignInRequest) -> SignInResponse:
         return response.json()
 
     def createNewApiKey(self) -> CreateNewAPIKeyResponse:
+        """
+        Create a new API key.
+
+        Returns:
+            A CreateNewAPIKeyResponse object containing the new API key.
+        """
         response = requests.get(
             f"{self.api_client.base_url}/accounts/new-api-key",
             headers=self.api_client.headers,
@@ -50,6 +75,12 @@ def createNewApiKey(self) -> CreateNewAPIKeyResponse:
         return response.json()
 
     def getDepositRecords(self) -> GetDepositRecordsResponse:
+        """
+        Get deposit records.
+
+        Returns:
+            A GetDepositRecordsResponse object containing the deposit records.
+        """
         response = requests.get(
             f"{self.api_client.base_url}/accounts/deposit-records",
             headers=self.api_client.headers,
@@ -58,6 +89,12 @@ def getDepositRecords(self) -> GetDepositRecordsResponse:
         return response.json()
 
     def getWithdrawalRecords(self) -> GetWithdrawalRecordsResponse:
+        """
+        Get withdrawal records.
+
+        Returns:
+            A GetWithdrawalRecordsResponse object containing the withdrawal records.
+        """
         response = requests.get(
             f"{self.api_client.base_url}/accounts/withdrawal-records",
             headers=self.api_client.headers,
@@ -66,6 +103,12 @@ def getWithdrawalRecords(self) -> GetWithdrawalRecordsResponse:
         return response.json()
 
     def getOrderRecords(self) -> GetOrderRecordResponse:
+        """
+        Get order records.
+
+        Returns:
+            A GetOrderRecordResponse object containing the order records.
+        """
         response = requests.get(
             f"{self.api_client.base_url}/accounts/order-records",
             headers=self.api_client.headers,
@@ -74,6 +117,12 @@ def getOrderRecords(self) -> GetOrderRecordResponse:
         return response.json()
 
     def getAccountBalance(self) -> GetAccountBalanceResponse:
+        """
+        Get account balance.
+
+        Returns:
+            A GetAccountBalanceResponse object containing the account balance.
+        """
         response = requests.get(
             f"{self.api_client.base_url}/accounts/balance",
             headers=self.api_client.headers,
@@ -84,6 +133,15 @@ def getAccountBalance(self) -> GetAccountBalanceResponse:
     def buildDepositTransaction(
         self, data: BuildDepositTransactionRequest
     ) -> BuildDepositTransactionResponse:
+        """
+        Build a deposit transaction.
+
+        Args:
+            data: A BuildDepositTransactionRequest object containing the deposit transaction details.
+
+        Returns:
+            A BuildDepositTransactionResponse object containing the built deposit transaction.
+        """
         response = requests.post(
             f"{self.api_client.base_url}/accounts/deposit/build",
             json=data,
@@ -95,6 +153,15 @@ def buildDepositTransaction(
     def buildWithdrawalTransaction(
         self, data: BuildWithdrawalTransactionRequest
     ) -> BuildWithdrawalTransactionResponse:
+        """
+        Build a withdrawal transaction.
+
+        Args:
+            data: A BuildWithdrawalTransactionRequest object containing the withdrawal transaction details.
+
+        Returns:
+            A BuildWithdrawalTransactionResponse object containing the built withdrawal transaction.
+        """
         response = requests.post(
             f"{self.api_client.base_url}/accounts/withdrawal/build",
             json=data,
@@ -106,6 +173,15 @@ def buildWithdrawalTransaction(
     def submitDepositTransaction(
         self, data: SubmitDepositTransactionRequest
     ) -> SubmitDepositTransactionResponse:
+        """
+        Submit a deposit transaction.
+
+        Args:
+            data: A SubmitDepositTransactionRequest object containing the deposit transaction details.
+
+        Returns:
+            A SubmitDepositTransactionResponse object containing the submitted deposit transaction.
+        """
         response = requests.post(
             f"{self.api_client.base_url}/accounts/deposit/submit",
             json=data,
@@ -117,6 +193,15 @@ def submitDepositTransaction(
     def submitWithdrawalTransaction(
         self, data: SubmitWithdrawalTransactionRequest
     ) -> SubmitWithdrawalTransactionResponse:
+        """
+        Submit a withdrawal transaction.
+
+        Args:
+            data: A SubmitWithdrawalTransactionRequest object containing the withdrawal transaction details.
+
+        Returns:
+            A SubmitWithdrawalTransactionResponse object containing the submitted withdrawal transaction.
+        """
         response = requests.post(
             f"{self.api_client.base_url}/accounts/withdrawal/submit",
             json=data,
@@ -126,6 +211,12 @@ def submitWithdrawalTransaction(
         return response.json()
 
     def getTermsAndCondition(self) -> GetTermsAndConditionResponse:
+        """
+        Get terms and conditions.
+
+        Returns:
+            A GetTermsAndConditionResponse object containing the terms and conditions.
+        """
         response = requests.get(
             f"{self.api_client.base_url}/accounts/terms-and-condition",
             headers=self.api_client.headers,

src/deltadefi/clients/app.py

@@ -4,10 +4,26 @@
 
 
 class App:
+    """
+    App client for interacting with the DeltaDeFi API.
+    """
+
     def __init__(self, api_client):
+        """
+        Initialize the App client.
+
+        Args:
+            api_client: An instance of the ApiClient.
+        """
         self.api_client = api_client
 
     def getTermsAndCondition(self) -> GetTermsAndConditionResponse:
+        """
+        Get terms and conditions.
+
+        Returns:
+            A GetTermsAndConditionResponse object containing the terms and conditions.
+        """
         response = requests.get(
             f"{self.api_client.base_url}/terms-and-conditions",
             headers=self.api_client.headers,

src/deltadefi/clients/clients.py

@@ -13,13 +13,24 @@
 
 
 class ApiClient:
+    """
+    ApiClient for interacting with the DeltaDeFi API.
+    """
 
     def __init__(
         self,
         config: ApiConfig,
         wallet: HDWallet,
         base_url: Optional[str] = None,
     ):
+        """
+        Initialize the ApiClient.
+
+        Args:
+            config: An instance of ApiConfig containing the API configuration.
+            wallet: An instance of HDWallet for signing transactions.
+            base_url: Optional; The base URL for the API. Defaults to "https://api-dev.deltadefi.io".
+        """
         self.base_url = base_url or "https://api-dev.deltadefi.io"
         headers: ApiHeaders = {
             "Content-Type": "application/json",
@@ -44,6 +55,18 @@ def __init__(
         self.markets = Markets(self)
 
     async def post_order(self, data: PostOrderRequest) -> PostOrderResponse:
+        """
+        Post an order to the DeltaDeFi API.
+
+        Args:
+            data: A PostOrderRequest object containing the order details.
+
+        Returns:
+            A PostOrderResponse object containing the response from the API.
+
+        Raises:
+            ValueError: If the wallet is not initialized.
+        """
         if not hasattr(self, "wallet") or self.wallet is None:
             raise ValueError("Wallet is not initialized")