3c3f4731bd
There are no definition lists in Markdown, and lists get mangled if
they follow immediately: they need a line between them.
So use bullets for options, and use an indent so the text gets in the
line below.
Here's a before-and-after example:
```diff
--- /tmp/after 2022-07-20 21:55:54.355487769 +0930
+++ /tmp/after2 2022-07-20 21:58:17.305642576 +0930
@@ -10,38 +10,71 @@
lightning-cli sends commands to the lightning daemon.
OPTIONS
- --lightning-dir=DIR Set the directory for the lightning daemon we're talking to; defaults to $HOME/.lightning.
+ • --lightning-dir=DIR
- --conf=PATH Sets configuration file (default: lightning-dir/config ).
+ Set the directory for the lightning daemon we're talking to; defaults to $HOME/.lightning.
- --network=network --mainnet --testnet --signet Sets network explicitly.
+ • --conf=PATH
- --rpc-file=FILE Named pipe to use to talk to lightning daemon: default is lightning-rpc in the lightning directory.
+ Sets configuration file (default: lightning-dir/config ).
- --keywords/-k Use format key=value for parameters in any order
+ • --network=network
- --order/-o Follow strictly the order of parameters for the command
+ • --mainnet
- --json/-J Return result in JSON format (default unless help command, or result contains a format-hint field).
+ • --testnet
- --raw/-R Return raw JSON directly as lightningd replies; this can be faster for large requests.
+ • --signet
- --human-readable/-H Return result in human-readable output.
+ Sets network explicitly.
- --flat/-F Return JSON result in flattened one-per-line output, e.g. { "help": [ { "command": "check" } ] } would become
+ • --rpc-file=FILE
+
+ Named pipe to use to talk to lightning daemon: default is lightning-rpc in the lightning directory.
+
+ • --keywords/-k
+
+ Use format key=value for parameters in any order
+
+ • --order/-o
+
+ Follow strictly the order of parameters for the command
+
+ • --json/-J
+
+ Return result in JSON format (default unless help command, or result contains a format-hint field).
+
+ • --raw/-R
+
+ Return raw JSON directly as lightningd replies; this can be faster for large requests.
+
+ • --human-readable/-H
+
+ Return result in human-readable output.
+
+ • --flat/-F
+
+ Return JSON result in flattened one-per-line output, e.g. { "help": [ { "command": "check" } ] } would become
help[0].command=check. This is useful for simple scripts which want to find a specific output field without parsing
JSON.
- --notifications/-N=LEVEL If LEVEL is 'none', then never print out notifications. Otherwise, print out notifications of
- LEVEL or above (one of io, debug, info (the default), unusual or broken: they are prefixed with # .
+ • --notifications/-N=LEVEL
+
+ If LEVEL is 'none', then never print out notifications. Otherwise, print out notifications of LEVEL or above (one of
+ io, debug, info (the default), unusual or broken: they are prefixed with # .
+
+ • --help/-h
+
+ Pretty-print summary of options to standard output and exit. The format can be changed using -F, -R, -J, -H etc.
+
+ • --version/-V
- --help/-h Pretty-print summary of options to standard output and exit. The format can be changed using -F, -R, -J, -H
- etc.
+ Print version number to standard output and exit.
- --version/-V Print version number to standard output and exit.
+ • allow-deprecated-apis=BOOL
- allow-deprecated-apis=BOOL Enable deprecated options. It defaults to true, but you should set it to false when testing to
- ensure that an upgrade won't break your configuration.
+ Enable deprecated options. It defaults to true, but you should set it to false when testing to ensure that an upgrade
+ won't break your configuration.
COMMANDS
lightning-cli simply uses the JSON RPC interface to talk to lightningd, and prints the results. Thus the commands avail‐
@@ -60,13 +93,13 @@
this is not encouraged.
EXAMPLES
- 1. List commands
+ 1. List commands:
- lightning-cli help
+ • lightning-cli help
- 2. Fund a 10k sat channel using uncomfirmed outputs
+ 2. Fund a 10k sat channel using uncomfirmed outputs:
- lightning-cli --keywords fundchannel id=028f...ae7d amount=10000sat minconf=0
+ • lightning-cli --keywords fundchannel id=028f...ae7d amount=10000sat minconf=0
BUGS
This manpage documents how it should work, not how it does work. The pretty printing of results isn't pretty.
```
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
|
||
|---|---|---|
| .github | ||
| bitcoin | ||
| ccan | ||
| channeld | ||
| cli | ||
| cln-grpc | ||
| cln-rpc | ||
| closingd | ||
| common | ||
| connectd | ||
| contrib | ||
| db | ||
| devtools | ||
| doc | ||
| external | ||
| gossipd | ||
| hsmd | ||
| lightningd | ||
| onchaind | ||
| openingd | ||
| plugins | ||
| tests | ||
| tools | ||
| wallet | ||
| wire | ||
| .clang-format | ||
| .dir-locals.el | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| .gitlab-ci.yml | ||
| .gitmodules | ||
| .msggen.json | ||
| CHANGELOG.md | ||
| Cargo.lock | ||
| Cargo.toml | ||
| Dockerfile | ||
| LICENSE | ||
| Makefile | ||
| README.md | ||
| action.yml | ||
| ccan_compat.h | ||
| configure | ||
| poetry.lock | ||
| pyproject.toml | ||
README.md
Core Lightning (CLN): A specification compliant Lightning Network implementation in C
Core Lightning (previously c-lightning) is a lightweight, highly customizable and standard compliant implementation of the Lightning Network protocol.
Project Status
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 testnet (or 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 c-lightning@lists.ozlabs.org, or on the Lightning Network-wide mailing list lightning-dev@lists.linuxfoundation.org, or on Discord core-lightning, or on Telegram Core Lightning.
Getting Started
Core Lightning only works on Linux and macOS, and requires a locally (or remotely) running bitcoind (version 0.16 or above) that is fully caught up with the network you're running on, and relays transactions (ie with blocksonly=0).
Pruning (prune=n option in bitcoin.conf) is partially supported, see here for more details.
Installation
There are 4 supported installation options:
- Installation from the Ubuntu PPA.
- Installation of a pre-compiled binary from the release page on GitHub.
- Using one of the provided docker images on the Docker Hub.
- Compiling the source code yourself as described in the installation documentation.
For the impatient here's the gist of it for Ubuntu:
sudo apt-get install -y software-properties-common
sudo add-apt-repository -u ppa:lightningnetwork/ppa
sudo apt-get install lightningd snapd
sudo snap install bitcoin-core
sudo ln -s /snap/bitcoin-core/current/bin/bitcoin{d,-cli} /usr/local/bin/
Starting lightningd
Regtest (local, fast-start) Option
If you want to experiment with lightningd, there's a script to set
up a bitcoind regtest test network of two local lightning nodes,
which provides a convenient start_ln helper. See the notes at the top
of the startup_regtest.sh file for details on how to use it.
. contrib/startup_regtest.sh
Note that your local nodeset will be much faster/more responsive if you've configured your node to expose the developer options, e.g.
./configure --enable-developer
Mainnet Option
To test with real bitcoin, you will need to have a local bitcoind node running:
bitcoind -daemon
Wait until 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://lightning.readthedocs.io/) for more runtime options.
Using The JSON-RPC Interface
Core Lightning exposes a JSON-RPC 2.0 interface over a Unix Domain socket; the lightning-cli tool can be used to access it, or there is a python client library.
You can use lightning-cli help to print a table of RPC methods; lightning-cli help <command>
will offer specific information on that command.
Useful commands:
- newaddr: get a bitcoin address to deposit funds into your lightning node.
- listfunds: see where your funds are.
- connect: connect to another lightning node.
- fundchannel: create a channel to another connected node.
- invoice: create an invoice to get paid by another node.
- pay: pay someone else's invoice.
- plugin: commands to control extensions.
Care And Feeding Of Your New Lightning Node
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:
https://github.com/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!
Opening A Channel
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
Confirm lightningd got funds by:
# Returns an array of on-chain funds.
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>:
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 state is CHANNELD_NORMAL; after 6 confirmations you can use lightning-cli listchannels to verify that the public field is now true.
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:
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:
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 top-level lightning directory or network subdirectory
(eg. ~/.lightning/config or ~/.lightning/bitcoin/config). See man -l doc/lightningd-config.5.
Further information
Pruning
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.
If 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 bitcoin-cli getblockchaininfo.
If the two blockheights drift apart it might be necessary to intervene.
HD wallet encryption
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 decrypt method.
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
Developers wishing to contribute should start with the developer guide here.
You should also configure with --enable-developer to get additional checks and options.