mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-19 18:11:28 +01:00
Code Issues Projects Releases Wiki Activity
0d581ddc01
core-lightning/doc/lightning-openchannel_update.7.md

68 lines
2.3 KiB
Markdown
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
lightning-openchannel\_update -- Command to update a collab channel open
========================================================================
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
**openchannel_update** *channel_id* *psbt*
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
DESCRIPTION
-----------
`openchannel_update` 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 *channel_id*. An updated *psbt* 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 `openchannel_init` or
a previous call to `openchannel_update`) will be communicated to the peer.
Must be called after `openchannel_init` and before `openchannel_signed`.
Must be called until *commitments_secured* is returned as true, at which point
`openchannel_signed` should be called with a signed version of the PSBT
returned by the last call to `openchannel_update`.
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_id* 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
*psbt* is the updated PSBT to be sent to the peer. May be identical to
the PSBT last returned by either `openchannel_init` or `openchannel_update`.
RETURN VALUE
------------
On success, returns the *channel_id* for this channel; an updated, potentially
complete *psbt* for this channel's funding transaction; and the flag
*commitments_secured*, which indicates the completeness of the returned *psbt*.
If *commitments_secured* is true, caller should proceed with signing the
returned PSBT and calling `openchannel_signed` to complete the channel open.
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 *commitments_secured* is true, will also return:
- The derived *channel_id*.
- A *close_to* script, iff a `close_to` address was provided to
`openchannel_init` and the peer supports `option_upfront_shutdownscript`.
- The *funding_outnum*, the index of the funding output for this channel
in the funding transaction.
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
- -32602: If the given parameters are wrong.
- -1: Catchall nonspecific error.
- 305: Peer is not connected.
- 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
- 311: Unknown channel id.
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
SEE ALSO
--------
lightning-openchannel\_update(7), lightning-openchannel\_signed(7),
lightning-fundchannel\_start(7), lightning-fundchannel\_complete(7),
lightning-fundchannel(7), lightning-fundpsbt(7), lightning-utxopsbt(7),
lightning-multifundchannel(7)
AUTHOR
------
@niftynei <<niftynei@gmail.com>> is mainly responsible.
RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
Reference in New Issue Copy Permalink