ckb-rpc 1.3.0

CKB RPC server
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

use ckb_jsonrpc_types::FeeRateStatistics;
use ckb_shared::Snapshot;
use ckb_store::ChainStore;
use ckb_types::core::{BlockExt, BlockNumber, FeeRate, tx_pool::get_transaction_weight};

const DEFAULT_TARGET: u64 = 21;
const MIN_TARGET: u64 = 1;
const MAX_TARGET: u64 = 101;

fn is_even(n: u64) -> bool {
    n & 1 == 0
}

fn mean(numbers: &[u64]) -> u64 {
    // The average of u64 values fits in u64, but the intermediate sum may not.
    let sum: u128 = numbers.iter().map(|number| u128::from(*number)).sum();
    (sum / numbers.len() as u128) as u64
}

fn median(numbers: &mut [u64]) -> u64 {
    numbers.sort_unstable();
    let mid = numbers.len() / 2;
    if numbers.len().is_multiple_of(2) {
        mean(&[numbers[mid - 1], numbers[mid]])
    } else {
        numbers[mid]
    }
}

pub(crate) trait FeeRateProvider {
    fn get_tip_number(&self) -> BlockNumber;
    fn get_block_ext_by_number(&self, number: BlockNumber) -> Option<BlockExt>;
    fn max_target(&self) -> u64;

    fn collect<F>(&self, target: u64, f: F) -> Vec<u64>
    where
        F: FnMut(Vec<u64>, BlockExt) -> Vec<u64>,
    {
        let tip_number = self.get_tip_number();
        let start = std::cmp::max(
            MIN_TARGET,
            tip_number.saturating_add(1).saturating_sub(target),
        );

        let block_ext_iter =
            (start..=tip_number).filter_map(|number| self.get_block_ext_by_number(number));
        block_ext_iter.fold(Vec::new(), f)
    }
}

impl FeeRateProvider for Snapshot {
    fn get_tip_number(&self) -> BlockNumber {
        self.tip_number()
    }

    fn get_block_ext_by_number(&self, number: BlockNumber) -> Option<BlockExt> {
        self.get_block_hash(number)
            .and_then(|hash| self.get_block_ext(&hash))
    }

    fn max_target(&self) -> u64 {
        MAX_TARGET
    }
}

// FeeRateCollector collect fee_rate related information
pub(crate) struct FeeRateCollector<'a, P> {
    provider: &'a P,
}

impl<'a, P> FeeRateCollector<'a, P>
where
    P: FeeRateProvider,
{
    pub fn new(provider: &'a P) -> Self {
        FeeRateCollector { provider }
    }

    pub fn statistics(&self, target: Option<u64>) -> Option<FeeRateStatistics> {
        let mut target = target.unwrap_or(DEFAULT_TARGET);
        if is_even(target) {
            target = target.saturating_add(1);
        }
        target = std::cmp::min(self.provider.max_target(), target);

        let mut fee_rates = self.provider.collect(target, |mut fee_rates, block_ext| {
            let BlockExt {
                txs_sizes,
                cycles,
                txs_fees,
                ..
            } = block_ext;
            // Older BlockExt records may not contain transaction size data.
            let Some(txs_sizes) = txs_sizes else {
                return fee_rates;
            };
            if txs_sizes.len() > 1 && !txs_fees.is_empty() {
                // block_ext.txs_fees's length == block_ext.cycles's length
                // block_ext.txs_fees's length + 1 == txs_sizes's length
                if let Some(cycles) = cycles {
                    for (fee, cycles, size) in itertools::izip!(
                        txs_fees,
                        cycles,
                        txs_sizes.iter().skip(1) // skip cellbase (first element in the Vec)
                    ) {
                        let weight = get_transaction_weight(*size as usize, cycles);
                        if weight > 0 {
                            fee_rates.push(FeeRate::calculate(fee, weight).as_u64());
                        }
                    }
                }
            }
            fee_rates
        });

        if fee_rates.is_empty() {
            None
        } else {
            Some(FeeRateStatistics {
                mean: mean(&fee_rates).into(),
                median: median(&mut fee_rates).into(),
            })
        }
    }
}