@morpho-dev/router 0.0.12 → 0.0.14

package/dist/index.browser.d.cts

@@ -1,8 +1,11 @@
-import { Offer, Errors } from '@morpho-dev/mempool';
+import { Offer, Errors, Format } from '@morpho-dev/mempool';
 export * from '@morpho-dev/mempool';
 import * as viem from 'viem';
 import { Address, PublicClient } from 'viem';
 import { Chain as Chain$2 } from 'viem/chains';
+import * as zod_v4_core from 'zod/v4/core';
+import * as zod_v4 from 'zod/v4';
+import { z, ZodError } from 'zod/v4';
 
 type Compute<type> = {
     [key in keyof type]: type[key];
@@ -42,16 +45,91 @@ type OfferMetadata = {
     issue: string;
 };
 type RouterOffer = Offer.Offer & {
+    consumed: bigint;
     status: OfferStatus;
     metadata?: OfferMetadata;
 };
+declare const RouterOfferSchema: (parameters?: {
+    omitHash?: boolean;
+}) => zod_v4.ZodObject<{
+    offering: zod_v4.ZodPipe<zod_v4.ZodString, zod_v4.ZodTransform<`0x${string}`, string>>;
+    assets: zod_v4.ZodBigInt;
+    rate: zod_v4.ZodBigInt;
+    maturity: zod_v4.ZodNumber;
+    expiry: zod_v4.ZodNumber;
+    start: zod_v4.ZodNumber;
+    nonce: zod_v4.ZodBigInt;
+    buy: zod_v4.ZodBoolean;
+    chainId: zod_v4.ZodBigInt;
+    loanToken: zod_v4.ZodPipe<zod_v4.ZodString, zod_v4.ZodTransform<`0x${string}`, string>>;
+    collaterals: zod_v4.ZodArray<zod_v4.ZodObject<{
+        asset: zod_v4.ZodPipe<zod_v4.ZodString, zod_v4.ZodTransform<`0x${string}`, string>>;
+        oracle: zod_v4.ZodPipe<zod_v4.ZodString, zod_v4.ZodTransform<`0x${string}`, string>>;
+        lltv: zod_v4.ZodBigInt;
+    }, zod_v4_core.$strip>>;
+    callback: zod_v4.ZodObject<{
+        address: zod_v4.ZodPipe<zod_v4.ZodString, zod_v4.ZodTransform<`0x${string}`, string>>;
+        data: zod_v4.ZodPipe<zod_v4.ZodString, zod_v4.ZodTransform<`0x${string}`, string>>;
+        gasLimit: zod_v4.ZodBigInt;
+    }, zod_v4_core.$strip>;
+    signature: zod_v4.ZodOptional<zod_v4.ZodPipe<zod_v4.ZodString, zod_v4.ZodTransform<`0x${string}`, string>>>;
+    createdAt: zod_v4.ZodOptional<zod_v4.ZodNumber>;
+    consumed: z.ZodBigInt;
+    status: z.ZodEnum<{
+        valid: "valid";
+        callback_not_supported: "callback_not_supported";
+        callback_error: "callback_error";
+        unverified: "unverified";
+    }>;
+    metadata: z.ZodOptional<z.ZodObject<{
+        issue: z.ZodString;
+    }, z.core.$strip>>;
+}, zod_v4_core.$strip>;
+/**
+ * Creates a router offer from a plain object.
+ * @throws {InvalidRouterOfferError} If the router offer is invalid.
+ * @param input - The router offer to create.
+ * @returns The created router offer with its hash.
+ */
+declare function from(input: Omit<RouterOffer, "hash">): RouterOffer;
+declare namespace from {
+    type ErrorType = InvalidRouterOfferError;
+}
+/**
+ * Creates a router offer from a snake case object.
+ * @throws {InvalidRouterOfferError} If the router offer is invalid.
+ * @param input - The router offer to create.
+ * @returns The created router offer with its hash.
+ */
+declare function fromSnakeCase(input: Format.Snake<Omit<RouterOffer, "hash">>): RouterOffer;
+declare namespace fromSnakeCase {
+    type ErrorType = InvalidRouterOfferError;
+}
+/**
+ * Converts a router offer to a snake case object.
+ * @param offer - The router offer to convert.
+ * @returns The converted router offer.
+ */
+declare function toSnakeCase(offer: RouterOffer): Format.Snake<RouterOffer>;
+declare function random(): RouterOffer;
+declare class InvalidRouterOfferError extends Errors.BaseError<ZodError | Error> {
+    readonly name = "RouterOffer.InvalidRouterOfferError";
+    constructor(error: ZodError | Error);
+}
 
+type RouterOffer$1_InvalidRouterOfferError = InvalidRouterOfferError;
+declare const RouterOffer$1_InvalidRouterOfferError: typeof InvalidRouterOfferError;
 type RouterOffer$1_OfferMetadata = OfferMetadata;
 type RouterOffer$1_OfferStatus = OfferStatus;
 declare const RouterOffer$1_OfferStatusValues: typeof OfferStatusValues;
 type RouterOffer$1_RouterOffer = RouterOffer;
+declare const RouterOffer$1_RouterOfferSchema: typeof RouterOfferSchema;
+declare const RouterOffer$1_from: typeof from;
+declare const RouterOffer$1_fromSnakeCase: typeof fromSnakeCase;
+declare const RouterOffer$1_random: typeof random;
+declare const RouterOffer$1_toSnakeCase: typeof toSnakeCase;
 declare namespace RouterOffer$1 {
-  export { type RouterOffer$1_OfferMetadata as OfferMetadata, type RouterOffer$1_OfferStatus as OfferStatus, RouterOffer$1_OfferStatusValues as OfferStatusValues, type RouterOffer$1_RouterOffer as RouterOffer };
+  export { RouterOffer$1_InvalidRouterOfferError as InvalidRouterOfferError, type RouterOffer$1_OfferMetadata as OfferMetadata, type RouterOffer$1_OfferStatus as OfferStatus, RouterOffer$1_OfferStatusValues as OfferStatusValues, type RouterOffer$1_RouterOffer as RouterOffer, RouterOffer$1_RouterOfferSchema as RouterOfferSchema, RouterOffer$1_from as from, RouterOffer$1_fromSnakeCase as fromSnakeCase, RouterOffer$1_random as random, RouterOffer$1_toSnakeCase as toSnakeCase };
 }
 
 type GetParameters = {
@@ -203,38 +281,38 @@ declare class HttpGetOffersFailedError extends Errors.BaseError {
     });
 }
 
-type index_Client = Client;
-type index_GetParameters = GetParameters;
-type index_HttpForbiddenError = HttpForbiddenError;
-declare const index_HttpForbiddenError: typeof HttpForbiddenError;
-type index_HttpGetOffersFailedError = HttpGetOffersFailedError;
-declare const index_HttpGetOffersFailedError: typeof HttpGetOffersFailedError;
-type index_HttpRateLimitError = HttpRateLimitError;
-declare const index_HttpRateLimitError: typeof HttpRateLimitError;
-type index_HttpUnauthorizedError = HttpUnauthorizedError;
-declare const index_HttpUnauthorizedError: typeof HttpUnauthorizedError;
-type index_InvalidUrlError = InvalidUrlError;
-declare const index_InvalidUrlError: typeof InvalidUrlError;
-type index_MatchParameters = MatchParameters;
-type index_RouterClientConfig = RouterClientConfig;
-declare const index_connect: typeof connect;
-declare const index_get: typeof get;
-declare const index_match: typeof match;
-declare namespace index {
-  export { type index_Client as Client, type index_GetParameters as GetParameters, index_HttpForbiddenError as HttpForbiddenError, index_HttpGetOffersFailedError as HttpGetOffersFailedError, index_HttpRateLimitError as HttpRateLimitError, index_HttpUnauthorizedError as HttpUnauthorizedError, index_InvalidUrlError as InvalidUrlError, type index_MatchParameters as MatchParameters, type index_RouterClientConfig as RouterClientConfig, index_connect as connect, index_get as get, index_match as match };
+type Client$1_Client = Client;
+type Client$1_GetParameters = GetParameters;
+type Client$1_HttpForbiddenError = HttpForbiddenError;
+declare const Client$1_HttpForbiddenError: typeof HttpForbiddenError;
+type Client$1_HttpGetOffersFailedError = HttpGetOffersFailedError;
+declare const Client$1_HttpGetOffersFailedError: typeof HttpGetOffersFailedError;
+type Client$1_HttpRateLimitError = HttpRateLimitError;
+declare const Client$1_HttpRateLimitError: typeof HttpRateLimitError;
+type Client$1_HttpUnauthorizedError = HttpUnauthorizedError;
+declare const Client$1_HttpUnauthorizedError: typeof HttpUnauthorizedError;
+type Client$1_InvalidUrlError = InvalidUrlError;
+declare const Client$1_InvalidUrlError: typeof InvalidUrlError;
+type Client$1_MatchParameters = MatchParameters;
+type Client$1_RouterClientConfig = RouterClientConfig;
+declare const Client$1_connect: typeof connect;
+declare const Client$1_get: typeof get;
+declare const Client$1_match: typeof match;
+declare namespace Client$1 {
+  export { type Client$1_Client as Client, type Client$1_GetParameters as GetParameters, Client$1_HttpForbiddenError as HttpForbiddenError, Client$1_HttpGetOffersFailedError as HttpGetOffersFailedError, Client$1_HttpRateLimitError as HttpRateLimitError, Client$1_HttpUnauthorizedError as HttpUnauthorizedError, Client$1_InvalidUrlError as InvalidUrlError, type Client$1_MatchParameters as MatchParameters, type Client$1_RouterClientConfig as RouterClientConfig, Client$1_connect as connect, Client$1_get as get, Client$1_match as match };
 }
 
 declare const types: readonly ["offer_created", "offer_matched", "offer_validation"];
 type Type = (typeof types)[number];
 type EventPayload = {
     offer_created: {
-        readonly offer: RouterOffer;
+        readonly offer: Offer.Offer;
     };
     offer_matched: {
-        readonly offer: RouterOffer;
+        readonly offer: Offer.Offer;
     };
     offer_validation: {
-        readonly offer: RouterOffer;
+        readonly offer: Offer.Offer;
     };
 };
 type BaseEvent<T extends Type> = {
@@ -278,6 +356,19 @@ declare namespace RouterEvent$1 {
  */
 declare function batch$1<T>(array: Array<T>, batchSize: number): Generator<T[], void, unknown>;
 
+type Cursor = {
+    sort: "rate" | "maturity" | "expiry" | "amount";
+    dir: "asc" | "desc";
+    rate?: string;
+    maturity?: number;
+    expiry?: number;
+    assets?: string;
+    hash: string;
+};
+declare function validateCursor(cursor: unknown): cursor is Cursor;
+declare function encodeCursor(c: Cursor): string;
+declare function decodeCursor(token?: string): Cursor | null;
+
 /**
  * Polls a function at a specified interval.
  * Inspired by https://github.com/wevm/viem/blob/845994d20275d08ff892018e237a4b599eeefb6a/src/utils/poll.ts
@@ -537,4 +628,4 @@ declare namespace Validation {
   export { type Validation_Issue as Issue, type Validation_Result as Result, Validation_run as run };
 }
 
-export { Chain$1 as Chain, type Compute, index as Router, RouterEvent$1 as RouterEvent, RouterOffer$1 as RouterOffer, Validation, ValidationRule, batch$1 as batch, poll, wait };
+export { Chain$1 as Chain, type Compute, type Cursor, Client$1 as Router, RouterEvent$1 as RouterEvent, RouterOffer$1 as RouterOffer, Validation, ValidationRule, batch$1 as batch, decodeCursor, encodeCursor, poll, validateCursor, wait };

package/dist/index.browser.d.ts

@@ -1,8 +1,11 @@
-import { Offer, Errors } from '@morpho-dev/mempool';
+import { Offer, Errors, Format } from '@morpho-dev/mempool';
 export * from '@morpho-dev/mempool';
 import * as viem from 'viem';
 import { Address, PublicClient } from 'viem';
 import { Chain as Chain$2 } from 'viem/chains';
+import * as zod_v4_core from 'zod/v4/core';
+import * as zod_v4 from 'zod/v4';
+import { z, ZodError } from 'zod/v4';
 
 type Compute<type> = {
     [key in keyof type]: type[key];
@@ -42,16 +45,91 @@ type OfferMetadata = {
     issue: string;
 };
 type RouterOffer = Offer.Offer & {
+    consumed: bigint;
     status: OfferStatus;
     metadata?: OfferMetadata;
 };
+declare const RouterOfferSchema: (parameters?: {
+    omitHash?: boolean;
+}) => zod_v4.ZodObject<{
+    offering: zod_v4.ZodPipe<zod_v4.ZodString, zod_v4.ZodTransform<`0x${string}`, string>>;
+    assets: zod_v4.ZodBigInt;
+    rate: zod_v4.ZodBigInt;
+    maturity: zod_v4.ZodNumber;
+    expiry: zod_v4.ZodNumber;
+    start: zod_v4.ZodNumber;
+    nonce: zod_v4.ZodBigInt;
+    buy: zod_v4.ZodBoolean;
+    chainId: zod_v4.ZodBigInt;
+    loanToken: zod_v4.ZodPipe<zod_v4.ZodString, zod_v4.ZodTransform<`0x${string}`, string>>;
+    collaterals: zod_v4.ZodArray<zod_v4.ZodObject<{
+        asset: zod_v4.ZodPipe<zod_v4.ZodString, zod_v4.ZodTransform<`0x${string}`, string>>;
+        oracle: zod_v4.ZodPipe<zod_v4.ZodString, zod_v4.ZodTransform<`0x${string}`, string>>;
+        lltv: zod_v4.ZodBigInt;
+    }, zod_v4_core.$strip>>;
+    callback: zod_v4.ZodObject<{
+        address: zod_v4.ZodPipe<zod_v4.ZodString, zod_v4.ZodTransform<`0x${string}`, string>>;
+        data: zod_v4.ZodPipe<zod_v4.ZodString, zod_v4.ZodTransform<`0x${string}`, string>>;
+        gasLimit: zod_v4.ZodBigInt;
+    }, zod_v4_core.$strip>;
+    signature: zod_v4.ZodOptional<zod_v4.ZodPipe<zod_v4.ZodString, zod_v4.ZodTransform<`0x${string}`, string>>>;
+    createdAt: zod_v4.ZodOptional<zod_v4.ZodNumber>;
+    consumed: z.ZodBigInt;
+    status: z.ZodEnum<{
+        valid: "valid";
+        callback_not_supported: "callback_not_supported";
+        callback_error: "callback_error";
+        unverified: "unverified";
+    }>;
+    metadata: z.ZodOptional<z.ZodObject<{
+        issue: z.ZodString;
+    }, z.core.$strip>>;
+}, zod_v4_core.$strip>;
+/**
+ * Creates a router offer from a plain object.
+ * @throws {InvalidRouterOfferError} If the router offer is invalid.
+ * @param input - The router offer to create.
+ * @returns The created router offer with its hash.
+ */
+declare function from(input: Omit<RouterOffer, "hash">): RouterOffer;
+declare namespace from {
+    type ErrorType = InvalidRouterOfferError;
+}
+/**
+ * Creates a router offer from a snake case object.
+ * @throws {InvalidRouterOfferError} If the router offer is invalid.
+ * @param input - The router offer to create.
+ * @returns The created router offer with its hash.
+ */
+declare function fromSnakeCase(input: Format.Snake<Omit<RouterOffer, "hash">>): RouterOffer;
+declare namespace fromSnakeCase {
+    type ErrorType = InvalidRouterOfferError;
+}
+/**
+ * Converts a router offer to a snake case object.
+ * @param offer - The router offer to convert.
+ * @returns The converted router offer.
+ */
+declare function toSnakeCase(offer: RouterOffer): Format.Snake<RouterOffer>;
+declare function random(): RouterOffer;
+declare class InvalidRouterOfferError extends Errors.BaseError<ZodError | Error> {
+    readonly name = "RouterOffer.InvalidRouterOfferError";
+    constructor(error: ZodError | Error);
+}
 
+type RouterOffer$1_InvalidRouterOfferError = InvalidRouterOfferError;
+declare const RouterOffer$1_InvalidRouterOfferError: typeof InvalidRouterOfferError;
 type RouterOffer$1_OfferMetadata = OfferMetadata;
 type RouterOffer$1_OfferStatus = OfferStatus;
 declare const RouterOffer$1_OfferStatusValues: typeof OfferStatusValues;
 type RouterOffer$1_RouterOffer = RouterOffer;
+declare const RouterOffer$1_RouterOfferSchema: typeof RouterOfferSchema;
+declare const RouterOffer$1_from: typeof from;
+declare const RouterOffer$1_fromSnakeCase: typeof fromSnakeCase;
+declare const RouterOffer$1_random: typeof random;
+declare const RouterOffer$1_toSnakeCase: typeof toSnakeCase;
 declare namespace RouterOffer$1 {
-  export { type RouterOffer$1_OfferMetadata as OfferMetadata, type RouterOffer$1_OfferStatus as OfferStatus, RouterOffer$1_OfferStatusValues as OfferStatusValues, type RouterOffer$1_RouterOffer as RouterOffer };
+  export { RouterOffer$1_InvalidRouterOfferError as InvalidRouterOfferError, type RouterOffer$1_OfferMetadata as OfferMetadata, type RouterOffer$1_OfferStatus as OfferStatus, RouterOffer$1_OfferStatusValues as OfferStatusValues, type RouterOffer$1_RouterOffer as RouterOffer, RouterOffer$1_RouterOfferSchema as RouterOfferSchema, RouterOffer$1_from as from, RouterOffer$1_fromSnakeCase as fromSnakeCase, RouterOffer$1_random as random, RouterOffer$1_toSnakeCase as toSnakeCase };
 }
 
 type GetParameters = {
@@ -203,38 +281,38 @@ declare class HttpGetOffersFailedError extends Errors.BaseError {
     });
 }
 
-type index_Client = Client;
-type index_GetParameters = GetParameters;
-type index_HttpForbiddenError = HttpForbiddenError;
-declare const index_HttpForbiddenError: typeof HttpForbiddenError;
-type index_HttpGetOffersFailedError = HttpGetOffersFailedError;
-declare const index_HttpGetOffersFailedError: typeof HttpGetOffersFailedError;
-type index_HttpRateLimitError = HttpRateLimitError;
-declare const index_HttpRateLimitError: typeof HttpRateLimitError;
-type index_HttpUnauthorizedError = HttpUnauthorizedError;
-declare const index_HttpUnauthorizedError: typeof HttpUnauthorizedError;
-type index_InvalidUrlError = InvalidUrlError;
-declare const index_InvalidUrlError: typeof InvalidUrlError;
-type index_MatchParameters = MatchParameters;
-type index_RouterClientConfig = RouterClientConfig;
-declare const index_connect: typeof connect;
-declare const index_get: typeof get;
-declare const index_match: typeof match;
-declare namespace index {
-  export { type index_Client as Client, type index_GetParameters as GetParameters, index_HttpForbiddenError as HttpForbiddenError, index_HttpGetOffersFailedError as HttpGetOffersFailedError, index_HttpRateLimitError as HttpRateLimitError, index_HttpUnauthorizedError as HttpUnauthorizedError, index_InvalidUrlError as InvalidUrlError, type index_MatchParameters as MatchParameters, type index_RouterClientConfig as RouterClientConfig, index_connect as connect, index_get as get, index_match as match };
+type Client$1_Client = Client;
+type Client$1_GetParameters = GetParameters;
+type Client$1_HttpForbiddenError = HttpForbiddenError;
+declare const Client$1_HttpForbiddenError: typeof HttpForbiddenError;
+type Client$1_HttpGetOffersFailedError = HttpGetOffersFailedError;
+declare const Client$1_HttpGetOffersFailedError: typeof HttpGetOffersFailedError;
+type Client$1_HttpRateLimitError = HttpRateLimitError;
+declare const Client$1_HttpRateLimitError: typeof HttpRateLimitError;
+type Client$1_HttpUnauthorizedError = HttpUnauthorizedError;
+declare const Client$1_HttpUnauthorizedError: typeof HttpUnauthorizedError;
+type Client$1_InvalidUrlError = InvalidUrlError;
+declare const Client$1_InvalidUrlError: typeof InvalidUrlError;
+type Client$1_MatchParameters = MatchParameters;
+type Client$1_RouterClientConfig = RouterClientConfig;
+declare const Client$1_connect: typeof connect;
+declare const Client$1_get: typeof get;
+declare const Client$1_match: typeof match;
+declare namespace Client$1 {
+  export { type Client$1_Client as Client, type Client$1_GetParameters as GetParameters, Client$1_HttpForbiddenError as HttpForbiddenError, Client$1_HttpGetOffersFailedError as HttpGetOffersFailedError, Client$1_HttpRateLimitError as HttpRateLimitError, Client$1_HttpUnauthorizedError as HttpUnauthorizedError, Client$1_InvalidUrlError as InvalidUrlError, type Client$1_MatchParameters as MatchParameters, type Client$1_RouterClientConfig as RouterClientConfig, Client$1_connect as connect, Client$1_get as get, Client$1_match as match };
 }
 
 declare const types: readonly ["offer_created", "offer_matched", "offer_validation"];
 type Type = (typeof types)[number];
 type EventPayload = {
     offer_created: {
-        readonly offer: RouterOffer;
+        readonly offer: Offer.Offer;
     };
     offer_matched: {
-        readonly offer: RouterOffer;
+        readonly offer: Offer.Offer;
     };
     offer_validation: {
-        readonly offer: RouterOffer;
+        readonly offer: Offer.Offer;
     };
 };
 type BaseEvent<T extends Type> = {
@@ -278,6 +356,19 @@ declare namespace RouterEvent$1 {
  */
 declare function batch$1<T>(array: Array<T>, batchSize: number): Generator<T[], void, unknown>;
 
+type Cursor = {
+    sort: "rate" | "maturity" | "expiry" | "amount";
+    dir: "asc" | "desc";
+    rate?: string;
+    maturity?: number;
+    expiry?: number;
+    assets?: string;
+    hash: string;
+};
+declare function validateCursor(cursor: unknown): cursor is Cursor;
+declare function encodeCursor(c: Cursor): string;
+declare function decodeCursor(token?: string): Cursor | null;
+
 /**
  * Polls a function at a specified interval.
  * Inspired by https://github.com/wevm/viem/blob/845994d20275d08ff892018e237a4b599eeefb6a/src/utils/poll.ts
@@ -537,4 +628,4 @@ declare namespace Validation {
   export { type Validation_Issue as Issue, type Validation_Result as Result, Validation_run as run };
 }
 
-export { Chain$1 as Chain, type Compute, index as Router, RouterEvent$1 as RouterEvent, RouterOffer$1 as RouterOffer, Validation, ValidationRule, batch$1 as batch, poll, wait };
+export { Chain$1 as Chain, type Compute, type Cursor, Client$1 as Router, RouterEvent$1 as RouterEvent, RouterOffer$1 as RouterOffer, Validation, ValidationRule, batch$1 as batch, decodeCursor, encodeCursor, poll, validateCursor, wait };