2019-08-31 14:30:56 +02:00
|
|
|
lightning-fundchannel\_cancel -- Command for completing channel establishment
|
|
|
|
=============================================================================
|
2019-08-10 01:54:18 +02:00
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
--------
|
|
|
|
|
|
|
|
**fundchannel\_cancel** *id*
|
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
-----------
|
|
|
|
|
2019-08-29 09:54:19 +02:00
|
|
|
`fundchannel_cancel` is a lower level RPC command. It allows channel funder
|
|
|
|
to cancel a channel before funding broadcast with a connected peer.
|
2019-08-10 01:54:18 +02:00
|
|
|
|
2019-08-29 09:54:19 +02:00
|
|
|
*id* is the node id of the remote peer with which to cancel.
|
|
|
|
|
|
|
|
Note that the funding transaction MUST NOT be broadcast before
|
|
|
|
`fundchannel_cancel`. Broadcasting transaction before `fundchannel_cancel`
|
|
|
|
WILL lead to unrecoverable loss of funds.
|
|
|
|
|
|
|
|
If `fundchannel_cancel` is called after `fundchannel_complete`, the remote
|
|
|
|
peer may disconnect when command succeeds. In this case, user need to connect
|
|
|
|
to remote peer again before opening channel.
|
2019-08-10 01:54:18 +02:00
|
|
|
|
|
|
|
RETURN VALUE
|
|
|
|
------------
|
|
|
|
|
|
|
|
On success, returns confirmation that the channel establishment has been
|
|
|
|
canceled.
|
|
|
|
|
2020-01-05 16:40:17 +01:00
|
|
|
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.
|
|
|
|
- 306: Unknown peer id.
|
2019-08-10 01:54:18 +02:00
|
|
|
|
|
|
|
AUTHOR
|
|
|
|
------
|
|
|
|
|
|
|
|
Lisa Neigut <<niftynei@gmail.com>> is mainly responsible.
|
|
|
|
|
|
|
|
SEE ALSO
|
|
|
|
--------
|
|
|
|
|
|
|
|
lightning-connect(7), lightning-fundchannel(7),
|
|
|
|
lightning-fundchannel\_start(7), lightning-fundchannel\_complete(7)
|
|
|
|
|
|
|
|
RESOURCES
|
|
|
|
---------
|
|
|
|
|
|
|
|
Main web site: <https://github.com/ElementsProject/lightning>
|