snarkvm_console_program/request/
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 Request<N> {
21    /// Serializes the request 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 request = serializer.serialize_struct("Request", 12)?;
26                request.serialize_field("signer", &self.signer)?;
27                request.serialize_field("network", &self.network_id)?;
28                request.serialize_field("program", &self.program_id)?;
29                request.serialize_field("function", &self.function_name)?;
30                request.serialize_field("input_ids", &self.input_ids)?;
31                request.serialize_field("inputs", &self.inputs)?;
32                request.serialize_field("signature", &self.signature)?;
33                request.serialize_field("sk_tag", &self.sk_tag)?;
34                request.serialize_field("tvk", &self.tvk)?;
35                request.serialize_field("tcm", &self.tcm)?;
36                request.serialize_field("scm", &self.scm)?;
37                request.serialize_field("is_dynamic", &self.is_dynamic)?;
38                request.end()
39            }
40            false => ToBytesSerializer::serialize_with_size_encoding(self, serializer),
41        }
42    }
43}
44
45impl<'de, N: Network> Deserialize<'de> for Request<N> {
46    /// Deserializes the request from a string or bytes.
47    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
48        match deserializer.is_human_readable() {
49            true => {
50                // Parse the request from a string into a value.
51                let mut request = serde_json::Value::deserialize(deserializer)?;
52
53                // Recover the request.
54                Ok(Self::from((
55                    // Retrieve the signer.
56                    DeserializeExt::take_from_value::<D>(&mut request, "signer")?,
57                    // Retrieve the network ID.
58                    DeserializeExt::take_from_value::<D>(&mut request, "network")?,
59                    // Retrieve the program ID.
60                    DeserializeExt::take_from_value::<D>(&mut request, "program")?,
61                    // Retrieve the function name.
62                    DeserializeExt::take_from_value::<D>(&mut request, "function")?,
63                    // Retrieve the input IDs.
64                    DeserializeExt::take_from_value::<D>(&mut request, "input_ids")?,
65                    // Retrieve the inputs.
66                    DeserializeExt::take_from_value::<D>(&mut request, "inputs")?,
67                    // Retrieve the signature.
68                    DeserializeExt::take_from_value::<D>(&mut request, "signature")?,
69                    // Retrieve the `sk_tag`.
70                    DeserializeExt::take_from_value::<D>(&mut request, "sk_tag")?,
71                    // Retrieve the `tvk`.
72                    DeserializeExt::take_from_value::<D>(&mut request, "tvk")?,
73                    // Retrieve the `tcm`.
74                    DeserializeExt::take_from_value::<D>(&mut request, "tcm")?,
75                    // Retrieve the `scm`.
76                    DeserializeExt::take_from_value::<D>(&mut request, "scm")?,
77                    // Retrieve the `is_dynamic` flag. V1 requests don't have this field, default to false.
78                    DeserializeExt::take_from_value::<D>(&mut request, "is_dynamic").unwrap_or(false),
79                )))
80            }
81            false => FromBytesDeserializer::<Self>::deserialize_with_size_encoding(deserializer, "request"),
82        }
83    }
84}
85
86#[cfg(test)]
87mod tests {
88    use super::*;
89
90    #[test]
91    fn test_serde_json() -> Result<()> {
92        let mut rng = TestRng::default();
93
94        for expected in test_helpers::sample_requests(&mut rng).into_iter() {
95            // Serialize
96            let expected_string = &expected.to_string();
97            let candidate_string = serde_json::to_string(&expected)?;
98
99            // Deserialize
100            assert_eq!(expected, Request::from_str(expected_string)?);
101            assert_eq!(expected, serde_json::from_str(&candidate_string)?);
102        }
103        Ok(())
104    }
105
106    #[test]
107    fn test_bincode() {
108        let mut rng = TestRng::default();
109
110        for expected in test_helpers::sample_requests(&mut rng).into_iter() {
111            // Serialize
112            let expected_bytes = expected.to_bytes_le().unwrap();
113            let expected_bytes_with_size_encoding = bincode::serialize(&expected).unwrap();
114            assert_eq!(&expected_bytes[..], &expected_bytes_with_size_encoding[8..]);
115
116            // Deserialize
117            assert_eq!(expected, Request::read_le(&expected_bytes[..]).unwrap());
118            assert_eq!(expected, bincode::deserialize(&expected_bytes_with_size_encoding).unwrap());
119        }
120    }
121}
snarkvm_console_program/request/serialize.rs

snarkvm_console_program/request/
serialize.rs
