]> git.bitcoin.ninja Git - rust-lightning/blob - lightning/src/ln/mod.rs
5576d8bd057c84773c4e634b9fbe51f2af40028c
[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 //! High level lightning structs and impls live here.
11 //!
12 //! You probably want to create a channelmanager::ChannelManager, and a routing::NetGraphMsgHandler 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.
16 //!
17 //! When you want to open/close a channel or send a payment, call into your ChannelManager and when
18 //! you want to learn things about the network topology (eg get a route for sending a payment),
19 //! call into your NetGraphMsgHandler.
20
21 #[cfg(any(test, feature = "_test_utils"))]
22 #[macro_use]
23 pub mod functional_test_utils;
24
25 pub mod channelmanager;
26 pub mod msgs;
27 pub mod peer_handler;
28 pub mod chan_utils;
29 pub mod features;
30 pub mod script;
31
32 #[cfg(feature = "fuzztarget")]
33 pub mod peer_channel_encryptor;
34 #[cfg(not(feature = "fuzztarget"))]
35 pub(crate) mod peer_channel_encryptor;
36
37 #[cfg(feature = "fuzztarget")]
38 pub mod channel;
39 #[cfg(not(feature = "fuzztarget"))]
40 mod channel;
41
42 mod onion_utils;
43 mod wire;
44
45 // Older rustc (which we support) refuses to let us call the get_payment_preimage_hash!() macro
46 // without the node parameter being mut. This is incorrect, and thus newer rustcs will complain
47 // about an unnecessary mut. Thus, we silence the unused_mut warning in two test modules below.
48
49 #[cfg(test)]
50 #[allow(unused_mut)]
51 mod functional_tests;
52 #[cfg(test)]
53 #[allow(unused_mut)]
54 mod chanmon_update_fail_tests;
55 #[cfg(test)]
56 mod reorg_tests;
57 #[cfg(test)]
58 #[allow(unused_mut)]
59 mod onion_route_tests;
60 #[cfg(test)]
61 #[allow(unused_mut)]
62 mod monitor_tests;
63
64 pub use self::peer_channel_encryptor::LN_MAX_MSG_LEN;
65
66 /// payment_hash type, use to cross-lock hop
67 /// (C-not exported) as we just use [u8; 32] directly
68 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
69 pub struct PaymentHash(pub [u8;32]);
70 /// payment_preimage type, use to route payment between hop
71 /// (C-not exported) as we just use [u8; 32] directly
72 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
73 pub struct PaymentPreimage(pub [u8;32]);
74 /// payment_secret type, use to authenticate sender to the receiver and tie MPP HTLCs together
75 /// (C-not exported) as we just use [u8; 32] directly
76 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
77 pub struct PaymentSecret(pub [u8;32]);
78
79 use prelude::*;
80 use bitcoin::bech32;
81 use bitcoin::bech32::{Base32Len, FromBase32, ToBase32, WriteBase32, u5};
82
83 impl FromBase32 for PaymentSecret {
84         type Err = bech32::Error;
85
86         fn from_base32(field_data: &[u5]) -> Result<PaymentSecret, bech32::Error> {
87                 if field_data.len() != 52 {
88                         return Err(bech32::Error::InvalidLength)
89                 } else {
90                         let data_bytes = Vec::<u8>::from_base32(field_data)?;
91                         let mut payment_secret = [0; 32];
92                         payment_secret.copy_from_slice(&data_bytes);
93                         Ok(PaymentSecret(payment_secret))
94                 }
95         }
96 }
97
98 impl ToBase32 for PaymentSecret {
99         fn write_base32<W: WriteBase32>(&self, writer: &mut W) -> Result<(), <W as WriteBase32>::Err> {
100                 (&self.0[..]).write_base32(writer)
101         }
102 }
103
104 impl Base32Len for PaymentSecret {
105         fn base32_len(&self) -> usize {
106                 52
107         }
108 }