Add Plugeth stack (#14)

Adds definitions for Plugeth stack and `ipld-eth-db`.

Uses cerc-io/stack-orchestrator#851 in tests.

Reviewed-on: #14

.gitea/workflows/test-fixturenet-plugeth.yml

@@ -0,0 +1,35 @@
+name: Test Ethereum Plugeth Fixturenet Stack
+
+on:
+  push:
+    branches: '*'
+  schedule: # Note: coordinate with other tests to not overload runners at the same time of day
+    - cron: '14 01 * * *'
+
+jobs:
+  test:
+    name: "Test fixturenet-plugeth stack"
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Clone project repository"
+        uses: actions/checkout@v3
+      # At present the stock setup-python action fails on Linux/aarch64
+      # Conditional steps below workaroud this by using deadsnakes for that case only
+      - name: "Install Python for ARM on Linux"
+        if: ${{ runner.arch == 'arm64' && runner.os == 'Linux' }}
+        uses: deadsnakes/action@v3.0.1
+        with:
+          python-version: '3.11'
+      - name: "Install Python cases other than ARM on Linux"
+        if: ${{ ! (runner.arch == 'arm64' && runner.os == 'Linux') }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+      - name: "Print Python version"
+        run: python3 --version
+      - name: "Install stack orchestrator"
+        run: ./scripts/install-so.sh
+      - name: "Run stack tests"
+        run: |
+         PATH=$PATH:~/bin
+         ./tests/fixturenet-plugeth-stack/run-test.sh

stack-orchestrator/compose/docker-compose-fixturenet-eth.yml

@@ -1,5 +1,3 @@
-version: '3.7'
-
 services:
   fixturenet-eth-bootnode-geth:
     restart: always

stack-orchestrator/compose/docker-compose-fixturenet-plugeth.yml

@@ -0,0 +1,133 @@
+services:
+  fixturenet-eth-bootnode-geth:
+    restart: always
+    hostname: fixturenet-eth-bootnode-geth
+    env_file:
+      - ../config/fixturenet-eth/fixturenet-eth.env
+    environment:
+      RUN_BOOTNODE: "true"
+      CERC_SCRIPT_DEBUG: ${CERC_SCRIPT_DEBUG}
+    image: cerc/fixturenet-plugeth-plugeth:local
+    volumes:
+      - fixturenet_plugeth_bootnode_geth_data:/root/ethdata
+    ports:
+      - "9898"
+      - "30303"
+
+  fixturenet-eth-geth-1:
+    restart: always
+    hostname: fixturenet-eth-geth-1
+    cap_add:
+      - SYS_PTRACE
+    environment:
+      CERC_REMOTE_DEBUG: ${CERC_REMOTE_DEBUG:-true}
+      CERC_RUN_STATEDIFF: ${CERC_RUN_STATEDIFF:-detect}
+      CERC_STATEDIFF_DB_NODE_ID: 1
+      CERC_SCRIPT_DEBUG: ${CERC_SCRIPT_DEBUG}
+      CERC_ALLOW_UNPROTECTED_TXS: ${CERC_ALLOW_UNPROTECTED_TXS:-false}
+    env_file:
+      - ../config/fixturenet-eth/fixturenet-eth.env
+      - ../config/fixturenet-eth/statediff.env
+    image: cerc/fixturenet-plugeth-plugeth:local
+    volumes:
+      - fixturenet_plugeth_geth_1_data:/root/ethdata
+    healthcheck:
+      test: ["CMD", "wget", "--tries=1", "--connect-timeout=1", "--quiet", "-O", "-", "http://localhost:8545/"]
+      interval: 30s
+      timeout: 10s
+      retries: 10
+      start_period: 3s
+    depends_on:
+      - fixturenet-eth-bootnode-geth
+    ports:
+      - "8545"
+      - "8546"
+      - "40000"
+      - "6060"
+
+  fixturenet-eth-geth-2:
+    restart: always
+    hostname: fixturenet-eth-geth-2
+    healthcheck:
+      test: ["CMD", "wget", "--tries=1", "--connect-timeout=1", "--quiet", "-O", "-", "http://localhost:8545/"]
+      interval: 30s
+      timeout: 10s
+      retries: 10
+      start_period: 3s
+    environment:
+      CERC_KEEP_RUNNING_AFTER_GETH_EXIT: "true"
+    env_file:
+      - ../config/fixturenet-eth/fixturenet-eth.env
+    image: cerc/fixturenet-plugeth-plugeth:local
+    depends_on:
+      - fixturenet-eth-bootnode-geth
+    volumes:
+      - fixturenet_plugeth_geth_2_data:/root/ethdata
+    ports:
+      - "8545"
+      - "8546"
+
+  fixturenet-eth-bootnode-lighthouse:
+    restart: always
+    hostname: fixturenet-eth-bootnode-lighthouse
+    environment:
+      RUN_BOOTNODE: "true"
+    image: cerc/fixturenet-eth-lighthouse:local
+
+  fixturenet-eth-lighthouse-1:
+    restart: always
+    hostname: fixturenet-eth-lighthouse-1
+    healthcheck:
+      test: ["CMD", "wget", "--tries=1", "--connect-timeout=1", "--quiet", "-O", "-", "http://localhost:8001/eth/v2/beacon/blocks/head"]
+      interval: 30s
+      timeout: 10s
+      retries: 10
+      start_period: 30s
+    env_file:
+      - ../config/fixturenet-eth/fixturenet-eth.env
+    environment:
+      NODE_NUMBER: "1"
+      ETH1_ENDPOINT: "http://fixturenet-eth-geth-1:8545"
+      EXECUTION_ENDPOINT: "http://fixturenet-eth-geth-1:8551"
+    image: cerc/fixturenet-eth-lighthouse:local
+    volumes:
+      - fixturenet_plugeth_lighthouse_1_data:/opt/testnet/build/cl
+    depends_on:
+      fixturenet-eth-bootnode-lighthouse:
+        condition: service_started
+      fixturenet-eth-geth-1:
+        condition: service_healthy
+    ports:
+      - "8001"
+
+  fixturenet-eth-lighthouse-2:
+    restart: always
+    hostname: fixturenet-eth-lighthouse-2
+    healthcheck:
+      test: ["CMD", "wget", "--tries=1", "--connect-timeout=1", "--quiet", "-O", "-", "http://localhost:8001/eth/v2/beacon/blocks/head"]
+      interval: 30s
+      timeout: 10s
+      retries: 10
+      start_period: 30s
+    env_file:
+      - ../config/fixturenet-eth/fixturenet-eth.env
+    environment:
+      NODE_NUMBER: "2"
+      ETH1_ENDPOINT: "http://fixturenet-eth-geth-2:8545"
+      EXECUTION_ENDPOINT: "http://fixturenet-eth-geth-2:8551"
+      LIGHTHOUSE_GENESIS_STATE_URL: "http://fixturenet-eth-lighthouse-1:8001/eth/v2/debug/beacon/states/0"
+    image: cerc/fixturenet-eth-lighthouse:local
+    volumes:
+      - fixturenet_plugeth_lighthouse_2_data:/opt/testnet/build/cl
+    depends_on:
+      fixturenet-eth-bootnode-lighthouse:
+        condition: service_started
+      fixturenet-eth-geth-2:
+        condition: service_healthy
+
+volumes:
+  fixturenet_plugeth_bootnode_geth_data:
+  fixturenet_plugeth_geth_1_data:
+  fixturenet_plugeth_geth_2_data:
+  fixturenet_plugeth_lighthouse_1_data:
+  fixturenet_plugeth_lighthouse_2_data:

stack-orchestrator/compose/docker-compose-ipld-eth-db.yml

@@ -0,0 +1,29 @@
+services:
+  migrations:
+    restart: on-failure
+    depends_on:
+      ipld-eth-db:
+        condition: service_healthy
+    image: cerc/ipld-eth-db:local
+    environment:
+      DATABASE_USER: "vdbm"
+      DATABASE_NAME: "cerc_testing"
+      DATABASE_PASSWORD: "password"
+      DATABASE_HOSTNAME: "ipld-eth-db"
+      DATABASE_PORT: 5432
+
+  ipld-eth-db:
+    image: timescale/timescaledb:2.8.1-pg14
+    restart: always
+    environment:
+      POSTGRES_USER: "vdbm"
+      POSTGRES_DB: "cerc_testing"
+      POSTGRES_PASSWORD: "password"
+    healthcheck:
+      test: ["CMD", "nc", "-v", "localhost", "5432"]
+      interval: 30s
+      timeout: 10s
+      retries: 10
+      start_period: 3s
+    ports:
+      - "127.0.0.1:8077:5432"

stack-orchestrator/config/fixturenet-eth/statediff.env

@@ -0,0 +1,9 @@
+# DB connection settings for statediffing (see docker-compose-db.yml)
+CERC_STATEDIFF_DB_HOST="ipld-eth-db"
+CERC_STATEDIFF_DB_PORT=5432
+CERC_STATEDIFF_DB_NAME="cerc_testing"
+CERC_STATEDIFF_DB_USER="vdbm"
+CERC_STATEDIFF_DB_PASSWORD="password"
+CERC_STATEDIFF_DB_GOOSE_MIN_VER=${CERC_STATEDIFF_DB_GOOSE_MIN_VER:-21}
+CERC_STATEDIFF_DB_LOG_STATEMENTS="${CERC_STATEDIFF_DB_LOG_STATEMENTS:-false}"
+CERC_STATEDIFF_WORKERS=2

stack-orchestrator/container-build/cerc-fixturenet-eth-genesis-postmerge/Dockerfile

@@ -1,23 +1,15 @@
 FROM ethpandaops/ethereum-genesis-generator:3.0.0 AS ethgen
 
-FROM golang:1.20-alpine as builder
-
-RUN apk add --no-cache python3 py3-pip make bash envsubst jq
-
-# Install ethereum-genesis-generator tools
-COPY --from=ethgen /apps /apps
-RUN cd /apps/el-gen && pip3 install --break-system-packages -r requirements.txt
-RUN pip3 install --break-system-packages --upgrade "web3==v6.15.1"
-RUN pip3 install --break-system-packages --upgrade "typing-extensions"
-
-# Install tool to generate initial block
-RUN go install github.com/cerc-io/eth-dump-genblock@b29516740fc01cf1d1d623acbfd0e9a2b6440a96
-
 # Build genesis config
-COPY genesis /opt/genesis
+ADD genesis /opt/genesis
 RUN cd /opt/genesis && make genesis-el
 
+FROM golang:1.21-alpine as builder
+
+COPY --from=ethgen /opt/genesis /opt/genesis
+
 # Snag the genesis block info.
+RUN CGO_ENABLED=0 go install github.com/cerc-io/eth-dump-genblock@v0.2.0
 RUN eth-dump-genblock /opt/genesis/build/el/geth.json > /opt/genesis/build/el/genesis_block.json
 
 FROM alpine:latest

stack-orchestrator/container-build/cerc-fixturenet-eth-genesis-postmerge/genesis/Makefile

@@ -6,7 +6,7 @@ genesis: genesis-el
 
 .PHONY: genesis-el
 genesis-el:
-	cd el; ./build_el.sh
+	cd el && . /apps/el-gen/.venv/bin/activate && ./build_el.sh
 
 .PHONY: clean
 clean:

stack-orchestrator/container-build/cerc-fixturenet-eth-geth/run-el.sh

@@ -50,6 +50,58 @@ else
 
     echo -n "$JWT" > /opt/testnet/build/el/jwtsecret
 
+    if [ "$CERC_RUN_STATEDIFF" == "detect" ] && [ -n "$CERC_STATEDIFF_DB_HOST" ]; then
+      dig_result=$(dig $CERC_STATEDIFF_DB_HOST +short)
+      dig_status_code=$?
+      if [[ $dig_status_code = 0 && -n $dig_result ]]; then
+        echo "Statediff DB at $CERC_STATEDIFF_DB_HOST"
+        CERC_RUN_STATEDIFF="true"
+      else
+        echo "No statediff DB available."
+        CERC_RUN_STATEDIFF="false"
+      fi
+    fi
+
+    STATEDIFF_OPTS=""
+    if [ "$CERC_RUN_STATEDIFF" == "true" ]; then
+      ready=0
+      echo "Waiting for statediff DB..."
+      while [ $ready -eq 0 ]; do
+        sleep 1
+        export PGPASSWORD="$CERC_STATEDIFF_DB_PASSWORD"
+        result=$(psql -h "$CERC_STATEDIFF_DB_HOST" \
+          -p "$CERC_STATEDIFF_DB_PORT" \
+          -U "$CERC_STATEDIFF_DB_USER" \
+          -d "$CERC_STATEDIFF_DB_NAME" \
+          -t -c 'select max(version_id) from goose_db_version;' 2>/dev/null | awk '{ print $1 }')
+        if [ -n "$result" ]; then
+          echo "DB ready."
+          if [ $result -ge $CERC_STATEDIFF_DB_GOOSE_MIN_VER ]; then
+            ready=1
+          else
+            echo "DB not at required version (want $CERC_STATEDIFF_DB_GOOSE_MIN_VER, have $result)"
+          fi
+        fi
+      done
+      STATEDIFF_OPTS="--statediff \
+      --statediff.db.host=$CERC_STATEDIFF_DB_HOST \
+      --statediff.db.name=$CERC_STATEDIFF_DB_NAME \
+      --statediff.db.nodeid=$CERC_STATEDIFF_DB_NODE_ID \
+      --statediff.db.password=$CERC_STATEDIFF_DB_PASSWORD \
+      --statediff.db.port=$CERC_STATEDIFF_DB_PORT \
+      --statediff.db.user=$CERC_STATEDIFF_DB_USER \
+      --statediff.db.logstatements=${CERC_STATEDIFF_DB_LOG_STATEMENTS:-false} \
+      --statediff.db.copyfrom=${CERC_STATEDIFF_DB_COPY_FROM:-true} \
+      --statediff.waitforsync=true \
+      --statediff.workers=${CERC_STATEDIFF_WORKERS:-1} \
+      --statediff.writing=true"
+
+      if [ -d "${CERC_PLUGINS_DIR}" ]; then
+        # With plugeth, we separate the statediff options by prefixing with ' -- '
+        STATEDIFF_OPTS="--pluginsdir "${CERC_PLUGINS_DIR}" -- ${STATEDIFF_OPTS}"
+      fi
+    fi
+
     OTHER_OPTS=""
     if [ "$CERC_ALLOW_UNPROTECTED_TXS" == "true" ]; then
       # Allow for unprotected (non EIP155) txs to be submitted via RPC
@@ -87,6 +139,7 @@ else
       --log.vmodule="${CERC_GETH_VMODULE}" \
       --miner.etherbase="${ETHERBASE}" \
       ${OTHER_OPTS} \
+      ${STATEDIFF_OPTS} \
       &
 
     geth_pid=$!

stack-orchestrator/container-build/cerc-fixturenet-plugeth-plugeth/Dockerfile

@@ -0,0 +1,27 @@
+FROM cerc/fixturenet-eth-genesis-postmerge:local as fnetgen
+
+# Using the same golang image as used to build geth: https://github.com/cerc-io/go-ethereum/blob/HEAD/Dockerfile
+FROM golang:1.21-alpine as delve
+RUN go install github.com/go-delve/delve/cmd/dlv@latest
+
+FROM cerc/plugeth-statediff:local as statediff
+# FIXME: fork of plugeth, use stock after upstreaming patches
+FROM cerc/plugeth:local as geth
+
+FROM alpine:3.18
+
+RUN apk add --no-cache bash wget python3 bind-tools postgresql-client
+
+COPY run-el.sh /opt/testnet/run.sh
+
+COPY --from=delve /go/bin/dlv /usr/local/bin/
+COPY --from=geth /usr/local/bin/geth /usr/local/bin/
+COPY --from=fnetgen /opt/genesis /opt/testnet
+COPY --from=statediff  /usr/local/lib/statediff.so /usr/local/lib/plugeth/
+
+# Initialize the geth db with our config
+RUN geth --datadir ~/ethdata --state.scheme hash \
+    init /opt/testnet/build/el/geth.json && \
+    rm -f ~/ethdata/geth/nodekey
+
+ENTRYPOINT ["/opt/testnet/run.sh"]

stack-orchestrator/container-build/cerc-fixturenet-plugeth-plugeth/build.sh

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+# Build cerc/fixturenet-plugeth-plugeth
+set -x
+
+source ${CERC_CONTAINER_BASE_DIR}/build-base.sh
+
+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+
+cp -fp ${SCRIPT_DIR}/../cerc-fixturenet-eth-geth/run-el.sh ${SCRIPT_DIR}/
+
+docker build -t cerc/fixturenet-plugeth-plugeth:local -f ${SCRIPT_DIR}/Dockerfile ${build_command_args} $SCRIPT_DIR

stack-orchestrator/container-build/cerc-plugeth-statediff/build.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+# Build cerc/plugeth-statediff
+source ${CERC_CONTAINER_BASE_DIR}/build-base.sh
+# Pass Go auth token if present
+if [[ -n "${CERC_GO_AUTH_TOKEN}" ]]; then
+    build_command_args="${build_command_args} --build-arg GIT_VDBTO_TOKEN=${CERC_GO_AUTH_TOKEN}"
+fi
+docker build -t cerc/plugeth-statediff:local ${build_command_args} ${CERC_REPO_BASE_DIR}/plugeth-statediff

stack-orchestrator/container-build/cerc-plugeth/build.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+# Build cerc/plugeth
+source ${CERC_CONTAINER_BASE_DIR}/build-base.sh
+# Pass Go auth token if present
+if [[ -n "${CERC_GO_AUTH_TOKEN}" ]]; then
+    build_command_args="${build_command_args} --build-arg GIT_VDBTO_TOKEN=${CERC_GO_AUTH_TOKEN}"
+fi
+docker build -t cerc/plugeth:local ${build_command_args} ${CERC_REPO_BASE_DIR}/plugeth

stack-orchestrator/stacks/fixturenet-plugeth/stack.yml

@@ -0,0 +1,20 @@
+version: "1.1"
+name: fixturenet-plugeth
+description: "Plugeth Ethereum Indexing Fixturenet"
+repos:
+  - git.vdb.to/cerc-io/plugeth@statediff
+  - git.vdb.to/cerc-io/plugeth-statediff
+  - git.vdb.to/cerc-io/lighthouse
+  - git.vdb.to/cerc-io/ipld-eth-db
+containers:
+  - cerc/plugeth-statediff
+  - cerc/plugeth
+  - cerc/fixturenet-eth-genesis-postmerge
+  - cerc/fixturenet-plugeth-plugeth
+  - cerc/lighthouse
+  - cerc/lighthouse-cli
+  - cerc/fixturenet-eth-lighthouse
+  - cerc/ipld-eth-db
+pods:
+  - fixturenet-plugeth
+  - ipld-eth-db

tests/fixturenet-plugeth-stack/run-test.sh

@@ -0,0 +1,132 @@
+#!/usr/bin/env bash
+set -e
+if [ -n "$CERC_SCRIPT_DEBUG" ]; then
+  set -x
+fi
+
+SO_COMMAND=laconic-so
+
+test_name="Fixturenet eth stack deploy test"
+echo "Running ${test_name}"
+
+stack_name=$(pwd)/stack-orchestrator/stacks/fixturenet-plugeth
+
+test_fail_exit () {
+    local fail_message=$1
+    echo "${test_name}: ${fail_message}"
+    echo "${test_name}: FAILED"
+    exit 1
+}
+
+log_info () {
+    local message=$1
+    echo "$(date +"%Y-%m-%d %T"): ${message}"
+}
+
+get_block_number () {
+  local result=$(wget -q -O- "$1" \
+    --header "Content-Type: application/json" \
+    --post-data '{"id": 1, "jsonrpc": "2.0", "method": "eth_blockNumber"}' | \
+    jq -r '.result')
+  printf "%d" $result
+}
+
+# Sanity check the stack dir exists
+if [ ! -d "${stack_name}" ]; then
+    test_fail_exit "stack directory not present"
+    exit 1
+fi
+
+# Set a non-default repo dir
+export CERC_REPO_BASE_DIR=~/stack-orchestrator-test/repo-base-dir
+reported_version_string=$( $SO_COMMAND version )
+echo "SO version is: ${reported_version_string}"
+echo "Cloning repositories into: $CERC_REPO_BASE_DIR"
+rm -rf $CERC_REPO_BASE_DIR
+mkdir -p $CERC_REPO_BASE_DIR
+
+$SO_COMMAND --stack ${stack_name} setup-repositories
+
+echo "Building containers"
+$SO_COMMAND --stack ${stack_name} build-containers
+
+test_deployment_dir=$CERC_REPO_BASE_DIR/test-deployment-dir
+test_deployment_spec=$CERC_REPO_BASE_DIR/test-deployment-spec.yml
+
+$SO_COMMAND --stack ${stack_name} deploy init --output $test_deployment_spec
+# Check the file now exists
+if [ ! -f "$test_deployment_spec" ]; then
+    test_fail_exit "deploy init test: spec file not present"
+fi
+echo "deploy init test: passed"
+
+$SO_COMMAND --stack ${stack_name} deploy create --spec-file $test_deployment_spec --deployment-dir $test_deployment_dir
+# Check the deployment dir exists
+if [ ! -d "$test_deployment_dir" ]; then
+    test_fail_exit "deploy create test: deployment directory not present"
+fi
+echo "deploy create test: passed"
+
+dump_logs () {
+  echo "Test failed. Logs from stack:"
+  $SO_COMMAND deployment --dir $test_deployment_dir logs
+}
+trap dump_logs ERR
+
+$SO_COMMAND deployment --dir $test_deployment_dir start
+
+geth_endpoint=localhost:$($SO_COMMAND deployment --dir $test_deployment_dir port fixturenet-eth-geth-1 8545 | cut -d: -f2)
+
+timeout=900 # 15 minutes
+log_info "Getting initial block number. Timeout set to $timeout seconds"
+start_time=$(date +%s)
+elapsed_time=0
+initial_block_number=0
+while [ "$initial_block_number" -eq 0 ]  && [ $elapsed_time -lt $timeout ]; do
+  sleep 10
+  log_info "Waiting for initial block..."
+  initial_block_number=$(get_block_number $geth_endpoint)
+  current_time=$(date +%s)
+  elapsed_time=$((current_time - start_time))
+done
+
+subsequent_block_number=$initial_block_number
+
+# if initial block was 0 after timeout, assume chain did not start successfully and skip finding subsequent block
+if [[ $initial_block_number -gt 0 ]]; then
+  timeout=300
+  log_info "Getting subsequent block number. Timeout set to $timeout seconds"
+  start_time=$(date +%s)
+  elapsed_time=0
+  # wait for 5 blocks or timeout
+  while [ "$subsequent_block_number" -le $((initial_block_number + 5)) ]  && [ $elapsed_time -lt $timeout ]; do
+    sleep 10
+    log_info "Waiting for five blocks or $timeout seconds..."
+    subsequent_block_number=$(get_block_number $geth_endpoint)
+    current_time=$(date +%s)
+    elapsed_time=$((current_time - start_time))
+  done
+fi
+
+# will return 0 if either of the above loops timed out
+block_number_difference=$((subsequent_block_number - initial_block_number))
+
+log_info "Results of block height queries:"
+echo "Initial block height: $initial_block_number"
+echo "Subsequent block height: $subsequent_block_number"
+
+# Block height difference should be between 1 and some small number
+[[ $block_number_difference -gt 1 && $block_number_difference -lt 100 ]]
+
+# Check that the block hash is present in the ipld-eth-db
+echo "Querying ipld-eth-db for block number $subsequent_block_number"
+block_hash_query="SELECT block_hash from eth.header_cids where block_number = $subsequent_block_number"
+block_hash=$(
+  $SO_COMMAND deployment --dir $test_deployment_dir exec ipld-eth-db \
+    "psql -qtA -U vdbm -c '$block_hash_query' cerc_testing"
+)
+echo "Block hash in ipld-eth-db: $block_hash"
+
+[[ -n $block_hash ]]
+
+echo "Test passed."