]> git.bitcoin.ninja Git - ldk-c-bindings/blob - lightning-c-bindings/src/lightning/mod.rs
Merge pull request #103 from TheBlueMatt/main
[ldk-c-bindings] / lightning-c-bindings / src / lightning / mod.rs
1 // This file is Copyright its original authors, visible in version control
2 // history and in the source files from which this was generated.
3 //
4 // This file is licensed under the license available in the LICENSE or LICENSE.md
5 // file in the root of this repository or, if no such file exists, the same
6 // license as that which applies to the original source files from which this
7 // source was automatically generated.
8
9 //!lightning
10 //! Rust-Lightning, not Rusty's Lightning!
11 //!
12 //! A full-featured but also flexible lightning implementation, in library form. This allows the
13 //! user (you) to decide how they wish to use it instead of being a fully self-contained daemon.
14 //! This means there is no built-in threading/execution environment and it's up to the user to
15 //! figure out how best to make networking happen/timers fire/things get written to disk/keys get
16 //! generated/etc. This makes it a good candidate for tight integration into an existing wallet
17 //! instead of having a rather-separate lightning appendage to a wallet.
18 //!
19 //! `default` features are:
20 //!
21 //! * `std` - enables functionalities which require `std`, including `std::io` trait implementations and things which utilize time
22 //! * `grind_signatures` - enables generation of [low-r bitcoin signatures](https://bitcoin.stackexchange.com/questions/111660/what-is-signature-grinding),
23 //! which saves 1 byte per signature in 50% of the cases (see [bitcoin PR #13666](https://github.com/bitcoin/bitcoin/pull/13666))
24 //!
25 //! Available features are:
26 //!
27 //! * `std`
28 //! * `grind_signatures`
29 //! * `no-std ` - exposes write trait implementations from the `core2` crate (at least one of `no-std` or `std` are required)
30 //! * Skip logging of messages at levels below the given log level:
31 //!     * `max_level_off`
32 //!     * `max_level_error`
33 //!     * `max_level_warn`
34 //!     * `max_level_info`
35 //!     * `max_level_debug`
36 //!     * `max_level_trace`
37
38 use alloc::str::FromStr;
39 use core::ffi::c_void;
40 use core::convert::Infallible;
41 use bitcoin::hashes::Hash;
42 use crate::c_types::*;
43 #[cfg(feature="no-std")]
44 use alloc::{vec::Vec, boxed::Box};
45
46 pub mod util;
47 pub mod chain;
48 pub mod ln;
49 pub mod offers;
50 pub mod routing;
51 pub mod onion_message;
52 pub mod blinded_path;
53 pub mod events;
54 mod io_extras {
55
56 use alloc::str::FromStr;
57 use core::ffi::c_void;
58 use core::convert::Infallible;
59 use bitcoin::hashes::Hash;
60 use crate::c_types::*;
61 #[cfg(feature="no-std")]
62 use alloc::{vec::Vec, boxed::Box};
63
64 }
65 mod prelude {
66
67 use alloc::str::FromStr;
68 use core::ffi::c_void;
69 use core::convert::Infallible;
70 use bitcoin::hashes::Hash;
71 use crate::c_types::*;
72 #[cfg(feature="no-std")]
73 use alloc::{vec::Vec, boxed::Box};
74
75 }
76 mod sync {
77
78 use alloc::str::FromStr;
79 use core::ffi::c_void;
80 use core::convert::Infallible;
81 use bitcoin::hashes::Hash;
82 use crate::c_types::*;
83 #[cfg(feature="no-std")]
84 use alloc::{vec::Vec, boxed::Box};
85
86 mod fairrwlock {
87
88 use alloc::str::FromStr;
89 use core::ffi::c_void;
90 use core::convert::Infallible;
91 use bitcoin::hashes::Hash;
92 use crate::c_types::*;
93 #[cfg(feature="no-std")]
94 use alloc::{vec::Vec, boxed::Box};
95
96 }
97 mod ext_impl {
98
99 use alloc::str::FromStr;
100 use core::ffi::c_void;
101 use core::convert::Infallible;
102 use bitcoin::hashes::Hash;
103 use crate::c_types::*;
104 #[cfg(feature="no-std")]
105 use alloc::{vec::Vec, boxed::Box};
106
107 }
108 }