Gradle building

Setup instructions for gradle build in docker container.

This is a deterministic build process used to build RSK node JAR file. It provides a way to be reasonable sure that the JAR is built from GitHub Rskj repository. It also makes sure that the same tested dependencies are used and statically built into the executable.

It's strongly suggested to follow the steps by yourself to avoid any kind of contamination in the process.

Table of Contents

• Install Docker
• Build the environment docker container
• Run Build
• Check Results

Install Docker

Depending on your OS, you can install Docker following the official Docker guide:

• Mac
• Windows
• Ubuntu
• CentOS
• Fedora
• Debian
• Others

Build Container

Create a Dockerfile to setup the build environment

• Linux

  FROM ubuntu:16.04
  RUN apt-get update -y && \
      apt-get install -y git curl gnupg-curl openjdk-8-jdk && \
      rm -rf /var/lib/apt/lists/* && \
      apt-get autoremove -y && \
      apt-get clean
  RUN gpg --keyserver https://secchannel.rsk.co/release.asc --recv-keys 1A92D8942171AFA951A857365DECF4415E3B8FA4
  RUN gpg --finger 1A92D8942171AFA951A857365DECF4415E3B8FA4
  RUN git clone --single-branch --depth 1 --branch FINGERROOT-5.2.0 https://github.com/rsksmart/rskj.git /code/rskj
   RUN git clone https://github.com/rsksmart/reproducible-builds 
  RUN CP /Users/{$USER}/reproducible-builds/rskj/5.2.0-fingerroot/Dockerfile  /Users/{$USER}/code/rskj
  WORKDIR /code/rskj
  RUN gpg --verify SHA256SUMS.asc
  RUN sha256sum --check SHA256SUMS.asc
  RUN ./configure.sh
  RUN ./gradlew clean build -x test

• Mac OSX

  brew update && \
  brew install git gnupg openjdk@8 && \
      rm -rf /var/lib/apt/lists/* && \
      brew autoremove && \
      brew cleanup
  RUN gpg --keyserver https://secchannel.rsk.co/release.asc --recv-keys 1A92D8942171AFA951A857365DECF4415E3B8FA4
  RUN gpg --finger 1A92D8942171AFA951A857365DECF4415E3B8FA4
  RUN git clone --single-branch --depth 1 --branch FINGERROOT-5.2.0 https://github.com/rsksmart/rskj.git ./code/rskj
  RUN git clone https://github.com/rsksmart/reproducible-builds 
  RUN CP /Users/{$USER}/reproducible-builds/rskj/5.2.0-fingerroot/Dockerfile  /Users/{$USER}/code/rskj
  RUN CD /code/rskj
  RUN gpg --verify SHA256SUMS.asc
  RUN sha256sum --check SHA256SUMS.asc
  RUN ./configure.sh
  RUN ./gradlew clean build -x test   

Response:

You should get the following as the final response, after running the above steps:

BUILD SUCCESSFUL in 55s
14 actionable tasks: 13 executed, 1 up-to-date

If you are not familiar with Docker or the Dockerfile format: what this does is use the Ubuntu 16.04 base image and install git, curl, gnupg-curl and openjdk-8-jdk, required for building the RSK node.

Run build

To create a reproducible build, run the command below in the same directory:

$ docker build -t rskj/5.2.0-fingerroot .     

if you run into any problems, ensure you're running the commands on the right folder and also ensure docker daemon is running is updated to the recent version.

This may take several minutes to complete. What is done is:

• Place in the RSKj repository root because we need Gradle and the project.
• Runs the secure chain verification process.
• Compile a reproducible RSKj node.
• ./gradlew clean build -x test builds without running tests.

Verify Build

The last step of the build prints the sha256sum of the files, to obtain SHA-256 checksums, run the following command in the same directory as shown above:

$ docker run --rm rskj/5.2.0-fingerroot sh -c 'sha256sum * | grep -v javadoc.jar'

Check Results

After running the build process, a JAR file will be created in /rskj/rskj-core/build/libs/, into the docker container.

You can check the SHA256 sum of the result file and compare it to the one published by RSK for that version.

70ae5209720ad6477c1c32d8a8d94e29ebb0db25d57e9903546519d614eddf9f  rskj-core-5.2.0-FINGERROOT-all.jar
6ed2bcb287e6b9e61bb99b65307e2e51b4231a92070fed4569443981fc2597ce  rskj-core-5.2.0-FINGERROOT-sources.jar
3b1dd7d624137fb1bcc133927a7357eed3228457e8db29f17cf0a193370bbe12  rskj-core-5.2.0-FINGERROOT.jar
4d588eae64108680c6ae6e895e2d6d4a07cdd05a31718d6f4a34870153a51d5a  rskj-core-5.2.0-FINGERROOT.module
3903f17a97e7dbd55bac0dd02030f5297e364280e2b7a856aaf03b4d327dce3c  rskj-core-5.2.0-FINGERROOT.pom

For SHA256 sum of older versions check the releases page.

If you check inside the JAR file, you will find that the dates of the files are the same as the version commit you are using.

Run RSK Node (Optional)

To start an RSK Node using the Dockerfile, run the command below:

$ docker run -d rskj/5.2.0-fingerroot

Extract JAR from image (Optional)

$ cid=$(docker run -d rskj/5.2.0-fingerroot /bin/true)
$ docker cp "$cid":/home/rsk/ ./libs/
$ docker rm "$cid"

More Resources

• See Reproducible builds
• Check out the latest rskj releases