@compass-labs/api-sdk 0.0.27 → 0.0.29

package/FUNCTIONS.md

@@ -20,7 +20,7 @@ specific category of applications.
 
 ```typescript
 import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
-import { aaveV3ReserveOverview } from "@compass-labs/api-sdk/funcs/aaveV3ReserveOverview.js";
+import { aaveV3AvgRate } from "@compass-labs/api-sdk/funcs/aaveV3AvgRate.js";
 import { SDKValidationError } from "@compass-labs/api-sdk/models/errors/sdkvalidationerror.js";
 
 // Use `CompassApiSDKCore` for best tree-shaking performance.
@@ -30,9 +30,10 @@ const compassApiSDK = new CompassApiSDKCore({
 });
 
 async function run() {
-  const res = await aaveV3ReserveOverview(compassApiSDK, {
-    chain: "arbitrum:mainnet",
+  const res = await aaveV3AvgRate(compassApiSDK, {
+    chain: "ethereum:mainnet",
     token: "USDC",
+    days: 7,
   });
 
   switch (true) {

package/README.md

@@ -175,9 +175,10 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.aaveV3.reserveOverview({
-    chain: "arbitrum:mainnet",
+  const result = await compassApiSDK.aaveV3.avgRate({
+    chain: "ethereum:mainnet",
     token: "USDC",
+    days: 7,
   });
 
   // Handle the result
@@ -209,9 +210,10 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.aaveV3.reserveOverview({
-    chain: "arbitrum:mainnet",
+  const result = await compassApiSDK.aaveV3.avgRate({
+    chain: "ethereum:mainnet",
     token: "USDC",
+    days: 7,
   });
 
   // Handle the result
@@ -231,6 +233,7 @@ run();
 
 ### [aaveV3](docs/sdks/aavev3/README.md)
 
+* [avgRate](docs/sdks/aavev3/README.md#avgrate) - Average interest rates
 * [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
@@ -331,6 +334,7 @@ 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
 - [`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
@@ -408,9 +412,10 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.aaveV3.reserveOverview({
-    chain: "arbitrum:mainnet",
+  const result = await compassApiSDK.aaveV3.avgRate({
+    chain: "ethereum:mainnet",
     token: "USDC",
+    days: 7,
   }, {
     retries: {
       strategy: "backoff",
@@ -451,9 +456,10 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.aaveV3.reserveOverview({
-    chain: "arbitrum:mainnet",
+  const result = await compassApiSDK.aaveV3.avgRate({
+    chain: "ethereum:mainnet",
     token: "USDC",
+    days: 7,
   });
 
   // Handle the result
@@ -468,7 +474,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 `reserveOverview` 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 `avgRate` method may throw the following errors:
 
 | Error Type                 | Status Code | Content Type     |
 | -------------------------- | ----------- | ---------------- |
@@ -491,9 +497,10 @@ const compassApiSDK = new CompassApiSDK({
 async function run() {
   let result;
   try {
-    result = await compassApiSDK.aaveV3.reserveOverview({
-      chain: "arbitrum:mainnet",
+    result = await compassApiSDK.aaveV3.avgRate({
+      chain: "ethereum:mainnet",
       token: "USDC",
+      days: 7,
     });
 
     // Handle the result
@@ -553,9 +560,10 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.aaveV3.reserveOverview({
-    chain: "arbitrum:mainnet",
+  const result = await compassApiSDK.aaveV3.avgRate({
+    chain: "ethereum:mainnet",
     token: "USDC",
+    days: 7,
   });
 
   // Handle the result