X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=README.md;h=ea1f08ae165e0ecbb3b1a49c15ab209bf43ab7e9;hb=f8d4186746ca542371e64b141d6b529131f0c0c6;hp=d73e71da8aaf3a10fa076ca6fc953f6949094c78;hpb=4894d52d30399c21b7994952a8de0d1d7848c58d;p=rust-lightning diff --git a/README.md b/README.md index d73e71da..ea1f08ae 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,24 @@ production-worthy implementation in 2021. Communications for Rust-Lightning and Lightning Development Kit happens through [LDK slack](http://lightningdevkit.org/). +Crates +----------- +1. [lightning](./lightning) + The Core of the LDK library, implements the lightning protocol, channel state machine, + and on-chain logic. Supports no-std and exposes on relatively low-level interfaces. +2. [lightning-background-processor](./lightning-background-processor) + Utilities to perform required background tasks for Rust Lightning. +3. [lightning-block-sync](./lightning-block-sync) + Utilities to fetch the chain data from a block source and feed them into Rust Lightning. +4. [lightning-invoice](./lightning-invoice) + Data structures to parse and serialize BOLT11 lightning invoices. +5. [lightning-net-tokio](./lightning-net-tokio) + Implementation of the rust-lightning network stack using Tokio. + 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. +6. [lightning-persister](./lightning-persister) + Utilities to manage Rust-Lightning channel data persistence and retrieval. + About ----------- LDK/Rust-Lightning is a generic library which allows you to build a lightning @@ -87,7 +105,7 @@ In general, Rust-Lightning does not provide (but LDK has implementations of): hardware wallets. LDK's customizability was presented about at Advancing Bitcoin in February 2020: -https://vimeo.com/showcase/7131712/video/418412286 +https://vimeo.com/showcase/8372504/video/412818125 Design Goal -----------