@compass-labs/api-sdk 0.0.22 → 0.0.23

package/src/models/components/aavereserveoverviewresponse.ts

@@ -0,0 +1,96 @@
+/*
+ * 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 AaveReserveOverviewResponse = {
+  /**
+   * Total tokens supplied in an Aave Reserve in USD. E.G. How much WBTC has been supplied on Aave in USD.
+   */
+  tvl: number;
+  /**
+   * Total tokens borrowed in an Aave Reserve converted to USD. E.G. How much WBTC has been supplied on Aave (in USD).
+   */
+  totalBorrowed: number;
+  /**
+   * Total borrowed divided by total supplied in an Aave Reserve. E.G. How much WBTC has been borrowed on Aaave divided by the amount supplied
+   */
+  utilizationRatio: number;
+};
+
+/** @internal */
+export const AaveReserveOverviewResponse$inboundSchema: z.ZodType<
+  AaveReserveOverviewResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  tvl: z.number(),
+  total_borrowed: z.number(),
+  utilization_ratio: z.number(),
+}).transform((v) => {
+  return remap$(v, {
+    "total_borrowed": "totalBorrowed",
+    "utilization_ratio": "utilizationRatio",
+  });
+});
+
+/** @internal */
+export type AaveReserveOverviewResponse$Outbound = {
+  tvl: number;
+  total_borrowed: number;
+  utilization_ratio: number;
+};
+
+/** @internal */
+export const AaveReserveOverviewResponse$outboundSchema: z.ZodType<
+  AaveReserveOverviewResponse$Outbound,
+  z.ZodTypeDef,
+  AaveReserveOverviewResponse
+> = z.object({
+  tvl: z.number(),
+  totalBorrowed: z.number(),
+  utilizationRatio: z.number(),
+}).transform((v) => {
+  return remap$(v, {
+    totalBorrowed: "total_borrowed",
+    utilizationRatio: "utilization_ratio",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AaveReserveOverviewResponse$ {
+  /** @deprecated use `AaveReserveOverviewResponse$inboundSchema` instead. */
+  export const inboundSchema = AaveReserveOverviewResponse$inboundSchema;
+  /** @deprecated use `AaveReserveOverviewResponse$outboundSchema` instead. */
+  export const outboundSchema = AaveReserveOverviewResponse$outboundSchema;
+  /** @deprecated use `AaveReserveOverviewResponse$Outbound` instead. */
+  export type Outbound = AaveReserveOverviewResponse$Outbound;
+}
+
+export function aaveReserveOverviewResponseToJSON(
+  aaveReserveOverviewResponse: AaveReserveOverviewResponse,
+): string {
+  return JSON.stringify(
+    AaveReserveOverviewResponse$outboundSchema.parse(
+      aaveReserveOverviewResponse,
+    ),
+  );
+}
+
+export function aaveReserveOverviewResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<AaveReserveOverviewResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AaveReserveOverviewResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AaveReserveOverviewResponse' from JSON`,
+  );
+}

package/src/models/components/index.ts

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

package/src/models/operations/aavereserveoverview.ts

@@ -0,0 +1,205 @@
+/*
+ * 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 AaveReserveOverviewChain = {
+  BaseMainnet: "base:mainnet",
+  EthereumMainnet: "ethereum:mainnet",
+  ArbitrumMainnet: "arbitrum:mainnet",
+} as const;
+/**
+ * The chain to use.
+ */
+export type AaveReserveOverviewChain = ClosedEnum<
+  typeof AaveReserveOverviewChain
+>;
+
+/**
+ * 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 AaveReserveOverviewToken = {
+  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 AaveReserveOverviewToken = ClosedEnum<
+  typeof AaveReserveOverviewToken
+>;
+
+export type AaveReserveOverviewRequest = {
+  /**
+   * The chain to use.
+   */
+  chain?: AaveReserveOverviewChain | undefined;
+  /**
+   * 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?: AaveReserveOverviewToken | undefined;
+};
+
+/** @internal */
+export const AaveReserveOverviewChain$inboundSchema: z.ZodNativeEnum<
+  typeof AaveReserveOverviewChain
+> = z.nativeEnum(AaveReserveOverviewChain);
+
+/** @internal */
+export const AaveReserveOverviewChain$outboundSchema: z.ZodNativeEnum<
+  typeof AaveReserveOverviewChain
+> = AaveReserveOverviewChain$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AaveReserveOverviewChain$ {
+  /** @deprecated use `AaveReserveOverviewChain$inboundSchema` instead. */
+  export const inboundSchema = AaveReserveOverviewChain$inboundSchema;
+  /** @deprecated use `AaveReserveOverviewChain$outboundSchema` instead. */
+  export const outboundSchema = AaveReserveOverviewChain$outboundSchema;
+}
+
+/** @internal */
+export const AaveReserveOverviewToken$inboundSchema: z.ZodNativeEnum<
+  typeof AaveReserveOverviewToken
+> = z.nativeEnum(AaveReserveOverviewToken);
+
+/** @internal */
+export const AaveReserveOverviewToken$outboundSchema: z.ZodNativeEnum<
+  typeof AaveReserveOverviewToken
+> = AaveReserveOverviewToken$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AaveReserveOverviewToken$ {
+  /** @deprecated use `AaveReserveOverviewToken$inboundSchema` instead. */
+  export const inboundSchema = AaveReserveOverviewToken$inboundSchema;
+  /** @deprecated use `AaveReserveOverviewToken$outboundSchema` instead. */
+  export const outboundSchema = AaveReserveOverviewToken$outboundSchema;
+}
+
+/** @internal */
+export const AaveReserveOverviewRequest$inboundSchema: z.ZodType<
+  AaveReserveOverviewRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  chain: AaveReserveOverviewChain$inboundSchema.default("arbitrum:mainnet"),
+  token: AaveReserveOverviewToken$inboundSchema.default("USDC"),
+});
+
+/** @internal */
+export type AaveReserveOverviewRequest$Outbound = {
+  chain: string;
+  token: string;
+};
+
+/** @internal */
+export const AaveReserveOverviewRequest$outboundSchema: z.ZodType<
+  AaveReserveOverviewRequest$Outbound,
+  z.ZodTypeDef,
+  AaveReserveOverviewRequest
+> = z.object({
+  chain: AaveReserveOverviewChain$outboundSchema.default("arbitrum:mainnet"),
+  token: AaveReserveOverviewToken$outboundSchema.default("USDC"),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AaveReserveOverviewRequest$ {
+  /** @deprecated use `AaveReserveOverviewRequest$inboundSchema` instead. */
+  export const inboundSchema = AaveReserveOverviewRequest$inboundSchema;
+  /** @deprecated use `AaveReserveOverviewRequest$outboundSchema` instead. */
+  export const outboundSchema = AaveReserveOverviewRequest$outboundSchema;
+  /** @deprecated use `AaveReserveOverviewRequest$Outbound` instead. */
+  export type Outbound = AaveReserveOverviewRequest$Outbound;
+}
+
+export function aaveReserveOverviewRequestToJSON(
+  aaveReserveOverviewRequest: AaveReserveOverviewRequest,
+): string {
+  return JSON.stringify(
+    AaveReserveOverviewRequest$outboundSchema.parse(aaveReserveOverviewRequest),
+  );
+}
+
+export function aaveReserveOverviewRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<AaveReserveOverviewRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AaveReserveOverviewRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AaveReserveOverviewRequest' from JSON`,
+  );
+}

package/src/models/operations/index.ts

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

package/src/sdk/aavev3.ts

@@ -7,6 +7,7 @@ import { aaveV3HistoricalTransactions } from "../funcs/aaveV3HistoricalTransacti
 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 { aaveV3Supply } from "../funcs/aaveV3Supply.js";
 import { aaveV3TokenPrice } from "../funcs/aaveV3TokenPrice.js";
 import { aaveV3UserPositionPerToken } from "../funcs/aaveV3UserPositionPerToken.js";
@@ -18,6 +19,28 @@ import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class AaveV3 extends ClientSDK {
+  /**
+   * Reserve overview
+   *
+   * @remarks
+   * Returns key metrics for Aave Reserves:
+   * - Total Supplied (TVL) in USD
+   * - Total Borrowed in USD
+   * - Utilization Ratio
+   *
+   * See below for more info:
+   */
+  async reserveOverview(
+    request: operations.AaveReserveOverviewRequest,
+    options?: RequestOptions,
+  ): Promise<components.AaveReserveOverviewResponse> {
+    return unwrapAsync(aaveV3ReserveOverview(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Interest rates
    *