#message #user #chain #signature #byte #bitcoin #required

no-std lightning

A Bitcoin Lightning library in Rust. Does most of the hard work, without implying a specific runtime, requiring clients implement basic network logic, chain interactions and disk storage. Still missing tons of error-handling. See GitHub issues for suggested projects if you want to contribute. Don't have to bother telling you not to use this for anything serious, because you'd have to build a client around it to even try.

51 releases

0.0.125 Oct 14, 2024
0.0.124-rc1 Aug 29, 2024
0.0.123 May 9, 2024
0.0.121 Jan 23, 2024
0.0.1 Feb 16, 2018

#15 in #bitcoin

Download history 5610/week @ 2024-07-30 5292/week @ 2024-08-06 5268/week @ 2024-08-13 4871/week @ 2024-08-20 6375/week @ 2024-08-27 7214/week @ 2024-09-03 6227/week @ 2024-09-10 5337/week @ 2024-09-17 8985/week @ 2024-09-24 8908/week @ 2024-10-01 8779/week @ 2024-10-08 10517/week @ 2024-10-15 10554/week @ 2024-10-22 9068/week @ 2024-10-29 9373/week @ 2024-11-05 7773/week @ 2024-11-12

38,431 downloads per month
Used in 123 crates (33 directly)

MIT/Apache

7MB
117K SLoC

Rust-Lightning, not Rusty's Lightning!

A full-featured but also flexible lightning implementation, in library form. This allows the user (you) to decide how they wish to use it instead of being a fully self-contained daemon. This means there is no built-in threading/execution environment and it's up to the user to figure out how best to make networking happen/timers fire/things get written to disk/keys get generated/etc. This makes it a good candidate for tight integration into an existing wallet instead of having a rather-separate lightning appendage to a wallet.

default features are:

  • std - enables functionalities which require std, including std::io trait implementations and things which utilize time
  • grind_signatures - enables generation of low-r bitcoin signatures, which saves 1 byte per signature in 50% of the cases (see bitcoin PR #13666)

Available features are:

  • std
  • grind_signatures
  • no-std - exposes write trait implementations from the core2 crate (at least one of no-std or std are required)
  • Skip logging of messages at levels below the given log level:
    • max_level_off
    • max_level_error
    • max_level_warn
    • max_level_info
    • max_level_debug
    • max_level_trace

Dependencies

~7–17MB
~180K SLoC