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
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
use std::result;
use jsonrpc;
use serde_json;
use bitcoin::util::hash::Sha256dHash;
use bitcoin::{Address, Block, BlockHeader, Transaction};
use bitcoin_amount::Amount;
use log::Level::Trace;
use num_bigint::BigUint;
use secp256k1::Signature;
use std::collections::HashMap;
use error::*;
use json;
use queryable;
pub type Result<T> = result::Result<T, Error>;
fn into_json<T>(val: T) -> Result<serde_json::Value>
where
T: serde::ser::Serialize,
{
Ok(serde_json::to_value(val)?)
}
fn opt_into_json<T>(opt: Option<T>) -> Result<serde_json::Value>
where
T: serde::ser::Serialize,
{
match opt {
Some(val) => Ok(into_json(val)?),
None => Ok(serde_json::Value::Null),
}
}
#[allow(unused)]
fn null() -> serde_json::Value {
serde_json::Value::Null
}
fn handle_defaults<'a, 'b>(
args: &'a mut [serde_json::Value],
defaults: &'b [serde_json::Value],
) -> &'a [serde_json::Value] {
assert!(args.len() >= defaults.len());
let mut first_non_null_optional_idx = None;
for i in 0..defaults.len() {
let args_i = args.len() - 1 - i;
let defaults_i = defaults.len() - 1 - i;
if args[args_i] == serde_json::Value::Null {
if first_non_null_optional_idx.is_some() {
if defaults[defaults_i] == serde_json::Value::Null {
panic!("Missing `default` for argument idx {}", args_i);
}
args[args_i] = defaults[defaults_i].clone();
}
} else if first_non_null_optional_idx.is_none() {
first_non_null_optional_idx = Some(args_i);
}
}
let required_num = args.len() - defaults.len();
if let Some(i) = first_non_null_optional_idx {
&args[..=i]
} else {
&args[..required_num]
}
}
pub struct Client {
client: jsonrpc::client::Client,
}
impl Client {
pub fn new(url: String, user: Option<String>, pass: Option<String>) -> Self {
debug_assert!(pass.is_none() || user.is_some());
Client {
client: jsonrpc::client::Client::new(url, user, pass),
}
}
pub fn from_jsonrpc(client: jsonrpc::client::Client) -> Client {
Client {
client: client,
}
}
pub fn get_by_id<T: queryable::Queryable>(
&mut self,
id: &<T as queryable::Queryable>::Id,
) -> Result<T> {
T::query(self, &id)
}
pub fn call<T: for<'a> serde::de::Deserialize<'a>>(
&mut self,
cmd: &str,
args: &[serde_json::Value],
) -> Result<T> {
let req = self.client.build_request(cmd.to_owned(), args.to_owned());
if log_enabled!(Trace) {
trace!("JSON-RPC request: {}", serde_json::to_string(&req).unwrap());
}
let resp = self.client.send_request(&req).map_err(Error::from);
if log_enabled!(Trace) && resp.is_ok() {
let resp = resp.as_ref().unwrap();
trace!("JSON-RPC response: {}", serde_json::to_string(resp).unwrap());
}
Ok(resp?.into_result()?)
}
pub fn add_multisig_address(
&mut self,
nrequired: usize,
keys: Vec<json::PubKeyOrAddress>,
label: Option<&str>,
address_type: Option<json::AddressType>,
) -> Result<json::AddMultiSigAddressResult> {
let mut args = [
into_json(nrequired)?,
into_json(keys)?,
opt_into_json(label)?,
opt_into_json(address_type)?,
];
self.call("addmultisigaddress", handle_defaults(&mut args, &[into_json("")?, null()]))
}
pub fn backup_wallet(&mut self, destination: Option<&str>) -> Result<()> {
let mut args = [opt_into_json(destination)?];
self.call("backupwallet", handle_defaults(&mut args, &[null()]))
}
pub fn dump_priv_key(&mut self, address: &Address) -> Result<String> {
self.call("dumpprivkey", &[into_json(address)?])
}
pub fn encrypt_wallet(&mut self, passphrase: &str) -> Result<()> {
self.call("encryptwallet", &[into_json(passphrase)?])
}
pub fn get_difficulty(&mut self) -> Result<BigUint> {
self.call("getdifficulty", &[])
}
pub fn get_connection_count(&mut self) -> Result<usize> {
self.call("getconnectioncount", &[])
}
pub fn get_block(&mut self, hash: &Sha256dHash) -> Result<Block> {
let hex: String = self.call("getblock", &[into_json(hash)?, 0.into()])?;
let bytes = hex::decode(hex)?;
Ok(bitcoin::consensus::encode::deserialize(&bytes)?)
}
pub fn get_block_hex(&mut self, hash: &Sha256dHash) -> Result<String> {
self.call("getblock", &[into_json(hash)?, 0.into()])
}
pub fn get_block_info(&mut self, hash: &Sha256dHash) -> Result<json::GetBlockResult> {
self.call("getblock", &[into_json(hash)?, 1.into()])
}
pub fn get_block_header_raw(&mut self, hash: &Sha256dHash) -> Result<BlockHeader> {
let hex: String = self.call("getblockheader", &[into_json(hash)?, false.into()])?;
let bytes = hex::decode(hex)?;
Ok(bitcoin::consensus::encode::deserialize(&bytes)?)
}
pub fn get_block_header_verbose(
&mut self,
hash: &Sha256dHash,
) -> Result<json::GetBlockHeaderResult> {
self.call("getblockheader", &[into_json(hash)?, true.into()])
}
pub fn get_mining_info(&mut self) -> Result<json::GetMiningInfoResult> {
self.call("getmininginfo", &[])
}
pub fn get_blockchain_info(&mut self) -> Result<json::GetBlockchainInfoResult> {
self.call("getblockchaininfo", &[])
}
pub fn get_block_count(&mut self) -> Result<u64> {
self.call("getblockcount", &[])
}
pub fn get_best_block_hash(&mut self) -> Result<Sha256dHash> {
self.call("getbestblockhash", &[])
}
pub fn get_block_hash(&mut self, height: u64) -> Result<Sha256dHash> {
self.call("getblockhash", &[height.into()])
}
pub fn get_raw_transaction(
&mut self,
txid: &Sha256dHash,
block_hash: Option<&Sha256dHash>,
) -> Result<Transaction> {
let mut args = [into_json(txid)?, into_json(false)?, opt_into_json(block_hash)?];
let hex: String = self.call("getrawtransaction", handle_defaults(&mut args, &[null()]))?;
let bytes = hex::decode(hex)?;
Ok(bitcoin::consensus::encode::deserialize(&bytes)?)
}
pub fn get_raw_transaction_hex(
&mut self,
txid: &Sha256dHash,
block_hash: Option<&Sha256dHash>,
) -> Result<String> {
let mut args = [into_json(txid)?, into_json(false)?, opt_into_json(block_hash)?];
self.call("getrawtransaction", handle_defaults(&mut args, &[null()]))
}
pub fn get_raw_transaction_verbose(
&mut self,
txid: &Sha256dHash,
block_hash: Option<&Sha256dHash>,
) -> Result<json::GetRawTransactionResult> {
let mut args = [into_json(txid)?, into_json(true)?, opt_into_json(block_hash)?];
self.call("getrawtransaction", handle_defaults(&mut args, &[null()]))
}
pub fn get_received_by_address(
&mut self,
address: &Address,
minconf: Option<u32>,
) -> Result<Amount> {
let mut args = [into_json(address)?, opt_into_json(minconf)?];
self.call("getreceivedbyaddress", handle_defaults(&mut args, &[null()]))
}
pub fn get_transaction(
&mut self,
txid: &Sha256dHash,
include_watchonly: Option<bool>,
) -> Result<json::GetTransactionResult> {
let mut args = [into_json(txid)?, opt_into_json(include_watchonly)?];
self.call("getrawtransaction", handle_defaults(&mut args, &[null()]))
}
pub fn get_tx_out(
&mut self,
txid: &Sha256dHash,
vout: u32,
include_mempool: Option<bool>,
) -> Result<Option<json::GetTxOutResult>> {
let mut args = [into_json(txid)?, into_json(vout)?, opt_into_json(include_mempool)?];
self.call("gettxout", handle_defaults(&mut args, &[null()]))
}
pub fn import_priv_key(
&mut self,
privkey: &str,
label: Option<&str>,
rescan: Option<bool>,
) -> Result<()> {
let mut args = [into_json(privkey)?, into_json(label)?, opt_into_json(rescan)?];
self.call("importprivkey", handle_defaults(&mut args, &[into_json("")?, null()]))
}
pub fn key_pool_refill(&mut self, new_size: Option<usize>) -> Result<()> {
let mut args = [opt_into_json(new_size)?];
self.call("keypoolrefill", handle_defaults(&mut args, &[null()]))
}
pub fn list_unspent(
&mut self,
minconf: Option<usize>,
maxconf: Option<usize>,
addresses: Option<Vec<&Address>>,
include_unsafe: Option<bool>,
query_options: Option<HashMap<&str, &str>>,
) -> Result<Vec<json::ListUnspentResult>> {
let mut args = [
opt_into_json(minconf)?,
opt_into_json(maxconf)?,
opt_into_json(addresses)?,
opt_into_json(include_unsafe)?,
opt_into_json(query_options)?,
];
let defaults = [
into_json(0)?,
into_json(9999999)?,
into_json::<&[Address]>(&[])?,
into_json(true)?,
null(),
];
self.call("listunspent", handle_defaults(&mut args, &defaults))
}
pub fn sign_raw_transaction(
&mut self,
tx: json::HexBytes,
utxos: Option<&[json::UTXO]>,
private_keys: Option<&[&str]>,
sighash_type: Option<json::SigHashType>,
) -> Result<json::SignRawTransactionResult> {
let mut args = [
into_json(tx)?,
opt_into_json(utxos)?,
opt_into_json(private_keys)?,
opt_into_json(sighash_type)?,
];
let defaults = [into_json::<&[json::UTXO]>(&[])?, into_json::<&[&str]>(&[])?, null()];
self.call("signrawtransaction", handle_defaults(&mut args, &defaults))
}
pub fn stop(&mut self) -> Result<()> {
self.call("stop", &[])
}
pub fn sign_raw_transaction_with_wallet(
&mut self,
tx: json::HexBytes,
utxos: Option<&[json::UTXO]>,
sighash_type: Option<json::SigHashType>,
) -> Result<json::SignRawTransactionResult> {
let mut args = [into_json(tx)?, opt_into_json(utxos)?, opt_into_json(sighash_type)?];
let defaults = [into_json::<&[json::UTXO]>(&[])?, null()];
self.call("signrawtransactionwithwallet", handle_defaults(&mut args, &defaults))
}
pub fn verify_message(
&mut self,
address: &Address,
signature: &Signature,
message: &str,
) -> Result<bool> {
let args = [into_json(address)?, into_json(signature)?, into_json(message)?];
self.call("verifymessage", &args)
}
pub fn get_new_address(&mut self, account: &str) -> Result<String> {
self.call("getnewaddress", &[into_json(account)?])
}
pub fn generate_to_address(
&mut self,
block_num: u64,
address: &str,
) -> Result<Vec<Sha256dHash>> {
self.call("generatetoaddress", &[block_num.into(), address.into()])
}
pub fn invalidate_block(&mut self, block_hash: &Sha256dHash) -> Result<()> {
self.call("invalidateblock", &[into_json(block_hash)?])
}
pub fn get_peer_info(&mut self) -> Result<Vec<json::GetPeerInfoResult>> {
self.call("getpeerinfo", &[])
}
pub fn ping(&mut self) -> Result<()> {
self.call("ping", &[])
}
pub fn send_raw_transaction(&mut self, tx: &str) -> Result<String> {
self.call("sendrawtransaction", &[into_json(tx)?])
}
pub fn estimate_smartfee<E>(
&mut self,
conf_target: u16,
estimate_mode: Option<json::EstimateMode>,
) -> Result<json::EstimateSmartFeeResult> {
let mut args = [into_json(conf_target)?, opt_into_json(estimate_mode)?];
self.call("estimatesmartfee", handle_defaults(&mut args, &[null()]))
}
pub fn wait_for_new_block(&mut self, timeout: u64) -> Result<json::BlockRef> {
self.call("waitfornewblock", &[into_json(timeout)?])
}
pub fn wait_for_block(
&mut self,
blockhash: &Sha256dHash,
timeout: u64,
) -> Result<json::BlockRef> {
let args = [into_json(blockhash)?, into_json(timeout)?];
self.call("waitforblock", &args)
}
}
#[cfg(tests)]
mod tests {
use super::*;
#[test]
fn test_handle_defaults() -> Result<()> {
{
let mut args = [into_json(0)?, null(), null()];
let defaults = [into_json(1)?, into_json(2)?];
let res = [into_json(0)?];
assert_eq!(handle_defaults(&mut args, &defaults), &res);
}
{
let mut args = [into_json(0)?, into_json(1)?, null()];
let defaults = [into_json(2)?];
let res = [into_json(0)?, into_json(1)?];
assert_eq!(handle_defaults(&mut args, &defaults), &res);
}
{
let mut args = [into_json(0)?, null(), into_json(5)?];
let defaults = [into_json(2)?, into_json(3)?];
let res = [into_json(0)?, into_json(2)?, into_json(5)?];
assert_eq!(handle_defaults(&mut args, &defaults), &res);
}
{
let mut args = [into_json(0)?, null(), into_json(5)?, null()];
let defaults = [into_json(2)?, into_json(3)?, into_json(4)?];
let res = [into_json(0)?, into_json(2)?, into_json(5)?];
assert_eq!(handle_defaults(&mut args, &defaults), &res);
}
{
let mut args = [null(), null()];
let defaults = [into_json(2)?, into_json(3)?];
let res: [serde_json::Value; 0] = [];
assert_eq!(handle_defaults(&mut args, &defaults), &res);
}
{
let mut args = [null(), into_json(1)?];
let defaults = [];
let res = [null(), into_json(1)?];
assert_eq!(handle_defaults(&mut args, &defaults), &res);
}
{
let mut args = [];
let defaults = [];
let res: [serde_json::Value; 0] = [];
assert_eq!(handle_defaults(&mut args, &defaults), &res);
}
{
let mut args = [into_json(0)?];
let defaults = [into_json(2)?];
let res = [into_json(0)?];
assert_eq!(handle_defaults(&mut args, &defaults), &res);
}
Ok(())
}
}