doc: htlc_minimum_msat htlc_maximum_msat announce_discovered_ip

doc/schemas: adds htlc min/max and ip discovery
This commit is contained in:
Michael Schmoock 2022-03-26 14:36:28 +01:00 committed by Rusty Russell
parent 21fd3b22d4
commit e99f9ad6d6
4 changed files with 40 additions and 2 deletions

View File

@ -122,6 +122,10 @@ On success, an object is returned, containing:
.IP \[bu]
\fBmax-concurrent-htlcs\fR (u32, optional): \fBmax-concurrent-htlcs\fR field from config or cmdline, or default
.IP \[bu]
\fBhtlc-minimum-msat\fR (msat, optional): \fBhtlc-minimum-msat\fR field from config or cmdline, or default
.IP \[bu]
\fBhtlc-maximum-msat\fR (msat, optional): \fBhtlc-maximum-msat\fR field from config or cmdline, or default
.IP \[bu]
\fBmax-dust-htlc-exposure-msat\fR (msat, optional): \fBmax-dust-htlc-exposure-mast\fR field from config or cmdline, or default
.IP \[bu]
\fBmin-capacity-sat\fR (u64, optional): \fBmin-capacity-sat\fR field from config or cmdline, or default
@ -140,6 +144,8 @@ On success, an object is returned, containing:
.IP \[bu]
\fBdisable-dns\fR (boolean, optional): \fBtrue\fR if \fBdisable-dns\fR was set in config or cmdline
.IP \[bu]
\fBdisable-ip-discovery\fR (boolean, optional): \fBtrue\fR if \fBdisable-ip-discovery\fR was set in config or cmdline
.IP \[bu]
\fBencrypted-hsm\fR (boolean, optional): \fBtrue\fR if \fBencrypted-hsm\fR was set in config or cmdline
.IP \[bu]
\fBrpc-file-mode\fR (string, optional): \fBrpc-file-mode\fR field from config or cmdline, or default
@ -276,4 +282,4 @@ Vincenzo Palazzo \fI<vincenzo.palazzo@protonmail.com\fR> wrote the initial versi
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:759090c2619cd40cba89b670ea16d4885f9aea520588d30d0ee8041369d5b91e
\" SHA256STAMP:8d8f73010f55f3af6e050c944cf7670109224b3cf3166cc754047f6e20beef20

View File

@ -71,6 +71,8 @@ On success, an object is returned, containing:
- **rescan** (integer, optional): `rescan` field from config or cmdline, or default
- **fee-per-satoshi** (u32, optional): `fee-per-satoshi` field from config or cmdline, or default
- **max-concurrent-htlcs** (u32, optional): `max-concurrent-htlcs` field from config or cmdline, or default
- **htlc-minimum-msat** (msat, optional): `htlc-minimum-msat` field from config or cmdline, or default
- **htlc-maximum-msat** (msat, optional): `htlc-maximum-msat` field from config or cmdline, or default
- **max-dust-htlc-exposure-msat** (msat, optional): `max-dust-htlc-exposure-mast` field from config or cmdline, or default
- **min-capacity-sat** (u64, optional): `min-capacity-sat` field from config or cmdline, or default
- **addr** (string, optional): `addr` field from config or cmdline (can be more than one)
@ -80,6 +82,7 @@ On success, an object is returned, containing:
- **autolisten** (boolean, optional): `autolisten` field from config or cmdline, or default
- **proxy** (string, optional): `proxy` field from config or cmdline, or default
- **disable-dns** (boolean, optional): `true` if `disable-dns` was set in config or cmdline
- **disable-ip-discovery** (boolean, optional): `true` if `disable-ip-discovery` was set in config or cmdline
- **encrypted-hsm** (boolean, optional): `true` if `encrypted-hsm` was set in config or cmdline
- **rpc-file-mode** (string, optional): `rpc-file-mode` field from config or cmdline, or default
- **log-level** (string, optional): `log-level` field from config or cmdline, or default
@ -208,4 +211,4 @@ RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:59b197ad256bd701744ed5aa9f663166e48ef6320cf3a1538af0bd855daa3186)
[comment]: # ( SHA256STAMP:ebc37d1f9cb452d312285a8168d2bb6da2d1dba08db56bbb8d3d7f47b58d7fa4)

View File

@ -278,6 +278,23 @@ values), and the order is "opening", "mutual_close", "unilateral_close",
You would usually put this option in the per-chain config file, to avoid
setting it on Bitcoin mainnet! e.g. `~rusty/.lightning/regtest/config`.
**htlc-minimum-msat**=*MILLISATOSHI*
Default: 0. Sets the minimal allowed HTLC value for newly created channels.
If you want to change the `htlc_minimum_msat` for existing channels, use the
RPC call lightning-setchannel(7).
**htlc-maximum-msat**=*MILLISATOSHI*
Default: unset (no limit). Sets the maximum allowed HTLC value for newly created
channels. If you want to change the `htlc_maximum_msat` for existing channels,
use the RPC call lightning-setchannel(7).
**disable-ip-discovery**
Turn off public IP discovery to send `node_announcement` updates that contain
the discovered IP with TCP port 9735 as announced address. If unset and you
open TCP port 9735 on your router towords your node, your node will remain
connectable on changing IP addresses. Note: Will always be disabled if you use
'always-use-proxy'.
### Lightning channel and HTLC options
**large-channels**

View File

@ -187,6 +187,14 @@
"type": "u32",
"description": "`max-concurrent-htlcs` field from config or cmdline, or default"
},
"htlc-minimum-msat": {
"type": "msat",
"description": "`htlc-minimum-msat` field from config or cmdline, or default"
},
"htlc-maximum-msat": {
"type": "msat",
"description": "`htlc-maximum-msat` field from config or cmdline, or default"
},
"max-dust-htlc-exposure-msat": {
"type": "msat",
"description": "`max-dust-htlc-exposure-mast` field from config or cmdline, or default"
@ -223,6 +231,10 @@
"type": "boolean",
"description": "`true` if `disable-dns` was set in config or cmdline"
},
"disable-ip-discovery": {
"type": "boolean",
"description": "`true` if `disable-ip-discovery` was set in config or cmdline"
},
"encrypted-hsm": {
"type": "boolean",
"description": "`true` if `encrypted-hsm` was set in config or cmdline"