@compass-labs/api-sdk 2.2.105-rc.0 → 2.2.106

package/docs/models/components/dextokensresponse.md

@@ -0,0 +1,24 @@
+# DexTokensResponse
+
+## Example Usage
+
+```typescript
+import { DexTokensResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: DexTokensResponse = {
+  total: 8197,
+  offset: 661751,
+  limit: 618288,
+  tokens: [],
+};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `total`                                                                                       | *number*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `offset`                                                                                      | *number*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `limit`                                                                                       | *number*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `tokens`                                                                                      | [components.DexTokenInfo](../../models/components/dextokeninfo.md)[]                          | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `statsUpdatedAt`                                                                              | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | When the indexer last restated these numbers.                                                 |

package/docs/models/components/dexversion.md

@@ -0,0 +1,21 @@
+# DexVersion
+
+Which Uniswap deployment a pool belongs to.
+
+v3 pools hold their own tokens and pay LPs the fee tier. v4 pools live in a
+shared PoolManager and may route the fee through a hook, which is where the
+launchpad pools' zero LP yield comes from.
+
+## Example Usage
+
+```typescript
+import { DexVersion } from "@compass-labs/api-sdk/models/components";
+
+let value: DexVersion = "V3";
+```
+
+## Values
+
+```typescript
+"V3" | "V4"
+```

package/docs/models/components/eulermarket.md

@@ -23,21 +23,24 @@ let value: EulerMarket = {
 
 ## Fields
 
-| Field                                                                                                                                               | Type                                                                                                                                                | Required                                                                                                                                            | Description                                                                                                                                         | Example                                                                                                                                             |
-| --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `vault`                                                                                                                                             | *string*                                                                                                                                            | :heavy_check_mark:                                                                                                                                  | EVK vault to borrow from (pass as borrow_vault when borrowing).                                                                                     |                                                                                                                                                     |
-| `vaultSymbol`                                                                                                                                       | *string*                                                                                                                                            | :heavy_check_mark:                                                                                                                                  | Symbol of the EVK vault (e.g. eUSDT-2).                                                                                                             |                                                                                                                                                     |
-| `asset`                                                                                                                                             | *string*                                                                                                                                            | :heavy_check_mark:                                                                                                                                  | Underlying asset this market lends and borrows.                                                                                                     |                                                                                                                                                     |
-| `assetSymbol`                                                                                                                                       | *string*                                                                                                                                            | :heavy_check_mark:                                                                                                                                  | Symbol of the borrowable asset (e.g. USDT).                                                                                                         |                                                                                                                                                     |
-| `assetDecimals`                                                                                                                                     | *number*                                                                                                                                            | :heavy_check_mark:                                                                                                                                  | Decimals of the borrowable asset.                                                                                                                   |                                                                                                                                                     |
-| `assetPriceUsd`                                                                                                                                     | *string*                                                                                                                                            | :heavy_minus_sign:                                                                                                                                  | USD price of one whole unit of the borrowable asset. Use it to convert USD borrow capacity into token units. Null if the price feed can't quote it. |                                                                                                                                                     |
-| `unitOfAccountSymbol`                                                                                                                               | *string*                                                                                                                                            | :heavy_minus_sign:                                                                                                                                  | Symbol of the market's native unit of account (usually USD). The market's own risk engine denominates collateral and debt in this unit.             |                                                                                                                                                     |
-| `borrowApy`                                                                                                                                         | *string*                                                                                                                                            | :heavy_minus_sign:                                                                                                                                  | Current borrow APY for this market (cost to borrow the asset), in percentage (e.g. 5.25 means 5.25%). Null if the rate is unavailable.              |                                                                                                                                                     |
-| `supplyApy`                                                                                                                                         | *string*                                                                                                                                            | :heavy_minus_sign:                                                                                                                                  | Current supply APY for this market (yield for supplying the asset), in percentage (e.g. 3.45 means 3.45%). Null if the rate is unavailable.         |                                                                                                                                                     |
-| `availableLiquidity`                                                                                                                                | *string*                                                                                                                                            | :heavy_check_mark:                                                                                                                                  | Asset available to borrow right now (vault cash), in token units. A borrow larger than this reverts even if the account is healthy.                 |                                                                                                                                                     |
-| `totalSupplyAssets`                                                                                                                                 | *string*                                                                                                                                            | :heavy_check_mark:                                                                                                                                  | Total asset supplied to this market, in token units.                                                                                                |                                                                                                                                                     |
-| `totalBorrowAssets`                                                                                                                                 | *string*                                                                                                                                            | :heavy_check_mark:                                                                                                                                  | Total asset borrowed from this market, in token units.                                                                                              |                                                                                                                                                     |
-| `utilization`                                                                                                                                       | *string*                                                                                                                                            | :heavy_check_mark:                                                                                                                                  | Borrowed share of supplied assets, in percentage 0-100.                                                                                             |                                                                                                                                                     |
-| `supplyCap`                                                                                                                                         | *string*                                                                                                                                            | :heavy_minus_sign:                                                                                                                                  | Maximum total supply allowed, in token units. Null when the market is uncapped.                                                                     |                                                                                                                                                     |
-| `borrowCap`                                                                                                                                         | *string*                                                                                                                                            | :heavy_minus_sign:                                                                                                                                  | Maximum total borrow allowed, in token units. A borrow that would breach this reverts even when cash exists. Null when uncapped.                    |                                                                                                                                                     |
-| `collaterals`                                                                                                                                       | [components.EulerMarketCollateral](../../models/components/eulermarketcollateral.md)[]                                                              | :heavy_minus_sign:                                                                                                                                  | Collateral vaults this market accepts (those currently borrowable, LTV > 0), each with its LTVs.                                                    | []                                                                                                                                                  |
+| Field                                                                                                                                                                                                                      | Type                                                                                                                                                                                                                       | Required                                                                                                                                                                                                                   | Description                                                                                                                                                                                                                | Example                                                                                                                                                                                                                    |
+| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `vault`                                                                                                                                                                                                                    | *string*                                                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                         | EVK vault to borrow from (pass as borrow_vault when borrowing).                                                                                                                                                            |                                                                                                                                                                                                                            |
+| `vaultSymbol`                                                                                                                                                                                                              | *string*                                                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                         | Symbol of the EVK vault (e.g. eUSDT-2).                                                                                                                                                                                    |                                                                                                                                                                                                                            |
+| `asset`                                                                                                                                                                                                                    | *string*                                                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                         | Underlying asset this market lends and borrows.                                                                                                                                                                            |                                                                                                                                                                                                                            |
+| `assetSymbol`                                                                                                                                                                                                              | *string*                                                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                         | Symbol of the borrowable asset (e.g. USDT).                                                                                                                                                                                |                                                                                                                                                                                                                            |
+| `assetDecimals`                                                                                                                                                                                                            | *number*                                                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                         | Decimals of the borrowable asset.                                                                                                                                                                                          |                                                                                                                                                                                                                            |
+| `assetPriceUsd`                                                                                                                                                                                                            | *string*                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                         | USD price of one whole unit of the borrowable asset. Use it to convert USD borrow capacity into token units. Null if the price feed can't quote it.                                                                        |                                                                                                                                                                                                                            |
+| `unitOfAccountSymbol`                                                                                                                                                                                                      | *string*                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                         | Symbol of the market's native unit of account (usually USD). The market's own risk engine denominates collateral and debt in this unit.                                                                                    |                                                                                                                                                                                                                            |
+| `borrowApy`                                                                                                                                                                                                                | *string*                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                         | Current borrow APY for this market (cost to borrow the asset), in percentage (e.g. 5.25 means 5.25%). Null if the rate is unavailable.                                                                                     |                                                                                                                                                                                                                            |
+| `supplyApy`                                                                                                                                                                                                                | *string*                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                         | Current supply APY for this market (yield for supplying the asset), in percentage (e.g. 3.45 means 3.45%). Null if the rate is unavailable.                                                                                |                                                                                                                                                                                                                            |
+| `intrinsicApy`                                                                                                                                                                                                             | *string*                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                         | What the borrowable asset earns inside its own price, in percentage, trailing 7 days. Debt owed in such a token grows by this on top of borrow_apy — a borrower's true cost is their sum. Null means unmeasured, NOT zero. |                                                                                                                                                                                                                            |
+| `availableLiquidity`                                                                                                                                                                                                       | *string*                                                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                         | Asset available to borrow right now (vault cash), in token units. A borrow larger than this reverts even if the account is healthy.                                                                                        |                                                                                                                                                                                                                            |
+| `totalSupplyAssets`                                                                                                                                                                                                        | *string*                                                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                         | Total asset supplied to this market, in token units.                                                                                                                                                                       |                                                                                                                                                                                                                            |
+| `totalBorrowAssets`                                                                                                                                                                                                        | *string*                                                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                         | Total asset borrowed from this market, in token units.                                                                                                                                                                     |                                                                                                                                                                                                                            |
+| `utilization`                                                                                                                                                                                                              | *string*                                                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                         | Borrowed share of supplied assets, in percentage 0-100.                                                                                                                                                                    |                                                                                                                                                                                                                            |
+| `tvlUsd`                                                                                                                                                                                                                   | *string*                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                         | Total asset supplied to this market in USD (total_supply_assets priced by the shared request-time feed). Null when the price feed can't quote the asset — size in token units instead.                                     |                                                                                                                                                                                                                            |
+| `liquidityUsd`                                                                                                                                                                                                             | *string*                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                         | Asset available to borrow right now in USD (available_liquidity priced by the shared request-time feed; vault cash equals supplied minus borrowed). Null when the price feed can't quote the asset.                        |                                                                                                                                                                                                                            |
+| `supplyCap`                                                                                                                                                                                                                | *string*                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                         | Maximum total supply allowed, in token units. Null when the market is uncapped.                                                                                                                                            |                                                                                                                                                                                                                            |
+| `borrowCap`                                                                                                                                                                                                                | *string*                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                         | Maximum total borrow allowed, in token units. A borrow that would breach this reverts even when cash exists. Null when uncapped.                                                                                           |                                                                                                                                                                                                                            |
+| `collaterals`                                                                                                                                                                                                              | [components.EulerMarketCollateral](../../models/components/eulermarketcollateral.md)[]                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                         | Collateral vaults this market accepts (those currently borrowable, LTV > 0), each with its LTVs.                                                                                                                           | []                                                                                                                                                                                                                         |

package/docs/models/components/eulermarketcollateral.md

@@ -19,13 +19,14 @@ let value: EulerMarketCollateral = {
 
 ## Fields
 
-| Field                                                                                                                                     | Type                                                                                                                                      | Required                                                                                                                                  | Description                                                                                                                               |
-| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
-| `vault`                                                                                                                                   | *string*                                                                                                                                  | :heavy_check_mark:                                                                                                                        | EVK collateral vault to supply into (pass as collateral_vault when borrowing).                                                            |
-| `asset`                                                                                                                                   | *string*                                                                                                                                  | :heavy_check_mark:                                                                                                                        | Underlying asset of the collateral vault.                                                                                                 |
-| `assetSymbol`                                                                                                                             | *string*                                                                                                                                  | :heavy_check_mark:                                                                                                                        | Symbol of the collateral's underlying asset (e.g. USDC).                                                                                  |
-| `assetDecimals`                                                                                                                           | *number*                                                                                                                                  | :heavy_check_mark:                                                                                                                        | Decimals of the collateral's underlying asset.                                                                                            |
-| `assetPriceUsd`                                                                                                                           | *string*                                                                                                                                  | :heavy_minus_sign:                                                                                                                        | USD price of one whole unit of the collateral asset. Null if the price feed can't quote it (size the supply in token units instead).      |
-| `borrowLtv`                                                                                                                               | *string*                                                                                                                                  | :heavy_check_mark:                                                                                                                        | Maximum loan-to-value when borrowing against this collateral, in percentage (e.g. 94 means 94%).                                          |
-| `liquidationLtv`                                                                                                                          | *string*                                                                                                                                  | :heavy_check_mark:                                                                                                                        | Loan-to-value at which this collateral is liquidated, in percentage (e.g. 96 means 96%).                                                  |
-| `supplyApy`                                                                                                                               | *string*                                                                                                                                  | :heavy_minus_sign:                                                                                                                        | Current supply APY earned on this collateral while it backs a loan, in percentage (e.g. 3.5 means 3.5%). Null if the rate is unavailable. |
+| Field                                                                                                                                                                                                                                                                                                                                                                                           | Type                                                                                                                                                                                                                                                                                                                                                                                            | Required                                                                                                                                                                                                                                                                                                                                                                                        | Description                                                                                                                                                                                                                                                                                                                                                                                     |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `vault`                                                                                                                                                                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                              | EVK collateral vault to supply into (pass as collateral_vault when borrowing).                                                                                                                                                                                                                                                                                                                  |
+| `asset`                                                                                                                                                                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                              | Underlying asset of the collateral vault.                                                                                                                                                                                                                                                                                                                                                       |
+| `assetSymbol`                                                                                                                                                                                                                                                                                                                                                                                   | *string*                                                                                                                                                                                                                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                              | Symbol of the collateral's underlying asset (e.g. USDC).                                                                                                                                                                                                                                                                                                                                        |
+| `assetDecimals`                                                                                                                                                                                                                                                                                                                                                                                 | *number*                                                                                                                                                                                                                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                              | Decimals of the collateral's underlying asset.                                                                                                                                                                                                                                                                                                                                                  |
+| `assetPriceUsd`                                                                                                                                                                                                                                                                                                                                                                                 | *string*                                                                                                                                                                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                              | USD price of one whole unit of the collateral asset. Null if the price feed can't quote it (size the supply in token units instead).                                                                                                                                                                                                                                                            |
+| `borrowLtv`                                                                                                                                                                                                                                                                                                                                                                                     | *string*                                                                                                                                                                                                                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                              | Maximum loan-to-value when borrowing against this collateral, in percentage (e.g. 94 means 94%).                                                                                                                                                                                                                                                                                                |
+| `liquidationLtv`                                                                                                                                                                                                                                                                                                                                                                                | *string*                                                                                                                                                                                                                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                              | Loan-to-value at which this collateral is liquidated, in percentage (e.g. 96 means 96%).                                                                                                                                                                                                                                                                                                        |
+| `supplyApy`                                                                                                                                                                                                                                                                                                                                                                                     | *string*                                                                                                                                                                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                              | Current supply APY earned on this collateral while it backs a loan, in percentage (e.g. 3.5 means 3.5%). Null if the rate is unavailable.                                                                                                                                                                                                                                                       |
+| `intrinsicApy`                                                                                                                                                                                                                                                                                                                                                                                  | *string*                                                                                                                                                                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                              | What the collateral token earns inside its own price, in percentage: an ERC-4626 share's vault yield, a staking token's rewards, or an RWA token's NAV accrual, trailing 7 days. Earned on top of supply_apy — the collateral leg's whole yield is their sum. Null means unmeasured, NOT zero: a plain token (USDC, cbBTC) earns nothing and a yield-bearing one may simply not be indexed yet. |

package/docs/models/components/feeaprpctoverride.md

@@ -0,0 +1,19 @@
+# FeeAprPctOverride
+
+Assume this fee rate instead of the pool's measured one.
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/components/fullrange.md

@@ -0,0 +1,19 @@
+# FullRange
+
+The whole price range: never out of range, and never concentrated.
+
+## Example Usage
+
+```typescript
+import { FullRange } from "@compass-labs/api-sdk/models/components";
+
+let value: FullRange = {
+  type: "full",
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        | Example            |
+| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
+| `type`             | *"full"*           | :heavy_check_mark: | N/A                | full               |

package/docs/models/components/launchpad.md

@@ -0,0 +1,15 @@
+# Launchpad
+
+## Example Usage
+
+```typescript
+import { Launchpad } from "@compass-labs/api-sdk/models/components";
+
+let value: Launchpad = "PONS_V1";
+```
+
+## Values
+
+```typescript
+"PONS_V1" | "PONS_V2" | "POOLS_TRADE" | "BAGS"
+```

package/docs/models/components/launchpadmetadata.md

@@ -0,0 +1,25 @@
+# LaunchpadMetadata
+
+Where a memecoin came from, and whether it made it out of the curve.
+
+## Example Usage
+
+```typescript
+import { LaunchpadMetadata } from "@compass-labs/api-sdk/models/components";
+
+let value: LaunchpadMetadata = {
+  launchpad: "PONS_V2",
+  status: "<value>",
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                           | Type                                                                                                                                                            | Required                                                                                                                                                        | Description                                                                                                                                                     |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `launchpad`                                                                                                                                                     | [components.Launchpad](../../models/components/launchpad.md)                                                                                                    | :heavy_check_mark:                                                                                                                                              | N/A                                                                                                                                                             |
+| `status`                                                                                                                                                        | *string*                                                                                                                                                        | :heavy_check_mark:                                                                                                                                              | CURVE (still bonding), GRADUATED (a tradable pool exists), or a wind-down state. Sweeping happens before graduation, so a swept launch that graduated is alive. |
+| `pairToken`                                                                                                                                                     | *string*                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                              | N/A                                                                                                                                                             |
+| `graduationPoolId`                                                                                                                                              | *number*                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                              | N/A                                                                                                                                                             |
+| `launchedAt`                                                                                                                                                    | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                   | :heavy_minus_sign:                                                                                                                                              | N/A                                                                                                                                                             |
+| `creator`                                                                                                                                                       | *string*                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                              | N/A                                                                                                                                                             |

package/docs/models/components/liquiditybucket.md

@@ -0,0 +1,31 @@
+# LiquidityBucket
+
+Active liquidity between two initialized ticks.
+
+This is the shape of the book. A range you open outside where the liquidity
+is will earn nothing while the price stays where it is; a range inside a
+wall of it earns a small share of a large pot.
+
+## Example Usage
+
+```typescript
+import { LiquidityBucket } from "@compass-labs/api-sdk/models/components";
+
+let value: LiquidityBucket = {
+  tickLower: 498388,
+  tickUpper: 928329,
+  liquidity: "<value>",
+  isCurrent: false,
+};
+```
+
+## Fields
+
+| Field                                         | Type                                          | Required                                      | Description                                   | Example                                       |
+| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
+| `tickLower`                                   | *number*                                      | :heavy_check_mark:                            | N/A                                           |                                               |
+| `tickUpper`                                   | *number*                                      | :heavy_check_mark:                            | N/A                                           |                                               |
+| `priceLower`                                  | *string*                                      | :heavy_minus_sign:                            | N/A                                           |                                               |
+| `priceUpper`                                  | *string*                                      | :heavy_minus_sign:                            | N/A                                           |                                               |
+| `liquidity`                                   | *string*                                      | :heavy_check_mark:                            | N/A                                           |                                               |
+| `isCurrent`                                   | *boolean*                                     | :heavy_minus_sign:                            | Whether the pool's price sits in this bucket. | false                                         |

package/docs/models/components/lpposition.md

@@ -0,0 +1,82 @@
+# LpPosition
+
+## Example Usage
+
+```typescript
+import { LpPosition } from "@compass-labs/api-sdk/models/components";
+
+let value: LpPosition = {
+  tokenId: 39099,
+  dexVersion: "V4",
+  token0: {
+    address: "707 Lesch Meadow",
+    kind: "STOCK",
+  },
+  token1: {
+    address: "96147 King Street",
+    kind: "STOCK",
+  },
+  feePpm: 609122,
+  range: {
+    tickLower: 235456,
+    tickUpper: 859949,
+    priceLower: "<value>",
+    priceUpper: "<value>",
+    widthLowerPct: "<value>",
+    widthUpperPct: "<value>",
+    isFullRange: true,
+  },
+  liquidity: "<value>",
+  inRange: false,
+  amount0: "<value>",
+  amount1: "<value>",
+  unclaimedFees0: "<value>",
+  unclaimedFees1: "<value>",
+  costBasis: {
+    source: "unavailable",
+  },
+  status: "ACTIVE",
+  needsRebalance: false,
+  needsCollect: false,
+  lpEarnsFees: true,
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                                                                                                                                                                  | Type                                                                                                                                                                                                                                                                                                                   | Required                                                                                                                                                                                                                                                                                                               | Description                                                                                                                                                                                                                                                                                                            | Example                                                                                                                                                                                                                                                                                                                |
+| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `tokenId`                                                                                                                                                                                                                                                                                                              | *number*                                                                                                                                                                                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                                                                                                                     | The position NFT's id.                                                                                                                                                                                                                                                                                                 |                                                                                                                                                                                                                                                                                                                        |
+| `dexVersion`                                                                                                                                                                                                                                                                                                           | [components.DexVersion](../../models/components/dexversion.md)                                                                                                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                                                                                                                                                                     | Which Uniswap deployment a pool belongs to.<br/><br/>v3 pools hold their own tokens and pay LPs the fee tier. v4 pools live in a<br/>shared PoolManager and may route the fee through a hook, which is where the<br/>launchpad pools' zero LP yield comes from.                                                        |                                                                                                                                                                                                                                                                                                                        |
+| `poolId`                                                                                                                                                                                                                                                                                                               | *number*                                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                     | N/A                                                                                                                                                                                                                                                                                                                    |                                                                                                                                                                                                                                                                                                                        |
+| `poolAddress`                                                                                                                                                                                                                                                                                                          | *string*                                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                     | N/A                                                                                                                                                                                                                                                                                                                    |                                                                                                                                                                                                                                                                                                                        |
+| `token0`                                                                                                                                                                                                                                                                                                               | [components.DexTokenRef](../../models/components/dextokenref.md)                                                                                                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                                                                                                                                                                     | A token as every Risk Yield response describes it.                                                                                                                                                                                                                                                                     |                                                                                                                                                                                                                                                                                                                        |
+| `token1`                                                                                                                                                                                                                                                                                                               | [components.DexTokenRef](../../models/components/dextokenref.md)                                                                                                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                                                                                                                                                                     | A token as every Risk Yield response describes it.                                                                                                                                                                                                                                                                     |                                                                                                                                                                                                                                                                                                                        |
+| `feePpm`                                                                                                                                                                                                                                                                                                               | *number*                                                                                                                                                                                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                                                                                                                     | N/A                                                                                                                                                                                                                                                                                                                    |                                                                                                                                                                                                                                                                                                                        |
+| `range`                                                                                                                                                                                                                                                                                                                | [components.ResolvedRange](../../models/components/resolvedrange.md)                                                                                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                                                                                                                     | A range after the API has snapped it to the pool's tick spacing.<br/><br/>Returned because the range you asked for is rarely the range you get: ticks<br/>are discrete, and a 30% band becomes whichever usable ticks bracket it.                                                                                      |                                                                                                                                                                                                                                                                                                                        |
+| `liquidity`                                                                                                                                                                                                                                                                                                            | *string*                                                                                                                                                                                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                                                                                                                     | N/A                                                                                                                                                                                                                                                                                                                    |                                                                                                                                                                                                                                                                                                                        |
+| `currentTick`                                                                                                                                                                                                                                                                                                          | *number*                                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                     | N/A                                                                                                                                                                                                                                                                                                                    |                                                                                                                                                                                                                                                                                                                        |
+| `currentPrice`                                                                                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                     | N/A                                                                                                                                                                                                                                                                                                                    |                                                                                                                                                                                                                                                                                                                        |
+| `inRange`                                                                                                                                                                                                                                                                                                              | *boolean*                                                                                                                                                                                                                                                                                                              | :heavy_check_mark:                                                                                                                                                                                                                                                                                                     | N/A                                                                                                                                                                                                                                                                                                                    |                                                                                                                                                                                                                                                                                                                        |
+| `outOfRangeSide`                                                                                                                                                                                                                                                                                                       | *string*                                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                     | `below` or `above`: which asset the position is now all of.                                                                                                                                                                                                                                                            |                                                                                                                                                                                                                                                                                                                        |
+| `amount0`                                                                                                                                                                                                                                                                                                              | *string*                                                                                                                                                                                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                                                                                                                     | N/A                                                                                                                                                                                                                                                                                                                    |                                                                                                                                                                                                                                                                                                                        |
+| `amount1`                                                                                                                                                                                                                                                                                                              | *string*                                                                                                                                                                                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                                                                                                                     | N/A                                                                                                                                                                                                                                                                                                                    |                                                                                                                                                                                                                                                                                                                        |
+| `valueUsd`                                                                                                                                                                                                                                                                                                             | *string*                                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                     | N/A                                                                                                                                                                                                                                                                                                                    |                                                                                                                                                                                                                                                                                                                        |
+| `unclaimedFees0`                                                                                                                                                                                                                                                                                                       | *string*                                                                                                                                                                                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                                                                                                                     | N/A                                                                                                                                                                                                                                                                                                                    |                                                                                                                                                                                                                                                                                                                        |
+| `unclaimedFees1`                                                                                                                                                                                                                                                                                                       | *string*                                                                                                                                                                                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                                                                                                                     | N/A                                                                                                                                                                                                                                                                                                                    |                                                                                                                                                                                                                                                                                                                        |
+| `unclaimedFeesUsd`                                                                                                                                                                                                                                                                                                     | *string*                                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                     | N/A                                                                                                                                                                                                                                                                                                                    |                                                                                                                                                                                                                                                                                                                        |
+| `feesCollected0`                                                                                                                                                                                                                                                                                                       | *string*                                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                     | N/A                                                                                                                                                                                                                                                                                                                    |                                                                                                                                                                                                                                                                                                                        |
+| `feesCollected1`                                                                                                                                                                                                                                                                                                       | *string*                                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                     | N/A                                                                                                                                                                                                                                                                                                                    |                                                                                                                                                                                                                                                                                                                        |
+| `costBasis`                                                                                                                                                                                                                                                                                                            | [components.CostBasis](../../models/components/costbasis.md)                                                                                                                                                                                                                                                           | :heavy_check_mark:                                                                                                                                                                                                                                                                                                     | What the position cost to open.<br/><br/>Not readable from the chain: a position reports its liquidity, never the<br/>amounts that bought it. This comes from recorded events, and when there are<br/>none the PnL fields are null rather than guessed — an invented cost basis<br/>would make every number derived from it quietly wrong. |                                                                                                                                                                                                                                                                                                                        |
+| `holdValueUsd`                                                                                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                     | What the deposited amounts would be worth had they simply been held. The comparison that makes impermanent loss meaningful.                                                                                                                                                                                            |                                                                                                                                                                                                                                                                                                                        |
+| `ilUsd`                                                                                                                                                                                                                                                                                                                | *string*                                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                     | N/A                                                                                                                                                                                                                                                                                                                    |                                                                                                                                                                                                                                                                                                                        |
+| `ilPct`                                                                                                                                                                                                                                                                                                                | *string*                                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                     | N/A                                                                                                                                                                                                                                                                                                                    |                                                                                                                                                                                                                                                                                                                        |
+| `feesEarnedUsd`                                                                                                                                                                                                                                                                                                        | *string*                                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                     | Collected plus unclaimed.                                                                                                                                                                                                                                                                                              |                                                                                                                                                                                                                                                                                                                        |
+| `pnlUsd`                                                                                                                                                                                                                                                                                                               | *string*                                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                     | Position value plus fees earned, less what it cost to open.                                                                                                                                                                                                                                                            |                                                                                                                                                                                                                                                                                                                        |
+| `feeAprSinceOpenPct`                                                                                                                                                                                                                                                                                                   | *string*                                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                     | N/A                                                                                                                                                                                                                                                                                                                    |                                                                                                                                                                                                                                                                                                                        |
+| `ageDays`                                                                                                                                                                                                                                                                                                              | *string*                                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                     | N/A                                                                                                                                                                                                                                                                                                                    |                                                                                                                                                                                                                                                                                                                        |
+| `status`                                                                                                                                                                                                                                                                                                               | [components.PositionStatus](../../models/components/positionstatus.md)                                                                                                                                                                                                                                                 | :heavy_check_mark:                                                                                                                                                                                                                                                                                                     | N/A                                                                                                                                                                                                                                                                                                                    |                                                                                                                                                                                                                                                                                                                        |
+| `needsRebalance`                                                                                                                                                                                                                                                                                                       | *boolean*                                                                                                                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                     | N/A                                                                                                                                                                                                                                                                                                                    | false                                                                                                                                                                                                                                                                                                                  |
+| `rebalanceReasons`                                                                                                                                                                                                                                                                                                     | [components.RebalanceReason](../../models/components/rebalancereason.md)[]                                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                     | N/A                                                                                                                                                                                                                                                                                                                    |                                                                                                                                                                                                                                                                                                                        |
+| `needsCollect`                                                                                                                                                                                                                                                                                                         | *boolean*                                                                                                                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                     | N/A                                                                                                                                                                                                                                                                                                                    | false                                                                                                                                                                                                                                                                                                                  |
+| `lpEarnsFees`                                                                                                                                                                                                                                                                                                          | *boolean*                                                                                                                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                     | False when this pool's hook keeps the swap fee. Such a position accrues impermanent loss and earns nothing against it.                                                                                                                                                                                                 | true                                                                                                                                                                                                                                                                                                                   |

package/docs/models/components/pairclass.md

@@ -0,0 +1,17 @@
+# PairClass
+
+What kind of pair a pool is, which is what the product is sorted by.
+
+## Example Usage
+
+```typescript
+import { PairClass } from "@compass-labs/api-sdk/models/components";
+
+let value: PairClass = "MEME_STOCK";
+```
+
+## Values
+
+```typescript
+"MEME_STOCK" | "STOCK_STABLE" | "STOCK_ETH" | "STOCK_STOCK" | "MEME_ETH" | "MEME_STABLE" | "ETH_STABLE" | "OTHER"
+```

package/docs/models/components/percent.md

@@ -0,0 +1,19 @@
+# Percent
+
+How much of the position's liquidity to remove.
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "100";
+```
+