Common utilities for Ethereum https://nimbus.status.im
Go to file
Etan Kissling 3ce2d9a58e
remove outdated and incorrect SSZ code
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`.
2021-12-10 15:51:22 +01:00
.github/workflows Add initial handling of acks (#406) 2021-10-15 13:38:51 +02:00
doc Remove `{.rlpInline.}` which was never really implemented 2021-08-10 14:08:35 +03:00
eth remove outdated and incorrect SSZ code 2021-12-10 15:51:22 +01:00
tests remove outdated and incorrect SSZ code 2021-12-10 15:51:22 +01:00
.appveyor.yml Remove portal wire code which was moved to nimbus-eth1 repo (#370) 2021-07-09 22:14:31 +02:00
.gitignore use bearssl rng throughout (#265) 2020-07-07 10:56:26 +02:00
.travis.yml Remove portal wire code which was moved to nimbus-eth1 repo (#370) 2021-07-09 22:14:31 +02:00
LICENSE-APACHEv2 Moved eth-common to eth 2019-02-05 12:10:36 +02:00
LICENSE-MIT Moved eth-common to eth 2019-02-05 12:10:36 +02:00
README.md CI: refactor Nim compiler caching (#358) 2021-06-03 02:40:58 +02:00
eth.nimble remove outdated and incorrect SSZ code 2021-12-10 15:51:22 +01:00

README.md

eth - Eth Common Library

License: Apache License: MIT Stability: experimental Github action

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

or

at your option. This file may not be copied, modified, or distributed except according to those terms.