d7216e1506
These options that aren't documented yet were added recently, I hope this documentation looks okay for you.
62 lines
2.2 KiB
Markdown
62 lines
2.2 KiB
Markdown
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:
|
|
|
|
* https://github.com/dangeross/guides/blob/master/raspibolt/raspibolt_6B_lndhub.md
|
|
* https://medium.com/@jpthor/running-lndhub-on-mac-osx-5be6671b2e0c
|
|
|
|
```
|
|
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`](https://hub.docker.com/r/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](https://github.com/getumbrel/umbrel/blob/280c87f0f323666b1b0552aeb24f60df94d1e43c/apps/lndhub/docker-compose.yml).
|
|
|
|
### 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!
|