@morpho-org/blue-sdk 1.4.0 → 1.4.2

package/lib/market/Market.d.ts

@@ -162,15 +162,25 @@ export declare class Market implements InputMarket {
      */
     toBorrowShares(assets: bigint, rounding?: RoundingDirection): bigint;
     /**
-     * Returns the liquidity available to borrow until the market reach the given utilization rate.
+     * Returns the volume to supply until the market gets the closest to the given utilization rate.
      * @param utilization The target utilization rate (scaled by WAD).
      */
-    getSupplyLiquidityToUtilization(utilization: bigint): BigIntish;
+    getSupplyToUtilization(utilization: bigint): BigIntish;
     /**
-     * Returns the liquidity available to borrow until the market reach the given utilization rate.
+     * Returns the liquidity available to withdraw until the market gets the closest to the given utilization rate.
      * @param utilization The target utilization rate (scaled by WAD).
      */
-    getBorrowLiquidityToUtilization(utilization: bigint): bigint;
+    getWithdrawToUtilization(utilization: bigint): BigIntish;
+    /**
+     * Returns the liquidity available to borrow until the market gets the closest to the given utilization rate.
+     * @param utilization The target utilization rate (scaled by WAD).
+     */
+    getBorrowToUtilization(utilization: bigint): bigint;
+    /**
+     * Returns the volume to repay until the market gets the closest to the given utilization rate.
+     * @param utilization The target utilization rate (scaled by WAD).
+     */
+    getRepayToUtilization(utilization: bigint): bigint;
     /**
      * Returns the value of a given amount of collateral quoted in loan assets.
      * @param collateral The amount of collateral to quote.

package/lib/market/Market.js

@@ -140,8 +140,8 @@ class Market {
             return this;
         let borrowRate = 0n;
         let { rateAtTarget } = this;
-        if (this.rateAtTarget != null) {
-            const { avgBorrowRate, endRateAtTarget } = maths_1.AdaptiveCurveIrmLib.getBorrowRate(this.utilization, this.rateAtTarget, elapsed);
+        if (rateAtTarget != null) {
+            const { avgBorrowRate, endRateAtTarget } = maths_1.AdaptiveCurveIrmLib.getBorrowRate(this.utilization, rateAtTarget, elapsed);
             borrowRate = avgBorrowRate;
             rateAtTarget = endRateAtTarget;
         }
@@ -240,18 +240,32 @@ class Market {
         return MarketUtils_1.MarketUtils.toBorrowShares(assets, this, rounding);
     }
     /**
-     * Returns the liquidity available to borrow until the market reach the given utilization rate.
+     * Returns the volume to supply until the market gets the closest to the given utilization rate.
      * @param utilization The target utilization rate (scaled by WAD).
      */
-    getSupplyLiquidityToUtilization(utilization) {
-        return MarketUtils_1.MarketUtils.getSupplyLiquidityToUtilization(this, utilization);
+    getSupplyToUtilization(utilization) {
+        return MarketUtils_1.MarketUtils.getSupplyToUtilization(this, utilization);
     }
     /**
-     * Returns the liquidity available to borrow until the market reach the given utilization rate.
+     * Returns the liquidity available to withdraw until the market gets the closest to the given utilization rate.
      * @param utilization The target utilization rate (scaled by WAD).
      */
-    getBorrowLiquidityToUtilization(utilization) {
-        return MarketUtils_1.MarketUtils.getBorrowLiquidityToUtilization(this, utilization);
+    getWithdrawToUtilization(utilization) {
+        return MarketUtils_1.MarketUtils.getWithdrawToUtilization(this, utilization);
+    }
+    /**
+     * Returns the liquidity available to borrow until the market gets the closest to the given utilization rate.
+     * @param utilization The target utilization rate (scaled by WAD).
+     */
+    getBorrowToUtilization(utilization) {
+        return MarketUtils_1.MarketUtils.getBorrowToUtilization(this, utilization);
+    }
+    /**
+     * Returns the volume to repay until the market gets the closest to the given utilization rate.
+     * @param utilization The target utilization rate (scaled by WAD).
+     */
+    getRepayToUtilization(utilization) {
+        return MarketUtils_1.MarketUtils.getRepayToUtilization(this, utilization);
     }
     /**
      * Returns the value of a given amount of collateral quoted in loan assets.

package/lib/market/MarketUtils.d.ts

@@ -57,20 +57,38 @@ export declare namespace MarketUtils {
         feeShares: bigint;
     };
     /**
-     * Returns the liquidity available to withdraw until the market reach the given utilization rate.
+     * Returns the volume to supply until the market gets the closest to the given utilization rate.
      * @param market The market state.
      * @param utilization The target utilization rate (scaled by WAD).
      */
-    function getSupplyLiquidityToUtilization({ totalSupplyAssets, totalBorrowAssets, }: {
+    function getSupplyToUtilization({ totalSupplyAssets, totalBorrowAssets, }: {
         totalSupplyAssets: BigIntish;
         totalBorrowAssets: BigIntish;
     }, utilization: BigIntish): BigIntish;
     /**
-     * Returns the liquidity available to borrow until the market reach the given utilization rate.
+     * Returns the liquidity available to withdraw until the market gets the closest to the given utilization rate.
      * @param market The market state.
      * @param utilization The target utilization rate (scaled by WAD).
      */
-    function getBorrowLiquidityToUtilization({ totalSupplyAssets, totalBorrowAssets, }: {
+    function getWithdrawToUtilization({ totalSupplyAssets, totalBorrowAssets, }: {
+        totalSupplyAssets: BigIntish;
+        totalBorrowAssets: BigIntish;
+    }, utilization: BigIntish): BigIntish;
+    /**
+     * Returns the liquidity available to borrow until the market gets the closest to the given utilization rate.
+     * @param market The market state.
+     * @param utilization The target utilization rate (scaled by WAD).
+     */
+    function getBorrowToUtilization({ totalSupplyAssets, totalBorrowAssets, }: {
+        totalSupplyAssets: BigIntish;
+        totalBorrowAssets: BigIntish;
+    }, utilization: BigIntish): bigint;
+    /**
+     * Returns the volume to repay until the market gets the closest to the given utilization rate.
+     * @param market The market state.
+     * @param utilization The target utilization rate (scaled by WAD).
+     */
+    function getRepayToUtilization({ totalSupplyAssets, totalBorrowAssets, }: {
         totalSupplyAssets: BigIntish;
         totalBorrowAssets: BigIntish;
     }, utilization: BigIntish): bigint;

package/lib/market/MarketUtils.js

@@ -86,11 +86,27 @@ var MarketUtils;
     }
     MarketUtils.getAccruedInterest = getAccruedInterest;
     /**
-     * Returns the liquidity available to withdraw until the market reach the given utilization rate.
+     * Returns the volume to supply until the market gets the closest to the given utilization rate.
      * @param market The market state.
      * @param utilization The target utilization rate (scaled by WAD).
      */
-    function getSupplyLiquidityToUtilization({ totalSupplyAssets, totalBorrowAssets, }, utilization) {
+    function getSupplyToUtilization({ totalSupplyAssets, totalBorrowAssets, }, utilization) {
+        utilization = BigInt(utilization);
+        totalBorrowAssets = BigInt(totalBorrowAssets);
+        if (utilization === 0n) {
+            if (totalBorrowAssets === 0n)
+                return totalSupplyAssets;
+            return 0n;
+        }
+        return maths_1.MathLib.zeroFloorSub(maths_1.MathLib.wDivUp(totalBorrowAssets, utilization), totalSupplyAssets);
+    }
+    MarketUtils.getSupplyToUtilization = getSupplyToUtilization;
+    /**
+     * Returns the liquidity available to withdraw until the market gets the closest to the given utilization rate.
+     * @param market The market state.
+     * @param utilization The target utilization rate (scaled by WAD).
+     */
+    function getWithdrawToUtilization({ totalSupplyAssets, totalBorrowAssets, }, utilization) {
         utilization = BigInt(utilization);
         totalBorrowAssets = BigInt(totalBorrowAssets);
         if (utilization === 0n) {
@@ -100,16 +116,25 @@ var MarketUtils;
         }
         return maths_1.MathLib.zeroFloorSub(totalSupplyAssets, maths_1.MathLib.wDivUp(totalBorrowAssets, utilization));
     }
-    MarketUtils.getSupplyLiquidityToUtilization = getSupplyLiquidityToUtilization;
+    MarketUtils.getWithdrawToUtilization = getWithdrawToUtilization;
     /**
-     * Returns the liquidity available to borrow until the market reach the given utilization rate.
+     * Returns the liquidity available to borrow until the market gets the closest to the given utilization rate.
      * @param market The market state.
      * @param utilization The target utilization rate (scaled by WAD).
      */
-    function getBorrowLiquidityToUtilization({ totalSupplyAssets, totalBorrowAssets, }, utilization) {
+    function getBorrowToUtilization({ totalSupplyAssets, totalBorrowAssets, }, utilization) {
         return maths_1.MathLib.zeroFloorSub(maths_1.MathLib.wMulDown(totalSupplyAssets, utilization), totalBorrowAssets);
     }
-    MarketUtils.getBorrowLiquidityToUtilization = getBorrowLiquidityToUtilization;
+    MarketUtils.getBorrowToUtilization = getBorrowToUtilization;
+    /**
+     * Returns the volume to repay until the market gets the closest to the given utilization rate.
+     * @param market The market state.
+     * @param utilization The target utilization rate (scaled by WAD).
+     */
+    function getRepayToUtilization({ totalSupplyAssets, totalBorrowAssets, }, utilization) {
+        return maths_1.MathLib.zeroFloorSub(totalBorrowAssets, maths_1.MathLib.wMulDown(totalSupplyAssets, utilization));
+    }
+    MarketUtils.getRepayToUtilization = getRepayToUtilization;
     function getCollateralPower(collateral, { lltv }) {
         return maths_1.MathLib.wMulDown(collateral, lltv);
     }

package/lib/market/MarketUtils.test.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const maths_1 = require("../maths");
 const MarketUtils_1 = require("./MarketUtils");
 const market = {
     loanToken: "0x0000000000000000000000000000000000000001",
@@ -15,4 +16,21 @@ describe("MarketUtils", () => {
     it("should calculate the correct liquidation incentive factor", () => {
         expect(MarketUtils_1.MarketUtils.getLiquidationIncentiveFactor(market)).toEqual(1043841336116910229n);
     });
+    it("should calculate the supply volume to reach utilization", () => {
+        expect(MarketUtils_1.MarketUtils.getSupplyToUtilization({ totalSupplyAssets: maths_1.MathLib.WAD, totalBorrowAssets: maths_1.MathLib.WAD }, 900000000000000000n)).toEqual(111111111111111112n);
+        expect(MarketUtils_1.MarketUtils.getSupplyToUtilization({ totalSupplyAssets: maths_1.MathLib.WAD, totalBorrowAssets: 0n }, 900000000000000000n)).toEqual(0n);
+    });
+    it("should calculate the withdraw volume to reach utilization", () => {
+        expect(MarketUtils_1.MarketUtils.getWithdrawToUtilization({ totalSupplyAssets: maths_1.MathLib.WAD, totalBorrowAssets: maths_1.MathLib.WAD }, 900000000000000000n)).toEqual(0n);
+        expect(MarketUtils_1.MarketUtils.getWithdrawToUtilization({ totalSupplyAssets: 2n * maths_1.MathLib.WAD, totalBorrowAssets: maths_1.MathLib.WAD }, 900000000000000000n)).toEqual(888888888888888888n);
+        expect(MarketUtils_1.MarketUtils.getWithdrawToUtilization({ totalSupplyAssets: maths_1.MathLib.WAD, totalBorrowAssets: 0n }, 900000000000000000n)).toEqual(maths_1.MathLib.WAD);
+    });
+    it("should calculate the borrow volume to reach utilization", () => {
+        expect(MarketUtils_1.MarketUtils.getBorrowToUtilization({ totalSupplyAssets: maths_1.MathLib.WAD, totalBorrowAssets: maths_1.MathLib.WAD }, 900000000000000000n)).toEqual(0n);
+        expect(MarketUtils_1.MarketUtils.getBorrowToUtilization({ totalSupplyAssets: maths_1.MathLib.WAD, totalBorrowAssets: 0n }, 900000000000000000n)).toEqual(900000000000000000n);
+    });
+    it("should calculate the repay volume to reach utilization", () => {
+        expect(MarketUtils_1.MarketUtils.getRepayToUtilization({ totalSupplyAssets: maths_1.MathLib.WAD, totalBorrowAssets: maths_1.MathLib.WAD }, 900000000000000000n)).toEqual(100000000000000000n);
+        expect(MarketUtils_1.MarketUtils.getRepayToUtilization({ totalSupplyAssets: maths_1.MathLib.WAD, totalBorrowAssets: 0n }, 900000000000000000n)).toEqual(0n);
+    });
 });

package/lib/maths/AdaptiveCurveIrmLib.d.ts

@@ -35,4 +35,5 @@ export declare namespace AdaptiveCurveIrmLib {
         avgBorrowRate: bigint;
         endRateAtTarget: bigint;
     };
+    function getUtilizationAtBorrowRate(borrowRate: BigIntish, rateAtTarget: BigIntish): bigint;
 }

package/lib/maths/AdaptiveCurveIrmLib.js

@@ -116,4 +116,16 @@ var AdaptiveCurveIrmLib;
         };
     }
     AdaptiveCurveIrmLib.getBorrowRate = getBorrowRate;
+    function getUtilizationAtBorrowRate(borrowRate, rateAtTarget) {
+        borrowRate = BigInt(borrowRate);
+        rateAtTarget = BigInt(rateAtTarget);
+        if (borrowRate >= rateAtTarget) {
+            const maxBorrowRate = MathLib_1.MathLib.wMulDown(rateAtTarget, AdaptiveCurveIrmLib.CURVE_STEEPNESS);
+            return MathLib_1.MathLib.min(MathLib_1.MathLib.WAD, AdaptiveCurveIrmLib.TARGET_UTILIZATION +
+                MathLib_1.MathLib.mulDivDown(MathLib_1.MathLib.WAD - AdaptiveCurveIrmLib.TARGET_UTILIZATION, borrowRate - rateAtTarget, maxBorrowRate - rateAtTarget));
+        }
+        const minBorrowRate = MathLib_1.MathLib.wDivDown(rateAtTarget, AdaptiveCurveIrmLib.CURVE_STEEPNESS);
+        return MathLib_1.MathLib.max(0n, MathLib_1.MathLib.mulDivDown(AdaptiveCurveIrmLib.TARGET_UTILIZATION, borrowRate - minBorrowRate, rateAtTarget - minBorrowRate));
+    }
+    AdaptiveCurveIrmLib.getUtilizationAtBorrowRate = getUtilizationAtBorrowRate;
 })(AdaptiveCurveIrmLib || (exports.AdaptiveCurveIrmLib = AdaptiveCurveIrmLib = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@morpho-org/blue-sdk",
-  "version": "1.4.0",
+  "version": "1.4.2",
   "author": "Morpho Association <contact@morpho.org>",
   "license": "MIT",
   "main": "lib/index.js",
@@ -13,17 +13,20 @@
     "test": "jest"
   },
   "dependencies": {
-    "@morpho-org/morpho-ts": "^1.4.0",
     "keccak256": "^1.0.6"
   },
   "devDependencies": {
-    "@morpho-org/morpho-test": "^1.4.0",
+    "@morpho-org/morpho-test": "^1.4.2",
+    "@morpho-org/morpho-ts": "^1.4.2",
     "@types/jest": "^29.5.12",
     "@types/node": "^22.0.0",
     "jest": "^29.7.0",
     "ts-jest": "^29.2.2",
     "typescript": "^5.4.5"
   },
+  "peerDependencies": {
+    "@morpho-org/morpho-ts": "^1.4.2"
+  },
   "publishConfig": {
     "access": "public"
   },
@@ -46,5 +49,5 @@
     ],
     "preset": "ts-jest"
   },
-  "gitHead": "a58c35ff1cf51728fe72db7eb4542bafc0a6d8ac"
+  "gitHead": "b11ee6671da97837dd8356b3fb5e8867375a2a19"
 }