doc: Revise README

This commit is contained in:
sprites0
2025-07-06 03:45:59 +00:00
parent 92e42e86c2
commit eb7202bbe2

View File

@ -3,14 +3,45 @@
HyperEVM archive node implementation based on reth's NodeBuilder API. HyperEVM archive node implementation based on reth's NodeBuilder API.
Heavily inspired by [reth-bsc](https://github.com/loocapro/reth-bsc). Heavily inspired by [reth-bsc](https://github.com/loocapro/reth-bsc).
## TODOs ## Installation
- [x] Make it compilable Install the `reth-hl` binary:
- [x] EVM
- [x] Storage ```sh
- [x] TX forwarder API $ make install
- [x] Decide whether to include system txs, receipts in block or not ```
- [x] Downloader
- [x] S3 format (file) ## Usage
- [x] S3 format (AWS API)
- [x] hl-node format ### Ingest from S3
Set AWS credentials in `~/.aws/credentials`. To use a non-default profile:
```sh
$ export AWS_PROFILE=default # optional
$ reth-hl node --s3 --http --ws --ws.port=8545
```
### Ingest from local
#### S3-style directory (backfill):
```sh
$ reth-hl node --ingest-dir=/path/to/evm-blocks ...
```
#### Native hl-node format (realtime, low latency):
```sh
$ reth-hl node --local-ingest-dir=$HOME/hl/data/evm_blocks_and_receipts ...
```
Or if the path is `$HOME/hl/data/evm_blocks_and_receipts` simply:
```sh
$ reth-hl node --local
```
---
**Note:** This is a draft and will be merged with `nanoreth` documentation.