Feat/229 add mithril support (#232)

* feat: added mithril into the docker file

* foundation for Mithril functionality

* foundations for Mithril

* feat: added mithril to dockerfile

* feat: dockerfile now includes mithril

* feat: added mithril syncing to the eentrypoint.sh

* chore: added controlled stopping of background processes

* chore: added wait for mithril-client to finish downloading before continuing

* feat: added mithril to docker-compose

* fix: fixed slow start of cardano node. Killing it ungracefully leads to a broken starting routine

* fix: artillery test

---------

Co-authored-by: Michiel <michiel.bellengmail.com>

Author: Kammerlo

.env.IntegrationTest

@@ -29,11 +29,18 @@ CARDANO_NODE_PORT=3001
 CARDANO_NODE_SUBMIT_HOST=yaci-cli
 NODE_SUBMIT_API_PORT=8090
 CARDANO_NODE_VERSION=0.0.0
-CARDANO_NODE_SOCKET_DIR=/node
-CARDANO_NODE_SOCKET_PATH=${CARDANO_NODE_SOCKET_DIR}/node.socket
-CARDANO_NODE_DB=/node/db
+CARDANO_NODE_DIR=/node
+CARDANO_NODE_SOCKET_PATH=${CARDANO_NODE_DIR}/node.socket
+CARDANO_NODE_DB=${CARDANO_NODE_DIR}/db
 CARDANO_CONFIG=./config/${NETWORK}
 
+MITHRIL_SYNC=true
+SNAPSHOT_DIGEST=latest
+# if not set standard values will be used
+AGGREGATOR_ENDPOINT=
+# if not set standard values will be used
+GENESIS_VERIFICATION_KEY=
+
 ## Api env
 API_DOCKER_IMAGE_TAG=main
 API_SPRING_PROFILES_ACTIVE=dev

.env.docker-compose

@@ -27,11 +27,19 @@ CARDANO_NODE_PORT=3001
 CARDANO_NODE_VERSION=8.9.3
 CARDANO_NODE_SUBMIT_HOST=cardano-submit-api
 NODE_SUBMIT_API_PORT=8090
-CARDANO_NODE_SOCKET_DIR=/node
-CARDANO_NODE_SOCKET_PATH=${CARDANO_NODE_SOCKET_DIR}/node.socket
-CARDANO_NODE_DB=/node/db
+CARDANO_NODE_DIR=/node
+CARDANO_NODE_SOCKET_PATH=${CARDANO_NODE_DIR}/node.socket
+CARDANO_NODE_DB=${CARDANO_NODE_DIR}/db
 CARDANO_CONFIG=./config/${NETWORK}
 
+## Mithril
+MITHRIL_SYNC=true
+SNAPSHOT_DIGEST=latest
+# if not set standard values will be used
+AGGREGATOR_ENDPOINT=
+# if not set standard values will be used
+GENESIS_VERIFICATION_KEY=
+
 ## Api env
 API_DOCKER_IMAGE_TAG=main
 API_SPRING_PROFILES_ACTIVE=dev

README.md

@@ -55,6 +55,10 @@ Depending on using a snapshot feature or not, this will take X amount of time. Y
 ```bash
     docker exec rosetta tail -f /logs/node.log
 ```
+- Access indexer logs:
+```bash
+    docker exec rosetta tail -f /logs/indexer.log
+```
 - Interactive access to container:
 ```bash
     docker exec -it rosetta bash # direct bash access within the container 

docker-api-indexer.yaml

@@ -28,7 +28,7 @@ services:
       DEVKIT_PORT: ${DEVKIT_PORT}
     volumes:
       - ${CARDANO_CONFIG}:/config
-      - ${CARDANO_NODE_SOCKET_DIR}:${CARDANO_NODE_SOCKET_DIR}
+      - ${CARDANO_NODE_DIR}:${CARDANO_NODE_DIR}
     healthcheck:
       test: [ "CMD-SHELL", "curl --fail http://localhost:${API_PORT}/network/options -H 'Content-Type: application/json' --data '{\"network_identifier\": {\"blockchain\": \"cardano\",\"network\": \"${NETWORK}\"},\"metadata\": {}}' -X POST" ]
       interval: 30s

docker-node.yaml

@@ -1,25 +1,40 @@
 version: '3.8'
 services:
+  mithril:
+    build:
+      context: ./docker/dockerfiles/mithril
+    environment:
+      - NETWORK=${NETWORK}
+      - MITHRIL_SYNC=${MITHRIL_SYNC}
+      - SNAPSHOT_DIGEST=${SNAPSHOT_DIGEST}
+      - AGGREGATOR_ENDPOINT=${AGGREGATOR_ENDPOINT}
+      - GENESIS_VERIFICATION_KEY=${GENESIS_VERIFICATION_KEY}
+    volumes:
+      - ${CARDANO_NODE_DIR}:/node
   cardano-node:
+    build:
+      context: ./docker/dockerfiles/node
     image: ghcr.io/intersectmbo/cardano-node:${CARDANO_NODE_VERSION}
     environment:
       - NETWORK=${NETWORK}
     volumes:
-      - ${CARDANO_NODE_SOCKET_DIR}:${CARDANO_NODE_SOCKET_DIR}
+      - ${CARDANO_NODE_DIR}:/node/
       - ${CARDANO_NODE_DB}:/node/db
       - ${CARDANO_CONFIG}:/config
     ports:
       - ${CARDANO_NODE_PORT}:${CARDANO_NODE_PORT}
-    entrypoint: cardano-node run --database-path /node/db --port ${CARDANO_NODE_PORT} --socket-path ${CARDANO_NODE_SOCKET_PATH} --topology /config/topology.json --config /config/config.json
-
+    entrypoint: cardano-node run --database-path /node/db --port ${CARDANO_NODE_PORT} --socket-path /node/node.socket --topology /config/topology.json --config /config/config.json
+    depends_on:
+      mithril:
+        condition: service_completed_successfully
   cardano-submit-api:
     image: ghcr.io/intersectmbo/cardano-submit-api:${CARDANO_NODE_VERSION}
     environment:
       - NETWORK=${NETWORK}
     depends_on:
       - cardano-node
     volumes:
-      - ${CARDANO_NODE_SOCKET_DIR}:/node-ipc
+      - ${CARDANO_NODE_DIR}:/node-ipc
     ports:
       - ${NODE_SUBMIT_API_PORT}:8090
     restart: on-failure
@@ -29,6 +44,7 @@ services:
         max-size: "200k"
         max-file: "10"
 
+
 networks:
   default:
     name: cardano-rosetta-java-${NETWORK}

docker/.env.dockerfile

@@ -9,6 +9,14 @@ PROTOCOL_MAGIC=764824073
 SYNC=true
 VERIFICATION=true
 
+# Mithril snapshots
+MITHRIL_SYNC=true
+SNAPSHOT_DIGEST=latest
+# if not set standard values will be used
+AGGREGATOR_ENDPOINT=
+# if not set standard values will be used
+GENESIS_VERIFICATION_KEY=
+
 ## Postgres variables
 DB_NAME=rosetta-java
 DB_USER=rosetta_db_admin

docker/Dockerfile

@@ -29,6 +29,24 @@ ARG GHC_VERSION=8.10.7
 RUN bash -c "ghcup install ghc ${GHC_VERSION}"
 RUN bash -c "ghcup set ghc ${GHC_VERSION}"
 
+
+# Mithril setup
+ARG MITHRIL_VERSION=2423.0
+# Install dependencies
+RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | bash -s -- -y \
+    && apt update --fix-missing \
+    && apt install -y --no-install-recommends \
+       build-essential m4 libssl-dev docker jq git cargo \
+    && apt-get clean
+RUN git clone https://github.com/input-output-hk/mithril.git \
+    && cd mithril \
+    && git checkout $MITHRIL_VERSION \
+    && cd mithril-client-cli \
+    && make build \
+    && mkdir -p /root/.local/bin \
+    && cp mithril-client /root/.local/bin/
+
+
 # Cardano node version
 ARG CARDANO_NODE_VERSION=8.9.4
 
@@ -121,6 +139,7 @@ RUN mkdir -p /root/.local/bin \
     && cp -p "$(./scripts/bin-path.sh cardano-cli)" /root/.local/bin/ \
     && cp -p "$(./scripts/bin-path.sh cardano-submit-api)" /root/.local/bin/
 
+    
 # Compile java applications
 FROM ubuntu:22.04 AS java-builder
 
@@ -173,6 +192,7 @@ RUN apt install -y --no-install-recommends openjdk-21-jdk jq bc sudo curl \
 # Copy cardano node
 COPY --from=cardano-builder /usr/local/lib /usr/local/lib
 COPY --from=cardano-builder /root/.local/bin/cardano-* /usr/local/bin/
+COPY --from=cardano-builder /root/.local/bin/mithril-client /usr/local/bin/
 COPY --from=cardano-builder /root/src/cardano-node/cardano-submit-api/config/tx-submit-mainnet-config.yaml /cardano-submit-api-config/cardano-submit-api.yaml
 ENV LD_LIBRARY_PATH=/usr/local/lib:$LD_LIBRARY_PATH
 ENV PATH=/usr/local/lib/:$PATH
@@ -197,5 +217,3 @@ RUN chmod +x /sbin/entrypoint.sh
 EXPOSE 8082
 
 ENTRYPOINT ["/sbin/entrypoint.sh"]
-
-CMD ["tail", "-f", "-n", "+1", "/logs/*.log"]

docker/dockerfiles/mithril/Dockerfile

@@ -0,0 +1,30 @@
+FROM ubuntu:22.04 AS cardano-builder
+
+WORKDIR /root/src
+
+# Mithril setup
+ARG MITHRIL_VERSION=2423.0
+# Install dependencies
+RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | bash -s -- -y \
+    && apt update --fix-missing \
+    && apt install -y --no-install-recommends \
+       build-essential m4 libssl-dev docker jq git cargo ca-certificates wget \
+    && apt-get clean
+RUN git clone https://github.com/input-output-hk/mithril.git \
+    && cd mithril \
+    && git checkout $MITHRIL_VERSION \
+    && cd mithril-client-cli \
+    && make build \
+    && mkdir -p /root/.local/bin \
+    && cp mithril-client /root/.local/bin/
+
+
+FROM ubuntu:22.04 AS mithril-runner
+
+COPY --from=cardano-builder /root/.local/bin/mithril-client /usr/local/bin
+RUN apt update --fix-missing \
+    && apt install -y wget
+COPY entrypoint.sh /sbin/entrypoint.sh
+RUN chmod +x /sbin/entrypoint.sh
+
+CMD ["/sbin/entrypoint.sh"]

docker/dockerfiles/mithril/entrypoint.sh

@@ -0,0 +1,34 @@
+#!/bin/bash
+
+download_mithril_snapshot(){
+    echo "Downloading Mithril Snapshot..."
+    export CARDANO_NETWORK=$NETWORK
+    case $NETWORK in
+    mainnet)
+      AGGREGATOR_ENDPOINT=${AGGREGATOR_ENDPOINT:-https://aggregator.release-mainnet.api.mithril.network/aggregator}
+      GENESIS_VERIFICATION_KEY=${GENESIS_VERIFICATION_KEY:-$(wget -q -O - https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/release-mainnet/genesis.vkey)}
+      ;;
+    preprod)
+      AGGREGATOR_ENDPOINT=${AGGREGATOR_ENDPOINT:-https://aggregator.release-preprod.api.mithril.network/aggregator}
+      GENESIS_VERIFICATION_KEY=${GENESIS_VERIFICATION_KEY:-$(wget -q -O - https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/release-preprod/genesis.vkey)}
+      ;;
+    preview)
+      AGGREGATOR_ENDPOINT=${AGGREGATOR_ENDPOINT:-https://aggregator.pre-release-preview.api.mithril.network/aggregator}
+      GENESIS_VERIFICATION_KEY=${GENESIS_VERIFICATION_KEY:-$(wget -q -O - https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/pre-release-preview/genesis.vkey)}
+      ;;
+    sanchonet)
+      AGGREGATOR_ENDPOINT=${AGGREGATOR_ENDPOINT:-https://aggregator.testing-sanchonet.api.mithril.network/aggregator}
+      GENESIS_VERIFICATION_KEY=${GENESIS_VERIFICATION_KEY:-$(wget -q -O - https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/testing-sanchonet/genesis.vkey)}
+      ;;
+    esac
+    mithril-client cardano-db download latest --download-dir /node &
+    MITHRIL_PID=$!
+    wait $MITHRIL_PID
+    echo "Done downloading Mithril Snapshot"
+}
+echo $NETWORK
+if [ "${MITHRIL_SYNC}" == "true" ]; then
+    download_mithril_snapshot
+fi
+
+exit

docker/dockerfiles/node/Dockerfile

@@ -0,0 +1,125 @@
+FROM ubuntu:22.04 AS cardano-builder
+
+WORKDIR /root/src
+
+# Install dependencies
+RUN apt update --fix-missing \
+    && apt install -y --no-install-recommends \
+        automake build-essential pkg-config libffi-dev libgmp-dev libssl-dev libncurses-dev libsystemd-dev zlib1g-dev make \
+        g++ tmux git jq wget libncursesw5-dev libtool autoconf liblmdb-dev curl ca-certificates \
+    && apt-get clean
+
+
+# Install ghcup
+ENV BOOTSTRAP_HASKELL_NONINTERACTIVE=1
+RUN bash -c "curl --proto '=https' --tlsv1.2 -sSf https://get-ghcup.haskell.org | sh"
+
+ENV PATH=/root/.local/bin:/root/.ghcup/bin:/root/.cabal/bin:${PATH}
+
+# Install cabal
+ARG CABAL_VERSION=3.8.1.0
+
+RUN bash -c "ghcup install cabal ${CABAL_VERSION}"
+RUN bash -c "ghcup set cabal ${CABAL_VERSION}"
+
+# Install GHC
+ARG GHC_VERSION=8.10.7
+
+RUN bash -c "ghcup install ghc ${GHC_VERSION}"
+RUN bash -c "ghcup set ghc ${GHC_VERSION}"
+
+# Cardano node version
+ARG CARDANO_NODE_VERSION=8.9.4
+
+# Install sodium
+RUN export IOHKNIX_VERSION=$(curl https://raw.githubusercontent.com/IntersectMBO/cardano-node/${CARDANO_NODE_VERSION}/flake.lock | jq -r '.nodes.iohkNix.locked.rev') \
+    && echo "iohk-nix version: $IOHKNIX_VERSION" \
+    && export SODIUM_VERSION=$(curl https://raw.githubusercontent.com/input-output-hk/iohk-nix/${IOHKNIX_VERSION}/flake.lock | jq -r '.nodes.sodium.original.rev') \
+    && echo "Using sodium version: $SODIUM_VERSION" \
+    && git clone https://github.com/intersectmbo/libsodium \
+    && cd libsodium \
+    && git checkout ${SODIUM_VERSION} \
+    && ./autogen.sh \
+    && ./configure \
+    && make \
+    && make check \
+    && make install
+
+ENV LD_LIBRARY_PATH=/usr/local/lib:$LD_LIBRARY_PATH
+ENV PKG_CONFIG_PATH=/usr/local/lib/pkgconfig:$PKG_CONFIG_PATH
+
+# Install libsodium
+RUN apt install -y --no-install-recommends libsodium-dev \
+    && apt-get clean
+
+# Install secp256k1
+RUN export IOHKNIX_VERSION=$(curl https://raw.githubusercontent.com/IntersectMBO/cardano-node/${CARDANO_NODE_VERSION}/flake.lock | jq -r '.nodes.iohkNix.locked.rev') \
+    && echo "iohk-nix version: ${IOHKNIX_VERSION}" \
+    && export SECP256K1_VERSION=$(curl https://raw.githubusercontent.com/input-output-hk/iohk-nix/${IOHKNIX_VERSION}/flake.lock | jq -r '.nodes.secp256k1.original.ref') \
+    && echo "Using secp256k1 version:${SECP256K1_VERSION}" \
+    && git clone --depth 1 --branch ${SECP256K1_VERSION} https://github.com/bitcoin-core/secp256k1 \
+    && cd secp256k1 \
+    && ./autogen.sh \
+    && ./configure --enable-module-schnorrsig --enable-experimental \
+    && make \
+    && make check \
+    && make install
+
+# Install blst
+RUN export BLST_VERSION=$(curl https://raw.githubusercontent.com/input-output-hk/iohk-nix/master/flake.lock | jq -r '.nodes.blst.original.ref') \
+    && git clone --depth 1 --branch ${BLST_VERSION} https://github.com/supranational/blst \
+    && cd blst \
+    && ./build.sh \
+    && echo "prefix=/usr/local" >> libblst.pc \
+    && echo "exec_prefix=\${prefix}" >> libblst.pc \
+    && echo "libdir=\${exec_prefix}/lib" >> libblst.pc \
+    && echo "includedir=\${prefix}/include" >> libblst.pc \
+    && echo "" >> libblst.pc \
+    && echo "Name: libblst" >> libblst.pc \
+    && echo "Description: Multilingual BLS12-381 signature library" >> libblst.pc \
+    && echo "URL: https://github.com/supranational/blst" >> libblst.pc \
+    && echo "Version: ${BLST_VERSION#v}" >> libblst.pc \
+    && echo "Cflags: -I\${includedir}" >> libblst.pc \
+    && echo "Libs: -L\${libdir} -lblst" >> libblst.pc \
+    && cp libblst.pc /usr/local/lib/pkgconfig/ \
+    && cp bindings/blst_aux.h bindings/blst.h bindings/blst.hpp  /usr/local/include/ \
+    && cp libblst.a /usr/local/lib \
+    && bash -c "chmod u=rw,go=r /usr/local/{lib/{libblst.a,pkgconfig/libblst.pc},include/{blst.{h,hpp},blst_aux.h}}"
+
+RUN apt install -y --no-install-recommends libsecp256k1-dev \
+    && apt-get clean
+
+# Install node
+RUN git clone https://github.com/intersectmbo/cardano-node.git \
+    && cd cardano-node \
+    && git checkout tags/${CARDANO_NODE_VERSION} \
+    && echo "with-compiler: ghc-${GHC_VERSION}" >> cabal.project.local \
+    && echo "" >> cabal.project.local \
+    && echo "package cardano-crypto-praos" >> cabal.project.local \
+    && echo "  flags: -external-libsodium-vrf" >> cabal.project.local \
+    && echo "" >> cabal.project.local \
+    && echo "package trace-dispatcher" >> cabal.project.local \
+    && echo "  ghc-options: -Wwarn" >> cabal.project.local \
+    && echo "" >> cabal.project.local \
+    && echo "package HsOpenSSL" >> cabal.project.local \
+    && echo "  flags: -homebrew-openssl" >> cabal.project.local \
+    && echo "" >> cabal.project.local \
+    && mkdir -p /usr/local/opt/openssl \
+    && ln -s /opt/homebrew/opt/openssl@3/lib /usr/local/opt/openssl/lib \
+    && ln -s /opt/homebrew/opt/openssl@3/include /usr/local/opt/openssl/include
+
+WORKDIR /root/src/cardano-node
+
+RUN bash -c "cabal update"
+RUN bash -c "cabal build all"
+RUN bash -c "cabal build cardano-cli"
+RUN bash -c "cabal build cardano-submit-api"
+
+RUN mkdir -p /root/.local/bin \
+    && cp -p "$(./scripts/bin-path.sh cardano-node)" /root/.local/bin/ \
+    && cp -p "$(./scripts/bin-path.sh cardano-cli)" /root/.local/bin/ \
+    && cp -p "$(./scripts/bin-path.sh cardano-submit-api)" /root/.local/bin/
+
+
+FROM ubuntu:22.04 AS node-runner
+COPY --from=cardano-builder /root/.local/bin/cardano-* /usr/local/bin/