mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2025-01-04 04:54:47 +01:00
Code Issues Projects Releases Wiki Activity
8819278a88
core-lightning/doc/lightning-openchannel_update.7

93 lines
2.8 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_UPDATE" "7" "" "" "lightning-openchannel_update"
.SH NAME
lightning-openchannel_update - Command to update a collab 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_update\fR \fIchannel_id\fR \fIpsbt\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_update\fR is a low level RPC command which continues an open
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
channel, as specified by \fIchannel_id\fR\. An updated \fIpsbt\fR is passed in; any
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
changes from the PSBT last returned (either from \fBopenchannel_init\fR or
a previous call to \fBopenchannel_update\fR) will be communicated to the peer\.
Must be called after \fBopenchannel_init\fR and before \fBopenchannel_signed\fR\.
Must be called until \fIcommitments_secured\fR is returned as true, at which point
\fBopenchannel_signed\fR should be called with a signed version of the PSBT
returned by the last call to \fBopenchannel_update\fR\.
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
\fIpsbt\fR is the updated PSBT to be sent to the peer\. May be identical to
the PSBT last returned by either \fBopenchannel_init\fR or \fBopenchannel_update\fR\.
.SH RETURN VALUE
doc: schemas for everything else. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Fixed: doc: Epic documentation rewrite: each now lists complete and accurate JSON output, tested against testsuite.
2021-06-16 03:10:17 +02:00
On success, an object is returned, containing:
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
doc: schemas for everything else. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Fixed: doc: Epic documentation rewrite: each now lists complete and accurate JSON output, tested against testsuite.
2021-06-16 03:10:17 +02:00
.RS
.IP \[bu]
\fBchannel_id\fR (hex): the channel id of the channel (always 64 characters)
.IP \[bu]
\fBpsbt\fR (string): the PSBT of the funding transaction
.IP \[bu]
\fBcommitments_secured\fR (boolean): whether the \fIpsbt\fR is complete (if true, sign \fIpsbt\fR and call \fBopenchannel_signed\fR to complete the channel open)
schema: add 'funding_outnum' to openchannel_update schema
2021-07-08 23:23:16 +02:00
.IP \[bu]
schema: fixup for dual-funding things
2021-07-09 18:45:50 +02:00
\fBfunding_outnum\fR (u32): The index of the funding output in the psbt
.IP \[bu]
\fBclose_to\fR (hex, optional): scriptPubkey which we have to close to if we mutual close
doc: schemas for everything else. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Fixed: doc: Epic documentation rewrite: each now lists complete and accurate JSON output, tested against testsuite.
2021-06-16 03:10:17 +02:00
.RE
df: pass back 'close_to' for completed/commitment secured channels When commitments are secured, also return the 'close_to' script if we've got a local_upfront_shutdown_script set.
2020-10-26 20:40:00 +01:00
If \fIcommitments_secured\fR is true, will also return:
.RS
.IP \[bu]
The derived \fIchannel_id\fR\.
.IP \[bu]
A \fIclose_to\fR script, iff a \fBclose_to\fR address was provided to
\fBopenchannel_init\fR and the peer supports \fBoption_upfront_shutdownscript\fR\.
.IP \[bu]
The \fIfunding_outnum\fR, the index of the funding output for this channel
in the funding transaction\.
.RE
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
.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]
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
df-doc: add docs for openchannel_bump, more checks for valid psbt Add docs for openchannel_bump, plus some checks that were missed for verifying the amount is valid.
2021-03-11 05:33:47 +01:00
lightning-openchannel_\fBinit\fR(7), lightning-openchannel_\fBsigned\fR(7),
df: add openchannel_abort command Allows us to clean up an in-progress open that we won't be completing Changelog-Added: EXPERIMENTAL JSON-RPC: Permit user-initiated aborting of in-progress opens. Only valid for not-yet-committed opens and RBF-attempts
2021-03-09 22:14:08 +01:00
lightning-openchannel_\fBbump\fR(7), lightning-openchannel_\fBabort\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)
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 AUTHOR
@niftynei \fI<niftynei@gmail.com\fR> is mainly responsible\.
.SH RESOURCES
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
schema: fixup for dual-funding things
2021-07-09 18:45:50 +02:00
\" SHA256STAMP:4d28ceeb8b4f2052bccdc93bf2e0b08fa829a2177b1fad34b7c347e8a682845e
Reference in New Issue Copy Permalink