_ 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 //! `default` features are:
  22 //!
  23 //! * `std` - enables functionalities which require `std`, including `std::io` trait implementations and things which utilize time
  24 //! * `grind_signatures` - enables generation of [low-r bitcoin signatures](https://bitcoin.stackexchange.com/questions/111660/what-is-signature-grinding),
  25 //! which saves 1 byte per signature in 50% of the cases (see [bitcoin PR #13666](https://github.com/bitcoin/bitcoin/pull/13666))
  26 //!
  27 //! Available features are:
  28 //!
  29 //! * `std`
  30 //! * `grind_signatures`
  31 //! * `no-std ` - exposes write trait implementations from the `core2` crate (at least one of `no-std` or `std` are required)
  32 //! * Skip logging of messages at levels below the given log level:
  33 //!     * `max_level_off`
  34 //!     * `max_level_error`
  35 //!     * `max_level_warn`
  36 //!     * `max_level_info`
  37 //!     * `max_level_debug`
  38 //!     * `max_level_trace`
  39
  40 #![cfg_attr(not(any(test, fuzzing, feature = "_test_utils")), deny(missing_docs))]
  41 #![cfg_attr(not(any(test, fuzzing, feature = "_test_utils")), forbid(unsafe_code))]
  42
  43 // Prefix these with `rustdoc::` when we update our MSRV to be >= 1.52 to remove warnings.
  44 #![deny(broken_intra_doc_links)]
  45 #![deny(private_intra_doc_links)]
  46
  47 // In general, rust is absolutely horrid at supporting users doing things like,
  48 // for example, compiling Rust code for real environments. Disable useless lints
  49 // that don't do anything but annoy us and cant actually ever be resolved.
  50 #![allow(bare_trait_objects)]
  51 #![allow(ellipsis_inclusive_range_patterns)]
  52
  53 #![cfg_attr(docsrs, feature(doc_auto_cfg))]
  54
  55 #![cfg_attr(all(not(feature = "std"), not(test)), no_std)]
  56
  57 #![cfg_attr(all(any(test, feature = "_test_utils"), feature = "_bench_unstable"), feature(test))]
  58 #[cfg(all(any(test, feature = "_test_utils"), feature = "_bench_unstable"))] extern crate test;
  59
  60 #[cfg(not(any(feature = "std", feature = "no-std")))]
  61 compile_error!("at least one of the `std` or `no-std` features must be enabled");
  62
  63 #[cfg(all(fuzzing, test))]
  64 compile_error!("Tests will always fail with cfg=fuzzing");
  65
  66 #[macro_use]
  67 extern crate alloc;
  68 extern crate bitcoin;
  69 #[cfg(any(test, feature = "std"))]
  70 extern crate core;
  71
  72 #[cfg(any(test, feature = "_test_utils"))] extern crate hex;
  73 #[cfg(any(test, fuzzing, feature = "_test_utils"))] extern crate regex;
  74
  75 #[cfg(not(feature = "std"))] extern crate core2;
  76
  77 #[macro_use]
  78 pub mod util;
  79 pub mod chain;
  80 pub mod ln;
  81 pub mod offers;
  82 pub mod routing;
  83 pub mod sign;
  84 pub mod onion_message;
  85 pub mod blinded_path;
  86 pub mod events;
  87
  88 #[cfg(feature = "std")]
  89 /// Re-export of either `core2::io` or `std::io`, depending on the `std` feature flag.
  90 pub use std::io;
  91 #[cfg(not(feature = "std"))]
  92 /// Re-export of either `core2::io` or `std::io`, depending on the `std` feature flag.
  93 pub use core2::io;
  94
  95 #[cfg(not(feature = "std"))]
  96 mod io_extras {
  97         use core2::io::{self, Read, Write};
  98
  99         /// A writer which will move data into the void.
 100         pub struct Sink {
 101                 _priv: (),
 102         }
 103
 104         /// Creates an instance of a writer which will successfully consume all data.
 105         pub const fn sink() -> Sink {
 106                 Sink { _priv: () }
 107         }
 108
 109         impl core2::io::Write for Sink {
 110                 #[inline]
 111                 fn write(&mut self, buf: &[u8]) -> core2::io::Result<usize> {
 112                         Ok(buf.len())
 113                 }
 114
 115                 #[inline]
 116                 fn flush(&mut self) -> core2::io::Result<()> {
 117                         Ok(())
 118                 }
 119         }
 120
 121         pub fn copy<R: ?Sized, W: ?Sized>(reader: &mut R, writer: &mut W) -> Result<u64, io::Error>
 122                 where
 123                 R: Read,
 124                 W: Write,
 125         {
 126                 let mut count = 0;
 127                 let mut buf = [0u8; 64];
 128
 129                 loop {
 130                         match reader.read(&mut buf) {
 131                                 Ok(0) => break,
 132                                 Ok(n) => { writer.write_all(&buf[0..n])?; count += n as u64; },
 133                                 Err(ref e) if e.kind() == io::ErrorKind::Interrupted => {},
 134                                 Err(e) => return Err(e.into()),
 135                         };
 136                 }
 137                 Ok(count)
 138         }
 139
 140         pub fn read_to_end<D: io::Read>(mut d: D) -> Result<alloc::vec::Vec<u8>, io::Error> {
 141                 let mut result = vec![];
 142                 let mut buf = [0u8; 64];
 143                 loop {
 144                         match d.read(&mut buf) {
 145                                 Ok(0) => break,
 146                                 Ok(n) => result.extend_from_slice(&buf[0..n]),
 147                                 Err(ref e) if e.kind() == io::ErrorKind::Interrupted => {},
 148                                 Err(e) => return Err(e.into()),
 149                         };
 150                 }
 151                 Ok(result)
 152         }
 153 }
 154
 155 #[cfg(feature = "std")]
 156 mod io_extras {
 157         pub fn read_to_end<D: ::std::io::Read>(mut d: D) -> Result<Vec<u8>, ::std::io::Error> {
 158                 let mut buf = Vec::new();
 159                 d.read_to_end(&mut buf)?;
 160                 Ok(buf)
 161         }
 162
 163         pub use std::io::{copy, sink};
 164 }
 165
 166 mod prelude {
 167         #[cfg(feature = "hashbrown")]
 168         extern crate hashbrown;
 169
 170         pub use alloc::{vec, vec::Vec, string::String, collections::VecDeque, boxed::Box};
 171         #[cfg(not(feature = "hashbrown"))]
 172         pub use std::collections::{HashMap, HashSet, hash_map};
 173         #[cfg(feature = "hashbrown")]
 174         pub use self::hashbrown::{HashMap, HashSet, hash_map};
 175
 176         pub use alloc::borrow::ToOwned;
 177         pub use alloc::string::ToString;
 178 }
 179
 180 #[cfg(all(not(feature = "_bench_unstable"), feature = "backtrace", feature = "std", test))]
 181 extern crate backtrace;
 182
 183 mod sync;