1 use crate::error::{TxSyncError, InternalError};
2 use crate::common::{SyncState, FilterQueue, ConfirmedTx};
4 use lightning::util::logger::Logger;
5 use lightning::{log_error, log_debug, log_trace};
6 use lightning::chain::WatchedOutput;
7 use lightning::chain::{Confirm, Filter};
9 use bitcoin::{BlockHash, Script, Txid};
11 use esplora_client::Builder;
12 #[cfg(feature = "async-interface")]
13 use esplora_client::r#async::AsyncClient;
14 #[cfg(not(feature = "async-interface"))]
15 use esplora_client::blocking::BlockingClient;
17 use std::time::Instant;
18 use std::collections::HashSet;
21 /// Synchronizes LDK with a given [`Esplora`] server.
23 /// Needs to be registered with a [`ChainMonitor`] via the [`Filter`] interface to be informed of
24 /// transactions and outputs to monitor for on-chain confirmation, unconfirmation, and
27 /// Note that registration via [`Filter`] needs to happen before any calls to
28 /// [`Watch::watch_channel`] to ensure we get notified of the items to monitor.
30 /// This uses and exposes either a blocking or async client variant dependent on whether the
31 /// `esplora-blocking` or the `esplora-async` feature is enabled.
33 /// [`Esplora`]: https://github.com/Blockstream/electrs
34 /// [`ChainMonitor`]: lightning::chain::chainmonitor::ChainMonitor
35 /// [`Watch::watch_channel`]: lightning::chain::Watch::watch_channel
36 /// [`Filter`]: lightning::chain::Filter
37 pub struct EsploraSyncClient<L: Deref>
41 sync_state: MutexType<SyncState>,
42 queue: std::sync::Mutex<FilterQueue>,
43 client: EsploraClientType,
47 impl<L: Deref> EsploraSyncClient<L>
51 /// Returns a new [`EsploraSyncClient`] object.
52 pub fn new(server_url: String, logger: L) -> Self {
53 let builder = Builder::new(&server_url);
54 #[cfg(not(feature = "async-interface"))]
55 let client = builder.build_blocking().unwrap();
56 #[cfg(feature = "async-interface")]
57 let client = builder.build_async().unwrap();
59 EsploraSyncClient::from_client(client, logger)
62 /// Returns a new [`EsploraSyncClient`] object using the given Esplora client.
63 pub fn from_client(client: EsploraClientType, logger: L) -> Self {
64 let sync_state = MutexType::new(SyncState::new());
65 let queue = std::sync::Mutex::new(FilterQueue::new());
74 /// Synchronizes the given `confirmables` via their [`Confirm`] interface implementations. This
75 /// method should be called regularly to keep LDK up-to-date with current chain data.
77 /// For example, instances of [`ChannelManager`] and [`ChainMonitor`] can be informed about the
78 /// newest on-chain activity related to the items previously registered via the [`Filter`]
81 /// [`Confirm`]: lightning::chain::Confirm
82 /// [`ChainMonitor`]: lightning::chain::chainmonitor::ChainMonitor
83 /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
84 /// [`Filter`]: lightning::chain::Filter
86 pub fn sync(&self, confirmables: Vec<&(dyn Confirm + Sync + Send)>) -> Result<(), TxSyncError> {
87 // This lock makes sure we're syncing once at a time.
88 #[cfg(not(feature = "async-interface"))]
89 let mut sync_state = self.sync_state.lock().unwrap();
90 #[cfg(feature = "async-interface")]
91 let mut sync_state = self.sync_state.lock().await;
93 log_trace!(self.logger, "Starting transaction sync.");
94 let start_time = Instant::now();
95 let mut num_confirmed = 0;
96 let mut num_unconfirmed = 0;
98 let mut tip_hash = maybe_await!(self.client.get_tip_hash())?;
101 let pending_registrations = self.queue.lock().unwrap().process_queues(&mut sync_state);
102 let tip_is_new = Some(tip_hash) != sync_state.last_sync_hash;
104 // We loop until any registered transactions have been processed at least once, or the
105 // tip hasn't been updated during the last iteration.
106 if !sync_state.pending_sync && !pending_registrations && !tip_is_new {
110 // Update the known tip to the newest one.
112 // First check for any unconfirmed transactions and act on it immediately.
113 match maybe_await!(self.get_unconfirmed_transactions(&confirmables)) {
114 Ok(unconfirmed_txs) => {
115 // Double-check the tip hash. If it changed, a reorg happened since
116 // we started syncing and we need to restart last-minute.
117 match maybe_await!(self.client.get_tip_hash()) {
118 Ok(check_tip_hash) => {
119 if check_tip_hash != tip_hash {
120 tip_hash = check_tip_hash;
122 log_debug!(self.logger, "Encountered inconsistency during transaction sync, restarting.");
123 sync_state.pending_sync = true;
126 num_unconfirmed += unconfirmed_txs.len();
127 sync_state.sync_unconfirmed_transactions(
133 // (Semi-)permanent failure, retry later.
134 log_error!(self.logger,
135 "Failed during transaction sync, aborting. Synced so far: {} confirmed, {} unconfirmed.",
139 sync_state.pending_sync = true;
140 return Err(TxSyncError::from(err));
145 // (Semi-)permanent failure, retry later.
146 log_error!(self.logger,
147 "Failed during transaction sync, aborting. Synced so far: {} confirmed, {} unconfirmed.",
151 sync_state.pending_sync = true;
152 return Err(TxSyncError::from(err));
156 match maybe_await!(self.sync_best_block_updated(&confirmables, &tip_hash)) {
158 Err(InternalError::Inconsistency) => {
159 // Immediately restart syncing when we encounter any inconsistencies.
160 log_debug!(self.logger, "Encountered inconsistency during transaction sync, restarting.");
161 sync_state.pending_sync = true;
165 // (Semi-)permanent failure, retry later.
166 log_error!(self.logger,
167 "Failed during transaction sync, aborting. Synced so far: {} confirmed, {} unconfirmed.",
171 sync_state.pending_sync = true;
172 return Err(TxSyncError::from(err));
177 match maybe_await!(self.get_confirmed_transactions(&sync_state)) {
178 Ok(confirmed_txs) => {
179 // Double-check the tip hash. If it changed, a reorg happened since
180 // we started syncing and we need to restart last-minute.
181 match maybe_await!(self.client.get_tip_hash()) {
182 Ok(check_tip_hash) => {
183 if check_tip_hash != tip_hash {
184 tip_hash = check_tip_hash;
186 log_debug!(self.logger,
187 "Encountered inconsistency during transaction sync, restarting.");
188 sync_state.pending_sync = true;
191 num_confirmed += confirmed_txs.len();
192 sync_state.sync_confirmed_transactions(
198 // (Semi-)permanent failure, retry later.
199 log_error!(self.logger,
200 "Failed during transaction sync, aborting. Synced so far: {} confirmed, {} unconfirmed.",
204 sync_state.pending_sync = true;
205 return Err(TxSyncError::from(err));
209 Err(InternalError::Inconsistency) => {
210 // Immediately restart syncing when we encounter any inconsistencies.
211 log_debug!(self.logger, "Encountered inconsistency during transaction sync, restarting.");
212 sync_state.pending_sync = true;
216 // (Semi-)permanent failure, retry later.
217 log_error!(self.logger,
218 "Failed during transaction sync, aborting. Synced so far: {} confirmed, {} unconfirmed.",
222 sync_state.pending_sync = true;
223 return Err(TxSyncError::from(err));
226 sync_state.last_sync_hash = Some(tip_hash);
227 sync_state.pending_sync = false;
230 log_debug!(self.logger, "Finished transaction sync at tip {} in {}ms: {} confirmed, {} unconfirmed.",
231 tip_hash, start_time.elapsed().as_millis(), num_confirmed, num_unconfirmed);
236 fn sync_best_block_updated(
237 &self, confirmables: &Vec<&(dyn Confirm + Sync + Send)>, tip_hash: &BlockHash,
238 ) -> Result<(), InternalError> {
240 // Inform the interface of the new block.
241 let tip_header = maybe_await!(self.client.get_header_by_hash(tip_hash))?;
242 let tip_status = maybe_await!(self.client.get_block_status(&tip_hash))?;
243 if tip_status.in_best_chain {
244 if let Some(tip_height) = tip_status.height {
245 for c in confirmables {
246 c.best_block_updated(&tip_header, tip_height);
250 return Err(InternalError::Inconsistency);
256 fn get_confirmed_transactions(
257 &self, sync_state: &SyncState,
258 ) -> Result<Vec<ConfirmedTx>, InternalError> {
260 // First, check the confirmation status of registered transactions as well as the
261 // status of dependent transactions of registered outputs.
263 let mut confirmed_txs = Vec::new();
265 for txid in &sync_state.watched_transactions {
266 if let Some(confirmed_tx) = maybe_await!(self.get_confirmed_tx(&txid, None, None))? {
267 confirmed_txs.push(confirmed_tx);
271 for (_, output) in &sync_state.watched_outputs {
272 if let Some(output_status) = maybe_await!(self.client
273 .get_output_status(&output.outpoint.txid, output.outpoint.index as u64))?
275 if let Some(spending_txid) = output_status.txid {
276 if let Some(spending_tx_status) = output_status.status {
277 if let Some(confirmed_tx) = maybe_await!(self
280 spending_tx_status.block_hash,
281 spending_tx_status.block_height,
284 confirmed_txs.push(confirmed_tx);
291 // Sort all confirmed transactions first by block height, then by in-block
292 // position, and finally feed them to the interface in order.
293 confirmed_txs.sort_unstable_by(|tx1, tx2| {
294 tx1.block_height.cmp(&tx2.block_height).then_with(|| tx1.pos.cmp(&tx2.pos))
302 &self, txid: &Txid, expected_block_hash: Option<BlockHash>, known_block_height: Option<u32>,
303 ) -> Result<Option<ConfirmedTx>, InternalError> {
304 if let Some(merkle_block) = maybe_await!(self.client.get_merkle_block(&txid))? {
305 let block_header = merkle_block.header;
306 let block_hash = block_header.block_hash();
307 if let Some(expected_block_hash) = expected_block_hash {
308 if expected_block_hash != block_hash {
309 log_trace!(self.logger, "Inconsistency: Tx {} expected in block {}, but is confirmed in {}", txid, expected_block_hash, block_hash);
310 return Err(InternalError::Inconsistency);
314 let mut matches = Vec::new();
315 let mut indexes = Vec::new();
316 let _ = merkle_block.txn.extract_matches(&mut matches, &mut indexes);
317 if indexes.len() != 1 || matches.len() != 1 || matches[0] != *txid {
318 log_error!(self.logger, "Retrieved Merkle block for txid {} doesn't match expectations. This should not happen. Please verify server integrity.", txid);
319 return Err(InternalError::Failed);
322 // unwrap() safety: len() > 0 is checked above
323 let pos = *indexes.first().unwrap() as usize;
324 if let Some(tx) = maybe_await!(self.client.get_tx(&txid))? {
325 if let Some(block_height) = known_block_height {
326 // We can take a shortcut here if a previous call already gave us the height.
327 return Ok(Some(ConfirmedTx { tx, block_header, pos, block_height }));
330 let block_status = maybe_await!(self.client.get_block_status(&block_hash))?;
331 if let Some(block_height) = block_status.height {
332 return Ok(Some(ConfirmedTx { tx, block_header, pos, block_height }));
334 // If any previously-confirmed block suddenly is no longer confirmed, we found
335 // an inconsistency and should start over.
336 log_trace!(self.logger, "Inconsistency: Tx {} was unconfirmed during syncing.", txid);
337 return Err(InternalError::Inconsistency);
345 fn get_unconfirmed_transactions(
346 &self, confirmables: &Vec<&(dyn Confirm + Sync + Send)>,
347 ) -> Result<Vec<Txid>, InternalError> {
348 // Query the interface for relevant txids and check whether the relevant blocks are still
349 // in the best chain, mark them unconfirmed otherwise
350 let relevant_txids = confirmables
352 .flat_map(|c| c.get_relevant_txids())
353 .collect::<HashSet<(Txid, u32, Option<BlockHash>)>>();
355 let mut unconfirmed_txs = Vec::new();
357 for (txid, _conf_height, block_hash_opt) in relevant_txids {
358 if let Some(block_hash) = block_hash_opt {
359 let block_status = maybe_await!(self.client.get_block_status(&block_hash))?;
360 if block_status.in_best_chain {
361 // Skip if the block in question is still confirmed.
365 unconfirmed_txs.push(txid);
367 log_error!(self.logger, "Untracked confirmation of funding transaction. Please ensure none of your channels had been created with LDK prior to version 0.0.113!");
368 panic!("Untracked confirmation of funding transaction. Please ensure none of your channels had been created with LDK prior to version 0.0.113!");
374 /// Returns a reference to the underlying esplora client.
375 pub fn client(&self) -> &EsploraClientType {
380 #[cfg(feature = "async-interface")]
381 type MutexType<I> = futures::lock::Mutex<I>;
382 #[cfg(not(feature = "async-interface"))]
383 type MutexType<I> = std::sync::Mutex<I>;
385 // The underlying client type.
386 #[cfg(feature = "async-interface")]
387 type EsploraClientType = AsyncClient;
388 #[cfg(not(feature = "async-interface"))]
389 type EsploraClientType = BlockingClient;
392 impl<L: Deref> Filter for EsploraSyncClient<L>
396 fn register_tx(&self, txid: &Txid, _script_pubkey: &Script) {
397 let mut locked_queue = self.queue.lock().unwrap();
398 locked_queue.transactions.insert(*txid);
401 fn register_output(&self, output: WatchedOutput) {
402 let mut locked_queue = self.queue.lock().unwrap();
403 locked_queue.outputs.insert(output.outpoint.into_bitcoin_outpoint(), output);