snarkvm_console_program/state_path/transition_leaf/
serialize.rs

1// Copyright (c) 2019-2026 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
18use snarkvm_utilities::DeserializeExt;
19
20impl<N: Network> Serialize for TransitionLeaf<N> {
21    /// Serializes the leaf into string or bytes.
22    fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
23        match serializer.is_human_readable() {
24            true => {
25                let mut leaf = serializer.serialize_struct("TransitionLeaf", 4)?;
26                leaf.serialize_field("version", &self.version)?;
27                leaf.serialize_field("index", &self.index)?;
28                leaf.serialize_field("variant", &self.variant)?;
29                leaf.serialize_field("id", &self.id)?;
30                leaf.end()
31            }
32            false => ToBytesSerializer::serialize_with_size_encoding(self, serializer),
33        }
34    }
35}
36
37impl<'de, N: Network> Deserialize<'de> for TransitionLeaf<N> {
38    /// Deserializes the leaf from a string or bytes.
39    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
40        match deserializer.is_human_readable() {
41            true => {
42                // Parse the leaf from a string into a value.
43                let mut leaf = serde_json::Value::deserialize(deserializer)?;
44                // Recover the leaf.
45                Self::from(
46                    // Retrieve the version.
47                    DeserializeExt::take_from_value::<D>(&mut leaf, "version")?,
48                    // Retrieve the index.
49                    DeserializeExt::take_from_value::<D>(&mut leaf, "index")?,
50                    // Retrieve the variant.
51                    DeserializeExt::take_from_value::<D>(&mut leaf, "variant")?,
52                    // Retrieve the id.
53                    DeserializeExt::take_from_value::<D>(&mut leaf, "id")?,
54                )
55                .map_err(de::Error::custom)
56            }
57            false => FromBytesDeserializer::<Self>::deserialize_with_size_encoding(deserializer, "transition leaf"),
58        }
59    }
60}
61
62#[cfg(test)]
63mod tests {
64    use super::*;
65
66    #[test]
67    fn test_serde_json() -> Result<()> {
68        let mut rng = TestRng::default();
69
70        // Sample a static leaf (version 1).
71        let expected = test_helpers::sample_leaf(&mut rng);
72
73        // Serialize
74        let expected_string = &expected.to_string();
75        let candidate_string = serde_json::to_string(&expected)?;
76        assert_eq!(expected, serde_json::from_str(&candidate_string)?);
77
78        // Deserialize
79        assert_eq!(expected, TransitionLeaf::from_str(expected_string)?);
80        assert_eq!(expected, serde_json::from_str(&candidate_string)?);
81
82        // Sample a dynamic leaf (version 2).
83        let expected_dynamic = test_helpers::sample_dynamic_leaf(&mut rng);
84
85        // Serialize
86        let expected_dynamic_string = &expected_dynamic.to_string();
87        let candidate_dynamic_string = serde_json::to_string(&expected_dynamic)?;
88        assert_eq!(expected_dynamic, serde_json::from_str(&candidate_dynamic_string)?);
89
90        // Deserialize
91        assert_eq!(expected_dynamic, TransitionLeaf::from_str(expected_dynamic_string)?);
92        assert_eq!(expected_dynamic, serde_json::from_str(&candidate_dynamic_string)?);
93
94        Ok(())
95    }
96
97    #[test]
98    fn test_bincode() -> Result<()> {
99        let mut rng = TestRng::default();
100
101        // Sample a static leaf (version 1).
102        let expected = test_helpers::sample_leaf(&mut rng);
103
104        // Serialize
105        let expected_bytes = expected.to_bytes_le()?;
106        let expected_bytes_with_size_encoding = bincode::serialize(&expected)?;
107        assert_eq!(&expected_bytes[..], &expected_bytes_with_size_encoding[8..]);
108
109        // Deserialize
110        assert_eq!(expected, TransitionLeaf::read_le(&expected_bytes[..])?);
111        assert_eq!(expected, bincode::deserialize(&expected_bytes_with_size_encoding[..])?);
112
113        // Sample a dynamic leaf (version 2).
114        let expected_dynamic = test_helpers::sample_dynamic_leaf(&mut rng);
115
116        // Serialize
117        let expected_dynamic_bytes = expected_dynamic.to_bytes_le()?;
118        let expected_dynamic_bytes_with_size_encoding = bincode::serialize(&expected_dynamic)?;
119        assert_eq!(&expected_dynamic_bytes[..], &expected_dynamic_bytes_with_size_encoding[8..]);
120
121        // Deserialize
122        assert_eq!(expected_dynamic, TransitionLeaf::read_le(&expected_dynamic_bytes[..])?);
123        assert_eq!(expected_dynamic, bincode::deserialize(&expected_dynamic_bytes_with_size_encoding[..])?);
124
125        Ok(())
126    }
127}
snarkvm_console_program/state_path/transition_leaf/serialize.rs

snarkvm_console_program/state_path/transition_leaf/
serialize.rs
