From 173dbec389390aa41daea88b19ea91b66e753ea2 Mon Sep 17 00:00:00 2001 From: yyforyongyu Date: Mon, 21 Jul 2025 22:44:55 +0800 Subject: [PATCH] lncfg: update docs about `msg-rate-bytes` and `msg-burst-bytes` --- lncfg/gossip.go | 4 ++-- sample-lnd.conf | 22 +++++++++++++--------- 2 files changed, 15 insertions(+), 11 deletions(-) diff --git a/lncfg/gossip.go b/lncfg/gossip.go index 37595e439..3c49001c4 100644 --- a/lncfg/gossip.go +++ b/lncfg/gossip.go @@ -34,9 +34,9 @@ type Gossip struct { AnnouncementConf uint32 `long:"announcement-conf" description:"The number of confirmations required before processing channel announcements."` - MsgRateBytes uint64 `long:"msg-rate-bytes" description:"The maximum number of bytes of gossip messages that will be sent per second. This is a global limit that applies to all peers."` + MsgRateBytes uint64 `long:"msg-rate-bytes" description:"The total rate of outbound gossip messages, expressed in bytes per second. This setting controls the long-term average speed of gossip traffic sent from your node. The rate limit is applied globally across all peers, not per-peer. If the rate of outgoing messages exceeds this value, lnd will start to queue and delay messages to stay within the limit."` - MsgBurstBytes uint64 `long:"msg-burst-bytes" description:"The maximum number of bytes of gossip messages that will be sent in a burst. This is a global limit that applies to all peers. This value should be set to something greater than 130 KB"` + MsgBurstBytes uint64 `long:"msg-burst-bytes" description:"The maximum burst of outbound gossip data, in bytes, that can be sent at once. This works in conjunction with gossip.msg-rate-bytes as part of a token bucket rate-limiting scheme. This value represents the size of the token bucket. It allows for short, high-speed bursts of traffic, with the long-term rate controlled by gossip.msg-rate-bytes. This value must be larger than the maximum lightning message size (~65KB) to allow sending large gossip messages."` } // Parse the pubkeys for the pinned syncers. diff --git a/sample-lnd.conf b/sample-lnd.conf index 39a0bbc49..93c96b8f6 100644 --- a/sample-lnd.conf +++ b/sample-lnd.conf @@ -1761,16 +1761,20 @@ ; The number of confirmations required before processing channel announcements. ; gossip.announcement-conf=6 -; The allotted bandwidth rate expressed in bytes/second that will be allocated -; towards outbound gossip messages. Realized rates above this value will be -; throttled. This value is shared across all peers. -; gossip.msg-rate-bytes=102400 +; The total rate of outbound gossip messages, expressed in bytes per second. +; This setting controls the long-term average speed of gossip traffic sent from +; your node. The rate limit is applied globally across all peers, not per-peer. +; If the rate of outgoing messages exceeds this value, lnd will start to queue +; and delay messages to stay within the limit. +; gossip.msg-rate-bytes=1024000 -; The amount of bytes of gossip messages that can be sent at a given time. This -; is used as the amount of tokens in the token bucket algorithm. This value -; MUST be set to something about 65 KB, otherwise a single max sized message -; can never be sent. -; gossip.msg-burst-bytes=204800 +; The maximum burst of outbound gossip data, in bytes, that can be sent at once. +; This works in conjunction with `gossip.msg-rate-bytes` as part of a token +; bucket rate-limiting scheme. This value represents the size of the token +; bucket. It allows for short, high-speed bursts of traffic, with the long-term +; rate controlled by `gossip.msg-rate-bytes`. This value must be larger than the +; maximum lightning message size (~65KB) to allow sending large gossip messages. +; gossip.msg-burst-bytes=2048000 [invoices]