#!/usr/bin/env bash set -euo pipefail # Sends a `zcash-cli` command to a Zebra and zcashd instance, # and compares the results. # # Uses the configured `zcash-cli` RPC port, # and the `zebrad` port supplied on the command-line. function usage() { echo "Usage:" echo "$0 zebra-rpc-port rpc-name [rpc-args... ]" } # Override the commands used by this script using these environmental variables: ZCASH_CLI="${ZCASH_CLI:-zcash-cli}" DIFF="${DIFF:-diff --unified --color=always}" JQ="${JQ:-jq}" if [ $# -lt 2 ]; then usage exit 1 fi ZEBRAD_RPC_PORT=$1 shift ZCASH_RPC_TMP_DIR=$(mktemp -d) ZEBRAD_RELEASE_INFO="$ZCASH_RPC_TMP_DIR/first-check-getinfo.json" ZCASHD_RELEASE_INFO="$ZCASH_RPC_TMP_DIR/second-check-getinfo.json" echo "Checking first node release info..." $ZCASH_CLI -rpcport="$ZEBRAD_RPC_PORT" getinfo > "$ZEBRAD_RELEASE_INFO" ZEBRAD=$(cat "$ZEBRAD_RELEASE_INFO" | grep '"subversion"' | cut -d: -f2 | cut -d/ -f2 | \ tr 'A-Z' 'a-z' | sed 's/magicbean/zcashd/ ; s/zebra$/zebrad/') echo "Checking second node release info..." $ZCASH_CLI getinfo > "$ZCASHD_RELEASE_INFO" ZCASHD=$(cat "$ZCASHD_RELEASE_INFO" | grep '"subversion"' | cut -d: -f2 | cut -d/ -f2 | \ tr 'A-Z' 'a-z' | sed 's/magicbean/zcashd/ ; s/zebra$/zebrad/') echo "Connected to $ZEBRAD (port $ZEBRAD_RPC_PORT) and $ZCASHD ($ZCASH_CLI zcash.conf port)." echo ZEBRAD_BLOCKCHAIN_INFO="$ZCASH_RPC_TMP_DIR/$ZEBRAD-check-getblockchaininfo.json" ZCASHD_BLOCKCHAIN_INFO="$ZCASH_RPC_TMP_DIR/$ZCASHD-check-getblockchaininfo.json" echo "Checking $ZEBRAD network and tip height..." $ZCASH_CLI -rpcport="$ZEBRAD_RPC_PORT" getblockchaininfo > "$ZEBRAD_BLOCKCHAIN_INFO" ZEBRAD_NET=$(cat "$ZEBRAD_BLOCKCHAIN_INFO" | grep '"chain"' | cut -d: -f2 | tr -d ' ,"') ZEBRAD_HEIGHT=$(cat "$ZEBRAD_BLOCKCHAIN_INFO" | grep '"blocks"' | cut -d: -f2 | tr -d ' ,"') echo "Checking $ZCASHD network and tip height..." $ZCASH_CLI getblockchaininfo > "$ZCASHD_BLOCKCHAIN_INFO" ZCASHD_NET=$(cat "$ZCASHD_BLOCKCHAIN_INFO" | grep '"chain"' | cut -d: -f2 | tr -d ' ,"') ZCASHD_HEIGHT=$(cat "$ZCASHD_BLOCKCHAIN_INFO" | grep '"blocks"' | cut -d: -f2 | tr -d ' ,"') echo if [ "$ZEBRAD_NET" != "$ZCASHD_NET" ]; then echo "WARNING: comparing RPC responses from different networks:" echo "$ZCASHD is on: $ZCASHD_NET" echo "$ZEBRAD is on: $ZEBRAD_NET" echo fi if [ "$ZEBRAD_HEIGHT" -ne "$ZCASHD_HEIGHT" ]; then echo "WARNING: comparing RPC responses from different heights:" echo "$ZCASHD is at: $ZCASHD_HEIGHT" echo "$ZEBRAD is at: $ZEBRAD_HEIGHT" echo fi ZEBRAD_RESPONSE="$ZCASH_RPC_TMP_DIR/$ZEBRAD-$ZEBRAD_NET-$ZEBRAD_HEIGHT-$1.json" ZCASHD_RESPONSE="$ZCASH_RPC_TMP_DIR/$ZCASHD-$ZCASHD_NET-$ZCASHD_HEIGHT-$1.json" echo "Request:" echo "$@" echo echo "Querying $ZEBRAD $ZEBRAD_NET chain at height >=$ZEBRAD_HEIGHT..." $ZCASH_CLI -rpcport="$ZEBRAD_RPC_PORT" "$@" > "$ZEBRAD_RESPONSE" echo "Querying $ZCASHD $ZCASHD_NET chain at height >=$ZCASHD_HEIGHT..." $ZCASH_CLI "$@" > "$ZCASHD_RESPONSE" echo echo "Response diff between $ZCASHD and $ZEBRAD:" $DIFF "$ZEBRAD_RESPONSE" "$ZCASHD_RESPONSE" \ && ( \ echo "RPC responses were identical"; \ echo ; \ echo "$ZEBRAD_RESPONSE:"; \ cat "$ZEBRAD_RESPONSE"; \ ) EXIT_STATUS=$? # Consistency checks between RPCs # # TODO: # - sum of getaddressutxos.satoshis equals getaddressbalance # - set of getaddressutxos.txid is a subset of getaddresstxids 1 # - getblockchaininfo.bestblockhash equals getbestblockhash if [ "$1" == "getaddressutxos" ]; then set "getaddressbalance" "$2" else exit $EXIT_STATUS fi ZEBRAD_CHECK_RESPONSE="$ZCASH_RPC_TMP_DIR/$ZEBRAD-$ZEBRAD_NET-$ZEBRAD_HEIGHT-$1.json" ZCASHD_CHECK_RESPONSE="$ZCASH_RPC_TMP_DIR/$ZCASHD-$ZCASHD_NET-$ZCASHD_HEIGHT-$1.json" echo echo "Cross-checking request:" echo "$@" echo echo "Querying $ZEBRAD $ZEBRAD_NET chain at height >=$ZEBRAD_HEIGHT..." $ZCASH_CLI -rpcport="$ZEBRAD_RPC_PORT" "$@" > "$ZEBRAD_CHECK_RESPONSE" echo "Querying $ZCASHD $ZCASHD_NET chain at height >=$ZCASHD_HEIGHT..." $ZCASH_CLI "$@" > "$ZCASHD_CHECK_RESPONSE" echo echo "$1 diff between $ZCASHD and $ZEBRAD:" $DIFF "$ZEBRAD_CHECK_RESPONSE" "$ZCASHD_CHECK_RESPONSE" \ && ( \ echo "RPC check responses were identical"; \ echo ; \ echo "$ZEBRAD_CHECK_RESPONSE:"; \ cat "$ZEBRAD_CHECK_RESPONSE"; \ ) CHECK_EXIT_STATUS=$? if [ "$1" == "getaddressbalance" ]; then echo echo "Extracting getaddressbalance.balance..." ZEBRAD_NUM_RESPONSE="$ZCASH_RPC_TMP_DIR/$ZEBRAD-$ZEBRAD_NET-$ZEBRAD_HEIGHT-getaddressbalance-num.txt" ZCASHD_NUM_RESPONSE="$ZCASH_RPC_TMP_DIR/$ZCASHD-$ZCASHD_NET-$ZCASHD_HEIGHT-getaddressbalance-num.txt" cat "$ZEBRAD_CHECK_RESPONSE" | $JQ '.balance' > "$ZEBRAD_NUM_RESPONSE" cat "$ZCASHD_CHECK_RESPONSE" | $JQ '.balance' > "$ZCASHD_NUM_RESPONSE" echo "Summing getaddressutxos.satoshis..." ZEBRAD_SUM_RESPONSE="$ZCASH_RPC_TMP_DIR/$ZEBRAD-$ZEBRAD_NET-$ZEBRAD_HEIGHT-getaddressutxos-sum.txt" ZCASHD_SUM_RESPONSE="$ZCASH_RPC_TMP_DIR/$ZCASHD-$ZCASHD_NET-$ZCASHD_HEIGHT-getaddressutxos-sum.txt" cat "$ZEBRAD_RESPONSE" | $JQ 'map(.satoshis) | add // 0' > "$ZEBRAD_SUM_RESPONSE" cat "$ZCASHD_RESPONSE" | $JQ 'map(.satoshis) | add // 0' > "$ZCASHD_SUM_RESPONSE" echo echo "Balance diff between $ZCASHD and $ZEBRAD:" echo "(for both getaddressbalance and getaddressutxos)" $DIFF --from-file="$ZEBRAD_NUM_RESPONSE" "$ZCASHD_NUM_RESPONSE" \ "$ZEBRAD_SUM_RESPONSE" "$ZCASHD_SUM_RESPONSE" \ && ( \ echo "RPC balances were identical"; \ echo ; \ echo "$ZEBRAD_NUM_RESPONSE:"; \ cat "$ZEBRAD_NUM_RESPONSE"; \ ) COMPARE_EXIT_STATUS=$? if [ $COMPARE_EXIT_STATUS -ne 0 ]; then exit $COMPARE_EXIT_STATUS fi fi if [ $EXIT_STATUS -ne 0 ]; then exit $EXIT_STATUS else exit $CHECK_EXIT_STATUS fi