esplora-tapyrus 0.5.8

An efficient re-implementation of Electrum Server in Rust
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

use std::collections::HashMap;
use std::convert::{TryFrom, TryInto};
use std::net::ToSocketAddrs;

use tapyrus::{hashes::Hash, BlockHash};
use electrum_client::client::{
    Client as RClient, ElectrumPlaintextStream, ElectrumProxyStream, ElectrumSslStream,
};
pub use electrum_client::types::ServerFeaturesRes;
pub use electrum_client::Error as ElectrumError;

use crate::electrum::ServerFeatures;
use crate::errors::{Error, ResultExt};

pub enum Client {
    Tcp(RClient<ElectrumPlaintextStream>),
    Ssl(RClient<ElectrumSslStream>),
    ProxyTcp(RClient<ElectrumProxyStream>),
    // proxy+ssl on the same connection appears to be unsupported by the electrum_client crate
}

// impl<S: Read + Write> Client<S> {

impl Client {
    pub fn new<A: ToSocketAddrs>(socket_addr: A) -> Result<Self, ElectrumError> {
        Ok(Client::Tcp(RClient::new(socket_addr)?))
    }

    pub fn new_ssl(domain_addr: (&str, u16)) -> Result<Self, ElectrumError> {
        // SSL certificates are not validated
        Ok(Client::Ssl(RClient::new_ssl(domain_addr, false)?))
        // XXX this should ideally use the previously resolved IP address instead of the hostname, which
        // shuold be possible because we don't validate, but it appears like rustls does not support this.
    }

    pub fn new_proxy<A: ToSocketAddrs>(
        target_addr: (&str, u16),
        proxy_addr: A,
    ) -> Result<Self, ElectrumError> {
        Ok(Client::ProxyTcp(RClient::new_proxy(
            target_addr,
            proxy_addr,
        )?))
    }

    pub fn server_features(&mut self) -> Result<ServerFeatures, Error> {
        match self {
            Client::Tcp(c) => c.server_features(),
            Client::Ssl(c) => c.server_features(),
            Client::ProxyTcp(c) => c.server_features(),
        }?
        .try_into()
    }

    pub fn server_add_peer(&mut self, features: &ServerFeatures) -> Result<bool, ElectrumError> {
        match self {
            Client::Tcp(c) => c.server_add_peer(features),
            Client::Ssl(c) => c.server_add_peer(features),
            Client::ProxyTcp(c) => c.server_add_peer(features),
        }
    }
}

// Convert from electrum-client's server features struct to ours. We're using a different struct because
// the electrum-client's one doesn't support the "hosts" key.
impl TryFrom<ServerFeaturesRes> for ServerFeatures {
    type Error = Error;
    fn try_from(mut features: ServerFeaturesRes) -> Result<Self, Self::Error> {
        Ok(ServerFeatures {
            // electrum-client doesn't retain the hosts map data, but we already have it from the add_peer request
            hosts: HashMap::new(),
            server_version: features.server_version,
            protocol_min: features
                .protocol_min
                .parse()
                .chain_err(|| "invalid protocol_min")?,
            protocol_max: features
                .protocol_max
                .parse()
                .chain_err(|| "invalid protocol_max")?,
            pruning: features.pruning.map(|pruning| pruning as usize),
            hash_function: features
                .hash_function
                .chain_err(|| "missing hash_function")?,
        })
    }
}