feat: use foundry-cheatcodes implementations

Cargo.toml

@@ -68,13 +68,13 @@ scrypt.opt-level = 3
 # forking
 axum.opt-level = 3
 
-# Optimized release profile
-[profile.release]
-opt-level = "s"
-lto = "fat"
+# Local "release" mode, more optimized than dev but much faster to compile than release
+[profile.local]
+inherits = "dev"
+opt-level = 1
 strip = true
 panic = "abort"
-codegen-units = 1
+codegen-units = 16
 
 # Like release, but with full debug symbols and with stack unwinds. Useful for e.g. `perf`.
 [profile.debug-fast]
@@ -84,13 +84,16 @@ strip = "none"
 panic = "unwind"
 incremental = false
 
-[profile.release.package]
-# Optimize all non-workspace packages for speed
-"*".opt-level = 3
-
-# Package overrides
-foundry-evm.opt-level = 3
+# Optimized release profile
+[profile.release]
+opt-level = 3
+lto = "fat"
+strip = true
+panic = "abort"
+codegen-units = 1
 
+# Override packages which aren't perf-sensitive for faster compilation speed
+[profile.release.package]
 foundry-abi.opt-level = 1
 mdbook.opt-level = 1
 protobuf.opt-level = 1
@@ -100,47 +103,6 @@ rusoto_kms.opt-level = 1
 toml_edit.opt-level = 1
 trezor-client.opt-level = 1
 
-# Given that the `"*"` above takes precedence over the defaults for build scripts and macros, we
-# have to override all of them to reduce compile times
-syn.opt-level = 0
-prettyplease.opt-level = 0
-lalrpop.opt-level = 0
-
-ethers-contract-abigen.opt-level = 0
-ethers-contract-derive.opt-level = 0
-async-recursion.opt-level = 0
-miette-derive.opt-level = 0
-strum_macros.opt-level = 0
-enumn.opt-level = 0
-clap_derive.opt-level = 0
-serde_derive.opt-level = 0
-pear_codegen.opt-level = 0
-num_enum_derive.opt-level = 0
-scale-info-derive.opt-level = 0
-parity-scale-codec-derive.opt-level = 0
-time-macros.opt-level = 0
-phf_macros.opt-level = 0
-pin-project-internal.opt-level = 0
-auto_impl.opt-level = 0
-derive_more.opt-level = 0
-rlp-derive.opt-level = 0
-impl-trait-for-tuples.opt-level = 0
-async-trait.opt-level = 0
-tokio-macros.opt-level = 0
-tracing-attributes.opt-level = 0
-futures-macro.opt-level = 0
-thiserror-impl.opt-level = 0
-wasm-bindgen-macro-support.opt-level = 0
-wasm-bindgen-backend.opt-level = 0
-
-# Local "release" mode, more optimized than dev but much faster to compile than release
-[profile.local]
-inherits = "dev"
-opt-level = 1
-strip = true
-panic = "abort"
-codegen-units = 16
-
 [workspace.dependencies]
 anvil = { path = "crates/anvil" }
 cast = { path = "crates/cast" }

crates/abi/README.md

@@ -1,5 +1,9 @@
 # foundry-abi
 
+> [!WARNING]
+> This crate is deprecated and will be replaced with `foundry-cheatcodes` in the near future.
+> Please avoid making any changes in this crate.
+
 Contains automatically-generated Rust bindings from Solidity ABI.
 
 Additional bindings can be generated by doing the following:

crates/abi/build.rs

@@ -1,3 +1,7 @@
+//! **WARNING**
+//! This crate is deprecated and will be replaced with `foundry-cheatcodes` in the near future.
+//! Please avoid making any changes in this crate.
+
 use ethers_contract_abigen::MultiAbigen;
 
 /// Includes a JSON ABI as a string literal.

crates/abi/src/lib.rs

@@ -1,6 +1,10 @@
 //! Foundry's Solidity ABI bindings.
 //!
 //! Automatically generated by [abigen](ethers_contract::abigen).
+//!
+//! **WARNING**
+//! This crate is deprecated and will be replaced with `foundry-cheatcodes` in the near future.
+//! Please avoid making any changes in this crate.
 
 #![warn(unused_crate_dependencies)]
 

crates/cheatcodes/Cargo.toml

@@ -13,8 +13,10 @@ exclude.workspace = true
 
 [dependencies]
 foundry-macros.workspace = true
+
 alloy-primitives.workspace = true
 alloy-sol-types.workspace = true
+
 serde.workspace = true
 serde_json.workspace = true
 
@@ -23,38 +25,43 @@ schemars = { version = "0.8.15", optional = true }
 
 # impls
 foundry-common = { workspace = true, optional = true }
+foundry-compilers = { workspace = true, optional = true }
 foundry-config = { workspace = true, optional = true }
+foundry-evm-core = { workspace = true, optional = true }
 foundry-utils = { workspace = true, optional = true }
+
 alloy-dyn-abi = { workspace = true, optional = true }
 alloy-json-abi = { workspace = true, optional = true }
-ethers = { workspace = true, optional = true, features = ["ethers-solc"] }
-foundry-compilers = { workspace = true, optional = true, default-features = false }
+ethers-core = { workspace = true, optional = true }
+ethers-signers = { workspace = true, optional = true }
+ethers-providers = { workspace = true, optional = true }
+
 eyre = { workspace = true, optional = true }
-futures = { version = "0.3", optional = true }
 hex = { workspace = true, optional = true }
 itertools = { workspace = true, optional = true }
 jsonpath_lib = { workspace = true, optional = true }
 revm = { workspace = true, optional = true }
-thiserror = { version = "1", optional = true }
 tracing = { workspace = true, optional = true }
 walkdir = { version = "2", optional = true }
 
 [features]
 schema = ["dep:schemars"]
 impls = [
     "dep:foundry-common",
+    "dep:foundry-compilers",
     "dep:foundry-config",
+    "dep:foundry-evm-core",
     "dep:foundry-utils",
     "dep:alloy-dyn-abi",
     "dep:alloy-json-abi",
-    "dep:ethers",
+    "dep:ethers-core",
+    "dep:ethers-providers",
+    "dep:ethers-signers",
     "dep:eyre",
-    "dep:futures",
     "dep:hex",
     "dep:itertools",
     "dep:jsonpath_lib",
     "dep:revm",
-    "dep:thiserror",
     "dep:tracing",
     "dep:walkdir",
 ]

crates/cheatcodes/README.md

@@ -2,4 +2,40 @@
 
 Foundry cheatcodes definitions and implementations.
 
-All cheatcodes are defined in a single macro call.
+## Structure
+
+- [`assets/`](./assets/): JSON interface and specification
+- [`src/defs`](./src/defs/mod.rs): Defines traits and structs
+- [`src/impls`](./src/impls/mod.rs): Rust implementations of the cheatcodes. This is gated to the `impl` feature, since these are not needed when only using the definitions.
+
+## Overview
+
+All cheatcodes are defined in a single [`sol!`] macro call in [`src/defs/vm.rs`].
+
+This, combined with the use of an internal [`Cheatcode`](../macros/impl/src/cheatcodes.rs) derive macro,
+allows us to generate both the Rust definitions and the JSON specification of the cheatcodes.
+
+Cheatcodes are manually implemented through the `Cheatcode` trait, which is called in the
+`Cheatcodes` inspector implementation.
+
+See the [cheatcodes dev documentation](../../docs/dev/cheatcodes.md#cheatcodes-implementation) for more details.
+
+### JSON interface
+
+The JSON interface is guaranteed to be stable, and can be used by third-party tools to interact with
+the Foundry cheatcodes externally.
+
+For example, here are some tools that make use of the JSON interface:
+- Internally, this is used to generate [a simple Solidity interface](../../testdata/cheats/Vm.sol) for testing
+- (WIP) Used by [`forge-std`](https://github.com/foundry-rs/forge-std) to generate [user-friendly Solidity interfaces](https://github.com/foundry-rs/forge-std/blob/master/src/Vm.sol)
+- (WIP) Used by [the Foundry book](https://github.com/foundry-rs/book) to generate [the cheatcodes reference](https://book.getfoundry.sh/cheatcodes)
+- ...
+
+If you are making use of the JSON interface, please don't hesitate to open a PR to add your project to this list!
+
+### Adding a new cheatcode
+
+Please see the [cheatcodes dev documentation](../../docs/dev/cheatcodes.md#adding-a-new-cheatcode) on how to add new cheatcodes.
+
+[`sol!`]: https://docs.rs/alloy-sol-macro/latest/alloy_sol_macro/macro.sol.html
+[`src/defs/vm.rs`]: ./src/defs/vm.rs

crates/cheatcodes/src/defs/mod.rs

@@ -45,17 +45,12 @@ pub struct Cheatcode<'a> {
     pub description: &'a str,
 
     // Manually-specified fields.
-    /// The group this cheatcode belongs to.
-    /// Has to be specified for each cheatcode.
+    /// The group that the cheatcode belongs to.
     pub group: Group,
     /// The current status of the cheatcode. E.g. whether it is stable or experimental, etc.
-    /// Has to be specified for each cheatcode.
     pub status: Status,
     /// Whether the cheatcode is safe to use inside of scripts. E.g. it does not change state in an
     /// unexpected way.
-    ///
-    /// Defaults first to the group's safety if unspecified. If the group is ambiguous, then it
-    /// must be specified manually.
     pub safety: Safety,
 }