Bitcoin ABC 0.32.12
P2P Digital Currency
interfaces.cpp
Go to the documentation of this file.
1// Copyright (c) 2018 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 <chain.h>
8#include <chainparams.h>
9#include <common/args.h>
10#include <config.h>
11#include <init.h>
12#include <interfaces/chain.h>
13#include <interfaces/handler.h>
14#include <interfaces/node.h>
15#include <interfaces/wallet.h>
17#include <mapport.h>
18#include <net.h>
19#include <net_processing.h>
20#include <netaddress.h>
21#include <netbase.h>
22#include <node/blockstorage.h>
23#include <node/coin.h>
24#include <node/context.h>
25#include <node/transaction.h>
26#include <node/types.h>
27#include <node/ui_interface.h>
28#include <policy/settings.h>
29#include <primitives/block.h>
31#include <rpc/blockchain.h>
32#include <rpc/protocol.h>
33#include <rpc/server.h>
34#include <shutdown.h>
35#include <sync.h>
36#include <txmempool.h>
37#include <uint256.h>
38#include <util/check.h>
39#include <util/translation.h>
40#include <validation.h>
41#include <validationinterface.h>
42#include <warnings.h>
43
44#if defined(HAVE_CONFIG_H)
45#include <config/bitcoin-config.h>
46#endif
47
48#include <univalue.h>
49
50#include <boost/signals2/signal.hpp>
51
52#include <memory>
53#include <utility>
54
56
64
65namespace node {
66namespace {
67
68 class NodeImpl : public Node {
69 private:
70 ChainstateManager &chainman() { return *Assert(m_context->chainman); }
71
72 public:
73 explicit NodeImpl(NodeContext *context) { setContext(context); }
74 void initLogging() override { InitLogging(*Assert(m_context->args)); }
75 void initParameterInteraction() override {
77 }
78 bilingual_str getWarnings() override { return GetWarnings(true); }
79 int getExitStatus() override {
80 return Assert(m_context)->exit_status.load();
81 }
82 bool baseInitialize(Config &config) override {
83 if (!AppInitBasicSetup(gArgs, Assert(context())->exit_status)) {
84 return false;
85 }
86 if (!AppInitParameterInteraction(config, gArgs)) {
87 return false;
88 }
89
90 m_context->kernel = std::make_unique<kernel::Context>();
91 if (!AppInitSanityChecks(*m_context->kernel)) {
92 return false;
93 }
94
96 return false;
97 }
99 return false;
100 }
101
102 return true;
103 }
104 bool appInitMain(Config &config, RPCServer &rpcServer,
105 HTTPRPCRequestProcessor &httpRPCRequestProcessor,
106 interfaces::BlockAndHeaderTipInfo *tip_info) override {
107 if (AppInitMain(config, rpcServer, httpRPCRequestProcessor,
108 *m_context, tip_info)) {
109 return true;
110 }
111 // Error during initialization, set exit status before continue
112 m_context->exit_status.store(EXIT_FAILURE);
113 return false;
114 }
115 void appShutdown() override {
118 }
119 void startShutdown() override {
121 // Stop RPC for clean shutdown if any of waitfor* commands is
122 // executed.
123 if (gArgs.GetBoolArg("-server", false)) {
124 InterruptRPC();
125 StopRPC();
126 }
127 }
128 bool shutdownRequested() override { return ShutdownRequested(); }
129 bool isPersistentSettingIgnored(const std::string &name) override {
130 bool ignored = false;
131 gArgs.LockSettings([&](util::Settings &settings) {
132 if (auto *options =
134 ignored = !options->empty();
135 }
136 });
137 return ignored;
138 }
140 getPersistentSetting(const std::string &name) override {
142 }
143 void updateRwSetting(const std::string &name,
144 const util::SettingsValue &value) override {
145 gArgs.LockSettings([&](util::Settings &settings) {
146 if (value.isNull()) {
147 settings.rw_settings.erase(name);
148 } else {
149 settings.rw_settings[name] = value;
150 }
151 });
153 }
154 void forceSetting(const std::string &name,
155 const util::SettingsValue &value) override {
156 gArgs.LockSettings([&](util::Settings &settings) {
157 if (value.isNull()) {
158 settings.forced_settings.erase(name);
159 } else {
160 settings.forced_settings[name] = value;
161 }
162 });
163 }
164 void resetSettings() override {
165 gArgs.WriteSettingsFile(/*errors=*/nullptr, /*backup=*/true);
166 gArgs.LockSettings([&](util::Settings &settings) {
167 settings.rw_settings.clear();
168 });
170 }
171 void mapPort(bool use_upnp, bool use_natpmp) override {
172 StartMapPort(use_upnp, use_natpmp);
173 }
174 bool getProxy(Network net, Proxy &proxy_info) override {
175 return GetProxy(net, proxy_info);
176 }
177 size_t getNodeCount(ConnectionDirection flags) override {
178 return m_context->connman ? m_context->connman->GetNodeCount(flags)
179 : 0;
180 }
181 bool getNodesStats(NodesStats &stats) override {
182 stats.clear();
183
184 if (m_context->connman) {
185 std::vector<CNodeStats> stats_temp;
186 m_context->connman->GetNodeStats(stats_temp);
187
188 stats.reserve(stats_temp.size());
189 for (auto &node_stats_temp : stats_temp) {
190 stats.emplace_back(std::move(node_stats_temp), false,
192 }
193
194 // Try to retrieve the CNodeStateStats for each node.
195 if (m_context->peerman) {
196 TRY_LOCK(::cs_main, lockMain);
197 if (lockMain) {
198 for (auto &node_stats : stats) {
199 std::get<1>(node_stats) =
200 m_context->peerman->GetNodeStateStats(
201 std::get<0>(node_stats).nodeid,
202 std::get<2>(node_stats));
203 }
204 }
205 }
206 return true;
207 }
208 return false;
209 }
210 bool getBanned(banmap_t &banmap) override {
211 if (m_context->banman) {
212 m_context->banman->GetBanned(banmap);
213 return true;
214 }
215 return false;
216 }
217 bool ban(const CNetAddr &net_addr, int64_t ban_time_offset) override {
218 if (m_context->banman) {
219 m_context->banman->Ban(net_addr, ban_time_offset);
220 return true;
221 }
222 return false;
223 }
224 bool unban(const CSubNet &ip) override {
225 if (m_context->banman) {
226 m_context->banman->Unban(ip);
227 return true;
228 }
229 return false;
230 }
231 bool disconnectByAddress(const CNetAddr &net_addr) override {
232 if (m_context->connman) {
233 return m_context->connman->DisconnectNode(net_addr);
234 }
235 return false;
236 }
237 bool disconnectById(NodeId id) override {
238 if (m_context->connman) {
239 return m_context->connman->DisconnectNode(id);
240 }
241 return false;
242 }
243 int64_t getTotalBytesRecv() override {
244 return m_context->connman ? m_context->connman->GetTotalBytesRecv()
245 : 0;
246 }
247 int64_t getTotalBytesSent() override {
248 return m_context->connman ? m_context->connman->GetTotalBytesSent()
249 : 0;
250 }
251 size_t getMempoolSize() override {
252 return m_context->mempool ? m_context->mempool->size() : 0;
253 }
254 size_t getMempoolDynamicUsage() override {
255 return m_context->mempool ? m_context->mempool->DynamicMemoryUsage()
256 : 0;
257 }
258 bool getHeaderTip(int &height, int64_t &block_time) override {
260 auto best_header = chainman().m_best_header;
261 if (best_header) {
262 height = best_header->nHeight;
263 block_time = best_header->GetBlockTime();
264 return true;
265 }
266 return false;
267 }
268 int getNumBlocks() override {
270 return chainman().ActiveChain().Height();
271 }
272 BlockHash getBestBlockHash() override {
273 const CBlockIndex *tip =
274 WITH_LOCK(::cs_main, return chainman().ActiveTip());
275 return tip ? tip->GetBlockHash()
276 : chainman().GetParams().GenesisBlock().GetHash();
277 }
278 int64_t getLastBlockTime() override {
280 if (chainman().ActiveChain().Tip()) {
281 return chainman().ActiveChain().Tip()->GetBlockTime();
282 }
283 // Genesis block's time of current network
284 return chainman().GetParams().GenesisBlock().GetBlockTime();
285 }
286 double getVerificationProgress() override {
287 const CBlockIndex *tip;
288 {
290 tip = chainman().ActiveChain().Tip();
291 }
292 return GuessVerificationProgress(chainman().GetParams().TxData(),
293 tip);
294 }
295 bool isInitialBlockDownload() override {
296 return chainman().IsInitialBlockDownload();
297 }
298 bool isLoadingBlocks() override {
299 return chainman().m_blockman.LoadingBlocks();
300 }
301 void setNetworkActive(bool active) override {
302 if (m_context->connman) {
303 m_context->connman->SetNetworkActive(active);
304 }
305 }
306 bool getNetworkActive() override {
307 return m_context->connman && m_context->connman->GetNetworkActive();
308 }
309 CFeeRate getDustRelayFee() override {
310 if (!m_context->mempool) {
312 }
313 return m_context->mempool->m_dust_relay_feerate;
314 }
315 UniValue executeRpc(const Config &config, const std::string &command,
316 const UniValue &params,
317 const std::string &uri) override {
318 JSONRPCRequest req;
319 req.context = m_context;
320 req.params = params;
321 req.strMethod = command;
322 req.URI = uri;
323 return ::tableRPC.execute(config, req);
324 }
325 std::vector<std::string> listRpcCommands() override {
327 }
328 void rpcSetTimerInterfaceIfUnset(RPCTimerInterface *iface) override {
330 }
331 void rpcUnsetTimerInterface(RPCTimerInterface *iface) override {
333 }
334 bool getUnspentOutput(const COutPoint &output, Coin &coin) override {
336 return chainman().ActiveChainstate().CoinsTip().GetCoin(output,
337 coin);
338 }
339 WalletClient &walletClient() override {
340 return *Assert(m_context->wallet_client);
341 }
342 std::unique_ptr<Handler> handleInitMessage(InitMessageFn fn) override {
343 return MakeHandler(::uiInterface.InitMessage_connect(fn));
344 }
345 std::unique_ptr<Handler> handleMessageBox(MessageBoxFn fn) override {
346 return MakeHandler(::uiInterface.ThreadSafeMessageBox_connect(fn));
347 }
348 std::unique_ptr<Handler> handleQuestion(QuestionFn fn) override {
349 return MakeHandler(::uiInterface.ThreadSafeQuestion_connect(fn));
350 }
351 std::unique_ptr<Handler>
352 handleShowProgress(ShowProgressFn fn) override {
353 return MakeHandler(::uiInterface.ShowProgress_connect(fn));
354 }
355 std::unique_ptr<Handler> handleNotifyNumConnectionsChanged(
356 NotifyNumConnectionsChangedFn fn) override {
357 return MakeHandler(
358 ::uiInterface.NotifyNumConnectionsChanged_connect(fn));
359 }
360 std::unique_ptr<Handler> handleNotifyNetworkActiveChanged(
361 NotifyNetworkActiveChangedFn fn) override {
362 return MakeHandler(
363 ::uiInterface.NotifyNetworkActiveChanged_connect(fn));
364 }
365 std::unique_ptr<Handler>
366 handleNotifyAlertChanged(NotifyAlertChangedFn fn) override {
367 return MakeHandler(::uiInterface.NotifyAlertChanged_connect(fn));
368 }
369 std::unique_ptr<Handler>
370 handleBannedListChanged(BannedListChangedFn fn) override {
371 return MakeHandler(::uiInterface.BannedListChanged_connect(fn));
372 }
373 std::unique_ptr<Handler>
374 handleNotifyBlockTip(NotifyBlockTipFn fn) override {
375 return MakeHandler(::uiInterface.NotifyBlockTip_connect(
376 [fn](SynchronizationState sync_state,
377 const CBlockIndex *block) {
378 fn(sync_state,
379 BlockTip{block->nHeight, block->GetBlockTime(),
380 block->GetBlockHash()},
381 GuessVerificationProgress(Params().TxData(), block));
382 }));
383 }
384 std::unique_ptr<Handler>
385 handleNotifyHeaderTip(NotifyHeaderTipFn fn) override {
386 /* verification progress is unused when a header was received */
387 return MakeHandler(::uiInterface.NotifyHeaderTip_connect(
388 [fn](SynchronizationState sync_state, int64_t height,
389 int64_t timestamp, bool presync) {
390 fn(sync_state,
391 BlockTip{int(height), timestamp, BlockHash{}}, presync);
392 }));
393 }
394 NodeContext *context() override { return m_context; }
395 void setContext(NodeContext *context) override { m_context = context; }
396 NodeContext *m_context{nullptr};
397 };
398
399 bool FillBlock(const CBlockIndex *index, const FoundBlock &block,
400 UniqueLock<RecursiveMutex> &lock, const CChain &active,
401 const BlockManager &blockman) {
402 if (!index) {
403 return false;
404 }
405 if (block.m_hash) {
406 *block.m_hash = index->GetBlockHash();
407 }
408 if (block.m_height) {
409 *block.m_height = index->nHeight;
410 }
411 if (block.m_time) {
412 *block.m_time = index->GetBlockTime();
413 }
414 if (block.m_max_time) {
415 *block.m_max_time = index->GetBlockTimeMax();
416 }
417 if (block.m_mtp_time) {
418 *block.m_mtp_time = index->GetMedianTimePast();
419 }
420 if (block.m_in_active_chain) {
421 *block.m_in_active_chain = active[index->nHeight] == index;
422 }
423 if (block.m_locator) {
424 *block.m_locator = GetLocator(index);
425 }
426 if (block.m_next_block) {
427 FillBlock(active[index->nHeight] == index
428 ? active[index->nHeight + 1]
429 : nullptr,
430 *block.m_next_block, lock, active, blockman);
431 }
432 if (block.m_data) {
433 REVERSE_LOCK(lock);
434 if (!blockman.ReadBlock(*block.m_data, *index)) {
435 block.m_data->SetNull();
436 }
437 }
438 return true;
439 }
440
441 class NotificationsProxy : public CValidationInterface {
442 public:
443 explicit NotificationsProxy(
444 std::shared_ptr<Chain::Notifications> notifications)
445 : m_notifications(std::move(notifications)) {}
446 virtual ~NotificationsProxy() = default;
447 void TransactionAddedToMempool(const CTransactionRef &tx,
448 std::shared_ptr<const std::vector<Coin>>,
449 uint64_t mempool_sequence) override {
450 m_notifications->transactionAddedToMempool(tx, mempool_sequence);
451 }
452 void TransactionRemovedFromMempool(const CTransactionRef &tx,
454 uint64_t mempool_sequence) override {
455 m_notifications->transactionRemovedFromMempool(tx, reason,
456 mempool_sequence);
457 }
458 void BlockConnected(ChainstateRole role,
459 const std::shared_ptr<const CBlock> &block,
460 const CBlockIndex *index) override {
461 m_notifications->blockConnected(role, *block, index->nHeight);
462 }
463 void BlockDisconnected(const std::shared_ptr<const CBlock> &block,
464 const CBlockIndex *index) override {
465 m_notifications->blockDisconnected(*block, index->nHeight);
466 }
467 void UpdatedBlockTip(const CBlockIndex *index,
468 const CBlockIndex *fork_index,
469 bool is_ibd) override {
470 m_notifications->updatedBlockTip();
471 }
472 void ChainStateFlushed(ChainstateRole role,
473 const CBlockLocator &locator) override {
474 m_notifications->chainStateFlushed(role, locator);
475 }
476 std::shared_ptr<Chain::Notifications> m_notifications;
477 };
478
479 class NotificationsHandlerImpl : public Handler {
480 public:
481 explicit NotificationsHandlerImpl(
482 std::shared_ptr<Chain::Notifications> notifications)
483 : m_proxy(std::make_shared<NotificationsProxy>(
484 std::move(notifications))) {
486 }
487 ~NotificationsHandlerImpl() override { disconnect(); }
488 void disconnect() override {
489 if (m_proxy) {
491 m_proxy.reset();
492 }
493 }
494 std::shared_ptr<NotificationsProxy> m_proxy;
495 };
496
497 class RpcHandlerImpl : public Handler {
498 public:
499 explicit RpcHandlerImpl(const CRPCCommand &command)
500 : m_command(command), m_wrapped_command(&command) {
501 m_command.actor = [this](const Config &config,
502 const JSONRPCRequest &request,
503 UniValue &result, bool last_handler) {
504 if (!m_wrapped_command) {
505 return false;
506 }
507 try {
508 return m_wrapped_command->actor(config, request, result,
509 last_handler);
510 } catch (const UniValue &e) {
511 // If this is not the last handler and a wallet not found
512 // exception was thrown, return false so the next handler
513 // can try to handle the request. Otherwise, reraise the
514 // exception.
515 if (!last_handler) {
516 const UniValue &code = e["code"];
517 if (code.isNum() &&
518 code.getInt<int>() == RPC_WALLET_NOT_FOUND) {
519 return false;
520 }
521 }
522 throw;
523 }
524 };
526 }
527
528 void disconnect() final {
529 if (m_wrapped_command) {
530 m_wrapped_command = nullptr;
532 }
533 }
534
535 ~RpcHandlerImpl() override { disconnect(); }
536
539 };
540
541 class ChainImpl : public Chain {
542 private:
543 ChainstateManager &chainman() { return *Assert(m_node.chainman); }
544
545 public:
546 explicit ChainImpl(NodeContext &node, const CChainParams &params)
547 : m_node(node), m_params(params) {}
548 std::optional<int> getHeight() override {
550 const CChain &active = Assert(m_node.chainman)->ActiveChain();
551 int height = active.Height();
552 if (height >= 0) {
553 return height;
554 }
555 return std::nullopt;
556 }
557 BlockHash getBlockHash(int height) override {
559 const CChain &active = Assert(m_node.chainman)->ActiveChain();
560 CBlockIndex *block = active[height];
561 assert(block);
562 return block->GetBlockHash();
563 }
564 bool haveBlockOnDisk(int height) override {
565 LOCK(cs_main);
566 const CChain &active = Assert(m_node.chainman)->ActiveChain();
567 CBlockIndex *block = active[height];
568 return block && (block->nStatus.hasData() != 0) && block->nTx > 0;
569 }
570 CBlockLocator getTipLocator() override {
571 LOCK(cs_main);
572 const CChain &active = Assert(m_node.chainman)->ActiveChain();
573 return active.GetLocator();
574 }
575 // TODO: backport core#25036 with changes from core#25717
576 std::optional<int>
577 findLocatorFork(const CBlockLocator &locator) override {
578 LOCK(cs_main);
579 const Chainstate &active =
580 Assert(m_node.chainman)->ActiveChainstate();
581 if (const CBlockIndex *fork =
582 active.FindForkInGlobalIndex(locator)) {
583 return fork->nHeight;
584 }
585 return std::nullopt;
586 }
587 bool findBlock(const BlockHash &hash,
588 const FoundBlock &block) override {
589 WAIT_LOCK(cs_main, lock);
590 const CChain &active = Assert(m_node.chainman)->ActiveChain();
591 return FillBlock(m_node.chainman->m_blockman.LookupBlockIndex(hash),
592 block, lock, active, chainman().m_blockman);
593 }
594 bool findFirstBlockWithTimeAndHeight(int64_t min_time, int min_height,
595 const FoundBlock &block) override {
596 WAIT_LOCK(cs_main, lock);
597 const CChain &active = Assert(m_node.chainman)->ActiveChain();
598 return FillBlock(active.FindEarliestAtLeast(min_time, min_height),
599 block, lock, active, chainman().m_blockman);
600 }
601 bool findAncestorByHeight(const BlockHash &block_hash,
602 int ancestor_height,
603 const FoundBlock &ancestor_out) override {
604 WAIT_LOCK(cs_main, lock);
605 const CChain &active = Assert(m_node.chainman)->ActiveChain();
606 if (const CBlockIndex *block =
607 m_node.chainman->m_blockman.LookupBlockIndex(block_hash)) {
608 if (const CBlockIndex *ancestor =
609 block->GetAncestor(ancestor_height)) {
610 return FillBlock(ancestor, ancestor_out, lock, active,
611 chainman().m_blockman);
612 }
613 }
614 return FillBlock(nullptr, ancestor_out, lock, active,
615 chainman().m_blockman);
616 }
617 bool findAncestorByHash(const BlockHash &block_hash,
618 const BlockHash &ancestor_hash,
619 const FoundBlock &ancestor_out) override {
620 WAIT_LOCK(cs_main, lock);
621 const CChain &active = Assert(m_node.chainman)->ActiveChain();
622 const CBlockIndex *block =
623 m_node.chainman->m_blockman.LookupBlockIndex(block_hash);
624 const CBlockIndex *ancestor =
625 m_node.chainman->m_blockman.LookupBlockIndex(ancestor_hash);
626 if (block && ancestor &&
627 block->GetAncestor(ancestor->nHeight) != ancestor) {
628 ancestor = nullptr;
629 }
630 return FillBlock(ancestor, ancestor_out, lock, active,
631 chainman().m_blockman);
632 }
633 bool findCommonAncestor(const BlockHash &block_hash1,
634 const BlockHash &block_hash2,
635 const FoundBlock &ancestor_out,
636 const FoundBlock &block1_out,
637 const FoundBlock &block2_out) override {
638 WAIT_LOCK(cs_main, lock);
639 const CChain &active = Assert(m_node.chainman)->ActiveChain();
640 const CBlockIndex *block1 =
641 m_node.chainman->m_blockman.LookupBlockIndex(block_hash1);
642 const CBlockIndex *block2 =
643 m_node.chainman->m_blockman.LookupBlockIndex(block_hash2);
644 const CBlockIndex *ancestor =
645 block1 && block2 ? LastCommonAncestor(block1, block2) : nullptr;
646 // Using & instead of && below to avoid short circuiting and leaving
647 // output uninitialized. Cast bool to int to avoid
648 // -Wbitwise-instead-of-logical compiler warnings.
649 return int{FillBlock(ancestor, ancestor_out, lock, active,
650 chainman().m_blockman)} &
651 int{FillBlock(block1, block1_out, lock, active,
652 chainman().m_blockman)} &
653 int{FillBlock(block2, block2_out, lock, active,
654 chainman().m_blockman)};
655 }
656 void findCoins(std::map<COutPoint, Coin> &coins) override {
657 return FindCoins(m_node, coins);
658 }
659 double guessVerificationProgress(const BlockHash &block_hash) override {
660 LOCK(cs_main);
662 chainman().GetParams().TxData(),
663 chainman().m_blockman.LookupBlockIndex(block_hash));
664 }
665 bool hasBlocks(const BlockHash &block_hash, int min_height,
666 std::optional<int> max_height) override {
667 // hasBlocks returns true if all ancestors of block_hash in
668 // specified range have block data (are not pruned), false if any
669 // ancestors in specified range are missing data.
670 //
671 // For simplicity and robustness, min_height and max_height are only
672 // used to limit the range, and passing min_height that's too low or
673 // max_height that's too high will not crash or change the result.
675 if (const CBlockIndex *block =
676 chainman().m_blockman.LookupBlockIndex(block_hash)) {
677 if (max_height && block->nHeight >= *max_height) {
678 block = block->GetAncestor(*max_height);
679 }
680 for (; block->nStatus.hasData(); block = block->pprev) {
681 // Check pprev to not segfault if min_height is too low
682 if (block->nHeight <= min_height || !block->pprev) {
683 return true;
684 }
685 }
686 }
687 return false;
688 }
689 bool broadcastTransaction(const Config &config,
690 const CTransactionRef &tx,
691 const Amount &max_tx_fee, bool relay,
692 std::string &err_string) override {
693 const TransactionError err =
694 BroadcastTransaction(m_node, tx, err_string, max_tx_fee, relay,
695 /*wait_callback=*/false);
696 // Chain clients only care about failures to accept the tx to the
697 // mempool. Disregard non-mempool related failures. Note: this will
698 // need to be updated if BroadcastTransactions() is updated to
699 // return other non-mempool failures that Chain clients do not need
700 // to know about.
701 return err == TransactionError::OK;
702 }
703 CFeeRate estimateFee() const override {
704 if (!m_node.mempool) {
705 return {};
706 }
707 return m_node.mempool->estimateFee();
708 }
709 CFeeRate relayMinFee() override {
710 if (!m_node.mempool) {
712 }
713 return m_node.mempool->m_min_relay_feerate;
714 }
715 CFeeRate relayDustFee() override {
716 if (!m_node.mempool) {
718 }
719 return m_node.mempool->m_dust_relay_feerate;
720 }
721 bool havePruned() override {
722 LOCK(cs_main);
723 return m_node.chainman->m_blockman.m_have_pruned;
724 }
725 bool isReadyToBroadcast() override {
726 return !chainman().m_blockman.LoadingBlocks() &&
727 !isInitialBlockDownload();
728 }
729 std::optional<int> getPruneHeight() override {
730 LOCK(chainman().GetMutex());
731 return GetPruneHeight(chainman().m_blockman,
732 chainman().ActiveChain());
733 }
734 bool isInitialBlockDownload() override {
735 return chainman().IsInitialBlockDownload();
736 }
737 bool shutdownRequested() override { return ShutdownRequested(); }
738 void initMessage(const std::string &message) override {
739 ::uiInterface.InitMessage(message);
740 }
741 void initWarning(const bilingual_str &message) override {
742 InitWarning(message);
743 }
744 void initError(const bilingual_str &message) override {
745 InitError(message);
746 }
747 void showProgress(const std::string &title, int progress,
748 bool resume_possible) override {
749 ::uiInterface.ShowProgress(title, progress, resume_possible);
750 }
751 std::unique_ptr<Handler> handleNotifications(
752 std::shared_ptr<Notifications> notifications) override {
753 return std::make_unique<NotificationsHandlerImpl>(
754 std::move(notifications));
755 }
756 void
757 waitForNotificationsIfTipChanged(const BlockHash &old_tip) override {
758 if (!old_tip.IsNull()) {
760 const CChain &active = Assert(m_node.chainman)->ActiveChain();
761 if (old_tip == active.Tip()->GetBlockHash()) {
762 return;
763 }
764 }
766 }
767
768 std::unique_ptr<Handler>
769 handleRpc(const CRPCCommand &command) override {
770 return std::make_unique<RpcHandlerImpl>(command);
771 }
772 bool rpcEnableDeprecated(const std::string &method) override {
773 return IsDeprecatedRPCEnabled(gArgs, method);
774 }
775 void rpcRunLater(const std::string &name, std::function<void()> fn,
776 int64_t seconds) override {
777 RPCRunLater(name, std::move(fn), seconds);
778 }
779 util::SettingsValue getSetting(const std::string &name) override {
780 return gArgs.GetSetting(name);
781 }
782 std::vector<util::SettingsValue>
783 getSettingsList(const std::string &name) override {
784 return gArgs.GetSettingsList(name);
785 }
786 util::SettingsValue getRwSetting(const std::string &name) override {
787 util::SettingsValue result;
788 gArgs.LockSettings([&](const util::Settings &settings) {
789 if (const util::SettingsValue *value =
790 util::FindKey(settings.rw_settings, name)) {
791 result = *value;
792 }
793 });
794 return result;
795 }
796 bool updateRwSetting(const std::string &name,
797 const util::SettingsValue &value,
798 bool write) override {
799 gArgs.LockSettings([&](util::Settings &settings) {
800 if (value.isNull()) {
801 settings.rw_settings.erase(name);
802 } else {
803 settings.rw_settings[name] = value;
804 }
805 });
806 return !write || gArgs.WriteSettingsFile();
807 }
808 void requestMempoolTransactions(Notifications &notifications) override {
809 if (!m_node.mempool) {
810 return;
811 }
812 LOCK2(::cs_main, m_node.mempool->cs);
813 for (const CTxMemPoolEntryRef &entry : m_node.mempool->mapTx) {
814 notifications.transactionAddedToMempool(entry->GetSharedTx(),
815 /*mempool_sequence=*/0);
816 }
817 }
818 bool hasAssumedValidChain() override {
819 return Assert(m_node.chainman)->IsSnapshotActive();
820 }
821 const CChainParams &params() const override { return m_params; }
822 NodeContext *context() override { return &m_node; }
823 NodeContext &m_node;
825 };
826} // namespace
827} // namespace node
828
829namespace interfaces {
830std::unique_ptr<Node> MakeNode(node::NodeContext *context) {
831 return std::make_unique<node::NodeImpl>(context);
832}
833std::unique_ptr<Chain> MakeChain(node::NodeContext &node,
834 const CChainParams &params) {
835 return std::make_unique<node::ChainImpl>(node, params);
836}
837} // namespace interfaces
ArgsManager gArgs
Definition: args.cpp:39
int flags
Definition: bitcoin-tx.cpp:546
std::optional< int > GetPruneHeight(const BlockManager &blockman, const CChain &chain)
Definition: blockchain.cpp:852
CBlockLocator GetLocator(const CBlockIndex *index)
Get a locator for a block index entry.
Definition: chain.cpp:41
const CBlockIndex * LastCommonAncestor(const CBlockIndex *pa, const CBlockIndex *pb)
Find the last common ancestor two blocks have.
Definition: chain.cpp:112
const CChainParams & Params()
Return the currently selected parameters.
Definition: chainparams.cpp:21
#define Assert(val)
Identity function.
Definition: check.h:84
util::SettingsValue GetPersistentSetting(const std::string &name) const
Get current setting from config file or read/write settings file, ignoring nonpersistent command line...
Definition: args.cpp:451
void LockSettings(Fn &&fn)
Access settings with lock held.
Definition: args.h:422
bool WriteSettingsFile(std::vector< std::string > *errors=nullptr, bool backup=false) const
Write settings file or backup settings file.
Definition: args.cpp:425
std::vector< util::SettingsValue > GetSettingsList(const std::string &arg) const
Get list of setting values.
Definition: args.cpp:829
util::SettingsValue GetSetting(const std::string &arg) const
Get setting value.
Definition: args.cpp:820
bool GetBoolArg(const std::string &strArg, bool fDefault) const
Return boolean argument or default value.
Definition: args.cpp:524
void SetNull()
Definition: block.h:82
The block chain is a tree shaped structure starting with the genesis block at the root,...
Definition: blockindex.h:25
CBlockIndex * pprev
pointer to the index of the predecessor of this block
Definition: blockindex.h:32
int64_t GetBlockTime() const
Definition: blockindex.h:160
int64_t GetMedianTimePast() const
Definition: blockindex.h:172
int64_t GetBlockTimeMax() const
Definition: blockindex.h:162
unsigned int nTx
Number of transactions in this block.
Definition: blockindex.h:55
CBlockIndex * GetAncestor(int height)
Efficiently find an ancestor of this block.
Definition: blockindex.cpp:62
BlockHash GetBlockHash() const
Definition: blockindex.h:130
int nHeight
height of the entry in the chain. The genesis block has height 0
Definition: blockindex.h:38
An in-memory indexed chain of blocks.
Definition: chain.h:138
CBlockIndex * Tip() const
Returns the index entry for the tip of this chain, or nullptr if none.
Definition: chain.h:154
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:62
int Height() const
Return the maximal height in the chain.
Definition: chain.h:190
CBlockLocator GetLocator() const
Return a CBlockLocator that refers to the tip of this chain.
Definition: chain.cpp:45
CChainParams defines various tweakable parameters of a given instance of the Bitcoin system.
Definition: chainparams.h:86
Fee rate in satoshis per kilobyte: Amount / kB.
Definition: feerate.h:21
Network address.
Definition: netaddress.h:114
std::string name
Definition: server.h:176
Actor actor
Definition: server.h:177
bool removeCommand(const std::string &name, const CRPCCommand *pcmd)
Definition: server.cpp:338
std::vector< std::string > listCommands() const
Returns a list of registered commands.
Definition: server.cpp:626
UniValue execute(const Config &config, const JSONRPCRequest &request) const
Execute a method.
Definition: server.cpp:585
void appendCommand(const std::string &name, const CRPCCommand *pcmd)
Appends a CRPCCommand to the dispatch table.
Definition: server.cpp:330
Implement this to subscribe to events generated in validation.
Chainstate stores and provides an API to update our local knowledge of the current best chain.
Definition: validation.h:733
void ClearBlockIndexCandidates() EXCLUSIVE_LOCKS_REQUIRED(const CBlockIndex * FindForkInGlobalIndex(const CBlockLocator &locator) const EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Find the last common block of this chain and a locator.
Definition: validation.cpp:128
Provides an interface for creating and interacting with one or two chainstates: an IBD chainstate gen...
Definition: validation.h:1185
A UTXO entry.
Definition: coins.h:29
Definition: config.h:19
UniValue params
Definition: request.h:34
std::string strMethod
Definition: request.h:33
std::string URI
Definition: request.h:36
std::any context
Definition: request.h:39
Definition: netbase.h:67
Definition: rcu.h:85
Class for registering and managing all RPC calls.
Definition: server.h:40
RPC timer "driver".
Definition: server.h:100
bool isNull() const
Definition: univalue.h:104
Int getInt() const
Definition: univalue.h:157
bool isNum() const
Definition: univalue.h:109
Wrapper around std::unique_lock style lock for Mutex.
Definition: sync.h:168
bool IsNull() const
Definition: uint256.h:32
Interface giving clients (wallet processes, maybe other analysis tools in the future) ability to acce...
Definition: chain.h:136
Helper for findBlock to selectively return pieces of block data.
Definition: chain.h:55
const FoundBlock * m_next_block
Definition: chain.h:107
BlockHash * m_hash
Definition: chain.h:100
int64_t * m_max_time
Definition: chain.h:103
int64_t * m_time
Definition: chain.h:102
bool * m_in_active_chain
Definition: chain.h:105
int64_t * m_mtp_time
Definition: chain.h:104
CBlockLocator * m_locator
Definition: chain.h:106
Generic interface for managing an event handler or callback function registered with another interfac...
Definition: handler.h:22
Top-level interface for a bitcoin node (bitcoind process).
Definition: node.h:59
Wallet chain client that in addition to having chain client methods for starting up,...
Definition: wallet.h:304
RecursiveMutex cs_main
Mutex to guard access to validation specific variables, such as reading or changing the chainstate.
Definition: cs_main.cpp:7
int64_t NodeId
Definition: eviction.h:16
void Interrupt(NodeContext &node)
Interrupt threads.
Definition: init.cpp:209
void InitLogging(const ArgsManager &args)
Initialize global loggers.
Definition: init.cpp:1779
bool AppInitLockDataDirectory()
Lock bitcoin data directory.
Definition: init.cpp:2170
void Shutdown(NodeContext &node)
Definition: init.cpp:233
bool AppInitBasicSetup(const ArgsManager &args, std::atomic< int > &exit_status)
Initialize bitcoin: Basic context setup.
Definition: init.cpp:1806
bool AppInitMain(Config &config, RPCServer &rpcServer, HTTPRPCRequestProcessor &httpRPCRequestProcessor, NodeContext &node, interfaces::BlockAndHeaderTipInfo *tip_info)
Bitcoin main initialization.
Definition: init.cpp:2192
bool AppInitInterfaces(NodeContext &node)
Initialize node and wallet interface pointers.
Definition: init.cpp:2182
void InitParameterInteraction(ArgsManager &args)
Parameter interaction: change current parameters depending on various rules.
Definition: init.cpp:1645
bool AppInitParameterInteraction(Config &config, const ArgsManager &args)
Initialization: parameter interaction.
Definition: init.cpp:1848
bool AppInitSanityChecks(const kernel::Context &kernel)
Initialization sanity checks.
Definition: init.cpp:2154
ChainstateRole
This enum describes the various roles a specific Chainstate instance can take.
Definition: chain.h:14
void StartMapPort(bool use_upnp, bool use_natpmp)
Definition: mapport.cpp:363
std::unique_ptr< Handler > MakeHandler(boost::signals2::connection connection)
Return handler wrapping a boost signal connection.
Definition: handler.cpp:48
std::unique_ptr< Node > MakeNode(node::NodeContext *context)
Return implementation of Node interface.
Definition: interfaces.cpp:830
std::unique_ptr< Chain > MakeChain(node::NodeContext &node, const CChainParams &params)
Return implementation of Chain interface.
Definition: interfaces.cpp:833
Definition: messages.h:12
TransactionError BroadcastTransaction(const NodeContext &node, const CTransactionRef tx, std::string &err_string, const Amount max_tx_fee, bool relay, bool wait_callback)
Submit a transaction to the mempool and (optionally) relay it to all P2P peers.
Definition: transaction.cpp:38
TransactionError
Definition: types.h:17
void FindCoins(const NodeContext &node, std::map< COutPoint, Coin > &coins)
Look up unspent output information.
Definition: coin.cpp:12
Implement std::hash so RCUPtr can be used as a key for maps or sets.
Definition: rcu.h:259
auto FindKey(Map &&map, Key &&key) -> decltype(&map.at(key))
Map lookup helper.
Definition: settings.h:115
std::map< CSubNet, CBanEntry > banmap_t
Definition: net_types.h:13
Network
A network type.
Definition: netaddress.h:37
bool GetProxy(enum Network net, Proxy &proxyInfoOut)
Definition: netbase.cpp:812
ConnectionDirection
Definition: netbase.h:37
NodeContext & m_node
Definition: interfaces.cpp:823
NodeContext * m_context
Definition: interfaces.cpp:396
std::shared_ptr< Chain::Notifications > m_notifications
Definition: interfaces.cpp:476
CRPCCommand m_command
Definition: interfaces.cpp:537
const CChainParams & m_params
Definition: interfaces.cpp:824
const CRPCCommand * m_wrapped_command
Definition: interfaces.cpp:538
std::shared_ptr< NotificationsProxy > m_proxy
Definition: interfaces.cpp:494
is a home for public enum and struct type definitions that are used by internally by node code,...
static constexpr Amount DUST_RELAY_TX_FEE(1000 *SATOSHI)
Min feerate for defining dust.
static constexpr Amount DEFAULT_MIN_RELAY_TX_FEE_PER_KB(1000 *SATOSHI)
Default for -minrelaytxfee, minimum relay fee for transactions.
std::shared_ptr< const CTransaction > CTransactionRef
Definition: transaction.h:315
const char * name
Definition: rest.cpp:47
@ RPC_WALLET_NOT_FOUND
Invalid wallet specified.
Definition: protocol.h:109
void RPCSetTimerInterfaceIfUnset(RPCTimerInterface *iface)
Set the factory function for timer, but only, if unset.
Definition: server.cpp:652
bool IsDeprecatedRPCEnabled(const ArgsManager &args, const std::string &method)
Definition: server.cpp:410
void RPCUnsetTimerInterface(RPCTimerInterface *iface)
Unset factory function for timers.
Definition: server.cpp:662
void RPCRunLater(const std::string &name, std::function< void()> func, int64_t nSeconds)
Run func nSeconds from now.
Definition: server.cpp:668
void StopRPC()
Definition: server.cpp:368
void InterruptRPC()
Definition: server.cpp:357
CRPCTable tableRPC
Definition: server.cpp:683
bool ShutdownRequested()
Returns true if a shutdown is requested, false otherwise.
Definition: shutdown.cpp:29
void StartShutdown()
Request shutdown of the application.
Definition: shutdown.cpp:16
Definition: amount.h:21
A BlockHash is a unqiue identifier for a block.
Definition: blockhash.h:13
Describes a place in the block chain to another node such that if the other node doesn't have the sam...
Definition: block.h:108
Bilingual messages:
Definition: translation.h:17
Block and header tip information.
Definition: node.h:50
Block tip (could be a header or not, depends on the subscribed signal).
Definition: node.h:273
NodeContext struct containing references to chain state and connection state.
Definition: context.h:48
Stored settings.
Definition: settings.h:31
std::map< std::string, SettingsValue > rw_settings
Map of setting name to read-write file setting value.
Definition: settings.h:37
std::map< std::string, std::vector< SettingsValue > > command_line_options
Map of setting name to list of command line values.
Definition: settings.h:35
#define WAIT_LOCK(cs, name)
Definition: sync.h:317
#define LOCK2(cs1, cs2)
Definition: sync.h:309
#define LOCK(cs)
Definition: sync.h:306
#define WITH_LOCK(cs, code)
Run code while locking a mutex.
Definition: sync.h:357
#define TRY_LOCK(cs, name)
Definition: sync.h:314
#define REVERSE_LOCK(g)
Definition: sync.h:265
MemPoolRemovalReason
Reason why a transaction was removed from the mempool, this is passed to the notification signal.
Definition: txmempool.h:158
CClientUIInterface uiInterface
void InitWarning(const bilingual_str &str)
Show warning message.
bool InitError(const bilingual_str &str)
Show error message.
double GuessVerificationProgress(const ChainTxData &data, const CBlockIndex *pindex)
Guess how far we are in the verification process at the given block index require cs_main if pindex h...
assert(!tx.IsCoinBase())
SynchronizationState
Current sync state passed to tip changed callbacks.
Definition: validation.h:118
void UnregisterSharedValidationInterface(std::shared_ptr< CValidationInterface > callbacks)
Unregister subscriber.
void SyncWithValidationInterfaceQueue()
This is a synonym for the following, which asserts certain locks are not held: std::promise<void> pro...
void RegisterSharedValidationInterface(std::shared_ptr< CValidationInterface > callbacks)
Register subscriber.
bilingual_str GetWarnings(bool verbose)
Format a string that describes several potential problems detected by the core.
Definition: warnings.cpp:43