|Project Name||Stars||Downloads||Repos Using This||Packages Using This||Most Recent Commit||Total Releases||Latest Release||Open Issues||License||Language|
|Lnd||7,081||14||122||2 days ago||120||February 25, 2022||643||mit||Go|
|Lightning Network Daemon ⚡️|
|Lightning||2,629||1||7||2 days ago||20||August 01, 2023||550||other||C|
|Core Lightning — Lightning Network implementation focusing on spec compliance and performance|
|Lnbook||2,599||5 months ago||195||cc-by-sa-4.0||AsciiDoc|
|Mastering the Lightning Network (LN)|
|Awesome Lightning Network||909||6 months ago||8|
|⚡ A curated list of awesome Lightning Network projects for developers and crypto enthusiasts|
|Polar||656||a day ago||40||mit||TypeScript|
|One-click Bitcoin Lightning networks for local app development & testing|
|Lightning Onion||377||66||55||a month ago||5||February 11, 2022||10||mit||Go|
|Onion Routed Micropayments for the Lightning Network|
|Lightning Curriculum||320||4 months ago||1|
|Lightning Network Protocol Development Curriculum|
|Obd||211||2 months ago||9||November 11, 2021||32||mit||Go|
|OmniBOLT daemon, a golang implementation of OmniBOLT spec, the smart assets lightning network.|
|Lightning Docs||140||8 months ago||5||apache-2.0|
|Some in-depth articles about the Lightning Network|
|The Lightning Network Book||121||4 years ago||13||other||TeX|
|An open source and crowdfunded book about Bitcoins Lightning Network to scale blockchain technologies.|
Core Lightning (previously c-lightning) is a lightweight, highly customizable and standard compliant implementation of the Lightning Network protocol.
This implementation has been in production use on the Bitcoin mainnet since early 2018, with the launch of the Blockstream Store.
We recommend getting started by experimenting on
regtest), but the implementation is considered stable and can be safely used on mainnet.
Any help testing the implementation, reporting bugs, or helping with outstanding issues is very welcome. Don't hesitate to reach out to us on IRC at #lightning-dev @ libera.chat, #c-lightning @ libera.chat, or on the implementation-specific mailing list [email protected], or on the Lightning Network-wide mailing list [email protected], or on Discord core-lightning, or on Telegram Core Lightning.
Core Lightning only works on Linux and macOS, and requires a locally (or remotely) running
bitcoind (version 22.0 or above) that is fully caught up with the network you're running on, and relays transactions (ie with
prune=n option in
bitcoin.conf) is partially supported, see here for more details.
There are 4 supported installation options:
If you want to experiment with
lightningd, there's a script to set
bitcoind regtest test network of two local lightning nodes,
which provides a convenient
start_ln helper. See the notes at the top
startup_regtest.sh file for details on how to use it.
To test with real bitcoin, you will need to have a local
bitcoind node running:
bitcoind has synchronized with the network.
Make sure that you do not have
walletbroadcast=0 in your
~/.bitcoin/bitcoin.conf, or you may run into trouble.
Notice that running
lightningd against a pruned node may cause some issues if not managed carefully, see below for more information.
You can start
lightningd with the following command:
lightningd --network=bitcoin --log-level=debug
This creates a
.lightning/ subdirectory in your home directory: see
man -l doc/lightningd.8 (or https://docs.corelightning.org/docs) for more runtime options.
You can use
lightning-cli help to print a table of RPC methods;
lightning-cli help <command>
will offer specific information on that command.
Once you've started for the first time, there's a script called
contrib/bootstrap-node.sh which will connect you to other nodes on
the lightning network.
There are also numerous plugins available for Core Lightning which add capabilities: in particular there's a collection at: lightningd/plugins
Including helpme which guides you through setting up your first channels and customizing your node.
For a less reckless experience, you can encrypt the HD wallet seed: see HD wallet encryption.
You can also chat to other users at #c-lightning @ libera.chat; we are always happy to help you get started!
First you need to transfer some funds to
lightningd so that it can
open a channel:
# Returns an address <address> lightning-cli newaddr
lightningd will register the funds once the transaction is confirmed.
You may need to generate a p2sh-segwit address if the faucet does not support bech32:
# Return a p2sh-segwit address lightning-cli newaddr p2sh-segwit
lightningd got funds by:
# Returns an array of on-chain funds. lightning-cli listfunds
lightningd has funds, we can connect to a node and open a channel.
Let's assume the remote node is accepting connections at
<port>, if not 9735) and has the node ID
lightning-cli connect <node_id> <ip> [<port>] lightning-cli fundchannel <node_id> <amount_in_satoshis>
This opens a connection and, on top of that connection, then opens a channel.
The funding transaction needs 3 confirmation in order for the channel to be usable, and 6 to be announced for others to use.
You can check the status of the channel using
lightning-cli listpeers, which after 3 confirmations (1 on testnet) should say that
CHANNELD_NORMAL; after 6 confirmations you can use
lightning-cli listchannels to verify that the
public field is now
Payments in Lightning are invoice based.
The recipient creates an invoice with the expected
"any" for a donation), a unique
<label> and a
<description> the payer will see:
lightning-cli invoice <amount> <label> <description>
This returns some internal details, and a standard invoice string called
bolt11 (named after the BOLT #11 lightning spec).
The sender can feed this
bolt11 string to the
decodepay command to see what it is, and pay it simply using the
lightning-cli pay <bolt11>
Note that there are lower-level interfaces (and more options to these interfaces) for more sophisticated use.
lightningd can be configured either by passing options via the command line, or via a configuration file.
Command line options will always override the values in the configuration file.
To use a configuration file, create a file named
config within your top-level lightning directory or network subdirectory
man -l doc/lightningd-config.5.
A sample configuration file is available at
Core Lightning requires JSON-RPC access to a fully synchronized
bitcoind in order to synchronize with the Bitcoin network.
Access to ZeroMQ is not required and
bitcoind does not need to be run with
txindex like other implementations.
The lightning daemon will poll
bitcoind for new blocks that it hasn't processed yet, thus synchronizing itself with
bitcoind prunes a block that Core Lightning has not processed yet, e.g., Core Lightning was not running for a prolonged period, then
bitcoind will not be able to serve the missing blocks, hence Core Lightning will not be able to synchronize anymore and will be stuck.
In order to avoid this situation you should be monitoring the gap between Core Lightning's blockheight using
lightning-cli getinfo and
bitcoind's blockheight using
If the two blockheights drift apart it might be necessary to intervene.
You can encrypt the
hsm_secret content (which is used to derive the HD wallet's master key) by passing the
--encrypted-hsm startup argument, or by using the
hsmtool (which you can find in the
tool/ directory at the root of this repo) with the
encrypt method. You can unencrypt an encrypted
hsm_secret using the
hsmtool with the
If you encrypt your
hsm_secret, you will have to pass the
--encrypted-hsm startup option to
lightningd. Once your
hsm_secret is encrypted, you will not be able to access your funds without your password, so please beware with your password management. Also, beware of not feeling too safe with an encrypted
hsm_secret: unlike for
bitcoind where the wallet encryption can restrict the usage of some RPC command,
lightningd always needs to access keys from the wallet which is thus not locked (yet), even with an encrypted BIP32 master seed.
Developers wishing to contribute should start with the developer guide here.