lndhub/README.md

53 lines
1.5 KiB
Markdown
Raw Normal View History

2018-12-04 00:39:29 +00:00
LndHub
======
2018-12-19 23:55:12 +00:00
Wrapper for Lightning Network Daemon. It provides separate accounts with minimum trust for end users
2018-12-08 15:47:10 +00:00
2018-12-04 00:39:29 +00:00
INSTALLATION
------------
2019-02-16 13:07:08 +00:00
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
2018-12-04 00:39:29 +00:00
```
git clone git@github.com:BlueWallet/LndHub.git
cd LndHub
npm i
```
2019-02-07 14:46:00 +00:00
Install `bitcoind`, `lnd` and `redis`. Edit `config.js` and set it up correctly.
2018-12-04 00:39:29 +00:00
Copy `admin.macaroon` and `tls.cert` in root folder of LndHub.
2019-02-07 14:46:00 +00:00
`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`.
2018-12-04 00:39:29 +00:00
### Deploy to Heroku
Add config vars :
* `CONFIG` : json serialized config object
* `MACAROON`: hex-encoded `admin.macaroon`
2018-12-06 00:02:46 +00:00
* `TLSCERT`: hex-encoded `tls.cert`
2019-12-09 21:41:25 +00:00
### Reference client implementation
Can be used in ReactNative or Nodejs environment
* https://github.com/BlueWallet/BlueWallet/blob/master/class/lightning-custodian-wallet.js
2018-12-06 00:02:46 +00:00
### Tests
2019-02-01 19:28:26 +00:00
Acceptance tests are in https://github.com/BlueWallet/BlueWallet/blob/master/LightningCustodianWallet.test.js
2019-02-07 14:46:00 +00:00
![image](https://user-images.githubusercontent.com/1913337/52418916-f30beb00-2ae6-11e9-9d63-17189dc1ae8c.png)
2019-02-01 19:28:26 +00:00
## Responsible disclosure
Found critical bugs/vulnerabilities? Please email them bluewallet@bluewallet.io
Thanks!