Dockerized regtest setup

Installation

• Clone the git repository and make sure the regtest.sh script is executable:

  # We assume this will be cloned to $HOME/rt.
  $ git clone https://github.com/guggero/rt.git
  $ chmod +x rt/regtest.sh
  

• (optional) create an alias for easy execution (might require sudo):

  $ ln -s $HOME/rt/regtest.sh /usr/local/bin/rt
  

• (optional) configure the script and make convenience alias commands usable. Add the following lines to your ~/.bashrc file:

  # Where to store the data for all nodes. By default the data directory in this
  # project is used.
  export REGTEST_MOUNT_DIR=$HOME/rt/data
  
  # Make the aliases like reg_bitcoin available to any shell.
  source $HOME/rt/functions.sh
  

Components

• bitcoind in regtest mode
  • Port(s): 18443 (RPC, regtest default), 28332,28333 (ZMQ)
• Esplora block explorer
  • Port(s): 3002 (web, default)
• 2 litd nodes (bundles lnd, loop and taproot-assets):
  • Alice ports: 10011 (gRPC), 9741 (p2p), 8091 (REST), 8443 (lit)
  • Bob ports: 10012 (gRPC), 9742 (p2p), 8092 (REST), 8444 (lit)
• 4 lnd nodes:
  • Charlie ports: 10013 (gRPC), 9743 (p2p), 8093 (REST)
  • Dave ports: 10014 (gRPC), 9744 (p2p), 8094 (REST)
  • Erin ports: 10015 (gRPC), 9745 (p2p), 8095 (REST)
  • Fabia ports: 10016 (gRPC), 9746 (p2p), 8096 (REST)
• 3 CLN nodes:
  • Nifty ports: 9747 (p2p)
  • Rusty ports: 9748 (p2p)
  • Snyke ports: 9749 (p2p)
• 1 Loop server, connected to Fabia
  • Port(s): 11009 (gRPC)

graph TD;
    subgraph Bitcoin Network
        bitcoind[bitcoind]
        esplora[Esplora]

        subgraph LITD Nodes
          litd_alice[Alice]
          litd_bob[Bob]
        end
  
        subgraph LND Nodes
          lnd_charlie[Charlie]
          lnd_dave[Dave]
          lnd_erin[Erin]
          lnd_fabia[Fabia]
  
          loop_server[Loop Server]
        end
  
        subgraph CLN Nodes
          cln_nifty[Nifty]
          cln_rusty[Rusty]
          cln_snyke[Snyke]
        end
    end

    %% Connections
    bitcoind <-- RPC/ZMQ --> esplora
    bitcoind <-- RPC --> litd_alice
    bitcoind <-- RPC --> litd_bob
    bitcoind <-- RPC --> lnd_charlie
    bitcoind <-- RPC --> lnd_dave
    bitcoind <-- RPC --> lnd_erin
    bitcoind <-- RPC --> lnd_fabia
    bitcoind <-- RPC --> cln_nifty
    bitcoind <-- RPC --> cln_rusty
    bitcoind <-- RPC --> cln_snyke

    lnd_fabia <-- gRPC --> loop_server

Usage

General helper commands:

• rt help: Show available helper commands
• rt info: Show network information
• rt fund <node> <x>: Send <x> regtest BTC to <node> on-chain
• rt mine <x>: Mine x blocks. If x is not specified, mines 6 blocks by default
• rt start: Start everything
• rt restart: Restart everything, completely wiping all data
• rt stop: Stop and remove everything

Node interaction:

• rt <node> <command> [args...]: Interact with a node.
  • Help:
    • rt <node> --help
    • rt <node> <subcommand> --help
  • Examples:
    • rt alice getinfo (equivalent of lncli getinfo inside the alice container)
    • rt rusty getinfo (equivalent of lightning-cli getinfo inside the rusty container)
• rt <node>_litcli <command> [args...]: Interact with a litd node (Alice or Bob) using the litcli command line tool.
  • Help:
    • rt <node>_litcli --help
    • rt <node>_litcli <subcommand> --help
  • Examples:
    • rt alice_litcli ln fundchannel ... (equivalent of litcli ln fundchannel ... inside the alice container)
• rt <node>_loop <command> [args...]: Interact with a litd node (Alice or Bob) using the loop command line tool.
  • Help:
    • rt <node>_loop --help
    • rt <node>_loop <subcommand> --help
  • Example:
    • rt bob_loop out monitor (equivalent of loop out monitor inside the bob container)
• rt <node>_tapcli <command> [args...]: Interact with a tapd node (Alice or Bob) using the tapcli command line tool.

• Help:
  • rt <node>_tapcli --help
  • rt <node>_tapcli <subcommand> --help
• Example:
  • rt bob_tapcli assets list (equivalent of tapcli assets list inside the bob container)