Learn
First Local Run
Bring up the local validation and runtime surfaces from the repository root.
Before You Start
You need:
- Node.js 22+
- npm 10+
- Foundry tools:
forge,cast,anvil - pnpm for the interface workspace
- a real
.envwhen starting quote-server paths that require RPC/signers
1. Initialize Dependencies
git submodule update --init --recursive
make installmake install installs SDK, quote-server, docs, and interface dependencies.
2. Validate Core Surfaces
forge build
forge test
pnpm --filter docs types:check
pnpm --filter docs lintThis proves the Solidity and docs sources are coherent. It does not prove a live market is healthy.
3. Start The Docs
make docs-devOpen:
http://localhost:3000/docs4. Start The Quote Server
make quote-devIn another terminal:
make quote-health/healthz proves the HTTP process is alive. It does not prove fixed oracle
updates, LI.FI publishing, or live broker capacity.
5. Start The Interface
make interface-devDefault URL:
http://127.0.0.1:5173/Checkpoint
You have a useful local system when:
- docs render.
- quote server answers
/healthz. - interface renders.
- env checks do not print missing critical fields.
What Happened
The local stack is three surfaces:
- docs for understanding and operating.
- quote server for signed payloads and solver utilities.
- interface for market operations and wallet-driven checks.
Each surface can be healthy while another is not. Keep that distinction sharp.