Merge branch 'main' into feature/adk

Author: bussyjd

obolup/README.md

@@ -2,6 +2,26 @@
 
 `obolup` is a script for launching (and updating) the Obol Stack. It is in early Alpha, and subject to breaking changes. It is not yet recommended as a production runtime. 
 
+## Usage
+
+To start a light-client, mainnet node, simply run `./obolup` from this directory.
+
+To start a Hoodi testnet instance of the Obol Stack, run `./obolup --network hoodi`.
+
+```text
+Usage: ./obolup [--help] [--network <network>] [--mode <mode>] [--clean]
+
+Options:
+  --help                            Display this help message
+  --network <network>               Specify the network (default: mainnet) [mainnet, hoodi]
+  --mode <mode>                     Specify the type of sync mode (default: light) [light, full]
+  --clean                           Deletes and recreates the Obol Stack
+```
+
+### Troubleshooting
+
+Adding the `--clean` flag will start your cluster fresh, and may fix issues during alpha usage or version upgrades. This will clear the stored data of your stack.
+
 ## Supported Architectures
 
 | Operating System | Architecture | Supported |

obolup/obolup

@@ -1,33 +1,84 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 # modified from https://github.com/foundry-rs/foundry/blob/master/foundryup/foundryup
 
 # obolup - Obol Stack Updater and Launcher
-# Usage: obolup [update]
 
-set -eo pipefail
+set -Eeuo pipefail
 
 
 # Constants
-OBOL_CLI_REPO="https://github.com/obolnetwork/obol-cli"
-KIND_VERSION="v0.27.0"
-OBOLUP_URL="https://stack.obol.org/obolup"
-STACK_NAME="obol-stack"
-STATUS_PORT=8080
+readonly OBOL_CLI_REPO="https://github.com/obolnetwork/obol-cli"
+readonly KIND_VERSION="v0.27.0"
+readonly OBOLUP_URL="https://stack.obol.org/obolup"
+readonly STACK_NAME="obol-stack"
+readonly STATUS_PORT=8080
+
+# Colors for output
+readonly RED='\033[0;31m'
+readonly GREEN='\033[0;32m'
+readonly YELLOW='\033[1;33m'
+readonly NC='\033[0m' # No Color
+
+# Network name to chain ID mapping
+declare -A -r SUPPORTED_NETWORKS=(
+	["hoodi"]="560048"
+    ["mainnet"]="1"
+)
+# Supported sync types
+declare -A -r SUPPORTED_MODES=(
+	["light"]=1
+    ["full"]=2
+)
+
+readonly BASE_DIR=${XDG_CONFIG_HOME:-$HOME}
+
+
+tolower() {
+  echo "$1" | awk '{print tolower($0)}'
+}
+
+# Get platform + architecture
+readonly uname_s=$(uname -s)
+PLATFORM=$(tolower "${OBOLUP_PLATFORM:-$uname_s}")
 ARCHITECTURE=unset
+EXT="tar.gz"
+case $PLATFORM in
+    linux) ;;
+    darwin|mac*)
+    PLATFORM="darwin"
+    ;;
+    mingw*|win*)
+    EXT="zip"
+    PLATFORM="win32"
+    ;;
+    *)
+    err "unsupported platform: $PLATFORM"
+    ;;
+esac
+
+readonly uname_m=$(uname -m)
+ARCHITECTURE=$(tolower "${OBOLUP_ARCH:-$uname_m}")
+if [ "${ARCHITECTURE}" = "x86_64" ]; then
+    # Redirect stderr to /dev/null to avoid printing errors if non Rosetta.
+    if [ "$(sysctl -n sysctl.proc_translated 2>/dev/null)" = "1" ]; then
+    ARCHITECTURE="arm64" # Rosetta.
+    else
+    ARCHITECTURE="amd64" # Intel.
+    fi
+elif [ "${ARCHITECTURE}" = "arm64" ] ||[ "${ARCHITECTURE}" = "aarch64" ] ; then
+    ARCHITECTURE="arm64" # Arm.
+else
+    ARCHITECTURE="amd64" # Amd.
+fi
 
-BASE_DIR=${XDG_CONFIG_HOME:-$HOME}
 
 # Run a command that should never fail. If the command fails execution
 # will immediately terminate with an error showing the failing command.
 ensure() {
   if ! "$@"; then err "command failed: $*"; fi
 }
 
-tolower() {
-  echo "$1" | awk '{print tolower($0)}'
-}
-
 # Downloads $1 into $2 or stdout
 download() {
   if [ -n "$2" ]; then
@@ -47,12 +98,35 @@ download() {
   fi
 }
 
+# Validate the network
+validate_network() {
+	declare -n __network="$1"
 
-# Colors for output
-RED='\033[0;31m'
-GREEN='\033[0;32m'
-YELLOW='\033[1;33m'
-NC='\033[0m' # No Color
+	if [[ -z "$__network" ]]; then
+		log_info "Network name is empty. Defaulting to mainnet"
+        __network="mainnet"
+	fi
+
+	if [[ -z "${SUPPORTED_NETWORKS[$__network]:-}" ]]; then
+		log_warn "Unrecognised network name: \"${__network}\".\n"
+		help 1
+	fi
+}
+
+# Validate the sync mode
+validate_sync_mode() {
+	declare -n __mode="$1"
+
+	if [[ -z "$__mode" ]]; then
+		log_info "Sync mode is empty. Defaulting to light node sync mode."
+        __mode="light"
+	fi
+
+	if [[ -z "${SUPPORTED_MODES[$__mode]:-}" ]]; then
+		log_warn "Unrecognised sync mode: \"${__mode}\".\n"
+		help 1
+	fi
+}
 
 # Log functions
 log_info() { echo -e "${GREEN}[INFO]${NC} $1"; }
@@ -64,39 +138,6 @@ command_exists() {
     command -v "$1" >/dev/null 2>&1
 }
 
-# Get platform + architecture
-uname_s=$(uname -s)
-PLATFORM=$(tolower "${OBOLUP_PLATFORM:-$uname_s}")
-EXT="tar.gz"
-case $PLATFORM in
-    linux) ;;
-    darwin|mac*)
-    PLATFORM="darwin"
-    ;;
-    mingw*|win*)
-    EXT="zip"
-    PLATFORM="win32"
-    ;;
-    *)
-    err "unsupported platform: $PLATFORM"
-    ;;
-esac
-
-uname_m=$(uname -m)
-ARCHITECTURE=$(tolower "${OBOLUP_ARCH:-$uname_m}")
-if [ "${ARCHITECTURE}" = "x86_64" ]; then
-    # Redirect stderr to /dev/null to avoid printing errors if non Rosetta.
-    if [ "$(sysctl -n sysctl.proc_translated 2>/dev/null)" = "1" ]; then
-    ARCHITECTURE="arm64" # Rosetta.
-    else
-    ARCHITECTURE="amd64" # Intel.
-    fi
-elif [ "${ARCHITECTURE}" = "arm64" ] ||[ "${ARCHITECTURE}" = "aarch64" ] ; then
-    ARCHITECTURE="arm64" # Arm.
-else
-    ARCHITECTURE="amd64" # Amd.
-fi
-
 # Ensure Docker is running
 start_docker() {
     log_info "Checking Docker..."
@@ -259,6 +300,9 @@ open_obol_agent_interface() {
 
 # Launch or update the Obol Stack
 launch_stack() {
+    declare -n __network="$1"
+    declare -n __mode="$2"
+
     log_info "Launching core Obol Stack services..."
     if ! kind get clusters | grep -q "$STACK_NAME"; then
         log_info "Creating Kind cluster for Obol Stack..."
@@ -282,8 +326,8 @@ EOF
 
     # Add the appropriate Helm repos (ethpandaops, Obol, kubernetes-dashboard)
     log_info "Adding default Obol Stack app stores..."
-    ensure helm repo add ethereum https://ethpandaops.github.io/ethereum-helm-charts
-    ensure helm repo add obol https://obolnetwork.github.io/helm-charts/
+    ensure helm repo add ethereum https://ethpandaops.github.io/ethereum-helm-charts --force-update
+    ensure helm repo add obol https://obolnetwork.github.io/helm-charts/ --force-update
     #ensure helm repo add kubernetes-dashboard https://kubernetes.github.io/dashboard/
 
     # Update helm repos
@@ -292,12 +336,17 @@ EOF
     # Deploy a Helm Release named "kubernetes-dashboard" using the kubernetes-dashboard chart
     #helm upgrade --install kubernetes-dashboard kubernetes-dashboard/kubernetes-dashboard --create-namespace --namespace kubernetes-dashboard
 
-    log_info "Configuring the Obol Stack Ethereum client..."
-    ensure helm upgrade  --namespace l1 --create-namespace --hide-notes --install l1-light-client obol/helios
-    ensure helm upgrade --namespace l1 --create-namespace --install l1-rpc ethereum/erpc --values ../values/erpc.yaml
+    log_info "Installing the Obol Stack Ethereum light client configured for $__network..."
+    ensure helm upgrade  --namespace l1 --create-namespace --hide-notes --force --install l1-light-client obol/helios -f ../values/$__network/helios.yaml
+
+    # If mode="full", also sync an Erigon full node
+    if [["$__mode" = "full"]]; then
+        log_info "Installing an Ethereum Erigon full node client..."
+        ensure helm upgrade --namespace l1 --create-namespace --install l1-erigon ethereum/erigon -f ../values/$__network/erigon.yaml
+    fi
 
-    ## Ensure Erigon later
-    # ensure helm upgrade --namespace l1 --create-namespace --install l1-erigon ethereum/erigon --values ../values/erigon.yaml
+    log_info "Installing the Obol Stack Ethereum eRPC load balancer..."
+    ensure helm upgrade --namespace l1 --create-namespace --force --install l1-rpc ethereum/erpc -f ../values/erpc.yaml
 
     # Todo(Oisin): EthpandaOps/ethereum-node not flexible enough just yet, installing clients directly with their dedicated chart
     #ensure helm upgrade --namespace l1 --create-namespace --install --set erigon.enabled=true l1-erigon ethereum/ethereum-node 
@@ -321,28 +370,61 @@ EOF
 
 # Main logic
 main() {
+    # Instantiate
+    local network=""
+	local mode=""
+    declare -i clean=0
+
+	# Parse the CLI flags
+	while [[ $# -gt 0 ]]; do
+		case "$1" in
+		--help) help 0 ;;
+		--network)
+			network="$2"
+			shift 2
+			;;
+        --mode)
+			mode="$2"
+			shift 2
+			;;
+        --clean)
+			clean=1
+			shift 1
+			;;
+        *)
+			echo "Unknown option: $1" >&2
+			help
+			;;
+		esac
+	done
+
     banner
+
+    # Parse network and sync mode
+    validate_network network
+	validate_sync_mode mode
+
     log_info "Starting obolup..."
     log_info "Detected platform: $PLATFORM"
     log_info "Detected architecture: $ARCHITECTURE"
+    log_info "Selected network: $network"
+    log_info "Selected node type: $mode"
     # start_docker
     start_docker
     install_kubectl
     install_kind
     install_helm
     #install_obol_cli
     #check_obolup_update
-    if [[ "$1" == "clean" ]]; then
+    if [[ "$clean" -ne 0 ]]; then
         log_info "Clean command specified, deleting and recreating Obol Stack resources..."
         kind delete cluster --name "$STACK_NAME"
     fi
 
-    launch_stack
+    launch_stack network mode
 
     log_info "Obol Stack is up and running!"
-
-    # Open the obol-agent interface
-    open_obol_agent_interface
+    exit 0
 }
 
 
@@ -367,5 +449,19 @@ Docs       : https://docs.obol.org/
 '
 }
 
+# Displays help text
+help() {
+	cat <<EOF
+Usage: $0 [--help] [--network <network>] [--mode <mode>] [--clean]
+
+Options:
+  --help                            Display this help message
+  --network <network>               Specify the network (default: mainnet) [mainnet, hoodi]
+  --mode <mode>                     Specify the type of sync mode (default: light) [light, full]
+  --clean                           Deletes and recreates the Obol Stack
+EOF
+	exit "${1:-1}"
+}
+
 # Run main
 main "$@"

values/erpc.yaml

@@ -11,7 +11,7 @@ image:
   # -- erpc container image repository
   repository: ghcr.io/erpc/erpc
   # -- erpc container image tag
-  tag: 0.0.43
+  tag: 0.0.50
   # -- erpc container pull policy
   pullPolicy: IfNotPresent