mirrors/eclair
1
0
Fork 0
mirror of https://github.com/ACINQ/eclair.git synced 2024-11-19 09:54:02 +01:00
Code Issues Projects Releases Wiki Activity
A scala implementation of the Lightning Network.
214 Commits 48 Branches 96 Tags 127 MiB
Scala 99.3%
Shell 0.3%
Java 0.2%
d3766ec46b
Go to file
Pierre-Marie Padiou d3766ec46b Update README.md
2016-02-24 11:44:14 +01:00
eclair-demo fixed inconsistency in WatchSpent(Anchor) between funder and fundee 2016-02-22 13:33:34 +01:00
lightning-types added scalapb and google .proto files (otherwise travis doesn't work) 2016-02-18 18:46:23 +01:00
.gitignore improve tests 2016-02-16 18:16:10 +01:00
.travis.yml set version to 0.1-SNAPSHOT 2016-02-17 16:16:46 +01:00
LICENSE now using sonatype repos for acinq-tools 2016-01-21 15:04:42 +01:00
pom.xml custom toString for sha256_hash and signature, updated scalapb to 0.4.21 2016-02-18 17:39:59 +01:00
README.md Update README.md 2016-02-24 11:44:14 +01:00
TESTING.md Update TESTING.md 2016-02-17 11:47:27 +01:00

README.md

Build Status

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

Prerequisites:

  • A JRE or JDK depending on wether you want to compile yourself or not (preferably > 1.8)
  • A running bitcoin-core (testnet or regtest)

⚠️ eclair demo currently runs on testnet or regtest only. Do not try and modify it to run on bitcoin mainnet!

Either run from source:

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

Or grab the latest released jar and run:

java -jar eclair-demo_2.11-*-capsule-fat.jar

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

Available jvm options (see application.conf for full reference):

eclair.server.port (default: 45000)
eclair.http.port (default: 8080)
eclair.bitcoind.rpcuser (default: foo)
eclair.bitcoind.rpcpassword (default: bar)

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

Status

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

Ressources