@compass-labs/api-sdk 2.1.11-rc.0 → 2.1.12-rc.0

package/docs/models/components/aavesupportedtokensresponse.md

@@ -0,0 +1,24 @@
+# AaveSupportedTokensResponse
+
+## Example Usage
+
+```typescript
+import { AaveSupportedTokensResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: AaveSupportedTokensResponse = {
+  tokens: [
+    {
+      symbol: "<value>",
+      address: "96133 Milton Road",
+      supplyingEnabled: false,
+      borrowingEnabled: false,
+    },
+  ],
+};
+```
+
+## Fields
+
+| Field                                                                                            | Type                                                                                             | Required                                                                                         | Description                                                                                      |
+| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
+| `tokens`                                                                                         | [components.AaveSupportedTokenMetadata](../../models/components/aavesupportedtokenmetadata.md)[] | :heavy_check_mark:                                                                               | List of supported tokens with configuration metadata for a given chain.                          |

package/docs/models/components/aavetokenpriceresponse.md

@@ -0,0 +1,17 @@
+# AaveTokenPriceResponse
+
+## Example Usage
+
+```typescript
+import { AaveTokenPriceResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: AaveTokenPriceResponse = {
+  price: "198.09",
+};
+```
+
+## Fields
+
+| Field                          | Type                           | Required                       | Description                    |
+| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
+| `price`                        | *string*                       | :heavy_check_mark:             | The price of the asset in USD. |

package/docs/models/components/aaveusdcratesresponse.md

@@ -0,0 +1,40 @@
+# AaveUsdcRatesResponse
+
+Response containing token rates on Aave for Ethereum, Base, and Arbitrum.
+
+## Example Usage
+
+```typescript
+import { AaveUsdcRatesResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: AaveUsdcRatesResponse = {
+  ethereum: {
+    supplyApyVariableRate: "<value>",
+    borrowApyVariableRate: "<value>",
+  },
+  base: {
+    supplyApyVariableRate: "<value>",
+    borrowApyVariableRate: "<value>",
+  },
+  arbitrum: {
+    supplyApyVariableRate: "<value>",
+    borrowApyVariableRate: "<value>",
+  },
+  supplyApyMax: {
+    chain: "<value>",
+    rates: {
+      supplyApyVariableRate: "<value>",
+      borrowApyVariableRate: "<value>",
+    },
+  },
+};
+```
+
+## Fields
+
+| Field                                                                      | Type                                                                       | Required                                                                   | Description                                                                |
+| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
+| `ethereum`                                                                 | [components.ChainRateData](../../models/components/chainratedata.md)       | :heavy_check_mark:                                                         | Rate data for a specific chain.                                            |
+| `base`                                                                     | [components.ChainRateData](../../models/components/chainratedata.md)       | :heavy_check_mark:                                                         | Rate data for a specific chain.                                            |
+| `arbitrum`                                                                 | [components.ChainRateData](../../models/components/chainratedata.md)       | :heavy_check_mark:                                                         | Rate data for a specific chain.                                            |
+| `supplyApyMax`                                                             | [components.MaxSupplyApyData](../../models/components/maxsupplyapydata.md) | :heavy_check_mark:                                                         | Data for the chain with the highest supply APY.                            |

package/docs/models/components/aaveuserpositionpertokenresponse.md

@@ -0,0 +1,33 @@
+# AaveUserPositionPerTokenResponse
+
+## Example Usage
+
+```typescript
+import { AaveUserPositionPerTokenResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: AaveUserPositionPerTokenResponse = {
+  tokenBalance: "<value>",
+  stableDebt: "<value>",
+  variableDebt: "<value>",
+  principalStableDebt: "<value>",
+  principalVariableDebt: "<value>",
+  stableBorrowRate: "<value>",
+  stableBorrowRateForNewLoans: "<value>",
+  variableBorrowRate: "<value>",
+  liquidityRate: "<value>",
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                                                                                                    | Type                                                                                                                                                                                                                                                     | Required                                                                                                                                                                                                                                                 | Description                                                                                                                                                                                                                                              |
+| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `tokenBalance`                                                                                                                                                                                                                                           | *string*                                                                                                                                                                                                                                                 | :heavy_check_mark:                                                                                                                                                                                                                                       | The balance of AAVE aTokens (interest-bearing representations of your deposits).                                                                                                                                                                         |
+| `stableDebt`                                                                                                                                                                                                                                             | *string*                                                                                                                                                                                                                                                 | :heavy_check_mark:                                                                                                                                                                                                                                       | The amount of the user's debt with a fixed interest rate.                                                                                                                                                                                                |
+| `variableDebt`                                                                                                                                                                                                                                           | *string*                                                                                                                                                                                                                                                 | :heavy_check_mark:                                                                                                                                                                                                                                       | The amount of the user's debt with a variable interest rate.                                                                                                                                                                                             |
+| `principalStableDebt`                                                                                                                                                                                                                                    | *string*                                                                                                                                                                                                                                                 | :heavy_check_mark:                                                                                                                                                                                                                                       | The amount of the user's debt that was part of the initial principal of all<br/>        loans with a stable interest rate.                                                                                                                               |
+| `principalVariableDebt`                                                                                                                                                                                                                                  | *string*                                                                                                                                                                                                                                                 | :heavy_check_mark:                                                                                                                                                                                                                                       | The amount of the user's debt that was part of the initial principal of all<br/>        loans with a variable interest rate. This is the value stored by AAVE, which may be slightly<br/>        inaccurate, but reflects what AAVE believes you initially paid. |
+| `stableBorrowRate`                                                                                                                                                                                                                                       | *string*                                                                                                                                                                                                                                                 | :heavy_check_mark:                                                                                                                                                                                                                                       | The current average annualised interest rate for all your stable loans in<br/>        this pool.                                                                                                                                                         |
+| `stableBorrowRateForNewLoans`                                                                                                                                                                                                                            | *string*                                                                                                                                                                                                                                                 | :heavy_check_mark:                                                                                                                                                                                                                                       | The annualised interest rate you would pay on a new stable loan.                                                                                                                                                                                         |
+| `variableBorrowRate`                                                                                                                                                                                                                                     | *string*                                                                                                                                                                                                                                                 | :heavy_check_mark:                                                                                                                                                                                                                                       | The current annualised interest rate for variable rate loans in this pool.<br/>        (This applies to both current and new loans.)                                                                                                                     |
+| `liquidityRate`                                                                                                                                                                                                                                          | *string*                                                                                                                                                                                                                                                 | :heavy_check_mark:                                                                                                                                                                                                                                       | The annualised interest rate for deposited supplies.                                                                                                                                                                                                     |

package/docs/models/components/aaveuserpositionsummaryresponse.md

@@ -0,0 +1,27 @@
+# AaveUserPositionSummaryResponse
+
+## Example Usage
+
+```typescript
+import { AaveUserPositionSummaryResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: AaveUserPositionSummaryResponse = {
+  maximumLoanToValueRatio: "<value>",
+  healthFactor: "<value>",
+  totalCollateral: "<value>",
+  totalDebt: "<value>",
+  availableBorrows: "<value>",
+  liquidationThreshold: "<value>",
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                                           | Type                                                                                                                                                                                            | Required                                                                                                                                                                                        | Description                                                                                                                                                                                     |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `maximumLoanToValueRatio`                                                                                                                                                                       | *string*                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                              | The loan to value ratio of a user.                                                                                                                                                              |
+| `healthFactor`                                                                                                                                                                                  | *string*                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                              | The health factor of a user. If this is above 1 it is safe; below 1 and the<br/>        user is in risk of liquidation. This number might be very high (which would mean the user is<br/>        safe!) |
+| `totalCollateral`                                                                                                                                                                               | *string*                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                              | The total collateral (in USD) of a user.                                                                                                                                                        |
+| `totalDebt`                                                                                                                                                                                     | *string*                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                              | The total debt (in USD) of a user.                                                                                                                                                              |
+| `availableBorrows`                                                                                                                                                                              | *string*                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                              | The available borrows (in USD) of a user.                                                                                                                                                       |
+| `liquidationThreshold`                                                                                                                                                                          | *string*                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                              | The liquidation threshold of a user. A user might exceed this due to changing<br/>        asset values.                                                                                         |

package/docs/models/components/aavevenue.md

@@ -0,0 +1,19 @@
+# AaveVenue
+
+## Example Usage
+
+```typescript
+import { AaveVenue } from "@compass-labs/api-sdk/models/components";
+
+let value: AaveVenue = {
+  type: "AAVE",
+  token: "<value>",
+};
+```
+
+## Fields
+
+| Field                                                         | Type                                                          | Required                                                      | Description                                                   |
+| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
+| `type`                                                        | *"AAVE"*                                                      | :heavy_check_mark:                                            | The venue type discriminator.                                 |
+| `token`                                                       | *string*                                                      | :heavy_check_mark:                                            | The reserve token for the Aave pool you are interacting with. |

package/docs/models/components/aavewithdrawparams.md

@@ -0,0 +1,23 @@
+# AaveWithdrawParams
+
+## Example Usage
+
+```typescript
+import { AaveWithdrawParams } from "@compass-labs/api-sdk/models/components";
+
+let value: AaveWithdrawParams = {
+  actionType: "AAVE_WITHDRAW",
+  token: "<value>",
+  amount: 9580.15,
+  recipient: "<value>",
+};
+```
+
+## Fields
+
+| Field                                                | Type                                                 | Required                                             | Description                                          | Example                                              |
+| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
+| `actionType`                                         | *"AAVE_WITHDRAW"*                                    | :heavy_check_mark:                                   | N/A                                                  | AAVE_WITHDRAW                                        |
+| `token`                                              | *string*                                             | :heavy_check_mark:                                   | The symbol of the underlying asset to withdraw..     |                                                      |
+| `amount`                                             | *components.AaveWithdrawParamsAmount*                | :heavy_check_mark:                                   | The amount of the asset to withdraw                  |                                                      |
+| `recipient`                                          | *string*                                             | :heavy_check_mark:                                   | The address of the recipient of the withdrawn funds. |                                                      |

package/docs/models/components/aavewithdrawparamsamount.md

@@ -0,0 +1,19 @@
+# AaveWithdrawParamsAmount
+
+The amount of the asset to withdraw
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/components/aavewithdrawrequest.md

@@ -0,0 +1,27 @@
+# AaveWithdrawRequest
+
+## Example Usage
+
+```typescript
+import { AaveWithdrawRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: AaveWithdrawRequest = {
+  token: "USDC",
+  amount: "0.5",
+  recipient: "0x388f03DABdc414E11da8Da63198D183C82836866",
+  chain: "base",
+  sender: "0x388f03DABdc414E11da8Da63198D183C82836866",
+};
+```
+
+## Fields
+
+| Field                                                                                                                        | Type                                                                                                                         | Required                                                                                                                     | Description                                                                                                                  | Example                                                                                                                      |
+| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
+| `actionType`                                                                                                                 | *"AAVE_WITHDRAW"*                                                                                                            | :heavy_minus_sign:                                                                                                           | N/A                                                                                                                          | AAVE_WITHDRAW                                                                                                                |
+| `token`                                                                                                                      | *string*                                                                                                                     | :heavy_check_mark:                                                                                                           | The symbol of the underlying asset to withdraw..                                                                             |                                                                                                                              |
+| `amount`                                                                                                                     | *components.AaveWithdrawRequestAmount*                                                                                       | :heavy_check_mark:                                                                                                           | The amount of the asset to withdraw                                                                                          |                                                                                                                              |
+| `recipient`                                                                                                                  | *string*                                                                                                                     | :heavy_check_mark:                                                                                                           | The address of the recipient of the withdrawn funds.                                                                         |                                                                                                                              |
+| `chain`                                                                                                                      | [components.AaveWithdrawRequestChain](../../models/components/aavewithdrawrequestchain.md)                                   | :heavy_check_mark:                                                                                                           | N/A                                                                                                                          |                                                                                                                              |
+| `sender`                                                                                                                     | *string*                                                                                                                     | :heavy_check_mark:                                                                                                           | The address of the transaction sender.                                                                                       |                                                                                                                              |
+| `estimateGas`                                                                                                                | *boolean*                                                                                                                    | :heavy_minus_sign:                                                                                                           | Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed. | true                                                                                                                         |

package/docs/models/components/aavewithdrawrequestamount.md

@@ -0,0 +1,19 @@
+# AaveWithdrawRequestAmount
+
+The amount of the asset to withdraw
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/components/aavewithdrawrequestchain.md

@@ -0,0 +1,15 @@
+# AaveWithdrawRequestChain
+
+## Example Usage
+
+```typescript
+import { AaveWithdrawRequestChain } from "@compass-labs/api-sdk/models/components";
+
+let value: AaveWithdrawRequestChain = "arbitrum";
+```
+
+## Values
+
+```typescript
+"arbitrum" | "base" | "ethereum"
+```

package/docs/models/components/aerodromelppositionsresponse.md

@@ -0,0 +1,17 @@
+# AerodromeLPPositionsResponse
+
+## Example Usage
+
+```typescript
+import { AerodromeLPPositionsResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: AerodromeLPPositionsResponse = {
+  positions: {},
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                             | Type                                                                                                                                                              | Required                                                                                                                                                          | Description                                                                                                                                                       |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `positions`                                                                                                                                                       | Record<string, [components.AerodromePosition](../../models/components/aerodromeposition.md)>                                                                      | :heavy_check_mark:                                                                                                                                                | Liquidity provision positions belonging to a particular user. The key is a<br/>tuple of the token0, token1, tick_spacing, tick_lower, and tick_upper of the position. |

package/docs/models/components/aerodromeposition.md

@@ -0,0 +1,41 @@
+# AerodromePosition
+
+## Example Usage
+
+```typescript
+import { AerodromePosition } from "@compass-labs/api-sdk/models/components";
+
+let value: AerodromePosition = {
+  nonce: 163052,
+  operator: "<value>",
+  token0: "<value>",
+  token1: "<value>",
+  tickSpacing: 854662,
+  tickLower: 295077,
+  tickUpper: 882860,
+  liquidity: 260352,
+  feeGrowthInside0LastX128: 925124,
+  feeGrowthInside1LastX128: 102519,
+  tokensOwed0: 782285,
+  tokensOwed1: 337283,
+  tokenId: 919974,
+};
+```
+
+## Fields
+
+| Field                      | Type                       | Required                   | Description                |
+| -------------------------- | -------------------------- | -------------------------- | -------------------------- |
+| `nonce`                    | *number*                   | :heavy_check_mark:         | N/A                        |
+| `operator`                 | *string*                   | :heavy_check_mark:         | N/A                        |
+| `token0`                   | *string*                   | :heavy_check_mark:         | N/A                        |
+| `token1`                   | *string*                   | :heavy_check_mark:         | N/A                        |
+| `tickSpacing`              | *number*                   | :heavy_check_mark:         | N/A                        |
+| `tickLower`                | *number*                   | :heavy_check_mark:         | N/A                        |
+| `tickUpper`                | *number*                   | :heavy_check_mark:         | N/A                        |
+| `liquidity`                | *number*                   | :heavy_check_mark:         | N/A                        |
+| `feeGrowthInside0LastX128` | *number*                   | :heavy_check_mark:         | N/A                        |
+| `feeGrowthInside1LastX128` | *number*                   | :heavy_check_mark:         | N/A                        |
+| `tokensOwed0`              | *number*                   | :heavy_check_mark:         | N/A                        |
+| `tokensOwed1`              | *number*                   | :heavy_check_mark:         | N/A                        |
+| `tokenId`                  | *number*                   | :heavy_check_mark:         | N/A                        |

package/docs/models/components/aerodromeslipstreambuyexactlyparams.md

@@ -0,0 +1,29 @@
+# AerodromeSlipstreamBuyExactlyParams
+
+Parameters model for buying exactly an amount of tokens.
+
+## Example Usage
+
+```typescript
+import { AerodromeSlipstreamBuyExactlyParams } from "@compass-labs/api-sdk/models/components";
+
+let value: AerodromeSlipstreamBuyExactlyParams = {
+  actionType: "AERODROME_SLIPSTREAM_BUY_EXACTLY",
+  tokenIn: "<value>",
+  tokenOut: "<value>",
+  tickSpacing: 121289,
+  amountOut: "<value>",
+  amountInMaximum: "<value>",
+};
+```
+
+## Fields
+
+| Field                                                           | Type                                                            | Required                                                        | Description                                                     | Example                                                         |
+| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
+| `actionType`                                                    | *"AERODROME_SLIPSTREAM_BUY_EXACTLY"*                            | :heavy_check_mark:                                              | N/A                                                             | AERODROME_SLIPSTREAM_BUY_EXACTLY                                |
+| `tokenIn`                                                       | *string*                                                        | :heavy_check_mark:                                              | The symbol of the token to swap from.                           |                                                                 |
+| `tokenOut`                                                      | *string*                                                        | :heavy_check_mark:                                              | The symbol of the token to swap to.                             |                                                                 |
+| `tickSpacing`                                                   | *number*                                                        | :heavy_check_mark:                                              | The tick spacing of the pool                                    |                                                                 |
+| `amountOut`                                                     | *components.AerodromeSlipstreamBuyExactlyParamsAmountOut*       | :heavy_check_mark:                                              | The amount of the token to swap to                              |                                                                 |
+| `amountInMaximum`                                               | *components.AerodromeSlipstreamBuyExactlyParamsAmountInMaximum* | :heavy_check_mark:                                              | The maximum amount of the token to swap from                    |                                                                 |

package/docs/models/components/aerodromeslipstreambuyexactlyparamsamountinmaximum.md

@@ -0,0 +1,19 @@
+# AerodromeSlipstreamBuyExactlyParamsAmountInMaximum
+
+The maximum amount of the token to swap from
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/components/aerodromeslipstreambuyexactlyparamsamountout.md

@@ -0,0 +1,19 @@
+# AerodromeSlipstreamBuyExactlyParamsAmountOut
+
+The amount of the token to swap to
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/components/aerodromeslipstreambuyexactlyrequest.md

@@ -0,0 +1,33 @@
+# AerodromeSlipstreamBuyExactlyRequest
+
+Request model for buying exactly an amount of tokens.
+
+## Example Usage
+
+```typescript
+import { AerodromeSlipstreamBuyExactlyRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: AerodromeSlipstreamBuyExactlyRequest = {
+  tokenIn: "USDC",
+  tokenOut: "WETH",
+  tickSpacing: 100,
+  amountOut: 0.00001,
+  amountInMaximum: 0.1,
+  chain: "base",
+  sender: "0xA4C4fB06093C91E70528d4029050f358c4B065EE",
+};
+```
+
+## Fields
+
+| Field                                                                                                                        | Type                                                                                                                         | Required                                                                                                                     | Description                                                                                                                  | Example                                                                                                                      |
+| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
+| `actionType`                                                                                                                 | *"AERODROME_SLIPSTREAM_BUY_EXACTLY"*                                                                                         | :heavy_minus_sign:                                                                                                           | N/A                                                                                                                          | AERODROME_SLIPSTREAM_BUY_EXACTLY                                                                                             |
+| `tokenIn`                                                                                                                    | *string*                                                                                                                     | :heavy_check_mark:                                                                                                           | The symbol of the token to swap from.                                                                                        |                                                                                                                              |
+| `tokenOut`                                                                                                                   | *string*                                                                                                                     | :heavy_check_mark:                                                                                                           | The symbol of the token to swap to.                                                                                          |                                                                                                                              |
+| `tickSpacing`                                                                                                                | *number*                                                                                                                     | :heavy_check_mark:                                                                                                           | The tick spacing of the pool                                                                                                 |                                                                                                                              |
+| `amountOut`                                                                                                                  | *components.AerodromeSlipstreamBuyExactlyRequestAmountOut*                                                                   | :heavy_check_mark:                                                                                                           | The amount of the token to swap to                                                                                           |                                                                                                                              |
+| `amountInMaximum`                                                                                                            | *components.AerodromeSlipstreamBuyExactlyRequestAmountInMaximum*                                                             | :heavy_check_mark:                                                                                                           | The maximum amount of the token to swap from                                                                                 |                                                                                                                              |
+| `chain`                                                                                                                      | [components.AerodromeSlipstreamBuyExactlyRequestChain](../../models/components/aerodromeslipstreambuyexactlyrequestchain.md) | :heavy_check_mark:                                                                                                           | N/A                                                                                                                          |                                                                                                                              |
+| `sender`                                                                                                                     | *string*                                                                                                                     | :heavy_check_mark:                                                                                                           | The address of the transaction sender.                                                                                       |                                                                                                                              |
+| `estimateGas`                                                                                                                | *boolean*                                                                                                                    | :heavy_minus_sign:                                                                                                           | Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed. | true                                                                                                                         |

package/docs/models/components/aerodromeslipstreambuyexactlyrequestamountinmaximum.md

@@ -0,0 +1,19 @@
+# AerodromeSlipstreamBuyExactlyRequestAmountInMaximum
+
+The maximum amount of the token to swap from
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/components/aerodromeslipstreambuyexactlyrequestamountout.md

@@ -0,0 +1,19 @@
+# AerodromeSlipstreamBuyExactlyRequestAmountOut
+
+The amount of the token to swap to
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/components/aerodromeslipstreambuyexactlyrequestchain.md

@@ -0,0 +1,15 @@
+# AerodromeSlipstreamBuyExactlyRequestChain
+
+## Example Usage
+
+```typescript
+import { AerodromeSlipstreamBuyExactlyRequestChain } from "@compass-labs/api-sdk/models/components";
+
+let value: AerodromeSlipstreamBuyExactlyRequestChain = "base";
+```
+
+## Values
+
+```typescript
+"base"
+```

package/docs/models/components/aerodromeslipstreamincreaseliquidityprovisionparams.md

@@ -0,0 +1,32 @@
+# AerodromeSlipstreamIncreaseLiquidityProvisionParams
+
+Endpoint parameters for increasing liquidity provision on aerodrome slipstream.
+
+This action is performed on the NonfungiblePosition Manager to increase the
+liquidity of an existing position.
+
+## Example Usage
+
+```typescript
+import { AerodromeSlipstreamIncreaseLiquidityProvisionParams } from "@compass-labs/api-sdk/models/components";
+
+let value: AerodromeSlipstreamIncreaseLiquidityProvisionParams = {
+  actionType: "AERODROME_SLIPSTREAM_INCREASE_LIQUIDITY_PROVISION",
+  tokenId: 800217,
+  amount0Desired: 7257.53,
+  amount1Desired: "<value>",
+  amount0Min: 5828.13,
+  amount1Min: 7309.97,
+};
+```
+
+## Fields
+
+| Field                                                                          | Type                                                                           | Required                                                                       | Description                                                                    | Example                                                                        |
+| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
+| `actionType`                                                                   | *"AERODROME_SLIPSTREAM_INCREASE_LIQUIDITY_PROVISION"*                          | :heavy_check_mark:                                                             | N/A                                                                            | AERODROME_SLIPSTREAM_INCREASE_LIQUIDITY_PROVISION                              |
+| `tokenId`                                                                      | *number*                                                                       | :heavy_check_mark:                                                             | Token ID of the NFT representing the liquidity provisioned position.           |                                                                                |
+| `amount0Desired`                                                               | *components.AerodromeSlipstreamIncreaseLiquidityProvisionParamsAmount0Desired* | :heavy_check_mark:                                                             | The desired amount of the first token to deposit                               |                                                                                |
+| `amount1Desired`                                                               | *components.AerodromeSlipstreamIncreaseLiquidityProvisionParamsAmount1Desired* | :heavy_check_mark:                                                             | The desired amount of the second token to deposit                              |                                                                                |
+| `amount0Min`                                                                   | *components.AerodromeSlipstreamIncreaseLiquidityProvisionParamsAmount0Min*     | :heavy_check_mark:                                                             | The minimum amount of the first token to deposit                               |                                                                                |
+| `amount1Min`                                                                   | *components.AerodromeSlipstreamIncreaseLiquidityProvisionParamsAmount1Min*     | :heavy_check_mark:                                                             | The minimum amount of the second token to deposit                              |                                                                                |

package/docs/models/components/aerodromeslipstreamincreaseliquidityprovisionparamsamount0desired.md

@@ -0,0 +1,19 @@
+# AerodromeSlipstreamIncreaseLiquidityProvisionParamsAmount0Desired
+
+The desired amount of the first token to deposit
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/components/aerodromeslipstreamincreaseliquidityprovisionparamsamount0min.md

@@ -0,0 +1,19 @@
+# AerodromeSlipstreamIncreaseLiquidityProvisionParamsAmount0Min
+
+The minimum amount of the first token to deposit
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+