foundry_cheatcodes/
utils.rs

1//! Implementations of [`Utilities`](spec::Group::Utilities) cheatcodes.
2
3use crate::{Cheatcode, Cheatcodes, CheatcodesExecutor, CheatsCtxt, Result, Vm::*};
4use alloy_dyn_abi::{DynSolType, DynSolValue, Resolver, TypedData, eip712_parser::EncodeType};
5use alloy_ens::namehash;
6use alloy_primitives::{B64, Bytes, I256, U256, aliases::B32, keccak256, map::HashMap};
7use alloy_rlp::{Decodable, Encodable};
8use alloy_sol_types::SolValue;
9use foundry_common::{TYPE_BINDING_PREFIX, fs};
10use foundry_config::fs_permissions::FsAccessKind;
11use foundry_evm_core::{constants::DEFAULT_CREATE2_DEPLOYER, evm::FoundryEvmNetwork};
12use foundry_evm_fuzz::strategies::BoundMutator;
13use proptest::prelude::Strategy;
14use rand::{Rng, RngCore, seq::SliceRandom};
15use revm::context::{ContextTr, JournalTr};
16use std::path::PathBuf;
17
18/// Contains locations of traces ignored via cheatcodes.
19///
20/// The way we identify location in traces is by (node_idx, item_idx) tuple where node_idx is an
21/// index of a call trace node, and item_idx is a value between 0 and `node.ordering.len()` where i
22/// represents point after ith item, and 0 represents the beginning of the node trace.
23#[derive(Debug, Default, Clone)]
24pub struct IgnoredTraces {
25    /// Mapping from (start_node_idx, start_item_idx) to (end_node_idx, end_item_idx) representing
26    /// ranges of trace nodes to ignore.
27    pub ignored: HashMap<(usize, usize), (usize, usize)>,
28    /// Keeps track of (start_node_idx, start_item_idx) of the last `vm.pauseTracing` call.
29    pub last_pause_call: Option<(usize, usize)>,
30}
31
32impl Cheatcode for labelCall {
33    fn apply<FEN: FoundryEvmNetwork>(&self, state: &mut Cheatcodes<FEN>) -> Result {
34        let Self { account, newLabel } = self;
35        state.labels.insert(*account, newLabel.clone());
36        Ok(Default::default())
37    }
38}
39
40impl Cheatcode for getLabelCall {
41    fn apply<FEN: FoundryEvmNetwork>(&self, state: &mut Cheatcodes<FEN>) -> Result {
42        let Self { account } = self;
43        Ok(match state.labels.get(account) {
44            Some(label) => label.abi_encode(),
45            None => format!("unlabeled:{account}").abi_encode(),
46        })
47    }
48}
49
50impl Cheatcode for computeCreateAddressCall {
51    fn apply<FEN: FoundryEvmNetwork>(&self, _state: &mut Cheatcodes<FEN>) -> Result {
52        let Self { nonce, deployer } = self;
53        ensure!(*nonce <= U256::from(u64::MAX), "nonce must be less than 2^64");
54        Ok(deployer.create(nonce.to()).abi_encode())
55    }
56}
57
58impl Cheatcode for computeCreate2Address_0Call {
59    fn apply<FEN: FoundryEvmNetwork>(&self, _state: &mut Cheatcodes<FEN>) -> Result {
60        let Self { salt, initCodeHash, deployer } = self;
61        Ok(deployer.create2(salt, initCodeHash).abi_encode())
62    }
63}
64
65impl Cheatcode for computeCreate2Address_1Call {
66    fn apply<FEN: FoundryEvmNetwork>(&self, _state: &mut Cheatcodes<FEN>) -> Result {
67        let Self { salt, initCodeHash } = self;
68        Ok(DEFAULT_CREATE2_DEPLOYER.create2(salt, initCodeHash).abi_encode())
69    }
70}
71
72impl Cheatcode for ensNamehashCall {
73    fn apply<FEN: FoundryEvmNetwork>(&self, _state: &mut Cheatcodes<FEN>) -> Result {
74        let Self { name } = self;
75        Ok(namehash(name).abi_encode())
76    }
77}
78
79impl Cheatcode for bound_0Call {
80    fn apply<FEN: FoundryEvmNetwork>(&self, state: &mut Cheatcodes<FEN>) -> Result {
81        let Self { current, min, max } = *self;
82        let Some(mutated) = U256::bound(current, min, max, state.test_runner()) else {
83            bail!("cannot bound {current} in [{min}, {max}] range")
84        };
85        Ok(mutated.abi_encode())
86    }
87}
88
89impl Cheatcode for bound_1Call {
90    fn apply<FEN: FoundryEvmNetwork>(&self, state: &mut Cheatcodes<FEN>) -> Result {
91        let Self { current, min, max } = *self;
92        let Some(mutated) = I256::bound(current, min, max, state.test_runner()) else {
93            bail!("cannot bound {current} in [{min}, {max}] range")
94        };
95        Ok(mutated.abi_encode())
96    }
97}
98
99impl Cheatcode for randomUint_0Call {
100    fn apply<FEN: FoundryEvmNetwork>(&self, state: &mut Cheatcodes<FEN>) -> Result {
101        random_uint(state, None, None)
102    }
103}
104
105impl Cheatcode for randomUint_1Call {
106    fn apply<FEN: FoundryEvmNetwork>(&self, state: &mut Cheatcodes<FEN>) -> Result {
107        let Self { min, max } = *self;
108        random_uint(state, None, Some((min, max)))
109    }
110}
111
112impl Cheatcode for randomUint_2Call {
113    fn apply<FEN: FoundryEvmNetwork>(&self, state: &mut Cheatcodes<FEN>) -> Result {
114        let Self { bits } = *self;
115        random_uint(state, Some(bits), None)
116    }
117}
118
119impl Cheatcode for randomAddressCall {
120    fn apply<FEN: FoundryEvmNetwork>(&self, state: &mut Cheatcodes<FEN>) -> Result {
121        Ok(DynSolValue::type_strategy(&DynSolType::Address)
122            .new_tree(state.test_runner())
123            .unwrap()
124            .current()
125            .abi_encode())
126    }
127}
128
129impl Cheatcode for randomInt_0Call {
130    fn apply<FEN: FoundryEvmNetwork>(&self, state: &mut Cheatcodes<FEN>) -> Result {
131        random_int(state, None)
132    }
133}
134
135impl Cheatcode for randomInt_1Call {
136    fn apply<FEN: FoundryEvmNetwork>(&self, state: &mut Cheatcodes<FEN>) -> Result {
137        let Self { bits } = *self;
138        random_int(state, Some(bits))
139    }
140}
141
142impl Cheatcode for randomBoolCall {
143    fn apply<FEN: FoundryEvmNetwork>(&self, state: &mut Cheatcodes<FEN>) -> Result {
144        let rand_bool: bool = state.rng().random();
145        Ok(rand_bool.abi_encode())
146    }
147}
148
149impl Cheatcode for randomBytesCall {
150    fn apply<FEN: FoundryEvmNetwork>(&self, state: &mut Cheatcodes<FEN>) -> Result {
151        let Self { len } = *self;
152        ensure!(
153            len <= U256::from(usize::MAX),
154            format!("bytes length cannot exceed {}", usize::MAX)
155        );
156        let mut bytes = vec![0u8; len.to::<usize>()];
157        state.rng().fill_bytes(&mut bytes);
158        Ok(bytes.abi_encode())
159    }
160}
161
162impl Cheatcode for randomBytes4Call {
163    fn apply<FEN: FoundryEvmNetwork>(&self, state: &mut Cheatcodes<FEN>) -> Result {
164        let rand_u32 = state.rng().next_u32();
165        Ok(B32::from(rand_u32).abi_encode())
166    }
167}
168
169impl Cheatcode for randomBytes8Call {
170    fn apply<FEN: FoundryEvmNetwork>(&self, state: &mut Cheatcodes<FEN>) -> Result {
171        let rand_u64 = state.rng().next_u64();
172        Ok(B64::from(rand_u64).abi_encode())
173    }
174}
175
176impl Cheatcode for pauseTracingCall {
177    fn apply_full<FEN: FoundryEvmNetwork>(
178        &self,
179        ccx: &mut CheatsCtxt<'_, '_, FEN>,
180        executor: &mut dyn CheatcodesExecutor<FEN>,
181    ) -> Result {
182        let Some(tracer) = executor.tracing_inspector() else {
183            // No tracer -> nothing to pause
184            return Ok(Default::default());
185        };
186
187        // If paused earlier, ignore the call
188        if ccx.state.ignored_traces.last_pause_call.is_some() {
189            return Ok(Default::default());
190        }
191
192        let cur_node = &tracer.traces().nodes().last().expect("no trace nodes");
193        ccx.state.ignored_traces.last_pause_call = Some((cur_node.idx, cur_node.ordering.len()));
194
195        Ok(Default::default())
196    }
197}
198
199impl Cheatcode for resumeTracingCall {
200    fn apply_full<FEN: FoundryEvmNetwork>(
201        &self,
202        ccx: &mut CheatsCtxt<'_, '_, FEN>,
203        executor: &mut dyn CheatcodesExecutor<FEN>,
204    ) -> Result {
205        let Some(tracer) = executor.tracing_inspector() else {
206            // No tracer -> nothing to unpause
207            return Ok(Default::default());
208        };
209
210        let Some(start) = ccx.state.ignored_traces.last_pause_call.take() else {
211            // Nothing to unpause
212            return Ok(Default::default());
213        };
214
215        let node = &tracer.traces().nodes().last().expect("no trace nodes");
216        ccx.state.ignored_traces.ignored.insert(start, (node.idx, node.ordering.len()));
217
218        Ok(Default::default())
219    }
220}
221
222impl Cheatcode for interceptInitcodeCall {
223    fn apply<FEN: FoundryEvmNetwork>(&self, state: &mut Cheatcodes<FEN>) -> Result {
224        let Self {} = self;
225        if state.intercept_next_create_call {
226            bail!("vm.interceptInitcode() has already been called")
227        }
228        state.intercept_next_create_call = true;
229        Ok(Default::default())
230    }
231}
232
233impl Cheatcode for setArbitraryStorage_0Call {
234    fn apply_stateful<FEN: FoundryEvmNetwork>(&self, ccx: &mut CheatsCtxt<'_, '_, FEN>) -> Result {
235        let Self { target } = self;
236        ccx.state.arbitrary_storage().mark_arbitrary(target, false);
237
238        Ok(Default::default())
239    }
240}
241
242impl Cheatcode for setArbitraryStorage_1Call {
243    fn apply_stateful<FEN: FoundryEvmNetwork>(&self, ccx: &mut CheatsCtxt<'_, '_, FEN>) -> Result {
244        let Self { target, overwrite } = self;
245        ccx.state.arbitrary_storage().mark_arbitrary(target, *overwrite);
246
247        Ok(Default::default())
248    }
249}
250
251impl Cheatcode for copyStorageCall {
252    fn apply_stateful<FEN: FoundryEvmNetwork>(&self, ccx: &mut CheatsCtxt<'_, '_, FEN>) -> Result {
253        let Self { from, to } = self;
254
255        ensure!(
256            !ccx.state.has_arbitrary_storage(to),
257            "target address cannot have arbitrary storage"
258        );
259
260        if let Ok(from_account) = ccx.ecx.journal_mut().load_account(*from) {
261            let from_storage = from_account.storage.clone();
262            if ccx.ecx.journal_mut().load_account(*to).is_ok() {
263                // SAFETY: We ensured the account was already loaded.
264                ccx.ecx.journal_mut().evm_state_mut().get_mut(to).unwrap().storage = from_storage;
265                if let Some(arbitrary_storage) = &mut ccx.state.arbitrary_storage {
266                    arbitrary_storage.mark_copy(from, to);
267                }
268            }
269        }
270
271        Ok(Default::default())
272    }
273}
274
275impl Cheatcode for sortCall {
276    fn apply<FEN: FoundryEvmNetwork>(&self, _state: &mut Cheatcodes<FEN>) -> Result {
277        let Self { array } = self;
278
279        let mut sorted_values = array.clone();
280        sorted_values.sort();
281
282        Ok(sorted_values.abi_encode())
283    }
284}
285
286impl Cheatcode for shuffleCall {
287    fn apply<FEN: FoundryEvmNetwork>(&self, state: &mut Cheatcodes<FEN>) -> Result {
288        let Self { array } = self;
289
290        let mut shuffled_values = array.clone();
291        let rng = state.rng();
292        shuffled_values.shuffle(rng);
293
294        Ok(shuffled_values.abi_encode())
295    }
296}
297
298impl Cheatcode for setSeedCall {
299    fn apply_stateful<FEN: FoundryEvmNetwork>(&self, ccx: &mut CheatsCtxt<'_, '_, FEN>) -> Result {
300        let Self { seed } = self;
301        ccx.state.set_seed(*seed);
302        Ok(Default::default())
303    }
304}
305
306/// Helper to generate a random `uint` value (with given bits or bounded if specified)
307/// from type strategy.
308fn random_uint<FEN: FoundryEvmNetwork>(
309    state: &mut Cheatcodes<FEN>,
310    bits: Option<U256>,
311    bounds: Option<(U256, U256)>,
312) -> Result {
313    if let Some(bits) = bits {
314        // Generate random with specified bits.
315        ensure!(bits <= U256::from(256), "number of bits cannot exceed 256");
316        return Ok(DynSolValue::type_strategy(&DynSolType::Uint(bits.to::<usize>()))
317            .new_tree(state.test_runner())
318            .unwrap()
319            .current()
320            .abi_encode());
321    }
322
323    if let Some((min, max)) = bounds {
324        ensure!(min <= max, "min must be less than or equal to max");
325        // Generate random between range min..=max
326        let exclusive_modulo = max - min;
327        let mut random_number: U256 = state.rng().random();
328        if exclusive_modulo != U256::MAX {
329            let inclusive_modulo = exclusive_modulo + U256::from(1);
330            random_number %= inclusive_modulo;
331        }
332        random_number += min;
333        return Ok(random_number.abi_encode());
334    }
335
336    // Generate random `uint256` value.
337    Ok(DynSolValue::type_strategy(&DynSolType::Uint(256))
338        .new_tree(state.test_runner())
339        .unwrap()
340        .current()
341        .abi_encode())
342}
343
344/// Helper to generate a random `int` value (with given bits if specified) from type strategy.
345fn random_int<FEN: FoundryEvmNetwork>(state: &mut Cheatcodes<FEN>, bits: Option<U256>) -> Result {
346    let no_bits = bits.unwrap_or(U256::from(256));
347    ensure!(no_bits <= U256::from(256), "number of bits cannot exceed 256");
348    Ok(DynSolValue::type_strategy(&DynSolType::Int(no_bits.to::<usize>()))
349        .new_tree(state.test_runner())
350        .unwrap()
351        .current()
352        .abi_encode())
353}
354
355impl Cheatcode for eip712HashType_0Call {
356    fn apply<FEN: FoundryEvmNetwork>(&self, state: &mut Cheatcodes<FEN>) -> Result {
357        let Self { typeNameOrDefinition } = self;
358
359        let type_def = get_canonical_type_def(typeNameOrDefinition, state, None)?;
360
361        Ok(keccak256(type_def.as_bytes()).to_vec())
362    }
363}
364
365impl Cheatcode for eip712HashType_1Call {
366    fn apply<FEN: FoundryEvmNetwork>(&self, state: &mut Cheatcodes<FEN>) -> Result {
367        let Self { bindingsPath, typeName } = self;
368
369        let path = state.config.ensure_path_allowed(bindingsPath, FsAccessKind::Read)?;
370        let type_def = get_type_def_from_bindings(typeName, path, &state.config.root)?;
371
372        Ok(keccak256(type_def.as_bytes()).to_vec())
373    }
374}
375
376impl Cheatcode for eip712HashStruct_0Call {
377    fn apply<FEN: FoundryEvmNetwork>(&self, state: &mut Cheatcodes<FEN>) -> Result {
378        let Self { typeNameOrDefinition, abiEncodedData } = self;
379
380        let type_def = get_canonical_type_def(typeNameOrDefinition, state, None)?;
381        let primary = &type_def[..type_def.find('(').unwrap_or(type_def.len())];
382
383        get_struct_hash(primary, &type_def, abiEncodedData)
384    }
385}
386
387impl Cheatcode for eip712HashStruct_1Call {
388    fn apply<FEN: FoundryEvmNetwork>(&self, state: &mut Cheatcodes<FEN>) -> Result {
389        let Self { bindingsPath, typeName, abiEncodedData } = self;
390
391        let path = state.config.ensure_path_allowed(bindingsPath, FsAccessKind::Read)?;
392        let type_def = get_type_def_from_bindings(typeName, path, &state.config.root)?;
393
394        get_struct_hash(typeName, &type_def, abiEncodedData)
395    }
396}
397
398impl Cheatcode for eip712HashTypedDataCall {
399    fn apply<FEN: FoundryEvmNetwork>(&self, _state: &mut Cheatcodes<FEN>) -> Result {
400        let Self { jsonData } = self;
401        let typed_data: TypedData = serde_json::from_str(jsonData)?;
402        let digest = typed_data.eip712_signing_hash()?;
403
404        Ok(digest.to_vec())
405    }
406}
407
408/// Returns EIP-712 canonical type definition from the provided string type representation or type
409/// name. If type name provided, then it looks up bindings from file generated by `forge bind-json`.
410fn get_canonical_type_def<FEN: FoundryEvmNetwork>(
411    name_or_def: &String,
412    state: &mut Cheatcodes<FEN>,
413    path: Option<PathBuf>,
414) -> Result<String> {
415    let type_def = if name_or_def.contains('(') {
416        // If the input contains '(', it must be the type definition.
417        EncodeType::parse(name_or_def).and_then(|parsed| parsed.canonicalize())?
418    } else {
419        // Otherwise, it must be the type name.
420        let path = path.as_ref().unwrap_or(&state.config.bind_json_path);
421        let path = state.config.ensure_path_allowed(path, FsAccessKind::Read)?;
422        get_type_def_from_bindings(name_or_def, path, &state.config.root)?
423    };
424
425    Ok(type_def)
426}
427
428/// Returns the EIP-712 type definition from the bindings in the provided path.
429/// Assumes that read validation for the path has already been checked.
430fn get_type_def_from_bindings(name: &String, path: PathBuf, root: &PathBuf) -> Result<String> {
431    let content = fs::read_to_string(&path)?;
432
433    let type_defs: HashMap<&str, &str> = content
434        .lines()
435        .filter_map(|line| {
436            let relevant = line.trim().strip_prefix(TYPE_BINDING_PREFIX)?;
437            let (name, def) = relevant.split_once('=')?;
438            Some((name.trim(), def.trim().strip_prefix('"')?.strip_suffix("\";")?))
439        })
440        .collect();
441
442    match type_defs.get(name.as_str()) {
443        Some(value) => Ok(value.to_string()),
444        None => {
445            let bindings =
446                type_defs.keys().map(|k| format!(" - {k}")).collect::<Vec<String>>().join("\n");
447
448            bail!(
449                "'{}' not found in '{}'.{}",
450                name,
451                path.strip_prefix(root).unwrap_or(&path).to_string_lossy(),
452                if bindings.is_empty() {
453                    String::new()
454                } else {
455                    format!("\nAvailable bindings:\n{bindings}\n")
456                }
457            );
458        }
459    }
460}
461
462/// Returns the EIP-712 struct hash for provided name, definition and ABI encoded data.
463fn get_struct_hash(primary: &str, type_def: &String, abi_encoded_data: &Bytes) -> Result {
464    let mut resolver = Resolver::default();
465
466    // Populate the resolver by ingesting the canonical type definition, and then get the
467    // corresponding `DynSolType` of the primary type.
468    resolver
469        .ingest_string(type_def)
470        .map_err(|e| fmt_err!("Resolver failed to ingest type definition: {e}"))?;
471
472    let resolved_sol_type = resolver
473        .resolve(primary)
474        .map_err(|e| fmt_err!("Failed to resolve EIP-712 primary type '{primary}': {e}"))?;
475
476    // ABI-decode the bytes into `DynSolValue::CustomStruct`.
477    let sol_value = resolved_sol_type.abi_decode(abi_encoded_data.as_ref()).map_err(|e| {
478        fmt_err!("Failed to ABI decode using resolved_sol_type directly for '{primary}': {e}.")
479    })?;
480
481    // Use the resolver to properly encode the data.
482    let encoded_data: Vec<u8> = resolver
483        .encode_data(&sol_value)
484        .map_err(|e| fmt_err!("Failed to EIP-712 encode data for struct '{primary}': {e}"))?
485        .ok_or_else(|| fmt_err!("EIP-712 data encoding returned 'None' for struct '{primary}'"))?;
486
487    // Compute the type hash of the primary type.
488    let type_hash = resolver
489        .type_hash(primary)
490        .map_err(|e| fmt_err!("Failed to compute typeHash for EIP712 type '{primary}': {e}"))?;
491
492    // Compute the struct hash of the concatenated type hash and encoded data.
493    let mut bytes_to_hash = Vec::with_capacity(32 + encoded_data.len());
494    bytes_to_hash.extend_from_slice(type_hash.as_slice());
495    bytes_to_hash.extend_from_slice(&encoded_data);
496
497    Ok(keccak256(&bytes_to_hash).to_vec())
498}
499
500impl Cheatcode for toRlpCall {
501    fn apply<FEN: FoundryEvmNetwork>(&self, _state: &mut Cheatcodes<FEN>) -> Result {
502        let Self { data } = self;
503
504        let mut buf = Vec::new();
505        data.encode(&mut buf);
506
507        Ok(Bytes::from(buf).abi_encode())
508    }
509}
510
511impl Cheatcode for fromRlpCall {
512    fn apply<FEN: FoundryEvmNetwork>(&self, _state: &mut Cheatcodes<FEN>) -> Result {
513        let Self { rlp } = self;
514
515        let decoded: Vec<Bytes> = Vec::<Bytes>::decode(&mut rlp.as_ref())
516            .map_err(|e| fmt_err!("Failed to decode RLP: {e}"))?;
517
518        Ok(decoded.abi_encode())
519    }
520}
foundry_cheatcodes/utils.rs

foundry_cheatcodes/
utils.rs
