@compass-labs/api-sdk 2.2.106 → 2.2.107

package/src/models/components/scenarioinput.ts

@@ -1,125 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod/v3";
-import { remap as remap$ } from "../../lib/primitives.js";
-
-/**
- * How far the pair's ratio moves. This is what drives loss.
- */
-export type RatioMovePct = number | string;
-
-/**
- * How far token0 moves in dollars, independently. Mutually exclusive with `ratio_move_pct`.
- */
-export type BaseUsdMovePct = number | string;
-
-/**
- * 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.
- */
-export type QuoteUsdMovePct = number | string;
-
-/**
- * One hypothetical.
- *
- * @remarks
- *
- * 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.
- */
-export type ScenarioInput = {
-  /**
-   * What to call this row.
-   */
-  name?: string | null | undefined;
-  /**
-   * How far the pair's ratio moves. This is what drives loss.
-   */
-  ratioMovePct?: number | string | null | undefined;
-  /**
-   * How far token0 moves in dollars, independently. Mutually exclusive with `ratio_move_pct`.
-   */
-  baseUsdMovePct?: number | string | null | undefined;
-  /**
-   * 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.
-   */
-  quoteUsdMovePct?: number | string | undefined;
-};
-
-/** @internal */
-export type RatioMovePct$Outbound = number | string;
-
-/** @internal */
-export const RatioMovePct$outboundSchema: z.ZodType<
-  RatioMovePct$Outbound,
-  z.ZodTypeDef,
-  RatioMovePct
-> = z.union([z.number(), z.string()]);
-
-export function ratioMovePctToJSON(ratioMovePct: RatioMovePct): string {
-  return JSON.stringify(RatioMovePct$outboundSchema.parse(ratioMovePct));
-}
-
-/** @internal */
-export type BaseUsdMovePct$Outbound = number | string;
-
-/** @internal */
-export const BaseUsdMovePct$outboundSchema: z.ZodType<
-  BaseUsdMovePct$Outbound,
-  z.ZodTypeDef,
-  BaseUsdMovePct
-> = z.union([z.number(), z.string()]);
-
-export function baseUsdMovePctToJSON(baseUsdMovePct: BaseUsdMovePct): string {
-  return JSON.stringify(BaseUsdMovePct$outboundSchema.parse(baseUsdMovePct));
-}
-
-/** @internal */
-export type QuoteUsdMovePct$Outbound = number | string;
-
-/** @internal */
-export const QuoteUsdMovePct$outboundSchema: z.ZodType<
-  QuoteUsdMovePct$Outbound,
-  z.ZodTypeDef,
-  QuoteUsdMovePct
-> = z.union([z.number(), z.string()]);
-
-export function quoteUsdMovePctToJSON(
-  quoteUsdMovePct: QuoteUsdMovePct,
-): string {
-  return JSON.stringify(QuoteUsdMovePct$outboundSchema.parse(quoteUsdMovePct));
-}
-
-/** @internal */
-export type ScenarioInput$Outbound = {
-  name?: string | null | undefined;
-  ratio_move_pct?: number | string | null | undefined;
-  base_usd_move_pct?: number | string | null | undefined;
-  quote_usd_move_pct?: number | string | undefined;
-};
-
-/** @internal */
-export const ScenarioInput$outboundSchema: z.ZodType<
-  ScenarioInput$Outbound,
-  z.ZodTypeDef,
-  ScenarioInput
-> = z.object({
-  name: z.nullable(z.string()).optional(),
-  ratioMovePct: z.nullable(z.union([z.number(), z.string()])).optional(),
-  baseUsdMovePct: z.nullable(z.union([z.number(), z.string()])).optional(),
-  quoteUsdMovePct: z.union([z.number(), z.string()]).optional(),
-}).transform((v) => {
-  return remap$(v, {
-    ratioMovePct: "ratio_move_pct",
-    baseUsdMovePct: "base_usd_move_pct",
-    quoteUsdMovePct: "quote_usd_move_pct",
-  });
-});
-
-export function scenarioInputToJSON(scenarioInput: ScenarioInput): string {
-  return JSON.stringify(ScenarioInput$outboundSchema.parse(scenarioInput));
-}

package/src/models/components/scenarioresult.ts

@@ -1,80 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod/v3";
-import { remap as remap$ } from "../../lib/primitives.js";
-import { safeParse } from "../../lib/schemas.js";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-
-export type ScenarioResult = {
-  name: string;
-  priceRatio: string;
-  endPrice: string;
-  inRangeAtEnd: boolean;
-  positionValueUsd: string;
-  holdValueUsd: string;
-  ilUsd: string;
-  ilPct: string;
-  holdPnlUsd: string;
-  expectedFeesUsd: string;
-  /**
-   * Hold profit, plus the impermanent loss, plus the fees.
-   */
-  netPnlUsd: string;
-  /**
-   * 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.
-   */
-  breakevenFeeAprPct?: string | null | undefined;
-  /**
-   * 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.
-   */
-  daysOfFeesToRecoverIl?: string | null | undefined;
-};
-
-/** @internal */
-export const ScenarioResult$inboundSchema: z.ZodType<
-  ScenarioResult,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  name: z.string(),
-  price_ratio: z.string(),
-  end_price: z.string(),
-  in_range_at_end: z.boolean(),
-  position_value_usd: z.string(),
-  hold_value_usd: z.string(),
-  il_usd: z.string(),
-  il_pct: z.string(),
-  hold_pnl_usd: z.string(),
-  expected_fees_usd: z.string(),
-  net_pnl_usd: z.string(),
-  breakeven_fee_apr_pct: z.nullable(z.string()).optional(),
-  days_of_fees_to_recover_il: z.nullable(z.string()).optional(),
-}).transform((v) => {
-  return remap$(v, {
-    "price_ratio": "priceRatio",
-    "end_price": "endPrice",
-    "in_range_at_end": "inRangeAtEnd",
-    "position_value_usd": "positionValueUsd",
-    "hold_value_usd": "holdValueUsd",
-    "il_usd": "ilUsd",
-    "il_pct": "ilPct",
-    "hold_pnl_usd": "holdPnlUsd",
-    "expected_fees_usd": "expectedFeesUsd",
-    "net_pnl_usd": "netPnlUsd",
-    "breakeven_fee_apr_pct": "breakevenFeeAprPct",
-    "days_of_fees_to_recover_il": "daysOfFeesToRecoverIl",
-  });
-});
-
-export function scenarioResultFromJSON(
-  jsonString: string,
-): SafeParseResult<ScenarioResult, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => ScenarioResult$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'ScenarioResult' from JSON`,
-  );
-}

package/src/models/components/simulation.ts

@@ -1,49 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod/v3";
-import { remap as remap$ } from "../../lib/primitives.js";
-import { safeParse } from "../../lib/schemas.js";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-
-/**
- * The result of executing the transaction against current state.
- *
- * @remarks
- *
- * 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.
- */
-export type Simulation = {
-  ok: boolean;
-  error?: string | null | undefined;
-  gasUsed?: number | null | undefined;
-};
-
-/** @internal */
-export const Simulation$inboundSchema: z.ZodType<
-  Simulation,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  ok: z.boolean(),
-  error: z.nullable(z.string()).optional(),
-  gas_used: z.nullable(z.number().int()).optional(),
-}).transform((v) => {
-  return remap$(v, {
-    "gas_used": "gasUsed",
-  });
-});
-
-export function simulationFromJSON(
-  jsonString: string,
-): SafeParseResult<Simulation, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => Simulation$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Simulation' from JSON`,
-  );
-}

package/src/models/components/singlesideddeposit.ts

@@ -1,65 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod/v3";
-
-export type SingleSidedDepositAmount = number | string;
-
-/**
- * One token, split to fit the range.
- *
- * @remarks
- *
- * 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.
- */
-export type SingleSidedDeposit = {
-  type: "single";
-  token: string;
-  amount: number | string;
-};
-
-/** @internal */
-export type SingleSidedDepositAmount$Outbound = number | string;
-
-/** @internal */
-export const SingleSidedDepositAmount$outboundSchema: z.ZodType<
-  SingleSidedDepositAmount$Outbound,
-  z.ZodTypeDef,
-  SingleSidedDepositAmount
-> = z.union([z.number(), z.string()]);
-
-export function singleSidedDepositAmountToJSON(
-  singleSidedDepositAmount: SingleSidedDepositAmount,
-): string {
-  return JSON.stringify(
-    SingleSidedDepositAmount$outboundSchema.parse(singleSidedDepositAmount),
-  );
-}
-
-/** @internal */
-export type SingleSidedDeposit$Outbound = {
-  type: "single";
-  token: string;
-  amount: number | string;
-};
-
-/** @internal */
-export const SingleSidedDeposit$outboundSchema: z.ZodType<
-  SingleSidedDeposit$Outbound,
-  z.ZodTypeDef,
-  SingleSidedDeposit
-> = z.object({
-  type: z.literal("single"),
-  token: z.string(),
-  amount: z.union([z.number(), z.string()]),
-});
-
-export function singleSidedDepositToJSON(
-  singleSidedDeposit: SingleSidedDeposit,
-): string {
-  return JSON.stringify(
-    SingleSidedDeposit$outboundSchema.parse(singleSidedDeposit),
-  );
-}

package/src/models/components/stockmetadata.ts

@@ -1,67 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod/v3";
-import { remap as remap$ } from "../../lib/primitives.js";
-import { safeParse } from "../../lib/schemas.js";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-
-/**
- * The issuer's side of a tokenized stock.
- *
- * @remarks
- *
- * `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.
- */
-export type StockMetadata = {
-  ticker: string;
-  uiMultiplier?: string | null | undefined;
-  pendingUiMultiplier?: string | null | undefined;
-  pendingEffectiveAt?: Date | null | undefined;
-  chainlinkFeed?: string | null | undefined;
-  tokenPaused?: boolean | null | undefined;
-  status?: string | null | undefined;
-  logoUrl?: string | null | undefined;
-};
-
-/** @internal */
-export const StockMetadata$inboundSchema: z.ZodType<
-  StockMetadata,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  ticker: z.string(),
-  ui_multiplier: z.nullable(z.string()).optional(),
-  pending_ui_multiplier: z.nullable(z.string()).optional(),
-  pending_effective_at: z.nullable(
-    z.string().datetime({ offset: true }).transform(v => new Date(v)),
-  ).optional(),
-  chainlink_feed: z.nullable(z.string()).optional(),
-  token_paused: z.nullable(z.boolean()).optional(),
-  status: z.nullable(z.string()).optional(),
-  logo_url: z.nullable(z.string()).optional(),
-}).transform((v) => {
-  return remap$(v, {
-    "ui_multiplier": "uiMultiplier",
-    "pending_ui_multiplier": "pendingUiMultiplier",
-    "pending_effective_at": "pendingEffectiveAt",
-    "chainlink_feed": "chainlinkFeed",
-    "token_paused": "tokenPaused",
-    "logo_url": "logoUrl",
-  });
-});
-
-export function stockMetadataFromJSON(
-  jsonString: string,
-): SafeParseResult<StockMetadata, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => StockMetadata$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'StockMetadata' from JSON`,
-  );
-}

package/src/models/components/stockreference.ts

@@ -1,74 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod/v3";
-import { remap as remap$ } from "../../lib/primitives.js";
-import { safeParse } from "../../lib/schemas.js";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-
-/**
- * The pool price against the stock's own reference price.
- *
- * @remarks
- *
- * 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.
- */
-export type StockReference = {
-  ticker: string;
-  /**
-   * From the Chainlink feed, multiplier applied.
-   */
-  referencePriceUsd?: string | null | undefined;
-  referenceSource?: string | null | undefined;
-  referenceUpdatedAt?: Date | null | undefined;
-  poolImpliedPriceUsd?: string | null | undefined;
-  /**
-   * How far above (or below) the reference the pool is trading.
-   */
-  premiumPct?: string | null | undefined;
-  /**
-   * 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.
-   */
-  referenceIsStale?: boolean | undefined;
-};
-
-/** @internal */
-export const StockReference$inboundSchema: z.ZodType<
-  StockReference,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  ticker: z.string(),
-  reference_price_usd: z.nullable(z.string()).optional(),
-  reference_source: z.nullable(z.string()).optional(),
-  reference_updated_at: z.nullable(
-    z.string().datetime({ offset: true }).transform(v => new Date(v)),
-  ).optional(),
-  pool_implied_price_usd: z.nullable(z.string()).optional(),
-  premium_pct: z.nullable(z.string()).optional(),
-  reference_is_stale: z.boolean().optional(),
-}).transform((v) => {
-  return remap$(v, {
-    "reference_price_usd": "referencePriceUsd",
-    "reference_source": "referenceSource",
-    "reference_updated_at": "referenceUpdatedAt",
-    "pool_implied_price_usd": "poolImpliedPriceUsd",
-    "premium_pct": "premiumPct",
-    "reference_is_stale": "referenceIsStale",
-  });
-});
-
-export function stockReferenceFromJSON(
-  jsonString: string,
-): SafeParseResult<StockReference, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => StockReference$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'StockReference' from JSON`,
-  );
-}

package/src/models/components/swapplan.ts

@@ -1,60 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod/v3";
-import { remap as remap$ } from "../../lib/primitives.js";
-import { safeParse } from "../../lib/schemas.js";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-
-/**
- * The swap leg of an entry or a rebalance.
- */
-export type SwapPlan = {
-  tokenIn: string;
-  tokenOut: string;
-  amountIn: string;
-  amountOutQuoted: string;
-  /**
-   * The floor the transaction enforces, after slippage.
-   */
-  amountOutMin: string;
-  priceImpactPct?: string | null | undefined;
-  poolFeePpm?: number | null | undefined;
-};
-
-/** @internal */
-export const SwapPlan$inboundSchema: z.ZodType<
-  SwapPlan,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  token_in: z.string(),
-  token_out: z.string(),
-  amount_in: z.string(),
-  amount_out_quoted: z.string(),
-  amount_out_min: z.string(),
-  price_impact_pct: z.nullable(z.string()).optional(),
-  pool_fee_ppm: z.nullable(z.number().int()).optional(),
-}).transform((v) => {
-  return remap$(v, {
-    "token_in": "tokenIn",
-    "token_out": "tokenOut",
-    "amount_in": "amountIn",
-    "amount_out_quoted": "amountOutQuoted",
-    "amount_out_min": "amountOutMin",
-    "price_impact_pct": "priceImpactPct",
-    "pool_fee_ppm": "poolFeePpm",
-  });
-});
-
-export function swapPlanFromJSON(
-  jsonString: string,
-): SafeParseResult<SwapPlan, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => SwapPlan$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'SwapPlan' from JSON`,
-  );
-}

package/src/models/components/symmetricrange.ts

@@ -1,69 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod/v3";
-import { remap as remap$ } from "../../lib/primitives.js";
-
-/**
- * Half-width either side of the current price, in percent.
- */
-export type SymmetricRangeWidthPct = number | string;
-
-/**
- * A range centred on the current price, given as a percentage either side.
- *
- * @remarks
- *
- * 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.
- */
-export type SymmetricRange = {
-  type: "symmetric_pct";
-  /**
-   * Half-width either side of the current price, in percent.
-   */
-  widthPct: number | string;
-};
-
-/** @internal */
-export type SymmetricRangeWidthPct$Outbound = number | string;
-
-/** @internal */
-export const SymmetricRangeWidthPct$outboundSchema: z.ZodType<
-  SymmetricRangeWidthPct$Outbound,
-  z.ZodTypeDef,
-  SymmetricRangeWidthPct
-> = z.union([z.number(), z.string()]);
-
-export function symmetricRangeWidthPctToJSON(
-  symmetricRangeWidthPct: SymmetricRangeWidthPct,
-): string {
-  return JSON.stringify(
-    SymmetricRangeWidthPct$outboundSchema.parse(symmetricRangeWidthPct),
-  );
-}
-
-/** @internal */
-export type SymmetricRange$Outbound = {
-  type: "symmetric_pct";
-  width_pct: number | string;
-};
-
-/** @internal */
-export const SymmetricRange$outboundSchema: z.ZodType<
-  SymmetricRange$Outbound,
-  z.ZodTypeDef,
-  SymmetricRange
-> = z.object({
-  type: z.literal("symmetric_pct"),
-  widthPct: z.union([z.number(), z.string()]),
-}).transform((v) => {
-  return remap$(v, {
-    widthPct: "width_pct",
-  });
-});
-
-export function symmetricRangeToJSON(symmetricRange: SymmetricRange): string {
-  return JSON.stringify(SymmetricRange$outboundSchema.parse(symmetricRange));
-}

package/src/models/components/tickrange.ts

@@ -1,42 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod/v3";
-import { remap as remap$ } from "../../lib/primitives.js";
-
-/**
- * Exact tick bounds, for a caller who has already done the maths.
- */
-export type TickRange = {
-  type: "ticks";
-  tickLower: number;
-  tickUpper: number;
-};
-
-/** @internal */
-export type TickRange$Outbound = {
-  type: "ticks";
-  tick_lower: number;
-  tick_upper: number;
-};
-
-/** @internal */
-export const TickRange$outboundSchema: z.ZodType<
-  TickRange$Outbound,
-  z.ZodTypeDef,
-  TickRange
-> = z.object({
-  type: z.literal("ticks"),
-  tickLower: z.number().int(),
-  tickUpper: z.number().int(),
-}).transform((v) => {
-  return remap$(v, {
-    tickLower: "tick_lower",
-    tickUpper: "tick_upper",
-  });
-});
-
-export function tickRangeToJSON(tickRange: TickRange): string {
-  return JSON.stringify(TickRange$outboundSchema.parse(tickRange));
-}

package/src/models/components/usddeposit.ts

@@ -1,59 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod/v3";
-import { remap as remap$ } from "../../lib/primitives.js";
-
-export type ValueUsd = number | string;
-
-/**
- * A dollar figure, for analytics only.
- *
- * @remarks
- *
- * 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.
- */
-export type UsdDeposit = {
-  type: "usd";
-  valueUsd: number | string;
-};
-
-/** @internal */
-export type ValueUsd$Outbound = number | string;
-
-/** @internal */
-export const ValueUsd$outboundSchema: z.ZodType<
-  ValueUsd$Outbound,
-  z.ZodTypeDef,
-  ValueUsd
-> = z.union([z.number(), z.string()]);
-
-export function valueUsdToJSON(valueUsd: ValueUsd): string {
-  return JSON.stringify(ValueUsd$outboundSchema.parse(valueUsd));
-}
-
-/** @internal */
-export type UsdDeposit$Outbound = {
-  type: "usd";
-  value_usd: number | string;
-};
-
-/** @internal */
-export const UsdDeposit$outboundSchema: z.ZodType<
-  UsdDeposit$Outbound,
-  z.ZodTypeDef,
-  UsdDeposit
-> = z.object({
-  type: z.literal("usd"),
-  valueUsd: z.union([z.number(), z.string()]),
-}).transform((v) => {
-  return remap$(v, {
-    valueUsd: "value_usd",
-  });
-});
-
-export function usdDepositToJSON(usdDeposit: UsdDeposit): string {
-  return JSON.stringify(UsdDeposit$outboundSchema.parse(usdDeposit));
-}