#lightning #interface #sync #confirm #syncing #ldk #async

lightning-transaction-sync

Utilities for syncing LDK via the transaction-based Confirm interface

18 releases

0.0.123 May 9, 2024
0.0.123-beta Apr 19, 2024
0.0.121 Jan 23, 2024
0.0.119 Dec 16, 2023
0.0.114 Mar 4, 2023

#4 in #ldk

Download history 395/week @ 2024-01-25 981/week @ 2024-02-01 475/week @ 2024-02-08 1060/week @ 2024-02-15 1157/week @ 2024-02-22 1275/week @ 2024-02-29 516/week @ 2024-03-07 129/week @ 2024-03-14 86/week @ 2024-03-21 55/week @ 2024-03-28 202/week @ 2024-04-04 68/week @ 2024-04-11 424/week @ 2024-04-18 312/week @ 2024-04-25 148/week @ 2024-05-02 1012/week @ 2024-05-09

1,907 downloads per month
Used in 2 crates

MIT/Apache

6.5MB
105K SLoC

Provides utilities for syncing LDK via the transaction-based Confirm interface.

The provided synchronization clients need to be registered with a ChainMonitor via the Filter interface. Then, the respective fn sync needs to be called with the Confirm implementations to be synchronized, i.e., usually instances of ChannelManager and ChainMonitor.

Features and Backend Support

  • esplora-blocking enables syncing against an Esplora backend based on a blocking client.
  • esplora-async enables syncing against an Esplora backend based on an async client.
  • esplora-async-https enables the async Esplora client with support for HTTPS.

Version Compatibility

Currently this crate is compatible with LDK version 0.0.114 and above using channels which were created on LDK version 0.0.113 and above.

Usage Example:

let tx_sync = Arc::new(EsploraSyncClient::new(
	esplora_server_url,
	Arc::clone(&some_logger),
));

let chain_monitor = Arc::new(ChainMonitor::new(
	Some(Arc::clone(&tx_sync)),
	Arc::clone(&some_broadcaster),
	Arc::clone(&some_logger),
	Arc::clone(&some_fee_estimator),
	Arc::clone(&some_persister),
));

let channel_manager = Arc::new(ChannelManager::new(
	Arc::clone(&some_fee_estimator),
	Arc::clone(&chain_monitor),
	Arc::clone(&some_broadcaster),
	Arc::clone(&some_router),
	Arc::clone(&some_logger),
	Arc::clone(&some_entropy_source),
	Arc::clone(&some_node_signer),
	Arc::clone(&some_signer_provider),
	user_config,
	chain_params,
));

let confirmables = vec![
	&*channel_manager as &(dyn Confirm + Sync + Send),
	&*chain_monitor as &(dyn Confirm + Sync + Send),
];

tx_sync.sync(confirmables).unwrap();

Dependencies

~8–20MB
~246K SLoC