Skip to content

Commit bd0d2f8

Browse files
authored
update documentation
1 parent 87a278a commit bd0d2f8

File tree

1 file changed

+33
-33
lines changed

1 file changed

+33
-33
lines changed

docs/lnd/INSTALL.md

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -88,29 +88,29 @@ recommended for mainnet. The `master` branch can at times be unstable and
8888
running your node off of it can prevent it to go back to a previous, stable
8989
version if there are database migrations present.
9090

91-
In order to work with [`lnd`](https://github.com/lightningnetwork/lnd), the
91+
In order to work with [`lnd`](https://github.com/lightningnetwork/lnd), the
9292
following build dependencies are required:
9393

9494
### Installing Go
9595

96-
`lnd` is written in Go, with a minimum version of `1.23.12` (or, in case this
96+
`lnd` is written in Go, with a minimum version of `1.24.6` (or, in case this
9797
document gets out of date, whatever the Go version in the main `go.mod` file
9898
requires). To install, run one of the following commands for your OS:
9999

100100
<details>
101101
<summary>Linux (x86-64)</summary>
102-
102+
103103
```
104-
wget https://dl.google.com/go/go1.23.12.linux-amd64.tar.gz
105-
sha256sum go1.23.12.linux-amd64.tar.gz | awk -F " " '{ print $1 }'
104+
wget https://dl.google.com/go/go1.24.6.linux-amd64.tar.gz
105+
sha256sum go1.24.6.linux-amd64.tar.gz | awk -F " " '{ print $1 }'
106106
```
107107

108108
The final output of the command above should be
109-
`d3847fef834e9db11bf64e3fb34db9c04db14e068eeb064f49af747010454f90`. If it
109+
`bbca37cc395c974ffa4893ee35819ad23ebb27426df87af92e93a9ec66ef8712`. If it
110110
isn't, then the target REPO HAS BEEN MODIFIED, and you shouldn't install
111111
this version of Go. If it matches, then proceed to install Go:
112112
```
113-
sudo rm -rf /usr/local/go && sudo tar -C /usr/local -xzf go1.23.12.linux-amd64.tar.gz
113+
sudo rm -rf /usr/local/go && sudo tar -C /usr/local -xzf go1.24.6.linux-amd64.tar.gz
114114
export PATH=$PATH:/usr/local/go/bin
115115
```
116116
</details>
@@ -119,24 +119,24 @@ requires). To install, run one of the following commands for your OS:
119119
<summary>Linux (ARMv6)</summary>
120120

121121
```
122-
wget https://dl.google.com/go/go1.23.12.linux-armv6l.tar.gz
123-
sha256sum go1.23.12.linux-armv6l.tar.gz | awk -F " " '{ print $1 }'
122+
wget https://dl.google.com/go/go1.24.6.linux-armv6l.tar.gz
123+
sha256sum go1.24.6.linux-armv6l.tar.gz | awk -F " " '{ print $1 }'
124124
```
125125

126126
The final output of the command above should be
127-
`9704eba01401a3793f54fac162164b9c5d8cc6f3cab5cee72684bb72294d9f41`. If it
127+
`7feb4d25f5e72f94fda81c99d4adb6630dfa2c35211e0819417d53af6e71809e`. If it
128128
isn't, then the target REPO HAS BEEN MODIFIED, and you shouldn't install
129129
this version of Go. If it matches, then proceed to install Go:
130130
```
131-
sudo rm -rf /usr/local/go && tar -C /usr/local -xzf go1.23.12.linux-armv6l.tar.gz
131+
sudo rm -rf /usr/local/go && tar -C /usr/local -xzf go1.24.6.linux-armv6l.tar.gz
132132
export PATH=$PATH:/usr/local/go/bin
133133
```
134134

135135
</details>
136136

137137
<details>
138138
<summary>macOS</summary>
139-
139+
140140
First, install [Homebrew](https://brew.sh) if you don't already have it.
141141

142142
Then
@@ -149,7 +149,7 @@ requires). To install, run one of the following commands for your OS:
149149

150150
<details>
151151
<summary>FreeBSD</summary>
152-
152+
153153
```
154154
pkg install go
155155
```
@@ -172,14 +172,14 @@ export GOPATH=~/go
172172
export PATH=$PATH:$GOPATH/bin
173173
```
174174

175-
---
175+
---
176176

177-
We recommend placing the above in your `.bashrc`, `.zshrc` or in a setup script
177+
We recommend placing the above in your `.bashrc`, `.zshrc` or in a setup script
178178
so that you can avoid typing this every time you open a new terminal window.
179179

180180
### Go modules
181181

182-
This project uses [Go modules](https://github.com/golang/go/wiki/Modules)
182+
This project uses [Go modules](https://github.com/golang/go/wiki/Modules)
183183
to manage dependencies as well as to provide *reproducible builds*.
184184

185185
Usage of Go modules (with Go 1.13) means that you no longer need to clone
@@ -188,8 +188,8 @@ repo can now live anywhere!
188188

189189
---
190190
Note: For mobile development, having the source code in `$GOPATH` is still
191-
required due to a current limitation in
192-
[Go mobile](https://pkg.go.dev/golang.org/x/mobile). Take a look at the
191+
required due to a current limitation in
192+
[Go mobile](https://pkg.go.dev/golang.org/x/mobile). Take a look at the
193193
documentation for [building mobile libraries](../mobile) to learn more.
194194

195195
---
@@ -209,7 +209,7 @@ wish to install a tagged release of `lnd` (as the master branch can at times be
209209
unstable), then [visit the release page to locate the latest
210210
release](https://github.com/lightningnetwork/lnd/releases). Assuming the name
211211
of the release is `v0.x.x`, then you can compile this release from source with
212-
a small modification to the above command:
212+
a small modification to the above command:
213213
```shell
214214
git clone https://github.com/lightningnetwork/lnd
215215
cd lnd
@@ -299,7 +299,7 @@ in the system's `$PATH` variable. Otherwise, some tests will fail.
299299

300300
**Command-line completion for `lncli`**
301301

302-
_Bash_: See `contrib/lncli.bash-completion`
302+
_Bash_: See `contrib/lncli.bash-completion`
303303
_Fish_: Run: `lncli fish-completion > $HOME/.config/fish/completions/lncli.fish`
304304

305305
# Available Backend Operating Modes
@@ -309,7 +309,7 @@ time of writing of this document, there are three available chain backends:
309309
`btcd`, `neutrino`, `bitcoind`. All including neutrino can run on mainnet with
310310
an out of the box `lnd` instance. We don't require `--txindex` when running
311311
with `bitcoind` or `btcd` but activating the `txindex` will generally make
312-
`lnd` run faster. Note that since version 0.13 pruned nodes are supported,
312+
`lnd` run faster. Note that since version 0.13 pruned nodes are supported,
313313
although they cause performance penalty and higher network usage.
314314

315315
The set of arguments for each of the backend modes is as follows:
@@ -439,8 +439,8 @@ in `--bitcoin.simnet` if needed), and also your own `btcd` node if available:
439439

440440
## Using bitcoind
441441

442-
Note that adding `-txindex` is optional, as it will take longer to sync the
443-
node, but then `lnd` will generally operate faster as it can hit the index
442+
Note that adding `-txindex` is optional, as it will take longer to sync the
443+
node, but then `lnd` will generally operate faster as it can hit the index
444444
directly, rather than scanning blocks or BIP 158 filters for relevant items.
445445

446446
To configure your bitcoind backend for use with lnd, first complete and verify
@@ -449,10 +449,10 @@ the following:
449449
- Since `lnd` uses
450450
[ZeroMQ](https://github.com/bitcoin/bitcoin/blob/master/doc/zmq.md) to
451451
interface with `bitcoind`, *your `bitcoind` installation must be compiled with
452-
ZMQ*. Note that if you installed `bitcoind` from source and ZMQ was not present,
453-
then ZMQ support will be disabled, and `lnd` will quit on a `connection refused` error.
454-
If you installed `bitcoind` via Homebrew in the past ZMQ may not be included
455-
([this has now been fixed](https://github.com/Homebrew/homebrew-core/pull/23088)
452+
ZMQ*. Note that if you installed `bitcoind` from source and ZMQ was not present,
453+
then ZMQ support will be disabled, and `lnd` will quit on a `connection refused` error.
454+
If you installed `bitcoind` via Homebrew in the past ZMQ may not be included
455+
([this has now been fixed](https://github.com/Homebrew/homebrew-core/pull/23088)
456456
in the latest Homebrew recipe for bitcoin)
457457
- Configure the `bitcoind` instance for ZMQ with `-zmqpubrawblock` and
458458
`-zmqpubrawtx`. These options must each use their own unique address in order
@@ -461,10 +461,10 @@ the following:
461461
`-zmqpubrawtx=tcp://127.0.0.1:28333`).
462462
- Make sure the config setting `-rpcserialversion` in `bitcoind` is either set
463463
to 1 or NOT used because bitcoind's default behaviour is already correct
464-
(see [bitcoin/issues/28730](https://github.com/bitcoin/bitcoin/issues/28730)
465-
for more info). Lightning depends on segwit transactions therefore we need
464+
(see [bitcoin/issues/28730](https://github.com/bitcoin/bitcoin/issues/28730)
465+
for more info). Lightning depends on segwit transactions therefore we need
466466
the witness data when querying the bitcoind backend for transaction details.
467-
467+
468468
- Start `bitcoind` running against testnet, and let it complete a full sync with
469469
the testnet chain (alternatively, use `--bitcoind.regtest` instead).
470470

@@ -544,8 +544,8 @@ bearer credentials allowing for delegation, attenuation, and other cool
544544
features. You can learn more about them in Alex Akselrod's [writeup on
545545
GitHub](https://github.com/lightningnetwork/lnd/issues/20).
546546

547-
Running `lncli create` to create a wallet, will by default generate
548-
the `admin.macaroon`, `read_only.macaroon`, and `macaroons.db`
547+
Running `lncli create` to create a wallet, will by default generate
548+
the `admin.macaroon`, `read_only.macaroon`, and `macaroons.db`
549549
files that are used to authenticate
550550
into `lnd`. They will be stored in the network directory (default:
551551
`lnddir/data/chain/bitcoin/mainnet`) so that it's possible to use a distinct
@@ -617,5 +617,5 @@ Notice the `[Bitcoin]` section. This section houses the parameters for the
617617
Bitcoin chain. See a more detailed sample config file available
618618
[here](https://github.com/lightningnetwork/lnd/blob/master/sample-lnd.conf)
619619
and explore the other sections for node configuration, including `[Btcd]`,
620-
`[Bitcoind]` and `[Neutrino]` depending on which chain and node type you're
620+
`[Bitcoind]` and `[Neutrino]` depending on which chain and node type you're
621621
using.

0 commit comments

Comments
 (0)