-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Expand file tree
/
Copy pathparam.rs
More file actions
790 lines (729 loc) · 31.1 KB
/
param.rs
File metadata and controls
790 lines (729 loc) · 31.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
use super::state::EvmFuzzState;
use crate::{
invariant::SenderFilters,
strategies::mutators::{
BitMutator, GaussianNoiseMutator, IncrementDecrementMutator, InterestingWordMutator,
},
};
use alloy_dyn_abi::{DynSolType, DynSolValue, Word};
use alloy_primitives::{Address, B256, I256, U256};
use proptest::{prelude::*, test_runner::TestRunner};
use rand::{SeedableRng, prelude::IndexedMutRandom, rngs::StdRng};
use std::mem::replace;
/// The max length of arrays we fuzz for is 256.
const MAX_ARRAY_LEN: usize = 256;
/// Given a parameter type, returns a strategy for generating values for that type.
///
/// See [`fuzz_param_with_fixtures`] for more information.
pub fn fuzz_param(param: &DynSolType) -> BoxedStrategy<DynSolValue> {
fuzz_param_inner(param, None)
}
/// Given a parameter type and configured fixtures for param name, returns a strategy for generating
/// values for that type.
///
/// Fixtures can be currently generated for uint, int, address, bytes and
/// string types and are defined for parameter name.
/// For example, fixtures for parameter `owner` of type `address` can be defined in a function with
/// a `function fixture_owner() public returns (address[] memory)` signature.
///
/// Fixtures are matched on parameter name, hence fixtures defined in
/// `fixture_owner` function can be used in a fuzzed test function with a signature like
/// `function testFuzz_ownerAddress(address owner, uint amount)`.
///
/// Raises an error if all the fixture types are not of the same type as the input parameter.
///
/// Works with ABI Encoder v2 tuples.
pub fn fuzz_param_with_fixtures(
param: &DynSolType,
fixtures: Option<&[DynSolValue]>,
name: &str,
) -> BoxedStrategy<DynSolValue> {
fuzz_param_inner(param, fixtures.map(|f| (f, name)))
}
fn fuzz_param_inner(
param: &DynSolType,
mut fuzz_fixtures: Option<(&[DynSolValue], &str)>,
) -> BoxedStrategy<DynSolValue> {
if let Some((fixtures, name)) = fuzz_fixtures
&& !fixtures.iter().all(|f| f.matches(param))
{
error!("fixtures for {name:?} do not match type {param}");
fuzz_fixtures = None;
}
let fuzz_fixtures = fuzz_fixtures.map(|(f, _)| f);
let value = || {
let default_strategy = DynSolValue::type_strategy(param);
if let Some(fixtures) = fuzz_fixtures {
proptest::prop_oneof![
50 => {
let fixtures = fixtures.to_vec();
any::<prop::sample::Index>()
.prop_map(move |index| index.get(&fixtures).clone())
},
50 => default_strategy,
]
.boxed()
} else {
default_strategy.boxed()
}
};
match *param {
DynSolType::Address => value(),
DynSolType::Int(n @ 8..=256) => super::IntStrategy::new(n, fuzz_fixtures)
.prop_map(move |x| DynSolValue::Int(x, n))
.boxed(),
DynSolType::Uint(n @ 8..=256) => super::UintStrategy::new(n, fuzz_fixtures)
.prop_map(move |x| DynSolValue::Uint(x, n))
.boxed(),
DynSolType::Function | DynSolType::Bool => DynSolValue::type_strategy(param).boxed(),
DynSolType::Bytes => value(),
DynSolType::FixedBytes(_size @ 1..=32) => value(),
DynSolType::String => value()
.prop_map(move |value| {
DynSolValue::String(
value.as_str().unwrap().trim().trim_end_matches('\0').to_string(),
)
})
.boxed(),
DynSolType::Tuple(ref params) => params
.iter()
.map(|param| fuzz_param_inner(param, None))
.collect::<Vec<_>>()
.prop_map(DynSolValue::Tuple)
.boxed(),
DynSolType::FixedArray(ref param, size) => {
proptest::collection::vec(fuzz_param_inner(param, None), size)
.prop_map(DynSolValue::FixedArray)
.boxed()
}
DynSolType::Array(ref param) => {
proptest::collection::vec(fuzz_param_inner(param, None), 0..MAX_ARRAY_LEN)
.prop_map(DynSolValue::Array)
.boxed()
}
_ => panic!("unsupported fuzz param type: {param}"),
}
}
/// Given a parameter type, returns a strategy for generating values for that type, given some EVM
/// fuzz state.
///
/// Works with ABI Encoder v2 tuples.
pub fn fuzz_param_from_state(
param: &DynSolType,
state: &EvmFuzzState,
) -> BoxedStrategy<DynSolValue> {
// Value strategy that uses the state.
let value = || {
let state = state.clone();
let param = param.clone();
// Generate a bias and use it to pick samples or non-persistent values (50 / 50).
// Use `Index` instead of `Selector` when selecting a value to avoid iterating over the
// entire dictionary.
any::<(bool, prop::sample::Index)>().prop_map(move |(bias, index)| {
let state = state.dictionary_read();
let values = if bias { state.samples(¶m) } else { None }
.unwrap_or_else(|| state.values())
.as_slice();
values[index.index(values.len())]
})
};
// Convert the value based on the parameter type
match *param {
DynSolType::Address => {
let deployed_libs = state.deployed_libs.clone();
value()
.prop_map(move |value| {
let mut fuzzed_addr = Address::from_word(value);
if deployed_libs.contains(&fuzzed_addr) {
let mut rng = StdRng::seed_from_u64(0x1337); // use deterministic rng
// Do not use addresses of deployed libraries as fuzz input, instead return
// a deterministically random address. We cannot filter out this value (via
// `prop_filter_map`) as proptest can invoke this closure after test
// execution, and returning a `None` will cause it to panic.
// See <https://github.com/foundry-rs/foundry/issues/9764> and <https://github.com/foundry-rs/foundry/issues/8639>.
loop {
fuzzed_addr.randomize_with(&mut rng);
if !deployed_libs.contains(&fuzzed_addr) {
break;
}
}
}
DynSolValue::Address(fuzzed_addr)
})
.boxed()
}
DynSolType::Function => value()
.prop_map(move |value| {
DynSolValue::Function(alloy_primitives::Function::from_word(value))
})
.boxed(),
DynSolType::FixedBytes(size @ 1..=32) => value()
.prop_map(move |mut v| {
v[size..].fill(0);
DynSolValue::FixedBytes(B256::from(v), size)
})
.boxed(),
DynSolType::Bool => DynSolValue::type_strategy(param).boxed(),
DynSolType::String => {
let state = state.clone();
(proptest::bool::weighted(0.3), any::<prop::sample::Index>())
.prop_flat_map(move |(use_ast, select_index)| {
let dict = state.dictionary_read();
// AST string literals available: 30% probability
let ast_strings = dict.ast_strings();
if use_ast && !ast_strings.is_empty() {
let s = &ast_strings.as_slice()[select_index.index(ast_strings.len())];
return Just(DynSolValue::String(s.clone())).boxed();
}
// Fallback to random string generation
DynSolValue::type_strategy(&DynSolType::String)
.prop_map(|value| {
DynSolValue::String(
value.as_str().unwrap().trim().trim_end_matches('\0').to_string(),
)
})
.boxed()
})
.boxed()
}
DynSolType::Bytes => {
let state_clone = state.clone();
(
value(),
proptest::bool::weighted(0.1),
proptest::bool::weighted(0.2),
any::<prop::sample::Index>(),
)
.prop_map(move |(word, use_ast_string, use_ast_bytes, select_index)| {
let dict = state_clone.dictionary_read();
// Try string literals as bytes: 10% chance
let ast_strings = dict.ast_strings();
if use_ast_string && !ast_strings.is_empty() {
let s = &ast_strings.as_slice()[select_index.index(ast_strings.len())];
return DynSolValue::Bytes(s.as_bytes().to_vec());
}
// Try hex literals: 20% chance
let ast_bytes = dict.ast_bytes();
if use_ast_bytes && !ast_bytes.is_empty() {
let bytes = &ast_bytes.as_slice()[select_index.index(ast_bytes.len())];
return DynSolValue::Bytes(bytes.to_vec());
}
// Fallback to the generated word from the dictionary: 70% chance
DynSolValue::Bytes(word.0.into())
})
.boxed()
}
DynSolType::Int(n @ 8..=256) => match n / 8 {
32 => value()
.prop_map(move |value| DynSolValue::Int(I256::from_raw(value.into()), 256))
.boxed(),
1..=31 => value()
.prop_map(move |value| {
// Extract lower N bits
let uint_n = U256::from_be_bytes(value.0) % U256::from(1).wrapping_shl(n);
// Interpret as signed int (two's complement) --> check sign bit (bit N-1).
let sign_bit = U256::from(1) << (n - 1);
let num = if uint_n >= sign_bit {
// Negative number in two's complement
let modulus = U256::from(1) << n;
I256::from_raw(uint_n.wrapping_sub(modulus))
} else {
// Positive number
I256::from_raw(uint_n)
};
DynSolValue::Int(num, n)
})
.boxed(),
_ => unreachable!(),
},
DynSolType::Uint(n @ 8..=256) => match n / 8 {
32 => value()
.prop_map(move |value| DynSolValue::Uint(U256::from_be_bytes(value.0), 256))
.boxed(),
1..=31 => value()
.prop_map(move |value| {
let uint = U256::from_be_bytes(value.0) % U256::from(1).wrapping_shl(n);
DynSolValue::Uint(uint, n)
})
.boxed(),
_ => unreachable!(),
},
DynSolType::Tuple(ref params) => params
.iter()
.map(|p| fuzz_param_from_state(p, state))
.collect::<Vec<_>>()
.prop_map(DynSolValue::Tuple)
.boxed(),
DynSolType::FixedArray(ref param, size) => {
proptest::collection::vec(fuzz_param_from_state(param, state), size)
.prop_map(DynSolValue::FixedArray)
.boxed()
}
DynSolType::Array(ref param) => {
proptest::collection::vec(fuzz_param_from_state(param, state), 0..MAX_ARRAY_LEN)
.prop_map(DynSolValue::Array)
.boxed()
}
_ => panic!("unsupported fuzz param type: {param}"),
}
}
/// Selects a random address for mutation, respecting sender filters if provided.
///
/// Priority:
/// 1. If `senders` has targeted addresses, pick randomly from those
/// 2. Otherwise, pick from the dictionary state values (excluding any in `senders.excluded`)
/// 3. Returns `None` if no suitable address is found or if the selected address equals `current`
fn select_random_address(
current: Address,
test_runner: &mut TestRunner,
state: &EvmFuzzState,
senders: Option<&SenderFilters>,
) -> Option<Address> {
if let Some(senders) = senders {
if !senders.targeted.is_empty() {
// Pick from targeted senders
let index = test_runner.rng().random_range(0..senders.targeted.len());
let addr = senders.targeted[index];
return (addr != current).then_some(addr);
}
// Pick from dictionary state values, excluding addresses in the exclusion list
let dict = state.dictionary_read();
let values = dict.values();
if values.is_empty() {
return None;
}
// Try a few times to find a non-excluded address
for _ in 0..10 {
let index = test_runner.rng().random_range(0..values.len());
let addr = Address::from_word(values[index]);
if addr != current && !senders.excluded.contains(&addr) {
return Some(addr);
}
}
None
} else {
// No sender filters, just pick from dictionary state values
let dict = state.dictionary_read();
let values = dict.values();
if values.is_empty() {
None
} else {
let index = test_runner.rng().random_range(0..values.len());
let addr = Address::from_word(values[index]);
(addr != current).then_some(addr)
}
}
}
/// Mutates the current value of the given parameter type and value.
pub fn mutate_param_value(
param: &DynSolType,
value: DynSolValue,
test_runner: &mut TestRunner,
state: &EvmFuzzState,
) -> DynSolValue {
mutate_param_value_inner(param, value, test_runner, state, None)
}
/// Mutates the current value of the given parameter type and value, with optional sender filters.
///
/// When `senders` is provided and has targeted addresses, address mutations will prefer
/// selecting from those targeted addresses (similar to `select_random_sender` behavior).
pub fn mutate_param_value_with_senders(
param: &DynSolType,
value: DynSolValue,
test_runner: &mut TestRunner,
state: &EvmFuzzState,
senders: &SenderFilters,
) -> DynSolValue {
mutate_param_value_inner(param, value, test_runner, state, Some(senders))
}
fn mutate_param_value_inner(
param: &DynSolType,
value: DynSolValue,
test_runner: &mut TestRunner,
state: &EvmFuzzState,
senders: Option<&SenderFilters>,
) -> DynSolValue {
let new_value = |param: &DynSolType, test_runner: &mut TestRunner| {
fuzz_param_from_state(param, state)
.new_tree(test_runner)
.expect("Could not generate case")
.current()
};
match value {
DynSolValue::Bool(val) => {
// flip boolean value
trace!(target: "mutator", "Bool flip {val}");
Some(DynSolValue::Bool(!val))
}
DynSolValue::Uint(val, size) => match test_runner.rng().random_range(0..=6) {
0 => U256::increment_decrement(val, size, test_runner),
1 => U256::flip_random_bit(val, size, test_runner),
2 => U256::mutate_interesting_byte(val, size, test_runner),
3 => U256::mutate_interesting_word(val, size, test_runner),
4 => U256::mutate_interesting_dword(val, size, test_runner),
5 => U256::mutate_with_gaussian_noise(val, size, test_runner),
6 => None,
_ => unreachable!(),
}
.map(|v| DynSolValue::Uint(v, size)),
DynSolValue::Int(val, size) => match test_runner.rng().random_range(0..=6) {
0 => I256::increment_decrement(val, size, test_runner),
1 => I256::flip_random_bit(val, size, test_runner),
2 => I256::mutate_interesting_byte(val, size, test_runner),
3 => I256::mutate_interesting_word(val, size, test_runner),
4 => I256::mutate_interesting_dword(val, size, test_runner),
5 => I256::mutate_with_gaussian_noise(val, size, test_runner),
6 => None,
_ => unreachable!(),
}
.map(|v| DynSolValue::Int(v, size)),
DynSolValue::Address(val) => match test_runner.rng().random_range(0..=5) {
0 => Address::flip_random_bit(val, 20, test_runner),
1 => Address::mutate_interesting_byte(val, 20, test_runner),
2 => Address::mutate_interesting_word(val, 20, test_runner),
3 => Address::mutate_interesting_dword(val, 20, test_runner),
// Replace with a random address from targeted senders or dictionary.
4 => select_random_address(val, test_runner, state, senders),
5 => None,
_ => unreachable!(),
}
.map(DynSolValue::Address),
DynSolValue::Array(mut values) => {
if let DynSolType::Array(param_type) = param
&& !values.is_empty()
{
match test_runner.rng().random_range(0..=2) {
// Decrease array size by removing a random element.
0 => {
values.remove(test_runner.rng().random_range(0..values.len()));
}
// Increase array size.
1 => values.push(new_value(param_type, test_runner)),
// Mutate random array element.
2 => mutate_random_array_value(
&mut values,
param_type,
test_runner,
state,
senders,
),
_ => unreachable!(),
}
Some(DynSolValue::Array(values))
} else {
None
}
}
DynSolValue::FixedArray(mut values) => {
if let DynSolType::FixedArray(param_type, _size) = param
&& !values.is_empty()
{
mutate_random_array_value(&mut values, param_type, test_runner, state, senders);
Some(DynSolValue::FixedArray(values))
} else {
None
}
}
DynSolValue::FixedBytes(word, size) => match test_runner.rng().random_range(0..=4) {
0 => Word::flip_random_bit(word, size, test_runner),
1 => Word::mutate_interesting_byte(word, size, test_runner),
2 => Word::mutate_interesting_word(word, size, test_runner),
3 => Word::mutate_interesting_dword(word, size, test_runner),
4 => None,
_ => unreachable!(),
}
.map(|word| DynSolValue::FixedBytes(word, size)),
DynSolValue::CustomStruct { name, prop_names, tuple: mut values } => {
if let DynSolType::CustomStruct { name: _, prop_names: _, tuple: tuple_types }
| DynSolType::Tuple(tuple_types) = param
&& !values.is_empty()
{
// Mutate random struct element.
mutate_random_tuple_value(&mut values, tuple_types, test_runner, state, senders);
Some(DynSolValue::CustomStruct { name, prop_names, tuple: values })
} else {
None
}
}
DynSolValue::Tuple(mut values) => {
if let DynSolType::Tuple(tuple_types) = param
&& !values.is_empty()
{
// Mutate random tuple element.
mutate_random_tuple_value(&mut values, tuple_types, test_runner, state, senders);
Some(DynSolValue::Tuple(values))
} else {
None
}
}
_ => None,
}
.unwrap_or_else(|| new_value(param, test_runner))
}
/// Mutates random value from given tuples.
fn mutate_random_tuple_value(
tuple_values: &mut [DynSolValue],
tuple_types: &[DynSolType],
test_runner: &mut TestRunner,
state: &EvmFuzzState,
senders: Option<&SenderFilters>,
) {
let id = test_runner.rng().random_range(0..tuple_values.len());
let param_type = &tuple_types[id];
let old_val = replace(&mut tuple_values[id], DynSolValue::Bool(false));
let new_val = mutate_param_value_inner(param_type, old_val, test_runner, state, senders);
tuple_values[id] = new_val;
}
/// Mutates random value from given array.
fn mutate_random_array_value(
array_values: &mut [DynSolValue],
element_type: &DynSolType,
test_runner: &mut TestRunner,
state: &EvmFuzzState,
senders: Option<&SenderFilters>,
) {
let elem = array_values.choose_mut(&mut test_runner.rng()).unwrap();
let old_val = replace(elem, DynSolValue::Bool(false));
let new_val = mutate_param_value_inner(element_type, old_val, test_runner, state, senders);
*elem = new_val;
}
/// 0.001 ETH in wei.
const MILLI_ETH: u64 = 1_000_000_000_000_000;
/// 1 ETH in wei.
const ONE_ETH: u64 = 1_000_000_000_000_000_000;
/// Returns a proptest strategy for generating random msg.value for payable functions.
/// Biased towards smaller values to avoid balance issues.
///
/// Distribution:
/// - 85% chance: no value (None)
/// - 10% chance: small values (0-1000 wei)
/// - 4% chance: medium values (up to 0.001 ETH)
/// - 1% chance: larger values (up to 1 ETH)
pub fn fuzz_msg_value() -> impl Strategy<Value = Option<U256>> {
proptest::prop_oneof![
// 85% chance: no value
85 => proptest::strategy::Just(None),
// 10% chance: small values (0-1000 wei)
10 => (0u64..=1000).prop_map(|v| Some(U256::from(v))),
// 4% chance: medium values (up to 0.001 ETH)
4 => (0u64..=MILLI_ETH).prop_map(|v| Some(U256::from(v))),
// 1% chance: larger values (up to 1 ETH)
1 => (0u64..=ONE_ETH).prop_map(|v| Some(U256::from(v))),
]
}
/// Generates a random msg.value for payable functions using TestRunner's RNG.
/// Biased towards smaller values to avoid balance issues.
///
/// Distribution:
/// - 60% chance: small values (0-1000 wei)
/// - 30% chance: medium values (up to 0.001 ETH)
/// - 9% chance: larger values (up to 1 ETH)
/// - 1% chance: max value (edge case)
pub fn generate_msg_value(test_runner: &mut TestRunner) -> U256 {
match test_runner.rng().random_range(0..=10) {
// Small values (0-1000 wei) - 60% chance.
0..=5 => U256::from(test_runner.rng().random_range(0u64..=1000)),
// Medium values (up to 0.001 ETH) - 30% chance.
6..=8 => U256::from(test_runner.rng().random_range(0u64..=MILLI_ETH)),
// Larger values (up to 1 ETH) - 9% chance.
9 => U256::from(test_runner.rng().random_range(0u64..=ONE_ETH)),
// Edge case (max) - 1% chance.
_ => U256::MAX,
}
}
#[cfg(test)]
mod tests {
use crate::{
FuzzFixtures,
strategies::{EvmFuzzState, fuzz_calldata, fuzz_calldata_from_state},
};
use alloy_primitives::B256;
use foundry_common::abi::get_func;
use std::collections::HashSet;
#[test]
fn can_fuzz_array() {
let f = "testArray(uint64[2] calldata values)";
let func = get_func(f).unwrap();
let state = EvmFuzzState::test();
let strategy = proptest::prop_oneof![
60 => fuzz_calldata(func.clone(), &FuzzFixtures::default()),
40 => fuzz_calldata_from_state(func, &state),
];
let cfg = proptest::test_runner::Config { failure_persistence: None, ..Default::default() };
let mut runner = proptest::test_runner::TestRunner::new(cfg);
let _ = runner.run(&strategy, |_| Ok(()));
}
#[test]
fn can_fuzz_string_and_bytes_with_ast_literals_and_hashes() {
use super::fuzz_param_from_state;
use crate::strategies::LiteralMaps;
use alloy_dyn_abi::DynSolType;
use alloy_primitives::keccak256;
use proptest::strategy::Strategy;
// Seed dict with string values and their hashes --> mimic `CheatcodeAnalysis` behavior.
let mut literals = LiteralMaps::default();
literals.strings.insert("hello".to_string());
literals.strings.insert("world".to_string());
literals.words.entry(DynSolType::FixedBytes(32)).or_default().insert(keccak256("hello"));
literals.words.entry(DynSolType::FixedBytes(32)).or_default().insert(keccak256("world"));
let state = EvmFuzzState::test();
state.seed_literals(literals);
let cfg = proptest::test_runner::Config { failure_persistence: None, ..Default::default() };
let mut runner = proptest::test_runner::TestRunner::new(cfg);
// Verify strategies generates the seeded AST literals
let mut generated_bytes = HashSet::new();
let mut generated_hashes = HashSet::new();
let mut generated_strings = HashSet::new();
let bytes_strategy = fuzz_param_from_state(&DynSolType::Bytes, &state);
let string_strategy = fuzz_param_from_state(&DynSolType::String, &state);
let bytes32_strategy = fuzz_param_from_state(&DynSolType::FixedBytes(32), &state);
for _ in 0..256 {
let tree = bytes_strategy.new_tree(&mut runner).unwrap();
if let Some(bytes) = tree.current().as_bytes()
&& let Ok(s) = std::str::from_utf8(bytes)
{
generated_bytes.insert(s.to_string());
}
let tree = string_strategy.new_tree(&mut runner).unwrap();
if let Some(s) = tree.current().as_str() {
generated_strings.insert(s.to_string());
}
let tree = bytes32_strategy.new_tree(&mut runner).unwrap();
if let Some((bytes, size)) = tree.current().as_fixed_bytes()
&& size == 32
{
generated_hashes.insert(B256::from_slice(bytes));
}
}
assert!(generated_bytes.contains("hello"));
assert!(generated_bytes.contains("world"));
assert!(generated_strings.contains("hello"));
assert!(generated_strings.contains("world"));
assert!(generated_hashes.contains(&keccak256("hello")));
assert!(generated_hashes.contains(&keccak256("world")));
}
#[test]
fn mutate_address_can_select_from_dictionary() {
use super::mutate_param_value;
use alloy_dyn_abi::{DynSolType, DynSolValue};
use alloy_primitives::Address;
let state = EvmFuzzState::test();
// Add addresses to dictionary via state values.
let addr1 = Address::repeat_byte(0x11);
let addr2 = Address::repeat_byte(0x22);
let addr3 = Address::repeat_byte(0x33);
state.collect_values([addr1.into_word(), addr2.into_word(), addr3.into_word()]);
let cfg = proptest::test_runner::Config { failure_persistence: None, ..Default::default() };
let mut runner = proptest::test_runner::TestRunner::new(cfg);
// Mutate an address many times and verify we can get addresses from the dictionary.
let original = Address::repeat_byte(0xff);
let mut got_addr1 = false;
let mut got_addr2 = false;
let mut got_addr3 = false;
for _ in 0..1000 {
let mutated = mutate_param_value(
&DynSolType::Address,
DynSolValue::Address(original),
&mut runner,
&state,
);
if let DynSolValue::Address(addr) = mutated {
if addr == addr1 {
got_addr1 = true;
}
if addr == addr2 {
got_addr2 = true;
}
if addr == addr3 {
got_addr3 = true;
}
}
if got_addr1 && got_addr2 && got_addr3 {
break;
}
}
// We should have seen at least one dictionary address in 1000 iterations.
assert!(
got_addr1 || got_addr2 || got_addr3,
"Address mutation should select addresses from dictionary"
);
}
#[test]
fn mutate_address_prefers_targeted_senders() {
use super::select_random_address;
use crate::invariant::SenderFilters;
use alloy_primitives::Address;
let state = EvmFuzzState::test();
// Add addresses to dictionary (these should NOT be selected when targeted is set).
let dict_addr = Address::repeat_byte(0xdd);
state.collect_values([dict_addr.into_word()]);
// Set up targeted senders.
let targeted1 = Address::repeat_byte(0x11);
let targeted2 = Address::repeat_byte(0x22);
let senders = SenderFilters::new(vec![targeted1, targeted2], vec![]);
let cfg = proptest::test_runner::Config { failure_persistence: None, ..Default::default() };
let mut runner = proptest::test_runner::TestRunner::new(cfg);
// Call select_random_address directly to verify it uses targeted senders.
let original = Address::repeat_byte(0xff);
let mut got_targeted1 = false;
let mut got_targeted2 = false;
let mut got_dict = false;
for _ in 0..100 {
if let Some(addr) = select_random_address(original, &mut runner, &state, Some(&senders))
{
if addr == targeted1 {
got_targeted1 = true;
}
if addr == targeted2 {
got_targeted2 = true;
}
if addr == dict_addr {
got_dict = true;
}
}
}
// Should see targeted addresses, never dictionary address.
assert!(
got_targeted1 || got_targeted2,
"select_random_address should select from targeted senders"
);
assert!(
!got_dict,
"select_random_address should not select from dictionary when targeted senders are set"
);
}
#[test]
fn mutate_address_respects_excluded_senders() {
use super::select_random_address;
use crate::invariant::SenderFilters;
use alloy_primitives::Address;
let state = EvmFuzzState::test();
// Add addresses to dictionary.
let addr1 = Address::repeat_byte(0x11);
let addr2 = Address::repeat_byte(0x22);
let excluded_addr = Address::repeat_byte(0xee);
state.collect_values([addr1.into_word(), addr2.into_word(), excluded_addr.into_word()]);
// Exclude one address.
let senders = SenderFilters::new(vec![], vec![excluded_addr]);
let cfg = proptest::test_runner::Config { failure_persistence: None, ..Default::default() };
let mut runner = proptest::test_runner::TestRunner::new(cfg);
// Call select_random_address directly to verify it respects excluded senders.
let original = Address::repeat_byte(0xff);
let mut got_excluded = false;
let mut got_valid = false;
for _ in 0..100 {
if let Some(addr) = select_random_address(original, &mut runner, &state, Some(&senders))
{
if addr == excluded_addr {
got_excluded = true;
break;
}
if addr == addr1 || addr == addr2 {
got_valid = true;
}
}
}
assert!(!got_excluded, "select_random_address should not select excluded addresses");
assert!(got_valid, "select_random_address should select valid (non-excluded) addresses");
}
}