snarkvm_ledger_narwhal_batch_header/
serialize.rs

1// Copyright (c) 2019-2025 Provable Inc.
2// This file is part of the snarkVM library.
3
4// Licensed under the Apache License, Version 2.0 (the "License");
5// you may not use this file except in compliance with the License.
6// You may obtain a copy of the License at:
7
8// http://www.apache.org/licenses/LICENSE-2.0
9
10// Unless required by applicable law or agreed to in writing, software
11// distributed under the License is distributed on an "AS IS" BASIS,
12// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13// See the License for the specific language governing permissions and
14// limitations under the License.
15
16use super::*;
17
18impl<N: Network> Serialize for BatchHeader<N> {
19    #[inline]
20    fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
21        match serializer.is_human_readable() {
22            true => {
23                let mut header = serializer.serialize_struct("BatchHeader", 8)?;
24                header.serialize_field("batch_id", &self.batch_id)?;
25                header.serialize_field("author", &self.author)?;
26                header.serialize_field("round", &self.round)?;
27                header.serialize_field("timestamp", &self.timestamp)?;
28                header.serialize_field("committee_id", &self.committee_id)?;
29                header.serialize_field("transmission_ids", &self.transmission_ids)?;
30                header.serialize_field("previous_certificate_ids", &self.previous_certificate_ids)?;
31                header.serialize_field("signature", &self.signature)?;
32                header.end()
33            }
34            false => ToBytesSerializer::serialize_with_size_encoding(self, serializer),
35        }
36    }
37}
38
39impl<'de, N: Network> Deserialize<'de> for BatchHeader<N> {
40    #[inline]
41    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
42        match deserializer.is_human_readable() {
43            true => {
44                let mut header = serde_json::Value::deserialize(deserializer)?;
45                let batch_id: Field<N> = DeserializeExt::take_from_value::<D>(&mut header, "batch_id")?;
46
47                // Recover the header.
48                let batch_header = Self::from(
49                    DeserializeExt::take_from_value::<D>(&mut header, "author")?,
50                    DeserializeExt::take_from_value::<D>(&mut header, "round")?,
51                    DeserializeExt::take_from_value::<D>(&mut header, "timestamp")?,
52                    DeserializeExt::take_from_value::<D>(&mut header, "committee_id")?,
53                    DeserializeExt::take_from_value::<D>(&mut header, "transmission_ids")?,
54                    DeserializeExt::take_from_value::<D>(&mut header, "previous_certificate_ids")?,
55                    DeserializeExt::take_from_value::<D>(&mut header, "signature")?,
56                )
57                .map_err(de::Error::custom)?;
58
59                // Ensure that the batch ID matches the recovered header.
60                match batch_id == batch_header.batch_id() {
61                    true => Ok(batch_header),
62                    false => Err(de::Error::custom(error(format!(
63                        "Batch ID mismatch: expected {batch_id}, got {}",
64                        batch_header.batch_id()
65                    )))),
66                }
67            }
68            false => {
69                FromBytesUncheckedDeserializer::<Self>::deserialize_with_size_encoding(deserializer, "batch header")
70            }
71        }
72    }
73}
74
75#[cfg(test)]
76mod tests {
77    use super::*;
78
79    fn check_serde_json<
80        T: Serialize + for<'a> Deserialize<'a> + Debug + Display + PartialEq + Eq + FromStr + ToBytes + FromBytes,
81    >(
82        expected: T,
83    ) {
84        // Serialize
85        let expected_string = &expected.to_string();
86        let candidate_string = serde_json::to_string(&expected).unwrap();
87        assert_eq!(expected_string, &serde_json::Value::from_str(&candidate_string).unwrap().to_string());
88
89        // Deserialize
90        assert_eq!(expected, T::from_str(expected_string).unwrap_or_else(|_| panic!("FromStr: {expected_string}")));
91        assert_eq!(expected, serde_json::from_str(&candidate_string).unwrap());
92    }
93
94    fn check_bincode<T: Serialize + for<'a> Deserialize<'a> + Debug + PartialEq + Eq + ToBytes + FromBytes>(
95        expected: T,
96    ) {
97        // Serialize
98        let expected_bytes = expected.to_bytes_le().unwrap();
99        let expected_bytes_with_size_encoding = bincode::serialize(&expected).unwrap();
100        assert_eq!(&expected_bytes[..], &expected_bytes_with_size_encoding[8..]);
101
102        // Deserialize
103        assert_eq!(expected, T::read_le(&expected_bytes[..]).unwrap());
104        assert_eq!(expected, bincode::deserialize(&expected_bytes_with_size_encoding[..]).unwrap());
105    }
106
107    #[test]
108    fn test_serde_json() {
109        let rng = &mut TestRng::default();
110
111        for expected in crate::test_helpers::sample_batch_headers(rng) {
112            check_serde_json(expected);
113        }
114    }
115
116    #[test]
117    fn test_bincode() {
118        let rng = &mut TestRng::default();
119
120        for expected in crate::test_helpers::sample_batch_headers(rng) {
121            check_bincode(expected);
122        }
123    }
124}
snarkvm_ledger_narwhal_batch_header/serialize.rs

snarkvm_ledger_narwhal_batch_header/
serialize.rs
