Skip to content
Nimbus: an Ethereum 2.0 Sharding Client for Resource-Restricted Devices
Branch: master
Clone or download
stefantalpalaru and arnetheduck CI: use a release build for the test suite (#278)
* CI: use a release build for the test suite

Makefile: the "testsuite" target is no longer needed

* rename EXTRA_NIM_PARAMS to NIMFLAGS
Latest commit 9f0c945 Mar 17, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode vscode: add default build task Aug 23, 2018
doc
examples
nimbus assert() -> doAssert() Mar 13, 2019
nix [Nix] Some steps towards cross-compilation support Feb 19, 2019
premix
tests
vendor bump submodules Mar 15, 2019
.appveyor.yml CI: use a release build for the test suite (#278) Mar 17, 2019
.gitignore build p2pd and run some client tests Feb 27, 2019
.gitmodules build p2pd and run some client tests Feb 27, 2019
.travis.yml
GeneralStateTests.md GST +3 Mar 13, 2019
LICENSE-APACHEv2 Update README badges and add dual-license header Apr 6, 2018
LICENSE-MIT Update README badges and add dual-license header Apr 6, 2018
Makefile
PersistBlockTests.md add problematic block tests Mar 13, 2019
PrecompileTests.md
README.md CI: use a release build for the test suite (#278) Mar 17, 2019
TracerTests.md
add_submodule.sh add submodules for csources and Nimble Feb 24, 2019
default.nix
env.sh
nim.cfg
nimble.sh very simple reproducibility test Feb 24, 2019
nimbus.nimble

README.md

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

Windows build status (Appveyor) Build Status (Travis) 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. 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

Rocksdb

A recent version of Facebook's RocksDB is needed - it can usually be installed using a package manager of your choice:

# MacOS
brew install rocksdb

# Fedora
dnf install rocksdb-devel

# Debian and Ubuntu
sudo apt-get install librocksdb-dev

On Windows, you can download pre-compiled DLLs.

You can also build and install it by following their instructions

Developer tools

GNU make, Bash and the usual POSIX utilities

Obtaining the prerequisites through the Nix package manager

Experimental

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

nix-shell default.nix

Build & Develop

POSIX-compatible OS

To build Nimbus (in "build/nimbus"), just execute:

make

Running ./build/nimbus --help will provide you with a list of the available command-line options. To start syncing with mainnet, just execute ./build/nimbus without any parameters.

To execute all tests:

make test

To pull the latest changes in all the Git repositories involved:

git pull
make update

To run a command that might use binaries from the Status Nim fork:

./env.sh bash
which nim

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

Windows

Install Mingw-w64 for your architecture using the "MinGW-W64 Online Installer" (first link under the directory listing). Run it and select your architecture in the setup menu ("i686" on 32-bit, "x86_64" on 64-bit), set the threads to "win32" and the exceptions to "dwarf" on 32-bit and "seh" on 64-bit. Change the installation directory to "C:\mingw-w64" and add it to your system PATH in "My Computer"/"This PC" -> Properties -> Advanced system settings -> Environment Variables -> Path -> Edit -> New -> C:\mingw-w64\mingw64\bin (it's "C:\mingw-w64\mingw32\bin" on 32-bit)

Install Git for Windows and use a "Git Bash" shell to clone and build Nimbus.

If you don't want to compile RocksDB and SQLite separately, you can fetch pre-compiled DLLs with:

mingw32-make fetch-dlls

This will place the right DLLs for your architecture in the "build/" directory.

You can now follow those instructions in the previous section by replacing make with mingw32-make (regardless of your 32-bit or 64-bit architecture).

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"

  • the Premix debugging tools are documented separately

  • you can control the Makefile's verbosity with the V variable (defaults to 1):

make V=0 # quiet
make V=2 test # more verbose than usual
make LOG_LEVEL=DEBUG nimbus # this is the default
make LOG_LEVEL=TRACE nimbus # log everything
  • pass arbitrary parameters to the Nim compiler:
make NIMFLAGS="-d:release"
  • if you want to use SSH keys with GitHub:
make github-ssh

Git submodule workflow

Working on a dependency:

cd vendor/nim-chronicles
git checkout -b mybranch
# make some changes
git status
git commit -a
git push origin mybranch
# create a GitHub PR and wait for it to be approved and merged
git checkout master
git pull
git branch -d mybranch
# realise that the merge was done without "--no-ff"
git branch -D mybranch
# update the submodule's commit in the superproject
cd ../..
git status
git add vendor/nim-chronicles
git commit

It's important that you only update the submodule commit after it's available upstream.

You might want to do this on a new branch of the superproject, so you can make a GitHub PR for it and see the CI test results.

Don't update all Git submodules at once, just because you found the relevant Git command or make target. You risk updating submodules to other people's latest commits when they are not ready to be used in the superproject.

Adding the submodule "https://github.com/status-im/foo" to "vendor/foo":

./add_submodule.sh status-im/foo

Removing the submodule "vendor/bar":

git submodule deinit -f -- vendor/bar
git rm -f vendor/bar

Checking out older commits, either to bisect something or to reproduce an older build:

git checkout <commit hash here>
make clean
make -j8 update

Running a dependency's test suite using nim instead of nimble (which cannot be convinced not to run a dependency check, thus clashing with our jury-rigged "vendor/.nimble/pkgs"):

cd vendor/nim-blscurve
../../nimble.sh test

Troubleshooting

Report any errors you encounter, please, if not already documented!

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

Using the Makefile

  • Turn it off and on again:
make clean
make update

Using Nimble directly

  • 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

or

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

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.