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

// Copyright (C) 2019-2023 Aleo Systems Inc.
// This file is part of the snarkVM library.

// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at:
// http://www.apache.org/licenses/LICENSE-2.0

// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

pub type SynthesisResult<T> = Result<T, SynthesisError>;

/// This is an error that could occur during circuit synthesis contexts,
/// such as CRS generation, proving or verification.
#[derive(Debug, Error)]
pub enum SynthesisError {
    #[error("{}", _0)]
    AnyhowError(#[from] anyhow::Error),
    /// During synthesis, we lacked knowledge of a variable assignment.
    #[error("An assignment for a variable could not be computed")]
    AssignmentMissing,
    /// Handles a failed conversion of objects into constraint field elements.
    #[error("Failed to convert object into constraint field elements")]
    ConstraintFieldError(#[from] snarkvm_fields::ConstraintFieldError),
    /// During synthesis, we divided by zero.
    #[error("Division by zero during synthesis")]
    DivisionByZero,
    /// During synthesis, we constructed an unsatisfiable constraint system.
    #[error("Unsatisfiable constraint system")]
    Unsatisfiable,
    /// During synthesis, our polynomials ended up being too high of degree
    #[error("Polynomial degree is too large")]
    PolynomialDegreeTooLarge,
    /// During proof generation, we encountered an identity in the CRS
    #[error("Encountered an identity element in the CRS")]
    UnexpectedIdentity,
    /// During proof generation, we encountered an I/O error with the CRS
    #[error("Encountered an I/O error")]
    IoError(std::io::Error),
    /// During verification, our verifying key was malformed.
    #[error("Malformed verifying key, public input count was {} but expected {}", _0, _1)]
    MalformedVerifyingKey(usize, usize),
    /// During CRS generation, we observed an unconstrained auxiliary variable
    #[error("Auxiliary variable was unconstrained")]
    UnconstrainedVariable,
}

impl From<std::io::Error> for SynthesisError {
    fn from(e: std::io::Error) -> SynthesisError {
        SynthesisError::IoError(e)
    }
}