]> git.bitcoin.ninja Git - rust-lightning/blob - lightning/src/ln/mod.rs
Merge pull request #2575 from tnull/2023-09-fix-debug-panic
[rust-lightning] / lightning / src / ln / mod.rs
1 // This file is Copyright its original authors, visible in version control
2 // history.
3 //
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
8 // licenses.
9
10 //! Implementations of various parts of the Lightning protocol are in this module.
11
12 #[cfg(any(test, feature = "_test_utils"))]
13 #[macro_use]
14 pub mod functional_test_utils;
15
16 pub mod channelmanager;
17 pub mod inbound_payment;
18 pub mod msgs;
19 pub mod peer_handler;
20 pub mod chan_utils;
21 pub mod features;
22 pub mod script;
23 mod channel_id;
24
25 #[cfg(fuzzing)]
26 pub mod peer_channel_encryptor;
27 #[cfg(not(fuzzing))]
28 pub(crate) mod peer_channel_encryptor;
29
30 #[cfg(fuzzing)]
31 pub mod channel;
32 #[cfg(not(fuzzing))]
33 pub(crate) mod channel;
34
35 // Re-export ChannelId
36 pub use channel_id::ChannelId;
37
38 pub(crate) mod onion_utils;
39 mod outbound_payment;
40 pub mod wire;
41
42 // Older rustc (which we support) refuses to let us call the get_payment_preimage_hash!() macro
43 // without the node parameter being mut. This is incorrect, and thus newer rustcs will complain
44 // about an unnecessary mut. Thus, we silence the unused_mut warning in two test modules below.
45
46 #[cfg(test)]
47 #[allow(unused_mut)]
48 mod blinded_payment_tests;
49 #[cfg(test)]
50 #[allow(unused_mut)]
51 mod functional_tests;
52 #[cfg(test)]
53 #[allow(unused_mut)]
54 mod payment_tests;
55 #[cfg(test)]
56 #[allow(unused_mut)]
57 mod priv_short_conf_tests;
58 #[cfg(test)]
59 #[allow(unused_mut)]
60 mod chanmon_update_fail_tests;
61 #[cfg(test)]
62 #[allow(unused_mut)]
63 mod reorg_tests;
64 #[cfg(test)]
65 #[allow(unused_mut)]
66 mod reload_tests;
67 #[cfg(test)]
68 #[allow(unused_mut)]
69 mod onion_route_tests;
70 #[cfg(test)]
71 #[allow(unused_mut)]
72 mod monitor_tests;
73 #[cfg(test)]
74 #[allow(unused_mut)]
75 mod shutdown_tests;
76
77 pub use self::peer_channel_encryptor::LN_MAX_MSG_LEN;
78
79 /// payment_hash type, use to cross-lock hop
80 ///
81 /// This is not exported to bindings users as we just use [u8; 32] directly
82 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug, Ord, PartialOrd)]
83 pub struct PaymentHash(pub [u8; 32]);
84
85 impl core::fmt::Display for PaymentHash {
86         fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
87                 crate::util::logger::DebugBytes(&self.0).fmt(f)
88         }
89 }
90
91 /// payment_preimage type, use to route payment between hop
92 ///
93 /// This is not exported to bindings users as we just use [u8; 32] directly
94 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug, Ord, PartialOrd)]
95 pub struct PaymentPreimage(pub [u8; 32]);
96
97 impl core::fmt::Display for PaymentPreimage {
98         fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
99                 crate::util::logger::DebugBytes(&self.0).fmt(f)
100         }
101 }
102
103 /// payment_secret type, use to authenticate sender to the receiver and tie MPP HTLCs together
104 ///
105 /// This is not exported to bindings users as we just use [u8; 32] directly
106 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug, Ord, PartialOrd)]
107 pub struct PaymentSecret(pub [u8; 32]);
108
109 use crate::prelude::*;
110 use bitcoin::bech32;
111 use bitcoin::bech32::{Base32Len, FromBase32, ToBase32, WriteBase32, u5};
112
113 impl FromBase32 for PaymentSecret {
114         type Err = bech32::Error;
115
116         fn from_base32(field_data: &[u5]) -> Result<PaymentSecret, bech32::Error> {
117                 if field_data.len() != 52 {
118                         return Err(bech32::Error::InvalidLength)
119                 } else {
120                         let data_bytes = Vec::<u8>::from_base32(field_data)?;
121                         let mut payment_secret = [0; 32];
122                         payment_secret.copy_from_slice(&data_bytes);
123                         Ok(PaymentSecret(payment_secret))
124                 }
125         }
126 }
127
128 impl ToBase32 for PaymentSecret {
129         fn write_base32<W: WriteBase32>(&self, writer: &mut W) -> Result<(), <W as WriteBase32>::Err> {
130                 (&self.0[..]).write_base32(writer)
131         }
132 }
133
134 impl Base32Len for PaymentSecret {
135         fn base32_len(&self) -> usize {
136                 52
137         }
138 }