nimbus-eth2/ncli
Jacek Sieka c74ba5c0c6
ssz: move ref support outside (#943)
* ssz: move ref support outside

Instead of allocating ref's inside SSZ, move it to separate helper:

* makes `ref` allocations explicit
* less magic inside SSZ
* `ref` in nim generally means reference whereas SSZ was loading as
value - if a type indeed used references it would get copies instead of
references to a single value on roundtrip which is unexpected

TODO: EF tests would benefit from some refactoring since they all do the
same thing practically..

Co-authored-by: Zahary Karadjov <zahary@gmail.com>
2020-04-29 22:12:07 +02:00
..
.gitignore rm ncli_signing_root 2019-12-17 00:06:03 +02:00
README.md rm ncli_signing_root 2019-12-17 00:06:03 +02:00
ncli_hash_tree_root.nim ssz: move ref support outside (#943) 2020-04-29 22:12:07 +02:00
ncli_pretty.nim ssz: move ref support outside (#943) 2020-04-29 22:12:07 +02:00
ncli_transition.nim ssz: move ref support outside (#943) 2020-04-29 22:12:07 +02:00
nim.cfg minimize imports, specially for spec - cuts 2/3 of ncli build time (#500) 2019-10-25 12:59:56 +02: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 nim-beacon-chain

git clone https://github.com/status-im/nim-beacon-chain.git
cd nim-beacon-chain
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