mirrors/eclair
1
0
Fork 0
mirror of https://github.com/ACINQ/eclair.git synced 2024-11-20 18:50:43 +01:00
Code Issues Projects Releases Wiki Activity
A scala implementation of the Lightning Network.
883 Commits 46 Branches 96 Tags 127 MiB
Scala 99.3%
Shell 0.3%
Java 0.2%
0c580528b7
Go to file
pm47 0c580528b7 made build process less verbose
2017-03-21 14:55:16 +01:00
.readme Updated readme screenshot 2017-02-01 19:47:50 +01:00
eclair-node made build process less verbose 2017-03-21 14:55:16 +01:00
travis removed old protobuf dependency and related module 2017-01-31 16:23:35 +01:00
.gitignore temporary test files are now written to target/ directory 2017-03-16 16:46:54 +01:00
.travis.yml re-enabled travis tests 2017-01-17 19:09:06 +01:00
BUILD.md Update README.md and add build.md 2017-03-17 19:07:29 +01:00
LICENSE now using sonatype repos for acinq-tools 2016-01-21 15:04:42 +01:00
pom.xml BOLT 4: propagate htlc failures upstream (#30) 2017-03-17 17:01:14 +01:00
README.md Update README.md 2017-03-17 19:08:24 +01:00
TESTING.md fixed tests covering OPEN->NORMAL 2016-12-09 17:08:16 +01:00

README.md

Eclair Logo

Build Status License

Eclair (french for Lightning) is a scala implementation of the Lightning Network. It can run with or without a GUI, and a JSON-RPC API is also available.

This software follows the Lightning Network Specifications (BOLTs). Other implementations include lightning-c, lit, and lnd.

🚧 Both the BOLTs and Eclair itself are a work in progress. Expect things to break/change!

⚠️ Eclair currently only runs on regtest or testnet.

Lightning Network Specification Compliance

Eclair 0.2-Alpha1 is fully compliant with the BOLTs at commit 06a5e6cbdbb4c6f8b8dab444de497cdb9c7d7f02:

  • BOLT 1: Base Protocol
  • BOLT 2: Peer Protocol for Channel Management
  • BOLT 3: Bitcoin Transaction and Script Formats
  • BOLT 4: Onion Routing Protocol
  • BOLT 5: Recommendations for On-chain Transaction Handling
  • BOLT 7: P2P Node and Channel Discovery
  • BOLT 8: Encrypted and Authenticated Transport
  • BOLT 9: Assigned Feature Flags

Overview

Eclair Demo

Installation

Configuring Bitcoin Core

Eclair needs a synchronized, segwit-ready, non-pruning, tx-indexing Bitcoin-core node.

Run bitcoind with the following bitcoin.conf:

testnet=1
server=1
rpcuser=XXX
rpcpassword=XXX
txindex=1

Installing Eclair

Windows

Just use the windows installer, it should create a shortcut on your desktop.

Linux, MacOs or manual install on Windows

You need to first install java, more precisely a JRE 1.8+.

Then just grab the latest fat jar and run:

java -jar eclair-node_xxxxxx-fat.jar

Configuring Eclair

Eclair will create a directory in ~/.eclair by default. You may change this directory's location using --datadir <dir> command line argument.

If you want to change configuration parameters, create a file named eclair.conf in eclair's home directory.

option description default value
eclair.server.port TCP port 9735
eclair.http.port HTTP port 8080
eclair.bitcoind.rpcuser Bitcoin Core RPC user foo
eclair.bitcoind.rpcpassword Bitcoin Core RPC password bar

→ see application.conf for full reference.

JSON-RPC API

method params description
connect host, port, anchor_amount opens a channel with another eclair or lightningd instance
list lists existing channels
addhtlc channel_id, amount, rhash, locktime sends an htlc
fulfillhtlc channel_id, r fulfills an htlc
close channel_id closes a channel
help displays available methods

Resources