snarkvm_ledger_narwhal_batch_certificate/
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 BatchCertificate<N> {
19    /// Serializes the batch certificate to a JSON-string or buffer.
20    fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
21        match serializer.is_human_readable() {
22            true => {
23                let mut state = serializer.serialize_struct("BatchCertificate", 2)?;
24                state.serialize_field("batch_header", &self.batch_header)?;
25                state.serialize_field("signatures", &self.signatures)?;
26                state.end()
27            }
28            false => ToBytesSerializer::serialize_with_size_encoding(self, serializer),
29        }
30    }
31}
32
33impl<'de, N: Network> Deserialize<'de> for BatchCertificate<N> {
34    /// Deserializes the batch certificate from a JSON-string or buffer.
35    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
36        match deserializer.is_human_readable() {
37            true => {
38                let mut value = serde_json::Value::deserialize(deserializer)?;
39                Self::from(
40                    DeserializeExt::take_from_value::<D>(&mut value, "batch_header")?,
41                    DeserializeExt::take_from_value::<D>(&mut value, "signatures")?,
42                )
43                .map_err(de::Error::custom)
44            }
45            false => FromBytesDeserializer::<Self>::deserialize_with_size_encoding(deserializer, "batch certificate"),
46        }
47    }
48}
49
50#[cfg(test)]
51mod tests {
52    use super::*;
53
54    fn check_serde_json<
55        T: Serialize + for<'a> Deserialize<'a> + Debug + Display + PartialEq + Eq + FromStr + ToBytes + FromBytes,
56    >(
57        expected: T,
58    ) {
59        // Serialize
60        let expected_string = expected.to_string();
61        let candidate_string = serde_json::to_string(&expected).unwrap();
62        let candidate = serde_json::from_str::<T>(&candidate_string).unwrap();
63        assert_eq!(expected, candidate);
64        assert_eq!(expected_string, candidate_string);
65        assert_eq!(expected_string, candidate.to_string());
66
67        // Deserialize
68        assert_eq!(expected, T::from_str(&expected_string).unwrap_or_else(|_| panic!("FromStr: {expected_string}")));
69        assert_eq!(expected, serde_json::from_str(&candidate_string).unwrap());
70    }
71
72    fn check_bincode<
73        T: Serialize + for<'a> Deserialize<'a> + Debug + Display + PartialEq + Eq + FromStr + ToBytes + FromBytes,
74    >(
75        expected: T,
76    ) {
77        // Serialize
78        let expected_bytes = expected.to_bytes_le().unwrap();
79        let expected_bytes_with_size_encoding = bincode::serialize(&expected).unwrap();
80        assert_eq!(&expected_bytes[..], &expected_bytes_with_size_encoding[8..]);
81
82        // Deserialize
83        assert_eq!(expected, T::read_le(&expected_bytes[..]).unwrap());
84        assert_eq!(expected, bincode::deserialize(&expected_bytes_with_size_encoding[..]).unwrap());
85    }
86
87    #[test]
88    fn test_serde_json() {
89        let rng = &mut TestRng::default();
90
91        for expected in crate::test_helpers::sample_batch_certificates(rng) {
92            check_serde_json(expected);
93        }
94    }
95
96    #[test]
97    fn test_bincode() {
98        let rng = &mut TestRng::default();
99
100        for expected in crate::test_helpers::sample_batch_certificates(rng) {
101            check_bincode(expected);
102        }
103    }
104}
snarkvm_ledger_narwhal_batch_certificate/serialize.rs

snarkvm_ledger_narwhal_batch_certificate/
serialize.rs
