@compass-labs/api-sdk 2.2.105 → 2.2.106

package/src/models/components/probabilisticoutlook.ts

@@ -0,0 +1,70 @@
+/*
+ * 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";
+
+/**
+ * How likely the outcomes are, not just how large.
+ */
+export type ProbabilisticOutlook = {
+  method: string;
+  paths: number;
+  /**
+   * The chance the price *touches* a bound at any point, not just ends outside it. A position that left the range and came back still stopped earning while it was out.
+   */
+  pExitWithinHorizonPct: string;
+  pOutAtHorizonPct: string;
+  expectedTimeInRangePct: string;
+  expectedIlUsd: string;
+  expectedNetPnlUsd: string;
+  probNetLossPct: string;
+  ilPctPercentiles: { [k: string]: string };
+  ilUsdPercentiles: { [k: string]: string };
+  netPnlUsdPercentiles: { [k: string]: string };
+};
+
+/** @internal */
+export const ProbabilisticOutlook$inboundSchema: z.ZodType<
+  ProbabilisticOutlook,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  method: z.string(),
+  paths: z.number().int(),
+  p_exit_within_horizon_pct: z.string(),
+  p_out_at_horizon_pct: z.string(),
+  expected_time_in_range_pct: z.string(),
+  expected_il_usd: z.string(),
+  expected_net_pnl_usd: z.string(),
+  prob_net_loss_pct: z.string(),
+  il_pct_percentiles: z.record(z.string()),
+  il_usd_percentiles: z.record(z.string()),
+  net_pnl_usd_percentiles: z.record(z.string()),
+}).transform((v) => {
+  return remap$(v, {
+    "p_exit_within_horizon_pct": "pExitWithinHorizonPct",
+    "p_out_at_horizon_pct": "pOutAtHorizonPct",
+    "expected_time_in_range_pct": "expectedTimeInRangePct",
+    "expected_il_usd": "expectedIlUsd",
+    "expected_net_pnl_usd": "expectedNetPnlUsd",
+    "prob_net_loss_pct": "probNetLossPct",
+    "il_pct_percentiles": "ilPctPercentiles",
+    "il_usd_percentiles": "ilUsdPercentiles",
+    "net_pnl_usd_percentiles": "netPnlUsdPercentiles",
+  });
+});
+
+export function probabilisticOutlookFromJSON(
+  jsonString: string,
+): SafeParseResult<ProbabilisticOutlook, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProbabilisticOutlook$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProbabilisticOutlook' from JSON`,
+  );
+}

package/src/models/components/rebalancephase.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { PlanStep, PlanStep$inboundSchema } from "./planstep.js";
+
+/**
+ * One stage of the plan, with the legs it contributes.
+ */
+export type RebalancePhase = {
+  name: string;
+  description: string;
+  steps?: Array<PlanStep> | undefined;
+};
+
+/** @internal */
+export const RebalancePhase$inboundSchema: z.ZodType<
+  RebalancePhase,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  description: z.string(),
+  steps: z.array(PlanStep$inboundSchema).optional(),
+});
+
+export function rebalancePhaseFromJSON(
+  jsonString: string,
+): SafeParseResult<RebalancePhase, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RebalancePhase$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RebalancePhase' from JSON`,
+  );
+}

package/src/models/components/rebalancereason.ts

@@ -0,0 +1,21 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const RebalanceReason = {
+  OutOfRange: "OUT_OF_RANGE",
+  PriceDrift: "PRICE_DRIFT",
+  VolRegimeChange: "VOL_REGIME_CHANGE",
+  UncollectedFees: "UNCOLLECTED_FEES",
+  FeesNotEarned: "FEES_NOT_EARNED",
+  StaleData: "STALE_DATA",
+} as const;
+export type RebalanceReason = ClosedEnum<typeof RebalanceReason>;
+
+/** @internal */
+export const RebalanceReason$inboundSchema: z.ZodNativeEnum<
+  typeof RebalanceReason
+> = z.nativeEnum(RebalanceReason);

package/src/models/components/rebalancestrategy.ts

@@ -0,0 +1,24 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * How to choose the new range.
+ */
+export const RebalanceStrategy = {
+  RecenterSymmetricPct: "recenter_symmetric_pct",
+  VolScaled: "vol_scaled",
+  Manual: "manual",
+} as const;
+/**
+ * How to choose the new range.
+ */
+export type RebalanceStrategy = ClosedEnum<typeof RebalanceStrategy>;
+
+/** @internal */
+export const RebalanceStrategy$outboundSchema: z.ZodNativeEnum<
+  typeof RebalanceStrategy
+> = z.nativeEnum(RebalanceStrategy);

package/src/models/components/resolvedrange.ts

@@ -0,0 +1,65 @@
+/*
+ * 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";
+
+/**
+ * A range after the API has snapped it to the pool's tick spacing.
+ *
+ * @remarks
+ *
+ * Returned because the range you asked for is rarely the range you get: ticks
+ * are discrete, and a 30% band becomes whichever usable ticks bracket it.
+ */
+export type ResolvedRange = {
+  tickLower: number;
+  tickUpper: number;
+  priceLower: string;
+  priceUpper: string;
+  /**
+   * How far below the current price the lower bound sits.
+   */
+  widthLowerPct: string;
+  widthUpperPct: string;
+  isFullRange: boolean;
+};
+
+/** @internal */
+export const ResolvedRange$inboundSchema: z.ZodType<
+  ResolvedRange,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  tick_lower: z.number().int(),
+  tick_upper: z.number().int(),
+  price_lower: z.string(),
+  price_upper: z.string(),
+  width_lower_pct: z.string(),
+  width_upper_pct: z.string(),
+  is_full_range: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    "tick_lower": "tickLower",
+    "tick_upper": "tickUpper",
+    "price_lower": "priceLower",
+    "price_upper": "priceUpper",
+    "width_lower_pct": "widthLowerPct",
+    "width_upper_pct": "widthUpperPct",
+    "is_full_range": "isFullRange",
+  });
+});
+
+export function resolvedRangeFromJSON(
+  jsonString: string,
+): SafeParseResult<ResolvedRange, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ResolvedRange$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResolvedRange' from JSON`,
+  );
+}

package/src/models/components/riskassumptions.ts

@@ -0,0 +1,91 @@
+/*
+ * 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";
+
+/**
+ * What the answers rest on.
+ *
+ * @remarks
+ *
+ * Returned in full because every number below is only as good as these, and a
+ * caller who disagrees with one can override it and ask again.
+ */
+export type RiskAssumptions = {
+  entryPrice: string;
+  price0Usd?: string | null | undefined;
+  price1Usd?: string | null | undefined;
+  priceSource0?: string | null | undefined;
+  priceSource1?: string | null | undefined;
+  pricesUpdatedAt?: Date | null | undefined;
+  depositValueUsd: string;
+  horizonDays: number;
+  annualVolPct?: string | null | undefined;
+  /**
+   * `measured`, `override`, or `unavailable`.
+   */
+  volSource?: string | undefined;
+  feeAprPct?: string | null | undefined;
+  feeSource?: string | undefined;
+  feesPerDayUsdPool?: string | null | undefined;
+  shareOfActiveLiquidityPct?: string | null | undefined;
+  lpEarnsFees?: boolean | undefined;
+};
+
+/** @internal */
+export const RiskAssumptions$inboundSchema: z.ZodType<
+  RiskAssumptions,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  entry_price: z.string(),
+  price0_usd: z.nullable(z.string()).optional(),
+  price1_usd: z.nullable(z.string()).optional(),
+  price_source0: z.nullable(z.string()).optional(),
+  price_source1: z.nullable(z.string()).optional(),
+  prices_updated_at: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+  deposit_value_usd: z.string(),
+  horizon_days: z.number().int(),
+  annual_vol_pct: z.nullable(z.string()).optional(),
+  vol_source: z.string().optional(),
+  fee_apr_pct: z.nullable(z.string()).optional(),
+  fee_source: z.string().optional(),
+  fees_per_day_usd_pool: z.nullable(z.string()).optional(),
+  share_of_active_liquidity_pct: z.nullable(z.string()).optional(),
+  lp_earns_fees: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "entry_price": "entryPrice",
+    "price0_usd": "price0Usd",
+    "price1_usd": "price1Usd",
+    "price_source0": "priceSource0",
+    "price_source1": "priceSource1",
+    "prices_updated_at": "pricesUpdatedAt",
+    "deposit_value_usd": "depositValueUsd",
+    "horizon_days": "horizonDays",
+    "annual_vol_pct": "annualVolPct",
+    "vol_source": "volSource",
+    "fee_apr_pct": "feeAprPct",
+    "fee_source": "feeSource",
+    "fees_per_day_usd_pool": "feesPerDayUsdPool",
+    "share_of_active_liquidity_pct": "shareOfActiveLiquidityPct",
+    "lp_earns_fees": "lpEarnsFees",
+  });
+});
+
+export function riskAssumptionsFromJSON(
+  jsonString: string,
+): SafeParseResult<RiskAssumptions, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RiskAssumptions$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RiskAssumptions' from JSON`,
+  );
+}

package/src/models/components/riskscenariosrequest.ts

@@ -0,0 +1,279 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import {
+  BothSidesDeposit,
+  BothSidesDeposit$Outbound,
+  BothSidesDeposit$outboundSchema,
+} from "./bothsidesdeposit.js";
+import {
+  FullRange,
+  FullRange$Outbound,
+  FullRange$outboundSchema,
+} from "./fullrange.js";
+import {
+  PoolSelector,
+  PoolSelector$Outbound,
+  PoolSelector$outboundSchema,
+} from "./poolselector.js";
+import {
+  PriceRange,
+  PriceRange$Outbound,
+  PriceRange$outboundSchema,
+} from "./pricerange.js";
+import {
+  ScenarioInput,
+  ScenarioInput$Outbound,
+  ScenarioInput$outboundSchema,
+} from "./scenarioinput.js";
+import {
+  SingleSidedDeposit,
+  SingleSidedDeposit$Outbound,
+  SingleSidedDeposit$outboundSchema,
+} from "./singlesideddeposit.js";
+import {
+  SymmetricRange,
+  SymmetricRange$Outbound,
+  SymmetricRange$outboundSchema,
+} from "./symmetricrange.js";
+import {
+  TickRange,
+  TickRange$Outbound,
+  TickRange$outboundSchema,
+} from "./tickrange.js";
+import {
+  UsdDeposit,
+  UsdDeposit$Outbound,
+  UsdDeposit$outboundSchema,
+} from "./usddeposit.js";
+
+export const RiskScenariosRequestChain = {
+  Robinhood: "robinhood",
+} as const;
+export type RiskScenariosRequestChain = ClosedEnum<
+  typeof RiskScenariosRequestChain
+>;
+
+export type RiskScenariosRequestRange =
+  | FullRange
+  | PriceRange
+  | SymmetricRange
+  | TickRange;
+
+export type RiskScenariosRequestDeposit =
+  | BothSidesDeposit
+  | SingleSidedDeposit
+  | UsdDeposit;
+
+/**
+ * Assume this fee rate instead of the pool's measured one.
+ */
+export type FeeAprPctOverride = number | string;
+
+/**
+ * Assume this annualized volatility instead of the pair's measured one. Needed for a pool too new to have measured any.
+ */
+export type VolOverridePct = number | string;
+
+/**
+ * Ask what a position would do under a set of hypotheticals.
+ */
+export type RiskScenariosRequest = {
+  chain?: RiskScenariosRequestChain | undefined;
+  /**
+   * Which pool, by id or by its key.
+   *
+   * @remarks
+   *
+   * A pool id is stable and is what the list endpoints return. The long form
+   * exists so a caller who knows the pair can address a pool without a lookup —
+   * on a chain minting twenty thousand pools a day, a client should not have to
+   * search for one it just created.
+   */
+  pool: PoolSelector;
+  range: FullRange | PriceRange | SymmetricRange | TickRange;
+  deposit: BothSidesDeposit | SingleSidedDeposit | UsdDeposit;
+  horizonDays?: number | undefined;
+  /**
+   * Leave empty for a default spread of moves.
+   */
+  scenarios?: Array<ScenarioInput> | undefined;
+  /**
+   * Assume this fee rate instead of the pool's measured one.
+   */
+  feeAprPctOverride?: number | string | null | undefined;
+  /**
+   * Assume this annualized volatility instead of the pair's measured one. Needed for a pool too new to have measured any.
+   */
+  volOverridePct?: number | string | null | undefined;
+  /**
+   * Also estimate how likely each outcome is, not just its size.
+   */
+  monteCarlo?: boolean | undefined;
+  nPaths?: number | undefined;
+  /**
+   * Fixed so the same request gives the same answer.
+   */
+  seed?: number | undefined;
+};
+
+/** @internal */
+export const RiskScenariosRequestChain$outboundSchema: z.ZodNativeEnum<
+  typeof RiskScenariosRequestChain
+> = z.nativeEnum(RiskScenariosRequestChain);
+
+/** @internal */
+export type RiskScenariosRequestRange$Outbound =
+  | FullRange$Outbound
+  | PriceRange$Outbound
+  | SymmetricRange$Outbound
+  | TickRange$Outbound;
+
+/** @internal */
+export const RiskScenariosRequestRange$outboundSchema: z.ZodType<
+  RiskScenariosRequestRange$Outbound,
+  z.ZodTypeDef,
+  RiskScenariosRequestRange
+> = z.union([
+  FullRange$outboundSchema,
+  PriceRange$outboundSchema,
+  SymmetricRange$outboundSchema,
+  TickRange$outboundSchema,
+]);
+
+export function riskScenariosRequestRangeToJSON(
+  riskScenariosRequestRange: RiskScenariosRequestRange,
+): string {
+  return JSON.stringify(
+    RiskScenariosRequestRange$outboundSchema.parse(riskScenariosRequestRange),
+  );
+}
+
+/** @internal */
+export type RiskScenariosRequestDeposit$Outbound =
+  | BothSidesDeposit$Outbound
+  | SingleSidedDeposit$Outbound
+  | UsdDeposit$Outbound;
+
+/** @internal */
+export const RiskScenariosRequestDeposit$outboundSchema: z.ZodType<
+  RiskScenariosRequestDeposit$Outbound,
+  z.ZodTypeDef,
+  RiskScenariosRequestDeposit
+> = z.union([
+  BothSidesDeposit$outboundSchema,
+  SingleSidedDeposit$outboundSchema,
+  UsdDeposit$outboundSchema,
+]);
+
+export function riskScenariosRequestDepositToJSON(
+  riskScenariosRequestDeposit: RiskScenariosRequestDeposit,
+): string {
+  return JSON.stringify(
+    RiskScenariosRequestDeposit$outboundSchema.parse(
+      riskScenariosRequestDeposit,
+    ),
+  );
+}
+
+/** @internal */
+export type FeeAprPctOverride$Outbound = number | string;
+
+/** @internal */
+export const FeeAprPctOverride$outboundSchema: z.ZodType<
+  FeeAprPctOverride$Outbound,
+  z.ZodTypeDef,
+  FeeAprPctOverride
+> = z.union([z.number(), z.string()]);
+
+export function feeAprPctOverrideToJSON(
+  feeAprPctOverride: FeeAprPctOverride,
+): string {
+  return JSON.stringify(
+    FeeAprPctOverride$outboundSchema.parse(feeAprPctOverride),
+  );
+}
+
+/** @internal */
+export type VolOverridePct$Outbound = number | string;
+
+/** @internal */
+export const VolOverridePct$outboundSchema: z.ZodType<
+  VolOverridePct$Outbound,
+  z.ZodTypeDef,
+  VolOverridePct
+> = z.union([z.number(), z.string()]);
+
+export function volOverridePctToJSON(volOverridePct: VolOverridePct): string {
+  return JSON.stringify(VolOverridePct$outboundSchema.parse(volOverridePct));
+}
+
+/** @internal */
+export type RiskScenariosRequest$Outbound = {
+  chain?: string | undefined;
+  pool: PoolSelector$Outbound;
+  range:
+    | FullRange$Outbound
+    | PriceRange$Outbound
+    | SymmetricRange$Outbound
+    | TickRange$Outbound;
+  deposit:
+    | BothSidesDeposit$Outbound
+    | SingleSidedDeposit$Outbound
+    | UsdDeposit$Outbound;
+  horizon_days?: number | undefined;
+  scenarios?: Array<ScenarioInput$Outbound> | undefined;
+  fee_apr_pct_override?: number | string | null | undefined;
+  vol_override_pct?: number | string | null | undefined;
+  monte_carlo?: boolean | undefined;
+  n_paths?: number | undefined;
+  seed?: number | undefined;
+};
+
+/** @internal */
+export const RiskScenariosRequest$outboundSchema: z.ZodType<
+  RiskScenariosRequest$Outbound,
+  z.ZodTypeDef,
+  RiskScenariosRequest
+> = z.object({
+  chain: RiskScenariosRequestChain$outboundSchema.optional(),
+  pool: PoolSelector$outboundSchema,
+  range: z.union([
+    FullRange$outboundSchema,
+    PriceRange$outboundSchema,
+    SymmetricRange$outboundSchema,
+    TickRange$outboundSchema,
+  ]),
+  deposit: z.union([
+    BothSidesDeposit$outboundSchema,
+    SingleSidedDeposit$outboundSchema,
+    UsdDeposit$outboundSchema,
+  ]),
+  horizonDays: z.number().int().optional(),
+  scenarios: z.array(ScenarioInput$outboundSchema).optional(),
+  feeAprPctOverride: z.nullable(z.union([z.number(), z.string()])).optional(),
+  volOverridePct: z.nullable(z.union([z.number(), z.string()])).optional(),
+  monteCarlo: z.boolean().optional(),
+  nPaths: z.number().int().optional(),
+  seed: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    horizonDays: "horizon_days",
+    feeAprPctOverride: "fee_apr_pct_override",
+    volOverridePct: "vol_override_pct",
+    monteCarlo: "monte_carlo",
+    nPaths: "n_paths",
+  });
+});
+
+export function riskScenariosRequestToJSON(
+  riskScenariosRequest: RiskScenariosRequest,
+): string {
+  return JSON.stringify(
+    RiskScenariosRequest$outboundSchema.parse(riskScenariosRequest),
+  );
+}

package/src/models/components/riskscenariosresponse.ts

@@ -0,0 +1,78 @@
+/*
+ * 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";
+import {
+  ProbabilisticOutlook,
+  ProbabilisticOutlook$inboundSchema,
+} from "./probabilisticoutlook.js";
+import { ResolvedRange, ResolvedRange$inboundSchema } from "./resolvedrange.js";
+import {
+  RiskAssumptions,
+  RiskAssumptions$inboundSchema,
+} from "./riskassumptions.js";
+import {
+  ScenarioResult,
+  ScenarioResult$inboundSchema,
+} from "./scenarioresult.js";
+
+export type RiskScenariosResponse = {
+  poolId?: number | null | undefined;
+  /**
+   * A range after the API has snapped it to the pool's tick spacing.
+   *
+   * @remarks
+   *
+   * Returned because the range you asked for is rarely the range you get: ticks
+   * are discrete, and a 30% band becomes whichever usable ticks bracket it.
+   */
+  range: ResolvedRange;
+  /**
+   * What the answers rest on.
+   *
+   * @remarks
+   *
+   * Returned in full because every number below is only as good as these, and a
+   * caller who disagrees with one can override it and ask again.
+   */
+  assumptions: RiskAssumptions;
+  scenarios: Array<ScenarioResult>;
+  /**
+   * Absent when the pair's volatility cannot be measured — a pool with a few hours of history has no measurable volatility, and a distribution built on zero would report that nothing can happen.
+   */
+  probabilistic?: ProbabilisticOutlook | null | undefined;
+  warnings?: Array<string> | undefined;
+};
+
+/** @internal */
+export const RiskScenariosResponse$inboundSchema: z.ZodType<
+  RiskScenariosResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  pool_id: z.nullable(z.number().int()).optional(),
+  range: ResolvedRange$inboundSchema,
+  assumptions: RiskAssumptions$inboundSchema,
+  scenarios: z.array(ScenarioResult$inboundSchema),
+  probabilistic: z.nullable(ProbabilisticOutlook$inboundSchema).optional(),
+  warnings: z.array(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "pool_id": "poolId",
+  });
+});
+
+export function riskScenariosResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<RiskScenariosResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RiskScenariosResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RiskScenariosResponse' from JSON`,
+  );
+}