Bitcoin Core 31.99.0
P2P Digital Currency
interfaces.cpp
Go to the documentation of this file.
1// Copyright (c) 2018-present The Bitcoin Core developers
2// Distributed under the MIT software license, see the accompanying
3// file COPYING or http://www.opensource.org/licenses/mit-license.php.
4
5#include <addrdb.h>
6#include <banman.h>
7#include <blockfilter.h>
8#include <chain.h>
9#include <chainparams.h>
10#include <common/args.h>
11#include <consensus/merkle.h>
13#include <deploymentstatus.h>
14#include <external_signer.h>
15#include <httprpc.h>
17#include <init.h>
18#include <interfaces/chain.h>
19#include <interfaces/handler.h>
20#include <interfaces/mining.h>
21#include <interfaces/node.h>
22#include <interfaces/rpc.h>
23#include <interfaces/types.h>
24#include <interfaces/wallet.h>
25#include <kernel/chain.h>
26#include <kernel/context.h>
28#include <logging.h>
29#include <mapport.h>
30#include <net.h>
31#include <net_processing.h>
32#include <netaddress.h>
33#include <netbase.h>
34#include <node/blockstorage.h>
35#include <node/coin.h>
36#include <node/context.h>
37#include <node/interface_ui.h>
38#include <node/mini_miner.h>
39#include <node/miner.h>
41#include <node/transaction.h>
42#include <node/types.h>
43#include <node/warnings.h>
44#include <policy/feerate.h>
46#include <policy/policy.h>
47#include <policy/rbf.h>
48#include <policy/settings.h>
49#include <primitives/block.h>
51#include <rpc/blockchain.h>
52#include <rpc/protocol.h>
53#include <rpc/server.h>
55#include <sync.h>
56#include <txmempool.h>
57#include <uint256.h>
58#include <univalue.h>
59#include <util/check.h>
60#include <util/result.h>
62#include <util/string.h>
63#include <util/translation.h>
64#include <validation.h>
65#include <validationinterface.h>
66
67#include <bitcoin-build-config.h> // IWYU pragma: keep
68
69#include <any>
70#include <memory>
71#include <optional>
72#include <stdexcept>
73#include <utility>
74
75#include <boost/signals2/signal.hpp>
76
86using interfaces::Rpc;
92using util::Join;
93
94namespace node {
95// All members of the classes in this namespace are intentionally public, as the
96// classes themselves are private.
97namespace {
98#ifdef ENABLE_EXTERNAL_SIGNER
99class ExternalSignerImpl : public interfaces::ExternalSigner
100{
101public:
102 ExternalSignerImpl(::ExternalSigner signer) : m_signer(std::move(signer)) {}
103 std::string getName() override { return m_signer.m_name; }
105};
106#endif
107
108class NodeImpl : public Node
109{
110public:
111 explicit NodeImpl(NodeContext& context) { setContext(&context); }
112 void initLogging() override { InitLogging(args()); }
113 void initParameterInteraction() override { InitParameterInteraction(args()); }
114 bilingual_str getWarnings() override { return Join(Assert(m_context->warnings)->GetMessages(), Untranslated("<hr />")); }
115 int getExitStatus() override { return Assert(m_context)->exit_status.load(); }
116 BCLog::CategoryMask getLogCategories() override { return LogInstance().GetCategoryMask(); }
117 bool baseInitialize() override
118 {
119 if (!AppInitBasicSetup(args(), Assert(context())->exit_status)) return false;
120 if (!AppInitParameterInteraction(args())) return false;
121
122 m_context->warnings = std::make_unique<node::Warnings>();
123 m_context->kernel = std::make_unique<kernel::Context>();
124 m_context->ecc_context = std::make_unique<ECC_Context>();
125 if (!AppInitSanityChecks(*m_context->kernel)) return false;
126
127 if (!AppInitLockDirectories()) return false;
128 if (!AppInitInterfaces(*m_context)) return false;
129
130 return true;
131 }
132 bool appInitMain(interfaces::BlockAndHeaderTipInfo* tip_info) override
133 {
134 if (AppInitMain(*m_context, tip_info)) return true;
135 // Error during initialization, set exit status before continue
136 m_context->exit_status.store(EXIT_FAILURE);
137 return false;
138 }
139 void appShutdown() override
140 {
142 }
143 void startShutdown() override
144 {
145 NodeContext& ctx{*Assert(m_context)};
146 if (!(Assert(ctx.shutdown_request))()) {
147 LogError("Failed to send shutdown signal\n");
148 }
150 }
151 bool shutdownRequested() override { return ShutdownRequested(*Assert(m_context)); };
152 bool isSettingIgnored(const std::string& name) override
153 {
154 bool ignored = false;
155 args().LockSettings([&](common::Settings& settings) {
156 if (auto* options = common::FindKey(settings.command_line_options, name)) {
157 ignored = !options->empty();
158 }
159 });
160 return ignored;
161 }
162 common::SettingsValue getPersistentSetting(const std::string& name) override { return args().GetPersistentSetting(name); }
163 void updateRwSetting(const std::string& name, const common::SettingsValue& value) override
164 {
165 args().LockSettings([&](common::Settings& settings) {
166 if (value.isNull()) {
167 settings.rw_settings.erase(name);
168 } else {
169 settings.rw_settings[name] = value;
170 }
171 });
173 }
174 void forceSetting(const std::string& name, const common::SettingsValue& value) override
175 {
176 args().LockSettings([&](common::Settings& settings) {
177 if (value.isNull()) {
178 settings.forced_settings.erase(name);
179 } else {
180 settings.forced_settings[name] = value;
181 }
182 });
183 }
184 void resetSettings() override
185 {
186 args().WriteSettingsFile(/*errors=*/nullptr, /*backup=*/true);
187 args().LockSettings([&](common::Settings& settings) {
188 settings.rw_settings.clear();
189 });
191 }
192 void mapPort(bool enable) override { StartMapPort(enable); }
193 std::optional<Proxy> getProxy(Network net) override { return GetProxy(net); }
194 size_t getNodeCount(ConnectionDirection flags) override
195 {
196 return m_context->connman ? m_context->connman->GetNodeCount(flags) : 0;
197 }
198 bool getNodesStats(NodesStats& stats) override
199 {
200 stats.clear();
201
202 if (m_context->connman) {
203 std::vector<CNodeStats> stats_temp;
204 m_context->connman->GetNodeStats(stats_temp);
205
206 stats.reserve(stats_temp.size());
207 for (auto& node_stats_temp : stats_temp) {
208 stats.emplace_back(std::move(node_stats_temp), false, CNodeStateStats());
209 }
210
211 // Try to retrieve the CNodeStateStats for each node.
212 if (m_context->peerman) {
213 TRY_LOCK(::cs_main, lockMain);
214 if (lockMain) {
215 for (auto& node_stats : stats) {
216 std::get<1>(node_stats) =
217 m_context->peerman->GetNodeStateStats(std::get<0>(node_stats).nodeid, std::get<2>(node_stats));
218 }
219 }
220 }
221 return true;
222 }
223 return false;
224 }
225 bool getBanned(banmap_t& banmap) override
226 {
227 if (m_context->banman) {
228 m_context->banman->GetBanned(banmap);
229 return true;
230 }
231 return false;
232 }
233 bool ban(const CNetAddr& net_addr, int64_t ban_time_offset) override
234 {
235 if (m_context->banman) {
236 m_context->banman->Ban(net_addr, ban_time_offset);
237 return true;
238 }
239 return false;
240 }
241 bool unban(const CSubNet& ip) override
242 {
243 if (m_context->banman) {
244 m_context->banman->Unban(ip);
245 return true;
246 }
247 return false;
248 }
249 bool disconnectByAddress(const CNetAddr& net_addr) override
250 {
251 if (m_context->connman) {
252 return m_context->connman->DisconnectNode(net_addr);
253 }
254 return false;
255 }
256 bool disconnectById(NodeId id) override
257 {
258 if (m_context->connman) {
259 return m_context->connman->DisconnectNode(id);
260 }
261 return false;
262 }
263 std::vector<std::unique_ptr<interfaces::ExternalSigner>> listExternalSigners() override
264 {
265#ifdef ENABLE_EXTERNAL_SIGNER
266 std::vector<ExternalSigner> signers = {};
267 const std::string command = args().GetArg("-signer", "");
268 if (command == "") return {};
269 ExternalSigner::Enumerate(command, signers, Params().GetChainTypeString());
270 std::vector<std::unique_ptr<interfaces::ExternalSigner>> result;
271 result.reserve(signers.size());
272 for (auto& signer : signers) {
273 result.emplace_back(std::make_unique<ExternalSignerImpl>(std::move(signer)));
274 }
275 return result;
276#else
277 // This result is indistinguishable from a successful call that returns
278 // no signers. For the current GUI this doesn't matter, because the wallet
279 // creation dialog disables the external signer checkbox in both
280 // cases. The return type could be changed to std::optional<std::vector>
281 // (or something that also includes error messages) if this distinction
282 // becomes important.
283 return {};
284#endif // ENABLE_EXTERNAL_SIGNER
285 }
286 int64_t getTotalBytesRecv() override { return m_context->connman ? m_context->connman->GetTotalBytesRecv() : 0; }
287 int64_t getTotalBytesSent() override { return m_context->connman ? m_context->connman->GetTotalBytesSent() : 0; }
288 size_t getMempoolSize() override { return m_context->mempool ? m_context->mempool->size() : 0; }
289 size_t getMempoolDynamicUsage() override { return m_context->mempool ? m_context->mempool->DynamicMemoryUsage() : 0; }
290 size_t getMempoolMaxUsage() override { return m_context->mempool ? m_context->mempool->m_opts.max_size_bytes : 0; }
291 bool getHeaderTip(int& height, int64_t& block_time) override
292 {
294 auto best_header = chainman().m_best_header;
295 if (best_header) {
296 height = best_header->nHeight;
297 block_time = best_header->GetBlockTime();
298 return true;
299 }
300 return false;
301 }
302 std::map<CNetAddr, LocalServiceInfo> getNetLocalAddresses() override
303 {
304 if (m_context->connman)
305 return m_context->connman->getNetLocalAddresses();
306 else
307 return {};
308 }
309 int getNumBlocks() override
310 {
312 return chainman().ActiveChain().Height();
313 }
314 uint256 getBestBlockHash() override
315 {
316 const CBlockIndex* tip = WITH_LOCK(::cs_main, return chainman().ActiveChain().Tip());
317 return tip ? tip->GetBlockHash() : chainman().GetParams().GenesisBlock().GetHash();
318 }
319 int64_t getLastBlockTime() override
320 {
322 if (chainman().ActiveChain().Tip()) {
323 return chainman().ActiveChain().Tip()->GetBlockTime();
324 }
325 return chainman().GetParams().GenesisBlock().GetBlockTime(); // Genesis block's time of current network
326 }
327 double getVerificationProgress() override
328 {
329 LOCK(chainman().GetMutex());
330 return chainman().GuessVerificationProgress(chainman().ActiveTip());
331 }
332 bool isInitialBlockDownload() override
333 {
334 return chainman().IsInitialBlockDownload();
335 }
336 bool isLoadingBlocks() override { return chainman().m_blockman.LoadingBlocks(); }
337 void setNetworkActive(bool active) override
338 {
339 if (m_context->connman) {
340 m_context->connman->SetNetworkActive(active);
341 }
342 }
343 bool getNetworkActive() override { return m_context->connman && m_context->connman->GetNetworkActive(); }
344 CFeeRate getDustRelayFee() override
345 {
346 if (!m_context->mempool) return CFeeRate{DUST_RELAY_TX_FEE};
347 return m_context->mempool->m_opts.dust_relay_feerate;
348 }
349 UniValue executeRpc(const std::string& command, const UniValue& params, const std::string& uri) override
350 {
351 JSONRPCRequest req;
352 req.context = m_context;
353 req.params = params;
354 req.strMethod = command;
355 req.URI = uri;
357 }
358 std::vector<std::string> listRpcCommands() override { return ::tableRPC.listCommands(); }
359 std::optional<Coin> getUnspentOutput(const COutPoint& output) override
360 {
362 return chainman().ActiveChainstate().CoinsTip().GetCoin(output);
363 }
364 TransactionError broadcastTransaction(CTransactionRef tx, CAmount max_tx_fee, std::string& err_string) override
365 {
367 std::move(tx),
368 err_string,
369 max_tx_fee,
371 /*wait_callback=*/false);
372 }
373 WalletLoader& walletLoader() override
374 {
375 return *Assert(m_context->wallet_loader);
376 }
377 std::unique_ptr<Handler> handleInitMessage(InitMessageFn fn) override
378 {
379 return MakeSignalHandler(::uiInterface.InitMessage_connect(fn));
380 }
381 std::unique_ptr<Handler> handleMessageBox(MessageBoxFn fn) override
382 {
383 return MakeSignalHandler(::uiInterface.ThreadSafeMessageBox_connect(fn));
384 }
385 std::unique_ptr<Handler> handleQuestion(QuestionFn fn) override
386 {
387 return MakeSignalHandler(::uiInterface.ThreadSafeQuestion_connect(fn));
388 }
389 std::unique_ptr<Handler> handleShowProgress(ShowProgressFn fn) override
390 {
391 return MakeSignalHandler(::uiInterface.ShowProgress_connect(fn));
392 }
393 std::unique_ptr<Handler> handleInitWallet(InitWalletFn fn) override
394 {
395 return MakeSignalHandler(::uiInterface.InitWallet_connect(fn));
396 }
397 std::unique_ptr<Handler> handleNotifyNumConnectionsChanged(NotifyNumConnectionsChangedFn fn) override
398 {
399 return MakeSignalHandler(::uiInterface.NotifyNumConnectionsChanged_connect(fn));
400 }
401 std::unique_ptr<Handler> handleNotifyNetworkActiveChanged(NotifyNetworkActiveChangedFn fn) override
402 {
403 return MakeSignalHandler(::uiInterface.NotifyNetworkActiveChanged_connect(fn));
404 }
405 std::unique_ptr<Handler> handleNotifyAlertChanged(NotifyAlertChangedFn fn) override
406 {
407 return MakeSignalHandler(::uiInterface.NotifyAlertChanged_connect(fn));
408 }
409 std::unique_ptr<Handler> handleBannedListChanged(BannedListChangedFn fn) override
410 {
411 return MakeSignalHandler(::uiInterface.BannedListChanged_connect(fn));
412 }
413 std::unique_ptr<Handler> handleNotifyBlockTip(NotifyBlockTipFn fn) override
414 {
415 return MakeSignalHandler(::uiInterface.NotifyBlockTip_connect([fn](SynchronizationState sync_state, const CBlockIndex& block, double verification_progress) {
416 fn(sync_state, BlockTip{block.nHeight, block.GetBlockTime(), block.GetBlockHash()}, verification_progress);
417 }));
418 }
419 std::unique_ptr<Handler> handleNotifyHeaderTip(NotifyHeaderTipFn fn) override
420 {
421 return MakeSignalHandler(
422 ::uiInterface.NotifyHeaderTip_connect([fn](SynchronizationState sync_state, int64_t height, int64_t timestamp, bool presync) {
423 fn(sync_state, BlockTip{(int)height, timestamp, uint256{}}, presync);
424 }));
425 }
426 NodeContext* context() override { return m_context; }
427 void setContext(NodeContext* context) override
428 {
429 m_context = context;
430 }
431 ArgsManager& args() { return *Assert(Assert(m_context)->args); }
432 ChainstateManager& chainman() { return *Assert(m_context->chainman); }
433 NodeContext* m_context{nullptr};
434};
435
436// NOLINTNEXTLINE(misc-no-recursion)
437bool FillBlock(const CBlockIndex* index, const FoundBlock& block, UniqueLock<RecursiveMutex>& lock, const CChain& active, const BlockManager& blockman) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
438{
439 if (!index) return false;
440 if (block.m_hash) *block.m_hash = index->GetBlockHash();
441 if (block.m_height) *block.m_height = index->nHeight;
442 if (block.m_time) *block.m_time = index->GetBlockTime();
443 if (block.m_max_time) *block.m_max_time = index->GetBlockTimeMax();
444 if (block.m_mtp_time) *block.m_mtp_time = index->GetMedianTimePast();
445 if (block.m_in_active_chain) *block.m_in_active_chain = active[index->nHeight] == index;
446 if (block.m_locator) { *block.m_locator = GetLocator(index); }
447 if (block.m_next_block) FillBlock(active[index->nHeight] == index ? active[index->nHeight + 1] : nullptr, *block.m_next_block, lock, active, blockman);
448 if (block.m_data) {
449 REVERSE_LOCK(lock, cs_main);
450 if (!blockman.ReadBlock(*block.m_data, *index)) block.m_data->SetNull();
451 }
452 block.found = true;
453 return true;
454}
455
456class NotificationsProxy : public CValidationInterface
457{
458public:
459 explicit NotificationsProxy(std::shared_ptr<Chain::Notifications> notifications)
460 : m_notifications(std::move(notifications)) {}
461 virtual ~NotificationsProxy() = default;
462 void TransactionAddedToMempool(const NewMempoolTransactionInfo& tx, uint64_t mempool_sequence) override
463 {
464 m_notifications->transactionAddedToMempool(tx.info.m_tx);
465 }
466 void TransactionRemovedFromMempool(const CTransactionRef& tx, MemPoolRemovalReason reason, uint64_t mempool_sequence) override
467 {
468 m_notifications->transactionRemovedFromMempool(tx, reason);
469 }
470 void BlockConnected(const ChainstateRole& role, const std::shared_ptr<const CBlock>& block, const CBlockIndex* index) override
471 {
472 m_notifications->blockConnected(role, kernel::MakeBlockInfo(index, block.get()));
473 }
474 void BlockDisconnected(const std::shared_ptr<const CBlock>& block, const CBlockIndex* index) override
475 {
476 m_notifications->blockDisconnected(kernel::MakeBlockInfo(index, block.get()));
477 }
478 void UpdatedBlockTip(const CBlockIndex* index, const CBlockIndex* fork_index, bool is_ibd) override
479 {
480 m_notifications->updatedBlockTip();
481 }
482 void ChainStateFlushed(const ChainstateRole& role, const CBlockLocator& locator) override
483 {
484 m_notifications->chainStateFlushed(role, locator);
485 }
486 std::shared_ptr<Chain::Notifications> m_notifications;
487};
488
489class NotificationsHandlerImpl : public Handler
490{
491public:
492 explicit NotificationsHandlerImpl(ValidationSignals& signals, std::shared_ptr<Chain::Notifications> notifications)
493 : m_signals{signals}, m_proxy{std::make_shared<NotificationsProxy>(std::move(notifications))}
494 {
496 }
497 ~NotificationsHandlerImpl() override { disconnect(); }
498 void disconnect() override
499 {
500 if (m_proxy) {
502 m_proxy.reset();
503 }
504 }
506 std::shared_ptr<NotificationsProxy> m_proxy;
507};
508
509class RpcHandlerImpl : public Handler
510{
511public:
512 explicit RpcHandlerImpl(const CRPCCommand& command) : m_command(command), m_wrapped_command(&command)
513 {
514 m_command.actor = [this](const JSONRPCRequest& request, UniValue& result, bool last_handler) {
515 if (!m_wrapped_command) return false;
516 try {
517 return m_wrapped_command->actor(request, result, last_handler);
518 } catch (const UniValue& e) {
519 // If this is not the last handler and a wallet not found
520 // exception was thrown, return false so the next handler can
521 // try to handle the request. Otherwise, reraise the exception.
522 if (!last_handler) {
523 const UniValue& code = e["code"];
524 if (code.isNum() && code.getInt<int>() == RPC_WALLET_NOT_FOUND) {
525 return false;
526 }
527 }
528 throw;
529 }
530 };
532 }
533
534 void disconnect() final
535 {
536 if (m_wrapped_command) {
537 m_wrapped_command = nullptr;
539 }
540 }
541
542 ~RpcHandlerImpl() override { disconnect(); }
543
546};
547
548class ChainImpl : public Chain
549{
550public:
551 explicit ChainImpl(NodeContext& node) : m_node(node) {}
552 std::optional<int> getHeight() override
553 {
554 const int height{WITH_LOCK(::cs_main, return chainman().ActiveChain().Height())};
555 return height >= 0 ? std::optional{height} : std::nullopt;
556 }
557 uint256 getBlockHash(int height) override
558 {
560 return Assert(chainman().ActiveChain()[height])->GetBlockHash();
561 }
562 bool haveBlockOnDisk(int height) override
563 {
565 const CBlockIndex* block{chainman().ActiveChain()[height]};
566 return block && ((block->nStatus & BLOCK_HAVE_DATA) != 0) && block->nTx > 0;
567 }
568 std::optional<int> findLocatorFork(const CBlockLocator& locator) override
569 {
571 if (const CBlockIndex* fork = chainman().ActiveChainstate().FindForkInGlobalIndex(locator)) {
572 return fork->nHeight;
573 }
574 return std::nullopt;
575 }
576 bool hasBlockFilterIndex(BlockFilterType filter_type) override
577 {
578 return GetBlockFilterIndex(filter_type) != nullptr;
579 }
580 std::optional<bool> blockFilterMatchesAny(BlockFilterType filter_type, const uint256& block_hash, const GCSFilter::ElementSet& filter_set) override
581 {
582 const BlockFilterIndex* block_filter_index{GetBlockFilterIndex(filter_type)};
583 if (!block_filter_index) return std::nullopt;
584
585 BlockFilter filter;
586 const CBlockIndex* index{WITH_LOCK(::cs_main, return chainman().m_blockman.LookupBlockIndex(block_hash))};
587 if (index == nullptr || !block_filter_index->LookupFilter(index, filter)) return std::nullopt;
588 return filter.GetFilter().MatchAny(filter_set);
589 }
590 bool findBlock(const uint256& hash, const FoundBlock& block) override
591 {
592 WAIT_LOCK(cs_main, lock);
593 return FillBlock(chainman().m_blockman.LookupBlockIndex(hash), block, lock, chainman().ActiveChain(), chainman().m_blockman);
594 }
595 bool findFirstBlockWithTimeAndHeight(int64_t min_time, int min_height, const FoundBlock& block) override
596 {
597 WAIT_LOCK(cs_main, lock);
598 const CChain& active = chainman().ActiveChain();
599 return FillBlock(active.FindEarliestAtLeast(min_time, min_height), block, lock, active, chainman().m_blockman);
600 }
601 bool findAncestorByHeight(const uint256& block_hash, int ancestor_height, const FoundBlock& ancestor_out) override
602 {
603 WAIT_LOCK(cs_main, lock);
604 const CChain& active = chainman().ActiveChain();
605 if (const CBlockIndex* block = chainman().m_blockman.LookupBlockIndex(block_hash)) {
606 if (const CBlockIndex* ancestor = block->GetAncestor(ancestor_height)) {
607 return FillBlock(ancestor, ancestor_out, lock, active, chainman().m_blockman);
608 }
609 }
610 return FillBlock(nullptr, ancestor_out, lock, active, chainman().m_blockman);
611 }
612 bool findAncestorByHash(const uint256& block_hash, const uint256& ancestor_hash, const FoundBlock& ancestor_out) override
613 {
614 WAIT_LOCK(cs_main, lock);
615 const CBlockIndex* block = chainman().m_blockman.LookupBlockIndex(block_hash);
616 const CBlockIndex* ancestor = chainman().m_blockman.LookupBlockIndex(ancestor_hash);
617 if (block && ancestor && block->GetAncestor(ancestor->nHeight) != ancestor) ancestor = nullptr;
618 return FillBlock(ancestor, ancestor_out, lock, chainman().ActiveChain(), chainman().m_blockman);
619 }
620 bool findCommonAncestor(const uint256& block_hash1, const uint256& block_hash2, const FoundBlock& ancestor_out, const FoundBlock& block1_out, const FoundBlock& block2_out) override
621 {
622 WAIT_LOCK(cs_main, lock);
623 const CChain& active = chainman().ActiveChain();
624 const CBlockIndex* block1 = chainman().m_blockman.LookupBlockIndex(block_hash1);
625 const CBlockIndex* block2 = chainman().m_blockman.LookupBlockIndex(block_hash2);
626 const CBlockIndex* ancestor = block1 && block2 ? LastCommonAncestor(block1, block2) : nullptr;
627 // Using & instead of && below to avoid short circuiting and leaving
628 // output uninitialized. Cast bool to int to avoid -Wbitwise-instead-of-logical
629 // compiler warnings.
630 return int{FillBlock(ancestor, ancestor_out, lock, active, chainman().m_blockman)} &
631 int{FillBlock(block1, block1_out, lock, active, chainman().m_blockman)} &
632 int{FillBlock(block2, block2_out, lock, active, chainman().m_blockman)};
633 }
634 void findCoins(std::map<COutPoint, Coin>& coins) override { return FindCoins(m_node, coins); }
635 double guessVerificationProgress(const uint256& block_hash) override
636 {
637 LOCK(chainman().GetMutex());
638 return chainman().GuessVerificationProgress(chainman().m_blockman.LookupBlockIndex(block_hash));
639 }
640 bool hasBlocks(const uint256& block_hash, int min_height, std::optional<int> max_height) override
641 {
642 // hasBlocks returns true if all ancestors of block_hash in specified
643 // range have block data (are not pruned), false if any ancestors in
644 // specified range are missing data.
645 //
646 // For simplicity and robustness, min_height and max_height are only
647 // used to limit the range, and passing min_height that's too low or
648 // max_height that's too high will not crash or change the result.
650 if (const CBlockIndex* block = chainman().m_blockman.LookupBlockIndex(block_hash)) {
651 if (max_height && block->nHeight >= *max_height) block = block->GetAncestor(*max_height);
652 for (; block->nStatus & BLOCK_HAVE_DATA; block = block->pprev) {
653 // Check pprev to not segfault if min_height is too low
654 if (block->nHeight <= min_height || !block->pprev) return true;
655 }
656 }
657 return false;
658 }
659 RBFTransactionState isRBFOptIn(const CTransaction& tx) override
660 {
661 if (!m_node.mempool) return IsRBFOptInEmptyMempool(tx);
662 LOCK(m_node.mempool->cs);
663 return IsRBFOptIn(tx, *m_node.mempool);
664 }
665 bool isInMempool(const Txid& txid) override
666 {
667 if (!m_node.mempool) return false;
668 return m_node.mempool->exists(txid);
669 }
670 bool hasDescendantsInMempool(const Txid& txid) override
671 {
672 if (!m_node.mempool) return false;
673 return m_node.mempool->HasDescendants(txid);
674 }
675 bool broadcastTransaction(const CTransactionRef& tx,
676 const CAmount& max_tx_fee,
677 TxBroadcast broadcast_method,
678 std::string& err_string) override
679 {
680 const TransactionError err = BroadcastTransaction(m_node, tx, err_string, max_tx_fee, broadcast_method, /*wait_callback=*/false);
681 // Chain clients only care about failures to accept the tx to the mempool. Disregard non-mempool related failures.
682 // Note: this will need to be updated if BroadcastTransactions() is updated to return other non-mempool failures
683 // that Chain clients do not need to know about.
684 return TransactionError::OK == err;
685 }
686 void getTransactionAncestry(const Txid& txid, size_t& ancestors, size_t& cluster_count, size_t* ancestorsize, CAmount* ancestorfees) override
687 {
688 ancestors = cluster_count = 0;
689 if (!m_node.mempool) return;
690 m_node.mempool->GetTransactionAncestry(txid, ancestors, cluster_count, ancestorsize, ancestorfees);
691 }
692
693 std::map<COutPoint, CAmount> calculateIndividualBumpFees(const std::vector<COutPoint>& outpoints, const CFeeRate& target_feerate) override
694 {
695 if (!m_node.mempool) {
696 std::map<COutPoint, CAmount> bump_fees;
697 for (const auto& outpoint : outpoints) {
698 bump_fees.emplace(outpoint, 0);
699 }
700 return bump_fees;
701 }
702 return MiniMiner(*m_node.mempool, outpoints).CalculateBumpFees(target_feerate);
703 }
704
705 std::optional<CAmount> calculateCombinedBumpFee(const std::vector<COutPoint>& outpoints, const CFeeRate& target_feerate) override
706 {
707 if (!m_node.mempool) {
708 return 0;
709 }
710 return MiniMiner(*m_node.mempool, outpoints).CalculateTotalBumpFees(target_feerate);
711 }
712 void getPackageLimits(unsigned int& limit_ancestor_count, unsigned int& limit_descendant_count) override
713 {
714 const CTxMemPool::Limits default_limits{};
715
716 const CTxMemPool::Limits& limits{m_node.mempool ? m_node.mempool->m_opts.limits : default_limits};
717
718 limit_ancestor_count = limits.ancestor_count;
719 limit_descendant_count = limits.descendant_count;
720 }
721 util::Result<void> checkChainLimits(const CTransactionRef& tx) override
722 {
723 if (!m_node.mempool) return {};
724 if (!m_node.mempool->CheckPolicyLimits(tx)) {
725 return util::Error{Untranslated("too many unconfirmed transactions in cluster")};
726 }
727 return {};
728 }
729 CFeeRate estimateSmartFee(int num_blocks, bool conservative, FeeCalculation* calc) override
730 {
731 if (!m_node.fee_estimator) return {};
732 return m_node.fee_estimator->estimateSmartFee(num_blocks, calc, conservative);
733 }
734 unsigned int estimateMaxBlocks() override
735 {
736 if (!m_node.fee_estimator) return 0;
737 return m_node.fee_estimator->HighestTargetTracked(FeeEstimateHorizon::LONG_HALFLIFE);
738 }
739 CFeeRate mempoolMinFee() override
740 {
741 if (!m_node.mempool) return {};
742 return m_node.mempool->GetMinFee();
743 }
744 CFeeRate relayMinFee() override
745 {
746 if (!m_node.mempool) return CFeeRate{DEFAULT_MIN_RELAY_TX_FEE};
747 return m_node.mempool->m_opts.min_relay_feerate;
748 }
749 CFeeRate relayIncrementalFee() override
750 {
751 if (!m_node.mempool) return CFeeRate{DEFAULT_INCREMENTAL_RELAY_FEE};
752 return m_node.mempool->m_opts.incremental_relay_feerate;
753 }
754 CFeeRate relayDustFee() override
755 {
756 if (!m_node.mempool) return CFeeRate{DUST_RELAY_TX_FEE};
757 return m_node.mempool->m_opts.dust_relay_feerate;
758 }
759 bool havePruned() override
760 {
762 return chainman().m_blockman.m_have_pruned;
763 }
764 std::optional<int> getPruneHeight() override
765 {
766 LOCK(chainman().GetMutex());
767 return GetPruneHeight(chainman().m_blockman, chainman().ActiveChain());
768 }
769 bool isReadyToBroadcast() override { return !chainman().m_blockman.LoadingBlocks() && !isInitialBlockDownload(); }
770 bool isInitialBlockDownload() override
771 {
772 return chainman().IsInitialBlockDownload();
773 }
774 bool shutdownRequested() override { return ShutdownRequested(m_node); }
775 void initMessage(const std::string& message) override { ::uiInterface.InitMessage(message); }
776 void initWarning(const bilingual_str& message) override { InitWarning(message); }
777 void initError(const bilingual_str& message) override { InitError(message); }
778 void showProgress(const std::string& title, int progress, bool resume_possible) override
779 {
780 ::uiInterface.ShowProgress(title, progress, resume_possible);
781 }
782 std::unique_ptr<Handler> handleNotifications(std::shared_ptr<Notifications> notifications) override
783 {
784 return std::make_unique<NotificationsHandlerImpl>(validation_signals(), std::move(notifications));
785 }
786 void waitForNotificationsIfTipChanged(const uint256& old_tip) override
787 {
788 if (!old_tip.IsNull() && old_tip == WITH_LOCK(::cs_main, return chainman().ActiveChain().Tip()->GetBlockHash())) return;
789 validation_signals().SyncWithValidationInterfaceQueue();
790 }
791 void waitForNotifications() override
792 {
793 validation_signals().SyncWithValidationInterfaceQueue();
794 }
795 std::unique_ptr<Handler> handleRpc(const CRPCCommand& command) override
796 {
797 return std::make_unique<RpcHandlerImpl>(command);
798 }
799 bool rpcEnableDeprecated(const std::string& method) override { return IsDeprecatedRPCEnabled(method); }
800 common::SettingsValue getSetting(const std::string& name) override
801 {
802 return args().GetSetting(name);
803 }
804 std::vector<common::SettingsValue> getSettingsList(const std::string& name) override
805 {
806 return args().GetSettingsList(name);
807 }
808 common::SettingsValue getRwSetting(const std::string& name) override
809 {
811 args().LockSettings([&](const common::Settings& settings) {
812 if (const common::SettingsValue* value = common::FindKey(settings.rw_settings, name)) {
813 result = *value;
814 }
815 });
816 return result;
817 }
818 bool updateRwSetting(const std::string& name,
819 const interfaces::SettingsUpdate& update_settings_func) override
820 {
821 std::optional<interfaces::SettingsAction> action;
822 args().LockSettings([&](common::Settings& settings) {
823 if (auto* value = common::FindKey(settings.rw_settings, name)) {
824 action = update_settings_func(*value);
825 if (value->isNull()) settings.rw_settings.erase(name);
826 } else {
827 UniValue new_value;
828 action = update_settings_func(new_value);
829 if (!new_value.isNull()) settings.rw_settings[name] = std::move(new_value);
830 }
831 });
832 if (!action) return false;
833 // Now dump value to disk if requested
835 }
836 bool overwriteRwSetting(const std::string& name, common::SettingsValue value, interfaces::SettingsAction action) override
837 {
838 return updateRwSetting(name, [&](common::SettingsValue& settings) {
839 settings = std::move(value);
840 return action;
841 });
842 }
843 bool deleteRwSettings(const std::string& name, interfaces::SettingsAction action) override
844 {
845 return overwriteRwSetting(name, {}, action);
846 }
847 void requestMempoolTransactions(Notifications& notifications) override
848 {
849 if (!m_node.mempool) return;
850 LOCK2(::cs_main, m_node.mempool->cs);
851 for (const CTxMemPoolEntry& entry : m_node.mempool->entryAll()) {
852 notifications.transactionAddedToMempool(entry.GetSharedTx());
853 }
854 }
855 bool hasAssumedValidChain() override
856 {
858 return bool{chainman().CurrentChainstate().m_from_snapshot_blockhash};
859 }
860
861 NodeContext* context() override { return &m_node; }
862 ArgsManager& args() { return *Assert(m_node.args); }
863 ChainstateManager& chainman() { return *Assert(m_node.chainman); }
864 ValidationSignals& validation_signals() { return *Assert(m_node.validation_signals); }
865 NodeContext& m_node;
866};
867
868class BlockTemplateImpl : public BlockTemplate
869{
870public:
871 explicit BlockTemplateImpl(BlockAssembler::Options assemble_options,
872 std::unique_ptr<CBlockTemplate> block_template,
873 NodeContext& node) : m_assemble_options(std::move(assemble_options)),
874 m_block_template(std::move(block_template)),
875 m_node(node)
876 {
878 }
879
880 CBlockHeader getBlockHeader() override
881 {
882 return m_block_template->block;
883 }
884
885 CBlock getBlock() override
886 {
887 return m_block_template->block;
888 }
889
890 std::vector<CAmount> getTxFees() override
891 {
892 return m_block_template->vTxFees;
893 }
894
895 std::vector<int64_t> getTxSigops() override
896 {
897 return m_block_template->vTxSigOpsCost;
898 }
899
900 CoinbaseTx getCoinbaseTx() override
901 {
902 return m_block_template->m_coinbase_tx;
903 }
904
905 std::vector<uint256> getCoinbaseMerklePath() override
906 {
907 return TransactionMerklePath(m_block_template->block, 0);
908 }
909
910 bool submitSolution(uint32_t version, uint32_t timestamp, uint32_t nonce, CTransactionRef coinbase) override
911 {
912 AddMerkleRootAndCoinbase(m_block_template->block, std::move(coinbase), version, timestamp, nonce);
913 return chainman().ProcessNewBlock(std::make_shared<const CBlock>(m_block_template->block), /*force_processing=*/true, /*min_pow_checked=*/true, /*new_block=*/nullptr);
914 }
915
916 std::unique_ptr<BlockTemplate> waitNext(BlockWaitOptions options) override
917 {
918 auto new_template = WaitAndCreateNewBlock(chainman(), notifications(), m_node.mempool.get(), m_block_template, options, m_assemble_options, m_interrupt_wait);
919 if (new_template) return std::make_unique<BlockTemplateImpl>(m_assemble_options, std::move(new_template), m_node);
920 return nullptr;
921 }
922
923 void interruptWait() override
924 {
925 InterruptWait(notifications(), m_interrupt_wait);
926 }
927
928 const BlockAssembler::Options m_assemble_options;
929
930 const std::unique_ptr<CBlockTemplate> m_block_template;
931
932 bool m_interrupt_wait{false};
933 ChainstateManager& chainman() { return *Assert(m_node.chainman); }
934 KernelNotifications& notifications() { return *Assert(m_node.notifications); }
935 NodeContext& m_node;
936};
937
938class MinerImpl : public Mining
939{
940public:
941 explicit MinerImpl(NodeContext& node) : m_node(node) {}
942
943 bool isTestChain() override
944 {
945 return chainman().GetParams().IsTestChain();
946 }
947
948 bool isInitialBlockDownload() override
949 {
950 return chainman().IsInitialBlockDownload();
951 }
952
953 std::optional<BlockRef> getTip() override
954 {
955 return GetTip(chainman());
956 }
957
958 std::optional<BlockRef> waitTipChanged(uint256 current_tip, MillisecondsDouble timeout) override
959 {
960 return WaitTipChanged(chainman(), notifications(), current_tip, timeout, m_interrupt_mining);
961 }
962
963 std::unique_ptr<BlockTemplate> createNewBlock(const BlockCreateOptions& options, bool cooldown) override
964 {
965 // Reject too-small values instead of clamping so callers don't silently
966 // end up mining with different options than requested. This matches the
967 // behavior of the `-blockreservedweight` startup option, which rejects
968 // values below MINIMUM_BLOCK_RESERVED_WEIGHT.
969 if (options.block_reserved_weight && options.block_reserved_weight < MINIMUM_BLOCK_RESERVED_WEIGHT) {
970 throw std::runtime_error(strprintf("block_reserved_weight (%zu) must be at least %u weight units",
971 *options.block_reserved_weight,
973 }
974
975 // Ensure m_tip_block is set so consumers of BlockTemplate can rely on that.
976 std::optional<BlockRef> maybe_tip{waitTipChanged(uint256::ZERO, MillisecondsDouble::max())};
977
978 if (!maybe_tip) return {};
979
980 if (cooldown) {
981 // Do not return a template during IBD, because it can have long
982 // pauses and sometimes takes a while to get started. Although this
983 // is useful in general, it's gated behind the cooldown argument,
984 // because on regtest and single miner signets this would wait
985 // forever if no block was mined in the past day.
986 while (chainman().IsInitialBlockDownload()) {
987 maybe_tip = waitTipChanged(maybe_tip->hash, MillisecondsDouble{1000});
988 if (!maybe_tip || chainman().m_interrupt || WITH_LOCK(notifications().m_tip_block_mutex, return m_interrupt_mining)) return {};
989 }
990
991 // Also wait during the final catch-up moments after IBD.
992 if (!CooldownIfHeadersAhead(chainman(), notifications(), *maybe_tip, m_interrupt_mining)) return {};
993 }
994
995 BlockAssembler::Options assemble_options{options};
996 ApplyArgsManOptions(*Assert(m_node.args), assemble_options);
997 return std::make_unique<BlockTemplateImpl>(assemble_options, BlockAssembler{chainman().ActiveChainstate(), context()->mempool.get(), assemble_options}.CreateNewBlock(), m_node);
998 }
999
1000 void interrupt() override
1001 {
1002 InterruptWait(notifications(), m_interrupt_mining);
1003 }
1004
1005 bool checkBlock(const CBlock& block, const node::BlockCheckOptions& options, std::string& reason, std::string& debug) override
1006 {
1007 LOCK(chainman().GetMutex());
1008 BlockValidationState state{TestBlockValidity(chainman().ActiveChainstate(), block, /*check_pow=*/options.check_pow, /*check_merkle_root=*/options.check_merkle_root)};
1009 reason = state.GetRejectReason();
1010 debug = state.GetDebugMessage();
1011 return state.IsValid();
1012 }
1013
1014 NodeContext* context() override { return &m_node; }
1015 ChainstateManager& chainman() { return *Assert(m_node.chainman); }
1016 KernelNotifications& notifications() { return *Assert(m_node.notifications); }
1017 // Treat as if guarded by notifications().m_tip_block_mutex
1019 NodeContext& m_node;
1020};
1021
1022class RpcImpl : public Rpc
1023{
1024public:
1025 explicit RpcImpl(NodeContext& node) : m_node(node) {}
1026
1027 UniValue executeRpc(UniValue request, std::string uri, std::string user) override
1028 {
1029 JSONRPCRequest req;
1030 req.context = &m_node;
1031 req.URI = std::move(uri);
1032 req.authUser = std::move(user);
1033 HTTPStatusCode status;
1034 return ExecuteHTTPRPC(request, req, status);
1035 }
1036
1037 NodeContext& m_node;
1038};
1039} // namespace
1040} // namespace node
1041
1042namespace interfaces {
1043std::unique_ptr<Node> MakeNode(node::NodeContext& context) { return std::make_unique<node::NodeImpl>(context); }
1044std::unique_ptr<Chain> MakeChain(node::NodeContext& context) { return std::make_unique<node::ChainImpl>(context); }
1045std::unique_ptr<Mining> MakeMining(node::NodeContext& context, bool wait_loaded)
1046{
1047 if (wait_loaded) {
1048 node::KernelNotifications& kernel_notifications(*Assert(context.notifications));
1049 util::SignalInterrupt& interrupt(*Assert(context.shutdown_signal));
1050 WAIT_LOCK(kernel_notifications.m_tip_block_mutex, lock);
1051 kernel_notifications.m_tip_block_cv.wait(lock, [&]() EXCLUSIVE_LOCKS_REQUIRED(kernel_notifications.m_tip_block_mutex) {
1052 return kernel_notifications.m_state.chainstate_loaded || interrupt;
1053 });
1054 if (interrupt) return nullptr;
1055 }
1056 return std::make_unique<node::MinerImpl>(context);
1057}
1058std::unique_ptr<Rpc> MakeRpc(node::NodeContext& context) { return std::make_unique<node::RpcImpl>(context); }
1059} // namespace interfaces
int64_t CAmount
Amount in satoshis (Can be negative)
Definition: amount.h:12
int flags
Definition: bitcoin-tx.cpp:530
int exit_status
const auto command
ArgsManager & args
Definition: bitcoind.cpp:278
Interrupt(node)
Shutdown(node)
std::optional< int > GetPruneHeight(const BlockManager &blockman, const CChain &chain)
Return height of highest block that has been pruned, or std::nullopt if no blocks have been pruned.
Definition: blockchain.cpp:883
BlockFilterType
Definition: blockfilter.h:94
BlockFilterIndex * GetBlockFilterIndex(BlockFilterType filter_type)
Get a block filter index by type.
CBlockLocator GetLocator(const CBlockIndex *index)
Get a locator for a block index entry.
Definition: chain.cpp:45
const CBlockIndex * LastCommonAncestor(const CBlockIndex *pa, const CBlockIndex *pb)
Find the last common ancestor two blocks have.
Definition: chain.cpp:155
@ BLOCK_HAVE_DATA
full block available in blk*.dat
Definition: chain.h:75
const CChainParams & Params()
Return the currently selected parameters.
#define Assert(val)
Identity function.
Definition: check.h:116
std::vector< common::SettingsValue > GetSettingsList(const std::string &arg) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Get list of setting values.
Definition: args.cpp:899
common::SettingsValue GetSetting(const std::string &arg) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Get setting value.
Definition: args.cpp:893
bool WriteSettingsFile(std::vector< std::string > *errors=nullptr, bool backup=false) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Write settings file or backup settings file.
Definition: args.cpp:453
void LockSettings(Fn &&fn) EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Access settings with lock held.
Definition: args.h:427
common::SettingsValue GetPersistentSetting(const std::string &name) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Get current setting from config file or read/write settings file, ignoring nonpersistent command line...
Definition: args.cpp:473
std::string GetArg(const std::string &strArg, const std::string &strDefault) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Return string argument or default value.
Definition: args.cpp:485
CategoryMask GetCategoryMask() const
Definition: logging.h:264
Complete block filter struct as defined in BIP 157.
Definition: blockfilter.h:116
const GCSFilter & GetFilter() const LIFETIMEBOUND
Definition: blockfilter.h:137
BlockFilterIndex is used to store and retrieve block filters, hashes, and headers for a range of bloc...
Nodes collect new transactions into a block, hash them into a hash tree, and scan through nonce value...
Definition: block.h:27
Definition: block.h:74
The block chain is a tree shaped structure starting with the genesis block at the root,...
Definition: chain.h:94
CBlockIndex * pprev
pointer to the index of the predecessor of this block
Definition: chain.h:100
uint256 GetBlockHash() const
Definition: chain.h:198
int64_t GetBlockTime() const
Definition: chain.h:221
int64_t GetMedianTimePast() const
Definition: chain.h:233
int64_t GetBlockTimeMax() const
Definition: chain.h:226
unsigned int nTx
Number of transactions in this block.
Definition: chain.h:123
CBlockIndex * GetAncestor(int height)
Efficiently find an ancestor of this block.
Definition: chain.cpp:110
int nHeight
height of the entry in the chain. The genesis block has height 0
Definition: chain.h:106
An in-memory indexed chain of blocks.
Definition: chain.h:380
CBlockIndex * FindEarliestAtLeast(int64_t nTime, int height) const
Find the earliest block with timestamp equal or greater than the given time and height equal or great...
Definition: chain.cpp:61
Fee rate in satoshis per virtualbyte: CAmount / vB the feerate is represented internally as FeeFrac.
Definition: feerate.h:32
Network address.
Definition: netaddress.h:113
An outpoint - a combination of a transaction hash and an index n into its vout.
Definition: transaction.h:29
std::string name
Definition: server.h:68
Actor actor
Definition: server.h:69
bool removeCommand(const std::string &name, const CRPCCommand *pcmd)
Definition: server.cpp:260
std::vector< std::string > listCommands() const
Returns a list of registered commands.
Definition: server.cpp:519
UniValue execute(const JSONRPCRequest &request) const
Execute a method.
Definition: server.cpp:482
void appendCommand(const std::string &name, const CRPCCommand *pcmd)
Appends a CRPCCommand to the dispatch table.
Definition: server.cpp:253
The basic transaction that is broadcasted on the network and contained in blocks.
Definition: transaction.h:281
CTxMemPoolEntry stores data about the corresponding transaction, as well as data about all in-mempool...
Definition: mempool_entry.h:66
Implement this to subscribe to events generated in validation and mempool.
Interface for managing multiple Chainstate objects, where each chainstate is associated with chainsta...
Definition: validation.h:940
Enables interaction with an external signing device or service, such as a hardware wallet.
static bool Enumerate(const std::string &command, std::vector< ExternalSigner > &signers, const std::string &chain)
Obtain a list of signers.
std::string m_name
Name of signer.
std::unordered_set< Element, ByteVectorHash > ElementSet
Definition: blockfilter.h:33
bool MatchAny(const ElementSet &elements) const
Checks if any of the given elements may be in the set.
UniValue params
Definition: request.h:57
std::string strMethod
Definition: request.h:56
std::string URI
Definition: request.h:59
std::string authUser
Definition: request.h:60
std::any context
Definition: request.h:62
bool isNull() const
Definition: univalue.h:81
Int getInt() const
Definition: univalue.h:140
bool isNum() const
Definition: univalue.h:86
Wrapper around std::unique_lock style lock for MutexType.
Definition: sync.h:154
void RegisterSharedValidationInterface(std::shared_ptr< CValidationInterface > callbacks)
Register subscriber.
void UnregisterSharedValidationInterface(std::shared_ptr< CValidationInterface > callbacks)
Unregister subscriber.
std::string GetRejectReason() const
Definition: validation.h:109
constexpr bool IsNull() const
Definition: uint256.h:49
Block template interface.
Definition: mining.h:32
Interface giving clients (wallet processes, maybe other analysis tools in the future) ability to acce...
Definition: chain.h:118
External signer interface used by the GUI.
Definition: node.h:61
Helper for findBlock to selectively return pieces of block data.
Definition: chain.h:53
Generic interface for managing an event handler or callback function registered with another interfac...
Definition: handler.h:23
Interface giving clients (RPC, Stratum v2 Template Provider in the future) ability to create block te...
Definition: mining.h:97
Top-level interface for a bitcoin node (bitcoind process).
Definition: node.h:71
Interface giving clients ability to emulate HTTP RPC calls.
Definition: rpc.h:20
Wallet chain client that in addition to having chain client methods for starting up,...
Definition: wallet.h:316
Generate a new block, without valid proof-of-work.
Definition: miner.h:61
std::unique_ptr< CBlockTemplate > CreateNewBlock()
Construct a new block template.
Definition: miner.cpp:122
256-bit opaque blob.
Definition: uint256.h:196
static const uint256 ZERO
Definition: uint256.h:204
Helper class that manages an interrupt flag, and allows a thread or signal to interrupt another threa...
std::vector< uint256 > TransactionMerklePath(const CBlock &block, uint32_t position)
Compute merkle path to the specified transaction.
Definition: merkle.cpp:172
RecursiveMutex cs_main
Mutex to guard access to validation specific variables, such as reading or changing the chainstate.
Definition: cs_main.cpp:8
static CService ip(uint32_t i)
UniValue ExecuteHTTPRPC(const UniValue &valRequest, JSONRPCRequest &jreq, HTTPStatusCode &status)
Execute a single HTTP request containing one or more JSONRPC requests.
Definition: httprpc.cpp:103
void InitLogging(const ArgsManager &args)
Initialize global loggers.
Definition: init.cpp:853
bool AppInitBasicSetup(const ArgsManager &args, std::atomic< int > &exit_status)
Initialize bitcoin core: Basic context setup.
Definition: init.cpp:882
bool ShutdownRequested(node::NodeContext &node)
Return whether node shutdown was requested.
Definition: init.cpp:250
bool AppInitParameterInteraction(const ArgsManager &args)
Initialization: parameter interaction.
Definition: init.cpp:919
bool AppInitInterfaces(NodeContext &node)
Initialize node and wallet interface pointers.
Definition: init.cpp:1207
void InitParameterInteraction(ArgsManager &args)
Parameter interaction: change current parameters depending on various rules.
Definition: init.cpp:764
bool AppInitMain(NodeContext &node, interfaces::BlockAndHeaderTipInfo *tip_info)
Bitcoin core main initialization.
Definition: init.cpp:1421
bool AppInitLockDirectories()
Lock bitcoin core critical directories.
Definition: init.cpp:1195
bool AppInitSanityChecks(const kernel::Context &kernel)
Initialization sanity checks.
Definition: init.cpp:1176
CClientUIInterface uiInterface
void InitWarning(const bilingual_str &str)
Show warning message.
bool InitError(const bilingual_str &str)
Show error message.
#define LogError(...)
Definition: log.h:99
BCLog::Logger & LogInstance()
Definition: logging.cpp:26
void StartMapPort(bool enable)
Definition: mapport.cpp:137
MemPoolRemovalReason
Reason why a transaction was removed from the mempool, this is passed to the notification signal.
unsigned int nonce
Definition: miner_tests.cpp:82
uint64_t CategoryMask
Definition: categories.h:12
auto FindKey(Map &&map, Key &&key) -> decltype(&map.at(key))
Map lookup helper.
Definition: settings.h:107
std::unique_ptr< Node > MakeNode(node::NodeContext &context)
Return implementation of Node interface.
std::unique_ptr< Handler > MakeSignalHandler(boost::signals2::connection connection)
Return handler wrapping a boost signal connection.
Definition: interfaces.cpp:47
std::unique_ptr< Rpc > MakeRpc(node::NodeContext &node)
Return implementation of Rpc interface.
std::unique_ptr< Mining > MakeMining(node::NodeContext &node, bool wait_loaded=true)
Return implementation of Mining interface.
SettingsAction
The action to be taken after updating a settings value.
Definition: chain.h:86
std::unique_ptr< Chain > MakeChain(node::NodeContext &node)
Return implementation of Chain interface.
std::function< std::optional< interfaces::SettingsAction >(common::SettingsValue &)> SettingsUpdate
Definition: chain.h:91
interfaces::BlockInfo MakeBlockInfo(const CBlockIndex *index, const CBlock *data)
Return data from block index.
Definition: chain.cpp:18
Definition: messages.h:21
void FindCoins(const NodeContext &node, std::map< COutPoint, Coin > &coins)
Look up unspent output information.
Definition: coin.cpp:12
std::optional< BlockRef > WaitTipChanged(ChainstateManager &chainman, KernelNotifications &kernel_notifications, const uint256 &current_tip, MillisecondsDouble &timeout, bool &interrupt)
Definition: miner.cpp:492
TxBroadcast
How to broadcast a local transaction.
Definition: types.h:165
@ MEMPOOL_AND_BROADCAST_TO_ALL
Add the transaction to the mempool and broadcast to all peers for which tx relay is enabled.
TransactionError
Definition: types.h:28
util::Result< void > ApplyArgsManOptions(const ArgsManager &args, BlockManager::Options &opts)
std::unique_ptr< CBlockTemplate > WaitAndCreateNewBlock(ChainstateManager &chainman, KernelNotifications &kernel_notifications, CTxMemPool *mempool, const std::unique_ptr< CBlockTemplate > &block_template, const BlockWaitOptions &options, const BlockAssembler::Options &assemble_options, bool &interrupt_wait)
Return a new block template when fees rise to a certain threshold or after a new tip; return nullopt ...
Definition: miner.cpp:361
TransactionError BroadcastTransaction(NodeContext &node, const CTransactionRef tx, std::string &err_string, const CAmount &max_tx_fee, TxBroadcast broadcast_method, bool wait_callback)
Submit a transaction to the mempool and (optionally) relay it to all P2P peers.
Definition: transaction.cpp:32
void InterruptWait(KernelNotifications &kernel_notifications, bool &interrupt_wait)
Definition: miner.cpp:354
void AddMerkleRootAndCoinbase(CBlock &block, CTransactionRef coinbase, uint32_t version, uint32_t timestamp, uint32_t nonce)
Definition: miner.cpp:336
bool CooldownIfHeadersAhead(ChainstateManager &chainman, KernelNotifications &kernel_notifications, const BlockRef &last_tip, bool &interrupt_mining)
Wait while the best known header extends the current chain tip AND at least one block is being added ...
Definition: miner.cpp:458
std::optional< BlockRef > GetTip(ChainstateManager &chainman)
Definition: miner.cpp:450
Definition: common.h:29
auto Join(const C &container, const S &separator, UnaryOp unary_op)
Join all container items.
Definition: string.h:206
int64_t NodeId
Definition: net.h:103
std::map< CSubNet, CBanEntry > banmap_t
Definition: net_types.h:41
Network
A network type.
Definition: netaddress.h:33
std::optional< Proxy > GetProxy(enum Network net)
Definition: netbase.cpp:709
ConnectionDirection
Definition: netbase.h:34
ValidationSignals & m_signals
Definition: interfaces.cpp:505
::ExternalSigner m_signer
Definition: interfaces.cpp:104
bool m_interrupt_mining
const BlockAssembler::Options m_assemble_options
Definition: interfaces.cpp:928
NodeContext & m_node
Definition: interfaces.cpp:865
NodeContext * m_context
Definition: interfaces.cpp:433
std::shared_ptr< Chain::Notifications > m_notifications
Definition: interfaces.cpp:486
CRPCCommand m_command
Definition: interfaces.cpp:544
bool m_interrupt_wait
Definition: interfaces.cpp:932
const CRPCCommand * m_wrapped_command
Definition: interfaces.cpp:545
const std::unique_ptr< CBlockTemplate > m_block_template
Definition: interfaces.cpp:930
std::shared_ptr< NotificationsProxy > m_proxy
Definition: interfaces.cpp:506
is a home for public enum and struct type definitions that are used internally by node code,...
RBFTransactionState IsRBFOptInEmptyMempool(const CTransaction &tx)
Definition: rbf.cpp:52
RBFTransactionState IsRBFOptIn(const CTransaction &tx, const CTxMemPool &pool)
Determine whether an unconfirmed transaction is signaling opt-in to RBF according to BIP 125 This inv...
Definition: rbf.cpp:24
RBFTransactionState
The rbf state of unconfirmed transactions.
Definition: rbf.h:29
static constexpr unsigned int DEFAULT_INCREMENTAL_RELAY_FEE
Default for -incrementalrelayfee, which sets the minimum feerate increase for mempool limiting or rep...
Definition: policy.h:48
static constexpr unsigned int DUST_RELAY_TX_FEE
Min feerate for defining dust.
Definition: policy.h:68
static constexpr unsigned int MINIMUM_BLOCK_RESERVED_WEIGHT
This accounts for the block header, var_int encoding of the transaction count and a minimally viable ...
Definition: policy.h:34
static constexpr unsigned int DEFAULT_MIN_RELAY_TX_FEE
Default for -minrelaytxfee, minimum relay fee for transactions.
Definition: policy.h:70
std::shared_ptr< const CTransaction > CTransactionRef
Definition: transaction.h:403
const char * name
Definition: rest.cpp:49
HTTPStatusCode
HTTP status codes.
Definition: protocol.h:11
@ RPC_WALLET_NOT_FOUND
Invalid wallet specified.
Definition: protocol.h:80
bool IsDeprecatedRPCEnabled(const std::string &method)
Definition: server.cpp:339
CRPCTable tableRPC
Definition: server.cpp:544
Describes a place in the block chain to another node such that if the other node doesn't have the sam...
Definition: block.h:117
const CTransactionRef m_tx
Bilingual messages:
Definition: translation.h:24
Stored settings.
Definition: settings.h:32
std::map< std::string, SettingsValue > rw_settings
Map of setting name to read-write file setting value.
Definition: settings.h:38
std::map< std::string, std::vector< SettingsValue > > command_line_options
Map of setting name to list of command line values.
Definition: settings.h:36
Block and header tip information.
Definition: node.h:51
Hash/height pair to help track and identify blocks.
Definition: types.h:13
Block tip (could be a header or not, depends on the subscribed signal).
Definition: node.h:276
Information about chainstate that notifications are sent from.
Definition: types.h:18
Options struct containing limit options for a CTxMemPool.
bool check_pow
Set false to omit the proof-of-work check.
Definition: types.h:111
bool check_merkle_root
Set false to omit the merkle root check.
Definition: types.h:106
Template containing all coinbase transaction fields that are set by our miner code.
Definition: types.h:119
NodeContext struct containing references to chain state and connection state.
Definition: context.h:56
std::unique_ptr< KernelNotifications > notifications
Issues blocking calls about sync status, errors and warnings.
Definition: context.h:86
util::SignalInterrupt * shutdown_signal
Interrupt object used to track whether node shutdown was requested.
Definition: context.h:65
Definition: musig.c:31
#define WAIT_LOCK(cs, name)
Definition: sync.h:274
#define LOCK2(cs1, cs2)
Definition: sync.h:269
#define REVERSE_LOCK(g, cs)
Definition: sync.h:254
#define LOCK(cs)
Definition: sync.h:268
#define WITH_LOCK(cs, code)
Run code while locking a mutex.
Definition: sync.h:299
#define TRY_LOCK(cs, name)
Definition: sync.h:273
#define EXCLUSIVE_LOCKS_REQUIRED(...)
Definition: threadsafety.h:49
#define strprintf
Format arguments and return the string or write to given std::ostream (see tinyformat::format doc for...
Definition: tinyformat.h:1172
bilingual_str Untranslated(std::string original)
Mark a bilingual_str as untranslated.
Definition: translation.h:82
std::chrono::duration< double, std::chrono::milliseconds::period > MillisecondsDouble
Definition: time.h:102
BlockValidationState TestBlockValidity(Chainstate &chainstate, const CBlock &block, const bool check_pow, const bool check_merkle_root)
Verify a block, including transactions.
assert(!tx.IsCoinBase())
SynchronizationState
Current sync state passed to tip changed callbacks.
Definition: validation.h:93
TipBlock getTip(const CChainParams &params, const node::NodeContext &context)