Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: adjust StandByCommittee node config documentation #3375

Merged
merged 1 commit into from
Mar 27, 2024

Conversation

AnnaShaleva
Copy link
Member

Add a note about elements order.

@AnnaShaleva AnnaShaleva added this to the v0.106.0 milestone Mar 27, 2024
@AnnaShaleva AnnaShaleva added the documentation Improvements or additions to documentation label Mar 27, 2024
@@ -345,7 +345,7 @@ protocol-related settings described in the table below.
| P2PStateExchangeExtensions | `bool` | `false` | Enables the following P2P MPT state data exchange logic: <br>• `StateSyncInterval` protocol setting <br>• P2P commands `GetMPTDataCMD` and `MPTDataCMD` | Not supported by the C# node, thus may affect heterogeneous networks functionality. Can be supported either on MPT-complete node (`KeepOnlyLatestState`=`false`) or on light GC-enabled node (`RemoveUntraceableBlocks=true`) in which case `KeepOnlyLatestState` setting doesn't change the behavior, an appropriate set of MPTs is always stored (see `RemoveUntraceableBlocks`). |
| ReservedAttributes | `bool` | `false` | Allows to have reserved attributes range for experimental or private purposes. |
| SeedList | `[]string` | [] | List of initial nodes addresses used to establish connectivity. |
| StandbyCommittee | `[]string` | [] | List of public keys of standby committee validators are chosen from. |
| StandbyCommittee | `[]string` | [] | List of public keys of standby committee validators are chosen from. Note that it's not required to be sorted, but this list must have the same order of elements within configuration files of all the nodes in the network. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| StandbyCommittee | `[]string` | [] | List of public keys of standby committee validators are chosen from. Note that it's not required to be sorted, but this list must have the same order of elements within configuration files of all the nodes in the network. |
| StandbyCommittee | `[]string` | [] | List of public keys of standby committee validators are chosen from. Note that it's not required to be sorted, but the list must be exactly the same in configuration files of all the nodes in the network. |

is more straighforward imo

Add a note about elements order.

Signed-off-by: Anna Shaleva <shaleva.ann@nspcc.ru>
@AnnaShaleva AnnaShaleva merged commit 86f16bb into master Mar 27, 2024
1 check passed
@AnnaShaleva AnnaShaleva deleted the standby-note branch March 27, 2024 18:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants