@compass-labs/api-sdk 0.0.6 → 0.0.8

package/src/models/components/aerodromeswaptokenforethparams.ts

@@ -0,0 +1,249 @@
+/*
+ * 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 tokens you will give to aerodrome_basic for this trade
+ */
+export type AerodromeSwapTokenForEthParamsAmountIn = number | string;
+
+/**
+ * The minimal amount of ETH you are willing to receive (will revert if the swap gives you less)
+ */
+export type AerodromeSwapTokenForEthParamsAmountOutMin = number | string;
+
+/**
+ * Parameters model for swapping tokens for ETH.
+ */
+export type AerodromeSwapTokenForEthParams = {
+  /**
+   * 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.
+   */
+  tokenIn: TokenEnum;
+  /**
+   * The amount of tokens you will give to aerodrome_basic for this trade
+   */
+  amountIn: number | string;
+  /**
+   * The minimal amount of ETH you are willing to receive (will revert if the swap gives you less)
+   */
+  amountOutMin: number | string;
+  /**
+   * If true, try to trade on a stable pool with a bonding curve of K=x^3y+y^3x. If false, try to trade on a volatile pool with a bonding curve of K=xy
+   */
+  stable: boolean;
+  /**
+   * The receiver of the funds from this trade, default to sender
+   */
+  to?: string | null | undefined;
+};
+
+/** @internal */
+export const AerodromeSwapTokenForEthParamsAmountIn$inboundSchema: z.ZodType<
+  AerodromeSwapTokenForEthParamsAmountIn,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.number(), z.string()]);
+
+/** @internal */
+export type AerodromeSwapTokenForEthParamsAmountIn$Outbound = number | string;
+
+/** @internal */
+export const AerodromeSwapTokenForEthParamsAmountIn$outboundSchema: z.ZodType<
+  AerodromeSwapTokenForEthParamsAmountIn$Outbound,
+  z.ZodTypeDef,
+  AerodromeSwapTokenForEthParamsAmountIn
+> = 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 AerodromeSwapTokenForEthParamsAmountIn$ {
+  /** @deprecated use `AerodromeSwapTokenForEthParamsAmountIn$inboundSchema` instead. */
+  export const inboundSchema =
+    AerodromeSwapTokenForEthParamsAmountIn$inboundSchema;
+  /** @deprecated use `AerodromeSwapTokenForEthParamsAmountIn$outboundSchema` instead. */
+  export const outboundSchema =
+    AerodromeSwapTokenForEthParamsAmountIn$outboundSchema;
+  /** @deprecated use `AerodromeSwapTokenForEthParamsAmountIn$Outbound` instead. */
+  export type Outbound = AerodromeSwapTokenForEthParamsAmountIn$Outbound;
+}
+
+export function aerodromeSwapTokenForEthParamsAmountInToJSON(
+  aerodromeSwapTokenForEthParamsAmountIn:
+    AerodromeSwapTokenForEthParamsAmountIn,
+): string {
+  return JSON.stringify(
+    AerodromeSwapTokenForEthParamsAmountIn$outboundSchema.parse(
+      aerodromeSwapTokenForEthParamsAmountIn,
+    ),
+  );
+}
+
+export function aerodromeSwapTokenForEthParamsAmountInFromJSON(
+  jsonString: string,
+): SafeParseResult<AerodromeSwapTokenForEthParamsAmountIn, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      AerodromeSwapTokenForEthParamsAmountIn$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AerodromeSwapTokenForEthParamsAmountIn' from JSON`,
+  );
+}
+
+/** @internal */
+export const AerodromeSwapTokenForEthParamsAmountOutMin$inboundSchema:
+  z.ZodType<AerodromeSwapTokenForEthParamsAmountOutMin, z.ZodTypeDef, unknown> =
+    z.union([z.number(), z.string()]);
+
+/** @internal */
+export type AerodromeSwapTokenForEthParamsAmountOutMin$Outbound =
+  | number
+  | string;
+
+/** @internal */
+export const AerodromeSwapTokenForEthParamsAmountOutMin$outboundSchema:
+  z.ZodType<
+    AerodromeSwapTokenForEthParamsAmountOutMin$Outbound,
+    z.ZodTypeDef,
+    AerodromeSwapTokenForEthParamsAmountOutMin
+  > = 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 AerodromeSwapTokenForEthParamsAmountOutMin$ {
+  /** @deprecated use `AerodromeSwapTokenForEthParamsAmountOutMin$inboundSchema` instead. */
+  export const inboundSchema =
+    AerodromeSwapTokenForEthParamsAmountOutMin$inboundSchema;
+  /** @deprecated use `AerodromeSwapTokenForEthParamsAmountOutMin$outboundSchema` instead. */
+  export const outboundSchema =
+    AerodromeSwapTokenForEthParamsAmountOutMin$outboundSchema;
+  /** @deprecated use `AerodromeSwapTokenForEthParamsAmountOutMin$Outbound` instead. */
+  export type Outbound = AerodromeSwapTokenForEthParamsAmountOutMin$Outbound;
+}
+
+export function aerodromeSwapTokenForEthParamsAmountOutMinToJSON(
+  aerodromeSwapTokenForEthParamsAmountOutMin:
+    AerodromeSwapTokenForEthParamsAmountOutMin,
+): string {
+  return JSON.stringify(
+    AerodromeSwapTokenForEthParamsAmountOutMin$outboundSchema.parse(
+      aerodromeSwapTokenForEthParamsAmountOutMin,
+    ),
+  );
+}
+
+export function aerodromeSwapTokenForEthParamsAmountOutMinFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  AerodromeSwapTokenForEthParamsAmountOutMin,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      AerodromeSwapTokenForEthParamsAmountOutMin$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'AerodromeSwapTokenForEthParamsAmountOutMin' from JSON`,
+  );
+}
+
+/** @internal */
+export const AerodromeSwapTokenForEthParams$inboundSchema: z.ZodType<
+  AerodromeSwapTokenForEthParams,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  token_in: TokenEnum$inboundSchema,
+  amount_in: z.union([z.number(), z.string()]),
+  amount_out_min: z.union([z.number(), z.string()]),
+  stable: z.boolean(),
+  to: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "token_in": "tokenIn",
+    "amount_in": "amountIn",
+    "amount_out_min": "amountOutMin",
+  });
+});
+
+/** @internal */
+export type AerodromeSwapTokenForEthParams$Outbound = {
+  token_in: string;
+  amount_in: number | string;
+  amount_out_min: number | string;
+  stable: boolean;
+  to?: string | null | undefined;
+};
+
+/** @internal */
+export const AerodromeSwapTokenForEthParams$outboundSchema: z.ZodType<
+  AerodromeSwapTokenForEthParams$Outbound,
+  z.ZodTypeDef,
+  AerodromeSwapTokenForEthParams
+> = z.object({
+  tokenIn: TokenEnum$outboundSchema,
+  amountIn: z.union([z.number(), z.string()]),
+  amountOutMin: z.union([z.number(), z.string()]),
+  stable: z.boolean(),
+  to: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    tokenIn: "token_in",
+    amountIn: "amount_in",
+    amountOutMin: "amount_out_min",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AerodromeSwapTokenForEthParams$ {
+  /** @deprecated use `AerodromeSwapTokenForEthParams$inboundSchema` instead. */
+  export const inboundSchema = AerodromeSwapTokenForEthParams$inboundSchema;
+  /** @deprecated use `AerodromeSwapTokenForEthParams$outboundSchema` instead. */
+  export const outboundSchema = AerodromeSwapTokenForEthParams$outboundSchema;
+  /** @deprecated use `AerodromeSwapTokenForEthParams$Outbound` instead. */
+  export type Outbound = AerodromeSwapTokenForEthParams$Outbound;
+}
+
+export function aerodromeSwapTokenForEthParamsToJSON(
+  aerodromeSwapTokenForEthParams: AerodromeSwapTokenForEthParams,
+): string {
+  return JSON.stringify(
+    AerodromeSwapTokenForEthParams$outboundSchema.parse(
+      aerodromeSwapTokenForEthParams,
+    ),
+  );
+}
+
+export function aerodromeSwapTokenForEthParamsFromJSON(
+  jsonString: string,
+): SafeParseResult<AerodromeSwapTokenForEthParams, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AerodromeSwapTokenForEthParams$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AerodromeSwapTokenForEthParams' from JSON`,
+  );
+}

package/src/models/components/aerodromeswaptokensparams.ts

@@ -0,0 +1,260 @@
+/*
+ * 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 tokens you will give to aerodrome_basic for this trade
+ */
+export type AerodromeSwapTokensParamsAmountIn = number | string;
+
+/**
+ * The minimal amount of token you are willing to receive (will revert if the
+ *
+ * @remarks
+ *         swap gives you less)
+ */
+export type AerodromeSwapTokensParamsAmountOutMin = number | string;
+
+/**
+ * Parameters model for swapping tokens.
+ */
+export type AerodromeSwapTokensParams = {
+  /**
+   * 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.
+   */
+  tokenIn: 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.
+   */
+  tokenOut: TokenEnum;
+  /**
+   * The amount of tokens you will give to aerodrome_basic for this trade
+   */
+  amountIn: number | string;
+  /**
+   * The minimal amount of token you are willing to receive (will revert if the
+   *
+   * @remarks
+   *         swap gives you less)
+   */
+  amountOutMin: number | string;
+  /**
+   * If true, try to trade on a stable pool with a bonding curve of K=x^3y+y^3x.
+   *
+   * @remarks
+   *         If false, try to trade on a volatile pool with a bonding curve of K=xy
+   */
+  stable: boolean;
+  /**
+   * The receiver of the funds from this trade, default to sender
+   */
+  to?: string | null | undefined;
+};
+
+/** @internal */
+export const AerodromeSwapTokensParamsAmountIn$inboundSchema: z.ZodType<
+  AerodromeSwapTokensParamsAmountIn,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.number(), z.string()]);
+
+/** @internal */
+export type AerodromeSwapTokensParamsAmountIn$Outbound = number | string;
+
+/** @internal */
+export const AerodromeSwapTokensParamsAmountIn$outboundSchema: z.ZodType<
+  AerodromeSwapTokensParamsAmountIn$Outbound,
+  z.ZodTypeDef,
+  AerodromeSwapTokensParamsAmountIn
+> = 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 AerodromeSwapTokensParamsAmountIn$ {
+  /** @deprecated use `AerodromeSwapTokensParamsAmountIn$inboundSchema` instead. */
+  export const inboundSchema = AerodromeSwapTokensParamsAmountIn$inboundSchema;
+  /** @deprecated use `AerodromeSwapTokensParamsAmountIn$outboundSchema` instead. */
+  export const outboundSchema =
+    AerodromeSwapTokensParamsAmountIn$outboundSchema;
+  /** @deprecated use `AerodromeSwapTokensParamsAmountIn$Outbound` instead. */
+  export type Outbound = AerodromeSwapTokensParamsAmountIn$Outbound;
+}
+
+export function aerodromeSwapTokensParamsAmountInToJSON(
+  aerodromeSwapTokensParamsAmountIn: AerodromeSwapTokensParamsAmountIn,
+): string {
+  return JSON.stringify(
+    AerodromeSwapTokensParamsAmountIn$outboundSchema.parse(
+      aerodromeSwapTokensParamsAmountIn,
+    ),
+  );
+}
+
+export function aerodromeSwapTokensParamsAmountInFromJSON(
+  jsonString: string,
+): SafeParseResult<AerodromeSwapTokensParamsAmountIn, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AerodromeSwapTokensParamsAmountIn$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AerodromeSwapTokensParamsAmountIn' from JSON`,
+  );
+}
+
+/** @internal */
+export const AerodromeSwapTokensParamsAmountOutMin$inboundSchema: z.ZodType<
+  AerodromeSwapTokensParamsAmountOutMin,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.number(), z.string()]);
+
+/** @internal */
+export type AerodromeSwapTokensParamsAmountOutMin$Outbound = number | string;
+
+/** @internal */
+export const AerodromeSwapTokensParamsAmountOutMin$outboundSchema: z.ZodType<
+  AerodromeSwapTokensParamsAmountOutMin$Outbound,
+  z.ZodTypeDef,
+  AerodromeSwapTokensParamsAmountOutMin
+> = 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 AerodromeSwapTokensParamsAmountOutMin$ {
+  /** @deprecated use `AerodromeSwapTokensParamsAmountOutMin$inboundSchema` instead. */
+  export const inboundSchema =
+    AerodromeSwapTokensParamsAmountOutMin$inboundSchema;
+  /** @deprecated use `AerodromeSwapTokensParamsAmountOutMin$outboundSchema` instead. */
+  export const outboundSchema =
+    AerodromeSwapTokensParamsAmountOutMin$outboundSchema;
+  /** @deprecated use `AerodromeSwapTokensParamsAmountOutMin$Outbound` instead. */
+  export type Outbound = AerodromeSwapTokensParamsAmountOutMin$Outbound;
+}
+
+export function aerodromeSwapTokensParamsAmountOutMinToJSON(
+  aerodromeSwapTokensParamsAmountOutMin: AerodromeSwapTokensParamsAmountOutMin,
+): string {
+  return JSON.stringify(
+    AerodromeSwapTokensParamsAmountOutMin$outboundSchema.parse(
+      aerodromeSwapTokensParamsAmountOutMin,
+    ),
+  );
+}
+
+export function aerodromeSwapTokensParamsAmountOutMinFromJSON(
+  jsonString: string,
+): SafeParseResult<AerodromeSwapTokensParamsAmountOutMin, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      AerodromeSwapTokensParamsAmountOutMin$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AerodromeSwapTokensParamsAmountOutMin' from JSON`,
+  );
+}
+
+/** @internal */
+export const AerodromeSwapTokensParams$inboundSchema: z.ZodType<
+  AerodromeSwapTokensParams,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  token_in: TokenEnum$inboundSchema,
+  token_out: TokenEnum$inboundSchema,
+  amount_in: z.union([z.number(), z.string()]),
+  amount_out_min: z.union([z.number(), z.string()]),
+  stable: z.boolean(),
+  to: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "token_in": "tokenIn",
+    "token_out": "tokenOut",
+    "amount_in": "amountIn",
+    "amount_out_min": "amountOutMin",
+  });
+});
+
+/** @internal */
+export type AerodromeSwapTokensParams$Outbound = {
+  token_in: string;
+  token_out: string;
+  amount_in: number | string;
+  amount_out_min: number | string;
+  stable: boolean;
+  to?: string | null | undefined;
+};
+
+/** @internal */
+export const AerodromeSwapTokensParams$outboundSchema: z.ZodType<
+  AerodromeSwapTokensParams$Outbound,
+  z.ZodTypeDef,
+  AerodromeSwapTokensParams
+> = z.object({
+  tokenIn: TokenEnum$outboundSchema,
+  tokenOut: TokenEnum$outboundSchema,
+  amountIn: z.union([z.number(), z.string()]),
+  amountOutMin: z.union([z.number(), z.string()]),
+  stable: z.boolean(),
+  to: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    tokenIn: "token_in",
+    tokenOut: "token_out",
+    amountIn: "amount_in",
+    amountOutMin: "amount_out_min",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AerodromeSwapTokensParams$ {
+  /** @deprecated use `AerodromeSwapTokensParams$inboundSchema` instead. */
+  export const inboundSchema = AerodromeSwapTokensParams$inboundSchema;
+  /** @deprecated use `AerodromeSwapTokensParams$outboundSchema` instead. */
+  export const outboundSchema = AerodromeSwapTokensParams$outboundSchema;
+  /** @deprecated use `AerodromeSwapTokensParams$Outbound` instead. */
+  export type Outbound = AerodromeSwapTokensParams$Outbound;
+}
+
+export function aerodromeSwapTokensParamsToJSON(
+  aerodromeSwapTokensParams: AerodromeSwapTokensParams,
+): string {
+  return JSON.stringify(
+    AerodromeSwapTokensParams$outboundSchema.parse(aerodromeSwapTokensParams),
+  );
+}
+
+export function aerodromeSwapTokensParamsFromJSON(
+  jsonString: string,
+): SafeParseResult<AerodromeSwapTokensParams, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AerodromeSwapTokensParams$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AerodromeSwapTokensParams' from JSON`,
+  );
+}

package/src/models/components/chain.ts

@@ -12,6 +12,9 @@ export const Chain = {
   BaseMainnet: "base:mainnet",
   EthereumMainnet: "ethereum:mainnet",
   ArbitrumMainnet: "arbitrum:mainnet",
+  EthereumLocal: "ethereum:local",
+  ArbitrumLocal: "arbitrum:local",
+  BaseLocal: "base:local",
 } as const;
 /**
  * The chain to use.

package/src/models/components/contractname.ts

@@ -0,0 +1,64 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Select the protocol.
+ *
+ * @remarks
+ *
+ * E.g. for increasing ERC-20 allowance.
+ */
+export const ContractName = {
+  AaveV3Pool: "AaveV3Pool",
+  AaveV3Oracle: "AaveV3Oracle",
+  AaveV3ProtocolDataProvider: "AaveV3ProtocolDataProvider",
+  AerodromeBasicFactory: "AerodromeBasicFactory",
+  AerodromeSlipstreamFactory: "AerodromeSlipstreamFactory",
+  AerodromeBasicRouter: "AerodromeBasicRouter",
+  AerodromeSlipstreamRouter: "AerodromeSlipstreamRouter",
+  AerodromeBasicPool: "AerodromeBasicPool",
+  AerodromeSlipstreamPool: "AerodromeSlipstreamPool",
+  AerodromeSlipstreamNonfungiblePositionManager:
+    "AerodromeSlipstreamNonfungiblePositionManager",
+  UniswapV3Pool: "UniswapV3Pool",
+  UniswapV3Router: "UniswapV3Router",
+  UniswapV3Factory: "UniswapV3Factory",
+  UniswapV3NFTPositionManager: "UniswapV3NFTPositionManager",
+  UniswapV3Quoter: "UniswapV3Quoter",
+  ChainlinkEACAggregatorProxy: "ChainlinkEACAggregatorProxy",
+  Morpho: "Morpho",
+  MorphoVault: "MorphoVault",
+  MorphoOracle: "MorphoOracle",
+  Multicall: "Multicall",
+} as const;
+/**
+ * Select the protocol.
+ *
+ * @remarks
+ *
+ * E.g. for increasing ERC-20 allowance.
+ */
+export type ContractName = ClosedEnum<typeof ContractName>;
+
+/** @internal */
+export const ContractName$inboundSchema: z.ZodNativeEnum<typeof ContractName> =
+  z.nativeEnum(ContractName);
+
+/** @internal */
+export const ContractName$outboundSchema: z.ZodNativeEnum<typeof ContractName> =
+  ContractName$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ContractName$ {
+  /** @deprecated use `ContractName$inboundSchema` instead. */
+  export const inboundSchema = ContractName$inboundSchema;
+  /** @deprecated use `ContractName$outboundSchema` instead. */
+  export const outboundSchema = ContractName$outboundSchema;
+}