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 //! 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
  24 #[cfg(fuzzing)]
  25 pub mod peer_channel_encryptor;
  26 #[cfg(not(fuzzing))]
  27 pub(crate) mod peer_channel_encryptor;
  28
  29 #[cfg(fuzzing)]
  30 pub mod channel;
  31 #[cfg(not(fuzzing))]
  32 pub(crate) mod channel;
  33
  34 pub(crate) mod onion_utils;
  35 mod outbound_payment;
  36 pub mod wire;
  37
  38 // Older rustc (which we support) refuses to let us call the get_payment_preimage_hash!() macro
  39 // without the node parameter being mut. This is incorrect, and thus newer rustcs will complain
  40 // about an unnecessary mut. Thus, we silence the unused_mut warning in two test modules below.
  41
  42 #[cfg(test)]
  43 #[allow(unused_mut)]
  44 mod functional_tests;
  45 #[cfg(test)]
  46 #[allow(unused_mut)]
  47 mod payment_tests;
  48 #[cfg(test)]
  49 #[allow(unused_mut)]
  50 mod priv_short_conf_tests;
  51 #[cfg(test)]
  52 #[allow(unused_mut)]
  53 mod chanmon_update_fail_tests;
  54 #[cfg(test)]
  55 #[allow(unused_mut)]
  56 mod reorg_tests;
  57 #[cfg(test)]
  58 #[allow(unused_mut)]
  59 mod reload_tests;
  60 #[cfg(test)]
  61 #[allow(unused_mut)]
  62 mod onion_route_tests;
  63 #[cfg(test)]
  64 #[allow(unused_mut)]
  65 mod monitor_tests;
  66 #[cfg(test)]
  67 #[allow(unused_mut)]
  68 mod shutdown_tests;
  69
  70 pub use self::peer_channel_encryptor::LN_MAX_MSG_LEN;
  71
  72 /// payment_hash type, use to cross-lock hop
  73 ///
  74 /// This is not exported to bindings users as we just use [u8; 32] directly
  75 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug, Ord, PartialOrd)]
  76 pub struct PaymentHash(pub [u8; 32]);
  77
  78 impl core::fmt::Display for PaymentHash {
  79         fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
  80                 crate::util::logger::DebugBytes(&self.0).fmt(f)
  81         }
  82 }
  83
  84 /// payment_preimage type, use to route payment between hop
  85 ///
  86 /// This is not exported to bindings users as we just use [u8; 32] directly
  87 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug, Ord, PartialOrd)]
  88 pub struct PaymentPreimage(pub [u8; 32]);
  89
  90 impl core::fmt::Display for PaymentPreimage {
  91         fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
  92                 crate::util::logger::DebugBytes(&self.0).fmt(f)
  93         }
  94 }
  95
  96 /// payment_secret type, use to authenticate sender to the receiver and tie MPP HTLCs together
  97 ///
  98 /// This is not exported to bindings users as we just use [u8; 32] directly
  99 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug, Ord, PartialOrd)]
 100 pub struct PaymentSecret(pub [u8; 32]);
 101
 102 use crate::prelude::*;
 103 use bitcoin::bech32;
 104 use bitcoin::bech32::{Base32Len, FromBase32, ToBase32, WriteBase32, u5};
 105
 106 impl FromBase32 for PaymentSecret {
 107         type Err = bech32::Error;
 108
 109         fn from_base32(field_data: &[u5]) -> Result<PaymentSecret, bech32::Error> {
 110                 if field_data.len() != 52 {
 111                         return Err(bech32::Error::InvalidLength)
 112                 } else {
 113                         let data_bytes = Vec::<u8>::from_base32(field_data)?;
 114                         let mut payment_secret = [0; 32];
 115                         payment_secret.copy_from_slice(&data_bytes);
 116                         Ok(PaymentSecret(payment_secret))
 117                 }
 118         }
 119 }
 120
 121 impl ToBase32 for PaymentSecret {
 122         fn write_base32<W: WriteBase32>(&self, writer: &mut W) -> Result<(), <W as WriteBase32>::Err> {
 123                 (&self.0[..]).write_base32(writer)
 124         }
 125 }
 126
 127 impl Base32Len for PaymentSecret {
 128         fn base32_len(&self) -> usize {
 129                 52
 130         }
 131 }