5.6 KiB

Raw Blame History

Ethereum Beacon Chain

Nimbus beacon chain is a research implementation of the beacon chain component of the upcoming Ethereum Serenity upgrade, aka eth2. See the main Nimbus project for the bigger picture.

status-im/nimbus: main Nimbus repository - start here to learn more about the Nimbus eco-system
ethereum/eth2.0-specs: Serenity specification that this project implements
ethereum/beacon_chain: reference implementation from the Ethereum foundation

You can check where the beacon chain fits in the Ethereum research ecosystem in the Status Athenaeum.

Building and Testing

The beacon chain components require that you have Nim installed - the easiest way to get started is to head over to the main Nimbus repository and follow the build instructions there or just execute the commands below in order.

Note: This is because this repository is actually pulled in as a dependency of Nimbus - the Ethereum 1.0 + 2.0 client - so it makes sense to start from there even if you are only interested in testing the Ethereum 2.0 side of things (contained almost entirely in this repository).

# Clone main nimbus repository
git clone https://github.com/status-im/nimbus.git
cd nimbus

# Prep environment
make update deps

# Start a shell that uses the Nimbus compile environment
./env.sh bash

# You're now in a shell environment that has the right Nim version available.
# Head over to the vendor repo where you should have a checkout of this project
cd vendor/nim-beacon-chain

# You can now run the test suite:
nim c -d:release -r tests/all_tests

Beacon node simulation

The beacon node simulation is will create a full peer-to-peer network of beacon nodes and validators, and run the beacon chain in real time. To change network parameters such as shard and validator counts, see start.sh.

# Start beacon chain simulation, resuming from the previous state (if any)
./tests/simulation/start.sh # if starting from Nimbus, make sure you're in vendor/nim-beacon-chain!

# Clear data from last run and restart simulation with a new genesis block
rm -rf tests/simulation/data ; ./tests/simulation/start.sh

# Run an extra node - by default the network will launch with 9 nodes, each
# hosting 10 validators. The last 10 validators are lazy bums that hid from the
# startup script, but you can command them back to work in a separate terminal
# with:
./tests/simulation/run_node.sh 9

Alternatively, the Makefile flow is available from the Nimbus parent repo:

# In the Nimbus repo root

# Start beacon chain simulation, resuming from the previous state (if any)
make eth2_network_simulation

# Clear data from last run and restart simulation with a new genesis block
make clean_eth2_network_simulation_files eth2_network_simulation

You can also separate the output from each beacon node in its own panel, using multitail:

USE_MULTITAIL="yes" ./tests/simulation/start.sh

# OR

USE_MULTITAIL="yes" make eth2_network_simulation

You can find out more about it in the development update.

Alternatively, fire up our experimental Vagrant instance with Nim pre-installed and give us yout feedback about the process!

State transition simulation

The state transition simulator can quickly run the Beacon chain state transition function in isolation and output JSON snapshots of the state. The simulation runs without networking and blocks are processed without slot time delays.

cd research
# build and run state simulator, then display its help - -d:release speeds it
# up substantially, allowing the simulation of longer runs in reasonable time
nim c -d:release -r state_sim --help

Convention

Ethereum Foundation uses:

snake_case for fields and procedure names
MACRO_CASE for constants
PascalCase for types

Nim NEP-1 recommends:

camelCase for fields and procedure names
PascalCase for constants
PascalCase for types

To facilitate collaboration and comparison, Nim-beacon-chain uses the Ethereum Foundation convention.

License

Licensed and distributed under either of

MIT license: LICENSE-MIT or http://opensource.org/licenses/MIT

Apache License, Version 2.0, (LICENSE-APACHEv2 or http://www.apache.org/licenses/LICENSE-2.0)

at your option. This file may not be copied, modified, or distributed except according to those terms.

5.6 KiB Raw Blame History