Merge branch 'master' into adding_support_etherscan_v2

Author: iainnash

crates/cheatcodes/assets/cheatcodes.json

@@ -399,10 +399,15 @@ interface Vm {
 
     // -------- Record Storage --------
 
-    /// Records all storage reads and writes.
+    /// Records all storage reads and writes. Use `accesses` to get the recorded data.
+    /// Subsequent calls to `record` will clear the previous data.
     #[cheatcode(group = Evm, safety = Safe)]
     function record() external;
 
+    /// Stops recording storage reads and writes.
+    #[cheatcode(group = Evm, safety = Safe)]
+    function stopRecord() external;
+
     /// Gets all accessed reads and write slot from a `vm.record` session, for a given address.
     #[cheatcode(group = Evm, safety = Safe)]
     function accesses(address target) external returns (bytes32[] memory readSlots, bytes32[] memory writeSlots);

crates/cheatcodes/spec/src/vm.rs

@@ -56,6 +56,12 @@ impl RecordAccess {
         self.record_read(target, slot);
         self.writes.entry(target).or_default().push(slot);
     }
+
+    /// Clears the recorded reads and writes.
+    pub fn clear(&mut self) {
+        // Also frees memory.
+        *self = Default::default();
+    }
 }
 
 /// Records the `snapshotGas*` cheatcodes.
@@ -280,24 +286,26 @@ impl Cheatcode for dumpStateCall {
 impl Cheatcode for recordCall {
     fn apply(&self, state: &mut Cheatcodes) -> Result {
         let Self {} = self;
-        state.accesses = Some(Default::default());
+        state.recording_accesses = true;
+        state.accesses.clear();
+        Ok(Default::default())
+    }
+}
+
+impl Cheatcode for stopRecordCall {
+    fn apply(&self, state: &mut Cheatcodes) -> Result {
+        state.recording_accesses = false;
         Ok(Default::default())
     }
 }
 
 impl Cheatcode for accessesCall {
     fn apply(&self, state: &mut Cheatcodes) -> Result {
         let Self { target } = *self;
-        let result = state
-            .accesses
-            .as_mut()
-            .map(|accesses| {
-                (
-                    &accesses.reads.entry(target).or_default()[..],
-                    &accesses.writes.entry(target).or_default()[..],
-                )
-            })
-            .unwrap_or_default();
+        let result = (
+            state.accesses.reads.entry(target).or_default().as_slice(),
+            state.accesses.writes.entry(target).or_default().as_slice(),
+        );
         Ok(result.abi_encode_params())
     }
 }

crates/cheatcodes/src/evm.rs

@@ -420,7 +420,10 @@ pub struct Cheatcodes {
     pub fork_revert_diagnostic: Option<RevertDiagnostic>,
 
     /// Recorded storage reads and writes
-    pub accesses: Option<RecordAccess>,
+    pub accesses: RecordAccess,
+
+    /// Whether storage access recording is currently active
+    pub recording_accesses: bool,
 
     /// Recorded account accesses (calls, creates) organized by relative call depth, where the
     /// topmost vector corresponds to accesses at the depth at which account access recording
@@ -538,6 +541,7 @@ impl Cheatcodes {
             assume_no_revert: Default::default(),
             fork_revert_diagnostic: Default::default(),
             accesses: Default::default(),
+            recording_accesses: Default::default(),
             recorded_account_diffs_stack: Default::default(),
             recorded_logs: Default::default(),
             record_debug_steps_info: Default::default(),
@@ -1332,7 +1336,7 @@ impl Inspector<&mut dyn DatabaseExt> for Cheatcodes {
         }
 
         // `record`: record storage reads and writes.
-        if self.accesses.is_some() {
+        if self.recording_accesses {
             self.record_accesses(interpreter);
         }
 
@@ -1945,7 +1949,7 @@ impl Cheatcodes {
     /// Records storage slots reads and writes.
     #[cold]
     fn record_accesses(&mut self, interpreter: &mut Interpreter) {
-        let Some(access) = &mut self.accesses else { return };
+        let access = &mut self.accesses;
         match interpreter.current_opcode() {
             op::SLOAD => {
                 let key = try_or_return!(interpreter.stack().peek(0));

crates/cheatcodes/src/inspector.rs

@@ -523,6 +523,9 @@ pub struct Config {
     #[serde(default)]
     pub compilation_restrictions: Vec<CompilationRestrictions>,
 
+    /// Whether to enable script execution protection.
+    pub script_execution_protection: bool,
+
     /// PRIVATE: This structure may grow, As such, constructing this structure should
     /// _always_ be done using a public constructor or update syntax:
     ///
@@ -2412,6 +2415,7 @@ impl Default for Config {
             additional_compiler_profiles: Default::default(),
             compilation_restrictions: Default::default(),
             eof: false,
+            script_execution_protection: true,
             _non_exhaustive: (),
         }
     }

crates/config/src/lib.rs

@@ -258,7 +258,7 @@ impl Executor {
     }
 
     #[inline]
-    pub fn set_script(&mut self, script_address: Address) {
+    pub fn set_script_execution(&mut self, script_address: Address) {
         self.inspector_mut().script(script_address);
     }
 

crates/evm/evm/src/executors/mod.rs

@@ -169,6 +169,7 @@ forgetest!(can_extract_config_values, |prj, cmd| {
         additional_compiler_profiles: Default::default(),
         compilation_restrictions: Default::default(),
         eof: false,
+        script_execution_protection: true,
         _non_exhaustive: (),
     };
     prj.write_config(input.clone());
@@ -1041,6 +1042,7 @@ transaction_timeout = 120
 eof = false
 additional_compiler_profiles = []
 compilation_restrictions = []
+script_execution_protection = true
 
 [profile.default.rpc_storage_caching]
 chains = "all"
@@ -1298,7 +1300,8 @@ exclude = []
   "transaction_timeout": 120,
   "eof": false,
   "additional_compiler_profiles": [],
-  "compilation_restrictions": []
+  "compilation_restrictions": [],
+  "script_execution_protection": true
 }
 
 "#]]);

crates/forge/tests/cli/config.rs

@@ -2668,6 +2668,17 @@ Error: Usage of `address(this)` detected in script contract. Script contracts ar
 Error: script failed: <empty revert data>
 ...
 
+"#]]);
+
+    // Disable script protection.
+    prj.update_config(|config| {
+        config.script_execution_protection = false;
+    });
+    cmd.assert_success().stdout_eq(str![[r#"
+...
+Script ran successfully.
+...
+
 "#]]);
 });
 

crates/forge/tests/cli/script.rs

@@ -144,9 +144,8 @@ impl PreExecutionState {
             &self.build_data.predeploy_libraries,
             self.execution_data.bytecode.clone(),
             needs_setup(&self.execution_data.abi),
-            self.script_config.sender_nonce,
+            &self.script_config,
             self.args.broadcast,
-            self.script_config.evm_opts.fork_url.is_none(),
         )?;
 
         if setup_result.success {

crates/script/src/execute.rs

@@ -1,4 +1,4 @@
-use super::ScriptResult;
+use super::{ScriptConfig, ScriptResult};
 use crate::build::ScriptPredeployLibraries;
 use alloy_eips::eip7702::SignedAuthorization;
 use alloy_primitives::{Address, Bytes, TxKind, U256};
@@ -33,9 +33,8 @@ impl ScriptRunner {
         libraries: &ScriptPredeployLibraries,
         code: Bytes,
         setup: bool,
-        sender_nonce: u64,
+        script_config: &ScriptConfig,
         is_broadcast: bool,
-        need_create2_deployer: bool,
     ) -> Result<(Address, ScriptResult)> {
         trace!(target: "script", "executing setUP()");
 
@@ -45,11 +44,12 @@ impl ScriptRunner {
                 self.executor.set_balance(self.evm_opts.sender, U256::MAX)?;
             }
 
-            if need_create2_deployer {
+            if script_config.evm_opts.fork_url.is_none() {
                 self.executor.deploy_create2_deployer()?;
             }
         }
 
+        let sender_nonce = script_config.sender_nonce;
         self.executor.set_nonce(self.evm_opts.sender, sender_nonce)?;
 
         // We max out their balance so that they can deploy and make calls.
@@ -158,7 +158,9 @@ impl ScriptRunner {
         }
 
         // set script address to be used by execution inspector
-        self.executor.set_script(address);
+        if script_config.config.script_execution_protection {
+            self.executor.set_script_execution(address);
+        }
 
         traces.extend(constructor_traces.map(|traces| (TraceKind::Deployment, traces)));
 

crates/script/src/runner.rs

@@ -4,7 +4,7 @@ set -eo pipefail
 # NOTE: if you make modifications to this script, please increment the version number.
 # Major / minor: incremented for each stable release of Foundry.
 # Patch: incremented for each change between stable releases.
-FOUNDRYUP_INSTALLER_VERSION="1.0.1"
+FOUNDRYUP_INSTALLER_VERSION="1.1.0"
 
 BASE_DIR=${XDG_CONFIG_HOME:-$HOME}
 FOUNDRY_DIR=${FOUNDRY_DIR:-"$BASE_DIR/.foundry"}
@@ -118,7 +118,7 @@ main() {
     PLATFORM=$(tolower "${FOUNDRYUP_PLATFORM:-$uname_s}")
     EXT="tar.gz"
     case $PLATFORM in
-      linux) ;;
+      linux|alpine) ;;
       darwin|mac*)
         PLATFORM="darwin"
         ;;
@@ -272,7 +272,7 @@ OPTIONS:
     -p, --path      Build and install a local repository
     -j, --jobs      Number of CPUs to use for building Foundry (default: all CPUs)
     --arch          Install a specific architecture (supports amd64 and arm64)
-    --platform      Install a specific platform (supports win32, linux, and darwin)
+    --platform      Install a specific platform (supports win32, linux, darwin and alpine)
 EOF
 }
 

foundryup/foundryup

@@ -53,4 +53,44 @@ contract RecordTest is DSTest {
         assertEq(innerWrites.length, 1, "number of nested writes is incorrect");
         assertEq(innerWrites[0], bytes32(uint256(2)), "key for nested write is incorrect");
     }
+
+    function testStopRecordAccess() public {
+        RecordAccess target = new RecordAccess();
+
+        // Start recording
+        vm.record();
+        NestedRecordAccess inner = target.record();
+
+        // Verify Records
+        (bytes32[] memory reads, bytes32[] memory writes) = vm.accesses(address(target));
+
+        assertEq(reads.length, 2, "number of reads is incorrect");
+        assertEq(reads[0], bytes32(uint256(1)), "key for read 0 is incorrect");
+        assertEq(reads[1], bytes32(uint256(1)), "key for read 1 is incorrect");
+
+        assertEq(writes.length, 1, "number of writes is incorrect");
+        assertEq(writes[0], bytes32(uint256(1)), "key for write is incorrect");
+
+        vm.stopRecord();
+        inner = target.record();
+
+        // Verify that there are no new Records
+        (reads, writes) = vm.accesses(address(target));
+
+        assertEq(reads.length, 2, "number of reads is incorrect");
+        assertEq(reads[0], bytes32(uint256(1)), "key for read 0 is incorrect");
+        assertEq(reads[1], bytes32(uint256(1)), "key for read 1 is incorrect");
+
+        assertEq(writes.length, 1, "number of writes is incorrect");
+        assertEq(writes[0], bytes32(uint256(1)), "key for write is incorrect");
+
+        vm.record();
+        vm.stopRecord();
+
+        // verify reset all records
+        (reads, writes) = vm.accesses(address(target));
+
+        assertEq(reads.length, 0, "number of reads is incorrect");
+        assertEq(writes.length, 0, "number of writes is incorrect");
+    }
 }