Installing ethrex
Before running the ethrex client, you need to install it. We have multiple ways to install, depending on your needs.
Pre-built binaries for Linux and macOS are available for each release. See Installing from pre-built binaries for installation instructions.
You can also install through cargo install, or build the client from source.
Installing from pre-built binaries
To install ethrex from pre-built binaries, first download the binaries for your platform from the release page.
You can also download it from the command line using curl or wget:
# For Linux x86_64
curl -L https://github.com/lambdaclass/ethrex/releases/latest/download/ethrex-linux_x86_64 -o ethrex
wget https://github.com/lambdaclass/ethrex/releases/latest/download/ethrex-linux_x86_64 -O ethrex
# For Linux ARM
curl -L https://github.com/lambdaclass/ethrex/releases/latest/download/ethrex-linux_aarch64 -o ethrex
wget https://github.com/lambdaclass/ethrex/releases/latest/download/ethrex-linux_aarch64 -O ethrex
# For MacOS
curl -L https://github.com/lambdaclass/ethrex/releases/latest/download/ethrex-macos_aarch64 -o ethrex
wget https://github.com/lambdaclass/ethrex/releases/latest/download/ethrex-macos_aarch64 -O ethrex
And set the execution bit:
chmod +x ethrex
After that, you can verify the program is working by running:
./ethrex --version
This should output something like:
ethrex ethrex/v0.1.0-HEAD-23191af/aarch64-apple-darwin/rustc-v1.87.0
tip
For convenience, you can move the ethrex binary to a directory in your PATH, so you can run it from anywhere.
After installing the client, see "Running the client" for instructions on how to use it to run L1 and/or L2 networks.
Installing through cargo install
To install the client, first install Rust and then run:
cargo install --locked ethrex \
--git https://github.com/lambdaclass/ethrex.git \
--tag <LATEST_VERSION_HERE> \
This installs the ethrex binary.
For more information on how it is built and installed, see the cargo-install documentation.
After that, you can verify the program is working by running:
ethrex --version
This should output something like:
ethrex ethrex/v0.1.0-HEAD-23191af/aarch64-apple-darwin/rustc-v1.87.0
After installing the client, see "Running the client" for instructions on how to use it to run L1 and/or L2 networks.
tip
You can add sp1 and risc0 features to the installation script to build with support for SP1
and/or RISC0 provers. gpu feature is also available for CUDA support.
Building from source
This section assumes you already have Rust's cargo and git installed.
You can download the source code of a release from the GitHub releases page, or by cloning the repository at that version:
git clone --branch <LATEST_VERSION_HERE> --depth 1 https://github.com/lambdaclass/ethrex.git
After that, you can run the following command inside the cloned repo to build the client:
cargo build --bin ethrex --release
You can find the built binary inside target/release directory:
./target/release/ethrex --version
This should output something like:
ethrex ethrex/v0.1.0-HEAD-23191af/aarch64-apple-darwin/rustc-v1.87.0
tip
You can add sp1 and risc0 features to the installation script to build with support for SP1
and/or RISC0 provers. gpu feature is also available for CUDA support.
tip
For convenience, you can move the ethrex binary to a directory in your PATH, so you can run it from anywhere.
After installing the client, see "Running the client" for instructions on how to use it to run L1 and/or L2 networks.