• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

lightningnetwork / lnd / 15561477203

10 Jun 2025 01:54PM UTC coverage: 58.351% (-10.1%) from 68.487%
15561477203

Pull #9356

github

web-flow
Merge 6440b25db into c6d6d4c0b
Pull Request #9356: lnrpc: add incoming/outgoing channel ids filter to forwarding history request

33 of 36 new or added lines in 2 files covered. (91.67%)

28366 existing lines in 455 files now uncovered.

97715 of 167461 relevant lines covered (58.35%)

1.81 hits per line

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

81.08
/feature/manager.go
1
package feature
2

3
import (
4
        "errors"
5
        "fmt"
6

7
        "github.com/lightningnetwork/lnd/lnwire"
8
)
9

10
var (
11
        // ErrUnknownSet is returned if a proposed feature vector contains a
12
        // set that is unknown to LND.
13
        ErrUnknownSet = errors.New("unknown feature bit set")
14

15
        // ErrFeatureConfigured is returned if an attempt is made to unset a
16
        // feature that was configured at startup.
17
        ErrFeatureConfigured = errors.New("can't unset configured feature")
18
)
19

20
// Config houses any runtime modifications to the default set descriptors. For
21
// our purposes, this typically means disabling certain features to test legacy
22
// protocol interoperability or functionality.
23
type Config struct {
24
        // NoTLVOnion unsets any optional or required TLVOnionPaylod bits from
25
        // all feature sets.
26
        NoTLVOnion bool
27

28
        // NoStaticRemoteKey unsets any optional or required StaticRemoteKey
29
        // bits from all feature sets.
30
        NoStaticRemoteKey bool
31

32
        // NoAnchors unsets any bits signaling support for anchor outputs.
33
        NoAnchors bool
34

35
        // NoWumbo unsets any bits signalling support for wumbo channels.
36
        NoWumbo bool
37

38
        // NoTaprootChans unsets any bits signaling support for taproot
39
        // channels.
40
        NoTaprootChans bool
41

42
        // NoScriptEnforcementLease unsets any bits signaling support for script
43
        // enforced leases.
44
        NoScriptEnforcementLease bool
45

46
        // NoKeysend unsets any bits signaling support for accepting keysend
47
        // payments.
48
        NoKeysend bool
49

50
        // NoOptionScidAlias unsets any bits signalling support for
51
        // option_scid_alias. This also implicitly disables zero-conf channels.
52
        NoOptionScidAlias bool
53

54
        // NoZeroConf unsets any bits signalling support for zero-conf
55
        // channels. This should be used instead of NoOptionScidAlias to still
56
        // keep option-scid-alias support.
57
        NoZeroConf bool
58

59
        // NoAnySegwit unsets any bits that signal support for using other
60
        // segwit witness versions for co-op closes.
61
        NoAnySegwit bool
62

63
        // NoRouteBlinding unsets route blinding feature bits.
64
        NoRouteBlinding bool
65

66
        // NoQuiescence unsets quiescence feature bits.
67
        NoQuiescence bool
68

69
        // NoTaprootOverlay unsets the taproot overlay channel feature bits.
70
        NoTaprootOverlay bool
71

72
        // NoExperimentalEndorsement unsets any bits that signal support for
73
        // forwarding experimental endorsement.
74
        NoExperimentalEndorsement bool
75

76
        // NoRbfCoopClose unsets any bits that signal support for using RBF for
77
        // coop close.
78
        NoRbfCoopClose bool
79

80
        // CustomFeatures is a set of custom features to advertise in each
81
        // set.
82
        CustomFeatures map[Set][]lnwire.FeatureBit
83
}
84

85
// Manager is responsible for generating feature vectors for different requested
86
// feature sets.
87
type Manager struct {
88
        // fsets is a static map of feature set to raw feature vectors. Requests
89
        // are fulfilled by cloning these internal feature vectors.
90
        fsets map[Set]*lnwire.RawFeatureVector
91

92
        // configFeatures is a set of custom features that were "hard set" in
93
        // lnd's config that cannot be updated at runtime (as is the case with
94
        // our "standard" features that are defined in LND).
95
        configFeatures map[Set]*lnwire.FeatureVector
96
}
97

98
// NewManager creates a new feature Manager, applying any custom modifications
99
// to its feature sets before returning.
100
func NewManager(cfg Config) (*Manager, error) {
3✔
101
        return newManager(cfg, defaultSetDesc)
3✔
102
}
3✔
103

104
// newManager creates a new feature Manager, applying any custom modifications
105
// to its feature sets before returning. This method accepts the setDesc as its
106
// own parameter so that it can be unit tested.
107
func newManager(cfg Config, desc setDesc) (*Manager, error) {
3✔
108
        // First build the default feature vector for all known sets.
3✔
109
        fsets := make(map[Set]*lnwire.RawFeatureVector)
3✔
110
        for bit, sets := range desc {
6✔
111
                for set := range sets {
6✔
112
                        // Fetch the feature vector for this set, allocating a
3✔
113
                        // new one if it doesn't exist.
3✔
114
                        fv, ok := fsets[set]
3✔
115
                        if !ok {
6✔
116
                                fv = lnwire.NewRawFeatureVector()
3✔
117
                        }
3✔
118

119
                        // Set the configured bit on the feature vector,
120
                        // ensuring that we don't set two feature bits for the
121
                        // same pair.
122
                        err := fv.SafeSet(bit)
3✔
123
                        if err != nil {
3✔
124
                                return nil, fmt.Errorf("unable to set "+
×
125
                                        "%v in %v: %v", bit, set, err)
×
126
                        }
×
127

128
                        // Write the updated feature vector under its set.
129
                        fsets[set] = fv
3✔
130
                }
131
        }
132

133
        // Now, remove any features as directed by the config.
134
        configFeatures := make(map[Set]*lnwire.FeatureVector)
3✔
135
        for set, raw := range fsets {
6✔
136
                if cfg.NoTLVOnion {
6✔
137
                        raw.Unset(lnwire.TLVOnionPayloadOptional)
3✔
138
                        raw.Unset(lnwire.TLVOnionPayloadRequired)
3✔
139
                        raw.Unset(lnwire.PaymentAddrOptional)
3✔
140
                        raw.Unset(lnwire.PaymentAddrRequired)
3✔
141
                        raw.Unset(lnwire.MPPOptional)
3✔
142
                        raw.Unset(lnwire.MPPRequired)
3✔
143
                        raw.Unset(lnwire.RouteBlindingOptional)
3✔
144
                        raw.Unset(lnwire.RouteBlindingRequired)
3✔
145
                        raw.Unset(lnwire.Bolt11BlindedPathsOptional)
3✔
146
                        raw.Unset(lnwire.Bolt11BlindedPathsRequired)
3✔
147
                        raw.Unset(lnwire.AMPOptional)
3✔
148
                        raw.Unset(lnwire.AMPRequired)
3✔
149
                        raw.Unset(lnwire.KeysendOptional)
3✔
150
                        raw.Unset(lnwire.KeysendRequired)
3✔
151
                }
3✔
152
                if cfg.NoStaticRemoteKey {
6✔
153
                        raw.Unset(lnwire.StaticRemoteKeyOptional)
3✔
154
                        raw.Unset(lnwire.StaticRemoteKeyRequired)
3✔
155
                }
3✔
156
                if cfg.NoAnchors {
6✔
157
                        raw.Unset(lnwire.AnchorsZeroFeeHtlcTxOptional)
3✔
158
                        raw.Unset(lnwire.AnchorsZeroFeeHtlcTxRequired)
3✔
159

3✔
160
                        // If anchors are disabled, then we also need to
3✔
161
                        // disable all other features that depend on it as
3✔
162
                        // well, as otherwise we may create an invalid feature
3✔
163
                        // bit set.
3✔
164
                        for bit, depFeatures := range deps {
6✔
165
                                for depFeature := range depFeatures {
6✔
166
                                        switch {
3✔
167
                                        case depFeature == lnwire.AnchorsZeroFeeHtlcTxRequired:
×
168
                                                fallthrough
×
169
                                        case depFeature == lnwire.AnchorsZeroFeeHtlcTxOptional:
3✔
170
                                                raw.Unset(bit)
3✔
171
                                        }
172
                                }
173
                        }
174
                }
175
                if cfg.NoWumbo {
6✔
176
                        raw.Unset(lnwire.WumboChannelsOptional)
3✔
177
                        raw.Unset(lnwire.WumboChannelsRequired)
3✔
178
                }
3✔
179
                if cfg.NoScriptEnforcementLease {
6✔
180
                        raw.Unset(lnwire.ScriptEnforcedLeaseOptional)
3✔
181
                        raw.Unset(lnwire.ScriptEnforcedLeaseRequired)
3✔
182
                }
3✔
183
                if cfg.NoKeysend {
3✔
184
                        raw.Unset(lnwire.KeysendOptional)
×
185
                        raw.Unset(lnwire.KeysendRequired)
×
186
                }
×
187
                if cfg.NoOptionScidAlias {
6✔
188
                        raw.Unset(lnwire.ScidAliasOptional)
3✔
189
                        raw.Unset(lnwire.ScidAliasRequired)
3✔
190
                }
3✔
191
                if cfg.NoZeroConf {
6✔
192
                        raw.Unset(lnwire.ZeroConfOptional)
3✔
193
                        raw.Unset(lnwire.ZeroConfRequired)
3✔
194
                }
3✔
195
                if cfg.NoAnySegwit {
6✔
196
                        raw.Unset(lnwire.ShutdownAnySegwitOptional)
3✔
197
                        raw.Unset(lnwire.ShutdownAnySegwitRequired)
3✔
198
                }
3✔
199
                if cfg.NoTaprootChans {
6✔
200
                        raw.Unset(lnwire.SimpleTaprootChannelsOptionalStaging)
3✔
201
                        raw.Unset(lnwire.SimpleTaprootChannelsRequiredStaging)
3✔
202
                }
3✔
203
                if cfg.NoRouteBlinding {
6✔
204
                        raw.Unset(lnwire.RouteBlindingOptional)
3✔
205
                        raw.Unset(lnwire.RouteBlindingRequired)
3✔
206
                        raw.Unset(lnwire.Bolt11BlindedPathsOptional)
3✔
207
                        raw.Unset(lnwire.Bolt11BlindedPathsRequired)
3✔
208
                }
3✔
209
                if cfg.NoQuiescence {
3✔
210
                        raw.Unset(lnwire.QuiescenceOptional)
×
211
                }
×
212
                if cfg.NoTaprootOverlay {
6✔
213
                        raw.Unset(lnwire.SimpleTaprootOverlayChansOptional)
3✔
214
                        raw.Unset(lnwire.SimpleTaprootOverlayChansRequired)
3✔
215
                }
3✔
216
                if cfg.NoExperimentalEndorsement {
6✔
217
                        raw.Unset(lnwire.ExperimentalEndorsementOptional)
3✔
218
                        raw.Unset(lnwire.ExperimentalEndorsementRequired)
3✔
219
                }
3✔
220
                if cfg.NoRbfCoopClose {
6✔
221
                        raw.Unset(lnwire.RbfCoopCloseOptionalStaging)
3✔
222
                        raw.Unset(lnwire.RbfCoopCloseOptional)
3✔
223
                }
3✔
224

225
                for _, custom := range cfg.CustomFeatures[set] {
6✔
226
                        if custom > set.Maximum() {
3✔
227
                                return nil, fmt.Errorf("feature bit: %v "+
×
228
                                        "exceeds set: %v maximum: %v", custom,
×
229
                                        set, set.Maximum())
×
230
                        }
×
231

232
                        if raw.IsSet(custom) {
3✔
233
                                return nil, fmt.Errorf("feature bit: %v "+
×
234
                                        "already set", custom)
×
235
                        }
×
236

237
                        if err := raw.SafeSet(custom); err != nil {
3✔
238
                                return nil, fmt.Errorf("%w: could not set "+
×
239
                                        "feature: %d", err, custom)
×
240
                        }
×
241
                }
242

243
                // Track custom features separately so that we can check that
244
                // they aren't unset in subsequent updates. If there is no
245
                // entry for the set, the vector will just be empty.
246
                configFeatures[set] = lnwire.NewFeatureVector(
3✔
247
                        lnwire.NewRawFeatureVector(cfg.CustomFeatures[set]...),
3✔
248
                        lnwire.Features,
3✔
249
                )
3✔
250

3✔
251
                // Ensure that all of our feature sets properly set any
3✔
252
                // dependent features.
3✔
253
                fv := lnwire.NewFeatureVector(raw, lnwire.Features)
3✔
254
                err := ValidateDeps(fv)
3✔
255
                if err != nil {
3✔
256
                        return nil, fmt.Errorf("invalid feature set %v: %w",
×
257
                                set, err)
×
258
                }
×
259
        }
260

261
        return &Manager{
3✔
262
                fsets:          fsets,
3✔
263
                configFeatures: configFeatures,
3✔
264
        }, nil
3✔
265
}
266

267
// GetRaw returns a raw feature vector for the passed set. If no set is known,
268
// an empty raw feature vector is returned.
269
func (m *Manager) GetRaw(set Set) *lnwire.RawFeatureVector {
3✔
270
        if fv, ok := m.fsets[set]; ok {
6✔
271
                return fv.Clone()
3✔
272
        }
3✔
273

UNCOV
274
        return lnwire.NewRawFeatureVector()
×
275
}
276

277
// setRaw sets a new raw feature vector for the given set.
278
func (m *Manager) setRaw(set Set, raw *lnwire.RawFeatureVector) {
3✔
279
        m.fsets[set] = raw
3✔
280
}
3✔
281

282
// Get returns a feature vector for the passed set. If no set is known, an empty
283
// feature vector is returned.
284
func (m *Manager) Get(set Set) *lnwire.FeatureVector {
3✔
285
        raw := m.GetRaw(set)
3✔
286
        return lnwire.NewFeatureVector(raw, lnwire.Features)
3✔
287
}
3✔
288

289
// ListSets returns a list of the feature sets that our node supports.
290
func (m *Manager) ListSets() []Set {
3✔
291
        var sets []Set
3✔
292

3✔
293
        for set := range m.fsets {
6✔
294
                sets = append(sets, set)
3✔
295
        }
3✔
296

297
        return sets
3✔
298
}
299

300
// UpdateFeatureSets accepts a map of new feature vectors for each of the
301
// manager's known sets, validates that the update can be applied and modifies
302
// the feature manager's internal state. If a set is not included in the update
303
// map, it is left unchanged. The feature vectors provided are expected to
304
// include the current set of features, updated with desired bits added/removed.
305
func (m *Manager) UpdateFeatureSets(
306
        updates map[Set]*lnwire.RawFeatureVector) error {
3✔
307

3✔
308
        for set, newFeatures := range updates {
6✔
309
                if !set.valid() {
3✔
UNCOV
310
                        return fmt.Errorf("%w: set: %d", ErrUnknownSet, set)
×
UNCOV
311
                }
×
312

313
                if err := newFeatures.ValidatePairs(); err != nil {
3✔
UNCOV
314
                        return err
×
UNCOV
315
                }
×
316

317
                if err := m.Get(set).ValidateUpdate(
3✔
318
                        newFeatures, set.Maximum(),
3✔
319
                ); err != nil {
6✔
320
                        return err
3✔
321
                }
3✔
322

323
                // If any features were configured for this set, ensure that
324
                // they are still set in the new feature vector.
325
                if cfgFeat, haveCfgFeat := m.configFeatures[set]; haveCfgFeat {
6✔
326
                        for feature := range cfgFeat.Features() {
3✔
UNCOV
327
                                if !newFeatures.IsSet(feature) {
×
UNCOV
328
                                        return fmt.Errorf("%w: can't unset: "+
×
UNCOV
329
                                                "%d", ErrFeatureConfigured,
×
UNCOV
330
                                                feature)
×
UNCOV
331
                                }
×
332
                        }
333
                }
334

335
                fv := lnwire.NewFeatureVector(newFeatures, lnwire.Features)
3✔
336
                if err := ValidateDeps(fv); err != nil {
3✔
337
                        return err
×
338
                }
×
339
        }
340

341
        // Only update the current feature sets once every proposed set has
342
        // passed validation so that we don't partially update any sets then
343
        // fail out on a later set's validation.
344
        for set, features := range updates {
6✔
345
                m.setRaw(set, features.Clone())
3✔
346
        }
3✔
347

348
        return nil
3✔
349
}
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2025 Coveralls, Inc