ncli: move to separate folder

This commit is contained in:
Jacek Sieka 2019-09-28 18:23:02 +02:00
parent 66984c44ce
commit 2b20bf9bed
No known key found for this signature in database
GPG Key ID: A1B09461ABB656B8
8 changed files with 38 additions and 2 deletions

View File

@ -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

4
ncli/.gitignore vendored Normal file
View File

@ -0,0 +1,4 @@
ncli_pretty
ncli_signing_root
ncli_hash_tree_root
ncli_transition

31
ncli/README.md Normal file
View File

@ -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
```

1
ncli/nim.cfg Normal file
View File

@ -0,0 +1 @@
hints:off