status-im
/
nimbus-eth1
mirror of https://github.com/status-im/nimbus-eth1.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
Nimbus: an Ethereum Execution Client for Resource-Restricted Devices https://status-im.github.io/nimbus-eth1/
487 Commits 34 Branches 3 Tags 155 MiB
Nim 98%
Shell 0.7%
Makefile 0.5%
CodeQL 0.3%
Nix 0.2%
Other 0.1%
Go to file
Yuriy Glukhov 7a732040ba Added comments 2018-09-26 13:31:48 +03:00
.vscode vscode: add default build task 2018-08-22 21:43:22 -06:00
doc Update Nimbus - An Ethereum 2.0 Sharding Client_xt.md 2018-05-28 10:44:12 -07:00
examples update example 2018-07-17 19:18:59 +02:00
nimbus Added comments 2018-09-26 13:31:48 +03:00
tests Deal with the refactoring in status-im/nim-rlp#20 2018-09-26 12:58:23 +03:00
.appveyor.yml appveyor: fix version check 2018-09-06 11:57:26 -06:00
.gitignore vscode: add default build task 2018-08-22 21:43:22 -06:00
.travis.yml ci: update 2018-09-04 21:01:33 -06:00
GeneralStateTests.md Partly fix state_db getCode for 20 new working GeneralStateTests (#156) 2018-09-20 21:36:57 +00:00
LICENSE-APACHEv2 Update README badges and add dual-license header 2018-04-06 16:52:10 +02:00
LICENSE-MIT Update README badges and add dual-license header 2018-04-06 16:52:10 +02:00
README.md Cosmetic change 2018-09-25 02:10:38 +03:00
default.nix Updated Nix build environment for working with Nimbus 2018-06-24 17:46:43 +03:00
nim.cfg Add the new experimental forloopmacros flag for Stint fix #109 (#110) 2018-08-20 16:13:32 +02:00
nim.nix Restore the Nix build 2018-09-26 12:34:24 +03:00
nimbus.nimble Implement a --datadir command-line options 2018-09-25 02:06:20 +03:00
nimbus.nix Restore the Nix build 2018-09-26 12:34:24 +03:00

README.md

Nimbus: an Ethereum 2.0 Sharding Client for Resource-Restricted Devices

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

Join the Status community chats: Gitter: #status-im/nimbus Riot: #nimbus Riot: #dev-status

Rationale

Nimbus: an Ethereum 2.0 Sharding Client

Building & Testing

Prerequisites

  • A recent version of Nim
    • We use the version in the Status fork
    • Follow the Nim installation instructions or use choosenim to manage your Nim versions
  • A recent version of Facebook's RocksDB

Obtaining the prerequisites through the Nix package manager

Users of the Nix package manager can install all prerequisites simply by running:

nix-shell nimbus.nix

Build & Install

We use Nimble to manage dependencies and run tests.

To build and install Nimbus in your home folder, just execute:

nimble install

After a succesful installation, running nimbus --help will provide you with a list of the available command-line options. To start syncing with mainnet, just execute nimbus without any parameters.

To execute all tests:

nimble test

Our Wiki provides additional helpful information for debugging individual test cases and for pairing Nimbus with a locally running copy of Geth.

Troubleshooting

Sometimes, the build will fail even though the latest CI is green - here are a few tips to handle this:

  • Wrong Nim version
    • We depend on many bleeding-edge features - Nim regressions often happen
    • Use the Status fork of Nim
  • Wrong versions of dependencies
    • nimble dependency tracking often breaks due to its global registry
    • wipe the nimble folder and try again
  • C compile or link fails
    • Nim compile cache is pretty buggy and sometimes will fail to recompile
    • wipe your nimcache folder

License

Licensed under both of the following: