Bitcoin Core 30.99.0
P2P Digital Currency
bitcoinkernel.h
Go to the documentation of this file.
1// Copyright (c) 2024-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#ifndef BITCOIN_KERNEL_BITCOINKERNEL_H
6#define BITCOIN_KERNEL_BITCOINKERNEL_H
7
8#ifndef __cplusplus
9#include <stddef.h>
10#include <stdint.h>
11#else
12#include <cstddef>
13#include <cstdint>
14#endif // __cplusplus
15
16#ifndef BITCOINKERNEL_API
17 #ifdef BITCOINKERNEL_BUILD
18 #if defined(_WIN32)
19 #define BITCOINKERNEL_API __declspec(dllexport)
20 #else
21 #define BITCOINKERNEL_API __attribute__((visibility("default")))
22 #endif
23 #else
24 #if defined(_WIN32) && !defined(BITCOINKERNEL_STATIC)
25 #define BITCOINKERNEL_API __declspec(dllimport)
26 #else
27 #define BITCOINKERNEL_API
28 #endif
29 #endif
30#endif
31
32/* Warning attributes */
33#if defined(__GNUC__)
34 #define BITCOINKERNEL_WARN_UNUSED_RESULT __attribute__((__warn_unused_result__))
35#else
36 #define BITCOINKERNEL_WARN_UNUSED_RESULT
37#endif
38#if !defined(BITCOINKERNEL_BUILD) && defined(__GNUC__)
39 #define BITCOINKERNEL_ARG_NONNULL(...) __attribute__((__nonnull__(__VA_ARGS__)))
40#else
41 #define BITCOINKERNEL_ARG_NONNULL(...)
42#endif
43
44#ifdef __cplusplus
45extern "C" {
46#endif // __cplusplus
47
110
115
120
133
142
154
170
183
192
203
207typedef struct btck_Block btck_Block;
208
216
221typedef struct btck_Chain btck_Chain;
222
235
244
251typedef struct btck_Coin btck_Coin;
252
259
266
273
274typedef struct btck_Txid btck_Txid;
275
278#define btck_SynchronizationState_INIT_REINDEX ((btck_SynchronizationState)(0))
279#define btck_SynchronizationState_INIT_DOWNLOAD ((btck_SynchronizationState)(1))
280#define btck_SynchronizationState_POST_INIT ((btck_SynchronizationState)(2))
281
283typedef uint8_t btck_Warning;
284#define btck_Warning_UNKNOWN_NEW_RULES_ACTIVATED ((btck_Warning)(0))
285#define btck_Warning_LARGE_WORK_INVALID_CHAIN ((btck_Warning)(1))
286
293typedef void (*btck_LogCallback)(void* user_data, const char* message, size_t message_len);
294
298typedef void (*btck_DestroyCallback)(void* user_data);
299
303typedef void (*btck_NotifyBlockTip)(void* user_data, btck_SynchronizationState state, const btck_BlockTreeEntry* entry, double verification_progress);
304typedef void (*btck_NotifyHeaderTip)(void* user_data, btck_SynchronizationState state, int64_t height, int64_t timestamp, int presync);
305typedef void (*btck_NotifyProgress)(void* user_data, const char* title, size_t title_len, int progress_percent, int resume_possible);
306typedef void (*btck_NotifyWarningSet)(void* user_data, btck_Warning warning, const char* message, size_t message_len);
307typedef void (*btck_NotifyWarningUnset)(void* user_data, btck_Warning warning);
308typedef void (*btck_NotifyFlushError)(void* user_data, const char* message, size_t message_len);
309typedef void (*btck_NotifyFatalError)(void* user_data, const char* message, size_t message_len);
310
314typedef void (*btck_ValidationInterfaceBlockChecked)(void* user_data, btck_Block* block, const btck_BlockValidationState* state);
315typedef void (*btck_ValidationInterfacePoWValidBlock)(void* user_data, btck_Block* block, const btck_BlockTreeEntry* entry);
316typedef void (*btck_ValidationInterfaceBlockConnected)(void* user_data, btck_Block* block, const btck_BlockTreeEntry* entry);
317typedef void (*btck_ValidationInterfaceBlockDisconnected)(void* user_data, btck_Block* block, const btck_BlockTreeEntry* entry);
318
322typedef int (*btck_WriteBytes)(const void* bytes, size_t size, void* userdata);
323
328typedef uint8_t btck_ValidationMode;
329#define btck_ValidationMode_VALID ((btck_ValidationMode)(0))
330#define btck_ValidationMode_INVALID ((btck_ValidationMode)(1))
331#define btck_ValidationMode_INTERNAL_ERROR ((btck_ValidationMode)(2))
332
337#define btck_BlockValidationResult_UNSET ((btck_BlockValidationResult)(0))
338#define btck_BlockValidationResult_CONSENSUS ((btck_BlockValidationResult)(1))
339#define btck_BlockValidationResult_CACHED_INVALID ((btck_BlockValidationResult)(2))
340#define btck_BlockValidationResult_INVALID_HEADER ((btck_BlockValidationResult)(3))
341#define btck_BlockValidationResult_MUTATED ((btck_BlockValidationResult)(4))
342#define btck_BlockValidationResult_MISSING_PREV ((btck_BlockValidationResult)(5))
343#define btck_BlockValidationResult_INVALID_PREV ((btck_BlockValidationResult)(6))
344#define btck_BlockValidationResult_TIME_FUTURE ((btck_BlockValidationResult)(7))
345#define btck_BlockValidationResult_HEADER_LOW_WORK ((btck_BlockValidationResult)(8))
346
353typedef struct {
354 void* user_data;
365
378typedef struct {
379 void* user_data;
391
395typedef uint8_t btck_LogCategory;
396#define btck_LogCategory_ALL ((btck_LogCategory)(0))
397#define btck_LogCategory_BENCH ((btck_LogCategory)(1))
398#define btck_LogCategory_BLOCKSTORAGE ((btck_LogCategory)(2))
399#define btck_LogCategory_COINDB ((btck_LogCategory)(3))
400#define btck_LogCategory_LEVELDB ((btck_LogCategory)(4))
401#define btck_LogCategory_MEMPOOL ((btck_LogCategory)(5))
402#define btck_LogCategory_PRUNE ((btck_LogCategory)(6))
403#define btck_LogCategory_RAND ((btck_LogCategory)(7))
404#define btck_LogCategory_REINDEX ((btck_LogCategory)(8))
405#define btck_LogCategory_VALIDATION ((btck_LogCategory)(9))
406#define btck_LogCategory_KERNEL ((btck_LogCategory)(10))
407
411typedef uint8_t btck_LogLevel;
412#define btck_LogLevel_TRACE ((btck_LogLevel)(0))
413#define btck_LogLevel_DEBUG ((btck_LogLevel)(1))
414#define btck_LogLevel_INFO ((btck_LogLevel)(2))
415
421typedef struct {
428
433#define btck_ScriptVerifyStatus_OK ((btck_ScriptVerifyStatus)(0))
434#define btck_ScriptVerifyStatus_ERROR_INVALID_FLAGS_COMBINATION ((btck_ScriptVerifyStatus)(1))
435#define btck_ScriptVerifyStatus_ERROR_SPENT_OUTPUTS_REQUIRED ((btck_ScriptVerifyStatus)(2))
436
441#define btck_ScriptVerificationFlags_NONE ((btck_ScriptVerificationFlags)(0))
442#define btck_ScriptVerificationFlags_P2SH ((btck_ScriptVerificationFlags)(1U << 0))
443#define btck_ScriptVerificationFlags_DERSIG ((btck_ScriptVerificationFlags)(1U << 2))
444#define btck_ScriptVerificationFlags_NULLDUMMY ((btck_ScriptVerificationFlags)(1U << 4))
445#define btck_ScriptVerificationFlags_CHECKLOCKTIMEVERIFY ((btck_ScriptVerificationFlags)(1U << 9))
446#define btck_ScriptVerificationFlags_CHECKSEQUENCEVERIFY ((btck_ScriptVerificationFlags)(1U << 10))
447#define btck_ScriptVerificationFlags_WITNESS ((btck_ScriptVerificationFlags)(1U << 11))
448#define btck_ScriptVerificationFlags_TAPROOT ((btck_ScriptVerificationFlags)(1U << 17))
449#define btck_ScriptVerificationFlags_ALL ((btck_ScriptVerificationFlags)(btck_ScriptVerificationFlags_P2SH | \
450 btck_ScriptVerificationFlags_DERSIG | \
451 btck_ScriptVerificationFlags_NULLDUMMY | \
452 btck_ScriptVerificationFlags_CHECKLOCKTIMEVERIFY | \
453 btck_ScriptVerificationFlags_CHECKSEQUENCEVERIFY | \
454 btck_ScriptVerificationFlags_WITNESS | \
455 btck_ScriptVerificationFlags_TAPROOT))
456
457typedef uint8_t btck_ChainType;
458#define btck_ChainType_MAINNET ((btck_ChainType)(0))
459#define btck_ChainType_TESTNET ((btck_ChainType)(1))
460#define btck_ChainType_TESTNET_4 ((btck_ChainType)(2))
461#define btck_ChainType_SIGNET ((btck_ChainType)(3))
462#define btck_ChainType_REGTEST ((btck_ChainType)(4))
463
468
477 const void* raw_transaction, size_t raw_transaction_len) BITCOINKERNEL_ARG_NONNULL(1);
478
487 const btck_Transaction* transaction) BITCOINKERNEL_ARG_NONNULL(1);
488
500 const btck_Transaction* transaction,
501 btck_WriteBytes writer,
502 void* user_data) BITCOINKERNEL_ARG_NONNULL(1, 2);
503
511 const btck_Transaction* transaction) BITCOINKERNEL_ARG_NONNULL(1);
512
523 const btck_Transaction* transaction, size_t output_index) BITCOINKERNEL_ARG_NONNULL(1);
524
535 const btck_Transaction* transaction, size_t input_index) BITCOINKERNEL_ARG_NONNULL(1);
536
544 const btck_Transaction* transaction) BITCOINKERNEL_ARG_NONNULL(1);
545
554 const btck_Transaction* transaction) BITCOINKERNEL_ARG_NONNULL(1);
555
560
562
567
575 const void* script_pubkey, size_t script_pubkey_len) BITCOINKERNEL_ARG_NONNULL(1);
576
584 const btck_ScriptPubkey* script_pubkey) BITCOINKERNEL_ARG_NONNULL(1);
585
606 const btck_ScriptPubkey* script_pubkey,
607 int64_t amount,
608 const btck_Transaction* tx_to,
609 const btck_TransactionOutput** spent_outputs, size_t spent_outputs_len,
610 unsigned int input_index,
611 unsigned int flags,
613
624 const btck_ScriptPubkey* script_pubkey,
625 btck_WriteBytes writer,
626 void* user_data) BITCOINKERNEL_ARG_NONNULL(1, 2);
627
632
634
639
648 const btck_ScriptPubkey* script_pubkey,
649 int64_t amount) BITCOINKERNEL_ARG_NONNULL(1);
650
660 const btck_TransactionOutput* transaction_output) BITCOINKERNEL_ARG_NONNULL(1);
661
669 const btck_TransactionOutput* transaction_output) BITCOINKERNEL_ARG_NONNULL(1);
670
678 const btck_TransactionOutput* transaction_output) BITCOINKERNEL_ARG_NONNULL(1);
679
684
686
691
701
710
727
736
745
760 btck_LogCallback log_callback,
761 void* user_data,
762 btck_DestroyCallback user_data_destroy_callback) BITCOINKERNEL_ARG_NONNULL(1);
763
768
770
775
784 const btck_ChainType chain_type);
785
790 const btck_ChainParameters* chain_parameters) BITCOINKERNEL_ARG_NONNULL(1);
791
796
798
803
808
817 btck_ContextOptions* context_options,
818 const btck_ChainParameters* chain_parameters) BITCOINKERNEL_ARG_NONNULL(1, 2);
819
828 btck_ContextOptions* context_options,
830
842 btck_ContextOptions* context_options,
843 btck_ValidationInterfaceCallbacks validation_interface_callbacks) BITCOINKERNEL_ARG_NONNULL(1);
844
849
851
856
867 const btck_ContextOptions* context_options);
868
873 const btck_Context* context) BITCOINKERNEL_ARG_NONNULL(1);
874
884
889
891
896
905 const btck_BlockTreeEntry* block_tree_entry) BITCOINKERNEL_ARG_NONNULL(1);
906
914 const btck_BlockTreeEntry* block_tree_entry) BITCOINKERNEL_ARG_NONNULL(1);
915
923 const btck_BlockTreeEntry* block_tree_entry) BITCOINKERNEL_ARG_NONNULL(1);
924
926
931
944 const btck_Context* context,
945 const char* data_directory,
946 size_t data_directory_len,
947 const char* blocks_directory,
948 size_t blocks_directory_len) BITCOINKERNEL_ARG_NONNULL(1, 2);
949
959 btck_ChainstateManagerOptions* chainstate_manager_options,
960 int worker_threads) BITCOINKERNEL_ARG_NONNULL(1);
961
973 btck_ChainstateManagerOptions* chainstate_manager_options,
974 int wipe_block_tree_db,
975 int wipe_chainstate_db) BITCOINKERNEL_ARG_NONNULL(1);
976
984 btck_ChainstateManagerOptions* chainstate_manager_options,
985 int block_tree_db_in_memory) BITCOINKERNEL_ARG_NONNULL(1);
986
994 btck_ChainstateManagerOptions* chainstate_manager_options,
995 int chainstate_db_in_memory) BITCOINKERNEL_ARG_NONNULL(1);
996
1001
1003
1008
1018 const btck_ChainstateManagerOptions* chainstate_manager_options) BITCOINKERNEL_ARG_NONNULL(1);
1019
1032 btck_ChainstateManager* chainstate_manager,
1033 const char** block_file_paths_data, size_t* block_file_paths_lens,
1034 size_t block_file_paths_data_len) BITCOINKERNEL_ARG_NONNULL(1);
1035
1054 btck_ChainstateManager* chainstate_manager,
1055 const btck_Block* block,
1056 int* new_block) BITCOINKERNEL_ARG_NONNULL(1, 2, 3);
1057
1073 const btck_ChainstateManager* chainstate_manager) BITCOINKERNEL_ARG_NONNULL(1);
1074
1084 const btck_ChainstateManager* chainstate_manager,
1085 const btck_BlockHash* block_hash) BITCOINKERNEL_ARG_NONNULL(1, 2);
1086
1091
1093
1098
1108 const btck_ChainstateManager* chainstate_manager,
1109 const btck_BlockTreeEntry* block_tree_entry) BITCOINKERNEL_ARG_NONNULL(1, 2);
1110
1119 const void* raw_block, size_t raw_block_len) BITCOINKERNEL_ARG_NONNULL(1);
1120
1129 const btck_Block* block) BITCOINKERNEL_ARG_NONNULL(1);
1130
1138 const btck_Block* block) BITCOINKERNEL_ARG_NONNULL(1);
1139
1149 const btck_Block* block, size_t transaction_index) BITCOINKERNEL_ARG_NONNULL(1);
1150
1158 const btck_Block* block) BITCOINKERNEL_ARG_NONNULL(1);
1159
1171 const btck_Block* block,
1172 btck_WriteBytes writer,
1173 void* user_data) BITCOINKERNEL_ARG_NONNULL(1, 2);
1174
1179
1181
1186
1191 const btck_BlockValidationState* block_validation_state) BITCOINKERNEL_ARG_NONNULL(1);
1192
1197 const btck_BlockValidationState* block_validation_state) BITCOINKERNEL_ARG_NONNULL(1);
1198
1200
1205
1214 const btck_Chain* chain) BITCOINKERNEL_ARG_NONNULL(1);
1215
1223 const btck_Chain* chain) BITCOINKERNEL_ARG_NONNULL(1);
1224
1232 const btck_Chain* chain) BITCOINKERNEL_ARG_NONNULL(1);
1233
1244 const btck_Chain* chain,
1245 int block_height) BITCOINKERNEL_ARG_NONNULL(1);
1246
1256 const btck_Chain* chain,
1257 const btck_BlockTreeEntry* block_tree_entry) BITCOINKERNEL_ARG_NONNULL(1, 2);
1258
1260
1265
1275 const btck_ChainstateManager* chainstate_manager,
1276 const btck_BlockTreeEntry* block_tree_entry) BITCOINKERNEL_ARG_NONNULL(1, 2);
1277
1285 const btck_BlockSpentOutputs* block_spent_outputs) BITCOINKERNEL_ARG_NONNULL(1);
1286
1295 const btck_BlockSpentOutputs* block_spent_outputs) BITCOINKERNEL_ARG_NONNULL(1);
1296
1307 const btck_BlockSpentOutputs* block_spent_outputs,
1308 size_t transaction_spent_outputs_index) BITCOINKERNEL_ARG_NONNULL(1);
1309
1314
1316
1321
1329 const btck_TransactionSpentOutputs* transaction_spent_outputs) BITCOINKERNEL_ARG_NONNULL(1);
1330
1339 const btck_TransactionSpentOutputs* transaction_spent_outputs) BITCOINKERNEL_ARG_NONNULL(1);
1340
1352 const btck_TransactionSpentOutputs* transaction_spent_outputs,
1353 size_t coin_index) BITCOINKERNEL_ARG_NONNULL(1);
1354
1359
1361
1366
1374 const btck_TransactionInput* transaction_input) BITCOINKERNEL_ARG_NONNULL(1);
1375
1384 const btck_TransactionInput* transaction_input) BITCOINKERNEL_ARG_NONNULL(1);
1385
1390
1392
1397
1405 const btck_TransactionOutPoint* transaction_out_point) BITCOINKERNEL_ARG_NONNULL(1);
1406
1414 const btck_TransactionOutPoint* transaction_out_point) BITCOINKERNEL_ARG_NONNULL(1);
1415
1424 const btck_TransactionOutPoint* transaction_out_point) BITCOINKERNEL_ARG_NONNULL(1);
1425
1430
1432
1437
1445 const btck_Txid* txid) BITCOINKERNEL_ARG_NONNULL(1);
1446
1455 const btck_Txid* txid1, const btck_Txid* txid2) BITCOINKERNEL_ARG_NONNULL(1, 2);
1456
1464 const btck_Txid* txid, unsigned char output[32]) BITCOINKERNEL_ARG_NONNULL(1, 2);
1465
1470
1472
1474
1479
1487 const btck_Coin* coin) BITCOINKERNEL_ARG_NONNULL(1);
1488
1497 const btck_Coin* coin) BITCOINKERNEL_ARG_NONNULL(1);
1498
1506 const btck_Coin* coin) BITCOINKERNEL_ARG_NONNULL(1);
1507
1516 const btck_Coin* coin) BITCOINKERNEL_ARG_NONNULL(1);
1517
1522
1524
1529
1534 const unsigned char block_hash[32]) BITCOINKERNEL_ARG_NONNULL(1);
1535
1544 const btck_BlockHash* hash1, const btck_BlockHash* hash2) BITCOINKERNEL_ARG_NONNULL(1, 2);
1545
1553 const btck_BlockHash* block_hash) BITCOINKERNEL_ARG_NONNULL(1);
1554
1562 const btck_BlockHash* block_hash, unsigned char output[32]) BITCOINKERNEL_ARG_NONNULL(1, 2);
1563
1568
1570
1571#ifdef __cplusplus
1572} // extern "C"
1573#endif // __cplusplus
1574
1575#endif // BITCOIN_KERNEL_BITCOINKERNEL_H
int flags
Definition: bitcoin-tx.cpp:529
#define BITCOINKERNEL_API
Definition: bitcoinkernel.h:27
BITCOINKERNEL_API btck_TransactionInput *BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_input_copy(const btck_TransactionInput *transaction_input) BITCOINKERNEL_ARG_NONNULL(1)
Copy a transaction input.
BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_txid_equals(const btck_Txid *txid1, const btck_Txid *txid2) BITCOINKERNEL_ARG_NONNULL(1
Check if two txids are equal.
BITCOINKERNEL_API const btck_TransactionOutPoint *BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_input_get_out_point(const btck_TransactionInput *transaction_input) BITCOINKERNEL_ARG_NONNULL(1)
Get the transaction out point.
uint8_t btck_LogLevel
The level at which logs should be produced.
BITCOINKERNEL_API btck_ChainstateManagerOptions *BITCOINKERNEL_WARN_UNUSED_RESULT btck_chainstate_manager_options_create(const btck_Context *context, const char *data_directory, size_t data_directory_len, const char *blocks_directory, size_t blocks_directory_len) BITCOINKERNEL_ARG_NONNULL(1
Create options for the chainstate manager.
BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_script_pubkey_verify(const btck_ScriptPubkey *script_pubkey, int64_t amount, const btck_Transaction *tx_to, const btck_TransactionOutput **spent_outputs, size_t spent_outputs_len, unsigned int input_index, unsigned int flags, btck_ScriptVerifyStatus *status) BITCOINKERNEL_ARG_NONNULL(1
Verify if the input at input_index of tx_to spends the script pubkey under the constraints specified ...
BITCOINKERNEL_API btck_TransactionOutput *BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_output_copy(const btck_TransactionOutput *transaction_output) BITCOINKERNEL_ARG_NONNULL(1)
Copy a transaction output.
BITCOINKERNEL_API uint32_t BITCOINKERNEL_WARN_UNUSED_RESULT btck_coin_confirmation_height(const btck_Coin *coin) BITCOINKERNEL_ARG_NONNULL(1)
Returns the block height where the transaction that created this coin was included in.
BITCOINKERNEL_API void btck_logging_set_options(const btck_LoggingOptions options)
Set some options for the global internal logger.
BITCOINKERNEL_API const btck_Txid *BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_out_point_get_txid(const btck_TransactionOutPoint *transaction_out_point) BITCOINKERNEL_ARG_NONNULL(1)
Get the txid from the transaction out point.
BITCOINKERNEL_API void btck_logging_connection_destroy(btck_LoggingConnection *logging_connection)
Stop logging and destroy the logging connection.
BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_coin_is_coinbase(const btck_Coin *coin) BITCOINKERNEL_ARG_NONNULL(1)
Returns whether the containing transaction was a coinbase.
int(* btck_WriteBytes)(const void *bytes, size_t size, void *userdata)
Function signature for serializing data.
BITCOINKERNEL_API const btck_BlockTreeEntry *BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_tree_entry_get_previous(const btck_BlockTreeEntry *block_tree_entry) BITCOINKERNEL_ARG_NONNULL(1)
Returns the previous block tree entry in the tree, or null if the current block tree entry is the gen...
BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_context_interrupt(btck_Context *context) BITCOINKERNEL_ARG_NONNULL(1)
Interrupt can be used to halt long-running validation functions like when reindexing,...
#define BITCOINKERNEL_WARN_UNUSED_RESULT
Definition: bitcoinkernel.h:36
BITCOINKERNEL_API void btck_transaction_destroy(btck_Transaction *transaction)
Destroy the transaction.
BITCOINKERNEL_API int64_t BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_output_get_amount(const btck_TransactionOutput *transaction_output) BITCOINKERNEL_ARG_NONNULL(1)
Get the amount in the output.
BITCOINKERNEL_API const btck_Transaction *BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_get_transaction_at(const btck_Block *block, size_t transaction_index) BITCOINKERNEL_ARG_NONNULL(1)
Get the transaction at the provided index.
uint8_t btck_ChainType
BITCOINKERNEL_API const btck_TransactionInput *BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_get_input_at(const btck_Transaction *transaction, size_t input_index) BITCOINKERNEL_ARG_NONNULL(1)
Get the transaction input at the provided index.
BITCOINKERNEL_API const btck_BlockTreeEntry *BITCOINKERNEL_WARN_UNUSED_RESULT btck_chainstate_manager_get_block_tree_entry_by_hash(const btck_ChainstateManager *chainstate_manager, const btck_BlockHash *block_hash) BITCOINKERNEL_ARG_NONNULL(1
Retrieve a block tree entry by its block hash.
BITCOINKERNEL_API btck_Block *BITCOINKERNEL_WARN_UNUSED_RESULT BITCOINKERNEL_API btck_Block *BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_create(const void *raw_block, size_t raw_block_len) BITCOINKERNEL_ARG_NONNULL(1)
Parse a serialized raw block into a new block object.
void(* btck_LogCallback)(void *user_data, const char *message, size_t message_len)
Callback function types.
void(* btck_ValidationInterfaceBlockChecked)(void *user_data, btck_Block *block, const btck_BlockValidationState *state)
Function signatures for the validation interface.
BITCOINKERNEL_API btck_Context *BITCOINKERNEL_WARN_UNUSED_RESULT btck_context_create(const btck_ContextOptions *context_options)
Create a new kernel context.
BITCOINKERNEL_API btck_BlockSpentOutputs *BITCOINKERNEL_WARN_UNUSED_RESULT BITCOINKERNEL_API btck_BlockSpentOutputs *BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_spent_outputs_copy(const btck_BlockSpentOutputs *block_spent_outputs) BITCOINKERNEL_ARG_NONNULL(1)
Copy a block's spent outputs.
uint32_t btck_BlockValidationResult
A granular "reason" why a block was invalid.
uint8_t btck_ValidationMode
Whether a validated data structure is valid, invalid, or an error was encountered during processing.
BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT BITCOINKERNEL_API void BITCOINKERNEL_API void btck_txid_destroy(btck_Txid *txid)
Destroy the txid.
BITCOINKERNEL_API void btck_logging_disable_category(btck_LogCategory category)
Disable a specific log category for the global internal logger.
void(* btck_ValidationInterfacePoWValidBlock)(void *user_data, btck_Block *block, const btck_BlockTreeEntry *entry)
BITCOINKERNEL_API const btck_ScriptPubkey *BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_output_get_script_pubkey(const btck_TransactionOutput *transaction_output) BITCOINKERNEL_ARG_NONNULL(1)
Get the script pubkey of the output.
BITCOINKERNEL_API int BITCOINKERNEL_API size_t BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_count_outputs(const btck_Transaction *transaction) BITCOINKERNEL_ARG_NONNULL(1)
Get the number of outputs of a transaction.
BITCOINKERNEL_API btck_BlockValidationResult btck_block_validation_state_get_block_validation_result(const btck_BlockValidationState *block_validation_state) BITCOINKERNEL_ARG_NONNULL(1)
Returns the validation result from an opaque block validation state pointer.
BITCOINKERNEL_API const btck_Txid *BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_get_txid(const btck_Transaction *transaction) BITCOINKERNEL_ARG_NONNULL(1)
Get the txid of a transaction.
uint8_t btck_SynchronizationState
Current sync state passed to tip changed callbacks.
BITCOINKERNEL_API void btck_context_options_destroy(btck_ContextOptions *context_options)
Destroy the context options.
void(* btck_NotifyProgress)(void *user_data, const char *title, size_t title_len, int progress_percent, int resume_possible)
BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_chainstate_manager_import_blocks(btck_ChainstateManager *chainstate_manager, const char **block_file_paths_data, size_t *block_file_paths_lens, size_t block_file_paths_data_len) BITCOINKERNEL_ARG_NONNULL(1)
Triggers the start of a reindex if the wipe options were previously set for the chainstate manager.
void(* btck_NotifyWarningUnset)(void *user_data, btck_Warning warning)
BITCOINKERNEL_API btck_Block *BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_copy(const btck_Block *block) BITCOINKERNEL_ARG_NONNULL(1)
Copy a block.
BITCOINKERNEL_API int32_t BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_tree_entry_get_height(const btck_BlockTreeEntry *block_tree_entry) BITCOINKERNEL_ARG_NONNULL(1)
Return the height of a certain block tree entry.
void(* btck_ValidationInterfaceBlockDisconnected)(void *user_data, btck_Block *block, const btck_BlockTreeEntry *entry)
BITCOINKERNEL_API int32_t BITCOINKERNEL_WARN_UNUSED_RESULT btck_chain_get_height(const btck_Chain *chain) BITCOINKERNEL_ARG_NONNULL(1)
Return the height of the tip of the chain.
BITCOINKERNEL_API void btck_chainstate_manager_options_update_chainstate_db_in_memory(btck_ChainstateManagerOptions *chainstate_manager_options, int chainstate_db_in_memory) BITCOINKERNEL_ARG_NONNULL(1)
Sets chainstate db in memory in the options.
BITCOINKERNEL_API void btck_chainstate_manager_options_destroy(btck_ChainstateManagerOptions *chainstate_manager_options)
Destroy the chainstate manager options.
BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_chainstate_manager_options_set_wipe_dbs(btck_ChainstateManagerOptions *chainstate_manager_options, int wipe_block_tree_db, int wipe_chainstate_db) BITCOINKERNEL_ARG_NONNULL(1)
Sets wipe db in the options.
BITCOINKERNEL_API btck_ContextOptions *BITCOINKERNEL_WARN_UNUSED_RESULT btck_context_options_create()
Creates an empty context options.
BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT BITCOINKERNEL_API btck_BlockHash *BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_hash_copy(const btck_BlockHash *block_hash) BITCOINKERNEL_ARG_NONNULL(1)
Copy a block hash.
BITCOINKERNEL_API int btck_transaction_to_bytes(const btck_Transaction *transaction, btck_WriteBytes writer, void *user_data) BITCOINKERNEL_ARG_NONNULL(1
Serializes the transaction through the passed in callback to bytes.
#define BITCOINKERNEL_ARG_NONNULL(...)
Definition: bitcoinkernel.h:41
void(* btck_DestroyCallback)(void *user_data)
Function signature for freeing user data.
BITCOINKERNEL_API int btck_block_to_bytes(const btck_Block *block, btck_WriteBytes writer, void *user_data) BITCOINKERNEL_ARG_NONNULL(1
Serializes the block through the passed in callback to bytes.
uint32_t btck_ScriptVerificationFlags
Script verification flags that may be composed with each other.
BITCOINKERNEL_API btck_TransactionSpentOutputs *BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_spent_outputs_copy(const btck_TransactionSpentOutputs *transaction_spent_outputs) BITCOINKERNEL_ARG_NONNULL(1)
Copy a transaction's spent outputs.
BITCOINKERNEL_API btck_Context *BITCOINKERNEL_WARN_UNUSED_RESULT btck_context_copy(const btck_Context *context) BITCOINKERNEL_ARG_NONNULL(1)
Copy the context.
BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_chainstate_manager_process_block(btck_ChainstateManager *chainstate_manager, const btck_Block *block, int *new_block) BITCOINKERNEL_ARG_NONNULL(1
Process and validate the passed in block with the chainstate manager.
BITCOINKERNEL_API size_t BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_count_inputs(const btck_Transaction *transaction) BITCOINKERNEL_ARG_NONNULL(1)
Get the number of inputs of a transaction.
BITCOINKERNEL_API const btck_BlockHash *BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_tree_entry_get_block_hash(const btck_BlockTreeEntry *block_tree_entry) BITCOINKERNEL_ARG_NONNULL(1)
Return the block hash associated with a block tree entry.
BITCOINKERNEL_API size_t BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_spent_outputs_count(const btck_BlockSpentOutputs *block_spent_outputs) BITCOINKERNEL_ARG_NONNULL(1)
Returns the number of transaction spent outputs whose data is contained in block spent outputs.
BITCOINKERNEL_API btck_Transaction *BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_create(const void *raw_transaction, size_t raw_transaction_len) BITCOINKERNEL_ARG_NONNULL(1)
Create a new transaction from the serialized data.
BITCOINKERNEL_API btck_Txid *BITCOINKERNEL_WARN_UNUSED_RESULT btck_txid_copy(const btck_Txid *txid) BITCOINKERNEL_ARG_NONNULL(1)
Copy a txid.
BITCOINKERNEL_API int BITCOINKERNEL_API void btck_block_destroy(btck_Block *block)
Destroy the block.
BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT BITCOINKERNEL_API int btck_script_pubkey_to_bytes(const btck_ScriptPubkey *script_pubkey, btck_WriteBytes writer, void *user_data) BITCOINKERNEL_ARG_NONNULL(1
Serializes the script pubkey through the passed in callback to bytes.
BITCOINKERNEL_API btck_Coin *BITCOINKERNEL_WARN_UNUSED_RESULT btck_coin_copy(const btck_Coin *coin) BITCOINKERNEL_ARG_NONNULL(1)
Copy a coin.
BITCOINKERNEL_API btck_ChainstateManager *BITCOINKERNEL_WARN_UNUSED_RESULT btck_chainstate_manager_create(const btck_ChainstateManagerOptions *chainstate_manager_options) BITCOINKERNEL_ARG_NONNULL(1)
Create a chainstate manager.
BITCOINKERNEL_API const btck_BlockTreeEntry *BITCOINKERNEL_WARN_UNUSED_RESULT BITCOINKERNEL_API void btck_chainstate_manager_destroy(btck_ChainstateManager *chainstate_manager)
Destroy the chainstate manager.
BITCOINKERNEL_API const btck_BlockTreeEntry *BITCOINKERNEL_WARN_UNUSED_RESULT btck_chain_get_tip(const btck_Chain *chain) BITCOINKERNEL_ARG_NONNULL(1)
Get the block tree entry of the current chain tip.
BITCOINKERNEL_API void btck_transaction_output_destroy(btck_TransactionOutput *transaction_output)
Destroy the transaction output.
BITCOINKERNEL_API btck_TransactionOutput *BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_output_create(const btck_ScriptPubkey *script_pubkey, int64_t amount) BITCOINKERNEL_ARG_NONNULL(1)
Create a transaction output from a script pubkey and an amount.
BITCOINKERNEL_API btck_BlockSpentOutputs *BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_spent_outputs_read(const btck_ChainstateManager *chainstate_manager, const btck_BlockTreeEntry *block_tree_entry) BITCOINKERNEL_ARG_NONNULL(1
Reads the block spent coins data the passed in block tree entry points to from disk and returns it.
uint8_t btck_ScriptVerifyStatus
A collection of status codes that may be issued by the script verify function.
BITCOINKERNEL_API btck_Block *BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_read(const btck_ChainstateManager *chainstate_manager, const btck_BlockTreeEntry *block_tree_entry) BITCOINKERNEL_ARG_NONNULL(1
Reads the block the passed in block tree entry points to from disk and returns it.
BITCOINKERNEL_API void btck_transaction_out_point_destroy(btck_TransactionOutPoint *transaction_out_point)
Destroy the transaction out point.
BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_chain_contains(const btck_Chain *chain, const btck_BlockTreeEntry *block_tree_entry) BITCOINKERNEL_ARG_NONNULL(1
Return true if the passed in chain contains the block tree entry.
BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_hash_equals(const btck_BlockHash *hash1, const btck_BlockHash *hash2) BITCOINKERNEL_ARG_NONNULL(1
Check if two block hashes are equal.
BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT BITCOINKERNEL_API void btck_txid_to_bytes(const btck_Txid *txid, unsigned char output[32]) BITCOINKERNEL_ARG_NONNULL(1
Serializes the txid to bytes.
void(* btck_NotifyBlockTip)(void *user_data, btck_SynchronizationState state, const btck_BlockTreeEntry *entry, double verification_progress)
Function signatures for the kernel notifications.
uint8_t btck_LogCategory
A collection of logging categories that may be encountered by kernel code.
void(* btck_ValidationInterfaceBlockConnected)(void *user_data, btck_Block *block, const btck_BlockTreeEntry *entry)
BITCOINKERNEL_API void btck_transaction_spent_outputs_destroy(btck_TransactionSpentOutputs *transaction_spent_outputs)
Destroy the transaction spent outputs.
BITCOINKERNEL_API void btck_chain_parameters_destroy(btck_ChainParameters *chain_parameters)
Destroy the chain parameters.
BITCOINKERNEL_API size_t BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_spent_outputs_count(const btck_TransactionSpentOutputs *transaction_spent_outputs) BITCOINKERNEL_ARG_NONNULL(1)
Returns the number of previous transaction outputs contained in the transaction spent outputs data.
BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT BITCOINKERNEL_API int BITCOINKERNEL_API void btck_script_pubkey_destroy(btck_ScriptPubkey *script_pubkey)
Destroy the script pubkey.
BITCOINKERNEL_API void btck_logging_enable_category(btck_LogCategory category)
Enable a specific log category for the global internal logger.
uint8_t btck_Warning
Possible warning types issued by validation.
BITCOINKERNEL_API btck_ChainParameters *BITCOINKERNEL_WARN_UNUSED_RESULT btck_chain_parameters_create(const btck_ChainType chain_type)
Creates a chain parameters struct with default parameters based on the passed in chain type.
BITCOINKERNEL_API const btck_TransactionSpentOutputs *BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_spent_outputs_get_transaction_spent_outputs_at(const btck_BlockSpentOutputs *block_spent_outputs, size_t transaction_spent_outputs_index) BITCOINKERNEL_ARG_NONNULL(1)
Returns a transaction spent outputs contained in the block spent outputs at a certain index.
BITCOINKERNEL_API btck_Transaction *BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_copy(const btck_Transaction *transaction) BITCOINKERNEL_ARG_NONNULL(1)
Copy a transaction.
BITCOINKERNEL_API void btck_coin_destroy(btck_Coin *coin)
Destroy the coin.
void(* btck_NotifyHeaderTip)(void *user_data, btck_SynchronizationState state, int64_t height, int64_t timestamp, int presync)
BITCOINKERNEL_API const btck_BlockTreeEntry *BITCOINKERNEL_WARN_UNUSED_RESULT btck_chain_get_genesis(const btck_Chain *chain) BITCOINKERNEL_ARG_NONNULL(1)
Get the block tree entry of the genesis block.
BITCOINKERNEL_API void BITCOINKERNEL_API void btck_context_options_set_notifications(btck_ContextOptions *context_options, btck_NotificationInterfaceCallbacks notifications) BITCOINKERNEL_ARG_NONNULL(1)
Set the kernel notifications for the context options.
BITCOINKERNEL_API btck_BlockHash *BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_get_hash(const btck_Block *block) BITCOINKERNEL_ARG_NONNULL(1)
Calculate and return the hash of a block.
BITCOINKERNEL_API btck_ValidationMode btck_block_validation_state_get_validation_mode(const btck_BlockValidationState *block_validation_state) BITCOINKERNEL_ARG_NONNULL(1)
Returns the validation mode from an opaque block validation state pointer.
BITCOINKERNEL_API void btck_block_spent_outputs_destroy(btck_BlockSpentOutputs *block_spent_outputs)
Destroy the block spent outputs.
BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT BITCOINKERNEL_API const btck_Chain *BITCOINKERNEL_WARN_UNUSED_RESULT btck_chainstate_manager_get_active_chain(const btck_ChainstateManager *chainstate_manager) BITCOINKERNEL_ARG_NONNULL(1)
Returns the best known currently active chain.
BITCOINKERNEL_API btck_TransactionOutPoint *BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_out_point_copy(const btck_TransactionOutPoint *transaction_out_point) BITCOINKERNEL_ARG_NONNULL(1)
Copy a transaction out point.
BITCOINKERNEL_API void btck_logging_set_level_category(btck_LogCategory category, btck_LogLevel level)
Set the log level of the global internal logger.
BITCOINKERNEL_API void btck_context_options_set_chainparams(btck_ContextOptions *context_options, const btck_ChainParameters *chain_parameters) BITCOINKERNEL_ARG_NONNULL(1
Sets the chain params for the context options.
BITCOINKERNEL_API void BITCOINKERNEL_API void btck_block_hash_destroy(btck_BlockHash *block_hash)
Destroy the block hash.
BITCOINKERNEL_API btck_BlockHash *BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_hash_create(const unsigned char block_hash[32]) BITCOINKERNEL_ARG_NONNULL(1)
Create a block hash from its raw data.
BITCOINKERNEL_API void btck_block_hash_to_bytes(const btck_BlockHash *block_hash, unsigned char output[32]) BITCOINKERNEL_ARG_NONNULL(1
Serializes the block hash to bytes.
BITCOINKERNEL_API const btck_BlockTreeEntry *BITCOINKERNEL_WARN_UNUSED_RESULT btck_chain_get_by_height(const btck_Chain *chain, int block_height) BITCOINKERNEL_ARG_NONNULL(1)
Retrieve a block tree entry by its height in the currently active chain.
BITCOINKERNEL_API void btck_logging_disable()
This disables the global internal logger.
BITCOINKERNEL_API void btck_chainstate_manager_options_update_block_tree_db_in_memory(btck_ChainstateManagerOptions *chainstate_manager_options, int block_tree_db_in_memory) BITCOINKERNEL_ARG_NONNULL(1)
Sets block tree db in memory in the options.
void(* btck_NotifyWarningSet)(void *user_data, btck_Warning warning, const char *message, size_t message_len)
BITCOINKERNEL_API btck_ScriptPubkey *BITCOINKERNEL_WARN_UNUSED_RESULT btck_script_pubkey_copy(const btck_ScriptPubkey *script_pubkey) BITCOINKERNEL_ARG_NONNULL(1)
Copy a script pubkey.
BITCOINKERNEL_API void btck_transaction_input_destroy(btck_TransactionInput *transaction_input)
Destroy the transaction input.
BITCOINKERNEL_API uint32_t BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_out_point_get_index(const btck_TransactionOutPoint *transaction_out_point) BITCOINKERNEL_ARG_NONNULL(1)
Get the output position from the transaction out point.
BITCOINKERNEL_API const btck_TransactionOutput *BITCOINKERNEL_WARN_UNUSED_RESULT btck_coin_get_output(const btck_Coin *coin) BITCOINKERNEL_ARG_NONNULL(1)
Return the transaction output of a coin.
BITCOINKERNEL_API void btck_context_destroy(btck_Context *context)
Destroy the context.
BITCOINKERNEL_API void btck_context_options_set_validation_interface(btck_ContextOptions *context_options, btck_ValidationInterfaceCallbacks validation_interface_callbacks) BITCOINKERNEL_ARG_NONNULL(1)
Set the validation interface callbacks for the context options.
void(* btck_NotifyFatalError)(void *user_data, const char *message, size_t message_len)
void(* btck_NotifyFlushError)(void *user_data, const char *message, size_t message_len)
BITCOINKERNEL_API size_t BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_count_transactions(const btck_Block *block) BITCOINKERNEL_ARG_NONNULL(1)
Count the number of transactions contained in a block.
BITCOINKERNEL_API btck_LoggingConnection *BITCOINKERNEL_WARN_UNUSED_RESULT btck_logging_connection_create(btck_LogCallback log_callback, void *user_data, btck_DestroyCallback user_data_destroy_callback) BITCOINKERNEL_ARG_NONNULL(1)
Start logging messages through the provided callback.
BITCOINKERNEL_API btck_ScriptPubkey *BITCOINKERNEL_WARN_UNUSED_RESULT btck_script_pubkey_create(const void *script_pubkey, size_t script_pubkey_len) BITCOINKERNEL_ARG_NONNULL(1)
Create a script pubkey from serialized data.
BITCOINKERNEL_API const btck_Coin *BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_spent_outputs_get_coin_at(const btck_TransactionSpentOutputs *transaction_spent_outputs, size_t coin_index) BITCOINKERNEL_ARG_NONNULL(1)
Returns a coin contained in the transaction spent outputs at a certain index.
BITCOINKERNEL_API btck_ChainstateManagerOptions *BITCOINKERNEL_WARN_UNUSED_RESULT BITCOINKERNEL_API void btck_chainstate_manager_options_set_worker_threads_num(btck_ChainstateManagerOptions *chainstate_manager_options, int worker_threads) BITCOINKERNEL_ARG_NONNULL(1)
Set the number of available worker threads used during validation.
BITCOINKERNEL_API btck_ChainParameters *BITCOINKERNEL_WARN_UNUSED_RESULT btck_chain_parameters_copy(const btck_ChainParameters *chain_parameters) BITCOINKERNEL_ARG_NONNULL(1)
Copy the chain parameters.
BITCOINKERNEL_API const btck_TransactionOutput *BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_get_output_at(const btck_Transaction *transaction, size_t output_index) BITCOINKERNEL_ARG_NONNULL(1)
Get the transaction outputs at the provided index.
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
A un-recoverable 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.