feat: foundry-cheatcodes #5998

DaniPopes · 2023-10-05T22:35:45Z

Statically define all cheatcodes by leveraging Alloy and traits (for internal use) with a stable JSON schema (for external and third party use).

TODO

In follow-up

~~Integrate with foundry-evm~~
~~Implement warnings and errors for deprecated and removed cheatcodes respectively~~
~~Write up some docs on how it works and how to add new cheatcodes~~

crates/cheatcodes/Cargo.toml

mds1

I know it's a draft but left a few small comments, lgtm overall though

mds1 · 2023-10-06T00:19:41Z

crates/cheatcodes/src/defs/mod.rs

+    /// The cheatcode's identifier. Corresponds to the function's name,
+    /// thus is not unique if the function is overloaded.
+    pub id: &'a str,


Why not just use one of the signature fields, or equivalently the selector, as the ID so the ID can be unique? Or if there's no benefit to uniqueness, maybe we can remove this field?

Changed to use the ID generated by the macro, which is name, or <name>_<index> when overloaded
Can remove, but I don't think it hurts

mds1 · 2023-10-06T00:22:56Z

crates/cheatcodes/src/defs/mod.rs

+    /// The full Solidity function signature, including parameter names, visibility, etc.
+    /// This is just for reference, and is identical to the function declaration.
+    pub full_signature: &'a str,
+    // TODO: add visibility, state mutability...?


All will have visibility of external, but for mutability here's the way we define when to use pure vs. view vs. neither in forge-std: https://github.com/foundry-rs/forge-std/blob/f73c73d2018eb6a111f35e4dae7b4f27401e9421/src/Vm.sol#L6-L10. Might be useful to include a visibility field in the schema for consistency—there's been some recent PRs correcting visibility of cheats in forge-std that probably didn't make it upstream to foundry

Added here d68edfb

crates/cheatcodes/src/defs/mod.rs

Evalir · 2023-10-06T03:49:39Z

crates/cheatcodes/src/defs/mod.rs

+    pub selector: &'a str,
+    /// The description of the cheatcode.
+    /// This is a markdown string derived from the documentation of the function declaration.
+    /// Empty when the function has no documentation.


We should probably enforce all fns to be documented, though.

We can leave this to the compiler with missing_docs

Actually no, we can't do that because it triggers on struct fields (function params); I'll add it as a nightly-only warning (gets caught in clippy CI)

gotcha this sounds good—having us reviewing + nightly warning should be enough for now! if not, we can always come back and document later

crates/cheatcodes/src/defs/mod.rs

crates/cheatcodes/src/impls/mod.rs

mattsse

love this direction.

this is so much better

gakonst

overall love this direction and incredible work. what should we do with the json defs? probably need a nice way to incorporate in the book? i also assume this PR will have a bunch of removed old cheatcode code once fully migrated

gakonst · 2023-10-11T00:28:54Z

crates/cheatcodes/src/impls/evm/fork.rs

+use super::{Cheatcode, CheatsCtxt, DatabaseExt, Result};
+use crate::{impls::CreateFork, Cheatcodes, Vm::*};
+
+impl Cheatcode for activeForkCall {


Should these be capitalized in alloy codegen?

I don't think it should modify names by default, and instead have a rename_all like Serde (not implemented yet)

I remember that implementing this in abigen was also a bit painful to get right

gakonst · 2023-10-11T00:30:54Z

crates/macros/impl/src/cheatcodes.rs

+/// Returns `(signature, hex_selector, declaration, description)` from a given `sol!`-generated
+/// docstring for a function.
+///
+/// # Examples
+///
+/// The following docstring (string literals are joined with newlines):
+/// ```text
+/// "Function with signature `foo(uint256)` and selector `0x1234abcd`."
+/// "```solidity"
+/// "function foo(uint256 x) external view returns (bool y);"
+/// "```"
+/// "Description of the function."
+/// ```
+///
+/// Will return:
+/// ```text
+/// (
+///     "foo(uint256)",
+///     "0x1234abcd",
+///     "function foo(uint256 x) external view returns (bool y);",
+///     "Description of the function."
+/// )
+/// ```
+fn func_docstring(doc: &str) -> (&str, &str, &str, &str) {


should this be upstreamed

This is just a hack to get information between sol! internals and cheatcode macro internals, I figured it's good enough to rely on internally. I don't think it should be exposed anywhere

gakonst · 2023-10-11T00:31:30Z

crates/macros/impl/src/cheatcodes.rs

+        /// All the cheatcodes in [this contract](self).
+        pub const CHEATCODES: &'static [&'static Cheatcode<'static>] = &[#(<#variant_tys as CheatcodeDef>::CHEATCODE,)*];


is there some type magic behind why this is const &'static?

Each cheatcode defines its own &Cheatcode and this aggregates them without having a separate copy of the static data by being &[&T] instead of &[T].
const X: &'static T I think is kind of like static X: T

gakonst · 2023-10-11T00:38:34Z

crates/cheatcodes/src/impls/string.rs

+    fn apply(&self, _state: &mut Cheatcodes) -> Result {
+        let Self { value } = self;
+        Ok(value.to_string().abi_encode())
+    }


generally love this pattern

gakonst · 2023-10-11T00:41:55Z

crates/cheatcodes/src/defs/vm.rs

+    /// Gets the label for the specified address.
+    #[cheatcode(group = Utilities)]
+    function getLabel(address account) external returns (string memory currentLabel);
+}


i love this usage of the sol! macro showcasing derive macro composition with the cheatcode macro, beautiful. had not appreciated how mayn cheats we have now

Evalir

Man, we have a lot of cheatcodes.

I love this direction—just a few comments but so far so good

Evalir · 2023-10-16T10:48:13Z

crates/cheatcodes/src/defs/mod.rs

+    pub selector: &'a str,
+    /// The description of the cheatcode.
+    /// This is a markdown string derived from the documentation of the function declaration.
+    /// Empty when the function has no documentation.


gotcha this sounds good—having us reviewing + nightly warning should be enough for now! if not, we can always come back and document later

Evalir · 2023-10-16T11:25:15Z

crates/cheatcodes/src/impls/config.rs

@@ -8,11 +8,19 @@ use foundry_config::{
 };
 use std::path::{Path, PathBuf};

+// TODO
+#[derive(Clone, Debug, Default)]
+pub struct EvmOpts {


hm, this is because we need Config and related structs to be on alloy types right? Might tie in with #5986, but this is a cumbersome/significant refactor

It's that EvmOpts is in evm and we need it before in cheatcodes

yeah, one reason why we need a few more crates so we can get rid of circular deps

mattsse

this looks really good, I like this direction a lot.

this is a great first step.
after #5986 we can restructure the evm crate and finally get rid of some mess here.

but since this only adds a new crate we can merge now to reduce conflicts.

mattsse · 2023-10-17T17:18:07Z

crates/cheatcodes/src/impls/config.rs

@@ -8,11 +8,19 @@ use foundry_config::{
 };
 use std::path::{Path, PathBuf};

+// TODO
+#[derive(Clone, Debug, Default)]
+pub struct EvmOpts {


yeah, one reason why we need a few more crates so we can get rid of circular deps

mattsse · 2023-10-17T17:18:58Z

crates/cheatcodes/src/impls/evm/fork.rs

+use super::{Cheatcode, CheatsCtxt, DatabaseExt, Result};
+use crate::{impls::CreateFork, Cheatcodes, Vm::*};
+
+impl Cheatcode for activeForkCall {


I remember that implementing this in abigen was also a bit painful to get right

DaniPopes requested review from gakonst, mattsse and Evalir October 5, 2023 22:35

Evalir reviewed Oct 5, 2023

View reviewed changes

crates/cheatcodes/Cargo.toml Outdated Show resolved Hide resolved

mds1 reviewed Oct 6, 2023

View reviewed changes

Evalir reviewed Oct 6, 2023

View reviewed changes

mattsse reviewed Oct 9, 2023

View reviewed changes

crates/cheatcodes/src/impls/mod.rs Outdated Show resolved Hide resolved

mattsse reviewed Oct 9, 2023

View reviewed changes

gakonst reviewed Oct 11, 2023

View reviewed changes

Evalir reviewed Oct 16, 2023

View reviewed changes

This was referenced Oct 16, 2023

Display parameter name alongside value if present in call traces #6048

Closed

feat(deps): Move to Alloy ABI encoding/decoding & alloy types #5986

Merged

DaniPopes force-pushed the alloy-cheatcodes2 branch from 836eff3 to 547bf51 Compare October 17, 2023 16:57

feat: foundry-cheatcodes

ee8b30c

DaniPopes force-pushed the alloy-cheatcodes2 branch from 80ce86b to ee8b30c Compare October 17, 2023 17:03

DaniPopes marked this pull request as ready for review October 17, 2023 17:08

DaniPopes changed the title ~~refactor: stable cheatcodes~~ refactor: foundry-cheatcodes Oct 17, 2023

DaniPopes changed the title ~~refactor: foundry-cheatcodes~~ feat: foundry-cheatcodes Oct 17, 2023

mattsse approved these changes Oct 17, 2023

View reviewed changes

DaniPopes merged commit ee5d02c into foundry-rs:master Oct 17, 2023
17 checks passed

DaniPopes deleted the alloy-cheatcodes2 branch October 17, 2023 17:26

DaniPopes mentioned this pull request Oct 17, 2023

modularize foundry-evm #6052

Closed

Evalir mentioned this pull request Oct 25, 2023

Remove precompiles! macro #6102

Closed

DaniPopes mentioned this pull request Oct 26, 2023

feat: use foundry-cheatcodes implementations #6131

Merged

DaniPopes mentioned this pull request Dec 20, 2023

feat: automatically generate Vm.sol from cheatcodes.json foundry-rs/forge-std#487

Merged

This was referenced Jun 28, 2024

scripting: vm.startBroadcast() in setUp() increases nonce by 1 #4197

Closed

Display parameter name alongside value if present in call traces paradigmxyz/revm-inspectors#158

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: foundry-cheatcodes #5998

feat: foundry-cheatcodes #5998

DaniPopes commented Oct 5, 2023 •

edited

Loading

mds1 left a comment

mds1 Oct 6, 2023

DaniPopes Oct 6, 2023

mds1 Oct 6, 2023

DaniPopes Oct 7, 2023

Evalir Oct 6, 2023

DaniPopes Oct 7, 2023

DaniPopes Oct 9, 2023 •

edited

Loading

Evalir Oct 16, 2023

mattsse left a comment

gakonst left a comment •

edited

Loading

gakonst Oct 11, 2023

DaniPopes Oct 11, 2023

mattsse Oct 17, 2023

gakonst Oct 11, 2023

DaniPopes Oct 11, 2023 •

edited

Loading

gakonst Oct 11, 2023

DaniPopes Oct 11, 2023 •

edited

Loading

gakonst Oct 11, 2023

gakonst Oct 11, 2023

Evalir left a comment

Evalir Oct 16, 2023

Evalir Oct 16, 2023

DaniPopes Oct 16, 2023

mattsse Oct 17, 2023

mattsse left a comment

mattsse Oct 17, 2023

mattsse Oct 17, 2023

		/// All the cheatcodes in [this contract](self).
		pub const CHEATCODES: &'static [&'static Cheatcode<'static>] = &[#(<#variant_tys as CheatcodeDef>::CHEATCODE,)*];

feat: foundry-cheatcodes #5998

feat: foundry-cheatcodes #5998

Conversation

DaniPopes commented Oct 5, 2023 • edited Loading

TODO

mds1 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DaniPopes Oct 9, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mattsse left a comment

Choose a reason for hiding this comment

gakonst left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DaniPopes Oct 11, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DaniPopes Oct 11, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Evalir left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mattsse left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DaniPopes commented Oct 5, 2023 •

edited

Loading

DaniPopes Oct 9, 2023 •

edited

Loading

gakonst left a comment •

edited

Loading

DaniPopes Oct 11, 2023 •

edited

Loading

DaniPopes Oct 11, 2023 •

edited

Loading