A highly modular Bitcoin Lightning library written in Rust. It's rust-lightning, not Rusty's Lightning!
Find a file
Matt Corallo 60d37b2698 Fix long-standing race in net-tokio reading after a disconnect event
If rust-lightning tells us to disconnect a socket after we read
some bytes from the socket, but before we actually give those bytes
to rust-lightning, we may end up calling rust-lightning with a
Descriptor that isn't registered anymore.

Sadly, there really isn't a good way to solve this, and it should
be a pretty quick event, so we just busy-wait.
2020-03-11 12:19:39 -04:00
fuzz Swap read_event read type for a slice isntead of a Vec 2020-03-10 11:52:12 -04:00
lightning Swap read_event read type for a slice isntead of a Vec 2020-03-10 11:52:12 -04:00
lightning-net-tokio Fix long-standing race in net-tokio reading after a disconnect event 2020-03-11 12:19:39 -04:00
.editorconfig Fix typos 2019-01-24 19:07:08 +02:00
.gitignore Provide remote channel public keys to signer 2020-01-19 20:40:49 -05:00
.travis.yml [travis] Build lightning-net-tokio on Rust 1.39.0+, fuzz on stable 2020-03-04 13:47:25 -05:00
Cargo.toml Move test profile to crate root, so it has effect again 2019-11-28 01:21:41 -05:00
CONTRIBUTING.md Merge pull request #507 from moneyball/patch-2 2020-02-29 02:59:34 +00:00
LICENSE Unify license with rust-bitcoin-spv 2018-03-05 15:09:44 -05:00
README.md Merge pull request #470 from ariard/2020-01-contributing-draft 2020-02-12 19:31:26 +00:00

Safety Dance

Rust-Lightning, not Rusty's Lightning!

Documentation can be found at docs.rs

The project implements all of the BOLT specifications in the 1.0 spec except for channel queries. The implementation has pretty good test coverage that is expected to continue to improve. There are a number of internal refactorings being done now that will make the code base more welcoming to new contributors. It is also anticipated that as developers begin using the API, the lessons from that will result in changes to the API, so any developer using this API at this stage should be prepared to embrace that. The current state is sufficient for a developer or project to experiment with it. Recent increased contribution rate to the project is expected to lead to a high quality, stable, production-worthy implementation in 2020.

Communications for Rust-Lightning and Lightning Development Kit happens through LDK slack.

Design Goal

The goal is to provide a full-featured but also incredibly flexible lightning implementation, allowing the user to decide how they wish to use it. With that in mind, everything should be exposed via simple, composable APIs. The user should be able to decide whether they wish to use their own threading/execution models, allowing usage inside of existing library architectures, or allow us to handle that for them. Same goes with network connections - if the user wishes to use their own networking stack, they should be able to do so! This all means that we should provide simple external interfaces which allow the user to drive all execution, while implementing sample execution drivers that create a full-featured lightning daemon by default.

For security reasons, do not add new dependencies. Really do not add new non-optional/non-test/non-library dependencies. Really really do not add dependencies with dependencies. Do convince Andrew to cut down dependency usage in rust-bitcoin.

Contributing

Contributors are warmly welcome, see CONTRIBUTING.md.

Project Architecture

COMING SOON.

License is Apache-2.0.