@morpho-dev/router 0.1.16 → 0.1.18

package/dist/index.browser.d.cts

@@ -21,28 +21,24 @@ declare const ChainHealth: z$1.ZodObject<{
     block_number: z$1.ZodNumber;
     updated_at: z$1.ZodString;
 }, z$1.core.$strip>;
-declare const CollectorsHealthResponse: z$1.ZodObject<{
-    collectors: z$1.ZodArray<z$1.ZodObject<{
-        name: z$1.ZodString;
-        chain_id: z$1.ZodNumber;
-        block_number: z$1.ZodNullable<z$1.ZodNumber>;
-        updated_at: z$1.ZodNullable<z$1.ZodString>;
-        lag: z$1.ZodNullable<z$1.ZodNumber>;
-        status: z$1.ZodEnum<{
-            live: "live";
-            lagging: "lagging";
-            unknown: "unknown";
-        }>;
-    }, z$1.core.$strip>>;
-}, z$1.core.$strip>;
+declare const CollectorsHealthResponse: z$1.ZodArray<z$1.ZodObject<{
+    name: z$1.ZodString;
+    chain_id: z$1.ZodNumber;
+    block_number: z$1.ZodNullable<z$1.ZodNumber>;
+    updated_at: z$1.ZodNullable<z$1.ZodString>;
+    lag: z$1.ZodNullable<z$1.ZodNumber>;
+    status: z$1.ZodEnum<{
+        live: "live";
+        lagging: "lagging";
+        unknown: "unknown";
+    }>;
+}, z$1.core.$strip>>;
 type CollectorsHealthResponse = z$1.infer<typeof CollectorsHealthResponse>;
-declare const ChainsHealthResponse: z$1.ZodObject<{
-    chains: z$1.ZodArray<z$1.ZodObject<{
-        chain_id: z$1.ZodNumber;
-        block_number: z$1.ZodNumber;
-        updated_at: z$1.ZodString;
-    }, z$1.core.$strip>>;
-}, z$1.core.$strip>;
+declare const ChainsHealthResponse: z$1.ZodArray<z$1.ZodObject<{
+    chain_id: z$1.ZodNumber;
+    block_number: z$1.ZodNumber;
+    updated_at: z$1.ZodString;
+}, z$1.core.$strip>>;
 type ChainsHealthResponse = z$1.infer<typeof ChainsHealthResponse>;
 declare const RouterStatusResponse: z$1.ZodObject<{
     status: z$1.ZodEnum<{
@@ -396,8 +392,8 @@ type Options = (typeof Options)[number];
  * @param lltv - The LLTV option or the scaled LLTV.
  * @returns The LLTV.
  */
-declare function from$7(lltv: Options | bigint): LLTV;
-declare namespace from$7 {
+declare function from$8(lltv: Options | bigint): LLTV;
+declare namespace from$8 {
     type ErrorType = InvalidOptionError$1 | InvalidLLTVError;
 }
 declare class InvalidOptionError$1 extends BaseError {
@@ -416,7 +412,7 @@ type LLTV$1_LLTV = LLTV;
 declare const LLTV$1_LLTVSchema: typeof LLTVSchema;
 type LLTV$1_Options = Options;
 declare namespace LLTV$1 {
-  export { LLTV$1_InvalidLLTVError as InvalidLLTVError, InvalidOptionError$1 as InvalidOptionError, type LLTV$1_LLTV as LLTV, LLTV$1_LLTVSchema as LLTVSchema, type LLTV$1_Options as Options, from$7 as from };
+  export { LLTV$1_InvalidLLTVError as InvalidLLTVError, InvalidOptionError$1 as InvalidOptionError, type LLTV$1_LLTV as LLTV, LLTV$1_LLTVSchema as LLTVSchema, type LLTV$1_Options as Options, from$8 as from };
 }
 
 type Collateral = {
@@ -437,8 +433,8 @@ declare const CollateralsSchema: z.ZodArray<z.ZodObject<{
     oracle: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
     lltv: z.ZodPipe<z.ZodBigInt, z.ZodTransform<LLTV, bigint>>;
 }, z.core.$strip>>;
-declare const from$6: (parameters: from$6.Parameters) => from$6.ReturnType;
-declare namespace from$6 {
+declare const from$7: (parameters: from$7.Parameters) => from$7.ReturnType;
+declare namespace from$7 {
     type Parameters = {
         asset: Address;
         lltv: Options | bigint;
@@ -451,27 +447,7 @@ type Collateral$1_Collateral = Collateral;
 declare const Collateral$1_CollateralSchema: typeof CollateralSchema;
 declare const Collateral$1_CollateralsSchema: typeof CollateralsSchema;
 declare namespace Collateral$1 {
-  export { type Collateral$1_Collateral as Collateral, Collateral$1_CollateralSchema as CollateralSchema, Collateral$1_CollateralsSchema as CollateralsSchema, from$6 as from };
-}
-
-type Cursor = {
-    sort: "rate" | "maturity" | "expiry" | "amount";
-    dir: "asc" | "desc";
-    rate?: string;
-    maturity?: number;
-    expiry?: number;
-    assets?: string;
-    hash: string;
-    page?: number;
-};
-declare function validate(cursor: unknown): cursor is Cursor;
-declare function encode$1(c: Cursor): string;
-declare function decode$1(token?: string): Cursor | null;
-
-type Cursor$1_Cursor = Cursor;
-declare const Cursor$1_validate: typeof validate;
-declare namespace Cursor$1 {
-  export { type Cursor$1_Cursor as Cursor, decode$1 as decode, encode$1 as encode, Cursor$1_validate as validate };
+  export { type Collateral$1_Collateral as Collateral, Collateral$1_CollateralSchema as CollateralSchema, Collateral$1_CollateralsSchema as CollateralsSchema, from$7 as from };
 }
 
 /** The snake case representation of a type with bigint values stringified. */
@@ -500,11 +476,11 @@ declare function toSnakeCase$1<T>(obj: T): Snake<T>;
  * Converts checksummed ethereum addresses to lowercase if used as values.
  * @warning Does not unstringify bigint values.
  */
-declare function fromSnakeCase$2<T>(obj: Snake<T>): T;
+declare function fromSnakeCase$3<T>(obj: Snake<T>): T;
 
 type Format_Snake<T> = Snake<T>;
 declare namespace Format {
-  export { type Format_Snake as Snake, fromSnakeCase$2 as fromSnakeCase, toSnakeCase$1 as toSnakeCase };
+  export { type Format_Snake as Snake, fromSnakeCase$3 as fromSnakeCase, toSnakeCase$1 as toSnakeCase };
 }
 
 /**
@@ -527,8 +503,8 @@ type MaturityOptions = keyof typeof MaturityOptions;
  * @throws {InvalidDateError} If the maturity is in seconds but not a valid date.
  * @throws {InvalidOptionError} If the maturity is not a valid option.
  */
-declare function from$5(ts: from$5.Parameters): Maturity;
-declare namespace from$5 {
+declare function from$6(ts: from$6.Parameters): Maturity;
+declare namespace from$6 {
     type Parameters = number | MaturityOptions;
     type ErrorType = InvalidFormatError | InvalidDateError | InvalidOptionError;
 }
@@ -555,7 +531,7 @@ type Maturity$1_Maturity = Maturity;
 type Maturity$1_MaturityOptions = MaturityOptions;
 declare const Maturity$1_MaturitySchema: typeof MaturitySchema;
 declare namespace Maturity$1 {
-  export { Maturity$1_InvalidDateError as InvalidDateError, Maturity$1_InvalidFormatError as InvalidFormatError, Maturity$1_InvalidOptionError as InvalidOptionError, type Maturity$1_Maturity as Maturity, type Maturity$1_MaturityOptions as MaturityOptions, Maturity$1_MaturitySchema as MaturitySchema, from$5 as from };
+  export { Maturity$1_InvalidDateError as InvalidDateError, Maturity$1_InvalidFormatError as InvalidFormatError, Maturity$1_InvalidOptionError as InvalidOptionError, type Maturity$1_Maturity as Maturity, type Maturity$1_MaturityOptions as MaturityOptions, Maturity$1_MaturitySchema as MaturitySchema, from$6 as from };
 }
 
 type Offer = {
@@ -630,8 +606,8 @@ declare const OfferSchema: (parameters?: {
  * @param input - The offer to create.
  * @returns The created offer with its hash.
  */
-declare function from$4(input: Omit<Offer, "hash">): Offer;
-declare namespace from$4 {
+declare function from$5(input: Omit<Offer, "hash">): Offer;
+declare namespace from$5 {
     type ErrorType = InvalidOfferError;
 }
 /**
@@ -640,21 +616,42 @@ declare namespace from$4 {
  * @param input - The offer to create.
  * @returns The created offer with its hash.
  */
-declare function fromSnakeCase$1(input: Snake<Omit<Offer, "hash">>): Offer;
+declare function fromSnakeCase$2(input: Snake<Omit<Offer, "hash">>): Offer;
 /**
  * Converts an offer to a snake case object.
  * @param offer - The offer to convert.
  * @returns The converted offer.
  */
 declare function toSnakeCase(offer: Offer): Snake<Offer>;
+type RandomConfig = {
+    chains?: Chain[];
+    loanTokens?: Address[];
+    collateralTokens?: Address[];
+    assetsDecimals?: Record<Address, number>;
+    buy?: boolean;
+    assets?: bigint;
+    consumed?: bigint;
+    offering?: Address;
+    maturity?: Maturity;
+    start?: number;
+    expiry?: number;
+    nonce?: bigint;
+    rate?: bigint;
+    callback?: {
+        address: Address;
+        data: Hex;
+        gasLimit: bigint;
+    };
+    collaterals?: readonly Collateral[];
+    signature?: Hex;
+};
 /**
  * Generates a random Offer.
- * The returned Offer contains randomly generated values for most fields, such as assets, rate, nonce, and buy flag.
- * Some fields use fixed or deterministic values (e.g., chainId, collaterals, callback).
+ * The returned Offer contains randomly generated values.
  * @warning The generated Offer should not be used for production usage.
  * @returns {Offer} A randomly generated Offer object.
  */
-declare function random$1(): Offer;
+declare function random$2(config?: RandomConfig): Offer;
 /**
  * Creates an EIP-712 domain object.
  * @param chainId - The chain ID.
@@ -745,8 +742,8 @@ declare function hash(offer: Omit<Offer, "hash">): Hex;
  * @returns The obligation id as a 32-byte hex string.
  */
 declare function obligationId(offer: Offer): Hex;
-declare function encode(offer: Offer): `0x${string}`;
-declare function decode(data: Hex, blockNumber: number | bigint): Offer;
+declare function encode$1(offer: Offer): `0x${string}`;
+declare function decode$1(data: Hex, blockNumber: number | bigint): Offer;
 type OfferConsumed = {
     id: string;
     chainId: bigint;
@@ -805,10 +802,9 @@ type Offer$1_Offer = Offer;
 type Offer$1_OfferConsumed = OfferConsumed;
 declare const Offer$1_OfferHashSchema: typeof OfferHashSchema;
 declare const Offer$1_OfferSchema: typeof OfferSchema;
+type Offer$1_RandomConfig = RandomConfig;
 declare const Offer$1_consumedEvent: typeof consumedEvent;
-declare const Offer$1_decode: typeof decode;
 declare const Offer$1_domain: typeof domain;
-declare const Offer$1_encode: typeof encode;
 declare const Offer$1_fromConsumedLog: typeof fromConsumedLog;
 declare const Offer$1_hash: typeof hash;
 declare const Offer$1_obligationId: typeof obligationId;
@@ -816,7 +812,7 @@ declare const Offer$1_sign: typeof sign;
 declare const Offer$1_toSnakeCase: typeof toSnakeCase;
 declare const Offer$1_types: typeof types;
 declare namespace Offer$1 {
-  export { Offer$1_AccountNotSetError as AccountNotSetError, Offer$1_InvalidOfferError as InvalidOfferError, type Offer$1_Offer as Offer, type Offer$1_OfferConsumed as OfferConsumed, Offer$1_OfferHashSchema as OfferHashSchema, Offer$1_OfferSchema as OfferSchema, Offer$1_consumedEvent as consumedEvent, Offer$1_decode as decode, Offer$1_domain as domain, Offer$1_encode as encode, from$4 as from, Offer$1_fromConsumedLog as fromConsumedLog, fromSnakeCase$1 as fromSnakeCase, Offer$1_hash as hash, Offer$1_obligationId as obligationId, random$1 as random, Offer$1_sign as sign, Offer$1_toSnakeCase as toSnakeCase, Offer$1_types as types };
+  export { Offer$1_AccountNotSetError as AccountNotSetError, Offer$1_InvalidOfferError as InvalidOfferError, type Offer$1_Offer as Offer, type Offer$1_OfferConsumed as OfferConsumed, Offer$1_OfferHashSchema as OfferHashSchema, Offer$1_OfferSchema as OfferSchema, type Offer$1_RandomConfig as RandomConfig, Offer$1_consumedEvent as consumedEvent, decode$1 as decode, Offer$1_domain as domain, encode$1 as encode, from$5 as from, Offer$1_fromConsumedLog as fromConsumedLog, fromSnakeCase$2 as fromSnakeCase, Offer$1_hash as hash, Offer$1_obligationId as obligationId, random$2 as random, Offer$1_sign as sign, Offer$1_toSnakeCase as toSnakeCase, Offer$1_types as types };
 }
 
 /**
@@ -996,17 +992,17 @@ declare const ObligationSchema: z.ZodObject<{
  * });
  * ```
  */
-declare function from$3(parameters: from$3.Parameters): from$3.ReturnType;
-declare namespace from$3 {
+declare function from$4(parameters: from$4.Parameters): from$4.ReturnType;
+declare namespace from$4 {
     type Parameters = {
         /** The chain id where the liquidity for this obligation is located. */
         chainId: Id;
         /** The token that is being borrowed for this obligation. */
         loanToken: Address;
         /** The exact set of collaterals required to borrow the loan token. Must be sorted alphabetically by address. */
-        collaterals: from$6.Parameters[] | readonly from$6.Parameters[];
+        collaterals: from$7.Parameters[] | readonly from$7.Parameters[];
         /** The maturity of the obligation. */
-        maturity: from$5.Parameters;
+        maturity: from$6.Parameters;
     };
     type ReturnType = Obligation;
     type ErrorType = InvalidObligationError;
@@ -1017,8 +1013,8 @@ declare namespace from$3 {
  * @param input - {@link fromSnakeCase.Parameters}
  * @returns The created obligation. {@link fromSnakeCase.ReturnType}
  */
-declare function fromSnakeCase(input: fromSnakeCase.Parameters): fromSnakeCase.ReturnType;
-declare namespace fromSnakeCase {
+declare function fromSnakeCase$1(input: fromSnakeCase$1.Parameters): fromSnakeCase$1.ReturnType;
+declare namespace fromSnakeCase$1 {
     type Parameters = Snake<Obligation>;
     type ReturnType = Obligation;
     type ErrorType = InvalidObligationError;
@@ -1052,8 +1048,8 @@ declare namespace id {
  * const obligation = Obligation.random();
  * ```
  */
-declare function random(): random.ReturnType;
-declare namespace random {
+declare function random$1(): random$1.ReturnType;
+declare namespace random$1 {
     type ReturnType = Obligation;
 }
 declare class InvalidObligationError extends BaseError<z.ZodError | Error> {
@@ -1071,24 +1067,106 @@ type Obligation$1_InvalidObligationError = InvalidObligationError;
 declare const Obligation$1_InvalidObligationError: typeof InvalidObligationError;
 type Obligation$1_Obligation = Obligation;
 declare const Obligation$1_ObligationSchema: typeof ObligationSchema;
-declare const Obligation$1_fromSnakeCase: typeof fromSnakeCase;
 declare const Obligation$1_id: typeof id;
-declare const Obligation$1_random: typeof random;
 declare namespace Obligation$1 {
-  export { Obligation$1_CollateralsAreNotSortedError as CollateralsAreNotSortedError, Obligation$1_InvalidObligationError as InvalidObligationError, type Obligation$1_Obligation as Obligation, Obligation$1_ObligationSchema as ObligationSchema, from$3 as from, Obligation$1_fromSnakeCase as fromSnakeCase, Obligation$1_id as id, Obligation$1_random as random };
+  export { Obligation$1_CollateralsAreNotSortedError as CollateralsAreNotSortedError, Obligation$1_InvalidObligationError as InvalidObligationError, type Obligation$1_Obligation as Obligation, Obligation$1_ObligationSchema as ObligationSchema, from$4 as from, fromSnakeCase$1 as fromSnakeCase, Obligation$1_id as id, random$1 as random };
+}
+
+type Quote = {
+    /** The obligation id. */
+    obligationId: Hex;
+    ask: {
+        /** The highest interest rate the seller will accept to pay for the obligation. (18 decimals). */
+        rate: bigint;
+    };
+    bid: {
+        /** The lowest interest rate a buyer is willing to be paid for the obligation. (18 decimals). */
+        rate: bigint;
+    };
+};
+declare const QuoteSchema: z.ZodObject<{
+    obligationId: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
+    ask: z.ZodObject<{
+        rate: z.ZodBigInt;
+    }, z.core.$strip>;
+    bid: z.ZodObject<{
+        rate: z.ZodBigInt;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+/**
+ * Creates a quote for a given obligation.
+ * @constructor
+ * @param parameters - {@link from.Parameters}
+ * @returns The created quote. {@link Quote}
+ * @throws If the quote is invalid. {@link InvalidQuoteError}
+ *
+ * @example
+ * ```ts
+ * const quote = Quote.from({ obligationId: "0x123", ask: { assets: 100n, rate: 100n }, bid: { assets: 100n, rate: 100n } });
+ * ```
+ */
+declare function from$3(parameters: from$3.Parameters): from$3.ReturnType;
+declare namespace from$3 {
+    type Parameters = Quote;
+    type ReturnType = Quote;
+    type ErrorType = InvalidQuoteError;
+}
+/**
+ * Creates a quote from a snake case object.
+ * @throws If the quote is invalid. {@link InvalidQuoteError}
+ * @param snake - {@link fromSnakeCase.Parameters}
+ * @returns The created quote. {@link fromSnakeCase.ReturnType}
+ */
+declare function fromSnakeCase(snake: fromSnakeCase.Parameters): fromSnakeCase.ReturnType;
+declare namespace fromSnakeCase {
+    type Parameters = Snake<Quote>;
+    type ReturnType = Quote;
+    type ErrorType = from$3.ErrorType;
+}
+/**
+ * Generates a random quote.
+ * @returns A randomly generated quote. {@link random.ReturnType}
+ *
+ * @example
+ * ```ts
+ * const quote = Quote.random();
+ * ```
+ */
+declare function random(): random.ReturnType;
+declare namespace random {
+    type Parameters = never;
+    type ReturnType = Quote;
+    type ErrorType = from$3.ErrorType;
+}
+declare class InvalidQuoteError extends BaseError<z.ZodError | Error> {
+    readonly name = "Quote.InvalidQuoteError";
+    constructor(error: z.ZodError | Error);
+}
+
+type Quote$1_InvalidQuoteError = InvalidQuoteError;
+declare const Quote$1_InvalidQuoteError: typeof InvalidQuoteError;
+type Quote$1_Quote = Quote;
+declare const Quote$1_QuoteSchema: typeof QuoteSchema;
+declare const Quote$1_fromSnakeCase: typeof fromSnakeCase;
+declare const Quote$1_random: typeof random;
+declare namespace Quote$1 {
+  export { Quote$1_InvalidQuoteError as InvalidQuoteError, type Quote$1_Quote as Quote, Quote$1_QuoteSchema as QuoteSchema, from$3 as from, Quote$1_fromSnakeCase as fromSnakeCase, Quote$1_random as random };
 }
 
 type ObligationResponse = Snake<Compute<{
     /** The obligation id. */
     id: Hex;
-} & Obligation>>;
+} & Obligation & {
+    ask: Quote["ask"];
+    bid: Quote["bid"];
+}>>;
 /**
  * Creates an `ObligationResponse` from a `Obligation`.
  * @constructor
  * @param obligation - {@link Obligation}
  * @returns The created `ObligationResponse`. {@link ObligationResponse}
  */
-declare function from$2(obligation: Obligation): ObligationResponse;
+declare function from$2(obligation: Obligation, quote: Quote): ObligationResponse;
 
 type ObligationResponse$1_ObligationResponse = ObligationResponse;
 declare namespace ObligationResponse$1 {
@@ -1230,7 +1308,10 @@ declare namespace getObligations {
         limit?: number;
     };
     type ReturnType = {
-        obligations: Obligation[];
+        obligations: Compute<{
+            /** The obligation id. Uses {@link Obligation.id} to calculate the id.*/
+            id: () => Hex;
+        } & Obligation & Omit<Quote, "obligationId">>[];
         /** The pagination cursor. */
         cursor: string | null;
     };
@@ -1484,6 +1565,28 @@ declare namespace MempoolClient {
   export { type MempoolClient_AddParameters as AddParameters, type MempoolClient_Client as Client, type MempoolClient_GetParameters as GetParameters, type MempoolClient_WatchParameters as WatchParameters, MempoolClient_connect as connect };
 }
 
+type Cursor = {
+    sort: "rate" | "maturity" | "expiry" | "amount";
+    dir: "asc" | "desc";
+    rate?: string;
+    maturity?: number;
+    expiry?: number;
+    assets?: string;
+    hash: string;
+    page?: number;
+};
+declare function validate(cursor: unknown): cursor is Cursor;
+declare function encode(c: Cursor): string;
+declare function decode(token?: string): Cursor | null;
+
+type Cursor$1_Cursor = Cursor;
+declare const Cursor$1_decode: typeof decode;
+declare const Cursor$1_encode: typeof encode;
+declare const Cursor$1_validate: typeof validate;
+declare namespace Cursor$1 {
+  export { type Cursor$1_Cursor as Cursor, Cursor$1_decode as decode, Cursor$1_encode as encode, Cursor$1_validate as validate };
+}
+
 declare function max$1(a: bigint, b: bigint): bigint;
 declare function min(a: bigint, b: bigint): bigint;
 
@@ -1566,7 +1669,7 @@ declare const index_poll: typeof poll;
 declare const index_retry: typeof retry;
 declare const index_wait: typeof wait;
 declare namespace index {
-  export { index_BaseError as BaseError, type index_GlobalErrorType as GlobalErrorType, type index_Snake as Snake, time as Time, index_batch as batch, index_batchMulticall as batchMulticall, fromSnakeCase$2 as fromSnakeCase, index_lazy as lazy, max$1 as max, index_min as min, index_poll as poll, index_retry as retry, toSnakeCase$1 as toSnakeCase, index_wait as wait };
+  export { index_BaseError as BaseError, type index_GlobalErrorType as GlobalErrorType, type index_Snake as Snake, time as Time, index_batch as batch, index_batchMulticall as batchMulticall, fromSnakeCase$3 as fromSnakeCase, index_lazy as lazy, max$1 as max, index_min as min, index_poll as poll, index_retry as retry, toSnakeCase$1 as toSnakeCase, index_wait as wait };
 }
 
-export { Abi, type Brand, BrandTypeId, Callback, Chain$1 as Chain, Collateral$1 as Collateral, type Compute, Cursor$1 as Cursor, Errors, Format, LLTV$1 as LLTV, Liquidity, Maturity$1 as Maturity, MempoolClient as Mempool, Obligation$1 as Obligation, Offer$1 as Offer, index$1 as RouterApi, Client$2 as RouterClient, time as Time, index as Utils, Validation, ValidationRule };
+export { Abi, type Brand, BrandTypeId, Callback, Chain$1 as Chain, Collateral$1 as Collateral, type Compute, Cursor$1 as Cursor, Errors, Format, LLTV$1 as LLTV, Liquidity, Maturity$1 as Maturity, MempoolClient as Mempool, Obligation$1 as Obligation, Offer$1 as Offer, Quote$1 as Quote, index$1 as RouterApi, Client$2 as RouterClient, time as Time, index as Utils, Validation, ValidationRule };