mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-20 02:27:51 +01:00
Code Issues Projects Releases Wiki Activity
a648ec827a
core-lightning/doc/lightning-openchannel_signed.7

73 lines
2.1 KiB
Groff
Raw Normal View History

df-open: commands to update a PSBT or submit a signed PSBT `openchannel_signed` and `openchannel_update` which allow a user to continue a openchannel or kick off the completion of a openchannel. `openchannel_update` should be called until it returns with `commitments_secured`.
2020-09-10 21:43:40 +02:00
.TH "LIGHTNING-OPENCHANNEL_SIGNED" "7" "" "" "lightning-openchannel_signed"
.SH NAME
lightning-openchannel_signed - Command to conclude a channel open
.SH SYNOPSIS
df-open: use channel_id for openchannel_update and openchannel_signed Be as specific as possible is a good rule for things, I think
2020-09-17 22:28:46 +02:00
\fBopenchannel_signed\fR \fIchannel_id\fR \fIsigned_psbt\fR
df-open: commands to update a PSBT or submit a signed PSBT `openchannel_signed` and `openchannel_update` which allow a user to continue a openchannel or kick off the completion of a openchannel. `openchannel_update` should be called until it returns with `commitments_secured`.
2020-09-10 21:43:40 +02:00
.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\.
df-open: use channel_id for openchannel_update and openchannel_signed Be as specific as possible is a good rule for things, I think
2020-09-17 22:28:46 +02:00
\fIchannel_id\fR is the id of the channel\.
df-open: commands to update a PSBT or submit a signed PSBT `openchannel_signed` and `openchannel_update` which allow a user to continue a openchannel or kick off the completion of a openchannel. `openchannel_update` should be called until it returns with `commitments_secured`.
2020-09-10 21:43:40 +02:00
\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]
df-doc: update error codes, make sure they're correct
2021-03-11 05:32:48 +01:00
305: Peer is not connected\.
.IP \[bu]
df-open: commands to update a PSBT or submit a signed PSBT `openchannel_signed` and `openchannel_update` which allow a user to continue a openchannel or kick off the completion of a openchannel. `openchannel_update` should be called until it returns with `commitments_secured`.
2020-09-10 21:43:40 +02:00
309: PSBT missing required fields\.
df-open: use channel_id for openchannel_update and openchannel_signed Be as specific as possible is a good rule for things, I think
2020-09-17 22:28:46 +02:00
.IP \[bu]
311: Unknown channel id\.
df-doc: update error codes, make sure they're correct
2021-03-11 05:32:48 +01:00
.IP \[bu]
312: Channel in an invalid state
df-open: commands to update a PSBT or submit a signed PSBT `openchannel_signed` and `openchannel_update` which allow a user to continue a openchannel or kick off the completion of a openchannel. `openchannel_update` should be called until it returns with `commitments_secured`.
2020-09-10 21:43:40 +02:00
.RE
.SH SEE ALSO
lightning-openchannel_\fBupdate\fR(7), lightning-openchannel_\fBsigned\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
df-doc: update error codes, make sure they're correct
2021-03-11 05:32:48 +01:00
\" SHA256STAMP:1b4fe213f82746ac5773903dfef1bb84d5d80a8c9fdbf5dfc4c02ab2d84164a4
Reference in New Issue Copy Permalink