@morpho-org/midnight-sdk 0.1.0 → 1.1.1

package/lib/esm/constants.js

@@ -1,3 +1,4 @@
+import { maxUint128 } from "viem";
 /**
  * Centibip scale used by settlement fees.
  *
@@ -117,27 +118,28 @@ export const MAX_SETTLEMENT_FEES = [
  */
 export const 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);
  * ```
  */
-export const LIQUIDATION_CURSOR_LOW = 250000000000000000n;
+export const MAX_OFFER_CAP = 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);
  * ```
  */
-export const LIQUIDATION_CURSOR_HIGH = 500000000000000000n;
+export const TIME_TO_MAX_LIF = 60n * 60n;
 /**
  * HashLib collateral params typehash.
  *
@@ -148,7 +150,7 @@ export const LIQUIDATION_CURSOR_HIGH = 500000000000000000n;
  * console.log(COLLATERAL_PARAMS_TYPEHASH);
  * ```
  */
-export const COLLATERAL_PARAMS_TYPEHASH = "0xaf44a88eb50ebdbbebd980e5a23045c44f61ece5f80ab708a1bbe8718102e6af";
+export const COLLATERAL_PARAMS_TYPEHASH = "0x39ed3f928d24fd00574b1a02aba9c2483abcf5d9a3a366118c9a5aa29885b841";
 /**
  * HashLib market typehash.
  *
@@ -159,7 +161,7 @@ export const COLLATERAL_PARAMS_TYPEHASH = "0xaf44a88eb50ebdbbebd980e5a23045c44f6
  * console.log(MARKET_TYPEHASH);
  * ```
  */
-export const MARKET_TYPEHASH = "0x358117e98511cc3df97175dca58053b06675b43ad090b0553f8a1eff008b6e2e";
+export const MARKET_TYPEHASH = "0x510b3862f3816a109c9340b76972e8a30984246be06e034ae12ed2934220391a";
 /**
  * HashLib offer typehash.
  *
@@ -170,7 +172,7 @@ export const MARKET_TYPEHASH = "0x358117e98511cc3df97175dca58053b06675b43ad090b0
  * console.log(OFFER_TYPEHASH);
  * ```
  */
-export const OFFER_TYPEHASH = "0x6bd2a06ec6952feb97c3e3b4f7de6c342f12b1ac769d5c91368271af636c85b7";
+export const OFFER_TYPEHASH = "0x9905214264a9fb7b6cc1b0e33db7a04687c6e4185a84755d29914314aa9d8906";
 /**
  * EcrecoverRatifier EIP-712 domain typehash.
  *

package/lib/esm/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/esm/errors.js

@@ -159,6 +159,33 @@ export class InvalidMarketParameterError extends Error {
         this.value = params.value;
     }
 }
+/**
+ * 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 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;
+    }
+}
 /**
  * Thrown when an offer builder receives a parameter that cannot satisfy Midnight protocol rules.
  *
@@ -185,6 +212,25 @@ export class InvalidOfferParameterError extends Error {
         this.value = params.value;
     }
 }
+/**
+ * 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 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;
+    }
+}
 /**
  * Thrown when a tree height exceeds the ratifier typehash table.
  *
@@ -217,6 +263,47 @@ export class InvalidTreeError extends Error {
         this.name = "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);
+ * ```
+ */
+export 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;
+    }
+}
+/**
+ * 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 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;
+    }
+}
 /**
  * Thrown when a typed-data signature does not recover to the expected signer.
  *
@@ -232,12 +319,31 @@ export class InvalidTreeError extends Error {
 export 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;
     }
 }
+/**
+ * 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 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;
+    }
+}
 /**
  * Thrown when the Midnight API returns a non-2xx response.
  *

package/lib/esm/fetch/Market.js

@@ -1,7 +1,8 @@
 import { getChainAddress } from "@morpho-org/morpho-ts";
 import { readContract } from "viem/actions";
 import { midnightAbi } from "../abis.js";
-import { Market, MarketParams } from "../market/index.js";
+import { InvalidMarketParameterError } from "../errors.js";
+import { Market, MarketParams, MarketUtils } from "../market/index.js";
 import { callParameters, resolveChainId } from "./utils.js";
 /**
  * Fetches immutable market params by id.
@@ -41,7 +42,11 @@ export async function fetchMarketParams(client, params) {
         functionName: "toMarket",
         args: [params.marketId],
     });
-    return new MarketParams(market);
+    return normalizeFetchedMarketParams(market, {
+        marketId: params.marketId,
+        chainId,
+        midnight,
+    });
 }
 /**
  * Fetches a hydrated market by id.
@@ -92,8 +97,11 @@ export async function fetchMarket(client, params) {
     ]);
     const [totalUnits, lossFactor, withdrawable, continuousFeeCredit, settlementFeeCbps0, settlementFeeCbps1, settlementFeeCbps2, settlementFeeCbps3, settlementFeeCbps4, settlementFeeCbps5, settlementFeeCbps6, continuousFee, tickSpacing,] = state;
     return new Market({
-        chainId,
-        params: new MarketParams(market),
+        params: normalizeFetchedMarketParams(market, {
+            marketId: params.marketId,
+            chainId,
+            midnight,
+        }),
         totalUnits,
         lossFactor,
         withdrawable,
@@ -111,3 +119,29 @@ export async function fetchMarket(client, params) {
         tickSpacing,
     });
 }
+function normalizeFetchedMarketParams(market, expected) {
+    const marketParams = new MarketParams(market);
+    if (marketParams.chainId !== BigInt(expected.chainId)) {
+        throw new 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 InvalidMarketParameterError({
+            parameter: "midnight",
+            value: marketParams.midnight,
+            instruction: `Fetched market must use Midnight contract "${expected.midnight}".`,
+        });
+    }
+    const actualMarketId = MarketUtils.toId(marketParams);
+    if (actualMarketId.toLowerCase() !== expected.marketId.toLowerCase()) {
+        throw new InvalidMarketParameterError({
+            parameter: "marketId",
+            value: actualMarketId,
+            instruction: `Fetched market must match requested market id "${expected.marketId}".`,
+        });
+    }
+    return marketParams;
+}

package/lib/esm/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/esm/fetch/index.js

@@ -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/esm/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/esm/fetch/utils.js

@@ -1,4 +1,5 @@
 import { getChainId } from "viem/actions";
+import { ChainIdMismatchError } from "../errors.js";
 /** @internal Extracts viem call parameters from Midnight fetch inputs. */
 export const callParameters = (params) => ({
     account: params.account,
@@ -8,5 +9,11 @@ export const callParameters = (params) => ({
 });
 /** @internal Returns the configured deployless mode, defaulting to enabled. */
 export const shouldUseDeployless = (params) => params.deployless ?? true;
-/** @internal Returns the configured viem client chain id or fetches it from RPC. */
-export const resolveChainId = async (client) => client.chain?.id ?? (await getChainId(client));
+/** @internal Returns the RPC chain id and rejects configured-chain drift. */
+export const resolveChainId = async (client) => {
+    const rpcChainId = await getChainId(client);
+    if (client.chain?.id != null && client.chain.id !== rpcChainId) {
+        throw new ChainIdMismatchError(client.chain.id, BigInt(rpcChainId));
+    }
+    return rpcChainId;
+};

package/lib/esm/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/esm/index.js

@@ -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";