chore(simple-surge-node): add e2e CI pipeline, bridge delivery checks, script improvements

Author: nme-mvasylenko

.github/workflows/e2e-full-stack.yml

@@ -0,0 +1,96 @@
+name: E2E Full Stack Test
+
+on:
+  pull_request:
+    branches: [main, feat/shasta]
+  workflow_dispatch:
+
+concurrency:
+  group: e2e-${{ github.head_ref || github.ref_name }}
+  cancel-in-progress: true
+
+jobs:
+  e2e-full-stack:
+    name: E2E Full Stack
+    permissions:
+      contents: read
+    runs-on: ubuntu-22.04
+    timeout-minutes: 60
+    env:
+      CI_L2_DEPLOYER_TIMEOUT: "300"
+      CI_HEALTH_MAX_RETRIES: "60"
+      CI_HEALTH_RETRY_INTERVAL: "10"
+      CI_BRIDGE_DELIVERY_TIMEOUT: "1200"
+
+    steps:
+      - name: Checkout simple-surge-node
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+          fetch-depth: 0
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@e468171a9de216ec08956ac3ada2f0791b6bd435
+
+      - name: Install system dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y curl jq bc
+
+      - name: Install Kurtosis CLI
+        run: |
+          echo "deb [trusted=yes] https://apt.fury.io/kurtosis-tech/ /" | sudo tee /etc/apt/sources.list.d/kurtosis.list
+          sudo apt-get update
+          sudo apt-get install -y kurtosis-cli
+          kurtosis version
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+
+      - name: Verify prerequisites
+        run: |
+          docker --version
+          docker compose version
+          docker info
+          kurtosis version
+          cast --version
+
+      - name: Run E2E
+        run: ./script/ci-e2e.sh
+
+      - name: Collect logs on failure
+        if: failure()
+        run: |
+          echo "=== Docker Compose Services ==="
+          docker compose ps || true
+          echo "=== Docker Compose Logs (last 200 lines) ==="
+          docker compose logs --tail=200 || true
+          echo "=== Relayer Compose Logs ==="
+          docker compose -f docker-compose-relayer.yml logs --tail=100 || true
+          echo "=== Kurtosis Enclaves ==="
+          kurtosis enclave ls || true
+          echo "=== Kurtosis Inspect ==="
+          kurtosis enclave inspect surge-devnet || true
+
+      - name: Upload artifacts on failure
+        if: failure()
+        uses: actions/upload-artifact@v4
+        with:
+          name: e2e-failure-logs
+          path: |
+            deployment/*.json
+            deployment/*.lock
+            *.log
+          retention-days: 7
+          if-no-files-found: ignore
+
+      - name: Cleanup
+        if: always()
+        run: |
+          docker compose --profile driver --profile proposer --profile spammer --profile prover --profile blockscout down --remove-orphans 2>/dev/null || true
+          docker compose -f docker-compose-protocol.yml down --remove-orphans 2>/dev/null || true
+          docker compose -f docker-compose-relayer.yml down --remove-orphans 2>/dev/null || true
+          docker network rm surge-network 2>/dev/null || true
+          kurtosis enclave rm surge-devnet --force 2>/dev/null || true
+          kurtosis clean -a 2>/dev/null || true
+          docker system prune -af --volumes 2>/dev/null || true

README.md

@@ -4,20 +4,74 @@
 
 This repository is ideal for easy set up operating Layer 2 (L2) solutions, simplifying the process of running Surge node.
 
+## Prerequisites
+
+### Docker and Docker Compose
+
+Docker Engine and Docker Compose v2.1+ are required. Install Docker Desktop or Docker Engine following the [official docs](https://docs.docker.com/engine/install/).
+
+Verify:
+
+```bash
+docker --version
+docker compose version   # must be >= 2.1
+```
+
+### Foundry (cast)
+
+```bash
+curl -L https://foundry.paradigm.xyz | bash
+foundryup
+```
+
+### Node.js (using nvm - recommended)
+
+```bash
+curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
+source ~/.bashrc  # or ~/.zshrc if using zsh
+nvm install --lts
+```
+
+Or using apt on Ubuntu/Debian:
+
+```bash
+curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
+sudo apt-get install -y nodejs
+```
+
+After installation, restart your terminal or run `source ~/.bashrc` or `source ~/.zshrc` to ensure the tools are available in your PATH.
+
 ## Quick Start
 
 ### Deploy Complete Devnet
 
 ```bash
-# Deploy everything with defaults
+# Copy devnet environment (first time only)
+cp .env.devnet .env
+
+# Deploy everything (non-interactive, defaults to devnet + new L1)
+./deploy-surge-full.sh --force
+
+# Or specify options explicitly
 ./deploy-surge-full.sh --environment devnet --deploy-devnet true --force
 ```
 
-### Remove Everything
+Without `--force` the script prompts interactively for environment, deployment mode, and L1 options.
+
+**Options:**
+- `--environment ENV` - Surge environment: `devnet`, `staging`, `testnet` (defaults to `devnet` with `--force`)
+- `--deploy-devnet true` - Deploy a new L1 devnet (default with `--force`)
+- `--deploy-devnet false` - Skip L1 deployment, use existing chain
+- `--deployment local|remote` - Local or remote deployment (defaults to `local` with `--force`)
+
+### Remove Stack
 
 ```bash
-# Remove all components
+# Remove L2 stack, relayers, configs (keeps L1 devnet running)
 ./remove-surge-full.sh --force
+
+# Remove everything including L1 devnet
+./remove-surge-full.sh --remove-l1-devnet true --force
 ```
 
 For detailed deployment and removal instructions, see [DEPLOYMENT.md](./DEPLOYMENT.md).

bridge-txs-spammer.sh

@@ -223,20 +223,18 @@ send_bridge_tx() {
 
     log_tx "[$tx_num/$total] Sending $label bridge tx..."
 
-    local nonce="$9"
-
     local tx_output
     if tx_output=$(cast send "$bridge_address" \
         "sendMessage((uint64,uint64,uint32,address,uint64,address,uint64,address,address,uint256,bytes))" \
         "(0,$FEE_WEI,$GAS_LIMIT,$ZERO_ADDRESS,0,$PUBLIC_KEY,$dest_chain_id,$PUBLIC_KEY,$PUBLIC_KEY,$amount_wei,0x)" \
         --value "$total_value_wei" \
         --rpc-url "$rpc_url" \
         --private-key "$PRIVATE_KEY" \
-        --nonce "$nonce" 2>&1); then
-        log_tx "[$tx_num/$total] $label bridge tx sent successfully ✓"
+        2>&1); then
+        log_tx "[$tx_num/$total] $label bridge tx sent successfully"
         return 0
     else
-        log_error "[$tx_num/$total] $label bridge tx failed ✗"
+        log_error "[$tx_num/$total] $label bridge tx failed"
         log_error "Reason: $tx_output"
         return 1
     fi
@@ -265,37 +263,28 @@ run_bridge_spam() {
 
     local success_count=0
     local fail_count=0
+    local max_retries=5
+    local retry_delay=5
 
-    # Get starting nonce to avoid nonce collisions when sending rapid txs.
-    # We use pending nonce and increment locally, with retry on nonce conflicts
-    # (the same key may be used by proposer/prover, causing contention).
-    local current_nonce
-    current_nonce=$(cast nonce "$PUBLIC_KEY" --rpc-url "$rpc_url" --pending 2>/dev/null || cast nonce "$PUBLIC_KEY" --rpc-url "$rpc_url")
-    log_info "Starting nonce: $current_nonce"
-
-    local max_retries=3
     for ((i = 1; i <= count; i++)); do
         local attempt=0
         local sent=false
         while [[ "$sent" == "false" && $attempt -lt $max_retries ]]; do
             if send_bridge_tx "$bridge_address" "$rpc_url" "$dest_chain_id" \
-                "$amount_wei" "$total_value_wei" "$direction_label" "$i" "$count" "$current_nonce"; then
+                "$amount_wei" "$total_value_wei" "$direction_label" "$i" "$count"; then
                 ((success_count++)) || true
                 sent=true
             else
                 ((attempt++)) || true
                 if [[ $attempt -lt $max_retries ]]; then
-                    # Brief pause to allow pending txs to be mined before refreshing nonce
-                    sleep 2
-                    current_nonce=$(cast nonce "$PUBLIC_KEY" --rpc-url "$rpc_url" --pending 2>/dev/null || cast nonce "$PUBLIC_KEY" --rpc-url "$rpc_url")
-                    log_info "Retrying with refreshed nonce: $current_nonce (attempt $((attempt+1))/$max_retries)"
+                    log_info "Retrying in ${retry_delay}s (attempt $((attempt+1))/$max_retries)..."
+                    sleep "$retry_delay"
                 fi
             fi
         done
         if [[ "$sent" == "false" ]]; then
             ((fail_count++)) || true
         fi
-        ((current_nonce++)) || true
     done
 
     echo
@@ -308,6 +297,7 @@ run_bridge_spam() {
 
     if [[ $fail_count -gt 0 ]]; then
         log_warning "$fail_count transactions failed for $direction_label"
+        return 1
     else
         log_success "All $direction_label transactions completed successfully"
     fi
@@ -417,6 +407,8 @@ main() {
     l1_rpc=$(echo "$l1_rpc" | sed 's/host\.docker\.internal/localhost/g')
     l2_rpc=$(echo "$l2_rpc" | sed 's/host\.docker\.internal/localhost/g')
 
+    log_info "Using deployer wallet: $PUBLIC_KEY"
+
     # Map direction to label
     local dir_label
     case "$dir_choice" in
@@ -429,31 +421,30 @@ main() {
     confirm_execution "$tx_count" "$dir_label" "$eth_amount"
 
     # Execute bridge spam
-    local total_success=0
-    local total_fail=0
+    local has_failures=false
 
     case "$dir_choice" in
         1)
             # L1 -> L2: call L1 bridge, dest = L2 chain
             run_bridge_spam "L1 → L2" "$SHASTA_BRIDGE" "$l1_rpc" "$L2_CHAIN_ID" \
-                "$amount_wei" "$total_value_wei" "$tx_count"
+                "$amount_wei" "$total_value_wei" "$tx_count" || has_failures=true
             ;;
         2)
             # L2 -> L1: call L2 bridge, dest = L1 chain
             run_bridge_spam "L2 → L1" "$L2_BRIDGE" "$l2_rpc" "$L1_CHAIN_ID" \
-                "$amount_wei" "$total_value_wei" "$tx_count"
+                "$amount_wei" "$total_value_wei" "$tx_count" || has_failures=true
             ;;
         3)
             # Both directions: send full count in each direction
             log_info "Sending $tx_count transactions in each direction ($((tx_count * 2)) total)"
 
             # L1 -> L2
             run_bridge_spam "L1 → L2" "$SHASTA_BRIDGE" "$l1_rpc" "$L2_CHAIN_ID" \
-                "$amount_wei" "$total_value_wei" "$tx_count"
+                "$amount_wei" "$total_value_wei" "$tx_count" || has_failures=true
 
             # L2 -> L1
             run_bridge_spam "L2 → L1" "$L2_BRIDGE" "$l2_rpc" "$L1_CHAIN_ID" \
-                "$amount_wei" "$total_value_wei" "$tx_count"
+                "$amount_wei" "$total_value_wei" "$tx_count" || has_failures=true
             ;;
     esac
 
@@ -464,7 +455,12 @@ main() {
     echo "╚══════════════════════════════════════════════════════════════╝"
     echo
 
-    log_success "Bridge transaction spamming complete!"
+    if [[ "$has_failures" == "true" ]]; then
+        log_error "Bridge transaction spamming finished with failures"
+        exit 1
+    else
+        log_success "Bridge transaction spamming complete!"
+    fi
 }
 
 # Run main function

deploy-surge-full.sh

@@ -228,7 +228,19 @@ validate_prerequisites() {
         log_error "Please install them first"
         return 1
     fi
-    
+
+    # Verify docker compose v2.1+ (required for --profile support)
+    local compose_version
+    compose_version=$(docker compose version --short 2>/dev/null || echo "0.0.0")
+    local compose_major compose_minor
+    compose_major=$(echo "$compose_version" | cut -d. -f1)
+    compose_minor=$(echo "$compose_version" | cut -d. -f2)
+    if [[ "$compose_major" -lt 2 ]] || [[ "$compose_major" -eq 2 && "$compose_minor" -lt 1 ]]; then
+        log_error "docker compose >= 2.1 required (found: $compose_version)"
+        return 1
+    fi
+    log_info "docker compose version: $compose_version"
+
     # Create required directories
     for dir in "$DEPLOYMENT_DIR" "$CONFIGS_DIR" "driver-data"; do
         if [[ ! -d "$dir" ]]; then
@@ -1912,7 +1924,7 @@ wait_for_l2_blocks() {
     l2_rpc=$(echo "$l2_rpc" | sed 's/host\.docker\.internal/localhost/g')
 
     local waited=0
-    local max_wait=384  # Entire epoch duration
+    local max_wait=600  # 10 minutes
     while [[ $waited -lt $max_wait ]]; do
         local block_number
         block_number=$(cast block-number --rpc-url "$l2_rpc" 2>/dev/null || echo "0")
@@ -1953,25 +1965,25 @@ deploy_l2() {
         # Start L2 deployer in detached mode, then wait for it to finish
         BROADCAST=true docker compose --profile l2-deployer up -d >"$temp_output" 2>&1 &
         local deploy_pid=$!
-
+        
         show_progress $deploy_pid "Deploying L2 contracts..."
-
+        
         wait $deploy_pid
         exit_status=$?
-
+        
         if [[ $exit_status -ne 0 ]]; then
             log_error "Failed to start L2 deployer container (exit code: $exit_status)"
             if [[ -f "$temp_output" ]]; then
                 log_error "Output saved in: $temp_output"
             fi
             return 1
         fi
-
+        
         # Wait for the deployer container to finish (up to 600s)
         # The deployer runs forge script --broadcast which needs L2 blocks to confirm txs
         log_info "Waiting for L2 deployer to complete..."
         local waited=0
-        local max_wait=600
+        local max_wait=${CI_L2_DEPLOYER_TIMEOUT:-600}
         while [[ $waited -lt $max_wait ]]; do
             # Check if the deployment artifact appeared on the host (most reliable signal)
             if [[ -f "$DEPLOYMENT_DIR/setup_l2.json" ]]; then
@@ -2005,15 +2017,15 @@ deploy_l2() {
             docker logs surge-l2-deployer 2>&1 | tail -20 >&2
             return 1
         fi
-
+        
         # Verify the deployment artifact was produced
         if [[ -f "$DEPLOYMENT_DIR/setup_l2.json" ]]; then
             log_success "L2 smart contracts deployed successfully"
             touch "$L2_LOCK_FILE"
         else
             log_warning "L2 deployer exited 0 but setup_l2.json not found, continuing..."
         fi
-
+        
         return 0
     fi
 }
@@ -2583,7 +2595,7 @@ main() {
         # Deploy L1 contracts
         local mock_proof
         if [[ "$force" == "true" ]]; then
-            mock_proof=0  # default: mock prover
+            mock_proof=0
         else
             echo
             echo "╔══════════════════════════════════════════════════════════════╗"