@compass-labs/api-sdk 0.5.44 → 0.5.46

package/src/mcp-server/tools/morphoRepay.ts

@@ -19,7 +19,15 @@ Repay borrowed tokens to a market in order to reduce or eliminate debt.
 A Morpho Market is a primitive lending pool that pairs one collateral asset with one
 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.`,
+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>
+`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await morphoRepay(

package/src/mcp-server/tools/morphoSupplyCollateral.ts

@@ -19,7 +19,15 @@ Supply collateral to a Morpho Market in order to borrow against it.
 A Morpho Market is a primitive lending pool that pairs one collateral asset with one
 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.`,
+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>
+`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await morphoSupplyCollateral(

package/src/mcp-server/tools/morphoWithdraw.ts

@@ -24,7 +24,15 @@ markets. Users can deposit into a vault to start earning passive yield from inte
 paid by borrowers. Vaults feature automated risk management, actively curating risk
 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.`,
+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>
+`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await morphoWithdraw(

package/src/mcp-server/tools/morphoWithdrawCollateral.ts

@@ -19,7 +19,15 @@ Withdraw collateral that has been supplied to a Morpho Market.
 A Morpho Market is a primitive lending pool that pairs one collateral asset with one
 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.`,
+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>
+`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await morphoWithdrawCollateral(

package/src/mcp-server/tools/pendleAddLiquidity.ts

@@ -17,7 +17,15 @@ export const tool$pendleAddLiquidity: ToolDefinition<typeof args> = {
 Add liquidity to a Pendle Market to earn yield.
 
 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).`,
+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>
+`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await pendleAddLiquidity(

package/src/mcp-server/tools/pendleBuyPt.ts

@@ -14,7 +14,15 @@ export const tool$pendleBuyPt: ToolDefinition<typeof args> = {
   name: "pendle-buy-pt",
   description: `Buy Principal Token (PT)
 
-Buy Principal Token (PT) with market's Underlying Token.`,
+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>
+`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await pendleBuyPt(

package/src/mcp-server/tools/pendleBuyYt.ts

@@ -14,7 +14,15 @@ export const tool$pendleBuyYt: ToolDefinition<typeof args> = {
   name: "pendle-buy-yt",
   description: `Buy Yield Token (YT)
 
-Buy Yield Token (YT) with market's Underlying Token.`,
+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>
+`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await pendleBuyYt(

package/src/mcp-server/tools/pendleRedeemYield.ts

@@ -14,7 +14,15 @@ export const tool$pendleRedeemYield: ToolDefinition<typeof args> = {
   name: "pendle-redeem-yield",
   description: `Redeem Claimable Yield
 
-Redeem claimable yield from the market's associated Yield Token (YT).`,
+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>
+`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await pendleRedeemYield(

package/src/mcp-server/tools/pendleRemoveLiquidity.ts

@@ -18,7 +18,15 @@ Remove liquidity from a Pendle Market.
 
 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`,
+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>
+`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await pendleRemoveLiquidity(

package/src/mcp-server/tools/pendleSellPt.ts

@@ -14,7 +14,15 @@ export const tool$pendleSellPt: ToolDefinition<typeof args> = {
   name: "pendle-sell-pt",
   description: `Sell Principal Token (PT)
 
-Sell Principal Token (PT) for the market's Underlying Token.`,
+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>
+`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await pendleSellPt(

package/src/mcp-server/tools/pendleSellYt.ts

@@ -14,7 +14,15 @@ export const tool$pendleSellYt: ToolDefinition<typeof args> = {
   name: "pendle-sell-yt",
   description: `Sell Yield Token (YT)
 
-Sell Yield Token (YT) for the market's Underlying Token.`,
+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>
+`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await pendleSellYt(

package/src/mcp-server/tools/skyBuy.ts

@@ -20,7 +20,15 @@ If buying with DAI, user will need to set an allowance on the DAI contract for t
 '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>
+`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await skyBuy(

package/src/mcp-server/tools/skyDeposit.ts

@@ -14,9 +14,19 @@ export const tool$skyDeposit: ToolDefinition<typeof args> = {
   name: "sky-deposit",
   description: `Deposit USDS
 
-Deposit USDS for sUSDS to earn yield.
+Deposit USDS to earn yield. Deposited USDS is represented as sUSDS.
 
-There are no fees.`,
+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>
+`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await skyDeposit(

package/src/mcp-server/tools/skySell.ts

@@ -20,7 +20,15 @@ If swapping to DAI, user will need to set an allowance on the USDS contract for
 'SkyDaiUsdsConverter' contract beforehand.
 
 If swapping to USDC, user will need to set an allowance on the USDS contract for the
-'SkyUsdcUsdsConverter' 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>
+`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await skySell(

package/src/mcp-server/tools/skyWithdraw.ts

@@ -14,7 +14,20 @@ export const tool$skyWithdraw: ToolDefinition<typeof args> = {
   name: "sky-withdraw",
   description: `Withdraw USDS
 
-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>
+`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await skyWithdraw(

package/src/mcp-server/tools/uniswapV3LiquidityProvisionIncrease.ts

@@ -24,7 +24,15 @@ positions, thereby increasing their stake in the liquidity pool. This operation
 beneficial for users who wish to enhance their potential earnings from trading fees
 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.`,
+process.
+<Info>
+  **Required Allowances**
+
+    In order to make this transaction, token allowances need to be set on the following contracts.
+
+ - \`AerodromeSlipstreamRouter\`
+</Info>
+`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await uniswapV3LiquidityProvisionIncrease(

package/src/mcp-server/tools/uniswapV3LiquidityProvisionMint.ts

@@ -23,7 +23,15 @@ create a new LP token, which represents their stake in a specific liquidity pool
 This operation is essential for users looking to participate in liquidity provision,
 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.`,
+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>
+`,
     args,
     tool: async (client, args, ctx) => {
       const [result, apiCall] = await uniswapV3LiquidityProvisionMint(

package/src/mcp-server/tools/uniswapV3LiquidityProvisionWithdraw.ts

@@ -25,7 +25,15 @@ users who wish to reclaim their assets or reallocate their liquidity to differen
 pools or investments. The endpoint requires details such as the token pair, the
 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.`,
+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>
+`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await uniswapV3LiquidityProvisionWithdraw(

package/src/mcp-server/tools/uniswapV3SwapBuyExactly.ts

@@ -20,7 +20,15 @@ exact amount of another token using the Uniswap protocol.
 The transaction is executed on the specified blockchain network, and the user must
 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.`,
+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>
+`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await uniswapV3SwapBuyExactly(

package/src/mcp-server/tools/uniswapV3SwapSellExactly.ts

@@ -20,7 +20,15 @@ token using the Uniswap protocol.
 The transaction is executed on the specified blockchain network, and the user must
 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.`,
+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>
+`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await uniswapV3SwapSellExactly(

package/src/models/operations/tokenprice.ts

@@ -6,6 +6,7 @@ import * as z from "zod";
 import { safeParse } from "../../lib/schemas.js";
 import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
@@ -22,68 +23,9 @@ export const TokenPriceChain = {
 export type TokenPriceChain = ClosedEnum<typeof TokenPriceChain>;
 
 /**
- * A class representing the token.
- *
- * @remarks
- *
- * This class is used to represent the token in the system. Notice individual
- * endpoints' documentation where per chain tokens are presented.
+ * The symbol or address of the token for which to get the price.
  */
-export const TokenPriceToken = {
-  OneINCH: "1INCH",
-  Aave: "AAVE",
-  Bal: "BAL",
-  CbBTC: "cbBTC",
-  CbETH: "cbETH",
-  Crv: "CRV",
-  CrvUSD: "crvUSD",
-  Dai: "DAI",
-  Ens: "ENS",
-  ETHx: "ETHx",
-  Frax: "FRAX",
-  Fxs: "FXS",
-  Gho: "GHO",
-  Knc: "KNC",
-  Ldo: "LDO",
-  Link: "LINK",
-  Lusd: "LUSD",
-  Mkr: "MKR",
-  OsETH: "osETH",
-  Pyusd: "PYUSD",
-  RETH: "rETH",
-  Rpl: "RPL",
-  RsETH: "rsETH",
-  SDAI: "sDAI",
-  Snx: "SNX",
-  Stg: "STG",
-  SUSDe: "sUSDe",
-  TBTC: "tBTC",
-  Uni: "UNI",
-  Usdc: "USDC",
-  USDe: "USDe",
-  Usds: "USDS",
-  Usdt: "USDT",
-  Wbtc: "WBTC",
-  WeETH: "weETH",
-  Weth: "WETH",
-  WstETH: "wstETH",
-  Arb: "ARB",
-  Eurs: "EURS",
-  Mai: "MAI",
-  USDCe: "USDCe",
-  Aero: "AERO",
-  Eur: "EUR",
-  Virtual: "VIRTUAL",
-} as const;
-/**
- * A class representing the token.
- *
- * @remarks
- *
- * This class is used to represent the token in the system. Notice individual
- * endpoints' documentation where per chain tokens are presented.
- */
-export type TokenPriceToken = ClosedEnum<typeof TokenPriceToken>;
+export type TokenPriceToken = components.TokenEnum | string;
 
 export type TokenPriceRequest = {
   /**
@@ -95,9 +37,9 @@ export type TokenPriceRequest = {
    */
   block?: number | null | undefined;
   /**
-   * The symbol of the token for which to get the price.
+   * The symbol or address of the token for which to get the price.
    */
-  token?: TokenPriceToken | undefined;
+  token: components.TokenEnum | string;
 };
 
 /** @internal */
@@ -122,14 +64,21 @@ export namespace TokenPriceChain$ {
 }
 
 /** @internal */
-export const TokenPriceToken$inboundSchema: z.ZodNativeEnum<
-  typeof TokenPriceToken
-> = z.nativeEnum(TokenPriceToken);
+export const TokenPriceToken$inboundSchema: z.ZodType<
+  TokenPriceToken,
+  z.ZodTypeDef,
+  unknown
+> = z.union([components.TokenEnum$inboundSchema, z.string()]);
 
 /** @internal */
-export const TokenPriceToken$outboundSchema: z.ZodNativeEnum<
-  typeof TokenPriceToken
-> = TokenPriceToken$inboundSchema;
+export type TokenPriceToken$Outbound = string | string;
+
+/** @internal */
+export const TokenPriceToken$outboundSchema: z.ZodType<
+  TokenPriceToken$Outbound,
+  z.ZodTypeDef,
+  TokenPriceToken
+> = z.union([components.TokenEnum$outboundSchema, z.string()]);
 
 /**
  * @internal
@@ -140,6 +89,24 @@ export namespace TokenPriceToken$ {
   export const inboundSchema = TokenPriceToken$inboundSchema;
   /** @deprecated use `TokenPriceToken$outboundSchema` instead. */
   export const outboundSchema = TokenPriceToken$outboundSchema;
+  /** @deprecated use `TokenPriceToken$Outbound` instead. */
+  export type Outbound = TokenPriceToken$Outbound;
+}
+
+export function tokenPriceTokenToJSON(
+  tokenPriceToken: TokenPriceToken,
+): string {
+  return JSON.stringify(TokenPriceToken$outboundSchema.parse(tokenPriceToken));
+}
+
+export function tokenPriceTokenFromJSON(
+  jsonString: string,
+): SafeParseResult<TokenPriceToken, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TokenPriceToken$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TokenPriceToken' from JSON`,
+  );
 }
 
 /** @internal */
@@ -150,14 +117,14 @@ export const TokenPriceRequest$inboundSchema: z.ZodType<
 > = z.object({
   chain: TokenPriceChain$inboundSchema.default("ethereum:mainnet"),
   block: z.nullable(z.number().int()).optional(),
-  token: TokenPriceToken$inboundSchema.default("AAVE"),
+  token: z.union([components.TokenEnum$inboundSchema, z.string()]),
 });
 
 /** @internal */
 export type TokenPriceRequest$Outbound = {
   chain: string;
   block?: number | null | undefined;
-  token: string;
+  token: string | string;
 };
 
 /** @internal */
@@ -168,7 +135,7 @@ export const TokenPriceRequest$outboundSchema: z.ZodType<
 > = z.object({
   chain: TokenPriceChain$outboundSchema.default("ethereum:mainnet"),
   block: z.nullable(z.number().int()).optional(),
-  token: TokenPriceToken$outboundSchema.default("AAVE"),
+  token: z.union([components.TokenEnum$outboundSchema, z.string()]),
 });
 
 /**

package/src/sdk/aavev3.ts

@@ -243,6 +243,13 @@ export class AaveV3 extends ClientSDK {
    * 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>
    */
   async supply(
     request: components.AaveSupplyRequest,
@@ -263,6 +270,13 @@ export class AaveV3 extends ClientSDK {
    *
    * 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>
    */
   async borrow(
     request: components.AaveBorrowRequest,
@@ -287,6 +301,13 @@ export class AaveV3 extends ClientSDK {
    * 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>
    */
   async repay(
     request: components.AaveRepayRequest,
@@ -312,6 +333,13 @@ export class AaveV3 extends ClientSDK {
    * 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>
    */
   async withdraw(
     request: components.AaveWithdrawRequest,

package/src/sdk/aerodromeslipstream.ts

@@ -75,6 +75,13 @@ export class AerodromeSlipstream extends ClientSDK {
    * 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>
    */
   async slipstreamSwapSellExactly(
     request: components.AerodromeSlipstreamSellExactlyRequest,
@@ -101,6 +108,13 @@ export class AerodromeSlipstream extends ClientSDK {
    * 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>
    */
   async slipstreamSwapBuyExactly(
     request: components.AerodromeSlipstreamBuyExactlyRequest,
@@ -126,6 +140,13 @@ export class AerodromeSlipstream extends ClientSDK {
    * 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>
    */
   async slipstreamLiquidityProvisionMint(
     request: components.AerodromeSlipstreamMintLiquidityProvisionRequest,
@@ -153,6 +174,13 @@ export class AerodromeSlipstream extends ClientSDK {
    * 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>
    */
   async slipstreamLiquidityProvisionIncrease(
     request: components.AerodromeSlipstreamIncreaseLiquidityProvisionRequest,
@@ -180,6 +208,13 @@ export class AerodromeSlipstream extends ClientSDK {
    * 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>
    */
   async slipstreamLiquidityProvisionWithdraw(
     request: components.AerodromeSlipstreamWithdrawLiquidityProvisionRequest,