X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Fonion_message%2Fmod.rs;h=05a8b7d6fbd033922fb140ea97d326287aec8757;hb=b8b1ef3149f26992625a03d45c0307bfad70e8bd;hp=291030f4e26c5ce7b9eccee6e33760debab430fe;hpb=4c8dc2c2a0b9589298d937bf16061ae0ac99b31e;p=rust-lightning

diff --git a/lightning/src/onion_message/mod.rs b/lightning/src/onion_message/mod.rs
index 291030f4..05a8b7d6 100644
--- a/lightning/src/onion_message/mod.rs
+++ b/lightning/src/onion_message/mod.rs
@@ -8,13 +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 messenger;
-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 use self::messenger::{OnionMessenger, SimpleArcOnionMessenger, SimpleRefOnionMessenger};
-pub(crate) use self::packet::Packet;
+pub mod messenger;
+pub mod offers;
+pub mod packet;
+#[cfg(test)]
+mod functional_tests;