Skip to Content
Getting Started

Getting started

Supported environments

EnvironmentNetwork
localAnvil (Foundry)
base_sepoliaBase Sepolia (staging)
base_mainnetBase mainnet (production)

Manifests: deployments/<network>.json (canonical) | frontend/public/deployments/<network>.json (UI runtime copy)

Prereqs

ToolVersion
Foundry1.5.1 (required)
Node.jsUse repo .nvmrc
Python 3For lint/sync scripts
GitStandard

Install

make deps # Foundry libraries (pinned) make build # Build contracts make test # Run tests

Run local stack

npm run local

See Quickstart for variants and local dev flow.

CI gates

make gates

Includes: deployment sync, manifest parity, docs lint, ABI lint/sanity, subgraph lint, Solidity policy lint, analytics SQL lint.

Repo map

PathContents
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)