1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! High level lightning structs and impls live here.
12 //! You probably want to create a [`ChannelManager`], and a [`P2PGossipSync`] first.
13 //! Then, you probably want to pass them both on to a peer_handler::PeerManager and use that to
14 //! create/manage connections and call get_and_clear_pending_events after each action, handling
15 //! them appropriately.
17 //! When you want to open/close a channel or send a payment, call into your [`ChannelManager`] and
18 //! when you want to learn things about the network topology (eg get a route for sending a payment),
19 //! call into your [`P2PGossipSync`].
21 //! [`ChannelManager`]: channelmanager::ChannelManager
22 //! [`P2PGossipSync`]: crate::routing::gossip::P2PGossipSync
24 #[cfg(any(test, feature = "_test_utils"))]
26 pub mod functional_test_utils;
28 pub mod channelmanager;
29 pub mod inbound_payment;
37 pub mod peer_channel_encryptor;
39 pub(crate) mod peer_channel_encryptor;
44 pub(crate) mod channel;
49 // Older rustc (which we support) refuses to let us call the get_payment_preimage_hash!() macro
50 // without the node parameter being mut. This is incorrect, and thus newer rustcs will complain
51 // about an unnecessary mut. Thus, we silence the unused_mut warning in two test modules below.
61 mod priv_short_conf_tests;
64 mod chanmon_update_fail_tests;
70 mod onion_route_tests;
78 pub use self::peer_channel_encryptor::LN_MAX_MSG_LEN;
80 /// payment_hash type, use to cross-lock hop
81 /// (C-not exported) as we just use [u8; 32] directly
82 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
83 pub struct PaymentHash(pub [u8; 32]);
84 /// payment_preimage type, use to route payment between hop
85 /// (C-not exported) as we just use [u8; 32] directly
86 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
87 pub struct PaymentPreimage(pub [u8; 32]);
88 /// payment_secret type, use to authenticate sender to the receiver and tie MPP HTLCs together
89 /// (C-not exported) as we just use [u8; 32] directly
90 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
91 pub struct PaymentSecret(pub [u8; 32]);
95 use bitcoin::bech32::{Base32Len, FromBase32, ToBase32, WriteBase32, u5};
97 impl FromBase32 for PaymentSecret {
98 type Err = bech32::Error;
100 fn from_base32(field_data: &[u5]) -> Result<PaymentSecret, bech32::Error> {
101 if field_data.len() != 52 {
102 return Err(bech32::Error::InvalidLength)
104 let data_bytes = Vec::<u8>::from_base32(field_data)?;
105 let mut payment_secret = [0; 32];
106 payment_secret.copy_from_slice(&data_bytes);
107 Ok(PaymentSecret(payment_secret))
112 impl ToBase32 for PaymentSecret {
113 fn write_base32<W: WriteBase32>(&self, writer: &mut W) -> Result<(), <W as WriteBase32>::Err> {
114 (&self.0[..]).write_base32(writer)
118 impl Base32Len for PaymentSecret {
119 fn base32_len(&self) -> usize {