therob3000 / python-lightning

A Python 3 implementation of the Bitcoin Lightning Network.

Python-Lightning

A Python 3 implementation of the Bitcoin Lightning Network.

API

This implementation of the Bitcoin Lightning network will be exposed via a REST API. The main resource is a Channel. Channels support CRUD operations:

• C - creates a channel
• R - reads a channel status
• U - commits a payment to the channel (or updates channel configurations)
• D - closes out an existing channel

In addition, a subset of channel information will be available to peers, allowing for mapping out of the network's topology.

Development

This project includes a Dockerfile for development. The standard procedure would be:

git clone [email protected]:scmorse/Python-Lightning.git && cd Python-Lightning
cp docker/Dockerfile-dev Dockerfile
docker build -t pln .
docker run -it -p 8090:8090 -v `pwd`:/opt/code/pln pln /bin/bash

# From within the docker container:
./init.sh
PYTHONPATH=`pwd` python3 server/main.py

Community

Mailing list: lightning-dev

Forum: LightningNetworkTalk

IRC: #lightning-dev

Updating libraries

Note that ignore = dirty has been added to each submodule descriptor within .gitmodules due to build files being placed in the directory and the project not properly git ignoring them. This means that to update the commit that a submodule references, you must:

• Remove each instance of ignore = dirty from .gitmodules
• Update and commit the new reference hash for the submodule
• Put ignore = dirty back into each entry of .gitmodules