From 522debac470927cf4511ad9737229aef91afdadc Mon Sep 17 00:00:00 2001 From: Ruben Buniatyan Date: Wed, 9 Oct 2024 16:40:10 +0200 Subject: [PATCH] Revise configuration docs (#7576) --- src/Nethermind/Nethermind.Config/IBlocksConfig.cs | 4 ++-- .../CensorshipDetector/ICensorshipDetectorConfig.cs | 8 +++----- 2 files changed, 5 insertions(+), 7 deletions(-) diff --git a/src/Nethermind/Nethermind.Config/IBlocksConfig.cs b/src/Nethermind/Nethermind.Config/IBlocksConfig.cs index f7a929174d6..72b5446a97d 100644 --- a/src/Nethermind/Nethermind.Config/IBlocksConfig.cs +++ b/src/Nethermind/Nethermind.Config/IBlocksConfig.cs @@ -37,10 +37,10 @@ public interface IBlocksConfig : IConfig [ConfigItem(Description = "Whether to pre-warm the state when processing blocks. This can lead to an up to 2x speed-up in the main loop block processing.", DefaultValue = "True")] bool PreWarmStateOnBlockProcessing { get; set; } - [ConfigItem(Description = "Block Production timeout, in milliseconds.", DefaultValue = "4000")] + [ConfigItem(Description = "The block production timeout, in milliseconds.", DefaultValue = "4000")] int BlockProductionTimeoutMs { get; set; } - [ConfigItem(Description = "Genesis block load timeout, in milliseconds.", DefaultValue = "40000")] + [ConfigItem(Description = "The genesis block load timeout, in milliseconds.", DefaultValue = "40000")] int GenesisTimeoutMs { get; set; } byte[] GetExtraDataBytes(); diff --git a/src/Nethermind/Nethermind.Consensus/Processing/CensorshipDetector/ICensorshipDetectorConfig.cs b/src/Nethermind/Nethermind.Consensus/Processing/CensorshipDetector/ICensorshipDetectorConfig.cs index 259636bb7ca..e71ffff02e1 100644 --- a/src/Nethermind/Nethermind.Consensus/Processing/CensorshipDetector/ICensorshipDetectorConfig.cs +++ b/src/Nethermind/Nethermind.Consensus/Processing/CensorshipDetector/ICensorshipDetectorConfig.cs @@ -7,15 +7,13 @@ namespace Nethermind.Consensus.Processing.CensorshipDetector; public interface ICensorshipDetectorConfig : IConfig { - [ConfigItem(DefaultValue = "false", - Description = "Enabling censorship detection feature")] + [ConfigItem(DefaultValue = "false", Description = "Whether to enable censorship detection.")] bool Enabled { get; set; } [ConfigItem(DefaultValue = "2", - Description = "Number of consecutive blocks with detected potential censorship to report censorship attempt")] + Description = "The number of the consecutive blocks with detected potential censorship to report.")] uint BlockCensorshipThreshold { get; set; } - [ConfigItem(DefaultValue = "null", - Description = "The addresses for which censorship is being detected.")] + [ConfigItem(DefaultValue = "null", Description = "The addresses to detect censorship for.")] string[]? AddressesForCensorshipDetection { get; set; } }