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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
use crate::block::{BftProof, BlockDate, Header, Proof};
use crate::{
    key::BftLeaderId,
    leadership::{Error, ErrorKind, Verification},
};
use std::sync::Arc;

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct BftRoundRobinIndex(u64);

/// The BFT Leader selection is based on a round robin of the expected leaders
#[derive(Debug)]
pub struct LeadershipData {
    pub(crate) leaders: Arc<[BftLeaderId]>,
}

impl LeadershipData {
    /// Create a new BFT leadership
    pub fn new(leaders: Arc<[BftLeaderId]>) -> Option<Self> {
        if leaders.len() == 0 {
            return None;
        }

        Some(LeadershipData { leaders })
    }

    #[inline]
    pub fn number_of_leaders(&self) -> usize {
        self.leaders.len()
    }

    pub fn leaders(&self) -> &[BftLeaderId] {
        self.leaders.as_ref()
    }

    #[inline]
    fn offset(&self, block_number: u64) -> BftRoundRobinIndex {
        let max = self.number_of_leaders() as u64;
        BftRoundRobinIndex(block_number % max)
    }

    pub(crate) fn verify(&self, block_header: &Header) -> Verification {
        match &block_header.proof() {
            Proof::Bft(bft_proof) => {
                let BftProof {
                    leader_id,
                    signature,
                } = bft_proof;

                let leader = self.get_leader_at(block_header.block_date());

                if leader_id != &leader {
                    Verification::Failure(Error::new(ErrorKind::InvalidLeader))
                } else {
                    // verify block signature
                    match signature
                        .0
                        .verify_slice(leader.as_public_key(), block_header.as_auth_slice())
                    {
                        chain_crypto::Verification::Failed => {
                            Verification::Failure(Error::new(ErrorKind::InvalidLeaderSignature))
                        }
                        chain_crypto::Verification::Success => Verification::Success,
                    }
                }
            }
            _ => Verification::Failure(Error::new(ErrorKind::IncompatibleLeadershipMode)),
        }
    }

    #[inline]
    pub(crate) fn get_leader_at(&self, date: BlockDate) -> BftLeaderId {
        let BftRoundRobinIndex(ofs) = self.offset(date.slot_id as u64);
        self.leaders[ofs as usize].clone()
    }
}

#[cfg(test)]
mod tests {

    use super::*;
    use crate::fragment::Contents;
    use crate::header::BlockVersion;
    use crate::header::ChainLength;
    use crate::header::HeaderBuilderNew;
    use crate::leadership::tests::generate_ledger_with_bft_leaders;
    use crate::leadership::tests::generate_ledger_with_bft_leaders_count;
    use crate::ledger::{Ledger, Pots};
    use crate::setting::Settings;
    use crate::testing::data::AddressData;
    use crate::testing::TestGen;
    use chain_crypto::Ed25519;
    fn block_date() -> BlockDate {
        BlockDate {
            epoch: 0,
            slot_id: 1,
        }
    }

    #[test]
    fn empty_bft_leaders_collection() {
        let ledger = Ledger::empty(
            Settings::new(),
            TestGen::static_parameters(),
            TestGen::time_era(),
            Pots::zero(),
        );
        assert!(LeadershipData::new(ledger.settings.bft_leaders).is_none());
    }

    #[test]
    fn getters() {
        let leaders_size = 5;
        let (leaders, ledger) = generate_ledger_with_bft_leaders_count(leaders_size);
        let leadership_data = LeadershipData::new(ledger.settings.bft_leaders)
            .expect("leaders ids collection is empty");
        assert_eq!(leadership_data.number_of_leaders(), leaders_size);
        assert_eq!(&leaders, leadership_data.leaders());
    }

    #[test]
    fn round_robin_returns_correct_index() {
        let leaders_size = 5;
        let (leaders, ledger) = generate_ledger_with_bft_leaders_count(leaders_size);
        let leadership_data = LeadershipData::new(ledger.settings.bft_leaders)
            .expect("leaders ids collection is empty");

        for i in 0..leaders_size * 2 {
            assert_eq!(
                leadership_data.get_leader_at(BlockDate {
                    epoch: 0,
                    slot_id: i as u32
                }),
                leaders[i % leaders_size]
            );
        }
    }

    #[test]
    fn verify_incompatible_leadership_mode() {
        let header = TestGen::genesis_praos_header();
        let leader_key = AddressData::generate_key_pair::<Ed25519>()
            .private_key()
            .clone();
        let (_, ledger) = generate_ledger_with_bft_leaders(vec![leader_key.to_public()]);
        let leadership_data = LeadershipData::new(ledger.settings.bft_leaders)
            .expect("leaders ids collection is empty");

        assert!(leadership_data.verify(&header).failure());
    }

    #[test]
    fn verify_incorrect_leader() {
        let wrong_leader_key = TestGen::secret_key();
        let leader_key = TestGen::secret_key();
        let (_, ledger) = generate_ledger_with_bft_leaders(vec![leader_key.to_public()]);
        let leadership_data = LeadershipData::new(ledger.settings.bft_leaders)
            .expect("leaders ids collection is empty");

        let header = HeaderBuilderNew::new(BlockVersion::Ed25519Signed, &Contents::empty())
            .set_parent(&TestGen::hash(), ChainLength(1))
            .set_date(block_date())
            .into_bft_builder()
            .unwrap()
            .sign_using_unsafe(&leader_key, wrong_leader_key.to_public())
            .generalize();

        assert!(leadership_data.verify(&header).failure());
    }

    #[test]
    fn verify_incorrect_signature() {
        let wrong_leader_key = TestGen::secret_key();
        let leader_key = TestGen::secret_key();
        let (_, ledger) = generate_ledger_with_bft_leaders(vec![leader_key.to_public()]);
        let leadership_data = LeadershipData::new(ledger.settings.bft_leaders)
            .expect("leaders ids collection is empty");

        let header = HeaderBuilderNew::new(BlockVersion::Ed25519Signed, &Contents::empty())
            .set_parent(&TestGen::hash(), ChainLength(1))
            .set_date(block_date())
            .into_bft_builder()
            .unwrap()
            .sign_using_unsafe(&wrong_leader_key, leader_key.to_public())
            .generalize();

        assert!(leadership_data.verify(&header).failure());
    }

    #[test]
    fn verify_correct_verification() {
        let leader_key = TestGen::secret_key();
        let (_, ledger) = generate_ledger_with_bft_leaders(vec![leader_key.to_public()]);
        let leadership_data = LeadershipData::new(ledger.settings.bft_leaders)
            .expect("leaders ids collection is empty");

        let header = HeaderBuilderNew::new(BlockVersion::Ed25519Signed, &Contents::empty())
            .set_parent(&TestGen::hash(), ChainLength(1))
            .set_date(block_date())
            .into_bft_builder()
            .unwrap()
            .sign_using_unsafe(&leader_key, leader_key.to_public())
            .generalize();

        assert!(leadership_data.verify(&header).success());
    }
}