Skip to content

Latest commit

 

History

History
194 lines (126 loc) · 5.62 KB

README.md

File metadata and controls

194 lines (126 loc) · 5.62 KB
Raw

Bolt 12 Playground

This Bolt 12 Playground provides a docker stack that comprises of bitcoind, LND, LNDK, CLN, Eclair and LDK Node. It connects everything together, initializes wallets, and creates channels between the nodes.

You can use this to get familiar with Bolt 12.

Setup

Clone the repository and submodules:

git clone --recursive https://github.com/your/repo.git

Initialise the network:

Run the following command to initialise the nodes:

./scripts/init.sh

This script sets up a dockerized network of lightning nodes and channels which are a mix of different Lightning Network implementations, including LND, c-lightning (CLN), Eclair, and LDK Node.

NOTE: the init script must be run no later than 60 seconds after starting the nodes, otherwise nodes may crash due to an uninitialised blockchain

NOTE: It will take a couple of minutes for the network graph to become fully ready through the lnd gosip protocol. The init script will wait for the full sync

OR start an already initialised network:

Run the following command to startup the nodes:

docker compose up

Nodes

The script sets up eight nodes:

  • lnd1 and lnd2: These are instances of the LND implementation.
  • cln1, cln2, and cln3: These are instances of the c-lightning implementation.
  • eclair1, eclair2 and eclair3: These are instances of the Eclair implementation.
  • ldknode1, and ldknode2: These are instances of the LDK Node implementation.

Each node is funded with Bitcoin through a series of transactions.

Channels

The script sets up the following channels, which allows for testing of Bolt 12 interoperability between different Lightning Network node implementations and various channel configurations:

graph LR
    classDef nodes stroke:#FFD4D4,stroke-width:1px,fill:#303030;
    classDef groups stroke:#grey,stroke-width:1px,fill:none

    subgraph lndgroup ["LND"]
        lnd1(lnd1)
        lnd2(lnd2)
    end
    subgraph clngroup ["CLN"]
        cln2(cln3)
        cln3(cln2)
        cln1(cln1)
    end
    subgraph eclairgroup ["Eclair"]
        eclair1(eclair1)
        eclair2(eclair2)
        eclair3(eclair3)
    end
    subgraph ldkgroup ["LDK Node"]
        ldknode1(ldknode1)
        ldknode2(ldknode2)
    end

    lnd1 --10M (5M/5M)--> cln1
    lnd1 --10M (5M/5M)--> eclair1
    lnd1 --10M (5M/5M)--> ldknode1
    lnd1 --10M (5M/5M)--> lnd2
    lnd2 --10M (5M/5M)--> cln2
    lnd2 --10M (5M/5M)--> eclair2
    lnd2 --10M (5M/5M)--> ldknode2
    cln2 --10M (5M/5M)--> cln3
    eclair2 --10M (5M/5M)--> eclair3

    class lndgroup,clngroup,eclairgroup,ldkgroup groups;
    class lnd1,lnd2,cln1,cln2,cln3,eclair1,eclair2,eclair3,ldknode1,ldknode2 nodes;
Loading

Visualizing the Network with LN-Visualizer

LN-Visualizer is a tool that allows you to visualize the Lightning Network nodes and channels. It can be accessed at http://localhost:5646/.

Using CLI Commands

You can interact with any of the nodes using CLI commands. The bin scripts provided in the repository allow you to issue commands against any of the nodes.

To use the CLI commands, you need to pass the node name as the first argument to the relevant bin script. The node names are:

  • lnd1, lnd2
  • cln1, cln2, cln3
  • eclair1, eclair2, eclair3
  • ldknode1, ldknode2

Here's an example of how to use the CLI commands:

./bin/lncli lnd1 getinfo

In this example, ./bin/lncli is the bin script for the LND nodes, lnd1 is the name of the node you're issuing the command against, and getinfo is the command you're issuing. This command retrieves information about the lnd1 node.

You can replace getinfo with any other command supported by the node. For a list of available commands, you can use the help command. For example:

./bin/eclair-cli eclair2 help

This command displays a list of all commands that you can issue against the eclair2 node.

Examples

Paying to an Eclair node that is one hop away

Generate a bolt 12 offer on eclair1:

./bin/eclair-cli eclair1 tipjarshowoffer

Pay to bolt 12 offer from lndk1:

./bin/lndk-cli lndk1 pay-offer [BOLT12_OFFER] 10000

Paying to an Eclair node that is two hops away

Generate a bolt 12 offer on eclair2:

./bin/eclair-cli eclair2 tipjarshowoffer

Pay to bolt 12 offer:

./bin/lndk-cli lndk1 pay-offer [BOLT12_OFFER] 10000

Paying to a CLN node

NOTE: This is not working at the moment.

Generate a bolt 12 offer:

./bin/lightning-cli cln1 offer 1000 "test offer from cln1"

Pay to bolt 12 offer:

./bin/lndk-cli lndk1 pay-offer [BOLT12_OFFER]

Running Tests

This project uses Bats (Bash Automated Testing System) for testing. To run the tests, you first need to install Bats. You can find installation instructions in the Bats documentation.

Once you have Bats installed, you can run the tests with the following command:

bats test/

This will run all test files in the tests/ directory.

Each test is a separate function in the Bats file, and Bats will report a success or failure for each test. If a test fails, Bats will also display the output from the test, which can help you diagnose the problem.

Clean up

This will remove all docker container, images, and volumes created by this project.

Clean everything:

./scripts/clean.sh