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

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