@morpho-org/midnight-sdk 0.1.0 → 1.1.1

package/lib/cjs/constants.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EIP712_DOMAIN_TYPEHASH = exports.OFFER_TYPEHASH = exports.MARKET_TYPEHASH = exports.COLLATERAL_PARAMS_TYPEHASH = exports.LIQUIDATION_CURSOR_HIGH = exports.LIQUIDATION_CURSOR_LOW = exports.MAX_CONTINUOUS_FEE = exports.MAX_SETTLEMENT_FEES = exports.MAX_COLLATERALS_PER_BORROWER = exports.MAX_COLLATERALS = exports.DEFAULT_TICK_SPACING = exports.PRICE_ROUNDING_STEP = exports.MAX_TICK = exports.SETTLEMENT_FEE_BREAKPOINTS = exports.CBP = void 0;
+exports.EIP712_DOMAIN_TYPEHASH = exports.OFFER_TYPEHASH = exports.MARKET_TYPEHASH = exports.COLLATERAL_PARAMS_TYPEHASH = exports.TIME_TO_MAX_LIF = exports.MAX_OFFER_CAP = exports.MAX_CONTINUOUS_FEE = exports.MAX_SETTLEMENT_FEES = exports.MAX_COLLATERALS_PER_BORROWER = exports.MAX_COLLATERALS = exports.DEFAULT_TICK_SPACING = exports.PRICE_ROUNDING_STEP = exports.MAX_TICK = exports.SETTLEMENT_FEE_BREAKPOINTS = exports.CBP = void 0;
+const viem_1 = require("viem");
 /**
  * Centibip scale used by settlement fees.
  *
@@ -120,27 +121,28 @@ exports.MAX_SETTLEMENT_FEES = [
  */
 exports.MAX_CONTINUOUS_FEE = 317097919n;
 /**
- * Low liquidation cursor used by liquidation incentive factor helpers.
+ * Maximum value accepted by the uint128 offer cap fields.
  *
  * @example
  * ```ts
- * import { LIQUIDATION_CURSOR_LOW } from "@morpho-org/midnight-sdk";
+ * import { MAX_OFFER_CAP } from "@morpho-org/midnight-sdk";
  *
- * console.log(LIQUIDATION_CURSOR_LOW);
+ * console.log(MAX_OFFER_CAP);
  * ```
  */
-exports.LIQUIDATION_CURSOR_LOW = 250000000000000000n;
+exports.MAX_OFFER_CAP = viem_1.maxUint128;
 /**
- * High liquidation cursor from Midnight ConstantsLib.
+ * Seconds after maturity over which post-maturity LIF reaches the computed
+ * maximum liquidation incentive factor.
  *
  * @example
  * ```ts
- * import { LIQUIDATION_CURSOR_HIGH } from "@morpho-org/midnight-sdk";
+ * import { TIME_TO_MAX_LIF } from "@morpho-org/midnight-sdk";
  *
- * console.log(LIQUIDATION_CURSOR_HIGH);
+ * console.log(TIME_TO_MAX_LIF);
  * ```
  */
-exports.LIQUIDATION_CURSOR_HIGH = 500000000000000000n;
+exports.TIME_TO_MAX_LIF = 60n * 60n;
 /**
  * HashLib collateral params typehash.
  *
@@ -151,7 +153,7 @@ exports.LIQUIDATION_CURSOR_HIGH = 500000000000000000n;
  * console.log(COLLATERAL_PARAMS_TYPEHASH);
  * ```
  */
-exports.COLLATERAL_PARAMS_TYPEHASH = "0xaf44a88eb50ebdbbebd980e5a23045c44f61ece5f80ab708a1bbe8718102e6af";
+exports.COLLATERAL_PARAMS_TYPEHASH = "0x39ed3f928d24fd00574b1a02aba9c2483abcf5d9a3a366118c9a5aa29885b841";
 /**
  * HashLib market typehash.
  *
@@ -162,7 +164,7 @@ exports.COLLATERAL_PARAMS_TYPEHASH = "0xaf44a88eb50ebdbbebd980e5a23045c44f61ece5
  * console.log(MARKET_TYPEHASH);
  * ```
  */
-exports.MARKET_TYPEHASH = "0x358117e98511cc3df97175dca58053b06675b43ad090b0553f8a1eff008b6e2e";
+exports.MARKET_TYPEHASH = "0x510b3862f3816a109c9340b76972e8a30984246be06e034ae12ed2934220391a";
 /**
  * HashLib offer typehash.
  *
@@ -173,7 +175,7 @@ exports.MARKET_TYPEHASH = "0x358117e98511cc3df97175dca58053b06675b43ad090b0553f8
  * console.log(OFFER_TYPEHASH);
  * ```
  */
-exports.OFFER_TYPEHASH = "0x6bd2a06ec6952feb97c3e3b4f7de6c342f12b1ac769d5c91368271af636c85b7";
+exports.OFFER_TYPEHASH = "0x9905214264a9fb7b6cc1b0e33db7a04687c6e4185a84755d29914314aa9d8906";
 /**
  * EcrecoverRatifier EIP-712 domain typehash.
  *

package/lib/cjs/errors.d.ts

@@ -1,4 +1,5 @@
 import type { Address } from "viem";
+import type { MempoolPayloadValidationIssue } from "./api/types.js";
 /**
  * Thrown when a Midnight offer group violates protocol-level group mechanics.
  *
@@ -135,6 +136,31 @@ export declare class InvalidMarketParameterError extends Error {
         readonly cause?: unknown;
     });
 }
+/**
+ * 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.
+ */
+export declare class UnknownCollateralIndexError extends Error {
+    /** Market id whose collateral list was queried. */
+    readonly market: string;
+    /** Missing collateral index. */
+    readonly collateralIndex: bigint;
+    constructor(params: {
+        readonly market: string;
+        readonly collateralIndex: bigint;
+    });
+}
 /**
  * Thrown when an offer builder receives a parameter that cannot satisfy Midnight protocol rules.
  *
@@ -161,6 +187,21 @@ export declare class InvalidOfferParameterError extends Error {
         readonly cause?: unknown;
     });
 }
+/**
+ * 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");
+ * ```
+ */
+export declare class PayloadDecodeError extends Error {
+    /** Machine-readable decode failure reason without the class message prefix. */
+    readonly reason: string;
+    constructor(reason: string, cause?: Error);
+}
 /**
  * Thrown when a tree height exceeds the ratifier typehash table.
  *
@@ -187,6 +228,38 @@ export declare class InvalidTreeHeightError extends Error {
 export declare class InvalidTreeError extends Error {
     constructor(message: string);
 }
+/**
+ * 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);
+ * ```
+ */
+export declare class ChainIdMismatchError extends Error {
+    /** Chain id reported by the viem client, when configured. */
+    readonly clientChainId: number | undefined;
+    /** Chain id required by the data being signed. */
+    readonly expectedChainId: bigint;
+    constructor(clientChainId: number | undefined, expectedChainId: bigint);
+}
+/**
+ * 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" }]);
+ * ```
+ */
+export declare class MidnightMempoolValidationError extends Error {
+    /** Validation issues returned by the Midnight API. */
+    readonly issues: readonly MempoolPayloadValidationIssue[];
+    constructor(issues: readonly MempoolPayloadValidationIssue[]);
+}
 /**
  * Thrown when a typed-data signature does not recover to the expected signer.
  *
@@ -202,7 +275,22 @@ export declare class InvalidTreeError extends Error {
 export declare class InvalidTypedDataSignatureError extends Error {
     /** Signer address the signature was expected to recover. */
     readonly signer: Address;
-    constructor(signer: Address);
+    constructor(signer: Address, cause?: unknown);
+}
+/**
+ * Thrown when decoded Ecrecover ratifier data contains a non-canonical signature `v` value.
+ *
+ * @example
+ * ```ts
+ * import { InvalidEcrecoverSignatureVError } from "@morpho-org/midnight-sdk";
+ *
+ * throw new InvalidEcrecoverSignatureVError(29);
+ * ```
+ */
+export declare class InvalidEcrecoverSignatureVError extends Error {
+    /** Invalid ECDSA recovery id. */
+    readonly v: number;
+    constructor(v: number);
 }
 /**
  * Thrown when the Midnight API returns a non-2xx response.

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.InvalidEcrecoverSignatureVError = 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,13 +338,33 @@ 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;
     }
 }
 exports.InvalidTypedDataSignatureError = InvalidTypedDataSignatureError;
+/**
+ * Thrown when decoded Ecrecover ratifier data contains a non-canonical signature `v` value.
+ *
+ * @example
+ * ```ts
+ * import { InvalidEcrecoverSignatureVError } from "@morpho-org/midnight-sdk";
+ *
+ * throw new InvalidEcrecoverSignatureVError(29);
+ * ```
+ */
+class InvalidEcrecoverSignatureVError extends Error {
+    /** Invalid ECDSA recovery id. */
+    v;
+    constructor(v) {
+        super(`Ecrecover signature v "${v}" is invalid. Use canonical Ethereum v 27 or 28.`);
+        this.name = "InvalidEcrecoverSignatureVError";
+        this.v = v;
+    }
+}
+exports.InvalidEcrecoverSignatureVError = InvalidEcrecoverSignatureVError;
 /**
  * Thrown when the Midnight API returns a non-2xx response.
  *

package/lib/cjs/fetch/Market.js

@@ -5,6 +5,7 @@ exports.fetchMarket = fetchMarket;
 const morpho_ts_1 = require("@morpho-org/morpho-ts");
 const actions_1 = require("viem/actions");
 const abis_js_1 = require("../abis.js");
+const errors_js_1 = require("../errors.js");
 const index_js_1 = require("../market/index.js");
 const utils_js_1 = require("./utils.js");
 /**
@@ -45,7 +46,11 @@ async function fetchMarketParams(client, params) {
         functionName: "toMarket",
         args: [params.marketId],
     });
-    return new index_js_1.MarketParams(market);
+    return normalizeFetchedMarketParams(market, {
+        marketId: params.marketId,
+        chainId,
+        midnight,
+    });
 }
 /**
  * Fetches a hydrated market by id.
@@ -96,8 +101,11 @@ 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),
+        params: normalizeFetchedMarketParams(market, {
+            marketId: params.marketId,
+            chainId,
+            midnight,
+        }),
         totalUnits,
         lossFactor,
         withdrawable,
@@ -115,3 +123,29 @@ async function fetchMarket(client, params) {
         tickSpacing,
     });
 }
+function normalizeFetchedMarketParams(market, expected) {
+    const marketParams = new index_js_1.MarketParams(market);
+    if (marketParams.chainId !== BigInt(expected.chainId)) {
+        throw new errors_js_1.InvalidMarketParameterError({
+            parameter: "chainId",
+            value: marketParams.chainId,
+            instruction: `Fetched market must use client chain id "${expected.chainId}".`,
+        });
+    }
+    if (marketParams.midnight.toLowerCase() !== expected.midnight.toLowerCase()) {
+        throw new errors_js_1.InvalidMarketParameterError({
+            parameter: "midnight",
+            value: marketParams.midnight,
+            instruction: `Fetched market must use Midnight contract "${expected.midnight}".`,
+        });
+    }
+    const actualMarketId = index_js_1.MarketUtils.toId(marketParams);
+    if (actualMarketId.toLowerCase() !== expected.marketId.toLowerCase()) {
+        throw new errors_js_1.InvalidMarketParameterError({
+            parameter: "marketId",
+            value: actualMarketId,
+            instruction: `Fetched market must match requested market id "${expected.marketId}".`,
+        });
+    }
+    return marketParams;
+}

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/fetch/utils.d.ts

@@ -4,5 +4,5 @@ import type { DeploylessFetchParameters, MidnightCallParameters } from "./types.
 export declare const callParameters: (params: MidnightCallParameters) => MidnightCallParameters;
 /** @internal Returns the configured deployless mode, defaulting to enabled. */
 export declare const shouldUseDeployless: (params: DeploylessFetchParameters) => boolean | "force";
-/** @internal Returns the configured viem client chain id or fetches it from RPC. */
+/** @internal Returns the RPC chain id and rejects configured-chain drift. */
 export declare const resolveChainId: (client: Client) => Promise<number>;

package/lib/cjs/fetch/utils.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.resolveChainId = exports.shouldUseDeployless = exports.callParameters = void 0;
 const actions_1 = require("viem/actions");
+const errors_js_1 = require("../errors.js");
 /** @internal Extracts viem call parameters from Midnight fetch inputs. */
 const callParameters = (params) => ({
     account: params.account,
@@ -13,6 +14,12 @@ exports.callParameters = callParameters;
 /** @internal Returns the configured deployless mode, defaulting to enabled. */
 const shouldUseDeployless = (params) => params.deployless ?? true;
 exports.shouldUseDeployless = shouldUseDeployless;
-/** @internal Returns the configured viem client chain id or fetches it from RPC. */
-const resolveChainId = async (client) => client.chain?.id ?? (await (0, actions_1.getChainId)(client));
+/** @internal Returns the RPC chain id and rejects configured-chain drift. */
+const resolveChainId = async (client) => {
+    const rpcChainId = await (0, actions_1.getChainId)(client);
+    if (client.chain?.id != null && client.chain.id !== rpcChainId) {
+        throw new errors_js_1.ChainIdMismatchError(client.chain.id, BigInt(rpcChainId));
+    }
+    return rpcChainId;
+};
 exports.resolveChainId = resolveChainId;

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; } });