Pre-release versions of the RChain software are now available. We plan to launch the full platform in Q4 of 2018.
Note Successfully building from source requires attending to all of the prerequisites shown below. When users experience errors, it is typically related to failure to assure all prerequisites are met. Work is in progress to improve this experience.
- Java Development Kit (JDK), version 8. We recommend using the OpenJDK
- sbt
- Sodium crypto library
- For Rholang
- jflex
- Build BNFC from the following commit or later: BNFC/bnfc@7c9e859. Use the installation command
cabal install bnfc --global.
brew install git
brew install sbt
brew install libsodium
brew install jflex
Download and run the installer of the Haskell Platform
echo "deb https://dl.bintray.com/sbt/debian /" | sudo tee -a /etc/apt/sources.list.d/sbt.list
sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 2EE0EA64E40A89B84B2DF73499E82A75642AC823
sudo apt-get update
sudo apt-get install sbt
sudo apt-get install libsodium23
sudo apt-get install jflex
sudo apt-get install haskell-platform
sudo dnf remove sbt # uninstalling sbt if sbt 0.13 was installed (may not be necessary)
sudo dnf --enablerepo=bintray--sbt-rpm install sbt
sudo dnf install libsodium
sudo dnf install jflex
sudo dnf install haskell-platform
You can use pacaur or other AUR installer instead of trizen.
sudo pacman -S stack ghc # for building BNFC
sudo pacman -S jdk8-openjdk sbt libsodium
trizen -S jflex
Building BNFC with stack
git clone https://github.com/BNFC/bnfc
cd bnfc
stack init
stack install
cd -
export PATH="$HOME/.local/bin:$HOME"
Building some of the subprojects is just a matter of sbt compile, however some (like rholang or crypto) require extra steps to build. See README.md of each subproject for details.
Once you can build each subproject individually, run sbt node/assembly to build an executable. The assembled jar will be available under ./node/target/scala-2.12/rnode-assembly-x.y.z.jar
Example
sbt:rchain> node/assembly
[info] Including: JLex.jar
[info] Including: log4s_2.12-1.4.0.jar
[info] Including: java-cup-11b-runtime.jar
(...)
[info] SHA-1: bd4471642bb340c8b1fc0571fc614902c5bafbb2
[info] Packaging /Users/rabbit/projects/rchain/node/target/scala-2.12/rnode-assembly-0.1.3.jar ...
[info] Done packaging.
[success] Total time: 25 s, completed Mar 26, 2018 3:36:09 PMAssure prerequisites shown above are met.
When working in a single project, scope all sbt commands to that project. The most effective way is to maintain a running sbt instance, invoked from the project root:
$ sbt
[info] Loading settings from plugins.sbt ...
[info] Loading global plugins from /home/kirkwood/.sbt/1.0/plugins
[info] Loading settings from plugins.sbt,protoc.sbt ...
[info] Loading project definition from /home/kirkwood/src/rchain/project
[info] Loading settings from build.sbt ...
[info] Set current project to rchain (in build file:/home/kirkwood/src/rchain/)
[info] sbt server started at local:///home/kirkwood/.sbt/1.0/server/e6a65c30ec6e52272d3a/sock
sbt:rchain> project rspace
[info] Set current project to rspace (in build file:/home/kirkwood/src/rchain/)
sbt:rspace> compile
[... compiling rspace ...]
but single-line commands work, too:
$ sbt "project rspace" clean compile test
or
$ sbt rspace/clean rspace/compile rspace/test
The build is organized into several, mostly autonomous projects. These projects may be built (and used!) on their own, or they may be combined together to form the full node package. The build process in any case is contained in and controlled by a single, top-level build.sbt file. This process is able to produce several different kinds of artifacts, including JAR files (for Scala) and Docker images.
The most up-to-date code is found in the dev branch. This brilliant, cutting-edge source is periodically merged into master, which branch should represent a more stable, tested version.
Befor building the project for the first time you need to generate the rholang parser code:
> sbt clean bnfc:clean bnfc:generate
Please check the prerequistes on your machine if the code generation fails. Then build the whole project with all submodules:
> sbt compile
To publish a docker image to your local repo run:
> sbt node/docker:publishLocal
[... output snipped ...]
[info] Step 8/8 : ENTRYPOINT ["\/bin\/main.sh"]
[info] ---> Running in 2ac7f835192d
[info] Removing intermediate container 2ac7f835192d
[info] ---> 5e79e6d92528
[info] Successfully built 5e79e6d92528
[info] Tagging image 5e79e6d92528 with name: coop.rchain/rnode
[success] Total time: 35 s, completed May 24, 2018 10:19:14 AM
Check the local docker repo:
> docker images
REPOSITORY TAG IMAGE ID CREATED SIZE
coop.rchain/rnode latest 5e79e6d92528 7 minutes ago 143MB
<none> <none> e9b49f497dd7 47 hours ago 143MB
openjdk 8u151-jre-alpine b1bd879ca9b3 4 months ago 82MB
To deploy a tarball run:
> sbt node/universal:packageZipTarball
The tarball can be found in directory node/target/universal/
You will need a virtual machine running the appropriate version of Linux.
- Install VirtualBox
- Install the Linux distribution you need (e.g. Ubuntu)
- Start VirtualBox and create a new virtual machine in the manager
- Boot your virtual machine using the Linux distribution ISO installed in step 2.
- Configure your Linux VM as desired. You may need to install additional tools sucah as g++, g++-multilib, make, git, etc.
For a more convenient experience, you can share a folder on your Mac with the virtual machine. To do this you will need to install the VirtualBox Guest Additions. Unfortunately there are some gotchas with this. You may need to utilize one of these solutions.
The comm subproject contains code for network related operations for RChain.
The rholang subproject contains compiler related code for the Rholang language.
The roscala subproject contains a Scala translation of the Rosette VM.
The rosette subproject contains code for a low level virtual machine for RChain.
The rspace subproject contains code related to the key-value storage of the RChain blockchain.