mirrors/eclair
1
0
Fork 0
mirror of https://github.com/ACINQ/eclair.git synced 2024-11-19 01:43:22 +01:00
Code Issues Projects Releases Wiki Activity
40ef3655cf
eclair/README.md
Fabrice Drouin 6f8713788c
Delegate Bitcoin Core's private key management to Eclair (#2613) 
* Make Eclair manage bitcoin core's wallet private keys

We create an empty watch-only wallet and import public descriptors generated by Eclair.
Bitcoin Core can fund transaction and manage utxos, but can no longer sign transactions.

* Check that spent amounts and utxos are consistent before we sign a PSBT

PSBT utxo fields include the amount that are being spent by the PSBT inputs, but there is a "fee attack"
where using amounts that are lower than what is actually spent may make us sign a tx that spends much more
in fees than we think.

* Check that non-segwit uxto has been provided and inputs are signed with SIGHASH_ALL

* Verify that Bitcoin Core's fee match what we specified

When we call Bitcoin Core's `fundrawtransaction` RPC method, we check that the fee that we pay match the fee rate that we requested.
The fee is computed using the utxo information that Bitcoin Core adds to our PSBT before we sign it.

We can safely used this information because if Bitcoin Core lies about the value of the inputs that we're spending then the signature we produce will also not be valid (it commits to the value being spent).

When we're adding wallet inputs to "bump" the fees of a parent transaction we need to take the whole package into account when we verify the actual fee rate, which is why some internal methods were modified to return the package weight that was used as reference when `fundrawtransaction` was called.

* Check that fundrawtransaction does not add more than 1 change output

* Validate addresses and keys generated by bitcoin core

When eclair manages private keys, make sure that we can re-compute addresses and keys
generated by bitcoin core.

* Add a separate configuration file for Eclair's onchain signer

Eclair's onchain signer now has its own `eclair-signer.conf` configuration file in HOCON format.
It includes BIP39 mnemonic codes and passphrase, a wallet name and a timestamp.

When an `eclair-signer.conf` file is found, Eclair's API will return descriptors that can be imported into an
empty watch-only Bitcoin Wallet.
When wallet name in `eclair-signer.conf` matches the name of the Bitcoin Core wallet defined in `eclair.conf`
(`eclair.bitcoind.wallet`), Eclair will bypass Bitcoin Core and sign onchain transactions directly.

* Skip validation of local non-change outputs:

Local non-change outputs send to an external address, for splicing out funds for example.
We assume that these inputs are trusted i.e have been created by a trusted API call and our local
onchain key manager will not validate them during the signing process.

* Document why we use a separate, specific file for the onchain key manager

Using a new signer section is eclair.conf would be simpler but "leaks" because it becomes available everywhere
in the code through the actor system's settings instead of being contained to where it is actually needed
and could potentially be exposed through a bug that "exports" the configuration (through logs, ....)
though this is highly unlikely.

* Additional changes to delegate bitcoin core keys to eclair (#2726)

Refactor the `BitcoinCoreClient` and `LocalOnChainKeyManager` to:

- rely less on exceptions
- use more idiomatic scala (reduce dependency on kotlin types)
- provide more detailed logs

We also simplify the `useEclairSigner` field in `BitcoinCoreClient`.
The complexity of handling the case where there was an on-chain key
manager but for a different wallet than the one configured isn't
something that should be used, so it wasn't worth supporting.

Some checks were inconsistent and are now unified:

- checking the exact `scriptPubKey` in our outputs in TODO and TODO
- we allow using `fundTransaction` with a tx that already includes a
  change output (which may happen when RBF-ing a transaction)
- `getP2wpkhPubkeyHashForChange` didn't verify the returned key

We completely separate the two cases in `signPsbt`, because otherwise
in the non eclair-backed case, we were calling bitcoind's `processpsbt`
twice for no good reason, which is bad for performance.

We also decouple the `OnChainKeyManager` from the `BitcoinCoreClient`.
This lets users keep running their eclair node with a bitcoin client that
owns the private key while configuring the on-chain key manager for a
future bitcoin client that will leverage this on-chain key manager.

Users can use the eclair APIs to get the master xpub and descriptors to
properly configure their next bitcoin core node, and switch to it once it
has synchronized the descriptors.

* Simplify replaceable tx funding

We were previously signing twice (with makes a call to `bitcoind`),
just to get the final weights and adjust the change outputs. This was
unnecessary, as we can adjust the weights before adding inputs.

We were also duplicating the checks where we verify that `bitcoind` is
malicious. We only need to check that once, during the final signing step.

---------

Co-authored-by: Bastien Teinturier <31281497+t-bast@users.noreply.github.com>
2023-09-21 15:54:28 +02:00

15 KiB
Raw Blame History

Eclair Logo

Build Status codecov License

Eclair (French for Lightning) is a Scala implementation of the Lightning Network.

This software follows the Lightning Network Specifications (BOLTs). Other implementations include core lightning, lnd, electrum, and ldk.

Lightning Network Specification Compliance

Please see the latest release note for detailed information on BOLT compliance.

JSON API

Eclair offers a feature-rich HTTP API that enables application developers to easily integrate.

For more information please visit the API documentation website.

🚨 Eclair's JSON API should NOT be accessible from the outside world (similarly to Bitcoin Core API)

Documentation

Please visit our docs folder to find detailed instructions on how to configure your node, connect to other nodes, open channels, send and receive payments, and help with more advanced scenarios.

You will also find detailed guides and frequently asked questions there.

Installation

Prerequisite: Bitcoin Core

Eclair relies on Bitcoin Core to interface with and monitor the blockchain and to manage on-chain funds: Eclair does not include an on-chain wallet, channel opening transactions are funded by your Bitcoin Core node, and channel closing transactions return funds to your Bitcoin Core node.

This means that instead of re-implementing them, Eclair benefits from the verifications and optimisations (including fee management with RBF/CPFP, ...) that are implemented by Bitcoin Core. Eclair uses our own bitcoin library to verify data provided by Bitcoin Core.

⚠️ This also means that Eclair has strong requirements on how your Bitcoin Core node is configured (see below), and that you must back up your Bitcoin Core wallet as well as your Eclair node (see here):

  • Eclair needs a synchronized, segwit-ready, zeromq-enabled, wallet-enabled, non-pruning, tx-indexing Bitcoin Core node.
  • You must configure your Bitcoin node to use bech32 or bech32m (segwit) addresses. If your wallet has "non-segwit UTXOs" (outputs that are neither p2sh-segwit, bech32 or bech32m), you must send them to a bech32 or bech32m address before running Eclair.
  • Eclair requires Bitcoin Core 24.1 or higher. If you are upgrading an existing wallet, you may need to create a new address and send all your funds to that address.

Run bitcoind with the following minimal bitcoin.conf:

server=1
rpcuser=foo
rpcpassword=bar
txindex=1
addresstype=bech32
changetype=bech32
zmqpubhashblock=tcp://127.0.0.1:29000
zmqpubrawtx=tcp://127.0.0.1:29000

Depending on the actual hardware configuration, it may be useful to provide increased dbcache parameter value for faster verification and rpcworkqueue parameter value for better handling of API requests on bitcoind side.

# UTXO database cache size, in MiB
dbcache=2048
# Number of allowed pending RPC requests (default is 16)
rpcworkqueue=128

# How many seconds bitcoin will wait for a complete RPC HTTP request.
# after the HTTP connection is established.
rpcclienttimeout=30

Installing Eclair

Eclair is developed in Scala, a powerful functional language that runs on the JVM, and is packaged as a ZIP archive.

To run Eclair, you first need to install Java, we recommend that you use OpenJDK 11. Other runtimes also work, but we don't recommend using them.

Then download our latest release, unzip the archive and run the following command:

eclair-node-<version>-<commit_id>/bin/eclair-node.sh

You can then control your node via eclair-cli or the API.

⚠️ Be careful when following tutorials/guides that may be outdated or incomplete. You must thoroughly read the official eclair documentation before running your own node.

Configuration

Configuration file

Eclair reads its configuration file, and write its logs, to ~/.eclair by default.

To change your node's configuration, create a file named eclair.conf in ~/.eclair. Here's an example configuration file:

eclair.node-alias=eclair
eclair.node-color=49daaa

Here are some of the most common options:

name description default value
eclair.chain Which blockchain to use: regtest, testnet, signet or mainnet mainnet
eclair.server.port Lightning TCP port 9735
eclair.api.enabled Enable/disable the API false. By default the API is disabled. If you want to enable it, you must set a password.
eclair.api.port API HTTP port 8080
eclair.api.password API password (BASIC) "" (must be set if the API is enabled)
eclair.bitcoind.rpcuser Bitcoin Core RPC user foo
eclair.bitcoind.rpcpassword Bitcoin Core RPC password bar
eclair.bitcoind.zmqblock Bitcoin Core ZMQ block address "tcp://127.0.0.1:29000"
eclair.bitcoind.zmqtx Bitcoin Core ZMQ tx address "tcp://127.0.0.1:29000"
eclair.bitcoind.wallet Bitcoin Core wallet name ""

Quotes are not required unless the value contains special characters. Full syntax guide here.

→ see here for more configuration options.

Configure Bitcoin Core wallet

Eclair will use the default loaded Bitcoin Core wallet to fund any channels you choose to open. If you want to use a different wallet from the default one, you must set eclair.bitcoind.wallet accordingly in your eclair.conf.

⚠️ Once a wallet is configured, you must be very careful if you want to change it: changing the wallet when you have channels open may result in a loss of funds (or a complex recovery procedure).

Eclair will return BTC from closed channels to the wallet configured. Any BTC found in the wallet can be used to fund the channels you choose to open.

We also recommend tweaking the following parameters in bitcoin.conf:

# This parameter ensures that your wallet will not create chains of unconfirmed
# transactions that would be rejected by other nodes.
walletrejectlongchains=1
# The following parameters set the maximum length of chains of unconfirmed
# transactions to 20 instead of the default value of 25.
limitancestorcount=20
limitdescendantcount=20

Setting these parameters lets you unblock long chains of unconfirmed channel funding transactions by using child-pays-for-parent (CPFP) to make them confirm.

With the default bitcoind parameters, if your node created a chain of 25 unconfirmed funding transactions with a low-feerate, you wouldn't be able to use CPFP to raise their fees because your CPFP transaction would likely be rejected by the rest of the network.

You can also configure Eclair to manage Bitcoin Core's private keys, see our guides for more details.

Java Environment Variables

Some advanced parameters can be changed with java environment variables. Most users won't need this and can skip this section.

However, if you're seeing Java heap size errors, you can try increasing the maximum memory allocated to the JVM with the -Xmx parameter.

You can for example set it to use up to 512 MB (or any value that fits the amount of RAM on your machine) with:

export JAVA_OPTS=-Xmx512m

⚠️ Using separate datadir is mandatory if you want to run several instances of eclair on the same machine. You will also have to change ports in eclair.conf (see above).

name description default value
eclair.datadir Path to the data directory ~/.eclair
eclair.printToConsole Log to stdout (in addition to eclair.log)

For example, to specify a different data directory you would run the following command:

eclair-node-<version>-<commit_id>/bin/eclair-node.sh -Declair.datadir=/tmp/node1

Logging

Eclair uses logback for logging. To use a different configuration, and override the internal logback.xml, run:

eclair-node-<version>-<commit_id>/bin/eclair-node.sh -Dlogback.configurationFile=/path/to/logback-custom.xml

Backup

You need to backup:

  • your Bitcoin Core wallet
  • your Eclair channels

For Bitcoin Core, you need to backup the wallet file for the wallet that Eclair is using. You only need to do this once, when the wallet is created. See Managing Wallets in the Bitcoin Core documentation for more information.

For Eclair, the files that you need to backup are located in your data directory. You must backup:

  • your seeds (node_seed.dat and channel_seed.dat)
  • your channel database (eclair.sqlite.bak under directory mainnet, testnet, signet or regtest depending on which chain you're running on)

Your seeds never change once they have been created, but your channels will change whenever you receive or send payments. Eclair will create and maintain a snapshot of its database, named eclair.sqlite.bak, in your data directory, and update it when needed. This file is always consistent and safe to use even when Eclair is running, and this is what you should back up regularly.

For example, you could configure a cron task for your backup job. Or you could configure an optional notification script to be called by eclair once a new database snapshot has been created, using the following option:

eclair.file-backup.notify-script = "/absolute/path/to/script.sh"

Make sure your script is executable and uses an absolute path name for eclair.sqlite.bak.

Note that depending on your filesystem, in your backup process we recommend first moving eclair.sqlite.bak to some temporary file before copying that file to your final backup location.

Docker

A Dockerfile x86_64 image is built on each commit on docker hub for running a dockerized eclair-node. For arm64 platforms you can use an arm64 Dockerfile to build your own arm64 container.

You can use the JAVA_OPTS environment variable to set arguments to eclair-node.

docker run -ti --rm -e "JAVA_OPTS=-Xmx512m -Declair.api.binding-ip=0.0.0.0 -Declair.node-alias=node-pm -Declair.printToConsole" acinq/eclair

If you want to persist the data directory, you can make the volume to your host with the -v argument, as the following example:

docker run -ti --rm -v "/path_on_host:/data" -e "JAVA_OPTS=-Declair.printToConsole" acinq/eclair

If you enabled the API you can check the status of Eclair using the command line tool:

docker exec <container_name> eclair-cli -p foobar getinfo

Plugins

For advanced usage, Eclair supports plugins written in Scala, Java, or any JVM-compatible language.

A valid plugin is a jar that contains an implementation of the Plugin interface, and a manifest entry for Main-Class with the FQDN of the implementation.

Here is how to run Eclair with plugins:

eclair-node-<version>/bin/eclair-node.sh <plugin1.jar> <plugin2.jar> <...>

You can find more details about plugins in the eclair-plugins repository.

Testnet usage

Eclair is configured to run on mainnet by default, but you can still run it on testnet (or regtest/signet): start your Bitcoin node in testnet mode (add testnet=1 in bitcoin.conf or start with -testnet), and change Eclair's chain parameter and Bitcoin RPC port:

eclair.chain=testnet
eclair.bitcoind.rpcport=18332

For regtest, add regtest=1 in bitcoin.conf or start with -regtest, and modify eclair.conf:

eclair.chain = "regtest"
eclair.bitcoind.rpcport=18443

For signet, add signet=1 in bitcoin.conf or start with -signet, and modify eclair.conf:

eclair.chain = "signet"
eclair.bitcoind.rpcport=38332

You may also want to take advantage of the new configuration sections in bitcoin.conf to manage parameters that are network specific, so you can easily run your Bitcoin node on both mainnet and testnet. For example you could use:

server=1
txindex=1

addresstype=bech32
changetype=bech32

walletrejectlongchains=1
limitancestorcount=20
limitdescendantcount=20

[main]
rpcuser=<your-mainnet-rpc-user-here>
rpcpassword=<your-mainnet-rpc-password-here>
zmqpubhashblock=tcp://127.0.0.1:29000
zmqpubrawtx=tcp://127.0.0.1:29000

[test]
rpcuser=<your-testnet-rpc-user-here>
rpcpassword=<your-testnet-rpc-password-here>
zmqpubhashblock=tcp://127.0.0.1:29001
zmqpubrawtx=tcp://127.0.0.1:29001

Tools

Resources