mirrors/eclair
1
0
Fork 0
mirror of https://github.com/ACINQ/eclair.git synced 2025-02-20 13:34:35 +01:00
Code Issues Projects Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
Pierre-Marie 2016-02-16 17:55:10 +01:00
parent d4b0faca63
commit 8d81635507
1 changed files with 20 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -16,10 +16,26 @@ A "blockchain watcher" is responsible for monitoring the blockchain, and sending
* eclair-demo: actual implementation
## Usage
Run `Demo.scala` to have an example of:
1. Opening a channel
2. Updating the balance with an HTLC
3. Closing the channel
- 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](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
- [X] Network