@morpho-org/midnight-sdk 0.1.0 → 1.0.0

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

@@ -1,8 +1,7 @@
 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 { Item as PayloadItem } from "./Payload.js";
-import type { Tree } from "./Tree.js";
-import type { TreeProof } from "./TreeUtils.js";
+import type { Payload } from "./Payload.js";
+import { type RatifierTreeInput, type TreeProof } from "./TreeUtils.js";
 declare const typedDataTypes: {
     readonly EIP712Domain: readonly [{
         readonly name: "chainId";
@@ -18,13 +17,19 @@ declare const typedDataTypes: {
         readonly name: "lltv";
         readonly type: "uint256";
     }, {
-        readonly name: "maxLif";
+        readonly name: "liquidationCursor";
         readonly type: "uint256";
     }, {
         readonly name: "oracle";
         readonly type: "address";
     }];
     readonly Market: readonly [{
+        readonly name: "chainId";
+        readonly type: "uint256";
+    }, {
+        readonly name: "midnight";
+        readonly type: "address";
+    }, {
         readonly name: "loanToken";
         readonly type: "address";
     }, {
@@ -81,10 +86,10 @@ declare const typedDataTypes: {
         readonly type: "bool";
     }, {
         readonly name: "maxUnits";
-        readonly type: "uint256";
+        readonly type: "uint128";
     }, {
         readonly name: "maxAssets";
-        readonly type: "uint256";
+        readonly type: "uint128";
     }, {
         readonly name: "continuousFeeCap";
         readonly type: "uint256";
@@ -132,12 +137,14 @@ export interface DecodedEcrecoverRatifierData extends TreeProof {
  *
  * const offer = Offer.create({
  *   market: {
+ *     chainId: 8453,
+ *     midnight: "0x0000000000000000000000000000000000001000",
  *     loanToken: "0x0000000000000000000000000000000000006000",
  *     collateralParams: [
  *       {
  *         token: "0x0000000000000000000000000000000000007000",
  *         lltv: 770000000000000000n,
- *         maxLif: 1061007957559681697n,
+ *         liquidationCursor: 250000000000000000n,
  *         oracle: "0x0000000000000000000000000000000000008000",
  *       },
  *     ],
@@ -208,12 +215,14 @@ export type EcrecoverSignatureInput = Hex | Signature | Signature<number, number
  *
  * const offer = Offer.create({
  *   market: {
+ *     chainId: 8453,
+ *     midnight: "0x0000000000000000000000000000000000001000",
  *     loanToken: "0x0000000000000000000000000000000000006000",
  *     collateralParams: [
  *       {
  *         token: "0x0000000000000000000000000000000000007000",
  *         lltv: 770000000000000000n,
- *         maxLif: 1061007957559681697n,
+ *         liquidationCursor: 250000000000000000n,
  *         oracle: "0x0000000000000000000000000000000000008000",
  *       },
  *     ],
@@ -237,8 +246,8 @@ export type EcrecoverSignatureInput = Hex | Signature | Signature<number, number
  * ```
  */
 export interface EcrecoverRatifierTypedDataParams {
-    /** Tree being ratified. */
-    readonly tree: Tree;
+    /** Tree-like input being ratified. Existing `Tree` instances reuse cached hashes and proofs. */
+    readonly tree: RatifierTreeInput;
     /** Chain id used by the EIP-712 domain. */
     readonly chainId: BigIntish;
 }
@@ -246,7 +255,7 @@ export interface EcrecoverRatifierTypedDataParams {
  * Parameters for {@link EcrecoverRatifierUtils.ratify}.
  *
  * Use this after tree validation. Provide either a signing client plus account
- * or a signature that was produced from `typedData`.
+ * or a precomputed signature plus the account that produced it.
  *
  * @example
  * ```ts
@@ -255,12 +264,14 @@ export interface EcrecoverRatifierTypedDataParams {
  *
  * const offer = Offer.create({
  *   market: {
+ *     chainId: 8453,
+ *     midnight: "0x0000000000000000000000000000000000001000",
  *     loanToken: "0x0000000000000000000000000000000000006000",
  *     collateralParams: [
  *       {
  *         token: "0x0000000000000000000000000000000000007000",
  *         lltv: 770000000000000000n,
- *         maxLif: 1061007957559681697n,
+ *         liquidationCursor: 250000000000000000n,
  *         oracle: "0x0000000000000000000000000000000000008000",
  *       },
  *     ],
@@ -278,14 +289,15 @@ export interface EcrecoverRatifierTypedDataParams {
  * });
  * const params: EcrecoverRatifierRatifyParams = {
  *   tree: Tree.create([offer]),
+ *   account: "0x0000000000000000000000000000000000009000",
  *   signature: { v: 27, r: zeroHash, s: zeroHash },
  * };
  * console.log(params.tree);
  * ```
  */
 export type EcrecoverRatifierRatifyParams = {
-    /** Tree being ratified. */
-    readonly tree: Tree;
+    /** Tree-like input being ratified. */
+    readonly tree: RatifierTreeInput;
     /** Viem client whose transport signs the typed data built from `tree`. */
     readonly client: Client<Transport, Chain, Account | undefined>;
     /** Account that signs the tree root. It may be the maker or an address authorized by each maker. */
@@ -293,15 +305,15 @@ export type EcrecoverRatifierRatifyParams = {
     /** Omit when the SDK should request the signature through `client`. */
     readonly signature?: undefined;
 } | {
-    /** Tree being ratified. */
-    readonly tree: Tree;
+    /** Tree-like input being ratified. */
+    readonly tree: RatifierTreeInput;
     /** Precomputed signature for this tree root. */
     readonly signature: EcrecoverSignatureInput;
+    /** Account that produced the signature. It may be the maker or an address authorized by each maker. */
+    readonly account: Account | Address;
     /** Omit when a precomputed signature is supplied. */
     readonly client?: undefined;
     /** Omit when a precomputed signature is supplied. */
-    readonly account?: undefined;
-    /** Omit when a precomputed signature is supplied. */
     readonly chainId?: undefined;
 };
 /**
@@ -314,12 +326,14 @@ export type EcrecoverRatifierRatifyParams = {
  *
  * const offer = Offer.create({
  *   market: {
+ *     chainId: 8453,
+ *     midnight: "0x0000000000000000000000000000000000001000",
  *     loanToken: "0x0000000000000000000000000000000000006000",
  *     collateralParams: [
  *       {
  *         token: "0x0000000000000000000000000000000000007000",
  *         lltv: 770000000000000000n,
- *         maxLif: 1061007957559681697n,
+ *         liquidationCursor: 250000000000000000n,
  *         oracle: "0x0000000000000000000000000000000000008000",
  *       },
  *     ],
@@ -344,8 +358,8 @@ export type EcrecoverRatifierRatifyParams = {
  * ```
  */
 export interface EcrecoverRatifierDataParams {
-    /** Tree that produced the proof. */
-    readonly tree: Tree;
+    /** Tree-like input that produced the proof. Existing `Tree` instances reuse cached hashes and proofs. */
+    readonly tree: RatifierTreeInput;
     /** Leaf index to prove. */
     readonly leafIndex: BigIntish;
     /** Ecrecover signature for the tree root. */
@@ -359,7 +373,10 @@ export interface EcrecoverRatifierDataParams {
  * validate the tree, sign the typed data, call `ratify`, then pass the returned
  * items to `Payload.encode`. Ecrecover trees must contain one ratifier; split
  * trees by ratifier before signing. The signer may be the maker or an address
- * authorized by every maker in the tree.
+ * authorized by every maker in the tree. Ratifier helpers accept tree-like
+ * inputs rather than requiring the `Tree` class. Passing an existing `Tree`
+ * remains the optimal path because its cached offers, leaves, root, and height
+ * are reused for typed data and per-leaf proofs.
  *
  * @example
  * ```ts
@@ -382,16 +399,16 @@ export declare namespace EcrecoverRatifierUtils {
      * console.log(EcrecoverRatifierUtils.treeTypeHash(0));
      * ```
      */
-    function treeTypeHash(height: number): "0xc27c38e446b48c820ab9c4373dc63a4a750a08165cb4bb488206ebabe045d650" | "0x4e15d8736f4406e07bf9844b1653474472a827130c61e899bf1f574a88b8d987" | "0x46d107447b480c38ef5b7f54603dba0cb23b887f302b01a998b9d8a80320dd53" | "0xd1f3607a8e81454bb3baf5f898274ab47541fffc690278a74f13e174e116be72" | "0xb2d98adca9d116c9bc02ce59ec599ac3c2d33db1c0d1217c7e411d9198d427be" | "0x5931e0597fcf986027f3118b2495a9ac22139d133f9ad2c2198e6738dc3886c5" | "0x3967d37928614a085b47e8758fbc3869a8aed63bdf60ccee8536ff2b5064da06" | "0xd6b9f5f45915a260f6e521d9b40f86c385730b6bc330590fcde212e2fea64263" | "0x080caa519dbd5328c119d9907e0fa3d9a50dc2ae4bf6dd42c93c100dbc89b51a" | "0x45da471048924165ea2ad1855ba940e454b486e71dcf1666c71a928c8844c419" | "0xa49a9434fc1836bd08097368325b31039b6a0fd44919f53e4d8f4bf814084cb0" | "0xd3e93e4525132f0187a6964dc01fef33fde414538ffd212e9f2f478c3263e0a0" | "0x25990db2d26547f92c711988300df317af57bad5cd5d9d8e787a82f95c929474" | "0x8e0c648afa977572ead40a1d10a6db2c425b8099545006d834a7b849c6166643" | "0x4b635250efa6243e277fdd0cf6df993c2943b64f10f3a0756ceb1f47ef8f9b18" | "0xbde1c927f6222c07c8df264e68b42b8382c7c2b85f4729e0df94297cfeebfa91" | "0x4d58aea1a67f94be21ab1415bf3b602592430eb9112268fd0fc4e141b1a35e76" | "0x14c03281bce13010b158e5a4a3378be394ac9e16118aedb17d82ced51e66836c" | "0x99fd3e76f43b2cc221cb9860bc6c96cda95af3fa07ef5f04e071b54aa9386d06" | "0x1b1c2f1a04968094d8d0453d49838f7a809d1202ae04a1c2e0964e442ff7988b" | "0xc8ccd3cb3267dd76f563584920ac60f2283b719917481b85fe5e10b754932455";
+    function treeTypeHash(height: number): "0x270da1ebafc0f24637af3612fb8c3a1d828fcb56d3637c24e86dd006b12ca7f9" | "0x828b9cdf8326a1cf234328e4d5229546a98fb72ef73624f5b6b31538e555b96c" | "0xfcb7a3ca4094246b8185620c4cf025c93032b6f0384805aa3f22afe04290e982" | "0xcc97cb1955496a5269b5a7afca62ba694edcab26ba838a1adbd257931249de92" | "0xda3feb08db360ad9e09540132ff04d2b6a596fdaa4747892217aaa4c7c9bcc31" | "0x15bd6e2aa1a7a61614187ac16d2cbf8610c8f2f3c3d9eaa380ae7a501ee3cf06" | "0xb726cb7fab1a24c28213cbd482fa5a301f127fb25feb01da341919983a72711a" | "0xcea9cd557c6f821868ea287304199d0e0554af630bfa8fe36c64eb3bbacca418" | "0xf7dbde8234e8e345cec8fc0a8ac5909ee336b214882751ecd51e7b37df4f6cdd" | "0x5400a5d43d39e6bfe910af8cb84ac77bf501d310413769dffd62ccecda8b00c6" | "0x0754209b60d99d0822b3ecd5a970f9db09df9c8998a8441e24b81f06d6c76fee" | "0xf5d561d88647c3b38ed6636709d3166819fc66f8ed52a0daf4ae186387b4646c" | "0x5801c07a6c7df039ce00a7a2b8bd92aa1cf333c30b0bc3d78768590b6063d09e" | "0xc9da7190eaf4b14c7cb1c14f9898256c0adb6b1dc303afe79594dea64fe199c0" | "0xa47534c85ac57c583568465d40fd46683d2d558d8129fe1aca01e93023afca92" | "0xb1e841691fb54f4ef85e2ed9de45d610e57f49e1e6eb2510ceead16e447dd519" | "0x4fa4f16f09f0c36c7670449a4032073380d28a60071e12ee8874bb3e5a8318fc" | "0x817bbaac8bb863670f488b454cdd5d0990d9d81871a68e9df381c3c13d3f2ba2" | "0xc447f06079bddf4b011523c4bce119e9e90fdf937de4ee88f48010406560e9c1" | "0x1608d5eb56943c667c34b413f9f8a1c24a84ddfe1301a9c25487e638de1f5822" | "0x3a677100d2e855c24a62d1e9c365bff90d02287f066a07064843ca1ee70ea113";
     /**
-     * Builds EcrecoverRatifier typed data for a tree.
+     * Builds EcrecoverRatifier typed data for a tree-like input.
      *
      * Use after the tree is built and validated, before requesting the signer
      * signature. The EIP-712 verifier is derived from the shared ratifier address
      * on the tree offers. `ratify` calls this for you when given a client and
      * account.
      *
-     * @param params.tree - Ecrecover-ratified offer tree to sign.
+     * @param params.tree - Ecrecover-ratified offer tree-like input to sign.
      * @param params.chainId - EIP-155 chain id included in the EIP-712 domain.
      * @returns EIP-712 typed-data descriptor.
      * @throws {InvalidTreeError} when the tree is invalid or contains multiple ratifiers.
@@ -404,12 +421,14 @@ export declare namespace EcrecoverRatifierUtils {
      *
      * const offer = Offer.create({
      *   market: {
+     *     chainId: 8453,
+     *     midnight: "0x0000000000000000000000000000000000001000",
      *     loanToken: "0x0000000000000000000000000000000000006000",
      *     collateralParams: [
      *       {
      *         token: "0x0000000000000000000000000000000000007000",
      *         lltv: 770000000000000000n,
-     *         maxLif: 1061007957559681697n,
+     *         liquidationCursor: 250000000000000000n,
      *         oracle: "0x0000000000000000000000000000000000008000",
      *       },
      *     ],
@@ -437,7 +456,7 @@ export declare namespace EcrecoverRatifierUtils {
     /**
      * Builds the EcrecoverRatifier digest used by the Solidity ratifier.
      *
-     * @param params.tree - Ecrecover-ratified offer tree to hash.
+     * @param params.tree - Ecrecover-ratified offer tree-like input to hash.
      * @param params.chainId - EIP-155 chain id included in the EIP-712 domain.
      * @returns EIP-712 digest.
      * @throws {InvalidTreeError} when the tree contains multiple ratifiers.
@@ -450,12 +469,14 @@ export declare namespace EcrecoverRatifierUtils {
      *
      * const offer = Offer.create({
      *   market: {
+     *     chainId: 8453,
+     *     midnight: "0x0000000000000000000000000000000000001000",
      *     loanToken: "0x0000000000000000000000000000000000006000",
      *     collateralParams: [
      *       {
      *         token: "0x0000000000000000000000000000000000007000",
      *         lltv: 770000000000000000n,
-     *         maxLif: 1061007957559681697n,
+     *         liquidationCursor: 250000000000000000n,
      *         oracle: "0x0000000000000000000000000000000000008000",
      *       },
      *     ],
@@ -488,12 +509,13 @@ export declare namespace EcrecoverRatifierUtils {
      * client and account. The account may be the maker or an address authorized
      * by every maker in the tree; the protocol checks that authorization onchain.
      *
-     * @param params.tree - Ecrecover-ratified offer tree to sign.
+     * @param params.tree - Ecrecover-ratified offer tree-like input to sign.
      * @param params.client - Viem client whose transport signs the tree typed data.
      * @param params.account - Account used to sign the tree typed data.
      * @returns Signature returned by the client.
-     * @throws {InvalidTreeError} when the tree is invalid or contains multiple ratifiers.
+     * @throws {InvalidTreeError} when the tree is invalid, contains multiple ratifiers, or spans multiple chain ids.
      * @throws {InvalidTreeHeightError} when the tree height is unsupported.
+     * @throws {ChainIdMismatchError} when `params.client.chain?.id` does not match the tree offer chain id.
      * @throws {InvalidTypedDataSignatureError} when the returned signature does not recover to `params.account`.
      * @example
      * ```ts
@@ -504,12 +526,14 @@ export declare namespace EcrecoverRatifierUtils {
      *
      * const offer = Offer.create({
      *   market: {
+     *     chainId: 8453,
+     *     midnight: "0x0000000000000000000000000000000000001000",
      *     loanToken: "0x0000000000000000000000000000000000006000",
      *     collateralParams: [
      *       {
      *         token: "0x0000000000000000000000000000000000007000",
      *         lltv: 770000000000000000n,
-     *         maxLif: 1061007957559681697n,
+     *         liquidationCursor: 250000000000000000n,
      *         oracle: "0x0000000000000000000000000000000000008000",
      *       },
      *     ],
@@ -539,7 +563,7 @@ export declare namespace EcrecoverRatifierUtils {
      * ```
      */
     function sign(params: {
-        readonly tree: Tree;
+        readonly tree: RatifierTreeInput;
         readonly client: Client<Transport, Chain, Account | undefined>;
         readonly account: Account | Address;
     }): Promise<Hex>;
@@ -628,7 +652,7 @@ export declare namespace EcrecoverRatifierUtils {
      * Use after a tree has been signed when a caller needs data for one offer
      * leaf. Use `ratify` to produce payload-ready items for the whole tree.
      *
-     * @param params.tree - Ecrecover-ratified offer tree that produced the proof.
+     * @param params.tree - Ecrecover-ratified offer tree-like input that produced the proof.
      * @param params.leafIndex - Leaf index to prove.
      * @param params.signature - Ecrecover signature for the tree root.
      * @returns ABI-encoded EcrecoverRatifier data.
@@ -640,12 +664,14 @@ export declare namespace EcrecoverRatifierUtils {
      *
      * const offer = Offer.create({
      *   market: {
+     *     chainId: 8453,
+     *     midnight: "0x0000000000000000000000000000000000001000",
      *     loanToken: "0x0000000000000000000000000000000000006000",
      *     collateralParams: [
      *       {
      *         token: "0x0000000000000000000000000000000000007000",
      *         lltv: 770000000000000000n,
-     *         maxLif: 1061007957559681697n,
+     *         liquidationCursor: 250000000000000000n,
      *         oracle: "0x0000000000000000000000000000000000008000",
      *       },
      *     ],
@@ -677,14 +703,14 @@ export declare namespace EcrecoverRatifierUtils {
      * The returned items preserve tree leaf order and include ratifier data
      * required by takers. The group id is stored on each inline offer.
      *
-     * @param params.tree - Ecrecover-ratified offer tree to ratify.
+     * @param params.tree - Ecrecover-ratified offer tree-like input to ratify.
      * @param params.client - Optional viem client whose transport signs typed data built from `params.tree`.
      * @param params.account - Optional account used to sign typed data built from `params.tree`.
      * @param params.signature - Optional precomputed signature for `params.tree`.
      * @returns Items containing each offer and its ratifier data.
      * @throws {InvalidTreeError} when the tree is invalid or contains multiple ratifiers.
      * @throws {InvalidTreeHeightError} when the tree height is unsupported.
-     * @throws {InvalidTypedDataSignatureError} when client signing returns a signature that does not recover to `params.account`.
+     * @throws {InvalidTypedDataSignatureError} when client signing or a precomputed signature does not recover to `params.account`.
      * @example
      * ```ts
      * import { EcrecoverRatifierUtils, Tree } from "@morpho-org/midnight-sdk";
@@ -694,12 +720,14 @@ export declare namespace EcrecoverRatifierUtils {
      *
      * const offer = Offer.create({
      *   market: {
+     *     chainId: 8453,
+     *     midnight: "0x0000000000000000000000000000000000001000",
      *     loanToken: "0x0000000000000000000000000000000000006000",
      *     collateralParams: [
      *       {
      *         token: "0x0000000000000000000000000000000000007000",
      *         lltv: 770000000000000000n,
-     *         maxLif: 1061007957559681697n,
+     *         liquidationCursor: 250000000000000000n,
      *         oracle: "0x0000000000000000000000000000000000008000",
      *       },
      *     ],
@@ -728,6 +756,6 @@ export declare namespace EcrecoverRatifierUtils {
      * console.log(items.length);
      * ```
      */
-    function ratify(params: EcrecoverRatifierRatifyParams): Promise<readonly PayloadItem[]>;
+    function ratify(params: EcrecoverRatifierRatifyParams): Promise<readonly Payload.Item[]>;
 }
 export {};