From d6fd95d02aa53aa8da22f848af5b84529cce582c Mon Sep 17 00:00:00 2001 From: Will Winder Date: Fri, 20 Oct 2023 11:29:31 -0400 Subject: [PATCH] Add comment to initConsensusProtocols. --- config/consensus.go | 3 +++ 1 file changed, 3 insertions(+) diff --git a/config/consensus.go b/config/consensus.go index 190e5ce16a..c3592e40d9 100644 --- a/config/consensus.go +++ b/config/consensus.go @@ -788,6 +788,9 @@ func PreloadConfigurableConsensusProtocols(dataDirectory string) (ConsensusProto return Consensus.Merge(configurableConsensus), nil } +// initConsensusProtocols defines the consensus protocol values and how values change across different versions of the protocol. +// +// These are the only valid and tested consensus values and transitions. Other settings are not tested and may lead to unexpected behavior. func initConsensusProtocols() { // WARNING: copying a ConsensusParams by value into a new variable // does not copy the ApprovedUpgrades map. Make sure that each new