bluewallet/LndHub
bluewallet/LndHub
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity
[BREAKGLASS] Wrapper for Lightning Network Daemon. It provides separate accounts for end-users http://LndHub.io
336 Commits 42 Branches 12 Tags 3.1 MiB
JavaScript 64.8%
HTML 29.8%
CSS 3.3%
Shell 1.2%
Dockerfile 0.9%
sunset
Go to file
Marcos Rodriguez Vélez deefc3a112 FIX: API Error Wording
2021-07-14 18:35:11 +01:00
.github/workflows Fix: Fix actions for Umbrel 2021-04-29 13:39:32 +01:00
class FIX: time -> blocktime 2021-04-17 00:51:37 +01:00
controllers FIX: API Error Wording 2021-07-14 18:35:11 +01:00
doc DOC 2021-04-16 22:07:02 +01:00
scripts FIX: hsts header 2021-06-21 12:29:13 +01:00
static Fixed progress bar css for small values 2021-04-08 19:27:31 +01:00
templates REF: Change title 2021-02-18 12:11:01 +00:00
utils Update dependencies (#121) 2021-01-04 12:49:42 +00:00
.babelrc Update .babelrc 2020-12-04 18:59:57 +00:00
.eslintrc Umbrel support (#141) 2021-02-24 15:17:22 +00:00
.gitignore INIT 2018-12-02 22:17:02 +00:00
bitcoin.js Umbrel support (#141) 2021-02-24 15:17:22 +00:00
btc-decoder.js Umbrel support (#141) 2021-02-24 15:17:22 +00:00
config.js FIX: updateDescribeGraph() is disabled by default (too slow on low-end machines) 2021-05-14 11:10:41 +01:00
Dockerfile Umbrel support (#141) 2021-02-24 15:17:22 +00:00
index.js FIX: hsts header 2021-06-21 12:29:13 +01:00
LICENSE MIT License added see #40 2019-11-04 14:23:43 +00:00
lightning.js Umbrel support (#141) 2021-02-24 15:17:22 +00:00
package-lock.json fix: upgrade multiple dependencies with Snyk 2021-07-02 12:29:16 +01:00
package.json fix: upgrade multiple dependencies with Snyk 2021-07-02 12:29:16 +01:00
README.md doc: Add options that were added for Umbrel 2021-04-08 12:54:57 +01:00
rpc.proto Update dependencies (#121) 2021-01-04 12:49:42 +00:00
run-process-locked.sh OPS 2020-08-12 16:45:29 +01:00

README.md

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

Tests

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

image

Responsible disclosure

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