Check for timing-out HTLCs in remote unrevoked commitments

[rust-lightning] / src / ln / mod.rs

diff --git a/src/ln/mod.rs b/src/ln/mod.rs
index 7cd4272e13c1013e5e4abe1d38380aa0bd4e76dd..adf54e8e256b4a60cad55bafcb3b5f5967afabfe 100644 (file)
--- a/src/ln/mod.rs
+++ b/src/ln/mod.rs
@@ -1,13 +1,28 @@
+//! High level lightning structs and impls live here.
+//!
+//! You probably want to create a channelmanager::ChannelManager, and a router::Router first.
+//! Then, you probably want to pass them both on to a peer_handler::PeerManager and use that to
+//! create/manage connections and call get_and_clear_pending_events after each action, handling
+//! them appropriately.
+//!
+//! When you want to open/close a channel or send a payment, call into your ChannelManager and when
+//! you want to learn things about the network topology (eg get a route for sending a payment),
+//! call into your Router.
+
 pub mod channelmanager;
 pub mod channelmonitor;
 pub mod msgs;
 pub mod router;
-pub mod peer_channel_encryptor;
 pub mod peer_handler;
 
 #[cfg(feature = "fuzztarget")]
-pub mod channel;
+pub mod peer_channel_encryptor;
 #[cfg(not(feature = "fuzztarget"))]
-pub(crate) mod channel;
+pub(crate) mod peer_channel_encryptor;
 
+mod channel;
 mod chan_utils;
+mod onion_utils;
+
+#[cfg(test)]
+mod functional_tests;