Move CertificateMetadataMessage & SignerMessage to message_parts

Alenar · Alenar · commit 46732dc0112b · 2023-08-21T09:56:59.000+02:00
diff --git a/mithril-aggregator/src/message_adapters/to_certificate_message.rs b/mithril-aggregator/src/message_adapters/to_certificate_message.rs
@@ -1,6 +1,7 @@
 use mithril_common::entities::{Certificate, CertificateSignature};
 use mithril_common::messages::{
-    CertificateMessage, CertificateMetadataMessage, SignerWithStakeMessagePart, ToMessageAdapter,
+    CertificateMessage, CertificateMetadataMessagePart, SignerWithStakeMessagePart,
+    ToMessageAdapter,
 };
 
 /// Adapter to convert [Certificate] to [CertificateMessage] instances
@@ -9,7 +10,7 @@ pub struct ToCertificateMessageAdapter;
 impl ToMessageAdapter<Certificate, CertificateMessage> for ToCertificateMessageAdapter {
     /// Method to trigger the conversion
     fn adapt(certificate: Certificate) -> CertificateMessage {
-        let metadata = CertificateMetadataMessage {
+        let metadata = CertificateMetadataMessagePart {
             protocol_version: certificate.metadata.protocol_version,
             protocol_parameters: certificate.metadata.protocol_parameters,
             initiated_at: certificate.metadata.initiated_at,
diff --git a/mithril-aggregator/src/message_adapters/to_certificate_pending_message.rs b/mithril-aggregator/src/message_adapters/to_certificate_pending_message.rs
@@ -1,6 +1,6 @@
 use mithril_common::{
     entities::{CertificatePending, Signer},
-    messages::{CertificatePendingMessage, SignerMessage, ToMessageAdapter},
+    messages::{CertificatePendingMessage, SignerMessagePart, ToMessageAdapter},
 };
 
 /// Adapter to turn [CertificatePending] instances into [CertificatePendingMessage].
@@ -23,10 +23,10 @@ impl ToMessageAdapter<CertificatePending, CertificatePendingMessage>
 }
 
 impl ToCertificatePendingMessageAdapter {
-    fn adapt_signers(signers: Vec<Signer>) -> Vec<SignerMessage> {
+    fn adapt_signers(signers: Vec<Signer>) -> Vec<SignerMessagePart> {
         signers
             .into_iter()
-            .map(|signer| SignerMessage {
+            .map(|signer| SignerMessagePart {
                 party_id: signer.party_id,
                 verification_key: signer.verification_key.try_into().unwrap(),
                 verification_key_signature: signer
diff --git a/mithril-client/src/aggregator_client/certificate_client.rs b/mithril-client/src/aggregator_client/certificate_client.rs
@@ -67,7 +67,7 @@ impl CertificateRetriever for CertificateClient {
 #[cfg(test)]
 mod tests {
     use mithril_common::entities::CertificateSignature;
-    use mithril_common::messages::{CertificateMetadataMessage, SignerWithStakeMessagePart};
+    use mithril_common::messages::{CertificateMetadataMessagePart, SignerWithStakeMessagePart};
     use mithril_common::test_utils::fake_data;
 
     use crate::aggregator_client::MockAggregatorHTTPClient;
@@ -97,7 +97,7 @@ mod tests {
                     hash: certificate_hash.clone(),
                     previous_hash: previous_hash.clone(),
                     beacon: certificate.beacon.clone(),
-                    metadata: CertificateMetadataMessage {
+                    metadata: CertificateMetadataMessagePart {
                         protocol_version: certificate.metadata.protocol_version.clone(),
                         protocol_parameters: certificate.metadata.protocol_parameters.clone(),
                         initiated_at: certificate.metadata.initiated_at,
diff --git a/mithril-common/src/messages/certificate.rs b/mithril-common/src/messages/certificate.rs
@@ -1,10 +1,8 @@
-use crate::{
-    entities::{Beacon, ProtocolMessage, ProtocolMessagePartKey},
-    messages::certificate_metadata::CertificateMetadataMessage,
-};
+use serde::{Deserialize, Serialize};
 
+use crate::entities::{Beacon, ProtocolMessage, ProtocolMessagePartKey};
+use crate::messages::CertificateMetadataMessagePart;
 use crate::test_utils::fake_keys;
-use serde::{Deserialize, Serialize};
 
 /// Message structure of a certificate
 #[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
@@ -26,7 +24,7 @@ pub struct CertificateMessage {
 
     /// Certificate metadata
     /// aka METADATA(p,n)
-    pub metadata: CertificateMetadataMessage,
+    pub metadata: CertificateMetadataMessagePart,
 
     /// Structured message that is used to created the signed message
     /// aka MSG(p,n) U AVK(n-1)
@@ -66,7 +64,7 @@ impl CertificateMessage {
             hash: "hash".to_string(),
             previous_hash: "previous_hash".to_string(),
             beacon: Beacon::new("testnet".to_string(), 10, 100),
-            metadata: CertificateMetadataMessage::dummy(),
+            metadata: CertificateMetadataMessagePart::dummy(),
             protocol_message: protocol_message.clone(),
             signed_message: "signed_message".to_string(),
             aggregate_verification_key: "aggregate_verification_key".to_string(),
@@ -96,7 +94,7 @@ mod tests {
             hash: "hash".to_string(),
             previous_hash: "previous_hash".to_string(),
             beacon: Beacon::new("testnet".to_string(), 10, 100),
-            metadata: CertificateMetadataMessage {
+            metadata: CertificateMetadataMessagePart {
                 protocol_version: "0.1.0".to_string(),
                 protocol_parameters: ProtocolParameters::new(1000, 100, 0.123),
                 initiated_at: DateTime::parse_from_rfc3339("2024-02-12T13:11:47Z")
diff --git a/mithril-common/src/messages/certificate_pending.rs b/mithril-common/src/messages/certificate_pending.rs
@@ -1,13 +1,7 @@
 use serde::{Deserialize, Serialize};
 
-use crate::{
-    crypto_helper::KESPeriod,
-    entities::{
-        Beacon, HexEncodedOpCert, HexEncodedVerificationKey, HexEncodedVerificationKeySignature,
-        PartyId, ProtocolParameters, SignedEntityType,
-    },
-    test_utils::fake_keys,
-};
+use crate::entities::{Beacon, ProtocolParameters, SignedEntityType};
+use crate::messages::SignerMessagePart;
 
 /// Structure to transport [crate::entities::CertificatePending] data.
 #[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
@@ -28,10 +22,10 @@ pub struct CertificatePendingMessage {
     pub next_protocol_parameters: ProtocolParameters,
 
     /// Current Signers
-    pub signers: Vec<SignerMessage>,
+    pub signers: Vec<SignerMessagePart>,
 
     /// Signers that will be able to sign on the next epoch
-    pub next_signers: Vec<SignerMessage>,
+    pub next_signers: Vec<SignerMessagePart>,
 }
 
 impl CertificatePendingMessage {
@@ -50,55 +44,8 @@ impl CertificatePendingMessage {
                 m: 1000,
                 phi_f: 0.65,
             },
-            signers: [SignerMessage::dummy()].to_vec(),
-            next_signers: [SignerMessage::dummy()].to_vec(),
-        }
-    }
-}
-
-// todo: move to message_parts
-/// Signer Message
-#[derive(Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize)]
-pub struct SignerMessage {
-    /// The unique identifier of the signer
-    // TODO: Should be removed once the signer certification is fully deployed
-    pub party_id: PartyId,
-
-    /// The public key used to authenticate signer signature
-    pub verification_key: HexEncodedVerificationKey,
-
-    /// The encoded signer 'Mithril verification key' signature (signed by the
-    /// Cardano node KES secret key).
-    // TODO: Option should be removed once the signer certification is fully
-    //       deployed.
-    #[serde(skip_serializing_if = "Option::is_none")]
-    pub verification_key_signature: Option<HexEncodedVerificationKeySignature>,
-
-    /// The encoded operational certificate of stake pool operator attached to
-    /// the signer node.
-    // TODO: Option should be removed once the signer certification is fully
-    //       deployed.
-    #[serde(skip_serializing_if = "Option::is_none")]
-    pub operational_certificate: Option<HexEncodedOpCert>,
-
-    /// The KES period used to compute the verification key signature
-    // TODO: This KES period should not be used as is and should probably be
-    //       within an allowed range of KES periods for the epoch.
-    #[serde(skip_serializing_if = "Option::is_none")]
-    pub kes_period: Option<KESPeriod>,
-}
-
-impl SignerMessage {
-    /// Return a dummy test entity (test-only).
-    pub fn dummy() -> Self {
-        Self {
-            party_id: "pool1m8crhnqj5k2kyszf5j2scshupystyxc887zdfrpzh6ty6eun4fx".to_string(),
-            verification_key: fake_keys::signer_verification_key()[0].to_string(),
-            verification_key_signature: Some(
-                fake_keys::signer_verification_key_signature()[0].to_string(),
-            ),
-            operational_certificate: Some(fake_keys::operational_certificate()[0].to_string()),
-            kes_period: Some(6),
+            signers: [SignerMessagePart::dummy()].to_vec(),
+            next_signers: [SignerMessagePart::dummy()].to_vec(),
         }
     }
 }
@@ -129,7 +76,7 @@ mod tests {
                 phi_f: 0.65,
             },
             signers: vec![
-                SignerMessage {
+                SignerMessagePart {
                     party_id: "123".to_string(),
                     verification_key: "7b22766b223a5b3134332c3136312c3235352c34382c37382c35372c3230342c3232302c32352c3232312c3136342c3235322c3234382c31342c35362c3132362c3138362c3133352c3232382c3138382c3134352c3138312c35322c3230302c39372c39392c3231332c34362c302c3139392c3139332c38392c3138372c38382c32392c3133352c3137332c3234342c38362c33362c38332c35342c36372c3136342c362c3133372c39342c37322c362c3130352c3132382c3132382c39332c34382c3137362c31312c342c3234362c3133382c34382c3138302c3133332c39302c3134322c3139322c32342c3139332c3131312c3134322c33312c37362c3131312c3131302c3233342c3135332c39302c3230382c3139322c33312c3132342c39352c3130322c34392c3135382c39392c35322c3232302c3136352c39342c3235312c36382c36392c3132312c31362c3232342c3139345d2c22706f70223a5b3136382c35302c3233332c3139332c31352c3133362c36352c37322c3132332c3134382c3132392c3137362c33382c3139382c3230392c34372c32382c3230342c3137362c3134342c35372c3235312c34322c32382c36362c37362c38392c39372c3135382c36332c35342c3139382c3139342c3137362c3133352c3232312c31342c3138352c3139372c3232352c3230322c39382c3234332c37342c3233332c3232352c3134332c3135312c3134372c3137372c3137302c3131372c36362c3136352c36362c36322c33332c3231362c3233322c37352c36382c3131342c3139352c32322c3130302c36352c34342c3139382c342c3136362c3130322c3233332c3235332c3234302c35392c3137352c36302c3131372c3134322c3131342c3134302c3132322c31372c38372c3131302c3138372c312c31372c31302c3139352c3135342c31332c3234392c38362c35342c3232365d7d".to_string(),
                     verification_key_signature: None,
@@ -138,7 +85,7 @@ mod tests {
                 }
             ],
             next_signers: vec![
-                SignerMessage {
+                SignerMessagePart {
                     party_id: "123".to_string(),
                     verification_key: "7b22766b223a5b3134332c3136312c3235352c34382c37382c35372c3230342c3232302c32352c3232312c3136342c3235322c3234382c31342c35362c3132362c3138362c3133352c3232382c3138382c3134352c3138312c35322c3230302c39372c39392c3231332c34362c302c3139392c3139332c38392c3138372c38382c32392c3133352c3137332c3234342c38362c33362c38332c35342c36372c3136342c362c3133372c39342c37322c362c3130352c3132382c3132382c39332c34382c3137362c31312c342c3234362c3133382c34382c3138302c3133332c39302c3134322c3139322c32342c3139332c3131312c3134322c33312c37362c3131312c3131302c3233342c3135332c39302c3230382c3139322c33312c3132342c39352c3130322c34392c3135382c39392c35322c3232302c3136352c39342c3235312c36382c36392c3132312c31362c3232342c3139345d2c22706f70223a5b3136382c35302c3233332c3139332c31352c3133362c36352c37322c3132332c3134382c3132392c3137362c33382c3139382c3230392c34372c32382c3230342c3137362c3134342c35372c3235312c34322c32382c36362c37362c38392c39372c3135382c36332c35342c3139382c3139342c3137362c3133352c3232312c31342c3138352c3139372c3232352c3230322c39382c3234332c37342c3233332c3232352c3134332c3135312c3134372c3137372c3137302c3131372c36362c3136352c36362c36322c33332c3231362c3233322c37352c36382c3131342c3139352c32322c3130302c36352c34342c3139382c342c3136362c3130322c3233332c3235332c3234302c35392c3137352c36302c3131372c3134322c3131342c3134302c3132322c31372c38372c3131302c3138372c312c31372c31302c3139352c3135342c31332c3234392c38362c35342c3232365d7d".to_string(),
                     verification_key_signature: None,
diff --git a/mithril-common/src/messages/message_parts/certificate_metadata.rs b/mithril-common/src/messages/message_parts/certificate_metadata.rs
@@ -8,10 +8,9 @@ use serde::{Deserialize, Serialize};
 
 use super::SignerWithStakeMessagePart;
 
-// todo: move to message_parts
 /// CertificateMetadata represents the metadata associated to a Certificate
 #[derive(Clone, Debug, PartialEq, Default, Serialize, Deserialize)]
-pub struct CertificateMetadataMessage {
+pub struct CertificateMetadataMessagePart {
     /// Protocol Version (semver)
     /// Useful to achieve backward compatibility of the certificates (including of the multi signature)
     /// part of METADATA(p,n)
@@ -38,7 +37,7 @@ pub struct CertificateMetadataMessage {
     pub signers: Vec<SignerWithStakeMessagePart>,
 }
 
-impl CertificateMetadataMessage {
+impl CertificateMetadataMessagePart {
     /// CertificateMetadata factory
     pub fn dummy() -> Self {
         let initiated_at = DateTime::parse_from_rfc3339("2024-02-12T13:11:47Z")
@@ -76,8 +75,8 @@ impl CertificateMetadataMessage {
 mod tests {
     use super::*;
 
-    fn golden_message() -> CertificateMetadataMessage {
-        CertificateMetadataMessage {
+    fn golden_message() -> CertificateMetadataMessagePart {
+        CertificateMetadataMessagePart {
             protocol_version: "0.1.0".to_string(),
             protocol_parameters: ProtocolParameters::new(1000, 100, 0.123),
             initiated_at: DateTime::parse_from_rfc3339("2024-02-12T13:11:47Z")
@@ -132,7 +131,7 @@ mod tests {
                 }
             ]
         }"#;
-        let message: CertificateMetadataMessage = serde_json::from_str(json).expect(
+        let message: CertificateMetadataMessagePart = serde_json::from_str(json).expect(
             "This JSON is expected to be successfully parsed into a CertificateMetadataMessage instance.",
         );
 
diff --git a/mithril-common/src/messages/message_parts/mod.rs b/mithril-common/src/messages/message_parts/mod.rs
@@ -1,3 +1,5 @@
+mod certificate_metadata;
 mod signer;
 
-pub use signer::SignerWithStakeMessagePart;
+pub use certificate_metadata::CertificateMetadataMessagePart;
+pub use signer::{SignerMessagePart, SignerWithStakeMessagePart};
diff --git a/mithril-common/src/messages/message_parts/signer.rs b/mithril-common/src/messages/message_parts/signer.rs
@@ -9,7 +9,7 @@ use crate::{
 };
 use serde::{Deserialize, Serialize};
 
-/// Signer Message
+/// Signer with Stake Message
 #[derive(Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize)]
 pub struct SignerWithStakeMessagePart {
     /// The unique identifier of the signer
@@ -107,3 +107,49 @@ impl From<SignerWithStake> for SignerWithStakeMessagePart {
         }
     }
 }
+
+/// Signer Message
+#[derive(Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize)]
+pub struct SignerMessagePart {
+    /// The unique identifier of the signer
+    // TODO: Should be removed once the signer certification is fully deployed
+    pub party_id: PartyId,
+
+    /// The public key used to authenticate signer signature
+    pub verification_key: HexEncodedVerificationKey,
+
+    /// The encoded signer 'Mithril verification key' signature (signed by the
+    /// Cardano node KES secret key).
+    // TODO: Option should be removed once the signer certification is fully
+    //       deployed.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub verification_key_signature: Option<HexEncodedVerificationKeySignature>,
+
+    /// The encoded operational certificate of stake pool operator attached to
+    /// the signer node.
+    // TODO: Option should be removed once the signer certification is fully
+    //       deployed.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub operational_certificate: Option<HexEncodedOpCert>,
+
+    /// The KES period used to compute the verification key signature
+    // TODO: This KES period should not be used as is and should probably be
+    //       within an allowed range of KES periods for the epoch.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub kes_period: Option<KESPeriod>,
+}
+
+impl SignerMessagePart {
+    /// Return a dummy test entity (test-only).
+    pub fn dummy() -> Self {
+        Self {
+            party_id: "pool1m8crhnqj5k2kyszf5j2scshupystyxc887zdfrpzh6ty6eun4fx".to_string(),
+            verification_key: fake_keys::signer_verification_key()[0].to_string(),
+            verification_key_signature: Some(
+                fake_keys::signer_verification_key_signature()[0].to_string(),
+            ),
+            operational_certificate: Some(fake_keys::operational_certificate()[0].to_string()),
+            kes_period: Some(6),
+        }
+    }
+}
diff --git a/mithril-common/src/messages/mod.rs b/mithril-common/src/messages/mod.rs
@@ -2,7 +2,6 @@
 //! This module aims at providing shared structures for API communications.
 mod certificate;
 mod certificate_list;
-mod certificate_metadata;
 mod certificate_pending;
 mod epoch_settings;
 mod interface;
@@ -18,8 +17,7 @@ pub use certificate::CertificateMessage;
 pub use certificate_list::{
     CertificateListItemMessage, CertificateListItemMessageMetadata, CertificateListMessage,
 };
-pub use certificate_metadata::CertificateMetadataMessage;
-pub use certificate_pending::{CertificatePendingMessage, SignerMessage};
+pub use certificate_pending::CertificatePendingMessage;
 pub use epoch_settings::EpochSettingsMessage;
 pub use interface::*;
 pub use message_parts::*;
diff --git a/mithril-common/src/test_utils/apispec.rs b/mithril-common/src/test_utils/apispec.rs
@@ -195,7 +195,7 @@ mod tests {
 
     use super::*;
     use crate::entities;
-    use crate::messages::{CertificatePendingMessage, SignerMessage};
+    use crate::messages::{CertificatePendingMessage, SignerMessagePart};
     use crate::test_utils::fake_data;
 
     #[test]
@@ -217,7 +217,7 @@ mod tests {
         assert!(APISpec::from_file(&APISpec::get_defaut_spec_file())
             .method(Method::POST.as_str())
             .path("/register-signer")
-            .validate_request(&SignerMessage::dummy())
+            .validate_request(&SignerMessagePart::dummy())
             .unwrap()
             .validate_response(&Response::<Bytes>::new(Bytes::new()))
             .is_err());
diff --git a/mithril-signer/src/message_adapters/from_pending_certificate_message.rs b/mithril-signer/src/message_adapters/from_pending_certificate_message.rs
@@ -3,14 +3,14 @@ use mithril_common::{
         ProtocolOpCert, ProtocolSignerVerificationKey, ProtocolSignerVerificationKeySignature,
     },
     entities::{CertificatePending, Signer},
-    messages::{CertificatePendingMessage, SignerMessage, TryFromMessageAdapter},
+    messages::{CertificatePendingMessage, SignerMessagePart, TryFromMessageAdapter},
     StdResult,
 };
 
 /// Adapter to turn [CertificatePendingMessage] instances into [CertificatePending].
 pub struct FromPendingCertificateMessageAdapter;
 
-fn to_signers(messages: &[SignerMessage]) -> StdResult<Vec<Signer>> {
+fn to_signers(messages: &[SignerMessagePart]) -> StdResult<Vec<Signer>> {
     let mut signers: Vec<Signer> = Vec::new();
 
     for msg in messages {
@@ -73,7 +73,7 @@ mod tests {
     #[test]
     fn adapt_signers() {
         let mut message = CertificatePendingMessage::dummy();
-        message.signers = vec![SignerMessage::dummy(), SignerMessage::dummy()];
+        message.signers = vec![SignerMessagePart::dummy(), SignerMessagePart::dummy()];
         let certificate_pending = FromPendingCertificateMessageAdapter::try_adapt(message).unwrap();
 
         assert_eq!(2, certificate_pending.signers.len());
