aljaz/lightning
1
0
Fork 0
mirror of https://github.com/aljazceru/lightning.git synced 2025-12-19 07:04:22 +01:00
Code Issues Packages Projects Releases Wiki Activity

doc: Update the doc about destination of close

Browse Source
This commit is contained in:
trueptolemy
2019-09-30 03:24:22 +08:00
committed by neil saitug
parent 63af8632b7
commit e53d065230
2 changed files with 13 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
doc/lightning-close.7
View File

@@ -3,12 +3,13 @@
lightning-close - Command for closing channels with direct peers
.SH SYNOPSIS
\fBclose\fR \fIid\fR [\fIunilateraltimeout\fR]
\fBclose\fR \fIid\fR [\fIunilateraltimeout\fR] [\fIdestination\fR]
.SH DESCRIPTION
The \fBclose\fR RPC command attempts to close the channel cooperatively
with the peer, or unilaterally after \fIunilateraltimeout\fR\.
with the peer, or unilaterally after \fIunilateraltimeout\fR, and the
to-local output will be sent to the address specified in \fIdestination\fR\.
If the given \fIid\fR is a peer ID (66 hex digits as a string), then it
@@ -25,6 +26,10 @@ indefinitely until the peer is online and can negotiate a mutual close\.
The default is 2 days (172800 seconds)\.
The \fIdestination\fR can be of any Bitcoin accepted type, including bech32\.
If it isn't specified, the default is a c-lightning wallet address\.
The peer needs to be live and connected in order to negotiate a mutual
close\. The default of unilaterally closing after 48 hours is usually a
reasonable indication that you can no longer contact the peer\.

8
doc/lightning-close.7.md
View File

@@ -4,13 +4,14 @@ lightning-close -- Command for closing channels with direct peers
SYNOPSIS
--------
**close** *id* \[*unilateraltimeout*\]
**close** *id* \[*unilateraltimeout*\] \[*destination*\]
DESCRIPTION
-----------
The **close** RPC command attempts to close the channel cooperatively
with the peer, or unilaterally after *unilateraltimeout*.
with the peer, or unilaterally after *unilateraltimeout*, and the
to-local output will be sent to the address specified in *destination*.
If the given *id* is a peer ID (66 hex digits as a string), then it
applies to the active channel of the direct peer corresponding to the
@@ -24,6 +25,9 @@ If *unilateraltimeout* is zero, then the **close** command will wait
indefinitely until the peer is online and can negotiate a mutual close.
The default is 2 days (172800 seconds).
The *destination* can be of any Bitcoin accepted type, including bech32.
If it isn't specified, the default is a c-lightning wallet address.
The peer needs to be live and connected in order to negotiate a mutual
close. The default of unilaterally closing after 48 hours is usually a
reasonable indication that you can no longer contact the peer.