nix

RChain project setup/build using nix

This document describes developer setup and build commands for RChain project using nix package manager to install additional tools.

Note: default.nix file in this directory is not part of this document.

Java 11

sudo update-alternatives --config java

# If necessary install Java 11 version
sudo apt install default-jdk

Nix

Install Nix https://nixos.org/download.html

curl -L https://nixos.org/nix/install | sh

Test nix installation

# Install example Hello World program
nix-env -i hello

# Execute hello program
hello
# Hello, world!

# Unistall Hello World program
nix-env -e hello

sbt

Install Scala build tool sbt

sudo apt install sbt

BNFC

Install jflex and bnfc with nix

# Install BNFC and jflex with nix
# - jflex v1.7.0 with ghc 8.6.5
nix-env -i jflex -iA haskellPackages.BNFC --file https://github.com/NixOS/nixpkgs-channels/archive/nixos-20.03.tar.gz

# Uninstall
nix-env -e jflex BNFC

# Install in case of error (Ubuntu)
sudo apt-get install libgmp3-dev

RNode build

# Compile
sbt compile

# Compile with tests
sbt test:compile

# Compile and create local executable
# path: rchain/node/target/universal/stage/bin/rnode
sbt stage

# Compile Docker image
sbt docker:publishLocal

# Clean project (except bnfc generated Java code)
sbt clean

Default memory limits may not be sufficient so additional options for sbt can be specified. They can be added to .bashrc file.

Increase heap memory and thread stack size. Disable supershell if empty lines are printed in sbt output.

export SBT_OPTS="-Xmx4g -Xss2m -Dsbt.supershell=false"

sbt interactive mode

# Enter sbt interactive mode
sbt

# sbt entering interactive mode
# sbt:rchain>

# Compile
compile

# Compile with tests
test:compile

# Compile and create local executable
# path: ./node/target/universal/stage/bin/rnode
stage

# Compile Docker image
docker:publishLocal

# Clean project (except bnfc generated Java code)
clean

Reset Git repository to a clean state

WARNING: this will remove all non-versioned files from your local repository folder

git clean -fdx