Skip to content

Commit 723f16e

Browse files
committed
microblocks deprecated in 2.5. Add (X seconds) to ms configs
1 parent a6b6598 commit 723f16e

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

stackslib/src/config/mod.rs

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1746,24 +1746,24 @@ pub struct NodeConfig {
17461746
/// Enable microblock mining.
17471747
///
17481748
/// Default: `true`
1749-
/// Deprecated: Microblocks were removed in the Nakamoto upgrade. This setting is ignored in Epoch 3.0+.
1749+
/// Deprecated: This setting is ignored in Epoch 2.5+.
17501750
pub mine_microblocks: bool,
17511751
/// How often to attempt producing microblocks, in milliseconds.
17521752
/// Only applies when [`NodeConfig::mine_microblocks`] is true and before Epoch 2.5.
17531753
///
1754-
/// Default: `30_000`
1755-
/// Deprecated: Microblocks were removed in the Nakamoto upgrade. This setting is ignored in Epoch 3.0+.
1754+
/// Default: `30_000` ms (30 seconds)
1755+
/// Deprecated: This setting is ignored in Epoch 2.5+.
17561756
pub microblock_frequency: u64,
1757-
/// The maximum number of microblocks allowed per Stacks block (pre-Nakamoto).
1757+
/// The maximum number of microblocks allowed per Stacks block.
17581758
///
17591759
/// Default: `65535` (u16::MAX)
1760-
/// Deprecated: Microblocks were removed in the Nakamoto upgrade. This setting is ignored in Epoch 3.0+.
1760+
/// Deprecated: This setting is ignored in Epoch 2.5+.
17611761
pub max_microblocks: u64,
17621762
/// Cooldown period after a microblock is produced, in milliseconds.
17631763
/// Only applies when [`NodeConfig::mine_microblocks`] is true and before Epoch 2.5.
17641764
///
1765-
/// Default: `30_000`
1766-
/// Deprecated: Microblocks were removed in the Nakamoto upgrade. This setting is ignored in Epoch 3.0+.
1765+
/// Default: `30_000` ms (30 seconds)
1766+
/// Deprecated: This setting is ignored in Epoch 2.5+.
17671767
pub wait_time_for_microblocks: u64,
17681768
/// When operating as a miner, this specifies the maximum time (in milliseconds)
17691769
/// the node waits after detecting a new burnchain block to synchronize corresponding
@@ -1772,14 +1772,14 @@ pub struct NodeConfig {
17721772
/// to prevent stalling. This setting is loaded by all nodes but primarily affects
17731773
/// miner behavior within the relayer thread.
17741774
///
1775-
/// Default: `30_000`
1775+
/// Default: `30_000` ms (30 seconds)
17761776
pub wait_time_for_blocks: u64,
17771777
/// Controls how frequently, in milliseconds, the Nakamoto miner's relay thread polls for work
17781778
/// or takes periodic actions when idle (e.g., checking for new burnchain blocks).
17791779
/// Default value of 10 seconds is reasonable in mainnet (where bitcoin blocks are ~10 minutes)
17801780
/// A lower value might be useful in other environments with faster burn blocks.
17811781
///
1782-
/// Default: `10_000` (10 seconds)
1782+
/// Default: `10_000` ms (10 seconds)
17831783
pub next_initiative_delay: u64,
17841784
/// Optional network address and port (e.g., "127.0.0.1:9153") for binding the Prometheus metrics server.
17851785
/// If set, the node will start an HTTP server on this address to expose internal metrics
@@ -1809,7 +1809,7 @@ pub struct NodeConfig {
18091809
/// Sampling interval in seconds for the PoX synchronization watchdog thread (pre-Nakamoto).
18101810
/// Determines how often the watchdog checked PoX state consistency in the Neon run loop.
18111811
///
1812-
/// Default: `30`
1812+
/// Default: `30` seconds
18131813
/// Deprecated: Unused after the Nakamoto upgrade. This setting is ignored in Epoch 3.0+.
18141814
pub pox_sync_sample_secs: u64,
18151815
/// If set to `true`, the node initializes its state using an alternative test genesis block definition,

0 commit comments

Comments
 (0)