bitcoinkernel_8h_source.html

// Copyright (c) 2024-present The Bitcoin Core developers

// Distributed under the MIT software license, see the accompanying

// file COPYING or http://www.opensource.org/licenses/mit-license.php.


#ifndef BITCOIN_KERNEL_BITCOINKERNEL_H

#define BITCOIN_KERNEL_BITCOINKERNEL_H


#ifndef __cplusplus

#include <stddef.h>

#include <stdint.h>

#else

#include <cstddef>

#include <cstdint>

#endif // __cplusplus


#ifndef BITCOINKERNEL_API

    #ifdef BITCOINKERNEL_BUILD

        #if defined(_WIN32)

            #define BITCOINKERNEL_API __declspec(dllexport)

        #else

            #define BITCOINKERNEL_API __attribute__((visibility("default")))

        #endif

    #else

        #if defined(_WIN32) && !defined(BITCOINKERNEL_STATIC)

            #define BITCOINKERNEL_API __declspec(dllimport)

        #else

            #define BITCOINKERNEL_API

        #endif

    #endif

#endif


#if defined(__GNUC__)

    #define BITCOINKERNEL_WARN_UNUSED_RESULT __attribute__((__warn_unused_result__))

#else

    #define BITCOINKERNEL_WARN_UNUSED_RESULT

#endif


#if !defined(BITCOINKERNEL_BUILD) && defined(__GNUC__)

    #define BITCOINKERNEL_ARG_NONNULL(...) __attribute__((__nonnull__(__VA_ARGS__)))

#else

    #define BITCOINKERNEL_ARG_NONNULL(...)

#endif


#ifdef __cplusplus

extern "C" {

#endif // __cplusplus


typedef struct btck_Transaction btck_Transaction;


typedef struct btck_ScriptPubkey btck_ScriptPubkey;


typedef struct btck_TransactionOutput btck_TransactionOutput;


typedef struct btck_LoggingConnection btck_LoggingConnection;


typedef struct btck_ChainParameters btck_ChainParameters;


typedef struct btck_ContextOptions btck_ContextOptions;


typedef struct btck_Context btck_Context;


typedef struct btck_BlockTreeEntry btck_BlockTreeEntry;


typedef struct btck_ChainstateManagerOptions btck_ChainstateManagerOptions;


typedef struct btck_ChainstateManager btck_ChainstateManager;


typedef struct btck_Block btck_Block;


typedef struct btck_BlockValidationState btck_BlockValidationState;


typedef struct btck_ConsensusParams btck_ConsensusParams;


typedef struct btck_Chain btck_Chain;


typedef struct btck_TxValidationState btck_TxValidationState;


typedef struct btck_BlockSpentOutputs btck_BlockSpentOutputs;


typedef struct btck_TransactionSpentOutputs btck_TransactionSpentOutputs;


typedef struct btck_Coin btck_Coin;


typedef struct btck_BlockHash btck_BlockHash;


typedef struct btck_TransactionInput btck_TransactionInput;


typedef struct btck_WitnessStack btck_WitnessStack;


typedef struct btck_TransactionOutPoint btck_TransactionOutPoint;


typedef struct btck_PrecomputedTransactionData btck_PrecomputedTransactionData;


typedef struct btck_Txid btck_Txid;


typedef struct btck_Wtxid btck_Wtxid;


typedef struct btck_BlockHeader btck_BlockHeader;


typedef uint8_t btck_SynchronizationState;

#define btck_SynchronizationState_INIT_REINDEX ((btck_SynchronizationState)(0))

#define btck_SynchronizationState_INIT_DOWNLOAD ((btck_SynchronizationState)(1))

#define btck_SynchronizationState_POST_INIT ((btck_SynchronizationState)(2))


typedef uint8_t btck_Warning;

#define btck_Warning_UNKNOWN_NEW_RULES_ACTIVATED ((btck_Warning)(0))

#define btck_Warning_LARGE_WORK_INVALID_CHAIN ((btck_Warning)(1))


typedef uint8_t btck_LogCategory;

#define btck_LogCategory_NONE ((btck_LogCategory)(0))

#define btck_LogCategory_BENCH ((btck_LogCategory)(1))

#define btck_LogCategory_BLOCKSTORAGE ((btck_LogCategory)(2))

#define btck_LogCategory_COINDB ((btck_LogCategory)(3))

#define btck_LogCategory_LEVELDB ((btck_LogCategory)(4))

#define btck_LogCategory_MEMPOOL ((btck_LogCategory)(5))

#define btck_LogCategory_PRUNE ((btck_LogCategory)(6))

#define btck_LogCategory_RAND ((btck_LogCategory)(7))

#define btck_LogCategory_REINDEX ((btck_LogCategory)(8))

#define btck_LogCategory_VALIDATION ((btck_LogCategory)(9))

#define btck_LogCategory_KERNEL ((btck_LogCategory)(10))

#define btck_LogCategory_TXPACKAGES ((btck_LogCategory)(11))

#define btck_LogCategory_LOCK ((btck_LogCategory)(12))


typedef uint8_t btck_LogLevel;

#define btck_LogLevel_TRACE ((btck_LogLevel)(0))

#define btck_LogLevel_DEBUG ((btck_LogLevel)(1))

#define btck_LogLevel_INFO ((btck_LogLevel)(2))

#define btck_LogLevel_WARNING ((btck_LogLevel)(3))

#define btck_LogLevel_ERROR ((btck_LogLevel)(4))


typedef struct {

    const char* message;

    size_t message_len;

    const char* thread_name;

    size_t thread_name_len;

    int64_t timestamp_ns;

    int64_t mocktime_s;

    const char* file_name;

    size_t file_name_len;

    const char* function_name;

    size_t function_name_len;

    uint32_t line;

    btck_LogLevel level;

    btck_LogCategory category;

} btck_LogEntry;


typedef void (*btck_LogCallback)(void* user_data, const btck_LogEntry* entry);


typedef void (*btck_DestroyCallback)(void* user_data);


typedef void (*btck_NotifyBlockTip)(void* user_data, btck_SynchronizationState state, const btck_BlockTreeEntry* entry, double verification_progress);

typedef void (*btck_NotifyHeaderTip)(void* user_data, btck_SynchronizationState state, int64_t height, int64_t timestamp, int presync);

typedef void (*btck_NotifyProgress)(void* user_data, const char* title, size_t title_len, int progress_percent, int resume_possible);

typedef void (*btck_NotifyWarningSet)(void* user_data, btck_Warning warning, const char* message, size_t message_len);

typedef void (*btck_NotifyWarningUnset)(void* user_data, btck_Warning warning);

typedef void (*btck_NotifyFlushError)(void* user_data, const char* message, size_t message_len);

typedef void (*btck_NotifyFatalError)(void* user_data, const char* message, size_t message_len);


typedef void (*btck_ValidationInterfaceBlockChecked)(void* user_data, btck_Block* block, const btck_BlockValidationState* state);

typedef void (*btck_ValidationInterfacePoWValidBlock)(void* user_data, btck_Block* block, const btck_BlockTreeEntry* entry);

typedef void (*btck_ValidationInterfaceBlockConnected)(void* user_data, btck_Block* block, const btck_BlockTreeEntry* entry);

typedef void (*btck_ValidationInterfaceBlockDisconnected)(void* user_data, btck_Block* block, const btck_BlockTreeEntry* entry);


typedef int (*btck_WriteBytes)(const void* bytes, size_t size, void* userdata);


typedef uint8_t btck_ValidationMode;

#define btck_ValidationMode_VALID ((btck_ValidationMode)(0))

#define btck_ValidationMode_INVALID ((btck_ValidationMode)(1))

#define btck_ValidationMode_INTERNAL_ERROR ((btck_ValidationMode)(2))


typedef uint32_t btck_BlockValidationResult;

#define btck_BlockValidationResult_UNSET ((btck_BlockValidationResult)(0))

#define btck_BlockValidationResult_CONSENSUS ((btck_BlockValidationResult)(1))

#define btck_BlockValidationResult_CACHED_INVALID ((btck_BlockValidationResult)(2))

#define btck_BlockValidationResult_INVALID_HEADER ((btck_BlockValidationResult)(3))

#define btck_BlockValidationResult_MUTATED ((btck_BlockValidationResult)(4))

#define btck_BlockValidationResult_MISSING_PREV ((btck_BlockValidationResult)(5))

#define btck_BlockValidationResult_INVALID_PREV ((btck_BlockValidationResult)(6))

#define btck_BlockValidationResult_TIME_FUTURE ((btck_BlockValidationResult)(7))

#define btck_BlockValidationResult_HEADER_LOW_WORK ((btck_BlockValidationResult)(8))


typedef uint32_t btck_TxValidationResult;

#define btck_TxValidationResult_UNSET               ((btck_TxValidationResult)(0))

#define btck_TxValidationResult_CONSENSUS           ((btck_TxValidationResult)(1))

#define btck_TxValidationResult_INPUTS_NOT_STANDARD ((btck_TxValidationResult)(2))

#define btck_TxValidationResult_NOT_STANDARD        ((btck_TxValidationResult)(3))

#define btck_TxValidationResult_MISSING_INPUTS      ((btck_TxValidationResult)(4))

#define btck_TxValidationResult_PREMATURE_SPEND     ((btck_TxValidationResult)(5))

#define btck_TxValidationResult_WITNESS_MUTATED     ((btck_TxValidationResult)(6))

#define btck_TxValidationResult_WITNESS_STRIPPED    ((btck_TxValidationResult)(7))

#define btck_TxValidationResult_CONFLICT            ((btck_TxValidationResult)(8))

#define btck_TxValidationResult_MEMPOOL_POLICY      ((btck_TxValidationResult)(9))

#define btck_TxValidationResult_NO_MEMPOOL          ((btck_TxValidationResult)(10))

#define btck_TxValidationResult_RECONSIDERABLE      ((btck_TxValidationResult)(11))

#define btck_TxValidationResult_UNKNOWN             ((btck_TxValidationResult)(12))


typedef struct {

    void* user_data;

    btck_DestroyCallback user_data_destroy;

    btck_ValidationInterfaceBlockChecked block_checked;

    btck_ValidationInterfacePoWValidBlock pow_valid_block;

    btck_ValidationInterfaceBlockConnected block_connected;

    btck_ValidationInterfaceBlockDisconnected block_disconnected;

} btck_ValidationInterfaceCallbacks;


typedef struct {

    void* user_data;

    btck_DestroyCallback user_data_destroy;

    btck_NotifyBlockTip block_tip;

    btck_NotifyHeaderTip header_tip;

    btck_NotifyProgress progress;

    btck_NotifyWarningSet warning_set;

    btck_NotifyWarningUnset warning_unset;

    btck_NotifyFlushError flush_error;

    btck_NotifyFatalError fatal_error;

} btck_NotificationInterfaceCallbacks;


typedef uint8_t btck_ScriptVerifyStatus;

#define btck_ScriptVerifyStatus_OK ((btck_ScriptVerifyStatus)(0))

#define btck_ScriptVerifyStatus_ERROR_INVALID_FLAGS_COMBINATION ((btck_ScriptVerifyStatus)(1))

#define btck_ScriptVerifyStatus_ERROR_SPENT_OUTPUTS_REQUIRED ((btck_ScriptVerifyStatus)(2))


typedef uint32_t btck_ScriptVerificationFlags;

#define btck_ScriptVerificationFlags_NONE ((btck_ScriptVerificationFlags)(0))

#define btck_ScriptVerificationFlags_P2SH ((btck_ScriptVerificationFlags)(1U << 0))

#define btck_ScriptVerificationFlags_DERSIG ((btck_ScriptVerificationFlags)(1U << 2))

#define btck_ScriptVerificationFlags_NULLDUMMY ((btck_ScriptVerificationFlags)(1U << 4))

#define btck_ScriptVerificationFlags_CHECKLOCKTIMEVERIFY ((btck_ScriptVerificationFlags)(1U << 9))

#define btck_ScriptVerificationFlags_CHECKSEQUENCEVERIFY ((btck_ScriptVerificationFlags)(1U << 10))

#define btck_ScriptVerificationFlags_WITNESS ((btck_ScriptVerificationFlags)(1U << 11))

#define btck_ScriptVerificationFlags_TAPROOT ((btck_ScriptVerificationFlags)(1U << 17))

#define btck_ScriptVerificationFlags_ALL ((btck_ScriptVerificationFlags)(btck_ScriptVerificationFlags_P2SH |                \

                                                                         btck_ScriptVerificationFlags_DERSIG |              \

                                                                         btck_ScriptVerificationFlags_NULLDUMMY |           \

                                                                         btck_ScriptVerificationFlags_CHECKLOCKTIMEVERIFY | \

                                                                         btck_ScriptVerificationFlags_CHECKSEQUENCEVERIFY | \

                                                                         btck_ScriptVerificationFlags_WITNESS |             \

                                                                         btck_ScriptVerificationFlags_TAPROOT))


typedef uint8_t btck_ChainType;

#define btck_ChainType_MAINNET ((btck_ChainType)(0))

#define btck_ChainType_TESTNET ((btck_ChainType)(1))

#define btck_ChainType_TESTNET_4 ((btck_ChainType)(2))

#define btck_ChainType_SIGNET ((btck_ChainType)(3))

#define btck_ChainType_REGTEST ((btck_ChainType)(4))


BITCOINKERNEL_API btck_TxValidationState* BITCOINKERNEL_WARN_UNUSED_RESULT btck_tx_validation_state_create();


BITCOINKERNEL_API btck_ValidationMode btck_tx_validation_state_get_validation_mode(

    const btck_TxValidationState* state) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API btck_TxValidationResult btck_tx_validation_state_get_tx_validation_result(

    const btck_TxValidationState* state) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API void btck_tx_validation_state_destroy(btck_TxValidationState* state);


BITCOINKERNEL_API btck_Transaction* BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_create(

    const void* raw_transaction, size_t raw_transaction_len);


BITCOINKERNEL_API btck_Transaction* BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_copy(

    const btck_Transaction* transaction) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_to_bytes(

    const btck_Transaction* transaction,

    btck_WriteBytes writer,

    void* user_data) BITCOINKERNEL_ARG_NONNULL(1, 2);


BITCOINKERNEL_API size_t btck_transaction_count_outputs(

    const btck_Transaction* transaction) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API const btck_TransactionOutput* btck_transaction_get_output_at(

    const btck_Transaction* transaction, size_t output_index) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API const btck_TransactionInput* btck_transaction_get_input_at(

    const btck_Transaction* transaction, size_t input_index) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API size_t btck_transaction_count_inputs(

    const btck_Transaction* transaction) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API uint32_t btck_transaction_get_version(

    const btck_Transaction* transaction) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API uint32_t btck_transaction_get_locktime(

    const btck_Transaction* transaction) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API const btck_Txid* btck_transaction_get_txid(

    const btck_Transaction* transaction) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API int btck_transaction_has_witness(

    const btck_Transaction* transaction) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API const btck_Wtxid* btck_transaction_get_wtxid(

    const btck_Transaction* transaction) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API int btck_transaction_check(

    const btck_Transaction* tx,

    btck_TxValidationState* validation_state) BITCOINKERNEL_ARG_NONNULL(1, 2);


BITCOINKERNEL_API void btck_transaction_destroy(btck_Transaction* transaction);


BITCOINKERNEL_API btck_PrecomputedTransactionData* BITCOINKERNEL_WARN_UNUSED_RESULT btck_precomputed_transaction_data_create(

    const btck_Transaction* tx_to,

    const btck_TransactionOutput** spent_outputs, size_t spent_outputs_len) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API btck_PrecomputedTransactionData* BITCOINKERNEL_WARN_UNUSED_RESULT btck_precomputed_transaction_data_copy(

    const btck_PrecomputedTransactionData* precomputed_txdata) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API void btck_precomputed_transaction_data_destroy(btck_PrecomputedTransactionData* precomputed_txdata);


BITCOINKERNEL_API btck_ScriptPubkey* BITCOINKERNEL_WARN_UNUSED_RESULT btck_script_pubkey_create(

    const void* script_pubkey, size_t script_pubkey_len);


BITCOINKERNEL_API btck_ScriptPubkey* BITCOINKERNEL_WARN_UNUSED_RESULT btck_script_pubkey_copy(

    const btck_ScriptPubkey* script_pubkey) BITCOINKERNEL_ARG_NONNULL(1);


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_PrecomputedTransactionData* precomputed_txdata,

    unsigned int input_index,

    btck_ScriptVerificationFlags flags,

    btck_ScriptVerifyStatus* status) BITCOINKERNEL_ARG_NONNULL(1, 3);


BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_script_pubkey_to_bytes(

    const btck_ScriptPubkey* script_pubkey,

    btck_WriteBytes writer,

    void* user_data) BITCOINKERNEL_ARG_NONNULL(1, 2);


BITCOINKERNEL_API void btck_script_pubkey_destroy(btck_ScriptPubkey* script_pubkey);


BITCOINKERNEL_API btck_TransactionOutput* BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_output_create(

    const btck_ScriptPubkey* script_pubkey,

    int64_t amount) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API const btck_ScriptPubkey* btck_transaction_output_get_script_pubkey(

    const btck_TransactionOutput* transaction_output) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API int64_t btck_transaction_output_get_amount(

    const btck_TransactionOutput* transaction_output) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API btck_TransactionOutput* BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_output_copy(

    const btck_TransactionOutput* transaction_output) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API void btck_transaction_output_destroy(btck_TransactionOutput* transaction_output);


BITCOINKERNEL_API void btck_logging_set_min_level(btck_LogLevel level);


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);


BITCOINKERNEL_API void btck_logging_connection_destroy(btck_LoggingConnection* logging_connection);


BITCOINKERNEL_API btck_ChainParameters* BITCOINKERNEL_WARN_UNUSED_RESULT btck_chain_parameters_create(

    btck_ChainType chain_type);


BITCOINKERNEL_API btck_ChainParameters* BITCOINKERNEL_WARN_UNUSED_RESULT btck_chain_parameters_create_signet(

    const void* challenge, size_t challenge_len);


BITCOINKERNEL_API btck_ChainParameters* BITCOINKERNEL_WARN_UNUSED_RESULT btck_chain_parameters_copy(

    const btck_ChainParameters* chain_parameters) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API const btck_ConsensusParams* btck_chain_parameters_get_consensus_params(

    const btck_ChainParameters* chain_parameters) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API void btck_chain_parameters_destroy(btck_ChainParameters* chain_parameters);


BITCOINKERNEL_API btck_ContextOptions* BITCOINKERNEL_WARN_UNUSED_RESULT btck_context_options_create();


BITCOINKERNEL_API void btck_context_options_set_chainparams(

    btck_ContextOptions* context_options,

    const btck_ChainParameters* chain_parameters) BITCOINKERNEL_ARG_NONNULL(1, 2);


BITCOINKERNEL_API void btck_context_options_set_notifications(

    btck_ContextOptions* context_options,

    btck_NotificationInterfaceCallbacks notifications) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API void btck_context_options_set_validation_interface(

    btck_ContextOptions* context_options,

    btck_ValidationInterfaceCallbacks validation_interface_callbacks) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API void btck_context_options_destroy(btck_ContextOptions* context_options);


BITCOINKERNEL_API btck_Context* BITCOINKERNEL_WARN_UNUSED_RESULT btck_context_create(

    const btck_ContextOptions* context_options);


BITCOINKERNEL_API btck_Context* BITCOINKERNEL_WARN_UNUSED_RESULT btck_context_copy(

    const btck_Context* context) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_context_interrupt(

    btck_Context* context) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API void btck_context_destroy(btck_Context* context);


BITCOINKERNEL_API const btck_BlockTreeEntry* btck_block_tree_entry_get_previous(

    const btck_BlockTreeEntry* block_tree_entry) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API btck_BlockHeader* BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_tree_entry_get_block_header(

    const btck_BlockTreeEntry* block_tree_entry) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API int32_t btck_block_tree_entry_get_height(

    const btck_BlockTreeEntry* block_tree_entry) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API const btck_BlockHash* btck_block_tree_entry_get_block_hash(

    const btck_BlockTreeEntry* block_tree_entry) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API int btck_block_tree_entry_equals(

    const btck_BlockTreeEntry* entry1, const btck_BlockTreeEntry* entry2) BITCOINKERNEL_ARG_NONNULL(1, 2);


BITCOINKERNEL_API const btck_BlockTreeEntry* btck_block_tree_entry_get_ancestor(

    const btck_BlockTreeEntry* block_tree_entry,

    int32_t height) BITCOINKERNEL_ARG_NONNULL(1);


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);


BITCOINKERNEL_API void btck_chainstate_manager_options_set_worker_threads_num(

    btck_ChainstateManagerOptions* chainstate_manager_options,

    int worker_threads) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_chainstate_manager_options_set_database_cache_bytes(

    btck_ChainstateManagerOptions* chainstate_manager_options,

    uint64_t database_cache_bytes) BITCOINKERNEL_ARG_NONNULL(1);


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);


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);


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);


BITCOINKERNEL_API void btck_chainstate_manager_options_destroy(btck_ChainstateManagerOptions* chainstate_manager_options);


BITCOINKERNEL_API btck_ChainstateManager* BITCOINKERNEL_WARN_UNUSED_RESULT btck_chainstate_manager_create(

    const btck_ChainstateManagerOptions* chainstate_manager_options) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API const btck_BlockTreeEntry* btck_chainstate_manager_get_best_entry(

    const btck_ChainstateManager* chainstate_manager) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API btck_BlockValidationState* BITCOINKERNEL_WARN_UNUSED_RESULT btck_chainstate_manager_process_block_header(

    btck_ChainstateManager* chainstate_manager,

    const btck_BlockHeader* header) BITCOINKERNEL_ARG_NONNULL(1, 2);


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);


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, 2, 3);


BITCOINKERNEL_API const btck_Chain* btck_chainstate_manager_get_active_chain(

    const btck_ChainstateManager* chainstate_manager) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API const btck_BlockTreeEntry* btck_chainstate_manager_get_block_tree_entry_by_hash(

    const btck_ChainstateManager* chainstate_manager,

    const btck_BlockHash* block_hash) BITCOINKERNEL_ARG_NONNULL(1, 2);


BITCOINKERNEL_API void btck_chainstate_manager_destroy(btck_ChainstateManager* chainstate_manager);


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, 2);


BITCOINKERNEL_API btck_Block* BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_create(

    const void* raw_block, size_t raw_block_len);


BITCOINKERNEL_API btck_Block* BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_copy(

    const btck_Block* block) BITCOINKERNEL_ARG_NONNULL(1);


typedef uint32_t btck_BlockCheckFlags;

#define btck_BlockCheckFlags_BASE   ((btck_BlockCheckFlags)0)

#define btck_BlockCheckFlags_POW    ((btck_BlockCheckFlags)(1U << 0))

#define btck_BlockCheckFlags_MERKLE ((btck_BlockCheckFlags)(1U << 1))

#define btck_BlockCheckFlags_ALL    ((btck_BlockCheckFlags)(btck_BlockCheckFlags_POW | btck_BlockCheckFlags_MERKLE))


BITCOINKERNEL_API int btck_block_check(

    const btck_Block* block,

    const btck_ConsensusParams* consensus_params,

    btck_BlockCheckFlags flags,

    btck_BlockValidationState* validation_state) BITCOINKERNEL_ARG_NONNULL(1, 2, 4);


BITCOINKERNEL_API size_t btck_block_count_transactions(

    const btck_Block* block) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API const btck_Transaction* btck_block_get_transaction_at(

    const btck_Block* block, size_t transaction_index) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API btck_BlockHeader* BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_get_header(

    const btck_Block* block) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API btck_BlockHash* BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_get_hash(

    const btck_Block* block) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_to_bytes(

    const btck_Block* block,

    btck_WriteBytes writer,

    void* user_data) BITCOINKERNEL_ARG_NONNULL(1, 2);


BITCOINKERNEL_API void btck_block_destroy(btck_Block* block);


BITCOINKERNEL_API btck_BlockValidationState* BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_validation_state_create();


BITCOINKERNEL_API btck_ValidationMode btck_block_validation_state_get_validation_mode(

    const btck_BlockValidationState* block_validation_state) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API btck_BlockValidationResult btck_block_validation_state_get_block_validation_result(

    const btck_BlockValidationState* block_validation_state) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API btck_BlockValidationState* BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_validation_state_copy(

    const btck_BlockValidationState* block_validation_state) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API void btck_block_validation_state_destroy(

    btck_BlockValidationState* block_validation_state);


BITCOINKERNEL_API int32_t btck_chain_get_height(

    const btck_Chain* chain) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API const btck_BlockTreeEntry* btck_chain_get_by_height(

    const btck_Chain* chain,

    int32_t block_height) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API int btck_chain_contains(

    const btck_Chain* chain,

    const btck_BlockTreeEntry* block_tree_entry) BITCOINKERNEL_ARG_NONNULL(1, 2);


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, 2);


BITCOINKERNEL_API btck_BlockSpentOutputs* BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_spent_outputs_copy(

    const btck_BlockSpentOutputs* block_spent_outputs) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API size_t btck_block_spent_outputs_count(

    const btck_BlockSpentOutputs* block_spent_outputs) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API const btck_TransactionSpentOutputs* 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);


BITCOINKERNEL_API void btck_block_spent_outputs_destroy(btck_BlockSpentOutputs* block_spent_outputs);


BITCOINKERNEL_API btck_TransactionSpentOutputs* BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_spent_outputs_copy(

    const btck_TransactionSpentOutputs* transaction_spent_outputs) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API size_t btck_transaction_spent_outputs_count(

    const btck_TransactionSpentOutputs* transaction_spent_outputs) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API const btck_Coin* btck_transaction_spent_outputs_get_coin_at(

    const btck_TransactionSpentOutputs* transaction_spent_outputs,

    size_t coin_index) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API void btck_transaction_spent_outputs_destroy(btck_TransactionSpentOutputs* transaction_spent_outputs);


BITCOINKERNEL_API btck_TransactionInput* BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_input_copy(

    const btck_TransactionInput* transaction_input) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API const btck_TransactionOutPoint* btck_transaction_input_get_out_point(

    const btck_TransactionInput* transaction_input) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API uint32_t btck_transaction_input_get_sequence(

    const btck_TransactionInput* transaction_input) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API const btck_WitnessStack* btck_transaction_input_get_witness_stack(

    const btck_TransactionInput* transaction_input) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_input_get_script_sig(

    const btck_TransactionInput* transaction_input,

    btck_WriteBytes writer,

    void* user_data) BITCOINKERNEL_ARG_NONNULL(1, 2);


BITCOINKERNEL_API void btck_transaction_input_destroy(btck_TransactionInput* transaction_input);


BITCOINKERNEL_API size_t btck_witness_stack_count_items(

    const btck_WitnessStack* witness_stack) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_witness_stack_get_item_at(

    const btck_WitnessStack* witness_stack,

    size_t index,

    btck_WriteBytes writer,

    void* user_data) BITCOINKERNEL_ARG_NONNULL(1, 3);


BITCOINKERNEL_API btck_WitnessStack* BITCOINKERNEL_WARN_UNUSED_RESULT btck_witness_stack_copy(

    const btck_WitnessStack* witness_stack) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API void btck_witness_stack_destroy(btck_WitnessStack* witness_stack);


BITCOINKERNEL_API btck_TransactionOutPoint* BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_out_point_copy(

    const btck_TransactionOutPoint* transaction_out_point) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API uint32_t btck_transaction_out_point_get_index(

    const btck_TransactionOutPoint* transaction_out_point) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API const btck_Txid* btck_transaction_out_point_get_txid(

    const btck_TransactionOutPoint* transaction_out_point) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API void btck_transaction_out_point_destroy(btck_TransactionOutPoint* transaction_out_point);


BITCOINKERNEL_API btck_Txid* BITCOINKERNEL_WARN_UNUSED_RESULT btck_txid_copy(

    const btck_Txid* txid) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API int btck_txid_equals(

    const btck_Txid* txid1, const btck_Txid* txid2) BITCOINKERNEL_ARG_NONNULL(1, 2);


BITCOINKERNEL_API void btck_txid_to_bytes(

    const btck_Txid* txid, unsigned char output[32]) BITCOINKERNEL_ARG_NONNULL(1, 2);


BITCOINKERNEL_API void btck_txid_destroy(btck_Txid* txid);


BITCOINKERNEL_API btck_Wtxid* BITCOINKERNEL_WARN_UNUSED_RESULT btck_wtxid_copy(

    const btck_Wtxid* wtxid) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API int btck_wtxid_equals(

    const btck_Wtxid* wtxid1, const btck_Wtxid* wtxid2) BITCOINKERNEL_ARG_NONNULL(1, 2);


BITCOINKERNEL_API void btck_wtxid_to_bytes(

    const btck_Wtxid* wtxid, unsigned char output[32]) BITCOINKERNEL_ARG_NONNULL(1, 2);


BITCOINKERNEL_API void btck_wtxid_destroy(btck_Wtxid* wtxid);


BITCOINKERNEL_API btck_Coin* BITCOINKERNEL_WARN_UNUSED_RESULT btck_coin_copy(

    const btck_Coin* coin) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API uint32_t btck_coin_confirmation_height(

    const btck_Coin* coin) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API int btck_coin_is_coinbase(

    const btck_Coin* coin) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API const btck_TransactionOutput* btck_coin_get_output(

    const btck_Coin* coin) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API void btck_coin_destroy(btck_Coin* coin);


BITCOINKERNEL_API btck_BlockHash* BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_hash_create(

    const unsigned char block_hash[32]) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API int btck_block_hash_equals(

    const btck_BlockHash* hash1, const btck_BlockHash* hash2) BITCOINKERNEL_ARG_NONNULL(1, 2);


BITCOINKERNEL_API btck_BlockHash* BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_hash_copy(

    const btck_BlockHash* block_hash) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API void btck_block_hash_to_bytes(

    const btck_BlockHash* block_hash, unsigned char output[32]) BITCOINKERNEL_ARG_NONNULL(1, 2);


BITCOINKERNEL_API void btck_block_hash_destroy(btck_BlockHash* block_hash);


BITCOINKERNEL_API btck_BlockHeader* BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_header_create(

    const void* raw_block_header, size_t raw_block_header_len) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API btck_BlockHeader* BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_header_copy(

    const btck_BlockHeader* header) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API btck_BlockHash* BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_header_get_hash(

    const btck_BlockHeader* header) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API const btck_BlockHash* btck_block_header_get_prev_hash(

    const btck_BlockHeader* header) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API void btck_block_header_get_merkle_root(

    const btck_BlockHeader* header, unsigned char output[32]) BITCOINKERNEL_ARG_NONNULL(1, 2);


BITCOINKERNEL_API uint32_t btck_block_header_get_timestamp(

    const btck_BlockHeader* header) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API uint32_t btck_block_header_get_bits(

    const btck_BlockHeader* header) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API int32_t btck_block_header_get_version(

    const btck_BlockHeader* header) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API uint32_t btck_block_header_get_nonce(

    const btck_BlockHeader* header) BITCOINKERNEL_ARG_NONNULL(1);


BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_header_to_bytes(

    const btck_BlockHeader* header, unsigned char output[80]) BITCOINKERNEL_ARG_NONNULL(1, 2);


BITCOINKERNEL_API void btck_block_header_destroy(btck_BlockHeader* header);


BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_set_mock_time(int64_t timestamp);


#ifdef __cplusplus

} // extern "C"

#endif // __cplusplus


#endif // BITCOIN_KERNEL_BITCOINKERNEL_H

flags
int flags
Definition: bitcoin-tx.cpp:531

BITCOINKERNEL_API
#define BITCOINKERNEL_API
Definition: bitcoinkernel.h:27

btck_transaction_input_copy
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.
Definition: bitcoinkernel.cpp:851

btck_transaction_out_point_get_txid
BITCOINKERNEL_API const btck_Txid * btck_transaction_out_point_get_txid(const btck_TransactionOutPoint *transaction_out_point) BITCOINKERNEL_ARG_NONNULL(1)
Get the txid from the transaction out point.
Definition: bitcoinkernel.cpp:914

btck_transaction_out_point_get_index
BITCOINKERNEL_API uint32_t 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.
Definition: bitcoinkernel.cpp:909

btck_block_check
BITCOINKERNEL_API int btck_block_check(const btck_Block *block, const btck_ConsensusParams *consensus_params, btck_BlockCheckFlags flags, btck_BlockValidationState *validation_state) BITCOINKERNEL_ARG_NONNULL(1
Perform context-free validation checks on a btck_Block.

btck_block_header_destroy
BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT BITCOINKERNEL_API void btck_block_header_destroy(btck_BlockHeader *header)
Destroy the btck_BlockHeader.
Definition: bitcoinkernel.cpp:1689

btck_block_get_transaction_at
BITCOINKERNEL_API const btck_Transaction * btck_block_get_transaction_at(const btck_Block *block, size_t transaction_index) BITCOINKERNEL_ARG_NONNULL(1)
Get the transaction at the provided index.
Definition: bitcoinkernel.cpp:1399

btck_LogLevel
uint8_t btck_LogLevel
The severity of a log statement.
Definition: bitcoinkernel.h:377

btck_block_hash_copy
BITCOINKERNEL_API int 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.
Definition: bitcoinkernel.cpp:1467

btck_transaction_output_copy
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.
Definition: bitcoinkernel.cpp:758

btck_coin_get_output
BITCOINKERNEL_API const btck_TransactionOutput * btck_coin_get_output(const btck_Coin *coin) BITCOINKERNEL_ARG_NONNULL(1)
Return the transaction output of a coin.
Definition: bitcoinkernel.cpp:1560

btck_logging_connection_destroy
BITCOINKERNEL_API void btck_logging_connection_destroy(btck_LoggingConnection *logging_connection)
Stop logging and destroy the logging connection.
Definition: bitcoinkernel.cpp:1015

btck_block_header_copy
BITCOINKERNEL_API btck_BlockHeader *BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_header_copy(const btck_BlockHeader *header) BITCOINKERNEL_ARG_NONNULL(1)
Copy a btck_BlockHeader.
Definition: bitcoinkernel.cpp:1639

btck_block_header_to_bytes
BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_header_to_bytes(const btck_BlockHeader *header, unsigned char output[80]) BITCOINKERNEL_ARG_NONNULL(1
Serializes the btck_BlockHeader to bytes.

btck_block_validation_state_create
BITCOINKERNEL_API btck_BlockValidationState *BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_validation_state_create()
Create a new btck_BlockValidationState.
Definition: bitcoinkernel.cpp:1143

btck_set_mock_time
BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_set_mock_time(int64_t timestamp)
Override the current time with a fixed timestamp for testing.
Definition: bitcoinkernel.cpp:1740

btck_witness_stack_copy
BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT BITCOINKERNEL_API btck_WitnessStack *BITCOINKERNEL_WARN_UNUSED_RESULT btck_witness_stack_copy(const btck_WitnessStack *witness_stack) BITCOINKERNEL_ARG_NONNULL(1)
Copy a witness stack.
Definition: bitcoinkernel.cpp:894

btck_WriteBytes
int(* btck_WriteBytes)(const void *bytes, size_t size, void *userdata)
Function signature for serializing data.
Definition: bitcoinkernel.h:473

btck_chainstate_manager_options_set_database_cache_bytes
BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_chainstate_manager_options_set_database_cache_bytes(btck_ChainstateManagerOptions *chainstate_manager_options, uint64_t database_cache_bytes) BITCOINKERNEL_ARG_NONNULL(1)
Set the total database cache used by the chainstate manager.
Definition: bitcoinkernel.cpp:1218

btck_context_interrupt
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,...
Definition: bitcoinkernel.cpp:1116

btck_block_hash_equals
BITCOINKERNEL_API int btck_block_hash_equals(const btck_BlockHash *hash1, const btck_BlockHash *hash2) BITCOINKERNEL_ARG_NONNULL(1
Check if two block hashes are equal.

BITCOINKERNEL_WARN_UNUSED_RESULT
#define BITCOINKERNEL_WARN_UNUSED_RESULT
BITCOINKERNEL_WARN_UNUSED_RESULT is a compiler attribute used to indicate that ignoring a function's ...
Definition: bitcoinkernel.h:44

btck_transaction_to_bytes
BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT 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.

btck_TxValidationResult
uint32_t btck_TxValidationResult
Indicates the reason why a transaction failed validation.
Definition: bitcoinkernel.h:502

btck_block_spent_outputs_get_transaction_spent_outputs_at
BITCOINKERNEL_API const btck_TransactionSpentOutputs * 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.
Definition: bitcoinkernel.cpp:1511

btck_block_to_bytes
BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT 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.

btck_block_header_create
BITCOINKERNEL_API btck_BlockHeader *BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_header_create(const void *raw_block_header, size_t raw_block_header_len) BITCOINKERNEL_ARG_NONNULL(1)
Create a btck_BlockHeader from serialized data.
Definition: bitcoinkernel.cpp:1623

btck_txid_equals
BITCOINKERNEL_API int btck_txid_equals(const btck_Txid *txid1, const btck_Txid *txid2) BITCOINKERNEL_ARG_NONNULL(1
Check if two txids are equal.

btck_ChainType
uint8_t btck_ChainType
Definition: bitcoinkernel.h:590

btck_coin_confirmation_height
BITCOINKERNEL_API uint32_t 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.
Definition: bitcoinkernel.cpp:1550

btck_transaction_get_wtxid
BITCOINKERNEL_API const btck_Wtxid * btck_transaction_get_wtxid(const btck_Transaction *transaction) BITCOINKERNEL_ARG_NONNULL(1)
Get the wtxid of a transaction.
Definition: bitcoinkernel.cpp:704

btck_chain_parameters_get_consensus_params
BITCOINKERNEL_API const btck_ConsensusParams * btck_chain_parameters_get_consensus_params(const btck_ChainParameters *chain_parameters) BITCOINKERNEL_ARG_NONNULL(1)
Get btck_ConsensusParams from btck_ChainParameters.
Definition: bitcoinkernel.cpp:1059

btck_block_tree_entry_get_ancestor
BITCOINKERNEL_API int BITCOINKERNEL_API const btck_BlockTreeEntry * btck_block_tree_entry_get_ancestor(const btck_BlockTreeEntry *block_tree_entry, int32_t height) BITCOINKERNEL_ARG_NONNULL(1)
Return the ancestor of a btck_BlockTreeEntry at the given height.
Definition: bitcoinkernel.cpp:1136

btck_ValidationInterfaceBlockChecked
void(* btck_ValidationInterfaceBlockChecked)(void *user_data, btck_Block *block, const btck_BlockValidationState *state)
Function signatures for the validation interface.
Definition: bitcoinkernel.h:459

btck_chain_parameters_create
BITCOINKERNEL_API btck_ChainParameters *BITCOINKERNEL_WARN_UNUSED_RESULT btck_chain_parameters_create(btck_ChainType chain_type)
Creates a chain parameters struct with default parameters based on the passed in chain type.
Definition: bitcoinkernel.cpp:1022

btck_transaction_get_txid
BITCOINKERNEL_API const btck_Txid * btck_transaction_get_txid(const btck_Transaction *transaction) BITCOINKERNEL_ARG_NONNULL(1)
Get the txid of a transaction.
Definition: bitcoinkernel.cpp:694

btck_context_create
BITCOINKERNEL_API btck_Context *BITCOINKERNEL_WARN_UNUSED_RESULT btck_context_create(const btck_ContextOptions *context_options)
Create a new kernel context.
Definition: bitcoinkernel.cpp:1099

btck_block_spent_outputs_copy
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.
Definition: bitcoinkernel.cpp:1501

btck_BlockValidationResult
uint32_t btck_BlockValidationResult
A granular "reason" why a block was invalid.
Definition: bitcoinkernel.h:487

btck_transaction_spent_outputs_get_coin_at
BITCOINKERNEL_API const btck_Coin * 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.
Definition: bitcoinkernel.cpp:1538

btck_txid_destroy
BITCOINKERNEL_API int BITCOINKERNEL_API void BITCOINKERNEL_API void btck_txid_destroy(btck_Txid *txid)
Destroy the txid.
Definition: bitcoinkernel.cpp:939

btck_transaction_get_output_at
BITCOINKERNEL_API const btck_TransactionOutput * 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.
Definition: bitcoinkernel.cpp:666

btck_transaction_get_input_at
BITCOINKERNEL_API const btck_TransactionInput * 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.
Definition: bitcoinkernel.cpp:678

btck_ValidationMode
uint8_t btck_ValidationMode
Whether a validated data structure is valid, invalid, or an error was encountered during processing.
Definition: bitcoinkernel.h:479

btck_witness_stack_destroy
BITCOINKERNEL_API void btck_witness_stack_destroy(btck_WitnessStack *witness_stack)
Destroy the witness stack.
Definition: bitcoinkernel.cpp:899

btck_block_create
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)
Parse a serialized raw block into a new block object.
Definition: bitcoinkernel.cpp:1359

btck_chainstate_manager_get_best_entry
BITCOINKERNEL_API const btck_BlockTreeEntry * btck_chainstate_manager_get_best_entry(const btck_ChainstateManager *chainstate_manager) BITCOINKERNEL_ARG_NONNULL(1)
Get the btck_BlockTreeEntry whose associated btck_BlockHeader has the most known cumulative proof of ...
Definition: bitcoinkernel.cpp:1318

btck_LogCallback
void(* btck_LogCallback)(void *user_data, const btck_LogEntry *entry)
Callback function types.
Definition: bitcoinkernel.h:438

btck_ValidationInterfacePoWValidBlock
void(* btck_ValidationInterfacePoWValidBlock)(void *user_data, btck_Block *block, const btck_BlockTreeEntry *entry)
Definition: bitcoinkernel.h:460

btck_block_validation_state_get_block_validation_result
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 btck_BlockValidationState pointer.
Definition: bitcoinkernel.cpp:1166

btck_chainstate_manager_get_active_chain
BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT BITCOINKERNEL_API const btck_Chain * btck_chainstate_manager_get_active_chain(const btck_ChainstateManager *chainstate_manager) BITCOINKERNEL_ARG_NONNULL(1)
Returns the best known currently active chain.
Definition: bitcoinkernel.cpp:1600

btck_transaction_get_version
BITCOINKERNEL_API uint32_t btck_transaction_get_version(const btck_Transaction *transaction) BITCOINKERNEL_ARG_NONNULL(1)
Get a transaction's version.
Definition: bitcoinkernel.cpp:684

btck_block_header_get_prev_hash
BITCOINKERNEL_API const btck_BlockHash * btck_block_header_get_prev_hash(const btck_BlockHeader *header) BITCOINKERNEL_ARG_NONNULL(1)
Get the previous btck_BlockHash from btck_BlockHeader.
Definition: bitcoinkernel.cpp:1649

btck_SynchronizationState
uint8_t btck_SynchronizationState
Current sync state passed to tip changed callbacks.
Definition: bitcoinkernel.h:346

btck_context_options_destroy
BITCOINKERNEL_API void btck_context_options_destroy(btck_ContextOptions *context_options)
Destroy the context options.
Definition: bitcoinkernel.cpp:1094

btck_NotifyProgress
void(* btck_NotifyProgress)(void *user_data, const char *title, size_t title_len, int progress_percent, int resume_possible)
Definition: bitcoinkernel.h:450

btck_NotifyWarningUnset
void(* btck_NotifyWarningUnset)(void *user_data, btck_Warning warning)
Definition: bitcoinkernel.h:452

btck_block_copy
BITCOINKERNEL_API btck_Block *BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_copy(const btck_Block *block) BITCOINKERNEL_ARG_NONNULL(1)
Copy a block.
Definition: bitcoinkernel.cpp:1376

btck_ValidationInterfaceBlockDisconnected
void(* btck_ValidationInterfaceBlockDisconnected)(void *user_data, btck_Block *block, const btck_BlockTreeEntry *entry)
Definition: bitcoinkernel.h:462

btck_chainstate_manager_get_block_tree_entry_by_hash
BITCOINKERNEL_API const btck_BlockTreeEntry * 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.

btck_transaction_input_get_out_point
BITCOINKERNEL_API const btck_TransactionOutPoint * btck_transaction_input_get_out_point(const btck_TransactionInput *transaction_input) BITCOINKERNEL_ARG_NONNULL(1)
Get the transaction out point.
Definition: bitcoinkernel.cpp:856

btck_chainstate_manager_options_update_chainstate_db_in_memory
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.
Definition: bitcoinkernel.cpp:1259

btck_chainstate_manager_options_destroy
BITCOINKERNEL_API void btck_chainstate_manager_options_destroy(btck_ChainstateManagerOptions *chainstate_manager_options)
Destroy the chainstate manager options.
Definition: bitcoinkernel.cpp:1232

btck_block_header_get_hash
BITCOINKERNEL_API btck_BlockHash *BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_header_get_hash(const btck_BlockHeader *header) BITCOINKERNEL_ARG_NONNULL(1)
Get the btck_BlockHash.
Definition: bitcoinkernel.cpp:1644

btck_chainstate_manager_options_set_wipe_dbs
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.
Definition: bitcoinkernel.cpp:1237

btck_wtxid_copy
BITCOINKERNEL_API btck_Wtxid *BITCOINKERNEL_WARN_UNUSED_RESULT btck_wtxid_copy(const btck_Wtxid *wtxid) BITCOINKERNEL_ARG_NONNULL(1)
Copy a wtxid.
Definition: bitcoinkernel.cpp:944

btck_context_options_create
BITCOINKERNEL_API btck_ContextOptions *BITCOINKERNEL_WARN_UNUSED_RESULT btck_context_options_create()
Creates an empty context options.
Definition: bitcoinkernel.cpp:1069

BITCOINKERNEL_ARG_NONNULL
#define BITCOINKERNEL_ARG_NONNULL(...)
BITCOINKERNEL_ARG_NONNULL is a compiler attribute used to indicate that certain pointer arguments to ...
Definition: bitcoinkernel.h:60

btck_DestroyCallback
void(* btck_DestroyCallback)(void *user_data)
Function signature for freeing user data.
Definition: bitcoinkernel.h:443

btck_precomputed_transaction_data_destroy
BITCOINKERNEL_API void btck_precomputed_transaction_data_destroy(btck_PrecomputedTransactionData *precomputed_txdata)
Destroy the precomputed transaction data.
Definition: bitcoinkernel.cpp:809

btck_coin_is_coinbase
BITCOINKERNEL_API int btck_coin_is_coinbase(const btck_Coin *coin) BITCOINKERNEL_ARG_NONNULL(1)
Returns whether the containing transaction was a coinbase.
Definition: bitcoinkernel.cpp:1555

btck_transaction_input_destroy
BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT BITCOINKERNEL_API void btck_transaction_input_destroy(btck_TransactionInput *transaction_input)
Destroy the transaction input.
Definition: bitcoinkernel.cpp:877

btck_witness_stack_get_item_at
BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_witness_stack_get_item_at(const btck_WitnessStack *witness_stack, size_t index, btck_WriteBytes writer, void *user_data) BITCOINKERNEL_ARG_NONNULL(1
Serialize a witness stack item at a given index through the passed in callback.

btck_ScriptVerificationFlags
uint32_t btck_ScriptVerificationFlags
Script verification flags that may be composed with each other.
Definition: bitcoinkernel.h:573

btck_transaction_spent_outputs_copy
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.
Definition: bitcoinkernel.cpp:1523

btck_transaction_get_locktime
BITCOINKERNEL_API uint32_t btck_transaction_get_locktime(const btck_Transaction *transaction) BITCOINKERNEL_ARG_NONNULL(1)
Get a transaction's nLockTime value.
Definition: bitcoinkernel.cpp:689

btck_context_copy
BITCOINKERNEL_API btck_Context *BITCOINKERNEL_WARN_UNUSED_RESULT btck_context_copy(const btck_Context *context) BITCOINKERNEL_ARG_NONNULL(1)
Copy the context.
Definition: bitcoinkernel.cpp:1111

btck_chainstate_manager_process_block
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.

btck_transaction_output_get_amount
BITCOINKERNEL_API int64_t btck_transaction_output_get_amount(const btck_TransactionOutput *transaction_output) BITCOINKERNEL_ARG_NONNULL(1)
Get the amount in the output.
Definition: bitcoinkernel.cpp:768

btck_script_pubkey_verify
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_PrecomputedTransactionData *precomputed_txdata, unsigned int input_index, btck_ScriptVerificationFlags 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 ...

btck_precomputed_transaction_data_create
BITCOINKERNEL_API btck_PrecomputedTransactionData *BITCOINKERNEL_WARN_UNUSED_RESULT btck_precomputed_transaction_data_create(const btck_Transaction *tx_to, const btck_TransactionOutput **spent_outputs, size_t spent_outputs_len) BITCOINKERNEL_ARG_NONNULL(1)
Create precomputed transaction data for script verification.
Definition: bitcoinkernel.cpp:778

btck_transaction_create
BITCOINKERNEL_API btck_Transaction *BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_create(const void *raw_transaction, size_t raw_transaction_len)
Create a new transaction from the serialized data.
Definition: bitcoinkernel.cpp:650

btck_chainstate_manager_options_set_worker_threads_num
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.
Definition: bitcoinkernel.cpp:1212

btck_txid_copy
BITCOINKERNEL_API btck_Txid *BITCOINKERNEL_WARN_UNUSED_RESULT btck_txid_copy(const btck_Txid *txid) BITCOINKERNEL_ARG_NONNULL(1)
Copy a txid.
Definition: bitcoinkernel.cpp:924

btck_chainstate_manager_destroy
BITCOINKERNEL_API const btck_BlockTreeEntry BITCOINKERNEL_API void btck_chainstate_manager_destroy(btck_ChainstateManager *chainstate_manager)
Destroy the chainstate manager.
Definition: bitcoinkernel.cpp:1324

btck_script_pubkey_create
BITCOINKERNEL_API btck_ScriptPubkey *BITCOINKERNEL_WARN_UNUSED_RESULT btck_script_pubkey_create(const void *script_pubkey, size_t script_pubkey_len)
Create a script pubkey from serialized data.
Definition: bitcoinkernel.cpp:730

btck_block_count_transactions
BITCOINKERNEL_API int BITCOINKERNEL_API size_t btck_block_count_transactions(const btck_Block *block) BITCOINKERNEL_ARG_NONNULL(1)
Count the number of transactions contained in a block.
Definition: bitcoinkernel.cpp:1394

btck_chain_get_height
BITCOINKERNEL_API int32_t btck_chain_get_height(const btck_Chain *chain) BITCOINKERNEL_ARG_NONNULL(1)
Return the height of the tip of the chain.
Definition: bitcoinkernel.cpp:1605

btck_coin_copy
BITCOINKERNEL_API btck_Coin *BITCOINKERNEL_WARN_UNUSED_RESULT btck_coin_copy(const btck_Coin *coin) BITCOINKERNEL_ARG_NONNULL(1)
Copy a coin.
Definition: bitcoinkernel.cpp:1545

btck_script_pubkey_to_bytes
BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT 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.

btck_block_validation_state_destroy
BITCOINKERNEL_API void btck_block_validation_state_destroy(btck_BlockValidationState *block_validation_state)
Destroy the btck_BlockValidationState.
Definition: bitcoinkernel.cpp:1153

btck_wtxid_destroy
BITCOINKERNEL_API int BITCOINKERNEL_API void BITCOINKERNEL_API void btck_wtxid_destroy(btck_Wtxid *wtxid)
Destroy the wtxid.
Definition: bitcoinkernel.cpp:959

btck_chainstate_manager_create
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.
Definition: bitcoinkernel.cpp:1268

btck_transaction_input_get_sequence
BITCOINKERNEL_API uint32_t btck_transaction_input_get_sequence(const btck_TransactionInput *transaction_input) BITCOINKERNEL_ARG_NONNULL(1)
Get a transaction input's nSequence value.
Definition: bitcoinkernel.cpp:861

btck_precomputed_transaction_data_copy
BITCOINKERNEL_API btck_PrecomputedTransactionData *BITCOINKERNEL_WARN_UNUSED_RESULT btck_precomputed_transaction_data_copy(const btck_PrecomputedTransactionData *precomputed_txdata) BITCOINKERNEL_ARG_NONNULL(1)
Copy precomputed transaction data.
Definition: bitcoinkernel.cpp:804

btck_transaction_output_destroy
BITCOINKERNEL_API void btck_transaction_output_destroy(btck_TransactionOutput *transaction_output)
Destroy the transaction output.
Definition: bitcoinkernel.cpp:773

btck_tx_validation_state_create
BITCOINKERNEL_API btck_TxValidationState *BITCOINKERNEL_WARN_UNUSED_RESULT btck_tx_validation_state_create()
Create a new btck_TxValidationState.
Definition: bitcoinkernel.cpp:1702

btck_chain_contains
BITCOINKERNEL_API int 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.

btck_transaction_output_create
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.
Definition: bitcoinkernel.cpp:753

btck_block_header_get_nonce
BITCOINKERNEL_API uint32_t btck_block_header_get_nonce(const btck_BlockHeader *header) BITCOINKERNEL_ARG_NONNULL(1)
Get the nonce from btck_BlockHeader.
Definition: bitcoinkernel.cpp:1674

btck_block_get_header
BITCOINKERNEL_API btck_BlockHeader *BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_get_header(const btck_Block *block) BITCOINKERNEL_ARG_NONNULL(1)
Get the btck_BlockHeader from the block.
Definition: bitcoinkernel.cpp:1405

btck_block_tree_entry_get_block_hash
BITCOINKERNEL_API const btck_BlockHash * 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.
Definition: bitcoinkernel.cpp:1452

btck_block_spent_outputs_read
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.

btck_transaction_output_get_script_pubkey
BITCOINKERNEL_API const btck_ScriptPubkey * btck_transaction_output_get_script_pubkey(const btck_TransactionOutput *transaction_output) BITCOINKERNEL_ARG_NONNULL(1)
Get the script pubkey of the output.
Definition: bitcoinkernel.cpp:763

btck_ScriptVerifyStatus
uint8_t btck_ScriptVerifyStatus
A collection of status codes that may be issued by the script verify function.
Definition: bitcoinkernel.h:565

btck_block_tree_entry_get_height
BITCOINKERNEL_API int32_t 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.
Definition: bitcoinkernel.cpp:1447

btck_block_header_get_timestamp
BITCOINKERNEL_API void BITCOINKERNEL_API uint32_t btck_block_header_get_timestamp(const btck_BlockHeader *header) BITCOINKERNEL_ARG_NONNULL(1)
Get the timestamp from btck_BlockHeader.
Definition: bitcoinkernel.cpp:1659

btck_logging_set_min_level
BITCOINKERNEL_API void btck_logging_set_min_level(btck_LogLevel level)
Set the minimum log level.
Definition: bitcoinkernel.cpp:996

btck_block_read
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.

btck_transaction_out_point_destroy
BITCOINKERNEL_API void btck_transaction_out_point_destroy(btck_TransactionOutPoint *transaction_out_point)
Destroy the transaction out point.
Definition: bitcoinkernel.cpp:919

btck_tx_validation_state_destroy
BITCOINKERNEL_API void btck_tx_validation_state_destroy(btck_TxValidationState *state)
Destroy the btck_TxValidationState.
Definition: bitcoinkernel.cpp:1727

btck_NotifyBlockTip
void(* btck_NotifyBlockTip)(void *user_data, btck_SynchronizationState state, const btck_BlockTreeEntry *entry, double verification_progress)
Function signatures for the kernel notifications.
Definition: bitcoinkernel.h:448

btck_LogCategory
uint8_t btck_LogCategory
A collection of logging categories that may be encountered by kernel code.
Definition: bitcoinkernel.h:359

btck_transaction_spent_outputs_count
BITCOINKERNEL_API size_t 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.
Definition: bitcoinkernel.cpp:1528

btck_ValidationInterfaceBlockConnected
void(* btck_ValidationInterfaceBlockConnected)(void *user_data, btck_Block *block, const btck_BlockTreeEntry *entry)
Definition: bitcoinkernel.h:461

btck_transaction_spent_outputs_destroy
BITCOINKERNEL_API void btck_transaction_spent_outputs_destroy(btck_TransactionSpentOutputs *transaction_spent_outputs)
Destroy the transaction spent outputs.
Definition: bitcoinkernel.cpp:1533

btck_transaction_count_outputs
BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT BITCOINKERNEL_API size_t btck_transaction_count_outputs(const btck_Transaction *transaction) BITCOINKERNEL_ARG_NONNULL(1)
Get the number of outputs of a transaction.
Definition: bitcoinkernel.cpp:661

btck_chain_parameters_destroy
BITCOINKERNEL_API void btck_chain_parameters_destroy(btck_ChainParameters *chain_parameters)
Destroy the chain parameters.
Definition: bitcoinkernel.cpp:1064

btck_transaction_check
BITCOINKERNEL_API int btck_transaction_check(const btck_Transaction *tx, btck_TxValidationState *validation_state) BITCOINKERNEL_ARG_NONNULL(1
Run context-free consensus validation on a btck_Transaction.

btck_transaction_destroy
BITCOINKERNEL_API int BITCOINKERNEL_API void btck_transaction_destroy(btck_Transaction *transaction)
Destroy the transaction.
Definition: bitcoinkernel.cpp:725

btck_BlockCheckFlags
uint32_t btck_BlockCheckFlags
Bitflags to control context-free block checks (optional).
Definition: bitcoinkernel.h:1440

btck_block_header_get_bits
BITCOINKERNEL_API uint32_t btck_block_header_get_bits(const btck_BlockHeader *header) BITCOINKERNEL_ARG_NONNULL(1)
Get the nBits difficulty target from btck_BlockHeader.
Definition: bitcoinkernel.cpp:1664

btck_Warning
uint8_t btck_Warning
Possible warning types issued by validation.
Definition: bitcoinkernel.h:352

btck_block_destroy
BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT BITCOINKERNEL_API void btck_block_destroy(btck_Block *block)
Destroy the block.
Definition: bitcoinkernel.cpp:1427

btck_block_tree_entry_get_block_header
BITCOINKERNEL_API btck_BlockHeader *BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_tree_entry_get_block_header(const btck_BlockTreeEntry *block_tree_entry) BITCOINKERNEL_ARG_NONNULL(1)
Return the btck_BlockHeader associated with this entry.
Definition: bitcoinkernel.cpp:1442

btck_transaction_copy
BITCOINKERNEL_API btck_Transaction *BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_copy(const btck_Transaction *transaction) BITCOINKERNEL_ARG_NONNULL(1)
Copy a transaction.
Definition: bitcoinkernel.cpp:709

btck_coin_destroy
BITCOINKERNEL_API void btck_coin_destroy(btck_Coin *coin)
Destroy the coin.
Definition: bitcoinkernel.cpp:1565

btck_NotifyHeaderTip
void(* btck_NotifyHeaderTip)(void *user_data, btck_SynchronizationState state, int64_t height, int64_t timestamp, int presync)
Definition: bitcoinkernel.h:449

btck_context_options_set_notifications
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.
Definition: bitcoinkernel.cpp:1081

btck_block_get_hash
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.
Definition: bitcoinkernel.cpp:1422

btck_block_validation_state_get_validation_mode
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 btck_BlockValidationState pointer.
Definition: bitcoinkernel.cpp:1158

btck_transaction_input_get_witness_stack
BITCOINKERNEL_API const btck_WitnessStack * btck_transaction_input_get_witness_stack(const btck_TransactionInput *transaction_input) BITCOINKERNEL_ARG_NONNULL(1)
Get the witness stack of a transaction input.
Definition: bitcoinkernel.cpp:866

btck_block_spent_outputs_count
BITCOINKERNEL_API size_t 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.
Definition: bitcoinkernel.cpp:1506

btck_block_spent_outputs_destroy
BITCOINKERNEL_API void btck_block_spent_outputs_destroy(btck_BlockSpentOutputs *block_spent_outputs)
Destroy the block spent outputs.
Definition: bitcoinkernel.cpp:1518

btck_chainstate_manager_process_block_header
BITCOINKERNEL_API btck_BlockValidationState *BITCOINKERNEL_WARN_UNUSED_RESULT btck_chainstate_manager_process_block_header(btck_ChainstateManager *chainstate_manager, const btck_BlockHeader *header) BITCOINKERNEL_ARG_NONNULL(1
Processes and validates the provided btck_BlockHeader.

btck_chainstate_manager_options_create
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.
Definition: bitcoinkernel.cpp:1192

btck_wtxid_equals
BITCOINKERNEL_API int btck_wtxid_equals(const btck_Wtxid *wtxid1, const btck_Wtxid *wtxid2) BITCOINKERNEL_ARG_NONNULL(1
Check if two wtxids are equal.

btck_txid_to_bytes
BITCOINKERNEL_API int BITCOINKERNEL_API void btck_txid_to_bytes(const btck_Txid *txid, unsigned char output[32]) BITCOINKERNEL_ARG_NONNULL(1
Serializes the txid to bytes.

btck_transaction_out_point_copy
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.
Definition: bitcoinkernel.cpp:904

btck_block_tree_entry_equals
BITCOINKERNEL_API int btck_block_tree_entry_equals(const btck_BlockTreeEntry *entry1, const btck_BlockTreeEntry *entry2) BITCOINKERNEL_ARG_NONNULL(1
Check if two block tree entries are equal.

btck_context_options_set_chainparams
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.

btck_block_hash_destroy
BITCOINKERNEL_API void BITCOINKERNEL_API void btck_block_hash_destroy(btck_BlockHash *block_hash)
Destroy the block hash.
Definition: bitcoinkernel.cpp:1482

btck_chain_parameters_create_signet
BITCOINKERNEL_API btck_ChainParameters *BITCOINKERNEL_WARN_UNUSED_RESULT btck_chain_parameters_create_signet(const void *challenge, size_t challenge_len)
Create a signet chain parameters struct with a user-provided challenge.
Definition: bitcoinkernel.cpp:1044

btck_block_hash_create
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.
Definition: bitcoinkernel.cpp:1462

btck_block_hash_to_bytes
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.

btck_block_header_get_version
BITCOINKERNEL_API int32_t btck_block_header_get_version(const btck_BlockHeader *header) BITCOINKERNEL_ARG_NONNULL(1)
Get the version from btck_BlockHeader.
Definition: bitcoinkernel.cpp:1669

btck_transaction_has_witness
BITCOINKERNEL_API int btck_transaction_has_witness(const btck_Transaction *transaction) BITCOINKERNEL_ARG_NONNULL(1)
Check whether a transaction has witness data.
Definition: bitcoinkernel.cpp:699

btck_chainstate_manager_options_update_block_tree_db_in_memory
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.
Definition: bitcoinkernel.cpp:1250

btck_NotifyWarningSet
void(* btck_NotifyWarningSet)(void *user_data, btck_Warning warning, const char *message, size_t message_len)
Definition: bitcoinkernel.h:451

btck_script_pubkey_copy
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.
Definition: bitcoinkernel.cpp:743

btck_script_pubkey_destroy
BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT BITCOINKERNEL_API void btck_script_pubkey_destroy(btck_ScriptPubkey *script_pubkey)
Destroy the script pubkey.
Definition: bitcoinkernel.cpp:748

btck_transaction_input_get_script_sig
BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_input_get_script_sig(const btck_TransactionInput *transaction_input, btck_WriteBytes writer, void *user_data) BITCOINKERNEL_ARG_NONNULL(1
Serialize the script sig of a transaction input through the passed in callback.

btck_wtxid_to_bytes
BITCOINKERNEL_API int BITCOINKERNEL_API void btck_wtxid_to_bytes(const btck_Wtxid *wtxid, unsigned char output[32]) BITCOINKERNEL_ARG_NONNULL(1
Serializes the wtxid to bytes.

btck_context_destroy
BITCOINKERNEL_API void btck_context_destroy(btck_Context *context)
Destroy the context.
Definition: bitcoinkernel.cpp:1121

btck_block_validation_state_copy
BITCOINKERNEL_API btck_BlockValidationState *BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_validation_state_copy(const btck_BlockValidationState *block_validation_state) BITCOINKERNEL_ARG_NONNULL(1)
Copies the btck_BlockValidationState.
Definition: bitcoinkernel.cpp:1148

btck_tx_validation_state_get_validation_mode
BITCOINKERNEL_API btck_ValidationMode btck_tx_validation_state_get_validation_mode(const btck_TxValidationState *state) BITCOINKERNEL_ARG_NONNULL(1)
Returns the validation mode from an opaque btck_TxValidationState pointer.
Definition: bitcoinkernel.cpp:1694

btck_context_options_set_validation_interface
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.
Definition: bitcoinkernel.cpp:1088

btck_block_header_get_merkle_root
BITCOINKERNEL_API void btck_block_header_get_merkle_root(const btck_BlockHeader *header, unsigned char output[32]) BITCOINKERNEL_ARG_NONNULL(1
Get the Merkle root from btck_BlockHeader.

btck_block_tree_entry_get_previous
BITCOINKERNEL_API const btck_BlockTreeEntry * 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...
Definition: bitcoinkernel.cpp:1126

btck_chainstate_manager_import_blocks
BITCOINKERNEL_API btck_BlockValidationState *BITCOINKERNEL_WARN_UNUSED_RESULT 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.
Definition: bitcoinkernel.cpp:1339

btck_NotifyFatalError
void(* btck_NotifyFatalError)(void *user_data, const char *message, size_t message_len)
Definition: bitcoinkernel.h:454

btck_tx_validation_state_get_tx_validation_result
BITCOINKERNEL_API btck_TxValidationResult btck_tx_validation_state_get_tx_validation_result(const btck_TxValidationState *state) BITCOINKERNEL_ARG_NONNULL(1)
Returns the validation result from an opaque btck_TxValidationState pointer.
Definition: bitcoinkernel.cpp:1707

btck_NotifyFlushError
void(* btck_NotifyFlushError)(void *user_data, const char *message, size_t message_len)
Definition: bitcoinkernel.h:453

btck_logging_connection_create
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.
Definition: bitcoinkernel.cpp:1001

btck_witness_stack_count_items
BITCOINKERNEL_API size_t btck_witness_stack_count_items(const btck_WitnessStack *witness_stack) BITCOINKERNEL_ARG_NONNULL(1)
Return the number of items in a witness stack.
Definition: bitcoinkernel.cpp:882

btck_transaction_count_inputs
BITCOINKERNEL_API size_t btck_transaction_count_inputs(const btck_Transaction *transaction) BITCOINKERNEL_ARG_NONNULL(1)
Get the number of inputs of a transaction.
Definition: bitcoinkernel.cpp:673

btck_chain_get_by_height
BITCOINKERNEL_API const btck_BlockTreeEntry * btck_chain_get_by_height(const btck_Chain *chain, int32_t block_height) BITCOINKERNEL_ARG_NONNULL(1)
Retrieve a block tree entry by its height in the currently active chain.
Definition: bitcoinkernel.cpp:1611

btck_chain_parameters_copy
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.
Definition: bitcoinkernel.cpp:1054

btck_BlockHash
Definition: bitcoinkernel.cpp:640

btck_BlockHeader
Definition: bitcoinkernel.cpp:647

btck_Block
Definition: bitcoinkernel.cpp:157

btck_BlockSpentOutputs
Definition: bitcoinkernel.cpp:637

btck_BlockTreeEntry
Definition: bitcoinkernel.cpp:156

btck_BlockValidationState
Definition: bitcoinkernel.cpp:158

btck_Chain
Definition: bitcoinkernel.cpp:636

btck_ChainParameters
Definition: bitcoinkernel.cpp:633

btck_ChainstateManager
Definition: bitcoinkernel.cpp:635

btck_ChainstateManagerOptions
Definition: bitcoinkernel.cpp:634

btck_Coin
Definition: bitcoinkernel.cpp:639

btck_ConsensusParams
Definition: bitcoinkernel.cpp:648

btck_Context
Definition: bitcoinkernel.cpp:632

btck_ContextOptions
Definition: bitcoinkernel.cpp:631

btck_LogEntry
A log entry passed to the logging callback.
Definition: bitcoinkernel.h:390

btck_LogEntry::thread_name
const char * thread_name
Name of the thread that produced the log message.
Definition: bitcoinkernel.h:397

btck_LogEntry::function_name_len
size_t function_name_len
Length of function_name.
Definition: bitcoinkernel.h:413

btck_LogEntry::timestamp_ns
int64_t timestamp_ns
Wall-clock time when the entry was logged, in nanoseconds since the Unix epoch.
Definition: bitcoinkernel.h:402

btck_LogEntry::function_name
const char * function_name
Name of the function that produced the log message.
Definition: bitcoinkernel.h:411

btck_LogEntry::file_name_len
size_t file_name_len
Length of file_name.
Definition: bitcoinkernel.h:409

btck_LogEntry::line
uint32_t line
Line number of the source code that produced the log statement.
Definition: bitcoinkernel.h:415

btck_LogEntry::message
const char * message
Log message text.
Definition: bitcoinkernel.h:393

btck_LogEntry::file_name
const char * file_name
Name of the source file that produced the log statement.
Definition: bitcoinkernel.h:407

btck_LogEntry::mocktime_s
int64_t mocktime_s
Mock time in effect when the entry was logged, in seconds since the Unix epoch, or 0 if no mock time ...
Definition: bitcoinkernel.h:405

btck_LogEntry::category
btck_LogCategory category
Log category.
Definition: bitcoinkernel.h:419

btck_LogEntry::message_len
size_t message_len
Length of message.
Definition: bitcoinkernel.h:395

btck_LogEntry::thread_name_len
size_t thread_name_len
Length of thread_name.
Definition: bitcoinkernel.h:399

btck_LogEntry::level
btck_LogLevel level
Log severity level.
Definition: bitcoinkernel.h:417

btck_LoggingConnection
Definition: bitcoinkernel.cpp:630

btck_NotificationInterfaceCallbacks
A struct for holding the kernel notification callbacks.
Definition: bitcoinkernel.h:548

btck_NotificationInterfaceCallbacks::warning_unset
btck_NotifyWarningUnset warning_unset
A previous condition leading to the issuance of a warning is no longer given.
Definition: bitcoinkernel.h:557

btck_NotificationInterfaceCallbacks::block_tip
btck_NotifyBlockTip block_tip
The chain's tip was updated to the provided block entry.
Definition: bitcoinkernel.h:553

btck_NotificationInterfaceCallbacks::warning_set
btck_NotifyWarningSet warning_set
A warning issued by the kernel library during validation.
Definition: bitcoinkernel.h:556

btck_NotificationInterfaceCallbacks::flush_error
btck_NotifyFlushError flush_error
An error encountered when flushing data to disk.
Definition: bitcoinkernel.h:558

btck_NotificationInterfaceCallbacks::progress
btck_NotifyProgress progress
Reports on current block synchronization progress.
Definition: bitcoinkernel.h:555

btck_NotificationInterfaceCallbacks::fatal_error
btck_NotifyFatalError fatal_error
An unrecoverable system error encountered by the library.
Definition: bitcoinkernel.h:559

btck_NotificationInterfaceCallbacks::user_data_destroy
btck_DestroyCallback user_data_destroy
Frees the provided user data structure.
Definition: bitcoinkernel.h:552

btck_NotificationInterfaceCallbacks::user_data
void * user_data
Holds a user-defined opaque structure that is passed to the notification callbacks.
Definition: bitcoinkernel.h:549

btck_NotificationInterfaceCallbacks::header_tip
btck_NotifyHeaderTip header_tip
A new best block header was added.
Definition: bitcoinkernel.h:554

btck_PrecomputedTransactionData
Definition: bitcoinkernel.cpp:646

btck_ScriptPubkey
Definition: bitcoinkernel.cpp:629

btck_Transaction
Definition: bitcoinkernel.cpp:627

btck_TransactionInput
Definition: bitcoinkernel.cpp:641

btck_TransactionOutPoint
Definition: bitcoinkernel.cpp:643

btck_TransactionOutput
Definition: bitcoinkernel.cpp:628

btck_TransactionSpentOutputs
Definition: bitcoinkernel.cpp:638

btck_TxValidationState
Definition: bitcoinkernel.cpp:159

btck_Txid
Definition: bitcoinkernel.cpp:644

btck_ValidationInterfaceCallbacks
Holds the validation interface callbacks.
Definition: bitcoinkernel.h:523

btck_ValidationInterfaceCallbacks::user_data_destroy
btck_DestroyCallback user_data_destroy
Frees the provided user data structure.
Definition: bitcoinkernel.h:527

btck_ValidationInterfaceCallbacks::block_connected
btck_ValidationInterfaceBlockConnected block_connected
Called when a block is valid and has now been connected to the best chain.
Definition: bitcoinkernel.h:532

btck_ValidationInterfaceCallbacks::block_checked
btck_ValidationInterfaceBlockChecked block_checked
Called when a new block has been fully validated.
Definition: bitcoinkernel.h:528

btck_ValidationInterfaceCallbacks::block_disconnected
btck_ValidationInterfaceBlockDisconnected block_disconnected
Called during a re-org when a block has been removed from the best chain.
Definition: bitcoinkernel.h:533

btck_ValidationInterfaceCallbacks::user_data
void * user_data
Holds a user-defined opaque structure that is passed to the validation interface callbacks.
Definition: bitcoinkernel.h:524

btck_ValidationInterfaceCallbacks::pow_valid_block
btck_ValidationInterfacePoWValidBlock pow_valid_block
Called when a new block extends the header chain and has a valid transaction and segwit merkle root.
Definition: bitcoinkernel.h:530

btck_WitnessStack
Definition: bitcoinkernel.cpp:642

btck_Wtxid
Definition: bitcoinkernel.cpp:645

context
WalletContext context
Definition: wallet_tests.cpp:130