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

use std::collections::BTreeMap;

use thiserror::Error;

use casper_types::{
    execution::Effects, system::auction::Error as AuctionError, BlockTime, Digest, ProtocolVersion,
    PublicKey, U512,
};

use crate::{
    system::{runtime_native::Config, transfer::TransferError},
    tracking_copy::TrackingCopyError,
};

/// Block rewards request.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct BlockRewardsRequest {
    config: Config,
    state_hash: Digest,
    protocol_version: ProtocolVersion,
    rewards: BTreeMap<PublicKey, Vec<U512>>,
    block_time: BlockTime,
}

impl BlockRewardsRequest {
    /// Ctor.
    pub fn new(
        config: Config,
        state_hash: Digest,
        protocol_version: ProtocolVersion,
        block_time: BlockTime,
        rewards: BTreeMap<PublicKey, Vec<U512>>,
    ) -> Self {
        BlockRewardsRequest {
            config,
            state_hash,
            protocol_version,
            rewards,
            block_time,
        }
    }

    /// Returns config.
    pub fn config(&self) -> &Config {
        &self.config
    }

    /// 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 rewards.
    pub fn rewards(&self) -> &BTreeMap<PublicKey, Vec<U512>> {
        &self.rewards
    }

    /// Returns block time.
    pub fn block_time(&self) -> BlockTime {
        self.block_time
    }
}

/// Block rewards error.
#[derive(Clone, Error, Debug)]
pub enum BlockRewardsError {
    /// Undistributed rewards error.
    #[error("Undistributed rewards")]
    UndistributedRewards,
    /// Tracking copy error.
    #[error(transparent)]
    TrackingCopy(TrackingCopyError),
    /// Registry entry not found error.
    #[error("Registry entry not found: {0}")]
    RegistryEntryNotFound(String),
    /// Transfer error.
    #[error(transparent)]
    Transfer(TransferError),
    /// Auction error.
    #[error("Auction error: {0}")]
    Auction(AuctionError),
}

/// Block reward result.
#[derive(Debug, Clone)]
pub enum BlockRewardsResult {
    /// Root not found in global state.
    RootNotFound,
    /// Block rewards failure error.
    Failure(BlockRewardsError),
    /// Success result.
    Success {
        /// State hash after distribution outcome is committed to the global state.
        post_state_hash: Digest,
        /// Effects of the distribution process.
        effects: Effects,
    },
}

impl BlockRewardsResult {
    /// Returns true if successful, else false.
    pub fn is_success(&self) -> bool {
        matches!(self, BlockRewardsResult::Success { .. })
    }
}