start.sh

#!/bin/bash

# Define color codes
color_success="\033[0;32m"  # green
color_danger="\033[0;31m"   # red
color_warning="\033[0;33m"  # yellow
color_debug="\033[0;34m"    # blue
color_user="\033[0;35m"  # purple

# Reset color code
color_reset="\033[0m"
choice=''

# Constants
default_xpriv_value="xprv9s21ZrQH143K3CbJXirfrtpLvhT3Vgusdo8coBritQ3rcS7Jy7sxWhatuxG5h2y1Cqj8FKmPp69536gmjYRpfga2MJdsGyBsnB12E19CESK"
default_config_file="config.start.yaml"

# Variables
servicesToRun=()
servicesToHideLogs=()
additionalFlags=()
composeFiles=("docker-compose.yml")

# Setting it globally to solve problem with passing it docker_compose_up function
name=""

function print_debug() {
  if [ "$debug" == "true" ]; then
      echo -e "${color_debug}$1${color_reset}"
  fi
}

function print_info() {
  echo -e "$1"
}

function print_success() {
  echo -e "${color_success}$1${color_reset}"
}

function print_warning() {
  echo -e "${color_warning}$1${color_reset}"
}

function print_error() {
  echo -e "${color_danger}$1${color_reset}"
}

function printPrompt() {
  echo -e "${color_user}$1${color_reset}"
}

function ask_for_value() {
    local prompt="$1"
    local prefix="$2"

    printPrompt "$prompt"
    read -p ">" choice

    if [[ -z "$choice" ]]; then
        return
    fi

    while ! [[ "$choice" =~ ^"$prefix".*$ ]]; do
      echo -e "${color_danger}Invalid value!${color_reset}"
      read -p "> " choice
      if [[ -z "$choice" ]]; then
          return
      fi
    done
}

function ask_for_choice() {
    local prompt="$1"
    local options=("${@:2}")

    printPrompt "$prompt"
    for (( i = 0; i < ${#options[@]}; i++ )); do
        echo "$((i+1)). ${options[i]}"
    done


    read -p ">" choice

    while ! [[ "$choice" =~ ^[0-9]+$ ]] || (( choice < 1 || choice > ${#options[@]} )); do
        echo -e "${color_danger}Invalid choice! Please select a valid option.${color_reset}"
        read -p "> " choice
    done
}

function ask_for_yes_or_no() {
    local prompt="$1"
    local default_value="${2:-true}"

    local default_prompt="[Y/n]"
    local inverse_default_prompt="[y/N]"

    if [[ "$default_value" == "true" ]]; then
        prompt="$prompt $default_prompt"
    elif [[ "$default_value" == "false" ]]; then
        prompt="$prompt $inverse_default_prompt"
    fi

    printPrompt "$prompt"

    local response
    read -p ">" response

    if [[ -z "$response" ]]; then
        choice="$default_value"
        return
    fi

    while ! [[ "$response" =~ ^(yes|no|y|n)$ ]]; do
        echo -e "${color_danger}Invalid response! Please enter 'yes' or 'no'.${color_reset}"
        read -p "> " response
        if [[ -z "$response" ]]; then
            choice="$default_value"
            return
        fi
    done

    if [[ "$response" =~ ^(yes|y)$ ]]; then
        choice="true"
    else
        choice="false"
    fi
}

function print_state() {
    print_debug "State:"
    print_debug "  database=${database}"
    print_debug "  cache=${cache}"
    print_debug "  spv_wallet=${spv_wallet}"
    print_debug "  block_headers_service=${block_headers_service}"
    print_debug "  wallet_frontend=${wallet_frontend}"
    print_debug "  wallet_backend=${wallet_backend}"
    print_debug "  default_xpub: $default_xpub"
    print_debug "  admin_xpub=${admin_xpub}"
    print_debug "  admin_xpriv=${admin_xpriv}"
    print_debug "  paymail_domain=${paymail_domain}"
    print_debug "  sw_config_file=${sw_config_file}"
    print_debug "  name=${name}"
    print_debug "  useDefaultName=${useDefaultName}"
    print_debug "  expose=${expose}"
    print_debug "  background=${background}"
    print_debug "  load_config=${load_config}"
    print_debug "  composeFiles=${composeFiles[*]}"
    print_debug "  debug=${debug}"
    print_debug ""
}

function load_from() {
    local key="$1"
    local variable="$2"

    if [[ -n "${!variable}" ]]; then
        return
    fi

    if [[ "$line" =~ ^("$key"=) ]]; then
        print_debug "Loading $key to variable $variable"
        value="${line#*=}"
        value="${value//\"}"
        print_debug "Value for $variable is '$value'"
        eval "$variable=\"$value\""
    fi
}

function save_to() {
  local key="$1"
  local variable="$2"

  if [[ "${!variable}" == "" ]]; then
      return
  fi

  save_value "$key" "${!variable}"
}

function save_value() {
  local key="$1"
  local value="$2"
  echo "$key=\"${value}\"" >> .env.config
}

function docker_compose_up() {
  local compose_plugin=false
  if command docker compose version &> /dev/null; then
  	compose_plugin=true
  fi

  local run="true"
  local additionalComposeFlags=($1)
  if [ -n "$name" ]; then
    additionalComposeFlags+=("--project-name $name")
  fi

  if [ "$debug" == 'true' ]; then
    echo ""
    if [ $compose_plugin == true ]; then
      print_debug "docker compose ${additionalComposeFlags[*]} up $2"
    else
      print_debug "docker-compose ${additionalComposeFlags[*]} up $2"
    fi
    echo ""
    ask_for_yes_or_no "You use debug mode. Do you want to run docker compose now?"
    run=$choice
  fi
  if [ "$run" != "true" ]; then
    return
  fi

  if [ $compose_plugin == true ]; then
    docker compose ${additionalComposeFlags[*]} up $2
  else
    docker-compose ${additionalComposeFlags[*]} up $2
  fi
}

function prefix_each() {
    local delimiter="$1"
    local result=""
    shift
    for element in "$@"; do
       result+="$delimiter $element "
    done
    echo "$result"
}

function parse_compose_additional() {
    local argument="$1"

    # Check if argument value is provided
    if [ -z "$argument" ]; then
        echo "Error: Argument for --compose-additional is missing"
        exit 1
    fi

    # Split the argument on ':' to separate file and services
    IFS=':' read -r file services <<< "$argument"

    # Append file to the list of compose files
    composeFiles+=("$file")

    # Split services by spaces and append to servicesToRun
    IFS=' ' read -r -a serviceArray <<< "$services"
    for service in "${serviceArray[@]}"; do
        servicesToRun+=("$service")
    done
}

# === LOAD FROM CLI ===

while [[ $# -gt 0 ]]; do
    key="$1"

    case $key in
        -db|--database)
        database="$2"
        shift
        ;;
        -c|--cache)
        cache="$2"
        shift
        ;;
        -sw|--spv-wallet)
        spv_wallet="$2"
        shift
        ;;
        -bhs|--block-headers-service)
        block_headers_service="$2"
        shift
        ;;
        -wf|--wallet-frontend)
        wallet_frontend="$2"
        shift
        ;;
        -wb|--wallet-backend)
        wallet_backend="$2"
        shift
        ;;
        --xpub)
        admin_xpub="$2"
        shift
        ;;
        --xprv)
        admin_xpriv="$2"
        shift
        ;;
        -pm|--paymail)
        paymail_domain="$2"
        shift
        ;;
        -a|--admin-panel)
        admin_panel="$2"
        shift
        ;;
        -e|--expose)
        expose="$2"
        shift
        ;;
        -b|--background)
        background="$2"
        shift
        ;;
        --sw-config)
        sw_config_file="$2"
        if [ "$sw_config_file" == "" ]; then
            sw_config_file="$default_config_file"
        fi
        shift
        ;;
        -ca|--compose-additional)
        parse_compose_additional "$2"
        shift
        ;;
        -l|--load)
        load_config="true"
        # no additional arguments so no `shift` command
        ;;
        -n|--name)
        name="$2"
        if [ "$name" = "" ]; then
            useDefaultName="true"
        fi
        shift
        ;;
        -d|--debug)
        debug="true"
        # no additional arguments so no `shift` command
        ;;
        -h|--help)
        echo -e "Usage: ./start.sh [OPTIONS]"
        echo ""
        echo "This script helps you to run SPV Wallet with your preferred database and cache storage."
        echo ""
        echo -e "Options:"
        echo -e "  -pm,  --paymail\t\t PayMail domain for which to run all applications"
        echo -e "  -e,   --expose\t\t Whether to expose the services PayMail domain and its subdomains - true/false"
        echo -e "  -l,   --load\t\t\t Load previously stored config from .env.config file"
        echo -e "  -b,   --background\t\t Whether the applications should be run in background - true/false"
        echo -e "  -n,   --name\t\t\t Define project name used by docker-compose - defaults to name from docker-compose.yaml"
        echo -e "  -d,   --debug\t\t\t Run in debug mode"
        echo -e "  -h,   --help\t\t\t Show this message"
        echo -e ""
        echo -e "<----------   SPV WALLET SECTION"
        echo -e "  -sw,  --spv-wallet\t\t Whether the spv-wallet should be run - true/false"
        echo -e "  -db,  --database\t\t Define database - postgresql, sqlite"
        echo -e "  -c,   --cache\t\t\t Define cache storage - freecache(in-memory), redis"
        echo -e "  --sw-config <file>\t\t Choose a custom config yaml file for configuring spv wallet - the file MUST be in subtree of call directory."
        echo -e "  \t\t\t\t Set it to empty string to set back to default (defaults to config.start.yaml)"
        echo -e "  --xpub\t\t\t Define admin xPub"
        echo ""
        echo -e "<----------   BLOCK HEADERS SERVICE SECTION"
        echo -e "  -bhs,  --block-headers-service Whether the block-headers-service should be run - true/false"
        echo ""
        echo -e "<----------   SPV WALLET COMPONENT SECTION"
        echo -e "  -wf,  --wallet-frontend\t Whether the wallet-frontend should be run - true/false"
        echo -e "  -wb,  --wallet-backend\t Whether the wallet-backend should be run - true/false"
        echo -e "  --xprv\t\t\t Define admin xPriv"
        echo ""
        echo -e "<----------   SPV WALLET ADMIN SECTION"
        echo -e "  -a,  --admin-panel\t\t Whether the spv-wallet-admin should be run - true/false"
        exit 0;
        ;;
        *)
        ;;
    esac
    shift
done

# Welcome message
echo -e "${color_user}Welcome in SPV Wallet!${color_reset}"

print_debug "Loaded config from CLI:"
print_state


# === LOAD FROM FILE ===
if [ "$load_config" == "true" ]; then
    if [ -f .env.config ]; then
        print_debug "Loading config from .env.config"

        while IFS= read -r line; do
            print_debug "Checking line '$line'"
            load_from 'SPVWALLET_DB_DATASTORE_ENGINE' database
            load_from 'SPVWALLET_CACHE_ENGINE' cache
            load_from 'RUN_SPVWALLET' spv_wallet
            load_from 'RUN_BLOCK_HEADERS_SERVICE' block_headers_service
            load_from 'RUN_SPVWALLET_FRONTEND' wallet_frontend
            load_from 'RUN_SPVWALLET_BACKEND' wallet_backend
            load_from 'RUN_PAYMAIL_DOMAIN' paymail_domain
            load_from 'RUN_EXPOSED' expose
            load_from 'RUN_IN_BACKGROUND' background
            if [ "$useDefaultName" != "true" ]; then
                load_from 'RUN_NAME' name
            fi
            load_from 'RUN_WITH_DEFAULT_XPUB' default_xpub
            load_from 'SPVWALLET_AUTH_ADMIN_KEY' admin_xpub
            load_from 'SPVWALLET_ADMIN_XPRIV' admin_xpriv
            load_from 'RUN_ADMIN_PANEL' admin_panel
            load_from 'SPVWALLET_CONFIG_FILE' sw_config_file
            # remove /config/ prefix as we're binding the volume with the config file to /config/ directory
            sw_config_file="${sw_config_file//\/config\//}"
        done < ".env.config"

        print_success "Config loaded from .env.config file"
        print_debug "Config after loading .env.config:"
        print_state
    else
        print_warning "File .env.config does not exist, but you choose to load from it."
    fi
fi

# === COLLECT CONFIG FROM USER IF NEEDED ===

# <----------   SPV WALLET SECTION
if [ "$database" == "" ]; then
    database_options=("postgresql" "sqlite")
    ask_for_choice "Select your database:" "${database_options[@]}"

    case $choice in
        1) database="postgresql";;
        2) database="sqlite";;
    esac
    print_debug "database: $database"
fi

if [ "$cache" == "" ]; then
    cache_options=("freecache" "redis")
    ask_for_choice "Select your cache storage:" "${cache_options[@]}"

    case $choice in
        1) cache="freecache";;
        2) cache="redis";;
    esac
    print_debug "cache: $cache"
fi

if [ "$spv_wallet" == "" ]; then
    ask_for_yes_or_no "Do you want to run spv-wallet?"
    spv_wallet="$choice"
    print_debug "spv_wallet: $spv_wallet"
fi

# <----------   SPV WALLET ADMIN SECTION
if [ "$admin_panel" == "" ]; then
    ask_for_yes_or_no "Do you want to run spv-wallet-admin?"
    admin_panel="$choice"
    print_debug "admin_panel: $admin_panel"
fi

# <----------   BLOCK HEADERS SERVICE SECTION
if [ "$block_headers_service" == "" ]; then
    ask_for_yes_or_no "Do you want to run block-headers-service?"
    block_headers_service="$choice"
    print_debug "block_headers_service: $block_headers_service"
fi

# <----------   SPV WALLET COMPONENT SECTION
if [ "$wallet_frontend" == "" ]; then
    ask_for_yes_or_no "Do you want to run spv-wallet-web-frontend?"
    wallet_frontend="$choice"
    print_debug "wallet_frontend: $wallet_frontend"
fi

if [ "$wallet_backend" == "" ]; then
    ask_for_yes_or_no "Do you want to run spv-wallet-web-backend?"
    wallet_backend="$choice"
    print_debug "wallet_backend: $wallet_backend"
fi

if [ "$spv_wallet" == "true" ] && [ "$admin_xpub" == "" ] && [ "$default_xpub" != "true" ]; then
    ask_for_value "Define admin xPub (Leave empty to use the default one)" 'xpub'

    if [[ -n "$choice" ]]; then
        admin_xpub=$choice
        default_xpub="false"
    else
        default_xpub="true"
    fi
    print_debug "admin_xpub: $admin_xpub"
    print_debug "default_xpub: $default_xpub"
fi

if [ "$spv_wallet" != "true" ] && [ "$wallet_backend" == "true" ] && [ "$admin_xpriv" == "" ] && [ "$default_xpub" != "true" ]; then
  ask_for_value "Define admin xPriv (Leave empty to use the default one)" 'xprv'

  if [[ -n "$choice" ]]; then
      admin_xpriv=$choice
      default_xpub="false"
  else
      default_xpub="true"
  fi
  print_debug "default_xpub: $default_xpub"
  print_debug "admin_xpriv: $admin_xpriv"
fi

if [ "$wallet_backend" == "true" ] && [ "$admin_xpriv" == "" ] && [ "$default_xpub" != "true" ]; then
  ask_for_value "Define admin xPriv (Leave empty to use the default one)" 'xprv'
  admin_xpriv=$choice
  print_debug "admin_xpriv: $admin_xpriv"
fi

if [ "$admin_panel" == "true" ] && [ "$default_xpub" == "true" ]; then
    print_warning "To login to the admin panel, you will need to provide the admin xPriv."
    print_warning "You choose to use default admin xPub, so you can use the following xPriv:"
    print_warning "$default_xpriv_value"
elif [ "$spv_wallet" == "true" ] && [ "$admin_panel" == "true" ] && [ "$default_xpub" != "true" ]; then
    print_warning "To login to the admin panel, you will need to provide the admin xPriv."
    print_warning "You choose to use custom admin xPub, therefore ensure you have xPriv for it to use in admin panel"
elif [ "$spv_wallet" != "true" ] && [ "$admin_panel" == "true" ] && [ "$default_xpub" != "true" ]; then
    print_warning "To login to the admin panel, you will need to provide the admin xPriv."
    print_warning "You choose to not start spv-wallet, therefore ensure you have xPriv for it to use in admin panel"
    print_warning "By default it should be:"
    print_warning "$default_xpriv_value"
fi

if [ "$paymail_domain" == "" ] && { [ "$wallet_backend" == "true" ] || [ "$wallet_frontend" == "true" ] || [ "$spv_wallet" == "true" ]; }; then
    ask_for_value "What PayMail domain should be configured in applications?"
    paymail_domain=$choice
    print_debug "paymail_domain: $paymail_domain"
fi

if [ "$expose" == "" ]; then
    ask_for_yes_or_no "Do you want to expose the services on $paymail_domain and its subdomains?" "false"
    expose="$choice"
    print_debug "expose: $expose"
fi

if [ "$expose" == "true" ]; then
    print_warning "Following domains/subdomains should be registered"
    print_warning "$paymail_domain => where the spv-wallet will be running"
    print_warning "wallet.$paymail_domain => where the web frontend will be running"
    print_warning "api.$paymail_domain => where the web backend will be running"
    print_warning "headers.$paymail_domain => where the block-headers-service will be running"
    print_warning "admin.$paymail_domain => where the admin panel will be running"
fi

if [ "$background" == "" ]; then
    ask_for_yes_or_no "Do you want to run everything in the background?" "false"
    background="$choice"
    print_debug "background: $background"
fi

# Set SPVWALLET_ARC_CALLBACK_HOST if paymail_domain is set
if [ -n "$paymail_domain" ]; then
    SPVWALLET_ARC_CALLBACK_HOST="https://$paymail_domain"
    print_debug "SPVWALLET_ARC_CALLBACK_HOST set to $SPVWALLET_ARC_CALLBACK_HOST"
fi

# === SAVE CONFIG ===
print_debug "Config before storing:"
print_state

# Create the .env.config file
print_debug "Creating/Cleaning .env.config file."
echo "# Used by start.sh. All unknown variables will be removed after running the script" > ".env.config"
save_to 'SPVWALLET_DB_DATASTORE_ENGINE' database
save_to 'SPVWALLET_CACHE_ENGINE' cache
save_to 'RUN_SPVWALLET' spv_wallet
save_to 'RUN_BLOCK_HEADERS_SERVICE' block_headers_service
save_to 'RUN_PAYMAIL_DOMAIN' paymail_domain
save_to 'RUN_SPVWALLET_FRONTEND' wallet_frontend
save_to 'RUN_SPVWALLET_BACKEND' wallet_backend
save_to 'RUN_EXPOSED' expose
save_to 'RUN_IN_BACKGROUND' background
save_to 'RUN_NAME' name
save_to 'RUN_WITH_DEFAULT_XPUB' default_xpub
save_to 'SPVWALLET_AUTH_ADMIN_KEY' admin_xpub
save_to 'SPVWALLET_ADMIN_XPRIV' admin_xpriv

if [ "$spv_wallet" == "true" ] && [ "$sw_config_file" == "" ]; then
    sw_config_file="$default_config_file"
    print_debug "setting sw_config_file to default: $sw_config_file"
fi

if [ "$spv_wallet" == "true" ] && [ ! -f "$sw_config_file" ]; then
    if [ "$sw_config_file" != "$default_config_file" ]; then
        print_error "Config file $sw_config_file does not exist."
        ask_for_yes_or_no "Do you want to unset config file and continue?"
        if [ "$choice" == "false" ]; then
            exit 1
        fi
    fi
    sw_config_file=""
fi

if [ "$sw_config_file" != "" ]; then
    save_value 'SPVWALLET_CONFIG_FILE' "/config/$sw_config_file"
fi

if [ "$admin_panel" == "true" ] && [ "$default_xpub" == "true" ]; then
    {
        echo "# Use the following xPriv to login to the admin panel:" >> ".env.config"
        echo "# $default_xpriv_value"
    } >> ".env.config"
elif [ "$spv_wallet" != "true" ] && [ "$admin_panel" == "true" ] && [ "$default_xpub" != "true" ]; then
    {
        echo "# You choose to not start spv-wallet, to log in to admin you need admin xPriv"
        echo "# By default it is:"
        echo "# $default_xpriv_value"
    } >> ".env.config"
fi

save_to 'RUN_ADMIN_PANEL' admin_panel
case $database in
  postgresql)
    save_value 'SPVWALLET_DB_SQL_HOST' "wallet-postgresql"
    save_value 'SPVWALLET_DB_SQL_NAME' "postgres"
    save_value 'SPVWALLET_DB_SQL_USER' "postgres"
    save_value 'SPVWALLET_DB_SQL_PASSWORD' "postgres"
  ;;
esac

if [ "$cache" == "redis" ]; then
  save_value 'SPVWALLET_CACHE_REDIS_URL' "redis://redis:6379"
fi

if [ "$spv_wallet" == "true" ]; then
  save_value 'SPVWALLET_SERVER_URL' "http://spv-wallet:3003"
  save_value 'SPVWALLET_ARC_CALLBACK_HOST' "https://$paymail_domain"
else
  save_value 'SPVWALLET_SERVER_URL' "http://host.docker.internal:3003"
fi
if [ "$wallet_backend" == "true" ]; then
  save_value 'DB_HOST' "wallet-postgresql"
fi

if [ "$block_headers_service" == "true" ]; then
  save_value 'SPVWALLET_PAYMAIL_BEEF_BLOCK_HEADERS_SERVICE_URL' "http://block-headers-service:8080/api/v1/chain/merkleroot/verify"
  save_value 'SPVWALLET_BLOCK_HEADERS_SERVICE_URL' "http://block-headers-service:8080"
else
  save_value 'SPVWALLET_PAYMAIL_BEEF_BLOCK_HEADERS_SERVICE_URL' "http://host.docker.internal:8080/api/v1/chain/merkleroot/verify"
  save_value 'SPVWALLET_BLOCK_HEADERS_SERVICE_URL' "http://host.docker.internal:8080"
fi

if [ "$expose" == "true" ]; then
  save_value 'HTTP_SERVER_CORS_ALLOWEDDOMAINS' "https://wallet.$paymail_domain"
else
  save_value 'HTTP_SERVER_CORS_ALLOWEDDOMAINS' "http://localhost:3002"
fi

print_debug "Exporting RUN_PAYMAIL_DOMAIN environment variable"
export RUN_PAYMAIL_DOMAIN="$paymail_domain"

print_success "File .env.config updated!"
print_debug "$(cat .env.config)"

# === RUN WHAT IS NEEDED ===

case $database in
  postgresql)
    servicesToRun+=("wallet-postgresql")
    servicesToHideLogs+=("wallet-postgresql")
  ;;
esac

if [ "$cache" == "redis" ]; then
  servicesToRun+=("wallet-redis")
  servicesToHideLogs+=("wallet-redis")
fi

if [ "$spv_wallet" == "true" ]; then
  servicesToRun+=("spv-wallet")
fi

if [ "$block_headers_service" == "true" ]; then
  servicesToRun+=("block-headers-service")
fi

if [ "$wallet_backend" == "true" ]; then
  servicesToRun+=("wallet-backend")
  servicesToRun+=("wallet-postgresql")
  servicesToHideLogs+=("wallet-postgresql")
fi

if [ "$wallet_frontend" == "true" ]; then
  servicesToRun+=("wallet-frontend")
  servicesToHideLogs+=("wallet-frontend")
fi

if [ "$expose" == "true" ]; then
    servicesToRun+=("wallet-gateway")
    if [ "$debug" != "true" ]; then
        servicesToHideLogs+=("wallet-gateway")
    fi
    export RUN_API_DOMAIN="api.$paymail_domain"
    export RUN_SPVWALLET_DOMAIN="$paymail_domain"
    export RUN_SECURED_PROTOCOL_SUFFIX="s"
else
    export RUN_API_DOMAIN="localhost:8180"
    export RUN_SPVWALLET_DOMAIN="localhost:3003"
    export RUN_SECURED_PROTOCOL_SUFFIX=""
fi
print_debug "Exporting following variables:"
print_debug "  RUN_API_DOMAIN=$RUN_API_DOMAIN"
print_debug "  RUN_SPVWALLET_DOMAIN=$RUN_SPVWALLET_DOMAIN"
print_debug "  RUN_SECURED_PROTOCOL_SUFFIX=$RUN_SECURED_PROTOCOL_SUFFIX"

if [ "$admin_panel" == "true" ]; then
  servicesToRun+=("spv-wallet-admin")
  servicesToHideLogs+=("spv-wallet-admin")
fi

if [ "$background" == "true" ]; then
  additionalFlags+=("-d")
fi

docker_compose_up "$(prefix_each '-f ' ${composeFiles[*]})" "${servicesToRun[*]} ${additionalFlags[*]} $(prefix_each '--no-attach ' ${servicesToHideLogs[*]})"