Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Building from source

Prerequisites

Installing using cargo install

To install the client simply run

cargo install --locked ethrex --git https://github.com/lambdaclass/ethrex.git

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.

To install a specifc version you can add the --tag <tag> flag. Existing tags are available in the GitHub repo

After that, you can verify the program is working by running:

ethrex --version

Building the binary with cargo build

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

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.

You can find the built binary inside target/release directory. After that, you can verify the program is working by running:

./target/release/ethrex --version

tip

For convenience, you can move the ethrex binary to a directory in your $PATH, so you can run it from anywhere.