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