Add wallet.sh

Dockerfile

@@ -1,7 +1,7 @@
 FROM debian:bullseye-slim
 
 RUN apt-get update -y \
-  && apt-get install -y curl gosu \
+  && apt-get install -y curl procps procps jq \
   && apt-get clean \
   && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
 
@@ -22,4 +22,6 @@ VOLUME ["/root/.bitcoin"]
 
 RUN bitcoind -version | grep "Bitcoin Core version v${BITCOIN_VERSION}"
 
+COPY wallet.sh /opt/wallet.sh
+
 CMD ["bitcoind"]

README.md

@@ -1,3 +1,20 @@
 # bitcoin-core-docker
 
-This is a hard fork of [ruimarinho/docker-bitcoin-core](https://github.com/ruimarinho/docker-bitcoin-core) with support for new bitcoin core versions.
+This is a hard fork of [ruimarinho/docker-bitcoin-core](https://github.com/ruimarinho/docker-bitcoin-core) with support for new bitcoin core versions.
+
+## `wallet.sh`
+
+We also include a script which can start a bitcoin rpc node with a wallet in watch only mode. We require this functionality for our [observer/signer nodes](https://github.com/zeta-chain/node).
+
+This script is stored at `/opt/wallet.sh`.
+
+You should set several environment variables when running this container:
+
+| variable    | description |
+| -------- | ------- |
+| `CHAIN`       | `chain` config setting. Allowed values: main, test, testnet4, signet, regtest.   |
+| `RPC_USER`   | `rpcuser` config setting. |
+| `RPC_PASSWORD` | `rpcpassword` config setting.   |
+| `WALLET_NAME` | name of the wallet for the `createwallet` and `loadwallet` commands |
+| `WALLET_ADDRESS` | address of the wallet |
+| `NETWORK_HEIGHT_URL` | url which will return the current height of the network. Will use mempool.space if unset. |

examples/testnet4.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+docker run -d \
+  --name testnet4 \
+  -e CHAIN=testnet4 \
+  -e RPC_USER=default \
+  -e RPC_PASSWORD=default \
+  -e WALLET_NAME=default \
+  -e WALLET_ADDRESS=110yMxB69Fp5kYQtdA7lpQWZWCMna2dtjl \
+  bitcoin-core-docker /opt/wallet.sh

wallet.sh

@@ -0,0 +1,185 @@
+#!/bin/bash
+
+# set default config
+# this makes running bitcoin-cli interactively much easier
+
+echo "
+chain=${CHAIN}
+rpcuser=${RPC_USER}
+rpcpassword=${RPC_PASSWORD}
+rpcallowip=0.0.0.0/0
+
+[${CHAIN}]
+rpcbind=0.0.0.0
+">~/.bitcoin/bitcoin.conf
+
+ensure_bitcoin_is_running() {
+  process_check=`ps aux | grep -v grep | grep bitcoind`
+  if [[ -z "${process_check}" ]]; then
+    echo "Bitcoind seems to have crashed, we are going to ensure no lock exists on the process and restart the daemon."
+    remove_lock_if_exists
+    start_bitcoind_daemon
+  fi
+}
+
+check_bitcoin_is_running() {
+  process_check=`ps aux | grep -v grep | grep bitcoind`
+  echo "${process_check}"
+}
+
+remove_lock_if_exists() {
+  if [ -f "~/.bitcoin/bitcoind.pid" ]; then
+    rm -rf ~/.bitcoin/bitcoind.pid || echo "Failed to delete PID"
+  else
+    echo "PID Doesn't Exist"
+  fi
+
+  if [ -f "~/.bitcoin/${CHAIN}/.lock" ]; then
+   rm -rf ~/.bitcoin/${CHAIN}/.lock || echo "Failed to delete data lock"
+  else
+    echo "Failed to delete data lock"
+  fi
+}
+
+start_bitcoind_daemon() {
+  start_bitcoind -daemon
+}
+
+start_bitcoind() {
+  bitcoind \
+    -pid=${HOME}/.bitcoin/bitcoind.pid \
+    -listen=1 \
+    -server=1 \
+    -txindex=1 \
+    -deprecatedrpc=create_bdb \
+    -deprecatedrpc=warnings \
+    $@
+}
+
+stop_bitcoind_daemon() {
+  bitcoin_pid=$(pgrep bitcoind)
+  echo "Kill bitcoind with kill -SIGTERM"
+  kill -SIGTERM "$bitcoin_pid"
+  echo "bitcoind PID: ${bitcoin_pid}"
+  while kill -0 "$bitcoin_pid" 2> /dev/null; do
+    echo "Waiting for bitcoind process to stop."
+    check_bitcoin_is_running
+    sleep 1
+  done
+}
+
+wait_for_daemon_active() {
+  while true; do
+    check_bitcoin_is_running
+    if bitcoin-cli getblockchaininfo ; then
+      return
+    fi
+    echo "Waiting for bitcoind to start..."
+    sleep 5
+  done
+}
+
+get_current_height() {
+  if [[ -z $NETWORK_HEIGHT_URL ]]; then
+    case $CHAIN in
+      "main")
+      NETWORK_HEIGHT_URL=https://mempool.space/api/blocks/tip/height
+        ;;
+      "testnet3")
+        NETWORK_HEIGHT_URL=https://mempool.space/testnet/api/blocks/tip/height
+        ;;
+      "testnet4")
+        NETWORK_HEIGHT_URL=https://mempool.space/testnet4/api/blocks/tip/height
+        ;;
+      "signet")
+        NETWORK_HEIGHT_URL=https://mempool.space/signet/api/blocks/tip/height
+        ;;
+      *)
+        echo "Unsupported chain: $CHAIN" >&2
+        return 1
+        ;;
+    esac
+    fi
+  curl -s ${NETWORK_HEIGHT_URL}
+}
+
+wait_for_network_sync() {
+  echo "Wait until network is completely synced."
+  while true
+  do
+    network_current_block=`get_current_height || echo "No height was observed. Waiting for external network to return check height."`
+    node_current_block=`bitcoin-cli getblockchaininfo | jq -r '.blocks' || echo "No height was observed. Waiting for local network to return height."`
+    if [[ "${node_current_block}" == "${network_current_block}" ]]; then
+      echo "Bitcoin node is now synced, the local height matches external height."
+      break
+    else
+      echo "Node height: ${node_current_block} Network Height: ${network_current_block} - Network Still Syncing"
+    fi
+    sleep 30
+  done
+}
+
+load_wallet() {
+  bitcoin-cli -named createwallet wallet_name=${WALLET_NAME} disable_private_keys=true load_on_startup=true descriptors=false || echo "wallet exists"
+  sleep 5
+  bitcoin-cli loadwallet ${WALLET_NAME} || echo "wallet already loaded"
+  sleep 5
+  bitcoin-cli importaddress "${WALLET_ADDRESS}" "${WALLET_NAME}" true || echo "address already exists"
+}
+
+snapshot_restore() {
+  if [ "$SNAPSHOT_RESTORE" != "true" ]; then
+    return
+  fi
+
+  if [ -f ~/.bitcoin/extracted ]; then
+    echo "Snapshot already extracted. Skipping download and extraction."
+    return
+  fi
+
+  echo "Use restore from snapshot: $SNAPSHOT_RESTORE"
+
+  mkdir -p ~/.bitcoin/ || echo "already exists."
+  cd ~/.bitcoin/
+  rm -rf ~/.bitcoin/{$CHAIN}
+
+  curl -L "${SNAPSHOT_URL}" | tar -xzf -
+  touch ~/.bitcoin/extracted
+
+  echo "Snapshot Restored. Verify the data and folder structure."
+  echo "Bitcoin network snapshot restart process is complete."
+}
+
+
+echo "Remove Lock if Exists"
+remove_lock_if_exists
+
+echo "Check snapshot restore."
+snapshot_restore
+
+echo "Start Bitcoind Daemon"
+start_bitcoind_daemon
+
+echo "Wait for bitcoind to be active."
+wait_for_daemon_active
+
+echo "Wait for network sync."
+wait_for_network_sync
+
+echo "Ensure bitcoind is running."
+ensure_bitcoin_is_running
+
+echo "Wait for daemon active."
+wait_for_daemon_active
+
+echo "Load Wallet"
+load_wallet
+
+echo "Stop the daemon to start the non daemon forground process."
+stop_bitcoind_daemon
+
+echo "Check bitcoind is running."
+check_bitcoin_is_running
+
+echo "Start bitcoind foreground process"
+start_bitcoind