2018-05-27 19:13:55 +00:00
# Nimbus: an Ethereum 2.0 Sharding Client for Resource-Restricted Devices
2018-02-06 19:20:06 +00:00
2018-04-06 14:52:10 +00:00
[](https://travis-ci.org/status-im/nimbus)
2018-09-05 03:03:10 +00:00
[](https://ci.appveyor.com/project/nimbus/nimbus)
[](https://opensource.org/licenses/Apache-2.0)
2018-04-06 14:52:10 +00:00
[](https://opensource.org/licenses/MIT)
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
[](https://gitter.im/status-im/nimbus)
2018-03-17 08:39:13 +00:00
[](https://chat.status.im/#/room/#nimbus:status.im)
2018-09-05 03:01:33 +00:00
[](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-05-28 17:45:03 +00:00
[Nimbus: an Ethereum 2.0 Sharding Client ](https://github.com/status-im/nimbus/blob/master/doc/Nimbus%20-%20An%20Ethereum%202.0%20Sharding%20Client_xt.md )
2018-04-06 14:52:10 +00:00
2018-06-19 19:19:07 +00:00
## Building & Testing
2018-06-24 14:34:32 +00:00
### Prerequisites
2018-08-31 22:23:51 +00:00
* A recent version of Nim
* We use the version in the [Status fork ](https://github.com/status-im/Nim )
* Normally, this is the latest released version of Nim but it may also include custom patches
* Follow the Nim installation instructions or use [choosenim ](https://github.com/dom96/choosenim ) to manage your Nim versions
* 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
2018-06-19 19:19:07 +00:00
2018-06-24 14:34:32 +00:00
### 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
nix-shell nimbus.nix
```
### Build
2018-08-31 22:23:51 +00:00
We use [Nimble ](https://github.com/nim-lang/nimble ) to manage dependencies and run tests.
2018-06-19 19:19:07 +00:00
2018-08-31 22:23:51 +00:00
To build and run test suite:
```bash
nimble test
```
2018-07-20 20:02:52 +00:00
2018-08-31 22:23:51 +00:00
Based on our config, Nimble will write binaries to `build/` - you can do this manually also, as in the following examples:
2018-07-20 20:02:52 +00:00
2018-08-31 22:23:51 +00:00
Run example:
```bash
mkdir -p build
nim c -o:build/decompile_smart_contract -r examples/decompile_smart_contract.nim
```
2018-07-20 20:02:52 +00:00
2018-09-07 22:29:25 +00:00
Run Ethereum [JSON-based general state tests ](https://github.com/ethereum/tests/ ):
2018-07-20 20:02:52 +00:00
```
2018-08-31 22:23:51 +00:00
mkdir -p build
2018-09-07 19:47:45 +00:00
nim c -o:build/test_generalstate_json -r --experimental:forLoopMacros tests/test_generalstate_json.nim
2018-07-20 20:02:52 +00:00
```
2018-08-31 22:23:51 +00:00
#### 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 ](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
2018-04-06 14:52:10 +00:00
## License
2018-09-05 03:37:47 +00:00
Licensed under both of the following:
2018-04-06 14:52:10 +00:00
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
2018-05-17 05:03:36 +00:00
* MIT license: [LICENSE-MIT ](LICENSE-MIT ) or http://opensource.org/licenses/MIT
