Add signed message to RegisterSignatureMessage in common

Author: Alenar

mithril-common/src/messages/register_signature.rs

@@ -21,6 +21,13 @@ pub struct RegisterSignatureMessage {
     /// The indexes of the won lotteries that lead to the single signatures
     #[serde(rename = "indexes")]
     pub won_indexes: Vec<LotteryIndex>,
+
+    /// Message that is signed by the signer
+    ///
+    /// Used to buffer the signature for later if the Aggregator has yet to create an open message
+    /// for the signed entity type.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub signed_message: Option<String>,
 }
 
 impl RegisterSignatureMessage {
@@ -32,6 +39,7 @@ impl RegisterSignatureMessage {
                 party_id: "party_id".to_string(),
                 signature: fake_keys::single_signature()[0].to_string(),
                 won_indexes: vec![1, 3],
+                signed_message: None,
             }
         }
     }
@@ -62,28 +70,58 @@ mod tests {
 
     use super::*;
 
-    fn golden_message() -> RegisterSignatureMessage {
+    #[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
+    pub struct RegisterSignatureMessagePrevious {
+        #[serde(rename = "entity_type")]
+        pub signed_entity_type: SignedEntityType,
+        pub party_id: PartyId,
+        pub signature: HexEncodedSingleSignature,
+        #[serde(rename = "indexes")]
+        pub won_indexes: Vec<LotteryIndex>,
+    }
+
+    fn golden_message_previous() -> RegisterSignatureMessagePrevious {
+        RegisterSignatureMessagePrevious {
+            signed_entity_type: SignedEntityType::MithrilStakeDistribution(Epoch(246)),
+            party_id: "party_id".to_string(),
+            signature: "7b227369676d61223a5b3133302c3137372c31352c3232392c32342c3235312c3234372c3137312c3139362c3231302c3134332c3131332c38362c3138392c39322c35362c3131322c33332c3139332c3231322c35342c3231342c32382c3231362c3232372c3137332c3130302c3132372c3137382c34302c39382c38372c32392c3138312c3235352c3131312c3135372c3232342c3233352c34362c3130302c3136392c3233322c3138392c3235322c38322c3133392c33365d2c22696e6465786573223a5b302c312c332c342c362c382c392c31302c31312c31322c31342c31382c32312c32322c32332c32352c32362c32372c33302c33332c33342c33382c34312c34332c35302c35382c35392c36302c36312c36322c36372c36392c37312c37332c37352c37362c37372c38312c38322c38332c38342c39302c39312c39322c39332c39372c39385d2c227369676e65725f696e646578223a327d".to_string(),
+            won_indexes: vec![1, 3],
+        }
+    }
+
+    fn golden_message_actual() -> RegisterSignatureMessage {
         RegisterSignatureMessage {
             signed_entity_type: SignedEntityType::MithrilStakeDistribution(Epoch(246)),
             party_id: "party_id".to_string(),
             signature: "7b227369676d61223a5b3133302c3137372c31352c3232392c32342c3235312c3234372c3137312c3139362c3231302c3134332c3131332c38362c3138392c39322c35362c3131322c33332c3139332c3231322c35342c3231342c32382c3231362c3232372c3137332c3130302c3132372c3137382c34302c39382c38372c32392c3138312c3235352c3131312c3135372c3232342c3233352c34362c3130302c3136392c3233322c3138392c3235322c38322c3133392c33365d2c22696e6465786573223a5b302c312c332c342c362c382c392c31302c31312c31322c31342c31382c32312c32322c32332c32352c32362c32372c33302c33332c33342c33382c34312c34332c35302c35382c35392c36302c36312c36322c36372c36392c37312c37332c37352c37362c37372c38312c38322c38332c38342c39302c39312c39322c39332c39372c39385d2c227369676e65725f696e646578223a327d".to_string(),
             won_indexes: vec![1, 3],
+            signed_message: Some("6a7e737c312972d2346b65ac3075696e04286d046dddaf8004121e3d5e27cc0d".to_string()),
         }
     }
 
-    // Test the retro compatibility with possible future upgrades.
+    const ACTUAL_JSON: &str = r#"{
+        "entity_type": { "MithrilStakeDistribution": 246 },
+        "party_id": "party_id",
+        "signature": "7b227369676d61223a5b3133302c3137372c31352c3232392c32342c3235312c3234372c3137312c3139362c3231302c3134332c3131332c38362c3138392c39322c35362c3131322c33332c3139332c3231322c35342c3231342c32382c3231362c3232372c3137332c3130302c3132372c3137382c34302c39382c38372c32392c3138312c3235352c3131312c3135372c3232342c3233352c34362c3130302c3136392c3233322c3138392c3235322c38322c3133392c33365d2c22696e6465786573223a5b302c312c332c342c362c382c392c31302c31312c31322c31342c31382c32312c32322c32332c32352c32362c32372c33302c33332c33342c33382c34312c34332c35302c35382c35392c36302c36312c36322c36372c36392c37312c37332c37352c37362c37372c38312c38322c38332c38342c39302c39312c39322c39332c39372c39385d2c227369676e65725f696e646578223a327d",
+        "indexes": [1, 3],
+        "signed_message": "6a7e737c312972d2346b65ac3075696e04286d046dddaf8004121e3d5e27cc0d"
+    }"#;
+
+    #[test]
+    fn test_actual_json_deserialized_into_previous_message() {
+        let json = ACTUAL_JSON;
+        let message: RegisterSignatureMessagePrevious = serde_json::from_str(json).unwrap();
+
+        assert_eq!(golden_message_previous(), message);
+    }
+
     #[test]
-    fn test_v1() {
-        let json = r#"{
-"entity_type": { "MithrilStakeDistribution": 246 },
-"party_id": "party_id",
-"signature":  "7b227369676d61223a5b3133302c3137372c31352c3232392c32342c3235312c3234372c3137312c3139362c3231302c3134332c3131332c38362c3138392c39322c35362c3131322c33332c3139332c3231322c35342c3231342c32382c3231362c3232372c3137332c3130302c3132372c3137382c34302c39382c38372c32392c3138312c3235352c3131312c3135372c3232342c3233352c34362c3130302c3136392c3233322c3138392c3235322c38322c3133392c33365d2c22696e6465786573223a5b302c312c332c342c362c382c392c31302c31312c31322c31342c31382c32312c32322c32332c32352c32362c32372c33302c33332c33342c33382c34312c34332c35302c35382c35392c36302c36312c36322c36372c36392c37312c37332c37352c37362c37372c38312c38322c38332c38342c39302c39312c39322c39332c39372c39385d2c227369676e65725f696e646578223a327d",
-"indexes": [1, 3]
-}"#;
+    fn test_actual_json_deserialized_into_actual_message() {
+        let json = ACTUAL_JSON;
         let message: RegisterSignatureMessage = serde_json::from_str(json).expect(
             "This JSON is expected to be successfully parsed into a RegisterSignatureMessage instance.",
         );
 
-        assert_eq!(golden_message(), message);
+        assert_eq!(golden_message_actual(), message);
     }
 }

mithril-signer/src/message_adapters/to_register_signature_message.rs

@@ -18,6 +18,7 @@ impl TryToMessageAdapter<(SignedEntityType, SingleSignatures), RegisterSignature
                 "'ToRegisterSignatureMessageAdapter' can not convert the single signature"
             })?,
             won_indexes: single_signature.won_indexes,
+            signed_message: None,
         };
 
         Ok(message)

mithril-test-lab/mithril-end-to-end/src/stress_test/payload_builder.rs

@@ -58,6 +58,7 @@ pub fn generate_register_signature_message(
             party_id: s.party_id.clone(),
             signature: s.signature.clone().to_json_hex().unwrap(),
             won_indexes: s.won_indexes.clone(),
+            signed_message: None,
         })
         .collect::<Vec<_>>()
 }