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

lightningnetwork / lnd / 11909028775

19 Nov 2024 08:27AM UTC coverage: 58.987% (+0.04%) from 58.947%
11909028775

Pull #9258

github

yyforyongyu
chainntnfs: skip duplicate `numConfsLeft` notifications

This commit adds a new state to the `ConfNtfn` struct to start tracking
the number of confs left to be notified to avoid sending duplicate
notifications.
Pull Request #9258: chainntnfs: fix missing notifications

59 of 72 new or added lines in 5 files covered. (81.94%)

176 existing lines in 31 files now uncovered.

132559 of 224725 relevant lines covered (58.99%)

19680.56 hits per line

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

96.67
/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
        "github.com/lightningnetwork/lnd/healthcheck"
25
        "github.com/lightningnetwork/lnd/htlcswitch"
26
        "github.com/lightningnetwork/lnd/invoices"
27
        "github.com/lightningnetwork/lnd/lncfg"
28
        "github.com/lightningnetwork/lnd/lnrpc/autopilotrpc"
29
        "github.com/lightningnetwork/lnd/lnrpc/chainrpc"
30
        "github.com/lightningnetwork/lnd/lnrpc/devrpc"
31
        "github.com/lightningnetwork/lnd/lnrpc/invoicesrpc"
32
        "github.com/lightningnetwork/lnd/lnrpc/neutrinorpc"
33
        "github.com/lightningnetwork/lnd/lnrpc/peersrpc"
34
        "github.com/lightningnetwork/lnd/lnrpc/routerrpc"
35
        "github.com/lightningnetwork/lnd/lnrpc/signrpc"
36
        "github.com/lightningnetwork/lnd/lnrpc/verrpc"
37
        "github.com/lightningnetwork/lnd/lnrpc/walletrpc"
38
        "github.com/lightningnetwork/lnd/lnwallet"
39
        "github.com/lightningnetwork/lnd/lnwallet/btcwallet"
40
        "github.com/lightningnetwork/lnd/lnwallet/chancloser"
41
        "github.com/lightningnetwork/lnd/lnwallet/chanfunding"
42
        "github.com/lightningnetwork/lnd/lnwallet/rpcwallet"
43
        "github.com/lightningnetwork/lnd/monitoring"
44
        "github.com/lightningnetwork/lnd/netann"
45
        "github.com/lightningnetwork/lnd/peer"
46
        "github.com/lightningnetwork/lnd/peernotifier"
47
        "github.com/lightningnetwork/lnd/routing"
48
        "github.com/lightningnetwork/lnd/routing/blindedpath"
49
        "github.com/lightningnetwork/lnd/rpcperms"
50
        "github.com/lightningnetwork/lnd/signal"
51
        "github.com/lightningnetwork/lnd/sweep"
52
        "github.com/lightningnetwork/lnd/tor"
53
        "github.com/lightningnetwork/lnd/watchtower"
54
        "github.com/lightningnetwork/lnd/watchtower/wtclient"
55
)
56

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

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

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

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

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

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

UNCOV
109
                interceptor.RequestShutdown()
×
110
        }
111

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

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

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

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

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

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

4✔
176
        AddSubLogger(root, routing.Subsystem, interceptor, routing.UseLogger)
4✔
177
        AddSubLogger(root, routerrpc.Subsystem, interceptor, routerrpc.UseLogger)
4✔
178
        AddSubLogger(root, chanfitness.Subsystem, interceptor, chanfitness.UseLogger)
4✔
179
        AddSubLogger(root, verrpc.Subsystem, interceptor, verrpc.UseLogger)
4✔
180
        AddSubLogger(root, healthcheck.Subsystem, interceptor, healthcheck.UseLogger)
4✔
181
        AddSubLogger(root, chainreg.Subsystem, interceptor, chainreg.UseLogger)
4✔
182
        AddSubLogger(root, chanacceptor.Subsystem, interceptor, chanacceptor.UseLogger)
4✔
183
        AddSubLogger(root, funding.Subsystem, interceptor, funding.UseLogger)
4✔
184
        AddSubLogger(root, cluster.Subsystem, interceptor, cluster.UseLogger)
4✔
185
        AddSubLogger(root, rpcperms.Subsystem, interceptor, rpcperms.UseLogger)
4✔
186
        AddSubLogger(root, tor.Subsystem, interceptor, tor.UseLogger)
4✔
187
        AddSubLogger(root, btcwallet.Subsystem, interceptor, btcwallet.UseLogger)
4✔
188
        AddSubLogger(root, rpcwallet.Subsystem, interceptor, rpcwallet.UseLogger)
4✔
189
        AddSubLogger(root, peersrpc.Subsystem, interceptor, peersrpc.UseLogger)
4✔
190
        AddSubLogger(root, graph.Subsystem, interceptor, graph.UseLogger)
4✔
191
        AddSubLogger(root, lncfg.Subsystem, interceptor, lncfg.UseLogger)
4✔
192
        AddSubLogger(
4✔
193
                root, blindedpath.Subsystem, interceptor, blindedpath.UseLogger,
4✔
194
        )
4✔
195
}
196

197
// AddSubLogger is a helper method to conveniently create and register the
198
// logger of one or more sub systems.
199
func AddSubLogger(root *build.SubLoggerManager, subsystem string,
200
        interceptor signal.Interceptor, useLoggers ...func(btclog.Logger)) {
4✔
201

4✔
202
        // genSubLogger will return a callback for creating a logger instance,
4✔
203
        // which we will give to the root logger.
4✔
204
        genLogger := genSubLogger(root, interceptor)
4✔
205

4✔
206
        // Create and register just a single logger to prevent them from
4✔
207
        // overwriting each other internally.
4✔
208
        logger := build.NewSubLogger(subsystem, genLogger)
4✔
209
        SetSubLogger(root, subsystem, logger, useLoggers...)
4✔
210
}
4✔
211

212
// SetSubLogger is a helper method to conveniently register the logger of a
213
// sub system.
214
func SetSubLogger(root *build.SubLoggerManager, subsystem string,
215
        logger btclog.Logger, useLoggers ...func(btclog.Logger)) {
4✔
216

4✔
217
        root.RegisterSubLogger(subsystem, logger)
4✔
218
        for _, useLogger := range useLoggers {
8✔
219
                useLogger(logger)
4✔
220
        }
4✔
221
}
222

223
// AddV1SubLogger is a helper method to conveniently create and register the
224
// logger of one or more sub systems.
225
func AddV1SubLogger(root *build.SubLoggerManager, subsystem string,
226
        interceptor signal.Interceptor, useLoggers ...func(btclogv1.Logger)) {
4✔
227

4✔
228
        // genSubLogger will return a callback for creating a logger instance,
4✔
229
        // which we will give to the root logger.
4✔
230
        genLogger := genSubLogger(root, interceptor)
4✔
231

4✔
232
        // Create and register just a single logger to prevent them from
4✔
233
        // overwriting each other internally.
4✔
234
        logger := build.NewSubLogger(subsystem, genLogger)
4✔
235
        SetV1SubLogger(root, subsystem, logger, useLoggers...)
4✔
236
}
4✔
237

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

4✔
245
        root.RegisterSubLogger(subsystem, logger)
4✔
246
        for _, useLogger := range useLoggers {
8✔
247
                useLogger(logger)
4✔
248
        }
4✔
249
}
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