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

package/lib/errors.d.ts

@@ -21,6 +21,10 @@ export declare class UnsupportedChainIdError extends Error {
     readonly chainId: number;
     constructor(chainId: number);
 }
+export declare class UnsupportedPreLiquidationParamsError extends Error {
+    readonly lltv: bigint;
+    constructor(lltv: bigint);
+}
 export declare namespace BlueErrors {
     class InvalidInterestAccrual extends Error {
         readonly marketId: MarketId;

package/lib/errors.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BlueErrors = exports.UnsupportedChainIdError = exports.UnknownVaultConfigError = exports.UnknownMarketParamsError = exports.UnknownTokenPriceError = exports.UnknownTokenError = exports.UnknownDataError = void 0;
+exports.BlueErrors = exports.UnsupportedPreLiquidationParamsError = exports.UnsupportedChainIdError = exports.UnknownVaultConfigError = exports.UnknownMarketParamsError = exports.UnknownTokenPriceError = exports.UnknownTokenError = exports.UnknownDataError = void 0;
 exports._try = _try;
+const viem_1 = require("viem");
 class UnknownDataError extends Error {
 }
 exports.UnknownDataError = UnknownDataError;
@@ -45,6 +46,14 @@ class UnsupportedChainIdError extends Error {
     }
 }
 exports.UnsupportedChainIdError = UnsupportedChainIdError;
+class UnsupportedPreLiquidationParamsError extends Error {
+    lltv;
+    constructor(lltv) {
+        super(`unsupported pre liquidation params for lltv ${(0, viem_1.formatUnits)(lltv, 16)}%`);
+        this.lltv = lltv;
+    }
+}
+exports.UnsupportedPreLiquidationParamsError = UnsupportedPreLiquidationParamsError;
 var BlueErrors;
 (function (BlueErrors) {
     class InvalidInterestAccrual extends Error {

package/lib/position/Position.d.ts

@@ -33,46 +33,47 @@ export declare class Position implements IPosition {
 export interface IAccrualPosition extends Omit<IPosition, "marketId"> {
 }
 export declare class AccrualPosition extends Position implements IAccrualPosition {
+    protected readonly _market: Market;
+    constructor(position: IAccrualPosition, market: IMarket);
     /**
      * The market on which this position is held.
      */
-    readonly market: Market;
-    constructor(position: IAccrualPosition, market: IMarket);
+    get market(): Market;
     get supplyAssets(): bigint;
     get borrowAssets(): bigint;
     /**
      * 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(): bigint | undefined;
     /**
      * 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(): bigint | undefined;
     /**
      * 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(): bigint | undefined;
     /**
      * 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(): bigint | undefined;
     /**
      * 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(): bigint | undefined;
     /**
      * 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(): boolean | undefined;
     /**
      * Whether this position can be liquidated.
-     * `undefined` iff the market's oracle is undefined or reverts.
+     * `undefined` if the market's oracle is undefined or reverts.
      */
     get isLiquidatable(): boolean | undefined;
     /**
@@ -83,20 +84,20 @@ export declare class AccrualPosition extends Position implements IAccrualPositio
     /**
      * 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.
+     * `undefined` if the market's oracle is undefined or reverts.
      * `null` if the position is not a borrow.
      */
     get priceVariationToLiquidationPrice(): bigint | null | undefined;
     /**
      * 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(): bigint | undefined;
     /**
      * 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(): bigint | undefined;
     /**

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,33 +79,33 @@ 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` iff the market's oracle is undefined or reverts.
+     * `undefined` if the market's oracle is undefined or reverts.
      */
     get isLiquidatable() {
-        const isHealthy = this.market.isHealthy(this);
+        const isHealthy = this._market.isHealthy(this);
         if (isHealthy == null)
-            return isHealthy;
+            return;
         return !isHealthy;
     }
     /**
@@ -110,63 +113,63 @@ class AccrualPosition extends Position {
      * `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.
+     * `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;
@@ -176,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;
@@ -190,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));
@@ -201,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;
@@ -210,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

@@ -1,81 +1,60 @@
 import type { Address } from "viem";
-import { type Market, type MaxBorrowOptions, type MaxWithdrawCollateralOptions } from "../market";
+import { type IMarket, Market } from "../market";
+import type { BigIntish } from "../types";
 import { AccrualPosition, type IAccrualPosition } from "./Position";
-export interface PreLiquidationParams {
-    preLltv: bigint;
-    preLCF1: bigint;
-    preLCF2: bigint;
-    preLIF1: bigint;
-    preLIF2: bigint;
+export interface IPreLiquidationParams {
+    preLltv: BigIntish;
+    preLCF1: BigIntish;
+    preLCF2: BigIntish;
+    preLIF1: BigIntish;
+    preLIF2: BigIntish;
     preLiquidationOracle: Address;
 }
-export interface IPreLiquidationPosition extends IAccrualPosition {
-    preLiquidationParams: PreLiquidationParams;
-    preLiquidation: Address;
-    isPreLiquidationAuthorized: boolean;
+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 declare class PreLiquidationPosition extends AccrualPosition implements IPreLiquidationPosition {
+export interface IPreLiquidationPosition extends IAccrualPosition {
     /**
      * The pre-liquidation parameters of the associated PreLiquidation contract.
      */
-    readonly preLiquidationParams: PreLiquidationParams;
+    preLiquidationParams: IPreLiquidationParams;
     /**
      * The address of the PreLiquidation contract this position is associated to.
      */
-    readonly preLiquidation: Address;
-    /**
-     * Whether the PreLiquidation contract is authorized to manage this position.
-     */
-    readonly isPreLiquidationAuthorized: boolean;
-    constructor(position: IPreLiquidationPosition, market: Market);
+    preLiquidation: Address;
     /**
-     * Whether this position is liquidatable via the PreLiquidation contract.
-     * `undefined` iff the market's oracle is undefined or reverts.
+     * The price of the collateral quoted in loan assets used by the PreLiquidation contract.
+     * `undefined` if the oracle reverts.
      */
-    get isPreLiquidatable(): boolean | undefined;
+    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;
     /**
-     * Whether this position is healthy.
-     * `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 isHealthy(): boolean | undefined;
     /**
-     * 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(): bigint | null;
-    /**
-     * 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(): bigint | null | undefined;
-    /**
-     * 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.
-     */
-    get maxBorrowAssets(): bigint | undefined;
-    /**
-     * The maximum amount of collateral that can be withdrawn.
-     * `undefined` iff the market's oracle is undefined or reverts.
-     */
-    get withdrawableCollateral(): bigint | undefined;
-    /**
-     * 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.
-     */
-    get preSeizableCollateral(): bigint | undefined;
-    /**
-     * 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.
+     * @inheritdoc `undefined` if the pre-liquidation's oracle reverts.
      */
-    get preHealthFactor(): bigint | undefined;
+    get isLiquidatable(): boolean | undefined;
     /**
-     * The percentage of this position's borrow power currently used (scaled by WAD).
-     * If the collateral price is 0, usage is `MaxUint256`.
+     * @inheritdoc `undefined` if the pre-liquidation's oracle reverts.
      */
-    get borrowCapacityUsage(): bigint | undefined;
-    getBorrowCapacityLimit(options?: MaxBorrowOptions): import("../market").CapacityLimit | undefined;
-    getWithdrawCollateralCapacityLimit(options?: MaxWithdrawCollateralOptions): import("../market").CapacityLimit | undefined;
+    get seizableCollateral(): bigint | undefined;
 }