Skip to content

Commit e366e6d

Browse files
committed
Update README
1 parent a3ffd2f commit e366e6d

1 file changed

Lines changed: 22 additions & 5 deletions

File tree

README.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -65,12 +65,29 @@ Numbers of the Ethereum Consensus Layer do not match existing numbers from other
6565

6666
## Install
6767

68-
### From source
68+
### Go Version
69+
70+
Nebula has a hard dependency on Go 1.19 because Nebula requires go-libp2p
71+
`<0.30`. With version `0.30` go-libp2p dropped support for the `quic` transport
72+
and only continues to support `quic-v1` ([release notes](https://github.com/libp2p/go-libp2p/releases/tag/v0.30.0)). However, many peers in the IPFS Amino
73+
DHT still only listen on `quic` addresses (as opposed to `quic-v1`). Many of them
74+
also listen over `tcp` but from experiments I saw that they often refuse
75+
connections over tcp. As of 2023-12-02 this results in a significant increase of
76+
undialable peers that Nebula was previously able to connect to and identify.
77+
78+
Until the error incurred by dropping the `quic` transport is negligible or some
79+
new go-libp2p feature justifies and update, Nebula will stick to the old
80+
go-libp2p version.
6981

70-
To compile it yourself run:
82+
Because go-libp2p has a dependency on quic-go and specific versions of quic-go
83+
can only be compiled with specific versions of Go. I'm currently sticking to
84+
Go 1.19 but it might be possible to update to Go 1.20 - I just haven't had the
85+
time to test this yet.
86+
87+
### From source
7188

7289
```shell
73-
go install github.com/dennis-tra/nebula-crawler/cmd/nebula@latest # Go 1.19 or higher is required (may work with a lower version too)
90+
go install github.com/dennis-tra/nebula-crawler/cmd/nebula@2.1.2
7491
```
7592

7693
Make sure the `$GOPATH/bin` is in your PATH variable to access the installed `nebula` executable.
@@ -103,7 +120,7 @@ nebula networks
103120
To store crawl results as JSON files provide the `--json-out` command line flag like so:
104121

105122
```shell
106-
nebula crawl --json-out ./results/
123+
nebula --json-out ./results/ crawl
107124
```
108125

109126
After the crawl has finished, you will find the JSON files in the `./results/` subdirectory.
@@ -322,7 +339,7 @@ To run the tests you need a running test database instance:
322339

323340
```shell
324341
make database
325-
go test ./...
342+
make test
326343
```
327344

328345
## Report

0 commit comments

Comments
 (0)