f! doc

Author: wpaulino

lightning-invoice/src/payment.rs

@@ -40,21 +40,23 @@
 //! # use lightning::routing::gossip::NodeId;
 //! # use lightning::routing::router::{Route, RouteHop, RouteParameters};
 //! # use lightning::routing::scoring::{ChannelUsage, Score};
-//! # use lightning::util::events::{Event, EventHandler, EventsProvider};
+//! # use lightning::util::events::{Event, AsyncEventHandler, EventHandler, EventsProvider};
 //! # use lightning::util::logger::{Logger, Record};
 //! # use lightning::util::ser::{Writeable, Writer};
 //! # use lightning_invoice::Invoice;
 //! # use lightning_invoice::payment::{InFlightHtlcs, InvoicePayer, Payer, Retry, Router};
 //! # use secp256k1::PublicKey;
 //! # use std::cell::RefCell;
+//! # use std::future::Future;
 //! # use std::ops::Deref;
+//! # use std::pin::Pin;
 //! #
 //! # struct FakeEventProvider {}
 //! # impl EventsProvider for FakeEventProvider {
 //! #     fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {}
 //! #     fn process_pending_events_async<'a, H: Deref + 'a>(
 //! #         &'a self, handler: H
-//! #     ) -> Pin<Box<dyn StdFuture<Output = ()> + 'a>> where H::Target: AsyncEventHandler {}
+//! #     ) -> Pin<Box<dyn Future<Output = ()> + 'a>> where H::Target: AsyncEventHandler {}
 //! # }
 //! #
 //! # struct FakePayer {}

lightning/src/ln/channelmanager.rs

@@ -5654,7 +5654,10 @@ where
 		// We can't use `optionally_notify` with an async closure as required by the
 		// `handle_event_async` call since it's not supported on stable.
 		Box::pin(async move {
+			// We'll acquire our total consistency lock until the returned future completes so that
+			// we can be sure no other persists happen while processing events.
 			let _read_guard = self.total_consistency_lock.read().unwrap();
+
 			let mut result = NotifyOption::SkipPersist;
 
 			// TODO: This behavior should be documented. It's unintuitive that we query