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

package/lib/market/Market.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Market = exports.CapacityLimitReason = void 0;
-const errors_1 = require("../errors");
-const maths_1 = require("../maths");
-const MarketUtils_1 = require("./MarketUtils");
+const morpho_ts_1 = require("@morpho-org/morpho-ts");
+const errors_js_1 = require("../errors.js");
+const index_js_1 = require("../math/index.js");
+const MarketUtils_js_1 = require("./MarketUtils.js");
 var CapacityLimitReason;
 (function (CapacityLimitReason) {
     CapacityLimitReason["liquidity"] = "Liquidity";
@@ -17,9 +18,9 @@ var CapacityLimitReason;
  */
 class Market {
     /**
-     * The market's config.
+     * The market's params.
      */
-    config;
+    params;
     /**
      * The amount of loan assets supplied in total on the market.
      */
@@ -46,6 +47,7 @@ class Market {
     fee;
     /**
      * The price as returned by the market's oracle.
+     * `undefined` if the oracle is undefined or reverts.
      */
     price;
     /**
@@ -53,8 +55,8 @@ class Market {
      * Undefined otherwise.
      */
     rateAtTarget;
-    constructor({ config, totalSupplyAssets, totalBorrowAssets, totalSupplyShares, totalBorrowShares, lastUpdate, fee, price, rateAtTarget, }) {
-        this.config = config;
+    constructor({ params, totalSupplyAssets, totalBorrowAssets, totalSupplyShares, totalBorrowShares, lastUpdate, fee, price, rateAtTarget, }) {
+        this.params = params;
         this.totalSupplyAssets = totalSupplyAssets;
         this.totalBorrowAssets = totalBorrowAssets;
         this.totalSupplyShares = totalSupplyShares;
@@ -69,14 +71,13 @@ class Market {
      * The market's hex-encoded id, defined as the hash of the market params.
      */
     get id() {
-        return this.config.id;
+        return this.params.id;
     }
     /**
      * Whether the market satisfies the canonical definition of an idle market (i.e. collateral token is the zero address).
      */
     get isIdle() {
-        return (this.config.collateralToken ===
-            "0x0000000000000000000000000000000000000000");
+        return this.params.collateralToken === morpho_ts_1.ZERO_ADDRESS;
     }
     /**
      * @warning Cannot be used to calculate the liquidity available inside a callback,
@@ -89,7 +90,7 @@ class Market {
      * The market's utilization rate (scaled by WAD).
      */
     get utilization() {
-        return MarketUtils_1.MarketUtils.getUtilization(this);
+        return MarketUtils_js_1.MarketUtils.getUtilization(this);
     }
     /**
      * The market's Annual Percentage Yield (APY) at the IRM's target utilization rate, if applicable (scaled by WAD).
@@ -97,35 +98,35 @@ class Market {
     get apyAtTarget() {
         if (this.rateAtTarget == null)
             return;
-        return MarketUtils_1.MarketUtils.getApy(this.rateAtTarget);
+        return MarketUtils_js_1.MarketUtils.compoundRate(this.rateAtTarget);
     }
     /**
-     * Returns the rate at which interest accrued on average for suppliers of this market,
+     * Returns the rate at which interest accrued for suppliers of this market,
      * since the last time the market was updated (scaled by WAD).
      */
     get supplyRate() {
-        return MarketUtils_1.MarketUtils.getSupplyRate(this.borrowRate, this);
+        return MarketUtils_js_1.MarketUtils.getSupplyRate(this.borrowRate, this);
     }
     /**
-     * Returns the rate at which interest accrued on average for borrowers of this market,
+     * Returns the rate at which interest accrued for borrowers of this market,
      * since the last time the market was updated (scaled by WAD).
      */
     get borrowRate() {
         if (this.rateAtTarget == null)
             return 0n;
-        return maths_1.AdaptiveCurveIrmLib.getBorrowRate(this.utilization, this.rateAtTarget, 0n).avgBorrowRate;
+        return index_js_1.AdaptiveCurveIrmLib.getBorrowRate(this.utilization, this.rateAtTarget, 0n).avgBorrowRate;
     }
     /**
-     * The market's supply Annual Percentage Yield (APY) (scaled by WAD).
+     * The market's supply-side Annual Percentage Yield (APY) (scaled by WAD).
      */
     get supplyApy() {
-        return MarketUtils_1.MarketUtils.getApy(this.supplyRate);
+        return MarketUtils_js_1.MarketUtils.compoundRate(this.supplyRate);
     }
     /**
-     * The market's borrow Annual Percentage Yield (APY) (scaled by WAD).
+     * The market's borrow-side Annual Percentage Yield (APY) (scaled by WAD).
      */
     get borrowApy() {
-        return MarketUtils_1.MarketUtils.getApy(this.borrowRate);
+        return MarketUtils_js_1.MarketUtils.compoundRate(this.borrowRate);
     }
     /**
      * Returns a new market derived from this market, whose interest has been accrued up to the given timestamp.
@@ -135,17 +136,17 @@ class Market {
         timestamp = BigInt(timestamp);
         const elapsed = timestamp - this.lastUpdate;
         if (elapsed < 0n)
-            throw new errors_1.BlueErrors.InvalidInterestAccrual(this.id, timestamp, this.lastUpdate);
+            throw new errors_js_1.BlueErrors.InvalidInterestAccrual(this.id, timestamp, this.lastUpdate);
         if (elapsed === 0n)
             return new Market(this);
         let borrowRate = 0n;
         let { rateAtTarget } = this;
         if (rateAtTarget != null) {
-            const { avgBorrowRate, endRateAtTarget } = maths_1.AdaptiveCurveIrmLib.getBorrowRate(this.utilization, rateAtTarget, elapsed);
+            const { avgBorrowRate, endRateAtTarget } = index_js_1.AdaptiveCurveIrmLib.getBorrowRate(this.utilization, rateAtTarget, elapsed);
             borrowRate = avgBorrowRate;
             rateAtTarget = endRateAtTarget;
         }
-        const { interest, feeShares } = MarketUtils_1.MarketUtils.getAccruedInterest(borrowRate, this, elapsed);
+        const { interest, feeShares } = MarketUtils_js_1.MarketUtils.getAccruedInterest(borrowRate, this, elapsed);
         return new Market({
             ...this,
             totalSupplyAssets: this.totalSupplyAssets + interest,
@@ -157,7 +158,7 @@ class Market {
     }
     supply(assets, shares, timestamp) {
         if (assets === 0n && shares === 0n)
-            throw new errors_1.BlueErrors.InconsistentInput();
+            throw new errors_js_1.BlueErrors.InconsistentInput();
         const market = this.accrueInterest(timestamp);
         if (shares === 0n)
             shares = market.toSupplyShares(assets, "Down");
@@ -169,7 +170,7 @@ class Market {
     }
     withdraw(assets, shares, timestamp) {
         if (assets === 0n && shares === 0n)
-            throw new errors_1.BlueErrors.InconsistentInput();
+            throw new errors_js_1.BlueErrors.InconsistentInput();
         const market = this.accrueInterest(timestamp);
         if (shares === 0n)
             shares = market.toSupplyShares(assets, "Up");
@@ -178,12 +179,12 @@ class Market {
         market.totalSupplyAssets -= assets;
         market.totalSupplyShares -= shares;
         if (market.totalBorrowAssets > market.totalSupplyAssets)
-            throw new errors_1.BlueErrors.InsufficientLiquidity(market.id);
+            throw new errors_js_1.BlueErrors.InsufficientLiquidity(market.id);
         return { market, assets, shares };
     }
     borrow(assets, shares, timestamp) {
         if (assets === 0n && shares === 0n)
-            throw new errors_1.BlueErrors.InconsistentInput();
+            throw new errors_js_1.BlueErrors.InconsistentInput();
         const market = this.accrueInterest(timestamp);
         if (shares === 0n)
             shares = market.toBorrowShares(assets, "Up");
@@ -192,12 +193,12 @@ class Market {
         market.totalBorrowAssets += assets;
         market.totalBorrowShares += shares;
         if (market.totalBorrowAssets > market.totalSupplyAssets)
-            throw new errors_1.BlueErrors.InsufficientLiquidity(market.id);
+            throw new errors_js_1.BlueErrors.InsufficientLiquidity(market.id);
         return { market, assets, shares };
     }
     repay(assets, shares, timestamp) {
         if (assets === 0n && shares === 0n)
-            throw new errors_1.BlueErrors.InconsistentInput();
+            throw new errors_js_1.BlueErrors.InconsistentInput();
         const market = this.accrueInterest(timestamp);
         if (shares === 0n)
             shares = market.toBorrowShares(assets, "Down");
@@ -213,7 +214,7 @@ class Market {
      * @param rounding The rounding direction to use (defaults to "Down").
      */
     toSupplyAssets(shares, rounding) {
-        return MarketUtils_1.MarketUtils.toSupplyAssets(shares, this, rounding);
+        return MarketUtils_js_1.MarketUtils.toSupplyAssets(shares, this, rounding);
     }
     /**
      * Converts a given amount of supply loan assets into supply shares.
@@ -221,7 +222,7 @@ class Market {
      * @param rounding The rounding direction to use (defaults to "Up").
      */
     toSupplyShares(assets, rounding) {
-        return MarketUtils_1.MarketUtils.toSupplyShares(assets, this, rounding);
+        return MarketUtils_js_1.MarketUtils.toSupplyShares(assets, this, rounding);
     }
     /**
      * Converts a given amount of borrow shares into borrow loan assets.
@@ -229,7 +230,7 @@ class Market {
      * @param rounding The rounding direction to use (defaults to "Up").
      */
     toBorrowAssets(shares, rounding) {
-        return MarketUtils_1.MarketUtils.toBorrowAssets(shares, this, rounding);
+        return MarketUtils_js_1.MarketUtils.toBorrowAssets(shares, this, rounding);
     }
     /**
      * Converts a given amount of borrow loan assets into borrow shares.
@@ -237,140 +238,155 @@ class Market {
      * @param rounding The rounding direction to use (defaults to "Down").
      */
     toBorrowShares(assets, rounding) {
-        return MarketUtils_1.MarketUtils.toBorrowShares(assets, this, rounding);
+        return MarketUtils_js_1.MarketUtils.toBorrowShares(assets, this, rounding);
     }
     /**
      * Returns the smallest volume to supply until the market gets the closest to the given utilization rate.
      * @param utilization The target utilization rate (scaled by WAD).
      */
     getSupplyToUtilization(utilization) {
-        return MarketUtils_1.MarketUtils.getSupplyToUtilization(this, utilization);
+        return MarketUtils_js_1.MarketUtils.getSupplyToUtilization(this, utilization);
     }
     /**
      * 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).
      */
     getWithdrawToUtilization(utilization) {
-        return MarketUtils_1.MarketUtils.getWithdrawToUtilization(this, utilization);
+        return MarketUtils_js_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);
+        return MarketUtils_js_1.MarketUtils.getBorrowToUtilization(this, utilization);
     }
     /**
      * Returns the smallest 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);
+        return MarketUtils_js_1.MarketUtils.getRepayToUtilization(this, utilization);
     }
     /**
      * Returns the value of a given amount of collateral quoted in loan assets.
+     * `undefined` iff the market's oracle is undefined or reverts.
      * @param collateral The amount of collateral to quote.
      */
     getCollateralValue(collateral) {
-        return MarketUtils_1.MarketUtils.getCollateralValue(collateral, this);
+        return MarketUtils_js_1.MarketUtils.getCollateralValue(collateral, this);
     }
     /**
      * Returns the maximum debt allowed given a certain amount of collateral.
+     * `undefined` iff the market's oracle is undefined or reverts.
      * To calculate the amount of loan assets that can be borrowed, use `getMaxBorrowableAssets`.
      * @param collateral The amount of collateral to consider.
      */
-    getMaxBorrowAssets(collateral, { maxLtv = this.config.lltv } = {}) {
-        return MarketUtils_1.MarketUtils.getMaxBorrowAssets(collateral, this, {
-            lltv: maths_1.MathLib.min(maxLtv, this.config.lltv),
+    getMaxBorrowAssets(collateral, { maxLtv = this.params.lltv } = {}) {
+        return MarketUtils_js_1.MarketUtils.getMaxBorrowAssets(collateral, this, {
+            lltv: index_js_1.MathLib.min(maxLtv, this.params.lltv),
         });
     }
     /**
      * Returns the maximum amount of loan assets that can be borrowed given a certain borrow position.
+     * `undefined` iff the market's oracle is undefined or reverts.
      * @param position The borrow position to consider.
      */
     getMaxBorrowableAssets(position) {
-        return MarketUtils_1.MarketUtils.getMaxBorrowableAssets(position, this, this.config);
+        return MarketUtils_js_1.MarketUtils.getMaxBorrowableAssets(position, this, this.params);
     }
     /**
      * Returns the amount of collateral that would be seized in a liquidation given a certain amount of repaid shares.
+     * `undefined` iff the market's oracle is undefined or reverts.
      * @param repaidShares The amount of shares hypothetically repaid.
      */
     getLiquidationSeizedAssets(repaidShares) {
-        return MarketUtils_1.MarketUtils.getLiquidationSeizedAssets(repaidShares, this, this.config);
+        return MarketUtils_js_1.MarketUtils.getLiquidationSeizedAssets(repaidShares, this, this.params);
     }
     /**
      * Returns the amount of borrow shares that would be repaid in a liquidation given a certain amount of seized collateral.
+     * `undefined` iff the market's oracle is undefined or reverts.
      * @param seizedAssets The amount of collateral hypothetically seized.
      */
     getLiquidationRepaidShares(seizedAssets) {
-        return MarketUtils_1.MarketUtils.getLiquidationRepaidShares(seizedAssets, this, this.config);
+        return MarketUtils_js_1.MarketUtils.getLiquidationRepaidShares(seizedAssets, this, this.params);
     }
     /**
      * Returns the maximum amount of collateral that is worth being seized in a liquidation given a certain borrow position.
+     * `undefined` iff the market's oracle is undefined or reverts.
      * @param position The borrow position to consider.
      */
     getSeizableCollateral(position) {
-        return MarketUtils_1.MarketUtils.getSeizableCollateral(position, this, this.config);
+        return MarketUtils_js_1.MarketUtils.getSeizableCollateral(position, this, this.params);
     }
     /**
      * Returns the amount of collateral that can be withdrawn given a certain borrow position.
+     * `undefined` iff the market's oracle is undefined or reverts.
      * @param position The borrow position to consider.
      */
-    getWithdrawableCollateral(position, { maxLtv = this.config.lltv } = {}) {
-        return MarketUtils_1.MarketUtils.getWithdrawableCollateral(position, this, {
-            lltv: maths_1.MathLib.min(maxLtv, this.config.lltv),
+    getWithdrawableCollateral(position, { maxLtv = this.params.lltv } = {}) {
+        return MarketUtils_js_1.MarketUtils.getWithdrawableCollateral(position, this, {
+            lltv: index_js_1.MathLib.min(maxLtv, this.params.lltv),
         });
     }
     /**
      * Returns whether a given borrow position is healthy.
+     * `undefined` iff the market's oracle is undefined or reverts.
      * @param position The borrow position to check.
      */
     isHealthy(position) {
-        return MarketUtils_1.MarketUtils.isHealthy(position, this, this.config);
+        return MarketUtils_js_1.MarketUtils.isHealthy(position, this, this.params);
     }
     /**
      * Returns the liquidation price of a given borrow position.
      * @param position The borrow position to consider.
      */
     getLiquidationPrice(position) {
-        return MarketUtils_1.MarketUtils.getLiquidationPrice(position, this, this.config);
+        return MarketUtils_js_1.MarketUtils.getLiquidationPrice(position, this, this.params);
     }
     /**
-     * Returns the price deviation required for the given borrow position to be unhealthy (scaled by WAD).
+     * 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.
      * @param position The borrow position to consider.
      */
-    getPriceVariationToLiquidation(position) {
-        return MarketUtils_1.MarketUtils.getPriceVariationToLiquidation(position, this, this.config);
+    getPriceVariationToLiquidationPrice(position) {
+        return MarketUtils_js_1.MarketUtils.getPriceVariationToLiquidationPrice(position, this, this.params);
     }
     /**
      * Returns the health factor of a given borrow position (scaled by WAD).
      * @param position The borrow position to consider.
      */
     getHealthFactor(position) {
-        return MarketUtils_1.MarketUtils.getHealthFactor(position, this, this.config);
+        return MarketUtils_js_1.MarketUtils.getHealthFactor(position, this, this.params);
     }
     /**
      * Returns the loan-to-value ratio of a given borrow position (scaled by WAD).
      * @param position The borrow position to consider.
      */
     getLtv(position) {
-        return MarketUtils_1.MarketUtils.getLtv(position, this);
+        return MarketUtils_js_1.MarketUtils.getLtv(position, this);
     }
     /**
      * Returns the usage ratio of the maximum borrow capacity given a certain borrow position (scaled by WAD).
      * @param position The borrow position to consider.
      */
     getBorrowCapacityUsage(position) {
-        return MarketUtils_1.MarketUtils.getBorrowCapacityUsage(position, this, this.config);
+        return MarketUtils_js_1.MarketUtils.getBorrowCapacityUsage(position, this, this.params);
     }
     /**
      * Returns the maximum amount of loan assets that can be borrowed given a certain borrow position
      * and the reason for the limit.
+     * Returns `undefined` iff the market's price is undefined.
      * @param position The borrow position to consider.
      */
     getBorrowCapacityLimit({ collateral, borrowShares = 0n, }, options) {
+        const maxBorrowAssets = this.getMaxBorrowAssets(collateral, options);
+        if (maxBorrowAssets == null)
+            return;
         // handle edge cases when the user is liquidatable (maxBorrow < borrow)
-        const maxBorrowableAssets = maths_1.MathLib.zeroFloorSub(this.getMaxBorrowAssets(collateral, options), this.toBorrowAssets(borrowShares));
+        const maxBorrowableAssets = index_js_1.MathLib.zeroFloorSub(maxBorrowAssets, this.toBorrowAssets(borrowShares));
         const { liquidity } = this;
         if (maxBorrowableAssets > liquidity)
             return {
@@ -420,10 +436,13 @@ class Market {
     /**
      * Returns the maximum amount of collateral assets that can be withdrawn given a certain borrow position
      * and the reason for the limit.
+     * Returns `undefined` iff the market's price is undefined.
      * @param position The borrow position to consider.
      */
     getWithdrawCollateralCapacityLimit(position, options) {
         const withdrawableCollateral = this.getWithdrawableCollateral(position, options);
+        if (withdrawableCollateral == null)
+            return;
         if (position.collateral > withdrawableCollateral)
             return {
                 value: withdrawableCollateral,

package/lib/market/{MarketConfig.d.ts → MarketParams.d.ts}

@@ -1,25 +1,26 @@
-import { Address, BigIntish, MarketId } from "../types";
-export interface MarketParams {
+import type { Address, BigIntish, MarketId } from "../types.js";
+export interface IMarketParams {
     loanToken: Address;
     collateralToken: Address;
     oracle: Address;
     irm: Address;
     lltv: BigIntish;
 }
+export type InputMarketParams = Pick<MarketParams, "loanToken" | "collateralToken" | "oracle" | "irm" | "lltv">;
 /**
  * Represents a market's configuration (also called market params).
  */
-export declare class MarketConfig implements MarketParams {
+export declare class MarketParams implements IMarketParams {
     private static readonly _CACHE;
     /**
      * Returns the previously cached market config for the given id, if any.
-     * @throws {UnknownMarketConfigError} If no market config is cached.
+     * @throws {UnknownMarketParamsError} If no market config is cached.
      */
-    static get(id: MarketId): MarketConfig;
+    static get(id: MarketId): MarketParams;
     /**
      * Returns the canonical idle market configuration for the given loan token.
      */
-    static idle(token: Address): MarketConfig;
+    static idle(token: Address): MarketParams;
     /**
      * The market's collateral token address.
      */
@@ -48,5 +49,5 @@ export declare class MarketConfig implements MarketParams {
      * The market's liquidation incentive factor.
      */
     readonly liquidationIncentiveFactor: bigint;
-    constructor(params: MarketParams);
+    constructor(params: IMarketParams);
 }

package/lib/market/{MarketConfig.js → MarketParams.js}

@@ -1,32 +1,33 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MarketConfig = void 0;
-const errors_1 = require("../errors");
-const MarketUtils_1 = require("./MarketUtils");
+exports.MarketParams = void 0;
+const morpho_ts_1 = require("@morpho-org/morpho-ts");
+const errors_js_1 = require("../errors.js");
+const MarketUtils_js_1 = require("./MarketUtils.js");
 /**
  * Represents a market's configuration (also called market params).
  */
-class MarketConfig {
+class MarketParams {
     static _CACHE = {};
     /**
      * Returns the previously cached market config for the given id, if any.
-     * @throws {UnknownMarketConfigError} If no market config is cached.
+     * @throws {UnknownMarketParamsError} If no market config is cached.
      */
     static get(id) {
-        const marketConfig = MarketConfig._CACHE[id];
-        if (!marketConfig)
-            throw new errors_1.UnknownMarketConfigError(id);
-        return marketConfig;
+        const marketParams = MarketParams._CACHE[id];
+        if (!marketParams)
+            throw new errors_js_1.UnknownMarketParamsError(id);
+        return marketParams;
     }
     /**
      * Returns the canonical idle market configuration for the given loan token.
      */
     static idle(token) {
-        return new MarketConfig({
-            collateralToken: "0x0000000000000000000000000000000000000000",
+        return new MarketParams({
+            collateralToken: morpho_ts_1.ZERO_ADDRESS,
             loanToken: token,
-            oracle: "0x0000000000000000000000000000000000000000",
-            irm: "0x0000000000000000000000000000000000000000",
+            oracle: morpho_ts_1.ZERO_ADDRESS,
+            irm: morpho_ts_1.ZERO_ADDRESS,
             lltv: 0n,
         });
     }
@@ -53,13 +54,11 @@ class MarketConfig {
     /**
      * The market's hex-encoded id, defined as the hash of the market params.
      */
-    // Cached because params are readonly.
-    id;
+    id; // Cached because params are readonly.
     /**
      * The market's liquidation incentive factor.
      */
-    // Cached because lltv is readonly.
-    liquidationIncentiveFactor;
+    liquidationIncentiveFactor; // Cached because lltv is readonly.
     constructor(params) {
         const { collateralToken, loanToken, oracle, irm, lltv } = params;
         this.collateralToken = collateralToken;
@@ -67,10 +66,10 @@ class MarketConfig {
         this.oracle = oracle;
         this.irm = irm;
         this.lltv = BigInt(lltv);
-        this.id = MarketUtils_1.MarketUtils.getMarketId(params);
+        this.id = MarketUtils_js_1.MarketUtils.getMarketId(params);
         this.liquidationIncentiveFactor =
-            MarketUtils_1.MarketUtils.getLiquidationIncentiveFactor(params);
-        MarketConfig._CACHE[this.id] = this;
+            MarketUtils_js_1.MarketUtils.getLiquidationIncentiveFactor(params);
+        MarketParams._CACHE[this.id] = this;
     }
 }
-exports.MarketConfig = MarketConfig;
+exports.MarketParams = MarketParams;