refactor(signer): rename AggregatorClient::retrieve_epoch_settings to retrieve_all_signer_registrations

And `SignerEpochSettings` to `RegisteredSigners`

Author: Alenar

mithril-signer/src/entities/mod.rs

@@ -3,7 +3,7 @@
 //! This module provide domain entities for the services & state machine.
 
 mod beacon_to_sign;
-mod signer_epoch_settings;
+mod registered_signers;
 
 pub use beacon_to_sign::*;
-pub use signer_epoch_settings::*;
+pub use registered_signers::*;

mithril-signer/src/entities/signer_epoch_settings.rs renamed to mithril-signer/src/entities/registered_signers.rs

@@ -1,9 +1,9 @@
 use mithril_common::entities::{Epoch, Signer};
 
-/// SignerEpochSettings represents the settings of an epoch
+/// `RegisteredSigners` represents the registered signers of an epoch
 #[derive(Clone, Debug, PartialEq)]
-pub struct SignerEpochSettings {
-    /// Current Epoch
+pub struct RegisteredSigners {
+    /// Epoch for which those registrations are active.
     pub epoch: Epoch,
 
     /// Current Signers
@@ -14,9 +14,9 @@ pub struct SignerEpochSettings {
 }
 
 #[cfg(test)]
-impl mithril_common::test::double::Dummy for SignerEpochSettings {
-    /// Create a dummy `SignerEpochSettings`
-    fn dummy() -> SignerEpochSettings {
+impl mithril_common::test::double::Dummy for RegisteredSigners {
+    /// Create a dummy `RegisteredSigners`
+    fn dummy() -> RegisteredSigners {
         use mithril_common::test::double::fake_data;
 
         // Beacon
@@ -28,7 +28,7 @@ impl mithril_common::test::double::Dummy for SignerEpochSettings {
         let next_signers = signers[2..5].to_vec();
 
         // Signer Epoch settings
-        SignerEpochSettings {
+        RegisteredSigners {
             epoch: beacon.epoch,
             current_signers,
             next_signers,

mithril-signer/src/lib.rs

@@ -19,7 +19,7 @@ pub mod store;
 
 pub use commands::*;
 pub use configuration::{Configuration, DefaultConfiguration};
-pub use entities::SignerEpochSettings;
+pub use entities::RegisteredSigners;
 pub use message_adapters::{FromEpochSettingsAdapter, ToRegisterSignerMessageAdapter};
 pub use metrics::*;
 pub use runtime::*;

mithril-signer/src/message_adapters/from_epoch_settings.rs

@@ -4,15 +4,15 @@ use mithril_common::{
     messages::{EpochSettingsMessage, SignerMessagePart, TryFromMessageAdapter},
 };
 
-use crate::entities::SignerEpochSettings;
+use crate::entities::RegisteredSigners;
 
-/// Adapter to convert [EpochSettingsMessage] to [SignerEpochSettings].
+/// Adapter to convert [EpochSettingsMessage] to [RegisteredSigners].
 pub struct FromEpochSettingsAdapter;
 
-impl TryFromMessageAdapter<EpochSettingsMessage, SignerEpochSettings> for FromEpochSettingsAdapter {
+impl TryFromMessageAdapter<EpochSettingsMessage, RegisteredSigners> for FromEpochSettingsAdapter {
     /// Method to convert.
-    fn try_adapt(message: EpochSettingsMessage) -> StdResult<SignerEpochSettings> {
-        let epoch_settings = SignerEpochSettings {
+    fn try_adapt(message: EpochSettingsMessage) -> StdResult<RegisteredSigners> {
+        let epoch_settings = RegisteredSigners {
             epoch: message.epoch,
             current_signers: SignerMessagePart::try_into_signers(message.current_signers)
                 .with_context(|| "'FromMessageAdapter' can not convert the current signers")?,

mithril-signer/src/runtime/runner.rs

@@ -14,7 +14,7 @@ use mithril_protocol_config::model::MithrilNetworkConfiguration;
 
 use crate::Configuration;
 use crate::dependency_injection::SignerDependencyContainer;
-use crate::entities::{BeaconToSign, SignerEpochSettings};
+use crate::entities::{BeaconToSign, RegisteredSigners};
 use crate::services::{EpochService, MithrilProtocolInitializerBuilder};
 
 /// This trait is mainly intended for mocking.
@@ -29,7 +29,7 @@ pub trait Runner: Send + Sync {
     /// Fetch the current epoch settings if any.
     async fn get_signer_registrations_from_aggregator(
         &self,
-    ) -> StdResult<Option<SignerEpochSettings>>;
+    ) -> StdResult<Option<RegisteredSigners>>;
 
     /// Fetch the beacon to sign if any.
     async fn get_beacon_to_sign(&self, time_point: TimePoint) -> StdResult<Option<BeaconToSign>>;
@@ -131,10 +131,13 @@ impl Runner for SignerRunner {
 
     async fn get_signer_registrations_from_aggregator(
         &self,
-    ) -> StdResult<Option<SignerEpochSettings>> {
+    ) -> StdResult<Option<RegisteredSigners>> {
         debug!(self.logger, ">> get_epoch_settings");
 
-        self.services.certificate_handler.retrieve_epoch_settings().await
+        self.services
+            .certificate_handler
+            .retrieve_all_signer_registrations()
+            .await
     }
 
     async fn get_beacon_to_sign(&self, time_point: TimePoint) -> StdResult<Option<BeaconToSign>> {

mithril-signer/src/runtime/state_machine.rs

@@ -496,7 +496,7 @@ mod tests {
     use mithril_common::entities::{ChainPoint, Epoch, ProtocolMessage, SignedEntityType};
     use mithril_common::test::double::Dummy;
 
-    use crate::SignerEpochSettings;
+    use crate::RegisteredSigners;
     use crate::runtime::runner::MockSignerRunner;
     use crate::test_tools::TestLogger;
 
@@ -547,7 +547,7 @@ mod tests {
     #[tokio::test]
     async fn unregistered_epoch_settings_behind_known_epoch() {
         let mut runner = MockSignerRunner::new();
-        let epoch_settings = SignerEpochSettings {
+        let epoch_settings = RegisteredSigners {
             epoch: Epoch(3),
             current_signers: vec![],
             next_signers: vec![],
@@ -594,7 +594,7 @@ mod tests {
         runner
             .expect_get_signer_registrations_from_aggregator()
             .once()
-            .returning(|| Ok(Some(SignerEpochSettings::dummy())));
+            .returning(|| Ok(Some(RegisteredSigners::dummy())));
 
         runner
             .expect_get_mithril_network_configuration()
@@ -646,7 +646,7 @@ mod tests {
         runner
             .expect_get_signer_registrations_from_aggregator()
             .once()
-            .returning(|| Ok(Some(SignerEpochSettings::dummy())));
+            .returning(|| Ok(Some(RegisteredSigners::dummy())));
 
         runner
             .expect_get_mithril_network_configuration()
@@ -702,7 +702,7 @@ mod tests {
         runner
             .expect_get_signer_registrations_from_aggregator()
             .once()
-            .returning(|| Ok(Some(SignerEpochSettings::dummy())));
+            .returning(|| Ok(Some(RegisteredSigners::dummy())));
 
         runner
             .expect_get_mithril_network_configuration()

mithril-signer/src/services/aggregator_client.rs

@@ -4,20 +4,20 @@ use mithril_aggregator_client::AggregatorHttpClient;
 use mithril_aggregator_client::query::GetEpochSettingsQuery;
 use mithril_common::{StdResult, messages::TryFromMessageAdapter};
 
-use crate::entities::SignerEpochSettings;
+use crate::entities::RegisteredSigners;
 use crate::message_adapters::FromEpochSettingsAdapter;
 
 /// Trait for mocking and testing a `AggregatorClient`
 #[cfg_attr(test, mockall::automock)]
 #[async_trait]
 pub trait AggregatorClient: Sync + Send {
     /// Retrieves epoch settings from the aggregator
-    async fn retrieve_epoch_settings(&self) -> StdResult<Option<SignerEpochSettings>>;
+    async fn retrieve_all_signer_registrations(&self) -> StdResult<Option<RegisteredSigners>>;
 }
 
 #[async_trait]
 impl AggregatorClient for AggregatorHttpClient {
-    async fn retrieve_epoch_settings(&self) -> StdResult<Option<SignerEpochSettings>> {
+    async fn retrieve_all_signer_registrations(&self) -> StdResult<Option<RegisteredSigners>> {
         let message = self.send(GetEpochSettingsQuery::current()).await?;
         let epoch_settings = FromEpochSettingsAdapter::try_adapt(message)?;
 
@@ -36,20 +36,20 @@ pub(crate) mod dumb {
     /// 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 {
-        epoch_settings: RwLock<Option<SignerEpochSettings>>,
+        epoch_settings: RwLock<Option<RegisteredSigners>>,
     }
 
     impl Default for DumbAggregatorClient {
         fn default() -> Self {
             Self {
-                epoch_settings: RwLock::new(Some(SignerEpochSettings::dummy())),
+                epoch_settings: RwLock::new(Some(RegisteredSigners::dummy())),
             }
         }
     }
 
     #[async_trait]
     impl AggregatorClient for DumbAggregatorClient {
-        async fn retrieve_epoch_settings(&self) -> StdResult<Option<SignerEpochSettings>> {
+        async fn retrieve_all_signer_registrations(&self) -> StdResult<Option<RegisteredSigners>> {
             let epoch_settings = self.epoch_settings.read().await.clone();
 
             Ok(epoch_settings)

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::SignerEpochSettings, services::AggregatorClient};
+use mithril_signer::{entities::RegisteredSigners, services::AggregatorClient};
 
 pub struct FakeAggregator {
     registered_signers: RwLock<HashMap<Epoch, Vec<Signer>>>,
@@ -89,7 +89,7 @@ impl SignerRegistrationPublisher for FakeAggregator {
 
 #[async_trait]
 impl AggregatorClient for FakeAggregator {
-    async fn retrieve_epoch_settings(&self) -> StdResult<Option<SignerEpochSettings>> {
+    async fn retrieve_all_signer_registrations(&self) -> StdResult<Option<RegisteredSigners>> {
         if *self.withhold_epoch_settings.read().await {
             Ok(None)
         } else {
@@ -98,7 +98,7 @@ impl AggregatorClient for FakeAggregator {
             let current_signers = self.get_current_signers(&store).await?;
             let next_signers = self.get_next_signers(&store).await?;
 
-            Ok(Some(SignerEpochSettings {
+            Ok(Some(RegisteredSigners {
                 epoch: time_point.epoch,
                 current_signers,
                 next_signers,
@@ -183,7 +183,7 @@ mod tests {
             .await
             .expect("aggregator client should not fail while registering a user");
         let epoch_settings = fake_aggregator
-            .retrieve_epoch_settings()
+            .retrieve_all_signer_registrations()
             .await
             .expect("we should have a result, None found!")
             .expect("we should have an EpochSettings, None found!");
@@ -196,7 +196,7 @@ mod tests {
             .await
             .expect("aggregator client should not fail while registering a user");
         let epoch_settings = fake_aggregator
-            .retrieve_epoch_settings()
+            .retrieve_all_signer_registrations()
             .await
             .expect("we should have a result, None found!")
             .expect("we should have an EpochSettings, None found!");
@@ -210,7 +210,7 @@ mod tests {
             .await
             .expect("aggregator client should not fail while registering a user");
         let epoch_settings = fake_aggregator
-            .retrieve_epoch_settings()
+            .retrieve_all_signer_registrations()
             .await
             .expect("we should have a result, None found!")
             .expect("we should have an EpochSettings, None found!");