_ Git - rust-lightning/blob - README.md

   1 Rust-Lightning
   2 ==============
   3
   4 [![Crate](https://img.shields.io/crates/v/lightning.svg?logo=rust)](https://crates.io/crates/lightning)
   5 [![Documentation](https://img.shields.io/static/v1?logo=read-the-docs&label=docs.rs&message=lightning&color=informational)](https://docs.rs/lightning/)
   6 [![Safety Dance](https://img.shields.io/badge/unsafe-forbidden-success.svg)](https://github.com/rust-secure-code/safety-dance/)
   7
   8 Rust-lightning is a low-level Bitcoin Lightning library written in Rust. It is
   9 low-level in that it does not handle networking, persistence, or any other I/O.
  10 Thus, it is runtime-agnostic, but users must implement basic networking logic,
  11 chain interactions, and disk storage.
  12
  13 Status
  14 ------
  15
  16 The project implements all of the BOLT specifications in the 1.0 spec except
  17 for [channel queries](https://github.com/lightningnetwork/lightning-rfc/blob/master/07-routing-gossip.md#query-messages). The
  18 implementation has pretty good test coverage that is expected to continue to
  19 improve. There are a number of internal refactorings being done now that will
  20 make the code base more welcoming to new contributors. It is also anticipated
  21 that as developers begin using the API, the lessons from that will result in
  22 changes to the API, so any developer using this API at this stage should be prepared
  23 to embrace that. The current state is sufficient for a developer or project to
  24 experiment with it. Recent increased contribution rate to the project is expected
  25 to lead to a high quality, stable, production-worthy implementation in 2020.
  26
  27 Communications for Rust-Lightning and Lightning Development Kit happens through
  28 [LDK slack](http://lightningdevkit.org/).
  29
  30 Design Goal
  31 -----------
  32
  33 The goal is to provide a full-featured but also incredibly flexible lightning
  34 implementation, allowing the user to decide how they wish to use it. With that
  35 in mind, everything should be exposed via simple, composable APIs. The user
  36 should be able to decide whether they wish to use their own threading/execution
  37 models, allowing usage inside of existing library architectures, or allow us to
  38 handle that for them. Same goes with network connections - if the user wishes
  39 to use their own networking stack, they should be able to do so! This all means
  40 that we should provide simple external interfaces which allow the user to drive
  41 all execution, while implementing sample execution drivers that create a
  42 full-featured lightning daemon by default.
  43
  44 For security reasons, do not add new dependencies. Really do not add new
  45 non-optional/non-test/non-library dependencies. Really really do not add
  46 dependencies with dependencies. Do convince Andrew to cut down dependency usage
  47 in rust-bitcoin.
  48
  49 Contributing
  50 ------------
  51
  52 Contributors are warmly welcome, see [CONTRIBUTING.md](CONTRIBUTING.md).
  53
  54 Project Architecture
  55 ---------------------
  56
  57 For a Rust-Lightning high-level API introduction, see [ARCH.md](ARCH.md).
  58
  59 License is either Apache-2.0 or MIT, at the option of the user (ie dual-license
  60 Apache-2.0 and MIT).