core-lightning/doc/lightning-fundchannel_cancel.7

.TH "LIGHTNING-FUNDCHANNEL_CANCEL" "7" "" "" "lightning-fundchannel_cancel"
.SH NAME
lightning-fundchannel_cancel - Command for completing channel establishment
.SH SYNOPSIS

\fBfundchannel_cancel\fR \fIid\fR

.SH DESCRIPTION

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


\fIid\fR is the node id of the remote peer with which to cancel\.


Note that the funding transaction MUST NOT be broadcast before
\fBfundchannel_cancel\fR\. Broadcasting transaction before \fBfundchannel_cancel\fR
WILL lead to unrecoverable loss of funds\.


If \fBfundchannel_cancel\fR is called after \fBfundchannel_complete\fR, the remote
peer may disconnect when command succeeds\. In this case, user need to connect
to remote peer again before opening channel\.

.SH RETURN VALUE

On success, returns confirmation that the channel establishment has been
canceled\.


On error the returned object will contain \fBcode\fR and \fBmessage\fR properties,
with \fBcode\fR being one of the following:

.RS
.IP \[bu]
-32602: If the given parameters are wrong\.
.IP \[bu]
306: Unknown peer id\.
.IP \[bu]
307: No channel currently being funded that can be cancelled\.
.IP \[bu]
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\.

.RE
.SH AUTHOR

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

.SH SEE ALSO

\fBlightning-connect\fR(7), \fBlightning-fundchannel\fR(7),
lightning-fundchannel_\fBstart\fR(7), lightning-fundchannel_\fBcomplete\fR(7)

.SH RESOURCES

Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
doc/manpages: regenerate manpages using markdown templates 2019-08-10 02:12:44 +02:00			`.TH "LIGHTNING-FUNDCHANNEL_CANCEL" "7" "" "" "lightning-fundchannel_cancel"`
			`.SH NAME`
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: regenerate manpages using markdown templates 2019-08-10 02:12:44 +02:00			`.SH SYNOPSIS`

doc: add manpages for fundchannel_[start,complete,cancel] Manpages for the manpage-god!! 2019-06-06 01:32:04 +02:00			`\fBfundchannel_cancel\fR \fIid\fR`
doc/manpages: regenerate manpages using markdown templates 2019-08-10 02:12:44 +02:00
			`.SH 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			`\fBfundchannel_cancel\fR 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: regenerate manpages using markdown templates 2019-08-10 02:12:44 +02:00
doc: list the error codes of funding_* commands Changelog-None 2020-01-05 16:40:17 +01:00
doc: update the document of `fundchannel_cancel` 2019-08-29 09:54:19 +02:00			`\fIid\fR is the node id of the remote peer with which to cancel\.`
doc/manpages: regenerate manpages using markdown templates 2019-08-10 02:12:44 +02:00
doc: list the error codes of funding_* commands Changelog-None 2020-01-05 16:40:17 +01:00
doc: update the document of `fundchannel_cancel` 2019-08-29 09:54:19 +02:00			`Note that the funding transaction MUST NOT be broadcast before`
			`\fBfundchannel_cancel\fR\. Broadcasting transaction before \fBfundchannel_cancel\fR`
			`WILL lead to unrecoverable loss of funds\.`

doc: list the error codes of funding_* commands Changelog-None 2020-01-05 16:40:17 +01:00
doc: update the document of `fundchannel_cancel` 2019-08-29 09:54:19 +02:00			`If \fBfundchannel_cancel\fR is called after \fBfundchannel_complete\fR, the remote`
			`peer may disconnect when command succeeds\. In this case, user need to connect`
			`to remote peer again before opening channel\.`
doc/manpages: regenerate manpages using markdown templates 2019-08-10 02:12:44 +02:00
			`.SH 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 \fBcode\fR and \fBmessage\fR properties,`
			`with \fBcode\fR being one of the following:`

			`.RS`
			`.IP \[bu]`
			`-32602: If the given parameters are wrong\.`
			`.IP \[bu]`
			`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			`.IP \[bu]`
			`307: No channel currently being funded that can be cancelled\.`
			`.IP \[bu]`
			`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: regenerate manpages using markdown templates 2019-08-10 02:12:44 +02:00
doc: list the error codes of funding_* commands Changelog-None 2020-01-05 16:40:17 +01:00			`.RE`
doc/manpages: regenerate manpages using markdown templates 2019-08-10 02:12:44 +02:00			`.SH AUTHOR`

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			`Lisa Neigut \fI<niftynei@gmail.com\fR> is mainly responsible\.`
doc/manpages: regenerate manpages using markdown templates 2019-08-10 02:12:44 +02:00
			`.SH SEE ALSO`

			`\fBlightning-connect\fR(7), \fBlightning-fundchannel\fR(7),`
			`lightning-fundchannel_\fBstart\fR(7), lightning-fundchannel_\fBcomplete\fR(7)`

			`.SH RESOURCES`

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			`Main web site: \fIhttps://github.com/ElementsProject/lightning\fR`
doc/manpages: regenerate manpages using markdown templates 2019-08-10 02:12:44 +02:00