From 6fcb7d9b9882da13a3574b8154e386079bb9565f Mon Sep 17 00:00:00 2001 From: Hugo C <911307+hugocaillard@users.noreply.github.com> Date: Thu, 16 May 2024 10:54:20 +0200 Subject: [PATCH] docs: add rustdoc to next_initiative_delay Co-authored-by: Aaron Blankstein --- testnet/stacks-node/src/config.rs | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/testnet/stacks-node/src/config.rs b/testnet/stacks-node/src/config.rs index 76a8ab2f2..7411fc2cf 100644 --- a/testnet/stacks-node/src/config.rs +++ b/testnet/stacks-node/src/config.rs @@ -1781,6 +1781,12 @@ pub struct NodeConfig { pub max_microblocks: u64, pub wait_time_for_microblocks: u64, pub wait_time_for_blocks: u64, + /// Controls how frequently, in milliseconds, the nakamoto miner's relay thread acts on its own initiative + /// (as opposed to responding to an event from the networking thread, etc.). This is roughly + /// how frequently the miner checks if a new burnchain block has been processed. + /// + /// Default value of 10 seconds is reasonable in mainnet (where bitcoin blocks are ~10 minutes), + /// but environments where burn blocks are more frequent may want to decrease this value. pub next_initiative_delay: u64, pub prometheus_bind: Option, pub marf_cache_strategy: Option,