kosmos/lndhub
8
0
Fork 0
Code Issues Pull Requests Releases Activity

README.md: cleaned up and removed 'deprecatedrpc' recommendation

Browse Source
This commit is contained in:
xanoni 2021-07-20 01:40:29 -04:00 committed by Overtorment
parent ec3039d91d
commit bc84429b61
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -1,7 +1,7 @@
LndHub LndHub
====== ======
Wrapper for Lightning Network Daemon. It provides separate accounts with minimum trust for end users Wrapper for Lightning Network Daemon (lnd). It provides separate accounts with minimum trust for end users.
INSTALLATION INSTALLATION
------------ ------------
@ -17,15 +17,17 @@ cd LndHub
npm i npm i
``` ```
Install `bitcoind`, `lnd` and `redis`. Edit `config.js` and set it up correctly. Install `bitcoind`, `lnd`, and `redis`. Edit LndHub's `config.js` to set it up correctly.
Copy `admin.macaroon` and `tls.cert` in root folder of LndHub. 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.
`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`. 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 enable disk-persistance for `redis`. 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, 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`. 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. Please not 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 ### Deploy to Heroku
@ -57,5 +59,5 @@ Acceptance tests are in https://github.com/BlueWallet/BlueWallet/blob/master/Lig
## Responsible disclosure ## Responsible disclosure
Found critical bugs/vulnerabilities? Please email them bluewallet@bluewallet.io Found critical bugs/vulnerabilities? Please email them to bluewallet@bluewallet.io
Thanks! Thanks!