16911773184

Committed 12 Aug 2025 02:21PM UTC coverage: 57.471% (-9.4%) from 66.9%

Build # 16911773184

Build Type

Pull #10103

github

Committed by

web-flow

Commit Message

Merge d64a1234d into f3e1f2f35

Pull Request Pull Request #10103: Rate limit outgoing gossip bandwidth by peer

Run Details

57 of 77 new or added lines in 5 files covered. (74.03%)

28294 existing lines in 457 files now uncovered.

99110 of 172451 relevant lines covered (57.47%)

1.78 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

50.0

/lncfg/gossip.go

package lncfg

import (
        "fmt"
        "time"

        "github.com/lightningnetwork/lnd/discovery"
        "github.com/lightningnetwork/lnd/lnwire"
        "github.com/lightningnetwork/lnd/routing/route"
)

// minAnnouncementConf defines the minimal num of confs needed for the config
// AnnouncementConf. We choose 3 here as it's unlikely a reorg depth of 3 would
// happen.
//
// NOTE: The specs recommends setting this value to 6, which is the default
// value used for AnnouncementConf. However the receiver should be able to
// decide which channels to be included in its local graph, more details can be
// found:
// - https://github.com/lightning/bolts/pull/1215#issuecomment-2557337202
const minAnnouncementConf = 3

//nolint:ll
type Gossip struct {
        PinnedSyncersRaw []string `long:"pinned-syncers" description:"A set of peers that should always remain in an active sync state, which can be used to closely synchronize the routing tables of two nodes. The value should be a hex-encoded pubkey, the flag can be specified multiple times to add multiple peers. Connected peers matching this pubkey will remain active for the duration of the connection and not count towards the NumActiveSyncer count."`

        PinnedSyncers discovery.PinnedSyncers

        MaxChannelUpdateBurst int `long:"max-channel-update-burst" description:"The maximum number of updates for a specific channel and direction that lnd will accept over the channel update interval."`

        ChannelUpdateInterval time.Duration `long:"channel-update-interval" description:"The interval used to determine how often lnd should allow a burst of new updates for a specific channel and direction."`

        SubBatchDelay time.Duration `long:"sub-batch-delay" description:"The duration to wait before sending the next announcement batch if there are multiple. Use a small value if there are a lot announcements and they need to be broadcast quickly."`

        AnnouncementConf uint32 `long:"announcement-conf" description:"The number of confirmations required before processing channel announcements."`

        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 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."`

        FilterConcurrency int `long:"filter-concurrency" description:"The maximum number of concurrent gossip filter applications that can be processed. If not set, defaults to 5."`

        PeerMsgRateBytes uint64 `long:"peer-msg-rate-bytes" description:"The peer-specific 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 to each peer. If the rate of outgoing messages exceeds this value, lnd will start to queue and delay messages sending to that peer to stay within the limit."`
}

// Parse the pubkeys for the pinned syncers.

func (g *Gossip) Parse() error {
        pinnedSyncers := make(discovery.PinnedSyncers)
        for _, pubkeyStr := range g.PinnedSyncersRaw {
                vertex, err := route.NewVertexFromStr(pubkeyStr)
                if err != nil {
                        return err
                }
                pinnedSyncers[vertex] = struct{}{}
        }

        g.PinnedSyncers = pinnedSyncers

        return nil
}

// Validate checks the Gossip configuration to ensure that the input values are
// sane.
func (g *Gossip) Validate() error {
        if g.AnnouncementConf < minAnnouncementConf {
                return fmt.Errorf("announcement-conf=%v must be no less than "+
                        "%v", g.AnnouncementConf, minAnnouncementConf)
        }

        if g.MsgBurstBytes < lnwire.MaxSliceLength {
                return fmt.Errorf("msg-burst-bytes=%v must be at least %v",
                        g.MsgBurstBytes, lnwire.MaxSliceLength)
        }

        if g.MsgBurstBytes <= g.MsgRateBytes {
                return fmt.Errorf("msg-burst-bytes=%v must be greater than "+
                        "msg-rate-bytes=%v", g.MsgBurstBytes, g.MsgRateBytes)
        }

        if g.MsgRateBytes <= g.PeerMsgRateBytes {
                return fmt.Errorf("msg-rate-bytes=%v must be greater than "+
                        "peer-msg-rate-bytes=%v", g.MsgRateBytes,
                        g.PeerMsgRateBytes)
        }

        return nil
}

// Compile-time constraint to ensure Gossip implements the Validator interface.
var _ Validator = (*Gossip)(nil)

1	package lncfg
2
3	import (
4	"fmt"
5	"time"
6
7	"github.com/lightningnetwork/lnd/discovery"
8	"github.com/lightningnetwork/lnd/lnwire"
9	"github.com/lightningnetwork/lnd/routing/route"
10	)
11
12	// minAnnouncementConf defines the minimal num of confs needed for the config
13	// AnnouncementConf. We choose 3 here as it's unlikely a reorg depth of 3 would
14	// happen.
15	//
16	// NOTE: The specs recommends setting this value to 6, which is the default
17	// value used for AnnouncementConf. However the receiver should be able to
18	// decide which channels to be included in its local graph, more details can be
19	// found:
20	// - https://github.com/lightning/bolts/pull/1215#issuecomment-2557337202
21	const minAnnouncementConf = 3
22
23	//nolint:ll
24	type Gossip struct {
25	PinnedSyncersRaw []string `long:"pinned-syncers" description:"A set of peers that should always remain in an active sync state, which can be used to closely synchronize the routing tables of two nodes. The value should be a hex-encoded pubkey, the flag can be specified multiple times to add multiple peers. Connected peers matching this pubkey will remain active for the duration of the connection and not count towards the NumActiveSyncer count."`
26
27	PinnedSyncers discovery.PinnedSyncers
28
29	MaxChannelUpdateBurst int `long:"max-channel-update-burst" description:"The maximum number of updates for a specific channel and direction that lnd will accept over the channel update interval."`
30
31	ChannelUpdateInterval time.Duration `long:"channel-update-interval" description:"The interval used to determine how often lnd should allow a burst of new updates for a specific channel and direction."`
32
33	SubBatchDelay time.Duration `long:"sub-batch-delay" description:"The duration to wait before sending the next announcement batch if there are multiple. Use a small value if there are a lot announcements and they need to be broadcast quickly."`
34
35	AnnouncementConf uint32 `long:"announcement-conf" description:"The number of confirmations required before processing channel announcements."`
36
37	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."`
38
39	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."`
40
41	FilterConcurrency int `long:"filter-concurrency" description:"The maximum number of concurrent gossip filter applications that can be processed. If not set, defaults to 5."`
42
43	PeerMsgRateBytes uint64 `long:"peer-msg-rate-bytes" description:"The peer-specific 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 to each peer. If the rate of outgoing messages exceeds this value, lnd will start to queue and delay messages sending to that peer to stay within the limit."`
44	}
45
46	// Parse the pubkeys for the pinned syncers.
47
48	func (g *Gossip) Parse() error {	3✔
49	pinnedSyncers := make(discovery.PinnedSyncers)	3✔
50	for _, pubkeyStr := range g.PinnedSyncersRaw {	6✔
51	vertex, err := route.NewVertexFromStr(pubkeyStr)	3✔
52	if err != nil {	3✔
53	return err	×
54	}	×
55	pinnedSyncers[vertex] = struct{}{}	3✔
56	}
57
58	g.PinnedSyncers = pinnedSyncers	3✔
59		3✔
60	return nil	3✔
61	}
62
63	// Validate checks the Gossip configuration to ensure that the input values are
64	// sane.
65	func (g *Gossip) Validate() error {	3✔
66	if g.AnnouncementConf < minAnnouncementConf {	3✔
67	return fmt.Errorf("announcement-conf=%v must be no less than "+	×
68	"%v", g.AnnouncementConf, minAnnouncementConf)	×
69	}	×
70
71	if g.MsgBurstBytes < lnwire.MaxSliceLength {	3✔
72	return fmt.Errorf("msg-burst-bytes=%v must be at least %v",	×
73	g.MsgBurstBytes, lnwire.MaxSliceLength)	×
74	}	×
75
76	if g.MsgBurstBytes <= g.MsgRateBytes {	3✔
NEW 77	return fmt.Errorf("msg-burst-bytes=%v must be greater than "+	×
NEW 78	"msg-rate-bytes=%v", g.MsgBurstBytes, g.MsgRateBytes)	×
NEW 79	}	×
80
81	if g.MsgRateBytes <= g.PeerMsgRateBytes {	3✔
NEW 82	return fmt.Errorf("msg-rate-bytes=%v must be greater than "+	×
NEW 83	"peer-msg-rate-bytes=%v", g.MsgRateBytes,	×
NEW 84	g.PeerMsgRateBytes)	×
NEW 85	}	×
86
87	return nil	3✔
88	}
89
90	// Compile-time constraint to ensure Gossip implements the Validator interface.
91	var _ Validator = (*Gossip)(nil)

lightningnetwork / lnd / 16911773184

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous