@compass-labs/api-sdk 0.1.1 → 0.1.3

package/docs/sdks/aavev3/README.md

@@ -5,10 +5,10 @@
 
 ### Available Operations
 
-* [stdRate](#stdrate) - Standard deviation of interest rates
-* [avgRate](#avgrate) - Average interest rates
+* [rate](#rate) - Interest Rates: now
+* [avgRate](#avgrate) - Interest Rates: time average
+* [stdRate](#stdrate) - Interest Rates: standard deviation
 * [reserveOverview](#reserveoverview) - Reserve overview
-* [rate](#rate) - Interest rates
 * [tokenPrice](#tokenprice) - Token prices
 * [liquidityChange](#liquiditychange) - Liquidity index
 * [userPositionSummary](#userpositionsummary) - Positions - total
@@ -19,9 +19,22 @@
 * [repay](#repay) - Repay loans
 * [withdraw](#withdraw) - Unstake
 
-## stdRate
+## rate
+
+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 the standard deviation of Interest Rates for Aave Reserves over time.
+For APY/APR on loans Aave offers both stable and fixed rates on certain tokens.
 
 ### Example Usage
 
@@ -33,10 +46,9 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.aaveV3.stdRate({
-    chain: "ethereum:mainnet",
+  const result = await compassApiSDK.aaveV3.rate({
+    chain: "arbitrum:mainnet",
     token: "USDC",
-    days: 7,
   });
 
   // Handle the result
@@ -52,7 +64,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
-import { aaveV3StdRate } from "@compass-labs/api-sdk/funcs/aaveV3StdRate.js";
+import { aaveV3Rate } from "@compass-labs/api-sdk/funcs/aaveV3Rate.js";
 
 // Use `CompassApiSDKCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -61,10 +73,9 @@ const compassApiSDK = new CompassApiSDKCore({
 });
 
 async function run() {
-  const res = await aaveV3StdRate(compassApiSDK, {
-    chain: "ethereum:mainnet",
+  const res = await aaveV3Rate(compassApiSDK, {
+    chain: "arbitrum:mainnet",
     token: "USDC",
-    days: 7,
   });
 
   if (!res.ok) {
@@ -84,14 +95,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.AaveStdRateRequest](../../models/operations/aavestdraterequest.md)                                                                                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.AaveRateRequest](../../models/operations/aaveraterequest.md)                                                                                                       | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
 
 ### Response
 
-**Promise\<[components.AaveSTDRateResponse](../../models/components/aavestdrateresponse.md)\>**
+**Promise\<[components.AaveRateResponse](../../models/components/aaverateresponse.md)\>**
 
 ### Errors
 
@@ -102,7 +113,7 @@ run();
 
 ## avgRate
 
-Returns time averaged Interest Rates for Aave Reserves.
+Provides time-weighted averages of deposit and borrow rates for Aave reserves.
 
 ### Example Usage
 
@@ -181,14 +192,10 @@ run();
 | errors.HTTPValidationError | 422                        | application/json           |
 | errors.APIError            | 4XX, 5XX                   | \*/\*                      |
 
-## reserveOverview
-
-Returns key metrics for Aave Reserves:
-- Total Supplied (TVL) in USD
-- Total Borrowed in USD
-- Utilization Ratio
+## stdRate
 
-See below for more info:
+Returns the historical standard deviation of lending and borrowing rates for Aave
+reserves, illustrating market volatility.
 
 ### Example Usage
 
@@ -200,9 +207,10 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.aaveV3.reserveOverview({
-    chain: "arbitrum:mainnet",
+  const result = await compassApiSDK.aaveV3.stdRate({
+    chain: "ethereum:mainnet",
     token: "USDC",
+    days: 7,
   });
 
   // Handle the result
@@ -218,7 +226,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
-import { aaveV3ReserveOverview } from "@compass-labs/api-sdk/funcs/aaveV3ReserveOverview.js";
+import { aaveV3StdRate } from "@compass-labs/api-sdk/funcs/aaveV3StdRate.js";
 
 // Use `CompassApiSDKCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -227,9 +235,10 @@ const compassApiSDK = new CompassApiSDKCore({
 });
 
 async function run() {
-  const res = await aaveV3ReserveOverview(compassApiSDK, {
-    chain: "arbitrum:mainnet",
+  const res = await aaveV3StdRate(compassApiSDK, {
+    chain: "ethereum:mainnet",
     token: "USDC",
+    days: 7,
   });
 
   if (!res.ok) {
@@ -249,14 +258,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.AaveReserveOverviewRequest](../../models/operations/aavereserveoverviewrequest.md)                                                                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.AaveStdRateRequest](../../models/operations/aavestdraterequest.md)                                                                                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
 
 ### Response
 
-**Promise\<[components.AaveReserveOverviewResponse](../../models/components/aavereserveoverviewresponse.md)\>**
+**Promise\<[components.AaveSTDRateResponse](../../models/components/aavestdrateresponse.md)\>**
 
 ### Errors
 
@@ -265,22 +274,14 @@ run();
 | errors.HTTPValidationError | 422                        | application/json           |
 | errors.APIError            | 4XX, 5XX                   | \*/\*                      |
 
-## rate
-
-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.
+## reserveOverview
 
-**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:
 
 ### Example Usage
 
@@ -292,7 +293,7 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.aaveV3.rate({
+  const result = await compassApiSDK.aaveV3.reserveOverview({
     chain: "arbitrum:mainnet",
     token: "USDC",
   });
@@ -310,7 +311,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
-import { aaveV3Rate } from "@compass-labs/api-sdk/funcs/aaveV3Rate.js";
+import { aaveV3ReserveOverview } from "@compass-labs/api-sdk/funcs/aaveV3ReserveOverview.js";
 
 // Use `CompassApiSDKCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -319,7 +320,7 @@ const compassApiSDK = new CompassApiSDKCore({
 });
 
 async function run() {
-  const res = await aaveV3Rate(compassApiSDK, {
+  const res = await aaveV3ReserveOverview(compassApiSDK, {
     chain: "arbitrum:mainnet",
     token: "USDC",
   });
@@ -341,14 +342,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.AaveRateRequest](../../models/operations/aaveraterequest.md)                                                                                                       | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.AaveReserveOverviewRequest](../../models/operations/aavereserveoverviewrequest.md)                                                                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
 
 ### Response
 
-**Promise\<[components.AaveRateResponse](../../models/components/aaverateresponse.md)\>**
+**Promise\<[components.AaveReserveOverviewResponse](../../models/components/aavereserveoverviewresponse.md)\>**
 
 ### Errors
 

package/docs/sdks/morpho/README.md

@@ -22,7 +22,7 @@
 
 ## vaults
 
-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
@@ -105,6 +105,13 @@ run();
 
 Get data & metrics for a specific Morpho vault.
 
+Including:
+- Current, daily, weekly, monthly, yearly APY
+- Underlying asset data
+- Total liquidity
+- Pertinent metadata
+- Whitelist status
+
 ### Example Usage
 
 ```typescript
@@ -346,6 +353,15 @@ run();
 
 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
+
 ### Example Usage
 
 ```typescript
@@ -507,6 +523,9 @@ run();
 
 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.
+
 ### Example Usage
 
 ```typescript

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@compass-labs/api-sdk",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@compass-labs/api-sdk",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "author": "royalnine",
   "type": "module",
   "bin": {

package/src/funcs/aaveV3AvgRate.ts

@@ -26,10 +26,10 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * 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.
  */
 export function aaveV3AvgRate(
   client: CompassApiSDKCore,

package/src/funcs/aaveV3Rate.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Interest rates
+ * Interest Rates: now
  *
  * @remarks
  * Returns the latest APY and APR rates for a specified token on Aave, for both

package/src/funcs/aaveV3StdRate.ts

@@ -26,10 +26,11 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Standard deviation of interest rates
+ * Interest Rates: standard deviation
  *
  * @remarks
- * Returns the standard deviation of Interest Rates for Aave Reserves over time.
+ * Returns the historical standard deviation of lending and borrowing rates for Aave
+ * reserves, illustrating market volatility.
  */
 export function aaveV3StdRate(
   client: CompassApiSDKCore,

package/src/funcs/morphoMarket.ts

@@ -30,6 +30,15 @@ import { Result } from "../types/fp.js";
  *
  * @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
  */
 export function morphoMarket(
   client: CompassApiSDKCore,

package/src/funcs/morphoUserPosition.ts

@@ -30,6 +30,9 @@ import { Result } from "../types/fp.js";
  *
  * @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.
  */
 export function morphoUserPosition(
   client: CompassApiSDKCore,

package/src/funcs/morphoVault.ts

@@ -30,6 +30,13 @@ import { Result } from "../types/fp.js";
  *
  * @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
  */
 export function morphoVault(
   client: CompassApiSDKCore,

package/src/funcs/morphoVaults.ts

@@ -29,7 +29,7 @@ import { Result } from "../types/fp.js";
  * 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

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.1.1",
+  sdkVersion: "0.1.3",
   genVersion: "2.605.6",
   userAgent:
-    "speakeasy-sdk/typescript 0.1.1 2.605.6 0.0.1 @compass-labs/api-sdk",
+    "speakeasy-sdk/typescript 0.1.3 2.605.6 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.1.1",
+    currentVersion: "0.1.3",
   },
 });
 

package/src/mcp-server/server.ts

@@ -89,7 +89,7 @@ export function createMCPServer(deps: {
 }) {
   const server = new McpServer({
     name: "CompassApiSDK",
-    version: "0.1.1",
+    version: "0.1.3",
   });
 
   const client = new CompassApiSDKCore({
@@ -119,10 +119,10 @@ export function createMCPServer(deps: {
   const register = { tool, resource, resourceTemplate, prompt };
   void register; // suppress unused warnings
 
-  tool(tool$aaveV3StdRate);
+  tool(tool$aaveV3Rate);
   tool(tool$aaveV3AvgRate);
+  tool(tool$aaveV3StdRate);
   tool(tool$aaveV3ReserveOverview);
-  tool(tool$aaveV3Rate);
   tool(tool$aaveV3TokenPrice);
   tool(tool$aaveV3LiquidityChange);
   tool(tool$aaveV3UserPositionSummary);

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

@@ -12,9 +12,9 @@ const args = {
 
 export const tool$aaveV3AvgRate: ToolDefinition<typeof args> = {
   name: "aave-v3-avg-rate",
-  description: `Average interest rates
+  description: `Interest Rates: time average
 
-Returns time averaged Interest Rates for Aave Reserves.`,
+Provides time-weighted averages of deposit and borrow rates for Aave reserves.`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await aaveV3AvgRate(

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

@@ -12,7 +12,7 @@ const args = {
 
 export const tool$aaveV3Rate: ToolDefinition<typeof args> = {
   name: "aave-v3-rate",
-  description: `Interest rates
+  description: `Interest Rates: now
 
 Returns the latest APY and APR rates for a specified token on Aave, for both
 deposits and loans.

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

@@ -12,9 +12,10 @@ const args = {
 
 export const tool$aaveV3StdRate: ToolDefinition<typeof args> = {
   name: "aave-v3-std-rate",
-  description: `Standard deviation of interest rates
+  description: `Interest Rates: standard deviation
 
-Returns the standard deviation of Interest Rates for Aave Reserves over time.`,
+Returns the historical standard deviation of lending and borrowing rates for Aave
+reserves, illustrating market volatility.`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await aaveV3StdRate(

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

@@ -14,7 +14,16 @@ export const tool$morphoMarket: ToolDefinition<typeof args> = {
   name: "morpho-market",
   description: `Get Market
 
-Get data & metrics for a specific Morpho market.`,
+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`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await morphoMarket(

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

@@ -14,7 +14,10 @@ export const tool$morphoUserPosition: ToolDefinition<typeof args> = {
   name: "morpho-user-position",
   description: `Check User Position
 
-Check user's overall position across the entire Morpho ecosystem.`,
+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.`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await morphoUserPosition(

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

@@ -14,7 +14,14 @@ export const tool$morphoVault: ToolDefinition<typeof args> = {
   name: "morpho-vault",
   description: `Get Vault
 
-Get data & metrics for a specific Morpho vault.`,
+Get data & metrics for a specific Morpho vault.
+
+Including:
+- Current, daily, weekly, monthly, yearly APY
+- Underlying asset data
+- Total liquidity
+- Pertinent metadata
+- Whitelist status`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await morphoVault(

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

@@ -14,7 +14,7 @@ export const tool$morphoVaults: ToolDefinition<typeof args> = {
   name: "morpho-vaults",
   description: `Get Vaults
 
-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