snarkvm_console_program/request/input_id/
serialize.rs

1// Copyright 2024 Aleo Network Foundation
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 InputID<N> {
21    /// Serializes the input ID 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 => match self {
25                Self::Constant(id) => {
26                    let mut input = serializer.serialize_struct("InputID", 2)?;
27                    input.serialize_field("type", "constant")?;
28                    input.serialize_field("id", &id)?;
29                    input.end()
30                }
31                Self::Public(id) => {
32                    let mut input = serializer.serialize_struct("InputID", 2)?;
33                    input.serialize_field("type", "public")?;
34                    input.serialize_field("id", &id)?;
35                    input.end()
36                }
37                Self::Private(id) => {
38                    let mut input = serializer.serialize_struct("InputID", 2)?;
39                    input.serialize_field("type", "private")?;
40                    input.serialize_field("id", &id)?;
41                    input.end()
42                }
43                Self::Record(commitment, gamma, serial_number, tag) => {
44                    let mut input = serializer.serialize_struct("InputID", 5)?;
45                    input.serialize_field("type", "record")?;
46                    input.serialize_field("commitment", &commitment)?;
47                    input.serialize_field("gamma", &gamma)?;
48                    input.serialize_field("serial_number", &serial_number)?;
49                    input.serialize_field("tag", &tag)?;
50                    input.end()
51                }
52                Self::ExternalRecord(id) => {
53                    let mut input = serializer.serialize_struct("InputID", 2)?;
54                    input.serialize_field("type", "external_record")?;
55                    input.serialize_field("id", &id)?;
56                    input.end()
57                }
58            },
59            false => ToBytesSerializer::serialize_with_size_encoding(self, serializer),
60        }
61    }
62}
63
64impl<'de, N: Network> Deserialize<'de> for InputID<N> {
65    /// Deserializes the input ID from a string or bytes.
66    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
67        match deserializer.is_human_readable() {
68            true => {
69                // Parse the input ID from a string into a value.
70                let mut input = serde_json::Value::deserialize(deserializer)?;
71                // Recover the input.
72                let input_id = match input.get("type").and_then(|t| t.as_str()) {
73                    Some("constant") => InputID::Constant(DeserializeExt::take_from_value::<D>(&mut input, "id")?),
74                    Some("public") => InputID::Public(DeserializeExt::take_from_value::<D>(&mut input, "id")?),
75                    Some("private") => InputID::Private(DeserializeExt::take_from_value::<D>(&mut input, "id")?),
76                    Some("record") => InputID::Record(
77                        DeserializeExt::take_from_value::<D>(&mut input, "commitment")?,
78                        DeserializeExt::take_from_value::<D>(&mut input, "gamma")?,
79                        DeserializeExt::take_from_value::<D>(&mut input, "serial_number")?,
80                        DeserializeExt::take_from_value::<D>(&mut input, "tag")?,
81                    ),
82                    Some("external_record") => {
83                        InputID::ExternalRecord(DeserializeExt::take_from_value::<D>(&mut input, "id")?)
84                    }
85                    _ => return Err(de::Error::custom("Invalid input type")),
86                };
87                Ok(input_id)
88            }
89            false => FromBytesDeserializer::<Self>::deserialize_with_size_encoding(deserializer, "input ID"),
90        }
91    }
92}
93
94#[cfg(test)]
95mod tests {
96    use super::*;
97    use snarkvm_console_network::MainnetV0;
98
99    type CurrentNetwork = MainnetV0;
100
101    /// Add test cases here to be checked for serialization.
102    const TEST_CASES: &[&str] = &[
103        "{\"type\":\"constant\",\"id\":\"5field\"}",
104        "{\"type\":\"public\",\"id\":\"0field\"}",
105        "{\"type\":\"private\",\"id\":\"123field\"}",
106        "{\"type\":\"record\",\"commitment\":\"123123field\",\"tag\":\"0field\",\"serial_number\":\"123456789field\",\"gamma\":\"0group\"}",
107        "{\"type\":\"external_record\",\"id\":\"123456789field\"}",
108    ];
109
110    fn check_serde_json<
111        T: Serialize + for<'a> Deserialize<'a> + Debug + Display + PartialEq + Eq + FromStr + ToBytes + FromBytes,
112    >(
113        expected: T,
114    ) {
115        // Serialize
116        let expected_string = expected.to_string();
117        let candidate_string = serde_json::to_string(&expected).unwrap();
118        let candidate = serde_json::from_str::<T>(&candidate_string).unwrap();
119        assert_eq!(expected, candidate);
120        assert_eq!(expected_string, candidate_string);
121        assert_eq!(expected_string, candidate.to_string());
122
123        // Deserialize
124        assert_eq!(expected, T::from_str(&expected_string).unwrap_or_else(|_| panic!("FromStr: {expected_string}")));
125        assert_eq!(expected, serde_json::from_str(&candidate_string).unwrap());
126    }
127
128    fn check_bincode<
129        T: Serialize + for<'a> Deserialize<'a> + Debug + Display + PartialEq + Eq + FromStr + ToBytes + FromBytes,
130    >(
131        expected: T,
132    ) {
133        // Serialize
134        let expected_bytes = expected.to_bytes_le().unwrap();
135        let expected_bytes_with_size_encoding = bincode::serialize(&expected).unwrap();
136        assert_eq!(&expected_bytes[..], &expected_bytes_with_size_encoding[8..]);
137
138        // Deserialize
139        assert_eq!(expected, T::read_le(&expected_bytes[..]).unwrap());
140        assert_eq!(expected, bincode::deserialize(&expected_bytes_with_size_encoding[..]).unwrap());
141    }
142
143    #[test]
144    fn test_serde_json() {
145        for case in TEST_CASES.iter() {
146            check_serde_json(InputID::<CurrentNetwork>::from_str(case).unwrap());
147        }
148    }
149
150    #[test]
151    fn test_bincode() {
152        for case in TEST_CASES.iter() {
153            check_bincode(InputID::<CurrentNetwork>::from_str(case).unwrap());
154        }
155    }
156}
snarkvm_console_program/request/input_id/serialize.rs

snarkvm_console_program/request/input_id/
serialize.rs
