mirrors/rust-lightning
1
0
Fork 0
mirror of https://github.com/lightningdevkit/rust-lightning.git synced 2025-02-25 07:17:40 +01:00
Code Issues Projects Releases Packages Wiki Activity
A highly modular Bitcoin Lightning library written in Rust. It's rust-lightning, not Rusty's Lightning!
920 commits 27 branches 46 tags 92 MiB
Rust 99.4%
RenderScript 0.3%
Shell 0.2%
Find a file
Antoine Riard 3b09db80ea Move BREAKDOWN_TIMEOUT/MAX_LOCAL_BREAKDOWN_TIMEOUT in ChannelManager 
Let these values being used as default ones in UserConfig.

Also, reduce them to something more reasonable, for BREAKDOWN_TIMEOUT
from 1 week to 1 day, for MAX_LOCAL_BREAKDOWN_TIMEOUT from 2 weeks
to 1.
2019-07-24 17:53:04 -04:00
fuzz Make rand a dev-dep by having the user randomize HTLC forward delay 2019-07-23 14:29:56 -04:00
net-tokio Bump version to 0.0.9 to get current master fixes uploaded. 2019-06-01 07:48:33 -04:00
src Move BREAKDOWN_TIMEOUT/MAX_LOCAL_BREAKDOWN_TIMEOUT in ChannelManager 2019-07-24 17:53:04 -04:00
.editorconfig Fix typos 2019-01-24 19:07:08 +02:00
.gitignore ignore IntelliJ IDEA files 2018-03-19 16:14:19 -04:00
.travis.yml Move travis fuzzing to 1.34.2 to get integer atomics 2019-07-23 14:29:56 -04:00
Cargo.toml Make rand a dev-dep by having the user randomize HTLC forward delay 2019-07-23 14:29:56 -04:00
LICENSE Unify license with rust-bitcoin-spv 2018-03-05 15:09:44 -05:00
README.md Improve README usability 2019-03-25 18:03:06 -04:00

README.md

Rust-Lightning, not Rusty's Lightning!

Documentation can be found at docs.rs

Currently somewhere near 20% towards usable, published to see if there is any real interest from folks in using a lightning rust library.

The goal is to provide a full-featured but also incredibly flexible lightning implementation, allowing the user to decide how they wish to use it. With that in mind, everything should be exposed via simple, composable APIs. The user should be able to decide whether they wish to use their own threading/execution models, allowing usage inside of existing library architectures, or allow us to handle that for them. Same goes with network connections - if the user wishes to use their own networking stack, they should be able to do so! This all means that we should provide simple external interfaces which allow the user to drive all execution, while implementing sample execution drivers that create a full-featured lightning daemon by default.

For security reasons, do not add new dependencies. Really do not add new non-optional/non-test/non-library dependencies. Really really do not add dependencies with dependencies. Do convince Andrew to cut down dependency usage in rust-bitcoin.

Notes on coding style:

  • Use tabs. If you want to align lines, use spaces. Any desired alignment should display fine at any tab-length display setting.

License is Apache-2.0.