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

lightningnetwork / lnd / 20284391193

16 Dec 2025 10:13PM UTC coverage: 55.376% (-9.8%) from 65.195%
20284391193

Pull #10089

github

web-flow
Merge 51c0faa03 into 91423ee51
Pull Request #10089: Onion message forwarding

359 of 713 new or added lines in 13 files covered. (50.35%)

29403 existing lines in 461 files now uncovered.

100338 of 181195 relevant lines covered (55.38%)

1.72 hits per line

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

86.03
/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 {
3✔
46
        channelCopy := *c
3✔
47

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

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

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

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

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

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

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

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

124
        // Create the edge entry for both nodes. We always add the channel
125
        // structure to the cache, even if both policies are currently disabled,
126
        // so that later policy updates can find and update the channel entry.
127
        c.mtx.Lock()
3✔
128
        c.updateOrAddEdge(info.NodeKey1Bytes, &DirectedChannel{
3✔
129
                ChannelID: info.ChannelID,
3✔
130
                IsNode1:   true,
3✔
131
                OtherNode: info.NodeKey2Bytes,
3✔
132
                Capacity:  info.Capacity,
3✔
133
        })
3✔
134
        c.updateOrAddEdge(info.NodeKey2Bytes, &DirectedChannel{
3✔
135
                ChannelID: info.ChannelID,
3✔
136
                IsNode1:   false,
3✔
137
                OtherNode: info.NodeKey1Bytes,
3✔
138
                Capacity:  info.Capacity,
3✔
139
        })
3✔
140
        c.mtx.Unlock()
3✔
141

3✔
142
        // Skip adding policies if both are disabled, as the channel is
3✔
143
        // currently unusable for routing. However, we still add the channel
3✔
144
        // structure above so that policy updates can later enable it.
3✔
145
        if policy1 != nil && policy1.IsDisabled() &&
3✔
146
                policy2 != nil && policy2.IsDisabled() {
6✔
147

3✔
148
                log.Debugf("Skipping policies for channel %v: both "+
3✔
149
                        "policies are disabled (channel structure still "+
3✔
150
                        "cached for future updates)", info.ChannelID)
3✔
151

3✔
152
                return
3✔
153
        }
3✔
154

155
        // The policy's node is always the to_node. So if policy 1 has to_node
156
        // of node 2 then we have the policy 1 as seen from node 1.
157
        if policy1 != nil {
6✔
158
                fromNode, toNode := info.NodeKey1Bytes, info.NodeKey2Bytes
3✔
159
                if !policy1.IsNode1() {
3✔
UNCOV
160
                        fromNode, toNode = toNode, fromNode
×
UNCOV
161
                }
×
162
                c.UpdatePolicy(policy1, fromNode, toNode)
3✔
163
        }
164
        if policy2 != nil {
6✔
165
                fromNode, toNode := info.NodeKey2Bytes, info.NodeKey1Bytes
3✔
166
                if policy2.IsNode1() {
3✔
UNCOV
167
                        fromNode, toNode = toNode, fromNode
×
UNCOV
168
                }
×
169
                c.UpdatePolicy(policy2, fromNode, toNode)
3✔
170
        }
171
}
172

173
// updateOrAddEdge makes sure the edge information for a node is either updated
174
// if it already exists or is added to that node's list of channels.
175
func (c *GraphCache) updateOrAddEdge(node route.Vertex, edge *DirectedChannel) {
3✔
176
        if len(c.nodeChannels[node]) == 0 {
6✔
177
                c.nodeChannels[node] = make(map[uint64]*DirectedChannel)
3✔
178
        }
3✔
179

180
        c.nodeChannels[node][edge.ChannelID] = edge
3✔
181
}
182

183
// UpdatePolicy updates a single policy on both the from and to node. The order
184
// of the from and to node is not strictly important. But we assume that a
185
// channel edge was added beforehand so that the directed channel struct already
186
// exists in the cache.
187
func (c *GraphCache) UpdatePolicy(policy *models.CachedEdgePolicy, fromNode,
188
        toNode route.Vertex) {
3✔
189

3✔
190
        c.mtx.Lock()
3✔
191
        defer c.mtx.Unlock()
3✔
192

3✔
193
        updatePolicy := func(nodeKey route.Vertex) {
6✔
194
                if len(c.nodeChannels[nodeKey]) == 0 {
3✔
195
                        log.Warnf("Node=%v not found in graph cache", nodeKey)
×
196

×
197
                        return
×
198
                }
×
199

200
                channel, ok := c.nodeChannels[nodeKey][policy.ChannelID]
3✔
201
                if !ok {
3✔
202
                        log.Warnf("Channel=%v not found in graph cache",
×
203
                                policy.ChannelID)
×
204

×
205
                        return
×
206
                }
×
207

208
                // Edge 1 is defined as the policy for the direction of node1 to
209
                // node2.
210
                switch {
3✔
211
                // This is node 1, and it is edge 1, so this is the outgoing
212
                // policy for node 1.
213
                case channel.IsNode1 && policy.IsNode1():
3✔
214
                        channel.OutPolicySet = true
3✔
215
                        policy.InboundFee.WhenSome(func(fee lnwire.Fee) {
6✔
216
                                channel.InboundFee = fee
3✔
217
                        })
3✔
218

219
                // This is node 2, and it is edge 2, so this is the outgoing
220
                // policy for node 2.
221
                case !channel.IsNode1 && !policy.IsNode1():
3✔
222
                        channel.OutPolicySet = true
3✔
223
                        policy.InboundFee.WhenSome(func(fee lnwire.Fee) {
6✔
224
                                channel.InboundFee = fee
3✔
225
                        })
3✔
226

227
                // The other two cases left mean it's the inbound policy for the
228
                // node.
229
                default:
3✔
230
                        channel.InPolicy = policy
3✔
231
                }
232
        }
233

234
        updatePolicy(fromNode)
3✔
235
        updatePolicy(toNode)
3✔
236
}
237

238
// RemoveNode completely removes a node and all its channels (including the
239
// peer's side).
240
func (c *GraphCache) RemoveNode(node route.Vertex) {
3✔
241
        c.mtx.Lock()
3✔
242
        defer c.mtx.Unlock()
3✔
243

3✔
244
        delete(c.nodeFeatures, node)
3✔
245

3✔
246
        // First remove all channels from the other nodes' lists.
3✔
247
        for _, channel := range c.nodeChannels[node] {
3✔
UNCOV
248
                c.removeChannelIfFound(channel.OtherNode, channel.ChannelID)
×
UNCOV
249
        }
×
250

251
        // Then remove our whole node completely.
252
        delete(c.nodeChannels, node)
3✔
253
}
254

255
// RemoveChannel removes a single channel between two nodes.
256
func (c *GraphCache) RemoveChannel(node1, node2 route.Vertex, chanID uint64) {
3✔
257
        c.mtx.Lock()
3✔
258
        defer c.mtx.Unlock()
3✔
259

3✔
260
        // Remove that one channel from both sides.
3✔
261
        c.removeChannelIfFound(node1, chanID)
3✔
262
        c.removeChannelIfFound(node2, chanID)
3✔
263
}
3✔
264

265
// removeChannelIfFound removes a single channel from one side.
266
func (c *GraphCache) removeChannelIfFound(node route.Vertex, chanID uint64) {
3✔
267
        if len(c.nodeChannels[node]) == 0 {
3✔
UNCOV
268
                return
×
UNCOV
269
        }
×
270

271
        delete(c.nodeChannels[node], chanID)
3✔
272
}
273

274
// getChannels returns a copy of the passed node's channels or nil if there
275
// isn't any.
276
func (c *GraphCache) getChannels(node route.Vertex) []*DirectedChannel {
3✔
277
        c.mtx.RLock()
3✔
278
        defer c.mtx.RUnlock()
3✔
279

3✔
280
        channels, ok := c.nodeChannels[node]
3✔
281
        if !ok {
6✔
282
                return nil
3✔
283
        }
3✔
284

285
        features, ok := c.nodeFeatures[node]
3✔
286
        if !ok {
6✔
287
                // If the features were set to nil explicitly, that's fine here.
3✔
288
                // The router will overwrite the features of the destination
3✔
289
                // node with those found in the invoice if necessary. But if we
3✔
290
                // didn't yet get a node announcement we want to mimic the
3✔
291
                // behavior of the old DB based code that would always set an
3✔
292
                // empty feature vector instead of leaving it nil.
3✔
293
                features = lnwire.EmptyFeatureVector()
3✔
294
        }
3✔
295

296
        toNodeCallback := func() route.Vertex {
6✔
297
                return node
3✔
298
        }
3✔
299

300
        i := 0
3✔
301
        channelsCopy := make([]*DirectedChannel, len(channels))
3✔
302
        for _, channel := range channels {
6✔
303
                // We need to copy the channel and policy to avoid it being
3✔
304
                // updated in the cache if the path finding algorithm sets
3✔
305
                // fields on it (currently only the ToNodeFeatures of the
3✔
306
                // policy).
3✔
307
                channelCopy := channel.DeepCopy()
3✔
308
                if channelCopy.InPolicy != nil {
6✔
309
                        channelCopy.InPolicy.ToNodePubKey = toNodeCallback
3✔
310
                        channelCopy.InPolicy.ToNodeFeatures = features
3✔
311
                }
3✔
312

313
                channelsCopy[i] = channelCopy
3✔
314
                i++
3✔
315
        }
316

317
        return channelsCopy
3✔
318
}
319

320
// ForEachChannel invokes the given callback for each channel of the given node.
321
func (c *GraphCache) ForEachChannel(node route.Vertex,
322
        cb func(channel *DirectedChannel) error) error {
3✔
323

3✔
324
        // Obtain a copy of the node's channels. We need do this in order to
3✔
325
        // avoid deadlocks caused by interaction with the graph cache, channel
3✔
326
        // state and the graph database from multiple goroutines. This snapshot
3✔
327
        // is only used for path finding where being stale is acceptable since
3✔
328
        // the real world graph and our representation may always become
3✔
329
        // slightly out of sync for a short time and the actual channel state
3✔
330
        // is stored separately.
3✔
331
        channels := c.getChannels(node)
3✔
332
        for _, channel := range channels {
6✔
333
                if err := cb(channel); err != nil {
6✔
334
                        return err
3✔
335
                }
3✔
336
        }
337

338
        return nil
3✔
339
}
340

341
// ForEachNode iterates over the adjacency list of the graph, executing the
342
// call back for each node and the set of channels that emanate from the given
343
// node.
344
//
345
// NOTE: This method should be considered _read only_, the channels or nodes
346
// passed in MUST NOT be modified.
347
func (c *GraphCache) ForEachNode(cb func(node route.Vertex,
UNCOV
348
        channels map[uint64]*DirectedChannel) error) error {
×
UNCOV
349

×
UNCOV
350
        c.mtx.RLock()
×
UNCOV
351
        defer c.mtx.RUnlock()
×
UNCOV
352

×
UNCOV
353
        for node, channels := range c.nodeChannels {
×
UNCOV
354
                // We don't make a copy here since this is a read-only RPC
×
UNCOV
355
                // call. We also don't need the node features either for this
×
UNCOV
356
                // call.
×
UNCOV
357
                if err := cb(node, channels); err != nil {
×
358
                        return err
×
359
                }
×
360
        }
361

UNCOV
362
        return nil
×
363
}
364

365
// GetFeatures returns the features of the node with the given ID. If no
366
// features are known for the node, an empty feature vector is returned.
367
func (c *GraphCache) GetFeatures(node route.Vertex) *lnwire.FeatureVector {
3✔
368
        c.mtx.RLock()
3✔
369
        defer c.mtx.RUnlock()
3✔
370

3✔
371
        features, ok := c.nodeFeatures[node]
3✔
372
        if !ok || features == nil {
6✔
373
                // The router expects the features to never be nil, so we return
3✔
374
                // an empty feature set instead.
3✔
375
                return lnwire.EmptyFeatureVector()
3✔
376
        }
3✔
377

378
        return features
3✔
379
}
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