mirror of
https://github.com/ElementsProject/lightning.git
synced 2024-11-19 18:11:28 +01:00
c3254e6639
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.
54 lines
1.4 KiB
Groff
Generated
54 lines
1.4 KiB
Groff
Generated
.TH "LIGHTNING-FUNDCHANNEL_COMPLETE" "7" "" "" "lightning-fundchannel_complete"
|
|
.SH NAME
|
|
lightning-fundchannel_complete - Command for completing channel establishment
|
|
.SH SYNOPSIS
|
|
|
|
\fBfundchannel_complete\fR \fIid\fR \fItxid\fR \fItxout\fR
|
|
|
|
.SH DESCRIPTION
|
|
|
|
\fBfundchannel_complete\fR is a lower level RPC command\. It allows a user to
|
|
complete an initiated channel establishment with a connected peer\.
|
|
|
|
|
|
\fIid\fR is the node id of the remote peer\.
|
|
|
|
|
|
\fItxid\fR is the hex string of the funding transaction id\.
|
|
|
|
|
|
\fItxout\fR 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\.
|
|
|
|
.SH RETURN VALUE
|
|
|
|
On success, returns a confirmation that \fIcommitments_secured\fR and the
|
|
derived \fIchannel_id\fR\.
|
|
|
|
|
|
On failure, returns an error\.
|
|
|
|
.SH AUTHOR
|
|
|
|
Lisa Neigut \fI<niftynei@gmail.com\fR> is mainly responsible\.
|
|
|
|
.SH SEE ALSO
|
|
|
|
\fBlightning-connect\fR(7), \fBlightning-fundchannel\fR(7),
|
|
lightning-fundchannel_\fBstart\fR(7), lightning-fundchannel_\fBcancel\fR(7)
|
|
|
|
.SH RESOURCES
|
|
|
|
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
|
|
|
|
.HL
|
|
|
|
Last updated 2019-06-12 11:16:20 CEST
|
|
|