git.bitcoin.ninja Git - rust-lightning/blob - README.md

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