skeleton of compatibility check

crates/tweak/Cargo.toml

@@ -20,7 +20,7 @@ vergen = { workspace = true, default-features = false, features = [
 # lib
 foundry-block-explorers = { workspace = true, features = ["foundry-compilers"] }
 foundry-common.workspace = true
-# foundry-compilers = { workspace = true, features = ["full"] }
+foundry-compilers = { workspace = true, features = ["full"] }
 foundry-config.workspace = true
 foundry-evm.workspace = true
 # foundry-wallets.workspace = true
@@ -35,10 +35,10 @@ foundry-evm.workspace = true
 # revm-inspectors.workspace = true
 
 # comfy-table = "7"
-# eyre.workspace = true
+eyre.workspace = true
 # proptest = "1"
 # rayon = "1"
-# serde.workspace = true
+serde.workspace = true
 # tracing.workspace = true
 # yansi = "0.5"
 
@@ -52,7 +52,7 @@ foundry-evm.workspace = true
 
 # alloy-dyn-abi.workspace = true
 # alloy-json-abi.workspace = true
-# alloy-primitives = { workspace = true, features = ["serde"] }
+alloy-primitives = { workspace = true, features = ["serde"] }
 # alloy-rpc-types.workspace = true
 
 # async-trait = "0.1"
@@ -76,7 +76,7 @@ foundry-evm.workspace = true
 # strum = { workspace = true, features = ["derive"] }
 # thiserror = "1"
 # tokio = { version = "1", features = ["time"] }
-# toml = { version = "0.8", features = ["preserve_order"] }
+toml = { version = "0.8", features = ["preserve_order"] }
 # toml_edit = "0.21"
 # watchexec = "2.3.2"
 # evm-disassembler.workspace = true

crates/tweak/src/compatibility.rs

@@ -0,0 +1,42 @@
+//! Compatibility check of tweaking an on-chain contract with a local cloned project.
+//! The local project usually should be created by `forge clone` command.
+//! The `clone.toml` metadata file should be present in the root directory of the project.
+//! Users may modify the source code of the cloned project, but the storage layout should remain the same as the original contract.
+
+use std::path::PathBuf;
+
+use foundry_compilers::artifacts::StorageLayout;
+
+use crate::metadata::CloneMetadata;
+
+/// Check the tweak compatibility of the project with the given root.
+/// The project is compatible if:
+/// 1. the project has the `clone.toml` metadata file in the root directory, which defines its original contract on chain.
+/// 2. the project's storage layout is the same as the original contract.
+/// If the project is not compatible, an error is returned.
+pub fn check_compatibility(root: &PathBuf) -> eyre::Result<()> {
+    // the clone metadata
+    let clone_metadata = CloneMetadata::load_with_root(root).map_err(|e| {
+        eyre::eyre!("the clone metadata file (clone.toml) does not exist or is invalid: {}", e)
+    })?;
+
+    // to check the storage layout compatibility, we need to download the original contract's code from etherscan and compile.
+    let original_layout = get_original_storage_layout(&clone_metadata)?;
+    let current_layout = get_current_storage_layout(root)?;
+    check_storage_layout_compatibility(original_layout, current_layout)
+}
+
+pub fn get_original_storage_layout(_clone_metadata: &CloneMetadata) -> eyre::Result<StorageLayout> {
+    todo!()
+}
+
+pub fn get_current_storage_layout(_root: &PathBuf) -> eyre::Result<StorageLayout> {
+    todo!()
+}
+
+pub fn check_storage_layout_compatibility(
+    _original: StorageLayout,
+    _current: StorageLayout,
+) -> eyre::Result<()> {
+    todo!()
+}

crates/tweak/src/lib.rs

@@ -0,0 +1,2 @@
+pub mod compatibility;
+mod metadata;

crates/tweak/src/metadata.rs

@@ -0,0 +1,35 @@
+use std::path::PathBuf;
+
+use alloy_primitives::{Address, ChainId, TxHash};
+use eyre::Result;
+
+/// CloneMetadata stores the metadata that are not included by `foundry.toml` but necessary for a cloned contract.
+/// The metadata can be serialized to the `clone.toml` file in the cloned project root.
+/// This struct is the twin of the `CloneMetadata` struct in the `clone` command of `forge` crate.
+#[derive(Debug, Clone, serde::Deserialize)]
+pub struct CloneMetadata {
+    /// The path to the source file that contains the contract declaration.
+    /// The path is relative to the root directory of the project.
+    pub path: PathBuf,
+    /// The name of the contract in the file.
+    pub target_contract: String,
+    /// The address of the contract on the blockchian.
+    pub address: Address,
+    /// The chain id.
+    pub chain_id: ChainId,
+    /// The transaction hash of the creation transaction.
+    pub creation_transaction: TxHash,
+    /// The address of the deployer (caller of the CREATE/CREATE2).
+    pub deployer: Address,
+}
+
+impl CloneMetadata {
+    /// Load the metadata from the `clone.toml` file in the root directory of the project.
+    /// If the file does not exist, an error is returned.
+    pub fn load_with_root(root: &PathBuf) -> Result<CloneMetadata> {
+        let path = root.join("clone.toml");
+        let metadata = std::fs::read_to_string(&path)?;
+        let metadata = toml::from_str(&metadata)?;
+        Ok(metadata)
+    }
+}