mirror of
https://github.com/ElementsProject/lightning.git
synced 2024-11-20 10:39:49 +01:00
61 lines
1.6 KiB
Groff
61 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 for the channel\.
|
|
|
|
|
|
On failure, returns an error\.
|
|
|
|
.SH AUTHOR
|
|
|
|
Lisa Neigut \fBNone\fR (\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: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR)
|
|
|
|
.HL
|
|
|
|
Last updated 2019-06-12 11:16:20 CEST
|