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/time.h>
39#include <util/translation.h>
40#include <validation.h>
41#include <validationinterface.h>
42
43#include <cstddef>
44#include <cstring>
45#include <exception>
46#include <functional>
47#include <limits>
48#include <list>
49#include <memory>
50#include <optional>
51#include <span>
52#include <stdexcept>
53#include <string>
54#include <tuple>
55#include <utility>
56#include <vector>
57
58namespace Consensus {
59struct Params;
60} // namespace Consensus
61
64
65// Define G_TRANSLATION_FUN symbol in libbitcoinkernel library so users of the
66// library aren't required to export this symbol
67extern const TranslateFn G_TRANSLATION_FUN{nullptr};
68
70
71namespace {
72
73bool is_valid_flag_combination(script_verify_flags flags)
74{
76 if (flags & SCRIPT_VERIFY_WITNESS && ~flags & SCRIPT_VERIFY_P2SH) return false;
77 return true;
78}
79
80class WriterStream
81{
82private:
83 btck_WriteBytes m_writer;
84 void* m_user_data;
85
86public:
87 WriterStream(btck_WriteBytes writer, void* user_data)
88 : m_writer{writer}, m_user_data{user_data} {}
89
90 //
91 // Stream subset
92 //
93 void write(std::span<const std::byte> src)
94 {
95 if (m_writer(src.data(), src.size(), m_user_data) != 0) {
96 throw std::runtime_error("Failed to write serialization data");
97 }
98 }
99
100 template <typename T>
101 WriterStream& operator<<(const T& obj)
102 {
103 ::Serialize(*this, obj);
104 return *this;
105 }
106};
107
108template <typename C, typename CPP>
109struct Handle {
110 static C* ref(CPP* cpp_type)
111 {
112 return reinterpret_cast<C*>(cpp_type);
113 }
114
115 static const C* ref(const CPP* cpp_type)
116 {
117 return reinterpret_cast<const C*>(cpp_type);
118 }
119
120 template <typename... Args>
121 static C* create(Args&&... args)
122 {
123 auto cpp_obj{std::make_unique<CPP>(std::forward<Args>(args)...)};
124 return ref(cpp_obj.release());
125 }
126
127 static C* copy(const C* ptr)
128 {
129 auto cpp_obj{std::make_unique<CPP>(get(ptr))};
130 return ref(cpp_obj.release());
131 }
132
133 static const CPP& get(const C* ptr)
134 {
135 return *reinterpret_cast<const CPP*>(ptr);
136 }
137
138 static CPP& get(C* ptr)
139 {
140 return *reinterpret_cast<CPP*>(ptr);
141 }
142
143 static void operator delete(void* ptr)
144 {
145 delete reinterpret_cast<CPP*>(ptr);
146 }
147};
148
149} // namespace
150
151struct btck_BlockTreeEntry: Handle<btck_BlockTreeEntry, CBlockIndex> {};
152struct btck_Block : Handle<btck_Block, std::shared_ptr<const CBlock>> {};
153struct btck_BlockValidationState : Handle<btck_BlockValidationState, BlockValidationState> {};
154struct btck_TxValidationState : Handle<btck_TxValidationState, TxValidationState> {};
155
156namespace {
157
158BCLog::Level get_bclog_level(btck_LogLevel level)
159{
160 switch (level) {
161 case btck_LogLevel_INFO: {
162 return BCLog::Level::Info;
163 }
164 case btck_LogLevel_DEBUG: {
165 return BCLog::Level::Debug;
166 }
167 case btck_LogLevel_TRACE: {
168 return BCLog::Level::Trace;
169 }
170 }
171 assert(false);
172}
173
174BCLog::LogFlags get_bclog_flag(btck_LogCategory category)
175{
176 switch (category) {
179 }
182 }
185 }
188 }
191 }
194 }
197 }
200 }
203 }
206 }
209 }
210 }
211 assert(false);
212}
213
215{
216 switch (state) {
223 } // no default case, so the compiler can warn about missing cases
224 assert(false);
225}
226
227btck_Warning cast_btck_warning(kernel::Warning warning)
228{
229 switch (warning) {
234 } // no default case, so the compiler can warn about missing cases
235 assert(false);
236}
237
238struct LoggingConnection {
239 std::unique_ptr<std::list<std::function<void(const std::string&)>>::iterator> m_connection;
240 void* m_user_data;
241 std::function<void(void* user_data)> m_deleter;
242
243 LoggingConnection(btck_LogCallback callback, void* user_data, btck_DestroyCallback user_data_destroy_callback)
244 {
245 LOCK(cs_main);
246
247 auto connection{LogInstance().PushBackCallback([callback, user_data](const std::string& str) { callback(user_data, str.c_str(), str.length()); })};
248
249 // Only start logging if we just added the connection.
250 if (LogInstance().NumConnections() == 1 && !LogInstance().StartLogging()) {
251 LogError("Logger start failed.");
252 LogInstance().DeleteCallback(connection);
253 if (user_data && user_data_destroy_callback) {
254 user_data_destroy_callback(user_data);
255 }
256 throw std::runtime_error("Failed to start logging");
257 }
258
259 m_connection = std::make_unique<std::list<std::function<void(const std::string&)>>::iterator>(connection);
260 m_user_data = user_data;
261 m_deleter = user_data_destroy_callback;
262
263 LogDebug(BCLog::KERNEL, "Logger connected.");
264 }
265
266 ~LoggingConnection()
267 {
268 LOCK(cs_main);
269 LogDebug(BCLog::KERNEL, "Logger disconnecting.");
270
271 // Switch back to buffering by calling DisconnectTestLogger if the
272 // connection that we are about to remove is the last one.
273 if (LogInstance().NumConnections() == 1) {
275 } else {
277 }
278
279 m_connection.reset();
280 if (m_user_data && m_deleter) {
281 m_deleter(m_user_data);
282 }
283 }
284};
285
286class KernelNotifications final : public kernel::Notifications
287{
288private:
290
291public:
292 KernelNotifications(btck_NotificationInterfaceCallbacks cbs)
293 : m_cbs{cbs}
294 {
295 }
296
297 ~KernelNotifications()
298 {
299 if (m_cbs.user_data && m_cbs.user_data_destroy) {
300 m_cbs.user_data_destroy(m_cbs.user_data);
301 }
302 m_cbs.user_data_destroy = nullptr;
303 m_cbs.user_data = nullptr;
304 }
305
306 kernel::InterruptResult blockTip(SynchronizationState state, const CBlockIndex& index, double verification_progress) override
307 {
308 if (m_cbs.block_tip) m_cbs.block_tip(m_cbs.user_data, cast_state(state), btck_BlockTreeEntry::ref(&index), verification_progress);
309 return {};
310 }
311 void headerTip(SynchronizationState state, int64_t height, int64_t timestamp, bool presync) override
312 {
313 if (m_cbs.header_tip) m_cbs.header_tip(m_cbs.user_data, cast_state(state), height, timestamp, presync ? 1 : 0);
314 }
315 void progress(const bilingual_str& title, int progress_percent, bool resume_possible) override
316 {
317 if (m_cbs.progress) m_cbs.progress(m_cbs.user_data, title.original.c_str(), title.original.length(), progress_percent, resume_possible ? 1 : 0);
318 }
319 void warningSet(kernel::Warning id, const bilingual_str& message) override
320 {
321 if (m_cbs.warning_set) m_cbs.warning_set(m_cbs.user_data, cast_btck_warning(id), message.original.c_str(), message.original.length());
322 }
323 void warningUnset(kernel::Warning id) override
324 {
325 if (m_cbs.warning_unset) m_cbs.warning_unset(m_cbs.user_data, cast_btck_warning(id));
326 }
327 void flushError(const bilingual_str& message) override
328 {
329 if (m_cbs.flush_error) m_cbs.flush_error(m_cbs.user_data, message.original.c_str(), message.original.length());
330 }
331 void fatalError(const bilingual_str& message) override
332 {
333 if (m_cbs.fatal_error) m_cbs.fatal_error(m_cbs.user_data, message.original.c_str(), message.original.length());
334 }
335};
336
337class KernelValidationInterface final : public CValidationInterface
338{
339public:
341
342 explicit KernelValidationInterface(const btck_ValidationInterfaceCallbacks vi_cbs) : m_cbs{vi_cbs} {}
343
344 ~KernelValidationInterface()
345 {
346 if (m_cbs.user_data && m_cbs.user_data_destroy) {
347 m_cbs.user_data_destroy(m_cbs.user_data);
348 }
349 m_cbs.user_data = nullptr;
350 m_cbs.user_data_destroy = nullptr;
351 }
352
353protected:
354 void BlockChecked(const std::shared_ptr<const CBlock>& block, const BlockValidationState& stateIn) override
355 {
356 if (m_cbs.block_checked) {
357 m_cbs.block_checked(m_cbs.user_data,
358 btck_Block::copy(btck_Block::ref(&block)),
359 btck_BlockValidationState::ref(&stateIn));
360 }
361 }
362
363 void NewPoWValidBlock(const CBlockIndex* pindex, const std::shared_ptr<const CBlock>& block) override
364 {
365 if (m_cbs.pow_valid_block) {
366 m_cbs.pow_valid_block(m_cbs.user_data,
367 btck_Block::copy(btck_Block::ref(&block)),
368 btck_BlockTreeEntry::ref(pindex));
369 }
370 }
371
372 void BlockConnected(const ChainstateRole& role, const std::shared_ptr<const CBlock>& block, const CBlockIndex* pindex) override
373 {
374 if (m_cbs.block_connected) {
375 m_cbs.block_connected(m_cbs.user_data,
376 btck_Block::copy(btck_Block::ref(&block)),
377 btck_BlockTreeEntry::ref(pindex));
378 }
379 }
380
381 void BlockDisconnected(const std::shared_ptr<const CBlock>& block, const CBlockIndex* pindex) override
382 {
383 if (m_cbs.block_disconnected) {
384 m_cbs.block_disconnected(m_cbs.user_data,
385 btck_Block::copy(btck_Block::ref(&block)),
386 btck_BlockTreeEntry::ref(pindex));
387 }
388 }
389};
390
391struct ContextOptions {
392 mutable Mutex m_mutex;
393 std::unique_ptr<const CChainParams> m_chainparams GUARDED_BY(m_mutex);
394 std::shared_ptr<KernelNotifications> m_notifications GUARDED_BY(m_mutex);
395 std::shared_ptr<KernelValidationInterface> m_validation_interface GUARDED_BY(m_mutex);
396};
397
398class Context
399{
400public:
401 std::unique_ptr<kernel::Context> m_context;
402
403 std::shared_ptr<KernelNotifications> m_notifications;
404
405 std::unique_ptr<util::SignalInterrupt> m_interrupt;
406
407 std::unique_ptr<ValidationSignals> m_signals;
408
409 std::unique_ptr<const CChainParams> m_chainparams;
410
411 std::shared_ptr<KernelValidationInterface> m_validation_interface;
412
413 Context(const ContextOptions* options, bool& sane)
414 : m_context{std::make_unique<kernel::Context>()},
415 m_interrupt{std::make_unique<util::SignalInterrupt>()}
416 {
417 if (options) {
418 LOCK(options->m_mutex);
419 if (options->m_chainparams) {
420 m_chainparams = std::make_unique<const CChainParams>(*options->m_chainparams);
421 }
422 if (options->m_notifications) {
423 m_notifications = options->m_notifications;
424 }
425 if (options->m_validation_interface) {
426 m_signals = std::make_unique<ValidationSignals>(std::make_unique<ImmediateTaskRunner>());
427 m_validation_interface = options->m_validation_interface;
428 m_signals->RegisterSharedValidationInterface(m_validation_interface);
429 }
430 }
431
432 if (!m_chainparams) {
433 m_chainparams = CChainParams::Main();
434 }
435 if (!m_notifications) {
436 m_notifications = std::make_shared<KernelNotifications>(btck_NotificationInterfaceCallbacks{
437 nullptr, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr});
438 }
439
441 sane = false;
442 }
443 }
444
445 ~Context()
446 {
447 if (m_signals) {
448 m_signals->UnregisterSharedValidationInterface(m_validation_interface);
449 }
450 }
451};
452
454struct ChainstateManagerOptions {
455 mutable Mutex m_mutex;
456 ChainstateManager::Options m_chainman_options GUARDED_BY(m_mutex);
457 node::BlockManager::Options m_blockman_options GUARDED_BY(m_mutex);
458 std::shared_ptr<const Context> m_context;
459 node::ChainstateLoadOptions m_chainstate_load_options GUARDED_BY(m_mutex);
460 uint64_t m_db_cache_bytes GUARDED_BY(m_mutex){DEFAULT_KERNEL_CACHE};
461
462 ChainstateManagerOptions(const std::shared_ptr<const Context>& context, const fs::path& data_dir, const fs::path& blocks_dir)
463 : m_chainman_options{ChainstateManager::Options{
464 .chainparams = *context->m_chainparams,
465 .datadir = data_dir,
466 .notifications = *context->m_notifications,
467 .signals = context->m_signals.get()}},
468 m_blockman_options{node::BlockManager::Options{
469 .chainparams = *context->m_chainparams,
470 .blocks_dir = blocks_dir,
471 .notifications = *context->m_notifications,
472 .block_tree_db_params = DBParams{
473 .path = data_dir / "blocks" / "index",
474 .cache_bytes = kernel::CacheSizes{DEFAULT_KERNEL_CACHE}.block_tree_db,
475 }}},
476 m_context{context}, m_chainstate_load_options{node::ChainstateLoadOptions{}}
477 {
478 }
479};
480
481struct ChainMan {
482 std::unique_ptr<ChainstateManager> m_chainman;
483 std::shared_ptr<const Context> m_context;
484
485 ChainMan(std::unique_ptr<ChainstateManager> chainman, std::shared_ptr<const Context> context)
486 : m_chainman(std::move(chainman)), m_context(std::move(context)) {}
487};
488
489} // namespace
490
491struct btck_Transaction : Handle<btck_Transaction, std::shared_ptr<const CTransaction>> {};
492struct btck_TransactionOutput : Handle<btck_TransactionOutput, CTxOut> {};
493struct btck_ScriptPubkey : Handle<btck_ScriptPubkey, CScript> {};
494struct btck_LoggingConnection : Handle<btck_LoggingConnection, LoggingConnection> {};
495struct btck_ContextOptions : Handle<btck_ContextOptions, ContextOptions> {};
496struct btck_Context : Handle<btck_Context, std::shared_ptr<const Context>> {};
497struct btck_ChainParameters : Handle<btck_ChainParameters, CChainParams> {};
498struct btck_ChainstateManagerOptions : Handle<btck_ChainstateManagerOptions, ChainstateManagerOptions> {};
499struct btck_ChainstateManager : Handle<btck_ChainstateManager, ChainMan> {};
500struct btck_Chain : Handle<btck_Chain, CChain> {};
501struct btck_BlockSpentOutputs : Handle<btck_BlockSpentOutputs, std::shared_ptr<CBlockUndo>> {};
502struct btck_TransactionSpentOutputs : Handle<btck_TransactionSpentOutputs, CTxUndo> {};
503struct btck_Coin : Handle<btck_Coin, Coin> {};
504struct btck_BlockHash : Handle<btck_BlockHash, uint256> {};
505struct btck_TransactionInput : Handle<btck_TransactionInput, CTxIn> {};
506struct btck_WitnessStack : Handle<btck_WitnessStack, CScriptWitness> {};
507struct btck_TransactionOutPoint: Handle<btck_TransactionOutPoint, COutPoint> {};
508struct btck_Txid: Handle<btck_Txid, Txid> {};
509struct btck_PrecomputedTransactionData : Handle<btck_PrecomputedTransactionData, PrecomputedTransactionData> {};
510struct btck_BlockHeader: Handle<btck_BlockHeader, CBlockHeader> {};
511struct btck_ConsensusParams: Handle<btck_ConsensusParams, Consensus::Params> {};
512
513btck_Transaction* btck_transaction_create(const void* raw_transaction, size_t raw_transaction_len)
514{
515 assert(raw_transaction != nullptr || raw_transaction_len == 0);
516 try {
517 SpanReader stream{std::span{reinterpret_cast<const std::byte*>(raw_transaction), raw_transaction_len}};
518 return btck_Transaction::create(std::make_shared<const CTransaction>(deserialize, TX_WITH_WITNESS, stream));
519 } catch (...) {
520 return nullptr;
521 }
522}
523
525{
526 return btck_Transaction::get(transaction)->vout.size();
527}
528
529const btck_TransactionOutput* btck_transaction_get_output_at(const btck_Transaction* transaction, size_t output_index)
530{
531 const CTransaction& tx = *btck_Transaction::get(transaction);
532 assert(output_index < tx.vout.size());
533 return btck_TransactionOutput::ref(&tx.vout[output_index]);
534}
535
537{
538 return btck_Transaction::get(transaction)->vin.size();
539}
540
541const btck_TransactionInput* btck_transaction_get_input_at(const btck_Transaction* transaction, size_t input_index)
542{
543 assert(input_index < btck_Transaction::get(transaction)->vin.size());
544 return btck_TransactionInput::ref(&btck_Transaction::get(transaction)->vin[input_index]);
545}
546
548{
549 return btck_Transaction::get(transaction)->nLockTime;
550}
551
553{
554 return btck_Txid::ref(&btck_Transaction::get(transaction)->GetHash());
555}
556
558{
559 return btck_Transaction::copy(transaction);
560}
561
562int btck_transaction_to_bytes(const btck_Transaction* transaction, btck_WriteBytes writer, void* user_data)
563{
564 try {
565 WriterStream ws{writer, user_data};
566 ws << TX_WITH_WITNESS(btck_Transaction::get(transaction));
567 return 0;
568 } catch (...) {
569 return -1;
570 }
571}
572
574{
575 delete transaction;
576}
577
578btck_ScriptPubkey* btck_script_pubkey_create(const void* script_pubkey, size_t script_pubkey_len)
579{
580 assert(script_pubkey != nullptr || script_pubkey_len == 0);
581 auto data = std::span{reinterpret_cast<const uint8_t*>(script_pubkey), script_pubkey_len};
582 return btck_ScriptPubkey::create(data.begin(), data.end());
583}
584
585int btck_script_pubkey_to_bytes(const btck_ScriptPubkey* script_pubkey_, btck_WriteBytes writer, void* user_data)
586{
587 const auto& script_pubkey{btck_ScriptPubkey::get(script_pubkey_)};
588 return writer(script_pubkey.data(), script_pubkey.size(), user_data);
589}
590
592{
593 return btck_ScriptPubkey::copy(script_pubkey);
594}
595
597{
598 delete script_pubkey;
599}
600
602{
603 return btck_TransactionOutput::create(amount, btck_ScriptPubkey::get(script_pubkey));
604}
605
607{
608 return btck_TransactionOutput::copy(output);
609}
610
612{
613 return btck_ScriptPubkey::ref(&btck_TransactionOutput::get(output).scriptPubKey);
614}
615
617{
618 return btck_TransactionOutput::get(output).nValue;
619}
620
622{
623 delete output;
624}
625
627 const btck_Transaction* tx_to,
628 const btck_TransactionOutput** spent_outputs_, size_t spent_outputs_len)
629{
630 try {
631 const CTransaction& tx{*btck_Transaction::get(tx_to)};
632 auto txdata{btck_PrecomputedTransactionData::create()};
633 if (spent_outputs_ != nullptr && spent_outputs_len > 0) {
634 assert(spent_outputs_len == tx.vin.size());
635 std::vector<CTxOut> spent_outputs;
636 spent_outputs.reserve(spent_outputs_len);
637 for (size_t i = 0; i < spent_outputs_len; i++) {
638 const CTxOut& tx_out{btck_TransactionOutput::get(spent_outputs_[i])};
639 spent_outputs.push_back(tx_out);
640 }
641 btck_PrecomputedTransactionData::get(txdata).Init(tx, std::move(spent_outputs));
642 } else {
643 btck_PrecomputedTransactionData::get(txdata).Init(tx, {});
644 }
645
646 return txdata;
647 } catch (...) {
648 return nullptr;
649 }
650}
651
653{
654 return btck_PrecomputedTransactionData::copy(precomputed_txdata);
655}
656
658{
659 delete precomputed_txdata;
660}
661
663 const int64_t amount,
664 const btck_Transaction* tx_to,
665 const btck_PrecomputedTransactionData* precomputed_txdata,
666 const unsigned int input_index,
669{
670 // Assert that all specified flags are part of the interface before continuing
672
673 if (!is_valid_flag_combination(script_verify_flags::from_int(flags))) {
675 return 0;
676 }
677
678 const CTransaction& tx{*btck_Transaction::get(tx_to)};
679 assert(input_index < tx.vin.size());
680
681 const PrecomputedTransactionData& txdata{precomputed_txdata ? btck_PrecomputedTransactionData::get(precomputed_txdata) : PrecomputedTransactionData(tx)};
682
683 if (flags & btck_ScriptVerificationFlags_TAPROOT && txdata.m_spent_outputs.empty()) {
685 return 0;
686 }
687
688 if (status) *status = btck_ScriptVerifyStatus_OK;
689
690 bool result = VerifyScript(tx.vin[input_index].scriptSig,
691 btck_ScriptPubkey::get(script_pubkey),
692 &tx.vin[input_index].scriptWitness,
694 TransactionSignatureChecker(&tx, input_index, amount, txdata, MissingDataBehavior::FAIL),
695 nullptr);
696 return result ? 1 : 0;
697}
698
700{
701 return btck_TransactionInput::copy(input);
702}
703
705{
706 return btck_TransactionOutPoint::ref(&btck_TransactionInput::get(input).prevout);
707}
708
710{
711 return btck_TransactionInput::get(input).nSequence;
712}
713
715{
716 return btck_WitnessStack::ref(&btck_TransactionInput::get(input).scriptWitness);
717}
718
720{
721 const auto& script_sig{btck_TransactionInput::get(input).scriptSig};
722 return writer(script_sig.data(), script_sig.size(), user_data);
723}
724
726{
727 delete input;
728}
729
731{
732 return btck_WitnessStack::get(witness_stack).stack.size();
733}
734
735int btck_witness_stack_get_item_at(const btck_WitnessStack* witness_stack, size_t index, btck_WriteBytes writer, void* user_data)
736{
737 const auto& stack{btck_WitnessStack::get(witness_stack).stack};
738 assert(index < stack.size());
739 return writer(stack[index].data(), stack[index].size(), user_data);
740}
741
743{
744 return btck_WitnessStack::copy(witness_stack);
745}
746
748{
749 delete witness_stack;
750}
751
753{
754 return btck_TransactionOutPoint::copy(out_point);
755}
756
758{
759 return btck_TransactionOutPoint::get(out_point).n;
760}
761
763{
764 return btck_Txid::ref(&btck_TransactionOutPoint::get(out_point).hash);
765}
766
768{
769 delete out_point;
770}
771
773{
774 return btck_Txid::copy(txid);
775}
776
777void btck_txid_to_bytes(const btck_Txid* txid, unsigned char output[32])
778{
779 std::memcpy(output, btck_Txid::get(txid).begin(), 32);
780}
781
782int btck_txid_equals(const btck_Txid* txid1, const btck_Txid* txid2)
783{
784 return btck_Txid::get(txid1) == btck_Txid::get(txid2);
785}
786
788{
789 delete txid;
790}
791
793{
794 LOCK(cs_main);
800}
801
803{
804 LOCK(cs_main);
805 if (category == btck_LogCategory_ALL) {
806 LogInstance().SetLogLevel(get_bclog_level(level));
807 }
808
809 LogInstance().AddCategoryLogLevel(get_bclog_flag(category), get_bclog_level(level));
810}
811
813{
814 LogInstance().EnableCategory(get_bclog_flag(category));
815}
816
818{
819 LogInstance().DisableCategory(get_bclog_flag(category));
820}
821
823{
825}
826
828{
829 try {
830 return btck_LoggingConnection::create(callback, user_data, user_data_destroy_callback);
831 } catch (const std::exception&) {
832 return nullptr;
833 }
834}
835
837{
838 delete connection;
839}
840
842{
843 switch (chain_type) {
845 return btck_ChainParameters::ref(const_cast<CChainParams*>(CChainParams::Main().release()));
846 }
848 return btck_ChainParameters::ref(const_cast<CChainParams*>(CChainParams::TestNet().release()));
849 }
851 return btck_ChainParameters::ref(const_cast<CChainParams*>(CChainParams::TestNet4().release()));
852 }
854 return btck_ChainParameters::ref(const_cast<CChainParams*>(CChainParams::SigNet().release()));
855 }
857 return btck_ChainParameters::ref(const_cast<CChainParams*>(CChainParams::RegTest().release()));
858 }
859 }
860 assert(false);
861}
862
863btck_ChainParameters* btck_chain_parameters_create_signet(const void* challenge, size_t challenge_len)
864{
865 assert(challenge != nullptr || challenge_len == 0);
866 const uint8_t* p = static_cast<const uint8_t*>(challenge);
868 .challenge = std::vector<uint8_t>{p, p + challenge_len},
869 };
870 return btck_ChainParameters::ref(const_cast<CChainParams*>(CChainParams::SigNet(options).release()));
871}
872
874{
875 return btck_ChainParameters::copy(chain_parameters);
876}
877
879{
880 return btck_ConsensusParams::ref(&btck_ChainParameters::get(chain_parameters).GetConsensus());
881}
882
884{
885 delete chain_parameters;
886}
887
889{
890 return btck_ContextOptions::create();
891}
892
894{
895 // Copy the chainparams, so the caller can free it again
896 LOCK(btck_ContextOptions::get(options).m_mutex);
897 btck_ContextOptions::get(options).m_chainparams = std::make_unique<const CChainParams>(btck_ChainParameters::get(chain_parameters));
898}
899
901{
902 // The KernelNotifications are copy-initialized, so the caller can free them again.
903 LOCK(btck_ContextOptions::get(options).m_mutex);
904 btck_ContextOptions::get(options).m_notifications = std::make_shared<KernelNotifications>(notifications);
905}
906
908{
909 LOCK(btck_ContextOptions::get(options).m_mutex);
910 btck_ContextOptions::get(options).m_validation_interface = std::make_shared<KernelValidationInterface>(vi_cbs);
911}
912
914{
915 delete options;
916}
917
919{
920 bool sane{true};
921 const ContextOptions* opts = options ? &btck_ContextOptions::get(options) : nullptr;
922 auto context{std::make_shared<const Context>(opts, sane)};
923 if (!sane) {
924 LogError("Kernel context sanity check failed.");
925 return nullptr;
926 }
927 return btck_Context::create(context);
928}
929
931{
932 return btck_Context::copy(context);
933}
934
936{
937 return (*btck_Context::get(context)->m_interrupt)() ? 0 : -1;
938}
939
941{
942 delete context;
943}
944
946{
947 if (!btck_BlockTreeEntry::get(entry).pprev) {
948 LogInfo("Genesis block has no previous.");
949 return nullptr;
950 }
951
952 return btck_BlockTreeEntry::ref(btck_BlockTreeEntry::get(entry).pprev);
953}
954
956{
957 const auto* ancestor{btck_BlockTreeEntry::get(block_tree_entry).GetAncestor(height)};
958 assert(ancestor);
959 return btck_BlockTreeEntry::ref(ancestor);
960}
961
963{
964 return btck_BlockValidationState::create();
965}
966
968{
969 return btck_BlockValidationState::copy(state);
970}
971
973{
974 delete state;
975}
976
978{
979 auto& block_validation_state = btck_BlockValidationState::get(block_validation_state_);
980 if (block_validation_state.IsValid()) return btck_ValidationMode_VALID;
981 if (block_validation_state.IsInvalid()) return btck_ValidationMode_INVALID;
983}
984
986{
987 auto& block_validation_state = btck_BlockValidationState::get(block_validation_state_);
988 switch (block_validation_state.GetResult()) {
1007 } // no default case, so the compiler can warn about missing cases
1008 assert(false);
1009}
1010
1011btck_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)
1012{
1013 assert(data_dir != nullptr || data_dir_len == 0);
1014 assert(blocks_dir != nullptr || blocks_dir_len == 0);
1015 if (data_dir_len == 0 || blocks_dir_len == 0) {
1016 LogError("Failed to create chainstate manager options: dir must be non-null and non-empty");
1017 return nullptr;
1018 }
1019 try {
1020 fs::path abs_data_dir{fs::absolute(fs::PathFromString({data_dir, data_dir_len}))};
1021 fs::create_directories(abs_data_dir);
1022 fs::path abs_blocks_dir{fs::absolute(fs::PathFromString({blocks_dir, blocks_dir_len}))};
1023 fs::create_directories(abs_blocks_dir);
1024 return btck_ChainstateManagerOptions::create(btck_Context::get(context), abs_data_dir, abs_blocks_dir);
1025 } catch (const std::exception& e) {
1026 LogError("Failed to create chainstate manager options: %s", e.what());
1027 return nullptr;
1028 }
1029}
1030
1032{
1033 LOCK(btck_ChainstateManagerOptions::get(opts).m_mutex);
1034 btck_ChainstateManagerOptions::get(opts).m_chainman_options.worker_threads_num = worker_threads;
1035}
1036
1038{
1039 if (database_cache_bytes < MIN_DBCACHE_BYTES || database_cache_bytes > MAX_DBCACHE_BYTES) {
1040 LogError("Failed to set database cache: size is outside the supported range.");
1041 return -1;
1042 }
1043
1044 auto& opts{btck_ChainstateManagerOptions::get(chainman_opts)};
1045 LOCK(opts.m_mutex);
1046 opts.m_db_cache_bytes = database_cache_bytes;
1047 opts.m_blockman_options.block_tree_db_params.cache_bytes = kernel::CacheSizes{database_cache_bytes}.block_tree_db;
1048 return 0;
1049}
1050
1052{
1053 delete options;
1054}
1055
1056int btck_chainstate_manager_options_set_wipe_dbs(btck_ChainstateManagerOptions* chainman_opts, int wipe_block_tree_db, int wipe_chainstate_db)
1057{
1058 if (wipe_block_tree_db == 1 && wipe_chainstate_db != 1) {
1059 LogError("Wiping the block tree db without also wiping the chainstate db is currently unsupported.");
1060 return -1;
1061 }
1062 auto& opts{btck_ChainstateManagerOptions::get(chainman_opts)};
1063 LOCK(opts.m_mutex);
1064 opts.m_blockman_options.block_tree_db_params.wipe_data = wipe_block_tree_db == 1;
1065 opts.m_chainstate_load_options.wipe_chainstate_db = wipe_chainstate_db == 1;
1066 return 0;
1067}
1068
1070 btck_ChainstateManagerOptions* chainman_opts,
1071 int block_tree_db_in_memory)
1072{
1073 auto& opts{btck_ChainstateManagerOptions::get(chainman_opts)};
1074 LOCK(opts.m_mutex);
1075 opts.m_blockman_options.block_tree_db_params.memory_only = block_tree_db_in_memory == 1;
1076}
1077
1079 btck_ChainstateManagerOptions* chainman_opts,
1080 int chainstate_db_in_memory)
1081{
1082 auto& opts{btck_ChainstateManagerOptions::get(chainman_opts)};
1083 LOCK(opts.m_mutex);
1084 opts.m_chainstate_load_options.coins_db_in_memory = chainstate_db_in_memory == 1;
1085}
1086
1088 const btck_ChainstateManagerOptions* chainman_opts)
1089{
1090 auto& opts{btck_ChainstateManagerOptions::get(chainman_opts)};
1091 std::unique_ptr<ChainstateManager> chainman;
1092 try {
1093 LOCK(opts.m_mutex);
1094 chainman = std::make_unique<ChainstateManager>(*opts.m_context->m_interrupt, opts.m_chainman_options, opts.m_blockman_options);
1095 } catch (const std::exception& e) {
1096 LogError("Failed to create chainstate manager: %s", e.what());
1097 return nullptr;
1098 }
1099
1100 try {
1101 const auto chainstate_load_opts{WITH_LOCK(opts.m_mutex, return opts.m_chainstate_load_options)};
1102
1103 const kernel::CacheSizes cache_sizes{WITH_LOCK(opts.m_mutex, return opts.m_db_cache_bytes)};
1104 auto [status, chainstate_err]{node::LoadChainstate(*chainman, cache_sizes, chainstate_load_opts)};
1106 LogError("Failed to load chain state from your data directory: %s", chainstate_err.original);
1107 return nullptr;
1108 }
1109 std::tie(status, chainstate_err) = node::VerifyLoadedChainstate(*chainman, chainstate_load_opts);
1111 LogError("Failed to verify loaded chain state from your datadir: %s", chainstate_err.original);
1112 return nullptr;
1113 }
1114 if (auto result = chainman->ActivateBestChains(); !result) {
1115 LogError("%s", util::ErrorString(result).original);
1116 return nullptr;
1117 }
1118 } catch (const std::exception& e) {
1119 LogError("Failed to load chainstate: %s", e.what());
1120 return nullptr;
1121 }
1122
1123 return btck_ChainstateManager::create(std::move(chainman), opts.m_context);
1124}
1125
1127{
1128 auto block_index = WITH_LOCK(btck_ChainstateManager::get(chainman).m_chainman->GetMutex(),
1129 return btck_ChainstateManager::get(chainman).m_chainman->m_blockman.LookupBlockIndex(btck_BlockHash::get(block_hash)));
1130 if (!block_index) {
1131 LogDebug(BCLog::KERNEL, "A block with the given hash is not indexed.");
1132 return nullptr;
1133 }
1134 return btck_BlockTreeEntry::ref(block_index);
1135}
1136
1138{
1139 auto& chainman = *btck_ChainstateManager::get(chainstate_manager).m_chainman;
1140 return btck_BlockTreeEntry::ref(WITH_LOCK(chainman.GetMutex(), return chainman.m_best_header));
1141}
1142
1144{
1145 {
1146 LOCK(btck_ChainstateManager::get(chainman).m_chainman->GetMutex());
1147 for (const auto& chainstate : btck_ChainstateManager::get(chainman).m_chainman->m_chainstates) {
1148 if (chainstate->CanFlushToDisk()) {
1149 chainstate->ForceFlushStateToDisk();
1150 chainstate->ResetCoinsViews();
1151 }
1152 }
1153 }
1154
1155 delete chainman;
1156}
1157
1158int 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)
1159{
1160 try {
1161 std::vector<fs::path> import_files;
1162 import_files.reserve(block_file_paths_data_len);
1163 for (uint32_t i = 0; i < block_file_paths_data_len; i++) {
1164 if (block_file_paths_data[i] != nullptr) {
1165 import_files.emplace_back(std::string{block_file_paths_data[i], block_file_paths_lens[i]}.c_str());
1166 }
1167 }
1168 auto& chainman_ref{*btck_ChainstateManager::get(chainman).m_chainman};
1169 node::ImportBlocks(chainman_ref, import_files);
1170 WITH_LOCK(::cs_main, chainman_ref.UpdateIBDStatus());
1171 } catch (const std::exception& e) {
1172 LogError("Failed to import blocks: %s", e.what());
1173 return -1;
1174 }
1175 return 0;
1176}
1177
1178btck_Block* btck_block_create(const void* raw_block, size_t raw_block_length)
1179{
1180 assert(raw_block != nullptr || raw_block_length == 0);
1181 auto block{std::make_shared<CBlock>()};
1182
1183 SpanReader stream{std::span{reinterpret_cast<const std::byte*>(raw_block), raw_block_length}};
1184
1185 try {
1186 stream >> TX_WITH_WITNESS(*block);
1187 } catch (...) {
1188 LogDebug(BCLog::KERNEL, "Block decode failed.");
1189 return nullptr;
1190 }
1191
1192 return btck_Block::create(block);
1193}
1194
1196{
1197 return btck_Block::copy(block);
1198}
1199
1200int btck_block_check(const btck_Block* block, const btck_ConsensusParams* consensus_params, btck_BlockCheckFlags flags, btck_BlockValidationState* validation_state)
1201{
1202 auto& state = btck_BlockValidationState::get(validation_state);
1203 state = BlockValidationState{};
1204
1205 const bool check_pow = (flags & btck_BlockCheckFlags_POW) != 0;
1206 const bool check_merkle = (flags & btck_BlockCheckFlags_MERKLE) != 0;
1207
1208 const bool result = CheckBlock(*btck_Block::get(block), state, btck_ConsensusParams::get(consensus_params), /*fCheckPOW=*/check_pow, /*fCheckMerkleRoot=*/check_merkle);
1209
1210 return result ? 1 : 0;
1211}
1212
1214{
1215 return btck_Block::get(block)->vtx.size();
1216}
1217
1219{
1220 assert(index < btck_Block::get(block)->vtx.size());
1221 return btck_Transaction::ref(&btck_Block::get(block)->vtx[index]);
1222}
1223
1225{
1226 const auto& block_ptr = btck_Block::get(block);
1227 return btck_BlockHeader::create(static_cast<const CBlockHeader&>(*block_ptr));
1228}
1229
1230int btck_block_to_bytes(const btck_Block* block, btck_WriteBytes writer, void* user_data)
1231{
1232 try {
1233 WriterStream ws{writer, user_data};
1234 ws << TX_WITH_WITNESS(*btck_Block::get(block));
1235 return 0;
1236 } catch (...) {
1237 return -1;
1238 }
1239}
1240
1242{
1243 return btck_BlockHash::create(btck_Block::get(block)->GetHash());
1244}
1245
1247{
1248 delete block;
1249}
1250
1252{
1253 auto block{std::make_shared<CBlock>()};
1254 if (!btck_ChainstateManager::get(chainman).m_chainman->m_blockman.ReadBlock(*block, btck_BlockTreeEntry::get(entry))) {
1255 LogError("Failed to read block.");
1256 return nullptr;
1257 }
1258 return btck_Block::create(block);
1259}
1260
1262{
1263 return btck_BlockHeader::create(btck_BlockTreeEntry::get(entry).GetBlockHeader());
1264}
1265
1267{
1268 return btck_BlockTreeEntry::get(entry).nHeight;
1269}
1270
1272{
1273 return btck_BlockHash::ref(btck_BlockTreeEntry::get(entry).phashBlock);
1274}
1275
1277{
1278 return &btck_BlockTreeEntry::get(entry1) == &btck_BlockTreeEntry::get(entry2);
1279}
1280
1281btck_BlockHash* btck_block_hash_create(const unsigned char block_hash[32])
1282{
1283 return btck_BlockHash::create(std::span<const unsigned char>{block_hash, 32});
1284}
1285
1287{
1288 return btck_BlockHash::copy(block_hash);
1289}
1290
1291void btck_block_hash_to_bytes(const btck_BlockHash* block_hash, unsigned char output[32])
1292{
1293 std::memcpy(output, btck_BlockHash::get(block_hash).begin(), 32);
1294}
1295
1297{
1298 return btck_BlockHash::get(hash1) == btck_BlockHash::get(hash2);
1299}
1300
1302{
1303 delete hash;
1304}
1305
1307{
1308 auto block_undo{std::make_shared<CBlockUndo>()};
1309 if (btck_BlockTreeEntry::get(entry).nHeight < 1) {
1310 LogDebug(BCLog::KERNEL, "The genesis block does not have any spent outputs.");
1311 return btck_BlockSpentOutputs::create(block_undo);
1312 }
1313 if (!btck_ChainstateManager::get(chainman).m_chainman->m_blockman.ReadBlockUndo(*block_undo, btck_BlockTreeEntry::get(entry))) {
1314 LogError("Failed to read block spent outputs data.");
1315 return nullptr;
1316 }
1317 return btck_BlockSpentOutputs::create(block_undo);
1318}
1319
1321{
1322 return btck_BlockSpentOutputs::copy(block_spent_outputs);
1323}
1324
1326{
1327 return btck_BlockSpentOutputs::get(block_spent_outputs)->vtxundo.size();
1328}
1329
1331{
1332 assert(transaction_index < btck_BlockSpentOutputs::get(block_spent_outputs)->vtxundo.size());
1333 const auto* tx_undo{&btck_BlockSpentOutputs::get(block_spent_outputs)->vtxundo.at(transaction_index)};
1334 return btck_TransactionSpentOutputs::ref(tx_undo);
1335}
1336
1338{
1339 delete block_spent_outputs;
1340}
1341
1343{
1344 return btck_TransactionSpentOutputs::copy(transaction_spent_outputs);
1345}
1346
1348{
1349 return btck_TransactionSpentOutputs::get(transaction_spent_outputs).vprevout.size();
1350}
1351
1353{
1354 delete transaction_spent_outputs;
1355}
1356
1357const btck_Coin* btck_transaction_spent_outputs_get_coin_at(const btck_TransactionSpentOutputs* transaction_spent_outputs, size_t coin_index)
1358{
1359 assert(coin_index < btck_TransactionSpentOutputs::get(transaction_spent_outputs).vprevout.size());
1360 const Coin* coin{&btck_TransactionSpentOutputs::get(transaction_spent_outputs).vprevout.at(coin_index)};
1361 return btck_Coin::ref(coin);
1362}
1363
1365{
1366 return btck_Coin::copy(coin);
1367}
1368
1370{
1371 return btck_Coin::get(coin).nHeight;
1372}
1373
1375{
1376 return btck_Coin::get(coin).IsCoinBase() ? 1 : 0;
1377}
1378
1380{
1381 return btck_TransactionOutput::ref(&btck_Coin::get(coin).out);
1382}
1383
1385{
1386 delete coin;
1387}
1388
1390 btck_ChainstateManager* chainman,
1391 const btck_Block* block,
1392 int* _new_block)
1393{
1394 bool new_block;
1395 auto result = btck_ChainstateManager::get(chainman).m_chainman->ProcessNewBlock(btck_Block::get(block), /*force_processing=*/true, /*min_pow_checked=*/true, /*new_block=*/&new_block);
1396 if (_new_block) {
1397 *_new_block = new_block ? 1 : 0;
1398 }
1399 return result ? 0 : -1;
1400}
1401
1403 btck_ChainstateManager* chainstate_manager,
1404 const btck_BlockHeader* header)
1405{
1406 try {
1407 auto& chainman = btck_ChainstateManager::get(chainstate_manager).m_chainman;
1408
1409 auto state = btck_BlockValidationState::create();
1410 bool result{chainman->ProcessNewBlockHeaders({&btck_BlockHeader::get(header), 1}, /*min_pow_checked=*/true, btck_BlockValidationState::get(state))};
1411 assert(result == btck_BlockValidationState::get(state).IsValid());
1412 return state;
1413 } catch (const std::exception& e) {
1414 LogError("Failed to process block header: %s", e.what());
1415 return nullptr;
1416 }
1417}
1418
1420{
1421 return btck_Chain::ref(&WITH_LOCK(btck_ChainstateManager::get(chainman).m_chainman->GetMutex(), return btck_ChainstateManager::get(chainman).m_chainman->ActiveChain()));
1422}
1423
1425{
1426 LOCK(::cs_main);
1427 return btck_Chain::get(chain).Height();
1428}
1429
1430const btck_BlockTreeEntry* btck_chain_get_by_height(const btck_Chain* chain, int32_t height)
1431{
1432 LOCK(::cs_main);
1433 return btck_BlockTreeEntry::ref(btck_Chain::get(chain)[height]);
1434}
1435
1437{
1438 LOCK(::cs_main);
1439 return btck_Chain::get(chain).Contains(btck_BlockTreeEntry::get(entry)) ? 1 : 0;
1440}
1441
1442btck_BlockHeader* btck_block_header_create(const void* raw_block_header, size_t raw_block_header_len)
1443{
1444 assert(raw_block_header != nullptr && raw_block_header_len == 80);
1445 auto header{std::make_unique<CBlockHeader>()};
1446 SpanReader stream{std::span{reinterpret_cast<const std::byte*>(raw_block_header), raw_block_header_len}};
1447
1448 try {
1449 stream >> *header;
1450 } catch (...) {
1451 LogError("Block header decode failed.");
1452 return nullptr;
1453 }
1454
1455 return btck_BlockHeader::ref(header.release());
1456}
1457
1459{
1460 return btck_BlockHeader::copy(header);
1461}
1462
1464{
1465 return btck_BlockHash::create(btck_BlockHeader::get(header).GetHash());
1466}
1467
1469{
1470 return btck_BlockHash::ref(&btck_BlockHeader::get(header).hashPrevBlock);
1471}
1472
1474{
1475 return btck_BlockHeader::get(header).nTime;
1476}
1477
1479{
1480 return btck_BlockHeader::get(header).nBits;
1481}
1482
1484{
1485 return btck_BlockHeader::get(header).nVersion;
1486}
1487
1489{
1490 return btck_BlockHeader::get(header).nNonce;
1491}
1492
1493int btck_block_header_to_bytes(const btck_BlockHeader* header, unsigned char output[80])
1494{
1495 try {
1496 SpanWriter{std::as_writable_bytes(std::span{output, 80})} << btck_BlockHeader::get(header);
1497 return 0;
1498 } catch (...) {
1499 return -1;
1500 }
1501}
1502
1504{
1505 delete header;
1506}
1507
1509{
1510 const auto& state = btck_TxValidationState::get(state_);
1511 if (state.IsValid()) return btck_ValidationMode_VALID;
1512 if (state.IsInvalid()) return btck_ValidationMode_INVALID;
1514}
1515
1517{
1518 return btck_TxValidationState::create();
1519}
1520
1522{
1523 switch (btck_TxValidationState::get(state_).GetResult()) {
1537 } // no default case, so the compiler can warn about missing cases
1538 assert(false);
1539}
1540
1542{
1543 delete state;
1544}
1545
1547{
1548 auto& state = btck_TxValidationState::get(validation_state);
1549 state = TxValidationState{};
1550 const bool ok = CheckTransaction(*btck_Transaction::get(tx), state);
1551 return ok ? 1 : 0;
1552}
1553
1554int btck_set_mock_time(int64_t timestamp)
1555{
1556 constexpr int64_t max_time{std::numeric_limits<uint32_t>::max()};
1557 if (timestamp < 0 || timestamp > max_time) {
1558 return -1;
1559 }
1560 SetMockTime(std::chrono::seconds{timestamp});
1561 return 0;
1562}
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.
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.
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)
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.
int btck_transaction_input_get_script_sig(const btck_TransactionInput *input, btck_WriteBytes writer, void *user_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)
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 > TestNet4()
Definition: chainparams.h:179
static std::unique_ptr< const CChainParams > Main()
Definition: chainparams.h:175
static std::unique_ptr< const CChainParams > TestNet()
Definition: chainparams.h:177
static std::unique_ptr< const CChainParams > SigNet()
Definition: chainparams.h:173
static std::unique_ptr< const CChainParams > RegTest()
Definition: chainparams.h:171
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:945
A UTXO entry.
Definition: coins.h:46
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
static const PrecomputedData data
Precomputed COutPoint and CCoins values.
btcsignals::scoped_connection m_connection
Definition: interfaces.cpp:31
@ 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: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: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:42
@ COINDB
Definition: categories.h:33
@ REINDEX
Definition: categories.h:27
@ ALL
Definition: categories.h:48
@ 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:22
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)
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
constexpr TransactionSerParams TX_WITH_WITNESS
Definition: transaction.h:180
void Serialize(Stream &, V)=delete
constexpr deserialize_type deserialize
Definition: serialize.h:52
SigNetOptions holds configurations for creating a signet CChainParams.
Definition: chainparams.h:147
Application-specific storage settings.
Definition: dbwrapper.h:41
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...
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
#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:19
void SetMockTime(int64_t nMockTimeIn)
DEPRECATED Use SetMockTime with chrono type.
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