npm - @compass-labs/api-sdk - Versions diffs - 2.2.106 → 2.2.108-rc.0 - Mend

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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (892) hide show

package/docs/models/components/riskyieldswaprequestchain.md DELETED Viewed

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

package/docs/models/components/riskyieldswaprequestslippagepct.md DELETED Viewed

@@ -1,19 +0,0 @@
-# RiskYieldSwapRequestSlippagePct
-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/riskyieldswapresponse.md DELETED Viewed

@@ -1,19 +0,0 @@
-# RiskYieldSwapResponse
-## Example Usage
-```typescript
-import { RiskYieldSwapResponse } from "@compass-labs/api-sdk/models/components";
-let value: RiskYieldSwapResponse = {};
-```
-## Fields
-| Field                                                                                                                                                               | Type                                                                                                                                                                | Required                                                                                                                                                            | Description                                                                                                                                                         |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `transaction`                                                                                                                                                       | [components.UnsignedTransaction](../../models/components/unsignedtransaction.md)                                                                                    | :heavy_minus_sign:                                                                                                                                                  | Null when `preview` was set, or when the plan is a no-op.                                                                                                           |
-| `swap`                                                                                                                                                              | [components.SwapPlan](../../models/components/swapplan.md)                                                                                                          | :heavy_minus_sign:                                                                                                                                                  | N/A                                                                                                                                                                 |
-| `steps`                                                                                                                                                             | [components.PlanStep](../../models/components/planstep.md)[]                                                                                                        | :heavy_minus_sign:                                                                                                                                                  | What the single transaction does, in order.                                                                                                                         |
-| `simulation`                                                                                                                                                        | [components.Simulation](../../models/components/simulation.md)                                                                                                      | :heavy_minus_sign:                                                                                                                                                  | The result of executing this against current state. A failure here is the only warning you get about a token that taxes transfers, blocks an address, or is paused. |
-| `warnings`                                                                                                                                                          | *string*[]                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                  | N/A                                                                                                                                                                 |

package/docs/models/components/riskyieldtransferrequestaction.md DELETED Viewed

@@ -1,17 +0,0 @@
-# RiskYieldTransferRequestAction
-Whether you are depositing to or withdrawing from your earn account.
-## Example Usage
-```typescript
-import { RiskYieldTransferRequestAction } from "@compass-labs/api-sdk/models/components";
-let value: RiskYieldTransferRequestAction = "DEPOSIT";
-```
-## Values
-```typescript
-"DEPOSIT" | "WITHDRAW"
-```

package/docs/models/components/riskyieldtransferrequestamount.md DELETED Viewed

@@ -1,19 +0,0 @@
-# RiskYieldTransferRequestAmount
-The amount of 'token' to transfer.
-## Supported Types
-### `number`
-```typescript
-const value: number = 1284.03;
-```
-### `string`
-```typescript
-const value: string = "10";
-```

package/docs/models/components/riskyieldtransferrequestchain.md DELETED Viewed

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

package/docs/models/components/scenarioinput.md DELETED Viewed

@@ -1,28 +0,0 @@
-# ScenarioInput
-One hypothetical.
-The two moves are deliberately separate. On a meme-against-stock pair the
-ratio between them is what causes impermanent loss, while the stock's own
-dollar move scales the whole position without touching the ratio — so "NVDA
-drops 10%" and "the memecoin drops 10% against NVDA" are different
-questions with different answers, and one number cannot ask both.
-## Example Usage
-```typescript
-import { ScenarioInput } from "@compass-labs/api-sdk/models/components";
-let value: ScenarioInput = {
-  quoteUsdMovePct: "0",
-};
-```
-## Fields
-| Field                                                                                                                                                                  | Type                                                                                                                                                                   | Required                                                                                                                                                               | Description                                                                                                                                                            | Example                                                                                                                                                                |
-| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `name`                                                                                                                                                                 | *string*                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                     | What to call this row.                                                                                                                                                 |                                                                                                                                                                        |
-| `ratioMovePct`                                                                                                                                                         | *components.RatioMovePct*                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                     | How far the pair's ratio moves. This is what drives loss.                                                                                                              |                                                                                                                                                                        |
-| `baseUsdMovePct`                                                                                                                                                       | *components.BaseUsdMovePct*                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                     | How far token0 moves in dollars, independently. Mutually exclusive with `ratio_move_pct`.                                                                              |                                                                                                                                                                        |
-| `quoteUsdMovePct`                                                                                                                                                      | *components.QuoteUsdMovePct*                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                     | How far token1 — the stock, on a meme x stock pair — moves in dollars. On its own this changes what the position is worth without causing any impermanent loss at all. | 0                                                                                                                                                                      |

package/docs/models/components/scenarioresult.md DELETED Viewed

@@ -1,39 +0,0 @@
-# ScenarioResult
-## Example Usage
-```typescript
-import { ScenarioResult } from "@compass-labs/api-sdk/models/components";
-let value: ScenarioResult = {
-  name: "<value>",
-  priceRatio: "<value>",
-  endPrice: "<value>",
-  inRangeAtEnd: true,
-  positionValueUsd: "<value>",
-  holdValueUsd: "<value>",
-  ilUsd: "<value>",
-  ilPct: "<value>",
-  holdPnlUsd: "<value>",
-  expectedFeesUsd: "<value>",
-  netPnlUsd: "<value>",
-};
-```
-## Fields
-| Field                                                                                                                                                      | Type                                                                                                                                                       | Required                                                                                                                                                   | Description                                                                                                                                                |
-| ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `name`                                                                                                                                                     | *string*                                                                                                                                                   | :heavy_check_mark:                                                                                                                                         | N/A                                                                                                                                                        |
-| `priceRatio`                                                                                                                                               | *string*                                                                                                                                                   | :heavy_check_mark:                                                                                                                                         | N/A                                                                                                                                                        |
-| `endPrice`                                                                                                                                                 | *string*                                                                                                                                                   | :heavy_check_mark:                                                                                                                                         | N/A                                                                                                                                                        |
-| `inRangeAtEnd`                                                                                                                                             | *boolean*                                                                                                                                                  | :heavy_check_mark:                                                                                                                                         | N/A                                                                                                                                                        |
-| `positionValueUsd`                                                                                                                                         | *string*                                                                                                                                                   | :heavy_check_mark:                                                                                                                                         | N/A                                                                                                                                                        |
-| `holdValueUsd`                                                                                                                                             | *string*                                                                                                                                                   | :heavy_check_mark:                                                                                                                                         | N/A                                                                                                                                                        |
-| `ilUsd`                                                                                                                                                    | *string*                                                                                                                                                   | :heavy_check_mark:                                                                                                                                         | N/A                                                                                                                                                        |
-| `ilPct`                                                                                                                                                    | *string*                                                                                                                                                   | :heavy_check_mark:                                                                                                                                         | N/A                                                                                                                                                        |
-| `holdPnlUsd`                                                                                                                                               | *string*                                                                                                                                                   | :heavy_check_mark:                                                                                                                                         | N/A                                                                                                                                                        |
-| `expectedFeesUsd`                                                                                                                                          | *string*                                                                                                                                                   | :heavy_check_mark:                                                                                                                                         | N/A                                                                                                                                                        |
-| `netPnlUsd`                                                                                                                                                | *string*                                                                                                                                                   | :heavy_check_mark:                                                                                                                                         | Hold profit, plus the impermanent loss, plus the fees.                                                                                                     |
-| `breakevenFeeAprPct`                                                                                                                                       | *string*                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                         | What this position would have to earn, annualized, for the loss to be worth taking. The number to compare against the pool's actual fee APR.               |
-| `daysOfFeesToRecoverIl`                                                                                                                                    | *string*                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                         | How long the pool's current fee rate would take to earn the loss back. Null when the pool pays liquidity providers nothing, which no amount of time fixes. |

package/docs/models/components/simulation.md DELETED Viewed

@@ -1,25 +0,0 @@
-# Simulation
-The result of executing the transaction against current state.
-Meme tokens on this chain carry transfer taxes, blacklists and pause
-switches, none of which are visible from a pool's parameters. Simulating is
-the only way to find out before the owner signs.
-## Example Usage
-```typescript
-import { Simulation } from "@compass-labs/api-sdk/models/components";
-let value: Simulation = {
-  ok: true,
-};
-```
-## Fields
-| Field              | Type               | Required           | Description        |
-| ------------------ | ------------------ | ------------------ | ------------------ |
-| `ok`               | *boolean*          | :heavy_check_mark: | N/A                |
-| `error`            | *string*           | :heavy_minus_sign: | N/A                |
-| `gasUsed`          | *number*           | :heavy_minus_sign: | N/A                |

package/docs/models/components/singlesideddeposit.md DELETED Viewed

@@ -1,26 +0,0 @@
-# SingleSidedDeposit
-One token, split to fit the range.
-A range needs both assets in a ratio the range itself determines, so this
-asks the API to solve for that ratio and swap the difference.
-## Example Usage
-```typescript
-import { SingleSidedDeposit } from "@compass-labs/api-sdk/models/components";
-let value: SingleSidedDeposit = {
-  type: "single",
-  token: "<value>",
-  amount: "272.85",
-};
-```
-## Fields
-| Field                                 | Type                                  | Required                              | Description                           | Example                               |
-| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- |
-| `type`                                | *"single"*                            | :heavy_check_mark:                    | N/A                                   | single                                |
-| `token`                               | *string*                              | :heavy_check_mark:                    | N/A                                   |                                       |
-| `amount`                              | *components.SingleSidedDepositAmount* | :heavy_check_mark:                    | N/A                                   |                                       |

package/docs/models/components/singlesideddepositamount.md DELETED Viewed

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

package/docs/models/components/stockmetadata.md DELETED Viewed

@@ -1,31 +0,0 @@
-# StockMetadata
-The issuer's side of a tokenized stock.
-`ui_multiplier` is the ERC-8056 corporate-action factor. It matters because
-balances do **not** rebase on a split: the token count stays put and this
-number changes, so a price quoted for the underlying has to be multiplied by
-it to mean anything about the token a pool holds.
-## Example Usage
-```typescript
-import { StockMetadata } from "@compass-labs/api-sdk/models/components";
-let value: StockMetadata = {
-  ticker: "<value>",
-};
-```
-## Fields
-| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
-| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
-| `ticker`                                                                                      | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
-| `uiMultiplier`                                                                                | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `pendingUiMultiplier`                                                                         | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `pendingEffectiveAt`                                                                          | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `chainlinkFeed`                                                                               | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `tokenPaused`                                                                                 | *boolean*                                                                                     | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `status`                                                                                      | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `logoUrl`                                                                                     | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |

package/docs/models/components/stockreference.md DELETED Viewed

@@ -1,31 +0,0 @@
-# StockReference
-The pool price against the stock's own reference price.
-A tokenized stock trades in its pool around the clock while the underlying
-trades in a session. The gap between them is real information — it is what
-an LP is quoting against overnight — and it is not visible from either
-number alone.
-## Example Usage
-```typescript
-import { StockReference } from "@compass-labs/api-sdk/models/components";
-let value: StockReference = {
-  ticker: "<value>",
-  referenceIsStale: false,
-};
-```
-## Fields
-| Field                                                                                                                             | Type                                                                                                                              | Required                                                                                                                          | Description                                                                                                                       | Example                                                                                                                           |
-| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
-| `ticker`                                                                                                                          | *string*                                                                                                                          | :heavy_check_mark:                                                                                                                | N/A                                                                                                                               |                                                                                                                                   |
-| `referencePriceUsd`                                                                                                               | *string*                                                                                                                          | :heavy_minus_sign:                                                                                                                | From the Chainlink feed, multiplier applied.                                                                                      |                                                                                                                                   |
-| `referenceSource`                                                                                                                 | *string*                                                                                                                          | :heavy_minus_sign:                                                                                                                | N/A                                                                                                                               |                                                                                                                                   |
-| `referenceUpdatedAt`                                                                                                              | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                     | :heavy_minus_sign:                                                                                                                | N/A                                                                                                                               |                                                                                                                                   |
-| `poolImpliedPriceUsd`                                                                                                             | *string*                                                                                                                          | :heavy_minus_sign:                                                                                                                | N/A                                                                                                                               |                                                                                                                                   |
-| `premiumPct`                                                                                                                      | *string*                                                                                                                          | :heavy_minus_sign:                                                                                                                | How far above (or below) the reference the pool is trading.                                                                       |                                                                                                                                   |
-| `referenceIsStale`                                                                                                                | *boolean*                                                                                                                         | :heavy_minus_sign:                                                                                                                | True when the feed has not posted for over two heartbeats — normal over a weekend, when the stock is not trading and the pool is. | false                                                                                                                             |

package/docs/models/components/swapplan.md DELETED Viewed

@@ -1,29 +0,0 @@
-# SwapPlan
-The swap leg of an entry or a rebalance.
-## Example Usage
-```typescript
-import { SwapPlan } from "@compass-labs/api-sdk/models/components";
-let value: SwapPlan = {
-  tokenIn: "<value>",
-  tokenOut: "<value>",
-  amountIn: "<value>",
-  amountOutQuoted: "<value>",
-  amountOutMin: "<value>",
-};
-```
-## Fields
-| Field                                               | Type                                                | Required                                            | Description                                         |
-| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
-| `tokenIn`                                           | *string*                                            | :heavy_check_mark:                                  | N/A                                                 |
-| `tokenOut`                                          | *string*                                            | :heavy_check_mark:                                  | N/A                                                 |
-| `amountIn`                                          | *string*                                            | :heavy_check_mark:                                  | N/A                                                 |
-| `amountOutQuoted`                                   | *string*                                            | :heavy_check_mark:                                  | N/A                                                 |
-| `amountOutMin`                                      | *string*                                            | :heavy_check_mark:                                  | The floor the transaction enforces, after slippage. |
-| `priceImpactPct`                                    | *string*                                            | :heavy_minus_sign:                                  | N/A                                                 |
-| `poolFeePpm`                                        | *number*                                            | :heavy_minus_sign:                                  | N/A                                                 |

package/docs/models/components/symmetricrange.md DELETED Viewed

@@ -1,24 +0,0 @@
-# SymmetricRange
-A range centred on the current price, given as a percentage either side.
-The usual way to ask for a position: narrow earns more fees per dollar while
-the price stays inside it, and stops earning entirely when it leaves.
-## Example Usage
-```typescript
-import { SymmetricRange } from "@compass-labs/api-sdk/models/components";
-let value: SymmetricRange = {
-  type: "symmetric_pct",
-  widthPct: "30",
-};
-```
-## Fields
-| Field                                                    | Type                                                     | Required                                                 | Description                                              | Example                                                  |
-| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
-| `type`                                                   | *"symmetric_pct"*                                        | :heavy_check_mark:                                       | N/A                                                      | symmetric_pct                                            |
-| `widthPct`                                               | *components.SymmetricRangeWidthPct*                      | :heavy_check_mark:                                       | Half-width either side of the current price, in percent. |                                                          |

package/docs/models/components/symmetricrangewidthpct.md DELETED Viewed

@@ -1,19 +0,0 @@
-# SymmetricRangeWidthPct
-Half-width either side of the current price, in percent.
-## Supported Types
-### `number`
-```typescript
-const value: number = 1284.03;
-```
-### `string`
-```typescript
-const value: string = "<value>";
-```

package/docs/models/components/tickrange.md DELETED Viewed

@@ -1,23 +0,0 @@
-# TickRange
-Exact tick bounds, for a caller who has already done the maths.
-## Example Usage
-```typescript
-import { TickRange } from "@compass-labs/api-sdk/models/components";
-let value: TickRange = {
-  type: "ticks",
-  tickLower: 494824,
-  tickUpper: 250131,
-};
-```
-## Fields
-| Field              | Type               | Required           | Description        | Example            |
-| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
-| `type`             | *"ticks"*          | :heavy_check_mark: | N/A                | ticks              |
-| `tickLower`        | *number*           | :heavy_check_mark: | N/A                |                    |
-| `tickUpper`        | *number*           | :heavy_check_mark: | N/A                |                    |

package/docs/models/components/usddeposit.md DELETED Viewed

@@ -1,24 +0,0 @@
-# UsdDeposit
-A dollar figure, for analytics only.
-Enough to answer "what would this look like", not enough to build a
-transaction — the API will not choose which of your tokens to spend.
-## Example Usage
-```typescript
-import { UsdDeposit } from "@compass-labs/api-sdk/models/components";
-let value: UsdDeposit = {
-  type: "usd",
-  valueUsd: "1000",
-};
-```
-## Fields
-| Field                 | Type                  | Required              | Description           | Example               |
-| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- |
-| `type`                | *"usd"*               | :heavy_check_mark:    | N/A                   | usd                   |
-| `valueUsd`            | *components.ValueUsd* | :heavy_check_mark:    | N/A                   |                       |

package/docs/models/components/valueusd.md DELETED Viewed

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

package/docs/models/components/voloverridepct.md DELETED Viewed

@@ -1,19 +0,0 @@
-# VolOverridePct
-Assume this annualized volatility instead of the pair's measured one. Needed for a pool too new to have measured any.
-## Supported Types
-### `number`
-```typescript
-const value: number = 1284.03;
-```
-### `string`
-```typescript
-const value: string = "<value>";
-```

package/docs/models/operations/minvolume24husd.md DELETED Viewed

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

package/docs/models/operations/poolhistory.md DELETED Viewed

@@ -1,15 +0,0 @@
-# PoolHistory
-## Example Usage
-```typescript
-import { PoolHistory } from "@compass-labs/api-sdk/models/operations";
-let value: PoolHistory = "7d";
-```
-## Values
-```typescript
-"24h" | "7d" | "30d"
-```

package/docs/models/operations/poolorderby.md DELETED Viewed

@@ -1,15 +0,0 @@
-# PoolOrderBy
-## Example Usage
-```typescript
-import { PoolOrderBy } from "@compass-labs/api-sdk/models/operations";
-let value: PoolOrderBy = "il_adjusted_apr_7d";
-```
-## Values
-```typescript
-"il_adjusted_apr_7d" | "fee_apr_24h" | "fee_apr_7d" | "tvl_usd" | "volume_24h_usd" | "volume_7d_usd" | "realized_vol_24h" | "realized_vol_7d" | "created_at"
-```

package/docs/models/operations/tokenorderby.md DELETED Viewed

@@ -1,15 +0,0 @@
-# TokenOrderBy
-## Example Usage
-```typescript
-import { TokenOrderBy } from "@compass-labs/api-sdk/models/operations";
-let value: TokenOrderBy = "liquidity_usd";
-```
-## Values
-```typescript
-"liquidity_usd" | "volume_24h_usd" | "market_cap_usd" | "price_change_24h_pct" | "created_at"
-```

package/docs/models/operations/v2riskyieldpoolschain.md DELETED Viewed

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

package/docs/models/operations/v2riskyieldpoolsdirection.md DELETED Viewed

@@ -1,15 +0,0 @@
-# V2RiskYieldPoolsDirection
-## Example Usage
-```typescript
-import { V2RiskYieldPoolsDirection } from "@compass-labs/api-sdk/models/operations";
-let value: V2RiskYieldPoolsDirection = "desc";
-```
-## Values
-```typescript
-"asc" | "desc"
-```