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

   1 Rust-Lightning, not Rusty's Lightning!
   2
   3 Currently somewhere near 5% towards usable, published to see if there is any
   4 real interest from folks in either contributing to or using a lightning rust
   5 library.
   6
   7 The goal is to provide a full-featured but also incredibly flexible lightning
   8 implementation, allowing the user to decide how they wish to use it. With that
   9 in mind, everything should be exposed via simple, composable APIs. The user
  10 should be able to decide whether they wish to use their own threading/execution
  11 models, allowing usage inside of existing library architectures, or allow us to
  12 handle that for them. Same goes with network connections - if the user wishes
  13 to use their own networking stack, they should be able to do so! This all means
  14 that we should provide simple external interfaces which allow the user to drive
  15 all execution, while implementing sample execution drivers that create a
  16 full-featured lightning daemon by default.
  17
  18 For security reasons, do not add new dependencies. Really do not add new
  19 non-optional/non-test/non-library dependencies. Really really do not add
  20 dependencies with dependencies. Do convince Andrew to cut down dependency usage
  21 in rust-bitcoin.
  22
  23 Notes on coding style:
  24  * Use tabs. If you want to align lines, use spaces. Any desired alignment
  25    should display fine at any tab-length display setting.
  26
  27 License is Apache-2.0.