mirror of
https://github.com/ElementsProject/lightning.git
synced 2024-11-20 02:27:51 +01:00
b1f05795a8
Easier to pass it back than dig it out of the address, since we have it. Needed for extracting fundchannel
59 lines
1.6 KiB
Groff
59 lines
1.6 KiB
Groff
.TH "LIGHTNING-FUNDCHANNEL_START" "7" "" "" "lightning-fundchannel_start"
|
|
.SH NAME
|
|
lightning-fundchannel_start - Command for initiating channel establishment for a lightning channel
|
|
.SH SYNOPSIS
|
|
|
|
\fBfundchannel_start\fR \fIid\fR \fIsatoshi\fR [\fIfeerate\fR \fIannounce\fR]
|
|
|
|
.SH DESCRIPTION
|
|
|
|
\fBfundchannel_start\fR is a lower level RPC command\. It allows a user to
|
|
initiate channel establishment with a connected peer\.
|
|
|
|
|
|
\fIid\fR is the node id of the remote peer\.
|
|
|
|
|
|
\fIsatoshi\fR is the satoshi value that the channel will be funded at\. This
|
|
value MUST be accurate, otherwise the negotiated commitment transactions
|
|
will not encompass the correct channel value\.
|
|
|
|
|
|
\fIfeerate\fR is an optional field\. Sets the feerate for subsequent
|
|
commitment transactions\.
|
|
|
|
|
|
\fIannounce\fR whether or not to announce this channel\.
|
|
|
|
|
|
Note that the funding transaction MUST NOT be broadcast until after
|
|
channel establishment has been successfully completed by running
|
|
\fBfundchannel_complete\fR, as the commitment transactions for this channel
|
|
are not secured until the complete command succeeds\. Broadcasting
|
|
transaction before that can lead to unrecoverable loss of funds\.
|
|
|
|
.SH RETURN VALUE
|
|
|
|
On success, returns the \fIfunding_address\fR and the \fIscriptpubkey\fR for the channel funding output\.
|
|
|
|
|
|
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_\fBcomplete\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
|
|
|