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