@compass-labs/api-sdk 0.0.7 → 0.0.9

package/src/models/components/aerodromeaddliquidityparams.ts

@@ -0,0 +1,382 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 {
+  TokenEnum,
+  TokenEnum$inboundSchema,
+  TokenEnum$outboundSchema,
+} from "./tokenenum.js";
+
+/**
+ * The amount of token A you want to provide
+ */
+export type AmountADesired = number | string;
+
+/**
+ * The amount of token B you want to provide
+ */
+export type AmountBDesired = number | string;
+
+/**
+ * The minimal amount of token A you are willing to provide
+ */
+export type AerodromeAddLiquidityParamsAmountAMin = number | string;
+
+/**
+ * The minimal amount of token B you are willing to provide
+ */
+export type AerodromeAddLiquidityParamsAmountBMin = number | string;
+
+/**
+ * Endpoint parameters for adding liquidity on Aerodrome Basic.
+ *
+ * @remarks
+ *
+ * This action is performed on the Aerodrome Basic Router to add liquidity to a pool.
+ */
+export type AerodromeAddLiquidityParams = {
+  /**
+   * A class representing the token.
+   *
+   * @remarks
+   *
+   * This class is used to represent the token in the system. Notice individual
+   * endpoints' documentation where per chain tokens are presented.
+   */
+  tokenA: TokenEnum;
+  /**
+   * A class representing the token.
+   *
+   * @remarks
+   *
+   * This class is used to represent the token in the system. Notice individual
+   * endpoints' documentation where per chain tokens are presented.
+   */
+  tokenB: TokenEnum;
+  /**
+   * If true, try to provide liquidity on a stable pool with a bonding curve of K=x^3y+y^3x. If false, try to provide liquidity on a volatile pool with a bonding curve of K=xy
+   */
+  stable: boolean;
+  /**
+   * The amount of token A you want to provide
+   */
+  amountADesired: number | string;
+  /**
+   * The amount of token B you want to provide
+   */
+  amountBDesired: number | string;
+  /**
+   * The minimal amount of token A you are willing to provide
+   */
+  amountAMin: number | string;
+  /**
+   * The minimal amount of token B you are willing to provide
+   */
+  amountBMin: number | string;
+  /**
+   * The receiver of the LP tokens from this trade, default to sender
+   */
+  to?: string | null | undefined;
+  /**
+   * The deadline for this transaction in seconds since epoch
+   */
+  deadline: number | null;
+};
+
+/** @internal */
+export const AmountADesired$inboundSchema: z.ZodType<
+  AmountADesired,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.number(), z.string()]);
+
+/** @internal */
+export type AmountADesired$Outbound = number | string;
+
+/** @internal */
+export const AmountADesired$outboundSchema: z.ZodType<
+  AmountADesired$Outbound,
+  z.ZodTypeDef,
+  AmountADesired
+> = z.union([z.number(), z.string()]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AmountADesired$ {
+  /** @deprecated use `AmountADesired$inboundSchema` instead. */
+  export const inboundSchema = AmountADesired$inboundSchema;
+  /** @deprecated use `AmountADesired$outboundSchema` instead. */
+  export const outboundSchema = AmountADesired$outboundSchema;
+  /** @deprecated use `AmountADesired$Outbound` instead. */
+  export type Outbound = AmountADesired$Outbound;
+}
+
+export function amountADesiredToJSON(amountADesired: AmountADesired): string {
+  return JSON.stringify(AmountADesired$outboundSchema.parse(amountADesired));
+}
+
+export function amountADesiredFromJSON(
+  jsonString: string,
+): SafeParseResult<AmountADesired, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AmountADesired$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AmountADesired' from JSON`,
+  );
+}
+
+/** @internal */
+export const AmountBDesired$inboundSchema: z.ZodType<
+  AmountBDesired,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.number(), z.string()]);
+
+/** @internal */
+export type AmountBDesired$Outbound = number | string;
+
+/** @internal */
+export const AmountBDesired$outboundSchema: z.ZodType<
+  AmountBDesired$Outbound,
+  z.ZodTypeDef,
+  AmountBDesired
+> = z.union([z.number(), z.string()]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AmountBDesired$ {
+  /** @deprecated use `AmountBDesired$inboundSchema` instead. */
+  export const inboundSchema = AmountBDesired$inboundSchema;
+  /** @deprecated use `AmountBDesired$outboundSchema` instead. */
+  export const outboundSchema = AmountBDesired$outboundSchema;
+  /** @deprecated use `AmountBDesired$Outbound` instead. */
+  export type Outbound = AmountBDesired$Outbound;
+}
+
+export function amountBDesiredToJSON(amountBDesired: AmountBDesired): string {
+  return JSON.stringify(AmountBDesired$outboundSchema.parse(amountBDesired));
+}
+
+export function amountBDesiredFromJSON(
+  jsonString: string,
+): SafeParseResult<AmountBDesired, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AmountBDesired$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AmountBDesired' from JSON`,
+  );
+}
+
+/** @internal */
+export const AerodromeAddLiquidityParamsAmountAMin$inboundSchema: z.ZodType<
+  AerodromeAddLiquidityParamsAmountAMin,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.number(), z.string()]);
+
+/** @internal */
+export type AerodromeAddLiquidityParamsAmountAMin$Outbound = number | string;
+
+/** @internal */
+export const AerodromeAddLiquidityParamsAmountAMin$outboundSchema: z.ZodType<
+  AerodromeAddLiquidityParamsAmountAMin$Outbound,
+  z.ZodTypeDef,
+  AerodromeAddLiquidityParamsAmountAMin
+> = z.union([z.number(), z.string()]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AerodromeAddLiquidityParamsAmountAMin$ {
+  /** @deprecated use `AerodromeAddLiquidityParamsAmountAMin$inboundSchema` instead. */
+  export const inboundSchema =
+    AerodromeAddLiquidityParamsAmountAMin$inboundSchema;
+  /** @deprecated use `AerodromeAddLiquidityParamsAmountAMin$outboundSchema` instead. */
+  export const outboundSchema =
+    AerodromeAddLiquidityParamsAmountAMin$outboundSchema;
+  /** @deprecated use `AerodromeAddLiquidityParamsAmountAMin$Outbound` instead. */
+  export type Outbound = AerodromeAddLiquidityParamsAmountAMin$Outbound;
+}
+
+export function aerodromeAddLiquidityParamsAmountAMinToJSON(
+  aerodromeAddLiquidityParamsAmountAMin: AerodromeAddLiquidityParamsAmountAMin,
+): string {
+  return JSON.stringify(
+    AerodromeAddLiquidityParamsAmountAMin$outboundSchema.parse(
+      aerodromeAddLiquidityParamsAmountAMin,
+    ),
+  );
+}
+
+export function aerodromeAddLiquidityParamsAmountAMinFromJSON(
+  jsonString: string,
+): SafeParseResult<AerodromeAddLiquidityParamsAmountAMin, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      AerodromeAddLiquidityParamsAmountAMin$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AerodromeAddLiquidityParamsAmountAMin' from JSON`,
+  );
+}
+
+/** @internal */
+export const AerodromeAddLiquidityParamsAmountBMin$inboundSchema: z.ZodType<
+  AerodromeAddLiquidityParamsAmountBMin,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.number(), z.string()]);
+
+/** @internal */
+export type AerodromeAddLiquidityParamsAmountBMin$Outbound = number | string;
+
+/** @internal */
+export const AerodromeAddLiquidityParamsAmountBMin$outboundSchema: z.ZodType<
+  AerodromeAddLiquidityParamsAmountBMin$Outbound,
+  z.ZodTypeDef,
+  AerodromeAddLiquidityParamsAmountBMin
+> = z.union([z.number(), z.string()]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AerodromeAddLiquidityParamsAmountBMin$ {
+  /** @deprecated use `AerodromeAddLiquidityParamsAmountBMin$inboundSchema` instead. */
+  export const inboundSchema =
+    AerodromeAddLiquidityParamsAmountBMin$inboundSchema;
+  /** @deprecated use `AerodromeAddLiquidityParamsAmountBMin$outboundSchema` instead. */
+  export const outboundSchema =
+    AerodromeAddLiquidityParamsAmountBMin$outboundSchema;
+  /** @deprecated use `AerodromeAddLiquidityParamsAmountBMin$Outbound` instead. */
+  export type Outbound = AerodromeAddLiquidityParamsAmountBMin$Outbound;
+}
+
+export function aerodromeAddLiquidityParamsAmountBMinToJSON(
+  aerodromeAddLiquidityParamsAmountBMin: AerodromeAddLiquidityParamsAmountBMin,
+): string {
+  return JSON.stringify(
+    AerodromeAddLiquidityParamsAmountBMin$outboundSchema.parse(
+      aerodromeAddLiquidityParamsAmountBMin,
+    ),
+  );
+}
+
+export function aerodromeAddLiquidityParamsAmountBMinFromJSON(
+  jsonString: string,
+): SafeParseResult<AerodromeAddLiquidityParamsAmountBMin, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      AerodromeAddLiquidityParamsAmountBMin$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AerodromeAddLiquidityParamsAmountBMin' from JSON`,
+  );
+}
+
+/** @internal */
+export const AerodromeAddLiquidityParams$inboundSchema: z.ZodType<
+  AerodromeAddLiquidityParams,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  token_a: TokenEnum$inboundSchema,
+  token_b: TokenEnum$inboundSchema,
+  stable: z.boolean(),
+  amount_a_desired: z.union([z.number(), z.string()]),
+  amount_b_desired: z.union([z.number(), z.string()]),
+  amount_a_min: z.union([z.number(), z.string()]),
+  amount_b_min: z.union([z.number(), z.string()]),
+  to: z.nullable(z.string()).optional(),
+  deadline: z.nullable(z.number().int()),
+}).transform((v) => {
+  return remap$(v, {
+    "token_a": "tokenA",
+    "token_b": "tokenB",
+    "amount_a_desired": "amountADesired",
+    "amount_b_desired": "amountBDesired",
+    "amount_a_min": "amountAMin",
+    "amount_b_min": "amountBMin",
+  });
+});
+
+/** @internal */
+export type AerodromeAddLiquidityParams$Outbound = {
+  token_a: string;
+  token_b: string;
+  stable: boolean;
+  amount_a_desired: number | string;
+  amount_b_desired: number | string;
+  amount_a_min: number | string;
+  amount_b_min: number | string;
+  to?: string | null | undefined;
+  deadline: number | null;
+};
+
+/** @internal */
+export const AerodromeAddLiquidityParams$outboundSchema: z.ZodType<
+  AerodromeAddLiquidityParams$Outbound,
+  z.ZodTypeDef,
+  AerodromeAddLiquidityParams
+> = z.object({
+  tokenA: TokenEnum$outboundSchema,
+  tokenB: TokenEnum$outboundSchema,
+  stable: z.boolean(),
+  amountADesired: z.union([z.number(), z.string()]),
+  amountBDesired: z.union([z.number(), z.string()]),
+  amountAMin: z.union([z.number(), z.string()]),
+  amountBMin: z.union([z.number(), z.string()]),
+  to: z.nullable(z.string()).optional(),
+  deadline: z.nullable(z.number().int()),
+}).transform((v) => {
+  return remap$(v, {
+    tokenA: "token_a",
+    tokenB: "token_b",
+    amountADesired: "amount_a_desired",
+    amountBDesired: "amount_b_desired",
+    amountAMin: "amount_a_min",
+    amountBMin: "amount_b_min",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AerodromeAddLiquidityParams$ {
+  /** @deprecated use `AerodromeAddLiquidityParams$inboundSchema` instead. */
+  export const inboundSchema = AerodromeAddLiquidityParams$inboundSchema;
+  /** @deprecated use `AerodromeAddLiquidityParams$outboundSchema` instead. */
+  export const outboundSchema = AerodromeAddLiquidityParams$outboundSchema;
+  /** @deprecated use `AerodromeAddLiquidityParams$Outbound` instead. */
+  export type Outbound = AerodromeAddLiquidityParams$Outbound;
+}
+
+export function aerodromeAddLiquidityParamsToJSON(
+  aerodromeAddLiquidityParams: AerodromeAddLiquidityParams,
+): string {
+  return JSON.stringify(
+    AerodromeAddLiquidityParams$outboundSchema.parse(
+      aerodromeAddLiquidityParams,
+    ),
+  );
+}
+
+export function aerodromeAddLiquidityParamsFromJSON(
+  jsonString: string,
+): SafeParseResult<AerodromeAddLiquidityParams, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AerodromeAddLiquidityParams$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AerodromeAddLiquidityParams' from JSON`,
+  );
+}