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