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

lightningnetwork / lnd / 12430766295

20 Dec 2024 11:38AM UTC coverage: 52.607% (-6.1%) from 58.716%
12430766295

Pull #9384

github

ziggie1984
funding: refactor gossip msg code

We almost never need to create all messages at the same time
(ChanUpdate,ChanAnnouncement,Proof) so we split it up into own
functions.
Pull Request #9384: Refactor gossip msg code

224 of 279 new or added lines in 7 files covered. (80.29%)

27070 existing lines in 437 files now uncovered.

53540 of 101773 relevant lines covered (52.61%)

4.11 hits per line

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

96.77
/log.go
1
package lnd
2

3
import (
4
        "github.com/btcsuite/btcd/connmgr"
5
        "github.com/btcsuite/btcd/rpcclient"
6
        btclogv1 "github.com/btcsuite/btclog"
7
        "github.com/btcsuite/btclog/v2"
8
        "github.com/lightninglabs/neutrino"
9
        sphinx "github.com/lightningnetwork/lightning-onion"
10
        "github.com/lightningnetwork/lnd/autopilot"
11
        "github.com/lightningnetwork/lnd/build"
12
        "github.com/lightningnetwork/lnd/chainntnfs"
13
        "github.com/lightningnetwork/lnd/chainreg"
14
        "github.com/lightningnetwork/lnd/chanacceptor"
15
        "github.com/lightningnetwork/lnd/chanbackup"
16
        "github.com/lightningnetwork/lnd/chanfitness"
17
        "github.com/lightningnetwork/lnd/channeldb"
18
        "github.com/lightningnetwork/lnd/channelnotifier"
19
        "github.com/lightningnetwork/lnd/cluster"
20
        "github.com/lightningnetwork/lnd/contractcourt"
21
        "github.com/lightningnetwork/lnd/discovery"
22
        "github.com/lightningnetwork/lnd/funding"
23
        "github.com/lightningnetwork/lnd/graph"
24
        graphdb "github.com/lightningnetwork/lnd/graph/db"
25
        "github.com/lightningnetwork/lnd/healthcheck"
26
        "github.com/lightningnetwork/lnd/htlcswitch"
27
        "github.com/lightningnetwork/lnd/invoices"
28
        "github.com/lightningnetwork/lnd/kvdb/sqlbase"
29
        "github.com/lightningnetwork/lnd/lncfg"
30
        "github.com/lightningnetwork/lnd/lnrpc/autopilotrpc"
31
        "github.com/lightningnetwork/lnd/lnrpc/chainrpc"
32
        "github.com/lightningnetwork/lnd/lnrpc/devrpc"
33
        "github.com/lightningnetwork/lnd/lnrpc/invoicesrpc"
34
        "github.com/lightningnetwork/lnd/lnrpc/neutrinorpc"
35
        "github.com/lightningnetwork/lnd/lnrpc/peersrpc"
36
        "github.com/lightningnetwork/lnd/lnrpc/routerrpc"
37
        "github.com/lightningnetwork/lnd/lnrpc/signrpc"
38
        "github.com/lightningnetwork/lnd/lnrpc/verrpc"
39
        "github.com/lightningnetwork/lnd/lnrpc/walletrpc"
40
        "github.com/lightningnetwork/lnd/lnwallet"
41
        "github.com/lightningnetwork/lnd/lnwallet/btcwallet"
42
        "github.com/lightningnetwork/lnd/lnwallet/chancloser"
43
        "github.com/lightningnetwork/lnd/lnwallet/chanfunding"
44
        "github.com/lightningnetwork/lnd/lnwallet/rpcwallet"
45
        "github.com/lightningnetwork/lnd/monitoring"
46
        "github.com/lightningnetwork/lnd/netann"
47
        "github.com/lightningnetwork/lnd/peer"
48
        "github.com/lightningnetwork/lnd/peernotifier"
49
        "github.com/lightningnetwork/lnd/routing"
50
        "github.com/lightningnetwork/lnd/routing/blindedpath"
51
        "github.com/lightningnetwork/lnd/routing/localchans"
52
        "github.com/lightningnetwork/lnd/rpcperms"
53
        "github.com/lightningnetwork/lnd/signal"
54
        "github.com/lightningnetwork/lnd/sweep"
55
        "github.com/lightningnetwork/lnd/tor"
56
        "github.com/lightningnetwork/lnd/watchtower"
57
        "github.com/lightningnetwork/lnd/watchtower/wtclient"
58
)
59

60
// replaceableLogger is a thin wrapper around a logger that is used so the
61
// logger can be replaced easily without some black pointer magic.
62
type replaceableLogger struct {
63
        btclog.Logger
64
        subsystem string
65
}
66

67
// Loggers can not be used before the log rotator has been initialized with a
68
// log file. This must be performed early during application startup by
69
// calling InitLogRotator() on the main log writer instance in the config.
70
var (
71
        // lndPkgLoggers is a list of all lnd package level loggers that are
72
        // registered. They are tracked here so they can be replaced once the
73
        // SetupLoggers function is called with the final root logger.
74
        lndPkgLoggers []*replaceableLogger
75

76
        // addLndPkgLogger is a helper function that creates a new replaceable
77
        // main lnd package level logger and adds it to the list of loggers that
78
        // are replaced again later, once the final root logger is ready.
79
        addLndPkgLogger = func(subsystem string) *replaceableLogger {
80
                l := &replaceableLogger{
4✔
81
                        Logger:    build.NewSubLogger(subsystem, nil),
4✔
82
                        subsystem: subsystem,
4✔
83
                }
4✔
84
                lndPkgLoggers = append(lndPkgLoggers, l)
4✔
85
                return l
4✔
86
        }
4✔
87

4✔
88
        // Loggers that need to be accessible from the lnd package can be placed
89
        // here. Loggers that are only used in sub modules can be added directly
90
        // by using the addSubLogger method. We declare all loggers so we never
91
        // run into a nil reference if they are used early. But the SetupLoggers
92
        // function should always be called as soon as possible to finish
93
        // setting them up properly with a root logger.
94
        ltndLog = addLndPkgLogger("LTND")
95
        rpcsLog = addLndPkgLogger("RPCS")
96
        srvrLog = addLndPkgLogger("SRVR")
97
        atplLog = addLndPkgLogger("ATPL")
98
)
99

100
// genSubLogger creates a logger for a subsystem. We provide an instance of
101
// a signal.Interceptor to be able to shutdown in the case of a critical error.
102
func genSubLogger(root *build.SubLoggerManager,
103
        interceptor signal.Interceptor) func(string) btclog.Logger {
104

4✔
105
        // Create a shutdown function which will request shutdown from our
4✔
106
        // interceptor if it is listening.
4✔
107
        shutdown := func() {
4✔
108
                if !interceptor.Listening() {
4✔
UNCOV
109
                        return
×
110
                }
×
111

×
112
                interceptor.RequestShutdown()
UNCOV
113
        }
×
114

115
        // Return a function which will create a sublogger from our root
116
        // logger without shutdown fn.
117
        return func(tag string) btclog.Logger {
118
                return root.GenSubLogger(tag, shutdown)
8✔
119
        }
4✔
120
}
4✔
121

122
// SetupLoggers initializes all package-global logger variables.
123
//
124
//nolint:ll
125
func SetupLoggers(root *build.SubLoggerManager, interceptor signal.Interceptor) {
126
        genLogger := genSubLogger(root, interceptor)
4✔
127

4✔
128
        // Now that we have the proper root logger, we can replace the
4✔
129
        // placeholder lnd package loggers.
4✔
130
        for _, l := range lndPkgLoggers {
4✔
131
                l.Logger = build.NewSubLogger(l.subsystem, genLogger)
8✔
132
                SetSubLogger(root, l.subsystem, l.Logger)
4✔
133
        }
4✔
134

4✔
135
        // Initialize loggers from packages outside of `lnd` first. The
136
        // packages below will overwrite the names of the loggers they import.
137
        // For instance, the logger in `neutrino.query` is overwritten by
138
        // `btcwallet.chain`, which is overwritten by `lnwallet`. To ensure the
139
        // overwriting works, we need to initialize the loggers here so they
140
        // can be overwritten later.
141
        AddV1SubLogger(root, "BTCN", interceptor, neutrino.UseLogger)
142
        AddV1SubLogger(root, "CMGR", interceptor, connmgr.UseLogger)
4✔
143
        AddV1SubLogger(root, "RPCC", interceptor, rpcclient.UseLogger)
4✔
144

4✔
145
        // Some of the loggers declared in the main lnd package are also used
4✔
146
        // in sub packages.
4✔
147
        signal.UseLogger(ltndLog)
4✔
148
        autopilot.UseLogger(atplLog)
4✔
149

4✔
150
        AddSubLogger(root, "LNWL", interceptor, lnwallet.UseLogger)
4✔
151
        AddSubLogger(root, "DISC", interceptor, discovery.UseLogger)
4✔
152
        AddSubLogger(root, "NTFN", interceptor, chainntnfs.UseLogger)
4✔
153
        AddSubLogger(root, "CHDB", interceptor, channeldb.UseLogger)
4✔
154
        AddSubLogger(root, "SQLB", interceptor, sqlbase.UseLogger)
4✔
155
        AddSubLogger(root, "HSWC", interceptor, htlcswitch.UseLogger)
4✔
156
        AddSubLogger(root, "CNCT", interceptor, contractcourt.UseLogger)
4✔
157
        AddSubLogger(root, "UTXN", interceptor, contractcourt.UseNurseryLogger)
4✔
158
        AddSubLogger(root, "BRAR", interceptor, contractcourt.UseBreachLogger)
4✔
159
        AddV1SubLogger(root, "SPHX", interceptor, sphinx.UseLogger)
4✔
160
        AddSubLogger(root, "SWPR", interceptor, sweep.UseLogger)
4✔
161
        AddSubLogger(root, "SGNR", interceptor, signrpc.UseLogger)
4✔
162
        AddSubLogger(root, "WLKT", interceptor, walletrpc.UseLogger)
4✔
163
        AddSubLogger(root, "ARPC", interceptor, autopilotrpc.UseLogger)
4✔
164
        AddSubLogger(root, "NRPC", interceptor, neutrinorpc.UseLogger)
4✔
165
        AddSubLogger(root, "DRPC", interceptor, devrpc.UseLogger)
4✔
166
        AddSubLogger(root, "INVC", interceptor, invoices.UseLogger)
4✔
167
        AddSubLogger(root, "NANN", interceptor, netann.UseLogger)
4✔
168
        AddSubLogger(root, "WTWR", interceptor, watchtower.UseLogger)
4✔
169
        AddSubLogger(root, "NTFR", interceptor, chainrpc.UseLogger)
4✔
170
        AddSubLogger(root, "IRPC", interceptor, invoicesrpc.UseLogger)
4✔
171
        AddSubLogger(root, "CHNF", interceptor, channelnotifier.UseLogger)
4✔
172
        AddSubLogger(root, "CHBU", interceptor, chanbackup.UseLogger)
4✔
173
        AddSubLogger(root, "PROM", interceptor, monitoring.UseLogger)
4✔
174
        AddSubLogger(root, "WTCL", interceptor, wtclient.UseLogger)
4✔
175
        AddSubLogger(root, "PRNF", interceptor, peernotifier.UseLogger)
4✔
176
        AddSubLogger(root, "CHFD", interceptor, chanfunding.UseLogger)
4✔
177
        AddSubLogger(root, "PEER", interceptor, peer.UseLogger)
4✔
178
        AddSubLogger(root, "CHCL", interceptor, chancloser.UseLogger)
4✔
179
        AddSubLogger(root, "LCHN", interceptor, localchans.UseLogger)
4✔
180

4✔
181
        AddSubLogger(root, routing.Subsystem, interceptor, routing.UseLogger)
4✔
182
        AddSubLogger(root, routerrpc.Subsystem, interceptor, routerrpc.UseLogger)
4✔
183
        AddSubLogger(root, chanfitness.Subsystem, interceptor, chanfitness.UseLogger)
4✔
184
        AddSubLogger(root, verrpc.Subsystem, interceptor, verrpc.UseLogger)
4✔
185
        AddSubLogger(root, healthcheck.Subsystem, interceptor, healthcheck.UseLogger)
4✔
186
        AddSubLogger(root, chainreg.Subsystem, interceptor, chainreg.UseLogger)
4✔
187
        AddSubLogger(root, chanacceptor.Subsystem, interceptor, chanacceptor.UseLogger)
4✔
188
        AddSubLogger(root, funding.Subsystem, interceptor, funding.UseLogger)
4✔
189
        AddSubLogger(root, cluster.Subsystem, interceptor, cluster.UseLogger)
4✔
190
        AddSubLogger(root, rpcperms.Subsystem, interceptor, rpcperms.UseLogger)
4✔
191
        AddSubLogger(root, tor.Subsystem, interceptor, tor.UseLogger)
4✔
192
        AddSubLogger(root, btcwallet.Subsystem, interceptor, btcwallet.UseLogger)
4✔
193
        AddSubLogger(root, rpcwallet.Subsystem, interceptor, rpcwallet.UseLogger)
4✔
194
        AddSubLogger(root, peersrpc.Subsystem, interceptor, peersrpc.UseLogger)
4✔
195
        AddSubLogger(root, graph.Subsystem, interceptor, graph.UseLogger)
4✔
196
        AddSubLogger(root, lncfg.Subsystem, interceptor, lncfg.UseLogger)
4✔
197
        AddSubLogger(
4✔
198
                root, blindedpath.Subsystem, interceptor, blindedpath.UseLogger,
4✔
199
        )
4✔
200
        AddV1SubLogger(root, graphdb.Subsystem, interceptor, graphdb.UseLogger)
4✔
201
}
4✔
202

4✔
203
// AddSubLogger is a helper method to conveniently create and register the
204
// logger of one or more sub systems.
205
func AddSubLogger(root *build.SubLoggerManager, subsystem string,
206
        interceptor signal.Interceptor, useLoggers ...func(btclog.Logger)) {
207

208
        // genSubLogger will return a callback for creating a logger instance,
4✔
209
        // which we will give to the root logger.
4✔
210
        genLogger := genSubLogger(root, interceptor)
4✔
211

4✔
212
        // Create and register just a single logger to prevent them from
4✔
213
        // overwriting each other internally.
4✔
214
        logger := build.NewSubLogger(subsystem, genLogger)
4✔
215
        SetSubLogger(root, subsystem, logger, useLoggers...)
4✔
216
}
4✔
217

4✔
218
// SetSubLogger is a helper method to conveniently register the logger of a
4✔
219
// sub system.
220
func SetSubLogger(root *build.SubLoggerManager, subsystem string,
221
        logger btclog.Logger, useLoggers ...func(btclog.Logger)) {
222

223
        root.RegisterSubLogger(subsystem, logger)
4✔
224
        for _, useLogger := range useLoggers {
4✔
225
                useLogger(logger)
4✔
226
        }
8✔
227
}
4✔
228

4✔
229
// AddV1SubLogger is a helper method to conveniently create and register the
230
// logger of one or more sub systems.
231
func AddV1SubLogger(root *build.SubLoggerManager, subsystem string,
232
        interceptor signal.Interceptor, useLoggers ...func(btclogv1.Logger)) {
233

234
        // genSubLogger will return a callback for creating a logger instance,
4✔
235
        // which we will give to the root logger.
4✔
236
        genLogger := genSubLogger(root, interceptor)
4✔
237

4✔
238
        // Create and register just a single logger to prevent them from
4✔
239
        // overwriting each other internally.
4✔
240
        logger := build.NewSubLogger(subsystem, genLogger)
4✔
241
        SetV1SubLogger(root, subsystem, logger, useLoggers...)
4✔
242
}
4✔
243

4✔
244
// SetV1SubLogger is a helper method to conveniently register the logger of a
4✔
245
// sub system. Note that the btclog v2 logger implements the btclog v1 logger
246
// which is why we can pass the v2 logger to the UseLogger call-backs that
247
// expect the v1 logger.
248
func SetV1SubLogger(root *build.SubLoggerManager, subsystem string,
249
        logger btclog.Logger, useLoggers ...func(btclogv1.Logger)) {
250

251
        root.RegisterSubLogger(subsystem, logger)
4✔
252
        for _, useLogger := range useLoggers {
4✔
253
                useLogger(logger)
4✔
254
        }
8✔
255
}
4✔
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