@morpho-org/midnight-sdk 1.0.0 → 1.2.0

package/lib/esm/{market → position}/Position.d.ts

@@ -1,6 +1,6 @@
 import { type BigIntish } from "@morpho-org/morpho-ts";
-import type { Address } from "viem";
-import { type IMarket, Market } from "./Market.js";
+import type { Address, Hash } from "viem";
+import { type IMarket, Market } from "../market/Market.js";
 /**
  * Plain input accepted by {@link Position}.
  *
@@ -9,6 +9,8 @@ import { type IMarket, Market } from "./Market.js";
  * import type { IPosition } from "@morpho-org/midnight-sdk";
  *
  * const position: IPosition = {
+ *   user: "0x0000000000000000000000000000000000009000",
+ *   marketId: "0x0000000000000000000000000000000000000000000000000000000000000001",
  *   credit: 0n,
  *   pendingFee: 0n,
  *   lastLossFactor: 0n,
@@ -20,6 +22,10 @@ import { type IMarket, Market } from "./Market.js";
  * ```
  */
 export interface IPosition {
+    /** User holding this position. */
+    readonly user: Address;
+    /** Id of the market on which this position is held. */
+    readonly marketId: Hash;
     /** User credit. */
     readonly credit: BigIntish;
     /** Pending continuous fee. */
@@ -43,6 +49,8 @@ export interface IPosition {
  * import { Position } from "@morpho-org/midnight-sdk";
  *
  * const position = new Position({
+ *   user: "0x0000000000000000000000000000000000009000",
+ *   marketId: "0x0000000000000000000000000000000000000000000000000000000000000001",
  *   credit: 0n,
  *   pendingFee: 0n,
  *   lastLossFactor: 0n,
@@ -54,7 +62,11 @@ export interface IPosition {
  * console.log(position.debt);
  * ```
  */
-export declare class Position {
+export declare class Position implements IPosition {
+    /** User holding this position. */
+    readonly user: Address;
+    /** Id of the market on which this position is held. */
+    readonly marketId: Hash;
     /** User credit. */
     readonly credit: bigint;
     /** Pending continuous fee. */
@@ -79,6 +91,8 @@ export declare class Position {
      * import { Position } from "@morpho-org/midnight-sdk";
      *
      * const position = new Position({
+     *   user: "0x0000000000000000000000000000000000009000",
+     *   marketId: "0x0000000000000000000000000000000000000000000000000000000000000001",
      *   credit: 1_000n,
      *   pendingFee: 100n,
      *   lastLossFactor: 0n,
@@ -92,6 +106,9 @@ export declare class Position {
      */
     get faceValue(): bigint;
 }
+/** Plain input shape for a Midnight position paired with hydrated market state. */
+export interface IAccrualPosition extends Omit<IPosition, "marketId"> {
+}
 /**
  * Midnight position paired with its hydrated market.
  *
@@ -116,6 +133,7 @@ export declare class Position {
  *
  * const position = new AccrualPosition(
  *   {
+ *     user: "0x0000000000000000000000000000000000009000",
  *     credit: 1_000n,
  *     pendingFee: 100n,
  *     lastLossFactor: 0n,
@@ -154,10 +172,65 @@ export declare class Position {
  * console.log(position.market.id);
  * ```
  */
-export declare class AccrualPosition extends Position {
+export declare class AccrualPosition extends Position implements IAccrualPosition {
+    protected readonly _market: Market;
+    constructor(position: IAccrualPosition, market: IMarket | Market);
     /** Hydrated market for this position. */
-    readonly market: Market;
-    constructor(position: IPosition, market: IMarket | Market);
+    get market(): Market;
+    /**
+     * Returns the maximum credit units currently withdrawable from this position.
+     *
+     * The protocol capacity is limited by both the accrued position credit and
+     * the market's currently withdrawable liquidity. Default redemption flows may
+     * still choose the position face value.
+     *
+     * @returns Maximum credit units currently withdrawable.
+     * @example
+     * ```ts
+     * import { AccrualPosition } from "@morpho-org/midnight-sdk";
+     *
+     * const position = new AccrualPosition(
+     *   {
+     *     user: "0x0000000000000000000000000000000000009000",
+     *     credit: 1_000n,
+     *     pendingFee: 100n,
+     *     lastLossFactor: 0n,
+     *     lastAccrual: 1_000n,
+     *     debt: 0n,
+     *     collateralBitmap: 1n,
+     *     collateral: [50n],
+     *   },
+     *   {
+     *     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: 950n,
+     *     continuousFeeCredit: 0n,
+     *     settlementFeeCbps: [1, 2, 3, 4, 5, 6, 7],
+     *     continuousFee: 10,
+     *     tickSpacing: 4,
+     *   },
+     * );
+     * console.log(position.withdrawable); // 950n
+     * ```
+     */
+    get withdrawable(): bigint;
     /**
      * Returns the position collateral balance at an index configured by the market.
      *
@@ -184,6 +257,7 @@ export declare class AccrualPosition extends Position {
      *
      * const position = new AccrualPosition(
      *   {
+     *     user: "0x0000000000000000000000000000000000009000",
      *     credit: 1_000n,
      *     pendingFee: 100n,
      *     lastLossFactor: 0n,
@@ -251,6 +325,7 @@ export declare class AccrualPosition extends Position {
      * const collateralToken = "0x0000000000000000000000000000000000007000";
      * const position = new AccrualPosition(
      *   {
+     *     user: "0x0000000000000000000000000000000000009000",
      *     credit: 1_000n,
      *     pendingFee: 100n,
      *     lastLossFactor: 0n,
@@ -317,6 +392,7 @@ export declare class AccrualPosition extends Position {
      *
      * const position = new AccrualPosition(
      *   {
+     *     user: "0x0000000000000000000000000000000000009000",
      *     credit: 1_000n,
      *     pendingFee: 100n,
      *     lastLossFactor: 0n,
@@ -386,6 +462,7 @@ export declare class AccrualPosition extends Position {
      *
      * const position = new AccrualPosition(
      *   {
+     *     user: "0x0000000000000000000000000000000000009000",
      *     credit: 1_000n,
      *     pendingFee: 100n,
      *     lastLossFactor: 0n,

package/lib/esm/{market → position}/Position.js

@@ -1,6 +1,6 @@
 import { _try, MathLib } from "@morpho-org/morpho-ts";
 import { UnknownCollateralIndexError } from "../errors.js";
-import { Market } from "./Market.js";
+import { Market } from "../market/Market.js";
 import { PositionUtils } from "./PositionUtils.js";
 /**
  * Midnight user position as stored by the core contract.
@@ -10,6 +10,8 @@ import { PositionUtils } from "./PositionUtils.js";
  * import { Position } from "@morpho-org/midnight-sdk";
  *
  * const position = new Position({
+ *   user: "0x0000000000000000000000000000000000009000",
+ *   marketId: "0x0000000000000000000000000000000000000000000000000000000000000001",
  *   credit: 0n,
  *   pendingFee: 0n,
  *   lastLossFactor: 0n,
@@ -22,6 +24,10 @@ import { PositionUtils } from "./PositionUtils.js";
  * ```
  */
 export class Position {
+    /** User holding this position. */
+    user;
+    /** Id of the market on which this position is held. */
+    marketId;
     /** User credit. */
     credit;
     /** Pending continuous fee. */
@@ -37,6 +43,8 @@ export class Position {
     /** Collateral balances by index. */
     collateral;
     constructor(position) {
+        this.user = position.user;
+        this.marketId = position.marketId;
         this.credit = BigInt(position.credit);
         this.pendingFee = BigInt(position.pendingFee);
         this.lastLossFactor = BigInt(position.lastLossFactor);
@@ -54,6 +62,8 @@ export class Position {
      * import { Position } from "@morpho-org/midnight-sdk";
      *
      * const position = new Position({
+     *   user: "0x0000000000000000000000000000000000009000",
+     *   marketId: "0x0000000000000000000000000000000000000000000000000000000000000001",
      *   credit: 1_000n,
      *   pendingFee: 100n,
      *   lastLossFactor: 0n,
@@ -93,6 +103,7 @@ export class Position {
  *
  * const position = new AccrualPosition(
  *   {
+ *     user: "0x0000000000000000000000000000000000009000",
  *     credit: 1_000n,
  *     pendingFee: 100n,
  *     lastLossFactor: 0n,
@@ -132,11 +143,74 @@ export class Position {
  * ```
  */
 export class AccrualPosition extends Position {
-    /** Hydrated market for this position. */
-    market;
+    _market;
     constructor(position, market) {
-        super(position);
-        this.market = Market.from(market);
+        const _market = Market.from(market);
+        super({ ...position, marketId: _market.id });
+        this._market = _market;
+    }
+    /** Hydrated market for this position. */
+    get market() {
+        return this._market;
+    }
+    /**
+     * Returns the maximum credit units currently withdrawable from this position.
+     *
+     * The protocol capacity is limited by both the accrued position credit and
+     * the market's currently withdrawable liquidity. Default redemption flows may
+     * still choose the position face value.
+     *
+     * @returns Maximum credit units currently withdrawable.
+     * @example
+     * ```ts
+     * import { AccrualPosition } from "@morpho-org/midnight-sdk";
+     *
+     * const position = new AccrualPosition(
+     *   {
+     *     user: "0x0000000000000000000000000000000000009000",
+     *     credit: 1_000n,
+     *     pendingFee: 100n,
+     *     lastLossFactor: 0n,
+     *     lastAccrual: 1_000n,
+     *     debt: 0n,
+     *     collateralBitmap: 1n,
+     *     collateral: [50n],
+     *   },
+     *   {
+     *     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: 950n,
+     *     continuousFeeCredit: 0n,
+     *     settlementFeeCbps: [1, 2, 3, 4, 5, 6, 7],
+     *     continuousFee: 10,
+     *     tickSpacing: 4,
+     *   },
+     * );
+     * console.log(position.withdrawable); // 950n
+     * ```
+     */
+    get withdrawable() {
+        return PositionUtils.getWithdrawable({
+            position: this,
+            market: this.market,
+        });
     }
     /**
      * Returns the position collateral balance at an index configured by the market.
@@ -164,6 +238,7 @@ export class AccrualPosition extends Position {
      *
      * const position = new AccrualPosition(
      *   {
+     *     user: "0x0000000000000000000000000000000000009000",
      *     credit: 1_000n,
      *     pendingFee: 100n,
      *     lastLossFactor: 0n,
@@ -236,6 +311,7 @@ export class AccrualPosition extends Position {
      * const collateralToken = "0x0000000000000000000000000000000000007000";
      * const position = new AccrualPosition(
      *   {
+     *     user: "0x0000000000000000000000000000000000009000",
      *     credit: 1_000n,
      *     pendingFee: 100n,
      *     lastLossFactor: 0n,
@@ -305,6 +381,7 @@ export class AccrualPosition extends Position {
      *
      * const position = new AccrualPosition(
      *   {
+     *     user: "0x0000000000000000000000000000000000009000",
      *     credit: 1_000n,
      *     pendingFee: 100n,
      *     lastLossFactor: 0n,
@@ -376,6 +453,7 @@ export class AccrualPosition extends Position {
      *
      * const position = new AccrualPosition(
      *   {
+     *     user: "0x0000000000000000000000000000000000009000",
      *     credit: 1_000n,
      *     pendingFee: 100n,
      *     lastLossFactor: 0n,

package/lib/{cjs/market → esm/position}/PositionUtils.d.ts

@@ -1,5 +1,5 @@
 import { type BigIntish } from "@morpho-org/morpho-ts";
-import type { IMarket } from "./Market.js";
+import type { IMarket } from "../market/Market.js";
 import type { IPosition } from "./Position.js";
 /**
  * Domain helpers for Midnight positions.
@@ -10,6 +10,8 @@ import type { IPosition } from "./Position.js";
  *
  * const accrued = PositionUtils.accrueInterest({
  *   position: {
+ *     user: "0x0000000000000000000000000000000000009000",
+ *     marketId: "0x0000000000000000000000000000000000000000000000000000000000000001",
  *     credit: 1_000n,
  *     pendingFee: 100n,
  *     lastLossFactor: 0n,
@@ -50,6 +52,27 @@ import type { IPosition } from "./Position.js";
  * ```
  */
 export declare namespace PositionUtils {
+    /**
+     * Returns the maximum credit units currently withdrawable by a position.
+     *
+     * @param params.position - Position whose credit limits the withdrawal.
+     * @param params.market - Market whose available liquidity limits the withdrawal.
+     * @returns The lower of the position credit and market withdrawable liquidity.
+     * @example
+     * ```ts
+     * import { PositionUtils } from "@morpho-org/midnight-sdk";
+     *
+     * const withdrawable = PositionUtils.getWithdrawable({
+     *   position: { credit: 1_000n },
+     *   market: { withdrawable: 500n },
+     * });
+     * console.log(withdrawable); // 500n
+     * ```
+     */
+    function getWithdrawable(params: {
+        readonly position: Pick<IPosition, "credit">;
+        readonly market: Pick<IMarket, "withdrawable">;
+    }): bigint;
     /**
      * Returns plain Midnight position and market objects accrued like Midnight `updatePositionView`.
      *
@@ -66,6 +89,8 @@ export declare namespace PositionUtils {
      *
      * const { position, market } = PositionUtils.accrueInterest({
      *   position: {
+     *     user: "0x0000000000000000000000000000000000009000",
+     *     marketId: "0x0000000000000000000000000000000000000000000000000000000000000001",
      *     credit: 1_000n,
      *     pendingFee: 100n,
      *     lastLossFactor: 0n,

package/lib/esm/{market → position}/PositionUtils.js

@@ -9,6 +9,8 @@ import { InvalidPositionAccrualStateError, InvalidPositionAccrualTimestampError,
  *
  * const accrued = PositionUtils.accrueInterest({
  *   position: {
+ *     user: "0x0000000000000000000000000000000000009000",
+ *     marketId: "0x0000000000000000000000000000000000000000000000000000000000000001",
  *     credit: 1_000n,
  *     pendingFee: 100n,
  *     lastLossFactor: 0n,
@@ -50,6 +52,27 @@ import { InvalidPositionAccrualStateError, InvalidPositionAccrualTimestampError,
  */
 export var PositionUtils;
 (function (PositionUtils) {
+    /**
+     * Returns the maximum credit units currently withdrawable by a position.
+     *
+     * @param params.position - Position whose credit limits the withdrawal.
+     * @param params.market - Market whose available liquidity limits the withdrawal.
+     * @returns The lower of the position credit and market withdrawable liquidity.
+     * @example
+     * ```ts
+     * import { PositionUtils } from "@morpho-org/midnight-sdk";
+     *
+     * const withdrawable = PositionUtils.getWithdrawable({
+     *   position: { credit: 1_000n },
+     *   market: { withdrawable: 500n },
+     * });
+     * console.log(withdrawable); // 500n
+     * ```
+     */
+    function getWithdrawable(params) {
+        return MathLib.min(BigInt(params.position.credit), BigInt(params.market.withdrawable));
+    }
+    PositionUtils.getWithdrawable = getWithdrawable;
     /**
      * Returns plain Midnight position and market objects accrued like Midnight `updatePositionView`.
      *
@@ -66,6 +89,8 @@ export var PositionUtils;
      *
      * const { position, market } = PositionUtils.accrueInterest({
      *   position: {
+     *     user: "0x0000000000000000000000000000000000009000",
+     *     marketId: "0x0000000000000000000000000000000000000000000000000000000000000001",
      *     credit: 1_000n,
      *     pendingFee: 100n,
      *     lastLossFactor: 0n,
@@ -169,6 +194,8 @@ export var PositionUtils;
         ];
         return {
             position: {
+                user: params.position.user,
+                marketId: params.position.marketId,
                 credit: postSlashCredit - accruedFee,
                 pendingFee: postSlashPendingFee - accruedFee,
                 lastLossFactor: marketLossFactor,

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

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

package/lib/esm/position/index.js

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

package/lib/esm/signatures/EcrecoverRatifierUtils.d.ts

@@ -1,5 +1,6 @@
 import { type BigIntish } from "@morpho-org/morpho-ts";
 import { type Account, type Address, type Chain, type Client, type Hash, type Hex, type Signature, type Transport } from "viem";
+import { type IOffer } from "../offers/index.js";
 import type { Payload } from "./Payload.js";
 import { type RatifierTreeInput, type TreeProof } from "./TreeUtils.js";
 declare const typedDataTypes: {
@@ -365,6 +366,40 @@ export interface EcrecoverRatifierDataParams {
     /** Ecrecover signature for the tree root. */
     readonly signature: EcrecoverSignatureInput;
 }
+/** Parameters for reconstructing an EcrecoverRatifier digest from decoded ratifier data fields. */
+export interface EcrecoverRatifierRootDigestParams {
+    /** Observed EIP-155 chain id from the log or execution context. Must match `offer.market.chainId`. */
+    readonly chainId: BigIntish;
+    /** Offer whose ratifier address and market chain id define the EIP-712 domain. */
+    readonly offer: IOffer;
+    /** Merkle root embedded in the ratifier data. */
+    readonly root: Hash;
+    /** Number of sibling hashes in the Merkle proof. */
+    readonly proofLength: number;
+}
+/** Parameters for reconstructing an EcrecoverRatifier digest from encoded ratifier data. */
+export interface EcrecoverRatifierDataDigestParams {
+    /** Observed EIP-155 chain id from the log or execution context. Must match `offer.market.chainId`. */
+    readonly chainId: BigIntish;
+    /** Offer carried by the payload item. */
+    readonly offer: IOffer;
+    /** ABI-encoded Ecrecover ratifier data carried by the payload item. */
+    readonly ratifierData: Hex;
+}
+/** Parameters for locally verifying Ecrecover ratifier data attached to one payload item. */
+export interface EcrecoverRatifierDataVerificationParams {
+    /** Observed EIP-155 chain id from the log or execution context. Must match `offer.market.chainId`. */
+    readonly chainId: BigIntish;
+    /** Offer carried by the payload item. */
+    readonly offer: IOffer;
+    /** ABI-encoded Ecrecover ratifier data carried by the payload item. */
+    readonly ratifierData: Hex;
+}
+/** Decoded Ecrecover ratifier data after local proof verification and signature recovery. */
+export interface VerifiedEcrecoverRatifierData extends DecodedEcrecoverRatifierData {
+    /** Signer recovered from the Ecrecover typed-data digest. */
+    readonly signer: Address;
+}
 /**
  * EcrecoverRatifier-specific pure utilities.
  *
@@ -501,6 +536,89 @@ export declare namespace EcrecoverRatifierUtils {
      * ```
      */
     function digest(params: EcrecoverRatifierTypedDataParams): `0x${string}`;
+    /**
+     * Builds the EcrecoverRatifier digest from a payload offer, root, and proof height.
+     *
+     * Use this on the take-side or in indexers after decoding ratifier data, when
+     * the original full tree is not available but the payload item includes the
+     * offer and proof metadata needed to reconstruct the signed digest. Pass the
+     * observed log or execution chain id so cross-chain-spoofed payloads are
+     * rejected before signature recovery.
+     *
+     * @param params.chainId - Observed EIP-155 chain id from the log or execution context.
+     * @param params.offer - Offer carried by the payload item.
+     * @param params.root - Merkle root embedded in the ratifier data.
+     * @param params.proofLength - Number of sibling hashes in the Merkle proof.
+     * @returns EIP-712 digest signed by the maker or authorized signer.
+     * @throws {ChainIdMismatchError} when `params.chainId` does not match `offer.market.chainId`.
+     * @throws {InvalidTreeHeightError} when `proofLength` exceeds 20.
+     * @example
+     * ```ts
+     * import { EcrecoverRatifierUtils } from "@morpho-org/midnight-sdk";
+     * import { zeroHash } from "viem";
+     *
+     * const digest = EcrecoverRatifierUtils.digestForRoot({
+     *   chainId: 8453n,
+     *   offer,
+     *   root: zeroHash,
+     *   proofLength: 0,
+     * });
+     * console.log(digest);
+     * ```
+     */
+    function digestForRoot(params: EcrecoverRatifierRootDigestParams): Hash;
+    /**
+     * Builds the EcrecoverRatifier digest from one payload item's encoded ratifier data.
+     *
+     * @param params.chainId - Observed EIP-155 chain id from the log or execution context.
+     * @param params.offer - Offer carried by the payload item.
+     * @param params.ratifierData - ABI-encoded Ecrecover ratifier data.
+     * @returns EIP-712 digest signed by the maker or authorized signer.
+     * @throws {ChainIdMismatchError} when `params.chainId` does not match `offer.market.chainId`.
+     * @throws {InvalidTreeHeightError} when the proof height exceeds 20.
+     * @example
+     * ```ts
+     * import { EcrecoverRatifierUtils } from "@morpho-org/midnight-sdk";
+     *
+     * const digest = EcrecoverRatifierUtils.digestRatifierData({
+     *   chainId: 8453n,
+     *   offer,
+     *   ratifierData,
+     * });
+     * console.log(digest);
+     * ```
+     */
+    function digestRatifierData(params: EcrecoverRatifierDataDigestParams): Hash;
+    /**
+     * Verifies an Ecrecover ratifier-data proof and recovers its signer.
+     *
+     * This helper intentionally does not check `Midnight.isAuthorized` or
+     * `EcrecoverRatifier.isRootCanceled` state. Consumers must query both at the
+     * observed block before treating a recovered item as executable: the returned
+     * signer must be the maker or authorized by the maker, the offer ratifier must
+     * be authorized by the maker, and `isRootCanceled(maker, root)` must be false.
+     *
+     * @param params.chainId - Observed EIP-155 chain id from the log or execution context.
+     * @param params.offer - Offer carried by the payload item.
+     * @param params.ratifierData - ABI-encoded Ecrecover ratifier data.
+     * @returns Decoded ratifier data plus recovered signer.
+     * @throws {ChainIdMismatchError} when `params.chainId` does not match `offer.market.chainId`.
+     * @throws {InvalidEcrecoverSignatureVError} when the decoded signature `v` is not 27 or 28.
+     * @throws {InvalidTreeError} when the proof does not include `offer` in `root`.
+     * @throws {InvalidTreeHeightError} when the proof height exceeds 20.
+     * @example
+     * ```ts
+     * import { EcrecoverRatifierUtils } from "@morpho-org/midnight-sdk";
+     *
+     * const verified = await EcrecoverRatifierUtils.verifyRatifierData({
+     *   chainId: 8453n,
+     *   offer,
+     *   ratifierData,
+     * });
+     * console.log(verified.signer);
+     * ```
+     */
+    function verifyRatifierData(params: EcrecoverRatifierDataVerificationParams): Promise<VerifiedEcrecoverRatifierData>;
     /**
      * Signs EcrecoverRatifier typed data through a viem client.
      *