X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Fln%2Fmod.rs;h=f1ba914cabd81caeebce00f427fb0cd755504fca;hb=6bfab9d30a4ddab27f785643f2d974ffdc8371c0;hp=14864ddb53b1496b430b70e8adef530ec145ef91;hpb=2f346414ade972ca54705cf9ed774a24151144de;p=rust-lightning diff --git a/lightning/src/ln/mod.rs b/lightning/src/ln/mod.rs index 14864ddb..f1ba914c 100644 --- a/lightning/src/ln/mod.rs +++ b/lightning/src/ln/mod.rs @@ -1,18 +1,29 @@ +// This file is Copyright its original authors, visible in version control +// history. +// +// This file is licensed under the Apache License, Version 2.0 or the MIT license +// , at your option. +// You may not use this file except in accordance with one or both of these +// licenses. + //! High level lightning structs and impls live here. //! -//! You probably want to create a channelmanager::ChannelManager, and a router::Router first. +//! You probably want to create a channelmanager::ChannelManager, and a routing::NetGraphMsgHandler first. //! Then, you probably want to pass them both on to a peer_handler::PeerManager and use that to //! create/manage connections and call get_and_clear_pending_events after each action, handling //! them appropriately. //! //! When you want to open/close a channel or send a payment, call into your ChannelManager and when //! you want to learn things about the network topology (eg get a route for sending a payment), -//! call into your Router. +//! call into your NetGraphMsgHandler. + +#[cfg(any(test, feature = "_test_utils"))] +#[macro_use] +pub mod functional_test_utils; pub mod channelmanager; -pub mod channelmonitor; pub mod msgs; -pub mod router; pub mod peer_handler; pub mod chan_utils; pub mod features; @@ -26,10 +37,67 @@ mod channel; mod onion_utils; mod wire; +// Older rustc (which we support) refuses to let us call the get_payment_preimage_hash!() macro +// without the node parameter being mut. This is incorrect, and thus newer rustcs will complain +// about an unnecessary mut. Thus, we silence the unused_mut warning in two test modules below. + #[cfg(test)] -#[macro_use] -pub(crate) mod functional_test_utils; -#[cfg(test)] +#[allow(unused_mut)] mod functional_tests; #[cfg(test)] +#[allow(unused_mut)] mod chanmon_update_fail_tests; +#[cfg(test)] +mod reorg_tests; +#[cfg(test)] +#[allow(unused_mut)] +mod onion_route_tests; +#[cfg(test)] +#[allow(unused_mut)] +mod monitor_tests; + +pub use self::peer_channel_encryptor::LN_MAX_MSG_LEN; + +/// payment_hash type, use to cross-lock hop +/// (C-not exported) as we just use [u8; 32] directly +#[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)] +pub struct PaymentHash(pub [u8;32]); +/// payment_preimage type, use to route payment between hop +/// (C-not exported) as we just use [u8; 32] directly +#[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)] +pub struct PaymentPreimage(pub [u8;32]); +/// payment_secret type, use to authenticate sender to the receiver and tie MPP HTLCs together +/// (C-not exported) as we just use [u8; 32] directly +#[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)] +pub struct PaymentSecret(pub [u8;32]); + +use prelude::*; +use bitcoin::bech32; +use bitcoin::bech32::{Base32Len, FromBase32, ToBase32, WriteBase32, u5}; + +impl FromBase32 for PaymentSecret { + type Err = bech32::Error; + + fn from_base32(field_data: &[u5]) -> Result { + if field_data.len() != 52 { + return Err(bech32::Error::InvalidLength) + } else { + let data_bytes = Vec::::from_base32(field_data)?; + let mut payment_secret = [0; 32]; + payment_secret.copy_from_slice(&data_bytes); + Ok(PaymentSecret(payment_secret)) + } + } +} + +impl ToBase32 for PaymentSecret { + fn write_base32(&self, writer: &mut W) -> Result<(), ::Err> { + (&self.0[..]).write_base32(writer) + } +} + +impl Base32Len for PaymentSecret { + fn base32_len(&self) -> usize { + 52 + } +}