sn_transfers 0.11.0

Safe Network Transfer Logic
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

// Copyright 2023 MaidSafe.net limited.
//
// This SAFE Network Software is licensed to you under The General Public License (GPL), version 3.
// Unless required by applicable law or agreed to in writing, the SAFE Network Software distributed
// under the GPL Licence is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. Please review the Licences for the specific language governing
// permissions and limitations relating to use of the SAFE Network Software.

use sn_dbc::Hash;
use thiserror::Error;
use xor_name::XorName;

pub(crate) type Result<T> = std::result::Result<T, Error>;

/// Error type returned by the payment_proof utilities
#[derive(Debug, Error)]
#[non_exhaustive]
pub enum Error {
    /// Failed to build the payment proof tree
    #[error("Failed to build the payment proof tree: {0}")]
    ProofTree(String),
    /// Failed to generate the audit trail for an item
    #[error("Failed to generate the audit trail for leaf item #{index}: {reason}")]
    GenAuditTrail { index: usize, reason: String },
    /// Failed to build an audit trail from the provided information
    #[error("Failed to build an audit trail from the provided information: {0}")]
    InvalidAuditTrail(String),
    /// The given audit trail deemed invalid
    #[error("The given payment proof audit trail failed to self-validate: {0}")]
    AuditTrailSelfValidation(String),
    /// The leaf data for which proof was generated doesn't match the given item
    #[error("The leaf data for which proof was generated doesn't match the given item: {0:?}")]
    AuditTrailItemMismatch(XorName),
    /// The root data of the proof doesn't match the given hash
    #[error(
        "The root data of the proof doesn't match the given hash: {}",
        .0.to_hex()
    )]
    RootHashMismatch(Hash),
}