Smoke test for nitro testnode

.github/workflows/ci.yml

@@ -8,12 +8,12 @@ on:
     push:
       branches:
         - master
-        - develop
-  
+        - integration
+
 
 jobs:
   build_and_run:
-    runs-on: ubuntu-8
+    runs-on: ubuntu-24.04
 
     steps:
     - name: Checkout
@@ -32,6 +32,8 @@ jobs:
         path: /tmp/.buildx-cache
         key: ${{ runner.os }}-buildx-${{ hashFiles('Dockerfile') }}
         restore-keys: ${{ runner.os }}-buildx-
-
-    - name:  Startup Nitro testnode
-      run: ${{ github.workspace }}/.github/workflows/testnode.bash
+
+# This is currently broken as L3 node support needs to be fixed
+#    - name:  Startup Nitro testnode
+#      run: ${{ github.workspace }}/.github/workflows/testnode.bash
+

.github/workflows/smoke-test-node.bash

@@ -0,0 +1,56 @@
+#!/bin/bash
+# The script starts up the test node and waits until the timeout (10min) or
+# until send-l2 succeeds and the latest confirmation is fetched.
+
+# Start the test node and get PID, to terminate it once send-l2 is done and the latest confirmation is fetched.
+./smoke-test-node.bash --init  --detach
+
+START=$(date +%s)
+L2_TRANSACTION_SUCCEEDED=false
+LATEST_CONFIRMATION_FETCHED=false
+SUCCEEDED=false
+
+while true; do
+  if [ "$L2_TRANSACTION_SUCCEEDED" = false ]; then
+    if ${GITHUB_WORKSPACE}/smoke-test-node.bash script send-l2 --ethamount 100 --to user_l2user --wait; then
+        echo "Sending l2 transaction succeeded"
+        L2_TRANSACTION_SUCCEEDED=true
+    fi
+  fi
+
+  if [ "$LATEST_CONFIRMATION_FETCHED" = false ]; then
+   rollupAddress=`docker compose run --entrypoint sh poster -c "jq -r '.[0].rollup.rollup' /config/deployed_chain_info.json | tail -n 1 | tr -d '\r\n'"`
+    error=` cast call --rpc-url http://localhost:8545  $rollupAddress 'latestConfirmed()(uint256)' | grep "error"`
+       if [ "$error" == "" ]; then
+         echo "Lastest confirmation fetched"
+         LATEST_CONFIRMATION_FETCHED=true
+       fi
+  fi
+
+
+  if [ "$L2_TRANSACTION_SUCCEEDED" = true ] && [ "$LATEST_CONFIRMATION_FETCHED" = true ]; then
+      SUCCEEDED=true
+      break
+  fi
+
+  # Check if the timeout (20 min) has been reached.
+  NOW=$(date +%s)
+  DIFF=$((NOW - START))
+  if [ "$DIFF" -ge 1200 ]; then
+      echo "Timed out"
+      break
+  fi
+
+  sleep 10
+done
+
+docker compose stop
+
+if [ "$SUCCEEDED" = false ]; then
+  docker compose logs
+  exit 1
+fi
+
+echo "Smoke test succeeded"
+
+exit 0

.github/workflows/smoke-test.yml

@@ -0,0 +1,45 @@
+name: Smoke Test CI
+run-name: CI triggered from @${{ github.actor }} of ${{ github.head_ref }}
+
+on:
+  workflow_dispatch:
+  merge_group:
+  pull_request:
+  push:
+    branches:
+      - master
+      - integration
+  schedule:
+    #      Run at the end of every day
+    - cron: "0 0 * * *"
+
+
+jobs:
+  build_and_run:
+    runs-on: ubuntu-24.04
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+        with:
+          driver-opts: network=host
+
+      - name: Cache Docker layers
+        uses: actions/cache@v3
+        with:
+          path: /tmp/.buildx-cache
+          key: ${{ runner.os }}-buildx-${{ hashFiles('Dockerfile') }}
+          restore-keys: ${{ runner.os }}-buildx-
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: nightly
+
+      - name:  Start Smoke Test with Latest Espresso Image
+        run: ${{ github.workspace }}/.github/workflows/smoke-test-node.bash

.github/workflows/testnode.bash

@@ -21,6 +21,7 @@ while true; do
         fi
     fi
 
+
     if [ "$L3_TRANSACTION_SUCCEEDED" = false ]; then
         if ${GITHUB_WORKSPACE}/test-node.bash script send-l3 --ethamount 100 --to user_l3user --wait; then
             echo "Sending l3 transaction succeeded"
@@ -44,10 +45,10 @@ while true; do
     sleep 10
 done
 
-docker-compose stop
+docker compose stop
 
 if [ "$SUCCEEDED" = false ]; then
-    docker-compose logs
+    docker compose logs
     exit 1
 fi
 

smoke-test-node.bash

@@ -0,0 +1,207 @@
+#!/usr/bin/env bash
+
+set -e
+
+NITRO_NODE_VERSION=offchainlabs/nitro-node:v3.0.1-cf4b74e-dev
+ESPRESSO_VERSION=ghcr.io/espressosystems/nitro-espresso-integration/nitro-node-dev:integration
+
+DEFAULT_NITRO_CONTRACTS_VERSION="develop"
+
+: ${NITRO_CONTRACTS_BRANCH:=$DEFAULT_NITRO_CONTRACTS_VERSION}
+: ${TOKEN_BRIDGE_BRANCH:=$DEFAULT_TOKEN_BRIDGE_VERSION}
+export  NITRO_CONTRACTS_BRANCH
+export TOKEN_BRIDGE_BRANCH
+
+echo "Using NITRO_CONTRACTS_BRANCH: $NITRO_CONTRACTS_BRANCH"
+echo "Using TOKEN_BRIDGE_BRANCH: $TOKEN_BRIDGE_BRANCH"
+
+mydir=`dirname $0`
+cd "$mydir"
+
+if [[ $# -gt 0 ]] && [[ $1 == "script" ]]; then
+    shift
+    docker compose run scripts "$@"
+    exit $?
+fi
+
+num_volumes=`docker volume ls --filter label=com.docker.compose.project=nitro-testnode -q | wc -l`
+
+if [[ $num_volumes -eq 0 ]]; then
+    force_init=true
+else
+    force_init=false
+fi
+
+run=true
+detach=false
+force_build=false
+validate=true
+tokenbridge=true
+lightClientAddr=0xb6eb235fa509e3206f959761d11e3777e16d0e98
+espresso=true
+latest_espresso_image=true
+batchposters=1
+devprivkey=b6b15c8cb491557369f3c7d2c287b053eb229daa9c22138887752191c9520659
+l1chainid=1337
+while [[ $# -gt 0 ]]; do
+    case $1 in
+        --init)
+            if ! $force_init; then
+                read -p "are you sure? [y/n]" -n 1 response
+                if [[ $response == "y" ]] || [[ $response == "Y" ]]; then
+                    force_init=true
+                    echo
+                else
+                    exit 0
+                fi
+            fi
+            shift
+            ;;
+        --detach)
+            detach=true
+            shift
+            ;;
+      *)
+        echo Usage: $0 \[OPTIONS..]
+        echo        $0 script [SCRIPT-ARGS]
+        echo
+        echo OPTIONS:
+        echo --init            remove all data, rebuild, deploy new rollup
+        echo --detach          detach from nodes after running them
+        echo script runs inside a separate docker. For SCRIPT-ARGS, run $0 script --help
+        exit 0
+    esac
+done
+
+if $force_init; then
+  force_build=true
+fi
+
+NODES="sequencer"
+INITIAL_SEQ_NODES="sequencer"
+NODES="$NODES redis"
+
+if [ $batchposters -gt 0 ]; then
+    NODES="$NODES poster"
+fi
+
+if [ $batchposters -gt 1 ]; then
+    NODES="$NODES poster_b"
+fi
+
+if [ $batchposters -gt 2 ]; then
+    NODES="$NODES poster_c"
+fi
+
+NODES="$NODES validator"
+
+if $force_build; then
+    INITIAL_SEQ_NODES="$INITIAL_SEQ_NODES espresso-dev-node"
+else
+    NODES="$NODES espresso-dev-node"
+fi
+
+
+if $force_build; then
+  echo == Building..
+  LOCAL_BUILD_NODES="scripts rollupcreator"
+  if $tokenbridge; then
+    LOCAL_BUILD_NODES="$LOCAL_BUILD_NODES tokenbridge"
+  fi
+  docker compose build --no-rm $LOCAL_BUILD_NODES
+fi
+
+echo == Pulling the latest Espresso image
+docker pull $ESPRESSO_VERSION
+docker tag $ESPRESSO_VERSION nitro-node-dev-testnode
+
+
+if $force_build; then
+    docker compose build --no-rm $NODES scripts
+fi
+
+if $force_init; then
+    echo == Removing old data..
+    docker compose down
+    leftoverContainers=`docker container ls -a --filter label=com.docker.compose.project=nitro-testnode -q | xargs echo`
+    if [ `echo $leftoverContainers | wc -w` -gt 0 ]; then
+        docker rm $leftoverContainers
+    fi
+    docker volume prune -f --filter label=com.docker.compose.project=nitro-testnode
+    leftoverVolumes=`docker volume ls --filter label=com.docker.compose.project=nitro-testnode -q | xargs echo`
+    if [ `echo $leftoverVolumes | wc -w` -gt 0 ]; then
+        docker volume rm $leftoverVolumes
+    fi
+
+    echo == Generating l1 keys
+    docker compose run scripts write-accounts
+    docker compose run --entrypoint sh geth -c "echo passphrase > /datadir/passphrase"
+    docker compose run --entrypoint sh geth -c "chown -R 1000:1000 /keystore"
+    docker compose run --entrypoint sh geth -c "chown -R 1000:1000 /config"
+
+    echo == Starting geth
+    docker compose up --wait geth
+
+    echo == Funding validator, sequencer and l2owner
+    docker compose run scripts send-l1 --ethamount 1000 --to validator --wait
+    docker compose run scripts send-l1 --ethamount 1000 --to sequencer --wait
+    docker compose run scripts send-l1 --ethamount 1000 --to l2owner --wait
+    docker compose run scripts send-l1 --ethamount 10000 --to espresso-sequencer --wait
+
+    echo == create l1 traffic
+    docker compose run scripts send-l1 --ethamount 1000 --to user_l1user --wait
+    docker compose run scripts send-l1 --ethamount 0.0001 --from user_l1user --to user_l1user_b --wait --delay 500 --times 1000000 > /dev/null &
+
+    l2ownerAddress=`docker compose run scripts print-address --account l2owner | tail -n 1 | tr -d '\r\n'`
+
+    echo == Writing l2 chain config
+    docker compose run scripts --l2owner $l2ownerAddress  write-l2-chain-config --espresso $espresso
+
+    sequenceraddress=`docker compose run scripts print-address --account sequencer | tail -n 1 | tr -d '\r\n'`
+    l2ownerKey=`docker compose run scripts print-private-key --account l2owner | tail -n 1 | tr -d '\r\n'`
+    wasmroot=`docker compose run --entrypoint sh sequencer -c "cat /home/user/target/machines/latest/module-root.txt"`
+
+    echo == Deploying L2 chain
+    docker compose run -e PARENT_CHAIN_RPC="http://geth:8545" -e DEPLOYER_PRIVKEY=$l2ownerKey -e PARENT_CHAIN_ID=$l1chainid -e CHILD_CHAIN_NAME="arb-dev-test" -e MAX_DATA_SIZE=117964 -e OWNER_ADDRESS=$l2ownerAddress -e WASM_MODULE_ROOT=$wasmroot -e SEQUENCER_ADDRESS=$sequenceraddress -e AUTHORIZE_VALIDATORS=10 -e CHILD_CHAIN_CONFIG_PATH="/config/l2_chain_config.json" -e CHAIN_DEPLOYMENT_INFO="/config/deployment.json" -e CHILD_CHAIN_INFO="/config/deployed_chain_info.json" -e LIGHT_CLIENT_ADDR=$lightClientAddr  rollupcreator create-rollup-testnode
+    docker compose run --entrypoint sh rollupcreator -c "jq [.[]] /config/deployed_chain_info.json > /config/l2_chain_info.json"
+
+
+    echo == Writing configs
+    docker compose run scripts write-config --espresso $espresso --lightClientAddress $lightClientAddr
+
+    echo == Initializing redis
+    docker compose up --wait redis
+    docker compose run scripts redis-init
+
+    echo == Funding l2 funnel and dev key
+    docker compose up --wait $INITIAL_SEQ_NODES
+    docker compose run scripts bridge-funds --ethamount 100000 --wait
+    docker compose run scripts send-l2 --ethamount 10000 --to espresso-sequencer --wait
+    docker compose run scripts send-l2 --ethamount 100 --to l2owner --wait
+
+    if $tokenbridge; then
+        echo == Deploying L1-L2 token bridge
+        sleep 10 # no idea why this sleep is needed but without it the deploy fails randomly
+        rollupAddress=`docker compose run --entrypoint sh poster -c "jq -r '.[0].rollup.rollup' /config/deployed_chain_info.json | tail -n 1 | tr -d '\r\n'"`
+        l2ownerKey=`docker compose run scripts print-private-key --account l2owner | tail -n 1 | tr -d '\r\n'`
+        docker compose run -e ROLLUP_OWNER_KEY=$l2ownerKey -e ROLLUP_ADDRESS=$rollupAddress -e PARENT_KEY=$devprivkey -e PARENT_RPC=http://geth:8545 -e CHILD_KEY=$devprivkey -e CHILD_RPC=http://sequencer:8547 tokenbridge deploy:local:token-bridge
+        docker compose run --entrypoint sh tokenbridge -c "cat network.json && cp network.json l1l2_network.json && cp network.json localNetwork.json"
+        echo
+    fi
+
+    echo == Deploy CacheManager on L2
+    docker compose run -e CHILD_CHAIN_RPC="http://sequencer:8547" -e CHAIN_OWNER_PRIVKEY=$l2ownerKey rollupcreator deploy-cachemanager-testnode
+fi
+
+if $run; then
+    UP_FLAG=""
+    if $detach; then
+        UP_FLAG="--wait"
+    fi
+
+    echo == Launching Sequencer
+    echo if things go wrong - use --init to create a new chain
+    echo
+
+    docker compose up $UP_FLAG $NODES
+fi