zebra_chain/serialization/
error.rs

1//! Errors for Zcash consensus-critical serialization.
2
3use std::{array::TryFromSliceError, io, num::TryFromIntError, str::Utf8Error, sync::Arc};
4
5use hex::FromHexError;
6use thiserror::Error;
7
8/// A serialization error.
9// TODO: refine error types -- better to use boxed errors?
10#[derive(Clone, Error, Debug)]
11pub enum SerializationError {
12    /// An io error that prevented deserialization
13    #[error("io error: {0}")]
14    Io(#[from] Arc<io::Error>),
15
16    /// The data to be deserialized was malformed.
17    // TODO: refine errors
18    #[error("parse error: {0}")]
19    Parse(&'static str),
20
21    /// A string was not UTF-8.
22    ///
23    /// Note: Rust `String` and `str` are always UTF-8.
24    #[error("string was not UTF-8: {0}")]
25    Utf8Error(#[from] Utf8Error),
26
27    /// A slice was an unexpected length during deserialization.
28    #[error("slice was the wrong length: {0}")]
29    TryFromSliceError(#[from] TryFromSliceError),
30
31    /// The length of a vec is too large to convert to a usize (and thus, too large to allocate on this platform)
32    #[error("CompactSize too large: {0}")]
33    TryFromIntError(#[from] TryFromIntError),
34
35    /// A string was not valid hexadecimal.
36    #[error("string was not hex: {0}")]
37    FromHexError(#[from] FromHexError),
38
39    /// An error caused when validating a zatoshi `Amount`
40    #[error("input couldn't be parsed as a zatoshi `Amount`: {source}")]
41    Amount {
42        /// The source error indicating how the num failed to validate
43        #[from]
44        source: crate::amount::Error,
45    },
46
47    /// Invalid transaction with a non-zero balance and no Sapling shielded spends or outputs.
48    ///
49    /// Transaction does not conform to the Sapling [consensus
50    /// rule](https://zips.z.cash/protocol/protocol.pdf#txnencodingandconsensus).
51    #[error("transaction balance is non-zero but doesn't have Sapling shielded spends or outputs")]
52    BadTransactionBalance,
53}
54
55impl From<SerializationError> for io::Error {
56    fn from(e: SerializationError) -> Self {
57        match e {
58            SerializationError::Io(e) => {
59                Arc::try_unwrap(e).unwrap_or_else(|e| io::Error::new(e.kind(), e.to_string()))
60            }
61            SerializationError::Parse(msg) => io::Error::new(io::ErrorKind::InvalidData, msg),
62            SerializationError::Utf8Error(e) => io::Error::new(io::ErrorKind::InvalidData, e),
63            SerializationError::TryFromSliceError(e) => {
64                io::Error::new(io::ErrorKind::InvalidData, e)
65            }
66            SerializationError::TryFromIntError(e) => io::Error::new(io::ErrorKind::InvalidData, e),
67            SerializationError::FromHexError(e) => io::Error::new(io::ErrorKind::InvalidData, e),
68            SerializationError::Amount { source } => {
69                io::Error::new(io::ErrorKind::InvalidData, source)
70            }
71            SerializationError::BadTransactionBalance => io::Error::new(
72                io::ErrorKind::InvalidData,
73                "bad transaction balance: non-zero with no Sapling shielded spends or outputs",
74            ),
75        }
76    }
77}
78
79impl From<crate::Error> for SerializationError {
80    fn from(e: crate::Error) -> Self {
81        match e {
82            crate::Error::InvalidConsensusBranchId => Self::Parse("invalid consensus branch id"),
83            crate::Error::Io(e) => Self::Io(e),
84            crate::Error::MissingNetworkUpgrade => Self::Parse("missing network upgrade"),
85            crate::Error::Amount(_) => Self::BadTransactionBalance,
86            crate::Error::Conversion(_) => {
87                Self::Parse("Zebra's type could not be converted to its librustzcash equivalent")
88            }
89        }
90    }
91}
92
93/// Allow converting `io::Error` to `SerializationError`; we need this since we
94/// use `Arc<io::Error>` in `SerializationError::Io`.
95impl From<io::Error> for SerializationError {
96    fn from(value: io::Error) -> Self {
97        Arc::new(value).into()
98    }
99}
zebra_chain/serialization/error.rs

zebra_chain/serialization/
error.rs
