eclair

A scala implementation of the Lightning Network. Eclair is french for Lightning.

More precisely, this is an implementation of Rusty's deployable lightning. In particular it uses the same wire protocol, and almost the same state machine.

Overview

The general idea is to have an actor per channel, everything being non-blocking.

A "blockchain watcher" is responsible for monitoring the blockchain, and sending events (eg. when the anchor is spent).

Modules

• lightning-types: scala code generation using protobuf's compiler (wire protocol)
• eclair-demo: actual implementation

Usage

• Either run from source:

mvn exec:java -Dexec.mainClass=fr.acinq.eclair.Boot

• Or compile and execute the jar:

mvn install
java -jar eclair-demo/target/eclair-demo_2.11-*-capsule-fat.jar

See TESTING.md for more details on how to use this software.

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

Status

• Network
• Routing
• Channel state machine
• HTLC Scripts
• Unilateral close handling
• Relaying Payment
• Blockchain watcher
• Storing states in a database

Ressources

• [1] Lightning Network by Joseph Poon and Thaddeus Dryja (website), github repository (golang)
• [2] Deployable Lightning by Rusty Russel (Blockstream), github repository (C)
• [3] Thunder Network by Mats Jerratsch (Blockchain.info), github repository (Java)