@compass-labs/api-sdk 0.0.20 → 0.0.21

package/dist/esm/sdk/aavev3.js

@@ -4,6 +4,7 @@
 import { aaveV3Borrow } from "../funcs/aaveV3Borrow.js";
 import { aaveV3HistoricalTransactions } from "../funcs/aaveV3HistoricalTransactions.js";
 import { aaveV3LiquidityChange } from "../funcs/aaveV3LiquidityChange.js";
+import { aaveV3Rate } from "../funcs/aaveV3Rate.js";
 import { aaveV3Repay } from "../funcs/aaveV3Repay.js";
 import { aaveV3Supply } from "../funcs/aaveV3Supply.js";
 import { aaveV3TokenPrice } from "../funcs/aaveV3TokenPrice.js";
@@ -13,6 +14,28 @@ import { aaveV3Withdraw } from "../funcs/aaveV3Withdraw.js";
 import { ClientSDK } from "../lib/sdks.js";
 import { unwrapAsync } from "../types/fp.js";
 export class AaveV3 extends ClientSDK {
+    /**
+     * Interest rates
+     *
+     * @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).
+     *
+     * For APY/APR on loans Aave offers both stable and fixed rates on certain tokens.
+     */
+    async rate(request, options) {
+        return unwrapAsync(aaveV3Rate(this, request, options));
+    }
     /**
      * Token prices
      *

package/dist/esm/sdk/aavev3.js.map

@@ -1 +1 @@
-{"version":3,"file":"aavev3.js","sourceRoot":"","sources":["../../../src/sdk/aavev3.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,4BAA4B,EAAE,MAAM,0CAA0C,CAAC;AACxF,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,0BAA0B,EAAE,MAAM,wCAAwC,CAAC;AACpF,OAAO,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AAClF,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,MAAO,SAAQ,SAAS;IACnC;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,UAAU,CACd,OAAyC,EACzC,OAAwB;QAExB,OAAO,WAAW,CAAC,gBAAgB,CACjC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,eAAe,CACnB,OAA8C,EAC9C,OAAwB;QAExB,OAAO,WAAW,CAAC,qBAAqB,CACtC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,mBAAmB,CACvB,OAAkD,EAClD,OAAwB;QAExB,OAAO,WAAW,CAAC,yBAAyB,CAC1C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,oBAAoB,CACxB,OAAmD,EACnD,OAAwB;QAExB,OAAO,WAAW,CAAC,0BAA0B,CAC3C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,sBAAsB,CAC1B,OAAqD,EACrD,OAAwB;QAExB,OAAO,WAAW,CAAC,4BAA4B,CAC7C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,MAAM,CACV,OAAqC,EACrC,OAAwB;QAExB,OAAO,WAAW,CAAC,YAAY,CAC7B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,MAAM,CACV,OAAqC,EACrC,OAAwB;QAExB,OAAO,WAAW,CAAC,YAAY,CAC7B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,KAAK,CACT,OAAoC,EACpC,OAAwB;QAExB,OAAO,WAAW,CAAC,WAAW,CAC5B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,QAAQ,CACZ,OAAuC,EACvC,OAAwB;QAExB,OAAO,WAAW,CAAC,cAAc,CAC/B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"aavev3.js","sourceRoot":"","sources":["../../../src/sdk/aavev3.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,4BAA4B,EAAE,MAAM,0CAA0C,CAAC;AACxF,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,0BAA0B,EAAE,MAAM,wCAAwC,CAAC;AACpF,OAAO,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AAClF,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,MAAO,SAAQ,SAAS;IACnC;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,IAAI,CACR,OAAmC,EACnC,OAAwB;QAExB,OAAO,WAAW,CAAC,UAAU,CAC3B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,UAAU,CACd,OAAyC,EACzC,OAAwB;QAExB,OAAO,WAAW,CAAC,gBAAgB,CACjC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,eAAe,CACnB,OAA8C,EAC9C,OAAwB;QAExB,OAAO,WAAW,CAAC,qBAAqB,CACtC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,mBAAmB,CACvB,OAAkD,EAClD,OAAwB;QAExB,OAAO,WAAW,CAAC,yBAAyB,CAC1C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,oBAAoB,CACxB,OAAmD,EACnD,OAAwB;QAExB,OAAO,WAAW,CAAC,0BAA0B,CAC3C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,sBAAsB,CAC1B,OAAqD,EACrD,OAAwB;QAExB,OAAO,WAAW,CAAC,4BAA4B,CAC7C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,MAAM,CACV,OAAqC,EACrC,OAAwB;QAExB,OAAO,WAAW,CAAC,YAAY,CAC7B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,MAAM,CACV,OAAqC,EACrC,OAAwB;QAExB,OAAO,WAAW,CAAC,YAAY,CAC7B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,KAAK,CACT,OAAoC,EACpC,OAAwB;QAExB,OAAO,WAAW,CAAC,WAAW,CAC5B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,QAAQ,CACZ,OAAuC,EACvC,OAAwB;QAExB,OAAO,WAAW,CAAC,cAAc,CAC/B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/esm/sdk/sky.d.ts

@@ -13,18 +13,26 @@ export declare class Sky extends ClientSDK {
      * Buy USDS
      *
      * @remarks
-     * Buy USDS with DAI or USDC on a 1:1 basis.
+     * Buy USDS with DAI or USDC on a 1:1 basis. There are no fees.
      *
-     * There are no fees.
+     * If buying with DAI, user will need to set an allowance on the DAI contract for the
+     * 'SkyDaiUsdsConverter' contract beforehand.
+     *
+     * If buying with USDC, user will need to set an allowance on the USDC contract for the
+     * 'SkyDaiUsdsConverter' contract beforehand.
      */
     buy(request: components.SkyBuyRequest, options?: RequestOptions): Promise<components.UnsignedTransaction>;
     /**
      * Sell USDS
      *
      * @remarks
-     * Sell USDS for DAI or USDC on a 1:1 basis.
+     * Sell USDS for DAI or USDC on a 1:1 basis. There are no fees.
      *
-     * There are no fees.
+     * If swapping to DAI, user will need to set an allowance on the USDS contract for the
+     * 'SkyDaiUsdsConverter' contract beforehand.
+     *
+     * If swapping to USDC, user will need to set an allowance on the USDS contract for the
+     * 'SkyUsdcUsdsConverter' contract beforehand.
      */
     sell(request: components.SkySellRequest, options?: RequestOptions): Promise<components.UnsignedTransaction>;
     /**

package/dist/esm/sdk/sky.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sky.d.ts","sourceRoot":"","sources":["../../../src/sdk/sky.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,GAAI,SAAQ,SAAS;IAChC;;;;;OAKG;IACG,QAAQ,CACZ,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,wBAAwB,CAAC;IAQ/C;;;;;;;OAOG;IACG,GAAG,CACP,OAAO,EAAE,UAAU,CAAC,aAAa,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mBAAmB,CAAC;IAQ1C;;;;;;;OAOG;IACG,IAAI,CACR,OAAO,EAAE,UAAU,CAAC,cAAc,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mBAAmB,CAAC;IAQ1C;;;;;;;OAOG;IACG,OAAO,CACX,OAAO,EAAE,UAAU,CAAC,iBAAiB,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mBAAmB,CAAC;IAQ1C;;;;;;;OAOG;IACG,QAAQ,CACZ,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mBAAmB,CAAC;CAO3C"}
+{"version":3,"file":"sky.d.ts","sourceRoot":"","sources":["../../../src/sdk/sky.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,GAAI,SAAQ,SAAS;IAChC;;;;;OAKG;IACG,QAAQ,CACZ,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,wBAAwB,CAAC;IAQ/C;;;;;;;;;;;OAWG;IACG,GAAG,CACP,OAAO,EAAE,UAAU,CAAC,aAAa,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mBAAmB,CAAC;IAQ1C;;;;;;;;;;;OAWG;IACG,IAAI,CACR,OAAO,EAAE,UAAU,CAAC,cAAc,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mBAAmB,CAAC;IAQ1C;;;;;;;OAOG;IACG,OAAO,CACX,OAAO,EAAE,UAAU,CAAC,iBAAiB,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mBAAmB,CAAC;IAQ1C;;;;;;;OAOG;IACG,QAAQ,CACZ,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mBAAmB,CAAC;CAO3C"}

package/dist/esm/sdk/sky.js

@@ -22,9 +22,13 @@ export class Sky extends ClientSDK {
      * Buy USDS
      *
      * @remarks
-     * Buy USDS with DAI or USDC on a 1:1 basis.
+     * Buy USDS with DAI or USDC on a 1:1 basis. There are no fees.
      *
-     * There are no fees.
+     * If buying with DAI, user will need to set an allowance on the DAI contract for the
+     * 'SkyDaiUsdsConverter' contract beforehand.
+     *
+     * If buying with USDC, user will need to set an allowance on the USDC contract for the
+     * 'SkyDaiUsdsConverter' contract beforehand.
      */
     async buy(request, options) {
         return unwrapAsync(skyBuy(this, request, options));
@@ -33,9 +37,13 @@ export class Sky extends ClientSDK {
      * Sell USDS
      *
      * @remarks
-     * Sell USDS for DAI or USDC on a 1:1 basis.
+     * Sell USDS for DAI or USDC on a 1:1 basis. There are no fees.
      *
-     * There are no fees.
+     * If swapping to DAI, user will need to set an allowance on the USDS contract for the
+     * 'SkyDaiUsdsConverter' contract beforehand.
+     *
+     * If swapping to USDC, user will need to set an allowance on the USDS contract for the
+     * 'SkyUsdcUsdsConverter' contract beforehand.
      */
     async sell(request, options) {
         return unwrapAsync(skySell(this, request, options));

package/dist/esm/sdk/sky.js.map

@@ -1 +1 @@
-{"version":3,"file":"sky.js","sourceRoot":"","sources":["../../../src/sdk/sky.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,GAAI,SAAQ,SAAS;IAChC;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,CACZ,OAAsC,EACtC,OAAwB;QAExB,OAAO,WAAW,CAAC,WAAW,CAC5B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,GAAG,CACP,OAAiC,EACjC,OAAwB;QAExB,OAAO,WAAW,CAAC,MAAM,CACvB,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,IAAI,CACR,OAAkC,EAClC,OAAwB;QAExB,OAAO,WAAW,CAAC,OAAO,CACxB,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,OAAO,CACX,OAAqC,EACrC,OAAwB;QAExB,OAAO,WAAW,CAAC,UAAU,CAC3B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,QAAQ,CACZ,OAAsC,EACtC,OAAwB;QAExB,OAAO,WAAW,CAAC,WAAW,CAC5B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"sky.js","sourceRoot":"","sources":["../../../src/sdk/sky.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,GAAI,SAAQ,SAAS;IAChC;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,CACZ,OAAsC,EACtC,OAAwB;QAExB,OAAO,WAAW,CAAC,WAAW,CAC5B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,GAAG,CACP,OAAiC,EACjC,OAAwB;QAExB,OAAO,WAAW,CAAC,MAAM,CACvB,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,IAAI,CACR,OAAkC,EAClC,OAAwB;QAExB,OAAO,WAAW,CAAC,OAAO,CACxB,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,OAAO,CACX,OAAqC,EACrC,OAAwB;QAExB,OAAO,WAAW,CAAC,UAAU,CAC3B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,QAAQ,CACZ,OAAsC,EACtC,OAAwB;QAExB,OAAO,WAAW,CAAC,WAAW,CAC5B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}

package/docs/sdks/aavev3/README.md

@@ -5,6 +5,7 @@
 
 ### Available Operations
 
+* [rate](#rate) - Interest rates
 * [tokenPrice](#tokenprice) - Token prices
 * [liquidityChange](#liquiditychange) - Liquidity index
 * [userPositionSummary](#userpositionsummary) - Positions - total
@@ -15,6 +16,98 @@
 * [repay](#repay) - Repay loans
 * [withdraw](#withdraw) - Unstake
 
+## 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).
+
+For APY/APR on loans Aave offers both stable and fixed rates on certain tokens.
+
+### Example Usage
+
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.aaveV3.rate({
+    chain: "arbitrum:mainnet",
+    token: "USDC",
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+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";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await aaveV3Rate(compassApiSDK, {
+    chain: "arbitrum:mainnet",
+    token: "USDC",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `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.AaveRateResponse](../../models/components/aaverateresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
 ## tokenPrice
 
 This endpoint retrieves the current price of a specified token in USD as

package/docs/sdks/sky/README.md

@@ -90,9 +90,13 @@ run();
 
 ## buy
 
-Buy USDS with DAI or USDC on a 1:1 basis.
+Buy USDS with DAI or USDC on a 1:1 basis. There are no fees.
 
-There are no fees.
+If buying with DAI, user will need to set an allowance on the DAI contract for the
+'SkyDaiUsdsConverter' contract beforehand.
+
+If buying with USDC, user will need to set an allowance on the USDC contract for the
+'SkyDaiUsdsConverter' contract beforehand.
 
 ### Example Usage
 
@@ -173,9 +177,13 @@ run();
 
 ## sell
 
-Sell USDS for DAI or USDC on a 1:1 basis.
+Sell USDS for DAI or USDC on a 1:1 basis. There are no fees.
 
-There are no fees.
+If swapping to DAI, user will need to set an allowance on the USDS contract for the
+'SkyDaiUsdsConverter' contract beforehand.
+
+If swapping to USDC, user will need to set an allowance on the USDS contract for the
+'SkyUsdcUsdsConverter' contract beforehand.
 
 ### Example Usage
 

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@compass-labs/api-sdk",
-  "version": "0.0.20",
+  "version": "0.0.21",
   "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.0.20",
+  "version": "0.0.21",
   "author": "royalnine",
   "type": "module",
   "bin": {

package/src/funcs/aaveV3Rate.ts

@@ -0,0 +1,182 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { CompassApiSDKCore } from "../core.js";
+import { encodeFormQuery } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import { APIError } from "../models/errors/apierror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Interest rates
+ *
+ * @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).
+ *
+ * For APY/APR on loans Aave offers both stable and fixed rates on certain tokens.
+ */
+export function aaveV3Rate(
+  client: CompassApiSDKCore,
+  request: operations.AaveRateRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.AaveRateResponse,
+    | errors.HTTPValidationError
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CompassApiSDKCore,
+  request: operations.AaveRateRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.AaveRateResponse,
+      | errors.HTTPValidationError
+      | APIError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.AaveRateRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/v0/aave/rate/get")();
+
+  const query = encodeFormQuery({
+    "chain": payload.chain,
+    "token": payload.token,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKeyAuth);
+  const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "aave_rate",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKeyAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["422", "4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    components.AaveRateResponse,
+    | errors.HTTPValidationError
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, components.AaveRateResponse$inboundSchema),
+    M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/skyBuy.ts

@@ -28,9 +28,13 @@ import { Result } from "../types/fp.js";
  * Buy USDS
  *
  * @remarks
- * Buy USDS with DAI or USDC on a 1:1 basis.
+ * Buy USDS with DAI or USDC on a 1:1 basis. There are no fees.
  *
- * There are no fees.
+ * If buying with DAI, user will need to set an allowance on the DAI contract for the
+ * 'SkyDaiUsdsConverter' contract beforehand.
+ *
+ * If buying with USDC, user will need to set an allowance on the USDC contract for the
+ * 'SkyDaiUsdsConverter' contract beforehand.
  */
 export function skyBuy(
   client: CompassApiSDKCore,

package/src/funcs/skySell.ts

@@ -28,9 +28,13 @@ import { Result } from "../types/fp.js";
  * Sell USDS
  *
  * @remarks
- * Sell USDS for DAI or USDC on a 1:1 basis.
+ * Sell USDS for DAI or USDC on a 1:1 basis. There are no fees.
  *
- * There are no fees.
+ * If swapping to DAI, user will need to set an allowance on the USDS contract for the
+ * 'SkyDaiUsdsConverter' contract beforehand.
+ *
+ * If swapping to USDC, user will need to set an allowance on the USDS contract for the
+ * 'SkyUsdcUsdsConverter' contract beforehand.
  */
 export function skySell(
   client: CompassApiSDKCore,

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.0.20",
+  sdkVersion: "0.0.21",
   genVersion: "2.598.22",
   userAgent:
-    "speakeasy-sdk/typescript 0.0.20 2.598.22 0.0.1 @compass-labs/api-sdk",
+    "speakeasy-sdk/typescript 0.0.21 2.598.22 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.0.20",
+    currentVersion: "0.0.21",
   },
 });
 

package/src/mcp-server/server.ts

@@ -16,6 +16,7 @@ import { createRegisterTool } from "./tools.js";
 import { tool$aaveV3Borrow } from "./tools/aaveV3Borrow.js";
 import { tool$aaveV3HistoricalTransactions } from "./tools/aaveV3HistoricalTransactions.js";
 import { tool$aaveV3LiquidityChange } from "./tools/aaveV3LiquidityChange.js";
+import { tool$aaveV3Rate } from "./tools/aaveV3Rate.js";
 import { tool$aaveV3Repay } from "./tools/aaveV3Repay.js";
 import { tool$aaveV3Supply } from "./tools/aaveV3Supply.js";
 import { tool$aaveV3TokenPrice } from "./tools/aaveV3TokenPrice.js";
@@ -80,7 +81,7 @@ export function createMCPServer(deps: {
 }) {
   const server = new McpServer({
     name: "CompassApiSDK",
-    version: "0.0.20",
+    version: "0.0.21",
   });
 
   const client = new CompassApiSDKCore({
@@ -110,6 +111,7 @@ export function createMCPServer(deps: {
   const register = { tool, resource, resourceTemplate, prompt };
   void register; // suppress unused warnings
 
+  tool(tool$aaveV3Rate);
   tool(tool$aaveV3TokenPrice);
   tool(tool$aaveV3LiquidityChange);
   tool(tool$aaveV3UserPositionSummary);

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

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { aaveV3Rate } from "../../funcs/aaveV3Rate.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.AaveRateRequest$inboundSchema,
+};
+
+export const tool$aaveV3Rate: ToolDefinition<typeof args> = {
+  name: "aave-v3-rate",
+  description: `Interest rates
+
+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.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await aaveV3Rate(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

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

@@ -14,9 +14,13 @@ export const tool$skyBuy: ToolDefinition<typeof args> = {
   name: "sky-buy",
   description: `Buy USDS
 
-Buy USDS with DAI or USDC on a 1:1 basis.
+Buy USDS with DAI or USDC on a 1:1 basis. There are no fees.
 
-There are no fees.`,
+If buying with DAI, user will need to set an allowance on the DAI contract for the
+'SkyDaiUsdsConverter' contract beforehand.
+
+If buying with USDC, user will need to set an allowance on the USDC contract for the
+'SkyDaiUsdsConverter' contract beforehand.`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await skyBuy(

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

@@ -14,9 +14,13 @@ export const tool$skySell: ToolDefinition<typeof args> = {
   name: "sky-sell",
   description: `Sell USDS
 
-Sell USDS for DAI or USDC on a 1:1 basis.
+Sell USDS for DAI or USDC on a 1:1 basis. There are no fees.
 
-There are no fees.`,
+If swapping to DAI, user will need to set an allowance on the USDS contract for the
+'SkyDaiUsdsConverter' contract beforehand.
+
+If swapping to USDC, user will need to set an allowance on the USDS contract for the
+'SkyUsdcUsdsConverter' contract beforehand.`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await skySell(