core-lightning/doc/lightning-fundchannel_complete.7.md
Christian Decker c3254e6639 docs: Update manpages to be recognized correctly by mrkd
mrkd started enforcing the `name -- short description` style of top-level
headings somewhere, and was thus failing to build the man-pages. I swapped
the title and with the existing short description to make it work
again. `mrkd` will automatically infer the section from the filename so no
need to put it in the title as well.

In addition I removed the "last updated" lines at the bottom since they are
out of date at best, and misleading at the worst. If we want to keep them, I'd
suggest generating them from the commit that last touched them.
2019-09-02 16:31:36 +02:00

1.3 KiB

lightning-fundchannel_complete -- Command for completing channel establishment

SYNOPSIS

fundchannel_complete id txid txout

DESCRIPTION

fundchannel_complete is a lower level RPC command. It allows a user to complete an initiated channel establishment with a connected peer.

id is the node id of the remote peer.

txid is the hex string of the funding transaction id.

txout is the integer outpoint of the funding output for this channel.

Note that the funding transaction MUST NOT be broadcast until after channel establishment has been successfully completed, as the commitment transactions for this channel are not secured until this command successfully completes. Broadcasting transaction before can lead to unrecoverable loss of funds.

RETURN VALUE

On success, returns a confirmation that commitments_secured and the derived channel_id.

On failure, returns an error.

AUTHOR

Lisa Neigut <niftynei@gmail.com> is mainly responsible.

SEE ALSO

lightning-connect(7), lightning-fundchannel(7), lightning-fundchannel_start(7), lightning-fundchannel_cancel(7)

RESOURCES

Main web site: https://github.com/ElementsProject/lightning