_ Git - rust-lightning/blob - lightning/src/lib.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 #![crate_name = "lightning"]
  11
  12 //! Rust-Lightning, not Rusty's Lightning!
  13 //!
  14 //! A full-featured but also flexible lightning implementation, in library form. This allows the
  15 //! user (you) to decide how they wish to use it instead of being a fully self-contained daemon.
  16 //! This means there is no built-in threading/execution environment and it's up to the user to
  17 //! figure out how best to make networking happen/timers fire/things get written to disk/keys get
  18 //! generated/etc. This makes it a good candidate for tight integration into an existing wallet
  19 //! instead of having a rather-separate lightning appendage to a wallet.
  20
  21 #![cfg_attr(not(any(feature = "fuzztarget", feature = "_test_utils")), deny(missing_docs))]
  22 #![cfg_attr(not(any(test, feature = "fuzztarget", feature = "_test_utils")), forbid(unsafe_code))]
  23 #![deny(broken_intra_doc_links)]
  24
  25 // In general, rust is absolutely horrid at supporting users doing things like,
  26 // for example, compiling Rust code for real environments. Disable useless lints
  27 // that don't do anything but annoy us and cant actually ever be resolved.
  28 #![allow(bare_trait_objects)]
  29 #![allow(ellipsis_inclusive_range_patterns)]
  30
  31 #![cfg_attr(all(not(feature = "std"), not(test)), no_std)]
  32
  33 #![cfg_attr(all(any(test, feature = "_test_utils"), feature = "unstable"), feature(test))]
  34 #[cfg(all(any(test, feature = "_test_utils"), feature = "unstable"))] extern crate test;
  35
  36 #[cfg(not(any(feature = "std", feature = "no_std")))]
  37 compile_error!("at least one of the `std` or `no_std` features must be enabled");
  38
  39 #[macro_use]
  40 extern crate alloc;
  41 extern crate bitcoin;
  42 #[cfg(any(test, feature = "std"))]
  43 extern crate core;
  44
  45 #[cfg(any(test, feature = "_test_utils"))] extern crate hex;
  46 #[cfg(any(test, feature = "fuzztarget", feature = "_test_utils"))] extern crate regex;
  47
  48 #[cfg(not(feature = "std"))] extern crate core2;
  49
  50 #[macro_use]
  51 pub mod util;
  52 pub mod chain;
  53 pub mod ln;
  54 pub mod routing;
  55
  56 #[cfg(feature = "std")]
  57 use std::io;
  58 #[cfg(not(feature = "std"))]
  59 use core2::io;
  60
  61 #[cfg(not(feature = "std"))]
  62 mod io_extras {
  63         use core2::io::{self, Read, Write};
  64
  65         /// A writer which will move data into the void.
  66         pub struct Sink {
  67                 _priv: (),
  68         }
  69
  70         /// Creates an instance of a writer which will successfully consume all data.
  71         pub const fn sink() -> Sink {
  72                 Sink { _priv: () }
  73         }
  74
  75         impl core2::io::Write for Sink {
  76                 #[inline]
  77                 fn write(&mut self, buf: &[u8]) -> core2::io::Result<usize> {
  78                         Ok(buf.len())
  79                 }
  80
  81                 #[inline]
  82                 fn flush(&mut self) -> core2::io::Result<()> {
  83                         Ok(())
  84                 }
  85         }
  86
  87         pub fn copy<R: ?Sized, W: ?Sized>(reader: &mut R, writer: &mut W) -> Result<u64, io::Error>
  88                 where
  89                 R: Read,
  90                 W: Write,
  91         {
  92                 let mut count = 0;
  93                 let mut buf = [0u8; 64];
  94
  95                 loop {
  96                         match reader.read(&mut buf) {
  97                                 Ok(0) => break,
  98                                 Ok(n) => { writer.write_all(&buf[0..n])?; count += n as u64; },
  99                                 Err(ref e) if e.kind() == io::ErrorKind::Interrupted => {},
 100                                 Err(e) => return Err(e.into()),
 101                         };
 102                 }
 103                 Ok(count)
 104         }
 105
 106         pub fn read_to_end<D: io::Read>(mut d: D) -> Result<alloc::vec::Vec<u8>, io::Error> {
 107                 let mut result = vec![];
 108                 let mut buf = [0u8; 64];
 109                 loop {
 110                         match d.read(&mut buf) {
 111                                 Ok(0) => break,
 112                                 Ok(n) => result.extend_from_slice(&buf[0..n]),
 113                                 Err(ref e) if e.kind() == io::ErrorKind::Interrupted => {},
 114                                 Err(e) => return Err(e.into()),
 115                         };
 116                 }
 117                 Ok(result)
 118         }
 119 }
 120
 121 #[cfg(feature = "std")]
 122 mod io_extras {
 123         pub fn read_to_end<D: ::std::io::Read>(mut d: D) -> Result<Vec<u8>, ::std::io::Error> {
 124                 let mut buf = Vec::new();
 125                 d.read_to_end(&mut buf)?;
 126                 Ok(buf)
 127         }
 128
 129         pub use std::io::{copy, sink};
 130 }
 131
 132 mod prelude {
 133         #[cfg(feature = "hashbrown")]
 134         extern crate hashbrown;
 135
 136         pub use alloc::{vec, vec::Vec, string::String, collections::VecDeque, boxed::Box};
 137         #[cfg(not(feature = "hashbrown"))]
 138         pub use std::collections::{HashMap, HashSet, hash_map};
 139         #[cfg(feature = "hashbrown")]
 140         pub use self::hashbrown::{HashMap, HashSet, hash_map};
 141
 142         pub use alloc::borrow::ToOwned;
 143         pub use alloc::string::ToString;
 144 }
 145
 146 #[cfg(feature = "std")]
 147 mod sync {
 148         pub use ::std::sync::{Arc, Mutex, Condvar, MutexGuard, RwLock, RwLockReadGuard};
 149 }
 150
 151 #[cfg(not(feature = "std"))]
 152 mod sync;