foundry_config/
fuzz.rs

Help
1//! Configuration for fuzz testing.
2
3use alloy_primitives::U256;
4use serde::{Deserialize, Serialize};
5use std::path::PathBuf;
6
7/// Contains for fuzz testing
8#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
9pub struct FuzzConfig {
10    /// The number of test cases that must execute for each property test
11    pub runs: u32,
12    /// The maximum number of test case rejections allowed by proptest, to be
13    /// encountered during usage of `vm.assume` cheatcode. This will be used
14    /// to set the `max_global_rejects` value in proptest test runner config.
15    /// `max_local_rejects` option isn't exposed here since we're not using
16    /// `prop_filter`.
17    pub max_test_rejects: u32,
18    /// Optional seed for the fuzzing RNG algorithm
19    pub seed: Option<U256>,
20    /// The fuzz dictionary configuration
21    #[serde(flatten)]
22    pub dictionary: FuzzDictionaryConfig,
23    /// Number of runs to execute and include in the gas report.
24    pub gas_report_samples: u32,
25    /// Path where fuzz failures are recorded and replayed.
26    pub failure_persist_dir: Option<PathBuf>,
27    /// Name of the file to record fuzz failures, defaults to `failures`.
28    pub failure_persist_file: Option<String>,
29    /// show `console.log` in fuzz test, defaults to `false`
30    pub show_logs: bool,
31    /// Optional timeout (in seconds) for each property test
32    pub timeout: Option<u32>,
33}
34
35impl Default for FuzzConfig {
36    fn default() -> Self {
37        Self {
38            runs: 256,
39            max_test_rejects: 65536,
40            seed: None,
41            dictionary: FuzzDictionaryConfig::default(),
42            gas_report_samples: 256,
43            failure_persist_dir: None,
44            failure_persist_file: None,
45            show_logs: false,
46            timeout: None,
47        }
48    }
49}
50
51impl FuzzConfig {
52    /// Creates fuzz configuration to write failures in `{PROJECT_ROOT}/cache/fuzz` dir.
53    pub fn new(cache_dir: PathBuf) -> Self {
54        Self {
55            failure_persist_dir: Some(cache_dir),
56            failure_persist_file: Some("failures".to_string()),
57            ..Default::default()
58        }
59    }
60}
61
62/// Contains for fuzz testing
63#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)]
64pub struct FuzzDictionaryConfig {
65    /// The weight of the dictionary
66    #[serde(deserialize_with = "crate::deserialize_stringified_percent")]
67    pub dictionary_weight: u32,
68    /// The flag indicating whether to include values from storage
69    pub include_storage: bool,
70    /// The flag indicating whether to include push bytes values
71    pub include_push_bytes: bool,
72    /// How many addresses to record at most.
73    /// Once the fuzzer exceeds this limit, it will start evicting random entries
74    ///
75    /// This limit is put in place to prevent memory blowup.
76    #[serde(deserialize_with = "crate::deserialize_usize_or_max")]
77    pub max_fuzz_dictionary_addresses: usize,
78    /// How many values to record at most.
79    /// Once the fuzzer exceeds this limit, it will start evicting random entries
80    #[serde(deserialize_with = "crate::deserialize_usize_or_max")]
81    pub max_fuzz_dictionary_values: usize,
82}
83
84impl Default for FuzzDictionaryConfig {
85    fn default() -> Self {
86        Self {
87            dictionary_weight: 40,
88            include_storage: true,
89            include_push_bytes: true,
90            // limit this to 300MB
91            max_fuzz_dictionary_addresses: (300 * 1024 * 1024) / 20,
92            // limit this to 200MB
93            max_fuzz_dictionary_values: (200 * 1024 * 1024) / 32,
94        }
95    }
96}
foundry_config/fuzz.rs

foundry_config/
fuzz.rs
