solana-ledger 3.1.12

Solana ledger
Documentation 
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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

use strum::{Display, EnumString, EnumVariantNames, IntoStaticStr, VariantNames};

/// When should snapshot archives be used at startup?
#[derive(
    Debug, Default, Clone, Copy, PartialEq, Eq, Display, EnumString, EnumVariantNames, IntoStaticStr,
)]
#[strum(serialize_all = "kebab-case")]
pub enum UseSnapshotArchivesAtStartup {
    /// If snapshot archives are used, they will be extracted and overwrite any existing state
    /// already on disk.  This will incur the associated runtime costs for extracting.
    Always,
    /// If snapshot archives are not used, then the local snapshot state already on disk is
    /// used instead.  If there is no local state on disk, startup will fail.
    Never,
    /// Only use snapshot archives if they are newer than the local snapshot state on disk.
    /// This can happen if a node is stopped and a new snapshot archive is downloaded before
    /// restarting.  At startup, the snapshot archive would be the newest and loaded from.
    /// Note, this also implies that snapshot archives will be used if there is no local snapshot
    /// state on disk.
    #[default]
    WhenNewest,
}

pub mod cli {
    use super::*;

    pub const NAME: &str = "use_snapshot_archives_at_startup";
    pub const LONG_ARG: &str = "use-snapshot-archives-at-startup";
    pub const HELP: &str = "When should snapshot archives be used at startup?";
    #[rustfmt::skip]
    pub const LONG_HELP: &str = "At startup, when should snapshot archives be extracted \
        versus using what is already on disk?\n\
        Specifying \"always\" will always startup by extracting snapshot archives and disregard \
        any snapshot-related state already on disk. Note that starting up from snapshot archives \
        will incur the runtime costs associated with extracting the archives and rebuilding the \
        local state.\n\
        Specifying \"never\" will never startup from snapshot archives and will only use \
        snapshot-related state already on disk. If there is no state already on disk, startup will \
        fail. Note, this will use the latest state available, which may be newer than the latest \
        snapshot archive.\n\
        Specifying \"when-newest\" will use snapshot-related state already on disk unless there \
        are snapshot archives newer than it. This can happen if a new snapshot archive is \
        downloaded while the node is stopped.";

    pub const POSSIBLE_VALUES: &[&str] = UseSnapshotArchivesAtStartup::VARIANTS;

    pub fn default_value() -> &'static str {
        UseSnapshotArchivesAtStartup::default().into()
    }

    pub fn default_value_for_ledger_tool() -> &'static str {
        UseSnapshotArchivesAtStartup::Always.into()
    }
}