@compass-labs/api-sdk 2.1.17 → 2.1.18-rc.1

package/src/models/components/index.ts

@@ -8,6 +8,7 @@ export * from "./aaveborrowrequest.js";
 export * from "./aavehistoricaltransactionsresponse.js";
 export * from "./aaveliquiditychangeresponse.js";
 export * from "./aavelooprequest.js";
+export * from "./aavemarketinfo.js";
 export * from "./aaveposition.js";
 export * from "./aaverateresponse.js";
 export * from "./aaverepayparams.js";
@@ -49,6 +50,7 @@ export * from "./batcheduseroperationsresponse.js";
 export * from "./borrow.js";
 export * from "./bundlertransactionresponse.js";
 export * from "./chain.js";
+export * from "./chainaavemarkets.js";
 export * from "./chaininfo.js";
 export * from "./chainratedata.js";
 export * from "./compassapibackendv1modelsgenericreadresponseportfoliotokenbalance.js";
@@ -106,11 +108,13 @@ export * from "./fee.js";
 export * from "./feeenum.js";
 export * from "./interestratemode.js";
 export * from "./liquidationcall.js";
+export * from "./listaavemarketsresponse.js";
 export * from "./lpbalance.js";
 export * from "./market.js";
 export * from "./marketposition.js";
 export * from "./markettokens.js";
 export * from "./maxsupplyapydata.js";
+export * from "./maxsupplyapymarket.js";
 export * from "./mintpreparecompletedresponse.js";
 export * from "./mintpreparependingresponse.js";
 export * from "./mintpreparereadyresponse.js";

package/src/models/components/listaavemarketsresponse.ts

@@ -0,0 +1,55 @@
+/*
+ * 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";
+import {
+  ChainAaveMarkets,
+  ChainAaveMarkets$inboundSchema,
+} from "./chainaavemarkets.js";
+import {
+  MaxSupplyApyMarket,
+  MaxSupplyApyMarket$inboundSchema,
+} from "./maxsupplyapymarket.js";
+
+/**
+ * Response containing Aave market rates for all tokens across chains.
+ */
+export type ListAaveMarketsResponse = {
+  /**
+   * List of chains with their Aave market data.
+   */
+  chains: Array<ChainAaveMarkets>;
+  /**
+   * The market with the highest supply APY across all queried chains. Only included when multiple chains are queried.
+   */
+  maxSupplyApy?: MaxSupplyApyMarket | null | undefined;
+};
+
+/** @internal */
+export const ListAaveMarketsResponse$inboundSchema: z.ZodType<
+  ListAaveMarketsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  chains: z.array(ChainAaveMarkets$inboundSchema),
+  max_supply_apy: z.nullable(MaxSupplyApyMarket$inboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "max_supply_apy": "maxSupplyApy",
+  });
+});
+
+export function listAaveMarketsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListAaveMarketsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListAaveMarketsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListAaveMarketsResponse' from JSON`,
+  );
+}

package/src/models/components/maxsupplyapymarket.ts

@@ -0,0 +1,46 @@
+/*
+ * 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 {
+  AaveMarketInfo,
+  AaveMarketInfo$inboundSchema,
+} from "./aavemarketinfo.js";
+
+/**
+ * Information about the market with the highest supply APY.
+ */
+export type MaxSupplyApyMarket = {
+  /**
+   * Chain name where this market exists.
+   */
+  chain: string;
+  /**
+   * Rate information for a single token on Aave.
+   */
+  market: AaveMarketInfo;
+};
+
+/** @internal */
+export const MaxSupplyApyMarket$inboundSchema: z.ZodType<
+  MaxSupplyApyMarket,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  chain: z.string(),
+  market: AaveMarketInfo$inboundSchema,
+});
+
+export function maxSupplyApyMarketFromJSON(
+  jsonString: string,
+): SafeParseResult<MaxSupplyApyMarket, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MaxSupplyApyMarket$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MaxSupplyApyMarket' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -42,5 +42,6 @@ export * from "./v1vaultsvault.js";
 export * from "./v1wildcatmarket.js";
 export * from "./v2cctpmint.js";
 export * from "./v2earnaavetokenrates.js";
+export * from "./v2earnlistaavemarkets.js";
 export * from "./v2earnpositions.js";
 export * from "./v2earnvaults.js";

package/src/models/operations/v2earnlistaavemarkets.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as components from "../components/index.js";
+
+export type V2EarnListAaveMarketsRequest = {
+  /**
+   * Optional chain filter. If not provided, returns rates for all chains.
+   */
+  chain?: components.Chain | null | undefined;
+};
+
+/** @internal */
+export type V2EarnListAaveMarketsRequest$Outbound = {
+  chain?: string | null | undefined;
+};
+
+/** @internal */
+export const V2EarnListAaveMarketsRequest$outboundSchema: z.ZodType<
+  V2EarnListAaveMarketsRequest$Outbound,
+  z.ZodTypeDef,
+  V2EarnListAaveMarketsRequest
+> = z.object({
+  chain: z.nullable(components.Chain$outboundSchema).optional(),
+});
+
+export function v2EarnListAaveMarketsRequestToJSON(
+  v2EarnListAaveMarketsRequest: V2EarnListAaveMarketsRequest,
+): string {
+  return JSON.stringify(
+    V2EarnListAaveMarketsRequest$outboundSchema.parse(
+      v2EarnListAaveMarketsRequest,
+    ),
+  );
+}

package/src/models/operations/v2earnvaults.ts

@@ -5,6 +5,7 @@
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { ClosedEnum } from "../../types/enums.js";
+import * as components from "../components/index.js";
 
 /**
  * The direction to order the results by.
@@ -18,13 +19,6 @@ export const Direction = {
  */
 export type Direction = ClosedEnum<typeof Direction>;
 
-export const V2EarnVaultsChain = {
-  Arbitrum: "arbitrum",
-  Base: "base",
-  Ethereum: "ethereum",
-} as const;
-export type V2EarnVaultsChain = ClosedEnum<typeof V2EarnVaultsChain>;
-
 export type V2EarnVaultsRequest = {
   /**
    * The field to order the results by.
@@ -42,7 +36,10 @@ export type V2EarnVaultsRequest = {
    * The number of items to return.
    */
   limit?: number | undefined;
-  chain: V2EarnVaultsChain;
+  /**
+   * Optional chain filter. If not provided, returns vaults for all chains.
+   */
+  chain?: components.Chain | null | undefined;
   /**
    * Filter vaults by underlying asset symbol (e.g., 'USDC', 'WETH').
    */
@@ -53,18 +50,13 @@ export type V2EarnVaultsRequest = {
 export const Direction$outboundSchema: z.ZodNativeEnum<typeof Direction> = z
   .nativeEnum(Direction);
 
-/** @internal */
-export const V2EarnVaultsChain$outboundSchema: z.ZodNativeEnum<
-  typeof V2EarnVaultsChain
-> = z.nativeEnum(V2EarnVaultsChain);
-
 /** @internal */
 export type V2EarnVaultsRequest$Outbound = {
   order_by: string;
   direction?: string | undefined;
   offset?: number | undefined;
   limit?: number | undefined;
-  chain: string;
+  chain?: string | null | undefined;
   asset_symbol?: string | null | undefined;
 };
 
@@ -78,7 +70,7 @@ export const V2EarnVaultsRequest$outboundSchema: z.ZodType<
   direction: Direction$outboundSchema.optional(),
   offset: z.number().int().optional(),
   limit: z.number().int().optional(),
-  chain: V2EarnVaultsChain$outboundSchema,
+  chain: z.nullable(components.Chain$outboundSchema).optional(),
   assetSymbol: z.nullable(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {

package/src/sdk/earn.ts

@@ -5,6 +5,7 @@
 import { earnEarnAaveTokenRates } from "../funcs/earnEarnAaveTokenRates.js";
 import { earnEarnBundle } from "../funcs/earnEarnBundle.js";
 import { earnEarnCreateAccount } from "../funcs/earnEarnCreateAccount.js";
+import { earnEarnListAaveMarkets } from "../funcs/earnEarnListAaveMarkets.js";
 import { earnEarnManage } from "../funcs/earnEarnManage.js";
 import { earnEarnPositions } from "../funcs/earnEarnPositions.js";
 import { earnEarnSwap } from "../funcs/earnEarnSwap.js";
@@ -34,13 +35,12 @@ export class Earn extends ClientSDK {
   }
 
   /**
-   * List Vaults
+   * List vaults
    *
    * @remarks
-   * Fetch ERC-4626 vaults from the database with TVL and APY stats.
+   * List information about 4626 vaults.
    *
-   * Returns a paginated list of ERC-4626 vaults indexed from various chains, joined with
-   * their current statistics (TVL in USD, 7d/30d/90d APY).
+   * These are earn opportunities for protocols like morpho.
    */
   async earnVaults(
     request: operations.V2EarnVaultsRequest,
@@ -70,6 +70,26 @@ export class Earn extends ClientSDK {
     ));
   }
 
+  /**
+   * List all Aave markets with rates
+   *
+   * @remarks
+   * List all Aave markets with their supply and borrow rates.
+   *
+   * Returns rates for all supported tokens across Ethereum, Base, and Arbitrum.
+   * Optionally filter by chain. Uses batch_multicall for efficient RPC usage.
+   */
+  async earnListAaveMarkets(
+    request: operations.V2EarnListAaveMarketsRequest,
+    options?: RequestOptions,
+  ): Promise<components.ListAaveMarketsResponse> {
+    return unwrapAsync(earnEarnListAaveMarkets(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Create earn account
    *

package/docs/models/operations/v2earnvaultschain.md

@@ -1,15 +0,0 @@
-# V2EarnVaultsChain
-
-## Example Usage
-
-```typescript
-import { V2EarnVaultsChain } from "@compass-labs/api-sdk/models/operations";
-
-let value: V2EarnVaultsChain = "ethereum";
-```
-
-## Values
-
-```typescript
-"arbitrum" | "base" | "ethereum"
-```