feat(cheatcodes): additional random cheatcodes to aid in symbolic testing

Author: grandizzy

crates/cheatcodes/Cargo.toml

@@ -65,6 +65,4 @@ thiserror.workspace = true
 toml = { workspace = true, features = ["preserve_order"] }
 tracing.workspace = true
 walkdir.workspace = true
-
-[dev-dependencies]
 proptest.workspace = true

crates/cheatcodes/assets/cheatcodes.json

@@ -2297,15 +2297,18 @@ interface Vm {
     function ensNamehash(string calldata name) external pure returns (bytes32);
 
     /// Returns a random uint256 value.
-    #[cheatcode(group = Utilities)]
+    /// `randomUint` is being deprecated in favor of `arbitraryUint`. It will be removed in future versions.
+    #[cheatcode(group = Utilities, status = Deprecated)]
     function randomUint() external returns (uint256);
 
     /// Returns random uin256 value between the provided range (=min..=max).
-    #[cheatcode(group = Utilities)]
+    /// `randomUint` is being deprecated in favor of `arbitraryUint`. It will be removed in future versions.
+    #[cheatcode(group = Utilities, status = Deprecated)]
     function randomUint(uint256 min, uint256 max) external returns (uint256);
 
     /// Returns a random `address`.
-    #[cheatcode(group = Utilities)]
+    /// `randomAddress` is being deprecated in favor of `arbitraryAddress`. It will be removed in future versions
+    #[cheatcode(group = Utilities, status = Deprecated)]
     function randomAddress() external returns (address);
 
     /// Pauses collection of call traces. Useful in cases when you want to skip tracing of
@@ -2324,6 +2327,39 @@ interface Vm {
     /// Utility cheatcode to set arbitrary storage for given target address.
     #[cheatcode(group = Utilities)]
     function setArbitraryStorage(address target) external;
+
+    /// Returns an arbitrary `uint256` value.
+    #[cheatcode(group = Utilities)]
+    function arbitraryUint() external view returns (uint256);
+
+    /// Returns an arbitrary `uint256` value between the provided range (=min..=max).
+    /// `randomUint` is being deprecated in favor of `arbitraryUint`. It will be removed in future versions.
+    #[cheatcode(group = Utilities)]
+    function arbitraryUint(uint256 min, uint256 max) external view returns (uint256);
+
+    /// Returns an arbitrary `uint256` value of given bits.
+    #[cheatcode(group = Utilities)]
+    function arbitraryUint(uint256 bits) external view returns (uint256);
+
+    /// Returns an arbitrary `int256` value.
+    #[cheatcode(group = Utilities)]
+    function arbitraryInt() external view returns (int256);
+
+    /// Returns an arbitrary `int256` value of given bits.
+    #[cheatcode(group = Utilities)]
+    function arbitraryInt(uint256 bits) external view returns (int256);
+
+    /// Returns an arbitrary `address`.
+    #[cheatcode(group = Utilities)]
+    function arbitraryAddress() external view returns (address);
+
+    /// Returns an arbitrary `bool`.
+    #[cheatcode(group = Utilities)]
+    function arbitraryBool() external view returns (bool);
+
+    /// Returns an arbitrary byte array value of the given length.
+    #[cheatcode(group = Utilities)]
+    function arbitraryBytes(uint256 len) external view returns (bytes memory);
 }
 }
 

crates/cheatcodes/spec/src/vm.rs

@@ -96,7 +96,7 @@ impl Cheatcode for loadCall {
             if ccx.state.has_arbitrary_storage(&target) {
                 // If storage slot is untouched and load from a target with arbitrary storage,
                 // then set random value for current slot.
-                let rand_value = ccx.state.rng().gen();
+                let rand_value = ccx.state.test_runner().rng().gen();
                 ccx.state.arbitrary_storage.as_mut().unwrap().save(
                     ccx.ecx,
                     target,
@@ -108,7 +108,7 @@ impl Cheatcode for loadCall {
                 // If storage slot is untouched and load from a target that copies storage from
                 // a source address with arbitrary storage, then copy existing arbitrary value.
                 // If no arbitrary value generated yet, then the random one is saved and set.
-                let rand_value = ccx.state.rng().gen();
+                let rand_value = ccx.state.test_runner().rng().gen();
                 val.data = ccx.state.arbitrary_storage.as_mut().unwrap().copy(
                     ccx.ecx,
                     target,

crates/cheatcodes/src/evm.rs

@@ -34,7 +34,8 @@ use foundry_evm_core::{
 };
 use foundry_evm_traces::TracingInspector;
 use itertools::Itertools;
-use rand::{rngs::StdRng, Rng, SeedableRng};
+use proptest::test_runner::{RngAlgorithm, TestRng, TestRunner};
+use rand::Rng;
 use revm::{
     interpreter::{
         opcode as op, CallInputs, CallOutcome, CallScheme, CreateInputs, CreateOutcome,
@@ -439,8 +440,8 @@ pub struct Cheatcodes {
     /// `char -> (address, pc)`
     pub breakpoints: Breakpoints,
 
-    /// Optional RNG algorithm.
-    rng: Option<StdRng>,
+    /// Optional cheatcodes `TestRunner`.
+    test_runner: Option<TestRunner>,
 
     /// Ignored traces.
     pub ignored_traces: IgnoredTraces,
@@ -488,7 +489,7 @@ impl Cheatcodes {
             mapping_slots: Default::default(),
             pc: Default::default(),
             breakpoints: Default::default(),
-            rng: Default::default(),
+            test_runner: Default::default(),
             ignored_traces: Default::default(),
             arbitrary_storage: Default::default(),
         }
@@ -1064,10 +1065,13 @@ impl Cheatcodes {
         None
     }
 
-    pub fn rng(&mut self) -> &mut impl Rng {
-        self.rng.get_or_insert_with(|| match self.config.seed {
-            Some(seed) => StdRng::from_seed(seed.to_be_bytes::<32>()),
-            None => StdRng::from_entropy(),
+    pub fn test_runner(&mut self) -> &mut TestRunner {
+        self.test_runner.get_or_insert_with(|| match self.config.seed {
+            Some(seed) => TestRunner::new_with_rng(
+                proptest::test_runner::Config::default(),
+                TestRng::from_seed(RngAlgorithm::ChaCha, &seed.to_be_bytes::<32>()),
+            ),
+            None => TestRunner::new(proptest::test_runner::Config::default()),
         })
     }
 
@@ -1598,15 +1602,15 @@ impl Cheatcodes {
 
         if value.is_cold && value.data.is_zero() {
             if self.has_arbitrary_storage(&target_address) {
-                let arbitrary_value = self.rng().gen();
+                let arbitrary_value = self.test_runner().rng().gen();
                 self.arbitrary_storage.as_mut().unwrap().save(
                     &mut ecx.inner,
                     target_address,
                     key,
                     arbitrary_value,
                 );
             } else if self.is_arbitrary_storage_copy(&target_address) {
-                let arbitrary_value = self.rng().gen();
+                let arbitrary_value = self.test_runner().rng().gen();
                 self.arbitrary_storage.as_mut().unwrap().copy(
                     &mut ecx.inner,
                     target_address,