compass_api_sdk 0.9.13__py3-none-any.whl → 0.9.15__py3-none-any.whl

compass_api_sdk/models/pendlesellytparams.py

@@ -24,6 +24,8 @@ class PendleSellYtParamsTypedDict(TypedDict):
     r"""The address of the market identifying which Yield Token (YT) you would like to sell."""
     amount: PendleSellYtParamsAmountTypedDict
     r"""The amount of market's Yield Token (YT) you would like to sell for market's Underlying Token."""
+    max_slippage_percent: float
+    r"""The maximum slippage allowed in percent. e.g. `1` means `1%` slippage allowed."""
     action_type: Literal["PENDLE_SELL_YT"]
 
 
@@ -34,6 +36,9 @@ class PendleSellYtParams(BaseModel):
     amount: PendleSellYtParamsAmount
     r"""The amount of market's Yield Token (YT) you would like to sell for market's Underlying Token."""
 
+    max_slippage_percent: float
+    r"""The maximum slippage allowed in percent. e.g. `1` means `1%` slippage allowed."""
+
     ACTION_TYPE: Annotated[
         Annotated[
             Optional[Literal["PENDLE_SELL_YT"]],

compass_api_sdk/models/pendlesellytrequest.py

@@ -27,6 +27,8 @@ class PendleSellYtRequestTypedDict(TypedDict):
     r"""The address of the market identifying which Yield Token (YT) you would like to sell."""
     amount: PendleSellYtRequestAmountTypedDict
     r"""The amount of market's Yield Token (YT) you would like to sell for market's Underlying Token."""
+    max_slippage_percent: float
+    r"""The maximum slippage allowed in percent. e.g. `1` means `1%` slippage allowed."""
     chain: Chain
     r"""The chain to use."""
     sender: str
@@ -41,6 +43,9 @@ class PendleSellYtRequest(BaseModel):
     amount: PendleSellYtRequestAmount
     r"""The amount of market's Yield Token (YT) you would like to sell for market's Underlying Token."""
 
+    max_slippage_percent: float
+    r"""The maximum slippage allowed in percent. e.g. `1` means `1%` slippage allowed."""
+
     chain: Chain
     r"""The chain to use."""
 

compass_api_sdk/models/useroperation.py

@@ -101,38 +101,38 @@ from typing_extensions import Annotated, TypeAliasType, TypedDict
 BodyTypedDict = TypeAliasType(
     "BodyTypedDict",
     Union[
-        PendleRedeemYieldParamsTypedDict,
         WrapEthParamsTypedDict,
         UnwrapWethParamsTypedDict,
-        SkyWithdrawParamsTypedDict,
-        PendleAddLiquidityParamsTypedDict,
+        PendleRedeemYieldParamsTypedDict,
+        MorphoSetVaultAllowanceParamsTypedDict,
         UniswapWithdrawLiquidityProvisionParamsTypedDict,
-        PendleRemoveLiquidityParamsTypedDict,
+        SkyWithdrawParamsTypedDict,
         SkySellParamsTypedDict,
-        AerodromeSlipstreamWithdrawLiquidityProvisionParamsTypedDict,
         SkyDepositParamsTypedDict,
         SkyBuyParamsTypedDict,
+        AerodromeSlipstreamWithdrawLiquidityProvisionParamsTypedDict,
+        IncreaseAllowanceParamsTypedDict,
         PendleSellYtParamsTypedDict,
-        PendleSellPtParamsTypedDict,
-        MorphoSetVaultAllowanceParamsTypedDict,
-        PendleBuyYtParamsTypedDict,
-        PendleBuyPtParamsTypedDict,
-        TokenTransferErc20ParamsTypedDict,
-        MorphoDepositParamsTypedDict,
-        MorphoWithdrawParamsTypedDict,
         AaveSupplyParamsTypedDict,
         AaveWithdrawParamsTypedDict,
-        IncreaseAllowanceParamsTypedDict,
-        MorphoSupplyCollateralParamsTypedDict,
+        TokenTransferErc20ParamsTypedDict,
+        MorphoWithdrawParamsTypedDict,
+        MorphoDepositParamsTypedDict,
+        PendleAddLiquidityParamsTypedDict,
+        PendleBuyPtParamsTypedDict,
+        PendleBuyYtParamsTypedDict,
+        PendleSellPtParamsTypedDict,
+        PendleRemoveLiquidityParamsTypedDict,
         MorphoRepayParamsTypedDict,
-        MorphoBorrowParamsTypedDict,
         MorphoWithdrawCollateralParamsTypedDict,
-        AaveRepayParamsTypedDict,
         AaveBorrowParamsTypedDict,
-        UniswapIncreaseLiquidityProvisionParamsTypedDict,
+        MorphoSupplyCollateralParamsTypedDict,
+        AaveRepayParamsTypedDict,
+        MorphoBorrowParamsTypedDict,
+        AerodromeSlipstreamSellExactlyParamsTypedDict,
         AerodromeSlipstreamIncreaseLiquidityProvisionParamsTypedDict,
         AerodromeSlipstreamBuyExactlyParamsTypedDict,
-        AerodromeSlipstreamSellExactlyParamsTypedDict,
+        UniswapIncreaseLiquidityProvisionParamsTypedDict,
         UniswapBuyExactlyParamsTypedDict,
         UniswapSellExactlyParamsTypedDict,
         AerodromeSlipstreamMintLiquidityProvisionParamsTypedDict,

compass_api_sdk/pendle.py

@@ -831,6 +831,7 @@ class Pendle(BaseSDK):
         amount: Union[
             models.PendleBuyPtRequestAmount, models.PendleBuyPtRequestAmountTypedDict
         ],
+        max_slippage_percent: float,
         chain: models.Chain,
         sender: str,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -844,6 +845,7 @@ class Pendle(BaseSDK):
 
         :param market_address: The address of the market identifying which Principal Token (PT) you would like to buy.
         :param amount: The amount of market's Underlying Token you would like to sell for market's Principal Token (PT).
+        :param max_slippage_percent: The maximum slippage allowed in percent. e.g. `1` means `1%` slippage allowed.
         :param chain: The chain to use.
         :param sender: The address of the transaction sender.
         :param retries: Override the default retry configuration for this method
@@ -864,6 +866,7 @@ class Pendle(BaseSDK):
         request = models.PendleBuyPtRequest(
             market_address=market_address,
             amount=amount,
+            max_slippage_percent=max_slippage_percent,
             chain=chain,
             sender=sender,
         )
@@ -943,6 +946,7 @@ class Pendle(BaseSDK):
         amount: Union[
             models.PendleBuyPtRequestAmount, models.PendleBuyPtRequestAmountTypedDict
         ],
+        max_slippage_percent: float,
         chain: models.Chain,
         sender: str,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -956,6 +960,7 @@ class Pendle(BaseSDK):
 
         :param market_address: The address of the market identifying which Principal Token (PT) you would like to buy.
         :param amount: The amount of market's Underlying Token you would like to sell for market's Principal Token (PT).
+        :param max_slippage_percent: The maximum slippage allowed in percent. e.g. `1` means `1%` slippage allowed.
         :param chain: The chain to use.
         :param sender: The address of the transaction sender.
         :param retries: Override the default retry configuration for this method
@@ -976,6 +981,7 @@ class Pendle(BaseSDK):
         request = models.PendleBuyPtRequest(
             market_address=market_address,
             amount=amount,
+            max_slippage_percent=max_slippage_percent,
             chain=chain,
             sender=sender,
         )
@@ -1055,6 +1061,7 @@ class Pendle(BaseSDK):
         amount: Union[
             models.PendleSellPtRequestAmount, models.PendleSellPtRequestAmountTypedDict
         ],
+        max_slippage_percent: float,
         chain: models.Chain,
         sender: str,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -1068,6 +1075,7 @@ class Pendle(BaseSDK):
 
         :param market_address: The address of the market identifying which Principal Token (PT) you would like to sell.
         :param amount: The amount of market's Principal Token (PT) you would like to sell for market's Underlying Token.
+        :param max_slippage_percent: The maximum slippage allowed in percent. e.g. `1` means `1%` slippage allowed.
         :param chain: The chain to use.
         :param sender: The address of the transaction sender.
         :param retries: Override the default retry configuration for this method
@@ -1088,6 +1096,7 @@ class Pendle(BaseSDK):
         request = models.PendleSellPtRequest(
             market_address=market_address,
             amount=amount,
+            max_slippage_percent=max_slippage_percent,
             chain=chain,
             sender=sender,
         )
@@ -1167,6 +1176,7 @@ class Pendle(BaseSDK):
         amount: Union[
             models.PendleSellPtRequestAmount, models.PendleSellPtRequestAmountTypedDict
         ],
+        max_slippage_percent: float,
         chain: models.Chain,
         sender: str,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -1180,6 +1190,7 @@ class Pendle(BaseSDK):
 
         :param market_address: The address of the market identifying which Principal Token (PT) you would like to sell.
         :param amount: The amount of market's Principal Token (PT) you would like to sell for market's Underlying Token.
+        :param max_slippage_percent: The maximum slippage allowed in percent. e.g. `1` means `1%` slippage allowed.
         :param chain: The chain to use.
         :param sender: The address of the transaction sender.
         :param retries: Override the default retry configuration for this method
@@ -1200,6 +1211,7 @@ class Pendle(BaseSDK):
         request = models.PendleSellPtRequest(
             market_address=market_address,
             amount=amount,
+            max_slippage_percent=max_slippage_percent,
             chain=chain,
             sender=sender,
         )
@@ -1279,6 +1291,7 @@ class Pendle(BaseSDK):
         amount: Union[
             models.PendleBuyYtRequestAmount, models.PendleBuyYtRequestAmountTypedDict
         ],
+        max_slippage_percent: float,
         chain: models.Chain,
         sender: str,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -1292,6 +1305,7 @@ class Pendle(BaseSDK):
 
         :param market_address: The address of the market identifying which Yield Token (YT) you would like to buy.
         :param amount: The amount of market's Underlying Token you would like to sell for market's Yield Token (YT).
+        :param max_slippage_percent: The maximum slippage allowed in percent. e.g. `1` means `1%` slippage allowed.
         :param chain: The chain to use.
         :param sender: The address of the transaction sender.
         :param retries: Override the default retry configuration for this method
@@ -1312,6 +1326,7 @@ class Pendle(BaseSDK):
         request = models.PendleBuyYtRequest(
             market_address=market_address,
             amount=amount,
+            max_slippage_percent=max_slippage_percent,
             chain=chain,
             sender=sender,
         )
@@ -1391,6 +1406,7 @@ class Pendle(BaseSDK):
         amount: Union[
             models.PendleBuyYtRequestAmount, models.PendleBuyYtRequestAmountTypedDict
         ],
+        max_slippage_percent: float,
         chain: models.Chain,
         sender: str,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -1404,6 +1420,7 @@ class Pendle(BaseSDK):
 
         :param market_address: The address of the market identifying which Yield Token (YT) you would like to buy.
         :param amount: The amount of market's Underlying Token you would like to sell for market's Yield Token (YT).
+        :param max_slippage_percent: The maximum slippage allowed in percent. e.g. `1` means `1%` slippage allowed.
         :param chain: The chain to use.
         :param sender: The address of the transaction sender.
         :param retries: Override the default retry configuration for this method
@@ -1424,6 +1441,7 @@ class Pendle(BaseSDK):
         request = models.PendleBuyYtRequest(
             market_address=market_address,
             amount=amount,
+            max_slippage_percent=max_slippage_percent,
             chain=chain,
             sender=sender,
         )
@@ -1503,6 +1521,7 @@ class Pendle(BaseSDK):
         amount: Union[
             models.PendleSellYtRequestAmount, models.PendleSellYtRequestAmountTypedDict
         ],
+        max_slippage_percent: float,
         chain: models.Chain,
         sender: str,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -1516,6 +1535,7 @@ class Pendle(BaseSDK):
 
         :param market_address: The address of the market identifying which Yield Token (YT) you would like to sell.
         :param amount: The amount of market's Yield Token (YT) you would like to sell for market's Underlying Token.
+        :param max_slippage_percent: The maximum slippage allowed in percent. e.g. `1` means `1%` slippage allowed.
         :param chain: The chain to use.
         :param sender: The address of the transaction sender.
         :param retries: Override the default retry configuration for this method
@@ -1536,6 +1556,7 @@ class Pendle(BaseSDK):
         request = models.PendleSellYtRequest(
             market_address=market_address,
             amount=amount,
+            max_slippage_percent=max_slippage_percent,
             chain=chain,
             sender=sender,
         )
@@ -1615,6 +1636,7 @@ class Pendle(BaseSDK):
         amount: Union[
             models.PendleSellYtRequestAmount, models.PendleSellYtRequestAmountTypedDict
         ],
+        max_slippage_percent: float,
         chain: models.Chain,
         sender: str,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -1628,6 +1650,7 @@ class Pendle(BaseSDK):
 
         :param market_address: The address of the market identifying which Yield Token (YT) you would like to sell.
         :param amount: The amount of market's Yield Token (YT) you would like to sell for market's Underlying Token.
+        :param max_slippage_percent: The maximum slippage allowed in percent. e.g. `1` means `1%` slippage allowed.
         :param chain: The chain to use.
         :param sender: The address of the transaction sender.
         :param retries: Override the default retry configuration for this method
@@ -1648,6 +1671,7 @@ class Pendle(BaseSDK):
         request = models.PendleSellYtRequest(
             market_address=market_address,
             amount=amount,
+            max_slippage_percent=max_slippage_percent,
             chain=chain,
             sender=sender,
         )
@@ -1942,6 +1966,7 @@ class Pendle(BaseSDK):
             models.PendleAddLiquidityRequestAmount,
             models.PendleAddLiquidityRequestAmountTypedDict,
         ],
+        max_slippage_percent: float,
         chain: models.Chain,
         sender: str,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -1958,6 +1983,7 @@ class Pendle(BaseSDK):
 
         :param market_address: The address identifying which Pendle Market you would like to add liquidity to.
         :param amount: The amount of liquidity you would like to add to the market denominated in the market's Underlying Token.
+        :param max_slippage_percent: The maximum slippage allowed in percent. e.g. `1` means `1%` slippage allowed.
         :param chain: The chain to use.
         :param sender: The address of the transaction sender.
         :param retries: Override the default retry configuration for this method
@@ -1978,6 +2004,7 @@ class Pendle(BaseSDK):
         request = models.PendleAddLiquidityRequest(
             market_address=market_address,
             amount=amount,
+            max_slippage_percent=max_slippage_percent,
             chain=chain,
             sender=sender,
         )
@@ -2058,6 +2085,7 @@ class Pendle(BaseSDK):
             models.PendleAddLiquidityRequestAmount,
             models.PendleAddLiquidityRequestAmountTypedDict,
         ],
+        max_slippage_percent: float,
         chain: models.Chain,
         sender: str,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -2074,6 +2102,7 @@ class Pendle(BaseSDK):
 
         :param market_address: The address identifying which Pendle Market you would like to add liquidity to.
         :param amount: The amount of liquidity you would like to add to the market denominated in the market's Underlying Token.
+        :param max_slippage_percent: The maximum slippage allowed in percent. e.g. `1` means `1%` slippage allowed.
         :param chain: The chain to use.
         :param sender: The address of the transaction sender.
         :param retries: Override the default retry configuration for this method
@@ -2094,6 +2123,7 @@ class Pendle(BaseSDK):
         request = models.PendleAddLiquidityRequest(
             market_address=market_address,
             amount=amount,
+            max_slippage_percent=max_slippage_percent,
             chain=chain,
             sender=sender,
         )
@@ -2174,6 +2204,7 @@ class Pendle(BaseSDK):
             models.PendleRemoveLiquidityRequestAmount,
             models.PendleRemoveLiquidityRequestAmountTypedDict,
         ],
+        max_slippage_percent: float,
         chain: models.Chain,
         sender: str,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -2191,6 +2222,7 @@ class Pendle(BaseSDK):
 
         :param market_address: The address identifying which Pendle Market you would like to remove liquidity from.
         :param amount: The amount of liquidity you would like to remove from the market denominated in the market's Liquidity Provider Token (LP).
+        :param max_slippage_percent: The maximum slippage allowed in percent. e.g. `1` means `1%` slippage allowed.
         :param chain: The chain to use.
         :param sender: The address of the transaction sender.
         :param retries: Override the default retry configuration for this method
@@ -2211,6 +2243,7 @@ class Pendle(BaseSDK):
         request = models.PendleRemoveLiquidityRequest(
             market_address=market_address,
             amount=amount,
+            max_slippage_percent=max_slippage_percent,
             chain=chain,
             sender=sender,
         )
@@ -2291,6 +2324,7 @@ class Pendle(BaseSDK):
             models.PendleRemoveLiquidityRequestAmount,
             models.PendleRemoveLiquidityRequestAmountTypedDict,
         ],
+        max_slippage_percent: float,
         chain: models.Chain,
         sender: str,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -2308,6 +2342,7 @@ class Pendle(BaseSDK):
 
         :param market_address: The address identifying which Pendle Market you would like to remove liquidity from.
         :param amount: The amount of liquidity you would like to remove from the market denominated in the market's Liquidity Provider Token (LP).
+        :param max_slippage_percent: The maximum slippage allowed in percent. e.g. `1` means `1%` slippage allowed.
         :param chain: The chain to use.
         :param sender: The address of the transaction sender.
         :param retries: Override the default retry configuration for this method
@@ -2328,6 +2363,7 @@ class Pendle(BaseSDK):
         request = models.PendleRemoveLiquidityRequest(
             market_address=market_address,
             amount=amount,
+            max_slippage_percent=max_slippage_percent,
             chain=chain,
             sender=sender,
         )

compass_api_sdk/sdk.py

@@ -21,6 +21,7 @@ if TYPE_CHECKING:
     from compass_api_sdk.sky import Sky
     from compass_api_sdk.smart_account import SmartAccount
     from compass_api_sdk.token_sdk import TokenSDK
+    from compass_api_sdk.transaction_batching import TransactionBatching
     from compass_api_sdk.uniswap_v3 import UniswapV3
     from compass_api_sdk.universal import Universal
 
@@ -36,6 +37,7 @@ class CompassAPI(BaseSDK):
     uniswap_v3: "UniswapV3"
     universal: "Universal"
     pendle: "Pendle"
+    transaction_batching: "TransactionBatching"
     smart_account: "SmartAccount"
     _sub_sdk_map = {
         "aave_v3": ("compass_api_sdk.aave_v3", "AaveV3"),
@@ -49,6 +51,10 @@ class CompassAPI(BaseSDK):
         "uniswap_v3": ("compass_api_sdk.uniswap_v3", "UniswapV3"),
         "universal": ("compass_api_sdk.universal", "Universal"),
         "pendle": ("compass_api_sdk.pendle", "Pendle"),
+        "transaction_batching": (
+            "compass_api_sdk.transaction_batching",
+            "TransactionBatching",
+        ),
         "smart_account": ("compass_api_sdk.smart_account", "SmartAccount"),
     }