@compass-labs/api-sdk 0.5.62 → 0.5.63

package/dist/esm/sdk/pendle.js

@@ -62,7 +62,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**
      *
@@ -78,7 +83,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**
      *
@@ -94,7 +104,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**
      *
@@ -110,7 +125,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**
      *
@@ -123,10 +146,18 @@ export class Pendle extends ClientSDK {
         return unwrapAsync(pendleSellYt(this, request, options));
     }
     /**
-     * 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**
      *
@@ -135,17 +166,19 @@ export class Pendle extends ClientSDK {
      *  - `PendleRouter`
      * </Info>
      */
-    async redeemYield(request, options) {
-        return unwrapAsync(pendleRedeemYield(this, request, options));
+    async addLiquidity(request, options) {
+        return unwrapAsync(pendleAddLiquidity(this, request, options));
     }
     /**
-     * Add Liquidity
+     * Remove Liquidity (LP)
      *
      * @remarks
-     * Add liquidity to a Pendle Market to earn yield.
+     * Remove liquidity from a Pendle Market.
+     *
+     * Liquidity is removed from the market into a token of the user's choice.
      *
-     * 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).
+     *  An appropriate allowance for the Pendle Router on the market contract (LP) must be
+     * set beforehand.
      * <Info>
      *   **Required Allowances**
      *
@@ -154,18 +187,14 @@ export class Pendle extends ClientSDK {
      *  - `PendleRouter`
      * </Info>
      */
-    async addLiquidity(request, options) {
-        return unwrapAsync(pendleAddLiquidity(this, request, options));
+    async removeLiquidity(request, options) {
+        return unwrapAsync(pendleRemoveLiquidity(this, request, options));
     }
     /**
-     * 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**
      *
@@ -174,8 +203,8 @@ export class Pendle extends ClientSDK {
      *  - `PendleRouter`
      * </Info>
      */
-    async removeLiquidity(request, options) {
-        return unwrapAsync(pendleRemoveLiquidity(this, request, options));
+    async redeemYield(request, options) {
+        return unwrapAsync(pendleRedeemYield(this, request, options));
     }
 }
 //# sourceMappingURL=pendle.js.map

package/dist/esm/sdk/pendle.js.map

@@ -1 +1 @@
-{"version":3,"file":"pendle.js","sourceRoot":"","sources":["../../../src/sdk/pendle.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,MAAO,SAAQ,SAAS;IACnC;;;;;;;OAOG;IACH,KAAK,CAAC,MAAM,CACV,OAAuC,EACvC,OAAwB;QAExB,OAAO,WAAW,CAAC,YAAY,CAC7B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,SAAS,CACb,OAA0C,EAC1C,OAAwB;QAExB,OAAO,WAAW,CAAC,eAAe,CAChC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAO,CACX,OAAwC,EACxC,OAAwB;QAExB,OAAO,WAAW,CAAC,aAAa,CAC9B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,KAAK,CACT,OAAsC,EACtC,OAAwB;QAExB,OAAO,WAAW,CAAC,WAAW,CAC5B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,KAAK,CACT,OAAsC,EACtC,OAAwB;QAExB,OAAO,WAAW,CAAC,WAAW,CAC5B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,MAAM,CACV,OAAuC,EACvC,OAAwB;QAExB,OAAO,WAAW,CAAC,YAAY,CAC7B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,KAAK,CACT,OAAsC,EACtC,OAAwB;QAExB,OAAO,WAAW,CAAC,WAAW,CAC5B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,MAAM,CACV,OAAuC,EACvC,OAAwB;QAExB,OAAO,WAAW,CAAC,YAAY,CAC7B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,WAAW,CACf,OAA4C,EAC5C,OAAwB;QAExB,OAAO,WAAW,CAAC,iBAAiB,CAClC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,YAAY,CAChB,OAA6C,EAC7C,OAAwB;QAExB,OAAO,WAAW,CAAC,kBAAkB,CACnC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,eAAe,CACnB,OAAgD,EAChD,OAAwB;QAExB,OAAO,WAAW,CAAC,qBAAqB,CACtC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"pendle.js","sourceRoot":"","sources":["../../../src/sdk/pendle.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,MAAO,SAAQ,SAAS;IACnC;;;;;;;OAOG;IACH,KAAK,CAAC,MAAM,CACV,OAAuC,EACvC,OAAwB;QAExB,OAAO,WAAW,CAAC,YAAY,CAC7B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,SAAS,CACb,OAA0C,EAC1C,OAAwB;QAExB,OAAO,WAAW,CAAC,eAAe,CAChC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAO,CACX,OAAwC,EACxC,OAAwB;QAExB,OAAO,WAAW,CAAC,aAAa,CAC9B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,KAAK,CACT,OAAsC,EACtC,OAAwB;QAExB,OAAO,WAAW,CAAC,WAAW,CAC5B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,KAAK,CACT,OAAsC,EACtC,OAAwB;QAExB,OAAO,WAAW,CAAC,WAAW,CAC5B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,MAAM,CACV,OAAuC,EACvC,OAAwB;QAExB,OAAO,WAAW,CAAC,YAAY,CAC7B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,KAAK,CACT,OAAsC,EACtC,OAAwB;QAExB,OAAO,WAAW,CAAC,WAAW,CAC5B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,MAAM,CACV,OAAuC,EACvC,OAAwB;QAExB,OAAO,WAAW,CAAC,YAAY,CAC7B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,YAAY,CAChB,OAA6C,EAC7C,OAAwB;QAExB,OAAO,WAAW,CAAC,kBAAkB,CACnC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,eAAe,CACnB,OAAgD,EAChD,OAAwB;QAExB,OAAO,WAAW,CAAC,qBAAqB,CACtC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,WAAW,CACf,OAA4C,EAC5C,OAAwB;QAExB,OAAO,WAAW,CAAC,iBAAiB,CAClC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}

package/docs/sdks/pendle/README.md

@@ -13,9 +13,9 @@
 * [sellPt](#sellpt) - Sell Principal Token (PT)
 * [buyYt](#buyyt) - Buy Yield Token (YT)
 * [sellYt](#sellyt) - Sell Yield Token (YT)
+* [addLiquidity](#addliquidity) - Add Liquidity (LP)
+* [removeLiquidity](#removeliquidity) - Remove Liquidity (LP)
 * [redeemYield](#redeemyield) - Redeem Claimable Yield
-* [addLiquidity](#addliquidity) - Add Liquidity
-* [removeLiquidity](#removeliquidity) - Remove Liquidity
 
 ## market
 
@@ -314,7 +314,12 @@ run();
 
 ## buyPt
 
-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**
 
@@ -406,7 +411,12 @@ run();
 
 ## sellPt
 
-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**
 
@@ -498,7 +508,12 @@ run();
 
 ## buyYt
 
-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**
 
@@ -590,7 +605,15 @@ run();
 
 ## sellYt
 
-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**
 
@@ -680,9 +703,17 @@ run();
 | errors.HTTPValidationError | 422                        | application/json           |
 | errors.APIError            | 4XX, 5XX                   | \*/\*                      |
 
-## redeemYield
+## addLiquidity
 
-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**
 
@@ -694,7 +725,7 @@ Redeem claimable yield from the market's associated Yield Token (YT).
 
 ### Example Usage
 
-<!-- UsageSnippet language="typescript" operationID="pendle_redeem_yield" method="post" path="/v0/pendle/redeem_yield" -->
+<!-- UsageSnippet language="typescript" operationID="pendle_add_liquidity" method="post" path="/v0/pendle/add_liquidity" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -703,8 +734,11 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.pendle.redeemYield({
+  const result = await compassApiSDK.pendle.addLiquidity({
     marketAddress: "0x08a152834de126d2ef83d612ff36e4523fd0017f",
+    tokenIn: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
+    amountIn: 1.5,
+    maxSlippagePercent: 0.5,
     chain: "ethereum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
@@ -721,7 +755,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
-import { pendleRedeemYield } from "@compass-labs/api-sdk/funcs/pendleRedeemYield.js";
+import { pendleAddLiquidity } from "@compass-labs/api-sdk/funcs/pendleAddLiquidity.js";
 
 // Use `CompassApiSDKCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -730,8 +764,11 @@ const compassApiSDK = new CompassApiSDKCore({
 });
 
 async function run() {
-  const res = await pendleRedeemYield(compassApiSDK, {
+  const res = await pendleAddLiquidity(compassApiSDK, {
     marketAddress: "0x08a152834de126d2ef83d612ff36e4523fd0017f",
+    tokenIn: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
+    amountIn: 1.5,
+    maxSlippagePercent: 0.5,
     chain: "ethereum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
@@ -739,7 +776,7 @@ async function run() {
     const { value: result } = res;
     console.log(result);
   } else {
-    console.log("pendleRedeemYield failed:", res.error);
+    console.log("pendleAddLiquidity failed:", res.error);
   }
 }
 
@@ -750,7 +787,7 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.PendleRedeemYieldRequest](../../models/components/pendleredeemyieldrequest.md)                                                                                     | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [components.PendleAddLiquidityRequest](../../models/components/pendleaddliquidityrequest.md)                                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
@@ -766,12 +803,14 @@ run();
 | errors.HTTPValidationError | 422                        | application/json           |
 | errors.APIError            | 4XX, 5XX                   | \*/\*                      |
 
-## addLiquidity
+## removeLiquidity
 
-Add liquidity to a Pendle Market to earn yield.
+Remove liquidity from a Pendle Market.
+
+Liquidity is removed from the market into a token of the user's choice.
 
-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).
+ An appropriate allowance for the Pendle Router on the market contract (LP) must be
+set beforehand.
 <Info>
   **Required Allowances**
 
@@ -783,7 +822,7 @@ the liquidity received is the market's Liquidity Provider Token (LP).
 
 ### Example Usage
 
-<!-- UsageSnippet language="typescript" operationID="pendle_add_liquidity" method="post" path="/v0/pendle/add_liquidity" -->
+<!-- UsageSnippet language="typescript" operationID="pendle_remove_liquidity" method="post" path="/v0/pendle/remove_liquidity" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -792,9 +831,9 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.pendle.addLiquidity({
+  const result = await compassApiSDK.pendle.removeLiquidity({
     marketAddress: "0x08a152834de126d2ef83d612ff36e4523fd0017f",
-    tokenIn: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
+    tokenOut: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
     amountIn: 1.5,
     maxSlippagePercent: 0.5,
     chain: "ethereum:mainnet",
@@ -813,7 +852,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
-import { pendleAddLiquidity } from "@compass-labs/api-sdk/funcs/pendleAddLiquidity.js";
+import { pendleRemoveLiquidity } from "@compass-labs/api-sdk/funcs/pendleRemoveLiquidity.js";
 
 // Use `CompassApiSDKCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -822,9 +861,9 @@ const compassApiSDK = new CompassApiSDKCore({
 });
 
 async function run() {
-  const res = await pendleAddLiquidity(compassApiSDK, {
+  const res = await pendleRemoveLiquidity(compassApiSDK, {
     marketAddress: "0x08a152834de126d2ef83d612ff36e4523fd0017f",
-    tokenIn: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
+    tokenOut: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
     amountIn: 1.5,
     maxSlippagePercent: 0.5,
     chain: "ethereum:mainnet",
@@ -834,7 +873,7 @@ async function run() {
     const { value: result } = res;
     console.log(result);
   } else {
-    console.log("pendleAddLiquidity failed:", res.error);
+    console.log("pendleRemoveLiquidity failed:", res.error);
   }
 }
 
@@ -845,7 +884,7 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.PendleAddLiquidityRequest](../../models/components/pendleaddliquidityrequest.md)                                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [components.PendleRemoveLiquidityRequest](../../models/components/pendleremoveliquidityrequest.md)                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
@@ -861,13 +900,9 @@ run();
 | errors.HTTPValidationError | 422                        | application/json           |
 | errors.APIError            | 4XX, 5XX                   | \*/\*                      |
 
-## removeLiquidity
-
-Remove liquidity from a Pendle Market.
+## redeemYield
 
-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**
 
@@ -879,7 +914,7 @@ market contract must be set beforehand
 
 ### Example Usage
 
-<!-- UsageSnippet language="typescript" operationID="pendle_remove_liquidity" method="post" path="/v0/pendle/remove_liquidity" -->
+<!-- UsageSnippet language="typescript" operationID="pendle_redeem_yield" method="post" path="/v0/pendle/redeem_yield" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -888,11 +923,8 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.pendle.removeLiquidity({
+  const result = await compassApiSDK.pendle.redeemYield({
     marketAddress: "0x08a152834de126d2ef83d612ff36e4523fd0017f",
-    tokenOut: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
-    amountIn: 1.5,
-    maxSlippagePercent: 0.5,
     chain: "ethereum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
@@ -909,7 +941,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
-import { pendleRemoveLiquidity } from "@compass-labs/api-sdk/funcs/pendleRemoveLiquidity.js";
+import { pendleRedeemYield } from "@compass-labs/api-sdk/funcs/pendleRedeemYield.js";
 
 // Use `CompassApiSDKCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -918,11 +950,8 @@ const compassApiSDK = new CompassApiSDKCore({
 });
 
 async function run() {
-  const res = await pendleRemoveLiquidity(compassApiSDK, {
+  const res = await pendleRedeemYield(compassApiSDK, {
     marketAddress: "0x08a152834de126d2ef83d612ff36e4523fd0017f",
-    tokenOut: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
-    amountIn: 1.5,
-    maxSlippagePercent: 0.5,
     chain: "ethereum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
@@ -930,7 +959,7 @@ async function run() {
     const { value: result } = res;
     console.log(result);
   } else {
-    console.log("pendleRemoveLiquidity failed:", res.error);
+    console.log("pendleRedeemYield failed:", res.error);
   }
 }
 
@@ -941,7 +970,7 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.PendleRemoveLiquidityRequest](../../models/components/pendleremoveliquidityrequest.md)                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [components.PendleRedeemYieldRequest](../../models/components/pendleredeemyieldrequest.md)                                                                                     | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@compass-labs/api-sdk",
-  "version": "0.5.62",
+  "version": "0.5.63",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@compass-labs/api-sdk",
-  "version": "0.5.62",
+  "version": "0.5.63",
   "author": "royalnine",
   "type": "module",
   "bin": {

package/src/funcs/pendleAddLiquidity.ts

@@ -26,13 +26,18 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Add Liquidity
+ * Add Liquidity (LP)
  *
  * @remarks
  * 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/funcs/pendleBuyPt.ts

@@ -29,7 +29,12 @@ import { Result } from "../types/fp.js";
  * 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**
  *

package/src/funcs/pendleBuyYt.ts

@@ -29,7 +29,12 @@ import { Result } from "../types/fp.js";
  * 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**
  *

package/src/funcs/pendleRemoveLiquidity.ts

@@ -26,14 +26,15 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Remove Liquidity
+ * Remove Liquidity (LP)
  *
  * @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
+ * 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/funcs/pendleSellPt.ts

@@ -29,7 +29,12 @@ import { Result } from "../types/fp.js";
  * 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**
  *

package/src/funcs/pendleSellYt.ts

@@ -29,7 +29,15 @@ import { Result } from "../types/fp.js";
  * 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**
  *

package/src/lib/config.ts

@@ -61,8 +61,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.0.1",
-  sdkVersion: "0.5.62",
+  sdkVersion: "0.5.63",
   genVersion: "2.667.0",
   userAgent:
-    "speakeasy-sdk/typescript 0.5.62 2.667.0 0.0.1 @compass-labs/api-sdk",
+    "speakeasy-sdk/typescript 0.5.63 2.667.0 0.0.1 @compass-labs/api-sdk",
 } as const;

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

@@ -19,7 +19,7 @@ const routes = buildRouteMap({
 export const app = buildApplication(routes, {
   name: "mcp",
   versionInfo: {
-    currentVersion: "0.5.62",
+    currentVersion: "0.5.63",
   },
 });
 

package/src/mcp-server/server.ts

@@ -104,7 +104,7 @@ export function createMCPServer(deps: {
 }) {
   const server = new McpServer({
     name: "CompassApiSDK",
-    version: "0.5.62",
+    version: "0.5.63",
   });
 
   const client = new CompassApiSDKCore({
@@ -203,9 +203,9 @@ export function createMCPServer(deps: {
   tool(tool$pendleSellPt);
   tool(tool$pendleBuyYt);
   tool(tool$pendleSellYt);
-  tool(tool$pendleRedeemYield);
   tool(tool$pendleAddLiquidity);
   tool(tool$pendleRemoveLiquidity);
+  tool(tool$pendleRedeemYield);
   tool(tool$swapOdos);
   tool(tool$transactionBundlerBundlerAuthorization);
   tool(tool$transactionBundlerBundlerExecute);