Merge pull request #132 from shesek/202008-utxo-info

Implement RpcApi::get_tx_out_set_info()

Author: stevenroose

client/src/client.rs

@@ -991,6 +991,12 @@ pub trait RpcApi: Sized {
         Ok((res.start_height, res.stop_height))
     }
 
+    /// Returns statistics about the unspent transaction output set.
+    /// This call may take some time.
+    fn get_tx_out_set_info(&self) -> Result<json::GetTxOutSetInfoResult> {
+        self.call("gettxoutsetinfo", &[])
+    }
+
     /// Returns information about network traffic, including bytes in, bytes out,
     /// and current time.
     fn get_net_totals(&self) -> Result<json::GetNetTotalsResult> {

integration_test/src/main.rs

@@ -147,6 +147,7 @@ fn main() {
     test_get_peer_info(&cl);
     test_rescan_blockchain(&cl);
     test_create_wallet(&cl);
+    test_get_tx_out_set_info(&cl);
     test_get_net_totals(&cl);
     test_get_network_hash_ps(&cl);
     test_uptime(&cl);
@@ -900,6 +901,10 @@ fn test_create_wallet(cl: &Client) {
     assert!(wallet_list.iter().zip(wallet_names).all(|(a, b)| a == b));
 }
 
+fn test_get_tx_out_set_info(cl: &Client) {
+    cl.get_tx_out_set_info().unwrap();
+}
+
 fn test_get_net_totals(cl: &Client) {
     cl.get_net_totals().unwrap();
 }

json/src/lib.rs

@@ -26,6 +26,7 @@ use std::collections::HashMap;
 
 use bitcoin::consensus::encode;
 use bitcoin::hashes::hex::{FromHex, ToHex};
+use bitcoin::hashes::sha256;
 use bitcoin::util::{bip158, bip32};
 use bitcoin::{Address, Amount, PrivateKey, PublicKey, Script, SignedAmount, Transaction};
 use serde::de::Error as SerdeError;
@@ -1180,6 +1181,29 @@ pub struct SignRawTransactionInput {
     pub amount: Option<Amount>,
 }
 
+#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
+pub struct GetTxOutSetInfoResult {
+    /// The current block height (index)
+    pub height: u64,
+    /// The hash of the block at the tip of the chain
+    #[serde(rename = "bestblock")]
+    pub best_block: bitcoin::BlockHash,
+    /// The number of transactions with unspent outputs
+    pub transactions: u64,
+    /// The number of unspent transaction outputs
+    #[serde(rename = "txouts")]
+    pub tx_outs: u64,
+    /// A meaningless metric for UTXO set size
+    pub bogosize: u64,
+    /// The serialized hash
+    pub hash_serialized_2: sha256::Hash,
+    /// The estimated size of the chainstate on disk
+    pub disk_size: u64,
+    /// The total amount
+    #[serde(with = "bitcoin::util::amount::serde::as_btc")]
+    pub total_amount: Amount,
+}
+
 #[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
 pub struct GetNetTotalsResult {
     /// Total bytes received