Implement custom generic deserialization

vm/src/types/builtin_name.rs

@@ -3,6 +3,32 @@ use serde::{Deserialize, Serialize};
 #[cfg(all(feature = "arbitrary", feature = "std"))]
 use arbitrary::{self, Arbitrary};
 
+const OUTPUT_BUILTIN_NAME: &str = "output";
+const HASH_BUILTIN_NAME: &str = "pedersen";
+const RANGE_CHECK_BUILTIN_NAME: &str = "range_check";
+const RANGE_CHECK_96_BUILTIN_NAME: &str = "range_check_96";
+const SIGNATURE_BUILTIN_NAME: &str = "ecdsa";
+const BITWISE_BUILTIN_NAME: &str = "bitwise";
+const EC_OP_BUILTIN_NAME: &str = "ec_op";
+const KECCAK_BUILTIN_NAME: &str = "keccak";
+const POSEIDON_BUILTIN_NAME: &str = "poseidon";
+const SEGMENT_ARENA_BUILTIN_NAME: &str = "segment_arena";
+const ADD_MOD_BUILTIN_NAME: &str = "add_mod";
+const MUL_MOD_BUILTIN_NAME: &str = "mul_mod";
+
+const OUTPUT_BUILTIN_NAME_WITH_SUFFIX: &str = "output_builtin";
+const HASH_BUILTIN_NAME_WITH_SUFFIX: &str = "pedersen_builtin";
+const RANGE_CHECK_BUILTIN_NAME_WITH_SUFFIX: &str = "range_check_builtin";
+const RANGE_CHECK_96_BUILTIN_NAME_WITH_SUFFIX: &str = "range_check_96_builtin";
+const SIGNATURE_BUILTIN_NAME_WITH_SUFFIX: &str = "ecdsa_builtin";
+const BITWISE_BUILTIN_NAME_WITH_SUFFIX: &str = "bitwise_builtin";
+const EC_OP_BUILTIN_NAME_WITH_SUFFIX: &str = "ec_op_builtin";
+const KECCAK_BUILTIN_NAME_WITH_SUFFIX: &str = "keccak_builtin";
+const POSEIDON_BUILTIN_NAME_WITH_SUFFIX: &str = "poseidon_builtin";
+const SEGMENT_ARENA_BUILTIN_NAME_WITH_SUFFIX: &str = "segment_arena_builtin";
+const ADD_MOD_BUILTIN_NAME_WITH_SUFFIX: &str = "add_mod_builtin";
+const MUL_MOD_BUILTIN_NAME_WITH_SUFFIX: &str = "mul_mod_builtin";
+
 // This enum is used to deserialize program builtins into &str and catch non-valid names
 #[cfg_attr(all(feature = "arbitrary", feature = "std"), derive(Arbitrary))]
 #[derive(Serialize, Deserialize, Debug, PartialEq, Copy, Clone, Eq, Hash)]
@@ -23,39 +49,57 @@ pub enum BuiltinName {
 }
 
 impl BuiltinName {
-    pub fn to_str_with_suffix(&self) -> &'static str {
+    pub const fn to_str_with_suffix(&self) -> &'static str {
         match self {
-            BuiltinName::output => "output_builtin",
-            BuiltinName::range_check => "range_check_builtin",
-            BuiltinName::pedersen => "pedersen_builtin",
-            BuiltinName::ecdsa => "ecdsa_builtin",
-            BuiltinName::keccak => "keccak_builtin",
-            BuiltinName::bitwise => "bitwise_builtin",
-            BuiltinName::ec_op => "ec_op_builtin",
-            BuiltinName::poseidon => "poseidon_builtin",
-            BuiltinName::segment_arena => "segment_arena_builtin",
-            BuiltinName::range_check96 => "range_check96_builtin",
-            BuiltinName::add_mod => "add_mod_builtin",
-            BuiltinName::mul_mod => "mul_mod_builtin",
+            BuiltinName::output => OUTPUT_BUILTIN_NAME_WITH_SUFFIX,
+            BuiltinName::range_check => RANGE_CHECK_BUILTIN_NAME_WITH_SUFFIX,
+            BuiltinName::pedersen => HASH_BUILTIN_NAME_WITH_SUFFIX,
+            BuiltinName::ecdsa => SIGNATURE_BUILTIN_NAME_WITH_SUFFIX,
+            BuiltinName::keccak => KECCAK_BUILTIN_NAME_WITH_SUFFIX,
+            BuiltinName::bitwise => BITWISE_BUILTIN_NAME_WITH_SUFFIX,
+            BuiltinName::ec_op => EC_OP_BUILTIN_NAME_WITH_SUFFIX,
+            BuiltinName::poseidon => POSEIDON_BUILTIN_NAME_WITH_SUFFIX,
+            BuiltinName::segment_arena => SEGMENT_ARENA_BUILTIN_NAME_WITH_SUFFIX,
+            BuiltinName::range_check96 => RANGE_CHECK_96_BUILTIN_NAME_WITH_SUFFIX,
+            BuiltinName::add_mod => ADD_MOD_BUILTIN_NAME_WITH_SUFFIX,
+            BuiltinName::mul_mod => MUL_MOD_BUILTIN_NAME_WITH_SUFFIX,
         }
     }
 }
 
 impl BuiltinName {
     pub fn to_str(&self) -> &'static str {
         match self {
-            BuiltinName::output => "output",
-            BuiltinName::range_check => "range_check",
-            BuiltinName::pedersen => "pedersen",
-            BuiltinName::ecdsa => "ecdsa",
-            BuiltinName::keccak => "keccak",
-            BuiltinName::bitwise => "bitwise",
-            BuiltinName::ec_op => "ec_op",
-            BuiltinName::poseidon => "poseidon",
-            BuiltinName::segment_arena => "segment_arena",
-            BuiltinName::range_check96 => "range_check96",
-            BuiltinName::add_mod => "add_mod",
-            BuiltinName::mul_mod => "mul_mod",
+            BuiltinName::output => OUTPUT_BUILTIN_NAME,
+            BuiltinName::range_check => RANGE_CHECK_BUILTIN_NAME,
+            BuiltinName::pedersen => HASH_BUILTIN_NAME,
+            BuiltinName::ecdsa => SIGNATURE_BUILTIN_NAME,
+            BuiltinName::keccak => KECCAK_BUILTIN_NAME,
+            BuiltinName::bitwise => BITWISE_BUILTIN_NAME,
+            BuiltinName::ec_op => EC_OP_BUILTIN_NAME,
+            BuiltinName::poseidon => POSEIDON_BUILTIN_NAME,
+            BuiltinName::segment_arena => SEGMENT_ARENA_BUILTIN_NAME,
+            BuiltinName::range_check96 => RANGE_CHECK_96_BUILTIN_NAME,
+            BuiltinName::add_mod => ADD_MOD_BUILTIN_NAME,
+            BuiltinName::mul_mod => MUL_MOD_BUILTIN_NAME,
+        }
+    }
+
+    pub(crate) fn from_suffixed_string(suffixed_str: &String) -> Option<Self> {
+        match suffixed_str.as_str() {
+            OUTPUT_BUILTIN_NAME_WITH_SUFFIX => Some(BuiltinName::output),
+            RANGE_CHECK_BUILTIN_NAME_WITH_SUFFIX => Some(BuiltinName::range_check),
+            HASH_BUILTIN_NAME_WITH_SUFFIX => Some(BuiltinName::pedersen),
+            SIGNATURE_BUILTIN_NAME_WITH_SUFFIX => Some(BuiltinName::ecdsa),
+            KECCAK_BUILTIN_NAME_WITH_SUFFIX => Some(BuiltinName::keccak),
+            BITWISE_BUILTIN_NAME_WITH_SUFFIX => Some(BuiltinName::bitwise),
+            EC_OP_BUILTIN_NAME_WITH_SUFFIX => Some(BuiltinName::ec_op),
+            POSEIDON_BUILTIN_NAME_WITH_SUFFIX => Some(BuiltinName::poseidon),
+            SEGMENT_ARENA_BUILTIN_NAME_WITH_SUFFIX => Some(BuiltinName::segment_arena),
+            RANGE_CHECK_96_BUILTIN_NAME_WITH_SUFFIX => Some(BuiltinName::range_check96),
+            ADD_MOD_BUILTIN_NAME_WITH_SUFFIX => Some(BuiltinName::add_mod),
+            MUL_MOD_BUILTIN_NAME_WITH_SUFFIX => Some(BuiltinName::mul_mod),
+            _ => None,
         }
     }
 }
@@ -68,10 +112,10 @@ impl core::fmt::Display for BuiltinName {
 
 pub(crate) mod serde_impl {
     use super::BuiltinName;
-    use serde::{Serializer, Serialize, ser::SerializeMap};
     use crate::stdlib::collections::HashMap;
+    use serde::{de::Error, ser::SerializeMap, Deserialize, Deserializer, Serialize, Serializer};
 
-    pub fn serialize_builtin_name_map_with_suffix<S, V>(
+    pub fn serialize<S, V>(
         values: &HashMap<BuiltinName, V>,
         serializer: S,
     ) -> Result<S::Ok, S::Error>
@@ -81,8 +125,20 @@ pub(crate) mod serde_impl {
     {
         let mut map_serializer = serializer.serialize_map(Some(values.len()))?;
         for (key, val) in values {
-                map_serializer.serialize_entry(key.to_str_with_suffix(), val)?
-            }
+            map_serializer.serialize_entry(key.to_str_with_suffix(), val)?
+        }
         map_serializer.end()
     }
+
+    pub fn deserialize<'de, D: Deserializer<'de>, V: Deserialize<'de>>(
+        d: D,
+    ) -> Result<HashMap<BuiltinName, V>, D::Error> {
+        // First deserialize keys into String
+        let map = HashMap::<String, V>::deserialize(d)?;
+        // Then match keys to BuiltinName and handle invalid names
+        map.into_iter()
+            .map(|(k, v)| BuiltinName::from_suffixed_string(&k).map(|k| (k, v)))
+            .collect::<Option<HashMap<_, _>>>()
+            .ok_or(D::Error::custom("Invalid builtin name"))
+    }
 }

vm/src/vm/runners/cairo_pie.rs

@@ -73,7 +73,7 @@ pub struct CairoPie {
     pub metadata: CairoPieMetadata,
     pub memory: CairoPieMemory,
     pub execution_resources: ExecutionResources,
-    #[serde(serialize_with = "crate::types::builtin_name::serde_impl::serialize_builtin_name_map_with_suffix")]
+    #[serde(with = "crate::types::builtin_name::serde_impl")]
     pub additional_data: HashMap<BuiltinName, BuiltinAdditionalData>,
     pub version: CairoPieVersion,
 }

vm/src/vm/runners/cairo_runner.rs

@@ -1529,7 +1529,7 @@ pub struct SegmentInfo {
 pub struct ExecutionResources {
     pub n_steps: usize,
     pub n_memory_holes: usize,
-    #[serde(serialize_with = "crate::types::builtin_name::serde_impl::serialize_builtin_name_map_with_suffix")]
+    #[serde(with = "crate::types::builtin_name::serde_impl")]
     pub builtin_instance_counter: HashMap<BuiltinName, usize>,
 }