bip157 0.5.0

A Bitcoin light-client according to the BIP-157/BIP-158 specifications
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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165

use crate::impl_sourceless_error;

use bip324::serde;
use bitcoin::consensus::encode;
use tokio::io;
use tokio::sync::mpsc;

#[derive(Debug)]
pub(crate) enum ReaderError {
    Io(io::Error),
    InvalidDeserialization,
    DecryptionFailed(bip324::Error),
    MessageTooLarge,
    ChannelClosed,
}

impl core::fmt::Display for ReaderError {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        match self {
            ReaderError::Io(err) => write!(f, "reading bytes off the stream failed: {err}"),
            ReaderError::InvalidDeserialization => {
                write!(f, "the message could not be properly deserialized.")
            }
            ReaderError::MessageTooLarge => write!(f, "OOM protection."),
            ReaderError::ChannelClosed => write!(f, "sending over the channel failed."),
            ReaderError::DecryptionFailed(err) => write!(f, "decrypting a message failed: {err}"),
        }
    }
}

impl_sourceless_error!(ReaderError);

impl<T> From<mpsc::error::SendError<T>> for ReaderError {
    fn from(_value: mpsc::error::SendError<T>) -> Self {
        Self::ChannelClosed
    }
}

impl From<io::Error> for ReaderError {
    fn from(value: io::Error) -> Self {
        Self::Io(value)
    }
}

impl From<encode::Error> for ReaderError {
    fn from(_value: encode::Error) -> Self {
        Self::InvalidDeserialization
    }
}

impl From<serde::Error> for ReaderError {
    fn from(_value: serde::Error) -> Self {
        Self::InvalidDeserialization
    }
}

impl From<bip324::Error> for ReaderError {
    fn from(value: bip324::Error) -> Self {
        Self::DecryptionFailed(value)
    }
}

#[derive(Debug)]
pub(crate) enum PeerError {
    ConnectionFailed,
    Encryption(bip324::Error),
    Serialization(serde::Error),
    HandshakeFailed,
    Io(io::Error),
    ChannelClosed,
    DisconnectCommand,
    UnreachableSocketAddr,
    Socks5(Socks5Error),
}

impl core::fmt::Display for PeerError {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        match self {
            PeerError::ConnectionFailed => {
                write!(f, "the peer's TCP port was closed or we could not connect.")
            }
            PeerError::Io(err) => write!(f, "a message could not be written to the peer: {err}"),
            PeerError::ChannelClosed => write!(
                f,
                "experienced an error sending a message over the channel."
            ),
            PeerError::DisconnectCommand => {
                write!(f, "the main thread advised this peer to disconnect.")
            }
            PeerError::UnreachableSocketAddr => {
                write!(f, "cannot make use of provided p2p address.")
            }
            PeerError::Serialization(err) => {
                write!(f, "serializing a message into bytes failed: {err}")
            }
            PeerError::HandshakeFailed => {
                write!(f, "an attempted V2 transport handshake failed.")
            }
            PeerError::Encryption(err) => {
                write!(f, "encrypting a serialized message failed: {err}")
            }
            PeerError::Socks5(err) => {
                write!(f, "could not connect via Socks5 proxy: {err}")
            }
        }
    }
}

impl_sourceless_error!(PeerError);

impl From<io::Error> for PeerError {
    fn from(value: io::Error) -> Self {
        Self::Io(value)
    }
}

impl<T> From<mpsc::error::SendError<T>> for PeerError {
    fn from(_value: mpsc::error::SendError<T>) -> Self {
        Self::ChannelClosed
    }
}

impl From<bip324::Error> for PeerError {
    fn from(value: bip324::Error) -> Self {
        Self::Encryption(value)
    }
}

impl From<serde::Error> for PeerError {
    fn from(value: serde::Error) -> Self {
        Self::Serialization(value)
    }
}

#[derive(Debug)]
pub(crate) enum Socks5Error {
    WrongVersion,
    AuthRequired,
    ConnectionTimeout,
    ConnectionFailed,
    Io(io::Error),
}

impl core::fmt::Display for Socks5Error {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        match self {
            Socks5Error::WrongVersion => write!(f, "server responded with an unsupported version."),
            Socks5Error::AuthRequired => write!(f, "server requires authentication."),
            Socks5Error::ConnectionTimeout => write!(f, "connection to server timed out."),
            Socks5Error::ConnectionFailed => write!(
                f,
                "the server could not connect to the requested destination."
            ),
            Socks5Error::Io(err) => write!(f, "socks5 io failed unexpectedly: {err}"),
        }
    }
}

impl_sourceless_error!(Socks5Error);

impl From<std::io::Error> for Socks5Error {
    fn from(value: std::io::Error) -> Self {
        Socks5Error::Io(value)
    }
}