solana_sdk/
poh_config.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
//! Definitions of Solana's proof of history.

use {
    crate::{clock::DEFAULT_TICKS_PER_SECOND, unchecked_div_by_const},
    std::time::Duration,
};

#[derive(Serialize, Deserialize, Clone, Debug, AbiExample, Eq, PartialEq)]
pub struct PohConfig {
    /// The target tick rate of the cluster.
    pub target_tick_duration: Duration,

    /// The target total tick count to be produced; used for testing only
    pub target_tick_count: Option<u64>,

    /// How many hashes to roll before emitting the next tick entry.
    /// None enables "Low power mode", which makes the validator sleep
    /// for `target_tick_duration` instead of hashing
    pub hashes_per_tick: Option<u64>,
}

impl PohConfig {
    pub fn new_sleep(target_tick_duration: Duration) -> Self {
        Self {
            target_tick_duration,
            hashes_per_tick: None,
            target_tick_count: None,
        }
    }
}

impl Default for PohConfig {
    fn default() -> Self {
        Self::new_sleep(Duration::from_micros(unchecked_div_by_const!(
            1000 * 1000,
            DEFAULT_TICKS_PER_SECOND
        )))
    }
}