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

package/src/models/components/riskscenariosrequest.ts

@@ -1,279 +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 { 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

@@ -1,78 +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";
-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`,
-  );
-}

package/src/models/components/riskyieldcollectrequest.ts

@@ -1,139 +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 { ClosedEnum } from "../../types/enums.js";
-import { DexVersion, DexVersion$outboundSchema } from "./dexversion.js";
-
-/**
- * Risk Yield is available on Robinhood Chain only.
- */
-export const RiskYieldCollectRequestChain = {
-  Robinhood: "robinhood",
-} as const;
-/**
- * Risk Yield is available on Robinhood Chain only.
- */
-export type RiskYieldCollectRequestChain = ClosedEnum<
-  typeof RiskYieldCollectRequestChain
->;
-
-/**
- * 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.
- */
-export type RiskYieldCollectRequestSlippagePct = number | string;
-
-/**
- * Sweep the fees a position has earned.
- */
-export type RiskYieldCollectRequest = {
-  /**
-   * The wallet that owns the Risk Yield Account.
-   */
-  owner: string;
-  /**
-   * Risk Yield is available on Robinhood Chain only.
-   */
-  chain?: RiskYieldCollectRequestChain | undefined;
-  /**
-   * Return EIP-712 typed data for the owner to sign instead of a transaction, so a sponsor can broadcast it.
-   */
-  gasSponsorship?: boolean | undefined;
-  /**
-   * Return the plan and its simulation without building a transaction. Nothing is signed and nothing can be broadcast.
-   */
-  preview?: boolean | undefined;
-  /**
-   * 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.
-   */
-  slippagePct?: number | string | undefined;
-  /**
-   * How long the transaction stays valid once built.
-   */
-  deadlineSeconds?: number | undefined;
-  positionId: number;
-  /**
-   * Which Uniswap deployment a pool belongs to.
-   *
-   * @remarks
-   *
-   * v3 pools hold their own tokens and pay LPs the fee tier. v4 pools live in a
-   * shared PoolManager and may route the fee through a hook, which is where the
-   * launchpad pools' zero LP yield comes from.
-   */
-  dexVersion?: DexVersion | undefined;
-  recipient?: string | null | undefined;
-};
-
-/** @internal */
-export const RiskYieldCollectRequestChain$outboundSchema: z.ZodNativeEnum<
-  typeof RiskYieldCollectRequestChain
-> = z.nativeEnum(RiskYieldCollectRequestChain);
-
-/** @internal */
-export type RiskYieldCollectRequestSlippagePct$Outbound = number | string;
-
-/** @internal */
-export const RiskYieldCollectRequestSlippagePct$outboundSchema: z.ZodType<
-  RiskYieldCollectRequestSlippagePct$Outbound,
-  z.ZodTypeDef,
-  RiskYieldCollectRequestSlippagePct
-> = z.union([z.number(), z.string()]);
-
-export function riskYieldCollectRequestSlippagePctToJSON(
-  riskYieldCollectRequestSlippagePct: RiskYieldCollectRequestSlippagePct,
-): string {
-  return JSON.stringify(
-    RiskYieldCollectRequestSlippagePct$outboundSchema.parse(
-      riskYieldCollectRequestSlippagePct,
-    ),
-  );
-}
-
-/** @internal */
-export type RiskYieldCollectRequest$Outbound = {
-  owner: string;
-  chain?: string | undefined;
-  gas_sponsorship?: boolean | undefined;
-  preview?: boolean | undefined;
-  slippage_pct?: number | string | undefined;
-  deadline_seconds?: number | undefined;
-  position_id: number;
-  dex_version?: string | undefined;
-  recipient?: string | null | undefined;
-};
-
-/** @internal */
-export const RiskYieldCollectRequest$outboundSchema: z.ZodType<
-  RiskYieldCollectRequest$Outbound,
-  z.ZodTypeDef,
-  RiskYieldCollectRequest
-> = z.object({
-  owner: z.string(),
-  chain: RiskYieldCollectRequestChain$outboundSchema.optional(),
-  gasSponsorship: z.boolean().optional(),
-  preview: z.boolean().optional(),
-  slippagePct: z.union([z.number(), z.string()]).optional(),
-  deadlineSeconds: z.number().int().optional(),
-  positionId: z.number().int(),
-  dexVersion: DexVersion$outboundSchema.optional(),
-  recipient: z.nullable(z.string()).optional(),
-}).transform((v) => {
-  return remap$(v, {
-    gasSponsorship: "gas_sponsorship",
-    slippagePct: "slippage_pct",
-    deadlineSeconds: "deadline_seconds",
-    positionId: "position_id",
-    dexVersion: "dex_version",
-  });
-});
-
-export function riskYieldCollectRequestToJSON(
-  riskYieldCollectRequest: RiskYieldCollectRequest,
-): string {
-  return JSON.stringify(
-    RiskYieldCollectRequest$outboundSchema.parse(riskYieldCollectRequest),
-  );
-}

package/src/models/components/riskyielddecreaserequest.ts

@@ -1,174 +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 { ClosedEnum } from "../../types/enums.js";
-import { DexVersion, DexVersion$outboundSchema } from "./dexversion.js";
-
-/**
- * Risk Yield is available on Robinhood Chain only.
- */
-export const RiskYieldDecreaseRequestChain = {
-  Robinhood: "robinhood",
-} as const;
-/**
- * Risk Yield is available on Robinhood Chain only.
- */
-export type RiskYieldDecreaseRequestChain = ClosedEnum<
-  typeof RiskYieldDecreaseRequestChain
->;
-
-/**
- * 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.
- */
-export type RiskYieldDecreaseRequestSlippagePct = number | string;
-
-/**
- * How much of the position's liquidity to remove.
- */
-export type Percent = number | string;
-
-/**
- * Take liquidity back out.
- */
-export type RiskYieldDecreaseRequest = {
-  /**
-   * The wallet that owns the Risk Yield Account.
-   */
-  owner: string;
-  /**
-   * Risk Yield is available on Robinhood Chain only.
-   */
-  chain?: RiskYieldDecreaseRequestChain | undefined;
-  /**
-   * Return EIP-712 typed data for the owner to sign instead of a transaction, so a sponsor can broadcast it.
-   */
-  gasSponsorship?: boolean | undefined;
-  /**
-   * Return the plan and its simulation without building a transaction. Nothing is signed and nothing can be broadcast.
-   */
-  preview?: boolean | undefined;
-  /**
-   * 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.
-   */
-  slippagePct?: number | string | undefined;
-  /**
-   * How long the transaction stays valid once built.
-   */
-  deadlineSeconds?: number | undefined;
-  positionId: number;
-  /**
-   * Which Uniswap deployment a pool belongs to.
-   *
-   * @remarks
-   *
-   * v3 pools hold their own tokens and pay LPs the fee tier. v4 pools live in a
-   * shared PoolManager and may route the fee through a hook, which is where the
-   * launchpad pools' zero LP yield comes from.
-   */
-  dexVersion?: DexVersion | undefined;
-  /**
-   * How much of the position's liquidity to remove.
-   */
-  percent?: number | string | undefined;
-  /**
-   * Sweep the withdrawn tokens and any fees in the same transaction. Leave this on: `decreaseLiquidity` only credits tokens, it does not move them, so without a collect nothing reaches your account.
-   */
-  collect?: boolean | undefined;
-  /**
-   * Destroy the NFT once it holds nothing. Frees a little gas.
-   */
-  burnIfEmpty?: boolean | undefined;
-};
-
-/** @internal */
-export const RiskYieldDecreaseRequestChain$outboundSchema: z.ZodNativeEnum<
-  typeof RiskYieldDecreaseRequestChain
-> = z.nativeEnum(RiskYieldDecreaseRequestChain);
-
-/** @internal */
-export type RiskYieldDecreaseRequestSlippagePct$Outbound = number | string;
-
-/** @internal */
-export const RiskYieldDecreaseRequestSlippagePct$outboundSchema: z.ZodType<
-  RiskYieldDecreaseRequestSlippagePct$Outbound,
-  z.ZodTypeDef,
-  RiskYieldDecreaseRequestSlippagePct
-> = z.union([z.number(), z.string()]);
-
-export function riskYieldDecreaseRequestSlippagePctToJSON(
-  riskYieldDecreaseRequestSlippagePct: RiskYieldDecreaseRequestSlippagePct,
-): string {
-  return JSON.stringify(
-    RiskYieldDecreaseRequestSlippagePct$outboundSchema.parse(
-      riskYieldDecreaseRequestSlippagePct,
-    ),
-  );
-}
-
-/** @internal */
-export type Percent$Outbound = number | string;
-
-/** @internal */
-export const Percent$outboundSchema: z.ZodType<
-  Percent$Outbound,
-  z.ZodTypeDef,
-  Percent
-> = z.union([z.number(), z.string()]);
-
-export function percentToJSON(percent: Percent): string {
-  return JSON.stringify(Percent$outboundSchema.parse(percent));
-}
-
-/** @internal */
-export type RiskYieldDecreaseRequest$Outbound = {
-  owner: string;
-  chain?: string | undefined;
-  gas_sponsorship?: boolean | undefined;
-  preview?: boolean | undefined;
-  slippage_pct?: number | string | undefined;
-  deadline_seconds?: number | undefined;
-  position_id: number;
-  dex_version?: string | undefined;
-  percent?: number | string | undefined;
-  collect?: boolean | undefined;
-  burn_if_empty?: boolean | undefined;
-};
-
-/** @internal */
-export const RiskYieldDecreaseRequest$outboundSchema: z.ZodType<
-  RiskYieldDecreaseRequest$Outbound,
-  z.ZodTypeDef,
-  RiskYieldDecreaseRequest
-> = z.object({
-  owner: z.string(),
-  chain: RiskYieldDecreaseRequestChain$outboundSchema.optional(),
-  gasSponsorship: z.boolean().optional(),
-  preview: z.boolean().optional(),
-  slippagePct: z.union([z.number(), z.string()]).optional(),
-  deadlineSeconds: z.number().int().optional(),
-  positionId: z.number().int(),
-  dexVersion: DexVersion$outboundSchema.optional(),
-  percent: z.union([z.number(), z.string()]).optional(),
-  collect: z.boolean().optional(),
-  burnIfEmpty: z.boolean().optional(),
-}).transform((v) => {
-  return remap$(v, {
-    gasSponsorship: "gas_sponsorship",
-    slippagePct: "slippage_pct",
-    deadlineSeconds: "deadline_seconds",
-    positionId: "position_id",
-    dexVersion: "dex_version",
-    burnIfEmpty: "burn_if_empty",
-  });
-});
-
-export function riskYieldDecreaseRequestToJSON(
-  riskYieldDecreaseRequest: RiskYieldDecreaseRequest,
-): string {
-  return JSON.stringify(
-    RiskYieldDecreaseRequest$outboundSchema.parse(riskYieldDecreaseRequest),
-  );
-}