akovalenko/lnd.xprv
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: update installation instructions to point to btcsuite/btcd not roasbeef/btcd

Browse Source
This commit is contained in:
Olaoluwa Osuntokun 2018-06-04 18:41:08 -07:00
parent 054d449316
commit a34a4661e8
No known key found for this signature in database
GPG Key ID: 964EA263DD637C21
1 changed files with 10 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/INSTALL.md
View File

@ -118,16 +118,16 @@ On FreeBSD, use gmake instead of make.
### Installing btcd ### Installing btcd
When using the `btcd` backend, `lnd` currently requires the To install btcd, run the following commands:
[roasbeef](https://github.com/btcsuite/btcd) fork of `btcd` due to neutrino
additions that are not yet available in the master branch. To install, run the
following commands:
Install **btcd**: (must be from roasbeef fork, not from btcsuite) Install **btcd**:
``` ```
make btcd make btcd
``` ```
Alternatively, you can install [`btcd` directly from its
repo](https://github.com/btcsuite/btcd).
### Starting btcd ### Starting btcd
Running the following command will create `rpc.cert` and default `btcd.conf`. Running the following command will create `rpc.cert` and default `btcd.conf`.
@ -195,11 +195,11 @@ light client powered by [neutrino](https://github.com/lightninglabs/neutrino).
#### Running lnd in Light Client Mode #### Running lnd in Light Client Mode
In order to run `lnd` in its light client mode, you'll need to locate a In order to run `lnd` in its light client mode, you'll need to locate a
full-node which is capable of serving this new light client mode. A [BIP full-node which is capable of serving this new light client mode. `lnd` uses
draft](https://github.com/Roasbeef/bips/blob/master/gcs_light_client.mediawiki) [BIP 157](https://github.com/bitcoin/bips/tree/master/bip-0157) and [BIP
exists, and will be finalized in the near future, but for now you'll need to be 158](https://github.com/bitcoin/bips/tree/master/bip-0158) for its light client
running `roasbeef`'s fork of btcd. A public instance of such a node can be mode. A public instance of such a node can be found at
found at `faucet.lightning.community`. `faucet.lightning.community`.
To run lnd in neutrino mode, run `lnd` with the following arguments, (swapping To run lnd in neutrino mode, run `lnd` with the following arguments, (swapping
in `--bitcoin.simnet` if needed), and also your own `btcd` node if available: in `--bitcoin.simnet` if needed), and also your own `btcd` node if available:
@ -328,8 +328,3 @@ at the same time), so when working with Litecoin be sure to set to parameters
for Litecoin accordingly. For node configuration, the sections are called for Litecoin accordingly. For node configuration, the sections are called
`[Btcd]`, `[Bitcoind]`, `[Neutrino]`, `[Ltcd]`, and `[Litecoind]` depending on `[Btcd]`, `[Bitcoind]`, `[Neutrino]`, `[Ltcd]`, and `[Litecoind]` depending on
which chain and node type you're using. which chain and node type you're using.
# Accurate as of:
- _btcsuite/btcd commit:_ `f8c02aff4e7a807ba0c1349e2db03695d8e790e8`
- _btcsuite/btcutil commit:_ `a259eaf2ec1b54653cdd67848a41867f280797ee`
- _lightningnetwork/lnd commit:_ `08de2becf8d77fae192205172c4fb17bb09bd0dbf49e64aa323b2fcbf9fe2a35`