core-lightning/doc/lightning-fundchannel_complete.7.txt
lisa neigut c0475d0d9d doc: add manpages for fundchannel_[start,complete,cancel]
Manpages for the manpage-god!!
2019-06-12 02:22:43 +00:00

47 lines
1.2 KiB
Plaintext

LIGHTNING-FUNDCHANNEL_COMPLETE(7)
=================================
:doctype: manpage
NAME
----
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 should not be broadcast until after channel
establishment has been successfully completed, as the commitment transactions
for this channel are not secured until this command succesfully completes.
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