casper-node 2.0.3

The Casper blockchain node
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

use datasize::DataSize;
use serde::{Deserialize, Serialize};
use thiserror::Error;

use crate::components::consensus::{traits::Context, utils::ValidatorIndex};

/// An error due to an invalid endorsement.
#[derive(Debug, Error, Eq, PartialEq)]
pub(crate) enum EndorsementError {
    #[error("The creator is not a validator.")]
    Creator,
    #[error("The creator is banned.")]
    Banned,
    #[error("The signature is invalid.")]
    Signature,
    #[error("The list of endorsements is empty.")]
    Empty,
}

/// Testimony that creator of `unit` was seen honest
/// by `endorser` at the moment of creating this endorsement.
#[derive(Clone, DataSize, Debug, Eq, PartialEq, Hash, Serialize, Deserialize)]
#[serde(bound(
    serialize = "C::Hash: Serialize",
    deserialize = "C::Hash: Deserialize<'de>",
))]
pub struct Endorsement<C>
where
    C: Context,
{
    /// Unit being endorsed.
    unit: C::Hash,
    /// The validator who created and sent this endorsement.
    creator: ValidatorIndex,
}

impl<C: Context> Endorsement<C> {
    pub(crate) fn new(vhash: C::Hash, creator: ValidatorIndex) -> Self {
        Endorsement {
            unit: vhash,
            creator,
        }
    }

    /// Returns the hash of the endorsement.
    pub fn hash(&self) -> C::Hash {
        <C as Context>::hash(
            &bincode::serialize(&(self.unit, self.creator)).expect("serialize endorsement"),
        )
    }
}

mod specimen_support {
    use crate::{
        components::consensus::ClContext,
        utils::specimen::{Cache, LargestSpecimen, SizeEstimator},
    };

    use super::Endorsement;

    impl LargestSpecimen for Endorsement<ClContext> {
        fn largest_specimen<E: SizeEstimator>(estimator: &E, cache: &mut Cache) -> Self {
            Endorsement {
                unit: LargestSpecimen::largest_specimen(estimator, cache),
                creator: LargestSpecimen::largest_specimen(estimator, cache),
            }
        }
    }
}

/// Testimony that creator of `unit` was seen honest
/// by `endorser` at the moment of creating this endorsement.
#[derive(Clone, DataSize, Debug, Eq, PartialEq, Hash, Serialize, Deserialize)]
#[serde(bound(
    serialize = "C::Signature: Serialize",
    deserialize = "C::Signature: Deserialize<'de>",
))]
pub struct SignedEndorsement<C>
where
    C: Context,
{
    /// Original endorsement,
    endorsement: Endorsement<C>,
    /// Original signature.
    signature: C::Signature,
}

impl<C: Context> SignedEndorsement<C> {
    pub fn new(endorsement: Endorsement<C>, signature: C::Signature) -> Self {
        SignedEndorsement {
            endorsement,
            signature,
        }
    }

    /// Returns the unit being endorsed.
    pub fn unit(&self) -> &C::Hash {
        &self.endorsement.unit
    }

    /// Returns the creator of the endorsement.
    pub fn validator_idx(&self) -> ValidatorIndex {
        self.endorsement.creator
    }

    /// Returns the signature of the endorsement.
    pub fn signature(&self) -> &C::Signature {
        &self.signature
    }

    /// Returns the hash of the endorsement.
    pub fn hash(&self) -> C::Hash {
        self.endorsement.hash()
    }
}