Merge pull request #2999 from keyuebao/keyue/update-ldk-docs

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

diff --git a/lightning/src/onion_message/mod.rs b/lightning/src/onion_message/mod.rs
index 37858c1a4a68d8e1541b4e5720606b0f4d81296b..05a8b7d6fbd033922fb140ea97d326287aec8757 100644 (file)
--- a/lightning/src/onion_message/mod.rs
+++ b/lightning/src/onion_message/mod.rs
@@ -8,10 +8,21 @@
 // licenses.
 
 //! Onion Messages: sending, receiving, forwarding, and ancillary utilities live here
+//!
+//! Onion messages are multi-purpose messages sent between peers over the lightning network. In the
+//! near future, they will be used to communicate invoices for [offers], unlocking use cases such as
+//! static invoices, refunds and proof of payer. Further, you will be able to accept payments
+//! without revealing your node id through the use of [blinded paths].
+//!
+//! LDK sends and receives onion messages via the [`OnionMessenger`]. See its documentation for more
+//! information on its usage.
+//!
+//! [offers]: <https://github.com/lightning/bolts/pull/798>
+//! [blinded paths]: crate::blinded_path::BlindedPath
+//! [`OnionMessenger`]: self::messenger::OnionMessenger
 
-mod blinded_route;
-mod packet;
-mod utils;
-
-// Re-export structs so they can be imported with just the `onion_message::` module prefix.
-pub use self::blinded_route::{BlindedRoute, BlindedHop};
+pub mod messenger;
+pub mod offers;
+pub mod packet;
+#[cfg(test)]
+mod functional_tests;