Rust-Lightning
LDK/rust-lightning is a highly performant and flexible
implementation of the Lightning Network protocol.
The primary crate, lightning, is runtime-agnostic. Data persistence, chain interactions,
and networking can be provided by LDK's sample modules, or you may provide your
own custom implementations.
More information is available in the About section.
Status
The project implements all of the BOLT specifications,
and has been in production use since 2021. As with any Lightning implementation, care and attention
to detail is important for safe deployment.
Communications for rust-lightning and Lightning Development Kit happen through
our LDK Discord channels.
Crates
- lightning
The core of the LDK library, implements the Lightning protocol, channel state machine,
and on-chain logic. Supports
no_std and exposes only relatively low-level interfaces.
- lightning-background-processor
Utilities to perform required background tasks for Rust Lightning.
- lightning-block-sync
Utilities to fetch the chain data from a block source and feed them into Rust Lightning.
- lightning-invoice
Data structures to parse and serialize
BOLT #11
Lightning invoices.
- lightning-net-tokio
Implementation of the
rust-lightning network stack using the
Tokio async runtime. For rust-lightning
clients which wish to make direct connections to Lightning P2P nodes, this is
a simple alternative to implementing the required network stack, especially
for those already using Tokio.
- lightning-persister
Implements utilities to manage
rust-lightning channel data persistence and retrieval.
Persisting channel data is crucial to avoiding loss of channel funds.
- lightning-rapid-gossip-sync
Client for rapid gossip graph syncing, aimed primarily at mobile clients.
About
LDK/rust-lightning is a generic library that allows you to build a Lightning
node without needing to worry about getting all of the Lightning state machine,
routing, and on-chain punishment code (and other chain interactions) exactly
correct. Note that LDK isn't, in itself, a node. For an out-of-the-box Lightning
node based on LDK, see LDK-sample. However, if you
want to integrate Lightning with custom features such as your own chain sync,
key management, data storage/backup logic, etc., LDK is likely your best option.
Some rust-lightning utilities such as those in
chan_utils are also suitable for use in
non-LN Bitcoin applications such as Discreet Log Contracts (DLCs) and bulletin boards.
Also check out LDK-node library
if you want to easily integrate lightning in your application without taking care of
all the boiler plate code.
以上為 README 的開頭部分。其餘內容請閱讀原文。 檢視完整 README ↗
