https://github.com/taikoxyz/alethia-reth
A high-performance Rust execution client for the Taiko protocol.
https://github.com/taikoxyz/alethia-reth
ethereum reth rust taiko
Last synced: about 2 months ago
JSON representation
A high-performance Rust execution client for the Taiko protocol.
- Host: GitHub
- URL: https://github.com/taikoxyz/alethia-reth
- Owner: taikoxyz
- License: mit
- Created: 2025-09-03T05:01:51.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-09-05T03:03:29.000Z (10 months ago)
- Last Synced: 2025-09-05T05:23:10.346Z (10 months ago)
- Topics: ethereum, reth, rust, taiko
- Language: Rust
- Homepage:
- Size: 688 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# alethia-reth
[](https://github.com/taikoxyz/alethia-reth/actions/workflows/ci.yml)
A high-performance Rust execution client for the Taiko protocol, built on top of [Reth](https://github.com/paradigmxyz/reth) powerful [`NodeBuilder` API](https://reth.rs/introduction/why-reth#infinitely-customizable), designed to deliver the best possible developer and maintenance experience.
## Getting Started
### 1. Clone the Repository
```bash
git clone https://github.com/taikoxyz/alethia-reth.git
cd alethia-reth
```
### 2. Build
Build by `Cargo`:
```bash
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:
```bash
just test
```
## Running the Node
To run the compiled node:
```bash
./target/release/alethia-reth [OPTIONS]
```
To see available command-line options and subcommands, run:
```bash
./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
```bash
docker build -t alethia-reth .
```
### 2. Run the Docker Container
```bash
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
Alethia-reth uses reth-compatible CLI options plus Taiko chain presets.
### Chain Selection
Use `--chain` with one of the supported presets:
- `mainnet`
- `taiko-hoodi`
- `devnet`
- `masaya`
### Common Runtime Flags
- `--datadir ` to set node data location.
- `--http` / `--ws` to enable RPC transports.
- `--authrpc.addr ` and `--authrpc.port ` for Engine API auth RPC.
- `--metrics ` to expose Prometheus metrics.
Use `./target/release/alethia-reth --help` for the full option list and defaults.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.