History

Rusty Russell 40637d0017 contrib/pylightning: temporarily convert to use plugin/pay for tests. That this simply pay plugin passes the tests is a poor reflection on our test cases, really. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>		2019-01-17 13:02:24 +01:00
..
lightning	contrib/pylightning: temporarily convert to use plugin/pay for tests.	2019-01-17 13:02:24 +01:00
tests	pylightning: Added a tiny library for python plugins	2018-12-15 15:04:32 +01:00
README.md	[doc] Add lightning-pay script as example for using pylightning library	2018-12-10 17:07:34 +01:00
lightning-pay	[pylightning] Fix lightning-pay script	2018-11-19 21:24:03 +01:00
setup.py	pylightning: Bump version number to 0.0.6 to make Pypi work again	2018-12-07 10:29:21 +01:00

README.md

pylightning: A python client library for lightningd

Installation

Note: With Python 2 you need to have the futures python library installed to be able to use pylightning:

pip install futures

pylightning is available on pip

pip install pylightning

Examples

"""
Generate invoice on one daemon and pay it on the other
"""
from lightning import LightningRpc
import random

# Create two instances of the LightningRpc object using two different c-lightning daemons on your computer
l1 = LightningRpc("/tmp/lightning1/lightning-rpc")
l5 = LightningRpc("/tmp/lightning5/lightning-rpc")

info5 = l5.getinfo()
print(info5)

# Create invoice for test payment
invoice = l5.invoice(100, "lbl{}".format(random.random()), "testpayment")
print(invoice)

# Get route to l1
route = l1.getroute(info5['id'], 100, 1)
print(route)

# Pay invoice
print(l1.sendpay(route['route'], invoice['payment_hash']))

Also see the included lightning-pay script, which uses the client library to pay invoices

lightning-pay <bolt11 invoice>
# or explicitly with
lightning-pay <destination_id> <amount in millisatoshi> <payment_hash> <min_final_cltv_expiry>