Skip to main content

No project description provided

Project description

LndHub

travis-badge codecov-badge pypi-badge license-badge

With lndhub you can interact with wallets that provide a LndHub URL like BlueWallet or lntxbot.

This library is still in pre-alpha and it can change a lot. The idea is to be able to interact with all API endpoints defined in the BlueWallet/LndHub documentation:

  • ...: /create
  • ...: /oauth2/token
  • Wallet.authenticate(): /auth
  • Wallet.get_info(): /getinfo
  • Wallet.get_balance(): /balance
  • Wallet.get_transactions(): /gettxs
  • Wallet.get_transaction(id): /gettx
  • Wallet.get_pending_transactions(): /getpending
  • Wallet.get_invoices(): /getuserinvoices
  • Wallet.create_invoice(amount, description): /addinvoice
  • Wallet.decode_invoice(bolt11): /decodeinvoice
  • ...: /checkrouteinvoice at the momment does nothing.
  • Wallet.pay_invoice(bolt11): /payinvoice
  • ...: /sendcoins
  • Wallet.get_btc_addresses(): /getbtc
  • Wallet.create_btc_address(): /newbtc

Basic usage

import os

from lndhub import Wallet

wallet = Wallet(os.environ['LNDHUB_WALLET'])  # lndhub://user:pass@https://endpoint.com
balance = wallet.get_balance()
invoice = wallet.create_invoice(amount=200, description='Thanks!')

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lndhub-0.0.2.tar.gz (4.0 kB view hashes)

Uploaded source

Built Distribution

lndhub-0.0.2-py3-none-any.whl (5.4 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page