refacto: remove entities dependency to signable_builder

sfauvel · sfauvel · commit 7ae9a6cd9024 · 2025-02-04T17:02:58.000+01:00
Move `signed_entity` to `signable_builder` module.
Move `Beacon` and `Artifact` implementations in `signable_builder` module.
diff --git a/mithril-aggregator/src/database/record/signed_entity.rs b/mithril-aggregator/src/database/record/signed_entity.rs
@@ -3,8 +3,7 @@ use serde::{Deserialize, Serialize};
 
 use mithril_common::crypto_helper::ProtocolParameters;
 use mithril_common::entities::{
-    BlockNumber, CardanoDatabaseSnapshot, Epoch, SignedEntity, SignedEntityType, Snapshot,
-    StakeDistribution,
+    BlockNumber, CardanoDatabaseSnapshot, Epoch, SignedEntityType, Snapshot, StakeDistribution,
 };
 #[cfg(test)]
 use mithril_common::entities::{CardanoStakeDistribution, MithrilStakeDistribution};
@@ -15,7 +14,7 @@ use mithril_common::messages::{
     MithrilStakeDistributionListItemMessage, MithrilStakeDistributionMessage,
     SignerWithStakeMessagePart, SnapshotListItemMessage, SnapshotMessage,
 };
-use mithril_common::signable_builder::Artifact;
+use mithril_common::signable_builder::{Artifact, SignedEntity};
 use mithril_common::StdError;
 use mithril_persistence::database::Hydrator;
 use mithril_persistence::sqlite::{HydrationError, Projection, SqLiteEntity};
diff --git a/mithril-aggregator/src/database/repository/signed_entity_store.rs b/mithril-aggregator/src/database/repository/signed_entity_store.rs
@@ -165,7 +165,8 @@ impl SignedEntityStorer for SignedEntityStore {
 #[cfg(test)]
 mod tests {
     use mithril_common::{
-        entities::{Epoch, MithrilStakeDistribution, SignedEntity, Snapshot},
+        entities::{Epoch, MithrilStakeDistribution, Snapshot},
+        signable_builder::SignedEntity,
         test_utils::fake_data,
     };
 
diff --git a/mithril-aggregator/src/http_server/routes/artifact_routes/mod.rs b/mithril-aggregator/src/http_server/routes/artifact_routes/mod.rs
@@ -7,8 +7,8 @@ pub mod snapshot;
 #[cfg(test)]
 pub mod test_utils {
     use chrono::{DateTime, Utc};
-    use mithril_common::entities::{SignedEntity, SignedEntityType};
-    use mithril_common::signable_builder::Artifact;
+    use mithril_common::entities::SignedEntityType;
+    use mithril_common::signable_builder::{Artifact, SignedEntity};
 
     pub fn create_signed_entity<T>(
         signed_entity_type: SignedEntityType,
diff --git a/mithril-aggregator/src/http_server/routes/proof_routes.rs b/mithril-aggregator/src/http_server/routes/proof_routes.rs
@@ -48,9 +48,8 @@ fn proof_cardano_transaction(
 
 mod handlers {
     use mithril_common::{
-        entities::{CardanoTransactionsSnapshot, SignedEntity},
-        messages::CardanoTransactionsProofsMessage,
-        StdResult,
+        entities::CardanoTransactionsSnapshot, messages::CardanoTransactionsProofsMessage,
+        signable_builder::SignedEntity, StdResult,
     };
     use slog::{debug, warn, Logger};
     use std::{convert::Infallible, sync::Arc};
@@ -148,9 +147,8 @@ mod tests {
     };
 
     use mithril_common::{
-        entities::{
-            BlockNumber, CardanoTransactionsSetProof, CardanoTransactionsSnapshot, SignedEntity,
-        },
+        entities::{BlockNumber, CardanoTransactionsSetProof, CardanoTransactionsSnapshot},
+        signable_builder::SignedEntity,
         test_utils::{apispec::APISpec, assert_equivalent, fake_data},
     };
 
diff --git a/mithril-aggregator/src/message_adapters/to_cardano_transactions_proof_message.rs b/mithril-aggregator/src/message_adapters/to_cardano_transactions_proof_message.rs
@@ -1,8 +1,7 @@
-use mithril_common::entities::{CardanoTransactionsSnapshot, SignedEntity};
-use mithril_common::messages::CardanoTransactionsSetProofMessagePart;
 use mithril_common::{
-    entities::{CardanoTransactionsSetProof, TransactionHash},
-    messages::CardanoTransactionsProofsMessage,
+    entities::{CardanoTransactionsSetProof, CardanoTransactionsSnapshot, TransactionHash},
+    messages::{CardanoTransactionsProofsMessage, CardanoTransactionsSetProofMessagePart},
+    signable_builder::SignedEntity,
     StdResult,
 };
 
diff --git a/mithril-aggregator/src/services/signed_entity.rs b/mithril-aggregator/src/services/signed_entity.rs
@@ -12,11 +12,11 @@ use tokio::task::JoinHandle;
 use mithril_common::{
     entities::{
         BlockNumber, CardanoDatabaseSnapshot, CardanoDbBeacon, CardanoStakeDistribution,
-        CardanoTransactionsSnapshot, Certificate, Epoch, MithrilStakeDistribution, SignedEntity,
+        CardanoTransactionsSnapshot, Certificate, Epoch, MithrilStakeDistribution,
         SignedEntityType, SignedEntityTypeDiscriminants, Snapshot,
     },
     logging::LoggerExtensions,
-    signable_builder::Artifact,
+    signable_builder::{Artifact, SignedEntity},
     signed_entity_type_lock::SignedEntityTypeLock,
     StdResult,
 };
diff --git a/mithril-aggregator/tests/test_extensions/aggregator_observer.rs b/mithril-aggregator/tests/test_extensions/aggregator_observer.rs
@@ -4,9 +4,12 @@ use mithril_aggregator::{
     entities::OpenMessage,
     services::{CertifierService, SignedEntityService},
 };
-use mithril_common::entities::{CardanoTransactionsSnapshot, Certificate, SignedEntity};
 use mithril_common::{
-    entities::{Epoch, SignedEntityType, SignedEntityTypeDiscriminants, TimePoint},
+    entities::{
+        CardanoTransactionsSnapshot, Certificate, Epoch, SignedEntityType,
+        SignedEntityTypeDiscriminants, TimePoint,
+    },
+    signable_builder::SignedEntity,
     StdResult, TickerService,
 };
 use std::sync::Arc;
diff --git a/mithril-common/src/entities/block_number.rs b/mithril-common/src/entities/block_number.rs
@@ -8,7 +8,6 @@ use crate::entities::arithmetic_operation_wrapper::{
     impl_add_to_wrapper, impl_div_to_wrapper, impl_mul_to_wrapper, impl_partial_eq_to_wrapper,
     impl_rem_to_wrapper, impl_sub_to_wrapper,
 };
-use crate::signable_builder::Beacon;
 
 #[cfg(target_family = "wasm")]
 use wasm_bindgen::prelude::*;
@@ -20,8 +19,6 @@ use wasm_bindgen::prelude::*;
 #[cfg_attr(target_family = "wasm", wasm_bindgen)]
 pub struct BlockNumber(pub u64);
 
-impl Beacon for BlockNumber {}
-
 impl Display for BlockNumber {
     fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
         write!(f, "{}", self.0)
diff --git a/mithril-common/src/entities/cardano_database.rs b/mithril-common/src/entities/cardano_database.rs
@@ -2,10 +2,7 @@ use semver::Version;
 use serde::{Deserialize, Serialize};
 use sha2::{Digest, Sha256};
 
-use crate::{
-    entities::{CardanoDbBeacon, CompressionAlgorithm},
-    signable_builder::Artifact,
-};
+use crate::entities::{CardanoDbBeacon, CompressionAlgorithm};
 
 use super::MultiFilesUri;
 
@@ -120,13 +117,6 @@ pub struct ArtifactsLocations {
     pub ancillary: Vec<AncillaryLocation>,
 }
 
-#[typetag::serde]
-impl Artifact for CardanoDatabaseSnapshot {
-    fn get_id(&self) -> String {
-        self.hash.clone()
-    }
-}
-
 #[cfg(test)]
 mod tests {
     use super::*;
diff --git a/mithril-common/src/entities/cardano_db_beacon.rs b/mithril-common/src/entities/cardano_db_beacon.rs
@@ -3,7 +3,6 @@ use sha2::{Digest, Sha256};
 use std::fmt::{Display, Formatter};
 
 use crate::entities::{Epoch, ImmutableFileNumber};
-use crate::signable_builder::Beacon;
 
 /// A point in the Cardano chain at which a Mithril certificate of the Cardano Database should be
 /// produced.
@@ -16,8 +15,6 @@ pub struct CardanoDbBeacon {
     pub immutable_file_number: ImmutableFileNumber,
 }
 
-impl Beacon for CardanoDbBeacon {}
-
 impl Display for CardanoDbBeacon {
     fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
         write!(
diff --git a/mithril-common/src/entities/cardano_stake_distribution.rs b/mithril-common/src/entities/cardano_stake_distribution.rs
@@ -1,8 +1,6 @@
 use serde::{Deserialize, Serialize};
 use sha2::{Digest, Sha256};
 
-use crate::signable_builder::Artifact;
-
 use super::{Epoch, StakeDistribution};
 
 /// Cardano Stake Distribution
@@ -44,13 +42,6 @@ impl CardanoStakeDistribution {
     }
 }
 
-#[typetag::serde]
-impl Artifact for CardanoStakeDistribution {
-    fn get_id(&self) -> String {
-        self.hash.clone()
-    }
-}
-
 #[cfg(test)]
 mod tests {
     use super::*;
diff --git a/mithril-common/src/entities/cardano_transactions_snapshot.rs b/mithril-common/src/entities/cardano_transactions_snapshot.rs
@@ -1,8 +1,6 @@
 use serde::{Deserialize, Serialize};
 use sha2::{Digest, Sha256};
 
-use crate::signable_builder::Artifact;
-
 use super::BlockNumber;
 
 /// Snapshot of a set of Cardano transactions
@@ -40,13 +38,6 @@ impl CardanoTransactionsSnapshot {
     }
 }
 
-#[typetag::serde]
-impl Artifact for CardanoTransactionsSnapshot {
-    fn get_id(&self) -> String {
-        self.hash.clone()
-    }
-}
-
 #[cfg(test)]
 mod tests {
     use super::*;
diff --git a/mithril-common/src/entities/epoch.rs b/mithril-common/src/entities/epoch.rs
@@ -8,7 +8,6 @@ use thiserror::Error;
 use crate::entities::arithmetic_operation_wrapper::{
     impl_add_to_wrapper, impl_partial_eq_to_wrapper, impl_sub_to_wrapper,
 };
-use crate::signable_builder::Beacon as SignableBeacon;
 
 /// Epoch represents a Cardano epoch
 #[derive(
@@ -119,8 +118,6 @@ impl Display for Epoch {
     }
 }
 
-impl SignableBeacon for Epoch {}
-
 impl TryInto<i64> for Epoch {
     type Error = TryFromIntError;
 
diff --git a/mithril-common/src/entities/mithril_stake_distribution.rs b/mithril-common/src/entities/mithril_stake_distribution.rs
@@ -1,10 +1,7 @@
 use serde::{Deserialize, Serialize};
 use sha2::{Digest, Sha256};
 
-use crate::{
-    entities::{Epoch, SignerWithStake},
-    signable_builder::Artifact,
-};
+use crate::entities::{Epoch, SignerWithStake};
 
 use super::ProtocolParameters;
 
@@ -57,13 +54,6 @@ impl MithrilStakeDistribution {
     }
 }
 
-#[typetag::serde]
-impl Artifact for MithrilStakeDistribution {
-    fn get_id(&self) -> String {
-        self.hash.clone()
-    }
-}
-
 #[cfg(test)]
 mod tests {
     use crate::test_utils::{fake_data, MithrilFixtureBuilder};
diff --git a/mithril-common/src/entities/mod.rs b/mithril-common/src/entities/mod.rs
@@ -21,7 +21,6 @@ mod http_server_error;
 mod mithril_stake_distribution;
 mod protocol_message;
 mod protocol_parameters;
-mod signed_entity;
 mod signed_entity_config;
 mod signed_entity_type;
 mod signer;
@@ -54,7 +53,6 @@ pub use http_server_error::{ClientError, ServerError};
 pub use mithril_stake_distribution::MithrilStakeDistribution;
 pub use protocol_message::{ProtocolMessage, ProtocolMessagePartKey, ProtocolMessagePartValue};
 pub use protocol_parameters::ProtocolParameters;
-pub use signed_entity::*;
 pub use signed_entity_config::*;
 pub use signed_entity_type::*;
 pub use signer::{Signer, SignerWithStake};
diff --git a/mithril-common/src/entities/snapshot.rs b/mithril-common/src/entities/snapshot.rs
@@ -1,7 +1,4 @@
-use crate::{
-    entities::{CardanoDbBeacon, CompressionAlgorithm},
-    signable_builder::Artifact,
-};
+use crate::entities::{CardanoDbBeacon, CompressionAlgorithm};
 use semver::Version;
 use serde::{Deserialize, Serialize};
 
@@ -54,10 +51,3 @@ impl Snapshot {
         }
     }
 }
-
-#[typetag::serde]
-impl Artifact for Snapshot {
-    fn get_id(&self) -> String {
-        self.digest.clone()
-    }
-}
diff --git a/mithril-common/src/signable_builder/interface.rs b/mithril-common/src/signable_builder/interface.rs
@@ -2,7 +2,11 @@ use async_trait::async_trait;
 use std::fmt::Debug;
 
 use crate::{
-    entities::{ProtocolMessage, ProtocolMessagePartValue},
+    entities::{
+        BlockNumber, CardanoDatabaseSnapshot, CardanoDbBeacon, CardanoStakeDistribution,
+        CardanoTransactionsSnapshot, Epoch, MithrilStakeDistribution, ProtocolMessage,
+        ProtocolMessagePartValue, Snapshot,
+    },
     StdResult,
 };
 
@@ -43,3 +47,44 @@ pub trait SignableSeedBuilder: Send + Sync {
     /// Compute current epoch protocol message part value
     async fn compute_current_epoch(&self) -> StdResult<ProtocolMessagePartValue>;
 }
+
+impl Beacon for BlockNumber {}
+
+impl Beacon for CardanoDbBeacon {}
+
+impl Beacon for Epoch {}
+
+#[typetag::serde]
+impl Artifact for CardanoDatabaseSnapshot {
+    fn get_id(&self) -> String {
+        self.hash.clone()
+    }
+}
+
+#[typetag::serde]
+impl Artifact for CardanoStakeDistribution {
+    fn get_id(&self) -> String {
+        self.hash.clone()
+    }
+}
+
+#[typetag::serde]
+impl Artifact for CardanoTransactionsSnapshot {
+    fn get_id(&self) -> String {
+        self.hash.clone()
+    }
+}
+
+#[typetag::serde]
+impl Artifact for MithrilStakeDistribution {
+    fn get_id(&self) -> String {
+        self.hash.clone()
+    }
+}
+
+#[typetag::serde]
+impl Artifact for Snapshot {
+    fn get_id(&self) -> String {
+        self.digest.clone()
+    }
+}
diff --git a/mithril-common/src/signable_builder/mod.rs b/mithril-common/src/signable_builder/mod.rs
@@ -4,11 +4,13 @@ mod cardano_stake_distribution;
 mod interface;
 mod mithril_stake_distribution;
 mod signable_builder_service;
+mod signed_entity;
 
 pub use cardano_stake_distribution::*;
 pub use interface::*;
 pub use mithril_stake_distribution::*;
 pub use signable_builder_service::*;
+pub use signed_entity::*;
 
 cfg_fs! {
     mod cardano_database;
diff --git a/mithril-common/src/signable_builder/signed_entity.rs b/mithril-common/src/signable_builder/signed_entity.rs
@@ -1,15 +1,15 @@
 use chrono::{DateTime, Utc};
 
+use super::Artifact;
 use crate::entities::{
-    CardanoTransactionsSnapshot, MithrilStakeDistribution, SignedEntityType, Snapshot,
+    CardanoStakeDistribution, CardanoTransactionsSnapshot, MithrilStakeDistribution,
+    SignedEntityType, Snapshot,
 };
-use crate::signable_builder::Artifact;
 #[cfg(any(test, feature = "test_tools"))]
 use crate::test_utils::fake_data;
 
-use super::CardanoStakeDistribution;
 #[cfg(any(test, feature = "test_tools"))]
-use super::{CardanoDbBeacon, Epoch};
+use crate::entities::{CardanoDbBeacon, Epoch};
 
 /// Aggregate for signed entity
 #[derive(Debug, Clone)]
