mirror of
https://github.com/Ride-The-Lightning/RTL.git
synced 2026-08-13 12:33:07 +02:00
b790dc7abf
The fixture had only bitcoind + three LND nodes, so RTL's Core Lightning screens
had no backend to exercise. Add a `cln` node (official elementsproject/lightningd
image, multi-arch) wired to RTL over clnrest with rune auth, and have the seed
open a cln->alice channel so the CLN channel/peer screens have real data.
- docker-compose.yml: cln service (clnrest on 0.0.0.0:3010, https), a healthcheck
gated on the rune file so rtl waits for it, and rtl now mounts the cln volume
read-only and depends on cln being healthy. The rtl image is parameterized via
${RTL_IMAGE:-...} so an unreleased build can be tested against the fixture.
- cln/poststart.d/create-rune.sh: once the RPC is up, create a master rune and
write it as LIGHTNING_RUNE="..." where RTL reads it (runePath). Polls for RPC
readiness because the image entrypoint can invoke poststart before the socket
exists.
- RTL-Config.regtest.json: add node index 4 (CLN, rune auth, https://cln:3010).
- seed.sh: fund cln, connect to alice, open a 4,000,000 sat channel, wait active.
- README + release notes updated.
Used to verify the CLN channel connection-status fix (#1606) end-to-end.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
230 lines
8.1 KiB
YAML
230 lines
8.1 KiB
YAML
# Regtest dev fixture for RTL: bitcoind + 3 LND nodes + RTL.
|
|
#
|
|
# NOT suitable for production. All credentials are throwaway.
|
|
#
|
|
# Topology is alice -> bob -> carol, so bob forwards payments and RTL's
|
|
# routing/forwarding screens have data in them. See README.md.
|
|
#
|
|
# Node images come from Polar (https://lightningpolar.com), which publishes
|
|
# multi-arch (amd64 + arm64) builds. Nothing is built locally.
|
|
|
|
volumes:
|
|
bitcoind_data:
|
|
alice_data:
|
|
bob_data:
|
|
carol_data:
|
|
cln_data:
|
|
rtl_db:
|
|
rtl_config:
|
|
|
|
x-lnd: &lnd
|
|
image: polarlightning/lnd:0.20.0-beta
|
|
restart: unless-stopped
|
|
depends_on:
|
|
- bitcoind
|
|
|
|
services:
|
|
bitcoind:
|
|
container_name: ${COMPOSE_PROJECT_NAME}_bitcoind
|
|
image: polarlightning/bitcoind:30.0
|
|
restart: unless-stopped
|
|
command:
|
|
- bitcoind
|
|
- -server=1
|
|
- -regtest=1
|
|
# rpcauth hash for ${BITCOIN_RPC_USER}/${BITCOIN_RPC_PASSWORD}. '$$' escapes
|
|
# compose interpolation and reaches bitcoind as a single '$'.
|
|
- -rpcauth=rtldev:8a1f2c3d4e5b6a7c8d9e0f1a2b3c4d5e$$010df4b32c5e9a556cba1857eb5865990c983d8a56dadc0fdbf457cf90073c6c
|
|
- -zmqpubrawblock=tcp://0.0.0.0:${BITCOIN_ZMQ_BLOCK_PORT}
|
|
- -zmqpubrawtx=tcp://0.0.0.0:${BITCOIN_ZMQ_TX_PORT}
|
|
- -txindex=1
|
|
- -dnsseed=0
|
|
- -rpcbind=0.0.0.0
|
|
- -rpcallowip=0.0.0.0/0
|
|
- -rpcport=${BITCOIN_RPC_PORT}
|
|
- -listen=1
|
|
- -listenonion=0
|
|
- -fallbackfee=0.0002
|
|
ports:
|
|
- "${BITCOIN_RPC_PORT}:${BITCOIN_RPC_PORT}"
|
|
volumes:
|
|
- bitcoind_data:/home/bitcoin/.bitcoin
|
|
|
|
# --alias / --externalip / --tlsextradomain are per-node on purpose: the alias
|
|
# is what RTL displays, and the extradomain must match the hostname RTL dials
|
|
# (https://alice:8080) or TLS validation fails.
|
|
alice:
|
|
<<: *lnd
|
|
container_name: ${COMPOSE_PROJECT_NAME}_alice
|
|
command:
|
|
- lnd
|
|
- --noseedbackup
|
|
- --trickledelay=5000
|
|
- --alias=alice
|
|
- --externalip=alice
|
|
- --tlsextradomain=alice
|
|
- --tlsextradomain=${COMPOSE_PROJECT_NAME}_alice
|
|
- --tlsextradomain=host.docker.internal
|
|
- --listen=0.0.0.0:${LIGHTNING_P2P_PORT}
|
|
- --rpclisten=0.0.0.0:${LIGHTNING_RPC_PORT}
|
|
- --restlisten=0.0.0.0:${LIGHTNING_REST_PORT}
|
|
- --bitcoin.active
|
|
- --bitcoin.regtest
|
|
- --bitcoin.node=bitcoind
|
|
- --bitcoind.rpchost=${BITCOIN_HOST}:${BITCOIN_RPC_PORT}
|
|
- --bitcoind.rpcuser=${BITCOIN_RPC_USER}
|
|
- --bitcoind.rpcpass=${BITCOIN_RPC_PASSWORD}
|
|
- --bitcoind.zmqpubrawblock=tcp://${BITCOIN_HOST}:${BITCOIN_ZMQ_BLOCK_PORT}
|
|
- --bitcoind.zmqpubrawtx=tcp://${BITCOIN_HOST}:${BITCOIN_ZMQ_TX_PORT}
|
|
- --accept-keysend
|
|
- --accept-amp
|
|
ports:
|
|
- "${ALICE_REST_PORT}:${LIGHTNING_REST_PORT}"
|
|
volumes:
|
|
- alice_data:/home/lnd/.lnd
|
|
|
|
bob:
|
|
<<: *lnd
|
|
container_name: ${COMPOSE_PROJECT_NAME}_bob
|
|
command:
|
|
- lnd
|
|
- --noseedbackup
|
|
- --trickledelay=5000
|
|
- --alias=bob
|
|
- --externalip=bob
|
|
- --tlsextradomain=bob
|
|
- --tlsextradomain=${COMPOSE_PROJECT_NAME}_bob
|
|
- --tlsextradomain=host.docker.internal
|
|
- --listen=0.0.0.0:${LIGHTNING_P2P_PORT}
|
|
- --rpclisten=0.0.0.0:${LIGHTNING_RPC_PORT}
|
|
- --restlisten=0.0.0.0:${LIGHTNING_REST_PORT}
|
|
- --bitcoin.active
|
|
- --bitcoin.regtest
|
|
- --bitcoin.node=bitcoind
|
|
- --bitcoind.rpchost=${BITCOIN_HOST}:${BITCOIN_RPC_PORT}
|
|
- --bitcoind.rpcuser=${BITCOIN_RPC_USER}
|
|
- --bitcoind.rpcpass=${BITCOIN_RPC_PASSWORD}
|
|
- --bitcoind.zmqpubrawblock=tcp://${BITCOIN_HOST}:${BITCOIN_ZMQ_BLOCK_PORT}
|
|
- --bitcoind.zmqpubrawtx=tcp://${BITCOIN_HOST}:${BITCOIN_ZMQ_TX_PORT}
|
|
- --accept-keysend
|
|
- --accept-amp
|
|
ports:
|
|
- "${BOB_REST_PORT}:${LIGHTNING_REST_PORT}"
|
|
volumes:
|
|
- bob_data:/home/lnd/.lnd
|
|
|
|
carol:
|
|
<<: *lnd
|
|
container_name: ${COMPOSE_PROJECT_NAME}_carol
|
|
command:
|
|
- lnd
|
|
- --noseedbackup
|
|
- --trickledelay=5000
|
|
- --alias=carol
|
|
- --externalip=carol
|
|
- --tlsextradomain=carol
|
|
- --tlsextradomain=${COMPOSE_PROJECT_NAME}_carol
|
|
- --tlsextradomain=host.docker.internal
|
|
- --listen=0.0.0.0:${LIGHTNING_P2P_PORT}
|
|
- --rpclisten=0.0.0.0:${LIGHTNING_RPC_PORT}
|
|
- --restlisten=0.0.0.0:${LIGHTNING_REST_PORT}
|
|
- --bitcoin.active
|
|
- --bitcoin.regtest
|
|
- --bitcoin.node=bitcoind
|
|
- --bitcoind.rpchost=${BITCOIN_HOST}:${BITCOIN_RPC_PORT}
|
|
- --bitcoind.rpcuser=${BITCOIN_RPC_USER}
|
|
- --bitcoind.rpcpass=${BITCOIN_RPC_PASSWORD}
|
|
- --bitcoind.zmqpubrawblock=tcp://${BITCOIN_HOST}:${BITCOIN_ZMQ_BLOCK_PORT}
|
|
- --bitcoind.zmqpubrawtx=tcp://${BITCOIN_HOST}:${BITCOIN_ZMQ_TX_PORT}
|
|
- --accept-keysend
|
|
- --accept-amp
|
|
ports:
|
|
- "${CAROL_REST_PORT}:${LIGHTNING_REST_PORT}"
|
|
volumes:
|
|
- carol_data:/home/lnd/.lnd
|
|
|
|
# Core Lightning node. Unlike the LND nodes it talks to RTL over clnrest (the
|
|
# built-in REST plugin) using rune auth, so it needs --clnrest-* options and a
|
|
# rune written where RTL can read it. The entrypoint runs scripts dropped in
|
|
# lightning-poststart.d once the RPC socket is up; create-rune.sh generates the
|
|
# rune there and writes it to /root/.lightning/rtl.rune (RTL mounts that read-only).
|
|
# --clnrest-host=0.0.0.0 is required so the rtl container can reach it; the default
|
|
# 127.0.0.1 would only be reachable from inside this container. Protocol stays https
|
|
# (clnrest default, self-signed) — RTL connects with rejectUnauthorized:false.
|
|
cln:
|
|
image: elementsproject/lightningd:v25.09
|
|
container_name: ${COMPOSE_PROJECT_NAME}_cln
|
|
restart: unless-stopped
|
|
depends_on:
|
|
- bitcoind
|
|
environment:
|
|
LIGHTNINGD_NETWORK: regtest
|
|
command:
|
|
- --alias=cln
|
|
- --bitcoin-rpcconnect=${BITCOIN_HOST}
|
|
- --bitcoin-rpcport=${BITCOIN_RPC_PORT}
|
|
- --bitcoin-rpcuser=${BITCOIN_RPC_USER}
|
|
- --bitcoin-rpcpassword=${BITCOIN_RPC_PASSWORD}
|
|
- --bitcoin-retry-timeout=3600
|
|
- --addr=0.0.0.0:9735
|
|
- --announce-addr=cln:9735
|
|
- --large-channels
|
|
- --clnrest-host=0.0.0.0
|
|
- --clnrest-port=3010
|
|
ports:
|
|
- "${CLN_REST_PORT:-3010}:3010"
|
|
volumes:
|
|
- cln_data:/root/.lightning
|
|
- ./cln/poststart.d:/root/.lightning/lightning-poststart.d:ro
|
|
healthcheck:
|
|
# Healthy only once the RPC is up AND the rune file has been written, so the
|
|
# rtl service (which reads the rune at startup) can wait on this.
|
|
test: ["CMD-SHELL", "lightning-cli --network=regtest getinfo >/dev/null 2>&1 && test -f /root/.lightning/rtl.rune"]
|
|
interval: 5s
|
|
timeout: 5s
|
|
retries: 40
|
|
|
|
# RTL rewrites its config file on startup, so it cannot be given the tracked
|
|
# template directly: a bind mount would either be read-only (RTL exits with
|
|
# EROFS) or would let RTL scribble into a version-controlled file. Instead the
|
|
# template is copied into a volume that 'down -v' discards, which keeps the
|
|
# source pristine and every run starting from identical config.
|
|
rtl-config-init:
|
|
container_name: ${COMPOSE_PROJECT_NAME}_rtl_config_init
|
|
image: busybox:1.36
|
|
command: >
|
|
sh -c "cp /template/RTL-Config.regtest.json /config/RTL-Config.json &&
|
|
chmod 644 /config/RTL-Config.json &&
|
|
echo 'config staged'"
|
|
volumes:
|
|
- ./rtl/RTL-Config.regtest.json:/template/RTL-Config.regtest.json:ro
|
|
- rtl_config:/config
|
|
|
|
rtl:
|
|
container_name: ${COMPOSE_PROJECT_NAME}_rtl
|
|
# Defaults to the published image; override with RTL_IMAGE (e.g. a locally built
|
|
# branch image) to test unreleased changes: RTL_IMAGE=rtl:pr1625 docker compose up.
|
|
image: ${RTL_IMAGE:-shahanafarooqui/rtl:v0.15.8}
|
|
restart: unless-stopped
|
|
depends_on:
|
|
rtl-config-init:
|
|
condition: service_completed_successfully
|
|
alice:
|
|
condition: service_started
|
|
bob:
|
|
condition: service_started
|
|
carol:
|
|
condition: service_started
|
|
cln:
|
|
condition: service_healthy
|
|
ports:
|
|
- "${RTL_PORT}:${RTL_PORT}"
|
|
environment:
|
|
RTL_CONFIG_PATH: /RTL/config
|
|
volumes:
|
|
- rtl_config:/RTL/config
|
|
- alice_data:/lnd/alice:ro
|
|
- bob_data:/lnd/bob:ro
|
|
- carol_data:/lnd/carol:ro
|
|
- cln_data:/cln:ro
|
|
- rtl_db:/RTL/database
|