Bitcoin Core 32.99.0
P2P Digital Currency
bitcoinkernel.cpp
Go to the documentation of this file.
1// Copyright (c) 2022-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#define BITCOINKERNEL_BUILD
6
8
9#include <attributes.h>
10#include <chain.h>
11#include <coins.h>
12#include <consensus/tx_check.h>
14#include <dbwrapper.h>
15#include <kernel/caches.h>
16#include <kernel/chainparams.h>
17#include <kernel/checks.h>
18#include <kernel/context.h>
20#include <kernel/warning.h>
21#include <node/blockstorage.h>
22#include <node/chainstate.h>
23#include <primitives/block.h>
25#include <script/interpreter.h>
26#include <script/script.h>
27#include <script/verify_flags.h>
28#include <serialize.h>
29#include <streams.h>
30#include <sync.h>
31#include <uint256.h>
32#include <undo.h>
33#include <util/check.h>
34#include <util/fs.h>
35#include <util/log.h>
36#include <util/result.h>
38#include <util/stdmutex.h>
39#include <util/string.h>
40#include <util/task_runner.h>
41#include <util/time.h>
42#include <util/translation.h>
43#include <validation.h>
44#include <validationinterface.h>
45
46#include <atomic>
47#include <cstddef>
48#include <cstring>
49#include <exception>
50#include <iterator>
51#include <limits>
52#include <list>
53#include <memory>
54#include <optional>
55#include <span>
56#include <stdexcept>
57#include <string>
58#include <string_view>
59#include <tuple>
60#include <utility>
61#include <vector>
62
63namespace Consensus {
64struct Params;
65} // namespace Consensus
66
69
70// Define G_TRANSLATION_FUN symbol in libbitcoinkernel library so users of the
71// library aren't required to export this symbol
72extern const TranslateFn G_TRANSLATION_FUN{nullptr};
73
75
76namespace {
77
78bool is_valid_flag_combination(script_verify_flags flags)
79{
81 if (flags & SCRIPT_VERIFY_WITNESS && ~flags & SCRIPT_VERIFY_P2SH) return false;
82 return true;
83}
84
85class WriterStream
86{
87private:
88 btck_WriteBytes m_writer;
89 void* m_user_data;
90
91public:
92 WriterStream(btck_WriteBytes writer, void* user_data)
93 : m_writer{writer}, m_user_data{user_data} {}
94
95 //
96 // Stream subset
97 //
98 void write(std::span<const std::byte> src)
99 {
100 if (m_writer(src.data(), src.size(), m_user_data) != 0) {
101 throw std::runtime_error("Failed to write serialization data");
102 }
103 }
104
105 template <typename T>
106 WriterStream& operator<<(const T& obj)
107 {
108 ::Serialize(*this, obj);
109 return *this;
110 }
111};
112
113template <typename C, typename CPP>
114struct Handle {
115 static C* ref(CPP* cpp_type)
116 {
117 return reinterpret_cast<C*>(cpp_type);
118 }
119
120 static const C* ref(const CPP* cpp_type)
121 {
122 return reinterpret_cast<const C*>(cpp_type);
123 }
124
125 template <typename... Args>
126 static C* create(Args&&... args)
127 {
128 auto cpp_obj{std::make_unique<CPP>(std::forward<Args>(args)...)};
129 return ref(cpp_obj.release());
130 }
131
132 static C* copy(const C* ptr)
133 {
134 auto cpp_obj{std::make_unique<CPP>(get(ptr))};
135 return ref(cpp_obj.release());
136 }
137
138 static const CPP& get(const C* ptr)
139 {
140 return *reinterpret_cast<const CPP*>(ptr);
141 }
142
143 static CPP& get(C* ptr)
144 {
145 return *reinterpret_cast<CPP*>(ptr);
146 }
147
148 static void operator delete(void* ptr)
149 {
150 delete reinterpret_cast<CPP*>(ptr);
151 }
152};
153
154} // namespace
155
156struct btck_BlockTreeEntry: Handle<btck_BlockTreeEntry, CBlockIndex> {};
157struct btck_Block : Handle<btck_Block, std::shared_ptr<const CBlock>> {};
158struct btck_BlockValidationState : Handle<btck_BlockValidationState, BlockValidationState> {};
159struct btck_TxValidationState : Handle<btck_TxValidationState, TxValidationState> {};
160
161namespace {
162
163constexpr util::log::Level to_util(btck_LogLevel level)
164{
165 switch (level) {
166 case btck_LogLevel_TRACE: {
168 }
169 case btck_LogLevel_DEBUG: {
171 }
172 case btck_LogLevel_INFO: {
174 }
177 }
178 case btck_LogLevel_ERROR: {
180 }
181 }
182 assert(false);
183}
184
186{
187 switch (state) {
194 } // no default case, so the compiler can warn about missing cases
195 assert(false);
196}
197
198btck_Warning cast_btck_warning(kernel::Warning warning)
199{
200 switch (warning) {
205 } // no default case, so the compiler can warn about missing cases
206 assert(false);
207}
208
209constexpr btck_LogLevel to_btck(util::log::Level level)
210{
211 switch (level) {
213 return btck_LogLevel_TRACE;
214 }
216 return btck_LogLevel_DEBUG;
217 }
219 return btck_LogLevel_INFO;
220 }
223 }
225 return btck_LogLevel_ERROR;
226 }
227 } // no default case, so the compiler can warn about missing cases
228 assert(false);
229}
230
231constexpr btck_LogCategory to_btck(BCLog::LogFlags flag)
232{
233 switch (flag) {
236 }
239 }
242 }
245 }
248 }
249#ifdef DEBUG_LOCKCONTENTION
252 }
253#endif
256 }
259 }
262 }
265 }
268 }
271 }
274 }
275 default: {
276 // Every category the kernel library can emit must be mapped above. This cannot be enforced
277 // at compile time, so abort in debug builds to catch it early, and deliver the entry as
278 // uncategorized otherwise.
279 Assume(false);
281 }
282 }
283}
284
285class KernelNotifications final : public kernel::Notifications
286{
287private:
289
290public:
291 KernelNotifications(btck_NotificationInterfaceCallbacks cbs)
292 : m_cbs{cbs}
293 {
294 }
295
296 ~KernelNotifications()
297 {
298 if (m_cbs.user_data && m_cbs.user_data_destroy) {
299 m_cbs.user_data_destroy(m_cbs.user_data);
300 }
301 m_cbs.user_data_destroy = nullptr;
302 m_cbs.user_data = nullptr;
303 }
304
305 kernel::InterruptResult blockTip(SynchronizationState state, const CBlockIndex& index, double verification_progress) override
306 {
307 if (m_cbs.block_tip) m_cbs.block_tip(m_cbs.user_data, cast_state(state), btck_BlockTreeEntry::ref(&index), verification_progress);
308 return {};
309 }
310 void headerTip(SynchronizationState state, int64_t height, int64_t timestamp, bool presync) override
311 {
312 if (m_cbs.header_tip) m_cbs.header_tip(m_cbs.user_data, cast_state(state), height, timestamp, presync ? 1 : 0);
313 }
314 void progress(const bilingual_str& title, int progress_percent, bool resume_possible) override
315 {
316 if (m_cbs.progress) m_cbs.progress(m_cbs.user_data, title.original.c_str(), title.original.length(), progress_percent, resume_possible ? 1 : 0);
317 }
318 void warningSet(kernel::Warning id, const bilingual_str& message) override
319 {
320 if (m_cbs.warning_set) m_cbs.warning_set(m_cbs.user_data, cast_btck_warning(id), message.original.c_str(), message.original.length());
321 }
322 void warningUnset(kernel::Warning id) override
323 {
324 if (m_cbs.warning_unset) m_cbs.warning_unset(m_cbs.user_data, cast_btck_warning(id));
325 }
326 void flushError(const bilingual_str& message) override
327 {
328 if (m_cbs.flush_error) m_cbs.flush_error(m_cbs.user_data, message.original.c_str(), message.original.length());
329 }
330 void fatalError(const bilingual_str& message) override
331 {
332 if (m_cbs.fatal_error) m_cbs.fatal_error(m_cbs.user_data, message.original.c_str(), message.original.length());
333 }
334};
335
336class KernelValidationInterface final : public CValidationInterface
337{
338public:
340
341 explicit KernelValidationInterface(const btck_ValidationInterfaceCallbacks vi_cbs) : m_cbs{vi_cbs} {}
342
343 ~KernelValidationInterface()
344 {
345 if (m_cbs.user_data && m_cbs.user_data_destroy) {
346 m_cbs.user_data_destroy(m_cbs.user_data);
347 }
348 m_cbs.user_data = nullptr;
349 m_cbs.user_data_destroy = nullptr;
350 }
351
352protected:
353 void BlockChecked(const std::shared_ptr<const CBlock>& block, const BlockValidationState& stateIn) override
354 {
355 if (m_cbs.block_checked) {
356 m_cbs.block_checked(m_cbs.user_data,
357 btck_Block::copy(btck_Block::ref(&block)),
358 btck_BlockValidationState::ref(&stateIn));
359 }
360 }
361
362 void NewPoWValidBlock(const CBlockIndex* pindex, const std::shared_ptr<const CBlock>& block) override
363 {
364 if (m_cbs.pow_valid_block) {
365 m_cbs.pow_valid_block(m_cbs.user_data,
366 btck_Block::copy(btck_Block::ref(&block)),
367 btck_BlockTreeEntry::ref(pindex));
368 }
369 }
370
371 void BlockConnected(const ChainstateRole& role, const std::shared_ptr<const CBlock>& block, const CBlockIndex* pindex) override
372 {
373 if (m_cbs.block_connected) {
374 m_cbs.block_connected(m_cbs.user_data,
375 btck_Block::copy(btck_Block::ref(&block)),
376 btck_BlockTreeEntry::ref(pindex));
377 }
378 }
379
380 void BlockDisconnected(const std::shared_ptr<const CBlock>& block, const CBlockIndex* pindex) override
381 {
382 if (m_cbs.block_disconnected) {
383 m_cbs.block_disconnected(m_cbs.user_data,
384 btck_Block::copy(btck_Block::ref(&block)),
385 btck_BlockTreeEntry::ref(pindex));
386 }
387 }
388};
389
390struct ContextOptions {
391 mutable Mutex m_mutex;
392 std::unique_ptr<const CChainParams> m_chainparams GUARDED_BY(m_mutex);
393 std::shared_ptr<KernelNotifications> m_notifications GUARDED_BY(m_mutex);
394 std::shared_ptr<KernelValidationInterface> m_validation_interface GUARDED_BY(m_mutex);
395};
396
397class Context
398{
399public:
400 std::unique_ptr<kernel::Context> m_context;
401
402 std::shared_ptr<KernelNotifications> m_notifications;
403
404 std::unique_ptr<util::SignalInterrupt> m_interrupt;
405
406 std::unique_ptr<ValidationSignals> m_signals;
407
408 std::unique_ptr<const CChainParams> m_chainparams;
409
410 std::shared_ptr<KernelValidationInterface> m_validation_interface;
411
412 Context(const ContextOptions* options, bool& sane)
413 : m_context{std::make_unique<kernel::Context>()},
414 m_interrupt{std::make_unique<util::SignalInterrupt>()}
415 {
416 if (options) {
417 LOCK(options->m_mutex);
418 if (options->m_chainparams) {
419 m_chainparams = std::make_unique<const CChainParams>(*options->m_chainparams);
420 }
421 if (options->m_notifications) {
422 m_notifications = options->m_notifications;
423 }
424 if (options->m_validation_interface) {
425 m_signals = std::make_unique<ValidationSignals>(std::make_unique<ImmediateTaskRunner>());
426 m_validation_interface = options->m_validation_interface;
427 m_signals->RegisterSharedValidationInterface(m_validation_interface);
428 }
429 }
430
431 if (!m_chainparams) {
432 m_chainparams = CChainParams::Main();
433 }
434 if (!m_notifications) {
435 m_notifications = std::make_shared<KernelNotifications>(btck_NotificationInterfaceCallbacks{
436 nullptr, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr});
437 }
438
440 sane = false;
441 }
442 }
443
444 ~Context()
445 {
446 if (m_signals) {
447 m_signals->UnregisterSharedValidationInterface(m_validation_interface);
448 }
449 }
450};
451
453struct ChainstateManagerOptions {
454 mutable Mutex m_mutex;
455 ChainstateManager::Options m_chainman_options GUARDED_BY(m_mutex);
456 node::BlockManager::Options m_blockman_options GUARDED_BY(m_mutex);
457 std::shared_ptr<const Context> m_context;
458 node::ChainstateLoadOptions m_chainstate_load_options GUARDED_BY(m_mutex);
459 uint64_t m_db_cache_bytes GUARDED_BY(m_mutex){DEFAULT_KERNEL_CACHE};
460
461 ChainstateManagerOptions(const std::shared_ptr<const Context>& context, const fs::path& data_dir, const fs::path& blocks_dir)
462 : m_chainman_options{ChainstateManager::Options{
463 .chainparams = *context->m_chainparams,
464 .datadir = data_dir,
465 .notifications = *context->m_notifications,
466 .signals = context->m_signals.get()}},
467 m_blockman_options{node::BlockManager::Options{
468 .chainparams = *context->m_chainparams,
469 .blocks_dir = blocks_dir,
470 .notifications = *context->m_notifications,
471 .block_tree_db_params = DBParams{
472 .path = data_dir / "blocks" / "index",
473 .cache_bytes = kernel::CacheSizes{DEFAULT_KERNEL_CACHE}.block_tree_db,
474 }}},
475 m_context{context}, m_chainstate_load_options{node::ChainstateLoadOptions{}}
476 {
477 }
478};
479
480struct ChainMan {
481 std::unique_ptr<ChainstateManager> m_chainman;
482 std::shared_ptr<const Context> m_context;
483
484 ChainMan(std::unique_ptr<ChainstateManager> chainman, std::shared_ptr<const Context> context)
485 : m_chainman(std::move(chainman)), m_context(std::move(context)) {}
486};
487
488struct UserDataDeleter {
489 btck_DestroyCallback destroy;
490 void operator()(void* user_data) const
491 {
492 if (destroy) destroy(user_data);
493 }
494};
496using UserData = std::unique_ptr<void, UserDataDeleter>;
497
500class KernelLogger
501{
503 struct Callback {
505 UserData user_data;
506
507 void operator()(const btck_LogEntry* entry) const { fn(user_data.get(), entry); }
508 };
509
510 mutable StdMutex m_mutex;
512 std::list<Callback> m_callbacks GUARDED_BY(m_mutex);
514 std::atomic<size_t> m_callback_count{0};
516 std::atomic<util::log::Level> m_min_level{util::log::Level::Info};
517
520 void UnregisterCallback(std::list<Callback>::iterator it) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex);
521
522public:
525 class CallbackHandle
526 {
527 KernelLogger* m_logger;
528 std::list<Callback>::iterator m_it;
529
530 public:
531 CallbackHandle(KernelLogger& logger LIFETIMEBOUND, std::list<Callback>::iterator it)
532 : m_logger{&logger}, m_it{it} {}
533 CallbackHandle(CallbackHandle&& other) noexcept
534 : m_logger{std::exchange(other.m_logger, nullptr)}, m_it{other.m_it} {}
535 CallbackHandle& operator=(CallbackHandle&&) = delete;
536 ~CallbackHandle()
537 {
538 if (m_logger) m_logger->UnregisterCallback(m_it);
539 }
540 };
541
543 [[nodiscard]] CallbackHandle RegisterCallback(btck_LogCallback fn, UserData user_data) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex);
545 void SetMinLevel(btck_LogLevel level)
546 {
547 m_min_level.store(to_util(level), std::memory_order_relaxed);
548 }
549
551 bool ShouldLog(util::log::Level level) const
552 {
553 return level >= m_min_level.load(std::memory_order_relaxed) &&
554 m_callback_count.load(std::memory_order_relaxed) > 0;
555 }
558 void Log(const util::log::Entry& entry) const EXCLUSIVE_LOCKS_REQUIRED(!m_mutex);
560 void MaybeLog(const util::log::Entry& entry) const EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
561 {
562 if (ShouldLog(entry.level)) {
563 Log(entry);
564 }
565 }
566};
567
568KernelLogger::CallbackHandle KernelLogger::RegisterCallback(btck_LogCallback fn, UserData user_data)
569{
570 // Construct before locking so that a failed push_back destroys user_data outside m_mutex.
571 Callback cb{fn, std::move(user_data)};
572 STDLOCK(m_mutex);
573 m_callbacks.push_back(std::move(cb));
574 m_callback_count.fetch_add(1, std::memory_order_relaxed);
575 return {*this, std::prev(m_callbacks.end())};
576}
577
578void KernelLogger::UnregisterCallback(std::list<Callback>::iterator it)
579{
580 // Avoid running the callback destructor while holding m_mutex.
581 std::list<Callback> dying;
582 {
583 STDLOCK(m_mutex);
584 dying.splice(dying.begin(), m_callbacks, it);
585 m_callback_count.fetch_sub(1, std::memory_order_relaxed);
586 }
587}
588
589void KernelLogger::Log(const util::log::Entry& entry) const
590{
591 // Some log statements are manually suffixed with a newline.
592 std::string_view message{util::RemoveSuffixView(entry.message, "\n")};
593 std::string_view thread_name{entry.thread_name};
594 const auto timestamp_ns{TicksSinceEpoch<std::chrono::nanoseconds>(entry.timestamp)};
595 std::string_view file_name{entry.source_loc.file_name()};
596 std::string_view function_name{entry.source_loc.function_name_short()};
597
598 btck_LogEntry btck_entry{
599 .message = message.data(),
600 .message_len = message.size(),
601 .thread_name = thread_name.data(),
602 .thread_name_len = thread_name.size(),
603 .timestamp_ns = timestamp_ns,
604 .mocktime_s = entry.mocktime.count(),
605 .file_name = file_name.data(),
606 .file_name_len = file_name.size(),
607 .function_name = function_name.data(),
608 .function_name_len = function_name.size(),
609 .line = entry.source_loc.line(),
610 .level = to_btck(entry.level),
611 .category = to_btck(static_cast<BCLog::LogFlags>(entry.category)),
612 };
613
614 STDLOCK(m_mutex);
615 for (const auto& callback : m_callbacks) {
616 try {
617 callback(&btck_entry);
618 } catch (...) {
619 // Can't log the error here because we're already inside the logging path (would
620 // deadlock on m_mutex).
621 }
622 }
623}
624
625} // namespace
626
627struct btck_Transaction : Handle<btck_Transaction, std::shared_ptr<const CTransaction>> {};
628struct btck_TransactionOutput : Handle<btck_TransactionOutput, CTxOut> {};
629struct btck_ScriptPubkey : Handle<btck_ScriptPubkey, CScript> {};
630struct btck_LoggingConnection : Handle<btck_LoggingConnection, KernelLogger::CallbackHandle> {};
631struct btck_ContextOptions : Handle<btck_ContextOptions, ContextOptions> {};
632struct btck_Context : Handle<btck_Context, std::shared_ptr<const Context>> {};
633struct btck_ChainParameters : Handle<btck_ChainParameters, CChainParams> {};
634struct btck_ChainstateManagerOptions : Handle<btck_ChainstateManagerOptions, ChainstateManagerOptions> {};
635struct btck_ChainstateManager : Handle<btck_ChainstateManager, ChainMan> {};
636struct btck_Chain : Handle<btck_Chain, CChain> {};
637struct btck_BlockSpentOutputs : Handle<btck_BlockSpentOutputs, std::shared_ptr<CBlockUndo>> {};
638struct btck_TransactionSpentOutputs : Handle<btck_TransactionSpentOutputs, CTxUndo> {};
639struct btck_Coin : Handle<btck_Coin, Coin> {};
640struct btck_BlockHash : Handle<btck_BlockHash, uint256> {};
641struct btck_TransactionInput : Handle<btck_TransactionInput, CTxIn> {};
642struct btck_WitnessStack : Handle<btck_WitnessStack, CScriptWitness> {};
643struct btck_TransactionOutPoint: Handle<btck_TransactionOutPoint, COutPoint> {};
644struct btck_Txid: Handle<btck_Txid, Txid> {};
645struct btck_Wtxid: Handle<btck_Wtxid, Wtxid> {};
646struct btck_PrecomputedTransactionData : Handle<btck_PrecomputedTransactionData, PrecomputedTransactionData> {};
647struct btck_BlockHeader: Handle<btck_BlockHeader, CBlockHeader> {};
648struct btck_ConsensusParams: Handle<btck_ConsensusParams, Consensus::Params> {};
649
650btck_Transaction* btck_transaction_create(const void* raw_transaction, size_t raw_transaction_len)
651{
652 assert(raw_transaction != nullptr || raw_transaction_len == 0);
653 try {
654 SpanReader stream{std::span{reinterpret_cast<const std::byte*>(raw_transaction), raw_transaction_len}};
655 return btck_Transaction::create(std::make_shared<const CTransaction>(deserialize, TX_WITH_WITNESS, stream));
656 } catch (...) {
657 return nullptr;
658 }
659}
660
662{
663 return btck_Transaction::get(transaction)->vout.size();
664}
665
666const btck_TransactionOutput* btck_transaction_get_output_at(const btck_Transaction* transaction, size_t output_index)
667{
668 const CTransaction& tx = *btck_Transaction::get(transaction);
669 assert(output_index < tx.vout.size());
670 return btck_TransactionOutput::ref(&tx.vout[output_index]);
671}
672
674{
675 return btck_Transaction::get(transaction)->vin.size();
676}
677
678const btck_TransactionInput* btck_transaction_get_input_at(const btck_Transaction* transaction, size_t input_index)
679{
680 assert(input_index < btck_Transaction::get(transaction)->vin.size());
681 return btck_TransactionInput::ref(&btck_Transaction::get(transaction)->vin[input_index]);
682}
683
685{
686 return btck_Transaction::get(transaction)->version;
687}
688
690{
691 return btck_Transaction::get(transaction)->nLockTime;
692}
693
695{
696 return btck_Txid::ref(&btck_Transaction::get(transaction)->GetHash());
697}
698
700{
701 return btck_Transaction::get(transaction)->HasWitness() ? 1 : 0;
702}
703
705{
706 return btck_Wtxid::ref(&btck_Transaction::get(transaction)->GetWitnessHash());
707}
708
710{
711 return btck_Transaction::copy(transaction);
712}
713
714int btck_transaction_to_bytes(const btck_Transaction* transaction, btck_WriteBytes writer, void* user_data)
715{
716 try {
717 WriterStream ws{writer, user_data};
718 ws << TX_WITH_WITNESS(btck_Transaction::get(transaction));
719 return 0;
720 } catch (...) {
721 return -1;
722 }
723}
724
726{
727 delete transaction;
728}
729
730btck_ScriptPubkey* btck_script_pubkey_create(const void* script_pubkey, size_t script_pubkey_len)
731{
732 assert(script_pubkey != nullptr || script_pubkey_len == 0);
733 auto data = std::span{reinterpret_cast<const uint8_t*>(script_pubkey), script_pubkey_len};
734 return btck_ScriptPubkey::create(data.begin(), data.end());
735}
736
737int btck_script_pubkey_to_bytes(const btck_ScriptPubkey* script_pubkey_, btck_WriteBytes writer, void* user_data)
738{
739 const auto& script_pubkey{btck_ScriptPubkey::get(script_pubkey_)};
740 return writer(script_pubkey.data(), script_pubkey.size(), user_data);
741}
742
744{
745 return btck_ScriptPubkey::copy(script_pubkey);
746}
747
749{
750 delete script_pubkey;
751}
752
754{
755 return btck_TransactionOutput::create(amount, btck_ScriptPubkey::get(script_pubkey));
756}
757
759{
760 return btck_TransactionOutput::copy(output);
761}
762
764{
765 return btck_ScriptPubkey::ref(&btck_TransactionOutput::get(output).scriptPubKey);
766}
767
769{
770 return btck_TransactionOutput::get(output).nValue;
771}
772
774{
775 delete output;
776}
777
779 const btck_Transaction* tx_to,
780 const btck_TransactionOutput** spent_outputs_, size_t spent_outputs_len)
781{
782 try {
783 const CTransaction& tx{*btck_Transaction::get(tx_to)};
784 auto txdata{btck_PrecomputedTransactionData::create()};
785 if (spent_outputs_ != nullptr && spent_outputs_len > 0) {
786 assert(spent_outputs_len == tx.vin.size());
787 std::vector<CTxOut> spent_outputs;
788 spent_outputs.reserve(spent_outputs_len);
789 for (size_t i = 0; i < spent_outputs_len; i++) {
790 const CTxOut& tx_out{btck_TransactionOutput::get(spent_outputs_[i])};
791 spent_outputs.push_back(tx_out);
792 }
793 btck_PrecomputedTransactionData::get(txdata).Init(tx, std::move(spent_outputs));
794 } else {
795 btck_PrecomputedTransactionData::get(txdata).Init(tx, {});
796 }
797
798 return txdata;
799 } catch (...) {
800 return nullptr;
801 }
802}
803
805{
806 return btck_PrecomputedTransactionData::copy(precomputed_txdata);
807}
808
810{
811 delete precomputed_txdata;
812}
813
815 const int64_t amount,
816 const btck_Transaction* tx_to,
817 const btck_PrecomputedTransactionData* precomputed_txdata,
818 const unsigned int input_index,
821{
822 // Assert that all specified flags are part of the interface before continuing
824
825 if (!is_valid_flag_combination(script_verify_flags::from_int(flags))) {
827 return 0;
828 }
829
830 const CTransaction& tx{*btck_Transaction::get(tx_to)};
831 assert(input_index < tx.vin.size());
832
833 const PrecomputedTransactionData& txdata{precomputed_txdata ? btck_PrecomputedTransactionData::get(precomputed_txdata) : PrecomputedTransactionData(tx)};
834
835 if (flags & btck_ScriptVerificationFlags_TAPROOT && txdata.m_spent_outputs.empty()) {
837 return 0;
838 }
839
840 if (status) *status = btck_ScriptVerifyStatus_OK;
841
842 bool result = VerifyScript(tx.vin[input_index].scriptSig,
843 btck_ScriptPubkey::get(script_pubkey),
844 &tx.vin[input_index].scriptWitness,
846 TransactionSignatureChecker(&tx, input_index, amount, txdata, MissingDataBehavior::FAIL),
847 nullptr);
848 return result ? 1 : 0;
849}
850
852{
853 return btck_TransactionInput::copy(input);
854}
855
857{
858 return btck_TransactionOutPoint::ref(&btck_TransactionInput::get(input).prevout);
859}
860
862{
863 return btck_TransactionInput::get(input).nSequence;
864}
865
867{
868 return btck_WitnessStack::ref(&btck_TransactionInput::get(input).scriptWitness);
869}
870
872{
873 const auto& script_sig{btck_TransactionInput::get(input).scriptSig};
874 return writer(script_sig.data(), script_sig.size(), user_data);
875}
876
878{
879 delete input;
880}
881
883{
884 return btck_WitnessStack::get(witness_stack).stack.size();
885}
886
887int btck_witness_stack_get_item_at(const btck_WitnessStack* witness_stack, size_t index, btck_WriteBytes writer, void* user_data)
888{
889 const auto& stack{btck_WitnessStack::get(witness_stack).stack};
890 assert(index < stack.size());
891 return writer(stack[index].data(), stack[index].size(), user_data);
892}
893
895{
896 return btck_WitnessStack::copy(witness_stack);
897}
898
900{
901 delete witness_stack;
902}
903
905{
906 return btck_TransactionOutPoint::copy(out_point);
907}
908
910{
911 return btck_TransactionOutPoint::get(out_point).n;
912}
913
915{
916 return btck_Txid::ref(&btck_TransactionOutPoint::get(out_point).hash);
917}
918
920{
921 delete out_point;
922}
923
925{
926 return btck_Txid::copy(txid);
927}
928
929void btck_txid_to_bytes(const btck_Txid* txid, unsigned char output[32])
930{
931 std::memcpy(output, btck_Txid::get(txid).begin(), 32);
932}
933
934int btck_txid_equals(const btck_Txid* txid1, const btck_Txid* txid2)
935{
936 return btck_Txid::get(txid1) == btck_Txid::get(txid2);
937}
938
940{
941 delete txid;
942}
943
945{
946 return btck_Wtxid::copy(wtxid);
947}
948
949void btck_wtxid_to_bytes(const btck_Wtxid* wtxid, unsigned char output[32])
950{
951 std::memcpy(output, btck_Wtxid::get(wtxid).begin(), 32);
952}
953
954int btck_wtxid_equals(const btck_Wtxid* wtxid1, const btck_Wtxid* wtxid2)
955{
956 return btck_Wtxid::get(wtxid1) == btck_Wtxid::get(wtxid2);
957}
958
960{
961 delete wtxid;
962}
963
964namespace {
967KernelLogger& GetKernelLogger()
968{
969 static KernelLogger* logger{new KernelLogger};
970 return *logger;
971}
972} // namespace
973
974namespace util::log {
975// Kernel filters on level only. The category is delivered as part of the entry, so consumers can
976// filter on it in their callback.
977bool ShouldDebugLog(Category /*category*/)
978{
979 return GetKernelLogger().ShouldLog(Level::Debug);
980}
981
982bool ShouldTraceLog(Category /*category*/)
983{
984 return GetKernelLogger().ShouldLog(Level::Trace);
985}
986
987void Log(Entry entry)
988{
989 // Conditional logging, because the util::log framework doesn't allow us to check if the
990 // minimum level exceeds Info.
991 GetKernelLogger().MaybeLog(entry);
992}
993} // namespace util::log
994
995
997{
998 GetKernelLogger().SetMinLevel(level);
999}
1000
1002{
1003 assert(callback);
1004 try {
1005 // Take ownership before anything can throw, so that user_data is always freed on error.
1006 UserData data{user_data, {user_data_destroy_callback}};
1007 auto handle{GetKernelLogger().RegisterCallback(callback, std::move(data))};
1008 LogDebug(BCLog::KERNEL, "Logger connected.");
1009 return btck_LoggingConnection::create(std::move(handle));
1010 } catch (...) {
1011 return nullptr;
1012 }
1013}
1014
1016{
1017 if (!connection) return;
1018 LogDebug(BCLog::KERNEL, "Logger disconnecting.");
1019 delete connection;
1020}
1021
1023{
1024 switch (chain_type) {
1026 return btck_ChainParameters::ref(const_cast<CChainParams*>(CChainParams::Main().release()));
1027 }
1029 return btck_ChainParameters::ref(const_cast<CChainParams*>(CChainParams::TestNet().release()));
1030 }
1032 return btck_ChainParameters::ref(const_cast<CChainParams*>(CChainParams::TestNet4().release()));
1033 }
1034 case btck_ChainType_SIGNET: {
1035 return btck_ChainParameters::ref(const_cast<CChainParams*>(CChainParams::SigNet().release()));
1036 }
1038 return btck_ChainParameters::ref(const_cast<CChainParams*>(CChainParams::RegTest().release()));
1039 }
1040 }
1041 assert(false);
1042}
1043
1044btck_ChainParameters* btck_chain_parameters_create_signet(const void* challenge, size_t challenge_len)
1045{
1046 assert(challenge != nullptr || challenge_len == 0);
1047 const uint8_t* p = static_cast<const uint8_t*>(challenge);
1049 .challenge = std::vector<uint8_t>{p, p + challenge_len},
1050 };
1051 return btck_ChainParameters::ref(const_cast<CChainParams*>(CChainParams::SigNet(options).release()));
1052}
1053
1055{
1056 return btck_ChainParameters::copy(chain_parameters);
1057}
1058
1060{
1061 return btck_ConsensusParams::ref(&btck_ChainParameters::get(chain_parameters).GetConsensus());
1062}
1063
1065{
1066 delete chain_parameters;
1067}
1068
1070{
1071 return btck_ContextOptions::create();
1072}
1073
1075{
1076 // Copy the chainparams, so the caller can free it again
1077 LOCK(btck_ContextOptions::get(options).m_mutex);
1078 btck_ContextOptions::get(options).m_chainparams = std::make_unique<const CChainParams>(btck_ChainParameters::get(chain_parameters));
1079}
1080
1082{
1083 // The KernelNotifications are copy-initialized, so the caller can free them again.
1084 LOCK(btck_ContextOptions::get(options).m_mutex);
1085 btck_ContextOptions::get(options).m_notifications = std::make_shared<KernelNotifications>(notifications);
1086}
1087
1089{
1090 LOCK(btck_ContextOptions::get(options).m_mutex);
1091 btck_ContextOptions::get(options).m_validation_interface = std::make_shared<KernelValidationInterface>(vi_cbs);
1092}
1093
1095{
1096 delete options;
1097}
1098
1100{
1101 bool sane{true};
1102 const ContextOptions* opts = options ? &btck_ContextOptions::get(options) : nullptr;
1103 auto context{std::make_shared<const Context>(opts, sane)};
1104 if (!sane) {
1105 LogError("Kernel context sanity check failed.");
1106 return nullptr;
1107 }
1108 return btck_Context::create(context);
1109}
1110
1112{
1113 return btck_Context::copy(context);
1114}
1115
1117{
1118 return (*btck_Context::get(context)->m_interrupt)() ? 0 : -1;
1119}
1120
1122{
1123 delete context;
1124}
1125
1127{
1128 if (!btck_BlockTreeEntry::get(entry).pprev) {
1129 LogInfo("Genesis block has no previous.");
1130 return nullptr;
1131 }
1132
1133 return btck_BlockTreeEntry::ref(btck_BlockTreeEntry::get(entry).pprev);
1134}
1135
1137{
1138 const auto* ancestor{btck_BlockTreeEntry::get(block_tree_entry).GetAncestor(height)};
1139 assert(ancestor);
1140 return btck_BlockTreeEntry::ref(ancestor);
1141}
1142
1144{
1145 return btck_BlockValidationState::create();
1146}
1147
1149{
1150 return btck_BlockValidationState::copy(state);
1151}
1152
1154{
1155 delete state;
1156}
1157
1159{
1160 auto& block_validation_state = btck_BlockValidationState::get(block_validation_state_);
1161 if (block_validation_state.IsValid()) return btck_ValidationMode_VALID;
1162 if (block_validation_state.IsInvalid()) return btck_ValidationMode_INVALID;
1164}
1165
1167{
1168 auto& block_validation_state = btck_BlockValidationState::get(block_validation_state_);
1169 switch (block_validation_state.GetResult()) {
1188 } // no default case, so the compiler can warn about missing cases
1189 assert(false);
1190}
1191
1192btck_ChainstateManagerOptions* btck_chainstate_manager_options_create(const btck_Context* context, const char* data_dir, size_t data_dir_len, const char* blocks_dir, size_t blocks_dir_len)
1193{
1194 assert(data_dir != nullptr || data_dir_len == 0);
1195 assert(blocks_dir != nullptr || blocks_dir_len == 0);
1196 if (data_dir_len == 0 || blocks_dir_len == 0) {
1197 LogError("Failed to create chainstate manager options: dir must be non-null and non-empty");
1198 return nullptr;
1199 }
1200 try {
1201 fs::path abs_data_dir{fs::absolute(fs::PathFromString({data_dir, data_dir_len}))};
1202 fs::create_directories(abs_data_dir);
1203 fs::path abs_blocks_dir{fs::absolute(fs::PathFromString({blocks_dir, blocks_dir_len}))};
1204 fs::create_directories(abs_blocks_dir);
1205 return btck_ChainstateManagerOptions::create(btck_Context::get(context), abs_data_dir, abs_blocks_dir);
1206 } catch (const std::exception& e) {
1207 LogError("Failed to create chainstate manager options: %s", e.what());
1208 return nullptr;
1209 }
1210}
1211
1213{
1214 LOCK(btck_ChainstateManagerOptions::get(opts).m_mutex);
1215 btck_ChainstateManagerOptions::get(opts).m_chainman_options.worker_threads_num = worker_threads;
1216}
1217
1219{
1220 if (database_cache_bytes < MIN_DBCACHE_BYTES || database_cache_bytes > MAX_DBCACHE_BYTES) {
1221 LogError("Failed to set database cache: size is outside the supported range.");
1222 return -1;
1223 }
1224
1225 auto& opts{btck_ChainstateManagerOptions::get(chainman_opts)};
1226 LOCK(opts.m_mutex);
1227 opts.m_db_cache_bytes = database_cache_bytes;
1228 opts.m_blockman_options.block_tree_db_params.cache_bytes = kernel::CacheSizes{database_cache_bytes}.block_tree_db;
1229 return 0;
1230}
1231
1233{
1234 delete options;
1235}
1236
1237int btck_chainstate_manager_options_set_wipe_dbs(btck_ChainstateManagerOptions* chainman_opts, int wipe_block_tree_db, int wipe_chainstate_db)
1238{
1239 if (wipe_block_tree_db == 1 && wipe_chainstate_db != 1) {
1240 LogError("Wiping the block tree db without also wiping the chainstate db is currently unsupported.");
1241 return -1;
1242 }
1243 auto& opts{btck_ChainstateManagerOptions::get(chainman_opts)};
1244 LOCK(opts.m_mutex);
1245 opts.m_blockman_options.block_tree_db_params.wipe_data = wipe_block_tree_db == 1;
1246 opts.m_chainstate_load_options.wipe_chainstate_db = wipe_chainstate_db == 1;
1247 return 0;
1248}
1249
1251 btck_ChainstateManagerOptions* chainman_opts,
1252 int block_tree_db_in_memory)
1253{
1254 auto& opts{btck_ChainstateManagerOptions::get(chainman_opts)};
1255 LOCK(opts.m_mutex);
1256 opts.m_blockman_options.block_tree_db_params.memory_only = block_tree_db_in_memory == 1;
1257}
1258
1260 btck_ChainstateManagerOptions* chainman_opts,
1261 int chainstate_db_in_memory)
1262{
1263 auto& opts{btck_ChainstateManagerOptions::get(chainman_opts)};
1264 LOCK(opts.m_mutex);
1265 opts.m_chainstate_load_options.coins_db_in_memory = chainstate_db_in_memory == 1;
1266}
1267
1269 const btck_ChainstateManagerOptions* chainman_opts)
1270{
1271 auto& opts{btck_ChainstateManagerOptions::get(chainman_opts)};
1272 std::unique_ptr<ChainstateManager> chainman;
1273 try {
1274 LOCK(opts.m_mutex);
1275 chainman = std::make_unique<ChainstateManager>(*opts.m_context->m_interrupt, opts.m_chainman_options, opts.m_blockman_options);
1276 } catch (const std::exception& e) {
1277 LogError("Failed to create chainstate manager: %s", e.what());
1278 return nullptr;
1279 }
1280
1281 try {
1282 const auto chainstate_load_opts{WITH_LOCK(opts.m_mutex, return opts.m_chainstate_load_options)};
1283
1284 const kernel::CacheSizes cache_sizes{WITH_LOCK(opts.m_mutex, return opts.m_db_cache_bytes)};
1285 auto [status, chainstate_err]{node::LoadChainstate(*chainman, cache_sizes, chainstate_load_opts)};
1287 LogError("Failed to load chain state from your data directory: %s", chainstate_err.original);
1288 return nullptr;
1289 }
1290 std::tie(status, chainstate_err) = node::VerifyLoadedChainstate(*chainman, chainstate_load_opts);
1292 LogError("Failed to verify loaded chain state from your datadir: %s", chainstate_err.original);
1293 return nullptr;
1294 }
1295 if (auto result = chainman->ActivateBestChains(); !result) {
1296 LogError("%s", util::ErrorString(result).original);
1297 return nullptr;
1298 }
1299 } catch (const std::exception& e) {
1300 LogError("Failed to load chainstate: %s", e.what());
1301 return nullptr;
1302 }
1303
1304 return btck_ChainstateManager::create(std::move(chainman), opts.m_context);
1305}
1306
1308{
1309 auto block_index = WITH_LOCK(btck_ChainstateManager::get(chainman).m_chainman->GetMutex(),
1310 return btck_ChainstateManager::get(chainman).m_chainman->m_blockman.LookupBlockIndex(btck_BlockHash::get(block_hash)));
1311 if (!block_index) {
1312 LogDebug(BCLog::KERNEL, "A block with the given hash is not indexed.");
1313 return nullptr;
1314 }
1315 return btck_BlockTreeEntry::ref(block_index);
1316}
1317
1319{
1320 auto& chainman = *btck_ChainstateManager::get(chainstate_manager).m_chainman;
1321 return btck_BlockTreeEntry::ref(WITH_LOCK(chainman.GetMutex(), return chainman.m_best_header));
1322}
1323
1325{
1326 {
1327 LOCK(btck_ChainstateManager::get(chainman).m_chainman->GetMutex());
1328 for (const auto& chainstate : btck_ChainstateManager::get(chainman).m_chainman->m_chainstates) {
1329 if (chainstate->CanFlushToDisk()) {
1330 chainstate->ForceFlushStateToDisk();
1331 chainstate->ResetCoinsViews();
1332 }
1333 }
1334 }
1335
1336 delete chainman;
1337}
1338
1339int btck_chainstate_manager_import_blocks(btck_ChainstateManager* chainman, const char** block_file_paths_data, size_t* block_file_paths_lens, size_t block_file_paths_data_len)
1340{
1341 try {
1342 std::vector<fs::path> import_files;
1343 import_files.reserve(block_file_paths_data_len);
1344 for (uint32_t i = 0; i < block_file_paths_data_len; i++) {
1345 if (block_file_paths_data[i] != nullptr) {
1346 import_files.emplace_back(std::string{block_file_paths_data[i], block_file_paths_lens[i]}.c_str());
1347 }
1348 }
1349 auto& chainman_ref{*btck_ChainstateManager::get(chainman).m_chainman};
1350 node::ImportBlocks(chainman_ref, import_files);
1351 WITH_LOCK(::cs_main, chainman_ref.UpdateIBDStatus());
1352 } catch (const std::exception& e) {
1353 LogError("Failed to import blocks: %s", e.what());
1354 return -1;
1355 }
1356 return 0;
1357}
1358
1359btck_Block* btck_block_create(const void* raw_block, size_t raw_block_length)
1360{
1361 assert(raw_block != nullptr || raw_block_length == 0);
1362 auto block{std::make_shared<CBlock>()};
1363
1364 SpanReader stream{std::span{reinterpret_cast<const std::byte*>(raw_block), raw_block_length}};
1365
1366 try {
1367 stream >> TX_WITH_WITNESS(*block);
1368 } catch (...) {
1369 LogDebug(BCLog::KERNEL, "Block decode failed.");
1370 return nullptr;
1371 }
1372
1373 return btck_Block::create(block);
1374}
1375
1377{
1378 return btck_Block::copy(block);
1379}
1380
1381int btck_block_check(const btck_Block* block, const btck_ConsensusParams* consensus_params, btck_BlockCheckFlags flags, btck_BlockValidationState* validation_state)
1382{
1383 auto& state = btck_BlockValidationState::get(validation_state);
1384 state = BlockValidationState{};
1385
1386 const bool check_pow = (flags & btck_BlockCheckFlags_POW) != 0;
1387 const bool check_merkle = (flags & btck_BlockCheckFlags_MERKLE) != 0;
1388
1389 const bool result = CheckBlock(*btck_Block::get(block), state, btck_ConsensusParams::get(consensus_params), /*fCheckPOW=*/check_pow, /*fCheckMerkleRoot=*/check_merkle);
1390
1391 return result ? 1 : 0;
1392}
1393
1395{
1396 return btck_Block::get(block)->vtx.size();
1397}
1398
1400{
1401 assert(index < btck_Block::get(block)->vtx.size());
1402 return btck_Transaction::ref(&btck_Block::get(block)->vtx[index]);
1403}
1404
1406{
1407 const auto& block_ptr = btck_Block::get(block);
1408 return btck_BlockHeader::create(static_cast<const CBlockHeader&>(*block_ptr));
1409}
1410
1411int btck_block_to_bytes(const btck_Block* block, btck_WriteBytes writer, void* user_data)
1412{
1413 try {
1414 WriterStream ws{writer, user_data};
1415 ws << TX_WITH_WITNESS(*btck_Block::get(block));
1416 return 0;
1417 } catch (...) {
1418 return -1;
1419 }
1420}
1421
1423{
1424 return btck_BlockHash::create(btck_Block::get(block)->GetHash());
1425}
1426
1428{
1429 delete block;
1430}
1431
1433{
1434 auto block{std::make_shared<CBlock>()};
1435 if (!btck_ChainstateManager::get(chainman).m_chainman->m_blockman.ReadBlock(*block, btck_BlockTreeEntry::get(entry))) {
1436 LogError("Failed to read block.");
1437 return nullptr;
1438 }
1439 return btck_Block::create(block);
1440}
1441
1443{
1444 return btck_BlockHeader::create(btck_BlockTreeEntry::get(entry).GetBlockHeader());
1445}
1446
1448{
1449 return btck_BlockTreeEntry::get(entry).nHeight;
1450}
1451
1453{
1454 return btck_BlockHash::ref(btck_BlockTreeEntry::get(entry).phashBlock);
1455}
1456
1458{
1459 return &btck_BlockTreeEntry::get(entry1) == &btck_BlockTreeEntry::get(entry2);
1460}
1461
1462btck_BlockHash* btck_block_hash_create(const unsigned char block_hash[32])
1463{
1464 return btck_BlockHash::create(std::span<const unsigned char>{block_hash, 32});
1465}
1466
1468{
1469 return btck_BlockHash::copy(block_hash);
1470}
1471
1472void btck_block_hash_to_bytes(const btck_BlockHash* block_hash, unsigned char output[32])
1473{
1474 std::memcpy(output, btck_BlockHash::get(block_hash).begin(), 32);
1475}
1476
1478{
1479 return btck_BlockHash::get(hash1) == btck_BlockHash::get(hash2);
1480}
1481
1483{
1484 delete hash;
1485}
1486
1488{
1489 auto block_undo{std::make_shared<CBlockUndo>()};
1490 if (btck_BlockTreeEntry::get(entry).nHeight < 1) {
1491 LogDebug(BCLog::KERNEL, "The genesis block does not have any spent outputs.");
1492 return btck_BlockSpentOutputs::create(block_undo);
1493 }
1494 if (!btck_ChainstateManager::get(chainman).m_chainman->m_blockman.ReadBlockUndo(*block_undo, btck_BlockTreeEntry::get(entry))) {
1495 LogError("Failed to read block spent outputs data.");
1496 return nullptr;
1497 }
1498 return btck_BlockSpentOutputs::create(block_undo);
1499}
1500
1502{
1503 return btck_BlockSpentOutputs::copy(block_spent_outputs);
1504}
1505
1507{
1508 return btck_BlockSpentOutputs::get(block_spent_outputs)->vtxundo.size();
1509}
1510
1512{
1513 assert(transaction_index < btck_BlockSpentOutputs::get(block_spent_outputs)->vtxundo.size());
1514 const auto* tx_undo{&btck_BlockSpentOutputs::get(block_spent_outputs)->vtxundo.at(transaction_index)};
1515 return btck_TransactionSpentOutputs::ref(tx_undo);
1516}
1517
1519{
1520 delete block_spent_outputs;
1521}
1522
1524{
1525 return btck_TransactionSpentOutputs::copy(transaction_spent_outputs);
1526}
1527
1529{
1530 return btck_TransactionSpentOutputs::get(transaction_spent_outputs).vprevout.size();
1531}
1532
1534{
1535 delete transaction_spent_outputs;
1536}
1537
1538const btck_Coin* btck_transaction_spent_outputs_get_coin_at(const btck_TransactionSpentOutputs* transaction_spent_outputs, size_t coin_index)
1539{
1540 assert(coin_index < btck_TransactionSpentOutputs::get(transaction_spent_outputs).vprevout.size());
1541 const Coin* coin{&btck_TransactionSpentOutputs::get(transaction_spent_outputs).vprevout.at(coin_index)};
1542 return btck_Coin::ref(coin);
1543}
1544
1546{
1547 return btck_Coin::copy(coin);
1548}
1549
1551{
1552 return btck_Coin::get(coin).nHeight;
1553}
1554
1556{
1557 return btck_Coin::get(coin).IsCoinBase() ? 1 : 0;
1558}
1559
1561{
1562 return btck_TransactionOutput::ref(&btck_Coin::get(coin).out);
1563}
1564
1566{
1567 delete coin;
1568}
1569
1571 btck_ChainstateManager* chainman,
1572 const btck_Block* block,
1573 int* _new_block)
1574{
1575 bool new_block;
1576 auto result = btck_ChainstateManager::get(chainman).m_chainman->ProcessNewBlock(btck_Block::get(block), /*force_processing=*/true, /*min_pow_checked=*/true, /*new_block=*/&new_block);
1577 if (_new_block) {
1578 *_new_block = new_block ? 1 : 0;
1579 }
1580 return result ? 0 : -1;
1581}
1582
1584 btck_ChainstateManager* chainstate_manager,
1585 const btck_BlockHeader* header)
1586{
1587 try {
1588 auto& chainman = btck_ChainstateManager::get(chainstate_manager).m_chainman;
1589
1590 auto state = btck_BlockValidationState::create();
1591 bool result{chainman->ProcessNewBlockHeaders({&btck_BlockHeader::get(header), 1}, /*min_pow_checked=*/true, btck_BlockValidationState::get(state))};
1592 assert(result == btck_BlockValidationState::get(state).IsValid());
1593 return state;
1594 } catch (const std::exception& e) {
1595 LogError("Failed to process block header: %s", e.what());
1596 return nullptr;
1597 }
1598}
1599
1601{
1602 return btck_Chain::ref(&WITH_LOCK(btck_ChainstateManager::get(chainman).m_chainman->GetMutex(), return btck_ChainstateManager::get(chainman).m_chainman->ActiveChain()));
1603}
1604
1606{
1607 LOCK(::cs_main);
1608 return btck_Chain::get(chain).Height();
1609}
1610
1611const btck_BlockTreeEntry* btck_chain_get_by_height(const btck_Chain* chain, int32_t height)
1612{
1613 LOCK(::cs_main);
1614 return btck_BlockTreeEntry::ref(btck_Chain::get(chain)[height]);
1615}
1616
1618{
1619 LOCK(::cs_main);
1620 return btck_Chain::get(chain).Contains(btck_BlockTreeEntry::get(entry)) ? 1 : 0;
1621}
1622
1623btck_BlockHeader* btck_block_header_create(const void* raw_block_header, size_t raw_block_header_len)
1624{
1625 assert(raw_block_header != nullptr && raw_block_header_len == 80);
1626 auto header{std::make_unique<CBlockHeader>()};
1627 SpanReader stream{std::span{reinterpret_cast<const std::byte*>(raw_block_header), raw_block_header_len}};
1628
1629 try {
1630 stream >> *header;
1631 } catch (...) {
1632 LogError("Block header decode failed.");
1633 return nullptr;
1634 }
1635
1636 return btck_BlockHeader::ref(header.release());
1637}
1638
1640{
1641 return btck_BlockHeader::copy(header);
1642}
1643
1645{
1646 return btck_BlockHash::create(btck_BlockHeader::get(header).GetHash());
1647}
1648
1650{
1651 return btck_BlockHash::ref(&btck_BlockHeader::get(header).hashPrevBlock);
1652}
1653
1654void btck_block_header_get_merkle_root(const btck_BlockHeader* header, unsigned char output[32])
1655{
1656 std::memcpy(output, btck_BlockHeader::get(header).hashMerkleRoot.begin(), 32);
1657}
1658
1660{
1661 return btck_BlockHeader::get(header).nTime;
1662}
1663
1665{
1666 return btck_BlockHeader::get(header).nBits;
1667}
1668
1670{
1671 return btck_BlockHeader::get(header).nVersion;
1672}
1673
1675{
1676 return btck_BlockHeader::get(header).nNonce;
1677}
1678
1679int btck_block_header_to_bytes(const btck_BlockHeader* header, unsigned char output[80])
1680{
1681 try {
1682 SpanWriter{std::as_writable_bytes(std::span{output, 80})} << btck_BlockHeader::get(header);
1683 return 0;
1684 } catch (...) {
1685 return -1;
1686 }
1687}
1688
1690{
1691 delete header;
1692}
1693
1695{
1696 const auto& state = btck_TxValidationState::get(state_);
1697 if (state.IsValid()) return btck_ValidationMode_VALID;
1698 if (state.IsInvalid()) return btck_ValidationMode_INVALID;
1700}
1701
1703{
1704 return btck_TxValidationState::create();
1705}
1706
1708{
1709 switch (btck_TxValidationState::get(state_).GetResult()) {
1723 } // no default case, so the compiler can warn about missing cases
1724 assert(false);
1725}
1726
1728{
1729 delete state;
1730}
1731
1733{
1734 auto& state = btck_TxValidationState::get(validation_state);
1735 state = TxValidationState{};
1736 const bool ok = CheckTransaction(*btck_Transaction::get(tx), state);
1737 return ok ? 1 : 0;
1738}
1739
1740int btck_set_mock_time(int64_t timestamp)
1741{
1742 constexpr int64_t max_time{std::numeric_limits<uint32_t>::max()};
1743 if (timestamp < 0 || timestamp > max_time) {
1744 return -1;
1745 }
1746 SetMockTime(std::chrono::seconds{timestamp});
1747 return 0;
1748}
#define LIFETIMEBOUND
Definition: attributes.h:12
int flags
Definition: bitcoin-tx.cpp:531
ArgsManager & args
Definition: bitcoind.cpp:280
int btck_block_to_bytes(const btck_Block *block, btck_WriteBytes writer, void *user_data)
btck_ScriptPubkey * btck_script_pubkey_copy(const btck_ScriptPubkey *script_pubkey)
Copy a script pubkey.
btck_BlockHash * btck_block_hash_copy(const btck_BlockHash *block_hash)
Copy a block hash.
void btck_txid_destroy(btck_Txid *txid)
Destroy the txid.
int btck_script_pubkey_to_bytes(const btck_ScriptPubkey *script_pubkey_, btck_WriteBytes writer, void *user_data)
void btck_script_pubkey_destroy(btck_ScriptPubkey *script_pubkey)
Destroy the script pubkey.
btck_TxValidationResult btck_tx_validation_state_get_tx_validation_result(const btck_TxValidationState *state_)
Returns the validation result from an opaque btck_TxValidationState pointer.
btck_Wtxid * btck_wtxid_copy(const btck_Wtxid *wtxid)
Copy a wtxid.
int btck_chainstate_manager_import_blocks(btck_ChainstateManager *chainman, const char **block_file_paths_data, size_t *block_file_paths_lens, size_t block_file_paths_data_len)
Triggers the start of a reindex if the wipe options were previously set for the chainstate manager.
const btck_Coin * btck_transaction_spent_outputs_get_coin_at(const btck_TransactionSpentOutputs *transaction_spent_outputs, size_t coin_index)
Returns a coin contained in the transaction spent outputs at a certain index.
const btck_TransactionInput * btck_transaction_get_input_at(const btck_Transaction *transaction, size_t input_index)
Get the transaction input at the provided index.
uint32_t btck_coin_confirmation_height(const btck_Coin *coin)
Returns the block height where the transaction that created this coin was included in.
void btck_context_destroy(btck_Context *context)
Destroy the context.
void btck_context_options_set_notifications(btck_ContextOptions *options, btck_NotificationInterfaceCallbacks notifications)
Set the kernel notifications for the context options.
btck_ContextOptions * btck_context_options_create()
Creates an empty context options.
void btck_transaction_destroy(btck_Transaction *transaction)
Destroy the transaction.
btck_PrecomputedTransactionData * btck_precomputed_transaction_data_create(const btck_Transaction *tx_to, const btck_TransactionOutput **spent_outputs_, size_t spent_outputs_len)
Create precomputed transaction data for script verification.
const btck_BlockTreeEntry * btck_block_tree_entry_get_ancestor(const btck_BlockTreeEntry *block_tree_entry, int32_t height)
Return the ancestor of a btck_BlockTreeEntry at the given height.
int64_t btck_transaction_output_get_amount(const btck_TransactionOutput *output)
Get the amount in the output.
void btck_chainstate_manager_options_update_chainstate_db_in_memory(btck_ChainstateManagerOptions *chainman_opts, int chainstate_db_in_memory)
Sets chainstate db in memory in the options.
uint32_t btck_block_header_get_nonce(const btck_BlockHeader *header)
Get the nonce from btck_BlockHeader.
const btck_Txid * btck_transaction_out_point_get_txid(const btck_TransactionOutPoint *out_point)
Get the txid from the transaction out point.
btck_BlockValidationState * btck_block_validation_state_create()
Create a new btck_BlockValidationState.
void btck_transaction_spent_outputs_destroy(btck_TransactionSpentOutputs *transaction_spent_outputs)
Destroy the transaction spent outputs.
const btck_BlockTreeEntry * btck_block_tree_entry_get_previous(const btck_BlockTreeEntry *entry)
Returns the previous block tree entry in the tree, or null if the current block tree entry is the gen...
void btck_chain_parameters_destroy(btck_ChainParameters *chain_parameters)
Destroy the chain parameters.
size_t btck_transaction_count_outputs(const btck_Transaction *transaction)
Get the number of outputs of a transaction.
int btck_witness_stack_get_item_at(const btck_WitnessStack *witness_stack, size_t index, btck_WriteBytes writer, void *user_data)
size_t btck_witness_stack_count_items(const btck_WitnessStack *witness_stack)
Return the number of items in a witness stack.
void btck_block_destroy(btck_Block *block)
Destroy the block.
btck_ScriptPubkey * btck_script_pubkey_create(const void *script_pubkey, size_t script_pubkey_len)
Create a script pubkey from serialized data.
btck_Context * btck_context_copy(const btck_Context *context)
Copy the context.
const btck_BlockTreeEntry * btck_chainstate_manager_get_best_entry(const btck_ChainstateManager *chainstate_manager)
Get the btck_BlockTreeEntry whose associated btck_BlockHeader has the most known cumulative proof of ...
btck_ChainParameters * btck_chain_parameters_create(const btck_ChainType chain_type)
Creates a chain parameters struct with default parameters based on the passed in chain type.
int32_t btck_block_header_get_version(const btck_BlockHeader *header)
Get the version from btck_BlockHeader.
int btck_set_mock_time(int64_t timestamp)
Override the current time with a fixed timestamp for testing.
btck_ValidationMode btck_block_validation_state_get_validation_mode(const btck_BlockValidationState *block_validation_state_)
Returns the validation mode from an opaque btck_BlockValidationState pointer.
btck_Block * btck_block_create(const void *raw_block, size_t raw_block_length)
Parse a serialized raw block into a new block object.
void btck_chainstate_manager_options_update_block_tree_db_in_memory(btck_ChainstateManagerOptions *chainman_opts, int block_tree_db_in_memory)
Sets block tree db in memory in the options.
static const kernel::Context btck_context_static
void btck_witness_stack_destroy(btck_WitnessStack *witness_stack)
Destroy the witness stack.
btck_ChainParameters * btck_chain_parameters_copy(const btck_ChainParameters *chain_parameters)
Copy the chain parameters.
int btck_block_tree_entry_equals(const btck_BlockTreeEntry *entry1, const btck_BlockTreeEntry *entry2)
uint32_t btck_block_header_get_bits(const btck_BlockHeader *header)
Get the nBits difficulty target from btck_BlockHeader.
const btck_Wtxid * btck_transaction_get_wtxid(const btck_Transaction *transaction)
Get the wtxid of a transaction.
int32_t btck_chain_get_height(const btck_Chain *chain)
Return the height of the tip of the chain.
btck_BlockHeader * btck_block_get_header(const btck_Block *block)
Get the btck_BlockHeader from the block.
size_t btck_block_count_transactions(const btck_Block *block)
Count the number of transactions contained in a block.
void btck_context_options_destroy(btck_ContextOptions *options)
Destroy the context options.
void btck_logging_set_min_level(btck_LogLevel level)
Set the minimum log level.
void btck_block_header_get_merkle_root(const btck_BlockHeader *header, unsigned char output[32])
btck_LoggingConnection * btck_logging_connection_create(btck_LogCallback callback, void *user_data, btck_DestroyCallback user_data_destroy_callback)
Start logging messages through the provided callback.
btck_BlockHeader * btck_block_header_copy(const btck_BlockHeader *header)
Copy a btck_BlockHeader.
int btck_script_pubkey_verify(const btck_ScriptPubkey *script_pubkey, const int64_t amount, const btck_Transaction *tx_to, const btck_PrecomputedTransactionData *precomputed_txdata, const unsigned int input_index, const btck_ScriptVerificationFlags flags, btck_ScriptVerifyStatus *status)
btck_BlockSpentOutputs * btck_block_spent_outputs_copy(const btck_BlockSpentOutputs *block_spent_outputs)
Copy a block's spent outputs.
void btck_precomputed_transaction_data_destroy(btck_PrecomputedTransactionData *precomputed_txdata)
Destroy the precomputed transaction data.
const btck_TransactionOutPoint * btck_transaction_input_get_out_point(const btck_TransactionInput *input)
Get the transaction out point.
btck_BlockSpentOutputs * btck_block_spent_outputs_read(const btck_ChainstateManager *chainman, const btck_BlockTreeEntry *entry)
void btck_tx_validation_state_destroy(btck_TxValidationState *state)
Destroy the btck_TxValidationState.
btck_ChainstateManager * btck_chainstate_manager_create(const btck_ChainstateManagerOptions *chainman_opts)
Create a chainstate manager.
int btck_transaction_check(const btck_Transaction *tx, btck_TxValidationState *validation_state)
void btck_block_validation_state_destroy(btck_BlockValidationState *state)
Destroy the btck_BlockValidationState.
btck_BlockHash * btck_block_get_hash(const btck_Block *block)
Calculate and return the hash of a block.
btck_Txid * btck_txid_copy(const btck_Txid *txid)
Copy a txid.
const btck_TransactionSpentOutputs * btck_block_spent_outputs_get_transaction_spent_outputs_at(const btck_BlockSpentOutputs *block_spent_outputs, size_t transaction_index)
Returns a transaction spent outputs contained in the block spent outputs at a certain index.
btck_Context * btck_context_create(const btck_ContextOptions *options)
Create a new kernel context.
const btck_TransactionOutput * btck_coin_get_output(const btck_Coin *coin)
Return the transaction output of a coin.
void btck_transaction_out_point_destroy(btck_TransactionOutPoint *out_point)
Destroy the transaction out point.
uint32_t btck_transaction_get_locktime(const btck_Transaction *transaction)
Get a transaction's nLockTime value.
int btck_coin_is_coinbase(const btck_Coin *coin)
Returns whether the containing transaction was a coinbase.
int btck_wtxid_equals(const btck_Wtxid *wtxid1, const btck_Wtxid *wtxid2)
void btck_txid_to_bytes(const btck_Txid *txid, unsigned char output[32])
void btck_block_hash_destroy(btck_BlockHash *hash)
Destroy the block hash.
int btck_chainstate_manager_options_set_wipe_dbs(btck_ChainstateManagerOptions *chainman_opts, int wipe_block_tree_db, int wipe_chainstate_db)
Sets wipe db in the options.
uint32_t btck_transaction_get_version(const btck_Transaction *transaction)
Get a transaction's version.
btck_BlockHeader * btck_block_tree_entry_get_block_header(const btck_BlockTreeEntry *entry)
Return the btck_BlockHeader associated with this entry.
int btck_context_interrupt(btck_Context *context)
Interrupt can be used to halt long-running validation functions like when reindexing,...
const btck_ConsensusParams * btck_chain_parameters_get_consensus_params(const btck_ChainParameters *chain_parameters)
Get btck_ConsensusParams from btck_ChainParameters.
void btck_transaction_input_destroy(btck_TransactionInput *input)
Destroy the transaction input.
const btck_TransactionOutput * btck_transaction_get_output_at(const btck_Transaction *transaction, size_t output_index)
Get the transaction outputs at the provided index.
const btck_BlockTreeEntry * btck_chain_get_by_height(const btck_Chain *chain, int32_t height)
Retrieve a block tree entry by its height in the currently active chain.
void btck_coin_destroy(btck_Coin *coin)
Destroy the coin.
void btck_context_options_set_chainparams(btck_ContextOptions *options, const btck_ChainParameters *chain_parameters)
btck_WitnessStack * btck_witness_stack_copy(const btck_WitnessStack *witness_stack)
Copy a witness stack.
int btck_block_header_to_bytes(const btck_BlockHeader *header, unsigned char output[80])
int btck_chainstate_manager_options_set_database_cache_bytes(btck_ChainstateManagerOptions *chainman_opts, uint64_t database_cache_bytes)
Set the total database cache used by the chainstate manager.
const btck_WitnessStack * btck_transaction_input_get_witness_stack(const btck_TransactionInput *input)
Get the witness stack of a transaction input.
btck_BlockHeader * btck_block_header_create(const void *raw_block_header, size_t raw_block_header_len)
Create a btck_BlockHeader from serialized data.
uint32_t btck_block_header_get_timestamp(const btck_BlockHeader *header)
Get the timestamp from btck_BlockHeader.
btck_ChainParameters * btck_chain_parameters_create_signet(const void *challenge, size_t challenge_len)
Create a signet chain parameters struct with a user-provided challenge.
void btck_block_header_destroy(btck_BlockHeader *header)
Destroy the btck_BlockHeader.
btck_PrecomputedTransactionData * btck_precomputed_transaction_data_copy(const btck_PrecomputedTransactionData *precomputed_txdata)
Copy precomputed transaction data.
btck_BlockHash * btck_block_hash_create(const unsigned char block_hash[32])
Create a block hash from its raw data.
btck_BlockHash * btck_block_header_get_hash(const btck_BlockHeader *header)
Get the btck_BlockHash.
const TranslateFn G_TRANSLATION_FUN
Definition: bitcoin-cli.cpp:61
btck_ValidationMode btck_tx_validation_state_get_validation_mode(const btck_TxValidationState *state_)
Returns the validation mode from an opaque btck_TxValidationState pointer.
void btck_wtxid_to_bytes(const btck_Wtxid *wtxid, unsigned char output[32])
int btck_transaction_input_get_script_sig(const btck_TransactionInput *input, btck_WriteBytes writer, void *user_data)
int btck_transaction_has_witness(const btck_Transaction *transaction)
Check whether a transaction has witness data.
void btck_context_options_set_validation_interface(btck_ContextOptions *options, btck_ValidationInterfaceCallbacks vi_cbs)
Set the validation interface callbacks for the context options.
uint32_t btck_transaction_out_point_get_index(const btck_TransactionOutPoint *out_point)
Get the output position from the transaction out point.
const btck_BlockHash * btck_block_header_get_prev_hash(const btck_BlockHeader *header)
Get the previous btck_BlockHash from btck_BlockHeader.
btck_Block * btck_block_read(const btck_ChainstateManager *chainman, const btck_BlockTreeEntry *entry)
const btck_Txid * btck_transaction_get_txid(const btck_Transaction *transaction)
Get the txid of a transaction.
btck_TransactionOutPoint * btck_transaction_out_point_copy(const btck_TransactionOutPoint *out_point)
Copy a transaction out point.
btck_BlockValidationState * btck_chainstate_manager_process_block_header(btck_ChainstateManager *chainstate_manager, const btck_BlockHeader *header)
btck_TransactionInput * btck_transaction_input_copy(const btck_TransactionInput *input)
Copy a transaction input.
int btck_chain_contains(const btck_Chain *chain, const btck_BlockTreeEntry *entry)
const btck_BlockTreeEntry * btck_chainstate_manager_get_block_tree_entry_by_hash(const btck_ChainstateManager *chainman, const btck_BlockHash *block_hash)
void btck_wtxid_destroy(btck_Wtxid *wtxid)
Destroy the wtxid.
size_t btck_block_spent_outputs_count(const btck_BlockSpentOutputs *block_spent_outputs)
Returns the number of transaction spent outputs whose data is contained in block spent outputs.
btck_TransactionOutput * btck_transaction_output_copy(const btck_TransactionOutput *output)
Copy a transaction output.
int btck_block_hash_equals(const btck_BlockHash *hash1, const btck_BlockHash *hash2)
void btck_logging_connection_destroy(btck_LoggingConnection *connection)
Stop logging and destroy the logging connection.
btck_TransactionSpentOutputs * btck_transaction_spent_outputs_copy(const btck_TransactionSpentOutputs *transaction_spent_outputs)
Copy a transaction's spent outputs.
int32_t btck_block_tree_entry_get_height(const btck_BlockTreeEntry *entry)
Return the height of a certain block tree entry.
void btck_block_spent_outputs_destroy(btck_BlockSpentOutputs *block_spent_outputs)
Destroy the block spent outputs.
const btck_ScriptPubkey * btck_transaction_output_get_script_pubkey(const btck_TransactionOutput *output)
Get the script pubkey of the output.
int btck_chainstate_manager_process_block(btck_ChainstateManager *chainman, const btck_Block *block, int *_new_block)
size_t btck_transaction_count_inputs(const btck_Transaction *transaction)
Get the number of inputs of a transaction.
int btck_block_check(const btck_Block *block, const btck_ConsensusParams *consensus_params, btck_BlockCheckFlags flags, btck_BlockValidationState *validation_state)
int btck_txid_equals(const btck_Txid *txid1, const btck_Txid *txid2)
btck_Block * btck_block_copy(const btck_Block *block)
Copy a block.
void btck_chainstate_manager_destroy(btck_ChainstateManager *chainman)
Destroy the chainstate manager.
void btck_chainstate_manager_options_destroy(btck_ChainstateManagerOptions *options)
Destroy the chainstate manager options.
btck_Transaction * btck_transaction_create(const void *raw_transaction, size_t raw_transaction_len)
Create a new transaction from the serialized data.
btck_Coin * btck_coin_copy(const btck_Coin *coin)
Copy a coin.
const btck_BlockHash * btck_block_tree_entry_get_block_hash(const btck_BlockTreeEntry *entry)
Return the block hash associated with a block tree entry.
void btck_chainstate_manager_options_set_worker_threads_num(btck_ChainstateManagerOptions *opts, int worker_threads)
Set the number of available worker threads used during validation.
int btck_transaction_to_bytes(const btck_Transaction *transaction, btck_WriteBytes writer, void *user_data)
btck_TransactionOutput * btck_transaction_output_create(const btck_ScriptPubkey *script_pubkey, int64_t amount)
Create a transaction output from a script pubkey and an amount.
btck_Transaction * btck_transaction_copy(const btck_Transaction *transaction)
Copy a transaction.
btck_TxValidationState * btck_tx_validation_state_create()
Create a new btck_TxValidationState.
const btck_Transaction * btck_block_get_transaction_at(const btck_Block *block, size_t index)
Get the transaction at the provided index.
const btck_Chain * btck_chainstate_manager_get_active_chain(const btck_ChainstateManager *chainman)
Returns the best known currently active chain.
btck_ChainstateManagerOptions * btck_chainstate_manager_options_create(const btck_Context *context, const char *data_dir, size_t data_dir_len, const char *blocks_dir, size_t blocks_dir_len)
Create options for the chainstate manager.
btck_BlockValidationResult btck_block_validation_state_get_block_validation_result(const btck_BlockValidationState *block_validation_state_)
Returns the validation result from an opaque btck_BlockValidationState pointer.
btck_BlockValidationState * btck_block_validation_state_copy(const btck_BlockValidationState *state)
Copies the btck_BlockValidationState.
void btck_block_hash_to_bytes(const btck_BlockHash *block_hash, unsigned char output[32])
uint32_t btck_transaction_input_get_sequence(const btck_TransactionInput *input)
Get a transaction input's nSequence value.
void btck_transaction_output_destroy(btck_TransactionOutput *output)
Destroy the transaction output.
size_t btck_transaction_spent_outputs_count(const btck_TransactionSpentOutputs *transaction_spent_outputs)
Returns the number of previous transaction outputs contained in the transaction spent outputs data.
#define btck_ChainType_REGTEST
uint8_t btck_LogLevel
The severity of a log statement.
#define btck_TxValidationResult_NOT_STANDARD
otherwise didn't meet local policy rules
#define btck_TxValidationResult_CONFLICT
tx already in mempool or conflicts with a tx in the chain
#define btck_LogLevel_WARNING
int(* btck_WriteBytes)(const void *bytes, size_t size, void *userdata)
Function signature for serializing data.
#define btck_TxValidationResult_RECONSIDERABLE
fails some policy, but might be acceptable if submitted in a (different) package
uint32_t btck_TxValidationResult
Indicates the reason why a transaction failed validation.
#define btck_ChainType_MAINNET
#define btck_BlockValidationResult_HEADER_LOW_WORK
the block header may be on a too-little-work chain
#define btck_Warning_UNKNOWN_NEW_RULES_ACTIVATED
#define btck_TxValidationResult_MISSING_INPUTS
transaction was missing some of its inputs
uint8_t btck_ChainType
#define btck_BlockValidationResult_INVALID_PREV
A block this one builds on is invalid.
#define btck_BlockCheckFlags_MERKLE
verify merkle root (and mutation detection)
#define btck_LogCategory_MEMPOOL
#define btck_TxValidationResult_UNKNOWN
transaction was not validated because package failed
#define btck_LogLevel_TRACE
#define btck_ChainType_TESTNET
#define btck_SynchronizationState_INIT_REINDEX
#define btck_ScriptVerifyStatus_ERROR_INVALID_FLAGS_COMBINATION
The flags were combined in an invalid way.
uint32_t btck_BlockValidationResult
A granular "reason" why a block was invalid.
#define btck_LogCategory_BENCH
uint8_t btck_ValidationMode
Whether a validated data structure is valid, invalid, or an error was encountered during processing.
#define btck_ScriptVerificationFlags_ALL
void(* btck_LogCallback)(void *user_data, const btck_LogEntry *entry)
Callback function types.
#define btck_LogCategory_LOCK
#define btck_LogCategory_PRUNE
uint8_t btck_SynchronizationState
Current sync state passed to tip changed callbacks.
#define btck_ChainType_TESTNET_4
#define btck_LogCategory_COINDB
#define btck_TxValidationResult_NO_MEMPOOL
this node does not have a mempool so can't validate the transaction
#define btck_ScriptVerificationFlags_TAPROOT
enable TAPROOT (BIPs 341 & 342)
#define btck_ScriptVerifyStatus_ERROR_SPENT_OUTPUTS_REQUIRED
The taproot flag was set, so valid spent_outputs have to be provided.
#define btck_BlockCheckFlags_POW
run CheckProofOfWork via CheckBlockHeader
void(* btck_DestroyCallback)(void *user_data)
Function signature for freeing user data.
uint32_t btck_ScriptVerificationFlags
Script verification flags that may be composed with each other.
#define btck_LogCategory_VALIDATION
#define btck_LogCategory_REINDEX
#define btck_LogLevel_DEBUG
#define btck_ScriptVerifyStatus_OK
#define btck_TxValidationResult_WITNESS_STRIPPED
transaction is missing a witness
#define btck_LogCategory_RAND
#define btck_TxValidationResult_INPUTS_NOT_STANDARD
inputs (covered by txid) failed policy rules
#define btck_BlockValidationResult_CONSENSUS
invalid by consensus rules (excluding any below reasons)
#define btck_BlockValidationResult_UNSET
initial value. Block has not yet been rejected
#define btck_TxValidationResult_UNSET
initial value. Tx has not yet been rejected
#define btck_SynchronizationState_POST_INIT
#define btck_BlockValidationResult_MISSING_PREV
We don't have the previous block the checked one is built on.
uint8_t btck_ScriptVerifyStatus
A collection of status codes that may be issued by the script verify function.
#define btck_ValidationMode_INTERNAL_ERROR
#define btck_TxValidationResult_WITNESS_MUTATED
witness may have been malleated or is prior to SegWit activation
uint8_t btck_LogCategory
A collection of logging categories that may be encountered by kernel code.
#define btck_ValidationMode_INVALID
#define btck_ChainType_SIGNET
#define btck_TxValidationResult_CONSENSUS
invalid by consensus rules
uint32_t btck_BlockCheckFlags
Bitflags to control context-free block checks (optional).
#define btck_BlockValidationResult_INVALID_HEADER
invalid proof of work or time too old
uint8_t btck_Warning
Possible warning types issued by validation.
#define btck_LogCategory_NONE
Not tied to a specific category, e.g. most INFO, WARNING and ERROR entries.
#define btck_BlockValidationResult_TIME_FUTURE
block timestamp was > 2 hours in the future (or our clock is bad)
#define btck_LogCategory_LEVELDB
#define btck_LogLevel_ERROR
#define btck_BlockValidationResult_CACHED_INVALID
this block was cached as being invalid and we didn't store the reason why
#define btck_Warning_LARGE_WORK_INVALID_CHAIN
#define btck_LogLevel_INFO
#define btck_TxValidationResult_PREMATURE_SPEND
transaction spends a coinbase too early, or violates locktime/sequence locks
#define btck_LogCategory_BLOCKSTORAGE
#define btck_ValidationMode_VALID
#define btck_LogCategory_KERNEL
#define btck_BlockValidationResult_MUTATED
the block's data didn't match the data committed to by the PoW
#define btck_LogCategory_TXPACKAGES
#define btck_TxValidationResult_MEMPOOL_POLICY
violated mempool's fee/size/descendant/RBF/etc limits
#define btck_SynchronizationState_INIT_DOWNLOAD
const CChainParams & Params()
Return the currently selected parameters.
#define Assume(val)
Assume is the identity function.
Definition: check.h:128
Nodes collect new transactions into a block, hash them into a hash tree, and scan through nonce value...
Definition: block.h:27
The block chain is a tree shaped structure starting with the genesis block at the root,...
Definition: chain.h:94
CChainParams defines various tweakable parameters of a given instance of the Bitcoin system.
Definition: chainparams.h:77
static std::unique_ptr< const CChainParams > TestNet4()
Definition: chainparams.h:180
static std::unique_ptr< const CChainParams > Main()
Definition: chainparams.h:176
static std::unique_ptr< const CChainParams > TestNet()
Definition: chainparams.h:178
static std::unique_ptr< const CChainParams > SigNet()
Definition: chainparams.h:174
static std::unique_ptr< const CChainParams > RegTest()
Definition: chainparams.h:172
The basic transaction that is broadcasted on the network and contained in blocks.
Definition: transaction.h:287
const std::vector< CTxOut > vout
Definition: transaction.h:298
An output of a transaction.
Definition: transaction.h:141
Implement this to subscribe to events generated in validation and mempool.
virtual void NewPoWValidBlock(const CBlockIndex *pindex, const std::shared_ptr< const CBlock > &block)
Notifies listeners that a block which builds directly on our current tip has been received and connec...
virtual void BlockChecked(const std::shared_ptr< const CBlock > &, const BlockValidationState &)
Notifies listeners of a block validation result.
virtual void BlockDisconnected(const std::shared_ptr< const CBlock > &block, const CBlockIndex *pindex)
Notifies listeners of a block being disconnected Provides the block that was disconnected.
virtual void BlockConnected(const kernel::ChainstateRole &role, const std::shared_ptr< const CBlock > &block, const CBlockIndex *pindex)
Notifies listeners of a block being connected.
Interface for managing multiple Chainstate objects, where each chainstate is associated with chainsta...
Definition: validation.h:950
A UTXO entry.
Definition: coins.h:46
std::string_view function_name_short() const
Definition: log.h:36
std::string_view file_name() const
Definition: log.h:34
std::uint_least32_t line() const
Definition: log.h:35
Minimal stream for reading from an existing byte array by std::span.
Definition: streams.h:83
Minimal stream for writing to an existing span of bytes.
Definition: streams.h:130
void RegisterSharedValidationInterface(std::shared_ptr< CValidationInterface > callbacks)
Register subscriber.
void UnregisterSharedValidationInterface(std::shared_ptr< CValidationInterface > callbacks)
Unregister subscriber.
A base class defining functions for notifying about certain kernel events.
virtual void headerTip(SynchronizationState state, int64_t height, int64_t timestamp, bool presync)
virtual void fatalError(const bilingual_str &message)
The fatal error notification is sent to notify the user when an error occurs in kernel code that can'...
virtual void warningSet(Warning id, const bilingual_str &message)
virtual void progress(const bilingual_str &title, int progress_percent, bool resume_possible)
virtual InterruptResult blockTip(SynchronizationState state, const CBlockIndex &index, double verification_progress)
virtual void flushError(const bilingual_str &message)
The flush error notification is sent to notify the user that an error occurred while flushing block d...
virtual void warningUnset(Warning id)
static constexpr script_verify_flags from_int(value_type f)
Definition: verify_flags.h:35
static const PrecomputedData data
Precomputed COutPoint and CCoins values.
@ BLOCK_HEADER_LOW_WORK
the block header may be on a too-little-work chain
@ BLOCK_INVALID_HEADER
invalid proof of work or time too old
@ BLOCK_CACHED_INVALID
this block was cached as being invalid and we didn't store the reason why
@ BLOCK_CONSENSUS
invalid by consensus rules (excluding any below reasons)
@ BLOCK_MISSING_PREV
We don't have the previous block the checked one is built on.
@ BLOCK_INVALID_PREV
A block this one builds on is invalid.
@ BLOCK_MUTATED
the block's data didn't match the data committed to by the PoW
@ BLOCK_TIME_FUTURE
block timestamp was > 2 hours in the future (or our clock is bad)
@ BLOCK_RESULT_UNSET
initial value. Block has not yet been rejected
@ TX_MISSING_INPUTS
transaction was missing some of its inputs
@ TX_MEMPOOL_POLICY
violated mempool's fee/size/descendant/RBF/etc limits
@ TX_UNKNOWN
transaction was not validated because package failed
@ TX_PREMATURE_SPEND
transaction spends a coinbase too early, or violates locktime/sequence locks
@ TX_INPUTS_NOT_STANDARD
inputs (covered by txid) failed policy rules
@ TX_WITNESS_STRIPPED
Transaction is missing a witness.
@ TX_CONFLICT
Tx already in mempool or conflicts with a tx in the chain (if it conflicts with another tx in mempool...
@ TX_NOT_STANDARD
otherwise didn't meet our local policy rules
@ TX_WITNESS_MUTATED
Transaction might have a witness prior to SegWit activation, or witness may have been malleated (whic...
@ TX_NO_MEMPOOL
this node does not have a mempool so can't validate the transaction
@ TX_RESULT_UNSET
initial value. Tx has not yet been rejected
@ TX_CONSENSUS
invalid by consensus rules
@ TX_RECONSIDERABLE
fails some policy, but might be acceptable if submitted in a (different) package
RecursiveMutex cs_main
Mutex to guard access to validation specific variables, such as reading or changing the chainstate.
Definition: cs_main.cpp:8
static path absolute(const path &p)
Definition: fs.h:87
static path PathFromString(const std::string &string)
Convert byte string to path object.
Definition: fs.h:183
bool VerifyScript(const CScript &scriptSig, const CScript &scriptPubKey, const CScriptWitness *witness, script_verify_flags flags, const BaseSignatureChecker &checker, ScriptError *serror)
@ FAIL
Just act as if the signature was invalid.
Context m_context
Definition: protocol.cpp:147
constexpr uint64_t MAX_DBCACHE_BYTES
Maximum total database cache on current architecture (bytes)
Definition: caches.h:17
constexpr uint64_t DEFAULT_KERNEL_CACHE
Suggested default amount of cache reserved for the kernel (bytes)
Definition: caches.h:19
#define LogInfo(...)
Definition: log.h:126
#define LogError(...)
Definition: log.h:128
#define LogDebug(category,...)
Definition: log.h:144
unsigned int nHeight
LogFlags
Definition: categories.h:14
@ RAND
Definition: categories.h:29
@ BLOCKSTORAGE
Definition: categories.h:42
@ COINDB
Definition: categories.h:33
@ REINDEX
Definition: categories.h:27
@ TXPACKAGES
Definition: categories.h:45
@ ALL
Definition: categories.h:49
@ LEVELDB
Definition: categories.h:35
@ VALIDATION
Definition: categories.h:36
@ PRUNE
Definition: categories.h:30
@ MEMPOOL
Definition: categories.h:18
@ BENCH
Definition: categories.h:20
@ KERNEL
Definition: categories.h:46
Transaction validation functions.
std::ostream & operator<<(std::ostream &os, BigO const &bigO)
std::variant< std::monostate, Interrupted > InterruptResult
Simple result type for functions that need to propagate an interrupt status and don't have other retu...
Warning
Definition: warning.h:9
util::Result< void > SanityChecks(const Context &)
Ensure a usable environment with all necessary library support.
Definition: checks.cpp:15
Definition: messages.h:21
ChainstateLoadResult LoadChainstate(ChainstateManager &chainman, const CacheSizes &cache_sizes, const ChainstateLoadOptions &options)
Definition: chainstate.cpp:151
ChainstateLoadResult VerifyLoadedChainstate(ChainstateManager &chainman, const ChainstateLoadOptions &options)
Definition: chainstate.cpp:240
void ImportBlocks(ChainstateManager &chainman, std::span< const fs::path > import_paths)
void Log(Entry entry)
Send message to be logged.
Level
Definition: log.h:53
bool ShouldDebugLog(Category)
Return whether messages with specified category should be debug logged.
bool ShouldTraceLog(Category)
Return whether messages with specified category should be trace logged.
uint64_t Category
Opaque to util::log; interpreted by consumers (e.g., BCLog::LogFlags).
Definition: log.h:45
bilingual_str ErrorString(const Result< T > &result)
Definition: result.h:93
std::string_view RemoveSuffixView(std::string_view str LIFETIMEBOUND, std::string_view suffix)
Definition: string.h:178
ValidationSignals & m_signals
Definition: interfaces.cpp:511
std::shared_ptr< Chain::Notifications > m_notifications
Definition: interfaces.cpp:492
constexpr TransactionSerParams TX_WITH_WITNESS
Definition: transaction.h:181
void Serialize(Stream &, V)=delete
constexpr deserialize_type deserialize
Definition: serialize.h:52
#define STDLOCK(cs)
Definition: stdmutex.h:41
SigNetOptions holds configurations for creating a signet CChainParams.
Definition: chainparams.h:148
Application-specific storage settings.
Definition: dbwrapper.h:43
Bilingual messages:
Definition: translation.h:24
std::string original
Definition: translation.h:25
A log entry passed to the logging callback.
const char * message
Log message text.
A struct for holding the kernel notification callbacks.
btck_NotifyWarningUnset warning_unset
A previous condition leading to the issuance of a warning is no longer given.
btck_NotifyBlockTip block_tip
The chain's tip was updated to the provided block entry.
btck_NotifyWarningSet warning_set
A warning issued by the kernel library during validation.
btck_NotifyFlushError flush_error
An error encountered when flushing data to disk.
btck_NotifyProgress progress
Reports on current block synchronization progress.
btck_NotifyFatalError fatal_error
An unrecoverable system error encountered by the library.
btck_DestroyCallback user_data_destroy
Frees the provided user data structure.
void * user_data
Holds a user-defined opaque structure that is passed to the notification callbacks.
btck_NotifyHeaderTip header_tip
A new best block header was added.
Holds the validation interface callbacks.
btck_DestroyCallback user_data_destroy
Frees the provided user data structure.
btck_ValidationInterfaceBlockConnected block_connected
Called when a block is valid and has now been connected to the best chain.
btck_ValidationInterfaceBlockChecked block_checked
Called when a new block has been fully validated.
btck_ValidationInterfaceBlockDisconnected block_disconnected
Called during a re-org when a block has been removed from the best chain.
void * user_data
Holds a user-defined opaque structure that is passed to the validation interface callbacks.
btck_ValidationInterfacePoWValidBlock pow_valid_block
Called when a new block extends the header chain and has a valid transaction and segwit merkle root.
An options struct for BlockManager, more ergonomically referred to as BlockManager::Options due to th...
uint64_t block_tree_db
Definition: caches.h:30
An options struct for ChainstateManager, more ergonomically referred to as ChainstateManager::Options...
Information about chainstate that notifications are sent from.
Definition: types.h:18
Context struct holding the kernel library's logically global state, and passed to external libbitcoin...
Definition: context.h:16
Definition: log.h:61
SourceLocation source_loc
Definition: log.h:68
SystemClock::time_point timestamp
Definition: log.h:65
std::string thread_name
Definition: log.h:67
Level level
Definition: log.h:63
std::string message
Definition: log.h:69
std::chrono::seconds mocktime
Definition: log.h:66
Category category
Definition: log.h:62
#define LOCK(cs)
Definition: sync.h:268
#define WITH_LOCK(cs, code)
Run code while locking a mutex.
Definition: sync.h:299
This header provides an interface and simple implementation for a task runner.
#define EXCLUSIVE_LOCKS_REQUIRED(...)
Definition: threadsafety.h:49
#define GUARDED_BY(x)
Definition: threadsafety.h:37
std::function< std::string(const char *)> TranslateFn
Translate a message to the native language of the user.
Definition: translation.h:16
bool CheckTransaction(const CTransaction &tx, TxValidationState &state)
Definition: tx_check.cpp:19
void SetMockTime(std::chrono::time_point< NodeClock, std::chrono::seconds > mock)
Definition: time.cpp:52
bool CheckBlock(const CBlock &block, BlockValidationState &state, const Consensus::Params &consensusParams, bool fCheckPOW, bool fCheckMerkleRoot)
Functions for validating blocks and updating the block tree.
assert(!tx.IsCoinBase())
SynchronizationState
Current sync state passed to tip changed callbacks.
Definition: validation.h:96
WalletContext context