aljaz/lightning
1
0
Fork 0
mirror of https://github.com/aljazceru/lightning.git synced 2026-01-10 01:24:30 +01:00
Code Issues Packages Projects Releases Wiki Activity

doc: update the document of fundchannel_cancel

Browse Source
This commit is contained in:
trueptolemy
2019-08-29 15:54:19 +08:00
committed by neil saitug
parent f1822e3650
commit 264b3692fb
2 changed files with 21 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
doc/lightning-fundchannel_cancel.7
View File

@@ -7,11 +7,18 @@ lightning-fundchannel_cancel - Command for completing channel establishment
.SH DESCRIPTION
\fBfundchannel_cancel\fR is a lower level RPC command\. It allows a user to
cancel an initiated channel establishment with a connected peer\.
\fBfundchannel_cancel\fR is a lower level RPC command\. It allows channel funder
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\.
\fIid\fR is the node id of the remote peer with which to cancel the
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

14
doc/lightning-fundchannel_cancel.7.md
View File

@@ -9,10 +9,18 @@ SYNOPSIS
DESCRIPTION
-----------
`fundchannel_cancel` is a lower level RPC command. It allows a user to
cancel an initiated channel establishment with a connected peer.
`fundchannel_cancel` is a lower level RPC command. It allows channel funder
to cancel a channel before funding broadcast with a connected peer.
*id* is the node id of the remote peer with which to cancel the
*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
------------