Skip to content

Commit c73f610

Browse files
committed
fix activated_vrf_key_path docs. minor secondary fixes
1 parent 85f2311 commit c73f610

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

stackslib/src/config/mod.rs

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2130,7 +2130,7 @@ pub struct MinerConfig {
21302130
/// Time to wait (in milliseconds) for subsequent attempts to mine a block,
21312131
/// after the first attempt fails.
21322132
///
2133-
/// Default: 12_0000 ms (2 minutes)
2133+
/// Default: 120_0000 ms (2 minutes)
21342134
/// Deprecated: This setting is ignored in Epoch 3.0+. Only used in the neon chain mode.
21352135
pub subsequent_attempt_time_ms: u64,
21362136
/// Time to wait (in milliseconds) to mine a microblock,
@@ -2224,7 +2224,7 @@ pub struct MinerConfig {
22242224
/// Amount of time while mining in nakamoto to wait in between mining interim blocks
22252225
///
22262226
/// Default: `None`
2227-
/// Deprecated: use `min_time_between_blocks_ms` instead.
2227+
/// Deprecated: use [`MinerConfig::min_time_between_blocks_ms`] instead.
22282228
pub wait_on_interim_blocks: Option<Duration>,
22292229
/// minimum number of transactions that must be in a block if we're going to replace a pending
22302230
/// block-commit with a new block-commit
@@ -2252,7 +2252,7 @@ pub struct MinerConfig {
22522252
///
22532253
/// Default: `None` (feature disabled).
22542254
/// Deprecated: This setting is ignored in Epoch 3.0+. Only used in the neon chain mode and
2255-
/// by the "get-spend-amount" cli subcommand.
2255+
/// by the `get-spend-amount` cli subcommand.
22562256
pub unconfirmed_commits_helper: Option<String>,
22572257
/// The minimum win probability this miner aims to achieve in block sortitions.
22582258
///
@@ -2266,11 +2266,17 @@ pub struct MinerConfig {
22662266
/// Default: `0.0`
22672267
/// Deprecated: This setting is ignored in Epoch 3.0+. Only used in the neon chain mode.
22682268
pub target_win_probability: f64,
2269-
/// Path to a serialized RegisteredKey struct, which points to an already-registered VRF key
2270-
/// (so we don't have to go make a new one)
2269+
/// Path to a file for storing and loading the currently active, registered VRF leader key.
2270+
///
2271+
/// Loading: On startup or when needing to register a key, if this path is set, the relayer first
2272+
/// attempts to load a serialized [`RegisteredKey`] from this file. If successful, it uses the
2273+
/// loaded key and skips the on-chain VRF key registration transaction, saving time and fees.
2274+
/// Saving: After a new VRF key registration transaction is confirmed and activated on the burnchain,
2275+
/// if this path is set, the node saves the details of the newly activated [`RegisteredKey`] to this file.
2276+
/// This allows the miner to persist its active VRF key across restarts.
2277+
/// If the file doesn't exist during load, or the path is `None`, the node proceeds with a new registration.
22712278
///
22722279
/// Default: `None`
2273-
/// Deprecated: This setting is ignored in Epoch 3.0+. Only used in the neon chain mode.
22742280
pub activated_vrf_key_path: Option<String>,
22752281
/// Controls how the miner estimates its win probability when checking for underperformance.
22762282
///
@@ -2286,7 +2292,7 @@ pub struct MinerConfig {
22862292
///
22872293
/// Default: `false`
22882294
/// Deprecated: This setting is ignored in Epoch 3.0+. Only used in the neon chain mode and
2289-
/// by the "get-spend-amount" cli subcommand.
2295+
/// by the `get-spend-amount` cli subcommand.
22902296
pub fast_rampup: bool,
22912297
/// The maximum number of consecutive Bitcoin blocks the miner will tolerate underperforming
22922298
/// (i.e., having a calculated win probability below [`MinerConfig::target_win_probability`])

0 commit comments

Comments
 (0)