Skip to content

Commit

Permalink
doc/lightning-multifundchannel.7.md: Describe best_effort flag of `…
Browse files Browse the repository at this point in the history
…multifundchannel`.
  • Loading branch information
ZmnSCPxj committed Aug 22, 2020
1 parent 1732042 commit 79c12aa
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 3 deletions.
26 changes: 24 additions & 2 deletions doc/lightning-multifundchannel.7

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

21 changes: 20 additions & 1 deletion doc/lightning-multifundchannel.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ lightning-multifundchannel -- Command for establishing many lightning channels
SYNOPSIS
--------

**multifundchannel** *destinations* \[*feerate*\] \[*minconf*\] \[*utxos*\]
**multifundchannel** *destinations* \[*feerate*\] \[*minconf*\] \[*utxos*\] \[*best\_effort*\]

DESCRIPTION
-----------
Expand Down Expand Up @@ -68,6 +68,12 @@ outputs should have. Default is 1.
*utxos* specifies the utxos to be used to fund the channel, as an array
of "txid:vout".

*best\_effort*, if specified as `true`, will re-attempt funding in case
one or more of the peers fails the funding process,
by removing the peers that failed and retrying with the remainder.
The **multifundchannel** command will only fail if all peers fail
the funding process.

RETURN VALUE
------------

Expand All @@ -76,13 +82,26 @@ transaction is returned.
This command opens multiple channels with a single large transaction,
thus only one transaction is returned.

If *best\_effort* was specified and `true`,
then it is possible that one or more of the destinations
do not have a channel even if **multifundchannel** succeeded.

An array of *channel\_ids* is returned;
each entry of the array is an object,
with an *id* field being the node ID of the peer,
an *outnum* field being the output number of the transaction
that anchors this channel,
and *channel_id* field being the channel ID with that peer.

If *best\_effort* was specified and `true`,
an array of *removed* is returned,
which contains the destinations that were removed
by *best\_effort* due to failures.
Each entry of the array is an object,
with an *id* field being the node ID of the removed peer,
*method* field describing what phase of funding the peer failed,
and *error* field of the exact error returned by the method.

On failure, none of the channels are created.

The following error codes may occur:
Expand Down

0 comments on commit 79c12aa

Please sign in to comment.