@compass-labs/api-sdk 0.0.29 → 0.0.30

package/FUNCTIONS.md

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

package/README.md

@@ -175,7 +175,7 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.aaveV3.avgRate({
+  const result = await compassApiSDK.aaveV3.stdRate({
     chain: "ethereum:mainnet",
     token: "USDC",
     days: 7,
@@ -210,7 +210,7 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.aaveV3.avgRate({
+  const result = await compassApiSDK.aaveV3.stdRate({
     chain: "ethereum:mainnet",
     token: "USDC",
     days: 7,
@@ -233,6 +233,7 @@ 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
 * [reserveOverview](docs/sdks/aavev3/README.md#reserveoverview) - Reserve overview
 * [rate](docs/sdks/aavev3/README.md#rate) - Interest rates
@@ -341,6 +342,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`aaveV3Rate`](docs/sdks/aavev3/README.md#rate) - Interest rates
 - [`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
 - [`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
@@ -412,7 +414,7 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.aaveV3.avgRate({
+  const result = await compassApiSDK.aaveV3.stdRate({
     chain: "ethereum:mainnet",
     token: "USDC",
     days: 7,
@@ -456,7 +458,7 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.aaveV3.avgRate({
+  const result = await compassApiSDK.aaveV3.stdRate({
     chain: "ethereum:mainnet",
     token: "USDC",
     days: 7,
@@ -474,7 +476,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 `avgRate` 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 `stdRate` method may throw the following errors:
 
 | Error Type                 | Status Code | Content Type     |
 | -------------------------- | ----------- | ---------------- |
@@ -497,7 +499,7 @@ const compassApiSDK = new CompassApiSDK({
 async function run() {
   let result;
   try {
-    result = await compassApiSDK.aaveV3.avgRate({
+    result = await compassApiSDK.aaveV3.stdRate({
       chain: "ethereum:mainnet",
       token: "USDC",
       days: 7,
@@ -560,7 +562,7 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.aaveV3.avgRate({
+  const result = await compassApiSDK.aaveV3.stdRate({
     chain: "ethereum:mainnet",
     token: "USDC",
     days: 7,