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
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
use anyhow::Context;
use async_trait::async_trait;
use mithril_common::StdResult;
use std::collections::HashMap;
use tokio::sync::RwLock;

use mithril_common::entities::{Epoch, PartyId, Signer, SignerWithStake};
use mithril_persistence::store::adapter::StoreAdapter;

#[cfg(test)]
use mockall::automock;

type Adapter = Box<dyn StoreAdapter<Key = Epoch, Record = HashMap<PartyId, SignerWithStake>>>;

/// Store and get signers verification keys for given epoch.
///
/// Important note: This store works on the **recording** epoch, the epoch at which the signers
/// are signed into a certificate so they can sign single signatures at the next epoch.
#[cfg_attr(test, automock)]
#[async_trait]
pub trait VerificationKeyStorer: Sync + Send {
    /// Save the verification key, for the given [Signer] for the given [Epoch], returns the
    /// previous values if one already existed.
    async fn save_verification_key(
        &self,
        epoch: Epoch,
        signer: SignerWithStake,
    ) -> StdResult<Option<SignerWithStake>>;

    /// Returns a HashMap of [Signer] indexed by [PartyId] for the given `epoch`.
    async fn get_verification_keys(
        &self,
        epoch: Epoch,
    ) -> StdResult<Option<HashMap<PartyId, Signer>>>;

    /// Returns the list of signers for the given `epoch`.
    async fn get_signers(&self, epoch: Epoch) -> StdResult<Option<Vec<SignerWithStake>>>;

    /// Prune all verification keys that are at or below the given epoch.
    async fn prune_verification_keys(&self, max_epoch_to_prune: Epoch) -> StdResult<()>;
}

/// Store for the `VerificationKey`.
pub struct VerificationKeyStore {
    adapter: RwLock<Adapter>,
}

impl VerificationKeyStore {
    /// Create a new instance.
    pub fn new(adapter: Adapter) -> Self {
        Self {
            adapter: RwLock::new(adapter),
        }
    }
}

#[async_trait]
impl VerificationKeyStorer for VerificationKeyStore {
    async fn save_verification_key(
        &self,
        epoch: Epoch,
        signer: SignerWithStake,
    ) -> StdResult<Option<SignerWithStake>> {
        let mut signers = match self.adapter.read().await.get_record(&epoch).await? {
            Some(s) => s,
            None => HashMap::new(),
        };
        let prev_signer = signers.insert(signer.party_id.to_owned(), signer.clone());
        self.adapter
            .write()
            .await
            .store_record(&epoch, &signers)
            .await?;

        Ok(prev_signer)
    }

    async fn get_verification_keys(
        &self,
        epoch: Epoch,
    ) -> StdResult<Option<HashMap<PartyId, Signer>>> {
        let record = self
            .adapter
            .read()
            .await
            .get_record(&epoch)
            .await
            .with_context(|| format!("Could not get verification keys for epoch {epoch}."))?;

        Ok(record.map(|h| h.into_iter().map(|(k, v)| (k, v.into())).collect()))
    }

    async fn get_signers(&self, epoch: Epoch) -> StdResult<Option<Vec<SignerWithStake>>> {
        let record = self
            .adapter
            .read()
            .await
            .get_record(&epoch)
            .await
            .with_context(|| format!("Could not get signers for epoch {epoch}."))?;

        Ok(record.map(|h| h.into_values().collect()))
    }

    async fn prune_verification_keys(&self, max_epoch_to_prune: Epoch) -> StdResult<()> {
        let mut adapter = self.adapter.write().await;

        for (epoch, _record) in adapter
            .get_last_n_records(usize::MAX)
            .await
            .with_context(|| {
                "Pruning verification keys: could not read last records from database".to_string()
            })?
            .into_iter()
            .filter(|(e, _)| e <= &max_epoch_to_prune)
        {
            adapter.remove(&epoch).await
                .with_context(|| format!("Pruning verification keys: could not remove record for epoch '{epoch}' from the database."))?;
        }

        Ok(())
    }
}

/// Macro that generate tests that a [VerificationKeyStorer] must pass
#[cfg(test)]
macro_rules! test_verification_key_storer {
    ($suit_name:ident => $store_builder:expr) => {
        #[cfg(test)]
        mod $suit_name {
            use crate::store::verification_key_store_test_suite as test_suite;

            #[tokio::test]
            async fn save_key_in_empty_store() {
                test_suite::save_key_in_empty_store(&$store_builder).await;
            }

            #[tokio::test]
            async fn update_signer_in_store() {
                test_suite::update_signer_in_store(&$store_builder).await;
            }

            #[tokio::test]
            async fn get_verification_keys_for_empty_epoch() {
                test_suite::get_verification_keys_for_empty_epoch(&$store_builder).await;
            }

            #[tokio::test]
            async fn get_signers_for_empty_epoch() {
                test_suite::get_signers_for_empty_epoch(&$store_builder).await;
            }

            #[tokio::test]
            async fn get_verification_keys_for_existing_epoch() {
                test_suite::get_verification_keys_for_existing_epoch(&$store_builder).await;
            }

            #[tokio::test]
            async fn get_signers_for_existing_epoch() {
                test_suite::get_signers_for_existing_epoch(&$store_builder).await;
            }

            #[tokio::test]
            async fn can_prune_keys_from_given_epoch_retention_limit() {
                test_suite::can_prune_keys_from_given_epoch_retention_limit(&$store_builder).await;
            }
        }
    };
}

#[cfg(test)]
pub(crate) use test_verification_key_storer;

#[macro_use]
#[cfg(test)]
pub mod test_suite {
    use mithril_common::entities::{Epoch, PartyId, Signer, SignerWithStake};
    use mithril_common::test_utils::fake_keys;
    use std::collections::{BTreeMap, BTreeSet, HashMap};
    use std::sync::Arc;

    use crate::VerificationKeyStorer;

    /// A builder of [VerificationKeyStorer], the arguments are:
    /// * initial_data
    type StoreBuilder =
        dyn Fn(Vec<(Epoch, HashMap<PartyId, SignerWithStake>)>) -> Arc<dyn VerificationKeyStorer>;

    fn build_signers(
        nb_epoch: u64,
        signers_per_epoch: usize,
    ) -> Vec<(Epoch, HashMap<PartyId, SignerWithStake>)> {
        let mut values = vec![];

        for epoch in 1..=nb_epoch {
            let mut signers: HashMap<PartyId, SignerWithStake> =
                HashMap::with_capacity(signers_per_epoch);

            for party_idx in 1..=signers_per_epoch {
                let party_id = format!("party_id:e{epoch}:{party_idx}");
                signers.insert(
                    party_id.clone(),
                    SignerWithStake {
                        party_id: party_id.clone(),
                        verification_key: fake_keys::signer_verification_key()[0]
                            .try_into()
                            .unwrap(),
                        verification_key_signature: None,
                        operational_certificate: None,
                        kes_period: None,
                        stake: 10,
                    },
                );
            }
            values.push((Epoch(epoch), signers));
        }

        values
    }

    pub async fn save_key_in_empty_store(store_builder: &StoreBuilder) {
        let signers = build_signers(0, 0);
        let store = store_builder(signers);
        let res = store
            .save_verification_key(
                Epoch(0),
                SignerWithStake {
                    party_id: "0".to_string(),
                    verification_key: fake_keys::signer_verification_key()[0].try_into().unwrap(),
                    verification_key_signature: None,
                    operational_certificate: None,
                    kes_period: None,
                    stake: 10,
                },
            )
            .await
            .unwrap();

        assert!(res.is_none());
    }

    pub async fn update_signer_in_store(store_builder: &StoreBuilder) {
        let signers = build_signers(1, 1);
        let store = store_builder(signers);
        let res = store
            .save_verification_key(
                Epoch(1),
                SignerWithStake {
                    party_id: "party_id:e1:1".to_string(),
                    verification_key: fake_keys::signer_verification_key()[2].try_into().unwrap(),
                    verification_key_signature: None,
                    operational_certificate: None,
                    kes_period: None,
                    stake: 10,
                },
            )
            .await
            .unwrap();

        assert_eq!(
            Some(SignerWithStake {
                party_id: "party_id:e1:1".to_string(),
                verification_key: fake_keys::signer_verification_key()[2].try_into().unwrap(),
                verification_key_signature: None,
                operational_certificate: None,
                kes_period: None,
                stake: 10,
            }),
            res,
        );
    }

    pub async fn get_verification_keys_for_empty_epoch(store_builder: &StoreBuilder) {
        let signers = build_signers(2, 1);
        let store = store_builder(signers);
        let res = store.get_verification_keys(Epoch(0)).await.unwrap();

        assert!(res.is_none());
    }

    pub async fn get_signers_for_empty_epoch(store_builder: &StoreBuilder) {
        let signers = build_signers(2, 1);
        let store = store_builder(signers);
        let res = store.get_signers(Epoch(0)).await.unwrap();

        assert!(res.is_none());
    }

    pub async fn get_verification_keys_for_existing_epoch(store_builder: &StoreBuilder) {
        let signers = build_signers(2, 2);
        let store = store_builder(signers.clone());

        let expected_signers: Option<BTreeMap<PartyId, Signer>> = signers
            .into_iter()
            .filter(|(e, _)| e == 1)
            .map(|(_, signers)| {
                BTreeMap::from_iter(signers.into_iter().map(|(p, s)| (p, s.into())))
            })
            .next();
        let res = store
            .get_verification_keys(Epoch(1))
            .await
            .unwrap()
            .map(|x| BTreeMap::from_iter(x.into_iter()));

        assert_eq!(expected_signers, res);
    }

    pub async fn get_signers_for_existing_epoch(store_builder: &StoreBuilder) {
        let signers = build_signers(2, 2);
        let store = store_builder(signers.clone());

        let expected_signers: Option<BTreeSet<SignerWithStake>> = signers
            .into_iter()
            .filter(|(e, _)| e == 1)
            .map(|(_, signers)| BTreeSet::from_iter(signers.into_values()))
            .next();
        let res = store
            .get_signers(Epoch(1))
            .await
            .unwrap()
            .map(|x| BTreeSet::from_iter(x.into_iter()));

        assert_eq!(expected_signers, res);
    }

    pub async fn can_prune_keys_from_given_epoch_retention_limit(store_builder: &StoreBuilder) {
        let signers = build_signers(6, 2);
        let store = store_builder(signers);

        for epoch in 1..6 {
            assert!(
                store
                    .get_verification_keys(Epoch(epoch))
                    .await
                    .unwrap()
                    .is_some(),
                "Keys should exist before pruning"
            );
            store
                .prune_verification_keys(Epoch(epoch))
                .await
                .expect("Pruning should not fail");

            let pruned_epoch_keys = store.get_verification_keys(Epoch(epoch)).await.unwrap();
            assert_eq!(None, pruned_epoch_keys);
        }
    }
}

#[cfg(test)]
mod tests {
    use mithril_common::entities::{Epoch, PartyId, SignerWithStake};
    use mithril_persistence::store::adapter::MemoryAdapter;
    use std::{collections::HashMap, sync::Arc};

    use crate::{VerificationKeyStore, VerificationKeyStorer};

    pub fn init_store(
        initial_data: Vec<(Epoch, HashMap<PartyId, SignerWithStake>)>,
    ) -> Arc<dyn VerificationKeyStorer> {
        let values = if initial_data.is_empty() {
            None
        } else {
            Some(initial_data)
        };

        let adapter: MemoryAdapter<Epoch, HashMap<PartyId, SignerWithStake>> =
            MemoryAdapter::new(values).unwrap();

        Arc::new(VerificationKeyStore::new(Box::new(adapter)))
    }

    test_verification_key_storer!(
        test_verification_key_store =>
        crate::store::verification_key_store::tests::init_store
    );
}