rgb-cln/doc/lightning-fundchannel_compl...

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>
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-08-31 13:30:56 +01:00			`lightning-fundchannel\_complete -- Command for completing channel establishment`
			`===============================================================================`
doc/manpages: replace asciidoc by markdown 2019-08-10 00:54:18 +01:00
			`SYNOPSIS`
			`--------`

			`fundchannel\_complete id txid txout`

			`DESCRIPTION`
			`-----------`

			`fundchannel_complete` is a lower level RPC command. It allows a user to
doc: fix wording for fundchannel_complete 2019-08-21 09:55:49 +01:00			`complete an initiated channel establishment with a connected peer.`
doc/manpages: replace asciidoc by markdown 2019-08-10 00:54:18 +01:00
doc: fix wording for fundchannel_complete 2019-08-21 09:55:49 +01:00			`id is the node id of the remote peer.`
doc/manpages: replace asciidoc by markdown 2019-08-10 00:54:18 +01:00
			`txid is the hex string of the funding transaction id.`

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

doc: fix wording for fundchannel_complete 2019-08-21 09:55:49 +01:00			`Note that the funding transaction MUST NOT be broadcast until after`
doc/manpages: replace asciidoc by markdown 2019-08-10 00:54:18 +01:00			`channel establishment has been successfully completed, as the commitment`
			`transactions for this channel are not secured until this command`
doc: fix wording for fundchannel_complete 2019-08-21 09:55:49 +01:00			`successfully completes. Broadcasting transaction before can lead to`
			`unrecoverable loss of funds.`
doc/manpages: replace asciidoc by markdown 2019-08-10 00:54:18 +01:00
			`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>`