Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# XLayer Reth

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![Rust](https://img.shields.io/badge/Rust-1.88+-orange.svg)](https://www.rust-lang.org/)
[![License: Apache-2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Rust](https://img.shields.io/badge/Rust-1.93+-orange.svg)](https://www.rust-lang.org/)
[![GitHub release](https://img.shields.io/github/v/release/okx/xlayer-reth)](https://github.com/okx/xlayer-reth/releases)


Expand All @@ -24,7 +25,7 @@ XLayer Reth is built on top of [Reth](https://github.com/paradigmxyz/reth), exte

### Prerequisites

- **Rust**: Version 1.88 or higher
- **Rust**: Version 1.93 or higher
- **[just](https://github.com/casey/just)**: Command runner (install with `cargo install just`)
- **Docker** (optional): For containerized builds

Expand Down Expand Up @@ -112,7 +113,7 @@ Below are the XLayer-specific configuration options:
### Development Commands

```bash
# Run all checks (format + clippy + tests)
# Run all checks (sweep-check + format + clippy + tests)
just check

# Run tests
Expand All @@ -121,11 +122,17 @@ just test
# Run tests including e2e tests
just test true

# Run flashblocks tests
just test false true

# Auto-fix formatting and clippy issues
just fix

# Watch mode - auto-run tests on file changes
just watch-test

# Watch mode - auto-run clippy on file changes
just watch-check
```

## Testing
Expand Down Expand Up @@ -198,4 +205,4 @@ just xlayer

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
This project is dual-licensed under the MIT License and the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.