Create options for the chainstate manager.

Synopsis

Declared in <kernel/bitcoinkernel.h>

[[nodiscard, __nonnull__]]
btck_ChainstateManagerOptions*
btck_chainstate_manager_options_create(
    btck_Context const* context,
    char const* data_directory,
    size_t data_directory_len,
    char const* blocks_directory,
    size_t blocks_directory_len);

Return Value

The allocated chainstate manager options, or null on error (e.g. if a path is invalid).

Note

The return value should not be discarded.

Parameters

Name

Description

context [in]

Non‐null, the created options and through it the chainstate manager will associate with this kernel context for the duration of their lifetimes.

data_directory [in]

Path string of the directory containing the chainstate data. If the directory does not exist yet, it will be created.

blocks_directory [in]

Path string of the directory containing the block data. If the directory does not exist yet, it will be created.

data_directory_len [in]

Length in bytes of data_directory (not including a trailing NUL).

blocks_directory_len [in]

Length in bytes of blocks_directory (not including a trailing NUL).

Created with MrDocs