History

Mamy Ratsimbazafy 5d7f9c3a04 Consensus object pools [reorg 4/5] (#2374 ) * Add documentation * make test doesn't try to build the beacon node :/		2021-03-04 10:13:44 +01:00
..
.gitignore	rm ncli_signing_root	2019-12-17 00:06:03 +02: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
inspector.nim	Move tools (#2370 )	2021-03-02 15:02:10 +01:00
inspector.nim.cfg	Move tools (#2370 )	2021-03-02 15:02:10 +01:00
logtrace.nim	Move tools (#2370 )	2021-03-02 15:02:10 +01:00
ncli.nim	fix tools/all build (#2010 )	2020-11-13 13:57:48 +01:00
ncli_db.nim	Consensus object pools [reorg 4/5] (#2374 )	2021-03-04 10:13:44 +01:00
ncli_query.nim	12x speedup on state sim with 100k validators sans BLS by caching get_beacon_proposer_index(...)	2020-06-04 17:07:51 +00:00
ncli_slashing.nim	Consolidate modules by areas [part 1] (#2365 )	2021-03-02 11:27:45 +01:00
nim.cfg	minimize imports, specially for spec - cuts 2/3 of ncli build time (#500 )	2019-10-25 12:59:56 +02:00
nimquery.nim	Move tools (#2370 )	2021-03-02 15:02:10 +01:00

README.md

Introduction

ncli is a set of low level / debugging tools to interact with the nimbus beacon chain specification implementation, simliar to zcli. With it, you explore SSZ, make state transitions and compute hash tree roots.

Tools

transition: Perform state transition given a pre-state and a block to apply (both in SSZ format)
hash_tree_root: Print tree root of an SSZ object
pretty: Pretty-print SSZ object as JSON

Building

Follow the instructions from nimbus-eth2

git clone https://github.com/status-im/nimbus-eth2.git
cd nimbus-eth2
make

Usage

# Build with minimal config
../env.sh nim c -d:const_preset=minimal ncli_transition
# Build with mainnet config
../env.sh nim c -d:const_preset=mainnet ncli_transition

# Run..
./ncli_transition --help