@compass-labs/api-sdk 0.0.3

package/docs/sdks/aerodromeslipstream/README.md

@@ -0,0 +1,667 @@
+# AerodromeSlipstream
+(*aerodromeSlipstream*)
+
+## Overview
+
+### Available Operations
+
+* [slipstreamLiquidityProvisionPositions](#slipstreamliquidityprovisionpositions) - List LP positions
+* [slipstreamPoolPrice](#slipstreampoolprice) - Pool price
+* [slipstreamSwapSellExactly](#slipstreamswapsellexactly) - Swap - from specified amount
+* [slipstreamSwapBuyExactly](#slipstreamswapbuyexactly) - Swap - into specified amount
+* [slipstreamLiquidityProvisionMint](#slipstreamliquidityprovisionmint) - Open a new LP position
+* [slipstreamLiquidityProvisionIncrease](#slipstreamliquidityprovisionincrease) - Increase an LP position
+* [slipstreamLiquidityProvisionWithdraw](#slipstreamliquidityprovisionwithdraw) - Withdraw an LP position
+
+## slipstreamLiquidityProvisionPositions
+
+Retrieve the total number of Liquidity Provider (LP) positions associated with a
+specific sender.
+
+This endpoint allows users to query and obtain detailed information about their LP
+positions, including the number of active positions they hold. The response model,
+AerodromeLPPositionsInfo, provides a structured representation of the LP positions
+data, ensuring clarity and ease of use. This functionality is essential for users
+managing their liquidity provision activities, enabling them to make informed
+decisions based on their current positions.
+
+### 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.aerodromeSlipstream.slipstreamLiquidityProvisionPositions({});
+
+  // 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 { aerodromeSlipstreamSlipstreamLiquidityProvisionPositions } from "@compass-labs/api-sdk/funcs/aerodromeSlipstreamSlipstreamLiquidityProvisionPositions.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 aerodromeSlipstreamSlipstreamLiquidityProvisionPositions(compassApiSDK, {});
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.AerodromeSlipstreamLiquidityProvisionPositionsRequest](../../models/operations/aerodromeslipstreamliquidityprovisionpositionsrequest.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.AerodromeLPPositionsResponse](../../models/components/aerodromelppositionsresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## slipstreamPoolPrice
+
+This endpoint retrieves the current price of a pool, indicating how many token0
+you can purchase for 1 token1.
+
+Note that this is an instantaneous price and may change during any trade. For a more
+accurate representation of the trade ratios between the two assets, consider using
+the quote endpoint.
+
+### 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.aerodromeSlipstream.slipstreamPoolPrice({});
+
+  // 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 { aerodromeSlipstreamSlipstreamPoolPrice } from "@compass-labs/api-sdk/funcs/aerodromeSlipstreamSlipstreamPoolPrice.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 aerodromeSlipstreamSlipstreamPoolPrice(compassApiSDK, {});
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.AerodromeSlipstreamPoolPriceRequest](../../models/operations/aerodromeslipstreampoolpricerequest.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.AerodromeSlipstreamPoolPriceResponse](../../models/components/aerodromeslipstreampoolpriceresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## slipstreamSwapSellExactly
+
+This endpoint allows users to trade a specific amount of one token into another
+token using the Aerodrome Slipstream protocol.
+
+The transaction is executed by specifying the exact amount of the input token to be
+sold, and the system calculates the amount of the output token that will be
+received. The operation ensures that the trade is conducted within the constraints
+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.
+
+### 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.aerodromeSlipstream.slipstreamSwapSellExactly({
+    tokenIn: "FRAX",
+    tokenOut: "cbETH",
+    tickSpacing: 500,
+    amountIn: 1.5,
+    amountOutMinimum: 1.4,
+    chain: "base:mainnet",
+    sender: "<value>",
+  });
+
+  // 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 { aerodromeSlipstreamSlipstreamSwapSellExactly } from "@compass-labs/api-sdk/funcs/aerodromeSlipstreamSlipstreamSwapSellExactly.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 aerodromeSlipstreamSlipstreamSwapSellExactly(compassApiSDK, {
+    tokenIn: "FRAX",
+    tokenOut: "cbETH",
+    tickSpacing: 500,
+    amountIn: 1.5,
+    amountOutMinimum: 1.4,
+    chain: "base:mainnet",
+    sender: "<value>",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.AerodromeSlipstreamSellExactlyRequest](../../models/components/aerodromeslipstreamsellexactlyrequest.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.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## slipstreamSwapBuyExactly
+
+This endpoint facilitates the trading of tokens by allowing users to specify the
+exact amount of the output token they wish to receive.
+
+Utilizing the Aerodrome Slipstream protocol, the system calculates the necessary
+amount of the input token required to achieve the desired output. This operation is
+particularly useful for users who have a specific target amount of the output token
+in mind and are willing to provide the corresponding input token amount. The
+transaction is executed with consideration of current market conditions, including
+liquidity and price impact, ensuring that the trade is completed efficiently and
+effectively.
+
+### 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.aerodromeSlipstream.slipstreamSwapBuyExactly({
+    tokenIn: "UNI",
+    tokenOut: "cbETH",
+    tickSpacing: 6000,
+    amountOut: 1.5,
+    amountInMaximum: 1.6,
+    chain: "ethereum:mainnet",
+    sender: "<value>",
+  });
+
+  // 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 { aerodromeSlipstreamSlipstreamSwapBuyExactly } from "@compass-labs/api-sdk/funcs/aerodromeSlipstreamSlipstreamSwapBuyExactly.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 aerodromeSlipstreamSlipstreamSwapBuyExactly(compassApiSDK, {
+    tokenIn: "UNI",
+    tokenOut: "cbETH",
+    tickSpacing: 6000,
+    amountOut: 1.5,
+    amountInMaximum: 1.6,
+    chain: "ethereum:mainnet",
+    sender: "<value>",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.AerodromeSlipstreamBuyExactlyRequest](../../models/components/aerodromeslipstreambuyexactlyrequest.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.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## slipstreamLiquidityProvisionMint
+
+Initiate a new Liquidity Provider (LP) position by minting tokens.
+
+This endpoint allows users to open a new LP position, enabling them to participate
+in liquidity provision. The minting process involves creating a new position with
+specified parameters, such as token amounts and pool details. The response will
+confirm the successful creation of the LP position, providing users with the
+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.
+
+### 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.aerodromeSlipstream.slipstreamLiquidityProvisionMint({
+    token0: "STG",
+    token1: "GHO",
+    tickSpacing: 5000,
+    tickLower: -1000,
+    tickUpper: 1000,
+    amount0Desired: "1.5",
+    amount1Desired: "1.7",
+    amount0Min: "1.4",
+    amount1Min: "1.6",
+    recipient: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+    chain: "base:mainnet",
+    sender: "<value>",
+  });
+
+  // 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 { aerodromeSlipstreamSlipstreamLiquidityProvisionMint } from "@compass-labs/api-sdk/funcs/aerodromeSlipstreamSlipstreamLiquidityProvisionMint.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 aerodromeSlipstreamSlipstreamLiquidityProvisionMint(compassApiSDK, {
+    token0: "STG",
+    token1: "GHO",
+    tickSpacing: 5000,
+    tickLower: -1000,
+    tickUpper: 1000,
+    amount0Desired: "1.5",
+    amount1Desired: "1.7",
+    amount0Min: "1.4",
+    amount1Min: "1.6",
+    recipient: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+    chain: "base:mainnet",
+    sender: "<value>",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.AerodromeSlipstreamMintLiquidityProvisionRequest](../../models/components/aerodromeslipstreammintliquidityprovisionrequest.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.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## slipstreamLiquidityProvisionIncrease
+
+Increase the liquidity of an existing Liquidity Provider (LP) position.
+
+This endpoint allows users to add more tokens to their current LP position,
+enhancing their participation in liquidity provision. By increasing liquidity, users
+can potentially earn more rewards and improve their position in the pool. The
+process involves specifying additional token amounts and updating the pool details.
+The response will confirm the successful increase of the LP position, providing
+users with updated information about their enhanced position. This functionality is
+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.
+
+### 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.aerodromeSlipstream.slipstreamLiquidityProvisionIncrease({
+    tokenId: 88456,
+    amount0Desired: "1.5",
+    amount1Desired: "1.7",
+    amount0Min: "1.4",
+    amount1Min: "1.6",
+    chain: "base:mainnet",
+    sender: "<value>",
+  });
+
+  // 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 { aerodromeSlipstreamSlipstreamLiquidityProvisionIncrease } from "@compass-labs/api-sdk/funcs/aerodromeSlipstreamSlipstreamLiquidityProvisionIncrease.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 aerodromeSlipstreamSlipstreamLiquidityProvisionIncrease(compassApiSDK, {
+    tokenId: 88456,
+    amount0Desired: "1.5",
+    amount1Desired: "1.7",
+    amount0Min: "1.4",
+    amount1Min: "1.6",
+    chain: "base:mainnet",
+    sender: "<value>",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.AerodromeSlipstreamIncreaseLiquidityProvisionRequest](../../models/components/aerodromeslipstreamincreaseliquidityprovisionrequest.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.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## slipstreamLiquidityProvisionWithdraw
+
+Withdraw an existing Liquidity Provider (LP) position.
+
+This endpoint allows users to remove their tokens from an LP position, effectively
+closing their participation in the liquidity pool. The withdrawal process involves
+specifying the LP position to be closed, and the response will confirm the
+successful removal of liquidity, providing users with details about the withdrawn
+tokens and any remaining balances. This functionality is essential for users who
+wish to exit their liquidity provision activities, enabling them to reclaim their
+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.
+
+### 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.aerodromeSlipstream.slipstreamLiquidityProvisionWithdraw({
+    tokenId: 512590,
+    percentageForWithdrawal: "50",
+    chain: "base:mainnet",
+    sender: "<value>",
+  });
+
+  // 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 { aerodromeSlipstreamSlipstreamLiquidityProvisionWithdraw } from "@compass-labs/api-sdk/funcs/aerodromeSlipstreamSlipstreamLiquidityProvisionWithdraw.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 aerodromeSlipstreamSlipstreamLiquidityProvisionWithdraw(compassApiSDK, {
+    tokenId: 512590,
+    percentageForWithdrawal: "50",
+    chain: "base:mainnet",
+    sender: "<value>",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.AerodromeSlipstreamWithdrawLiquidityProvisionRequest](../../models/components/aerodromeslipstreamwithdrawliquidityprovisionrequest.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.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |