avantis-trader-sdk 0.3.1__tar.gz → 0.5.0__tar.gz

{avantis_trader_sdk-0.3.1 → avantis_trader_sdk-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: avantis_trader_sdk
-Version: 0.3.1
+Version: 0.5.0
 Summary: SDK for interacting with Avantis trading contracts.
 Home-page: https://avantisfi.com/
 Author: Avantis Labs
@@ -62,7 +62,7 @@ To get started with the Avantis Trader SDK, follow these steps to install the pa
 2. Install the SDK using pip:
 
    ```bash
-    pip install avantis-trader-sdk==0.2.1
+    pip install avantis-trader-sdk
    ```
 
    or

{avantis_trader_sdk-0.3.1 → avantis_trader_sdk-0.5.0}/README.md

@@ -47,7 +47,7 @@ To get started with the Avantis Trader SDK, follow these steps to install the pa
 2. Install the SDK using pip:
 
    ```bash
-    pip install avantis-trader-sdk==0.2.1
+    pip install avantis-trader-sdk
    ```
 
    or

avantis_trader_sdk-0.5.0/avantis_trader_sdk/__init__.py

@@ -0,0 +1,26 @@
+from .client import TraderClient
+from .feed.feed_client import FeedClient
+from .signers.base import BaseSigner
+
+__version__ = "0.5.0"
+
+print(
+    f"""
+---------------------------------------------------------------------------------
+⚠️ IMPORTANT: Avantis Contracts v1.5 Upgrade
+
+Breaking changes are being introduced as part of the v1.5 Contracts Upgrade. 
+If you're using this SDK, please review the details to ensure compatibility.
+
+Details: https://avantisfi.notion.site/avantis-contracts-v1-5-upgrade
+
+Milestone 1: Scheduled for 24th January 2025
+- Updates to PairStorage, PairInfos, and Multicall contracts.
+
+Milestone 2: Date TBD
+- Updates to Trading, Referral, TradingStorage, TradingCallbacks, and more.
+
+Ensure your integration is updated to avoid disruptions.
+---------------------------------------------------------------------------------
+"""
+)

{avantis_trader_sdk-0.3.1 → avantis_trader_sdk-0.5.0}/avantis_trader_sdk/client.py

@@ -137,6 +137,12 @@ class TraderClient:
         if self.has_signer() and "from" not in kwargs:
             kwargs["from"] = self.get_signer().get_ethereum_address()
 
+        if "chainId" not in kwargs:
+            kwargs["chainId"] = self.chain_id
+
+        if "nonce" not in kwargs:
+            kwargs["nonce"] = await self.get_transaction_count(kwargs["from"])
+
         transaction = await contract.functions[function_name](*args).build_transaction(
             kwargs
         )

{avantis_trader_sdk-0.3.1 → avantis_trader_sdk-0.5.0}/avantis_trader_sdk/rpc/fee_parameters.py

@@ -75,28 +75,19 @@ class FeeParametersRPC:
         is_long: Optional[bool] = None,
         pair_index: int = None,
         pair: str = None,
-        trade_input: TradeInput = None,
     ):
         """
-        Retrieves the opening fee for all trading pairs.
+        Retrieves the opening fee for all trading pairs in bps.
 
         Args:
             is_long: A boolean indicating if the position is a buy or sell. Defaults to None. If None, the opening fee for both buy and sell will be returned.
             position_size: The size of the position (collateral * leverage). Supports upto 6 decimals. Defaults to 0.
             pair_index: The pair index for which the opening fee is to be calculated. Defaults to None. If None, the opening fee for all trading pairs will be returned.
             pair: The trading pair for which the opening fee is to be calculated. Defaults to None. If None, the opening fee for all trading pairs will be returned.
-            trade_input: The trade input object. Defaults to None. If provided, the pair index will be extracted from the trade input.
 
         Returns:
-            A Fee instance containing the opening Fee for each trading pair in bps or final opening fee in USDC if trade_input is provided.
+            A Fee instance containing the opening Fee for each trading pair in bps.
         """
-        if trade_input is not None:
-            position_size = (
-                trade_input.positionSizeUSDC / 10**6 * trade_input.leverage / 10**10
-            )
-            pair_index = trade_input.pairIndex
-            is_long = trade_input.buy
-
         position_size = int(position_size * 10**6)
 
         Multicall = self.client.contracts.get("Multicall")
@@ -204,16 +195,43 @@ class FeeParametersRPC:
                     ],
                 )
                 return Fee(short=decoded_response)
-        elif trade_input is not None:
-            referral_rebate_percentage = await self.client.trading_parameters.get_trade_referral_rebate_percentage(
-                trade_input.trader
-            )
-            referral_rebate_percentage = 1 - (referral_rebate_percentage / 100)
-            return round(
-                response / 10**12 * position_size / 10**6 * referral_rebate_percentage,
-                18,
-            )
         elif is_long:
             return Fee(long={pair: response / 10**10 * 100})
         else:
             return Fee(short={pair: response / 10**10 * 100})
+
+    async def get_new_trade_opening_fee(
+        self,
+        trade_input: TradeInput,
+    ):
+        """
+        Retrieves the opening fee for a trade with referral rebate in USDC.
+
+        Args:
+            trade_input: The trade input object.
+
+        Returns:
+            Final opening fee in USDC
+        """
+        position_size = (
+            trade_input.positionSizeUSDC / 10**6 * trade_input.leverage / 10**10
+        )
+
+        position_size = int(position_size * 10**6)
+
+        PriceAggregator = self.client.contracts.get("PriceAggregator")
+
+        response = await PriceAggregator.functions.openFeeP(
+            trade_input.pairIndex, position_size, trade_input.buy
+        ).call()
+
+        referral_rebate_percentage = (
+            await self.client.trading_parameters.get_trade_referral_rebate_percentage(
+                trade_input.trader
+            )
+        )
+        referral_rebate_percentage = 1 - (referral_rebate_percentage / 100)
+        return round(
+            response / 10**12 * position_size / 10**6 * referral_rebate_percentage,
+            18,
+        )

{avantis_trader_sdk-0.3.1 → avantis_trader_sdk-0.5.0}/avantis_trader_sdk/rpc/trade.py

@@ -236,6 +236,8 @@ class TradeRPC:
         if trader is None:
             trader = self.client.get_signer().get_ethereum_address()
 
+        collateral_to_close = int(collateral_to_close * 10**6)
+
         execution_fee = await self.get_trade_execution_fee()
 
         transaction = await Trading.functions.closeTradeMarket(
@@ -308,7 +310,6 @@ class TradeRPC:
             trader = self.client.get_signer().get_ethereum_address()
 
         collateral_change = int(collateral_change * 10**6)
-        fee_in_wei = 1 * 10**18
 
         feed_client = self.FeedClient()
 
@@ -328,8 +329,65 @@ class TradeRPC:
             {
                 "from": trader,
                 "chainId": self.client.chain_id,
-                "value": fee_in_wei,
+                "value": 1,
+                "nonce": await self.client.get_transaction_count(trader),
+            }
+        )
+
+        return transaction
+
+    async def build_trade_tp_sl_update_tx(
+        self,
+        pair_index: int,
+        trade_index: int,
+        take_profit_price: float,
+        stop_loss_price: float,
+        trader: str = None,
+    ):
+        """
+        Builds a transaction to update the stop loss and take profit of a trade.
+
+        Args:
+            pair_index: The pair index.
+            trade_index: The trade index.
+            take_profit_price: The take profit price.
+            stop_loss_price: The stop loss price. Pass 0 if you want to remove the stop loss.
+            trader (optional): The trader's wallet address.
+        Returns:
+            A transaction object.
+        """
+        Trading = self.client.contracts.get("Trading")
+
+        if take_profit_price == 0:
+            raise ValueError("Take profit price cannot be 0")
+
+        if trader is None:
+            trader = self.client.get_signer().get_ethereum_address()
+
+        feed_client = self.FeedClient()
+
+        pair_name = await self.client.pairs_cache.get_pair_name_from_index(pair_index)
+
+        price_data = await feed_client.get_latest_price_updates([pair_name])
+
+        price_update_data = "0x" + price_data.binary.data[0]
+
+        take_profit_price = int(take_profit_price * 10**10)
+        stop_loss_price = int(stop_loss_price * 10**10)
+
+        transaction = await Trading.functions.updateTpAndSl(
+            pair_index,
+            trade_index,
+            stop_loss_price,
+            take_profit_price,
+            [price_update_data],
+        ).build_transaction(
+            {
+                "from": trader,
+                "chainId": self.client.chain_id,
+                "value": 1,
                 "nonce": await self.client.get_transaction_count(trader),
+                "gas": 1_000_000,
             }
         )
 

{avantis_trader_sdk-0.3.1 → avantis_trader_sdk-0.5.0}/avantis_trader_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: avantis-trader-sdk
-Version: 0.3.1
+Version: 0.5.0
 Summary: SDK for interacting with Avantis trading contracts.
 Home-page: https://avantisfi.com/
 Author: Avantis Labs
@@ -62,7 +62,7 @@ To get started with the Avantis Trader SDK, follow these steps to install the pa
 2. Install the SDK using pip:
 
    ```bash
-    pip install avantis-trader-sdk==0.2.1
+    pip install avantis-trader-sdk
    ```
 
    or

{avantis_trader_sdk-0.3.1 → avantis_trader_sdk-0.5.0}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name="avantis_trader_sdk",
-    version="0.3.1",
+    version="0.5.0",
     author="Avantis Labs",
     author_email="brank@avantisfi.com",
     description="SDK for interacting with Avantis trading contracts.",

avantis_trader_sdk-0.3.1/avantis_trader_sdk/__init__.py

@@ -1,5 +0,0 @@
-from .client import TraderClient
-from .feed.feed_client import FeedClient
-from .signers.base import BaseSigner
-
-__version__ = "0.2.1"