lukechilds
/
lightning
mirror of https://github.com/lukechilds/lightning.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

doc: Update the doc about `destination` of `close`

travis-debug
trueptolemy 5 years ago
committed by neil saitug
parent
63af8632b7
commit
e53d065230
2 changed files with 13 additions and 4 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 9
      doc/lightning-close.7
  2. 8
      doc/lightning-close.7.md

9
doc/lightning-close.7
View File

@ -3,12 +3,13 @@
lightning-close - Command for closing channels with direct peers lightning-close - Command for closing channels with direct peers
.SH SYNOPSIS .SH SYNOPSIS
\fBclose\fR \fIid\fR [\fIunilateraltimeout\fR] \fBclose\fR \fIid\fR [\fIunilateraltimeout\fR] [\fIdestination\fR]
.SH DESCRIPTION .SH DESCRIPTION
The \fBclose\fR RPC command attempts to close the channel cooperatively 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 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 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 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 close\. The default of unilaterally closing after 48 hours is usually a
reasonable indication that you can no longer contact the peer\. 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 SYNOPSIS
-------- --------
**close** *id* \[*unilateraltimeout*\] **close** *id* \[*unilateraltimeout*\] \[*destination*\]
DESCRIPTION DESCRIPTION
----------- -----------
The **close** RPC command attempts to close the channel cooperatively 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 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 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. indefinitely until the peer is online and can negotiate a mutual close.
The default is 2 days (172800 seconds). 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 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 close. The default of unilaterally closing after 48 hours is usually a
reasonable indication that you can no longer contact the peer. reasonable indication that you can no longer contact the peer.

Write Preview
Loading…
Cancel
Save