core-lightning/contrib/pyln-proto
2021-09-28 18:34:43 +02:00
..
examples pyln: Split pylightning into multiple pyln modules 2019-09-30 13:27:37 +02:00
pyln/proto pyln: Derive version from git for pyln-proto 2021-09-28 18:34:43 +02:00
tests pyln.proto.message: add new BOLT12 fundamental types. 2021-07-30 19:17:47 +02:00
Makefile pyln: Add E741 as excluded flake warnings 2021-07-30 19:17:47 +02:00
README.md pyln: Split pylightning into multiple pyln modules 2019-09-30 13:27:37 +02:00
requirements.txt gci: Pin down a couple more dependencies 2021-09-28 18:34:43 +02:00
setup.py pyln: Derive version from git for pyln-proto 2021-09-28 18:34:43 +02:00

pyln-proto: Lightning Network protocol implementation

This package implements some of the Lightning Network protocol in pure python. It is intended for protocol testing and some minor tooling only. It is not deemed secure enough to handle any amount of real funds (you have been warned!).

Installation

pyln-proto is available on pip:

pip install pyln-proto

Alternatively you can also install the development version to get access to currently unreleased features by checking out the c-lightning source code and installing into your python3 environment:

git clone https://github.com/ElementsProject/lightning.git
cd lightning/contrib/pyln-proto
python3 setup.py develop

This will add links to the library into your environment so changing the checked out source code will also result in the environment picking up these changes. Notice however that unreleased versions may change API without warning, so test thoroughly with the released version.