tari_mmr/

error.rs

// Copyright 2019 The Tari Project
//
// Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
// following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
// disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
// following disclaimer in the documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
// products derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
// USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

use thiserror::Error;

#[derive(Debug, Error, PartialEq, Eq, Clone)]
pub enum MerkleMountainRangeError {
    #[error("The next position was not a leaf node as expected")]
    CorruptDataStructure,
    #[error("A problem has been encountered with the backend: `{0}`")]
    BackendError(String),
    #[error("The Merkle tree is not internally consistent. A parent hash isn't equal to the hash of its children")]
    InvalidMerkleTree,
    #[error("The tree has reached its maximum size")]
    MaximumSizeReached,
    #[error("A node hash was not found for the given node index: `{0}`")]
    HashNotFound(usize),
    #[error("A request was out of range")]
    OutOfRange,
    #[error("Conflicting or invalid configuration parameters provided.")]
    InvalidConfig,
    #[error("Invalid Merkle Mountain Range size")]
    InvalidMmrSize,
    #[error("Invalid leaf index")]
    InvalidLeafIndex,
}

impl MerkleMountainRangeError {
    pub fn backend_error<E: ToString>(err: &E) -> Self {
        Self::BackendError(err.to_string())
    }
}