@compass-labs/api-sdk 2.2.106 → 2.2.107

package/docs/models/components/riskyieldincreaserequestdeposit.md

@@ -1,34 +0,0 @@
-# RiskYieldIncreaseRequestDeposit
-
-
-## Supported Types
-
-### `components.BothSidesDeposit`
-
-```typescript
-const value: components.BothSidesDeposit = {
-  type: "both",
-  amount0: 3276.53,
-  amount1: 3718.96,
-};
-```
-
-### `components.SingleSidedDeposit`
-
-```typescript
-const value: components.SingleSidedDeposit = {
-  type: "single",
-  token: "<value>",
-  amount: 8108.49,
-};
-```
-
-### `components.UsdDeposit`
-
-```typescript
-const value: components.UsdDeposit = {
-  type: "usd",
-  valueUsd: "1000",
-};
-```
-

package/docs/models/components/riskyieldincreaserequestslippagepct.md

@@ -1,19 +0,0 @@
-# RiskYieldIncreaseRequestSlippagePct
-
-How far the executed amounts may fall short of the quote before the transaction reverts. Memecoin pools move between the quote and the block that includes the transaction.
-
-
-## Supported Types
-
-### `number`
-
-```typescript
-const value: number = 1284.03;
-```
-
-### `string`
-
-```typescript
-const value: string = "0.5";
-```
-

package/docs/models/components/riskyieldliquidityresponse.md

@@ -1,36 +0,0 @@
-# RiskYieldLiquidityResponse
-
-The shape every liquidity-changing endpoint returns.
-
-## Example Usage
-
-```typescript
-import { RiskYieldLiquidityResponse } from "@compass-labs/api-sdk/models/components";
-
-let value: RiskYieldLiquidityResponse = {
-  plan: {
-    amount0Desired: "<value>",
-    amount1Desired: "<value>",
-    amount0Min: "<value>",
-    amount1Min: "<value>",
-    leftover0: "0",
-    leftover1: "0",
-  },
-};
-```
-
-## Fields
-
-| Field                                                                            | Type                                                                             | Required                                                                         | Description                                                                      |
-| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
-| `transaction`                                                                    | [components.UnsignedTransaction](../../models/components/unsignedtransaction.md) | :heavy_minus_sign:                                                               | N/A                                                                              |
-| `positionId`                                                                     | *number*                                                                         | :heavy_minus_sign:                                                               | N/A                                                                              |
-| `range`                                                                          | [components.ResolvedRange](../../models/components/resolvedrange.md)             | :heavy_minus_sign:                                                               | N/A                                                                              |
-| `plan`                                                                           | [components.DepositPlan](../../models/components/depositplan.md)                 | :heavy_minus_sign:                                                               | N/A                                                                              |
-| `expectedLiquidity`                                                              | *string*                                                                         | :heavy_minus_sign:                                                               | N/A                                                                              |
-| `liquidityRemoved`                                                               | *string*                                                                         | :heavy_minus_sign:                                                               | N/A                                                                              |
-| `amount0Min`                                                                     | *string*                                                                         | :heavy_minus_sign:                                                               | N/A                                                                              |
-| `amount1Min`                                                                     | *string*                                                                         | :heavy_minus_sign:                                                               | N/A                                                                              |
-| `steps`                                                                          | [components.PlanStep](../../models/components/planstep.md)[]                     | :heavy_minus_sign:                                                               | N/A                                                                              |
-| `simulation`                                                                     | [components.Simulation](../../models/components/simulation.md)                   | :heavy_minus_sign:                                                               | N/A                                                                              |
-| `warnings`                                                                       | *string*[]                                                                       | :heavy_minus_sign:                                                               | N/A                                                                              |

package/docs/models/components/riskyieldmintrequest.md

@@ -1,41 +0,0 @@
-# RiskYieldMintRequest
-
-Open a new position.
-
-## Example Usage
-
-```typescript
-import { RiskYieldMintRequest } from "@compass-labs/api-sdk/models/components";
-
-let value: RiskYieldMintRequest = {
-  owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
-  chain: "robinhood",
-  pool: {
-    poolId: 1,
-  },
-  range: {
-    type: "symmetric_pct",
-    widthPct: "30",
-  },
-  deposit: {
-    type: "both",
-    amount0: "100",
-    amount1: "0.04",
-  },
-};
-```
-
-## Fields
-
-| Field                                                                                                                                                                                                                                                                                              | Type                                                                                                                                                                                                                                                                                               | Required                                                                                                                                                                                                                                                                                           | Description                                                                                                                                                                                                                                                                                        | Example                                                                                                                                                                                                                                                                                            |
-| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `owner`                                                                                                                                                                                                                                                                                            | *string*                                                                                                                                                                                                                                                                                           | :heavy_check_mark:                                                                                                                                                                                                                                                                                 | The wallet that owns the Risk Yield Account.                                                                                                                                                                                                                                                       | 0x06A9aF046187895AcFc7258450B15397CAc67400                                                                                                                                                                                                                                                         |
-| `chain`                                                                                                                                                                                                                                                                                            | [components.RiskYieldMintRequestChain](../../models/components/riskyieldmintrequestchain.md)                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                                                                                 | Risk Yield is available on Robinhood Chain only.                                                                                                                                                                                                                                                   | robinhood                                                                                                                                                                                                                                                                                          |
-| `gasSponsorship`                                                                                                                                                                                                                                                                                   | *boolean*                                                                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                                                 | Return EIP-712 typed data for the owner to sign instead of a transaction, so a sponsor can broadcast it.                                                                                                                                                                                           | false                                                                                                                                                                                                                                                                                              |
-| `preview`                                                                                                                                                                                                                                                                                          | *boolean*                                                                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                                                 | Return the plan and its simulation without building a transaction. Nothing is signed and nothing can be broadcast.                                                                                                                                                                                 | false                                                                                                                                                                                                                                                                                              |
-| `slippagePct`                                                                                                                                                                                                                                                                                      | *components.RiskYieldMintRequestSlippagePct*                                                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                                                                                 | How far the executed amounts may fall short of the quote before the transaction reverts. Memecoin pools move between the quote and the block that includes the transaction.                                                                                                                        | 0.5                                                                                                                                                                                                                                                                                                |
-| `deadlineSeconds`                                                                                                                                                                                                                                                                                  | *number*                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                 | How long the transaction stays valid once built.                                                                                                                                                                                                                                                   | 300                                                                                                                                                                                                                                                                                                |
-| `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.RiskYieldMintRequestRange*                                                                                                                                                                                                                                                             | :heavy_check_mark:                                                                                                                                                                                                                                                                                 | N/A                                                                                                                                                                                                                                                                                                | {<br/>"type": "symmetric_pct",<br/>"width_pct": "30"<br/>}                                                                                                                                                                                                                                         |
-| `deposit`                                                                                                                                                                                                                                                                                          | *components.RiskYieldMintRequestDeposit*                                                                                                                                                                                                                                                           | :heavy_check_mark:                                                                                                                                                                                                                                                                                 | N/A                                                                                                                                                                                                                                                                                                | {<br/>"amount0": "100",<br/>"amount1": "0.04",<br/>"type": "both"<br/>}                                                                                                                                                                                                                            |
-| `recipient`                                                                                                                                                                                                                                                                                        | *string*                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                 | Who receives the position NFT. Defaults to the Risk Yield Account, which is what makes it manageable through this API.                                                                                                                                                                             |                                                                                                                                                                                                                                                                                                    |

package/docs/models/components/riskyieldmintrequestchain.md

@@ -1,17 +0,0 @@
-# RiskYieldMintRequestChain
-
-Risk Yield is available on Robinhood Chain only.
-
-## Example Usage
-
-```typescript
-import { RiskYieldMintRequestChain } from "@compass-labs/api-sdk/models/components";
-
-let value: RiskYieldMintRequestChain = "robinhood";
-```
-
-## Values
-
-```typescript
-"robinhood"
-```

package/docs/models/components/riskyieldmintrequestdeposit.md

@@ -1,34 +0,0 @@
-# RiskYieldMintRequestDeposit
-
-
-## Supported Types
-
-### `components.BothSidesDeposit`
-
-```typescript
-const value: components.BothSidesDeposit = {
-  type: "both",
-  amount0: 3276.53,
-  amount1: 3718.96,
-};
-```
-
-### `components.SingleSidedDeposit`
-
-```typescript
-const value: components.SingleSidedDeposit = {
-  type: "single",
-  token: "<value>",
-  amount: 8108.49,
-};
-```
-
-### `components.UsdDeposit`
-
-```typescript
-const value: components.UsdDeposit = {
-  type: "usd",
-  valueUsd: "1000",
-};
-```
-

package/docs/models/components/riskyieldmintrequestrange.md

@@ -1,42 +0,0 @@
-# RiskYieldMintRequestRange
-
-
-## Supported Types
-
-### `components.FullRange`
-
-```typescript
-const value: components.FullRange = {
-  type: "full",
-};
-```
-
-### `components.PriceRange`
-
-```typescript
-const value: components.PriceRange = {
-  type: "prices",
-  priceLower: "<value>",
-  priceUpper: 3867.55,
-};
-```
-
-### `components.SymmetricRange`
-
-```typescript
-const value: components.SymmetricRange = {
-  type: "symmetric_pct",
-  widthPct: "30",
-};
-```
-
-### `components.TickRange`
-
-```typescript
-const value: components.TickRange = {
-  type: "ticks",
-  tickLower: 948265,
-  tickUpper: 918564,
-};
-```
-

package/docs/models/components/riskyieldmintrequestslippagepct.md

@@ -1,19 +0,0 @@
-# RiskYieldMintRequestSlippagePct
-
-How far the executed amounts may fall short of the quote before the transaction reverts. Memecoin pools move between the quote and the block that includes the transaction.
-
-
-## Supported Types
-
-### `number`
-
-```typescript
-const value: number = 1284.03;
-```
-
-### `string`
-
-```typescript
-const value: string = "0.5";
-```
-

package/docs/models/components/riskyieldpositionsresponse.md

@@ -1,59 +0,0 @@
-# RiskYieldPositionsResponse
-
-## Example Usage
-
-```typescript
-import { RiskYieldPositionsResponse } from "@compass-labs/api-sdk/models/components";
-
-let value: RiskYieldPositionsResponse = {
-  account: "73663182",
-  positions: [
-    {
-      tokenId: 645840,
-      dexVersion: "V4",
-      token0: {
-        address: "707 Lesch Meadow",
-        kind: "STOCK",
-      },
-      token1: {
-        address: "96147 King Street",
-        kind: "STOCK",
-      },
-      feePpm: 544809,
-      range: {
-        tickLower: 235456,
-        tickUpper: 859949,
-        priceLower: "<value>",
-        priceUpper: "<value>",
-        widthLowerPct: "<value>",
-        widthUpperPct: "<value>",
-        isFullRange: true,
-      },
-      liquidity: "<value>",
-      inRange: true,
-      amount0: "<value>",
-      amount1: "<value>",
-      unclaimedFees0: "<value>",
-      unclaimedFees1: "<value>",
-      costBasis: {
-        source: "unavailable",
-      },
-      status: "CLOSED",
-      needsRebalance: false,
-      needsCollect: false,
-      lpEarnsFees: true,
-    },
-  ],
-};
-```
-
-## Fields
-
-| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
-| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
-| `account`                                                                                     | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
-| `positions`                                                                                   | [components.LpPosition](../../models/components/lpposition.md)[]                              | :heavy_check_mark:                                                                            | N/A                                                                                           |
-| `totalValueUsd`                                                                               | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `totalUnclaimedFeesUsd`                                                                       | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `totalPnlUsd`                                                                                 | *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                                                                                           |

package/docs/models/components/riskyieldrebalancerequest.md

@@ -1,40 +0,0 @@
-# RiskYieldRebalanceRequest
-
-Move a position to a new range.
-
-Rebalancing is not free: it realizes the impermanent loss taken so far, pays
-gas twice and a swap, and puts the position back at risk from a new price.
-The API will answer `NOOP` when it thinks the move is not worth making.
-
-## Example Usage
-
-```typescript
-import { RiskYieldRebalanceRequest } from "@compass-labs/api-sdk/models/components";
-
-let value: RiskYieldRebalanceRequest = {
-  owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
-  chain: "robinhood",
-  positionId: 1076416,
-  strategy: "vol_scaled",
-  horizonDays: 7,
-};
-```
-
-## Fields
-
-| Field                                                                                                                                                                                                                                           | Type                                                                                                                                                                                                                                            | Required                                                                                                                                                                                                                                        | Description                                                                                                                                                                                                                                     | Example                                                                                                                                                                                                                                         |
-| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `owner`                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                                                                              | The wallet that owns the Risk Yield Account.                                                                                                                                                                                                    | 0x06A9aF046187895AcFc7258450B15397CAc67400                                                                                                                                                                                                      |
-| `chain`                                                                                                                                                                                                                                         | [components.RiskYieldRebalanceRequestChain](../../models/components/riskyieldrebalancerequestchain.md)                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                              | Risk Yield is available on Robinhood Chain only.                                                                                                                                                                                                | robinhood                                                                                                                                                                                                                                       |
-| `gasSponsorship`                                                                                                                                                                                                                                | *boolean*                                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                              | Return EIP-712 typed data for the owner to sign instead of a transaction, so a sponsor can broadcast it.                                                                                                                                        | false                                                                                                                                                                                                                                           |
-| `preview`                                                                                                                                                                                                                                       | *boolean*                                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                              | Return the plan and its simulation without building a transaction. Nothing is signed and nothing can be broadcast.                                                                                                                              | false                                                                                                                                                                                                                                           |
-| `slippagePct`                                                                                                                                                                                                                                   | *components.RiskYieldRebalanceRequestSlippagePct*                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                              | How far the executed amounts may fall short of the quote before the transaction reverts. Memecoin pools move between the quote and the block that includes the transaction.                                                                     | 0.5                                                                                                                                                                                                                                             |
-| `deadlineSeconds`                                                                                                                                                                                                                               | *number*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | How long the transaction stays valid once built.                                                                                                                                                                                                | 300                                                                                                                                                                                                                                             |
-| `positionId`                                                                                                                                                                                                                                    | *number*                                                                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                             | 1076416                                                                                                                                                                                                                                         |
-| `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. |                                                                                                                                                                                                                                                 |
-| `strategy`                                                                                                                                                                                                                                      | [components.RebalanceStrategy](../../models/components/rebalancestrategy.md)                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                              | How to choose the new range.                                                                                                                                                                                                                    |                                                                                                                                                                                                                                                 |
-| `widthPct`                                                                                                                                                                                                                                      | *components.RiskYieldRebalanceRequestWidthPct*                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                              | Required for `recenter_symmetric_pct`.                                                                                                                                                                                                          |                                                                                                                                                                                                                                                 |
-| `horizonDays`                                                                                                                                                                                                                                   | *number*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | For `vol_scaled`: how long the range should survive an ordinary move. A range narrower than the asset's usual movement spends most of its life out of range earning nothing.                                                                    | 7                                                                                                                                                                                                                                               |
-| `tickLower`                                                                                                                                                                                                                                     | *number*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | For `manual`.                                                                                                                                                                                                                                   |                                                                                                                                                                                                                                                 |
-| `tickUpper`                                                                                                                                                                                                                                     | *number*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | For `manual`.                                                                                                                                                                                                                                   |                                                                                                                                                                                                                                                 |
-| `burnOld`                                                                                                                                                                                                                                       | *boolean*                                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                              | Destroy the emptied NFT once it is unwound.                                                                                                                                                                                                     | true                                                                                                                                                                                                                                            |

package/docs/models/components/riskyieldrebalancerequestchain.md

@@ -1,17 +0,0 @@
-# RiskYieldRebalanceRequestChain
-
-Risk Yield is available on Robinhood Chain only.
-
-## Example Usage
-
-```typescript
-import { RiskYieldRebalanceRequestChain } from "@compass-labs/api-sdk/models/components";
-
-let value: RiskYieldRebalanceRequestChain = "robinhood";
-```
-
-## Values
-
-```typescript
-"robinhood"
-```

package/docs/models/components/riskyieldrebalancerequestslippagepct.md

@@ -1,19 +0,0 @@
-# RiskYieldRebalanceRequestSlippagePct
-
-How far the executed amounts may fall short of the quote before the transaction reverts. Memecoin pools move between the quote and the block that includes the transaction.
-
-
-## Supported Types
-
-### `number`
-
-```typescript
-const value: number = 1284.03;
-```
-
-### `string`
-
-```typescript
-const value: string = "0.5";
-```
-

package/docs/models/components/riskyieldrebalancerequestwidthpct.md

@@ -1,19 +0,0 @@
-# RiskYieldRebalanceRequestWidthPct
-
-Required for `recenter_symmetric_pct`.
-
-
-## Supported Types
-
-### `number`
-
-```typescript
-const value: number = 1284.03;
-```
-
-### `string`
-
-```typescript
-const value: string = "<value>";
-```
-

package/docs/models/components/riskyieldrebalanceresponse.md

@@ -1,32 +0,0 @@
-# RiskYieldRebalanceResponse
-
-## Example Usage
-
-```typescript
-import { RiskYieldRebalanceResponse } from "@compass-labs/api-sdk/models/components";
-
-let value: RiskYieldRebalanceResponse = {
-  action: "<value>",
-  reason: "<value>",
-};
-```
-
-## Fields
-
-| Field                                                                                                                                                                                                                                       | Type                                                                                                                                                                                                                                        | Required                                                                                                                                                                                                                                    | Description                                                                                                                                                                                                                                 |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `action`                                                                                                                                                                                                                                    | *string*                                                                                                                                                                                                                                    | :heavy_check_mark:                                                                                                                                                                                                                          | `NOOP`, `COLLECT_ONLY` or `RECENTER`. `NOOP` is a real answer and often the right one — moving a position realizes its loss and pays for a swap.                                                                                            |
-| `reason`                                                                                                                                                                                                                                    | *string*                                                                                                                                                                                                                                    | :heavy_check_mark:                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                         |
-| `transaction`                                                                                                                                                                                                                               | [components.UnsignedTransaction](../../models/components/unsignedtransaction.md)                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                         |
-| `oldPositionId`                                                                                                                                                                                                                             | *number*                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                         |
-| `oldRange`                                                                                                                                                                                                                                  | [components.ResolvedRange](../../models/components/resolvedrange.md)                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                         |
-| `newRange`                                                                                                                                                                                                                                  | [components.ResolvedRange](../../models/components/resolvedrange.md)                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                         |
-| `liquidityRemoved`                                                                                                                                                                                                                          | *string*                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                         |
-| `amount0Floor`                                                                                                                                                                                                                              | *string*                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                          | What the unwind is guaranteed to return. The new position is sized from this rather than from the quote, because every leg executes in the same transaction and a mint sized from a quote reverts when the decrease comes back a wei short. |
-| `amount1Floor`                                                                                                                                                                                                                              | *string*                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                         |
-| `expectedLiquidityFloor`                                                                                                                                                                                                                    | *string*                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                         |
-| `estimatedDust0`                                                                                                                                                                                                                            | *string*                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                         |
-| `estimatedDust1`                                                                                                                                                                                                                            | *string*                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                         |
-| `phases`                                                                                                                                                                                                                                    | [components.RebalancePhase](../../models/components/rebalancephase.md)[]                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                         |
-| `simulation`                                                                                                                                                                                                                                | [components.Simulation](../../models/components/simulation.md)                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                         |
-| `warnings`                                                                                                                                                                                                                                  | *string*[]                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                         |

package/docs/models/components/riskyieldswaprequest.md

@@ -1,37 +0,0 @@
-# RiskYieldSwapRequest
-
-Swap one token for another from inside the Risk Yield Account.
-
-There is no aggregator on this chain, so the route is a Uniswap v3 pool.
-The API quotes every enabled fee tier and takes whichever returns the most —
-a 1% pool with depth beats a 0.05% pool with none, and here that is the
-common case.
-
-## Example Usage
-
-```typescript
-import { RiskYieldSwapRequest } from "@compass-labs/api-sdk/models/components";
-
-let value: RiskYieldSwapRequest = {
-  owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
-  chain: "robinhood",
-  tokenIn: "USDG",
-  tokenOut: "WETH",
-  amountIn: "100",
-};
-```
-
-## Fields
-
-| Field                                                                                                                                                                       | Type                                                                                                                                                                        | Required                                                                                                                                                                    | Description                                                                                                                                                                 | Example                                                                                                                                                                     |
-| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `owner`                                                                                                                                                                     | *string*                                                                                                                                                                    | :heavy_check_mark:                                                                                                                                                          | The wallet that owns the Risk Yield Account.                                                                                                                                | 0x06A9aF046187895AcFc7258450B15397CAc67400                                                                                                                                  |
-| `chain`                                                                                                                                                                     | [components.RiskYieldSwapRequestChain](../../models/components/riskyieldswaprequestchain.md)                                                                                | :heavy_minus_sign:                                                                                                                                                          | Risk Yield is available on Robinhood Chain only.                                                                                                                            | robinhood                                                                                                                                                                   |
-| `gasSponsorship`                                                                                                                                                            | *boolean*                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                          | Return EIP-712 typed data for the owner to sign instead of a transaction, so a sponsor can broadcast it.                                                                    | false                                                                                                                                                                       |
-| `preview`                                                                                                                                                                   | *boolean*                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                          | Return the plan and its simulation without building a transaction. Nothing is signed and nothing can be broadcast.                                                          | false                                                                                                                                                                       |
-| `slippagePct`                                                                                                                                                               | *components.RiskYieldSwapRequestSlippagePct*                                                                                                                                | :heavy_minus_sign:                                                                                                                                                          | How far the executed amounts may fall short of the quote before the transaction reverts. Memecoin pools move between the quote and the block that includes the transaction. | 0.5                                                                                                                                                                         |
-| `deadlineSeconds`                                                                                                                                                           | *number*                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                          | How long the transaction stays valid once built.                                                                                                                            | 300                                                                                                                                                                         |
-| `tokenIn`                                                                                                                                                                   | *string*                                                                                                                                                                    | :heavy_check_mark:                                                                                                                                                          | What you are spending.                                                                                                                                                      | USDG                                                                                                                                                                        |
-| `tokenOut`                                                                                                                                                                  | *string*                                                                                                                                                                    | :heavy_check_mark:                                                                                                                                                          | What you want.                                                                                                                                                              | WETH                                                                                                                                                                        |
-| `amountIn`                                                                                                                                                                  | *components.RiskYieldSwapRequestAmountIn*                                                                                                                                   | :heavy_check_mark:                                                                                                                                                          | In token units, not wei.                                                                                                                                                    | 100                                                                                                                                                                         |
-| `feePpm`                                                                                                                                                                    | *number*                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                          | Pin the route to one fee tier. Leave unset to let the API pick the tier that returns the most.                                                                              |                                                                                                                                                                             |

package/docs/models/components/riskyieldswaprequestamountin.md

@@ -1,19 +0,0 @@
-# RiskYieldSwapRequestAmountIn
-
-In token units, not wei.
-
-
-## Supported Types
-
-### `number`
-
-```typescript
-const value: number = 1284.03;
-```
-
-### `string`
-
-```typescript
-const value: string = "100";
-```
-