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
115
116

use crate::tracking_copy::TrackingCopyError;
use casper_types::{Digest, EntryPointValue, HashAddr};

/// Represents a request to obtain entry point.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct EntryPointRequest {
    state_hash: Digest,
    entry_point_name: String,
    contract_hash: HashAddr,
}

impl EntryPointRequest {
    /// ctor
    pub fn new(state_hash: Digest, entry_point_name: String, contract_hash: HashAddr) -> Self {
        EntryPointRequest {
            state_hash,
            entry_point_name,
            contract_hash,
        }
    }

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

    /// Returns entry_point_name.
    pub fn entry_point_name(&self) -> &str {
        &self.entry_point_name
    }

    /// Returns contract_hash.
    pub fn contract_hash(&self) -> HashAddr {
        self.contract_hash
    }
}

impl From<EntryPointExistsRequest> for EntryPointRequest {
    fn from(value: EntryPointExistsRequest) -> Self {
        EntryPointRequest {
            state_hash: value.state_hash,
            entry_point_name: value.entry_point_name,
            contract_hash: value.contract_hash,
        }
    }
}

/// Represents a result of a `entry_point` request.
#[derive(Debug)]
pub enum EntryPointResult {
    /// Invalid state root hash.
    RootNotFound,
    /// Value not found.
    ValueNotFound(String),
    /// Contains an addressable entity from global state.
    Success {
        /// An addressable entity.
        entry_point: EntryPointValue,
    },
    /// Failure result.
    Failure(TrackingCopyError),
}

/// Represents a request to check entry point existence.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct EntryPointExistsRequest {
    state_hash: Digest,
    entry_point_name: String,
    contract_hash: HashAddr,
}

impl EntryPointExistsRequest {
    /// ctor
    pub fn new(state_hash: Digest, entry_point_name: String, contract_hash: HashAddr) -> Self {
        EntryPointExistsRequest {
            state_hash,
            entry_point_name,
            contract_hash,
        }
    }

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

    /// Returns entry_point_name.
    pub fn entry_point_name(&self) -> &str {
        &self.entry_point_name
    }

    /// Returns contract_hash.
    pub fn contract_hash(&self) -> HashAddr {
        self.contract_hash
    }
}

/// Represents a result of `entry_point_exists` request.
#[derive(Debug)]
pub enum EntryPointExistsResult {
    /// Invalid state root hash.
    RootNotFound,
    /// Value not found.
    ValueNotFound(String),
    /// This variant will be returned if the entry point was found.
    Success,
    /// Failure result.
    Failure(TrackingCopyError),
}

impl EntryPointExistsResult {
    /// Returns `true` if the result is `Success`.
    pub fn is_success(self) -> bool {
        matches!(self, Self::Success { .. })
    }
}