From 2b20bf9bed6392628bb79a5aece18456af950137 Mon Sep 17 00:00:00 2001 From: Jacek Sieka Date: Sat, 28 Sep 2019 18:23:02 +0200 Subject: [PATCH] ncli: move to separate folder --- Makefile | 4 +-- ncli/.gitignore | 4 +++ ncli/README.md | 31 ++++++++++++++++++++++ {multinet => ncli}/ncli_hash_tree_root.nim | 0 {multinet => ncli}/ncli_pretty.nim | 0 {multinet => ncli}/ncli_signing_root.nim | 0 {multinet => ncli}/ncli_transition.nim | 0 ncli/nim.cfg | 1 + 8 files changed, 38 insertions(+), 2 deletions(-) create mode 100644 ncli/.gitignore create mode 100644 ncli/README.md rename {multinet => ncli}/ncli_hash_tree_root.nim (100%) rename {multinet => ncli}/ncli_pretty.nim (100%) rename {multinet => ncli}/ncli_signing_root.nim (100%) rename {multinet => ncli}/ncli_transition.nim (100%) create mode 100644 ncli/nim.cfg diff --git a/Makefile b/Makefile index 3161b2425..3abfcde86 100644 --- a/Makefile +++ b/Makefile @@ -13,8 +13,8 @@ BUILD_SYSTEM_DIR := vendor/nimbus-build-system # we don't want an error here, so we can handle things later, in the build-system-checks target -include $(BUILD_SYSTEM_DIR)/makefiles/variables.mk -TOOLS := beacon_node bench_bls_sig_agggregation state_sim -TOOLS_DIRS := beacon_chain benchmarks research +TOOLS := beacon_node bench_bls_sig_agggregation state_sim ncli_hash_tree_root ncli_pretty ncli_signing_root ncli_transition +TOOLS_DIRS := beacon_chain benchmarks research ncli TOOLS_CSV := $(subst $(SPACE),$(COMMA),$(TOOLS)) .PHONY: all build-system-checks deps update p2pd test $(TOOLS) clean_eth2_network_simulation_files eth2_network_simulation clean-testnet0 testnet0 clean-testnet1 testnet1 clean diff --git a/ncli/.gitignore b/ncli/.gitignore new file mode 100644 index 000000000..8d344acf2 --- /dev/null +++ b/ncli/.gitignore @@ -0,0 +1,4 @@ +ncli_pretty +ncli_signing_root +ncli_hash_tree_root +ncli_transition diff --git a/ncli/README.md b/ncli/README.md new file mode 100644 index 000000000..68aef8041 --- /dev/null +++ b/ncli/README.md @@ -0,0 +1,31 @@ +# Introduction + +`ncli` is a set of low level / debugging tools to interact with the nimbus [beacon chain specification](https://github.com/ethereum/eth2.0-specs/tree/dev/specs) implementation, simliar to [zcli](https://github.com/protolambda/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) +* signing_root/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](../README.md) + +```bash +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 ncli_transition -d:const_preset=minimal +# Build with mainnet config +../env.sh nim c ncli_transition -d:const_preset=mainnet + +# Run.. +./ncli_transition --help +``` diff --git a/multinet/ncli_hash_tree_root.nim b/ncli/ncli_hash_tree_root.nim similarity index 100% rename from multinet/ncli_hash_tree_root.nim rename to ncli/ncli_hash_tree_root.nim diff --git a/multinet/ncli_pretty.nim b/ncli/ncli_pretty.nim similarity index 100% rename from multinet/ncli_pretty.nim rename to ncli/ncli_pretty.nim diff --git a/multinet/ncli_signing_root.nim b/ncli/ncli_signing_root.nim similarity index 100% rename from multinet/ncli_signing_root.nim rename to ncli/ncli_signing_root.nim diff --git a/multinet/ncli_transition.nim b/ncli/ncli_transition.nim similarity index 100% rename from multinet/ncli_transition.nim rename to ncli/ncli_transition.nim diff --git a/ncli/nim.cfg b/ncli/nim.cfg new file mode 100644 index 000000000..3f78c9e4f --- /dev/null +++ b/ncli/nim.cfg @@ -0,0 +1 @@ +hints:off