@morpho-org/midnight-sdk 1.8.0 → 2.1.0-next.0

package/lib/esm/api/MidnightApi.d.ts

@@ -142,7 +142,7 @@ export declare class MidnightApi {
      * @param params.request - Optional fetch options forwarded to this request.
      * @returns ABI-ready take objects mapped from the API response.
      * @throws {MidnightApiError} when the API returns a non-2xx response.
-     * @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, or when its caps or buy-side receiver are not executable.
+     * @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, when its caps or buy-side receiver are not executable, or when its units exceed its offer `maxUnits`.
      * @example
      * ```ts
      * import { MidnightApi } from "@morpho-org/midnight-sdk/api";
@@ -170,11 +170,12 @@ export declare class MidnightApi {
      * @param params.baseUrl - Optional Midnight API base URL override.
      * @param params.fetch - Optional fetch implementation override.
      * @param params.request - Optional fetch options forwarded to this request.
-     * @returns Quote and signed ABI-ready take caps mapped from the API response.
+     * @returns Quote and ABI-ready take caps. `averageWorstPrice` equals the caller's guard when provided,
+     *   otherwise the API's guard.
      * @throws {InvalidMidnightApiQuoteTargetError} when the runtime input does not set exactly one of `units` or `assets`.
      * @throws {NegativeValueError} when `settlementFee` is negative.
      * @throws {MidnightApiError} when the API returns a non-2xx response.
-     * @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, when its caps or buy-side receiver are not executable, or when the returned offers imply a rounded aggregate settlement price outside the effective average-worst-price guard.
+     * @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, when its caps or buy-side receiver are not executable, when its units exceed its offer `maxUnits`, or when the returned offers imply a rounded aggregate settlement price outside the effective average-worst-price guard.
      * @throws {SettlementFeeExceedsPriceError} when a bid's settlement fee exceeds its offer price.
      * @example
      * ```ts
@@ -205,7 +206,7 @@ export declare class MidnightApi {
      * @param params.request - Optional fetch options forwarded to this request.
      * @returns Paginated ABI-ready take objects mapped from the API response.
      * @throws {MidnightApiError} when the API returns a non-2xx response.
-     * @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, or when its caps or buy-side receiver are not executable.
+     * @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, when its caps or buy-side receiver are not executable, or when its units exceed its offer `maxUnits`.
      * @example
      * ```ts
      * import { MidnightApi } from "@morpho-org/midnight-sdk/api";
@@ -390,7 +391,7 @@ export declare class MidnightApi {
      * @param params.side - Book side to query.
      * @returns ABI-ready take objects mapped from the API response.
      * @throws {MidnightApiError} when the API returns a non-2xx response.
-     * @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, or when its caps or buy-side receiver are not executable.
+     * @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, when its caps or buy-side receiver are not executable, or when its units exceed its offer `maxUnits`.
      * @example
      * ```ts
      * import { MidnightApi } from "@morpho-org/midnight-sdk/api";
@@ -416,11 +417,12 @@ export declare class MidnightApi {
      * @param params.averageWorstPrice - Optional WAD-scaled average worst price guard. Mutually exclusive with `params.slippage`.
      * @param params.slippage - Optional slippage percentage used to derive the guard. Mutually exclusive with `params.averageWorstPrice`.
      * @param params.settlementFee - Optional current WAD-scaled settlement fee used for local guard validation. Defaults to zero.
-     * @returns Quote and signed ABI-ready take caps mapped from the API response.
+     * @returns Quote and ABI-ready take caps. `averageWorstPrice` equals the caller's guard when provided,
+     *   otherwise the API's guard.
      * @throws {InvalidMidnightApiQuoteTargetError} when the runtime input does not set exactly one of `units` or `assets`.
      * @throws {NegativeValueError} when `settlementFee` is negative.
      * @throws {MidnightApiError} when the API returns a non-2xx response.
-     * @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, when its caps or buy-side receiver are not executable, or when the returned offers imply a rounded aggregate settlement price outside the effective average-worst-price guard.
+     * @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, when its caps or buy-side receiver are not executable, when its units exceed its offer `maxUnits`, or when the returned offers imply a rounded aggregate settlement price outside the effective average-worst-price guard.
      * @throws {SettlementFeeExceedsPriceError} when a bid's settlement fee exceeds its offer price.
      * @example
      * ```ts
@@ -448,7 +450,7 @@ export declare class MidnightApi {
      * @param params.cursor - Optional opaque pagination cursor from a previous response.
      * @returns Paginated ABI-ready take objects mapped from the API response.
      * @throws {MidnightApiError} when the API returns a non-2xx response.
-     * @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, or when its caps or buy-side receiver are not executable.
+     * @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, when its caps or buy-side receiver are not executable, or when its units exceed its offer `maxUnits`.
      * @example
      * ```ts
      * import { MidnightApi } from "@morpho-org/midnight-sdk/api";

package/lib/esm/api/MidnightApi.js

@@ -203,7 +203,7 @@ export class MidnightApi {
      * @param params.request - Optional fetch options forwarded to this request.
      * @returns ABI-ready take objects mapped from the API response.
      * @throws {MidnightApiError} when the API returns a non-2xx response.
-     * @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, or when its caps or buy-side receiver are not executable.
+     * @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, when its caps or buy-side receiver are not executable, or when its units exceed its offer `maxUnits`.
      * @example
      * ```ts
      * import { MidnightApi } from "@morpho-org/midnight-sdk/api";
@@ -248,11 +248,12 @@ export class MidnightApi {
      * @param params.baseUrl - Optional Midnight API base URL override.
      * @param params.fetch - Optional fetch implementation override.
      * @param params.request - Optional fetch options forwarded to this request.
-     * @returns Quote and signed ABI-ready take caps mapped from the API response.
+     * @returns Quote and ABI-ready take caps. `averageWorstPrice` equals the caller's guard when provided,
+     *   otherwise the API's guard.
      * @throws {InvalidMidnightApiQuoteTargetError} when the runtime input does not set exactly one of `units` or `assets`.
      * @throws {NegativeValueError} when `settlementFee` is negative.
      * @throws {MidnightApiError} when the API returns a non-2xx response.
-     * @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, when its caps or buy-side receiver are not executable, or when the returned offers imply a rounded aggregate settlement price outside the effective average-worst-price guard.
+     * @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, when its caps or buy-side receiver are not executable, when its units exceed its offer `maxUnits`, or when the returned offers imply a rounded aggregate settlement price outside the effective average-worst-price guard.
      * @throws {SettlementFeeExceedsPriceError} when a bid's settlement fee exceeds its offer price.
      * @example
      * ```ts
@@ -297,8 +298,8 @@ export class MidnightApi {
             : "slippage" in input && input.slippage != null
                 ? response.data.average_worst_price
                 : undefined;
-        if (averageWorstPrice != null) {
-            const guard = BigInt(averageWorstPrice);
+        const guard = averageWorstPrice == null ? undefined : BigInt(averageWorstPrice);
+        if (guard != null) {
             let filledUnits = 0n;
             let filledAssets = 0n;
             if ("units" in input && input.units != null) {
@@ -355,7 +356,7 @@ export class MidnightApi {
         return {
             data: {
                 averageBestPrice: response.data.average_best_price,
-                averageWorstPrice: response.data.average_worst_price,
+                averageWorstPrice: guard?.toString() ?? response.data.average_worst_price,
                 availableAssets: response.data.available_assets,
                 availableUnits: response.data.available_units,
                 takeableOffers,
@@ -377,7 +378,7 @@ export class MidnightApi {
      * @param params.request - Optional fetch options forwarded to this request.
      * @returns Paginated ABI-ready take objects mapped from the API response.
      * @throws {MidnightApiError} when the API returns a non-2xx response.
-     * @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, or when its caps or buy-side receiver are not executable.
+     * @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, when its caps or buy-side receiver are not executable, or when its units exceed its offer `maxUnits`.
      * @example
      * ```ts
      * import { MidnightApi } from "@morpho-org/midnight-sdk/api";
@@ -625,7 +626,7 @@ export class MidnightApi {
      * @param params.side - Book side to query.
      * @returns ABI-ready take objects mapped from the API response.
      * @throws {MidnightApiError} when the API returns a non-2xx response.
-     * @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, or when its caps or buy-side receiver are not executable.
+     * @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, when its caps or buy-side receiver are not executable, or when its units exceed its offer `maxUnits`.
      * @example
      * ```ts
      * import { MidnightApi } from "@morpho-org/midnight-sdk/api";
@@ -656,11 +657,12 @@ export class MidnightApi {
      * @param params.averageWorstPrice - Optional WAD-scaled average worst price guard. Mutually exclusive with `params.slippage`.
      * @param params.slippage - Optional slippage percentage used to derive the guard. Mutually exclusive with `params.averageWorstPrice`.
      * @param params.settlementFee - Optional current WAD-scaled settlement fee used for local guard validation. Defaults to zero.
-     * @returns Quote and signed ABI-ready take caps mapped from the API response.
+     * @returns Quote and ABI-ready take caps. `averageWorstPrice` equals the caller's guard when provided,
+     *   otherwise the API's guard.
      * @throws {InvalidMidnightApiQuoteTargetError} when the runtime input does not set exactly one of `units` or `assets`.
      * @throws {NegativeValueError} when `settlementFee` is negative.
      * @throws {MidnightApiError} when the API returns a non-2xx response.
-     * @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, when its caps or buy-side receiver are not executable, or when the returned offers imply a rounded aggregate settlement price outside the effective average-worst-price guard.
+     * @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, when its caps or buy-side receiver are not executable, when its units exceed its offer `maxUnits`, or when the returned offers imply a rounded aggregate settlement price outside the effective average-worst-price guard.
      * @throws {SettlementFeeExceedsPriceError} when a bid's settlement fee exceeds its offer price.
      * @example
      * ```ts
@@ -693,7 +695,7 @@ export class MidnightApi {
      * @param params.cursor - Optional opaque pagination cursor from a previous response.
      * @returns Paginated ABI-ready take objects mapped from the API response.
      * @throws {MidnightApiError} when the API returns a non-2xx response.
-     * @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, or when its caps or buy-side receiver are not executable.
+     * @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, when its caps or buy-side receiver are not executable, or when its units exceed its offer `maxUnits`.
      * @example
      * ```ts
      * import { MidnightApi } from "@morpho-org/midnight-sdk/api";

package/lib/esm/api/helpers.d.ts

@@ -1,5 +1,5 @@
 import { type Address, type Hash } from "viem";
-import { type ApiBookMarketResponse, type ApiCollateralResponse, type ApiPriceLevelResponse, type ApiRequestParams, type ApiTakeableOfferResponse, type MempoolPayloadValidationResult, type MidnightApiBookMarket, type MidnightApiBookSide, type MidnightApiCollateral, type MidnightApiPriceLevel, type MidnightApiTake } from "./types.js";
+import { type ApiBookMarketResponse, type ApiPriceLevelResponse, type ApiRequestParams, type ApiTakeableOfferResponse, type MempoolPayloadValidationResult, type MidnightApiBookMarket, type MidnightApiBookSide, type MidnightApiPriceLevel, type MidnightApiTake } from "./types.js";
 /** @internal Sends one Midnight API request and maps non-2xx responses to SDK errors. */
 export declare function requestMidnightApi<Response = unknown>(params: ApiRequestParams): Promise<Response>;
 /** @internal Builds a book endpoint path with encoded path segments. */
@@ -8,16 +8,6 @@ export declare function buildBookPath(params: {
     readonly side?: MidnightApiBookSide;
     readonly suffix?: "quote" | "takeable-offers";
 }): string;
-/**
- * @internal Maps a book market API payload to the SDK response shape, rejecting any
- * response whose advertised `market_id` cannot be derived from — or does not match —
- * its own market params. Recomputing the id with `MarketUtils.toId` (mirroring the
- * takeable-offers path) stops a hostile API from pairing a trusted id with foreign
- * metadata; every book flows through here, so both bound paths reject the same substitution.
- * Collaterals are returned in the protocol's canonical order so their array index matches
- * the onchain `collateralIndex`.
- */
-export declare function mapBookMarket(book: ApiBookMarketResponse): MidnightApiBookMarket;
 /** @internal Maps a book market, binding its verified id to the requested market. */
 export declare function mapBoundBookMarket(book: ApiBookMarketResponse, requestedMarketId: Hash): MidnightApiBookMarket;
 /** @internal Requested `fetchBooks` filters that every returned book must satisfy. */
@@ -30,14 +20,8 @@ export interface BookFilterContext {
 }
 /** @internal Maps listed book markets, binding each verified id to requested filters when present. */
 export declare function mapBoundBooks(books: readonly ApiBookMarketResponse[], context?: BookFilterContext): MidnightApiBookMarket[];
-/** @internal Maps a collateral API payload to the SDK response shape. */
-export declare function mapCollateral(collateral: ApiCollateralResponse): MidnightApiCollateral;
-/** @internal Maps a price-level API payload to the SDK response shape. */
-export declare function mapPriceLevel(level: ApiPriceLevelResponse): MidnightApiPriceLevel;
 /** @internal Maps API price levels and sorts them best first: asks by ascending tick, bids by descending tick. */
 export declare function mapPriceLevels(levels: readonly ApiPriceLevelResponse[], side: MidnightApiBookSide): MidnightApiPriceLevel[];
-/** @internal Maps a takeable-offer API payload to the SDK response shape. */
-export declare function mapTakeableOffer(takeableOffer: ApiTakeableOfferResponse): MidnightApiTake;
 /** @internal API response context required for a takeable offer to be executable for the caller's request. */
 export interface TakeableOfferContext {
     readonly marketId?: Hash;
@@ -46,7 +30,7 @@ export interface TakeableOfferContext {
     readonly marketIds?: readonly Hash[];
     readonly groups?: readonly Hash[];
 }
-/** @internal Maps, validates, and best-price-sorts API takeable offers. */
+/** @internal Maps, validates offer caps and units, and best-price-sorts API takeable offers. */
 export declare function mapBoundTakeableOffers(takeableOffers: readonly ApiTakeableOfferResponse[], context: TakeableOfferContext): MidnightApiTake[];
 /** @internal Parses the mempool validation response envelope. */
 export declare function parseValidationResponse(response: unknown): MempoolPayloadValidationResult;

package/lib/esm/api/helpers.js

@@ -90,7 +90,7 @@ export function buildBookPath(params) {
  * Collaterals are returned in the protocol's canonical order so their array index matches
  * the onchain `collateralIndex`.
  */
-export function mapBookMarket(book) {
+function mapBookMarket(book) {
     let derivedMarketId;
     let matchesAdvertisedId;
     try {
@@ -177,7 +177,7 @@ export function mapBoundBooks(books, context = {}) {
     });
 }
 /** @internal Maps a collateral API payload to the SDK response shape. */
-export function mapCollateral(collateral) {
+function mapCollateral(collateral) {
     return {
         token: collateral.token,
         lltv: collateral.lltv,
@@ -186,7 +186,7 @@ export function mapCollateral(collateral) {
     };
 }
 /** @internal Maps a price-level API payload to the SDK response shape. */
-export function mapPriceLevel(level) {
+function mapPriceLevel(level) {
     return {
         tick: level.tick,
         price: level.price,
@@ -202,7 +202,7 @@ export function mapPriceLevels(levels, side) {
         .sort((a, b) => (side === "asks" ? a.tick - b.tick : b.tick - a.tick));
 }
 /** @internal Maps a takeable-offer API payload to the SDK response shape. */
-export function mapTakeableOffer(takeableOffer) {
+function mapTakeableOffer(takeableOffer) {
     const offer = takeableOffer.offer;
     return {
         marketId: takeableOffer.market_id,
@@ -241,7 +241,7 @@ export function mapTakeableOffer(takeableOffer) {
         ratifierData: takeableOffer.ratifier_data,
     };
 }
-/** @internal Maps, validates, and best-price-sorts API takeable offers. */
+/** @internal Maps, validates offer caps and units, and best-price-sorts API takeable offers. */
 export function mapBoundTakeableOffers(takeableOffers, context) {
     const mapped = takeableOffers.map((takeableOffer) => {
         let take;
@@ -276,6 +276,9 @@ export function mapBoundTakeableOffers(takeableOffers, context) {
                 throw cause;
             throw new InvalidMidnightApiResponseError(`Midnight API takeable offer for market_id "${take.marketId}" is not executable: ${cause.message}`, { cause });
         }
+        if (maxUnits > 0n && take.units > maxUnits) {
+            throw new InvalidMidnightApiResponseError(`Midnight API takeable offer for market_id "${take.marketId}" reports units "${take.units}" above offer maxUnits "${maxUnits}".`);
+        }
         if (context.marketId != null &&
             !isHexEqual(take.marketId, context.marketId)) {
             throw new InvalidMidnightApiResponseError(`Midnight API takeable offer market_id "${take.marketId}" does not match requested market "${context.marketId}".`);

package/lib/esm/api/types.d.ts

@@ -409,7 +409,7 @@ export interface MidnightApiBookPriceLevelsResult {
 export interface MidnightApiQuote {
     /** Weighted average price for the requested size before any guard. */
     readonly averageBestPrice: string;
-    /** Effective weighted average-price guard for the returned instructions. */
+    /** Equals the caller's `averageWorstPrice` when provided, otherwise the API's guard. */
     readonly averageWorstPrice: string;
     /** Maximum assets available from the returned take caps. */
     readonly availableAssets: string;
@@ -440,9 +440,9 @@ export interface MidnightApiTakeableOffersResult {
     readonly data: readonly MidnightApiTake[];
 }
 /** @internal HTTP method owned by Midnight API helpers. */
-export type ApiMethod = "GET" | "POST";
+type ApiMethod = "GET" | "POST";
 /** @internal Query values serializable by Midnight API helpers. */
-export type QueryValue = string | number | bigint | boolean | Date | readonly string[] | readonly number[] | undefined;
+type QueryValue = string | number | bigint | boolean | Date | readonly string[] | readonly number[] | undefined;
 /** @internal Request descriptor consumed by the Midnight API HTTP helper. */
 export type ApiRequestParams = MidnightApiConfig & {
     readonly method: ApiMethod;
@@ -493,7 +493,7 @@ export type ApiPriceLevelsResponse = {
     readonly data: readonly ApiPriceLevelResponse[];
 };
 /** @internal Offer market response shape returned by the API. */
-export type ApiOfferMarketResponse = {
+type ApiOfferMarketResponse = {
     readonly chain_id: number;
     readonly midnight: Address;
     readonly loan_token: Address;
@@ -504,7 +504,7 @@ export type ApiOfferMarketResponse = {
     readonly liquidator_gate: Address;
 };
 /** @internal Inline offer response shape returned by the API. */
-export type ApiOfferResponse = {
+type ApiOfferResponse = {
     readonly market: ApiOfferMarketResponse;
     readonly buy: boolean;
     readonly maker: Address;
@@ -547,3 +547,4 @@ export type ApiTakeableOffersResponse = {
     readonly cursor: string | null;
     readonly data: readonly ApiTakeableOfferResponse[];
 };
+export {};

package/lib/esm/api/version.generated.d.ts

@@ -1,2 +1,2 @@
 /** @internal Installed Midnight SDK package version. */
-export declare const MIDNIGHT_SDK_VERSION = "1.8.0";
+export declare const MIDNIGHT_SDK_VERSION = "2.1.0-next.0";

package/lib/esm/api/version.generated.js

@@ -1,3 +1,3 @@
-// Generated by scripts/release/generate-midnight-package-version.ts. Do not edit.
+// Generated by scripts/generate-midnight-package-version.ts. Do not edit.
 /** @internal Installed Midnight SDK package version. */
-export const MIDNIGHT_SDK_VERSION = "1.8.0";
+export const MIDNIGHT_SDK_VERSION = "2.1.0-next.0";

package/lib/esm/bundlesV2.d.ts

@@ -0,0 +1,15 @@
+import type { Hex } from "viem";
+/** `MidnightBundlesV2` group cancellation: marks `group` fully consumed if its consumption is at most `maxConsumed`. */
+export interface GroupCancellation {
+    /** Offer group id. */
+    readonly group: Hex;
+    /** Largest current group consumption accepted (uint128); the whole call reverts above it. */
+    readonly maxConsumed: bigint;
+}
+/** `MidnightBundlesV2` collateral transfer: `assets` of the market collateral at `collateralIndex`. */
+export interface CollateralTransfer {
+    /** Index of the collateral in the market's `collateralParams`. */
+    readonly collateralIndex: bigint;
+    /** Collateral assets. */
+    readonly assets: bigint;
+}

package/lib/esm/bundlesV2.js

@@ -0,0 +1 @@
+export {};

package/lib/esm/errors.d.ts

@@ -1,3 +1,4 @@
+import { InvalidPositionAccrualStateError as SharedInvalidPositionAccrualStateError, InvalidPositionAccrualTimestampError as SharedInvalidPositionAccrualTimestampError, InvalidPositionLossFactorError as SharedInvalidPositionLossFactorError } from "@morpho-org/morpho-ts";
 import type { Address } from "viem";
 import type { MempoolPayloadValidationIssue } from "./api/types.js";
 /**
@@ -70,42 +71,27 @@ export declare class SettlementFeeExceedsPriceError extends Error {
 /**
  * Thrown when a local position accrual is requested for an impossible timestamp.
  *
- * @example
- * ```ts
- * import { InvalidPositionAccrualTimestampError } from "@morpho-org/midnight-sdk";
- *
- * throw new InvalidPositionAccrualTimestampError(1n, 2n);
- * ```
+ * @deprecated Import `InvalidPositionAccrualTimestampError` from `@morpho-org/morpho-ts`. Removed in the next major.
  */
-export declare class InvalidPositionAccrualTimestampError extends Error {
-    constructor(timestamp: bigint, lastAccrual: bigint);
-}
+export declare const InvalidPositionAccrualTimestampError: typeof SharedInvalidPositionAccrualTimestampError;
+/** @deprecated Import `InvalidPositionAccrualTimestampError` from `@morpho-org/morpho-ts`. Removed in the next major. */
+export type InvalidPositionAccrualTimestampError = SharedInvalidPositionAccrualTimestampError;
 /**
  * Thrown when a local position accrual sees a market loss factor older than the position.
  *
- * @example
- * ```ts
- * import { InvalidPositionLossFactorError } from "@morpho-org/midnight-sdk";
- *
- * throw new InvalidPositionLossFactorError(1n, 2n);
- * ```
+ * @deprecated Import `InvalidPositionLossFactorError` from `@morpho-org/morpho-ts`. Removed in the next major.
  */
-export declare class InvalidPositionLossFactorError extends Error {
-    constructor(marketLossFactor: bigint, positionLossFactor: bigint);
-}
+export declare const InvalidPositionLossFactorError: typeof SharedInvalidPositionLossFactorError;
+/** @deprecated Import `InvalidPositionLossFactorError` from `@morpho-org/morpho-ts`. Removed in the next major. */
+export type InvalidPositionLossFactorError = SharedInvalidPositionLossFactorError;
 /**
  * Thrown when local position accrual inputs violate Midnight accounting invariants.
  *
- * @example
- * ```ts
- * import { InvalidPositionAccrualStateError } from "@morpho-org/midnight-sdk";
- *
- * throw new InvalidPositionAccrualStateError("Pending fee exceeds credit.");
- * ```
+ * @deprecated Import `InvalidPositionAccrualStateError` from `@morpho-org/morpho-ts`. Removed in the next major.
  */
-export declare class InvalidPositionAccrualStateError extends Error {
-    constructor(reason: string);
-}
+export declare const InvalidPositionAccrualStateError: typeof SharedInvalidPositionAccrualStateError;
+/** @deprecated Import `InvalidPositionAccrualStateError` from `@morpho-org/morpho-ts`. Removed in the next major. */
+export type InvalidPositionAccrualStateError = SharedInvalidPositionAccrualStateError;
 /**
  * Thrown when a market parameter cannot satisfy Midnight protocol rules.
  *

package/lib/esm/errors.js

@@ -1,3 +1,4 @@
+import { InvalidPositionAccrualStateError as SharedInvalidPositionAccrualStateError, InvalidPositionAccrualTimestampError as SharedInvalidPositionAccrualTimestampError, InvalidPositionLossFactorError as SharedInvalidPositionLossFactorError, } from "@morpho-org/morpho-ts";
 /**
  * Thrown when a Midnight offer group violates protocol-level group mechanics.
  *
@@ -81,54 +82,25 @@ export class SettlementFeeExceedsPriceError extends Error {
         this.name = "SettlementFeeExceedsPriceError";
     }
 }
+// Temporary compatibility exception for these shared morpho-ts errors.
 /**
  * Thrown when a local position accrual is requested for an impossible timestamp.
  *
- * @example
- * ```ts
- * import { InvalidPositionAccrualTimestampError } from "@morpho-org/midnight-sdk";
- *
- * throw new InvalidPositionAccrualTimestampError(1n, 2n);
- * ```
+ * @deprecated Import `InvalidPositionAccrualTimestampError` from `@morpho-org/morpho-ts`. Removed in the next major.
  */
-export class InvalidPositionAccrualTimestampError extends Error {
-    constructor(timestamp, lastAccrual) {
-        super(`Position accrual timestamp "${timestamp}" is before last accrual "${lastAccrual}". Use a timestamp greater than or equal to last accrual.`);
-        this.name = "InvalidPositionAccrualTimestampError";
-    }
-}
+export const InvalidPositionAccrualTimestampError = SharedInvalidPositionAccrualTimestampError;
 /**
  * Thrown when a local position accrual sees a market loss factor older than the position.
  *
- * @example
- * ```ts
- * import { InvalidPositionLossFactorError } from "@morpho-org/midnight-sdk";
- *
- * throw new InvalidPositionLossFactorError(1n, 2n);
- * ```
+ * @deprecated Import `InvalidPositionLossFactorError` from `@morpho-org/morpho-ts`. Removed in the next major.
  */
-export class InvalidPositionLossFactorError extends Error {
-    constructor(marketLossFactor, positionLossFactor) {
-        super(`Market loss factor "${marketLossFactor}" is below position loss factor "${positionLossFactor}". Fetch a consistent market and position at the same block.`);
-        this.name = "InvalidPositionLossFactorError";
-    }
-}
+export const InvalidPositionLossFactorError = SharedInvalidPositionLossFactorError;
 /**
  * Thrown when local position accrual inputs violate Midnight accounting invariants.
  *
- * @example
- * ```ts
- * import { InvalidPositionAccrualStateError } from "@morpho-org/midnight-sdk";
- *
- * throw new InvalidPositionAccrualStateError("Pending fee exceeds credit.");
- * ```
+ * @deprecated Import `InvalidPositionAccrualStateError` from `@morpho-org/morpho-ts`. Removed in the next major.
  */
-export class InvalidPositionAccrualStateError extends Error {
-    constructor(reason) {
-        super(`Invalid Midnight position accrual state. ${reason}`);
-        this.name = "InvalidPositionAccrualStateError";
-    }
-}
+export const InvalidPositionAccrualStateError = SharedInvalidPositionAccrualStateError;
 /**
  * Thrown when a market parameter cannot satisfy Midnight protocol rules.
  *

package/lib/esm/fetch/Ratifier.js

@@ -39,6 +39,7 @@ export async function fetchRatifierInfo(client, params) {
     const chainId = await resolveChainId(client);
     const ecrecoverRatifier = getChainAddress(chainId, "ecrecoverRatifier");
     const setterRatifier = getChainAddress(chainId, "setterRatifier");
+    // eth_getCode is trusted; the returned ratifier is a suggestion the caller commits to on Offer.create. See THREAT_MODEL.md, RPC.
     const bytecode = await getBytecode(client, {
         ...(params.blockNumber != null
             ? { blockNumber: params.blockNumber }

package/lib/esm/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./abis.js";
+export type { CollateralTransfer, GroupCancellation } from "./bundlesV2.js";
 export * from "./constants.js";
 export * from "./errors.js";
 export * from "./fetch/index.js";

package/lib/esm/position/PositionUtils.js

@@ -1,5 +1,4 @@
-import { MathLib } from "@morpho-org/morpho-ts";
-import { InvalidPositionAccrualStateError, InvalidPositionAccrualTimestampError, InvalidPositionLossFactorError, } from "../errors.js";
+import { MathLib, MidnightPositionLib, } from "@morpho-org/morpho-ts";
 /**
  * Domain helpers for Midnight positions.
  *
@@ -132,40 +131,17 @@ export var PositionUtils;
      */
     function accrueInterest(params) {
         const timestamp = BigInt(params.timestamp);
-        const credit = BigInt(params.position.credit);
-        const pendingFee = BigInt(params.position.pendingFee);
-        const lastLossFactor = BigInt(params.position.lastLossFactor);
-        const lastAccrual = BigInt(params.position.lastAccrual);
         const marketLossFactor = BigInt(params.market.lossFactor);
-        if (timestamp < lastAccrual) {
-            throw new InvalidPositionAccrualTimestampError(timestamp, lastAccrual);
-        }
-        if (marketLossFactor < lastLossFactor) {
-            throw new InvalidPositionLossFactorError(marketLossFactor, lastLossFactor);
-        }
-        if (pendingFee > credit) {
-            throw new InvalidPositionAccrualStateError("Pending fee must be less than or equal to credit.");
-        }
-        const postSlashCredit = lastLossFactor < MathLib.MAX_UINT_128
-            ? MathLib.mulDivDown(credit, MathLib.MAX_UINT_128 - marketLossFactor, MathLib.MAX_UINT_128 - lastLossFactor)
-            : 0n;
-        if (postSlashCredit > credit) {
-            throw new InvalidPositionAccrualStateError("Post-slash credit cannot exceed stored credit.");
-        }
-        const creditDecrease = credit - postSlashCredit;
-        const pendingFeeDecrease = credit > 0n ? MathLib.mulDivUp(pendingFee, creditDecrease, credit) : 0n;
-        if (pendingFeeDecrease > pendingFee) {
-            throw new InvalidPositionAccrualStateError("Pending-fee decrease cannot exceed pending fee.");
-        }
-        const postSlashPendingFee = pendingFee - pendingFeeDecrease;
         const maturity = BigInt(params.market.params.maturity);
-        const accrualEnd = timestamp < maturity ? timestamp : maturity;
-        const accruedFee = lastAccrual < maturity
-            ? MathLib.mulDivDown(postSlashPendingFee, accrualEnd - lastAccrual, maturity - lastAccrual)
-            : 0n;
-        if (accruedFee > postSlashCredit || accruedFee > postSlashPendingFee) {
-            throw new InvalidPositionAccrualStateError("Accrued fee cannot exceed post-slash credit or pending fee.");
-        }
+        const { credit, pendingFee, accruedFee } = MidnightPositionLib.accrue({
+            credit: params.position.credit,
+            pendingFee: params.position.pendingFee,
+            lastLossFactor: params.position.lastLossFactor,
+            lastAccrual: params.position.lastAccrual,
+            marketLossFactor,
+            maturity,
+            timestamp,
+        });
         const collateral = params.position.collateral.map((assets) => BigInt(assets));
         const collateralParams = params.market.params.collateralParams.map((collateralParam) => ({
             token: collateralParam.token,
@@ -196,8 +172,8 @@ export var PositionUtils;
             position: {
                 user: params.position.user,
                 marketId: params.position.marketId,
-                credit: postSlashCredit - accruedFee,
-                pendingFee: postSlashPendingFee - accruedFee,
+                credit,
+                pendingFee,
                 lastLossFactor: marketLossFactor,
                 lastAccrual: timestamp,
                 debt: BigInt(params.position.debt),

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@morpho-org/midnight-sdk",
   "description": "Viem-based package for Morpho Midnight that exports protocol utilities, fetch helpers, and Midnight API utilities under a dedicated API subpath.",
-  "version": "1.8.0",
+  "version": "2.1.0-next.0",
   "author": "Morpho Association <contact@morpho.org>",
   "repository": {
     "type": "git",
@@ -37,19 +37,20 @@
   },
   "sideEffects": false,
   "files": [
-    "lib"
+    "lib",
+    "MIGRATION-v1-to-v2.md"
   ],
   "peerDependencies": {
-    "@morpho-org/morpho-ts": "^2.8.0 || ^3.0.0",
+    "@morpho-org/morpho-ts": "^4.1.0-0",
     "viem": "^2.0.0"
   },
   "devDependencies": {
+    "@morpho-org/morpho-ts": "^4.1.0-next.0",
+    "@morpho-org/test": "^2.11.0-next.0",
     "fast-check": "^4.9.0",
     "typescript": "7.0.2",
     "viem": "^2.55.10",
-    "vitest": "^4.1.11",
-    "@morpho-org/morpho-ts": "^3.1.0",
-    "@morpho-org/test": "^2.10.0"
+    "vitest": "^4.1.11"
   },
   "scripts": {
     "prepublish": "pnpm build",
@@ -57,7 +58,7 @@
     "build": "pnpm generate:version && tsc --noEmit && pnpm build:cjs && pnpm build:esm",
     "build:cjs": "tsc --build tsconfig.build.cjs.json && echo '{\"type\":\"commonjs\"}' > lib/cjs/package.json",
     "build:esm": "tsc --build tsconfig.build.esm.json && echo '{\"type\":\"module\"}' > lib/esm/package.json",
-    "generate:version": "node ../../scripts/release/generate-midnight-package-version.ts",
+    "generate:version": "node ../../scripts/generate-midnight-package-version.ts",
     "test": "vitest --root ../.. --project midnight-sdk --project midnight-sdk-fork"
   },
   "types": "./lib/esm/index.d.ts"