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