Skip to main content

Explorer Getting Started

With clutch-deploy

The explorer is included in the full Docker stack:

git clone https://github.com/clutchprotocol/clutch-deploy.git
cd clutch-deploy
cp .env.example .env
docker compose up -d
ServiceURL
Explorer UIhttp://localhost:5174
Explorer APIhttp://localhost:8088
API healthhttp://localhost:8088/health

Docker images (GHCR only): clutch-explorer-backend, clutch-explorer-frontend. Full list: Docker images.

Standalone development

See the clutch-explorer repository for backend and frontend setup with Postgres.

Frontend routes

RoutePage
/Dashboard / stats
/blocksBlock list
/blocks/:idBlock detail
/txsTransaction list
/txs/:hashTransaction detail
/address/:addressAccount page
/validatorsValidator set

Environment variables

Backend

SettingDescription
EXPLORER_POSTGRES_*Database connection (in clutch-deploy .env)
indexer_poll_interval_msBlock poll interval (default 4000)
clutch_node_ws_urlNode WebSocket for indexing

Frontend

VariableDescription
VITE_EXPLORER_API_URLBackend API URL (default http://localhost:8088)

Verify indexing

  1. Submit a transaction via the demo app or SDK
  2. Wait for the indexer poll (~4 seconds)
  3. Search the transaction hash in the explorer UI or API
curl "http://localhost:8088/api/v1/search?q=0xYourTxHash"