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

lightningnetwork / lnd / 12199391122

06 Dec 2024 01:10PM UTC coverage: 49.807% (-9.1%) from 58.933%
12199391122

push

github

web-flow
Merge pull request #9337 from Guayaba221/patch-1

chore: fix typo in ruby.md

100137 of 201051 relevant lines covered (49.81%)

2.07 hits per line

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

80.66
/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
        // CustomFeatures is a set of custom features to advertise in each
77
        // set.
78
        CustomFeatures map[Set][]lnwire.FeatureBit
79
}
80

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

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

94
// NewManager creates a new feature Manager, applying any custom modifications
95
// to its feature sets before returning.
96
func NewManager(cfg Config) (*Manager, error) {
4✔
97
        return newManager(cfg, defaultSetDesc)
4✔
98
}
4✔
99

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

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

124
                        // Write the updated feature vector under its set.
125
                        fsets[set] = fv
4✔
126
                }
127
        }
128

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

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

213
                if cfg.NoExperimentalEndorsement {
8✔
214
                        raw.Unset(lnwire.ExperimentalEndorsementOptional)
4✔
215
                        raw.Unset(lnwire.ExperimentalEndorsementRequired)
4✔
216
                }
4✔
217

218
                for _, custom := range cfg.CustomFeatures[set] {
8✔
219
                        if custom > set.Maximum() {
4✔
220
                                return nil, fmt.Errorf("feature bit: %v "+
×
221
                                        "exceeds set: %v maximum: %v", custom,
×
222
                                        set, set.Maximum())
×
223
                        }
×
224

225
                        if raw.IsSet(custom) {
4✔
226
                                return nil, fmt.Errorf("feature bit: %v "+
×
227
                                        "already set", custom)
×
228
                        }
×
229

230
                        if err := raw.SafeSet(custom); err != nil {
4✔
231
                                return nil, fmt.Errorf("%w: could not set "+
×
232
                                        "feature: %d", err, custom)
×
233
                        }
×
234
                }
235

236
                // Track custom features separately so that we can check that
237
                // they aren't unset in subsequent updates. If there is no
238
                // entry for the set, the vector will just be empty.
239
                configFeatures[set] = lnwire.NewFeatureVector(
4✔
240
                        lnwire.NewRawFeatureVector(cfg.CustomFeatures[set]...),
4✔
241
                        lnwire.Features,
4✔
242
                )
4✔
243

4✔
244
                // Ensure that all of our feature sets properly set any
4✔
245
                // dependent features.
4✔
246
                fv := lnwire.NewFeatureVector(raw, lnwire.Features)
4✔
247
                err := ValidateDeps(fv)
4✔
248
                if err != nil {
4✔
249
                        return nil, fmt.Errorf("invalid feature set %v: %w",
×
250
                                set, err)
×
251
                }
×
252
        }
253

254
        return &Manager{
4✔
255
                fsets:          fsets,
4✔
256
                configFeatures: configFeatures,
4✔
257
        }, nil
4✔
258
}
259

260
// GetRaw returns a raw feature vector for the passed set. If no set is known,
261
// an empty raw feature vector is returned.
262
func (m *Manager) GetRaw(set Set) *lnwire.RawFeatureVector {
4✔
263
        if fv, ok := m.fsets[set]; ok {
8✔
264
                return fv.Clone()
4✔
265
        }
4✔
266

267
        return lnwire.NewRawFeatureVector()
×
268
}
269

270
// setRaw sets a new raw feature vector for the given set.
271
func (m *Manager) setRaw(set Set, raw *lnwire.RawFeatureVector) {
4✔
272
        m.fsets[set] = raw
4✔
273
}
4✔
274

275
// Get returns a feature vector for the passed set. If no set is known, an empty
276
// feature vector is returned.
277
func (m *Manager) Get(set Set) *lnwire.FeatureVector {
4✔
278
        raw := m.GetRaw(set)
4✔
279
        return lnwire.NewFeatureVector(raw, lnwire.Features)
4✔
280
}
4✔
281

282
// ListSets returns a list of the feature sets that our node supports.
283
func (m *Manager) ListSets() []Set {
4✔
284
        var sets []Set
4✔
285

4✔
286
        for set := range m.fsets {
8✔
287
                sets = append(sets, set)
4✔
288
        }
4✔
289

290
        return sets
4✔
291
}
292

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

4✔
301
        for set, newFeatures := range updates {
8✔
302
                if !set.valid() {
4✔
303
                        return fmt.Errorf("%w: set: %d", ErrUnknownSet, set)
×
304
                }
×
305

306
                if err := newFeatures.ValidatePairs(); err != nil {
4✔
307
                        return err
×
308
                }
×
309

310
                if err := m.Get(set).ValidateUpdate(
4✔
311
                        newFeatures, set.Maximum(),
4✔
312
                ); err != nil {
8✔
313
                        return err
4✔
314
                }
4✔
315

316
                // If any features were configured for this set, ensure that
317
                // they are still set in the new feature vector.
318
                if cfgFeat, haveCfgFeat := m.configFeatures[set]; haveCfgFeat {
8✔
319
                        for feature := range cfgFeat.Features() {
4✔
320
                                if !newFeatures.IsSet(feature) {
×
321
                                        return fmt.Errorf("%w: can't unset: "+
×
322
                                                "%d", ErrFeatureConfigured,
×
323
                                                feature)
×
324
                                }
×
325
                        }
326
                }
327

328
                fv := lnwire.NewFeatureVector(newFeatures, lnwire.Features)
4✔
329
                if err := ValidateDeps(fv); err != nil {
4✔
330
                        return err
×
331
                }
×
332
        }
333

334
        // Only update the current feature sets once every proposed set has
335
        // passed validation so that we don't partially update any sets then
336
        // fail out on a later set's validation.
337
        for set, features := range updates {
8✔
338
                m.setRaw(set, features.Clone())
4✔
339
        }
4✔
340

341
        return nil
4✔
342
}
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