kontor-crypto 0.1.5

Kontor Proof-of-Retrievability system for decentralized storage
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

//! Error types for the Kontor PoR library

/// Error types for the Kontor PoR library
#[derive(Debug, thiserror::Error)]
pub enum KontorPoRError {
    /// Merkle tree construction or operations failed
    #[error("Merkle tree error: {0}")]
    MerkleTree(String),

    /// Circuit construction or synthesis failed
    #[error("Circuit error: {0}")]
    Circuit(String),

    /// SNARK creation or verification failed
    #[error("SNARK error: {0}")]
    Snark(String),

    /// Invalid input parameters (generic fallback)
    #[error("Invalid input: {0}")]
    InvalidInput(String),

    /// Empty data provided where non-empty data is required
    #[error("Empty data: {operation} requires non-empty input data")]
    EmptyData { operation: String },

    /// Too many files requested
    #[error("Too many files: {got} exceeds limit of {max}")]
    TooManyFiles { got: usize, max: usize },

    /// File not found in collection
    #[error("File not found: {file_id}")]
    FileNotFound { file_id: String },

    /// File not found in ledger
    #[error("File not in ledger: {file_id} (possible depth spoofing)")]
    FileNotInLedger { file_id: String },

    /// Inconsistent challenge parameters
    #[error("Challenge mismatch: {field} values must be consistent across all challenges")]
    ChallengeMismatch { field: String },

    /// Invalid challenge count
    #[error("Invalid challenge count: {count} (must be > 0 and <= {max})", max = crate::config::MAX_NUM_CHALLENGES)]
    InvalidChallengeCount { count: usize },

    /// Chunk size validation failed
    #[error("Invalid chunk size: {size} bytes (must be > 0 and ≤ {max})")]
    InvalidChunkSize { size: usize, max: usize },

    /// File metadata mismatch
    #[error("Metadata mismatch: file root does not match expected value")]
    MetadataMismatch,

    /// Erasure coding validation failed
    #[error("Erasure coding error: {details}")]
    ErasureCoding { details: String },

    /// Ledger validation failed
    #[error("Ledger validation failed: {reason}")]
    LedgerValidation { reason: String },

    /// Invalid ledger root in proof (not in historical roots)
    #[error("Invalid ledger root in proof: {proof_root} - {reason}")]
    InvalidLedgerRoot { proof_root: String, reason: String },

    /// Cryptographic operation failed
    #[error("Cryptographic error: {0}")]
    Cryptographic(String),

    /// Serialization/deserialization failed
    #[error("Serialization error: {0}")]
    Serialization(String),

    /// IO operation failed
    #[error("IO error: {0}")]
    IO(String),

    /// Index out of bounds
    #[error("Index out of bounds: index {index}, length {length}")]
    IndexOutOfBounds { index: usize, length: usize },

    /// Invalid chunk encoding (chunk too large for field)
    #[error("Invalid chunk encoding: chunk size {size} bytes exceeds maximum {max} bytes")]
    InvalidChunkEncoding { size: usize, max: usize },
}

/// Convenience Result type for Kontor PoR operations
pub type Result<T> = std::result::Result<T, KontorPoRError>;