(and make sure it will work on Windows, when enabled)
Binary Nimbus beacon node distribution
This binary distribution of the Nimbus eth2 package is compiled in reproducible way from source files hosted at https://github.com/status-im/nimbus-eth2.
The tarball containing this README uses the following naming scheme:
nimbus-eth2_<TARGET OS>_<TARGET CPU>_<VERSION>_<GIT COMMIT>.tar.gz
For a more complete and up-to-date documentation, please refer to the Nimbus book.
Reproducing the build
Besides the generic build requirements, you also need Docker.
git clone https://github.com/status-im/nimbus-eth2.git
cd nimbus-eth2
git checkout GIT_COMMIT
make update
make dist
Significant differences from self-built binaries
No -march=native
and no metrics support.
Running a Pyrmont node
With default options:
./run-pyrmont-beacon-node.sh
The script will forward all supplied options to the beacon node executable:
./run-pyrmont-beacon-node.sh --log-level=DEBUG --tcp-port=9050
To monitor the Eth1 validator deposit contract, you'll need to pair the Nimbus beacon node with a Web3 provider capable of serving Eth1 event logs. This could be a locally running Eth1 client such as Geth or a cloud service such as Infura. For more information please see our setup guides:
https://status-im.github.io/nimbus-eth2/eth1.html
By default, the script will ask you to enter a web3 provider URL interactively,
but this can be bypassed by specifying a websocket WEB3_URL
environment variable:
WEB3_URL="<YOUR_WEB3_URL>" ./run-pyrmont-beacon-node.sh
Running a mainnet node
run-mainnet-beacon-node.sh
is a similar script intended for connecting to mainnet.
All the same conventions apply:
# using a local Geth instance
WEB3_URL="ws://localhost:8545" ./run-mainnet-node.sh --max-peers=150