Skip to content
DOCUMENTATION

Build from Source

What You’ll Need

  • A Linux Operating System: This guide is tailored for Linux users. If you’re using another operating system, you might run into issues.
  • An Internet Connection: Ensure you can download files and communicate to other nodes on the target device.
  • Firewall Access: Dusk’s networking protocol, Kadcast, uses UDP to communicate among nodes. If you want your node to connect to an external network, ensure that your firewall and router’s UDP ports are forwarded correctly. The default configuration targets port 9000.
  • Software Prerequisites: You’ll need the following software installed to follow this guide: curl, zip, libssl-dev, rustc, clang, gcc and git.

Step-by-Step Instructions

1. Setting up the Environment

1.1 Install the Rust Programming Language

The majority of Dusk software is written in Rust. To compile our code, we will first need to make sure it’s installed.

Open a terminal and run the following command to see if Rust is available:

Terminal window
rustc --version

If this returns a command not found error, we’ll need to install and activate Rust.

Run the following command to download and install Rust:

Terminal window
# Download and install
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs/ | sh


# Activate rust
source $HOME/.cargo/env

1.2 Install Clang

Clang is necessary to compile the internal database of the node, RocksDB.

  • For Ubuntu/Debian:
Terminal window
sudo apt-get install clang
  • For Arch:
Terminal window
sudo pacman -S clang
  • For CentOS/RHEL:
Terminal window
sudo yum install clang

1.3 Install git

Git is a version control system. We will use it to download the Node code.

  • For Ubuntu/Debian:
Terminal window
sudo apt-get install git
  • For Arch:
Terminal window
sudo pacman -S git
  • For CentOS/RHEL:
Terminal window
sudo yum install git

2. Compiling the Dusk node

2.1 Download the Node Software

Clone the Rusk repository:

Terminal window
git clone https://github.com/dusk-network/rusk.git
cd rusk

Build the node:

Terminal window
# Generate the keys used by the circuits
make keys


# Compile all the genesis contracts
make wasm


# Build the node
cargo b --release -p rusk

2.2 Run a single-node cluster with example’s data

Create a new directory and copy the example consensus keys to it. In a production environment, you would put your own consensus keys here.

Terminal window
mkdir -p ~/.dusk/rusk
cp examples/consensus.keys ~/.dusk/rusk/consensus.keys

Create the Genesis state according to your local examples/genesis.toml. See the examples.toml for configuration options you can set in terms of stakes and balances on network initialization.

Run ephemeral node
Terminal window
# Generate genesis state
cargo r --release -p rusk -- recovery-state --init examples/genesis.toml -o /tmp/example.state


# Launch a local ephemeral node
DUSK_CONSENSUS_KEYS_PASS=password cargo r --release -p rusk -- -s /tmp/example.state -c rusk/default.config.toml
Run persistent node

Delete any leftover in state/chain

Terminal window
# Delete old state
rm -rf ~/.dusk/rusk/state
# Delete old chain
rm -rf ~/.dusk/rusk/chain.db
Terminal window
# Generate genesis state
cargo r --release -p rusk -- recovery-state --init examples/genesis.toml


# Launch a local pnode
DUSK_CONSENSUS_KEYS_PASS=password cargo r --release -p rusk -- -c rusk/default.config.toml

Note that the password used here is connected to the example consensus keys, which are also defined in the examples/genesis.toml.

Troubleshooting Tips

  • Installation Issues: Ensure your operating system is up-to-date, you have adequate permissions and all the necessary prerequisite software is installed.
  • Network Errors: Check your internet connection and verify UDP ports are open if connecting to an external network.