@morpho-dev/router 0.1.17 → 0.1.18

package/dist/index.node.d.cts

@@ -583,14 +583,35 @@ declare function fromSnakeCase$2(input: Snake<Omit<Offer, "hash">>): Offer;
  * @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$2(): Offer;
+declare function random$2(config?: RandomConfig): Offer;
 /**
  * Creates an EIP-712 domain object.
  * @param chainId - The chain ID.
@@ -741,6 +762,7 @@ 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_domain: typeof domain;
 declare const Offer$1_fromConsumedLog: typeof fromConsumedLog;
@@ -750,7 +772,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, decode$1 as decode, Offer$1_domain as domain, encode$1 as encode, from$6 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 };
+  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$6 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 };
 }
 
 /**
@@ -1112,7 +1134,7 @@ type PGLiteDB = ReturnType<typeof drizzle$1> & {
     pool: PGlite;
 };
 type PG = PgDB | PGLiteDB;
-declare function connect$1(parameters: {
+declare function connect$2(parameters: {
     type: "pg";
     endpoint: string;
 } | {
@@ -1127,7 +1149,7 @@ type PG$1_PgDB = PgDB;
 declare const PG$1_applyMigrations: typeof applyMigrations;
 declare const PG$1_clean: typeof clean;
 declare namespace PG$1 {
-  export { type PG$1_PG as PG, type PG$1_PGLiteDB as PGLiteDB, type PG$1_PgDB as PgDB, PG$1_applyMigrations as applyMigrations, PG$1_clean as clean, connect$1 as connect };
+  export { type PG$1_PG as PG, type PG$1_PGLiteDB as PGLiteDB, type PG$1_PgDB as PgDB, PG$1_applyMigrations as applyMigrations, PG$1_clean as clean, connect$2 as connect };
 }
 
 type ChainStore = {
@@ -1861,7 +1883,7 @@ declare function getHealthCollectors(healthService: HealthService): Promise<{
     });
 }>;
 
-declare function getObligations(queryParameters: object, store: OfferStore): Promise<{
+declare function getObligations$1(queryParameters: object, store: OfferStore): Promise<{
     statusCode: STATUS_CODE;
     body: {
         status: "success" | "error";
@@ -1880,7 +1902,7 @@ declare function getObligations(queryParameters: object, store: OfferStore): Pro
     });
 }>;
 
-declare function getOffers(queryParameters: object, store: OfferStore): Promise<{
+declare function getOffers$1(queryParameters: object, store: OfferStore): Promise<{
     statusCode: STATUS_CODE;
     body: {
         status: "success" | "error";
@@ -1903,11 +1925,9 @@ declare const index$2_getDocsHtml: typeof getDocsHtml;
 declare const index$2_getHealth: typeof getHealth;
 declare const index$2_getHealthChains: typeof getHealthChains;
 declare const index$2_getHealthCollectors: typeof getHealthCollectors;
-declare const index$2_getObligations: typeof getObligations;
-declare const index$2_getOffers: typeof getOffers;
 declare const index$2_getSwaggerJson: typeof getSwaggerJson;
 declare namespace index$2 {
-  export { index$2_getDocsHtml as getDocsHtml, index$2_getHealth as getHealth, index$2_getHealthChains as getHealthChains, index$2_getHealthCollectors as getHealthCollectors, index$2_getObligations as getObligations, index$2_getOffers as getOffers, index$2_getSwaggerJson as getSwaggerJson };
+  export { index$2_getDocsHtml as getDocsHtml, index$2_getHealth as getHealth, index$2_getHealthChains as getHealthChains, index$2_getHealthCollectors as getHealthCollectors, getObligations$1 as getObligations, getOffers$1 as getOffers, index$2_getSwaggerJson as getSwaggerJson };
 }
 
 declare const CollectorHealth: z$1.ZodObject<{
@@ -2023,6 +2043,144 @@ declare namespace RouterApi {
   export { RouterApi_ChainHealth as ChainHealth, type RouterApi_ChainsHealthResponse as ChainsHealthResponse, RouterApi_CollectorHealth as CollectorHealth, type RouterApi_CollectorsHealthResponse as CollectorsHealthResponse, index$2 as Controllers, ObligationResponse$1 as ObligationResponse, OfferResponse$1 as OfferResponse, RouterApi_OpenApi as OpenApi, type RouterApi$1 as RouterApi, type RouterApi_RouterApiConfig as RouterApiConfig, type RouterApi_RouterStatusResponse as RouterStatusResponse, RouterApi_create as create, RouterApi_parse as parse, RouterApi_safeParse as safeParse };
 }
 
+type RouterClientConfig = {
+    /** The URL of the router. */
+    readonly url: URL;
+    /** The default headers to use for each request. */
+    readonly headers: Headers;
+};
+type Client$1 = Compute<RouterClientConfig & {
+    /**
+     * Get offers from the router.
+     * @param parameters - {@link getOffers.Parameters}
+     * @returns The offers with pagination cursor. {@link getOffers.ReturnType}
+     *
+     * @example
+     * ```ts
+     * const router = RouterClient.connect({ url: "https://router.morpho.dev" });
+     * const { offers, cursor } = await router.getOffers({ side: "buy", obligationId: "0xa1c...d2f" });
+     * console.log(offers);
+     * ```
+     */
+    getOffers: (parameters: getOffers.Parameters) => Promise<getOffers.ReturnType>;
+    /**
+     * Get obligations from the router.
+     * @param parameters - {@link getObligations.Parameters}
+     * @returns The obligations with pagination cursor. {@link getObligations.ReturnType}
+     *
+     * @example
+     * ```ts
+     * const router = RouterClient.connect({ url: "https://router.morpho.dev" });
+     * const { obligations, cursor } = await router.getObligations();
+     * console.log(obligations);
+     * ```
+     */
+    getObligations: (parameters?: getObligations.Parameters) => Promise<getObligations.ReturnType>;
+}>;
+type ConnectOptions = {
+    /** The URL of the router to interact with.
+     * @default "https://router.morpho.dev"
+     */
+    url?: string;
+    /** The API key to use for the router API. */
+    apiKey?: string;
+    /** The default headers to use for each request. */
+    headers?: Headers;
+};
+/**
+ * Creates an instance of a router client.
+ * @constructor
+ * @param options - {@link ConnectOptions}
+ * @returns A Router Client. {@link Client}
+ *
+ * @example
+ * ```typescript
+ * const router = RouterClient.connect({ url: "https://router.morpho.dev" });
+ * ```
+ */
+declare function connect$1(options?: ConnectOptions): connect$1.ReturnType;
+declare namespace connect$1 {
+    type ReturnType = Client$1;
+    type ErrorType = InvalidUrlError;
+}
+declare function getOffers(config: RouterClientConfig, parameters: getOffers.Parameters): Promise<getOffers.ReturnType>;
+declare namespace getOffers {
+    type Parameters = {
+        /** The desired side of the match: 'buy' if you want to buy, 'sell' if you want to sell */
+        side: "buy" | "sell";
+        /** The offers obligation id */
+        obligationId: Hex;
+        /** Pagination cursor in base64url-encoded format */
+        cursor?: string;
+        /** Maximum number of offers to return. @default 20 */
+        limit?: number;
+    };
+    type ReturnType = {
+        offers: Offer[];
+        /** The pagination cursor. */
+        cursor: string | null;
+    };
+    type ErrorType = GetApiErrorType;
+}
+declare function getObligations(config: RouterClientConfig, parameters?: getObligations.Parameters): Promise<getObligations.ReturnType>;
+declare namespace getObligations {
+    type Parameters = {
+        /** Pagination cursor is a 32-byte hex string. */
+        cursor?: Hex;
+        /** Maximum number of obligations to return. @default 20 */
+        limit?: number;
+    };
+    type ReturnType = {
+        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;
+    };
+    type ErrorType = GetApiErrorType;
+}
+type GetApiErrorType = HttpGetApiFailedError | HttpUnauthorizedError | HttpForbiddenError | HttpRateLimitError;
+declare class InvalidUrlError extends BaseError {
+    name: string;
+    constructor(url: string);
+}
+declare class HttpUnauthorizedError extends BaseError {
+    name: string;
+    constructor();
+}
+declare class HttpForbiddenError extends BaseError {
+    name: string;
+    constructor();
+}
+declare class HttpRateLimitError extends BaseError {
+    name: string;
+    constructor();
+}
+declare class HttpGetApiFailedError extends BaseError {
+    name: string;
+    constructor(message: string, { details }?: {
+        details?: string;
+    });
+}
+
+type Client$2_ConnectOptions = ConnectOptions;
+type Client$2_HttpForbiddenError = HttpForbiddenError;
+declare const Client$2_HttpForbiddenError: typeof HttpForbiddenError;
+type Client$2_HttpGetApiFailedError = HttpGetApiFailedError;
+declare const Client$2_HttpGetApiFailedError: typeof HttpGetApiFailedError;
+type Client$2_HttpRateLimitError = HttpRateLimitError;
+declare const Client$2_HttpRateLimitError: typeof HttpRateLimitError;
+type Client$2_HttpUnauthorizedError = HttpUnauthorizedError;
+declare const Client$2_HttpUnauthorizedError: typeof HttpUnauthorizedError;
+type Client$2_InvalidUrlError = InvalidUrlError;
+declare const Client$2_InvalidUrlError: typeof InvalidUrlError;
+declare const Client$2_getObligations: typeof getObligations;
+declare const Client$2_getOffers: typeof getOffers;
+declare namespace Client$2 {
+  export { type Client$1 as Client, type Client$2_ConnectOptions as ConnectOptions, Client$2_HttpForbiddenError as HttpForbiddenError, Client$2_HttpGetApiFailedError as HttpGetApiFailedError, Client$2_HttpRateLimitError as HttpRateLimitError, Client$2_HttpUnauthorizedError as HttpUnauthorizedError, Client$2_InvalidUrlError as InvalidUrlError, connect$1 as connect, Client$2_getObligations as getObligations, Client$2_getOffers as getOffers };
+}
+
 type MempoolEVMClientConfig = {
     readonly client: WalletClient;
     readonly mempoolAddress: Address;
@@ -3310,4 +3468,4 @@ 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$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, ChainHealth, ChainStore$1 as ChainStore, ChainsHealthResponse, Collateral$1 as Collateral, index$3 as Collector, CollectorHealth, CollectorStore$1 as CollectorStore, CollectorsHealthResponse, type Compute, Cursor$1 as Cursor, Errors, Format, Health, LLTV$1 as LLTV, Liquidity, LiquidityStore$1 as LiquidityStore, Logger$1 as Logger, Maturity$1 as Maturity, index$1 as Mempool, Obligation$1 as Obligation, ObligationResponse$1 as ObligationResponse, Offer$1 as Offer, OfferResponse$1 as OfferResponse, OfferStore$1 as OfferStore, schema as OffersSchema, OpenApi, PG$1 as PG, Quote$1 as Quote, RouterApi, RouterIndexer, RouterStatusResponse, Services$1 as Services, time as Time, index as Utils, Validation, ValidationRule, parse, safeParse };
+export { Abi, type Brand, BrandTypeId, Callback, Chain$1 as Chain, ChainHealth, ChainStore$1 as ChainStore, ChainsHealthResponse, Collateral$1 as Collateral, index$3 as Collector, CollectorHealth, CollectorStore$1 as CollectorStore, CollectorsHealthResponse, type Compute, Cursor$1 as Cursor, Errors, Format, Health, LLTV$1 as LLTV, Liquidity, LiquidityStore$1 as LiquidityStore, Logger$1 as Logger, Maturity$1 as Maturity, index$1 as Mempool, Obligation$1 as Obligation, ObligationResponse$1 as ObligationResponse, Offer$1 as Offer, OfferResponse$1 as OfferResponse, OfferStore$1 as OfferStore, schema as OffersSchema, OpenApi, PG$1 as PG, Quote$1 as Quote, RouterApi, Client$2 as RouterClient, RouterIndexer, RouterStatusResponse, Services$1 as Services, time as Time, index as Utils, Validation, ValidationRule, parse, safeParse };

package/dist/index.node.d.ts

@@ -583,14 +583,35 @@ declare function fromSnakeCase$2(input: Snake<Omit<Offer, "hash">>): Offer;
  * @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$2(): Offer;
+declare function random$2(config?: RandomConfig): Offer;
 /**
  * Creates an EIP-712 domain object.
  * @param chainId - The chain ID.
@@ -741,6 +762,7 @@ 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_domain: typeof domain;
 declare const Offer$1_fromConsumedLog: typeof fromConsumedLog;
@@ -750,7 +772,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, decode$1 as decode, Offer$1_domain as domain, encode$1 as encode, from$6 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 };
+  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$6 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 };
 }
 
 /**
@@ -1112,7 +1134,7 @@ type PGLiteDB = ReturnType<typeof drizzle$1> & {
     pool: PGlite;
 };
 type PG = PgDB | PGLiteDB;
-declare function connect$1(parameters: {
+declare function connect$2(parameters: {
     type: "pg";
     endpoint: string;
 } | {
@@ -1127,7 +1149,7 @@ type PG$1_PgDB = PgDB;
 declare const PG$1_applyMigrations: typeof applyMigrations;
 declare const PG$1_clean: typeof clean;
 declare namespace PG$1 {
-  export { type PG$1_PG as PG, type PG$1_PGLiteDB as PGLiteDB, type PG$1_PgDB as PgDB, PG$1_applyMigrations as applyMigrations, PG$1_clean as clean, connect$1 as connect };
+  export { type PG$1_PG as PG, type PG$1_PGLiteDB as PGLiteDB, type PG$1_PgDB as PgDB, PG$1_applyMigrations as applyMigrations, PG$1_clean as clean, connect$2 as connect };
 }
 
 type ChainStore = {
@@ -1861,7 +1883,7 @@ declare function getHealthCollectors(healthService: HealthService): Promise<{
     });
 }>;
 
-declare function getObligations(queryParameters: object, store: OfferStore): Promise<{
+declare function getObligations$1(queryParameters: object, store: OfferStore): Promise<{
     statusCode: STATUS_CODE;
     body: {
         status: "success" | "error";
@@ -1880,7 +1902,7 @@ declare function getObligations(queryParameters: object, store: OfferStore): Pro
     });
 }>;
 
-declare function getOffers(queryParameters: object, store: OfferStore): Promise<{
+declare function getOffers$1(queryParameters: object, store: OfferStore): Promise<{
     statusCode: STATUS_CODE;
     body: {
         status: "success" | "error";
@@ -1903,11 +1925,9 @@ declare const index$2_getDocsHtml: typeof getDocsHtml;
 declare const index$2_getHealth: typeof getHealth;
 declare const index$2_getHealthChains: typeof getHealthChains;
 declare const index$2_getHealthCollectors: typeof getHealthCollectors;
-declare const index$2_getObligations: typeof getObligations;
-declare const index$2_getOffers: typeof getOffers;
 declare const index$2_getSwaggerJson: typeof getSwaggerJson;
 declare namespace index$2 {
-  export { index$2_getDocsHtml as getDocsHtml, index$2_getHealth as getHealth, index$2_getHealthChains as getHealthChains, index$2_getHealthCollectors as getHealthCollectors, index$2_getObligations as getObligations, index$2_getOffers as getOffers, index$2_getSwaggerJson as getSwaggerJson };
+  export { index$2_getDocsHtml as getDocsHtml, index$2_getHealth as getHealth, index$2_getHealthChains as getHealthChains, index$2_getHealthCollectors as getHealthCollectors, getObligations$1 as getObligations, getOffers$1 as getOffers, index$2_getSwaggerJson as getSwaggerJson };
 }
 
 declare const CollectorHealth: z$1.ZodObject<{
@@ -2023,6 +2043,144 @@ declare namespace RouterApi {
   export { RouterApi_ChainHealth as ChainHealth, type RouterApi_ChainsHealthResponse as ChainsHealthResponse, RouterApi_CollectorHealth as CollectorHealth, type RouterApi_CollectorsHealthResponse as CollectorsHealthResponse, index$2 as Controllers, ObligationResponse$1 as ObligationResponse, OfferResponse$1 as OfferResponse, RouterApi_OpenApi as OpenApi, type RouterApi$1 as RouterApi, type RouterApi_RouterApiConfig as RouterApiConfig, type RouterApi_RouterStatusResponse as RouterStatusResponse, RouterApi_create as create, RouterApi_parse as parse, RouterApi_safeParse as safeParse };
 }
 
+type RouterClientConfig = {
+    /** The URL of the router. */
+    readonly url: URL;
+    /** The default headers to use for each request. */
+    readonly headers: Headers;
+};
+type Client$1 = Compute<RouterClientConfig & {
+    /**
+     * Get offers from the router.
+     * @param parameters - {@link getOffers.Parameters}
+     * @returns The offers with pagination cursor. {@link getOffers.ReturnType}
+     *
+     * @example
+     * ```ts
+     * const router = RouterClient.connect({ url: "https://router.morpho.dev" });
+     * const { offers, cursor } = await router.getOffers({ side: "buy", obligationId: "0xa1c...d2f" });
+     * console.log(offers);
+     * ```
+     */
+    getOffers: (parameters: getOffers.Parameters) => Promise<getOffers.ReturnType>;
+    /**
+     * Get obligations from the router.
+     * @param parameters - {@link getObligations.Parameters}
+     * @returns The obligations with pagination cursor. {@link getObligations.ReturnType}
+     *
+     * @example
+     * ```ts
+     * const router = RouterClient.connect({ url: "https://router.morpho.dev" });
+     * const { obligations, cursor } = await router.getObligations();
+     * console.log(obligations);
+     * ```
+     */
+    getObligations: (parameters?: getObligations.Parameters) => Promise<getObligations.ReturnType>;
+}>;
+type ConnectOptions = {
+    /** The URL of the router to interact with.
+     * @default "https://router.morpho.dev"
+     */
+    url?: string;
+    /** The API key to use for the router API. */
+    apiKey?: string;
+    /** The default headers to use for each request. */
+    headers?: Headers;
+};
+/**
+ * Creates an instance of a router client.
+ * @constructor
+ * @param options - {@link ConnectOptions}
+ * @returns A Router Client. {@link Client}
+ *
+ * @example
+ * ```typescript
+ * const router = RouterClient.connect({ url: "https://router.morpho.dev" });
+ * ```
+ */
+declare function connect$1(options?: ConnectOptions): connect$1.ReturnType;
+declare namespace connect$1 {
+    type ReturnType = Client$1;
+    type ErrorType = InvalidUrlError;
+}
+declare function getOffers(config: RouterClientConfig, parameters: getOffers.Parameters): Promise<getOffers.ReturnType>;
+declare namespace getOffers {
+    type Parameters = {
+        /** The desired side of the match: 'buy' if you want to buy, 'sell' if you want to sell */
+        side: "buy" | "sell";
+        /** The offers obligation id */
+        obligationId: Hex;
+        /** Pagination cursor in base64url-encoded format */
+        cursor?: string;
+        /** Maximum number of offers to return. @default 20 */
+        limit?: number;
+    };
+    type ReturnType = {
+        offers: Offer[];
+        /** The pagination cursor. */
+        cursor: string | null;
+    };
+    type ErrorType = GetApiErrorType;
+}
+declare function getObligations(config: RouterClientConfig, parameters?: getObligations.Parameters): Promise<getObligations.ReturnType>;
+declare namespace getObligations {
+    type Parameters = {
+        /** Pagination cursor is a 32-byte hex string. */
+        cursor?: Hex;
+        /** Maximum number of obligations to return. @default 20 */
+        limit?: number;
+    };
+    type ReturnType = {
+        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;
+    };
+    type ErrorType = GetApiErrorType;
+}
+type GetApiErrorType = HttpGetApiFailedError | HttpUnauthorizedError | HttpForbiddenError | HttpRateLimitError;
+declare class InvalidUrlError extends BaseError {
+    name: string;
+    constructor(url: string);
+}
+declare class HttpUnauthorizedError extends BaseError {
+    name: string;
+    constructor();
+}
+declare class HttpForbiddenError extends BaseError {
+    name: string;
+    constructor();
+}
+declare class HttpRateLimitError extends BaseError {
+    name: string;
+    constructor();
+}
+declare class HttpGetApiFailedError extends BaseError {
+    name: string;
+    constructor(message: string, { details }?: {
+        details?: string;
+    });
+}
+
+type Client$2_ConnectOptions = ConnectOptions;
+type Client$2_HttpForbiddenError = HttpForbiddenError;
+declare const Client$2_HttpForbiddenError: typeof HttpForbiddenError;
+type Client$2_HttpGetApiFailedError = HttpGetApiFailedError;
+declare const Client$2_HttpGetApiFailedError: typeof HttpGetApiFailedError;
+type Client$2_HttpRateLimitError = HttpRateLimitError;
+declare const Client$2_HttpRateLimitError: typeof HttpRateLimitError;
+type Client$2_HttpUnauthorizedError = HttpUnauthorizedError;
+declare const Client$2_HttpUnauthorizedError: typeof HttpUnauthorizedError;
+type Client$2_InvalidUrlError = InvalidUrlError;
+declare const Client$2_InvalidUrlError: typeof InvalidUrlError;
+declare const Client$2_getObligations: typeof getObligations;
+declare const Client$2_getOffers: typeof getOffers;
+declare namespace Client$2 {
+  export { type Client$1 as Client, type Client$2_ConnectOptions as ConnectOptions, Client$2_HttpForbiddenError as HttpForbiddenError, Client$2_HttpGetApiFailedError as HttpGetApiFailedError, Client$2_HttpRateLimitError as HttpRateLimitError, Client$2_HttpUnauthorizedError as HttpUnauthorizedError, Client$2_InvalidUrlError as InvalidUrlError, connect$1 as connect, Client$2_getObligations as getObligations, Client$2_getOffers as getOffers };
+}
+
 type MempoolEVMClientConfig = {
     readonly client: WalletClient;
     readonly mempoolAddress: Address;
@@ -3310,4 +3468,4 @@ 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$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, ChainHealth, ChainStore$1 as ChainStore, ChainsHealthResponse, Collateral$1 as Collateral, index$3 as Collector, CollectorHealth, CollectorStore$1 as CollectorStore, CollectorsHealthResponse, type Compute, Cursor$1 as Cursor, Errors, Format, Health, LLTV$1 as LLTV, Liquidity, LiquidityStore$1 as LiquidityStore, Logger$1 as Logger, Maturity$1 as Maturity, index$1 as Mempool, Obligation$1 as Obligation, ObligationResponse$1 as ObligationResponse, Offer$1 as Offer, OfferResponse$1 as OfferResponse, OfferStore$1 as OfferStore, schema as OffersSchema, OpenApi, PG$1 as PG, Quote$1 as Quote, RouterApi, RouterIndexer, RouterStatusResponse, Services$1 as Services, time as Time, index as Utils, Validation, ValidationRule, parse, safeParse };
+export { Abi, type Brand, BrandTypeId, Callback, Chain$1 as Chain, ChainHealth, ChainStore$1 as ChainStore, ChainsHealthResponse, Collateral$1 as Collateral, index$3 as Collector, CollectorHealth, CollectorStore$1 as CollectorStore, CollectorsHealthResponse, type Compute, Cursor$1 as Cursor, Errors, Format, Health, LLTV$1 as LLTV, Liquidity, LiquidityStore$1 as LiquidityStore, Logger$1 as Logger, Maturity$1 as Maturity, index$1 as Mempool, Obligation$1 as Obligation, ObligationResponse$1 as ObligationResponse, Offer$1 as Offer, OfferResponse$1 as OfferResponse, OfferStore$1 as OfferStore, schema as OffersSchema, OpenApi, PG$1 as PG, Quote$1 as Quote, RouterApi, Client$2 as RouterClient, RouterIndexer, RouterStatusResponse, Services$1 as Services, time as Time, index as Utils, Validation, ValidationRule, parse, safeParse };