status-im
/
nimbus-eth2
mirror of https://github.com/status-im/nimbus-eth2.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
Nim implementation of the Ethereum Beacon Chain https://nimbus.guide
140 Commits 111 Branches 116 Tags 223 MiB
Nim 94.9%
Shell 1.9%
C 1.7%
Makefile 0.6%
Rich Text Format 0.2%
Other 0.5%
Go to file
Bruno Škvorc 110abf9ffd
Merge pull request #50 from status-im/update-readme 
Updated readme
 		2018-12-27 15:23:51 +01:00
.vscode vscode: add tasks 2018-12-13 11:14:21 -06:00
beacon_chain initial rough commit of a work/attestation pool (#46) 2018-12-26 13:17:30 +01:00
benchmarks hash -> root 2018-12-11 15:53:18 -06:00
research spec updates 2018-12-24 10:08:11 +01:00
tests spec updates 2018-12-24 10:08:11 +01:00
.appveyor.yml appveyor: fix version check 2018-09-06 11:56:42 -06:00
.gitignore initial commit 2018-07-20 15:46:03 +02:00
.travis.yml ci: update 2018-09-04 20:34:09 -06:00
LICENSE-APACHEv2 initial commit 2018-07-20 15:46:03 +02:00
LICENSE-MIT initial commit 2018-07-20 15:46:03 +02:00
README.md Updated readme 2018-12-27 15:22:58 +01:00
beacon_chain.nim Add the types used in the beacon chain 2018-07-20 20:18:56 +02:00
beacon_chain.nimble spec updates (#45) 2018-12-21 16:37:46 -06:00
nim.cfg initial impl of fork choice rules. Main types sorted out 2018-09-03 18:42:22 +02:00

README.md

Ethereum Beacon Chain

Build Status (Travis) Windows build status (Appveyor) License: Apache License: MIT Stability: experimental

An alternative implementation of the Ethereum beacon chain in Nim.

Please see Full Beacon chain specs and the Ethereum Foundation reference implementation.

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

Test vectors

The Eth 2.0 test vectors and their generators are available in a dedicated repository.

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.

Installation

You can install the developement version of the library through nimble with the following command

nimble install https://github.com/status-im/nim-beacon-chain@#master

Building and Testing

To try out the implementation, please first make sure you have a Nim environment configured.

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

Then:

git clone git@github.com:status-im/nim-beacon-chain
cd nim-beacon-chain
nimble install
nimble test

This should produce some passing tests.

Additionally, you can run our simulation which generates a genesis file from some randomly generated validators. It then fires up 10 beacon nodes (each hosting 9 validators) which talk to each other and try to do state transitions. The simulation can be run by executing:

bash tests/simulation/start.sh

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

License

Licensed and distributed under either of

or

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