refactor: Rename ProtocolParametersStorer to EpochSettingsStorer

Author: dlachaume

mithril-aggregator/src/database/repository/epoch_settings_store.rs

@@ -10,7 +10,7 @@ use mithril_persistence::store::adapter::AdapterError;
 use crate::database::query::{
     DeleteEpochSettingsQuery, GetEpochSettingsQuery, UpdateEpochSettingsQuery,
 };
-use crate::ProtocolParametersStorer;
+use crate::EpochSettingsStorer;
 
 /// Service to deal with epoch settings (read & write).
 pub struct EpochSettingsStore {
@@ -32,8 +32,8 @@ impl EpochSettingsStore {
 }
 
 #[async_trait]
-impl ProtocolParametersStorer for EpochSettingsStore {
-    async fn save_protocol_parameters(
+impl EpochSettingsStorer for EpochSettingsStore {
+    async fn save_epoch_settings(
         &self,
         epoch: Epoch,
         protocol_parameters: ProtocolParameters,
@@ -60,7 +60,7 @@ impl ProtocolParametersStorer for EpochSettingsStore {
         Ok(Some(epoch_setting_record.protocol_parameters))
     }
 
-    async fn get_protocol_parameters(&self, epoch: Epoch) -> StdResult<Option<ProtocolParameters>> {
+    async fn get_epoch_settings(&self, epoch: Epoch) -> StdResult<Option<ProtocolParameters>> {
         let mut cursor = self
             .connection
             .fetch(GetEpochSettingsQuery::by_epoch(epoch)?)
@@ -93,14 +93,14 @@ mod tests {
         );
 
         store
-            .save_protocol_parameters(
+            .save_epoch_settings(
                 Epoch(2) + EPOCH_SETTING_PRUNE_EPOCH_THRESHOLD,
                 fake_data::protocol_parameters(),
             )
             .await
             .expect("saving protocol parameters should not fails");
-        let epoch1_params = store.get_protocol_parameters(Epoch(1)).await.unwrap();
-        let epoch2_params = store.get_protocol_parameters(Epoch(2)).await.unwrap();
+        let epoch1_params = store.get_epoch_settings(Epoch(1)).await.unwrap();
+        let epoch2_params = store.get_epoch_settings(Epoch(2)).await.unwrap();
 
         assert!(
             epoch1_params.is_none(),

mithril-aggregator/src/dependency_injection/builder.rs

@@ -75,8 +75,8 @@ use crate::{
     tools::{CExplorerSignerRetriever, GcpFileUploader, GenesisToolsDependency, SignersImporter},
     AggregatorConfig, AggregatorRunner, AggregatorRuntime, CertificatePendingStore,
     CompressedArchiveSnapshotter, Configuration, DependencyContainer, DumbSnapshotUploader,
-    DumbSnapshotter, LocalSnapshotUploader, MithrilSignerRegisterer, MultiSigner, MultiSignerImpl,
-    ProtocolParametersStorer, RemoteSnapshotUploader, SingleSignatureAuthenticator,
+    DumbSnapshotter, EpochSettingsStorer, LocalSnapshotUploader, MithrilSignerRegisterer,
+    MultiSigner, MultiSignerImpl, RemoteSnapshotUploader, SingleSignatureAuthenticator,
     SnapshotUploader, SnapshotUploaderType, Snapshotter, SnapshotterCompressionAlgorithm,
     VerificationKeyStorer,
 };
@@ -131,7 +131,7 @@ pub struct DependenciesBuilder {
     pub verification_key_store: Option<Arc<dyn VerificationKeyStorer>>,
 
     /// Protocol parameter store.
-    pub protocol_parameters_store: Option<Arc<dyn ProtocolParametersStorer>>,
+    pub protocol_parameters_store: Option<Arc<dyn EpochSettingsStorer>>,
 
     /// Cardano CLI Runner for the [ChainObserver]
     pub cardano_cli_runner: Option<Box<CardanoCliRunner>>,
@@ -554,9 +554,7 @@ impl DependenciesBuilder {
         Ok(self.verification_key_store.as_ref().cloned().unwrap())
     }
 
-    async fn build_protocol_parameters_store(
-        &mut self,
-    ) -> Result<Arc<dyn ProtocolParametersStorer>> {
+    async fn build_protocol_parameters_store(&mut self) -> Result<Arc<dyn EpochSettingsStorer>> {
         let protocol_parameters_store = EpochSettingsStore::new(
             self.get_sqlite_connection().await?,
             self.configuration.safe_epoch_retention_limit(),
@@ -588,9 +586,7 @@ impl DependenciesBuilder {
     }
 
     /// Get a configured [ProtocolParametersStorer].
-    pub async fn get_protocol_parameters_store(
-        &mut self,
-    ) -> Result<Arc<dyn ProtocolParametersStorer>> {
+    pub async fn get_protocol_parameters_store(&mut self) -> Result<Arc<dyn EpochSettingsStorer>> {
         if self.protocol_parameters_store.is_none() {
             self.protocol_parameters_store = Some(self.build_protocol_parameters_store().await?);
         }

mithril-aggregator/src/dependency_injection/containers.rs

@@ -32,9 +32,8 @@ use crate::{
     },
     signer_registerer::SignerRecorder,
     snapshot_uploaders::SnapshotUploader,
-    CertificatePendingStore, ProtocolParametersStorer, SignerRegisterer,
-    SignerRegistrationRoundOpener, SingleSignatureAuthenticator, Snapshotter,
-    VerificationKeyStorer,
+    CertificatePendingStore, EpochSettingsStorer, SignerRegisterer, SignerRegistrationRoundOpener,
+    SingleSignatureAuthenticator, Snapshotter, VerificationKeyStorer,
 };
 
 /// EpochServiceWrapper wraps a [EpochService]
@@ -80,7 +79,7 @@ pub struct DependencyContainer {
     pub verification_key_store: Arc<dyn VerificationKeyStorer>,
 
     /// Protocol parameter store.
-    pub protocol_parameters_store: Arc<dyn ProtocolParametersStorer>,
+    pub protocol_parameters_store: Arc<dyn EpochSettingsStorer>,
 
     /// Chain observer service.
     pub chain_observer: Arc<dyn ChainObserver>,
@@ -194,7 +193,7 @@ impl DependencyContainer {
     pub async fn init_state_from_fixture(&self, fixture: &MithrilFixture, target_epochs: &[Epoch]) {
         for epoch in target_epochs {
             self.protocol_parameters_store
-                .save_protocol_parameters(*epoch, fixture.protocol_parameters())
+                .save_epoch_settings(*epoch, fixture.protocol_parameters())
                 .await
                 .expect("save_protocol_parameters should not fail");
             self.fill_verification_key_store(*epoch, &fixture.signers_with_stake())
@@ -242,7 +241,7 @@ impl DependencyContainer {
         epochs_to_save.push(epoch_to_sign.next());
         for epoch in epochs_to_save {
             self.protocol_parameters_store
-                .save_protocol_parameters(epoch, protocol_parameters.clone())
+                .save_epoch_settings(epoch, protocol_parameters.clone())
                 .await
                 .expect("save_protocol_parameters should not fail");
         }

mithril-aggregator/src/lib.rs

@@ -53,7 +53,7 @@ pub use snapshotter::{
     SnapshotterCompressionAlgorithm,
 };
 pub use store::{
-    CertificatePendingStore, ProtocolParametersStorer, VerificationKeyStore, VerificationKeyStorer,
+    CertificatePendingStore, EpochSettingsStorer, VerificationKeyStore, VerificationKeyStorer,
 };
 pub use tools::{
     CExplorerSignerRetriever, SignersImporter, SignersImporterPersister, SignersImporterRetriever,

mithril-aggregator/src/runtime/runner.rs

@@ -953,7 +953,7 @@ pub mod tests {
             .expect("update_protocol_parameters should not fail");
 
         let saved_protocol_parameters = protocol_parameters_store
-            .get_protocol_parameters(insert_epoch)
+            .get_epoch_settings(insert_epoch)
             .await
             .unwrap()
             .unwrap_or_else(|| panic!("should have protocol parameters for epoch {insert_epoch}",));

mithril-aggregator/src/services/epoch_service.rs

@@ -9,7 +9,7 @@ use mithril_common::entities::{Epoch, ProtocolParameters, Signer, SignerWithStak
 use mithril_common::protocol::{MultiSigner as ProtocolMultiSigner, SignerBuilder};
 use mithril_common::StdResult;
 
-use crate::{ProtocolParametersStorer, VerificationKeyStorer};
+use crate::{EpochSettingsStorer, VerificationKeyStorer};
 
 /// Errors dedicated to the CertifierService.
 #[derive(Debug, Error)]
@@ -107,15 +107,15 @@ pub struct MithrilEpochService {
     future_protocol_parameters: ProtocolParameters,
     epoch_data: Option<EpochData>,
     computed_epoch_data: Option<ComputedEpochData>,
-    protocol_parameters_store: Arc<dyn ProtocolParametersStorer>,
+    protocol_parameters_store: Arc<dyn EpochSettingsStorer>,
     verification_key_store: Arc<dyn VerificationKeyStorer>,
 }
 
 impl MithrilEpochService {
     /// Create a new service instance
     pub fn new(
         future_protocol_parameters: ProtocolParameters,
-        protocol_parameters_store: Arc<dyn ProtocolParametersStorer>,
+        protocol_parameters_store: Arc<dyn EpochSettingsStorer>,
         verification_key_store: Arc<dyn VerificationKeyStorer>,
     ) -> Self {
         Self {
@@ -147,7 +147,7 @@ impl MithrilEpochService {
     ) -> StdResult<ProtocolParameters> {
         let parameters = self
             .protocol_parameters_store
-            .get_protocol_parameters(epoch)
+            .get_epoch_settings(epoch)
             .await
             .with_context(|| format!("Epoch service failed to obtain {name}"))?
             .ok_or(EpochServiceError::UnavailableData(epoch, name.to_string()))?;
@@ -165,7 +165,7 @@ impl MithrilEpochService {
         );
 
         self.protocol_parameters_store
-            .save_protocol_parameters(
+            .save_epoch_settings(
                 recording_epoch,
                 self.future_protocol_parameters.clone(),
             )
@@ -521,7 +521,7 @@ mod tests {
     use std::collections::{BTreeSet, HashMap};
 
     use crate::services::epoch_service::tests::ServiceBuilderParameters::WithFutureProtocolParameters;
-    use crate::store::FakeProtocolParametersStorer;
+    use crate::store::FakeEpochSettingsStorer;
     use crate::VerificationKeyStore;
 
     use super::*;
@@ -617,7 +617,7 @@ mod tests {
             }
         }
 
-        let protocol_parameters_store = FakeProtocolParametersStorer::new(vec![
+        let protocol_parameters_store = FakeEpochSettingsStorer::new(vec![
             (
                 signer_retrieval_epoch,
                 current_epoch_fixture.protocol_parameters(),
@@ -797,7 +797,7 @@ mod tests {
 
         let inserted_protocol_parameters = service
             .protocol_parameters_store
-            .get_protocol_parameters(epoch.offset_to_protocol_parameters_recording_epoch())
+            .get_epoch_settings(epoch.offset_to_protocol_parameters_recording_epoch())
             .await
             .unwrap_or_else(|_| {
                 panic!(

mithril-aggregator/src/store/protocol_parameters_store.rs renamed to mithril-aggregator/src/store/epoch_settings_storer.rs

@@ -9,16 +9,16 @@ use mithril_common::entities::{Epoch, ProtocolParameters};
 
 /// Store and get [protocol parameters][ProtocolParameters] for given epoch.
 #[async_trait]
-pub trait ProtocolParametersStorer: Sync + Send {
+pub trait EpochSettingsStorer: Sync + Send {
     /// Save the given `ProtocolParameter` for the given [Epoch].
-    async fn save_protocol_parameters(
+    async fn save_epoch_settings(
         &self,
         epoch: Epoch,
         protocol_parameters: ProtocolParameters,
     ) -> StdResult<Option<ProtocolParameters>>;
 
     /// Get the saved `ProtocolParameter` for the given [Epoch] if any.
-    async fn get_protocol_parameters(&self, epoch: Epoch) -> StdResult<Option<ProtocolParameters>>;
+    async fn get_epoch_settings(&self, epoch: Epoch) -> StdResult<Option<ProtocolParameters>>;
 
     /// Handle discrepancies at startup in the protocol parameters store.
     /// In case an aggregator has been launched after some epochs of not being up or at initial startup,
@@ -31,9 +31,9 @@ pub trait ProtocolParametersStorer: Sync + Send {
     ) -> StdResult<()> {
         for epoch_offset in 0..=2 {
             let epoch = current_epoch + epoch_offset;
-            if self.get_protocol_parameters(epoch).await?.is_none() {
+            if self.get_epoch_settings(epoch).await?.is_none() {
                 debug!("Handle discrepancies at startup of protocol parameters store, will record protocol parameters from the configuration for epoch {epoch}: {configuration_protocol_parameters:?}");
-                self.save_protocol_parameters(epoch, configuration_protocol_parameters.clone())
+                self.save_epoch_settings(epoch, configuration_protocol_parameters.clone())
                     .await?;
             }
         }
@@ -42,11 +42,11 @@ pub trait ProtocolParametersStorer: Sync + Send {
     }
 }
 
-pub struct FakeProtocolParametersStorer {
+pub struct FakeEpochSettingsStorer {
     pub protocol_parameters: RwLock<HashMap<Epoch, ProtocolParameters>>,
 }
 
-impl FakeProtocolParametersStorer {
+impl FakeEpochSettingsStorer {
     #[cfg(test)]
     pub fn new(data: Vec<(Epoch, ProtocolParameters)>) -> Self {
         let protocol_parameters = RwLock::new(data.into_iter().collect());
@@ -57,8 +57,8 @@ impl FakeProtocolParametersStorer {
 }
 
 #[async_trait]
-impl ProtocolParametersStorer for FakeProtocolParametersStorer {
-    async fn save_protocol_parameters(
+impl EpochSettingsStorer for FakeEpochSettingsStorer {
+    async fn save_epoch_settings(
         &self,
         epoch: Epoch,
         protocol_parameters: ProtocolParameters,
@@ -67,7 +67,7 @@ impl ProtocolParametersStorer for FakeProtocolParametersStorer {
         Ok(protocol_parameters_write.insert(epoch, protocol_parameters))
     }
 
-    async fn get_protocol_parameters(&self, epoch: Epoch) -> StdResult<Option<ProtocolParameters>> {
+    async fn get_epoch_settings(&self, epoch: Epoch) -> StdResult<Option<ProtocolParameters>> {
         let protocol_parameters = self.protocol_parameters.read().await;
         Ok(protocol_parameters.get(&epoch).cloned())
     }
@@ -84,9 +84,9 @@ mod tests {
     async fn test_save_protocol_parameters_do_not_exist_yet() {
         let protocol_parameters = fake_data::protocol_parameters();
         let epoch = Epoch(1);
-        let store = FakeProtocolParametersStorer::new(vec![]);
+        let store = FakeEpochSettingsStorer::new(vec![]);
         let protocol_parameters_previous = store
-            .save_protocol_parameters(epoch, protocol_parameters)
+            .save_epoch_settings(epoch, protocol_parameters)
             .await
             .unwrap();
 
@@ -97,13 +97,13 @@ mod tests {
     async fn test_save_protocol_parameters_already_exist() {
         let protocol_parameters = fake_data::protocol_parameters();
         let epoch = Epoch(1);
-        let store = FakeProtocolParametersStorer::new(vec![(epoch, protocol_parameters.clone())]);
+        let store = FakeEpochSettingsStorer::new(vec![(epoch, protocol_parameters.clone())]);
         let protocol_parameters_new = ProtocolParameters {
             k: protocol_parameters.k + 1,
             ..protocol_parameters
         };
         let protocol_parameters_previous = store
-            .save_protocol_parameters(epoch, protocol_parameters_new)
+            .save_epoch_settings(epoch, protocol_parameters_new)
             .await
             .unwrap();
 
@@ -114,8 +114,8 @@ mod tests {
     async fn test_get_protocol_parameters_exist() {
         let protocol_parameters = fake_data::protocol_parameters();
         let epoch = Epoch(1);
-        let store = FakeProtocolParametersStorer::new(vec![(epoch, protocol_parameters.clone())]);
-        let protocol_parameters_stored = store.get_protocol_parameters(epoch).await.unwrap();
+        let store = FakeEpochSettingsStorer::new(vec![(epoch, protocol_parameters.clone())]);
+        let protocol_parameters_stored = store.get_epoch_settings(epoch).await.unwrap();
 
         assert_eq!(Some(protocol_parameters), protocol_parameters_stored);
     }
@@ -124,8 +124,8 @@ mod tests {
     async fn test_get_protocol_parameters_do_not_exist() {
         let protocol_parameters = fake_data::protocol_parameters();
         let epoch = Epoch(1);
-        let store = FakeProtocolParametersStorer::new(vec![(epoch, protocol_parameters.clone())]);
-        let protocol_parameters_stored = store.get_protocol_parameters(epoch + 1).await.unwrap();
+        let store = FakeEpochSettingsStorer::new(vec![(epoch, protocol_parameters.clone())]);
+        let protocol_parameters_stored = store.get_epoch_settings(epoch + 1).await.unwrap();
 
         assert!(protocol_parameters_stored.is_none());
     }
@@ -138,7 +138,7 @@ mod tests {
             ..protocol_parameters
         };
         let epoch = Epoch(1);
-        let store = FakeProtocolParametersStorer::new(vec![
+        let store = FakeEpochSettingsStorer::new(vec![
             (epoch, protocol_parameters.clone()),
             (epoch + 1, protocol_parameters.clone()),
         ]);
@@ -148,25 +148,25 @@ mod tests {
             .await
             .unwrap();
 
-        let protocol_parameters_stored = store.get_protocol_parameters(epoch).await.unwrap();
+        let protocol_parameters_stored = store.get_epoch_settings(epoch).await.unwrap();
         assert_eq!(
             Some(protocol_parameters.clone()),
             protocol_parameters_stored
         );
 
-        let protocol_parameters_stored = store.get_protocol_parameters(epoch + 1).await.unwrap();
+        let protocol_parameters_stored = store.get_epoch_settings(epoch + 1).await.unwrap();
         assert_eq!(
             Some(protocol_parameters.clone()),
             protocol_parameters_stored
         );
 
-        let protocol_parameters_stored = store.get_protocol_parameters(epoch + 2).await.unwrap();
+        let protocol_parameters_stored = store.get_epoch_settings(epoch + 2).await.unwrap();
         assert_eq!(
             Some(protocol_parameters_new.clone()),
             protocol_parameters_stored
         );
 
-        let protocol_parameters_stored = store.get_protocol_parameters(epoch + 3).await.unwrap();
+        let protocol_parameters_stored = store.get_epoch_settings(epoch + 3).await.unwrap();
         assert!(protocol_parameters_stored.is_none());
     }
 }

mithril-aggregator/src/store/mod.rs

@@ -1,13 +1,13 @@
+mod epoch_settings_storer;
 mod pending_certificate_store;
-mod protocol_parameters_store;
 mod verification_key_store;
 
+pub use epoch_settings_storer::EpochSettingsStorer;
 pub use pending_certificate_store::CertificatePendingStore;
-pub use protocol_parameters_store::ProtocolParametersStorer;
 pub use verification_key_store::{VerificationKeyStore, VerificationKeyStorer};
 
 #[cfg(test)]
-pub use protocol_parameters_store::FakeProtocolParametersStorer;
+pub use epoch_settings_storer::FakeEpochSettingsStorer;
 #[cfg(test)]
 pub use verification_key_store::test_suite as verification_key_store_test_suite;
 #[cfg(test)]