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

package/lib/addresses.d.ts

@@ -35,6 +35,7 @@ export interface ChainAddresses {
     publicAllocator?: Address;
     metaMorphoFactory?: Address;
     chainlinkOracleFactory?: Address;
+    preLiquidationFactory?: Address;
     wNative?: Address;
     morphoToken?: Address;
     /**
@@ -78,6 +79,7 @@ export declare const addressesRegistry: {
         readonly publicAllocator: "0xfd32fA2ca22c76dD6E550706Ad913FC6CE91c75D";
         readonly metaMorphoFactory: "0x1897A8997241C1cD4bD0698647e4EB7213535c24";
         readonly chainlinkOracleFactory: "0x3A7bB36Ee3f3eE32A60e9f2b33c1e5f2E83ad766";
+        readonly preLiquidationFactory: "0x6FF33615e792E35ed1026ea7cACCf42D9BF83476";
         readonly wNative: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2";
         readonly morphoToken: "0x9994E35Db50125E0DF82e4c2dde62496CE330999";
         readonly dai: "0x6B175474E89094C44Da98b954EedeAC495271d0F";
@@ -128,6 +130,7 @@ export declare const addressesRegistry: {
         readonly publicAllocator: "0xA090dD1a701408Df1d4d0B85b716c87565f90467";
         readonly metaMorphoFactory: "0xFf62A7c278C62eD665133147129245053Bbf5918";
         readonly chainlinkOracleFactory: "0x2DC205F24BCb6B311E5cdf0745B0741648Aebd3d";
+        readonly preLiquidationFactory: "0x8cd16b62E170Ee0bA83D80e1F80E6085367e2aef";
         readonly wNative: "0x4200000000000000000000000000000000000006";
         readonly usdc: "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913";
         readonly verUsdc: "0x59aaF835D34b1E3dF2170e4872B785f11E2a964b";
@@ -148,6 +151,7 @@ export declare const addressesRegistry: {
         readonly publicAllocator: "0xfac15aff53ADd2ff80C2962127C434E8615Df0d3";
         readonly metaMorphoFactory: "0xa9c87daB340631C34BB738625C70499e29ddDC98";
         readonly chainlinkOracleFactory: "0x1ff7895Eb842794c5d07C4c547b6730e61295215";
+        readonly preLiquidationFactory: "0xeDadDe37D76c72b98725614d0b41C20Fe612d304";
         readonly wNative: "0x0d500B1d8E8eF31E21C99d1Db9A6444d3ADf1270";
     };
     readonly 42161: {
@@ -162,6 +166,7 @@ export declare const addressesRegistry: {
         readonly publicAllocator: "0x769583Af5e9D03589F159EbEC31Cc2c23E8C355E";
         readonly metaMorphoFactory: "0x878988f5f561081deEa117717052164ea1Ef0c82";
         readonly chainlinkOracleFactory: "0x98Ce5D183DC0c176f54D37162F87e7eD7f2E41b5";
+        readonly preLiquidationFactory: "0x635c31B5DF1F7EFbCbC07E302335Ef4230758e3d";
         readonly wNative: "0x82aF49447D8a07e3bd95BD0d56f35241523fBab1";
         readonly usdc: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831";
     };
@@ -177,6 +182,7 @@ export declare const addressesRegistry: {
         readonly publicAllocator: "0x0d68a97324E602E02799CD83B42D337207B40658";
         readonly metaMorphoFactory: "0x3Bb6A6A0Bc85b367EFE0A5bAc81c5E52C892839a";
         readonly chainlinkOracleFactory: "0x1ec408D4131686f727F3Fd6245CF85Bc5c9DAD70";
+        readonly preLiquidationFactory: "0x3d05C01EE8e97361b9E19D172128255eaE5F98B9";
         readonly wNative: "0x4200000000000000000000000000000000000006";
         readonly usdc: "0x0b2C639c533813f4Aa9D7837CAf62653d097Ff85";
     };
@@ -190,6 +196,7 @@ export declare const addressesRegistry: {
         readonly publicAllocator: "0xef9889B4e443DEd35FA0Bd060f2104Cca94e6A43";
         readonly metaMorphoFactory: "0x4DBB3a642a2146d5413750Cca3647086D9ba5F12";
         readonly chainlinkOracleFactory: "0xd706690BA1Fe26b70c4AD89e60ff62cEB3A2eD02";
+        readonly preLiquidationFactory: "0xe3cE2051a24e58DBFC0eFBe4c2d9e89c5eAe4695";
         readonly wNative: "0x4200000000000000000000000000000000000006";
     };
     readonly 252: {
@@ -202,6 +209,7 @@ export declare const addressesRegistry: {
         readonly publicAllocator: "0x37a888192165fC39884f87c64E2476BfD2C09675";
         readonly metaMorphoFactory: "0x27D4Af0AC9E7FDfA6D0853236f249CC27AE79488";
         readonly chainlinkOracleFactory: "0x39d8622C607A691D7705E8842fbB12E3c38dCD41";
+        readonly preLiquidationFactory: "0xe3cE2051a24e58DBFC0eFBe4c2d9e89c5eAe4695";
         readonly wNative: "0xfc00000000000000000000000000000000000006";
     };
     readonly 534352: {
@@ -214,6 +222,7 @@ export declare const addressesRegistry: {
         readonly publicAllocator: "0x8a7f671E45E51dE245649Cf916cA0256FB8a9927";
         readonly metaMorphoFactory: "0x56b65742ade55015e6480959808229Ad6dbc9295";
         readonly chainlinkOracleFactory: "0xb5961902E60b188b1c665B7b72Ef616656A9e24E";
+        readonly preLiquidationFactory: "0xeD960178e4aDA0296786Fa79D84e8FDF7bd44B25";
         readonly wNative: "0x5300000000000000000000000000000000000004";
         readonly usdc: "0x06eFdBFf2a14a7c8E15944D1F4A48F9F95F663A4";
     };
@@ -227,6 +236,7 @@ export declare const addressesRegistry: {
         readonly publicAllocator: "0x85416891752a6B81106c1C2999AE1AF5d8Cd3357";
         readonly metaMorphoFactory: "0xd3f39505d0c48AFED3549D625982FdC38Ea9904b";
         readonly chainlinkOracleFactory: "0x3FFFE273ee348b9E1ef89533025C7f165B17B439";
+        readonly preLiquidationFactory: "0x30607fEa77168d2c0401B6f60F0B40E32F9339E3";
         readonly wNative: "0x4200000000000000000000000000000000000006";
         readonly usdc: "0xF1815bd50389c46847f0Bda824eC8da914045D14";
     };
@@ -240,6 +250,7 @@ export declare const addressesRegistry: {
         readonly publicAllocator: "0xB0c9a107fA17c779B3378210A7a593e88938C7C9";
         readonly metaMorphoFactory: "0xe9EdE3929F43a7062a007C3e8652e4ACa610Bdc0";
         readonly chainlinkOracleFactory: "0x43269546e1D586a1f7200a0AC07e26f9631f7539";
+        readonly preLiquidationFactory: "0xb04e4D3D59Ee47Ca9BA192707AF13A7D02969911";
         readonly wNative: "0x4200000000000000000000000000000000000006";
         readonly usdc: "0x078D782b760474a361dDA0AF3839290b0EF57AD6";
     };
@@ -253,6 +264,7 @@ export declare const addressesRegistry: {
         readonly publicAllocator: "0x6Cef2EDC70D87E8f1623f3096efF05d066E59B36";
         readonly metaMorphoFactory: "0x0cE9e3512CB4df8ae7e265e62Fb9258dc14f12e8";
         readonly chainlinkOracleFactory: "0x7DA59Fa482F1F49fADc486d8e47BADc506fEb86d";
+        readonly preLiquidationFactory: "0xc72129DA4CC808e955699111b8c22B22Ca8A10b8";
         readonly wNative: "0x039e2fB66102314Ce7b64Ce5Ce3E5183bc94aD38";
     };
     readonly 43111: {
@@ -265,6 +277,7 @@ export declare const addressesRegistry: {
         readonly publicAllocator: "0x4107Ea1746909028d6212B315dE5fE9538F9eb39";
         readonly metaMorphoFactory: "0x8e52179BeB18E882040b01632440d8Ca0f01da82";
         readonly chainlinkOracleFactory: "0xB3cb32E6185446a6Bc7A047E4FfA138fA939e133";
+        readonly preLiquidationFactory: "0x40F2896C551194e364F7C846046C34d8a9FE97e4";
         readonly wNative: "0x4200000000000000000000000000000000000006";
         readonly usdc: "0xad11a8BEb98bbf61dbb1aa0F6d6F2ECD87b35afA";
     };
@@ -278,6 +291,7 @@ export declare const addressesRegistry: {
         readonly publicAllocator: "0xEE868Bf3359DA30c10ea472EAEBFC0a06E8F0120";
         readonly metaMorphoFactory: "0xae5b0884bfff430493D6C844B9fd052Af7d79278";
         readonly chainlinkOracleFactory: "0xf9380f7898423Bd7FDe3C9fDD1b2671A2471f39D";
+        readonly preLiquidationFactory: "0x249E4808264c545861e43728186a731dE7c7D745";
         readonly wNative: "0x4200000000000000000000000000000000000006";
     };
     readonly 21000000: {
@@ -290,6 +304,7 @@ export declare const addressesRegistry: {
         readonly publicAllocator: "0xDFde06e2B2A2D718eE5560b73dA4F830E56A2f10";
         readonly metaMorphoFactory: "0xe430821595602eA5DD0cD350f86987437c7362fA";
         readonly chainlinkOracleFactory: "0x16278156D366fC91536b6b81482ffaC47EEa06D6";
+        readonly preLiquidationFactory: "0xb9065AC18d3EBdb3263B77B587f9c5CD570545D1";
         readonly wNative: "0xda5dDd7270381A7C2717aD10D1c0ecB19e3CDFb2";
         readonly usdc: "0xDF0B24095e15044538866576754F3C964e902Ee6";
     };

package/lib/addresses.js

@@ -40,6 +40,7 @@ exports.addressesRegistry = {
         publicAllocator: "0xfd32fA2ca22c76dD6E550706Ad913FC6CE91c75D",
         metaMorphoFactory: "0x1897A8997241C1cD4bD0698647e4EB7213535c24",
         chainlinkOracleFactory: "0x3A7bB36Ee3f3eE32A60e9f2b33c1e5f2E83ad766",
+        preLiquidationFactory: "0x6FF33615e792E35ed1026ea7cACCf42D9BF83476",
         wNative: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
         morphoToken: "0x9994E35Db50125E0DF82e4c2dde62496CE330999",
         // Must implement DAI specific permit (otherwise breaks permit signatures).
@@ -96,6 +97,7 @@ exports.addressesRegistry = {
         publicAllocator: "0xA090dD1a701408Df1d4d0B85b716c87565f90467",
         metaMorphoFactory: "0xFf62A7c278C62eD665133147129245053Bbf5918",
         chainlinkOracleFactory: "0x2DC205F24BCb6B311E5cdf0745B0741648Aebd3d",
+        preLiquidationFactory: "0x8cd16b62E170Ee0bA83D80e1F80E6085367e2aef",
         wNative: "0x4200000000000000000000000000000000000006",
         // Must implement USDC permit version 2 (otherwise breaks permit signatures).
         usdc: "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
@@ -117,6 +119,7 @@ exports.addressesRegistry = {
         publicAllocator: "0xfac15aff53ADd2ff80C2962127C434E8615Df0d3",
         metaMorphoFactory: "0xa9c87daB340631C34BB738625C70499e29ddDC98",
         chainlinkOracleFactory: "0x1ff7895Eb842794c5d07C4c547b6730e61295215",
+        preLiquidationFactory: "0xeDadDe37D76c72b98725614d0b41C20Fe612d304",
         wNative: "0x0d500B1d8E8eF31E21C99d1Db9A6444d3ADf1270",
     },
     [chain_js_1.ChainId.ArbitrumMainnet]: {
@@ -131,6 +134,7 @@ exports.addressesRegistry = {
         publicAllocator: "0x769583Af5e9D03589F159EbEC31Cc2c23E8C355E",
         metaMorphoFactory: "0x878988f5f561081deEa117717052164ea1Ef0c82",
         chainlinkOracleFactory: "0x98Ce5D183DC0c176f54D37162F87e7eD7f2E41b5",
+        preLiquidationFactory: "0x635c31B5DF1F7EFbCbC07E302335Ef4230758e3d",
         wNative: "0x82aF49447D8a07e3bd95BD0d56f35241523fBab1",
         // Must implement USDC permit version 2 (otherwise breaks permit signatures).
         usdc: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
@@ -147,6 +151,7 @@ exports.addressesRegistry = {
         publicAllocator: "0x0d68a97324E602E02799CD83B42D337207B40658",
         metaMorphoFactory: "0x3Bb6A6A0Bc85b367EFE0A5bAc81c5E52C892839a",
         chainlinkOracleFactory: "0x1ec408D4131686f727F3Fd6245CF85Bc5c9DAD70",
+        preLiquidationFactory: "0x3d05C01EE8e97361b9E19D172128255eaE5F98B9",
         wNative: "0x4200000000000000000000000000000000000006",
         // Must implement USDC permit version 2 (otherwise breaks permit signatures).
         usdc: "0x0b2C639c533813f4Aa9D7837CAf62653d097Ff85",
@@ -161,6 +166,7 @@ exports.addressesRegistry = {
         publicAllocator: "0xef9889B4e443DEd35FA0Bd060f2104Cca94e6A43",
         metaMorphoFactory: "0x4DBB3a642a2146d5413750Cca3647086D9ba5F12",
         chainlinkOracleFactory: "0xd706690BA1Fe26b70c4AD89e60ff62cEB3A2eD02",
+        preLiquidationFactory: "0xe3cE2051a24e58DBFC0eFBe4c2d9e89c5eAe4695",
         wNative: "0x4200000000000000000000000000000000000006",
     },
     [chain_js_1.ChainId.FraxtalMainnet]: {
@@ -173,6 +179,7 @@ exports.addressesRegistry = {
         publicAllocator: "0x37a888192165fC39884f87c64E2476BfD2C09675",
         metaMorphoFactory: "0x27D4Af0AC9E7FDfA6D0853236f249CC27AE79488",
         chainlinkOracleFactory: "0x39d8622C607A691D7705E8842fbB12E3c38dCD41",
+        preLiquidationFactory: "0xe3cE2051a24e58DBFC0eFBe4c2d9e89c5eAe4695",
         wNative: "0xfc00000000000000000000000000000000000006",
     },
     [chain_js_1.ChainId.ScrollMainnet]: {
@@ -185,6 +192,7 @@ exports.addressesRegistry = {
         publicAllocator: "0x8a7f671E45E51dE245649Cf916cA0256FB8a9927",
         metaMorphoFactory: "0x56b65742ade55015e6480959808229Ad6dbc9295",
         chainlinkOracleFactory: "0xb5961902E60b188b1c665B7b72Ef616656A9e24E",
+        preLiquidationFactory: "0xeD960178e4aDA0296786Fa79D84e8FDF7bd44B25",
         wNative: "0x5300000000000000000000000000000000000004",
         // Must implement USDC permit version 2 (otherwise breaks permit signatures).
         usdc: "0x06eFdBFf2a14a7c8E15944D1F4A48F9F95F663A4",
@@ -199,6 +207,7 @@ exports.addressesRegistry = {
         publicAllocator: "0x85416891752a6B81106c1C2999AE1AF5d8Cd3357",
         metaMorphoFactory: "0xd3f39505d0c48AFED3549D625982FdC38Ea9904b",
         chainlinkOracleFactory: "0x3FFFE273ee348b9E1ef89533025C7f165B17B439",
+        preLiquidationFactory: "0x30607fEa77168d2c0401B6f60F0B40E32F9339E3",
         wNative: "0x4200000000000000000000000000000000000006",
         // Must implement USDC permit version 2 (otherwise breaks permit signatures).
         usdc: "0xF1815bd50389c46847f0Bda824eC8da914045D14",
@@ -213,6 +222,7 @@ exports.addressesRegistry = {
         publicAllocator: "0xB0c9a107fA17c779B3378210A7a593e88938C7C9",
         metaMorphoFactory: "0xe9EdE3929F43a7062a007C3e8652e4ACa610Bdc0",
         chainlinkOracleFactory: "0x43269546e1D586a1f7200a0AC07e26f9631f7539",
+        preLiquidationFactory: "0xb04e4D3D59Ee47Ca9BA192707AF13A7D02969911",
         wNative: "0x4200000000000000000000000000000000000006",
         // Must implement USDC permit version 2 (otherwise breaks permit signatures).
         usdc: "0x078D782b760474a361dDA0AF3839290b0EF57AD6",
@@ -227,6 +237,7 @@ exports.addressesRegistry = {
         publicAllocator: "0x6Cef2EDC70D87E8f1623f3096efF05d066E59B36",
         metaMorphoFactory: "0x0cE9e3512CB4df8ae7e265e62Fb9258dc14f12e8",
         chainlinkOracleFactory: "0x7DA59Fa482F1F49fADc486d8e47BADc506fEb86d",
+        preLiquidationFactory: "0xc72129DA4CC808e955699111b8c22B22Ca8A10b8",
         wNative: "0x039e2fB66102314Ce7b64Ce5Ce3E5183bc94aD38",
     },
     [chain_js_1.ChainId.HemiMainnet]: {
@@ -239,6 +250,7 @@ exports.addressesRegistry = {
         publicAllocator: "0x4107Ea1746909028d6212B315dE5fE9538F9eb39",
         metaMorphoFactory: "0x8e52179BeB18E882040b01632440d8Ca0f01da82",
         chainlinkOracleFactory: "0xB3cb32E6185446a6Bc7A047E4FfA138fA939e133",
+        preLiquidationFactory: "0x40F2896C551194e364F7C846046C34d8a9FE97e4",
         wNative: "0x4200000000000000000000000000000000000006",
         // Must implement USDC permit version 2 (otherwise breaks permit signatures).
         usdc: "0xad11a8BEb98bbf61dbb1aa0F6d6F2ECD87b35afA",
@@ -253,6 +265,7 @@ exports.addressesRegistry = {
         publicAllocator: "0xEE868Bf3359DA30c10ea472EAEBFC0a06E8F0120",
         metaMorphoFactory: "0xae5b0884bfff430493D6C844B9fd052Af7d79278",
         chainlinkOracleFactory: "0xf9380f7898423Bd7FDe3C9fDD1b2671A2471f39D",
+        preLiquidationFactory: "0x249E4808264c545861e43728186a731dE7c7D745",
         wNative: "0x4200000000000000000000000000000000000006",
     },
     [chain_js_1.ChainId.CornMainnet]: {
@@ -265,6 +278,7 @@ exports.addressesRegistry = {
         publicAllocator: "0xDFde06e2B2A2D718eE5560b73dA4F830E56A2f10",
         metaMorphoFactory: "0xe430821595602eA5DD0cD350f86987437c7362fA",
         chainlinkOracleFactory: "0x16278156D366fC91536b6b81482ffaC47EEa06D6",
+        preLiquidationFactory: "0xb9065AC18d3EBdb3263B77B587f9c5CD570545D1",
         wNative: "0xda5dDd7270381A7C2717aD10D1c0ecB19e3CDFb2",
         // Must implement USDC permit version 2 (otherwise breaks permit signatures).
         usdc: "0xDF0B24095e15044538866576754F3C964e902Ee6",

package/lib/errors.d.ts

@@ -21,7 +21,16 @@ 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 AlreadySet extends Error {
+        readonly name: string;
+        readonly value: string;
+        constructor(name: string, value: string);
+    }
     class InvalidInterestAccrual extends Error {
         readonly marketId: MarketId;
         readonly timestamp: bigint;

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,8 +46,26 @@ 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 AlreadySet extends Error {
+        name;
+        value;
+        constructor(name, value) {
+            super(`${name} is already set to ${value}`);
+            this.name = name;
+            this.value = value;
+        }
+    }
+    BlueErrors.AlreadySet = AlreadySet;
     class InvalidInterestAccrual extends Error {
         marketId;
         timestamp;

package/lib/index.d.ts

@@ -10,3 +10,4 @@ export * from "./user/index.js";
 export * from "./holding/index.js";
 export * from "./position/index.js";
 export * from "./vault/index.js";
+export * from "./preLiquidation.js";

package/lib/index.js

@@ -26,3 +26,4 @@ __exportStar(require("./user/index.js"), exports);
 __exportStar(require("./holding/index.js"), exports);
 __exportStar(require("./position/index.js"), exports);
 __exportStar(require("./vault/index.js"), exports);
+__exportStar(require("./preLiquidation.js"), exports);

package/lib/market/Market.d.ts

@@ -275,7 +275,7 @@ export declare class Market implements IMarket {
     getHealthFactor(position: {
         collateral: bigint;
         borrowShares: bigint;
-    }): bigint | null | undefined;
+    }): bigint | undefined;
     /**
      * Returns the loan-to-value ratio of a given borrow position (scaled by WAD).
      * @param position The borrow position to consider.

package/lib/market/MarketUtils.d.ts

@@ -225,8 +225,8 @@ export declare namespace MarketUtils {
     }): bigint | null | undefined;
     /**
      * Returns the health factor of a given borrow position (scaled by WAD).
+     * If the debt is 0, health factor is `MaxUint256`.
      * Returns `undefined` iff the market's price is undefined.
-     * Returns null if the position is not a borrow.
      */
     function getHealthFactor({ collateral, borrowShares, }: {
         collateral: BigIntish;
@@ -237,7 +237,7 @@ export declare namespace MarketUtils {
         price?: BigIntish;
     }, marketParams: {
         lltv: BigIntish;
-    }): bigint | null | undefined;
+    }): bigint | undefined;
     /**
      * Returns the loan-to-value ratio of a given borrow position (scaled by WAD).
      * Returns `undefined` iff the market's price is undefined.

package/lib/market/MarketUtils.js

@@ -272,14 +272,10 @@ var MarketUtils;
     MarketUtils.getPriceVariationToLiquidationPrice = getPriceVariationToLiquidationPrice;
     /**
      * Returns the health factor of a given borrow position (scaled by WAD).
+     * If the debt is 0, health factor is `MaxUint256`.
      * 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 index_js_1.MathLib.MAX_UINT_256;

package/lib/position/Position.d.ts

@@ -33,66 +33,73 @@ 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` if the market's oracle is undefined or reverts.
+     */
+    get isLiquidatable(): boolean | undefined;
     /**
      * 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(): bigint | null;
     /**
      * 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(): 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 | null | 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 | null | undefined;
+    get healthFactor(): bigint | undefined;
     /**
      * The percentage of this position's borrow power currently used (scaled by WAD).
      * If the collateral price is 0, usage is `MaxUint256`.

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 {