compass_api_sdk 0.9.45__tar.gz → 0.9.47__tar.gz

{compass_api_sdk-0.9.45 → compass_api_sdk-0.9.47}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: compass_api_sdk
-Version: 0.9.45
+Version: 0.9.47
 Summary: Compass API SDK.
 Author: royalnine
 Requires-Python: >=3.9.2

{compass_api_sdk-0.9.45 → compass_api_sdk-0.9.47}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "compass_api_sdk"
-version = "0.9.45"
+version = "0.9.47"
 description = "Compass API SDK."
 authors = [{ name = "royalnine" },]
 readme = "README-PYPI.md"

{compass_api_sdk-0.9.45 → compass_api_sdk-0.9.47}/src/compass_api_sdk/_version.py

@@ -3,10 +3,10 @@
 import importlib.metadata
 
 __title__: str = "compass_api_sdk"
-__version__: str = "0.9.45"
+__version__: str = "0.9.47"
 __openapi_doc_version__: str = "0.0.1"
-__gen_version__: str = "2.656.5"
-__user_agent__: str = "speakeasy-sdk/python 0.9.45 2.656.5 0.0.1 compass_api_sdk"
+__gen_version__: str = "2.656.9"
+__user_agent__: str = "speakeasy-sdk/python 0.9.47 2.656.9 0.0.1 compass_api_sdk"
 
 try:
     if __package__ is not None:

{compass_api_sdk-0.9.45 → compass_api_sdk-0.9.47}/src/compass_api_sdk/aave_v3.py

@@ -1863,6 +1863,14 @@ class AaveV3(BaseSDK):
         Overall, this endpoint is a critical component for users looking to maximize their
         asset utility within the AAVEv3 ecosystem, providing both earning potential and
         borrowing flexibility.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `AaveV3Pool`
+        </Info>
+
 
         :param token: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
         :param amount: The amount of the asset to supply
@@ -1975,6 +1983,14 @@ class AaveV3(BaseSDK):
         Overall, this endpoint is a critical component for users looking to maximize their
         asset utility within the AAVEv3 ecosystem, providing both earning potential and
         borrowing flexibility.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `AaveV3Pool`
+        </Info>
+
 
         :param token: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
         :param amount: The amount of the asset to supply
@@ -2083,6 +2099,14 @@ class AaveV3(BaseSDK):
 
         Price changes in the assets may lead to some or all of your collateral being
         liquidated, if the borrow position becomes unhealthy.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `AaveV3Pool`
+        </Info>
+
 
         :param token: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
         :param amount: The amount of the asset to borrow
@@ -2193,6 +2217,14 @@ class AaveV3(BaseSDK):
 
         Price changes in the assets may lead to some or all of your collateral being
         liquidated, if the borrow position becomes unhealthy.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `AaveV3Pool`
+        </Info>
+
 
         :param token: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
         :param amount: The amount of the asset to borrow
@@ -2307,6 +2339,14 @@ class AaveV3(BaseSDK):
         risk of liquidation, ensuring a more secure borrowing experience. The endpoint
         requires specifying the chain and the details of the repayment transaction,
         including the amount and the asset to be repaid.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `AaveV3Pool`
+        </Info>
+
 
         :param token: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
         :param amount: The amount of the asset to repay
@@ -2421,6 +2461,14 @@ class AaveV3(BaseSDK):
         risk of liquidation, ensuring a more secure borrowing experience. The endpoint
         requires specifying the chain and the details of the repayment transaction,
         including the amount and the asset to be repaid.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `AaveV3Pool`
+        </Info>
+
 
         :param token: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
         :param amount: The amount of the asset to repay
@@ -2535,6 +2583,14 @@ class AaveV3(BaseSDK):
         their liquidation threshold before proceeding with a withdrawal. This endpoint is
         designed to provide a seamless and efficient way to manage your collateral within
         the Aave ecosystem.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `AaveV3Pool`
+        </Info>
+
 
         :param token: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
         :param amount: The amount of the asset to withdraw
@@ -2647,6 +2703,14 @@ class AaveV3(BaseSDK):
         their liquidation threshold before proceeding with a withdrawal. This endpoint is
         designed to provide a seamless and efficient way to manage your collateral within
         the Aave ecosystem.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `AaveV3Pool`
+        </Info>
+
 
         :param token: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
         :param amount: The amount of the asset to withdraw

{compass_api_sdk-0.9.45 → compass_api_sdk-0.9.47}/src/compass_api_sdk/aerodrome_slipstream.py

@@ -449,6 +449,14 @@ class AerodromeSlipstream(BaseSDK):
         of the current market conditions, taking into account the liquidity and price
         impact. This endpoint is suitable for users who want to sell a precise quantity of a
         token and are willing to accept the resulting amount of the other token.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `AerodromeSlipstreamRouter`
+        </Info>
+
 
         :param token_in: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
         :param token_out: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
@@ -577,6 +585,14 @@ class AerodromeSlipstream(BaseSDK):
         of the current market conditions, taking into account the liquidity and price
         impact. This endpoint is suitable for users who want to sell a precise quantity of a
         token and are willing to accept the resulting amount of the other token.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `AerodromeSlipstreamRouter`
+        </Info>
+
 
         :param token_in: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
         :param token_out: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
@@ -704,6 +720,14 @@ class AerodromeSlipstream(BaseSDK):
         transaction is executed with consideration of current market conditions, including
         liquidity and price impact, ensuring that the trade is completed efficiently and
         effectively.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `AerodromeSlipstreamRouter`
+        </Info>
+
 
         :param token_in: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
         :param token_out: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
@@ -831,6 +855,14 @@ class AerodromeSlipstream(BaseSDK):
         transaction is executed with consideration of current market conditions, including
         liquidity and price impact, ensuring that the trade is completed efficiently and
         effectively.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `AerodromeSlipstreamRouter`
+        </Info>
+
 
         :param token_in: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
         :param token_out: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
@@ -968,6 +1000,14 @@ class AerodromeSlipstream(BaseSDK):
         necessary information to manage their newly minted position. This functionality is
         crucial for users looking to expand their liquidity provision activities, offering
         them the opportunity to engage in decentralized finance (DeFi) markets effectively.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `AerodromeSlipstreamNonfungiblePositionManager`
+        </Info>
+
 
         :param token0: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
         :param token1: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
@@ -1115,6 +1155,14 @@ class AerodromeSlipstream(BaseSDK):
         necessary information to manage their newly minted position. This functionality is
         crucial for users looking to expand their liquidity provision activities, offering
         them the opportunity to engage in decentralized finance (DeFi) markets effectively.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `AerodromeSlipstreamNonfungiblePositionManager`
+        </Info>
+
 
         :param token0: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
         :param token1: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
@@ -1259,6 +1307,14 @@ class AerodromeSlipstream(BaseSDK):
         vital for users aiming to optimize their liquidity provision strategy, enabling them
         to adapt to market conditions and maximize their returns in decentralized finance
         (DeFi) markets.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `AerodromeSlipstreamRouter`
+        </Info>
+
 
         :param token_id: Token ID of the NFT representing the liquidity provisioned position.
         :param amount0_desired: The desired amount of the first token to deposit
@@ -1393,6 +1449,14 @@ class AerodromeSlipstream(BaseSDK):
         vital for users aiming to optimize their liquidity provision strategy, enabling them
         to adapt to market conditions and maximize their returns in decentralized finance
         (DeFi) markets.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `AerodromeSlipstreamRouter`
+        </Info>
+
 
         :param token_id: Token ID of the NFT representing the liquidity provisioned position.
         :param amount0_desired: The desired amount of the first token to deposit
@@ -1515,6 +1579,14 @@ class AerodromeSlipstream(BaseSDK):
         assets and potentially reallocate them to other investment opportunities. The
         endpoint ensures a smooth and secure withdrawal process, facilitating users'
         strategic management of their decentralized finance (DeFi) portfolios.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `AerodromeSlipstreamNonfungiblePositionManager`
+        </Info>
+
 
         :param token_id: Token ID of the NFT representing the liquidity provisioned position.
         :param percentage_for_withdrawal: How much liquidity to take out in percentage.
@@ -1631,6 +1703,14 @@ class AerodromeSlipstream(BaseSDK):
         assets and potentially reallocate them to other investment opportunities. The
         endpoint ensures a smooth and secure withdrawal process, facilitating users'
         strategic management of their decentralized finance (DeFi) portfolios.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `AerodromeSlipstreamNonfungiblePositionManager`
+        </Info>
+
 
         :param token_id: Token ID of the NFT representing the liquidity provisioned position.
         :param percentage_for_withdrawal: How much liquidity to take out in percentage.

{compass_api_sdk-0.9.45 → compass_api_sdk-0.9.47}/src/compass_api_sdk/erc_4626_vaults.py

@@ -225,6 +225,14 @@ class ERC4626Vaults(BaseSDK):
         Deposit tokens into a Vault (ERC-4626 Standard) to earn passive yield.
 
         Each vault accepts one unique token that can be deposited.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `<vault_address>`
+        </Info>
+
 
         :param vault_address: The vault address you are depositing to.
         :param amount: The amount of tokens to deposit into the vault.
@@ -331,6 +339,14 @@ class ERC4626Vaults(BaseSDK):
         Deposit tokens into a Vault (ERC-4626 Standard) to earn passive yield.
 
         Each vault accepts one unique token that can be deposited.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `<vault_address>`
+        </Info>
+
 
         :param vault_address: The vault address you are depositing to.
         :param amount: The amount of tokens to deposit into the vault.
@@ -437,6 +453,14 @@ class ERC4626Vaults(BaseSDK):
         The passive yield earned on token deposits is represented by the increased value of
         the shares received upon depositing tokens. Trade in these shares for the tokens you
         deposited plus any accrued yield.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `<vault address>`
+        </Info>
+
 
         :param vault_address: The vault address you are withdrawing from.
         :param amount: The amount of tokens to withdraw from the vault. If set to 'ALL', your total deposited token amount will be withdrawn.
@@ -543,6 +567,14 @@ class ERC4626Vaults(BaseSDK):
         The passive yield earned on token deposits is represented by the increased value of
         the shares received upon depositing tokens. Trade in these shares for the tokens you
         deposited plus any accrued yield.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `<vault address>`
+        </Info>
+
 
         :param vault_address: The vault address you are withdrawing from.
         :param amount: The amount of tokens to withdraw from the vault. If set to 'ALL', your total deposited token amount will be withdrawn.

{compass_api_sdk-0.9.45 → compass_api_sdk-0.9.47}/src/compass_api_sdk/models/aave_avg_rateop.py

@@ -73,6 +73,7 @@ class AaveAvgRateToken(str, Enum):
     AERO = "AERO"
     EUR = "EUR"
     VIRTUAL = "VIRTUAL"
+    EZ_ETH = "ezETH"
 
 
 class AaveAvgRateRequestTypedDict(TypedDict):

{compass_api_sdk-0.9.45 → compass_api_sdk-0.9.47}/src/compass_api_sdk/models/aave_liquidity_changeop.py

@@ -66,6 +66,7 @@ class AaveLiquidityChangeToken(str, Enum):
     AERO = "AERO"
     EUR = "EUR"
     VIRTUAL = "VIRTUAL"
+    EZ_ETH = "ezETH"
 
 
 class AaveLiquidityChangeRequestTypedDict(TypedDict):

{compass_api_sdk-0.9.45 → compass_api_sdk-0.9.47}/src/compass_api_sdk/models/aave_rateop.py

@@ -73,6 +73,7 @@ class AaveRateToken(str, Enum):
     AERO = "AERO"
     EUR = "EUR"
     VIRTUAL = "VIRTUAL"
+    EZ_ETH = "ezETH"
 
 
 class AaveRateRequestTypedDict(TypedDict):

{compass_api_sdk-0.9.45 → compass_api_sdk-0.9.47}/src/compass_api_sdk/models/aave_reserve_overviewop.py

@@ -73,6 +73,7 @@ class AaveReserveOverviewToken(str, Enum):
     AERO = "AERO"
     EUR = "EUR"
     VIRTUAL = "VIRTUAL"
+    EZ_ETH = "ezETH"
 
 
 class AaveReserveOverviewRequestTypedDict(TypedDict):

{compass_api_sdk-0.9.45 → compass_api_sdk-0.9.47}/src/compass_api_sdk/models/aave_std_rateop.py

@@ -73,6 +73,7 @@ class AaveStdRateToken(str, Enum):
     AERO = "AERO"
     EUR = "EUR"
     VIRTUAL = "VIRTUAL"
+    EZ_ETH = "ezETH"
 
 
 class AaveStdRateRequestTypedDict(TypedDict):

{compass_api_sdk-0.9.45 → compass_api_sdk-0.9.47}/src/compass_api_sdk/models/aave_token_priceop.py

@@ -73,6 +73,7 @@ class AaveTokenPriceToken(str, Enum):
     AERO = "AERO"
     EUR = "EUR"
     VIRTUAL = "VIRTUAL"
+    EZ_ETH = "ezETH"
 
 
 class AaveTokenPriceRequestTypedDict(TypedDict):

{compass_api_sdk-0.9.45 → compass_api_sdk-0.9.47}/src/compass_api_sdk/models/aave_user_position_per_tokenop.py

@@ -73,6 +73,7 @@ class AaveUserPositionPerTokenToken(str, Enum):
     AERO = "AERO"
     EUR = "EUR"
     VIRTUAL = "VIRTUAL"
+    EZ_ETH = "ezETH"
 
 
 class AaveUserPositionPerTokenRequestTypedDict(TypedDict):

{compass_api_sdk-0.9.45 → compass_api_sdk-0.9.47}/src/compass_api_sdk/models/aerodrome_slipstream_pool_priceop.py

@@ -67,6 +67,7 @@ class AerodromeSlipstreamPoolPriceTokenInToken(str, Enum):
     AERO = "AERO"
     EUR = "EUR"
     VIRTUAL = "VIRTUAL"
+    EZ_ETH = "ezETH"
 
 
 class AerodromeSlipstreamPoolPriceTokenOutToken(str, Enum):
@@ -120,6 +121,7 @@ class AerodromeSlipstreamPoolPriceTokenOutToken(str, Enum):
     AERO = "AERO"
     EUR = "EUR"
     VIRTUAL = "VIRTUAL"
+    EZ_ETH = "ezETH"
 
 
 class AerodromeSlipstreamPoolPriceRequestTypedDict(TypedDict):

{compass_api_sdk-0.9.45 → compass_api_sdk-0.9.47}/src/compass_api_sdk/models/token_addressop.py

@@ -66,6 +66,7 @@ class TokenAddressToken(str, Enum):
     AERO = "AERO"
     EUR = "EUR"
     VIRTUAL = "VIRTUAL"
+    EZ_ETH = "ezETH"
 
 
 class TokenAddressRequestTypedDict(TypedDict):

{compass_api_sdk-0.9.45 → compass_api_sdk-0.9.47}/src/compass_api_sdk/models/token_enum.py

@@ -55,3 +55,4 @@ class TokenEnum(str, Enum):
     AERO = "AERO"
     EUR = "EUR"
     VIRTUAL = "VIRTUAL"
+    EZ_ETH = "ezETH"

{compass_api_sdk-0.9.45 → compass_api_sdk-0.9.47}/src/compass_api_sdk/models/uniswap_pool_priceop.py

@@ -66,6 +66,7 @@ class UniswapPoolPriceTokenInToken(str, Enum):
     AERO = "AERO"
     EUR = "EUR"
     VIRTUAL = "VIRTUAL"
+    EZ_ETH = "ezETH"
 
 
 class UniswapPoolPriceTokenOutToken(str, Enum):
@@ -119,6 +120,7 @@ class UniswapPoolPriceTokenOutToken(str, Enum):
     AERO = "AERO"
     EUR = "EUR"
     VIRTUAL = "VIRTUAL"
+    EZ_ETH = "ezETH"
 
 
 class UniswapPoolPriceFeeEnum(str, Enum):

{compass_api_sdk-0.9.45 → compass_api_sdk-0.9.47}/src/compass_api_sdk/models/uniswap_quote_buy_exactlyop.py

@@ -67,6 +67,7 @@ class UniswapQuoteBuyExactlyTokenInToken(str, Enum):
     AERO = "AERO"
     EUR = "EUR"
     VIRTUAL = "VIRTUAL"
+    EZ_ETH = "ezETH"
 
 
 class UniswapQuoteBuyExactlyTokenOutToken(str, Enum):
@@ -120,6 +121,7 @@ class UniswapQuoteBuyExactlyTokenOutToken(str, Enum):
     AERO = "AERO"
     EUR = "EUR"
     VIRTUAL = "VIRTUAL"
+    EZ_ETH = "ezETH"
 
 
 class UniswapQuoteBuyExactlyFeeEnum(str, Enum):

{compass_api_sdk-0.9.45 → compass_api_sdk-0.9.47}/src/compass_api_sdk/models/uniswap_quote_sell_exactlyop.py

@@ -67,6 +67,7 @@ class UniswapQuoteSellExactlyTokenInToken(str, Enum):
     AERO = "AERO"
     EUR = "EUR"
     VIRTUAL = "VIRTUAL"
+    EZ_ETH = "ezETH"
 
 
 class UniswapQuoteSellExactlyTokenOutToken(str, Enum):
@@ -120,6 +121,7 @@ class UniswapQuoteSellExactlyTokenOutToken(str, Enum):
     AERO = "AERO"
     EUR = "EUR"
     VIRTUAL = "VIRTUAL"
+    EZ_ETH = "ezETH"
 
 
 class UniswapQuoteSellExactlyFeeEnum(str, Enum):