Merge pull request #1839 from input-output-hk/ensemble/1807/optional_beacon_in_cert_messages

Make deprecated `beacon` field optional in `Certificate` & `CertificateList` messages

Author: Alenar

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-aggregator"
-version = "0.5.45"
+version = "0.5.46"
 description = "A Mithril Aggregator server"
 authors = { workspace = true }
 edition = { workspace = true }

mithril-aggregator/Cargo.toml

@@ -239,7 +239,7 @@ impl From<CertificateRecord> for Certificate {
 
 impl From<CertificateRecord> for CertificateMessage {
     fn from(value: CertificateRecord) -> Self {
-        let beacon = value.as_cardano_db_beacon();
+        let beacon = Some(value.as_cardano_db_beacon());
         let metadata = CertificateMetadataMessagePart {
             network: value.network,
             protocol_version: value.protocol_version,
@@ -273,7 +273,7 @@ impl From<CertificateRecord> for CertificateMessage {
 
 impl From<CertificateRecord> for CertificateListItemMessage {
     fn from(value: CertificateRecord) -> Self {
-        let beacon = value.as_cardano_db_beacon();
+        let beacon = Some(value.as_cardano_db_beacon());
         let metadata = CertificateListItemMessageMetadata {
             network: value.network,
             protocol_version: value.protocol_version,

mithril-aggregator/src/database/record/certificate.rs

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-client-cli"
-version = "0.9.6"
+version = "0.9.7"
 description = "A Mithril Client"
 authors = { workspace = true }
 edition = { workspace = true }

mithril-client-cli/Cargo.toml

@@ -364,7 +364,7 @@ mod tests {
             hash: "hash".to_string(),
             previous_hash: "previous_hash".to_string(),
             epoch: beacon.epoch,
-            beacon: beacon.clone(),
+            beacon: Some(beacon.clone()),
             signed_entity_type: SignedEntityType::CardanoImmutableFilesFull(beacon),
             metadata: MithrilCertificateMetadata::dummy(),
             protocol_message: protocol_message.clone(),

mithril-client-cli/src/commands/cardano_db/download.rs

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-common"
-version = "0.4.32"
+version = "0.4.33"
 description = "Common types, interfaces, and utilities for Mithril nodes."
 authors = { workspace = true }
 edition = { workspace = true }

mithril-common/Cargo.toml

@@ -37,7 +37,8 @@ pub struct CertificateMessage {
 
     /// Mithril beacon on the Cardano chain
     #[deprecated(since = "0.3.25", note = "use epoch and/or signed_entity_type instead")]
-    pub beacon: CardanoDbBeacon,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub beacon: Option<CardanoDbBeacon>,
 
     /// Certificate metadata
     /// aka METADATA(p,n)
@@ -86,7 +87,7 @@ impl CertificateMessage {
                 previous_hash: "previous_hash".to_string(),
                 epoch,
                 signed_entity_type: SignedEntityType::MithrilStakeDistribution(epoch),
-                beacon: CardanoDbBeacon::new("testnet".to_string(), *epoch, 100),
+                beacon: Some(CardanoDbBeacon::new("testnet".to_string(), *epoch, 100)),
                 metadata: CertificateMetadataMessagePart::dummy(),
                 protocol_message: protocol_message.clone(),
                 signed_message: "signed_message".to_string(),
@@ -142,8 +143,13 @@ impl TryFrom<CertificateMessage> for Certificate {
     fn try_from(certificate_message: CertificateMessage) -> Result<Self, Self::Error> {
         #[allow(deprecated)]
         let metadata = CertificateMetadata {
-            network: certificate_message.beacon.network,
-            immutable_file_number: certificate_message.beacon.immutable_file_number,
+            network: certificate_message.metadata.network,
+            // This field is deprecated and will be removed in the future so use 0 as default
+            // value is fine.
+            immutable_file_number: certificate_message
+                .beacon
+                .map(|b| b.immutable_file_number)
+                .unwrap_or(0),
             protocol_version: certificate_message.metadata.protocol_version,
             protocol_parameters: certificate_message.metadata.protocol_parameters,
             initiated_at: certificate_message.metadata.initiated_at,
@@ -194,7 +200,7 @@ impl TryFrom<Certificate> for CertificateMessage {
     type Error = StdError;
 
     fn try_from(certificate: Certificate) -> Result<Self, Self::Error> {
-        let beacon = certificate.as_cardano_db_beacon();
+        let beacon = Some(certificate.as_cardano_db_beacon());
         let signed_entity_type = certificate.signed_entity_type();
         let metadata = CertificateMetadataMessagePart {
             network: certificate.metadata.network,
@@ -249,7 +255,23 @@ mod tests {
 
     use super::*;
 
-    fn golden_message() -> CertificateMessage {
+    #[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
+    struct CertificateMessagePreviousVersion {
+        pub hash: String,
+        pub previous_hash: String,
+        pub epoch: Epoch,
+        pub signed_entity_type: SignedEntityType,
+        #[deprecated(since = "0.3.25", note = "use epoch and/or signed_entity_type instead")]
+        pub beacon: CardanoDbBeacon,
+        pub metadata: CertificateMetadataMessagePart,
+        pub protocol_message: ProtocolMessage,
+        pub signed_message: String,
+        pub aggregate_verification_key: String,
+        pub multi_signature: String,
+        pub genesis_signature: String,
+    }
+
+    fn golden_previous_message() -> CertificateMessagePreviousVersion {
         let mut protocol_message = ProtocolMessage::new();
         protocol_message.set_message_part(
             ProtocolMessagePartKey::SnapshotDigest,
@@ -262,7 +284,7 @@ mod tests {
         let beacon = CardanoDbBeacon::new("testnet", 10, 100);
 
         #[allow(deprecated)]
-        CertificateMessage {
+        CertificateMessagePreviousVersion {
             hash: "hash".to_string(),
             previous_hash: "previous_hash".to_string(),
             epoch: beacon.epoch,
@@ -297,10 +319,55 @@ mod tests {
         }
     }
 
-    // Test the backward compatibility with possible future upgrades.
-    #[test]
-    fn test_v1() {
-        let json = r#"{
+    fn golden_actual_message() -> CertificateMessage {
+        let mut protocol_message = ProtocolMessage::new();
+        protocol_message.set_message_part(
+            ProtocolMessagePartKey::SnapshotDigest,
+            "snapshot-digest-123".to_string(),
+        );
+        protocol_message.set_message_part(
+            ProtocolMessagePartKey::NextAggregateVerificationKey,
+            "next-avk-123".to_string(),
+        );
+        let beacon = CardanoDbBeacon::new("testnet", 10, 100);
+
+        #[allow(deprecated)]
+        CertificateMessage {
+            hash: "hash".to_string(),
+            previous_hash: "previous_hash".to_string(),
+            epoch: beacon.epoch,
+            signed_entity_type: SignedEntityType::MithrilStakeDistribution(beacon.epoch),
+            beacon: Some(beacon.clone()),
+            metadata: CertificateMetadataMessagePart {
+                network: beacon.network,
+                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")
+                    .unwrap()
+                    .with_timezone(&Utc),
+                sealed_at: DateTime::parse_from_rfc3339("2024-02-12T13:12:57Z")
+                    .unwrap()
+                    .with_timezone(&Utc),
+                signers: vec![
+                    StakeDistributionParty {
+                        party_id: "1".to_string(),
+                        stake: 10,
+                    },
+                    StakeDistributionParty {
+                        party_id: "2".to_string(),
+                        stake: 20,
+                    },
+                ],
+            },
+            protocol_message: protocol_message.clone(),
+            signed_message: "signed_message".to_string(),
+            aggregate_verification_key: "aggregate_verification_key".to_string(),
+            multi_signature: "multi_signature".to_string(),
+            genesis_signature: "genesis_signature".to_string(),
+        }
+    }
+
+    const ACTUAL_JSON: &str = r#"{
             "hash": "hash",
             "previous_hash": "previous_hash",
             "epoch": 10,
@@ -344,10 +411,74 @@ mod tests {
             "multi_signature": "multi_signature",
             "genesis_signature": "genesis_signature"
         }"#;
+
+    #[test]
+    fn test_actual_json_deserialized_into_previous_message() {
+        let json = ACTUAL_JSON;
+        let message: CertificateMessagePreviousVersion = serde_json::from_str(json).unwrap();
+
+        assert_eq!(golden_previous_message(), message);
+    }
+
+    #[test]
+    fn test_actual_json_deserialized_into_actual_message() {
+        let json = ACTUAL_JSON;
+        let message: CertificateMessage = serde_json::from_str(json).unwrap();
+
+        assert_eq!(golden_actual_message(), message);
+    }
+
+    #[test]
+    fn test_json_next_version_deserialized_into_actual_message() {
+        let json = r#"{
+            "hash": "hash",
+            "previous_hash": "previous_hash",
+            "epoch": 10,
+            "signed_entity_type": { "MithrilStakeDistribution": 10 },
+            "metadata": {
+                "network": "testnet",
+                "version": "0.1.0",
+                "parameters": {
+                    "k": 1000,
+                    "m": 100,
+                    "phi_f": 0.123
+                },
+            "initiated_at": "2024-02-12T13:11:47Z",
+            "sealed_at": "2024-02-12T13:12:57Z",
+                "signers": [
+                    {
+                        "party_id": "1",
+                        "verification_key": "7b22766b223a5b3134332c3136312c3235352c34382c37382c35372c3230342c3232302c32352c3232312c3136342c3235322c3234382c31342c35362c3132362c3138362c3133352c3232382c3138382c3134352c3138312c35322c3230302c39372c39392c3231332c34362c302c3139392c3139332c38392c3138372c38382c32392c3133352c3137332c3234342c38362c33362c38332c35342c36372c3136342c362c3133372c39342c37322c362c3130352c3132382c3132382c39332c34382c3137362c31312c342c3234362c3133382c34382c3138302c3133332c39302c3134322c3139322c32342c3139332c3131312c3134322c33312c37362c3131312c3131302c3233342c3135332c39302c3230382c3139322c33312c3132342c39352c3130322c34392c3135382c39392c35322c3232302c3136352c39342c3235312c36382c36392c3132312c31362c3232342c3139345d2c22706f70223a5b3136382c35302c3233332c3139332c31352c3133362c36352c37322c3132332c3134382c3132392c3137362c33382c3139382c3230392c34372c32382c3230342c3137362c3134342c35372c3235312c34322c32382c36362c37362c38392c39372c3135382c36332c35342c3139382c3139342c3137362c3133352c3232312c31342c3138352c3139372c3232352c3230322c39382c3234332c37342c3233332c3232352c3134332c3135312c3134372c3137372c3137302c3131372c36362c3136352c36362c36322c33332c3231362c3233322c37352c36382c3131342c3139352c32322c3130302c36352c34342c3139382c342c3136362c3130322c3233332c3235332c3234302c35392c3137352c36302c3131372c3134322c3131342c3134302c3132322c31372c38372c3131302c3138372c312c31372c31302c3139352c3135342c31332c3234392c38362c35342c3232365d7d",
+                        "stake": 10
+                    },
+                    {
+                        "party_id": "2",
+                        "verification_key": "7b22766b223a5b3134352c35362c3137352c33322c3132322c3138372c3231342c3232362c3235312c3134382c38382c392c312c3130332c3135392c3134362c38302c3136362c3130372c3234332c3235312c3233362c34312c32382c3131312c3132382c3230372c3136342c3133322c3134372c3232382c38332c3234362c3232382c3137302c36382c38392c37382c36302c32382c3132332c3133302c38382c3233342c33382c39372c34322c36352c312c3130302c35332c31382c37382c3133312c382c36312c3132322c3133312c3233382c38342c3233332c3232332c3135342c3131382c3131382c37332c32382c32372c3130312c37382c38302c3233332c3132332c3230362c3232302c3137342c3133342c3230352c37312c3131302c3131322c3138302c39372c39382c302c3131332c36392c3134352c3233312c3136382c34332c3137332c3137322c35362c3130342c3230385d2c22706f70223a5b3133372c3231342c37352c37352c3134342c3136312c3133372c37392c39342c3134302c3138312c34372c33312c38312c3231332c33312c3137312c3231362c32342c3137342c37382c3234382c3133302c37352c3235352c31312c3134352c3132342c36312c38302c3139302c32372c3231362c3130352c3130362c3234382c39312c3134332c3230342c3130322c3230332c3136322c37362c3130372c31352c35322c36312c38322c3134362c3133302c3132342c37342c382c33342c3136342c3138372c3230332c38322c36342c3130382c3139312c3138352c3138382c37372c3132322c352c3234362c3235352c3130322c3131392c3234372c3139392c3131372c36372c3234312c3134332c32392c3136382c36372c39342c3135312c37382c3132392c3133312c33302c3130312c3137332c31302c36392c36382c3137352c39382c33372c3233392c3139342c32395d7d",
+                        "stake": 20
+                    }
+                ]
+            },
+            "protocol_message": {
+                "message_parts": {
+                    "snapshot_digest": "snapshot-digest-123",
+                    "next_aggregate_verification_key": "next-avk-123"
+                }
+            },
+            "signed_message": "signed_message",
+            "aggregate_verification_key": "aggregate_verification_key",
+            "multi_signature": "multi_signature",
+            "genesis_signature": "genesis_signature"
+        }"#;
         let message: CertificateMessage = serde_json::from_str(json).expect(
             "This JSON is expected to be successfully parsed into a CertificateMessage instance.",
         );
 
-        assert_eq!(golden_message(), message);
+        #[allow(deprecated)]
+        let golden_message = CertificateMessage {
+            beacon: None,
+            ..golden_actual_message()
+        };
+
+        assert_eq!(golden_message, message);
     }
 }