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
// Copyright (c) Microsoft Corporation.
// SPDX-License-Identifier: MIT
// This file is part of the Spartan2 project.
// See the LICENSE file in the project root for full license information.
// Source repository: https://github.com/Microsoft/Spartan2
//! This module defines errors returned by the library.
use core::fmt::Debug;
use thiserror::Error;
/// Errors returned by Spartan2
#[derive(Clone, Debug, Eq, PartialEq, Error)]
pub enum SpartanError {
/// returned if the supplied row or col in (row,col,val) tuple is out of range
#[error("InvalidIndex")]
InvalidIndex,
/// returned if the step circuit calls inputize or alloc_io in its synthesize method
/// instead of passing output with the return value
#[error("InvalidStepCircuitIO")]
InvalidStepCircuitIO,
/// returned if the supplied input is not of the right length
#[error("InvalidInputLength")]
InvalidInputLength {
/// The reason for the invalid input check failure
reason: String,
},
/// returned if the supplied witness is not of the right length
#[error("InvalidWitnessLength")]
InvalidWitnessLength,
/// returned if the supplied witness is not a satisfying witness to a given shape and instance
#[error("UnSat: {reason}")]
UnSat {
/// The reason for circuit UnSat failure
reason: String,
},
/// returned if proof verification fails
#[error("ProofVerifyError")]
ProofVerifyError {
/// The reason for the proof verification error
reason: String,
},
/// returned if the provided commitment key is not of sufficient length
#[error("InvalidCommitmentKeyLength")]
InvalidCommitmentKeyLength,
/// returned if the provided commitment is not of sufficient length
#[error("InvalidCommitmentLength: {reason}")]
InvalidCommitmentLength {
/// The reason for the invalid commitment length error
reason: String,
},
/// returned when an invalid PCS evaluation argument is provided
#[error("InvalidPCS")]
InvalidPCS {
/// The reason for the invalid PCS error
reason: String,
},
/// returned when an invalid sum-check proof is provided
#[error("InvalidSumcheckProof")]
InvalidSumcheckProof,
/// returned when the initial input to an incremental computation differs from a previously declared arity
#[error("InvalidInitialInputLength")]
InvalidInitialInputLength,
/// returned when the step execution produces an output whose length differs from a previously declared arity
#[error("InvalidStepOutputLength")]
InvalidStepOutputLength,
/// returned when the transcript engine encounters an overflow of the round number
#[error("InternalTranscriptError")]
InternalTranscriptError,
/// returned when the multiset check fails
#[error("InvalidMultisetProof")]
InvalidMultisetProof,
/// returned when the product proof check fails
#[error("InvalidProductProof")]
InvalidProductProof,
/// returned when the consistency with public IO and assignment used fails
#[error("IncorrectWitness")]
IncorrectWitness {
/// The reason for the incorrect witness error
reason: String,
},
/// return when error during synthesis
#[error("SynthesisError: {reason}")]
SynthesisError {
/// The reason for circuit synthesis failure
reason: String,
},
/// returned when there is an error creating a digest
#[error("DigestError")]
DigestError {
/// The reason for the digest error
reason: String,
},
/// returned when the prover cannot prove the provided statement due to completeness error
#[error("InternalError")]
InternalError {
/// The reason for the internal error
reason: String,
},
/// returned when attempting to divide by zero
#[error("DivisionByZero")]
DivisionByZero,
/// returned when input vector size exceeds commitment key capacity
#[error("InvalidVectorSize")]
InvalidVectorSize {
/// The actual size of the input vector
actual: usize,
/// The maximum size that can be handled
max: usize,
},
}