mithril_common/messages/
certificate.rs

1use std::fmt::{Debug, Formatter};
2
3use anyhow::Context;
4use serde::{Deserialize, Serialize};
5
6use crate::StdError;
7use crate::entities::{
8    Certificate, CertificateMetadata, CertificateSignature, Epoch, ProtocolMessage,
9    SignedEntityType,
10};
11use crate::messages::CertificateMetadataMessagePart;
12
13/// Message structure of a certificate
14#[derive(Clone, PartialEq, Serialize, Deserialize)]
15pub struct CertificateMessage {
16    /// Hash of the current certificate
17    /// Computed from the other fields of the certificate
18    /// aka H(Cp,n))
19    pub hash: String,
20
21    /// Hash of the previous certificate in the chain
22    /// This is either the hash of the first certificate of the epoch in the chain
23    /// Or the first certificate of the previous epoch in the chain (if the certificate is the first of its epoch)
24    /// aka H(FC(n))
25    pub previous_hash: String,
26
27    /// Epoch of the Cardano chain
28    pub epoch: Epoch,
29
30    /// The signed entity type of the message.
31    /// aka BEACON(p,n)
32    pub signed_entity_type: SignedEntityType,
33
34    /// Certificate metadata
35    /// aka METADATA(p,n)
36    pub metadata: CertificateMetadataMessagePart,
37
38    /// Structured message that is used to create the signed message
39    /// aka MSG(p,n) U AVK(n-1)
40    pub protocol_message: ProtocolMessage,
41
42    /// Message that is signed by the signers
43    /// aka H(MSG(p,n) || AVK(n-1))
44    pub signed_message: String,
45
46    /// Aggregate verification key
47    /// The AVK used to sign during the current epoch
48    /// aka AVK(n-2)
49    pub aggregate_verification_key: String,
50
51    /// STM multi signature created from a quorum of single signatures from the signers
52    /// aka MULTI_SIG(H(MSG(p,n) || AVK(n-1)))
53    pub multi_signature: String,
54
55    /// Genesis signature created from the original stake distribution
56    /// aka GENESIS_SIG(AVK(-1))
57    pub genesis_signature: String,
58}
59
60impl CertificateMessage {
61    /// Check that the certificate signed message match the given protocol message.
62    pub fn match_message(&self, message: &ProtocolMessage) -> bool {
63        message.compute_hash() == self.signed_message
64    }
65}
66
67impl Debug for CertificateMessage {
68    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
69        let should_be_exhaustive = f.alternate();
70        let mut debug = f.debug_struct("Certificate");
71        debug
72            .field("hash", &self.hash)
73            .field("previous_hash", &self.previous_hash)
74            .field("epoch", &format_args!("{:?}", self.epoch))
75            .field(
76                "signed_entity_type",
77                &format_args!("{:?}", self.signed_entity_type),
78            )
79            .field("metadata", &format_args!("{:?}", self.metadata))
80            .field(
81                "protocol_message",
82                &format_args!("{:?}", self.protocol_message),
83            )
84            .field("signed_message", &self.signed_message);
85
86        match should_be_exhaustive {
87            true => debug
88                .field(
89                    "aggregate_verification_key",
90                    &self.aggregate_verification_key,
91                )
92                .field("multi_signature", &self.multi_signature)
93                .field("genesis_signature", &self.genesis_signature)
94                .finish(),
95            false => debug.finish_non_exhaustive(),
96        }
97    }
98}
99
100impl TryFrom<CertificateMessage> for Certificate {
101    type Error = StdError;
102
103    fn try_from(certificate_message: CertificateMessage) -> Result<Self, Self::Error> {
104        let metadata = CertificateMetadata {
105            network: certificate_message.metadata.network,
106            protocol_version: certificate_message.metadata.protocol_version,
107            protocol_parameters: certificate_message.metadata.protocol_parameters,
108            initiated_at: certificate_message.metadata.initiated_at,
109            sealed_at: certificate_message.metadata.sealed_at,
110            signers: certificate_message.metadata.signers,
111        };
112
113        let certificate = Certificate {
114            hash: certificate_message.hash,
115            previous_hash: certificate_message.previous_hash,
116            epoch: certificate_message.epoch,
117            metadata,
118            protocol_message: certificate_message.protocol_message,
119            signed_message: certificate_message.signed_message,
120            aggregate_verification_key: certificate_message
121                .aggregate_verification_key
122                .try_into()
123                .with_context(|| {
124                "Can not convert message to certificate: can not decode the aggregate verification key"
125            })?,
126            signature: if certificate_message.genesis_signature.is_empty() {
127                CertificateSignature::MultiSignature(
128                    certificate_message.signed_entity_type,
129                    certificate_message
130                        .multi_signature
131                        .try_into()
132                        .with_context(|| {
133                            "Can not convert message to certificate: can not decode the multi-signature"
134                        })?,
135                )
136            } else {
137                CertificateSignature::GenesisSignature(
138                    certificate_message
139                        .genesis_signature
140                        .try_into()
141                        .with_context(|| {
142                            "Can not convert message to certificate: can not decode the genesis signature"
143                        })?,
144                )
145            },
146        };
147
148        Ok(certificate)
149    }
150}
151
152impl TryFrom<Certificate> for CertificateMessage {
153    type Error = StdError;
154
155    fn try_from(certificate: Certificate) -> Result<Self, Self::Error> {
156        let signed_entity_type = certificate.signed_entity_type();
157        let metadata = CertificateMetadataMessagePart {
158            network: certificate.metadata.network,
159            protocol_version: certificate.metadata.protocol_version,
160            protocol_parameters: certificate.metadata.protocol_parameters,
161            initiated_at: certificate.metadata.initiated_at,
162            sealed_at: certificate.metadata.sealed_at,
163            signers: certificate.metadata.signers,
164        };
165
166        let (multi_signature, genesis_signature) = match certificate.signature {
167            CertificateSignature::GenesisSignature(signature) => (
168                String::new(),
169                signature.to_bytes_hex().with_context(|| {
170                    "Can not convert certificate to message: can not encode the genesis signature"
171                })?,
172            ),
173            CertificateSignature::MultiSignature(_, signature) => (
174                signature.to_json_hex().with_context(|| {
175                    "Can not convert certificate to message: can not encode the multi-signature"
176                })?,
177                String::new(),
178            ),
179        };
180
181        let message = CertificateMessage {
182            hash: certificate.hash,
183            previous_hash: certificate.previous_hash,
184            epoch: certificate.epoch,
185            signed_entity_type,
186            metadata,
187            protocol_message: certificate.protocol_message,
188            signed_message: certificate.signed_message,
189            aggregate_verification_key: certificate
190                .aggregate_verification_key
191                .to_json_hex()
192                .with_context(|| {
193                    "Can not convert certificate to message: can not encode aggregate verification key"
194                })?,
195            multi_signature,
196            genesis_signature,
197        };
198
199        Ok(message)
200    }
201}
202
203#[cfg(test)]
204mod tests {
205    use chrono::{DateTime, Utc};
206
207    use crate::entities::{
208        CardanoDbBeacon, ProtocolMessagePartKey, ProtocolParameters, StakeDistributionParty,
209    };
210
211    use super::*;
212
213    fn golden_certificate_message() -> CertificateMessage {
214        CertificateMessage {
215            hash: "hash".to_string(),
216            previous_hash: "previous_hash".to_string(),
217            epoch: Epoch(10),
218            signed_entity_type: SignedEntityType::CardanoImmutableFilesFull(CardanoDbBeacon::new(
219                *Epoch(10),
220                1728,
221            )),
222            metadata: CertificateMetadataMessagePart {
223                network: "testnet".to_string(),
224                protocol_version: "0.1.0".to_string(),
225                protocol_parameters: ProtocolParameters::new(1000, 100, 0.123),
226                initiated_at: DateTime::parse_from_rfc3339("2024-02-12T13:11:47Z")
227                    .unwrap()
228                    .with_timezone(&Utc),
229                sealed_at: DateTime::parse_from_rfc3339("2024-02-12T13:12:57Z")
230                    .unwrap()
231                    .with_timezone(&Utc),
232                signers: vec![
233                    StakeDistributionParty {
234                        party_id: "1".to_string(),
235                        stake: 10,
236                    },
237                    StakeDistributionParty {
238                        party_id: "2".to_string(),
239                        stake: 20,
240                    },
241                ],
242            },
243            protocol_message: {
244                let mut protocol_message = ProtocolMessage::new();
245                protocol_message.set_message_part(
246                    ProtocolMessagePartKey::SnapshotDigest,
247                    "snapshot-digest-123".to_string(),
248                );
249                protocol_message.set_message_part(
250                    ProtocolMessagePartKey::NextAggregateVerificationKey,
251                    "next-avk-123".to_string(),
252                );
253
254                protocol_message
255            },
256            signed_message: "signed_message".to_string(),
257            aggregate_verification_key: "aggregate_verification_key".to_string(),
258            multi_signature: "multi_signature".to_string(),
259            genesis_signature: "genesis_signature".to_string(),
260        }
261    }
262
263    mod golden_json_serialization {
264
265        use super::*;
266
267        const CURRENT_JSON: &str = r#"{
268            "hash": "hash",
269            "previous_hash": "previous_hash",
270            "epoch": 10,
271            "signed_entity_type": {
272                "CardanoImmutableFilesFull": {
273                    "epoch": 10,
274                    "immutable_file_number": 1728
275                }
276            },
277            "metadata": {
278                "network": "testnet",
279                "version": "0.1.0",
280                "parameters": {
281                    "k": 1000,
282                    "m": 100,
283                    "phi_f": 0.123
284                },
285            "initiated_at": "2024-02-12T13:11:47Z",
286            "sealed_at": "2024-02-12T13:12:57Z",
287                "signers": [
288                    {
289                        "party_id": "1",
290                        "verification_key": "7b22766b223a5b3134332c3136312c3235352c34382c37382c35372c3230342c3232302c32352c3232312c3136342c3235322c3234382c31342c35362c3132362c3138362c3133352c3232382c3138382c3134352c3138312c35322c3230302c39372c39392c3231332c34362c302c3139392c3139332c38392c3138372c38382c32392c3133352c3137332c3234342c38362c33362c38332c35342c36372c3136342c362c3133372c39342c37322c362c3130352c3132382c3132382c39332c34382c3137362c31312c342c3234362c3133382c34382c3138302c3133332c39302c3134322c3139322c32342c3139332c3131312c3134322c33312c37362c3131312c3131302c3233342c3135332c39302c3230382c3139322c33312c3132342c39352c3130322c34392c3135382c39392c35322c3232302c3136352c39342c3235312c36382c36392c3132312c31362c3232342c3139345d2c22706f70223a5b3136382c35302c3233332c3139332c31352c3133362c36352c37322c3132332c3134382c3132392c3137362c33382c3139382c3230392c34372c32382c3230342c3137362c3134342c35372c3235312c34322c32382c36362c37362c38392c39372c3135382c36332c35342c3139382c3139342c3137362c3133352c3232312c31342c3138352c3139372c3232352c3230322c39382c3234332c37342c3233332c3232352c3134332c3135312c3134372c3137372c3137302c3131372c36362c3136352c36362c36322c33332c3231362c3233322c37352c36382c3131342c3139352c32322c3130302c36352c34342c3139382c342c3136362c3130322c3233332c3235332c3234302c35392c3137352c36302c3131372c3134322c3131342c3134302c3132322c31372c38372c3131302c3138372c312c31372c31302c3139352c3135342c31332c3234392c38362c35342c3232365d7d",
291                        "stake": 10
292                    },
293                    {
294                        "party_id": "2",
295                        "verification_key": "7b22766b223a5b3134352c35362c3137352c33322c3132322c3138372c3231342c3232362c3235312c3134382c38382c392c312c3130332c3135392c3134362c38302c3136362c3130372c3234332c3235312c3233362c34312c32382c3131312c3132382c3230372c3136342c3133322c3134372c3232382c38332c3234362c3232382c3137302c36382c38392c37382c36302c32382c3132332c3133302c38382c3233342c33382c39372c34322c36352c312c3130302c35332c31382c37382c3133312c382c36312c3132322c3133312c3233382c38342c3233332c3232332c3135342c3131382c3131382c37332c32382c32372c3130312c37382c38302c3233332c3132332c3230362c3232302c3137342c3133342c3230352c37312c3131302c3131322c3138302c39372c39382c302c3131332c36392c3134352c3233312c3136382c34332c3137332c3137322c35362c3130342c3230385d2c22706f70223a5b3133372c3231342c37352c37352c3134342c3136312c3133372c37392c39342c3134302c3138312c34372c33312c38312c3231332c33312c3137312c3231362c32342c3137342c37382c3234382c3133302c37352c3235352c31312c3134352c3132342c36312c38302c3139302c32372c3231362c3130352c3130362c3234382c39312c3134332c3230342c3130322c3230332c3136322c37362c3130372c31352c35322c36312c38322c3134362c3133302c3132342c37342c382c33342c3136342c3138372c3230332c38322c36342c3130382c3139312c3138352c3138382c37372c3132322c352c3234362c3235352c3130322c3131392c3234372c3139392c3131372c36372c3234312c3134332c32392c3136382c36372c39342c3135312c37382c3132392c3133312c33302c3130312c3137332c31302c36392c36382c3137352c39382c33372c3233392c3139342c32395d7d",
296                        "stake": 20
297                    }
298                ]
299            },
300            "protocol_message": {
301                "message_parts": {
302                    "snapshot_digest": "snapshot-digest-123",
303                    "next_aggregate_verification_key": "next-avk-123"
304                }
305            },
306            "signed_message": "signed_message",
307            "aggregate_verification_key": "aggregate_verification_key",
308            "multi_signature": "multi_signature",
309            "genesis_signature": "genesis_signature"
310        }"#;
311
312        fn golden_current_message() -> CertificateMessage {
313            golden_certificate_message()
314        }
315
316        #[test]
317        fn test_current_json_deserialized_into_current_message() {
318            let json = CURRENT_JSON;
319            let message: CertificateMessage = serde_json::from_str(json).unwrap();
320
321            assert_eq!(golden_current_message(), message);
322        }
323    }
324
325    mod golden_protocol_key_encodings {
326        use super::*;
327
328        mod standard_certificate {
329            use super::*;
330
331            fn golden_message_with_json_hex_encoding() -> CertificateMessage {
332                CertificateMessage {
333                    aggregate_verification_key: "7b226d745f636f6d6d69746d656e74223a7b22726f6f74223a5b3234312c3235352c35332c3133352c3231322c3134322c33372c3131342c3133302c3131372c3135342c3230382c34392c3134352c31362c3132382c3230392c37352c3137392c32392c35392c3136352c3134352c3235302c34372c332c3233312c3134302c3137382c35302c3231322c3131345d2c226e725f6c6561766573223a342c22686173686572223a6e756c6c7d2c22746f74616c5f7374616b65223a33303337393438363730323339327d".to_string(),
334                    multi_signature: "7b227369676e617475726573223a5b5b7b227369676d61223a5b3135302c3132312c3230322c3133322c33362c34392c3230342c3137332c35392c3130322c3130382c36362c32322c3230342c3130372c3235302c36352c3136372c3230302c3233372c32312c31372c37382c3233382c34332c3232372c3234382c38392c3136362c3232322c3134352c36382c33312c3134322c3231302c3232342c3139322c3233342c38362c3134372c36362c37302c3132332c33332c39382c37372c3138382c3136375d2c22696e6465786573223a5b352c31332c32322c33312c37312c37355d2c227369676e65725f696e646578223a307d2c5b5b3135302c37362c3234362c3133302c3130352c3136372c3138372c3230372c39382c3132332c3134382c3133322c3132342c3234372c33372c3133342c32332c3137322c312c3138352c3133302c3235312c3138312c38302c36382c3137342c3131362c3139302c3231372c37312c33342c33372c3134302c3139342c3234342c3138342c3136322c3136392c3137302c37322c3139312c3138372c3232392c3136362c34372c3139362c3133392c3233332c372c38372c3232352c392c3139332c37332c3138312c3233352c35342c3135322c312c3133382c34382c3130332c36392c3230392c35322c34302c31372c32312c3134372c37332c3232352c37302c392c3233342c3233362c342c37312c33382c38392c3232352c32342c3131362c392c3133302c3139352c3139362c3233312c3133312c3230332c37372c39372c3230322c36332c3132382c3132332c3230335d2c313030393439373632393034365d5d5d2c2262617463685f70726f6f66223a7b2276616c756573223a5b5b3130312c3230302c3136392c3231322c3135312c3133352c35362c35312c3232312c3138392c3138352c3230322c3232362c3132312c3138332c36382c3135372c3132352c32342c3232332c3135312c38392c3235342c32372c32332c372c3230392c32312c3136372c3234332c322c3131345d2c5b3138352c3134312c3139392c362c3131342c3134342c3235352c37312c3138302c36342c3135332c33322c37362c372c3234392c3137342c3134312c3230302c3131382c3231312c302c31392c3232352c3134392c3133372c33362c3134312c35302c3134382c38312c3137322c3139325d5d2c22696e6469636573223a5b305d2c22686173686572223a6e756c6c7d7d".to_string(),
335                    genesis_signature: "".to_string(),
336                    ..golden_certificate_message()
337                }
338            }
339
340            fn golden_message_with_bytes_hex_encoding() -> CertificateMessage {
341                CertificateMessage {
342                    aggregate_verification_key: "20f1ff3587d48e257282759ad031911080d14bb31d3ba591fa2f03e78cb232d47204fd386b8346a11b0000".to_string(),
343                    multi_signature: "00000000000000000100000000000000d8964cf68269a7bbcf627b94847cf7258617ac01b982fbb55044ae74bed94722258cc2f4b8a2a9aa48bfbbe5a62fc48be90757e109c149b5eb3698018a306745d1342811159349e14609eaec04472659e118740982c3c4e783cb4d61ca3f807bcb000000eb0abf617600000000000000060000000000000005000000000000000d0000000000000016000000000000001f0000000000000047000000000000004b9679ca842431ccad3b666c4216cc6bfa41a7c8ed15114eee2be3f859a6de91441f8ed2e0c0ea569342467b21624dbca700000000000000000000000000000002000000000000000165c8a9d497873833ddbdb9cae279b7449d7d18df9759fe1b1707d115a7f30272b98dc7067290ff47b44099204c07f9ae8dc876d30013e19589248d329451acc00000000000000000".to_string(),
344                    genesis_signature: "".to_string(),
345                    ..golden_certificate_message()
346                }
347            }
348
349            #[test]
350            fn restorations_from_json_hex_and_bytes_hex_give_same_certificate() {
351                let certificate_from_json_hex: Certificate =
352                    golden_message_with_json_hex_encoding().try_into().unwrap();
353                let certificate_from_bytes_hex: Certificate =
354                    golden_message_with_bytes_hex_encoding().try_into().unwrap();
355
356                assert_eq!(certificate_from_json_hex, certificate_from_bytes_hex);
357            }
358        }
359
360        mod genesis_certificate {
361            use super::*;
362
363            fn golden_message_with_bytes_hex_encoding() -> CertificateMessage {
364                CertificateMessage {
365                    aggregate_verification_key: "20f1ff3587d48e257282759ad031911080d14bb31d3ba591fa2f03e78cb232d47204fd386b8346a11b0000".to_string(),
366                    multi_signature: "".to_string(),
367                    genesis_signature: "c21f77fb812a8111b547c2145d765f854ca224b17e883d6483b668a8c4d095fd893efd2a2ba1d41da9f49d82bf02d8ee603791998b64436000e49184c000170b".to_string(),
368                    ..golden_certificate_message()
369                }
370            }
371
372            #[test]
373            fn restorations_from_bytes_hex_succeeds() {
374                let _certificate_from_bytes_hex: Certificate =
375                    golden_message_with_bytes_hex_encoding().try_into().unwrap();
376            }
377        }
378    }
379}
mithril_common/messages/certificate.rs

mithril_common/messages/
certificate.rs
