c-lightning — a Lightning Network implementation in C
Clone or download
rustyrussell connectd: give user a hint when wrong key is used.
When the wrong key is used, the remote end simply hangs up.

We used to get a random errno, which tends to be "Operation now in progress."
Now it's defined to be 0, detect and provide a better error.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
Latest commit 09b3301 Oct 17, 2018
Failed to load latest commit information.
.github github: Added issue template Jan 29, 2018
bitcoin chainparams: Remove index from chainparams Sep 14, 2018
ccan ccan: update to get new ccan/io which sets errno to 0 on EOF. Oct 19, 2018
channeld channeld: use u64 fo `htlc_minimum_msat` Oct 16, 2018
cli cli: fix human help output for the new jsonrpc help response Oct 10, 2018
closingd hsmd: rename hsm_client_wire_csv to hsm_wire.csv Sep 20, 2018
common bolt11: better message when you try to 'lightning-cli pay' an onchain… Oct 17, 2018
connectd connectd: give user a hint when wrong key is used. Oct 19, 2018
contrib docker: Update docker images and docs to non-CVE-2018-17144 bitcoind Oct 15, 2018
devtools build: fix compile error on gcc ~7.3.0 Oct 9, 2018
doc options: Parse config file before opening working directory Oct 13, 2018
external libwally: Update to latest master to fix some compilation issues Oct 15, 2018
gossipd gossipd: update node announcement even if we change within a second. Oct 16, 2018
hsmd BOLT7: broadcast `htlc_maximum_msat` in `channel_update s Oct 16, 2018
lightningd gossipd: don't initialize broadcast interval, make field name explicit. Oct 15, 2018
onchaind common/utils.h: add tal_arr_expand helper. Sep 27, 2018
openingd BOLT 2 updates for fix placment of chain_hash req Sep 21, 2018
tests connectd: give user a hint when wrong key is used. Oct 19, 2018
tools common/utils.h: add tal_arr_expand helper. Sep 27, 2018
wallet gossipd: don't accept forwarding short_channel_ids we don't own. Oct 15, 2018
wire wire: add test for parsing optional version of channel_update Oct 9, 2018
.dir-locals.el emacs: add .dir-locals.el for linux style C Jan 10, 2018
.gitattributes Add configure and .gitmodules to .gitattributes Jun 24, 2018
.gitignore git: ignore vim's c-tags 'tags' file Sep 26, 2018
.gitlab-ci.yml Add .gitlab-ci.yml Dec 11, 2016
.gitmodules Update git configs for mac build Mar 26, 2018
.travis.yml travis: Actually build with clang if we want to Aug 10, 2018
CHANGELOG.md CHANGELOG: Fix up Added order, add note about htlc_maximum_msat. Oct 17, 2018
Dockerfile docker: Update docker images and docs to non-CVE-2018-17144 bitcoind Oct 15, 2018
LICENSE licensing: Make license explicit. Jan 21, 2016
Makefile ccan: update. Oct 19, 2018
README.md docker: Update docker images and docs to non-CVE-2018-17144 bitcoind Oct 15, 2018
ccan_compat.h ccan: upgrade to new ccan/tal and ccan/tal/str. Jul 30, 2018
configure pytest: Fix configure to find pytest when installed using pip3. Sep 5, 2018


c-lightning: A specification compliant Lightning Network implementation in C

c-lightning is a standard compliant implementation of the Lightning Network protocol. The Lightning Network is a scalability solution for Bitcoin, enabling secure and instant transfer of funds between any two parties for any amount.

For more information about the Lightning Network please refer to http://lightning.network.

Project Status

Build Status Pull Requests Welcome Irc

This implementation is still very much a work in progress. It can be used for testing, but it should not be used for real funds. We do our best to identify and fix problems, and implement missing features.

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 @ freenode.net, #c-lightning @ freenode.net, or on the implementation-specific mailing list c-lightning@lists.ozlabs.org, or on the Lightning Network-wide mailing list lightning-dev@lists.linuxfoundation.org.

Getting Started

c-lightning currently only works on Linux (and possibly Mac OS with some tweaking), and requires a locally (or remotely) running bitcoind (version 0.15 or above) that is fully caught up with the network you're testing on. Pruning (prune=n option in bitcoin.conf) is not currently supported.


Please refer to the installation documentation for detailed instructions. For the impatient here's the gist of it for Ubuntu and Debian:

sudo apt-get update
sudo apt-get install -y \
  autoconf automake build-essential git libtool libgmp-dev \
  libsqlite3-dev python python3 net-tools zlib1g-dev
git clone https://github.com/ElementsProject/lightning.git
cd lightning

Or if you like to throw docker into the mix, you can use the offial docker image either directly or as a base layer for more complex images. The docker image is elementsproject/lightningd (from this Dockerfile). Image tags with -dev at the end are images built with DEVELOPER=1. If you build the image yourself, you can use the build arg DEVELOPER=1 to build c-lightning in developer mode.

It has the following environment variable:

  • EXPOSE_TCP default to false, if true, use expose c-lightning RPC on port 9835. (Use this only for testing)

Here is an example of a docker-compose file with bitcoind and c-lightning on testnet which expose bitcoind's rpc interface on default ports 18332 and c-lightning API on port 9735:

version: "3"
    image: nicolasdorier/docker-bitcoin:0.16.3
    container_name: bitcoind
      - "18332"
      - ""
      - "bitcoin_datadir:/data"

    image: elementsproject/lightningd
    container_name: lightningd
      - --bitcoin-rpcconnect=bitcoind
      - --bitcoin-rpcuser=rpcuser
      - --bitcoin-rpcpassword=rpcpass
      - --network=testnet
      - --alias=myawesomenode
      - --log-level=debug
      EXPOSE_TCP: "true"
      - "9735"
      - ""
      - "clightning_bitcoin_datadir:/root/.lightning"
      - "bitcoin_datadir:/etc/bitcoin"
      - bitcoind


Starting lightningd

In order to start lightningd you will need to have a local bitcoind node running in either testnet or regtest mode:

bitcoind -daemon -testnet

Wait until bitcoind has synchronized with the testnet network.

Make sure that you do not have walletbroadcast=0 in your ~/.bitcoin/bitcoin.conf, or you may run into trouble. Notice that currently pruned nodes are not supported and may result in lightningd being unable to synchronize with the blockchain.

You can start lightningd with the following command:

lightningd/lightningd --network=testnet --log-level=debug

Listing all commands:

cli/lightning-cli help will print a table of the API and lists the following commands

Opening a channel on the Bitcoin testnet

First you need to transfer some funds to lightningd so that it can open a channel:

# Returns an address <address>
cli/lightning-cli newaddr

# Returns a transaction id <txid>
bitcoin-cli -testnet sendtoaddress <address> <amount_in_bitcoins>

lightningd will register the funds once the transaction is confirmed.

If you don't have any testcoins you can get a few from a faucet such as TPs' testnet faucet or Kiwi's testnet faucet. You can send it directly to the lightningd address.

You may need to generate a p2sh-segwit address if the faucet does not support bech32:

# Return a p2sh-segwit address
cli/lightning-cli newaddr p2sh-segwit

Confirm lightningd got funds by:

# Returns an array of on-chain funds.
cli/lightning-cli listfunds

Once lightningd has funds, we can connect to a node and open a channel. Let's assume the remote node is accepting connections at <ip> (and optional <port>, if not 9735) and has the node ID <node_id>:

cli/lightning-cli connect <node_id> <ip> [<port>]
cli/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 1 confirmations in order for the channel to be usable, and 6 to be broadcast for others to use. You can check the status of the channel using cli/lightning-cli listpeers, which after 3 confirmations (1 on testnet) should say that state is CHANNELD_NORMAL; after 6 confirmations you can use cli/lightning-cli listchannels to verify that the public field is now true.

Different states

  • GOSSIPING means that you are connected to a peer but there is no payment channel yet.
  • OPENINGD means that lightning_openingd is negotiating channel opening.
  • CHANNELD_AWAITING_LOCKIN means that lightning_channeld is waiting until the minimum number of confirmation on the channel funding transaction.
  • CHANNELD_NORMAL means your channel is operating normally.
  • CHANNELD_SHUTTING_DOWN means one or both sides have asked to shut down the channel, and we're waiting for existing HTLCs to clear.
  • CLOSINGD_SIGEXCHANGE means we're trying to negotiate the fee for the mutual close transaction.
  • CLOSINGD_COMPLETE means we've broadcast our mutual close transaction (which spends the funding transaction) , but haven't seen it in a block yet.
  • FUNDING_SPEND_SEEN means we've seen the funding transaction spent.
  • ONCHAIN means that the lightning_onchaind is tracking the onchain closing of the channel.
  • AWAITING_UNILATERAL means that we're waiting for a unilateral close to hit the blockchain.

All these states have more information about what's going on in the status field in listpeers.

Sending and receiving payments

Payments in Lightning are invoice based. The recipient creates an invoice with the expected <amount> in millisatoshi (or "any" for a donation), a unique <label> and a <description> the payer will see:

cli/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 pay command:

cli/lightning-cli pay <bolt11>

Note that there are lower-level interfaces (and more options to these interfaces) for more sophisticated use.

Configuration File

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 ".lightning" directory. Usually this will be ~/.lightning/config

Configuration options are set using a key=value pair on each line of the file, for example:


For a full list of possible lightningd configuration options, run:

lightningd/lightningd --help

Further information

JSON-RPC interface is documented in the following manual pages:

For simple access to the JSON-RPC interface you can use the cli/lightning-cli tool, or the python API client.