@compass-labs/api-sdk 2.2.105 → 2.2.106

package/src/models/components/riskyieldmintrequest.ts

@@ -0,0 +1,264 @@
+/*
+ * 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 {
+  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";
+
+/**
+ * Risk Yield is available on Robinhood Chain only.
+ */
+export const RiskYieldMintRequestChain = {
+  Robinhood: "robinhood",
+} as const;
+/**
+ * Risk Yield is available on Robinhood Chain only.
+ */
+export type RiskYieldMintRequestChain = ClosedEnum<
+  typeof RiskYieldMintRequestChain
+>;
+
+/**
+ * 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 RiskYieldMintRequestSlippagePct = number | string;
+
+export type RiskYieldMintRequestRange =
+  | FullRange
+  | PriceRange
+  | SymmetricRange
+  | TickRange;
+
+export type RiskYieldMintRequestDeposit =
+  | BothSidesDeposit
+  | SingleSidedDeposit
+  | UsdDeposit;
+
+/**
+ * Open a new position.
+ */
+export type RiskYieldMintRequest = {
+  /**
+   * The wallet that owns the Risk Yield Account.
+   */
+  owner: string;
+  /**
+   * Risk Yield is available on Robinhood Chain only.
+   */
+  chain?: RiskYieldMintRequestChain | 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;
+  /**
+   * 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;
+  /**
+   * Who receives the position NFT. Defaults to the Risk Yield Account, which is what makes it manageable through this API.
+   */
+  recipient?: string | null | undefined;
+};
+
+/** @internal */
+export const RiskYieldMintRequestChain$outboundSchema: z.ZodNativeEnum<
+  typeof RiskYieldMintRequestChain
+> = z.nativeEnum(RiskYieldMintRequestChain);
+
+/** @internal */
+export type RiskYieldMintRequestSlippagePct$Outbound = number | string;
+
+/** @internal */
+export const RiskYieldMintRequestSlippagePct$outboundSchema: z.ZodType<
+  RiskYieldMintRequestSlippagePct$Outbound,
+  z.ZodTypeDef,
+  RiskYieldMintRequestSlippagePct
+> = z.union([z.number(), z.string()]);
+
+export function riskYieldMintRequestSlippagePctToJSON(
+  riskYieldMintRequestSlippagePct: RiskYieldMintRequestSlippagePct,
+): string {
+  return JSON.stringify(
+    RiskYieldMintRequestSlippagePct$outboundSchema.parse(
+      riskYieldMintRequestSlippagePct,
+    ),
+  );
+}
+
+/** @internal */
+export type RiskYieldMintRequestRange$Outbound =
+  | FullRange$Outbound
+  | PriceRange$Outbound
+  | SymmetricRange$Outbound
+  | TickRange$Outbound;
+
+/** @internal */
+export const RiskYieldMintRequestRange$outboundSchema: z.ZodType<
+  RiskYieldMintRequestRange$Outbound,
+  z.ZodTypeDef,
+  RiskYieldMintRequestRange
+> = z.union([
+  FullRange$outboundSchema,
+  PriceRange$outboundSchema,
+  SymmetricRange$outboundSchema,
+  TickRange$outboundSchema,
+]);
+
+export function riskYieldMintRequestRangeToJSON(
+  riskYieldMintRequestRange: RiskYieldMintRequestRange,
+): string {
+  return JSON.stringify(
+    RiskYieldMintRequestRange$outboundSchema.parse(riskYieldMintRequestRange),
+  );
+}
+
+/** @internal */
+export type RiskYieldMintRequestDeposit$Outbound =
+  | BothSidesDeposit$Outbound
+  | SingleSidedDeposit$Outbound
+  | UsdDeposit$Outbound;
+
+/** @internal */
+export const RiskYieldMintRequestDeposit$outboundSchema: z.ZodType<
+  RiskYieldMintRequestDeposit$Outbound,
+  z.ZodTypeDef,
+  RiskYieldMintRequestDeposit
+> = z.union([
+  BothSidesDeposit$outboundSchema,
+  SingleSidedDeposit$outboundSchema,
+  UsdDeposit$outboundSchema,
+]);
+
+export function riskYieldMintRequestDepositToJSON(
+  riskYieldMintRequestDeposit: RiskYieldMintRequestDeposit,
+): string {
+  return JSON.stringify(
+    RiskYieldMintRequestDeposit$outboundSchema.parse(
+      riskYieldMintRequestDeposit,
+    ),
+  );
+}
+
+/** @internal */
+export type RiskYieldMintRequest$Outbound = {
+  owner: string;
+  chain?: string | undefined;
+  gas_sponsorship?: boolean | undefined;
+  preview?: boolean | undefined;
+  slippage_pct?: number | string | undefined;
+  deadline_seconds?: number | undefined;
+  pool: PoolSelector$Outbound;
+  range:
+    | FullRange$Outbound
+    | PriceRange$Outbound
+    | SymmetricRange$Outbound
+    | TickRange$Outbound;
+  deposit:
+    | BothSidesDeposit$Outbound
+    | SingleSidedDeposit$Outbound
+    | UsdDeposit$Outbound;
+  recipient?: string | null | undefined;
+};
+
+/** @internal */
+export const RiskYieldMintRequest$outboundSchema: z.ZodType<
+  RiskYieldMintRequest$Outbound,
+  z.ZodTypeDef,
+  RiskYieldMintRequest
+> = z.object({
+  owner: z.string(),
+  chain: RiskYieldMintRequestChain$outboundSchema.optional(),
+  gasSponsorship: z.boolean().optional(),
+  preview: z.boolean().optional(),
+  slippagePct: z.union([z.number(), z.string()]).optional(),
+  deadlineSeconds: z.number().int().optional(),
+  pool: PoolSelector$outboundSchema,
+  range: z.union([
+    FullRange$outboundSchema,
+    PriceRange$outboundSchema,
+    SymmetricRange$outboundSchema,
+    TickRange$outboundSchema,
+  ]),
+  deposit: z.union([
+    BothSidesDeposit$outboundSchema,
+    SingleSidedDeposit$outboundSchema,
+    UsdDeposit$outboundSchema,
+  ]),
+  recipient: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    gasSponsorship: "gas_sponsorship",
+    slippagePct: "slippage_pct",
+    deadlineSeconds: "deadline_seconds",
+  });
+});
+
+export function riskYieldMintRequestToJSON(
+  riskYieldMintRequest: RiskYieldMintRequest,
+): string {
+  return JSON.stringify(
+    RiskYieldMintRequest$outboundSchema.parse(riskYieldMintRequest),
+  );
+}

package/src/models/components/riskyieldpositionsresponse.ts

@@ -0,0 +1,52 @@
+/*
+ * 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 { LpPosition, LpPosition$inboundSchema } from "./lpposition.js";
+
+export type RiskYieldPositionsResponse = {
+  account: string;
+  positions: Array<LpPosition>;
+  totalValueUsd?: string | null | undefined;
+  totalUnclaimedFeesUsd?: string | null | undefined;
+  totalPnlUsd?: string | null | undefined;
+  pricesUpdatedAt?: Date | null | undefined;
+};
+
+/** @internal */
+export const RiskYieldPositionsResponse$inboundSchema: z.ZodType<
+  RiskYieldPositionsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  account: z.string(),
+  positions: z.array(LpPosition$inboundSchema),
+  total_value_usd: z.nullable(z.string()).optional(),
+  total_unclaimed_fees_usd: z.nullable(z.string()).optional(),
+  total_pnl_usd: z.nullable(z.string()).optional(),
+  prices_updated_at: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "total_value_usd": "totalValueUsd",
+    "total_unclaimed_fees_usd": "totalUnclaimedFeesUsd",
+    "total_pnl_usd": "totalPnlUsd",
+    "prices_updated_at": "pricesUpdatedAt",
+  });
+});
+
+export function riskYieldPositionsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<RiskYieldPositionsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RiskYieldPositionsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RiskYieldPositionsResponse' from JSON`,
+  );
+}

package/src/models/components/riskyieldrebalancerequest.ts

@@ -0,0 +1,212 @@
+/*
+ * 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";
+import {
+  RebalanceStrategy,
+  RebalanceStrategy$outboundSchema,
+} from "./rebalancestrategy.js";
+
+/**
+ * Risk Yield is available on Robinhood Chain only.
+ */
+export const RiskYieldRebalanceRequestChain = {
+  Robinhood: "robinhood",
+} as const;
+/**
+ * Risk Yield is available on Robinhood Chain only.
+ */
+export type RiskYieldRebalanceRequestChain = ClosedEnum<
+  typeof RiskYieldRebalanceRequestChain
+>;
+
+/**
+ * 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 RiskYieldRebalanceRequestSlippagePct = number | string;
+
+/**
+ * Required for `recenter_symmetric_pct`.
+ */
+export type RiskYieldRebalanceRequestWidthPct = number | string;
+
+/**
+ * Move a position to a new range.
+ *
+ * @remarks
+ *
+ * Rebalancing is not free: it realizes the impermanent loss taken so far, pays
+ * gas twice and a swap, and puts the position back at risk from a new price.
+ * The API will answer `NOOP` when it thinks the move is not worth making.
+ */
+export type RiskYieldRebalanceRequest = {
+  /**
+   * The wallet that owns the Risk Yield Account.
+   */
+  owner: string;
+  /**
+   * Risk Yield is available on Robinhood Chain only.
+   */
+  chain?: RiskYieldRebalanceRequestChain | 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 to choose the new range.
+   */
+  strategy?: RebalanceStrategy | undefined;
+  /**
+   * Required for `recenter_symmetric_pct`.
+   */
+  widthPct?: number | string | null | undefined;
+  /**
+   * For `vol_scaled`: how long the range should survive an ordinary move. A range narrower than the asset's usual movement spends most of its life out of range earning nothing.
+   */
+  horizonDays?: number | undefined;
+  /**
+   * For `manual`.
+   */
+  tickLower?: number | null | undefined;
+  /**
+   * For `manual`.
+   */
+  tickUpper?: number | null | undefined;
+  /**
+   * Destroy the emptied NFT once it is unwound.
+   */
+  burnOld?: boolean | undefined;
+};
+
+/** @internal */
+export const RiskYieldRebalanceRequestChain$outboundSchema: z.ZodNativeEnum<
+  typeof RiskYieldRebalanceRequestChain
+> = z.nativeEnum(RiskYieldRebalanceRequestChain);
+
+/** @internal */
+export type RiskYieldRebalanceRequestSlippagePct$Outbound = number | string;
+
+/** @internal */
+export const RiskYieldRebalanceRequestSlippagePct$outboundSchema: z.ZodType<
+  RiskYieldRebalanceRequestSlippagePct$Outbound,
+  z.ZodTypeDef,
+  RiskYieldRebalanceRequestSlippagePct
+> = z.union([z.number(), z.string()]);
+
+export function riskYieldRebalanceRequestSlippagePctToJSON(
+  riskYieldRebalanceRequestSlippagePct: RiskYieldRebalanceRequestSlippagePct,
+): string {
+  return JSON.stringify(
+    RiskYieldRebalanceRequestSlippagePct$outboundSchema.parse(
+      riskYieldRebalanceRequestSlippagePct,
+    ),
+  );
+}
+
+/** @internal */
+export type RiskYieldRebalanceRequestWidthPct$Outbound = number | string;
+
+/** @internal */
+export const RiskYieldRebalanceRequestWidthPct$outboundSchema: z.ZodType<
+  RiskYieldRebalanceRequestWidthPct$Outbound,
+  z.ZodTypeDef,
+  RiskYieldRebalanceRequestWidthPct
+> = z.union([z.number(), z.string()]);
+
+export function riskYieldRebalanceRequestWidthPctToJSON(
+  riskYieldRebalanceRequestWidthPct: RiskYieldRebalanceRequestWidthPct,
+): string {
+  return JSON.stringify(
+    RiskYieldRebalanceRequestWidthPct$outboundSchema.parse(
+      riskYieldRebalanceRequestWidthPct,
+    ),
+  );
+}
+
+/** @internal */
+export type RiskYieldRebalanceRequest$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;
+  strategy?: string | undefined;
+  width_pct?: number | string | null | undefined;
+  horizon_days?: number | undefined;
+  tick_lower?: number | null | undefined;
+  tick_upper?: number | null | undefined;
+  burn_old?: boolean | undefined;
+};
+
+/** @internal */
+export const RiskYieldRebalanceRequest$outboundSchema: z.ZodType<
+  RiskYieldRebalanceRequest$Outbound,
+  z.ZodTypeDef,
+  RiskYieldRebalanceRequest
+> = z.object({
+  owner: z.string(),
+  chain: RiskYieldRebalanceRequestChain$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(),
+  strategy: RebalanceStrategy$outboundSchema.optional(),
+  widthPct: z.nullable(z.union([z.number(), z.string()])).optional(),
+  horizonDays: z.number().int().optional(),
+  tickLower: z.nullable(z.number().int()).optional(),
+  tickUpper: z.nullable(z.number().int()).optional(),
+  burnOld: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    gasSponsorship: "gas_sponsorship",
+    slippagePct: "slippage_pct",
+    deadlineSeconds: "deadline_seconds",
+    positionId: "position_id",
+    dexVersion: "dex_version",
+    widthPct: "width_pct",
+    horizonDays: "horizon_days",
+    tickLower: "tick_lower",
+    tickUpper: "tick_upper",
+    burnOld: "burn_old",
+  });
+});
+
+export function riskYieldRebalanceRequestToJSON(
+  riskYieldRebalanceRequest: RiskYieldRebalanceRequest,
+): string {
+  return JSON.stringify(
+    RiskYieldRebalanceRequest$outboundSchema.parse(riskYieldRebalanceRequest),
+  );
+}

package/src/models/components/riskyieldrebalanceresponse.ts

@@ -0,0 +1,88 @@
+/*
+ * 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 {
+  RebalancePhase,
+  RebalancePhase$inboundSchema,
+} from "./rebalancephase.js";
+import { ResolvedRange, ResolvedRange$inboundSchema } from "./resolvedrange.js";
+import { Simulation, Simulation$inboundSchema } from "./simulation.js";
+import {
+  UnsignedTransaction,
+  UnsignedTransaction$inboundSchema,
+} from "./unsignedtransaction.js";
+
+export type RiskYieldRebalanceResponse = {
+  /**
+   * `NOOP`, `COLLECT_ONLY` or `RECENTER`. `NOOP` is a real answer and often the right one — moving a position realizes its loss and pays for a swap.
+   */
+  action: string;
+  reason: string;
+  transaction?: UnsignedTransaction | null | undefined;
+  oldPositionId?: number | null | undefined;
+  oldRange?: ResolvedRange | null | undefined;
+  newRange?: ResolvedRange | null | undefined;
+  liquidityRemoved?: string | null | undefined;
+  /**
+   * What the unwind is guaranteed to return. The new position is sized from this rather than from the quote, because every leg executes in the same transaction and a mint sized from a quote reverts when the decrease comes back a wei short.
+   */
+  amount0Floor?: string | null | undefined;
+  amount1Floor?: string | null | undefined;
+  expectedLiquidityFloor?: string | null | undefined;
+  estimatedDust0?: string | null | undefined;
+  estimatedDust1?: string | null | undefined;
+  phases?: Array<RebalancePhase> | undefined;
+  simulation?: Simulation | null | undefined;
+  warnings?: Array<string> | undefined;
+};
+
+/** @internal */
+export const RiskYieldRebalanceResponse$inboundSchema: z.ZodType<
+  RiskYieldRebalanceResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  action: z.string(),
+  reason: z.string(),
+  transaction: z.nullable(UnsignedTransaction$inboundSchema).optional(),
+  old_position_id: z.nullable(z.number().int()).optional(),
+  old_range: z.nullable(ResolvedRange$inboundSchema).optional(),
+  new_range: z.nullable(ResolvedRange$inboundSchema).optional(),
+  liquidity_removed: z.nullable(z.string()).optional(),
+  amount0_floor: z.nullable(z.string()).optional(),
+  amount1_floor: z.nullable(z.string()).optional(),
+  expected_liquidity_floor: z.nullable(z.string()).optional(),
+  estimated_dust0: z.nullable(z.string()).optional(),
+  estimated_dust1: z.nullable(z.string()).optional(),
+  phases: z.array(RebalancePhase$inboundSchema).optional(),
+  simulation: z.nullable(Simulation$inboundSchema).optional(),
+  warnings: z.array(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "old_position_id": "oldPositionId",
+    "old_range": "oldRange",
+    "new_range": "newRange",
+    "liquidity_removed": "liquidityRemoved",
+    "amount0_floor": "amount0Floor",
+    "amount1_floor": "amount1Floor",
+    "expected_liquidity_floor": "expectedLiquidityFloor",
+    "estimated_dust0": "estimatedDust0",
+    "estimated_dust1": "estimatedDust1",
+  });
+});
+
+export function riskYieldRebalanceResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<RiskYieldRebalanceResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RiskYieldRebalanceResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RiskYieldRebalanceResponse' from JSON`,
+  );
+}