mithril_aggregator/database/repository/
signer_registration_store.rs1use std::collections::HashMap;
2use std::sync::Arc;
3
4use anyhow::Context;
5use async_trait::async_trait;
6
7use mithril_common::entities::{Epoch, PartyId, Signer, SignerWithStake};
8use mithril_common::StdResult;
9use mithril_persistence::sqlite::{ConnectionExtensions, SqliteConnection};
10
11use crate::database::query::{
12 DeleteSignerRegistrationRecordQuery, GetSignerRegistrationRecordQuery,
13 InsertOrReplaceSignerRegistrationRecordQuery,
14};
15use crate::database::record::SignerRegistrationRecord;
16use crate::VerificationKeyStorer;
17
18pub struct SignerRegistrationStore {
20 connection: Arc<SqliteConnection>,
21}
22
23impl SignerRegistrationStore {
24 pub fn new(connection: Arc<SqliteConnection>) -> Self {
26 Self { connection }
27 }
28}
29
30#[async_trait]
31impl VerificationKeyStorer for SignerRegistrationStore {
32 async fn save_verification_key(
33 &self,
34 epoch: Epoch,
35 signer: SignerWithStake,
36 ) -> StdResult<Option<SignerWithStake>> {
37 let existing_record = self
38 .connection
39 .fetch_first(GetSignerRegistrationRecordQuery::by_signer_id_and_epoch(
40 signer.party_id.to_owned(),
41 epoch,
42 )?)
43 .with_context(|| {
44 format!(
45 "Get signer registration record failure with signer_id: '{}', epoch: '{}'",
46 signer.party_id, epoch
47 )
48 })?;
49
50 let _updated_record = self
51 .connection
52 .fetch_first(InsertOrReplaceSignerRegistrationRecordQuery::one(
53 SignerRegistrationRecord::from_signer_with_stake(signer, epoch),
54 ))
55 .with_context(|| format!("persist verification key failure, epoch: {epoch}"))?;
56
57 match existing_record {
58 None => Ok(None),
59 Some(previous_record) => Ok(Some(previous_record.into())),
60 }
61 }
62
63 async fn get_verification_keys(
64 &self,
65 epoch: Epoch,
66 ) -> StdResult<Option<HashMap<PartyId, Signer>>> {
67 let cursor = self
68 .connection
69 .fetch(GetSignerRegistrationRecordQuery::by_epoch(epoch)?)
70 .with_context(|| format!("get verification key failure, epoch: {epoch}"))?;
71
72 let signer_with_stakes: HashMap<PartyId, Signer> =
73 HashMap::from_iter(cursor.map(|record| (record.signer_id.to_owned(), record.into())));
74
75 match signer_with_stakes.is_empty() {
76 true => Ok(None),
77 false => Ok(Some(signer_with_stakes)),
78 }
79 }
80
81 async fn get_signers(&self, epoch: Epoch) -> StdResult<Option<Vec<SignerWithStake>>> {
82 let cursor = self
83 .connection
84 .fetch(GetSignerRegistrationRecordQuery::by_epoch(epoch)?)
85 .with_context(|| format!("get verification key failure, epoch: {epoch}"))?;
86
87 let signer_with_stakes: Vec<SignerWithStake> = cursor.map(|record| record.into()).collect();
88
89 match signer_with_stakes.is_empty() {
90 true => Ok(None),
91 false => Ok(Some(signer_with_stakes)),
92 }
93 }
94
95 async fn prune_verification_keys(&self, max_epoch_to_prune: Epoch) -> StdResult<()> {
96 self.connection
97 .apply(DeleteSignerRegistrationRecordQuery::below_epoch_threshold(
98 max_epoch_to_prune,
99 ))?;
100
101 Ok(())
102 }
103}
104
105#[cfg(test)]
106mod tests {
107 use crate::database::test_helper::{insert_signer_registrations, main_db_connection};
108
109 use mithril_common::entities::{Epoch, PartyId, Signer, SignerWithStake};
110 use mithril_common::test_utils::fake_keys;
111 use std::collections::HashMap;
112 use std::sync::Arc;
113
114 use crate::VerificationKeyStorer;
115
116 use super::*;
117
118 fn build_fake_signers_with_stakes(nb: u64) -> Vec<SignerWithStake> {
122 let verification_keys = fake_keys::signer_verification_key();
123 let nb_keys = verification_keys.len() as u64;
124 (1..=nb)
125 .map(|party_idx| SignerWithStake {
126 party_id: format!("party_id:{party_idx}"),
127 verification_key: verification_keys[(party_idx % nb_keys) as usize]
128 .try_into()
129 .unwrap(),
130 verification_key_signature: None,
131 operational_certificate: None,
132 kes_period: None,
133 stake: 10,
134 })
135 .collect()
136 }
137
138 fn build_signers(
139 nb_epoch: u64,
140 signers_per_epoch: usize,
141 ) -> HashMap<Epoch, Vec<SignerWithStake>> {
142 (1..=nb_epoch)
143 .map(|epoch| {
144 (
145 Epoch(epoch),
146 build_fake_signers_with_stakes(signers_per_epoch as u64),
147 )
148 })
149 .collect()
150 }
151
152 fn insert_golden_signer_registration(connection: &SqliteConnection) {
153 connection
154 .execute(
155 r#"
156 insert into signer_registration
157 values(
158 'pool1t9uuagsat8hlr0n0ga4wzge0jxlyjuhl6mugrm8atc285vzkf2e',
159 292,
160 '7b22766b223a5b3132382c3134322c31352c37322c35342c37332c32392c3135372c39302c3134392c33342c3235352c35312c31382c34342c33322c36302c34362c3130302c31342c3136342c39362c3138362c31382c32372c3231312c3130322c3130362c35352c332c3137302c3234302c3131342c3134372c3134362c3234382c31352c32312c3232392c3133322c3234362c3230322c3136322c34312c3135312c3138362c3136332c3232302c31342c3231372c3235352c3234352c35352c3231362c3235322c342c3137302c31362c3137382c3230392c3134392c32302c3230352c39322c3232312c38302c32392c3139302c3131372c3138382c3132382c3234372c3133312c37382c3138372c3232332c3231382c3131362c3235352c34332c3130392c3132362c3233302c3130382c33372c3131342c332c3138362c3136352c33322c3133312c3139332c3139302c34342c3134362c3234315d2c22706f70223a5b3134322c3133352c38352c342c3134362c32342c37382c34332c36332c3233382c3235312c37382c3138312c37342c37302c362c39342c3138372c3137382c3133332c3135352c3233342c3235352c3134352c3139372c3137302c3135352c3132392c3234332c3137332c31322c31392c36382c3132392c3131342c36392c3231312c33372c3233322c3139332c3130372c3233332c32392c3130332c3232382c34392c36392c38362c3137322c35352c39342c3132332c372c36322c3135382c33352c31372c3131332c38312c3136312c34342c3234392c35332c36362c39332c37302c3136392c3133372c3135372c3233342c3234372c3232332c37312c3135302c3231362c3130322c3139302c3137362c3135322c34362c3134332c3233302c31322c3138382c33312c3234362c3137312c3130352c3230392c3133382c35352c32382c3134312c36302c3132312c3132305d7d',
161 '7b227369676d61223a7b227369676d61223a7b227369676d61223a7b227369676d61223a7b227369676d61223a7b227369676d61223a5b35322c3230342c36342c3136342c3134382c36302c342c3133372c3132312c312c3130302c38352c3133382c3235302c33382c37352c39302c3133352c31392c35322c3135312c3130302c35392c372c33332c3131322c31332c3138342c3138342c32332c35352c37392c3134332c3231382c3231352c3136362c3137392c36312c3234312c3136342c38342c36302c3234312c3234302c3134362c33332c37342c3136372c37342c3230332c37382c34372c3231362c3132352c37382c31302c38312c3233322c3134332c37302c3234362c382c3130352c345d2c226c68735f706b223a5b3130342c3131332c39302c32332c3231392c3235342c382c3137352c3136372c3133312c3136382c3131322c3130392c3137362c31342c35372c38362c3139372c34392c35312c3136382c3131352c3138372c3137382c392c3233322c38362c3139352c3130362c3134322c3232372c3139365d2c227268735f706b223a5b38372c3136392c39392c3133382c3130352c3133312c3133322c3132362c3139382c3138352c3137302c3132352c39372c3137372c38342c3231302c3137362c3134322c3133382c32312c38362c3133312c3135382c3132332c36332c3131322c39392c3133322c3134352c3231322c382c3233315d7d2c226c68735f706b223a5b34302c38382c39392c372c31362c32302c37352c3132302c3234372c3233302c32372c3233392c35332c3235352c3137302c3132302c3131392c33372c3138362c3130322c35302c33362c39382c3139332c3130332c33372c352c3131362c3134322c3134382c3233322c32355d2c227268735f706b223a5b3130372c3135372c3234342c3230342c3133362c3139332c38382c3130322c3234312c3135392c39392c3233342c38342c3139322c3133302c34372c32302c3136362c322c3230302c37392c3133352c3230352c312c3235332c3233352c32382c3134372c3135352c3132322c33392c3234345d7d2c226c68735f706b223a5b3133332c3131362c3131342c36342c3132322c31332c3138362c3130342c39322c3233372c39372c38322c3232312c38322c35342c3132352c34352c3234342c3139322c39332c35362c3132362c34302c3134362c3131312c3132392c3232312c3234382c362c35342c3233372c3138355d2c227268735f706b223a5b3137312c3137302c33382c3232302c3133302c34372c3133362c3233362c37322c35332c36332c33382c32392c34362c3230352c32392c3234382c3235342c37362c32372c322c3132382c3130372c3131392c3132382c3137302c32322c3131322c3137362c3130322c3136332c37335d7d2c226c68735f706b223a5b3231312c3138392c38342c3139372c302c3231382c3134382c312c34332c36332c38342c3234322c3231392c39342c31302c3134302c3134372c3137322c38342c35392c31352c3131342c3230392c3235302c3230372c31342c3134322c33362c3135372c3230332c37382c3137355d2c227268735f706b223a5b3137302c3132392c3132332c342c3131332c3135322c3232392c3133372c392c32342c3133372c3136362c32352c3136352c34332c3132322c3132332c3230312c3234322c3231302c3137382c3234382c31342c3233302c33392c3231322c31382c33362c34382c38372c39302c3230365d7d2c226c68735f706b223a5b33332c3234322c3130372c39312c3130372c3130322c3136332c36342c33332c3231372c3233342c3138302c33382c312c3138352c3135382c3230372c3234352c3136372c3130352c3134322c33382c3233342c37362c34322c32322c372c3130342c39362c3139382c3234322c35335d2c227268735f706b223a5b39352c34302c392c3131372c3130382c3135362c3138342c3133392c39302c3138382c31352c32312c3131322c31382c3130302c3134362c3130342c352c3135362c39372c3134392c33322c34322c3234302c3134392c3138382c35322c33312c39312c39392c3131382c365d7d2c226c68735f706b223a5b3139332c3234322c37362c3230392c3134312c33372c3130312c36382c37302c392c3134312c33392c3230372c39342c3232362c33392c3136302c3131382c32332c3233302c3234342c3231302c31382c38322c3137332c3135382c3233312c3137392c3138322c31392c32322c3134365d2c227268735f706b223a5b3133322c3232392c3130382c3139392c37312c36392c3233362c36352c31382c3131372c39332c3234332c3234332c37342c36392c39382c3134302c3234392c342c33372c37372c38372c35382c31322c3132302c37332c3230332c39362c36312c3233302c39322c3132385d7d',
162 '5b5b5b3138362c39352c3232362c3137342c3132352c3235302c31302c3232322c3130322c3234302c36352c3235352c34372c3133382c38392c3131302c31342c3131302c32322c3138322c33322c3136362c3231312c392c32302c32302c35352c35382c3232392c3132302c3235302c37315d2c312c3136352c5b3130352c35342c3234352c35362c3231352c3130362c3133392c3231322c3137342c3232332c39302c3234392c3138372c34372c3134382c35302c34302c31352c3131372c3231372c3134392c3132362c3231382c3232352c3133362c36352c3231392c3136302c3134382c39332c3232382c3235312c31392c3231332c3136382c332c3233362c38392c3132302c3135392c3139382c38302c3234342c3138302c33332c3131392c3132382c3230312c3138362c3132302c32312c3130322c36322c3232392c32382c3135352c37362c31392c3235322c3232312c3234372c3137342c3135392c365d5d2c5b3234312c32372c31332c34342c3131342c37382c3138392c3234392c3135302c3135302c35332c3134342c3233362c3135312c38382c3134302c3132382c3136322c36302c3232382c38382c3131312c392c3134342c3233322c38332c39342c3231302c3135362c3136382c33352c3234325d5d',
163 29,
164 9497629046,
165 '2023-08-12T00:03:51.236860002+00:00'
166 );
167 "#,
168 )
169 .unwrap();
170 }
171
172 #[tokio::test]
173 async fn test_golden_master() {
174 let connection = main_db_connection().unwrap();
175 insert_golden_signer_registration(&connection);
176
177 let repository = SignerRegistrationStore::new(Arc::new(connection));
178 repository
179 .get_verification_keys(Epoch(292))
180 .await
181 .expect("Getting Golden signer registration should not fail")
182 .expect("Signer registration should exist for this epoch");
183 }
184
185 pub fn init_signer_registration_store(
186 initial_data: HashMap<Epoch, Vec<SignerWithStake>>,
187 ) -> Arc<SignerRegistrationStore> {
188 let connection = main_db_connection().unwrap();
189
190 let initial_data = initial_data.into_iter().collect();
191 insert_signer_registrations(&connection, initial_data).unwrap();
192
193 Arc::new(SignerRegistrationStore::new(Arc::new(connection)))
194 }
195
196 #[tokio::test]
197 pub async fn save_key_in_empty_store() {
198 let signers = build_signers(0, 0);
199 let store = init_signer_registration_store(signers);
200 let res = store
201 .save_verification_key(
202 Epoch(0),
203 SignerWithStake {
204 party_id: "0".to_string(),
205 verification_key: fake_keys::signer_verification_key()[0].try_into().unwrap(),
206 verification_key_signature: None,
207 operational_certificate: None,
208 kes_period: None,
209 stake: 10,
210 },
211 )
212 .await
213 .unwrap();
214
215 assert!(res.is_none());
216 }
217
218 #[tokio::test]
219 pub async fn update_signer_in_store() {
220 let signers = build_signers(1, 1);
221 let signers_on_epoch = signers.get(&Epoch(1)).unwrap().clone();
222 let first_signer = signers_on_epoch.first().unwrap();
223
224 let store = init_signer_registration_store(signers);
225 let res = store
226 .save_verification_key(
227 Epoch(1),
228 SignerWithStake {
229 party_id: first_signer.party_id.clone(),
230 verification_key: fake_keys::signer_verification_key()[2].try_into().unwrap(),
231 verification_key_signature: None,
232 operational_certificate: None,
233 kes_period: None,
234 stake: 10,
235 },
236 )
237 .await
238 .unwrap();
239
240 assert_eq!(
241 Some(SignerWithStake {
242 party_id: first_signer.party_id.clone(),
243 verification_key: fake_keys::signer_verification_key()[2].try_into().unwrap(),
244 verification_key_signature: None,
245 operational_certificate: None,
246 kes_period: None,
247 stake: 10,
248 }),
249 res,
250 );
251 }
252
253 #[tokio::test]
254 pub async fn get_verification_keys_for_empty_epoch() {
255 let signers = build_signers(2, 1);
256 let store = init_signer_registration_store(signers);
257 let res = store.get_verification_keys(Epoch(0)).await.unwrap();
258
259 assert!(res.is_none());
260 }
261
262 #[tokio::test]
263 pub async fn get_signers_for_empty_epoch() {
264 let signers = build_signers(2, 1);
265 let store = init_signer_registration_store(signers);
266 let res = store.get_signers(Epoch(0)).await.unwrap();
267
268 assert!(res.is_none());
269 }
270
271 #[tokio::test]
272 pub async fn get_verification_keys_for_existing_epoch() {
273 let signers = build_signers(2, 2);
274 let store = init_signer_registration_store(signers.clone());
275
276 let epoch = Epoch(1);
277 let expected_signers = signers
278 .get(&epoch)
279 .unwrap()
280 .iter()
281 .map(|s| (s.party_id.clone(), Signer::from(s.clone())))
282 .collect::<HashMap<PartyId, Signer>>();
283
284 let res = store.get_verification_keys(epoch).await.unwrap().unwrap();
285
286 assert_eq!(expected_signers, res);
287 }
288
289 #[tokio::test]
290 pub async fn get_signers_for_existing_epoch() {
291 let signers = build_signers(2, 2);
292 let store = init_signer_registration_store(signers.clone());
293
294 let epoch = Epoch(1);
295 let mut expected_signers = signers.get(&epoch).unwrap().clone();
296 expected_signers.sort_by(|a, b| a.party_id.cmp(&b.party_id));
297
298 let mut res = store.get_signers(epoch).await.unwrap().unwrap();
299 res.sort_by(|a, b| a.party_id.cmp(&b.party_id));
300
301 assert_eq!(expected_signers, res);
302 }
303
304 #[tokio::test]
305 pub async fn can_prune_keys_from_given_epoch_retention_limit() {
306 let signers = build_signers(6, 2);
307 let store = init_signer_registration_store(signers);
308
309 for epoch in 1..6 {
310 assert!(
311 store
312 .get_verification_keys(Epoch(epoch))
313 .await
314 .unwrap()
315 .is_some(),
316 "Keys should exist before pruning"
317 );
318 store
319 .prune_verification_keys(Epoch(epoch) + 1)
320 .await
321 .expect("Pruning should not fail");
322
323 let pruned_epoch_keys = store.get_verification_keys(Epoch(epoch)).await.unwrap();
324 assert_eq!(None, pruned_epoch_keys);
325 }
326 }
327
328 async fn get_epochs_in_database_until(
329 store: &SignerRegistrationStore,
330 until_epoch: Epoch,
331 ) -> Vec<Epoch> {
332 let mut epochs_in_database = vec![];
333 for epoch_number in 1..=(*until_epoch) {
334 let current_epoch = Epoch(epoch_number);
335 if store
336 .get_verification_keys(current_epoch)
337 .await
338 .unwrap()
339 .is_some()
340 {
341 epochs_in_database.push(current_epoch);
342 }
343 }
344
345 epochs_in_database
346 }
347
348 #[tokio::test]
349 async fn prune_epoch_older_than_threshold() {
350 let signers = build_signers(5, 2);
351 let store = init_signer_registration_store(signers);
352
353 assert_eq!(
354 vec!(Epoch(1), Epoch(2), Epoch(3), Epoch(4), Epoch(5)),
355 get_epochs_in_database_until(&store, Epoch(8)).await
356 );
357
358 store.prune_verification_keys(Epoch(4)).await.unwrap();
359
360 assert_eq!(
361 vec!(Epoch(4), Epoch(5)),
362 get_epochs_in_database_until(&store, Epoch(8)).await
363 );
364 }
365}