Fork of LndHub with some fixes, as well as additions for lnurl-pay support https://lndhub.kosmos.org
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
raucao 9b81cc6287
Store and return invoice memo
3 months ago
.github/workflows Fix: Fix actions for Umbrel 1 year ago
class Store and return invoice memo 3 months ago
controllers Store and return invoice memo 3 months ago
doc Last .md style improvement 8 months ago
scripts ref 7 months ago
static Fixed progress bar css for small values 1 year ago
templates REF: Change title 1 year ago
utils Update dependencies (#121) 1 year ago
.babelrc Update .babelrc 1 year ago
.eslintrc Umbrel support (#141) 1 year ago
.gitignore INIT 4 years ago
Dockerfile Update node from 12-buster to 16-bullseye 8 months ago
LICENSE MIT License added see #40 3 years ago
README.md Update README.md 8 months ago
bitcoin.js Umbrel support (#141) 1 year ago
btc-decoder.js Umbrel support (#141) 1 year ago
config.js move default in varible name to comment 8 months ago
index.js index.js: add HOST environment argument 8 months ago
lightning.js Umbrel support (#141) 1 year ago
package-lock.json fix: upgrade express-rate-limit from 5.3.0 to 5.4.1 7 months ago
package.json fix: upgrade express-rate-limit from 5.3.0 to 5.4.1 7 months ago
rpc.proto Update dependencies (#121) 1 year ago
run-process-locked.sh OPS 2 years ago

README.md

LndHub

Wrapper for Lightning Network Daemon (lnd). It provides separate accounts with minimum trust for end users.

INSTALLATION

You can use those guides or follow instructions below:

git clone git@github.com:BlueWallet/LndHub.git
cd LndHub
npm i

Install bitcoind, lnd, and redis. Edit LndHub's config.js to set it up correctly. Copy the files admin.macaroon (for Bitcoin mainnet, usually stored in ~/.lnd/data/chain/bitcoin/mainnet/admin.macaroon) and tls.cert (usually stored in ~/.lnd/tls.cert) into the root folder of LndHub.

LndHub expects LND's wallet to be unlocked, if not — it will attempt to unlock it with the password stored in config.lnd.password. Don't forget to configure disk-persistence for redis (e.g., you may want to set appendonly to yes in redis.conf (see http://redis.io/topics/persistence for more information).

If you have no bitcoind instance, for example if you use neutrino, or you have no bitcoind wallet, for example if you use LND for wallet managment, you can remove the bitcoind settings from config.js. Please note that this feature is limited to Bitcoin, so you can't use it if you use any other cryptocurrency with LND (e.g., Litecoin).

Deploy to Heroku

Add config vars :

  • CONFIG : json serialized config object
  • MACAROON: hex-encoded admin.macaroon
  • TLSCERT: hex-encoded tls.cert

Run in docker

LndHub is available on Docker Hub as bluewalletorganization/lndhub. Please note that this requires a separate instance of redis and LND and optionally, bitcoind. You can also view Umbrel's implementation using docker-compose here.

Reference client implementation

Can be used in ReactNative or Nodejs environment

Tests

Acceptance tests are in https://github.com/BlueWallet/BlueWallet/blob/master/tests/integration/lightning-custodian-wallet.test.js

image

Responsible disclosure

Found critical bugs/vulnerabilities? Please email them to bluewallet@bluewallet.io Thanks!