/tmp/bitcoin/src/wallet/fees.cpp
Line | Count | Source |
1 | | // Copyright (c) 2009-2010 Satoshi Nakamoto |
2 | | // Copyright (c) 2009-present The Bitcoin Core developers |
3 | | // Distributed under the MIT software license, see the accompanying |
4 | | // file COPYING or http://www.opensource.org/licenses/mit-license.php. |
5 | | |
6 | | #include <wallet/fees.h> |
7 | | |
8 | | #include <policy/feerate.h> |
9 | | #include <util/fees.h> |
10 | | #include <wallet/coincontrol.h> |
11 | | #include <wallet/wallet.h> |
12 | | |
13 | | #include <optional> |
14 | | |
15 | | namespace wallet { |
16 | | CAmount GetRequiredFee(const CWallet& wallet, unsigned int nTxBytes) |
17 | 25 | { |
18 | 25 | return GetRequiredFeeRate(wallet).GetFee(static_cast<int32_t>(nTxBytes)); |
19 | 25 | } |
20 | | |
21 | | |
22 | | CAmount GetMinimumFee(const MinimumFeeRateResult& min_fee_rate, unsigned int nTxBytes) |
23 | 0 | { |
24 | 0 | return min_fee_rate.fee_rate.GetFee(static_cast<int32_t>(nTxBytes)); |
25 | 0 | } |
26 | | |
27 | | CFeeRate GetRequiredFeeRate(const CWallet& wallet) |
28 | 3.70k | { |
29 | 3.70k | return std::max(wallet.m_min_fee, wallet.chain().relayMinFee()); |
30 | 3.70k | } |
31 | | |
32 | | MinimumFeeRateResult GetMinimumFeeRate(const CWallet& wallet, const CCoinControl& coin_control) |
33 | 4.06k | { |
34 | | /* User control of how to calculate fee uses the following parameter precedence: |
35 | | 1. coin_control.m_feerate |
36 | | 2. coin_control.m_confirm_target |
37 | | 3. m_confirm_target (user-set member variable of wallet) |
38 | | The first parameter that is set is used. |
39 | | */ |
40 | 4.06k | if (coin_control.m_feerate) { // 1. |
41 | 1.13k | CFeeRate fee_rate{*coin_control.m_feerate}; |
42 | | // Allow to override automatic min/max check over coin control instance |
43 | 1.13k | if (coin_control.fOverrideFeeRate) return {fee_rate, FeeReason::USER_SPECIFIED, std::nullopt}; |
44 | | |
45 | 766 | CFeeRate required_feerate = GetRequiredFeeRate(wallet); |
46 | 766 | if (required_feerate > fee_rate) return {required_feerate, FeeReason::REQUIRED, std::nullopt}; |
47 | | |
48 | 744 | return {fee_rate, FeeReason::USER_SPECIFIED, std::nullopt}; |
49 | 766 | } |
50 | | |
51 | | // We will use smart fee estimation |
52 | 2.93k | unsigned int target = coin_control.m_confirm_target ? *coin_control.m_confirm_target : wallet.m_confirm_target; |
53 | | // By default estimates are economical iff we are signaling opt-in-RBF |
54 | 2.93k | bool conservative_estimate = !coin_control.m_signal_bip125_rbf.value_or(wallet.m_signal_rbf); |
55 | | // Allow to override the default fee estimate mode over the CoinControl instance |
56 | 2.93k | if (coin_control.m_fee_mode == FeeEstimateMode::CONSERVATIVE) |
57 | 0 | conservative_estimate = true; |
58 | 2.93k | else if (coin_control.m_fee_mode == FeeEstimateMode::ECONOMICAL) |
59 | 4 | conservative_estimate = false; |
60 | | |
61 | 2.93k | const auto fee_estimation_res = wallet.chain().getFeeRateEstimate(target, conservative_estimate); |
62 | 2.93k | const FeeRateEstimation& estimation{FeeRateEstimationRef(fee_estimation_res)}; |
63 | 2.93k | CFeeRate fee_rate{estimation.feerate}; |
64 | 2.93k | FeeReason fee_reason{FeeReason::FEE_RATE_ESTIMATOR}; |
65 | | // Only fee rate estimator results have a returned target. |
66 | 2.93k | std::optional<int> returned_target{estimation.returned_target}; |
67 | 2.93k | if (fee_rate == CFeeRate(0)) { |
68 | | // if we don't have enough data for getFeeRateEstimate, then use fallback fee |
69 | 1.61k | fee_rate = wallet.m_fallback_fee; |
70 | 1.61k | fee_reason = FeeReason::FALLBACK; |
71 | 1.61k | returned_target = std::nullopt; |
72 | | // directly return if fallback fee is disabled (feerate 0 == disabled) |
73 | 1.61k | if (wallet.m_fallback_fee == CFeeRate(0)) return {fee_rate, FeeReason::FALLBACK, std::nullopt}; |
74 | 1.61k | } |
75 | | |
76 | | // Obey mempool min fee when using smart fee estimation or fallback fee |
77 | 2.91k | CFeeRate min_mempool_feerate = wallet.chain().mempoolMinFee(); |
78 | 2.91k | if (fee_rate < min_mempool_feerate) { |
79 | 0 | fee_rate = min_mempool_feerate; |
80 | 0 | fee_reason = FeeReason::MEMPOOL_MIN; |
81 | 0 | returned_target = std::nullopt; |
82 | 0 | } |
83 | | |
84 | 2.91k | CFeeRate required_feerate = GetRequiredFeeRate(wallet); |
85 | 2.91k | if (required_feerate > fee_rate) return {required_feerate, FeeReason::REQUIRED, std::nullopt}; |
86 | | |
87 | 1.57k | return {fee_rate, fee_reason, returned_target}; |
88 | 2.91k | } |
89 | | |
90 | | CFeeRate GetDiscardRate(const CWallet& wallet) |
91 | 3.79k | { |
92 | 3.79k | unsigned int highest_target = wallet.chain().maximumFeeEstimationTargetBlocks(); |
93 | 3.79k | const auto res = wallet.chain().getFeeRateEstimate(highest_target, /*conservative=*/false); |
94 | 3.79k | auto discard_rate = res ? CFeeRate(res->feerate) : CFeeRate(0); |
95 | | // Don't let discard_rate be greater than longest possible fee estimate if we get a valid fee estimate |
96 | 3.79k | discard_rate = (discard_rate == CFeeRate(0)) ? wallet.m_discard_rate : std::min(discard_rate, wallet.m_discard_rate); |
97 | | // Discard rate must be at least dust relay feerate |
98 | 3.79k | discard_rate = std::max(discard_rate, wallet.chain().relayDustFee()); |
99 | 3.79k | return discard_rate; |
100 | 3.79k | } |
101 | | } // namespace wallet |