Bitcoin Core 31.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 <chain.h>
10#include <coins.h>
11#include <consensus/tx_check.h>
13#include <dbwrapper.h>
14#include <kernel/caches.h>
15#include <kernel/chainparams.h>
16#include <kernel/checks.h>
17#include <kernel/context.h>
19#include <kernel/warning.h>
20#include <logging.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/result.h>
37#include <util/task_runner.h>
38#include <util/translation.h>
39#include <validation.h>
40#include <validationinterface.h>
41
42#include <cstddef>
43#include <cstring>
44#include <exception>
45#include <functional>
46#include <list>
47#include <memory>
48#include <span>
49#include <stdexcept>
50#include <string>
51#include <tuple>
52#include <utility>
53#include <vector>
54
55namespace Consensus {
56struct Params;
57} // namespace Consensus
58
61
62// Define G_TRANSLATION_FUN symbol in libbitcoinkernel library so users of the
63// library aren't required to export this symbol
64extern const TranslateFn G_TRANSLATION_FUN{nullptr};
65
67
68namespace {
69
70bool is_valid_flag_combination(script_verify_flags flags)
71{
73 if (flags & SCRIPT_VERIFY_WITNESS && ~flags & SCRIPT_VERIFY_P2SH) return false;
74 return true;
75}
76
77class WriterStream
78{
79private:
80 btck_WriteBytes m_writer;
81 void* m_user_data;
82
83public:
84 WriterStream(btck_WriteBytes writer, void* user_data)
85 : m_writer{writer}, m_user_data{user_data} {}
86
87 //
88 // Stream subset
89 //
90 void write(std::span<const std::byte> src)
91 {
92 if (m_writer(src.data(), src.size(), m_user_data) != 0) {
93 throw std::runtime_error("Failed to write serialization data");
94 }
95 }
96
97 template <typename T>
98 WriterStream& operator<<(const T& obj)
99 {
100 ::Serialize(*this, obj);
101 return *this;
102 }
103};
104
105template <typename C, typename CPP>
106struct Handle {
107 static C* ref(CPP* cpp_type)
108 {
109 return reinterpret_cast<C*>(cpp_type);
110 }
111
112 static const C* ref(const CPP* cpp_type)
113 {
114 return reinterpret_cast<const C*>(cpp_type);
115 }
116
117 template <typename... Args>
118 static C* create(Args&&... args)
119 {
120 auto cpp_obj{std::make_unique<CPP>(std::forward<Args>(args)...)};
121 return ref(cpp_obj.release());
122 }
123
124 static C* copy(const C* ptr)
125 {
126 auto cpp_obj{std::make_unique<CPP>(get(ptr))};
127 return ref(cpp_obj.release());
128 }
129
130 static const CPP& get(const C* ptr)
131 {
132 return *reinterpret_cast<const CPP*>(ptr);
133 }
134
135 static CPP& get(C* ptr)
136 {
137 return *reinterpret_cast<CPP*>(ptr);
138 }
139
140 static void operator delete(void* ptr)
141 {
142 delete reinterpret_cast<CPP*>(ptr);
143 }
144};
145
146} // namespace
147
148struct btck_BlockTreeEntry: Handle<btck_BlockTreeEntry, CBlockIndex> {};
149struct btck_Block : Handle<btck_Block, std::shared_ptr<const CBlock>> {};
150struct btck_BlockValidationState : Handle<btck_BlockValidationState, BlockValidationState> {};
151struct btck_TxValidationState : Handle<btck_TxValidationState, TxValidationState> {};
152
153namespace {
154
155BCLog::Level get_bclog_level(btck_LogLevel level)
156{
157 switch (level) {
158 case btck_LogLevel_INFO: {
159 return BCLog::Level::Info;
160 }
161 case btck_LogLevel_DEBUG: {
162 return BCLog::Level::Debug;
163 }
164 case btck_LogLevel_TRACE: {
165 return BCLog::Level::Trace;
166 }
167 }
168 assert(false);
169}
170
171BCLog::LogFlags get_bclog_flag(btck_LogCategory category)
172{
173 switch (category) {
176 }
179 }
182 }
185 }
188 }
191 }
194 }
197 }
200 }
203 }
206 }
207 }
208 assert(false);
209}
210
212{
213 switch (state) {
220 } // no default case, so the compiler can warn about missing cases
221 assert(false);
222}
223
224btck_Warning cast_btck_warning(kernel::Warning warning)
225{
226 switch (warning) {
231 } // no default case, so the compiler can warn about missing cases
232 assert(false);
233}
234
235struct LoggingConnection {
236 std::unique_ptr<std::list<std::function<void(const std::string&)>>::iterator> m_connection;
237 void* m_user_data;
238 std::function<void(void* user_data)> m_deleter;
239
240 LoggingConnection(btck_LogCallback callback, void* user_data, btck_DestroyCallback user_data_destroy_callback)
241 {
242 LOCK(cs_main);
243
244 auto connection{LogInstance().PushBackCallback([callback, user_data](const std::string& str) { callback(user_data, str.c_str(), str.length()); })};
245
246 // Only start logging if we just added the connection.
247 if (LogInstance().NumConnections() == 1 && !LogInstance().StartLogging()) {
248 LogError("Logger start failed.");
249 LogInstance().DeleteCallback(connection);
250 if (user_data && user_data_destroy_callback) {
251 user_data_destroy_callback(user_data);
252 }
253 throw std::runtime_error("Failed to start logging");
254 }
255
256 m_connection = std::make_unique<std::list<std::function<void(const std::string&)>>::iterator>(connection);
257 m_user_data = user_data;
258 m_deleter = user_data_destroy_callback;
259
260 LogDebug(BCLog::KERNEL, "Logger connected.");
261 }
262
263 ~LoggingConnection()
264 {
265 LOCK(cs_main);
266 LogDebug(BCLog::KERNEL, "Logger disconnecting.");
267
268 // Switch back to buffering by calling DisconnectTestLogger if the
269 // connection that we are about to remove is the last one.
270 if (LogInstance().NumConnections() == 1) {
272 } else {
274 }
275
276 m_connection.reset();
277 if (m_user_data && m_deleter) {
278 m_deleter(m_user_data);
279 }
280 }
281};
282
283class KernelNotifications final : public kernel::Notifications
284{
285private:
287
288public:
289 KernelNotifications(btck_NotificationInterfaceCallbacks cbs)
290 : m_cbs{cbs}
291 {
292 }
293
294 ~KernelNotifications()
295 {
296 if (m_cbs.user_data && m_cbs.user_data_destroy) {
297 m_cbs.user_data_destroy(m_cbs.user_data);
298 }
299 m_cbs.user_data_destroy = nullptr;
300 m_cbs.user_data = nullptr;
301 }
302
303 kernel::InterruptResult blockTip(SynchronizationState state, const CBlockIndex& index, double verification_progress) override
304 {
305 if (m_cbs.block_tip) m_cbs.block_tip(m_cbs.user_data, cast_state(state), btck_BlockTreeEntry::ref(&index), verification_progress);
306 return {};
307 }
308 void headerTip(SynchronizationState state, int64_t height, int64_t timestamp, bool presync) override
309 {
310 if (m_cbs.header_tip) m_cbs.header_tip(m_cbs.user_data, cast_state(state), height, timestamp, presync ? 1 : 0);
311 }
312 void progress(const bilingual_str& title, int progress_percent, bool resume_possible) override
313 {
314 if (m_cbs.progress) m_cbs.progress(m_cbs.user_data, title.original.c_str(), title.original.length(), progress_percent, resume_possible ? 1 : 0);
315 }
316 void warningSet(kernel::Warning id, const bilingual_str& message) override
317 {
318 if (m_cbs.warning_set) m_cbs.warning_set(m_cbs.user_data, cast_btck_warning(id), message.original.c_str(), message.original.length());
319 }
320 void warningUnset(kernel::Warning id) override
321 {
322 if (m_cbs.warning_unset) m_cbs.warning_unset(m_cbs.user_data, cast_btck_warning(id));
323 }
324 void flushError(const bilingual_str& message) override
325 {
326 if (m_cbs.flush_error) m_cbs.flush_error(m_cbs.user_data, message.original.c_str(), message.original.length());
327 }
328 void fatalError(const bilingual_str& message) override
329 {
330 if (m_cbs.fatal_error) m_cbs.fatal_error(m_cbs.user_data, message.original.c_str(), message.original.length());
331 }
332};
333
334class KernelValidationInterface final : public CValidationInterface
335{
336public:
338
339 explicit KernelValidationInterface(const btck_ValidationInterfaceCallbacks vi_cbs) : m_cbs{vi_cbs} {}
340
341 ~KernelValidationInterface()
342 {
343 if (m_cbs.user_data && m_cbs.user_data_destroy) {
344 m_cbs.user_data_destroy(m_cbs.user_data);
345 }
346 m_cbs.user_data = nullptr;
347 m_cbs.user_data_destroy = nullptr;
348 }
349
350protected:
351 void BlockChecked(const std::shared_ptr<const CBlock>& block, const BlockValidationState& stateIn) override
352 {
353 if (m_cbs.block_checked) {
354 m_cbs.block_checked(m_cbs.user_data,
355 btck_Block::copy(btck_Block::ref(&block)),
356 btck_BlockValidationState::ref(&stateIn));
357 }
358 }
359
360 void NewPoWValidBlock(const CBlockIndex* pindex, const std::shared_ptr<const CBlock>& block) override
361 {
362 if (m_cbs.pow_valid_block) {
363 m_cbs.pow_valid_block(m_cbs.user_data,
364 btck_Block::copy(btck_Block::ref(&block)),
365 btck_BlockTreeEntry::ref(pindex));
366 }
367 }
368
369 void BlockConnected(const ChainstateRole& role, const std::shared_ptr<const CBlock>& block, const CBlockIndex* pindex) override
370 {
371 if (m_cbs.block_connected) {
372 m_cbs.block_connected(m_cbs.user_data,
373 btck_Block::copy(btck_Block::ref(&block)),
374 btck_BlockTreeEntry::ref(pindex));
375 }
376 }
377
378 void BlockDisconnected(const std::shared_ptr<const CBlock>& block, const CBlockIndex* pindex) override
379 {
380 if (m_cbs.block_disconnected) {
381 m_cbs.block_disconnected(m_cbs.user_data,
382 btck_Block::copy(btck_Block::ref(&block)),
383 btck_BlockTreeEntry::ref(pindex));
384 }
385 }
386};
387
388struct ContextOptions {
389 mutable Mutex m_mutex;
390 std::unique_ptr<const CChainParams> m_chainparams GUARDED_BY(m_mutex);
391 std::shared_ptr<KernelNotifications> m_notifications GUARDED_BY(m_mutex);
392 std::shared_ptr<KernelValidationInterface> m_validation_interface GUARDED_BY(m_mutex);
393};
394
395class Context
396{
397public:
398 std::unique_ptr<kernel::Context> m_context;
399
400 std::shared_ptr<KernelNotifications> m_notifications;
401
402 std::unique_ptr<util::SignalInterrupt> m_interrupt;
403
404 std::unique_ptr<ValidationSignals> m_signals;
405
406 std::unique_ptr<const CChainParams> m_chainparams;
407
408 std::shared_ptr<KernelValidationInterface> m_validation_interface;
409
410 Context(const ContextOptions* options, bool& sane)
411 : m_context{std::make_unique<kernel::Context>()},
412 m_interrupt{std::make_unique<util::SignalInterrupt>()}
413 {
414 if (options) {
415 LOCK(options->m_mutex);
416 if (options->m_chainparams) {
417 m_chainparams = std::make_unique<const CChainParams>(*options->m_chainparams);
418 }
419 if (options->m_notifications) {
420 m_notifications = options->m_notifications;
421 }
422 if (options->m_validation_interface) {
423 m_signals = std::make_unique<ValidationSignals>(std::make_unique<ImmediateTaskRunner>());
424 m_validation_interface = options->m_validation_interface;
425 m_signals->RegisterSharedValidationInterface(m_validation_interface);
426 }
427 }
428
429 if (!m_chainparams) {
430 m_chainparams = CChainParams::Main();
431 }
432 if (!m_notifications) {
433 m_notifications = std::make_shared<KernelNotifications>(btck_NotificationInterfaceCallbacks{
434 nullptr, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr});
435 }
436
438 sane = false;
439 }
440 }
441
442 ~Context()
443 {
444 if (m_signals) {
445 m_signals->UnregisterSharedValidationInterface(m_validation_interface);
446 }
447 }
448};
449
451struct ChainstateManagerOptions {
452 mutable Mutex m_mutex;
453 ChainstateManager::Options m_chainman_options GUARDED_BY(m_mutex);
454 node::BlockManager::Options m_blockman_options GUARDED_BY(m_mutex);
455 std::shared_ptr<const Context> m_context;
456 node::ChainstateLoadOptions m_chainstate_load_options GUARDED_BY(m_mutex);
457
458 ChainstateManagerOptions(const std::shared_ptr<const Context>& context, const fs::path& data_dir, const fs::path& blocks_dir)
459 : m_chainman_options{ChainstateManager::Options{
460 .chainparams = *context->m_chainparams,
461 .datadir = data_dir,
462 .notifications = *context->m_notifications,
463 .signals = context->m_signals.get()}},
464 m_blockman_options{node::BlockManager::Options{
465 .chainparams = *context->m_chainparams,
466 .blocks_dir = blocks_dir,
467 .notifications = *context->m_notifications,
468 .block_tree_db_params = DBParams{
469 .path = data_dir / "blocks" / "index",
470 .cache_bytes = kernel::CacheSizes{DEFAULT_KERNEL_CACHE}.block_tree_db,
471 }}},
472 m_context{context}, m_chainstate_load_options{node::ChainstateLoadOptions{}}
473 {
474 }
475};
476
477struct ChainMan {
478 std::unique_ptr<ChainstateManager> m_chainman;
479 std::shared_ptr<const Context> m_context;
480
481 ChainMan(std::unique_ptr<ChainstateManager> chainman, std::shared_ptr<const Context> context)
482 : m_chainman(std::move(chainman)), m_context(std::move(context)) {}
483};
484
485} // namespace
486
487struct btck_Transaction : Handle<btck_Transaction, std::shared_ptr<const CTransaction>> {};
488struct btck_TransactionOutput : Handle<btck_TransactionOutput, CTxOut> {};
489struct btck_ScriptPubkey : Handle<btck_ScriptPubkey, CScript> {};
490struct btck_LoggingConnection : Handle<btck_LoggingConnection, LoggingConnection> {};
491struct btck_ContextOptions : Handle<btck_ContextOptions, ContextOptions> {};
492struct btck_Context : Handle<btck_Context, std::shared_ptr<const Context>> {};
493struct btck_ChainParameters : Handle<btck_ChainParameters, CChainParams> {};
494struct btck_ChainstateManagerOptions : Handle<btck_ChainstateManagerOptions, ChainstateManagerOptions> {};
495struct btck_ChainstateManager : Handle<btck_ChainstateManager, ChainMan> {};
496struct btck_Chain : Handle<btck_Chain, CChain> {};
497struct btck_BlockSpentOutputs : Handle<btck_BlockSpentOutputs, std::shared_ptr<CBlockUndo>> {};
498struct btck_TransactionSpentOutputs : Handle<btck_TransactionSpentOutputs, CTxUndo> {};
499struct btck_Coin : Handle<btck_Coin, Coin> {};
500struct btck_BlockHash : Handle<btck_BlockHash, uint256> {};
501struct btck_TransactionInput : Handle<btck_TransactionInput, CTxIn> {};
502struct btck_TransactionOutPoint: Handle<btck_TransactionOutPoint, COutPoint> {};
503struct btck_Txid: Handle<btck_Txid, Txid> {};
504struct btck_PrecomputedTransactionData : Handle<btck_PrecomputedTransactionData, PrecomputedTransactionData> {};
505struct btck_BlockHeader: Handle<btck_BlockHeader, CBlockHeader> {};
506struct btck_ConsensusParams: Handle<btck_ConsensusParams, Consensus::Params> {};
507
508btck_Transaction* btck_transaction_create(const void* raw_transaction, size_t raw_transaction_len)
509{
510 if (raw_transaction == nullptr && raw_transaction_len != 0) {
511 return nullptr;
512 }
513 try {
514 SpanReader stream{std::span{reinterpret_cast<const std::byte*>(raw_transaction), raw_transaction_len}};
515 return btck_Transaction::create(std::make_shared<const CTransaction>(deserialize, TX_WITH_WITNESS, stream));
516 } catch (...) {
517 return nullptr;
518 }
519}
520
522{
523 return btck_Transaction::get(transaction)->vout.size();
524}
525
526const btck_TransactionOutput* btck_transaction_get_output_at(const btck_Transaction* transaction, size_t output_index)
527{
528 const CTransaction& tx = *btck_Transaction::get(transaction);
529 assert(output_index < tx.vout.size());
530 return btck_TransactionOutput::ref(&tx.vout[output_index]);
531}
532
534{
535 return btck_Transaction::get(transaction)->vin.size();
536}
537
538const btck_TransactionInput* btck_transaction_get_input_at(const btck_Transaction* transaction, size_t input_index)
539{
540 assert(input_index < btck_Transaction::get(transaction)->vin.size());
541 return btck_TransactionInput::ref(&btck_Transaction::get(transaction)->vin[input_index]);
542}
543
545{
546 return btck_Transaction::get(transaction)->nLockTime;
547}
548
550{
551 return btck_Txid::ref(&btck_Transaction::get(transaction)->GetHash());
552}
553
555{
556 return btck_Transaction::copy(transaction);
557}
558
559int btck_transaction_to_bytes(const btck_Transaction* transaction, btck_WriteBytes writer, void* user_data)
560{
561 try {
562 WriterStream ws{writer, user_data};
563 ws << TX_WITH_WITNESS(btck_Transaction::get(transaction));
564 return 0;
565 } catch (...) {
566 return -1;
567 }
568}
569
571{
572 delete transaction;
573}
574
575btck_ScriptPubkey* btck_script_pubkey_create(const void* script_pubkey, size_t script_pubkey_len)
576{
577 if (script_pubkey == nullptr && script_pubkey_len != 0) {
578 return nullptr;
579 }
580 auto data = std::span{reinterpret_cast<const uint8_t*>(script_pubkey), script_pubkey_len};
581 return btck_ScriptPubkey::create(data.begin(), data.end());
582}
583
584int btck_script_pubkey_to_bytes(const btck_ScriptPubkey* script_pubkey_, btck_WriteBytes writer, void* user_data)
585{
586 const auto& script_pubkey{btck_ScriptPubkey::get(script_pubkey_)};
587 return writer(script_pubkey.data(), script_pubkey.size(), user_data);
588}
589
591{
592 return btck_ScriptPubkey::copy(script_pubkey);
593}
594
596{
597 delete script_pubkey;
598}
599
601{
602 return btck_TransactionOutput::create(amount, btck_ScriptPubkey::get(script_pubkey));
603}
604
606{
607 return btck_TransactionOutput::copy(output);
608}
609
611{
612 return btck_ScriptPubkey::ref(&btck_TransactionOutput::get(output).scriptPubKey);
613}
614
616{
617 return btck_TransactionOutput::get(output).nValue;
618}
619
621{
622 delete output;
623}
624
626 const btck_Transaction* tx_to,
627 const btck_TransactionOutput** spent_outputs_, size_t spent_outputs_len)
628{
629 try {
630 const CTransaction& tx{*btck_Transaction::get(tx_to)};
631 auto txdata{btck_PrecomputedTransactionData::create()};
632 if (spent_outputs_ != nullptr && spent_outputs_len > 0) {
633 assert(spent_outputs_len == tx.vin.size());
634 std::vector<CTxOut> spent_outputs;
635 spent_outputs.reserve(spent_outputs_len);
636 for (size_t i = 0; i < spent_outputs_len; i++) {
637 const CTxOut& tx_out{btck_TransactionOutput::get(spent_outputs_[i])};
638 spent_outputs.push_back(tx_out);
639 }
640 btck_PrecomputedTransactionData::get(txdata).Init(tx, std::move(spent_outputs));
641 } else {
642 btck_PrecomputedTransactionData::get(txdata).Init(tx, {});
643 }
644
645 return txdata;
646 } catch (...) {
647 return nullptr;
648 }
649}
650
652{
653 return btck_PrecomputedTransactionData::copy(precomputed_txdata);
654}
655
657{
658 delete precomputed_txdata;
659}
660
662 const int64_t amount,
663 const btck_Transaction* tx_to,
664 const btck_PrecomputedTransactionData* precomputed_txdata,
665 const unsigned int input_index,
668{
669 // Assert that all specified flags are part of the interface before continuing
671
672 if (!is_valid_flag_combination(script_verify_flags::from_int(flags))) {
674 return 0;
675 }
676
677 const CTransaction& tx{*btck_Transaction::get(tx_to)};
678 assert(input_index < tx.vin.size());
679
680 const PrecomputedTransactionData& txdata{precomputed_txdata ? btck_PrecomputedTransactionData::get(precomputed_txdata) : PrecomputedTransactionData(tx)};
681
682 if (flags & btck_ScriptVerificationFlags_TAPROOT && txdata.m_spent_outputs.empty()) {
684 return 0;
685 }
686
687 if (status) *status = btck_ScriptVerifyStatus_OK;
688
689 bool result = VerifyScript(tx.vin[input_index].scriptSig,
690 btck_ScriptPubkey::get(script_pubkey),
691 &tx.vin[input_index].scriptWitness,
693 TransactionSignatureChecker(&tx, input_index, amount, txdata, MissingDataBehavior::FAIL),
694 nullptr);
695 return result ? 1 : 0;
696}
697
699{
700 return btck_TransactionInput::copy(input);
701}
702
704{
705 return btck_TransactionOutPoint::ref(&btck_TransactionInput::get(input).prevout);
706}
707
709{
710 return btck_TransactionInput::get(input).nSequence;
711}
712
714{
715 delete input;
716}
717
719{
720 return btck_TransactionOutPoint::copy(out_point);
721}
722
724{
725 return btck_TransactionOutPoint::get(out_point).n;
726}
727
729{
730 return btck_Txid::ref(&btck_TransactionOutPoint::get(out_point).hash);
731}
732
734{
735 delete out_point;
736}
737
739{
740 return btck_Txid::copy(txid);
741}
742
743void btck_txid_to_bytes(const btck_Txid* txid, unsigned char output[32])
744{
745 std::memcpy(output, btck_Txid::get(txid).begin(), 32);
746}
747
748int btck_txid_equals(const btck_Txid* txid1, const btck_Txid* txid2)
749{
750 return btck_Txid::get(txid1) == btck_Txid::get(txid2);
751}
752
754{
755 delete txid;
756}
757
759{
760 LOCK(cs_main);
766}
767
769{
770 LOCK(cs_main);
771 if (category == btck_LogCategory_ALL) {
772 LogInstance().SetLogLevel(get_bclog_level(level));
773 }
774
775 LogInstance().AddCategoryLogLevel(get_bclog_flag(category), get_bclog_level(level));
776}
777
779{
780 LogInstance().EnableCategory(get_bclog_flag(category));
781}
782
784{
785 LogInstance().DisableCategory(get_bclog_flag(category));
786}
787
789{
791}
792
794{
795 try {
796 return btck_LoggingConnection::create(callback, user_data, user_data_destroy_callback);
797 } catch (const std::exception&) {
798 return nullptr;
799 }
800}
801
803{
804 delete connection;
805}
806
808{
809 switch (chain_type) {
811 return btck_ChainParameters::ref(const_cast<CChainParams*>(CChainParams::Main().release()));
812 }
814 return btck_ChainParameters::ref(const_cast<CChainParams*>(CChainParams::TestNet().release()));
815 }
817 return btck_ChainParameters::ref(const_cast<CChainParams*>(CChainParams::TestNet4().release()));
818 }
820 return btck_ChainParameters::ref(const_cast<CChainParams*>(CChainParams::SigNet({}).release()));
821 }
823 return btck_ChainParameters::ref(const_cast<CChainParams*>(CChainParams::RegTest({}).release()));
824 }
825 }
826 assert(false);
827}
828
830{
831 return btck_ChainParameters::copy(chain_parameters);
832}
833
835{
836 return btck_ConsensusParams::ref(&btck_ChainParameters::get(chain_parameters).GetConsensus());
837}
838
840{
841 delete chain_parameters;
842}
843
845{
846 return btck_ContextOptions::create();
847}
848
850{
851 // Copy the chainparams, so the caller can free it again
852 LOCK(btck_ContextOptions::get(options).m_mutex);
853 btck_ContextOptions::get(options).m_chainparams = std::make_unique<const CChainParams>(btck_ChainParameters::get(chain_parameters));
854}
855
857{
858 // The KernelNotifications are copy-initialized, so the caller can free them again.
859 LOCK(btck_ContextOptions::get(options).m_mutex);
860 btck_ContextOptions::get(options).m_notifications = std::make_shared<KernelNotifications>(notifications);
861}
862
864{
865 LOCK(btck_ContextOptions::get(options).m_mutex);
866 btck_ContextOptions::get(options).m_validation_interface = std::make_shared<KernelValidationInterface>(vi_cbs);
867}
868
870{
871 delete options;
872}
873
875{
876 bool sane{true};
877 const ContextOptions* opts = options ? &btck_ContextOptions::get(options) : nullptr;
878 auto context{std::make_shared<const Context>(opts, sane)};
879 if (!sane) {
880 LogError("Kernel context sanity check failed.");
881 return nullptr;
882 }
883 return btck_Context::create(context);
884}
885
887{
888 return btck_Context::copy(context);
889}
890
892{
893 return (*btck_Context::get(context)->m_interrupt)() ? 0 : -1;
894}
895
897{
898 delete context;
899}
900
902{
903 if (!btck_BlockTreeEntry::get(entry).pprev) {
904 LogInfo("Genesis block has no previous.");
905 return nullptr;
906 }
907
908 return btck_BlockTreeEntry::ref(btck_BlockTreeEntry::get(entry).pprev);
909}
910
912{
913 const auto* ancestor{btck_BlockTreeEntry::get(block_tree_entry).GetAncestor(height)};
914 assert(ancestor);
915 return btck_BlockTreeEntry::ref(ancestor);
916}
917
919{
920 return btck_BlockValidationState::create();
921}
922
924{
925 return btck_BlockValidationState::copy(state);
926}
927
929{
930 delete state;
931}
932
934{
935 auto& block_validation_state = btck_BlockValidationState::get(block_validation_state_);
936 if (block_validation_state.IsValid()) return btck_ValidationMode_VALID;
937 if (block_validation_state.IsInvalid()) return btck_ValidationMode_INVALID;
939}
940
942{
943 auto& block_validation_state = btck_BlockValidationState::get(block_validation_state_);
944 switch (block_validation_state.GetResult()) {
963 } // no default case, so the compiler can warn about missing cases
964 assert(false);
965}
966
967btck_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)
968{
969 if (data_dir == nullptr || data_dir_len == 0 || blocks_dir == nullptr || blocks_dir_len == 0) {
970 LogError("Failed to create chainstate manager options: dir must be non-null and non-empty");
971 return nullptr;
972 }
973 try {
974 fs::path abs_data_dir{fs::absolute(fs::PathFromString({data_dir, data_dir_len}))};
975 fs::create_directories(abs_data_dir);
976 fs::path abs_blocks_dir{fs::absolute(fs::PathFromString({blocks_dir, blocks_dir_len}))};
977 fs::create_directories(abs_blocks_dir);
978 return btck_ChainstateManagerOptions::create(btck_Context::get(context), abs_data_dir, abs_blocks_dir);
979 } catch (const std::exception& e) {
980 LogError("Failed to create chainstate manager options: %s", e.what());
981 return nullptr;
982 }
983}
984
986{
987 LOCK(btck_ChainstateManagerOptions::get(opts).m_mutex);
988 btck_ChainstateManagerOptions::get(opts).m_chainman_options.worker_threads_num = worker_threads;
989}
990
992{
993 delete options;
994}
995
996int btck_chainstate_manager_options_set_wipe_dbs(btck_ChainstateManagerOptions* chainman_opts, int wipe_block_tree_db, int wipe_chainstate_db)
997{
998 if (wipe_block_tree_db == 1 && wipe_chainstate_db != 1) {
999 LogError("Wiping the block tree db without also wiping the chainstate db is currently unsupported.");
1000 return -1;
1001 }
1002 auto& opts{btck_ChainstateManagerOptions::get(chainman_opts)};
1003 LOCK(opts.m_mutex);
1004 opts.m_blockman_options.block_tree_db_params.wipe_data = wipe_block_tree_db == 1;
1005 opts.m_chainstate_load_options.wipe_chainstate_db = wipe_chainstate_db == 1;
1006 return 0;
1007}
1008
1010 btck_ChainstateManagerOptions* chainman_opts,
1011 int block_tree_db_in_memory)
1012{
1013 auto& opts{btck_ChainstateManagerOptions::get(chainman_opts)};
1014 LOCK(opts.m_mutex);
1015 opts.m_blockman_options.block_tree_db_params.memory_only = block_tree_db_in_memory == 1;
1016}
1017
1019 btck_ChainstateManagerOptions* chainman_opts,
1020 int chainstate_db_in_memory)
1021{
1022 auto& opts{btck_ChainstateManagerOptions::get(chainman_opts)};
1023 LOCK(opts.m_mutex);
1024 opts.m_chainstate_load_options.coins_db_in_memory = chainstate_db_in_memory == 1;
1025}
1026
1028 const btck_ChainstateManagerOptions* chainman_opts)
1029{
1030 auto& opts{btck_ChainstateManagerOptions::get(chainman_opts)};
1031 std::unique_ptr<ChainstateManager> chainman;
1032 try {
1033 LOCK(opts.m_mutex);
1034 chainman = std::make_unique<ChainstateManager>(*opts.m_context->m_interrupt, opts.m_chainman_options, opts.m_blockman_options);
1035 } catch (const std::exception& e) {
1036 LogError("Failed to create chainstate manager: %s", e.what());
1037 return nullptr;
1038 }
1039
1040 try {
1041 const auto chainstate_load_opts{WITH_LOCK(opts.m_mutex, return opts.m_chainstate_load_options)};
1042
1044 auto [status, chainstate_err]{node::LoadChainstate(*chainman, cache_sizes, chainstate_load_opts)};
1046 LogError("Failed to load chain state from your data directory: %s", chainstate_err.original);
1047 return nullptr;
1048 }
1049 std::tie(status, chainstate_err) = node::VerifyLoadedChainstate(*chainman, chainstate_load_opts);
1051 LogError("Failed to verify loaded chain state from your datadir: %s", chainstate_err.original);
1052 return nullptr;
1053 }
1054 if (auto result = chainman->ActivateBestChains(); !result) {
1055 LogError("%s", util::ErrorString(result).original);
1056 return nullptr;
1057 }
1058 } catch (const std::exception& e) {
1059 LogError("Failed to load chainstate: %s", e.what());
1060 return nullptr;
1061 }
1062
1063 return btck_ChainstateManager::create(std::move(chainman), opts.m_context);
1064}
1065
1067{
1068 auto block_index = WITH_LOCK(btck_ChainstateManager::get(chainman).m_chainman->GetMutex(),
1069 return btck_ChainstateManager::get(chainman).m_chainman->m_blockman.LookupBlockIndex(btck_BlockHash::get(block_hash)));
1070 if (!block_index) {
1071 LogDebug(BCLog::KERNEL, "A block with the given hash is not indexed.");
1072 return nullptr;
1073 }
1074 return btck_BlockTreeEntry::ref(block_index);
1075}
1076
1078{
1079 auto& chainman = *btck_ChainstateManager::get(chainstate_manager).m_chainman;
1080 return btck_BlockTreeEntry::ref(WITH_LOCK(chainman.GetMutex(), return chainman.m_best_header));
1081}
1082
1084{
1085 {
1086 LOCK(btck_ChainstateManager::get(chainman).m_chainman->GetMutex());
1087 for (const auto& chainstate : btck_ChainstateManager::get(chainman).m_chainman->m_chainstates) {
1088 if (chainstate->CanFlushToDisk()) {
1089 chainstate->ForceFlushStateToDisk();
1090 chainstate->ResetCoinsViews();
1091 }
1092 }
1093 }
1094
1095 delete chainman;
1096}
1097
1098int 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)
1099{
1100 try {
1101 std::vector<fs::path> import_files;
1102 import_files.reserve(block_file_paths_data_len);
1103 for (uint32_t i = 0; i < block_file_paths_data_len; i++) {
1104 if (block_file_paths_data[i] != nullptr) {
1105 import_files.emplace_back(std::string{block_file_paths_data[i], block_file_paths_lens[i]}.c_str());
1106 }
1107 }
1108 auto& chainman_ref{*btck_ChainstateManager::get(chainman).m_chainman};
1109 node::ImportBlocks(chainman_ref, import_files);
1110 WITH_LOCK(::cs_main, chainman_ref.UpdateIBDStatus());
1111 } catch (const std::exception& e) {
1112 LogError("Failed to import blocks: %s", e.what());
1113 return -1;
1114 }
1115 return 0;
1116}
1117
1118btck_Block* btck_block_create(const void* raw_block, size_t raw_block_length)
1119{
1120 if (raw_block == nullptr && raw_block_length != 0) {
1121 return nullptr;
1122 }
1123 auto block{std::make_shared<CBlock>()};
1124
1125 SpanReader stream{std::span{reinterpret_cast<const std::byte*>(raw_block), raw_block_length}};
1126
1127 try {
1128 stream >> TX_WITH_WITNESS(*block);
1129 } catch (...) {
1130 LogDebug(BCLog::KERNEL, "Block decode failed.");
1131 return nullptr;
1132 }
1133
1134 return btck_Block::create(block);
1135}
1136
1138{
1139 return btck_Block::copy(block);
1140}
1141
1142int btck_block_check(const btck_Block* block, const btck_ConsensusParams* consensus_params, btck_BlockCheckFlags flags, btck_BlockValidationState* validation_state)
1143{
1144 auto& state = btck_BlockValidationState::get(validation_state);
1145 state = BlockValidationState{};
1146
1147 const bool check_pow = (flags & btck_BlockCheckFlags_POW) != 0;
1148 const bool check_merkle = (flags & btck_BlockCheckFlags_MERKLE) != 0;
1149
1150 const bool result = CheckBlock(*btck_Block::get(block), state, btck_ConsensusParams::get(consensus_params), /*fCheckPOW=*/check_pow, /*fCheckMerkleRoot=*/check_merkle);
1151
1152 return result ? 1 : 0;
1153}
1154
1156{
1157 return btck_Block::get(block)->vtx.size();
1158}
1159
1161{
1162 assert(index < btck_Block::get(block)->vtx.size());
1163 return btck_Transaction::ref(&btck_Block::get(block)->vtx[index]);
1164}
1165
1167{
1168 const auto& block_ptr = btck_Block::get(block);
1169 return btck_BlockHeader::create(static_cast<const CBlockHeader&>(*block_ptr));
1170}
1171
1172int btck_block_to_bytes(const btck_Block* block, btck_WriteBytes writer, void* user_data)
1173{
1174 try {
1175 WriterStream ws{writer, user_data};
1176 ws << TX_WITH_WITNESS(*btck_Block::get(block));
1177 return 0;
1178 } catch (...) {
1179 return -1;
1180 }
1181}
1182
1184{
1185 return btck_BlockHash::create(btck_Block::get(block)->GetHash());
1186}
1187
1189{
1190 delete block;
1191}
1192
1194{
1195 auto block{std::make_shared<CBlock>()};
1196 if (!btck_ChainstateManager::get(chainman).m_chainman->m_blockman.ReadBlock(*block, btck_BlockTreeEntry::get(entry))) {
1197 LogError("Failed to read block.");
1198 return nullptr;
1199 }
1200 return btck_Block::create(block);
1201}
1202
1204{
1205 return btck_BlockHeader::create(btck_BlockTreeEntry::get(entry).GetBlockHeader());
1206}
1207
1209{
1210 return btck_BlockTreeEntry::get(entry).nHeight;
1211}
1212
1214{
1215 return btck_BlockHash::ref(btck_BlockTreeEntry::get(entry).phashBlock);
1216}
1217
1219{
1220 return &btck_BlockTreeEntry::get(entry1) == &btck_BlockTreeEntry::get(entry2);
1221}
1222
1223btck_BlockHash* btck_block_hash_create(const unsigned char block_hash[32])
1224{
1225 return btck_BlockHash::create(std::span<const unsigned char>{block_hash, 32});
1226}
1227
1229{
1230 return btck_BlockHash::copy(block_hash);
1231}
1232
1233void btck_block_hash_to_bytes(const btck_BlockHash* block_hash, unsigned char output[32])
1234{
1235 std::memcpy(output, btck_BlockHash::get(block_hash).begin(), 32);
1236}
1237
1239{
1240 return btck_BlockHash::get(hash1) == btck_BlockHash::get(hash2);
1241}
1242
1244{
1245 delete hash;
1246}
1247
1249{
1250 auto block_undo{std::make_shared<CBlockUndo>()};
1251 if (btck_BlockTreeEntry::get(entry).nHeight < 1) {
1252 LogDebug(BCLog::KERNEL, "The genesis block does not have any spent outputs.");
1253 return btck_BlockSpentOutputs::create(block_undo);
1254 }
1255 if (!btck_ChainstateManager::get(chainman).m_chainman->m_blockman.ReadBlockUndo(*block_undo, btck_BlockTreeEntry::get(entry))) {
1256 LogError("Failed to read block spent outputs data.");
1257 return nullptr;
1258 }
1259 return btck_BlockSpentOutputs::create(block_undo);
1260}
1261
1263{
1264 return btck_BlockSpentOutputs::copy(block_spent_outputs);
1265}
1266
1268{
1269 return btck_BlockSpentOutputs::get(block_spent_outputs)->vtxundo.size();
1270}
1271
1273{
1274 assert(transaction_index < btck_BlockSpentOutputs::get(block_spent_outputs)->vtxundo.size());
1275 const auto* tx_undo{&btck_BlockSpentOutputs::get(block_spent_outputs)->vtxundo.at(transaction_index)};
1276 return btck_TransactionSpentOutputs::ref(tx_undo);
1277}
1278
1280{
1281 delete block_spent_outputs;
1282}
1283
1285{
1286 return btck_TransactionSpentOutputs::copy(transaction_spent_outputs);
1287}
1288
1290{
1291 return btck_TransactionSpentOutputs::get(transaction_spent_outputs).vprevout.size();
1292}
1293
1295{
1296 delete transaction_spent_outputs;
1297}
1298
1299const btck_Coin* btck_transaction_spent_outputs_get_coin_at(const btck_TransactionSpentOutputs* transaction_spent_outputs, size_t coin_index)
1300{
1301 assert(coin_index < btck_TransactionSpentOutputs::get(transaction_spent_outputs).vprevout.size());
1302 const Coin* coin{&btck_TransactionSpentOutputs::get(transaction_spent_outputs).vprevout.at(coin_index)};
1303 return btck_Coin::ref(coin);
1304}
1305
1307{
1308 return btck_Coin::copy(coin);
1309}
1310
1312{
1313 return btck_Coin::get(coin).nHeight;
1314}
1315
1317{
1318 return btck_Coin::get(coin).IsCoinBase() ? 1 : 0;
1319}
1320
1322{
1323 return btck_TransactionOutput::ref(&btck_Coin::get(coin).out);
1324}
1325
1327{
1328 delete coin;
1329}
1330
1332 btck_ChainstateManager* chainman,
1333 const btck_Block* block,
1334 int* _new_block)
1335{
1336 bool new_block;
1337 auto result = btck_ChainstateManager::get(chainman).m_chainman->ProcessNewBlock(btck_Block::get(block), /*force_processing=*/true, /*min_pow_checked=*/true, /*new_block=*/&new_block);
1338 if (_new_block) {
1339 *_new_block = new_block ? 1 : 0;
1340 }
1341 return result ? 0 : -1;
1342}
1343
1345 btck_ChainstateManager* chainstate_manager,
1346 const btck_BlockHeader* header)
1347{
1348 try {
1349 auto& chainman = btck_ChainstateManager::get(chainstate_manager).m_chainman;
1350
1351 auto state = btck_BlockValidationState::create();
1352 bool result{chainman->ProcessNewBlockHeaders({&btck_BlockHeader::get(header), 1}, /*min_pow_checked=*/true, btck_BlockValidationState::get(state))};
1353 assert(result == btck_BlockValidationState::get(state).IsValid());
1354 return state;
1355 } catch (const std::exception& e) {
1356 LogError("Failed to process block header: %s", e.what());
1357 return nullptr;
1358 }
1359}
1360
1362{
1363 return btck_Chain::ref(&WITH_LOCK(btck_ChainstateManager::get(chainman).m_chainman->GetMutex(), return btck_ChainstateManager::get(chainman).m_chainman->ActiveChain()));
1364}
1365
1367{
1368 LOCK(::cs_main);
1369 return btck_Chain::get(chain).Height();
1370}
1371
1372const btck_BlockTreeEntry* btck_chain_get_by_height(const btck_Chain* chain, int32_t height)
1373{
1374 LOCK(::cs_main);
1375 return btck_BlockTreeEntry::ref(btck_Chain::get(chain)[height]);
1376}
1377
1379{
1380 LOCK(::cs_main);
1381 return btck_Chain::get(chain).Contains(btck_BlockTreeEntry::get(entry)) ? 1 : 0;
1382}
1383
1384btck_BlockHeader* btck_block_header_create(const void* raw_block_header, size_t raw_block_header_len)
1385{
1386 if (raw_block_header == nullptr && raw_block_header_len != 0) {
1387 return nullptr;
1388 }
1389 auto header{std::make_unique<CBlockHeader>()};
1390 SpanReader stream{std::span{reinterpret_cast<const std::byte*>(raw_block_header), raw_block_header_len}};
1391
1392 try {
1393 stream >> *header;
1394 } catch (...) {
1395 LogError("Block header decode failed.");
1396 return nullptr;
1397 }
1398
1399 return btck_BlockHeader::ref(header.release());
1400}
1401
1403{
1404 return btck_BlockHeader::copy(header);
1405}
1406
1408{
1409 return btck_BlockHash::create(btck_BlockHeader::get(header).GetHash());
1410}
1411
1413{
1414 return btck_BlockHash::ref(&btck_BlockHeader::get(header).hashPrevBlock);
1415}
1416
1418{
1419 return btck_BlockHeader::get(header).nTime;
1420}
1421
1423{
1424 return btck_BlockHeader::get(header).nBits;
1425}
1426
1428{
1429 return btck_BlockHeader::get(header).nVersion;
1430}
1431
1433{
1434 return btck_BlockHeader::get(header).nNonce;
1435}
1436
1437int btck_block_header_to_bytes(const btck_BlockHeader* header, unsigned char output[80])
1438{
1439 try {
1440 SpanWriter{std::as_writable_bytes(std::span{output, 80})} << btck_BlockHeader::get(header);
1441 return 0;
1442 } catch (...) {
1443 return -1;
1444 }
1445}
1446
1448{
1449 delete header;
1450}
1451
1453{
1454 const auto& state = btck_TxValidationState::get(state_);
1455 if (state.IsValid()) return btck_ValidationMode_VALID;
1456 if (state.IsInvalid()) return btck_ValidationMode_INVALID;
1458}
1459
1461{
1462 return btck_TxValidationState::create();
1463}
1464
1466{
1467 switch (btck_TxValidationState::get(state_).GetResult()) {
1481 } // no default case, so the compiler can warn about missing cases
1482 assert(false);
1483}
1484
1486{
1487 delete state;
1488}
1489
1491{
1492 auto& state = btck_TxValidationState::get(validation_state);
1493 state = TxValidationState{};
1494 const bool ok = CheckTransaction(*btck_Transaction::get(tx), state);
1495 return ok ? 1 : 0;
1496}
int flags
Definition: bitcoin-tx.cpp:530
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.
void btck_logging_disable()
This disables the global internal logger.
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.
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.
void btck_logging_enable_category(btck_LogCategory category)
Enable a specific log category for the global internal logger.
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.
void btck_logging_disable_category(btck_LogCategory category)
Disable a specific log category for the global internal logger.
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.
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.
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
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.
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.
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.
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.
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_logging_set_level_category(btck_LogCategory category, btck_LogLevel level)
Set the log level of the global internal logger.
void btck_coin_destroy(btck_Coin *coin)
Destroy the coin.
void btck_context_options_set_chainparams(btck_ContextOptions *options, const btck_ChainParameters *chain_parameters)
int btck_block_header_to_bytes(const btck_BlockHeader *header, unsigned char output[80])
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.
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_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)
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_logging_set_options(const btck_LoggingOptions options)
Set some options for the global internal logger.
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 level at which logs should be produced.
#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
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
void(* btck_LogCallback)(void *user_data, const char *message, size_t message_len)
Callback function types.
#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
#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.
#define btck_LogCategory_ALL
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_BlockValidationResult_TIME_FUTURE
block timestamp was > 2 hours in the future (or our clock is bad)
#define btck_LogCategory_LEVELDB
#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_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.
bool m_always_print_category_level
Definition: logging.h:175
bool m_log_sourcelocations
Definition: logging.h:174
void SetLogLevel(Level level)
Definition: logging.h:250
size_t NumConnections() EXCLUSIVE_LOCKS_REQUIRED(!m_cs)
Definition: logging.h:205
bool m_log_time_micros
Definition: logging.h:172
bool m_log_threadnames
Definition: logging.h:173
std::list< std::function< void(conststd::string &)> >::iterator PushBackCallback(std::function< void(const std::string &)> fun) EXCLUSIVE_LOCKS_REQUIRED(!m_cs)
Connect a slot to the print signal and return the connection.
Definition: logging.h:191
void DisableLogging() EXCLUSIVE_LOCKS_REQUIRED(!m_cs)
Disable logging This offers a slight speedup and slightly smaller memory usage compared to leaving th...
Definition: logging.cpp:116
bool StartLogging() EXCLUSIVE_LOCKS_REQUIRED(!m_cs)
Start logging (and flush all buffered messages)
Definition: logging.cpp:54
void EnableCategory(LogFlags flag)
Definition: logging.cpp:128
void AddCategoryLogLevel(LogFlags category, Level level) EXCLUSIVE_LOCKS_REQUIRED(!m_cs)
Definition: logging.h:242
bool m_log_timestamps
Definition: logging.h:171
void DeleteCallback(std::list< std::function< void(const std::string &)> >::iterator it) EXCLUSIVE_LOCKS_REQUIRED(!m_cs)
Delete a connection.
Definition: logging.h:199
void DisconnectTestLogger() EXCLUSIVE_LOCKS_REQUIRED(!m_cs)
Only for testing.
Definition: logging.cpp:103
void DisableCategory(LogFlags flag)
Definition: logging.cpp:142
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 > Main()
static std::unique_ptr< const CChainParams > RegTest(const RegTestOptions &options)
static std::unique_ptr< const CChainParams > TestNet()
static std::unique_ptr< const CChainParams > TestNet4()
static std::unique_ptr< const CChainParams > SigNet(const SigNetOptions &options)
The basic transaction that is broadcasted on the network and contained in blocks.
Definition: transaction.h:281
const std::vector< CTxOut > vout
Definition: transaction.h:292
An output of a transaction.
Definition: transaction.h:140
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:940
A UTXO entry.
Definition: coins.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
NumConnections
Definition: clientmodel.h:48
btcsignals::scoped_connection m_connection
Definition: interfaces.cpp:30
@ 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:89
static path PathFromString(const std::string &string)
Convert byte string to path object.
Definition: fs.h:185
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:141
static constexpr size_t DEFAULT_KERNEL_CACHE
Suggested default amount of cache reserved for the kernel (bytes)
Definition: caches.h:13
#define LogInfo(...)
Definition: log.h:125
#define LogError(...)
Definition: log.h:127
#define LogDebug(category,...)
Definition: log.h:143
BCLog::Logger & LogInstance()
Definition: logging.cpp:26
unsigned int nHeight
LogFlags
Definition: categories.h:14
@ RAND
Definition: categories.h:29
@ BLOCKSTORAGE
Definition: categories.h:43
@ COINDB
Definition: categories.h:34
@ REINDEX
Definition: categories.h:27
@ ALL
Definition: categories.h:49
@ LEVELDB
Definition: categories.h:36
@ VALIDATION
Definition: categories.h:37
@ PRUNE
Definition: categories.h:30
@ MEMPOOL
Definition: categories.h:18
@ BENCH
Definition: categories.h:20
@ KERNEL
Definition: categories.h:47
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)
Definition: common.h:30
Level
Definition: log.h:52
bilingual_str ErrorString(const Result< T > &result)
Definition: result.h:93
ValidationSignals & m_signals
Definition: interfaces.cpp:515
std::shared_ptr< Chain::Notifications > m_notifications
Definition: interfaces.cpp:496
static constexpr TransactionSerParams TX_WITH_WITNESS
Definition: transaction.h:180
void Serialize(Stream &, V)=delete
constexpr deserialize_type deserialize
Definition: serialize.h:51
Application-specific storage settings.
Definition: dbwrapper.h:38
Bilingual messages:
Definition: translation.h:24
std::string original
Definition: translation.h:25
Options controlling the format of log messages.
int always_print_category_levels
Prepend the log category and level to log messages.
int log_time_micros
Log timestamps in microsecond precision.
int log_threadnames
Prepend the name of the thread to log messages.
int log_sourcelocations
Prepend the source location to log messages.
int log_timestamps
Prepend a timestamp to log messages.
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...
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
#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 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:11
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:93