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