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
2073d9771d
core-lightning/doc/lightning-openchannel_update.7.md
Tony Aldon 8f6a02c182 doc: fix display of lists and code blocks in manpages. 
The conversion from markdown to manpages does not display lists and
code blocks correctly if they are not preceded by an empty line.

Changelog-None
2023-10-14 17:55:51 +02:00

2.9 KiB
Raw Blame History

lightning-openchannel_update -- Command to update a collab channel open

SYNOPSIS

openchannel_update channel_id psbt

DESCRIPTION

openchannel_update is a low level RPC command which continues an open channel, as specified by channel_id. An updated psbt is passed in; any 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.

channel_id is the id of the channel.

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, an object is returned, containing:

  • channel_id (hex): the channel id of the channel (always 64 characters)
  • psbt (string): the PSBT of the funding transaction
  • commitments_secured (boolean): whether the psbt is complete (if true, sign psbt and call openchannel_signed to complete the channel open)
  • funding_outnum (u32): The index of the funding output in the psbt
  • close_to (hex, optional): scriptPubkey which we have to close to if we mutual close
  • requires_confirmed_inputs (boolean, optional): Does peer require confirmed inputs in psbt?

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.

On error, the returned object will contain code and message properties, with code being one of the following:

  • -32602: If the given parameters are wrong.
  • -1: Catchall nonspecific error.
  • 305: Peer is not connected.
  • 309: PSBT missing required fields
  • 311: Unknown channel id.
  • 312: Channel in an invalid state

SEE ALSO

lightning-openchannel_init(7), lightning-openchannel_signed(7), lightning-openchannel_bump(7), lightning-openchannel_abort(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