@compass-labs/api-sdk 2.2.105 → 2.2.106

package/src/models/components/riskyieldcollectrequest.ts

@@ -0,0 +1,139 @@
+/*
+ * 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

@@ -0,0 +1,174 @@
+/*
+ * 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),
+  );
+}

package/src/models/components/riskyieldincreaserequest.ts

@@ -0,0 +1,196 @@
+/*
+ * 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 { DexVersion, DexVersion$outboundSchema } from "./dexversion.js";
+import {
+  SingleSidedDeposit,
+  SingleSidedDeposit$Outbound,
+  SingleSidedDeposit$outboundSchema,
+} from "./singlesideddeposit.js";
+import {
+  UsdDeposit,
+  UsdDeposit$Outbound,
+  UsdDeposit$outboundSchema,
+} from "./usddeposit.js";
+
+/**
+ * Risk Yield is available on Robinhood Chain only.
+ */
+export const RiskYieldIncreaseRequestChain = {
+  Robinhood: "robinhood",
+} as const;
+/**
+ * Risk Yield is available on Robinhood Chain only.
+ */
+export type RiskYieldIncreaseRequestChain = ClosedEnum<
+  typeof RiskYieldIncreaseRequestChain
+>;
+
+/**
+ * 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 RiskYieldIncreaseRequestSlippagePct = number | string;
+
+export type RiskYieldIncreaseRequestDeposit =
+  | BothSidesDeposit
+  | SingleSidedDeposit
+  | UsdDeposit;
+
+/**
+ * Add to a position you already hold.
+ */
+export type RiskYieldIncreaseRequest = {
+  /**
+   * The wallet that owns the Risk Yield Account.
+   */
+  owner: string;
+  /**
+   * Risk Yield is available on Robinhood Chain only.
+   */
+  chain?: RiskYieldIncreaseRequestChain | 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;
+  /**
+   * The position NFT's id.
+   */
+  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;
+  deposit: BothSidesDeposit | SingleSidedDeposit | UsdDeposit;
+};
+
+/** @internal */
+export const RiskYieldIncreaseRequestChain$outboundSchema: z.ZodNativeEnum<
+  typeof RiskYieldIncreaseRequestChain
+> = z.nativeEnum(RiskYieldIncreaseRequestChain);
+
+/** @internal */
+export type RiskYieldIncreaseRequestSlippagePct$Outbound = number | string;
+
+/** @internal */
+export const RiskYieldIncreaseRequestSlippagePct$outboundSchema: z.ZodType<
+  RiskYieldIncreaseRequestSlippagePct$Outbound,
+  z.ZodTypeDef,
+  RiskYieldIncreaseRequestSlippagePct
+> = z.union([z.number(), z.string()]);
+
+export function riskYieldIncreaseRequestSlippagePctToJSON(
+  riskYieldIncreaseRequestSlippagePct: RiskYieldIncreaseRequestSlippagePct,
+): string {
+  return JSON.stringify(
+    RiskYieldIncreaseRequestSlippagePct$outboundSchema.parse(
+      riskYieldIncreaseRequestSlippagePct,
+    ),
+  );
+}
+
+/** @internal */
+export type RiskYieldIncreaseRequestDeposit$Outbound =
+  | BothSidesDeposit$Outbound
+  | SingleSidedDeposit$Outbound
+  | UsdDeposit$Outbound;
+
+/** @internal */
+export const RiskYieldIncreaseRequestDeposit$outboundSchema: z.ZodType<
+  RiskYieldIncreaseRequestDeposit$Outbound,
+  z.ZodTypeDef,
+  RiskYieldIncreaseRequestDeposit
+> = z.union([
+  BothSidesDeposit$outboundSchema,
+  SingleSidedDeposit$outboundSchema,
+  UsdDeposit$outboundSchema,
+]);
+
+export function riskYieldIncreaseRequestDepositToJSON(
+  riskYieldIncreaseRequestDeposit: RiskYieldIncreaseRequestDeposit,
+): string {
+  return JSON.stringify(
+    RiskYieldIncreaseRequestDeposit$outboundSchema.parse(
+      riskYieldIncreaseRequestDeposit,
+    ),
+  );
+}
+
+/** @internal */
+export type RiskYieldIncreaseRequest$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;
+  deposit:
+    | BothSidesDeposit$Outbound
+    | SingleSidedDeposit$Outbound
+    | UsdDeposit$Outbound;
+};
+
+/** @internal */
+export const RiskYieldIncreaseRequest$outboundSchema: z.ZodType<
+  RiskYieldIncreaseRequest$Outbound,
+  z.ZodTypeDef,
+  RiskYieldIncreaseRequest
+> = z.object({
+  owner: z.string(),
+  chain: RiskYieldIncreaseRequestChain$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(),
+  deposit: z.union([
+    BothSidesDeposit$outboundSchema,
+    SingleSidedDeposit$outboundSchema,
+    UsdDeposit$outboundSchema,
+  ]),
+}).transform((v) => {
+  return remap$(v, {
+    gasSponsorship: "gas_sponsorship",
+    slippagePct: "slippage_pct",
+    deadlineSeconds: "deadline_seconds",
+    positionId: "position_id",
+    dexVersion: "dex_version",
+  });
+});
+
+export function riskYieldIncreaseRequestToJSON(
+  riskYieldIncreaseRequest: RiskYieldIncreaseRequest,
+): string {
+  return JSON.stringify(
+    RiskYieldIncreaseRequest$outboundSchema.parse(riskYieldIncreaseRequest),
+  );
+}

package/src/models/components/riskyieldliquidityresponse.ts

@@ -0,0 +1,71 @@
+/*
+ * 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 { DepositPlan, DepositPlan$inboundSchema } from "./depositplan.js";
+import { PlanStep, PlanStep$inboundSchema } from "./planstep.js";
+import { ResolvedRange, ResolvedRange$inboundSchema } from "./resolvedrange.js";
+import { Simulation, Simulation$inboundSchema } from "./simulation.js";
+import {
+  UnsignedTransaction,
+  UnsignedTransaction$inboundSchema,
+} from "./unsignedtransaction.js";
+
+/**
+ * The shape every liquidity-changing endpoint returns.
+ */
+export type RiskYieldLiquidityResponse = {
+  transaction?: UnsignedTransaction | null | undefined;
+  positionId?: number | null | undefined;
+  range?: ResolvedRange | null | undefined;
+  plan?: DepositPlan | null | undefined;
+  expectedLiquidity?: string | null | undefined;
+  liquidityRemoved?: string | null | undefined;
+  amount0Min?: string | null | undefined;
+  amount1Min?: string | null | undefined;
+  steps?: Array<PlanStep> | undefined;
+  simulation?: Simulation | null | undefined;
+  warnings?: Array<string> | undefined;
+};
+
+/** @internal */
+export const RiskYieldLiquidityResponse$inboundSchema: z.ZodType<
+  RiskYieldLiquidityResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  transaction: z.nullable(UnsignedTransaction$inboundSchema).optional(),
+  position_id: z.nullable(z.number().int()).optional(),
+  range: z.nullable(ResolvedRange$inboundSchema).optional(),
+  plan: z.nullable(DepositPlan$inboundSchema).optional(),
+  expected_liquidity: z.nullable(z.string()).optional(),
+  liquidity_removed: z.nullable(z.string()).optional(),
+  amount0_min: z.nullable(z.string()).optional(),
+  amount1_min: z.nullable(z.string()).optional(),
+  steps: z.array(PlanStep$inboundSchema).optional(),
+  simulation: z.nullable(Simulation$inboundSchema).optional(),
+  warnings: z.array(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "position_id": "positionId",
+    "expected_liquidity": "expectedLiquidity",
+    "liquidity_removed": "liquidityRemoved",
+    "amount0_min": "amount0Min",
+    "amount1_min": "amount1Min",
+  });
+});
+
+export function riskYieldLiquidityResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<RiskYieldLiquidityResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RiskYieldLiquidityResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RiskYieldLiquidityResponse' from JSON`,
+  );
+}