topologyUpdate

#!/bin/bash
# shellcheck disable=SC2086,SC2034
# shellcheck source=/dev/null

# https://vaneyckt.io/posts/safer_bash_scripts_with_set_euxo_pipefail
set -eo pipefail

# This is borrowed from https://github.com/cardano-community/guild-operators
# and mainly just removes the auto-update of the script itself
#
# i.e. we want a stable/known version of this script
#
# Also, this is hopefully only a temporary thing until
# the node can take care about it's p2p2 updates itself

######################################
# User Variables - Change as desired #
######################################

#CNODE_HOSTNAME="CHANGE ME" # (Optional) Must resolve to the IP you are requesting from
#CUSTOM_PEERS="None"        # *Additional* custom peers to (IP,port[,valency]) to add to your target topology.json
                            # eg: "10.0.0.1,3001|10.0.0.2,3002|relays.mydomain.com,3003,3"

CNODE_VALENCY=1             # (Optional) for multi-IP hostnames
MAX_PEERS=15                # Maximum number of peers to return on successful fetch

CARDANO_ENV="/usr/local/bin/env"

if [[ ! -f ${CARDANO_ENV} ]]; then
  echo "[Error] Generated env file missing: ${CARDANO_ENV}"
  echo "This is a mandatory prerequisite\n"
  exit 1
fi

# source generated env variables
if ! source ${CARDANO_ENV}; then
  echo "[Error] Cannot source: ${CARDANO_ENV}"
  exit 1;
fi

# NetworkMagic extracted from the genesis file
NWMAGIC=$(jq -r .networkMagic < ${GENESIS_JSON})

# Installed by pkgs.cacert
# https://curl.se/docs/sslcerts.html
export CURL_CA_BUNDLE="/etc/ssl/certs/ca-bundle.crt"

######################################
# Do NOT modify code below           #
######################################

usage() {
  cat <<EOF
Usage: $(basename "$0") [-f] [-p] [-l]
Topology Updater - Build topology with community pools

-f    Disable fetch of a fresh topology file
-p    Disable node alive push to Topology Updater API
-l    Enable an endless topology update loop (one call per hour)

EOF
  exit 1
}

TU_FETCH='Y'
TU_PUSH='Y'
LOOP='N'

while getopts :fpl opt; do
  case ${opt} in
    f ) TU_FETCH='N' ;;
    p ) TU_PUSH='N' ;;
    l ) LOOP='Y' ;;
    \? ) usage ;;
  esac
done
shift $((OPTIND -1))

# Description : Helper function to validate that input is a number
#             : $1 = number
isNumber() {
  [[ -z $1 ]] && return 1
  [[ $1 =~ ^[0-9]+$ ]] && return 0 || return 1
}

# Description : Helper function to validate IPv4 address
#             : $1 = IP
isValidIPv4() {
  local ip=$1
  [[ -z ${ip} ]] && return 1
  if [[ ${ip} =~ ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$ || ${ip} =~ ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])$ ]]; then
    return 0
  fi
  return 1
}

# Description : Helper function to validate IPv6 address, works for normal IPv6 addresses, not dual incl IPv4
#             : $1 = IP
isValidIPv6() {
  local ip=$1
  [[ -z ${ip} ]] && return 1
  ipv6_regex="^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$"
  [[ ${ip} =~ ${ipv6_regex} ]] && return 0
  return 1
}

if [[ ${CNODE_HOSTNAME} != "" ]]; then
  T_HOSTNAME="&hostname=${CNODE_HOSTNAME}"
else
  T_HOSTNAME=''
fi

#####################################################################
#
# Fetch the current block number from the EKG endpoint
#
fetchBlockNumber () {

  fail_cnt=0
  while ! blockNo=$(curl -s -m ${EKG_TIMEOUT} -H 'Accept: application/json' "http://${EKG_HOST}:${EKG_PORT}/" 2>/dev/null | jq -er '.cardano.node.metrics.blockNum.int.val //0' ); do
    ((fail_cnt++))
    if [[ ${fail_cnt} -eq 5 ]]; then echo "5 consecutive EKG queries failed, aborting!"; exit 1; fi
    echo "(${fail_cnt}/5) Failed to grab blockNum from node EKG metrics, sleeping for 30s before retrying..."
    sleep 30
  done
}

#####################################################################
#
# Push the node config info to the topology endpoint
#
# If you run your node in IPv4/IPv6 dual stack network configuration and want announced the
# IPv4 address only please add the -4 parameter to the curl command below  (curl -4 -s ...)
pushNodeInfo () {

  if [[ ${TU_PUSH} = "Y" ]]; then

      echo "[`date +'%Y-%m-%d %H:%M:%S %Z'`] Updating topology ..."

      fetchBlockNumber

      echo "curl -s -f https://api.clio.one/htopology/v1/?port=${CNODE_PORT}&blockNo=${blockNo}&valency=${CNODE_VALENCY}&magic=${NWMAGIC}${T_HOSTNAME}"
      curl -s -f "https://api.clio.one/htopology/v1/?port=${CNODE_PORT}&blockNo=${blockNo}&valency=${CNODE_VALENCY}&magic=${NWMAGIC}${T_HOSTNAME}" | \
        tee -a ${LOG_DIR}/topologyUpdateResult
  else

    echo "[Warning] Topology update push disabled"
  fi
}

#####################################################################
#
# Fetch the next topology update
#
fetchTopology () {

  if [[ ${TU_FETCH} = "Y" ]]; then

    echo "curl -s -f https://api.clio.one/htopology/v1/fetch/?max=${MAX_PEERS}&magic=${NWMAGIC}"
    curl -s -f -o ${TOPOLOGY}.tmp "https://api.clio.one/htopology/v1/fetch/?max=${MAX_PEERS}&magic=${NWMAGIC}" \
      && cat ${TOPOLOGY}.tmp

    # Check if old style CUSTOM_PEERS with colon separator is used, if so convert to use commas
    if [[ -n ${CUSTOM_PEERS} && ${CUSTOM_PEERS} != *","* ]]; then
      CUSTOM_PEERS=${CUSTOM_PEERS//[:]/,}
    fi

    if [[ -n "${CUSTOM_PEERS}" ]]; then
      topo="$(cat "${TOPOLOGY}".tmp)"
      IFS='|' read -ra cpeers <<< "${CUSTOM_PEERS}"
      for cpeer in "${cpeers[@]}"; do
        IFS=',' read -ra cpeer_attr <<< "${cpeer}"
        case ${#cpeer_attr[@]} in
          2) addr="${cpeer_attr[0]}"
             port=${cpeer_attr[1]}
             valency=1 ;;
          3) addr="${cpeer_attr[0]}"
             port=${cpeer_attr[1]}
             valency=${cpeer_attr[2]} ;;
          *) echo "ERROR: Invalid Custom Peer definition '${cpeer}'. Please double check CUSTOM_PEERS definition"
             exit 1 ;;
        esac
        if [[ ${addr} = *.* ]]; then
          ! isValidIPv4 "${addr}" && echo "ERROR: Invalid IPv4 address or hostname '${addr}'. Please check CUSTOM_PEERS definition" && continue
        elif [[ ${addr} = *:* ]]; then
          ! isValidIPv6 "${addr}" && echo "ERROR: Invalid IPv6 address '${addr}'. Please check CUSTOM_PEERS definition" && continue
        fi
        ! isNumber ${port} && echo "ERROR: Invalid port number '${port}'. Please check CUSTOM_PEERS definition" && continue
        ! isNumber ${valency} && echo "ERROR: Invalid valency number '${valency}'. Please check CUSTOM_PEERS definition" && continue
        topo=$(jq '.Producers += [{"addr": $addr, "port": $port|tonumber, "valency": $valency|tonumber}]' --arg addr "${addr}" --arg port ${port} --arg valency ${valency} <<< "${topo}")
      done
      echo "${topo}" | jq -r . >/dev/null 2>&1 && echo "${topo}" > "${TOPOLOGY}".tmp
    fi
    mv ${TOPOLOGY}.tmp ${TOPOLOGY} && echo "Topology updated: ${TOPOLOGY}"
  else
    echo "[Warning] Topology update fetch disabled"
  fi
}

##########################################################################################################################################
#
# Run a single topology update cycle
#
if [[ ${LOOP} = "N" ]]; then
    pushNodeInfo
    fetchTopology
    exit 0
fi

##########################################################################################################################################
#
# Run an endless topology update loop
#

MIN=`date +"%-M"`
INITIAL_WAIT=5
MIN=$(($MIN + $INITIAL_WAIT))
if (( $MIN > 59 )); then MIN=$(($MIN - 60)); fi

CRONJOB="$MIN * * * * root topologyUpdate"
echo "Topology update: $CRONJOB"

sleep $(($INITIAL_WAIT * 60))

while true; do
  # Allow each ef these to fail
  pushNodeInfo || true
  fetchTopology || true
  sleep 3600
done

echo "[Warning] Exiting topology update loop"