@compass-labs/api-sdk 0.0.29 → 0.0.31

package/src/models/components/aavestdrateresponse.ts

@@ -0,0 +1,123 @@
+/*
+ * 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";
+
+export type AaveSTDRateResponse = {
+  /**
+   * Standard deviation of the variable rate APY for deposits.
+   */
+  supplyApyVariableRate: number;
+  /**
+   * Standard deviation of the variable rate APR for deposits.
+   */
+  supplyAprVariableRate: number;
+  /**
+   * Standard deviation of the variable rate APY for loans.
+   */
+  borrowApyVariableRate: number;
+  /**
+   * Standard deviation of the variable rate APR for loans.
+   */
+  borrowAprVariableRate: number;
+  /**
+   * Standard deviation of the fixed rate APY for loans.
+   */
+  borrowApyFixedRate: number;
+  /**
+   * Standard deviation of the fixed rate APR for loans.
+   */
+  borrowAprFixedRate: number;
+};
+
+/** @internal */
+export const AaveSTDRateResponse$inboundSchema: z.ZodType<
+  AaveSTDRateResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  supply_apy_variable_rate: z.number(),
+  supply_apr_variable_rate: z.number(),
+  borrow_apy_variable_rate: z.number(),
+  borrow_apr_variable_rate: z.number(),
+  borrow_apy_fixed_rate: z.number(),
+  borrow_apr_fixed_rate: z.number(),
+}).transform((v) => {
+  return remap$(v, {
+    "supply_apy_variable_rate": "supplyApyVariableRate",
+    "supply_apr_variable_rate": "supplyAprVariableRate",
+    "borrow_apy_variable_rate": "borrowApyVariableRate",
+    "borrow_apr_variable_rate": "borrowAprVariableRate",
+    "borrow_apy_fixed_rate": "borrowApyFixedRate",
+    "borrow_apr_fixed_rate": "borrowAprFixedRate",
+  });
+});
+
+/** @internal */
+export type AaveSTDRateResponse$Outbound = {
+  supply_apy_variable_rate: number;
+  supply_apr_variable_rate: number;
+  borrow_apy_variable_rate: number;
+  borrow_apr_variable_rate: number;
+  borrow_apy_fixed_rate: number;
+  borrow_apr_fixed_rate: number;
+};
+
+/** @internal */
+export const AaveSTDRateResponse$outboundSchema: z.ZodType<
+  AaveSTDRateResponse$Outbound,
+  z.ZodTypeDef,
+  AaveSTDRateResponse
+> = z.object({
+  supplyApyVariableRate: z.number(),
+  supplyAprVariableRate: z.number(),
+  borrowApyVariableRate: z.number(),
+  borrowAprVariableRate: z.number(),
+  borrowApyFixedRate: z.number(),
+  borrowAprFixedRate: z.number(),
+}).transform((v) => {
+  return remap$(v, {
+    supplyApyVariableRate: "supply_apy_variable_rate",
+    supplyAprVariableRate: "supply_apr_variable_rate",
+    borrowApyVariableRate: "borrow_apy_variable_rate",
+    borrowAprVariableRate: "borrow_apr_variable_rate",
+    borrowApyFixedRate: "borrow_apy_fixed_rate",
+    borrowAprFixedRate: "borrow_apr_fixed_rate",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AaveSTDRateResponse$ {
+  /** @deprecated use `AaveSTDRateResponse$inboundSchema` instead. */
+  export const inboundSchema = AaveSTDRateResponse$inboundSchema;
+  /** @deprecated use `AaveSTDRateResponse$outboundSchema` instead. */
+  export const outboundSchema = AaveSTDRateResponse$outboundSchema;
+  /** @deprecated use `AaveSTDRateResponse$Outbound` instead. */
+  export type Outbound = AaveSTDRateResponse$Outbound;
+}
+
+export function aaveSTDRateResponseToJSON(
+  aaveSTDRateResponse: AaveSTDRateResponse,
+): string {
+  return JSON.stringify(
+    AaveSTDRateResponse$outboundSchema.parse(aaveSTDRateResponse),
+  );
+}
+
+export function aaveSTDRateResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<AaveSTDRateResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AaveSTDRateResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AaveSTDRateResponse' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -12,6 +12,7 @@ export * from "./aaverateresponse.js";
 export * from "./aaverepayparams.js";
 export * from "./aaverepayrequest.js";
 export * from "./aavereserveoverviewresponse.js";
+export * from "./aavestdrateresponse.js";
 export * from "./aavesupplyparams.js";
 export * from "./aavesupplyrequest.js";
 export * from "./aavetokenpriceresponse.js";

package/src/models/operations/aavestdrate.ts

@@ -0,0 +1,203 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * The chain to use.
+ */
+export const AaveStdRateChain = {
+  BaseMainnet: "base:mainnet",
+  EthereumMainnet: "ethereum:mainnet",
+  ArbitrumMainnet: "arbitrum:mainnet",
+} as const;
+/**
+ * The chain to use.
+ */
+export type AaveStdRateChain = ClosedEnum<typeof AaveStdRateChain>;
+
+/**
+ * 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.
+ */
+export const AaveStdRateToken = {
+  OneINCH: "1INCH",
+  Aave: "AAVE",
+  Bal: "BAL",
+  CbBTC: "cbBTC",
+  CbETH: "cbETH",
+  Crv: "CRV",
+  CrvUSD: "crvUSD",
+  Dai: "DAI",
+  Ens: "ENS",
+  ETHx: "ETHx",
+  Frax: "FRAX",
+  Fxs: "FXS",
+  Gho: "GHO",
+  Knc: "KNC",
+  Ldo: "LDO",
+  Link: "LINK",
+  Lusd: "LUSD",
+  Mkr: "MKR",
+  OsETH: "osETH",
+  Pyusd: "PYUSD",
+  RETH: "rETH",
+  Rpl: "RPL",
+  RsETH: "rsETH",
+  SDAI: "sDAI",
+  Snx: "SNX",
+  Stg: "STG",
+  SUSDe: "sUSDe",
+  TBTC: "tBTC",
+  Uni: "UNI",
+  Usdc: "USDC",
+  USDe: "USDe",
+  Usds: "USDS",
+  Usdt: "USDT",
+  Wbtc: "WBTC",
+  WeETH: "weETH",
+  Weth: "WETH",
+  WstETH: "wstETH",
+  Arb: "ARB",
+  Eurs: "EURS",
+  Mai: "MAI",
+  USDCe: "USDCe",
+  Aero: "AERO",
+  Eur: "EUR",
+  Virtual: "VIRTUAL",
+} as const;
+/**
+ * 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.
+ */
+export type AaveStdRateToken = ClosedEnum<typeof AaveStdRateToken>;
+
+export type AaveStdRateRequest = {
+  /**
+   * The chain to use.
+   */
+  chain?: AaveStdRateChain | undefined;
+  /**
+   * The symbol of the asset to fetch the user's position on..
+   */
+  token?: AaveStdRateToken | undefined;
+  /**
+   * The number of days to fetch the user's position on.
+   */
+  days?: number | undefined;
+};
+
+/** @internal */
+export const AaveStdRateChain$inboundSchema: z.ZodNativeEnum<
+  typeof AaveStdRateChain
+> = z.nativeEnum(AaveStdRateChain);
+
+/** @internal */
+export const AaveStdRateChain$outboundSchema: z.ZodNativeEnum<
+  typeof AaveStdRateChain
+> = AaveStdRateChain$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AaveStdRateChain$ {
+  /** @deprecated use `AaveStdRateChain$inboundSchema` instead. */
+  export const inboundSchema = AaveStdRateChain$inboundSchema;
+  /** @deprecated use `AaveStdRateChain$outboundSchema` instead. */
+  export const outboundSchema = AaveStdRateChain$outboundSchema;
+}
+
+/** @internal */
+export const AaveStdRateToken$inboundSchema: z.ZodNativeEnum<
+  typeof AaveStdRateToken
+> = z.nativeEnum(AaveStdRateToken);
+
+/** @internal */
+export const AaveStdRateToken$outboundSchema: z.ZodNativeEnum<
+  typeof AaveStdRateToken
+> = AaveStdRateToken$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AaveStdRateToken$ {
+  /** @deprecated use `AaveStdRateToken$inboundSchema` instead. */
+  export const inboundSchema = AaveStdRateToken$inboundSchema;
+  /** @deprecated use `AaveStdRateToken$outboundSchema` instead. */
+  export const outboundSchema = AaveStdRateToken$outboundSchema;
+}
+
+/** @internal */
+export const AaveStdRateRequest$inboundSchema: z.ZodType<
+  AaveStdRateRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  chain: AaveStdRateChain$inboundSchema.default("ethereum:mainnet"),
+  token: AaveStdRateToken$inboundSchema.default("USDC"),
+  days: z.number().int().default(7),
+});
+
+/** @internal */
+export type AaveStdRateRequest$Outbound = {
+  chain: string;
+  token: string;
+  days: number;
+};
+
+/** @internal */
+export const AaveStdRateRequest$outboundSchema: z.ZodType<
+  AaveStdRateRequest$Outbound,
+  z.ZodTypeDef,
+  AaveStdRateRequest
+> = z.object({
+  chain: AaveStdRateChain$outboundSchema.default("ethereum:mainnet"),
+  token: AaveStdRateToken$outboundSchema.default("USDC"),
+  days: z.number().int().default(7),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AaveStdRateRequest$ {
+  /** @deprecated use `AaveStdRateRequest$inboundSchema` instead. */
+  export const inboundSchema = AaveStdRateRequest$inboundSchema;
+  /** @deprecated use `AaveStdRateRequest$outboundSchema` instead. */
+  export const outboundSchema = AaveStdRateRequest$outboundSchema;
+  /** @deprecated use `AaveStdRateRequest$Outbound` instead. */
+  export type Outbound = AaveStdRateRequest$Outbound;
+}
+
+export function aaveStdRateRequestToJSON(
+  aaveStdRateRequest: AaveStdRateRequest,
+): string {
+  return JSON.stringify(
+    AaveStdRateRequest$outboundSchema.parse(aaveStdRateRequest),
+  );
+}
+
+export function aaveStdRateRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<AaveStdRateRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AaveStdRateRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AaveStdRateRequest' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -7,6 +7,7 @@ export * from "./aavehistoricaltransactions.js";
 export * from "./aaveliquiditychange.js";
 export * from "./aaverate.js";
 export * from "./aavereserveoverview.js";
+export * from "./aavestdrate.js";
 export * from "./aavetokenprice.js";
 export * from "./aaveuserpositionpertoken.js";
 export * from "./aaveuserpositionsummary.js";

package/src/sdk/aavev3.ts

@@ -9,6 +9,7 @@ import { aaveV3LiquidityChange } from "../funcs/aaveV3LiquidityChange.js";
 import { aaveV3Rate } from "../funcs/aaveV3Rate.js";
 import { aaveV3Repay } from "../funcs/aaveV3Repay.js";
 import { aaveV3ReserveOverview } from "../funcs/aaveV3ReserveOverview.js";
+import { aaveV3StdRate } from "../funcs/aaveV3StdRate.js";
 import { aaveV3Supply } from "../funcs/aaveV3Supply.js";
 import { aaveV3TokenPrice } from "../funcs/aaveV3TokenPrice.js";
 import { aaveV3UserPositionPerToken } from "../funcs/aaveV3UserPositionPerToken.js";
@@ -20,6 +21,23 @@ import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class AaveV3 extends ClientSDK {
+  /**
+   * Standard deviation of interest rates
+   *
+   * @remarks
+   * Returns the standard deviation of Interest Rates for Aave Reserves over time:
+   */
+  async stdRate(
+    request: operations.AaveStdRateRequest,
+    options?: RequestOptions,
+  ): Promise<components.AaveSTDRateResponse> {
+    return unwrapAsync(aaveV3StdRate(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Average interest rates
    *