casper-node 0.1.0

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

//! Macros for concise test setup.

/// Creates a panorama from a list of either observations or vote hashes. Vote hashes are converted
/// to `Correct` observations.
macro_rules! panorama {
    ($($obs:expr),*) => {{
        use crate::components::consensus::highway_core::state::Panorama;

        Panorama::from(vec![$($obs.into()),*])
    }};
}

/// Creates a vote, adds it to `$state` and returns its hash.
/// Returns an error if vote addition fails.
///
/// The short variant is for tests that don't care about timestamps and round lengths: It
/// automatically picks reasonable values for those.
macro_rules! add_vote {
    ($state: ident, $rng: ident, $creator: expr, $val: expr; $($obs:expr),*) => {{
        #[allow(unused_imports)] // These might be already imported at the call site.
        use crate::{
            components::consensus::highway_core::{
                state::{self, tests::TestSecret},
                highway::{SignedWireVote, WireVote},
            },
            types::{TimeDiff, Timestamp},
        };

        let creator = $creator;
        let panorama = panorama!($($obs),*);
        let seq_number = panorama.next_seq_num(&$state, creator);
        let opt_parent_hash = panorama[creator].correct();
        // Use our most recent round exponent, or the configured initial one.
        let round_exp = opt_parent_hash.map_or_else(
            || $state.params().init_round_exp(),
            |vh| $state.vote(vh).round_exp,
        );
        let value = Option::from($val);
        // At most two votes per round are allowed.
        let two_votes_limit = opt_parent_hash
            .and_then(|ph| $state.vote(ph).previous())
            .map(|pph| $state.vote(pph))
            .map(|vote| vote.round_id() + vote.round_len());
        // And our timestamp must not be less than any justification's.
        let mut timestamp = panorama
            .iter_correct(&$state)
            .map(|vote| vote.timestamp + TimeDiff::from(1))
            .chain(two_votes_limit)
            .max()
            .unwrap_or_else(Timestamp::zero);
        // If this is a block: Find the next time we're a leader.
        if value.is_some() {
            let r_len = TimeDiff::from(1 << round_exp);
            timestamp = state::round_id(timestamp + r_len - TimeDiff::from(1), round_exp);
            while $state.leader(timestamp) != creator {
                timestamp += r_len;
            }
        }
        let wvote = WireVote {
            panorama,
            creator,
            instance_id: 1u64,
            value,
            seq_number,
            timestamp,
            round_exp,
            endorsed: vec![],
        };
        let hash = wvote.hash();
        let swvote = SignedWireVote::new(wvote, &TestSecret(($creator).0), &mut $rng);
        $state.add_vote(swvote).map(|()| hash)
    }};
    ($state: ident, $rng: ident, $creator: expr, $time: expr, $round_exp: expr, $val: expr; $($obs:expr),*) => {{
        add_vote!($state, $rng, $creator, $time, $round_exp, $val; $($obs),*; vec![])
    }};
    ($state: ident, $rng: ident, $creator: expr, $time: expr, $round_exp: expr, $val: expr; $($obs:expr),*; $($ends:expr),*) => {{
        use crate::components::consensus::highway_core::{
            state::tests::TestSecret,
            highway::{SignedWireVote, WireVote},
        };

        let creator = $creator;
        let panorama = panorama!($($obs),*);
        let seq_number = panorama.next_seq_num(&$state, creator);
        let wvote = WireVote {
            panorama,
            creator,
            instance_id: 1u64,
            value: ($val).into(),
            seq_number,
            timestamp: ($time).into(),
            round_exp: $round_exp,
            endorsed: $($ends.into()),*
        };
        let hash = wvote.hash();
        let swvote = SignedWireVote::new(wvote, &TestSecret(($creator).0), &mut $rng);
        $state.add_vote(swvote).map(|()| hash)
    }};
}