@morpho-org/blue-sdk 2.0.0-test.1 → 2.0.0

package/lib/market/MarketUtils.d.ts

@@ -1,6 +1,6 @@
-import { RoundingDirection } from "../maths";
-import { BigIntish, MarketId } from "../types";
-import { MarketParams } from "./MarketConfig";
+import { type RoundingDirection } from "../math/index.js";
+import type { BigIntish, MarketId } from "../types.js";
+import type { IMarketParams } from "./MarketParams.js";
 /**
  * Namespace of utility functions to ease market-related calculations.
  */
@@ -9,7 +9,7 @@ export declare namespace MarketUtils {
      * Returns the id of a market based on its params.
      * @param market The market params.
      */
-    function getMarketId(market: MarketParams): MarketId;
+    function getMarketId(market: IMarketParams): MarketId;
     /**
      * Returns the liquidation incentive factor for a given market params.
      * @param config The market params.
@@ -26,7 +26,7 @@ export declare namespace MarketUtils {
         totalBorrowAssets: BigIntish;
     }): bigint;
     /**
-     * Returns the rate at which interest accrued on average for suppliers on the corresponding market,
+     * Returns the rate at which interest accrued for suppliers on the corresponding market,
      * since the last time the market was updated (scaled by WAD).
      * @param borrowRate The average borrow rate since the last market update (scaled by WAD).
      * @param market The market state.
@@ -36,10 +36,12 @@ export declare namespace MarketUtils {
         fee: BigIntish;
     }): bigint;
     /**
-     * Returns the Annual Percentage Yield (APY) from an average rate, as calculated in Morpho Blue.
-     * @param rate The average rate to convert to APY (scaled by WAD).
+     * Returns the per-second rate continuously compounded over the given period, as calculated in Morpho Blue (scaled by WAD).
+     * If the period is 1 year, the compounded rate correspond to the Annual Percentage Yield (APY)
+     * @param rate The per-second rate to compound (scaled by WAD).
+     * @param period The period to compound the rate over (in seconds). Defaults to 1 year.
      */
-    function getApy(rate: BigIntish): bigint;
+    function compoundRate(rate: BigIntish, period?: BigIntish): bigint;
     /**
      * Returns the interest accrued on both sides of the given market
      * as well as the supply shares minted to the fee recipient.
@@ -95,72 +97,106 @@ export declare namespace MarketUtils {
     function getCollateralPower(collateral: BigIntish, { lltv }: {
         lltv: BigIntish;
     }): bigint;
+    /**
+     * Returns the value of a given amount of collateral quoted in loan assets.
+     * Return `undefined` iff the market's price is undefined.
+     */
     function getCollateralValue(collateral: BigIntish, { price }: {
-        price: BigIntish;
-    }): bigint;
+        price?: BigIntish;
+    }): bigint | undefined;
+    /**
+     * Returns the maximum debt allowed given a certain amount of collateral.
+     * Return `undefined` iff the market's price is undefined.
+     * To calculate the amount of loan assets that can be borrowed, use `getMaxBorrowableAssets`.
+     */
     function getMaxBorrowAssets(collateral: BigIntish, market: {
-        price: BigIntish;
+        price?: BigIntish;
     }, { lltv }: {
         lltv: BigIntish;
-    }): bigint;
+    }): bigint | undefined;
+    /**
+     * Returns the maximum amount of loan assets that can be borrowed given a certain borrow position.
+     * Return `undefined` iff the market's price is undefined.
+     */
     function getMaxBorrowableAssets({ collateral, borrowShares, }: {
         collateral: BigIntish;
         borrowShares: BigIntish;
     }, market: {
         totalBorrowAssets: BigIntish;
         totalBorrowShares: BigIntish;
-        price: BigIntish;
-    }, marketConfig: {
+        price?: BigIntish;
+    }, marketParams: {
         lltv: BigIntish;
-    }): bigint;
+    }): bigint | undefined;
+    /**
+     * Returns the amount of collateral that would be seized in a liquidation given a certain amount of repaid shares.
+     * Return `undefined` iff the market's price is undefined.
+     */
     function getLiquidationSeizedAssets(repaidShares: BigIntish, market: {
         totalBorrowAssets: BigIntish;
         totalBorrowShares: BigIntish;
-        price: BigIntish;
+        price?: BigIntish;
     }, config: {
         lltv: BigIntish;
-    }): bigint;
+    }): bigint | undefined;
+    /**
+     * Returns the amount of borrow shares that would be repaid in a liquidation given a certain amount of seized collateral.
+     * Return `undefined` iff the market's price is undefined.
+     */
     function getLiquidationRepaidShares(seizedAssets: BigIntish, market: {
         totalBorrowAssets: BigIntish;
         totalBorrowShares: BigIntish;
-        price: BigIntish;
+        price?: BigIntish;
     }, config: {
         lltv: BigIntish;
-    }): bigint;
+    }): bigint | undefined;
+    /**
+     * Returns the maximum amount of collateral that is worth being seized in a liquidation given a certain borrow position.
+     * Return `undefined` iff the market's price is undefined.
+     */
     function getSeizableCollateral(position: {
         collateral: BigIntish;
         borrowShares: BigIntish;
     }, market: {
         totalBorrowAssets: BigIntish;
         totalBorrowShares: BigIntish;
-        price: BigIntish;
+        price?: BigIntish;
     }, config: {
         lltv: BigIntish;
-    }): bigint;
+    }): bigint | undefined;
+    /**
+     * Returns the amount of collateral that can be withdrawn given a certain borrow position.
+     * Return `undefined` iff the market's price is undefined.
+     */
     function getWithdrawableCollateral({ collateral, borrowShares, }: {
         collateral: BigIntish;
         borrowShares: BigIntish;
     }, market: {
         totalBorrowAssets: BigIntish;
         totalBorrowShares: BigIntish;
-        price: BigIntish;
+        price?: BigIntish;
     }, { lltv }: {
         lltv: BigIntish;
-    }): bigint;
+    }): bigint | undefined;
+    /**
+     * Returns whether a given borrow position is healthy.
+     * Return `undefined` iff the market's price is undefined.
+     * @param position The borrow position to check.
+     */
     function isHealthy({ collateral, borrowShares, }: {
         collateral: BigIntish;
         borrowShares: BigIntish;
     }, market: {
         totalBorrowAssets: BigIntish;
         totalBorrowShares: BigIntish;
-        price: BigIntish;
-    }, marketConfig: {
+        price?: BigIntish;
+    }, marketParams: {
         lltv: BigIntish;
-    }): boolean;
+    }): boolean | undefined;
     /**
      * Returns the price of the collateral quoted in the loan token (e.g. ETH/DAI)
      * that set the user's position to be liquidatable.
-     * Returns null if the user is not a borrower
+     * Returns null if the position is not a borrow.
      */
     function getLiquidationPrice({ collateral, borrowShares, }: {
         collateral: BigIntish;
@@ -168,51 +204,67 @@ export declare namespace MarketUtils {
     }, market: {
         totalBorrowAssets: BigIntish;
         totalBorrowShares: BigIntish;
-    }, marketConfig: {
+    }, marketParams: {
         lltv: BigIntish;
     }): bigint | null;
     /**
-     * Returns the price deviation required for the given borrow position to be unhealthy (scaled by WAD).
-     * @param position The borrow position to consider.
+     * Returns the price variation required for the given position to reach its liquidation threshold (scaled by WAD).
+     * Negative when healthy (the price needs to drop x%), positive when unhealthy (the price needs to soar x%).
+     * Returns `undefined` iff the market's price is undefined.
+     * Returns null if the position is not a borrow.
      */
-    function getPriceVariationToLiquidation(position: {
+    function getPriceVariationToLiquidationPrice(position: {
         collateral: BigIntish;
         borrowShares: BigIntish;
     }, market: {
         totalBorrowAssets: BigIntish;
         totalBorrowShares: BigIntish;
-        price: BigIntish;
-    }, marketConfig: {
+        price?: BigIntish;
+    }, marketParams: {
         lltv: BigIntish;
-    }): bigint | null;
+    }): bigint | null | undefined;
+    /**
+     * Returns the health factor of a given borrow position (scaled by WAD).
+     * Returns `undefined` iff the market's price is undefined.
+     * Returns null if the position is not a borrow.
+     */
     function getHealthFactor({ collateral, borrowShares, }: {
         collateral: BigIntish;
         borrowShares: BigIntish;
     }, market: {
         totalBorrowAssets: BigIntish;
         totalBorrowShares: BigIntish;
-        price: BigIntish;
-    }, marketConfig: {
+        price?: BigIntish;
+    }, marketParams: {
         lltv: BigIntish;
-    }): bigint | null;
+    }): bigint | null | undefined;
+    /**
+     * Returns the loan-to-value ratio of a given borrow position (scaled by WAD).
+     * Returns `undefined` iff the market's price is undefined.
+     * Returns null if the position is not a borrow.
+     */
     function getLtv({ collateral, borrowShares, }: {
         collateral: BigIntish;
         borrowShares: BigIntish;
     }, market: {
         totalBorrowAssets: BigIntish;
         totalBorrowShares: BigIntish;
-        price: BigIntish;
-    }): bigint | null;
+        price?: BigIntish;
+    }): bigint | null | undefined;
+    /**
+     * Returns the usage ratio of the maximum borrow capacity given a certain borrow position (scaled by WAD).
+     * Returns `undefined` iff the market's price is undefined.
+     */
     function getBorrowCapacityUsage(position: {
         collateral: BigIntish;
         borrowShares: BigIntish;
     }, market: {
         totalBorrowAssets: BigIntish;
         totalBorrowShares: BigIntish;
-        price: BigIntish;
-    }, marketConfig: {
+        price?: BigIntish;
+    }, marketParams: {
         lltv: BigIntish;
-    }): bigint | null;
+    }): bigint | undefined;
     function toSupplyAssets(shares: BigIntish, market: {
         totalSupplyAssets: BigIntish;
         totalSupplyShares: BigIntish;

package/lib/market/MarketUtils.js

@@ -1,12 +1,10 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MarketUtils = void 0;
-const keccak256_1 = __importDefault(require("keccak256"));
-const constants_1 = require("../constants");
-const maths_1 = require("../maths");
+const sha3_1 = require("@noble/hashes/sha3");
+const utils_1 = require("@noble/hashes/utils");
+const constants_js_1 = require("../constants.js");
+const index_js_1 = require("../math/index.js");
 /**
  * Namespace of utility functions to ease market-related calculations.
  */
@@ -17,12 +15,14 @@ var MarketUtils;
      * @param market The market params.
      */
     function getMarketId(market) {
-        return `0x${(0, keccak256_1.default)("0x" +
-            market.loanToken.substring(2).toLowerCase().padStart(64, "0") +
-            market.collateralToken.substring(2).toLowerCase().padStart(64, "0") +
+        return `0x${(0, utils_1.bytesToHex)((0, sha3_1.keccak_256)((0, utils_1.hexToBytes)(`${market.loanToken.substring(2).toLowerCase().padStart(64, "0") +
+            market.collateralToken
+                .substring(2)
+                .toLowerCase()
+                .padStart(64, "0") +
             market.oracle.substring(2).padStart(64, "0") +
             market.irm.substring(2).toLowerCase().padStart(64, "0") +
-            BigInt(market.lltv).toString(16).padStart(64, "0")).toString("hex")}`;
+            BigInt(market.lltv).toString(16).padStart(64, "0")}`)))}`;
     }
     MarketUtils.getMarketId = getMarketId;
     /**
@@ -30,8 +30,8 @@ var MarketUtils;
      * @param config The market params.
      */
     function getLiquidationIncentiveFactor({ lltv }) {
-        return maths_1.MathLib.min(constants_1.MAX_LIQUIDATION_INCENTIVE_FACTOR, maths_1.MathLib.wDivDown(maths_1.MathLib.WAD, maths_1.MathLib.WAD -
-            maths_1.MathLib.wMulDown(constants_1.LIQUIDATION_CURSOR, maths_1.MathLib.WAD - BigInt(lltv))));
+        return index_js_1.MathLib.min(constants_js_1.MAX_LIQUIDATION_INCENTIVE_FACTOR, index_js_1.MathLib.wDivDown(index_js_1.MathLib.WAD, index_js_1.MathLib.WAD -
+            index_js_1.MathLib.wMulDown(constants_js_1.LIQUIDATION_CURSOR, index_js_1.MathLib.WAD - BigInt(lltv))));
     }
     MarketUtils.getLiquidationIncentiveFactor = getLiquidationIncentiveFactor;
     /**
@@ -43,31 +43,33 @@ var MarketUtils;
         totalBorrowAssets = BigInt(totalBorrowAssets);
         if (totalSupplyAssets === 0n) {
             if (totalBorrowAssets > 0n)
-                return maths_1.MathLib.MAX_UINT_256;
+                return index_js_1.MathLib.MAX_UINT_256;
             return 0n;
         }
-        return maths_1.MathLib.wDivDown(totalBorrowAssets, totalSupplyAssets);
+        return index_js_1.MathLib.wDivDown(totalBorrowAssets, totalSupplyAssets);
     }
     MarketUtils.getUtilization = getUtilization;
     /**
-     * Returns the rate at which interest accrued on average for suppliers on the corresponding market,
+     * Returns the rate at which interest accrued for suppliers on the corresponding market,
      * since the last time the market was updated (scaled by WAD).
      * @param borrowRate The average borrow rate since the last market update (scaled by WAD).
      * @param market The market state.
      */
     function getSupplyRate(borrowRate, { utilization, fee }) {
-        const borrowRateWithoutFees = maths_1.MathLib.wMulUp(borrowRate, utilization);
-        return maths_1.MathLib.wMulUp(borrowRateWithoutFees, maths_1.MathLib.WAD - BigInt(fee));
+        const borrowRateWithoutFees = index_js_1.MathLib.wMulUp(borrowRate, utilization);
+        return index_js_1.MathLib.wMulUp(borrowRateWithoutFees, index_js_1.MathLib.WAD - BigInt(fee));
     }
     MarketUtils.getSupplyRate = getSupplyRate;
     /**
-     * Returns the Annual Percentage Yield (APY) from an average rate, as calculated in Morpho Blue.
-     * @param rate The average rate to convert to APY (scaled by WAD).
+     * Returns the per-second rate continuously compounded over the given period, as calculated in Morpho Blue (scaled by WAD).
+     * If the period is 1 year, the compounded rate correspond to the Annual Percentage Yield (APY)
+     * @param rate The per-second rate to compound (scaled by WAD).
+     * @param period The period to compound the rate over (in seconds). Defaults to 1 year.
      */
-    function getApy(rate) {
-        return maths_1.MathLib.wTaylorCompounded(rate, constants_1.SECONDS_PER_YEAR);
+    function compoundRate(rate, period = constants_js_1.SECONDS_PER_YEAR) {
+        return index_js_1.MathLib.wTaylorCompounded(rate, period);
     }
-    MarketUtils.getApy = getApy;
+    MarketUtils.compoundRate = compoundRate;
     /**
      * Returns the interest accrued on both sides of the given market
      * as well as the supply shares minted to the fee recipient.
@@ -76,8 +78,8 @@ var MarketUtils;
      * @param elapsed The time elapsed since the last market update (in seconds).
      */
     function getAccruedInterest(borrowRate, { totalSupplyAssets, totalBorrowAssets, totalSupplyShares, fee, }, elapsed = 0n) {
-        const interest = maths_1.MathLib.wMulDown(totalBorrowAssets, maths_1.MathLib.wTaylorCompounded(borrowRate, elapsed));
-        const feeAmount = maths_1.MathLib.wMulDown(interest, fee);
+        const interest = index_js_1.MathLib.wMulDown(totalBorrowAssets, index_js_1.MathLib.wTaylorCompounded(borrowRate, elapsed));
+        const feeAmount = index_js_1.MathLib.wMulDown(interest, fee);
         const feeShares = toSupplyShares(feeAmount, {
             totalSupplyAssets: BigInt(totalSupplyAssets) - feeAmount,
             totalSupplyShares,
@@ -95,9 +97,9 @@ var MarketUtils;
         if (utilization === 0n) {
             if (getUtilization(market) === 0n)
                 return 0n;
-            return maths_1.MathLib.MAX_UINT_256;
+            return index_js_1.MathLib.MAX_UINT_256;
         }
-        return maths_1.MathLib.zeroFloorSub(maths_1.MathLib.wDivUp(market.totalBorrowAssets, utilization), market.totalSupplyAssets);
+        return index_js_1.MathLib.zeroFloorSub(index_js_1.MathLib.wDivUp(market.totalBorrowAssets, utilization), market.totalSupplyAssets);
     }
     MarketUtils.getSupplyToUtilization = getSupplyToUtilization;
     /**
@@ -114,7 +116,7 @@ var MarketUtils;
                 return totalSupplyAssets;
             return 0n;
         }
-        return maths_1.MathLib.zeroFloorSub(totalSupplyAssets, maths_1.MathLib.wDivUp(totalBorrowAssets, utilization));
+        return index_js_1.MathLib.zeroFloorSub(totalSupplyAssets, index_js_1.MathLib.wDivUp(totalBorrowAssets, utilization));
     }
     MarketUtils.getWithdrawToUtilization = getWithdrawToUtilization;
     /**
@@ -123,7 +125,7 @@ var MarketUtils;
      * @param utilization The target utilization rate (scaled by WAD).
      */
     function getBorrowToUtilization({ totalSupplyAssets, totalBorrowAssets, }, utilization) {
-        return maths_1.MathLib.zeroFloorSub(maths_1.MathLib.wMulDown(totalSupplyAssets, utilization), totalBorrowAssets);
+        return index_js_1.MathLib.zeroFloorSub(index_js_1.MathLib.wMulDown(totalSupplyAssets, utilization), totalBorrowAssets);
     }
     MarketUtils.getBorrowToUtilization = getBorrowToUtilization;
     /**
@@ -132,132 +134,208 @@ var MarketUtils;
      * @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));
+        return index_js_1.MathLib.zeroFloorSub(totalBorrowAssets, index_js_1.MathLib.wMulDown(totalSupplyAssets, utilization));
     }
     MarketUtils.getRepayToUtilization = getRepayToUtilization;
     function getCollateralPower(collateral, { lltv }) {
-        return maths_1.MathLib.wMulDown(collateral, lltv);
+        return index_js_1.MathLib.wMulDown(collateral, lltv);
     }
     MarketUtils.getCollateralPower = getCollateralPower;
+    /**
+     * Returns the value of a given amount of collateral quoted in loan assets.
+     * Return `undefined` iff the market's price is undefined.
+     */
     function getCollateralValue(collateral, { price }) {
-        return maths_1.MathLib.mulDivDown(collateral, price, constants_1.ORACLE_PRICE_SCALE);
+        if (price == null)
+            return;
+        return index_js_1.MathLib.mulDivDown(collateral, price, constants_js_1.ORACLE_PRICE_SCALE);
     }
     MarketUtils.getCollateralValue = getCollateralValue;
+    /**
+     * Returns the maximum debt allowed given a certain amount of collateral.
+     * Return `undefined` iff the market's price is undefined.
+     * To calculate the amount of loan assets that can be borrowed, use `getMaxBorrowableAssets`.
+     */
     function getMaxBorrowAssets(collateral, market, { lltv }) {
-        return maths_1.MathLib.wMulDown(getCollateralValue(collateral, market), lltv);
+        const collateralValue = getCollateralValue(collateral, market);
+        if (collateralValue == null)
+            return;
+        return index_js_1.MathLib.wMulDown(collateralValue, lltv);
     }
     MarketUtils.getMaxBorrowAssets = getMaxBorrowAssets;
-    function getMaxBorrowableAssets({ collateral, borrowShares, }, market, marketConfig) {
-        return maths_1.MathLib.zeroFloorSub(getMaxBorrowAssets(collateral, market, marketConfig), toBorrowAssets(borrowShares, market));
+    /**
+     * Returns the maximum amount of loan assets that can be borrowed given a certain borrow position.
+     * Return `undefined` iff the market's price is undefined.
+     */
+    function getMaxBorrowableAssets({ collateral, borrowShares, }, market, marketParams) {
+        const maxBorrowAssets = getMaxBorrowAssets(collateral, market, marketParams);
+        if (maxBorrowAssets == null)
+            return;
+        return index_js_1.MathLib.zeroFloorSub(maxBorrowAssets, toBorrowAssets(borrowShares, market));
     }
     MarketUtils.getMaxBorrowableAssets = getMaxBorrowableAssets;
+    /**
+     * Returns the amount of collateral that would be seized in a liquidation given a certain amount of repaid shares.
+     * Return `undefined` iff the market's price is undefined.
+     */
     function getLiquidationSeizedAssets(repaidShares, market, config) {
+        if (market.price == null)
+            return;
         market.price = BigInt(market.price);
         if (market.price === 0n)
             return 0n;
-        return maths_1.MathLib.mulDivDown(maths_1.MathLib.wMulDown(toBorrowAssets(repaidShares, market, "Down"), getLiquidationIncentiveFactor(config)), constants_1.ORACLE_PRICE_SCALE, market.price);
+        return index_js_1.MathLib.mulDivDown(index_js_1.MathLib.wMulDown(toBorrowAssets(repaidShares, market, "Down"), getLiquidationIncentiveFactor(config)), constants_js_1.ORACLE_PRICE_SCALE, market.price);
     }
     MarketUtils.getLiquidationSeizedAssets = getLiquidationSeizedAssets;
+    /**
+     * Returns the amount of borrow shares that would be repaid in a liquidation given a certain amount of seized collateral.
+     * Return `undefined` iff the market's price is undefined.
+     */
     function getLiquidationRepaidShares(seizedAssets, market, config) {
-        return toBorrowShares(maths_1.MathLib.wDivUp(maths_1.MathLib.mulDivUp(seizedAssets, market.price, constants_1.ORACLE_PRICE_SCALE), getLiquidationIncentiveFactor(config)), market, "Up");
+        if (market.price == null)
+            return;
+        return toBorrowShares(index_js_1.MathLib.wDivUp(index_js_1.MathLib.mulDivUp(seizedAssets, market.price, constants_js_1.ORACLE_PRICE_SCALE), getLiquidationIncentiveFactor(config)), market, "Up");
     }
     MarketUtils.getLiquidationRepaidShares = getLiquidationRepaidShares;
+    /**
+     * Returns the maximum amount of collateral that is worth being seized in a liquidation given a certain borrow position.
+     * Return `undefined` iff the market's price is undefined.
+     */
     function getSeizableCollateral(position, market, config) {
+        if (market.price == null)
+            return; // Must be checked before calling `isHealthy`.
         market.price = BigInt(market.price);
         if (market.price === 0n || isHealthy(position, market, config))
             return 0n;
-        return maths_1.MathLib.min(position.collateral, getLiquidationSeizedAssets(position.borrowShares, market, config));
+        return index_js_1.MathLib.min(position.collateral, getLiquidationSeizedAssets(position.borrowShares, market, config));
     }
     MarketUtils.getSeizableCollateral = getSeizableCollateral;
+    /**
+     * Returns the amount of collateral that can be withdrawn given a certain borrow position.
+     * Return `undefined` iff the market's price is undefined.
+     */
     function getWithdrawableCollateral({ collateral, borrowShares, }, market, { lltv }) {
+        if (market.price == null)
+            return;
         market.price = BigInt(market.price);
         if (market.price === 0n)
             return 0n;
-        return maths_1.MathLib.zeroFloorSub(collateral, maths_1.MathLib.wDivUp(maths_1.MathLib.mulDivUp(toBorrowAssets(borrowShares, market), constants_1.ORACLE_PRICE_SCALE, market.price), lltv));
+        return index_js_1.MathLib.zeroFloorSub(collateral, index_js_1.MathLib.wDivUp(index_js_1.MathLib.mulDivUp(toBorrowAssets(borrowShares, market), constants_js_1.ORACLE_PRICE_SCALE, market.price), lltv));
     }
     MarketUtils.getWithdrawableCollateral = getWithdrawableCollateral;
-    function isHealthy({ collateral, borrowShares, }, market, marketConfig) {
-        return (getMaxBorrowAssets(collateral, market, marketConfig) >=
-            toBorrowAssets(borrowShares, market));
+    /**
+     * Returns whether a given borrow position is healthy.
+     * Return `undefined` iff the market's price is undefined.
+     * @param position The borrow position to check.
+     */
+    function isHealthy({ collateral, borrowShares, }, market, marketParams) {
+        const maxBorrowAssets = getMaxBorrowAssets(collateral, market, marketParams);
+        if (maxBorrowAssets == null)
+            return;
+        return maxBorrowAssets >= toBorrowAssets(borrowShares, market);
     }
     MarketUtils.isHealthy = isHealthy;
     /**
      * Returns the price of the collateral quoted in the loan token (e.g. ETH/DAI)
      * that set the user's position to be liquidatable.
-     * Returns null if the user is not a borrower
+     * Returns null if the position is not a borrow.
      */
-    function getLiquidationPrice({ collateral, borrowShares, }, market, marketConfig) {
+    function getLiquidationPrice({ collateral, borrowShares, }, market, marketParams) {
         borrowShares = BigInt(borrowShares);
         market.totalBorrowShares = BigInt(market.totalBorrowShares);
         if (borrowShares === 0n || market.totalBorrowShares === 0n)
             return null;
-        const collateralPower = getCollateralPower(collateral, marketConfig);
+        const collateralPower = getCollateralPower(collateral, marketParams);
         if (collateralPower === 0n)
-            return maths_1.MathLib.MAX_UINT_256;
+            return index_js_1.MathLib.MAX_UINT_256;
         const borrowAssets = toBorrowAssets(borrowShares, market);
-        return maths_1.MathLib.mulDivUp(borrowAssets, constants_1.ORACLE_PRICE_SCALE, collateralPower);
+        return index_js_1.MathLib.mulDivUp(borrowAssets, constants_js_1.ORACLE_PRICE_SCALE, collateralPower);
     }
     MarketUtils.getLiquidationPrice = getLiquidationPrice;
     /**
-     * Returns the price deviation required for the given borrow position to be unhealthy (scaled by WAD).
-     * @param position The borrow position to consider.
+     * Returns the price variation required for the given position to reach its liquidation threshold (scaled by WAD).
+     * Negative when healthy (the price needs to drop x%), positive when unhealthy (the price needs to soar x%).
+     * Returns `undefined` iff the market's price is undefined.
+     * Returns null if the position is not a borrow.
      */
-    function getPriceVariationToLiquidation(position, market, marketConfig) {
+    function getPriceVariationToLiquidationPrice(position, market, marketParams) {
+        if (market.price == null)
+            return;
         market.price = BigInt(market.price);
         if (market.price === 0n)
             return null;
-        const liquidationPrice = getLiquidationPrice(position, market, marketConfig);
+        const liquidationPrice = getLiquidationPrice(position, market, marketParams);
         if (liquidationPrice == null)
             return null;
-        return maths_1.MathLib.WAD - maths_1.MathLib.wDivUp(liquidationPrice, market.price);
+        return index_js_1.MathLib.wDivUp(liquidationPrice, market.price) - index_js_1.MathLib.WAD;
     }
-    MarketUtils.getPriceVariationToLiquidation = getPriceVariationToLiquidation;
-    function getHealthFactor({ collateral, borrowShares, }, market, marketConfig) {
+    MarketUtils.getPriceVariationToLiquidationPrice = getPriceVariationToLiquidationPrice;
+    /**
+     * Returns the health factor of a given borrow position (scaled by WAD).
+     * Returns `undefined` iff the market's price is undefined.
+     * Returns null if the position is not a borrow.
+     */
+    function getHealthFactor({ collateral, borrowShares, }, market, marketParams) {
         borrowShares = BigInt(borrowShares);
         market.totalBorrowShares = BigInt(market.totalBorrowShares);
         if (borrowShares === 0n || market.totalBorrowShares === 0n)
             return null;
         const borrowAssets = toBorrowAssets(borrowShares, market);
         if (borrowAssets === 0n)
-            return maths_1.MathLib.MAX_UINT_256;
-        const maxBorrowAssets = getMaxBorrowAssets(collateral, market, marketConfig);
-        return maths_1.MathLib.wDivDown(maxBorrowAssets, borrowAssets);
+            return index_js_1.MathLib.MAX_UINT_256;
+        const maxBorrowAssets = getMaxBorrowAssets(collateral, market, marketParams);
+        if (maxBorrowAssets == null)
+            return;
+        return index_js_1.MathLib.wDivDown(maxBorrowAssets, borrowAssets);
     }
     MarketUtils.getHealthFactor = getHealthFactor;
+    /**
+     * Returns the loan-to-value ratio of a given borrow position (scaled by WAD).
+     * Returns `undefined` iff the market's price is undefined.
+     * Returns null if the position is not a borrow.
+     */
     function getLtv({ collateral, borrowShares, }, market) {
         borrowShares = BigInt(borrowShares);
         market.totalBorrowShares = BigInt(market.totalBorrowShares);
         if (borrowShares === 0n || market.totalBorrowShares === 0n)
             return null;
         const collateralValue = getCollateralValue(collateral, market);
+        if (collateralValue == null)
+            return;
         if (collateralValue === 0n)
-            return maths_1.MathLib.MAX_UINT_256;
-        return maths_1.MathLib.wDivUp(toBorrowAssets(borrowShares, market), collateralValue);
+            return index_js_1.MathLib.MAX_UINT_256;
+        return index_js_1.MathLib.wDivUp(toBorrowAssets(borrowShares, market), collateralValue);
     }
     MarketUtils.getLtv = getLtv;
-    function getBorrowCapacityUsage(position, market, marketConfig) {
-        const hf = getHealthFactor(position, market, marketConfig);
+    /**
+     * Returns the usage ratio of the maximum borrow capacity given a certain borrow position (scaled by WAD).
+     * Returns `undefined` iff the market's price is undefined.
+     */
+    function getBorrowCapacityUsage(position, market, marketParams) {
+        const hf = getHealthFactor(position, market, marketParams);
+        if (hf === undefined)
+            return;
         if (hf === null)
-            return null;
+            return 0n;
         if (hf === 0n)
-            return maths_1.MathLib.MAX_UINT_256;
-        return maths_1.MathLib.wDivUp(maths_1.MathLib.WAD, hf);
+            return index_js_1.MathLib.MAX_UINT_256;
+        return index_js_1.MathLib.wDivUp(index_js_1.MathLib.WAD, hf);
     }
     MarketUtils.getBorrowCapacityUsage = getBorrowCapacityUsage;
     function toSupplyAssets(shares, market, rounding = "Down") {
-        return maths_1.SharesMath.toAssets(shares, market.totalSupplyAssets, market.totalSupplyShares, rounding);
+        return index_js_1.SharesMath.toAssets(shares, market.totalSupplyAssets, market.totalSupplyShares, rounding);
     }
     MarketUtils.toSupplyAssets = toSupplyAssets;
     function toSupplyShares(assets, market, rounding = "Up") {
-        return maths_1.SharesMath.toShares(assets, market.totalSupplyAssets, market.totalSupplyShares, rounding);
+        return index_js_1.SharesMath.toShares(assets, market.totalSupplyAssets, market.totalSupplyShares, rounding);
     }
     MarketUtils.toSupplyShares = toSupplyShares;
     function toBorrowAssets(shares, market, rounding = "Up") {
-        return maths_1.SharesMath.toAssets(shares, market.totalBorrowAssets, market.totalBorrowShares, rounding);
+        return index_js_1.SharesMath.toAssets(shares, market.totalBorrowAssets, market.totalBorrowShares, rounding);
     }
     MarketUtils.toBorrowAssets = toBorrowAssets;
     function toBorrowShares(assets, market, rounding = "Down") {
-        return maths_1.SharesMath.toShares(assets, market.totalBorrowAssets, market.totalBorrowShares, rounding);
+        return index_js_1.SharesMath.toShares(assets, market.totalBorrowAssets, market.totalBorrowShares, rounding);
     }
     MarketUtils.toBorrowShares = toBorrowShares;
 })(MarketUtils || (exports.MarketUtils = MarketUtils = {}));

package/lib/market/index.d.ts

@@ -1,3 +1,3 @@
-export * from "./MarketUtils";
-export * from "./MarketConfig";
-export * from "./Market";
+export * from "./MarketUtils.js";
+export * from "./MarketParams.js";
+export * from "./Market.js";

package/lib/market/index.js

@@ -14,6 +14,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./MarketUtils"), exports);
-__exportStar(require("./MarketConfig"), exports);
-__exportStar(require("./Market"), exports);
+__exportStar(require("./MarketUtils.js"), exports);
+__exportStar(require("./MarketParams.js"), exports);
+__exportStar(require("./Market.js"), exports);