zingolib 0.0.1

Zingo backend 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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

//! TODO: Add Mod Description Here!

use std::error::Error;
use std::fmt;

use zcash_primitives::transaction::TxId;

/// Holds zingolib error types
#[derive(Debug)]
pub enum ZingoLibError {
    /// TODO: Add Doc Comment Here!
    UnknownError,
    /// TODO: Add Doc Comment Here!
    Error(String),
    /// TODO: Add Doc Comment Here!
    NoWalletLocation,
    /// TODO: Add Doc Comment Here!
    MetadataUnderflow(String),
    /// TODO: Add Doc Comment Here!
    InternalWriteBufferError(std::io::Error),
    /// TODO: Add Doc Comment Here!
    WriteFileError(std::io::Error),
    /// TODO: Add Doc Comment Here!
    EmptySaveBuffer,
    /// TODO: Add Doc Comment Here!
    CantReadWallet(std::io::Error),
    /// TODO: Add Doc Comment Here!
    NoSuchTxId(TxId),
    /// TODO: Add Doc Comment Here!
    NoSuchSaplingOutputInTx(TxId, u32),
    /// TODO: Add Doc Comment Here!
    NoSuchOrchardOutputInTx(TxId, u32),
    /// TODO: Add Doc Comment Here!
    NoSuchNullifierInTx(TxId),
    /// TODO: Add Doc Comment Here!
    MissingOutputIndex(TxId),
    /// TODO: Add Doc Comment Here!
    CouldNotDecodeMemo(std::io::Error),
    /// server error
    Lightwalletd(String),
}

/// TODO: Add Doc Comment Here!
pub type ZingoLibResult<T> = Result<T, ZingoLibError>;

impl ZingoLibError {
    /// TODO: Add Doc Comment Here!
    pub fn handle<T>(self) -> ZingoLibResult<T> {
        log::error!("{}", self);
        Err(self)
    }
}

impl std::fmt::Display for ZingoLibError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        use ZingoLibError::*;
        match self {
            UnknownError => write!(f, "UnknownError",),
            Error(string) => write!(f, "Error: {}", string,),
            NoWalletLocation => write!(
                f,
                "No wallet location! (compiled for native rust, wallet location expected)"
            ),
            MetadataUnderflow(explanation) => write!(
                f,
                "Metadata underflow! Recorded metadata shows greater output than input value. This may be because input notes are prebirthday. {}",
                explanation,
            ),
            InternalWriteBufferError(err) => write!(f, "Internal save error! {} ", err,),
            WriteFileError(err) => write!(
                f,
                "Could not write to wallet save file. Was this erroneously attempted in mobile?, instead of native save buffer handling? Is there a permission issue? {} ",
                err,
            ),
            EmptySaveBuffer => write!(
                f,
                "Empty save buffer. probably save_external was called before save_internal_rust. this is handled by save_external."
            ),
            CantReadWallet(err) => write!(
                f,
                "Cant read wallet. Corrupt file. Or maybe a backwards version issue? {}",
                err,
            ),
            NoSuchTxId(txid) => write!(f, "Cant find TxId {}!", txid,),
            NoSuchSaplingOutputInTx(txid, output_index) => write!(
                f,
                "Cant find note with sapling output_index {} in TxId {}",
                output_index, txid,
            ),
            NoSuchOrchardOutputInTx(txid, output_index) => write!(
                f,
                "Cant find note with orchard output_index {} in TxId {}",
                output_index, txid,
            ),
            NoSuchNullifierInTx(txid) => write!(f, "Cant find that Nullifier in TxId {}", txid,),
            CouldNotDecodeMemo(err) => write!(
                f,
                "Could not decode memo. Zingo plans to support foreign memo formats soon. {}",
                err,
            ),
            MissingOutputIndex(txid) => write!(
                f,
                "{txid} is missing output_index for note, cannot mark change"
            ),
            Lightwalletd(string) => write!(f, "{string}"),
        }
    }
}

impl From<ZingoLibError> for String {
    fn from(value: ZingoLibError) -> Self {
        format!("{value}")
    }
}

impl Error for ZingoLibError {}

/// Errors associated with builder patterns in production code
#[derive(thiserror::Error, Debug)]
pub enum BuildError {
    /// build failed. missing field.
    #[error("build failed. missing field {0}")]
    MissingField(String),
}