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 //! Implementations of various parts of the Lightning protocol are in this module.
12 #[cfg(any(test, feature = "_test_utils"))]
14 pub mod functional_test_utils;
16 pub mod channelmanager;
17 pub mod inbound_payment;
26 pub mod peer_channel_encryptor;
28 pub(crate) mod peer_channel_encryptor;
33 pub(crate) mod channel;
35 // Re-export ChannelId
36 pub use channel_id::ChannelId;
38 pub(crate) mod onion_utils;
42 pub use onion_utils::create_payment_onion;
43 // Older rustc (which we support) refuses to let us call the get_payment_preimage_hash!() macro
44 // without the node parameter being mut. This is incorrect, and thus newer rustcs will complain
45 // about an unnecessary mut. Thus, we silence the unused_mut warning in two test modules below.
49 mod blinded_payment_tests;
58 mod priv_short_conf_tests;
61 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
82 /// This is not exported to bindings users as we just use [u8; 32] directly
83 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug, Ord, PartialOrd)]
84 pub struct PaymentHash(pub [u8; 32]);
86 impl core::fmt::Display for PaymentHash {
87 fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
88 crate::util::logger::DebugBytes(&self.0).fmt(f)
92 /// payment_preimage type, use to route payment between hop
94 /// This is not exported to bindings users as we just use [u8; 32] directly
95 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug, Ord, PartialOrd)]
96 pub struct PaymentPreimage(pub [u8; 32]);
98 impl core::fmt::Display for PaymentPreimage {
99 fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
100 crate::util::logger::DebugBytes(&self.0).fmt(f)
104 /// payment_secret type, use to authenticate sender to the receiver and tie MPP HTLCs together
106 /// This is not exported to bindings users as we just use [u8; 32] directly
107 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug, Ord, PartialOrd)]
108 pub struct PaymentSecret(pub [u8; 32]);
110 use crate::prelude::*;
112 use bitcoin::bech32::{Base32Len, FromBase32, ToBase32, WriteBase32, u5};
114 impl FromBase32 for PaymentSecret {
115 type Err = bech32::Error;
117 fn from_base32(field_data: &[u5]) -> Result<PaymentSecret, bech32::Error> {
118 if field_data.len() != 52 {
119 return Err(bech32::Error::InvalidLength)
121 let data_bytes = Vec::<u8>::from_base32(field_data)?;
122 let mut payment_secret = [0; 32];
123 payment_secret.copy_from_slice(&data_bytes);
124 Ok(PaymentSecret(payment_secret))
129 impl ToBase32 for PaymentSecret {
130 fn write_base32<W: WriteBase32>(&self, writer: &mut W) -> Result<(), <W as WriteBase32>::Err> {
131 (&self.0[..]).write_base32(writer)
135 impl Base32Len for PaymentSecret {
136 fn base32_len(&self) -> usize {