mirror of https://github.com/status-im/nim-eth.git
Common utilities for Ethereum
https://nimbus.status.im
3ce2d9a58e
This removes the outdated copy of the SSZ code. It became incorrect over time (e.g., empty SSZ list elements), and is no longer in use by GitHub projects: https://github.com/search?q=extension%3Anim+eth%2Fssz The canonical SSZ implementation resides at `nim-ssz-serialization`. Compared to `nim-eth`, these changes were made meanwhile: - `bitseqs` was extended with JSON serialization support, and with the new functions `isZero` and `countOnes`. - `bytes_reader` was renamed to `codec`, extended with a few additional SSZ type conversions as well as support for `SingleMemberUnion`. - The simplified merkle tree implementation in `merkle_tree.nim` was removed. It was not used by other projects. - `merkleization` was extended with support for `HashArray`, `HashList` and `SingleMemberUnion`. The `isValidProof` functionality has been moved to `nimbus-eth2` and replaced with the EF defined function `is_valid_merkle_branch`. The test was also moved to `nimbus-eth2`. There are no other GitHub projects using `isValidProof`: https://github.com/search?q=extension%3Anim+isValidProof Furthermore, a definition for `GeneralizedIndex` was added. - `ssz_serialization` was moved one directory up, and improved with bug fixes and `HashArray`, `HashList` and `SingleMemberUnion` support. - `types` was extended with JSON serialization and new type support for `Uint128`, `Uint256`, `HashArray`, `HashList` and `SingleMemberUnion`. There is also a new `getBit` function for `BitList`. |
||
---|---|---|
.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.