You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Rusty Russell 94711969f9 gossipd: hand out gossip_index to other daemons. 7 years ago
bitcoin Share similar code between bitcoin_witness_p2sh_p2wpkh and bitcoin_scriptsig_p2sh_p2wpkh. 7 years ago
ccan ccan: update to get new ccan/io changes. 7 years ago
channeld gossipd: hand out gossip_index to other daemons. 7 years ago
cli Makefiles: simplify dependencies. 7 years ago
closingd gossipd: hand out gossip_index to other daemons. 7 years ago
common daemon_conn: helper to release daemon_conn. 7 years ago
contrib docker: Added clang to build dependencies 7 years ago
devtools bolt11: handle r value fee spec change. 7 years ago
doc Fix typos 7 years ago
external Makefile: clean needs to do more, distclean should remove everything. 7 years ago
gossipd gossipd: hand out gossip_index to other daemons. 7 years ago
hsmd Modify hsm_sign_withdrawal to transmit scriptpubkey to withdraw to, rather than pkh. 7 years ago
lightningd gossipd: hand out gossip_index to other daemons. 7 years ago
onchaind Remove trailing whitespace 7 years ago
openingd gossipd: hand out gossip_index to other daemons. 7 years ago
test update-mocks: move mock generation into tools/, fix and generalize. 7 years ago
tests gossipd: hand back peer, don't hand a new peer. 7 years ago
tools Remove trailing whitespace 7 years ago
wallet wallet.c: Minor leak in wallet_invoices_load. 7 years ago
wire cleanup: Use check_act* in handshake and remove unused static inline 7 years ago
.gitignore Add build artefacts generated during "make"/"make check" to .gitignore 7 years ago
.gitlab-ci.yml Add .gitlab-ci.yml 8 years ago
.gitmodules external/libbacktrace: new external library for backtrace support. 7 years ago
.travis.yml travis: Add clang build to build matrix 7 years ago
LICENSE licensing: Make license explicit. 9 years ago
Makefile Fix typos 7 years ago
README.md README.md: Add link to waitanyinvoice 7 years ago

README.md

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 party for any amount.

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

Project Status

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

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 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 running bitcoind (version 0.15 or above) that is fully caught up with the network you're testing on.

Installation

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 install -y autoconf git build-essential libtool libgmp-dev libsqlite3-dev python python3
git clone https://github.com/ElementsProject/lightning.git
cd lightning
make

Or if you like to throw docker into the mix:

sudo docker run \
	-v $HOME/.lightning:/root/.lightning \
	-v $HOME/.bitcoin:/root/.bitcoin \
	-p 9735:9735 \
	cdecker/lightningd:latest

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. In case you use regtest, make sure you generate at least 432 blocks to activate SegWit.

You can start lightningd with the following command:

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

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>

# Retrieves the raw transaction <rawtx>
bitcoin-cli -testnet getrawtransaction <txid>

# Notifies `lightningd` that there are now funds available:
cli/lightning-cli addfunds <rawtx>

Eventually lightningd will include its own wallet making this transfer easier, but for now this is how it gets its funds. 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.

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>

This opens a connection and, on top of that connection, then opens a channel. The funding transaction needs 6 confirmations in order for the channel to be usable. You can check the status of the channel using cli/lightning-cli getpeers, which after 1 confirmation should say that the status is in Normal operation. After 6 confirmations you can use cli/lightning-cli getchannels to verify that the channel shows up in the list of open channels.

Receiving and receiving payments

Payments in Lightning are invoice based. The recipient creates an invoice with the expected <amount> in millisatoshi, a <label> and a <description>:

cli/lightning-cli invoice <amount> <label> <description>

This returns a random value called rhash that is part of the invoice. The recipient needs to communicate its ID <recipient_id>, <rhash> and the desired <amount> to the sender.

The sender needs to compute a route to the recipient, and use that route to actually send the payment. The route contains the path that the payment will take through the Lightning Network and the respective funds that each node will forward.

route=$(cli/lightning-cli getroute <recipient_id> <amount> 1 | jq --raw-output .route -)
cli/lightning-cli sendpay "$route" <rhash>

Notice that in the first step we stored the route in a variable and reused it in the second step. lightning-cli should return a preimage that serves as a receipt, confirming that the payment was successful.

This low-level interface is still experimental and will eventually be complemented with a higher level interface that is easier to use.

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.