74add30c5f
ForLoopMacros cleanup |
||
|---|---|---|
| .vscode | ||
| doc | ||
| examples | ||
| nimbus | ||
| tests | ||
| .appveyor.yml | ||
| .gitignore | ||
| .travis.yml | ||
| GeneralStateTests.md | ||
| LICENSE-APACHEv2 | ||
| LICENSE-MIT | ||
| PersistBlockTests.md | ||
| PrecompileTests.md | ||
| README.md | ||
| TracerTests.md | ||
| default.nix | ||
| nim.cfg | ||
| nim.nix | ||
| nimbus.nimble | ||
| nimbus.nix | ||
README.md
Nimbus: an Ethereum 2.0 Sharding Client for Resource-Restricted Devices
Join the Status community chats:
Rationale
Nimbus: an Ethereum 2.0 Sharding Client. The code in this repository is currently focusing on Ethereum 1.0 feature parity, while all 2.0 research and development is happening in parallel in nim-beacon-chain. The two repositories are expected to merge in Q1 2019.
Development Updates
To keep up to date with changes and development progress, follow the Nimbus blog.
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
- Compile from source or use the package manager of your OS; for example, Debian, Ubuntu, and Fedora have working RocksDB packages
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.
Build and Run Nimbus
nimble nimbus
./build/nimbus
Report any errors you encounter, please, if not already documented!
Development tips
- you can switch the DB backend with a Nim compiler define:
-d:nimbus_db_backend=...where the (case-insensitive) value is one of "rocksdb" (the default), "sqlite", "lmdb".
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 and distributed under either of
- MIT license: LICENSE-MIT or http://opensource.org/licenses/MIT
or
- 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.