@compass-labs/api-sdk 0.0.7 → 0.0.8

package/src/models/components/aavewithdrawparams.ts

@@ -0,0 +1,146 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 the asset to withdraw
+ */
+export type AaveWithdrawParamsAmount = number | string;
+
+export type AaveWithdrawParams = {
+  /**
+   * 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.
+   */
+  token: TokenEnum;
+  /**
+   * The amount of the asset to withdraw
+   */
+  amount: number | string;
+  /**
+   * The address of the recipient of the withdrawn funds.
+   */
+  recipient: string;
+};
+
+/** @internal */
+export const AaveWithdrawParamsAmount$inboundSchema: z.ZodType<
+  AaveWithdrawParamsAmount,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.number(), z.string()]);
+
+/** @internal */
+export type AaveWithdrawParamsAmount$Outbound = number | string;
+
+/** @internal */
+export const AaveWithdrawParamsAmount$outboundSchema: z.ZodType<
+  AaveWithdrawParamsAmount$Outbound,
+  z.ZodTypeDef,
+  AaveWithdrawParamsAmount
+> = 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 AaveWithdrawParamsAmount$ {
+  /** @deprecated use `AaveWithdrawParamsAmount$inboundSchema` instead. */
+  export const inboundSchema = AaveWithdrawParamsAmount$inboundSchema;
+  /** @deprecated use `AaveWithdrawParamsAmount$outboundSchema` instead. */
+  export const outboundSchema = AaveWithdrawParamsAmount$outboundSchema;
+  /** @deprecated use `AaveWithdrawParamsAmount$Outbound` instead. */
+  export type Outbound = AaveWithdrawParamsAmount$Outbound;
+}
+
+export function aaveWithdrawParamsAmountToJSON(
+  aaveWithdrawParamsAmount: AaveWithdrawParamsAmount,
+): string {
+  return JSON.stringify(
+    AaveWithdrawParamsAmount$outboundSchema.parse(aaveWithdrawParamsAmount),
+  );
+}
+
+export function aaveWithdrawParamsAmountFromJSON(
+  jsonString: string,
+): SafeParseResult<AaveWithdrawParamsAmount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AaveWithdrawParamsAmount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AaveWithdrawParamsAmount' from JSON`,
+  );
+}
+
+/** @internal */
+export const AaveWithdrawParams$inboundSchema: z.ZodType<
+  AaveWithdrawParams,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  token: TokenEnum$inboundSchema,
+  amount: z.union([z.number(), z.string()]),
+  recipient: z.string(),
+});
+
+/** @internal */
+export type AaveWithdrawParams$Outbound = {
+  token: string;
+  amount: number | string;
+  recipient: string;
+};
+
+/** @internal */
+export const AaveWithdrawParams$outboundSchema: z.ZodType<
+  AaveWithdrawParams$Outbound,
+  z.ZodTypeDef,
+  AaveWithdrawParams
+> = z.object({
+  token: TokenEnum$outboundSchema,
+  amount: z.union([z.number(), z.string()]),
+  recipient: 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 AaveWithdrawParams$ {
+  /** @deprecated use `AaveWithdrawParams$inboundSchema` instead. */
+  export const inboundSchema = AaveWithdrawParams$inboundSchema;
+  /** @deprecated use `AaveWithdrawParams$outboundSchema` instead. */
+  export const outboundSchema = AaveWithdrawParams$outboundSchema;
+  /** @deprecated use `AaveWithdrawParams$Outbound` instead. */
+  export type Outbound = AaveWithdrawParams$Outbound;
+}
+
+export function aaveWithdrawParamsToJSON(
+  aaveWithdrawParams: AaveWithdrawParams,
+): string {
+  return JSON.stringify(
+    AaveWithdrawParams$outboundSchema.parse(aaveWithdrawParams),
+  );
+}
+
+export function aaveWithdrawParamsFromJSON(
+  jsonString: string,
+): SafeParseResult<AaveWithdrawParams, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AaveWithdrawParams$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AaveWithdrawParams' from JSON`,
+  );
+}

package/src/models/components/aerodromeaddliquidityethparams.ts

@@ -0,0 +1,392 @@
+/*
+ * 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 you want to provide
+ */
+export type AmountTokenDesired = number | string;
+
+/**
+ * The amount of WETH you want to provide
+ */
+export type AmountEthDesired = number | string;
+
+/**
+ * The minimal amount of token you are willing to provide
+ */
+export type AerodromeAddLiquidityEthParamsAmountTokenMin = number | string;
+
+/**
+ * The minimal amount of WETH you are willing to provide
+ */
+export type AerodromeAddLiquidityEthParamsAmountEthMin = number | string;
+
+/**
+ * Endpoint parameters for adding ETH liquidity on Aerodrome Basic.
+ *
+ * @remarks
+ *
+ * This action is performed on the Aerodrome Basic Router to add liquidity to a pool
+ * with ETH as one of the tokens.
+ */
+export type AerodromeAddLiquidityEthParams = {
+  /**
+   * 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.
+   */
+  token: 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 you want to provide
+   */
+  amountTokenDesired: number | string;
+  /**
+   * The amount of WETH you want to provide
+   */
+  amountEthDesired: number | string;
+  /**
+   * The minimal amount of token you are willing to provide
+   */
+  amountTokenMin: number | string;
+  /**
+   * The minimal amount of WETH you are willing to provide
+   */
+  amountEthMin: 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 AmountTokenDesired$inboundSchema: z.ZodType<
+  AmountTokenDesired,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.number(), z.string()]);
+
+/** @internal */
+export type AmountTokenDesired$Outbound = number | string;
+
+/** @internal */
+export const AmountTokenDesired$outboundSchema: z.ZodType<
+  AmountTokenDesired$Outbound,
+  z.ZodTypeDef,
+  AmountTokenDesired
+> = 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 AmountTokenDesired$ {
+  /** @deprecated use `AmountTokenDesired$inboundSchema` instead. */
+  export const inboundSchema = AmountTokenDesired$inboundSchema;
+  /** @deprecated use `AmountTokenDesired$outboundSchema` instead. */
+  export const outboundSchema = AmountTokenDesired$outboundSchema;
+  /** @deprecated use `AmountTokenDesired$Outbound` instead. */
+  export type Outbound = AmountTokenDesired$Outbound;
+}
+
+export function amountTokenDesiredToJSON(
+  amountTokenDesired: AmountTokenDesired,
+): string {
+  return JSON.stringify(
+    AmountTokenDesired$outboundSchema.parse(amountTokenDesired),
+  );
+}
+
+export function amountTokenDesiredFromJSON(
+  jsonString: string,
+): SafeParseResult<AmountTokenDesired, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AmountTokenDesired$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AmountTokenDesired' from JSON`,
+  );
+}
+
+/** @internal */
+export const AmountEthDesired$inboundSchema: z.ZodType<
+  AmountEthDesired,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.number(), z.string()]);
+
+/** @internal */
+export type AmountEthDesired$Outbound = number | string;
+
+/** @internal */
+export const AmountEthDesired$outboundSchema: z.ZodType<
+  AmountEthDesired$Outbound,
+  z.ZodTypeDef,
+  AmountEthDesired
+> = 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 AmountEthDesired$ {
+  /** @deprecated use `AmountEthDesired$inboundSchema` instead. */
+  export const inboundSchema = AmountEthDesired$inboundSchema;
+  /** @deprecated use `AmountEthDesired$outboundSchema` instead. */
+  export const outboundSchema = AmountEthDesired$outboundSchema;
+  /** @deprecated use `AmountEthDesired$Outbound` instead. */
+  export type Outbound = AmountEthDesired$Outbound;
+}
+
+export function amountEthDesiredToJSON(
+  amountEthDesired: AmountEthDesired,
+): string {
+  return JSON.stringify(
+    AmountEthDesired$outboundSchema.parse(amountEthDesired),
+  );
+}
+
+export function amountEthDesiredFromJSON(
+  jsonString: string,
+): SafeParseResult<AmountEthDesired, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AmountEthDesired$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AmountEthDesired' from JSON`,
+  );
+}
+
+/** @internal */
+export const AerodromeAddLiquidityEthParamsAmountTokenMin$inboundSchema:
+  z.ZodType<
+    AerodromeAddLiquidityEthParamsAmountTokenMin,
+    z.ZodTypeDef,
+    unknown
+  > = z.union([z.number(), z.string()]);
+
+/** @internal */
+export type AerodromeAddLiquidityEthParamsAmountTokenMin$Outbound =
+  | number
+  | string;
+
+/** @internal */
+export const AerodromeAddLiquidityEthParamsAmountTokenMin$outboundSchema:
+  z.ZodType<
+    AerodromeAddLiquidityEthParamsAmountTokenMin$Outbound,
+    z.ZodTypeDef,
+    AerodromeAddLiquidityEthParamsAmountTokenMin
+  > = 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 AerodromeAddLiquidityEthParamsAmountTokenMin$ {
+  /** @deprecated use `AerodromeAddLiquidityEthParamsAmountTokenMin$inboundSchema` instead. */
+  export const inboundSchema =
+    AerodromeAddLiquidityEthParamsAmountTokenMin$inboundSchema;
+  /** @deprecated use `AerodromeAddLiquidityEthParamsAmountTokenMin$outboundSchema` instead. */
+  export const outboundSchema =
+    AerodromeAddLiquidityEthParamsAmountTokenMin$outboundSchema;
+  /** @deprecated use `AerodromeAddLiquidityEthParamsAmountTokenMin$Outbound` instead. */
+  export type Outbound = AerodromeAddLiquidityEthParamsAmountTokenMin$Outbound;
+}
+
+export function aerodromeAddLiquidityEthParamsAmountTokenMinToJSON(
+  aerodromeAddLiquidityEthParamsAmountTokenMin:
+    AerodromeAddLiquidityEthParamsAmountTokenMin,
+): string {
+  return JSON.stringify(
+    AerodromeAddLiquidityEthParamsAmountTokenMin$outboundSchema.parse(
+      aerodromeAddLiquidityEthParamsAmountTokenMin,
+    ),
+  );
+}
+
+export function aerodromeAddLiquidityEthParamsAmountTokenMinFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  AerodromeAddLiquidityEthParamsAmountTokenMin,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      AerodromeAddLiquidityEthParamsAmountTokenMin$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'AerodromeAddLiquidityEthParamsAmountTokenMin' from JSON`,
+  );
+}
+
+/** @internal */
+export const AerodromeAddLiquidityEthParamsAmountEthMin$inboundSchema:
+  z.ZodType<AerodromeAddLiquidityEthParamsAmountEthMin, z.ZodTypeDef, unknown> =
+    z.union([z.number(), z.string()]);
+
+/** @internal */
+export type AerodromeAddLiquidityEthParamsAmountEthMin$Outbound =
+  | number
+  | string;
+
+/** @internal */
+export const AerodromeAddLiquidityEthParamsAmountEthMin$outboundSchema:
+  z.ZodType<
+    AerodromeAddLiquidityEthParamsAmountEthMin$Outbound,
+    z.ZodTypeDef,
+    AerodromeAddLiquidityEthParamsAmountEthMin
+  > = 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 AerodromeAddLiquidityEthParamsAmountEthMin$ {
+  /** @deprecated use `AerodromeAddLiquidityEthParamsAmountEthMin$inboundSchema` instead. */
+  export const inboundSchema =
+    AerodromeAddLiquidityEthParamsAmountEthMin$inboundSchema;
+  /** @deprecated use `AerodromeAddLiquidityEthParamsAmountEthMin$outboundSchema` instead. */
+  export const outboundSchema =
+    AerodromeAddLiquidityEthParamsAmountEthMin$outboundSchema;
+  /** @deprecated use `AerodromeAddLiquidityEthParamsAmountEthMin$Outbound` instead. */
+  export type Outbound = AerodromeAddLiquidityEthParamsAmountEthMin$Outbound;
+}
+
+export function aerodromeAddLiquidityEthParamsAmountEthMinToJSON(
+  aerodromeAddLiquidityEthParamsAmountEthMin:
+    AerodromeAddLiquidityEthParamsAmountEthMin,
+): string {
+  return JSON.stringify(
+    AerodromeAddLiquidityEthParamsAmountEthMin$outboundSchema.parse(
+      aerodromeAddLiquidityEthParamsAmountEthMin,
+    ),
+  );
+}
+
+export function aerodromeAddLiquidityEthParamsAmountEthMinFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  AerodromeAddLiquidityEthParamsAmountEthMin,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      AerodromeAddLiquidityEthParamsAmountEthMin$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'AerodromeAddLiquidityEthParamsAmountEthMin' from JSON`,
+  );
+}
+
+/** @internal */
+export const AerodromeAddLiquidityEthParams$inboundSchema: z.ZodType<
+  AerodromeAddLiquidityEthParams,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  token: TokenEnum$inboundSchema,
+  stable: z.boolean(),
+  amount_token_desired: z.union([z.number(), z.string()]),
+  amount_eth_desired: z.union([z.number(), z.string()]),
+  amount_token_min: z.union([z.number(), z.string()]),
+  amount_eth_min: z.union([z.number(), z.string()]),
+  to: z.nullable(z.string()).optional(),
+  deadline: z.nullable(z.number().int()),
+}).transform((v) => {
+  return remap$(v, {
+    "amount_token_desired": "amountTokenDesired",
+    "amount_eth_desired": "amountEthDesired",
+    "amount_token_min": "amountTokenMin",
+    "amount_eth_min": "amountEthMin",
+  });
+});
+
+/** @internal */
+export type AerodromeAddLiquidityEthParams$Outbound = {
+  token: string;
+  stable: boolean;
+  amount_token_desired: number | string;
+  amount_eth_desired: number | string;
+  amount_token_min: number | string;
+  amount_eth_min: number | string;
+  to?: string | null | undefined;
+  deadline: number | null;
+};
+
+/** @internal */
+export const AerodromeAddLiquidityEthParams$outboundSchema: z.ZodType<
+  AerodromeAddLiquidityEthParams$Outbound,
+  z.ZodTypeDef,
+  AerodromeAddLiquidityEthParams
+> = z.object({
+  token: TokenEnum$outboundSchema,
+  stable: z.boolean(),
+  amountTokenDesired: z.union([z.number(), z.string()]),
+  amountEthDesired: z.union([z.number(), z.string()]),
+  amountTokenMin: z.union([z.number(), z.string()]),
+  amountEthMin: z.union([z.number(), z.string()]),
+  to: z.nullable(z.string()).optional(),
+  deadline: z.nullable(z.number().int()),
+}).transform((v) => {
+  return remap$(v, {
+    amountTokenDesired: "amount_token_desired",
+    amountEthDesired: "amount_eth_desired",
+    amountTokenMin: "amount_token_min",
+    amountEthMin: "amount_eth_min",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AerodromeAddLiquidityEthParams$ {
+  /** @deprecated use `AerodromeAddLiquidityEthParams$inboundSchema` instead. */
+  export const inboundSchema = AerodromeAddLiquidityEthParams$inboundSchema;
+  /** @deprecated use `AerodromeAddLiquidityEthParams$outboundSchema` instead. */
+  export const outboundSchema = AerodromeAddLiquidityEthParams$outboundSchema;
+  /** @deprecated use `AerodromeAddLiquidityEthParams$Outbound` instead. */
+  export type Outbound = AerodromeAddLiquidityEthParams$Outbound;
+}
+
+export function aerodromeAddLiquidityEthParamsToJSON(
+  aerodromeAddLiquidityEthParams: AerodromeAddLiquidityEthParams,
+): string {
+  return JSON.stringify(
+    AerodromeAddLiquidityEthParams$outboundSchema.parse(
+      aerodromeAddLiquidityEthParams,
+    ),
+  );
+}
+
+export function aerodromeAddLiquidityEthParamsFromJSON(
+  jsonString: string,
+): SafeParseResult<AerodromeAddLiquidityEthParams, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AerodromeAddLiquidityEthParams$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AerodromeAddLiquidityEthParams' from JSON`,
+  );
+}