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

lightningnetwork / lnd / 15951470896

29 Jun 2025 04:23AM UTC coverage: 67.594% (-0.01%) from 67.606%
15951470896

Pull #9751

github

web-flow
Merge 599d9b051 into 6290edf14
Pull Request #9751: multi: update Go to 1.23.10 and update some packages

135088 of 199851 relevant lines covered (67.59%)

21909.44 hits per line

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

94.2
/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 {
1,597✔
46
        channelCopy := *c
1,597✔
47

1,597✔
48
        if channelCopy.InPolicy != nil {
3,168✔
49
                inPolicyCopy := *channelCopy.InPolicy
1,571✔
50
                channelCopy.InPolicy = &inPolicyCopy
1,571✔
51

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

60
        return &channelCopy
1,597✔
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 {
142✔
74
        return &GraphCache{
142✔
75
                nodeChannels: make(
142✔
76
                        map[route.Vertex]map[uint64]*DirectedChannel,
142✔
77
                        // A channel connects two nodes, so we can look it up
142✔
78
                        // from both sides, meaning we get double the number of
142✔
79
                        // entries.
142✔
80
                        preAllocNumNodes*2,
142✔
81
                ),
142✔
82
                nodeFeatures: make(
142✔
83
                        map[route.Vertex]*lnwire.FeatureVector,
142✔
84
                        preAllocNumNodes,
142✔
85
                ),
142✔
86
        }
142✔
87
}
142✔
88

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

378✔
94
        numChannels := 0
378✔
95
        for node := range c.nodeChannels {
783✔
96
                numChannels += len(c.nodeChannels[node])
405✔
97
        }
405✔
98
        return fmt.Sprintf("num_node_features=%d, num_nodes=%d, "+
378✔
99
                "num_channels=%d", len(c.nodeFeatures), len(c.nodeChannels),
378✔
100
                numChannels)
378✔
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) {
663✔
106

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

663✔
110
        c.nodeFeatures[node] = features
663✔
111
}
663✔
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) {
1,695✔
119

1,695✔
120
        if info == nil {
1,695✔
121
                return
×
122
        }
×
123

124
        if policy1 != nil && policy1.IsDisabled() &&
1,695✔
125
                policy2 != nil && policy2.IsDisabled() {
1,698✔
126

3✔
127
                return
3✔
128
        }
3✔
129

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

1,695✔
146
        // The policy's node is always the to_node. So if policy 1 has to_node
1,695✔
147
        // of node 2 then we have the policy 1 as seen from node 1.
1,695✔
148
        if policy1 != nil {
2,096✔
149
                fromNode, toNode := info.NodeKey1Bytes, info.NodeKey2Bytes
401✔
150
                if !policy1.IsNode1() {
402✔
151
                        fromNode, toNode = toNode, fromNode
1✔
152
                }
1✔
153
                c.UpdatePolicy(policy1, fromNode, toNode)
401✔
154
        }
155
        if policy2 != nil {
2,096✔
156
                fromNode, toNode := info.NodeKey2Bytes, info.NodeKey1Bytes
401✔
157
                if policy2.IsNode1() {
402✔
158
                        fromNode, toNode = toNode, fromNode
1✔
159
                }
1✔
160
                c.UpdatePolicy(policy2, fromNode, toNode)
401✔
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) {
3,387✔
167
        if len(c.nodeChannels[node]) == 0 {
4,253✔
168
                c.nodeChannels[node] = make(map[uint64]*DirectedChannel)
866✔
169
        }
866✔
170

171
        c.nodeChannels[node][edge.ChannelID] = edge
3,387✔
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) {
3,075✔
180

3,075✔
181
        c.mtx.Lock()
3,075✔
182
        defer c.mtx.Unlock()
3,075✔
183

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

×
188
                        return
×
189
                }
×
190

191
                channel, ok := c.nodeChannels[nodeKey][policy.ChannelID]
6,147✔
192
                if !ok {
6,147✔
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 {
6,147✔
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():
1,540✔
205
                        channel.OutPolicySet = true
1,540✔
206
                        policy.InboundFee.WhenSome(func(fee lnwire.Fee) {
1,705✔
207
                                channel.InboundFee = fee
165✔
208
                        })
165✔
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():
1,538✔
213
                        channel.OutPolicySet = true
1,538✔
214
                        policy.InboundFee.WhenSome(func(fee lnwire.Fee) {
1,702✔
215
                                channel.InboundFee = fee
164✔
216
                        })
164✔
217

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

225
        updatePolicy(fromNode)
3,075✔
226
        updatePolicy(toNode)
3,075✔
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) {
64✔
232
        c.mtx.Lock()
64✔
233
        defer c.mtx.Unlock()
64✔
234

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

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

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

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

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

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

262
        delete(c.nodeChannels[node], chanID)
356✔
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 {
548✔
268
        c.mtx.RLock()
548✔
269
        defer c.mtx.RUnlock()
548✔
270

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

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

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

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

304
                channelsCopy[i] = channelCopy
1,593✔
305
                i++
1,593✔
306
        }
307

308
        return channelsCopy
541✔
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 {
548✔
314

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

329
        return nil
537✔
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,
339
        channels map[uint64]*DirectedChannel) error) error {
2✔
340

2✔
341
        c.mtx.RLock()
2✔
342
        defer c.mtx.RUnlock()
2✔
343

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

353
        return nil
2✔
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 {
472✔
359
        c.mtx.RLock()
472✔
360
        defer c.mtx.RUnlock()
472✔
361

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

369
        return features
392✔
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