Skip to content

setup.md

Latest commit

 

History

History
60 lines (42 loc) · 1.65 KB

setup.md

File metadata and controls

60 lines (42 loc) · 1.65 KB

NCTL setup

Prerequisites

  1. bash shell.
  2. python3 + pip3.
  3. The casper-node repository cloned into YOUR_WORKING_DIRECTORY.
  4. The casper-client-rs repository cloned into YOUR_WORKING_DIRECTORY.
  5. The casper-node-launcher repository cloned into YOUR_WORKING_DIRECTORY.

NOTE

Ensure you are checked out to the correct branch of each of the three repositories above. Generally this will be dev (or your working branch recently forked from dev) for casper-node and casper-client-rs, and main for casper-node-launcher.

To find out which branch of the client and launcher are compatible with the current branch of node, refer to ci.json.

Install prerequisites

# Supervisor - cross-platform process manager.
python3 -m pip install supervisor

# Utilities for config file parsing and generation.
python3 -m pip install toml tomlkit

# Rust toolchain and smart contracts - required by casper-node software.
cd YOUR_WORKING_DIRECTORY/casper-node
make setup-rs

Extend .bashrc file to make NCTL commands available from terminal session

cd YOUR_WORKING_DIRECTORY/casper-node

cat >> $HOME/.bashrc <<- EOM

# ----------------------------------------------------------------------
# CASPER - NCTL
# ----------------------------------------------------------------------

# Activate NCTL shell.
. $(pwd)/utils/nctl/activate

EOM

Refresh bash session

. $HOME/.bashrc

Compile it

nctl-compile