mirror of https://github.com/status-im/nim-eth.git
Common utilities for Ethereum
https://nimbus.status.im
00ed6ad312
* Provide dedicated `DisconnectionReason` enum type RLP reader why: Without this reader, the program communicating via RLPX will crash when receiving out of bound reason codes disconnect message. Out of bound value assignments to an enum causes a `RangeError`defect and consequently the program to terminate. This `RangeError` is avoided here and a `MalformedRlpError` catchable error raised. * Using default exception type in bespoke `read(DisconnectionReason)` why: This should not differ from the default enum parser. The particular message is different and more targeted, here. Note: The default RLP parser was not used because ` `array[1,DisconnectionReason]` is currently not properly handled and should give a siliar error message as a `DisconnectionReason` error. * De-clutter, custom read() was not needed Co-authored-by: jordan <jordan@curd.mjh-it.com> |
||
---|---|---|
.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
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.