Merge pull request #711 from input-output-hk/ensemble/708-create-era-checker

Create Era Checker

Author: jpraynaud

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-aggregator"
-version = "0.2.11"
+version = "0.2.12"
 description = "A Mithril Aggregator server"
 authors = { workspace = true }
 edition = { workspace = true }

mithril-aggregator/Cargo.toml

@@ -15,6 +15,7 @@ use mithril_common::{
         CardanoImmutableDigester, ImmutableFileSystemObserver,
     },
     entities::{Epoch, HexEncodedGenesisSecretKey},
+    era::{EraChecker, SupportedEra},
     store::{adapter::SQLiteAdapter, StakeStore},
     BeaconProviderImpl,
 };
@@ -397,6 +398,10 @@ impl ServeCommand {
             ongoing_snapshot_directory,
         ));
 
+        // TODO: use EraReader when it is implemented to retrieve current era
+        let current_era = SupportedEra::Thales;
+        let era_checker = Arc::new(EraChecker::new(current_era));
+
         // Init dependency manager
         let dependency_manager = DependencyManager {
             config: config.clone(),
@@ -418,6 +423,7 @@ impl ServeCommand {
             genesis_verifier,
             signer_registerer: signer_registerer.clone(),
             signer_registration_round_opener: signer_registerer.clone(),
+            era_checker: era_checker.clone(),
         };
         let dependency_manager = Arc::new(dependency_manager);
 

mithril-aggregator/src/command_args.rs

@@ -1,15 +1,17 @@
-use mithril_common::certificate_chain::CertificateVerifier;
-use mithril_common::chain_observer::ChainObserver;
-use mithril_common::crypto_helper::ProtocolGenesisVerifier;
-use mithril_common::digesters::{ImmutableDigester, ImmutableFileObserver};
-use mithril_common::entities::{
-    Certificate, Epoch, ProtocolParameters, Signer, SignerWithStake, StakeDistribution,
+use mithril_common::{
+    certificate_chain::CertificateVerifier,
+    chain_observer::ChainObserver,
+    crypto_helper::ProtocolGenesisVerifier,
+    digesters::{ImmutableDigester, ImmutableFileObserver},
+    entities::{
+        Certificate, Epoch, ProtocolParameters, Signer, SignerWithStake, StakeDistribution,
+    },
+    era::EraChecker,
+    store::{StakeStore, StakeStorer},
+    BeaconProvider,
 };
-use mithril_common::store::{StakeStore, StakeStorer};
-use mithril_common::BeaconProvider;
 
-use std::collections::HashMap;
-use std::sync::Arc;
+use std::{collections::HashMap, sync::Arc};
 use tokio::sync::RwLock;
 
 use crate::multi_signer::MultiSigner;
@@ -82,6 +84,9 @@ pub struct DependencyManager {
 
     /// Signer registration round opener service
     pub signer_registration_round_opener: Arc<dyn SignerRegistrationRoundOpener>,
+
+    /// Era checker service
+    pub era_checker: Arc<EraChecker>,
 }
 
 #[doc(hidden)]
@@ -264,6 +269,7 @@ pub mod tests {
         chain_observer::FakeObserver,
         crypto_helper::{key_encode_hex, ProtocolGenesisSigner},
         digesters::{DumbImmutableDigester, DumbImmutableFileObserver},
+        era::{EraChecker, SupportedEra},
         store::{adapter::MemoryAdapter, StakeStore},
         test_utils::fake_data,
         BeaconProviderImpl, CardanoNetwork,
@@ -341,6 +347,7 @@ pub mod tests {
             chain_observer.clone(),
             verification_key_store.clone(),
         ));
+        let era_checker = Arc::new(EraChecker::new(SupportedEra::dummy()));
 
         let dependency_manager = DependencyManager {
             config,
@@ -362,6 +369,7 @@ pub mod tests {
             genesis_verifier,
             signer_registerer: signer_registerer.clone(),
             signer_registration_round_opener: signer_registerer,
+            era_checker,
         };
 
         let config = AggregatorConfig::new(

mithril-aggregator/src/dependency.rs

@@ -9,6 +9,7 @@ use mithril_common::chain_observer::FakeObserver;
 use mithril_common::crypto_helper::{key_encode_hex, ProtocolGenesisSigner};
 use mithril_common::digesters::{DumbImmutableDigester, DumbImmutableFileObserver};
 use mithril_common::entities::ProtocolParameters;
+use mithril_common::era::{EraChecker, SupportedEra};
 use mithril_common::store::adapter::MemoryAdapter;
 use mithril_common::store::StakeStore;
 use mithril_common::{BeaconProviderImpl, CardanoNetwork};
@@ -90,6 +91,7 @@ pub async fn initialize_dependencies(
         chain_observer.clone(),
         verification_key_store.clone(),
     ));
+    let era_checker = Arc::new(EraChecker::new(SupportedEra::dummy()));
 
     let dependency_manager = DependencyManager {
         config,
@@ -111,6 +113,7 @@ pub async fn initialize_dependencies(
         genesis_verifier,
         signer_registerer: signer_registerer.clone(),
         signer_registration_round_opener: signer_registerer,
+        era_checker,
     };
 
     let config = AggregatorConfig::new(

mithril-aggregator/tests/test_extensions/dependency.rs

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-common"
-version = "0.2.10"
+version = "0.2.11"
 authors = { workspace = true }
 edition = { workspace = true }
 documentation = { workspace = true }

mithril-common/Cargo.toml

@@ -0,0 +1,54 @@
+use std::sync::RwLock;
+
+use super::SupportedEra;
+
+/// EraChecker allows the verification of the current era
+pub struct EraChecker {
+    current_era: RwLock<SupportedEra>,
+}
+
+impl EraChecker {
+    /// Era checker factory
+    pub fn new(era: SupportedEra) -> Self {
+        Self {
+            current_era: RwLock::new(era),
+        }
+    }
+
+    /// Retrieve the current era
+    pub fn current_era(&self) -> SupportedEra {
+        self.current_era.read().unwrap().to_owned()
+    }
+
+    /// Change the current era
+    pub fn change_era(&self, new_era: SupportedEra) {
+        let mut era = self.current_era.write().unwrap();
+        *era = new_era;
+    }
+
+    /// Check if an era is active
+    pub fn is_era_active(&self, era: SupportedEra) -> bool {
+        self.current_era() == era
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn can_change_era() {
+        let expected_era = SupportedEra::dummy();
+        let era_checker = EraChecker::new(expected_era);
+        era_checker.change_era(expected_era);
+
+        assert_eq!(expected_era, era_checker.current_era());
+    }
+
+    #[test]
+    fn is_era_active_panics_when_current_era_not_set() {
+        let expected_era = SupportedEra::dummy();
+        let era_checker = EraChecker::new(expected_era);
+        era_checker.is_era_active(expected_era);
+    }
+}

mithril-common/src/era/era_checker.rs

@@ -0,0 +1,7 @@
+//! The module used for handling eras
+
+mod era_checker;
+mod supported_era;
+
+pub use era_checker::EraChecker;
+pub use supported_era::SupportedEra;

mithril-common/src/era/mod.rs

@@ -0,0 +1,14 @@
+/// The era that the software is running or will run
+#[derive(Debug, Clone, Copy, PartialEq, Eq)]
+pub enum SupportedEra {
+    /// Thales era
+    Thales,
+}
+
+impl SupportedEra {
+    /// Retrieve a dummy era (for test only)
+    #[cfg(any(test, feature = "test_only"))]
+    pub fn dummy() -> Self {
+        Self::Thales
+    }
+}

mithril-common/src/era/supported_era.rs

@@ -17,6 +17,7 @@ pub mod crypto_helper;
 pub mod database;
 pub mod digesters;
 pub mod entities;
+pub mod era;
 pub mod messages;
 pub mod sqlite;
 pub mod store;