mirror of
https://github.com/ElementsProject/lightning.git
synced 2024-11-20 02:27:51 +01:00
fc9e72b62b
Add docs for openchannel_bump, plus some checks that were missed for verifying the amount is valid.
74 lines
2.1 KiB
Groff
Generated
74 lines
2.1 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, returns the \fIchannel_id\fR for this channel; hex \fItx\fR of the
|
|
published funding transaction; and \fItxid\fR of the funding transaction\.
|
|
|
|
|
|
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_\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:3004ce5963d892d4828b11d3e5daedb59f780f98485098eba0e46b3e835e759d
|