@compass-labs/api-sdk 0.1.1 → 0.1.3

package/src/sdk/aavev3.ts

@@ -22,16 +22,29 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class AaveV3 extends ClientSDK {
   /**
-   * Standard deviation of interest rates
+   * Interest Rates: now
    *
    * @remarks
-   * Returns the standard deviation of Interest Rates for Aave Reserves over time.
+   * 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 stdRate(
-    request: operations.AaveStdRateRequest,
+  async rate(
+    request: operations.AaveRateRequest,
     options?: RequestOptions,
-  ): Promise<components.AaveSTDRateResponse> {
-    return unwrapAsync(aaveV3StdRate(
+  ): Promise<components.AaveRateResponse> {
+    return unwrapAsync(aaveV3Rate(
       this,
       request,
       options,
@@ -39,10 +52,10 @@ export class AaveV3 extends ClientSDK {
   }
 
   /**
-   * Average interest rates
+   * Interest Rates: time average
    *
    * @remarks
-   * Returns time averaged Interest Rates for Aave Reserves.
+   * Provides time-weighted averages of deposit and borrow rates for Aave reserves.
    */
   async avgRate(
     request: operations.AaveAvgRateRequest,
@@ -56,21 +69,17 @@ export class AaveV3 extends ClientSDK {
   }
 
   /**
-   * Reserve overview
+   * Interest Rates: standard deviation
    *
    * @remarks
-   * Returns key metrics for Aave Reserves:
-   * - Total Supplied (TVL) in USD
-   * - Total Borrowed in USD
-   * - Utilization Ratio
-   *
-   * See below for more info:
+   * Returns the historical standard deviation of lending and borrowing rates for Aave
+   * reserves, illustrating market volatility.
    */
-  async reserveOverview(
-    request: operations.AaveReserveOverviewRequest,
+  async stdRate(
+    request: operations.AaveStdRateRequest,
     options?: RequestOptions,
-  ): Promise<components.AaveReserveOverviewResponse> {
-    return unwrapAsync(aaveV3ReserveOverview(
+  ): Promise<components.AaveSTDRateResponse> {
+    return unwrapAsync(aaveV3StdRate(
       this,
       request,
       options,
@@ -78,29 +87,21 @@ export class AaveV3 extends ClientSDK {
   }
 
   /**
-   * Interest rates
+   * Reserve overview
    *
    * @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).
+   * Returns key metrics for Aave Reserves:
+   * - Total Supplied (TVL) in USD
+   * - Total Borrowed in USD
+   * - Utilization Ratio
    *
-   * For APY/APR on loans Aave offers both stable and fixed rates on certain tokens.
+   * See below for more info:
    */
-  async rate(
-    request: operations.AaveRateRequest,
+  async reserveOverview(
+    request: operations.AaveReserveOverviewRequest,
     options?: RequestOptions,
-  ): Promise<components.AaveRateResponse> {
-    return unwrapAsync(aaveV3Rate(
+  ): Promise<components.AaveReserveOverviewResponse> {
+    return unwrapAsync(aaveV3ReserveOverview(
       this,
       request,
       options,

package/src/sdk/morpho.ts

@@ -26,7 +26,7 @@ export class Morpho extends ClientSDK {
    * Get Vaults
    *
    * @remarks
-   * Query a list of available vaults for deposit token.
+   * Query a list of vaults you can deposit into.
    *
    * Each vault has one unique token that can be deposited. In exchange for depositing
    * tokens into a vault you receive shares. You earn yield on these shares by their
@@ -48,6 +48,13 @@ export class Morpho extends ClientSDK {
    *
    * @remarks
    * Get data & metrics for a specific Morpho vault.
+   *
+   * Including:
+   * - Current, daily, weekly, monthly, yearly APY
+   * - Underlying asset data
+   * - Total liquidity
+   * - Pertinent metadata
+   * - Whitelist status
    */
   async vault(
     request: operations.MorphoVaultRequest,
@@ -103,6 +110,15 @@ export class Morpho extends ClientSDK {
    *
    * @remarks
    * Get data & metrics for a specific Morpho market.
+   *
+   * Including:
+   * - Current, daily, weekly, monthly, yearly APY
+   * - Collateral & loan asset data
+   * - Liquidation loan-to-value ratio
+   * - Collateral, borrow & liquidity value
+   * - Utilization ratio
+   * - Pertinent metadata
+   * - Whitelist status
    */
   async market(
     request: operations.MorphoMarketRequest,
@@ -138,6 +154,9 @@ export class Morpho extends ClientSDK {
    *
    * @remarks
    * Check user's overall position across the entire Morpho ecosystem.
+   *
+   * Inlcuding all vault and market position metrics and relavant metadata of said vaults
+   * and markets.
    */
   async userPosition(
     request: operations.MorphoUserPositionRequest,