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

package/docs/models/components/planstep.md

@@ -0,0 +1,28 @@
+# PlanStep
+
+One leg of a bundled transaction, in the order it executes.
+
+Every transact endpoint returns a single transaction; this is what is inside
+it, so a caller can show a person what they are about to sign.
+
+## Example Usage
+
+```typescript
+import { PlanStep } from "@compass-labs/api-sdk/models/components";
+
+let value: PlanStep = {
+  kind: "MINT",
+  description:
+    "baggy management heavily among catch hmph coaxingly search idealistic",
+};
+```
+
+## Fields
+
+| Field                                                              | Type                                                               | Required                                                           | Description                                                        |
+| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
+| `kind`                                                             | [components.PlanStepKind](../../models/components/planstepkind.md) | :heavy_check_mark:                                                 | N/A                                                                |
+| `description`                                                      | *string*                                                           | :heavy_check_mark:                                                 | N/A                                                                |
+| `contract`                                                         | *string*                                                           | :heavy_minus_sign:                                                 | N/A                                                                |
+| `token`                                                            | *string*                                                           | :heavy_minus_sign:                                                 | N/A                                                                |
+| `amount`                                                           | *string*                                                           | :heavy_minus_sign:                                                 | N/A                                                                |

package/docs/models/components/planstepkind.md

@@ -0,0 +1,15 @@
+# PlanStepKind
+
+## Example Usage
+
+```typescript
+import { PlanStepKind } from "@compass-labs/api-sdk/models/components";
+
+let value: PlanStepKind = "APPROVE";
+```
+
+## Values
+
+```typescript
+"APPROVE" | "PERMIT2_APPROVE" | "SWAP" | "MINT" | "INCREASE" | "DECREASE" | "COLLECT" | "BURN" | "TRANSFER"
+```

package/docs/models/components/poolhourlypoint.md

@@ -0,0 +1,27 @@
+# PoolHourlyPoint
+
+## Example Usage
+
+```typescript
+import { PoolHourlyPoint } from "@compass-labs/api-sdk/models/components";
+
+let value: PoolHourlyPoint = {
+  hourStart: new Date("2025-10-02T07:31:00.654Z"),
+  swapCount: 0,
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                         | Type                                                                                                                                                          | Required                                                                                                                                                      | Description                                                                                                                                                   | Example                                                                                                                                                       |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `hourStart`                                                                                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                 | :heavy_check_mark:                                                                                                                                            | N/A                                                                                                                                                           |                                                                                                                                                               |
+| `open`                                                                                                                                                        | *string*                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                            | N/A                                                                                                                                                           |                                                                                                                                                               |
+| `high`                                                                                                                                                        | *string*                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                            | N/A                                                                                                                                                           |                                                                                                                                                               |
+| `low`                                                                                                                                                         | *string*                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                            | N/A                                                                                                                                                           |                                                                                                                                                               |
+| `close`                                                                                                                                                       | *string*                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                            | N/A                                                                                                                                                           |                                                                                                                                                               |
+| `closeSource`                                                                                                                                                 | *string*                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                            | SWAP when the hour traded, SNAPSHOT when it did not — an hour with no trades still has a price, and a series with holes cannot be used to measure volatility. |                                                                                                                                                               |
+| `volumeUsd`                                                                                                                                                   | *string*                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                            | N/A                                                                                                                                                           |                                                                                                                                                               |
+| `lpFeesUsd`                                                                                                                                                   | *string*                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                            | N/A                                                                                                                                                           |                                                                                                                                                               |
+| `swapCount`                                                                                                                                                   | *number*                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                            | N/A                                                                                                                                                           | 0                                                                                                                                                             |
+| `tvlUsdEnd`                                                                                                                                                   | *string*                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                            | N/A                                                                                                                                                           |                                                                                                                                                               |

package/docs/models/components/poolonchainstate.md

@@ -0,0 +1,34 @@
+# PoolOnChainState
+
+Read live, at request time.
+
+The indexer's numbers are minutes old, which is fine for ranking and not
+fine for sizing a position on an asset that moves this fast.
+
+## Example Usage
+
+```typescript
+import { PoolOnChainState } from "@compass-labs/api-sdk/models/components";
+
+let value: PoolOnChainState = {
+  blockNumber: 48351,
+  sqrtPriceX96: "<value>",
+  tick: 528173,
+  liquidity: "<value>",
+  fetchedAt: new Date("2025-08-06T18:12:35.269Z"),
+};
+```
+
+## Fields
+
+| Field                                                                                                                               | Type                                                                                                                                | Required                                                                                                                            | Description                                                                                                                         |
+| ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
+| `blockNumber`                                                                                                                       | *number*                                                                                                                            | :heavy_check_mark:                                                                                                                  | N/A                                                                                                                                 |
+| `sqrtPriceX96`                                                                                                                      | *string*                                                                                                                            | :heavy_check_mark:                                                                                                                  | N/A                                                                                                                                 |
+| `tick`                                                                                                                              | *number*                                                                                                                            | :heavy_check_mark:                                                                                                                  | N/A                                                                                                                                 |
+| `price`                                                                                                                             | *string*                                                                                                                            | :heavy_minus_sign:                                                                                                                  | N/A                                                                                                                                 |
+| `liquidity`                                                                                                                         | *string*                                                                                                                            | :heavy_check_mark:                                                                                                                  | N/A                                                                                                                                 |
+| `lpFeePpm`                                                                                                                          | *number*                                                                                                                            | :heavy_minus_sign:                                                                                                                  | The fee the pool charges right now. A dynamic-fee pool can quote zero, which is what LPs earning nothing looks like from the chain. |
+| `feeGrowthGlobal0X128`                                                                                                              | *string*                                                                                                                            | :heavy_minus_sign:                                                                                                                  | N/A                                                                                                                                 |
+| `feeGrowthGlobal1X128`                                                                                                              | *string*                                                                                                                            | :heavy_minus_sign:                                                                                                                  | N/A                                                                                                                                 |
+| `fetchedAt`                                                                                                                         | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                       | :heavy_check_mark:                                                                                                                  | N/A                                                                                                                                 |

package/docs/models/components/poolselector.md

@@ -0,0 +1,28 @@
+# PoolSelector
+
+Which pool, by id or by its key.
+
+A pool id is stable and is what the list endpoints return. The long form
+exists so a caller who knows the pair can address a pool without a lookup —
+on a chain minting twenty thousand pools a day, a client should not have to
+search for one it just created.
+
+## Example Usage
+
+```typescript
+import { PoolSelector } from "@compass-labs/api-sdk/models/components";
+
+let value: PoolSelector = {};
+```
+
+## Fields
+
+| Field                                                                                                                                                                                                                                           | Type                                                                                                                                                                                                                                            | Required                                                                                                                                                                                                                                        | Description                                                                                                                                                                                                                                     |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `poolId`                                                                                                                                                                                                                                        | *number*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | The pool's id, as returned by `GET /pools`.                                                                                                                                                                                                     |
+| `token0`                                                                                                                                                                                                                                        | *string*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | Lower-sorting token address.                                                                                                                                                                                                                    |
+| `token1`                                                                                                                                                                                                                                        | *string*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | Higher-sorting token address.                                                                                                                                                                                                                   |
+| `feePpm`                                                                                                                                                                                                                                        | *number*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | Fee tier in hundredths of a bip (3000 = 0.30%).                                                                                                                                                                                                 |
+| `tickSpacing`                                                                                                                                                                                                                                   | *number*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | Required for v4, where it is part of the pool key.                                                                                                                                                                                              |
+| `hooks`                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | v4 hook address; part of the pool key.                                                                                                                                                                                                          |
+| `dexVersion`                                                                                                                                                                                                                                    | [components.DexVersion](../../models/components/dexversion.md)                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                              | 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. |

package/docs/models/components/positionstatus.md

@@ -0,0 +1,15 @@
+# PositionStatus
+
+## Example Usage
+
+```typescript
+import { PositionStatus } from "@compass-labs/api-sdk/models/components";
+
+let value: PositionStatus = "ACTIVE";
+```
+
+## Values
+
+```typescript
+"ACTIVE" | "OUT_OF_RANGE" | "EMPTY" | "CLOSED"
+```

package/docs/models/components/pricelower.md

@@ -0,0 +1,17 @@
+# PriceLower
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/components/pricerange.md

@@ -0,0 +1,23 @@
+# PriceRange
+
+Bounds as prices (token1 per token0, decimals-adjusted).
+
+## Example Usage
+
+```typescript
+import { PriceRange } from "@compass-labs/api-sdk/models/components";
+
+let value: PriceRange = {
+  type: "prices",
+  priceLower: "<value>",
+  priceUpper: 458.66,
+};
+```
+
+## Fields
+
+| Field                   | Type                    | Required                | Description             | Example                 |
+| ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- |
+| `type`                  | *"prices"*              | :heavy_check_mark:      | N/A                     | prices                  |
+| `priceLower`            | *components.PriceLower* | :heavy_check_mark:      | N/A                     |                         |
+| `priceUpper`            | *components.PriceUpper* | :heavy_check_mark:      | N/A                     |                         |

package/docs/models/components/pricesource.md

@@ -0,0 +1,21 @@
+# PriceSource
+
+Where a USD price came from, best first.
+
+Returned with every price because they are not equally trustworthy: a
+Chainlink feed is a measurement, a price read off a shallow pool is closer
+to a rumour.
+
+## Example Usage
+
+```typescript
+import { PriceSource } from "@compass-labs/api-sdk/models/components";
+
+let value: PriceSource = "CHAINLINK";
+```
+
+## Values
+
+```typescript
+"CHAINLINK" | "RH_REST" | "LLAMA" | "POOL" | "PEG"
+```

package/docs/models/components/priceupper.md

@@ -0,0 +1,17 @@
+# PriceUpper
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/components/probabilisticoutlook.md

@@ -0,0 +1,49 @@
+# ProbabilisticOutlook
+
+How likely the outcomes are, not just how large.
+
+## Example Usage
+
+```typescript
+import { ProbabilisticOutlook } from "@compass-labs/api-sdk/models/components";
+
+let value: ProbabilisticOutlook = {
+  method: "<value>",
+  paths: 721593,
+  pExitWithinHorizonPct: "<value>",
+  pOutAtHorizonPct: "<value>",
+  expectedTimeInRangePct: "<value>",
+  expectedIlUsd: "<value>",
+  expectedNetPnlUsd: "<value>",
+  probNetLossPct: "<value>",
+  ilPctPercentiles: {
+    "key": "<value>",
+  },
+  ilUsdPercentiles: {
+    "key": "<value>",
+    "key1": "<value>",
+    "key2": "<value>",
+  },
+  netPnlUsdPercentiles: {
+    "key": "<value>",
+    "key1": "<value>",
+    "key2": "<value>",
+  },
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                               | Type                                                                                                                                                                | Required                                                                                                                                                            | Description                                                                                                                                                         |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `method`                                                                                                                                                            | *string*                                                                                                                                                            | :heavy_check_mark:                                                                                                                                                  | N/A                                                                                                                                                                 |
+| `paths`                                                                                                                                                             | *number*                                                                                                                                                            | :heavy_check_mark:                                                                                                                                                  | N/A                                                                                                                                                                 |
+| `pExitWithinHorizonPct`                                                                                                                                             | *string*                                                                                                                                                            | :heavy_check_mark:                                                                                                                                                  | The chance the price *touches* a bound at any point, not just ends outside it. A position that left the range and came back still stopped earning while it was out. |
+| `pOutAtHorizonPct`                                                                                                                                                  | *string*                                                                                                                                                            | :heavy_check_mark:                                                                                                                                                  | N/A                                                                                                                                                                 |
+| `expectedTimeInRangePct`                                                                                                                                            | *string*                                                                                                                                                            | :heavy_check_mark:                                                                                                                                                  | N/A                                                                                                                                                                 |
+| `expectedIlUsd`                                                                                                                                                     | *string*                                                                                                                                                            | :heavy_check_mark:                                                                                                                                                  | N/A                                                                                                                                                                 |
+| `expectedNetPnlUsd`                                                                                                                                                 | *string*                                                                                                                                                            | :heavy_check_mark:                                                                                                                                                  | N/A                                                                                                                                                                 |
+| `probNetLossPct`                                                                                                                                                    | *string*                                                                                                                                                            | :heavy_check_mark:                                                                                                                                                  | N/A                                                                                                                                                                 |
+| `ilPctPercentiles`                                                                                                                                                  | Record<string, *string*>                                                                                                                                            | :heavy_check_mark:                                                                                                                                                  | N/A                                                                                                                                                                 |
+| `ilUsdPercentiles`                                                                                                                                                  | Record<string, *string*>                                                                                                                                            | :heavy_check_mark:                                                                                                                                                  | N/A                                                                                                                                                                 |
+| `netPnlUsdPercentiles`                                                                                                                                              | Record<string, *string*>                                                                                                                                            | :heavy_check_mark:                                                                                                                                                  | N/A                                                                                                                                                                 |

package/docs/models/components/quoteusdmovepct.md

@@ -0,0 +1,19 @@
+# QuoteUsdMovePct
+
+How far token1 — the stock, on a meme x stock pair — moves in dollars. On its own this changes what the position is worth without causing any impermanent loss at all.
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "0";
+```
+

package/docs/models/components/ratiomovepct.md

@@ -0,0 +1,19 @@
+# RatioMovePct
+
+How far the pair's ratio moves. This is what drives loss.
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/components/rebalancephase.md

@@ -0,0 +1,23 @@
+# RebalancePhase
+
+One stage of the plan, with the legs it contributes.
+
+## Example Usage
+
+```typescript
+import { RebalancePhase } from "@compass-labs/api-sdk/models/components";
+
+let value: RebalancePhase = {
+  name: "<value>",
+  description:
+    "up apparatus strategy what hastily beneath signature hm during disrespect",
+};
+```
+
+## Fields
+
+| Field                                                        | Type                                                         | Required                                                     | Description                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `name`                                                       | *string*                                                     | :heavy_check_mark:                                           | N/A                                                          |
+| `description`                                                | *string*                                                     | :heavy_check_mark:                                           | N/A                                                          |
+| `steps`                                                      | [components.PlanStep](../../models/components/planstep.md)[] | :heavy_minus_sign:                                           | N/A                                                          |

package/docs/models/components/rebalancereason.md

@@ -0,0 +1,15 @@
+# RebalanceReason
+
+## Example Usage
+
+```typescript
+import { RebalanceReason } from "@compass-labs/api-sdk/models/components";
+
+let value: RebalanceReason = "VOL_REGIME_CHANGE";
+```
+
+## Values
+
+```typescript
+"OUT_OF_RANGE" | "PRICE_DRIFT" | "VOL_REGIME_CHANGE" | "UNCOLLECTED_FEES" | "FEES_NOT_EARNED" | "STALE_DATA"
+```

package/docs/models/components/rebalancestrategy.md

@@ -0,0 +1,17 @@
+# RebalanceStrategy
+
+How to choose the new range.
+
+## Example Usage
+
+```typescript
+import { RebalanceStrategy } from "@compass-labs/api-sdk/models/components";
+
+let value: RebalanceStrategy = "vol_scaled";
+```
+
+## Values
+
+```typescript
+"recenter_symmetric_pct" | "vol_scaled" | "manual"
+```

package/docs/models/components/resolvedrange.md

@@ -0,0 +1,34 @@
+# ResolvedRange
+
+A range after the API has snapped it to the pool's tick spacing.
+
+Returned because the range you asked for is rarely the range you get: ticks
+are discrete, and a 30% band becomes whichever usable ticks bracket it.
+
+## Example Usage
+
+```typescript
+import { ResolvedRange } from "@compass-labs/api-sdk/models/components";
+
+let value: ResolvedRange = {
+  tickLower: 292322,
+  tickUpper: 793130,
+  priceLower: "<value>",
+  priceUpper: "<value>",
+  widthLowerPct: "<value>",
+  widthUpperPct: "<value>",
+  isFullRange: true,
+};
+```
+
+## Fields
+
+| Field                                                 | Type                                                  | Required                                              | Description                                           |
+| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
+| `tickLower`                                           | *number*                                              | :heavy_check_mark:                                    | N/A                                                   |
+| `tickUpper`                                           | *number*                                              | :heavy_check_mark:                                    | N/A                                                   |
+| `priceLower`                                          | *string*                                              | :heavy_check_mark:                                    | N/A                                                   |
+| `priceUpper`                                          | *string*                                              | :heavy_check_mark:                                    | N/A                                                   |
+| `widthLowerPct`                                       | *string*                                              | :heavy_check_mark:                                    | How far below the current price the lower bound sits. |
+| `widthUpperPct`                                       | *string*                                              | :heavy_check_mark:                                    | N/A                                                   |
+| `isFullRange`                                         | *boolean*                                             | :heavy_check_mark:                                    | N/A                                                   |

package/docs/models/components/riskassumptions.md

@@ -0,0 +1,41 @@
+# RiskAssumptions
+
+What the answers rest on.
+
+Returned in full because every number below is only as good as these, and a
+caller who disagrees with one can override it and ask again.
+
+## Example Usage
+
+```typescript
+import { RiskAssumptions } from "@compass-labs/api-sdk/models/components";
+
+let value: RiskAssumptions = {
+  entryPrice: "<value>",
+  depositValueUsd: "<value>",
+  horizonDays: 754671,
+  volSource: "measured",
+  feeSource: "measured",
+  lpEarnsFees: true,
+};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   | Example                                                                                       |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `entryPrice`                                                                                  | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |                                                                                               |
+| `price0Usd`                                                                                   | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |                                                                                               |
+| `price1Usd`                                                                                   | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |                                                                                               |
+| `priceSource0`                                                                                | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |                                                                                               |
+| `priceSource1`                                                                                | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |                                                                                               |
+| `pricesUpdatedAt`                                                                             | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |                                                                                               |
+| `depositValueUsd`                                                                             | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |                                                                                               |
+| `horizonDays`                                                                                 | *number*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |                                                                                               |
+| `annualVolPct`                                                                                | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |                                                                                               |
+| `volSource`                                                                                   | *string*                                                                                      | :heavy_minus_sign:                                                                            | `measured`, `override`, or `unavailable`.                                                     | measured                                                                                      |
+| `feeAprPct`                                                                                   | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |                                                                                               |
+| `feeSource`                                                                                   | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           | measured                                                                                      |
+| `feesPerDayUsdPool`                                                                           | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |                                                                                               |
+| `shareOfActiveLiquidityPct`                                                                   | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |                                                                                               |
+| `lpEarnsFees`                                                                                 | *boolean*                                                                                     | :heavy_minus_sign:                                                                            | N/A                                                                                           | true                                                                                          |

package/docs/models/components/riskscenariosrequest.md

@@ -0,0 +1,55 @@
+# RiskScenariosRequest
+
+Ask what a position would do under a set of hypotheticals.
+
+## Example Usage
+
+```typescript
+import { RiskScenariosRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: RiskScenariosRequest = {
+  chain: "robinhood",
+  pool: {
+    poolId: 1,
+  },
+  range: {
+    type: "symmetric_pct",
+    widthPct: "30",
+  },
+  deposit: {
+    type: "usd",
+    valueUsd: "1000",
+  },
+  horizonDays: 30,
+  scenarios: [
+    {
+      name: "meme halves",
+      ratioMovePct: "-50",
+    },
+    {
+      name: "meme doubles",
+      ratioMovePct: "100",
+    },
+    {
+      name: "stock falls 10%",
+      quoteUsdMovePct: "-10",
+    },
+  ],
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                                                                                                                                              | Type                                                                                                                                                                                                                                                                                               | Required                                                                                                                                                                                                                                                                                           | Description                                                                                                                                                                                                                                                                                        | Example                                                                                                                                                                                                                                                                                            |
+| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `chain`                                                                                                                                                                                                                                                                                            | [components.RiskScenariosRequestChain](../../models/components/riskscenariosrequestchain.md)                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                                                                                 | N/A                                                                                                                                                                                                                                                                                                | robinhood                                                                                                                                                                                                                                                                                          |
+| `pool`                                                                                                                                                                                                                                                                                             | [components.PoolSelector](../../models/components/poolselector.md)                                                                                                                                                                                                                                 | :heavy_check_mark:                                                                                                                                                                                                                                                                                 | Which pool, by id or by its key.<br/><br/>A pool id is stable and is what the list endpoints return. The long form<br/>exists so a caller who knows the pair can address a pool without a lookup —<br/>on a chain minting twenty thousand pools a day, a client should not have to<br/>search for one it just created. |                                                                                                                                                                                                                                                                                                    |
+| `range`                                                                                                                                                                                                                                                                                            | *components.RiskScenariosRequestRange*                                                                                                                                                                                                                                                             | :heavy_check_mark:                                                                                                                                                                                                                                                                                 | N/A                                                                                                                                                                                                                                                                                                | {<br/>"type": "symmetric_pct",<br/>"width_pct": "30"<br/>}                                                                                                                                                                                                                                         |
+| `deposit`                                                                                                                                                                                                                                                                                          | *components.RiskScenariosRequestDeposit*                                                                                                                                                                                                                                                           | :heavy_check_mark:                                                                                                                                                                                                                                                                                 | N/A                                                                                                                                                                                                                                                                                                | {<br/>"type": "usd",<br/>"value_usd": "1000"<br/>}                                                                                                                                                                                                                                                 |
+| `horizonDays`                                                                                                                                                                                                                                                                                      | *number*                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                 | N/A                                                                                                                                                                                                                                                                                                | 30                                                                                                                                                                                                                                                                                                 |
+| `scenarios`                                                                                                                                                                                                                                                                                        | [components.ScenarioInput](../../models/components/scenarioinput.md)[]                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                                                                 | Leave empty for a default spread of moves.                                                                                                                                                                                                                                                         | [<br/>{<br/>"name": "meme halves",<br/>"ratio_move_pct": "-50"<br/>},<br/>{<br/>"name": "meme doubles",<br/>"ratio_move_pct": "100"<br/>},<br/>{<br/>"name": "stock falls 10%",<br/>"quote_usd_move_pct": "-10"<br/>}<br/>]                                                                        |
+| `feeAprPctOverride`                                                                                                                                                                                                                                                                                | *components.FeeAprPctOverride*                                                                                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                                                                                 | Assume this fee rate instead of the pool's measured one.                                                                                                                                                                                                                                           |                                                                                                                                                                                                                                                                                                    |
+| `volOverridePct`                                                                                                                                                                                                                                                                                   | *components.VolOverridePct*                                                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                                                                 | Assume this annualized volatility instead of the pair's measured one. Needed for a pool too new to have measured any.                                                                                                                                                                              |                                                                                                                                                                                                                                                                                                    |
+| `monteCarlo`                                                                                                                                                                                                                                                                                       | *boolean*                                                                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                                                 | Also estimate how likely each outcome is, not just its size.                                                                                                                                                                                                                                       | true                                                                                                                                                                                                                                                                                               |
+| `nPaths`                                                                                                                                                                                                                                                                                           | *number*                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                 | N/A                                                                                                                                                                                                                                                                                                | 2000                                                                                                                                                                                                                                                                                               |
+| `seed`                                                                                                                                                                                                                                                                                             | *number*                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                 | Fixed so the same request gives the same answer.                                                                                                                                                                                                                                                   | 0                                                                                                                                                                                                                                                                                                  |