CbfClientInterface

A `CbfClient` handles wallet updates from a `CbfNode`.

Inheritors

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
abstract suspend fun addRevealedScripts(wallet: Wallet)

Add scripts for the node to watch for as they are revealed. Typically used after creating a transaction or revealing a receive address.

Link copied to clipboard
abstract suspend fun broadcast(transaction: Transaction)

Broadcast a transaction to the network, erroring if the node has stopped running.

Link copied to clipboard
abstract suspend fun isRunning(): Boolean

Check if the node is still running in the background.

Link copied to clipboard
abstract suspend fun minBroadcastFeerate(): FeeRate

The minimum fee rate required to broadcast a transcation to all connected peers.

Link copied to clipboard
abstract suspend fun nextLog(): Log

Return the next available log message from a node. If none is returned, the node has stopped.

Link copied to clipboard
abstract suspend fun nextWarning(): Warning

Return the next available warning message from a node. If none is returned, the node has stopped.

Link copied to clipboard
abstract suspend fun shutdown()

Stop the `CbfNode`. Errors if the node is already stopped.

Link copied to clipboard
abstract suspend fun update(): Update?

Return an `Update`. This is method returns once the node syncs to the rest of the network or a new block has been gossiped.