factor out solc JSON interface crate (#264)

The differential testing framework will make a second consumer. There seems to be no re-usable Rust crate for this. But we already have everything here, just needs a small refactor to make it fully re-usable. - Mostly decouple the solc JSON-input-output interface types from the `solidity` frontend crate - Expose the JSON-input-output interface types in a dedicated crate --------- Signed-off-by: Cyrill Leutwiler <bigcyrill@hotmail.com>
2026-06-15 17:21:09 +00:00 · 2025-03-20 17:11:40 +01:00
parent 36ea69b50f
commit 497dae2494
45 changed files with 328 additions and 245 deletions
@@ -0,0 +1,72 @@
+//! The `solc --combined-json` contract.
+
+use std::collections::BTreeMap;
+use std::collections::HashSet;
+
+use serde::Deserialize;
+use serde::Serialize;
+
+/// The contract.
+#[derive(Debug, Serialize, Deserialize)]
+#[serde(rename_all = "kebab-case")]
+pub struct Contract {
+    /// The `solc` hashes output.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub hashes: Option<BTreeMap<String, String>>,
+    /// The `solc` ABI output.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub abi: Option<serde_json::Value>,
+    /// The `solc` metadata output.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub metadata: Option<String>,
+    /// The `solc` developer documentation output.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub devdoc: Option<serde_json::Value>,
+    /// The `solc` user documentation output.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub userdoc: Option<serde_json::Value>,
+    /// The `solc` storage layout output.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub storage_layout: Option<serde_json::Value>,
+    /// The `solc` AST output.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub ast: Option<serde_json::Value>,
+    /// The `solc` assembly output.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub asm: Option<serde_json::Value>,
+    /// The `solc` hexadecimal binary output.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub bin: Option<String>,
+    /// The `solc` hexadecimal binary runtime part output.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub bin_runtime: Option<String>,
+    /// The factory dependencies.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub factory_deps: Option<BTreeMap<String, String>>,
+    /// The missing libraries.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub missing_libraries: Option<HashSet<String>>,
+}
+
+impl Contract {
+    /// Returns the signature hash of the specified contract entry.
+    /// # Panics
+    /// If the hashes have not been requested in the `solc` call.
+    pub fn entry(&self, entry: &str) -> u32 {
+        self.hashes
+            .as_ref()
+            .expect("Always exists")
+            .iter()
+            .find_map(|(contract_entry, hash)| {
+                if contract_entry.starts_with(entry) {
+                    Some(
+                        u32::from_str_radix(hash.as_str(), revive_common::BASE_HEXADECIMAL)
+                            .expect("Test hash is always valid"),
+                    )
+                } else {
+                    None
+                }
+            })
+            .unwrap_or_else(|| panic!("Entry `{entry}` not found"))
+    }
+}