Struct ElectrumSyncClient

pub struct ElectrumSyncClient<L: Deref>
where
    L::Target: Logger,
{ /* private fields */ }

Available on crate feature electrum only.

Synchronizes LDK with a given Electrum server.

Needs to be registered with a ChainMonitor via the Filter interface to be informed of transactions and outputs to monitor for on-chain confirmation, unconfirmation, and reconfirmation.

Note that registration via Filter needs to happen before any calls to Watch::watch_channel to ensure we get notified of the items to monitor.

Implementations

impl<L: Deref> ElectrumSyncClient<L>

where L::Target: Logger,

pub fn new(server_url: String, logger: L) -> Result<Self, TxSyncError>

Returns a new ElectrumSyncClient object.

pub fn from_client( client: ElectrumClient, logger: L, ) -> Result<Self, TxSyncError>

Returns a new ElectrumSyncClient object using the given Electrum client.

This is not exported to bindings users as the underlying client from BDK is not exported.

pub fn sync<C: Deref>(&self, confirmables: Vec<C>) -> Result<(), TxSyncError>

where C::Target: Confirm,

Synchronizes the given confirmables via their Confirm interface implementations. This method should be called regularly to keep LDK up-to-date with current chain data.

For example, instances of ChannelManager and ChainMonitor can be informed about the newest on-chain activity related to the items previously registered via the Filter interface.

pub fn client(&self) -> &ElectrumClient

Returns a reference to the underlying Electrum client.

This is not exported to bindings users as the underlying client from BDK is not exported.

Trait Implementations

impl<L: Deref> Filter for ElectrumSyncClient<L>

where L::Target: Logger,

fn register_tx(&self, txid: &Txid, _script_pubkey: &Script)

Registers interest in a transaction with txid and having an output with script_pubkey as a spending condition.

fn register_output(&self, output: WatchedOutput)

Registers interest in spends of a transaction output.