@morpho-dev/router 0.1.12 → 0.1.16

package/README.md

@@ -1,83 +1,116 @@
-# Router Client
+# Router
 
-A TypeScript client to interact with the Morpho Router.
+> Status: Alpha – this is under active development and interfaces/behavior are subject to change.
 
-## Installation
+## CLI
+
+CLI install
 
 ```bash
-pnpm add @morpho-dev/router
+pnpm add -g @morpho-dev/router
 ```
 
-## Usage
+- 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
+
+Examples:
+
+```bash
+# Router with seeded random offers
+router start --seed 100
 
-### Running the Local Server
+# Router with postgres database and custom port
+router start --db-endpoint <db url> --port 8080
 
-```typescript
-import { RouterApi } from "@morpho-dev/router";
+# Router with offers loaded from file
+router start --file offers.json
 
-// Start a local router api on port 8081
-await RouterApi.serve({ port: 8081 });
-// Server will be available at http://localhost:8081
+# Start Router indexer (Default indexer,api)
+router start --services indexer
 ```
 
-### Basic Setup
+<!-- AUTO-GENERATED: CLI-HELP START -->
+### CLI reference
 
-```typescript
-import { RouterApi } from "@morpho-dev/router";
+#### Global
 
-// Create a router client
-const router = RouterApi.connect();
+```text
+Usage: router [options] [command]
 
-// With custom URL
-const router = RouterApi.connect({ url: "https://router.morpho.dev" });
+Router package for Morpho protocol
 
-// Connect to local server
-const router = RouterApi.connect({ url: "http://localhost:8081" });
+Options:
+  -V, --version      output the version number
+  -h, --help         display help for command
+
+Commands:
+  start [options]    Start Router services.
+  tunnel [options]   Expose the local Router via ngrok
+  mempool [options]  Start a local chain with the mempool contract
+  help [command]     display help for command
+```
+
+#### start
+
+```text
+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)
+  --store <type>           (choices: "pglite", "pg", default: "pglite", env:
+                          ROUTER_STORE)
+  --db-endpoint <url>      (env: ROUTER_DB_ENDPOINT)
+  --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: 100)
+  --seed <n>              Seed random offers to router (default: 0)
+  --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
 ```
 
-### Get Offers
-
-```typescript
-// Get all offers
-const result = await router.get({});
-
-// Get buy offers on Ethereum mainnet
-const result = await router.get({ side: "buy", chains: [1], limit: 10 });
-
-// Get offers with specific filters
-const result = await router.get({
-  side: "sell",
-  chains: [1, 137],
-  loanTokens: ["0x1234567890123456789012345678901234567890"],
-  minAmount: 1000n,
-  maxAmount: 10000n,
-  minRate: 500000000000000000n,
-  maxRate: 1500000000000000000n,
-  sortBy: "rate",
-  sortOrder: "asc"
-});
+#### tunnel
+
+```text
+Usage: router tunnel [options]
+
+Expose the local Router via ngrok
+
+Options:
+  --port <n>                  (default: 7891, env: ROUTER_PORT)
+  --ngrok-authtoken <token>   (env: NGROK_AUTHTOKEN)
+  -h, --help                 display help for command
+```
+
+#### mempool
+
+```text
+Usage: router mempool [options]
+
+Start a local chain with the mempool contract
+
+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
 ```
 
-### Match Offers
-
-```typescript
-// Match offers for buy on Ethereum mainnet
-const result = await router.match({ side: "buy", chainId: 1 });
-
-// Match with specific requirements
-const result = await router.match({
-  side: "sell",
-  chainId: 1,
-  rate: 1000000000000000000n,
-  loanToken: "0x1234567890123456789012345678901234567890",
-  collaterals: [
-    {
-      asset: "0x1234567890123456789012345678901234567890",
-      oracle: "0xabcdefabcdefabcdefabcdefabcdefabcdefabcd",
-      lltv: 800000000000000000n
-    }
-  ],
-  minMaturity: 1700000000,
-  maxMaturity: 1800000000
-});
-```
+<!-- AUTO-GENERATED: CLI-HELP END -->