alethia-reth

A high-performance Rust execution client for the Taiko protocol, built on top of Reth powerful NodeBuilder API, designed to deliver the best possible developer and maintenance experience.

Getting Started

1. Clone the Repository

git clone https://github.com/taikoxyz/alethia-reth.git
cd alethia-reth

2. Build

Build by Cargo:

cargo build --release

The main binary will be located at target/release/alethia-reth.

3. Run Checks and Tests

To ensure everything is set up correctly, run the checks and tests:

just test

Running the Node

To run the compiled node:

./target/release/alethia-reth [OPTIONS]

To see available command-line options and subcommands, run:

./target/release/alethia-reth --help

(Note: Replace [OPTIONS] with the necessary configuration flags for your setup. Refer to the --help output for details.)

Docker

1. Build the Docker Image

docker build -t alethia-reth .

2. Run the Docker Container

docker run -it --rm alethia-reth [OPTIONS]

(Note: You might need to map ports (-p), mount volumes (-v) for data persistence, or pass environment variables (-e) depending on your node's configuration needs.)

Configuration

(Details about specific configuration files, environment variables, or command-line arguments required for typical operation will be added here as the project evolves. For now, please refer to the --help output of the binary.)

License

This project is licensed under the MIT License. See the LICENSE file for details.