mirror of
https://github.com/ACINQ/eclair.git
synced 2025-02-22 06:21:42 +01:00
Update README.md
This commit is contained in:
parent
d4b0faca63
commit
8d81635507
1 changed files with 20 additions and 4 deletions
24
README.md
24
README.md
|
@ -16,10 +16,26 @@ A "blockchain watcher" is responsible for monitoring the blockchain, and sending
|
||||||
* eclair-demo: actual implementation
|
* eclair-demo: actual implementation
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
Run `Demo.scala` to have an example of:
|
- Either run from source:
|
||||||
1. Opening a channel
|
```
|
||||||
2. Updating the balance with an HTLC
|
mvn exec:java -Dexec.mainClass=fr.acinq.eclair.Boot
|
||||||
3. Closing the channel
|
```
|
||||||
|
- 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
|
## Status
|
||||||
- [X] Network
|
- [X] Network
|
||||||
|
|
Loading…
Add table
Reference in a new issue