tari_crypto 0.23.0

Tari Cryptography library
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

// Copyright 2019. The Tari Project
// SPDX-License-Identifier: BSD-3-Clause

//! Errors used in the Tari Crypto crate

use alloc::string::String;

use snafu::prelude::*;
/// Errors encountered when creating of verifying range proofs
#[derive(Debug, Clone, Snafu, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum RangeProofError {
    /// Cold not construct a range proof
    #[snafu(display("Could not construct range proof: `{reason}'"))]
    ProofConstructionError {
        /// The reason for the error
        reason: String,
    },
    /// The deserialization of the range proof failed
    #[snafu(display("The deserialization of the range proof failed"))]
    InvalidProof {},
    /// Invalid input was provided to the RangeProofService constructor
    #[snafu(display("Invalid input was provided to the RangeProofService constructor: `{reason}'"))]
    InitializationError {
        /// The reason for the error
        reason: String,
    },
    /// Invalid range proof provided
    #[snafu(display("Invalid range proof provided: `{reason}"))]
    InvalidRangeProof {
        /// The reason for the error
        reason: String,
    },
    /// Invalid range proof rewind, the rewind keys provided must be invalid
    #[snafu(display("Invalid range proof rewind, the rewind keys provided must be invalid: `{reason}'"))]
    InvalidRewind {
        /// The reason for the error
        reason: String,
    },
    /// Inconsistent extension degree
    #[snafu(display("Inconsistent extension degree: `{reason}'"))]
    RPExtensionDegree {
        /// The reason for the error
        reason: String,
    },
}

/// Errors encountered when committing values
#[derive(Debug, Clone, Snafu, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum CommitmentError {
    /// Inconsistent extension degree
    #[snafu(display("Inconsistent extension degree: `{reason}'"))]
    CommitmentExtensionDegree {
        /// The reason for the error
        reason: String,
    },
}

/// Errors encountered when hashing
#[derive(Debug, Snafu, PartialEq, Eq)]
pub enum HashingError {
    /// The input to the hashing function is too short
    #[snafu(display("The input to the hashing function is too short."))]
    InputTooShort {},
    /// Converting a byte string into a secret key failed
    #[snafu(display("Converting a byte string into a secret key failed.  `{reason}'"))]
    ConversionFromBytes {
        /// The reason for the error
        reason: String,
    },
    /// The digest does not produce enough output
    #[snafu(display("The digest does not produce enough output.`{bytes}' bytes are required."))]
    DigestTooShort {
        /// The number of bytes required
        bytes: usize,
    },
}

/// Errors encountered when copying to a buffer
#[derive(Debug, Clone, Snafu, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum SliceError {
    /// The requested fixed slice length exceeds the available slice length
    #[snafu(display("Cannot create fixed slice of length '{target}' from a slice of length '{provided}'"))]
    CopyFromSlice {
        /// The requested fixed slice length
        target: usize,
        /// The available slice length
        provided: usize,
    },
}