rostrum 14.0.1

An efficient implementation of Electrum Server with token support
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

use std::sync::Arc;
use std::time::Duration;

use electrum_client_netagnostic::{Client, Config, ConfigBuilder, ElectrumApi};
use serde_json::Value;

use super::peer::ServerPeer;
use anyhow::{Context, Result};

// Connection timeout until considering server peer bad
const CANDIDATE_TIMEOUT: Duration = Duration::from_secs(10);

pub struct ElectrumClient {
    client: Option<Arc<Client>>,
}

#[derive(PartialEq, Eq)]
pub enum Protocol {
    TCP,
    SSL,
    ANY,
}

async fn async_call(
    client: Arc<electrum_client_netagnostic::Client>,
    method_name: impl Into<String> + Send + 'static,
    params: impl IntoIterator<Item = electrum_client_netagnostic::Param> + Send + 'static,
) -> Result<Value> {
    let method_name = method_name.into();
    let params_vec: Vec<electrum_client_netagnostic::Param> = params.into_iter().collect();

    Ok(tokio::task::spawn_blocking(move || {
        // Because we use spawn_blocking, the entire call (client, method, params)
        // must be 'static and moved into this closure.
        client.raw_call(&method_name, params_vec)
    })
    .await??)
}

async fn connect(url: String, config: Config) -> Result<Client> {
    Ok(tokio::task::spawn_blocking(move || Client::from_config(&url, config)).await??)
}

impl ElectrumClient {
    async fn connect_ssl(peer: &dyn ServerPeer, config: Config) -> Result<Self> {
        let port = peer.ssl_port().context("SSL not supported by peer")?;

        let client = Arc::new(connect(format!("ssl://{}:{}", peer.ip(), port), config).await?);

        async_call(client.clone(), "server.ping", None)
            .await
            .context("Server did not respond to ping")?;

        Ok(Self {
            client: Some(client),
        })
    }

    async fn connect_tcp(peer: &dyn ServerPeer, config: Config) -> Result<Self> {
        let port = peer.tcp_port().context("TCP not supported by peer")?;

        let client = Arc::new(connect(format!("tcp://{}:{}", peer.ip(), port), config).await?);

        async_call(client.clone(), "server.ping", None)
            .await
            .context("Server did not respond to ping")?;

        Ok(Self {
            client: Some(client),
        })
    }

    fn default_config() -> Config {
        ConfigBuilder::new()
            .timeout(Some(CANDIDATE_TIMEOUT))
            .validate_domain(false)
            .build()
    }

    pub async fn connect(peer: &dyn ServerPeer, protocol: Protocol) -> Result<Self> {
        trace!(
            "discover: Connecting to electrum server {}",
            peer.pretty_hostname()
        );

        if protocol == Protocol::SSL {
            return Self::connect_ssl(peer, Self::default_config()).await;
        }

        if protocol == Protocol::TCP {
            return Self::connect_tcp(peer, Self::default_config()).await;
        }

        debug_assert!(protocol == Protocol::ANY);
        if let Ok(c) = Self::connect_ssl(peer, Self::default_config()).await {
            return Ok(c);
        }
        if let Ok(c) = Self::connect_tcp(peer, Self::default_config()).await {
            return Ok(c);
        }
        bail!("Unable to connec to peer via SSL or TCP");
    }

    pub async fn connect_all(peer: &dyn ServerPeer) -> (Result<Self>, Result<Self>) {
        let ssl = Self::connect_ssl(peer, Self::default_config()).await;
        let tcp = Self::connect_tcp(peer, Self::default_config()).await;
        (ssl, tcp)
    }

    pub async fn call(
        &self,
        method_name: impl Into<String> + Send + 'static,
        params: impl IntoIterator<Item = electrum_client_netagnostic::Param> + Send + 'static,
    ) -> Result<Value> {
        return async_call(
            self.client.as_ref().context("Not connected")?.clone(),
            method_name,
            params,
        )
        .await;
    }
}