23eea197f6
* Implement split preset/config support This is the initial bulk refactor to introduce runtime config values in a number of places, somewhat replacing the existing mechanism of loading network metadata. It still needs more work, this is the initial refactor that introduces runtime configuration in some of the places that need it. The PR changes the way presets and constants work, to match the spec. In particular, a "preset" now refers to the compile-time configuration while a "cfg" or "RuntimeConfig" is the dynamic part. A single binary can support either mainnet or minimal, but not both. Support for other presets has been removed completely (can be readded, in case there's need). There's a number of outstanding tasks: * `SECONDS_PER_SLOT` still needs fixing * loading custom runtime configs needs redoing * checking constants against YAML file * yeerongpilly support `build/nimbus_beacon_node --network=yeerongpilly --discv5:no --log-level=DEBUG` * load fork epoch from config * fix fork digest sent in status * nicer error string for request failures * fix tools * one more * fixup * fixup * fixup * use "standard" network definition folder in local testnet Files are loaded from their standard locations, including genesis etc, to conform to the format used in the `eth2-networks` repo. * fix launch scripts, allow unknown config values * fix base config of rest test * cleanups * bundle mainnet config using common loader * fix spec links and names * only include supported preset in binary * drop yeerongpilly, add altair-devnet-0, support boot_enr.yaml |
||
|---|---|---|
| .. | ||
| README.md | ||
| libnfuzz.h | ||
| libnfuzz.nim | ||
README.md
Introduction
libnfuzz is a wrapper library that exports to C, a set of fuzzing test cases
written in Nim and making use of nimbus-eth2.
Building
To build the wrapper library (for more details follow first the instructions from nimbus-eth2):
git clone https://github.com/status-im/nimbus-eth2.git
cd nimbus-eth2
make
# static library
make libnfuzz.a
# dynamic loaded library
make libnfuzz.so
Default, the library is build with the minimal config. To select a specific config you can instead run:
# build with mainnet config
make libnfuzz.a NIMFLAGS="-d:const_preset=mainnet"
For the library to be useful for fuzzing with libFuzzer (e.g. for integration with beacon-fuzz) we can pass additional Nim arguments, e.g.:
make libnfuzz.a NIMFLAGS="--cc:clang --passC:'-fsanitize=fuzzer-no-link' --passL='-fsanitize=fuzzer'"
To disable BLS verification on deserialization of SSZ objects add -d:ssz_testing to the NIMFLAGS.
Other useful options might include: --clang.path:<path>, --clang.exe:<exe>, --clang.linkerexe:<exe>, -d:const_preset=mainnet
It might also deem useful to lower the log level, e.g. by adding -d:chronicles_log_level=fatal.
Usage
There is a libnfuzz.h file provided for easy including in C or C++ projects.
It is most important that before any of the exported tests are called, the
NimMain() call is done first. Additionally, all following library calls need
to be done from the same thread as from where the original NimMain() call was
done.