Branch data Line data Source code
1 : : // Copyright (c) 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 <bitcoin-build-config.h> // IWYU pragma: keep
7 : :
8 : : #include <interfaces/mining.h>
9 : :
10 : : #include <addresstype.h>
11 : : #include <arith_uint256.h>
12 : : #include <chain.h>
13 : : #include <chainparams.h>
14 : : #include <chainparamsbase.h>
15 : : #include <consensus/amount.h>
16 : : #include <consensus/consensus.h>
17 : : #include <consensus/merkle.h>
18 : : #include <consensus/params.h>
19 : : #include <consensus/validation.h>
20 : : #include <core_io.h>
21 : : #include <crypto/hex_base.h>
22 : : #include <interfaces/types.h>
23 : : #include <key_io.h>
24 : : #include <net.h>
25 : : #include <netbase.h>
26 : : #include <node/blockstorage.h>
27 : : #include <node/context.h>
28 : : #include <node/miner.h>
29 : : #include <node/mining_args.h>
30 : : #include <node/mining_types.h>
31 : : #include <node/warnings.h>
32 : : #include <policy/feerate.h>
33 : : #include <policy/policy.h>
34 : : #include <pow.h>
35 : : #include <primitives/block.h>
36 : : #include <primitives/transaction.h>
37 : : #include <rpc/blockchain.h>
38 : : #include <rpc/mining.h>
39 : : #include <rpc/protocol.h>
40 : : #include <rpc/request.h>
41 : : #include <rpc/server.h>
42 : : #include <rpc/server_util.h>
43 : : #include <rpc/util.h>
44 : : #include <script/descriptor.h>
45 : : #include <script/script.h>
46 : : #include <script/signingprovider.h>
47 : : #include <serialize.h>
48 : : #include <streams.h>
49 : : #include <sync.h>
50 : : #include <tinyformat.h>
51 : : #include <txmempool.h>
52 : : #include <uint256.h>
53 : : #include <univalue.h>
54 : : #include <util/chaintype.h>
55 : : #include <util/check.h>
56 : : #include <util/signalinterrupt.h>
57 : : #include <util/strencodings.h>
58 : : #include <util/string.h>
59 : : #include <util/time.h>
60 : : #include <validation.h>
61 : : #include <validationinterface.h>
62 : : #include <versionbits.h>
63 : :
64 : : #include <algorithm>
65 : : #include <cstddef>
66 : : #include <cstdint>
67 : : #include <functional>
68 : : #include <initializer_list>
69 : : #include <limits>
70 : : #include <map>
71 : : #include <memory>
72 : : #include <optional>
73 : : #include <set>
74 : : #include <span>
75 : : #include <string>
76 : : #include <string_view>
77 : : #include <utility>
78 : : #include <vector>
79 : :
80 : : using interfaces::BlockRef;
81 : : using interfaces::BlockTemplate;
82 : : using interfaces::Mining;
83 : : using node::BlockAssembler;
84 : : using node::GetMinimumTime;
85 : : using node::NodeContext;
86 : : using node::RegenerateCommitments;
87 : : using node::UpdateTime;
88 : : using util::ToString;
89 : :
90 : : /**
91 : : * Return average network hashes per second based on the last 'lookup' blocks,
92 : : * or from the last difficulty change if 'lookup' is -1.
93 : : * If 'height' is -1, compute the estimate from current chain tip.
94 : : * If 'height' is a valid block height, compute the estimate at the time when a given block was found.
95 : : */
96 : 13 : static UniValue GetNetworkHashPS(int lookup, int height, const CChain& active_chain) {
97 [ + + ]: 13 : if (lookup < -1 || lookup == 0) {
98 [ + - + - ]: 6 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid nblocks. Must be a positive number or -1.");
99 : : }
100 : :
101 [ + + + + ]: 18 : if (height < -1 || height > active_chain.Height()) {
102 [ + - + - ]: 8 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Block does not exist at specified height");
103 : : }
104 : :
105 [ + - ]: 6 : const CBlockIndex* pb = active_chain.Tip();
106 : :
107 [ + + ]: 6 : if (height >= 0) {
108 : 2 : pb = active_chain[height];
109 : : }
110 : :
111 [ + - + - ]: 6 : if (pb == nullptr || !pb->nHeight)
112 : 6 : return 0;
113 : :
114 : : // If lookup is -1, then use blocks since last difficulty change.
115 [ # # ]: 0 : if (lookup == -1)
116 : 0 : lookup = pb->nHeight % Params().GetConsensus().DifficultyAdjustmentInterval() + 1;
117 : :
118 : : // If lookup is larger than chain, then set it to chain length.
119 [ # # ]: 0 : if (lookup > pb->nHeight)
120 : 0 : lookup = pb->nHeight;
121 : :
122 : 0 : const CBlockIndex* pb0 = pb;
123 : 0 : int64_t minTime = pb0->GetBlockTime();
124 : 0 : int64_t maxTime = minTime;
125 [ # # ]: 0 : for (int i = 0; i < lookup; i++) {
126 : 0 : pb0 = pb0->pprev;
127 [ # # ]: 0 : int64_t time = pb0->GetBlockTime();
128 [ # # ]: 0 : minTime = std::min(time, minTime);
129 [ # # ]: 0 : maxTime = std::max(time, maxTime);
130 : : }
131 : :
132 : : // In case there's a situation where minTime == maxTime, we don't want a divide by zero exception.
133 [ # # ]: 0 : if (minTime == maxTime)
134 : 0 : return 0;
135 : :
136 : 0 : arith_uint256 workDiff = pb->nChainWork - pb0->nChainWork;
137 : 0 : int64_t timeDiff = maxTime - minTime;
138 : :
139 : 0 : return workDiff.getdouble() / timeDiff;
140 : : }
141 : :
142 : 74 : static RPCMethod getnetworkhashps()
143 : : {
144 : 74 : return RPCMethod{
145 : 74 : "getnetworkhashps",
146 [ + - ]: 148 : "Returns the estimated network hashes per second based on the last n blocks.\n"
147 : : "Pass in [blocks] to override # of blocks, -1 specifies since last difficulty change.\n"
148 : : "Pass in [height] to estimate the network speed at the time when a certain block was found.\n",
149 : : {
150 [ + - + - : 222 : {"nblocks", RPCArg::Type::NUM, RPCArg::Default{120}, "The number of previous blocks to calculate estimate from, or -1 for blocks since last difficulty change."},
+ - ]
151 [ + - + - : 222 : {"height", RPCArg::Type::NUM, RPCArg::Default{-1}, "To estimate at the time of the given height."},
+ - ]
152 : : },
153 [ + - ]: 148 : RPCResult{
154 [ + - + - : 148 : RPCResult::Type::NUM, "", "Hashes per second estimated"},
+ - ]
155 : 74 : RPCExamples{
156 [ + - + - : 148 : HelpExampleCli("getnetworkhashps", "")
+ - ]
157 [ + - + - : 296 : + HelpExampleRpc("getnetworkhashps", "")
+ - + - ]
158 [ + - ]: 74 : },
159 : 74 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
160 : : {
161 : 14 : ChainstateManager& chainman = EnsureAnyChainman(request.context);
162 : 14 : LOCK(cs_main);
163 [ + - + - : 14 : return GetNetworkHashPS(self.Arg<int>("nblocks"), self.Arg<int>("height"), chainman.ActiveChain());
+ + + + ]
164 : 6 : },
165 [ + - + - : 444 : };
+ + - - ]
166 [ + - + - : 296 : }
- - ]
167 : :
168 : 0 : static bool GenerateBlock(ChainstateManager& chainman, CBlock&& block, uint64_t& max_tries, std::shared_ptr<const CBlock>& block_out, bool process_new_block)
169 : : {
170 : 0 : block_out.reset();
171 : 0 : block.hashMerkleRoot = BlockMerkleRoot(block);
172 : :
173 [ # # # # : 0 : while (max_tries > 0 && block.nNonce < std::numeric_limits<uint32_t>::max() && !CheckProofOfWork(block.GetHash(), block.nBits, chainman.GetConsensus()) && !chainman.m_interrupt) {
# # # # ]
174 : 0 : ++block.nNonce;
175 : 0 : --max_tries;
176 : : }
177 [ # # # # ]: 0 : if (max_tries == 0 || chainman.m_interrupt) {
178 : 0 : return false;
179 : : }
180 [ # # ]: 0 : if (block.nNonce == std::numeric_limits<uint32_t>::max()) {
181 : : return true;
182 : : }
183 : :
184 [ # # ]: 0 : block_out = std::make_shared<const CBlock>(std::move(block));
185 : :
186 [ # # ]: 0 : if (!process_new_block) return true;
187 : :
188 [ # # ]: 0 : if (!chainman.ProcessNewBlock(block_out, /*force_processing=*/true, /*min_pow_checked=*/true, nullptr)) {
189 [ # # # # ]: 0 : throw JSONRPCError(RPC_INTERNAL_ERROR, "ProcessNewBlock, block not accepted");
190 : : }
191 : :
192 : : return true;
193 : : }
194 : :
195 : 0 : static UniValue generateBlocks(ChainstateManager& chainman, Mining& miner, const CScript& coinbase_output_script, int nGenerate, uint64_t nMaxTries)
196 : : {
197 : 0 : UniValue blockHashes(UniValue::VARR);
198 [ # # # # : 0 : while (nGenerate > 0 && !chainman.m_interrupt) {
# # ]
199 : 0 : std::unique_ptr<BlockTemplate> block_template(miner.createNewBlock({ .coinbase_output_script = coinbase_output_script }, /*cooldown=*/false));
200 [ # # ]: 0 : CHECK_NONFATAL(block_template);
201 : :
202 : 0 : std::shared_ptr<const CBlock> block_out;
203 [ # # # # : 0 : if (!GenerateBlock(chainman, block_template->getBlock(), nMaxTries, block_out, /*process_new_block=*/true)) {
# # ]
204 : : break;
205 : : }
206 : :
207 [ # # ]: 0 : if (block_out) {
208 : 0 : --nGenerate;
209 [ # # # # : 0 : blockHashes.push_back(block_out->GetHash().GetHex());
# # # # ]
210 : : }
211 : 0 : }
212 : 0 : return blockHashes;
213 [ # # ]: 0 : }
214 : :
215 : 333 : static bool getScriptFromDescriptor(std::string_view descriptor, CScript& script, std::string& error)
216 : : {
217 : 333 : FlatSigningProvider key_provider;
218 [ + - ]: 333 : const auto descs = Parse(descriptor, key_provider, error, /* require_checksum = */ false);
219 [ + + ]: 333 : if (descs.empty()) return false;
220 [ - + - + ]: 26 : if (descs.size() > 1) {
221 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Multipath descriptor not accepted");
222 : : }
223 [ + - ]: 26 : const auto& desc = descs.at(0);
224 [ + - - + ]: 26 : if (desc->IsRange()) {
225 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Ranged descriptor not accepted. Maybe pass through deriveaddresses first?");
226 : : }
227 : :
228 : 26 : FlatSigningProvider provider;
229 : 26 : std::vector<CScript> scripts;
230 [ + - - + ]: 26 : if (!desc->Expand(0, key_provider, scripts, provider)) {
231 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Cannot derive script without private keys");
232 : : }
233 : :
234 : : // Combo descriptors can have 2 or 4 scripts, so we can't just check scripts.size() == 1
235 [ - + + - : 26 : CHECK_NONFATAL(scripts.size() > 0 && scripts.size() <= 4);
- + + - ]
236 : :
237 [ - + + - ]: 26 : if (scripts.size() == 1) {
238 [ + - ]: 26 : script = scripts.at(0);
239 [ # # ]: 0 : } else if (scripts.size() == 4) {
240 : : // For uncompressed keys, take the 3rd script, since it is p2wpkh
241 [ # # ]: 0 : script = scripts.at(2);
242 : : } else {
243 : : // Else take the 2nd script, since it is p2pkh
244 [ # # ]: 0 : script = scripts.at(1);
245 : : }
246 : :
247 : 26 : return true;
248 : 333 : }
249 : :
250 : 56 : static RPCMethod generatetodescriptor()
251 : : {
252 : 56 : return RPCMethod{
253 : 56 : "generatetodescriptor",
254 [ + - ]: 112 : "Mine to a specified descriptor and return the block hashes.",
255 : : {
256 [ + - + - ]: 112 : {"num_blocks", RPCArg::Type::NUM, RPCArg::Optional::NO, "How many blocks are generated."},
257 [ + - + - ]: 112 : {"descriptor", RPCArg::Type::STR, RPCArg::Optional::NO, "The descriptor to send the newly generated bitcoin to."},
258 [ + - + - : 168 : {"maxtries", RPCArg::Type::NUM, RPCArg::Default{DEFAULT_MAX_TRIES}, "How many iterations to try."},
+ - ]
259 : : },
260 [ + - ]: 112 : RPCResult{
261 [ + - + - ]: 112 : RPCResult::Type::ARR, "", "hashes of blocks generated",
262 : : {
263 [ + - + - ]: 112 : {RPCResult::Type::STR_HEX, "", "blockhash"},
264 : : }
265 [ + - + - : 224 : },
+ + - - ]
266 : 56 : RPCExamples{
267 [ + - + - : 168 : "\nGenerate 11 blocks to mydesc\n" + HelpExampleCli("generatetodescriptor", "11 \"mydesc\"")},
+ - + - +
- ]
268 : 56 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
269 : : {
270 : 0 : const auto num_blocks{self.Arg<int>("num_blocks")};
271 : 0 : const auto max_tries{self.Arg<uint64_t>("maxtries")};
272 : :
273 : 0 : CScript coinbase_output_script;
274 [ # # ]: 0 : std::string error;
275 [ # # # # : 0 : if (!getScriptFromDescriptor(self.Arg<std::string_view>("descriptor"), coinbase_output_script, error)) {
# # ]
276 [ # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, error);
277 : : }
278 : :
279 [ # # ]: 0 : NodeContext& node = EnsureAnyNodeContext(request.context);
280 [ # # ]: 0 : Mining& miner = EnsureMining(node);
281 [ # # ]: 0 : ChainstateManager& chainman = EnsureChainman(node);
282 : :
283 [ # # ]: 0 : return generateBlocks(chainman, miner, coinbase_output_script, num_blocks, max_tries);
284 : 0 : },
285 [ + - + - : 392 : };
+ + - - ]
286 [ + - + - : 448 : }
+ - + - -
- ]
287 : :
288 : 77 : static RPCMethod generate()
289 : : {
290 [ + - + - ]: 308 : return RPCMethod{"generate", "has been replaced by the -generate cli option. Refer to -help for more information.", {}, {}, RPCExamples{""}, [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue {
291 [ + - + - ]: 2 : throw JSONRPCError(RPC_METHOD_NOT_FOUND, self.ToString());
292 [ + - + - : 385 : }};
+ - ]
293 : : }
294 : :
295 : 55 : static RPCMethod generatetoaddress()
296 : : {
297 : 55 : return RPCMethod{"generatetoaddress",
298 [ + - ]: 110 : "Mine to a specified address and return the block hashes.",
299 : : {
300 [ + - + - ]: 110 : {"nblocks", RPCArg::Type::NUM, RPCArg::Optional::NO, "How many blocks are generated."},
301 [ + - + - ]: 110 : {"address", RPCArg::Type::STR, RPCArg::Optional::NO, "The address to send the newly generated bitcoin to."},
302 [ + - + - : 165 : {"maxtries", RPCArg::Type::NUM, RPCArg::Default{DEFAULT_MAX_TRIES}, "How many iterations to try."},
+ - ]
303 : : },
304 [ + - ]: 110 : RPCResult{
305 [ + - + - ]: 110 : RPCResult::Type::ARR, "", "hashes of blocks generated",
306 : : {
307 [ + - + - ]: 110 : {RPCResult::Type::STR_HEX, "", "blockhash"},
308 [ + - + - : 220 : }},
+ + - - ]
309 : 55 : RPCExamples{
310 : : "\nGenerate 11 blocks to myaddress\n"
311 [ + - + - : 110 : + HelpExampleCli("generatetoaddress", "11 \"myaddress\"")
+ - + - ]
312 : 55 : + "If you are using the " CLIENT_NAME " wallet, you can get a new address to send the newly generated bitcoin to with:\n"
313 [ + - + - : 220 : + HelpExampleCli("getnewaddress", "")
+ - + - ]
314 [ + - ]: 55 : },
315 : 55 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
316 : : {
317 : 0 : const int num_blocks{request.params[0].getInt<int>()};
318 [ # # ]: 0 : const uint64_t max_tries{request.params[2].isNull() ? DEFAULT_MAX_TRIES : request.params[2].getInt<int>()};
319 : :
320 : 0 : CTxDestination destination = DecodeDestination(request.params[1].get_str());
321 [ # # # # ]: 0 : if (!IsValidDestination(destination)) {
322 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Error: Invalid address");
323 : : }
324 : :
325 [ # # ]: 0 : NodeContext& node = EnsureAnyNodeContext(request.context);
326 [ # # ]: 0 : Mining& miner = EnsureMining(node);
327 [ # # ]: 0 : ChainstateManager& chainman = EnsureChainman(node);
328 : :
329 [ # # ]: 0 : CScript coinbase_output_script = GetScriptForDestination(destination);
330 : :
331 [ # # ]: 0 : return generateBlocks(chainman, miner, coinbase_output_script, num_blocks, max_tries);
332 : 0 : },
333 [ + - + - : 385 : };
+ + - - ]
334 [ + - + - : 440 : }
+ - + - -
- ]
335 : :
336 : 390 : static RPCMethod generateblock()
337 : : {
338 : 390 : return RPCMethod{"generateblock",
339 [ + - ]: 780 : "Mine a set of ordered transactions to a specified address or descriptor and return the block hash.\n"
340 : : "Transaction fees are not collected in the block reward.",
341 : : {
342 [ + - + - ]: 780 : {"output", RPCArg::Type::STR, RPCArg::Optional::NO, "The address or descriptor to send the newly generated bitcoin to."},
343 [ + - + - ]: 780 : {"transactions", RPCArg::Type::ARR, RPCArg::Optional::NO, "An array of hex strings which are either txids or raw transactions.\n"
344 : : "Txids must reference transactions currently in the mempool.\n"
345 : : "All transactions must be valid and in valid order, otherwise the block will be rejected.",
346 : : {
347 [ + - + - ]: 780 : {"rawtx/txid", RPCArg::Type::STR_HEX, RPCArg::Optional::OMITTED, ""},
348 : : },
349 : : },
350 [ + - + - : 1170 : {"submit", RPCArg::Type::BOOL, RPCArg::Default{true}, "Whether to submit the block before the RPC call returns or to return it as hex."},
+ - ]
351 : : },
352 [ + - ]: 780 : RPCResult{
353 [ + - + - ]: 780 : RPCResult::Type::OBJ, "", "",
354 : : {
355 [ + - + - ]: 780 : {RPCResult::Type::STR_HEX, "hash", "hash of generated block"},
356 [ + - + - ]: 780 : {RPCResult::Type::STR_HEX, "hex", /*optional=*/true, "hex of generated block, only present when submit=false"},
357 : : }
358 [ + - + - : 2340 : },
+ + - - ]
359 : 390 : RPCExamples{
360 : : "\nGenerate a block to myaddress, with txs rawtx and mempool_txid\n"
361 [ + - + - : 780 : + HelpExampleCli("generateblock", R"("myaddress" '["rawtx", "mempool_txid"]')")
+ - + - ]
362 [ + - ]: 390 : },
363 : 390 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
364 : : {
365 [ - + ]: 333 : const auto address_or_descriptor = request.params[0].get_str();
366 : 333 : CScript coinbase_output_script;
367 [ - + ]: 333 : std::string error;
368 : :
369 [ - + + - : 333 : if (!getScriptFromDescriptor(address_or_descriptor, coinbase_output_script, error)) {
+ + ]
370 [ + - ]: 307 : const auto destination = DecodeDestination(address_or_descriptor);
371 [ + - + + ]: 307 : if (!IsValidDestination(destination)) {
372 [ + - + - ]: 596 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Error: Invalid address or descriptor");
373 : : }
374 : :
375 [ + - ]: 18 : coinbase_output_script = GetScriptForDestination(destination);
376 : 307 : }
377 : :
378 [ + - ]: 35 : NodeContext& node = EnsureAnyNodeContext(request.context);
379 [ - + ]: 35 : Mining& miner = EnsureMining(node);
380 [ # # ]: 0 : const CTxMemPool& mempool = EnsureMemPool(node);
381 : :
382 : 0 : std::vector<CTransactionRef> txs;
383 [ # # # # : 0 : const auto raw_txs_or_txids = request.params[1].get_array();
# # ]
384 [ # # # # ]: 0 : for (size_t i = 0; i < raw_txs_or_txids.size(); i++) {
385 [ # # # # ]: 0 : const auto& str{raw_txs_or_txids[i].get_str()};
386 : :
387 [ # # ]: 0 : CMutableTransaction mtx;
388 [ # # # # : 0 : if (auto txid{Txid::FromHex(str)}) {
# # ]
389 [ # # ]: 0 : const auto tx{mempool.get(*txid)};
390 [ # # ]: 0 : if (!tx) {
391 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, strprintf("Transaction %s not in mempool.", str));
392 : : }
393 : :
394 [ # # ]: 0 : txs.emplace_back(tx);
395 : :
396 [ # # # # ]: 0 : } else if (DecodeHexTx(mtx, str)) {
397 [ # # # # : 0 : txs.push_back(MakeTransactionRef(std::move(mtx)));
# # ]
398 : :
399 : : } else {
400 [ # # # # ]: 0 : throw JSONRPCError(RPC_DESERIALIZATION_ERROR, strprintf("Transaction decode failed for %s. Make sure the tx has at least one input.", str));
401 : : }
402 : 0 : }
403 : :
404 [ # # # # : 0 : const bool process_new_block{request.params[2].isNull() ? true : request.params[2].get_bool()};
# # # # ]
405 : 0 : CBlock block;
406 : :
407 [ # # ]: 0 : ChainstateManager& chainman = EnsureChainman(node);
408 : 0 : {
409 [ # # ]: 0 : LOCK(chainman.GetMutex());
410 : 0 : {
411 : 0 : std::unique_ptr<BlockTemplate> block_template{miner.createNewBlock({.use_mempool = false, .coinbase_output_script = coinbase_output_script}, /*cooldown=*/false)};
412 [ # # ]: 0 : CHECK_NONFATAL(block_template);
413 : :
414 [ # # ]: 0 : block = block_template->getBlock();
415 : 0 : }
416 : :
417 [ # # # # ]: 0 : CHECK_NONFATAL(block.vtx.size() == 1);
418 : :
419 : : // Add transactions
420 [ # # ]: 0 : block.vtx.insert(block.vtx.end(), txs.begin(), txs.end());
421 [ # # ]: 0 : RegenerateCommitments(block, chainman);
422 : :
423 [ # # # # : 0 : if (BlockValidationState state{TestBlockValidity(chainman.ActiveChainstate(), block, /*check_pow=*/false, /*check_merkle_root=*/false)}; !state.IsValid()) {
# # ]
424 [ # # # # : 0 : throw JSONRPCError(RPC_VERIFY_ERROR, strprintf("TestBlockValidity failed: %s", state.ToString()));
# # ]
425 [ # # ]: 0 : }
426 : 0 : }
427 : :
428 : 0 : std::shared_ptr<const CBlock> block_out;
429 : 0 : uint64_t max_tries{DEFAULT_MAX_TRIES};
430 : :
431 [ # # # # : 0 : if (!GenerateBlock(chainman, std::move(block), max_tries, block_out, process_new_block) || !block_out) {
# # ]
432 [ # # # # ]: 0 : throw JSONRPCError(RPC_MISC_ERROR, "Failed to make block.");
433 : : }
434 : :
435 : 0 : UniValue obj(UniValue::VOBJ);
436 [ # # # # : 0 : obj.pushKV("hash", block_out->GetHash().GetHex());
# # # # #
# ]
437 [ # # ]: 0 : if (!process_new_block) {
438 : 0 : DataStream block_ser;
439 [ # # ]: 0 : block_ser << TX_WITH_WITNESS(*block_out);
440 [ # # # # : 0 : obj.pushKV("hex", HexStr(block_ser));
# # # # #
# ]
441 : 0 : }
442 [ # # ]: 0 : return obj;
443 [ - - ]: 666 : },
444 [ + - + - : 3900 : };
+ - + + +
+ - - -
- ]
445 [ + - + - : 4680 : }
+ - + - +
- + - - -
- - ]
446 : :
447 : 68 : static RPCMethod getmininginfo()
448 : : {
449 : 68 : return RPCMethod{
450 : 68 : "getmininginfo",
451 [ + - ]: 136 : "Returns a json object containing mining-related information.",
452 : : {},
453 [ + - ]: 136 : RPCResult{
454 [ + - ]: 136 : RPCResult::Type::OBJ, "", "",
455 : : {
456 [ + - + - ]: 136 : {RPCResult::Type::NUM, "blocks", "The current block"},
457 [ + - + - ]: 136 : {RPCResult::Type::NUM, "currentblockweight", /*optional=*/true, "The block weight (including reserved weight for block header, txs count and coinbase tx) of the last assembled block (only present if a block was ever assembled)"},
458 [ + - + - ]: 136 : {RPCResult::Type::NUM, "currentblocktx", /*optional=*/true, "The number of block transactions (excluding coinbase) of the last assembled block (only present if a block was ever assembled)"},
459 [ + - + - ]: 136 : {RPCResult::Type::STR_HEX, "bits", "The current nBits, compact representation of the block difficulty target"},
460 [ + - + - ]: 136 : {RPCResult::Type::NUM, "difficulty", "The current difficulty"},
461 [ + - + - ]: 136 : {RPCResult::Type::STR_HEX, "target", "The current target"},
462 [ + - + - ]: 136 : {RPCResult::Type::NUM, "networkhashps", "The network hashes per second"},
463 [ + - + - ]: 136 : {RPCResult::Type::NUM, "pooledtx", "The size of the mempool"},
464 [ + - + - ]: 136 : {RPCResult::Type::STR_AMOUNT, "blockmintxfee", "Minimum feerate of packages selected for block inclusion in " + CURRENCY_UNIT + "/kvB"},
465 [ + - + - ]: 136 : {RPCResult::Type::STR, "chain", "current network name (" LIST_CHAIN_NAMES ")"},
466 [ + - + - ]: 136 : {RPCResult::Type::STR_HEX, "signet_challenge", /*optional=*/true, "The block challenge (aka. block script), in hexadecimal (only present if the current network is a signet)"},
467 [ + - + - ]: 136 : {RPCResult::Type::OBJ, "next", "The next block",
468 : : {
469 [ + - + - ]: 136 : {RPCResult::Type::NUM, "height", "The next height"},
470 [ + - + - ]: 136 : {RPCResult::Type::STR_HEX, "bits", "The next target nBits"},
471 [ + - + - ]: 136 : {RPCResult::Type::NUM, "difficulty", "The next difficulty"},
472 [ + - + - ]: 136 : {RPCResult::Type::STR_HEX, "target", "The next target"}
473 : : }},
474 [ + - + - : 136 : (IsDeprecatedRPCEnabled("warnings") ?
- + ]
475 [ - - - - : 68 : RPCResult{RPCResult::Type::STR, "warnings", "any network and blockchain warnings (DEPRECATED)"} :
- + - + -
+ - - - -
- - ]
476 [ + - + - : 272 : RPCResult{RPCResult::Type::ARR, "warnings", "any network and blockchain warnings (run with `-deprecatedrpc=warnings` to return the latest warning as a single string)",
+ - + - -
- - - ]
477 : : {
478 [ + - + - : 272 : {RPCResult::Type::STR, "", "warning"},
+ - + - -
- - - ]
479 : : }
480 [ + - + - : 340 : }
+ - + + +
- - - - -
- - - - ]
481 : : ),
482 [ + - + - : 2448 : }},
+ - + + +
+ - - -
- ]
483 : 68 : RPCExamples{
484 [ + - + - : 136 : HelpExampleCli("getmininginfo", "")
+ - ]
485 [ + - + - : 272 : + HelpExampleRpc("getmininginfo", "")
+ - + - ]
486 [ + - ]: 68 : },
487 : 68 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
488 : : {
489 : 4 : NodeContext& node = EnsureAnyNodeContext(request.context);
490 : 4 : const CTxMemPool& mempool = EnsureMemPool(node);
491 : 4 : ChainstateManager& chainman = EnsureChainman(node);
492 : 4 : LOCK(cs_main);
493 [ + - ]: 4 : const CChain& active_chain = chainman.ActiveChain();
494 [ - + + - ]: 8 : CBlockIndex& tip{*CHECK_NONFATAL(active_chain.Tip())};
495 : :
496 : 4 : UniValue obj(UniValue::VOBJ);
497 [ - + + - : 8 : obj.pushKV("blocks", active_chain.Height());
+ - + - ]
498 [ - + - - : 4 : if (BlockAssembler::m_last_block_weight) obj.pushKV("currentblockweight", *BlockAssembler::m_last_block_weight);
- - - - ]
499 [ - + - - : 4 : if (BlockAssembler::m_last_block_num_txs) obj.pushKV("currentblocktx", *BlockAssembler::m_last_block_num_txs);
- - - - ]
500 [ + - + - : 8 : obj.pushKV("bits", strprintf("%08x", tip.nBits));
+ - + - ]
501 [ + - + - : 8 : obj.pushKV("difficulty", GetDifficulty(tip));
+ - + - ]
502 [ + - + - : 8 : obj.pushKV("target", GetTarget(tip, chainman.GetConsensus().powLimit).GetHex());
+ - + - +
- ]
503 [ + - + - : 8 : obj.pushKV("networkhashps", getnetworkhashps().HandleRequest(request));
+ - + - ]
504 [ + - + - : 8 : obj.pushKV("pooledtx", mempool.size());
+ - + - ]
505 [ + - ]: 4 : const auto mining_options{node::FlattenMiningOptions(node.mining_args)};
506 [ + - + - : 8 : obj.pushKV("blockmintxfee", ValueFromAmount(CHECK_NONFATAL(mining_options.block_min_fee_rate)->GetFeePerK()));
+ - + - ]
507 [ + - + - : 8 : obj.pushKV("chain", chainman.GetParams().GetChainTypeString());
+ - + - ]
508 : :
509 : 4 : UniValue next(UniValue::VOBJ);
510 : 4 : CBlockIndex next_index;
511 [ + - ]: 4 : NextEmptyBlockIndex(tip, chainman.GetConsensus(), next_index);
512 : :
513 [ + - + - : 8 : next.pushKV("height", next_index.nHeight);
+ - ]
514 [ + - + - : 8 : next.pushKV("bits", strprintf("%08x", next_index.nBits));
+ - + - ]
515 [ + - + - : 8 : next.pushKV("difficulty", GetDifficulty(next_index));
+ - + - ]
516 [ + - + - : 8 : next.pushKV("target", GetTarget(next_index, chainman.GetConsensus().powLimit).GetHex());
+ - + - +
- ]
517 [ + - + - : 8 : obj.pushKV("next", next);
+ - ]
518 : :
519 [ - + ]: 4 : if (chainman.GetParams().GetChainType() == ChainType::SIGNET) {
520 [ # # ]: 0 : const std::vector<uint8_t>& signet_challenge =
521 : 0 : chainman.GetConsensus().signet_challenge;
522 [ # # # # : 0 : obj.pushKV("signet_challenge", HexStr(signet_challenge));
# # # # #
# ]
523 : : }
524 [ + - + - : 8 : obj.pushKV("warnings", node::GetWarningsForRpc(*CHECK_NONFATAL(node.warnings), IsDeprecatedRPCEnabled("warnings")));
+ - + - +
- + - ]
525 : 8 : return obj;
526 [ + - ]: 8 : },
527 [ + - + - ]: 272 : };
528 [ + - + - : 2652 : }
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - - -
+ - + - +
- + - - +
- - - - -
- - - -
- ]
529 : :
530 : :
531 : : // NOTE: Unlike wallet RPC (which use BTC values), mining RPCs follow GBT (BIP 22) in using satoshi amounts
532 : 115 : static RPCMethod prioritisetransaction()
533 : : {
534 : 115 : return RPCMethod{"prioritisetransaction",
535 [ + - ]: 230 : "Accepts the transaction into mined blocks at a higher (or lower) priority\n",
536 : : {
537 [ + - + - ]: 230 : {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The transaction id."},
538 [ + - + - ]: 230 : {"dummy", RPCArg::Type::NUM, RPCArg::Optional::OMITTED, "API-Compatibility for previous API. Must be zero or null.\n"
539 : : " DEPRECATED. For forward compatibility use named arguments and omit this parameter."},
540 [ + - + - ]: 230 : {"fee_delta", RPCArg::Type::NUM, RPCArg::Optional::NO, "The fee value (in satoshis) to add (or subtract, if negative).\n"
541 : : " Note, that this value is not a fee rate. It is a value to modify absolute fee of the TX.\n"
542 : : " The fee is not actually paid, only the algorithm for selecting transactions into a block\n"
543 : : " considers the transaction as it would have paid a higher (or lower) fee."},
544 : : },
545 [ + - ]: 230 : RPCResult{
546 [ + - + - : 230 : RPCResult::Type::BOOL, "", "Returns true"},
+ - ]
547 : 115 : RPCExamples{
548 [ + - + - : 230 : HelpExampleCli("prioritisetransaction", "\"txid\" 0.0 10000")
+ - ]
549 [ + - + - : 460 : + HelpExampleRpc("prioritisetransaction", "\"txid\", 0.0, 10000")
+ - + - ]
550 [ + - ]: 115 : },
551 : 115 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
552 : : {
553 : 57 : LOCK(cs_main);
554 : :
555 [ + - + + ]: 57 : auto txid{Txid::FromUint256(ParseHashV(request.params[0], "txid"))};
556 [ + + ]: 56 : const auto dummy{self.MaybeArg<double>("dummy")};
557 [ + - + + ]: 55 : CAmount nAmount = request.params[2].getInt<int64_t>();
558 : :
559 [ + + + + ]: 54 : if (dummy && *dummy != 0) {
560 [ + - + - ]: 4 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Priority is no longer supported, dummy argument to prioritisetransaction must be 0.");
561 : : }
562 : :
563 [ + - ]: 52 : CTxMemPool& mempool = EnsureAnyMemPool(request.context);
564 : :
565 : : // Non-0 fee dust transactions are not allowed for entry, and modification not allowed afterwards
566 [ + - ]: 52 : const auto& tx = mempool.get(txid);
567 [ + - - + : 52 : if (mempool.m_opts.require_standard && tx && !GetDust(*tx, mempool.m_opts.dust_relay_feerate).empty()) {
- - - - -
+ ]
568 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Priority is not supported for transactions with dust outputs.");
569 : : }
570 : :
571 [ + - ]: 52 : mempool.PrioritiseTransaction(txid, nAmount);
572 [ + - ]: 52 : return true;
573 [ + - ]: 104 : },
574 [ + - + - : 805 : };
+ + - - ]
575 [ + - + - : 690 : }
+ - - - ]
576 : :
577 : 116 : static RPCMethod getprioritisedtransactions()
578 : : {
579 : 116 : return RPCMethod{"getprioritisedtransactions",
580 [ + - ]: 232 : "Returns a map of all user-created (see prioritisetransaction) fee deltas by txid, and whether the tx is present in mempool.",
581 : : {},
582 [ + - ]: 232 : RPCResult{
583 [ + - ]: 232 : RPCResult::Type::OBJ_DYN, "", "prioritisation keyed by txid",
584 : : {
585 [ + - + - ]: 232 : {RPCResult::Type::OBJ, "<transactionid>", "", {
586 [ + - + - ]: 232 : {RPCResult::Type::NUM, "fee_delta", "transaction fee delta in satoshis"},
587 [ + - + - ]: 232 : {RPCResult::Type::BOOL, "in_mempool", "whether this transaction is currently in mempool"},
588 [ + - + - ]: 232 : {RPCResult::Type::NUM, "modified_fee", /*optional=*/true, "modified fee in satoshis. Only returned if in_mempool=true"},
589 : : }}
590 : : },
591 [ + - + - : 1276 : },
+ - + + +
+ - - -
- ]
592 : 116 : RPCExamples{
593 [ + - + - : 232 : HelpExampleCli("getprioritisedtransactions", "")
+ - ]
594 [ + - + - : 464 : + HelpExampleRpc("getprioritisedtransactions", "")
+ - + - ]
595 [ + - ]: 116 : },
596 : 116 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
597 : : {
598 : 31 : NodeContext& node = EnsureAnyNodeContext(request.context);
599 : 31 : CTxMemPool& mempool = EnsureMemPool(node);
600 : 31 : UniValue rpc_result{UniValue::VOBJ};
601 [ + - + + ]: 317 : for (const auto& delta_info : mempool.GetPrioritisedTransactions()) {
602 : 286 : UniValue result_inner{UniValue::VOBJ};
603 [ + - + - : 572 : result_inner.pushKV("fee_delta", delta_info.delta);
+ - ]
604 [ + - + - : 572 : result_inner.pushKV("in_mempool", delta_info.in_mempool);
+ - ]
605 [ - + ]: 286 : if (delta_info.in_mempool) {
606 [ # # # # : 0 : result_inner.pushKV("modified_fee", *delta_info.modified_fee);
# # ]
607 : : }
608 [ + - + - ]: 572 : rpc_result.pushKV(delta_info.txid.GetHex(), std::move(result_inner));
609 : 286 : }
610 : 31 : return rpc_result;
611 : 0 : },
612 [ + - + - ]: 464 : };
613 [ + - + - : 928 : }
+ - + - -
- ]
614 : :
615 : :
616 : : // NOTE: Assumes a conclusive result; if result is inconclusive, it must be handled by caller
617 : 80 : static UniValue BIP22ValidationResult(const BlockValidationState& state)
618 : : {
619 [ - + ]: 80 : if (state.IsValid())
620 : 0 : return UniValue::VNULL;
621 : :
622 [ - + ]: 80 : if (state.IsError())
623 [ # # # # ]: 0 : throw JSONRPCError(RPC_VERIFY_ERROR, state.ToString());
624 [ + - ]: 80 : if (state.IsInvalid())
625 : : {
626 [ - + ]: 80 : std::string strRejectReason = state.GetRejectReason();
627 [ - + ]: 80 : if (strRejectReason.empty())
628 [ # # ]: 0 : return "rejected";
629 [ + - ]: 80 : return strRejectReason;
630 : 80 : }
631 : : // Should be impossible
632 : 0 : return "valid?";
633 : : }
634 : :
635 : : // Prefix rule name with ! if not optional, see BIP9
636 : 0 : static std::string gbt_rule_value(const std::string& name, bool gbt_optional_rule)
637 : : {
638 [ # # ]: 0 : std::string s{name};
639 [ # # ]: 0 : if (!gbt_optional_rule) {
640 [ # # ]: 0 : s.insert(s.begin(), '!');
641 : : }
642 : 0 : return s;
643 : 0 : }
644 : :
645 : 64 : static RPCMethod getblocktemplate()
646 : : {
647 : 64 : return RPCMethod{
648 : 64 : "getblocktemplate",
649 [ + - ]: 128 : "If the request parameters include a 'mode' key, that is used to explicitly select between the default 'template' request or a 'proposal'.\n"
650 : : "It returns data needed to construct a block to work on.\n"
651 : : "For full specification, see BIPs 22, 23, 9, and 145:\n"
652 : : " https://github.com/bitcoin/bips/blob/master/bip-0022.mediawiki\n"
653 : : " https://github.com/bitcoin/bips/blob/master/bip-0023.mediawiki\n"
654 : : " https://github.com/bitcoin/bips/blob/master/bip-0009.mediawiki#getblocktemplate_changes\n"
655 : : " https://github.com/bitcoin/bips/blob/master/bip-0145.mediawiki\n",
656 : : {
657 [ + - + - ]: 128 : {"template_request", RPCArg::Type::OBJ, RPCArg::Optional::NO, "Format of the template",
658 : : {
659 [ + - + - ]: 128 : {"mode", RPCArg::Type::STR, /* treat as named arg */ RPCArg::Optional::OMITTED, "This must be set to \"template\", \"proposal\" (see BIP 23), or omitted"},
660 [ + - + - ]: 128 : {"capabilities", RPCArg::Type::ARR, /* treat as named arg */ RPCArg::Optional::OMITTED, "A list of strings",
661 : : {
662 [ + - + - ]: 128 : {"str", RPCArg::Type::STR, RPCArg::Optional::OMITTED, "client side supported feature, 'longpoll', 'coinbasevalue', 'proposal', 'serverlist', 'workid'"},
663 : : }},
664 [ + - + - ]: 128 : {"rules", RPCArg::Type::ARR, RPCArg::Optional::NO, "A list of strings",
665 : : {
666 [ + - + - ]: 128 : {"segwit", RPCArg::Type::STR, RPCArg::Optional::NO, "(literal) indicates client side segwit support"},
667 [ + - + - ]: 128 : {"str", RPCArg::Type::STR, RPCArg::Optional::OMITTED, "other client side supported softfork deployment"},
668 : : }},
669 [ + - + - ]: 128 : {"longpollid", RPCArg::Type::STR, RPCArg::Optional::OMITTED, "delay processing request until the result would vary significantly from the \"longpollid\" of a prior template"},
670 [ + - + - ]: 128 : {"data", RPCArg::Type::STR_HEX, RPCArg::Optional::OMITTED, "proposed block data to check, encoded in hexadecimal; valid only for mode=\"proposal\""},
671 : : },
672 : : },
673 : : },
674 : : {
675 [ + - + - : 128 : RPCResult{"If the proposal was accepted with mode=='proposal'", RPCResult::Type::NONE, "", ""},
+ - ]
676 [ + - + - : 128 : RPCResult{"If the proposal was not accepted with mode=='proposal'", RPCResult::Type::STR, "", "According to BIP22"},
+ - ]
677 [ + - + - : 128 : RPCResult{"Otherwise", RPCResult::Type::OBJ, "", "",
+ - ]
678 : : {
679 [ + - + - ]: 128 : {RPCResult::Type::NUM, "version", "The preferred block version"},
680 [ + - + - ]: 128 : {RPCResult::Type::ARR, "rules", "specific block rules that are to be enforced",
681 : : {
682 [ + - + - ]: 128 : {RPCResult::Type::STR, "", "name of a rule the client must understand to some extent; see BIP 9 for format"},
683 : : }},
684 [ + - + - ]: 128 : {RPCResult::Type::OBJ_DYN, "vbavailable", "set of pending, supported versionbit (BIP 9) softfork deployments",
685 : : {
686 [ + - + - ]: 128 : {RPCResult::Type::NUM, "rulename", "identifies the bit number as indicating acceptance and readiness for the named softfork rule"},
687 : : }},
688 [ + - + - ]: 128 : {RPCResult::Type::ARR, "capabilities", "",
689 : : {
690 [ + - + - ]: 128 : {RPCResult::Type::STR, "value", "A supported feature, for example 'proposal'"},
691 : : }},
692 [ + - + - ]: 128 : {RPCResult::Type::NUM, "vbrequired", "bit mask of versionbits the server requires set in submissions"},
693 [ + - + - ]: 128 : {RPCResult::Type::STR, "previousblockhash", "The hash of current highest block"},
694 [ + - + - ]: 128 : {RPCResult::Type::ARR, "transactions", "contents of non-coinbase transactions that should be included in the next block",
695 : : {
696 [ + - + - ]: 128 : {RPCResult::Type::OBJ, "", "",
697 : : {
698 [ + - + - ]: 128 : {RPCResult::Type::STR_HEX, "data", "transaction data encoded in hexadecimal (byte-for-byte)"},
699 [ + - + - ]: 128 : {RPCResult::Type::STR_HEX, "txid", "transaction hash excluding witness data, shown in byte-reversed hex"},
700 [ + - + - ]: 128 : {RPCResult::Type::STR_HEX, "hash", "transaction hash including witness data, shown in byte-reversed hex"},
701 [ + - + - ]: 128 : {RPCResult::Type::ARR, "depends", "array of numbers",
702 : : {
703 [ + - + - ]: 128 : {RPCResult::Type::NUM, "", "transactions before this one (by 1-based index in 'transactions' list) that must be present in the final block if this one is"},
704 : : }},
705 [ + - + - ]: 128 : {RPCResult::Type::NUM, "fee", "difference in value between transaction inputs and outputs (in satoshis); for coinbase transactions, this is a negative Number of the total collected block fees (ie, not including the block subsidy); if key is not present, fee is unknown and clients MUST NOT assume there isn't one"},
706 [ + - + - ]: 128 : {RPCResult::Type::NUM, "sigops", "total SigOps cost, as counted for purposes of block limits; if key is not present, sigop cost is unknown and clients MUST NOT assume it is zero"},
707 [ + - + - ]: 128 : {RPCResult::Type::NUM, "weight", "total transaction weight, as counted for purposes of block limits"},
708 : : }},
709 : : }},
710 [ + - + - ]: 128 : {RPCResult::Type::OBJ_DYN, "coinbaseaux", "data that should be included in the coinbase's scriptSig content",
711 : : {
712 [ + - + - ]: 128 : {RPCResult::Type::STR_HEX, "key", "values must be in the coinbase (keys may be ignored)"},
713 : : }},
714 [ + - + - ]: 128 : {RPCResult::Type::NUM, "coinbasevalue", "maximum allowable input to coinbase transaction, including the generation award and transaction fees (in satoshis)"},
715 [ + - + - ]: 128 : {RPCResult::Type::STR, "longpollid", "an id to include with a request to longpoll on an update to this template"},
716 [ + - + - ]: 128 : {RPCResult::Type::STR, "target", "The hash target"},
717 [ + - + - ]: 128 : {RPCResult::Type::NUM_TIME, "mintime", "The minimum timestamp appropriate for the next block time, expressed in " + UNIX_EPOCH_TIME + ". Adjusted for the proposed BIP94 timewarp rule."},
718 [ + - + - ]: 128 : {RPCResult::Type::ARR, "mutable", "list of ways the block template may be changed",
719 : : {
720 [ + - + - ]: 128 : {RPCResult::Type::STR, "value", "A way the block template may be changed, e.g. 'time', 'transactions', 'prevblock'"},
721 : : }},
722 [ + - + - ]: 128 : {RPCResult::Type::STR_HEX, "noncerange", "A range of valid nonces"},
723 [ + - + - ]: 128 : {RPCResult::Type::NUM, "sigoplimit", "limit of sigops in blocks"},
724 [ + - + - ]: 128 : {RPCResult::Type::NUM, "sizelimit", "limit of block size"},
725 [ + - + - ]: 128 : {RPCResult::Type::NUM, "weightlimit", /*optional=*/true, "limit of block weight"},
726 [ + - + - ]: 128 : {RPCResult::Type::NUM_TIME, "curtime", "current timestamp in " + UNIX_EPOCH_TIME + ". Adjusted for the proposed BIP94 timewarp rule."},
727 [ + - + - ]: 128 : {RPCResult::Type::STR, "bits", "compressed target of next block"},
728 [ + - + - ]: 128 : {RPCResult::Type::NUM, "height", "The height of the next block"},
729 [ + - + - ]: 128 : {RPCResult::Type::STR_HEX, "signet_challenge", /*optional=*/true, "Only on signet"},
730 [ + - + - ]: 128 : {RPCResult::Type::STR_HEX, "default_witness_commitment", /*optional=*/true, "a valid witness commitment for the unmodified block template"},
731 [ + - + - : 5248 : }},
+ - + - +
- + - + -
+ - + - +
+ + + + +
+ + + + +
+ + + + +
+ + - - -
- - - - -
- - - - -
- - - -
- ]
732 : : },
733 : 64 : RPCExamples{
734 [ + - + - : 128 : HelpExampleCli("getblocktemplate", "'{\"rules\": [\"segwit\"]}'")
+ - ]
735 [ + - + - : 256 : + HelpExampleRpc("getblocktemplate", "{\"rules\": [\"segwit\"]}")
+ - ]
736 [ + - ]: 64 : },
737 : 64 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
738 : : {
739 : 1 : NodeContext& node = EnsureAnyNodeContext(request.context);
740 : 1 : ChainstateManager& chainman = EnsureChainman(node);
741 : 1 : Mining& miner = EnsureMining(node);
742 : :
743 : 0 : std::string strMode = "template";
744 [ # # ]: 0 : UniValue lpval = NullUniValue;
745 [ # # ]: 0 : std::set<std::string> setClientRules;
746 [ # # # # ]: 0 : if (!request.params[0].isNull())
747 : : {
748 [ # # # # ]: 0 : const UniValue& oparam = request.params[0].get_obj();
749 [ # # ]: 0 : const UniValue& modeval = oparam.find_value("mode");
750 [ # # ]: 0 : if (modeval.isStr())
751 [ # # # # ]: 0 : strMode = modeval.get_str();
752 [ # # ]: 0 : else if (modeval.isNull())
753 : : {
754 : : /* Do nothing */
755 : : }
756 : : else
757 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid mode");
758 [ # # # # ]: 0 : lpval = oparam.find_value("longpollid");
759 : :
760 [ # # ]: 0 : if (strMode == "proposal")
761 : : {
762 [ # # ]: 0 : const UniValue& dataval = oparam.find_value("data");
763 [ # # ]: 0 : if (!dataval.isStr())
764 [ # # # # ]: 0 : throw JSONRPCError(RPC_TYPE_ERROR, "Missing data String key for proposal");
765 : :
766 : 0 : CBlock block;
767 [ # # # # : 0 : if (!DecodeHexBlk(block, dataval.get_str()))
# # ]
768 [ # # # # ]: 0 : throw JSONRPCError(RPC_DESERIALIZATION_ERROR, "Block decode failed");
769 : :
770 [ # # ]: 0 : uint256 hash = block.GetHash();
771 [ # # ]: 0 : LOCK(cs_main);
772 [ # # ]: 0 : const CBlockIndex* pindex = chainman.m_blockman.LookupBlockIndex(hash);
773 [ # # ]: 0 : if (pindex) {
774 [ # # # # ]: 0 : if (pindex->IsValid(BLOCK_VALID_SCRIPTS))
775 [ # # ]: 0 : return "duplicate";
776 [ # # ]: 0 : if (pindex->nStatus & BLOCK_FAILED_VALID)
777 [ # # ]: 0 : return "duplicate-invalid";
778 [ # # ]: 0 : return "duplicate-inconclusive";
779 : : }
780 : :
781 [ # # # # : 0 : return BIP22ValidationResult(TestBlockValidity(chainman.ActiveChainstate(), block, /*check_pow=*/false, /*check_merkle_root=*/true));
# # ]
782 : 0 : }
783 : :
784 [ # # ]: 0 : const UniValue& aClientRules = oparam.find_value("rules");
785 [ # # ]: 0 : if (aClientRules.isArray()) {
786 [ # # # # ]: 0 : for (unsigned int i = 0; i < aClientRules.size(); ++i) {
787 [ # # ]: 0 : const UniValue& v = aClientRules[i];
788 [ # # # # ]: 0 : setClientRules.insert(v.get_str());
789 : : }
790 : : }
791 : : }
792 : :
793 [ # # ]: 0 : if (strMode != "template")
794 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid mode");
795 : :
796 [ # # # # ]: 0 : if (!miner.isTestChain()) {
797 [ # # ]: 0 : const CConnman& connman = EnsureConnman(node);
798 [ # # # # ]: 0 : if (connman.GetNodeCount(ConnectionDirection::Both) == 0) {
799 [ # # # # ]: 0 : throw JSONRPCError(RPC_CLIENT_NOT_CONNECTED, CLIENT_NAME " is not connected!");
800 : : }
801 : :
802 [ # # # # ]: 0 : if (miner.isInitialBlockDownload()) {
803 [ # # # # ]: 0 : throw JSONRPCError(RPC_CLIENT_IN_INITIAL_DOWNLOAD, CLIENT_NAME " is in initial sync and waiting for blocks...");
804 : : }
805 : : }
806 : :
807 : 0 : static unsigned int nTransactionsUpdatedLast;
808 [ # # ]: 0 : const CTxMemPool& mempool = EnsureMemPool(node);
809 : :
810 [ # # ]: 0 : WAIT_LOCK(cs_main, cs_main_lock);
811 [ # # # # : 0 : uint256 tip{CHECK_NONFATAL(miner.getTip()).value().hash};
# # ]
812 : :
813 : : // Long Polling (BIP22)
814 [ # # ]: 0 : if (!lpval.isNull()) {
815 : : /**
816 : : * Wait to respond until either the best block changes, OR there are more
817 : : * transactions.
818 : : *
819 : : * The check for new transactions first happens after 1 minute and
820 : : * subsequently every 10 seconds. BIP22 does not require this particular interval.
821 : : * On mainnet the mempool changes frequently enough that in practice this RPC
822 : : * returns after 60 seconds, or sooner if the best block changes.
823 : : *
824 : : * getblocktemplate is unlikely to be called by bitcoin-cli, so
825 : : * -rpcclienttimeout is not a concern. BIP22 recommends a long request timeout.
826 : : *
827 : : * The longpollid is assumed to be a tip hash if it has the right format.
828 : : */
829 : 0 : uint256 hashWatchedChain;
830 : 0 : unsigned int nTransactionsUpdatedLastLP;
831 : :
832 [ # # ]: 0 : if (lpval.isStr())
833 : : {
834 : : // Format: <hashBestChain><nTransactionsUpdatedLast>
835 [ # # ]: 0 : const std::string& lpstr = lpval.get_str();
836 : :
837 : : // Assume the longpollid is a block hash. If it's not then we return
838 : : // early below.
839 [ # # # # : 0 : hashWatchedChain = ParseHashV(lpstr.substr(0, 64), "longpollid");
# # ]
840 [ # # # # ]: 0 : nTransactionsUpdatedLastLP = LocaleIndependentAtoi<int64_t>(lpstr.substr(64));
841 : : }
842 : : else
843 : : {
844 : : // NOTE: Spec does not specify behaviour for non-string longpollid, but this makes testing easier
845 : 0 : hashWatchedChain = tip;
846 : 0 : nTransactionsUpdatedLastLP = nTransactionsUpdatedLast;
847 : : }
848 : :
849 : : // Release lock while waiting
850 : 0 : {
851 [ # # ]: 0 : REVERSE_LOCK(cs_main_lock, cs_main);
852 : 0 : MillisecondsDouble checktxtime{std::chrono::minutes(1)};
853 [ # # # # ]: 0 : while (IsRPCRunning()) {
854 : : // If hashWatchedChain is not a real block hash, this will
855 : : // return immediately.
856 [ # # ]: 0 : std::optional<BlockRef> maybe_tip{miner.waitTipChanged(hashWatchedChain, checktxtime)};
857 : : // Node is shutting down
858 [ # # ]: 0 : if (!maybe_tip) break;
859 [ # # ]: 0 : tip = maybe_tip->hash;
860 [ # # ]: 0 : if (tip != hashWatchedChain) break;
861 : :
862 : : // Check transactions for update without holding the mempool
863 : : // lock to avoid deadlocks.
864 [ # # # # ]: 0 : if (mempool.GetTransactionsUpdated() != nTransactionsUpdatedLastLP) {
865 : : break;
866 : : }
867 : 0 : checktxtime = std::chrono::seconds(10);
868 : : }
869 : 0 : }
870 [ # # # # : 0 : tip = CHECK_NONFATAL(miner.getTip()).value().hash;
# # ]
871 : :
872 [ # # # # ]: 0 : if (!IsRPCRunning())
873 [ # # # # ]: 0 : throw JSONRPCError(RPC_CLIENT_NOT_CONNECTED, "Shutting down");
874 : : // TODO: Maybe recheck connections/IBD and (if something wrong) send an expires-immediately template to stop miners?
875 : : }
876 : :
877 [ # # ]: 0 : const Consensus::Params& consensusParams = chainman.GetParams().GetConsensus();
878 : :
879 : : // GBT must be called with 'signet' set in the rules for signet chains
880 [ # # # # : 0 : if (consensusParams.signet_blocks && !setClientRules.contains("signet")) {
# # # # ]
881 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "getblocktemplate must be called with the signet rule set (call with {\"rules\": [\"segwit\", \"signet\"]})");
882 : : }
883 : :
884 : : // GBT must be called with 'segwit' set in the rules
885 [ # # # # ]: 0 : if (!setClientRules.contains("segwit")) {
886 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "getblocktemplate must be called with the segwit rule set (call with {\"rules\": [\"segwit\"]})");
887 : : }
888 : :
889 : : // Update block
890 : 0 : static CBlockIndex* pindexPrev;
891 : 0 : static int64_t time_start;
892 [ - - - - ]: 27 : static std::unique_ptr<BlockTemplate> block_template;
893 [ # # # # ]: 0 : if (!pindexPrev || pindexPrev->GetBlockHash() != tip ||
894 [ # # # # : 0 : (mempool.GetTransactionsUpdated() != nTransactionsUpdatedLast && GetTime() - time_start > 5))
# # # # ]
895 : : {
896 : : // Clear pindexPrev so future calls make a new block, despite any failures from here on
897 : 0 : pindexPrev = nullptr;
898 : :
899 : : // Store the pindexBest used before createNewBlock, to avoid races
900 [ # # ]: 0 : nTransactionsUpdatedLast = mempool.GetTransactionsUpdated();
901 [ # # ]: 0 : CBlockIndex* pindexPrevNew = chainman.m_blockman.LookupBlockIndex(tip);
902 [ # # ]: 0 : time_start = GetTime();
903 : :
904 : : // Create new block. Opt-out of cooldown mechanism, because it would add
905 : : // a delay to each getblocktemplate call. This differs from typical
906 : : // long-lived IPC usage, where the overhead is paid only when creating
907 : : // the initial template.
908 : 0 : block_template = miner.createNewBlock({}, /*cooldown=*/false);
909 [ # # ]: 0 : CHECK_NONFATAL(block_template);
910 : :
911 : :
912 : : // Need to update only after we know createNewBlock succeeded
913 : 0 : pindexPrev = pindexPrevNew;
914 : : }
915 [ # # ]: 0 : CHECK_NONFATAL(pindexPrev);
916 [ # # ]: 0 : CBlock block{block_template->getBlock()};
917 : :
918 : : // Update nTime
919 [ # # ]: 0 : UpdateTime(&block, consensusParams, pindexPrev);
920 : 0 : block.nNonce = 0;
921 : :
922 : : // NOTE: If at some point we support pre-segwit miners post-segwit-activation, this needs to take segwit support into consideration
923 : 0 : const bool fPreSegWit = !DeploymentActiveAfter(pindexPrev, chainman, Consensus::DEPLOYMENT_SEGWIT);
924 : :
925 [ # # # # ]: 0 : UniValue aCaps(UniValue::VARR); aCaps.push_back("proposal");
926 : :
927 : 0 : UniValue transactions(UniValue::VARR);
928 [ # # ]: 0 : std::map<Txid, int64_t> setTxIndex;
929 [ # # ]: 0 : std::vector<CAmount> tx_fees{block_template->getTxFees()};
930 [ # # ]: 0 : std::vector<int64_t> tx_sigops{block_template->getTxSigops()};
931 : :
932 : 0 : int i = 0;
933 [ # # ]: 0 : for (const auto& it : block.vtx) {
934 [ # # ]: 0 : const CTransaction& tx = *it;
935 : 0 : Txid txHash = tx.GetHash();
936 [ # # ]: 0 : setTxIndex[txHash] = i++;
937 : :
938 [ # # ]: 0 : if (tx.IsCoinBase())
939 : 0 : continue;
940 : :
941 : 0 : UniValue entry(UniValue::VOBJ);
942 : :
943 [ # # # # : 0 : entry.pushKV("data", EncodeHexTx(tx));
# # # # ]
944 [ # # # # : 0 : entry.pushKV("txid", txHash.GetHex());
# # # # ]
945 [ # # # # : 0 : entry.pushKV("hash", tx.GetWitnessHash().GetHex());
# # # # ]
946 : :
947 : 0 : UniValue deps(UniValue::VARR);
948 [ # # ]: 0 : for (const CTxIn &in : tx.vin)
949 : : {
950 [ # # ]: 0 : if (setTxIndex.contains(in.prevout.hash))
951 [ # # # # : 0 : deps.push_back(setTxIndex[in.prevout.hash]);
# # ]
952 : : }
953 [ # # # # ]: 0 : entry.pushKV("depends", std::move(deps));
954 : :
955 : 0 : int index_in_template = i - 2;
956 [ # # # # : 0 : entry.pushKV("fee", tx_fees.at(index_in_template));
# # # # ]
957 [ # # ]: 0 : int64_t nTxSigOps{tx_sigops.at(index_in_template)};
958 [ # # ]: 0 : if (fPreSegWit) {
959 [ # # ]: 0 : CHECK_NONFATAL(nTxSigOps % WITNESS_SCALE_FACTOR == 0);
960 : 0 : nTxSigOps /= WITNESS_SCALE_FACTOR;
961 : : }
962 [ # # # # : 0 : entry.pushKV("sigops", nTxSigOps);
# # ]
963 [ # # # # : 0 : entry.pushKV("weight", GetTransactionWeight(tx));
# # ]
964 : :
965 [ # # ]: 0 : transactions.push_back(std::move(entry));
966 : 0 : }
967 : :
968 : 0 : UniValue aux(UniValue::VOBJ);
969 : :
970 [ # # ]: 0 : arith_uint256 hashTarget = arith_uint256().SetCompact(block.nBits);
971 : :
972 : 0 : UniValue aMutable(UniValue::VARR);
973 [ # # # # ]: 0 : aMutable.push_back("time");
974 [ # # # # ]: 0 : aMutable.push_back("transactions");
975 [ # # # # ]: 0 : aMutable.push_back("prevblock");
976 : :
977 : 0 : UniValue result(UniValue::VOBJ);
978 [ # # # # ]: 0 : result.pushKV("capabilities", std::move(aCaps));
979 : :
980 : 0 : UniValue aRules(UniValue::VARR);
981 : : // See getblocktemplate changes in BIP 9:
982 : : // ! indicates a more subtle change to the block structure or generation transaction
983 : : // Otherwise clients may assume the rule will not impact usage of the template as-is.
984 [ # # # # ]: 0 : aRules.push_back("csv");
985 [ # # ]: 0 : if (!fPreSegWit) {
986 [ # # # # ]: 0 : aRules.push_back("!segwit");
987 [ # # # # ]: 0 : aRules.push_back("taproot");
988 : : }
989 [ # # ]: 0 : if (consensusParams.signet_blocks) {
990 : : // indicate to miner that they must understand signet rules
991 : : // when attempting to mine with this template
992 [ # # # # ]: 0 : aRules.push_back("!signet");
993 : : }
994 : :
995 : 0 : UniValue vbavailable(UniValue::VOBJ);
996 [ # # ]: 0 : const auto gbtstatus = chainman.m_versionbitscache.GBTStatus(*pindexPrev, consensusParams);
997 : :
998 [ # # # # ]: 0 : for (const auto& [name, info] : gbtstatus.signalling) {
999 [ # # # # : 0 : vbavailable.pushKV(gbt_rule_value(name, info.gbt_optional_rule), info.bit);
# # ]
1000 [ # # # # ]: 0 : if (!info.gbt_optional_rule && !setClientRules.contains(name)) {
1001 : : // If the client doesn't support this, don't indicate it in the [default] version
1002 : 0 : block.nVersion &= ~info.mask;
1003 : : }
1004 : : }
1005 : :
1006 [ # # # # ]: 0 : for (const auto& [name, info] : gbtstatus.locked_in) {
1007 : 0 : block.nVersion |= info.mask;
1008 [ # # # # : 0 : vbavailable.pushKV(gbt_rule_value(name, info.gbt_optional_rule), info.bit);
# # ]
1009 [ # # # # ]: 0 : if (!info.gbt_optional_rule && !setClientRules.contains(name)) {
1010 : : // If the client doesn't support this, don't indicate it in the [default] version
1011 : 0 : block.nVersion &= ~info.mask;
1012 : : }
1013 : : }
1014 : :
1015 [ # # # # ]: 0 : for (const auto& [name, info] : gbtstatus.active) {
1016 [ # # # # : 0 : aRules.push_back(gbt_rule_value(name, info.gbt_optional_rule));
# # ]
1017 [ # # # # ]: 0 : if (!info.gbt_optional_rule && !setClientRules.contains(name)) {
1018 : : // Not supported by the client; make sure it's safe to proceed
1019 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Support for '%s' rule requires explicit client support", name));
1020 : : }
1021 : : }
1022 : :
1023 [ # # # # : 0 : result.pushKV("version", block.nVersion);
# # ]
1024 [ # # # # ]: 0 : result.pushKV("rules", std::move(aRules));
1025 [ # # # # ]: 0 : result.pushKV("vbavailable", std::move(vbavailable));
1026 [ # # # # : 0 : result.pushKV("vbrequired", 0);
# # ]
1027 : :
1028 [ # # # # : 0 : result.pushKV("previousblockhash", block.hashPrevBlock.GetHex());
# # # # ]
1029 [ # # # # ]: 0 : result.pushKV("transactions", std::move(transactions));
1030 [ # # # # ]: 0 : result.pushKV("coinbaseaux", std::move(aux));
1031 [ # # # # : 0 : result.pushKV("coinbasevalue", block.vtx[0]->vout[0].nValue);
# # ]
1032 [ # # # # : 0 : result.pushKV("longpollid", tip.GetHex() + ToString(nTransactionsUpdatedLast));
# # # # #
# # # ]
1033 [ # # # # : 0 : result.pushKV("target", hashTarget.GetHex());
# # # # ]
1034 [ # # # # : 0 : result.pushKV("mintime", GetMinimumTime(pindexPrev, consensusParams.DifficultyAdjustmentInterval()));
# # # # ]
1035 [ # # # # ]: 0 : result.pushKV("mutable", std::move(aMutable));
1036 [ # # # # : 0 : result.pushKV("noncerange", "00000000ffffffff");
# # ]
1037 : 0 : int64_t nSigOpLimit = MAX_BLOCK_SIGOPS_COST;
1038 : 0 : int64_t nSizeLimit = MAX_BLOCK_SERIALIZED_SIZE;
1039 [ # # ]: 0 : if (fPreSegWit) {
1040 [ # # ]: 0 : CHECK_NONFATAL(nSigOpLimit % WITNESS_SCALE_FACTOR == 0);
1041 : 0 : nSigOpLimit /= WITNESS_SCALE_FACTOR;
1042 [ # # ]: 0 : CHECK_NONFATAL(nSizeLimit % WITNESS_SCALE_FACTOR == 0);
1043 : 0 : nSizeLimit /= WITNESS_SCALE_FACTOR;
1044 : : }
1045 [ # # # # : 0 : result.pushKV("sigoplimit", nSigOpLimit);
# # ]
1046 [ # # # # : 0 : result.pushKV("sizelimit", nSizeLimit);
# # ]
1047 [ # # ]: 0 : if (!fPreSegWit) {
1048 [ # # # # : 0 : result.pushKV("weightlimit", MAX_BLOCK_WEIGHT);
# # ]
1049 : : }
1050 [ # # # # : 0 : result.pushKV("curtime", block.GetBlockTime());
# # ]
1051 [ # # # # : 0 : result.pushKV("bits", strprintf("%08x", block.nBits));
# # # # ]
1052 [ # # # # : 0 : result.pushKV("height", pindexPrev->nHeight + 1);
# # ]
1053 : :
1054 [ # # ]: 0 : if (consensusParams.signet_blocks) {
1055 [ # # # # : 0 : result.pushKV("signet_challenge", HexStr(consensusParams.signet_challenge));
# # # # #
# ]
1056 : : }
1057 : :
1058 [ # # # # ]: 0 : if (auto coinbase{block_template->getCoinbaseTx()}; coinbase.required_outputs.size() > 0) {
1059 [ # # ]: 0 : CHECK_NONFATAL(coinbase.required_outputs.size() == 1); // Only one output is currently expected
1060 [ # # # # : 0 : result.pushKV("default_witness_commitment", HexStr(coinbase.required_outputs[0].scriptPubKey));
# # # # #
# ]
1061 : 0 : }
1062 : :
1063 : 0 : return result;
1064 [ # # # # : 0 : },
# # ]
1065 [ + - + - : 1600 : };
+ - + - +
- + - + -
+ + + + +
+ + + + +
- - - - -
- - - -
- ]
1066 [ + - + - : 6144 : }
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - - - -
- - - - -
- - ]
1067 : :
1068 : : class submitblock_StateCatcher final : public CValidationInterface
1069 : : {
1070 : : public:
1071 : : uint256 hash;
1072 : : bool found{false};
1073 : : BlockValidationState state;
1074 : :
1075 : 80 : explicit submitblock_StateCatcher(const uint256 &hashIn) : hash(hashIn), state() {}
1076 : :
1077 : : protected:
1078 : 80 : void BlockChecked(const std::shared_ptr<const CBlock>& block, const BlockValidationState& stateIn) override
1079 : : {
1080 [ + - ]: 80 : if (block->GetHash() != hash) return;
1081 : 80 : found = true;
1082 : 80 : state = stateIn;
1083 : : }
1084 : : };
1085 : :
1086 : 160 : static RPCMethod submitblock()
1087 : : {
1088 : : // We allow 2 arguments for compliance with BIP22. Argument 2 is ignored.
1089 : 160 : return RPCMethod{
1090 : 160 : "submitblock",
1091 [ + - ]: 320 : "Attempts to submit new block to network.\n"
1092 : : "See https://en.bitcoin.it/wiki/BIP_0022 for full specification.\n",
1093 : : {
1094 [ + - + - ]: 320 : {"hexdata", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "the hex-encoded block data to submit"},
1095 [ + - + - : 480 : {"dummy", RPCArg::Type::STR, RPCArg::DefaultHint{"ignored"}, "dummy value, for compatibility with BIP22. This value is ignored."},
+ - ]
1096 : : },
1097 : : {
1098 [ + - + - : 320 : RPCResult{"If the block was accepted", RPCResult::Type::NONE, "", ""},
+ - ]
1099 [ + - + - : 320 : RPCResult{"Otherwise", RPCResult::Type::STR, "", "According to BIP22"},
+ - ]
1100 : : },
1101 : 160 : RPCExamples{
1102 [ + - + - : 320 : HelpExampleCli("submitblock", "\"mydata\"")
+ - ]
1103 [ + - + - : 640 : + HelpExampleRpc("submitblock", "\"mydata\"")
+ - ]
1104 [ + - ]: 160 : },
1105 : 160 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
1106 : : {
1107 : 100 : std::shared_ptr<CBlock> blockptr = std::make_shared<CBlock>();
1108 [ + - ]: 100 : CBlock& block = *blockptr;
1109 [ + - + - : 100 : if (!DecodeHexBlk(block, request.params[0].get_str())) {
+ - + + ]
1110 [ + - + - ]: 40 : throw JSONRPCError(RPC_DESERIALIZATION_ERROR, "Block decode failed");
1111 : : }
1112 : :
1113 [ + - ]: 80 : ChainstateManager& chainman = EnsureAnyChainman(request.context);
1114 : 80 : {
1115 [ + - ]: 80 : LOCK(cs_main);
1116 [ + - ]: 80 : const CBlockIndex* pindex = chainman.m_blockman.LookupBlockIndex(block.hashPrevBlock);
1117 [ + + ]: 80 : if (pindex) {
1118 [ + - ]: 42 : chainman.UpdateUncommittedBlockStructures(block, pindex);
1119 : : }
1120 : 0 : }
1121 : :
1122 : 80 : bool new_block;
1123 [ + - ]: 80 : auto sc = std::make_shared<submitblock_StateCatcher>(block.GetHash());
1124 [ + - + - : 160 : CHECK_NONFATAL(chainman.m_options.signals)->RegisterSharedValidationInterface(sc);
+ - ]
1125 [ + - + - : 160 : bool accepted = chainman.ProcessNewBlock(blockptr, /*force_processing=*/true, /*min_pow_checked=*/true, /*new_block=*/&new_block);
+ - ]
1126 [ + - + - : 160 : CHECK_NONFATAL(chainman.m_options.signals)->UnregisterSharedValidationInterface(sc);
+ - ]
1127 [ + - - + ]: 80 : if (!new_block && accepted) {
1128 [ # # ]: 0 : return "duplicate";
1129 : : }
1130 [ - + ]: 80 : if (!sc->found) {
1131 [ # # ]: 0 : return "inconclusive";
1132 : : }
1133 [ + - ]: 80 : return BIP22ValidationResult(sc->state);
1134 [ + - ]: 160 : },
1135 [ + - + - : 1760 : };
+ - + - +
+ + + - -
- - ]
1136 [ + - + - : 1280 : }
+ - + - -
- - - ]
1137 : :
1138 : 237 : static RPCMethod submitheader()
1139 : : {
1140 : 237 : return RPCMethod{
1141 : 237 : "submitheader",
1142 [ + - ]: 474 : "Decode the given hexdata as a header and submit it as a candidate chain tip if valid."
1143 : : "\nThrows when the header is invalid.\n",
1144 : : {
1145 [ + - + - ]: 474 : {"hexdata", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "the hex-encoded block header data"},
1146 : : },
1147 [ + - ]: 474 : RPCResult{
1148 [ + - + - : 474 : RPCResult::Type::NONE, "", "None"},
+ - ]
1149 : 237 : RPCExamples{
1150 [ + - + - : 474 : HelpExampleCli("submitheader", "\"aabbcc\"") +
+ - ]
1151 [ + - + - : 711 : HelpExampleRpc("submitheader", "\"aabbcc\"")
+ - + - ]
1152 [ + - ]: 237 : },
1153 : 237 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
1154 : : {
1155 : 173 : CBlockHeader h;
1156 [ + + ]: 173 : if (!DecodeHexBlockHeader(h, request.params[0].get_str())) {
1157 [ + - + - ]: 8 : throw JSONRPCError(RPC_DESERIALIZATION_ERROR, "Block header decode failed");
1158 : : }
1159 : 169 : ChainstateManager& chainman = EnsureAnyChainman(request.context);
1160 : 169 : {
1161 : 169 : LOCK(cs_main);
1162 [ + - + + ]: 169 : if (!chainman.m_blockman.LookupBlockIndex(h.hashPrevBlock)) {
1163 [ + - + - : 174 : throw JSONRPCError(RPC_VERIFY_ERROR, "Must submit previous header (" + h.hashPrevBlock.GetHex() + ") first");
+ - ]
1164 : : }
1165 : 58 : }
1166 : :
1167 [ + - ]: 111 : BlockValidationState state;
1168 [ + - ]: 111 : chainman.ProcessNewBlockHeaders({{h}}, /*min_pow_checked=*/true, state);
1169 [ + + ]: 111 : if (state.IsValid()) return UniValue::VNULL;
1170 [ - + ]: 14 : if (state.IsError()) {
1171 [ # # # # ]: 0 : throw JSONRPCError(RPC_VERIFY_ERROR, state.ToString());
1172 : : }
1173 [ - + + - ]: 42 : throw JSONRPCError(RPC_VERIFY_ERROR, state.GetRejectReason());
1174 : 97 : },
1175 [ + - + - : 1185 : };
+ + - - ]
1176 [ + - ]: 474 : }
1177 : :
1178 : 29 : void RegisterMiningRPCCommands(CRPCTable& t)
1179 : : {
1180 : 29 : static const CRPCCommand commands[]{
1181 [ + - ]: 54 : {"mining", &getnetworkhashps},
1182 [ + - ]: 54 : {"mining", &getmininginfo},
1183 [ + - ]: 54 : {"mining", &prioritisetransaction},
1184 [ + - ]: 54 : {"mining", &getprioritisedtransactions},
1185 [ + - ]: 54 : {"mining", &getblocktemplate},
1186 [ + - ]: 54 : {"mining", &submitblock},
1187 [ + - ]: 54 : {"mining", &submitheader},
1188 : :
1189 [ + - ]: 54 : {"hidden", &generatetoaddress},
1190 [ + - ]: 54 : {"hidden", &generatetodescriptor},
1191 [ + - ]: 54 : {"hidden", &generateblock},
1192 [ + - ]: 54 : {"hidden", &generate},
1193 [ + + + - : 353 : };
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - - - ]
1194 [ + + ]: 348 : for (const auto& c : commands) {
1195 : 319 : t.appendCommand(c.name, &c);
1196 : : }
1197 : 29 : }
|
