@morpho-org/midnight-sdk 0.1.0 → 1.0.0

package/lib/esm/market/Market.js

@@ -1,4 +1,5 @@
 import { assertNonNegative, MathLib, } from "@morpho-org/morpho-ts";
+import { MAX_COLLATERALS } from "../constants.js";
 import { InvalidMarketParameterError } from "../errors.js";
 import { MarketUtils } from "./MarketUtils.js";
 /**
@@ -9,12 +10,14 @@ import { MarketUtils } from "./MarketUtils.js";
  * import { MarketParams } from "@morpho-org/midnight-sdk";
  *
  * const params = new MarketParams({
+ *   chainId: 8453,
+ *   midnight: "0x0000000000000000000000000000000000001000",
  *   loanToken: "0x0000000000000000000000000000000000000001",
  *   collateralParams: [
  *     {
  *       token: "0x0000000000000000000000000000000000000002",
  *       lltv: 770000000000000000n,
- *       maxLif: 1061007957559681697n,
+ *       liquidationCursor: 250000000000000000n,
  *       oracle: "0x0000000000000000000000000000000000000003",
  *     },
  *   ],
@@ -27,6 +30,10 @@ import { MarketUtils } from "./MarketUtils.js";
  * ```
  */
 export class MarketParams {
+    /** EIP-155 chain id captured in the market struct. */
+    chainId;
+    /** Core Midnight contract address captured in the market struct. */
+    midnight;
     /** Loan token address. */
     loanToken;
     /** Collateral definitions sorted by token. */
@@ -43,11 +50,30 @@ export class MarketParams {
      * Creates normalized market params.
      *
      * @param params - Market params to normalize.
-     * @throws {InvalidMarketParameterError} when the collateral list is empty, contains duplicate tokens, or has LLTV outside `[0, WAD]`.
+     * @throws {InvalidMarketParameterError} when the chain id is malformed or negative, or when the collateral list is empty, exceeds {@link MAX_COLLATERALS}, contains duplicate tokens, has LLTV outside `[0, WAD]`, has liquidation cursor outside `[0, WAD)`, or computes an invalid maximum liquidation incentive factor.
      */
     constructor(params) {
+        try {
+            this.chainId = BigInt(params.chainId);
+        }
+        catch (cause) {
+            throw new InvalidMarketParameterError({
+                parameter: "chainId",
+                value: params.chainId,
+                instruction: "Provide a bigint-compatible EIP-155 chain id.",
+                cause,
+            });
+        }
+        this.midnight = params.midnight;
         this.loanToken = params.loanToken;
         const collateralParams = params.collateralParams.map(MarketUtils.toCollateralParams);
+        if (this.chainId < 0n) {
+            throw new InvalidMarketParameterError({
+                parameter: "chainId",
+                value: this.chainId,
+                instruction: "Use a non-negative EIP-155 chain id.",
+            });
+        }
         if (collateralParams.length === 0) {
             throw new InvalidMarketParameterError({
                 parameter: "collateralParams",
@@ -55,6 +81,13 @@ export class MarketParams {
                 instruction: "Provide at least one collateral.",
             });
         }
+        if (collateralParams.length > Number(MAX_COLLATERALS)) {
+            throw new InvalidMarketParameterError({
+                parameter: "collateralParams",
+                value: collateralParams.length,
+                instruction: `Provide at most ${MAX_COLLATERALS} collaterals.`,
+            });
+        }
         const seenCollateralTokens = new Set();
         for (const collateral of collateralParams) {
             if (collateral.lltv < 0n || collateral.lltv > MathLib.WAD) {
@@ -64,6 +97,31 @@ export class MarketParams {
                     instruction: "Use an LLTV between 0 and WAD.",
                 });
             }
+            if (collateral.liquidationCursor < 0n ||
+                collateral.liquidationCursor >= MathLib.WAD) {
+                throw new InvalidMarketParameterError({
+                    parameter: "collateralParams.liquidationCursor",
+                    value: collateral.liquidationCursor,
+                    instruction: "Use a liquidation cursor between 0 and WAD, exclusive of WAD.",
+                });
+            }
+            const maxLif = MathLib.mulDivDown(MathLib.WAD, MathLib.WAD, MathLib.WAD -
+                MathLib.mulDivDown(collateral.liquidationCursor, MathLib.WAD - collateral.lltv, MathLib.WAD));
+            if (maxLif > 2n * MathLib.WAD) {
+                throw new InvalidMarketParameterError({
+                    parameter: "collateralParams.liquidationCursor",
+                    value: collateral.liquidationCursor,
+                    instruction: "Use a liquidation cursor whose computed maximum LIF is at most 2 WAD.",
+                });
+            }
+            if (collateral.lltv !== MathLib.WAD &&
+                collateral.lltv * maxLif > 999000000000000000n * MathLib.WAD) {
+                throw new InvalidMarketParameterError({
+                    parameter: "collateralParams.liquidationCursor",
+                    value: collateral.liquidationCursor,
+                    instruction: "Use an LLTV and liquidation cursor whose computed maximum LIF product satisfies the protocol bound.",
+                });
+            }
             const token = collateral.token.toLowerCase();
             if (seenCollateralTokens.has(token)) {
                 throw new InvalidMarketParameterError({
@@ -93,12 +151,14 @@ export class MarketParams {
      * import { MarketParams } from "@morpho-org/midnight-sdk";
      *
      * const params = MarketParams.from({
+     *   chainId: 8453,
+     *   midnight: "0x0000000000000000000000000000000000001000",
      *   loanToken: "0x0000000000000000000000000000000000006000",
      *   collateralParams: [
      *     {
      *       token: "0x0000000000000000000000000000000000007000",
      *       lltv: 770000000000000000n,
-     *       maxLif: 1061007957559681697n,
+     *       liquidationCursor: 250000000000000000n,
      *       oracle: "0x0000000000000000000000000000000000008000",
      *     },
      *   ],
@@ -139,14 +199,15 @@ export class MarketParams {
  * });
  *
  * const market = new Market({
- *   chainId: 31337,
  *   params: {
+ *     chainId: 31337,
+ *     midnight: "0x0000000000000000000000000000000000001000",
  *     loanToken: "0x0000000000000000000000000000000000006000",
  *     collateralParams: [
  *       {
  *         token: "0x0000000000000000000000000000000000007000",
  *         lltv: 770000000000000000n,
- *         maxLif: 1061007957559681697n,
+ *         liquidationCursor: 250000000000000000n,
  *         oracle: "0x0000000000000000000000000000000000008000",
  *       },
  *     ],
@@ -169,7 +230,7 @@ export class MarketParams {
 export class Market {
     /** Market id. */
     id;
-    /** EIP-155 chain id used to derive the market id. */
+    /** EIP-155 chain id captured in the market struct. */
     chainId;
     /** Immutable market configuration. */
     params;
@@ -188,9 +249,9 @@ export class Market {
     /** Market tick spacing. */
     tickSpacing;
     constructor(market) {
-        this.chainId = BigInt(market.chainId);
         this.params = MarketParams.from(market.params);
-        this.id = MarketUtils.toId({ market: this.params, chainId: this.chainId });
+        this.chainId = this.params.chainId;
+        this.id = MarketUtils.toId(this.params);
         this.totalUnits = BigInt(market.totalUnits);
         this.lossFactor = BigInt(market.lossFactor);
         this.withdrawable = BigInt(market.withdrawable);
@@ -199,6 +260,52 @@ export class Market {
         this.continuousFee = market.continuousFee;
         this.tickSpacing = market.tickSpacing;
     }
+    /**
+     * Returns a hydrated market instance from class or plain input.
+     *
+     * Existing `Market` instances are returned as-is. Plain hydrated market objects
+     * are normalized through the constructor so nested params and bigint fields use
+     * the SDK's canonical shapes.
+     *
+     * @param market - Hydrated market class or plain market input.
+     * @returns Hydrated market instance.
+     * @throws {InvalidMarketParameterError} when nested market params are invalid.
+     * @example
+     * ```ts
+     * import { Market } from "@morpho-org/midnight-sdk";
+     *
+     * const market = Market.from({
+     *   params: {
+     *     chainId: 8453,
+     *     midnight: "0x0000000000000000000000000000000000001000",
+     *     loanToken: "0x0000000000000000000000000000000000006000",
+     *     collateralParams: [
+     *       {
+     *         token: "0x0000000000000000000000000000000000007000",
+     *         lltv: 770000000000000000n,
+     *         liquidationCursor: 250000000000000000n,
+     *         oracle: "0x0000000000000000000000000000000000008000",
+     *       },
+     *     ],
+     *     maturity: 54_000n,
+     *     rcfThreshold: 0n,
+     *     enterGate: "0x0000000000000000000000000000000000000000",
+     *     liquidatorGate: "0x0000000000000000000000000000000000000000",
+     *   },
+     *   totalUnits: 1_000n,
+     *   lossFactor: 0n,
+     *   withdrawable: 500n,
+     *   continuousFeeCredit: 0n,
+     *   settlementFeeCbps: [1, 2, 3, 4, 5, 6, 7],
+     *   continuousFee: 10,
+     *   tickSpacing: 4,
+     * });
+     * console.log(market.id);
+     * ```
+     */
+    static from(market) {
+        return market instanceof Market ? market : new Market(market);
+    }
     /**
      * Returns the non-negative time remaining before maturity.
      *
@@ -225,14 +332,15 @@ export class Market {
      * });
      *
      * const market = new Market({
-     *   chainId: 31337,
      *   params: {
+     *     chainId: 31337,
+     *     midnight: "0x0000000000000000000000000000000000001000",
      *     loanToken: "0x0000000000000000000000000000000000006000",
      *     collateralParams: [
      *       {
      *         token: "0x0000000000000000000000000000000000007000",
      *         lltv: 770000000000000000n,
-     *         maxLif: 1061007957559681697n,
+     *         liquidationCursor: 250000000000000000n,
      *         oracle: "0x0000000000000000000000000000000000008000",
      *       },
      *     ],
@@ -285,14 +393,15 @@ export class Market {
      * });
      *
      * const market = new Market({
-     *   chainId: 31337,
      *   params: {
+     *     chainId: 31337,
+     *     midnight: "0x0000000000000000000000000000000000001000",
      *     loanToken: "0x0000000000000000000000000000000000006000",
      *     collateralParams: [
      *       {
      *         token: "0x0000000000000000000000000000000000007000",
      *         lltv: 770000000000000000n,
-     *         maxLif: 1061007957559681697n,
+     *         liquidationCursor: 250000000000000000n,
      *         oracle: "0x0000000000000000000000000000000000008000",
      *       },
      *     ],
@@ -319,10 +428,11 @@ export class Market {
         });
     }
     /**
-     * Returns collateral params by numeric index.
+     * Returns collateral by numeric index.
      *
      * @param index - Collateral index.
-     * @returns Collateral params, or undefined when the index is not configured.
+     * @returns Collateral entry for the configured index.
+     * @throws {UnknownCollateralIndexError} when the index is not configured.
      * @example
      * ```ts
      * import { registerCustomAddresses } from "@morpho-org/morpho-ts";
@@ -343,14 +453,15 @@ export class Market {
      * });
      *
      * const market = new Market({
-     *   chainId: 31337,
      *   params: {
+     *     chainId: 31337,
+     *     midnight: "0x0000000000000000000000000000000000001000",
      *     loanToken: "0x0000000000000000000000000000000000006000",
      *     collateralParams: [
      *       {
      *         token: "0x0000000000000000000000000000000000007000",
      *         lltv: 770000000000000000n,
-     *         maxLif: 1061007957559681697n,
+     *         liquidationCursor: 250000000000000000n,
      *         oracle: "0x0000000000000000000000000000000000008000",
      *       },
      *     ],
@@ -367,16 +478,12 @@ export class Market {
      *   continuousFee: 10,
      *   tickSpacing: 4,
      * });
-     * const params = market.getCollateralParamsByIndex(0);
-     * console.log(params?.token);
+     * const collateral = market.getCollateralByIndex(0);
+     * console.log(collateral.token);
      * ```
      */
-    getCollateralParamsByIndex(index) {
-        const normalizedIndex = BigInt(index);
-        if (normalizedIndex < 0n ||
-            normalizedIndex > BigInt(Number.MAX_SAFE_INTEGER))
-            return undefined;
-        return this.params.collateralParams[Number(normalizedIndex)];
+    getCollateralByIndex(index) {
+        return MarketUtils.getCollateralByIndex(this, index);
     }
     /**
      * Returns the configured collateral index for a token.
@@ -404,14 +511,15 @@ export class Market {
      *
      * const collateralToken = "0x0000000000000000000000000000000000007000";
      * const market = new Market({
-     *   chainId: 31337,
      *   params: {
+     *     chainId: 31337,
+     *     midnight: "0x0000000000000000000000000000000000001000",
      *     loanToken: "0x0000000000000000000000000000000000006000",
      *     collateralParams: [
      *       {
      *         token: collateralToken,
      *         lltv: 770000000000000000n,
-     *         maxLif: 1061007957559681697n,
+     *         liquidationCursor: 250000000000000000n,
      *         oracle: "0x0000000000000000000000000000000000008000",
      *       },
      *     ],
@@ -463,14 +571,15 @@ export class Market {
      *
      * const collateralToken = "0x0000000000000000000000000000000000007000";
      * const market = new Market({
-     *   chainId: 31337,
      *   params: {
+     *     chainId: 31337,
+     *     midnight: "0x0000000000000000000000000000000000001000",
      *     loanToken: "0x0000000000000000000000000000000000006000",
      *     collateralParams: [
      *       {
      *         token: collateralToken,
      *         lltv: 770000000000000000n,
-     *         maxLif: 1061007957559681697n,
+     *         liquidationCursor: 250000000000000000n,
      *         oracle: "0x0000000000000000000000000000000000008000",
      *       },
      *     ],

package/lib/esm/market/MarketUtils.d.ts

@@ -17,7 +17,7 @@ export declare namespace MarketUtils {
      *
      * @param params.token - Collateral token address.
      * @param params.lltv - WAD-scaled liquidation loan-to-value.
-     * @param params.maxLif - WAD-scaled maximum liquidation incentive factor.
+     * @param params.liquidationCursor - WAD-scaled liquidation cursor.
      * @param params.oracle - Oracle address used to price this collateral.
      * @returns Collateral params with bigint fields.
      * @example
@@ -27,10 +27,10 @@ export declare namespace MarketUtils {
      * const collateral = MarketUtils.toCollateralParams({
      *   token: "0x0000000000000000000000000000000000000001",
      *   lltv: 770000000000000000n,
-     *   maxLif: 1061007957559681697n,
+     *   liquidationCursor: 250000000000000000n,
      *   oracle: "0x0000000000000000000000000000000000000002",
      * });
-     * console.log(collateral.maxLif);
+     * console.log(collateral.liquidationCursor);
      * ```
      */
     function toCollateralParams(params: CollateralParamsInput): CollateralParams;
@@ -44,12 +44,14 @@ export declare namespace MarketUtils {
      * import { MarketUtils } from "@morpho-org/midnight-sdk";
      *
      * const struct = MarketUtils.toStruct({
+     *   chainId: 8453,
+     *   midnight: "0x0000000000000000000000000000000000001000",
      *   loanToken: "0x0000000000000000000000000000000000006000",
      *   collateralParams: [
      *     {
      *       token: "0x0000000000000000000000000000000000007000",
      *       lltv: 770000000000000000n,
-     *       maxLif: 1061007957559681697n,
+     *       liquidationCursor: 250000000000000000n,
      *       oracle: "0x0000000000000000000000000000000000008000",
      *     },
      *   ],
@@ -62,19 +64,51 @@ export declare namespace MarketUtils {
      * ```
      */
     function toStruct(market: MarketInput): MarketParams;
+    /**
+     * Returns configured collateral by index.
+     *
+     * @param market - Market params or hydrated market.
+     * @param index - Collateral index to look up.
+     * @returns Collateral entry for the configured index.
+     * @throws {UnknownCollateralIndexError} when the index is not configured.
+     * @example
+     * ```ts
+     * import { MarketUtils } from "@morpho-org/midnight-sdk";
+     *
+     * const collateral = MarketUtils.getCollateralByIndex({
+     *   chainId: 8453,
+     *   midnight: "0x0000000000000000000000000000000000001000",
+     *   loanToken: "0x0000000000000000000000000000000000000001",
+     *   collateralParams: [
+     *     {
+     *       token: "0x0000000000000000000000000000000000000002",
+     *       lltv: 770000000000000000n,
+     *       liquidationCursor: 250000000000000000n,
+     *       oracle: "0x0000000000000000000000000000000000000003",
+     *     },
+     *   ],
+     *   maturity: 1n,
+     *   rcfThreshold: 0n,
+     *   enterGate: "0x0000000000000000000000000000000000000000",
+     *   liquidatorGate: "0x0000000000000000000000000000000000000000",
+     * }, 0n);
+     * console.log(collateral.token);
+     * ```
+     */
+    function getCollateralByIndex(market: MarketInput, index: BigIntish): CollateralParams;
     /**
      * Returns the liquidation incentive factor for an LLTV and liquidation cursor.
      *
      * @param input - WAD-scaled LLTV or collateral params carrying an LLTV.
-     * @param cursor - WAD-scaled liquidation cursor, usually `LIQUIDATION_CURSOR_LOW` or `LIQUIDATION_CURSOR_HIGH`.
+     * @param cursor - WAD-scaled liquidation cursor.
      * @returns WAD-scaled liquidation incentive factor.
      * @example
      * ```ts
-     * import { LIQUIDATION_CURSOR_LOW, MarketUtils } from "@morpho-org/midnight-sdk";
+     * import { MarketUtils } from "@morpho-org/midnight-sdk";
      *
      * const liquidationIncentiveFactor = MarketUtils.getLiquidationIncentiveFactor(
      *   770000000000000000n,
-     *   LIQUIDATION_CURSOR_LOW,
+     *   250000000000000000n,
      * );
      * console.log(liquidationIncentiveFactor);
      * ```
@@ -121,12 +155,14 @@ export declare namespace MarketUtils {
      * import { MarketUtils } from "@morpho-org/midnight-sdk";
      *
      * const hash = MarketUtils.hash({
+     *   chainId: 8453,
+     *   midnight: "0x0000000000000000000000000000000000001000",
      *   loanToken: "0x0000000000000000000000000000000000000001",
      *   collateralParams: [
      *     {
      *       token: "0x0000000000000000000000000000000000000002",
      *       lltv: 770000000000000000n,
-     *       maxLif: 1061007957559681697n,
+     *       liquidationCursor: 250000000000000000n,
      *       oracle: "0x0000000000000000000000000000000000000003",
      *     },
      *   ],
@@ -142,48 +178,32 @@ export declare namespace MarketUtils {
     /**
      * Computes the Midnight id for a market using `IdLib.toId`.
      *
-     * @param params.market - Market to hash.
-     * @param params.chainId - EIP-155 chain id used to resolve the core Midnight address from the registry.
+     * @param market - Market to hash.
      * @returns Market id.
-     * @throws {UnsupportedChainIdError} when no address registry exists for `chainId`.
-     * @throws {UnknownAddressError} when the registry has no Midnight address for `chainId`.
      * @example
      * ```ts
-     * import { ChainId, registerCustomAddresses } from "@morpho-org/morpho-ts";
      * import { MarketUtils } from "@morpho-org/midnight-sdk";
      *
-     * registerCustomAddresses({
-     *   addresses: {
-     *     [ChainId.BaseMainnet]: {
-     *       midnight: "0x0000000000000000000000000000000000000001",
-     *     },
-     *   },
-     * });
-     *
      * const id = MarketUtils.toId({
-     *   market: {
-     *     loanToken: "0x0000000000000000000000000000000000000001",
-     *     collateralParams: [
-     *       {
-     *         token: "0x0000000000000000000000000000000000000002",
-     *         lltv: 770000000000000000n,
-     *         maxLif: 1061007957559681697n,
-     *         oracle: "0x0000000000000000000000000000000000000003",
-     *       },
-     *     ],
-     *     maturity: 1n,
-     *     rcfThreshold: 0n,
-     *     enterGate: "0x0000000000000000000000000000000000000000",
-     *     liquidatorGate: "0x0000000000000000000000000000000000000000",
-     *   },
-     *   chainId: ChainId.BaseMainnet,
+     *   chainId: 8453,
+     *   midnight: "0x0000000000000000000000000000000000001000",
+     *   loanToken: "0x0000000000000000000000000000000000000001",
+     *   collateralParams: [
+     *     {
+     *       token: "0x0000000000000000000000000000000000000002",
+     *       lltv: 770000000000000000n,
+     *       liquidationCursor: 250000000000000000n,
+     *       oracle: "0x0000000000000000000000000000000000000003",
+     *     },
+     *   ],
+     *   maturity: 1n,
+     *   rcfThreshold: 0n,
+     *   enterGate: "0x0000000000000000000000000000000000000000",
+     *   liquidatorGate: "0x0000000000000000000000000000000000000000",
      * });
      * console.log(id);
      * ```
      */
-    function toId(params: {
-        readonly market: MarketInput;
-        readonly chainId: BigIntish;
-    }): `0x${string}`;
+    function toId(market: MarketInput): `0x${string}`;
 }
 export {};