1 // This file is Copyright its original authors, visible in version control
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
10 #![crate_name = "lightning"]
12 //! Rust-Lightning, not Rusty's Lightning!
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.
21 #![cfg_attr(not(any(test, fuzzing, feature = "_test_utils")), deny(missing_docs))]
22 #![cfg_attr(not(any(test, fuzzing, feature = "_test_utils")), forbid(unsafe_code))]
23 #![deny(broken_intra_doc_links)]
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)]
31 #![cfg_attr(docsrs, feature(doc_auto_cfg))]
33 #![cfg_attr(all(not(feature = "std"), not(test)), no_std)]
35 #![cfg_attr(all(any(test, feature = "_test_utils"), feature = "_bench_unstable"), feature(test))]
36 #[cfg(all(any(test, feature = "_test_utils"), feature = "_bench_unstable"))] extern crate test;
38 #[cfg(not(any(feature = "std", feature = "no-std")))]
39 compile_error!("at least one of the `std` or `no-std` features must be enabled");
41 #[cfg(all(fuzzing, test))]
42 compile_error!("Tests will always fail with cfg=fuzzing");
47 #[cfg(any(test, feature = "std"))]
50 #[cfg(any(test, feature = "_test_utils"))] extern crate hex;
51 #[cfg(any(test, fuzzing, feature = "_test_utils"))] extern crate regex;
53 #[cfg(not(feature = "std"))] extern crate core2;
61 #[cfg(feature = "std")]
63 #[cfg(not(feature = "std"))]
66 #[cfg(not(feature = "std"))]
68 use core2::io::{self, Read, Write};
70 /// A writer which will move data into the void.
75 /// Creates an instance of a writer which will successfully consume all data.
76 pub const fn sink() -> Sink {
80 impl core2::io::Write for Sink {
82 fn write(&mut self, buf: &[u8]) -> core2::io::Result<usize> {
87 fn flush(&mut self) -> core2::io::Result<()> {
92 pub fn copy<R: ?Sized, W: ?Sized>(reader: &mut R, writer: &mut W) -> Result<u64, io::Error>
98 let mut buf = [0u8; 64];
101 match reader.read(&mut buf) {
103 Ok(n) => { writer.write_all(&buf[0..n])?; count += n as u64; },
104 Err(ref e) if e.kind() == io::ErrorKind::Interrupted => {},
105 Err(e) => return Err(e.into()),
111 pub fn read_to_end<D: io::Read>(mut d: D) -> Result<alloc::vec::Vec<u8>, io::Error> {
112 let mut result = vec![];
113 let mut buf = [0u8; 64];
115 match d.read(&mut buf) {
117 Ok(n) => result.extend_from_slice(&buf[0..n]),
118 Err(ref e) if e.kind() == io::ErrorKind::Interrupted => {},
119 Err(e) => return Err(e.into()),
126 #[cfg(feature = "std")]
128 pub fn read_to_end<D: ::std::io::Read>(mut d: D) -> Result<Vec<u8>, ::std::io::Error> {
129 let mut buf = Vec::new();
130 d.read_to_end(&mut buf)?;
134 pub use std::io::{copy, sink};
138 #[cfg(feature = "hashbrown")]
139 extern crate hashbrown;
141 pub use alloc::{vec, vec::Vec, string::String, collections::VecDeque, boxed::Box};
142 #[cfg(not(feature = "hashbrown"))]
143 pub use std::collections::{HashMap, HashSet, hash_map};
144 #[cfg(feature = "hashbrown")]
145 pub use self::hashbrown::{HashMap, HashSet, hash_map};
147 pub use alloc::borrow::ToOwned;
148 pub use alloc::string::ToString;
151 #[cfg(all(feature = "std", test))]
153 #[cfg(all(feature = "backtrace", feature = "std", test))]
154 extern crate backtrace;
156 #[cfg(feature = "std")]
159 pub use debug_sync::*;
161 pub use ::std::sync::{Arc, Mutex, Condvar, MutexGuard, RwLock, RwLockReadGuard};
163 pub use crate::util::fairrwlock::FairRwLock;
166 #[cfg(not(feature = "std"))]