@compass-labs/api-sdk 0.5.7 → 0.5.9

package/docs/sdks/pendle/README.md

@@ -7,13 +7,15 @@
 
 * [position](#position) - Check User's Market Position
 * [positions](#positions) - List User's Market Positions
-* [markets](#markets) - List Market Data
 * [market](#market) - Get Market Data
+* [markets](#markets) - List Market Data
 * [buyPt](#buypt) - Buy Principal Token (PT)
 * [sellPt](#sellpt) - Sell Principal Token (PT)
 * [buyYt](#buyyt) - Buy Yield Token (YT)
 * [sellYt](#sellyt) - Sell Yield Token (YT)
 * [redeemYield](#redeemyield) - Redeem Claimable Yield
+* [addLiquidity](#addliquidity) - Add Liquidity
+* [removeLiquidity](#removeliquidity) - Remove Liquidity
 
 ## position
 
@@ -29,13 +31,8 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.pendle.position({
-    chain: "ethereum:mainnet",
-    userAddress: "0xa829B388A3DF7f581cE957a95edbe419dd146d1B",
-    marketAddress: "0xc374f7ec85f8c7de3207a10bb1978ba104bda3b2",
-  });
+  const result = await compassApiSDK.pendle.position({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -57,20 +54,13 @@ const compassApiSDK = new CompassApiSDKCore({
 });
 
 async function run() {
-  const res = await pendlePosition(compassApiSDK, {
-    chain: "ethereum:mainnet",
-    userAddress: "0xa829B388A3DF7f581cE957a95edbe419dd146d1B",
-    marketAddress: "0xc374f7ec85f8c7de3207a10bb1978ba104bda3b2",
-  });
-
-  if (!res.ok) {
-    throw res.error;
+  const res = await pendlePosition(compassApiSDK, {});
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("pendlePosition failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -110,12 +100,8 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.pendle.positions({
-    chain: "ethereum:mainnet",
-    userAddress: "0xa829B388A3DF7f581cE957a95edbe419dd146d1B",
-  });
+  const result = await compassApiSDK.pendle.positions({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -137,19 +123,13 @@ const compassApiSDK = new CompassApiSDKCore({
 });
 
 async function run() {
-  const res = await pendlePositions(compassApiSDK, {
-    chain: "ethereum:mainnet",
-    userAddress: "0xa829B388A3DF7f581cE957a95edbe419dd146d1B",
-  });
-
-  if (!res.ok) {
-    throw res.error;
+  const res = await pendlePositions(compassApiSDK, {});
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("pendlePositions failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -175,9 +155,9 @@ run();
 | errors.HTTPValidationError | 422                        | application/json           |
 | errors.APIError            | 4XX, 5XX                   | \*/\*                      |
 
-## markets
+## market
 
-Get a list of active markets.
+Get the market's implied APY, maturity date and the associated token data.
 
 ### Example Usage
 
@@ -189,11 +169,8 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.pendle.markets({
-    chain: "ethereum:mainnet",
-  });
+  const result = await compassApiSDK.pendle.market({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -206,7 +183,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
-import { pendleMarkets } from "@compass-labs/api-sdk/funcs/pendleMarkets.js";
+import { pendleMarket } from "@compass-labs/api-sdk/funcs/pendleMarket.js";
 
 // Use `CompassApiSDKCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -215,18 +192,13 @@ const compassApiSDK = new CompassApiSDKCore({
 });
 
 async function run() {
-  const res = await pendleMarkets(compassApiSDK, {
-    chain: "ethereum:mainnet",
-  });
-
-  if (!res.ok) {
-    throw res.error;
+  const res = await pendleMarket(compassApiSDK, {});
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("pendleMarket failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -236,14 +208,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.PendleMarketsRequest](../../models/operations/pendlemarketsrequest.md)                                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.PendleMarketRequest](../../models/operations/pendlemarketrequest.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.                                                                                                               |
 
 ### Response
 
-**Promise\<[components.PendleListMarketsResponse](../../models/components/pendlelistmarketsresponse.md)\>**
+**Promise\<[components.PendleGetMarketResponse](../../models/components/pendlegetmarketresponse.md)\>**
 
 ### Errors
 
@@ -252,9 +224,9 @@ run();
 | errors.HTTPValidationError | 422                        | application/json           |
 | errors.APIError            | 4XX, 5XX                   | \*/\*                      |
 
-## market
+## markets
 
-Get the market's implied APY, maturity date and the associated token data.
+Get a list of active markets.
 
 ### Example Usage
 
@@ -266,12 +238,8 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.pendle.market({
-    chain: "ethereum:mainnet",
-    marketAddress: "0xc374f7ec85f8c7de3207a10bb1978ba104bda3b2",
-  });
+  const result = await compassApiSDK.pendle.markets({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -284,7 +252,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
-import { pendleMarket } from "@compass-labs/api-sdk/funcs/pendleMarket.js";
+import { pendleMarkets } from "@compass-labs/api-sdk/funcs/pendleMarkets.js";
 
 // Use `CompassApiSDKCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -293,19 +261,13 @@ const compassApiSDK = new CompassApiSDKCore({
 });
 
 async function run() {
-  const res = await pendleMarket(compassApiSDK, {
-    chain: "ethereum:mainnet",
-    marketAddress: "0xc374f7ec85f8c7de3207a10bb1978ba104bda3b2",
-  });
-
-  if (!res.ok) {
-    throw res.error;
+  const res = await pendleMarkets(compassApiSDK, {});
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("pendleMarkets failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -315,14 +277,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.PendleMarketRequest](../../models/operations/pendlemarketrequest.md)                                                                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.PendleMarketsRequest](../../models/operations/pendlemarketsrequest.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.                                                                                                               |
 
 ### Response
 
-**Promise\<[components.PendleGetMarketResponse](../../models/components/pendlegetmarketresponse.md)\>**
+**Promise\<[components.PendleListMarketsResponse](../../models/components/pendlelistmarketsresponse.md)\>**
 
 ### Errors
 
@@ -352,7 +314,6 @@ async function run() {
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -380,15 +341,12 @@ async function run() {
     chain: "arbitrum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("pendleBuyPt failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -435,7 +393,6 @@ async function run() {
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -463,15 +420,12 @@ async function run() {
     chain: "base:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("pendleSellPt failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -518,7 +472,6 @@ async function run() {
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -546,15 +499,12 @@ async function run() {
     chain: "arbitrum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("pendleBuyYt failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -601,7 +551,6 @@ async function run() {
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -629,15 +578,12 @@ async function run() {
     chain: "arbitrum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("pendleSellYt failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -683,7 +629,6 @@ async function run() {
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -710,25 +655,187 @@ async function run() {
     chain: "base:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("pendleRedeemYield failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `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.                                                                                                               |
+
+### Response
+
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## addLiquidity
+
+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).
+
+### Example Usage
+
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.pendle.addLiquidity({
+    marketAddress: "0x08a152834de126d2ef83d612ff36e4523fd0017f",
+    amount: 1.5,
+    chain: "base:mainnet",
+    sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+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";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
 
-  if (!res.ok) {
-    throw res.error;
+async function run() {
+  const res = await pendleAddLiquidity(compassApiSDK, {
+    marketAddress: "0x08a152834de126d2ef83d612ff36e4523fd0017f",
+    amount: 1.5,
+    chain: "base:mainnet",
+    sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("pendleAddLiquidity failed:", res.error);
   }
+}
+
+run();
+```
 
-  const { value: result } = res;
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `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.                                                                                                               |
+
+### Response
+
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## removeLiquidity
+
+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
+
+### Example Usage
+
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.pendle.removeLiquidity({
+    marketAddress: "0x08a152834de126d2ef83d612ff36e4523fd0017f",
+    amount: 1.5,
+    chain: "arbitrum:mainnet",
+    sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+  });
 
-  // Handle the result
   console.log(result);
 }
 
 run();
 ```
 
+### Standalone function
+
+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";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await pendleRemoveLiquidity(compassApiSDK, {
+    marketAddress: "0x08a152834de126d2ef83d612ff36e4523fd0017f",
+    amount: 1.5,
+    chain: "arbitrum:mainnet",
+    sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("pendleRemoveLiquidity failed:", res.error);
+  }
+}
+
+run();
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.PendleRedeemYieldRequest](../../models/components/pendleredeemyieldrequest.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.                                                                                                               |