docs: update README

This commit is contained in:
Mohamed Sohail 2024-09-27 15:01:14 +03:00
parent 404e769655
commit ffdac26c41
Signed by: kamikazechaser
GPG Key ID: 7DD45520C01CD85D

View File

@ -2,10 +2,12 @@
![GitHub Tag](https://img.shields.io/github/v/tag/grassrootseconomics/eth-tracker) ![GitHub Tag](https://img.shields.io/github/v/tag/grassrootseconomics/eth-tracker)
A fast and lightweight tracker designed to monitor the Celo blockchain for live and historical transaction events, including reverted transactions. It filters these events and publishes them to NATS for further processing. A fast and lightweight tracker designed to monitor EVM blockchains for live and historical transaction events, including reverted transactions. It filters these events and publishes them to NATS for further processing.
It applies deduplication at the NATS level, making it safe to run in a distributed fashion. It applies deduplication at the NATS level, making it safe to run in a distributed fashion.
Note: To run it against an L2/EVM chain, you will need to manually add a replace directive in the `go.mod` file pointing to the EVM chain's `*geth` compatible source code. This will allow the tracker to process transaction types other than Ethereum's `0x0, 0x1 and 0x2`.
## Getting Started ## Getting Started
A `Makefile` is also provided to build the required binaries to run eth-tracker. A `Makefile` is also provided to build the required binaries to run eth-tracker.