Skip to content

Commit ad95341

Browse files
committed
enhanche some notes as per review comments
1 parent 01b8446 commit ad95341

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

stackslib/src/config/mod.rs

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2210,15 +2210,18 @@ pub struct NodeConfig {
22102210
pub require_affirmed_anchor_blocks: bool,
22112211
/// Controls if the node must strictly wait for any PoX anchor block selected by the core consensus mechanism.
22122212
/// - If `true`: Halts burnchain processing immediately whenever a selected anchor block is missing locally
2213-
/// (`SelectedAndUnknown` status), regardless of affirmation status. This is always true in Nakamoto (Epoch 3.0+)
2214-
/// and runs *before* affirmation checks.
2213+
/// (`SelectedAndUnknown` status), regardless of affirmation status.
22152214
/// - If `false` (primarily for testing): Skips this immediate halt, allowing processing to proceed to
22162215
/// affirmation map checks.
22172216
/// Normal operation requires this to be `true`; setting to `false` will likely break consensus adherence.
22182217
/// ---
22192218
/// @default: `true`
22202219
/// @notes: |
2221-
/// - This parameter cannot be set via the configuration file; it must be modified programmatically.
2220+
/// - This parameter cannot be set via the configuration file;
2221+
/// it must be modified programmatically.
2222+
/// - This is intended strictly for testing purposes.
2223+
/// - The halt check runs *before* affirmation checks.
2224+
/// - In Nakamoto (Epoch 3.0+), all prepare phase have anchor blocks.
22222225
pub assume_present_anchor_blocks: bool,
22232226
/// Fault injection setting for testing purposes. If set to `Some(p)`, where `p` is between 0 and 100,
22242227
/// the node will have a `p` percent chance of intentionally *not* pushing a newly processed block
@@ -2940,7 +2943,7 @@ pub struct MinerConfig {
29402943
/// @default: `false` (Should only default true if [`MinerConfig::mining_key`] is set).
29412944
/// @deprecated: This setting is ignored in Epoch 3.0+.
29422945
/// @notes: |
2943-
/// - This is intended strictly for testing purposes for Epoch 2.5 conditions.
2946+
/// - This is intended strictly for testing Epoch 2.5 conditions.
29442947
pub pre_nakamoto_mock_signing: bool,
29452948
/// The minimum time to wait between mining blocks in milliseconds. The value must be greater
29462949
/// than or equal to 1000 ms because if a block is mined within the same second as its parent,
@@ -3070,7 +3073,8 @@ pub struct MinerConfig {
30703073
/// ---
30713074
/// @default: `{ 0: 180, 10: 90, 20: 45, 30: 0 }` (times in seconds)
30723075
/// @notes: |
3073-
/// - Keys are rejection weight percentages (0-100). Values are timeout durations.
3076+
/// - Keys are rejection weight percentages (0-100).
3077+
/// - Values are timeout durations.
30743078
/// @toml_example: |
30753079
/// # Keys are rejection counts (as strings), values are timeouts in seconds.
30763080
/// [miner.block_rejection_timeout_steps]
@@ -3528,9 +3532,10 @@ pub struct ConnectionOptionsFile {
35283532
/// ---
35293533
/// @default: `None` (authentication disabled for relevant endpoints)
35303534
/// @notes: |
3531-
/// - **Requirement:** This field **must** be configured if the node needs to receive
3532-
/// block proposals from a configured `stacks-signer` event_observer via the
3533-
/// `/v3/block_proposal` endpoint. The value must match the token configured on the signer.
3535+
/// - This field **must** be configured if the node needs to receive
3536+
/// block proposals from a configured `stacks-signer` [[events_observer]]
3537+
/// via the `/v3/block_proposal` endpoint.
3538+
/// - The value must match the token configured on the signer.
35343539
pub auth_token: Option<String>,
35353540
/// Minimum interval (in seconds) between attempts to run the Epoch 2.x anti-entropy data push mechanism.
35363541
///

0 commit comments

Comments
 (0)