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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114

use crate::tracking_copy::TrackingCopyError;
use casper_types::{execution::Effects, BlockTime, Digest, ProtocolVersion};
use std::fmt::{Display, Formatter};
use thiserror::Error;

/// Block global kind.
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub enum BlockGlobalKind {
    /// Block time.
    BlockTime(BlockTime),
    /// Message count.
    MessageCount(u64),
    /// Protocol version.
    ProtocolVersion(ProtocolVersion),
    /// Addressable entity flag.
    AddressableEntity(bool),
}

impl Default for BlockGlobalKind {
    fn default() -> Self {
        BlockGlobalKind::BlockTime(BlockTime::default())
    }
}

/// Block global request.
#[derive(Debug, Copy, Clone, PartialEq, Eq, Default)]
pub struct BlockGlobalRequest {
    state_hash: Digest,
    protocol_version: ProtocolVersion,
    block_global_kind: BlockGlobalKind,
}

impl BlockGlobalRequest {
    /// Returns block time setting request.
    pub fn block_time(
        state_hash: Digest,
        protocol_version: ProtocolVersion,
        block_time: BlockTime,
    ) -> Self {
        let block_global_kind = BlockGlobalKind::BlockTime(block_time);
        BlockGlobalRequest {
            state_hash,
            protocol_version,
            block_global_kind,
        }
    }

    /// Returns protocol version setting request.
    pub fn set_protocol_version(state_hash: Digest, protocol_version: ProtocolVersion) -> Self {
        let block_global_kind = BlockGlobalKind::ProtocolVersion(protocol_version);
        BlockGlobalRequest {
            state_hash,
            protocol_version,
            block_global_kind,
        }
    }

    /// Returns addressable entity flag setting request.
    pub fn set_addressable_entity(
        state_hash: Digest,
        protocol_version: ProtocolVersion,
        addressable_entity: bool,
    ) -> Self {
        let block_global_kind = BlockGlobalKind::AddressableEntity(addressable_entity);
        BlockGlobalRequest {
            state_hash,
            protocol_version,
            block_global_kind,
        }
    }

    /// Returns state hash.
    pub fn state_hash(&self) -> Digest {
        self.state_hash
    }

    /// Returns protocol version.
    pub fn protocol_version(&self) -> ProtocolVersion {
        self.protocol_version
    }

    /// Returns block global kind.
    pub fn block_global_kind(&self) -> BlockGlobalKind {
        self.block_global_kind
    }
}

/// Block global result.
#[derive(Error, Debug, Clone)]
pub enum BlockGlobalResult {
    /// Returned if a passed state root hash is not found.
    RootNotFound,
    /// Failed to store block global data.
    Failure(TrackingCopyError),
    /// Successfully stored block global data.
    Success {
        /// State hash after data committed to the global state.
        post_state_hash: Digest,
        /// The effects of putting the data to global state.
        effects: Box<Effects>,
    },
}

impl Display for BlockGlobalResult {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        match self {
            BlockGlobalResult::RootNotFound => f.write_str("root not found"),
            BlockGlobalResult::Failure(tce) => {
                write!(f, "failed {}", tce)
            }
            BlockGlobalResult::Success { .. } => f.write_str("success"),
        }
    }
}