mirror of
https://github.com/ElementsProject/lightning.git
synced 2024-11-20 02:27:51 +01:00
6e636a835f
1. listpeers has a deprecated `"closer": null`, which we need to handle in the schema, while trying not to damage our documentation too much. 2. Don't print a condition if there are no fields to print. 3. Allow a special "untyped" marker for multifundchannel which returns arbitrary JSON in a field. 4. Allow a single field return (for 'stop'). Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
72 lines
2.1 KiB
Groff
Generated
72 lines
2.1 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 \fIpsbt\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\.
|
|
|
|
|
|
\fIpsbt\fR is the transaction to use for funding (does not need to be
|
|
signed but must be otherwise complete)\.
|
|
|
|
|
|
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, an object is returned, containing:
|
|
|
|
.RS
|
|
.IP \[bu]
|
|
\fBchannel_id\fR (hex): The channel_id of the resulting channel (always 64 characters)
|
|
.IP \[bu]
|
|
\fBcommitments_secured\fR (boolean): Indication that channel is safe to use (always \fItrue\fR)
|
|
|
|
.RE
|
|
|
|
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\.
|
|
.IP \[bu]
|
|
309: PSBT does not have a unique, correct output to fund the channel\.
|
|
|
|
.RE
|
|
.SH AUTHOR
|
|
|
|
Lisa Neigut \fI<niftynei@gmail.com\fR> is mainly responsible\.
|
|
|
|
.SH SEE ALSO
|
|
|
|
\fBlightning-connect\fR(7), \fBlightning-fundchannel\fR(7), \fBlightning-multifundchannel\fR(7),
|
|
lightning-fundchannel_\fBstart\fR(7), lightning-fundchannel_\fBcancel\fR(7),
|
|
lightning-openchannel_\fBinit\fR(7), lightning-openchannel_\fBupdate\fR(7),
|
|
lightning-openchannel_\fBsigned\fR(7), lightning-openchannel_\fBbump\fR(7),
|
|
lightning-openchannel_\fBabort\fR(7)
|
|
|
|
.SH RESOURCES
|
|
|
|
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
|
|
|
|
\" SHA256STAMP:51894a500920df4510ca85db038527f8ef7138fba3afcea0cb1326ac1142f567
|