mirror of https://github.com/ElementsProject/lightning.git synced 2025-01-07 14:29:33 +01:00

History

Christian Decker cc4fbfca43 pylightning: Add the `background` keyword to hooks and methods This indicates that the method or hook will accepts a request parameter, and will use that to return the result or raise an exception instead of returning the return value. This allows the hook or method to stash the incomplete request or pass it around, without blocking the JSON-RPC interface. Signed-off-by: Christian Decker <decker.christian@gmail.com>		2019-02-22 02:59:36 +00:00
..
lightning	pylightning: Add the `background` keyword to hooks and methods	2019-02-22 02:59:36 +00:00
tests	pylightning: Added a tiny library for python plugins	2018-12-15 15:04:32 +01:00
lightning-pay	[pylightning] Fix lightning-pay script	2018-11-19 21:24:03 +01:00
README.md	[doc] Add lightning-pay script as example for using pylightning library	2018-12-10 17:07:34 +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>