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

lightningnetwork / lnd / 23574486954

26 Mar 2026 02:27AM UTC coverage: 52.282% (-9.8%) from 62.117%
23574486954

Pull #10063

github

web-flow
Merge e2ce19c78 into 46fbc10fc
Pull Request #10063: multi: add taproot support to the new RBF close flow

811 of 1111 new or added lines in 8 files covered. (73.0%)

30843 existing lines in 476 files now uncovered.

102015 of 195125 relevant lines covered (52.28%)

2.17 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 {
4✔
46
        channelCopy := *c
4✔
47

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

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

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

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

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

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

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

4✔
120
        if info == nil {
4✔
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()
4✔
128
        c.updateOrAddEdge(info.NodeKey1Bytes, &DirectedChannel{
4✔
129
                ChannelID: info.ChannelID,
4✔
130
                IsNode1:   true,
4✔
131
                OtherNode: info.NodeKey2Bytes,
4✔
132
                Capacity:  info.Capacity,
4✔
133
        })
4✔
134
        c.updateOrAddEdge(info.NodeKey2Bytes, &DirectedChannel{
4✔
135
                ChannelID: info.ChannelID,
4✔
136
                IsNode1:   false,
4✔
137
                OtherNode: info.NodeKey1Bytes,
4✔
138
                Capacity:  info.Capacity,
4✔
139
        })
4✔
140
        c.mtx.Unlock()
4✔
141

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

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

4✔
152
                return
4✔
153
        }
4✔
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 {
8✔
158
                fromNode, toNode := info.NodeKey1Bytes, info.NodeKey2Bytes
4✔
159
                if !policy1.IsNode1 {
4✔
UNCOV
160
                        fromNode, toNode = toNode, fromNode
×
UNCOV
161
                }
×
162
                c.UpdatePolicy(policy1, fromNode, toNode)
4✔
163
        }
164
        if policy2 != nil {
8✔
165
                fromNode, toNode := info.NodeKey2Bytes, info.NodeKey1Bytes
4✔
166
                if policy2.IsNode1 {
4✔
UNCOV
167
                        fromNode, toNode = toNode, fromNode
×
UNCOV
168
                }
×
169
                c.UpdatePolicy(policy2, fromNode, toNode)
4✔
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) {
4✔
176
        if len(c.nodeChannels[node]) == 0 {
8✔
177
                c.nodeChannels[node] = make(map[uint64]*DirectedChannel)
4✔
178
        }
4✔
179

180
        c.nodeChannels[node][edge.ChannelID] = edge
4✔
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) {
4✔
189

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

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

×
197
                        return
×
198
                }
×
199

200
                channel, ok := c.nodeChannels[nodeKey][policy.ChannelID]
4✔
201
                if !ok {
4✔
202
                        log.Debugf("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 {
4✔
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:
4✔
214
                        channel.OutPolicySet = true
4✔
215
                        policy.InboundFee.WhenSome(func(fee lnwire.Fee) {
8✔
216
                                channel.InboundFee = fee
4✔
217
                        })
4✔
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:
4✔
222
                        channel.OutPolicySet = true
4✔
223
                        policy.InboundFee.WhenSome(func(fee lnwire.Fee) {
8✔
224
                                channel.InboundFee = fee
4✔
225
                        })
4✔
226

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

234
        updatePolicy(fromNode)
4✔
235
        updatePolicy(toNode)
4✔
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) {
4✔
241
        c.mtx.Lock()
4✔
242
        defer c.mtx.Unlock()
4✔
243

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

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

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

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

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

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

271
        delete(c.nodeChannels[node], chanID)
4✔
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 {
4✔
277
        c.mtx.RLock()
4✔
278
        defer c.mtx.RUnlock()
4✔
279

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

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

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

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

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

317
        return channelsCopy
4✔
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 {
4✔
323

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

338
        return nil
4✔
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 {
4✔
368
        c.mtx.RLock()
4✔
369
        defer c.mtx.RUnlock()
4✔
370

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

378
        return features
4✔
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

© 2026 Coveralls, Inc