2.7 KiB
Running Lighthouse Code
These documents provide a guide for running code in the following repositories:
- lighthouse-libs
- [lighthouse-beacon](https://github.com/sigp/lighthouse-beacon
- [lighthouse-validator](https://github.com/sigp/lighthouse-validator
NOTE: The cryptography libraries used in this implementation are experimental. As such all cryptography is assumed to be insecure.
This code-base is still very much under-development and does not provide any user-facing functionality. For developers and researchers, there are several tests and benchmarks which may be of interest.
A few basic steps are needed to get set up:
- Install rustup. It's a toolchain manager for Rust
(Linux | macos | Windows). For installation run the below command in your
terminal
$ curl https://sh.rustup.rs -sSf | sh
- (Linux & MacOS) To configure your current shell run:
$ source $HOME/.cargo/env
- Use the command
rustup show
to get information about the Rust installation. You should see that the active toolchain is the stable version. - Run
rustc --version
to check the installation and version of rust.- Updates can be performed using
rustup update
.
- Updates can be performed using
- Install build dependencies (Arch packages are listed here, your
distribution will likely be similar):
clang
: required by RocksDB.protobuf
: required for protobuf- serialization (gRPC).
- Navigate to the working directory.
- Run the test by using command
cargo test --all
. By running, it will pass all the required test cases. If you are doing it for the first time, then you can grab a coffee in the meantime. Usually, it takes time to build, compile and pass all test cases. If there is no error then it means everything is working properly and it's time to get your hands dirty. In case, if there is an error, then please raise the issue. We will help you. - As an alternative to, or instead of the above step, you may also run
benchmarks by using the command
cargo bench --all
. (Note: not all repositories have benchmarking).
Note: Lighthouse presently runs on Rust stable
.
Note for Windows users: Perl may also be required to build lighthouse.
You can install Strawberry Perl, or alternatively
use a choco install command choco install strawberryperl
.
Additionally, the dependency protoc-grpcio v0.3.1
is reported to have issues
compiling in Windows. You can specify a known working version by editing
version in protos/Cargo.toml's "build-dependencies" section to protoc-grpcio = "<=0.3.0"
.