@morpho-org/midnight-sdk 0.1.0 → 1.1.1

package/lib/esm/market/PositionUtils.d.ts

@@ -19,14 +19,15 @@ import type { IPosition } from "./Position.js";
  *     collateral: [50n],
  *   },
  *   market: {
- *     chainId: 8453,
  *     params: {
+ *       chainId: 8453,
+ *       midnight: "0x0000000000000000000000000000000000001000",
  *       loanToken: "0x0000000000000000000000000000000000006000",
  *       collateralParams: [
  *         {
  *           token: "0x0000000000000000000000000000000000007000",
  *           lltv: 770000000000000000n,
- *           maxLif: 1061007957559681697n,
+ *           liquidationCursor: 250000000000000000n,
  *           oracle: "0x0000000000000000000000000000000000008000",
  *         },
  *       ],
@@ -74,14 +75,15 @@ export declare namespace PositionUtils {
      *     collateral: [50n],
      *   },
      *   market: {
-     *     chainId: 8453,
      *     params: {
+     *       chainId: 8453,
+     *       midnight: "0x0000000000000000000000000000000000001000",
      *       loanToken: "0x0000000000000000000000000000000000006000",
      *       collateralParams: [
      *         {
      *           token: "0x0000000000000000000000000000000000007000",
      *           lltv: 770000000000000000n,
-     *           maxLif: 1061007957559681697n,
+     *           liquidationCursor: 250000000000000000n,
      *           oracle: "0x0000000000000000000000000000000000008000",
      *         },
      *       ],

package/lib/esm/market/PositionUtils.js

@@ -18,14 +18,15 @@ import { InvalidPositionAccrualStateError, InvalidPositionAccrualTimestampError,
  *     collateral: [50n],
  *   },
  *   market: {
- *     chainId: 8453,
  *     params: {
+ *       chainId: 8453,
+ *       midnight: "0x0000000000000000000000000000000000001000",
  *       loanToken: "0x0000000000000000000000000000000000006000",
  *       collateralParams: [
  *         {
  *           token: "0x0000000000000000000000000000000000007000",
  *           lltv: 770000000000000000n,
- *           maxLif: 1061007957559681697n,
+ *           liquidationCursor: 250000000000000000n,
  *           oracle: "0x0000000000000000000000000000000000008000",
  *         },
  *       ],
@@ -74,14 +75,15 @@ export var PositionUtils;
      *     collateral: [50n],
      *   },
      *   market: {
-     *     chainId: 8453,
      *     params: {
+     *       chainId: 8453,
+     *       midnight: "0x0000000000000000000000000000000000001000",
      *       loanToken: "0x0000000000000000000000000000000000006000",
      *       collateralParams: [
      *         {
      *           token: "0x0000000000000000000000000000000000007000",
      *           lltv: 770000000000000000n,
-     *           maxLif: 1061007957559681697n,
+     *           liquidationCursor: 250000000000000000n,
      *           oracle: "0x0000000000000000000000000000000000008000",
      *         },
      *       ],
@@ -143,10 +145,12 @@ export var PositionUtils;
         const collateralParams = params.market.params.collateralParams.map((collateralParam) => ({
             token: collateralParam.token,
             lltv: BigInt(collateralParam.lltv),
-            maxLif: BigInt(collateralParam.maxLif),
+            liquidationCursor: BigInt(collateralParam.liquidationCursor),
             oracle: collateralParam.oracle,
         }));
         const marketParams = {
+            chainId: BigInt(params.market.params.chainId),
+            midnight: params.market.params.midnight,
             loanToken: params.market.params.loanToken,
             collateralParams,
             maturity,
@@ -174,7 +178,6 @@ export var PositionUtils;
                 collateral,
             },
             market: {
-                chainId: BigInt(params.market.chainId),
                 params: marketParams,
                 totalUnits: BigInt(params.market.totalUnits),
                 lossFactor: marketLossFactor,

package/lib/esm/math/TickLib.d.ts

@@ -178,6 +178,28 @@ export declare namespace TickLib {
      * ```
      */
     function tickToRate(tick: BigIntish): bigint;
+    /**
+     * Converts a Midnight tick into a WAD simple annual percentage rate.
+     *
+     * This is an SDK-only rate display convenience. It annualizes the fixed
+     * period rate from {@link tickToRate} over `timeToMaturity` seconds.
+     *
+     * @param tick - Midnight tick.
+     * @param timeToMaturity - Seconds until the market matures.
+     * @returns WAD simple APR rounded up.
+     * @throws {NegativeValueError} when `tick` or `timeToMaturity` is negative.
+     * @throws {TickOutOfRangeError} when `tick` exceeds `MAX_TICK`.
+     * @throws {DivisionByZeroError} when the tick price or `timeToMaturity` is zero.
+     * @example
+     * ```ts
+     * import { TickLib } from "@morpho-org/midnight-sdk";
+     * import { Time } from "@morpho-org/morpho-ts";
+     *
+     * const apr = TickLib.tickToApr(6744n, Time.s.from.y(1n));
+     * console.log(apr);
+     * ```
+     */
+    function tickToApr(tick: BigIntish, timeToMaturity: BigIntish): bigint;
     /**
      * Asserts that a tick is aligned to the provided spacing.
      *

package/lib/esm/math/TickLib.js

@@ -1,4 +1,4 @@
-import { assertNonNegative, DivisionByZeroError, MathLib, } from "@morpho-org/morpho-ts";
+import { assertNonNegative, DivisionByZeroError, MathLib, Time, } from "@morpho-org/morpho-ts";
 import { DEFAULT_TICK_SPACING, MAX_TICK, PRICE_ROUNDING_STEP, } from "../constants.js";
 import { InvalidTickSpacingError, PriceGreaterThanOneError, TickOutOfRangeError, } from "../errors.js";
 /**
@@ -236,6 +236,36 @@ export var TickLib;
         return MathLib.mulDiv(MathLib.WAD, MathLib.WAD, price, "Up") - MathLib.WAD;
     }
     TickLib.tickToRate = tickToRate;
+    /**
+     * Converts a Midnight tick into a WAD simple annual percentage rate.
+     *
+     * This is an SDK-only rate display convenience. It annualizes the fixed
+     * period rate from {@link tickToRate} over `timeToMaturity` seconds.
+     *
+     * @param tick - Midnight tick.
+     * @param timeToMaturity - Seconds until the market matures.
+     * @returns WAD simple APR rounded up.
+     * @throws {NegativeValueError} when `tick` or `timeToMaturity` is negative.
+     * @throws {TickOutOfRangeError} when `tick` exceeds `MAX_TICK`.
+     * @throws {DivisionByZeroError} when the tick price or `timeToMaturity` is zero.
+     * @example
+     * ```ts
+     * import { TickLib } from "@morpho-org/midnight-sdk";
+     * import { Time } from "@morpho-org/morpho-ts";
+     *
+     * const apr = TickLib.tickToApr(6744n, Time.s.from.y(1n));
+     * console.log(apr);
+     * ```
+     */
+    function tickToApr(tick, timeToMaturity) {
+        const normalizedTimeToMaturity = BigInt(timeToMaturity);
+        assertNonNegative("timeToMaturity", normalizedTimeToMaturity);
+        if (normalizedTimeToMaturity === 0n) {
+            throw new DivisionByZeroError("timeToMaturity");
+        }
+        return MathLib.mulDiv(tickToRate(tick), Time.s.from.y(1n), normalizedTimeToMaturity, "Up");
+    }
+    TickLib.tickToApr = tickToApr;
     /**
      * Asserts that a tick is aligned to the provided spacing.
      *

package/lib/esm/math/index.d.ts

@@ -1,3 +1,2 @@
-export * from "./ConsumableUnitsLib.js";
 export * from "./TakeAmountsLib.js";
 export * from "./TickLib.js";

package/lib/esm/math/index.js

@@ -1,3 +1,2 @@
-export * from "./ConsumableUnitsLib.js";
 export * from "./TakeAmountsLib.js";
 export * from "./TickLib.js";

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

@@ -1,6 +1,6 @@
 import type { BigIntish } from "@morpho-org/morpho-ts";
 import type { Address, Hash, Hex } from "viem";
-import { type IMarket, type IMarketParams, MarketParams } from "../market/index.js";
+import { type IMarket, type IMarketParams, Market, MarketParams } from "../market/index.js";
 /**
  * Plain make-side offer input accepted by {@link Offer}.
  *
@@ -19,12 +19,14 @@ import { type IMarket, type IMarketParams, MarketParams } from "../market/index.
  *
  * const offer: IOffer = {
  *   market: {
+ *     chainId: 8453,
+ *     midnight: "0x0000000000000000000000000000000000001000",
  *     loanToken: "0x0000000000000000000000000000000000000001",
  *     collateralParams: [
  *       {
  *         token: "0x0000000000000000000000000000000000007000",
  *         lltv: 770000000000000000n,
- *         maxLif: 1061007957559681697n,
+ *         liquidationCursor: 250000000000000000n,
  *         oracle: "0x0000000000000000000000000000000000008000",
  *       },
  *     ],
@@ -99,12 +101,14 @@ export interface IOffer {
  *
  * const offer = Offer.create({
  *   market: {
+ *     chainId: 8453,
+ *     midnight: "0x0000000000000000000000000000000000001000",
  *     loanToken: "0x0000000000000000000000000000000000000001",
  *     collateralParams: [
  *       {
  *         token: "0x0000000000000000000000000000000000007000",
  *         lltv: 770000000000000000n,
- *         maxLif: 1061007957559681697n,
+ *         liquidationCursor: 250000000000000000n,
  *         oracle: "0x0000000000000000000000000000000000008000",
  *       },
  *     ],
@@ -132,7 +136,7 @@ export interface IOffer {
  */
 export declare class Offer {
     /** Market this offer trades. */
-    readonly market: MarketParams;
+    readonly market: MarketParams | Market;
     /** Whether the maker buys units. */
     readonly buy: boolean;
     /** Offer maker. */
@@ -178,12 +182,14 @@ export declare class Offer {
      *
      * const offer = Offer.from({
      *   market: {
+     *     chainId: 8453,
+     *     midnight: "0x0000000000000000000000000000000000001000",
      *     loanToken: "0x0000000000000000000000000000000000006000",
      *     collateralParams: [
      *       {
      *         token: "0x0000000000000000000000000000000000007000",
      *         lltv: 770000000000000000n,
-     *         maxLif: 1061007957559681697n,
+     *         liquidationCursor: 250000000000000000n,
      *         oracle: "0x0000000000000000000000000000000000008000",
      *       },
      *     ],
@@ -231,12 +237,14 @@ export declare class Offer {
      *
      * const offer = Offer.create({
      *   market: {
+     *     chainId: 8453,
+     *     midnight: "0x0000000000000000000000000000000000001000",
      *     loanToken,
      *     collateralParams: [
      *       {
      *         token: collateralToken,
      *         lltv: 770000000000000000n,
-     *         maxLif: 1061007957559681697n,
+     *         liquidationCursor: 250000000000000000n,
      *         oracle,
      *       },
      *     ],
@@ -254,7 +262,7 @@ export declare class Offer {
      * });
      *
      * const group = offer.group;
-     * // group satisfies Hash
+     * console.log(group);
      * ```
      */
     get group(): Hash;
@@ -278,12 +286,14 @@ export declare class Offer {
      *
      * const offer = Offer.create({
      *   market: {
+     *     chainId: 8453,
+     *     midnight: "0x0000000000000000000000000000000000001000",
      *     loanToken,
      *     collateralParams: [
      *       {
      *         token: collateralToken,
      *         lltv: 770000000000000000n,
-     *         maxLif: 1061007957559681697n,
+     *         liquidationCursor: 250000000000000000n,
      *         oracle,
      *       },
      *     ],
@@ -305,6 +315,196 @@ export declare class Offer {
      * ```
      */
     get hash(): Hash;
+    /**
+     * WAD zero-coupon price at this offer's tick.
+     *
+     * @returns WAD price rounded to the protocol price quantum.
+     * @throws {NegativeValueError} when `tick` is negative.
+     * @throws {TickOutOfRangeError} when `tick` exceeds `MAX_TICK`.
+     * @example
+     * ```ts
+     * import { Offer } from "@morpho-org/midnight-sdk";
+     *
+     * const offer = Offer.create({
+     *   market: {
+     *     loanToken: "0x0000000000000000000000000000000000006000",
+     *     collateralParams: [
+     *       {
+     *         token: "0x0000000000000000000000000000000000007000",
+     *         lltv: 770000000000000000n,
+     *         liquidationCursor: 250000000000000000n,
+     *         oracle: "0x0000000000000000000000000000000000008000",
+     *       },
+     *     ],
+     *     maturity: 54_000n,
+     *     rcfThreshold: 0n,
+     *     enterGate: "0x0000000000000000000000000000000000000000",
+     *     liquidatorGate: "0x0000000000000000000000000000000000000000",
+     *   },
+     *   buy: true,
+     *   maker: "0x0000000000000000000000000000000000009000",
+     *   tick: 5_000n,
+     *   expiry: 3_600n,
+     *   ratifier: "0x0000000000000000000000000000000000004000",
+     *   maxUnits: 100n,
+     * });
+     * console.log(offer.price);
+     * ```
+     */
+    get price(): bigint;
+    /**
+     * Converts this offer's tick into a WAD per-second simple rate at a timestamp.
+     *
+     * @param timestamp - Timestamp at which the rate is calculated.
+     * @returns WAD per-second simple rate rounded up.
+     * @throws {NegativeValueError} when market maturity, `timestamp`, or `tick` is negative.
+     * @throws {TickOutOfRangeError} when `tick` exceeds `MAX_TICK`.
+     * @throws {DivisionByZeroError} when the tick price is zero or `timestamp` is at or after maturity.
+     * @example
+     * ```ts
+     * import { Offer } from "@morpho-org/midnight-sdk";
+     *
+     * const offer = Offer.create({
+     *   market: {
+     *     loanToken: "0x0000000000000000000000000000000000006000",
+     *     collateralParams: [
+     *       {
+     *         token: "0x0000000000000000000000000000000000007000",
+     *         lltv: 770000000000000000n,
+     *         liquidationCursor: 250000000000000000n,
+     *         oracle: "0x0000000000000000000000000000000000008000",
+     *       },
+     *     ],
+     *     maturity: 54_000n,
+     *     rcfThreshold: 0n,
+     *     enterGate: "0x0000000000000000000000000000000000000000",
+     *     liquidatorGate: "0x0000000000000000000000000000000000000000",
+     *   },
+     *   buy: true,
+     *   maker: "0x0000000000000000000000000000000000009000",
+     *   tick: 5_000n,
+     *   expiry: 3_600n,
+     *   ratifier: "0x0000000000000000000000000000000000004000",
+     *   maxUnits: 100n,
+     * });
+     * const rate = offer.getRate(1_000n);
+     * console.log(rate);
+     * ```
+     */
+    getRate(timestamp: BigIntish): bigint;
+    /**
+     * Converts this offer's tick into a WAD simple annual percentage rate at a timestamp.
+     *
+     * @param timestamp - Timestamp at which the APR is calculated.
+     * @returns WAD simple APR rounded up.
+     * @throws {NegativeValueError} when market maturity, `timestamp`, or `tick` is negative.
+     * @throws {TickOutOfRangeError} when `tick` exceeds `MAX_TICK`.
+     * @throws {DivisionByZeroError} when the tick price is zero or `timestamp` is at or after maturity.
+     * @example
+     * ```ts
+     * import { Offer } from "@morpho-org/midnight-sdk";
+     *
+     * const offer = Offer.create({
+     *   market: {
+     *     loanToken: "0x0000000000000000000000000000000000006000",
+     *     collateralParams: [
+     *       {
+     *         token: "0x0000000000000000000000000000000000007000",
+     *         lltv: 770000000000000000n,
+     *         liquidationCursor: 250000000000000000n,
+     *         oracle: "0x0000000000000000000000000000000000008000",
+     *       },
+     *     ],
+     *     maturity: 54_000n,
+     *     rcfThreshold: 0n,
+     *     enterGate: "0x0000000000000000000000000000000000000000",
+     *     liquidatorGate: "0x0000000000000000000000000000000000000000",
+     *   },
+     *   buy: true,
+     *   maker: "0x0000000000000000000000000000000000009000",
+     *   tick: 5_000n,
+     *   expiry: 3_600n,
+     *   ratifier: "0x0000000000000000000000000000000000004000",
+     *   maxUnits: 100n,
+     * });
+     * const apr = offer.getApr(1_000n);
+     * console.log(apr);
+     * ```
+     */
+    getApr(timestamp: BigIntish): bigint;
+    /**
+     * Returns remaining units accepted by this offer's cap at a timestamp.
+     *
+     * The offer must carry a hydrated {@link Market} so the current market
+     * continuous fee and settlement-fee buckets are available locally. Fetch the
+     * current `consumed(maker, group)` value separately and pass it as input.
+     *
+     * @param params.consumed - Amount already consumed from this offer's group.
+     * @param params.timestamp - Timestamp used to compute the market time to maturity.
+     * @returns Remaining consumable units accepted by Midnight `take`.
+     * @throws {InvalidOfferParameterError} when this offer does not carry hydrated market state or has invalid caps.
+     * @throws {NegativeValueError} when `consumed`, `timestamp`, offer limits, or delegated math inputs are negative.
+     * @throws {TickOutOfRangeError} when `tick` exceeds `MAX_TICK`.
+     * @throws {SettlementFeeExceedsPriceError} when settlement fee exceeds a buy-offer price.
+     * @example
+     * ```ts
+     * import { Offer } from "@morpho-org/midnight-sdk";
+     *
+     * const offer = Offer.from({
+     *   market: {
+     *     params: {
+     *       chainId: 8453,
+     *       midnight: "0x0000000000000000000000000000000000001000",
+     *       loanToken: "0x0000000000000000000000000000000000006000",
+     *       collateralParams: [
+     *         {
+     *           token: "0x0000000000000000000000000000000000007000",
+     *           lltv: 770000000000000000n,
+     *           liquidationCursor: 250000000000000000n,
+     *           oracle: "0x0000000000000000000000000000000000008000",
+     *         },
+     *       ],
+     *       maturity: 54_000n,
+     *       rcfThreshold: 0n,
+     *       enterGate: "0x0000000000000000000000000000000000000000",
+     *       liquidatorGate: "0x0000000000000000000000000000000000000000",
+     *     },
+     *     totalUnits: 1_000n,
+     *     lossFactor: 0n,
+     *     withdrawable: 500n,
+     *     continuousFeeCredit: 0n,
+     *     settlementFeeCbps: [1, 2, 3, 4, 5, 6, 7],
+     *     continuousFee: 10,
+     *     tickSpacing: 4,
+     *   },
+     *   buy: true,
+     *   maker: "0x0000000000000000000000000000000000009000",
+     *   start: 0n,
+     *   expiry: 3_600n,
+     *   tick: 5_000n,
+     *   callback: "0x0000000000000000000000000000000000000000",
+     *   callbackData: "0x",
+     *   receiverIfMakerIsSeller: "0x0000000000000000000000000000000000000000",
+     *   ratifier: "0x0000000000000000000000000000000000004000",
+     *   reduceOnly: false,
+     *   maxUnits: 100n,
+     *   maxAssets: 0n,
+     *   continuousFeeCap: 317097919n,
+     * });
+     * const consumed = await readContract(client, {
+     *   address: "0x0000000000000000000000000000000000001000",
+     *   abi: midnightAbi,
+     *   functionName: "consumed",
+     *   args: [offer.maker, offer.group],
+     * });
+     * const units = offer.getConsumableUnits({ consumed, timestamp: 1_000n });
+     * console.log(units);
+     * ```
+     */
+    getConsumableUnits(params: {
+        readonly consumed: BigIntish;
+        readonly timestamp: BigIntish;
+    }): bigint;
     /**
      * Creates a validated maker-side Midnight offer.
      *
@@ -347,12 +547,14 @@ export declare class Offer {
      *
      * const offer = Offer.create({
      *   market: {
+     *     chainId: 8453,
+     *     midnight: "0x0000000000000000000000000000000000001000",
      *     loanToken,
      *     collateralParams: [
      *       {
      *         token: collateralToken,
      *         lltv: 770000000000000000n,
-     *         maxLif: 1061007957559681697n,
+     *         liquidationCursor: 250000000000000000n,
      *         oracle,
      *       },
      *     ],
@@ -390,12 +592,14 @@ export declare class Offer {
  *
  * const offer: OfferStruct = {
  *   market: {
+ *     chainId: 8453,
+ *     midnight: "0x0000000000000000000000000000000000001000",
  *     loanToken: "0x0000000000000000000000000000000000006000",
  *     collateralParams: [
  *       {
  *         token: "0x0000000000000000000000000000000000007000",
  *         lltv: 770000000000000000n,
- *         maxLif: 1061007957559681697n,
+ *         liquidationCursor: 250000000000000000n,
  *         oracle: "0x0000000000000000000000000000000000008000",
  *       },
  *     ],
@@ -470,12 +674,14 @@ export interface OfferStruct {
  *
  * const params: BuildOfferParams = {
  *   market: {
+ *     chainId: 8453,
+ *     midnight: "0x0000000000000000000000000000000000001000",
  *     loanToken: "0x0000000000000000000000000000000000006000",
  *     collateralParams: [
  *       {
  *         token: "0x0000000000000000000000000000000000007000",
  *         lltv: 770000000000000000n,
- *         maxLif: 1061007957559681697n,
+ *         liquidationCursor: 250000000000000000n,
  *         oracle: "0x0000000000000000000000000000000000008000",
  *       },
  *     ],
@@ -515,7 +721,7 @@ export interface BuildOfferParams {
     readonly maxUnits?: BigIntish;
     /** Maximum buyer or seller assets; defaults to zero. Exactly one of `maxUnits` and `maxAssets` must be non-zero. */
     readonly maxAssets?: BigIntish;
-    /** Maximum market continuous fee accepted by this offer; defaults to the protocol maximum. */
+    /** Maximum market continuous fee accepted by this offer; defaults to zero. */
     readonly continuousFeeCap?: BigIntish;
     /** Offer start timestamp; defaults to zero. */
     readonly start?: BigIntish;