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

lightningnetwork / lnd / 14977937992

12 May 2025 04:50PM UTC coverage: 58.596% (+0.04%) from 58.559%
14977937992

Pull #9677

github

web-flow
Merge 882e0ce18 into 1db6c31e2
Pull Request #9677: Expose confirmation count for pending 'channel open' transactions

142 of 178 new or added lines in 5 files covered. (79.78%)

35 existing lines in 6 files now uncovered.

97502 of 166397 relevant lines covered (58.6%)

1.82 hits per line

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

63.96
/server.go
1
package lnd
2

3
import (
4
        "bytes"
5
        "context"
6
        "crypto/rand"
7
        "encoding/hex"
8
        "fmt"
9
        "math/big"
10
        prand "math/rand"
11
        "net"
12
        "strconv"
13
        "strings"
14
        "sync"
15
        "sync/atomic"
16
        "time"
17

18
        "github.com/btcsuite/btcd/btcec/v2"
19
        "github.com/btcsuite/btcd/btcec/v2/ecdsa"
20
        "github.com/btcsuite/btcd/btcutil"
21
        "github.com/btcsuite/btcd/chaincfg"
22
        "github.com/btcsuite/btcd/chaincfg/chainhash"
23
        "github.com/btcsuite/btcd/connmgr"
24
        "github.com/btcsuite/btcd/txscript"
25
        "github.com/btcsuite/btcd/wire"
26
        "github.com/go-errors/errors"
27
        sphinx "github.com/lightningnetwork/lightning-onion"
28
        "github.com/lightningnetwork/lnd/aliasmgr"
29
        "github.com/lightningnetwork/lnd/autopilot"
30
        "github.com/lightningnetwork/lnd/brontide"
31
        "github.com/lightningnetwork/lnd/chainio"
32
        "github.com/lightningnetwork/lnd/chainreg"
33
        "github.com/lightningnetwork/lnd/chanacceptor"
34
        "github.com/lightningnetwork/lnd/chanbackup"
35
        "github.com/lightningnetwork/lnd/chanfitness"
36
        "github.com/lightningnetwork/lnd/channeldb"
37
        "github.com/lightningnetwork/lnd/channelnotifier"
38
        "github.com/lightningnetwork/lnd/clock"
39
        "github.com/lightningnetwork/lnd/cluster"
40
        "github.com/lightningnetwork/lnd/contractcourt"
41
        "github.com/lightningnetwork/lnd/discovery"
42
        "github.com/lightningnetwork/lnd/feature"
43
        "github.com/lightningnetwork/lnd/fn/v2"
44
        "github.com/lightningnetwork/lnd/funding"
45
        "github.com/lightningnetwork/lnd/graph"
46
        graphdb "github.com/lightningnetwork/lnd/graph/db"
47
        "github.com/lightningnetwork/lnd/graph/db/models"
48
        "github.com/lightningnetwork/lnd/healthcheck"
49
        "github.com/lightningnetwork/lnd/htlcswitch"
50
        "github.com/lightningnetwork/lnd/htlcswitch/hop"
51
        "github.com/lightningnetwork/lnd/input"
52
        "github.com/lightningnetwork/lnd/invoices"
53
        "github.com/lightningnetwork/lnd/keychain"
54
        "github.com/lightningnetwork/lnd/kvdb"
55
        "github.com/lightningnetwork/lnd/lncfg"
56
        "github.com/lightningnetwork/lnd/lnencrypt"
57
        "github.com/lightningnetwork/lnd/lnpeer"
58
        "github.com/lightningnetwork/lnd/lnrpc"
59
        "github.com/lightningnetwork/lnd/lnrpc/routerrpc"
60
        "github.com/lightningnetwork/lnd/lnwallet"
61
        "github.com/lightningnetwork/lnd/lnwallet/chainfee"
62
        "github.com/lightningnetwork/lnd/lnwallet/chanfunding"
63
        "github.com/lightningnetwork/lnd/lnwallet/rpcwallet"
64
        "github.com/lightningnetwork/lnd/lnwire"
65
        "github.com/lightningnetwork/lnd/nat"
66
        "github.com/lightningnetwork/lnd/netann"
67
        "github.com/lightningnetwork/lnd/peer"
68
        "github.com/lightningnetwork/lnd/peernotifier"
69
        "github.com/lightningnetwork/lnd/pool"
70
        "github.com/lightningnetwork/lnd/queue"
71
        "github.com/lightningnetwork/lnd/routing"
72
        "github.com/lightningnetwork/lnd/routing/localchans"
73
        "github.com/lightningnetwork/lnd/routing/route"
74
        "github.com/lightningnetwork/lnd/subscribe"
75
        "github.com/lightningnetwork/lnd/sweep"
76
        "github.com/lightningnetwork/lnd/ticker"
77
        "github.com/lightningnetwork/lnd/tor"
78
        "github.com/lightningnetwork/lnd/walletunlocker"
79
        "github.com/lightningnetwork/lnd/watchtower/blob"
80
        "github.com/lightningnetwork/lnd/watchtower/wtclient"
81
        "github.com/lightningnetwork/lnd/watchtower/wtpolicy"
82
        "github.com/lightningnetwork/lnd/watchtower/wtserver"
83
)
84

85
const (
86
        // defaultMinPeers is the minimum number of peers nodes should always be
87
        // connected to.
88
        defaultMinPeers = 3
89

90
        // defaultStableConnDuration is a floor under which all reconnection
91
        // attempts will apply exponential randomized backoff. Connections
92
        // durations exceeding this value will be eligible to have their
93
        // backoffs reduced.
94
        defaultStableConnDuration = 10 * time.Minute
95

96
        // numInstantInitReconnect specifies how many persistent peers we should
97
        // always attempt outbound connections to immediately. After this value
98
        // is surpassed, the remaining peers will be randomly delayed using
99
        // maxInitReconnectDelay.
100
        numInstantInitReconnect = 10
101

102
        // maxInitReconnectDelay specifies the maximum delay in seconds we will
103
        // apply in attempting to reconnect to persistent peers on startup. The
104
        // value used or a particular peer will be chosen between 0s and this
105
        // value.
106
        maxInitReconnectDelay = 30
107

108
        // multiAddrConnectionStagger is the number of seconds to wait between
109
        // attempting to a peer with each of its advertised addresses.
110
        multiAddrConnectionStagger = 10 * time.Second
111
)
112

113
var (
114
        // ErrPeerNotConnected signals that the server has no connection to the
115
        // given peer.
116
        ErrPeerNotConnected = errors.New("peer is not connected")
117

118
        // ErrServerNotActive indicates that the server has started but hasn't
119
        // fully finished the startup process.
120
        ErrServerNotActive = errors.New("server is still in the process of " +
121
                "starting")
122

123
        // ErrServerShuttingDown indicates that the server is in the process of
124
        // gracefully exiting.
125
        ErrServerShuttingDown = errors.New("server is shutting down")
126

127
        // MaxFundingAmount is a soft-limit of the maximum channel size
128
        // currently accepted within the Lightning Protocol. This is
129
        // defined in BOLT-0002, and serves as an initial precautionary limit
130
        // while implementations are battle tested in the real world.
131
        //
132
        // At the moment, this value depends on which chain is active. It is set
133
        // to the value under the Bitcoin chain as default.
134
        //
135
        // TODO(roasbeef): add command line param to modify.
136
        MaxFundingAmount = funding.MaxBtcFundingAmount
137

138
        // EndorsementExperimentEnd is the time after which nodes should stop
139
        // propagating experimental endorsement signals.
140
        //
141
        // Per blip04: January 1, 2026 12:00:00 AM UTC in unix seconds.
142
        EndorsementExperimentEnd = time.Unix(1767225600, 0)
143

144
        // ErrGossiperBan is one of the errors that can be returned when we
145
        // attempt to finalize a connection to a remote peer.
146
        ErrGossiperBan = errors.New("gossiper has banned remote's key")
147

148
        // ErrNoMoreRestrictedAccessSlots is one of the errors that can be
149
        // returned when we attempt to finalize a connection. It means that
150
        // this peer has no pending-open, open, or closed channels with us and
151
        // are already at our connection ceiling for a peer with this access
152
        // status.
153
        ErrNoMoreRestrictedAccessSlots = errors.New("no more restricted slots")
154

155
        // ErrNoPeerScore is returned when we expect to find a score in
156
        // peerScores, but one does not exist.
157
        ErrNoPeerScore = errors.New("peer score not found")
158

159
        // ErrNoPendingPeerInfo is returned when we couldn't find any pending
160
        // peer info.
161
        ErrNoPendingPeerInfo = errors.New("no pending peer info")
162
)
163

164
// errPeerAlreadyConnected is an error returned by the server when we're
165
// commanded to connect to a peer, but they're already connected.
166
type errPeerAlreadyConnected struct {
167
        peer *peer.Brontide
168
}
169

170
// Error returns the human readable version of this error type.
171
//
172
// NOTE: Part of the error interface.
173
func (e *errPeerAlreadyConnected) Error() string {
3✔
174
        return fmt.Sprintf("already connected to peer: %v", e.peer)
3✔
175
}
3✔
176

177
// peerAccessStatus denotes the p2p access status of a given peer. This will be
178
// used to assign peer ban scores that determine an action the server will
179
// take.
180
type peerAccessStatus int
181

182
const (
183
        // peerStatusRestricted indicates that the peer only has access to the
184
        // limited number of "free" reserved slots.
185
        peerStatusRestricted peerAccessStatus = iota
186

187
        // peerStatusTemporary indicates that the peer only has temporary p2p
188
        // access to the server.
189
        peerStatusTemporary
190

191
        // peerStatusProtected indicates that the peer has been granted
192
        // permanent p2p access to the server. The peer can still have its
193
        // access revoked.
194
        peerStatusProtected
195
)
196

197
// peerSlotStatus determines whether a peer gets access to one of our free
198
// slots or gets to bypass this safety mechanism.
199
type peerSlotStatus struct {
200
        // state determines which privileges the peer has with our server.
201
        state peerAccessStatus
202
}
203

204
// server is the main server of the Lightning Network Daemon. The server houses
205
// global state pertaining to the wallet, database, and the rpcserver.
206
// Additionally, the server is also used as a central messaging bus to interact
207
// with any of its companion objects.
208
type server struct {
209
        active   int32 // atomic
210
        stopping int32 // atomic
211

212
        start sync.Once
213
        stop  sync.Once
214

215
        cfg *Config
216

217
        implCfg *ImplementationCfg
218

219
        // identityECDH is an ECDH capable wrapper for the private key used
220
        // to authenticate any incoming connections.
221
        identityECDH keychain.SingleKeyECDH
222

223
        // identityKeyLoc is the key locator for the above wrapped identity key.
224
        identityKeyLoc keychain.KeyLocator
225

226
        // nodeSigner is an implementation of the MessageSigner implementation
227
        // that's backed by the identity private key of the running lnd node.
228
        nodeSigner *netann.NodeSigner
229

230
        chanStatusMgr *netann.ChanStatusManager
231

232
        // listenAddrs is the list of addresses the server is currently
233
        // listening on.
234
        listenAddrs []net.Addr
235

236
        // torController is a client that will communicate with a locally
237
        // running Tor server. This client will handle initiating and
238
        // authenticating the connection to the Tor server, automatically
239
        // creating and setting up onion services, etc.
240
        torController *tor.Controller
241

242
        // natTraversal is the specific NAT traversal technique used to
243
        // automatically set up port forwarding rules in order to advertise to
244
        // the network that the node is accepting inbound connections.
245
        natTraversal nat.Traversal
246

247
        // lastDetectedIP is the last IP detected by the NAT traversal technique
248
        // above. This IP will be watched periodically in a goroutine in order
249
        // to handle dynamic IP changes.
250
        lastDetectedIP net.IP
251

252
        mu sync.RWMutex
253

254
        // peersByPub is a map of the active peers.
255
        //
256
        // NOTE: The key used here is the raw bytes of the peer's public key to
257
        // string conversion, which means it cannot be printed using `%s` as it
258
        // will just print the binary.
259
        //
260
        // TODO(yy): Use the hex string instead.
261
        peersByPub map[string]*peer.Brontide
262

263
        inboundPeers  map[string]*peer.Brontide
264
        outboundPeers map[string]*peer.Brontide
265

266
        peerConnectedListeners    map[string][]chan<- lnpeer.Peer
267
        peerDisconnectedListeners map[string][]chan<- struct{}
268

269
        // TODO(yy): the Brontide.Start doesn't know this value, which means it
270
        // will continue to send messages even if there are no active channels
271
        // and the value below is false. Once it's pruned, all its connections
272
        // will be closed, thus the Brontide.Start will return an error.
273
        persistentPeers        map[string]bool
274
        persistentPeersBackoff map[string]time.Duration
275
        persistentPeerAddrs    map[string][]*lnwire.NetAddress
276
        persistentConnReqs     map[string][]*connmgr.ConnReq
277
        persistentRetryCancels map[string]chan struct{}
278

279
        // peerErrors keeps a set of peer error buffers for peers that have
280
        // disconnected from us. This allows us to track historic peer errors
281
        // over connections. The string of the peer's compressed pubkey is used
282
        // as a key for this map.
283
        peerErrors map[string]*queue.CircularBuffer
284

285
        // ignorePeerTermination tracks peers for which the server has initiated
286
        // a disconnect. Adding a peer to this map causes the peer termination
287
        // watcher to short circuit in the event that peers are purposefully
288
        // disconnected.
289
        ignorePeerTermination map[*peer.Brontide]struct{}
290

291
        // scheduledPeerConnection maps a pubkey string to a callback that
292
        // should be executed in the peerTerminationWatcher the prior peer with
293
        // the same pubkey exits.  This allows the server to wait until the
294
        // prior peer has cleaned up successfully, before adding the new peer
295
        // intended to replace it.
296
        scheduledPeerConnection map[string]func()
297

298
        // pongBuf is a shared pong reply buffer we'll use across all active
299
        // peer goroutines. We know the max size of a pong message
300
        // (lnwire.MaxPongBytes), so we can allocate this ahead of time, and
301
        // avoid allocations each time we need to send a pong message.
302
        pongBuf []byte
303

304
        cc *chainreg.ChainControl
305

306
        fundingMgr *funding.Manager
307

308
        graphDB *graphdb.ChannelGraph
309

310
        chanStateDB *channeldb.ChannelStateDB
311

312
        addrSource channeldb.AddrSource
313

314
        // miscDB is the DB that contains all "other" databases within the main
315
        // channel DB that haven't been separated out yet.
316
        miscDB *channeldb.DB
317

318
        invoicesDB invoices.InvoiceDB
319

320
        aliasMgr *aliasmgr.Manager
321

322
        htlcSwitch *htlcswitch.Switch
323

324
        interceptableSwitch *htlcswitch.InterceptableSwitch
325

326
        invoices *invoices.InvoiceRegistry
327

328
        invoiceHtlcModifier *invoices.HtlcModificationInterceptor
329

330
        channelNotifier *channelnotifier.ChannelNotifier
331

332
        peerNotifier *peernotifier.PeerNotifier
333

334
        htlcNotifier *htlcswitch.HtlcNotifier
335

336
        witnessBeacon contractcourt.WitnessBeacon
337

338
        breachArbitrator *contractcourt.BreachArbitrator
339

340
        missionController *routing.MissionController
341
        defaultMC         *routing.MissionControl
342

343
        graphBuilder *graph.Builder
344

345
        chanRouter *routing.ChannelRouter
346

347
        controlTower routing.ControlTower
348

349
        authGossiper *discovery.AuthenticatedGossiper
350

351
        localChanMgr *localchans.Manager
352

353
        utxoNursery *contractcourt.UtxoNursery
354

355
        sweeper *sweep.UtxoSweeper
356

357
        chainArb *contractcourt.ChainArbitrator
358

359
        sphinx *hop.OnionProcessor
360

361
        towerClientMgr *wtclient.Manager
362

363
        connMgr *connmgr.ConnManager
364

365
        sigPool *lnwallet.SigPool
366

367
        writePool *pool.Write
368

369
        readPool *pool.Read
370

371
        tlsManager *TLSManager
372

373
        // featureMgr dispatches feature vectors for various contexts within the
374
        // daemon.
375
        featureMgr *feature.Manager
376

377
        // currentNodeAnn is the node announcement that has been broadcast to
378
        // the network upon startup, if the attributes of the node (us) has
379
        // changed since last start.
380
        currentNodeAnn *lnwire.NodeAnnouncement
381

382
        // chansToRestore is the set of channels that upon starting, the server
383
        // should attempt to restore/recover.
384
        chansToRestore walletunlocker.ChannelsToRecover
385

386
        // chanSubSwapper is a sub-system that will ensure our on-disk channel
387
        // backups are consistent at all times. It interacts with the
388
        // channelNotifier to be notified of newly opened and closed channels.
389
        chanSubSwapper *chanbackup.SubSwapper
390

391
        // chanEventStore tracks the behaviour of channels and their remote peers to
392
        // provide insights into their health and performance.
393
        chanEventStore *chanfitness.ChannelEventStore
394

395
        hostAnn *netann.HostAnnouncer
396

397
        // livenessMonitor monitors that lnd has access to critical resources.
398
        livenessMonitor *healthcheck.Monitor
399

400
        customMessageServer *subscribe.Server
401

402
        // txPublisher is a publisher with fee-bumping capability.
403
        txPublisher *sweep.TxPublisher
404

405
        // blockbeatDispatcher is a block dispatcher that notifies subscribers
406
        // of new blocks.
407
        blockbeatDispatcher *chainio.BlockbeatDispatcher
408

409
        // peerAccessMan implements peer access controls.
410
        peerAccessMan *accessMan
411

412
        quit chan struct{}
413

414
        wg sync.WaitGroup
415
}
416

417
// updatePersistentPeerAddrs subscribes to topology changes and stores
418
// advertised addresses for any NodeAnnouncements from our persisted peers.
419
func (s *server) updatePersistentPeerAddrs() error {
3✔
420
        graphSub, err := s.graphDB.SubscribeTopology()
3✔
421
        if err != nil {
3✔
422
                return err
×
423
        }
×
424

425
        s.wg.Add(1)
3✔
426
        go func() {
6✔
427
                defer func() {
6✔
428
                        graphSub.Cancel()
3✔
429
                        s.wg.Done()
3✔
430
                }()
3✔
431

432
                for {
6✔
433
                        select {
3✔
434
                        case <-s.quit:
3✔
435
                                return
3✔
436

437
                        case topChange, ok := <-graphSub.TopologyChanges:
3✔
438
                                // If the router is shutting down, then we will
3✔
439
                                // as well.
3✔
440
                                if !ok {
3✔
441
                                        return
×
442
                                }
×
443

444
                                for _, update := range topChange.NodeUpdates {
6✔
445
                                        pubKeyStr := string(
3✔
446
                                                update.IdentityKey.
3✔
447
                                                        SerializeCompressed(),
3✔
448
                                        )
3✔
449

3✔
450
                                        // We only care about updates from
3✔
451
                                        // our persistentPeers.
3✔
452
                                        s.mu.RLock()
3✔
453
                                        _, ok := s.persistentPeers[pubKeyStr]
3✔
454
                                        s.mu.RUnlock()
3✔
455
                                        if !ok {
6✔
456
                                                continue
3✔
457
                                        }
458

459
                                        addrs := make([]*lnwire.NetAddress, 0,
3✔
460
                                                len(update.Addresses))
3✔
461

3✔
462
                                        for _, addr := range update.Addresses {
6✔
463
                                                addrs = append(addrs,
3✔
464
                                                        &lnwire.NetAddress{
3✔
465
                                                                IdentityKey: update.IdentityKey,
3✔
466
                                                                Address:     addr,
3✔
467
                                                                ChainNet:    s.cfg.ActiveNetParams.Net,
3✔
468
                                                        },
3✔
469
                                                )
3✔
470
                                        }
3✔
471

472
                                        s.mu.Lock()
3✔
473

3✔
474
                                        // Update the stored addresses for this
3✔
475
                                        // to peer to reflect the new set.
3✔
476
                                        s.persistentPeerAddrs[pubKeyStr] = addrs
3✔
477

3✔
478
                                        // If there are no outstanding
3✔
479
                                        // connection requests for this peer
3✔
480
                                        // then our work is done since we are
3✔
481
                                        // not currently trying to connect to
3✔
482
                                        // them.
3✔
483
                                        if len(s.persistentConnReqs[pubKeyStr]) == 0 {
6✔
484
                                                s.mu.Unlock()
3✔
485
                                                continue
3✔
486
                                        }
487

488
                                        s.mu.Unlock()
3✔
489

3✔
490
                                        s.connectToPersistentPeer(pubKeyStr)
3✔
491
                                }
492
                        }
493
                }
494
        }()
495

496
        return nil
3✔
497
}
498

499
// CustomMessage is a custom message that is received from a peer.
500
type CustomMessage struct {
501
        // Peer is the peer pubkey
502
        Peer [33]byte
503

504
        // Msg is the custom wire message.
505
        Msg *lnwire.Custom
506
}
507

508
// parseAddr parses an address from its string format to a net.Addr.
509
func parseAddr(address string, netCfg tor.Net) (net.Addr, error) {
3✔
510
        var (
3✔
511
                host string
3✔
512
                port int
3✔
513
        )
3✔
514

3✔
515
        // Split the address into its host and port components.
3✔
516
        h, p, err := net.SplitHostPort(address)
3✔
517
        if err != nil {
3✔
518
                // If a port wasn't specified, we'll assume the address only
×
519
                // contains the host so we'll use the default port.
×
520
                host = address
×
521
                port = defaultPeerPort
×
522
        } else {
3✔
523
                // Otherwise, we'll note both the host and ports.
3✔
524
                host = h
3✔
525
                portNum, err := strconv.Atoi(p)
3✔
526
                if err != nil {
3✔
527
                        return nil, err
×
528
                }
×
529
                port = portNum
3✔
530
        }
531

532
        if tor.IsOnionHost(host) {
3✔
533
                return &tor.OnionAddr{OnionService: host, Port: port}, nil
×
534
        }
×
535

536
        // If the host is part of a TCP address, we'll use the network
537
        // specific ResolveTCPAddr function in order to resolve these
538
        // addresses over Tor in order to prevent leaking your real IP
539
        // address.
540
        hostPort := net.JoinHostPort(host, strconv.Itoa(port))
3✔
541
        return netCfg.ResolveTCPAddr("tcp", hostPort)
3✔
542
}
543

544
// noiseDial is a factory function which creates a connmgr compliant dialing
545
// function by returning a closure which includes the server's identity key.
546
func noiseDial(idKey keychain.SingleKeyECDH,
547
        netCfg tor.Net, timeout time.Duration) func(net.Addr) (net.Conn, error) {
3✔
548

3✔
549
        return func(a net.Addr) (net.Conn, error) {
6✔
550
                lnAddr := a.(*lnwire.NetAddress)
3✔
551
                return brontide.Dial(idKey, lnAddr, timeout, netCfg.Dial)
3✔
552
        }
3✔
553
}
554

555
// newServer creates a new instance of the server which is to listen using the
556
// passed listener address.
557
func newServer(cfg *Config, listenAddrs []net.Addr,
558
        dbs *DatabaseInstances, cc *chainreg.ChainControl,
559
        nodeKeyDesc *keychain.KeyDescriptor,
560
        chansToRestore walletunlocker.ChannelsToRecover,
561
        chanPredicate chanacceptor.ChannelAcceptor,
562
        torController *tor.Controller, tlsManager *TLSManager,
563
        leaderElector cluster.LeaderElector,
564
        implCfg *ImplementationCfg) (*server, error) {
3✔
565

3✔
566
        var (
3✔
567
                err         error
3✔
568
                nodeKeyECDH = keychain.NewPubKeyECDH(*nodeKeyDesc, cc.KeyRing)
3✔
569

3✔
570
                // We just derived the full descriptor, so we know the public
3✔
571
                // key is set on it.
3✔
572
                nodeKeySigner = keychain.NewPubKeyMessageSigner(
3✔
573
                        nodeKeyDesc.PubKey, nodeKeyDesc.KeyLocator, cc.KeyRing,
3✔
574
                )
3✔
575
        )
3✔
576

3✔
577
        var serializedPubKey [33]byte
3✔
578
        copy(serializedPubKey[:], nodeKeyDesc.PubKey.SerializeCompressed())
3✔
579

3✔
580
        netParams := cfg.ActiveNetParams.Params
3✔
581

3✔
582
        // Initialize the sphinx router.
3✔
583
        replayLog := htlcswitch.NewDecayedLog(
3✔
584
                dbs.DecayedLogDB, cc.ChainNotifier,
3✔
585
        )
3✔
586
        sphinxRouter := sphinx.NewRouter(nodeKeyECDH, replayLog)
3✔
587

3✔
588
        writeBufferPool := pool.NewWriteBuffer(
3✔
589
                pool.DefaultWriteBufferGCInterval,
3✔
590
                pool.DefaultWriteBufferExpiryInterval,
3✔
591
        )
3✔
592

3✔
593
        writePool := pool.NewWrite(
3✔
594
                writeBufferPool, cfg.Workers.Write, pool.DefaultWorkerTimeout,
3✔
595
        )
3✔
596

3✔
597
        readBufferPool := pool.NewReadBuffer(
3✔
598
                pool.DefaultReadBufferGCInterval,
3✔
599
                pool.DefaultReadBufferExpiryInterval,
3✔
600
        )
3✔
601

3✔
602
        readPool := pool.NewRead(
3✔
603
                readBufferPool, cfg.Workers.Read, pool.DefaultWorkerTimeout,
3✔
604
        )
3✔
605

3✔
606
        // If the taproot overlay flag is set, but we don't have an aux funding
3✔
607
        // controller, then we'll exit as this is incompatible.
3✔
608
        if cfg.ProtocolOptions.TaprootOverlayChans &&
3✔
609
                implCfg.AuxFundingController.IsNone() {
3✔
610

×
611
                return nil, fmt.Errorf("taproot overlay flag set, but not " +
×
612
                        "aux controllers")
×
613
        }
×
614

615
        //nolint:ll
616
        featureMgr, err := feature.NewManager(feature.Config{
3✔
617
                NoTLVOnion:                cfg.ProtocolOptions.LegacyOnion(),
3✔
618
                NoStaticRemoteKey:         cfg.ProtocolOptions.NoStaticRemoteKey(),
3✔
619
                NoAnchors:                 cfg.ProtocolOptions.NoAnchorCommitments(),
3✔
620
                NoWumbo:                   !cfg.ProtocolOptions.Wumbo(),
3✔
621
                NoScriptEnforcementLease:  cfg.ProtocolOptions.NoScriptEnforcementLease(),
3✔
622
                NoKeysend:                 !cfg.AcceptKeySend,
3✔
623
                NoOptionScidAlias:         !cfg.ProtocolOptions.ScidAlias(),
3✔
624
                NoZeroConf:                !cfg.ProtocolOptions.ZeroConf(),
3✔
625
                NoAnySegwit:               cfg.ProtocolOptions.NoAnySegwit(),
3✔
626
                CustomFeatures:            cfg.ProtocolOptions.CustomFeatures(),
3✔
627
                NoTaprootChans:            !cfg.ProtocolOptions.TaprootChans,
3✔
628
                NoTaprootOverlay:          !cfg.ProtocolOptions.TaprootOverlayChans,
3✔
629
                NoRouteBlinding:           cfg.ProtocolOptions.NoRouteBlinding(),
3✔
630
                NoExperimentalEndorsement: cfg.ProtocolOptions.NoExperimentalEndorsement(),
3✔
631
                NoQuiescence:              cfg.ProtocolOptions.NoQuiescence(),
3✔
632
                NoRbfCoopClose:            !cfg.ProtocolOptions.RbfCoopClose,
3✔
633
        })
3✔
634
        if err != nil {
3✔
635
                return nil, err
×
636
        }
×
637

638
        invoiceHtlcModifier := invoices.NewHtlcModificationInterceptor()
3✔
639
        registryConfig := invoices.RegistryConfig{
3✔
640
                FinalCltvRejectDelta:        lncfg.DefaultFinalCltvRejectDelta,
3✔
641
                HtlcHoldDuration:            invoices.DefaultHtlcHoldDuration,
3✔
642
                Clock:                       clock.NewDefaultClock(),
3✔
643
                AcceptKeySend:               cfg.AcceptKeySend,
3✔
644
                AcceptAMP:                   cfg.AcceptAMP,
3✔
645
                GcCanceledInvoicesOnStartup: cfg.GcCanceledInvoicesOnStartup,
3✔
646
                GcCanceledInvoicesOnTheFly:  cfg.GcCanceledInvoicesOnTheFly,
3✔
647
                KeysendHoldTime:             cfg.KeysendHoldTime,
3✔
648
                HtlcInterceptor:             invoiceHtlcModifier,
3✔
649
        }
3✔
650

3✔
651
        addrSource := channeldb.NewMultiAddrSource(dbs.ChanStateDB, dbs.GraphDB)
3✔
652

3✔
653
        s := &server{
3✔
654
                cfg:            cfg,
3✔
655
                implCfg:        implCfg,
3✔
656
                graphDB:        dbs.GraphDB,
3✔
657
                chanStateDB:    dbs.ChanStateDB.ChannelStateDB(),
3✔
658
                addrSource:     addrSource,
3✔
659
                miscDB:         dbs.ChanStateDB,
3✔
660
                invoicesDB:     dbs.InvoiceDB,
3✔
661
                cc:             cc,
3✔
662
                sigPool:        lnwallet.NewSigPool(cfg.Workers.Sig, cc.Signer),
3✔
663
                writePool:      writePool,
3✔
664
                readPool:       readPool,
3✔
665
                chansToRestore: chansToRestore,
3✔
666

3✔
667
                blockbeatDispatcher: chainio.NewBlockbeatDispatcher(
3✔
668
                        cc.ChainNotifier,
3✔
669
                ),
3✔
670
                channelNotifier: channelnotifier.New(
3✔
671
                        dbs.ChanStateDB.ChannelStateDB(),
3✔
672
                ),
3✔
673

3✔
674
                identityECDH:   nodeKeyECDH,
3✔
675
                identityKeyLoc: nodeKeyDesc.KeyLocator,
3✔
676
                nodeSigner:     netann.NewNodeSigner(nodeKeySigner),
3✔
677

3✔
678
                listenAddrs: listenAddrs,
3✔
679

3✔
680
                // TODO(roasbeef): derive proper onion key based on rotation
3✔
681
                // schedule
3✔
682
                sphinx: hop.NewOnionProcessor(sphinxRouter),
3✔
683

3✔
684
                torController: torController,
3✔
685

3✔
686
                persistentPeers:         make(map[string]bool),
3✔
687
                persistentPeersBackoff:  make(map[string]time.Duration),
3✔
688
                persistentConnReqs:      make(map[string][]*connmgr.ConnReq),
3✔
689
                persistentPeerAddrs:     make(map[string][]*lnwire.NetAddress),
3✔
690
                persistentRetryCancels:  make(map[string]chan struct{}),
3✔
691
                peerErrors:              make(map[string]*queue.CircularBuffer),
3✔
692
                ignorePeerTermination:   make(map[*peer.Brontide]struct{}),
3✔
693
                scheduledPeerConnection: make(map[string]func()),
3✔
694
                pongBuf:                 make([]byte, lnwire.MaxPongBytes),
3✔
695

3✔
696
                peersByPub:                make(map[string]*peer.Brontide),
3✔
697
                inboundPeers:              make(map[string]*peer.Brontide),
3✔
698
                outboundPeers:             make(map[string]*peer.Brontide),
3✔
699
                peerConnectedListeners:    make(map[string][]chan<- lnpeer.Peer),
3✔
700
                peerDisconnectedListeners: make(map[string][]chan<- struct{}),
3✔
701

3✔
702
                invoiceHtlcModifier: invoiceHtlcModifier,
3✔
703

3✔
704
                customMessageServer: subscribe.NewServer(),
3✔
705

3✔
706
                tlsManager: tlsManager,
3✔
707

3✔
708
                featureMgr: featureMgr,
3✔
709
                quit:       make(chan struct{}),
3✔
710
        }
3✔
711

3✔
712
        // Start the low-level services once they are initialized.
3✔
713
        //
3✔
714
        // TODO(yy): break the server startup into four steps,
3✔
715
        // 1. init the low-level services.
3✔
716
        // 2. start the low-level services.
3✔
717
        // 3. init the high-level services.
3✔
718
        // 4. start the high-level services.
3✔
719
        if err := s.startLowLevelServices(); err != nil {
3✔
720
                return nil, err
×
721
        }
×
722

723
        currentHash, currentHeight, err := s.cc.ChainIO.GetBestBlock()
3✔
724
        if err != nil {
3✔
725
                return nil, err
×
726
        }
×
727

728
        expiryWatcher := invoices.NewInvoiceExpiryWatcher(
3✔
729
                clock.NewDefaultClock(), cfg.Invoices.HoldExpiryDelta,
3✔
730
                uint32(currentHeight), currentHash, cc.ChainNotifier,
3✔
731
        )
3✔
732
        s.invoices = invoices.NewRegistry(
3✔
733
                dbs.InvoiceDB, expiryWatcher, &registryConfig,
3✔
734
        )
3✔
735

3✔
736
        s.htlcNotifier = htlcswitch.NewHtlcNotifier(time.Now)
3✔
737

3✔
738
        thresholdSats := btcutil.Amount(cfg.MaxFeeExposure)
3✔
739
        thresholdMSats := lnwire.NewMSatFromSatoshis(thresholdSats)
3✔
740

3✔
741
        linkUpdater := func(shortID lnwire.ShortChannelID) error {
6✔
742
                link, err := s.htlcSwitch.GetLinkByShortID(shortID)
3✔
743
                if err != nil {
3✔
744
                        return err
×
745
                }
×
746

747
                s.htlcSwitch.UpdateLinkAliases(link)
3✔
748

3✔
749
                return nil
3✔
750
        }
751

752
        s.aliasMgr, err = aliasmgr.NewManager(dbs.ChanStateDB, linkUpdater)
3✔
753
        if err != nil {
3✔
754
                return nil, err
×
755
        }
×
756

757
        s.htlcSwitch, err = htlcswitch.New(htlcswitch.Config{
3✔
758
                DB:                   dbs.ChanStateDB,
3✔
759
                FetchAllOpenChannels: s.chanStateDB.FetchAllOpenChannels,
3✔
760
                FetchAllChannels:     s.chanStateDB.FetchAllChannels,
3✔
761
                FetchClosedChannels:  s.chanStateDB.FetchClosedChannels,
3✔
762
                LocalChannelClose: func(pubKey []byte,
3✔
763
                        request *htlcswitch.ChanClose) {
6✔
764

3✔
765
                        peer, err := s.FindPeerByPubStr(string(pubKey))
3✔
766
                        if err != nil {
3✔
767
                                srvrLog.Errorf("unable to close channel, peer"+
×
768
                                        " with %v id can't be found: %v",
×
769
                                        pubKey, err,
×
770
                                )
×
771
                                return
×
772
                        }
×
773

774
                        peer.HandleLocalCloseChanReqs(request)
3✔
775
                },
776
                FwdingLog:              dbs.ChanStateDB.ForwardingLog(),
777
                SwitchPackager:         channeldb.NewSwitchPackager(),
778
                ExtractErrorEncrypter:  s.sphinx.ExtractErrorEncrypter,
779
                FetchLastChannelUpdate: s.fetchLastChanUpdate(),
780
                Notifier:               s.cc.ChainNotifier,
781
                HtlcNotifier:           s.htlcNotifier,
782
                FwdEventTicker:         ticker.New(htlcswitch.DefaultFwdEventInterval),
783
                LogEventTicker:         ticker.New(htlcswitch.DefaultLogInterval),
784
                AckEventTicker:         ticker.New(htlcswitch.DefaultAckInterval),
785
                AllowCircularRoute:     cfg.AllowCircularRoute,
786
                RejectHTLC:             cfg.RejectHTLC,
787
                Clock:                  clock.NewDefaultClock(),
788
                MailboxDeliveryTimeout: cfg.Htlcswitch.MailboxDeliveryTimeout,
789
                MaxFeeExposure:         thresholdMSats,
790
                SignAliasUpdate:        s.signAliasUpdate,
791
                IsAlias:                aliasmgr.IsAlias,
792
        }, uint32(currentHeight))
793
        if err != nil {
3✔
794
                return nil, err
×
795
        }
×
796
        s.interceptableSwitch, err = htlcswitch.NewInterceptableSwitch(
3✔
797
                &htlcswitch.InterceptableSwitchConfig{
3✔
798
                        Switch:             s.htlcSwitch,
3✔
799
                        CltvRejectDelta:    lncfg.DefaultFinalCltvRejectDelta,
3✔
800
                        CltvInterceptDelta: lncfg.DefaultCltvInterceptDelta,
3✔
801
                        RequireInterceptor: s.cfg.RequireInterceptor,
3✔
802
                        Notifier:           s.cc.ChainNotifier,
3✔
803
                },
3✔
804
        )
3✔
805
        if err != nil {
3✔
806
                return nil, err
×
807
        }
×
808

809
        s.witnessBeacon = newPreimageBeacon(
3✔
810
                dbs.ChanStateDB.NewWitnessCache(),
3✔
811
                s.interceptableSwitch.ForwardPacket,
3✔
812
        )
3✔
813

3✔
814
        chanStatusMgrCfg := &netann.ChanStatusConfig{
3✔
815
                ChanStatusSampleInterval: cfg.ChanStatusSampleInterval,
3✔
816
                ChanEnableTimeout:        cfg.ChanEnableTimeout,
3✔
817
                ChanDisableTimeout:       cfg.ChanDisableTimeout,
3✔
818
                OurPubKey:                nodeKeyDesc.PubKey,
3✔
819
                OurKeyLoc:                nodeKeyDesc.KeyLocator,
3✔
820
                MessageSigner:            s.nodeSigner,
3✔
821
                IsChannelActive:          s.htlcSwitch.HasActiveLink,
3✔
822
                ApplyChannelUpdate:       s.applyChannelUpdate,
3✔
823
                DB:                       s.chanStateDB,
3✔
824
                Graph:                    dbs.GraphDB,
3✔
825
        }
3✔
826

3✔
827
        chanStatusMgr, err := netann.NewChanStatusManager(chanStatusMgrCfg)
3✔
828
        if err != nil {
3✔
829
                return nil, err
×
830
        }
×
831
        s.chanStatusMgr = chanStatusMgr
3✔
832

3✔
833
        // If enabled, use either UPnP or NAT-PMP to automatically configure
3✔
834
        // port forwarding for users behind a NAT.
3✔
835
        if cfg.NAT {
3✔
836
                srvrLog.Info("Scanning local network for a UPnP enabled device")
×
837

×
838
                discoveryTimeout := time.Duration(10 * time.Second)
×
839

×
840
                ctx, cancel := context.WithTimeout(
×
841
                        context.Background(), discoveryTimeout,
×
842
                )
×
843
                defer cancel()
×
844
                upnp, err := nat.DiscoverUPnP(ctx)
×
845
                if err == nil {
×
846
                        s.natTraversal = upnp
×
847
                } else {
×
848
                        // If we were not able to discover a UPnP enabled device
×
849
                        // on the local network, we'll fall back to attempting
×
850
                        // to discover a NAT-PMP enabled device.
×
851
                        srvrLog.Errorf("Unable to discover a UPnP enabled "+
×
852
                                "device on the local network: %v", err)
×
853

×
854
                        srvrLog.Info("Scanning local network for a NAT-PMP " +
×
855
                                "enabled device")
×
856

×
857
                        pmp, err := nat.DiscoverPMP(discoveryTimeout)
×
858
                        if err != nil {
×
859
                                err := fmt.Errorf("unable to discover a "+
×
860
                                        "NAT-PMP enabled device on the local "+
×
861
                                        "network: %v", err)
×
862
                                srvrLog.Error(err)
×
863
                                return nil, err
×
864
                        }
×
865

866
                        s.natTraversal = pmp
×
867
                }
868
        }
869

870
        // If we were requested to automatically configure port forwarding,
871
        // we'll use the ports that the server will be listening on.
872
        externalIPStrings := make([]string, len(cfg.ExternalIPs))
3✔
873
        for idx, ip := range cfg.ExternalIPs {
6✔
874
                externalIPStrings[idx] = ip.String()
3✔
875
        }
3✔
876
        if s.natTraversal != nil {
3✔
877
                listenPorts := make([]uint16, 0, len(listenAddrs))
×
878
                for _, listenAddr := range listenAddrs {
×
879
                        // At this point, the listen addresses should have
×
880
                        // already been normalized, so it's safe to ignore the
×
881
                        // errors.
×
882
                        _, portStr, _ := net.SplitHostPort(listenAddr.String())
×
883
                        port, _ := strconv.Atoi(portStr)
×
884

×
885
                        listenPorts = append(listenPorts, uint16(port))
×
886
                }
×
887

888
                ips, err := s.configurePortForwarding(listenPorts...)
×
889
                if err != nil {
×
890
                        srvrLog.Errorf("Unable to automatically set up port "+
×
891
                                "forwarding using %s: %v",
×
892
                                s.natTraversal.Name(), err)
×
893
                } else {
×
894
                        srvrLog.Infof("Automatically set up port forwarding "+
×
895
                                "using %s to advertise external IP",
×
896
                                s.natTraversal.Name())
×
897
                        externalIPStrings = append(externalIPStrings, ips...)
×
898
                }
×
899
        }
900

901
        // If external IP addresses have been specified, add those to the list
902
        // of this server's addresses.
903
        externalIPs, err := lncfg.NormalizeAddresses(
3✔
904
                externalIPStrings, strconv.Itoa(defaultPeerPort),
3✔
905
                cfg.net.ResolveTCPAddr,
3✔
906
        )
3✔
907
        if err != nil {
3✔
908
                return nil, err
×
909
        }
×
910

911
        selfAddrs := make([]net.Addr, 0, len(externalIPs))
3✔
912
        selfAddrs = append(selfAddrs, externalIPs...)
3✔
913

3✔
914
        // We'll now reconstruct a node announcement based on our current
3✔
915
        // configuration so we can send it out as a sort of heart beat within
3✔
916
        // the network.
3✔
917
        //
3✔
918
        // We'll start by parsing the node color from configuration.
3✔
919
        color, err := lncfg.ParseHexColor(cfg.Color)
3✔
920
        if err != nil {
3✔
921
                srvrLog.Errorf("unable to parse color: %v\n", err)
×
922
                return nil, err
×
923
        }
×
924

925
        // If no alias is provided, default to first 10 characters of public
926
        // key.
927
        alias := cfg.Alias
3✔
928
        if alias == "" {
6✔
929
                alias = hex.EncodeToString(serializedPubKey[:10])
3✔
930
        }
3✔
931
        nodeAlias, err := lnwire.NewNodeAlias(alias)
3✔
932
        if err != nil {
3✔
933
                return nil, err
×
934
        }
×
935
        selfNode := &models.LightningNode{
3✔
936
                HaveNodeAnnouncement: true,
3✔
937
                LastUpdate:           time.Now(),
3✔
938
                Addresses:            selfAddrs,
3✔
939
                Alias:                nodeAlias.String(),
3✔
940
                Features:             s.featureMgr.Get(feature.SetNodeAnn),
3✔
941
                Color:                color,
3✔
942
        }
3✔
943
        copy(selfNode.PubKeyBytes[:], nodeKeyDesc.PubKey.SerializeCompressed())
3✔
944

3✔
945
        // Based on the disk representation of the node announcement generated
3✔
946
        // above, we'll generate a node announcement that can go out on the
3✔
947
        // network so we can properly sign it.
3✔
948
        nodeAnn, err := selfNode.NodeAnnouncement(false)
3✔
949
        if err != nil {
3✔
950
                return nil, fmt.Errorf("unable to gen self node ann: %w", err)
×
951
        }
×
952

953
        // With the announcement generated, we'll sign it to properly
954
        // authenticate the message on the network.
955
        authSig, err := netann.SignAnnouncement(
3✔
956
                s.nodeSigner, nodeKeyDesc.KeyLocator, nodeAnn,
3✔
957
        )
3✔
958
        if err != nil {
3✔
959
                return nil, fmt.Errorf("unable to generate signature for "+
×
960
                        "self node announcement: %v", err)
×
961
        }
×
962
        selfNode.AuthSigBytes = authSig.Serialize()
3✔
963
        nodeAnn.Signature, err = lnwire.NewSigFromECDSARawSignature(
3✔
964
                selfNode.AuthSigBytes,
3✔
965
        )
3✔
966
        if err != nil {
3✔
967
                return nil, err
×
968
        }
×
969

970
        // Finally, we'll update the representation on disk, and update our
971
        // cached in-memory version as well.
972
        if err := dbs.GraphDB.SetSourceNode(selfNode); err != nil {
3✔
973
                return nil, fmt.Errorf("can't set self node: %w", err)
×
974
        }
×
975
        s.currentNodeAnn = nodeAnn
3✔
976

3✔
977
        // The router will get access to the payment ID sequencer, such that it
3✔
978
        // can generate unique payment IDs.
3✔
979
        sequencer, err := htlcswitch.NewPersistentSequencer(dbs.ChanStateDB)
3✔
980
        if err != nil {
3✔
981
                return nil, err
×
982
        }
×
983

984
        // Instantiate mission control with config from the sub server.
985
        //
986
        // TODO(joostjager): When we are further in the process of moving to sub
987
        // servers, the mission control instance itself can be moved there too.
988
        routingConfig := routerrpc.GetRoutingConfig(cfg.SubRPCServers.RouterRPC)
3✔
989

3✔
990
        // We only initialize a probability estimator if there's no custom one.
3✔
991
        var estimator routing.Estimator
3✔
992
        if cfg.Estimator != nil {
3✔
993
                estimator = cfg.Estimator
×
994
        } else {
3✔
995
                switch routingConfig.ProbabilityEstimatorType {
3✔
996
                case routing.AprioriEstimatorName:
3✔
997
                        aCfg := routingConfig.AprioriConfig
3✔
998
                        aprioriConfig := routing.AprioriConfig{
3✔
999
                                AprioriHopProbability: aCfg.HopProbability,
3✔
1000
                                PenaltyHalfLife:       aCfg.PenaltyHalfLife,
3✔
1001
                                AprioriWeight:         aCfg.Weight,
3✔
1002
                                CapacityFraction:      aCfg.CapacityFraction,
3✔
1003
                        }
3✔
1004

3✔
1005
                        estimator, err = routing.NewAprioriEstimator(
3✔
1006
                                aprioriConfig,
3✔
1007
                        )
3✔
1008
                        if err != nil {
3✔
1009
                                return nil, err
×
1010
                        }
×
1011

1012
                case routing.BimodalEstimatorName:
×
1013
                        bCfg := routingConfig.BimodalConfig
×
1014
                        bimodalConfig := routing.BimodalConfig{
×
1015
                                BimodalNodeWeight: bCfg.NodeWeight,
×
1016
                                BimodalScaleMsat: lnwire.MilliSatoshi(
×
1017
                                        bCfg.Scale,
×
1018
                                ),
×
1019
                                BimodalDecayTime: bCfg.DecayTime,
×
1020
                        }
×
1021

×
1022
                        estimator, err = routing.NewBimodalEstimator(
×
1023
                                bimodalConfig,
×
1024
                        )
×
1025
                        if err != nil {
×
1026
                                return nil, err
×
1027
                        }
×
1028

1029
                default:
×
1030
                        return nil, fmt.Errorf("unknown estimator type %v",
×
1031
                                routingConfig.ProbabilityEstimatorType)
×
1032
                }
1033
        }
1034

1035
        mcCfg := &routing.MissionControlConfig{
3✔
1036
                OnConfigUpdate:          fn.Some(s.UpdateRoutingConfig),
3✔
1037
                Estimator:               estimator,
3✔
1038
                MaxMcHistory:            routingConfig.MaxMcHistory,
3✔
1039
                McFlushInterval:         routingConfig.McFlushInterval,
3✔
1040
                MinFailureRelaxInterval: routing.DefaultMinFailureRelaxInterval,
3✔
1041
        }
3✔
1042

3✔
1043
        s.missionController, err = routing.NewMissionController(
3✔
1044
                dbs.ChanStateDB, selfNode.PubKeyBytes, mcCfg,
3✔
1045
        )
3✔
1046
        if err != nil {
3✔
1047
                return nil, fmt.Errorf("can't create mission control "+
×
1048
                        "manager: %w", err)
×
1049
        }
×
1050
        s.defaultMC, err = s.missionController.GetNamespacedStore(
3✔
1051
                routing.DefaultMissionControlNamespace,
3✔
1052
        )
3✔
1053
        if err != nil {
3✔
1054
                return nil, fmt.Errorf("can't create mission control in the "+
×
1055
                        "default namespace: %w", err)
×
1056
        }
×
1057

1058
        srvrLog.Debugf("Instantiating payment session source with config: "+
3✔
1059
                "AttemptCost=%v + %v%%, MinRouteProbability=%v",
3✔
1060
                int64(routingConfig.AttemptCost),
3✔
1061
                float64(routingConfig.AttemptCostPPM)/10000,
3✔
1062
                routingConfig.MinRouteProbability)
3✔
1063

3✔
1064
        pathFindingConfig := routing.PathFindingConfig{
3✔
1065
                AttemptCost: lnwire.NewMSatFromSatoshis(
3✔
1066
                        routingConfig.AttemptCost,
3✔
1067
                ),
3✔
1068
                AttemptCostPPM: routingConfig.AttemptCostPPM,
3✔
1069
                MinProbability: routingConfig.MinRouteProbability,
3✔
1070
        }
3✔
1071

3✔
1072
        sourceNode, err := dbs.GraphDB.SourceNode()
3✔
1073
        if err != nil {
3✔
1074
                return nil, fmt.Errorf("error getting source node: %w", err)
×
1075
        }
×
1076
        paymentSessionSource := &routing.SessionSource{
3✔
1077
                GraphSessionFactory: dbs.GraphDB,
3✔
1078
                SourceNode:          sourceNode,
3✔
1079
                MissionControl:      s.defaultMC,
3✔
1080
                GetLink:             s.htlcSwitch.GetLinkByShortID,
3✔
1081
                PathFindingConfig:   pathFindingConfig,
3✔
1082
        }
3✔
1083

3✔
1084
        paymentControl := channeldb.NewPaymentControl(dbs.ChanStateDB)
3✔
1085

3✔
1086
        s.controlTower = routing.NewControlTower(paymentControl)
3✔
1087

3✔
1088
        strictPruning := cfg.Bitcoin.Node == "neutrino" ||
3✔
1089
                cfg.Routing.StrictZombiePruning
3✔
1090

3✔
1091
        s.graphBuilder, err = graph.NewBuilder(&graph.Config{
3✔
1092
                SelfNode:            selfNode.PubKeyBytes,
3✔
1093
                Graph:               dbs.GraphDB,
3✔
1094
                Chain:               cc.ChainIO,
3✔
1095
                ChainView:           cc.ChainView,
3✔
1096
                Notifier:            cc.ChainNotifier,
3✔
1097
                ChannelPruneExpiry:  graph.DefaultChannelPruneExpiry,
3✔
1098
                GraphPruneInterval:  time.Hour,
3✔
1099
                FirstTimePruneDelay: graph.DefaultFirstTimePruneDelay,
3✔
1100
                AssumeChannelValid:  cfg.Routing.AssumeChannelValid,
3✔
1101
                StrictZombiePruning: strictPruning,
3✔
1102
                IsAlias:             aliasmgr.IsAlias,
3✔
1103
        })
3✔
1104
        if err != nil {
3✔
1105
                return nil, fmt.Errorf("can't create graph builder: %w", err)
×
1106
        }
×
1107

1108
        s.chanRouter, err = routing.New(routing.Config{
3✔
1109
                SelfNode:           selfNode.PubKeyBytes,
3✔
1110
                RoutingGraph:       dbs.GraphDB,
3✔
1111
                Chain:              cc.ChainIO,
3✔
1112
                Payer:              s.htlcSwitch,
3✔
1113
                Control:            s.controlTower,
3✔
1114
                MissionControl:     s.defaultMC,
3✔
1115
                SessionSource:      paymentSessionSource,
3✔
1116
                GetLink:            s.htlcSwitch.GetLinkByShortID,
3✔
1117
                NextPaymentID:      sequencer.NextID,
3✔
1118
                PathFindingConfig:  pathFindingConfig,
3✔
1119
                Clock:              clock.NewDefaultClock(),
3✔
1120
                ApplyChannelUpdate: s.graphBuilder.ApplyChannelUpdate,
3✔
1121
                ClosedSCIDs:        s.fetchClosedChannelSCIDs(),
3✔
1122
                TrafficShaper:      implCfg.TrafficShaper,
3✔
1123
        })
3✔
1124
        if err != nil {
3✔
1125
                return nil, fmt.Errorf("can't create router: %w", err)
×
1126
        }
×
1127

1128
        chanSeries := discovery.NewChanSeries(s.graphDB)
3✔
1129
        gossipMessageStore, err := discovery.NewMessageStore(dbs.ChanStateDB)
3✔
1130
        if err != nil {
3✔
1131
                return nil, err
×
1132
        }
×
1133
        waitingProofStore, err := channeldb.NewWaitingProofStore(dbs.ChanStateDB)
3✔
1134
        if err != nil {
3✔
1135
                return nil, err
×
1136
        }
×
1137

1138
        scidCloserMan := discovery.NewScidCloserMan(s.graphDB, s.chanStateDB)
3✔
1139

3✔
1140
        s.authGossiper = discovery.New(discovery.Config{
3✔
1141
                Graph:                 s.graphBuilder,
3✔
1142
                ChainIO:               s.cc.ChainIO,
3✔
1143
                Notifier:              s.cc.ChainNotifier,
3✔
1144
                ChainHash:             *s.cfg.ActiveNetParams.GenesisHash,
3✔
1145
                Broadcast:             s.BroadcastMessage,
3✔
1146
                ChanSeries:            chanSeries,
3✔
1147
                NotifyWhenOnline:      s.NotifyWhenOnline,
3✔
1148
                NotifyWhenOffline:     s.NotifyWhenOffline,
3✔
1149
                FetchSelfAnnouncement: s.getNodeAnnouncement,
3✔
1150
                UpdateSelfAnnouncement: func() (lnwire.NodeAnnouncement,
3✔
1151
                        error) {
3✔
1152

×
1153
                        return s.genNodeAnnouncement(nil)
×
1154
                },
×
1155
                ProofMatureDelta:        cfg.Gossip.AnnouncementConf,
1156
                TrickleDelay:            time.Millisecond * time.Duration(cfg.TrickleDelay),
1157
                RetransmitTicker:        ticker.New(time.Minute * 30),
1158
                RebroadcastInterval:     time.Hour * 24,
1159
                WaitingProofStore:       waitingProofStore,
1160
                MessageStore:            gossipMessageStore,
1161
                AnnSigner:               s.nodeSigner,
1162
                RotateTicker:            ticker.New(discovery.DefaultSyncerRotationInterval),
1163
                HistoricalSyncTicker:    ticker.New(cfg.HistoricalSyncInterval),
1164
                NumActiveSyncers:        cfg.NumGraphSyncPeers,
1165
                NoTimestampQueries:      cfg.ProtocolOptions.NoTimestampQueryOption, //nolint:ll
1166
                MinimumBatchSize:        10,
1167
                SubBatchDelay:           cfg.Gossip.SubBatchDelay,
1168
                IgnoreHistoricalFilters: cfg.IgnoreHistoricalGossipFilters,
1169
                PinnedSyncers:           cfg.Gossip.PinnedSyncers,
1170
                MaxChannelUpdateBurst:   cfg.Gossip.MaxChannelUpdateBurst,
1171
                ChannelUpdateInterval:   cfg.Gossip.ChannelUpdateInterval,
1172
                IsAlias:                 aliasmgr.IsAlias,
1173
                SignAliasUpdate:         s.signAliasUpdate,
1174
                FindBaseByAlias:         s.aliasMgr.FindBaseSCID,
1175
                GetAlias:                s.aliasMgr.GetPeerAlias,
1176
                FindChannel:             s.findChannel,
1177
                IsStillZombieChannel:    s.graphBuilder.IsZombieChannel,
1178
                ScidCloser:              scidCloserMan,
1179
                AssumeChannelValid:      cfg.Routing.AssumeChannelValid,
1180
                MsgRateBytes:            cfg.Gossip.MsgRateBytes,
1181
                MsgBurstBytes:           cfg.Gossip.MsgBurstBytes,
1182
        }, nodeKeyDesc)
1183

1184
        accessCfg := &accessManConfig{
3✔
1185
                initAccessPerms: func() (map[string]channeldb.ChanCount,
3✔
1186
                        error) {
6✔
1187

3✔
1188
                        genesisHash := *s.cfg.ActiveNetParams.GenesisHash
3✔
1189
                        return s.chanStateDB.FetchPermAndTempPeers(
3✔
1190
                                genesisHash[:],
3✔
1191
                        )
3✔
1192
                },
3✔
1193
                shouldDisconnect:   s.authGossiper.ShouldDisconnect,
1194
                maxRestrictedSlots: int64(s.cfg.NumRestrictedSlots),
1195
        }
1196

1197
        peerAccessMan, err := newAccessMan(accessCfg)
3✔
1198
        if err != nil {
3✔
1199
                return nil, err
×
1200
        }
×
1201

1202
        s.peerAccessMan = peerAccessMan
3✔
1203

3✔
1204
        selfVertex := route.Vertex(nodeKeyDesc.PubKey.SerializeCompressed())
3✔
1205
        //nolint:ll
3✔
1206
        s.localChanMgr = &localchans.Manager{
3✔
1207
                SelfPub:              nodeKeyDesc.PubKey,
3✔
1208
                DefaultRoutingPolicy: cc.RoutingPolicy,
3✔
1209
                ForAllOutgoingChannels: func(cb func(*models.ChannelEdgeInfo,
3✔
1210
                        *models.ChannelEdgePolicy) error) error {
6✔
1211

3✔
1212
                        return s.graphDB.ForEachNodeChannel(selfVertex,
3✔
1213
                                func(_ kvdb.RTx, c *models.ChannelEdgeInfo,
3✔
1214
                                        e *models.ChannelEdgePolicy,
3✔
1215
                                        _ *models.ChannelEdgePolicy) error {
6✔
1216

3✔
1217
                                        // NOTE: The invoked callback here may
3✔
1218
                                        // receive a nil channel policy.
3✔
1219
                                        return cb(c, e)
3✔
1220
                                },
3✔
1221
                        )
1222
                },
1223
                PropagateChanPolicyUpdate: s.authGossiper.PropagateChanPolicyUpdate,
1224
                UpdateForwardingPolicies:  s.htlcSwitch.UpdateForwardingPolicies,
1225
                FetchChannel:              s.chanStateDB.FetchChannel,
1226
                AddEdge: func(edge *models.ChannelEdgeInfo) error {
×
1227
                        return s.graphBuilder.AddEdge(edge)
×
1228
                },
×
1229
        }
1230

1231
        utxnStore, err := contractcourt.NewNurseryStore(
3✔
1232
                s.cfg.ActiveNetParams.GenesisHash, dbs.ChanStateDB,
3✔
1233
        )
3✔
1234
        if err != nil {
3✔
1235
                srvrLog.Errorf("unable to create nursery store: %v", err)
×
1236
                return nil, err
×
1237
        }
×
1238

1239
        sweeperStore, err := sweep.NewSweeperStore(
3✔
1240
                dbs.ChanStateDB, s.cfg.ActiveNetParams.GenesisHash,
3✔
1241
        )
3✔
1242
        if err != nil {
3✔
1243
                srvrLog.Errorf("unable to create sweeper store: %v", err)
×
1244
                return nil, err
×
1245
        }
×
1246

1247
        aggregator := sweep.NewBudgetAggregator(
3✔
1248
                cc.FeeEstimator, sweep.DefaultMaxInputsPerTx,
3✔
1249
                s.implCfg.AuxSweeper,
3✔
1250
        )
3✔
1251

3✔
1252
        s.txPublisher = sweep.NewTxPublisher(sweep.TxPublisherConfig{
3✔
1253
                Signer:     cc.Wallet.Cfg.Signer,
3✔
1254
                Wallet:     cc.Wallet,
3✔
1255
                Estimator:  cc.FeeEstimator,
3✔
1256
                Notifier:   cc.ChainNotifier,
3✔
1257
                AuxSweeper: s.implCfg.AuxSweeper,
3✔
1258
        })
3✔
1259

3✔
1260
        s.sweeper = sweep.New(&sweep.UtxoSweeperConfig{
3✔
1261
                FeeEstimator: cc.FeeEstimator,
3✔
1262
                GenSweepScript: newSweepPkScriptGen(
3✔
1263
                        cc.Wallet, s.cfg.ActiveNetParams.Params,
3✔
1264
                ),
3✔
1265
                Signer:               cc.Wallet.Cfg.Signer,
3✔
1266
                Wallet:               newSweeperWallet(cc.Wallet),
3✔
1267
                Mempool:              cc.MempoolNotifier,
3✔
1268
                Notifier:             cc.ChainNotifier,
3✔
1269
                Store:                sweeperStore,
3✔
1270
                MaxInputsPerTx:       sweep.DefaultMaxInputsPerTx,
3✔
1271
                MaxFeeRate:           cfg.Sweeper.MaxFeeRate,
3✔
1272
                Aggregator:           aggregator,
3✔
1273
                Publisher:            s.txPublisher,
3✔
1274
                NoDeadlineConfTarget: cfg.Sweeper.NoDeadlineConfTarget,
3✔
1275
        })
3✔
1276

3✔
1277
        s.utxoNursery = contractcourt.NewUtxoNursery(&contractcourt.NurseryConfig{
3✔
1278
                ChainIO:             cc.ChainIO,
3✔
1279
                ConfDepth:           1,
3✔
1280
                FetchClosedChannels: s.chanStateDB.FetchClosedChannels,
3✔
1281
                FetchClosedChannel:  s.chanStateDB.FetchClosedChannel,
3✔
1282
                Notifier:            cc.ChainNotifier,
3✔
1283
                PublishTransaction:  cc.Wallet.PublishTransaction,
3✔
1284
                Store:               utxnStore,
3✔
1285
                SweepInput:          s.sweeper.SweepInput,
3✔
1286
                Budget:              s.cfg.Sweeper.Budget,
3✔
1287
        })
3✔
1288

3✔
1289
        // Construct a closure that wraps the htlcswitch's CloseLink method.
3✔
1290
        closeLink := func(chanPoint *wire.OutPoint,
3✔
1291
                closureType contractcourt.ChannelCloseType) {
6✔
1292
                // TODO(conner): Properly respect the update and error channels
3✔
1293
                // returned by CloseLink.
3✔
1294

3✔
1295
                // Instruct the switch to close the channel.  Provide no close out
3✔
1296
                // delivery script or target fee per kw because user input is not
3✔
1297
                // available when the remote peer closes the channel.
3✔
1298
                s.htlcSwitch.CloseLink(
3✔
1299
                        context.Background(), chanPoint, closureType, 0, 0, nil,
3✔
1300
                )
3✔
1301
        }
3✔
1302

1303
        // We will use the following channel to reliably hand off contract
1304
        // breach events from the ChannelArbitrator to the BreachArbitrator,
1305
        contractBreaches := make(chan *contractcourt.ContractBreachEvent, 1)
3✔
1306

3✔
1307
        s.breachArbitrator = contractcourt.NewBreachArbitrator(
3✔
1308
                &contractcourt.BreachConfig{
3✔
1309
                        CloseLink: closeLink,
3✔
1310
                        DB:        s.chanStateDB,
3✔
1311
                        Estimator: s.cc.FeeEstimator,
3✔
1312
                        GenSweepScript: newSweepPkScriptGen(
3✔
1313
                                cc.Wallet, s.cfg.ActiveNetParams.Params,
3✔
1314
                        ),
3✔
1315
                        Notifier:           cc.ChainNotifier,
3✔
1316
                        PublishTransaction: cc.Wallet.PublishTransaction,
3✔
1317
                        ContractBreaches:   contractBreaches,
3✔
1318
                        Signer:             cc.Wallet.Cfg.Signer,
3✔
1319
                        Store: contractcourt.NewRetributionStore(
3✔
1320
                                dbs.ChanStateDB,
3✔
1321
                        ),
3✔
1322
                        AuxSweeper: s.implCfg.AuxSweeper,
3✔
1323
                },
3✔
1324
        )
3✔
1325

3✔
1326
        //nolint:ll
3✔
1327
        s.chainArb = contractcourt.NewChainArbitrator(contractcourt.ChainArbitratorConfig{
3✔
1328
                ChainHash:              *s.cfg.ActiveNetParams.GenesisHash,
3✔
1329
                IncomingBroadcastDelta: lncfg.DefaultIncomingBroadcastDelta,
3✔
1330
                OutgoingBroadcastDelta: lncfg.DefaultOutgoingBroadcastDelta,
3✔
1331
                NewSweepAddr: func() ([]byte, error) {
3✔
1332
                        addr, err := newSweepPkScriptGen(
×
1333
                                cc.Wallet, netParams,
×
1334
                        )().Unpack()
×
1335
                        if err != nil {
×
1336
                                return nil, err
×
1337
                        }
×
1338

1339
                        return addr.DeliveryAddress, nil
×
1340
                },
1341
                PublishTx: cc.Wallet.PublishTransaction,
1342
                DeliverResolutionMsg: func(msgs ...contractcourt.ResolutionMsg) error {
3✔
1343
                        for _, msg := range msgs {
6✔
1344
                                err := s.htlcSwitch.ProcessContractResolution(msg)
3✔
1345
                                if err != nil {
3✔
1346
                                        return err
×
1347
                                }
×
1348
                        }
1349
                        return nil
3✔
1350
                },
1351
                IncubateOutputs: func(chanPoint wire.OutPoint,
1352
                        outHtlcRes fn.Option[lnwallet.OutgoingHtlcResolution],
1353
                        inHtlcRes fn.Option[lnwallet.IncomingHtlcResolution],
1354
                        broadcastHeight uint32,
1355
                        deadlineHeight fn.Option[int32]) error {
3✔
1356

3✔
1357
                        return s.utxoNursery.IncubateOutputs(
3✔
1358
                                chanPoint, outHtlcRes, inHtlcRes,
3✔
1359
                                broadcastHeight, deadlineHeight,
3✔
1360
                        )
3✔
1361
                },
3✔
1362
                PreimageDB:   s.witnessBeacon,
1363
                Notifier:     cc.ChainNotifier,
1364
                Mempool:      cc.MempoolNotifier,
1365
                Signer:       cc.Wallet.Cfg.Signer,
1366
                FeeEstimator: cc.FeeEstimator,
1367
                ChainIO:      cc.ChainIO,
1368
                MarkLinkInactive: func(chanPoint wire.OutPoint) error {
3✔
1369
                        chanID := lnwire.NewChanIDFromOutPoint(chanPoint)
3✔
1370
                        s.htlcSwitch.RemoveLink(chanID)
3✔
1371
                        return nil
3✔
1372
                },
3✔
1373
                IsOurAddress: cc.Wallet.IsOurAddress,
1374
                ContractBreach: func(chanPoint wire.OutPoint,
1375
                        breachRet *lnwallet.BreachRetribution) error {
3✔
1376

3✔
1377
                        // processACK will handle the BreachArbitrator ACKing
3✔
1378
                        // the event.
3✔
1379
                        finalErr := make(chan error, 1)
3✔
1380
                        processACK := func(brarErr error) {
6✔
1381
                                if brarErr != nil {
3✔
1382
                                        finalErr <- brarErr
×
1383
                                        return
×
1384
                                }
×
1385

1386
                                // If the BreachArbitrator successfully handled
1387
                                // the event, we can signal that the handoff
1388
                                // was successful.
1389
                                finalErr <- nil
3✔
1390
                        }
1391

1392
                        event := &contractcourt.ContractBreachEvent{
3✔
1393
                                ChanPoint:         chanPoint,
3✔
1394
                                ProcessACK:        processACK,
3✔
1395
                                BreachRetribution: breachRet,
3✔
1396
                        }
3✔
1397

3✔
1398
                        // Send the contract breach event to the
3✔
1399
                        // BreachArbitrator.
3✔
1400
                        select {
3✔
1401
                        case contractBreaches <- event:
3✔
1402
                        case <-s.quit:
×
1403
                                return ErrServerShuttingDown
×
1404
                        }
1405

1406
                        // We'll wait for a final error to be available from
1407
                        // the BreachArbitrator.
1408
                        select {
3✔
1409
                        case err := <-finalErr:
3✔
1410
                                return err
3✔
1411
                        case <-s.quit:
×
1412
                                return ErrServerShuttingDown
×
1413
                        }
1414
                },
1415
                DisableChannel: func(chanPoint wire.OutPoint) error {
3✔
1416
                        return s.chanStatusMgr.RequestDisable(chanPoint, false)
3✔
1417
                },
3✔
1418
                Sweeper:                       s.sweeper,
1419
                Registry:                      s.invoices,
1420
                NotifyClosedChannel:           s.channelNotifier.NotifyClosedChannelEvent,
1421
                NotifyFullyResolvedChannel:    s.channelNotifier.NotifyFullyResolvedChannelEvent,
1422
                OnionProcessor:                s.sphinx,
1423
                PaymentsExpirationGracePeriod: cfg.PaymentsExpirationGracePeriod,
1424
                IsForwardedHTLC:               s.htlcSwitch.IsForwardedHTLC,
1425
                Clock:                         clock.NewDefaultClock(),
1426
                SubscribeBreachComplete:       s.breachArbitrator.SubscribeBreachComplete,
1427
                PutFinalHtlcOutcome:           s.chanStateDB.PutOnchainFinalHtlcOutcome,
1428
                HtlcNotifier:                  s.htlcNotifier,
1429
                Budget:                        *s.cfg.Sweeper.Budget,
1430

1431
                // TODO(yy): remove this hack once PaymentCircuit is interfaced.
1432
                QueryIncomingCircuit: func(
1433
                        circuit models.CircuitKey) *models.CircuitKey {
3✔
1434

3✔
1435
                        // Get the circuit map.
3✔
1436
                        circuits := s.htlcSwitch.CircuitLookup()
3✔
1437

3✔
1438
                        // Lookup the outgoing circuit.
3✔
1439
                        pc := circuits.LookupOpenCircuit(circuit)
3✔
1440
                        if pc == nil {
5✔
1441
                                return nil
2✔
1442
                        }
2✔
1443

1444
                        return &pc.Incoming
3✔
1445
                },
1446
                AuxLeafStore: implCfg.AuxLeafStore,
1447
                AuxSigner:    implCfg.AuxSigner,
1448
                AuxResolver:  implCfg.AuxContractResolver,
1449
        }, dbs.ChanStateDB)
1450

1451
        // Select the configuration and funding parameters for Bitcoin.
1452
        chainCfg := cfg.Bitcoin
3✔
1453
        minRemoteDelay := funding.MinBtcRemoteDelay
3✔
1454
        maxRemoteDelay := funding.MaxBtcRemoteDelay
3✔
1455

3✔
1456
        var chanIDSeed [32]byte
3✔
1457
        if _, err := rand.Read(chanIDSeed[:]); err != nil {
3✔
1458
                return nil, err
×
1459
        }
×
1460

1461
        // Wrap the DeleteChannelEdges method so that the funding manager can
1462
        // use it without depending on several layers of indirection.
1463
        deleteAliasEdge := func(scid lnwire.ShortChannelID) (
3✔
1464
                *models.ChannelEdgePolicy, error) {
6✔
1465

3✔
1466
                info, e1, e2, err := s.graphDB.FetchChannelEdgesByID(
3✔
1467
                        scid.ToUint64(),
3✔
1468
                )
3✔
1469
                if errors.Is(err, graphdb.ErrEdgeNotFound) {
3✔
1470
                        // This is unlikely but there is a slim chance of this
×
1471
                        // being hit if lnd was killed via SIGKILL and the
×
1472
                        // funding manager was stepping through the delete
×
1473
                        // alias edge logic.
×
1474
                        return nil, nil
×
1475
                } else if err != nil {
3✔
1476
                        return nil, err
×
1477
                }
×
1478

1479
                // Grab our key to find our policy.
1480
                var ourKey [33]byte
3✔
1481
                copy(ourKey[:], nodeKeyDesc.PubKey.SerializeCompressed())
3✔
1482

3✔
1483
                var ourPolicy *models.ChannelEdgePolicy
3✔
1484
                if info != nil && info.NodeKey1Bytes == ourKey {
6✔
1485
                        ourPolicy = e1
3✔
1486
                } else {
6✔
1487
                        ourPolicy = e2
3✔
1488
                }
3✔
1489

1490
                if ourPolicy == nil {
3✔
1491
                        // Something is wrong, so return an error.
×
1492
                        return nil, fmt.Errorf("we don't have an edge")
×
1493
                }
×
1494

1495
                err = s.graphDB.DeleteChannelEdges(
3✔
1496
                        false, false, scid.ToUint64(),
3✔
1497
                )
3✔
1498
                return ourPolicy, err
3✔
1499
        }
1500

1501
        // For the reservationTimeout and the zombieSweeperInterval different
1502
        // values are set in case we are in a dev environment so enhance test
1503
        // capacilities.
1504
        reservationTimeout := chanfunding.DefaultReservationTimeout
3✔
1505
        zombieSweeperInterval := lncfg.DefaultZombieSweeperInterval
3✔
1506

3✔
1507
        // Get the development config for funding manager. If we are not in
3✔
1508
        // development mode, this would be nil.
3✔
1509
        var devCfg *funding.DevConfig
3✔
1510
        if lncfg.IsDevBuild() {
6✔
1511
                devCfg = &funding.DevConfig{
3✔
1512
                        ProcessChannelReadyWait: cfg.Dev.ChannelReadyWait(),
3✔
1513
                        MaxWaitNumBlocksFundingConf: cfg.Dev.
3✔
1514
                                GetMaxWaitNumBlocksFundingConf(),
3✔
1515
                }
3✔
1516

3✔
1517
                reservationTimeout = cfg.Dev.GetReservationTimeout()
3✔
1518
                zombieSweeperInterval = cfg.Dev.GetZombieSweeperInterval()
3✔
1519

3✔
1520
                srvrLog.Debugf("Using the dev config for the fundingMgr: %v, "+
3✔
1521
                        "reservationTimeout=%v, zombieSweeperInterval=%v",
3✔
1522
                        devCfg, reservationTimeout, zombieSweeperInterval)
3✔
1523
        }
3✔
1524

1525
        //nolint:ll
1526
        s.fundingMgr, err = funding.NewFundingManager(funding.Config{
3✔
1527
                Dev:                devCfg,
3✔
1528
                NoWumboChans:       !cfg.ProtocolOptions.Wumbo(),
3✔
1529
                IDKey:              nodeKeyDesc.PubKey,
3✔
1530
                IDKeyLoc:           nodeKeyDesc.KeyLocator,
3✔
1531
                Wallet:             cc.Wallet,
3✔
1532
                PublishTransaction: cc.Wallet.PublishTransaction,
3✔
1533
                UpdateLabel: func(hash chainhash.Hash, label string) error {
6✔
1534
                        return cc.Wallet.LabelTransaction(hash, label, true)
3✔
1535
                },
3✔
1536
                Notifier:     cc.ChainNotifier,
1537
                ChannelDB:    s.chanStateDB,
1538
                FeeEstimator: cc.FeeEstimator,
1539
                SignMessage:  cc.MsgSigner.SignMessage,
1540
                CurrentNodeAnnouncement: func() (lnwire.NodeAnnouncement,
1541
                        error) {
3✔
1542

3✔
1543
                        return s.genNodeAnnouncement(nil)
3✔
1544
                },
3✔
1545
                SendAnnouncement:     s.authGossiper.ProcessLocalAnnouncement,
1546
                NotifyWhenOnline:     s.NotifyWhenOnline,
1547
                TempChanIDSeed:       chanIDSeed,
1548
                FindChannel:          s.findChannel,
1549
                DefaultRoutingPolicy: cc.RoutingPolicy,
1550
                DefaultMinHtlcIn:     cc.MinHtlcIn,
1551
                NumRequiredConfs: func(chanAmt btcutil.Amount,
1552
                        pushAmt lnwire.MilliSatoshi) uint16 {
3✔
1553
                        // For large channels we increase the number
3✔
1554
                        // of confirmations we require for the
3✔
1555
                        // channel to be considered open. As it is
3✔
1556
                        // always the responder that gets to choose
3✔
1557
                        // value, the pushAmt is value being pushed
3✔
1558
                        // to us. This means we have more to lose
3✔
1559
                        // in the case this gets re-orged out, and
3✔
1560
                        // we will require more confirmations before
3✔
1561
                        // we consider it open.
3✔
1562

3✔
1563
                        // In case the user has explicitly specified
3✔
1564
                        // a default value for the number of
3✔
1565
                        // confirmations, we use it.
3✔
1566
                        defaultConf := uint16(chainCfg.DefaultNumChanConfs)
3✔
1567
                        if defaultConf != 0 {
6✔
1568
                                return defaultConf
3✔
1569
                        }
3✔
1570

1571
                        minConf := uint64(3)
×
1572
                        maxConf := uint64(6)
×
1573

×
1574
                        // If this is a wumbo channel, then we'll require the
×
1575
                        // max amount of confirmations.
×
1576
                        if chanAmt > MaxFundingAmount {
×
1577
                                return uint16(maxConf)
×
1578
                        }
×
1579

1580
                        // If not we return a value scaled linearly
1581
                        // between 3 and 6, depending on channel size.
1582
                        // TODO(halseth): Use 1 as minimum?
1583
                        maxChannelSize := uint64(
×
1584
                                lnwire.NewMSatFromSatoshis(MaxFundingAmount))
×
1585
                        stake := lnwire.NewMSatFromSatoshis(chanAmt) + pushAmt
×
1586
                        conf := maxConf * uint64(stake) / maxChannelSize
×
1587
                        if conf < minConf {
×
1588
                                conf = minConf
×
1589
                        }
×
1590
                        if conf > maxConf {
×
1591
                                conf = maxConf
×
1592
                        }
×
1593
                        return uint16(conf)
×
1594
                },
1595
                RequiredRemoteDelay: func(chanAmt btcutil.Amount) uint16 {
3✔
1596
                        // We scale the remote CSV delay (the time the
3✔
1597
                        // remote have to claim funds in case of a unilateral
3✔
1598
                        // close) linearly from minRemoteDelay blocks
3✔
1599
                        // for small channels, to maxRemoteDelay blocks
3✔
1600
                        // for channels of size MaxFundingAmount.
3✔
1601

3✔
1602
                        // In case the user has explicitly specified
3✔
1603
                        // a default value for the remote delay, we
3✔
1604
                        // use it.
3✔
1605
                        defaultDelay := uint16(chainCfg.DefaultRemoteDelay)
3✔
1606
                        if defaultDelay > 0 {
6✔
1607
                                return defaultDelay
3✔
1608
                        }
3✔
1609

1610
                        // If this is a wumbo channel, then we'll require the
1611
                        // max value.
1612
                        if chanAmt > MaxFundingAmount {
×
1613
                                return maxRemoteDelay
×
1614
                        }
×
1615

1616
                        // If not we scale according to channel size.
1617
                        delay := uint16(btcutil.Amount(maxRemoteDelay) *
×
1618
                                chanAmt / MaxFundingAmount)
×
1619
                        if delay < minRemoteDelay {
×
1620
                                delay = minRemoteDelay
×
1621
                        }
×
1622
                        if delay > maxRemoteDelay {
×
1623
                                delay = maxRemoteDelay
×
1624
                        }
×
1625
                        return delay
×
1626
                },
1627
                WatchNewChannel: func(channel *channeldb.OpenChannel,
1628
                        peerKey *btcec.PublicKey) error {
3✔
1629

3✔
1630
                        // First, we'll mark this new peer as a persistent peer
3✔
1631
                        // for re-connection purposes. If the peer is not yet
3✔
1632
                        // tracked or the user hasn't requested it to be perm,
3✔
1633
                        // we'll set false to prevent the server from continuing
3✔
1634
                        // to connect to this peer even if the number of
3✔
1635
                        // channels with this peer is zero.
3✔
1636
                        s.mu.Lock()
3✔
1637
                        pubStr := string(peerKey.SerializeCompressed())
3✔
1638
                        if _, ok := s.persistentPeers[pubStr]; !ok {
6✔
1639
                                s.persistentPeers[pubStr] = false
3✔
1640
                        }
3✔
1641
                        s.mu.Unlock()
3✔
1642

3✔
1643
                        // With that taken care of, we'll send this channel to
3✔
1644
                        // the chain arb so it can react to on-chain events.
3✔
1645
                        return s.chainArb.WatchNewChannel(channel)
3✔
1646
                },
1647
                ReportShortChanID: func(chanPoint wire.OutPoint) error {
3✔
1648
                        cid := lnwire.NewChanIDFromOutPoint(chanPoint)
3✔
1649
                        return s.htlcSwitch.UpdateShortChanID(cid)
3✔
1650
                },
3✔
1651
                RequiredRemoteChanReserve: func(chanAmt,
1652
                        dustLimit btcutil.Amount) btcutil.Amount {
3✔
1653

3✔
1654
                        // By default, we'll require the remote peer to maintain
3✔
1655
                        // at least 1% of the total channel capacity at all
3✔
1656
                        // times. If this value ends up dipping below the dust
3✔
1657
                        // limit, then we'll use the dust limit itself as the
3✔
1658
                        // reserve as required by BOLT #2.
3✔
1659
                        reserve := chanAmt / 100
3✔
1660
                        if reserve < dustLimit {
6✔
1661
                                reserve = dustLimit
3✔
1662
                        }
3✔
1663

1664
                        return reserve
3✔
1665
                },
1666
                RequiredRemoteMaxValue: func(chanAmt btcutil.Amount) lnwire.MilliSatoshi {
3✔
1667
                        // By default, we'll allow the remote peer to fully
3✔
1668
                        // utilize the full bandwidth of the channel, minus our
3✔
1669
                        // required reserve.
3✔
1670
                        reserve := lnwire.NewMSatFromSatoshis(chanAmt / 100)
3✔
1671
                        return lnwire.NewMSatFromSatoshis(chanAmt) - reserve
3✔
1672
                },
3✔
1673
                RequiredRemoteMaxHTLCs: func(chanAmt btcutil.Amount) uint16 {
3✔
1674
                        if cfg.DefaultRemoteMaxHtlcs > 0 {
6✔
1675
                                return cfg.DefaultRemoteMaxHtlcs
3✔
1676
                        }
3✔
1677

1678
                        // By default, we'll permit them to utilize the full
1679
                        // channel bandwidth.
1680
                        return uint16(input.MaxHTLCNumber / 2)
×
1681
                },
1682
                ZombieSweeperInterval:         zombieSweeperInterval,
1683
                ReservationTimeout:            reservationTimeout,
1684
                MinChanSize:                   btcutil.Amount(cfg.MinChanSize),
1685
                MaxChanSize:                   btcutil.Amount(cfg.MaxChanSize),
1686
                MaxPendingChannels:            cfg.MaxPendingChannels,
1687
                RejectPush:                    cfg.RejectPush,
1688
                MaxLocalCSVDelay:              chainCfg.MaxLocalDelay,
1689
                NotifyOpenChannelEvent:        s.notifyOpenChannelPeerEvent,
1690
                OpenChannelPredicate:          chanPredicate,
1691
                NotifyPendingOpenChannelEvent: s.notifyPendingOpenChannelPeerEvent,
1692
                NotifyFundingTimeout:          s.notifyFundingTimeoutPeerEvent,
1693
                EnableUpfrontShutdown:         cfg.EnableUpfrontShutdown,
1694
                MaxAnchorsCommitFeeRate: chainfee.SatPerKVByte(
1695
                        s.cfg.MaxCommitFeeRateAnchors * 1000).FeePerKWeight(),
1696
                DeleteAliasEdge:      deleteAliasEdge,
1697
                AliasManager:         s.aliasMgr,
1698
                IsSweeperOutpoint:    s.sweeper.IsSweeperOutpoint,
1699
                AuxFundingController: implCfg.AuxFundingController,
1700
                AuxSigner:            implCfg.AuxSigner,
1701
                AuxResolver:          implCfg.AuxContractResolver,
1702
        })
1703
        if err != nil {
3✔
1704
                return nil, err
×
1705
        }
×
1706

1707
        // Next, we'll assemble the sub-system that will maintain an on-disk
1708
        // static backup of the latest channel state.
1709
        chanNotifier := &channelNotifier{
3✔
1710
                chanNotifier: s.channelNotifier,
3✔
1711
                addrs:        s.addrSource,
3✔
1712
        }
3✔
1713
        backupFile := chanbackup.NewMultiFile(
3✔
1714
                cfg.BackupFilePath, cfg.NoBackupArchive,
3✔
1715
        )
3✔
1716
        startingChans, err := chanbackup.FetchStaticChanBackups(
3✔
1717
                s.chanStateDB, s.addrSource,
3✔
1718
        )
3✔
1719
        if err != nil {
3✔
1720
                return nil, err
×
1721
        }
×
1722
        s.chanSubSwapper, err = chanbackup.NewSubSwapper(
3✔
1723
                startingChans, chanNotifier, s.cc.KeyRing, backupFile,
3✔
1724
        )
3✔
1725
        if err != nil {
3✔
1726
                return nil, err
×
1727
        }
×
1728

1729
        // Assemble a peer notifier which will provide clients with subscriptions
1730
        // to peer online and offline events.
1731
        s.peerNotifier = peernotifier.New()
3✔
1732

3✔
1733
        // Create a channel event store which monitors all open channels.
3✔
1734
        s.chanEventStore = chanfitness.NewChannelEventStore(&chanfitness.Config{
3✔
1735
                SubscribeChannelEvents: func() (subscribe.Subscription, error) {
6✔
1736
                        return s.channelNotifier.SubscribeChannelEvents()
3✔
1737
                },
3✔
1738
                SubscribePeerEvents: func() (subscribe.Subscription, error) {
3✔
1739
                        return s.peerNotifier.SubscribePeerEvents()
3✔
1740
                },
3✔
1741
                GetOpenChannels: s.chanStateDB.FetchAllOpenChannels,
1742
                Clock:           clock.NewDefaultClock(),
1743
                ReadFlapCount:   s.miscDB.ReadFlapCount,
1744
                WriteFlapCount:  s.miscDB.WriteFlapCounts,
1745
                FlapCountTicker: ticker.New(chanfitness.FlapCountFlushRate),
1746
        })
1747

1748
        if cfg.WtClient.Active {
6✔
1749
                policy := wtpolicy.DefaultPolicy()
3✔
1750
                policy.MaxUpdates = cfg.WtClient.MaxUpdates
3✔
1751

3✔
1752
                // We expose the sweep fee rate in sat/vbyte, but the tower
3✔
1753
                // protocol operations on sat/kw.
3✔
1754
                sweepRateSatPerVByte := chainfee.SatPerKVByte(
3✔
1755
                        1000 * cfg.WtClient.SweepFeeRate,
3✔
1756
                )
3✔
1757

3✔
1758
                policy.SweepFeeRate = sweepRateSatPerVByte.FeePerKWeight()
3✔
1759

3✔
1760
                if err := policy.Validate(); err != nil {
3✔
1761
                        return nil, err
×
1762
                }
×
1763

1764
                // authDial is the wrapper around the btrontide.Dial for the
1765
                // watchtower.
1766
                authDial := func(localKey keychain.SingleKeyECDH,
3✔
1767
                        netAddr *lnwire.NetAddress,
3✔
1768
                        dialer tor.DialFunc) (wtserver.Peer, error) {
6✔
1769

3✔
1770
                        return brontide.Dial(
3✔
1771
                                localKey, netAddr, cfg.ConnectionTimeout, dialer,
3✔
1772
                        )
3✔
1773
                }
3✔
1774

1775
                // buildBreachRetribution is a call-back that can be used to
1776
                // query the BreachRetribution info and channel type given a
1777
                // channel ID and commitment height.
1778
                buildBreachRetribution := func(chanID lnwire.ChannelID,
3✔
1779
                        commitHeight uint64) (*lnwallet.BreachRetribution,
3✔
1780
                        channeldb.ChannelType, error) {
6✔
1781

3✔
1782
                        channel, err := s.chanStateDB.FetchChannelByID(
3✔
1783
                                nil, chanID,
3✔
1784
                        )
3✔
1785
                        if err != nil {
3✔
1786
                                return nil, 0, err
×
1787
                        }
×
1788

1789
                        br, err := lnwallet.NewBreachRetribution(
3✔
1790
                                channel, commitHeight, 0, nil,
3✔
1791
                                implCfg.AuxLeafStore,
3✔
1792
                                implCfg.AuxContractResolver,
3✔
1793
                        )
3✔
1794
                        if err != nil {
3✔
1795
                                return nil, 0, err
×
1796
                        }
×
1797

1798
                        return br, channel.ChanType, nil
3✔
1799
                }
1800

1801
                fetchClosedChannel := s.chanStateDB.FetchClosedChannelForID
3✔
1802

3✔
1803
                // Copy the policy for legacy channels and set the blob flag
3✔
1804
                // signalling support for anchor channels.
3✔
1805
                anchorPolicy := policy
3✔
1806
                anchorPolicy.BlobType |= blob.Type(blob.FlagAnchorChannel)
3✔
1807

3✔
1808
                // Copy the policy for legacy channels and set the blob flag
3✔
1809
                // signalling support for taproot channels.
3✔
1810
                taprootPolicy := policy
3✔
1811
                taprootPolicy.TxPolicy.BlobType |= blob.Type(
3✔
1812
                        blob.FlagTaprootChannel,
3✔
1813
                )
3✔
1814

3✔
1815
                s.towerClientMgr, err = wtclient.NewManager(&wtclient.Config{
3✔
1816
                        FetchClosedChannel:     fetchClosedChannel,
3✔
1817
                        BuildBreachRetribution: buildBreachRetribution,
3✔
1818
                        SessionCloseRange:      cfg.WtClient.SessionCloseRange,
3✔
1819
                        ChainNotifier:          s.cc.ChainNotifier,
3✔
1820
                        SubscribeChannelEvents: func() (subscribe.Subscription,
3✔
1821
                                error) {
6✔
1822

3✔
1823
                                return s.channelNotifier.
3✔
1824
                                        SubscribeChannelEvents()
3✔
1825
                        },
3✔
1826
                        Signer: cc.Wallet.Cfg.Signer,
1827
                        NewAddress: func() ([]byte, error) {
3✔
1828
                                addr, err := newSweepPkScriptGen(
3✔
1829
                                        cc.Wallet, netParams,
3✔
1830
                                )().Unpack()
3✔
1831
                                if err != nil {
3✔
1832
                                        return nil, err
×
1833
                                }
×
1834

1835
                                return addr.DeliveryAddress, nil
3✔
1836
                        },
1837
                        SecretKeyRing:      s.cc.KeyRing,
1838
                        Dial:               cfg.net.Dial,
1839
                        AuthDial:           authDial,
1840
                        DB:                 dbs.TowerClientDB,
1841
                        ChainHash:          *s.cfg.ActiveNetParams.GenesisHash,
1842
                        MinBackoff:         10 * time.Second,
1843
                        MaxBackoff:         5 * time.Minute,
1844
                        MaxTasksInMemQueue: cfg.WtClient.MaxTasksInMemQueue,
1845
                }, policy, anchorPolicy, taprootPolicy)
1846
                if err != nil {
3✔
1847
                        return nil, err
×
1848
                }
×
1849
        }
1850

1851
        if len(cfg.ExternalHosts) != 0 {
3✔
1852
                advertisedIPs := make(map[string]struct{})
×
1853
                for _, addr := range s.currentNodeAnn.Addresses {
×
1854
                        advertisedIPs[addr.String()] = struct{}{}
×
1855
                }
×
1856

1857
                s.hostAnn = netann.NewHostAnnouncer(netann.HostAnnouncerConfig{
×
1858
                        Hosts:         cfg.ExternalHosts,
×
1859
                        RefreshTicker: ticker.New(defaultHostSampleInterval),
×
1860
                        LookupHost: func(host string) (net.Addr, error) {
×
1861
                                return lncfg.ParseAddressString(
×
1862
                                        host, strconv.Itoa(defaultPeerPort),
×
1863
                                        cfg.net.ResolveTCPAddr,
×
1864
                                )
×
1865
                        },
×
1866
                        AdvertisedIPs: advertisedIPs,
1867
                        AnnounceNewIPs: netann.IPAnnouncer(
1868
                                func(modifier ...netann.NodeAnnModifier) (
1869
                                        lnwire.NodeAnnouncement, error) {
×
1870

×
1871
                                        return s.genNodeAnnouncement(
×
1872
                                                nil, modifier...,
×
1873
                                        )
×
1874
                                }),
×
1875
                })
1876
        }
1877

1878
        // Create liveness monitor.
1879
        s.createLivenessMonitor(cfg, cc, leaderElector)
3✔
1880

3✔
1881
        listeners := make([]net.Listener, len(listenAddrs))
3✔
1882
        for i, listenAddr := range listenAddrs {
6✔
1883
                // Note: though brontide.NewListener uses ResolveTCPAddr, it
3✔
1884
                // doesn't need to call the general lndResolveTCP function
3✔
1885
                // since we are resolving a local address.
3✔
1886

3✔
1887
                // RESOLVE: We are actually partially accepting inbound
3✔
1888
                // connection requests when we call NewListener.
3✔
1889
                listeners[i], err = brontide.NewListener(
3✔
1890
                        nodeKeyECDH, listenAddr.String(),
3✔
1891
                        s.peerAccessMan.checkIncomingConnBanScore,
3✔
1892
                )
3✔
1893
                if err != nil {
3✔
1894
                        return nil, err
×
1895
                }
×
1896
        }
1897

1898
        // Create the connection manager which will be responsible for
1899
        // maintaining persistent outbound connections and also accepting new
1900
        // incoming connections
1901
        cmgr, err := connmgr.New(&connmgr.Config{
3✔
1902
                Listeners:      listeners,
3✔
1903
                OnAccept:       s.InboundPeerConnected,
3✔
1904
                RetryDuration:  time.Second * 5,
3✔
1905
                TargetOutbound: 100,
3✔
1906
                Dial: noiseDial(
3✔
1907
                        nodeKeyECDH, s.cfg.net, s.cfg.ConnectionTimeout,
3✔
1908
                ),
3✔
1909
                OnConnection: s.OutboundPeerConnected,
3✔
1910
        })
3✔
1911
        if err != nil {
3✔
1912
                return nil, err
×
1913
        }
×
1914
        s.connMgr = cmgr
3✔
1915

3✔
1916
        // Finally, register the subsystems in blockbeat.
3✔
1917
        s.registerBlockConsumers()
3✔
1918

3✔
1919
        return s, nil
3✔
1920
}
1921

1922
// UpdateRoutingConfig is a callback function to update the routing config
1923
// values in the main cfg.
1924
func (s *server) UpdateRoutingConfig(cfg *routing.MissionControlConfig) {
3✔
1925
        routerCfg := s.cfg.SubRPCServers.RouterRPC
3✔
1926

3✔
1927
        switch c := cfg.Estimator.Config().(type) {
3✔
1928
        case routing.AprioriConfig:
3✔
1929
                routerCfg.ProbabilityEstimatorType =
3✔
1930
                        routing.AprioriEstimatorName
3✔
1931

3✔
1932
                targetCfg := routerCfg.AprioriConfig
3✔
1933
                targetCfg.PenaltyHalfLife = c.PenaltyHalfLife
3✔
1934
                targetCfg.Weight = c.AprioriWeight
3✔
1935
                targetCfg.CapacityFraction = c.CapacityFraction
3✔
1936
                targetCfg.HopProbability = c.AprioriHopProbability
3✔
1937

1938
        case routing.BimodalConfig:
3✔
1939
                routerCfg.ProbabilityEstimatorType =
3✔
1940
                        routing.BimodalEstimatorName
3✔
1941

3✔
1942
                targetCfg := routerCfg.BimodalConfig
3✔
1943
                targetCfg.Scale = int64(c.BimodalScaleMsat)
3✔
1944
                targetCfg.NodeWeight = c.BimodalNodeWeight
3✔
1945
                targetCfg.DecayTime = c.BimodalDecayTime
3✔
1946
        }
1947

1948
        routerCfg.MaxMcHistory = cfg.MaxMcHistory
3✔
1949
}
1950

1951
// registerBlockConsumers registers the subsystems that consume block events.
1952
// By calling `RegisterQueue`, a list of subsystems are registered in the
1953
// blockbeat for block notifications. When a new block arrives, the subsystems
1954
// in the same queue are notified sequentially, and different queues are
1955
// notified concurrently.
1956
//
1957
// NOTE: To put a subsystem in a different queue, create a slice and pass it to
1958
// a new `RegisterQueue` call.
1959
func (s *server) registerBlockConsumers() {
3✔
1960
        // In this queue, when a new block arrives, it will be received and
3✔
1961
        // processed in this order: chainArb -> sweeper -> txPublisher.
3✔
1962
        consumers := []chainio.Consumer{
3✔
1963
                s.chainArb,
3✔
1964
                s.sweeper,
3✔
1965
                s.txPublisher,
3✔
1966
        }
3✔
1967
        s.blockbeatDispatcher.RegisterQueue(consumers)
3✔
1968
}
3✔
1969

1970
// signAliasUpdate takes a ChannelUpdate and returns the signature. This is
1971
// used for option_scid_alias channels where the ChannelUpdate to be sent back
1972
// may differ from what is on disk.
1973
func (s *server) signAliasUpdate(u *lnwire.ChannelUpdate1) (*ecdsa.Signature,
1974
        error) {
3✔
1975

3✔
1976
        data, err := u.DataToSign()
3✔
1977
        if err != nil {
3✔
1978
                return nil, err
×
1979
        }
×
1980

1981
        return s.cc.MsgSigner.SignMessage(s.identityKeyLoc, data, true)
3✔
1982
}
1983

1984
// createLivenessMonitor creates a set of health checks using our configured
1985
// values and uses these checks to create a liveness monitor. Available
1986
// health checks,
1987
//   - chainHealthCheck (will be disabled for --nochainbackend mode)
1988
//   - diskCheck
1989
//   - tlsHealthCheck
1990
//   - torController, only created when tor is enabled.
1991
//
1992
// If a health check has been disabled by setting attempts to 0, our monitor
1993
// will not run it.
1994
func (s *server) createLivenessMonitor(cfg *Config, cc *chainreg.ChainControl,
1995
        leaderElector cluster.LeaderElector) {
3✔
1996

3✔
1997
        chainBackendAttempts := cfg.HealthChecks.ChainCheck.Attempts
3✔
1998
        if cfg.Bitcoin.Node == "nochainbackend" {
3✔
1999
                srvrLog.Info("Disabling chain backend checks for " +
×
2000
                        "nochainbackend mode")
×
2001

×
2002
                chainBackendAttempts = 0
×
2003
        }
×
2004

2005
        chainHealthCheck := healthcheck.NewObservation(
3✔
2006
                "chain backend",
3✔
2007
                cc.HealthCheck,
3✔
2008
                cfg.HealthChecks.ChainCheck.Interval,
3✔
2009
                cfg.HealthChecks.ChainCheck.Timeout,
3✔
2010
                cfg.HealthChecks.ChainCheck.Backoff,
3✔
2011
                chainBackendAttempts,
3✔
2012
        )
3✔
2013

3✔
2014
        diskCheck := healthcheck.NewObservation(
3✔
2015
                "disk space",
3✔
2016
                func() error {
3✔
2017
                        free, err := healthcheck.AvailableDiskSpaceRatio(
×
2018
                                cfg.LndDir,
×
2019
                        )
×
2020
                        if err != nil {
×
2021
                                return err
×
2022
                        }
×
2023

2024
                        // If we have more free space than we require,
2025
                        // we return a nil error.
2026
                        if free > cfg.HealthChecks.DiskCheck.RequiredRemaining {
×
2027
                                return nil
×
2028
                        }
×
2029

2030
                        return fmt.Errorf("require: %v free space, got: %v",
×
2031
                                cfg.HealthChecks.DiskCheck.RequiredRemaining,
×
2032
                                free)
×
2033
                },
2034
                cfg.HealthChecks.DiskCheck.Interval,
2035
                cfg.HealthChecks.DiskCheck.Timeout,
2036
                cfg.HealthChecks.DiskCheck.Backoff,
2037
                cfg.HealthChecks.DiskCheck.Attempts,
2038
        )
2039

2040
        tlsHealthCheck := healthcheck.NewObservation(
3✔
2041
                "tls",
3✔
2042
                func() error {
3✔
2043
                        expired, expTime, err := s.tlsManager.IsCertExpired(
×
2044
                                s.cc.KeyRing,
×
2045
                        )
×
2046
                        if err != nil {
×
2047
                                return err
×
2048
                        }
×
2049
                        if expired {
×
2050
                                return fmt.Errorf("TLS certificate is "+
×
2051
                                        "expired as of %v", expTime)
×
2052
                        }
×
2053

2054
                        // If the certificate is not outdated, no error needs
2055
                        // to be returned
2056
                        return nil
×
2057
                },
2058
                cfg.HealthChecks.TLSCheck.Interval,
2059
                cfg.HealthChecks.TLSCheck.Timeout,
2060
                cfg.HealthChecks.TLSCheck.Backoff,
2061
                cfg.HealthChecks.TLSCheck.Attempts,
2062
        )
2063

2064
        checks := []*healthcheck.Observation{
3✔
2065
                chainHealthCheck, diskCheck, tlsHealthCheck,
3✔
2066
        }
3✔
2067

3✔
2068
        // If Tor is enabled, add the healthcheck for tor connection.
3✔
2069
        if s.torController != nil {
3✔
2070
                torConnectionCheck := healthcheck.NewObservation(
×
2071
                        "tor connection",
×
2072
                        func() error {
×
2073
                                return healthcheck.CheckTorServiceStatus(
×
2074
                                        s.torController,
×
2075
                                        s.createNewHiddenService,
×
2076
                                )
×
2077
                        },
×
2078
                        cfg.HealthChecks.TorConnection.Interval,
2079
                        cfg.HealthChecks.TorConnection.Timeout,
2080
                        cfg.HealthChecks.TorConnection.Backoff,
2081
                        cfg.HealthChecks.TorConnection.Attempts,
2082
                )
2083
                checks = append(checks, torConnectionCheck)
×
2084
        }
2085

2086
        // If remote signing is enabled, add the healthcheck for the remote
2087
        // signing RPC interface.
2088
        if s.cfg.RemoteSigner != nil && s.cfg.RemoteSigner.Enable {
6✔
2089
                // Because we have two cascading timeouts here, we need to add
3✔
2090
                // some slack to the "outer" one of them in case the "inner"
3✔
2091
                // returns exactly on time.
3✔
2092
                overhead := time.Millisecond * 10
3✔
2093

3✔
2094
                remoteSignerConnectionCheck := healthcheck.NewObservation(
3✔
2095
                        "remote signer connection",
3✔
2096
                        rpcwallet.HealthCheck(
3✔
2097
                                s.cfg.RemoteSigner,
3✔
2098

3✔
2099
                                // For the health check we might to be even
3✔
2100
                                // stricter than the initial/normal connect, so
3✔
2101
                                // we use the health check timeout here.
3✔
2102
                                cfg.HealthChecks.RemoteSigner.Timeout,
3✔
2103
                        ),
3✔
2104
                        cfg.HealthChecks.RemoteSigner.Interval,
3✔
2105
                        cfg.HealthChecks.RemoteSigner.Timeout+overhead,
3✔
2106
                        cfg.HealthChecks.RemoteSigner.Backoff,
3✔
2107
                        cfg.HealthChecks.RemoteSigner.Attempts,
3✔
2108
                )
3✔
2109
                checks = append(checks, remoteSignerConnectionCheck)
3✔
2110
        }
3✔
2111

2112
        // If we have a leader elector, we add a health check to ensure we are
2113
        // still the leader. During normal operation, we should always be the
2114
        // leader, but there are circumstances where this may change, such as
2115
        // when we lose network connectivity for long enough expiring out lease.
2116
        if leaderElector != nil {
3✔
2117
                leaderCheck := healthcheck.NewObservation(
×
2118
                        "leader status",
×
2119
                        func() error {
×
2120
                                // Check if we are still the leader. Note that
×
2121
                                // we don't need to use a timeout context here
×
2122
                                // as the healthcheck observer will handle the
×
2123
                                // timeout case for us.
×
2124
                                timeoutCtx, cancel := context.WithTimeout(
×
2125
                                        context.Background(),
×
2126
                                        cfg.HealthChecks.LeaderCheck.Timeout,
×
2127
                                )
×
2128
                                defer cancel()
×
2129

×
2130
                                leader, err := leaderElector.IsLeader(
×
2131
                                        timeoutCtx,
×
2132
                                )
×
2133
                                if err != nil {
×
2134
                                        return fmt.Errorf("unable to check if "+
×
2135
                                                "still leader: %v", err)
×
2136
                                }
×
2137

2138
                                if !leader {
×
2139
                                        srvrLog.Debug("Not the current leader")
×
2140
                                        return fmt.Errorf("not the current " +
×
2141
                                                "leader")
×
2142
                                }
×
2143

2144
                                return nil
×
2145
                        },
2146
                        cfg.HealthChecks.LeaderCheck.Interval,
2147
                        cfg.HealthChecks.LeaderCheck.Timeout,
2148
                        cfg.HealthChecks.LeaderCheck.Backoff,
2149
                        cfg.HealthChecks.LeaderCheck.Attempts,
2150
                )
2151

2152
                checks = append(checks, leaderCheck)
×
2153
        }
2154

2155
        // If we have not disabled all of our health checks, we create a
2156
        // liveness monitor with our configured checks.
2157
        s.livenessMonitor = healthcheck.NewMonitor(
3✔
2158
                &healthcheck.Config{
3✔
2159
                        Checks:   checks,
3✔
2160
                        Shutdown: srvrLog.Criticalf,
3✔
2161
                },
3✔
2162
        )
3✔
2163
}
2164

2165
// Started returns true if the server has been started, and false otherwise.
2166
// NOTE: This function is safe for concurrent access.
2167
func (s *server) Started() bool {
3✔
2168
        return atomic.LoadInt32(&s.active) != 0
3✔
2169
}
3✔
2170

2171
// cleaner is used to aggregate "cleanup" functions during an operation that
2172
// starts several subsystems. In case one of the subsystem fails to start
2173
// and a proper resource cleanup is required, the "run" method achieves this
2174
// by running all these added "cleanup" functions.
2175
type cleaner []func() error
2176

2177
// add is used to add a cleanup function to be called when
2178
// the run function is executed.
2179
func (c cleaner) add(cleanup func() error) cleaner {
3✔
2180
        return append(c, cleanup)
3✔
2181
}
3✔
2182

2183
// run is used to run all the previousely added cleanup functions.
2184
func (c cleaner) run() {
×
2185
        for i := len(c) - 1; i >= 0; i-- {
×
2186
                if err := c[i](); err != nil {
×
2187
                        srvrLog.Errorf("Cleanup failed: %v", err)
×
2188
                }
×
2189
        }
2190
}
2191

2192
// startLowLevelServices starts the low-level services of the server. These
2193
// services must be started successfully before running the main server. The
2194
// services are,
2195
// 1. the chain notifier.
2196
//
2197
// TODO(yy): identify and add more low-level services here.
2198
func (s *server) startLowLevelServices() error {
3✔
2199
        var startErr error
3✔
2200

3✔
2201
        cleanup := cleaner{}
3✔
2202

3✔
2203
        cleanup = cleanup.add(s.cc.ChainNotifier.Stop)
3✔
2204
        if err := s.cc.ChainNotifier.Start(); err != nil {
3✔
2205
                startErr = err
×
2206
        }
×
2207

2208
        if startErr != nil {
3✔
2209
                cleanup.run()
×
2210
        }
×
2211

2212
        return startErr
3✔
2213
}
2214

2215
// Start starts the main daemon server, all requested listeners, and any helper
2216
// goroutines.
2217
// NOTE: This function is safe for concurrent access.
2218
//
2219
//nolint:funlen
2220
func (s *server) Start() error {
3✔
2221
        // Get the current blockbeat.
3✔
2222
        beat, err := s.getStartingBeat()
3✔
2223
        if err != nil {
3✔
2224
                return err
×
2225
        }
×
2226

2227
        var startErr error
3✔
2228

3✔
2229
        // If one sub system fails to start, the following code ensures that the
3✔
2230
        // previous started ones are stopped. It also ensures a proper wallet
3✔
2231
        // shutdown which is important for releasing its resources (boltdb, etc...)
3✔
2232
        cleanup := cleaner{}
3✔
2233

3✔
2234
        s.start.Do(func() {
6✔
2235
                cleanup = cleanup.add(s.customMessageServer.Stop)
3✔
2236
                if err := s.customMessageServer.Start(); err != nil {
3✔
2237
                        startErr = err
×
2238
                        return
×
2239
                }
×
2240

2241
                if s.hostAnn != nil {
3✔
2242
                        cleanup = cleanup.add(s.hostAnn.Stop)
×
2243
                        if err := s.hostAnn.Start(); err != nil {
×
2244
                                startErr = err
×
2245
                                return
×
2246
                        }
×
2247
                }
2248

2249
                if s.livenessMonitor != nil {
6✔
2250
                        cleanup = cleanup.add(s.livenessMonitor.Stop)
3✔
2251
                        if err := s.livenessMonitor.Start(); err != nil {
3✔
2252
                                startErr = err
×
2253
                                return
×
2254
                        }
×
2255
                }
2256

2257
                // Start the notification server. This is used so channel
2258
                // management goroutines can be notified when a funding
2259
                // transaction reaches a sufficient number of confirmations, or
2260
                // when the input for the funding transaction is spent in an
2261
                // attempt at an uncooperative close by the counterparty.
2262
                cleanup = cleanup.add(s.sigPool.Stop)
3✔
2263
                if err := s.sigPool.Start(); err != nil {
3✔
2264
                        startErr = err
×
2265
                        return
×
2266
                }
×
2267

2268
                cleanup = cleanup.add(s.writePool.Stop)
3✔
2269
                if err := s.writePool.Start(); err != nil {
3✔
2270
                        startErr = err
×
2271
                        return
×
2272
                }
×
2273

2274
                cleanup = cleanup.add(s.readPool.Stop)
3✔
2275
                if err := s.readPool.Start(); err != nil {
3✔
2276
                        startErr = err
×
2277
                        return
×
2278
                }
×
2279

2280
                cleanup = cleanup.add(s.cc.BestBlockTracker.Stop)
3✔
2281
                if err := s.cc.BestBlockTracker.Start(); err != nil {
3✔
2282
                        startErr = err
×
2283
                        return
×
2284
                }
×
2285

2286
                cleanup = cleanup.add(s.channelNotifier.Stop)
3✔
2287
                if err := s.channelNotifier.Start(); err != nil {
3✔
2288
                        startErr = err
×
2289
                        return
×
2290
                }
×
2291

2292
                cleanup = cleanup.add(func() error {
3✔
2293
                        return s.peerNotifier.Stop()
×
2294
                })
×
2295
                if err := s.peerNotifier.Start(); err != nil {
3✔
2296
                        startErr = err
×
2297
                        return
×
2298
                }
×
2299

2300
                cleanup = cleanup.add(s.htlcNotifier.Stop)
3✔
2301
                if err := s.htlcNotifier.Start(); err != nil {
3✔
2302
                        startErr = err
×
2303
                        return
×
2304
                }
×
2305

2306
                if s.towerClientMgr != nil {
6✔
2307
                        cleanup = cleanup.add(s.towerClientMgr.Stop)
3✔
2308
                        if err := s.towerClientMgr.Start(); err != nil {
3✔
2309
                                startErr = err
×
2310
                                return
×
2311
                        }
×
2312
                }
2313

2314
                cleanup = cleanup.add(s.txPublisher.Stop)
3✔
2315
                if err := s.txPublisher.Start(beat); err != nil {
3✔
2316
                        startErr = err
×
2317
                        return
×
2318
                }
×
2319

2320
                cleanup = cleanup.add(s.sweeper.Stop)
3✔
2321
                if err := s.sweeper.Start(beat); err != nil {
3✔
2322
                        startErr = err
×
2323
                        return
×
2324
                }
×
2325

2326
                cleanup = cleanup.add(s.utxoNursery.Stop)
3✔
2327
                if err := s.utxoNursery.Start(); err != nil {
3✔
2328
                        startErr = err
×
2329
                        return
×
2330
                }
×
2331

2332
                cleanup = cleanup.add(s.breachArbitrator.Stop)
3✔
2333
                if err := s.breachArbitrator.Start(); err != nil {
3✔
2334
                        startErr = err
×
2335
                        return
×
2336
                }
×
2337

2338
                cleanup = cleanup.add(s.fundingMgr.Stop)
3✔
2339
                if err := s.fundingMgr.Start(); err != nil {
3✔
2340
                        startErr = err
×
2341
                        return
×
2342
                }
×
2343

2344
                // htlcSwitch must be started before chainArb since the latter
2345
                // relies on htlcSwitch to deliver resolution message upon
2346
                // start.
2347
                cleanup = cleanup.add(s.htlcSwitch.Stop)
3✔
2348
                if err := s.htlcSwitch.Start(); err != nil {
3✔
2349
                        startErr = err
×
2350
                        return
×
2351
                }
×
2352

2353
                cleanup = cleanup.add(s.interceptableSwitch.Stop)
3✔
2354
                if err := s.interceptableSwitch.Start(); err != nil {
3✔
2355
                        startErr = err
×
2356
                        return
×
2357
                }
×
2358

2359
                cleanup = cleanup.add(s.invoiceHtlcModifier.Stop)
3✔
2360
                if err := s.invoiceHtlcModifier.Start(); err != nil {
3✔
2361
                        startErr = err
×
2362
                        return
×
2363
                }
×
2364

2365
                cleanup = cleanup.add(s.chainArb.Stop)
3✔
2366
                if err := s.chainArb.Start(beat); err != nil {
3✔
2367
                        startErr = err
×
2368
                        return
×
2369
                }
×
2370

2371
                cleanup = cleanup.add(s.graphDB.Stop)
3✔
2372
                if err := s.graphDB.Start(); err != nil {
3✔
2373
                        startErr = err
×
2374
                        return
×
2375
                }
×
2376

2377
                cleanup = cleanup.add(s.graphBuilder.Stop)
3✔
2378
                if err := s.graphBuilder.Start(); err != nil {
3✔
2379
                        startErr = err
×
2380
                        return
×
2381
                }
×
2382

2383
                cleanup = cleanup.add(s.chanRouter.Stop)
3✔
2384
                if err := s.chanRouter.Start(); err != nil {
3✔
2385
                        startErr = err
×
2386
                        return
×
2387
                }
×
2388
                // The authGossiper depends on the chanRouter and therefore
2389
                // should be started after it.
2390
                cleanup = cleanup.add(s.authGossiper.Stop)
3✔
2391
                if err := s.authGossiper.Start(); err != nil {
3✔
2392
                        startErr = err
×
2393
                        return
×
2394
                }
×
2395

2396
                cleanup = cleanup.add(s.invoices.Stop)
3✔
2397
                if err := s.invoices.Start(); err != nil {
3✔
2398
                        startErr = err
×
2399
                        return
×
2400
                }
×
2401

2402
                cleanup = cleanup.add(s.sphinx.Stop)
3✔
2403
                if err := s.sphinx.Start(); err != nil {
3✔
2404
                        startErr = err
×
2405
                        return
×
2406
                }
×
2407

2408
                cleanup = cleanup.add(s.chanStatusMgr.Stop)
3✔
2409
                if err := s.chanStatusMgr.Start(); err != nil {
3✔
2410
                        startErr = err
×
2411
                        return
×
2412
                }
×
2413

2414
                cleanup = cleanup.add(s.chanEventStore.Stop)
3✔
2415
                if err := s.chanEventStore.Start(); err != nil {
3✔
2416
                        startErr = err
×
2417
                        return
×
2418
                }
×
2419

2420
                cleanup.add(func() error {
3✔
2421
                        s.missionController.StopStoreTickers()
×
2422
                        return nil
×
2423
                })
×
2424
                s.missionController.RunStoreTickers()
3✔
2425

3✔
2426
                // Before we start the connMgr, we'll check to see if we have
3✔
2427
                // any backups to recover. We do this now as we want to ensure
3✔
2428
                // that have all the information we need to handle channel
3✔
2429
                // recovery _before_ we even accept connections from any peers.
3✔
2430
                chanRestorer := &chanDBRestorer{
3✔
2431
                        db:         s.chanStateDB,
3✔
2432
                        secretKeys: s.cc.KeyRing,
3✔
2433
                        chainArb:   s.chainArb,
3✔
2434
                }
3✔
2435
                if len(s.chansToRestore.PackedSingleChanBackups) != 0 {
3✔
2436
                        _, err := chanbackup.UnpackAndRecoverSingles(
×
2437
                                s.chansToRestore.PackedSingleChanBackups,
×
2438
                                s.cc.KeyRing, chanRestorer, s,
×
2439
                        )
×
2440
                        if err != nil {
×
2441
                                startErr = fmt.Errorf("unable to unpack single "+
×
2442
                                        "backups: %v", err)
×
2443
                                return
×
2444
                        }
×
2445
                }
2446
                if len(s.chansToRestore.PackedMultiChanBackup) != 0 {
6✔
2447
                        _, err := chanbackup.UnpackAndRecoverMulti(
3✔
2448
                                s.chansToRestore.PackedMultiChanBackup,
3✔
2449
                                s.cc.KeyRing, chanRestorer, s,
3✔
2450
                        )
3✔
2451
                        if err != nil {
3✔
2452
                                startErr = fmt.Errorf("unable to unpack chan "+
×
2453
                                        "backup: %v", err)
×
2454
                                return
×
2455
                        }
×
2456
                }
2457

2458
                // chanSubSwapper must be started after the `channelNotifier`
2459
                // because it depends on channel events as a synchronization
2460
                // point.
2461
                cleanup = cleanup.add(s.chanSubSwapper.Stop)
3✔
2462
                if err := s.chanSubSwapper.Start(); err != nil {
3✔
2463
                        startErr = err
×
2464
                        return
×
2465
                }
×
2466

2467
                if s.torController != nil {
3✔
2468
                        cleanup = cleanup.add(s.torController.Stop)
×
2469
                        if err := s.createNewHiddenService(); err != nil {
×
2470
                                startErr = err
×
2471
                                return
×
2472
                        }
×
2473
                }
2474

2475
                if s.natTraversal != nil {
3✔
2476
                        s.wg.Add(1)
×
2477
                        go s.watchExternalIP()
×
2478
                }
×
2479

2480
                // Start connmgr last to prevent connections before init.
2481
                cleanup = cleanup.add(func() error {
3✔
2482
                        s.connMgr.Stop()
×
2483
                        return nil
×
2484
                })
×
2485

2486
                // RESOLVE: s.connMgr.Start() is called here, but
2487
                // brontide.NewListener() is called in newServer. This means
2488
                // that we are actually listening and partially accepting
2489
                // inbound connections even before the connMgr starts.
2490
                //
2491
                // TODO(yy): move the log into the connMgr's `Start` method.
2492
                srvrLog.Info("connMgr starting...")
3✔
2493
                s.connMgr.Start()
3✔
2494
                srvrLog.Debug("connMgr started")
3✔
2495

3✔
2496
                // If peers are specified as a config option, we'll add those
3✔
2497
                // peers first.
3✔
2498
                for _, peerAddrCfg := range s.cfg.AddPeers {
6✔
2499
                        parsedPubkey, parsedHost, err := lncfg.ParseLNAddressPubkey(
3✔
2500
                                peerAddrCfg,
3✔
2501
                        )
3✔
2502
                        if err != nil {
3✔
2503
                                startErr = fmt.Errorf("unable to parse peer "+
×
2504
                                        "pubkey from config: %v", err)
×
2505
                                return
×
2506
                        }
×
2507
                        addr, err := parseAddr(parsedHost, s.cfg.net)
3✔
2508
                        if err != nil {
3✔
2509
                                startErr = fmt.Errorf("unable to parse peer "+
×
2510
                                        "address provided as a config option: "+
×
2511
                                        "%v", err)
×
2512
                                return
×
2513
                        }
×
2514

2515
                        peerAddr := &lnwire.NetAddress{
3✔
2516
                                IdentityKey: parsedPubkey,
3✔
2517
                                Address:     addr,
3✔
2518
                                ChainNet:    s.cfg.ActiveNetParams.Net,
3✔
2519
                        }
3✔
2520

3✔
2521
                        err = s.ConnectToPeer(
3✔
2522
                                peerAddr, true,
3✔
2523
                                s.cfg.ConnectionTimeout,
3✔
2524
                        )
3✔
2525
                        if err != nil {
3✔
2526
                                startErr = fmt.Errorf("unable to connect to "+
×
2527
                                        "peer address provided as a config "+
×
2528
                                        "option: %v", err)
×
2529
                                return
×
2530
                        }
×
2531
                }
2532

2533
                // Subscribe to NodeAnnouncements that advertise new addresses
2534
                // our persistent peers.
2535
                if err := s.updatePersistentPeerAddrs(); err != nil {
3✔
2536
                        srvrLog.Errorf("Failed to update persistent peer "+
×
2537
                                "addr: %v", err)
×
2538

×
2539
                        startErr = err
×
2540
                        return
×
2541
                }
×
2542

2543
                // With all the relevant sub-systems started, we'll now attempt
2544
                // to establish persistent connections to our direct channel
2545
                // collaborators within the network. Before doing so however,
2546
                // we'll prune our set of link nodes found within the database
2547
                // to ensure we don't reconnect to any nodes we no longer have
2548
                // open channels with.
2549
                if err := s.chanStateDB.PruneLinkNodes(); err != nil {
3✔
2550
                        srvrLog.Errorf("Failed to prune link nodes: %v", err)
×
2551

×
2552
                        startErr = err
×
2553
                        return
×
2554
                }
×
2555

2556
                if err := s.establishPersistentConnections(); err != nil {
3✔
2557
                        srvrLog.Errorf("Failed to establish persistent "+
×
2558
                                "connections: %v", err)
×
2559
                }
×
2560

2561
                // setSeedList is a helper function that turns multiple DNS seed
2562
                // server tuples from the command line or config file into the
2563
                // data structure we need and does a basic formal sanity check
2564
                // in the process.
2565
                setSeedList := func(tuples []string, genesisHash chainhash.Hash) {
3✔
2566
                        if len(tuples) == 0 {
×
2567
                                return
×
2568
                        }
×
2569

2570
                        result := make([][2]string, len(tuples))
×
2571
                        for idx, tuple := range tuples {
×
2572
                                tuple = strings.TrimSpace(tuple)
×
2573
                                if len(tuple) == 0 {
×
2574
                                        return
×
2575
                                }
×
2576

2577
                                servers := strings.Split(tuple, ",")
×
2578
                                if len(servers) > 2 || len(servers) == 0 {
×
2579
                                        srvrLog.Warnf("Ignoring invalid DNS "+
×
2580
                                                "seed tuple: %v", servers)
×
2581
                                        return
×
2582
                                }
×
2583

2584
                                copy(result[idx][:], servers)
×
2585
                        }
2586

2587
                        chainreg.ChainDNSSeeds[genesisHash] = result
×
2588
                }
2589

2590
                // Let users overwrite the DNS seed nodes. We only allow them
2591
                // for bitcoin mainnet/testnet/signet.
2592
                if s.cfg.Bitcoin.MainNet {
3✔
2593
                        setSeedList(
×
2594
                                s.cfg.Bitcoin.DNSSeeds,
×
2595
                                chainreg.BitcoinMainnetGenesis,
×
2596
                        )
×
2597
                }
×
2598
                if s.cfg.Bitcoin.TestNet3 {
3✔
2599
                        setSeedList(
×
2600
                                s.cfg.Bitcoin.DNSSeeds,
×
2601
                                chainreg.BitcoinTestnetGenesis,
×
2602
                        )
×
2603
                }
×
2604
                if s.cfg.Bitcoin.TestNet4 {
3✔
2605
                        setSeedList(
×
2606
                                s.cfg.Bitcoin.DNSSeeds,
×
2607
                                chainreg.BitcoinTestnet4Genesis,
×
2608
                        )
×
2609
                }
×
2610
                if s.cfg.Bitcoin.SigNet {
3✔
2611
                        setSeedList(
×
2612
                                s.cfg.Bitcoin.DNSSeeds,
×
2613
                                chainreg.BitcoinSignetGenesis,
×
2614
                        )
×
2615
                }
×
2616

2617
                // If network bootstrapping hasn't been disabled, then we'll
2618
                // configure the set of active bootstrappers, and launch a
2619
                // dedicated goroutine to maintain a set of persistent
2620
                // connections.
2621
                if shouldPeerBootstrap(s.cfg) {
3✔
2622
                        bootstrappers, err := initNetworkBootstrappers(s)
×
2623
                        if err != nil {
×
2624
                                startErr = err
×
2625
                                return
×
2626
                        }
×
2627

2628
                        s.wg.Add(1)
×
2629
                        go s.peerBootstrapper(defaultMinPeers, bootstrappers)
×
2630
                } else {
3✔
2631
                        srvrLog.Infof("Auto peer bootstrapping is disabled")
3✔
2632
                }
3✔
2633

2634
                // Start the blockbeat after all other subsystems have been
2635
                // started so they are ready to receive new blocks.
2636
                cleanup = cleanup.add(func() error {
3✔
2637
                        s.blockbeatDispatcher.Stop()
×
2638
                        return nil
×
2639
                })
×
2640
                if err := s.blockbeatDispatcher.Start(); err != nil {
3✔
2641
                        startErr = err
×
2642
                        return
×
2643
                }
×
2644

2645
                // Set the active flag now that we've completed the full
2646
                // startup.
2647
                atomic.StoreInt32(&s.active, 1)
3✔
2648
        })
2649

2650
        if startErr != nil {
3✔
2651
                cleanup.run()
×
2652
        }
×
2653
        return startErr
3✔
2654
}
2655

2656
// Stop gracefully shutsdown the main daemon server. This function will signal
2657
// any active goroutines, or helper objects to exit, then blocks until they've
2658
// all successfully exited. Additionally, any/all listeners are closed.
2659
// NOTE: This function is safe for concurrent access.
2660
func (s *server) Stop() error {
3✔
2661
        s.stop.Do(func() {
6✔
2662
                atomic.StoreInt32(&s.stopping, 1)
3✔
2663

3✔
2664
                close(s.quit)
3✔
2665

3✔
2666
                // Shutdown connMgr first to prevent conns during shutdown.
3✔
2667
                s.connMgr.Stop()
3✔
2668

3✔
2669
                // Stop dispatching blocks to other systems immediately.
3✔
2670
                s.blockbeatDispatcher.Stop()
3✔
2671

3✔
2672
                // Shutdown the wallet, funding manager, and the rpc server.
3✔
2673
                if err := s.chanStatusMgr.Stop(); err != nil {
3✔
2674
                        srvrLog.Warnf("failed to stop chanStatusMgr: %v", err)
×
2675
                }
×
2676
                if err := s.htlcSwitch.Stop(); err != nil {
3✔
2677
                        srvrLog.Warnf("failed to stop htlcSwitch: %v", err)
×
2678
                }
×
2679
                if err := s.sphinx.Stop(); err != nil {
3✔
2680
                        srvrLog.Warnf("failed to stop sphinx: %v", err)
×
2681
                }
×
2682
                if err := s.invoices.Stop(); err != nil {
3✔
2683
                        srvrLog.Warnf("failed to stop invoices: %v", err)
×
2684
                }
×
2685
                if err := s.interceptableSwitch.Stop(); err != nil {
3✔
2686
                        srvrLog.Warnf("failed to stop interceptable "+
×
2687
                                "switch: %v", err)
×
2688
                }
×
2689
                if err := s.invoiceHtlcModifier.Stop(); err != nil {
3✔
2690
                        srvrLog.Warnf("failed to stop htlc invoices "+
×
2691
                                "modifier: %v", err)
×
2692
                }
×
2693
                if err := s.chanRouter.Stop(); err != nil {
3✔
2694
                        srvrLog.Warnf("failed to stop chanRouter: %v", err)
×
2695
                }
×
2696
                if err := s.graphBuilder.Stop(); err != nil {
3✔
2697
                        srvrLog.Warnf("failed to stop graphBuilder %v", err)
×
2698
                }
×
2699
                if err := s.graphDB.Stop(); err != nil {
3✔
2700
                        srvrLog.Warnf("failed to stop graphDB %v", err)
×
2701
                }
×
2702
                if err := s.chainArb.Stop(); err != nil {
3✔
2703
                        srvrLog.Warnf("failed to stop chainArb: %v", err)
×
2704
                }
×
2705
                if err := s.fundingMgr.Stop(); err != nil {
3✔
2706
                        srvrLog.Warnf("failed to stop fundingMgr: %v", err)
×
2707
                }
×
2708
                if err := s.breachArbitrator.Stop(); err != nil {
3✔
2709
                        srvrLog.Warnf("failed to stop breachArbitrator: %v",
×
2710
                                err)
×
2711
                }
×
2712
                if err := s.utxoNursery.Stop(); err != nil {
3✔
2713
                        srvrLog.Warnf("failed to stop utxoNursery: %v", err)
×
2714
                }
×
2715
                if err := s.authGossiper.Stop(); err != nil {
3✔
2716
                        srvrLog.Warnf("failed to stop authGossiper: %v", err)
×
2717
                }
×
2718
                if err := s.sweeper.Stop(); err != nil {
3✔
2719
                        srvrLog.Warnf("failed to stop sweeper: %v", err)
×
2720
                }
×
2721
                if err := s.txPublisher.Stop(); err != nil {
3✔
2722
                        srvrLog.Warnf("failed to stop txPublisher: %v", err)
×
2723
                }
×
2724
                if err := s.channelNotifier.Stop(); err != nil {
3✔
2725
                        srvrLog.Warnf("failed to stop channelNotifier: %v", err)
×
2726
                }
×
2727
                if err := s.peerNotifier.Stop(); err != nil {
3✔
2728
                        srvrLog.Warnf("failed to stop peerNotifier: %v", err)
×
2729
                }
×
2730
                if err := s.htlcNotifier.Stop(); err != nil {
3✔
2731
                        srvrLog.Warnf("failed to stop htlcNotifier: %v", err)
×
2732
                }
×
2733

2734
                // Update channel.backup file. Make sure to do it before
2735
                // stopping chanSubSwapper.
2736
                singles, err := chanbackup.FetchStaticChanBackups(
3✔
2737
                        s.chanStateDB, s.addrSource,
3✔
2738
                )
3✔
2739
                if err != nil {
3✔
2740
                        srvrLog.Warnf("failed to fetch channel states: %v",
×
2741
                                err)
×
2742
                } else {
3✔
2743
                        err := s.chanSubSwapper.ManualUpdate(singles)
3✔
2744
                        if err != nil {
6✔
2745
                                srvrLog.Warnf("Manual update of channel "+
3✔
2746
                                        "backup failed: %v", err)
3✔
2747
                        }
3✔
2748
                }
2749

2750
                if err := s.chanSubSwapper.Stop(); err != nil {
3✔
2751
                        srvrLog.Warnf("failed to stop chanSubSwapper: %v", err)
×
2752
                }
×
2753
                if err := s.cc.ChainNotifier.Stop(); err != nil {
3✔
2754
                        srvrLog.Warnf("Unable to stop ChainNotifier: %v", err)
×
2755
                }
×
2756
                if err := s.cc.BestBlockTracker.Stop(); err != nil {
3✔
2757
                        srvrLog.Warnf("Unable to stop BestBlockTracker: %v",
×
2758
                                err)
×
2759
                }
×
2760
                if err := s.chanEventStore.Stop(); err != nil {
3✔
2761
                        srvrLog.Warnf("Unable to stop ChannelEventStore: %v",
×
2762
                                err)
×
2763
                }
×
2764
                s.missionController.StopStoreTickers()
3✔
2765

3✔
2766
                // Disconnect from each active peers to ensure that
3✔
2767
                // peerTerminationWatchers signal completion to each peer.
3✔
2768
                for _, peer := range s.Peers() {
6✔
2769
                        err := s.DisconnectPeer(peer.IdentityKey())
3✔
2770
                        if err != nil {
3✔
2771
                                srvrLog.Warnf("could not disconnect peer: %v"+
×
2772
                                        "received error: %v", peer.IdentityKey(),
×
2773
                                        err,
×
2774
                                )
×
2775
                        }
×
2776
                }
2777

2778
                // Now that all connections have been torn down, stop the tower
2779
                // client which will reliably flush all queued states to the
2780
                // tower. If this is halted for any reason, the force quit timer
2781
                // will kick in and abort to allow this method to return.
2782
                if s.towerClientMgr != nil {
6✔
2783
                        if err := s.towerClientMgr.Stop(); err != nil {
3✔
2784
                                srvrLog.Warnf("Unable to shut down tower "+
×
2785
                                        "client manager: %v", err)
×
2786
                        }
×
2787
                }
2788

2789
                if s.hostAnn != nil {
3✔
2790
                        if err := s.hostAnn.Stop(); err != nil {
×
2791
                                srvrLog.Warnf("unable to shut down host "+
×
2792
                                        "annoucner: %v", err)
×
2793
                        }
×
2794
                }
2795

2796
                if s.livenessMonitor != nil {
6✔
2797
                        if err := s.livenessMonitor.Stop(); err != nil {
3✔
2798
                                srvrLog.Warnf("unable to shutdown liveness "+
×
2799
                                        "monitor: %v", err)
×
2800
                        }
×
2801
                }
2802

2803
                // Wait for all lingering goroutines to quit.
2804
                srvrLog.Debug("Waiting for server to shutdown...")
3✔
2805
                s.wg.Wait()
3✔
2806

3✔
2807
                srvrLog.Debug("Stopping buffer pools...")
3✔
2808
                s.sigPool.Stop()
3✔
2809
                s.writePool.Stop()
3✔
2810
                s.readPool.Stop()
3✔
2811
        })
2812

2813
        return nil
3✔
2814
}
2815

2816
// Stopped returns true if the server has been instructed to shutdown.
2817
// NOTE: This function is safe for concurrent access.
2818
func (s *server) Stopped() bool {
3✔
2819
        return atomic.LoadInt32(&s.stopping) != 0
3✔
2820
}
3✔
2821

2822
// configurePortForwarding attempts to set up port forwarding for the different
2823
// ports that the server will be listening on.
2824
//
2825
// NOTE: This should only be used when using some kind of NAT traversal to
2826
// automatically set up forwarding rules.
2827
func (s *server) configurePortForwarding(ports ...uint16) ([]string, error) {
×
2828
        ip, err := s.natTraversal.ExternalIP()
×
2829
        if err != nil {
×
2830
                return nil, err
×
2831
        }
×
2832
        s.lastDetectedIP = ip
×
2833

×
2834
        externalIPs := make([]string, 0, len(ports))
×
2835
        for _, port := range ports {
×
2836
                if err := s.natTraversal.AddPortMapping(port); err != nil {
×
2837
                        srvrLog.Debugf("Unable to forward port %d: %v", port, err)
×
2838
                        continue
×
2839
                }
2840

2841
                hostIP := fmt.Sprintf("%v:%d", ip, port)
×
2842
                externalIPs = append(externalIPs, hostIP)
×
2843
        }
2844

2845
        return externalIPs, nil
×
2846
}
2847

2848
// removePortForwarding attempts to clear the forwarding rules for the different
2849
// ports the server is currently listening on.
2850
//
2851
// NOTE: This should only be used when using some kind of NAT traversal to
2852
// automatically set up forwarding rules.
2853
func (s *server) removePortForwarding() {
×
2854
        forwardedPorts := s.natTraversal.ForwardedPorts()
×
2855
        for _, port := range forwardedPorts {
×
2856
                if err := s.natTraversal.DeletePortMapping(port); err != nil {
×
2857
                        srvrLog.Errorf("Unable to remove forwarding rules for "+
×
2858
                                "port %d: %v", port, err)
×
2859
                }
×
2860
        }
2861
}
2862

2863
// watchExternalIP continuously checks for an updated external IP address every
2864
// 15 minutes. Once a new IP address has been detected, it will automatically
2865
// handle port forwarding rules and send updated node announcements to the
2866
// currently connected peers.
2867
//
2868
// NOTE: This MUST be run as a goroutine.
2869
func (s *server) watchExternalIP() {
×
2870
        defer s.wg.Done()
×
2871

×
2872
        // Before exiting, we'll make sure to remove the forwarding rules set
×
2873
        // up by the server.
×
2874
        defer s.removePortForwarding()
×
2875

×
2876
        // Keep track of the external IPs set by the user to avoid replacing
×
2877
        // them when detecting a new IP.
×
2878
        ipsSetByUser := make(map[string]struct{})
×
2879
        for _, ip := range s.cfg.ExternalIPs {
×
2880
                ipsSetByUser[ip.String()] = struct{}{}
×
2881
        }
×
2882

2883
        forwardedPorts := s.natTraversal.ForwardedPorts()
×
2884

×
2885
        ticker := time.NewTicker(15 * time.Minute)
×
2886
        defer ticker.Stop()
×
2887
out:
×
2888
        for {
×
2889
                select {
×
2890
                case <-ticker.C:
×
2891
                        // We'll start off by making sure a new IP address has
×
2892
                        // been detected.
×
2893
                        ip, err := s.natTraversal.ExternalIP()
×
2894
                        if err != nil {
×
2895
                                srvrLog.Debugf("Unable to retrieve the "+
×
2896
                                        "external IP address: %v", err)
×
2897
                                continue
×
2898
                        }
2899

2900
                        // Periodically renew the NAT port forwarding.
2901
                        for _, port := range forwardedPorts {
×
2902
                                err := s.natTraversal.AddPortMapping(port)
×
2903
                                if err != nil {
×
2904
                                        srvrLog.Warnf("Unable to automatically "+
×
2905
                                                "re-create port forwarding using %s: %v",
×
2906
                                                s.natTraversal.Name(), err)
×
2907
                                } else {
×
2908
                                        srvrLog.Debugf("Automatically re-created "+
×
2909
                                                "forwarding for port %d using %s to "+
×
2910
                                                "advertise external IP",
×
2911
                                                port, s.natTraversal.Name())
×
2912
                                }
×
2913
                        }
2914

2915
                        if ip.Equal(s.lastDetectedIP) {
×
2916
                                continue
×
2917
                        }
2918

2919
                        srvrLog.Infof("Detected new external IP address %s", ip)
×
2920

×
2921
                        // Next, we'll craft the new addresses that will be
×
2922
                        // included in the new node announcement and advertised
×
2923
                        // to the network. Each address will consist of the new
×
2924
                        // IP detected and one of the currently advertised
×
2925
                        // ports.
×
2926
                        var newAddrs []net.Addr
×
2927
                        for _, port := range forwardedPorts {
×
2928
                                hostIP := fmt.Sprintf("%v:%d", ip, port)
×
2929
                                addr, err := net.ResolveTCPAddr("tcp", hostIP)
×
2930
                                if err != nil {
×
2931
                                        srvrLog.Debugf("Unable to resolve "+
×
2932
                                                "host %v: %v", addr, err)
×
2933
                                        continue
×
2934
                                }
2935

2936
                                newAddrs = append(newAddrs, addr)
×
2937
                        }
2938

2939
                        // Skip the update if we weren't able to resolve any of
2940
                        // the new addresses.
2941
                        if len(newAddrs) == 0 {
×
2942
                                srvrLog.Debug("Skipping node announcement " +
×
2943
                                        "update due to not being able to " +
×
2944
                                        "resolve any new addresses")
×
2945
                                continue
×
2946
                        }
2947

2948
                        // Now, we'll need to update the addresses in our node's
2949
                        // announcement in order to propagate the update
2950
                        // throughout the network. We'll only include addresses
2951
                        // that have a different IP from the previous one, as
2952
                        // the previous IP is no longer valid.
2953
                        currentNodeAnn := s.getNodeAnnouncement()
×
2954

×
2955
                        for _, addr := range currentNodeAnn.Addresses {
×
2956
                                host, _, err := net.SplitHostPort(addr.String())
×
2957
                                if err != nil {
×
2958
                                        srvrLog.Debugf("Unable to determine "+
×
2959
                                                "host from address %v: %v",
×
2960
                                                addr, err)
×
2961
                                        continue
×
2962
                                }
2963

2964
                                // We'll also make sure to include external IPs
2965
                                // set manually by the user.
2966
                                _, setByUser := ipsSetByUser[addr.String()]
×
2967
                                if setByUser || host != s.lastDetectedIP.String() {
×
2968
                                        newAddrs = append(newAddrs, addr)
×
2969
                                }
×
2970
                        }
2971

2972
                        // Then, we'll generate a new timestamped node
2973
                        // announcement with the updated addresses and broadcast
2974
                        // it to our peers.
2975
                        newNodeAnn, err := s.genNodeAnnouncement(
×
2976
                                nil, netann.NodeAnnSetAddrs(newAddrs),
×
2977
                        )
×
2978
                        if err != nil {
×
2979
                                srvrLog.Debugf("Unable to generate new node "+
×
2980
                                        "announcement: %v", err)
×
2981
                                continue
×
2982
                        }
2983

2984
                        err = s.BroadcastMessage(nil, &newNodeAnn)
×
2985
                        if err != nil {
×
2986
                                srvrLog.Debugf("Unable to broadcast new node "+
×
2987
                                        "announcement to peers: %v", err)
×
2988
                                continue
×
2989
                        }
2990

2991
                        // Finally, update the last IP seen to the current one.
2992
                        s.lastDetectedIP = ip
×
2993
                case <-s.quit:
×
2994
                        break out
×
2995
                }
2996
        }
2997
}
2998

2999
// initNetworkBootstrappers initializes a set of network peer bootstrappers
3000
// based on the server, and currently active bootstrap mechanisms as defined
3001
// within the current configuration.
3002
func initNetworkBootstrappers(s *server) ([]discovery.NetworkPeerBootstrapper, error) {
×
3003
        srvrLog.Infof("Initializing peer network bootstrappers!")
×
3004

×
3005
        var bootStrappers []discovery.NetworkPeerBootstrapper
×
3006

×
3007
        // First, we'll create an instance of the ChannelGraphBootstrapper as
×
3008
        // this can be used by default if we've already partially seeded the
×
3009
        // network.
×
3010
        chanGraph := autopilot.ChannelGraphFromDatabase(s.graphDB)
×
3011
        graphBootstrapper, err := discovery.NewGraphBootstrapper(chanGraph)
×
3012
        if err != nil {
×
3013
                return nil, err
×
3014
        }
×
3015
        bootStrappers = append(bootStrappers, graphBootstrapper)
×
3016

×
3017
        // If this isn't simnet mode, then one of our additional bootstrapping
×
3018
        // sources will be the set of running DNS seeds.
×
3019
        if !s.cfg.Bitcoin.SimNet {
×
3020
                dnsSeeds, ok := chainreg.ChainDNSSeeds[*s.cfg.ActiveNetParams.GenesisHash]
×
3021

×
3022
                // If we have a set of DNS seeds for this chain, then we'll add
×
3023
                // it as an additional bootstrapping source.
×
3024
                if ok {
×
3025
                        srvrLog.Infof("Creating DNS peer bootstrapper with "+
×
3026
                                "seeds: %v", dnsSeeds)
×
3027

×
3028
                        dnsBootStrapper := discovery.NewDNSSeedBootstrapper(
×
3029
                                dnsSeeds, s.cfg.net, s.cfg.ConnectionTimeout,
×
3030
                        )
×
3031
                        bootStrappers = append(bootStrappers, dnsBootStrapper)
×
3032
                }
×
3033
        }
3034

3035
        return bootStrappers, nil
×
3036
}
3037

3038
// createBootstrapIgnorePeers creates a map of peers that the bootstrap process
3039
// needs to ignore, which is made of three parts,
3040
//   - the node itself needs to be skipped as it doesn't make sense to connect
3041
//     to itself.
3042
//   - the peers that already have connections with, as in s.peersByPub.
3043
//   - the peers that we are attempting to connect, as in s.persistentPeers.
3044
func (s *server) createBootstrapIgnorePeers() map[autopilot.NodeID]struct{} {
×
3045
        s.mu.RLock()
×
3046
        defer s.mu.RUnlock()
×
3047

×
3048
        ignore := make(map[autopilot.NodeID]struct{})
×
3049

×
3050
        // We should ignore ourselves from bootstrapping.
×
3051
        selfKey := autopilot.NewNodeID(s.identityECDH.PubKey())
×
3052
        ignore[selfKey] = struct{}{}
×
3053

×
3054
        // Ignore all connected peers.
×
3055
        for _, peer := range s.peersByPub {
×
3056
                nID := autopilot.NewNodeID(peer.IdentityKey())
×
3057
                ignore[nID] = struct{}{}
×
3058
        }
×
3059

3060
        // Ignore all persistent peers as they have a dedicated reconnecting
3061
        // process.
3062
        for pubKeyStr := range s.persistentPeers {
×
3063
                var nID autopilot.NodeID
×
3064
                copy(nID[:], []byte(pubKeyStr))
×
3065
                ignore[nID] = struct{}{}
×
3066
        }
×
3067

3068
        return ignore
×
3069
}
3070

3071
// peerBootstrapper is a goroutine which is tasked with attempting to establish
3072
// and maintain a target minimum number of outbound connections. With this
3073
// invariant, we ensure that our node is connected to a diverse set of peers
3074
// and that nodes newly joining the network receive an up to date network view
3075
// as soon as possible.
3076
func (s *server) peerBootstrapper(numTargetPeers uint32,
3077
        bootstrappers []discovery.NetworkPeerBootstrapper) {
×
3078

×
3079
        defer s.wg.Done()
×
3080

×
3081
        // Before we continue, init the ignore peers map.
×
3082
        ignoreList := s.createBootstrapIgnorePeers()
×
3083

×
3084
        // We'll start off by aggressively attempting connections to peers in
×
3085
        // order to be a part of the network as soon as possible.
×
3086
        s.initialPeerBootstrap(ignoreList, numTargetPeers, bootstrappers)
×
3087

×
3088
        // Once done, we'll attempt to maintain our target minimum number of
×
3089
        // peers.
×
3090
        //
×
3091
        // We'll use a 15 second backoff, and double the time every time an
×
3092
        // epoch fails up to a ceiling.
×
3093
        backOff := time.Second * 15
×
3094

×
3095
        // We'll create a new ticker to wake us up every 15 seconds so we can
×
3096
        // see if we've reached our minimum number of peers.
×
3097
        sampleTicker := time.NewTicker(backOff)
×
3098
        defer sampleTicker.Stop()
×
3099

×
3100
        // We'll use the number of attempts and errors to determine if we need
×
3101
        // to increase the time between discovery epochs.
×
3102
        var epochErrors uint32 // To be used atomically.
×
3103
        var epochAttempts uint32
×
3104

×
3105
        for {
×
3106
                select {
×
3107
                // The ticker has just woken us up, so we'll need to check if
3108
                // we need to attempt to connect our to any more peers.
3109
                case <-sampleTicker.C:
×
3110
                        // Obtain the current number of peers, so we can gauge
×
3111
                        // if we need to sample more peers or not.
×
3112
                        s.mu.RLock()
×
3113
                        numActivePeers := uint32(len(s.peersByPub))
×
3114
                        s.mu.RUnlock()
×
3115

×
3116
                        // If we have enough peers, then we can loop back
×
3117
                        // around to the next round as we're done here.
×
3118
                        if numActivePeers >= numTargetPeers {
×
3119
                                continue
×
3120
                        }
3121

3122
                        // If all of our attempts failed during this last back
3123
                        // off period, then will increase our backoff to 5
3124
                        // minute ceiling to avoid an excessive number of
3125
                        // queries
3126
                        //
3127
                        // TODO(roasbeef): add reverse policy too?
3128

3129
                        if epochAttempts > 0 &&
×
3130
                                atomic.LoadUint32(&epochErrors) >= epochAttempts {
×
3131

×
3132
                                sampleTicker.Stop()
×
3133

×
3134
                                backOff *= 2
×
3135
                                if backOff > bootstrapBackOffCeiling {
×
3136
                                        backOff = bootstrapBackOffCeiling
×
3137
                                }
×
3138

3139
                                srvrLog.Debugf("Backing off peer bootstrapper to "+
×
3140
                                        "%v", backOff)
×
3141
                                sampleTicker = time.NewTicker(backOff)
×
3142
                                continue
×
3143
                        }
3144

3145
                        atomic.StoreUint32(&epochErrors, 0)
×
3146
                        epochAttempts = 0
×
3147

×
3148
                        // Since we know need more peers, we'll compute the
×
3149
                        // exact number we need to reach our threshold.
×
3150
                        numNeeded := numTargetPeers - numActivePeers
×
3151

×
3152
                        srvrLog.Debugf("Attempting to obtain %v more network "+
×
3153
                                "peers", numNeeded)
×
3154

×
3155
                        // With the number of peers we need calculated, we'll
×
3156
                        // query the network bootstrappers to sample a set of
×
3157
                        // random addrs for us.
×
3158
                        //
×
3159
                        // Before we continue, get a copy of the ignore peers
×
3160
                        // map.
×
3161
                        ignoreList = s.createBootstrapIgnorePeers()
×
3162

×
3163
                        peerAddrs, err := discovery.MultiSourceBootstrap(
×
3164
                                ignoreList, numNeeded*2, bootstrappers...,
×
3165
                        )
×
3166
                        if err != nil {
×
3167
                                srvrLog.Errorf("Unable to retrieve bootstrap "+
×
3168
                                        "peers: %v", err)
×
3169
                                continue
×
3170
                        }
3171

3172
                        // Finally, we'll launch a new goroutine for each
3173
                        // prospective peer candidates.
3174
                        for _, addr := range peerAddrs {
×
3175
                                epochAttempts++
×
3176

×
3177
                                go func(a *lnwire.NetAddress) {
×
3178
                                        // TODO(roasbeef): can do AS, subnet,
×
3179
                                        // country diversity, etc
×
3180
                                        errChan := make(chan error, 1)
×
3181
                                        s.connectToPeer(
×
3182
                                                a, errChan,
×
3183
                                                s.cfg.ConnectionTimeout,
×
3184
                                        )
×
3185
                                        select {
×
3186
                                        case err := <-errChan:
×
3187
                                                if err == nil {
×
3188
                                                        return
×
3189
                                                }
×
3190

3191
                                                srvrLog.Errorf("Unable to "+
×
3192
                                                        "connect to %v: %v",
×
3193
                                                        a, err)
×
3194
                                                atomic.AddUint32(&epochErrors, 1)
×
3195
                                        case <-s.quit:
×
3196
                                        }
3197
                                }(addr)
3198
                        }
3199
                case <-s.quit:
×
3200
                        return
×
3201
                }
3202
        }
3203
}
3204

3205
// bootstrapBackOffCeiling is the maximum amount of time we'll wait between
3206
// failed attempts to locate a set of bootstrap peers. We'll slowly double our
3207
// query back off each time we encounter a failure.
3208
const bootstrapBackOffCeiling = time.Minute * 5
3209

3210
// initialPeerBootstrap attempts to continuously connect to peers on startup
3211
// until the target number of peers has been reached. This ensures that nodes
3212
// receive an up to date network view as soon as possible.
3213
func (s *server) initialPeerBootstrap(ignore map[autopilot.NodeID]struct{},
3214
        numTargetPeers uint32,
3215
        bootstrappers []discovery.NetworkPeerBootstrapper) {
×
3216

×
3217
        srvrLog.Debugf("Init bootstrap with targetPeers=%v, bootstrappers=%v, "+
×
3218
                "ignore=%v", numTargetPeers, len(bootstrappers), len(ignore))
×
3219

×
3220
        // We'll start off by waiting 2 seconds between failed attempts, then
×
3221
        // double each time we fail until we hit the bootstrapBackOffCeiling.
×
3222
        var delaySignal <-chan time.Time
×
3223
        delayTime := time.Second * 2
×
3224

×
3225
        // As want to be more aggressive, we'll use a lower back off celling
×
3226
        // then the main peer bootstrap logic.
×
3227
        backOffCeiling := bootstrapBackOffCeiling / 5
×
3228

×
3229
        for attempts := 0; ; attempts++ {
×
3230
                // Check if the server has been requested to shut down in order
×
3231
                // to prevent blocking.
×
3232
                if s.Stopped() {
×
3233
                        return
×
3234
                }
×
3235

3236
                // We can exit our aggressive initial peer bootstrapping stage
3237
                // if we've reached out target number of peers.
3238
                s.mu.RLock()
×
3239
                numActivePeers := uint32(len(s.peersByPub))
×
3240
                s.mu.RUnlock()
×
3241

×
3242
                if numActivePeers >= numTargetPeers {
×
3243
                        return
×
3244
                }
×
3245

3246
                if attempts > 0 {
×
3247
                        srvrLog.Debugf("Waiting %v before trying to locate "+
×
3248
                                "bootstrap peers (attempt #%v)", delayTime,
×
3249
                                attempts)
×
3250

×
3251
                        // We've completed at least one iterating and haven't
×
3252
                        // finished, so we'll start to insert a delay period
×
3253
                        // between each attempt.
×
3254
                        delaySignal = time.After(delayTime)
×
3255
                        select {
×
3256
                        case <-delaySignal:
×
3257
                        case <-s.quit:
×
3258
                                return
×
3259
                        }
3260

3261
                        // After our delay, we'll double the time we wait up to
3262
                        // the max back off period.
3263
                        delayTime *= 2
×
3264
                        if delayTime > backOffCeiling {
×
3265
                                delayTime = backOffCeiling
×
3266
                        }
×
3267
                }
3268

3269
                // Otherwise, we'll request for the remaining number of peers
3270
                // in order to reach our target.
3271
                peersNeeded := numTargetPeers - numActivePeers
×
3272
                bootstrapAddrs, err := discovery.MultiSourceBootstrap(
×
3273
                        ignore, peersNeeded, bootstrappers...,
×
3274
                )
×
3275
                if err != nil {
×
3276
                        srvrLog.Errorf("Unable to retrieve initial bootstrap "+
×
3277
                                "peers: %v", err)
×
3278
                        continue
×
3279
                }
3280

3281
                // Then, we'll attempt to establish a connection to the
3282
                // different peer addresses retrieved by our bootstrappers.
3283
                var wg sync.WaitGroup
×
3284
                for _, bootstrapAddr := range bootstrapAddrs {
×
3285
                        wg.Add(1)
×
3286
                        go func(addr *lnwire.NetAddress) {
×
3287
                                defer wg.Done()
×
3288

×
3289
                                errChan := make(chan error, 1)
×
3290
                                go s.connectToPeer(
×
3291
                                        addr, errChan, s.cfg.ConnectionTimeout,
×
3292
                                )
×
3293

×
3294
                                // We'll only allow this connection attempt to
×
3295
                                // take up to 3 seconds. This allows us to move
×
3296
                                // quickly by discarding peers that are slowing
×
3297
                                // us down.
×
3298
                                select {
×
3299
                                case err := <-errChan:
×
3300
                                        if err == nil {
×
3301
                                                return
×
3302
                                        }
×
3303
                                        srvrLog.Errorf("Unable to connect to "+
×
3304
                                                "%v: %v", addr, err)
×
3305
                                // TODO: tune timeout? 3 seconds might be *too*
3306
                                // aggressive but works well.
3307
                                case <-time.After(3 * time.Second):
×
3308
                                        srvrLog.Tracef("Skipping peer %v due "+
×
3309
                                                "to not establishing a "+
×
3310
                                                "connection within 3 seconds",
×
3311
                                                addr)
×
3312
                                case <-s.quit:
×
3313
                                }
3314
                        }(bootstrapAddr)
3315
                }
3316

3317
                wg.Wait()
×
3318
        }
3319
}
3320

3321
// createNewHiddenService automatically sets up a v2 or v3 onion service in
3322
// order to listen for inbound connections over Tor.
3323
func (s *server) createNewHiddenService() error {
×
3324
        // Determine the different ports the server is listening on. The onion
×
3325
        // service's virtual port will map to these ports and one will be picked
×
3326
        // at random when the onion service is being accessed.
×
3327
        listenPorts := make([]int, 0, len(s.listenAddrs))
×
3328
        for _, listenAddr := range s.listenAddrs {
×
3329
                port := listenAddr.(*net.TCPAddr).Port
×
3330
                listenPorts = append(listenPorts, port)
×
3331
        }
×
3332

3333
        encrypter, err := lnencrypt.KeyRingEncrypter(s.cc.KeyRing)
×
3334
        if err != nil {
×
3335
                return err
×
3336
        }
×
3337

3338
        // Once the port mapping has been set, we can go ahead and automatically
3339
        // create our onion service. The service's private key will be saved to
3340
        // disk in order to regain access to this service when restarting `lnd`.
3341
        onionCfg := tor.AddOnionConfig{
×
3342
                VirtualPort: defaultPeerPort,
×
3343
                TargetPorts: listenPorts,
×
3344
                Store: tor.NewOnionFile(
×
3345
                        s.cfg.Tor.PrivateKeyPath, 0600, s.cfg.Tor.EncryptKey,
×
3346
                        encrypter,
×
3347
                ),
×
3348
        }
×
3349

×
3350
        switch {
×
3351
        case s.cfg.Tor.V2:
×
3352
                onionCfg.Type = tor.V2
×
3353
        case s.cfg.Tor.V3:
×
3354
                onionCfg.Type = tor.V3
×
3355
        }
3356

3357
        addr, err := s.torController.AddOnion(onionCfg)
×
3358
        if err != nil {
×
3359
                return err
×
3360
        }
×
3361

3362
        // Now that the onion service has been created, we'll add the onion
3363
        // address it can be reached at to our list of advertised addresses.
3364
        newNodeAnn, err := s.genNodeAnnouncement(
×
3365
                nil, func(currentAnn *lnwire.NodeAnnouncement) {
×
3366
                        currentAnn.Addresses = append(currentAnn.Addresses, addr)
×
3367
                },
×
3368
        )
3369
        if err != nil {
×
3370
                return fmt.Errorf("unable to generate new node "+
×
3371
                        "announcement: %v", err)
×
3372
        }
×
3373

3374
        // Finally, we'll update the on-disk version of our announcement so it
3375
        // will eventually propagate to nodes in the network.
3376
        selfNode := &models.LightningNode{
×
3377
                HaveNodeAnnouncement: true,
×
3378
                LastUpdate:           time.Unix(int64(newNodeAnn.Timestamp), 0),
×
3379
                Addresses:            newNodeAnn.Addresses,
×
3380
                Alias:                newNodeAnn.Alias.String(),
×
3381
                Features: lnwire.NewFeatureVector(
×
3382
                        newNodeAnn.Features, lnwire.Features,
×
3383
                ),
×
3384
                Color:        newNodeAnn.RGBColor,
×
3385
                AuthSigBytes: newNodeAnn.Signature.ToSignatureBytes(),
×
3386
        }
×
3387
        copy(selfNode.PubKeyBytes[:], s.identityECDH.PubKey().SerializeCompressed())
×
3388
        if err := s.graphDB.SetSourceNode(selfNode); err != nil {
×
3389
                return fmt.Errorf("can't set self node: %w", err)
×
3390
        }
×
3391

3392
        return nil
×
3393
}
3394

3395
// findChannel finds a channel given a public key and ChannelID. It is an
3396
// optimization that is quicker than seeking for a channel given only the
3397
// ChannelID.
3398
func (s *server) findChannel(node *btcec.PublicKey, chanID lnwire.ChannelID) (
3399
        *channeldb.OpenChannel, error) {
3✔
3400

3✔
3401
        nodeChans, err := s.chanStateDB.FetchOpenChannels(node)
3✔
3402
        if err != nil {
3✔
3403
                return nil, err
×
3404
        }
×
3405

3406
        for _, channel := range nodeChans {
6✔
3407
                if chanID.IsChanPoint(&channel.FundingOutpoint) {
6✔
3408
                        return channel, nil
3✔
3409
                }
3✔
3410
        }
3411

3412
        return nil, fmt.Errorf("unable to find channel")
3✔
3413
}
3414

3415
// getNodeAnnouncement fetches the current, fully signed node announcement.
3416
func (s *server) getNodeAnnouncement() lnwire.NodeAnnouncement {
3✔
3417
        s.mu.Lock()
3✔
3418
        defer s.mu.Unlock()
3✔
3419

3✔
3420
        return *s.currentNodeAnn
3✔
3421
}
3✔
3422

3423
// genNodeAnnouncement generates and returns the current fully signed node
3424
// announcement. The time stamp of the announcement will be updated in order
3425
// to ensure it propagates through the network.
3426
func (s *server) genNodeAnnouncement(features *lnwire.RawFeatureVector,
3427
        modifiers ...netann.NodeAnnModifier) (lnwire.NodeAnnouncement, error) {
3✔
3428

3✔
3429
        s.mu.Lock()
3✔
3430
        defer s.mu.Unlock()
3✔
3431

3✔
3432
        // First, try to update our feature manager with the updated set of
3✔
3433
        // features.
3✔
3434
        if features != nil {
6✔
3435
                proposedFeatures := map[feature.Set]*lnwire.RawFeatureVector{
3✔
3436
                        feature.SetNodeAnn: features,
3✔
3437
                }
3✔
3438
                err := s.featureMgr.UpdateFeatureSets(proposedFeatures)
3✔
3439
                if err != nil {
6✔
3440
                        return lnwire.NodeAnnouncement{}, err
3✔
3441
                }
3✔
3442

3443
                // If we could successfully update our feature manager, add
3444
                // an update modifier to include these new features to our
3445
                // set.
3446
                modifiers = append(
3✔
3447
                        modifiers, netann.NodeAnnSetFeatures(features),
3✔
3448
                )
3✔
3449
        }
3450

3451
        // Always update the timestamp when refreshing to ensure the update
3452
        // propagates.
3453
        modifiers = append(modifiers, netann.NodeAnnSetTimestamp)
3✔
3454

3✔
3455
        // Apply the requested changes to the node announcement.
3✔
3456
        for _, modifier := range modifiers {
6✔
3457
                modifier(s.currentNodeAnn)
3✔
3458
        }
3✔
3459

3460
        // Sign a new update after applying all of the passed modifiers.
3461
        err := netann.SignNodeAnnouncement(
3✔
3462
                s.nodeSigner, s.identityKeyLoc, s.currentNodeAnn,
3✔
3463
        )
3✔
3464
        if err != nil {
3✔
3465
                return lnwire.NodeAnnouncement{}, err
×
3466
        }
×
3467

3468
        return *s.currentNodeAnn, nil
3✔
3469
}
3470

3471
// updateAndBroadcastSelfNode generates a new node announcement
3472
// applying the giving modifiers and updating the time stamp
3473
// to ensure it propagates through the network. Then it broadcasts
3474
// it to the network.
3475
func (s *server) updateAndBroadcastSelfNode(features *lnwire.RawFeatureVector,
3476
        modifiers ...netann.NodeAnnModifier) error {
3✔
3477

3✔
3478
        newNodeAnn, err := s.genNodeAnnouncement(features, modifiers...)
3✔
3479
        if err != nil {
6✔
3480
                return fmt.Errorf("unable to generate new node "+
3✔
3481
                        "announcement: %v", err)
3✔
3482
        }
3✔
3483

3484
        // Update the on-disk version of our announcement.
3485
        // Load and modify self node istead of creating anew instance so we
3486
        // don't risk overwriting any existing values.
3487
        selfNode, err := s.graphDB.SourceNode()
3✔
3488
        if err != nil {
3✔
3489
                return fmt.Errorf("unable to get current source node: %w", err)
×
3490
        }
×
3491

3492
        selfNode.HaveNodeAnnouncement = true
3✔
3493
        selfNode.LastUpdate = time.Unix(int64(newNodeAnn.Timestamp), 0)
3✔
3494
        selfNode.Addresses = newNodeAnn.Addresses
3✔
3495
        selfNode.Alias = newNodeAnn.Alias.String()
3✔
3496
        selfNode.Features = s.featureMgr.Get(feature.SetNodeAnn)
3✔
3497
        selfNode.Color = newNodeAnn.RGBColor
3✔
3498
        selfNode.AuthSigBytes = newNodeAnn.Signature.ToSignatureBytes()
3✔
3499

3✔
3500
        copy(selfNode.PubKeyBytes[:], s.identityECDH.PubKey().SerializeCompressed())
3✔
3501

3✔
3502
        if err := s.graphDB.SetSourceNode(selfNode); err != nil {
3✔
3503
                return fmt.Errorf("can't set self node: %w", err)
×
3504
        }
×
3505

3506
        // Finally, propagate it to the nodes in the network.
3507
        err = s.BroadcastMessage(nil, &newNodeAnn)
3✔
3508
        if err != nil {
3✔
3509
                rpcsLog.Debugf("Unable to broadcast new node "+
×
3510
                        "announcement to peers: %v", err)
×
3511
                return err
×
3512
        }
×
3513

3514
        return nil
3✔
3515
}
3516

3517
type nodeAddresses struct {
3518
        pubKey    *btcec.PublicKey
3519
        addresses []net.Addr
3520
}
3521

3522
// establishPersistentConnections attempts to establish persistent connections
3523
// to all our direct channel collaborators. In order to promote liveness of our
3524
// active channels, we instruct the connection manager to attempt to establish
3525
// and maintain persistent connections to all our direct channel counterparties.
3526
func (s *server) establishPersistentConnections() error {
3✔
3527
        // nodeAddrsMap stores the combination of node public keys and addresses
3✔
3528
        // that we'll attempt to reconnect to. PubKey strings are used as keys
3✔
3529
        // since other PubKey forms can't be compared.
3✔
3530
        nodeAddrsMap := map[string]*nodeAddresses{}
3✔
3531

3✔
3532
        // Iterate through the list of LinkNodes to find addresses we should
3✔
3533
        // attempt to connect to based on our set of previous connections. Set
3✔
3534
        // the reconnection port to the default peer port.
3✔
3535
        linkNodes, err := s.chanStateDB.LinkNodeDB().FetchAllLinkNodes()
3✔
3536
        if err != nil && err != channeldb.ErrLinkNodesNotFound {
3✔
3537
                return fmt.Errorf("failed to fetch all link nodes: %w", err)
×
3538
        }
×
3539

3540
        for _, node := range linkNodes {
6✔
3541
                pubStr := string(node.IdentityPub.SerializeCompressed())
3✔
3542
                nodeAddrs := &nodeAddresses{
3✔
3543
                        pubKey:    node.IdentityPub,
3✔
3544
                        addresses: node.Addresses,
3✔
3545
                }
3✔
3546
                nodeAddrsMap[pubStr] = nodeAddrs
3✔
3547
        }
3✔
3548

3549
        // After checking our previous connections for addresses to connect to,
3550
        // iterate through the nodes in our channel graph to find addresses
3551
        // that have been added via NodeAnnouncement messages.
3552
        sourceNode, err := s.graphDB.SourceNode()
3✔
3553
        if err != nil {
3✔
3554
                return fmt.Errorf("failed to fetch source node: %w", err)
×
3555
        }
×
3556

3557
        // TODO(roasbeef): instead iterate over link nodes and query graph for
3558
        // each of the nodes.
3559
        selfPub := s.identityECDH.PubKey().SerializeCompressed()
3✔
3560
        err = s.graphDB.ForEachNodeChannel(sourceNode.PubKeyBytes, func(
3✔
3561
                tx kvdb.RTx,
3✔
3562
                chanInfo *models.ChannelEdgeInfo,
3✔
3563
                policy, _ *models.ChannelEdgePolicy) error {
6✔
3564

3✔
3565
                // If the remote party has announced the channel to us, but we
3✔
3566
                // haven't yet, then we won't have a policy. However, we don't
3✔
3567
                // need this to connect to the peer, so we'll log it and move on.
3✔
3568
                if policy == nil {
3✔
3569
                        srvrLog.Warnf("No channel policy found for "+
×
3570
                                "ChannelPoint(%v): ", chanInfo.ChannelPoint)
×
3571
                }
×
3572

3573
                // We'll now fetch the peer opposite from us within this
3574
                // channel so we can queue up a direct connection to them.
3575
                channelPeer, err := s.graphDB.FetchOtherNode(
3✔
3576
                        tx, chanInfo, selfPub,
3✔
3577
                )
3✔
3578
                if err != nil {
3✔
3579
                        return fmt.Errorf("unable to fetch channel peer for "+
×
3580
                                "ChannelPoint(%v): %v", chanInfo.ChannelPoint,
×
3581
                                err)
×
3582
                }
×
3583

3584
                pubStr := string(channelPeer.PubKeyBytes[:])
3✔
3585

3✔
3586
                // Add all unique addresses from channel
3✔
3587
                // graph/NodeAnnouncements to the list of addresses we'll
3✔
3588
                // connect to for this peer.
3✔
3589
                addrSet := make(map[string]net.Addr)
3✔
3590
                for _, addr := range channelPeer.Addresses {
6✔
3591
                        switch addr.(type) {
3✔
3592
                        case *net.TCPAddr:
3✔
3593
                                addrSet[addr.String()] = addr
3✔
3594

3595
                        // We'll only attempt to connect to Tor addresses if Tor
3596
                        // outbound support is enabled.
3597
                        case *tor.OnionAddr:
×
3598
                                if s.cfg.Tor.Active {
×
3599
                                        addrSet[addr.String()] = addr
×
3600
                                }
×
3601
                        }
3602
                }
3603

3604
                // If this peer is also recorded as a link node, we'll add any
3605
                // additional addresses that have not already been selected.
3606
                linkNodeAddrs, ok := nodeAddrsMap[pubStr]
3✔
3607
                if ok {
6✔
3608
                        for _, lnAddress := range linkNodeAddrs.addresses {
6✔
3609
                                switch lnAddress.(type) {
3✔
3610
                                case *net.TCPAddr:
3✔
3611
                                        addrSet[lnAddress.String()] = lnAddress
3✔
3612

3613
                                // We'll only attempt to connect to Tor
3614
                                // addresses if Tor outbound support is enabled.
3615
                                case *tor.OnionAddr:
×
3616
                                        if s.cfg.Tor.Active {
×
3617
                                                addrSet[lnAddress.String()] = lnAddress
×
3618
                                        }
×
3619
                                }
3620
                        }
3621
                }
3622

3623
                // Construct a slice of the deduped addresses.
3624
                var addrs []net.Addr
3✔
3625
                for _, addr := range addrSet {
6✔
3626
                        addrs = append(addrs, addr)
3✔
3627
                }
3✔
3628

3629
                n := &nodeAddresses{
3✔
3630
                        addresses: addrs,
3✔
3631
                }
3✔
3632
                n.pubKey, err = channelPeer.PubKey()
3✔
3633
                if err != nil {
3✔
3634
                        return err
×
3635
                }
×
3636

3637
                nodeAddrsMap[pubStr] = n
3✔
3638
                return nil
3✔
3639
        })
3640
        if err != nil {
3✔
3641
                srvrLog.Errorf("Failed to iterate channels for node %x",
×
3642
                        sourceNode.PubKeyBytes)
×
3643

×
3644
                if !errors.Is(err, graphdb.ErrGraphNoEdgesFound) &&
×
3645
                        !errors.Is(err, graphdb.ErrEdgeNotFound) {
×
3646

×
3647
                        return err
×
3648
                }
×
3649
        }
3650

3651
        srvrLog.Debugf("Establishing %v persistent connections on start",
3✔
3652
                len(nodeAddrsMap))
3✔
3653

3✔
3654
        // Acquire and hold server lock until all persistent connection requests
3✔
3655
        // have been recorded and sent to the connection manager.
3✔
3656
        s.mu.Lock()
3✔
3657
        defer s.mu.Unlock()
3✔
3658

3✔
3659
        // Iterate through the combined list of addresses from prior links and
3✔
3660
        // node announcements and attempt to reconnect to each node.
3✔
3661
        var numOutboundConns int
3✔
3662
        for pubStr, nodeAddr := range nodeAddrsMap {
6✔
3663
                // Add this peer to the set of peers we should maintain a
3✔
3664
                // persistent connection with. We set the value to false to
3✔
3665
                // indicate that we should not continue to reconnect if the
3✔
3666
                // number of channels returns to zero, since this peer has not
3✔
3667
                // been requested as perm by the user.
3✔
3668
                s.persistentPeers[pubStr] = false
3✔
3669
                if _, ok := s.persistentPeersBackoff[pubStr]; !ok {
6✔
3670
                        s.persistentPeersBackoff[pubStr] = s.cfg.MinBackoff
3✔
3671
                }
3✔
3672

3673
                for _, address := range nodeAddr.addresses {
6✔
3674
                        // Create a wrapper address which couples the IP and
3✔
3675
                        // the pubkey so the brontide authenticated connection
3✔
3676
                        // can be established.
3✔
3677
                        lnAddr := &lnwire.NetAddress{
3✔
3678
                                IdentityKey: nodeAddr.pubKey,
3✔
3679
                                Address:     address,
3✔
3680
                        }
3✔
3681

3✔
3682
                        s.persistentPeerAddrs[pubStr] = append(
3✔
3683
                                s.persistentPeerAddrs[pubStr], lnAddr)
3✔
3684
                }
3✔
3685

3686
                // We'll connect to the first 10 peers immediately, then
3687
                // randomly stagger any remaining connections if the
3688
                // stagger initial reconnect flag is set. This ensures
3689
                // that mobile nodes or nodes with a small number of
3690
                // channels obtain connectivity quickly, but larger
3691
                // nodes are able to disperse the costs of connecting to
3692
                // all peers at once.
3693
                if numOutboundConns < numInstantInitReconnect ||
3✔
3694
                        !s.cfg.StaggerInitialReconnect {
6✔
3695

3✔
3696
                        go s.connectToPersistentPeer(pubStr)
3✔
3697
                } else {
3✔
3698
                        go s.delayInitialReconnect(pubStr)
×
3699
                }
×
3700

3701
                numOutboundConns++
3✔
3702
        }
3703

3704
        return nil
3✔
3705
}
3706

3707
// delayInitialReconnect will attempt a reconnection to the given peer after
3708
// sampling a value for the delay between 0s and the maxInitReconnectDelay.
3709
//
3710
// NOTE: This method MUST be run as a goroutine.
3711
func (s *server) delayInitialReconnect(pubStr string) {
×
3712
        delay := time.Duration(prand.Intn(maxInitReconnectDelay)) * time.Second
×
3713
        select {
×
3714
        case <-time.After(delay):
×
3715
                s.connectToPersistentPeer(pubStr)
×
3716
        case <-s.quit:
×
3717
        }
3718
}
3719

3720
// prunePersistentPeerConnection removes all internal state related to
3721
// persistent connections to a peer within the server. This is used to avoid
3722
// persistent connection retries to peers we do not have any open channels with.
3723
func (s *server) prunePersistentPeerConnection(compressedPubKey [33]byte) {
3✔
3724
        pubKeyStr := string(compressedPubKey[:])
3✔
3725

3✔
3726
        s.mu.Lock()
3✔
3727
        if perm, ok := s.persistentPeers[pubKeyStr]; ok && !perm {
6✔
3728
                delete(s.persistentPeers, pubKeyStr)
3✔
3729
                delete(s.persistentPeersBackoff, pubKeyStr)
3✔
3730
                delete(s.persistentPeerAddrs, pubKeyStr)
3✔
3731
                s.cancelConnReqs(pubKeyStr, nil)
3✔
3732
                s.mu.Unlock()
3✔
3733

3✔
3734
                srvrLog.Infof("Pruned peer %x from persistent connections, "+
3✔
3735
                        "peer has no open channels", compressedPubKey)
3✔
3736

3✔
3737
                return
3✔
3738
        }
3✔
3739
        s.mu.Unlock()
3✔
3740
}
3741

3742
// bannedPersistentPeerConnection does not actually "ban" a persistent peer. It
3743
// is instead used to remove persistent peer state for a peer that has been
3744
// disconnected for good cause by the server. Currently, a gossip ban from
3745
// sending garbage and the server running out of restricted-access
3746
// (i.e. "free") connection slots are the only way this logic gets hit. In the
3747
// future, this function may expand when more ban criteria is added.
3748
//
3749
// NOTE: The server's write lock MUST be held when this is called.
3750
func (s *server) bannedPersistentPeerConnection(remotePub string) {
×
3751
        if perm, ok := s.persistentPeers[remotePub]; ok && !perm {
×
3752
                delete(s.persistentPeers, remotePub)
×
3753
                delete(s.persistentPeersBackoff, remotePub)
×
3754
                delete(s.persistentPeerAddrs, remotePub)
×
3755
                s.cancelConnReqs(remotePub, nil)
×
3756
        }
×
3757
}
3758

3759
// BroadcastMessage sends a request to the server to broadcast a set of
3760
// messages to all peers other than the one specified by the `skips` parameter.
3761
// All messages sent via BroadcastMessage will be queued for lazy delivery to
3762
// the target peers.
3763
//
3764
// NOTE: This function is safe for concurrent access.
3765
func (s *server) BroadcastMessage(skips map[route.Vertex]struct{},
3766
        msgs ...lnwire.Message) error {
3✔
3767

3✔
3768
        // Filter out peers found in the skips map. We synchronize access to
3✔
3769
        // peersByPub throughout this process to ensure we deliver messages to
3✔
3770
        // exact set of peers present at the time of invocation.
3✔
3771
        s.mu.RLock()
3✔
3772
        peers := make([]*peer.Brontide, 0, len(s.peersByPub))
3✔
3773
        for pubStr, sPeer := range s.peersByPub {
6✔
3774
                if skips != nil {
6✔
3775
                        if _, ok := skips[sPeer.PubKey()]; ok {
6✔
3776
                                srvrLog.Tracef("Skipping %x in broadcast with "+
3✔
3777
                                        "pubStr=%x", sPeer.PubKey(), pubStr)
3✔
3778
                                continue
3✔
3779
                        }
3780
                }
3781

3782
                peers = append(peers, sPeer)
3✔
3783
        }
3784
        s.mu.RUnlock()
3✔
3785

3✔
3786
        // Iterate over all known peers, dispatching a go routine to enqueue
3✔
3787
        // all messages to each of peers.
3✔
3788
        var wg sync.WaitGroup
3✔
3789
        for _, sPeer := range peers {
6✔
3790
                srvrLog.Debugf("Sending %v messages to peer %x", len(msgs),
3✔
3791
                        sPeer.PubKey())
3✔
3792

3✔
3793
                // Dispatch a go routine to enqueue all messages to this peer.
3✔
3794
                wg.Add(1)
3✔
3795
                s.wg.Add(1)
3✔
3796
                go func(p lnpeer.Peer) {
6✔
3797
                        defer s.wg.Done()
3✔
3798
                        defer wg.Done()
3✔
3799

3✔
3800
                        p.SendMessageLazy(false, msgs...)
3✔
3801
                }(sPeer)
3✔
3802
        }
3803

3804
        // Wait for all messages to have been dispatched before returning to
3805
        // caller.
3806
        wg.Wait()
3✔
3807

3✔
3808
        return nil
3✔
3809
}
3810

3811
// NotifyWhenOnline can be called by other subsystems to get notified when a
3812
// particular peer comes online. The peer itself is sent across the peerChan.
3813
//
3814
// NOTE: This function is safe for concurrent access.
3815
func (s *server) NotifyWhenOnline(peerKey [33]byte,
3816
        peerChan chan<- lnpeer.Peer) {
3✔
3817

3✔
3818
        s.mu.Lock()
3✔
3819

3✔
3820
        // Compute the target peer's identifier.
3✔
3821
        pubStr := string(peerKey[:])
3✔
3822

3✔
3823
        // Check if peer is connected.
3✔
3824
        peer, ok := s.peersByPub[pubStr]
3✔
3825
        if ok {
6✔
3826
                // Unlock here so that the mutex isn't held while we are
3✔
3827
                // waiting for the peer to become active.
3✔
3828
                s.mu.Unlock()
3✔
3829

3✔
3830
                // Wait until the peer signals that it is actually active
3✔
3831
                // rather than only in the server's maps.
3✔
3832
                select {
3✔
3833
                case <-peer.ActiveSignal():
3✔
UNCOV
3834
                case <-peer.QuitSignal():
×
UNCOV
3835
                        // The peer quit, so we'll add the channel to the slice
×
UNCOV
3836
                        // and return.
×
UNCOV
3837
                        s.mu.Lock()
×
UNCOV
3838
                        s.peerConnectedListeners[pubStr] = append(
×
UNCOV
3839
                                s.peerConnectedListeners[pubStr], peerChan,
×
UNCOV
3840
                        )
×
UNCOV
3841
                        s.mu.Unlock()
×
UNCOV
3842
                        return
×
3843
                }
3844

3845
                // Connected, can return early.
3846
                srvrLog.Debugf("Notifying that peer %x is online", peerKey)
3✔
3847

3✔
3848
                select {
3✔
3849
                case peerChan <- peer:
3✔
3850
                case <-s.quit:
×
3851
                }
3852

3853
                return
3✔
3854
        }
3855

3856
        // Not connected, store this listener such that it can be notified when
3857
        // the peer comes online.
3858
        s.peerConnectedListeners[pubStr] = append(
3✔
3859
                s.peerConnectedListeners[pubStr], peerChan,
3✔
3860
        )
3✔
3861
        s.mu.Unlock()
3✔
3862
}
3863

3864
// NotifyWhenOffline delivers a notification to the caller of when the peer with
3865
// the given public key has been disconnected. The notification is signaled by
3866
// closing the channel returned.
3867
func (s *server) NotifyWhenOffline(peerPubKey [33]byte) <-chan struct{} {
3✔
3868
        s.mu.Lock()
3✔
3869
        defer s.mu.Unlock()
3✔
3870

3✔
3871
        c := make(chan struct{})
3✔
3872

3✔
3873
        // If the peer is already offline, we can immediately trigger the
3✔
3874
        // notification.
3✔
3875
        peerPubKeyStr := string(peerPubKey[:])
3✔
3876
        if _, ok := s.peersByPub[peerPubKeyStr]; !ok {
3✔
3877
                srvrLog.Debugf("Notifying that peer %x is offline", peerPubKey)
×
3878
                close(c)
×
3879
                return c
×
3880
        }
×
3881

3882
        // Otherwise, the peer is online, so we'll keep track of the channel to
3883
        // trigger the notification once the server detects the peer
3884
        // disconnects.
3885
        s.peerDisconnectedListeners[peerPubKeyStr] = append(
3✔
3886
                s.peerDisconnectedListeners[peerPubKeyStr], c,
3✔
3887
        )
3✔
3888

3✔
3889
        return c
3✔
3890
}
3891

3892
// FindPeer will return the peer that corresponds to the passed in public key.
3893
// This function is used by the funding manager, allowing it to update the
3894
// daemon's local representation of the remote peer.
3895
//
3896
// NOTE: This function is safe for concurrent access.
3897
func (s *server) FindPeer(peerKey *btcec.PublicKey) (*peer.Brontide, error) {
3✔
3898
        s.mu.RLock()
3✔
3899
        defer s.mu.RUnlock()
3✔
3900

3✔
3901
        pubStr := string(peerKey.SerializeCompressed())
3✔
3902

3✔
3903
        return s.findPeerByPubStr(pubStr)
3✔
3904
}
3✔
3905

3906
// FindPeerByPubStr will return the peer that corresponds to the passed peerID,
3907
// which should be a string representation of the peer's serialized, compressed
3908
// public key.
3909
//
3910
// NOTE: This function is safe for concurrent access.
3911
func (s *server) FindPeerByPubStr(pubStr string) (*peer.Brontide, error) {
3✔
3912
        s.mu.RLock()
3✔
3913
        defer s.mu.RUnlock()
3✔
3914

3✔
3915
        return s.findPeerByPubStr(pubStr)
3✔
3916
}
3✔
3917

3918
// findPeerByPubStr is an internal method that retrieves the specified peer from
3919
// the server's internal state using.
3920
func (s *server) findPeerByPubStr(pubStr string) (*peer.Brontide, error) {
3✔
3921
        peer, ok := s.peersByPub[pubStr]
3✔
3922
        if !ok {
6✔
3923
                return nil, ErrPeerNotConnected
3✔
3924
        }
3✔
3925

3926
        return peer, nil
3✔
3927
}
3928

3929
// nextPeerBackoff computes the next backoff duration for a peer's pubkey using
3930
// exponential backoff. If no previous backoff was known, the default is
3931
// returned.
3932
func (s *server) nextPeerBackoff(pubStr string,
3933
        startTime time.Time) time.Duration {
3✔
3934

3✔
3935
        // Now, determine the appropriate backoff to use for the retry.
3✔
3936
        backoff, ok := s.persistentPeersBackoff[pubStr]
3✔
3937
        if !ok {
6✔
3938
                // If an existing backoff was unknown, use the default.
3✔
3939
                return s.cfg.MinBackoff
3✔
3940
        }
3✔
3941

3942
        // If the peer failed to start properly, we'll just use the previous
3943
        // backoff to compute the subsequent randomized exponential backoff
3944
        // duration. This will roughly double on average.
3945
        if startTime.IsZero() {
3✔
3946
                return computeNextBackoff(backoff, s.cfg.MaxBackoff)
×
3947
        }
×
3948

3949
        // The peer succeeded in starting. If the connection didn't last long
3950
        // enough to be considered stable, we'll continue to back off retries
3951
        // with this peer.
3952
        connDuration := time.Since(startTime)
3✔
3953
        if connDuration < defaultStableConnDuration {
6✔
3954
                return computeNextBackoff(backoff, s.cfg.MaxBackoff)
3✔
3955
        }
3✔
3956

3957
        // The peer succeed in starting and this was stable peer, so we'll
3958
        // reduce the timeout duration by the length of the connection after
3959
        // applying randomized exponential backoff. We'll only apply this in the
3960
        // case that:
3961
        //   reb(curBackoff) - connDuration > cfg.MinBackoff
3962
        relaxedBackoff := computeNextBackoff(backoff, s.cfg.MaxBackoff) - connDuration
×
3963
        if relaxedBackoff > s.cfg.MinBackoff {
×
3964
                return relaxedBackoff
×
3965
        }
×
3966

3967
        // Lastly, if reb(currBackoff) - connDuration <= cfg.MinBackoff, meaning
3968
        // the stable connection lasted much longer than our previous backoff.
3969
        // To reward such good behavior, we'll reconnect after the default
3970
        // timeout.
3971
        return s.cfg.MinBackoff
×
3972
}
3973

3974
// shouldDropLocalConnection determines if our local connection to a remote peer
3975
// should be dropped in the case of concurrent connection establishment. In
3976
// order to deterministically decide which connection should be dropped, we'll
3977
// utilize the ordering of the local and remote public key. If we didn't use
3978
// such a tie breaker, then we risk _both_ connections erroneously being
3979
// dropped.
3980
func shouldDropLocalConnection(local, remote *btcec.PublicKey) bool {
×
3981
        localPubBytes := local.SerializeCompressed()
×
3982
        remotePubPbytes := remote.SerializeCompressed()
×
3983

×
3984
        // The connection that comes from the node with a "smaller" pubkey
×
3985
        // should be kept. Therefore, if our pubkey is "greater" than theirs, we
×
3986
        // should drop our established connection.
×
3987
        return bytes.Compare(localPubBytes, remotePubPbytes) > 0
×
3988
}
×
3989

3990
// InboundPeerConnected initializes a new peer in response to a new inbound
3991
// connection.
3992
//
3993
// NOTE: This function is safe for concurrent access.
3994
func (s *server) InboundPeerConnected(conn net.Conn) {
3✔
3995
        // Exit early if we have already been instructed to shutdown, this
3✔
3996
        // prevents any delayed callbacks from accidentally registering peers.
3✔
3997
        if s.Stopped() {
3✔
3998
                return
×
3999
        }
×
4000

4001
        nodePub := conn.(*brontide.Conn).RemotePub()
3✔
4002
        pubSer := nodePub.SerializeCompressed()
3✔
4003
        pubStr := string(pubSer)
3✔
4004

3✔
4005
        var pubBytes [33]byte
3✔
4006
        copy(pubBytes[:], pubSer)
3✔
4007

3✔
4008
        s.mu.Lock()
3✔
4009
        defer s.mu.Unlock()
3✔
4010

3✔
4011
        // If the remote node's public key is banned, drop the connection.
3✔
4012
        access, err := s.peerAccessMan.assignPeerPerms(nodePub)
3✔
4013
        if err != nil {
3✔
4014
                // Clean up the persistent peer maps if we're dropping this
×
4015
                // connection.
×
4016
                s.bannedPersistentPeerConnection(pubStr)
×
4017

×
4018
                srvrLog.Debugf("Dropping connection for %x since we are out "+
×
4019
                        "of restricted-access connection slots: %v.", pubSer,
×
4020
                        err)
×
4021

×
4022
                conn.Close()
×
4023

×
4024
                return
×
4025
        }
×
4026

4027
        // If we already have an outbound connection to this peer, then ignore
4028
        // this new connection.
4029
        if p, ok := s.outboundPeers[pubStr]; ok {
6✔
4030
                srvrLog.Debugf("Already have outbound connection for %v, "+
3✔
4031
                        "ignoring inbound connection from local=%v, remote=%v",
3✔
4032
                        p, conn.LocalAddr(), conn.RemoteAddr())
3✔
4033

3✔
4034
                conn.Close()
3✔
4035
                return
3✔
4036
        }
3✔
4037

4038
        // If we already have a valid connection that is scheduled to take
4039
        // precedence once the prior peer has finished disconnecting, we'll
4040
        // ignore this connection.
4041
        if p, ok := s.scheduledPeerConnection[pubStr]; ok {
3✔
4042
                srvrLog.Debugf("Ignoring connection from %v, peer %v already "+
×
4043
                        "scheduled", conn.RemoteAddr(), p)
×
4044
                conn.Close()
×
4045
                return
×
4046
        }
×
4047

4048
        srvrLog.Infof("New inbound connection from %v", conn.RemoteAddr())
3✔
4049

3✔
4050
        // Check to see if we already have a connection with this peer. If so,
3✔
4051
        // we may need to drop our existing connection. This prevents us from
3✔
4052
        // having duplicate connections to the same peer. We forgo adding a
3✔
4053
        // default case as we expect these to be the only error values returned
3✔
4054
        // from findPeerByPubStr.
3✔
4055
        connectedPeer, err := s.findPeerByPubStr(pubStr)
3✔
4056
        switch err {
3✔
4057
        case ErrPeerNotConnected:
3✔
4058
                // We were unable to locate an existing connection with the
3✔
4059
                // target peer, proceed to connect.
3✔
4060
                s.cancelConnReqs(pubStr, nil)
3✔
4061
                s.peerConnected(conn, nil, true, access)
3✔
4062

4063
        case nil:
×
4064
                // We already have a connection with the incoming peer. If the
×
4065
                // connection we've already established should be kept and is
×
4066
                // not of the same type of the new connection (inbound), then
×
4067
                // we'll close out the new connection s.t there's only a single
×
4068
                // connection between us.
×
4069
                localPub := s.identityECDH.PubKey()
×
4070
                if !connectedPeer.Inbound() &&
×
4071
                        !shouldDropLocalConnection(localPub, nodePub) {
×
4072

×
4073
                        srvrLog.Warnf("Received inbound connection from "+
×
4074
                                "peer %v, but already have outbound "+
×
4075
                                "connection, dropping conn", connectedPeer)
×
4076
                        conn.Close()
×
4077
                        return
×
4078
                }
×
4079

4080
                // Otherwise, if we should drop the connection, then we'll
4081
                // disconnect our already connected peer.
4082
                srvrLog.Debugf("Disconnecting stale connection to %v",
×
4083
                        connectedPeer)
×
4084

×
4085
                s.cancelConnReqs(pubStr, nil)
×
4086

×
4087
                // Remove the current peer from the server's internal state and
×
4088
                // signal that the peer termination watcher does not need to
×
4089
                // execute for this peer.
×
4090
                s.removePeer(connectedPeer)
×
4091
                s.ignorePeerTermination[connectedPeer] = struct{}{}
×
4092
                s.scheduledPeerConnection[pubStr] = func() {
×
4093
                        s.peerConnected(conn, nil, true, access)
×
4094
                }
×
4095
        }
4096
}
4097

4098
// OutboundPeerConnected initializes a new peer in response to a new outbound
4099
// connection.
4100
// NOTE: This function is safe for concurrent access.
4101
func (s *server) OutboundPeerConnected(connReq *connmgr.ConnReq, conn net.Conn) {
3✔
4102
        // Exit early if we have already been instructed to shutdown, this
3✔
4103
        // prevents any delayed callbacks from accidentally registering peers.
3✔
4104
        if s.Stopped() {
3✔
4105
                return
×
4106
        }
×
4107

4108
        nodePub := conn.(*brontide.Conn).RemotePub()
3✔
4109
        pubSer := nodePub.SerializeCompressed()
3✔
4110
        pubStr := string(pubSer)
3✔
4111

3✔
4112
        var pubBytes [33]byte
3✔
4113
        copy(pubBytes[:], pubSer)
3✔
4114

3✔
4115
        s.mu.Lock()
3✔
4116
        defer s.mu.Unlock()
3✔
4117

3✔
4118
        access, err := s.peerAccessMan.assignPeerPerms(nodePub)
3✔
4119
        if err != nil {
3✔
4120
                // Clean up the persistent peer maps if we're dropping this
×
4121
                // connection.
×
4122
                s.bannedPersistentPeerConnection(pubStr)
×
4123

×
4124
                srvrLog.Debugf("Dropping connection for %x since we are out "+
×
4125
                        "of restricted-access connection slots: %v.", pubSer,
×
4126
                        err)
×
4127

×
4128
                if connReq != nil {
×
4129
                        s.connMgr.Remove(connReq.ID())
×
4130
                }
×
4131

4132
                conn.Close()
×
4133

×
4134
                return
×
4135
        }
4136

4137
        // If we already have an inbound connection to this peer, then ignore
4138
        // this new connection.
4139
        if p, ok := s.inboundPeers[pubStr]; ok {
6✔
4140
                srvrLog.Debugf("Already have inbound connection for %v, "+
3✔
4141
                        "ignoring outbound connection from local=%v, remote=%v",
3✔
4142
                        p, conn.LocalAddr(), conn.RemoteAddr())
3✔
4143

3✔
4144
                if connReq != nil {
6✔
4145
                        s.connMgr.Remove(connReq.ID())
3✔
4146
                }
3✔
4147
                conn.Close()
3✔
4148
                return
3✔
4149
        }
4150
        if _, ok := s.persistentConnReqs[pubStr]; !ok && connReq != nil {
3✔
4151
                srvrLog.Debugf("Ignoring canceled outbound connection")
×
4152
                s.connMgr.Remove(connReq.ID())
×
4153
                conn.Close()
×
4154
                return
×
4155
        }
×
4156

4157
        // If we already have a valid connection that is scheduled to take
4158
        // precedence once the prior peer has finished disconnecting, we'll
4159
        // ignore this connection.
4160
        if _, ok := s.scheduledPeerConnection[pubStr]; ok {
3✔
4161
                srvrLog.Debugf("Ignoring connection, peer already scheduled")
×
4162

×
4163
                if connReq != nil {
×
4164
                        s.connMgr.Remove(connReq.ID())
×
4165
                }
×
4166

4167
                conn.Close()
×
4168
                return
×
4169
        }
4170

4171
        srvrLog.Infof("Established connection to: %x@%v", pubStr,
3✔
4172
                conn.RemoteAddr())
3✔
4173

3✔
4174
        if connReq != nil {
6✔
4175
                // A successful connection was returned by the connmgr.
3✔
4176
                // Immediately cancel all pending requests, excluding the
3✔
4177
                // outbound connection we just established.
3✔
4178
                ignore := connReq.ID()
3✔
4179
                s.cancelConnReqs(pubStr, &ignore)
3✔
4180
        } else {
6✔
4181
                // This was a successful connection made by some other
3✔
4182
                // subsystem. Remove all requests being managed by the connmgr.
3✔
4183
                s.cancelConnReqs(pubStr, nil)
3✔
4184
        }
3✔
4185

4186
        // If we already have a connection with this peer, decide whether or not
4187
        // we need to drop the stale connection. We forgo adding a default case
4188
        // as we expect these to be the only error values returned from
4189
        // findPeerByPubStr.
4190
        connectedPeer, err := s.findPeerByPubStr(pubStr)
3✔
4191
        switch err {
3✔
4192
        case ErrPeerNotConnected:
3✔
4193
                // We were unable to locate an existing connection with the
3✔
4194
                // target peer, proceed to connect.
3✔
4195
                s.peerConnected(conn, connReq, false, access)
3✔
4196

4197
        case nil:
×
4198
                // We already have a connection with the incoming peer. If the
×
4199
                // connection we've already established should be kept and is
×
4200
                // not of the same type of the new connection (outbound), then
×
4201
                // we'll close out the new connection s.t there's only a single
×
4202
                // connection between us.
×
4203
                localPub := s.identityECDH.PubKey()
×
4204
                if connectedPeer.Inbound() &&
×
4205
                        shouldDropLocalConnection(localPub, nodePub) {
×
4206

×
4207
                        srvrLog.Warnf("Established outbound connection to "+
×
4208
                                "peer %v, but already have inbound "+
×
4209
                                "connection, dropping conn", connectedPeer)
×
4210
                        if connReq != nil {
×
4211
                                s.connMgr.Remove(connReq.ID())
×
4212
                        }
×
4213
                        conn.Close()
×
4214
                        return
×
4215
                }
4216

4217
                // Otherwise, _their_ connection should be dropped. So we'll
4218
                // disconnect the peer and send the now obsolete peer to the
4219
                // server for garbage collection.
4220
                srvrLog.Debugf("Disconnecting stale connection to %v",
×
4221
                        connectedPeer)
×
4222

×
4223
                // Remove the current peer from the server's internal state and
×
4224
                // signal that the peer termination watcher does not need to
×
4225
                // execute for this peer.
×
4226
                s.removePeer(connectedPeer)
×
4227
                s.ignorePeerTermination[connectedPeer] = struct{}{}
×
4228
                s.scheduledPeerConnection[pubStr] = func() {
×
4229
                        s.peerConnected(conn, connReq, false, access)
×
4230
                }
×
4231
        }
4232
}
4233

4234
// UnassignedConnID is the default connection ID that a request can have before
4235
// it actually is submitted to the connmgr.
4236
// TODO(conner): move into connmgr package, or better, add connmgr method for
4237
// generating atomic IDs
4238
const UnassignedConnID uint64 = 0
4239

4240
// cancelConnReqs stops all persistent connection requests for a given pubkey.
4241
// Any attempts initiated by the peerTerminationWatcher are canceled first.
4242
// Afterwards, each connection request removed from the connmgr. The caller can
4243
// optionally specify a connection ID to ignore, which prevents us from
4244
// canceling a successful request. All persistent connreqs for the provided
4245
// pubkey are discarded after the operationjw.
4246
func (s *server) cancelConnReqs(pubStr string, skip *uint64) {
3✔
4247
        // First, cancel any lingering persistent retry attempts, which will
3✔
4248
        // prevent retries for any with backoffs that are still maturing.
3✔
4249
        if cancelChan, ok := s.persistentRetryCancels[pubStr]; ok {
6✔
4250
                close(cancelChan)
3✔
4251
                delete(s.persistentRetryCancels, pubStr)
3✔
4252
        }
3✔
4253

4254
        // Next, check to see if we have any outstanding persistent connection
4255
        // requests to this peer. If so, then we'll remove all of these
4256
        // connection requests, and also delete the entry from the map.
4257
        connReqs, ok := s.persistentConnReqs[pubStr]
3✔
4258
        if !ok {
6✔
4259
                return
3✔
4260
        }
3✔
4261

4262
        for _, connReq := range connReqs {
6✔
4263
                srvrLog.Tracef("Canceling %s:", connReqs)
3✔
4264

3✔
4265
                // Atomically capture the current request identifier.
3✔
4266
                connID := connReq.ID()
3✔
4267

3✔
4268
                // Skip any zero IDs, this indicates the request has not
3✔
4269
                // yet been schedule.
3✔
4270
                if connID == UnassignedConnID {
3✔
4271
                        continue
×
4272
                }
4273

4274
                // Skip a particular connection ID if instructed.
4275
                if skip != nil && connID == *skip {
6✔
4276
                        continue
3✔
4277
                }
4278

4279
                s.connMgr.Remove(connID)
3✔
4280
        }
4281

4282
        delete(s.persistentConnReqs, pubStr)
3✔
4283
}
4284

4285
// handleCustomMessage dispatches an incoming custom peers message to
4286
// subscribers.
4287
func (s *server) handleCustomMessage(peer [33]byte, msg *lnwire.Custom) error {
3✔
4288
        srvrLog.Debugf("Custom message received: peer=%x, type=%d",
3✔
4289
                peer, msg.Type)
3✔
4290

3✔
4291
        return s.customMessageServer.SendUpdate(&CustomMessage{
3✔
4292
                Peer: peer,
3✔
4293
                Msg:  msg,
3✔
4294
        })
3✔
4295
}
3✔
4296

4297
// SubscribeCustomMessages subscribes to a stream of incoming custom peer
4298
// messages.
4299
func (s *server) SubscribeCustomMessages() (*subscribe.Client, error) {
3✔
4300
        return s.customMessageServer.Subscribe()
3✔
4301
}
3✔
4302

4303
// notifyOpenChannelPeerEvent updates the access manager's maps and then calls
4304
// the channelNotifier's NotifyOpenChannelEvent.
4305
func (s *server) notifyOpenChannelPeerEvent(op wire.OutPoint,
4306
        remotePub *btcec.PublicKey) error {
3✔
4307

3✔
4308
        // Call newOpenChan to update the access manager's maps for this peer.
3✔
4309
        if err := s.peerAccessMan.newOpenChan(remotePub); err != nil {
6✔
4310
                return err
3✔
4311
        }
3✔
4312

4313
        // Notify subscribers about this open channel event.
4314
        s.channelNotifier.NotifyOpenChannelEvent(op)
3✔
4315

3✔
4316
        return nil
3✔
4317
}
4318

4319
// notifyPendingOpenChannelPeerEvent updates the access manager's maps and then
4320
// calls the channelNotifier's NotifyPendingOpenChannelEvent.
4321
func (s *server) notifyPendingOpenChannelPeerEvent(op wire.OutPoint,
4322
        pendingChan *channeldb.OpenChannel, remotePub *btcec.PublicKey) error {
3✔
4323

3✔
4324
        // Call newPendingOpenChan to update the access manager's maps for this
3✔
4325
        // peer.
3✔
4326
        if err := s.peerAccessMan.newPendingOpenChan(remotePub); err != nil {
3✔
4327
                return err
×
4328
        }
×
4329

4330
        // Notify subscribers about this event.
4331
        s.channelNotifier.NotifyPendingOpenChannelEvent(op, pendingChan)
3✔
4332

3✔
4333
        return nil
3✔
4334
}
4335

4336
// notifyFundingTimeoutPeerEvent updates the access manager's maps and then
4337
// calls the channelNotifier's NotifyFundingTimeout.
4338
func (s *server) notifyFundingTimeoutPeerEvent(op wire.OutPoint,
4339
        remotePub *btcec.PublicKey) error {
3✔
4340

3✔
4341
        // Call newPendingCloseChan to potentially demote the peer.
3✔
4342
        err := s.peerAccessMan.newPendingCloseChan(remotePub)
3✔
4343
        if errors.Is(err, ErrNoMoreRestrictedAccessSlots) {
3✔
4344
                // If we encounter an error while attempting to disconnect the
×
4345
                // peer, log the error.
×
4346
                if dcErr := s.DisconnectPeer(remotePub); dcErr != nil {
×
4347
                        srvrLog.Errorf("Unable to disconnect peer: %v\n", err)
×
4348
                }
×
4349
        }
4350

4351
        // Notify subscribers about this event.
4352
        s.channelNotifier.NotifyFundingTimeout(op)
3✔
4353

3✔
4354
        return nil
3✔
4355
}
4356

4357
// peerConnected is a function that handles initialization a newly connected
4358
// peer by adding it to the server's global list of all active peers, and
4359
// starting all the goroutines the peer needs to function properly. The inbound
4360
// boolean should be true if the peer initiated the connection to us.
4361
func (s *server) peerConnected(conn net.Conn, connReq *connmgr.ConnReq,
4362
        inbound bool, access peerAccessStatus) {
3✔
4363

3✔
4364
        brontideConn := conn.(*brontide.Conn)
3✔
4365
        addr := conn.RemoteAddr()
3✔
4366
        pubKey := brontideConn.RemotePub()
3✔
4367

3✔
4368
        srvrLog.Infof("Finalizing connection to %x@%s, inbound=%v",
3✔
4369
                pubKey.SerializeCompressed(), addr, inbound)
3✔
4370

3✔
4371
        peerAddr := &lnwire.NetAddress{
3✔
4372
                IdentityKey: pubKey,
3✔
4373
                Address:     addr,
3✔
4374
                ChainNet:    s.cfg.ActiveNetParams.Net,
3✔
4375
        }
3✔
4376

3✔
4377
        // With the brontide connection established, we'll now craft the feature
3✔
4378
        // vectors to advertise to the remote node.
3✔
4379
        initFeatures := s.featureMgr.Get(feature.SetInit)
3✔
4380
        legacyFeatures := s.featureMgr.Get(feature.SetLegacyGlobal)
3✔
4381

3✔
4382
        // Lookup past error caches for the peer in the server. If no buffer is
3✔
4383
        // found, create a fresh buffer.
3✔
4384
        pkStr := string(peerAddr.IdentityKey.SerializeCompressed())
3✔
4385
        errBuffer, ok := s.peerErrors[pkStr]
3✔
4386
        if !ok {
6✔
4387
                var err error
3✔
4388
                errBuffer, err = queue.NewCircularBuffer(peer.ErrorBufferSize)
3✔
4389
                if err != nil {
3✔
4390
                        srvrLog.Errorf("unable to create peer %v", err)
×
4391
                        return
×
4392
                }
×
4393
        }
4394

4395
        // If we directly set the peer.Config TowerClient member to the
4396
        // s.towerClientMgr then in the case that the s.towerClientMgr is nil,
4397
        // the peer.Config's TowerClient member will not evaluate to nil even
4398
        // though the underlying value is nil. To avoid this gotcha which can
4399
        // cause a panic, we need to explicitly pass nil to the peer.Config's
4400
        // TowerClient if needed.
4401
        var towerClient wtclient.ClientManager
3✔
4402
        if s.towerClientMgr != nil {
6✔
4403
                towerClient = s.towerClientMgr
3✔
4404
        }
3✔
4405

4406
        thresholdSats := btcutil.Amount(s.cfg.MaxFeeExposure)
3✔
4407
        thresholdMSats := lnwire.NewMSatFromSatoshis(thresholdSats)
3✔
4408

3✔
4409
        // Now that we've established a connection, create a peer, and it to the
3✔
4410
        // set of currently active peers. Configure the peer with the incoming
3✔
4411
        // and outgoing broadcast deltas to prevent htlcs from being accepted or
3✔
4412
        // offered that would trigger channel closure. In case of outgoing
3✔
4413
        // htlcs, an extra block is added to prevent the channel from being
3✔
4414
        // closed when the htlc is outstanding and a new block comes in.
3✔
4415
        pCfg := peer.Config{
3✔
4416
                Conn:                    brontideConn,
3✔
4417
                ConnReq:                 connReq,
3✔
4418
                Addr:                    peerAddr,
3✔
4419
                Inbound:                 inbound,
3✔
4420
                Features:                initFeatures,
3✔
4421
                LegacyFeatures:          legacyFeatures,
3✔
4422
                OutgoingCltvRejectDelta: lncfg.DefaultOutgoingCltvRejectDelta,
3✔
4423
                ChanActiveTimeout:       s.cfg.ChanEnableTimeout,
3✔
4424
                ErrorBuffer:             errBuffer,
3✔
4425
                WritePool:               s.writePool,
3✔
4426
                ReadPool:                s.readPool,
3✔
4427
                Switch:                  s.htlcSwitch,
3✔
4428
                InterceptSwitch:         s.interceptableSwitch,
3✔
4429
                ChannelDB:               s.chanStateDB,
3✔
4430
                ChannelGraph:            s.graphDB,
3✔
4431
                ChainArb:                s.chainArb,
3✔
4432
                AuthGossiper:            s.authGossiper,
3✔
4433
                ChanStatusMgr:           s.chanStatusMgr,
3✔
4434
                ChainIO:                 s.cc.ChainIO,
3✔
4435
                FeeEstimator:            s.cc.FeeEstimator,
3✔
4436
                Signer:                  s.cc.Wallet.Cfg.Signer,
3✔
4437
                SigPool:                 s.sigPool,
3✔
4438
                Wallet:                  s.cc.Wallet,
3✔
4439
                ChainNotifier:           s.cc.ChainNotifier,
3✔
4440
                BestBlockView:           s.cc.BestBlockTracker,
3✔
4441
                RoutingPolicy:           s.cc.RoutingPolicy,
3✔
4442
                Sphinx:                  s.sphinx,
3✔
4443
                WitnessBeacon:           s.witnessBeacon,
3✔
4444
                Invoices:                s.invoices,
3✔
4445
                ChannelNotifier:         s.channelNotifier,
3✔
4446
                HtlcNotifier:            s.htlcNotifier,
3✔
4447
                TowerClient:             towerClient,
3✔
4448
                DisconnectPeer:          s.DisconnectPeer,
3✔
4449
                GenNodeAnnouncement: func(...netann.NodeAnnModifier) (
3✔
4450
                        lnwire.NodeAnnouncement, error) {
6✔
4451

3✔
4452
                        return s.genNodeAnnouncement(nil)
3✔
4453
                },
3✔
4454

4455
                PongBuf: s.pongBuf,
4456

4457
                PrunePersistentPeerConnection: s.prunePersistentPeerConnection,
4458

4459
                FetchLastChanUpdate: s.fetchLastChanUpdate(),
4460

4461
                FundingManager: s.fundingMgr,
4462

4463
                Hodl:                    s.cfg.Hodl,
4464
                UnsafeReplay:            s.cfg.UnsafeReplay,
4465
                MaxOutgoingCltvExpiry:   s.cfg.MaxOutgoingCltvExpiry,
4466
                MaxChannelFeeAllocation: s.cfg.MaxChannelFeeAllocation,
4467
                CoopCloseTargetConfs:    s.cfg.CoopCloseTargetConfs,
4468
                MaxAnchorsCommitFeeRate: chainfee.SatPerKVByte(
4469
                        s.cfg.MaxCommitFeeRateAnchors * 1000).FeePerKWeight(),
4470
                ChannelCommitInterval:  s.cfg.ChannelCommitInterval,
4471
                PendingCommitInterval:  s.cfg.PendingCommitInterval,
4472
                ChannelCommitBatchSize: s.cfg.ChannelCommitBatchSize,
4473
                HandleCustomMessage:    s.handleCustomMessage,
4474
                GetAliases:             s.aliasMgr.GetAliases,
4475
                RequestAlias:           s.aliasMgr.RequestAlias,
4476
                AddLocalAlias:          s.aliasMgr.AddLocalAlias,
4477
                DisallowRouteBlinding:  s.cfg.ProtocolOptions.NoRouteBlinding(),
4478
                DisallowQuiescence:     s.cfg.ProtocolOptions.NoQuiescence(),
4479
                MaxFeeExposure:         thresholdMSats,
4480
                Quit:                   s.quit,
4481
                AuxLeafStore:           s.implCfg.AuxLeafStore,
4482
                AuxSigner:              s.implCfg.AuxSigner,
4483
                MsgRouter:              s.implCfg.MsgRouter,
4484
                AuxChanCloser:          s.implCfg.AuxChanCloser,
4485
                AuxResolver:            s.implCfg.AuxContractResolver,
4486
                AuxTrafficShaper:       s.implCfg.TrafficShaper,
4487
                ShouldFwdExpEndorsement: func() bool {
3✔
4488
                        if s.cfg.ProtocolOptions.NoExperimentalEndorsement() {
6✔
4489
                                return false
3✔
4490
                        }
3✔
4491

4492
                        return clock.NewDefaultClock().Now().Before(
3✔
4493
                                EndorsementExperimentEnd,
3✔
4494
                        )
3✔
4495
                },
4496
        }
4497

4498
        copy(pCfg.PubKeyBytes[:], peerAddr.IdentityKey.SerializeCompressed())
3✔
4499
        copy(pCfg.ServerPubKey[:], s.identityECDH.PubKey().SerializeCompressed())
3✔
4500

3✔
4501
        p := peer.NewBrontide(pCfg)
3✔
4502

3✔
4503
        // Update the access manager with the access permission for this peer.
3✔
4504
        s.peerAccessMan.addPeerAccess(pubKey, access)
3✔
4505

3✔
4506
        // TODO(roasbeef): update IP address for link-node
3✔
4507
        //  * also mark last-seen, do it one single transaction?
3✔
4508

3✔
4509
        s.addPeer(p)
3✔
4510

3✔
4511
        // Once we have successfully added the peer to the server, we can
3✔
4512
        // delete the previous error buffer from the server's map of error
3✔
4513
        // buffers.
3✔
4514
        delete(s.peerErrors, pkStr)
3✔
4515

3✔
4516
        // Dispatch a goroutine to asynchronously start the peer. This process
3✔
4517
        // includes sending and receiving Init messages, which would be a DOS
3✔
4518
        // vector if we held the server's mutex throughout the procedure.
3✔
4519
        s.wg.Add(1)
3✔
4520
        go s.peerInitializer(p)
3✔
4521
}
4522

4523
// addPeer adds the passed peer to the server's global state of all active
4524
// peers.
4525
func (s *server) addPeer(p *peer.Brontide) {
3✔
4526
        if p == nil {
3✔
4527
                return
×
4528
        }
×
4529

4530
        pubBytes := p.IdentityKey().SerializeCompressed()
3✔
4531

3✔
4532
        // Ignore new peers if we're shutting down.
3✔
4533
        if s.Stopped() {
3✔
4534
                srvrLog.Infof("Server stopped, skipped adding peer=%x",
×
4535
                        pubBytes)
×
4536
                p.Disconnect(ErrServerShuttingDown)
×
4537

×
4538
                return
×
4539
        }
×
4540

4541
        // Track the new peer in our indexes so we can quickly look it up either
4542
        // according to its public key, or its peer ID.
4543
        // TODO(roasbeef): pipe all requests through to the
4544
        // queryHandler/peerManager
4545

4546
        // NOTE: This pubStr is a raw bytes to string conversion and will NOT
4547
        // be human-readable.
4548
        pubStr := string(pubBytes)
3✔
4549

3✔
4550
        s.peersByPub[pubStr] = p
3✔
4551

3✔
4552
        if p.Inbound() {
6✔
4553
                s.inboundPeers[pubStr] = p
3✔
4554
        } else {
6✔
4555
                s.outboundPeers[pubStr] = p
3✔
4556
        }
3✔
4557

4558
        // Inform the peer notifier of a peer online event so that it can be reported
4559
        // to clients listening for peer events.
4560
        var pubKey [33]byte
3✔
4561
        copy(pubKey[:], pubBytes)
3✔
4562

3✔
4563
        s.peerNotifier.NotifyPeerOnline(pubKey)
3✔
4564
}
4565

4566
// peerInitializer asynchronously starts a newly connected peer after it has
4567
// been added to the server's peer map. This method sets up a
4568
// peerTerminationWatcher for the given peer, and ensures that it executes even
4569
// if the peer failed to start. In the event of a successful connection, this
4570
// method reads the negotiated, local feature-bits and spawns the appropriate
4571
// graph synchronization method. Any registered clients of NotifyWhenOnline will
4572
// be signaled of the new peer once the method returns.
4573
//
4574
// NOTE: This MUST be launched as a goroutine.
4575
func (s *server) peerInitializer(p *peer.Brontide) {
3✔
4576
        defer s.wg.Done()
3✔
4577

3✔
4578
        pubBytes := p.IdentityKey().SerializeCompressed()
3✔
4579

3✔
4580
        // Avoid initializing peers while the server is exiting.
3✔
4581
        if s.Stopped() {
3✔
4582
                srvrLog.Infof("Server stopped, skipped initializing peer=%x",
×
4583
                        pubBytes)
×
4584
                return
×
4585
        }
×
4586

4587
        // Create a channel that will be used to signal a successful start of
4588
        // the link. This prevents the peer termination watcher from beginning
4589
        // its duty too early.
4590
        ready := make(chan struct{})
3✔
4591

3✔
4592
        // Before starting the peer, launch a goroutine to watch for the
3✔
4593
        // unexpected termination of this peer, which will ensure all resources
3✔
4594
        // are properly cleaned up, and re-establish persistent connections when
3✔
4595
        // necessary. The peer termination watcher will be short circuited if
3✔
4596
        // the peer is ever added to the ignorePeerTermination map, indicating
3✔
4597
        // that the server has already handled the removal of this peer.
3✔
4598
        s.wg.Add(1)
3✔
4599
        go s.peerTerminationWatcher(p, ready)
3✔
4600

3✔
4601
        // Start the peer! If an error occurs, we Disconnect the peer, which
3✔
4602
        // will unblock the peerTerminationWatcher.
3✔
4603
        if err := p.Start(); err != nil {
6✔
4604
                srvrLog.Warnf("Starting peer=%x got error: %v", pubBytes, err)
3✔
4605

3✔
4606
                p.Disconnect(fmt.Errorf("unable to start peer: %w", err))
3✔
4607
                return
3✔
4608
        }
3✔
4609

4610
        // Otherwise, signal to the peerTerminationWatcher that the peer startup
4611
        // was successful, and to begin watching the peer's wait group.
4612
        close(ready)
3✔
4613

3✔
4614
        s.mu.Lock()
3✔
4615
        defer s.mu.Unlock()
3✔
4616

3✔
4617
        // Check if there are listeners waiting for this peer to come online.
3✔
4618
        srvrLog.Debugf("Notifying that peer %v is online", p)
3✔
4619

3✔
4620
        // TODO(guggero): Do a proper conversion to a string everywhere, or use
3✔
4621
        // route.Vertex as the key type of peerConnectedListeners.
3✔
4622
        pubStr := string(pubBytes)
3✔
4623
        for _, peerChan := range s.peerConnectedListeners[pubStr] {
6✔
4624
                select {
3✔
4625
                case peerChan <- p:
3✔
4626
                case <-s.quit:
×
4627
                        return
×
4628
                }
4629
        }
4630
        delete(s.peerConnectedListeners, pubStr)
3✔
4631
}
4632

4633
// peerTerminationWatcher waits until a peer has been disconnected unexpectedly,
4634
// and then cleans up all resources allocated to the peer, notifies relevant
4635
// sub-systems of its demise, and finally handles re-connecting to the peer if
4636
// it's persistent. If the server intentionally disconnects a peer, it should
4637
// have a corresponding entry in the ignorePeerTermination map which will cause
4638
// the cleanup routine to exit early. The passed `ready` chan is used to
4639
// synchronize when WaitForDisconnect should begin watching on the peer's
4640
// waitgroup. The ready chan should only be signaled if the peer starts
4641
// successfully, otherwise the peer should be disconnected instead.
4642
//
4643
// NOTE: This MUST be launched as a goroutine.
4644
func (s *server) peerTerminationWatcher(p *peer.Brontide, ready chan struct{}) {
3✔
4645
        defer s.wg.Done()
3✔
4646

3✔
4647
        p.WaitForDisconnect(ready)
3✔
4648

3✔
4649
        srvrLog.Debugf("Peer %v has been disconnected", p)
3✔
4650

3✔
4651
        // If the server is exiting then we can bail out early ourselves as all
3✔
4652
        // the other sub-systems will already be shutting down.
3✔
4653
        if s.Stopped() {
6✔
4654
                srvrLog.Debugf("Server quitting, exit early for peer %v", p)
3✔
4655
                return
3✔
4656
        }
3✔
4657

4658
        // Next, we'll cancel all pending funding reservations with this node.
4659
        // If we tried to initiate any funding flows that haven't yet finished,
4660
        // then we need to unlock those committed outputs so they're still
4661
        // available for use.
4662
        s.fundingMgr.CancelPeerReservations(p.PubKey())
3✔
4663

3✔
4664
        pubKey := p.IdentityKey()
3✔
4665

3✔
4666
        // We'll also inform the gossiper that this peer is no longer active,
3✔
4667
        // so we don't need to maintain sync state for it any longer.
3✔
4668
        s.authGossiper.PruneSyncState(p.PubKey())
3✔
4669

3✔
4670
        // Tell the switch to remove all links associated with this peer.
3✔
4671
        // Passing nil as the target link indicates that all links associated
3✔
4672
        // with this interface should be closed.
3✔
4673
        //
3✔
4674
        // TODO(roasbeef): instead add a PurgeInterfaceLinks function?
3✔
4675
        links, err := s.htlcSwitch.GetLinksByInterface(p.PubKey())
3✔
4676
        if err != nil && err != htlcswitch.ErrNoLinksFound {
3✔
4677
                srvrLog.Errorf("Unable to get channel links for %v: %v", p, err)
×
4678
        }
×
4679

4680
        for _, link := range links {
6✔
4681
                s.htlcSwitch.RemoveLink(link.ChanID())
3✔
4682
        }
3✔
4683

4684
        s.mu.Lock()
3✔
4685
        defer s.mu.Unlock()
3✔
4686

3✔
4687
        // If there were any notification requests for when this peer
3✔
4688
        // disconnected, we can trigger them now.
3✔
4689
        srvrLog.Debugf("Notifying that peer %v is offline", p)
3✔
4690
        pubStr := string(pubKey.SerializeCompressed())
3✔
4691
        for _, offlineChan := range s.peerDisconnectedListeners[pubStr] {
6✔
4692
                close(offlineChan)
3✔
4693
        }
3✔
4694
        delete(s.peerDisconnectedListeners, pubStr)
3✔
4695

3✔
4696
        // If the server has already removed this peer, we can short circuit the
3✔
4697
        // peer termination watcher and skip cleanup.
3✔
4698
        if _, ok := s.ignorePeerTermination[p]; ok {
3✔
4699
                delete(s.ignorePeerTermination, p)
×
4700

×
4701
                pubKey := p.PubKey()
×
4702
                pubStr := string(pubKey[:])
×
4703

×
4704
                // If a connection callback is present, we'll go ahead and
×
4705
                // execute it now that previous peer has fully disconnected. If
×
4706
                // the callback is not present, this likely implies the peer was
×
4707
                // purposefully disconnected via RPC, and that no reconnect
×
4708
                // should be attempted.
×
4709
                connCallback, ok := s.scheduledPeerConnection[pubStr]
×
4710
                if ok {
×
4711
                        delete(s.scheduledPeerConnection, pubStr)
×
4712
                        connCallback()
×
4713
                }
×
4714
                return
×
4715
        }
4716

4717
        // First, cleanup any remaining state the server has regarding the peer
4718
        // in question.
4719
        s.removePeer(p)
3✔
4720

3✔
4721
        // Next, check to see if this is a persistent peer or not.
3✔
4722
        if _, ok := s.persistentPeers[pubStr]; !ok {
6✔
4723
                return
3✔
4724
        }
3✔
4725

4726
        // Get the last address that we used to connect to the peer.
4727
        addrs := []net.Addr{
3✔
4728
                p.NetAddress().Address,
3✔
4729
        }
3✔
4730

3✔
4731
        // We'll ensure that we locate all the peers advertised addresses for
3✔
4732
        // reconnection purposes.
3✔
4733
        advertisedAddrs, err := s.fetchNodeAdvertisedAddrs(pubKey)
3✔
4734
        switch {
3✔
4735
        // We found advertised addresses, so use them.
4736
        case err == nil:
3✔
4737
                addrs = advertisedAddrs
3✔
4738

4739
        // The peer doesn't have an advertised address.
4740
        case err == errNoAdvertisedAddr:
3✔
4741
                // If it is an outbound peer then we fall back to the existing
3✔
4742
                // peer address.
3✔
4743
                if !p.Inbound() {
6✔
4744
                        break
3✔
4745
                }
4746

4747
                // Fall back to the existing peer address if
4748
                // we're not accepting connections over Tor.
4749
                if s.torController == nil {
6✔
4750
                        break
3✔
4751
                }
4752

4753
                // If we are, the peer's address won't be known
4754
                // to us (we'll see a private address, which is
4755
                // the address used by our onion service to dial
4756
                // to lnd), so we don't have enough information
4757
                // to attempt a reconnect.
4758
                srvrLog.Debugf("Ignoring reconnection attempt "+
×
4759
                        "to inbound peer %v without "+
×
4760
                        "advertised address", p)
×
4761
                return
×
4762

4763
        // We came across an error retrieving an advertised
4764
        // address, log it, and fall back to the existing peer
4765
        // address.
4766
        default:
3✔
4767
                srvrLog.Errorf("Unable to retrieve advertised "+
3✔
4768
                        "address for node %x: %v", p.PubKey(),
3✔
4769
                        err)
3✔
4770
        }
4771

4772
        // Make an easy lookup map so that we can check if an address
4773
        // is already in the address list that we have stored for this peer.
4774
        existingAddrs := make(map[string]bool)
3✔
4775
        for _, addr := range s.persistentPeerAddrs[pubStr] {
6✔
4776
                existingAddrs[addr.String()] = true
3✔
4777
        }
3✔
4778

4779
        // Add any missing addresses for this peer to persistentPeerAddr.
4780
        for _, addr := range addrs {
6✔
4781
                if existingAddrs[addr.String()] {
3✔
4782
                        continue
×
4783
                }
4784

4785
                s.persistentPeerAddrs[pubStr] = append(
3✔
4786
                        s.persistentPeerAddrs[pubStr],
3✔
4787
                        &lnwire.NetAddress{
3✔
4788
                                IdentityKey: p.IdentityKey(),
3✔
4789
                                Address:     addr,
3✔
4790
                                ChainNet:    p.NetAddress().ChainNet,
3✔
4791
                        },
3✔
4792
                )
3✔
4793
        }
4794

4795
        // Record the computed backoff in the backoff map.
4796
        backoff := s.nextPeerBackoff(pubStr, p.StartTime())
3✔
4797
        s.persistentPeersBackoff[pubStr] = backoff
3✔
4798

3✔
4799
        // Initialize a retry canceller for this peer if one does not
3✔
4800
        // exist.
3✔
4801
        cancelChan, ok := s.persistentRetryCancels[pubStr]
3✔
4802
        if !ok {
6✔
4803
                cancelChan = make(chan struct{})
3✔
4804
                s.persistentRetryCancels[pubStr] = cancelChan
3✔
4805
        }
3✔
4806

4807
        // We choose not to wait group this go routine since the Connect
4808
        // call can stall for arbitrarily long if we shutdown while an
4809
        // outbound connection attempt is being made.
4810
        go func() {
6✔
4811
                srvrLog.Debugf("Scheduling connection re-establishment to "+
3✔
4812
                        "persistent peer %x in %s",
3✔
4813
                        p.IdentityKey().SerializeCompressed(), backoff)
3✔
4814

3✔
4815
                select {
3✔
4816
                case <-time.After(backoff):
3✔
4817
                case <-cancelChan:
3✔
4818
                        return
3✔
4819
                case <-s.quit:
3✔
4820
                        return
3✔
4821
                }
4822

4823
                srvrLog.Debugf("Attempting to re-establish persistent "+
3✔
4824
                        "connection to peer %x",
3✔
4825
                        p.IdentityKey().SerializeCompressed())
3✔
4826

3✔
4827
                s.connectToPersistentPeer(pubStr)
3✔
4828
        }()
4829
}
4830

4831
// connectToPersistentPeer uses all the stored addresses for a peer to attempt
4832
// to connect to the peer. It creates connection requests if there are
4833
// currently none for a given address and it removes old connection requests
4834
// if the associated address is no longer in the latest address list for the
4835
// peer.
4836
func (s *server) connectToPersistentPeer(pubKeyStr string) {
3✔
4837
        s.mu.Lock()
3✔
4838
        defer s.mu.Unlock()
3✔
4839

3✔
4840
        // Create an easy lookup map of the addresses we have stored for the
3✔
4841
        // peer. We will remove entries from this map if we have existing
3✔
4842
        // connection requests for the associated address and then any leftover
3✔
4843
        // entries will indicate which addresses we should create new
3✔
4844
        // connection requests for.
3✔
4845
        addrMap := make(map[string]*lnwire.NetAddress)
3✔
4846
        for _, addr := range s.persistentPeerAddrs[pubKeyStr] {
6✔
4847
                addrMap[addr.String()] = addr
3✔
4848
        }
3✔
4849

4850
        // Go through each of the existing connection requests and
4851
        // check if they correspond to the latest set of addresses. If
4852
        // there is a connection requests that does not use one of the latest
4853
        // advertised addresses then remove that connection request.
4854
        var updatedConnReqs []*connmgr.ConnReq
3✔
4855
        for _, connReq := range s.persistentConnReqs[pubKeyStr] {
6✔
4856
                lnAddr := connReq.Addr.(*lnwire.NetAddress).Address.String()
3✔
4857

3✔
4858
                switch _, ok := addrMap[lnAddr]; ok {
3✔
4859
                // If the existing connection request is using one of the
4860
                // latest advertised addresses for the peer then we add it to
4861
                // updatedConnReqs and remove the associated address from
4862
                // addrMap so that we don't recreate this connReq later on.
4863
                case true:
×
4864
                        updatedConnReqs = append(
×
4865
                                updatedConnReqs, connReq,
×
4866
                        )
×
4867
                        delete(addrMap, lnAddr)
×
4868

4869
                // If the existing connection request is using an address that
4870
                // is not one of the latest advertised addresses for the peer
4871
                // then we remove the connecting request from the connection
4872
                // manager.
4873
                case false:
3✔
4874
                        srvrLog.Info(
3✔
4875
                                "Removing conn req:", connReq.Addr.String(),
3✔
4876
                        )
3✔
4877
                        s.connMgr.Remove(connReq.ID())
3✔
4878
                }
4879
        }
4880

4881
        s.persistentConnReqs[pubKeyStr] = updatedConnReqs
3✔
4882

3✔
4883
        cancelChan, ok := s.persistentRetryCancels[pubKeyStr]
3✔
4884
        if !ok {
6✔
4885
                cancelChan = make(chan struct{})
3✔
4886
                s.persistentRetryCancels[pubKeyStr] = cancelChan
3✔
4887
        }
3✔
4888

4889
        // Any addresses left in addrMap are new ones that we have not made
4890
        // connection requests for. So create new connection requests for those.
4891
        // If there is more than one address in the address map, stagger the
4892
        // creation of the connection requests for those.
4893
        go func() {
6✔
4894
                ticker := time.NewTicker(multiAddrConnectionStagger)
3✔
4895
                defer ticker.Stop()
3✔
4896

3✔
4897
                for _, addr := range addrMap {
6✔
4898
                        // Send the persistent connection request to the
3✔
4899
                        // connection manager, saving the request itself so we
3✔
4900
                        // can cancel/restart the process as needed.
3✔
4901
                        connReq := &connmgr.ConnReq{
3✔
4902
                                Addr:      addr,
3✔
4903
                                Permanent: true,
3✔
4904
                        }
3✔
4905

3✔
4906
                        s.mu.Lock()
3✔
4907
                        s.persistentConnReqs[pubKeyStr] = append(
3✔
4908
                                s.persistentConnReqs[pubKeyStr], connReq,
3✔
4909
                        )
3✔
4910
                        s.mu.Unlock()
3✔
4911

3✔
4912
                        srvrLog.Debugf("Attempting persistent connection to "+
3✔
4913
                                "channel peer %v", addr)
3✔
4914

3✔
4915
                        go s.connMgr.Connect(connReq)
3✔
4916

3✔
4917
                        select {
3✔
4918
                        case <-s.quit:
3✔
4919
                                return
3✔
4920
                        case <-cancelChan:
3✔
4921
                                return
3✔
4922
                        case <-ticker.C:
3✔
4923
                        }
4924
                }
4925
        }()
4926
}
4927

4928
// removePeer removes the passed peer from the server's state of all active
4929
// peers.
4930
func (s *server) removePeer(p *peer.Brontide) {
3✔
4931
        if p == nil {
3✔
4932
                return
×
4933
        }
×
4934

4935
        srvrLog.Debugf("removing peer %v", p)
3✔
4936

3✔
4937
        // As the peer is now finished, ensure that the TCP connection is
3✔
4938
        // closed and all of its related goroutines have exited.
3✔
4939
        p.Disconnect(fmt.Errorf("server: disconnecting peer %v", p))
3✔
4940

3✔
4941
        // If this peer had an active persistent connection request, remove it.
3✔
4942
        if p.ConnReq() != nil {
6✔
4943
                s.connMgr.Remove(p.ConnReq().ID())
3✔
4944
        }
3✔
4945

4946
        // Ignore deleting peers if we're shutting down.
4947
        if s.Stopped() {
3✔
4948
                return
×
4949
        }
×
4950

4951
        pKey := p.PubKey()
3✔
4952
        pubSer := pKey[:]
3✔
4953
        pubStr := string(pubSer)
3✔
4954

3✔
4955
        delete(s.peersByPub, pubStr)
3✔
4956

3✔
4957
        if p.Inbound() {
6✔
4958
                delete(s.inboundPeers, pubStr)
3✔
4959
        } else {
6✔
4960
                delete(s.outboundPeers, pubStr)
3✔
4961
        }
3✔
4962

4963
        // Remove the peer's access permission from the access manager.
4964
        s.peerAccessMan.removePeerAccess(p.IdentityKey())
3✔
4965

3✔
4966
        // Copy the peer's error buffer across to the server if it has any items
3✔
4967
        // in it so that we can restore peer errors across connections.
3✔
4968
        if p.ErrorBuffer().Total() > 0 {
6✔
4969
                s.peerErrors[pubStr] = p.ErrorBuffer()
3✔
4970
        }
3✔
4971

4972
        // Inform the peer notifier of a peer offline event so that it can be
4973
        // reported to clients listening for peer events.
4974
        var pubKey [33]byte
3✔
4975
        copy(pubKey[:], pubSer)
3✔
4976

3✔
4977
        s.peerNotifier.NotifyPeerOffline(pubKey)
3✔
4978
}
4979

4980
// ConnectToPeer requests that the server connect to a Lightning Network peer
4981
// at the specified address. This function will *block* until either a
4982
// connection is established, or the initial handshake process fails.
4983
//
4984
// NOTE: This function is safe for concurrent access.
4985
func (s *server) ConnectToPeer(addr *lnwire.NetAddress,
4986
        perm bool, timeout time.Duration) error {
3✔
4987

3✔
4988
        targetPub := string(addr.IdentityKey.SerializeCompressed())
3✔
4989

3✔
4990
        // Acquire mutex, but use explicit unlocking instead of defer for
3✔
4991
        // better granularity.  In certain conditions, this method requires
3✔
4992
        // making an outbound connection to a remote peer, which requires the
3✔
4993
        // lock to be released, and subsequently reacquired.
3✔
4994
        s.mu.Lock()
3✔
4995

3✔
4996
        // Ensure we're not already connected to this peer.
3✔
4997
        peer, err := s.findPeerByPubStr(targetPub)
3✔
4998
        if err == nil {
6✔
4999
                s.mu.Unlock()
3✔
5000
                return &errPeerAlreadyConnected{peer: peer}
3✔
5001
        }
3✔
5002

5003
        // Peer was not found, continue to pursue connection with peer.
5004

5005
        // If there's already a pending connection request for this pubkey,
5006
        // then we ignore this request to ensure we don't create a redundant
5007
        // connection.
5008
        if reqs, ok := s.persistentConnReqs[targetPub]; ok {
6✔
5009
                srvrLog.Warnf("Already have %d persistent connection "+
3✔
5010
                        "requests for %v, connecting anyway.", len(reqs), addr)
3✔
5011
        }
3✔
5012

5013
        // If there's not already a pending or active connection to this node,
5014
        // then instruct the connection manager to attempt to establish a
5015
        // persistent connection to the peer.
5016
        srvrLog.Debugf("Connecting to %v", addr)
3✔
5017
        if perm {
6✔
5018
                connReq := &connmgr.ConnReq{
3✔
5019
                        Addr:      addr,
3✔
5020
                        Permanent: true,
3✔
5021
                }
3✔
5022

3✔
5023
                // Since the user requested a permanent connection, we'll set
3✔
5024
                // the entry to true which will tell the server to continue
3✔
5025
                // reconnecting even if the number of channels with this peer is
3✔
5026
                // zero.
3✔
5027
                s.persistentPeers[targetPub] = true
3✔
5028
                if _, ok := s.persistentPeersBackoff[targetPub]; !ok {
6✔
5029
                        s.persistentPeersBackoff[targetPub] = s.cfg.MinBackoff
3✔
5030
                }
3✔
5031
                s.persistentConnReqs[targetPub] = append(
3✔
5032
                        s.persistentConnReqs[targetPub], connReq,
3✔
5033
                )
3✔
5034
                s.mu.Unlock()
3✔
5035

3✔
5036
                go s.connMgr.Connect(connReq)
3✔
5037

3✔
5038
                return nil
3✔
5039
        }
5040
        s.mu.Unlock()
3✔
5041

3✔
5042
        // If we're not making a persistent connection, then we'll attempt to
3✔
5043
        // connect to the target peer. If the we can't make the connection, or
3✔
5044
        // the crypto negotiation breaks down, then return an error to the
3✔
5045
        // caller.
3✔
5046
        errChan := make(chan error, 1)
3✔
5047
        s.connectToPeer(addr, errChan, timeout)
3✔
5048

3✔
5049
        select {
3✔
5050
        case err := <-errChan:
3✔
5051
                return err
3✔
5052
        case <-s.quit:
×
5053
                return ErrServerShuttingDown
×
5054
        }
5055
}
5056

5057
// connectToPeer establishes a connection to a remote peer. errChan is used to
5058
// notify the caller if the connection attempt has failed. Otherwise, it will be
5059
// closed.
5060
func (s *server) connectToPeer(addr *lnwire.NetAddress,
5061
        errChan chan<- error, timeout time.Duration) {
3✔
5062

3✔
5063
        conn, err := brontide.Dial(
3✔
5064
                s.identityECDH, addr, timeout, s.cfg.net.Dial,
3✔
5065
        )
3✔
5066
        if err != nil {
6✔
5067
                srvrLog.Errorf("Unable to connect to %v: %v", addr, err)
3✔
5068
                select {
3✔
5069
                case errChan <- err:
3✔
5070
                case <-s.quit:
×
5071
                }
5072
                return
3✔
5073
        }
5074

5075
        close(errChan)
3✔
5076

3✔
5077
        srvrLog.Tracef("Brontide dialer made local=%v, remote=%v",
3✔
5078
                conn.LocalAddr(), conn.RemoteAddr())
3✔
5079

3✔
5080
        s.OutboundPeerConnected(nil, conn)
3✔
5081
}
5082

5083
// DisconnectPeer sends the request to server to close the connection with peer
5084
// identified by public key.
5085
//
5086
// NOTE: This function is safe for concurrent access.
5087
func (s *server) DisconnectPeer(pubKey *btcec.PublicKey) error {
3✔
5088
        pubBytes := pubKey.SerializeCompressed()
3✔
5089
        pubStr := string(pubBytes)
3✔
5090

3✔
5091
        s.mu.Lock()
3✔
5092
        defer s.mu.Unlock()
3✔
5093

3✔
5094
        // Check that were actually connected to this peer. If not, then we'll
3✔
5095
        // exit in an error as we can't disconnect from a peer that we're not
3✔
5096
        // currently connected to.
3✔
5097
        peer, err := s.findPeerByPubStr(pubStr)
3✔
5098
        if err == ErrPeerNotConnected {
6✔
5099
                return fmt.Errorf("peer %x is not connected", pubBytes)
3✔
5100
        }
3✔
5101

5102
        srvrLog.Infof("Disconnecting from %v", peer)
3✔
5103

3✔
5104
        s.cancelConnReqs(pubStr, nil)
3✔
5105

3✔
5106
        // If this peer was formerly a persistent connection, then we'll remove
3✔
5107
        // them from this map so we don't attempt to re-connect after we
3✔
5108
        // disconnect.
3✔
5109
        delete(s.persistentPeers, pubStr)
3✔
5110
        delete(s.persistentPeersBackoff, pubStr)
3✔
5111

3✔
5112
        // Remove the peer by calling Disconnect. Previously this was done with
3✔
5113
        // removePeer, which bypassed the peerTerminationWatcher.
3✔
5114
        peer.Disconnect(fmt.Errorf("server: DisconnectPeer called"))
3✔
5115

3✔
5116
        return nil
3✔
5117
}
5118

5119
// OpenChannel sends a request to the server to open a channel to the specified
5120
// peer identified by nodeKey with the passed channel funding parameters.
5121
//
5122
// NOTE: This function is safe for concurrent access.
5123
func (s *server) OpenChannel(
5124
        req *funding.InitFundingMsg) (chan *lnrpc.OpenStatusUpdate, chan error) {
3✔
5125

3✔
5126
        // The updateChan will have a buffer of 2, since we expect a ChanPending
3✔
5127
        // + a ChanOpen update, and we want to make sure the funding process is
3✔
5128
        // not blocked if the caller is not reading the updates.
3✔
5129
        req.Updates = make(chan *lnrpc.OpenStatusUpdate, 2)
3✔
5130
        req.Err = make(chan error, 1)
3✔
5131

3✔
5132
        // First attempt to locate the target peer to open a channel with, if
3✔
5133
        // we're unable to locate the peer then this request will fail.
3✔
5134
        pubKeyBytes := req.TargetPubkey.SerializeCompressed()
3✔
5135
        s.mu.RLock()
3✔
5136
        peer, ok := s.peersByPub[string(pubKeyBytes)]
3✔
5137
        if !ok {
3✔
5138
                s.mu.RUnlock()
×
5139

×
5140
                req.Err <- fmt.Errorf("peer %x is not online", pubKeyBytes)
×
5141
                return req.Updates, req.Err
×
5142
        }
×
5143
        req.Peer = peer
3✔
5144
        s.mu.RUnlock()
3✔
5145

3✔
5146
        // We'll wait until the peer is active before beginning the channel
3✔
5147
        // opening process.
3✔
5148
        select {
3✔
5149
        case <-peer.ActiveSignal():
3✔
5150
        case <-peer.QuitSignal():
×
5151
                req.Err <- fmt.Errorf("peer %x disconnected", pubKeyBytes)
×
5152
                return req.Updates, req.Err
×
5153
        case <-s.quit:
×
5154
                req.Err <- ErrServerShuttingDown
×
5155
                return req.Updates, req.Err
×
5156
        }
5157

5158
        // If the fee rate wasn't specified at this point we fail the funding
5159
        // because of the missing fee rate information. The caller of the
5160
        // `OpenChannel` method needs to make sure that default values for the
5161
        // fee rate are set beforehand.
5162
        if req.FundingFeePerKw == 0 {
3✔
5163
                req.Err <- fmt.Errorf("no FundingFeePerKw specified for " +
×
5164
                        "the channel opening transaction")
×
5165

×
5166
                return req.Updates, req.Err
×
5167
        }
×
5168

5169
        // Spawn a goroutine to send the funding workflow request to the funding
5170
        // manager. This allows the server to continue handling queries instead
5171
        // of blocking on this request which is exported as a synchronous
5172
        // request to the outside world.
5173
        go s.fundingMgr.InitFundingWorkflow(req)
3✔
5174

3✔
5175
        return req.Updates, req.Err
3✔
5176
}
5177

5178
// Peers returns a slice of all active peers.
5179
//
5180
// NOTE: This function is safe for concurrent access.
5181
func (s *server) Peers() []*peer.Brontide {
3✔
5182
        s.mu.RLock()
3✔
5183
        defer s.mu.RUnlock()
3✔
5184

3✔
5185
        peers := make([]*peer.Brontide, 0, len(s.peersByPub))
3✔
5186
        for _, peer := range s.peersByPub {
6✔
5187
                peers = append(peers, peer)
3✔
5188
        }
3✔
5189

5190
        return peers
3✔
5191
}
5192

5193
// computeNextBackoff uses a truncated exponential backoff to compute the next
5194
// backoff using the value of the exiting backoff. The returned duration is
5195
// randomized in either direction by 1/20 to prevent tight loops from
5196
// stabilizing.
5197
func computeNextBackoff(currBackoff, maxBackoff time.Duration) time.Duration {
3✔
5198
        // Double the current backoff, truncating if it exceeds our maximum.
3✔
5199
        nextBackoff := 2 * currBackoff
3✔
5200
        if nextBackoff > maxBackoff {
6✔
5201
                nextBackoff = maxBackoff
3✔
5202
        }
3✔
5203

5204
        // Using 1/10 of our duration as a margin, compute a random offset to
5205
        // avoid the nodes entering connection cycles.
5206
        margin := nextBackoff / 10
3✔
5207

3✔
5208
        var wiggle big.Int
3✔
5209
        wiggle.SetUint64(uint64(margin))
3✔
5210
        if _, err := rand.Int(rand.Reader, &wiggle); err != nil {
3✔
5211
                // Randomizing is not mission critical, so we'll just return the
×
5212
                // current backoff.
×
5213
                return nextBackoff
×
5214
        }
×
5215

5216
        // Otherwise add in our wiggle, but subtract out half of the margin so
5217
        // that the backoff can tweaked by 1/20 in either direction.
5218
        return nextBackoff + (time.Duration(wiggle.Uint64()) - margin/2)
3✔
5219
}
5220

5221
// errNoAdvertisedAddr is an error returned when we attempt to retrieve the
5222
// advertised address of a node, but they don't have one.
5223
var errNoAdvertisedAddr = errors.New("no advertised address found")
5224

5225
// fetchNodeAdvertisedAddrs attempts to fetch the advertised addresses of a node.
5226
func (s *server) fetchNodeAdvertisedAddrs(pub *btcec.PublicKey) ([]net.Addr, error) {
3✔
5227
        vertex, err := route.NewVertexFromBytes(pub.SerializeCompressed())
3✔
5228
        if err != nil {
3✔
5229
                return nil, err
×
5230
        }
×
5231

5232
        node, err := s.graphDB.FetchLightningNode(vertex)
3✔
5233
        if err != nil {
6✔
5234
                return nil, err
3✔
5235
        }
3✔
5236

5237
        if len(node.Addresses) == 0 {
6✔
5238
                return nil, errNoAdvertisedAddr
3✔
5239
        }
3✔
5240

5241
        return node.Addresses, nil
3✔
5242
}
5243

5244
// fetchLastChanUpdate returns a function which is able to retrieve our latest
5245
// channel update for a target channel.
5246
func (s *server) fetchLastChanUpdate() func(lnwire.ShortChannelID) (
5247
        *lnwire.ChannelUpdate1, error) {
3✔
5248

3✔
5249
        ourPubKey := s.identityECDH.PubKey().SerializeCompressed()
3✔
5250
        return func(cid lnwire.ShortChannelID) (*lnwire.ChannelUpdate1, error) {
6✔
5251
                info, edge1, edge2, err := s.graphBuilder.GetChannelByID(cid)
3✔
5252
                if err != nil {
6✔
5253
                        return nil, err
3✔
5254
                }
3✔
5255

5256
                return netann.ExtractChannelUpdate(
3✔
5257
                        ourPubKey[:], info, edge1, edge2,
3✔
5258
                )
3✔
5259
        }
5260
}
5261

5262
// applyChannelUpdate applies the channel update to the different sub-systems of
5263
// the server. The useAlias boolean denotes whether or not to send an alias in
5264
// place of the real SCID.
5265
func (s *server) applyChannelUpdate(update *lnwire.ChannelUpdate1,
5266
        op *wire.OutPoint, useAlias bool) error {
3✔
5267

3✔
5268
        var (
3✔
5269
                peerAlias    *lnwire.ShortChannelID
3✔
5270
                defaultAlias lnwire.ShortChannelID
3✔
5271
        )
3✔
5272

3✔
5273
        chanID := lnwire.NewChanIDFromOutPoint(*op)
3✔
5274

3✔
5275
        // Fetch the peer's alias from the lnwire.ChannelID so it can be used
3✔
5276
        // in the ChannelUpdate if it hasn't been announced yet.
3✔
5277
        if useAlias {
6✔
5278
                foundAlias, _ := s.aliasMgr.GetPeerAlias(chanID)
3✔
5279
                if foundAlias != defaultAlias {
6✔
5280
                        peerAlias = &foundAlias
3✔
5281
                }
3✔
5282
        }
5283

5284
        errChan := s.authGossiper.ProcessLocalAnnouncement(
3✔
5285
                update, discovery.RemoteAlias(peerAlias),
3✔
5286
        )
3✔
5287
        select {
3✔
5288
        case err := <-errChan:
3✔
5289
                return err
3✔
5290
        case <-s.quit:
×
5291
                return ErrServerShuttingDown
×
5292
        }
5293
}
5294

5295
// SendCustomMessage sends a custom message to the peer with the specified
5296
// pubkey.
5297
func (s *server) SendCustomMessage(peerPub [33]byte, msgType lnwire.MessageType,
5298
        data []byte) error {
3✔
5299

3✔
5300
        peer, err := s.FindPeerByPubStr(string(peerPub[:]))
3✔
5301
        if err != nil {
3✔
5302
                return err
×
5303
        }
×
5304

5305
        // We'll wait until the peer is active.
5306
        select {
3✔
5307
        case <-peer.ActiveSignal():
3✔
5308
        case <-peer.QuitSignal():
×
5309
                return fmt.Errorf("peer %x disconnected", peerPub)
×
5310
        case <-s.quit:
×
5311
                return ErrServerShuttingDown
×
5312
        }
5313

5314
        msg, err := lnwire.NewCustom(msgType, data)
3✔
5315
        if err != nil {
6✔
5316
                return err
3✔
5317
        }
3✔
5318

5319
        // Send the message as low-priority. For now we assume that all
5320
        // application-defined message are low priority.
5321
        return peer.SendMessageLazy(true, msg)
3✔
5322
}
5323

5324
// newSweepPkScriptGen creates closure that generates a new public key script
5325
// which should be used to sweep any funds into the on-chain wallet.
5326
// Specifically, the script generated is a version 0, pay-to-witness-pubkey-hash
5327
// (p2wkh) output.
5328
func newSweepPkScriptGen(
5329
        wallet lnwallet.WalletController,
5330
        netParams *chaincfg.Params) func() fn.Result[lnwallet.AddrWithKey] {
3✔
5331

3✔
5332
        return func() fn.Result[lnwallet.AddrWithKey] {
6✔
5333
                sweepAddr, err := wallet.NewAddress(
3✔
5334
                        lnwallet.TaprootPubkey, false,
3✔
5335
                        lnwallet.DefaultAccountName,
3✔
5336
                )
3✔
5337
                if err != nil {
3✔
5338
                        return fn.Err[lnwallet.AddrWithKey](err)
×
5339
                }
×
5340

5341
                addr, err := txscript.PayToAddrScript(sweepAddr)
3✔
5342
                if err != nil {
3✔
5343
                        return fn.Err[lnwallet.AddrWithKey](err)
×
5344
                }
×
5345

5346
                internalKeyDesc, err := lnwallet.InternalKeyForAddr(
3✔
5347
                        wallet, netParams, addr,
3✔
5348
                )
3✔
5349
                if err != nil {
3✔
5350
                        return fn.Err[lnwallet.AddrWithKey](err)
×
5351
                }
×
5352

5353
                return fn.Ok(lnwallet.AddrWithKey{
3✔
5354
                        DeliveryAddress: addr,
3✔
5355
                        InternalKey:     internalKeyDesc,
3✔
5356
                })
3✔
5357
        }
5358
}
5359

5360
// shouldPeerBootstrap returns true if we should attempt to perform peer
5361
// bootstrapping to actively seek our peers using the set of active network
5362
// bootstrappers.
5363
func shouldPeerBootstrap(cfg *Config) bool {
3✔
5364
        isSimnet := cfg.Bitcoin.SimNet
3✔
5365
        isSignet := cfg.Bitcoin.SigNet
3✔
5366
        isRegtest := cfg.Bitcoin.RegTest
3✔
5367
        isDevNetwork := isSimnet || isSignet || isRegtest
3✔
5368

3✔
5369
        // TODO(yy): remove the check on simnet/regtest such that the itest is
3✔
5370
        // covering the bootstrapping process.
3✔
5371
        return !cfg.NoNetBootstrap && !isDevNetwork
3✔
5372
}
3✔
5373

5374
// fetchClosedChannelSCIDs returns a set of SCIDs that have their force closing
5375
// finished.
5376
func (s *server) fetchClosedChannelSCIDs() map[lnwire.ShortChannelID]struct{} {
3✔
5377
        // Get a list of closed channels.
3✔
5378
        channels, err := s.chanStateDB.FetchClosedChannels(false)
3✔
5379
        if err != nil {
3✔
5380
                srvrLog.Errorf("Failed to fetch closed channels: %v", err)
×
5381
                return nil
×
5382
        }
×
5383

5384
        // Save the SCIDs in a map.
5385
        closedSCIDs := make(map[lnwire.ShortChannelID]struct{}, len(channels))
3✔
5386
        for _, c := range channels {
6✔
5387
                // If the channel is not pending, its FC has been finalized.
3✔
5388
                if !c.IsPending {
6✔
5389
                        closedSCIDs[c.ShortChanID] = struct{}{}
3✔
5390
                }
3✔
5391
        }
5392

5393
        // Double check whether the reported closed channel has indeed finished
5394
        // closing.
5395
        //
5396
        // NOTE: There are misalignments regarding when a channel's FC is
5397
        // marked as finalized. We double check the pending channels to make
5398
        // sure the returned SCIDs are indeed terminated.
5399
        //
5400
        // TODO(yy): fix the misalignments in `FetchClosedChannels`.
5401
        pendings, err := s.chanStateDB.FetchPendingChannels()
3✔
5402
        if err != nil {
3✔
5403
                srvrLog.Errorf("Failed to fetch pending channels: %v", err)
×
5404
                return nil
×
5405
        }
×
5406

5407
        for _, c := range pendings {
6✔
5408
                if _, ok := closedSCIDs[c.ShortChannelID]; !ok {
6✔
5409
                        continue
3✔
5410
                }
5411

5412
                // If the channel is still reported as pending, remove it from
5413
                // the map.
5414
                delete(closedSCIDs, c.ShortChannelID)
×
5415

×
5416
                srvrLog.Warnf("Channel=%v is prematurely marked as finalized",
×
5417
                        c.ShortChannelID)
×
5418
        }
5419

5420
        return closedSCIDs
3✔
5421
}
5422

5423
// getStartingBeat returns the current beat. This is used during the startup to
5424
// initialize blockbeat consumers.
5425
func (s *server) getStartingBeat() (*chainio.Beat, error) {
3✔
5426
        // beat is the current blockbeat.
3✔
5427
        var beat *chainio.Beat
3✔
5428

3✔
5429
        // If the node is configured with nochainbackend mode (remote signer),
3✔
5430
        // we will skip fetching the best block.
3✔
5431
        if s.cfg.Bitcoin.Node == "nochainbackend" {
3✔
5432
                srvrLog.Info("Skipping block notification for nochainbackend " +
×
5433
                        "mode")
×
5434

×
5435
                return &chainio.Beat{}, nil
×
5436
        }
×
5437

5438
        // We should get a notification with the current best block immediately
5439
        // by passing a nil block.
5440
        blockEpochs, err := s.cc.ChainNotifier.RegisterBlockEpochNtfn(nil)
3✔
5441
        if err != nil {
3✔
5442
                return beat, fmt.Errorf("register block epoch ntfn: %w", err)
×
5443
        }
×
5444
        defer blockEpochs.Cancel()
3✔
5445

3✔
5446
        // We registered for the block epochs with a nil request. The notifier
3✔
5447
        // should send us the current best block immediately. So we need to
3✔
5448
        // wait for it here because we need to know the current best height.
3✔
5449
        select {
3✔
5450
        case bestBlock := <-blockEpochs.Epochs:
3✔
5451
                srvrLog.Infof("Received initial block %v at height %d",
3✔
5452
                        bestBlock.Hash, bestBlock.Height)
3✔
5453

3✔
5454
                // Update the current blockbeat.
3✔
5455
                beat = chainio.NewBeat(*bestBlock)
3✔
5456

5457
        case <-s.quit:
×
5458
                srvrLog.Debug("LND shutting down")
×
5459
        }
5460

5461
        return beat, nil
3✔
5462
}
5463

5464
// ChanHasRbfCoopCloser returns true if the channel as identifier by the channel
5465
// point has an active RBF chan closer.
5466
func (s *server) ChanHasRbfCoopCloser(peerPub *btcec.PublicKey,
5467
        chanPoint wire.OutPoint) bool {
3✔
5468

3✔
5469
        pubBytes := peerPub.SerializeCompressed()
3✔
5470

3✔
5471
        s.mu.RLock()
3✔
5472
        targetPeer, ok := s.peersByPub[string(pubBytes)]
3✔
5473
        s.mu.RUnlock()
3✔
5474
        if !ok {
3✔
5475
                return false
×
5476
        }
×
5477

5478
        return targetPeer.ChanHasRbfCoopCloser(chanPoint)
3✔
5479
}
5480

5481
// attemptCoopRbfFeeBump attempts to look up the active chan closer for a
5482
// channel given the outpoint. If found, we'll attempt to do a fee bump,
5483
// returning channels used for updates. If the channel isn't currently active
5484
// (p2p connection established), then his function will return an error.
5485
func (s *server) attemptCoopRbfFeeBump(ctx context.Context,
5486
        chanPoint wire.OutPoint, feeRate chainfee.SatPerKWeight,
5487
        deliveryScript lnwire.DeliveryAddress) (*peer.CoopCloseUpdates, error) {
3✔
5488

3✔
5489
        // First, we'll attempt to look up the channel based on it's
3✔
5490
        // ChannelPoint.
3✔
5491
        channel, err := s.chanStateDB.FetchChannel(chanPoint)
3✔
5492
        if err != nil {
3✔
5493
                return nil, fmt.Errorf("unable to fetch channel: %w", err)
×
5494
        }
×
5495

5496
        // From the channel, we can now get the pubkey of the peer, then use
5497
        // that to eventually get the chan closer.
5498
        peerPub := channel.IdentityPub.SerializeCompressed()
3✔
5499

3✔
5500
        // Now that we have the peer pub, we can look up the peer itself.
3✔
5501
        s.mu.RLock()
3✔
5502
        targetPeer, ok := s.peersByPub[string(peerPub)]
3✔
5503
        s.mu.RUnlock()
3✔
5504
        if !ok {
3✔
5505
                return nil, fmt.Errorf("peer for ChannelPoint(%v) is "+
×
5506
                        "not online", chanPoint)
×
5507
        }
×
5508

5509
        closeUpdates, err := targetPeer.TriggerCoopCloseRbfBump(
3✔
5510
                ctx, chanPoint, feeRate, deliveryScript,
3✔
5511
        )
3✔
5512
        if err != nil {
3✔
5513
                return nil, fmt.Errorf("unable to trigger coop rbf fee bump: "+
×
5514
                        "%w", err)
×
5515
        }
×
5516

5517
        return closeUpdates, nil
3✔
5518
}
5519

5520
// AttemptRBFCloseUpdate attempts to trigger a new RBF iteration for a co-op
5521
// close update. This route it to be used only if the target channel in question
5522
// is no longer active in the link. This can happen when we restart while we
5523
// already have done a single RBF co-op close iteration.
5524
func (s *server) AttemptRBFCloseUpdate(ctx context.Context,
5525
        chanPoint wire.OutPoint, feeRate chainfee.SatPerKWeight,
5526
        deliveryScript lnwire.DeliveryAddress) (*peer.CoopCloseUpdates, error) {
3✔
5527

3✔
5528
        // If the channel is present in the switch, then the request should flow
3✔
5529
        // through the switch instead.
3✔
5530
        chanID := lnwire.NewChanIDFromOutPoint(chanPoint)
3✔
5531
        if _, err := s.htlcSwitch.GetLink(chanID); err == nil {
3✔
5532
                return nil, fmt.Errorf("ChannelPoint(%v) is active in link, "+
×
5533
                        "invalid request", chanPoint)
×
5534
        }
×
5535

5536
        // At this point, we know that the channel isn't present in the link, so
5537
        // we'll check to see if we have an entry in the active chan closer map.
5538
        updates, err := s.attemptCoopRbfFeeBump(
3✔
5539
                ctx, chanPoint, feeRate, deliveryScript,
3✔
5540
        )
3✔
5541
        if err != nil {
3✔
5542
                return nil, fmt.Errorf("unable to attempt coop rbf fee bump "+
×
5543
                        "ChannelPoint(%v)", chanPoint)
×
5544
        }
×
5545

5546
        return updates, nil
3✔
5547
}
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