zk-scribble 0.1.2

Trace mutation fuzzer for Hekate ZK programs and chiplets. Tampers valid traces and asserts preflight catches every mutation.
Documentation 
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

use crate::mutation::MutationKind;
use crate::target::Target;

/// Empty `targets` / `kinds` / `include_*`
/// mean "no restriction"; populated lists
/// are filters.
#[derive(Clone, Debug)]
pub struct ScribbleConfig {
    cases: u32,
    targets: Vec<Target>,
    kinds: Vec<MutationKind>,
    include_cols: Vec<usize>,
    exclude_cols: Vec<usize>,
    include_rows: Vec<usize>,
    exclude_rows: Vec<usize>,
}

impl Default for ScribbleConfig {
    fn default() -> Self {
        Self {
            cases: 256,
            targets: Vec::new(),
            kinds: Vec::new(),
            include_cols: Vec::new(),
            exclude_cols: Vec::new(),
            include_rows: Vec::new(),
            exclude_rows: Vec::new(),
        }
    }
}

impl ScribbleConfig {
    pub fn cases(mut self, cases: u32) -> Self {
        self.cases = cases;
        self
    }

    pub fn target(mut self, target: Target) -> Self {
        self.targets = vec![target];
        self
    }

    pub fn targets<I: IntoIterator<Item = Target>>(mut self, targets: I) -> Self {
        self.targets = targets.into_iter().collect();
        self
    }

    pub fn mutations<I: IntoIterator<Item = MutationKind>>(mut self, kinds: I) -> Self {
        self.kinds = kinds.into_iter().collect();
        self
    }

    pub fn include_cols<I: IntoIterator<Item = usize>>(mut self, cols: I) -> Self {
        self.include_cols = cols.into_iter().collect();
        self
    }

    pub fn exclude_cols<I: IntoIterator<Item = usize>>(mut self, cols: I) -> Self {
        self.exclude_cols = cols.into_iter().collect();
        self
    }

    pub fn include_rows<I: IntoIterator<Item = usize>>(mut self, rows: I) -> Self {
        self.include_rows = rows.into_iter().collect();
        self
    }

    pub fn exclude_rows<I: IntoIterator<Item = usize>>(mut self, rows: I) -> Self {
        self.exclude_rows = rows.into_iter().collect();
        self
    }

    pub fn case_count(&self) -> u32 {
        self.cases
    }

    pub fn is_target_allowed(&self, target: Target) -> bool {
        self.targets.is_empty() || self.targets.contains(&target)
    }

    pub fn is_kind_allowed(&self, kind: MutationKind) -> bool {
        self.kinds.is_empty() || self.kinds.contains(&kind)
    }

    pub fn is_col_allowed(&self, col: usize) -> bool {
        if !self.include_cols.is_empty() && !self.include_cols.contains(&col) {
            return false;
        }

        !self.exclude_cols.contains(&col)
    }

    pub fn is_row_allowed(&self, row: usize) -> bool {
        if !self.include_rows.is_empty() && !self.include_rows.contains(&row) {
            return false;
        }

        !self.exclude_rows.contains(&row)
    }
}