Reproducible Build

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

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

Build Container

Create a Dockerfile to setup the build environment

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 --recv-keys 1A92D8942171AFA951A857365DECF4415E3B8FA4
RUN gpg --finger 1A92D8942171AFA951A857365DECF4415E3B8FA4
RUN git clone --single-branch --depth 1 --branch PAPYRUS-2.0.1 /code/rskj
WORKDIR /code/rskj
RUN gpg --verify SHA256SUMS.asc
RUN sha256sum --check SHA256SUMS.asc
RUN ./
RUN ./gradlew clean build -x test

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 RSK node.

Run build

To create a reproducible build, run:

sudo docker build -t rskj-papyrus-2.0.1-reproducible .

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.

To obtain SHA-256 checksums, run the following command:

sudo docker run --rm rskj-papyrus-2.0.1-reproducible sha256sum /code/rskj/rskj-core/build/libs/rskj-core-2.0.1-PAPYRUS-all.jar /code/rskj/rskj-core/build/libs/rskj-core-2.0.1-PAPYRUS-sources.jar /code/rskj/rskj-core/build/libs/rskj-core-2.0.1-PAPYRUS.jar /code/rskj/rskj-core/build/libs/rskj-core-2.0.1-PAPYRUS.pom

Check Results

After running the build process, a JAR file will be created in /code/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.

43149abce0a737341a0b063f2016a1e73dae19b8af8f2e54657326ac8eedc8a0  rskj-core/build/libs/rskj-core-2.0.1-PAPYRUS-all.jar
c1bdb9aeff6463906d75874773e2633f006281d41b244e5cbc6b4115d023a7f8  rskj-core/build/libs/rskj-core-2.0.1-PAPYRUS-sources.jar
7833de3cf827fc7c665b4d03fb425afb0d26140dfbade5b70edb4cb6e2694561  rskj-core/build/libs/rskj-core-2.0.1-PAPYRUS.jar
9b915279251248222c56f95fae060f84464f4c89bb9bc32ac2e2594f937f9fa5  rskj-core/build/libs/rskj-core-2.0.1-PAPYRUS.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.