@compass-labs/api-sdk 0.0.20 → 0.0.22

package/src/funcs/aaveV3Rate.ts

@@ -0,0 +1,182 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { CompassApiSDKCore } from "../core.js";
+import { encodeFormQuery } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import { APIError } from "../models/errors/apierror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Interest rates
+ *
+ * @remarks
+ * Returns the latest APY and APR rates for a specified token on Aave, for both
+ * deposits and loans.
+ *
+ * **Annual percentage yield (APY)** is the yearly return/cost after continuous
+ * compounding of the per-second rate stored on-chain. This value is the same value as
+ * seen the on [app.aave.com](
+ * https://app.aave.com/)
+ * but more up-to-date as it is taken directly from the
+ * blockchain every time this endpoint is called.
+ *
+ * **Annual percentage rate (APR)** is the yearly simple interest rate (no
+ * compounding).
+ *
+ * For APY/APR on loans Aave offers both stable and fixed rates on certain tokens.
+ */
+export function aaveV3Rate(
+  client: CompassApiSDKCore,
+  request: operations.AaveRateRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.AaveRateResponse,
+    | errors.HTTPValidationError
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CompassApiSDKCore,
+  request: operations.AaveRateRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.AaveRateResponse,
+      | errors.HTTPValidationError
+      | APIError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.AaveRateRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/v0/aave/rate/get")();
+
+  const query = encodeFormQuery({
+    "chain": payload.chain,
+    "token": payload.token,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKeyAuth);
+  const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "aave_rate",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKeyAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["422", "4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    components.AaveRateResponse,
+    | errors.HTTPValidationError
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, components.AaveRateResponse$inboundSchema),
+    M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/skyBuy.ts

@@ -28,9 +28,13 @@ import { Result } from "../types/fp.js";
  * Buy USDS
  *
  * @remarks
- * Buy USDS with DAI or USDC on a 1:1 basis.
+ * Buy USDS with DAI or USDC on a 1:1 basis. There are no fees.
  *
- * There are no fees.
+ * If buying with DAI, user will need to set an allowance on the DAI contract for the
+ * 'SkyDaiUsdsConverter' contract beforehand.
+ *
+ * If buying with USDC, user will need to set an allowance on the USDC contract for the
+ * 'SkyDaiUsdsConverter' contract beforehand.
  */
 export function skyBuy(
   client: CompassApiSDKCore,

package/src/funcs/skySell.ts

@@ -28,9 +28,13 @@ import { Result } from "../types/fp.js";
  * Sell USDS
  *
  * @remarks
- * Sell USDS for DAI or USDC on a 1:1 basis.
+ * Sell USDS for DAI or USDC on a 1:1 basis. There are no fees.
  *
- * There are no fees.
+ * If swapping to DAI, user will need to set an allowance on the USDS contract for the
+ * 'SkyDaiUsdsConverter' contract beforehand.
+ *
+ * If swapping to USDC, user will need to set an allowance on the USDS contract for the
+ * 'SkyUsdcUsdsConverter' contract beforehand.
  */
 export function skySell(
   client: CompassApiSDKCore,

package/src/lib/config.ts

@@ -57,8 +57,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.0.1",
-  sdkVersion: "0.0.20",
+  sdkVersion: "0.0.22",
   genVersion: "2.598.22",
   userAgent:
-    "speakeasy-sdk/typescript 0.0.20 2.598.22 0.0.1 @compass-labs/api-sdk",
+    "speakeasy-sdk/typescript 0.0.22 2.598.22 0.0.1 @compass-labs/api-sdk",
 } as const;

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

@@ -19,7 +19,7 @@ const routes = buildRouteMap({
 export const app = buildApplication(routes, {
   name: "mcp",
   versionInfo: {
-    currentVersion: "0.0.20",
+    currentVersion: "0.0.22",
   },
 });
 

package/src/mcp-server/server.ts

@@ -16,6 +16,7 @@ import { createRegisterTool } from "./tools.js";
 import { tool$aaveV3Borrow } from "./tools/aaveV3Borrow.js";
 import { tool$aaveV3HistoricalTransactions } from "./tools/aaveV3HistoricalTransactions.js";
 import { tool$aaveV3LiquidityChange } from "./tools/aaveV3LiquidityChange.js";
+import { tool$aaveV3Rate } from "./tools/aaveV3Rate.js";
 import { tool$aaveV3Repay } from "./tools/aaveV3Repay.js";
 import { tool$aaveV3Supply } from "./tools/aaveV3Supply.js";
 import { tool$aaveV3TokenPrice } from "./tools/aaveV3TokenPrice.js";
@@ -80,7 +81,7 @@ export function createMCPServer(deps: {
 }) {
   const server = new McpServer({
     name: "CompassApiSDK",
-    version: "0.0.20",
+    version: "0.0.22",
   });
 
   const client = new CompassApiSDKCore({
@@ -110,6 +111,7 @@ export function createMCPServer(deps: {
   const register = { tool, resource, resourceTemplate, prompt };
   void register; // suppress unused warnings
 
+  tool(tool$aaveV3Rate);
   tool(tool$aaveV3TokenPrice);
   tool(tool$aaveV3LiquidityChange);
   tool(tool$aaveV3UserPositionSummary);

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

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { aaveV3Rate } from "../../funcs/aaveV3Rate.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.AaveRateRequest$inboundSchema,
+};
+
+export const tool$aaveV3Rate: ToolDefinition<typeof args> = {
+  name: "aave-v3-rate",
+  description: `Interest rates
+
+Returns the latest APY and APR rates for a specified token on Aave, for both
+deposits and loans.
+
+**Annual percentage yield (APY)** is the yearly return/cost after continuous
+compounding of the per-second rate stored on-chain. This value is the same value as
+seen the on [app.aave.com](
+https://app.aave.com/)
+but more up-to-date as it is taken directly from the
+blockchain every time this endpoint is called.
+
+**Annual percentage rate (APR)** is the yearly simple interest rate (no
+compounding).
+
+For APY/APR on loans Aave offers both stable and fixed rates on certain tokens.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await aaveV3Rate(
+      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/mcp-server/tools/skyBuy.ts

@@ -14,9 +14,13 @@ export const tool$skyBuy: ToolDefinition<typeof args> = {
   name: "sky-buy",
   description: `Buy USDS
 
-Buy USDS with DAI or USDC on a 1:1 basis.
+Buy USDS with DAI or USDC on a 1:1 basis. There are no fees.
 
-There are no fees.`,
+If buying with DAI, user will need to set an allowance on the DAI contract for the
+'SkyDaiUsdsConverter' contract beforehand.
+
+If buying with USDC, user will need to set an allowance on the USDC contract for the
+'SkyDaiUsdsConverter' contract beforehand.`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await skyBuy(

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

@@ -14,9 +14,13 @@ export const tool$skySell: ToolDefinition<typeof args> = {
   name: "sky-sell",
   description: `Sell USDS
 
-Sell USDS for DAI or USDC on a 1:1 basis.
+Sell USDS for DAI or USDC on a 1:1 basis. There are no fees.
 
-There are no fees.`,
+If swapping to DAI, user will need to set an allowance on the USDS contract for the
+'SkyDaiUsdsConverter' contract beforehand.
+
+If swapping to USDC, user will need to set an allowance on the USDS contract for the
+'SkyUsdcUsdsConverter' contract beforehand.`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await skySell(

package/src/models/components/aaverateresponse.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 AaveRateResponse = {
+  /**
+   * Variable rate APY for deposits.
+   */
+  supplyApyVariableRate: string;
+  /**
+   * Variable rate APR for deposits.
+   */
+  supplyAprVariableRate: string;
+  /**
+   * Variable rate APY for loans.
+   */
+  borrowApyVariableRate: string;
+  /**
+   * Variable rate APR for loans.
+   */
+  borrowAprVariableRate: string;
+  /**
+   * Fixed rate APY for loans.
+   */
+  borrowApyFixedRate: string;
+  /**
+   * Fixed rate APR for loans.
+   */
+  borrowAprFixedRate: string;
+};
+
+/** @internal */
+export const AaveRateResponse$inboundSchema: z.ZodType<
+  AaveRateResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  supply_apy_variable_rate: z.string(),
+  supply_apr_variable_rate: z.string(),
+  borrow_apy_variable_rate: z.string(),
+  borrow_apr_variable_rate: z.string(),
+  borrow_apy_fixed_rate: z.string(),
+  borrow_apr_fixed_rate: z.string(),
+}).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 AaveRateResponse$Outbound = {
+  supply_apy_variable_rate: string;
+  supply_apr_variable_rate: string;
+  borrow_apy_variable_rate: string;
+  borrow_apr_variable_rate: string;
+  borrow_apy_fixed_rate: string;
+  borrow_apr_fixed_rate: string;
+};
+
+/** @internal */
+export const AaveRateResponse$outboundSchema: z.ZodType<
+  AaveRateResponse$Outbound,
+  z.ZodTypeDef,
+  AaveRateResponse
+> = z.object({
+  supplyApyVariableRate: z.string(),
+  supplyAprVariableRate: z.string(),
+  borrowApyVariableRate: z.string(),
+  borrowAprVariableRate: z.string(),
+  borrowApyFixedRate: z.string(),
+  borrowAprFixedRate: z.string(),
+}).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 AaveRateResponse$ {
+  /** @deprecated use `AaveRateResponse$inboundSchema` instead. */
+  export const inboundSchema = AaveRateResponse$inboundSchema;
+  /** @deprecated use `AaveRateResponse$outboundSchema` instead. */
+  export const outboundSchema = AaveRateResponse$outboundSchema;
+  /** @deprecated use `AaveRateResponse$Outbound` instead. */
+  export type Outbound = AaveRateResponse$Outbound;
+}
+
+export function aaveRateResponseToJSON(
+  aaveRateResponse: AaveRateResponse,
+): string {
+  return JSON.stringify(
+    AaveRateResponse$outboundSchema.parse(aaveRateResponse),
+  );
+}
+
+export function aaveRateResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<AaveRateResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AaveRateResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AaveRateResponse' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -7,6 +7,7 @@ export * from "./aaveborrowrequest.js";
 export * from "./aavehistoricaltransactionbase.js";
 export * from "./aavehistoricaltransactionsresponse.js";
 export * from "./aaveliquiditychangeresponse.js";
+export * from "./aaverateresponse.js";
 export * from "./aaverepayparams.js";
 export * from "./aaverepayrequest.js";
 export * from "./aavesupplyparams.js";
@@ -17,12 +18,8 @@ export * from "./aaveuserpositionsummaryresponse.js";
 export * from "./aavewithdrawparams.js";
 export * from "./aavewithdrawrequest.js";
 export * from "./action.js";
-export * from "./aerodromeaddliquidityethparams.js";
-export * from "./aerodromeaddliquidityparams.js";
 export * from "./aerodromelppositionsresponse.js";
 export * from "./aerodromeposition.js";
-export * from "./aerodromeremoveliquidityethrequest.js";
-export * from "./aerodromeremoveliquidityrequest.js";
 export * from "./aerodromeslipstreambuyexactlyparams.js";
 export * from "./aerodromeslipstreambuyexactlyrequest.js";
 export * from "./aerodromeslipstreamincreaseliquidityprovisionparams.js";
@@ -34,9 +31,6 @@ export * from "./aerodromeslipstreamsellexactlyparams.js";
 export * from "./aerodromeslipstreamsellexactlyrequest.js";
 export * from "./aerodromeslipstreamwithdrawliquidityprovisionparams.js";
 export * from "./aerodromeslipstreamwithdrawliquidityprovisionrequest.js";
-export * from "./aerodromeswapethfortokenparams.js";
-export * from "./aerodromeswaptokenforethparams.js";
-export * from "./aerodromeswaptokensparams.js";
 export * from "./allowanceinforesponse.js";
 export * from "./borrow.js";
 export * from "./chain.js";