Skip to content

Latest commit

 

History

History
355 lines (272 loc) · 10.7 KB

README.md

File metadata and controls

355 lines (272 loc) · 10.7 KB
Raw

GitHub top language Rust Minimum rustc version

Yes! This is the right weapon for you 'ETH Grandmaster' !!

NBnet

The nb kit is a powerful presence for creating and managing custom ETH2 networks.

It has two modes.

Mode dev is designed to create and manage local clusters running on a single host. It does not require complex configuration, and is an excellent tool for deploying and managing devnets, very suitable for rapid development.

Mode ddev is designed to manage distributed multi-machine clusters, and can be used to deploy formal testnet or even mainnet. Its convenient and powerful functions do not even require DevOps to participate in, the develop team can manage the network well by themselves relying on the nb kit.

General intro:

  • You can deploy as many networks as needed
    • Each network can easily extend to hundreds of nodes
  • You can flexibly add or kick out nodes
  • You can flexibly start and stop nodes
    • Specify explicit IDs or filter by client type
  • Many other practical functions...

== Quick Start ==

NOTE: all demos below are based on the Linux OS.

Prepare Binaries

Use make bin_all to build the necessary binaries:

  • geth
  • reth
  • lighthouse
  • nb

If you do not want to spend the compiling time, feel free to use your own binaries:

  • Downloading them from the offical sites of these projects
  • Or use your own pre-compiled binaries

For the nb binary, download the statically compiled(linked) package from this link, and put it in your $PATH.

If you want to compile a nb binary from source, use make install. It will be located at ~/.cargo/bin/, so you should make sure that this directory is under your $PATH. We assume you have already been familiar with the configuration of the rust development environment, so we won't introduce this aspect.

Command Line Usage

# nb -h
Usage: nb <COMMAND>

Commands:
  dev                       Manage development clusters on a local host
  ddev                      Manage development clusters on various distributed hosts
  deposit                   Manage deposit operations
  validator-exit            Exit an existing validator from the beacon chain
  new-mnemonic              Create a 24-words bip39 mnemonic
  gen-zsh-completions, -z   Generate the cmdline completion script for zsh
  gen-bash-completions, -b  Generate the cmdline completion script for bash
  help                      Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

For more detailed information, you can get it through the nb <SUBCOMMAND> -h.

For example:

# nb ddev show -h
Default operation, show the information of an existing ENV

Usage: nb ddev show [OPTIONS]

Options:
  -e, --env-name <ENV_NAME>
  -c, --clean-up             Clean up expired data before showing
  -w, --write-back           Whether to write back after a `clean up`

Shell Completion

Before any real nb operation, let's config the shell completion to improve command line efficiency.

For zsh:

mkdir -p ~/.cargo/bin
nb -z > ~/.cargo/bin/zsh_nb.completion
echo -e "\n source ~/.cargo/bin/zsh_nb.completion" >> ~/.zshrc
source ~/.zshrc

For bash:

mkdir -p ~/.cargo/bin
nb -b > ~/.cargo/bin/bash_nb.completion
echo -e "\n source ~/.cargo/bin/bash_nb.completion" >> ~/.bashrc
source ~/.bashrc

A simple workflow

For nb dev:

  1. nb dev create: create a new ENV
    • 4 nodes, the first one own all the initial validators
    • the el client is geth
    • the cl client is lighthouse
  2. nb dev show: show the information of the ENV
  3. nb dev stop -N all: stop all nodes of the ENV
  4. nb dev start: restart all nodes of the ENV
  5. nb dev push-node: add a new node to the ENV
  6. nb dev kick-node: remove a node from the ENV
    • the first node can never be removed
  7. nb dev destroy: destroy the entire ENV

For nb ddev:

  1. Declare the remote hosts
    • export NB_DDEV_HOSTS="10.0.0.2#bob,10.0.0.3#bob"
    • This means: you can log in to these two hosts through ssh protocol with username bob without password
  2. nb ddev create: create a new ENV
    • 4 nodes, the first one own all the initial validators
    • the el client is geth
    • the cl client is lighthouse
  3. nb ddev show: show the information of the ENV
  4. nb ddev stop -N all: stop all nodes of the ENV
  5. nb ddev start: restart all nodes of the ENV
  6. nb ddev push-node: add a new node to the ENV
  7. nb ddev kick-node: remove a node from the ENV
    • the first node can never be removed
  8. nb ddev destroy: destroy the entire ENV

== More Detailed Tutorials ==

== ENV VARs ==

  • $NB_DDEV_HOSTS_JSON
    • Specify hosts infomations in the json file path style
    • Check the help info for details
  • $NB_DDEV_HOSTS
    • Specify hosts infomations in the custom expressions style
    • Check the help info for details
    • The priority is lower than $NB_DDEV_HOSTS_JSON
  • $RUNTIME_CHAIN_DEV_BASE_DIR
    • All runtime data will be mgmt under the path declared by this VAR
    • Default: /tmp/__CHAIN_DEV__
  • $CHAIN_DEV_EGG_REPO
  • $RUC_SSH_TIMEOUT
    • ssh connection timeout, default to 20s
    • 300s at most, any value larger than this will be truncated
    • Probably only useful if you want to transfer large files to or from hosts

== Clients Support ==

  • CL clients:
    • lighthouse
    • prysm, not implemented yet, but in the plan
  • EL clients:
    • geth
    • reth, limited support

== Known Issues ==

Reth related:

  • reth can not be used as the genesis node
    • It will hang at the next restarting
  • reth's fullnode mode is unstable in practice
    • This mode is currently banned in nb
  • reth will fail to restart without a finalized block
    • That is, reth nodes should be added after the first finalized block

Q&A

0. What systems can it run on?

Linux and macOS, Linux is more recommended.

1. How to set a custom chain id?
export CHAIN_ID="1234"
nb dev create
# nb ddev create
2. How to set a custom block time?

Method 1:

BLOCK_TIME=2 # 2 seconds
nb dev create -t $BLOCK_TIME
# nb ddev create -t $BLOCK_TIME

Method 2:

export SLOT_DURATION_IN_SECONDS="2"
nb dev create
# nb ddev create

'Method 1' has higher priority.

3. How to set multiple genesis parameters at the same time?
echo 'export SLOT_DURATION_IN_SECONDS="2"' > custom.env
echo 'export CHAIN_ID="1234"' >> custom.env

# Many other VAR declarations ...

nb dev create -g custom.env
# nb ddev create -g custom.env

For all VARs that can be declared, please check the defaults.env file.

The are two ready-made examples:

4. Too slow when nb dev/ddev create

This is most likely a network problem.

During the nb dev/ddev create process, we need to clone the EGG repository from GitHub. If you live in a restricted country, such as North Korea, you can use a mirror source from your own country or a friendly country.

For example:

# Use mirror repo
export CHAIN_DEV_EGG_REPO="https://gitlab.com/YOUR_NAME/EGG"

# Or a more efficient approach
git clone https://gitlab.com/YOUR_NAME/EGG
export CHAIN_DEV_EGG_REPO="/PATH/TO/THE/LOCAL/EGG"

If you want to further shorten the startup time, you can build the EGG manually and assign it to nb. It should be noted that this method will cause all the custom settings of genesis from the command line to become invalid. All your customizations need to be configured directly in the EGG.

For example:

cd EGG
make build
nb dev create -G "data/genesis.tar.gz+data/vcdata.tar.gz"
# nb ddev create -G "data/genesis.tar.gz+data/vcdata.tar.gz"
5. I don't want to store nb data under /tmp, what should I do?

There are two recommended methods.

Assume your target path is declared by $P.

Method 1:

mkdir -p $P

# `dev` and `ddev` are both mgmt under this path
export RUNTIME_CHAIN_DEV_BASE_DIR="$P"

Method 2:

The make ddev_docker_runtime may be a better choice for ddev, check here for more infomation.

mkdir -p $P
ln -svf $P /tmp/__CHAIN_DEV__

# Needed by `ddev` only!
nb ddev host-exec -c "mkdir -p $P && ln -svf $P /tmp/__CHAIN_DEV__"
6. How to check the host information separately?
nb ddev show-hosts --json

# OR

nb ddev | jq '.meta.remote_hosts'
7. How to troubleshoot failed nodes?

Try the nb ddev debug-failed-nodes command, it will show all failed nodes.

Sample outputs in dev:

[
  352,
  364,
  392,
  400
]

Sample outputs in ddev:

{
  "10.0.0.2": [
    383,
    387
  ],
  "10.0.0.3": [
    352,
    364,
    392,
    400
  ]
}
8. Issues like "Address/Port already in use...", etc.

When a large number of nodes are deployed on one or a small number of physical machines, there may be conflicts between nb allocated ports and ports dynamically binded by other processes.

The following commands can migigate this problem:

nb dev start -I
# nb ddev start -I

If some nodes always fail, try this:

# run it a few more times and it will finally clean up all failed nodes
# NOTE: the `-R` option will cause the failed node ports to be reallocated!
nb dev start -I -R
# nb ddev start -I -R
9. How to sync from the genesis instead of a checkpoint?
export NBNET_NODE_SYNC_FROM_GENESIS=1
nb dev push-nodes
# nb ddev push-nodes