feat: support cairo 2.x abi (#424)

Author: xJonathanLEI

starknet-core/src/types/contract/mod.rs

@@ -89,6 +89,10 @@ pub enum AbiEntry {
     Event(AbiEvent),
     Struct(AbiStruct),
     Enum(AbiEnum),
+    Constructor(AbiConstructor),
+    Impl(AbiImpl),
+    Interface(AbiInterface),
+    L1Handler(AbiFunction),
 }
 
 #[derive(Debug, Clone, Serialize, Deserialize)]
@@ -126,18 +130,71 @@ pub struct AbiFunction {
 
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
-pub struct AbiEvent {
+#[serde(untagged)]
+pub enum AbiEvent {
+    /// Cairo 2.x ABI event entry
+    Typed(TypedAbiEvent),
+    /// Cairo 1.x ABI event entry
+    Untyped(UntypedAbiEvent),
+}
+
+#[derive(Debug, Clone, Deserialize)]
+#[serde(tag = "kind", rename_all = "snake_case")]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
+pub enum TypedAbiEvent {
+    Struct(AbiEventStruct),
+    Enum(AbiEventEnum),
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
+pub struct UntypedAbiEvent {
     pub name: String,
     pub inputs: Vec<AbiNamedMember>,
 }
 
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
+pub struct AbiEventStruct {
+    pub name: String,
+    pub members: Vec<EventField>,
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
+pub struct AbiEventEnum {
+    pub name: String,
+    pub variants: Vec<EventField>,
+}
+
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct AbiStruct {
     pub name: String,
     pub members: Vec<AbiNamedMember>,
 }
 
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
+pub struct AbiConstructor {
+    pub name: String,
+    pub inputs: Vec<AbiNamedMember>,
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
+pub struct AbiImpl {
+    pub name: String,
+    pub interface_name: String,
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
+pub struct AbiInterface {
+    pub name: String,
+    pub items: Vec<AbiEntry>,
+}
+
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct AbiEnum {
@@ -158,13 +215,29 @@ pub struct AbiOutput {
     pub r#type: String,
 }
 
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
+pub struct EventField {
+    pub name: String,
+    pub r#type: String,
+    pub kind: EventFieldKind,
+}
+
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[serde(rename_all = "snake_case")]
 pub enum StateMutability {
     External,
     View,
 }
 
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[serde(rename_all = "snake_case")]
+pub enum EventFieldKind {
+    Key,
+    Data,
+    Nested,
+}
+
 #[derive(Debug, thiserror::Error)]
 pub enum ComputeClassHashError {
     #[error("invalid builtin name")]
@@ -370,6 +443,47 @@ impl<'de> Deserialize<'de> for PythonicHint {
     }
 }
 
+// Manually implementing this so we can put `kind` in the middle:
+impl Serialize for TypedAbiEvent {
+    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
+    where
+        S: Serializer,
+    {
+        #[derive(Serialize)]
+        struct StructRef<'a> {
+            name: &'a str,
+            kind: &'static str,
+            members: &'a [EventField],
+        }
+
+        #[derive(Serialize)]
+        struct EnumRef<'a> {
+            name: &'a str,
+            kind: &'static str,
+            variants: &'a [EventField],
+        }
+
+        match self {
+            TypedAbiEvent::Struct(inner) => StructRef::serialize(
+                &StructRef {
+                    name: &inner.name,
+                    kind: "struct",
+                    members: &inner.members,
+                },
+                serializer,
+            ),
+            TypedAbiEvent::Enum(inner) => EnumRef::serialize(
+                &EnumRef {
+                    name: &inner.name,
+                    kind: "enum",
+                    variants: &inner.variants,
+                },
+                serializer,
+            ),
+        }
+    }
+}
+
 fn hash_sierra_entrypoints(entrypoints: &[SierraEntryPoint]) -> FieldElement {
     let mut hasher = PoseidonHasher::new();
 
@@ -394,10 +508,11 @@ mod tests {
     #[test]
     #[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
     fn test_sierra_class_deser() {
-        // Artifacts generated from cairo v1.0.0-rc0
         for raw_artifact in [
             include_str!("../../../test-data/contracts/cairo1/artifacts/abi_types_sierra.txt"),
             include_str!("../../../test-data/contracts/cairo1/artifacts/erc20_sierra.txt"),
+            include_str!("../../../test-data/contracts/cairo2/artifacts/abi_types_sierra.txt"),
+            include_str!("../../../test-data/contracts/cairo2/artifacts/erc20_sierra.txt"),
         ]
         .into_iter()
         {
@@ -411,10 +526,11 @@ mod tests {
     #[test]
     #[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
     fn test_compiled_class_deser() {
-        // Artifacts generated from cairo v1.0.0-rc0
         for raw_artifact in [
             include_str!("../../../test-data/contracts/cairo1/artifacts/abi_types_compiled.txt"),
             include_str!("../../../test-data/contracts/cairo1/artifacts/erc20_compiled.txt"),
+            include_str!("../../../test-data/contracts/cairo2/artifacts/abi_types_compiled.txt"),
+            include_str!("../../../test-data/contracts/cairo2/artifacts/erc20_compiled.txt"),
         ]
         .into_iter()
         {
@@ -448,6 +564,14 @@ mod tests {
                 include_str!("../../../test-data/contracts/cairo1/artifacts/abi_types_sierra.txt"),
                 include_str!("../../../test-data/contracts/cairo1/artifacts/abi_types.hashes.json"),
             ),
+            (
+                include_str!("../../../test-data/contracts/cairo2/artifacts/erc20_sierra.txt"),
+                include_str!("../../../test-data/contracts/cairo2/artifacts/erc20.hashes.json"),
+            ),
+            (
+                include_str!("../../../test-data/contracts/cairo2/artifacts/abi_types_sierra.txt"),
+                include_str!("../../../test-data/contracts/cairo2/artifacts/abi_types.hashes.json"),
+            ),
         ]
         .into_iter()
         {
@@ -475,6 +599,16 @@ mod tests {
                 ),
                 include_str!("../../../test-data/contracts/cairo1/artifacts/abi_types.hashes.json"),
             ),
+            (
+                include_str!("../../../test-data/contracts/cairo2/artifacts/erc20_compiled.txt"),
+                include_str!("../../../test-data/contracts/cairo2/artifacts/erc20.hashes.json"),
+            ),
+            (
+                include_str!(
+                    "../../../test-data/contracts/cairo2/artifacts/abi_types_compiled.txt"
+                ),
+                include_str!("../../../test-data/contracts/cairo2/artifacts/abi_types.hashes.json"),
+            ),
         ]
         .into_iter()
         {

starknet-core/test-data/contracts/cairo2/artifacts/abi_types.hashes.json

@@ -0,0 +1,4 @@
+{
+  "sierra_class_hash": "0x61ec4af0e7b12eda8f79d7dc20014f6bba883938a16c1a10d300e88e38ff255",
+  "compiled_class_hash": "0x6a1254307a13eb075103df104e7055f3f61e3a7de3afa2acae77a4acc102de4"
+}