9627bf9ba1
It breaks, but more importantly we don't need to install lowdown any more, since the check in build-release.sh has been removed. ``` Run sudo apt-get install -y lowdown Reading package lists... Building dependency tree... Reading state information... The following NEW packages will be installed: lowdown 0 upgraded, 1 newly installed, 0 to remove and 21 not upgraded. Need to get 129 kB of archives. After this operation, 314 kB of additional disk space will be used. Get:1 file:/etc/apt/apt-mirrors.txt Mirrorlist [144 B] Get:2 http://azure.archive.ubuntu.com/ubuntu noble/universe amd64 lowdown amd64 1.1.0-1 [129 kB] Fetched 129 kB in 0s (2971 kB/s) Selecting previously unselected package lowdown. (Reading database ... (Reading database ... 5% (Reading database ... 10% (Reading database ... 15% (Reading database ... 20% (Reading database ... 25% (Reading database ... 30% (Reading database ... 35% (Reading database ... 40% (Reading database ... 45% (Reading database ... 50% (Reading database ... 55% (Reading database ... 60% (Reading database ... 65% (Reading database ... 70% (Reading database ... 75% (Reading database ... 80% (Reading database ... 85% (Reading database ... 90% (Reading database ... 95% (Reading database ... 100% (Reading database ... 216225 files and directories currently installed.) Preparing to unpack .../lowdown_1.1.0-1_amd64.deb ... Unpacking lowdown (1.1.0-1) ... Setting up lowdown (1.1.0-1) ... Processing triggers for man-db (2.12.0-4build2) ... Not building database; man-db/auto-update is not 'true'. Running kernel seems to be up-to-date. No services need to be restarted. No containers need to be restarted. checking for getpagesize() in <unistd.h>... yes checking for isblank() in <ctype.h>... yes checking for little endian... yes checking for memmem in <string.h>... yes checking for memrchr in <string.h>... yes checking for mmap() declaration... yes checking for /proc/self/maps exists... yes checking for qsort_r cmp takes trailing arg... yes checking for __attribute__((section)) and __start/__stop... yes checking for stack grows upwards... no checking for statement expression support... yes checking for <sys/filio.h>... no checking for <sys/termios.h>... yes checking for <sys/unistd.h>... yes checking for __typeof__ support... yes checking for unaligned access to int... yes checking for utime() declaration... yes checking for __attribute__((warn_unused_result))... yes checking for #pragma omp and -fopenmp support... yes checking for <valgrind/memcheck.h>... no checking for working <ucontext.h... yes checking for passing pointers via makecontext()... yes checking for __builtin_cpu_supports()... yes checking for closefrom() offered by system... yes checking for F_CLOSEM defined for fctnl.... no checking for close_range syscall available as __NR_close_range.... yes checking for F_MAXFD defined for fcntl.... no checking for zlib support... yes checking for libsodium with IETF chacha20 variants... no checking for sqlite3... yes checking for postgres... yes checking for User Statically-Defined Tracing (USDT)... no checking for compiler is GCC... yes checking for GCC version is 7 or above... yes Writing variables to config.vars.2200... yes Writing header to ccan/config.h.2200... yes checking for python3-mako... not found checking for lowdown... found checking for sha256sum... found checking for jq... found Setting PREFIX... /usr/local Setting CC... cc Setting CONFIGURATOR_CC... cc Setting CWARNFLAGS... -Wall -Wundef -Wmissing-prototypes -Wmissing-declarations -Wstrict-prototypes -Wold-style-definition -Werror -Wno-maybe-uninitialized -Wshadow=local Setting CDEBUGFLAGS... -std=gnu11 -g -fstack-protector-strong Setting COPTFLAGS... -Og CSANFLAGS not found FUZZFLAGS not found FUZZER_LIB not found LLVM_LDFLAGS not found SQLITE3_CFLAGS not found Setting SQLITE3_LDLIBS... -lsqlite3 Setting POSTGRES_INCLUDE... -I/usr/include/postgresql Setting POSTGRES_LDLIBS... -L/usr/lib/x86_64-linux-gnu -lpq SODIUM_CFLAGS not found SODIUM_LDLIBS not found Setting VALGRIND... 0 Setting DEBUGBUILD... 0 Setting COMPAT... 1 Setting PYTEST... python3 -m pytest Setting STATIC... 0 Setting CLANG_COVERAGE... 0 Setting ASAN... 0 Setting UBSAN... 0 Setting TEST_NETWORK... regtest Setting HAVE_PYTHON3_MAKO... 0 Setting SHA256SUM... sha256sum Setting FUZZING... 0 Setting RUST... 1 Setting PYTHON... python3 Setting SED... sed *** We need a libsodium >= 1.0.4 (released 2015-06-11). Error: Process completed with exit code 1. ``` Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
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 (testnet4 or regtest), but the implementation is considered stable and can be safely used on mainnet.
Reach Out to Us
Any help testing the implementation, reporting bugs, or helping with outstanding issues is very welcome. Don't hesitate to reach out to us on the implementation-specific mailing list, or on CLN Discord, or on CLN Telegram, or on IRC at dev/gen channel.
Getting Started
Core Lightning only works on Linux and macOS, and requires a locally (or remotely) running bitcoind (version 25.0 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 3 supported installation options:
- 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.
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
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://docs.corelightning.org/docs) 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
For a less reckless experience, you can encrypt the HD wallet seed: see HD wallet encryption.
You can also chat to other users at Discord core-lightning; 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.
Alternatively you can generate a taproot address should your source of funds support it:
# Return a taproot address
lightning-cli newaddr p2tr
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.
A sample configuration file is available at contrib/config-example.
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.