feat(forge): eip712 cheatcodes (#10570)

Author: 0xrusowsky

Cargo.lock

@@ -196,14 +196,13 @@ foundry-wallets = { path = "crates/wallets" }
 foundry-linking = { path = "crates/linking" }
 
 # solc & compilation utilities
-foundry-block-explorers = { version = "0.17.0", default-features = false }
-foundry-compilers = { version = "0.16.1", default-features = false }
+foundry-block-explorers = { version = "0.18.0", default-features = false }
+foundry-compilers = { version = "0.17.0", default-features = false }
 foundry-fork-db = "0.14"
 solang-parser = { version = "=0.3.8", package = "foundry-solang-parser" }
-solar-parse = { version = "=0.1.3", default-features = false }
-solar-sema = { version = "=0.1.3", default-features = false }
-solar-interface = { version = "=0.1.3", default-features = false }
-
+solar-parse = { version = "=0.1.4", default-features = false }
+solar-sema = { version = "=0.1.4", default-features = false }
+solar-interface = { version = "=0.1.4", default-features = false }
 
 ## alloy
 alloy-consensus = { version = "1.0.5", default-features = false }
@@ -229,17 +228,17 @@ alloy-transport-ipc = { version = "1.0.5", default-features = false }
 alloy-transport-ws = { version = "1.0.5", default-features = false }
 
 ## alloy-core
-alloy-dyn-abi = "1.0"
-alloy-json-abi = "1.0"
-alloy-primitives = { version = "1.0", features = [
+alloy-dyn-abi = "1.1.2"
+alloy-json-abi = "1.1.2"
+alloy-primitives = { version = "1.1.2", features = [
     "getrandom",
     "rand",
     "map-fxhash",
     "map-foldhash",
 ] }
-alloy-sol-macro-expander = "1.0"
-alloy-sol-macro-input = "1.0"
-alloy-sol-types = "1.0"
+alloy-sol-macro-expander = "1.1.2"
+alloy-sol-macro-input = "1.1.2"
+alloy-sol-types = "1.1.2"
 
 alloy-chains = "0.2"
 alloy-rlp = "0.3"
@@ -393,10 +392,5 @@ revm = { git = "https://github.com/bluealloy/revm.git", rev = "b5808253" }
 op-revm = { git = "https://github.com/bluealloy/revm.git", rev = "b5808253" }
 # revm-inspectors = { git = "https://github.com/paradigmxyz/revm-inspectors.git", rev = "a625c04" }
 
-## solar
-solar-parse = { git = "https://github.com/paradigmxyz/solar.git", branch = "dani/resolver-absolute-paths" }
-solar-sema = { git = "https://github.com/paradigmxyz/solar.git", branch = "dani/resolver-absolute-paths" }
-solar-interface = { git = "https://github.com/paradigmxyz/solar.git", branch = "dani/resolver-absolute-paths" }
-
 ## foundry
 # foundry-fork-db = { git = "https://github.com/foundry-rs/foundry-fork-db", rev = "811a61a" }

Cargo.toml

@@ -35,6 +35,7 @@ pub struct Params<T: Default> {
 /// Represents ethereum JSON-RPC API
 #[derive(Clone, Debug, serde::Deserialize)]
 #[serde(tag = "method", content = "params")]
+#[allow(clippy::large_enum_variant)]
 pub enum EthRequest {
     #[serde(rename = "web3_clientVersion", with = "empty_params")]
     Web3ClientVersion(()),
@@ -640,7 +641,7 @@ pub enum EthRequest {
 
     /// Add an address to the [`DelegationCapability`] of the wallet
     ///
-    /// [`DelegationCapability`]: wallet::DelegationCapability  
+    /// [`DelegationCapability`]: wallet::DelegationCapability
     #[serde(rename = "anvil_addCapability", with = "sequence")]
     AnvilAddCapability(Address),
 

crates/anvil/core/src/eth/mod.rs

@@ -2888,6 +2888,55 @@ interface Vm {
     /// catch (bytes memory interceptedInitcode) { initcode = interceptedInitcode; }
     #[cheatcode(group = Utilities, safety = Unsafe)]
     function interceptInitcode() external;
+
+    /// Generates the hash of the canonical EIP-712 type representation.
+    ///
+    /// Supports 2 different inputs:
+    ///  1. Name of the type (i.e. "Transaction"):
+    ///     * requires previous binding generation with `forge bind-json`.
+    ///     * bindings will be retrieved from the path configured in `foundry.toml`.
+    ///
+    ///  2. String representation of the type (i.e. "Foo(Bar bar) Bar(uint256 baz)").
+    ///     * Note: the cheatcode will output the canonical type even if the input is malformated
+    ///             with the wrong order of elements or with extra whitespaces.
+    #[cheatcode(group = Utilities)]
+    function eip712HashType(string calldata typeNameOrDefinition) external pure returns (bytes32 typeHash);
+
+    /// Generates the hash of the canonical EIP-712 type representation.
+    /// Requires previous binding generation with `forge bind-json`.
+    ///
+    /// Params:
+    ///  * `bindingsPath`: path where the output of `forge bind-json` is stored.
+    ///  * `typeName`: Name of the type (i.e. "Transaction").
+    #[cheatcode(group = Utilities)]
+    function eip712HashType(string calldata bindingsPath, string calldata typeName) external pure returns (bytes32 typeHash);
+
+    /// Generates the struct hash of the canonical EIP-712 type representation and its abi-encoded data.
+    ///
+    /// Supports 2 different inputs:
+    ///  1. Name of the type (i.e. "PermitSingle"):
+    ///     * requires previous binding generation with `forge bind-json`.
+    ///     * bindings will be retrieved from the path configured in `foundry.toml`.
+    ///
+    ///  2. String representation of the type (i.e. "Foo(Bar bar) Bar(uint256 baz)").
+    ///     * Note: the cheatcode will use the canonical type even if the input is malformated
+    ///             with the wrong order of elements or with extra whitespaces.
+    #[cheatcode(group = Utilities)]
+    function eip712HashStruct(string calldata typeNameOrDefinition, bytes calldata abiEncodedData) external pure returns (bytes32 typeHash);
+
+    /// Generates the struct hash of the canonical EIP-712 type representation and its abi-encoded data.
+    /// Requires previous binding generation with `forge bind-json`.
+    ///
+    /// Params:
+    ///  * `bindingsPath`: path where the output of `forge bind-json` is stored.
+    ///  * `typeName`: Name of the type (i.e. "PermitSingle").
+    ///  * `abiEncodedData`: ABI-encoded data for the struct that is being hashed.
+    #[cheatcode(group = Utilities)]
+    function eip712HashStruct(string calldata bindingsPath, string calldata typeName, bytes calldata abiEncodedData) external pure returns (bytes32 typeHash);
+
+    /// Generates a ready-to-sign digest of human-readable typed data following the EIP-712 standard.
+    #[cheatcode(group = Utilities)]
+    function eip712HashTypedData(string calldata jsonData) external pure returns (bytes32 digest);
 }
 }
 

crates/cheatcodes/assets/cheatcodes.json

@@ -33,6 +33,8 @@ pub struct CheatsConfig {
     pub rpc_endpoints: ResolvedRpcEndpoints,
     /// Project's paths as configured
     pub paths: ProjectPathsConfig,
+    /// Path to the directory that contains the bindings generated by `forge bind-json`.
+    pub bind_json_path: PathBuf,
     /// Filesystem permissions for cheatcodes like `writeFile`, `readFile`
     pub fs_permissions: FsPermissions,
     /// Project root
@@ -98,6 +100,7 @@ impl CheatsConfig {
             no_storage_caching: config.no_storage_caching,
             rpc_endpoints,
             paths: config.project_paths(),
+            bind_json_path: config.bind_json.out.clone(),
             fs_permissions: config.fs_permissions.clone().joined(config.root.as_ref()),
             root: config.root.clone(),
             broadcast: config.root.clone().join(&config.broadcast),
@@ -303,6 +306,7 @@ impl Default for CheatsConfig {
             paths: ProjectPathsConfig::builder().build_with_root("./"),
             fs_permissions: Default::default(),
             root: Default::default(),
+            bind_json_path: PathBuf::default().join("utils").join("jsonBindings.sol"),
             broadcast: Default::default(),
             allowed_paths: vec![],
             evm_opts: Default::default(),