refactor: rename CardanoDatabase to CardanoDatabaseSnapshot and documentation enhancements

Author: dlachaume

mithril-aggregator/src/artifact_builder/cardano_database.rs

@@ -6,8 +6,8 @@ use semver::Version;
 
 use mithril_common::{
     entities::{
-        ArtifactsLocations, CardanoDatabase, CardanoDbBeacon, Certificate, CompressionAlgorithm,
-        ProtocolMessagePartKey, SignedEntityType,
+        ArtifactsLocations, CardanoDatabaseSnapshot, CardanoDbBeacon, Certificate,
+        CompressionAlgorithm, ProtocolMessagePartKey, SignedEntityType,
     },
     StdResult,
 };
@@ -35,12 +35,12 @@ impl CardanoDatabaseArtifactBuilder {
 }
 
 #[async_trait]
-impl ArtifactBuilder<CardanoDbBeacon, CardanoDatabase> for CardanoDatabaseArtifactBuilder {
+impl ArtifactBuilder<CardanoDbBeacon, CardanoDatabaseSnapshot> for CardanoDatabaseArtifactBuilder {
     async fn compute_artifact(
         &self,
         beacon: CardanoDbBeacon,
         certificate: &Certificate,
-    ) -> StdResult<CardanoDatabase> {
+    ) -> StdResult<CardanoDatabaseSnapshot> {
         let merkle_root = certificate
             .protocol_message
             .get_message_part(&ProtocolMessagePartKey::CardanoDatabaseMerkleRoot)
@@ -55,7 +55,7 @@ impl ArtifactBuilder<CardanoDbBeacon, CardanoDatabase> for CardanoDatabaseArtifa
             })?;
         let total_db_size_uncompressed = compute_uncompressed_database_size(&self.db_directory)?;
 
-        let cardano_database = CardanoDatabase::new(
+        let cardano_database = CardanoDatabaseSnapshot::new(
             merkle_root.to_string(),
             beacon,
             total_db_size_uncompressed,
@@ -195,12 +195,12 @@ mod tests {
             .await
             .unwrap();
 
-        let artifact_expected = CardanoDatabase::new(
+        let artifact_expected = CardanoDatabaseSnapshot::new(
             "merkleroot".to_string(),
             beacon,
             expected_total_size,
             ArtifactsLocations {
-                digests: vec![],
+                digest: vec![],
                 immutables: vec![],
                 ancillary: vec![],
             },

mithril-aggregator/src/services/signed_entity.rs

@@ -11,7 +11,7 @@ use tokio::task::JoinHandle;
 
 use mithril_common::{
     entities::{
-        BlockNumber, CardanoDatabase, CardanoDbBeacon, CardanoStakeDistribution,
+        BlockNumber, CardanoDatabaseSnapshot, CardanoDbBeacon, CardanoStakeDistribution,
         CardanoTransactionsSnapshot, Certificate, Epoch, MithrilStakeDistribution, SignedEntity,
         SignedEntityType, SignedEntityTypeDiscriminants, Snapshot,
     },
@@ -89,7 +89,8 @@ pub struct MithrilSignedEntityService {
     signed_entity_type_lock: Arc<SignedEntityTypeLock>,
     cardano_stake_distribution_artifact_builder:
         Arc<dyn ArtifactBuilder<Epoch, CardanoStakeDistribution>>,
-    cardano_database_artifact_builder: Arc<dyn ArtifactBuilder<CardanoDbBeacon, CardanoDatabase>>,
+    cardano_database_artifact_builder:
+        Arc<dyn ArtifactBuilder<CardanoDbBeacon, CardanoDatabaseSnapshot>>,
     metrics_service: Arc<MetricsService>,
     logger: Logger,
 }
@@ -104,7 +105,8 @@ pub struct SignedEntityServiceArtifactsDependencies {
         Arc<dyn ArtifactBuilder<BlockNumber, CardanoTransactionsSnapshot>>,
     cardano_stake_distribution_artifact_builder:
         Arc<dyn ArtifactBuilder<Epoch, CardanoStakeDistribution>>,
-    cardano_database_artifact_builder: Arc<dyn ArtifactBuilder<CardanoDbBeacon, CardanoDatabase>>,
+    cardano_database_artifact_builder:
+        Arc<dyn ArtifactBuilder<CardanoDbBeacon, CardanoDatabaseSnapshot>>,
 }
 
 impl SignedEntityServiceArtifactsDependencies {
@@ -123,7 +125,7 @@ impl SignedEntityServiceArtifactsDependencies {
             dyn ArtifactBuilder<Epoch, CardanoStakeDistribution>,
         >,
         cardano_database_artifact_builder: Arc<
-            dyn ArtifactBuilder<CardanoDbBeacon, CardanoDatabase>,
+            dyn ArtifactBuilder<CardanoDbBeacon, CardanoDatabaseSnapshot>,
         >,
     ) -> Self {
         Self {
@@ -523,7 +525,7 @@ mod tests {
         mock_cardano_stake_distribution_artifact_builder:
             MockArtifactBuilder<Epoch, CardanoStakeDistribution>,
         mock_cardano_database_artifact_builder:
-            MockArtifactBuilder<CardanoDbBeacon, CardanoDatabase>,
+            MockArtifactBuilder<CardanoDbBeacon, CardanoDatabaseSnapshot>,
     }
 
     impl MockDependencyInjector {
@@ -548,7 +550,7 @@ mod tests {
                 >::new(),
                 mock_cardano_database_artifact_builder: MockArtifactBuilder::<
                     CardanoDbBeacon,
-                    CardanoDatabase,
+                    CardanoDatabaseSnapshot,
                 >::new(),
             }
         }
@@ -845,7 +847,7 @@ mod tests {
     async fn build_cardano_database_artifact_when_given_cardano_database_entity_type() {
         let mut mock_container = MockDependencyInjector::new();
 
-        let cardano_database_expected = fake_data::cardano_database_entities(1)
+        let cardano_database_expected = fake_data::cardano_database_snapshots(1)
             .first()
             .unwrap()
             .to_owned();
@@ -855,7 +857,7 @@ mod tests {
             .expect_compute_artifact()
             .times(1)
             .returning(|_, _| {
-                Ok(fake_data::cardano_database_entities(1)
+                Ok(fake_data::cardano_database_snapshots(1)
                     .first()
                     .unwrap()
                     .to_owned())
@@ -877,7 +879,7 @@ mod tests {
     async fn should_store_the_artifact_when_creating_artifact_for_a_cardano_database() {
         generic_test_that_the_artifact_is_stored(
             SignedEntityType::CardanoDatabase(CardanoDbBeacon::default()),
-            fake_data::cardano_database_entities(1)
+            fake_data::cardano_database_snapshots(1)
                 .first()
                 .unwrap()
                 .to_owned(),

mithril-common/src/entities/cardano_database.rs

@@ -6,30 +6,30 @@ use crate::{
     signable_builder::Artifact,
 };
 
-/// Cardano database incremental.
+/// Cardano database snapshot.
 #[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
-pub struct CardanoDatabase {
-    /// Merkle root of the Cardano database.
+pub struct CardanoDatabaseSnapshot {
+    /// Merkle root of the Cardano database snapshot.
     pub merkle_root: String,
 
     /// Mithril beacon on the Cardano chain.
     pub beacon: CardanoDbBeacon,
 
-    /// Size of the uncompressed Cardano database (including the ledger and volatile) in Bytes.
+    /// Size of the uncompressed Cardano database files.
     pub total_db_size_uncompressed: u64,
 
     /// Locations of the Cardano database artifacts.
     pub locations: ArtifactsLocations,
 
-    /// Compression algorithm of the Cardano database archives
+    /// Compression algorithm of the Cardano database artifacts.
     pub compression_algorithm: CompressionAlgorithm,
 
-    /// Version of the Cardano node used to create the archives.
+    /// Version of the Cardano node used to create the snapshot.
     pub cardano_node_version: String,
 }
 
-impl CardanoDatabase {
-    /// [CardanoDatabase] factory
+impl CardanoDatabaseSnapshot {
+    /// [CardanoDatabaseSnapshot] factory
     pub fn new(
         merkle_root: String,
         beacon: CardanoDbBeacon,
@@ -60,16 +60,16 @@ pub enum ArtifactLocation {
 /// Locations of the Cardano database related files.
 #[derive(Clone, Debug, Default, PartialEq, Eq, Serialize, Deserialize)]
 pub struct ArtifactsLocations {
-    /// Locations of the file containing the digests of the immutable files.
-    pub digests: Vec<ArtifactLocation>,
+    /// Locations of the the immutable file digests.
+    pub digest: Vec<ArtifactLocation>,
     /// Locations of the immutable files.
     pub immutables: Vec<ArtifactLocation>,
     /// Locations of the ancillary files (ledger and volatile).
     pub ancillary: Vec<ArtifactLocation>,
 }
 
 #[typetag::serde]
-impl Artifact for CardanoDatabase {
+impl Artifact for CardanoDatabaseSnapshot {
     fn get_id(&self) -> String {
         self.merkle_root.clone()
     }

mithril-common/src/entities/mod.rs

@@ -33,7 +33,7 @@ mod type_alias;
 pub use block_number::BlockNumber;
 pub use block_range::{BlockRange, BlockRangeLength, BlockRangesSequence};
 pub use cardano_chain_point::{BlockHash, ChainPoint};
-pub use cardano_database::{ArtifactsLocations, CardanoDatabase};
+pub use cardano_database::{ArtifactsLocations, CardanoDatabaseSnapshot};
 pub use cardano_db_beacon::CardanoDbBeacon;
 pub use cardano_network::CardanoNetwork;
 pub use cardano_stake_distribution::CardanoStakeDistribution;

mithril-common/src/test_utils/fake_data.rs

@@ -278,8 +278,8 @@ pub fn cardano_stake_distribution(epoch: Epoch) -> entities::CardanoStakeDistrib
     }
 }
 
-/// Fake Cardano Database entities
-pub fn cardano_database_entities(total: u64) -> Vec<entities::CardanoDatabase> {
+/// Fake Cardano Database snapshots
+pub fn cardano_database_snapshots(total: u64) -> Vec<entities::CardanoDatabaseSnapshot> {
     (1..total + 1)
         .map(|cardano_database_id| {
             let merkle_root = format!("1{cardano_database_id}").repeat(20);
@@ -289,7 +289,7 @@ pub fn cardano_database_entities(total: u64) -> Vec<entities::CardanoDatabase> {
             let cardano_node_version = Version::parse("1.0.0").unwrap();
             let locations = ArtifactsLocations::default();
 
-            entities::CardanoDatabase::new(
+            entities::CardanoDatabaseSnapshot::new(
                 merkle_root,
                 beacon,
                 total_db_size_uncompressed,
@@ -298,5 +298,5 @@ pub fn cardano_database_entities(total: u64) -> Vec<entities::CardanoDatabase> {
                 &cardano_node_version,
             )
         })
-        .collect::<Vec<entities::CardanoDatabase>>()
+        .collect::<Vec<entities::CardanoDatabaseSnapshot>>()
 }