Make it clear that the default port for ETH2 is 9000 udp/tcp

[actuallymentor]

Hello team!

The only place where the default port is explicitly mentioned is in a troubleshooting section which is suboptimal for people trying to find the right ports for firewall configuration.

Please confirm that 9000 on both udp/tcp is the default, right now I am only going on that troubleshooting section.

[actuallymentor]

Update, the port is indeed 9000, see network.nim.

Thanks for checking @jclapis.

[kdeme]

Thank you for pointing out that it is not clear what the default used port is.
While documentation can help here somewhat, the best UX solution is to simply have this added in the --help print.
There is an open issue to take care of this consistently for all defaults: status-im/nim-confutils#19

[kdeme]

As this is a dump of the --help command, I wouldn't really alter the documentation here.

[arnetheduck]

@deme we can actually change the help docs in conf.nim manually for the time being, until proper support is added in confutils

[kdeme]

Yup, that was what I was implying on, rather change it there for now then just in these docs here.

[actuallymentor]

Thank you for pointing out that it is not clear what the default used port is.
While documentation can help here somewhat, the best UX solution is to simply have this added in the --help print.
There is an open issue to take care of this consistently for all defaults: status-im/nim-confutils#19

I see. Do I understand from that conversation there is already a PR for it or should I do that?

[arnetheduck]

Thank you for pointing out that it is not clear what the default used port is.
While documentation can help here somewhat, the best UX solution is to simply have this added in the --help print.
There is an open issue to take care of this consistently for all defaults: status-im/nim-confutils#19

I see. Do I understand from that conversation there is already a PR for it or should I do that?

if you can update the help text in conf.nim here as well, that's great - there's no PR presently:

nimbus-eth2/beacon_chain/conf.nim

Line 157 in f3fc551

desc: "Listening TCP port for Ethereum LibP2P traffic"

[actuallymentor]

@arnetheduck I just edited the descriptions in conf.nim and added the same text to the docs. Let me know if this suffices!