Skip to content

Commit

Permalink
doc: commandline switch min-capacity-sat
Browse files Browse the repository at this point in the history
  • Loading branch information
m-schmoock authored and cdecker committed Apr 9, 2019
1 parent b0b86c9 commit 0fc9368
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 2 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

- JSON API: `newaddr` outputs `bech32` or `p2sh-segwit`, or both with new `all` parameter (#2390)
- JSON API: `listpeers` status now shows how many confirmations until channel is open (#2405)
- Config: Adds parameter `min-capacity-sat` to reject tiny channels.

### Changed

Expand Down
9 changes: 7 additions & 2 deletions doc/lightningd-config.5
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: lightningd-config
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 03/05/2019
.\" Date: 03/27/2019
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "LIGHTNINGD\-CONFIG" "5" "03/05/2019" "\ \&" "\ \&"
.TH "LIGHTNINGD\-CONFIG" "5" "03/27/2019" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand Down Expand Up @@ -196,6 +196,11 @@ The base fee to charge for every payment which passes through\&. Note that milli
This is the proportional fee to charge for every payment which passes through\&. As percentages are too coarse, it\(cqs in millionths, so 10000 is 1%, 1000 is 0\&.1%\&. Changing this value will only affect new channels and not existing ones\&. If you want to change fees for existing channels, use the RPC call lightningd\-setchannelfee(7)\&.
.RE
.PP
\fBmin\-capacity\-sat\fR=\fISATOSHI\fR
.RS 4
This value defines the minimal effective channel capacity in satoshi to accept for channel opening requests\&. If a peer tries to open a channel smaller than this, the opening will be rejected\&.
.RE
.PP
\fBignore\-fee\-limits\fR=\fIBOOL\fR
.RS 4
Allow nodes which establish channels to us to set any fee they want\&. This may result in a channel which cannot be closed, should fees increase, but make channels far more reliable since we never close it due to unreasonable fees\&.
Expand Down
5 changes: 5 additions & 0 deletions doc/lightningd-config.5.txt
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,11 @@ Lightning node customization options
not existing ones. If you want to change fees for existing channels, use
the RPC call lightningd-setchannelfee(7).

*min-capacity-sat*='SATOSHI'::
This value defines the minimal effective channel capacity in satoshi to
accept for channel opening requests. If a peer tries to open a channel
smaller than this, the opening will be rejected.

*ignore-fee-limits*='BOOL'::
Allow nodes which establish channels to us to set any fee they
want. This may result in a channel which cannot be closed, should
Expand Down

0 comments on commit 0fc9368

Please sign in to comment.