Define an OfferId for BOLT 12 Offers
[rust-lightning] / lightning / src / onion_message / mod.rs
index 89c1545a7df29c59adfe0956bc9faf1f769e9b80..05a8b7d6fbd033922fb140ea97d326287aec8757 100644 (file)
 //! 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].
+//! 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 routes]: crate::onion_message::BlindedRoute
+//! [blinded paths]: crate::blinded_path::BlindedPath
+//! [`OnionMessenger`]: self::messenger::OnionMessenger
 
-mod blinded_route;
-mod messenger;
-mod packet;
-mod utils;
+pub mod messenger;
+pub mod offers;
+pub mod packet;
 #[cfg(test)]
 mod functional_tests;
-
-// Re-export structs so they can be imported with just the `onion_message::` module prefix.
-pub use self::blinded_route::{BlindedRoute, BlindedRoute as BlindedPath, BlindedHop};
-pub use self::messenger::{CustomOnionMessageContents, CustomOnionMessageHandler, Destination, OnionMessageContents, OnionMessenger, SendError, SimpleArcOnionMessenger, SimpleRefOnionMessenger};
-pub(crate) use self::packet::Packet;