An rpc client for LND (lightning network deamon)
Project description
lnd-grpc-client
A python grpc client for LND (Lightning Network Daemon) ⚡⚡⚡
This is a wrapper around the default grpc interface that handles setting up credentials (including macaroons). An async client is also available to do fun async stuff like listening for invoices in the background.
Dependencies
- Python 3.6+
- Working LND lightning node, take note of its ip address.
- Copy your admin.macaroon and tls.cert files from your node to a directory on your machine.
Installation
pip install lnd-grpc-client
# Test it is working
# Set these values as needed!
export CRED_PATH=/path/to/macaroon/and/tls/cert
export LND_NODE_IP=192.168.1.xx
# This will run a get_info() request on your node, checking its connection.
python3 -m lndgrpc
Environment Variables
These environment variables are only used when testing node connectivity and/or correct module installation from the command line. This library is primarily used through Python scripting.
export CRED_PATH=/path/to/macaroon/and/tls/cert
export LND_NODE_IP=192.168.1.xx
python3 -m lndgrpc
# You should expect to see:
#
# .....
# .....
# .....
# lndgrpc package is installed... Wow it works!
Create Node ENV File
Make a folder for holding your TLS cert and macaroons, and create a file named node-env
which contains what is necessary to connect to your node
Example node-env
is located at node-env.example
IN BASH
mkdir -p /home/you-user-name/creds/your-node-alias
cd /home/you-user-name/creds/your-node-alias
nano node-env
IN NANO
# Lightning Node Vars
export CRED_PATH=/home/you-user-name/creds/your-node-alias/lnd
export LND_NODE_IP=192.168.4.69
export LND_NODE_PORT=10009
IN BASH
mkdir lnd
cd lnd
*copy your tls.cert and admin.macaroon in to this folder*
HOW TO USE IN BASH
cd /home/you-user-name/creds/your-node-alias
source node-env
# THIS ADDS WHAT IS IN THE FILE AS AN ENVIRONMENT VARIABLE SO IT IS AVAILABLE WHEN YOU ARE WRITING SCRIPTS
CLI Usage
This package adds a CLI command to your PATH once installed:
lndgrpcclient_cli
Basic Usage
The api mirrors the underlying lnd grpc api (http://api.lightning.community/) but methods will be in pep8 style. ie. .GetInfo()
becomes .get_info()
.
import os
from pathlib import Path
from lndgrpc import LNDClient
credential_path = os.getenv("LND_CRED_PATH", None)
if credential_path == None:
credential_path = Path.home().joinpath(".lnd")
mac = str(credential_path.joinpath("data/chain/bitcoin/mainnet/admin.macaroon").absolute())
else:
credential_path = Path(credential_path)
mac = str(credential_path.joinpath("admin.macaroon").absolute())
node_ip = os.getenv("LND_NODE_IP")
tls = str(credential_path.joinpath("tls.cert").absolute())
lnd_ip_port = f"{node_ip}:10009"
# pass in the ip-address with RPC port and network ('mainnet', 'testnet', 'simnet')
# the client defaults to 127.0.0.1:10009 and mainnet if no args provided
lnd = LNDClient(
lnd_ip_port,
macaroon_filepath=mac,
cert_filepath=tls
# no_tls=True
)
# Unlock you wallet
lnd.unlock_wallet(wallet_password=b"your_wallet_password")
# Get general data about your node
lnd.get_info()
print('Listening for invoices...')
for invoice in lnd.subscribe_invoices():
print(invoice)
Advanced Usage
Go in the examples
folder for some advanced examples including:
- WIP: Open channel using PSBT
- Keysend Payments
- Reconnect to your peers
Async
import asyncio
from lndgrpc import AsyncLNDClient
async_lnd = AsyncLNDClient()
async def subscribe_invoices():
print('Listening for invoices...')
async for invoice in async_lnd.subscribe_invoices():
print(invoice)
async def get_info():
while True:
info = await async_lnd.get_info()
print(info)
await asyncio.sleep(5)
async def run():
coros = [subscribe_invoices(), get_info()]
await asyncio.gather(*coros)
loop = asyncio.get_event_loop()
loop.run_until_complete(run())
Specifying Macaroon/Cert files
By default the client will attempt to lookup the readonly.macaron
and tls.cert
files in the mainnet directory.
However if you want to specify a different macaroon or different path you can pass in the filepath explicitly.
lnd = LNDClient(
macaroon_filepath='~/.lnd/invoice.macaroon',
cert_filepath='path/to/tls.cert'
)
Generating LND Proto Files
mkvirtualenv gen_rpc_protos
# or
workon gen_rpc_protos
# then
pip install grpcio grpcio-tools googleapis-common-protos sh
cd lndgrpc
git clone --depth 1 https://github.com/googleapis/googleapis.git
cd ..
Set environment variables
export APP_DIR=$HOME/Documents/lightning/lnd
export CLIENT_DIR=$HOME/Documents/lightning/lnd-grpc-client
python3 rebuild_protos.py
Deploy to Test-PyPi
poetry build
twine check dist/*
twine upload --repository-url https://test.pypi.org/legacy/ dist/*
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for lnd_grpc_client-0.4.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bf84f7413294c5cc2f1afcdc2474b34903ce93424df7f6127ecc757c62a14ce4 |
|
MD5 | 7e5aa662cd2d748a4b62a1f0ca48b4ca |
|
BLAKE2b-256 | a1b7a8e89904f07d25979b599fe0667ca3d1f9bfbd95d4be6a9427284ed8e407 |