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
d0bbf07655
core-lightning/doc/lightning-fundchannel_cancel.7.md

59 lines
1.8 KiB
Markdown
Raw Normal View History

docs: Update manpages to be recognized correctly by mrkd mrkd started enforcing the `name -- short description` style of top-level headings somewhere, and was thus failing to build the man-pages. I swapped the title and with the existing short description to make it work again. `mrkd` will automatically infer the section from the filename so no need to put it in the title as well. In addition I removed the "last updated" lines at the bottom since they are out of date at best, and misleading at the worst. If we want to keep them, I'd suggest generating them from the commit that last touched them.
2019-08-31 14:30:56 +02:00
lightning-fundchannel\_cancel -- Command for completing channel establishment
=============================================================================
doc/manpages: replace asciidoc by markdown
2019-08-10 01:54:18 +02:00
SYNOPSIS
--------
**fundchannel\_cancel** *id*
DESCRIPTION
-----------
df: rename 'funder' to 'opener' Previously we've used the term 'funder' to refer to the peer paying the fees for a transaction; v2 of openchannel will make this no longer true. Instead we rename this to 'opener', or the peer sending the 'open_channel' message, since this will be universally true in a dual-funding world.
2019-09-09 18:11:24 +02:00
`fundchannel_cancel` is a lower level RPC command. It allows channel opener
doc: update the document of `fundchannel_cancel`
2019-08-29 09:54:19 +02:00
to cancel a channel before funding broadcast with a connected peer.
doc/manpages: replace asciidoc by markdown
2019-08-10 01:54:18 +02:00
doc: update the document of `fundchannel_cancel`
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.
doc/manpages: replace asciidoc by markdown
2019-08-10 01:54:18 +02:00
RETURN VALUE
------------
On success, returns confirmation that the channel establishment has been
canceled.
doc: list the error codes of funding_* commands Changelog-None
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.
- 306: Unknown peer id.
lightningd/opening_control.c: `fundchannel_cancel` no longer requires a `channel_id` argument. Fixes: #3785 Changelog-Changed: `fundchannel_cancel` no longer requires its undocumented `channel_id` argument after `fundchannel_complete`.
2020-06-24 06:34:26 +02:00
- 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.
doc/manpages: replace asciidoc by markdown
2019-08-10 01:54:18 +02:00
AUTHOR
------
Lisa Neigut <<niftynei@gmail.com>> is mainly responsible.
SEE ALSO
--------
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-09 22:14:08 +01:00
lightning-connect(7), lightning-fundchannel(7), lightning-multifundchannel(7),
doc/manpages: replace asciidoc by markdown
2019-08-10 01:54:18 +02:00
lightning-fundchannel\_start(7), lightning-fundchannel\_complete(7)
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-09 22:14:08 +01:00
lightning-openchannel\_init(7), lightning-openchannel\_update(7),
lightning-openchannel\_signed(7), lightning-openchannel\_abort(7)
doc/manpages: replace asciidoc by markdown
2019-08-10 01:54:18 +02:00
RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
doc: force refresh of all manpages. The idea is that you regenerate the man pages in the same commit you alter them: that's how we know whether to try regenerating them or not (git doesn't store timestamps, so it can't really tell). Travis will now check this, so force them all to sync to this commit. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-08-25 03:33:16 +02:00
Reference in New Issue Copy Permalink