X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Fln%2Fmod.rs;h=af654837861fc2eeac3d1f7795453b1a206cae46;hb=f76f60ff855ff286fc5c71704ea74430cdfb7d86;hp=444c9685fdda6979708fdee6eb26797b0ddfe040;hpb=b1cd5a74348ad305ce9cacd30749322651811635;p=rust-lightning diff --git a/lightning/src/ln/mod.rs b/lightning/src/ln/mod.rs index 444c9685..af654837 100644 --- a/lightning/src/ln/mod.rs +++ b/lightning/src/ln/mod.rs @@ -9,20 +9,24 @@ //! High level lightning structs and impls live here. //! -//! You probably want to create a channelmanager::ChannelManager, and a routing::NetGraphMsgHandler first. +//! You probably want to create a [`ChannelManager`], and a [`P2PGossipSync`] first. //! Then, you probably want to pass them both on to a peer_handler::PeerManager and use that to //! create/manage connections and call get_and_clear_pending_events after each action, handling //! them appropriately. //! -//! When you want to open/close a channel or send a payment, call into your ChannelManager and when -//! you want to learn things about the network topology (eg get a route for sending a payment), -//! call into your NetGraphMsgHandler. +//! When you want to open/close a channel or send a payment, call into your [`ChannelManager`] and +//! when you want to learn things about the network topology (eg get a route for sending a payment), +//! call into your [`P2PGossipSync`]. +//! +//! [`ChannelManager`]: channelmanager::ChannelManager +//! [`P2PGossipSync`]: crate::routing::gossip::P2PGossipSync #[cfg(any(test, feature = "_test_utils"))] #[macro_use] pub mod functional_test_utils; pub mod channelmanager; +pub mod inbound_payment; pub mod msgs; pub mod peer_handler; pub mod chan_utils; @@ -39,7 +43,7 @@ pub mod channel; #[cfg(not(fuzzing))] pub(crate) mod channel; -mod onion_utils; +pub(crate) mod onion_utils; pub mod wire; // Older rustc (which we support) refuses to let us call the get_payment_preimage_hash!() macro @@ -76,15 +80,15 @@ pub use self::peer_channel_encryptor::LN_MAX_MSG_LEN; /// payment_hash type, use to cross-lock hop /// (C-not exported) as we just use [u8; 32] directly #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)] -pub struct PaymentHash(pub [u8;32]); +pub struct PaymentHash(pub [u8; 32]); /// payment_preimage type, use to route payment between hop /// (C-not exported) as we just use [u8; 32] directly #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)] -pub struct PaymentPreimage(pub [u8;32]); +pub struct PaymentPreimage(pub [u8; 32]); /// payment_secret type, use to authenticate sender to the receiver and tie MPP HTLCs together /// (C-not exported) as we just use [u8; 32] directly #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)] -pub struct PaymentSecret(pub [u8;32]); +pub struct PaymentSecret(pub [u8; 32]); use prelude::*; use bitcoin::bech32;