@compass-labs/api-sdk 0.5.44 → 0.5.46

package/src/sdk/erc4626vaults.ts

@@ -37,6 +37,13 @@ export class Erc4626Vaults extends ClientSDK {
    * 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>
    */
   async deposit(
     request: components.VaultDepositRequest,
@@ -58,6 +65,13 @@ export class Erc4626Vaults extends ClientSDK {
    * 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>
    */
   async withdraw(
     request: components.VaultWithdrawRequest,

package/src/sdk/morpho.ts

@@ -159,6 +159,13 @@ export class Morpho extends ClientSDK {
    * 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>
    */
   async deposit(
     request: components.MorphoDepositRequest,
@@ -186,6 +193,13 @@ export class Morpho extends ClientSDK {
    * 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>
    */
   async withdraw(
     request: components.MorphoWithdrawRequest,
@@ -208,6 +222,13 @@ export class Morpho extends ClientSDK {
    * 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>
    */
   async supplyCollateral(
     request: components.MorphoSupplyCollateralRequest,
@@ -230,6 +251,13 @@ export class Morpho extends ClientSDK {
    * 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>
    */
   async withdrawCollateral(
     request: components.MorphoWithdrawCollateralRequest,
@@ -255,6 +283,13 @@ export class Morpho extends ClientSDK {
    * 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>
    */
   async borrow(
     request: components.MorphoBorrowRequest,
@@ -277,6 +312,13 @@ export class Morpho extends ClientSDK {
    * 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>
    */
   async repay(
     request: components.MorphoRepayRequest,

package/src/sdk/pendle.ts

@@ -99,6 +99,13 @@ export class Pendle extends ClientSDK {
    *
    * @remarks
    * 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>
    */
   async buyPt(
     request: components.PendleBuyPtRequest,
@@ -116,6 +123,13 @@ export class Pendle extends ClientSDK {
    *
    * @remarks
    * 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>
    */
   async sellPt(
     request: components.PendleSellPtRequest,
@@ -133,6 +147,13 @@ export class Pendle extends ClientSDK {
    *
    * @remarks
    * 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>
    */
   async buyYt(
     request: components.PendleBuyYtRequest,
@@ -150,6 +171,13 @@ export class Pendle extends ClientSDK {
    *
    * @remarks
    * 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>
    */
   async sellYt(
     request: components.PendleSellYtRequest,
@@ -167,6 +195,13 @@ export class Pendle extends ClientSDK {
    *
    * @remarks
    * 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>
    */
   async redeemYield(
     request: components.PendleRedeemYieldRequest,
@@ -187,6 +222,13 @@ export class Pendle extends ClientSDK {
    *
    * 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>
    */
   async addLiquidity(
     request: components.PendleAddLiquidityRequest,
@@ -208,6 +250,13 @@ export class Pendle extends ClientSDK {
    * 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>
    */
   async removeLiquidity(
     request: components.PendleRemoveLiquidityRequest,

package/src/sdk/sky.ts

@@ -40,7 +40,14 @@ export class Sky extends ClientSDK {
    * 'SkyDaiUsdsConverter' contract beforehand.
    *
    * If buying with USDC, user will need to set an allowance on the USDC contract for the
-   * 'SkyDaiUsdsConverter' contract beforehand.
+   * 'SkyUsdcUsdsConverter' contract beforehand.
+   * <Info>
+   *   **Required Allowances**
+   *
+   *     In order to make this transaction, token allowances need to be set on the following contracts.
+   *
+   *  - `SkyUsdcUsdsConverter`
+   * </Info>
    */
   async buy(
     request: components.SkyBuyRequest,
@@ -64,6 +71,13 @@ export class Sky extends ClientSDK {
    *
    * 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>
    */
   async sell(
     request: components.SkySellRequest,
@@ -80,9 +94,18 @@ export class Sky extends ClientSDK {
    * Deposit USDS
    *
    * @remarks
-   * Deposit USDS for sUSDS to earn yield.
+   * Deposit USDS to earn yield. Deposited USDS is represented as sUSDS.
+   *
+   * 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>
    */
   async deposit(
     request: components.SkyDepositRequest,
@@ -99,7 +122,19 @@ export class Sky extends ClientSDK {
    * Withdraw USDS
    *
    * @remarks
-   * Withdraw USDS for sUSDS to stop earning yield.
+   * Withdraw USDS. Exchange yield-bearing sUSDS for USDS.
+   *
+   * 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>
    */
   async withdraw(
     request: components.SkyWithdrawRequest,

package/src/sdk/uniswapv3.ts

@@ -137,6 +137,13 @@ export class UniswapV3 extends ClientSDK {
    * 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>
    */
   async swapBuyExactly(
     request: components.UniswapBuyExactlyRequest,
@@ -160,6 +167,13 @@ export class UniswapV3 extends ClientSDK {
    * 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>
    */
   async swapSellExactly(
     request: components.UniswapSellExactlyRequest,
@@ -185,6 +199,13 @@ export class UniswapV3 extends ClientSDK {
    * 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>
    */
   async liquidityProvisionMint(
     request: components.UniswapMintLiquidityProvisionRequest,
@@ -210,6 +231,13 @@ export class UniswapV3 extends ClientSDK {
    * 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>
    */
   async liquidityProvisionIncrease(
     request: components.UniswapIncreaseLiquidityProvisionRequest,
@@ -236,6 +264,13 @@ export class UniswapV3 extends ClientSDK {
    * 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>
    */
   async liquidityProvisionWithdraw(
     request: components.UniswapWithdrawLiquidityProvisionRequest,