@morpho-dev/router 0.1.10 → 0.1.12

package/dist/index.browser.d.ts

@@ -2,143 +2,9 @@ import * as _morpho_dev_mempool from '@morpho-dev/mempool';
 import { Offer, Errors, Format, Maturity, LLTV, Compute, Chain } from '@morpho-dev/mempool';
 export * from '@morpho-dev/mempool';
 import * as viem from 'viem';
-import { PublicActions, Address, Hex } from 'viem';
+import { Address, Hex, PublicActions } from 'viem';
 import { z, ZodError } from 'zod/v4';
 
-declare function fetchBalancesAndAllowances(parameters: {
-    client: Pick<PublicActions, "multicall">;
-    spender: Address;
-    pairs: Array<{
-        user: Address;
-        token: Address;
-    }>;
-    options?: {
-        batchSize?: number;
-        retryAttempts?: number;
-        retryDelayMs?: number;
-        blockNumber?: number;
-    };
-}): Promise<Map<Address, Map<Address, {
-    balance: bigint;
-    allowance: bigint;
-}>>>;
-type LiquidityUserPosition = {
-    id: string;
-    availableLiquidityQueueId: string;
-    user: string;
-    chainId: bigint;
-    amount: string;
-    updatedAt: Date;
-};
-type LiquidityQueue = {
-    queueId: string;
-    availableLiquidityPoolId: string;
-    index: number;
-    updatedAt: Date;
-};
-type LiquidityPool = {
-    id: string;
-    amount: string;
-    updatedAt: Date;
-};
-type LiquidityQueueWithPool = {
-    queue: LiquidityQueue;
-    pool: LiquidityPool;
-};
-type Liquidity = {
-    userPosition: LiquidityUserPosition;
-    queues: LiquidityQueueWithPool[];
-};
-declare function fetch(parameters: {
-    client: Pick<PublicActions, "multicall">;
-    chainId: bigint;
-    spender: Address;
-    type: CallbackType;
-    pairs: Array<{
-        user: Address;
-        contract: Address;
-    }>;
-    options?: {
-        batchSize?: number;
-        retryAttempts?: number;
-        retryDelayMs?: number;
-        blockNumber?: number;
-    };
-}): Promise<Liquidity[]>;
-declare function serialize(liquidity: Liquidity): string;
-
-type Liquidity$1_Liquidity = Liquidity;
-type Liquidity$1_LiquidityPool = LiquidityPool;
-type Liquidity$1_LiquidityQueue = LiquidityQueue;
-type Liquidity$1_LiquidityQueueWithPool = LiquidityQueueWithPool;
-type Liquidity$1_LiquidityUserPosition = LiquidityUserPosition;
-declare const Liquidity$1_fetch: typeof fetch;
-declare const Liquidity$1_fetchBalancesAndAllowances: typeof fetchBalancesAndAllowances;
-declare const Liquidity$1_serialize: typeof serialize;
-declare namespace Liquidity$1 {
-  export { type Liquidity$1_Liquidity as Liquidity, type Liquidity$1_LiquidityPool as LiquidityPool, type Liquidity$1_LiquidityQueue as LiquidityQueue, type Liquidity$1_LiquidityQueueWithPool as LiquidityQueueWithPool, type Liquidity$1_LiquidityUserPosition as LiquidityUserPosition, Liquidity$1_fetch as fetch, Liquidity$1_fetchBalancesAndAllowances as fetchBalancesAndAllowances, Liquidity$1_serialize as serialize };
-}
-
-declare enum CallbackType {
-    BuyWithEmptyCallback = "buy_with_empty_callback",
-    SellWithdrawFromWallet = "sell_withdraw_from_wallet"
-}
-declare const WhitelistedCallbackAddresses: Record<CallbackType, readonly string[]>;
-declare function buildLiquidity(parameters: {
-    type: CallbackType;
-    user: string;
-    contract: string;
-    chainId: bigint;
-    amount: string | bigint;
-    index?: number;
-    updatedAt?: Date;
-}): Liquidity;
-declare function getCallbackIdForOffer(offer: Offer.Offer): string | null;
-declare function decode$1(parameters: {
-    type: CallbackType;
-    data: Hex;
-}): Array<{
-    collateral: Address;
-    amount: bigint;
-}>;
-declare function encode$1(parameters: {
-    type: CallbackType;
-    data: {
-        collaterals: Address[];
-        amounts: bigint[];
-    };
-}): Hex;
-
-type Callback_CallbackType = CallbackType;
-declare const Callback_CallbackType: typeof CallbackType;
-declare const Callback_WhitelistedCallbackAddresses: typeof WhitelistedCallbackAddresses;
-declare const Callback_buildLiquidity: typeof buildLiquidity;
-declare const Callback_getCallbackIdForOffer: typeof getCallbackIdForOffer;
-declare namespace Callback {
-  export { Callback_CallbackType as CallbackType, Callback_WhitelistedCallbackAddresses as WhitelistedCallbackAddresses, Callback_buildLiquidity as buildLiquidity, decode$1 as decode, encode$1 as encode, Callback_getCallbackIdForOffer as getCallbackIdForOffer };
-}
-
-type Cursor = {
-    sort: "rate" | "maturity" | "expiry" | "amount";
-    dir: "asc" | "desc";
-    rate?: string;
-    maturity?: number;
-    expiry?: number;
-    assets?: string;
-    hash: string;
-};
-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 const OfferStatusValues: readonly ["valid", "callback_not_supported", "callback_error", "unverified"];
 type OfferStatus = (typeof OfferStatusValues)[number];
 type OfferMetadata = {
@@ -364,11 +230,11 @@ type MatchParameters = {
     /** Maximum number of offers to return. Defaults to 20. Maximum is 100. */
     limit?: number;
 };
-type RouterClientConfig = {
+type RouterApiClientConfig = {
     readonly url: URL;
     readonly headers: Headers;
 };
-type Client = Compute<RouterClientConfig & {
+type Client = Compute<RouterApiClientConfig & {
     get: (parameters: GetParameters) => Promise<{
         cursor: string | null;
         offers: OfferResponse[];
@@ -390,7 +256,7 @@ declare namespace connect {
  * Get offers from the router.
  * @returns The offers with pagination cursor.
  */
-declare function get(config: RouterClientConfig, parameters: GetParameters): Promise<{
+declare function get(config: RouterApiClientConfig, parameters: GetParameters): Promise<{
     cursor: string | null;
     offers: OfferResponse[];
 }>;
@@ -401,7 +267,7 @@ declare namespace get {
  * Match offers from the router.
  * @returns The matched offers with pagination cursor.
  */
-declare function match(config: RouterClientConfig, parameters: MatchParameters): Promise<{
+declare function match(config: RouterApiClientConfig, parameters: MatchParameters): Promise<{
     cursor: string | null;
     offers: OfferResponse[];
 }>;
@@ -445,12 +311,164 @@ 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;
+type Client$1_RouterApiClientConfig = RouterApiClientConfig;
 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 };
+  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_RouterApiClientConfig as RouterApiClientConfig, Client$1_connect as connect, Client$1_get as get, Client$1_match as match };
+}
+
+type LiquidityUserPosition = {
+    id: string;
+    availableLiquidityQueueId: string;
+    user: string;
+    chainId: bigint;
+    amount: string;
+    updatedAt: Date;
+};
+type LiquidityQueue = {
+    queueId: string;
+    availableLiquidityPoolId: string;
+    index: number;
+    callbackAmount: string;
+    updatedAt: Date;
+};
+type LiquidityPool = {
+    id: string;
+    amount: string;
+    updatedAt: Date;
+};
+type LiquidityQueueWithPool = {
+    queue: LiquidityQueue;
+    pool: LiquidityPool;
+};
+type Liquidity = {
+    userPosition: LiquidityUserPosition;
+    queues: LiquidityQueueWithPool[];
+};
+type FetchOptions = {
+    batchSize?: number;
+    retryAttempts?: number;
+    retryDelayMs?: number;
+    blockNumber?: number;
+};
+type LiquidityClient = {
+    /** Fetch liquidity for buy offers based on wallet token balances and allowances. */
+    fetchBuyLiquidity: (parameters: {
+        chainId: bigint;
+        spender: Address;
+        pairs: Array<{
+            user: Address;
+            loanToken: Address;
+        }>;
+        options?: FetchOptions;
+    }) => Promise<Liquidity[]>;
+    /** Fetch liquidity for sell offers based on collateral capacity and existing positions. */
+    fetchSellLiquidity: (parameters: {
+        chainId: bigint;
+        spender: Address;
+        morphoAddress: Address;
+        offers: Array<Offer.Offer>;
+        options?: FetchOptions;
+    }) => Promise<Liquidity[]>;
+};
+/**
+ * Create a liquidity client with the specified blockchain client.
+ *
+ * @param config - Configuration containing the blockchain client
+ * @returns LiquidityClient
+ */
+declare const create: (config: {
+    client: Pick<PublicActions, "multicall">;
+}) => LiquidityClient;
+declare function serialize(liquidity: Liquidity): string;
+
+type Liquidity$1_Liquidity = Liquidity;
+type Liquidity$1_LiquidityClient = LiquidityClient;
+type Liquidity$1_LiquidityPool = LiquidityPool;
+type Liquidity$1_LiquidityQueue = LiquidityQueue;
+type Liquidity$1_LiquidityQueueWithPool = LiquidityQueueWithPool;
+type Liquidity$1_LiquidityUserPosition = LiquidityUserPosition;
+declare const Liquidity$1_create: typeof create;
+declare const Liquidity$1_serialize: typeof serialize;
+declare namespace Liquidity$1 {
+  export { type Liquidity$1_Liquidity as Liquidity, type Liquidity$1_LiquidityClient as LiquidityClient, type Liquidity$1_LiquidityPool as LiquidityPool, type Liquidity$1_LiquidityQueue as LiquidityQueue, type Liquidity$1_LiquidityQueueWithPool as LiquidityQueueWithPool, type Liquidity$1_LiquidityUserPosition as LiquidityUserPosition, Liquidity$1_create as create, Liquidity$1_serialize as serialize };
+}
+
+declare enum CallbackType {
+    BuyWithEmptyCallback = "buy_with_empty_callback",
+    SellERC20Callback = "sell_erc20_callback"
+}
+declare const WhitelistedCallbackAddresses: Record<CallbackType, readonly string[]>;
+type BuildLiquidityParameters = {
+    type: CallbackType.BuyWithEmptyCallback;
+    user: Address;
+    loanToken: Address;
+    chainId: Chain.Id;
+    amount: bigint;
+    index?: number;
+    updatedAt?: Date;
+} | {
+    type: CallbackType.SellERC20Callback;
+    user: Address;
+    termId: string;
+    offerHash: string;
+    chainId: Chain.Id;
+    amount: bigint;
+    collaterals: Array<{
+        collateralAddress: Address;
+        balance: bigint;
+        callbackAmount: bigint;
+    }>;
+    index?: number;
+    updatedAt?: Date;
+};
+declare function buildLiquidity(parameters: BuildLiquidityParameters): Liquidity;
+declare function getCallbackIdForOffer(offer: Offer.Offer): string | null;
+declare function decode$1(parameters: {
+    type: CallbackType;
+    data: Hex;
+}): Array<{
+    collateral: Address;
+    amount: bigint;
+}>;
+declare function encode$1(parameters: {
+    type: CallbackType;
+    data: {
+        collaterals: Address[];
+        amounts: bigint[];
+    };
+}): Hex;
+
+type Callback_CallbackType = CallbackType;
+declare const Callback_CallbackType: typeof CallbackType;
+declare const Callback_WhitelistedCallbackAddresses: typeof WhitelistedCallbackAddresses;
+declare const Callback_buildLiquidity: typeof buildLiquidity;
+declare const Callback_getCallbackIdForOffer: typeof getCallbackIdForOffer;
+declare namespace Callback {
+  export { Callback_CallbackType as CallbackType, Callback_WhitelistedCallbackAddresses as WhitelistedCallbackAddresses, Callback_buildLiquidity as buildLiquidity, decode$1 as decode, encode$1 as encode, Callback_getCallbackIdForOffer as getCallbackIdForOffer };
+}
+
+type Cursor = {
+    sort: "rate" | "maturity" | "expiry" | "amount";
+    dir: "asc" | "desc";
+    rate?: string;
+    maturity?: number;
+    expiry?: number;
+    assets?: string;
+    hash: string;
+};
+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 };
 }
 
 /**
@@ -691,7 +709,31 @@ declare function morpho(): (Rule<{
     readonly hash: viem.Hex;
     signature?: viem.Hex;
     createdAt?: number;
-}, "sell_offers_callback_collateral_invalid", MorphoContext>)[];
+}, "sell_offers_callback_collateral_invalid", MorphoContext> | Rule<{
+    readonly offering: Address;
+    readonly assets: bigint;
+    readonly rate: bigint;
+    readonly maturity: number & _morpho_dev_mempool.Brand<"Maturity">;
+    readonly expiry: number;
+    readonly nonce: bigint;
+    readonly buy: boolean;
+    readonly chainId: bigint;
+    readonly loanToken: Address;
+    readonly start: number;
+    readonly collaterals: readonly {
+        asset: Address;
+        oracle: Address;
+        lltv: bigint & _morpho_dev_mempool.Brand<"LLTV">;
+    }[];
+    readonly callback: {
+        readonly address: Address;
+        readonly data: viem.Hex;
+        readonly gasLimit: bigint;
+    };
+    readonly hash: viem.Hex;
+    signature?: viem.Hex;
+    createdAt?: number;
+}, "maturity", MorphoContext>)[];
 
 type ValidationRule_Batch<T, RuleName extends string, Ctx = void> = Batch<T, RuleName, Ctx>;
 type ValidationRule_MorphoContext = MorphoContext;
@@ -746,4 +788,4 @@ declare namespace Validation {
   export { type Validation_Issue as Issue, type Validation_Result as Result, Validation_run as run };
 }
 
-export { Callback, Cursor$1 as Cursor, Liquidity$1 as Liquidity, Client$1 as Router, RouterOffer$1 as RouterOffer, Validation, ValidationRule };
+export { Callback, Cursor$1 as Cursor, Liquidity$1 as Liquidity, Client$1 as RouterApi, RouterOffer$1 as RouterOffer, Validation, ValidationRule };