avantis-trader-sdk 0.3.1__py3-none-any.whl → 0.6.0__py3-none-any.whl

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/config.py

@@ -1,11 +1,11 @@
 MAINNET_ADDRESSES = {
     "TradingStorage": "0x8a311D7048c35985aa31C131B9A13e03a5f7422d",
-    "PairStorage": "0x92Ed158d5e423CFdc9eed5Bd7328FFF7CeD6fF94",
+    "PairStorage": "0x5db3772136e5557EFE028Db05EE95C84D76faEC4",
     "PairInfos": "0x81F22d0Cc22977c91bEfE648C9fddf1f2bd977e5",
     "PriceAggregator": "0x64e2625621970F8cfA17B294670d61CB883dA511",
     "USDC": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
     "Trading": "0x5FF292d70bA9cD9e7CCb313782811b3D7120535f",
-    "Multicall": "0x06B145b672dc04BBA9821e2172728FEEa0D12Ec5",
+    "Multicall": "0xD4693314460d6fb598C1124aeC40C03e2Aa0A8a4",
     "Referral": "0xA96f577821933d127B491D0F91202405B0dbB1bd",
 }
 

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/rpc/pairs_cache.py

@@ -1,4 +1,4 @@
-from ..types import PairInfo
+from ..types import PairInfoWithData
 
 
 class PairsCache:
@@ -35,15 +35,31 @@ class PairsCache:
 
             calls = []
             for pair_index in range(pairs_count):
-                call_data = PairStorage.encodeABI(fn_name="pairs", args=[pair_index])
-                calls.append((PairStorage.address, call_data))
+                core_call_data = PairStorage.encodeABI(
+                    fn_name="pairs", args=[pair_index]
+                )
+                pair_data_call_data = PairStorage.encodeABI(
+                    fn_name="getPairData", args=[pair_index]
+                )
+                calls.extend(
+                    [
+                        (PairStorage.address, core_call_data),
+                        (PairStorage.address, pair_data_call_data),
+                    ]
+                )
 
             _, raw_data = await Multicall.functions.aggregate(calls).call()
 
             decoded_data = []
-            for data in raw_data:
-                decoded = self.client.utils["decoder"](PairStorage, "pairs", data)
-                decoded_data.append(PairInfo(**decoded))
+            for i in range(0, len(raw_data), 2):
+                pair_info = self.client.utils["decoder"](
+                    PairStorage, "pairs", raw_data[i]
+                )
+                pair_data = self.client.utils["decoder"](
+                    PairStorage, "getPairData", raw_data[i + 1]
+                )
+                pair_info.update(pair_data)
+                decoded_data.append(PairInfoWithData(**pair_info))
 
             for index, pair_info in enumerate(decoded_data):
                 if not pair_info.from_:

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/types.py

@@ -13,6 +13,22 @@ import re
 
 
 class PairInfoFeed(BaseModel):
+    max_open_deviation_percentage: float = Field(..., alias="maxOpenDeviationP")
+    max_close_deviation_percentage: float = Field(..., alias="maxCloseDeviationP")
+
+    feed_id: str = Field(..., alias="feedId")
+
+    @field_validator(
+        "max_open_deviation_percentage", "max_close_deviation_percentage", mode="before"
+    )
+    def convert_max_deviation(cls, v):
+        return v / 10**10
+
+    class Config:
+        populate_by_name = True
+
+
+class PairInfoBackupFeed(BaseModel):
     max_deviation_percentage: float = Field(..., alias="maxDeviationP")
     feed_id: str = Field(..., alias="feedId")
 
@@ -21,26 +37,52 @@ class PairInfoFeed(BaseModel):
         return v / 10**10
 
 
+class PairInfoLeverages(BaseModel):
+    min_leverage: float = Field(..., alias="minLeverage")
+    max_leverage: float = Field(..., alias="maxLeverage")
+    pnl_min_leverage: float = Field(..., alias="pnlMinLeverage")
+    pnl_max_leverage: float = Field(..., alias="pnlMaxLeverage")
+
+    @field_validator(
+        "min_leverage",
+        "max_leverage",
+        "pnl_min_leverage",
+        "pnl_max_leverage",
+        mode="before",
+    )
+    def convert_max_deviation(cls, v):
+        return v / 10**10
+
+
+class PairInfoValues(BaseModel):
+    max_gain_percentage: float = Field(..., alias="maxGainP")
+    max_sl_percentage: float = Field(..., alias="maxSlP")
+    max_long_oi_percentage: float = Field(..., alias="maxLongOiP")
+    max_short_oi_percentage: float = Field(..., alias="maxShortOiP")
+    group_open_interest_percentage: float = Field(
+        ..., alias="groupOpenInterestPecentage"
+    )
+    max_wallet_oi_percentage: float = Field(..., alias="maxWalletOI")
+    is_usdc_aligned: bool = Field(..., alias="isUSDCAligned")
+
+
 class PairInfo(BaseModel):
-    from_: str = Field(..., alias="from")
-    to: str
     feed: PairInfoFeed
-    backup_feed: PairInfoFeed = Field(..., alias="backupFeed")
+    backup_feed: PairInfoBackupFeed = Field(..., alias="backupFeed")
     constant_spread_bps: float = Field(..., alias="spreadP")
+    constant_pnl_spread_bps: float = Field(..., alias="pnlSpreadP")
+    leverages: PairInfoLeverages = Field(..., alias="leverages")
     price_impact_parameter: float = Field(..., alias="priceImpactMultiplier")
     skew_impact_parameter: float = Field(..., alias="skewImpactMultiplier")
     group_index: int = Field(..., alias="groupIndex")
     fee_index: int = Field(..., alias="feeIndex")
-    group_open_interest_percentage: float = Field(
-        ..., alias="groupOpenInterestPecentage"
-    )
-    max_wallet_oi: float = Field(..., alias="maxWalletOI")
+    values: PairInfoValues = Field(..., alias="values")
 
     @field_validator("price_impact_parameter", "skew_impact_parameter", mode="before")
     def convert_to_float_10(cls, v):
         return v / 10**10
 
-    @field_validator("constant_spread_bps", mode="before")
+    @field_validator("constant_spread_bps", "constant_pnl_spread_bps", mode="before")
     def convert_to_float_10_bps(cls, v):
         return v / 10**10 * 100
 
@@ -48,6 +90,26 @@ class PairInfo(BaseModel):
         populate_by_name = True
 
 
+class PairData(BaseModel):
+    from_: str = Field(..., alias="from")
+    to: str
+    num_tiers: int = Field(..., alias="numTiers")
+    tier_thresholds: Dict[str, float] = Field(..., alias="tierThresholds")
+    tier_timers: Dict[str, float] = Field(..., alias="timer")
+
+    @field_validator("tier_thresholds", "tier_timers", mode="before")
+    def convert_tuple_to_dict(cls, v):
+        if isinstance(v, tuple):
+            return {str(i): j for i, j in enumerate(v)}
+        return v
+
+
+class PairInfoWithData(PairInfo, PairData):
+    class Config:
+        populate_by_name = True
+        from_attributes = True
+
+
 class OpenInterest(BaseModel):
     long: Dict[str, float]
     short: Dict[str, float]
@@ -82,7 +144,7 @@ class DepthSingle(BaseModel):
     below: float
 
 
-class PairInfoExtended(PairInfo):
+class PairInfoExtended(PairInfoWithData):
     asset_open_interest_limit: float
     asset_open_interest: Dict[str, float]
     asset_utilization: float

{avantis_trader_sdk-0.3.1.dist-info → avantis_trader_sdk-0.6.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: avantis-trader-sdk
-Version: 0.3.1
+Version: 0.6.0
 Summary: SDK for interacting with Avantis trading contracts.
 Home-page: https://avantisfi.com/
 Author: Avantis Labs
@@ -70,7 +70,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.dist-info → avantis_trader_sdk-0.6.0.dist-info}/RECORD

@@ -1,7 +1,7 @@
-avantis_trader_sdk/__init__.py,sha256=XfcfMCSlyYvs5_uVHDGSOxLxOpaHLclcjsirqmcXLS4,139
-avantis_trader_sdk/client.py,sha256=QfljOKja32K89bl0_PTvcT0QrF2WX2yS3lIxNjU5mAA,11068
-avantis_trader_sdk/config.py,sha256=ieqm9dAcbdmarBp7UfIHQQYSDx5KlVZ6OmZvxjacPeE,585
-avantis_trader_sdk/types.py,sha256=6B4t21ohWiyB9yZEfTC7ckznzgFFIW93z_J2m6_azPU,11754
+avantis_trader_sdk/__init__.py,sha256=JUFO-X_UKaXCpgw3D34f1vlKoiykNf3eRBkYkeb9slg,917
+avantis_trader_sdk/client.py,sha256=OPyVhE6g41_Uek1C95PT6h1YJRjDnsQ6cGZZ-1XV2XM,11271
+avantis_trader_sdk/config.py,sha256=3nubC4ClH15JJ71Z3MJuvEwkBP5R-paIhHOEfQ9WFnM,585
+avantis_trader_sdk/types.py,sha256=aJRfFESmcqcgSRQ8B_9zzXalOChSlsC5K5HfkZvwzlg,13958
 avantis_trader_sdk/utils.py,sha256=JE3hiDA8a9KHW08u0lVsuXi6Npl8GcuUdvrSkwohvDc,2909
 avantis_trader_sdk/abis/AggregatorV3Interface.json,sha256=0sTEMeK5PfVfJM0ZoLkWkxme_PgcOKoYhxz5cQNo728,26850
 avantis_trader_sdk/abis/Sanctions.json,sha256=2FFgtlHZEXTOYtFWNjPlV56b7WSiwuY92VR9Jkik1uc,4047
@@ -88,7 +88,7 @@ avantis_trader_sdk/abis/Multicall.t.sol/MulticallGroup.json,sha256=AZVoGuVs__JE-
 avantis_trader_sdk/abis/Multicall3.sol/Multicall3.json,sha256=7-38-beNTW3Jo9ZHvpgp8JzI5ylN6llcV_fzw9syF_s,176224
 avantis_trader_sdk/abis/Ownable.sol/Ownable.json,sha256=aBFacbduOM9MRjoTB71SNiMWIytBc2t0BRcU7u-GrNk,31008
 avantis_trader_sdk/abis/PairInfos.sol/PairInfos.json,sha256=i9sWFDHIDJAlwuC0M0Y9w7Z2rhOcWDGyKYUrobI2SdI,712989
-avantis_trader_sdk/abis/PairStorage.sol/PairStorage.json,sha256=4PhXTV7g9JMg8tBJRn5lxnn053_lkV8EzztHDlU-cE4,504985
+avantis_trader_sdk/abis/PairStorage.sol/PairStorage.json,sha256=Lcrh8PfZusTQr_ZWpSU96PBEKebb0rQrMhzge6BsjoA,305493
 avantis_trader_sdk/abis/PausableUpgradeable.sol/PausableUpgradeable.json,sha256=_STYbJg_yX9kU7He-sQjkwVo8uHTs0jotpHoi-8DYWY,31799
 avantis_trader_sdk/abis/PositionMath.sol/PositionMath.json,sha256=WouZkR-00Avs16LvtMUdWitehNKKiuiQUWr4O0I6DJM,11823
 avantis_trader_sdk/abis/PriceAggregator.sol/PriceAggregator.json,sha256=_IhAyWO2pzFu-TJg0OJRxnF8s9xE_w9khrkq7R3ztdc,393087
@@ -200,11 +200,11 @@ avantis_trader_sdk/rpc/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3
 avantis_trader_sdk/rpc/asset_parameters.py,sha256=OkGyfSmiCUl7fgJaUJFQekpQ8o2_JbbSwh1gWAXdZKY,19717
 avantis_trader_sdk/rpc/blended.py,sha256=UHgrPEvkJwQJRxTrVG03Ir8IjJRGenQFov1bJvbuGi4,2512
 avantis_trader_sdk/rpc/category_parameters.py,sha256=yw-6Ib1kS25JTmZQzH7Xyn1dehUqGYBoZM_bO7G4lEE,8181
-avantis_trader_sdk/rpc/fee_parameters.py,sha256=fawGjRVGSIugEh2rs93Qyu4e68ejDzUrn0ZlbkwmEf8,9161
-avantis_trader_sdk/rpc/pairs_cache.py,sha256=CxaZKNv38AW90oINcJdG7QVGfOVYEiTWSV_vtdQ570M,4066
+avantis_trader_sdk/rpc/fee_parameters.py,sha256=EhJY7I66MAP_sClVhSy6KBiicpeEip5EXrIlpfbVSDM,9369
+avantis_trader_sdk/rpc/pairs_cache.py,sha256=gjdfdIr8BGhGDIBv-PZQnJZEKeDHSt1DJZVzecCN7yY,4689
 avantis_trader_sdk/rpc/rpc_helpers.py,sha256=d3dzwEaAUVo700qK7S-bBSVX3UtrOKbPEGPqgxHS5sk,292
 avantis_trader_sdk/rpc/snapshot.py,sha256=2EMtNqfeB37dr4EsuSMBm0CAYbwWMv9evML8MZocNFw,5494
-avantis_trader_sdk/rpc/trade.py,sha256=Zvtj2WbDv_uuR0l8SKQ99mL1BDv9vVAP_xOUy9VRIUU,11250
+avantis_trader_sdk/rpc/trade.py,sha256=jq3bYWPZqAaFjDlbs42mhbQFb8dKiGLxGYyDAsqNv8Y,13154
 avantis_trader_sdk/rpc/trading_parameters.py,sha256=ZvEJ-kjrogENIhPsETRIp-FdVaIdd2mT2fyM84SuFJk,4702
 avantis_trader_sdk/signers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 avantis_trader_sdk/signers/base.py,sha256=QaOu0CxFq60oR4LegCp1XwONMQx8ZShXyiLZvfcbCPM,260
@@ -212,7 +212,7 @@ avantis_trader_sdk/signers/kms_signer.py,sha256=lxK3f9KQsdCDAvOE1SHleKjI8zD_3PTv
 avantis_trader_sdk/signers/local_signer.py,sha256=kUx5vExiBfvFGmoMCFR6b7_4cXx2mvYOJNqZQDIEcG8,505
 tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/test_client.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-avantis_trader_sdk-0.3.1.dist-info/METADATA,sha256=zyqqV0h2A_q_IBGSb_DMs0F0u8hDl9Sr4R98UfYU6tg,4923
-avantis_trader_sdk-0.3.1.dist-info/WHEEL,sha256=eOLhNAGa2EW3wWl_TU484h7q1UNgy0JXjjoqKoxAAQc,92
-avantis_trader_sdk-0.3.1.dist-info/top_level.txt,sha256=XffaQJ68SGT1KUz2HHXSGSEsmNy8-AGjgtO127xhzQA,25
-avantis_trader_sdk-0.3.1.dist-info/RECORD,,
+avantis_trader_sdk-0.6.0.dist-info/METADATA,sha256=T5o1GDxF_mjZE3_N77alBZ9QbRQGg6U6YGqozkPbVmw,4916
+avantis_trader_sdk-0.6.0.dist-info/WHEEL,sha256=eOLhNAGa2EW3wWl_TU484h7q1UNgy0JXjjoqKoxAAQc,92
+avantis_trader_sdk-0.6.0.dist-info/top_level.txt,sha256=XffaQJ68SGT1KUz2HHXSGSEsmNy8-AGjgtO127xhzQA,25
+avantis_trader_sdk-0.6.0.dist-info/RECORD,,