@@ -1664,7 +1664,7 @@ pub struct NodeConfig {
1664
1664
/// The node's Bitcoin wallet private key, provided as a hex string in the config file.
1665
1665
/// Used to initialize the node's keychain for signing operations.
1666
1666
/// If `miner.mining_key` is not set, this seed may also be used for mining-related signing.
1667
- /// Required if the node is configured as a miner (`node. miner = true`) and `miner. mining_key` is absent.
1667
+ /// Required if [`NodeConfig:: miner`] is ` true` and [`MinerConfig:: mining_key`] is absent.
1668
1668
///
1669
1669
/// Default: Randomly generated 32 bytes.
1670
1670
pub seed : Vec < u8 > ,
@@ -1700,7 +1700,7 @@ pub struct NodeConfig {
1700
1700
pub p2p_address : String ,
1701
1701
/// The private key seed, provided as a hex string in the config file, used specifically for the
1702
1702
/// node's identity and message signing within the P2P networking layer.
1703
- /// This is separate from the main `node. seed`.
1703
+ /// This is separate from the main [`NodeConfig:: seed`] .
1704
1704
///
1705
1705
/// Default: Randomly generated 32 bytes.
1706
1706
pub local_peer_seed : Vec < u8 > ,
@@ -1721,8 +1721,8 @@ pub struct NodeConfig {
1721
1721
/// Default: Empty vector `[]`.
1722
1722
pub deny_nodes : Vec < Neighbor > ,
1723
1723
/// Flag indicating whether this node should activate its mining logic and attempt to produce Stacks blocks.
1724
- /// Setting this to `true` typically requires providing necessary private keys (either `node. seed` or `miner. mining_key`).
1725
- /// It also influences default behavior for settings like ` require_affirmed_anchor_blocks`.
1724
+ /// Setting this to `true` typically requires providing necessary private keys (either [`NodeConfig:: seed`] or [`MinerConfig:: mining_key`] ).
1725
+ /// It also influences default behavior for settings like [`NodeConfig:: require_affirmed_anchor_blocks`] .
1726
1726
///
1727
1727
/// Default: `false`
1728
1728
pub miner : bool ,
@@ -1732,12 +1732,14 @@ pub struct NodeConfig {
1732
1732
/// Default: `false`
1733
1733
pub stacker : bool ,
1734
1734
/// Enables a simulated mining mode, primarily for local testing and development.
1735
- /// When `true`, *and* [`NodeConfig::miner`] is also `true`, the node may generate blocks
1736
- /// locally without participating in the real bitcoin consensus or P2P block production process.
1735
+ /// When `true`, the node may generate blocks locally without participating in the
1736
+ /// real bitcoin consensus or P2P block production process.
1737
+ ///
1738
+ /// Only relevant if [`NodeConfig::miner`] is `true`.
1737
1739
///
1738
1740
/// Default: `false`
1739
1741
pub mock_mining : bool ,
1740
- /// If ` mock_mining` is enabled, this specifies an optional directory path where the
1742
+ /// If [`NodeConfig:: mock_mining`] is enabled, this specifies an optional directory path where the
1741
1743
/// generated mock Stacks blocks will be saved. (pre-Nakamoto)
1742
1744
/// The path is canonicalized on load.
1743
1745
///
@@ -1749,8 +1751,8 @@ pub struct NodeConfig {
1749
1751
/// Default: `true`
1750
1752
/// Deprecated: Microblocks were removed in the Nakamoto upgrade. This setting is ignored in Epoch 3.0+.
1751
1753
pub mine_microblocks : bool ,
1752
- /// How often to attempt producing microblocks, in milliseconds (pre-Nakamoto) .
1753
- /// Only applies when ` mine_microblocks` is true and before Epoch 3.0 .
1754
+ /// How often to attempt producing microblocks, in milliseconds.
1755
+ /// Only applies when [`NodeConfig:: mine_microblocks`] is true and before Epoch 2.5 .
1754
1756
///
1755
1757
/// Default: `30_000`
1756
1758
/// Deprecated: Microblocks were removed in the Nakamoto upgrade. This setting is ignored in Epoch 3.0+.
@@ -1760,8 +1762,8 @@ pub struct NodeConfig {
1760
1762
/// Default: `65535` (u16::MAX)
1761
1763
/// Deprecated: Microblocks were removed in the Nakamoto upgrade. This setting is ignored in Epoch 3.0+.
1762
1764
pub max_microblocks : u64 ,
1763
- /// Cooldown period after a microblock is produced, in milliseconds (pre-Nakamoto) .
1764
- /// Only applies when ` mine_microblocks` is true and before Epoch 3.0 .
1765
+ /// Cooldown period after a microblock is produced, in milliseconds.
1766
+ /// Only applies when [`NodeConfig:: mine_microblocks`] is true and before Epoch 2.5 .
1765
1767
///
1766
1768
/// Default: `30_000`
1767
1769
/// Deprecated: Microblocks were removed in the Nakamoto upgrade. This setting is ignored in Epoch 3.0+.
@@ -1865,12 +1867,12 @@ pub struct NodeConfig {
1865
1867
/// This thread periodically wakes up the main coordinator to check for chain progress or
1866
1868
/// other conditions requiring action.
1867
1869
///
1868
- /// Default: `300` (5 minutes)
1870
+ /// Default: `300` seconds (5 minutes)
1869
1871
pub chain_liveness_poll_time_secs : u64 ,
1870
1872
/// A list of specific StackerDB contracts (identified by their qualified contract identifiers,
1871
1873
/// e.g., "SP000000000000000000002Q6VF78.pox-3") that this node should actively replicate.
1872
1874
///
1873
- /// Default: The initial list depends on the `node. miner` and `node. stacker` settings:
1875
+ /// Default: The initial list depends on the [`NodeConfig:: miner`] and [`NodeConfig:: stacker`] settings:
1874
1876
/// - If `miner = true` or `stacker = true`: Relevant system contracts (like `.miners`
1875
1877
/// and `.signers-*`) are automatically added during configuration loading, in addition
1876
1878
/// to any contracts specified in the configuration file.
0 commit comments