Add per-field querying for getblockstats

Author: Gabriel Comte

client/src/client.rs

@@ -443,6 +443,14 @@ pub trait RpcApi: Sized {
         self.call("getblockstats", &[height.into()])
     }
 
+    fn get_block_stats_fields(&self, height: u64, fields: &Vec<bitcoincore_rpc_json::BlockStatsFields>) -> Result<json::GetBlockStatsResultPartial> {
+        let fields: Vec<&str> = fields.iter()
+            .map(|field| field.get_rpc_keyword())
+            .collect();
+
+        self.call("getblockstats", &[height.into(), fields.into()])
+    }
+
     fn get_raw_transaction(
         &self,
         txid: &bitcoin::Txid,

integration_test/src/main.rs

@@ -133,6 +133,7 @@ fn main() {
     test_get_block(&cl);
     test_get_block_header_get_block_header_info(&cl);
     test_get_block_stats(&cl);
+    test_get_block_stats_partial(&cl);
     test_get_address_info(&cl);
     test_set_label(&cl);
     test_send_to_address(&cl);
@@ -299,6 +300,20 @@ fn test_get_block_stats(cl: &Client) {
     assert_eq!(tip, stats.height);
 }
 
+fn test_get_block_stats_partial(cl: &Client) {
+    use bitcoincore_rpc::bitcoincore_rpc_json::BlockStatsFields;
+    let fields = vec![BlockStatsFields::BlockHash, BlockStatsFields::Height, BlockStatsFields::TotalFee];
+
+    let tip = cl.get_block_count().unwrap();
+    let tip_hash = cl.get_best_block_hash().unwrap();
+    let header = cl.get_block_header(&tip_hash).unwrap();
+    let stats = cl.get_block_stats_fields(tip, &fields).unwrap();
+    assert_eq!(header.block_hash(), stats.block_hash.unwrap());
+    assert_eq!(tip, stats.height.unwrap());
+    assert!(stats.total_fee.is_some());
+    assert!(stats.avg_fee.is_none());
+}
+
 fn test_get_address_info(cl: &Client) {
     let addr = cl.get_new_address(None, Some(json::AddressType::Legacy)).unwrap();
     let info = cl.get_address_info(&addr).unwrap();

json/src/lib.rs

@@ -270,6 +270,57 @@ pub struct GetBlockStatsResult {
     pub utxo_size_inc: i32,
 }
 
+#[derive(Clone, PartialEq, Debug, Deserialize, Serialize)]
+pub struct GetBlockStatsResultPartial {
+    #[serde(rename = "avgfee")]
+    pub avg_fee: Option<u32>,
+    #[serde(rename = "avgfeerate")]
+    pub avg_fee_rate: Option<u32>,
+    #[serde(rename = "avgtxsize")]
+    pub avg_tx_size: Option<u32>,
+    #[serde(rename = "blockhash")]
+    pub block_hash: Option<bitcoin::BlockHash>,
+    #[serde(rename = "feerate_percentiles")]
+    pub fee_rate_percentiles: Option<FeeRatePercentiles>,
+    pub height: Option<u64>,
+    pub ins: Option<usize>,
+    #[serde(rename = "maxfee")]
+    pub max_fee: Option<u64>,
+    #[serde(rename = "maxfeerate")]
+    pub max_fee_rate: Option<u32>,
+    #[serde(rename = "maxtxsize")]
+    pub max_tx_size: Option<u32>,
+    #[serde(rename = "medianfee")]
+    pub median_fee: Option<u32>,
+    #[serde(rename = "mediantime")]
+    pub median_time: Option<u32>,
+    #[serde(rename = "mediantxsize")]
+    pub median_tx_size: Option<u32>,
+    #[serde(rename = "minfee")]
+    pub min_fee: Option<u32>,
+    #[serde(rename = "minfeerate")]
+    pub min_fee_rate: Option<u32>,
+    #[serde(rename = "mintxsize")]
+    pub min_tx_size: Option<u32>,
+    pub outs: Option<usize>,
+    pub subsidy: Option<u32>,
+    #[serde(rename = "swtotal_size")]
+    pub sw_total_size: Option<usize>,
+    #[serde(rename = "swtotal_weight")]
+    pub sw_total_weight: Option<usize>,
+    #[serde(rename = "swtxs")]
+    pub sw_txs: Option<usize>,
+    pub time: Option<u32>,
+    pub total_out: Option<usize>,
+    pub total_size: Option<usize>,
+    pub total_weight: Option<usize>,
+    #[serde(rename = "totalfee")]
+    pub total_fee: Option<u64>,
+    pub txs: Option<usize>,
+    pub utxo_increase: Option<i32>,
+    pub utxo_size_inc: Option<i32>,
+}
+
 #[derive(Clone, PartialEq, Debug, Deserialize, Serialize)]
 pub struct FeeRatePercentiles {
     pub fr_10th: u32,
@@ -279,6 +330,74 @@ pub struct FeeRatePercentiles {
     pub fr_90th: u32,
 }
 
+pub enum BlockStatsFields {
+    AverageFee,
+    AverageFeeRate,
+    AverageTxSize,
+    BlockHash,
+    FeeRatePercentiles,
+    Height,
+    Ins,
+    MaxFee,
+    MaxFeeRate,
+    MaxTxSize,
+    MedianFee,
+    MedianTime,
+    MedianTxSize,
+    MinFee,
+    MinFeeRate,
+    MinTxSize,
+    Outs,
+    Subsidy,
+    SegWitTotalSize,
+    SegWitTotalWeight,
+    SegWitTxs,
+    Time,
+    TotalOut,
+    TotalSize,
+    TotalWeight,
+    TotalFee,
+    Txs,
+    UtxoIncrease,
+    UtxoSizeIncrease,
+}
+
+impl BlockStatsFields {
+    pub fn get_rpc_keyword(&self) -> &str {
+        match *self {
+            BlockStatsFields::AverageFee => "avgfee",
+            BlockStatsFields::AverageFeeRate => "avgfeerate",
+            BlockStatsFields::AverageTxSize => "avgtxsize",
+            BlockStatsFields::BlockHash => "blockhash",
+            BlockStatsFields::FeeRatePercentiles => "feerate_percentiles",
+            BlockStatsFields::Height => "height",
+            BlockStatsFields::Ins => "ins",
+            BlockStatsFields::MaxFee => "maxfee",
+            BlockStatsFields::MaxFeeRate => "maxfeerate",
+            BlockStatsFields::MaxTxSize => "maxtxsize",
+            BlockStatsFields::MedianFee => "medianfee",
+            BlockStatsFields::MedianTime => "mediantime",
+            BlockStatsFields::MedianTxSize => "mediantxsize",
+            BlockStatsFields::MinFee => "minfee",
+            BlockStatsFields::MinFeeRate => "minfeerate",
+            BlockStatsFields::MinTxSize => "minfeerate",
+            BlockStatsFields::Outs => "outs",
+            BlockStatsFields::Subsidy => "subsidy",
+            BlockStatsFields::SegWitTotalSize => "swtotal_size",
+            BlockStatsFields::SegWitTotalWeight => "swtotal_weight",
+            BlockStatsFields::SegWitTxs => "swtxs",
+            BlockStatsFields::Time => "time",
+            BlockStatsFields::TotalOut => "total_out",
+            BlockStatsFields::TotalSize => "total_size",
+            BlockStatsFields::TotalWeight => "total_weight",
+            BlockStatsFields::TotalFee => "totalfee",
+            BlockStatsFields::Txs => "txs",
+            BlockStatsFields::UtxoIncrease => "utxo_increase",
+            BlockStatsFields::UtxoSizeIncrease => "utxo_size_inc",
+        }
+    }
+}
+
 #[derive(Clone, PartialEq, Debug, Deserialize, Serialize)]
 #[serde(rename_all = "camelCase")]
 pub struct GetMiningInfoResult {