@compass-labs/api-sdk 0.5.48 → 0.5.50

package/src/mcp-server/tools/universalSupportedChains.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { universalSupportedChains } from "../../funcs/universalSupportedChains.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.GenericSupportedChainsRequest$inboundSchema,
+};
+
+export const tool$universalSupportedChains: ToolDefinition<typeof args> = {
+  name: "universal-supported-chains",
+  description: `List Supported Chains
+
+Get the list of supported chains by the Compass API.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await universalSupportedChains(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/models/components/aavesupportedtokenmetadata.ts

@@ -0,0 +1,101 @@
+/*
+ * 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 AaveSupportedTokenMetadata = {
+  /**
+   * Token symbol (e.g., 'WETH', 'DAI').
+   */
+  symbol: string;
+  /**
+   * Token contract address.
+   */
+  address: string;
+  /**
+   * Whether the token can be used as collateral.
+   */
+  supplyingEnabled: boolean;
+  /**
+   * Whether the token can be borrowed.
+   */
+  borrowingEnabled: boolean;
+};
+
+/** @internal */
+export const AaveSupportedTokenMetadata$inboundSchema: z.ZodType<
+  AaveSupportedTokenMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  symbol: z.string(),
+  address: z.string(),
+  supplying_enabled: z.boolean(),
+  borrowing_enabled: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    "supplying_enabled": "supplyingEnabled",
+    "borrowing_enabled": "borrowingEnabled",
+  });
+});
+
+/** @internal */
+export type AaveSupportedTokenMetadata$Outbound = {
+  symbol: string;
+  address: string;
+  supplying_enabled: boolean;
+  borrowing_enabled: boolean;
+};
+
+/** @internal */
+export const AaveSupportedTokenMetadata$outboundSchema: z.ZodType<
+  AaveSupportedTokenMetadata$Outbound,
+  z.ZodTypeDef,
+  AaveSupportedTokenMetadata
+> = z.object({
+  symbol: z.string(),
+  address: z.string(),
+  supplyingEnabled: z.boolean(),
+  borrowingEnabled: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    supplyingEnabled: "supplying_enabled",
+    borrowingEnabled: "borrowing_enabled",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AaveSupportedTokenMetadata$ {
+  /** @deprecated use `AaveSupportedTokenMetadata$inboundSchema` instead. */
+  export const inboundSchema = AaveSupportedTokenMetadata$inboundSchema;
+  /** @deprecated use `AaveSupportedTokenMetadata$outboundSchema` instead. */
+  export const outboundSchema = AaveSupportedTokenMetadata$outboundSchema;
+  /** @deprecated use `AaveSupportedTokenMetadata$Outbound` instead. */
+  export type Outbound = AaveSupportedTokenMetadata$Outbound;
+}
+
+export function aaveSupportedTokenMetadataToJSON(
+  aaveSupportedTokenMetadata: AaveSupportedTokenMetadata,
+): string {
+  return JSON.stringify(
+    AaveSupportedTokenMetadata$outboundSchema.parse(aaveSupportedTokenMetadata),
+  );
+}
+
+export function aaveSupportedTokenMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<AaveSupportedTokenMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AaveSupportedTokenMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AaveSupportedTokenMetadata' from JSON`,
+  );
+}

package/src/models/components/aavesupportedtokensresponse.ts

@@ -0,0 +1,77 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  AaveSupportedTokenMetadata,
+  AaveSupportedTokenMetadata$inboundSchema,
+  AaveSupportedTokenMetadata$Outbound,
+  AaveSupportedTokenMetadata$outboundSchema,
+} from "./aavesupportedtokenmetadata.js";
+
+export type AaveSupportedTokensResponse = {
+  /**
+   * List of supported tokens with configuration metadata for a given chain.
+   */
+  tokens: Array<AaveSupportedTokenMetadata>;
+};
+
+/** @internal */
+export const AaveSupportedTokensResponse$inboundSchema: z.ZodType<
+  AaveSupportedTokensResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  tokens: z.array(AaveSupportedTokenMetadata$inboundSchema),
+});
+
+/** @internal */
+export type AaveSupportedTokensResponse$Outbound = {
+  tokens: Array<AaveSupportedTokenMetadata$Outbound>;
+};
+
+/** @internal */
+export const AaveSupportedTokensResponse$outboundSchema: z.ZodType<
+  AaveSupportedTokensResponse$Outbound,
+  z.ZodTypeDef,
+  AaveSupportedTokensResponse
+> = z.object({
+  tokens: z.array(AaveSupportedTokenMetadata$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AaveSupportedTokensResponse$ {
+  /** @deprecated use `AaveSupportedTokensResponse$inboundSchema` instead. */
+  export const inboundSchema = AaveSupportedTokensResponse$inboundSchema;
+  /** @deprecated use `AaveSupportedTokensResponse$outboundSchema` instead. */
+  export const outboundSchema = AaveSupportedTokensResponse$outboundSchema;
+  /** @deprecated use `AaveSupportedTokensResponse$Outbound` instead. */
+  export type Outbound = AaveSupportedTokensResponse$Outbound;
+}
+
+export function aaveSupportedTokensResponseToJSON(
+  aaveSupportedTokensResponse: AaveSupportedTokensResponse,
+): string {
+  return JSON.stringify(
+    AaveSupportedTokensResponse$outboundSchema.parse(
+      aaveSupportedTokensResponse,
+    ),
+  );
+}
+
+export function aaveSupportedTokensResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<AaveSupportedTokensResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AaveSupportedTokensResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AaveSupportedTokensResponse' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -15,6 +15,8 @@ export * from "./aavereserveoverviewresponse.js";
 export * from "./aavestdrateresponse.js";
 export * from "./aavesupplyparams.js";
 export * from "./aavesupplyrequest.js";
+export * from "./aavesupportedtokenmetadata.js";
+export * from "./aavesupportedtokensresponse.js";
 export * from "./aavetokenpriceresponse.js";
 export * from "./aaveuserpositionpertokenresponse.js";
 export * from "./aaveuserpositionsummaryresponse.js";
@@ -114,6 +116,7 @@ export * from "./pendlesellytparams.js";
 export * from "./pendlesellytrequest.js";
 export * from "./portfolio.js";
 export * from "./position.js";
+export * from "./protocol.js";
 export * from "./redeemunderlying.js";
 export * from "./repay.js";
 export * from "./reserve.js";
@@ -131,6 +134,7 @@ export * from "./skysellrequest.js";
 export * from "./skywithdrawparams.js";
 export * from "./skywithdrawrequest.js";
 export * from "./supply.js";
+export * from "./supportedchaininfo.js";
 export * from "./swapborrowrate.js";
 export * from "./syposition.js";
 export * from "./tokenaddressresponse.js";

package/src/models/components/protocol.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const Protocol = {
+  Aave: "aave",
+  Aerodrome: "aerodrome",
+  Morpho: "morpho",
+  Sky: "sky",
+  Uniswap: "uniswap",
+  Pendle: "pendle",
+} as const;
+export type Protocol = ClosedEnum<typeof Protocol>;
+
+/** @internal */
+export const Protocol$inboundSchema: z.ZodNativeEnum<typeof Protocol> = z
+  .nativeEnum(Protocol);
+
+/** @internal */
+export const Protocol$outboundSchema: z.ZodNativeEnum<typeof Protocol> =
+  Protocol$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Protocol$ {
+  /** @deprecated use `Protocol$inboundSchema` instead. */
+  export const inboundSchema = Protocol$inboundSchema;
+  /** @deprecated use `Protocol$outboundSchema` instead. */
+  export const outboundSchema = Protocol$outboundSchema;
+}

package/src/models/components/supportedchaininfo.ts

@@ -0,0 +1,70 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { Chain, Chain$inboundSchema, Chain$outboundSchema } from "./chain.js";
+
+/**
+ * Response model for a chain.
+ */
+export type SupportedChainInfo = {
+  chains: Array<Chain>;
+};
+
+/** @internal */
+export const SupportedChainInfo$inboundSchema: z.ZodType<
+  SupportedChainInfo,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  chains: z.array(Chain$inboundSchema),
+});
+
+/** @internal */
+export type SupportedChainInfo$Outbound = {
+  chains: Array<string>;
+};
+
+/** @internal */
+export const SupportedChainInfo$outboundSchema: z.ZodType<
+  SupportedChainInfo$Outbound,
+  z.ZodTypeDef,
+  SupportedChainInfo
+> = z.object({
+  chains: z.array(Chain$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SupportedChainInfo$ {
+  /** @deprecated use `SupportedChainInfo$inboundSchema` instead. */
+  export const inboundSchema = SupportedChainInfo$inboundSchema;
+  /** @deprecated use `SupportedChainInfo$outboundSchema` instead. */
+  export const outboundSchema = SupportedChainInfo$outboundSchema;
+  /** @deprecated use `SupportedChainInfo$Outbound` instead. */
+  export type Outbound = SupportedChainInfo$Outbound;
+}
+
+export function supportedChainInfoToJSON(
+  supportedChainInfo: SupportedChainInfo,
+): string {
+  return JSON.stringify(
+    SupportedChainInfo$outboundSchema.parse(supportedChainInfo),
+  );
+}
+
+export function supportedChainInfoFromJSON(
+  jsonString: string,
+): SafeParseResult<SupportedChainInfo, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SupportedChainInfo$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SupportedChainInfo' from JSON`,
+  );
+}

package/src/models/operations/aaveaavesupportedtokens.ts

@@ -0,0 +1,117 @@
+/*
+ * 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 AaveAaveSupportedTokensChain = {
+  BaseMainnet: "base:mainnet",
+  EthereumMainnet: "ethereum:mainnet",
+  ArbitrumMainnet: "arbitrum:mainnet",
+} as const;
+/**
+ * The chain to use.
+ */
+export type AaveAaveSupportedTokensChain = ClosedEnum<
+  typeof AaveAaveSupportedTokensChain
+>;
+
+export type AaveAaveSupportedTokensRequest = {
+  /**
+   * The chain to use.
+   */
+  chain?: AaveAaveSupportedTokensChain | undefined;
+  /**
+   * Optional block number (defaults to latest).
+   */
+  block?: number | null | undefined;
+};
+
+/** @internal */
+export const AaveAaveSupportedTokensChain$inboundSchema: z.ZodNativeEnum<
+  typeof AaveAaveSupportedTokensChain
+> = z.nativeEnum(AaveAaveSupportedTokensChain);
+
+/** @internal */
+export const AaveAaveSupportedTokensChain$outboundSchema: z.ZodNativeEnum<
+  typeof AaveAaveSupportedTokensChain
+> = AaveAaveSupportedTokensChain$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AaveAaveSupportedTokensChain$ {
+  /** @deprecated use `AaveAaveSupportedTokensChain$inboundSchema` instead. */
+  export const inboundSchema = AaveAaveSupportedTokensChain$inboundSchema;
+  /** @deprecated use `AaveAaveSupportedTokensChain$outboundSchema` instead. */
+  export const outboundSchema = AaveAaveSupportedTokensChain$outboundSchema;
+}
+
+/** @internal */
+export const AaveAaveSupportedTokensRequest$inboundSchema: z.ZodType<
+  AaveAaveSupportedTokensRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  chain: AaveAaveSupportedTokensChain$inboundSchema.default("arbitrum:mainnet"),
+  block: z.nullable(z.number().int()).optional(),
+});
+
+/** @internal */
+export type AaveAaveSupportedTokensRequest$Outbound = {
+  chain: string;
+  block?: number | null | undefined;
+};
+
+/** @internal */
+export const AaveAaveSupportedTokensRequest$outboundSchema: z.ZodType<
+  AaveAaveSupportedTokensRequest$Outbound,
+  z.ZodTypeDef,
+  AaveAaveSupportedTokensRequest
+> = z.object({
+  chain: AaveAaveSupportedTokensChain$outboundSchema.default(
+    "arbitrum:mainnet",
+  ),
+  block: z.nullable(z.number().int()).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AaveAaveSupportedTokensRequest$ {
+  /** @deprecated use `AaveAaveSupportedTokensRequest$inboundSchema` instead. */
+  export const inboundSchema = AaveAaveSupportedTokensRequest$inboundSchema;
+  /** @deprecated use `AaveAaveSupportedTokensRequest$outboundSchema` instead. */
+  export const outboundSchema = AaveAaveSupportedTokensRequest$outboundSchema;
+  /** @deprecated use `AaveAaveSupportedTokensRequest$Outbound` instead. */
+  export type Outbound = AaveAaveSupportedTokensRequest$Outbound;
+}
+
+export function aaveAaveSupportedTokensRequestToJSON(
+  aaveAaveSupportedTokensRequest: AaveAaveSupportedTokensRequest,
+): string {
+  return JSON.stringify(
+    AaveAaveSupportedTokensRequest$outboundSchema.parse(
+      aaveAaveSupportedTokensRequest,
+    ),
+  );
+}
+
+export function aaveAaveSupportedTokensRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<AaveAaveSupportedTokensRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AaveAaveSupportedTokensRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AaveAaveSupportedTokensRequest' from JSON`,
+  );
+}

package/src/models/operations/genericsupportedchains.ts

@@ -0,0 +1,72 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type GenericSupportedChainsRequest = {
+  /**
+   * The protocol to get the supported chains for.
+   */
+  protocol?: components.Protocol | null | undefined;
+};
+
+/** @internal */
+export const GenericSupportedChainsRequest$inboundSchema: z.ZodType<
+  GenericSupportedChainsRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  protocol: z.nullable(components.Protocol$inboundSchema).optional(),
+});
+
+/** @internal */
+export type GenericSupportedChainsRequest$Outbound = {
+  protocol?: string | null | undefined;
+};
+
+/** @internal */
+export const GenericSupportedChainsRequest$outboundSchema: z.ZodType<
+  GenericSupportedChainsRequest$Outbound,
+  z.ZodTypeDef,
+  GenericSupportedChainsRequest
+> = z.object({
+  protocol: z.nullable(components.Protocol$outboundSchema).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GenericSupportedChainsRequest$ {
+  /** @deprecated use `GenericSupportedChainsRequest$inboundSchema` instead. */
+  export const inboundSchema = GenericSupportedChainsRequest$inboundSchema;
+  /** @deprecated use `GenericSupportedChainsRequest$outboundSchema` instead. */
+  export const outboundSchema = GenericSupportedChainsRequest$outboundSchema;
+  /** @deprecated use `GenericSupportedChainsRequest$Outbound` instead. */
+  export type Outbound = GenericSupportedChainsRequest$Outbound;
+}
+
+export function genericSupportedChainsRequestToJSON(
+  genericSupportedChainsRequest: GenericSupportedChainsRequest,
+): string {
+  return JSON.stringify(
+    GenericSupportedChainsRequest$outboundSchema.parse(
+      genericSupportedChainsRequest,
+    ),
+  );
+}
+
+export function genericSupportedChainsRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<GenericSupportedChainsRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GenericSupportedChainsRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GenericSupportedChainsRequest' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -2,6 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+export * from "./aaveaavesupportedtokens.js";
 export * from "./aaveavgrate.js";
 export * from "./aavehistoricaltransactions.js";
 export * from "./aaveliquiditychange.js";
@@ -16,6 +17,7 @@ export * from "./aerodromeslipstreampoolprice.js";
 export * from "./genericallowance.js";
 export * from "./genericens.js";
 export * from "./genericportfolio.js";
+export * from "./genericsupportedchains.js";
 export * from "./genericsupportedtokens.js";
 export * from "./genericvisualizeportfolio.js";
 export * from "./morphomarket.js";

package/src/sdk/aavev3.ts

@@ -2,6 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { aaveV3AaveSupportedTokens } from "../funcs/aaveV3AaveSupportedTokens.js";
 import { aaveV3AvgRate } from "../funcs/aaveV3AvgRate.js";
 import { aaveV3Borrow } from "../funcs/aaveV3Borrow.js";
 import { aaveV3HistoricalTransactions } from "../funcs/aaveV3HistoricalTransactions.js";
@@ -21,6 +22,29 @@ import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class AaveV3 extends ClientSDK {
+  /**
+   * Aave Supported Tokens
+   *
+   * @remarks
+   * Returns the list of supported tokens on Aave for the specified network, along
+   * with key metadata.
+   *
+   * For each token, the response includes:
+   * - The symbol and contract address.
+   * - Whether the token is currently enabled for supplying (depositing).
+   * - Whether it is enabled for borrowing.
+   */
+  async aaveSupportedTokens(
+    request: operations.AaveAaveSupportedTokensRequest,
+    options?: RequestOptions,
+  ): Promise<components.AaveSupportedTokensResponse> {
+    return unwrapAsync(aaveV3AaveSupportedTokens(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Interest Rates
    *

package/src/sdk/universal.ts

@@ -6,6 +6,7 @@ import { universalAllowance } from "../funcs/universalAllowance.js";
 import { universalAllowanceSet } from "../funcs/universalAllowanceSet.js";
 import { universalEns } from "../funcs/universalEns.js";
 import { universalPortfolio } from "../funcs/universalPortfolio.js";
+import { universalSupportedChains } from "../funcs/universalSupportedChains.js";
 import { universalSupportedTokens } from "../funcs/universalSupportedTokens.js";
 import { universalUnwrapWeth } from "../funcs/universalUnwrapWeth.js";
 import { universalVisualizePortfolio } from "../funcs/universalVisualizePortfolio.js";
@@ -74,6 +75,23 @@ export class Universal extends ClientSDK {
     ));
   }
 
+  /**
+   * List Supported Chains
+   *
+   * @remarks
+   * Get the list of supported chains by the Compass API.
+   */
+  async supportedChains(
+    request: operations.GenericSupportedChainsRequest,
+    options?: RequestOptions,
+  ): Promise<components.SupportedChainInfo> {
+    return unwrapAsync(universalSupportedChains(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Get Allowance
    *