From c497bad2e92a687e181d32adf02af05b8a96bfd9 Mon Sep 17 00:00:00 2001 From: lisa neigut Date: Fri, 7 Dec 2018 15:40:14 -0800 Subject: [PATCH] changelog + docs: Add entries for `announce` option on `fundchannel` --- CHANGELOG.md | 1 + doc/lightning-fundchannel.7 | 8 +++++--- doc/lightning-fundchannel.7.txt | 6 +++++- 3 files changed, 11 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5574d44ce..1089a7613 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. - JSON API: `getinfo` now returns `num_peers` `num_pending_channels`, `num_active_channels` and `num_inactive_channels` fields. - JSON API: use `\n\n` to terminate responses, for simplified parsing (pylightning now relies on this) +- JSON API: `fundchannel` now includes an `announce` option, when false it will keep channel private. Defaults to true. - Plugins: Added plugins to `lightningd`, including option passthrough and JSON-RPC passthrough. ### Changed diff --git a/doc/lightning-fundchannel.7 b/doc/lightning-fundchannel.7 index e99ef51e0..a810f2655 100644 --- a/doc/lightning-fundchannel.7 +++ b/doc/lightning-fundchannel.7 @@ -2,12 +2,12 @@ .\" Title: lightning-fundchannel .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 09/07/2018 +.\" Date: 12/07/2018 .\" Manual: \ \& .\" Source: \ \& .\" Language: English .\" -.TH "LIGHTNING\-FUNDCHANN" "7" "09/07/2018" "\ \&" "\ \&" +.TH "LIGHTNING\-FUNDCHANN" "7" "12/07/2018" "\ \&" "\ \&" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -31,7 +31,7 @@ lightning-fundchannel \- Command for establishing a lightning channel\&. .SH "SYNOPSIS" .sp -\fBfundchannel\fR \fIid\fR \fIsatoshi\fR [\fIfeerate\fR] +\fBfundchannel\fR \fIid\fR \fIsatoshi\fR [\fIfeerate\fR \fIannounce\fR] .SH "DESCRIPTION" .sp The \fBfundchannel\fR RPC command opens a payment channel with a peer by committing a funding transaction to the blockchain as defined in BOLT #2\&. \fBfundchannel\fR by itself does not attempt to open a connection\&. A connection must first be established using \fBconnect\fR\&. Once the transaction is confirmed, normal channel operations may begin\&. Readiness is indicated by \fBlistpeers\fR reporting a \fIstate\fR of CHANNELD_NORMAL for the channel\&. @@ -42,6 +42,8 @@ The \fBfundchannel\fR RPC command opens a payment channel with a peer by committ .sp \fIfeerate\fR is an optional feerate to use\&. It can be one of the strings \fIurgent\fR, \fInormal\fR or \fIslow\fR to use lightningd\(cqs internal estimates: \fInormal\fR is the default\&. .sp +\fIannounce\fR is an optional flag that triggers whether to announce this channel or not\&. Defaults to true\&. An unannounced channel is considered private\&. +.sp Otherwise, \fIfeerate\fR is a number, with an optional suffix: \fIperkw\fR means the number is interpreted as satoshi\-per\-kilosipa (weight), and \fIperkb\fR means it is interpreted bitcoind\-style as satoshi\-per\-kilobyte\&. Omitting the suffix is equivalent to \fIperkb\fR\&. .SH "RETURN VALUE" .sp diff --git a/doc/lightning-fundchannel.7.txt b/doc/lightning-fundchannel.7.txt index 1d1595571..c9c27bde9 100644 --- a/doc/lightning-fundchannel.7.txt +++ b/doc/lightning-fundchannel.7.txt @@ -8,7 +8,7 @@ lightning-fundchannel - Command for establishing a lightning channel. SYNOPSIS -------- -*fundchannel* 'id' 'satoshi' ['feerate'] +*fundchannel* 'id' 'satoshi' ['feerate' 'announce'] DESCRIPTION ----------- @@ -31,6 +31,10 @@ than 16777215 satoshi. 'urgent', 'normal' or 'slow' to use lightningd's internal estimates: 'normal' is the default. +'announce' is an optional flag that triggers whether to announce +this channel or not. Defaults to `true`. An unannounced channel +is considered private. + Otherwise, 'feerate' is a number, with an optional suffix: 'perkw' means the number is interpreted as satoshi-per-kilosipa (weight), and 'perkb' means it is interpreted bitcoind-style as