@compass-labs/api-sdk 0.5.45 → 0.5.46

package/src/sdk/sky.ts

@@ -41,6 +41,13 @@ export class Sky extends ClientSDK {
    *
    * 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>
    */
   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,
@@ -85,6 +99,13 @@ export class Sky extends ClientSDK {
    * 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,
@@ -106,6 +127,14 @@ export class Sky extends ClientSDK {
    * 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,