Context
The project README needs to be updated to document EVM chain support, including supported chains, configuration options, API endpoints, and an updated architecture diagram reflecting the dual-chain capability of the indexer.
Specification
- EVM section in README.md covering:
- Supported chains: Ethereum, Polygon, Arbitrum, Base (and any EVM-compatible chain)
- Configuration: All EVM environment variables with descriptions and defaults
- API endpoints: All 8 EVM REST endpoints with request/response examples:
GET /api/evm/stats
GET /api/evm/transactions (with filter params)
GET /api/evm/transactions/{txHash}
GET /api/evm/blocks (paginated)
GET /api/evm/blocks/{blockNumber}/transactions
GET /api/evm/transfers (with min_amount)
GET /api/evm/token-transfers (with token/from/to filters)
GET /api/evm/accounts/{address}
- Architecture diagram: Updated to show the chain mode switch and EVM data flow path alongside the existing Solana path
- Quick start: How to run in EVM mode with docker-compose
- Chain-specific notes: Confirmation blocks, reorg depth, OP Stack deposits
Acceptance Criteria
Dependencies
- EVM-49 through EVM-54: All E2E tests passing (EVM functionality verified before documenting)
References
Context
The project README needs to be updated to document EVM chain support, including supported chains, configuration options, API endpoints, and an updated architecture diagram reflecting the dual-chain capability of the indexer.
Specification
GET /api/evm/statsGET /api/evm/transactions(with filter params)GET /api/evm/transactions/{txHash}GET /api/evm/blocks(paginated)GET /api/evm/blocks/{blockNumber}/transactionsGET /api/evm/transfers(with min_amount)GET /api/evm/token-transfers(with token/from/to filters)GET /api/evm/accounts/{address}Acceptance Criteria
Dependencies
References