feat: implement 'get_current_chain_point' for FakeChainObserver

Author: jpraynaud

mithril-aggregator/src/tools/mocks.rs

@@ -1,7 +1,7 @@
 use async_trait::async_trait;
 use mithril_common::chain_observer::{ChainAddress, ChainObserver, ChainObserverError, TxDatum};
 use mithril_common::crypto_helper::{KESPeriod, OpCert};
-use mithril_common::entities::{Epoch, StakeDistribution};
+use mithril_common::entities::{ChainPoint, Epoch, StakeDistribution};
 use mockall::mock;
 
 mock! {
@@ -16,6 +16,8 @@ mock! {
 
         async fn get_current_epoch(&self) -> Result<Option<Epoch>, ChainObserverError>;
 
+        async fn get_current_chain_point(&self) -> Result<Option<ChainPoint>, ChainObserverError>;
+
         async fn get_current_stake_distribution(
             &self,
         ) -> Result<Option<StakeDistribution>, ChainObserverError>;

mithril-common/src/chain_observer/fake_observer.rs

@@ -18,6 +18,9 @@ pub struct FakeObserver {
     /// [get_current_epoch]: ChainObserver::get_current_epoch
     pub current_time_point: RwLock<Option<TimePoint>>,
 
+    /// The current chain point
+    pub current_chain_point: RwLock<Option<ChainPoint>>,
+
     /// A list of [TxDatum], used by [get_current_datums]
     ///
     /// [get_current_datums]: ChainObserver::get_current_datums
@@ -30,6 +33,7 @@ impl FakeObserver {
         Self {
             signers: RwLock::new(vec![]),
             current_time_point: RwLock::new(current_time_point),
+            current_chain_point: RwLock::new(None),
             datums: RwLock::new(vec![]),
         }
     }
@@ -52,6 +56,13 @@ impl FakeObserver {
         *signers = new_signers;
     }
 
+    /// Set the chain point that will use to compute the result of
+    /// [get_current_chain_point][ChainObserver::get_current_chain_point].
+    pub async fn set_current_chain_point(&self, new_current_chain_point: Option<ChainPoint>) {
+        let mut current_chain_point = self.current_chain_point.write().await;
+        *current_chain_point = new_current_chain_point;
+    }
+
     /// Set the datums that will use to compute the result of
     /// [get_current_datums][ChainObserver::get_current_datums].
     pub async fn set_datums(&self, new_datums: Vec<TxDatum>) {
@@ -88,6 +99,10 @@ impl ChainObserver for FakeObserver {
             .map(|time_point| time_point.epoch))
     }
 
+    async fn get_current_chain_point(&self) -> Result<Option<ChainPoint>, ChainObserverError> {
+        Ok(self.current_chain_point.read().await.clone())
+    }
+
     async fn get_current_stake_distribution(
         &self,
     ) -> Result<Option<StakeDistribution>, ChainObserverError> {
@@ -124,6 +139,21 @@ mod tests {
         assert_eq!(Some(time_point.epoch), current_epoch);
     }
 
+    #[tokio::test]
+    async fn test_get_current_chain_point() {
+        let fake_observer = FakeObserver::new(None);
+        fake_observer
+            .set_current_chain_point(Some(fake_data::chain_point()))
+            .await;
+        let chain_point = fake_observer.get_current_chain_point().await.unwrap();
+
+        assert_eq!(
+            Some(fake_data::chain_point()),
+            chain_point,
+            "get current chain point should not fail"
+        );
+    }
+
     #[tokio::test]
     async fn test_get_current_stake_distribution() {
         let fake_observer = FakeObserver::new(None);

mithril-common/src/test_utils/fake_data.rs

@@ -28,6 +28,15 @@ pub fn beacon() -> entities::CardanoDbBeacon {
     entities::CardanoDbBeacon::new(network, *time_point.epoch, time_point.immutable_file_number)
 }
 
+/// Fake ChainPoint
+pub fn chain_point() -> entities::ChainPoint {
+    entities::ChainPoint {
+        slot_number: 500,
+        block_number: 42,
+        block_hash: "1b69b3202fbe500".to_string(),
+    }
+}
+
 /// Fake Digest
 pub fn digest(beacon: &entities::CardanoDbBeacon) -> Vec<u8> {
     format!(

mithril-common/src/time_point_provider.rs

@@ -76,7 +76,7 @@ impl TimePointProvider for TimePointProviderImpl {
 mod tests {
     use crate::chain_observer::{ChainAddress, ChainObserver, ChainObserverError, TxDatum};
     use crate::digesters::DumbImmutableFileObserver;
-    use crate::entities::{Epoch, StakeDistribution};
+    use crate::entities::{ChainPoint, Epoch, StakeDistribution};
     use anyhow::anyhow;
 
     use super::*;
@@ -96,6 +96,14 @@ mod tests {
             Ok(Some(Epoch(42)))
         }
 
+        async fn get_current_chain_point(&self) -> Result<Option<ChainPoint>, ChainObserverError> {
+            Ok(Some(ChainPoint {
+                slot_number: 500,
+                block_number: 42,
+                block_hash: "1b69b3202fbe500".to_string(),
+            }))
+        }
+
         async fn get_current_stake_distribution(
             &self,
         ) -> Result<Option<StakeDistribution>, ChainObserverError> {