refactor(signer): rename AggregatorClient to SignersRegistrationRetriever

Author: Alenar

mithril-signer/src/dependency_injection/builder.rs

@@ -513,7 +513,6 @@ impl<'a> DependenciesBuilder<'a> {
 
         let services = SignerDependencyContainer {
             ticker_service,
-            certificate_handler: aggregator_client.clone(),
             chain_observer,
             digester,
             single_signer,
@@ -529,7 +528,8 @@ impl<'a> DependenciesBuilder<'a> {
             upkeep_service,
             epoch_service,
             certifier,
-            signer_registration_publisher: aggregator_client,
+            signer_registration_publisher: aggregator_client.clone(),
+            signers_registration_retriever: aggregator_client,
             kes_signer,
             network_configuration_service,
         };

mithril-signer/src/dependency_injection/containers.rs

@@ -16,13 +16,12 @@ use mithril_ticker::TickerService;
 
 use crate::MetricsService;
 use crate::services::{
-    AggregatorClient, CertifierService, EpochService, SignerRegistrationPublisher, SingleSigner,
-    UpkeepService,
+    CertifierService, EpochService, SignerRegistrationPublisher, SignersRegistrationRetriever,
+    SingleSigner, UpkeepService,
 };
 use crate::store::ProtocolInitializerStorer;
 
 type StakeStoreService = Arc<dyn StakeStorer>;
-type CertificateHandlerService = Arc<dyn AggregatorClient>;
 type ChainObserverService = Arc<dyn ChainObserver>;
 type DigesterService = Arc<dyn ImmutableDigester>;
 type SingleSignerService = Arc<dyn SingleSigner>;
@@ -41,9 +40,6 @@ pub struct SignerDependencyContainer {
     /// Stake store service
     pub stake_store: StakeStoreService,
 
-    /// Certificate handler service
-    pub certificate_handler: CertificateHandlerService,
-
     /// Chain Observer service
     pub chain_observer: ChainObserverService,
 
@@ -89,6 +85,9 @@ pub struct SignerDependencyContainer {
     /// Signer registration publisher
     pub signer_registration_publisher: Arc<dyn SignerRegistrationPublisher>,
 
+    /// Signers registration retriever
+    pub signers_registration_retriever: Arc<dyn SignersRegistrationRetriever>,
+
     /// Kes signer service
     pub kes_signer: Option<Arc<dyn KesSigner>>,
 

mithril-signer/src/runtime/runner.rs

@@ -135,7 +135,7 @@ impl Runner for SignerRunner {
         debug!(self.logger, ">> get_epoch_settings");
 
         self.services
-            .certificate_handler
+            .signers_registration_retriever
             .retrieve_all_signer_registrations()
             .await
     }
@@ -417,7 +417,7 @@ mod tests {
     use crate::database::test_helper::main_db_connection;
     use crate::metrics::MetricsService;
     use crate::services::{
-        CardanoTransactionsImporter, DumbAggregatorClient, MithrilEpochService,
+        CardanoTransactionsImporter, DumbSignersRegistrationRetriever, MithrilEpochService,
         MithrilSingleSigner, MockTransactionStore, MockUpkeepService, SignaturePublisherNoop,
         SignerCertifierService, SignerSignableSeedBuilder, SignerSignedEntityConfigProvider,
         SpySignerRegistrationPublisher,
@@ -550,7 +550,6 @@ mod tests {
             Arc::new(CardanoTransactionsPreloaderActivation::new(true)),
         ));
         let upkeep_service = Arc::new(MockUpkeepService::new());
-        let aggregator_client = Arc::new(DumbAggregatorClient::default());
         let certifier = Arc::new(SignerCertifierService::new(
             Arc::new(SignedBeaconRepository::new(sqlite_connection.clone(), None)),
             Arc::new(SignerSignedEntityConfigProvider::new(epoch_service.clone())),
@@ -573,7 +572,6 @@ mod tests {
 
         SignerDependencyContainer {
             stake_store,
-            certificate_handler: aggregator_client,
             chain_observer,
             digester,
             single_signer,
@@ -590,6 +588,7 @@ mod tests {
             epoch_service,
             certifier,
             signer_registration_publisher: Arc::new(SpySignerRegistrationPublisher::default()),
+            signers_registration_retriever: Arc::new(DumbSignersRegistrationRetriever::default()),
             kes_signer,
             network_configuration_service,
         }
@@ -776,10 +775,7 @@ mod tests {
 
     #[tokio::test]
     async fn test_inform_epoch_setting_pass_available_signed_entity_types_to_epoch_service() {
-        let mut services = init_services().await;
-        let certificate_handler = Arc::new(DumbAggregatorClient::default());
-
-        services.certificate_handler = certificate_handler;
+        let services = init_services().await;
         let runner = init_runner(Some(services), None).await;
 
         let epoch = Epoch(1);

mithril-signer/src/services/mod.rs

@@ -9,24 +9,24 @@
 //!
 //! Each service is defined by a public API (a trait) that is used in the controllers (runtimes).
 
-mod aggregator_client;
 mod cardano_transactions;
 mod certifier;
 mod epoch_service;
 mod signable_builder;
 mod signature_publisher;
 mod signer_registration;
+mod signers_registration_retriever;
 mod single_signer;
 mod upkeep_service;
 
-#[cfg(test)]
-pub(crate) use aggregator_client::dumb::DumbAggregatorClient;
-pub use aggregator_client::*;
 pub use cardano_transactions::*;
 pub use certifier::*;
 pub use epoch_service::*;
 pub use signable_builder::*;
 pub use signature_publisher::*;
 pub use signer_registration::*;
+#[cfg(test)]
+pub(crate) use signers_registration_retriever::dumb::DumbSignersRegistrationRetriever;
+pub use signers_registration_retriever::*;
 pub use single_signer::*;
 pub use upkeep_service::*;

mithril-signer/src/services/aggregator_client.rs renamed to mithril-signer/src/services/signers_registration_retriever.rs

@@ -7,16 +7,16 @@ use mithril_common::{StdResult, messages::TryFromMessageAdapter};
 use crate::entities::RegisteredSigners;
 use crate::message_adapters::FromEpochSettingsAdapter;
 
-/// Trait for mocking and testing a `AggregatorClient`
+/// Service responsible for retrieving the signer's registration from the mithril network
 #[cfg_attr(test, mockall::automock)]
 #[async_trait]
-pub trait AggregatorClient: Sync + Send {
-    /// Retrieves epoch settings from the aggregator
+pub trait SignersRegistrationRetriever: Sync + Send {
+    /// Retrieves signer's registration from the mithril network
     async fn retrieve_all_signer_registrations(&self) -> StdResult<Option<RegisteredSigners>>;
 }
 
 #[async_trait]
-impl AggregatorClient for AggregatorHttpClient {
+impl SignersRegistrationRetriever for AggregatorHttpClient {
     async fn retrieve_all_signer_registrations(&self) -> StdResult<Option<RegisteredSigners>> {
         let message = self.send(GetEpochSettingsQuery::current()).await?;
         let epoch_settings = FromEpochSettingsAdapter::try_adapt(message)?;
@@ -32,14 +32,12 @@ pub(crate) mod dumb {
 
     use super::*;
 
-    /// This aggregator client is intended to be used by test services.
-    /// It actually does not communicate with an aggregator host but mimics this behavior.
-    /// It is driven by a Tester that controls the data it can return, and it can return its internal state for testing.
-    pub struct DumbAggregatorClient {
+    /// Dumb `SignersRegistrationRetriever` implementation for testing
+    pub struct DumbSignersRegistrationRetriever {
         epoch_settings: RwLock<Option<RegisteredSigners>>,
     }
 
-    impl Default for DumbAggregatorClient {
+    impl Default for DumbSignersRegistrationRetriever {
         fn default() -> Self {
             Self {
                 epoch_settings: RwLock::new(Some(RegisteredSigners::dummy())),
@@ -48,7 +46,7 @@ pub(crate) mod dumb {
     }
 
     #[async_trait]
-    impl AggregatorClient for DumbAggregatorClient {
+    impl SignersRegistrationRetriever for DumbSignersRegistrationRetriever {
         async fn retrieve_all_signer_registrations(&self) -> StdResult<Option<RegisteredSigners>> {
             let epoch_settings = self.epoch_settings.read().await.clone();
 

mithril-signer/tests/test_extensions/certificate_handler.rs

@@ -10,7 +10,7 @@ use mithril_common::{
 use mithril_ticker::{MithrilTickerService, TickerService};
 
 use mithril_signer::services::{SignaturePublisher, SignerRegistrationPublisher};
-use mithril_signer::{entities::RegisteredSigners, services::AggregatorClient};
+use mithril_signer::{entities::RegisteredSigners, services::SignersRegistrationRetriever};
 
 pub struct FakeAggregator {
     registered_signers: RwLock<HashMap<Epoch, Vec<Signer>>>,
@@ -88,7 +88,7 @@ impl SignerRegistrationPublisher for FakeAggregator {
 }
 
 #[async_trait]
-impl AggregatorClient for FakeAggregator {
+impl SignersRegistrationRetriever for FakeAggregator {
     async fn retrieve_all_signer_registrations(&self) -> StdResult<Option<RegisteredSigners>> {
         if *self.withhold_epoch_settings.read().await {
             Ok(None)

mithril-signer/tests/test_extensions/state_machine_tester.rs

@@ -315,7 +315,7 @@ impl StateMachineTester {
         )) as Arc<dyn KesSigner>);
 
         let services = SignerDependencyContainer {
-            certificate_handler: certificate_handler.clone(),
+            signers_registration_retriever: certificate_handler.clone(),
             ticker_service: ticker_service.clone(),
             chain_observer: chain_observer.clone(),
             digester: digester.clone(),