Add Bitcoin Knots

bitcoin-knots/docker-compose.yml

@@ -0,0 +1,78 @@
+version: "3.7"
+
+services:
+  app_proxy:
+    environment:
+      APP_HOST: $APP_BITCOIN_IP
+      APP_PORT: 3005
+  
+  server:
+    image: retropexx/umbrel-bitcoin-knots:v0.5.0
+    depends_on: [bitcoind]
+    restart: on-failure
+    volumes:
+      - ${APP_DATA_DIR}/data/app:/data # volume to persist advanced settings json
+      - ${APP_BITCOIN_DATA_DIR}:/bitcoin/.bitcoin # volume to persist umbrel-bitcoin.conf and bitcoin.conf
+    environment:
+      PORT: "3005"
+      BITCOIN_HOST: "${APP_BITCOIN_NODE_IP}"
+      RPC_PORT: "${APP_BITCOIN_RPC_PORT}"
+      BITCOIN_RPC_PORT: "${APP_BITCOIN_RPC_PORT}"
+      RPC_USER: "${APP_BITCOIN_RPC_USER}"
+      BITCOIN_RPC_USER: "${APP_BITCOIN_RPC_USER}"
+      RPC_PASSWORD: "${APP_BITCOIN_RPC_PASS}"
+      BITCOIN_RPC_PASSWORD: "${APP_BITCOIN_RPC_PASS}"
+      BITCOIN_RPC_HIDDEN_SERVICE: "${APP_BITCOIN_RPC_HIDDEN_SERVICE}"
+      BITCOIN_P2P_HIDDEN_SERVICE: "${APP_BITCOIN_P2P_HIDDEN_SERVICE}"
+      BITCOIN_P2P_PORT: "${APP_BITCOIN_P2P_PORT}"
+      DEVICE_DOMAIN_NAME: "${DEVICE_DOMAIN_NAME}"
+      BITCOIN_DEFAULT_NETWORK: "${BITCOIN_DEFAULT_NETWORK:-mainnet}"
+      BITCOIN_INITIALIZE_WITH_CLEARNET_OVER_TOR: "${BITCOIN_INITIALIZE_WITH_CLEARNET_OVER_TOR:-unset}"
+      BITCOIND_IP: "${APP_BITCOIN_NODE_IP}"
+      TOR_PROXY_IP: "${APP_BITCOIN_TOR_PROXY_IP}"
+      TOR_PROXY_PORT: "9050"
+      TOR_PROXY_CONTROL_PORT: "9051"
+      TOR_PROXY_CONTROL_PASSWORD: "moneyprintergobrrr"
+      I2P_DAEMON_IP: "${APP_BITCOIN_I2P_DAEMON_IP}"
+      I2P_DAEMON_PORT: "7656"
+    networks:
+      default:
+        ipv4_address: $APP_BITCOIN_IP
+
+  bitcoind:
+    image: retropexx/bitcoind:v25.1
+    command: "${APP_BITCOIN_COMMAND}"
+    restart: unless-stopped
+    stop_grace_period: 15m30s
+    volumes:
+      - "${APP_BITCOIN_DATA_DIR}:/data/.bitcoin"
+    ports:
+      - "${APP_BITCOIN_P2P_PORT}:${APP_BITCOIN_P2P_PORT}"
+      - "${APP_BITCOIN_RPC_PORT}:${APP_BITCOIN_RPC_PORT}"
+    networks:
+      default:
+        ipv4_address: $APP_BITCOIN_NODE_IP
+
+  tor:
+    image: getumbrel/tor:0.4.7.8@sha256:2ace83f22501f58857fa9b403009f595137fa2e7986c4fda79d82a8119072b6a
+    user: "1000:1000"
+    restart: on-failure
+    volumes:
+      - ${APP_DATA_DIR}/torrc:/etc/tor/torrc:ro
+      - ${TOR_DATA_DIR}:/data
+    environment:
+      HOME: "/tmp"
+    networks:
+      default:
+        ipv4_address: "${APP_BITCOIN_TOR_PROXY_IP}"
+  
+  i2pd_daemon:
+    image: purplei2p/i2pd:release-2.44.0@sha256:d154a599793c393cf9c91f8549ba7ece0bb40e5728e1813aa6dd4c210aa606f6
+    user: "root"
+    command: --sam.enabled=true --sam.address=0.0.0.0 --sam.port=7656 --loglevel=error
+    restart: on-failure
+    volumes:
+      - ${APP_DATA_DIR}/data/i2pd:/home/i2pd/data
+    networks:
+      default:
+        ipv4_address: "${APP_BITCOIN_I2P_DAEMON_IP}"

bitcoin-knots/exports.sh

@@ -0,0 +1,153 @@
+export APP_BITCOIN_IP="10.21.22.2"
+export APP_BITCOIN_NODE_IP="10.21.21.8"
+export APP_BITCOIN_TOR_PROXY_IP="10.21.22.10"
+export APP_BITCOIN_I2P_DAEMON_IP="10.21.22.11"
+
+export APP_BITCOIN_DATA_DIR="${EXPORTS_APP_DIR}/data/bitcoin"
+export APP_BITCOIN_RPC_PORT="8332"
+export APP_BITCOIN_P2P_PORT="8333"
+export APP_BITCOIN_TOR_PORT="8334"
+export APP_BITCOIN_ZMQ_RAWBLOCK_PORT="28332"
+export APP_BITCOIN_ZMQ_RAWTX_PORT="28333"
+export APP_BITCOIN_ZMQ_HASHBLOCK_PORT="28334"
+export APP_BITCOIN_ZMQ_SEQUENCE_PORT="28335"
+
+BITCOIN_CHAIN="main"
+BITCOIN_ENV_FILE="${EXPORTS_APP_DIR}/.env"
+
+{
+	BITCOIN_APP_CONFIG_FILE="${EXPORTS_APP_DIR}/data/app/bitcoin-config.json"
+	if [[ -f "${BITCOIN_APP_CONFIG_FILE}" ]]
+	then
+		bitcoin_app_network=$(jq -r '.network' "${BITCOIN_APP_CONFIG_FILE}")
+		case $bitcoin_app_network in
+			"main")
+				BITCOIN_NETWORK="mainnet";;
+			"test")
+				BITCOIN_NETWORK="testnet";;
+			"signet")
+				BITCOIN_NETWORK="signet";;
+			"regtest")
+				BITCOIN_NETWORK="regtest";;
+		esac
+	fi
+} > /dev/null || true
+
+if [[ ! -f "${BITCOIN_ENV_FILE}" ]]; then
+	if [[ -z "${BITCOIN_NETWORK}" ]]; then
+		BITCOIN_NETWORK="mainnet"
+	fi
+	
+	if [[ -z ${BITCOIN_RPC_USER+x} ]] || [[ -z ${BITCOIN_RPC_PASS+x} ]] || [[ -z ${BITCOIN_RPC_AUTH+x} ]]; then
+		BITCOIN_RPC_USER="umbrel"
+		BITCOIN_RPC_DETAILS=$("${EXPORTS_APP_DIR}/scripts/rpcauth.py" "${BITCOIN_RPC_USER}")
+		BITCOIN_RPC_PASS=$(echo "$BITCOIN_RPC_DETAILS" | tail -1)
+		BITCOIN_RPC_AUTH=$(echo "$BITCOIN_RPC_DETAILS" | head -2 | tail -1 | sed -e "s/^rpcauth=//")
+	fi
+
+	echo "export APP_BITCOIN_NETWORK='${BITCOIN_NETWORK}'"		>  "${BITCOIN_ENV_FILE}"
+	echo "export APP_BITCOIN_RPC_USER='${BITCOIN_RPC_USER}'"	>> "${BITCOIN_ENV_FILE}"
+	echo "export APP_BITCOIN_RPC_PASS='${BITCOIN_RPC_PASS}'"	>> "${BITCOIN_ENV_FILE}"
+	echo "export APP_BITCOIN_RPC_AUTH='${BITCOIN_RPC_AUTH}'"	>> "${BITCOIN_ENV_FILE}"
+fi
+
+. "${BITCOIN_ENV_FILE}"
+
+# Make sure we don't persist the original value in .env if we have a more recent
+# value from the app config
+{
+	if [[ ! -z ${BITCOIN_NETWORK+x} ]] && [[ "${BITCOIN_NETWORK}" ]] && [[ "${APP_BITCOIN_NETWORK}" ]]
+	then
+		APP_BITCOIN_NETWORK="${BITCOIN_NETWORK}"
+	fi
+} > /dev/null || true
+
+if [[ "${APP_BITCOIN_NETWORK}" == "mainnet" ]]; then
+	BITCOIN_CHAIN="main"
+elif [[ "${APP_BITCOIN_NETWORK}" == "testnet" ]]; then
+	BITCOIN_CHAIN="test"
+	# export APP_BITCOIN_RPC_PORT="18332"
+	# export APP_BITCOIN_P2P_PORT="18333"
+	# export APP_BITCOIN_TOR_PORT="18334"
+elif [[ "${APP_BITCOIN_NETWORK}" == "signet" ]]; then
+	BITCOIN_CHAIN="signet"
+	# export APP_BITCOIN_RPC_PORT="38332"
+	# export APP_BITCOIN_P2P_PORT="38333"
+	# export APP_BITCOIN_TOR_PORT="38334"
+elif [[ "${APP_BITCOIN_NETWORK}" == "regtest" ]]; then
+	BITCOIN_CHAIN="regtest"
+	# export APP_BITCOIN_RPC_PORT="18443"
+	# export APP_BITCOIN_P2P_PORT="18444"
+	# export APP_BITCOIN_TOR_PORT="18445"
+else
+	echo "Warning (${EXPORTS_APP_ID}): Bitcoin Network '${APP_BITCOIN_NETWORK}' is not supported"
+fi
+
+export BITCOIN_DEFAULT_NETWORK="${BITCOIN_CHAIN}"
+
+BIN_ARGS=()
+# Commenting out options that are replaced by generated config file. We should migrate all these over in a future update.
+# BIN_ARGS+=( "-chain=${BITCOIN_CHAIN}" )
+# BIN_ARGS+=( "-proxy=${TOR_PROXY_IP}:${TOR_PROXY_PORT}" )
+# BIN_ARGS+=( "-listen" )
+# BIN_ARGS+=( "-bind=0.0.0.0:${APP_BITCOIN_TOR_PORT}=onion" )
+# BIN_ARGS+=( "-bind=${APP_BITCOIN_NODE_IP}" )
+# BIN_ARGS+=( "-port=${APP_BITCOIN_P2P_PORT}" )
+# BIN_ARGS+=( "-rpcport=${APP_BITCOIN_RPC_PORT}" )
+BIN_ARGS+=( "-port=8333" )
+BIN_ARGS+=( "-rpcport=8332" )
+BIN_ARGS+=( "-rpcbind=${APP_BITCOIN_NODE_IP}" )
+BIN_ARGS+=( "-rpcbind=127.0.0.1" )
+BIN_ARGS+=( "-rpcallowip=${NETWORK_IP}/16" )
+BIN_ARGS+=( "-rpcallowip=127.0.0.1" )
+BIN_ARGS+=( "-rpcauth=\"${APP_BITCOIN_RPC_AUTH}\"" )
+BIN_ARGS+=( "-zmqpubrawblock=tcp://0.0.0.0:${APP_BITCOIN_ZMQ_RAWBLOCK_PORT}" )
+BIN_ARGS+=( "-zmqpubrawtx=tcp://0.0.0.0:${APP_BITCOIN_ZMQ_RAWTX_PORT}" )
+BIN_ARGS+=( "-zmqpubhashblock=tcp://0.0.0.0:${APP_BITCOIN_ZMQ_HASHBLOCK_PORT}" )
+BIN_ARGS+=( "-zmqpubsequence=tcp://0.0.0.0:${APP_BITCOIN_ZMQ_SEQUENCE_PORT}" )
+# BIN_ARGS+=( "-txindex=1" )
+# BIN_ARGS+=( "-blockfilterindex=1" )
+# BIN_ARGS+=( "-peerbloomfilters=1" )
+# BIN_ARGS+=( "-peerblockfilters=1" )
+# BIN_ARGS+=( "-rpcworkqueue=128" )
+
+export APP_BITCOIN_COMMAND=$(IFS=" "; echo "${BIN_ARGS[@]}")
+
+# echo "${APP_BITCOIN_COMMAND}"
+
+rpc_hidden_service_file="${EXPORTS_TOR_DATA_DIR}/app-${EXPORTS_APP_ID}-rpc/hostname"
+p2p_hidden_service_file="${EXPORTS_TOR_DATA_DIR}/app-${EXPORTS_APP_ID}-p2p/hostname"
+export APP_BITCOIN_RPC_HIDDEN_SERVICE="$(cat "${rpc_hidden_service_file}" 2>/dev/null || echo "notyetset.onion")"
+export APP_BITCOIN_P2P_HIDDEN_SERVICE="$(cat "${p2p_hidden_service_file}" 2>/dev/null || echo "notyetset.onion")"
+
+# electrs compatible network param
+export APP_BITCOIN_NETWORK_ELECTRS=$APP_BITCOIN_NETWORK
+if [[ "${APP_BITCOIN_NETWORK_ELECTRS}" = "mainnet" ]]; then
+	APP_BITCOIN_NETWORK_ELECTRS="bitcoin"
+fi
+
+{
+	# Migrate settings for app updates differently to fresh installs
+	BITCOIN_DATA_DIR="${EXPORTS_APP_DIR}/data/bitcoin"
+	IS_POST_ADVANCED_SETTINGS_INSTALL_FILE_PATH="${EXPORTS_APP_DIR}/data/app/IS_POST_ADVANCED_SETTINGS_INSTALL"
+
+	# If no blocks directory exists, we write out a file to indicate that this is a fresh install.
+	# This gets around the issue of the pre-start hook starting up the bitcoind container early for Tor HS creation
+	# and creating the blocks directory.
+	if [[ ! -d "${BITCOIN_DATA_DIR}/blocks" ]] && [[ ! -d "${BITCOIN_DATA_DIR}/testnet3/blocks" ]] && [[ ! -d "${BITCOIN_DATA_DIR}/regtest/blocks" ]]
+	then
+		touch "${IS_POST_ADVANCED_SETTINGS_INSTALL_FILE_PATH}"
+	fi
+
+	APP_CONFIG_EXISTS="false"
+	if [[ -f "${EXPORTS_APP_DIR}/data/app/bitcoin-config.json" ]]
+	then
+		APP_CONFIG_EXISTS="true"
+	fi
+
+	if [[ ! -f "${IS_POST_ADVANCED_SETTINGS_INSTALL_FILE_PATH}" ]] && [[ "${APP_CONFIG_EXISTS}" = "false" ]]
+	then
+		# This app is not a fresh install, it's being updated, so preserve existing clearnet over Tor setting
+		export BITCOIN_INITIALIZE_WITH_CLEARNET_OVER_TOR="true"
+	fi
+} || true

bitcoin-knots/hooks/pre-start

@@ -0,0 +1,26 @@
+#!/usr/bin/env bash
+
+# Delay booting Bitcoin until the RPC and P2P Tor Hidden Services are ready
+
+HIDDEN_SERVICE_FILE="${TOR_DATA_DIR}/app-${APP_ID}-rpc/hostname"
+
+if [[ -f "${HIDDEN_SERVICE_FILE}" ]]; then
+	exit
+fi
+
+"${UMBREL_ROOT}/scripts/app" compose "${APP_ID}" up --detach bitcoind
+"${UMBREL_ROOT}/scripts/app" compose "${APP_ID}" up --detach tor
+
+echo "App: ${APP_ID} - Generating Tor Hidden Service..."
+
+for attempt in $(seq 1 100); do
+	if [[ -f "${HIDDEN_SERVICE_FILE}" ]]; then
+		echo "App: ${APP_ID} - Hidden service file created successfully!"
+		break
+	fi
+	sleep 0.1
+done
+
+if [[ ! -f "${HIDDEN_SERVICE_FILE}" ]]; then
+	echo "App: ${APP_ID} - Hidden service file wasn't created"
+fi

bitcoin-knots/scripts/rpcauth.py

@@ -0,0 +1,46 @@
+#!/usr/bin/env python3
+# Copyright (c) 2015-2018 The Bitcoin Core developers
+# Distributed under the MIT software license, see the accompanying
+# file COPYING or http://www.opensource.org/licenses/mit-license.php.
+
+from argparse import ArgumentParser
+from base64 import urlsafe_b64encode
+from binascii import hexlify
+from getpass import getpass
+from os import urandom
+
+import hmac
+
+def generate_salt(size):
+    """Create size byte hex salt"""
+    return hexlify(urandom(size)).decode()
+
+def generate_password():
+    """Create 32 byte b64 password"""
+    return urlsafe_b64encode(urandom(32)).decode('utf-8')
+
+def password_to_hmac(salt, password):
+    m = hmac.new(bytearray(salt, 'utf-8'), bytearray(password, 'utf-8'), 'SHA256')
+    return m.hexdigest()
+
+def main():
+    parser = ArgumentParser(description='Create login credentials for a JSON-RPC user')
+    parser.add_argument('username', help='the username for authentication')
+    parser.add_argument('password', help='leave empty to generate a random password or specify "-" to prompt for password', nargs='?')
+    args = parser.parse_args()
+
+    if not args.password:
+        args.password = generate_password()
+    elif args.password == '-':
+        args.password = getpass()
+
+    # Create 16 byte hex salt
+    salt = generate_salt(16)
+    password_hmac = password_to_hmac(salt, args.password)
+
+    print('String to be appended to bitcoin.conf:')
+    print('rpcauth={0}:{1}${2}'.format(args.username, salt, password_hmac))
+    print('Your password:\n{0}'.format(args.password))
+
+if __name__ == '__main__':
+    main()

bitcoin-knots/torrc.template

@@ -0,0 +1,13 @@
+SocksPort 0.0.0.0:9050
+ControlPort 0.0.0.0:9051
+CookieAuthentication 1
+CookieAuthFileGroupReadable 1
+HashedControlPassword 16:39AF5EEFA4FC1D986022FDFB13663669FE50FB6DE9A3B4FE4FC7D82010 # moneyprintergobrrr
+
+# Bitcoin Core P2P Hidden Service
+HiddenServiceDir /data/app-$APP_ID-p2p
+HiddenServicePort $APP_BITCOIN_P2P_PORT $APP_BITCOIN_NODE_IP:$APP_BITCOIN_TOR_PORT
+
+# Bitcoin Core RPC Hidden Service
+HiddenServiceDir /data/app-$APP_ID-rpc
+HiddenServicePort $APP_BITCOIN_RPC_PORT $APP_BITCOIN_NODE_IP:$APP_BITCOIN_RPC_PORT

bitcoin-knots/umbrel-app.yml

@@ -0,0 +1,56 @@
+manifestVersion: 1.1
+id: bitcoin
+category: bitcoin
+name: Bitcoin Knots
+version: "25.1"
+tagline: Run your personal node powered by Bitcoin Knots
+description: >-
+  Run your Bitcoin node and independently store and validate
+  every single Bitcoin transaction with it. Achieve unparalleled
+  privacy by connecting your wallet directly to your node to
+  ensure that your wallet company can’t spy on your transactions,
+  or worse — lie to you.
+
+
+  Plus, transacting with your own node also helps keep the entire
+  Bitcoin network decentralized; win-win!
+
+
+  With over 20 advanced settings, you can take control of your node
+  and customize it to your needs. Control how your node connects to
+  other nodes over Tor, clearnet, and I2P, adjust your daily upload
+  limit, set the maximum mempool size, fine-tune its performance,
+  and much more.
+
+
+  Don't trust. Verify. On steroids.
+developer: Luke Dashjr
+website: https://bitcoinknots.org
+dependencies: []
+repo: https://github.com/bitcoinknots/bitcoin.git
+support: https://github.com/bitcoinknots/bitcoin/issues
+port: 2100
+gallery:
+  - 1.jpg
+  - 2.jpg
+  - 3.jpg
+  - 4.jpg
+  - 5.jpg
+path: ""
+defaultPassword: ""
+releaseNotes: >-
+  What's new in Bitcoin Knots version 25.1?
+
+
+  - P2P and network changes
+
+  - Security fixes
+
+  - New and updated RPCs
+  
+  - and more!
+
+
+  Read the full release notes for additional information and detailed changes at https://github.com/bitcoinknots/bitcoin/blob/v25.1.knots20231115/doc/release-notes.md
+submitter: Léo Haf
+submission: to update.