#message #chain #lightning #byte #signature #required #bitcoin

no-std rgb-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.

1 unstable release

0.0.1 Mar 24, 2023

#109 in #required

MIT/Apache

4MB
64K SLoC

rgb-lightning

This project is a fork of the lightning crate from rust-lightning that currently only changes the crate name and version in order to reserve the crate name in crates.io. We cannot publish RGB fork now since it depends on some unpublished dependencies, but you can still clone and try the project by checking out the rgb branch.


lib.rs:

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

~6.5–9MB
~115K SLoC