blitskrieg 0.1.0

The Bitcoin Lightning Integration Test Service

BLITSkrieg: Bitcoin Lightning Integration Test Service

BLITSkrieg is a gRPC server in Python that aims to provide a set of utilities to test Bitcoin and Lightning Network services.

It uses boltlight in order to hide the differences between the different LN node implementations.

Currently the available services are:

• bitcoind ^[1]
• boltlight ^[2]
• c-lightning
• eclair
• electrs ^[3]
• electrum
• lnd

Notes

1. docker image always necessary
2. docker image necessary to call LN-related commands
3. docker image necessary to run electrum

System dependencies

• Linux or macOS (Windows may work, but is not supported)
• Python 3.7+
• docker

Build

BLITSkrieg docker image

In order to build a docker image of BLITSkrieg, run:

# production mode
$ ./unix_helper build

# development mode
$ ./unix_helper build-dev

CLI

Inside the docker container of BLITSkrieg you will find bli, the command line interface for BLITSkrieg. In order to install this tool on your local machine (outside docker) you can create a Python virtual environment and install it there with:

$ pip install .

Run

In order to launch the docker image of BLITSkrieg, run:

# production mode
$ ./unix_helper run

# development mode
$ ./unix_helper run-dev

Usage

In order to run a command on BLITSkrieg, you can directly call it by making a gRPC call to it, or you can use its CLI.

To get a list of available CLI commands, run:

$ bli --help

In order to perform any action in BLITSkrieg, you first need to call:

$ bli createstack [--<implementation>=<number_of_nodes>]

If you do not specify any LN node, this will run a single bitcoind instance and only Bitcoin-related commands will be available.

Visit our docker repository in order to build the required services. Otherwise, if the needed docker images are not available, they will be pulled from hashbeam's GitLab container registry.