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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
#![warn(missing_docs)]
use bitcoind::bitcoincore_rpc::RpcApi;
use bitcoind::tempfile::TempDir;
use bitcoind::{get_available_port, BitcoinD};
use electrum_client::raw_client::{ElectrumPlaintextStream, RawClient};
use std::ffi::OsStr;
use std::process::{Child, Command, Stdio};
use std::time::Duration;
pub use bitcoind;
pub struct ElectrsD {
process: Child,
pub client: RawClient<ElectrumPlaintextStream>,
_db_dir: TempDir,
pub electrum_url: String,
pub esplora_url: Option<String>,
}
#[derive(Debug)]
pub enum Error {
Io(std::io::Error),
Bitcoind(bitcoind::Error),
ElectrumClient(electrum_client::Error),
BitcoinCoreRpc(bitcoind::bitcoincore_rpc::Error),
#[cfg(feature = "trigger")]
Nix(nix::Error),
}
impl ElectrsD {
pub fn new<S: AsRef<OsStr>>(
exe: S,
bitcoind: &BitcoinD,
view_stderr: bool,
http_enabled: bool,
) -> Result<ElectrsD, Error> {
if bitcoind
.client
.get_blockchain_info()?
.initial_block_download
{
let node_address = bitcoind.client.get_new_address(None, None).unwrap();
bitcoind
.client
.generate_to_address(1, &node_address)
.unwrap();
}
let mut args = vec!["-vvv"];
let _db_dir = TempDir::new()?;
let db_dir = format!("{}", _db_dir.path().display());
args.push("--db-dir");
args.push(&db_dir);
args.push("--network");
args.push("regtest");
#[cfg(not(feature = "legacy"))]
let cookie_file;
#[cfg(not(feature = "legacy"))]
{
args.push("--cookie-file");
cookie_file = format!("{}", bitcoind.params.cookie_file.display());
args.push(&cookie_file);
}
#[cfg(feature = "legacy")]
let mut cookie_value;
#[cfg(feature = "legacy")]
{
use std::io::Read;
args.push("--cookie");
let mut cookie = std::fs::File::open(&bitcoind.params.cookie_file)?;
cookie_value = String::new();
cookie.read_to_string(&mut cookie_value)?;
args.push(&cookie_value);
}
args.push("--daemon-rpc-addr");
let rpc_socket = bitcoind.params.rpc_socket.to_string();
args.push(&rpc_socket);
args.push("--jsonrpc-import");
let electrum_url = format!("0.0.0.0:{}", get_available_port()?);
args.push("--electrum-rpc-addr");
args.push(&electrum_url);
let monitoring = format!("0.0.0.0:{}", get_available_port()?);
args.push("--monitoring-addr");
args.push(&monitoring);
let esplora_url_string;
let esplora_url = if http_enabled {
esplora_url_string = format!("0.0.0.0:{}", get_available_port()?);
args.push("--http-addr");
args.push(&esplora_url_string);
#[allow(clippy::redundant_clone)]
Some(esplora_url_string.clone())
} else {
None
};
let view_stderr = if view_stderr {
Stdio::inherit()
} else {
Stdio::null()
};
eprintln!("args: {:?}", args);
let process = Command::new(exe).args(args).stderr(view_stderr).spawn()?;
let client = loop {
match RawClient::new(&electrum_url, None) {
Ok(client) => break client,
Err(_) => std::thread::sleep(Duration::from_millis(500)),
}
};
Ok(ElectrsD {
process,
client,
_db_dir,
electrum_url,
esplora_url,
})
}
#[cfg(feature = "trigger")]
pub fn trigger(&self) -> Result<(), Error> {
Ok(nix::sys::signal::kill(
nix::unistd::Pid::from_raw(self.process.id() as i32),
nix::sys::signal::SIGUSR1,
)?)
}
}
impl Drop for ElectrsD {
fn drop(&mut self) {
let _ = self.process.kill();
}
}
impl From<std::io::Error> for Error {
fn from(e: std::io::Error) -> Self {
Error::Io(e)
}
}
impl From<bitcoind::Error> for Error {
fn from(e: bitcoind::Error) -> Self {
Error::Bitcoind(e)
}
}
impl From<electrum_client::Error> for Error {
fn from(e: electrum_client::Error) -> Self {
Error::ElectrumClient(e)
}
}
impl From<bitcoind::bitcoincore_rpc::Error> for Error {
fn from(e: bitcoind::bitcoincore_rpc::Error) -> Self {
Error::BitcoinCoreRpc(e)
}
}
#[cfg(feature = "trigger")]
impl From<nix::Error> for Error {
fn from(e: nix::Error) -> Self {
Error::Nix(e)
}
}
#[cfg(test)]
mod test {
use crate::ElectrsD;
use bitcoind::bitcoincore_rpc::RpcApi;
use bitcoind::{downloaded_exe_path, BitcoinD, Conf};
use electrum_client::ElectrumApi;
use std::env;
#[test]
fn test_electrsd() {
let bitcoind_exe = downloaded_exe_path().unwrap();
let electrs_exe = env::var("ELECTRS_EXE").expect("ELECTRS_EXE env var must be set");
let conf = Conf {
view_stdout: true,
..Default::default()
};
let bitcoind = BitcoinD::with_conf(&bitcoind_exe, &conf).unwrap();
let electrsd = ElectrsD::new(&electrs_exe, &bitcoind, true, false).unwrap();
let header = electrsd.client.block_headers_subscribe().unwrap();
assert_eq!(header.height, 1);
let address = bitcoind.client.get_new_address(None, None).unwrap();
bitcoind.client.generate_to_address(100, &address).unwrap();
#[cfg(feature = "trigger")]
electrsd.trigger().unwrap();
let header = loop {
std::thread::sleep(std::time::Duration::from_secs(1));
let header = electrsd.client.block_headers_subscribe().unwrap();
if header.height > 100 {
break header;
}
};
assert_eq!(header.height, 101);
let electrsd = ElectrsD::new(&electrs_exe, &bitcoind, true, false).unwrap();
let header = electrsd.client.block_headers_subscribe().unwrap();
assert_eq!(header.height, 101);
}
}