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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

use std::{net::SocketAddr, sync::Arc};

use anyhow::Result;
use bitcoincash::Network;
use prometheus::HistogramVec;

use crate::{
    daemon::CookieGetter,
    errors::ConnectionError,
    metrics::{default_duration_buckets, default_size_buckets, Metrics},
    signal::NetworkNotifier,
};

use super::{p2pconnection::P2PConnection, rpcconnection::RPCConnection};

/**
 * BB8 RPC connection pool manager for bitcoind
 */
pub struct BitcoindRPCConnectionManager {
    addr: SocketAddr,
    cookie_getter: Arc<dyn CookieGetter>,
}

impl BitcoindRPCConnectionManager {
    pub fn new(addr: SocketAddr, cookie_getter: Arc<dyn CookieGetter>) -> Self {
        Self {
            addr,
            cookie_getter,
        }
    }
}

impl bb8::ManageConnection for BitcoindRPCConnectionManager {
    type Connection = crate::daemon::rpcconnection::RPCConnection;

    type Error = crate::errors::ConnectionError;

    async fn connect(&self) -> Result<Self::Connection, Self::Error> {
        RPCConnection::new(self.addr, self.cookie_getter.clone())
    }

    async fn is_valid(&self, conn: &mut Self::Connection) -> Result<(), Self::Error> {
        match conn.request("ping", &None).await {
            Ok(_) => Ok(()),
            Err(e) => Err(Self::Error {
                msg: format!("ping failed: {e}"),
            }),
        }
    }

    fn has_broken(&self, conn: &mut Self::Connection) -> bool {
        conn.is_broken()
    }
}

/**
 * BB8 P2P connection pool manager for bitcoind
 */
pub struct BitcoindP2PConnectionManager {
    network: Network,
    addr: SocketAddr,
    network_notifier: Arc<NetworkNotifier>,
    send_duration: Arc<HistogramVec>,
    recv_duration: Arc<HistogramVec>,
    parse_duration: Arc<HistogramVec>,
    recv_size: Arc<HistogramVec>,
}

impl BitcoindP2PConnectionManager {
    pub fn new(
        network: Network,
        addr: SocketAddr,
        network_notifier: Arc<NetworkNotifier>,
        metrics: &Metrics,
    ) -> Self {
        let send_duration = Arc::new(metrics.histogram_vec(
            "rostrum_p2p_send_duration",
            "Time spent sending p2p messages (in seconds)",
            &["step"],
            default_duration_buckets(),
        ));
        let recv_duration = Arc::new(metrics.histogram_vec(
            "rostrum_p2p_recv_duration",
            "Time spent receiving p2p messages (in seconds)",
            &["step"],
            default_duration_buckets(),
        ));
        let parse_duration = Arc::new(metrics.histogram_vec(
            "rostrum_p2p_parse_duration",
            "Time spent parsing p2p messages (in seconds)",
            &["step"],
            default_duration_buckets(),
        ));
        let recv_size = Arc::new(metrics.histogram_vec(
            "rostrum_p2p_recv_size",
            "Size of p2p messages read (in bytes)",
            &["message"],
            default_size_buckets(),
        ));

        Self {
            network,
            addr,
            network_notifier,
            send_duration,
            recv_duration,
            parse_duration,
            recv_size,
        }
    }
}

impl bb8::ManageConnection for BitcoindP2PConnectionManager {
    type Connection = crate::daemon::p2pconnection::P2PConnection;

    type Error = crate::errors::ConnectionError;

    async fn connect(&self) -> Result<Self::Connection, Self::Error> {
        P2PConnection::connect(
            self.network,
            self.addr,
            self.network_notifier.clone(),
            Arc::clone(&self.send_duration),
            Arc::clone(&self.recv_duration),
            Arc::clone(&self.parse_duration),
            Arc::clone(&self.recv_size),
        )
        .await
    }

    async fn is_valid(&self, conn: &mut Self::Connection) -> Result<(), Self::Error> {
        match conn.is_broken() {
            true => Ok(()),
            false => Err(ConnectionError {
                msg: "Connection broken".to_string(),
            }),
        }
    }

    fn has_broken(&self, conn: &mut Self::Connection) -> bool {
        conn.is_broken()
    }
}