home | help 
LIGHTNING-OPENCHANNEL_ABORT(7)			  LIGHTNING-OPENCHANNEL_ABORT(7)

NAME
     openchannel_abort -- Command to abort a channel to a peer

SYNOPSIS
     openchannel_abort channel_id

DESCRIPTION
     openchannel_abort	is  a low level RPC command which initiates an abort for
     specified channel. It uses the openchannel protocol which allows for inter-
     active transaction construction.

     *	channel_id (hash): Channel id of the channel to be aborted.

RETURN VALUE
     On success, an object is returned, containing:

     *	channel_id (hash): The channel id of the aborted channel.
     *	channel_canceled (boolean): Whether this is completely	canceled  (there
	may be remaining in-flight transactions).
     *	reason	(string):  Usually "Abort requested", but if it happened to fail
	at the same time it could be different.

ERRORS
     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.
     *	311: Unknown channel id.
     *	312: Channel in an invalid state

AUTHOR
     Lisa Neigut niftynei@gmail.com is mainly responsible.

SEE ALSO
     lightning-openchannel_init(7), lightning-openchannel_update(7),  lightning-
     openchannel_signed(7),  lightning-openchannel_bump(7),  lightning-fundchan-
     nel_start(7), lightning-fundchannel_complete(7),  lightning-fundchannel(7),
     lightning-fundpsbt(7), lightning-utxopsbt(7), lightning-multifundchannel(7)

RESOURCES
     Main web site: https://github.com/ElementsProject/lightning

EXAMPLES
     Example 1:

     Request:

     $ lightning-cli openchannel_abort -k "channel_id"="channelid0111200111200111200111200111200111200111200111200111200"

     {
       "id": "example:openchannel_abort#1",
       "method": "openchannel_abort",
       "params": {
	 "channel_id": "channelid0111200111200111200111200111200111200111200111200111200"
       }
     }

     Response:

     {
       "channel_id": "channelid0111200111200111200111200111200111200111200111200111200",
       "channel_canceled": false,
       "reason": "Abort requested"
     }

Core Lightning v26.06.1 			  LIGHTNING-OPENCHANNEL_ABORT(7)
home | help