@compass-labs/api-sdk 0.0.19 → 0.0.21

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";

package/src/models/operations/aaverate.ts

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

package/src/models/operations/index.ts

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

package/src/sdk/aavev3.ts

@@ -5,6 +5,7 @@
 import { aaveV3Borrow } from "../funcs/aaveV3Borrow.js";
 import { aaveV3HistoricalTransactions } from "../funcs/aaveV3HistoricalTransactions.js";
 import { aaveV3LiquidityChange } from "../funcs/aaveV3LiquidityChange.js";
+import { aaveV3Rate } from "../funcs/aaveV3Rate.js";
 import { aaveV3Repay } from "../funcs/aaveV3Repay.js";
 import { aaveV3Supply } from "../funcs/aaveV3Supply.js";
 import { aaveV3TokenPrice } from "../funcs/aaveV3TokenPrice.js";
@@ -17,6 +18,36 @@ import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class AaveV3 extends ClientSDK {
+  /**
+   * 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.
+   */
+  async rate(
+    request: operations.AaveRateRequest,
+    options?: RequestOptions,
+  ): Promise<components.AaveRateResponse> {
+    return unwrapAsync(aaveV3Rate(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Token prices
    *

package/src/sdk/sky.ts

@@ -34,9 +34,13 @@ export class Sky extends ClientSDK {
    * 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.
    */
   async buy(
     request: components.SkyBuyRequest,
@@ -53,9 +57,13 @@ export class Sky extends ClientSDK {
    * 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.
    */
   async sell(
     request: components.SkySellRequest,