nimbus-eth2/nfuzz
tersec 146fa48454
use ForkedHashedBeaconState in StateData (#2634)
* use ForkedHashedBeaconState in StateData

* fix FAR_FUTURE_EPOCH -> slot overflow; almost always use assign()

* avoid stack allocation in maybeUpgradeStateToAltair()

* create and use dispatch functions for check_attester_slashing(), check_proposer_slashing(), and check_voluntary_exit()

* use getStateRoot() instead of various state.data.hbsPhase0.root

* remove withStateVars.hashedState(), which doesn't work as a design anymore

* introduce spec/datatypes/altair into beacon_chain_db

* fix inefficient codegen for getStateField(largeStateField)

* state_transition_slots() doesn't either need/use blocks or runtime presets

* combine process_slots(HBS)/state_transition_slots(HBS) which differ only in last-slot htr optimization

* getStateField(StateData, ...) was replaced by getStateField(ForkedHashedBeaconState, ...)

* fix rollback

* switch some state_transition(), process_slots, makeTestBlocks(), etc to use ForkedHashedBeaconState

* remove state_transition(phase0.HashedBeaconState)

* remove process_slots(phase0.HashedBeaconState)

* remove state_transition_block(phase0.HashedBeaconState)

* remove unused callWithBS(); separate case expression from if statement

* switch back from nested-ref-object construction to (ref Foo)(Bar())
2021-06-11 20:51:46 +03:00
..
README.md update nim-beacon-chain to nimbus-eth2 in beacon_chain/, ncli/, tests/, and README.md (#1843) 2020-10-08 19:02:05 +00:00
libnfuzz.h [WIP] Fake bls at runtime (#735) 2020-03-05 13:52:10 +01:00
libnfuzz.nim use ForkedHashedBeaconState in StateData (#2634) 2021-06-11 20:51:46 +03:00

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.