doc: warn that incoming conns are unlikely when not using default ports #20668

pull adamjonas wants to merge 1 commits into bitcoin:master from adamjonas:121520-non-standard-port-doc changing 2 files +6 −2

adamjonas commented at 2:33 AM on December 16, 2020: member

Closes #5150.

This was mostly copied from #5285 by sulks, who has since quit GitHub.

The issue has remained open for 6 years, but the extra explanation still seems useful.
DrahtBot added the label Docs on Dec 16, 2020
DrahtBot added the label P2P on Dec 16, 2020

laanwj commented at 10:27 AM on December 16, 2020: member

ACK b2bbc089888015e86ce3cbe145fd5a61695205ff

diff:

--- /tmp/1.log  2020-12-17 12:05:19.661809857 +0100
+++ /tmp/2.log  2020-12-17 12:04:46.502043685 +0100
@@ -1,4 +1,4 @@
-Bitcoin Core version v21.99.0-f0913f2f950c7a3e0a14d32216bd6ce4e19d85df
+Bitcoin Core version v21.99.0-6d74b0e0ac6e9bc63a893ca3cfe33362d445f595
 Copyright (C) 2009-2020 The Bitcoin Core developers
 
 Please contribute if you find Bitcoin Core useful. Visit
@@ -238,8 +238,9 @@
        Relay non-P2SH multisig (default: 1)
 
   -port=<port>
-       Listen for connections on <port> (default: 8333, testnet: 18333 signet:
-       38333, regtest: 18444)
+       Listen for connections on <port>. Nodes not using the default ports
+       (default: 8333, testnet: 18333, signet: 38333, regtest: 18444)
+       are unlikely to get incoming connections.
 
   -proxy=<ip:port>
        Connect through SOCKS5 proxy, set -noproxy to disable (default:

re-ACK 010eed3ce03cf4fc622a48f40fc4d589383f7a44

in src/init.cpp:453 in b2bbc08988 outdated

 449 | @@ -450,7 +450,7 @@ void SetupServerArgs(NodeContext& node)
 450 |      argsman.AddArg("-peerbloomfilters", strprintf("Support filtering of blocks and transaction with bloom filters (default: %u)", DEFAULT_PEERBLOOMFILTERS), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
 451 |      argsman.AddArg("-peerblockfilters", strprintf("Serve compact block filters to peers per BIP 157 (default: %u)", DEFAULT_PEERBLOCKFILTERS), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
 452 |      argsman.AddArg("-permitbaremultisig", strprintf("Relay non-P2SH multisig (default: %u)", DEFAULT_PERMIT_BAREMULTISIG), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
 453 | -    argsman.AddArg("-port=<port>", strprintf("Listen for connections on <port> (default: %u, testnet: %u signet: %u, regtest: %u)", defaultChainParams->GetDefaultPort(), testnetChainParams->GetDefaultPort(), signetChainParams->GetDefaultPort(), regtestChainParams->GetDefaultPort()), ArgsManager::ALLOW_ANY | ArgsManager::NETWORK_ONLY, OptionsCategory::CONNECTION);
 454 | +    argsman.AddArg("-port=<port>", strprintf("Listen for connections on <port>. Nodes not using the default ports (default: %u, testnet: %u, signet: %u, regtest: %u) will be unlikely to get incoming connections.", defaultChainParams->GetDefaultPort(), testnetChainParams->GetDefaultPort(), signetChainParams->GetDefaultPort(), regtestChainParams->GetDefaultPort()), ArgsManager::ALLOW_ANY | ArgsManager::NETWORK_ONLY, OptionsCategory::CONNECTION);

jonatack commented at 11:45 AM on December 16, 2020:

thanks for fixing up the grammar while here

tried to make this part more easy/clear, not sure it's better ("not using"..."not see" symmetry)

    argsman.AddArg("-port=<port>", strprintf("Listen for connections on <port>. Nodes not using the default ports (default: %u, testnet: %u, signet: %u, regtest: %u) will likely not see incoming connections.", defaultChainParams->GetDefaultPort(), testnetChainParams->GetDefaultPort(), signetChainParams->GetDefaultPort(), regtestChainParams->GetDefaultPort()), ArgsManager::ALLOW_ANY | ArgsManager::NETWORK_ONLY, OptionsCategory::CONNECTION);

practicalswift commented at 12:03 PM on December 16, 2020:

Nit: "are" instead of "will be"?

jonatack commented at 11:49 AM on December 16, 2020: member

utACK b2bbc089888015e86ce3cbe145fd5a61695205ff
MarcoFalke commented at 11:59 AM on December 16, 2020: member

ACK b2bbc089888015e86ce3cbe145fd5a61695205ff

Nice find
doc: warn that incoming conns are unlikely when not using default ports 010eed3ce0
adamjonas force-pushed on Dec 16, 2020
adamjonas commented at 2:27 PM on December 16, 2020: member

Updated to go with @practicalswift's readability recommendation.

Thanks for the quick review and suggestions.
laanwj merged this on Dec 17, 2020
laanwj closed this on Dec 17, 2020
MarcoFalke referenced this in commit 84e8d5467f on Dec 17, 2020
sidhujag referenced this in commit 24de220d34 on Dec 17, 2020
MarcoFalke referenced this in commit 22a9018649 on Oct 25, 2021
DrahtBot locked this on Feb 15, 2022

Contributors

Labels

Linked (view graph)

#5150 Should a warning be thrown when using -port that nodes are very unlikely to get any incoming connections? #5285 Add explanation regarding non-standard port to init.cpp and net.cpp.#23306 Make AddrMan support multiple ports per IP