@@ -5,21 +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
- ` rust-lightning ` is a Bitcoin Lightning library written in Rust. The main crate,
9
- ` lightning ` , does not handle networking, persistence, or any other I/O. Thus,
10
- it is runtime-agnostic, but users must implement basic networking logic, chain
11
- interactions, and disk storage. More information is available in the ` About `
12
- section.
8
+ [ LDK] ( https://lightningdevkit.org ) /` rust-lightning ` is a highly performant and flexible
9
+ implementation of the Lightning Network protocol.
10
+
11
+ The primary crate, ` lightning ` , is runtime-agnostic. Data persistence, chain interactions,
12
+ and networking can be provided by LDK's [ sample modules] ( #crates ) , or you may provide your
13
+ own custom implementations.
14
+ More information is available in the [ ` About ` ] ( #about ) section.
13
15
14
16
Status
15
17
------
16
- The project implements all of the [ BOLT
17
- specifications] ( https://github.com/lightning/bolts ) . The
18
- implementation has pretty good test coverage that is expected to continue to
19
- improve. It is also anticipated that as developers begin using the API, the
20
- lessons from that will result in changes to the API, so any developer using this
21
- API at this stage should be prepared to embrace that. The current state is
22
- sufficient for a developer or project to experiment with it.
18
+ The project implements all of the [ BOLT specifications] ( https://github.com/lightning/bolts ) ,
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.
23
21
24
22
Communications for ` rust-lightning ` and Lightning Development Kit happen through
25
23
our LDK [ Discord] ( https://discord.gg/5AcknnMfBw ) channels.
@@ -51,17 +49,14 @@ Crates
51
49
52
50
About
53
51
-----------
54
- LDK/` rust-lightning ` is a generic library which allows you to build a Lightning
52
+ LDK/` rust-lightning ` is a generic library that allows you to build a Lightning
55
53
node without needing to worry about getting all of the Lightning state machine,
56
54
routing, and on-chain punishment code (and other chain interactions) exactly
57
- correct. Note that ` rust-lightning ` isn't, in itself, a node. There are various
58
- working/in progress demos which could be used as a node today, but if you "just"
59
- want a generic Lightning node, you're almost certainly better off with [ Core
60
- Lightning] ( https://github.com/ElementsProject/lightning ) or
61
- [ LND] ( https://github.com/lightningnetwork/lnd ) . If, on the other hand, you want
62
- to integrate Lightning with custom features such as your own chain sync, your
63
- own key management, your own data storage/backup logic, etc., LDK is likely your
64
- only option. Some ` rust-lightning ` utilities such as those in
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,
58
+ key management, data storage/backup logic, etc., LDK is likely your best option.
59
+ Some ` rust-lightning ` utilities such as those in
65
60
[ ` chan_utils ` ] ( ./lightning/src/ln/chan_utils.rs ) are also suitable for use in
66
61
non-LN Bitcoin applications such as Discreet Log Contracts (DLCs) and bulletin boards.
67
62
0 commit comments