mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-12-28 17:44:47 +01:00
Code Issues Projects Releases Wiki Activity
ec83d7a8a5
core-lightning/doc/lightning-fundchannel_cancel.7.md
Rusty Russell ec83d7a8a5 doc/schemas: disableoffer, disconnect, feerates, fetchinvoice, fundchannel, fundchannel_cancel, fundchannel_complete, fundchannel_start, fundpsbt, getinfo, getlog, getroute. 
We also add a test for getlog, since it was never called by the
testsuite.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-27 20:28:49 +09:30

2.0 KiB
Raw Blame History

lightning-fundchannel_cancel -- Command for completing channel establishment

SYNOPSIS

fundchannel_cancel id

DESCRIPTION

fundchannel_cancel is a lower level RPC command. It allows channel opener to cancel a channel before funding broadcast with a connected peer.

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.

RETURN VALUE

On success, an object is returned, containing:

  • cancelled (string): A message indicating it was cancelled by RPC 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.
  • 306: Unknown peer id.
  • 307: No channel currently being funded that can be cancelled.
  • 308: It is unsafe to cancel the channel: the funding transaction has been broadcast, or there are HTLCs already in the channel, or the peer was the initiator and not us.

AUTHOR

Lisa Neigut <niftynei@gmail.com> is mainly responsible.

SEE ALSO

lightning-connect(7), lightning-fundchannel(7), lightning-multifundchannel(7), lightning-fundchannel_start(7), lightning-fundchannel_complete(7) lightning-openchannel_init(7), lightning-openchannel_update(7), lightning-openchannel_signed(7), lightning-openchannel_abort(7)

RESOURCES

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