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

package/docs/models/components/riskscenariosrequestchain.md

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

package/docs/models/components/riskscenariosrequestdeposit.md

@@ -0,0 +1,34 @@
+# RiskScenariosRequestDeposit
+
+
+## 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/riskscenariosrequestrange.md

@@ -0,0 +1,42 @@
+# RiskScenariosRequestRange
+
+
+## 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/riskscenariosresponse.md

@@ -0,0 +1,39 @@
+# RiskScenariosResponse
+
+## Example Usage
+
+```typescript
+import { RiskScenariosResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: RiskScenariosResponse = {
+  range: {
+    tickLower: 235456,
+    tickUpper: 859949,
+    priceLower: "<value>",
+    priceUpper: "<value>",
+    widthLowerPct: "<value>",
+    widthUpperPct: "<value>",
+    isFullRange: true,
+  },
+  assumptions: {
+    entryPrice: "<value>",
+    depositValueUsd: "<value>",
+    horizonDays: 992181,
+    volSource: "measured",
+    feeSource: "measured",
+    lpEarnsFees: true,
+  },
+  scenarios: [],
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                                                                 | Type                                                                                                                                                                                                                  | Required                                                                                                                                                                                                              | Description                                                                                                                                                                                                           |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `poolId`                                                                                                                                                                                                              | *number*                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                    | N/A                                                                                                                                                                                                                   |
+| `range`                                                                                                                                                                                                               | [components.ResolvedRange](../../models/components/resolvedrange.md)                                                                                                                                                  | :heavy_check_mark:                                                                                                                                                                                                    | A range after the API has snapped it to the pool's tick spacing.<br/><br/>Returned because the range you asked for is rarely the range you get: ticks<br/>are discrete, and a 30% band becomes whichever usable ticks bracket it. |
+| `assumptions`                                                                                                                                                                                                         | [components.RiskAssumptions](../../models/components/riskassumptions.md)                                                                                                                                              | :heavy_check_mark:                                                                                                                                                                                                    | What the answers rest on.<br/><br/>Returned in full because every number below is only as good as these, and a<br/>caller who disagrees with one can override it and ask again.                                       |
+| `scenarios`                                                                                                                                                                                                           | [components.ScenarioResult](../../models/components/scenarioresult.md)[]                                                                                                                                              | :heavy_check_mark:                                                                                                                                                                                                    | N/A                                                                                                                                                                                                                   |
+| `probabilistic`                                                                                                                                                                                                       | [components.ProbabilisticOutlook](../../models/components/probabilisticoutlook.md)                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                    | Absent when the pair's volatility cannot be measured — a pool with a few hours of history has no measurable volatility, and a distribution built on zero would report that nothing can happen.                        |
+| `warnings`                                                                                                                                                                                                            | *string*[]                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                    | N/A                                                                                                                                                                                                                   |

package/docs/models/components/riskyieldcollectrequest.md

@@ -0,0 +1,29 @@
+# RiskYieldCollectRequest
+
+Sweep the fees a position has earned.
+
+## Example Usage
+
+```typescript
+import { RiskYieldCollectRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: RiskYieldCollectRequest = {
+  owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
+  chain: "robinhood",
+  positionId: 1076416,
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                                                                                           | Type                                                                                                                                                                                                                                            | Required                                                                                                                                                                                                                                        | Description                                                                                                                                                                                                                                     | Example                                                                                                                                                                                                                                         |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `owner`                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                                                                              | The wallet that owns the Risk Yield Account.                                                                                                                                                                                                    | 0x06A9aF046187895AcFc7258450B15397CAc67400                                                                                                                                                                                                      |
+| `chain`                                                                                                                                                                                                                                         | [components.RiskYieldCollectRequestChain](../../models/components/riskyieldcollectrequestchain.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.RiskYieldCollectRequestSlippagePct*                                                                                                                                                                                                 | :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. |                                                                                                                                                                                                                                                 |
+| `recipient`                                                                                                                                                                                                                                     | *string*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                             |                                                                                                                                                                                                                                                 |

package/docs/models/components/riskyieldcollectrequestchain.md

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

package/docs/models/components/riskyieldcollectrequestslippagepct.md

@@ -0,0 +1,19 @@
+# RiskYieldCollectRequestSlippagePct
+
+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/riskyielddecreaserequest.md

@@ -0,0 +1,32 @@
+# RiskYieldDecreaseRequest
+
+Take liquidity back out.
+
+## Example Usage
+
+```typescript
+import { RiskYieldDecreaseRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: RiskYieldDecreaseRequest = {
+  owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
+  chain: "robinhood",
+  positionId: 1076416,
+  percent: "100",
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                                                                                           | Type                                                                                                                                                                                                                                            | Required                                                                                                                                                                                                                                        | Description                                                                                                                                                                                                                                     | Example                                                                                                                                                                                                                                         |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `owner`                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                                                                              | The wallet that owns the Risk Yield Account.                                                                                                                                                                                                    | 0x06A9aF046187895AcFc7258450B15397CAc67400                                                                                                                                                                                                      |
+| `chain`                                                                                                                                                                                                                                         | [components.RiskYieldDecreaseRequestChain](../../models/components/riskyielddecreaserequestchain.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.RiskYieldDecreaseRequestSlippagePct*                                                                                                                                                                                                | :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. |                                                                                                                                                                                                                                                 |
+| `percent`                                                                                                                                                                                                                                       | *components.Percent*                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                              | How much of the position's liquidity to remove.                                                                                                                                                                                                 | 100                                                                                                                                                                                                                                             |
+| `collect`                                                                                                                                                                                                                                       | *boolean*                                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                              | Sweep the withdrawn tokens and any fees in the same transaction. Leave this on: `decreaseLiquidity` only credits tokens, it does not move them, so without a collect nothing reaches your account.                                              | true                                                                                                                                                                                                                                            |
+| `burnIfEmpty`                                                                                                                                                                                                                                   | *boolean*                                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                              | Destroy the NFT once it holds nothing. Frees a little gas.                                                                                                                                                                                      | false                                                                                                                                                                                                                                           |

package/docs/models/components/riskyielddecreaserequestchain.md

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

package/docs/models/components/riskyielddecreaserequestslippagepct.md

@@ -0,0 +1,19 @@
+# RiskYieldDecreaseRequestSlippagePct
+
+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/riskyieldincreaserequest.md

@@ -0,0 +1,34 @@
+# RiskYieldIncreaseRequest
+
+Add to a position you already hold.
+
+## Example Usage
+
+```typescript
+import { RiskYieldIncreaseRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: RiskYieldIncreaseRequest = {
+  owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
+  chain: "robinhood",
+  positionId: 1076416,
+  deposit: {
+    type: "both",
+    amount0: "50",
+    amount1: "0.02",
+  },
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                                                                                           | Type                                                                                                                                                                                                                                            | Required                                                                                                                                                                                                                                        | Description                                                                                                                                                                                                                                     | Example                                                                                                                                                                                                                                         |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `owner`                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                                                                              | The wallet that owns the Risk Yield Account.                                                                                                                                                                                                    | 0x06A9aF046187895AcFc7258450B15397CAc67400                                                                                                                                                                                                      |
+| `chain`                                                                                                                                                                                                                                         | [components.RiskYieldIncreaseRequestChain](../../models/components/riskyieldincreaserequestchain.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.RiskYieldIncreaseRequestSlippagePct*                                                                                                                                                                                                | :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:                                                                                                                                                                                                                              | The position NFT's id.                                                                                                                                                                                                                          | 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. |                                                                                                                                                                                                                                                 |
+| `deposit`                                                                                                                                                                                                                                       | *components.RiskYieldIncreaseRequestDeposit*                                                                                                                                                                                                    | :heavy_check_mark:                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                             | {<br/>"amount0": "50",<br/>"amount1": "0.02",<br/>"type": "both"<br/>}                                                                                                                                                                          |

package/docs/models/components/riskyieldincreaserequestchain.md

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

package/docs/models/components/riskyieldincreaserequestdeposit.md

@@ -0,0 +1,34 @@
+# 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

@@ -0,0 +1,19 @@
+# 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

@@ -0,0 +1,36 @@
+# 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

@@ -0,0 +1,41 @@
+# 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

@@ -0,0 +1,17 @@
+# 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"
+```