Getting started
Supported environments
| Environment | Network |
|---|---|
| local | Anvil (Foundry) |
| base_sepolia | Base Sepolia (staging) |
| base_mainnet | Base mainnet (production) |
Manifests: deployments/<network>.json (canonical) | frontend/public/deployments/<network>.json (UI runtime copy)
Prereqs
| Tool | Version |
|---|---|
| Foundry | 1.5.1 (required) |
| Node.js | Use repo .nvmrc |
| Python 3 | For lint/sync scripts |
| Git | Standard |
Install
make deps # Foundry libraries (pinned)
make build # Build contracts
make test # Run testsRun local stack
npm run localSee Quickstart for variants and local dev flow.
CI gates
make gatesIncludes: deployment sync, manifest parity, docs lint, ABI lint/sanity, subgraph lint, Solidity policy lint, analytics SQL lint.
Repo map
| Path | Contents |
|---|---|
src/ | Solidity contracts; lib/Constants.sol, lib/Events.sol |
docs/ | Spec, security, analytics, UI notes |
deployments/ | <network>.json (canonical manifests) |
abis/ | Versioned exported ABIs for indexers |
frontend/ | Next.js app |
subgraph/ | The Graph mappings + schema |
analytics/ | Dune integration pack + SQL templates |
workers/ | Offchain services (chat, etc) |