Significantly expand onion message documentation

[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 9236341fa61d25b36e4b4d0e2b73692aaccccf73..a874fbc4335ffa3e269fce0c453ce8e4543dd4cd 100644 (file)
--- a/lightning/src/onion_message/mod.rs
+++ b/lightning/src/onion_message/mod.rs
@@ -8,6 +8,17 @@
 // 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 routes].
+//!
+//! 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 routes]: crate::onion_message::BlindedRoute
 
 mod blinded_route;
 mod messenger;