dcfbc4291d
1.0.0 was never an intentional release and the nim-eth repo is not yet stable in terms of API, thus we start at 0.5.0 and go from there for the first tagged release. Most of the eth code in this repo now is aligned with various specs meaning that most API can be considered "mostly" stable, but there are still aspects being worked on as well as a potential future reorganisation of the code turning nim-eth into a more "pure" spec-driven core ethereum infrastructure repo, removing in the process application-level stuff that happens to be common between nimbus-eth1 and eth2 and ended up in here for convenience.
Fuzzing Tests
This directory contains a set of subdirectories which hold one or more test cases that can be used for fuzzing.
The fuzzing test cases use the fuzzing templates from nim-testutils.
For more details see the fuzzing readme of nim-testutils.
Some of the subdirectories also hold corpus generation tooling in order to have some corpus files to start fuzzing from.
Prerequisites
As explained
in nim-testutils fuzzing readme, first install the fuzzer you want to run.
Next install nim-testutils its ntu application.
E.g. by running the nim-testutils nimble install:
nimble install testutils
How to run
To start fuzzing a test case run following command:
# Rlp fuzzing with libFuzzer
ntu fuzz --fuzzer:libFuzzer rlp/rlp_decode
# Rlp fuzzing with afl
ntu fuzz --fuzzer:afl rlp/rlp_decode
Or another example:
# ENR fuzzing with libFuzzer
ntu fuzz --fuzzer:libFuzzer enr/fuzz_enr
# ENR fuzzing with afl
ntu fuzz --fuzzer:afl enr/fuzz_enr
Manual adjustments
The ntu application is still very limited in its functionality. Many of the underlying fuzzer functionality is not available for adjustment so you might want to configure the setup in a more manual way.
How to do this is briefly explained here for afl and here for libFuzzer.