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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
// Copyright (c) 2021-2024 Espresso Systems (espressosys.com)
// This file is part of the HotShot repository.

// You should have received a copy of the MIT License
// along with the HotShot repository. If not, see <https://mit-license.org/>.

use std::{
    cmp::max,
    collections::{BTreeMap, BTreeSet},
    marker::PhantomData,
    num::NonZeroU64,
};

use hotshot_types::{
    traits::{
        election::Membership,
        node_implementation::{ConsensusTime, NodeType},
        signature_key::{SignatureKey, StakeTableEntryType},
    },
    PeerConfig,
};
use primitive_types::U256;
use rand::{rngs::StdRng, Rng};
use utils::anytrace::Result;

use crate::traits::election::helpers::QuorumFilterConfig;

#[derive(Clone, Debug, Eq, PartialEq, Hash)]
/// The static committee election
pub struct RandomizedCommitteeMembers<T: NodeType, C: QuorumFilterConfig> {
    /// The nodes eligible for leadership.
    /// NOTE: This is currently a hack because the DA leader needs to be the quorum
    /// leader but without voting rights.
    eligible_leaders: Vec<<T::SignatureKey as SignatureKey>::StakeTableEntry>,

    /// The nodes on the committee and their stake
    stake_table: Vec<<T::SignatureKey as SignatureKey>::StakeTableEntry>,

    /// The nodes on the da committee and their stake
    da_stake_table: Vec<<T::SignatureKey as SignatureKey>::StakeTableEntry>,

    /// The nodes on the committee and their stake, indexed by public key
    indexed_stake_table:
        BTreeMap<T::SignatureKey, <T::SignatureKey as SignatureKey>::StakeTableEntry>,

    /// The nodes on the da committee and their stake, indexed by public key
    indexed_da_stake_table:
        BTreeMap<T::SignatureKey, <T::SignatureKey as SignatureKey>::StakeTableEntry>,

    /// Phantom
    _pd: PhantomData<C>,
}

impl<TYPES: NodeType, CONFIG: QuorumFilterConfig> RandomizedCommitteeMembers<TYPES, CONFIG> {
    /// Creates a set of indices into the stake_table which reference the nodes selected for this epoch's committee
    fn make_quorum_filter(&self, epoch: <TYPES as NodeType>::Epoch) -> BTreeSet<usize> {
        CONFIG::execute(epoch.u64(), self.stake_table.len())
    }

    /// Creates a set of indices into the da_stake_table which reference the nodes selected for this epoch's da committee
    fn make_da_quorum_filter(&self, epoch: <TYPES as NodeType>::Epoch) -> BTreeSet<usize> {
        CONFIG::execute(epoch.u64(), self.da_stake_table.len())
    }
}

impl<TYPES: NodeType, CONFIG: QuorumFilterConfig> Membership<TYPES>
    for RandomizedCommitteeMembers<TYPES, CONFIG>
{
    type Error = utils::anytrace::Error;

    /// Create a new election
    fn new(
        committee_members: Vec<PeerConfig<<TYPES as NodeType>::SignatureKey>>,
        da_members: Vec<PeerConfig<<TYPES as NodeType>::SignatureKey>>,
    ) -> Self {
        // For each eligible leader, get the stake table entry
        let eligible_leaders: Vec<<TYPES::SignatureKey as SignatureKey>::StakeTableEntry> =
            committee_members
                .iter()
                .map(|member| member.stake_table_entry.clone())
                .filter(|entry| entry.stake() > U256::zero())
                .collect();

        // For each member, get the stake table entry
        let members: Vec<<TYPES::SignatureKey as SignatureKey>::StakeTableEntry> =
            committee_members
                .iter()
                .map(|member| member.stake_table_entry.clone())
                .filter(|entry| entry.stake() > U256::zero())
                .collect();

        // For each da member, get the stake table entry
        let da_members: Vec<<TYPES::SignatureKey as SignatureKey>::StakeTableEntry> = da_members
            .iter()
            .map(|member| member.stake_table_entry.clone())
            .filter(|entry| entry.stake() > U256::zero())
            .collect();

        // Index the stake table by public key
        let indexed_stake_table: BTreeMap<
            TYPES::SignatureKey,
            <TYPES::SignatureKey as SignatureKey>::StakeTableEntry,
        > = members
            .iter()
            .map(|entry| (TYPES::SignatureKey::public_key(entry), entry.clone()))
            .collect();

        // Index the stake table by public key
        let indexed_da_stake_table: BTreeMap<
            TYPES::SignatureKey,
            <TYPES::SignatureKey as SignatureKey>::StakeTableEntry,
        > = da_members
            .iter()
            .map(|entry| (TYPES::SignatureKey::public_key(entry), entry.clone()))
            .collect();

        Self {
            eligible_leaders,
            stake_table: members,
            da_stake_table: da_members,
            indexed_stake_table,
            indexed_da_stake_table,
            _pd: PhantomData,
        }
    }

    /// Get the stake table for the current view
    fn stake_table(
        &self,
        epoch: <TYPES as NodeType>::Epoch,
    ) -> Vec<<<TYPES as NodeType>::SignatureKey as SignatureKey>::StakeTableEntry> {
        let filter = self.make_quorum_filter(epoch);
        //self.stake_table.clone()s
        self.stake_table
            .iter()
            .enumerate()
            .filter(|(idx, _)| filter.contains(idx))
            .map(|(_, v)| v.clone())
            .collect()
    }

    /// Get the da stake table for the current view
    fn da_stake_table(
        &self,
        epoch: <TYPES as NodeType>::Epoch,
    ) -> Vec<<<TYPES as NodeType>::SignatureKey as SignatureKey>::StakeTableEntry> {
        let filter = self.make_da_quorum_filter(epoch);
        //self.stake_table.clone()s
        self.da_stake_table
            .iter()
            .enumerate()
            .filter(|(idx, _)| filter.contains(idx))
            .map(|(_, v)| v.clone())
            .collect()
    }

    /// Get all members of the committee for the current view
    fn committee_members(
        &self,
        _view_number: <TYPES as NodeType>::View,
        epoch: <TYPES as NodeType>::Epoch,
    ) -> BTreeSet<<TYPES as NodeType>::SignatureKey> {
        let filter = self.make_quorum_filter(epoch);
        self.stake_table
            .iter()
            .enumerate()
            .filter(|(idx, _)| filter.contains(idx))
            .map(|(_, v)| TYPES::SignatureKey::public_key(v))
            .collect()
    }

    /// Get all members of the committee for the current view
    fn da_committee_members(
        &self,
        _view_number: <TYPES as NodeType>::View,
        epoch: <TYPES as NodeType>::Epoch,
    ) -> BTreeSet<<TYPES as NodeType>::SignatureKey> {
        let filter = self.make_da_quorum_filter(epoch);
        self.da_stake_table
            .iter()
            .enumerate()
            .filter(|(idx, _)| filter.contains(idx))
            .map(|(_, v)| TYPES::SignatureKey::public_key(v))
            .collect()
    }

    /// Get all eligible leaders of the committee for the current view
    fn committee_leaders(
        &self,
        view_number: <TYPES as NodeType>::View,
        epoch: <TYPES as NodeType>::Epoch,
    ) -> BTreeSet<<TYPES as NodeType>::SignatureKey> {
        self.committee_members(view_number, epoch)
    }

    /// Get the stake table entry for a public key
    fn stake(
        &self,
        pub_key: &<TYPES as NodeType>::SignatureKey,
        epoch: <TYPES as NodeType>::Epoch,
    ) -> Option<<TYPES::SignatureKey as SignatureKey>::StakeTableEntry> {
        let filter = self.make_quorum_filter(epoch);
        let actual_members: BTreeSet<_> = self
            .stake_table
            .iter()
            .enumerate()
            .filter(|(idx, _)| filter.contains(idx))
            .map(|(_, v)| TYPES::SignatureKey::public_key(v))
            .collect();

        if actual_members.contains(pub_key) {
            // Only return the stake if it is above zero
            self.indexed_stake_table.get(pub_key).cloned()
        } else {
            // Skip members which aren't included based on the quorum filter
            None
        }
    }

    /// Get the da stake table entry for a public key
    fn da_stake(
        &self,
        pub_key: &<TYPES as NodeType>::SignatureKey,
        epoch: <TYPES as NodeType>::Epoch,
    ) -> Option<<TYPES::SignatureKey as SignatureKey>::StakeTableEntry> {
        let filter = self.make_da_quorum_filter(epoch);
        let actual_members: BTreeSet<_> = self
            .da_stake_table
            .iter()
            .enumerate()
            .filter(|(idx, _)| filter.contains(idx))
            .map(|(_, v)| TYPES::SignatureKey::public_key(v))
            .collect();

        if actual_members.contains(pub_key) {
            // Only return the stake if it is above zero
            self.indexed_da_stake_table.get(pub_key).cloned()
        } else {
            // Skip members which aren't included based on the quorum filter
            None
        }
    }

    /// Check if a node has stake in the committee
    fn has_stake(
        &self,
        pub_key: &<TYPES as NodeType>::SignatureKey,
        epoch: <TYPES as NodeType>::Epoch,
    ) -> bool {
        let filter = self.make_quorum_filter(epoch);
        let actual_members: BTreeSet<_> = self
            .stake_table
            .iter()
            .enumerate()
            .filter(|(idx, _)| filter.contains(idx))
            .map(|(_, v)| TYPES::SignatureKey::public_key(v))
            .collect();

        if actual_members.contains(pub_key) {
            self.indexed_stake_table
                .get(pub_key)
                .is_some_and(|x| x.stake() > U256::zero())
        } else {
            // Skip members which aren't included based on the quorum filter
            false
        }
    }

    /// Check if a node has stake in the committee
    fn has_da_stake(
        &self,
        pub_key: &<TYPES as NodeType>::SignatureKey,
        epoch: <TYPES as NodeType>::Epoch,
    ) -> bool {
        let filter = self.make_da_quorum_filter(epoch);
        let actual_members: BTreeSet<_> = self
            .da_stake_table
            .iter()
            .enumerate()
            .filter(|(idx, _)| filter.contains(idx))
            .map(|(_, v)| TYPES::SignatureKey::public_key(v))
            .collect();

        if actual_members.contains(pub_key) {
            self.indexed_da_stake_table
                .get(pub_key)
                .is_some_and(|x| x.stake() > U256::zero())
        } else {
            // Skip members which aren't included based on the quorum filter
            false
        }
    }

    /// Index the vector of public keys with the current view number
    fn lookup_leader(
        &self,
        view_number: TYPES::View,
        epoch: <TYPES as NodeType>::Epoch,
    ) -> Result<TYPES::SignatureKey> {
        let filter = self.make_quorum_filter(epoch);
        let leader_vec: Vec<_> = self
            .stake_table
            .iter()
            .enumerate()
            .filter(|(idx, _)| filter.contains(idx))
            .map(|(_, v)| v.clone())
            .collect();

        let mut rng: StdRng = rand::SeedableRng::seed_from_u64(*view_number);

        let randomized_view_number: u64 = rng.gen_range(0..=u64::MAX);
        #[allow(clippy::cast_possible_truncation)]
        let index = randomized_view_number as usize % leader_vec.len();

        let res = leader_vec[index].clone();

        Ok(TYPES::SignatureKey::public_key(&res))
    }

    /// Get the total number of nodes in the committee
    fn total_nodes(&self, epoch: <TYPES as NodeType>::Epoch) -> usize {
        self.make_quorum_filter(epoch).len()
    }

    /// Get the total number of nodes in the committee
    fn da_total_nodes(&self, epoch: <TYPES as NodeType>::Epoch) -> usize {
        self.make_da_quorum_filter(epoch).len()
    }

    /// Get the voting success threshold for the committee
    fn success_threshold(&self, epoch: <TYPES as NodeType>::Epoch) -> NonZeroU64 {
        let len = self.total_nodes(epoch);
        NonZeroU64::new(((len as u64 * 2) / 3) + 1).unwrap()
    }

    /// Get the voting success threshold for the committee
    fn da_success_threshold(&self, epoch: <TYPES as NodeType>::Epoch) -> NonZeroU64 {
        let len = self.da_total_nodes(epoch);
        NonZeroU64::new(((len as u64 * 2) / 3) + 1).unwrap()
    }

    /// Get the voting failure threshold for the committee
    fn failure_threshold(&self, epoch: <TYPES as NodeType>::Epoch) -> NonZeroU64 {
        let len = self.total_nodes(epoch);
        NonZeroU64::new(((len as u64) / 3) + 1).unwrap()
    }

    /// Get the voting upgrade threshold for the committee
    fn upgrade_threshold(&self, epoch: <TYPES as NodeType>::Epoch) -> NonZeroU64 {
        let len = self.total_nodes(epoch);
        NonZeroU64::new(max((len as u64 * 9) / 10, ((len as u64 * 2) / 3) + 1)).unwrap()
    }
}