Skip to content

Commit e7f41fa

Browse files
committed
README: add version compatibility table
1 parent ad4e1e9 commit e7f41fa

File tree

1 file changed

+18
-7
lines changed

1 file changed

+18
-7
lines changed

README.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -57,25 +57,36 @@ problems. Community support is also available in the
5757
LND and the loop client are using Go modules. Make sure that the `GO111MODULE`
5858
env variable is set to `on`.
5959

60-
In order to execute a swap, **You need to run lnd 0.7.1+, or master built with
61-
sub-servers enabled.**
60+
In order to execute a swap, **you need to run a compatible lnd version built
61+
with the correct sub-servers enabled.**
6262

6363
### LND
6464

65-
If you are building from source, and not using a 0.7.1 or higher release of
66-
lnd, make sure that you are using the `master` branch of lnd. You can get this
67-
by git cloning the repository
65+
To run loop, you need a compatible version of `lnd` running. It is generally
66+
recommended to always keep both `lnd` and `loop` updated to the most recent
67+
released version. If you need to run an older version of `lnd`, please consult
68+
the following table for supported versions.
69+
70+
Loop Version | Compatible LND Version(s)
71+
------------------|------------------
72+
`>= v0.6.0-beta` | `v0.10.x-beta`
73+
`<= 0.5.1-beta` | `v0.7.1-beta` - `v0.10.x-beta`
74+
75+
If you are building from source make sure you are using the latest tagged
76+
version of lnd. You can get this by git cloning the repository and checking out
77+
a specific tag:
6878

6979
```
7080
git clone https://github.com/lightningnetwork/lnd.git
81+
cd lnd
82+
git checkout v0.10.0-beta
7183
```
7284

7385
Once the lnd repository is cloned, it will need to be built with special build
7486
tags that enable the swap. This enables the required lnd rpc services.
7587

7688
```
77-
cd lnd
78-
make install tags="signrpc walletrpc chainrpc invoicesrpc routerrpc"
89+
make install tags="signrpc walletrpc chainrpc invoicesrpc"
7990
```
8091

8192
Check to see if you have already installed lnd. If you have, you will need to

0 commit comments

Comments
 (0)