]> git.bitcoin.ninja Git - rust-lightning/blob - lightning/src/ln/mod.rs
Add ShutdownScript for BOLT 2 acceptable scripts
[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 mod channel;
38 mod onion_utils;
39 mod wire;
40
41 // Older rustc (which we support) refuses to let us call the get_payment_preimage_hash!() macro
42 // without the node parameter being mut. This is incorrect, and thus newer rustcs will complain
43 // about an unnecessary mut. Thus, we silence the unused_mut warning in two test modules below.
44
45 #[cfg(test)]
46 #[allow(unused_mut)]
47 mod functional_tests;
48 #[cfg(test)]
49 #[allow(unused_mut)]
50 mod chanmon_update_fail_tests;
51 #[cfg(test)]
52 mod reorg_tests;
53 #[cfg(test)]
54 #[allow(unused_mut)]
55 mod onion_route_tests;
56
57 pub use self::peer_channel_encryptor::LN_MAX_MSG_LEN;
58
59 /// payment_hash type, use to cross-lock hop
60 /// (C-not exported) as we just use [u8; 32] directly
61 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
62 pub struct PaymentHash(pub [u8;32]);
63 /// payment_preimage type, use to route payment between hop
64 /// (C-not exported) as we just use [u8; 32] directly
65 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
66 pub struct PaymentPreimage(pub [u8;32]);
67 /// payment_secret type, use to authenticate sender to the receiver and tie MPP HTLCs together
68 /// (C-not exported) as we just use [u8; 32] directly
69 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
70 pub struct PaymentSecret(pub [u8;32]);
71
72 use prelude::*;
73 use bitcoin::bech32;
74 use bitcoin::bech32::{Base32Len, FromBase32, ToBase32, WriteBase32, u5};
75
76 impl FromBase32 for PaymentSecret {
77         type Err = bech32::Error;
78
79         fn from_base32(field_data: &[u5]) -> Result<PaymentSecret, bech32::Error> {
80                 if field_data.len() != 52 {
81                         return Err(bech32::Error::InvalidLength)
82                 } else {
83                         let data_bytes = Vec::<u8>::from_base32(field_data)?;
84                         let mut payment_secret = [0; 32];
85                         payment_secret.copy_from_slice(&data_bytes);
86                         Ok(PaymentSecret(payment_secret))
87                 }
88         }
89 }
90
91 impl ToBase32 for PaymentSecret {
92         fn write_base32<W: WriteBase32>(&self, writer: &mut W) -> Result<(), <W as WriteBase32>::Err> {
93                 (&self.0[..]).write_base32(writer)
94         }
95 }
96
97 impl Base32Len for PaymentSecret {
98         fn base32_len(&self) -> usize {
99                 52
100         }
101 }