LndHub

Wrapper for Lightning Network Daemon. 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 config.js and set it up correctly. Copy admin.macaroon and tls.cert in root folder of LndHub.

bitcoind should run with -deprecatedrpc=accounts, for now. Lndhub expects Lnd's wallet to be unlocked, if not - it will attempt to unlock it with password stored in config.lnd.password. Don't forget to enable disk-persistance for redis.

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 not that this feature is limited to Bitcoin, so you can't use this feature if you use any other cryptocurrency with LND.

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

https://github.com/BlueWallet/BlueWallet/blob/master/class/lightning-custodian-wallet.js

Tests

Acceptance tests are in https://github.com/BlueWallet/BlueWallet/blob/master/LightningCustodianWallet.test.js

Responsible disclosure

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