@morpho-org/blue-sdk 3.0.0-next.10 → 3.0.0-next.12

package/lib/position/PreLiquidationPosition.js

@@ -1,158 +1,102 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PreLiquidationPosition = void 0;
+exports.PreLiquidationPosition = exports.PreLiquidationParams = void 0;
 const constants_1 = require("../constants");
 const market_1 = require("../market");
 const math_1 = require("../math");
 const Position_1 = require("./Position");
+class PreLiquidationParams {
+    preLltv;
+    preLCF1;
+    preLCF2;
+    preLIF1;
+    preLIF2;
+    preLiquidationOracle;
+    constructor({ preLltv, preLCF1, preLCF2, preLIF1, preLIF2, preLiquidationOracle, }) {
+        this.preLltv = BigInt(preLltv);
+        this.preLCF1 = BigInt(preLCF1);
+        this.preLCF2 = BigInt(preLCF2);
+        this.preLIF1 = BigInt(preLIF1);
+        this.preLIF2 = BigInt(preLIF2);
+        this.preLiquidationOracle = preLiquidationOracle;
+    }
+    getCloseFactor(quotient) {
+        return (this.preLCF1 + math_1.MathLib.wMulDown(quotient, this.preLCF2 - this.preLCF1));
+    }
+    getIncentiveFactor(quotient) {
+        return (this.preLIF1 + math_1.MathLib.wMulDown(quotient, this.preLIF2 - this.preLIF1));
+    }
+}
+exports.PreLiquidationParams = PreLiquidationParams;
 class PreLiquidationPosition extends Position_1.AccrualPosition {
-    /**
-     * The pre-liquidation parameters of the associated PreLiquidation contract.
-     */
     preLiquidationParams;
-    /**
-     * The address of the PreLiquidation contract this position is associated to.
-     */
     preLiquidation;
-    /**
-     * Whether the PreLiquidation contract is authorized to manage this position.
-     */
-    isPreLiquidationAuthorized;
-    constructor(position, market) {
-        super(position, market);
-        this.preLiquidationParams = position.preLiquidationParams;
-        this.preLiquidation = position.preLiquidation;
-        this.isPreLiquidationAuthorized = position.isPreLiquidationAuthorized;
+    preLiquidationOraclePrice;
+    _baseMarket;
+    constructor({ preLiquidationParams, preLiquidation, preLiquidationOraclePrice, ...position }, market) {
+        super(position, {
+            ...market,
+            params: {
+                ...market.params,
+                lltv: BigInt(preLiquidationParams.preLltv),
+            },
+            price: preLiquidationOraclePrice != null
+                ? BigInt(preLiquidationOraclePrice)
+                : undefined,
+        });
+        this.preLiquidationParams = new PreLiquidationParams(preLiquidationParams);
+        this.preLiquidation = preLiquidation;
+        if (preLiquidationOraclePrice != null)
+            this.preLiquidationOraclePrice = BigInt(preLiquidationOraclePrice);
+        this._baseMarket = new market_1.Market(market);
+    }
+    get market() {
+        return this._baseMarket;
+    }
+    get _lltv() {
+        return this._baseMarket.params.lltv;
     }
     /**
-     * Whether this position is liquidatable via the PreLiquidation contract.
-     * `undefined` iff the market's oracle is undefined or reverts.
+     * @inheritdoc `undefined` if the pre-liquidation's oracle reverts.
+     * `undefined` if it may be liquidatable on Morpho.
      */
-    get isPreLiquidatable() {
+    get isHealthy() {
         const { collateralValue } = this;
         if (collateralValue == null)
             return;
         const { borrowAssets } = this;
-        return (this.isPreLiquidationAuthorized &&
-            borrowAssets <=
-                math_1.MathLib.wMulDown(collateralValue, this.market.params.lltv) &&
-            borrowAssets >
-                math_1.MathLib.wMulDown(collateralValue, this.preLiquidationParams.preLltv));
-    }
-    /**
-     * Whether this position is healthy.
-     * `undefined` iff the market's oracle is undefined or reverts.
-     */
-    get isHealthy() {
-        const { isPreLiquidatable } = this;
-        if (isPreLiquidatable == null)
-            return isPreLiquidatable;
-        const { isLiquidatable } = this;
-        if (isLiquidatable == null)
-            return isLiquidatable;
-        return !isPreLiquidatable && !isLiquidatable;
-    }
-    /**
-     * The price of the collateral quoted in loan assets that would allow this position to be pre-liquidated.
-     * `null` if the position has no borrow.
-     */
-    get preLiquidationPrice() {
-        if (this.borrowShares === 0n || this.market.totalBorrowShares === 0n)
-            return null;
-        const collateralPower = market_1.MarketUtils.getCollateralPower(this.collateral, {
-            lltv: this.preLiquidationParams.preLltv,
-        });
-        if (collateralPower === 0n)
-            return math_1.MathLib.MAX_UINT_256;
-        const { borrowAssets } = this;
-        return math_1.MathLib.mulDivUp(borrowAssets, constants_1.ORACLE_PRICE_SCALE, collateralPower);
-    }
-    /**
-     * The price variation required for the position to reach its pre-liquidation threshold (scaled by WAD).
-     * Negative when healthy (the price needs to drop x%), positive when unhealthy (the price needs to soar x%).
-     * `undefined` iff the market's oracle is undefined or reverts.
-     * `null` if the position is not a borrow.
-     */
-    get priceVariationToLiquidationPrice() {
-        if (this.market.price == null)
+        if (borrowAssets > math_1.MathLib.wMulDown(collateralValue, this._lltv))
             return;
-        const { preLiquidationPrice } = this;
-        if (this.market.price === 0n || preLiquidationPrice == null)
-            return null;
-        return math_1.MathLib.wDivUp(preLiquidationPrice, this.market.price) - math_1.MathLib.WAD;
+        return (borrowAssets <=
+            math_1.MathLib.wMulDown(collateralValue, this.preLiquidationParams.preLltv));
     }
     /**
-     * The maximum amount of loan assets that can be borrowed against this position's collateral.
-     * `undefined` iff the market's oracle is undefined or reverts.
+     * @inheritdoc `undefined` if the pre-liquidation's oracle reverts.
      */
-    get maxBorrowAssets() {
+    get isLiquidatable() {
         const { collateralValue } = this;
         if (collateralValue == null)
             return;
-        return math_1.MathLib.wMulDown(collateralValue, this.preLiquidationParams.preLltv);
-    }
-    /**
-     * The maximum amount of collateral that can be withdrawn.
-     * `undefined` iff the market's oracle is undefined or reverts.
-     */
-    get withdrawableCollateral() {
-        return market_1.MarketUtils.getWithdrawableCollateral(this, this.market, {
-            lltv: this.preLiquidationParams.preLltv,
-        });
+        const { borrowAssets } = this;
+        return (borrowAssets >
+            math_1.MathLib.wMulDown(collateralValue, this.preLiquidationParams.preLltv) &&
+            borrowAssets <= math_1.MathLib.wMulDown(collateralValue, this._lltv));
     }
     /**
-     * The maximum amount of collateral that can be seized in exchange for the outstanding debt in the context of pre-liquidation.
-     * `undefined` iff the market's oracle is undefined or reverts.
+     * @inheritdoc `undefined` if the pre-liquidation's oracle reverts.
      */
-    get preSeizableCollateral() {
-        if (this.market.price == null)
+    get seizableCollateral() {
+        if (this._market.price == null)
             return;
+        if (!this.isLiquidatable)
+            return 0n;
         const { ltv } = this;
         if (ltv == null)
-            return ltv;
-        if (!this.isPreLiquidatable)
-            return 0n;
-        const quotient = math_1.MathLib.wDivDown(ltv - this.preLiquidationParams.preLltv, this.market.params.lltv - this.preLiquidationParams.preLltv);
-        const preLIF = this.preLiquidationParams.preLIF1 +
-            math_1.MathLib.wMulDown(quotient, this.preLiquidationParams.preLIF2 - this.preLiquidationParams.preLIF1);
-        const preLCF = this.preLiquidationParams.preLCF1 +
-            math_1.MathLib.wMulDown(quotient, this.preLiquidationParams.preLCF2 - this.preLiquidationParams.preLCF1);
-        const repayableShares = math_1.MathLib.wMulDown(this.borrowShares, preLCF);
-        const repayableAssets = math_1.MathLib.wMulDown(math_1.SharesMath.toAssets(repayableShares, this.market.totalBorrowAssets, this.market.totalBorrowShares, "Down"), preLIF);
-        return math_1.MathLib.mulDivDown(repayableAssets, constants_1.ORACLE_PRICE_SCALE, this.market.price);
-    }
-    /**
-     * This position's pre health factor (collateral power over debt, scaled by WAD).
-     * If the debt is 0, health factor is `MaxUint256`.
-     * `undefined` iff the market's oracle is undefined or reverts.
-     */
-    get preHealthFactor() {
-        return market_1.MarketUtils.getHealthFactor(this, this.market, {
-            lltv: this.preLiquidationParams.preLltv,
-        });
-    }
-    /**
-     * The percentage of this position's borrow power currently used (scaled by WAD).
-     * If the collateral price is 0, usage is `MaxUint256`.
-     */
-    get borrowCapacityUsage() {
-        return market_1.MarketUtils.getBorrowCapacityUsage(this, this.market, {
-            lltv: this.preLiquidationParams.preLltv,
-        });
-    }
-    getBorrowCapacityLimit(options = {}) {
-        options.maxLtv =
-            options.maxLtv != null
-                ? math_1.MathLib.min(options.maxLtv, this.preLiquidationParams.preLltv)
-                : this.preLiquidationParams.preLltv;
-        return this.market.getBorrowCapacityLimit(this, options);
-    }
-    getWithdrawCollateralCapacityLimit(options = {}) {
-        options.maxLtv =
-            options.maxLtv != null
-                ? math_1.MathLib.min(options.maxLtv, this.preLiquidationParams.preLltv)
-                : this.preLiquidationParams.preLltv;
-        return this.market.getWithdrawCollateralCapacityLimit(this, options);
+            return;
+        const quotient = math_1.MathLib.wDivDown(ltv - this.preLiquidationParams.preLltv, this._lltv - this.preLiquidationParams.preLltv);
+        const repayableShares = math_1.MathLib.wMulDown(this.borrowShares, this.preLiquidationParams.getCloseFactor(quotient));
+        const repayableAssets = math_1.MathLib.wMulDown(math_1.SharesMath.toAssets(repayableShares, this._market.totalBorrowAssets, this._market.totalBorrowShares, "Down"), this.preLiquidationParams.getIncentiveFactor(quotient));
+        return math_1.MathLib.mulDivDown(repayableAssets, constants_1.ORACLE_PRICE_SCALE, this._market.price);
     }
 }
 exports.PreLiquidationPosition = PreLiquidationPosition;

package/lib/preLiquidation.d.ts

@@ -0,0 +1,15 @@
+import type { BigIntish } from "./types";
+export declare const defaultPreLiquidationParamsRegistry: Map<bigint, {
+    preLltv: bigint;
+    preLCF1: bigint;
+    preLCF2: bigint;
+    preLIF1: bigint;
+    preLIF2: bigint;
+}>;
+export declare const getDefaultPreLiquidationParams: (lltv: BigIntish) => {
+    preLltv: bigint;
+    preLCF1: bigint;
+    preLCF2: bigint;
+    preLIF1: bigint;
+    preLIF2: bigint;
+};

package/lib/preLiquidation.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDefaultPreLiquidationParams = exports.defaultPreLiquidationParamsRegistry = void 0;
+const viem_1 = require("viem");
+const errors_1 = require("./errors");
+exports.defaultPreLiquidationParamsRegistry = new Map([
+    [
+        (0, viem_1.parseEther)("0.385"),
+        {
+            preLltv: 301514568055515563n,
+            preLCF1: 22637943984157107n,
+            preLCF2: 349673199983645648n,
+            preLIF1: (0, viem_1.parseEther)("1.15"),
+            preLIF2: (0, viem_1.parseEther)("1.15"),
+        },
+    ],
+    [
+        (0, viem_1.parseEther)("0.625"),
+        {
+            preLltv: 562591950487445723n,
+            preLCF1: 7543182567291709n,
+            preLCF2: 279542312587328718n,
+            preLIF1: 1126760563380281690n,
+            preLIF2: 1126760563380281690n,
+        },
+    ],
+    [
+        (0, viem_1.parseEther)("0.77"),
+        {
+            preLltv: 727366070175296029n,
+            preLCF1: 3706417131700377n,
+            preLCF2: 256643181309902852n,
+            preLIF1: 1074113856068743286n,
+            preLIF2: 1074113856068743286n,
+        },
+    ],
+    [
+        (0, viem_1.parseEther)("0.86"),
+        {
+            preLltv: 832603694978499652n,
+            preLCF1: 2001493508968667n,
+            preLCF2: 245311807032632372n,
+            preLIF1: 1043841336116910229n,
+            preLIF2: 1043841336116910229n,
+        },
+    ],
+    [
+        (0, viem_1.parseEther)("0.915"),
+        {
+            preLltv: 897868776651447149n,
+            preLCF1: 1135586186384195n,
+            preLCF2: 239205538157954887n,
+            preLIF1: 1026167265264238070n,
+            preLIF2: 1026167265264238070n,
+        },
+    ],
+    [
+        (0, viem_1.parseEther)("0.965"),
+        {
+            preLltv: 957768981497388846n,
+            preLCF1: 441038514876104n,
+            preLCF2: 234108264807531861n,
+            preLIF1: 1010611419909044972n,
+            preLIF2: 1010611419909044972n,
+        },
+    ],
+    [
+        (0, viem_1.parseEther)("0.985"),
+        {
+            preLltv: 975838577830248552n,
+            preLCF1: 247773050273784n,
+            preLCF2: 232655340599010079n,
+            preLIF1: 1006036217303822937n,
+            preLIF2: 1006036217303822937n,
+        },
+    ],
+]);
+const getDefaultPreLiquidationParams = (lltv) => {
+    lltv = BigInt(lltv);
+    const defaultParams = exports.defaultPreLiquidationParamsRegistry.get(lltv);
+    if (defaultParams == null)
+        throw new errors_1.UnsupportedPreLiquidationParamsError(lltv);
+    return defaultParams;
+};
+exports.getDefaultPreLiquidationParams = getDefaultPreLiquidationParams;