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
#![warn(missing_docs)]
use bitcoincore_rpc::{Auth, Client, RpcApi};
use std::ffi::OsStr;
use std::net::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 bitcoincore_rpc;
pub extern crate tempfile;
pub struct BitcoinD {
process: Child,
pub client: Client,
_work_dir: TempDir,
pub cookie_file: PathBuf,
pub rpc_url: String,
pub p2p_url: Option<String>,
}
pub enum P2P {
No,
Yes,
Connect(String),
}
#[derive(Debug)]
pub enum Error {
Io(std::io::Error),
Rpc(bitcoincore_rpc::Error),
}
impl BitcoinD {
pub fn new<S: AsRef<OsStr>>(exe: S) -> Result<BitcoinD, Error> {
BitcoinD::with_args(exe, vec![], false, P2P::No)
}
pub fn with_args<S, I>(exe: S, args: I, view_stdout: bool, p2p: P2P) -> Result<BitcoinD, Error>
where
I: IntoIterator<Item = S>,
S: AsRef<OsStr>,
{
let _work_dir = TempDir::new()?;
let datadir_path = _work_dir.path().to_path_buf();
let cookie_file = datadir_path.join("regtest").join(".cookie");
let rpc_port = get_available_port()?;
let url = format!("http://127.0.0.1:{}", rpc_port);
let (p2p_args, p2p_url) = match p2p {
P2P::No => (vec!["-listen=0".to_string()], None),
P2P::Yes => {
let p2p_port = get_available_port()?;
let p2p_url = format!("127.0.0.1:{}", p2p_port);
let p2p_arg = format!("-port={}", p2p_port);
let args = vec![p2p_arg];
(args, Some(p2p_url))
}
P2P::Connect(other_node_url) => {
let p2p_port = get_available_port()?;
let p2p_url = format!("127.0.0.1:{}", p2p_port);
let p2p_arg = format!("-port={}", p2p_port);
let connect = format!("-connect={}", other_node_url);
let args = vec![p2p_arg, connect];
(args, Some(p2p_url))
}
};
let stdout = if view_stdout {
Stdio::inherit()
} else {
Stdio::null()
};
let process = Command::new(exe)
.arg(format!("-datadir={}", datadir_path.display()))
.arg(format!("-rpcport={}", rpc_port))
.arg("-regtest")
.arg("-fallbackfee=0.0001")
.args(p2p_args)
.args(args)
.stdout(stdout)
.spawn()?;
let node_url_default = format!("{}/wallet/default", url);
let client = loop {
thread::sleep(Duration::from_millis(500));
assert!(process.stderr.is_none());
let client_result = Client::new(url.clone(), Auth::CookieFile(cookie_file.clone()));
if let Ok(client_base) = client_result {
if client_base.get_blockchain_info().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,
cookie_file,
rpc_url: url,
p2p_url,
})
}
pub fn stop(&mut self) -> Result<ExitStatus, Error> {
self.client.stop()?;
Ok(self.process.wait()?)
}
}
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)
}
}
#[cfg(test)]
mod test {
use crate::{BitcoinD, P2P};
use bitcoincore_rpc::jsonrpc::serde_json::Value;
use bitcoincore_rpc::RpcApi;
use std::collections::HashMap;
use std::env;
#[test]
fn test_bitcoind() {
let exe = env::var("BITCOIND_EXE").expect("BITCOIND_EXE env var must be set");
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]
fn test_getindexinfo() {
let exe = env::var("BITCOIND_EXE").expect("BITCOIND_EXE env var must be set");
let bitcoind =
BitcoinD::with_args(exe, vec!["-txindex".to_string()], false, P2P::No).unwrap();
assert!(
bitcoind.client.version().unwrap() >= 210_000,
"getindexinfo requires bitcoin >0.21"
);
let info: HashMap<String, Value> = bitcoind.client.call("getindexinfo", &[]).unwrap();
assert!(info.contains_key("txindex"));
assert_eq!(bitcoind.client.version().unwrap(), 210_000);
}
#[test]
fn test_p2p() {
let exe = env::var("BITCOIND_EXE").expect("BITCOIND_EXE env var must be set");
let bitcoind = BitcoinD::with_args(exe.clone(), vec![], false, P2P::Yes).unwrap();
assert_eq!(bitcoind.client.get_peer_info().unwrap().len(), 0);
let other_bitcoind = BitcoinD::with_args(
exe,
vec![],
false,
P2P::Connect(bitcoind.p2p_url.clone().unwrap()),
)
.unwrap();
assert_eq!(bitcoind.client.get_peer_info().unwrap().len(), 1);
assert_eq!(other_bitcoind.client.get_peer_info().unwrap().len(), 1);
}
}