Skip to content

Latest commit

 

History

History
128 lines (80 loc) · 4.1 KB

README.md

File metadata and controls

128 lines (80 loc) · 4.1 KB
Raw

Full Node

Just because you call something a blockchain, that doesn't mean you aren't subject to normal engineering laws.

User guide documentation available here

Master current build status

CI Status Description
CircleCI CircleCI Master and PRs

Install from Binaries

Use the Latest Binaries, available for many operating systems and architectures.

Install from Source

Prerequisites

Get the Rust Compiler (latest stable version is recommended, minimum required: 1.35+)

rustup install stable
rustup default stable
rustc --version # if this fails, try a new command window, or add the path (see below)

Path

  • Win: Add %USERPROFILE%\.cargo\bin to the environment variable PATH.
  • Lin/Mac: Add ${HOME}/.cargo/bin to your PATH.

protobuf

  • The [Protocol Buffers][protobuf] version bundled with crate prost-build will be used.
  • For distribution or container builds in general, it's a good practice to install protoc from the official distribution package if available.

Commands

Check <latest release tag> on https://github.com/input-output-hk/jormungandr/releases/latest

git clone --recurse-submodules https://github.com/input-output-hk/jormungandr
cd jormungandr
git checkout tags/<latest release tag> #replace this with something like v1.2.3
git submodule update
cargo install --path jormungandr # --features systemd # (on linux with systemd)
cargo install --path jcli

This will install 2 tools:

  • jormungandr: the node part of the blockchain;
  • jcli: a command line helper tool to help you use and setup the node;

Configuration Basics

A functional node needs 2 configurations:

  1. Its own node configuration: Where to store data, network configuration, logging.
  2. The blockchain genesis configuration, which contains the initial trusted setup of the blockchain: coin configuration, consensus settings, initial state.

In normal use, the blockchain genesis configuration is given to you or automatically fetched from the network.

Quick-Start - Public Mode

To start a new node from scratch on a given blockchain, you need to know the block0 hash of this blockchain for trust purpose and internet peers to connect to. The simplest way to start such a node is:

jormungandr --block0-hash <HASH> --trusted-peers <IPs>

Quick-Start - Cardano Shelly Testnet

Quick-Start - Private Mode

Follow instructions on installation, then to start a private and minimal test setup:

mkdir mynode
cd mynode
PATH/TO/SOURCE/REPOSITORY/scripts/bootstrap <options>

Use the following recommended bootstrap options:

bootstrap -b        # BFT setup
bootstrap -g -s 2   # Genesis-praos setup
bootstrap -h        # further help

The bootstrap script creates a simple setup with a faucet with 10 millions coins, a BFT leader, and a stake pool.

It also creates 2 shell scripts parametrized to this specific run of bootstrap:

  • faucet-send-money
  • faucet-send-certificate

Both scripts can be used to do simple limited operation through the jcli debugging tools.

Documentation

Documentation is available in the markdown format here

License

This project is licensed under either of the following licenses: