Common utilities for Ethereum https://nimbus.status.im

Go to file

Jamie Lokier 9a28ed7ef5 RLPx: Protocol names have never been limited to 3 characters Don't treat 3 characters as special in `cmp`. `cmp` for `ProtocolInfo` was wrong because it ignored all characters after the first 3. In the wild we have seen protocol names longer than 3 characters. `snap`, `hive`, `istanbul`, `bzzeth`, `bzz-stream`, `bzz-retrieve`, `dbix`, `opera`, `pchain`, `pchain_child_0`, `sero`, `smilobft`, `spock`. There was never a 3 character limit in the [specification] (https://github.com/ethereum/devp2p/blob/master/rlpx.md). It always said "short ASCII name", until recently on 2021-02-25 it was changed to an 8 characters limit. Also `pi.nameStr` can be removed. Nothing uses it, and it has the same actual effect as just copying the string `pi.name`. Signed-off-by: Jamie Lokier <jamie@shareable.org>		2021-08-10 14:08:35 +03:00
.github/workflows	Remove portal wire code which was moved to nimbus-eth1 repo (#370 )	2021-07-09 22:14:31 +02:00
doc	Remove `{.rlpInline.}` which was never really implemented	2021-08-10 14:08:35 +03:00
eth	RLPx: Protocol names have never been limited to 3 characters	2021-08-10 14:08:35 +03:00
tests	Add helpers to generate merkle proofs (#381 )	2021-08-09 12:17:21 +02: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	add merkle proof verification (#379 )	2021-07-23 13:40:47 +02:00

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

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.