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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
#![deny(missing_docs)]
mod versions;
use crate::bitcoincore_rpc::jsonrpc::serde_json::Value;
use bitcoincore_rpc::{Auth, Client, RpcApi};
use log::debug;
use std::ffi::OsStr;
use std::net::{Ipv4Addr, SocketAddrV4, TcpListener};
use std::path::PathBuf;
use std::process::{Child, Command, ExitStatus, Stdio};
use std::thread;
use std::time::Duration;
use tempfile::TempDir;
pub extern crate core_rpc as bitcoincore_rpc;
pub extern crate tempfile;
pub struct BitcoinD {
process: Child,
pub client: Client,
_work_dir: TempDir,
pub params: ConnectParams,
}
#[derive(Debug, Clone)]
pub struct ConnectParams {
pub datadir: PathBuf,
pub cookie_file: PathBuf,
pub rpc_socket: SocketAddrV4,
pub p2p_socket: Option<SocketAddrV4>,
}
#[derive(Debug, PartialEq, Eq)]
pub enum P2P {
No,
Yes,
Connect(SocketAddrV4, bool),
}
#[derive(Debug)]
pub enum Error {
Io(std::io::Error),
Rpc(bitcoincore_rpc::Error),
}
const LOCAL_IP: Ipv4Addr = Ipv4Addr::new(127, 0, 0, 1);
#[non_exhaustive]
#[derive(Debug, PartialEq, Eq)]
pub struct Conf<'a> {
pub args: Vec<&'a str>,
pub view_stdout: bool,
pub p2p: P2P,
pub network: &'a str,
}
impl Default for Conf<'_> {
fn default() -> Self {
Conf {
args: vec!["-regtest", "-fallbackfee=0.0001"],
view_stdout: false,
p2p: P2P::No,
network: "regtest",
}
}
}
impl BitcoinD {
pub fn new<S: AsRef<OsStr>>(exe: S) -> Result<BitcoinD, Error> {
BitcoinD::with_conf(exe, &Conf::default())
}
pub fn with_conf<S: AsRef<OsStr>>(exe: S, conf: &Conf) -> Result<BitcoinD, Error> {
let _work_dir = TempDir::new()?;
let datadir = _work_dir.path().to_path_buf();
let cookie_file = datadir.join(conf.network).join(".cookie");
let rpc_port = get_available_port()?;
let rpc_socket = SocketAddrV4::new(LOCAL_IP, rpc_port);
let rpc_url = format!("http://{}", rpc_socket);
let (p2p_args, p2p_socket) = match conf.p2p {
P2P::No => (vec!["-listen=0".to_string()], None),
P2P::Yes => {
let p2p_port = get_available_port()?;
let p2p_socket = SocketAddrV4::new(LOCAL_IP, p2p_port);
let p2p_arg = format!("-port={}", p2p_port);
let args = vec![p2p_arg];
(args, Some(p2p_socket))
}
P2P::Connect(other_node_url, listen) => {
let p2p_port = get_available_port()?;
let p2p_socket = SocketAddrV4::new(LOCAL_IP, p2p_port);
let p2p_arg = format!("-port={}", p2p_port);
let connect = format!("-connect={}", other_node_url);
let mut args = vec![p2p_arg, connect];
if listen {
args.push("-listen=1".to_string())
}
(args, Some(p2p_socket))
}
};
let stdout = if conf.view_stdout {
Stdio::inherit()
} else {
Stdio::null()
};
let datadir_arg = format!("-datadir={}", datadir.display());
let rpc_arg = format!("-rpcport={}", rpc_port);
let default_args = [&datadir_arg, &rpc_arg];
debug!(
"launching {:?} with args: {:?} {:?} AND custom args",
exe.as_ref(),
default_args,
p2p_args
);
let process = Command::new(exe)
.args(&default_args)
.args(&p2p_args)
.args(&conf.args)
.stdout(stdout)
.spawn()?;
let node_url_default = format!("{}/wallet/default", rpc_url);
let client = loop {
thread::sleep(Duration::from_millis(500));
assert!(process.stderr.is_none());
let client_result = Client::new(&rpc_url, Auth::CookieFile(cookie_file.clone()));
if let Ok(client_base) = client_result {
if client_base.call::<Value>("getblockchaininfo", &[]).is_ok() {
client_base
.create_wallet("default", None, None, None, None)
.unwrap();
break Client::new(&node_url_default, Auth::CookieFile(cookie_file.clone()))
.unwrap();
}
}
};
Ok(BitcoinD {
process,
client,
_work_dir,
params: ConnectParams {
datadir,
cookie_file,
rpc_socket,
p2p_socket,
},
})
}
pub fn rpc_url(&self) -> String {
format!("http://{}", self.params.rpc_socket)
}
#[cfg(not(any(feature = "0_17_1", feature = "0_18_0", feature = "0_18_1")))]
pub fn rpc_url_with_wallet<T: AsRef<str>>(&self, wallet_name: T) -> String {
format!(
"http://{}/wallet/{}",
self.params.rpc_socket,
wallet_name.as_ref()
)
}
pub fn p2p_connect(&self, listen: bool) -> Option<P2P> {
self.params.p2p_socket.map(|s| P2P::Connect(s, listen))
}
pub fn stop(&mut self) -> Result<ExitStatus, Error> {
self.client.stop()?;
Ok(self.process.wait()?)
}
#[cfg(not(any(feature = "0_17_1", feature = "0_18_0", feature = "0_18_1")))]
pub fn create_wallet<T: AsRef<str>>(&self, wallet: T) -> Result<Client, Error> {
let _ = self
.client
.create_wallet(wallet.as_ref(), None, None, None, None)?;
Ok(Client::new(
&self.rpc_url_with_wallet(wallet),
Auth::CookieFile(self.params.cookie_file.clone()),
)?)
}
}
impl Drop for BitcoinD {
fn drop(&mut self) {
let _ = self.process.kill();
}
}
pub fn get_available_port() -> Result<u16, Error> {
let t = TcpListener::bind(("127.0.0.1", 0))?;
Ok(t.local_addr().map(|s| s.port())?)
}
impl From<std::io::Error> for Error {
fn from(e: std::io::Error) -> Self {
Error::Io(e)
}
}
impl From<bitcoincore_rpc::Error> for Error {
fn from(e: bitcoincore_rpc::Error) -> Self {
Error::Rpc(e)
}
}
pub fn downloaded_exe_path() -> Option<String> {
if versions::HAS_FEATURE {
Some(format!(
"{}/bitcoin/bitcoin-{}/bin/bitcoind",
env!("OUT_DIR"),
versions::VERSION
))
} else {
None
}
}
#[cfg(test)]
mod test {
use crate::downloaded_exe_path;
use crate::{get_available_port, BitcoinD, Conf, LOCAL_IP, P2P};
use bitcoincore_rpc::RpcApi;
use std::env;
use std::net::SocketAddrV4;
#[test]
fn test_local_ip() {
assert_eq!("127.0.0.1", format!("{}", LOCAL_IP));
let port = get_available_port().unwrap();
let socket = SocketAddrV4::new(LOCAL_IP, port);
assert_eq!(format!("127.0.0.1:{}", port), format!("{}", socket));
}
#[test]
fn test_default() {
let conf = Conf {
p2p: P2P::Yes,
..Default::default()
};
assert_eq!("regtest", conf.network);
}
#[test]
fn test_bitcoind() {
let exe = init();
println!("{}", exe);
let bitcoind = BitcoinD::new(exe).unwrap();
let info = bitcoind.client.get_blockchain_info().unwrap();
assert_eq!(0, info.blocks);
let address = bitcoind.client.get_new_address(None, None).unwrap();
let _ = bitcoind.client.generate_to_address(1, &address).unwrap();
let info = bitcoind.client.get_blockchain_info().unwrap();
assert_eq!(1, info.blocks);
}
#[test]
#[cfg(any(feature = "0_21_0", feature = "0_21_1"))]
fn test_getindexinfo() {
let exe = init();
let mut conf = Conf::default();
conf.args.push("-txindex");
let bitcoind = BitcoinD::with_conf(&exe, &conf).unwrap();
assert!(
bitcoind.client.version().unwrap() >= 210_000,
"getindexinfo requires bitcoin >0.21"
);
let info: std::collections::HashMap<String, bitcoincore_rpc::jsonrpc::serde_json::Value> =
bitcoind.client.call("getindexinfo", &[]).unwrap();
assert!(info.contains_key("txindex"));
assert!(bitcoind.client.version().unwrap() >= 210_000);
}
#[test]
fn test_p2p() {
let exe = init();
let conf = Conf {
p2p: P2P::Yes,
..Default::default()
};
let bitcoind = BitcoinD::with_conf(&exe, &conf).unwrap();
assert_eq!(bitcoind.client.get_peer_info().unwrap().len(), 0);
let other_conf = Conf {
p2p: bitcoind.p2p_connect(false).unwrap(),
..Default::default()
};
let other_bitcoind = BitcoinD::with_conf(&exe, &other_conf).unwrap();
assert_eq!(bitcoind.client.get_peer_info().unwrap().len(), 1);
assert_eq!(other_bitcoind.client.get_peer_info().unwrap().len(), 1);
}
#[test]
fn test_multi_p2p() {
let conf_node1 = Conf {
p2p: P2P::Yes,
..Default::default()
};
let node1 = BitcoinD::with_conf(exe_path(), &conf_node1).unwrap();
let conf_node2 = Conf {
p2p: node1.p2p_connect(true).unwrap(),
..Default::default()
};
let node2 = BitcoinD::with_conf(exe_path(), &conf_node2).unwrap();
let conf_node3 = Conf {
p2p: node2.p2p_connect(false).unwrap(),
..Default::default()
};
let node3 = BitcoinD::with_conf(exe_path(), &conf_node3).unwrap();
let node1_peers = node1.client.get_peer_info().unwrap();
let node2_peers = node2.client.get_peer_info().unwrap();
let node3_peers = node3.client.get_peer_info().unwrap();
assert!(node1_peers.len() >= 1);
assert!(node2_peers.len() >= 1);
assert_eq!(node3_peers.len(), 1, "listen false but more than 1 peer");
}
#[cfg(not(any(feature = "0_17_1", feature = "0_18_0", feature = "0_18_1")))]
#[test]
fn test_multi_wallet() {
use bitcoincore_rpc::bitcoin::Amount;
let exe = init();
let bitcoind = BitcoinD::new(exe).unwrap();
let alice = bitcoind.create_wallet("alice").unwrap();
let alice_address = alice.get_new_address(None, None).unwrap();
let bob = bitcoind.create_wallet("bob").unwrap();
let bob_address = bob.get_new_address(None, None).unwrap();
bitcoind
.client
.generate_to_address(1, &alice_address)
.unwrap();
bitcoind
.client
.generate_to_address(101, &bob_address)
.unwrap();
assert_eq!(
Amount::from_btc(50.0).unwrap(),
alice.get_balances().unwrap().mine.trusted
);
assert_eq!(
Amount::from_btc(50.0).unwrap(),
bob.get_balances().unwrap().mine.trusted
);
assert_eq!(
Amount::from_btc(5000.0).unwrap(),
bob.get_balances().unwrap().mine.immature
);
alice
.send_to_address(
&bob_address,
Amount::from_btc(1.0).unwrap(),
None,
None,
None,
None,
None,
None,
)
.unwrap();
assert!(
alice.get_balances().unwrap().mine.trusted < Amount::from_btc(49.0).unwrap()
&& alice.get_balances().unwrap().mine.trusted > Amount::from_btc(48.9).unwrap()
);
assert_eq!(
Amount::from_btc(1.0).unwrap(),
bob.get_balances().unwrap().mine.untrusted_pending
);
assert!(
bitcoind.create_wallet("bob").is_err(),
"wallet already exist"
);
}
fn exe_path() -> String {
if let Some(downloaded_exe_path) = downloaded_exe_path() {
downloaded_exe_path
} else {
env::var("BITCOIND_EXE").expect(
"when no version feature is specified, you must specify BITCOIND_EXE env var",
)
}
}
fn init() -> String {
let _ = env_logger::try_init();
exe_path()
}
}