Merge pull request #2075 from TheBlueMatt/2023-02-0.0.114-bindings
[rust-lightning] / lightning / src / onion_message / mod.rs
index 966b10b60fbd6be7d6d3ebac6166bddf7bd92e23..7a2ee12d0466fe958c771bd52ab95dabf55e7332 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::onion_message::BlindedPath
 
-mod blinded_route;
-mod messenger;
-mod packet;
+pub mod blinded_path;
+pub mod messenger;
+pub mod packet;
 mod utils;
 #[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, BlindedHop};
-pub use self::messenger::{Destination, OnionMessenger, SimpleArcOnionMessenger, SimpleRefOnionMessenger};
-pub(crate) use self::packet::Packet;
+
+pub(crate) use self::blinded_path::{BlindedPath, BlindedHop};
+pub(crate) use self::messenger::{CustomOnionMessageHandler, Destination, OnionMessenger, SendError, SimpleArcOnionMessenger, SimpleRefOnionMessenger};
+pub(crate) use self::packet::{Packet, CustomOnionMessageContents, OnionMessageContents};