interactive_regtest.sh 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330
  1. #!/usr/bin/env bash
  2. # Interactive Regtest Environment for CDK
  3. # This script sets up the regtest environment and keeps it running for interaction
  4. set -e
  5. # Function to wait for HTTP endpoint
  6. wait_for_endpoint() {
  7. local url=$1
  8. local timeout=${2:-60}
  9. local start_time=$(date +%s)
  10. while true; do
  11. local current_time=$(date +%s)
  12. local elapsed_time=$((current_time - start_time))
  13. if [ $elapsed_time -ge $timeout ]; then
  14. echo "❌ Timeout waiting for $url"
  15. return 1
  16. fi
  17. local http_status=$(curl -o /dev/null -s -w "%{http_code}" "$url" 2>/dev/null || echo "000")
  18. if [ "$http_status" -eq 200 ]; then
  19. echo "✓ $url is ready"
  20. return 0
  21. fi
  22. sleep 2
  23. done
  24. }
  25. # Function to perform cleanup
  26. cleanup() {
  27. echo "Cleaning up..."
  28. # Remove state file for other sessions
  29. rm -f "/tmp/cdk_regtest_env"
  30. if [ ! -z "$CDK_MINTD_PID" ] && kill -0 $CDK_MINTD_PID 2>/dev/null; then
  31. echo "Killing the cdk mintd (CLN)"
  32. kill -2 $CDK_MINTD_PID
  33. wait $CDK_MINTD_PID
  34. fi
  35. if [ ! -z "$CDK_MINTD_LND_PID" ] && kill -0 $CDK_MINTD_LND_PID 2>/dev/null; then
  36. echo "Killing the cdk mintd (LND)"
  37. kill -2 $CDK_MINTD_LND_PID
  38. wait $CDK_MINTD_LND_PID
  39. fi
  40. if [ ! -z "$CDK_REGTEST_PID" ] && kill -0 $CDK_REGTEST_PID 2>/dev/null; then
  41. echo "Killing the cdk regtest"
  42. kill -2 $CDK_REGTEST_PID
  43. wait $CDK_REGTEST_PID
  44. fi
  45. echo "Environment terminated"
  46. # Remove the temporary directory
  47. if [ ! -z "$CDK_ITESTS_DIR" ]; then
  48. rm -rf "$CDK_ITESTS_DIR"
  49. echo "Temp directory removed: $CDK_ITESTS_DIR"
  50. fi
  51. # Unset all environment variables
  52. unset CDK_ITESTS_DIR
  53. unset CDK_ITESTS_MINT_ADDR
  54. unset CDK_ITESTS_MINT_PORT_0
  55. unset CDK_ITESTS_MINT_PORT_1
  56. unset CDK_MINTD_DATABASE
  57. unset CDK_TEST_MINT_URL
  58. unset CDK_TEST_MINT_URL_2
  59. unset CDK_MINTD_URL
  60. unset CDK_MINTD_WORK_DIR
  61. unset CDK_MINTD_LISTEN_HOST
  62. unset CDK_MINTD_LISTEN_PORT
  63. unset CDK_MINTD_LN_BACKEND
  64. unset CDK_MINTD_MNEMONIC
  65. unset CDK_MINTD_CLN_RPC_PATH
  66. unset CDK_MINTD_LND_ADDRESS
  67. unset CDK_MINTD_LND_CERT_FILE
  68. unset CDK_MINTD_LND_MACAROON_FILE
  69. unset CDK_MINTD_PID
  70. unset CDK_MINTD_LND_PID
  71. unset CDK_REGTEST_PID
  72. unset RUST_BACKTRACE
  73. unset CDK_TEST_REGTEST
  74. }
  75. # Set up trap to call cleanup on script exit
  76. trap cleanup EXIT
  77. export CDK_TEST_REGTEST=1
  78. # Check for mprocs and offer to install if missing
  79. if ! command -v mprocs >/dev/null 2>&1; then
  80. echo "⚠️ mprocs not found - this tool provides a nice TUI for monitoring logs"
  81. echo "Install it with: cargo install mprocs"
  82. echo
  83. read -p "Would you like to install mprocs now? (y/n): " -n 1 -r
  84. echo
  85. if [[ $REPLY =~ ^[Yy]$ ]]; then
  86. echo "Installing mprocs..."
  87. cargo install mprocs
  88. if [ $? -eq 0 ]; then
  89. echo "✓ mprocs installed successfully"
  90. else
  91. echo "❌ Failed to install mprocs. You can install it later with: cargo install mprocs"
  92. fi
  93. else
  94. echo "Skipping mprocs installation. The environment will work without it."
  95. fi
  96. echo
  97. fi
  98. # Parse command line arguments
  99. CDK_MINTD_DATABASE=${1:-"sqlite"} # Default to sqlite if not specified
  100. # Create a temporary directory
  101. export CDK_ITESTS_DIR=$(mktemp -d)
  102. export CDK_ITESTS_MINT_ADDR="127.0.0.1"
  103. export CDK_ITESTS_MINT_PORT_0=8085
  104. export CDK_ITESTS_MINT_PORT_1=8087
  105. # Check if the temporary directory was created successfully
  106. if [[ ! -d "$CDK_ITESTS_DIR" ]]; then
  107. echo "Failed to create temp directory"
  108. exit 1
  109. fi
  110. echo "=============================================="
  111. echo "Starting Interactive CDK Regtest Environment"
  112. echo "=============================================="
  113. echo "Temp directory: $CDK_ITESTS_DIR"
  114. echo "Database type: $CDK_MINTD_DATABASE"
  115. echo
  116. export CDK_MINTD_DATABASE="$CDK_MINTD_DATABASE"
  117. # Build the necessary binaries
  118. echo "Building binaries..."
  119. cargo build -p cdk-integration-tests --bin start_regtest
  120. echo "Starting regtest network (Bitcoin + Lightning nodes)..."
  121. cargo run --bin start_regtest &
  122. export CDK_REGTEST_PID=$!
  123. # Create named pipe for progress tracking
  124. mkfifo "$CDK_ITESTS_DIR/progress_pipe"
  125. rm -f "$CDK_ITESTS_DIR/signal_received"
  126. # Start reading from pipe in background
  127. (while read line; do
  128. case "$line" in
  129. "checkpoint1")
  130. echo "✓ Regtest network is ready"
  131. touch "$CDK_ITESTS_DIR/signal_received"
  132. exit 0
  133. ;;
  134. esac
  135. done < "$CDK_ITESTS_DIR/progress_pipe") &
  136. # Wait for regtest setup (up to 120 seconds)
  137. echo "Waiting for regtest network to be ready..."
  138. for ((i=0; i<120; i++)); do
  139. if [ -f "$CDK_ITESTS_DIR/signal_received" ]; then
  140. break
  141. fi
  142. sleep 1
  143. done
  144. if [ ! -f "$CDK_ITESTS_DIR/signal_received" ]; then
  145. echo "❌ Timeout waiting for regtest network"
  146. exit 1
  147. fi
  148. echo
  149. echo "Starting CDK Mint #1 (CLN backend)..."
  150. export CDK_MINTD_CLN_RPC_PATH="$CDK_ITESTS_DIR/cln/one/regtest/lightning-rpc"
  151. export CDK_MINTD_URL="http://$CDK_ITESTS_MINT_ADDR:$CDK_ITESTS_MINT_PORT_0"
  152. export CDK_MINTD_WORK_DIR="$CDK_ITESTS_DIR/cln_mint"
  153. export CDK_MINTD_LISTEN_HOST=$CDK_ITESTS_MINT_ADDR
  154. export CDK_MINTD_LISTEN_PORT=$CDK_ITESTS_MINT_PORT_0
  155. export CDK_MINTD_LN_BACKEND="cln"
  156. export CDK_MINTD_MNEMONIC="eye survey guilt napkin crystal cup whisper salt luggage manage unveil loyal"
  157. export RUST_BACKTRACE=1
  158. mkdir -p "$CDK_MINTD_WORK_DIR"
  159. cargo run --bin cdk-mintd > "$CDK_MINTD_WORK_DIR/mintd.log" 2>&1 &
  160. export CDK_MINTD_PID=$!
  161. # Wait for CLN mint to be ready
  162. echo "Waiting for CLN mint to be ready..."
  163. URL="http://$CDK_ITESTS_MINT_ADDR:$CDK_ITESTS_MINT_PORT_0/v1/info"
  164. wait_for_endpoint "$URL" 60
  165. echo
  166. echo "Starting CDK Mint #2 (LND backend)..."
  167. export CDK_MINTD_LND_ADDRESS="https://localhost:10010"
  168. export CDK_MINTD_LND_CERT_FILE="$CDK_ITESTS_DIR/lnd/two/tls.cert"
  169. export CDK_MINTD_LND_MACAROON_FILE="$CDK_ITESTS_DIR/lnd/two/data/chain/bitcoin/regtest/admin.macaroon"
  170. export CDK_MINTD_URL="http://$CDK_ITESTS_MINT_ADDR:$CDK_ITESTS_MINT_PORT_1"
  171. mkdir -p "$CDK_ITESTS_DIR/lnd_mint"
  172. export CDK_MINTD_WORK_DIR="$CDK_ITESTS_DIR/lnd_mint"
  173. export CDK_MINTD_LISTEN_HOST=$CDK_ITESTS_MINT_ADDR
  174. export CDK_MINTD_LISTEN_PORT=$CDK_ITESTS_MINT_PORT_1
  175. export CDK_MINTD_LN_BACKEND="lnd"
  176. export CDK_MINTD_MNEMONIC="cattle gold bind busy sound reduce tone addict baby spend february strategy"
  177. cargo run --bin cdk-mintd > "$CDK_MINTD_WORK_DIR/mintd.log" 2>&1 &
  178. export CDK_MINTD_LND_PID=$!
  179. # Wait for LND mint to be ready
  180. echo "Waiting for LND mint to be ready..."
  181. URL="http://$CDK_ITESTS_MINT_ADDR:$CDK_ITESTS_MINT_PORT_1/v1/info"
  182. wait_for_endpoint "$URL" 60
  183. # Set environment variables for easy access
  184. export CDK_TEST_MINT_URL="http://$CDK_ITESTS_MINT_ADDR:$CDK_ITESTS_MINT_PORT_0"
  185. export CDK_TEST_MINT_URL_2="http://$CDK_ITESTS_MINT_ADDR:$CDK_ITESTS_MINT_PORT_1"
  186. # Create state file for other terminal sessions
  187. ENV_FILE="/tmp/cdk_regtest_env"
  188. echo "export CDK_ITESTS_DIR=\"$CDK_ITESTS_DIR\"" > "$ENV_FILE"
  189. echo "export CDK_TEST_MINT_URL=\"$CDK_TEST_MINT_URL\"" >> "$ENV_FILE"
  190. echo "export CDK_TEST_MINT_URL_2=\"$CDK_TEST_MINT_URL_2\"" >> "$ENV_FILE"
  191. echo "export CDK_MINTD_PID=\"$CDK_MINTD_PID\"" >> "$ENV_FILE"
  192. echo "export CDK_MINTD_LND_PID=\"$CDK_MINTD_LND_PID\"" >> "$ENV_FILE"
  193. echo "export CDK_REGTEST_PID=\"$CDK_REGTEST_PID\"" >> "$ENV_FILE"
  194. echo
  195. echo "=============================================="
  196. echo "🎉 CDK Regtest Environment is Ready!"
  197. echo "=============================================="
  198. echo
  199. echo "Network Information:"
  200. echo " • Bitcoin RPC: 127.0.0.1:18443 (user: testuser, pass: testpass)"
  201. echo " • CLN Node 1: $CDK_ITESTS_DIR/cln/one/regtest/lightning-rpc"
  202. echo " • CLN Node 2: $CDK_ITESTS_DIR/cln/two/regtest/lightning-rpc"
  203. echo " • LND Node 1: https://localhost:10009"
  204. echo " • LND Node 2: https://localhost:10010"
  205. echo
  206. echo "CDK Mints:"
  207. echo " • CLN Mint: $CDK_TEST_MINT_URL"
  208. echo " • LND Mint: $CDK_TEST_MINT_URL_2"
  209. echo
  210. echo "Files and Directories:"
  211. echo " • Working Directory: $CDK_ITESTS_DIR"
  212. echo " • CLN Mint Logs: $CDK_ITESTS_DIR/cln_mint/mintd.log"
  213. echo " • LND Mint Logs: $CDK_ITESTS_DIR/lnd_mint/mintd.log"
  214. echo " • LND 1 TLS Cert: $CDK_ITESTS_DIR/lnd/one/tls.cert"
  215. echo " • LND 1 Macaroon: $CDK_ITESTS_DIR/lnd/one/data/chain/bitcoin/regtest/admin.macaroon"
  216. echo " • LND 2 TLS Cert: $CDK_ITESTS_DIR/lnd/two/tls.cert"
  217. echo " • LND 2 Macaroon: $CDK_ITESTS_DIR/lnd/two/data/chain/bitcoin/regtest/admin.macaroon"
  218. echo
  219. echo "Environment Variables (available in other terminals):"
  220. echo " • CDK_TEST_MINT_URL=\"$CDK_TEST_MINT_URL\""
  221. echo " • CDK_TEST_MINT_URL_2=\"$CDK_TEST_MINT_URL_2\""
  222. echo " • CDK_ITESTS_DIR=\"$CDK_ITESTS_DIR\""
  223. echo
  224. echo "You can now:"
  225. echo " • Use 'just' commands in other terminals: 'just ln-cln1 getinfo'"
  226. echo " • Run integration tests: 'just mint-test' or 'cargo test -p cdk-integration-tests'"
  227. echo " • Use CDK CLI tools with the mint URLs above"
  228. echo " • Interact with Lightning nodes directly"
  229. echo " • Access Bitcoin regtest node"
  230. echo
  231. echo "State File: /tmp/cdk_regtest_env (allows other terminals to find this environment)"
  232. echo
  233. echo "Starting mprocs to monitor logs..."
  234. echo "Press 'q' to quit mprocs and stop the environment"
  235. echo "=============================================="
  236. # Create mprocs configuration
  237. MPROCS_CONFIG="$CDK_ITESTS_DIR/mprocs.yaml"
  238. cat > "$MPROCS_CONFIG" << EOF
  239. procs:
  240. cln-mint:
  241. shell: "touch $CDK_ITESTS_DIR/cln_mint/mintd.log && tail -f $CDK_ITESTS_DIR/cln_mint/mintd.log"
  242. autostart: true
  243. lnd-mint:
  244. shell: "touch $CDK_ITESTS_DIR/lnd_mint/mintd.log && tail -f $CDK_ITESTS_DIR/lnd_mint/mintd.log"
  245. autostart: true
  246. bitcoind:
  247. shell: "touch $CDK_ITESTS_DIR/bitcoin/regtest/debug.log && tail -f $CDK_ITESTS_DIR/bitcoin/regtest/debug.log"
  248. autostart: true
  249. cln-one:
  250. shell: "while [ ! -f $CDK_ITESTS_DIR/cln/one/regtest/log ]; do sleep 1; done && tail -f $CDK_ITESTS_DIR/cln/one/regtest/log"
  251. autostart: true
  252. cln-two:
  253. shell: "while [ ! -f $CDK_ITESTS_DIR/cln/two/regtest/log ]; do sleep 1; done && tail -f $CDK_ITESTS_DIR/cln/two/regtest/log"
  254. autostart: true
  255. lnd-one:
  256. shell: "while [ ! -f $CDK_ITESTS_DIR/lnd/one/logs/bitcoin/regtest/lnd.log ]; do sleep 1; done && tail -f $CDK_ITESTS_DIR/lnd/one/logs/bitcoin/regtest/lnd.log"
  257. autostart: true
  258. lnd-two:
  259. shell: "while [ ! -f $CDK_ITESTS_DIR/lnd/two/logs/bitcoin/regtest/lnd.log ]; do sleep 1; done && tail -f $CDK_ITESTS_DIR/lnd/two/logs/bitcoin/regtest/lnd.log"
  260. autostart: true
  261. settings:
  262. mouse_scroll_speed: 3
  263. proc_list_width: 20
  264. hide_keymap_window: false
  265. EOF
  266. # Wait a bit for log files to be created
  267. sleep 2
  268. # Start mprocs to show all logs
  269. if command -v mprocs >/dev/null 2>&1; then
  270. cd "$CDK_ITESTS_DIR"
  271. mprocs --config "$MPROCS_CONFIG"
  272. else
  273. echo "⚠️ mprocs not found. Install it with: cargo install mprocs"
  274. echo "Falling back to simple wait loop..."
  275. echo "Press Ctrl+C to stop the environment"
  276. # Keep the script running
  277. while true; do
  278. sleep 1
  279. done
  280. fi