status-im
/
nimbus-eth1
mirror of https://github.com/status-im/nimbus-eth1.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

readme updates

This commit is contained in:
Jacek Sieka 2018-08-31 16:23:51 -06:00
parent 446ea60a02
commit 7b01b6d522
No known key found for this signature in database
GPG Key ID: 6299FEB3EB6FA465
1 changed files with 38 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
README.md
View File

@ -6,6 +6,7 @@
![Stability: experimental](https://img.shields.io/badge/stability-experimental-orange.svg)
Join the Status community chats:
[![Gitter: #status-im/nimbus](https://img.shields.io/badge/gitter-status--im%2Fnimbus-orange.svg)](https://gitter.im/status-im/nimbus)
[![Riot: #dev-status](https://img.shields.io/badge/riot-%23dev--status%3Astatus.im-orange.svg)](https://chat.status.im/#/room/#dev-status:status.im)
[![Riot: #nimbus](https://img.shields.io/badge/riot-%23nimbus%3Astatus.im-orange.svg)](https://chat.status.im/#/room/#nimbus:status.im)
@ -17,11 +18,12 @@ Join the Status community chats:
### Prerequisites
Please install a recent version of Facebook's RocksDB following the instructions here:
https://github.com/facebook/rocksdb/blob/master/INSTALL.md
Currently Nimbus requires the latest development version of the Nim programming language. Follow the [installation steps](https://github.com/nim-lang/Nim) or use [choosenim](https://github.com/dom96/choosenim).
* 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
### Obtaining the prerequisites through the Nix package manager
@ -33,19 +35,40 @@ nix-shell nimbus.nix
### Build
You can build the package and run the tests using `nimble test`. You can run the example using `nim compile --run examples/decompile_smart_contract.nim`.
We use [Nimble](https://github.com/nim-lang/nimble) to manage dependencies and run tests.
You can run the official Ethereum JSON tests for the EVM this way:
create a `./build` directory with `mkdir build` in your cloned repository.
Run
```
nim c -r --nimcache:nimcache -o:build/test tests/test_vm_json.nim
To build and run test suite:
```bash
nimble test
```
The executable will be put in `build`, and nim compilation cache will use `nimcache`.
Based on our config, Nimble will write binaries to `build/` - you can do this manually also, as in the following examples:
Run example:
```bash
mkdir -p build
nim c -o:build/decompile_smart_contract -r examples/decompile_smart_contract.nim
```
Run Ethereum [JSON-based VM tests](https://github.com/ethereum/tests/):
```
mkdir -p build
nim c -o:build/test_vm_json -r tests/test_vm_json.nim
```
#### 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
## License