Merge pull request #2945 from nspcc-dev/adj-minpeers-doc

docs: add minor note to `MinPeers` config section
This commit is contained in:
Roman Khimov 2023-03-22 18:03:18 +03:00 committed by GitHub
commit de7bff9cea
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -86,7 +86,9 @@ where:
sender stored in a local pool. sender stored in a local pool.
- `MaxPeers` (`int`) is the maximum numbers of peers that can be connected to the server. - `MaxPeers` (`int`) is the maximum numbers of peers that can be connected to the server.
- `MinPeers` (`int`) is the minimum number of peers for normal operation; when the node has - `MinPeers` (`int`) is the minimum number of peers for normal operation; when the node has
less than this number of peers it tries to connect with some new ones. less than this number of peers it tries to connect with some new ones. Note that consensus
node won't start the consensus process until at least `MinPeers` number of peers are
connected.
- `PingInterval` (`Duration`) is the interval used in pinging mechanism for syncing - `PingInterval` (`Duration`) is the interval used in pinging mechanism for syncing
blocks. blocks.
- `PingTimeout` (`Duration`) is the time to wait for pong (response for sent ping request). - `PingTimeout` (`Duration`) is the time to wait for pong (response for sent ping request).