Go implementation of Ethereum 2.0 - casper & sharding
Switch branches/tags
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
beacon-chain Quick fix on a pseudocode typo (#1106) Dec 15, 2018
contracts Update Registration Contract in Solidity (#996) Nov 30, 2018
docs Fixed broken reference link to eth2.0 spec (#784) Nov 16, 2018
k8s Kubernetes 4 of ?? - rotate secrets (#991) Nov 29, 2018
proto Implement Attestation Processing Block Operations (#1088) Dec 14, 2018
scripts Use --batch for gazelle to help with timeouts on buildkite (#843) Nov 21, 2018
shared Implement Attestation Processing Block Operations (#1088) Dec 14, 2018
tools Revert "Update dependency com_github_aws_aws_sdk_go to v0.10.4" (#1002) Nov 30, 2018
validator Removed Deprecated BeaconBlock Fields (#1035) Dec 3, 2018
.buildkite-bazelrc More fixes to bazel buildkite and update rules_go (#626) Oct 5, 2018
.codecov.yml Adding Basic Private Key Management (#671) Nov 8, 2018
.gitattributes whisper: Golint fixes in whisper packages (#16637) May 2, 2018
.gitignore Add detailed git workflow (#1057) Dec 7, 2018
.gometalinter.json Add Golint (#344) Jul 29, 2018
.soliumignore Moving solidity lint check to bazel / buildkite (#629) Oct 7, 2018
.soliumrc.json Update Registration Contract in Solidity (#996) Nov 30, 2018
.travis.yml Proposal to upgrade to 1.11 (#652) Oct 13, 2018
BUILD.bazel Updated Genesis JSON and Fixed Test (#1044) Dec 5, 2018
CONTRIBUTING.md Add detailed git workflow (#1057) Dec 7, 2018
LICENSE.md update to GPLv3 (#297) Jul 20, 2018
PULL_REQUEST_TEMPLATE.md Create PULL_REQUEST_TEMPLATE.md (#532) Sep 18, 2018
README.md adding docs (#1009) Nov 30, 2018
WORKSPACE Update com_github_libp2p_go_libp2p_discovery commit hash to e9dd335 (#… Dec 14, 2018
genesis.json Use Validator Status in Proto (#1082) Dec 12, 2018
package.json Pin dependency solium to 1.1.8 (#723) Nov 6, 2018
renovate.json Add renovate.json (#722) Nov 6, 2018
service-account.json.enc Bazel cache for travis (#236) Jul 7, 2018
yarn.lock Pin dependency solium to 1.1.8 (#723) Nov 6, 2018

README.md

Prysmatic Labs Ethereum Serenity Implementation

Build status

This is the main repository for the beacon chain and sharding implementation for Ethereum Serenity Prysmatic Labs.

Before you begin, check out our Contribution Guidelines and join our active chat room on Discord or Gitter below:

Discord Gitter

Also, read our Sharding Reference Implementation Doc. This doc provides a background on the sharding implementation we follow at Prysmatic Labs.

Table of Contents

Running Our Demo Release

To run our current release, v0.0.0, as a local demo, you'll need to run a beacon chain node and a validator client.

In this local demo, you can start a beacon chain from genesis, connect as a validator client through a public key, and propose/vote on beacon blocks during each cycle. For more information on the full scope of the public demo, see the demo information here.

Installation

You can either choose to run our system via:

  • Downloading our Precompiled Binaries from our latest release
  • Use Docker
  • Use Our Build Tool, Bazel (Recommended)

Run Our Pre-Compiled Binaries

First, download our latest release for your operating system. Then:

chmod +x ./beacon-chain
chmod +x ./validator

Run Via Bazel (Recommended)

First, clone our repository:

git clone https://github.com/prysmaticlabs/prysm

Download the Bazel build tool by Google here and ensure it works by typing:

bazel version

Bazel manages all of the dependencies for you (including go and necessary compilers) so you are all set to build prysm.

Building

Then, build both parts of our system: a beacon chain node implementation, and a validator client:

bazel build //beacon-chain:beacon-chain
bazel build //validator:validator

Running The Beacon Chain

To start the system, we need to seed the beacon chain state with an initial validator set for local development. We created a reference genesis.json in the prysm base directory for this! You'll also need a special data directory where all the beacon chain data will be persisted to.

Then, you can run the node as follows:

With the binary executable:

./beacon-chain \
  --genesis-json /path/to/genesis.json \
  --datadir /path/to/your/datadir \
  --rpc-port 4000 \
  --simulator \
  --demo-config \
  --p2p-port 9000

With bazel:

bazel run //beacon-chain --\
  --genesis-json /path/to/genesis.json \
  --datadir /path/to/your/datadir \
  --rpc-port 4000 \
  --simulator \
  --demo-config \
  --p2p-port 9000

We added a --simulator flag that simulates other nodes connected to you sending your node blocks for processing. Given this is a local development version and you'll only be running 1 validator client, this gives us a good idea of what the system will need to handle in the wild and will help advance the chain.

We also have a --demo-config flag that configures some internal parameters for you to run a local demo version of the system.

If you want to see what's happening in the system underneath the hood, add a --verbosity debug flag to show every single thing the beacon chain node does during its run time. If you want to rerun the beacon chain, delete and create a new data directory for the system to start from scratch.

beaconsystem

Running an ETH2.0 Validator Client

Once your beacon node is up, you'll need to attach a validator client as a separate process. This validator is in charge of running Casper+Sharding responsibilities (shard state execution to be designed in phase 2). This validator will listen for incoming beacon blocks and shard assignments and determine when its time to perform attester/proposer responsibilities accordingly.

To get started, you'll need to use a public key from the initial validator set of the beacon node. Here are a few you can try out:

AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB
CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC

Run as follows:

With the binary executable:

./validator \
  --beacon-rpc-provider http://localhost:4000 \
  --datadir /path/to/uniquevalidatordatadir \
  --pubkey CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC

With Bazel:

bazel run //validator --\
  --beacon-rpc-provider http://localhost:4000 \
  --datadir /path/to/uniquevalidatordatadir \
  --pubkey CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC

This will connect you to your running beacon node and listen for shard/slot assignments! The beacon node will update you at every cycle transition and shuffle your validator into different shards and slots in order to vote on or propose beacon blocks.

if you want to run multiple validator clients, each one needs to have its own data directory where it will persist information, so create a new one each time and pass it into the validator command with the flag --datadir /path/to/validatordatadir.

Running Via Docker

docker run -p 4000:4000 -v /path/to/genesis.json:/genesis.json gcr.io/prysmaticlabs/prysm/beacon-chain:latest \
  --genesis-json /genesis.json \
  --rpc-port 4000 \
  --simulator \
  --demo-config \
  --p2p-port 9000

Then, to run a validator client, use:

docker run gcr.io/prysmaticlabs/prysm/validator:latest \
  --beacon-rpc-provider http://{YOUR_LOCAL_IP}:4000 \
  --pubkey CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC

This will connect you to your running beacon node and listen for shard/slot assignments! The beacon node will update you at every cycle transition and shuffle your validator into different shards and slots in order to vote on or propose beacon blocks.

Running While Connected to a Mainchain Ethereum 1.0 Node

If you want to run the system with a real Web3 endpoint to listen for incoming Ethereum 1.0 block hashes, follow the instructions on setting up a geth node here.

Running Under Windows

The best way to run under Windows is to clone the repository and then run the node with go run from the Windows command line. Go 1.10 fails due to documented permission errors so be sure you are running Go 1.11 or later. Go through the source code and resolve any dependencies. Create two empty files for use as data directories by the beacon chain and validator respectively. The contents of these files should be deleted each time you run the software. After cloning the Prsym repository, run the node as follows:

go run ./beacon-chain main.go \
   --genesis-json /path/to/genesis.json \
   --datadir /path/to/your/datadir \
   --rpc-port 4000 \
   --simulator \
   --demo-config \
   --p2p-port 9000

After the beacon chain is up and running, run the validator client as a separate process as follows:

go run ./validator/main.go \
  --beacon-rpc-provider http://localhost:4000 \
  --datadir /path/to/uniquevalidatordatadir \
  --pubkey CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC

Testing

To run the unit tests of our system do:

bazel test //...

To run our linter, make sure you have gometalinter installed and then run:

gometalinter ./...

Contributing

We have put all of our contribution guidelines into CONTRIBUTING.md! Check it out to get started.

nyancat

License

GNU General Public License v3.0