refactor: enhance namings in 'signer_registration' module of aggregator

mithril-aggregator/src/dependency_injection/builder/mod.rs

@@ -47,10 +47,10 @@ use crate::{
         AggregatorClient, CertifierService, EpochPruningTask, MessageService, ProverService,
         SignedEntityService, Snapshotter, StakeDistributionService, UpkeepService,
     },
-    signer_registration::{MithrilSignerRegistererSlave, SignerSynchronizer},
+    signer_registration::{MithrilSignerRegistrationSlave, SignerSynchronizer},
     tools::GenesisToolsDependency,
     AggregatorConfig, AggregatorRunner, AggregatorRuntime, Configuration, DependencyContainer,
-    ImmutableFileDigestMapper, MetricsService, MithrilSignerRegistererMaster, MultiSigner,
+    ImmutableFileDigestMapper, MetricsService, MithrilSignerRegistrationMaster, MultiSigner,
     SignerRegisterer, SignerRegistrationRoundOpener, SignerRegistrationVerifier,
     SingleSignatureAuthenticator, VerificationKeyStorer,
 };
@@ -150,10 +150,10 @@ pub struct DependenciesBuilder {
     pub genesis_verifier: Option<Arc<ProtocolGenesisVerifier>>,
 
     /// Mithril signer registerer master service
-    pub mithril_signer_registerer_master: Option<Arc<MithrilSignerRegistererMaster>>,
+    pub mithril_signer_registerer_master: Option<Arc<MithrilSignerRegistrationMaster>>,
 
     /// Mithril signer registerer slave service
-    pub mithril_signer_registerer_slave: Option<Arc<MithrilSignerRegistererSlave>>,
+    pub mithril_signer_registerer_slave: Option<Arc<MithrilSignerRegistrationSlave>>,
 
     /// Signer registerer service
     pub signer_registerer: Option<Arc<dyn SignerRegisterer>>,

mithril-aggregator/src/dependency_injection/builder/protocol/certificates.rs

@@ -9,9 +9,9 @@ use mithril_common::crypto_helper::{
 use crate::database::repository::{BufferedSingleSignatureRepository, SingleSignatureRepository};
 use crate::dependency_injection::{DependenciesBuilder, DependenciesBuilderError, Result};
 use crate::services::{BufferedCertifierService, CertifierService, MithrilCertifierService};
-use crate::signer_registration::{MithrilSignerRegistererSlave, SignerSynchronizer};
+use crate::signer_registration::{MithrilSignerRegistrationSlave, SignerSynchronizer};
 use crate::{
-    ExecutionEnvironment, MithrilSignerRegistererMaster, MithrilSignerRegistrationVerifier,
+    ExecutionEnvironment, MithrilSignerRegistrationMaster, MithrilSignerRegistrationVerifier,
     MultiSigner, MultiSignerImpl, SignerRegisterer, SignerRegistrationRoundOpener,
     SignerRegistrationVerifier, SingleSignatureAuthenticator,
 };
@@ -125,11 +125,11 @@ impl DependenciesBuilder {
         Ok(self.genesis_verifier.as_ref().cloned().unwrap())
     }
 
-    /// Return a [MithrilSignerRegistererMaster] service
-    async fn build_mithril_registerer_master(
+    /// Return a [MithrilSignerRegistrationMaster] service
+    async fn build_mithril_signer_registration_master(
         &mut self,
-    ) -> Result<Arc<MithrilSignerRegistererMaster>> {
-        let registerer = MithrilSignerRegistererMaster::new(
+    ) -> Result<Arc<MithrilSignerRegistrationMaster>> {
+        let registerer = MithrilSignerRegistrationMaster::new(
             self.get_verification_key_store().await?,
             self.get_signer_store().await?,
             self.get_signer_registration_verifier().await?,
@@ -139,13 +139,13 @@ impl DependenciesBuilder {
         Ok(Arc::new(registerer))
     }
 
-    /// Return a [MithrilSignerRegistererMaster]
-    pub async fn get_mithril_signer_registerer_master(
+    /// Return a [MithrilSignerRegistrationMaster]
+    pub async fn get_mithril_signer_registration_master(
         &mut self,
-    ) -> Result<Arc<MithrilSignerRegistererMaster>> {
+    ) -> Result<Arc<MithrilSignerRegistrationMaster>> {
         if self.mithril_signer_registerer_master.is_none() {
             self.mithril_signer_registerer_master =
-                Some(self.build_mithril_registerer_master().await?);
+                Some(self.build_mithril_signer_registration_master().await?);
         }
 
         Ok(self
@@ -155,11 +155,11 @@ impl DependenciesBuilder {
             .unwrap())
     }
 
-    /// Return a [MithrilSignerRegistererSlave] service
-    async fn build_mithril_registerer_slave(
+    /// Return a [MithrilSignerRegistrationSlave] service
+    async fn build_mithril_signer_registration_slave(
         &mut self,
-    ) -> Result<Arc<MithrilSignerRegistererSlave>> {
-        let registerer = MithrilSignerRegistererSlave::new(
+    ) -> Result<Arc<MithrilSignerRegistrationSlave>> {
+        let registerer = MithrilSignerRegistrationSlave::new(
             self.get_verification_key_store().await?,
             self.get_signer_store().await?,
             self.get_signer_registration_verifier().await?,
@@ -169,13 +169,13 @@ impl DependenciesBuilder {
         Ok(Arc::new(registerer))
     }
 
-    /// Return a [MithrilSignerRegistererSlave]
-    pub async fn get_mithril_signer_registerer_slave(
+    /// Return a [MithrilSignerRegistrationSlave]
+    pub async fn get_mithril_signer_registration_slave(
         &mut self,
-    ) -> Result<Arc<MithrilSignerRegistererSlave>> {
+    ) -> Result<Arc<MithrilSignerRegistrationSlave>> {
         if self.mithril_signer_registerer_slave.is_none() {
             self.mithril_signer_registerer_slave =
-                Some(self.build_mithril_registerer_slave().await?);
+                Some(self.build_mithril_signer_registration_slave().await?);
         }
 
         Ok(self
@@ -189,9 +189,9 @@ impl DependenciesBuilder {
     pub async fn get_signer_registerer(&mut self) -> Result<Arc<dyn SignerRegisterer>> {
         if self.signer_registerer.is_none() {
             self.signer_registerer = Some(if self.configuration.is_slave_aggregator() {
-                self.get_mithril_signer_registerer_slave().await?
+                self.get_mithril_signer_registration_slave().await?
             } else {
-                self.get_mithril_signer_registerer_master().await?
+                self.get_mithril_signer_registration_master().await?
             });
         }
 
@@ -202,9 +202,9 @@ impl DependenciesBuilder {
     pub async fn get_signer_synchronizer(&mut self) -> Result<Arc<dyn SignerSynchronizer>> {
         if self.signer_synchronizer.is_none() {
             self.signer_synchronizer = Some(if self.configuration.is_slave_aggregator() {
-                self.get_mithril_signer_registerer_slave().await?
+                self.get_mithril_signer_registration_slave().await?
             } else {
-                self.get_mithril_signer_registerer_master().await?
+                self.get_mithril_signer_registration_master().await?
             });
         }
 
@@ -238,10 +238,10 @@ impl DependenciesBuilder {
         if self.signer_registration_round_opener.is_none() {
             if self.configuration.is_slave_aggregator() {
                 self.signer_registration_round_opener =
-                    Some(self.get_mithril_signer_registerer_slave().await?);
+                    Some(self.get_mithril_signer_registration_slave().await?);
             } else {
                 self.signer_registration_round_opener =
-                    Some(self.get_mithril_signer_registerer_master().await?);
+                    Some(self.get_mithril_signer_registration_master().await?);
             }
         }
 

mithril-aggregator/src/dependency_injection/builder/support/upkeep.rs

@@ -11,9 +11,9 @@ impl DependenciesBuilder {
         if self.signer_registration_pruning_task.is_none() {
             self.signer_registration_pruning_task =
                 Some(if self.configuration.is_slave_aggregator() {
-                    self.get_mithril_signer_registerer_slave().await?
+                    self.get_mithril_signer_registration_slave().await?
                 } else {
-                    self.get_mithril_signer_registerer_master().await?
+                    self.get_mithril_signer_registration_master().await?
                 });
         }
 

mithril-aggregator/src/lib.rs

@@ -45,9 +45,10 @@ pub use runtime::{
     AggregatorConfig, AggregatorRunner, AggregatorRunnerTrait, AggregatorRuntime, RuntimeError,
 };
 pub use signer_registration::{
-    MithrilSignerRegistererMaster, MithrilSignerRegistererSlave, MithrilSignerRegistrationVerifier,
-    SignerRecorder, SignerRegisterer, SignerRegistrationError, SignerRegistrationRound,
-    SignerRegistrationRoundOpener, SignerRegistrationVerifier, SignerSynchronizer,
+    MithrilSignerRegistrationMaster, MithrilSignerRegistrationSlave,
+    MithrilSignerRegistrationVerifier, SignerRecorder, SignerRegisterer, SignerRegistrationError,
+    SignerRegistrationRound, SignerRegistrationRoundOpener, SignerRegistrationVerifier,
+    SignerSynchronizer,
 };
 pub use store::{EpochSettingsStorer, VerificationKeyStorer};
 pub use tools::{

mithril-aggregator/src/runtime/runner.rs

@@ -555,7 +555,8 @@ pub mod tests {
         initialize_dependencies,
         runtime::{AggregatorRunner, AggregatorRunnerTrait},
         services::{MithrilStakeDistributionService, MockCertifierService},
-        Configuration, DependencyContainer, MithrilSignerRegistererMaster, SignerRegistrationRound,
+        Configuration, DependencyContainer, MithrilSignerRegistrationMaster,
+        SignerRegistrationRound,
     };
     use async_trait::async_trait;
     use chrono::{DateTime, Utc};
@@ -740,7 +741,7 @@ pub mod tests {
     #[tokio::test]
     async fn test_open_signer_registration_round() {
         let mut deps = initialize_dependencies().await;
-        let signer_registration_round_opener = Arc::new(MithrilSignerRegistererMaster::new(
+        let signer_registration_round_opener = Arc::new(MithrilSignerRegistrationMaster::new(
             deps.verification_key_store.clone(),
             deps.signer_recorder.clone(),
             deps.signer_registration_verifier.clone(),
@@ -780,7 +781,7 @@ pub mod tests {
     #[tokio::test]
     async fn test_close_signer_registration_round() {
         let mut deps = initialize_dependencies().await;
-        let signer_registration_round_opener = Arc::new(MithrilSignerRegistererMaster::new(
+        let signer_registration_round_opener = Arc::new(MithrilSignerRegistrationMaster::new(
             deps.verification_key_store.clone(),
             deps.signer_recorder.clone(),
             deps.signer_registration_verifier.clone(),

mithril-aggregator/src/signer_registration/master.rs

@@ -16,8 +16,8 @@ use super::{
     SignerRegistrationRoundOpener, SignerSynchronizer,
 };
 
-/// Implementation of a [SignerRegisterer]
-pub struct MithrilSignerRegistererMaster {
+/// A [MithrilSignerRegistrationMaster] supports signer registrations in a master aggregator
+pub struct MithrilSignerRegistrationMaster {
     /// Current signer registration round
     current_round: RwLock<Option<SignerRegistrationRound>>,
 
@@ -35,7 +35,7 @@ pub struct MithrilSignerRegistererMaster {
     verification_key_epoch_retention_limit: Option<u64>,
 }
 
-impl MithrilSignerRegistererMaster {
+impl MithrilSignerRegistrationMaster {
     /// MithrilSignerRegistererMaster factory
     pub fn new(
         verification_key_store: Arc<dyn VerificationKeyStorer>,
@@ -59,7 +59,7 @@ impl MithrilSignerRegistererMaster {
 }
 
 #[async_trait]
-impl SignerRegistrationRoundOpener for MithrilSignerRegistererMaster {
+impl SignerRegistrationRoundOpener for MithrilSignerRegistrationMaster {
     async fn open_registration_round(
         &self,
         registration_epoch: Epoch,
@@ -83,7 +83,7 @@ impl SignerRegistrationRoundOpener for MithrilSignerRegistererMaster {
 }
 
 #[async_trait]
-impl EpochPruningTask for MithrilSignerRegistererMaster {
+impl EpochPruningTask for MithrilSignerRegistrationMaster {
     fn pruned_data(&self) -> &'static str {
         "Signer registration"
     }
@@ -108,7 +108,7 @@ impl EpochPruningTask for MithrilSignerRegistererMaster {
 }
 
 #[async_trait]
-impl SignerRegisterer for MithrilSignerRegistererMaster {
+impl SignerRegisterer for MithrilSignerRegistrationMaster {
     async fn register_signer(
         &self,
         epoch: Epoch,
@@ -162,7 +162,7 @@ impl SignerRegisterer for MithrilSignerRegistererMaster {
 }
 
 #[async_trait]
-impl SignerSynchronizer for MithrilSignerRegistererMaster {
+impl SignerSynchronizer for MithrilSignerRegistrationMaster {
     async fn synchronize_signers(
         &self,
         _epoch: Epoch,
@@ -191,7 +191,7 @@ mod tests {
             MockSignerRecorder, MockSignerRegistrationVerifier, SignerSynchronizer,
         },
         store::MockVerificationKeyStorer,
-        MithrilSignerRegistererMaster, SignerRegisterer, SignerRegistrationRoundOpener,
+        MithrilSignerRegistrationMaster, SignerRegisterer, SignerRegistrationRoundOpener,
         VerificationKeyStorer,
     };
 
@@ -211,7 +211,7 @@ mod tests {
             .expect_verify()
             .returning(|signer, _| Ok(SignerWithStake::from_signer(signer.to_owned(), 123)))
             .once();
-        let signer_registerer = MithrilSignerRegistererMaster::new(
+        let signer_registerer = MithrilSignerRegistrationMaster::new(
             verification_key_store.clone(),
             Arc::new(signer_recorder),
             Arc::new(signer_registration_verifier),
@@ -262,7 +262,7 @@ mod tests {
             .expect_verify()
             .returning(|signer, _| Ok(SignerWithStake::from_signer(signer.to_owned(), 123)))
             .once();
-        let signer_registerer = MithrilSignerRegistererMaster::new(
+        let signer_registerer = MithrilSignerRegistrationMaster::new(
             verification_key_store.clone(),
             Arc::new(signer_recorder),
             Arc::new(signer_registration_verifier),
@@ -308,7 +308,7 @@ mod tests {
 
         let signer_recorder = MockSignerRecorder::new();
         let signer_registration_verifier = MockSignerRegistrationVerifier::new();
-        let signer_registerer = MithrilSignerRegistererMaster::new(
+        let signer_registerer = MithrilSignerRegistrationMaster::new(
             verification_key_store.clone(),
             Arc::new(signer_recorder),
             Arc::new(signer_registration_verifier),
@@ -332,7 +332,7 @@ mod tests {
 
         let signer_recorder = MockSignerRecorder::new();
         let signer_registration_verifier = MockSignerRegistrationVerifier::new();
-        let signer_registerer = MithrilSignerRegistererMaster::new(
+        let signer_registerer = MithrilSignerRegistrationMaster::new(
             verification_key_store.clone(),
             Arc::new(signer_recorder),
             Arc::new(signer_registration_verifier),
@@ -365,7 +365,7 @@ mod tests {
             .returning(|_| Ok(()));
         let signer_registration_verifier = MockSignerRegistrationVerifier::new();
 
-        let signer_registerer = MithrilSignerRegistererMaster::new(
+        let signer_registerer = MithrilSignerRegistrationMaster::new(
             Arc::new(verification_key_store),
             Arc::new(MockSignerRecorder::new()),
             Arc::new(signer_registration_verifier),
@@ -386,7 +386,7 @@ mod tests {
             .never();
         let signer_registration_verifier = MockSignerRegistrationVerifier::new();
 
-        let signer_registerer = MithrilSignerRegistererMaster::new(
+        let signer_registerer = MithrilSignerRegistrationMaster::new(
             Arc::new(verification_key_store),
             Arc::new(MockSignerRecorder::new()),
             Arc::new(signer_registration_verifier),

mithril-aggregator/src/signer_registration/mod.rs

@@ -1,5 +1,5 @@
 mod api;
-mod errors;
+mod error;
 mod master;
 mod slave;
 mod verifier;
@@ -8,9 +8,9 @@ pub use api::{
     SignerRecorder, SignerRegisterer, SignerRegistrationRound, SignerRegistrationRoundOpener,
     SignerRegistrationVerifier, SignerSynchronizer,
 };
-pub use errors::SignerRegistrationError;
-pub use master::MithrilSignerRegistererMaster;
-pub use slave::MithrilSignerRegistererSlave;
+pub use error::SignerRegistrationError;
+pub use master::MithrilSignerRegistrationMaster;
+pub use slave::MithrilSignerRegistrationSlave;
 pub use verifier::MithrilSignerRegistrationVerifier;
 
 #[cfg(test)]