@morpho-org/blue-sdk 3.0.0-next.8 → 3.0.0

package/lib/position/Position.js

@@ -35,38 +35,41 @@ class Position {
 }
 exports.Position = Position;
 class AccrualPosition extends Position {
-    /**
-     * The market on which this position is held.
-     */
-    market;
+    _market;
     constructor(position, market) {
         const _market = new index_js_1.Market(market);
         super({ ...position, marketId: _market.id });
-        this.market = _market;
+        this._market = _market;
+    }
+    /**
+     * The market on which this position is held.
+     */
+    get market() {
+        return this._market;
     }
     get supplyAssets() {
-        return this.market.toSupplyAssets(this.supplyShares);
+        return this._market.toSupplyAssets(this.supplyShares);
     }
     get borrowAssets() {
-        return this.market.toBorrowAssets(this.borrowShares);
+        return this._market.toBorrowAssets(this.borrowShares);
     }
     /**
      * The value of this position's collateral quoted in loan assets.
-     * `undefined` iff the market's oracle is undefined or reverts.
+     * `undefined` if the market's oracle is undefined or reverts.
      */
     get collateralValue() {
-        return this.market.getCollateralValue(this.collateral);
+        return this._market.getCollateralValue(this.collateral);
     }
     /**
      * 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.
+     * `undefined` if the market's oracle is undefined or reverts.
      */
     get maxBorrowAssets() {
-        return this.market.getMaxBorrowAssets(this.collateral);
+        return this._market.getMaxBorrowAssets(this.collateral);
     }
     /**
      * The maximum additional amount of assets that can be borrowed against this position's collateral.
-     * `undefined` iff the market's oracle is undefined or reverts.
+     * `undefined` if the market's oracle is undefined or reverts.
      */
     get maxBorrowableAssets() {
         const { maxBorrowAssets } = this;
@@ -76,86 +79,97 @@ class AccrualPosition extends Position {
     }
     /**
      * The maximum amount of collateral that can be seized in exchange for the outstanding debt.
-     * `undefined` iff the market's oracle is undefined or reverts.
+     * `undefined` if the market's oracle is undefined or reverts.
      */
     get seizableCollateral() {
-        return this.market.getSeizableCollateral(this);
+        return this._market.getSeizableCollateral(this);
     }
     /**
      * The maximum amount of collateral that can be withdrawn.
-     * `undefined` iff the market's oracle is undefined or reverts.
+     * `undefined` if the market's oracle is undefined or reverts.
      */
     get withdrawableCollateral() {
-        return this.market.getWithdrawableCollateral(this);
+        return this._market.getWithdrawableCollateral(this);
     }
     /**
      * Whether this position is healthy.
-     * `undefined` iff the market's oracle is undefined or reverts.
+     * `undefined` if the market's oracle is undefined or reverts.
      */
     get isHealthy() {
-        return this.market.isHealthy(this);
+        return this._market.isHealthy(this);
+    }
+    /**
+     * Whether this position can be liquidated.
+     * `undefined` if the market's oracle is undefined or reverts.
+     */
+    get isLiquidatable() {
+        const isHealthy = this._market.isHealthy(this);
+        if (isHealthy == null)
+            return;
+        return !isHealthy;
     }
     /**
      * The price of the collateral quoted in loan assets that would allow this position to be liquidated.
+     * `null` if the position has no borrow.
      */
     get liquidationPrice() {
-        return this.market.getLiquidationPrice(this);
+        return this._market.getLiquidationPrice(this);
     }
     /**
      * The price variation required for the 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%).
-     * `undefined` iff the market's oracle is undefined or reverts.
-     * Null if the position is not a borrow.
+     * `undefined` if the market's oracle is undefined or reverts.
+     * `null` if the position is not a borrow.
      */
     get priceVariationToLiquidationPrice() {
-        return this.market.getPriceVariationToLiquidationPrice(this);
+        return this._market.getPriceVariationToLiquidationPrice(this);
     }
     /**
      * This position's Loan-To-Value (debt over collateral power, scaled by WAD).
      * If the collateral price is 0, LTV is `MaxUint256`.
-     * `undefined` iff the market's oracle is undefined or reverts.
+     * `undefined` if the market's oracle is undefined or reverts.
      */
     get ltv() {
-        return this.market.getLtv(this);
+        return this._market.getLtv(this);
     }
     /**
      * This position's 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.
+     * `undefined` if the market's oracle is undefined or reverts.
      */
     get healthFactor() {
-        return this.market.getHealthFactor(this);
+        return this._market.getHealthFactor(this);
     }
     /**
      * 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 this.market.getBorrowCapacityUsage(this);
+        return this._market.getBorrowCapacityUsage(this);
     }
     /**
      * Returns the maximum amount of loan assets that can be withdrawn given a certain supply position
      * and a balance of loan assets, and the reason for the limit.
      */
     get withdrawCapacityLimit() {
-        return this.market.getWithdrawCapacityLimit(this);
+        return this._market.getWithdrawCapacityLimit(this);
     }
     /**
      * Returns a new position derived from this position, whose interest has been accrued up to the given timestamp.
      * @param timestamp The timestamp at which to accrue interest. Must be greater than or equal to the market's `lastUpdate`.
      */
     accrueInterest(timestamp) {
-        return new AccrualPosition(this, this.market.accrueInterest(timestamp));
+        return new AccrualPosition(this, this._market.accrueInterest(timestamp));
     }
     supply(assets, shares, timestamp) {
-        let { market } = this;
+        let { _market: market } = this;
         ({ market, assets, shares } = market.supply(assets, shares, timestamp));
         const position = new AccrualPosition(this, market);
         position.supplyShares += shares;
         return { position, assets, shares };
     }
     withdraw(assets, shares, timestamp) {
-        let { market } = this;
+        let { _market: market } = this;
         ({ market, assets, shares } = market.withdraw(assets, shares, timestamp));
         const position = new AccrualPosition(this, market);
         position.supplyShares -= shares;
@@ -165,10 +179,10 @@ class AccrualPosition extends Position {
     }
     supplyCollateral(assets) {
         this.collateral += assets;
-        return new AccrualPosition(this, new index_js_1.Market(this.market));
+        return new AccrualPosition(this, new index_js_1.Market(this._market));
     }
     withdrawCollateral(assets, timestamp) {
-        if (this.market.price == null)
+        if (this._market.price == null)
             throw new errors_js_1.BlueErrors.UnknownOraclePrice(this.marketId);
         const position = this.accrueInterest(timestamp);
         position.collateral -= assets;
@@ -179,7 +193,7 @@ class AccrualPosition extends Position {
         return position;
     }
     borrow(assets, shares, timestamp) {
-        let { market } = this;
+        let { _market: market } = this;
         if (market.price == null)
             throw new errors_js_1.BlueErrors.UnknownOraclePrice(market.id);
         ({ market, assets, shares } = market.borrow(assets, shares, timestamp));
@@ -190,7 +204,7 @@ class AccrualPosition extends Position {
         return { position, assets, shares };
     }
     repay(assets, shares, timestamp) {
-        let { market } = this;
+        let { _market: market } = this;
         ({ market, assets, shares } = market.repay(assets, shares, timestamp));
         const position = new AccrualPosition(this, market);
         position.borrowShares -= shares;
@@ -199,13 +213,13 @@ class AccrualPosition extends Position {
         return { position, assets, shares };
     }
     getBorrowCapacityLimit(options) {
-        return this.market.getBorrowCapacityLimit(this, options);
+        return this._market.getBorrowCapacityLimit(this, options);
     }
     getWithdrawCollateralCapacityLimit(options) {
-        return this.market.getWithdrawCollateralCapacityLimit(this, options);
+        return this._market.getWithdrawCollateralCapacityLimit(this, options);
     }
     getRepayCapacityLimit(loanTokenBalance) {
-        return this.market.getRepayCapacityLimit(this.borrowShares, loanTokenBalance);
+        return this._market.getRepayCapacityLimit(this.borrowShares, loanTokenBalance);
     }
     getMaxCapacities(loanTokenBalance, collateralTokenBalance, options) {
         return {

package/lib/position/PreLiquidationPosition.d.ts

@@ -0,0 +1,60 @@
+import type { Address } from "viem";
+import { type IMarket, Market } from "../market";
+import type { BigIntish } from "../types";
+import { AccrualPosition, type IAccrualPosition } from "./Position";
+export interface IPreLiquidationParams {
+    preLltv: BigIntish;
+    preLCF1: BigIntish;
+    preLCF2: BigIntish;
+    preLIF1: BigIntish;
+    preLIF2: BigIntish;
+    preLiquidationOracle: Address;
+}
+export declare class PreLiquidationParams implements IPreLiquidationParams {
+    readonly preLltv: bigint;
+    readonly preLCF1: bigint;
+    readonly preLCF2: bigint;
+    readonly preLIF1: bigint;
+    readonly preLIF2: bigint;
+    readonly preLiquidationOracle: `0x${string}`;
+    constructor({ preLltv, preLCF1, preLCF2, preLIF1, preLIF2, preLiquidationOracle, }: IPreLiquidationParams);
+    getCloseFactor(quotient: BigIntish): bigint;
+    getIncentiveFactor(quotient: BigIntish): bigint;
+}
+export interface IPreLiquidationPosition extends IAccrualPosition {
+    /**
+     * The pre-liquidation parameters of the associated PreLiquidation contract.
+     */
+    preLiquidationParams: IPreLiquidationParams;
+    /**
+     * The address of the PreLiquidation contract this position is associated to.
+     */
+    preLiquidation: Address;
+    /**
+     * The price of the collateral quoted in loan assets used by the PreLiquidation contract.
+     * `undefined` if the oracle reverts.
+     */
+    preLiquidationOraclePrice?: BigIntish;
+}
+export declare class PreLiquidationPosition extends AccrualPosition implements IPreLiquidationPosition {
+    readonly preLiquidationParams: PreLiquidationParams;
+    readonly preLiquidation: `0x${string}`;
+    readonly preLiquidationOraclePrice?: bigint;
+    protected readonly _baseMarket: Market;
+    constructor({ preLiquidationParams, preLiquidation, preLiquidationOraclePrice, ...position }: IPreLiquidationPosition, market: IMarket);
+    get market(): Market;
+    protected get _lltv(): bigint;
+    /**
+     * @inheritdoc `undefined` if the pre-liquidation's oracle reverts.
+     * `undefined` if it may be liquidatable on Morpho.
+     */
+    get isHealthy(): boolean | undefined;
+    /**
+     * @inheritdoc `undefined` if the pre-liquidation's oracle reverts.
+     */
+    get isLiquidatable(): boolean | undefined;
+    /**
+     * @inheritdoc `undefined` if the pre-liquidation's oracle reverts.
+     */
+    get seizableCollateral(): bigint | undefined;
+}

package/lib/position/PreLiquidationPosition.js

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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 {
+    preLiquidationParams;
+    preLiquidation;
+    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;
+    }
+    /**
+     * @inheritdoc `undefined` if the pre-liquidation's oracle reverts.
+     * `undefined` if it may be liquidatable on Morpho.
+     */
+    get isHealthy() {
+        const { collateralValue } = this;
+        if (collateralValue == null)
+            return;
+        const { borrowAssets } = this;
+        if (borrowAssets > math_1.MathLib.wMulDown(collateralValue, this._lltv))
+            return;
+        return (borrowAssets <=
+            math_1.MathLib.wMulDown(collateralValue, this.preLiquidationParams.preLltv));
+    }
+    /**
+     * @inheritdoc `undefined` if the pre-liquidation's oracle reverts.
+     */
+    get isLiquidatable() {
+        const { collateralValue } = this;
+        if (collateralValue == null)
+            return;
+        const { borrowAssets } = this;
+        return (borrowAssets >
+            math_1.MathLib.wMulDown(collateralValue, this.preLiquidationParams.preLltv) &&
+            borrowAssets <= math_1.MathLib.wMulDown(collateralValue, this._lltv));
+    }
+    /**
+     * @inheritdoc `undefined` if the pre-liquidation's oracle reverts.
+     */
+    get seizableCollateral() {
+        if (this._market.price == null)
+            return;
+        if (!this.isLiquidatable)
+            return 0n;
+        const { ltv } = this;
+        if (ltv == null)
+            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/position/index.d.ts

@@ -1 +1,2 @@
 export * from "./Position.js";
+export * from "./PreLiquidationPosition.js";

package/lib/position/index.js

@@ -15,3 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./Position.js"), exports);
+__exportStar(require("./PreLiquidationPosition.js"), exports);

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;