Skip to content

Commit 2a6fcf9

Browse files
committed
init, doc: improve -onlynet help and tor/i2p documentation
and harmonize them as follows - s/outgoing/automatic outbound/ - s/Incoming/Inbound and manual/ (are not affected by this option.) - s/only through network/only to network/ - s/this option. This option/this option. It/ - s/network types/networks/ and also pick up a few nits in doc/p2p-bad-ports.md Github-Pull: bitcoin#24468 Rebased-From: a1db99a
1 parent cbdfb46 commit 2a6fcf9

File tree

4 files changed

+11
-11
lines changed

4 files changed

+11
-11
lines changed

doc/i2p.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,9 @@ logging` for more information.
6565
-onlynet=i2p
6666
```
6767

68-
Make outgoing connections only to I2P addresses. Incoming connections are not
69-
affected by this option. It can be specified multiple times to allow multiple
70-
network types, e.g. onlynet=onion, onlynet=i2p.
68+
Make automatic outbound connections only to I2P addresses. Inbound and manual
69+
connections are not affected by this option. It can be specified multiple times
70+
to allow multiple networks, e.g. onlynet=onion, onlynet=i2p.
7171

7272
I2P support was added to Bitcoin Core in version 22.0 and there may be fewer I2P
7373
peers than Tor or IP ones. Therefore, using I2P alone without other networks may

doc/p2p-bad-ports.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
When Bitcoin Core automatically opens outgoing P2P connections it chooses
1+
When Bitcoin Core automatically opens outgoing P2P connections, it chooses
22
a peer (address and port) from its list of potential peers. This list is
3-
populated with unchecked data, gossiped over the P2P network by other peers.
3+
populated with unchecked data gossiped over the P2P network by other peers.
44

55
A malicious actor may gossip an address:port where no Bitcoin node is listening,
66
or one where a service is listening that is not related to the Bitcoin network.
@@ -17,7 +17,7 @@ authentication are unlikely to be considered a malicious action,
1717
e.g. port 80 (http).
1818

1919
Below is a list of "bad" ports which Bitcoin Core avoids when choosing a peer to
20-
connect to. If a node is listening on such a port, it will likely receive less
20+
connect to. If a node is listening on such a port, it will likely receive fewer
2121
incoming connections.
2222

2323
1: tcpmux

doc/tor.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,10 @@ outgoing connections, but more is possible.
5555
-seednode=X SOCKS5. In Tor mode, such addresses can also be exchanged with
5656
other P2P nodes.
5757

58-
-onlynet=onion Make outgoing connections only to .onion addresses. Incoming
59-
connections are not affected by this option. This option can be
60-
specified multiple times to allow multiple network types, e.g.
61-
onlynet=onion, onlynet=i2p.
58+
-onlynet=onion Make automatic outbound connections only to .onion addresses.
59+
Inbound and manual connections are not affected by this option.
60+
It can be specified multiple times to allow multiple networks,
61+
e.g. onlynet=onion, onlynet=i2p.
6262

6363
In a typical situation, this suffices to run behind a Tor proxy:
6464

src/init.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -462,7 +462,7 @@ void SetupServerArgs(ArgsManager& argsman)
462462
argsman.AddArg("-onion=<ip:port>", "Use separate SOCKS5 proxy to reach peers via Tor onion services, set -noonion to disable (default: -proxy)", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
463463
argsman.AddArg("-i2psam=<ip:port>", "I2P SAM proxy to reach I2P peers and accept I2P connections (default: none)", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
464464
argsman.AddArg("-i2pacceptincoming", "If set and -i2psam is also set then incoming I2P connections are accepted via the SAM proxy. If this is not set but -i2psam is set then only outgoing connections will be made to the I2P network. Ignored if -i2psam is not set. Listening for incoming I2P connections is done through the SAM proxy, not by binding to a local address and port (default: 1)", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
465-
argsman.AddArg("-onlynet=<net>", "Make automatic outgoing connections only through network <net> (" + Join(GetNetworkNames(), ", ") + "). Incoming connections are not affected by this option. This option can be specified multiple times to allow multiple networks.", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
465+
argsman.AddArg("-onlynet=<net>", "Make automatic outbound connections only to network <net> (" + Join(GetNetworkNames(), ", ") + "). Inbound and manual connections are not affected by this option. It can be specified multiple times to allow multiple networks.", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
466466
argsman.AddArg("-peerbloomfilters", strprintf("Support filtering of blocks and transaction with bloom filters (default: %u)", DEFAULT_PEERBLOOMFILTERS), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
467467
argsman.AddArg("-peerblockfilters", strprintf("Serve compact block filters to peers per BIP 157 (default: %u)", DEFAULT_PEERBLOCKFILTERS), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
468468
argsman.AddArg("-permitbaremultisig", strprintf("Relay non-P2SH multisig (default: %u)", DEFAULT_PERMIT_BAREMULTISIG), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);

0 commit comments

Comments
 (0)