@compass-labs/api-sdk 0.5.62 → 0.5.63

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

@@ -12,12 +12,17 @@ const args = {
 
 export const tool$pendleAddLiquidity: ToolDefinition<typeof args> = {
   name: "pendle-add-liquidity",
-  description: `Add Liquidity
+  description: `Add Liquidity (LP)
 
 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).
+Liquidity is added to the market with a token of the user's choice.
+
+Representation of the liquidity provided is in the form of market's Liquidity
+Provider Token (LP) received by the user.
+
+An appropriate allowance for the Pendle Router on the token_in contract must be set
+beforehand.
 <Info>
   **Required Allowances**
 

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

@@ -14,7 +14,12 @@ 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 market's Principal Token (PT) for fixed yield.
+
+PT is bought with a token of the user's choice.
+
+An appropriate allowance for the Pendle Router on the token_in contract must be set
+beforehand.
 <Info>
   **Required Allowances**
 

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

@@ -14,7 +14,12 @@ 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) to go long yield and earn variable yield.
+
+YT is bought with a token of the user's choice.
+
+An appropriate allowance for the Pendle Router on the token_in contract must be set
+beforehand.
 <Info>
   **Required Allowances**
 

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

@@ -12,13 +12,14 @@ const args = {
 
 export const tool$pendleRemoveLiquidity: ToolDefinition<typeof args> = {
   name: "pendle-remove-liquidity",
-  description: `Remove Liquidity
+  description: `Remove Liquidity (LP)
 
 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
+Liquidity is removed from the market into a token of the user's choice.
+
+ An appropriate allowance for the Pendle Router on the market contract (LP) must be
+set beforehand.
 <Info>
   **Required Allowances**
 

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

@@ -14,7 +14,12 @@ 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) to redeem the fixed yield you have earned thus far.
+
+PT is sold for a token of the user's choice.
+
+An appropriate allowance for the Pendle Router on the market's PT token contract
+must be set beforehand.
 <Info>
   **Required Allowances**
 

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) to stop earning variable yield.
+
+YT is sold for a token of the user's choice.
+
+An appropriate allowance for the Pendle Router on the market's YT token contract
+must be set beforehand.
+
+Make sure to redeem yield earned thus far by calling the 'Redeem Claimable Yield'
+before selling YT.
 <Info>
   **Required Allowances**
 

package/src/sdk/pendle.ts

@@ -98,7 +98,12 @@ export class Pendle extends ClientSDK {
    * Buy Principal Token (PT)
    *
    * @remarks
-   * Buy Principal Token (PT) with market's Underlying Token.
+   * Buy market's Principal Token (PT) for fixed yield.
+   *
+   * PT is bought with a token of the user's choice.
+   *
+   * An appropriate allowance for the Pendle Router on the token_in contract must be set
+   * beforehand.
    * <Info>
    *   **Required Allowances**
    *
@@ -122,7 +127,12 @@ export class Pendle extends ClientSDK {
    * Sell Principal Token (PT)
    *
    * @remarks
-   * Sell Principal Token (PT) for the market's Underlying Token.
+   * Sell Principal Token (PT) to redeem the fixed yield you have earned thus far.
+   *
+   * PT is sold for a token of the user's choice.
+   *
+   * An appropriate allowance for the Pendle Router on the market's PT token contract
+   * must be set beforehand.
    * <Info>
    *   **Required Allowances**
    *
@@ -146,7 +156,12 @@ export class Pendle extends ClientSDK {
    * Buy Yield Token (YT)
    *
    * @remarks
-   * Buy Yield Token (YT) with market's Underlying Token.
+   * Buy Yield Token (YT) to go long yield and earn variable yield.
+   *
+   * YT is bought with a token of the user's choice.
+   *
+   * An appropriate allowance for the Pendle Router on the token_in contract must be set
+   * beforehand.
    * <Info>
    *   **Required Allowances**
    *
@@ -170,7 +185,15 @@ export class Pendle extends ClientSDK {
    * Sell Yield Token (YT)
    *
    * @remarks
-   * Sell Yield Token (YT) for the market's Underlying Token.
+   * Sell Yield Token (YT) to stop earning variable yield.
+   *
+   * YT is sold for a token of the user's choice.
+   *
+   * An appropriate allowance for the Pendle Router on the market's YT token contract
+   * must be set beforehand.
+   *
+   * Make sure to redeem yield earned thus far by calling the 'Redeem Claimable Yield'
+   * before selling YT.
    * <Info>
    *   **Required Allowances**
    *
@@ -191,10 +214,18 @@ export class Pendle extends ClientSDK {
   }
 
   /**
-   * Redeem Claimable Yield
+   * Add Liquidity (LP)
    *
    * @remarks
-   * Redeem claimable yield from the market's associated Yield Token (YT).
+   * Add liquidity to a Pendle Market to earn yield.
+   *
+   * Liquidity is added to the market with a token of the user's choice.
+   *
+   * Representation of the liquidity provided is in the form of market's Liquidity
+   * Provider Token (LP) received by the user.
+   *
+   * An appropriate allowance for the Pendle Router on the token_in contract must be set
+   * beforehand.
    * <Info>
    *   **Required Allowances**
    *
@@ -203,11 +234,11 @@ export class Pendle extends ClientSDK {
    *  - `PendleRouter`
    * </Info>
    */
-  async redeemYield(
-    request: components.PendleRedeemYieldRequest,
+  async addLiquidity(
+    request: components.PendleAddLiquidityRequest,
     options?: RequestOptions,
   ): Promise<components.TxResponse> {
-    return unwrapAsync(pendleRedeemYield(
+    return unwrapAsync(pendleAddLiquidity(
       this,
       request,
       options,
@@ -215,13 +246,15 @@ export class Pendle extends ClientSDK {
   }
 
   /**
-   * Add Liquidity
+   * Remove Liquidity (LP)
    *
    * @remarks
-   * Add liquidity to a Pendle Market to earn yield.
+   * Remove liquidity from a Pendle Market.
    *
-   * 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).
+   * Liquidity is removed from the market into a token of the user's choice.
+   *
+   *  An appropriate allowance for the Pendle Router on the market contract (LP) must be
+   * set beforehand.
    * <Info>
    *   **Required Allowances**
    *
@@ -230,11 +263,11 @@ export class Pendle extends ClientSDK {
    *  - `PendleRouter`
    * </Info>
    */
-  async addLiquidity(
-    request: components.PendleAddLiquidityRequest,
+  async removeLiquidity(
+    request: components.PendleRemoveLiquidityRequest,
     options?: RequestOptions,
   ): Promise<components.TxResponse> {
-    return unwrapAsync(pendleAddLiquidity(
+    return unwrapAsync(pendleRemoveLiquidity(
       this,
       request,
       options,
@@ -242,14 +275,10 @@ export class Pendle extends ClientSDK {
   }
 
   /**
-   * Remove Liquidity
+   * Redeem Claimable Yield
    *
    * @remarks
-   * 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
+   * Redeem claimable yield from the market's associated Yield Token (YT).
    * <Info>
    *   **Required Allowances**
    *
@@ -258,11 +287,11 @@ export class Pendle extends ClientSDK {
    *  - `PendleRouter`
    * </Info>
    */
-  async removeLiquidity(
-    request: components.PendleRemoveLiquidityRequest,
+  async redeemYield(
+    request: components.PendleRedeemYieldRequest,
     options?: RequestOptions,
   ): Promise<components.TxResponse> {
-    return unwrapAsync(pendleRemoveLiquidity(
+    return unwrapAsync(pendleRedeemYield(
       this,
       request,
       options,