doc: list the error codes of funding_* commands

Changelog-None
waldow90 · Jan 21, 2020 · 89466f0 · 89466f0
1 parent 11da88a
commit 89466f0
Show file tree

Hide file tree

Showing 6 changed files with 71 additions and 12 deletions.
diff --git a/doc/lightning-fundchannel_cancel.7 b/doc/lightning-fundchannel_cancel.7
diff --git a/doc/lightning-fundchannel_cancel.7.md b/doc/lightning-fundchannel_cancel.7.md
@@ -28,7 +28,12 @@ RETURN VALUE
 On success, returns confirmation that the channel establishment has been
 canceled.
 
-On failure, returns an error.
+On error the returned object will contain `code` and `message` properties,
+with `code` being one of the following:
+
+- -32602: If the given parameters are wrong.
+- -1: Catchall nonspecific error.
+- 306: Unknown peer id.
 
 AUTHOR
 ------

diff --git a/doc/lightning-fundchannel_complete.7 b/doc/lightning-fundchannel_complete.7
diff --git a/doc/lightning-fundchannel_complete.7.md b/doc/lightning-fundchannel_complete.7.md
@@ -30,7 +30,13 @@ RETURN VALUE
 On success, returns a confirmation that *commitments\_secured* and the
 derived *channel\_id*.
 
-On failure, returns an error.
+On error the returned object will contain `code` and `message` properties,
+with `code` being one of the following:
+
+- -32602: If the given parameters are wrong.
+- -1: Catchall nonspecific error.
+- 305: Peer is not connected.
+- 306: Unknown peer id.
 
 AUTHOR
 ------

diff --git a/doc/lightning-fundchannel_start.7 b/doc/lightning-fundchannel_start.7
diff --git a/doc/lightning-fundchannel_start.7.md b/doc/lightning-fundchannel_start.7.md
@@ -45,7 +45,16 @@ On success, returns the *funding\_address* and the *scriptpubkey* for the channe
 If a `close_to` address was provided, will close to this address iff the `close_to` address is
 returned in the response. Otherwise, the peer does not support `option_upfront_shutdownscript`.
 
-On failure, returns an error.
+On error the returned object will contain `code` and `message` properties,
+with `code` being one of the following:
+
+- -32602: If the given parameters are wrong.
+- -1: Catchall nonspecific error.
+- 300: The amount exceeded the maximum configured funding amount.
+- 301: The provided `push_msat` is greater than the provided `amount`.
+- 304: Still syncing with bitcoin network
+- 305: Peer is not connected.
+- 306: Unknown peer id.
 
 AUTHOR
 ------