nimbus-eth1/README.md

234 lines
8.0 KiB
Markdown
Raw Normal View History

2018-05-27 19:13:55 +00:00
# Nimbus: an Ethereum 2.0 Sharding Client for Resource-Restricted Devices
2018-12-27 14:32:35 +00:00
[![Windows build status (Appveyor)](https://img.shields.io/appveyor/ci/nimbus/nimbus/master.svg?label=Windows "Windows build status (Appveyor)")](https://ci.appveyor.com/project/nimbus/nimbus)
[![Build Status (Travis)](https://img.shields.io/travis/status-im/nimbus/master.svg?label=Linux%20/%20macOS "Linux/macOS build status (Travis)")](https://travis-ci.org/status-im/nimbus)
2018-09-05 03:03:10 +00:00
[![License: Apache](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
![Stability: experimental](https://img.shields.io/badge/stability-experimental-orange.svg)
2018-02-07 16:50:28 +00:00
2018-03-17 08:39:13 +00:00
Join the Status community chats:
2018-08-31 22:23:51 +00:00
[![Gitter: #status-im/nimbus](https://img.shields.io/badge/gitter-status--im%2Fnimbus-orange.svg)](https://gitter.im/status-im/nimbus)
2018-03-17 08:39:13 +00:00
[![Riot: #nimbus](https://img.shields.io/badge/riot-%23nimbus%3Astatus.im-orange.svg)](https://chat.status.im/#/room/#nimbus:status.im)
2018-09-05 03:01:33 +00:00
[![Riot: #dev-status](https://img.shields.io/badge/riot-%23dev--status%3Astatus.im-orange.svg)](https://chat.status.im/#/room/#dev-status:status.im)
2018-03-17 08:39:13 +00:00
2018-05-17 04:51:17 +00:00
## Rationale
2018-11-22 13:00:24 +00:00
[Nimbus: an Ethereum 2.0 Sharding Client](https://our.status.im/nimbus-for-newbies/). 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](https://github.com/status-im/nim-beacon-chain). The two repositories are expected to merge in Q1 2019.
2018-12-27 14:32:35 +00:00
## Development Updates
To keep up to date with changes and development progress, follow the [Nimbus blog](https://our.status.im/tag/nimbus/).
## Building & Testing
### Prerequisites
2018-08-31 22:23:51 +00:00
* A recent version of Facebook's [RocksDB](https://github.com/facebook/rocksdb/)
* Compile [from source](https://github.com/facebook/rocksdb/blob/master/INSTALL.md) or use the package manager of your OS; for example, [Debian](https://packages.debian.org/search?keywords=librocksdb-dev&searchon=names&exact=1&suite=all&section=all), [Ubuntu](https://packages.ubuntu.com/search?keywords=librocksdb-dev&searchon=names&exact=1&suite=all&section=all), and [Fedora](https://apps.fedoraproject.org/packages/rocksdb) have working RocksDB packages
* on Windows, you can [download pre-compiled DLLs](#windows)
* GNU make, Bash and the usual POSIX utilities
#### Obtaining the prerequisites through the Nix package manager
Users of the [Nix package manager](https://nixos.org/nix/download.html) can install all prerequisites simply by running:
``` bash
2019-03-11 22:03:29 +00:00
nix-shell default.nix
```
### Build & Develop
#### POSIX-compatible OS
To build Nimbus (in "build/nimbus"), just execute:
2018-08-31 22:23:51 +00:00
```bash
make
2018-08-31 22:23:51 +00:00
```
2018-07-20 20:02:52 +00:00
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.
2018-07-20 20:02:52 +00:00
To execute all tests:
2018-08-31 22:23:51 +00:00
```bash
make test
```
To pull the latest changes in all the Git repositories involved:
```bash
git pull
make update
```
To run a command that might use binaries from the Status Nim fork:
```bash
./env.sh vim
2018-08-31 22:23:51 +00:00
```
2018-07-20 20:02:52 +00:00
Our Wiki provides additional helpful information for [debugging individual test cases][1]
and for [pairing Nimbus with a locally running copy of Geth][2].
#### Windows
2018-07-20 20:02:52 +00:00
Install Mingw-w64 for your architecture using the "[MinGW-W64 Online
Installer](https://sourceforge.net/projects/mingw-w64/files/)" (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)
2018-12-27 14:32:35 +00:00
Install [Git for Windows](https://gitforwindows.org/) 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:
2018-12-27 14:32:35 +00:00
```bash
mingw32-make fetch-dlls
2018-12-27 14:32:35 +00:00
```
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).
2018-12-27 14:32:35 +00:00
### 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](premix/readme.md)
- you can control the Makefile's verbosity with the V variable (defaults to 1):
```bash
make V=0 # quiet
make V=2 test # more verbose than usual
```
- same for the [Chronicles log level](https://github.com/status-im/nim-chronicles#chronicles_log_level):
```bash
make LOG_LEVEL=DEBUG nimbus # this is the default
make LOG_LEVEL=TRACE nimbus # log everything
```
- pass arbitrary parameters to the Nim compiler:
```bash
make EXTRA_NIM_PARAMS="-d:release"
```
2019-02-21 22:46:28 +00:00
- if you want to use SSH keys with GitHub:
```bash
make github-ssh
```
#### Git submodule workflow
Working on a dependency:
```bash
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":
```bash
./add_submodule.sh status-im/foo
```
Removing the submodule "vendor/bar":
```bash
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:
```bash
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"):
```bash
cd vendor/nim-blscurve
../../nimble.sh test
```
### Troubleshooting
Report any errors you encounter, please, if not [already documented](https://github.com/status-im/nimbus/issues)!
2018-08-31 22:23:51 +00:00
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:
```bash
make clean
make update
```
#### Using Nimble directly
2018-08-31 22:23:51 +00:00
* Wrong Nim version
* We depend on many bleeding-edge features - Nim regressions often happen
* Use the [Status fork](https://github.com/status-im/Nim) 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
2018-07-20 20:02:52 +00:00
## License
2018-12-27 14:32:35 +00:00
Licensed and distributed under either of
* MIT license: [LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT
or
2019-01-02 13:50:44 +00:00
* Apache License, Version 2.0, ([LICENSE-APACHEv2](LICENSE-APACHEv2) or http://www.apache.org/licenses/LICENSE-2.0)
at your option. These files may not be copied, modified, or distributed except according to those terms.
[1]: https://github.com/status-im/nimbus/wiki/Understanding-and-debugging-Nimbus-EVM-JSON-tests
[2]: https://github.com/status-im/nimbus/wiki/Debugging-state-reconstruction