compass_api_sdk 0.9.45__py3-none-any.whl → 0.9.46__py3-none-any.whl

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.46"
 __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"
+__user_agent__: str = "speakeasy-sdk/python 0.9.46 2.656.5 0.0.1 compass_api_sdk"
 
 try:
     if __package__ is not None:

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

@@ -1194,6 +1194,14 @@ class Morpho(BaseSDK):
         exposure for all deposited assets so users don't need to make these decisions
         themselves. Users maintain full control over their assets, can monitor the vault's
         state at any time, and withdraw their liquidity at their discretion.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `USDC`
+        </Info>
+
 
         :param vault_address: The vault address you are depositing to.
         :param amount: The amount of tokens to deposit into the vault.
@@ -1309,6 +1317,14 @@ class Morpho(BaseSDK):
         exposure for all deposited assets so users don't need to make these decisions
         themselves. Users maintain full control over their assets, can monitor the vault's
         state at any time, and withdraw their liquidity at their discretion.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `USDC`
+        </Info>
+
 
         :param vault_address: The vault address you are depositing to.
         :param amount: The amount of tokens to deposit into the vault.
@@ -1421,6 +1437,14 @@ class Morpho(BaseSDK):
         exposure for all deposited assets so users don't need to make these decisions
         themselves. Users maintain full control over their assets, can monitor the vault's
         state at any time, and withdraw their liquidity at their discretion.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `<token 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.
@@ -1533,6 +1557,14 @@ class Morpho(BaseSDK):
         exposure for all deposited assets so users don't need to make these decisions
         themselves. Users maintain full control over their assets, can monitor the vault's
         state at any time, and withdraw their liquidity at their discretion.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `<token 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.
@@ -1644,6 +1676,14 @@ class Morpho(BaseSDK):
         loan asset. Each market is isolated (meaning risks are contained within each
         individual market), immutable (cannot be changed after deployment), and will persist
         as long as the blockchain it is deployed on is live.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `Morpho`
+        </Info>
+
 
         :param amount: Amount of the token to supply to the market as collateral.
         :param unique_market_key: The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint.
@@ -1757,6 +1797,14 @@ class Morpho(BaseSDK):
         loan asset. Each market is isolated (meaning risks are contained within each
         individual market), immutable (cannot be changed after deployment), and will persist
         as long as the blockchain it is deployed on is live.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `Morpho`
+        </Info>
+
 
         :param amount: Amount of the token to supply to the market as collateral.
         :param unique_market_key: The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint.
@@ -1870,6 +1918,14 @@ class Morpho(BaseSDK):
         loan asset. Each market is isolated (meaning risks are contained within each
         individual market), immutable (cannot be changed after deployment), and will persist
         as long as the blockchain it is deployed on is live.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `Morpho`
+        </Info>
+
 
         :param amount: Amount of the token to supply to the market as collateral.
         :param unique_market_key: The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint.
@@ -1983,6 +2039,14 @@ class Morpho(BaseSDK):
         loan asset. Each market is isolated (meaning risks are contained within each
         individual market), immutable (cannot be changed after deployment), and will persist
         as long as the blockchain it is deployed on is live.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `Morpho`
+        </Info>
+
 
         :param amount: Amount of the token to supply to the market as collateral.
         :param unique_market_key: The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint.
@@ -2098,6 +2162,14 @@ class Morpho(BaseSDK):
         loan asset. Each market is isolated (meaning risks are contained within each
         individual market), immutable (cannot be changed after deployment), and will persist
         as long as the blockchain it is deployed on is live.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `Morpho`
+        </Info>
+
 
         :param amount: Amount of the token to borrow from the market.
         :param unique_market_key: The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint.
@@ -2213,6 +2285,14 @@ class Morpho(BaseSDK):
         loan asset. Each market is isolated (meaning risks are contained within each
         individual market), immutable (cannot be changed after deployment), and will persist
         as long as the blockchain it is deployed on is live.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `Morpho`
+        </Info>
+
 
         :param amount: Amount of the token to borrow from the market.
         :param unique_market_key: The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint.
@@ -2323,6 +2403,14 @@ class Morpho(BaseSDK):
         loan asset. Each market is isolated (meaning risks are contained within each
         individual market), immutable (cannot be changed after deployment), and will persist
         as long as the blockchain it is deployed on is live.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `Morpho`
+        </Info>
+
 
         :param amount: Amount of the token to repay to the market. If set to 'ALL', all debt plus interest will be paid back if the user has a sufficient token balance in their wallet.
         :param unique_market_key: The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint.
@@ -2433,6 +2521,14 @@ class Morpho(BaseSDK):
         loan asset. Each market is isolated (meaning risks are contained within each
         individual market), immutable (cannot be changed after deployment), and will persist
         as long as the blockchain it is deployed on is live.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `Morpho`
+        </Info>
+
 
         :param amount: Amount of the token to repay to the market. If set to 'ALL', all debt plus interest will be paid back if the user has a sufficient token balance in their wallet.
         :param unique_market_key: The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint.

compass_api_sdk/pendle.py

@@ -795,6 +795,14 @@ class Pendle(BaseSDK):
         r"""Buy Principal Token (PT)
 
         Buy Principal Token (PT) with market's Underlying Token.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `PendleRouter`
+        </Info>
+
 
         :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).
@@ -899,6 +907,14 @@ class Pendle(BaseSDK):
         r"""Buy Principal Token (PT)
 
         Buy Principal Token (PT) with market's Underlying Token.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `PendleRouter`
+        </Info>
+
 
         :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).
@@ -1003,6 +1019,14 @@ class Pendle(BaseSDK):
         r"""Sell Principal Token (PT)
 
         Sell Principal Token (PT) for the market's Underlying Token.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `PendleRouter`
+        </Info>
+
 
         :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.
@@ -1107,6 +1131,14 @@ class Pendle(BaseSDK):
         r"""Sell Principal Token (PT)
 
         Sell Principal Token (PT) for the market's Underlying Token.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `PendleRouter`
+        </Info>
+
 
         :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.
@@ -1211,6 +1243,14 @@ class Pendle(BaseSDK):
         r"""Buy Yield Token (YT)
 
         Buy Yield Token (YT) with market's Underlying Token.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `PendleRouter`
+        </Info>
+
 
         :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).
@@ -1315,6 +1355,14 @@ class Pendle(BaseSDK):
         r"""Buy Yield Token (YT)
 
         Buy Yield Token (YT) with market's Underlying Token.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `PendleRouter`
+        </Info>
+
 
         :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).
@@ -1419,6 +1467,14 @@ class Pendle(BaseSDK):
         r"""Sell Yield Token (YT)
 
         Sell Yield Token (YT) for the market's Underlying Token.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `PendleRouter`
+        </Info>
+
 
         :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.
@@ -1523,6 +1579,14 @@ class Pendle(BaseSDK):
         r"""Sell Yield Token (YT)
 
         Sell Yield Token (YT) for the market's Underlying Token.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `PendleRouter`
+        </Info>
+
 
         :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.
@@ -1623,6 +1687,14 @@ class Pendle(BaseSDK):
         r"""Redeem Claimable Yield
 
         Redeem claimable yield from the market's associated Yield Token (YT).
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `PendleRouter`
+        </Info>
+
 
         :param market_address: The address of the market identifying which Yield Token (YT) you would like to claim yield from.
         :param chain: The chain to use.
@@ -1719,6 +1791,14 @@ class Pendle(BaseSDK):
         r"""Redeem Claimable Yield
 
         Redeem claimable yield from the market's associated Yield Token (YT).
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `PendleRouter`
+        </Info>
+
 
         :param market_address: The address of the market identifying which Yield Token (YT) you would like to claim yield from.
         :param chain: The chain to use.
@@ -1823,6 +1903,14 @@ class Pendle(BaseSDK):
 
         Liquidity is added in the form of the market's Underlying Token. Representation of
         the liquidity received is the market's Liquidity Provider Token (LP).
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `PendleRouter`
+        </Info>
+
 
         :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.
@@ -1931,6 +2019,14 @@ class Pendle(BaseSDK):
 
         Liquidity is added in the form of the market's Underlying Token. Representation of
         the liquidity received is the market's Liquidity Provider Token (LP).
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `PendleRouter`
+        </Info>
+
 
         :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.
@@ -2040,6 +2136,14 @@ class Pendle(BaseSDK):
         Liquidity is removed in the form of the market's Liquidity Provider Token (LP) into
         the market's Underlying Token. An appropriate allowance for the Pendle Router on the
         market contract must be set beforehand
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `PendleRouter`
+        </Info>
+
 
         :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).
@@ -2149,6 +2253,14 @@ class Pendle(BaseSDK):
         Liquidity is removed in the form of the market's Liquidity Provider Token (LP) into
         the market's Underlying Token. An appropriate allowance for the Pendle Router on the
         market contract must be set beforehand
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `PendleRouter`
+        </Info>
+
 
         :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).

compass_api_sdk/sky.py

@@ -203,6 +203,14 @@ class Sky(BaseSDK):
 
         If buying with USDC, user will need to set an allowance on the USDC contract for the
         'SkyUsdcUsdsConverter' contract beforehand.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `SkyUsdcUsdsConverter`
+        </Info>
+
 
         :param token_in: The token you would like to swap 1:1 for USDS. Choose from DAI or USDC.
         :param amount: The amount of USDS you would like to buy 1:1 with 'token_in'.
@@ -305,6 +313,14 @@ class Sky(BaseSDK):
 
         If buying with USDC, user will need to set an allowance on the USDC contract for the
         'SkyUsdcUsdsConverter' contract beforehand.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `SkyUsdcUsdsConverter`
+        </Info>
+
 
         :param token_in: The token you would like to swap 1:1 for USDS. Choose from DAI or USDC.
         :param amount: The amount of USDS you would like to buy 1:1 with 'token_in'.
@@ -409,6 +425,14 @@ class Sky(BaseSDK):
 
         If swapping to USDC, user will need to set an allowance on the USDS contract for the
         'SkyUsdcUsdsConverter' contract beforehand.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `SkyUsdcUsdsConverter`
+        </Info>
+
 
         :param token_out: The token you would like to swap 1:1 with USDS. Choose from DAI or USDC.
         :param amount: The amount of USDS you would like to sell 1:1 for 'token_out'.
@@ -513,6 +537,14 @@ class Sky(BaseSDK):
 
         If swapping to USDC, user will need to set an allowance on the USDS contract for the
         'SkyUsdcUsdsConverter' contract beforehand.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `SkyUsdcUsdsConverter`
+        </Info>
+
 
         :param token_out: The token you would like to swap 1:1 with USDS. Choose from DAI or USDC.
         :param amount: The amount of USDS you would like to sell 1:1 for 'token_out'.
@@ -615,6 +647,14 @@ class Sky(BaseSDK):
         Allowance must be set on USDS contract for UsdsVault.
 
         There are no fees.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `SkyUsdsVault`
+        </Info>
+
 
         :param amount: The amount of USDS you would like to deposit for sUSDS to earn yield.
         :param sender: The address of the transaction sender.
@@ -717,6 +757,14 @@ class Sky(BaseSDK):
         Allowance must be set on USDS contract for UsdsVault.
 
         There are no fees.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `SkyUsdsVault`
+        </Info>
+
 
         :param amount: The amount of USDS you would like to deposit for sUSDS to earn yield.
         :param sender: The address of the transaction sender.
@@ -817,6 +865,15 @@ class Sky(BaseSDK):
         Allowance must be set on USDS contract for UsdsVault.
 
         There are no fees.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `SkyUsdcUsdsConverter`
+        - `SkyUsdsVault`
+        </Info>
+
 
         :param amount: The amount of USDS you would like to withdraw. If set to 'ALL', your total deposited USDS amount will be withdrawn.
         :param sender: The address of the transaction sender.
@@ -917,6 +974,15 @@ class Sky(BaseSDK):
         Allowance must be set on USDS contract for UsdsVault.
 
         There are no fees.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `SkyUsdcUsdsConverter`
+        - `SkyUsdsVault`
+        </Info>
+
 
         :param amount: The amount of USDS you would like to withdraw. If set to 'ALL', your total deposited USDS amount will be withdrawn.
         :param sender: The address of the transaction sender.

compass_api_sdk/uniswap_v3.py

@@ -1057,6 +1057,14 @@ class UniswapV3(BaseSDK):
         provide the necessary transaction details, including the token to buy, the token to
         pay with, and the exact amount to receive. If the token being paid with is WETH and
         needs to be wrapped, the appropriate amount will be wrapped automatically.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `UniswapV3Router`
+        </Info>
+
 
         :param token_in: The symbol of the token to swap from.
         :param token_out: The symbol of the token to swap to.
@@ -1183,6 +1191,14 @@ class UniswapV3(BaseSDK):
         provide the necessary transaction details, including the token to buy, the token to
         pay with, and the exact amount to receive. If the token being paid with is WETH and
         needs to be wrapped, the appropriate amount will be wrapped automatically.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `UniswapV3Router`
+        </Info>
+
 
         :param token_in: The symbol of the token to swap from.
         :param token_out: The symbol of the token to swap to.
@@ -1303,6 +1319,14 @@ class UniswapV3(BaseSDK):
         provide the necessary transaction details, including the token to sell, the token to
         receive, and the amount to sell. If the token being sold is WETH and needs to be
         wrapped, the appropriate amount will be wrapped automatically.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `UniswapV3Router`
+        </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.
@@ -1423,6 +1447,14 @@ class UniswapV3(BaseSDK):
         provide the necessary transaction details, including the token to sell, the token to
         receive, and the amount to sell. If the token being sold is WETH and needs to be
         wrapped, the appropriate amount will be wrapped automatically.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `UniswapV3Router`
+        </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.
@@ -1558,6 +1590,14 @@ class UniswapV3(BaseSDK):
         enabling them to earn fees from trades that occur within the pool. The endpoint
         requires details such as the token pair, amount, and any additional parameters
         needed for the minting process.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `UniswapV3NFTPositionManager`
+        </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.
@@ -1705,6 +1745,14 @@ class UniswapV3(BaseSDK):
         enabling them to earn fees from trades that occur within the pool. The endpoint
         requires details such as the token pair, amount, and any additional parameters
         needed for the minting process.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `UniswapV3NFTPositionManager`
+        </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.
@@ -1847,6 +1895,14 @@ class UniswapV3(BaseSDK):
         within the pool. The endpoint requires details such as the token pair, additional
         amount to be added, and any other parameters necessary for the liquidity increase
         process.
+        <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
@@ -1979,6 +2035,14 @@ class UniswapV3(BaseSDK):
         within the pool. The endpoint requires details such as the token pair, additional
         amount to be added, and any other parameters necessary for the liquidity increase
         process.
+        <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
@@ -2100,6 +2164,14 @@ class UniswapV3(BaseSDK):
         amount to be withdrawn, and any additional parameters needed for the withdrawal
         process. Users should ensure they meet any protocol requirements or conditions
         before initiating a withdrawal to avoid potential issues or penalties.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `UniswapV3NFTPositionManager`
+        </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.
@@ -2215,6 +2287,14 @@ class UniswapV3(BaseSDK):
         amount to be withdrawn, and any additional parameters needed for the withdrawal
         process. Users should ensure they meet any protocol requirements or conditions
         before initiating a withdrawal to avoid potential issues or penalties.
+        <Info>
+        **Required Allowances**
+
+        In order to make this transaction, token allowances need to be set on the following contracts.
+
+        - `UniswapV3NFTPositionManager`
+        </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.dist-info → compass_api_sdk-0.9.46.dist-info}/METADATA

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

{compass_api_sdk-0.9.45.dist-info → compass_api_sdk-0.9.46.dist-info}/RECORD

@@ -2,11 +2,11 @@ compass_api_sdk/__init__.py,sha256=w2u919V3Tzv4zEPQ-OYJ79gQ_4_SyW7GOFFoHtqXDFA,4
 compass_api_sdk/_hooks/__init__.py,sha256=p5J13DeYuISQyQWirjJAObHIf2VtIlOtFqnIpvjjVwk,118
 compass_api_sdk/_hooks/sdkhooks.py,sha256=eVxHB2Q_JG6zZx5xn74i208ij-fpTHqq2jod6fbghRQ,2503
 compass_api_sdk/_hooks/types.py,sha256=4qXm6dEntJOC2QeOdTklcc53oFzTU3HBb1xGdZ-kBXY,3059
-compass_api_sdk/_version.py,sha256=qaG6705xNObV_Og9r38dN8EroFcJKKE4ud64r49wmf0,474
-compass_api_sdk/aave_v3.py,sha256=OhQmjeWl2emRwT0g1D9RUdPn5B3NsO2fdwzszPs3Uug,116614
-compass_api_sdk/aerodrome_slipstream.py,sha256=l57AwIZqQvYpeZp9ZJxfhHXqPD5XRGSH0d5ETV3YLww,78289
+compass_api_sdk/_version.py,sha256=T0qaimFHDeU7bg1JH2Mvp90DcZJi-aPe1le0NYuAmZI,474
+compass_api_sdk/aave_v3.py,sha256=4eQQKFIjY-adOE6Uv30n_9K7XCT74am8uFhvZXE2o4I,118150
+compass_api_sdk/aerodrome_slipstream.py,sha256=Ym1DuavVYneGxdCUp2aGsSnsd6_z4aQ53vohR4RQLoU,80439
 compass_api_sdk/basesdk.py,sha256=PQNcMD7BiLruZwOuU2TeWIE_zQ0iO--XYUFmIDr5zX0,11844
-compass_api_sdk/erc_4626_vaults.py,sha256=h2lIPJYbyj6eBZQ6ww9FiU-ZYwLZpcgN3P0nieQtptc,26383
+compass_api_sdk/erc_4626_vaults.py,sha256=X3CTaLLs5MR6miC_2qzbXpYoAU8m0PT54R_uryOGOps,27171
 compass_api_sdk/errors/__init__.py,sha256=UZYQ_CPi1cQkYcHe6n00nfKPIRwbmcufTY-FmMJGmk8,1693
 compass_api_sdk/errors/apierror.py,sha256=y1lf-8zwQhv1JGntxj03ViMUyHN_Uewe0oZoH8MhwSM,1235
 compass_api_sdk/errors/compassapierror.py,sha256=VqVzBWmwoS3OvoKbgBNh2WFFhrM3K5Kbz_5q4bupD7o,717
@@ -222,18 +222,18 @@ compass_api_sdk/models/weeklyapys.py,sha256=AaGjDD4NeGsZQBwdRW1G09Pmx17pLPe2oUA9
 compass_api_sdk/models/wrapethparams.py,sha256=nw1fZiDrj5wZnI25Vmg0DcNI01k-uhot68lG1_H7xrY,1223
 compass_api_sdk/models/wrapethrequest.py,sha256=pjo0BZtzdOZKuwgnc05LsCWO1A6ZAGLwFixLuXQNKDg,1476
 compass_api_sdk/models/yieldrange.py,sha256=WEpZR24JddnCS1_13y2P1CdD0lBi6dPktysCNu3TUic,324
-compass_api_sdk/morpho.py,sha256=RJ7uw5GswJmy65Imwq3i3svxjuhVpl5c3Q9bv9AY9jw,107770
-compass_api_sdk/pendle.py,sha256=Eb4zJfmfU28fria3eeA_tA2xnKZjvmtTrTJpNrrhb98,93890
+compass_api_sdk/morpho.py,sha256=pviK4dBnaaCENUIEvfI3-2F22SMz9xgXDDWzx1WOHpY,110040
+compass_api_sdk/pendle.py,sha256=hLldhz26PwMgx7vnpIMPNtT5nHL83PZuy-WtOLQGL-Q,96606
 compass_api_sdk/py.typed,sha256=zrp19r0G21lr2yRiMC0f8MFkQFGj9wMpSbboePMg8KM,59
 compass_api_sdk/sdk.py,sha256=rQ3ANGf0BxHoZc9hCQvsxkNc9qOW3DbGAuOz_sy3o7g,7865
 compass_api_sdk/sdkconfiguration.py,sha256=5nec4ViMLCsNWBd3DyEv8zWqU5Z77YZfzwX69jkdSnM,1607
-compass_api_sdk/sky.py,sha256=z7vR7IRGP80G_v7FedI33XJjDMJdk1dID5yi4ezEpew,40691
+compass_api_sdk/sky.py,sha256=hb6gocNjaammmojMrs0PA0uSvmYNWaOjWHdvMNHDgbA,42341
 compass_api_sdk/smart_account.py,sha256=H28RSfvyffnWNBOy7irXHsp4Xcmz-mBgKuJWlsQ6Rv4,8704
 compass_api_sdk/token_sdk.py,sha256=0ecx4CkCV05_KLLDAxX5krEPRgJ8YUKea2ulTTZd1qY,32006
 compass_api_sdk/transaction_bundler.py,sha256=6nij4Wf5g5fyE_DEY0tGr9VGUNvyjXRLqEfA1Y1FUNM,30278
 compass_api_sdk/types/__init__.py,sha256=RArOwSgeeTIva6h-4ttjXwMUeCkz10nAFBL9D-QljI4,377
 compass_api_sdk/types/basemodel.py,sha256=L79WXvTECbSqaJzs8D3ud_KdIWkU7Cx2wbohDAktE9E,1127
-compass_api_sdk/uniswap_v3.py,sha256=MVyv6u_nQFoMXUGv0M6TWTHYAtPuTZjdK3ZQv0NAJRU,101489
+compass_api_sdk/uniswap_v3.py,sha256=RrBsMi9-LZw9RH5SCtx-3l-UxDGNDoGzKyg5xs2CUhU,103527
 compass_api_sdk/universal.py,sha256=zdmsKmRxI9u3kv-kGXUXFY30ARz9Yp8yCYNl1bvjLxs,65113
 compass_api_sdk/utils/__init__.py,sha256=811KKdkxMaWDfz2lMohUWqrR4JnIWxqeNQ1lRGQU4DM,5341
 compass_api_sdk/utils/annotations.py,sha256=aR7mZG34FzgRdew7WZPYEu9QGBerpuKxCF4sek5Z_5Y,1699
@@ -252,6 +252,6 @@ compass_api_sdk/utils/serializers.py,sha256=Hndks5M_rJXVub_N5lu0gKZQUoEmWrn6PN7R
 compass_api_sdk/utils/unmarshal_json_response.py,sha256=GI4Cw4JB6H2qNkqbOuBiUcxtEOJhRm2bz3qfer9KmoE,591
 compass_api_sdk/utils/url.py,sha256=BgGPgcTA6MRK4bF8fjP2dUopN3NzEzxWMXPBVg8NQUA,5254
 compass_api_sdk/utils/values.py,sha256=CcaCXEa3xHhkUDROyXZocN8f0bdITftv9Y0P9lTf0YM,3517
-compass_api_sdk-0.9.45.dist-info/METADATA,sha256=E2rD5bUPoppC9ivsYWuE36Al0rfquCx9TAzbL68jrL8,28507
-compass_api_sdk-0.9.45.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-compass_api_sdk-0.9.45.dist-info/RECORD,,
+compass_api_sdk-0.9.46.dist-info/METADATA,sha256=WbZTghv-ncCeC8L-T5NkgoAW_KB9PkWotqlUkUpsPxI,28507
+compass_api_sdk-0.9.46.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+compass_api_sdk-0.9.46.dist-info/RECORD,,