rust-lightning/lightning/src/ln/mod.rs

49 lines
1.5 KiB
Rust
Raw Normal View History

// This file is Copyright its original authors, visible in version control
// history.
//
// This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
// or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
// You may not use this file except in accordance with one or both of these
// licenses.
//! High level lightning structs and impls live here.
//!
2020-05-06 19:04:44 -04:00
//! You probably want to create a channelmanager::ChannelManager, and a routing::NetGraphMsgHandler 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),
2020-05-06 19:04:44 -04:00
//! call into your NetGraphMsgHandler.
2017-12-25 01:05:27 -05:00
pub mod channelmanager;
pub mod channelmonitor;
pub mod msgs;
pub mod peer_handler;
pub mod chan_utils;
pub mod features;
pub(crate) mod onchaintx;
2017-12-25 01:05:27 -05:00
#[cfg(feature = "fuzztarget")]
pub mod peer_channel_encryptor;
#[cfg(not(feature = "fuzztarget"))]
pub(crate) mod peer_channel_encryptor;
mod channel;
mod onion_utils;
mod wire;
#[cfg(test)]
#[macro_use]
pub(crate) mod functional_test_utils;
#[cfg(test)]
mod functional_tests;
#[cfg(test)]
mod chanmon_update_fail_tests;
#[cfg(test)]
mod reorg_tests;
pub use self::peer_channel_encryptor::LN_MAX_MSG_LEN;