rgb-cln/contrib/pyln-proto
Christian Decker 6c19818314 pyln-proto: Add invoice utilities
We are about to disect a couple of invoices for features, so let's add a class
that can encode and decode invoices from bolt11 strings. This is pretty much
the lnaddr.py file created by @rustyrussell with some minor changes. I'm
planning to clean this up further which is why I'm only exporting the
`Invoice` class for now.
2020-02-01 16:50:58 +01:00
..
examples pyln: Split pylightning into multiple pyln modules 2019-09-30 13:27:37 +02:00
pyln/proto pyln-proto: Add invoice utilities 2020-02-01 16:50:58 +01:00
tests pyln-proto: Add invoice utilities 2020-02-01 16:50:58 +01:00
README.md pyln: Split pylightning into multiple pyln modules 2019-09-30 13:27:37 +02:00
requirements.txt pyln-proto: Add invoice utilities 2020-02-01 16:50:58 +01:00
setup.py pyln: Split pylightning into multiple pyln modules 2019-09-30 13:27:37 +02:00

README.md

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.