mirror of
https://github.com/aljazceru/lightning.git
synced 2025-12-21 16:14:23 +01:00
b2148d0eab
This means we will document deprecations and additions, rather than just pretending they've always been that way! Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
60 lines
1.7 KiB
Markdown
60 lines
1.7 KiB
Markdown
lightning-openchannel\_abort -- Command to abort a channel to a peer
|
|
=====================================================================
|
|
|
|
SYNOPSIS
|
|
--------
|
|
|
|
**openchannel\_abort** *channel\_id*
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
|
|
`openchannel_init` is a low level RPC command which initiates a channel
|
|
open with a specified peer. It uses the openchannel protocol
|
|
which allows for interactive transaction construction.
|
|
|
|
*channel\_id* is id of this channel.
|
|
|
|
|
|
RETURN VALUE
|
|
------------
|
|
|
|
[comment]: # (GENERATE-FROM-SCHEMA-START)
|
|
On success, an object is returned, containing:
|
|
|
|
- **channel\_id** (hex): the channel id of the aborted channel (always 64 characters)
|
|
- **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
|
|
|
|
[comment]: # (GENERATE-FROM-SCHEMA-END)
|
|
|
|
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
|
|
|
|
SEE ALSO
|
|
--------
|
|
|
|
lightning-openchannel\_init(7), lightning-openchannel\_update(7),
|
|
lightning-openchannel\_signed(7), lightning-openchannel\_bump(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>
|
|
|
|
[comment]: # ( SHA256STAMP:c6f95d7c5638e19315ae917ea64adce77cfa492c12be843813a93e03027c82f1)
|