Merge #21394: [doc] Improve comment about protected peers

fanquake · fanquake · commit a13a8cd8e317 · 2021-03-12T13:11:10.000+08:00
ebde946 [doc] Improve comment about protected peers (Amiti Uttarwar) Pull request description: The comment currently suggests a long-standing node would infrequently protect peers under normal circumstances. Clarify that we also protect peers that are synced to the same work as our chain tip. [Relevant check here](https://github.com/bitcoin/bitcoin/blob/ee0dc02c6f93de2a366bbff490eb4d37bca6a24f/src/net_processing.cpp#L1997). ACKs for top commit: Empact: ACK bitcoin/bitcoin@ebde946 jnewbery: ACK ebde946 Tree-SHA512: 3692f4098e95f935d801e0ee6bbd3a7c9480e66ca070a7c68ba79c4fc2e62377f5d37080c7b6a7d15ab617aaf4d3df9b26abc4f1b090d572ba46fdd092a6a64a
diff --git a/src/net_processing.cpp b/src/net_processing.cpp
@@ -557,7 +557,7 @@ struct CNodeState {
       *   - its connection type is IsBlockOnlyConn() == false
       *   - it gave us a valid connecting header
       *   - we haven't reached MAX_OUTBOUND_PEERS_TO_PROTECT_FROM_DISCONNECT yet
-      *   - it has a better chain than we have
+      *   - its chain tip has at least as much work as ours
       *
       * CHAIN_SYNC_TIMEOUT: if a peer's best known block has less work than our tip,
       * set a timeout CHAIN_SYNC_TIMEOUT seconds in the future:

Original file line number	Diff line number	Diff line change
`@@ -557,7 +557,7 @@ struct CNodeState {`
`557`	`557`	`* - its connection type is IsBlockOnlyConn() == false`
`558`	`558`	`* - it gave us a valid connecting header`
`559`	`559`	`* - we haven't reached MAX_OUTBOUND_PEERS_TO_PROTECT_FROM_DISCONNECT yet`
`560`		`- * - it has a better chain than we have`
	`560`	`+ * - its chain tip has at least as much work as ours`
`561`	`561`	`*`
`562`	`562`	`* CHAIN_SYNC_TIMEOUT: if a peer's best known block has less work than our tip,`
`563`	`563`	`* set a timeout CHAIN_SYNC_TIMEOUT seconds in the future:`