@compass-labs/api-sdk 0.1.2 → 0.1.3

package/FUNCTIONS.md

@@ -20,7 +20,7 @@ specific category of applications.
 
 ```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";
 import { SDKValidationError } from "@compass-labs/api-sdk/models/errors/sdkvalidationerror.js";
 
 // Use `CompassApiSDKCore` for best tree-shaking performance.
@@ -30,10 +30,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,
   });
 
   switch (true) {

package/README.md

@@ -180,10 +180,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
@@ -215,10 +214,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
@@ -238,10 +236,10 @@ run();
 
 ### [aaveV3](docs/sdks/aavev3/README.md)
 
-* [stdRate](docs/sdks/aavev3/README.md#stdrate) - Standard deviation of interest rates
-* [avgRate](docs/sdks/aavev3/README.md#avgrate) - Average interest rates
+* [rate](docs/sdks/aavev3/README.md#rate) - Interest Rates: now
+* [avgRate](docs/sdks/aavev3/README.md#avgrate) - Interest Rates: time average
+* [stdRate](docs/sdks/aavev3/README.md#stdrate) - Interest Rates: standard deviation
 * [reserveOverview](docs/sdks/aavev3/README.md#reserveoverview) - Reserve overview
-* [rate](docs/sdks/aavev3/README.md#rate) - Interest rates
 * [tokenPrice](docs/sdks/aavev3/README.md#tokenprice) - Token prices
 * [liquidityChange](docs/sdks/aavev3/README.md#liquiditychange) - Liquidity index
 * [userPositionSummary](docs/sdks/aavev3/README.md#userpositionsummary) - Positions - total
@@ -347,14 +345,14 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 
 <summary>Available standalone functions</summary>
 
-- [`aaveV3AvgRate`](docs/sdks/aavev3/README.md#avgrate) - Average interest rates
+- [`aaveV3AvgRate`](docs/sdks/aavev3/README.md#avgrate) - Interest Rates: time average
 - [`aaveV3Borrow`](docs/sdks/aavev3/README.md#borrow) - Borrow
 - [`aaveV3HistoricalTransactions`](docs/sdks/aavev3/README.md#historicaltransactions) - Historical transactions
 - [`aaveV3LiquidityChange`](docs/sdks/aavev3/README.md#liquiditychange) - Liquidity index
-- [`aaveV3Rate`](docs/sdks/aavev3/README.md#rate) - Interest rates
+- [`aaveV3Rate`](docs/sdks/aavev3/README.md#rate) - Interest Rates: now
 - [`aaveV3Repay`](docs/sdks/aavev3/README.md#repay) - Repay loans
 - [`aaveV3ReserveOverview`](docs/sdks/aavev3/README.md#reserveoverview) - Reserve overview
-- [`aaveV3StdRate`](docs/sdks/aavev3/README.md#stdrate) - Standard deviation of interest rates
+- [`aaveV3StdRate`](docs/sdks/aavev3/README.md#stdrate) - Interest Rates: standard deviation
 - [`aaveV3Supply`](docs/sdks/aavev3/README.md#supply) - Supply/Lend
 - [`aaveV3TokenPrice`](docs/sdks/aavev3/README.md#tokenprice) - Token prices
 - [`aaveV3UserPositionPerToken`](docs/sdks/aavev3/README.md#userpositionpertoken) - Positions - per token
@@ -430,10 +428,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,
   }, {
     retries: {
       strategy: "backoff",
@@ -474,10 +471,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
@@ -492,7 +488,7 @@ run();
 <!-- Start Error Handling [errors] -->
 ## Error Handling
 
-Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `stdRate` method may throw the following errors:
+Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `rate` method may throw the following errors:
 
 | Error Type                 | Status Code | Content Type     |
 | -------------------------- | ----------- | ---------------- |
@@ -515,10 +511,9 @@ const compassApiSDK = new CompassApiSDK({
 async function run() {
   let result;
   try {
-    result = await compassApiSDK.aaveV3.stdRate({
-      chain: "ethereum:mainnet",
+    result = await compassApiSDK.aaveV3.rate({
+      chain: "arbitrum:mainnet",
       token: "USDC",
-      days: 7,
     });
 
     // Handle the result
@@ -578,10 +573,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

package/bin/mcp-server.js

@@ -34229,9 +34229,9 @@ var init_config = __esm(() => {
   SDK_METADATA = {
     language: "typescript",
     openapiDocVersion: "0.0.1",
-    sdkVersion: "0.1.2",
+    sdkVersion: "0.1.3",
     genVersion: "2.605.6",
-    userAgent: "speakeasy-sdk/typescript 0.1.2 2.605.6 0.0.1 @compass-labs/api-sdk"
+    userAgent: "speakeasy-sdk/typescript 0.1.3 2.605.6 0.0.1 @compass-labs/api-sdk"
   };
 });
 
@@ -43604,9 +43604,9 @@ var init_aaveV3AvgRate2 = __esm(() => {
   };
   tool$aaveV3AvgRate = {
     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, args2, ctx) => {
       const [result, apiCall] = await aaveV3AvgRate(client, args2.request, { fetchOptions: { signal: ctx.signal } }).$inspect();
@@ -44045,7 +44045,7 @@ var init_aaveV3Rate2 = __esm(() => {
   };
   tool$aaveV3Rate = {
     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.
@@ -44384,9 +44384,10 @@ var init_aaveV3StdRate2 = __esm(() => {
   };
   tool$aaveV3StdRate = {
     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: args8,
     tool: async (client, args9, ctx) => {
       const [result, apiCall] = await aaveV3StdRate(client, args9.request, { fetchOptions: { signal: ctx.signal } }).$inspect();
@@ -50602,7 +50603,7 @@ it to be traded on DeFi protocols.`,
 function createMCPServer(deps) {
   const server = new McpServer({
     name: "CompassApiSDK",
-    version: "0.1.2"
+    version: "0.1.3"
   });
   const client = new CompassApiSDKCore({
     apiKeyAuth: deps.apiKeyAuth,
@@ -50616,10 +50617,10 @@ function createMCPServer(deps) {
   const resourceTemplate = createRegisterResourceTemplate(deps.logger, server, client, scopes);
   const prompt = createRegisterPrompt(deps.logger, server, client, scopes);
   const register = { tool, resource, resourceTemplate, prompt };
-  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);
@@ -51943,7 +51944,7 @@ var routes = an({
 var app = He(routes, {
   name: "mcp",
   versionInfo: {
-    currentVersion: "0.1.2"
+    currentVersion: "0.1.3"
   }
 });
 zt(app, process3.argv.slice(2), buildContext(process3));
@@ -51951,5 +51952,5 @@ export {
   app
 };
 
-//# debugId=A7162BC25E901E6164756E2164756E21
+//# debugId=D62D5457B9B50DCB64756E2164756E21
 //# sourceMappingURL=mcp-server.js.map