@morpho-org/midnight-sdk 1.1.1 → 1.2.1

package/lib/cjs/api/helpers.js

@@ -12,10 +12,8 @@ const morpho_ts_1 = require("@morpho-org/morpho-ts");
 const viem_1 = require("viem");
 const errors_js_1 = require("../errors.js");
 const index_js_1 = require("../market/index.js");
+const version_generated_js_1 = require("./version.generated.js");
 const DEFAULT_MIDNIGHT_API_URL = new URL("/v0/midnight", morpho_ts_1.BLUE_API_BASE_URL);
-// Keep this literal in source so the browser ESM build does not import package.json
-// through Node-only createRequire/module shims.
-const MIDNIGHT_SDK_VERSION = "1.0.1";
 /** @internal Sends one Midnight API request and maps non-2xx responses to SDK errors. */
 async function requestMidnightApi(params) {
     const baseUrl = new URL(params.baseUrl ?? DEFAULT_MIDNIGHT_API_URL);
@@ -46,7 +44,7 @@ async function requestMidnightApi(params) {
     const headers = new Headers(params.request?.headers);
     if (params.body !== undefined)
         headers.set("Content-Type", "application/json");
-    headers.set("sdk-version", MIDNIGHT_SDK_VERSION);
+    headers.set("sdk-version", version_generated_js_1.MIDNIGHT_SDK_VERSION);
     const init = {
         ...params.request,
         method: params.method,

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

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

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

@@ -0,0 +1,6 @@
+"use strict";
+// Generated by scripts/release/generate-midnight-package-version.mjs. Do not edit.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MIDNIGHT_SDK_VERSION = void 0;
+/** @internal Installed Midnight SDK package version. */
+exports.MIDNIGHT_SDK_VERSION = "1.2.1";

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

@@ -1,5 +1,5 @@
 import type { Address, Client, Hash } from "viem";
-import { AccrualPosition, Position } from "../market/index.js";
+import { AccrualPosition, Position } from "../position/index.js";
 import type { MidnightFetchParams } from "./types.js";
 /**
  * Fetches a Midnight position by id and user.

package/lib/cjs/fetch/Position.js

@@ -6,7 +6,7 @@ const morpho_ts_1 = require("@morpho-org/morpho-ts");
 const actions_1 = require("viem/actions");
 const abis_js_1 = require("../abis.js");
 const constants_js_1 = require("../constants.js");
-const index_js_1 = require("../market/index.js");
+const index_js_1 = require("../position/index.js");
 const GetPosition_js_1 = require("../queries/GetPosition.js");
 const Market_js_1 = require("./Market.js");
 const utils_js_1 = require("./utils.js");
@@ -64,6 +64,8 @@ async function fetchPosition(client, params) {
             });
             const collateral = position.collateral;
             return new index_js_1.Position({
+                user: params.user,
+                marketId: params.marketId,
                 credit: position.credit,
                 pendingFee: position.pendingFee,
                 lastLossFactor: position.lastLossFactor,
@@ -96,6 +98,8 @@ async function fetchPosition(client, params) {
         });
     }));
     return new index_js_1.Position({
+        user: params.user,
+        marketId: params.marketId,
         credit: position[0],
         pendingFee: position[1],
         lastLossFactor: position[2],

package/lib/cjs/index.d.ts

@@ -5,6 +5,7 @@ export * from "./fetch/index.js";
 export * from "./market/index.js";
 export * from "./math/index.js";
 export * from "./offers/index.js";
+export * from "./position/index.js";
 export * from "./signatures/index.js";
 /**
  * Namespace for Midnight mempool payload utilities.

package/lib/cjs/index.js

@@ -22,6 +22,7 @@ __exportStar(require("./fetch/index.js"), exports);
 __exportStar(require("./market/index.js"), exports);
 __exportStar(require("./math/index.js"), exports);
 __exportStar(require("./offers/index.js"), exports);
+__exportStar(require("./position/index.js"), exports);
 __exportStar(require("./signatures/index.js"), exports);
 /**
  * Namespace for Midnight mempool payload utilities.

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

@@ -1,4 +1,2 @@
 export * from "./Market.js";
 export * from "./MarketUtils.js";
-export * from "./Position.js";
-export * from "./PositionUtils.js";

package/lib/cjs/market/index.js

@@ -16,5 +16,3 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./Market.js"), exports);
 __exportStar(require("./MarketUtils.js"), exports);
-__exportStar(require("./Position.js"), exports);
-__exportStar(require("./PositionUtils.js"), exports);

package/lib/cjs/offers/Offer.d.ts

@@ -9,9 +9,9 @@ import { type IMarket, type IMarketParams, Market, MarketParams } from "../marke
  * take-side conversion helpers. Use {@link Offer.create} instead for new maker
  * offers so deterministic fields are validated before grouping or signing.
  * The `group` field is optional. When omitted, {@link Offer.group} lazily
- * derives the standalone group id from this offer hashed with the protocol
- * zero group id. `Group.create` copies offers into a shared group and overrides
- * this field on the copies it owns.
+ * derives the content-addressed singleton group id from this offer's
+ * zero-group hash. `Group.create` copies offers into a shared group and
+ * overrides this field on the copies it owns.
  *
  * @example
  * ```ts
@@ -64,7 +64,7 @@ export interface IOffer {
     readonly expiry: BigIntish;
     /** Midnight tick. */
     readonly tick: BigIntish;
-    /** Consumption group id; defaults to the offer hash with the zero group id. */
+    /** Consumption group id; defaults to the content-addressed singleton group id. */
     readonly group?: Hash;
     /** Optional maker callback. */
     readonly callback: Address;
@@ -90,10 +90,11 @@ export interface IOffer {
  * `Group.create` for shared-consumption ladders or directly to `Tree.create`
  * for standalone offers. API/take-side code can convert a plain `IOffer`
  * into this class before ABI encoding. The class resolves the onchain `group`
- * field lazily. Standalone offers derive their group id from the offer hash
- * with the zero group id; `Group.create` copies offers and overrides the group
- * on those copies when several offers share one consumption bucket. Offers
- * hydrated from API or decoded data may also carry a known group id.
+ * field lazily. Standalone offers derive their content-addressed singleton
+ * group id from the offer's zero-group hash; `Group.create` copies offers and
+ * overrides the group on those copies when several offers share one
+ * consumption bucket. Offers hydrated from API or decoded data may also carry
+ * a known group id.
  *
  * @example
  * ```ts
@@ -220,8 +221,11 @@ export declare class Offer {
      * Consumption group id encoded into this offer.
      *
      * When no group id was provided, the value is computed on first access by
-     * hashing this offer with the protocol zero group id. The computed value is
-     * cached because offer hashing is resource-intensive.
+     * hashing this offer with the protocol zero group id, then hashing that
+     * result as a singleton group. The computed value is cached because offer
+     * hashing is resource-intensive. This is equivalent to
+     * `GroupUtils.hash([offer])`, but is computed directly to keep the offers
+     * layer from importing signature helpers and creating a circular dependency.
      *
      * @returns Consumption group id.
      * @example

package/lib/cjs/offers/Offer.js

@@ -11,10 +11,11 @@ const OfferUtils_js_1 = require("./OfferUtils.js");
  * `Group.create` for shared-consumption ladders or directly to `Tree.create`
  * for standalone offers. API/take-side code can convert a plain `IOffer`
  * into this class before ABI encoding. The class resolves the onchain `group`
- * field lazily. Standalone offers derive their group id from the offer hash
- * with the zero group id; `Group.create` copies offers and overrides the group
- * on those copies when several offers share one consumption bucket. Offers
- * hydrated from API or decoded data may also carry a known group id.
+ * field lazily. Standalone offers derive their content-addressed singleton
+ * group id from the offer's zero-group hash; `Group.create` copies offers and
+ * overrides the group on those copies when several offers share one
+ * consumption bucket. Offers hydrated from API or decoded data may also carry
+ * a known group id.
  *
  * @example
  * ```ts
@@ -162,8 +163,11 @@ class Offer {
      * Consumption group id encoded into this offer.
      *
      * When no group id was provided, the value is computed on first access by
-     * hashing this offer with the protocol zero group id. The computed value is
-     * cached because offer hashing is resource-intensive.
+     * hashing this offer with the protocol zero group id, then hashing that
+     * result as a singleton group. The computed value is cached because offer
+     * hashing is resource-intensive. This is equivalent to
+     * `GroupUtils.hash([offer])`, but is computed directly to keep the offers
+     * layer from importing signature helpers and creating a circular dependency.
      *
      * @returns Consumption group id.
      * @example
@@ -208,7 +212,7 @@ class Offer {
      * ```
      */
     get group() {
-        this.cachedGroup ??= OfferUtils_js_1.OfferUtils.groupHash(this);
+        this.cachedGroup ??= (0, viem_1.keccak256)(OfferUtils_js_1.OfferUtils.groupHash(this));
         return this.cachedGroup;
     }
     /**

package/lib/cjs/offers/OfferChainUtils.d.ts

@@ -0,0 +1,179 @@
+import { type BigIntish } from "@morpho-org/morpho-ts";
+/** One time-bounded offer leg to convert into a Midnight `Offer.create` input. */
+export interface FixedRateOfferChainLeg {
+    /** Spacing-aligned Midnight tick for this offer. */
+    readonly tick: bigint;
+    /** First timestamp at which the offer leg is active. */
+    readonly startTimestamp: bigint;
+    /** Last timestamp at which the offer leg is active. */
+    readonly expiryTimestamp: bigint;
+}
+/** Parameters shared by lend-only and borrow-only fixed-rate offer-chain builders. */
+export interface BuildFixedRateOfferChainParams {
+    /** Target yearly fixed rate as a decimal number, for example `0.05` for 5%. */
+    readonly targetRate: number;
+    /** Tick spacing enforced by the market. */
+    readonly tickSpacing: BigIntish;
+    /** Market maturity timestamp in seconds. */
+    readonly maturityTimestamp: BigIntish;
+    /** First timestamp the chain should cover. */
+    readonly chainStartTimestamp: BigIntish;
+    /** Latest timestamp the chain may cover. */
+    readonly chainEndTimestamp: BigIntish;
+}
+/**
+ * Utilities for building time-bounded Midnight offer chains.
+ *
+ * A Midnight offer has one fixed price, so its displayed yearly rate changes
+ * as maturity approaches. The markets app uses these helpers when a maker wants
+ * to post, for example, a 5% order for several months: the app builds several
+ * adjacent offers sharing the same reserve, each with a different tick and time
+ * window, so the order reviews and renders as a stable 5% order across the
+ * selected window instead of drifting upward as time passes.
+ *
+ * @example
+ * ```ts
+ * import { OfferChainUtils } from "@morpho-org/midnight-sdk";
+ *
+ * const legs = OfferChainUtils.buildLendFixedRateOfferChain({
+ *   targetRate: 0.05,
+ *   tickSpacing: 4n,
+ *   maturityTimestamp: 1_798_761_600n,
+ *   chainStartTimestamp: 1_767_225_600n,
+ *   chainEndTimestamp: 1_791_153_600n,
+ * });
+ * console.log(legs[0]?.tick);
+ * ```
+ */
+export declare namespace OfferChainUtils {
+    /**
+     * Maximum fraction of the initial time-to-maturity covered by a fixed-rate offer chain.
+     *
+     * Use this cap before displaying an expiry picker for a fixed-rate maker
+     * order. The last part of the maturity window is intentionally excluded
+     * because tiny time changes cause large displayed-rate drift.
+     *
+     * @example
+     * ```ts
+     * import { OfferChainUtils } from "@morpho-org/midnight-sdk";
+     *
+     * console.log(OfferChainUtils.MAX_EXPIRY_TTM_FRACTION);
+     * ```
+     */
+    const MAX_EXPIRY_TTM_FRACTION = 0.75;
+    /**
+     * Builds borrow-side sell-offer legs that approximate one fixed maker rate over time.
+     *
+     * Use before a make-borrow or supply-collateral-and-make-borrow flow when a
+     * borrower wants one displayed fixed borrow rate across a longer window. Map
+     * the returned legs to `Offer.create({ buy: false, ... })`, then group and
+     * submit them through the maker flow.
+     *
+     * Borrow chains read their target rate at each leg's expiry edge. If a leg
+     * would need to extend past `chainEndTimestamp`, it is dropped rather than
+     * clamped so the expiry edge remains the recoverable target-rate edge.
+     *
+     * @param params - Fixed-rate offer-chain parameters without a side field.
+     * @param params.targetRate - Target yearly fixed rate expressed as a decimal number.
+     * @param params.tickSpacing - Tick spacing enforced by the market.
+     * @param params.maturityTimestamp - Market maturity timestamp in seconds.
+     * @param params.chainStartTimestamp - First timestamp the chain should cover.
+     * @param params.chainEndTimestamp - Latest timestamp the chain may cover.
+     * @returns Borrow-side offer legs that can be mapped to `Offer.create({ buy: false, ... })`.
+     * @throws {InvalidOfferParameterError} when an input is invalid or the end timestamp exceeds the supported horizon.
+     * @example
+     * ```ts
+     * import { Offer, OfferChainUtils } from "@morpho-org/midnight-sdk";
+     *
+     * const legs = OfferChainUtils.buildBorrowFixedRateOfferChain({
+     *   targetRate: 0.08,
+     *   tickSpacing: market.tickSpacing,
+     *   maturityTimestamp: market.params.maturity,
+     *   chainStartTimestamp: now,
+     *   chainEndTimestamp: expiry,
+     * });
+     * const offers = legs.map((leg) =>
+     *   Offer.create({
+     *     ...baseOffer,
+     *     buy: false,
+     *     tick: leg.tick,
+     *     start: leg.startTimestamp,
+     *     expiry: leg.expiryTimestamp,
+     *   }),
+     * );
+     * ```
+     */
+    function buildBorrowFixedRateOfferChain(params: BuildFixedRateOfferChainParams): readonly FixedRateOfferChainLeg[];
+    /**
+     * Builds lend-side buy-offer legs that approximate one fixed maker rate over time.
+     *
+     * Use before a make-lend flow when a lender wants one displayed fixed lend
+     * rate across a longer window. Map the returned legs to
+     * `Offer.create({ buy: true, ... })`, then group and submit them through the
+     * maker flow.
+     *
+     * Lend chains read their target rate at each leg's start edge. The first leg
+     * may start before `chainStartTimestamp`; clamping that edge would move the
+     * recoverable display rate below the maker's target.
+     *
+     * @param params - Fixed-rate offer-chain parameters without a side field.
+     * @param params.targetRate - Target yearly fixed rate expressed as a decimal number.
+     * @param params.tickSpacing - Tick spacing enforced by the market.
+     * @param params.maturityTimestamp - Market maturity timestamp in seconds.
+     * @param params.chainStartTimestamp - First timestamp the chain should cover.
+     * @param params.chainEndTimestamp - Latest timestamp the chain may cover.
+     * @returns Lend-side offer legs that can be mapped to `Offer.create({ buy: true, ... })`.
+     * @throws {InvalidOfferParameterError} when an input is invalid or the end timestamp exceeds the supported horizon.
+     * @example
+     * ```ts
+     * import { Offer, OfferChainUtils } from "@morpho-org/midnight-sdk";
+     *
+     * const legs = OfferChainUtils.buildLendFixedRateOfferChain({
+     *   targetRate: 0.05,
+     *   tickSpacing: market.tickSpacing,
+     *   maturityTimestamp: market.params.maturity,
+     *   chainStartTimestamp: now,
+     *   chainEndTimestamp: expiry,
+     * });
+     * const offers = legs.map((leg) =>
+     *   Offer.create({
+     *     ...baseOffer,
+     *     buy: true,
+     *     tick: leg.tick,
+     *     start: leg.startTimestamp,
+     *     expiry: leg.expiryTimestamp,
+     *   }),
+     * );
+     * ```
+     */
+    function buildLendFixedRateOfferChain(params: BuildFixedRateOfferChainParams): readonly FixedRateOfferChainLeg[];
+    /**
+     * Returns the latest supported end timestamp for a fixed-rate offer chain.
+     *
+     * Chains intentionally stop before the final part of the maturity window
+     * because rate sensitivity accelerates near maturity and would require too
+     * many short-lived offers for a stable maker quote.
+     * Call this when constraining a make-offer expiry selector, then pass the
+     * selected timestamp to the lend-only or borrow-only chain builder.
+     *
+     * @param params - Maturity and chain-start timestamps.
+     * @param params.maturityTimestamp - Market maturity timestamp in seconds.
+     * @param params.chainStartTimestamp - First timestamp the chain should cover.
+     * @returns Latest accepted chain end timestamp.
+     * @throws {InvalidOfferParameterError} when a timestamp is invalid.
+     * @example
+     * ```ts
+     * import { OfferChainUtils } from "@morpho-org/midnight-sdk";
+     *
+     * const maxExpiry = OfferChainUtils.getMaxFixedRateOfferChainEndTimestamp({
+     *   maturityTimestamp: market.params.maturity,
+     *   chainStartTimestamp: now,
+     * });
+     * console.log(maxExpiry);
+     * ```
+     */
+    function getMaxFixedRateOfferChainEndTimestamp(params: {
+        readonly maturityTimestamp: BigIntish;
+        readonly chainStartTimestamp: BigIntish;
+    }): bigint;
+}