Class

ContextOptions

Builder for constructing a Context — configure, then pass to init(options:).

final class ContextOptions

Mentioned In

Embedding BitcoinKernel on iOS without an xcframework

Overview

A one-shot builder: each setter replaces the previous value for that property. Defaults produce a mainnet context with no callbacks (see init(options:) for the implications). Set the chain type first, attach callbacks, then build the context.

Warning

Not thread-safe. Configure on a single thread before creating the context; the resulting Context is thread-safe but building ContextOptions concurrently is undefined.

Wraps the opaque btck_ContextOptions type; deinit calls btck_context_options_destroy when the last Swift reference drops.

Topics

Initializers

init()
Creates empty context options with default values — mainnet chain, no notification callbacks, no validation interface callbacks.

Instance Methods

func setChainParams(ChainParameters)
Sets the chain parameters — determines which Bitcoin network the resulting Context validates against.
func setNotifications(NotificationCallbacks)
Attaches notification callbacks — tip updates, header tips, progress reports, warnings, and fatal errors.
func setValidationInterface(ValidationInterfaceCallbacks)
Attaches validation interface callbacks — per-block validation, PoW confirmation, chain connect / disconnect events.