common.sh

#!/usr/bin/env bash

# -u: Treat unset variables as an error when substituting.
# -o pipefail: The return value of a pipeline is the status of the last command to exit with a non-zero status, or zero if no command exited with a non-zero status.
set -uo pipefail
trap 's=$?; error "$0: Error on line "$LINENO": $BASH_COMMAND"; exit $s' ERR

# =============================================================================
#                               GLOBAL VARIABLES
# =============================================================================

# If not defined, set to default values
SEDA_BINARY=${SEDA_BINARY:-"sedad"}
TXN_GAS_FLAGS=${TXN_GAS_FLAGS:-"--gas-prices 0.1aseda --gas auto --gas-adjustment 1.6"}
SLEEP_TIME=${SLEEP_TIME:-10}

# =============================================================================
#                               COMMON FUNCTIONS
# =============================================================================

# Checks if the script/function was given the correct number of arguments
# Usage: usage CALLER EXPECTED_NUM_OF_ARGS NUM_OF_ARGS ARG_NAME_1 ARG_NAME_2 ... ARG_NAME_N
usage() {
	local caller=$1
	local expected_num_args=$2
	local actual_num_args=$3 # This will be the count of arguments actually passed to the calling function.
	shift 3
	if [ "${actual_num_args}" -ne "${expected_num_args}" ]; then
		echo -n "Usage: $caller"
		while (("$#")); do
			echo -n " <$1>"
			shift
		done
		echo
		exit 1
	fi
}

# Checks if the script/function was given the correct number of arguments variadic
# Usage: usage CALLER MINUM_ARGS NUM_OF_ARGS ARG_NAME_1 ARG_NAME_2 ... ARG_NAME_N
usage_variadic() {
	caller=$1
	min_args=$2
	actual_args=$3
	shift 3
	if [ "${actual_args}" -lt "${min_args}" ]; then
		echo -n "Usage: $caller"
		while (("$#")); do
			echo -n " <$1>"
			shift
		done
		echo
		exit 1
	fi
}

# Prints an error message to stderr
# Usage: error "Error message"
error() {
	usage "${FUNCNAME[0]}" 1 "$#" "ERROR_MESSAGE"
	printf "\033[31mERROR: \033[0m%s\n" "$1" >&2
}

# Checks if command(s) exists on the sytem
# Usage: check_commands COMMAND_NAME_1 COMMAND_NAME_2 ... COMMAND_NAME_N
check_commands() {
	usage_variadic "${FUNCNAME[0]}" 1 "$#" "COMMAND_NAMES"
	local command_names=("$@")
	local command_unset=false
	for command_name in "${command_names[@]}"; do
		if ! command -v ${command_name} >/dev/null 2>&1; then
			error "Command \`${command_name}\` not found."
			command_unset=true
		fi
	done
	[ "$command_unset" = "true" ] && exit 1

	return 0
}

# Checks if env vars are set
# Usage: check_env_vars VAR_NAME_1 VAR_NAME_2 ... VAR_NAME_N
check_env_vars() {
	usage_variadic "${FUNCNAME[0]}" 1 "$#" "VAR_NAMES"
	local var_names=("$@")
	local var_unset=false
	for var_name in "${var_names[@]}"; do
		[ -z "${!var_name+x}" ] && error "$var_name must be defined" && var_unset=true
	done
	[ "$var_unset" = "true" ] && exit 1

	return 0
}

# Pushes shell variables to a .env file
# Usage: update_env_file VAR_NAME VALUE
update_env_file() {
	usage "${FUNCNAME[0]}" 2 "$#" "VAR_NAME" "VALUE"
	local variable_name="$1"
	local value="$2"

	echo "# $(date)" >>../.env
	echo "$variable_name=$value" >>../.env
}