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
  • [x] Wallet.authenticate(): /auth
  • [x] Wallet.get_info(): /getinfo
  • [x] Wallet.get_balance(): /balance
  • [x] Wallet.get_transactions(): /gettxs
  • [x] Wallet.get_transaction(id): /gettx
  • [x] Wallet.get_pending_transactions(): /getpending
  • [x] Wallet.get_invoices(): /getuserinvoices
  • [x] Wallet.create_invoice(amount, description): /addinvoice
  • [x] Wallet.decode_invoice(bolt11): /decodeinvoice
  • [ ] ...: /checkrouteinvoice at the momment does nothing.
  • [ ] Wallet.pay_invoice(bolt11): /payinvoice
  • [ ] ...: /sendcoins
  • [x] Wallet.get_btc_addresses(): /getbtc
  • [x] 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.

Files for lndhub, version 0.0.2
Filename, size File type Python version Upload date Hashes
Filename, size lndhub-0.0.2-py3-none-any.whl (5.4 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size lndhub-0.0.2.tar.gz (4.0 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page