machine-cat 0.1.0

Generic AIR chip framework built on proof-cat
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

//! Project-wide error type.

/// All errors that can arise in machine-cat.
#[derive(Debug)]
pub enum Error {
    /// An error propagated from proof-cat.
    ProofCat(proof_cat::Error),
    /// An error propagated from plonkish-cat.
    Plonkish(plonkish_cat::Error),
    /// Column index out of bounds.
    ColumnOutOfBounds {
        /// The column index that was accessed.
        index: usize,
        /// The total number of columns.
        column_count: usize,
    },
    /// Trace has zero rows.
    EmptyTrace,
    /// Trace column count does not match the AIR's column count.
    ColumnCountMismatch {
        /// The expected column count (from the AIR).
        expected: usize,
        /// The actual column count (from the trace).
        actual: usize,
    },
    /// Trace row count is not a power of two.
    TraceNotPowerOfTwo {
        /// The row count.
        row_count: usize,
    },
    /// An AIR constraint was not satisfied at a row pair.
    UnsatisfiedAirConstraint {
        /// The row index of the failing pair.
        row: usize,
    },
    /// AIR has no constraints.
    NoConstraints,
    /// Trace has fewer than 2 rows.
    InsufficientRows {
        /// The row count.
        row_count: usize,
    },
    /// Row length does not match column count.
    RowLengthMismatch {
        /// The row index.
        row: usize,
        /// The expected length.
        expected: usize,
        /// The actual length.
        actual: usize,
    },
}

impl core::fmt::Display for Error {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        match self {
            Self::ProofCat(e) => write!(f, "proof-cat error: {e}"),
            Self::Plonkish(e) => write!(f, "plonkish-cat error: {e}"),
            Self::ColumnOutOfBounds {
                index,
                column_count,
            } => write!(
                f,
                "column index {index} out of bounds (column count: {column_count})"
            ),
            Self::EmptyTrace => write!(f, "trace has zero rows"),
            Self::ColumnCountMismatch { expected, actual } => {
                write!(
                    f,
                    "column count mismatch: expected {expected}, got {actual}"
                )
            }
            Self::TraceNotPowerOfTwo { row_count } => {
                write!(f, "trace row count {row_count} is not a power of two")
            }
            Self::UnsatisfiedAirConstraint { row } => {
                write!(f, "AIR constraint not satisfied at row pair ({row}, {})", row + 1)
            }
            Self::NoConstraints => write!(f, "AIR has no constraints"),
            Self::InsufficientRows { row_count } => {
                write!(f, "trace has {row_count} rows, need at least 2")
            }
            Self::RowLengthMismatch {
                row,
                expected,
                actual,
            } => write!(
                f,
                "row {row} has {actual} elements, expected {expected}"
            ),
        }
    }
}

impl std::error::Error for Error {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        match self {
            Self::ProofCat(e) => Some(e),
            Self::Plonkish(e) => Some(e),
            Self::ColumnOutOfBounds { .. }
            | Self::EmptyTrace
            | Self::ColumnCountMismatch { .. }
            | Self::TraceNotPowerOfTwo { .. }
            | Self::UnsatisfiedAirConstraint { .. }
            | Self::NoConstraints
            | Self::InsufficientRows { .. }
            | Self::RowLengthMismatch { .. } => None,
        }
    }
}

impl From<proof_cat::Error> for Error {
    fn from(e: proof_cat::Error) -> Self {
        Self::ProofCat(e)
    }
}

impl From<plonkish_cat::Error> for Error {
    fn from(e: plonkish_cat::Error) -> Self {
        Self::Plonkish(e)
    }
}