TraceFlow

TraceFlow is an indexer-in-a-box for Mantle. This repo contains the CLI that scaffolds a full stack (indexer, Postgres schema, REST API, Docker Compose) from a contract ABI.

Install

npm install -g traceflow-indexer

Quick start

1. Create a project:

traceflow init traceflow-project
cd traceflow-project

2. Review .env, run migrations, add a contract, and start dev:

npm install
npm run migrate
traceflow add-contract --name MyContract --address 0x... --abi ./abis/MyContract.json
npm run dev

CLI commands

• traceflow init [dir] - scaffold a new project in dir
• traceflow add-contract --name --address --abi - add a contract and generate event tables/types
• traceflow config get - print current config and .env overrides
• traceflow config set --rpc-url --chain-id --start-block --confirmations --database-url - update config/env
• traceflow config push --from-env - push .env values to the running API
• traceflow config pull --write - fetch settings from the API into .env/config
• traceflow dev - run indexer + API locally
• traceflow up - run the full stack with Docker Compose

API endpoints

• GET /health
• GET /status
• GET /metrics
• GET /logs
• GET /contracts
• POST /contracts
• GET /events?contract=...&event=...&fromBlock=...&toBlock=...&txHash=...&address=...&limit=...
• GET /tx/:hash
• GET /tx/:hash/receipt
• GET /address/:address/activity
• GET /settings
• PATCH /settings

Notes

• The generated project lives in templates/base.
• Event tables are created per contract: event_<contract>_<event>.
• Use START_BLOCK=latest to start indexing from the current block.
• The dashboard is served from the API at http://localhost:3000.
• Use the dashboard “Runtime Settings” panel or traceflow config set to update RPC/chain/start block settings.
• Add contracts directly in the dashboard by pasting name, address, and ABI.

Developing locally

npm install
npm run build
npm link