eclair

![Eclair Logo](.readme/logo.png)

[![Build Status](https://github.com/ACINQ/eclair/workflows/Build%20&%20Test/badge.svg)](https://github.com/ACINQ/eclair/actions?query=workflow%3A%22Build+%26+Test%22)
[![codecov](https://codecov.io/gh/acinq/eclair/branch/master/graph/badge.svg)](https://codecov.io/gh/acinq/eclair)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)

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

This software follows the [Lightning Network Specifications (BOLTs)](https://github.com/lightning/bolts).
Other implementations include [core lightning](https://github.com/ElementsProject/lightning), [lnd](https://github.com/LightningNetwork/lnd), [electrum](https://github.com/spesmilo/electrum/), and [ldk](https://github.com/lightningdevkit/rust-lightning).

---

* [Lightning Network Specification Compliance](#lightning-network-specification-compliance)
* [JSON API](#json-api)
* [Documentation](#documentation)
* [Installation](#installation)
  * [Prerequisite: Bitcoin Core](#prerequisite-bitcoin-core)
  * [Installing Eclair](#installing-eclair)
* [Configuration](#configuration)
  * [Configuration file](#configuration-file)
  * [Configure Bitcoin Core wallet](#configure-bitcoin-core-wallet)
  * [Java Environment Variables](#java-environment-variables)
  * [Logging](#logging)
  * [Backup](#backup)
* [Docker](#docker)
* [Plugins](#plugins)
* [Testnet usage](#testnet-usage)
* [Tools](#tools)
* [Resources](#resources)

---

## Lightning Network Specification Compliance

Please see the latest [release note](https://github.com/ACINQ/eclair/releases) 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](https://acinq.github.io/eclair).

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

## Documentation

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

You will also find detailed [guides](./docs/Guides.md) and [frequently asked questions](./docs/FAQ.md) 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](https://github.com/ACINQ/bitcoin-kmp) to verify data