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

   1 Rust-Lightning
   2 ==============
   3
   4 [![Crate](https://img.shields.io/crates/v/lightning.svg?logo=rust)](https://crates.io/crates/lightning)
   5 [![Documentation](https://img.shields.io/static/v1?logo=read-the-docs&label=docs.rs&message=lightning&color=informational)](https://docs.rs/lightning/)
   6 [![Safety Dance](https://img.shields.io/badge/unsafe-forbidden-success.svg)](https://github.com/rust-secure-code/safety-dance/)
   7
   8 Rust-Lightning is a Bitcoin Lightning library written in Rust. The main crate,
   9 `lightning`, does not handle networking, persistence, or any other I/O. Thus,
  10 it is runtime-agnostic, but users must implement basic networking logic, chain
  11 interactions, and disk storage. More information is available in the `About`
  12 section.
  13
  14 The `lightning-net-tokio` crate implements Lightning networking using the
  15 [Tokio](https://github.com/tokio-rs/tokio) async runtime.
  16
  17 The `lightning-persister` crate implements persistence for channel data that
  18 is crucial to avoiding loss of channel funds. Sample modules for persistence of
  19 other Rust-Lightning data is coming soon.
  20
  21 Status
  22 ------
  23
  24 The project implements all of the BOLT specifications in the 1.0 spec. The
  25 implementation has pretty good test coverage that is expected to continue to
  26 improve. It is also anticipated that as developers begin using the API, the
  27 lessons from that will result in changes to the API, so any developer using this
  28 API at this stage should be prepared to embrace that. The current state is
  29 sufficient for a developer or project to experiment with it. Recent increased
  30 contribution rate to the project is expected to lead to a high quality, stable,
  31 production-worthy implementation in 2021.
  32
  33 Communications for Rust-Lightning and Lightning Development Kit happens through
  34 [LDK slack](http://lightningdevkit.org/).
  35
  36 About
  37 -----------
  38 LDK/Rust-Lightning is a generic library which allows you to build a lightning
  39 node without needing to worry about getting all of the lightning state machine,
  40 routing, and on-chain punishment code (and other chain interactions) exactly
  41 correct. Note that Rust-Lightning isn't, in itself, a node. There are various
  42 working/in progress demos which could be used as a node today, but if you "just"
  43 want a generic lightning node, you're almost certainly better off with
  44 `c-lightning`/`lnd` - if, on the other hand, you want to integrate lightning
  45 with custom features such as your own chain sync, your own key management, your
  46 own data storage/backup logic, etc., LDK is likely your only option. Some
  47 Rust-Lightning utilities such as those in `chan_utils` are also suitable for use
  48 in non-LN Bitcoin applications such as DLCs and bulletin boards.
  49
  50 We are currently working on a demo node which fetches blockchain data and
  51 on-chain funds via Bitcoin Core RPC/REST. The individual pieces of that demo
  52 are/will be composable, so you can pick the off-the-shelf parts you want and
  53 replace the rest.
  54
  55 In general, Rust-Lightning does not provide (but LDK has implementations of):
  56 * on-disk storage - you can store the channel state any way you want - whether
  57   Google Drive/iCloud, a local disk, any key-value store/database/a remote
  58   server, or any combination of them - we provide a clean API that provides
  59   objects which can be serialized into simple binary blobs, and stored in any
  60   way you wish.
  61 * blockchain data - we provide a simple `block_connected`/`block_disconnected`
  62   API which you provide block headers and transaction information to. We also
  63   provide an API for getting information about transactions we wish to be
  64   informed of, which is compatible with Electrum server requests/neutrino
  65   filtering/etc.
  66 * UTXO management - RL/LDK owns on-chain funds as long as they are claimable as
  67   a part of a lightning output which can be contested - once a channel is closed
  68   and all on-chain outputs are spendable only by the user, we provide users
  69   notifications that a UTXO is "theirs" again and it is up to them to spend it
  70   as they wish. Additionally, channel funding is accomplished with a generic API
  71   which notifies users of the output which needs to appear on-chain, which they
  72   can then create a transaction for. Once a transaction is created, we handle
  73   the rest. This is a large part of our API's goals - making it easier to
  74   integrate lightning into existing on-chain wallets which have their own
  75   on-chain logic - without needing to move funds in and out of a separate
  76   lightning wallet with on-chain transactions and a separate private key system.
  77 * networking - to enable a user to run a full lightning node on an embedded
  78   machine, we don't specify exactly how to connect to another node at all! We
  79   provide a default implementation which uses TCP sockets, but, e.g., if you
  80   wanted to run your full lightning node on a hardware wallet, you could, by
  81   piping the lightning network messages over USB/serial and then sending them in
  82   a TCP socket from another machine.
  83 * private keys - again we have "default implementations", but users can chose to
  84   provide private keys to RL/LDK in any way they wish following a simple API. We
  85   even support a generic API for signing transactions, allowing users to run
  86   RL/LDK without any private keys in memory/putting private keys only on
  87   hardware wallets.
  88
  89 LDK's customizability was presented about at Advancing Bitcoin in February 2020:
  90 https://vimeo.com/showcase/7131712/video/418412286
  91
  92 Design Goal
  93 -----------
  94
  95 The goal is to provide a full-featured but also incredibly flexible lightning
  96 implementation, allowing the user to decide how they wish to use it. With that
  97 in mind, everything should be exposed via simple, composable APIs. More
  98 information about Rust-Lightning's flexibility is provided in the `About`
  99 section above.
 100
 101 For security reasons, do not add new dependencies. Really do not add new
 102 non-optional/non-test/non-library dependencies. Really really do not add
 103 dependencies with dependencies. Do convince Andrew to cut down dependency usage
 104 in rust-bitcoin.
 105
 106 Rust-Lightning vs. LDK (Lightning Development Kit)
 107 -------------
 108 Rust-Lightning refers to the core `lightning` crate within this repo, whereas
 109 LDK encompasses Rust-Lightning and all of its sample modules and crates (e.g.
 110 the `lightning-persister` crate), language bindings, sample node
 111 implementation(s), and other tools built around using Rust-Lightning for
 112 lightning integration or building a lightning node.
 113
 114 Tagline
 115 -------
 116
 117 *"Rust-Lightning, not Rusty's Lightning!"*
 118
 119 Contributing
 120 ------------
 121
 122 Contributors are warmly welcome, see [CONTRIBUTING.md](CONTRIBUTING.md).
 123
 124 Project Architecture
 125 ---------------------
 126
 127 For a Rust-Lightning high-level API introduction, see [ARCH.md](ARCH.md).
 128
 129 License is either Apache-2.0 or MIT, at the option of the user (ie dual-license
 130 Apache-2.0 and MIT).