forked from ElementsProject/lightning
-
Notifications
You must be signed in to change notification settings - Fork 0
/
lightning-fundchannel_start.7
60 lines (33 loc) · 1.63 KB
/
lightning-fundchannel_start.7
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
.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<[email protected]\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