API: replace JSON-RPC by named parameters

BUILD.md

@@ -24,3 +24,16 @@ To only build the `eclair-node` module
 $ mvn install -pl eclair-node -am -DskipTests
 ```
 
+# Building the API documentation
+
+## Slate
+
+The API doc is generated via slate and hosted on github pages. To make a change and update the doc follow the steps:
+
+1.  git checkout slate-doc
+2.  Install your local dependencies for slate, more info [here](https://github.com/lord/slate#getting-started-with-slate)
+3.  Edit `source/index.html.md` and save your changes.
+4.  Commit all the changes to git, before deploying the repo should be clean.
+5.  Push your commit to remote.
+6.  Run `./deploy.sh`
+7.  Wait a few minutes and the doc should be updated at https://acinq.github.io/eclair

OLD-API-DOCS.md

@@ -0,0 +1,40 @@
+ ## JSON-RPC API
+
+ :warning: Note this interface is being deprecated.
+
+ method        |  params                                                                                | description
+ ------------- |----------------------------------------------------------------------------------------|-----------------------------------------------------------
+  getinfo      |                                                                                        | return basic node information (id, chain hash, current block height)
+  connect      | nodeId, host, port                                                                     | open a secure connection to a lightning node
+  connect      | uri                                                                                    | open a secure connection to a lightning node
+  open         | nodeId, fundingSatoshis, pushMsat = 0, feerateSatPerByte = ?, channelFlags = 0x01      | open a channel with another lightning node, by default push = 0, feerate for the funding tx targets 6 blocks, and channel is announced
+  updaterelayfee | channelId, feeBaseMsat, feeProportionalMillionths                                    | update relay fee for payments going through this channel
+  peers        |                                                                                        | list existing local peers
+  channels     |                                                                                        | list existing local channels
+  channels     | nodeId                                                                                 | list existing local channels opened with a particular nodeId
+  channel      | channelId                                                                              | retrieve detailed information about a given channel
+  channelstats |                                                                                        | retrieves statistics about channel usage (fees, number and average amount of payments)
+  allnodes     |                                                                                        | list all known nodes
+  allchannels  |                                                                                        | list all known channels
+  allupdates   |                                                                                        | list all channels updates
+  allupdates   | nodeId                                                                                 | list all channels updates for this nodeId
+  receive      | description                                                                            | generate a payment request without a required amount (can be useful for donations)
+  receive      | amountMsat, description                                                                | generate a payment request for a given amount
+  receive      | amountMsat, description, expirySeconds                                                 | generate a payment request for a given amount that expires after given number of seconds
+  parseinvoice | paymentRequest                                                                         | returns node, amount and payment hash in a payment request
+  findroute    | paymentRequest                                                                         | returns nodes and channels of the route for this payment request if there is any
+  findroute    | paymentRequest, amountMsat                                                             | returns nodes and channels of the route for this payment request and amount, if there is any
+  findroute    | nodeId, amountMsat                                                                     | returns nodes and channels of the route to the nodeId, if there is any
+  send         | amountMsat, paymentHash, nodeId                                                        | send a payment to a lightning node
+  send         | paymentRequest                                                                         | send a payment to a lightning node using a BOLT11 payment request
+  send         | paymentRequest, amountMsat                                                             | send a payment to a lightning node using a BOLT11 payment request and a custom amount
+  checkpayment | paymentHash                                                                            | returns true if the payment has been received, false otherwise
+  checkpayment | paymentRequest                                                                         | returns true if the payment has been received, false otherwise
+  close        | channelId                                                                              | close a channel
+  close        | channelId, scriptPubKey                                                                | close a channel and send the funds to the given scriptPubKey
+  forceclose   | channelId                                                                              | force-close a channel by publishing the local commitment tx (careful: this is more expensive than a regular close and will incur a delay before funds are spendable)"
+  audit        |                                                                                        | list all send/received/relayed payments
+  audit        | from, to                                                                               | list send/received/relayed payments in that interval (from <= timestamp < to)
+  networkfees  |                                                                                        | list all network fees paid to the miners, by transaction
+  networkfees  |from, to                                                                                | list network fees paid to the miners, by transaction, in that interval (from <= timestamp < to)
+  help         |                                                                                        | display available methods

README.md

@@ -128,44 +128,12 @@ Eclair uses [`logback`](https://logback.qos.ch) for logging. To use a different
 java -Dlogback.configurationFile=/path/to/logback-custom.xml -jar eclair-node-gui-<version>-<commit_id>.jar
 ```
 
-## JSON-RPC API
-
- method        |  params                                                                                | description
- ------------- |----------------------------------------------------------------------------------------|-----------------------------------------------------------
-  getinfo      |                                                                                        | return basic node information (id, chain hash, current block height) 
-  connect      | nodeId, host, port                                                                     | open a secure connection to a lightning node
-  connect      | uri                                                                                    | open a secure connection to a lightning node
-  open         | nodeId, fundingSatoshis, pushMsat = 0, feerateSatPerByte = ?, channelFlags = 0x01      | open a channel with another lightning node, by default push = 0, feerate for the funding tx targets 6 blocks, and channel is announced
-  updaterelayfee | channelId, feeBaseMsat, feeProportionalMillionths                                    | update relay fee for payments going through this channel
-  peers        |                                                                                        | list existing local peers
-  channels     |                                                                                        | list existing local channels
-  channels     | nodeId                                                                                 | list existing local channels opened with a particular nodeId
-  channel      | channelId                                                                              | retrieve detailed information about a given channel
-  channelstats |                                                                                        | retrieves statistics about channel usage (fees, number and average amount of payments)
-  allnodes     |                                                                                        | list all known nodes
-  allchannels  |                                                                                        | list all known channels
-  allupdates   |                                                                                        | list all channels updates
-  allupdates   | nodeId                                                                                 | list all channels updates for this nodeId
-  receive      | description                                                                            | generate a payment request without a required amount (can be useful for donations)
-  receive      | amountMsat, description                                                                | generate a payment request for a given amount
-  receive      | amountMsat, description, expirySeconds                                                 | generate a payment request for a given amount that expires after given number of seconds
-  parseinvoice | paymentRequest                                                                         | returns node, amount and payment hash in a payment request
-  findroute    | paymentRequest                                                                         | returns nodes and channels of the route for this payment request if there is any
-  findroute    | paymentRequest, amountMsat                                                             | returns nodes and channels of the route for this payment request and amount, if there is any
-  findroute    | nodeId, amountMsat                                                                     | returns nodes and channels of the route to the nodeId, if there is any
-  send         | amountMsat, paymentHash, nodeId                                                        | send a payment to a lightning node
-  send         | paymentRequest                                                                         | send a payment to a lightning node using a BOLT11 payment request
-  send         | paymentRequest, amountMsat                                                             | send a payment to a lightning node using a BOLT11 payment request and a custom amount
-  checkpayment | paymentHash                                                                            | returns true if the payment has been received, false otherwise
-  checkpayment | paymentRequest                                                                         | returns true if the payment has been received, false otherwise
-  close        | channelId                                                                              | close a channel
-  close        | channelId, scriptPubKey                                                                | close a channel and send the funds to the given scriptPubKey
-  forceclose   | channelId                                                                              | force-close a channel by publishing the local commitment tx (careful: this is more expensive than a regular close and will incur a delay before funds are spendable)"
-  audit        |                                                                                        | list all send/received/relayed payments
-  audit        | from, to                                                                               | list send/received/relayed payments in that interval (from <= timestamp < to)
-  networkfees  |                                                                                        | list all network fees paid to the miners, by transaction
-  networkfees  |from, to                                                                                | list network fees paid to the miners, by transaction, in that interval (from <= timestamp < to)
-  help         |                                                                                        | display available methods
+## JSON API
+
+Eclair offers a feature rich HTTP API that enables application developers to easily integrate, for the full documentation please visit
+the [website](https://acinq.github.io/eclair). If you are still using the old APIs and looking for documentation you can find it [here](https://github.com/ACINQ/eclair/OLD-API-DOCS.md)
+but is not maintained anymore.
+
 
 ## Docker
 

contrib/eclair-cli.bash-completion

@@ -21,7 +21,7 @@ _eclair-cli()
         *)
             # works fine, but is too slow at the moment.
             # allopts=$($eclaircli help 2>&1 | awk '$1 ~ /^"/ { sub(/,/, ""); print $1}' | sed 's/[":]//g')
-            allopts="connect open peers channels channel allnodes allchannels allupdates receive send close audit findroute updaterelayfee parseinvoice forceclose networkfees channelstats checkpayment getinfo help"
+            allopts="getinfo connect open close forceclose updaterelayfee peers channels channel allnodes allchannels allupdates receive parseinvoice findroute findroutetonode send sendtonode checkpayment audit networkfees channelstats"
 
             if ! [[ " $allopts " =~ " $prev " ]]; then          # prevent double arguments
                 if [[ -z "$cur" || "$cur" =~ ^[a-z] ]]; then