rgb-cln/contrib/pyln-proto
Swapnil 6204d70a37 docs: fix contrib/ docs 2022-07-17 21:40:01 +09:30
..
examples pyln-proto: fix port typo in example script 2022-03-11 16:42:45 +10:30
pyln/proto v0.11.0rc1 2022-04-05 08:48:46 +09:30
tests doc: update c-lightning to Core Lightning almost everywhere. 2022-04-07 06:53:26 +09:30
.gitignore pyln: Update the makefile to use poetry for publishing 2022-05-01 14:22:49 +09:30
Makefile pytest: Remove all trace of python's "flaky" module. 2022-06-27 17:21:35 +09:30
README.md docs: fix contrib/ docs 2022-07-17 21:40:01 +09:30
pyproject.toml pyln: Fix relative path dependencies when publishing to PyPI 2022-06-26 13:54:01 +09:30

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 Core Lightning source code and installing into your python3 environment:

git clone https://github.com/ElementsProject/lightning.git
cd lightning/contrib/pyln-proto
poetry install

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.