Bitcoin Core 29.99.0
P2P Digital Currency
fees.cpp
Go to the documentation of this file.
1// Copyright (c) 2010 Satoshi Nakamoto
2// Copyright (c) 2009-2022 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 <common/messages.h>
7#include <core_io.h>
8#include <node/context.h>
9#include <policy/feerate.h>
10#include <policy/fees.h>
11#include <rpc/protocol.h>
12#include <rpc/request.h>
13#include <rpc/server.h>
14#include <rpc/server_util.h>
15#include <rpc/util.h>
16#include <txmempool.h>
17#include <univalue.h>
18#include <validationinterface.h>
19
20#include <algorithm>
21#include <array>
22#include <cmath>
23#include <string>
24
29
31{
32 return RPCHelpMan{
33 "estimatesmartfee",
34 "Estimates the approximate fee per kilobyte needed for a transaction to begin\n"
35 "confirmation within conf_target blocks if possible and return the number of blocks\n"
36 "for which the estimate is valid. Uses virtual transaction size as defined\n"
37 "in BIP 141 (witness data is discounted).\n",
38 {
39 {"conf_target", RPCArg::Type::NUM, RPCArg::Optional::NO, "Confirmation target in blocks (1 - 1008)"},
40 {"estimate_mode", RPCArg::Type::STR, RPCArg::Default{"economical"}, "The fee estimate mode.\n"
41 + FeeModesDetail(std::string("default mode will be used"))},
42 },
45 {
46 {RPCResult::Type::NUM, "feerate", /*optional=*/true, "estimate fee rate in " + CURRENCY_UNIT + "/kvB (only present if no errors were encountered)"},
47 {RPCResult::Type::ARR, "errors", /*optional=*/true, "Errors encountered during processing (if there are any)",
48 {
49 {RPCResult::Type::STR, "", "error"},
50 }},
51 {RPCResult::Type::NUM, "blocks", "block number where estimate was found\n"
52 "The request target will be clamped between 2 and the highest target\n"
53 "fee estimation is able to return based on how long it has been running.\n"
54 "An error is returned if not enough transactions and blocks\n"
55 "have been observed to make an estimate for any number of blocks."},
56 }},
58 HelpExampleCli("estimatesmartfee", "6") +
59 HelpExampleRpc("estimatesmartfee", "6")
60 },
61 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
62 {
63 CBlockPolicyEstimator& fee_estimator = EnsureAnyFeeEstimator(request.context);
64 const NodeContext& node = EnsureAnyNodeContext(request.context);
65 const CTxMemPool& mempool = EnsureMemPool(node);
66
67 CHECK_NONFATAL(mempool.m_opts.signals)->SyncWithValidationInterfaceQueue();
68 unsigned int max_target = fee_estimator.HighestTargetTracked(FeeEstimateHorizon::LONG_HALFLIFE);
69 unsigned int conf_target = ParseConfirmTarget(request.params[0], max_target);
70 bool conservative = false;
71 if (!request.params[1].isNull()) {
72 FeeEstimateMode fee_mode;
73 if (!FeeModeFromString(request.params[1].get_str(), fee_mode)) {
75 }
76 if (fee_mode == FeeEstimateMode::CONSERVATIVE) conservative = true;
77 }
78
81 FeeCalculation feeCalc;
82 CFeeRate feeRate{fee_estimator.estimateSmartFee(conf_target, &feeCalc, conservative)};
83 if (feeRate != CFeeRate(0)) {
84 CFeeRate min_mempool_feerate{mempool.GetMinFee()};
85 CFeeRate min_relay_feerate{mempool.m_opts.min_relay_feerate};
86 feeRate = std::max({feeRate, min_mempool_feerate, min_relay_feerate});
87 result.pushKV("feerate", ValueFromAmount(feeRate.GetFeePerK()));
88 } else {
89 errors.push_back("Insufficient data or no feerate found");
90 result.pushKV("errors", std::move(errors));
91 }
92 result.pushKV("blocks", feeCalc.returnedTarget);
93 return result;
94 },
95 };
96}
97
99{
100 return RPCHelpMan{
101 "estimaterawfee",
102 "WARNING: This interface is unstable and may disappear or change!\n"
103 "\nWARNING: This is an advanced API call that is tightly coupled to the specific\n"
104 "implementation of fee estimation. The parameters it can be called with\n"
105 "and the results it returns will change if the internal implementation changes.\n"
106 "\nEstimates the approximate fee per kilobyte needed for a transaction to begin\n"
107 "confirmation within conf_target blocks if possible. Uses virtual transaction size as\n"
108 "defined in BIP 141 (witness data is discounted).\n",
109 {
110 {"conf_target", RPCArg::Type::NUM, RPCArg::Optional::NO, "Confirmation target in blocks (1 - 1008)"},
111 {"threshold", RPCArg::Type::NUM, RPCArg::Default{0.95}, "The proportion of transactions in a given feerate range that must have been\n"
112 "confirmed within conf_target in order to consider those feerates as high enough and proceed to check\n"
113 "lower buckets."},
114 },
115 RPCResult{
116 RPCResult::Type::OBJ, "", "Results are returned for any horizon which tracks blocks up to the confirmation target",
117 {
118 {RPCResult::Type::OBJ, "short", /*optional=*/true, "estimate for short time horizon",
119 {
120 {RPCResult::Type::NUM, "feerate", /*optional=*/true, "estimate fee rate in " + CURRENCY_UNIT + "/kvB"},
121 {RPCResult::Type::NUM, "decay", "exponential decay (per block) for historical moving average of confirmation data"},
122 {RPCResult::Type::NUM, "scale", "The resolution of confirmation targets at this time horizon"},
123 {RPCResult::Type::OBJ, "pass", /*optional=*/true, "information about the lowest range of feerates to succeed in meeting the threshold",
124 {
125 {RPCResult::Type::NUM, "startrange", "start of feerate range"},
126 {RPCResult::Type::NUM, "endrange", "end of feerate range"},
127 {RPCResult::Type::NUM, "withintarget", "number of txs over history horizon in the feerate range that were confirmed within target"},
128 {RPCResult::Type::NUM, "totalconfirmed", "number of txs over history horizon in the feerate range that were confirmed at any point"},
129 {RPCResult::Type::NUM, "inmempool", "current number of txs in mempool in the feerate range unconfirmed for at least target blocks"},
130 {RPCResult::Type::NUM, "leftmempool", "number of txs over history horizon in the feerate range that left mempool unconfirmed after target"},
131 }},
132 {RPCResult::Type::OBJ, "fail", /*optional=*/true, "information about the highest range of feerates to fail to meet the threshold",
133 {
134 {RPCResult::Type::ELISION, "", ""},
135 }},
136 {RPCResult::Type::ARR, "errors", /*optional=*/true, "Errors encountered during processing (if there are any)",
137 {
138 {RPCResult::Type::STR, "error", ""},
139 }},
140 }},
141 {RPCResult::Type::OBJ, "medium", /*optional=*/true, "estimate for medium time horizon",
142 {
143 {RPCResult::Type::ELISION, "", ""},
144 }},
145 {RPCResult::Type::OBJ, "long", /*optional=*/true, "estimate for long time horizon",
146 {
147 {RPCResult::Type::ELISION, "", ""},
148 }},
149 }},
151 HelpExampleCli("estimaterawfee", "6 0.9")
152 },
153 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
154 {
155 CBlockPolicyEstimator& fee_estimator = EnsureAnyFeeEstimator(request.context);
156 const NodeContext& node = EnsureAnyNodeContext(request.context);
157
158 CHECK_NONFATAL(node.validation_signals)->SyncWithValidationInterfaceQueue();
159 unsigned int max_target = fee_estimator.HighestTargetTracked(FeeEstimateHorizon::LONG_HALFLIFE);
160 unsigned int conf_target = ParseConfirmTarget(request.params[0], max_target);
161 double threshold = 0.95;
162 if (!request.params[1].isNull()) {
163 threshold = request.params[1].get_real();
164 }
165 if (threshold < 0 || threshold > 1) {
166 throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid threshold");
167 }
168
169 UniValue result(UniValue::VOBJ);
170
171 for (const FeeEstimateHorizon horizon : ALL_FEE_ESTIMATE_HORIZONS) {
172 CFeeRate feeRate;
173 EstimationResult buckets;
174
175 // Only output results for horizons which track the target
176 if (conf_target > fee_estimator.HighestTargetTracked(horizon)) continue;
177
178 feeRate = fee_estimator.estimateRawFee(conf_target, threshold, horizon, &buckets);
179 UniValue horizon_result(UniValue::VOBJ);
180 UniValue errors(UniValue::VARR);
181 UniValue passbucket(UniValue::VOBJ);
182 passbucket.pushKV("startrange", round(buckets.pass.start));
183 passbucket.pushKV("endrange", round(buckets.pass.end));
184 passbucket.pushKV("withintarget", round(buckets.pass.withinTarget * 100.0) / 100.0);
185 passbucket.pushKV("totalconfirmed", round(buckets.pass.totalConfirmed * 100.0) / 100.0);
186 passbucket.pushKV("inmempool", round(buckets.pass.inMempool * 100.0) / 100.0);
187 passbucket.pushKV("leftmempool", round(buckets.pass.leftMempool * 100.0) / 100.0);
188 UniValue failbucket(UniValue::VOBJ);
189 failbucket.pushKV("startrange", round(buckets.fail.start));
190 failbucket.pushKV("endrange", round(buckets.fail.end));
191 failbucket.pushKV("withintarget", round(buckets.fail.withinTarget * 100.0) / 100.0);
192 failbucket.pushKV("totalconfirmed", round(buckets.fail.totalConfirmed * 100.0) / 100.0);
193 failbucket.pushKV("inmempool", round(buckets.fail.inMempool * 100.0) / 100.0);
194 failbucket.pushKV("leftmempool", round(buckets.fail.leftMempool * 100.0) / 100.0);
195
196 // CFeeRate(0) is used to indicate error as a return value from estimateRawFee
197 if (feeRate != CFeeRate(0)) {
198 horizon_result.pushKV("feerate", ValueFromAmount(feeRate.GetFeePerK()));
199 horizon_result.pushKV("decay", buckets.decay);
200 horizon_result.pushKV("scale", (int)buckets.scale);
201 horizon_result.pushKV("pass", std::move(passbucket));
202 // buckets.fail.start == -1 indicates that all buckets passed, there is no fail bucket to output
203 if (buckets.fail.start != -1) horizon_result.pushKV("fail", std::move(failbucket));
204 } else {
205 // Output only information that is still meaningful in the event of error
206 horizon_result.pushKV("decay", buckets.decay);
207 horizon_result.pushKV("scale", (int)buckets.scale);
208 horizon_result.pushKV("fail", std::move(failbucket));
209 errors.push_back("Insufficient data or no feerate found which meets threshold");
210 horizon_result.pushKV("errors", std::move(errors));
211 }
212 result.pushKV(StringForFeeEstimateHorizon(horizon), std::move(horizon_result));
213 }
214 return result;
215 },
216 };
217}
218
220{
221 static const CRPCCommand commands[]{
222 {"util", &estimatesmartfee},
223 {"hidden", &estimaterawfee},
224 };
225 for (const auto& c : commands) {
226 t.appendCommand(c.name, &c);
227 }
228}
#define CHECK_NONFATAL(condition)
Identity function.
Definition: check.h:102
The BlockPolicyEstimator is used for estimating the feerate needed for a transaction to be included i...
Definition: fees.h:149
CFeeRate estimateSmartFee(int confTarget, FeeCalculation *feeCalc, bool conservative) const EXCLUSIVE_LOCKS_REQUIRED(!m_cs_fee_estimator)
Estimate feerate needed to get be included in a block within confTarget blocks.
Definition: fees.cpp:870
unsigned int HighestTargetTracked(FeeEstimateHorizon horizon) const EXCLUSIVE_LOCKS_REQUIRED(!m_cs_fee_estimator)
Calculation of highest target that estimates are tracked for.
Definition: fees.cpp:762
CFeeRate estimateRawFee(int confTarget, double successThreshold, FeeEstimateHorizon horizon, EstimationResult *result=nullptr) const EXCLUSIVE_LOCKS_REQUIRED(!m_cs_fee_estimator)
Return a specific fee estimate calculation with a given success threshold and time horizon,...
Definition: fees.cpp:726
Fee rate in satoshis per kilovirtualbyte: CAmount / kvB.
Definition: feerate.h:33
CAmount GetFeePerK() const
Return the fee in satoshis for a vsize of 1000 vbytes.
Definition: feerate.h:63
RPC command dispatcher.
Definition: server.h:127
CTxMemPool stores valid-according-to-the-current-best-chain transactions that may be included in the ...
Definition: txmempool.h:304
CFeeRate GetMinFee(size_t sizelimit) const
Definition: txmempool.cpp:1126
const Options m_opts
Definition: txmempool.h:439
void push_back(UniValue val)
Definition: univalue.cpp:104
@ VOBJ
Definition: univalue.h:24
@ VARR
Definition: univalue.h:24
void pushKV(std::string key, UniValue val)
Definition: univalue.cpp:126
UniValue ValueFromAmount(const CAmount amount)
Definition: core_write.cpp:26
const std::string CURRENCY_UNIT
Definition: feerate.h:17
FeeEstimateMode
Definition: feerate.h:21
@ CONSERVATIVE
Force estimateSmartFee to use conservative estimates.
is a home for simple string functions returning descriptive messages that are used in RPC and GUI int...
bool FeeModeFromString(const std::string &mode_string, FeeEstimateMode &fee_estimate_mode)
Definition: messages.cpp:94
std::string FeeModesDetail(std::string default_info)
Definition: messages.cpp:75
std::string InvalidEstimateModeErrorMessage()
Definition: messages.cpp:89
Definition: messages.h:20
std::string StringForFeeEstimateHorizon(FeeEstimateHorizon horizon)
Definition: fees.cpp:40
static constexpr auto ALL_FEE_ESTIMATE_HORIZONS
Definition: fees.h:51
FeeEstimateHorizon
Definition: fees.h:45
UniValue JSONRPCError(int code, const std::string &message)
Definition: request.cpp:70
static RPCHelpMan estimatesmartfee()
Definition: fees.cpp:30
void RegisterFeeRPCCommands(CRPCTable &t)
Definition: fees.cpp:219
static RPCHelpMan estimaterawfee()
Definition: fees.cpp:98
@ RPC_INVALID_PARAMETER
Invalid, missing or duplicate parameter.
Definition: protocol.h:44
std::string HelpExampleCli(const std::string &methodname, const std::string &args)
Definition: util.cpp:186
std::string HelpExampleRpc(const std::string &methodname, const std::string &args)
Definition: util.cpp:204
unsigned int ParseConfirmTarget(const UniValue &value, unsigned int max_target)
Parse a confirm target option and raise an RPC error if it is invalid.
Definition: util.cpp:372
NodeContext & EnsureAnyNodeContext(const std::any &context)
Definition: server_util.cpp:25
CTxMemPool & EnsureMemPool(const NodeContext &node)
Definition: server_util.cpp:34
CBlockPolicyEstimator & EnsureAnyFeeEstimator(const std::any &context)
Definition: server_util.cpp:95
EstimatorBucket fail
Definition: fees.h:87
EstimatorBucket pass
Definition: fees.h:86
double decay
Definition: fees.h:88
unsigned int scale
Definition: fees.h:89
double totalConfirmed
Definition: fees.h:78
double end
Definition: fees.h:76
double leftMempool
Definition: fees.h:80
double start
Definition: fees.h:75
double withinTarget
Definition: fees.h:77
double inMempool
Definition: fees.h:79
int returnedTarget
Definition: fees.h:97
@ NO
Required arg.
@ ELISION
Special type to denote elision (...)
ValidationSignals * signals
CFeeRate min_relay_feerate
A fee rate smaller than this is considered zero fee (for relaying, mining and transaction creation)
NodeContext struct containing references to chain state and connection state.
Definition: context.h:56