casper-storage 2.1.1

Storage for a node on the Casper network.
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
55
56
57
58
59
60
61
62
63

use casper_types::{execution::Effects, Digest, ProtocolUpgradeConfig};

use crate::system::protocol_upgrade::ProtocolUpgradeError;

/// Request to upgrade the protocol.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ProtocolUpgradeRequest {
    config: ProtocolUpgradeConfig,
}

impl ProtocolUpgradeRequest {
    /// Creates a new instance of ProtocolUpgradeRequest.
    pub fn new(config: ProtocolUpgradeConfig) -> Self {
        ProtocolUpgradeRequest { config }
    }

    /// Get the protocol upgrade config.
    pub fn config(&self) -> &ProtocolUpgradeConfig {
        &self.config
    }

    /// Get the pre_state_hash to apply protocol upgrade to.
    pub fn pre_state_hash(&self) -> Digest {
        self.config.pre_state_hash()
    }
}

/// Response to attempt to upgrade the protocol.
#[derive(Debug, Clone)]
pub enum ProtocolUpgradeResult {
    /// Global state root not found.
    RootNotFound,
    /// Protocol upgraded successfully.
    Success {
        /// State hash after protocol upgrade is committed to the global state.
        post_state_hash: Digest,
        /// Effects of protocol upgrade.
        effects: Effects,
    },
    /// Failed to upgrade protocol.
    Failure(ProtocolUpgradeError),
}

impl ProtocolUpgradeResult {
    /// Is success.
    pub fn is_success(&self) -> bool {
        matches!(self, ProtocolUpgradeResult::Success { .. })
    }

    /// Is an error
    pub fn is_err(&self) -> bool {
        match self {
            ProtocolUpgradeResult::RootNotFound | ProtocolUpgradeResult::Failure(_) => true,
            ProtocolUpgradeResult::Success { .. } => false,
        }
    }
}

impl From<ProtocolUpgradeError> for ProtocolUpgradeResult {
    fn from(err: ProtocolUpgradeError) -> Self {
        ProtocolUpgradeResult::Failure(err)
    }
}