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 https://secchannel.rsk.co/release.asc --recv-keys 1A92D8942171AFA951A857365DECF4415E3B8FA4
RUN gpg --finger 1A92D8942171AFA951A857365DECF4415E3B8FA4
RUN git clone --single-branch --depth 1 --branch WASABI-1.3.0 https://github.com/rsksmart/rskj.git /code/rskj
WORKDIR /code/rskj
RUN gpg --verify SHA256SUMS.asc
RUN sha256sum --check SHA256SUMS.asc
RUN ./configure.sh
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-wasabi-1.3.0-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-wasabi-1.3.0-reproducible sha256sum /code/rskj/rskj-core/build/libs/rskj-core-1.3.0-WASABI-all.jar /code/rskj/rskj-core/build/libs/rskj-core-1.3.0-WASABI-sources.jar /code/rskj/rskj-core/build/libs/rskj-core-1.3.0-WASABI.jar /code/rskj/rskj-core/build/libs/rskj-core-1.3.0-WASABI.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.

1343a100363d78db8c6563ec0778646b17af7fdaf7de2ac5932537582c079ddd  rskj-core/build/libs/rskj-core-1.3.0-WASABI-all.jar
5ab02adee2c610d923432704e72601066e78b2d78b9d55a0f4ce2757ab8a1e3f  rskj-core/build/libs/rskj-core-1.2.0-WASABI-sources.jar
c34c2dbcf2aee1f51b1a0850fa406dece3427b051acf11f2a2ef4d69840278ba  rskj-core/build/libs/rskj-core-1.3.0-WASABI.jar
60f87f549f72532cabe8f1583c55006636b99ef29ef6bd1ff4e71b907bffe140  rskj-core/build/libs/rskj-core-1.3.0-WASABI.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.