core-lightning/doc/lightning-openchannel_signed.7
Rusty Russell 6d1897b796 doc: fix GH/readthedocs rendering of manual pages.
They render the comment as if it's in the list.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-09-05 15:02:17 +02:00

82 lines
2.2 KiB
Groff
Generated

.TH "LIGHTNING-OPENCHANNEL_SIGNED" "7" "" "" "lightning-openchannel_signed"
.SH NAME
lightning-openchannel_signed - Command to conclude a channel open
.SH SYNOPSIS
\fBopenchannel_signed\fR \fIchannel_id\fR \fIsigned_psbt\fR
.SH DESCRIPTION
\fBopenchannel_signed\fR is a low level RPC command which concludes a channel
open with the specified peer\. It uses the v2 openchannel protocol, which
allows for interactive transaction construction\.
This command should be called after \fBopenchannel_update\fR returns
\fIcommitments_secured\fR \fBtrue\fR\.
This command will broadcast the finalized funding transaction,
if we receive valid signatures from the peer\.
\fIchannel_id\fR is the id of the channel\.
\fIsigned_psbt\fR is the PSBT returned from \fBopenchannel_update\fR (where
\fIcommitments_secured\fR was true) with partial signatures or finalized
witness stacks included for every input that we contributed to the
PSBT\.
.SH RETURN VALUE
On success, an object is returned, containing:
.RS
.IP \[bu]
\fBchannel_id\fR (hex): the channel id of the channel (always 64 characters)
.IP \[bu]
\fBtx\fR (hex): the funding transaction
.IP \[bu]
\fBtxid\fR (txid): The txid of the \fBtx\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]
303: Funding transaction broadcast failed\.
.IP \[bu]
305: Peer is not connected\.
.IP \[bu]
309: PSBT missing required fields\.
.IP \[bu]
311: Unknown channel id\.
.IP \[bu]
312: Channel in an invalid state
.RE
.SH SEE ALSO
lightning-openchannel_\fBinit\fR(7), lightning-openchannel_\fBupdate\fR(7),
lightning-openchannel_\fBabort\fR(7), lightning-openchannel_\fBbump\fR(7),
lightning-fundchannel_\fBstart\fR(7), lightning-fundchannel_\fBcomplete\fR(7),
\fBlightning-fundchannel\fR(7), \fBlightning-fundpsbt\fR(7),
\fBlightning-utxopsbt\fR(7), \fBlightning-multifundchannel\fR(7)
.SH AUTHOR
@niftynei \fI<niftynei@gmail.com\fR> is mainly responsible\.
.SH RESOURCES
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:b41890ddae64449f218338b0d211358a3b6fb006cd11f2dc10adc7b7e660ee07