Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add on-chain APIs #1461

Merged
merged 7 commits into from Jun 19, 2020
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
59 changes: 49 additions & 10 deletions eclair-core/eclair-cli
Expand Up @@ -26,19 +26,58 @@ where OPTIONS can be:
-h Show this help
-s Some commands can print a trimmed JSON

and COMMAND is one of:
getinfo, connect, disconnect, open, close, forceclose, updaterelayfee,
peers, channels, channel, allnodes, allchannels, allupdates
findroute, findroutetonode, parseinvoice, payinvoice, sendtonode,
sendtoroute, getsentinfo, createinvoice, getinvoice, listinvoices,
listpendinginvoices, getreceivedinfo, audit, networkfees,
channelstats, usablebalances
and COMMAND is one of the available commands:
t-bast marked this conversation as resolved.
Show resolved Hide resolved

=== Node ===
- getinfo
- connect
- disconnect
- peers
- allnodes
- audit

=== Channel ===
- open
- close
- forceclose
- channel
- channels
- allchannels
- allupdates
- channelstats
- networkfees
- updaterelayfee

=== Path-finding ===
- findroute
- findroutetonode
- networkstats

=== Invoice ===
- createinvoice
- getinvoice
- listinvoices
- listpendinginvoices
- parseinvoice

=== Payment ===
- getnewaddress
- usablebalances
- onchainbalances
- payinvoice
- sendtonode
- sendtoroute
- sendonchain
- getsentinfo
- getreceivedinfo
- listtransactions

Examples
--------
eclair-cli -a localhost:1234 peers list the peers of a node hosted on localhost:1234
eclair-cli close --channelId=006fb... closes the channel with id 006fb...

eclair-cli -a localhost:1234 peers list the peers of a node hosted on localhost:1234
eclair-cli connect --nodeId=03864e... connect to node with id 03864e...
eclair-cli open --nodeId=... --fundingSatoshis=... open a channel to a given node
eclair-cli close --channelId=006fb... closes the channel with id 006fb...

Full documentation here: <https://acinq.github.io/eclair>" 1>&2;
exit 1;
Expand Down