@morpho-dev/router 0.10.0 → 0.12.0

package/docs/integrator.md

@@ -1,35 +1,25 @@
-# Documentation
+# Router
 
-This document is intended for **technical integrators** and **product/design teams**. It explains how the router works end-to-end, how to integrate with it, and what the main user-facing implications are.
+The router improves the discoverability of offers made by **makers** for **takers**. Because offers are published to a **public**, **uncensored mempool**, the router ensures malicious or invalid offers are filtered out before they reach takers, acting as an opinionated infrastructure that lets applications be built without needing custom offer validation or anti-spam logic.
 
-At a high level, the router indexes and exposes offers published to the on-chain mempool and computes the *takeable* amount for each offer. In practice, this means the router aims to surface offers with a takeable amount that can be executed without reverting at take time, minimizing execution failures for takers.
+It follows a set of rules managed by an external service, the **gatekeeper**, exposed at **`GET /v1/config/rules`**. Those rules determine which offers are fully excluded, based on criteria such as offer format, tokens, maturity, callback, and more. Any maker that wants to comply with these rules can call **`POST /v1/validate`** to confirm that their offers are supported by the router.
 
-## Forge a supported offer
+### The mempool
 
-Not every offer published to the mempool will be indexed by the router. The router applies a **gatekeeper** that validates both **offer validity** (e.g., the offer is not expired) and the **supported format** (e.g., the callback type is supported by the router).
+Although the mempool is unrestricted, the router supports only a specific offer format. The best way for a maker to stay router-compatible is to call **`POST /v1/validate`** to get the **encoded offer payload**, sign the returned **root**, and publish the payload with the **signature appended** (`data = payload + signature`).
 
-These checks serve the same goal: **minimize take-time failures**. Validity checks eliminate offers that are expected to revert on-chain. Supported-format checks further reduce failure risk by restricting the full set of protocol possibilities to a subset the router understands and can reason about, providing a more controlled integration surface and fewer unpredictable execution paths.
-
-To run these checks and validate your offers, call **`POST /v1/validate`**. If validation fails, the response includes `data.issues` describing what needs to be fixed.
-
-## Discover supported rules
-
-The router publishes configured rules (maturities, loan tokens, and oracles) by chain. These rules are enforced by the gatekeeper when validating offers.
-
-Call **`GET /v1/config/rules`** to retrieve the current rules (with pagination). Use the `types` and `chains` query params to filter which rules are returned. The response includes `meta.checksum` so integrators can detect updates.
-
-## Push offers to the mempool
-
-Once your offer is valid, you must **publish it on-chain** to make it available to all mempool consumers. The router is one consumer of the mempool, but anyone can publish to it or listen to it.
+The maker can then be confident their offers will be indexed correctly when queried.
 
+```text
+POST /v1/validate --data "{ chainId, offers: [...] }"
+ → { payload, root }
+ → sign(root)
+ → publish(payload + signature)
 ```
-POST /v1/validate  →  { payload, root }  →  sign(root)  →  publish(payload + sig)
-    { offers: [...] }
-```
-
-Offers are published as a *batch* using a Merkle tree so that a single signature can cover a whole group of offers. The Merkle **root** is a compact commitment to the full set: changing any offer changes the root, which makes the signature invalid. To keep calldata (and therefore gas costs) low, the offer set is embedded in the `payload` as a **gzipped** representation rather than being sent as plain JSON.
 
-Use **`POST /v1/validate`** to obtain `payload` (the encoded representation of your offers, with the root already embedded) and `root` (the Merkle root to sign). To publish, append your signature to the payload: `data = payload + signature`.
+Offers are submitted as a batch using a Merkle tree, so one signature can cover multiple offers. The Merkle root is a compact
+commitment to the whole set: any change to any offer changes the root, invalidating the signature. To reduce calldata (and gas)
+usage, the full offer set is embedded in the payload as gzipped data instead of plain JSON.
 
 ## Router takeable computation
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@morpho-dev/router",
-  "version": "0.10.0",
+  "version": "0.12.0",
   "description": "Router package for Morpho protocol",
   "type": "module",
   "license": "MIT",
@@ -16,23 +16,23 @@
     "dist/*",
     "docs/*"
   ],
-  "main": "./dist/index.node.js",
+  "main": "./dist/index.node.mjs",
   "module": "./dist/index.node.mjs",
-  "types": "./dist/index.node.d.ts",
+  "types": "./dist/index.node.d.mts",
   "bin": {
     "router": "./dist/cli.js"
   },
   "exports": {
     ".": {
       "node": {
-        "types": "./dist/index.node.d.ts",
+        "types": "./dist/index.node.d.mts",
         "import": "./dist/index.node.mjs",
-        "require": "./dist/index.node.js"
+        "require": "./dist/index.node.mjs"
       },
       "default": {
-        "types": "./dist/index.browser.d.ts",
+        "types": "./dist/index.browser.d.mts",
         "import": "./dist/index.browser.mjs",
-        "require": "./dist/index.browser.js"
+        "require": "./dist/index.browser.mjs"
       }
     }
   },
@@ -40,6 +40,10 @@
     "#core": "./src/core/index.ts",
     "#*": "./src/*"
   },
+  "engines": {
+    "node": ">=22.22.0",
+    "pnpm": ">=10.30.1 <11"
+  },
   "devDependencies": {
     "@types/pako": "^2.0.4",
     "@types/pg": "^8.15.5",
@@ -50,55 +54,58 @@
   },
   "dependencies": {
     "@electric-sql/pglite": "^0.3.1",
-    "@hono/node-server": "^1.19.9",
+    "@hono/node-server": "^1.19.10",
     "@opentelemetry/api": "^1.9.0",
-    "@opentelemetry/exporter-trace-otlp-proto": "^0.208.0",
-    "@opentelemetry/id-generator-aws-xray": "^2.0.3",
-    "@opentelemetry/instrumentation": "^0.208.0",
-    "@opentelemetry/instrumentation-http": "^0.208.0",
-    "@opentelemetry/instrumentation-pg": "^0.61.1",
-    "@opentelemetry/propagator-aws-xray": "^2.0.3",
-    "@opentelemetry/resources": "^2.2.0",
-    "@opentelemetry/sdk-trace-node": "^2.2.0",
-    "@opentelemetry/semantic-conventions": "^1.38.0",
+    "@opentelemetry/exporter-trace-otlp-proto": "^0.212.0",
+    "@opentelemetry/instrumentation": "^0.212.0",
+    "@opentelemetry/instrumentation-http": "^0.212.0",
+    "@opentelemetry/instrumentation-pg": "^0.64.0",
+    "@opentelemetry/resources": "^2.5.1",
+    "@opentelemetry/sdk-trace-node": "^2.5.1",
+    "@opentelemetry/semantic-conventions": "^1.39.0",
     "@openzeppelin/merkle-tree": "^1.0.8",
     "commander": "^13.1.0",
     "dotenv": "^17.2.1",
     "drizzle-orm": "^0.43.1",
-    "hono": "^4.11.5",
-    "js-base64": "^3.7.8",
+    "hono": "^4.12.7",
     "marked": "^17.0.1",
     "openapi-fetch": "^0.15.0",
     "openapi-metadata": "^0.2.2",
     "pako": "^2.1.0",
+    "prom-client": "^15.1.3",
     "pg": "^8.16.0",
     "reflect-metadata": "^0.2.2",
     "smol-toml": "^1.6.0",
     "viem": "^2.37.13",
-    "zod": "^4.1.12",
-    "zod-openapi": "^5.4.3"
+    "zod": "^4.1.12"
   },
   "scripts": {
     "bench": "vitest bench",
     "build": "pnpm openapi:generate && tsdown --config tsdown.config.ts",
-    "container:build": "docker build -f Dockerfile -t morpho-router ../../",
+    "container:build": "docker buildx build -f Dockerfile -t morpho-router --load ../../",
     "container:run": "docker run -p 7891:7891 -e OTEL_EXPORTER_OTLP_ENDPOINT=http://host.docker.internal:4318/v1/traces --rm -it morpho-router",
-    "cli": "pnpm build && node --experimental-loader=@opentelemetry/instrumentation/hook.mjs ./dist/cli.js",
+    "cli": "pnpm build && node --import ./dist/register-otel-hook.js ./dist/cli.js",
     "dev": "tsdown --config tsdown.config.ts --watch --onSuccess 'echo \"Router package rebuilt\"'",
     "docs:cli": "node ./scripts/generate-readme.mjs",
-    "format": "biome format --write src/",
+    "format": "oxfmt src/",
     "lint": "bash ./scripts/lint.sh",
-    "lint:ci": "biome ci src/",
+    "lint:fix": "oxlint --fix src/",
+    "lint:ci": "bash ./scripts/lint.sh",
     "migrations:create": "drizzle-kit generate --config src/database/drizzle/drizzle.config.ts --name",
+    "migrations:verify": "node ./scripts/verify-migration-artifacts.mjs",
     "migrations:run": "drizzle-kit migrate --config src/database/drizzle/drizzle.config.ts",
-    "openapi:generate": "node --import tsx src/cli/dump-swagger.ts && pnpm openapi-typescript src/api/Schema/generated/swagger.json -o src/api/Schema/generated/swagger.d.ts && biome check --write src/api/Schema/generated",
-    "test": "vitest run",
+    "openapi:generate": "node --import tsx src/cli/dump-swagger.ts && pnpm openapi-typescript src/api/Schema/generated/swagger.json -o src/api/Schema/generated/swagger.d.ts && oxfmt src/api/Schema/generated",
+    "test": "vitest --config vitest.config.ts run",
+    "test:guard:classification": "node --import tsx ./scripts/verify-test-classification.ts",
+    "test:integration": "vitest --config vitest.integration.config.ts run",
+    "test:unit": "pnpm test:guard:classification && vitest --config vitest.config.ts run",
     "test:e2e": "./scripts/e2e-run.sh",
     "test:tenderly": "vitest --config vitest.e2e.config.ts run",
-    "test:ui": "vitest --ui",
-    "test:watch": "vitest watch",
+    "test:ui": "vitest --config vitest.config.ts --ui",
+    "test:watch": "vitest --config vitest.config.ts watch",
     "e2e:setup": "./scripts/e2e-setup.sh",
     "e2e:teardown": "./scripts/e2e-teardown.sh",
+    "load:test": "node --import tsx scripts/load-test.ts",
     "typecheck": "pnpm openapi:generate && tsc --project tsconfig.json --noEmit --incremental"
   }
 }