@compass-labs/api-sdk 1.5.1 → 1.5.2

package/src/models/components/vaultinfo.ts

@@ -0,0 +1,398 @@
+/*
+ * 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";
+
+/**
+ * Information about a single DeFi vault.
+ */
+export type VaultInfo = {
+  /**
+   * Unique vault identifier.
+   */
+  id?: string | null | undefined;
+  /**
+   * The name of the vault.
+   */
+  name: string;
+  /**
+   * The vault contract address.
+   */
+  address: string;
+  /**
+   * The DeFi protocol name.
+   */
+  protocol: string;
+  /**
+   * Blockchain name (e.g., 'ethereum', 'base').
+   */
+  chain?: string | null | undefined;
+  /**
+   * Blockchain chain ID.
+   */
+  chainId?: number | null | undefined;
+  /**
+   * The denomination token symbol (underlying asset).
+   */
+  denomination: string;
+  /**
+   * The vault share token symbol.
+   */
+  shareToken: string;
+  /**
+   * Whether the vault is denominated in a stablecoin.
+   */
+  stablecoinish: boolean;
+  /**
+   * Total lifetime return as a decimal (e.g., 0.093 = 9.3%).
+   */
+  lifetimeReturn?: string | null | undefined;
+  /**
+   * Total lifetime return after fees as a decimal.
+   */
+  lifetimeReturnNet?: string | null | undefined;
+  /**
+   * Compound Annual Growth Rate as a decimal.
+   */
+  cagr?: string | null | undefined;
+  /**
+   * Compound Annual Growth Rate after fees as a decimal.
+   */
+  cagrNet?: string | null | undefined;
+  /**
+   * 3-month returns as a decimal.
+   */
+  threeMonthsReturns?: string | null | undefined;
+  /**
+   * 3-month returns after fees as a decimal.
+   */
+  threeMonthsReturnsNet?: string | null | undefined;
+  /**
+   * 3-month CAGR as a decimal.
+   */
+  threeMonthsCagr?: string | null | undefined;
+  /**
+   * 3-month CAGR after fees as a decimal.
+   */
+  threeMonthsCagrNet?: string | null | undefined;
+  /**
+   * 3-month Sharpe ratio.
+   */
+  threeMonthsSharpe?: string | null | undefined;
+  /**
+   * 3-month Sharpe ratio after fees.
+   */
+  threeMonthsSharpeNet?: string | null | undefined;
+  /**
+   * 3-month volatility.
+   */
+  threeMonthsVolatility?: string | null | undefined;
+  /**
+   * 1-month returns as a decimal.
+   */
+  oneMonthReturns?: string | null | undefined;
+  /**
+   * 1-month returns after fees as a decimal.
+   */
+  oneMonthReturnsNet?: string | null | undefined;
+  /**
+   * 1-month CAGR as a decimal.
+   */
+  oneMonthCagr?: string | null | undefined;
+  /**
+   * 1-month CAGR after fees as a decimal.
+   */
+  oneMonthCagrNet?: string | null | undefined;
+  /**
+   * Current Net Asset Value in denomination token.
+   */
+  currentNav?: string | null | undefined;
+  /**
+   * Peak Net Asset Value in denomination token.
+   */
+  peakNav?: string | null | undefined;
+  /**
+   * Risk classification label (e.g., 'low', 'medium', 'high').
+   */
+  risk?: string | null | undefined;
+  /**
+   * Numeric risk score.
+   */
+  riskNumeric?: string | null | undefined;
+  /**
+   * Human-readable fee structure label.
+   */
+  feeLabel?: string | null | undefined;
+  /**
+   * Management fee as a decimal.
+   */
+  managementFee?: string | null | undefined;
+  /**
+   * Performance fee as a decimal.
+   */
+  performanceFee?: string | null | undefined;
+  /**
+   * Deposit fee as a decimal.
+   */
+  depositFee?: string | null | undefined;
+  /**
+   * Withdrawal fee as a decimal.
+   */
+  withdrawFee?: string | null | undefined;
+  /**
+   * Age of the vault in years.
+   */
+  years?: string | null | undefined;
+  /**
+   * Number of events/transactions in the vault.
+   */
+  eventCount?: number | null | undefined;
+  /**
+   * List of vault features and capabilities.
+   */
+  features?: Array<string> | null | undefined;
+  /**
+   * Vault start date (first deposit).
+   */
+  startDate?: Date | null | undefined;
+  /**
+   * Vault end date (if applicable).
+   */
+  endDate?: Date | null | undefined;
+  /**
+   * Last update timestamp.
+   */
+  lastUpdatedAt?: Date | null | undefined;
+  /**
+   * Block number of last update.
+   */
+  lastUpdatedBlock?: number | null | undefined;
+};
+
+/** @internal */
+export const VaultInfo$inboundSchema: z.ZodType<
+  VaultInfo,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.nullable(z.string()).optional(),
+  name: z.string(),
+  address: z.string(),
+  protocol: z.string(),
+  chain: z.nullable(z.string()).optional(),
+  chain_id: z.nullable(z.number().int()).optional(),
+  denomination: z.string(),
+  share_token: z.string(),
+  stablecoinish: z.boolean(),
+  lifetime_return: z.nullable(z.string()).optional(),
+  lifetime_return_net: z.nullable(z.string()).optional(),
+  cagr: z.nullable(z.string()).optional(),
+  cagr_net: z.nullable(z.string()).optional(),
+  three_months_returns: z.nullable(z.string()).optional(),
+  three_months_returns_net: z.nullable(z.string()).optional(),
+  three_months_cagr: z.nullable(z.string()).optional(),
+  three_months_cagr_net: z.nullable(z.string()).optional(),
+  three_months_sharpe: z.nullable(z.string()).optional(),
+  three_months_sharpe_net: z.nullable(z.string()).optional(),
+  three_months_volatility: z.nullable(z.string()).optional(),
+  one_month_returns: z.nullable(z.string()).optional(),
+  one_month_returns_net: z.nullable(z.string()).optional(),
+  one_month_cagr: z.nullable(z.string()).optional(),
+  one_month_cagr_net: z.nullable(z.string()).optional(),
+  current_nav: z.nullable(z.string()).optional(),
+  peak_nav: z.nullable(z.string()).optional(),
+  risk: z.nullable(z.string()).optional(),
+  risk_numeric: z.nullable(z.string()).optional(),
+  fee_label: z.nullable(z.string()).optional(),
+  management_fee: z.nullable(z.string()).optional(),
+  performance_fee: z.nullable(z.string()).optional(),
+  deposit_fee: z.nullable(z.string()).optional(),
+  withdraw_fee: z.nullable(z.string()).optional(),
+  years: z.nullable(z.string()).optional(),
+  event_count: z.nullable(z.number().int()).optional(),
+  features: z.nullable(z.array(z.string())).optional(),
+  start_date: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+  end_date: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+  last_updated_at: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+  last_updated_block: z.nullable(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "chain_id": "chainId",
+    "share_token": "shareToken",
+    "lifetime_return": "lifetimeReturn",
+    "lifetime_return_net": "lifetimeReturnNet",
+    "cagr_net": "cagrNet",
+    "three_months_returns": "threeMonthsReturns",
+    "three_months_returns_net": "threeMonthsReturnsNet",
+    "three_months_cagr": "threeMonthsCagr",
+    "three_months_cagr_net": "threeMonthsCagrNet",
+    "three_months_sharpe": "threeMonthsSharpe",
+    "three_months_sharpe_net": "threeMonthsSharpeNet",
+    "three_months_volatility": "threeMonthsVolatility",
+    "one_month_returns": "oneMonthReturns",
+    "one_month_returns_net": "oneMonthReturnsNet",
+    "one_month_cagr": "oneMonthCagr",
+    "one_month_cagr_net": "oneMonthCagrNet",
+    "current_nav": "currentNav",
+    "peak_nav": "peakNav",
+    "risk_numeric": "riskNumeric",
+    "fee_label": "feeLabel",
+    "management_fee": "managementFee",
+    "performance_fee": "performanceFee",
+    "deposit_fee": "depositFee",
+    "withdraw_fee": "withdrawFee",
+    "event_count": "eventCount",
+    "start_date": "startDate",
+    "end_date": "endDate",
+    "last_updated_at": "lastUpdatedAt",
+    "last_updated_block": "lastUpdatedBlock",
+  });
+});
+/** @internal */
+export type VaultInfo$Outbound = {
+  id?: string | null | undefined;
+  name: string;
+  address: string;
+  protocol: string;
+  chain?: string | null | undefined;
+  chain_id?: number | null | undefined;
+  denomination: string;
+  share_token: string;
+  stablecoinish: boolean;
+  lifetime_return?: string | null | undefined;
+  lifetime_return_net?: string | null | undefined;
+  cagr?: string | null | undefined;
+  cagr_net?: string | null | undefined;
+  three_months_returns?: string | null | undefined;
+  three_months_returns_net?: string | null | undefined;
+  three_months_cagr?: string | null | undefined;
+  three_months_cagr_net?: string | null | undefined;
+  three_months_sharpe?: string | null | undefined;
+  three_months_sharpe_net?: string | null | undefined;
+  three_months_volatility?: string | null | undefined;
+  one_month_returns?: string | null | undefined;
+  one_month_returns_net?: string | null | undefined;
+  one_month_cagr?: string | null | undefined;
+  one_month_cagr_net?: string | null | undefined;
+  current_nav?: string | null | undefined;
+  peak_nav?: string | null | undefined;
+  risk?: string | null | undefined;
+  risk_numeric?: string | null | undefined;
+  fee_label?: string | null | undefined;
+  management_fee?: string | null | undefined;
+  performance_fee?: string | null | undefined;
+  deposit_fee?: string | null | undefined;
+  withdraw_fee?: string | null | undefined;
+  years?: string | null | undefined;
+  event_count?: number | null | undefined;
+  features?: Array<string> | null | undefined;
+  start_date?: string | null | undefined;
+  end_date?: string | null | undefined;
+  last_updated_at?: string | null | undefined;
+  last_updated_block?: number | null | undefined;
+};
+
+/** @internal */
+export const VaultInfo$outboundSchema: z.ZodType<
+  VaultInfo$Outbound,
+  z.ZodTypeDef,
+  VaultInfo
+> = z.object({
+  id: z.nullable(z.string()).optional(),
+  name: z.string(),
+  address: z.string(),
+  protocol: z.string(),
+  chain: z.nullable(z.string()).optional(),
+  chainId: z.nullable(z.number().int()).optional(),
+  denomination: z.string(),
+  shareToken: z.string(),
+  stablecoinish: z.boolean(),
+  lifetimeReturn: z.nullable(z.string()).optional(),
+  lifetimeReturnNet: z.nullable(z.string()).optional(),
+  cagr: z.nullable(z.string()).optional(),
+  cagrNet: z.nullable(z.string()).optional(),
+  threeMonthsReturns: z.nullable(z.string()).optional(),
+  threeMonthsReturnsNet: z.nullable(z.string()).optional(),
+  threeMonthsCagr: z.nullable(z.string()).optional(),
+  threeMonthsCagrNet: z.nullable(z.string()).optional(),
+  threeMonthsSharpe: z.nullable(z.string()).optional(),
+  threeMonthsSharpeNet: z.nullable(z.string()).optional(),
+  threeMonthsVolatility: z.nullable(z.string()).optional(),
+  oneMonthReturns: z.nullable(z.string()).optional(),
+  oneMonthReturnsNet: z.nullable(z.string()).optional(),
+  oneMonthCagr: z.nullable(z.string()).optional(),
+  oneMonthCagrNet: z.nullable(z.string()).optional(),
+  currentNav: z.nullable(z.string()).optional(),
+  peakNav: z.nullable(z.string()).optional(),
+  risk: z.nullable(z.string()).optional(),
+  riskNumeric: z.nullable(z.string()).optional(),
+  feeLabel: z.nullable(z.string()).optional(),
+  managementFee: z.nullable(z.string()).optional(),
+  performanceFee: z.nullable(z.string()).optional(),
+  depositFee: z.nullable(z.string()).optional(),
+  withdrawFee: z.nullable(z.string()).optional(),
+  years: z.nullable(z.string()).optional(),
+  eventCount: z.nullable(z.number().int()).optional(),
+  features: z.nullable(z.array(z.string())).optional(),
+  startDate: z.nullable(z.date().transform(v => v.toISOString())).optional(),
+  endDate: z.nullable(z.date().transform(v => v.toISOString())).optional(),
+  lastUpdatedAt: z.nullable(z.date().transform(v => v.toISOString()))
+    .optional(),
+  lastUpdatedBlock: z.nullable(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    chainId: "chain_id",
+    shareToken: "share_token",
+    lifetimeReturn: "lifetime_return",
+    lifetimeReturnNet: "lifetime_return_net",
+    cagrNet: "cagr_net",
+    threeMonthsReturns: "three_months_returns",
+    threeMonthsReturnsNet: "three_months_returns_net",
+    threeMonthsCagr: "three_months_cagr",
+    threeMonthsCagrNet: "three_months_cagr_net",
+    threeMonthsSharpe: "three_months_sharpe",
+    threeMonthsSharpeNet: "three_months_sharpe_net",
+    threeMonthsVolatility: "three_months_volatility",
+    oneMonthReturns: "one_month_returns",
+    oneMonthReturnsNet: "one_month_returns_net",
+    oneMonthCagr: "one_month_cagr",
+    oneMonthCagrNet: "one_month_cagr_net",
+    currentNav: "current_nav",
+    peakNav: "peak_nav",
+    riskNumeric: "risk_numeric",
+    feeLabel: "fee_label",
+    managementFee: "management_fee",
+    performanceFee: "performance_fee",
+    depositFee: "deposit_fee",
+    withdrawFee: "withdraw_fee",
+    eventCount: "event_count",
+    startDate: "start_date",
+    endDate: "end_date",
+    lastUpdatedAt: "last_updated_at",
+    lastUpdatedBlock: "last_updated_block",
+  });
+});
+
+export function vaultInfoToJSON(vaultInfo: VaultInfo): string {
+  return JSON.stringify(VaultInfo$outboundSchema.parse(vaultInfo));
+}
+export function vaultInfoFromJSON(
+  jsonString: string,
+): SafeParseResult<VaultInfo, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VaultInfo$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VaultInfo' from JSON`,
+  );
+}

package/src/models/components/{vaultdeposit.ts → vaultmarket.ts}

@@ -8,20 +8,20 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-export type VaultDeposit = {
+export type VaultMarket = {
   /**
    * The market type discriminator.
    */
   type?: "VAULT" | undefined;
   /**
-   * The vault address you are depositing to.
+   * The vault address you are interacting with for this action.
    */
   vaultAddress: string;
 };
 
 /** @internal */
-export const VaultDeposit$inboundSchema: z.ZodType<
-  VaultDeposit,
+export const VaultMarket$inboundSchema: z.ZodType<
+  VaultMarket,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -33,16 +33,16 @@ export const VaultDeposit$inboundSchema: z.ZodType<
   });
 });
 /** @internal */
-export type VaultDeposit$Outbound = {
+export type VaultMarket$Outbound = {
   type: "VAULT";
   vault_address: string;
 };
 
 /** @internal */
-export const VaultDeposit$outboundSchema: z.ZodType<
-  VaultDeposit$Outbound,
+export const VaultMarket$outboundSchema: z.ZodType<
+  VaultMarket$Outbound,
   z.ZodTypeDef,
-  VaultDeposit
+  VaultMarket
 > = z.object({
   type: z.literal("VAULT"),
   vaultAddress: z.string(),
@@ -52,15 +52,15 @@ export const VaultDeposit$outboundSchema: z.ZodType<
   });
 });
 
-export function vaultDepositToJSON(vaultDeposit: VaultDeposit): string {
-  return JSON.stringify(VaultDeposit$outboundSchema.parse(vaultDeposit));
+export function vaultMarketToJSON(vaultMarket: VaultMarket): string {
+  return JSON.stringify(VaultMarket$outboundSchema.parse(vaultMarket));
 }
-export function vaultDepositFromJSON(
+export function vaultMarketFromJSON(
   jsonString: string,
-): SafeParseResult<VaultDeposit, SDKValidationError> {
+): SafeParseResult<VaultMarket, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => VaultDeposit$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'VaultDeposit' from JSON`,
+    (x) => VaultMarket$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VaultMarket' from JSON`,
   );
 }

package/src/models/components/vaultslistresponse.ts

@@ -0,0 +1,75 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  VaultInfo,
+  VaultInfo$inboundSchema,
+  VaultInfo$Outbound,
+  VaultInfo$outboundSchema,
+} from "./vaultinfo.js";
+
+/**
+ * Response model for a paginated list of DeFi vaults.
+ */
+export type VaultsListResponse = {
+  total: number;
+  offset: number;
+  limit: number;
+  /**
+   * A list of vault information objects.
+   */
+  vaults: Array<VaultInfo>;
+};
+
+/** @internal */
+export const VaultsListResponse$inboundSchema: z.ZodType<
+  VaultsListResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  total: z.number().int(),
+  offset: z.number().int(),
+  limit: z.number().int(),
+  vaults: z.array(VaultInfo$inboundSchema),
+});
+/** @internal */
+export type VaultsListResponse$Outbound = {
+  total: number;
+  offset: number;
+  limit: number;
+  vaults: Array<VaultInfo$Outbound>;
+};
+
+/** @internal */
+export const VaultsListResponse$outboundSchema: z.ZodType<
+  VaultsListResponse$Outbound,
+  z.ZodTypeDef,
+  VaultsListResponse
+> = z.object({
+  total: z.number().int(),
+  offset: z.number().int(),
+  limit: z.number().int(),
+  vaults: z.array(VaultInfo$outboundSchema),
+});
+
+export function vaultsListResponseToJSON(
+  vaultsListResponse: VaultsListResponse,
+): string {
+  return JSON.stringify(
+    VaultsListResponse$outboundSchema.parse(vaultsListResponse),
+  );
+}
+export function vaultsListResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<VaultsListResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VaultsListResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VaultsListResponse' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -41,3 +41,5 @@ export * from "./v1uniswapquotesellexactly.js";
 export * from "./v1vaultsvault.js";
 export * from "./v1wildcatmarket.js";
 export * from "./v2earnpositions.js";
+export * from "./v2earnpositionspositionid.js";
+export * from "./v2earnvaults.js";

package/src/models/operations/v2earnpositionspositionid.ts

@@ -0,0 +1,81 @@
+/*
+ * 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";
+
+export type V2EarnPositionsPositionIdRequest = {
+  /**
+   * Base64-encoded position identifier
+   */
+  positionId: string;
+  /**
+   * The address of the user to get the position for.
+   */
+  userAddress: string;
+  /**
+   * How many days back from the current time to include in the blockchain scan (vault positions only).
+   */
+  days?: number | undefined;
+};
+
+/** @internal */
+export const V2EarnPositionsPositionIdRequest$inboundSchema: z.ZodType<
+  V2EarnPositionsPositionIdRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  position_id: z.string(),
+  user_address: z.string(),
+  days: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "position_id": "positionId",
+    "user_address": "userAddress",
+  });
+});
+/** @internal */
+export type V2EarnPositionsPositionIdRequest$Outbound = {
+  position_id: string;
+  user_address: string;
+  days?: number | undefined;
+};
+
+/** @internal */
+export const V2EarnPositionsPositionIdRequest$outboundSchema: z.ZodType<
+  V2EarnPositionsPositionIdRequest$Outbound,
+  z.ZodTypeDef,
+  V2EarnPositionsPositionIdRequest
+> = z.object({
+  positionId: z.string(),
+  userAddress: z.string(),
+  days: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    positionId: "position_id",
+    userAddress: "user_address",
+  });
+});
+
+export function v2EarnPositionsPositionIdRequestToJSON(
+  v2EarnPositionsPositionIdRequest: V2EarnPositionsPositionIdRequest,
+): string {
+  return JSON.stringify(
+    V2EarnPositionsPositionIdRequest$outboundSchema.parse(
+      v2EarnPositionsPositionIdRequest,
+    ),
+  );
+}
+export function v2EarnPositionsPositionIdRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<V2EarnPositionsPositionIdRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => V2EarnPositionsPositionIdRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V2EarnPositionsPositionIdRequest' from JSON`,
+  );
+}