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