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
/*
getblockstats hash_or_height ( stats )
Compute per block statistics for a given window. All amounts are in satoshis.
It won't work for some heights with pruning.
Arguments:
1. hash_or_height (string or numeric, required) The block hash or height of the target block
2. stats (json array, optional, default=all values) Values to plot (see result below)
[
"height", (string) Selected statistic
"time", (string) Selected statistic
...
]
Result:
{ (json object)
"avgfee" : n, (numeric) Average fee in the block
"avgfeerate" : n, (numeric) Average feerate (in satoshis per virtual byte)
"avgtxsize" : n, (numeric) Average transaction size
"blockhash" : "hex", (string) The block hash (to check for potential reorgs)
"feerate_percentiles" : [ (json array) Feerates at the 10th, 25th, 50th, 75th, and 90th percentile weight unit (in satoshis per virtual byte)
n, (numeric) The 10th percentile feerate
n, (numeric) The 25th percentile feerate
n, (numeric) The 50th percentile feerate
n, (numeric) The 75th percentile feerate
n (numeric) The 90th percentile feerate
],
"height" : n, (numeric) The height of the block
"ins" : n, (numeric) The number of inputs (excluding coinbase)
"maxfee" : n, (numeric) Maximum fee in the block
"maxfeerate" : n, (numeric) Maximum feerate (in satoshis per virtual byte)
"maxtxsize" : n, (numeric) Maximum transaction size
"medianfee" : n, (numeric) Truncated median fee in the block
"mediantime" : n, (numeric) The block median time past
"mediantxsize" : n, (numeric) Truncated median transaction size
"minfee" : n, (numeric) Minimum fee in the block
"minfeerate" : n, (numeric) Minimum feerate (in satoshis per virtual byte)
"mintxsize" : n, (numeric) Minimum transaction size
"outs" : n, (numeric) The number of outputs
"subsidy" : n, (numeric) The block subsidy
"swtotal_size" : n, (numeric) Total size of all segwit transactions
"swtotal_weight" : n, (numeric) Total weight of all segwit transactions
"swtxs" : n, (numeric) The number of segwit transactions
"time" : n, (numeric) The block time
"total_out" : n, (numeric) Total amount in all outputs (excluding coinbase and thus reward [ie subsidy + totalfee])
"total_size" : n, (numeric) Total size of all non-coinbase transactions
"total_weight" : n, (numeric) Total weight of all non-coinbase transactions
"totalfee" : n, (numeric) The fee total
"txs" : n, (numeric) The number of transactions (including coinbase)
"utxo_increase" : n, (numeric) The increase/decrease in the number of unspent outputs
"utxo_size_inc" : n (numeric) The increase/decrease in size for the utxo index (not discounting op_return and similar)
}
Examples:
> bitcoin-cli getblockstats '"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09"' '["minfeerate","avgfeerate"]'
> bitcoin-cli getblockstats 1000 '["minfeerate","avgfeerate"]'
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getblockstats", "params": ["00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09", ["minfeerate","avgfeerate"]]}' -H 'content-type: text/plain;' http://127.0.0.1:8332/
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getblockstats", "params": [1000, ["minfeerate","avgfeerate"]]}' -H 'content-type: text/plain;' http://127.0.0.1:8332/
*/
use serde::{Deserialize, Serialize};
use serde_json::value::to_raw_value;
use std::fmt;
use crate::{client::Client, command::CallableCommand, Blockhash};
use super::request::request;
type BlockHeight = u64;
pub enum TargetBlockArgument {
Hash(Blockhash),
Height(BlockHeight),
}
// TODO: Fill in all of these:
// https://bitcoincore.org/en/doc/0.21.0/rpc/blockchain/getblockstats/
#[derive(Serialize, Deserialize, Debug)]
pub enum StatsArgumentChoices {
AvgFee,
AvgTxSize,
Blockhash,
FeeRatePercentiles,
Height,
Ins,
MaxFee,
MaxFeeRate,
MaxTxSize,
MedianFee,
MedianTime,
MedianTxSize,
MinFee,
MinFeeRate,
MinTxSize,
Outs,
Subsidy,
SwTotalSize,
SwTotalWeight,
SwTxs,
Time,
TotalOut,
TotalSize,
TotalWeight,
TotalFee,
Txs,
UtxoIncrease,
UtxoSizeInc,
}
impl fmt::Display for StatsArgumentChoices {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match self {
StatsArgumentChoices::AvgFee => write!(f, "avgfee"),
StatsArgumentChoices::AvgTxSize => write!(f, "avgtxsize"),
StatsArgumentChoices::Blockhash => write!(f, "blockhash"),
StatsArgumentChoices::FeeRatePercentiles => write!(f, "feerate_percentiles"),
StatsArgumentChoices::Height => write!(f, "height"),
StatsArgumentChoices::Ins => write!(f, "ins"),
StatsArgumentChoices::MaxFee => write!(f, "maxfee"),
StatsArgumentChoices::MaxFeeRate => write!(f, "maxfeerate"),
StatsArgumentChoices::MaxTxSize => write!(f, "maxtxsize"),
StatsArgumentChoices::MedianFee => write!(f, "medianfee"),
StatsArgumentChoices::MedianTime => write!(f, "mediantime"),
StatsArgumentChoices::MedianTxSize => write!(f, "mediantxsize"),
StatsArgumentChoices::MinFee => write!(f, "minfee"),
StatsArgumentChoices::MinFeeRate => write!(f, "minfeerate"),
StatsArgumentChoices::MinTxSize => write!(f, "mintxsize"),
StatsArgumentChoices::Outs => write!(f, "outs"),
StatsArgumentChoices::Subsidy => write!(f, "subsidy"),
StatsArgumentChoices::SwTotalSize => write!(f, "swtotal_size"),
StatsArgumentChoices::SwTotalWeight => write!(f, "swtotal_weight"),
StatsArgumentChoices::SwTxs => write!(f, "swtxs"),
StatsArgumentChoices::Time => write!(f, "time"),
StatsArgumentChoices::TotalOut => write!(f, "total_out"),
StatsArgumentChoices::TotalSize => write!(f, "total_size"),
StatsArgumentChoices::TotalWeight => write!(f, "total_weight"),
StatsArgumentChoices::TotalFee => write!(f, "totalfee"),
StatsArgumentChoices::Txs => write!(f, "txs"),
StatsArgumentChoices::UtxoIncrease => write!(f, "utxo_increase"),
StatsArgumentChoices::UtxoSizeInc => write!(f, "utxo_size_inc"),
}
}
}
pub struct GetBlockStatsCommand {
target_block: TargetBlockArgument,
stats: Vec<StatsArgumentChoices>,
}
impl GetBlockStatsCommand {
pub fn new(target_block: TargetBlockArgument) -> Self {
GetBlockStatsCommand {
target_block,
stats: vec![],
}
}
pub fn add_selective_stats(
&mut self,
stats_argument_choices: Vec<StatsArgumentChoices>,
) -> &Self {
self.stats = stats_argument_choices;
self
}
}
#[derive(Serialize, Deserialize, Debug)]
pub struct GetBlockStatsCommandWithSelectiveStatsResponse {
pub avgfee: Option<u64>, // Average fee in the block
pub avgfeerate: Option<u64>, // Average feerate (in satoshis per virtual byte)
pub avgtxsize: Option<u64>, // Average transaction size
pub blockhash: Option<String>, // "hex" The block hash (to check for potential reorgs)
pub feerate_percentiles: Option<[u64; 5]>, // Feerates at the 10th, 25th, 50th, 75th, and 90th percentile weight unit (in satoshis per virtual byte)
// index 0, (numeric) The 10th percentile feerate
// index 1 (numeric) The 25th percentile feerate
// index 2 (numeric) The 50th percentile feerate
// index 3, (numeric) The 75th percentile feerate
// index 4 (numeric) The 90th percentile feerate
pub height: Option<u64>, // The height of the block
pub ins: Option<u64>, // The number of inputs (excluding coinbase)
pub maxfee: Option<u64>, // Maximum fee in the block
pub maxfeerate: Option<u64>, // Maximum feerate (in satoshis per virtual byte)
pub maxtxsize: Option<u64>, // Maximum transaction size
pub medianfee: Option<u64>, //Truncated median fee in the block
pub mediantime: Option<u64>, // The block median time past
pub mediantxsize: Option<u64>, // Truncated median transaction size
pub minfee: Option<u64>, // Minimum fee in the block
pub minfeerate: Option<u64>, // Minimum feerate (in satoshis per virtual byte)
pub mintxsize: Option<u64>, // Minimum transaction size
pub outs: Option<u64>, // The number of outputs
pub subsidy: Option<u64>, // The block subsidy
pub swtotal_size: Option<u64>, // Total size of all segwit transactions
pub swtotal_weight: Option<u64>, // Total weight of all segwit transactions
pub swtxs: Option<u64>, // The number of segwit transactions
pub time: Option<u64>, // The block time
pub total_out: Option<u64>, // Total amount in all outputs (excluding coinbase and thus reward [ie subsidy + totalfee])
pub total_size: Option<u64>, // Total size of all non-coinbase transactions
pub total_weight: Option<u64>, // Total weight of all non-coinbase transactions
pub totalfee: Option<u64>, // The fee total
pub txs: Option<u64>, // The number of transactions (including coinbase)
pub utxo_increase: Option<u64>, // The increase/decrease in the number of unspent outputs
pub utxo_size_inc: Option<u64>, // The increase/decrease in size for the utxo index (not discounting op_return and similar)
}
#[derive(Serialize, Deserialize, Debug)]
pub struct GetBlockStatsCommandWithAllStatsResponse {
pub avgfee: u64, // Average fee in the block
pub avgfeerate: u64, // Average feerate (in satoshis per virtual byte)
pub avgtxsize: u64, // Average transaction size
pub blockhash: String, // "hex" The block hash (to check for potential reorgs)
pub feerate_percentiles: [u64; 5], // Feerates at the 10th, 25th, 50th, 75th, and 90th percentile weight unit (in satoshis per virtual byte)
// index 0, (numeric) The 10th percentile feerate
// index 1 (numeric) The 25th percentile feerate
// index 2 (numeric) The 50th percentile feerate
// index 3, (numeric) The 75th percentile feerate
// index 4 (numeric) The 90th percentile feerate
pub height: u64, // The height of the block
pub ins: u64, // The number of inputs (excluding coinbase)
pub maxfee: u64, // Maximum fee in the block
pub maxfeerate: u64, // Maximum feerate (in satoshis per virtual byte)
pub maxtxsize: u64, // Maximum transaction size
pub medianfee: u64, //Truncated median fee in the block
pub mediantime: u64, // The block median time past
pub mediantxsize: u64, // Truncated median transaction size
pub minfee: u64, // Minimum fee in the block
pub minfeerate: u64, // Minimum feerate (in satoshis per virtual byte)
pub mintxsize: u64, // Minimum transaction size
pub outs: u64, // The number of outputs
pub subsidy: u64, // The block subsidy
pub swtotal_size: u64, // Total size of all segwit transactions
pub swtotal_weight: u64, // Total weight of all segwit transactions
pub swtxs: u64, // The number of segwit transactions
pub time: u64, // The block time
pub total_out: u64, // Total amount in all outputs (excluding coinbase and thus reward [ie subsidy + totalfee])
pub total_size: u64, // Total size of all non-coinbase transactions
pub total_weight: u64, // Total weight of all non-coinbase transactions
pub totalfee: u64, // The fee total
pub txs: u64, // The number of transactions (including coinbase)
pub utxo_increase: i64, // The increase/decrease in the number of unspent outputs
pub utxo_size_inc: i64, // The increase/decrease in size for the utxo index (not discounting op_return and similar)
}
#[derive(Serialize, Deserialize, Debug)]
#[serde(rename_all = "camelCase")]
#[serde(untagged)]
pub enum GetBlockStatsCommandResponse {
SelectiveStats(GetBlockStatsCommandWithSelectiveStatsResponse),
AllStats(GetBlockStatsCommandWithAllStatsResponse),
}
impl CallableCommand for GetBlockStatsCommand {
type Response = GetBlockStatsCommandResponse;
fn call(&self, client: &Client) -> Result<Self::Response, jsonrpc::Error> {
let target_block = &self.target_block;
let hash_or_height_arg_raw_value = match target_block {
TargetBlockArgument::Hash(hash) => to_raw_value(&hash).unwrap(),
TargetBlockArgument::Height(height) => to_raw_value(&height).unwrap(),
};
// TODO: Add stats param!
let stats_arg: Vec<String> = self.stats.iter().map(|stat| stat.to_string()).collect();
let stats_arg_raw_value = to_raw_value(&stats_arg).unwrap();
let command = "getblockstats";
let params = vec![hash_or_height_arg_raw_value, stats_arg_raw_value];
let r = request(client, command, params);
let response: GetBlockStatsCommandResponse = if stats_arg.is_empty() {
GetBlockStatsCommandResponse::AllStats(r.result()?)
} else {
GetBlockStatsCommandResponse::SelectiveStats(r.result()?)
};
Ok(response)
}
}