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

package/dist/esm/sdk/riskyield.js

@@ -1,271 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-import { riskYieldRiskYieldCollect } from "../funcs/riskYieldRiskYieldCollect.js";
-import { riskYieldRiskYieldCreateAccount } from "../funcs/riskYieldRiskYieldCreateAccount.js";
-import { riskYieldRiskYieldDecrease } from "../funcs/riskYieldRiskYieldDecrease.js";
-import { riskYieldRiskYieldIncrease } from "../funcs/riskYieldRiskYieldIncrease.js";
-import { riskYieldRiskYieldMint } from "../funcs/riskYieldRiskYieldMint.js";
-import { riskYieldRiskYieldPools } from "../funcs/riskYieldRiskYieldPools.js";
-import { riskYieldRiskYieldPoolsPoolId } from "../funcs/riskYieldRiskYieldPoolsPoolId.js";
-import { riskYieldRiskYieldPositions } from "../funcs/riskYieldRiskYieldPositions.js";
-import { riskYieldRiskYieldRebalance } from "../funcs/riskYieldRiskYieldRebalance.js";
-import { riskYieldRiskYieldRiskScenarios } from "../funcs/riskYieldRiskYieldRiskScenarios.js";
-import { riskYieldRiskYieldSwap } from "../funcs/riskYieldRiskYieldSwap.js";
-import { riskYieldRiskYieldTokens } from "../funcs/riskYieldRiskYieldTokens.js";
-import { riskYieldRiskYieldTransfer } from "../funcs/riskYieldRiskYieldTransfer.js";
-import { ClientSDK } from "../lib/sdks.js";
-import { unwrapAsync } from "../types/fp.js";
-export class RiskYield extends ClientSDK {
-    /**
-     * List tokens
-     *
-     * @remarks
-     * The assets that trade on Robinhood Chain.
-     *
-     * Tokenized stocks carry their issuer metadata, including the corporate-action
-     * multiplier — balances do not rebase on a split, so a quote for the
-     * underlying only becomes a token price once that is applied.
-     *
-     * Memecoins carry the launch they came from. Every price carries the source it
-     * was resolved from and a confidence: below 0.6 it came from a pool shallow
-     * enough that one trade moves it, and every dollar figure derived from it is
-     * indicative.
-     */
-    async riskYieldTokens(request, options) {
-        return unwrapAsync(riskYieldRiskYieldTokens(this, request, options));
-    }
-    /**
-     * List pools
-     *
-     * @remarks
-     * Pools you could provide liquidity to, ranked by what you would keep.
-     *
-     * **Read `lp_earns_fees` first.** The launchpad that dominates this chain
-     * graduates tokens into pools whose hook takes the swap fee, so they trade
-     * enormously and pay an external liquidity provider nothing. Those pools are
-     * listed — they carry the memecoin's price and volume — with a fee APR of
-     * exactly zero and a note saying why. Pass `lp_earns_fees=true` to hide them.
-     *
-     * The default ordering is `il_adjusted_apr_7d`: the fee APR less the expected
-     * impermanent-loss drag from the pair's own volatility. A pool paying 200% on
-     * an asset that moves 400% is not a better position than one paying 20% on an
-     * asset that moves 30%, and sorting on the raw APR would say it was.
-     *
-     * Pools too thin for a rate to mean anything — under 20 swaps a day, or under
-     * $1,000 of liquidity — are served with `ranked: false` and always sort last.
-     */
-    async riskYieldPools(request, options) {
-        return unwrapAsync(riskYieldRiskYieldPools(this, request, options));
-    }
-    /**
-     * Get pool detail
-     *
-     * @remarks
-     * One pool, with its price history and the caveats that apply to it.
-     *
-     * For a pool holding a tokenized stock, `stock_reference` compares the pool's
-     * price against the stock's own. They drift: the pool trades around the clock
-     * while the stock trades in a session, and that gap is what a liquidity
-     * provider is quoting against overnight.
-     */
-    async riskYieldPoolsPoolId(request, options) {
-        return unwrapAsync(riskYieldRiskYieldPoolsPoolId(this, request, options));
-    }
-    /**
-     * List LP positions
-     *
-     * @remarks
-     * Your liquidity positions: what they hold, what they cost, what they paid.
-     *
-     * Only the first of those is on chain. A position reports its liquidity and
-     * its range; it does not report the amounts that opened it or what has already
-     * been collected. Those come from recorded events, and where there are none
-     * `cost_basis.source` is `unavailable` and the PnL fields are null rather than
-     * guessed — an invented cost basis would make every number derived from it
-     * wrong in the same direction.
-     *
-     * `hold_value_usd` is what the deposited amounts would be worth if they had
-     * simply been held. The gap between that and `value_usd` is impermanent loss,
-     * and it is the number that decides whether the fees were worth it.
-     *
-     * `needs_rebalance` and `rebalance_reasons` say what the API would look at, not
-     * what it will do: rebalancing realizes the loss, pays gas twice and a swap,
-     * and puts the position back at risk from a new price.
-     */
-    async riskYieldPositions(request, options) {
-        return unwrapAsync(riskYieldRiskYieldPositions(this, request, options));
-    }
-    /**
-     * Model impermanent loss
-     *
-     * @remarks
-     * What this position would do if the price moved — and how likely that is.
-     *
-     * A fee APR on a memecoin pair means nothing without the loss it is paid
-     * against, which is what this measures.
-     *
-     * Each scenario takes **two** independent moves, and keeping them apart is the
-     * point. `ratio_move_pct` is how far the pair's ratio travels, and that is
-     * what causes impermanent loss. `quote_usd_move_pct` is how far the stock
-     * moves in dollars, which scales what the position is worth without touching
-     * the ratio at all — a stock-only move produces an impermanent loss of exactly
-     * zero. "NVDA drops 10%" and "the memecoin drops 10% against NVDA" are
-     * different questions, and one number cannot ask both.
-     *
-     * The two most useful columns are `breakeven_fee_apr_pct` — what this position
-     * would have to earn for the loss to be worth taking, which you can compare
-     * against the pool's actual fee APR — and `days_of_fees_to_recover_il`, which
-     * is null when the pool pays liquidity providers nothing, because no amount of
-     * time fixes that.
-     *
-     * `probabilistic` runs the pair's own measured volatility through a driftless
-     * simulation. Driftless deliberately: nobody knows which way a memecoin goes,
-     * and a model that assumed one would be predicting returns rather than
-     * measuring risk. It is absent when the pair has no measured volatility —
-     * which a pool with a few hours of history does not — because a distribution
-     * built on zero would report that nothing can happen.
-     */
-    async riskYieldRiskScenarios(request, options) {
-        return unwrapAsync(riskYieldRiskYieldRiskScenarios(this, request, options));
-    }
-    /**
-     * Create account
-     *
-     * @remarks
-     * Create the Risk Yield Account that will hold your LP positions.
-     *
-     * Liquidity is provided from an account, not from your wallet, so this comes
-     * first. The address is deterministic from the `owner`, and it is the **same
-     * account as your Earn Account** on this chain — if you already have one,
-     * this returns it with `transaction: null` and nothing needs to be signed.
-     *
-     * **If the owner pays gas:** set `sender` to the owner's address.
-     *
-     * **If someone else pays:** set `sender` to whoever will broadcast.
-     */
-    async riskYieldCreateAccount(request, options) {
-        return unwrapAsync(riskYieldRiskYieldCreateAccount(this, request, options));
-    }
-    /**
-     * Transfer tokens to/from account
-     *
-     * @remarks
-     * Move tokens between your wallet and your Risk Yield Account.
-     *
-     * `DEPOSIT` pulls from the owner's wallet into the account; `WITHDRAW` sends
-     * them back. Native ETH is supported, which matters here because many pools on
-     * this chain are quoted in it.
-     *
-     * The account is shared with Earn, so a deposit made through either product is
-     * available to both.
-     */
-    async riskYieldTransfer(request, options) {
-        return unwrapAsync(riskYieldRiskYieldTransfer(this, request, options));
-    }
-    /**
-     * Swap tokens
-     *
-     * @remarks
-     * Trade one token for another from inside your Risk Yield Account.
-     *
-     * Mostly used to reach the ratio a range needs before opening a position:
-     * a range fixes the proportion of the two assets, and a caller holding one of
-     * them has to swap to it.
-     *
-     * 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, which here is the common
-     * case rather than the corner one.
-     *
-     * The transaction is simulated before it is returned. A failing simulation is
-     * a 422 rather than something to sign: on this chain a token may tax
-     * transfers, block an address or be paused, and none of that is visible until
-     * the call is actually made.
-     */
-    async riskYieldSwap(request, options) {
-        return unwrapAsync(riskYieldRiskYieldSwap(this, request, options));
-    }
-    /**
-     * Open a position
-     *
-     * @remarks
-     * Provide liquidity to a pool over a price range.
-     *
-     * The range you ask for is not quite the range you get: ticks are discrete, so
-     * a 30% band becomes the usable ticks that bracket it — snapped outward, never
-     * inward, because a position that stops earning sooner than you expected is
-     * the worse surprise. The `range` in the response is what will actually be
-     * opened.
-     *
-     * A range also fixes the proportion of the two assets, so a deposit rarely
-     * uses all of both. What does not fit is reported as `leftover` and stays in
-     * your account rather than being quietly swept.
-     *
-     * Set `preview` to see the plan and its simulation without building anything.
-     */
-    async riskYieldMint(request, options) {
-        return unwrapAsync(riskYieldRiskYieldMint(this, request, options));
-    }
-    /**
-     * Add to a position
-     *
-     * @remarks
-     * Add liquidity to a position you already hold, over its existing range.
-     */
-    async riskYieldIncrease(request, options) {
-        return unwrapAsync(riskYieldRiskYieldIncrease(this, request, options));
-    }
-    /**
-     * Withdraw from a position
-     *
-     * @remarks
-     * Take liquidity back out of a position.
-     *
-     * The collect is bundled in by default and should stay that way:
-     * `decreaseLiquidity` only *credits* the tokens to the position, it does not
-     * move them. Without the collect the position looks emptied while the funds
-     * sit in the position manager.
-     */
-    async riskYieldDecrease(request, options) {
-        return unwrapAsync(riskYieldRiskYieldDecrease(this, request, options));
-    }
-    /**
-     * Collect fees
-     *
-     * @remarks
-     * Sweep the fees a position has earned into your account.
-     */
-    async riskYieldCollect(request, options) {
-        return unwrapAsync(riskYieldRiskYieldCollect(this, request, options));
-    }
-    /**
-     * Rebalance a position
-     *
-     * @remarks
-     * Move a position to a new range, in one transaction.
-     *
-     * **`NOOP` is a real answer and often the right one.** Rebalancing realizes
-     * the impermanent loss the position has taken so far, pays gas twice and a
-     * swap, and puts the position back at risk from a new price. If the position
-     * is already centred at the requested width, that is what you will get.
-     *
-     * When there is something to do, the transaction unwinds the old position,
-     * sweeps it together with the fees, opens the new range and burns the empty
-     * NFT. Every leg is sized from the **floor** the previous one guarantees
-     * rather than from its quote — they execute in the same transaction, and a
-     * mint sized from a quote reverts when the decrease comes back a wei short,
-     * leaving the owner having paid gas to dismantle a position. `estimated_dust`
-     * is what that safety costs.
-     *
-     * The default `vol_scaled` strategy sizes the new range from the pair's own
-     * measured volatility: two standard deviations over the horizon. A range
-     * narrower than the asset's ordinary movement spends most of its life out of
-     * range earning nothing, which is the most common way to lose money doing
-     * this on purpose.
-     */
-    async riskYieldRebalance(request, options) {
-        return unwrapAsync(riskYieldRiskYieldRebalance(this, request, options));
-    }
-}
-//# sourceMappingURL=riskyield.js.map

package/dist/esm/sdk/riskyield.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"riskyield.js","sourceRoot":"","sources":["../../../src/sdk/riskyield.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AAClF,OAAO,EAAE,+BAA+B,EAAE,MAAM,6CAA6C,CAAC;AAC9F,OAAO,EAAE,0BAA0B,EAAE,MAAM,wCAAwC,CAAC;AACpF,OAAO,EAAE,0BAA0B,EAAE,MAAM,wCAAwC,CAAC;AACpF,OAAO,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAC5E,OAAO,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,EAAE,6BAA6B,EAAE,MAAM,2CAA2C,CAAC;AAC1F,OAAO,EAAE,2BAA2B,EAAE,MAAM,yCAAyC,CAAC;AACtF,OAAO,EAAE,2BAA2B,EAAE,MAAM,yCAAyC,CAAC;AACtF,OAAO,EAAE,+BAA+B,EAAE,MAAM,6CAA6C,CAAC;AAC9F,OAAO,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAC5E,OAAO,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AAChF,OAAO,EAAE,0BAA0B,EAAE,MAAM,wCAAwC,CAAC;AACpF,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,SAAU,SAAQ,SAAS;IACtC;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,eAAe,CACnB,OAA4C,EAC5C,OAAwB;QAExB,OAAO,WAAW,CAAC,wBAAwB,CACzC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,cAAc,CAClB,OAA2C,EAC3C,OAAwB;QAExB,OAAO,WAAW,CAAC,uBAAuB,CACxC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,oBAAoB,CACxB,OAAiD,EACjD,OAAwB;QAExB,OAAO,WAAW,CAAC,6BAA6B,CAC9C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,kBAAkB,CACtB,OAA+C,EAC/C,OAAwB;QAExB,OAAO,WAAW,CAAC,2BAA2B,CAC5C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,KAAK,CAAC,sBAAsB,CAC1B,OAAwC,EACxC,OAAwB;QAExB,OAAO,WAAW,CAAC,+BAA+B,CAChD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,sBAAsB,CAC1B,OAAiD,EACjD,OAAwB;QAExB,OAAO,WAAW,CAAC,+BAA+B,CAChD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAA4C,EAC5C,OAAwB;QAExB,OAAO,WAAW,CAAC,0BAA0B,CAC3C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,aAAa,CACjB,OAAwC,EACxC,OAAwB;QAExB,OAAO,WAAW,CAAC,sBAAsB,CACvC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,aAAa,CACjB,OAAwC,EACxC,OAAwB;QAExB,OAAO,WAAW,CAAC,sBAAsB,CACvC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAA4C,EAC5C,OAAwB;QAExB,OAAO,WAAW,CAAC,0BAA0B,CAC3C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAA4C,EAC5C,OAAwB;QAExB,OAAO,WAAW,CAAC,0BAA0B,CAC3C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,gBAAgB,CACpB,OAA2C,EAC3C,OAAwB;QAExB,OAAO,WAAW,CAAC,yBAAyB,CAC1C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,KAAK,CAAC,kBAAkB,CACtB,OAA6C,EAC7C,OAAwB;QAExB,OAAO,WAAW,CAAC,2BAA2B,CAC5C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}

package/docs/models/components/amount0.md

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

package/docs/models/components/amount1.md

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

package/docs/models/components/baseusdmovepct.md

@@ -1,19 +0,0 @@
-# BaseUsdMovePct
-
-How far token0 moves in dollars, independently. Mutually exclusive with `ratio_move_pct`.
-
-
-## Supported Types
-
-### `number`
-
-```typescript
-const value: number = 1284.03;
-```
-
-### `string`
-
-```typescript
-const value: string = "<value>";
-```
-

package/docs/models/components/bothsidesdeposit.md

@@ -1,23 +0,0 @@
-# BothSidesDeposit
-
-Explicit amounts of each token.
-
-## Example Usage
-
-```typescript
-import { BothSidesDeposit } from "@compass-labs/api-sdk/models/components";
-
-let value: BothSidesDeposit = {
-  type: "both",
-  amount0: "<value>",
-  amount1: "<value>",
-};
-```
-
-## Fields
-
-| Field                | Type                 | Required             | Description          | Example              |
-| -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
-| `type`               | *"both"*             | :heavy_check_mark:   | N/A                  | both                 |
-| `amount0`            | *components.Amount0* | :heavy_check_mark:   | N/A                  |                      |
-| `amount1`            | *components.Amount1* | :heavy_check_mark:   | N/A                  |                      |

package/docs/models/components/costbasis.md

@@ -1,28 +0,0 @@
-# CostBasis
-
-What the position cost to open.
-
-Not readable from the chain: a position reports its liquidity, never the
-amounts that bought it. This comes from recorded events, and when there are
-none the PnL fields are null rather than guessed — an invented cost basis
-would make every number derived from it quietly wrong.
-
-## Example Usage
-
-```typescript
-import { CostBasis } from "@compass-labs/api-sdk/models/components";
-
-let value: CostBasis = {
-  source: "onchain_logs",
-};
-```
-
-## Fields
-
-| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
-| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
-| `source`                                                                                      | [components.CostBasisSource](../../models/components/costbasissource.md)                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
-| `amount0`                                                                                     | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `amount1`                                                                                     | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `valueUsd`                                                                                    | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `openedAt`                                                                                    | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |

package/docs/models/components/costbasissource.md

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

package/docs/models/components/createriskyieldaccountrequest.md

@@ -1,23 +0,0 @@
-# CreateRiskYieldAccountRequest
-
-Create the Safe that will hold the owner's LP positions.
-
-## Example Usage
-
-```typescript
-import { CreateRiskYieldAccountRequest } from "@compass-labs/api-sdk/models/components";
-
-let value: CreateRiskYieldAccountRequest = {
-  sender: "0xdB035cb494EEE30996fbDD25a7b1Fa38D795bdC6",
-  owner: "0xdB035cb494EEE30996fbDD25a7b1Fa38D795bdC6",
-};
-```
-
-## Fields
-
-| Field                                                                                                          | Type                                                                                                           | Required                                                                                                       | Description                                                                                                    | Example                                                                                                        |
-| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
-| `sender`                                                                                                       | *string*                                                                                                       | :heavy_check_mark:                                                                                             | The address that signs and broadcasts this transaction.                                                        | 0xdB035cb494EEE30996fbDD25a7b1Fa38D795bdC6                                                                     |
-| `owner`                                                                                                        | *string*                                                                                                       | :heavy_check_mark:                                                                                             | The address that will own and control the Risk Yield Account.                                                  | 0xdB035cb494EEE30996fbDD25a7b1Fa38D795bdC6                                                                     |
-| `chain`                                                                                                        | [components.CreateRiskYieldAccountRequestChain](../../models/components/createriskyieldaccountrequestchain.md) | :heavy_minus_sign:                                                                                             | Risk Yield is available on Robinhood Chain only.                                                               | robinhood                                                                                                      |
-| `estimateGas`                                                                                                  | *boolean*                                                                                                      | :heavy_minus_sign:                                                                                             | Estimate gas, which also proves the transaction can execute.                                                   | true                                                                                                           |

package/docs/models/components/createriskyieldaccountrequestchain.md

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

package/docs/models/components/createriskyieldaccountresponse.md

@@ -1,29 +0,0 @@
-# CreateRiskYieldAccountResponse
-
-## Example Usage
-
-```typescript
-import { CreateRiskYieldAccountResponse } from "@compass-labs/api-sdk/models/components";
-
-let value: CreateRiskYieldAccountResponse = {
-  transaction: {
-    chainId: "<id>",
-    data: "<value>",
-    from: "<value>",
-    gas: "<value>",
-    to: "<value>",
-    value: "<value>",
-    nonce: "<value>",
-    maxFeePerGas: "<value>",
-    maxPriorityFeePerGas: "<value>",
-  },
-  riskYieldAccountAddress: "<value>",
-};
-```
-
-## Fields
-
-| Field                                                                                                                                                                                                                                                                 | Type                                                                                                                                                                                                                                                                  | Required                                                                                                                                                                                                                                                              | Description                                                                                                                                                                                                                                                           |
-| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `transaction`                                                                                                                                                                                                                                                         | [components.UnsignedTransaction](../../models/components/unsignedtransaction.md)                                                                                                                                                                                      | :heavy_check_mark:                                                                                                                                                                                                                                                    | The transaction that deploys the account, or null when it already exists — calling this twice is safe.                                                                                                                                                                |
-| `riskYieldAccountAddress`                                                                                                                                                                                                                                             | *string*                                                                                                                                                                                                                                                              | :heavy_check_mark:                                                                                                                                                                                                                                                    | Where the account is, or will be. Deterministic from the owner, so it is known before the transaction is sent. This is the same address as the owner's Earn Account on this chain: one Safe holds both, and funds moved in through either product are the same funds. |

package/docs/models/components/depositplan.md

@@ -1,34 +0,0 @@
-# DepositPlan
-
-What will actually be deposited, and what is left over.
-
-A range fixes the ratio of the two assets, so a deposit rarely uses all of
-both. The leftovers are reported rather than silently swept: they stay in
-the account, and a caller who expected them to be used should know.
-
-## Example Usage
-
-```typescript
-import { DepositPlan } from "@compass-labs/api-sdk/models/components";
-
-let value: DepositPlan = {
-  amount0Desired: "<value>",
-  amount1Desired: "<value>",
-  amount0Min: "<value>",
-  amount1Min: "<value>",
-  leftover0: "0",
-  leftover1: "0",
-};
-```
-
-## Fields
-
-| Field                                                      | Type                                                       | Required                                                   | Description                                                | Example                                                    |
-| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
-| `amount0Desired`                                           | *string*                                                   | :heavy_check_mark:                                         | N/A                                                        |                                                            |
-| `amount1Desired`                                           | *string*                                                   | :heavy_check_mark:                                         | N/A                                                        |                                                            |
-| `amount0Min`                                               | *string*                                                   | :heavy_check_mark:                                         | The floor the transaction enforces after slippage.         |                                                            |
-| `amount1Min`                                               | *string*                                                   | :heavy_check_mark:                                         | N/A                                                        |                                                            |
-| `leftover0`                                                | *string*                                                   | :heavy_minus_sign:                                         | N/A                                                        | 0                                                          |
-| `leftover1`                                                | *string*                                                   | :heavy_minus_sign:                                         | N/A                                                        | 0                                                          |
-| `swap`                                                     | [components.SwapPlan](../../models/components/swapplan.md) | :heavy_minus_sign:                                         | Present when one asset had to be traded for the other.     |                                                            |

package/docs/models/components/dexpooldetailresponse.md

@@ -1,59 +0,0 @@
-# DexPoolDetailResponse
-
-## Example Usage
-
-```typescript
-import { DexPoolDetailResponse } from "@compass-labs/api-sdk/models/components";
-
-let value: DexPoolDetailResponse = {
-  pool: {
-    poolId: 31641,
-    dexVersion: "V4",
-    poolKey: "<value>",
-    token0: {
-      address: "707 Lesch Meadow",
-      kind: "STOCK",
-    },
-    token1: {
-      address: "96147 King Street",
-      kind: "STOCK",
-    },
-    feePpm: 556358,
-    feePct: "<value>",
-    pairClass: "MEME_STOCK",
-    watched: true,
-    lpOpen: true,
-    lpEarnsFees: false,
-    ranked: true,
-  },
-  liquidityDistribution: [
-    {
-      tickLower: 874443,
-      tickUpper: 352786,
-      liquidity: "<value>",
-      isCurrent: false,
-    },
-  ],
-  hourly: [
-    {
-      hourStart: new Date("2025-10-01T10:34:46.351Z"),
-      swapCount: 0,
-    },
-  ],
-  stockReference: {
-    ticker: "<value>",
-    referenceIsStale: false,
-  },
-};
-```
-
-## Fields
-
-| Field                                                                      | Type                                                                       | Required                                                                   | Description                                                                |
-| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
-| `pool`                                                                     | [components.DexPoolInfo](../../models/components/dexpoolinfo.md)           | :heavy_check_mark:                                                         | N/A                                                                        |
-| `onChain`                                                                  | [components.PoolOnChainState](../../models/components/poolonchainstate.md) | :heavy_minus_sign:                                                         | N/A                                                                        |
-| `liquidityDistribution`                                                    | [components.LiquidityBucket](../../models/components/liquiditybucket.md)[] | :heavy_minus_sign:                                                         | N/A                                                                        |
-| `hourly`                                                                   | [components.PoolHourlyPoint](../../models/components/poolhourlypoint.md)[] | :heavy_minus_sign:                                                         | N/A                                                                        |
-| `stockReference`                                                           | [components.StockReference](../../models/components/stockreference.md)     | :heavy_minus_sign:                                                         | N/A                                                                        |
-| `warnings`                                                                 | *string*[]                                                                 | :heavy_minus_sign:                                                         | Things worth knowing before providing liquidity here.                      |