_ 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(any(test, feature = "_test_utils"), feature = "unstable"), feature(test))]
  32 #[cfg(all(any(test, feature = "_test_utils"), feature = "unstable"))] extern crate test;
  33
  34 extern crate alloc;
  35 extern crate bitcoin;
  36 extern crate core;
  37 #[cfg(any(test, feature = "_test_utils"))] extern crate hex;
  38 #[cfg(any(test, feature = "fuzztarget", feature = "_test_utils"))] extern crate regex;
  39
  40 #[macro_use]
  41 pub mod util;
  42 pub mod chain;
  43 pub mod ln;
  44 pub mod routing;
  45
  46 mod prelude {
  47         #[cfg(feature = "hashbrown")]
  48         extern crate hashbrown;
  49
  50         pub use alloc::{vec, vec::Vec, string::String, collections::VecDeque};
  51         #[cfg(not(feature = "hashbrown"))]
  52         pub use std::collections::{HashMap, HashSet, hash_map};
  53         #[cfg(feature = "hashbrown")]
  54         pub use self::hashbrown::{HashMap, HashSet, hash_map};
  55 }