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
3bc5d47aa2
core-lightning/doc/lightning-openchannel_update.7.md
niftynei bec96a6c5b 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-15 14:08:44 +10:30

2.4 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, 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.

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.

  • -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