Add MessageAdapter trait

Implement for Cardano Immutable Files Snapshot and Mithril Stake Distribution.
Adapt artifact builder implementations.

Author: jpraynaud

mithril-aggregator/src/artifact_builder/artifact_builder_service.rs

@@ -4,7 +4,7 @@ use slog_scope::info;
 use std::sync::Arc;
 
 use mithril_common::{
-    entities::{Beacon, Certificate, Epoch, SignedEntityType, Snapshot},
+    entities::{Beacon, Certificate, Epoch, MithrilStakeDistribution, SignedEntityType, Snapshot},
     signable_builder::Artifact,
     StdResult,
 };
@@ -14,8 +14,6 @@ use crate::{
     database::provider::{SignedEntityRecord, SignedEntityStorer},
 };
 
-use super::MithrilStakeDistribution;
-
 #[cfg(test)]
 use mockall::automock;
 

mithril-aggregator/src/artifact_builder/mithril_stake_distribution.rs

@@ -1,73 +1,14 @@
 use async_trait::async_trait;
-use serde::{Deserialize, Serialize};
-use sha2::{Digest, Sha256};
 use std::sync::Arc;
 use tokio::sync::RwLock;
 
 use super::ArtifactBuilder;
 use crate::MultiSigner;
 use mithril_common::{
-    entities::{Certificate, Epoch, SignerWithStake},
-    signable_builder::Artifact,
+    entities::{Certificate, Epoch, MithrilStakeDistribution},
     StdResult,
 };
 
-/// Mithril Stake Distribution
-#[derive(Debug, PartialEq, Serialize, Deserialize, Clone)]
-pub struct MithrilStakeDistribution {
-    epoch: Epoch,
-    signers_with_stake: Vec<SignerWithStake>,
-    hash: String,
-}
-
-impl MithrilStakeDistribution {
-    /// MithrilStakeDistribution artifact factory
-    pub fn new(epoch: Epoch, signers_with_stake: Vec<SignerWithStake>) -> Self {
-        let mut signers_with_stake_sorted = signers_with_stake;
-        signers_with_stake_sorted.sort();
-        let mut mithril_stake_distribution = Self {
-            epoch,
-            signers_with_stake: signers_with_stake_sorted,
-            hash: "".to_string(),
-        };
-        mithril_stake_distribution.hash = mithril_stake_distribution.compute_hash();
-        mithril_stake_distribution
-    }
-
-    fn compute_hash(&self) -> String {
-        let mut hasher = Sha256::new();
-        hasher.update(self.epoch.0.to_be_bytes());
-        for signer_with_stake in &self.signers_with_stake {
-            hasher.update(signer_with_stake.compute_hash().as_bytes());
-        }
-        hex::encode(hasher.finalize())
-    }
-}
-
-#[typetag::serde]
-impl Artifact for MithrilStakeDistribution {
-    fn get_id(&self) -> String {
-        self.hash.clone()
-    }
-}
-
-/// Mithril Stake Distribution Summary
-// TODO: This type should probably be listed in the common entities?
-#[derive(Debug, PartialEq, Serialize, Deserialize, Clone)]
-pub struct MithrilStakeDistributionSummary {
-    epoch: Epoch,
-    hash: String,
-}
-
-impl From<MithrilStakeDistribution> for MithrilStakeDistributionSummary {
-    fn from(other: MithrilStakeDistribution) -> Self {
-        Self {
-            epoch: other.epoch,
-            hash: other.hash,
-        }
-    }
-}
-
 /// A [MithrilStakeDistributionArtifact] builder
 pub struct MithrilStakeDistributionArtifactBuilder {
     multi_signer: Arc<RwLock<dyn MultiSigner>>,

mithril-aggregator/src/message_adapters/mod.rs

@@ -3,13 +3,17 @@ mod from_register_signer;
 mod to_certificate_message;
 mod to_certificate_pending_message;
 mod to_epoch_settings_message;
+mod to_mithril_stake_distribution_list_message;
+mod to_mithril_stake_distribution_message;
 mod to_snapshot_list_message;
-mod to_snasphot_message;
+mod to_snapshot_message;
 
 pub use from_register_signature::FromRegisterSingleSignatureAdapter;
 pub use from_register_signer::FromRegisterSignerAdapter;
 pub use to_certificate_message::ToCertificateMessageAdapter;
 pub use to_certificate_pending_message::ToCertificatePendingMessageAdapter;
 pub use to_epoch_settings_message::ToEpochSettingsMessageAdapter;
+pub use to_mithril_stake_distribution_list_message::ToMithrilStakeDistributionListMessageAdapter;
+pub use to_mithril_stake_distribution_message::ToMithrilStakeDistributionMessageAdapter;
 pub use to_snapshot_list_message::ToSnapshotListMessageAdapter;
-pub use to_snasphot_message::ToSnapshotMessageAdapter;
+pub use to_snapshot_message::ToSnapshotMessageAdapter;

mithril-aggregator/src/message_adapters/to_mithril_stake_distribution_list_message.rs

@@ -0,0 +1,52 @@
+use mithril_common::entities::MithrilStakeDistribution;
+use mithril_common::messages::{
+    MessageAdapter, MithrilStakeDistributionListItemMessage, MithrilStakeDistributionListMessage,
+};
+
+/// Adapter to convert a list of [MithrilStakeDistribution] to [MithrilStakeDistributionListMessage] instances
+pub struct ToMithrilStakeDistributionListMessageAdapter;
+
+impl MessageAdapter<Vec<MithrilStakeDistribution>, MithrilStakeDistributionListMessage>
+    for ToMithrilStakeDistributionListMessageAdapter
+{
+    /// Method to trigger the conversion
+    fn adapt(snapshots: Vec<MithrilStakeDistribution>) -> MithrilStakeDistributionListMessage {
+        snapshots
+            .into_iter()
+            .map(
+                |stake_distribution| MithrilStakeDistributionListItemMessage {
+                    epoch: stake_distribution.epoch,
+                    hash: stake_distribution.hash,
+                },
+            )
+            .collect()
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use mithril_common::{entities::Epoch, test_utils::fake_data::signers_with_stakes};
+
+    use super::*;
+
+    #[test]
+    fn adapt_ok() {
+        let mithril_stake_distribution = MithrilStakeDistribution {
+            epoch: Epoch(1),
+            signers_with_stake: signers_with_stakes(1),
+            hash: "hash-123".to_string(),
+        };
+        let mithril_stake_distribution_list_message =
+            ToMithrilStakeDistributionListMessageAdapter::adapt(vec![mithril_stake_distribution]);
+        let mithril_stake_distribution_list_message_expected =
+            vec![MithrilStakeDistributionListItemMessage {
+                epoch: Epoch(1),
+                hash: "hash-123".to_string(),
+            }];
+
+        assert_eq!(
+            mithril_stake_distribution_list_message_expected,
+            mithril_stake_distribution_list_message
+        );
+    }
+}

mithril-aggregator/src/message_adapters/to_mithril_stake_distribution_message.rs

@@ -0,0 +1,46 @@
+use mithril_common::entities::MithrilStakeDistribution;
+use mithril_common::messages::{MessageAdapter, MithrilStakeDistributionMessage};
+
+/// Adapter to convert [MithrilStakeDistribution] to [MithrilStakeDistributionMessage] instances
+pub struct ToMithrilStakeDistributionMessageAdapter;
+
+impl MessageAdapter<MithrilStakeDistribution, MithrilStakeDistributionMessage>
+    for ToMithrilStakeDistributionMessageAdapter
+{
+    /// Method to trigger the conversion
+    fn adapt(from: MithrilStakeDistribution) -> MithrilStakeDistributionMessage {
+        MithrilStakeDistributionMessage {
+            epoch: from.epoch,
+            signers_with_stake: from.signers_with_stake,
+            hash: from.hash,
+        }
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use mithril_common::{entities::Epoch, test_utils::fake_data};
+
+    use super::*;
+
+    #[test]
+    fn adapt_ok() {
+        let mithril_stake_distribution = MithrilStakeDistribution {
+            epoch: Epoch(1),
+            signers_with_stake: fake_data::signers_with_stakes(2),
+            hash: "hash-123".to_string(),
+        };
+        let mithril_stake_distribution_message_expected = MithrilStakeDistributionMessage {
+            epoch: Epoch(1),
+            signers_with_stake: fake_data::signers_with_stakes(2),
+            hash: "hash-123".to_string(),
+        };
+        let mithril_stake_distribution_message =
+            ToMithrilStakeDistributionMessageAdapter::adapt(mithril_stake_distribution);
+
+        assert_eq!(
+            mithril_stake_distribution_message_expected,
+            mithril_stake_distribution_message
+        );
+    }
+}

mithril-aggregator/src/message_adapters/to_snapshot_list_message.rs

@@ -1,12 +1,12 @@
 use mithril_common::entities::Snapshot;
-use mithril_common::messages::{SnapshotListItemMessage, SnapshotListMessage};
+use mithril_common::messages::{MessageAdapter, SnapshotListItemMessage, SnapshotListMessage};
 
 /// Adapter to convert a list of [Snapshot] to [SnapshotListMessage] instances
 pub struct ToSnapshotListMessageAdapter;
 
-impl ToSnapshotListMessageAdapter {
+impl MessageAdapter<Vec<Snapshot>, SnapshotListMessage> for ToSnapshotListMessageAdapter {
     /// Method to trigger the conversion
-    pub fn adapt(snapshots: Vec<Snapshot>) -> SnapshotListMessage {
+    fn adapt(snapshots: Vec<Snapshot>) -> SnapshotListMessage {
         snapshots
             .into_iter()
             .map(|snapshot| SnapshotListItemMessage {

mithril-aggregator/src/message_adapters/to_snasphot_message.rs renamed to mithril-aggregator/src/message_adapters/to_snapshot_message.rs

@@ -1,12 +1,12 @@
 use mithril_common::entities::Snapshot;
-use mithril_common::messages::SnapshotMessage;
+use mithril_common::messages::{MessageAdapter, SnapshotMessage};
 
 /// Adapter to convert [Snapshot] to [SnapshotMessage] instances
 pub struct ToSnapshotMessageAdapter;
 
-impl ToSnapshotMessageAdapter {
+impl MessageAdapter<Snapshot, SnapshotMessage> for ToSnapshotMessageAdapter {
     /// Method to trigger the conversion
-    pub fn adapt(snapshot: Snapshot) -> SnapshotMessage {
+    fn adapt(snapshot: Snapshot) -> SnapshotMessage {
         SnapshotMessage {
             digest: snapshot.digest,
             beacon: snapshot.beacon,

mithril-common/src/entities/mithril_stake_distribution.rs

@@ -0,0 +1,51 @@
+use serde::{Deserialize, Serialize};
+use sha2::{Digest, Sha256};
+
+use crate::{
+    entities::{Epoch, SignerWithStake},
+    signable_builder::Artifact,
+};
+
+/// Mithril Stake Distribution
+#[derive(Debug, PartialEq, Serialize, Deserialize, Clone)]
+pub struct MithrilStakeDistribution {
+    /// Epoch at which the Mithril Stake Distribution is created
+    pub epoch: Epoch,
+
+    /// List of signers with stakes of the Mithril Stake Distribution
+    pub signers_with_stake: Vec<SignerWithStake>,
+
+    /// Hash of the Mithril Stake Distribution (different from the AVK).
+    pub hash: String,
+}
+
+impl MithrilStakeDistribution {
+    /// MithrilStakeDistribution artifact factory
+    pub fn new(epoch: Epoch, signers_with_stake: Vec<SignerWithStake>) -> Self {
+        let mut signers_with_stake_sorted = signers_with_stake;
+        signers_with_stake_sorted.sort();
+        let mut mithril_stake_distribution = Self {
+            epoch,
+            signers_with_stake: signers_with_stake_sorted,
+            hash: "".to_string(),
+        };
+        mithril_stake_distribution.hash = mithril_stake_distribution.compute_hash();
+        mithril_stake_distribution
+    }
+
+    fn compute_hash(&self) -> String {
+        let mut hasher = Sha256::new();
+        hasher.update(self.epoch.0.to_be_bytes());
+        for signer_with_stake in &self.signers_with_stake {
+            hasher.update(signer_with_stake.compute_hash().as_bytes());
+        }
+        hex::encode(hasher.finalize())
+    }
+}
+
+#[typetag::serde]
+impl Artifact for MithrilStakeDistribution {
+    fn get_id(&self) -> String {
+        self.hash.clone()
+    }
+}

mithril-common/src/entities/mod.rs

@@ -8,6 +8,7 @@ mod certificate_pending;
 mod epoch;
 mod epoch_settings;
 mod http_server_error;
+mod mithril_stake_distribution;
 mod protocol_message;
 mod protocol_parameters;
 mod signed_entity_type;
@@ -24,6 +25,7 @@ pub use certificate_pending::CertificatePending;
 pub use epoch::{Epoch, EpochError};
 pub use epoch_settings::EpochSettings;
 pub use http_server_error::{ClientError, InternalServerError};
+pub use mithril_stake_distribution::MithrilStakeDistribution;
 pub use protocol_message::{ProtocolMessage, ProtocolMessagePartKey, ProtocolMessagePartValue};
 pub use protocol_parameters::ProtocolParameters;
 pub use signed_entity_type::*;

mithril-common/src/messages/interface.rs

@@ -0,0 +1,7 @@
+use serde::{Deserialize, Serialize};
+
+/// Message adapter trait
+pub trait MessageAdapter<U, V: Serialize + for<'a> Deserialize<'a>> {
+    /// Adapt entity to message
+    fn adapt(from: U) -> V;
+}