15714380358

Committed 17 Jun 2025 05:43PM UTC coverage: 58.303% (-10.2%) from 68.465%

Build # 15714380358

Build Type

Pull #9958

github

Committed by

web-flow

Commit Message

Merge b7cc95803 into c1740c14b

Pull Request Pull Request #9958: improve CloseChannel docs

Run Details

97827 of 167790 relevant lines covered (58.3%)

1.81 hits per line

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

62.43

/graph/db/graph.go

package graphdb

import (
        "errors"
        "fmt"
        "sync"
        "sync/atomic"
        "testing"
        "time"

        "github.com/btcsuite/btcd/chaincfg/chainhash"
        "github.com/btcsuite/btcd/wire"
        "github.com/lightningnetwork/lnd/batch"
        "github.com/lightningnetwork/lnd/graph/db/models"
        "github.com/lightningnetwork/lnd/lnwire"
        "github.com/lightningnetwork/lnd/routing/route"
        "github.com/stretchr/testify/require"
)

// ErrChanGraphShuttingDown indicates that the ChannelGraph has shutdown or is
// busy shutting down.
var ErrChanGraphShuttingDown = fmt.Errorf("ChannelGraph shutting down")

// ChannelGraph is a layer above the graph's CRUD layer.
//
// NOTE: currently, this is purely a pass-through layer directly to the backing
// KVStore. Upcoming commits will move the graph cache out of the KVStore and
// into this layer so that the KVStore is only responsible for CRUD operations.
type ChannelGraph struct {
        started atomic.Bool
        stopped atomic.Bool

        graphCache *GraphCache

        V1Store
        *topologyManager

        quit chan struct{}
        wg   sync.WaitGroup
}

// NewChannelGraph creates a new ChannelGraph instance with the given backend.
func NewChannelGraph(v1Store V1Store,
        options ...ChanGraphOption) (*ChannelGraph, error) {

        opts := defaultChanGraphOptions()
        for _, o := range options {
                o(opts)
        }

        g := &ChannelGraph{
                V1Store:         v1Store,
                topologyManager: newTopologyManager(),
                quit:            make(chan struct{}),
        }

        // The graph cache can be turned off (e.g. for mobile users) for a
        // speed/memory usage tradeoff.
        if opts.useGraphCache {
                g.graphCache = NewGraphCache(opts.preAllocCacheNumNodes)
        }

        return g, nil
}

// Start kicks off any goroutines required for the ChannelGraph to function.
// If the graph cache is enabled, then it will be populated with the contents of
// the database.
func (c *ChannelGraph) Start() error {
        if !c.started.CompareAndSwap(false, true) {
                return nil
        }
        log.Debugf("ChannelGraph starting")
        defer log.Debug("ChannelGraph started")

        if c.graphCache != nil {
                if err := c.populateCache(); err != nil {
                        return fmt.Errorf("could not populate the graph "+
                                "cache: %w", err)
                }
        }

        c.wg.Add(1)
        go c.handleTopologySubscriptions()

        return nil
}

// Stop signals any active goroutines for a graceful closure.
func (c *ChannelGraph) Stop() error {
        if !c.stopped.CompareAndSwap(false, true) {
                return nil
        }

        log.Debugf("ChannelGraph shutting down...")
        defer log.Debug("ChannelGraph shutdown complete")

        close(c.quit)
        c.wg.Wait()

        return nil
}

// handleTopologySubscriptions ensures that topology client subscriptions,
// subscription cancellations and topology notifications are handled
// synchronously.
//
// NOTE: this MUST be run in a goroutine.
func (c *ChannelGraph) handleTopologySubscriptions() {
        defer c.wg.Done()

        for {
                select {
                // A new fully validated topology update has just arrived.
                // We'll notify any registered clients.
                case update := <-c.topologyUpdate:
                        // TODO(elle): change topology handling to be handled
                        // synchronously so that we can guarantee the order of
                        // notification delivery.
                        c.wg.Add(1)
                        go c.handleTopologyUpdate(update)

                        // TODO(roasbeef): remove all unconnected vertexes
                        // after N blocks pass with no corresponding
                        // announcements.

                // A new notification client update has arrived. We're either
                // gaining a new client, or cancelling notifications for an
                // existing client.
                case ntfnUpdate := <-c.ntfnClientUpdates:
                        clientID := ntfnUpdate.clientID

                        if ntfnUpdate.cancel {
                                client, ok := c.topologyClients.LoadAndDelete(
                                        clientID,
                                )
                                if ok {
                                        close(client.exit)
                                        client.wg.Wait()

                                        close(client.ntfnChan)
                                }

                                continue
                        }

                        c.topologyClients.Store(clientID, &topologyClient{
                                ntfnChan: ntfnUpdate.ntfnChan,
                                exit:     make(chan struct{}),
                        })

                case <-c.quit:
                        return
                }
        }
}

// populateCache loads the entire channel graph into the in-memory graph cache.
//
// NOTE: This should only be called if the graphCache has been constructed.
func (c *ChannelGraph) populateCache() error {
        startTime := time.Now()
        log.Info("Populating in-memory channel graph, this might take a " +
                "while...")

        err := c.V1Store.ForEachNodeCacheable(func(node route.Vertex,
                features *lnwire.FeatureVector) error {

                c.graphCache.AddNodeFeatures(node, features)

                return nil
        })
        if err != nil {
                return err
        }

        err = c.V1Store.ForEachChannelCacheable(
                func(info *models.CachedEdgeInfo,
                        policy1, policy2 *models.CachedEdgePolicy) error {

                        c.graphCache.AddChannel(info, policy1, policy2)

                        return nil
                })
        if err != nil {
                return err
        }

        log.Infof("Finished populating in-memory channel graph (took %v, %s)",
                time.Since(startTime), c.graphCache.Stats())

        return nil
}

// ForEachNodeDirectedChannel iterates through all channels of a given node,
// executing the passed callback on the directed edge representing the channel
// and its incoming policy. If the callback returns an error, then the iteration
// is halted with the error propagated back up to the caller. If the graphCache
// is available, then it will be used to retrieve the node's channels instead
// of the database.
//
// Unknown policies are passed into the callback as nil values.
//
// NOTE: this is part of the graphdb.NodeTraverser interface.
func (c *ChannelGraph) ForEachNodeDirectedChannel(node route.Vertex,
        cb func(channel *DirectedChannel) error) error {

        if c.graphCache != nil {
                return c.graphCache.ForEachChannel(node, cb)
        }

        return c.V1Store.ForEachNodeDirectedChannel(node, cb)
}

// FetchNodeFeatures returns the features of the given node. If no features are
// known for the node, an empty feature vector is returned.
// If the graphCache is available, then it will be used to retrieve the node's
// features instead of the database.
//
// NOTE: this is part of the graphdb.NodeTraverser interface.
func (c *ChannelGraph) FetchNodeFeatures(node route.Vertex) (
        *lnwire.FeatureVector, error) {

        if c.graphCache != nil {
                return c.graphCache.GetFeatures(node), nil
        }

        return c.V1Store.FetchNodeFeatures(node)
}

// GraphSession will provide the call-back with access to a NodeTraverser
// instance which can be used to perform queries against the channel graph. If
// the graph cache is not enabled, then the call-back will be provided with
// access to the graph via a consistent read-only transaction.
func (c *ChannelGraph) GraphSession(cb func(graph NodeTraverser) error) error {
        if c.graphCache != nil {
                return cb(c)
        }

        return c.V1Store.GraphSession(cb)
}

// ForEachNodeCached iterates through all the stored vertices/nodes in the
// graph, executing the passed callback with each node encountered.
//
// NOTE: The callback contents MUST not be modified.
func (c *ChannelGraph) ForEachNodeCached(cb func(node route.Vertex,
        chans map[uint64]*DirectedChannel) error) error {

        if c.graphCache != nil {
                return c.graphCache.ForEachNode(cb)
        }

        return c.V1Store.ForEachNodeCached(cb)
}

// AddLightningNode adds a vertex/node to the graph database. If the node is not
// in the database from before, this will add a new, unconnected one to the
// graph. If it is present from before, this will update that node's
// information. Note that this method is expected to only be called to update an
// already present node from a node announcement, or to insert a node found in a
// channel update.
func (c *ChannelGraph) AddLightningNode(node *models.LightningNode,
        op ...batch.SchedulerOption) error {

        err := c.V1Store.AddLightningNode(node, op...)
        if err != nil {
                return err
        }

        if c.graphCache != nil {
                c.graphCache.AddNodeFeatures(
                        node.PubKeyBytes, node.Features,
                )
        }

        select {
        case c.topologyUpdate <- node:
        case <-c.quit:
                return ErrChanGraphShuttingDown
        }

        return nil
}

// DeleteLightningNode starts a new database transaction to remove a vertex/node
// from the database according to the node's public key.
func (c *ChannelGraph) DeleteLightningNode(nodePub route.Vertex) error {
        err := c.V1Store.DeleteLightningNode(nodePub)
        if err != nil {
                return err
        }

        if c.graphCache != nil {
                c.graphCache.RemoveNode(nodePub)
        }

        return nil
}

// AddChannelEdge adds a new (undirected, blank) edge to the graph database. An
// undirected edge from the two target nodes are created. The information stored
// denotes the static attributes of the channel, such as the channelID, the keys
// involved in creation of the channel, and the set of features that the channel
// supports. The chanPoint and chanID are used to uniquely identify the edge
// globally within the database.
func (c *ChannelGraph) AddChannelEdge(edge *models.ChannelEdgeInfo,
        op ...batch.SchedulerOption) error {

        err := c.V1Store.AddChannelEdge(edge, op...)
        if err != nil {
                return err
        }

        if c.graphCache != nil {
                c.graphCache.AddChannel(models.NewCachedEdge(edge), nil, nil)
        }

        select {
        case c.topologyUpdate <- edge:
        case <-c.quit:
                return ErrChanGraphShuttingDown
        }

        return nil
}

// MarkEdgeLive clears an edge from our zombie index, deeming it as live.
// If the cache is enabled, the edge will be added back to the graph cache if
// we still have a record of this channel in the DB.
func (c *ChannelGraph) MarkEdgeLive(chanID uint64) error {
        err := c.V1Store.MarkEdgeLive(chanID)
        if err != nil {
                return err
        }

        if c.graphCache != nil {
                // We need to add the channel back into our graph cache,
                // otherwise we won't use it for path finding.
                infos, err := c.V1Store.FetchChanInfos([]uint64{chanID})
                if err != nil {
                        return err
                }

                if len(infos) == 0 {
                        return nil
                }

                info := infos[0]

                c.graphCache.AddChannel(
                        models.NewCachedEdge(info.Info),
                        models.NewCachedPolicy(info.Policy1),
                        models.NewCachedPolicy(info.Policy2),
                )
        }

        return nil
}

// DeleteChannelEdges removes edges with the given channel IDs from the
// database and marks them as zombies. This ensures that we're unable to re-add
// it to our database once again. If an edge does not exist within the
// database, then ErrEdgeNotFound will be returned. If strictZombiePruning is
// true, then when we mark these edges as zombies, we'll set up the keys such
// that we require the node that failed to send the fresh update to be the one
// that resurrects the channel from its zombie state. The markZombie bool
// denotes whether to mark the channel as a zombie.
func (c *ChannelGraph) DeleteChannelEdges(strictZombiePruning, markZombie bool,
        chanIDs ...uint64) error {

        infos, err := c.V1Store.DeleteChannelEdges(
                strictZombiePruning, markZombie, chanIDs...,
        )
        if err != nil {
                return err
        }

        if c.graphCache != nil {
                for _, info := range infos {
                        c.graphCache.RemoveChannel(
                                info.NodeKey1Bytes, info.NodeKey2Bytes,
                                info.ChannelID,
                        )
                }
        }

        return err
}

// DisconnectBlockAtHeight is used to indicate that the block specified
// by the passed height has been disconnected from the main chain. This
// will "rewind" the graph back to the height below, deleting channels
// that are no longer confirmed from the graph. The prune log will be
// set to the last prune height valid for the remaining chain.
// Channels that were removed from the graph resulting from the
// disconnected block are returned.
func (c *ChannelGraph) DisconnectBlockAtHeight(height uint32) (
        []*models.ChannelEdgeInfo, error) {

        edges, err := c.V1Store.DisconnectBlockAtHeight(height)
        if err != nil {
                return nil, err
        }

        if c.graphCache != nil {
                for _, edge := range edges {
                        c.graphCache.RemoveChannel(
                                edge.NodeKey1Bytes, edge.NodeKey2Bytes,
                                edge.ChannelID,
                        )
                }
        }

        return edges, nil
}

// PruneGraph prunes newly closed channels from the channel graph in response
// to a new block being solved on the network. Any transactions which spend the
// funding output of any known channels within he graph will be deleted.
// Additionally, the "prune tip", or the last block which has been used to
// prune the graph is stored so callers can ensure the graph is fully in sync
// with the current UTXO state. A slice of channels that have been closed by
// the target block are returned if the function succeeds without error.
func (c *ChannelGraph) PruneGraph(spentOutputs []*wire.OutPoint,
        blockHash *chainhash.Hash, blockHeight uint32) (
        []*models.ChannelEdgeInfo, error) {

        edges, nodes, err := c.V1Store.PruneGraph(
                spentOutputs, blockHash, blockHeight,
        )
        if err != nil {
                return nil, err
        }

        if c.graphCache != nil {
                for _, edge := range edges {
                        c.graphCache.RemoveChannel(
                                edge.NodeKey1Bytes, edge.NodeKey2Bytes,
                                edge.ChannelID,
                        )
                }

                for _, node := range nodes {
                        c.graphCache.RemoveNode(node)
                }

                log.Debugf("Pruned graph, cache now has %s",
                        c.graphCache.Stats())
        }

        if len(edges) != 0 {
                // Notify all currently registered clients of the newly closed
                // channels.
                closeSummaries := createCloseSummaries(
                        blockHeight, edges...,
                )

                select {
                case c.topologyUpdate <- closeSummaries:
                case <-c.quit:
                        return nil, ErrChanGraphShuttingDown
                }
        }

        return edges, nil
}

// PruneGraphNodes is a garbage collection method which attempts to prune out
// any nodes from the channel graph that are currently unconnected. This ensure
// that we only maintain a graph of reachable nodes. In the event that a pruned
// node gains more channels, it will be re-added back to the graph.
func (c *ChannelGraph) PruneGraphNodes() error {
        nodes, err := c.V1Store.PruneGraphNodes()
        if err != nil {
                return err
        }

        if c.graphCache != nil {
                for _, node := range nodes {
                        c.graphCache.RemoveNode(node)
                }
        }

        return nil
}

// FilterKnownChanIDs takes a set of channel IDs and return the subset of chan
// ID's that we don't know and are not known zombies of the passed set. In other
// words, we perform a set difference of our set of chan ID's and the ones
// passed in. This method can be used by callers to determine the set of
// channels another peer knows of that we don't.
func (c *ChannelGraph) FilterKnownChanIDs(chansInfo []ChannelUpdateInfo,
        isZombieChan func(time.Time, time.Time) bool) ([]uint64, error) {

        unknown, knownZombies, err := c.V1Store.FilterKnownChanIDs(chansInfo)
        if err != nil {
                return nil, err
        }

        for _, info := range knownZombies {
                // TODO(ziggie): Make sure that for the strict pruning case we
                // compare the pubkeys and whether the right timestamp is not
                // older than the `ChannelPruneExpiry`.
                //
                // NOTE: The timestamp data has no verification attached to it
                // in the `ReplyChannelRange` msg so we are trusting this data
                // at this point. However it is not critical because we are just
                // removing the channel from the db when the timestamps are more
                // recent. During the querying of the gossip msg verification
                // happens as usual. However we should start punishing peers
                // when they don't provide us honest data ?
                isStillZombie := isZombieChan(
                        info.Node1UpdateTimestamp, info.Node2UpdateTimestamp,
                )

                if isStillZombie {
                        continue
                }

                // If we have marked it as a zombie but the latest update
                // timestamps could bring it back from the dead, then we mark it
                // alive, and we let it be added to the set of IDs to query our
                // peer for.
                err := c.V1Store.MarkEdgeLive(
                        info.ShortChannelID.ToUint64(),
                )
                // Since there is a chance that the edge could have been marked
                // as "live" between the FilterKnownChanIDs call and the
                // MarkEdgeLive call, we ignore the error if the edge is already
                // marked as live.
                if err != nil && !errors.Is(err, ErrZombieEdgeNotFound) {
                        return nil, err
                }
        }

        return unknown, nil
}

// MarkEdgeZombie attempts to mark a channel identified by its channel ID as a
// zombie. This method is used on an ad-hoc basis, when channels need to be
// marked as zombies outside the normal pruning cycle.
func (c *ChannelGraph) MarkEdgeZombie(chanID uint64,
        pubKey1, pubKey2 [33]byte) error {

        err := c.V1Store.MarkEdgeZombie(chanID, pubKey1, pubKey2)
        if err != nil {
                return err
        }

        if c.graphCache != nil {
                c.graphCache.RemoveChannel(pubKey1, pubKey2, chanID)
        }

        return nil
}

// UpdateEdgePolicy updates the edge routing policy for a single directed edge
// within the database for the referenced channel. The `flags` attribute within
// the ChannelEdgePolicy determines which of the directed edges are being
// updated. If the flag is 1, then the first node's information is being
// updated, otherwise it's the second node's information. The node ordering is
// determined by the lexicographical ordering of the identity public keys of the
// nodes on either side of the channel.
func (c *ChannelGraph) UpdateEdgePolicy(edge *models.ChannelEdgePolicy,
        op ...batch.SchedulerOption) error {

        from, to, err := c.V1Store.UpdateEdgePolicy(edge, op...)
        if err != nil {
                return err
        }

        if c.graphCache != nil {
                c.graphCache.UpdatePolicy(
                        models.NewCachedPolicy(edge), from, to,
                )
        }

        select {
        case c.topologyUpdate <- edge:
        case <-c.quit:
                return ErrChanGraphShuttingDown
        }

        return nil
}

// MakeTestGraphNew creates a new instance of the ChannelGraph for testing
// purposes. The backing V1Store implementation depends on the version of
// NewTestDB included in the current build.
//
// NOTE: this is currently unused, but is left here for future use to show how
// NewTestDB can be used. As the SQL implementation of the V1Store is
// implemented, unit tests will be switched to use this function instead of
// the existing MakeTestGraph helper. Once only this function is used, the
// existing MakeTestGraph function will be removed and this one will be renamed.
func MakeTestGraphNew(t testing.TB,
        opts ...ChanGraphOption) *ChannelGraph {

        t.Helper()

        store := NewTestDB(t)

        graph, err := NewChannelGraph(store, opts...)
        require.NoError(t, err)
        require.NoError(t, graph.Start())

        t.Cleanup(func() {
                require.NoError(t, graph.Stop())
        })

        return graph
}

1	package graphdb
2
3	import (
4	"errors"
5	"fmt"
6	"sync"
7	"sync/atomic"
8	"testing"
9	"time"
10
11	"github.com/btcsuite/btcd/chaincfg/chainhash"
12	"github.com/btcsuite/btcd/wire"
13	"github.com/lightningnetwork/lnd/batch"
14	"github.com/lightningnetwork/lnd/graph/db/models"
15	"github.com/lightningnetwork/lnd/lnwire"
16	"github.com/lightningnetwork/lnd/routing/route"
17	"github.com/stretchr/testify/require"
18	)
19
20	// ErrChanGraphShuttingDown indicates that the ChannelGraph has shutdown or is
21	// busy shutting down.
22	var ErrChanGraphShuttingDown = fmt.Errorf("ChannelGraph shutting down")
23
24	// ChannelGraph is a layer above the graph's CRUD layer.
25	//
26	// NOTE: currently, this is purely a pass-through layer directly to the backing
27	// KVStore. Upcoming commits will move the graph cache out of the KVStore and
28	// into this layer so that the KVStore is only responsible for CRUD operations.
29	type ChannelGraph struct {
30	started atomic.Bool
31	stopped atomic.Bool
32
33	graphCache *GraphCache
34
35	V1Store
36	*topologyManager
37
38	quit chan struct{}
39	wg sync.WaitGroup
40	}
41
42	// NewChannelGraph creates a new ChannelGraph instance with the given backend.
43	func NewChannelGraph(v1Store V1Store,
44	options ...ChanGraphOption) (*ChannelGraph, error) {	3✔
45		3✔
46	opts := defaultChanGraphOptions()	3✔
47	for _, o := range options {	6✔
48	o(opts)	3✔
49	}	3✔
50
51	g := &ChannelGraph{	3✔
52	V1Store: v1Store,	3✔
53	topologyManager: newTopologyManager(),	3✔
54	quit: make(chan struct{}),	3✔
55	}	3✔
56		3✔
57	// The graph cache can be turned off (e.g. for mobile users) for a	3✔
58	// speed/memory usage tradeoff.	3✔
59	if opts.useGraphCache {	6✔
60	g.graphCache = NewGraphCache(opts.preAllocCacheNumNodes)	3✔
61	}	3✔
62
63	return g, nil	3✔
64	}
65
66	// Start kicks off any goroutines required for the ChannelGraph to function.
67	// If the graph cache is enabled, then it will be populated with the contents of
68	// the database.
69	func (c *ChannelGraph) Start() error {	3✔
70	if !c.started.CompareAndSwap(false, true) {	3✔
71	return nil	×
72	}	×
73	log.Debugf("ChannelGraph starting")	3✔
74	defer log.Debug("ChannelGraph started")	3✔
75		3✔
76	if c.graphCache != nil {	6✔
77	if err := c.populateCache(); err != nil {	3✔
78	return fmt.Errorf("could not populate the graph "+	×
79	"cache: %w", err)	×
80	}	×
81	}
82
83	c.wg.Add(1)	3✔
84	go c.handleTopologySubscriptions()	3✔
85		3✔
86	return nil	3✔
87	}
88
89	// Stop signals any active goroutines for a graceful closure.
90	func (c *ChannelGraph) Stop() error {	3✔
91	if !c.stopped.CompareAndSwap(false, true) {	3✔
92	return nil	×
93	}	×
94
95	log.Debugf("ChannelGraph shutting down...")	3✔
96	defer log.Debug("ChannelGraph shutdown complete")	3✔
97		3✔
98	close(c.quit)	3✔
99	c.wg.Wait()	3✔
100		3✔
101	return nil	3✔
102	}
103
104	// handleTopologySubscriptions ensures that topology client subscriptions,
105	// subscription cancellations and topology notifications are handled
106	// synchronously.
107	//
108	// NOTE: this MUST be run in a goroutine.
109	func (c *ChannelGraph) handleTopologySubscriptions() {	3✔
110	defer c.wg.Done()	3✔
111		3✔
112	for {	6✔
113	select {	3✔
114	// A new fully validated topology update has just arrived.
115	// We'll notify any registered clients.
116	case update := <-c.topologyUpdate:	3✔
117	// TODO(elle): change topology handling to be handled	3✔
118	// synchronously so that we can guarantee the order of	3✔
119	// notification delivery.	3✔
120	c.wg.Add(1)	3✔
121	go c.handleTopologyUpdate(update)	3✔
122
123	// TODO(roasbeef): remove all unconnected vertexes
124	// after N blocks pass with no corresponding
125	// announcements.
126
127	// A new notification client update has arrived. We're either
128	// gaining a new client, or cancelling notifications for an
129	// existing client.
130	case ntfnUpdate := <-c.ntfnClientUpdates:	3✔
131	clientID := ntfnUpdate.clientID	3✔
132		3✔
133	if ntfnUpdate.cancel {	6✔
134	client, ok := c.topologyClients.LoadAndDelete(	3✔
135	clientID,	3✔
136	)	3✔
137	if ok {	6✔
138	close(client.exit)	3✔
139	client.wg.Wait()	3✔
140		3✔
141	close(client.ntfnChan)	3✔
142	}	3✔
143
144	continue	3✔
145	}
146
147	c.topologyClients.Store(clientID, &topologyClient{	3✔
148	ntfnChan: ntfnUpdate.ntfnChan,	3✔
149	exit: make(chan struct{}),	3✔
150	})	3✔
151
152	case <-c.quit:	3✔
153	return	3✔
154	}
155	}
156	}
157
158	// populateCache loads the entire channel graph into the in-memory graph cache.
159	//
160	// NOTE: This should only be called if the graphCache has been constructed.
161	func (c *ChannelGraph) populateCache() error {	3✔
162	startTime := time.Now()	3✔
163	log.Info("Populating in-memory channel graph, this might take a " +	3✔
164	"while...")	3✔
165		3✔
166	err := c.V1Store.ForEachNodeCacheable(func(node route.Vertex,	3✔
167	features *lnwire.FeatureVector) error {	6✔
168		3✔
169	c.graphCache.AddNodeFeatures(node, features)	3✔
170		3✔
171	return nil	3✔
172	})	3✔
173	if err != nil {	3✔
174	return err	×
175	}	×
176
177	err = c.V1Store.ForEachChannelCacheable(	3✔
178	func(info *models.CachedEdgeInfo,	3✔
179	policy1, policy2 *models.CachedEdgePolicy) error {	6✔
180		3✔
181	c.graphCache.AddChannel(info, policy1, policy2)	3✔
182		3✔
183	return nil	3✔
184	})	3✔
185	if err != nil {	3✔
186	return err	×
187	}	×
188
189	log.Infof("Finished populating in-memory channel graph (took %v, %s)",	3✔
190	time.Since(startTime), c.graphCache.Stats())	3✔
191		3✔
192	return nil	3✔
193	}
194
195	// ForEachNodeDirectedChannel iterates through all channels of a given node,
196	// executing the passed callback on the directed edge representing the channel
197	// and its incoming policy. If the callback returns an error, then the iteration
198	// is halted with the error propagated back up to the caller. If the graphCache
199	// is available, then it will be used to retrieve the node's channels instead
200	// of the database.
201	//
202	// Unknown policies are passed into the callback as nil values.
203	//
204	// NOTE: this is part of the graphdb.NodeTraverser interface.
205	func (c *ChannelGraph) ForEachNodeDirectedChannel(node route.Vertex,
206	cb func(channel *DirectedChannel) error) error {	3✔
207		3✔
208	if c.graphCache != nil {	6✔
209	return c.graphCache.ForEachChannel(node, cb)	3✔
210	}	3✔
211
212	return c.V1Store.ForEachNodeDirectedChannel(node, cb)	3✔
213	}
214
215	// FetchNodeFeatures returns the features of the given node. If no features are
216	// known for the node, an empty feature vector is returned.
217	// If the graphCache is available, then it will be used to retrieve the node's
218	// features instead of the database.
219	//
220	// NOTE: this is part of the graphdb.NodeTraverser interface.
221	func (c *ChannelGraph) FetchNodeFeatures(node route.Vertex) (
222	*lnwire.FeatureVector, error) {	3✔
223		3✔
224	if c.graphCache != nil {	6✔
225	return c.graphCache.GetFeatures(node), nil	3✔
226	}	3✔
227
228	return c.V1Store.FetchNodeFeatures(node)	3✔
229	}
230
231	// GraphSession will provide the call-back with access to a NodeTraverser
232	// instance which can be used to perform queries against the channel graph. If
233	// the graph cache is not enabled, then the call-back will be provided with
234	// access to the graph via a consistent read-only transaction.
235	func (c *ChannelGraph) GraphSession(cb func(graph NodeTraverser) error) error {	3✔
236	if c.graphCache != nil {	6✔
237	return cb(c)	3✔
238	}	3✔
239
240	return c.V1Store.GraphSession(cb)	×
241	}
242
243	// ForEachNodeCached iterates through all the stored vertices/nodes in the
244	// graph, executing the passed callback with each node encountered.
245	//
246	// NOTE: The callback contents MUST not be modified.
247	func (c *ChannelGraph) ForEachNodeCached(cb func(node route.Vertex,
248	chans map[uint64]*DirectedChannel) error) error {	×
249		×
250	if c.graphCache != nil {	×
251	return c.graphCache.ForEachNode(cb)	×
252	}	×
253
254	return c.V1Store.ForEachNodeCached(cb)	×
255	}
256
257	// AddLightningNode adds a vertex/node to the graph database. If the node is not
258	// in the database from before, this will add a new, unconnected one to the
259	// graph. If it is present from before, this will update that node's
260	// information. Note that this method is expected to only be called to update an
261	// already present node from a node announcement, or to insert a node found in a
262	// channel update.
263	func (c ChannelGraph) AddLightningNode(node models.LightningNode,
264	op ...batch.SchedulerOption) error {	3✔
265		3✔
266	err := c.V1Store.AddLightningNode(node, op...)	3✔
267	if err != nil {	3✔
268	return err	×
269	}	×
270
271	if c.graphCache != nil {	6✔
272	c.graphCache.AddNodeFeatures(	3✔
273	node.PubKeyBytes, node.Features,	3✔
274	)	3✔
275	}	3✔
276
277	select {	3✔
278	case c.topologyUpdate <- node:	3✔
279	case <-c.quit:	×
280	return ErrChanGraphShuttingDown	×
281	}
282
283	return nil	3✔
284	}
285
286	// DeleteLightningNode starts a new database transaction to remove a vertex/node
287	// from the database according to the node's public key.
288	func (c *ChannelGraph) DeleteLightningNode(nodePub route.Vertex) error {	×
289	err := c.V1Store.DeleteLightningNode(nodePub)	×
290	if err != nil {	×
291	return err	×
292	}	×
293
294	if c.graphCache != nil {	×
295	c.graphCache.RemoveNode(nodePub)	×
296	}	×
297
298	return nil	×
299	}
300
301	// AddChannelEdge adds a new (undirected, blank) edge to the graph database. An
302	// undirected edge from the two target nodes are created. The information stored
303	// denotes the static attributes of the channel, such as the channelID, the keys
304	// involved in creation of the channel, and the set of features that the channel
305	// supports. The chanPoint and chanID are used to uniquely identify the edge
306	// globally within the database.
307	func (c ChannelGraph) AddChannelEdge(edge models.ChannelEdgeInfo,
308	op ...batch.SchedulerOption) error {	3✔
309		3✔
310	err := c.V1Store.AddChannelEdge(edge, op...)	3✔
311	if err != nil {	3✔
312	return err	×
313	}	×
314
315	if c.graphCache != nil {	6✔
316	c.graphCache.AddChannel(models.NewCachedEdge(edge), nil, nil)	3✔
317	}	3✔
318
319	select {	3✔
320	case c.topologyUpdate <- edge:	3✔
321	case <-c.quit:	×
322	return ErrChanGraphShuttingDown	×
323	}
324
325	return nil	3✔
326	}
327
328	// MarkEdgeLive clears an edge from our zombie index, deeming it as live.
329	// If the cache is enabled, the edge will be added back to the graph cache if
330	// we still have a record of this channel in the DB.
331	func (c *ChannelGraph) MarkEdgeLive(chanID uint64) error {	×
332	err := c.V1Store.MarkEdgeLive(chanID)	×
333	if err != nil {	×
334	return err	×
335	}	×
336
337	if c.graphCache != nil {	×
338	// We need to add the channel back into our graph cache,	×
339	// otherwise we won't use it for path finding.	×
340	infos, err := c.V1Store.FetchChanInfos([]uint64{chanID})	×
341	if err != nil {	×
342	return err	×
343	}	×
344
345	if len(infos) == 0 {	×
346	return nil	×
347	}	×
348
349	info := infos[0]	×
350		×
351	c.graphCache.AddChannel(	×
352	models.NewCachedEdge(info.Info),	×
353	models.NewCachedPolicy(info.Policy1),	×
354	models.NewCachedPolicy(info.Policy2),	×
355	)	×
356	}
357
358	return nil	×
359	}
360
361	// DeleteChannelEdges removes edges with the given channel IDs from the
362	// database and marks them as zombies. This ensures that we're unable to re-add
363	// it to our database once again. If an edge does not exist within the
364	// database, then ErrEdgeNotFound will be returned. If strictZombiePruning is
365	// true, then when we mark these edges as zombies, we'll set up the keys such
366	// that we require the node that failed to send the fresh update to be the one
367	// that resurrects the channel from its zombie state. The markZombie bool
368	// denotes whether to mark the channel as a zombie.
369	func (c *ChannelGraph) DeleteChannelEdges(strictZombiePruning, markZombie bool,
370	chanIDs ...uint64) error {	3✔
371		3✔
372	infos, err := c.V1Store.DeleteChannelEdges(	3✔
373	strictZombiePruning, markZombie, chanIDs...,	3✔
374	)	3✔
375	if err != nil {	3✔
376	return err	×
377	}	×
378
379	if c.graphCache != nil {	6✔
380	for _, info := range infos {	6✔
381	c.graphCache.RemoveChannel(	3✔
382	info.NodeKey1Bytes, info.NodeKey2Bytes,	3✔
383	info.ChannelID,	3✔
384	)	3✔
385	}	3✔
386	}
387
388	return err	3✔
389	}
390
391	// DisconnectBlockAtHeight is used to indicate that the block specified
392	// by the passed height has been disconnected from the main chain. This
393	// will "rewind" the graph back to the height below, deleting channels
394	// that are no longer confirmed from the graph. The prune log will be
395	// set to the last prune height valid for the remaining chain.
396	// Channels that were removed from the graph resulting from the
397	// disconnected block are returned.
398	func (c *ChannelGraph) DisconnectBlockAtHeight(height uint32) (
399	[]*models.ChannelEdgeInfo, error) {	2✔
400		2✔
401	edges, err := c.V1Store.DisconnectBlockAtHeight(height)	2✔
402	if err != nil {	2✔
403	return nil, err	×
404	}	×
405
406	if c.graphCache != nil {	4✔
407	for _, edge := range edges {	4✔
408	c.graphCache.RemoveChannel(	2✔
409	edge.NodeKey1Bytes, edge.NodeKey2Bytes,	2✔
410	edge.ChannelID,	2✔
411	)	2✔
412	}	2✔
413	}
414
415	return edges, nil	2✔
416	}
417
418	// PruneGraph prunes newly closed channels from the channel graph in response
419	// to a new block being solved on the network. Any transactions which spend the
420	// funding output of any known channels within he graph will be deleted.
421	// Additionally, the "prune tip", or the last block which has been used to
422	// prune the graph is stored so callers can ensure the graph is fully in sync
423	// with the current UTXO state. A slice of channels that have been closed by
424	// the target block are returned if the function succeeds without error.
425	func (c ChannelGraph) PruneGraph(spentOutputs []wire.OutPoint,
426	blockHash *chainhash.Hash, blockHeight uint32) (
427	[]*models.ChannelEdgeInfo, error) {	3✔
428		3✔
429	edges, nodes, err := c.V1Store.PruneGraph(	3✔
430	spentOutputs, blockHash, blockHeight,	3✔
431	)	3✔
432	if err != nil {	3✔
433	return nil, err	×
434	}	×
435
436	if c.graphCache != nil {	6✔
437	for _, edge := range edges {	6✔
438	c.graphCache.RemoveChannel(	3✔
439	edge.NodeKey1Bytes, edge.NodeKey2Bytes,	3✔
440	edge.ChannelID,	3✔
441	)	3✔
442	}	3✔
443
444	for _, node := range nodes {	6✔
445	c.graphCache.RemoveNode(node)	3✔
446	}	3✔
447
448	log.Debugf("Pruned graph, cache now has %s",	3✔
449	c.graphCache.Stats())	3✔
450	}
451
452	if len(edges) != 0 {	6✔
453	// Notify all currently registered clients of the newly closed	3✔
454	// channels.	3✔
455	closeSummaries := createCloseSummaries(	3✔
456	blockHeight, edges...,	3✔
457	)	3✔
458		3✔
459	select {	3✔
460	case c.topologyUpdate <- closeSummaries:	3✔
461	case <-c.quit:	×
462	return nil, ErrChanGraphShuttingDown	×
463	}
464	}
465
466	return edges, nil	3✔
467	}
468
469	// PruneGraphNodes is a garbage collection method which attempts to prune out
470	// any nodes from the channel graph that are currently unconnected. This ensure
471	// that we only maintain a graph of reachable nodes. In the event that a pruned
472	// node gains more channels, it will be re-added back to the graph.
473	func (c *ChannelGraph) PruneGraphNodes() error {	3✔
474	nodes, err := c.V1Store.PruneGraphNodes()	3✔
475	if err != nil {	3✔
476	return err	×
477	}	×
478
479	if c.graphCache != nil {	6✔
480	for _, node := range nodes {	3✔
481	c.graphCache.RemoveNode(node)	×
482	}	×
483	}
484
485	return nil	3✔
486	}
487
488	// FilterKnownChanIDs takes a set of channel IDs and return the subset of chan
489	// ID's that we don't know and are not known zombies of the passed set. In other
490	// words, we perform a set difference of our set of chan ID's and the ones
491	// passed in. This method can be used by callers to determine the set of
492	// channels another peer knows of that we don't.
493	func (c *ChannelGraph) FilterKnownChanIDs(chansInfo []ChannelUpdateInfo,
494	isZombieChan func(time.Time, time.Time) bool) ([]uint64, error) {	3✔
495		3✔
496	unknown, knownZombies, err := c.V1Store.FilterKnownChanIDs(chansInfo)	3✔
497	if err != nil {	3✔
498	return nil, err	×
499	}	×
500
501	for _, info := range knownZombies {	3✔
502	// TODO(ziggie): Make sure that for the strict pruning case we	×
503	// compare the pubkeys and whether the right timestamp is not	×
504	// older than the `ChannelPruneExpiry`.	×
505	//	×
506	// NOTE: The timestamp data has no verification attached to it	×
507	// in the `ReplyChannelRange` msg so we are trusting this data	×
508	// at this point. However it is not critical because we are just	×
509	// removing the channel from the db when the timestamps are more	×
510	// recent. During the querying of the gossip msg verification	×
511	// happens as usual. However we should start punishing peers	×
512	// when they don't provide us honest data ?	×
513	isStillZombie := isZombieChan(	×
514	info.Node1UpdateTimestamp, info.Node2UpdateTimestamp,	×
515	)	×
516		×
517	if isStillZombie {	×
518	continue	×
519	}
520
521	// If we have marked it as a zombie but the latest update
522	// timestamps could bring it back from the dead, then we mark it
523	// alive, and we let it be added to the set of IDs to query our
524	// peer for.
525	err := c.V1Store.MarkEdgeLive(	×
526	info.ShortChannelID.ToUint64(),	×
527	)	×
528	// Since there is a chance that the edge could have been marked	×
529	// as "live" between the FilterKnownChanIDs call and the	×
530	// MarkEdgeLive call, we ignore the error if the edge is already	×
531	// marked as live.	×
532	if err != nil && !errors.Is(err, ErrZombieEdgeNotFound) {	×
533	return nil, err	×
534	}	×
535	}
536
537	return unknown, nil	3✔
538	}
539
540	// MarkEdgeZombie attempts to mark a channel identified by its channel ID as a
541	// zombie. This method is used on an ad-hoc basis, when channels need to be
542	// marked as zombies outside the normal pruning cycle.
543	func (c *ChannelGraph) MarkEdgeZombie(chanID uint64,
544	pubKey1, pubKey2 [33]byte) error {	×
545		×
546	err := c.V1Store.MarkEdgeZombie(chanID, pubKey1, pubKey2)	×
547	if err != nil {	×
548	return err	×
549	}	×
550
551	if c.graphCache != nil {	×
552	c.graphCache.RemoveChannel(pubKey1, pubKey2, chanID)	×
553	}	×
554
555	return nil	×
556	}
557
558	// UpdateEdgePolicy updates the edge routing policy for a single directed edge
559	// within the database for the referenced channel. The `flags` attribute within
560	// the ChannelEdgePolicy determines which of the directed edges are being
561	// updated. If the flag is 1, then the first node's information is being
562	// updated, otherwise it's the second node's information. The node ordering is
563	// determined by the lexicographical ordering of the identity public keys of the
564	// nodes on either side of the channel.
565	func (c ChannelGraph) UpdateEdgePolicy(edge models.ChannelEdgePolicy,
566	op ...batch.SchedulerOption) error {	3✔
567		3✔
568	from, to, err := c.V1Store.UpdateEdgePolicy(edge, op...)	3✔
569	if err != nil {	3✔
570	return err	×
571	}	×
572
573	if c.graphCache != nil {	6✔
574	c.graphCache.UpdatePolicy(	3✔
575	models.NewCachedPolicy(edge), from, to,	3✔
576	)	3✔
577	}	3✔
578
579	select {	3✔
580	case c.topologyUpdate <- edge:	3✔
581	case <-c.quit:	×
582	return ErrChanGraphShuttingDown	×
583	}
584
585	return nil	3✔
586	}
587
588	// MakeTestGraphNew creates a new instance of the ChannelGraph for testing
589	// purposes. The backing V1Store implementation depends on the version of
590	// NewTestDB included in the current build.
591	//
592	// NOTE: this is currently unused, but is left here for future use to show how
593	// NewTestDB can be used. As the SQL implementation of the V1Store is
594	// implemented, unit tests will be switched to use this function instead of
595	// the existing MakeTestGraph helper. Once only this function is used, the
596	// existing MakeTestGraph function will be removed and this one will be renamed.
597	func MakeTestGraphNew(t testing.TB,
598	opts ...ChanGraphOption) *ChannelGraph {	×
599		×
600	t.Helper()	×
601		×
602	store := NewTestDB(t)	×
603		×
604	graph, err := NewChannelGraph(store, opts...)	×
605	require.NoError(t, err)	×
606	require.NoError(t, graph.Start())	×
607		×
608	t.Cleanup(func() {	×
609	require.NoError(t, graph.Stop())	×
610	})	×
611
612	return graph	×
613	}

lightningnetwork / lnd / 15714380358

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

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