forked from ElementsProject/lightning
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathlightning-fundchannel_complete.7
61 lines (38 loc) · 1.6 KB
/
lightning-fundchannel_complete.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_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 error the returned object will contain \fBcode\fR and \fBmessage\fR properties,
with \fBcode\fR being one of the following:
.RS
.IP \[bu]
-32602: If the given parameters are wrong\.
.IP \[bu]
-1: Catchall nonspecific error\.
.IP \[bu]
305: Peer is not connected\.
.IP \[bu]
306: Unknown peer id\.
.RE
.SH AUTHOR
Lisa Neigut \fI<[email protected]\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