@@ -5,17 +5,19 @@ Rust-Lightning
5
5
[ ![ Documentation] ( https://img.shields.io/static/v1?logo=read-the-docs&label=docs.rs&message=lightning&color=informational )] ( https://docs.rs/lightning/ )
6
6
[ ![ Safety Dance] ( https://img.shields.io/badge/unsafe-forbidden-success.svg )] ( https://github.com/rust-secure-code/safety-dance/ )
7
7
8
- [ LDK] ( lightningdevkit.org ) /` rust-lightning ` is a highly performant implementation of the Lightning
9
- Network protocol, with support for custom data persistence, chain sync, and much more .
8
+ [ LDK] ( lightningdevkit.org ) /` rust-lightning ` is a highly performant and flexible implementation of
9
+ the Lightning Network protocol .
10
10
11
- The main crate, ` lightning ` , does not handle networking, persistence, or any other I/O. Thus, it is
12
- runtime-agnostic, but users must plug in networking logic, chain interactions, and disk storage.
11
+ The main crate, ` lightning ` is runtime-agnostic. Data persistence, chain interactions, and
12
+ networking can be provided by LDK's [ sample modules] ( ./README.md#crates ) , or custom implementations
13
+ may be provided by the user.
13
14
More information is available in the [ ` About ` ] ( ./README.md#about ) section.
14
15
15
16
Status
16
17
------
17
18
The project implements all of the [ BOLT specifications] ( https://github.com/lightning/bolts ) ,
18
- and has been in production use since 2021.
19
+ and has been in production use since 2021. As with any lightning implementation, care and attention
20
+ to detail is important for safe deployment.
19
21
20
22
Communications for ` rust-lightning ` and Lightning Development Kit happen through
21
23
our LDK [ Discord] ( https://discord.gg/5AcknnMfBw ) channels.
50
52
LDK/` rust-lightning ` is a generic library which allows you to build a Lightning
51
53
node without needing to worry about getting all of the Lightning state machine,
52
54
routing, and on-chain punishment code (and other chain interactions) exactly
53
- correct. Note that ` rust-lightning ` isn't, in itself, a node. There are various
54
- nodes built using LDK such as [ Sensei] ( https://l2.technology/sensei ) , but if you
55
- "just" want a generic Lightning node, you're almost certainly better off with
56
- [ Core Lightning] ( https://github.com/ElementsProject/lightning ) or
57
- [ LND] ( https://github.com/lightningnetwork/lnd ) . If, on the other hand, you want
58
- to integrate Lightning with custom features such as your own chain sync, your
55
+ correct. Note that LDK isn't, in itself, a node. For an out-of-the-box lightning
56
+ node based on LDK, see [ Sensei] ( https://l2.technology/sensei ) . However, if you
57
+ want to integrate Lightning with custom features such as your own chain sync, your
59
58
own key management, your own data storage/backup logic, etc., LDK is likely your
60
59
only option. Some ` rust-lightning ` utilities such as those in
61
60
[ ` chan_utils ` ] ( ./lightning/src/ln/chan_utils.rs ) are also suitable for use in
0 commit comments