docs: Relocate original README content and update project documentation, security, and licensing files
This commit is contained in:
12
.github/PULL_REQUEST_TEMPLATE.md
vendored
12
.github/PULL_REQUEST_TEMPLATE.md
vendored
@@ -1,17 +1,7 @@
|
||||
> [!IMPORTANT]
|
||||
>
|
||||
> 26.04 FREEZE March 11th: Non-bugfix PRs not ready by this date will wait for 26.06.
|
||||
>
|
||||
> RC1 is scheduled on _March 23rd_
|
||||
>
|
||||
> The final release is scheduled for April 15th.
|
||||
|
||||
|
||||
## Checklist
|
||||
|
||||
Before submitting the PR, ensure the following tasks are completed. If an item is not applicable to your PR, please mark it as checked:
|
||||
|
||||
- [ ] The changelog has been updated in the relevant commit(s) according to the [guidelines](https://docs.corelightning.org/docs/coding-style-guidelines#changelog-entries-in-commit-messages).
|
||||
- [ ] Tests have been added or modified to reflect the changes.
|
||||
- [ ] Documentation has been reviewed and updated as needed.
|
||||
- [ ] Related issues have been listed and linked, including any that this PR closes.
|
||||
- [ ] *Important* All PRs must consider how to reverse any persistent changes for `tools/lightning-downgrade`
|
||||
|
||||
3967
CHANGELOG.md
3967
CHANGELOG.md
File diff suppressed because it is too large
Load Diff
1
LICENSE
1
LICENSE
@@ -1,6 +1,7 @@
|
||||
Note: the modules in the ccan/ directory have their own licenses, but
|
||||
the rest of the code is covered by the following (BSD-MIT) license:
|
||||
|
||||
Copyright Davide Grilli (Palladium Developer) 2026.
|
||||
Copyright Rusty Russell (Blockstream) 2015-2024.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
|
||||
229
README-original.md
Normal file
229
README-original.md
Normal file
@@ -0,0 +1,229 @@
|
||||
# Core Lightning (CLN): A specification compliant Lightning Network implementation in C
|
||||
|
||||
Core Lightning (previously c-lightning) is a lightweight, highly customizable and [standard compliant][std] implementation of the Lightning Network protocol.
|
||||
|
||||
* [Getting Started](#getting-started)
|
||||
* [Installation](#installation)
|
||||
* [Starting lightningd](#starting-lightningd)
|
||||
* [Using the JSON-RPC Interface](#using-the-json-rpc-interface)
|
||||
* [Care And Feeding Of Your New Lightning Node](#care-and-feeding-of-your-new-lightning-node)
|
||||
* [Opening A Channel](#opening-a-channel)
|
||||
* [Sending and Receiving Payments](#sending-and-receiving-payments)
|
||||
* [Configuration File](#configuration-file)
|
||||
* [Further Information](#further-information)
|
||||
* [FAQ](doc/FAQ.md)
|
||||
* [Pruning](#pruning)
|
||||
* [HD wallet encryption](#hd-wallet-encryption)
|
||||
* [Developers](#developers)
|
||||
* [Documentation](https://docs.corelightning.org/docs)
|
||||
|
||||
## Project Status
|
||||
|
||||
[![Continuous Integration][actions-badge]][actions]
|
||||
[![Pull Requests Welcome][prs-badge]][prs]
|
||||
[![Documentation Status][docs-badge]][docs]
|
||||
[![Telegram][telegram-badge]][telegram]
|
||||
[![Discord][discord-badge]][discord]
|
||||
[![Irc][IRC-badge]][IRC]
|
||||
|
||||
This implementation has been in production use on the Bitcoin mainnet since early 2018, with the launch of the [Blockstream Store][blockstream-store-blog].
|
||||
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][ml1], or on [CLN Discord][discord], or on [CLN Telegram][telegram], or on IRC at [dev][irc1]/[gen][irc2] 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](#pruning) for more details.
|
||||
|
||||
### Installation
|
||||
|
||||
There are 3 supported installation options:
|
||||
|
||||
- Installation of a pre-compiled binary from the [release page][releases] on GitHub.
|
||||
- Using one of the [provided docker images][dockerhub] on the Docker Hub.
|
||||
- Compiling the source code yourself as described in the [installation documentation](doc/getting-started/getting-started/installation.md).
|
||||
|
||||
### 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.
|
||||
|
||||
```bash
|
||||
. contrib/startup_regtest.sh
|
||||
```
|
||||
|
||||
#### Mainnet Option
|
||||
To test with real bitcoin, you will need to have a local `bitcoind` node running:
|
||||
|
||||
```bash
|
||||
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](#pruning) for more information.
|
||||
|
||||
You can start `lightningd` with the following command:
|
||||
|
||||
```bash
|
||||
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][jsonrpcspec] interface over a Unix Domain socket; the `lightning-cli` tool can be used to access it, or there is a [python client library](contrib/pyln-client).
|
||||
|
||||
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](https://docs.corelightning.org/reference/newaddr): get a bitcoin address to deposit funds into your lightning node.
|
||||
* [listfunds](https://docs.corelightning.org/reference/listfunds): see where your funds are.
|
||||
* [connect](https://docs.corelightning.org/reference/connect): connect to another lightning node.
|
||||
* [fundchannel](https://docs.corelightning.org/reference/fundchannel): create a channel to another connected node.
|
||||
* [invoice](https://docs.corelightning.org/reference/invoice): create an invoice to get paid by another node.
|
||||
* [pay](https://docs.corelightning.org/reference/pay): pay someone else's invoice.
|
||||
* [plugin](https://docs.corelightning.org/reference/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](#hd-wallet-encryption).
|
||||
|
||||
You can also chat to other users at Discord [core-lightning][discord];
|
||||
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:
|
||||
|
||||
```bash
|
||||
# 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:
|
||||
|
||||
```bash
|
||||
# Return a taproot address
|
||||
lightning-cli newaddr p2tr
|
||||
```
|
||||
|
||||
Confirm `lightningd` got funds by:
|
||||
|
||||
```bash
|
||||
# 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>`:
|
||||
|
||||
```bash
|
||||
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:
|
||||
|
||||
```bash
|
||||
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][BOLT11]).
|
||||
|
||||
[BOLT11]: https://github.com/lightning/bolts/blob/master/11-payment-encoding.md
|
||||
|
||||
The sender can feed this `bolt11` string to the `decode` command to see what it is, and pay it simply using the `pay` command:
|
||||
|
||||
```bash
|
||||
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 `lightning-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 `lightning-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](doc/contribute-to-core-lightning/coding-style-guidelines.md).
|
||||
|
||||
[blockstream-store-blog]: https://blockstream.com/2018/01/16/en-lightning-charge/
|
||||
[std]: https://github.com/lightning/bolts
|
||||
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat
|
||||
[prs]: http://makeapullrequest.com
|
||||
[ml1]: https://lists.ozlabs.org/listinfo/c-lightning
|
||||
[discord-badge]: https://badgen.net/badge/Discord/chat/blue
|
||||
[discord]: https://discord.gg/mE9s4rc5un
|
||||
[telegram-badge]: https://badgen.net/badge/Telegram/chat/blue
|
||||
[telegram]: https://t.me/lightningd
|
||||
[IRC-badge]: https://img.shields.io/badge/IRC-chat-blue.svg
|
||||
[IRC]: https://web.libera.chat/#c-lightning
|
||||
[irc1]: https://web.libera.chat/#lightning-dev
|
||||
[irc2]: https://web.libera.chat/#c-lightning
|
||||
[docs-badge]: https://readthedocs.org/projects/lightning/badge/?version=docs
|
||||
[docs]: https://docs.corelightning.org/docs
|
||||
[releases]: https://github.com/ElementsProject/lightning/releases
|
||||
[dockerhub]: https://hub.docker.com/r/elementsproject/lightningd/
|
||||
[jsonrpcspec]: https://www.jsonrpc.org/specification
|
||||
[helpme-github]: https://github.com/lightningd/plugins/tree/master/helpme
|
||||
[actions-badge]: https://github.com/ElementsProject/lightning/workflows/Continuous%20Integration/badge.svg
|
||||
[actions]: https://github.com/ElementsProject/lightning/actions
|
||||
229
README.md
229
README.md
@@ -1,229 +1,24 @@
|
||||
# Core Lightning (CLN): A specification compliant Lightning Network implementation in C
|
||||
# Palladium Lightning
|
||||
|
||||
Core Lightning (previously c-lightning) is a lightweight, highly customizable and [standard compliant][std] implementation of the Lightning Network protocol.
|
||||
Palladium Lightning is the standard compliant implementation of the Lightning Network protocol for **Palladium**, a fork of Bitcoin.
|
||||
|
||||
* [Getting Started](#getting-started)
|
||||
* [Installation](#installation)
|
||||
* [Starting lightningd](#starting-lightningd)
|
||||
* [Using the JSON-RPC Interface](#using-the-json-rpc-interface)
|
||||
* [Care And Feeding Of Your New Lightning Node](#care-and-feeding-of-your-new-lightning-node)
|
||||
* [Opening A Channel](#opening-a-channel)
|
||||
* [Sending and Receiving Payments](#sending-and-receiving-payments)
|
||||
* [Configuration File](#configuration-file)
|
||||
* [Further Information](#further-information)
|
||||
* [FAQ](doc/FAQ.md)
|
||||
* [Pruning](#pruning)
|
||||
* [HD wallet encryption](#hd-wallet-encryption)
|
||||
* [Developers](#developers)
|
||||
* [Documentation](https://docs.corelightning.org/docs)
|
||||
This repository is an independent professional fork of [Core Lightning (CLN)](https://github.com/ElementsProject/lightning), maintained by Davide Grilli.
|
||||
|
||||
## Project Status
|
||||
## Fork Information
|
||||
|
||||
[![Continuous Integration][actions-badge]][actions]
|
||||
[![Pull Requests Welcome][prs-badge]][prs]
|
||||
[![Documentation Status][docs-badge]][docs]
|
||||
[![Telegram][telegram-badge]][telegram]
|
||||
[![Discord][discord-badge]][discord]
|
||||
[![Irc][IRC-badge]][IRC]
|
||||
The Palladium Lightning fork officially begins from the following upstream Core Lightning commit:
|
||||
**`823a575d9a70ed7f2cb08be462c09a399a4a2842`**
|
||||
|
||||
This implementation has been in production use on the Bitcoin mainnet since early 2018, with the launch of the [Blockstream Store][blockstream-store-blog].
|
||||
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][ml1], or on [CLN Discord][discord], or on [CLN Telegram][telegram], or on IRC at [dev][irc1]/[gen][irc2] channel.
|
||||
For the original Core Lightning documentation, please refer to [`README-original.md`](README-original.md).
|
||||
|
||||
## 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](#pruning) for more details.
|
||||
Palladium Lightning aims to be lightweight, highly customizable, and fully compliant with the Lightning Network protocol adapted for the Palladium network.
|
||||
|
||||
### Installation
|
||||
### Building from Source
|
||||
|
||||
There are 3 supported installation options:
|
||||
To compile the source code, please refer to the updated instructions or refer to the original installation documentation available in `doc/getting-started/getting-started/installation.md`.
|
||||
|
||||
- Installation of a pre-compiled binary from the [release page][releases] on GitHub.
|
||||
- Using one of the [provided docker images][dockerhub] on the Docker Hub.
|
||||
- Compiling the source code yourself as described in the [installation documentation](doc/getting-started/getting-started/installation.md).
|
||||
## License
|
||||
|
||||
### 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.
|
||||
|
||||
```bash
|
||||
. contrib/startup_regtest.sh
|
||||
```
|
||||
|
||||
#### Mainnet Option
|
||||
To test with real bitcoin, you will need to have a local `bitcoind` node running:
|
||||
|
||||
```bash
|
||||
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](#pruning) for more information.
|
||||
|
||||
You can start `lightningd` with the following command:
|
||||
|
||||
```bash
|
||||
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][jsonrpcspec] interface over a Unix Domain socket; the `lightning-cli` tool can be used to access it, or there is a [python client library](contrib/pyln-client).
|
||||
|
||||
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](https://docs.corelightning.org/reference/newaddr): get a bitcoin address to deposit funds into your lightning node.
|
||||
* [listfunds](https://docs.corelightning.org/reference/listfunds): see where your funds are.
|
||||
* [connect](https://docs.corelightning.org/reference/connect): connect to another lightning node.
|
||||
* [fundchannel](https://docs.corelightning.org/reference/fundchannel): create a channel to another connected node.
|
||||
* [invoice](https://docs.corelightning.org/reference/invoice): create an invoice to get paid by another node.
|
||||
* [pay](https://docs.corelightning.org/reference/pay): pay someone else's invoice.
|
||||
* [plugin](https://docs.corelightning.org/reference/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](#hd-wallet-encryption).
|
||||
|
||||
You can also chat to other users at Discord [core-lightning][discord];
|
||||
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:
|
||||
|
||||
```bash
|
||||
# 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:
|
||||
|
||||
```bash
|
||||
# Return a taproot address
|
||||
lightning-cli newaddr p2tr
|
||||
```
|
||||
|
||||
Confirm `lightningd` got funds by:
|
||||
|
||||
```bash
|
||||
# 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>`:
|
||||
|
||||
```bash
|
||||
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:
|
||||
|
||||
```bash
|
||||
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][BOLT11]).
|
||||
|
||||
[BOLT11]: https://github.com/lightning/bolts/blob/master/11-payment-encoding.md
|
||||
|
||||
The sender can feed this `bolt11` string to the `decode` command to see what it is, and pay it simply using the `pay` command:
|
||||
|
||||
```bash
|
||||
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 `lightning-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 `lightning-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](doc/contribute-to-core-lightning/coding-style-guidelines.md).
|
||||
|
||||
[blockstream-store-blog]: https://blockstream.com/2018/01/16/en-lightning-charge/
|
||||
[std]: https://github.com/lightning/bolts
|
||||
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat
|
||||
[prs]: http://makeapullrequest.com
|
||||
[ml1]: https://lists.ozlabs.org/listinfo/c-lightning
|
||||
[discord-badge]: https://badgen.net/badge/Discord/chat/blue
|
||||
[discord]: https://discord.gg/mE9s4rc5un
|
||||
[telegram-badge]: https://badgen.net/badge/Telegram/chat/blue
|
||||
[telegram]: https://t.me/lightningd
|
||||
[IRC-badge]: https://img.shields.io/badge/IRC-chat-blue.svg
|
||||
[IRC]: https://web.libera.chat/#c-lightning
|
||||
[irc1]: https://web.libera.chat/#lightning-dev
|
||||
[irc2]: https://web.libera.chat/#c-lightning
|
||||
[docs-badge]: https://readthedocs.org/projects/lightning/badge/?version=docs
|
||||
[docs]: https://docs.corelightning.org/docs
|
||||
[releases]: https://github.com/ElementsProject/lightning/releases
|
||||
[dockerhub]: https://hub.docker.com/r/elementsproject/lightningd/
|
||||
[jsonrpcspec]: https://www.jsonrpc.org/specification
|
||||
[helpme-github]: https://github.com/lightningd/plugins/tree/master/helpme
|
||||
[actions-badge]: https://github.com/ElementsProject/lightning/workflows/Continuous%20Integration/badge.svg
|
||||
[actions]: https://github.com/ElementsProject/lightning/actions
|
||||
The code is released under the BSD-MIT License. See the [LICENSE](LICENSE) file for more details.
|
||||
|
||||
34
SECURITY.md
34
SECURITY.md
@@ -1,37 +1,9 @@
|
||||
# Security Policy
|
||||
|
||||
## Supported Versions
|
||||
|
||||
We have a 3 month release cycle, and the last two versions are supported.
|
||||
Palladium Lightning is an independent fork of Core Lightning maintained by Davide Grilli.
|
||||
|
||||
## Reporting a Vulnerability
|
||||
|
||||
To report security vulnerabilities, please send an email to one of the following addresses:
|
||||
- `rusty@rustcorp.com.au`
|
||||
- `security@blockstream.com`
|
||||
To report security vulnerabilities for Palladium Lightning, please open an issue or contact Davide Grilli directly.
|
||||
|
||||
Note: These email addresses are exclusively for vulnerability reporting.
|
||||
|
||||
For all other inquiries/communication, please refer to the [Reach Out to Us](https://github.com/ElementsProject/lightning?tab=readme-ov-file#reach-out-to-us) section in our README.
|
||||
|
||||
## Signatures For Releases
|
||||
|
||||
The following keys may be used to communicate sensitive information to
|
||||
developers, and to validate signatures on releases:
|
||||
|
||||
| Name | Email | Fingerprint |
|
||||
|------|-------|-------------|
|
||||
| Blockstream Security Reporting | `security@blockstream.com` | 1176 542D A98E 71E1 3372 2EF7 4AC8 CC88 6844 A2D6 |
|
||||
| Rusty Russell | `rusty@rustcorp.com.au` | 15EE 8D6C AB0E 7F0C F999 BFCB D920 0E6C D1AD B8F1 |
|
||||
| Christian Decker | `decker@blockstream.com` | B731 AAC5 21B0 1385 9313 F674 A26D 6D9F E088 ED58 |
|
||||
| Lisa Neigut | `niftynei@gmail.com` | 30DE 693A E0DE 9E37 B3E7 EB6B BFF0 F678 10C1 EED1 |
|
||||
| Alex Myers | `alex@endothermic.dev` | 0437 4E42 789B BBA9 462E 4767 F3BF 63F2 7474 36AB |
|
||||
| Peter Neuroth | `pet.v.ne@gmail.com` | 653B 19F3 3DF7 EFF3 E9D1 C94C C3F2 1EE3 87FF 4CD2 |
|
||||
| Shahana Farooqui | `sfarooqui@blockstream.com` | 0CCA 8183 C13A 2389 A9C5 FD29 BFB0 1536 0049 CB56 |
|
||||
| Madeline Paech | `madeline@blockstream.com` | 7169 D262 72B5 0A3F 531A A1C2 A57A FC23 1B58 0804 |
|
||||
| Blockstream CLN Release | `cln@blockstream.com` | 616C 52F9 9D06 12B2 A151 B107 4129 A994 AA7E 9852 |
|
||||
| Sangbida Chaudhuri | `sangbidac@gmail.com` | 1A37 1C2C 3064 5FAA 91AA 6B7D B643 E612 8422 1961 |
|
||||
|
||||
You can import a key by running the following command with that individual’s fingerprint:
|
||||
`gpg --keyserver hkps://keys.openpgp.org --recv-keys "<fingerprint>"`.
|
||||
Ensure that you put quotes around fingerprints containing spaces.
|
||||
For vulnerabilities that are also present in upstream Core Lightning, you may also report them to the upstream maintainers as described in their original documentation, but please disclose to Davide Grilli first if it affects Palladium specifically.
|
||||
|
||||
Reference in New Issue
Block a user