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

lightningnetwork / lnd / 17917482292

22 Sep 2025 01:50PM UTC coverage: 56.562% (-10.1%) from 66.668%
17917482292

Pull #10182

github

web-flow
Merge 9efe3bd8c into 055fb436e
Pull Request #10182: Aux feature bits

32 of 68 new or added lines in 5 files covered. (47.06%)

29734 existing lines in 467 files now uncovered.

98449 of 174056 relevant lines covered (56.56%)

1.18 hits per line

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

86.61
/graph/db/graph_cache.go
1
package graphdb
2

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

7
        "github.com/btcsuite/btcd/btcutil"
8
        "github.com/lightningnetwork/lnd/graph/db/models"
9
        "github.com/lightningnetwork/lnd/lnwire"
10
        "github.com/lightningnetwork/lnd/routing/route"
11
)
12

13
// DirectedChannel is a type that stores the channel information as seen from
14
// one side of the channel.
15
type DirectedChannel struct {
16
        // ChannelID is the unique identifier of this channel.
17
        ChannelID uint64
18

19
        // IsNode1 indicates if this is the node with the smaller public key.
20
        IsNode1 bool
21

22
        // OtherNode is the public key of the node on the other end of this
23
        // channel.
24
        OtherNode route.Vertex
25

26
        // Capacity is the announced capacity of this channel in satoshis.
27
        Capacity btcutil.Amount
28

29
        // OutPolicySet is a boolean that indicates whether the node has an
30
        // outgoing policy set. For pathfinding only the existence of the policy
31
        // is important to know, not the actual content.
32
        OutPolicySet bool
33

34
        // InPolicy is the incoming policy *from* the other node to this node.
35
        // In path finding, we're walking backward from the destination to the
36
        // source, so we're always interested in the edge that arrives to us
37
        // from the other node.
38
        InPolicy *models.CachedEdgePolicy
39

40
        // Inbound fees of this node.
41
        InboundFee lnwire.Fee
42
}
43

44
// DeepCopy creates a deep copy of the channel, including the incoming policy.
45
func (c *DirectedChannel) DeepCopy() *DirectedChannel {
2✔
46
        channelCopy := *c
2✔
47

2✔
48
        if channelCopy.InPolicy != nil {
4✔
49
                inPolicyCopy := *channelCopy.InPolicy
2✔
50
                channelCopy.InPolicy = &inPolicyCopy
2✔
51

2✔
52
                // The fields for the ToNode can be overwritten by the path
2✔
53
                // finding algorithm, which is why we need a deep copy in the
2✔
54
                // first place. So we always start out with nil values, just to
2✔
55
                // be sure they don't contain any old data.
2✔
56
                channelCopy.InPolicy.ToNodePubKey = nil
2✔
57
                channelCopy.InPolicy.ToNodeFeatures = nil
2✔
58
        }
2✔
59

60
        return &channelCopy
2✔
61
}
62

63
// GraphCache is a type that holds a minimal set of information of the public
64
// channel graph that can be used for pathfinding.
65
type GraphCache struct {
66
        nodeChannels map[route.Vertex]map[uint64]*DirectedChannel
67
        nodeFeatures map[route.Vertex]*lnwire.FeatureVector
68

69
        mtx sync.RWMutex
70
}
71

72
// NewGraphCache creates a new graphCache.
73
func NewGraphCache(preAllocNumNodes int) *GraphCache {
2✔
74
        return &GraphCache{
2✔
75
                nodeChannels: make(
2✔
76
                        map[route.Vertex]map[uint64]*DirectedChannel,
2✔
77
                        // A channel connects two nodes, so we can look it up
2✔
78
                        // from both sides, meaning we get double the number of
2✔
79
                        // entries.
2✔
80
                        preAllocNumNodes*2,
2✔
81
                ),
2✔
82
                nodeFeatures: make(
2✔
83
                        map[route.Vertex]*lnwire.FeatureVector,
2✔
84
                        preAllocNumNodes,
2✔
85
                ),
2✔
86
        }
2✔
87
}
2✔
88

89
// Stats returns statistics about the current cache size.
90
func (c *GraphCache) Stats() string {
2✔
91
        c.mtx.RLock()
2✔
92
        defer c.mtx.RUnlock()
2✔
93

2✔
94
        numChannels := 0
2✔
95
        for node := range c.nodeChannels {
4✔
96
                numChannels += len(c.nodeChannels[node])
2✔
97
        }
2✔
98
        return fmt.Sprintf("num_node_features=%d, num_nodes=%d, "+
2✔
99
                "num_channels=%d", len(c.nodeFeatures), len(c.nodeChannels),
2✔
100
                numChannels)
2✔
101
}
102

103
// AddNodeFeatures adds a graph node and its features to the cache.
104
func (c *GraphCache) AddNodeFeatures(node route.Vertex,
105
        features *lnwire.FeatureVector) {
2✔
106

2✔
107
        c.mtx.Lock()
2✔
108
        defer c.mtx.Unlock()
2✔
109

2✔
110
        c.nodeFeatures[node] = features
2✔
111
}
2✔
112

113
// AddChannel adds a non-directed channel, meaning that the order of policy 1
114
// and policy 2 does not matter, the directionality is extracted from the info
115
// and policy flags automatically. The policy will be set as the outgoing policy
116
// on one node and the incoming policy on the peer's side.
117
func (c *GraphCache) AddChannel(info *models.CachedEdgeInfo,
118
        policy1, policy2 *models.CachedEdgePolicy) {
2✔
119

2✔
120
        if info == nil {
2✔
121
                return
×
122
        }
×
123

124
        if policy1 != nil && policy1.IsDisabled() &&
2✔
125
                policy2 != nil && policy2.IsDisabled() {
4✔
126

2✔
127
                return
2✔
128
        }
2✔
129

130
        // Create the edge entry for both nodes.
131
        c.mtx.Lock()
2✔
132
        c.updateOrAddEdge(info.NodeKey1Bytes, &DirectedChannel{
2✔
133
                ChannelID: info.ChannelID,
2✔
134
                IsNode1:   true,
2✔
135
                OtherNode: info.NodeKey2Bytes,
2✔
136
                Capacity:  info.Capacity,
2✔
137
        })
2✔
138
        c.updateOrAddEdge(info.NodeKey2Bytes, &DirectedChannel{
2✔
139
                ChannelID: info.ChannelID,
2✔
140
                IsNode1:   false,
2✔
141
                OtherNode: info.NodeKey1Bytes,
2✔
142
                Capacity:  info.Capacity,
2✔
143
        })
2✔
144
        c.mtx.Unlock()
2✔
145

2✔
146
        // The policy's node is always the to_node. So if policy 1 has to_node
2✔
147
        // of node 2 then we have the policy 1 as seen from node 1.
2✔
148
        if policy1 != nil {
4✔
149
                fromNode, toNode := info.NodeKey1Bytes, info.NodeKey2Bytes
2✔
150
                if !policy1.IsNode1() {
2✔
UNCOV
151
                        fromNode, toNode = toNode, fromNode
×
UNCOV
152
                }
×
153
                c.UpdatePolicy(policy1, fromNode, toNode)
2✔
154
        }
155
        if policy2 != nil {
4✔
156
                fromNode, toNode := info.NodeKey2Bytes, info.NodeKey1Bytes
2✔
157
                if policy2.IsNode1() {
2✔
UNCOV
158
                        fromNode, toNode = toNode, fromNode
×
UNCOV
159
                }
×
160
                c.UpdatePolicy(policy2, fromNode, toNode)
2✔
161
        }
162
}
163

164
// updateOrAddEdge makes sure the edge information for a node is either updated
165
// if it already exists or is added to that node's list of channels.
166
func (c *GraphCache) updateOrAddEdge(node route.Vertex, edge *DirectedChannel) {
2✔
167
        if len(c.nodeChannels[node]) == 0 {
4✔
168
                c.nodeChannels[node] = make(map[uint64]*DirectedChannel)
2✔
169
        }
2✔
170

171
        c.nodeChannels[node][edge.ChannelID] = edge
2✔
172
}
173

174
// UpdatePolicy updates a single policy on both the from and to node. The order
175
// of the from and to node is not strictly important. But we assume that a
176
// channel edge was added beforehand so that the directed channel struct already
177
// exists in the cache.
178
func (c *GraphCache) UpdatePolicy(policy *models.CachedEdgePolicy, fromNode,
179
        toNode route.Vertex) {
2✔
180

2✔
181
        c.mtx.Lock()
2✔
182
        defer c.mtx.Unlock()
2✔
183

2✔
184
        updatePolicy := func(nodeKey route.Vertex) {
4✔
185
                if len(c.nodeChannels[nodeKey]) == 0 {
2✔
186
                        log.Warnf("Node=%v not found in graph cache", nodeKey)
×
187

×
188
                        return
×
189
                }
×
190

191
                channel, ok := c.nodeChannels[nodeKey][policy.ChannelID]
2✔
192
                if !ok {
2✔
193
                        log.Warnf("Channel=%v not found in graph cache",
×
194
                                policy.ChannelID)
×
195

×
196
                        return
×
197
                }
×
198

199
                // Edge 1 is defined as the policy for the direction of node1 to
200
                // node2.
201
                switch {
2✔
202
                // This is node 1, and it is edge 1, so this is the outgoing
203
                // policy for node 1.
204
                case channel.IsNode1 && policy.IsNode1():
2✔
205
                        channel.OutPolicySet = true
2✔
206
                        policy.InboundFee.WhenSome(func(fee lnwire.Fee) {
4✔
207
                                channel.InboundFee = fee
2✔
208
                        })
2✔
209

210
                // This is node 2, and it is edge 2, so this is the outgoing
211
                // policy for node 2.
212
                case !channel.IsNode1 && !policy.IsNode1():
2✔
213
                        channel.OutPolicySet = true
2✔
214
                        policy.InboundFee.WhenSome(func(fee lnwire.Fee) {
4✔
215
                                channel.InboundFee = fee
2✔
216
                        })
2✔
217

218
                // The other two cases left mean it's the inbound policy for the
219
                // node.
220
                default:
2✔
221
                        channel.InPolicy = policy
2✔
222
                }
223
        }
224

225
        updatePolicy(fromNode)
2✔
226
        updatePolicy(toNode)
2✔
227
}
228

229
// RemoveNode completely removes a node and all its channels (including the
230
// peer's side).
231
func (c *GraphCache) RemoveNode(node route.Vertex) {
2✔
232
        c.mtx.Lock()
2✔
233
        defer c.mtx.Unlock()
2✔
234

2✔
235
        delete(c.nodeFeatures, node)
2✔
236

2✔
237
        // First remove all channels from the other nodes' lists.
2✔
238
        for _, channel := range c.nodeChannels[node] {
2✔
UNCOV
239
                c.removeChannelIfFound(channel.OtherNode, channel.ChannelID)
×
UNCOV
240
        }
×
241

242
        // Then remove our whole node completely.
243
        delete(c.nodeChannels, node)
2✔
244
}
245

246
// RemoveChannel removes a single channel between two nodes.
247
func (c *GraphCache) RemoveChannel(node1, node2 route.Vertex, chanID uint64) {
2✔
248
        c.mtx.Lock()
2✔
249
        defer c.mtx.Unlock()
2✔
250

2✔
251
        // Remove that one channel from both sides.
2✔
252
        c.removeChannelIfFound(node1, chanID)
2✔
253
        c.removeChannelIfFound(node2, chanID)
2✔
254
}
2✔
255

256
// removeChannelIfFound removes a single channel from one side.
257
func (c *GraphCache) removeChannelIfFound(node route.Vertex, chanID uint64) {
2✔
258
        if len(c.nodeChannels[node]) == 0 {
4✔
259
                return
2✔
260
        }
2✔
261

262
        delete(c.nodeChannels[node], chanID)
2✔
263
}
264

265
// getChannels returns a copy of the passed node's channels or nil if there
266
// isn't any.
267
func (c *GraphCache) getChannels(node route.Vertex) []*DirectedChannel {
2✔
268
        c.mtx.RLock()
2✔
269
        defer c.mtx.RUnlock()
2✔
270

2✔
271
        channels, ok := c.nodeChannels[node]
2✔
272
        if !ok {
4✔
273
                return nil
2✔
274
        }
2✔
275

276
        features, ok := c.nodeFeatures[node]
2✔
277
        if !ok {
4✔
278
                // If the features were set to nil explicitly, that's fine here.
2✔
279
                // The router will overwrite the features of the destination
2✔
280
                // node with those found in the invoice if necessary. But if we
2✔
281
                // didn't yet get a node announcement we want to mimic the
2✔
282
                // behavior of the old DB based code that would always set an
2✔
283
                // empty feature vector instead of leaving it nil.
2✔
284
                features = lnwire.EmptyFeatureVector()
2✔
285
        }
2✔
286

287
        toNodeCallback := func() route.Vertex {
4✔
288
                return node
2✔
289
        }
2✔
290

291
        i := 0
2✔
292
        channelsCopy := make([]*DirectedChannel, len(channels))
2✔
293
        for _, channel := range channels {
4✔
294
                // We need to copy the channel and policy to avoid it being
2✔
295
                // updated in the cache if the path finding algorithm sets
2✔
296
                // fields on it (currently only the ToNodeFeatures of the
2✔
297
                // policy).
2✔
298
                channelCopy := channel.DeepCopy()
2✔
299
                if channelCopy.InPolicy != nil {
4✔
300
                        channelCopy.InPolicy.ToNodePubKey = toNodeCallback
2✔
301
                        channelCopy.InPolicy.ToNodeFeatures = features
2✔
302
                }
2✔
303

304
                channelsCopy[i] = channelCopy
2✔
305
                i++
2✔
306
        }
307

308
        return channelsCopy
2✔
309
}
310

311
// ForEachChannel invokes the given callback for each channel of the given node.
312
func (c *GraphCache) ForEachChannel(node route.Vertex,
313
        cb func(channel *DirectedChannel) error) error {
2✔
314

2✔
315
        // Obtain a copy of the node's channels. We need do this in order to
2✔
316
        // avoid deadlocks caused by interaction with the graph cache, channel
2✔
317
        // state and the graph database from multiple goroutines. This snapshot
2✔
318
        // is only used for path finding where being stale is acceptable since
2✔
319
        // the real world graph and our representation may always become
2✔
320
        // slightly out of sync for a short time and the actual channel state
2✔
321
        // is stored separately.
2✔
322
        channels := c.getChannels(node)
2✔
323
        for _, channel := range channels {
4✔
324
                if err := cb(channel); err != nil {
4✔
325
                        return err
2✔
326
                }
2✔
327
        }
328

329
        return nil
2✔
330
}
331

332
// ForEachNode iterates over the adjacency list of the graph, executing the
333
// call back for each node and the set of channels that emanate from the given
334
// node.
335
//
336
// NOTE: This method should be considered _read only_, the channels or nodes
337
// passed in MUST NOT be modified.
338
func (c *GraphCache) ForEachNode(cb func(node route.Vertex,
UNCOV
339
        channels map[uint64]*DirectedChannel) error) error {
×
UNCOV
340

×
UNCOV
341
        c.mtx.RLock()
×
UNCOV
342
        defer c.mtx.RUnlock()
×
UNCOV
343

×
UNCOV
344
        for node, channels := range c.nodeChannels {
×
UNCOV
345
                // We don't make a copy here since this is a read-only RPC
×
UNCOV
346
                // call. We also don't need the node features either for this
×
UNCOV
347
                // call.
×
UNCOV
348
                if err := cb(node, channels); err != nil {
×
349
                        return err
×
350
                }
×
351
        }
352

UNCOV
353
        return nil
×
354
}
355

356
// GetFeatures returns the features of the node with the given ID. If no
357
// features are known for the node, an empty feature vector is returned.
358
func (c *GraphCache) GetFeatures(node route.Vertex) *lnwire.FeatureVector {
2✔
359
        c.mtx.RLock()
2✔
360
        defer c.mtx.RUnlock()
2✔
361

2✔
362
        features, ok := c.nodeFeatures[node]
2✔
363
        if !ok || features == nil {
4✔
364
                // The router expects the features to never be nil, so we return
2✔
365
                // an empty feature set instead.
2✔
366
                return lnwire.EmptyFeatureVector()
2✔
367
        }
2✔
368

369
        return features
2✔
370
}
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