mirror of https://github.com/status-im/nim-eth.git
Common utilities for Ethereum
https://nimbus.status.im
4bc020384f
why: This is a legacy feature and its usage should peter out over time. details: Use -d:chunked_rlpx_enabled for enabling chunked RLPx message handling. |
||
|---|---|---|
| .github/workflows | ||
| doc | ||
| eth | ||
| tests | ||
| .appveyor.yml | ||
| .gitignore | ||
| .travis.yml | ||
| LICENSE-APACHEv2 | ||
| LICENSE-MIT | ||
| README.md | ||
| eth.nimble | ||
README.md
eth - Eth Common Library
Introduction
Ethereum-related utilities written in Nim. Includes things like Bloom filters, private/public key utilities, RLP, devp2p, and more.
Docs
Prerequisites
- Nim & Nimble
- RocksDB, SQLite, LMDB (required for the trie backend tests)
E.g. on Ubuntu one can run:
apt install -y librocksdb-dev liblmdb-dev sqlite3
Building & Testing
# Install required modules
nimble install
# Run full test suite
nimble test
You can also run specific parts of the test suite, e.g.:
# Test p2p functionality
nimble test_p2p
# Test rlp functionality
nimble test_rlp
Fuzzing
Next to the test suite, there are also several fuzzing test cases available. How these can be run is explained in the fuzzing readme.
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.