@morpho-org/midnight-sdk 0.1.0 → 1.0.0

package/lib/cjs/errors.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InvalidMidnightApiResponseError = exports.MidnightApiError = exports.InvalidTypedDataSignatureError = exports.InvalidTreeError = exports.InvalidTreeHeightError = exports.InvalidOfferParameterError = exports.InvalidMarketParameterError = exports.InvalidPositionAccrualStateError = exports.InvalidPositionLossFactorError = exports.InvalidPositionAccrualTimestampError = exports.SettlementFeeExceedsPriceError = exports.InvalidTickSpacingError = exports.PriceGreaterThanOneError = exports.TickOutOfRangeError = exports.InvalidOfferGroupError = void 0;
+exports.InvalidMidnightApiResponseError = exports.MidnightApiError = exports.InvalidTypedDataSignatureError = exports.MidnightMempoolValidationError = exports.ChainIdMismatchError = exports.InvalidTreeError = exports.InvalidTreeHeightError = exports.PayloadDecodeError = exports.InvalidOfferParameterError = exports.UnknownCollateralIndexError = exports.InvalidMarketParameterError = exports.InvalidPositionAccrualStateError = exports.InvalidPositionLossFactorError = exports.InvalidPositionAccrualTimestampError = exports.SettlementFeeExceedsPriceError = exports.InvalidTickSpacingError = exports.PriceGreaterThanOneError = exports.TickOutOfRangeError = exports.InvalidOfferGroupError = void 0;
 /**
  * Thrown when a Midnight offer group violates protocol-level group mechanics.
  *
@@ -171,6 +171,34 @@ class InvalidMarketParameterError extends Error {
     }
 }
 exports.InvalidMarketParameterError = InvalidMarketParameterError;
+/**
+ * Thrown when a Midnight market collateral index is not configured.
+ *
+ * @example
+ * ```ts
+ * import { UnknownCollateralIndexError } from "@morpho-org/midnight-sdk";
+ *
+ * throw new UnknownCollateralIndexError({
+ *   market: "0x1111111111111111111111111111111111111111111111111111111111111111",
+ *   collateralIndex: 2n,
+ * });
+ * ```
+ * @param params.market - Market id whose collateral list was queried.
+ * @param params.collateralIndex - Missing collateral index.
+ */
+class UnknownCollateralIndexError extends Error {
+    /** Market id whose collateral list was queried. */
+    market;
+    /** Missing collateral index. */
+    collateralIndex;
+    constructor(params) {
+        super(`Midnight market "${params.market}" has no collateral at index "${params.collateralIndex}". Use a configured collateral index.`);
+        this.name = "UnknownCollateralIndexError";
+        this.market = params.market;
+        this.collateralIndex = params.collateralIndex;
+    }
+}
+exports.UnknownCollateralIndexError = UnknownCollateralIndexError;
 /**
  * Thrown when an offer builder receives a parameter that cannot satisfy Midnight protocol rules.
  *
@@ -198,6 +226,26 @@ class InvalidOfferParameterError extends Error {
     }
 }
 exports.InvalidOfferParameterError = InvalidOfferParameterError;
+/**
+ * Thrown when Midnight mempool payload bytes cannot be encoded or decoded.
+ *
+ * @example
+ * ```ts
+ * import { PayloadDecodeError } from "@morpho-org/midnight-sdk";
+ *
+ * throw new PayloadDecodeError("payload too short for header");
+ * ```
+ */
+class PayloadDecodeError extends Error {
+    /** Machine-readable decode failure reason without the class message prefix. */
+    reason;
+    constructor(reason, cause) {
+        super(`Failed to decode payload: ${reason}`, cause ? { cause } : undefined);
+        this.name = "PayloadDecodeError";
+        this.reason = reason;
+    }
+}
+exports.PayloadDecodeError = PayloadDecodeError;
 /**
  * Thrown when a tree height exceeds the ratifier typehash table.
  *
@@ -232,6 +280,49 @@ class InvalidTreeError extends Error {
     }
 }
 exports.InvalidTreeError = InvalidTreeError;
+/**
+ * Thrown when a viem client's chain id does not match the chain id required by a signing flow.
+ *
+ * @example
+ * ```ts
+ * import { ChainIdMismatchError } from "@morpho-org/midnight-sdk";
+ *
+ * throw new ChainIdMismatchError(1, 8453n);
+ * ```
+ */
+class ChainIdMismatchError extends Error {
+    /** Chain id reported by the viem client, when configured. */
+    clientChainId;
+    /** Chain id required by the data being signed. */
+    expectedChainId;
+    constructor(clientChainId, expectedChainId) {
+        super(`Client chain id "${clientChainId}" does not match expected chain id "${expectedChainId}". Switch the viem client to the offer market chain before signing.`);
+        this.name = "ChainIdMismatchError";
+        this.clientChainId = clientChainId;
+        this.expectedChainId = expectedChainId;
+    }
+}
+exports.ChainIdMismatchError = ChainIdMismatchError;
+/**
+ * Thrown when the Midnight API rejects a tree during mempool policy validation.
+ *
+ * @example
+ * ```ts
+ * import { MidnightMempoolValidationError } from "@morpho-org/midnight-sdk";
+ *
+ * throw new MidnightMempoolValidationError([{ rule: "tick_spacing" }]);
+ * ```
+ */
+class MidnightMempoolValidationError extends Error {
+    /** Validation issues returned by the Midnight API. */
+    issues;
+    constructor(issues) {
+        super(`Midnight mempool validation failed with "${issues.length}" issue${issues.length === 1 ? "" : "s"}. Adjust the offer parameters and try again.`);
+        this.name = "MidnightMempoolValidationError";
+        this.issues = issues;
+    }
+}
+exports.MidnightMempoolValidationError = MidnightMempoolValidationError;
 /**
  * Thrown when a typed-data signature does not recover to the expected signer.
  *
@@ -247,8 +338,8 @@ exports.InvalidTreeError = InvalidTreeError;
 class InvalidTypedDataSignatureError extends Error {
     /** Signer address the signature was expected to recover. */
     signer;
-    constructor(signer) {
-        super(`Typed-data signature does not recover to signer "${signer}". Check the wallet account or signing transport.`);
+    constructor(signer, cause) {
+        super(`Typed-data signature does not recover to signer "${signer}". Check the wallet account or signing transport.`, cause === undefined ? undefined : { cause });
         this.name = "InvalidTypedDataSignatureError";
         this.signer = signer;
     }

package/lib/cjs/fetch/Market.js

@@ -96,7 +96,6 @@ async function fetchMarket(client, params) {
     ]);
     const [totalUnits, lossFactor, withdrawable, continuousFeeCredit, settlementFeeCbps0, settlementFeeCbps1, settlementFeeCbps2, settlementFeeCbps3, settlementFeeCbps4, settlementFeeCbps5, settlementFeeCbps6, continuousFee, tickSpacing,] = state;
     return new index_js_1.Market({
-        chainId,
         params: new index_js_1.MarketParams(market),
         totalUnits,
         lossFactor,

package/lib/cjs/fetch/index.d.ts

@@ -1,5 +1,4 @@
 export * from "./Market.js";
-export * from "./Offer.js";
 export * from "./Position.js";
 export * from "./Ratifier.js";
 export * from "./types.js";

package/lib/cjs/fetch/index.js

@@ -15,7 +15,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./Market.js"), exports);
-__exportStar(require("./Offer.js"), exports);
 __exportStar(require("./Position.js"), exports);
 __exportStar(require("./Ratifier.js"), exports);
 __exportStar(require("./types.js"), exports);

package/lib/cjs/index.d.ts

@@ -15,4 +15,4 @@ export * from "./signatures/index.js";
  * Encoded payloads are always `Hex` strings ready to be included in onchain
  * mempool submission calldata.
  */
-export * as Payload from "./signatures/Payload.js";
+export { Payload } from "./signatures/Payload.js";

package/lib/cjs/index.js

@@ -10,31 +10,9 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Payload = void 0;
 __exportStar(require("./abis.js"), exports);
@@ -54,4 +32,5 @@ __exportStar(require("./signatures/index.js"), exports);
  * Encoded payloads are always `Hex` strings ready to be included in onchain
  * mempool submission calldata.
  */
-exports.Payload = __importStar(require("./signatures/Payload.js"));
+var Payload_js_1 = require("./signatures/Payload.js");
+Object.defineProperty(exports, "Payload", { enumerable: true, get: function () { return Payload_js_1.Payload; } });

package/lib/cjs/market/Market.d.ts

@@ -30,7 +30,7 @@ export type SettlementFeeCbps = readonly [
  * const params: ICollateralParams = {
  *   token: "0x0000000000000000000000000000000000000001",
  *   lltv: 770000000000000000n,
- *   maxLif: 1061007957559681697n,
+ *   liquidationCursor: 250000000000000000n,
  *   oracle: "0x0000000000000000000000000000000000000002",
  * };
  * ```
@@ -40,8 +40,8 @@ export interface ICollateralParams {
     readonly token: Address;
     /** WAD-scaled liquidation loan-to-value. */
     readonly lltv: BigIntish;
-    /** WAD-scaled maximum liquidation incentive factor. */
-    readonly maxLif: BigIntish;
+    /** WAD-scaled liquidation cursor used to compute the maximum liquidation incentive factor. */
+    readonly liquidationCursor: BigIntish;
     /** Oracle address for this collateral. */
     readonly oracle: Address;
 }
@@ -55,7 +55,7 @@ export interface ICollateralParams {
  * const params: CollateralParams = {
  *   token: "0x0000000000000000000000000000000000000001",
  *   lltv: 770000000000000000n,
- *   maxLif: 1298701298701298701n,
+ *   liquidationCursor: 250000000000000000n,
  *   oracle: "0x0000000000000000000000000000000000000002",
  * };
  * console.log(params.lltv);
@@ -66,8 +66,8 @@ export interface CollateralParams {
     readonly token: Address;
     /** WAD-scaled liquidation loan-to-value. */
     readonly lltv: bigint;
-    /** WAD-scaled maximum liquidation incentive factor. */
-    readonly maxLif: bigint;
+    /** WAD-scaled liquidation cursor used to compute the maximum liquidation incentive factor. */
+    readonly liquidationCursor: bigint;
     /** Oracle address for this collateral. */
     readonly oracle: Address;
 }
@@ -79,12 +79,14 @@ export interface CollateralParams {
  * import type { IMarketParams } from "@morpho-org/midnight-sdk";
  *
  * const params: IMarketParams = {
+ *   chainId: 8453,
+ *   midnight: "0x0000000000000000000000000000000000001000",
  *   loanToken: "0x0000000000000000000000000000000000000001",
  *   collateralParams: [
  *     {
  *       token: "0x0000000000000000000000000000000000000002",
  *       lltv: 770000000000000000n,
- *       maxLif: 1061007957559681697n,
+ *       liquidationCursor: 250000000000000000n,
  *       oracle: "0x0000000000000000000000000000000000000003",
  *     },
  *   ],
@@ -96,6 +98,10 @@ export interface CollateralParams {
  * ```
  */
 export interface IMarketParams {
+    /** EIP-155 chain id captured in the market struct. */
+    readonly chainId: BigIntish;
+    /** Core Midnight contract address captured in the market struct. */
+    readonly midnight: Address;
     /** Loan token address. */
     readonly loanToken: Address;
     /** Collateral definitions; `MarketParams` stores them sorted by token and rejects duplicate tokens. */
@@ -117,12 +123,14 @@ export interface IMarketParams {
  * 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",
  *     },
  *   ],
@@ -135,6 +143,10 @@ export interface IMarketParams {
  * ```
  */
 export declare class MarketParams {
+    /** EIP-155 chain id captured in the market struct. */
+    readonly chainId: bigint;
+    /** Core Midnight contract address captured in the market struct. */
+    readonly midnight: Address;
     /** Loan token address. */
     readonly loanToken: Address;
     /** Collateral definitions sorted by token. */
@@ -151,7 +163,7 @@ export declare 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: IMarketParams);
     /**
@@ -167,12 +179,14 @@ export declare 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",
      *     },
      *   ],
@@ -194,14 +208,15 @@ export declare class MarketParams {
  * import type { IMarket } from "@morpho-org/midnight-sdk";
  *
  * const market: IMarket = {
- *   chainId: 31337,
  *   params: {
+ *     chainId: 31337,
+ *     midnight: "0x0000000000000000000000000000000000001000",
  *     loanToken: "0x0000000000000000000000000000000000000001",
  *     collateralParams: [
  *       {
  *         token: "0x0000000000000000000000000000000000000002",
  *         lltv: 770000000000000000n,
- *         maxLif: 1061007957559681697n,
+ *         liquidationCursor: 250000000000000000n,
  *         oracle: "0x0000000000000000000000000000000000000003",
  *       },
  *     ],
@@ -221,8 +236,6 @@ export declare class MarketParams {
  * ```
  */
 export interface IMarket {
-    /** EIP-155 chain id used to derive the market id. */
-    readonly chainId: BigIntish;
     /** Immutable market configuration. */
     readonly params: IMarketParams;
     /** Total market units. */
@@ -248,12 +261,14 @@ export interface IMarket {
  * import type { MarketInput } from "@morpho-org/midnight-sdk";
  *
  * const market: MarketInput = {
+ *   chainId: 8453,
+ *   midnight: "0x0000000000000000000000000000000000001000",
  *   loanToken: "0x0000000000000000000000000000000000006000",
  *   collateralParams: [
  *     {
  *       token: "0x0000000000000000000000000000000000007000",
  *       lltv: 770000000000000000n,
- *       maxLif: 1061007957559681697n,
+ *       liquidationCursor: 250000000000000000n,
  *       oracle: "0x0000000000000000000000000000000000008000",
  *     },
  *   ],
@@ -289,14 +304,15 @@ export type MarketInput = IMarketParams | IMarket;
  * });
  *
  * 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,7 +335,7 @@ export type MarketInput = IMarketParams | IMarket;
 export declare class Market {
     /** Market id. */
     readonly id: Hash;
-    /** EIP-155 chain id used to derive the market id. */
+    /** EIP-155 chain id captured in the market struct. */
     readonly chainId: bigint;
     /** Immutable market configuration. */
     readonly params: MarketParams;
@@ -338,6 +354,50 @@ export declare class Market {
     /** Market tick spacing. */
     readonly tickSpacing: number;
     constructor(market: IMarket);
+    /**
+     * 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: IMarket | Market): Market;
     /**
      * Returns the non-negative time remaining before maturity.
      *
@@ -364,14 +424,15 @@ export declare 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",
      *       },
      *     ],
@@ -418,14 +479,15 @@ export declare 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",
      *       },
      *     ],
@@ -447,10 +509,11 @@ export declare class Market {
      */
     getSettlementFee(timeToMaturity: BigIntish): bigint;
     /**
-     * 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";
@@ -471,14 +534,15 @@ export declare 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",
      *       },
      *     ],
@@ -495,11 +559,11 @@ export declare 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: BigIntish): CollateralParams | undefined;
+    getCollateralByIndex(index: BigIntish): CollateralParams;
     /**
      * Returns the configured collateral index for a token.
      *
@@ -526,14 +590,15 @@ export declare 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",
      *       },
      *     ],
@@ -581,14 +646,15 @@ export declare 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",
      *       },
      *     ],