@morpho-dev/router 0.8.0 → 0.9.0

package/dist/index.node.d.ts

@@ -510,7 +510,7 @@ declare const MorphoV2: readonly [{
   readonly stateMutability: "nonpayable";
   readonly inputs: readonly [{
     readonly type: "address";
-    readonly name: "recipient";
+    readonly name: "feeRecipient";
   }];
   readonly outputs: readonly [];
 }, {
@@ -590,6 +590,15 @@ declare const MorphoV2: readonly [{
   }, {
     readonly type: "address";
     readonly name: "taker";
+  }, {
+    readonly type: "address";
+    readonly name: "takerCallback";
+  }, {
+    readonly type: "bytes";
+    readonly name: "takerCallbackData";
+  }, {
+    readonly type: "address";
+    readonly name: "receiverIfTakerIsSeller";
   }, {
     readonly type: "tuple";
     readonly components: readonly [{
@@ -651,6 +660,9 @@ declare const MorphoV2: readonly [{
     }, {
       readonly type: "bytes";
       readonly name: "callbackData";
+    }, {
+      readonly type: "address";
+      readonly name: "receiverIfMakerIsSeller";
     }];
     readonly name: "offer";
   }, {
@@ -672,12 +684,6 @@ declare const MorphoV2: readonly [{
   }, {
     readonly type: "bytes32[]";
     readonly name: "proof";
-  }, {
-    readonly type: "address";
-    readonly name: "takerCallback";
-  }, {
-    readonly type: "bytes";
-    readonly name: "takerCallbackData";
   }];
   readonly outputs: readonly [{
     readonly type: "uint256";
@@ -799,6 +805,9 @@ declare const MorphoV2: readonly [{
   }, {
     readonly type: "address";
     readonly name: "onBehalf";
+  }, {
+    readonly type: "address";
+    readonly name: "receiver";
   }];
   readonly outputs: readonly [{
     readonly type: "uint256";
@@ -841,6 +850,9 @@ declare const MorphoV2: readonly [{
   }, {
     readonly type: "address";
     readonly name: "onBehalf";
+  }, {
+    readonly type: "address";
+    readonly name: "receiver";
   }];
   readonly outputs: readonly [];
 }, {
@@ -1028,7 +1040,7 @@ declare const MorphoV2: readonly [{
   readonly type: "event";
   readonly inputs: readonly [{
     readonly type: "address";
-    readonly name: "recipient";
+    readonly name: "feeRecipient";
     readonly indexed: true;
   }];
 }, {
@@ -1103,6 +1115,9 @@ declare const MorphoV2: readonly [{
   }, {
     readonly type: "bool";
     readonly name: "sellerIsBorrower";
+  }, {
+    readonly type: "address";
+    readonly name: "sellerReceiver";
   }, {
     readonly type: "bytes32";
     readonly name: "group";
@@ -1116,7 +1131,6 @@ declare const MorphoV2: readonly [{
   readonly inputs: readonly [{
     readonly type: "address";
     readonly name: "caller";
-    readonly indexed: true;
   }, {
     readonly type: "bytes32";
     readonly name: "id";
@@ -1131,6 +1145,10 @@ declare const MorphoV2: readonly [{
     readonly type: "address";
     readonly name: "onBehalf";
     readonly indexed: true;
+  }, {
+    readonly type: "address";
+    readonly name: "receiver";
+    readonly indexed: true;
   }];
 }, {
   readonly name: "WithdrawCollateral";
@@ -1153,6 +1171,9 @@ declare const MorphoV2: readonly [{
     readonly type: "address";
     readonly name: "onBehalf";
     readonly indexed: true;
+  }, {
+    readonly type: "address";
+    readonly name: "receiver";
   }];
 }];
 type MorphoV2 = typeof MorphoV2;
@@ -1886,7 +1907,8 @@ type Offer = {
   readonly callback: {
     readonly address: Address;
     readonly data: Hex;
-  };
+  }; /** Receiver of loan token proceeds when maker is seller on `take()`. */
+  readonly receiverIfMakerIsSeller: Address;
 };
 declare enum Status {
   VALID = "VALID",
@@ -1919,6 +1941,7 @@ declare const OfferSchema: () => z$1.ZodObject<{
     address: z$1.ZodPipe<z$1.ZodString, z$1.ZodTransform<`0x${string}`, string>>;
     data: z$1.ZodPipe<z$1.ZodString, z$1.ZodTransform<`0x${string}`, string>>;
   }, z$1.core.$strip>;
+  receiverIfMakerIsSeller: z$1.ZodPipe<z$1.ZodString, z$1.ZodTransform<`0x${string}`, string>>;
 }, z$1.core.$strip>;
 /**
  * Input type for creating offers. Accepts flexible group types that will be coerced to Hex.
@@ -1931,12 +1954,13 @@ declare const OfferSchema: () => z$1.ZodObject<{
  *
  * All values validated to be non-negative and within bytes32 range.
  */
-type OfferInput = Compute<Omit<Offer, "chainId" | "group" | "session" | "obligationUnits" | "obligationShares"> & {
+type OfferInput = Compute<Omit<Offer, "chainId" | "group" | "session" | "obligationUnits" | "obligationShares" | "receiverIfMakerIsSeller"> & {
   chainId: number;
   group: Hex | bigint | number | string; /** Optional: defaults to zero bytes32. */
   session?: Hex | bigint | number | string; /** Optional: defaults to 0n. Mutually exclusive with assets and obligationShares. */
   obligationUnits?: bigint; /** Optional: defaults to 0n. Mutually exclusive with assets and obligationUnits. */
-  obligationShares?: bigint;
+  obligationShares?: bigint; /** Optional: defaults to maker for backward compatibility. */
+  receiverIfMakerIsSeller?: Address;
 }>;
 /**
  * Creates an offer from a plain object.
@@ -1954,9 +1978,9 @@ declare namespace from$13 {
  * @param input - The offer to create.
  * @returns The created offer.
  */
-declare function fromSnakeCase$1(input: Snake<Omit<Offer, "chainId" | "session"> & {
-  chainId: number;
-  session: string;
+declare function fromSnakeCase$1(input: Snake<Omit<Offer, "session" | "receiverIfMakerIsSeller"> & {
+  session?: Hex;
+  receiverIfMakerIsSeller?: Address;
 }>): Offer;
 /**
  * Converts an offer to a snake case object.
@@ -1994,6 +2018,7 @@ declare const serialize: (offer: Offer) => {
     address: `0x${string}`;
     data: `0x${string}`;
   };
+  receiverIfMakerIsSeller: `0x${string}`;
   hash: `0x${string}`;
 };
 type RandomConfig = {
@@ -2016,6 +2041,7 @@ type RandomConfig = {
     address: Address;
     data: Hex;
   };
+  receiverIfMakerIsSeller?: Address;
   collaterals?: readonly Collateral[];
 };
 /**
@@ -2086,6 +2112,9 @@ declare const types: {
   }, {
     readonly name: "callback";
     readonly type: "Callback";
+  }, {
+    readonly name: "receiverIfMakerIsSeller";
+    readonly type: "address";
   }];
   readonly Collateral: readonly [{
     readonly name: "asset";
@@ -2184,6 +2213,11 @@ declare const takeEvent: {
     readonly type: "bool";
     readonly indexed: false;
     readonly internalType: "bool";
+  }, {
+    readonly name: "sellerReceiver";
+    readonly type: "address";
+    readonly indexed: false;
+    readonly internalType: "address";
   }, {
     readonly name: "group";
     readonly type: "bytes32";
@@ -2387,26 +2421,26 @@ declare namespace from$11 {
   type ReturnType = Position;
 }
 declare namespace Quote_d_exports {
-  export { InvalidQuoteError, Quote, QuoteSchema, from$10 as from, fromSnakeCase, random };
+  export { InvalidQuoteError, Quote, QuoteInput, Side, from$10 as from, fromSnakeCase, random };
 }
-type Quote = {
+type Side = {
+  /** The best side tick, or null when no active quote exists. */tick: number | null; /** The side price for the obligation. (18 decimals). */
+  price: bigint;
+};
+type QuoteInput = {
   /** The obligation id. */obligationId: Hex;
   ask: {
-    /** The ask price for the obligation. (18 decimals). */price: bigint;
+    /** The best ask tick, or null when there is no active ask quote. */tick: number | null;
   };
   bid: {
-    /** The bid price for the obligation. (18 decimals). */price: bigint;
+    /** The best bid tick, or null when there is no active bid quote. */tick: number | null;
   };
 };
-declare const QuoteSchema: z$1.ZodObject<{
-  obligationId: z$1.ZodPipe<z$1.ZodString, z$1.ZodTransform<`0x${string}`, string>>;
-  ask: z$1.ZodObject<{
-    price: z$1.ZodBigInt;
-  }, z$1.core.$strip>;
-  bid: z$1.ZodObject<{
-    price: z$1.ZodBigInt;
-  }, z$1.core.$strip>;
-}, z$1.core.$strip>;
+type Quote = {
+  /** The obligation id. */obligationId: Hex;
+  ask: Side;
+  bid: Side;
+};
 /**
  * Creates a quote for a given obligation.
  * @constructor
@@ -2416,12 +2450,12 @@ declare const QuoteSchema: z$1.ZodObject<{
  *
  * @example
  * ```ts
- * const quote = Quote.from({ obligationId: "0x123", ask: { price: 100n }, bid: { price: 100n } });
+ * const quote = Quote.from({ obligationId: "0x123", ask: { tick: 500 }, bid: { tick: 510 } });
  * ```
  */
 declare function from$10(parameters: from$10.Parameters): from$10.ReturnType;
 declare namespace from$10 {
-  type Parameters = Quote;
+  type Parameters = QuoteInput;
   type ReturnType = Quote;
   type ErrorType = InvalidQuoteError;
 }
@@ -2433,7 +2467,7 @@ declare namespace from$10 {
  */
 declare function fromSnakeCase(snake: fromSnakeCase.Parameters): fromSnakeCase.ReturnType;
 declare namespace fromSnakeCase {
-  type Parameters = Snake<Quote>;
+  type Parameters = Snake<QuoteInput>;
   type ReturnType = Quote;
   type ErrorType = from$10.ErrorType;
 }
@@ -2918,6 +2952,7 @@ type Row = {
     address: Address;
     data: Hex;
   };
+  receiverIfMakerIsSeller: Address;
   consumed: bigint;
   available: bigint;
   takeable: bigint;
@@ -2937,18 +2972,6 @@ type OffersDomain = {
   get: (parameters?: GetOffersParams) => Promise<{
     rows: Row[];
     nextCursor: string | null;
-  }>; /** Get obligations */
-  getObligations: (parameters?: {
-    ids?: Hex[];
-    chainId?: Id[];
-    loanToken?: Address[];
-    collateralToken?: Address[];
-    maturity?: number[];
-    cursor?: string;
-    limit?: number;
-  }) => Promise<{
-    obligations: Obligation[];
-    nextCursor: string | null;
   }>; /** Get quotes for given obligations. */
   getQuotes: (parameters: {
     obligationIds: Hex[];
@@ -3113,6 +3136,14 @@ type ObligationsDomain = {
    * @param obligations - Obligations to insert. {@link Obligation.Obligation}
    */
   create: (obligations: Obligation[]) => Promise<void>;
+  /**
+   * Get active obligations with optional chain filters.
+   * @param parameters - Optional chain filters.
+   * @returns Matching obligations.
+   */
+  get: (parameters?: {
+    chainId?: Id[];
+  }) => Promise<Obligation[]>;
 };
 //#endregion
 //#region src/database/domains/Offsets.d.ts
@@ -3304,6 +3335,34 @@ type ValidationsDomain = {
    */
   upsert: (validations: Validation[]) => Promise<void>;
 };
+//#endregion
+//#region src/database/readers/ObligationsListing.d.ts
+type ListObligationsParameters = {
+  ids?: Hex[];
+  chainId?: Id[];
+  loanToken?: Address[];
+  collateralToken?: Address[];
+  maturity?: number[];
+  sort?: string[];
+  cursor?: string;
+  limit?: number;
+};
+type ListedObligation = {
+  obligation: Obligation;
+  quote: Quote;
+};
+type ListObligationsResult = {
+  obligations: ListedObligation[];
+  nextCursor: string | null;
+};
+type ObligationsListingReader = {
+  /**
+   * Lists obligations with SQL keyset pagination and opaque cursor handling.
+   * @param parameters - Optional filters, sorting, and pagination cursor.
+   * @returns Listed obligations with associated quotes and a next cursor.
+   */
+  list: (parameters?: ListObligationsParameters) => Promise<ListObligationsResult>;
+};
 declare namespace Database_d_exports {
   export { Core, Database, Driver, WithDomains, connect$2 as connect, getSchemaNamesForMigration };
 }
@@ -3324,7 +3383,13 @@ type Domains = {
   positions: PositionsDomain;
   transfers: TransfersDomain;
 };
-type WithDomains<D extends Driver> = D & Domains;
+type Readers = {
+  obligations: ObligationsListingReader;
+};
+type DatabaseFacade = Domains & {
+  readers: Readers;
+};
+type WithDomains<D extends Driver> = D & DatabaseFacade;
 type Core = Omit<WithDomains<Driver>, "transaction"> & {
   transaction<T>(fn: (tx: WithDomains<Driver>) => Promise<T>): Promise<T>;
 };
@@ -3944,11 +4009,16 @@ interface paths {
     };
     /**
      * List all obligations
-     * @description Returns a list of obligations with their current best ask and bid. Obligations are sorted by their id in ascending order by default.
+     * @description Returns a list of obligations with their current best ask and bid. Sorting is customizable with the sort parameter and defaults to id ascending.
      */
     get: {
       parameters: {
         query?: {
+          /**
+           * @description Sort order as comma-separated fields (`id`, `ask`, `bid`, `maturity`). Prefix with `-` for descending order. Max 3 fields.
+           * @example -ask,bid,maturity
+           */
+          sort?: string;
           /**
            * @description Filter by exact maturity timestamps (comma-separated, unix seconds).
            * @example 1761922800,1764524800
@@ -3975,8 +4045,8 @@ interface paths {
            */
           limit?: number;
           /**
-           * @description Obligation id cursor for pagination.
-           * @example 0x25690ae1aee324a005be565f3bcdd16dbf8daf7969b26c181c8b8f467dad9abc
+           * @description Pagination cursor in base64url-encoded format.
+           * @example eyJzb3J0IjpbImlkIl0sImlkIjoiMHgxMjM0NTY3ODkwMTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0NTY3ODkwMTIzNDU2Nzg5MDEyMzQ1Njc4OTAiLCJhc2siOiIwIiwiYmlkIjoiMCIsIm1hdHVyaXR5IjoxNzYxOTIyODAwfQ
            */
           cursor?: string;
         };
@@ -4461,7 +4531,8 @@ interface components {
        *           "group": "0x000000000000000000000000000000000000000000000000000000000008b8f4",
        *           "session": "0x0000000000000000000000000000000000000000000000000000000000000000",
        *           "callback": "0x0000000000000000000000000000000000000000",
-       *           "callback_data": "0x"
+       *           "callback_data": "0x",
+       *           "receiver_if_maker_is_seller": "0x7b093658BE7f90B63D7c359e8f408e503c2D9401"
        *         },
        *         "offer_hash": "0xac4bd8318ec914f89f8af913f162230575b0ac0696a19256bc12138c5cfe1427",
        *         "obligation_id": "0x25690ae1aee324a005be565f3bcdd16dbf8daf7969b26c181c8b8f467dad9abc",
@@ -4505,7 +4576,8 @@ interface components {
        *       "group": "0x000000000000000000000000000000000000000000000000000000000008b8f4",
        *       "session": "0x0000000000000000000000000000000000000000000000000000000000000000",
        *       "callback": "0x0000000000000000000000000000000000000000",
-       *       "callback_data": "0x"
+       *       "callback_data": "0x",
+       *       "receiver_if_maker_is_seller": "0x7b093658BE7f90B63D7c359e8f408e503c2D9401"
        *     }
        */
       offer: components["schemas"]["OfferDataResponse"]; /** @example 0xac4bd8318ec914f89f8af913f162230575b0ac0696a19256bc12138c5cfe1427 */
@@ -4551,7 +4623,8 @@ interface components {
       group: string; /** @example 0x0000000000000000000000000000000000000000000000000000000000000000 */
       session: string; /** @example 0x0000000000000000000000000000000000000000 */
       callback: string; /** @example 0x */
-      callback_data: string;
+      callback_data: string; /** @example 0x7b093658BE7f90B63D7c359e8f408e503c2D9401 */
+      receiver_if_maker_is_seller: string;
     };
     ObligationOfferResponse: {
       /** @example 0xC9A9C45C0eB717f8b5F193Af6bAa05A1c0Ac5078 */loan_token: string;
@@ -4573,7 +4646,7 @@ interface components {
       oracle: string;
     };
     ObligationListResponse: {
-      meta: components["schemas"]["Meta"]; /** @example 0x25690ae1aee324a005be565f3bcdd16dbf8daf7969b26c181c8b8f467dad9abc */
+      meta: components["schemas"]["Meta"]; /** @example eyJzb3J0IjpbImlkIl0sImlkIjoiMHgxMjM0NTY3ODkwMTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0NTY3ODkwMTIzNDU2Nzg5MDEyMzQ1Njc4OTAiLCJhc2siOiIwIiwiYmlkIjoiMCIsIm1hdHVyaXR5IjoxNzYxOTIyODAwfQ */
       cursor: string | null; /** @description List of obligations with takable offers. */
       data: components["schemas"]["ObligationResponse"][];
     };
@@ -4587,10 +4660,20 @@ interface components {
       bid: components["schemas"]["BidResponse"];
     };
     AskResponse: {
-      /** @example 1000000000000000000 */price: string;
+      /**
+       * @description Best ask tick. Null when there is no active ask quote.
+       * @example 500
+       */
+      tick: number | null; /** @example 1000000000000000000 */
+      price: string;
     };
     BidResponse: {
-      /** @example 1000000000000000000 */price: string;
+      /**
+       * @description Best bid tick. Null when there is no active bid quote.
+       * @example 500
+       */
+      tick: number | null; /** @example 1000000000000000000 */
+      price: string;
     };
     ObligationSingleSuccessResponse: {
       meta: components["schemas"]["Meta"]; /** @example null */
@@ -4749,7 +4832,8 @@ interface components {
        *       "data": "0x"
        *     }
        */
-      callback: components["schemas"]["ValidateCallbackRequest"];
+      callback: components["schemas"]["ValidateCallbackRequest"]; /** @example 0x7b093658BE7f90B63D7c359e8f408e503c2D9401 */
+      receiver_if_maker_is_seller: string;
     };
     ValidateCollateralRequest: {
       /** @example 0x34Cf890dB685FC536E05652FB41f02090c3fb751 */asset: string; /** @example 0x45093658BE7f90B63D7c359e8f408e503c2D9401 */
@@ -4792,6 +4876,7 @@ type ObligationResponse = paths["/v1/obligations"]["get"]["responses"]["200"]["c
  * Creates an `ObligationResponse` from a `Obligation`.
  * @constructor
  * @param obligation - {@link Obligation}
+ * @param quote - {@link Quote}
  * @returns The created `ObligationResponse`. {@link ObligationResponse}
  */
 declare function from$3(obligation: Obligation, quote: Quote): ObligationResponse;
@@ -4823,6 +4908,7 @@ type Input = Readonly<{
     address: Address;
     data: Hex;
   };
+  receiverIfMakerIsSeller: Address;
   root?: Hex | undefined;
   proof?: Hex[] | undefined;
   signature?: Hex | undefined;
@@ -4957,6 +5043,7 @@ declare const schemas: {
     loan_tokens: z$1.ZodOptional<z$1.ZodPipe<z$1.ZodTransform<{} | null | undefined, unknown>, z$1.ZodArray<z$1.ZodPipe<z$1.ZodString, z$1.ZodTransform<`0x${string}`, string>>>>>;
     collateral_tokens: z$1.ZodOptional<z$1.ZodPipe<z$1.ZodTransform<{} | null | undefined, unknown>, z$1.ZodArray<z$1.ZodPipe<z$1.ZodString, z$1.ZodTransform<`0x${string}`, string>>>>>;
     maturities: z$1.ZodOptional<z$1.ZodPipe<z$1.ZodTransform<{} | null | undefined, unknown>, z$1.ZodArray<z$1.ZodPipe<z$1.ZodString, z$1.ZodTransform<number, string>>>>>;
+    sort: z$1.ZodOptional<z$1.ZodPipe<z$1.ZodTransform<{} | null | undefined, unknown>, z$1.ZodArray<z$1.ZodString>>>;
     limit: z$1.ZodDefault<z$1.ZodOptional<z$1.ZodPipe<z$1.ZodPipe<z$1.ZodString, z$1.ZodTransform<number, string>>, z$1.ZodNumber>>>;
   }, z$1.core.$strip>;
   readonly get_obligation: z$1.ZodObject<{
@@ -5227,13 +5314,16 @@ declare namespace getOffers {
 }
 declare function getObligations(apiClient: Client$1<paths>, parameters?: getObligations.Parameters): Promise<getObligations.ReturnType>;
 declare namespace getObligations {
+  type SortField = "id" | "ask" | "bid" | "maturity";
+  type SortEntry = SortField | `-${SortField}`;
   type Parameters = {
-    /** Pagination cursor is a 32-byte hex string. */cursor?: Hex; /** Maximum number of obligations to return. @default 20 */
+    /** Pagination cursor in base64url-encoded format. */cursor?: string; /** Maximum number of obligations to return. @default 20 */
     limit?: number; /** Filter by chain IDs (comma-separated). */
     chainIds?: number[]; /** Filter by loan token addresses (comma-separated). */
     loanTokens?: Address[]; /** Filter by collateral tokens (comma-separated, matches any collateral). */
     collateralTokens?: Address[]; /** Filter by exact maturity timestamps (comma-separated, unix seconds). */
-    maturities?: number[];
+    maturities?: number[]; /** Sort order entries in priority order. Prefix with '-' for descending. Max 3 fields. */
+    sort?: SortEntry[];
   };
   type ReturnType = {
     obligations: Compute<{
@@ -6129,6 +6219,25 @@ declare const offers: drizzle_orm_pg_core0.PgTableWithColumns<{
       identity: undefined;
       generated: undefined;
     }, {}, {}>;
+    receiverIfMakerIsSeller: drizzle_orm_pg_core0.PgColumn<{
+      name: "receiver_if_maker_is_seller";
+      tableName: EnumTableName.OFFERS;
+      dataType: "string";
+      columnType: "PgVarchar";
+      data: string;
+      driverParam: string;
+      notNull: false;
+      hasDefault: false;
+      isPrimaryKey: false;
+      isAutoincrement: false;
+      hasRuntimeDefault: false;
+      enumValues: [string, ...string[]];
+      baseColumn: never;
+      identity: undefined;
+      generated: undefined;
+    }, {}, {
+      length: 42;
+    }>;
     blockNumber: drizzle_orm_pg_core0.PgColumn<{
       name: "block_number";
       tableName: EnumTableName.OFFERS;