@morpho-dev/router 0.3.0 → 0.4.0

package/README.md

@@ -10,26 +10,60 @@ CLI install
 pnpm add -g @morpho-dev/router
 ```
 
-- Router starts on http://localhost:7891 by default
-- Seed random offers with --seed <n> for testing
-- Load offers from JSON file with --file <path>
-- Start services using --services indexer,api
-- --db-endpoint plugs the router on top of a postgres instance
+- Router configuration is read from a TOML file
+- `router start` only accepts `--config-file` (or `ROUTER_CONFIG_FILE`/`./router.toml`)
+- Seed mock offers with `--mock <n>` for testing
+- Load offers from JSON file with `--file <path>`
 
 Examples:
 
 ```bash
-# Router with postgres database and custom port
-router start --db-endpoint <db url> --port 8080
+# Start router from a config file
+router start --config-file ./router.toml
 
-# Start Router indexer (Default indexer,api)
-router start --services indexer
+# Start router using the env fallback
+ROUTER_CONFIG_FILE=./router.toml router start
 
-# Router Mock with seeded random offers
-router mock --seed 100
+# Start router with mock offers for testing
+router start --config-file ./router.toml --mock 100
 
-# Router with offers loaded from file
-router mock --file offers.json
+# Start router with offers loaded from file
+router start --config-file ./router.toml --file offers.json
+```
+
+### Chain
+
+Use `router chain` to manage the anvil chain for dev and E2E workflows.
+
+```bash
+# Start a chain and emit JSON status
+router chain start --output json
+
+# Check chain status
+router chain status --output json
+
+# Stop the chain and purge state
+router chain stop --purge
+```
+
+Example `router.toml`:
+
+```toml
+[logging]
+level = "info"
+
+[database]
+url_env = "DATABASE_URL"
+
+[api]
+port = 7891
+
+[indexer]
+block_window = 8000
+chains = ["ethereum"]
+
+[chains."ethereum"]
+rpc_url_env = "ETHEREUM_RPC_URL"
 ```
 
 <!-- AUTO-GENERATED: CLI-HELP START -->
@@ -43,14 +77,13 @@ Usage: router [options] [command]
 Router package for Morpho protocol
 
 Options:
-  -V, --version      output the version number
-  -h, --help         display help for command
+  -V, --version    output the version number
+  -h, --help       display help for command
 
 Commands:
-  start [options]    Start Router services.
-  mempool [options]  Start a local chain with the mempool contract
-  mock [options]     Start Router mock.
-  help [command]     display help for command
+  start [options]  Start Router services.
+  chain            Manage the anvil chain lifecycle.
+  help [command]   display help for command
 ```
 
 #### start
@@ -61,66 +94,29 @@ Usage: router start [options]
 Start Router services.
 
 Options:
-  --port <n>               (default: 7891, env: ROUTER_PORT)
-  --chain <chain>          (choices: "ethereum", "base",
-                          "ethereum-virtual-testnet", "anvil", default:
-                          "ethereum", env: ROUTER_CHAIN)
-  --rpc-url <url>          (env: ROUTER_RPC_URL)
-  --router-url <url>       (default: "https://router.morpho.dev", env:
-                          ROUTER_REMOTE_URL)
-  --db-endpoint <url>      (env: DATABASE_URL)
-  --log-level <level>      (choices: "trace", "debug", "info", "warn", "error",
-                          "fatal", "silent", default: "info", env:
-                          ROUTER_LOG_LEVEL)
-  --log-pretty            Enable pretty logs (default: true, env:
-                          ROUTER_LOG_PRETTY)
-  --block-window <n>      Block window to get logs from (default: 8000)
-  --file <path>           Seed offers from a JSON file
-  --max-block-number <n>  Block number at which to stop indexing
-  --services <list>       Comma-separated services to run. Default: api,indexer
-                          (default: ["indexer","api"], env: ROUTER_SERVICES)
-  -h, --help              display help for command
+  --config-file <path>  Path to router TOML config file
+  --mock <n>            Number of mock offers to seed
+  --file <path>         Seed offers from a JSON file
+  -h, --help            display help for command
 ```
 
-#### mempool
+#### chain
 
 ```text
-Usage: router mempool [options]
+Usage: router chain [options] [command]
 
-Start a local chain with the mempool contract
+Manage the anvil chain lifecycle.
 
 Options:
-  --port <port>             (default: 8545, env: MEMPOOL_PORT)
-  --fork-url <url>          (default: "https://ethereum-rpc.publicnode.com",
-                           env: MEMPOOL_FORK_URL)
-  --block-number <number>   (default: 0)
-  -h, --help               display help for command
-```
-
-#### mock
-
-```text
-Usage: router mock [options]
-
-Start Router mock.
+  -h, --help         display help for command
 
-Options:
-  --port <n>            (default: 7891, env: ROUTER_PORT)
-  --chain <chain>       (choices: "ethereum", "base",
-                       "ethereum-virtual-testnet", "anvil", default: "ethereum",
-                       env: ROUTER_CHAIN)
-  --rpc-url <url>       (env: ROUTER_RPC_URL)
-  --router-url <url>    (default: "https://router.morpho.dev", env:
-                       ROUTER_REMOTE_URL)
-  --db-endpoint <url>   (env: DATABASE_URL)
-  --log-level <level>   (choices: "trace", "debug", "info", "warn", "error",
-                       "fatal", "silent", default: "info", env:
-                       ROUTER_LOG_LEVEL)
-  --log-pretty         Enable pretty logs (default: true, env:
-                       ROUTER_LOG_PRETTY)
-  --seed <n>           Seed random offers to router (default: 0)
-  --file <path>        Seed offers from a JSON file
-  -h, --help           display help for command
+Commands:
+  start [options]    Start an anvil chain.
+  status [options]   Show chain status.
+  stop [options]     Stop the chain process.
+  restart [options]  Restart the chain process.
+  logs [options]     Read anvil logs.
+  help [command]     display help for command
 ```
 
 <!-- AUTO-GENERATED: CLI-HELP END -->