X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Flib.rs;h=9bc158328701562954555286e18b0093ea14084b;hb=d1c2e143fe014256ddc4ccf8aa0ec29b38205b19;hp=1088063540c97f51e03d0bcebbcde1773fb83970;hpb=002a5db5b07fd317545d3aa4f1a217cd40b608e2;p=rust-lightning diff --git a/lightning/src/lib.rs b/lightning/src/lib.rs index 10880635..9bc15832 100644 --- a/lightning/src/lib.rs +++ b/lightning/src/lib.rs @@ -17,10 +17,31 @@ //! figure out how best to make networking happen/timers fire/things get written to disk/keys get //! generated/etc. This makes it a good candidate for tight integration into an existing wallet //! instead of having a rather-separate lightning appendage to a wallet. +//! +//! `default` features are: +//! +//! * `std` - enables functionalities which require `std`, including `std::io` trait implementations and things which utilize time +//! * `grind_signatures` - enables generation of [low-r bitcoin signatures](https://bitcoin.stackexchange.com/questions/111660/what-is-signature-grinding), +//! which saves 1 byte per signature in 50% of the cases (see [bitcoin PR #13666](https://github.com/bitcoin/bitcoin/pull/13666)) +//! +//! Available features are: +//! +//! * `std` +//! * `grind_signatures` +//! * `no-std ` - exposes write trait implementations from the `core2` crate (at least one of `no-std` or `std` are required) +//! * Skip logging of messages at levels below the given log level: +//! * `max_level_off` +//! * `max_level_error` +//! * `max_level_warn` +//! * `max_level_info` +//! * `max_level_debug` +//! * `max_level_trace` + +#![cfg_attr(not(any(test, fuzzing, feature = "_test_utils")), deny(missing_docs))] +#![cfg_attr(not(any(test, feature = "_test_utils")), forbid(unsafe_code))] -#![cfg_attr(not(any(feature = "fuzztarget", feature = "_test_utils")), deny(missing_docs))] -#![cfg_attr(not(any(test, feature = "fuzztarget", feature = "_test_utils")), forbid(unsafe_code))] -#![deny(broken_intra_doc_links)] +#![deny(rustdoc::broken_intra_doc_links)] +#![deny(rustdoc::private_intra_doc_links)] // In general, rust is absolutely horrid at supporting users doing things like, // for example, compiling Rust code for real environments. Disable useless lints @@ -28,32 +49,232 @@ #![allow(bare_trait_objects)] #![allow(ellipsis_inclusive_range_patterns)] -#![cfg_attr(all(any(test, feature = "_test_utils"), feature = "unstable"), feature(test))] -#[cfg(all(any(test, feature = "_test_utils"), feature = "unstable"))] extern crate test; +#![cfg_attr(docsrs, feature(doc_auto_cfg))] + +#![cfg_attr(all(not(feature = "std"), not(test)), no_std)] +#[cfg(not(any(feature = "std", feature = "no-std")))] +compile_error!("at least one of the `std` or `no-std` features must be enabled"); + +#[cfg(all(fuzzing, test))] +compile_error!("Tests will always fail with cfg=fuzzing"); + +#[macro_use] extern crate alloc; extern crate bitcoin; +#[cfg(any(test, feature = "std"))] extern crate core; -#[cfg(any(test, feature = "_test_utils"))] extern crate hex; -#[cfg(any(test, feature = "fuzztarget", feature = "_test_utils"))] extern crate regex; + +extern crate hex; +#[cfg(any(test, feature = "_test_utils"))] extern crate regex; + +#[cfg(not(feature = "std"))] extern crate core2; +#[cfg(not(feature = "std"))] extern crate libm; + +#[cfg(ldk_bench)] extern crate criterion; #[macro_use] pub mod util; pub mod chain; pub mod ln; +pub mod offers; pub mod routing; +pub mod sign; +pub mod onion_message; +pub mod blinded_path; +pub mod events; + +pub(crate) mod crypto; + +#[cfg(feature = "std")] +/// Re-export of either `core2::io` or `std::io`, depending on the `std` feature flag. +pub use std::io; +#[cfg(not(feature = "std"))] +/// Re-export of either `core2::io` or `std::io`, depending on the `std` feature flag. +pub use core2::io; + +#[cfg(not(feature = "std"))] +mod io_extras { + use core2::io::{self, Read, Write}; + + /// A writer which will move data into the void. + pub struct Sink { + _priv: (), + } + + /// Creates an instance of a writer which will successfully consume all data. + pub const fn sink() -> Sink { + Sink { _priv: () } + } + + impl core2::io::Write for Sink { + #[inline] + fn write(&mut self, buf: &[u8]) -> core2::io::Result { + Ok(buf.len()) + } + + #[inline] + fn flush(&mut self) -> core2::io::Result<()> { + Ok(()) + } + } + + pub fn copy(reader: &mut R, writer: &mut W) -> Result + where + R: Read, + W: Write, + { + let mut count = 0; + let mut buf = [0u8; 64]; + + loop { + match reader.read(&mut buf) { + Ok(0) => break, + Ok(n) => { writer.write_all(&buf[0..n])?; count += n as u64; }, + Err(ref e) if e.kind() == io::ErrorKind::Interrupted => {}, + Err(e) => return Err(e.into()), + }; + } + Ok(count) + } + + pub fn read_to_end(mut d: D) -> Result, io::Error> { + let mut result = vec![]; + let mut buf = [0u8; 64]; + loop { + match d.read(&mut buf) { + Ok(0) => break, + Ok(n) => result.extend_from_slice(&buf[0..n]), + Err(ref e) if e.kind() == io::ErrorKind::Interrupted => {}, + Err(e) => return Err(e.into()), + }; + } + Ok(result) + } +} + +#[cfg(feature = "std")] +mod io_extras { + pub fn read_to_end(mut d: D) -> Result, ::std::io::Error> { + let mut buf = Vec::new(); + d.read_to_end(&mut buf)?; + Ok(buf) + } + + pub use std::io::{copy, sink}; +} mod prelude { #[cfg(feature = "hashbrown")] extern crate hashbrown; + #[cfg(feature = "ahash")] + extern crate ahash; + + pub use alloc::{vec, vec::Vec, string::String, collections::VecDeque, boxed::Box}; + + pub use alloc::borrow::ToOwned; + pub use alloc::string::ToString; + + // For no-std builds, we need to use hashbrown, however, by default, it doesn't randomize the + // hashing and is vulnerable to HashDoS attacks. Thus, when not fuzzing, we use its default + // ahash hashing algorithm but randomize, opting to not randomize when fuzzing to avoid false + // positive branch coverage. - pub use alloc::{vec, vec::Vec, string::String, collections::VecDeque}; #[cfg(not(feature = "hashbrown"))] - pub use std::collections::{HashMap, HashSet, hash_map}; + mod std_hashtables { + pub(crate) use std::collections::{HashMap, HashSet, hash_map}; + + pub(crate) type OccupiedHashMapEntry<'a, K, V> = + std::collections::hash_map::OccupiedEntry<'a, K, V>; + pub(crate) type VacantHashMapEntry<'a, K, V> = + std::collections::hash_map::VacantEntry<'a, K, V>; + } + #[cfg(not(feature = "hashbrown"))] + pub(crate) use std_hashtables::*; + #[cfg(feature = "hashbrown")] - pub use self::hashbrown::{HashMap, HashSet, hash_map}; -} + pub(crate) use self::hashbrown::hash_map; + + #[cfg(all(feature = "hashbrown", fuzzing))] + mod nonrandomized_hashbrown { + pub(crate) use hashbrown::{HashMap, HashSet}; + + pub(crate) type OccupiedHashMapEntry<'a, K, V> = + hashbrown::hash_map::OccupiedEntry<'a, K, V, hashbrown::hash_map::DefaultHashBuilder>; + pub(crate) type VacantHashMapEntry<'a, K, V> = + hashbrown::hash_map::VacantEntry<'a, K, V, hashbrown::hash_map::DefaultHashBuilder>; + } + #[cfg(all(feature = "hashbrown", fuzzing))] + pub(crate) use nonrandomized_hashbrown::*; -mod sync { - pub use ::std::sync::{Arc, Mutex, Condvar, MutexGuard, RwLock, RwLockReadGuard}; + + #[cfg(all(feature = "hashbrown", not(fuzzing)))] + mod randomized_hashtables { + use super::*; + use ahash::RandomState; + + pub(crate) type HashMap = hashbrown::HashMap; + pub(crate) type HashSet = hashbrown::HashSet; + + pub(crate) type OccupiedHashMapEntry<'a, K, V> = + hashbrown::hash_map::OccupiedEntry<'a, K, V, RandomState>; + pub(crate) type VacantHashMapEntry<'a, K, V> = + hashbrown::hash_map::VacantEntry<'a, K, V, RandomState>; + + pub(crate) fn new_hash_map() -> HashMap { + HashMap::with_hasher(RandomState::new()) + } + pub(crate) fn hash_map_with_capacity(cap: usize) -> HashMap { + HashMap::with_capacity_and_hasher(cap, RandomState::new()) + } + pub(crate) fn hash_map_from_iter>(iter: I) -> HashMap { + let iter = iter.into_iter(); + let min_size = iter.size_hint().0; + let mut res = HashMap::with_capacity_and_hasher(min_size, RandomState::new()); + res.extend(iter); + res + } + + pub(crate) fn new_hash_set() -> HashSet { + HashSet::with_hasher(RandomState::new()) + } + pub(crate) fn hash_set_with_capacity(cap: usize) -> HashSet { + HashSet::with_capacity_and_hasher(cap, RandomState::new()) + } + pub(crate) fn hash_set_from_iter>(iter: I) -> HashSet { + let iter = iter.into_iter(); + let min_size = iter.size_hint().0; + let mut res = HashSet::with_capacity_and_hasher(min_size, RandomState::new()); + res.extend(iter); + res + } + } + + #[cfg(any(not(feature = "hashbrown"), fuzzing))] + mod randomized_hashtables { + use super::*; + + pub(crate) fn new_hash_map() -> HashMap { HashMap::new() } + pub(crate) fn hash_map_with_capacity(cap: usize) -> HashMap { + HashMap::with_capacity(cap) + } + pub(crate) fn hash_map_from_iter>(iter: I) -> HashMap { + HashMap::from_iter(iter) + } + + pub(crate) fn new_hash_set() -> HashSet { HashSet::new() } + pub(crate) fn hash_set_with_capacity(cap: usize) -> HashSet { + HashSet::with_capacity(cap) + } + pub(crate) fn hash_set_from_iter>(iter: I) -> HashSet { + HashSet::from_iter(iter) + } + } + + pub(crate) use randomized_hashtables::*; } + +#[cfg(all(not(ldk_bench), feature = "backtrace", feature = "std", test))] +extern crate backtrace; + +mod sync;