@morpho-org/midnight-sdk 0.1.0 → 1.1.1

package/lib/esm/offers/Offer.js

@@ -1,5 +1,5 @@
 import { zeroAddress } from "viem";
-import { MarketParams, } from "../market/index.js";
+import { Market, MarketParams, } from "../market/index.js";
 import { OfferUtils } from "./OfferUtils.js";
 /**
  * Maker-side Midnight offer.
@@ -19,12 +19,14 @@ import { OfferUtils } from "./OfferUtils.js";
  *
  * const offer = Offer.create({
  *   market: {
+ *     chainId: 8453,
+ *     midnight: "0x0000000000000000000000000000000000001000",
  *     loanToken: "0x0000000000000000000000000000000000000001",
  *     collateralParams: [
  *       {
  *         token: "0x0000000000000000000000000000000000007000",
  *         lltv: 770000000000000000n,
- *         maxLif: 1061007957559681697n,
+ *         liquidationCursor: 250000000000000000n,
  *         oracle: "0x0000000000000000000000000000000000008000",
  *       },
  *     ],
@@ -82,7 +84,10 @@ export class Offer {
     /** Maximum market continuous fee accepted by this offer. */
     continuousFeeCap;
     constructor(offer) {
-        this.market = MarketParams.from(offer.market);
+        this.market =
+            "params" in offer.market
+                ? Market.from(offer.market)
+                : MarketParams.from(offer.market);
         this.buy = offer.buy;
         this.maker = offer.maker;
         this.start = BigInt(offer.start);
@@ -114,12 +119,14 @@ export class Offer {
      *
      * const offer = Offer.from({
      *   market: {
+     *     chainId: 8453,
+     *     midnight: "0x0000000000000000000000000000000000001000",
      *     loanToken: "0x0000000000000000000000000000000000006000",
      *     collateralParams: [
      *       {
      *         token: "0x0000000000000000000000000000000000007000",
      *         lltv: 770000000000000000n,
-     *         maxLif: 1061007957559681697n,
+     *         liquidationCursor: 250000000000000000n,
      *         oracle: "0x0000000000000000000000000000000000008000",
      *       },
      *     ],
@@ -169,12 +176,14 @@ export class Offer {
      *
      * const offer = Offer.create({
      *   market: {
+     *     chainId: 8453,
+     *     midnight: "0x0000000000000000000000000000000000001000",
      *     loanToken,
      *     collateralParams: [
      *       {
      *         token: collateralToken,
      *         lltv: 770000000000000000n,
-     *         maxLif: 1061007957559681697n,
+     *         liquidationCursor: 250000000000000000n,
      *         oracle,
      *       },
      *     ],
@@ -192,7 +201,7 @@ export class Offer {
      * });
      *
      * const group = offer.group;
-     * // group satisfies Hash
+     * console.log(group);
      * ```
      */
     get group() {
@@ -219,12 +228,14 @@ export class Offer {
      *
      * const offer = Offer.create({
      *   market: {
+     *     chainId: 8453,
+     *     midnight: "0x0000000000000000000000000000000000001000",
      *     loanToken,
      *     collateralParams: [
      *       {
      *         token: collateralToken,
      *         lltv: 770000000000000000n,
-     *         maxLif: 1061007957559681697n,
+     *         liquidationCursor: 250000000000000000n,
      *         oracle,
      *       },
      *     ],
@@ -249,6 +260,201 @@ export class Offer {
         this.cachedHash ??= OfferUtils.hash(this);
         return this.cachedHash;
     }
+    /**
+     * 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() {
+        return OfferUtils.getPrice(this);
+    }
+    /**
+     * 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) {
+        return OfferUtils.getRate({ offer: this, timestamp });
+    }
+    /**
+     * 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) {
+        return OfferUtils.getApr({ offer: this, timestamp });
+    }
+    /**
+     * 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) {
+        return OfferUtils.getConsumableUnits({ offer: this, ...params });
+    }
     /**
      * Creates a validated maker-side Midnight offer.
      *
@@ -291,12 +497,14 @@ export class Offer {
      *
      * const offer = Offer.create({
      *   market: {
+     *     chainId: 8453,
+     *     midnight: "0x0000000000000000000000000000000000001000",
      *     loanToken,
      *     collateralParams: [
      *       {
      *         token: collateralToken,
      *         lltv: 770000000000000000n,
-     *         maxLif: 1061007957559681697n,
+     *         liquidationCursor: 250000000000000000n,
      *         oracle,
      *       },
      *     ],