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

lightningnetwork / lnd / 16005100421

01 Jul 2025 04:35PM UTC coverage: 57.772% (+0.6%) from 57.216%
16005100421

Pull #10018

github

web-flow
Merge 0b73fe73c into d8a12a5e5
Pull Request #10018: Refactor link's long methods

390 of 746 new or added lines in 1 file covered. (52.28%)

41 existing lines in 11 files now uncovered.

98433 of 170383 relevant lines covered (57.77%)

1.79 hits per line

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

69.18
/server.go
1
package lnd
2

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

19
        "github.com/btcsuite/btcd/btcec/v2"
20
        "github.com/btcsuite/btcd/btcec/v2/ecdsa"
21
        "github.com/btcsuite/btcd/btcutil"
22
        "github.com/btcsuite/btcd/chaincfg"
23
        "github.com/btcsuite/btcd/chaincfg/chainhash"
24
        "github.com/btcsuite/btcd/connmgr"
25
        "github.com/btcsuite/btcd/txscript"
26
        "github.com/btcsuite/btcd/wire"
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/lncfg"
55
        "github.com/lightningnetwork/lnd/lnencrypt"
56
        "github.com/lightningnetwork/lnd/lnpeer"
57
        "github.com/lightningnetwork/lnd/lnrpc"
58
        "github.com/lightningnetwork/lnd/lnrpc/routerrpc"
59
        "github.com/lightningnetwork/lnd/lnwallet"
60
        "github.com/lightningnetwork/lnd/lnwallet/chainfee"
61
        "github.com/lightningnetwork/lnd/lnwallet/chanfunding"
62
        "github.com/lightningnetwork/lnd/lnwallet/rpcwallet"
63
        "github.com/lightningnetwork/lnd/lnwire"
64
        "github.com/lightningnetwork/lnd/nat"
65
        "github.com/lightningnetwork/lnd/netann"
66
        "github.com/lightningnetwork/lnd/peer"
67
        "github.com/lightningnetwork/lnd/peernotifier"
68
        "github.com/lightningnetwork/lnd/pool"
69
        "github.com/lightningnetwork/lnd/queue"
70
        "github.com/lightningnetwork/lnd/routing"
71
        "github.com/lightningnetwork/lnd/routing/localchans"
72
        "github.com/lightningnetwork/lnd/routing/route"
73
        "github.com/lightningnetwork/lnd/subscribe"
74
        "github.com/lightningnetwork/lnd/sweep"
75
        "github.com/lightningnetwork/lnd/ticker"
76
        "github.com/lightningnetwork/lnd/tor"
77
        "github.com/lightningnetwork/lnd/walletunlocker"
78
        "github.com/lightningnetwork/lnd/watchtower/blob"
79
        "github.com/lightningnetwork/lnd/watchtower/wtclient"
80
        "github.com/lightningnetwork/lnd/watchtower/wtpolicy"
81
        "github.com/lightningnetwork/lnd/watchtower/wtserver"
82
)
83

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

196
// String returns a human-readable representation of the status code.
197
func (p peerAccessStatus) String() string {
3✔
198
        switch p {
3✔
199
        case peerStatusRestricted:
3✔
200
                return "restricted"
3✔
201

202
        case peerStatusTemporary:
3✔
203
                return "temporary"
3✔
204

205
        case peerStatusProtected:
3✔
206
                return "protected"
3✔
207

208
        default:
×
209
                return "unknown"
×
210
        }
211
}
212

213
// peerSlotStatus determines whether a peer gets access to one of our free
214
// slots or gets to bypass this safety mechanism.
215
type peerSlotStatus struct {
216
        // state determines which privileges the peer has with our server.
217
        state peerAccessStatus
218
}
219

220
// server is the main server of the Lightning Network Daemon. The server houses
221
// global state pertaining to the wallet, database, and the rpcserver.
222
// Additionally, the server is also used as a central messaging bus to interact
223
// with any of its companion objects.
224
type server struct {
225
        active   int32 // atomic
226
        stopping int32 // atomic
227

228
        start sync.Once
229
        stop  sync.Once
230

231
        cfg *Config
232

233
        implCfg *ImplementationCfg
234

235
        // identityECDH is an ECDH capable wrapper for the private key used
236
        // to authenticate any incoming connections.
237
        identityECDH keychain.SingleKeyECDH
238

239
        // identityKeyLoc is the key locator for the above wrapped identity key.
240
        identityKeyLoc keychain.KeyLocator
241

242
        // nodeSigner is an implementation of the MessageSigner implementation
243
        // that's backed by the identity private key of the running lnd node.
244
        nodeSigner *netann.NodeSigner
245

246
        chanStatusMgr *netann.ChanStatusManager
247

248
        // listenAddrs is the list of addresses the server is currently
249
        // listening on.
250
        listenAddrs []net.Addr
251

252
        // torController is a client that will communicate with a locally
253
        // running Tor server. This client will handle initiating and
254
        // authenticating the connection to the Tor server, automatically
255
        // creating and setting up onion services, etc.
256
        torController *tor.Controller
257

258
        // natTraversal is the specific NAT traversal technique used to
259
        // automatically set up port forwarding rules in order to advertise to
260
        // the network that the node is accepting inbound connections.
261
        natTraversal nat.Traversal
262

263
        // lastDetectedIP is the last IP detected by the NAT traversal technique
264
        // above. This IP will be watched periodically in a goroutine in order
265
        // to handle dynamic IP changes.
266
        lastDetectedIP net.IP
267

268
        mu sync.RWMutex
269

270
        // peersByPub is a map of the active peers.
271
        //
272
        // NOTE: The key used here is the raw bytes of the peer's public key to
273
        // string conversion, which means it cannot be printed using `%s` as it
274
        // will just print the binary.
275
        //
276
        // TODO(yy): Use the hex string instead.
277
        peersByPub map[string]*peer.Brontide
278

279
        inboundPeers  map[string]*peer.Brontide
280
        outboundPeers map[string]*peer.Brontide
281

282
        peerConnectedListeners    map[string][]chan<- lnpeer.Peer
283
        peerDisconnectedListeners map[string][]chan<- struct{}
284

285
        // TODO(yy): the Brontide.Start doesn't know this value, which means it
286
        // will continue to send messages even if there are no active channels
287
        // and the value below is false. Once it's pruned, all its connections
288
        // will be closed, thus the Brontide.Start will return an error.
289
        persistentPeers        map[string]bool
290
        persistentPeersBackoff map[string]time.Duration
291
        persistentPeerAddrs    map[string][]*lnwire.NetAddress
292
        persistentConnReqs     map[string][]*connmgr.ConnReq
293
        persistentRetryCancels map[string]chan struct{}
294

295
        // peerErrors keeps a set of peer error buffers for peers that have
296
        // disconnected from us. This allows us to track historic peer errors
297
        // over connections. The string of the peer's compressed pubkey is used
298
        // as a key for this map.
299
        peerErrors map[string]*queue.CircularBuffer
300

301
        // ignorePeerTermination tracks peers for which the server has initiated
302
        // a disconnect. Adding a peer to this map causes the peer termination
303
        // watcher to short circuit in the event that peers are purposefully
304
        // disconnected.
305
        ignorePeerTermination map[*peer.Brontide]struct{}
306

307
        // scheduledPeerConnection maps a pubkey string to a callback that
308
        // should be executed in the peerTerminationWatcher the prior peer with
309
        // the same pubkey exits.  This allows the server to wait until the
310
        // prior peer has cleaned up successfully, before adding the new peer
311
        // intended to replace it.
312
        scheduledPeerConnection map[string]func()
313

314
        // pongBuf is a shared pong reply buffer we'll use across all active
315
        // peer goroutines. We know the max size of a pong message
316
        // (lnwire.MaxPongBytes), so we can allocate this ahead of time, and
317
        // avoid allocations each time we need to send a pong message.
318
        pongBuf []byte
319

320
        cc *chainreg.ChainControl
321

322
        fundingMgr *funding.Manager
323

324
        graphDB *graphdb.ChannelGraph
325

326
        chanStateDB *channeldb.ChannelStateDB
327

328
        addrSource channeldb.AddrSource
329

330
        // miscDB is the DB that contains all "other" databases within the main
331
        // channel DB that haven't been separated out yet.
332
        miscDB *channeldb.DB
333

334
        invoicesDB invoices.InvoiceDB
335

336
        aliasMgr *aliasmgr.Manager
337

338
        htlcSwitch *htlcswitch.Switch
339

340
        interceptableSwitch *htlcswitch.InterceptableSwitch
341

342
        invoices *invoices.InvoiceRegistry
343

344
        invoiceHtlcModifier *invoices.HtlcModificationInterceptor
345

346
        channelNotifier *channelnotifier.ChannelNotifier
347

348
        peerNotifier *peernotifier.PeerNotifier
349

350
        htlcNotifier *htlcswitch.HtlcNotifier
351

352
        witnessBeacon contractcourt.WitnessBeacon
353

354
        breachArbitrator *contractcourt.BreachArbitrator
355

356
        missionController *routing.MissionController
357
        defaultMC         *routing.MissionControl
358

359
        graphBuilder *graph.Builder
360

361
        chanRouter *routing.ChannelRouter
362

363
        controlTower routing.ControlTower
364

365
        authGossiper *discovery.AuthenticatedGossiper
366

367
        localChanMgr *localchans.Manager
368

369
        utxoNursery *contractcourt.UtxoNursery
370

371
        sweeper *sweep.UtxoSweeper
372

373
        chainArb *contractcourt.ChainArbitrator
374

375
        sphinx *hop.OnionProcessor
376

377
        towerClientMgr *wtclient.Manager
378

379
        connMgr *connmgr.ConnManager
380

381
        sigPool *lnwallet.SigPool
382

383
        writePool *pool.Write
384

385
        readPool *pool.Read
386

387
        tlsManager *TLSManager
388

389
        // featureMgr dispatches feature vectors for various contexts within the
390
        // daemon.
391
        featureMgr *feature.Manager
392

393
        // currentNodeAnn is the node announcement that has been broadcast to
394
        // the network upon startup, if the attributes of the node (us) has
395
        // changed since last start.
396
        currentNodeAnn *lnwire.NodeAnnouncement
397

398
        // chansToRestore is the set of channels that upon starting, the server
399
        // should attempt to restore/recover.
400
        chansToRestore walletunlocker.ChannelsToRecover
401

402
        // chanSubSwapper is a sub-system that will ensure our on-disk channel
403
        // backups are consistent at all times. It interacts with the
404
        // channelNotifier to be notified of newly opened and closed channels.
405
        chanSubSwapper *chanbackup.SubSwapper
406

407
        // chanEventStore tracks the behaviour of channels and their remote peers to
408
        // provide insights into their health and performance.
409
        chanEventStore *chanfitness.ChannelEventStore
410

411
        hostAnn *netann.HostAnnouncer
412

413
        // livenessMonitor monitors that lnd has access to critical resources.
414
        livenessMonitor *healthcheck.Monitor
415

416
        customMessageServer *subscribe.Server
417

418
        // txPublisher is a publisher with fee-bumping capability.
419
        txPublisher *sweep.TxPublisher
420

421
        // blockbeatDispatcher is a block dispatcher that notifies subscribers
422
        // of new blocks.
423
        blockbeatDispatcher *chainio.BlockbeatDispatcher
424

425
        // peerAccessMan implements peer access controls.
426
        peerAccessMan *accessMan
427

428
        quit chan struct{}
429

430
        wg sync.WaitGroup
431
}
432

433
// updatePersistentPeerAddrs subscribes to topology changes and stores
434
// advertised addresses for any NodeAnnouncements from our persisted peers.
435
func (s *server) updatePersistentPeerAddrs() error {
3✔
436
        graphSub, err := s.graphDB.SubscribeTopology()
3✔
437
        if err != nil {
3✔
438
                return err
×
439
        }
×
440

441
        s.wg.Add(1)
3✔
442
        go func() {
6✔
443
                defer func() {
6✔
444
                        graphSub.Cancel()
3✔
445
                        s.wg.Done()
3✔
446
                }()
3✔
447

448
                for {
6✔
449
                        select {
3✔
450
                        case <-s.quit:
3✔
451
                                return
3✔
452

453
                        case topChange, ok := <-graphSub.TopologyChanges:
3✔
454
                                // If the router is shutting down, then we will
3✔
455
                                // as well.
3✔
456
                                if !ok {
3✔
457
                                        return
×
458
                                }
×
459

460
                                for _, update := range topChange.NodeUpdates {
6✔
461
                                        pubKeyStr := string(
3✔
462
                                                update.IdentityKey.
3✔
463
                                                        SerializeCompressed(),
3✔
464
                                        )
3✔
465

3✔
466
                                        // We only care about updates from
3✔
467
                                        // our persistentPeers.
3✔
468
                                        s.mu.RLock()
3✔
469
                                        _, ok := s.persistentPeers[pubKeyStr]
3✔
470
                                        s.mu.RUnlock()
3✔
471
                                        if !ok {
6✔
472
                                                continue
3✔
473
                                        }
474

475
                                        addrs := make([]*lnwire.NetAddress, 0,
3✔
476
                                                len(update.Addresses))
3✔
477

3✔
478
                                        for _, addr := range update.Addresses {
6✔
479
                                                addrs = append(addrs,
3✔
480
                                                        &lnwire.NetAddress{
3✔
481
                                                                IdentityKey: update.IdentityKey,
3✔
482
                                                                Address:     addr,
3✔
483
                                                                ChainNet:    s.cfg.ActiveNetParams.Net,
3✔
484
                                                        },
3✔
485
                                                )
3✔
486
                                        }
3✔
487

488
                                        s.mu.Lock()
3✔
489

3✔
490
                                        // Update the stored addresses for this
3✔
491
                                        // to peer to reflect the new set.
3✔
492
                                        s.persistentPeerAddrs[pubKeyStr] = addrs
3✔
493

3✔
494
                                        // If there are no outstanding
3✔
495
                                        // connection requests for this peer
3✔
496
                                        // then our work is done since we are
3✔
497
                                        // not currently trying to connect to
3✔
498
                                        // them.
3✔
499
                                        if len(s.persistentConnReqs[pubKeyStr]) == 0 {
6✔
500
                                                s.mu.Unlock()
3✔
501
                                                continue
3✔
502
                                        }
503

504
                                        s.mu.Unlock()
3✔
505

3✔
506
                                        s.connectToPersistentPeer(pubKeyStr)
3✔
507
                                }
508
                        }
509
                }
510
        }()
511

512
        return nil
3✔
513
}
514

515
// CustomMessage is a custom message that is received from a peer.
516
type CustomMessage struct {
517
        // Peer is the peer pubkey
518
        Peer [33]byte
519

520
        // Msg is the custom wire message.
521
        Msg *lnwire.Custom
522
}
523

524
// parseAddr parses an address from its string format to a net.Addr.
525
func parseAddr(address string, netCfg tor.Net) (net.Addr, error) {
3✔
526
        var (
3✔
527
                host string
3✔
528
                port int
3✔
529
        )
3✔
530

3✔
531
        // Split the address into its host and port components.
3✔
532
        h, p, err := net.SplitHostPort(address)
3✔
533
        if err != nil {
3✔
534
                // If a port wasn't specified, we'll assume the address only
×
535
                // contains the host so we'll use the default port.
×
536
                host = address
×
537
                port = defaultPeerPort
×
538
        } else {
3✔
539
                // Otherwise, we'll note both the host and ports.
3✔
540
                host = h
3✔
541
                portNum, err := strconv.Atoi(p)
3✔
542
                if err != nil {
3✔
543
                        return nil, err
×
544
                }
×
545
                port = portNum
3✔
546
        }
547

548
        if tor.IsOnionHost(host) {
3✔
549
                return &tor.OnionAddr{OnionService: host, Port: port}, nil
×
550
        }
×
551

552
        // If the host is part of a TCP address, we'll use the network
553
        // specific ResolveTCPAddr function in order to resolve these
554
        // addresses over Tor in order to prevent leaking your real IP
555
        // address.
556
        hostPort := net.JoinHostPort(host, strconv.Itoa(port))
3✔
557
        return netCfg.ResolveTCPAddr("tcp", hostPort)
3✔
558
}
559

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

3✔
565
        return func(a net.Addr) (net.Conn, error) {
6✔
566
                lnAddr := a.(*lnwire.NetAddress)
3✔
567
                return brontide.Dial(idKey, lnAddr, timeout, netCfg.Dial)
3✔
568
        }
3✔
569
}
570

571
// newServer creates a new instance of the server which is to listen using the
572
// passed listener address.
573
//
574
//nolint:funlen
575
func newServer(ctx context.Context, cfg *Config, listenAddrs []net.Addr,
576
        dbs *DatabaseInstances, cc *chainreg.ChainControl,
577
        nodeKeyDesc *keychain.KeyDescriptor,
578
        chansToRestore walletunlocker.ChannelsToRecover,
579
        chanPredicate chanacceptor.ChannelAcceptor,
580
        torController *tor.Controller, tlsManager *TLSManager,
581
        leaderElector cluster.LeaderElector,
582
        implCfg *ImplementationCfg) (*server, error) {
3✔
583

3✔
584
        var (
3✔
585
                err         error
3✔
586
                nodeKeyECDH = keychain.NewPubKeyECDH(*nodeKeyDesc, cc.KeyRing)
3✔
587

3✔
588
                // We just derived the full descriptor, so we know the public
3✔
589
                // key is set on it.
3✔
590
                nodeKeySigner = keychain.NewPubKeyMessageSigner(
3✔
591
                        nodeKeyDesc.PubKey, nodeKeyDesc.KeyLocator, cc.KeyRing,
3✔
592
                )
3✔
593
        )
3✔
594

3✔
595
        var serializedPubKey [33]byte
3✔
596
        copy(serializedPubKey[:], nodeKeyDesc.PubKey.SerializeCompressed())
3✔
597

3✔
598
        netParams := cfg.ActiveNetParams.Params
3✔
599

3✔
600
        // Initialize the sphinx router.
3✔
601
        replayLog := htlcswitch.NewDecayedLog(
3✔
602
                dbs.DecayedLogDB, cc.ChainNotifier,
3✔
603
        )
3✔
604
        sphinxRouter := sphinx.NewRouter(nodeKeyECDH, replayLog)
3✔
605

3✔
606
        writeBufferPool := pool.NewWriteBuffer(
3✔
607
                pool.DefaultWriteBufferGCInterval,
3✔
608
                pool.DefaultWriteBufferExpiryInterval,
3✔
609
        )
3✔
610

3✔
611
        writePool := pool.NewWrite(
3✔
612
                writeBufferPool, cfg.Workers.Write, pool.DefaultWorkerTimeout,
3✔
613
        )
3✔
614

3✔
615
        readBufferPool := pool.NewReadBuffer(
3✔
616
                pool.DefaultReadBufferGCInterval,
3✔
617
                pool.DefaultReadBufferExpiryInterval,
3✔
618
        )
3✔
619

3✔
620
        readPool := pool.NewRead(
3✔
621
                readBufferPool, cfg.Workers.Read, pool.DefaultWorkerTimeout,
3✔
622
        )
3✔
623

3✔
624
        // If the taproot overlay flag is set, but we don't have an aux funding
3✔
625
        // controller, then we'll exit as this is incompatible.
3✔
626
        if cfg.ProtocolOptions.TaprootOverlayChans &&
3✔
627
                implCfg.AuxFundingController.IsNone() {
3✔
628

×
629
                return nil, fmt.Errorf("taproot overlay flag set, but not " +
×
630
                        "aux controllers")
×
631
        }
×
632

633
        //nolint:ll
634
        featureMgr, err := feature.NewManager(feature.Config{
3✔
635
                NoTLVOnion:                cfg.ProtocolOptions.LegacyOnion(),
3✔
636
                NoStaticRemoteKey:         cfg.ProtocolOptions.NoStaticRemoteKey(),
3✔
637
                NoAnchors:                 cfg.ProtocolOptions.NoAnchorCommitments(),
3✔
638
                NoWumbo:                   !cfg.ProtocolOptions.Wumbo(),
3✔
639
                NoScriptEnforcementLease:  cfg.ProtocolOptions.NoScriptEnforcementLease(),
3✔
640
                NoKeysend:                 !cfg.AcceptKeySend,
3✔
641
                NoOptionScidAlias:         !cfg.ProtocolOptions.ScidAlias(),
3✔
642
                NoZeroConf:                !cfg.ProtocolOptions.ZeroConf(),
3✔
643
                NoAnySegwit:               cfg.ProtocolOptions.NoAnySegwit(),
3✔
644
                CustomFeatures:            cfg.ProtocolOptions.CustomFeatures(),
3✔
645
                NoTaprootChans:            !cfg.ProtocolOptions.TaprootChans,
3✔
646
                NoTaprootOverlay:          !cfg.ProtocolOptions.TaprootOverlayChans,
3✔
647
                NoRouteBlinding:           cfg.ProtocolOptions.NoRouteBlinding(),
3✔
648
                NoExperimentalEndorsement: cfg.ProtocolOptions.NoExperimentalEndorsement(),
3✔
649
                NoQuiescence:              cfg.ProtocolOptions.NoQuiescence(),
3✔
650
                NoRbfCoopClose:            !cfg.ProtocolOptions.RbfCoopClose,
3✔
651
        })
3✔
652
        if err != nil {
3✔
653
                return nil, err
×
654
        }
×
655

656
        invoiceHtlcModifier := invoices.NewHtlcModificationInterceptor()
3✔
657
        registryConfig := invoices.RegistryConfig{
3✔
658
                FinalCltvRejectDelta:        lncfg.DefaultFinalCltvRejectDelta,
3✔
659
                HtlcHoldDuration:            invoices.DefaultHtlcHoldDuration,
3✔
660
                Clock:                       clock.NewDefaultClock(),
3✔
661
                AcceptKeySend:               cfg.AcceptKeySend,
3✔
662
                AcceptAMP:                   cfg.AcceptAMP,
3✔
663
                GcCanceledInvoicesOnStartup: cfg.GcCanceledInvoicesOnStartup,
3✔
664
                GcCanceledInvoicesOnTheFly:  cfg.GcCanceledInvoicesOnTheFly,
3✔
665
                KeysendHoldTime:             cfg.KeysendHoldTime,
3✔
666
                HtlcInterceptor:             invoiceHtlcModifier,
3✔
667
        }
3✔
668

3✔
669
        addrSource := channeldb.NewMultiAddrSource(dbs.ChanStateDB, dbs.GraphDB)
3✔
670

3✔
671
        s := &server{
3✔
672
                cfg:            cfg,
3✔
673
                implCfg:        implCfg,
3✔
674
                graphDB:        dbs.GraphDB,
3✔
675
                chanStateDB:    dbs.ChanStateDB.ChannelStateDB(),
3✔
676
                addrSource:     addrSource,
3✔
677
                miscDB:         dbs.ChanStateDB,
3✔
678
                invoicesDB:     dbs.InvoiceDB,
3✔
679
                cc:             cc,
3✔
680
                sigPool:        lnwallet.NewSigPool(cfg.Workers.Sig, cc.Signer),
3✔
681
                writePool:      writePool,
3✔
682
                readPool:       readPool,
3✔
683
                chansToRestore: chansToRestore,
3✔
684

3✔
685
                blockbeatDispatcher: chainio.NewBlockbeatDispatcher(
3✔
686
                        cc.ChainNotifier,
3✔
687
                ),
3✔
688
                channelNotifier: channelnotifier.New(
3✔
689
                        dbs.ChanStateDB.ChannelStateDB(),
3✔
690
                ),
3✔
691

3✔
692
                identityECDH:   nodeKeyECDH,
3✔
693
                identityKeyLoc: nodeKeyDesc.KeyLocator,
3✔
694
                nodeSigner:     netann.NewNodeSigner(nodeKeySigner),
3✔
695

3✔
696
                listenAddrs: listenAddrs,
3✔
697

3✔
698
                // TODO(roasbeef): derive proper onion key based on rotation
3✔
699
                // schedule
3✔
700
                sphinx: hop.NewOnionProcessor(sphinxRouter),
3✔
701

3✔
702
                torController: torController,
3✔
703

3✔
704
                persistentPeers:         make(map[string]bool),
3✔
705
                persistentPeersBackoff:  make(map[string]time.Duration),
3✔
706
                persistentConnReqs:      make(map[string][]*connmgr.ConnReq),
3✔
707
                persistentPeerAddrs:     make(map[string][]*lnwire.NetAddress),
3✔
708
                persistentRetryCancels:  make(map[string]chan struct{}),
3✔
709
                peerErrors:              make(map[string]*queue.CircularBuffer),
3✔
710
                ignorePeerTermination:   make(map[*peer.Brontide]struct{}),
3✔
711
                scheduledPeerConnection: make(map[string]func()),
3✔
712
                pongBuf:                 make([]byte, lnwire.MaxPongBytes),
3✔
713

3✔
714
                peersByPub:                make(map[string]*peer.Brontide),
3✔
715
                inboundPeers:              make(map[string]*peer.Brontide),
3✔
716
                outboundPeers:             make(map[string]*peer.Brontide),
3✔
717
                peerConnectedListeners:    make(map[string][]chan<- lnpeer.Peer),
3✔
718
                peerDisconnectedListeners: make(map[string][]chan<- struct{}),
3✔
719

3✔
720
                invoiceHtlcModifier: invoiceHtlcModifier,
3✔
721

3✔
722
                customMessageServer: subscribe.NewServer(),
3✔
723

3✔
724
                tlsManager: tlsManager,
3✔
725

3✔
726
                featureMgr: featureMgr,
3✔
727
                quit:       make(chan struct{}),
3✔
728
        }
3✔
729

3✔
730
        // Start the low-level services once they are initialized.
3✔
731
        //
3✔
732
        // TODO(yy): break the server startup into four steps,
3✔
733
        // 1. init the low-level services.
3✔
734
        // 2. start the low-level services.
3✔
735
        // 3. init the high-level services.
3✔
736
        // 4. start the high-level services.
3✔
737
        if err := s.startLowLevelServices(); err != nil {
3✔
738
                return nil, err
×
739
        }
×
740

741
        currentHash, currentHeight, err := s.cc.ChainIO.GetBestBlock()
3✔
742
        if err != nil {
3✔
743
                return nil, err
×
744
        }
×
745

746
        expiryWatcher := invoices.NewInvoiceExpiryWatcher(
3✔
747
                clock.NewDefaultClock(), cfg.Invoices.HoldExpiryDelta,
3✔
748
                uint32(currentHeight), currentHash, cc.ChainNotifier,
3✔
749
        )
3✔
750
        s.invoices = invoices.NewRegistry(
3✔
751
                dbs.InvoiceDB, expiryWatcher, &registryConfig,
3✔
752
        )
3✔
753

3✔
754
        s.htlcNotifier = htlcswitch.NewHtlcNotifier(time.Now)
3✔
755

3✔
756
        thresholdSats := btcutil.Amount(cfg.MaxFeeExposure)
3✔
757
        thresholdMSats := lnwire.NewMSatFromSatoshis(thresholdSats)
3✔
758

3✔
759
        linkUpdater := func(shortID lnwire.ShortChannelID) error {
6✔
760
                link, err := s.htlcSwitch.GetLinkByShortID(shortID)
3✔
761
                if err != nil {
3✔
762
                        return err
×
763
                }
×
764

765
                s.htlcSwitch.UpdateLinkAliases(link)
3✔
766

3✔
767
                return nil
3✔
768
        }
769

770
        s.aliasMgr, err = aliasmgr.NewManager(dbs.ChanStateDB, linkUpdater)
3✔
771
        if err != nil {
3✔
772
                return nil, err
×
773
        }
×
774

775
        s.htlcSwitch, err = htlcswitch.New(htlcswitch.Config{
3✔
776
                DB:                   dbs.ChanStateDB,
3✔
777
                FetchAllOpenChannels: s.chanStateDB.FetchAllOpenChannels,
3✔
778
                FetchAllChannels:     s.chanStateDB.FetchAllChannels,
3✔
779
                FetchClosedChannels:  s.chanStateDB.FetchClosedChannels,
3✔
780
                LocalChannelClose: func(pubKey []byte,
3✔
781
                        request *htlcswitch.ChanClose) {
6✔
782

3✔
783
                        peer, err := s.FindPeerByPubStr(string(pubKey))
3✔
784
                        if err != nil {
3✔
785
                                srvrLog.Errorf("unable to close channel, peer"+
×
786
                                        " with %v id can't be found: %v",
×
787
                                        pubKey, err,
×
788
                                )
×
789
                                return
×
790
                        }
×
791

792
                        peer.HandleLocalCloseChanReqs(request)
3✔
793
                },
794
                FwdingLog:              dbs.ChanStateDB.ForwardingLog(),
795
                SwitchPackager:         channeldb.NewSwitchPackager(),
796
                ExtractErrorEncrypter:  s.sphinx.ExtractErrorEncrypter,
797
                FetchLastChannelUpdate: s.fetchLastChanUpdate(),
798
                Notifier:               s.cc.ChainNotifier,
799
                HtlcNotifier:           s.htlcNotifier,
800
                FwdEventTicker:         ticker.New(htlcswitch.DefaultFwdEventInterval),
801
                LogEventTicker:         ticker.New(htlcswitch.DefaultLogInterval),
802
                AckEventTicker:         ticker.New(htlcswitch.DefaultAckInterval),
803
                AllowCircularRoute:     cfg.AllowCircularRoute,
804
                RejectHTLC:             cfg.RejectHTLC,
805
                Clock:                  clock.NewDefaultClock(),
806
                MailboxDeliveryTimeout: cfg.Htlcswitch.MailboxDeliveryTimeout,
807
                MaxFeeExposure:         thresholdMSats,
808
                SignAliasUpdate:        s.signAliasUpdate,
809
                IsAlias:                aliasmgr.IsAlias,
810
        }, uint32(currentHeight))
811
        if err != nil {
3✔
812
                return nil, err
×
813
        }
×
814
        s.interceptableSwitch, err = htlcswitch.NewInterceptableSwitch(
3✔
815
                &htlcswitch.InterceptableSwitchConfig{
3✔
816
                        Switch:             s.htlcSwitch,
3✔
817
                        CltvRejectDelta:    lncfg.DefaultFinalCltvRejectDelta,
3✔
818
                        CltvInterceptDelta: lncfg.DefaultCltvInterceptDelta,
3✔
819
                        RequireInterceptor: s.cfg.RequireInterceptor,
3✔
820
                        Notifier:           s.cc.ChainNotifier,
3✔
821
                },
3✔
822
        )
3✔
823
        if err != nil {
3✔
824
                return nil, err
×
825
        }
×
826

827
        s.witnessBeacon = newPreimageBeacon(
3✔
828
                dbs.ChanStateDB.NewWitnessCache(),
3✔
829
                s.interceptableSwitch.ForwardPacket,
3✔
830
        )
3✔
831

3✔
832
        chanStatusMgrCfg := &netann.ChanStatusConfig{
3✔
833
                ChanStatusSampleInterval: cfg.ChanStatusSampleInterval,
3✔
834
                ChanEnableTimeout:        cfg.ChanEnableTimeout,
3✔
835
                ChanDisableTimeout:       cfg.ChanDisableTimeout,
3✔
836
                OurPubKey:                nodeKeyDesc.PubKey,
3✔
837
                OurKeyLoc:                nodeKeyDesc.KeyLocator,
3✔
838
                MessageSigner:            s.nodeSigner,
3✔
839
                IsChannelActive:          s.htlcSwitch.HasActiveLink,
3✔
840
                ApplyChannelUpdate:       s.applyChannelUpdate,
3✔
841
                DB:                       s.chanStateDB,
3✔
842
                Graph:                    dbs.GraphDB,
3✔
843
        }
3✔
844

3✔
845
        chanStatusMgr, err := netann.NewChanStatusManager(chanStatusMgrCfg)
3✔
846
        if err != nil {
3✔
847
                return nil, err
×
848
        }
×
849
        s.chanStatusMgr = chanStatusMgr
3✔
850

3✔
851
        // If enabled, use either UPnP or NAT-PMP to automatically configure
3✔
852
        // port forwarding for users behind a NAT.
3✔
853
        if cfg.NAT {
3✔
854
                srvrLog.Info("Scanning local network for a UPnP enabled device")
×
855

×
856
                discoveryTimeout := time.Duration(10 * time.Second)
×
857

×
858
                ctx, cancel := context.WithTimeout(
×
859
                        context.Background(), discoveryTimeout,
×
860
                )
×
861
                defer cancel()
×
862
                upnp, err := nat.DiscoverUPnP(ctx)
×
863
                if err == nil {
×
864
                        s.natTraversal = upnp
×
865
                } else {
×
866
                        // If we were not able to discover a UPnP enabled device
×
867
                        // on the local network, we'll fall back to attempting
×
868
                        // to discover a NAT-PMP enabled device.
×
869
                        srvrLog.Errorf("Unable to discover a UPnP enabled "+
×
870
                                "device on the local network: %v", err)
×
871

×
872
                        srvrLog.Info("Scanning local network for a NAT-PMP " +
×
873
                                "enabled device")
×
874

×
875
                        pmp, err := nat.DiscoverPMP(discoveryTimeout)
×
876
                        if err != nil {
×
877
                                err := fmt.Errorf("unable to discover a "+
×
878
                                        "NAT-PMP enabled device on the local "+
×
879
                                        "network: %v", err)
×
880
                                srvrLog.Error(err)
×
881
                                return nil, err
×
882
                        }
×
883

884
                        s.natTraversal = pmp
×
885
                }
886
        }
887

888
        // If we were requested to automatically configure port forwarding,
889
        // we'll use the ports that the server will be listening on.
890
        externalIPStrings := make([]string, len(cfg.ExternalIPs))
3✔
891
        for idx, ip := range cfg.ExternalIPs {
6✔
892
                externalIPStrings[idx] = ip.String()
3✔
893
        }
3✔
894
        if s.natTraversal != nil {
3✔
895
                listenPorts := make([]uint16, 0, len(listenAddrs))
×
896
                for _, listenAddr := range listenAddrs {
×
897
                        // At this point, the listen addresses should have
×
898
                        // already been normalized, so it's safe to ignore the
×
899
                        // errors.
×
900
                        _, portStr, _ := net.SplitHostPort(listenAddr.String())
×
901
                        port, _ := strconv.Atoi(portStr)
×
902

×
903
                        listenPorts = append(listenPorts, uint16(port))
×
904
                }
×
905

906
                ips, err := s.configurePortForwarding(listenPorts...)
×
907
                if err != nil {
×
908
                        srvrLog.Errorf("Unable to automatically set up port "+
×
909
                                "forwarding using %s: %v",
×
910
                                s.natTraversal.Name(), err)
×
911
                } else {
×
912
                        srvrLog.Infof("Automatically set up port forwarding "+
×
913
                                "using %s to advertise external IP",
×
914
                                s.natTraversal.Name())
×
915
                        externalIPStrings = append(externalIPStrings, ips...)
×
916
                }
×
917
        }
918

919
        // If external IP addresses have been specified, add those to the list
920
        // of this server's addresses.
921
        externalIPs, err := lncfg.NormalizeAddresses(
3✔
922
                externalIPStrings, strconv.Itoa(defaultPeerPort),
3✔
923
                cfg.net.ResolveTCPAddr,
3✔
924
        )
3✔
925
        if err != nil {
3✔
926
                return nil, err
×
927
        }
×
928

929
        selfAddrs := make([]net.Addr, 0, len(externalIPs))
3✔
930
        selfAddrs = append(selfAddrs, externalIPs...)
3✔
931

3✔
932
        // We'll now reconstruct a node announcement based on our current
3✔
933
        // configuration so we can send it out as a sort of heart beat within
3✔
934
        // the network.
3✔
935
        //
3✔
936
        // We'll start by parsing the node color from configuration.
3✔
937
        color, err := lncfg.ParseHexColor(cfg.Color)
3✔
938
        if err != nil {
3✔
939
                srvrLog.Errorf("unable to parse color: %v\n", err)
×
940
                return nil, err
×
941
        }
×
942

943
        // If no alias is provided, default to first 10 characters of public
944
        // key.
945
        alias := cfg.Alias
3✔
946
        if alias == "" {
6✔
947
                alias = hex.EncodeToString(serializedPubKey[:10])
3✔
948
        }
3✔
949
        nodeAlias, err := lnwire.NewNodeAlias(alias)
3✔
950
        if err != nil {
3✔
951
                return nil, err
×
952
        }
×
953

954
        // TODO(elle): All previously persisted node announcement fields (ie,
955
        //  not just LastUpdate) should be consulted here to ensure that we
956
        //  aren't overwriting any fields that may have been set during the
957
        //  last run of lnd.
958
        nodeLastUpdate := time.Now()
3✔
959
        srcNode, err := dbs.GraphDB.SourceNode(ctx)
3✔
960
        switch {
3✔
961
        // If we have a source node persisted in the DB already, then we just
962
        // need to make sure that the new LastUpdate time is at least one
963
        // second after the last update time.
964
        case err == nil:
3✔
965
                if srcNode.LastUpdate.Second() >= nodeLastUpdate.Second() {
6✔
966
                        nodeLastUpdate = srcNode.LastUpdate.Add(time.Second)
3✔
967
                }
3✔
968

969
        // If we don't have a source node persisted in the DB, then we'll
970
        // create a new one with the current time as the LastUpdate.
971
        case errors.Is(err, graphdb.ErrSourceNodeNotSet):
3✔
972

973
        // If the above cases are not matched, then we have an unhandled non
974
        // nil error.
975
        default:
×
976
                return nil, fmt.Errorf("unable to fetch source node: %w", err)
×
977
        }
978

979
        selfNode := &models.LightningNode{
3✔
980
                HaveNodeAnnouncement: true,
3✔
981
                LastUpdate:           nodeLastUpdate,
3✔
982
                Addresses:            selfAddrs,
3✔
983
                Alias:                nodeAlias.String(),
3✔
984
                Features:             s.featureMgr.Get(feature.SetNodeAnn),
3✔
985
                Color:                color,
3✔
986
        }
3✔
987
        copy(selfNode.PubKeyBytes[:], nodeKeyDesc.PubKey.SerializeCompressed())
3✔
988

3✔
989
        // Based on the disk representation of the node announcement generated
3✔
990
        // above, we'll generate a node announcement that can go out on the
3✔
991
        // network so we can properly sign it.
3✔
992
        nodeAnn, err := selfNode.NodeAnnouncement(false)
3✔
993
        if err != nil {
3✔
994
                return nil, fmt.Errorf("unable to gen self node ann: %w", err)
×
995
        }
×
996

997
        // With the announcement generated, we'll sign it to properly
998
        // authenticate the message on the network.
999
        authSig, err := netann.SignAnnouncement(
3✔
1000
                s.nodeSigner, nodeKeyDesc.KeyLocator, nodeAnn,
3✔
1001
        )
3✔
1002
        if err != nil {
3✔
1003
                return nil, fmt.Errorf("unable to generate signature for "+
×
1004
                        "self node announcement: %v", err)
×
1005
        }
×
1006
        selfNode.AuthSigBytes = authSig.Serialize()
3✔
1007
        nodeAnn.Signature, err = lnwire.NewSigFromECDSARawSignature(
3✔
1008
                selfNode.AuthSigBytes,
3✔
1009
        )
3✔
1010
        if err != nil {
3✔
1011
                return nil, err
×
1012
        }
×
1013

1014
        // Finally, we'll update the representation on disk, and update our
1015
        // cached in-memory version as well.
1016
        if err := dbs.GraphDB.SetSourceNode(ctx, selfNode); err != nil {
3✔
1017
                return nil, fmt.Errorf("can't set self node: %w", err)
×
1018
        }
×
1019
        s.currentNodeAnn = nodeAnn
3✔
1020

3✔
1021
        // The router will get access to the payment ID sequencer, such that it
3✔
1022
        // can generate unique payment IDs.
3✔
1023
        sequencer, err := htlcswitch.NewPersistentSequencer(dbs.ChanStateDB)
3✔
1024
        if err != nil {
3✔
1025
                return nil, err
×
1026
        }
×
1027

1028
        // Instantiate mission control with config from the sub server.
1029
        //
1030
        // TODO(joostjager): When we are further in the process of moving to sub
1031
        // servers, the mission control instance itself can be moved there too.
1032
        routingConfig := routerrpc.GetRoutingConfig(cfg.SubRPCServers.RouterRPC)
3✔
1033

3✔
1034
        // We only initialize a probability estimator if there's no custom one.
3✔
1035
        var estimator routing.Estimator
3✔
1036
        if cfg.Estimator != nil {
3✔
1037
                estimator = cfg.Estimator
×
1038
        } else {
3✔
1039
                switch routingConfig.ProbabilityEstimatorType {
3✔
1040
                case routing.AprioriEstimatorName:
3✔
1041
                        aCfg := routingConfig.AprioriConfig
3✔
1042
                        aprioriConfig := routing.AprioriConfig{
3✔
1043
                                AprioriHopProbability: aCfg.HopProbability,
3✔
1044
                                PenaltyHalfLife:       aCfg.PenaltyHalfLife,
3✔
1045
                                AprioriWeight:         aCfg.Weight,
3✔
1046
                                CapacityFraction:      aCfg.CapacityFraction,
3✔
1047
                        }
3✔
1048

3✔
1049
                        estimator, err = routing.NewAprioriEstimator(
3✔
1050
                                aprioriConfig,
3✔
1051
                        )
3✔
1052
                        if err != nil {
3✔
1053
                                return nil, err
×
1054
                        }
×
1055

1056
                case routing.BimodalEstimatorName:
×
1057
                        bCfg := routingConfig.BimodalConfig
×
1058
                        bimodalConfig := routing.BimodalConfig{
×
1059
                                BimodalNodeWeight: bCfg.NodeWeight,
×
1060
                                BimodalScaleMsat: lnwire.MilliSatoshi(
×
1061
                                        bCfg.Scale,
×
1062
                                ),
×
1063
                                BimodalDecayTime: bCfg.DecayTime,
×
1064
                        }
×
1065

×
1066
                        estimator, err = routing.NewBimodalEstimator(
×
1067
                                bimodalConfig,
×
1068
                        )
×
1069
                        if err != nil {
×
1070
                                return nil, err
×
1071
                        }
×
1072

1073
                default:
×
1074
                        return nil, fmt.Errorf("unknown estimator type %v",
×
1075
                                routingConfig.ProbabilityEstimatorType)
×
1076
                }
1077
        }
1078

1079
        mcCfg := &routing.MissionControlConfig{
3✔
1080
                OnConfigUpdate:          fn.Some(s.UpdateRoutingConfig),
3✔
1081
                Estimator:               estimator,
3✔
1082
                MaxMcHistory:            routingConfig.MaxMcHistory,
3✔
1083
                McFlushInterval:         routingConfig.McFlushInterval,
3✔
1084
                MinFailureRelaxInterval: routing.DefaultMinFailureRelaxInterval,
3✔
1085
        }
3✔
1086

3✔
1087
        s.missionController, err = routing.NewMissionController(
3✔
1088
                dbs.ChanStateDB, selfNode.PubKeyBytes, mcCfg,
3✔
1089
        )
3✔
1090
        if err != nil {
3✔
1091
                return nil, fmt.Errorf("can't create mission control "+
×
1092
                        "manager: %w", err)
×
1093
        }
×
1094
        s.defaultMC, err = s.missionController.GetNamespacedStore(
3✔
1095
                routing.DefaultMissionControlNamespace,
3✔
1096
        )
3✔
1097
        if err != nil {
3✔
1098
                return nil, fmt.Errorf("can't create mission control in the "+
×
1099
                        "default namespace: %w", err)
×
1100
        }
×
1101

1102
        srvrLog.Debugf("Instantiating payment session source with config: "+
3✔
1103
                "AttemptCost=%v + %v%%, MinRouteProbability=%v",
3✔
1104
                int64(routingConfig.AttemptCost),
3✔
1105
                float64(routingConfig.AttemptCostPPM)/10000,
3✔
1106
                routingConfig.MinRouteProbability)
3✔
1107

3✔
1108
        pathFindingConfig := routing.PathFindingConfig{
3✔
1109
                AttemptCost: lnwire.NewMSatFromSatoshis(
3✔
1110
                        routingConfig.AttemptCost,
3✔
1111
                ),
3✔
1112
                AttemptCostPPM: routingConfig.AttemptCostPPM,
3✔
1113
                MinProbability: routingConfig.MinRouteProbability,
3✔
1114
        }
3✔
1115

3✔
1116
        sourceNode, err := dbs.GraphDB.SourceNode(ctx)
3✔
1117
        if err != nil {
3✔
1118
                return nil, fmt.Errorf("error getting source node: %w", err)
×
1119
        }
×
1120
        paymentSessionSource := &routing.SessionSource{
3✔
1121
                GraphSessionFactory: dbs.GraphDB,
3✔
1122
                SourceNode:          sourceNode,
3✔
1123
                MissionControl:      s.defaultMC,
3✔
1124
                GetLink:             s.htlcSwitch.GetLinkByShortID,
3✔
1125
                PathFindingConfig:   pathFindingConfig,
3✔
1126
        }
3✔
1127

3✔
1128
        paymentControl := channeldb.NewPaymentControl(dbs.ChanStateDB)
3✔
1129

3✔
1130
        s.controlTower = routing.NewControlTower(paymentControl)
3✔
1131

3✔
1132
        strictPruning := cfg.Bitcoin.Node == "neutrino" ||
3✔
1133
                cfg.Routing.StrictZombiePruning
3✔
1134

3✔
1135
        s.graphBuilder, err = graph.NewBuilder(&graph.Config{
3✔
1136
                SelfNode:            selfNode.PubKeyBytes,
3✔
1137
                Graph:               dbs.GraphDB,
3✔
1138
                Chain:               cc.ChainIO,
3✔
1139
                ChainView:           cc.ChainView,
3✔
1140
                Notifier:            cc.ChainNotifier,
3✔
1141
                ChannelPruneExpiry:  graph.DefaultChannelPruneExpiry,
3✔
1142
                GraphPruneInterval:  time.Hour,
3✔
1143
                FirstTimePruneDelay: graph.DefaultFirstTimePruneDelay,
3✔
1144
                AssumeChannelValid:  cfg.Routing.AssumeChannelValid,
3✔
1145
                StrictZombiePruning: strictPruning,
3✔
1146
                IsAlias:             aliasmgr.IsAlias,
3✔
1147
        })
3✔
1148
        if err != nil {
3✔
1149
                return nil, fmt.Errorf("can't create graph builder: %w", err)
×
1150
        }
×
1151

1152
        s.chanRouter, err = routing.New(routing.Config{
3✔
1153
                SelfNode:           selfNode.PubKeyBytes,
3✔
1154
                RoutingGraph:       dbs.GraphDB,
3✔
1155
                Chain:              cc.ChainIO,
3✔
1156
                Payer:              s.htlcSwitch,
3✔
1157
                Control:            s.controlTower,
3✔
1158
                MissionControl:     s.defaultMC,
3✔
1159
                SessionSource:      paymentSessionSource,
3✔
1160
                GetLink:            s.htlcSwitch.GetLinkByShortID,
3✔
1161
                NextPaymentID:      sequencer.NextID,
3✔
1162
                PathFindingConfig:  pathFindingConfig,
3✔
1163
                Clock:              clock.NewDefaultClock(),
3✔
1164
                ApplyChannelUpdate: s.graphBuilder.ApplyChannelUpdate,
3✔
1165
                ClosedSCIDs:        s.fetchClosedChannelSCIDs(),
3✔
1166
                TrafficShaper:      implCfg.TrafficShaper,
3✔
1167
        })
3✔
1168
        if err != nil {
3✔
1169
                return nil, fmt.Errorf("can't create router: %w", err)
×
1170
        }
×
1171

1172
        chanSeries := discovery.NewChanSeries(s.graphDB)
3✔
1173
        gossipMessageStore, err := discovery.NewMessageStore(dbs.ChanStateDB)
3✔
1174
        if err != nil {
3✔
1175
                return nil, err
×
1176
        }
×
1177
        waitingProofStore, err := channeldb.NewWaitingProofStore(dbs.ChanStateDB)
3✔
1178
        if err != nil {
3✔
1179
                return nil, err
×
1180
        }
×
1181

1182
        scidCloserMan := discovery.NewScidCloserMan(s.graphDB, s.chanStateDB)
3✔
1183

3✔
1184
        s.authGossiper = discovery.New(discovery.Config{
3✔
1185
                Graph:                 s.graphBuilder,
3✔
1186
                ChainIO:               s.cc.ChainIO,
3✔
1187
                Notifier:              s.cc.ChainNotifier,
3✔
1188
                ChainHash:             *s.cfg.ActiveNetParams.GenesisHash,
3✔
1189
                Broadcast:             s.BroadcastMessage,
3✔
1190
                ChanSeries:            chanSeries,
3✔
1191
                NotifyWhenOnline:      s.NotifyWhenOnline,
3✔
1192
                NotifyWhenOffline:     s.NotifyWhenOffline,
3✔
1193
                FetchSelfAnnouncement: s.getNodeAnnouncement,
3✔
1194
                UpdateSelfAnnouncement: func() (lnwire.NodeAnnouncement,
3✔
1195
                        error) {
3✔
1196

×
1197
                        return s.genNodeAnnouncement(nil)
×
1198
                },
×
1199
                ProofMatureDelta:        cfg.Gossip.AnnouncementConf,
1200
                TrickleDelay:            time.Millisecond * time.Duration(cfg.TrickleDelay),
1201
                RetransmitTicker:        ticker.New(time.Minute * 30),
1202
                RebroadcastInterval:     time.Hour * 24,
1203
                WaitingProofStore:       waitingProofStore,
1204
                MessageStore:            gossipMessageStore,
1205
                AnnSigner:               s.nodeSigner,
1206
                RotateTicker:            ticker.New(discovery.DefaultSyncerRotationInterval),
1207
                HistoricalSyncTicker:    ticker.New(cfg.HistoricalSyncInterval),
1208
                NumActiveSyncers:        cfg.NumGraphSyncPeers,
1209
                NoTimestampQueries:      cfg.ProtocolOptions.NoTimestampQueryOption, //nolint:ll
1210
                MinimumBatchSize:        10,
1211
                SubBatchDelay:           cfg.Gossip.SubBatchDelay,
1212
                IgnoreHistoricalFilters: cfg.IgnoreHistoricalGossipFilters,
1213
                PinnedSyncers:           cfg.Gossip.PinnedSyncers,
1214
                MaxChannelUpdateBurst:   cfg.Gossip.MaxChannelUpdateBurst,
1215
                ChannelUpdateInterval:   cfg.Gossip.ChannelUpdateInterval,
1216
                IsAlias:                 aliasmgr.IsAlias,
1217
                SignAliasUpdate:         s.signAliasUpdate,
1218
                FindBaseByAlias:         s.aliasMgr.FindBaseSCID,
1219
                GetAlias:                s.aliasMgr.GetPeerAlias,
1220
                FindChannel:             s.findChannel,
1221
                IsStillZombieChannel:    s.graphBuilder.IsZombieChannel,
1222
                ScidCloser:              scidCloserMan,
1223
                AssumeChannelValid:      cfg.Routing.AssumeChannelValid,
1224
                MsgRateBytes:            cfg.Gossip.MsgRateBytes,
1225
                MsgBurstBytes:           cfg.Gossip.MsgBurstBytes,
1226
        }, nodeKeyDesc)
1227

1228
        accessCfg := &accessManConfig{
3✔
1229
                initAccessPerms: func() (map[string]channeldb.ChanCount,
3✔
1230
                        error) {
6✔
1231

3✔
1232
                        genesisHash := *s.cfg.ActiveNetParams.GenesisHash
3✔
1233
                        return s.chanStateDB.FetchPermAndTempPeers(
3✔
1234
                                genesisHash[:],
3✔
1235
                        )
3✔
1236
                },
3✔
1237
                shouldDisconnect:   s.authGossiper.ShouldDisconnect,
1238
                maxRestrictedSlots: int64(s.cfg.NumRestrictedSlots),
1239
        }
1240

1241
        peerAccessMan, err := newAccessMan(accessCfg)
3✔
1242
        if err != nil {
3✔
1243
                return nil, err
×
1244
        }
×
1245

1246
        s.peerAccessMan = peerAccessMan
3✔
1247

3✔
1248
        selfVertex := route.Vertex(nodeKeyDesc.PubKey.SerializeCompressed())
3✔
1249
        //nolint:ll
3✔
1250
        s.localChanMgr = &localchans.Manager{
3✔
1251
                SelfPub:              nodeKeyDesc.PubKey,
3✔
1252
                DefaultRoutingPolicy: cc.RoutingPolicy,
3✔
1253
                ForAllOutgoingChannels: func(cb func(*models.ChannelEdgeInfo,
3✔
1254
                        *models.ChannelEdgePolicy) error) error {
6✔
1255

3✔
1256
                        return s.graphDB.ForEachNodeChannel(selfVertex,
3✔
1257
                                func(c *models.ChannelEdgeInfo,
3✔
1258
                                        e *models.ChannelEdgePolicy,
3✔
1259
                                        _ *models.ChannelEdgePolicy) error {
6✔
1260

3✔
1261
                                        // NOTE: The invoked callback here may
3✔
1262
                                        // receive a nil channel policy.
3✔
1263
                                        return cb(c, e)
3✔
1264
                                },
3✔
1265
                        )
1266
                },
1267
                PropagateChanPolicyUpdate: s.authGossiper.PropagateChanPolicyUpdate,
1268
                UpdateForwardingPolicies:  s.htlcSwitch.UpdateForwardingPolicies,
1269
                FetchChannel:              s.chanStateDB.FetchChannel,
1270
                AddEdge: func(ctx context.Context,
1271
                        edge *models.ChannelEdgeInfo) error {
×
1272

×
1273
                        return s.graphBuilder.AddEdge(ctx, edge)
×
1274
                },
×
1275
        }
1276

1277
        utxnStore, err := contractcourt.NewNurseryStore(
3✔
1278
                s.cfg.ActiveNetParams.GenesisHash, dbs.ChanStateDB,
3✔
1279
        )
3✔
1280
        if err != nil {
3✔
1281
                srvrLog.Errorf("unable to create nursery store: %v", err)
×
1282
                return nil, err
×
1283
        }
×
1284

1285
        sweeperStore, err := sweep.NewSweeperStore(
3✔
1286
                dbs.ChanStateDB, s.cfg.ActiveNetParams.GenesisHash,
3✔
1287
        )
3✔
1288
        if err != nil {
3✔
1289
                srvrLog.Errorf("unable to create sweeper store: %v", err)
×
1290
                return nil, err
×
1291
        }
×
1292

1293
        aggregator := sweep.NewBudgetAggregator(
3✔
1294
                cc.FeeEstimator, sweep.DefaultMaxInputsPerTx,
3✔
1295
                s.implCfg.AuxSweeper,
3✔
1296
        )
3✔
1297

3✔
1298
        s.txPublisher = sweep.NewTxPublisher(sweep.TxPublisherConfig{
3✔
1299
                Signer:     cc.Wallet.Cfg.Signer,
3✔
1300
                Wallet:     cc.Wallet,
3✔
1301
                Estimator:  cc.FeeEstimator,
3✔
1302
                Notifier:   cc.ChainNotifier,
3✔
1303
                AuxSweeper: s.implCfg.AuxSweeper,
3✔
1304
        })
3✔
1305

3✔
1306
        s.sweeper = sweep.New(&sweep.UtxoSweeperConfig{
3✔
1307
                FeeEstimator: cc.FeeEstimator,
3✔
1308
                GenSweepScript: newSweepPkScriptGen(
3✔
1309
                        cc.Wallet, s.cfg.ActiveNetParams.Params,
3✔
1310
                ),
3✔
1311
                Signer:               cc.Wallet.Cfg.Signer,
3✔
1312
                Wallet:               newSweeperWallet(cc.Wallet),
3✔
1313
                Mempool:              cc.MempoolNotifier,
3✔
1314
                Notifier:             cc.ChainNotifier,
3✔
1315
                Store:                sweeperStore,
3✔
1316
                MaxInputsPerTx:       sweep.DefaultMaxInputsPerTx,
3✔
1317
                MaxFeeRate:           cfg.Sweeper.MaxFeeRate,
3✔
1318
                Aggregator:           aggregator,
3✔
1319
                Publisher:            s.txPublisher,
3✔
1320
                NoDeadlineConfTarget: cfg.Sweeper.NoDeadlineConfTarget,
3✔
1321
        })
3✔
1322

3✔
1323
        s.utxoNursery = contractcourt.NewUtxoNursery(&contractcourt.NurseryConfig{
3✔
1324
                ChainIO:             cc.ChainIO,
3✔
1325
                ConfDepth:           1,
3✔
1326
                FetchClosedChannels: s.chanStateDB.FetchClosedChannels,
3✔
1327
                FetchClosedChannel:  s.chanStateDB.FetchClosedChannel,
3✔
1328
                Notifier:            cc.ChainNotifier,
3✔
1329
                PublishTransaction:  cc.Wallet.PublishTransaction,
3✔
1330
                Store:               utxnStore,
3✔
1331
                SweepInput:          s.sweeper.SweepInput,
3✔
1332
                Budget:              s.cfg.Sweeper.Budget,
3✔
1333
        })
3✔
1334

3✔
1335
        // Construct a closure that wraps the htlcswitch's CloseLink method.
3✔
1336
        closeLink := func(chanPoint *wire.OutPoint,
3✔
1337
                closureType contractcourt.ChannelCloseType) {
6✔
1338
                // TODO(conner): Properly respect the update and error channels
3✔
1339
                // returned by CloseLink.
3✔
1340

3✔
1341
                // Instruct the switch to close the channel.  Provide no close out
3✔
1342
                // delivery script or target fee per kw because user input is not
3✔
1343
                // available when the remote peer closes the channel.
3✔
1344
                s.htlcSwitch.CloseLink(
3✔
1345
                        context.Background(), chanPoint, closureType, 0, 0, nil,
3✔
1346
                )
3✔
1347
        }
3✔
1348

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

3✔
1353
        s.breachArbitrator = contractcourt.NewBreachArbitrator(
3✔
1354
                &contractcourt.BreachConfig{
3✔
1355
                        CloseLink: closeLink,
3✔
1356
                        DB:        s.chanStateDB,
3✔
1357
                        Estimator: s.cc.FeeEstimator,
3✔
1358
                        GenSweepScript: newSweepPkScriptGen(
3✔
1359
                                cc.Wallet, s.cfg.ActiveNetParams.Params,
3✔
1360
                        ),
3✔
1361
                        Notifier:           cc.ChainNotifier,
3✔
1362
                        PublishTransaction: cc.Wallet.PublishTransaction,
3✔
1363
                        ContractBreaches:   contractBreaches,
3✔
1364
                        Signer:             cc.Wallet.Cfg.Signer,
3✔
1365
                        Store: contractcourt.NewRetributionStore(
3✔
1366
                                dbs.ChanStateDB,
3✔
1367
                        ),
3✔
1368
                        AuxSweeper: s.implCfg.AuxSweeper,
3✔
1369
                },
3✔
1370
        )
3✔
1371

3✔
1372
        //nolint:ll
3✔
1373
        s.chainArb = contractcourt.NewChainArbitrator(contractcourt.ChainArbitratorConfig{
3✔
1374
                ChainHash:              *s.cfg.ActiveNetParams.GenesisHash,
3✔
1375
                IncomingBroadcastDelta: lncfg.DefaultIncomingBroadcastDelta,
3✔
1376
                OutgoingBroadcastDelta: lncfg.DefaultOutgoingBroadcastDelta,
3✔
1377
                NewSweepAddr: func() ([]byte, error) {
3✔
1378
                        addr, err := newSweepPkScriptGen(
×
1379
                                cc.Wallet, netParams,
×
1380
                        )().Unpack()
×
1381
                        if err != nil {
×
1382
                                return nil, err
×
1383
                        }
×
1384

1385
                        return addr.DeliveryAddress, nil
×
1386
                },
1387
                PublishTx: cc.Wallet.PublishTransaction,
1388
                DeliverResolutionMsg: func(msgs ...contractcourt.ResolutionMsg) error {
3✔
1389
                        for _, msg := range msgs {
6✔
1390
                                err := s.htlcSwitch.ProcessContractResolution(msg)
3✔
1391
                                if err != nil {
3✔
1392
                                        return err
×
1393
                                }
×
1394
                        }
1395
                        return nil
3✔
1396
                },
1397
                IncubateOutputs: func(chanPoint wire.OutPoint,
1398
                        outHtlcRes fn.Option[lnwallet.OutgoingHtlcResolution],
1399
                        inHtlcRes fn.Option[lnwallet.IncomingHtlcResolution],
1400
                        broadcastHeight uint32,
1401
                        deadlineHeight fn.Option[int32]) error {
3✔
1402

3✔
1403
                        return s.utxoNursery.IncubateOutputs(
3✔
1404
                                chanPoint, outHtlcRes, inHtlcRes,
3✔
1405
                                broadcastHeight, deadlineHeight,
3✔
1406
                        )
3✔
1407
                },
3✔
1408
                PreimageDB:   s.witnessBeacon,
1409
                Notifier:     cc.ChainNotifier,
1410
                Mempool:      cc.MempoolNotifier,
1411
                Signer:       cc.Wallet.Cfg.Signer,
1412
                FeeEstimator: cc.FeeEstimator,
1413
                ChainIO:      cc.ChainIO,
1414
                MarkLinkInactive: func(chanPoint wire.OutPoint) error {
3✔
1415
                        chanID := lnwire.NewChanIDFromOutPoint(chanPoint)
3✔
1416
                        s.htlcSwitch.RemoveLink(chanID)
3✔
1417
                        return nil
3✔
1418
                },
3✔
1419
                IsOurAddress: cc.Wallet.IsOurAddress,
1420
                ContractBreach: func(chanPoint wire.OutPoint,
1421
                        breachRet *lnwallet.BreachRetribution) error {
3✔
1422

3✔
1423
                        // processACK will handle the BreachArbitrator ACKing
3✔
1424
                        // the event.
3✔
1425
                        finalErr := make(chan error, 1)
3✔
1426
                        processACK := func(brarErr error) {
6✔
1427
                                if brarErr != nil {
3✔
1428
                                        finalErr <- brarErr
×
1429
                                        return
×
1430
                                }
×
1431

1432
                                // If the BreachArbitrator successfully handled
1433
                                // the event, we can signal that the handoff
1434
                                // was successful.
1435
                                finalErr <- nil
3✔
1436
                        }
1437

1438
                        event := &contractcourt.ContractBreachEvent{
3✔
1439
                                ChanPoint:         chanPoint,
3✔
1440
                                ProcessACK:        processACK,
3✔
1441
                                BreachRetribution: breachRet,
3✔
1442
                        }
3✔
1443

3✔
1444
                        // Send the contract breach event to the
3✔
1445
                        // BreachArbitrator.
3✔
1446
                        select {
3✔
1447
                        case contractBreaches <- event:
3✔
1448
                        case <-s.quit:
×
1449
                                return ErrServerShuttingDown
×
1450
                        }
1451

1452
                        // We'll wait for a final error to be available from
1453
                        // the BreachArbitrator.
1454
                        select {
3✔
1455
                        case err := <-finalErr:
3✔
1456
                                return err
3✔
1457
                        case <-s.quit:
×
1458
                                return ErrServerShuttingDown
×
1459
                        }
1460
                },
1461
                DisableChannel: func(chanPoint wire.OutPoint) error {
3✔
1462
                        return s.chanStatusMgr.RequestDisable(chanPoint, false)
3✔
1463
                },
3✔
1464
                Sweeper:                       s.sweeper,
1465
                Registry:                      s.invoices,
1466
                NotifyClosedChannel:           s.channelNotifier.NotifyClosedChannelEvent,
1467
                NotifyFullyResolvedChannel:    s.channelNotifier.NotifyFullyResolvedChannelEvent,
1468
                OnionProcessor:                s.sphinx,
1469
                PaymentsExpirationGracePeriod: cfg.PaymentsExpirationGracePeriod,
1470
                IsForwardedHTLC:               s.htlcSwitch.IsForwardedHTLC,
1471
                Clock:                         clock.NewDefaultClock(),
1472
                SubscribeBreachComplete:       s.breachArbitrator.SubscribeBreachComplete,
1473
                PutFinalHtlcOutcome:           s.chanStateDB.PutOnchainFinalHtlcOutcome,
1474
                HtlcNotifier:                  s.htlcNotifier,
1475
                Budget:                        *s.cfg.Sweeper.Budget,
1476

1477
                // TODO(yy): remove this hack once PaymentCircuit is interfaced.
1478
                QueryIncomingCircuit: func(
1479
                        circuit models.CircuitKey) *models.CircuitKey {
3✔
1480

3✔
1481
                        // Get the circuit map.
3✔
1482
                        circuits := s.htlcSwitch.CircuitLookup()
3✔
1483

3✔
1484
                        // Lookup the outgoing circuit.
3✔
1485
                        pc := circuits.LookupOpenCircuit(circuit)
3✔
1486
                        if pc == nil {
5✔
1487
                                return nil
2✔
1488
                        }
2✔
1489

1490
                        return &pc.Incoming
3✔
1491
                },
1492
                AuxLeafStore: implCfg.AuxLeafStore,
1493
                AuxSigner:    implCfg.AuxSigner,
1494
                AuxResolver:  implCfg.AuxContractResolver,
1495
        }, dbs.ChanStateDB)
1496

1497
        // Select the configuration and funding parameters for Bitcoin.
1498
        chainCfg := cfg.Bitcoin
3✔
1499
        minRemoteDelay := funding.MinBtcRemoteDelay
3✔
1500
        maxRemoteDelay := funding.MaxBtcRemoteDelay
3✔
1501

3✔
1502
        var chanIDSeed [32]byte
3✔
1503
        if _, err := rand.Read(chanIDSeed[:]); err != nil {
3✔
1504
                return nil, err
×
1505
        }
×
1506

1507
        // Wrap the DeleteChannelEdges method so that the funding manager can
1508
        // use it without depending on several layers of indirection.
1509
        deleteAliasEdge := func(scid lnwire.ShortChannelID) (
3✔
1510
                *models.ChannelEdgePolicy, error) {
6✔
1511

3✔
1512
                info, e1, e2, err := s.graphDB.FetchChannelEdgesByID(
3✔
1513
                        scid.ToUint64(),
3✔
1514
                )
3✔
1515
                if errors.Is(err, graphdb.ErrEdgeNotFound) {
3✔
1516
                        // This is unlikely but there is a slim chance of this
×
1517
                        // being hit if lnd was killed via SIGKILL and the
×
1518
                        // funding manager was stepping through the delete
×
1519
                        // alias edge logic.
×
1520
                        return nil, nil
×
1521
                } else if err != nil {
3✔
1522
                        return nil, err
×
1523
                }
×
1524

1525
                // Grab our key to find our policy.
1526
                var ourKey [33]byte
3✔
1527
                copy(ourKey[:], nodeKeyDesc.PubKey.SerializeCompressed())
3✔
1528

3✔
1529
                var ourPolicy *models.ChannelEdgePolicy
3✔
1530
                if info != nil && info.NodeKey1Bytes == ourKey {
6✔
1531
                        ourPolicy = e1
3✔
1532
                } else {
6✔
1533
                        ourPolicy = e2
3✔
1534
                }
3✔
1535

1536
                if ourPolicy == nil {
3✔
1537
                        // Something is wrong, so return an error.
×
1538
                        return nil, fmt.Errorf("we don't have an edge")
×
1539
                }
×
1540

1541
                err = s.graphDB.DeleteChannelEdges(
3✔
1542
                        false, false, scid.ToUint64(),
3✔
1543
                )
3✔
1544
                return ourPolicy, err
3✔
1545
        }
1546

1547
        // For the reservationTimeout and the zombieSweeperInterval different
1548
        // values are set in case we are in a dev environment so enhance test
1549
        // capacilities.
1550
        reservationTimeout := chanfunding.DefaultReservationTimeout
3✔
1551
        zombieSweeperInterval := lncfg.DefaultZombieSweeperInterval
3✔
1552

3✔
1553
        // Get the development config for funding manager. If we are not in
3✔
1554
        // development mode, this would be nil.
3✔
1555
        var devCfg *funding.DevConfig
3✔
1556
        if lncfg.IsDevBuild() {
6✔
1557
                devCfg = &funding.DevConfig{
3✔
1558
                        ProcessChannelReadyWait: cfg.Dev.ChannelReadyWait(),
3✔
1559
                        MaxWaitNumBlocksFundingConf: cfg.Dev.
3✔
1560
                                GetMaxWaitNumBlocksFundingConf(),
3✔
1561
                }
3✔
1562

3✔
1563
                reservationTimeout = cfg.Dev.GetReservationTimeout()
3✔
1564
                zombieSweeperInterval = cfg.Dev.GetZombieSweeperInterval()
3✔
1565

3✔
1566
                srvrLog.Debugf("Using the dev config for the fundingMgr: %v, "+
3✔
1567
                        "reservationTimeout=%v, zombieSweeperInterval=%v",
3✔
1568
                        devCfg, reservationTimeout, zombieSweeperInterval)
3✔
1569
        }
3✔
1570

1571
        //nolint:ll
1572
        s.fundingMgr, err = funding.NewFundingManager(funding.Config{
3✔
1573
                Dev:                devCfg,
3✔
1574
                NoWumboChans:       !cfg.ProtocolOptions.Wumbo(),
3✔
1575
                IDKey:              nodeKeyDesc.PubKey,
3✔
1576
                IDKeyLoc:           nodeKeyDesc.KeyLocator,
3✔
1577
                Wallet:             cc.Wallet,
3✔
1578
                PublishTransaction: cc.Wallet.PublishTransaction,
3✔
1579
                UpdateLabel: func(hash chainhash.Hash, label string) error {
6✔
1580
                        return cc.Wallet.LabelTransaction(hash, label, true)
3✔
1581
                },
3✔
1582
                Notifier:     cc.ChainNotifier,
1583
                ChannelDB:    s.chanStateDB,
1584
                FeeEstimator: cc.FeeEstimator,
1585
                SignMessage:  cc.MsgSigner.SignMessage,
1586
                CurrentNodeAnnouncement: func() (lnwire.NodeAnnouncement,
1587
                        error) {
3✔
1588

3✔
1589
                        return s.genNodeAnnouncement(nil)
3✔
1590
                },
3✔
1591
                SendAnnouncement:     s.authGossiper.ProcessLocalAnnouncement,
1592
                NotifyWhenOnline:     s.NotifyWhenOnline,
1593
                TempChanIDSeed:       chanIDSeed,
1594
                FindChannel:          s.findChannel,
1595
                DefaultRoutingPolicy: cc.RoutingPolicy,
1596
                DefaultMinHtlcIn:     cc.MinHtlcIn,
1597
                NumRequiredConfs: func(chanAmt btcutil.Amount,
1598
                        pushAmt lnwire.MilliSatoshi) uint16 {
3✔
1599
                        // For large channels we increase the number
3✔
1600
                        // of confirmations we require for the
3✔
1601
                        // channel to be considered open. As it is
3✔
1602
                        // always the responder that gets to choose
3✔
1603
                        // value, the pushAmt is value being pushed
3✔
1604
                        // to us. This means we have more to lose
3✔
1605
                        // in the case this gets re-orged out, and
3✔
1606
                        // we will require more confirmations before
3✔
1607
                        // we consider it open.
3✔
1608

3✔
1609
                        // In case the user has explicitly specified
3✔
1610
                        // a default value for the number of
3✔
1611
                        // confirmations, we use it.
3✔
1612
                        defaultConf := uint16(chainCfg.DefaultNumChanConfs)
3✔
1613
                        if defaultConf != 0 {
6✔
1614
                                return defaultConf
3✔
1615
                        }
3✔
1616

1617
                        minConf := uint64(3)
×
1618
                        maxConf := uint64(6)
×
1619

×
1620
                        // If this is a wumbo channel, then we'll require the
×
1621
                        // max amount of confirmations.
×
1622
                        if chanAmt > MaxFundingAmount {
×
1623
                                return uint16(maxConf)
×
1624
                        }
×
1625

1626
                        // If not we return a value scaled linearly
1627
                        // between 3 and 6, depending on channel size.
1628
                        // TODO(halseth): Use 1 as minimum?
1629
                        maxChannelSize := uint64(
×
1630
                                lnwire.NewMSatFromSatoshis(MaxFundingAmount))
×
1631
                        stake := lnwire.NewMSatFromSatoshis(chanAmt) + pushAmt
×
1632
                        conf := maxConf * uint64(stake) / maxChannelSize
×
1633
                        if conf < minConf {
×
1634
                                conf = minConf
×
1635
                        }
×
1636
                        if conf > maxConf {
×
1637
                                conf = maxConf
×
1638
                        }
×
1639
                        return uint16(conf)
×
1640
                },
1641
                RequiredRemoteDelay: func(chanAmt btcutil.Amount) uint16 {
3✔
1642
                        // We scale the remote CSV delay (the time the
3✔
1643
                        // remote have to claim funds in case of a unilateral
3✔
1644
                        // close) linearly from minRemoteDelay blocks
3✔
1645
                        // for small channels, to maxRemoteDelay blocks
3✔
1646
                        // for channels of size MaxFundingAmount.
3✔
1647

3✔
1648
                        // In case the user has explicitly specified
3✔
1649
                        // a default value for the remote delay, we
3✔
1650
                        // use it.
3✔
1651
                        defaultDelay := uint16(chainCfg.DefaultRemoteDelay)
3✔
1652
                        if defaultDelay > 0 {
6✔
1653
                                return defaultDelay
3✔
1654
                        }
3✔
1655

1656
                        // If this is a wumbo channel, then we'll require the
1657
                        // max value.
1658
                        if chanAmt > MaxFundingAmount {
×
1659
                                return maxRemoteDelay
×
1660
                        }
×
1661

1662
                        // If not we scale according to channel size.
1663
                        delay := uint16(btcutil.Amount(maxRemoteDelay) *
×
1664
                                chanAmt / MaxFundingAmount)
×
1665
                        if delay < minRemoteDelay {
×
1666
                                delay = minRemoteDelay
×
1667
                        }
×
1668
                        if delay > maxRemoteDelay {
×
1669
                                delay = maxRemoteDelay
×
1670
                        }
×
1671
                        return delay
×
1672
                },
1673
                WatchNewChannel: func(channel *channeldb.OpenChannel,
1674
                        peerKey *btcec.PublicKey) error {
3✔
1675

3✔
1676
                        // First, we'll mark this new peer as a persistent peer
3✔
1677
                        // for re-connection purposes. If the peer is not yet
3✔
1678
                        // tracked or the user hasn't requested it to be perm,
3✔
1679
                        // we'll set false to prevent the server from continuing
3✔
1680
                        // to connect to this peer even if the number of
3✔
1681
                        // channels with this peer is zero.
3✔
1682
                        s.mu.Lock()
3✔
1683
                        pubStr := string(peerKey.SerializeCompressed())
3✔
1684
                        if _, ok := s.persistentPeers[pubStr]; !ok {
6✔
1685
                                s.persistentPeers[pubStr] = false
3✔
1686
                        }
3✔
1687
                        s.mu.Unlock()
3✔
1688

3✔
1689
                        // With that taken care of, we'll send this channel to
3✔
1690
                        // the chain arb so it can react to on-chain events.
3✔
1691
                        return s.chainArb.WatchNewChannel(channel)
3✔
1692
                },
1693
                ReportShortChanID: func(chanPoint wire.OutPoint) error {
3✔
1694
                        cid := lnwire.NewChanIDFromOutPoint(chanPoint)
3✔
1695
                        return s.htlcSwitch.UpdateShortChanID(cid)
3✔
1696
                },
3✔
1697
                RequiredRemoteChanReserve: func(chanAmt,
1698
                        dustLimit btcutil.Amount) btcutil.Amount {
3✔
1699

3✔
1700
                        // By default, we'll require the remote peer to maintain
3✔
1701
                        // at least 1% of the total channel capacity at all
3✔
1702
                        // times. If this value ends up dipping below the dust
3✔
1703
                        // limit, then we'll use the dust limit itself as the
3✔
1704
                        // reserve as required by BOLT #2.
3✔
1705
                        reserve := chanAmt / 100
3✔
1706
                        if reserve < dustLimit {
6✔
1707
                                reserve = dustLimit
3✔
1708
                        }
3✔
1709

1710
                        return reserve
3✔
1711
                },
1712
                RequiredRemoteMaxValue: func(chanAmt btcutil.Amount) lnwire.MilliSatoshi {
3✔
1713
                        // By default, we'll allow the remote peer to fully
3✔
1714
                        // utilize the full bandwidth of the channel, minus our
3✔
1715
                        // required reserve.
3✔
1716
                        reserve := lnwire.NewMSatFromSatoshis(chanAmt / 100)
3✔
1717
                        return lnwire.NewMSatFromSatoshis(chanAmt) - reserve
3✔
1718
                },
3✔
1719
                RequiredRemoteMaxHTLCs: func(chanAmt btcutil.Amount) uint16 {
3✔
1720
                        if cfg.DefaultRemoteMaxHtlcs > 0 {
6✔
1721
                                return cfg.DefaultRemoteMaxHtlcs
3✔
1722
                        }
3✔
1723

1724
                        // By default, we'll permit them to utilize the full
1725
                        // channel bandwidth.
1726
                        return uint16(input.MaxHTLCNumber / 2)
×
1727
                },
1728
                ZombieSweeperInterval:         zombieSweeperInterval,
1729
                ReservationTimeout:            reservationTimeout,
1730
                MinChanSize:                   btcutil.Amount(cfg.MinChanSize),
1731
                MaxChanSize:                   btcutil.Amount(cfg.MaxChanSize),
1732
                MaxPendingChannels:            cfg.MaxPendingChannels,
1733
                RejectPush:                    cfg.RejectPush,
1734
                MaxLocalCSVDelay:              chainCfg.MaxLocalDelay,
1735
                NotifyOpenChannelEvent:        s.notifyOpenChannelPeerEvent,
1736
                OpenChannelPredicate:          chanPredicate,
1737
                NotifyPendingOpenChannelEvent: s.notifyPendingOpenChannelPeerEvent,
1738
                NotifyFundingTimeout:          s.notifyFundingTimeoutPeerEvent,
1739
                EnableUpfrontShutdown:         cfg.EnableUpfrontShutdown,
1740
                MaxAnchorsCommitFeeRate: chainfee.SatPerKVByte(
1741
                        s.cfg.MaxCommitFeeRateAnchors * 1000).FeePerKWeight(),
1742
                DeleteAliasEdge:      deleteAliasEdge,
1743
                AliasManager:         s.aliasMgr,
1744
                IsSweeperOutpoint:    s.sweeper.IsSweeperOutpoint,
1745
                AuxFundingController: implCfg.AuxFundingController,
1746
                AuxSigner:            implCfg.AuxSigner,
1747
                AuxResolver:          implCfg.AuxContractResolver,
1748
        })
1749
        if err != nil {
3✔
1750
                return nil, err
×
1751
        }
×
1752

1753
        // Next, we'll assemble the sub-system that will maintain an on-disk
1754
        // static backup of the latest channel state.
1755
        chanNotifier := &channelNotifier{
3✔
1756
                chanNotifier: s.channelNotifier,
3✔
1757
                addrs:        s.addrSource,
3✔
1758
        }
3✔
1759
        backupFile := chanbackup.NewMultiFile(
3✔
1760
                cfg.BackupFilePath, cfg.NoBackupArchive,
3✔
1761
        )
3✔
1762
        startingChans, err := chanbackup.FetchStaticChanBackups(
3✔
1763
                ctx, s.chanStateDB, s.addrSource,
3✔
1764
        )
3✔
1765
        if err != nil {
3✔
1766
                return nil, err
×
1767
        }
×
1768
        s.chanSubSwapper, err = chanbackup.NewSubSwapper(
3✔
1769
                ctx, startingChans, chanNotifier, s.cc.KeyRing, backupFile,
3✔
1770
        )
3✔
1771
        if err != nil {
3✔
1772
                return nil, err
×
1773
        }
×
1774

1775
        // Assemble a peer notifier which will provide clients with subscriptions
1776
        // to peer online and offline events.
1777
        s.peerNotifier = peernotifier.New()
3✔
1778

3✔
1779
        // Create a channel event store which monitors all open channels.
3✔
1780
        s.chanEventStore = chanfitness.NewChannelEventStore(&chanfitness.Config{
3✔
1781
                SubscribeChannelEvents: func() (subscribe.Subscription, error) {
6✔
1782
                        return s.channelNotifier.SubscribeChannelEvents()
3✔
1783
                },
3✔
1784
                SubscribePeerEvents: func() (subscribe.Subscription, error) {
3✔
1785
                        return s.peerNotifier.SubscribePeerEvents()
3✔
1786
                },
3✔
1787
                GetOpenChannels: s.chanStateDB.FetchAllOpenChannels,
1788
                Clock:           clock.NewDefaultClock(),
1789
                ReadFlapCount:   s.miscDB.ReadFlapCount,
1790
                WriteFlapCount:  s.miscDB.WriteFlapCounts,
1791
                FlapCountTicker: ticker.New(chanfitness.FlapCountFlushRate),
1792
        })
1793

1794
        if cfg.WtClient.Active {
6✔
1795
                policy := wtpolicy.DefaultPolicy()
3✔
1796
                policy.MaxUpdates = cfg.WtClient.MaxUpdates
3✔
1797

3✔
1798
                // We expose the sweep fee rate in sat/vbyte, but the tower
3✔
1799
                // protocol operations on sat/kw.
3✔
1800
                sweepRateSatPerVByte := chainfee.SatPerKVByte(
3✔
1801
                        1000 * cfg.WtClient.SweepFeeRate,
3✔
1802
                )
3✔
1803

3✔
1804
                policy.SweepFeeRate = sweepRateSatPerVByte.FeePerKWeight()
3✔
1805

3✔
1806
                if err := policy.Validate(); err != nil {
3✔
1807
                        return nil, err
×
1808
                }
×
1809

1810
                // authDial is the wrapper around the btrontide.Dial for the
1811
                // watchtower.
1812
                authDial := func(localKey keychain.SingleKeyECDH,
3✔
1813
                        netAddr *lnwire.NetAddress,
3✔
1814
                        dialer tor.DialFunc) (wtserver.Peer, error) {
6✔
1815

3✔
1816
                        return brontide.Dial(
3✔
1817
                                localKey, netAddr, cfg.ConnectionTimeout, dialer,
3✔
1818
                        )
3✔
1819
                }
3✔
1820

1821
                // buildBreachRetribution is a call-back that can be used to
1822
                // query the BreachRetribution info and channel type given a
1823
                // channel ID and commitment height.
1824
                buildBreachRetribution := func(chanID lnwire.ChannelID,
3✔
1825
                        commitHeight uint64) (*lnwallet.BreachRetribution,
3✔
1826
                        channeldb.ChannelType, error) {
6✔
1827

3✔
1828
                        channel, err := s.chanStateDB.FetchChannelByID(
3✔
1829
                                nil, chanID,
3✔
1830
                        )
3✔
1831
                        if err != nil {
3✔
1832
                                return nil, 0, err
×
1833
                        }
×
1834

1835
                        br, err := lnwallet.NewBreachRetribution(
3✔
1836
                                channel, commitHeight, 0, nil,
3✔
1837
                                implCfg.AuxLeafStore,
3✔
1838
                                implCfg.AuxContractResolver,
3✔
1839
                        )
3✔
1840
                        if err != nil {
3✔
1841
                                return nil, 0, err
×
1842
                        }
×
1843

1844
                        return br, channel.ChanType, nil
3✔
1845
                }
1846

1847
                fetchClosedChannel := s.chanStateDB.FetchClosedChannelForID
3✔
1848

3✔
1849
                // Copy the policy for legacy channels and set the blob flag
3✔
1850
                // signalling support for anchor channels.
3✔
1851
                anchorPolicy := policy
3✔
1852
                anchorPolicy.BlobType |= blob.Type(blob.FlagAnchorChannel)
3✔
1853

3✔
1854
                // Copy the policy for legacy channels and set the blob flag
3✔
1855
                // signalling support for taproot channels.
3✔
1856
                taprootPolicy := policy
3✔
1857
                taprootPolicy.TxPolicy.BlobType |= blob.Type(
3✔
1858
                        blob.FlagTaprootChannel,
3✔
1859
                )
3✔
1860

3✔
1861
                s.towerClientMgr, err = wtclient.NewManager(&wtclient.Config{
3✔
1862
                        FetchClosedChannel:     fetchClosedChannel,
3✔
1863
                        BuildBreachRetribution: buildBreachRetribution,
3✔
1864
                        SessionCloseRange:      cfg.WtClient.SessionCloseRange,
3✔
1865
                        ChainNotifier:          s.cc.ChainNotifier,
3✔
1866
                        SubscribeChannelEvents: func() (subscribe.Subscription,
3✔
1867
                                error) {
6✔
1868

3✔
1869
                                return s.channelNotifier.
3✔
1870
                                        SubscribeChannelEvents()
3✔
1871
                        },
3✔
1872
                        Signer: cc.Wallet.Cfg.Signer,
1873
                        NewAddress: func() ([]byte, error) {
3✔
1874
                                addr, err := newSweepPkScriptGen(
3✔
1875
                                        cc.Wallet, netParams,
3✔
1876
                                )().Unpack()
3✔
1877
                                if err != nil {
3✔
1878
                                        return nil, err
×
1879
                                }
×
1880

1881
                                return addr.DeliveryAddress, nil
3✔
1882
                        },
1883
                        SecretKeyRing:      s.cc.KeyRing,
1884
                        Dial:               cfg.net.Dial,
1885
                        AuthDial:           authDial,
1886
                        DB:                 dbs.TowerClientDB,
1887
                        ChainHash:          *s.cfg.ActiveNetParams.GenesisHash,
1888
                        MinBackoff:         10 * time.Second,
1889
                        MaxBackoff:         5 * time.Minute,
1890
                        MaxTasksInMemQueue: cfg.WtClient.MaxTasksInMemQueue,
1891
                }, policy, anchorPolicy, taprootPolicy)
1892
                if err != nil {
3✔
1893
                        return nil, err
×
1894
                }
×
1895
        }
1896

1897
        if len(cfg.ExternalHosts) != 0 {
3✔
1898
                advertisedIPs := make(map[string]struct{})
×
1899
                for _, addr := range s.currentNodeAnn.Addresses {
×
1900
                        advertisedIPs[addr.String()] = struct{}{}
×
1901
                }
×
1902

1903
                s.hostAnn = netann.NewHostAnnouncer(netann.HostAnnouncerConfig{
×
1904
                        Hosts:         cfg.ExternalHosts,
×
1905
                        RefreshTicker: ticker.New(defaultHostSampleInterval),
×
1906
                        LookupHost: func(host string) (net.Addr, error) {
×
1907
                                return lncfg.ParseAddressString(
×
1908
                                        host, strconv.Itoa(defaultPeerPort),
×
1909
                                        cfg.net.ResolveTCPAddr,
×
1910
                                )
×
1911
                        },
×
1912
                        AdvertisedIPs: advertisedIPs,
1913
                        AnnounceNewIPs: netann.IPAnnouncer(
1914
                                func(modifier ...netann.NodeAnnModifier) (
1915
                                        lnwire.NodeAnnouncement, error) {
×
1916

×
1917
                                        return s.genNodeAnnouncement(
×
1918
                                                nil, modifier...,
×
1919
                                        )
×
1920
                                }),
×
1921
                })
1922
        }
1923

1924
        // Create liveness monitor.
1925
        s.createLivenessMonitor(cfg, cc, leaderElector)
3✔
1926

3✔
1927
        listeners := make([]net.Listener, len(listenAddrs))
3✔
1928
        for i, listenAddr := range listenAddrs {
6✔
1929
                // Note: though brontide.NewListener uses ResolveTCPAddr, it
3✔
1930
                // doesn't need to call the general lndResolveTCP function
3✔
1931
                // since we are resolving a local address.
3✔
1932

3✔
1933
                // RESOLVE: We are actually partially accepting inbound
3✔
1934
                // connection requests when we call NewListener.
3✔
1935
                listeners[i], err = brontide.NewListener(
3✔
1936
                        nodeKeyECDH, listenAddr.String(),
3✔
1937
                        // TODO(yy): remove this check and unify the inbound
3✔
1938
                        // connection check inside `InboundPeerConnected`.
3✔
1939
                        s.peerAccessMan.checkAcceptIncomingConn,
3✔
1940
                )
3✔
1941
                if err != nil {
3✔
1942
                        return nil, err
×
1943
                }
×
1944
        }
1945

1946
        // Create the connection manager which will be responsible for
1947
        // maintaining persistent outbound connections and also accepting new
1948
        // incoming connections
1949
        cmgr, err := connmgr.New(&connmgr.Config{
3✔
1950
                Listeners:      listeners,
3✔
1951
                OnAccept:       s.InboundPeerConnected,
3✔
1952
                RetryDuration:  time.Second * 5,
3✔
1953
                TargetOutbound: 100,
3✔
1954
                Dial: noiseDial(
3✔
1955
                        nodeKeyECDH, s.cfg.net, s.cfg.ConnectionTimeout,
3✔
1956
                ),
3✔
1957
                OnConnection: s.OutboundPeerConnected,
3✔
1958
        })
3✔
1959
        if err != nil {
3✔
1960
                return nil, err
×
1961
        }
×
1962
        s.connMgr = cmgr
3✔
1963

3✔
1964
        // Finally, register the subsystems in blockbeat.
3✔
1965
        s.registerBlockConsumers()
3✔
1966

3✔
1967
        return s, nil
3✔
1968
}
1969

1970
// UpdateRoutingConfig is a callback function to update the routing config
1971
// values in the main cfg.
1972
func (s *server) UpdateRoutingConfig(cfg *routing.MissionControlConfig) {
3✔
1973
        routerCfg := s.cfg.SubRPCServers.RouterRPC
3✔
1974

3✔
1975
        switch c := cfg.Estimator.Config().(type) {
3✔
1976
        case routing.AprioriConfig:
3✔
1977
                routerCfg.ProbabilityEstimatorType =
3✔
1978
                        routing.AprioriEstimatorName
3✔
1979

3✔
1980
                targetCfg := routerCfg.AprioriConfig
3✔
1981
                targetCfg.PenaltyHalfLife = c.PenaltyHalfLife
3✔
1982
                targetCfg.Weight = c.AprioriWeight
3✔
1983
                targetCfg.CapacityFraction = c.CapacityFraction
3✔
1984
                targetCfg.HopProbability = c.AprioriHopProbability
3✔
1985

1986
        case routing.BimodalConfig:
3✔
1987
                routerCfg.ProbabilityEstimatorType =
3✔
1988
                        routing.BimodalEstimatorName
3✔
1989

3✔
1990
                targetCfg := routerCfg.BimodalConfig
3✔
1991
                targetCfg.Scale = int64(c.BimodalScaleMsat)
3✔
1992
                targetCfg.NodeWeight = c.BimodalNodeWeight
3✔
1993
                targetCfg.DecayTime = c.BimodalDecayTime
3✔
1994
        }
1995

1996
        routerCfg.MaxMcHistory = cfg.MaxMcHistory
3✔
1997
}
1998

1999
// registerBlockConsumers registers the subsystems that consume block events.
2000
// By calling `RegisterQueue`, a list of subsystems are registered in the
2001
// blockbeat for block notifications. When a new block arrives, the subsystems
2002
// in the same queue are notified sequentially, and different queues are
2003
// notified concurrently.
2004
//
2005
// NOTE: To put a subsystem in a different queue, create a slice and pass it to
2006
// a new `RegisterQueue` call.
2007
func (s *server) registerBlockConsumers() {
3✔
2008
        // In this queue, when a new block arrives, it will be received and
3✔
2009
        // processed in this order: chainArb -> sweeper -> txPublisher.
3✔
2010
        consumers := []chainio.Consumer{
3✔
2011
                s.chainArb,
3✔
2012
                s.sweeper,
3✔
2013
                s.txPublisher,
3✔
2014
        }
3✔
2015
        s.blockbeatDispatcher.RegisterQueue(consumers)
3✔
2016
}
3✔
2017

2018
// signAliasUpdate takes a ChannelUpdate and returns the signature. This is
2019
// used for option_scid_alias channels where the ChannelUpdate to be sent back
2020
// may differ from what is on disk.
2021
func (s *server) signAliasUpdate(u *lnwire.ChannelUpdate1) (*ecdsa.Signature,
2022
        error) {
3✔
2023

3✔
2024
        data, err := u.DataToSign()
3✔
2025
        if err != nil {
3✔
2026
                return nil, err
×
2027
        }
×
2028

2029
        return s.cc.MsgSigner.SignMessage(s.identityKeyLoc, data, true)
3✔
2030
}
2031

2032
// createLivenessMonitor creates a set of health checks using our configured
2033
// values and uses these checks to create a liveness monitor. Available
2034
// health checks,
2035
//   - chainHealthCheck (will be disabled for --nochainbackend mode)
2036
//   - diskCheck
2037
//   - tlsHealthCheck
2038
//   - torController, only created when tor is enabled.
2039
//
2040
// If a health check has been disabled by setting attempts to 0, our monitor
2041
// will not run it.
2042
func (s *server) createLivenessMonitor(cfg *Config, cc *chainreg.ChainControl,
2043
        leaderElector cluster.LeaderElector) {
3✔
2044

3✔
2045
        chainBackendAttempts := cfg.HealthChecks.ChainCheck.Attempts
3✔
2046
        if cfg.Bitcoin.Node == "nochainbackend" {
3✔
2047
                srvrLog.Info("Disabling chain backend checks for " +
×
2048
                        "nochainbackend mode")
×
2049

×
2050
                chainBackendAttempts = 0
×
2051
        }
×
2052

2053
        chainHealthCheck := healthcheck.NewObservation(
3✔
2054
                "chain backend",
3✔
2055
                cc.HealthCheck,
3✔
2056
                cfg.HealthChecks.ChainCheck.Interval,
3✔
2057
                cfg.HealthChecks.ChainCheck.Timeout,
3✔
2058
                cfg.HealthChecks.ChainCheck.Backoff,
3✔
2059
                chainBackendAttempts,
3✔
2060
        )
3✔
2061

3✔
2062
        diskCheck := healthcheck.NewObservation(
3✔
2063
                "disk space",
3✔
2064
                func() error {
3✔
2065
                        free, err := healthcheck.AvailableDiskSpaceRatio(
×
2066
                                cfg.LndDir,
×
2067
                        )
×
2068
                        if err != nil {
×
2069
                                return err
×
2070
                        }
×
2071

2072
                        // If we have more free space than we require,
2073
                        // we return a nil error.
2074
                        if free > cfg.HealthChecks.DiskCheck.RequiredRemaining {
×
2075
                                return nil
×
2076
                        }
×
2077

2078
                        return fmt.Errorf("require: %v free space, got: %v",
×
2079
                                cfg.HealthChecks.DiskCheck.RequiredRemaining,
×
2080
                                free)
×
2081
                },
2082
                cfg.HealthChecks.DiskCheck.Interval,
2083
                cfg.HealthChecks.DiskCheck.Timeout,
2084
                cfg.HealthChecks.DiskCheck.Backoff,
2085
                cfg.HealthChecks.DiskCheck.Attempts,
2086
        )
2087

2088
        tlsHealthCheck := healthcheck.NewObservation(
3✔
2089
                "tls",
3✔
2090
                func() error {
3✔
2091
                        expired, expTime, err := s.tlsManager.IsCertExpired(
×
2092
                                s.cc.KeyRing,
×
2093
                        )
×
2094
                        if err != nil {
×
2095
                                return err
×
2096
                        }
×
2097
                        if expired {
×
2098
                                return fmt.Errorf("TLS certificate is "+
×
2099
                                        "expired as of %v", expTime)
×
2100
                        }
×
2101

2102
                        // If the certificate is not outdated, no error needs
2103
                        // to be returned
2104
                        return nil
×
2105
                },
2106
                cfg.HealthChecks.TLSCheck.Interval,
2107
                cfg.HealthChecks.TLSCheck.Timeout,
2108
                cfg.HealthChecks.TLSCheck.Backoff,
2109
                cfg.HealthChecks.TLSCheck.Attempts,
2110
        )
2111

2112
        checks := []*healthcheck.Observation{
3✔
2113
                chainHealthCheck, diskCheck, tlsHealthCheck,
3✔
2114
        }
3✔
2115

3✔
2116
        // If Tor is enabled, add the healthcheck for tor connection.
3✔
2117
        if s.torController != nil {
3✔
2118
                torConnectionCheck := healthcheck.NewObservation(
×
2119
                        "tor connection",
×
2120
                        func() error {
×
2121
                                return healthcheck.CheckTorServiceStatus(
×
2122
                                        s.torController,
×
2123
                                        func() error {
×
2124
                                                return s.createNewHiddenService(
×
2125
                                                        context.TODO(),
×
2126
                                                )
×
2127
                                        },
×
2128
                                )
2129
                        },
2130
                        cfg.HealthChecks.TorConnection.Interval,
2131
                        cfg.HealthChecks.TorConnection.Timeout,
2132
                        cfg.HealthChecks.TorConnection.Backoff,
2133
                        cfg.HealthChecks.TorConnection.Attempts,
2134
                )
2135
                checks = append(checks, torConnectionCheck)
×
2136
        }
2137

2138
        // If remote signing is enabled, add the healthcheck for the remote
2139
        // signing RPC interface.
2140
        if s.cfg.RemoteSigner != nil && s.cfg.RemoteSigner.Enable {
6✔
2141
                // Because we have two cascading timeouts here, we need to add
3✔
2142
                // some slack to the "outer" one of them in case the "inner"
3✔
2143
                // returns exactly on time.
3✔
2144
                overhead := time.Millisecond * 10
3✔
2145

3✔
2146
                remoteSignerConnectionCheck := healthcheck.NewObservation(
3✔
2147
                        "remote signer connection",
3✔
2148
                        rpcwallet.HealthCheck(
3✔
2149
                                s.cfg.RemoteSigner,
3✔
2150

3✔
2151
                                // For the health check we might to be even
3✔
2152
                                // stricter than the initial/normal connect, so
3✔
2153
                                // we use the health check timeout here.
3✔
2154
                                cfg.HealthChecks.RemoteSigner.Timeout,
3✔
2155
                        ),
3✔
2156
                        cfg.HealthChecks.RemoteSigner.Interval,
3✔
2157
                        cfg.HealthChecks.RemoteSigner.Timeout+overhead,
3✔
2158
                        cfg.HealthChecks.RemoteSigner.Backoff,
3✔
2159
                        cfg.HealthChecks.RemoteSigner.Attempts,
3✔
2160
                )
3✔
2161
                checks = append(checks, remoteSignerConnectionCheck)
3✔
2162
        }
3✔
2163

2164
        // If we have a leader elector, we add a health check to ensure we are
2165
        // still the leader. During normal operation, we should always be the
2166
        // leader, but there are circumstances where this may change, such as
2167
        // when we lose network connectivity for long enough expiring out lease.
2168
        if leaderElector != nil {
3✔
2169
                leaderCheck := healthcheck.NewObservation(
×
2170
                        "leader status",
×
2171
                        func() error {
×
2172
                                // Check if we are still the leader. Note that
×
2173
                                // we don't need to use a timeout context here
×
2174
                                // as the healthcheck observer will handle the
×
2175
                                // timeout case for us.
×
2176
                                timeoutCtx, cancel := context.WithTimeout(
×
2177
                                        context.Background(),
×
2178
                                        cfg.HealthChecks.LeaderCheck.Timeout,
×
2179
                                )
×
2180
                                defer cancel()
×
2181

×
2182
                                leader, err := leaderElector.IsLeader(
×
2183
                                        timeoutCtx,
×
2184
                                )
×
2185
                                if err != nil {
×
2186
                                        return fmt.Errorf("unable to check if "+
×
2187
                                                "still leader: %v", err)
×
2188
                                }
×
2189

2190
                                if !leader {
×
2191
                                        srvrLog.Debug("Not the current leader")
×
2192
                                        return fmt.Errorf("not the current " +
×
2193
                                                "leader")
×
2194
                                }
×
2195

2196
                                return nil
×
2197
                        },
2198
                        cfg.HealthChecks.LeaderCheck.Interval,
2199
                        cfg.HealthChecks.LeaderCheck.Timeout,
2200
                        cfg.HealthChecks.LeaderCheck.Backoff,
2201
                        cfg.HealthChecks.LeaderCheck.Attempts,
2202
                )
2203

2204
                checks = append(checks, leaderCheck)
×
2205
        }
2206

2207
        // If we have not disabled all of our health checks, we create a
2208
        // liveness monitor with our configured checks.
2209
        s.livenessMonitor = healthcheck.NewMonitor(
3✔
2210
                &healthcheck.Config{
3✔
2211
                        Checks:   checks,
3✔
2212
                        Shutdown: srvrLog.Criticalf,
3✔
2213
                },
3✔
2214
        )
3✔
2215
}
2216

2217
// Started returns true if the server has been started, and false otherwise.
2218
// NOTE: This function is safe for concurrent access.
2219
func (s *server) Started() bool {
3✔
2220
        return atomic.LoadInt32(&s.active) != 0
3✔
2221
}
3✔
2222

2223
// cleaner is used to aggregate "cleanup" functions during an operation that
2224
// starts several subsystems. In case one of the subsystem fails to start
2225
// and a proper resource cleanup is required, the "run" method achieves this
2226
// by running all these added "cleanup" functions.
2227
type cleaner []func() error
2228

2229
// add is used to add a cleanup function to be called when
2230
// the run function is executed.
2231
func (c cleaner) add(cleanup func() error) cleaner {
3✔
2232
        return append(c, cleanup)
3✔
2233
}
3✔
2234

2235
// run is used to run all the previousely added cleanup functions.
2236
func (c cleaner) run() {
×
2237
        for i := len(c) - 1; i >= 0; i-- {
×
2238
                if err := c[i](); err != nil {
×
2239
                        srvrLog.Errorf("Cleanup failed: %v", err)
×
2240
                }
×
2241
        }
2242
}
2243

2244
// startLowLevelServices starts the low-level services of the server. These
2245
// services must be started successfully before running the main server. The
2246
// services are,
2247
// 1. the chain notifier.
2248
//
2249
// TODO(yy): identify and add more low-level services here.
2250
func (s *server) startLowLevelServices() error {
3✔
2251
        var startErr error
3✔
2252

3✔
2253
        cleanup := cleaner{}
3✔
2254

3✔
2255
        cleanup = cleanup.add(s.cc.ChainNotifier.Stop)
3✔
2256
        if err := s.cc.ChainNotifier.Start(); err != nil {
3✔
2257
                startErr = err
×
2258
        }
×
2259

2260
        if startErr != nil {
3✔
2261
                cleanup.run()
×
2262
        }
×
2263

2264
        return startErr
3✔
2265
}
2266

2267
// Start starts the main daemon server, all requested listeners, and any helper
2268
// goroutines.
2269
// NOTE: This function is safe for concurrent access.
2270
//
2271
//nolint:funlen
2272
func (s *server) Start(ctx context.Context) error {
3✔
2273
        // Get the current blockbeat.
3✔
2274
        beat, err := s.getStartingBeat()
3✔
2275
        if err != nil {
3✔
2276
                return err
×
2277
        }
×
2278

2279
        var startErr error
3✔
2280

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

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

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

2301
                if s.livenessMonitor != nil {
6✔
2302
                        cleanup = cleanup.add(s.livenessMonitor.Stop)
3✔
2303
                        if err := s.livenessMonitor.Start(); err != nil {
3✔
2304
                                startErr = err
×
2305
                                return
×
2306
                        }
×
2307
                }
2308

2309
                // Start the notification server. This is used so channel
2310
                // management goroutines can be notified when a funding
2311
                // transaction reaches a sufficient number of confirmations, or
2312
                // when the input for the funding transaction is spent in an
2313
                // attempt at an uncooperative close by the counterparty.
2314
                cleanup = cleanup.add(s.sigPool.Stop)
3✔
2315
                if err := s.sigPool.Start(); err != nil {
3✔
2316
                        startErr = err
×
2317
                        return
×
2318
                }
×
2319

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

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

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

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

2344
                cleanup = cleanup.add(func() error {
3✔
2345
                        return s.peerNotifier.Stop()
×
2346
                })
×
2347
                if err := s.peerNotifier.Start(); err != nil {
3✔
2348
                        startErr = err
×
2349
                        return
×
2350
                }
×
2351

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

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

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

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

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

2384
                cleanup = cleanup.add(s.breachArbitrator.Stop)
3✔
2385
                if err := s.breachArbitrator.Start(); err != nil {
3✔
2386
                        startErr = err
×
2387
                        return
×
2388
                }
×
2389

2390
                cleanup = cleanup.add(s.fundingMgr.Stop)
3✔
2391
                if err := s.fundingMgr.Start(); err != nil {
3✔
2392
                        startErr = err
×
2393
                        return
×
2394
                }
×
2395

2396
                // htlcSwitch must be started before chainArb since the latter
2397
                // relies on htlcSwitch to deliver resolution message upon
2398
                // start.
2399
                cleanup = cleanup.add(s.htlcSwitch.Stop)
3✔
2400
                if err := s.htlcSwitch.Start(); err != nil {
3✔
2401
                        startErr = err
×
2402
                        return
×
2403
                }
×
2404

2405
                cleanup = cleanup.add(s.interceptableSwitch.Stop)
3✔
2406
                if err := s.interceptableSwitch.Start(); err != nil {
3✔
2407
                        startErr = err
×
2408
                        return
×
2409
                }
×
2410

2411
                cleanup = cleanup.add(s.invoiceHtlcModifier.Stop)
3✔
2412
                if err := s.invoiceHtlcModifier.Start(); err != nil {
3✔
2413
                        startErr = err
×
2414
                        return
×
2415
                }
×
2416

2417
                cleanup = cleanup.add(s.chainArb.Stop)
3✔
2418
                if err := s.chainArb.Start(beat); err != nil {
3✔
2419
                        startErr = err
×
2420
                        return
×
2421
                }
×
2422

2423
                cleanup = cleanup.add(s.graphDB.Stop)
3✔
2424
                if err := s.graphDB.Start(); err != nil {
3✔
2425
                        startErr = err
×
2426
                        return
×
2427
                }
×
2428

2429
                cleanup = cleanup.add(s.graphBuilder.Stop)
3✔
2430
                if err := s.graphBuilder.Start(); err != nil {
3✔
2431
                        startErr = err
×
2432
                        return
×
2433
                }
×
2434

2435
                cleanup = cleanup.add(s.chanRouter.Stop)
3✔
2436
                if err := s.chanRouter.Start(); err != nil {
3✔
2437
                        startErr = err
×
2438
                        return
×
2439
                }
×
2440
                // The authGossiper depends on the chanRouter and therefore
2441
                // should be started after it.
2442
                cleanup = cleanup.add(s.authGossiper.Stop)
3✔
2443
                if err := s.authGossiper.Start(); err != nil {
3✔
2444
                        startErr = err
×
2445
                        return
×
2446
                }
×
2447

2448
                cleanup = cleanup.add(s.invoices.Stop)
3✔
2449
                if err := s.invoices.Start(); err != nil {
3✔
2450
                        startErr = err
×
2451
                        return
×
2452
                }
×
2453

2454
                cleanup = cleanup.add(s.sphinx.Stop)
3✔
2455
                if err := s.sphinx.Start(); err != nil {
3✔
2456
                        startErr = err
×
2457
                        return
×
2458
                }
×
2459

2460
                cleanup = cleanup.add(s.chanStatusMgr.Stop)
3✔
2461
                if err := s.chanStatusMgr.Start(); err != nil {
3✔
2462
                        startErr = err
×
2463
                        return
×
2464
                }
×
2465

2466
                cleanup = cleanup.add(s.chanEventStore.Stop)
3✔
2467
                if err := s.chanEventStore.Start(); err != nil {
3✔
2468
                        startErr = err
×
2469
                        return
×
2470
                }
×
2471

2472
                cleanup.add(func() error {
3✔
2473
                        s.missionController.StopStoreTickers()
×
2474
                        return nil
×
2475
                })
×
2476
                s.missionController.RunStoreTickers()
3✔
2477

3✔
2478
                // Before we start the connMgr, we'll check to see if we have
3✔
2479
                // any backups to recover. We do this now as we want to ensure
3✔
2480
                // that have all the information we need to handle channel
3✔
2481
                // recovery _before_ we even accept connections from any peers.
3✔
2482
                chanRestorer := &chanDBRestorer{
3✔
2483
                        db:         s.chanStateDB,
3✔
2484
                        secretKeys: s.cc.KeyRing,
3✔
2485
                        chainArb:   s.chainArb,
3✔
2486
                }
3✔
2487
                if len(s.chansToRestore.PackedSingleChanBackups) != 0 {
3✔
2488
                        _, err := chanbackup.UnpackAndRecoverSingles(
×
2489
                                s.chansToRestore.PackedSingleChanBackups,
×
2490
                                s.cc.KeyRing, chanRestorer, s,
×
2491
                        )
×
2492
                        if err != nil {
×
2493
                                startErr = fmt.Errorf("unable to unpack single "+
×
2494
                                        "backups: %v", err)
×
2495
                                return
×
2496
                        }
×
2497
                }
2498
                if len(s.chansToRestore.PackedMultiChanBackup) != 0 {
6✔
2499
                        _, err := chanbackup.UnpackAndRecoverMulti(
3✔
2500
                                s.chansToRestore.PackedMultiChanBackup,
3✔
2501
                                s.cc.KeyRing, chanRestorer, s,
3✔
2502
                        )
3✔
2503
                        if err != nil {
3✔
2504
                                startErr = fmt.Errorf("unable to unpack chan "+
×
2505
                                        "backup: %v", err)
×
2506
                                return
×
2507
                        }
×
2508
                }
2509

2510
                // chanSubSwapper must be started after the `channelNotifier`
2511
                // because it depends on channel events as a synchronization
2512
                // point.
2513
                cleanup = cleanup.add(s.chanSubSwapper.Stop)
3✔
2514
                if err := s.chanSubSwapper.Start(); err != nil {
3✔
2515
                        startErr = err
×
2516
                        return
×
2517
                }
×
2518

2519
                if s.torController != nil {
3✔
2520
                        cleanup = cleanup.add(s.torController.Stop)
×
2521
                        if err := s.createNewHiddenService(ctx); err != nil {
×
2522
                                startErr = err
×
2523
                                return
×
2524
                        }
×
2525
                }
2526

2527
                if s.natTraversal != nil {
3✔
2528
                        s.wg.Add(1)
×
2529
                        go s.watchExternalIP()
×
2530
                }
×
2531

2532
                // Start connmgr last to prevent connections before init.
2533
                cleanup = cleanup.add(func() error {
3✔
2534
                        s.connMgr.Stop()
×
2535
                        return nil
×
2536
                })
×
2537

2538
                // RESOLVE: s.connMgr.Start() is called here, but
2539
                // brontide.NewListener() is called in newServer. This means
2540
                // that we are actually listening and partially accepting
2541
                // inbound connections even before the connMgr starts.
2542
                //
2543
                // TODO(yy): move the log into the connMgr's `Start` method.
2544
                srvrLog.Info("connMgr starting...")
3✔
2545
                s.connMgr.Start()
3✔
2546
                srvrLog.Debug("connMgr started")
3✔
2547

3✔
2548
                // If peers are specified as a config option, we'll add those
3✔
2549
                // peers first.
3✔
2550
                for _, peerAddrCfg := range s.cfg.AddPeers {
6✔
2551
                        parsedPubkey, parsedHost, err := lncfg.ParseLNAddressPubkey(
3✔
2552
                                peerAddrCfg,
3✔
2553
                        )
3✔
2554
                        if err != nil {
3✔
2555
                                startErr = fmt.Errorf("unable to parse peer "+
×
2556
                                        "pubkey from config: %v", err)
×
2557
                                return
×
2558
                        }
×
2559
                        addr, err := parseAddr(parsedHost, s.cfg.net)
3✔
2560
                        if err != nil {
3✔
2561
                                startErr = fmt.Errorf("unable to parse peer "+
×
2562
                                        "address provided as a config option: "+
×
2563
                                        "%v", err)
×
2564
                                return
×
2565
                        }
×
2566

2567
                        peerAddr := &lnwire.NetAddress{
3✔
2568
                                IdentityKey: parsedPubkey,
3✔
2569
                                Address:     addr,
3✔
2570
                                ChainNet:    s.cfg.ActiveNetParams.Net,
3✔
2571
                        }
3✔
2572

3✔
2573
                        err = s.ConnectToPeer(
3✔
2574
                                peerAddr, true,
3✔
2575
                                s.cfg.ConnectionTimeout,
3✔
2576
                        )
3✔
2577
                        if err != nil {
3✔
2578
                                startErr = fmt.Errorf("unable to connect to "+
×
2579
                                        "peer address provided as a config "+
×
2580
                                        "option: %v", err)
×
2581
                                return
×
2582
                        }
×
2583
                }
2584

2585
                // Subscribe to NodeAnnouncements that advertise new addresses
2586
                // our persistent peers.
2587
                if err := s.updatePersistentPeerAddrs(); err != nil {
3✔
2588
                        srvrLog.Errorf("Failed to update persistent peer "+
×
2589
                                "addr: %v", err)
×
2590

×
2591
                        startErr = err
×
2592
                        return
×
2593
                }
×
2594

2595
                // With all the relevant sub-systems started, we'll now attempt
2596
                // to establish persistent connections to our direct channel
2597
                // collaborators within the network. Before doing so however,
2598
                // we'll prune our set of link nodes found within the database
2599
                // to ensure we don't reconnect to any nodes we no longer have
2600
                // open channels with.
2601
                if err := s.chanStateDB.PruneLinkNodes(); err != nil {
3✔
2602
                        srvrLog.Errorf("Failed to prune link nodes: %v", err)
×
2603

×
2604
                        startErr = err
×
2605
                        return
×
2606
                }
×
2607

2608
                if err := s.establishPersistentConnections(); err != nil {
3✔
2609
                        srvrLog.Errorf("Failed to establish persistent "+
×
2610
                                "connections: %v", err)
×
2611
                }
×
2612

2613
                // setSeedList is a helper function that turns multiple DNS seed
2614
                // server tuples from the command line or config file into the
2615
                // data structure we need and does a basic formal sanity check
2616
                // in the process.
2617
                setSeedList := func(tuples []string, genesisHash chainhash.Hash) {
3✔
2618
                        if len(tuples) == 0 {
×
2619
                                return
×
2620
                        }
×
2621

2622
                        result := make([][2]string, len(tuples))
×
2623
                        for idx, tuple := range tuples {
×
2624
                                tuple = strings.TrimSpace(tuple)
×
2625
                                if len(tuple) == 0 {
×
2626
                                        return
×
2627
                                }
×
2628

2629
                                servers := strings.Split(tuple, ",")
×
2630
                                if len(servers) > 2 || len(servers) == 0 {
×
2631
                                        srvrLog.Warnf("Ignoring invalid DNS "+
×
2632
                                                "seed tuple: %v", servers)
×
2633
                                        return
×
2634
                                }
×
2635

2636
                                copy(result[idx][:], servers)
×
2637
                        }
2638

2639
                        chainreg.ChainDNSSeeds[genesisHash] = result
×
2640
                }
2641

2642
                // Let users overwrite the DNS seed nodes. We only allow them
2643
                // for bitcoin mainnet/testnet/signet.
2644
                if s.cfg.Bitcoin.MainNet {
3✔
2645
                        setSeedList(
×
2646
                                s.cfg.Bitcoin.DNSSeeds,
×
2647
                                chainreg.BitcoinMainnetGenesis,
×
2648
                        )
×
2649
                }
×
2650
                if s.cfg.Bitcoin.TestNet3 {
3✔
2651
                        setSeedList(
×
2652
                                s.cfg.Bitcoin.DNSSeeds,
×
2653
                                chainreg.BitcoinTestnetGenesis,
×
2654
                        )
×
2655
                }
×
2656
                if s.cfg.Bitcoin.TestNet4 {
3✔
2657
                        setSeedList(
×
2658
                                s.cfg.Bitcoin.DNSSeeds,
×
2659
                                chainreg.BitcoinTestnet4Genesis,
×
2660
                        )
×
2661
                }
×
2662
                if s.cfg.Bitcoin.SigNet {
3✔
2663
                        setSeedList(
×
2664
                                s.cfg.Bitcoin.DNSSeeds,
×
2665
                                chainreg.BitcoinSignetGenesis,
×
2666
                        )
×
2667
                }
×
2668

2669
                // If network bootstrapping hasn't been disabled, then we'll
2670
                // configure the set of active bootstrappers, and launch a
2671
                // dedicated goroutine to maintain a set of persistent
2672
                // connections.
2673
                if !s.cfg.NoNetBootstrap {
6✔
2674
                        bootstrappers, err := initNetworkBootstrappers(s)
3✔
2675
                        if err != nil {
3✔
2676
                                startErr = err
×
2677
                                return
×
2678
                        }
×
2679

2680
                        s.wg.Add(1)
3✔
2681
                        go s.peerBootstrapper(
3✔
2682
                                ctx, defaultMinPeers, bootstrappers,
3✔
2683
                        )
3✔
2684
                } else {
3✔
2685
                        srvrLog.Infof("Auto peer bootstrapping is disabled")
3✔
2686
                }
3✔
2687

2688
                // Start the blockbeat after all other subsystems have been
2689
                // started so they are ready to receive new blocks.
2690
                cleanup = cleanup.add(func() error {
3✔
2691
                        s.blockbeatDispatcher.Stop()
×
2692
                        return nil
×
2693
                })
×
2694
                if err := s.blockbeatDispatcher.Start(); err != nil {
3✔
2695
                        startErr = err
×
2696
                        return
×
2697
                }
×
2698

2699
                // Set the active flag now that we've completed the full
2700
                // startup.
2701
                atomic.StoreInt32(&s.active, 1)
3✔
2702
        })
2703

2704
        if startErr != nil {
3✔
2705
                cleanup.run()
×
2706
        }
×
2707
        return startErr
3✔
2708
}
2709

2710
// Stop gracefully shutsdown the main daemon server. This function will signal
2711
// any active goroutines, or helper objects to exit, then blocks until they've
2712
// all successfully exited. Additionally, any/all listeners are closed.
2713
// NOTE: This function is safe for concurrent access.
2714
func (s *server) Stop() error {
3✔
2715
        s.stop.Do(func() {
6✔
2716
                atomic.StoreInt32(&s.stopping, 1)
3✔
2717

3✔
2718
                ctx := context.Background()
3✔
2719

3✔
2720
                close(s.quit)
3✔
2721

3✔
2722
                // Shutdown connMgr first to prevent conns during shutdown.
3✔
2723
                s.connMgr.Stop()
3✔
2724

3✔
2725
                // Stop dispatching blocks to other systems immediately.
3✔
2726
                s.blockbeatDispatcher.Stop()
3✔
2727

3✔
2728
                // Shutdown the wallet, funding manager, and the rpc server.
3✔
2729
                if err := s.chanStatusMgr.Stop(); err != nil {
3✔
2730
                        srvrLog.Warnf("failed to stop chanStatusMgr: %v", err)
×
2731
                }
×
2732
                if err := s.htlcSwitch.Stop(); err != nil {
3✔
2733
                        srvrLog.Warnf("failed to stop htlcSwitch: %v", err)
×
2734
                }
×
2735
                if err := s.sphinx.Stop(); err != nil {
3✔
2736
                        srvrLog.Warnf("failed to stop sphinx: %v", err)
×
2737
                }
×
2738
                if err := s.invoices.Stop(); err != nil {
3✔
2739
                        srvrLog.Warnf("failed to stop invoices: %v", err)
×
2740
                }
×
2741
                if err := s.interceptableSwitch.Stop(); err != nil {
3✔
2742
                        srvrLog.Warnf("failed to stop interceptable "+
×
2743
                                "switch: %v", err)
×
2744
                }
×
2745
                if err := s.invoiceHtlcModifier.Stop(); err != nil {
3✔
2746
                        srvrLog.Warnf("failed to stop htlc invoices "+
×
2747
                                "modifier: %v", err)
×
2748
                }
×
2749
                if err := s.chanRouter.Stop(); err != nil {
3✔
2750
                        srvrLog.Warnf("failed to stop chanRouter: %v", err)
×
2751
                }
×
2752
                if err := s.graphBuilder.Stop(); err != nil {
3✔
2753
                        srvrLog.Warnf("failed to stop graphBuilder %v", err)
×
2754
                }
×
2755
                if err := s.graphDB.Stop(); err != nil {
3✔
2756
                        srvrLog.Warnf("failed to stop graphDB %v", err)
×
2757
                }
×
2758
                if err := s.chainArb.Stop(); err != nil {
3✔
2759
                        srvrLog.Warnf("failed to stop chainArb: %v", err)
×
2760
                }
×
2761
                if err := s.fundingMgr.Stop(); err != nil {
3✔
2762
                        srvrLog.Warnf("failed to stop fundingMgr: %v", err)
×
2763
                }
×
2764
                if err := s.breachArbitrator.Stop(); err != nil {
3✔
2765
                        srvrLog.Warnf("failed to stop breachArbitrator: %v",
×
2766
                                err)
×
2767
                }
×
2768
                if err := s.utxoNursery.Stop(); err != nil {
3✔
2769
                        srvrLog.Warnf("failed to stop utxoNursery: %v", err)
×
2770
                }
×
2771
                if err := s.authGossiper.Stop(); err != nil {
3✔
2772
                        srvrLog.Warnf("failed to stop authGossiper: %v", err)
×
2773
                }
×
2774
                if err := s.sweeper.Stop(); err != nil {
3✔
2775
                        srvrLog.Warnf("failed to stop sweeper: %v", err)
×
2776
                }
×
2777
                if err := s.txPublisher.Stop(); err != nil {
3✔
2778
                        srvrLog.Warnf("failed to stop txPublisher: %v", err)
×
2779
                }
×
2780
                if err := s.channelNotifier.Stop(); err != nil {
3✔
2781
                        srvrLog.Warnf("failed to stop channelNotifier: %v", err)
×
2782
                }
×
2783
                if err := s.peerNotifier.Stop(); err != nil {
3✔
2784
                        srvrLog.Warnf("failed to stop peerNotifier: %v", err)
×
2785
                }
×
2786
                if err := s.htlcNotifier.Stop(); err != nil {
3✔
2787
                        srvrLog.Warnf("failed to stop htlcNotifier: %v", err)
×
2788
                }
×
2789

2790
                // Update channel.backup file. Make sure to do it before
2791
                // stopping chanSubSwapper.
2792
                singles, err := chanbackup.FetchStaticChanBackups(
3✔
2793
                        ctx, s.chanStateDB, s.addrSource,
3✔
2794
                )
3✔
2795
                if err != nil {
3✔
2796
                        srvrLog.Warnf("failed to fetch channel states: %v",
×
2797
                                err)
×
2798
                } else {
3✔
2799
                        err := s.chanSubSwapper.ManualUpdate(singles)
3✔
2800
                        if err != nil {
6✔
2801
                                srvrLog.Warnf("Manual update of channel "+
3✔
2802
                                        "backup failed: %v", err)
3✔
2803
                        }
3✔
2804
                }
2805

2806
                if err := s.chanSubSwapper.Stop(); err != nil {
3✔
2807
                        srvrLog.Warnf("failed to stop chanSubSwapper: %v", err)
×
2808
                }
×
2809
                if err := s.cc.ChainNotifier.Stop(); err != nil {
3✔
2810
                        srvrLog.Warnf("Unable to stop ChainNotifier: %v", err)
×
2811
                }
×
2812
                if err := s.cc.BestBlockTracker.Stop(); err != nil {
3✔
2813
                        srvrLog.Warnf("Unable to stop BestBlockTracker: %v",
×
2814
                                err)
×
2815
                }
×
2816
                if err := s.chanEventStore.Stop(); err != nil {
3✔
2817
                        srvrLog.Warnf("Unable to stop ChannelEventStore: %v",
×
2818
                                err)
×
2819
                }
×
2820
                s.missionController.StopStoreTickers()
3✔
2821

3✔
2822
                // Disconnect from each active peers to ensure that
3✔
2823
                // peerTerminationWatchers signal completion to each peer.
3✔
2824
                for _, peer := range s.Peers() {
6✔
2825
                        err := s.DisconnectPeer(peer.IdentityKey())
3✔
2826
                        if err != nil {
3✔
2827
                                srvrLog.Warnf("could not disconnect peer: %v"+
×
2828
                                        "received error: %v", peer.IdentityKey(),
×
2829
                                        err,
×
2830
                                )
×
2831
                        }
×
2832
                }
2833

2834
                // Now that all connections have been torn down, stop the tower
2835
                // client which will reliably flush all queued states to the
2836
                // tower. If this is halted for any reason, the force quit timer
2837
                // will kick in and abort to allow this method to return.
2838
                if s.towerClientMgr != nil {
6✔
2839
                        if err := s.towerClientMgr.Stop(); err != nil {
3✔
2840
                                srvrLog.Warnf("Unable to shut down tower "+
×
2841
                                        "client manager: %v", err)
×
2842
                        }
×
2843
                }
2844

2845
                if s.hostAnn != nil {
3✔
2846
                        if err := s.hostAnn.Stop(); err != nil {
×
2847
                                srvrLog.Warnf("unable to shut down host "+
×
2848
                                        "annoucner: %v", err)
×
2849
                        }
×
2850
                }
2851

2852
                if s.livenessMonitor != nil {
6✔
2853
                        if err := s.livenessMonitor.Stop(); err != nil {
3✔
2854
                                srvrLog.Warnf("unable to shutdown liveness "+
×
2855
                                        "monitor: %v", err)
×
2856
                        }
×
2857
                }
2858

2859
                // Wait for all lingering goroutines to quit.
2860
                srvrLog.Debug("Waiting for server to shutdown...")
3✔
2861
                s.wg.Wait()
3✔
2862

3✔
2863
                srvrLog.Debug("Stopping buffer pools...")
3✔
2864
                s.sigPool.Stop()
3✔
2865
                s.writePool.Stop()
3✔
2866
                s.readPool.Stop()
3✔
2867
        })
2868

2869
        return nil
3✔
2870
}
2871

2872
// Stopped returns true if the server has been instructed to shutdown.
2873
// NOTE: This function is safe for concurrent access.
2874
func (s *server) Stopped() bool {
3✔
2875
        return atomic.LoadInt32(&s.stopping) != 0
3✔
2876
}
3✔
2877

2878
// configurePortForwarding attempts to set up port forwarding for the different
2879
// ports that the server will be listening on.
2880
//
2881
// NOTE: This should only be used when using some kind of NAT traversal to
2882
// automatically set up forwarding rules.
2883
func (s *server) configurePortForwarding(ports ...uint16) ([]string, error) {
×
2884
        ip, err := s.natTraversal.ExternalIP()
×
2885
        if err != nil {
×
2886
                return nil, err
×
2887
        }
×
2888
        s.lastDetectedIP = ip
×
2889

×
2890
        externalIPs := make([]string, 0, len(ports))
×
2891
        for _, port := range ports {
×
2892
                if err := s.natTraversal.AddPortMapping(port); err != nil {
×
2893
                        srvrLog.Debugf("Unable to forward port %d: %v", port, err)
×
2894
                        continue
×
2895
                }
2896

2897
                hostIP := fmt.Sprintf("%v:%d", ip, port)
×
2898
                externalIPs = append(externalIPs, hostIP)
×
2899
        }
2900

2901
        return externalIPs, nil
×
2902
}
2903

2904
// removePortForwarding attempts to clear the forwarding rules for the different
2905
// ports the server is currently listening on.
2906
//
2907
// NOTE: This should only be used when using some kind of NAT traversal to
2908
// automatically set up forwarding rules.
2909
func (s *server) removePortForwarding() {
×
2910
        forwardedPorts := s.natTraversal.ForwardedPorts()
×
2911
        for _, port := range forwardedPorts {
×
2912
                if err := s.natTraversal.DeletePortMapping(port); err != nil {
×
2913
                        srvrLog.Errorf("Unable to remove forwarding rules for "+
×
2914
                                "port %d: %v", port, err)
×
2915
                }
×
2916
        }
2917
}
2918

2919
// watchExternalIP continuously checks for an updated external IP address every
2920
// 15 minutes. Once a new IP address has been detected, it will automatically
2921
// handle port forwarding rules and send updated node announcements to the
2922
// currently connected peers.
2923
//
2924
// NOTE: This MUST be run as a goroutine.
2925
func (s *server) watchExternalIP() {
×
2926
        defer s.wg.Done()
×
2927

×
2928
        // Before exiting, we'll make sure to remove the forwarding rules set
×
2929
        // up by the server.
×
2930
        defer s.removePortForwarding()
×
2931

×
2932
        // Keep track of the external IPs set by the user to avoid replacing
×
2933
        // them when detecting a new IP.
×
2934
        ipsSetByUser := make(map[string]struct{})
×
2935
        for _, ip := range s.cfg.ExternalIPs {
×
2936
                ipsSetByUser[ip.String()] = struct{}{}
×
2937
        }
×
2938

2939
        forwardedPorts := s.natTraversal.ForwardedPorts()
×
2940

×
2941
        ticker := time.NewTicker(15 * time.Minute)
×
2942
        defer ticker.Stop()
×
2943
out:
×
2944
        for {
×
2945
                select {
×
2946
                case <-ticker.C:
×
2947
                        // We'll start off by making sure a new IP address has
×
2948
                        // been detected.
×
2949
                        ip, err := s.natTraversal.ExternalIP()
×
2950
                        if err != nil {
×
2951
                                srvrLog.Debugf("Unable to retrieve the "+
×
2952
                                        "external IP address: %v", err)
×
2953
                                continue
×
2954
                        }
2955

2956
                        // Periodically renew the NAT port forwarding.
2957
                        for _, port := range forwardedPorts {
×
2958
                                err := s.natTraversal.AddPortMapping(port)
×
2959
                                if err != nil {
×
2960
                                        srvrLog.Warnf("Unable to automatically "+
×
2961
                                                "re-create port forwarding using %s: %v",
×
2962
                                                s.natTraversal.Name(), err)
×
2963
                                } else {
×
2964
                                        srvrLog.Debugf("Automatically re-created "+
×
2965
                                                "forwarding for port %d using %s to "+
×
2966
                                                "advertise external IP",
×
2967
                                                port, s.natTraversal.Name())
×
2968
                                }
×
2969
                        }
2970

2971
                        if ip.Equal(s.lastDetectedIP) {
×
2972
                                continue
×
2973
                        }
2974

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

×
2977
                        // Next, we'll craft the new addresses that will be
×
2978
                        // included in the new node announcement and advertised
×
2979
                        // to the network. Each address will consist of the new
×
2980
                        // IP detected and one of the currently advertised
×
2981
                        // ports.
×
2982
                        var newAddrs []net.Addr
×
2983
                        for _, port := range forwardedPorts {
×
2984
                                hostIP := fmt.Sprintf("%v:%d", ip, port)
×
2985
                                addr, err := net.ResolveTCPAddr("tcp", hostIP)
×
2986
                                if err != nil {
×
2987
                                        srvrLog.Debugf("Unable to resolve "+
×
2988
                                                "host %v: %v", addr, err)
×
2989
                                        continue
×
2990
                                }
2991

2992
                                newAddrs = append(newAddrs, addr)
×
2993
                        }
2994

2995
                        // Skip the update if we weren't able to resolve any of
2996
                        // the new addresses.
2997
                        if len(newAddrs) == 0 {
×
2998
                                srvrLog.Debug("Skipping node announcement " +
×
2999
                                        "update due to not being able to " +
×
3000
                                        "resolve any new addresses")
×
3001
                                continue
×
3002
                        }
3003

3004
                        // Now, we'll need to update the addresses in our node's
3005
                        // announcement in order to propagate the update
3006
                        // throughout the network. We'll only include addresses
3007
                        // that have a different IP from the previous one, as
3008
                        // the previous IP is no longer valid.
3009
                        currentNodeAnn := s.getNodeAnnouncement()
×
3010

×
3011
                        for _, addr := range currentNodeAnn.Addresses {
×
3012
                                host, _, err := net.SplitHostPort(addr.String())
×
3013
                                if err != nil {
×
3014
                                        srvrLog.Debugf("Unable to determine "+
×
3015
                                                "host from address %v: %v",
×
3016
                                                addr, err)
×
3017
                                        continue
×
3018
                                }
3019

3020
                                // We'll also make sure to include external IPs
3021
                                // set manually by the user.
3022
                                _, setByUser := ipsSetByUser[addr.String()]
×
3023
                                if setByUser || host != s.lastDetectedIP.String() {
×
3024
                                        newAddrs = append(newAddrs, addr)
×
3025
                                }
×
3026
                        }
3027

3028
                        // Then, we'll generate a new timestamped node
3029
                        // announcement with the updated addresses and broadcast
3030
                        // it to our peers.
3031
                        newNodeAnn, err := s.genNodeAnnouncement(
×
3032
                                nil, netann.NodeAnnSetAddrs(newAddrs),
×
3033
                        )
×
3034
                        if err != nil {
×
3035
                                srvrLog.Debugf("Unable to generate new node "+
×
3036
                                        "announcement: %v", err)
×
3037
                                continue
×
3038
                        }
3039

3040
                        err = s.BroadcastMessage(nil, &newNodeAnn)
×
3041
                        if err != nil {
×
3042
                                srvrLog.Debugf("Unable to broadcast new node "+
×
3043
                                        "announcement to peers: %v", err)
×
3044
                                continue
×
3045
                        }
3046

3047
                        // Finally, update the last IP seen to the current one.
3048
                        s.lastDetectedIP = ip
×
3049
                case <-s.quit:
×
3050
                        break out
×
3051
                }
3052
        }
3053
}
3054

3055
// initNetworkBootstrappers initializes a set of network peer bootstrappers
3056
// based on the server, and currently active bootstrap mechanisms as defined
3057
// within the current configuration.
3058
func initNetworkBootstrappers(s *server) ([]discovery.NetworkPeerBootstrapper, error) {
3✔
3059
        srvrLog.Infof("Initializing peer network bootstrappers!")
3✔
3060

3✔
3061
        var bootStrappers []discovery.NetworkPeerBootstrapper
3✔
3062

3✔
3063
        // First, we'll create an instance of the ChannelGraphBootstrapper as
3✔
3064
        // this can be used by default if we've already partially seeded the
3✔
3065
        // network.
3✔
3066
        chanGraph := autopilot.ChannelGraphFromDatabase(s.graphDB)
3✔
3067
        graphBootstrapper, err := discovery.NewGraphBootstrapper(
3✔
3068
                chanGraph, s.cfg.Bitcoin.IsLocalNetwork(),
3✔
3069
        )
3✔
3070
        if err != nil {
3✔
3071
                return nil, err
×
3072
        }
×
3073
        bootStrappers = append(bootStrappers, graphBootstrapper)
3✔
3074

3✔
3075
        // If this isn't using simnet or regtest mode, then one of our
3✔
3076
        // additional bootstrapping sources will be the set of running DNS
3✔
3077
        // seeds.
3✔
3078
        if !s.cfg.Bitcoin.IsLocalNetwork() {
3✔
3079
                //nolint:ll
×
3080
                dnsSeeds, ok := chainreg.ChainDNSSeeds[*s.cfg.ActiveNetParams.GenesisHash]
×
3081

×
3082
                // If we have a set of DNS seeds for this chain, then we'll add
×
3083
                // it as an additional bootstrapping source.
×
3084
                if ok {
×
3085
                        srvrLog.Infof("Creating DNS peer bootstrapper with "+
×
3086
                                "seeds: %v", dnsSeeds)
×
3087

×
3088
                        dnsBootStrapper := discovery.NewDNSSeedBootstrapper(
×
3089
                                dnsSeeds, s.cfg.net, s.cfg.ConnectionTimeout,
×
3090
                        )
×
3091
                        bootStrappers = append(bootStrappers, dnsBootStrapper)
×
3092
                }
×
3093
        }
3094

3095
        return bootStrappers, nil
3✔
3096
}
3097

3098
// createBootstrapIgnorePeers creates a map of peers that the bootstrap process
3099
// needs to ignore, which is made of three parts,
3100
//   - the node itself needs to be skipped as it doesn't make sense to connect
3101
//     to itself.
3102
//   - the peers that already have connections with, as in s.peersByPub.
3103
//   - the peers that we are attempting to connect, as in s.persistentPeers.
3104
func (s *server) createBootstrapIgnorePeers() map[autopilot.NodeID]struct{} {
3✔
3105
        s.mu.RLock()
3✔
3106
        defer s.mu.RUnlock()
3✔
3107

3✔
3108
        ignore := make(map[autopilot.NodeID]struct{})
3✔
3109

3✔
3110
        // We should ignore ourselves from bootstrapping.
3✔
3111
        selfKey := autopilot.NewNodeID(s.identityECDH.PubKey())
3✔
3112
        ignore[selfKey] = struct{}{}
3✔
3113

3✔
3114
        // Ignore all connected peers.
3✔
3115
        for _, peer := range s.peersByPub {
3✔
3116
                nID := autopilot.NewNodeID(peer.IdentityKey())
×
3117
                ignore[nID] = struct{}{}
×
3118
        }
×
3119

3120
        // Ignore all persistent peers as they have a dedicated reconnecting
3121
        // process.
3122
        for pubKeyStr := range s.persistentPeers {
3✔
3123
                var nID autopilot.NodeID
×
3124
                copy(nID[:], []byte(pubKeyStr))
×
3125
                ignore[nID] = struct{}{}
×
3126
        }
×
3127

3128
        return ignore
3✔
3129
}
3130

3131
// peerBootstrapper is a goroutine which is tasked with attempting to establish
3132
// and maintain a target minimum number of outbound connections. With this
3133
// invariant, we ensure that our node is connected to a diverse set of peers
3134
// and that nodes newly joining the network receive an up to date network view
3135
// as soon as possible.
3136
func (s *server) peerBootstrapper(ctx context.Context, numTargetPeers uint32,
3137
        bootstrappers []discovery.NetworkPeerBootstrapper) {
3✔
3138

3✔
3139
        defer s.wg.Done()
3✔
3140

3✔
3141
        // Before we continue, init the ignore peers map.
3✔
3142
        ignoreList := s.createBootstrapIgnorePeers()
3✔
3143

3✔
3144
        // We'll start off by aggressively attempting connections to peers in
3✔
3145
        // order to be a part of the network as soon as possible.
3✔
3146
        s.initialPeerBootstrap(ctx, ignoreList, numTargetPeers, bootstrappers)
3✔
3147

3✔
3148
        // Once done, we'll attempt to maintain our target minimum number of
3✔
3149
        // peers.
3✔
3150
        //
3✔
3151
        // We'll use a 15 second backoff, and double the time every time an
3✔
3152
        // epoch fails up to a ceiling.
3✔
3153
        backOff := time.Second * 15
3✔
3154

3✔
3155
        // We'll create a new ticker to wake us up every 15 seconds so we can
3✔
3156
        // see if we've reached our minimum number of peers.
3✔
3157
        sampleTicker := time.NewTicker(backOff)
3✔
3158
        defer sampleTicker.Stop()
3✔
3159

3✔
3160
        // We'll use the number of attempts and errors to determine if we need
3✔
3161
        // to increase the time between discovery epochs.
3✔
3162
        var epochErrors uint32 // To be used atomically.
3✔
3163
        var epochAttempts uint32
3✔
3164

3✔
3165
        for {
6✔
3166
                select {
3✔
3167
                // The ticker has just woken us up, so we'll need to check if
3168
                // we need to attempt to connect our to any more peers.
3169
                case <-sampleTicker.C:
×
3170
                        // Obtain the current number of peers, so we can gauge
×
3171
                        // if we need to sample more peers or not.
×
3172
                        s.mu.RLock()
×
3173
                        numActivePeers := uint32(len(s.peersByPub))
×
3174
                        s.mu.RUnlock()
×
3175

×
3176
                        // If we have enough peers, then we can loop back
×
3177
                        // around to the next round as we're done here.
×
3178
                        if numActivePeers >= numTargetPeers {
×
3179
                                continue
×
3180
                        }
3181

3182
                        // If all of our attempts failed during this last back
3183
                        // off period, then will increase our backoff to 5
3184
                        // minute ceiling to avoid an excessive number of
3185
                        // queries
3186
                        //
3187
                        // TODO(roasbeef): add reverse policy too?
3188

3189
                        if epochAttempts > 0 &&
×
3190
                                atomic.LoadUint32(&epochErrors) >= epochAttempts {
×
3191

×
3192
                                sampleTicker.Stop()
×
3193

×
3194
                                backOff *= 2
×
3195
                                if backOff > bootstrapBackOffCeiling {
×
3196
                                        backOff = bootstrapBackOffCeiling
×
3197
                                }
×
3198

3199
                                srvrLog.Debugf("Backing off peer bootstrapper to "+
×
3200
                                        "%v", backOff)
×
3201
                                sampleTicker = time.NewTicker(backOff)
×
3202
                                continue
×
3203
                        }
3204

3205
                        atomic.StoreUint32(&epochErrors, 0)
×
3206
                        epochAttempts = 0
×
3207

×
3208
                        // Since we know need more peers, we'll compute the
×
3209
                        // exact number we need to reach our threshold.
×
3210
                        numNeeded := numTargetPeers - numActivePeers
×
3211

×
3212
                        srvrLog.Debugf("Attempting to obtain %v more network "+
×
3213
                                "peers", numNeeded)
×
3214

×
3215
                        // With the number of peers we need calculated, we'll
×
3216
                        // query the network bootstrappers to sample a set of
×
3217
                        // random addrs for us.
×
3218
                        //
×
3219
                        // Before we continue, get a copy of the ignore peers
×
3220
                        // map.
×
3221
                        ignoreList = s.createBootstrapIgnorePeers()
×
3222

×
3223
                        peerAddrs, err := discovery.MultiSourceBootstrap(
×
3224
                                ctx, ignoreList, numNeeded*2, bootstrappers...,
×
3225
                        )
×
3226
                        if err != nil {
×
3227
                                srvrLog.Errorf("Unable to retrieve bootstrap "+
×
3228
                                        "peers: %v", err)
×
3229
                                continue
×
3230
                        }
3231

3232
                        // Finally, we'll launch a new goroutine for each
3233
                        // prospective peer candidates.
3234
                        for _, addr := range peerAddrs {
×
3235
                                epochAttempts++
×
3236

×
3237
                                go func(a *lnwire.NetAddress) {
×
3238
                                        // TODO(roasbeef): can do AS, subnet,
×
3239
                                        // country diversity, etc
×
3240
                                        errChan := make(chan error, 1)
×
3241
                                        s.connectToPeer(
×
3242
                                                a, errChan,
×
3243
                                                s.cfg.ConnectionTimeout,
×
3244
                                        )
×
3245
                                        select {
×
3246
                                        case err := <-errChan:
×
3247
                                                if err == nil {
×
3248
                                                        return
×
3249
                                                }
×
3250

3251
                                                srvrLog.Errorf("Unable to "+
×
3252
                                                        "connect to %v: %v",
×
3253
                                                        a, err)
×
3254
                                                atomic.AddUint32(&epochErrors, 1)
×
3255
                                        case <-s.quit:
×
3256
                                        }
3257
                                }(addr)
3258
                        }
3259
                case <-s.quit:
3✔
3260
                        return
3✔
3261
                }
3262
        }
3263
}
3264

3265
// bootstrapBackOffCeiling is the maximum amount of time we'll wait between
3266
// failed attempts to locate a set of bootstrap peers. We'll slowly double our
3267
// query back off each time we encounter a failure.
3268
const bootstrapBackOffCeiling = time.Minute * 5
3269

3270
// initialPeerBootstrap attempts to continuously connect to peers on startup
3271
// until the target number of peers has been reached. This ensures that nodes
3272
// receive an up to date network view as soon as possible.
3273
func (s *server) initialPeerBootstrap(ctx context.Context,
3274
        ignore map[autopilot.NodeID]struct{}, numTargetPeers uint32,
3275
        bootstrappers []discovery.NetworkPeerBootstrapper) {
3✔
3276

3✔
3277
        srvrLog.Debugf("Init bootstrap with targetPeers=%v, bootstrappers=%v, "+
3✔
3278
                "ignore=%v", numTargetPeers, len(bootstrappers), len(ignore))
3✔
3279

3✔
3280
        // We'll start off by waiting 2 seconds between failed attempts, then
3✔
3281
        // double each time we fail until we hit the bootstrapBackOffCeiling.
3✔
3282
        var delaySignal <-chan time.Time
3✔
3283
        delayTime := time.Second * 2
3✔
3284

3✔
3285
        // As want to be more aggressive, we'll use a lower back off celling
3✔
3286
        // then the main peer bootstrap logic.
3✔
3287
        backOffCeiling := bootstrapBackOffCeiling / 5
3✔
3288

3✔
3289
        for attempts := 0; ; attempts++ {
6✔
3290
                // Check if the server has been requested to shut down in order
3✔
3291
                // to prevent blocking.
3✔
3292
                if s.Stopped() {
3✔
3293
                        return
×
3294
                }
×
3295

3296
                // We can exit our aggressive initial peer bootstrapping stage
3297
                // if we've reached out target number of peers.
3298
                s.mu.RLock()
3✔
3299
                numActivePeers := uint32(len(s.peersByPub))
3✔
3300
                s.mu.RUnlock()
3✔
3301

3✔
3302
                if numActivePeers >= numTargetPeers {
6✔
3303
                        return
3✔
3304
                }
3✔
3305

3306
                if attempts > 0 {
3✔
UNCOV
3307
                        srvrLog.Debugf("Waiting %v before trying to locate "+
×
UNCOV
3308
                                "bootstrap peers (attempt #%v)", delayTime,
×
UNCOV
3309
                                attempts)
×
UNCOV
3310

×
UNCOV
3311
                        // We've completed at least one iterating and haven't
×
UNCOV
3312
                        // finished, so we'll start to insert a delay period
×
UNCOV
3313
                        // between each attempt.
×
UNCOV
3314
                        delaySignal = time.After(delayTime)
×
UNCOV
3315
                        select {
×
UNCOV
3316
                        case <-delaySignal:
×
UNCOV
3317
                        case <-s.quit:
×
UNCOV
3318
                                return
×
3319
                        }
3320

3321
                        // After our delay, we'll double the time we wait up to
3322
                        // the max back off period.
UNCOV
3323
                        delayTime *= 2
×
UNCOV
3324
                        if delayTime > backOffCeiling {
×
3325
                                delayTime = backOffCeiling
×
3326
                        }
×
3327
                }
3328

3329
                // Otherwise, we'll request for the remaining number of peers
3330
                // in order to reach our target.
3331
                peersNeeded := numTargetPeers - numActivePeers
3✔
3332
                bootstrapAddrs, err := discovery.MultiSourceBootstrap(
3✔
3333
                        ctx, ignore, peersNeeded, bootstrappers...,
3✔
3334
                )
3✔
3335
                if err != nil {
3✔
UNCOV
3336
                        srvrLog.Errorf("Unable to retrieve initial bootstrap "+
×
UNCOV
3337
                                "peers: %v", err)
×
UNCOV
3338
                        continue
×
3339
                }
3340

3341
                // Then, we'll attempt to establish a connection to the
3342
                // different peer addresses retrieved by our bootstrappers.
3343
                var wg sync.WaitGroup
3✔
3344
                for _, bootstrapAddr := range bootstrapAddrs {
6✔
3345
                        wg.Add(1)
3✔
3346
                        go func(addr *lnwire.NetAddress) {
6✔
3347
                                defer wg.Done()
3✔
3348

3✔
3349
                                errChan := make(chan error, 1)
3✔
3350
                                go s.connectToPeer(
3✔
3351
                                        addr, errChan, s.cfg.ConnectionTimeout,
3✔
3352
                                )
3✔
3353

3✔
3354
                                // We'll only allow this connection attempt to
3✔
3355
                                // take up to 3 seconds. This allows us to move
3✔
3356
                                // quickly by discarding peers that are slowing
3✔
3357
                                // us down.
3✔
3358
                                select {
3✔
3359
                                case err := <-errChan:
3✔
3360
                                        if err == nil {
6✔
3361
                                                return
3✔
3362
                                        }
3✔
3363
                                        srvrLog.Errorf("Unable to connect to "+
×
3364
                                                "%v: %v", addr, err)
×
3365
                                // TODO: tune timeout? 3 seconds might be *too*
3366
                                // aggressive but works well.
3367
                                case <-time.After(3 * time.Second):
×
3368
                                        srvrLog.Tracef("Skipping peer %v due "+
×
3369
                                                "to not establishing a "+
×
3370
                                                "connection within 3 seconds",
×
3371
                                                addr)
×
3372
                                case <-s.quit:
×
3373
                                }
3374
                        }(bootstrapAddr)
3375
                }
3376

3377
                wg.Wait()
3✔
3378
        }
3379
}
3380

3381
// createNewHiddenService automatically sets up a v2 or v3 onion service in
3382
// order to listen for inbound connections over Tor.
3383
func (s *server) createNewHiddenService(ctx context.Context) error {
×
3384
        // Determine the different ports the server is listening on. The onion
×
3385
        // service's virtual port will map to these ports and one will be picked
×
3386
        // at random when the onion service is being accessed.
×
3387
        listenPorts := make([]int, 0, len(s.listenAddrs))
×
3388
        for _, listenAddr := range s.listenAddrs {
×
3389
                port := listenAddr.(*net.TCPAddr).Port
×
3390
                listenPorts = append(listenPorts, port)
×
3391
        }
×
3392

3393
        encrypter, err := lnencrypt.KeyRingEncrypter(s.cc.KeyRing)
×
3394
        if err != nil {
×
3395
                return err
×
3396
        }
×
3397

3398
        // Once the port mapping has been set, we can go ahead and automatically
3399
        // create our onion service. The service's private key will be saved to
3400
        // disk in order to regain access to this service when restarting `lnd`.
3401
        onionCfg := tor.AddOnionConfig{
×
3402
                VirtualPort: defaultPeerPort,
×
3403
                TargetPorts: listenPorts,
×
3404
                Store: tor.NewOnionFile(
×
3405
                        s.cfg.Tor.PrivateKeyPath, 0600, s.cfg.Tor.EncryptKey,
×
3406
                        encrypter,
×
3407
                ),
×
3408
        }
×
3409

×
3410
        switch {
×
3411
        case s.cfg.Tor.V2:
×
3412
                onionCfg.Type = tor.V2
×
3413
        case s.cfg.Tor.V3:
×
3414
                onionCfg.Type = tor.V3
×
3415
        }
3416

3417
        addr, err := s.torController.AddOnion(onionCfg)
×
3418
        if err != nil {
×
3419
                return err
×
3420
        }
×
3421

3422
        // Now that the onion service has been created, we'll add the onion
3423
        // address it can be reached at to our list of advertised addresses.
3424
        newNodeAnn, err := s.genNodeAnnouncement(
×
3425
                nil, func(currentAnn *lnwire.NodeAnnouncement) {
×
3426
                        currentAnn.Addresses = append(currentAnn.Addresses, addr)
×
3427
                },
×
3428
        )
3429
        if err != nil {
×
3430
                return fmt.Errorf("unable to generate new node "+
×
3431
                        "announcement: %v", err)
×
3432
        }
×
3433

3434
        // Finally, we'll update the on-disk version of our announcement so it
3435
        // will eventually propagate to nodes in the network.
3436
        selfNode := &models.LightningNode{
×
3437
                HaveNodeAnnouncement: true,
×
3438
                LastUpdate:           time.Unix(int64(newNodeAnn.Timestamp), 0),
×
3439
                Addresses:            newNodeAnn.Addresses,
×
3440
                Alias:                newNodeAnn.Alias.String(),
×
3441
                Features: lnwire.NewFeatureVector(
×
3442
                        newNodeAnn.Features, lnwire.Features,
×
3443
                ),
×
3444
                Color:        newNodeAnn.RGBColor,
×
3445
                AuthSigBytes: newNodeAnn.Signature.ToSignatureBytes(),
×
3446
        }
×
3447
        copy(selfNode.PubKeyBytes[:], s.identityECDH.PubKey().SerializeCompressed())
×
3448
        if err := s.graphDB.SetSourceNode(ctx, selfNode); err != nil {
×
3449
                return fmt.Errorf("can't set self node: %w", err)
×
3450
        }
×
3451

3452
        return nil
×
3453
}
3454

3455
// findChannel finds a channel given a public key and ChannelID. It is an
3456
// optimization that is quicker than seeking for a channel given only the
3457
// ChannelID.
3458
func (s *server) findChannel(node *btcec.PublicKey, chanID lnwire.ChannelID) (
3459
        *channeldb.OpenChannel, error) {
3✔
3460

3✔
3461
        nodeChans, err := s.chanStateDB.FetchOpenChannels(node)
3✔
3462
        if err != nil {
3✔
3463
                return nil, err
×
3464
        }
×
3465

3466
        for _, channel := range nodeChans {
6✔
3467
                if chanID.IsChanPoint(&channel.FundingOutpoint) {
6✔
3468
                        return channel, nil
3✔
3469
                }
3✔
3470
        }
3471

3472
        return nil, fmt.Errorf("unable to find channel")
3✔
3473
}
3474

3475
// getNodeAnnouncement fetches the current, fully signed node announcement.
3476
func (s *server) getNodeAnnouncement() lnwire.NodeAnnouncement {
3✔
3477
        s.mu.Lock()
3✔
3478
        defer s.mu.Unlock()
3✔
3479

3✔
3480
        return *s.currentNodeAnn
3✔
3481
}
3✔
3482

3483
// genNodeAnnouncement generates and returns the current fully signed node
3484
// announcement. The time stamp of the announcement will be updated in order
3485
// to ensure it propagates through the network.
3486
func (s *server) genNodeAnnouncement(features *lnwire.RawFeatureVector,
3487
        modifiers ...netann.NodeAnnModifier) (lnwire.NodeAnnouncement, error) {
3✔
3488

3✔
3489
        s.mu.Lock()
3✔
3490
        defer s.mu.Unlock()
3✔
3491

3✔
3492
        // Create a shallow copy of the current node announcement to work on.
3✔
3493
        // This ensures the original announcement remains unchanged
3✔
3494
        // until the new announcement is fully signed and valid.
3✔
3495
        newNodeAnn := *s.currentNodeAnn
3✔
3496

3✔
3497
        // First, try to update our feature manager with the updated set of
3✔
3498
        // features.
3✔
3499
        if features != nil {
6✔
3500
                proposedFeatures := map[feature.Set]*lnwire.RawFeatureVector{
3✔
3501
                        feature.SetNodeAnn: features,
3✔
3502
                }
3✔
3503
                err := s.featureMgr.UpdateFeatureSets(proposedFeatures)
3✔
3504
                if err != nil {
6✔
3505
                        return lnwire.NodeAnnouncement{}, err
3✔
3506
                }
3✔
3507

3508
                // If we could successfully update our feature manager, add
3509
                // an update modifier to include these new features to our
3510
                // set.
3511
                modifiers = append(
3✔
3512
                        modifiers, netann.NodeAnnSetFeatures(features),
3✔
3513
                )
3✔
3514
        }
3515

3516
        // Always update the timestamp when refreshing to ensure the update
3517
        // propagates.
3518
        modifiers = append(modifiers, netann.NodeAnnSetTimestamp)
3✔
3519

3✔
3520
        // Apply the requested changes to the node announcement.
3✔
3521
        for _, modifier := range modifiers {
6✔
3522
                modifier(&newNodeAnn)
3✔
3523
        }
3✔
3524

3525
        // Sign a new update after applying all of the passed modifiers.
3526
        err := netann.SignNodeAnnouncement(
3✔
3527
                s.nodeSigner, s.identityKeyLoc, &newNodeAnn,
3✔
3528
        )
3✔
3529
        if err != nil {
3✔
3530
                return lnwire.NodeAnnouncement{}, err
×
3531
        }
×
3532

3533
        // If signing succeeds, update the current announcement.
3534
        *s.currentNodeAnn = newNodeAnn
3✔
3535

3✔
3536
        return *s.currentNodeAnn, nil
3✔
3537
}
3538

3539
// updateAndBroadcastSelfNode generates a new node announcement
3540
// applying the giving modifiers and updating the time stamp
3541
// to ensure it propagates through the network. Then it broadcasts
3542
// it to the network.
3543
func (s *server) updateAndBroadcastSelfNode(ctx context.Context,
3544
        features *lnwire.RawFeatureVector,
3545
        modifiers ...netann.NodeAnnModifier) error {
3✔
3546

3✔
3547
        newNodeAnn, err := s.genNodeAnnouncement(features, modifiers...)
3✔
3548
        if err != nil {
6✔
3549
                return fmt.Errorf("unable to generate new node "+
3✔
3550
                        "announcement: %v", err)
3✔
3551
        }
3✔
3552

3553
        // Update the on-disk version of our announcement.
3554
        // Load and modify self node istead of creating anew instance so we
3555
        // don't risk overwriting any existing values.
3556
        selfNode, err := s.graphDB.SourceNode(ctx)
3✔
3557
        if err != nil {
3✔
3558
                return fmt.Errorf("unable to get current source node: %w", err)
×
3559
        }
×
3560

3561
        selfNode.HaveNodeAnnouncement = true
3✔
3562
        selfNode.LastUpdate = time.Unix(int64(newNodeAnn.Timestamp), 0)
3✔
3563
        selfNode.Addresses = newNodeAnn.Addresses
3✔
3564
        selfNode.Alias = newNodeAnn.Alias.String()
3✔
3565
        selfNode.Features = s.featureMgr.Get(feature.SetNodeAnn)
3✔
3566
        selfNode.Color = newNodeAnn.RGBColor
3✔
3567
        selfNode.AuthSigBytes = newNodeAnn.Signature.ToSignatureBytes()
3✔
3568

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

3✔
3571
        if err := s.graphDB.SetSourceNode(ctx, selfNode); err != nil {
3✔
3572
                return fmt.Errorf("can't set self node: %w", err)
×
3573
        }
×
3574

3575
        // Finally, propagate it to the nodes in the network.
3576
        err = s.BroadcastMessage(nil, &newNodeAnn)
3✔
3577
        if err != nil {
3✔
3578
                rpcsLog.Debugf("Unable to broadcast new node "+
×
3579
                        "announcement to peers: %v", err)
×
3580
                return err
×
3581
        }
×
3582

3583
        return nil
3✔
3584
}
3585

3586
type nodeAddresses struct {
3587
        pubKey    *btcec.PublicKey
3588
        addresses []net.Addr
3589
}
3590

3591
// establishPersistentConnections attempts to establish persistent connections
3592
// to all our direct channel collaborators. In order to promote liveness of our
3593
// active channels, we instruct the connection manager to attempt to establish
3594
// and maintain persistent connections to all our direct channel counterparties.
3595
func (s *server) establishPersistentConnections() error {
3✔
3596
        // nodeAddrsMap stores the combination of node public keys and addresses
3✔
3597
        // that we'll attempt to reconnect to. PubKey strings are used as keys
3✔
3598
        // since other PubKey forms can't be compared.
3✔
3599
        nodeAddrsMap := map[string]*nodeAddresses{}
3✔
3600

3✔
3601
        // Iterate through the list of LinkNodes to find addresses we should
3✔
3602
        // attempt to connect to based on our set of previous connections. Set
3✔
3603
        // the reconnection port to the default peer port.
3✔
3604
        linkNodes, err := s.chanStateDB.LinkNodeDB().FetchAllLinkNodes()
3✔
3605
        if err != nil && err != channeldb.ErrLinkNodesNotFound {
3✔
3606
                return fmt.Errorf("failed to fetch all link nodes: %w", err)
×
3607
        }
×
3608

3609
        for _, node := range linkNodes {
6✔
3610
                pubStr := string(node.IdentityPub.SerializeCompressed())
3✔
3611
                nodeAddrs := &nodeAddresses{
3✔
3612
                        pubKey:    node.IdentityPub,
3✔
3613
                        addresses: node.Addresses,
3✔
3614
                }
3✔
3615
                nodeAddrsMap[pubStr] = nodeAddrs
3✔
3616
        }
3✔
3617

3618
        // After checking our previous connections for addresses to connect to,
3619
        // iterate through the nodes in our channel graph to find addresses
3620
        // that have been added via NodeAnnouncement messages.
3621
        // TODO(roasbeef): instead iterate over link nodes and query graph for
3622
        // each of the nodes.
3623
        err = s.graphDB.ForEachSourceNodeChannel(func(chanPoint wire.OutPoint,
3✔
3624
                havePolicy bool, channelPeer *models.LightningNode) error {
6✔
3625

3✔
3626
                // If the remote party has announced the channel to us, but we
3✔
3627
                // haven't yet, then we won't have a policy. However, we don't
3✔
3628
                // need this to connect to the peer, so we'll log it and move on.
3✔
3629
                if !havePolicy {
3✔
3630
                        srvrLog.Warnf("No channel policy found for "+
×
3631
                                "ChannelPoint(%v): ", chanPoint)
×
3632
                }
×
3633

3634
                pubStr := string(channelPeer.PubKeyBytes[:])
3✔
3635

3✔
3636
                // Add all unique addresses from channel
3✔
3637
                // graph/NodeAnnouncements to the list of addresses we'll
3✔
3638
                // connect to for this peer.
3✔
3639
                addrSet := make(map[string]net.Addr)
3✔
3640
                for _, addr := range channelPeer.Addresses {
6✔
3641
                        switch addr.(type) {
3✔
3642
                        case *net.TCPAddr:
3✔
3643
                                addrSet[addr.String()] = addr
3✔
3644

3645
                        // We'll only attempt to connect to Tor addresses if Tor
3646
                        // outbound support is enabled.
3647
                        case *tor.OnionAddr:
×
3648
                                if s.cfg.Tor.Active {
×
3649
                                        addrSet[addr.String()] = addr
×
3650
                                }
×
3651
                        }
3652
                }
3653

3654
                // If this peer is also recorded as a link node, we'll add any
3655
                // additional addresses that have not already been selected.
3656
                linkNodeAddrs, ok := nodeAddrsMap[pubStr]
3✔
3657
                if ok {
6✔
3658
                        for _, lnAddress := range linkNodeAddrs.addresses {
6✔
3659
                                switch lnAddress.(type) {
3✔
3660
                                case *net.TCPAddr:
3✔
3661
                                        addrSet[lnAddress.String()] = lnAddress
3✔
3662

3663
                                // We'll only attempt to connect to Tor
3664
                                // addresses if Tor outbound support is enabled.
3665
                                case *tor.OnionAddr:
×
3666
                                        if s.cfg.Tor.Active {
×
3667
                                                addrSet[lnAddress.String()] = lnAddress
×
3668
                                        }
×
3669
                                }
3670
                        }
3671
                }
3672

3673
                // Construct a slice of the deduped addresses.
3674
                var addrs []net.Addr
3✔
3675
                for _, addr := range addrSet {
6✔
3676
                        addrs = append(addrs, addr)
3✔
3677
                }
3✔
3678

3679
                n := &nodeAddresses{
3✔
3680
                        addresses: addrs,
3✔
3681
                }
3✔
3682
                n.pubKey, err = channelPeer.PubKey()
3✔
3683
                if err != nil {
3✔
3684
                        return err
×
3685
                }
×
3686

3687
                nodeAddrsMap[pubStr] = n
3✔
3688
                return nil
3✔
3689
        })
3690
        if err != nil {
3✔
3691
                srvrLog.Errorf("Failed to iterate over source node channels: "+
×
3692
                        "%v", err)
×
3693

×
3694
                if !errors.Is(err, graphdb.ErrGraphNoEdgesFound) &&
×
3695
                        !errors.Is(err, graphdb.ErrEdgeNotFound) {
×
3696

×
3697
                        return err
×
3698
                }
×
3699
        }
3700

3701
        srvrLog.Debugf("Establishing %v persistent connections on start",
3✔
3702
                len(nodeAddrsMap))
3✔
3703

3✔
3704
        // Acquire and hold server lock until all persistent connection requests
3✔
3705
        // have been recorded and sent to the connection manager.
3✔
3706
        s.mu.Lock()
3✔
3707
        defer s.mu.Unlock()
3✔
3708

3✔
3709
        // Iterate through the combined list of addresses from prior links and
3✔
3710
        // node announcements and attempt to reconnect to each node.
3✔
3711
        var numOutboundConns int
3✔
3712
        for pubStr, nodeAddr := range nodeAddrsMap {
6✔
3713
                // Add this peer to the set of peers we should maintain a
3✔
3714
                // persistent connection with. We set the value to false to
3✔
3715
                // indicate that we should not continue to reconnect if the
3✔
3716
                // number of channels returns to zero, since this peer has not
3✔
3717
                // been requested as perm by the user.
3✔
3718
                s.persistentPeers[pubStr] = false
3✔
3719
                if _, ok := s.persistentPeersBackoff[pubStr]; !ok {
6✔
3720
                        s.persistentPeersBackoff[pubStr] = s.cfg.MinBackoff
3✔
3721
                }
3✔
3722

3723
                for _, address := range nodeAddr.addresses {
6✔
3724
                        // Create a wrapper address which couples the IP and
3✔
3725
                        // the pubkey so the brontide authenticated connection
3✔
3726
                        // can be established.
3✔
3727
                        lnAddr := &lnwire.NetAddress{
3✔
3728
                                IdentityKey: nodeAddr.pubKey,
3✔
3729
                                Address:     address,
3✔
3730
                        }
3✔
3731

3✔
3732
                        s.persistentPeerAddrs[pubStr] = append(
3✔
3733
                                s.persistentPeerAddrs[pubStr], lnAddr)
3✔
3734
                }
3✔
3735

3736
                // We'll connect to the first 10 peers immediately, then
3737
                // randomly stagger any remaining connections if the
3738
                // stagger initial reconnect flag is set. This ensures
3739
                // that mobile nodes or nodes with a small number of
3740
                // channels obtain connectivity quickly, but larger
3741
                // nodes are able to disperse the costs of connecting to
3742
                // all peers at once.
3743
                if numOutboundConns < numInstantInitReconnect ||
3✔
3744
                        !s.cfg.StaggerInitialReconnect {
6✔
3745

3✔
3746
                        go s.connectToPersistentPeer(pubStr)
3✔
3747
                } else {
3✔
3748
                        go s.delayInitialReconnect(pubStr)
×
3749
                }
×
3750

3751
                numOutboundConns++
3✔
3752
        }
3753

3754
        return nil
3✔
3755
}
3756

3757
// delayInitialReconnect will attempt a reconnection to the given peer after
3758
// sampling a value for the delay between 0s and the maxInitReconnectDelay.
3759
//
3760
// NOTE: This method MUST be run as a goroutine.
3761
func (s *server) delayInitialReconnect(pubStr string) {
×
3762
        delay := time.Duration(prand.Intn(maxInitReconnectDelay)) * time.Second
×
3763
        select {
×
3764
        case <-time.After(delay):
×
3765
                s.connectToPersistentPeer(pubStr)
×
3766
        case <-s.quit:
×
3767
        }
3768
}
3769

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

3✔
3776
        s.mu.Lock()
3✔
3777
        if perm, ok := s.persistentPeers[pubKeyStr]; ok && !perm {
6✔
3778
                delete(s.persistentPeers, pubKeyStr)
3✔
3779
                delete(s.persistentPeersBackoff, pubKeyStr)
3✔
3780
                delete(s.persistentPeerAddrs, pubKeyStr)
3✔
3781
                s.cancelConnReqs(pubKeyStr, nil)
3✔
3782
                s.mu.Unlock()
3✔
3783

3✔
3784
                srvrLog.Infof("Pruned peer %x from persistent connections, "+
3✔
3785
                        "peer has no open channels", compressedPubKey)
3✔
3786

3✔
3787
                return
3✔
3788
        }
3✔
3789
        s.mu.Unlock()
3✔
3790
}
3791

3792
// bannedPersistentPeerConnection does not actually "ban" a persistent peer. It
3793
// is instead used to remove persistent peer state for a peer that has been
3794
// disconnected for good cause by the server. Currently, a gossip ban from
3795
// sending garbage and the server running out of restricted-access
3796
// (i.e. "free") connection slots are the only way this logic gets hit. In the
3797
// future, this function may expand when more ban criteria is added.
3798
//
3799
// NOTE: The server's write lock MUST be held when this is called.
3800
func (s *server) bannedPersistentPeerConnection(remotePub string) {
×
3801
        if perm, ok := s.persistentPeers[remotePub]; ok && !perm {
×
3802
                delete(s.persistentPeers, remotePub)
×
3803
                delete(s.persistentPeersBackoff, remotePub)
×
3804
                delete(s.persistentPeerAddrs, remotePub)
×
3805
                s.cancelConnReqs(remotePub, nil)
×
3806
        }
×
3807
}
3808

3809
// BroadcastMessage sends a request to the server to broadcast a set of
3810
// messages to all peers other than the one specified by the `skips` parameter.
3811
// All messages sent via BroadcastMessage will be queued for lazy delivery to
3812
// the target peers.
3813
//
3814
// NOTE: This function is safe for concurrent access.
3815
func (s *server) BroadcastMessage(skips map[route.Vertex]struct{},
3816
        msgs ...lnwire.Message) error {
3✔
3817

3✔
3818
        // Filter out peers found in the skips map. We synchronize access to
3✔
3819
        // peersByPub throughout this process to ensure we deliver messages to
3✔
3820
        // exact set of peers present at the time of invocation.
3✔
3821
        s.mu.RLock()
3✔
3822
        peers := make([]*peer.Brontide, 0, len(s.peersByPub))
3✔
3823
        for pubStr, sPeer := range s.peersByPub {
6✔
3824
                if skips != nil {
6✔
3825
                        if _, ok := skips[sPeer.PubKey()]; ok {
6✔
3826
                                srvrLog.Tracef("Skipping %x in broadcast with "+
3✔
3827
                                        "pubStr=%x", sPeer.PubKey(), pubStr)
3✔
3828
                                continue
3✔
3829
                        }
3830
                }
3831

3832
                peers = append(peers, sPeer)
3✔
3833
        }
3834
        s.mu.RUnlock()
3✔
3835

3✔
3836
        // Iterate over all known peers, dispatching a go routine to enqueue
3✔
3837
        // all messages to each of peers.
3✔
3838
        var wg sync.WaitGroup
3✔
3839
        for _, sPeer := range peers {
6✔
3840
                srvrLog.Debugf("Sending %v messages to peer %x", len(msgs),
3✔
3841
                        sPeer.PubKey())
3✔
3842

3✔
3843
                // Dispatch a go routine to enqueue all messages to this peer.
3✔
3844
                wg.Add(1)
3✔
3845
                s.wg.Add(1)
3✔
3846
                go func(p lnpeer.Peer) {
6✔
3847
                        defer s.wg.Done()
3✔
3848
                        defer wg.Done()
3✔
3849

3✔
3850
                        p.SendMessageLazy(false, msgs...)
3✔
3851
                }(sPeer)
3✔
3852
        }
3853

3854
        // Wait for all messages to have been dispatched before returning to
3855
        // caller.
3856
        wg.Wait()
3✔
3857

3✔
3858
        return nil
3✔
3859
}
3860

3861
// NotifyWhenOnline can be called by other subsystems to get notified when a
3862
// particular peer comes online. The peer itself is sent across the peerChan.
3863
//
3864
// NOTE: This function is safe for concurrent access.
3865
func (s *server) NotifyWhenOnline(peerKey [33]byte,
3866
        peerChan chan<- lnpeer.Peer) {
3✔
3867

3✔
3868
        s.mu.Lock()
3✔
3869

3✔
3870
        // Compute the target peer's identifier.
3✔
3871
        pubStr := string(peerKey[:])
3✔
3872

3✔
3873
        // Check if peer is connected.
3✔
3874
        peer, ok := s.peersByPub[pubStr]
3✔
3875
        if ok {
6✔
3876
                // Unlock here so that the mutex isn't held while we are
3✔
3877
                // waiting for the peer to become active.
3✔
3878
                s.mu.Unlock()
3✔
3879

3✔
3880
                // Wait until the peer signals that it is actually active
3✔
3881
                // rather than only in the server's maps.
3✔
3882
                select {
3✔
3883
                case <-peer.ActiveSignal():
3✔
3884
                case <-peer.QuitSignal():
×
3885
                        // The peer quit, so we'll add the channel to the slice
×
3886
                        // and return.
×
3887
                        s.mu.Lock()
×
3888
                        s.peerConnectedListeners[pubStr] = append(
×
3889
                                s.peerConnectedListeners[pubStr], peerChan,
×
3890
                        )
×
3891
                        s.mu.Unlock()
×
3892
                        return
×
3893
                }
3894

3895
                // Connected, can return early.
3896
                srvrLog.Debugf("Notifying that peer %x is online", peerKey)
3✔
3897

3✔
3898
                select {
3✔
3899
                case peerChan <- peer:
3✔
3900
                case <-s.quit:
×
3901
                }
3902

3903
                return
3✔
3904
        }
3905

3906
        // Not connected, store this listener such that it can be notified when
3907
        // the peer comes online.
3908
        s.peerConnectedListeners[pubStr] = append(
3✔
3909
                s.peerConnectedListeners[pubStr], peerChan,
3✔
3910
        )
3✔
3911
        s.mu.Unlock()
3✔
3912
}
3913

3914
// NotifyWhenOffline delivers a notification to the caller of when the peer with
3915
// the given public key has been disconnected. The notification is signaled by
3916
// closing the channel returned.
3917
func (s *server) NotifyWhenOffline(peerPubKey [33]byte) <-chan struct{} {
3✔
3918
        s.mu.Lock()
3✔
3919
        defer s.mu.Unlock()
3✔
3920

3✔
3921
        c := make(chan struct{})
3✔
3922

3✔
3923
        // If the peer is already offline, we can immediately trigger the
3✔
3924
        // notification.
3✔
3925
        peerPubKeyStr := string(peerPubKey[:])
3✔
3926
        if _, ok := s.peersByPub[peerPubKeyStr]; !ok {
3✔
3927
                srvrLog.Debugf("Notifying that peer %x is offline", peerPubKey)
×
3928
                close(c)
×
3929
                return c
×
3930
        }
×
3931

3932
        // Otherwise, the peer is online, so we'll keep track of the channel to
3933
        // trigger the notification once the server detects the peer
3934
        // disconnects.
3935
        s.peerDisconnectedListeners[peerPubKeyStr] = append(
3✔
3936
                s.peerDisconnectedListeners[peerPubKeyStr], c,
3✔
3937
        )
3✔
3938

3✔
3939
        return c
3✔
3940
}
3941

3942
// FindPeer will return the peer that corresponds to the passed in public key.
3943
// This function is used by the funding manager, allowing it to update the
3944
// daemon's local representation of the remote peer.
3945
//
3946
// NOTE: This function is safe for concurrent access.
3947
func (s *server) FindPeer(peerKey *btcec.PublicKey) (*peer.Brontide, error) {
3✔
3948
        s.mu.RLock()
3✔
3949
        defer s.mu.RUnlock()
3✔
3950

3✔
3951
        pubStr := string(peerKey.SerializeCompressed())
3✔
3952

3✔
3953
        return s.findPeerByPubStr(pubStr)
3✔
3954
}
3✔
3955

3956
// FindPeerByPubStr will return the peer that corresponds to the passed peerID,
3957
// which should be a string representation of the peer's serialized, compressed
3958
// public key.
3959
//
3960
// NOTE: This function is safe for concurrent access.
3961
func (s *server) FindPeerByPubStr(pubStr string) (*peer.Brontide, error) {
3✔
3962
        s.mu.RLock()
3✔
3963
        defer s.mu.RUnlock()
3✔
3964

3✔
3965
        return s.findPeerByPubStr(pubStr)
3✔
3966
}
3✔
3967

3968
// findPeerByPubStr is an internal method that retrieves the specified peer from
3969
// the server's internal state using.
3970
func (s *server) findPeerByPubStr(pubStr string) (*peer.Brontide, error) {
3✔
3971
        peer, ok := s.peersByPub[pubStr]
3✔
3972
        if !ok {
6✔
3973
                return nil, ErrPeerNotConnected
3✔
3974
        }
3✔
3975

3976
        return peer, nil
3✔
3977
}
3978

3979
// nextPeerBackoff computes the next backoff duration for a peer's pubkey using
3980
// exponential backoff. If no previous backoff was known, the default is
3981
// returned.
3982
func (s *server) nextPeerBackoff(pubStr string,
3983
        startTime time.Time) time.Duration {
3✔
3984

3✔
3985
        // Now, determine the appropriate backoff to use for the retry.
3✔
3986
        backoff, ok := s.persistentPeersBackoff[pubStr]
3✔
3987
        if !ok {
6✔
3988
                // If an existing backoff was unknown, use the default.
3✔
3989
                return s.cfg.MinBackoff
3✔
3990
        }
3✔
3991

3992
        // If the peer failed to start properly, we'll just use the previous
3993
        // backoff to compute the subsequent randomized exponential backoff
3994
        // duration. This will roughly double on average.
3995
        if startTime.IsZero() {
3✔
3996
                return computeNextBackoff(backoff, s.cfg.MaxBackoff)
×
3997
        }
×
3998

3999
        // The peer succeeded in starting. If the connection didn't last long
4000
        // enough to be considered stable, we'll continue to back off retries
4001
        // with this peer.
4002
        connDuration := time.Since(startTime)
3✔
4003
        if connDuration < defaultStableConnDuration {
6✔
4004
                return computeNextBackoff(backoff, s.cfg.MaxBackoff)
3✔
4005
        }
3✔
4006

4007
        // The peer succeed in starting and this was stable peer, so we'll
4008
        // reduce the timeout duration by the length of the connection after
4009
        // applying randomized exponential backoff. We'll only apply this in the
4010
        // case that:
4011
        //   reb(curBackoff) - connDuration > cfg.MinBackoff
4012
        relaxedBackoff := computeNextBackoff(backoff, s.cfg.MaxBackoff) - connDuration
×
4013
        if relaxedBackoff > s.cfg.MinBackoff {
×
4014
                return relaxedBackoff
×
4015
        }
×
4016

4017
        // Lastly, if reb(currBackoff) - connDuration <= cfg.MinBackoff, meaning
4018
        // the stable connection lasted much longer than our previous backoff.
4019
        // To reward such good behavior, we'll reconnect after the default
4020
        // timeout.
4021
        return s.cfg.MinBackoff
×
4022
}
4023

4024
// shouldDropLocalConnection determines if our local connection to a remote peer
4025
// should be dropped in the case of concurrent connection establishment. In
4026
// order to deterministically decide which connection should be dropped, we'll
4027
// utilize the ordering of the local and remote public key. If we didn't use
4028
// such a tie breaker, then we risk _both_ connections erroneously being
4029
// dropped.
4030
func shouldDropLocalConnection(local, remote *btcec.PublicKey) bool {
×
4031
        localPubBytes := local.SerializeCompressed()
×
4032
        remotePubPbytes := remote.SerializeCompressed()
×
4033

×
4034
        // The connection that comes from the node with a "smaller" pubkey
×
4035
        // should be kept. Therefore, if our pubkey is "greater" than theirs, we
×
4036
        // should drop our established connection.
×
4037
        return bytes.Compare(localPubBytes, remotePubPbytes) > 0
×
4038
}
×
4039

4040
// InboundPeerConnected initializes a new peer in response to a new inbound
4041
// connection.
4042
//
4043
// NOTE: This function is safe for concurrent access.
4044
func (s *server) InboundPeerConnected(conn net.Conn) {
3✔
4045
        // Exit early if we have already been instructed to shutdown, this
3✔
4046
        // prevents any delayed callbacks from accidentally registering peers.
3✔
4047
        if s.Stopped() {
3✔
4048
                return
×
4049
        }
×
4050

4051
        nodePub := conn.(*brontide.Conn).RemotePub()
3✔
4052
        pubSer := nodePub.SerializeCompressed()
3✔
4053
        pubStr := string(pubSer)
3✔
4054

3✔
4055
        var pubBytes [33]byte
3✔
4056
        copy(pubBytes[:], pubSer)
3✔
4057

3✔
4058
        s.mu.Lock()
3✔
4059
        defer s.mu.Unlock()
3✔
4060

3✔
4061
        // If we already have an outbound connection to this peer, then ignore
3✔
4062
        // this new connection.
3✔
4063
        if p, ok := s.outboundPeers[pubStr]; ok {
6✔
4064
                srvrLog.Debugf("Already have outbound connection for %v, "+
3✔
4065
                        "ignoring inbound connection from local=%v, remote=%v",
3✔
4066
                        p, conn.LocalAddr(), conn.RemoteAddr())
3✔
4067

3✔
4068
                conn.Close()
3✔
4069
                return
3✔
4070
        }
3✔
4071

4072
        // If we already have a valid connection that is scheduled to take
4073
        // precedence once the prior peer has finished disconnecting, we'll
4074
        // ignore this connection.
4075
        if p, ok := s.scheduledPeerConnection[pubStr]; ok {
3✔
4076
                srvrLog.Debugf("Ignoring connection from %v, peer %v already "+
×
4077
                        "scheduled", conn.RemoteAddr(), p)
×
4078
                conn.Close()
×
4079
                return
×
4080
        }
×
4081

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

3✔
4084
        // Check to see if we already have a connection with this peer. If so,
3✔
4085
        // we may need to drop our existing connection. This prevents us from
3✔
4086
        // having duplicate connections to the same peer. We forgo adding a
3✔
4087
        // default case as we expect these to be the only error values returned
3✔
4088
        // from findPeerByPubStr.
3✔
4089
        connectedPeer, err := s.findPeerByPubStr(pubStr)
3✔
4090
        switch err {
3✔
4091
        case ErrPeerNotConnected:
3✔
4092
                // We were unable to locate an existing connection with the
3✔
4093
                // target peer, proceed to connect.
3✔
4094
                s.cancelConnReqs(pubStr, nil)
3✔
4095
                s.peerConnected(conn, nil, true)
3✔
4096

4097
        case nil:
3✔
4098
                // We already have a connection with the incoming peer. If the
3✔
4099
                // connection we've already established should be kept and is
3✔
4100
                // not of the same type of the new connection (inbound), then
3✔
4101
                // we'll close out the new connection s.t there's only a single
3✔
4102
                // connection between us.
3✔
4103
                localPub := s.identityECDH.PubKey()
3✔
4104
                if !connectedPeer.Inbound() &&
3✔
4105
                        !shouldDropLocalConnection(localPub, nodePub) {
3✔
4106

×
4107
                        srvrLog.Warnf("Received inbound connection from "+
×
4108
                                "peer %v, but already have outbound "+
×
4109
                                "connection, dropping conn", connectedPeer)
×
4110
                        conn.Close()
×
4111
                        return
×
4112
                }
×
4113

4114
                // Otherwise, if we should drop the connection, then we'll
4115
                // disconnect our already connected peer.
4116
                srvrLog.Debugf("Disconnecting stale connection to %v",
3✔
4117
                        connectedPeer)
3✔
4118

3✔
4119
                s.cancelConnReqs(pubStr, nil)
3✔
4120

3✔
4121
                // Remove the current peer from the server's internal state and
3✔
4122
                // signal that the peer termination watcher does not need to
3✔
4123
                // execute for this peer.
3✔
4124
                s.removePeerUnsafe(connectedPeer)
3✔
4125
                s.ignorePeerTermination[connectedPeer] = struct{}{}
3✔
4126
                s.scheduledPeerConnection[pubStr] = func() {
6✔
4127
                        s.peerConnected(conn, nil, true)
3✔
4128
                }
3✔
4129
        }
4130
}
4131

4132
// OutboundPeerConnected initializes a new peer in response to a new outbound
4133
// connection.
4134
// NOTE: This function is safe for concurrent access.
4135
func (s *server) OutboundPeerConnected(connReq *connmgr.ConnReq, conn net.Conn) {
3✔
4136
        // Exit early if we have already been instructed to shutdown, this
3✔
4137
        // prevents any delayed callbacks from accidentally registering peers.
3✔
4138
        if s.Stopped() {
3✔
4139
                return
×
4140
        }
×
4141

4142
        nodePub := conn.(*brontide.Conn).RemotePub()
3✔
4143
        pubSer := nodePub.SerializeCompressed()
3✔
4144
        pubStr := string(pubSer)
3✔
4145

3✔
4146
        var pubBytes [33]byte
3✔
4147
        copy(pubBytes[:], pubSer)
3✔
4148

3✔
4149
        s.mu.Lock()
3✔
4150
        defer s.mu.Unlock()
3✔
4151

3✔
4152
        // If we already have an inbound connection to this peer, then ignore
3✔
4153
        // this new connection.
3✔
4154
        if p, ok := s.inboundPeers[pubStr]; ok {
6✔
4155
                srvrLog.Debugf("Already have inbound connection for %v, "+
3✔
4156
                        "ignoring outbound connection from local=%v, remote=%v",
3✔
4157
                        p, conn.LocalAddr(), conn.RemoteAddr())
3✔
4158

3✔
4159
                if connReq != nil {
6✔
4160
                        s.connMgr.Remove(connReq.ID())
3✔
4161
                }
3✔
4162
                conn.Close()
3✔
4163
                return
3✔
4164
        }
4165
        if _, ok := s.persistentConnReqs[pubStr]; !ok && connReq != nil {
3✔
4166
                srvrLog.Debugf("Ignoring canceled outbound connection")
×
4167
                s.connMgr.Remove(connReq.ID())
×
4168
                conn.Close()
×
4169
                return
×
4170
        }
×
4171

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

×
4178
                if connReq != nil {
×
4179
                        s.connMgr.Remove(connReq.ID())
×
4180
                }
×
4181

4182
                conn.Close()
×
4183
                return
×
4184
        }
4185

4186
        srvrLog.Infof("Established outbound connection to: %x@%v", pubStr,
3✔
4187
                conn.RemoteAddr())
3✔
4188

3✔
4189
        if connReq != nil {
6✔
4190
                // A successful connection was returned by the connmgr.
3✔
4191
                // Immediately cancel all pending requests, excluding the
3✔
4192
                // outbound connection we just established.
3✔
4193
                ignore := connReq.ID()
3✔
4194
                s.cancelConnReqs(pubStr, &ignore)
3✔
4195
        } else {
6✔
4196
                // This was a successful connection made by some other
3✔
4197
                // subsystem. Remove all requests being managed by the connmgr.
3✔
4198
                s.cancelConnReqs(pubStr, nil)
3✔
4199
        }
3✔
4200

4201
        // If we already have a connection with this peer, decide whether or not
4202
        // we need to drop the stale connection. We forgo adding a default case
4203
        // as we expect these to be the only error values returned from
4204
        // findPeerByPubStr.
4205
        connectedPeer, err := s.findPeerByPubStr(pubStr)
3✔
4206
        switch err {
3✔
4207
        case ErrPeerNotConnected:
3✔
4208
                // We were unable to locate an existing connection with the
3✔
4209
                // target peer, proceed to connect.
3✔
4210
                s.peerConnected(conn, connReq, false)
3✔
4211

4212
        case nil:
3✔
4213
                // We already have a connection with the incoming peer. If the
3✔
4214
                // connection we've already established should be kept and is
3✔
4215
                // not of the same type of the new connection (outbound), then
3✔
4216
                // we'll close out the new connection s.t there's only a single
3✔
4217
                // connection between us.
3✔
4218
                localPub := s.identityECDH.PubKey()
3✔
4219
                if connectedPeer.Inbound() &&
3✔
4220
                        shouldDropLocalConnection(localPub, nodePub) {
3✔
4221

×
4222
                        srvrLog.Warnf("Established outbound connection to "+
×
4223
                                "peer %v, but already have inbound "+
×
4224
                                "connection, dropping conn", connectedPeer)
×
4225
                        if connReq != nil {
×
4226
                                s.connMgr.Remove(connReq.ID())
×
4227
                        }
×
4228
                        conn.Close()
×
4229
                        return
×
4230
                }
4231

4232
                // Otherwise, _their_ connection should be dropped. So we'll
4233
                // disconnect the peer and send the now obsolete peer to the
4234
                // server for garbage collection.
4235
                srvrLog.Debugf("Disconnecting stale connection to %v",
3✔
4236
                        connectedPeer)
3✔
4237

3✔
4238
                // Remove the current peer from the server's internal state and
3✔
4239
                // signal that the peer termination watcher does not need to
3✔
4240
                // execute for this peer.
3✔
4241
                s.removePeerUnsafe(connectedPeer)
3✔
4242
                s.ignorePeerTermination[connectedPeer] = struct{}{}
3✔
4243
                s.scheduledPeerConnection[pubStr] = func() {
6✔
4244
                        s.peerConnected(conn, connReq, false)
3✔
4245
                }
3✔
4246
        }
4247
}
4248

4249
// UnassignedConnID is the default connection ID that a request can have before
4250
// it actually is submitted to the connmgr.
4251
// TODO(conner): move into connmgr package, or better, add connmgr method for
4252
// generating atomic IDs
4253
const UnassignedConnID uint64 = 0
4254

4255
// cancelConnReqs stops all persistent connection requests for a given pubkey.
4256
// Any attempts initiated by the peerTerminationWatcher are canceled first.
4257
// Afterwards, each connection request removed from the connmgr. The caller can
4258
// optionally specify a connection ID to ignore, which prevents us from
4259
// canceling a successful request. All persistent connreqs for the provided
4260
// pubkey are discarded after the operationjw.
4261
func (s *server) cancelConnReqs(pubStr string, skip *uint64) {
3✔
4262
        // First, cancel any lingering persistent retry attempts, which will
3✔
4263
        // prevent retries for any with backoffs that are still maturing.
3✔
4264
        if cancelChan, ok := s.persistentRetryCancels[pubStr]; ok {
6✔
4265
                close(cancelChan)
3✔
4266
                delete(s.persistentRetryCancels, pubStr)
3✔
4267
        }
3✔
4268

4269
        // Next, check to see if we have any outstanding persistent connection
4270
        // requests to this peer. If so, then we'll remove all of these
4271
        // connection requests, and also delete the entry from the map.
4272
        connReqs, ok := s.persistentConnReqs[pubStr]
3✔
4273
        if !ok {
6✔
4274
                return
3✔
4275
        }
3✔
4276

4277
        for _, connReq := range connReqs {
6✔
4278
                srvrLog.Tracef("Canceling %s:", connReqs)
3✔
4279

3✔
4280
                // Atomically capture the current request identifier.
3✔
4281
                connID := connReq.ID()
3✔
4282

3✔
4283
                // Skip any zero IDs, this indicates the request has not
3✔
4284
                // yet been schedule.
3✔
4285
                if connID == UnassignedConnID {
3✔
4286
                        continue
×
4287
                }
4288

4289
                // Skip a particular connection ID if instructed.
4290
                if skip != nil && connID == *skip {
6✔
4291
                        continue
3✔
4292
                }
4293

4294
                s.connMgr.Remove(connID)
3✔
4295
        }
4296

4297
        delete(s.persistentConnReqs, pubStr)
3✔
4298
}
4299

4300
// handleCustomMessage dispatches an incoming custom peers message to
4301
// subscribers.
4302
func (s *server) handleCustomMessage(peer [33]byte, msg *lnwire.Custom) error {
3✔
4303
        srvrLog.Debugf("Custom message received: peer=%x, type=%d",
3✔
4304
                peer, msg.Type)
3✔
4305

3✔
4306
        return s.customMessageServer.SendUpdate(&CustomMessage{
3✔
4307
                Peer: peer,
3✔
4308
                Msg:  msg,
3✔
4309
        })
3✔
4310
}
3✔
4311

4312
// SubscribeCustomMessages subscribes to a stream of incoming custom peer
4313
// messages.
4314
func (s *server) SubscribeCustomMessages() (*subscribe.Client, error) {
3✔
4315
        return s.customMessageServer.Subscribe()
3✔
4316
}
3✔
4317

4318
// notifyOpenChannelPeerEvent updates the access manager's maps and then calls
4319
// the channelNotifier's NotifyOpenChannelEvent.
4320
func (s *server) notifyOpenChannelPeerEvent(op wire.OutPoint,
4321
        remotePub *btcec.PublicKey) {
3✔
4322

3✔
4323
        // Call newOpenChan to update the access manager's maps for this peer.
3✔
4324
        if err := s.peerAccessMan.newOpenChan(remotePub); err != nil {
6✔
4325
                srvrLog.Errorf("Failed to update peer[%x] access status after "+
3✔
4326
                        "channel[%v] open", remotePub.SerializeCompressed(), op)
3✔
4327
        }
3✔
4328

4329
        // Notify subscribers about this open channel event.
4330
        s.channelNotifier.NotifyOpenChannelEvent(op)
3✔
4331
}
4332

4333
// notifyPendingOpenChannelPeerEvent updates the access manager's maps and then
4334
// calls the channelNotifier's NotifyPendingOpenChannelEvent.
4335
func (s *server) notifyPendingOpenChannelPeerEvent(op wire.OutPoint,
4336
        pendingChan *channeldb.OpenChannel, remotePub *btcec.PublicKey) {
3✔
4337

3✔
4338
        // Call newPendingOpenChan to update the access manager's maps for this
3✔
4339
        // peer.
3✔
4340
        if err := s.peerAccessMan.newPendingOpenChan(remotePub); err != nil {
3✔
4341
                srvrLog.Errorf("Failed to update peer[%x] access status after "+
×
4342
                        "channel[%v] pending open",
×
4343
                        remotePub.SerializeCompressed(), op)
×
4344
        }
×
4345

4346
        // Notify subscribers about this event.
4347
        s.channelNotifier.NotifyPendingOpenChannelEvent(op, pendingChan)
3✔
4348
}
4349

4350
// notifyFundingTimeoutPeerEvent updates the access manager's maps and then
4351
// calls the channelNotifier's NotifyFundingTimeout.
4352
func (s *server) notifyFundingTimeoutPeerEvent(op wire.OutPoint,
4353
        remotePub *btcec.PublicKey) {
3✔
4354

3✔
4355
        // Call newPendingCloseChan to potentially demote the peer.
3✔
4356
        err := s.peerAccessMan.newPendingCloseChan(remotePub)
3✔
4357
        if err != nil {
3✔
4358
                srvrLog.Errorf("Failed to update peer[%x] access status after "+
×
4359
                        "channel[%v] pending close",
×
4360
                        remotePub.SerializeCompressed(), op)
×
4361
        }
×
4362

4363
        if errors.Is(err, ErrNoMoreRestrictedAccessSlots) {
3✔
4364
                // If we encounter an error while attempting to disconnect the
×
4365
                // peer, log the error.
×
4366
                if dcErr := s.DisconnectPeer(remotePub); dcErr != nil {
×
4367
                        srvrLog.Errorf("Unable to disconnect peer: %v\n", err)
×
4368
                }
×
4369
        }
4370

4371
        // Notify subscribers about this event.
4372
        s.channelNotifier.NotifyFundingTimeout(op)
3✔
4373
}
4374

4375
// peerConnected is a function that handles initialization a newly connected
4376
// peer by adding it to the server's global list of all active peers, and
4377
// starting all the goroutines the peer needs to function properly. The inbound
4378
// boolean should be true if the peer initiated the connection to us.
4379
func (s *server) peerConnected(conn net.Conn, connReq *connmgr.ConnReq,
4380
        inbound bool) {
3✔
4381

3✔
4382
        brontideConn := conn.(*brontide.Conn)
3✔
4383
        addr := conn.RemoteAddr()
3✔
4384
        pubKey := brontideConn.RemotePub()
3✔
4385

3✔
4386
        // Only restrict access for inbound connections, which means if the
3✔
4387
        // remote node's public key is banned or the restricted slots are used
3✔
4388
        // up, we will drop the connection.
3✔
4389
        //
3✔
4390
        // TODO(yy): Consider perform this check in
3✔
4391
        // `peerAccessMan.addPeerAccess`.
3✔
4392
        access, err := s.peerAccessMan.assignPeerPerms(pubKey)
3✔
4393
        if inbound && err != nil {
3✔
4394
                pubSer := pubKey.SerializeCompressed()
×
4395

×
4396
                // Clean up the persistent peer maps if we're dropping this
×
4397
                // connection.
×
4398
                s.bannedPersistentPeerConnection(string(pubSer))
×
4399

×
4400
                srvrLog.Debugf("Dropping connection for %x since we are out "+
×
4401
                        "of restricted-access connection slots: %v.", pubSer,
×
4402
                        err)
×
4403

×
4404
                conn.Close()
×
4405

×
4406
                return
×
4407
        }
×
4408

4409
        srvrLog.Infof("Finalizing connection to %x@%s, inbound=%v",
3✔
4410
                pubKey.SerializeCompressed(), addr, inbound)
3✔
4411

3✔
4412
        peerAddr := &lnwire.NetAddress{
3✔
4413
                IdentityKey: pubKey,
3✔
4414
                Address:     addr,
3✔
4415
                ChainNet:    s.cfg.ActiveNetParams.Net,
3✔
4416
        }
3✔
4417

3✔
4418
        // With the brontide connection established, we'll now craft the feature
3✔
4419
        // vectors to advertise to the remote node.
3✔
4420
        initFeatures := s.featureMgr.Get(feature.SetInit)
3✔
4421
        legacyFeatures := s.featureMgr.Get(feature.SetLegacyGlobal)
3✔
4422

3✔
4423
        // Lookup past error caches for the peer in the server. If no buffer is
3✔
4424
        // found, create a fresh buffer.
3✔
4425
        pkStr := string(peerAddr.IdentityKey.SerializeCompressed())
3✔
4426
        errBuffer, ok := s.peerErrors[pkStr]
3✔
4427
        if !ok {
6✔
4428
                var err error
3✔
4429
                errBuffer, err = queue.NewCircularBuffer(peer.ErrorBufferSize)
3✔
4430
                if err != nil {
3✔
4431
                        srvrLog.Errorf("unable to create peer %v", err)
×
4432
                        return
×
4433
                }
×
4434
        }
4435

4436
        // If we directly set the peer.Config TowerClient member to the
4437
        // s.towerClientMgr then in the case that the s.towerClientMgr is nil,
4438
        // the peer.Config's TowerClient member will not evaluate to nil even
4439
        // though the underlying value is nil. To avoid this gotcha which can
4440
        // cause a panic, we need to explicitly pass nil to the peer.Config's
4441
        // TowerClient if needed.
4442
        var towerClient wtclient.ClientManager
3✔
4443
        if s.towerClientMgr != nil {
6✔
4444
                towerClient = s.towerClientMgr
3✔
4445
        }
3✔
4446

4447
        thresholdSats := btcutil.Amount(s.cfg.MaxFeeExposure)
3✔
4448
        thresholdMSats := lnwire.NewMSatFromSatoshis(thresholdSats)
3✔
4449

3✔
4450
        // Now that we've established a connection, create a peer, and it to the
3✔
4451
        // set of currently active peers. Configure the peer with the incoming
3✔
4452
        // and outgoing broadcast deltas to prevent htlcs from being accepted or
3✔
4453
        // offered that would trigger channel closure. In case of outgoing
3✔
4454
        // htlcs, an extra block is added to prevent the channel from being
3✔
4455
        // closed when the htlc is outstanding and a new block comes in.
3✔
4456
        pCfg := peer.Config{
3✔
4457
                Conn:                    brontideConn,
3✔
4458
                ConnReq:                 connReq,
3✔
4459
                Addr:                    peerAddr,
3✔
4460
                Inbound:                 inbound,
3✔
4461
                Features:                initFeatures,
3✔
4462
                LegacyFeatures:          legacyFeatures,
3✔
4463
                OutgoingCltvRejectDelta: lncfg.DefaultOutgoingCltvRejectDelta,
3✔
4464
                ChanActiveTimeout:       s.cfg.ChanEnableTimeout,
3✔
4465
                ErrorBuffer:             errBuffer,
3✔
4466
                WritePool:               s.writePool,
3✔
4467
                ReadPool:                s.readPool,
3✔
4468
                Switch:                  s.htlcSwitch,
3✔
4469
                InterceptSwitch:         s.interceptableSwitch,
3✔
4470
                ChannelDB:               s.chanStateDB,
3✔
4471
                ChannelGraph:            s.graphDB,
3✔
4472
                ChainArb:                s.chainArb,
3✔
4473
                AuthGossiper:            s.authGossiper,
3✔
4474
                ChanStatusMgr:           s.chanStatusMgr,
3✔
4475
                ChainIO:                 s.cc.ChainIO,
3✔
4476
                FeeEstimator:            s.cc.FeeEstimator,
3✔
4477
                Signer:                  s.cc.Wallet.Cfg.Signer,
3✔
4478
                SigPool:                 s.sigPool,
3✔
4479
                Wallet:                  s.cc.Wallet,
3✔
4480
                ChainNotifier:           s.cc.ChainNotifier,
3✔
4481
                BestBlockView:           s.cc.BestBlockTracker,
3✔
4482
                RoutingPolicy:           s.cc.RoutingPolicy,
3✔
4483
                Sphinx:                  s.sphinx,
3✔
4484
                WitnessBeacon:           s.witnessBeacon,
3✔
4485
                Invoices:                s.invoices,
3✔
4486
                ChannelNotifier:         s.channelNotifier,
3✔
4487
                HtlcNotifier:            s.htlcNotifier,
3✔
4488
                TowerClient:             towerClient,
3✔
4489
                DisconnectPeer:          s.DisconnectPeer,
3✔
4490
                GenNodeAnnouncement: func(...netann.NodeAnnModifier) (
3✔
4491
                        lnwire.NodeAnnouncement, error) {
6✔
4492

3✔
4493
                        return s.genNodeAnnouncement(nil)
3✔
4494
                },
3✔
4495

4496
                PongBuf: s.pongBuf,
4497

4498
                PrunePersistentPeerConnection: s.prunePersistentPeerConnection,
4499

4500
                FetchLastChanUpdate: s.fetchLastChanUpdate(),
4501

4502
                FundingManager: s.fundingMgr,
4503

4504
                Hodl:                    s.cfg.Hodl,
4505
                UnsafeReplay:            s.cfg.UnsafeReplay,
4506
                MaxOutgoingCltvExpiry:   s.cfg.MaxOutgoingCltvExpiry,
4507
                MaxChannelFeeAllocation: s.cfg.MaxChannelFeeAllocation,
4508
                CoopCloseTargetConfs:    s.cfg.CoopCloseTargetConfs,
4509
                MaxAnchorsCommitFeeRate: chainfee.SatPerKVByte(
4510
                        s.cfg.MaxCommitFeeRateAnchors * 1000).FeePerKWeight(),
4511
                ChannelCommitInterval:  s.cfg.ChannelCommitInterval,
4512
                PendingCommitInterval:  s.cfg.PendingCommitInterval,
4513
                ChannelCommitBatchSize: s.cfg.ChannelCommitBatchSize,
4514
                HandleCustomMessage:    s.handleCustomMessage,
4515
                GetAliases:             s.aliasMgr.GetAliases,
4516
                RequestAlias:           s.aliasMgr.RequestAlias,
4517
                AddLocalAlias:          s.aliasMgr.AddLocalAlias,
4518
                DisallowRouteBlinding:  s.cfg.ProtocolOptions.NoRouteBlinding(),
4519
                DisallowQuiescence:     s.cfg.ProtocolOptions.NoQuiescence(),
4520
                MaxFeeExposure:         thresholdMSats,
4521
                Quit:                   s.quit,
4522
                AuxLeafStore:           s.implCfg.AuxLeafStore,
4523
                AuxSigner:              s.implCfg.AuxSigner,
4524
                MsgRouter:              s.implCfg.MsgRouter,
4525
                AuxChanCloser:          s.implCfg.AuxChanCloser,
4526
                AuxResolver:            s.implCfg.AuxContractResolver,
4527
                AuxTrafficShaper:       s.implCfg.TrafficShaper,
4528
                ShouldFwdExpEndorsement: func() bool {
3✔
4529
                        if s.cfg.ProtocolOptions.NoExperimentalEndorsement() {
6✔
4530
                                return false
3✔
4531
                        }
3✔
4532

4533
                        return clock.NewDefaultClock().Now().Before(
3✔
4534
                                EndorsementExperimentEnd,
3✔
4535
                        )
3✔
4536
                },
4537
                NoDisconnectOnPongFailure: s.cfg.NoDisconnectOnPongFailure,
4538
        }
4539

4540
        copy(pCfg.PubKeyBytes[:], peerAddr.IdentityKey.SerializeCompressed())
3✔
4541
        copy(pCfg.ServerPubKey[:], s.identityECDH.PubKey().SerializeCompressed())
3✔
4542

3✔
4543
        p := peer.NewBrontide(pCfg)
3✔
4544

3✔
4545
        // Update the access manager with the access permission for this peer.
3✔
4546
        s.peerAccessMan.addPeerAccess(pubKey, access, inbound)
3✔
4547

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

3✔
4551
        s.addPeer(p)
3✔
4552

3✔
4553
        // Once we have successfully added the peer to the server, we can
3✔
4554
        // delete the previous error buffer from the server's map of error
3✔
4555
        // buffers.
3✔
4556
        delete(s.peerErrors, pkStr)
3✔
4557

3✔
4558
        // Dispatch a goroutine to asynchronously start the peer. This process
3✔
4559
        // includes sending and receiving Init messages, which would be a DOS
3✔
4560
        // vector if we held the server's mutex throughout the procedure.
3✔
4561
        s.wg.Add(1)
3✔
4562
        go s.peerInitializer(p)
3✔
4563
}
4564

4565
// addPeer adds the passed peer to the server's global state of all active
4566
// peers.
4567
func (s *server) addPeer(p *peer.Brontide) {
3✔
4568
        if p == nil {
3✔
4569
                return
×
4570
        }
×
4571

4572
        pubBytes := p.IdentityKey().SerializeCompressed()
3✔
4573

3✔
4574
        // Ignore new peers if we're shutting down.
3✔
4575
        if s.Stopped() {
3✔
4576
                srvrLog.Infof("Server stopped, skipped adding peer=%x",
×
4577
                        pubBytes)
×
4578
                p.Disconnect(ErrServerShuttingDown)
×
4579

×
4580
                return
×
4581
        }
×
4582

4583
        // Track the new peer in our indexes so we can quickly look it up either
4584
        // according to its public key, or its peer ID.
4585
        // TODO(roasbeef): pipe all requests through to the
4586
        // queryHandler/peerManager
4587

4588
        // NOTE: This pubStr is a raw bytes to string conversion and will NOT
4589
        // be human-readable.
4590
        pubStr := string(pubBytes)
3✔
4591

3✔
4592
        s.peersByPub[pubStr] = p
3✔
4593

3✔
4594
        if p.Inbound() {
6✔
4595
                s.inboundPeers[pubStr] = p
3✔
4596
        } else {
6✔
4597
                s.outboundPeers[pubStr] = p
3✔
4598
        }
3✔
4599

4600
        // Inform the peer notifier of a peer online event so that it can be reported
4601
        // to clients listening for peer events.
4602
        var pubKey [33]byte
3✔
4603
        copy(pubKey[:], pubBytes)
3✔
4604

3✔
4605
        s.peerNotifier.NotifyPeerOnline(pubKey)
3✔
4606
}
4607

4608
// peerInitializer asynchronously starts a newly connected peer after it has
4609
// been added to the server's peer map. This method sets up a
4610
// peerTerminationWatcher for the given peer, and ensures that it executes even
4611
// if the peer failed to start. In the event of a successful connection, this
4612
// method reads the negotiated, local feature-bits and spawns the appropriate
4613
// graph synchronization method. Any registered clients of NotifyWhenOnline will
4614
// be signaled of the new peer once the method returns.
4615
//
4616
// NOTE: This MUST be launched as a goroutine.
4617
func (s *server) peerInitializer(p *peer.Brontide) {
3✔
4618
        defer s.wg.Done()
3✔
4619

3✔
4620
        pubBytes := p.IdentityKey().SerializeCompressed()
3✔
4621

3✔
4622
        // Avoid initializing peers while the server is exiting.
3✔
4623
        if s.Stopped() {
3✔
4624
                srvrLog.Infof("Server stopped, skipped initializing peer=%x",
×
4625
                        pubBytes)
×
4626
                return
×
4627
        }
×
4628

4629
        // Create a channel that will be used to signal a successful start of
4630
        // the link. This prevents the peer termination watcher from beginning
4631
        // its duty too early.
4632
        ready := make(chan struct{})
3✔
4633

3✔
4634
        // Before starting the peer, launch a goroutine to watch for the
3✔
4635
        // unexpected termination of this peer, which will ensure all resources
3✔
4636
        // are properly cleaned up, and re-establish persistent connections when
3✔
4637
        // necessary. The peer termination watcher will be short circuited if
3✔
4638
        // the peer is ever added to the ignorePeerTermination map, indicating
3✔
4639
        // that the server has already handled the removal of this peer.
3✔
4640
        s.wg.Add(1)
3✔
4641
        go s.peerTerminationWatcher(p, ready)
3✔
4642

3✔
4643
        // Start the peer! If an error occurs, we Disconnect the peer, which
3✔
4644
        // will unblock the peerTerminationWatcher.
3✔
4645
        if err := p.Start(); err != nil {
6✔
4646
                srvrLog.Warnf("Starting peer=%x got error: %v", pubBytes, err)
3✔
4647

3✔
4648
                p.Disconnect(fmt.Errorf("unable to start peer: %w", err))
3✔
4649
                return
3✔
4650
        }
3✔
4651

4652
        // Otherwise, signal to the peerTerminationWatcher that the peer startup
4653
        // was successful, and to begin watching the peer's wait group.
4654
        close(ready)
3✔
4655

3✔
4656
        s.mu.Lock()
3✔
4657
        defer s.mu.Unlock()
3✔
4658

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

3✔
4662
        // TODO(guggero): Do a proper conversion to a string everywhere, or use
3✔
4663
        // route.Vertex as the key type of peerConnectedListeners.
3✔
4664
        pubStr := string(pubBytes)
3✔
4665
        for _, peerChan := range s.peerConnectedListeners[pubStr] {
6✔
4666
                select {
3✔
4667
                case peerChan <- p:
3✔
4668
                case <-s.quit:
×
4669
                        return
×
4670
                }
4671
        }
4672
        delete(s.peerConnectedListeners, pubStr)
3✔
4673
}
4674

4675
// peerTerminationWatcher waits until a peer has been disconnected unexpectedly,
4676
// and then cleans up all resources allocated to the peer, notifies relevant
4677
// sub-systems of its demise, and finally handles re-connecting to the peer if
4678
// it's persistent. If the server intentionally disconnects a peer, it should
4679
// have a corresponding entry in the ignorePeerTermination map which will cause
4680
// the cleanup routine to exit early. The passed `ready` chan is used to
4681
// synchronize when WaitForDisconnect should begin watching on the peer's
4682
// waitgroup. The ready chan should only be signaled if the peer starts
4683
// successfully, otherwise the peer should be disconnected instead.
4684
//
4685
// NOTE: This MUST be launched as a goroutine.
4686
func (s *server) peerTerminationWatcher(p *peer.Brontide, ready chan struct{}) {
3✔
4687
        defer s.wg.Done()
3✔
4688

3✔
4689
        ctx := context.TODO()
3✔
4690

3✔
4691
        p.WaitForDisconnect(ready)
3✔
4692

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

3✔
4695
        // If the server is exiting then we can bail out early ourselves as all
3✔
4696
        // the other sub-systems will already be shutting down.
3✔
4697
        if s.Stopped() {
6✔
4698
                srvrLog.Debugf("Server quitting, exit early for peer %v", p)
3✔
4699
                return
3✔
4700
        }
3✔
4701

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

3✔
4708
        pubKey := p.IdentityKey()
3✔
4709

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

3✔
4714
        // Tell the switch to remove all links associated with this peer.
3✔
4715
        // Passing nil as the target link indicates that all links associated
3✔
4716
        // with this interface should be closed.
3✔
4717
        //
3✔
4718
        // TODO(roasbeef): instead add a PurgeInterfaceLinks function?
3✔
4719
        links, err := s.htlcSwitch.GetLinksByInterface(p.PubKey())
3✔
4720
        if err != nil && err != htlcswitch.ErrNoLinksFound {
3✔
4721
                srvrLog.Errorf("Unable to get channel links for %v: %v", p, err)
×
4722
        }
×
4723

4724
        for _, link := range links {
6✔
4725
                s.htlcSwitch.RemoveLink(link.ChanID())
3✔
4726
        }
3✔
4727

4728
        s.mu.Lock()
3✔
4729
        defer s.mu.Unlock()
3✔
4730

3✔
4731
        // If there were any notification requests for when this peer
3✔
4732
        // disconnected, we can trigger them now.
3✔
4733
        srvrLog.Debugf("Notifying that peer %v is offline", p)
3✔
4734
        pubStr := string(pubKey.SerializeCompressed())
3✔
4735
        for _, offlineChan := range s.peerDisconnectedListeners[pubStr] {
6✔
4736
                close(offlineChan)
3✔
4737
        }
3✔
4738
        delete(s.peerDisconnectedListeners, pubStr)
3✔
4739

3✔
4740
        // If the server has already removed this peer, we can short circuit the
3✔
4741
        // peer termination watcher and skip cleanup.
3✔
4742
        if _, ok := s.ignorePeerTermination[p]; ok {
6✔
4743
                delete(s.ignorePeerTermination, p)
3✔
4744

3✔
4745
                pubKey := p.PubKey()
3✔
4746
                pubStr := string(pubKey[:])
3✔
4747

3✔
4748
                // If a connection callback is present, we'll go ahead and
3✔
4749
                // execute it now that previous peer has fully disconnected. If
3✔
4750
                // the callback is not present, this likely implies the peer was
3✔
4751
                // purposefully disconnected via RPC, and that no reconnect
3✔
4752
                // should be attempted.
3✔
4753
                connCallback, ok := s.scheduledPeerConnection[pubStr]
3✔
4754
                if ok {
6✔
4755
                        delete(s.scheduledPeerConnection, pubStr)
3✔
4756
                        connCallback()
3✔
4757
                }
3✔
4758
                return
3✔
4759
        }
4760

4761
        // First, cleanup any remaining state the server has regarding the peer
4762
        // in question.
4763
        s.removePeerUnsafe(p)
3✔
4764

3✔
4765
        // Next, check to see if this is a persistent peer or not.
3✔
4766
        if _, ok := s.persistentPeers[pubStr]; !ok {
6✔
4767
                return
3✔
4768
        }
3✔
4769

4770
        // Get the last address that we used to connect to the peer.
4771
        addrs := []net.Addr{
3✔
4772
                p.NetAddress().Address,
3✔
4773
        }
3✔
4774

3✔
4775
        // We'll ensure that we locate all the peers advertised addresses for
3✔
4776
        // reconnection purposes.
3✔
4777
        advertisedAddrs, err := s.fetchNodeAdvertisedAddrs(ctx, pubKey)
3✔
4778
        switch {
3✔
4779
        // We found advertised addresses, so use them.
4780
        case err == nil:
3✔
4781
                addrs = advertisedAddrs
3✔
4782

4783
        // The peer doesn't have an advertised address.
4784
        case err == errNoAdvertisedAddr:
3✔
4785
                // If it is an outbound peer then we fall back to the existing
3✔
4786
                // peer address.
3✔
4787
                if !p.Inbound() {
6✔
4788
                        break
3✔
4789
                }
4790

4791
                // Fall back to the existing peer address if
4792
                // we're not accepting connections over Tor.
4793
                if s.torController == nil {
6✔
4794
                        break
3✔
4795
                }
4796

4797
                // If we are, the peer's address won't be known
4798
                // to us (we'll see a private address, which is
4799
                // the address used by our onion service to dial
4800
                // to lnd), so we don't have enough information
4801
                // to attempt a reconnect.
4802
                srvrLog.Debugf("Ignoring reconnection attempt "+
×
4803
                        "to inbound peer %v without "+
×
4804
                        "advertised address", p)
×
4805
                return
×
4806

4807
        // We came across an error retrieving an advertised
4808
        // address, log it, and fall back to the existing peer
4809
        // address.
4810
        default:
3✔
4811
                srvrLog.Errorf("Unable to retrieve advertised "+
3✔
4812
                        "address for node %x: %v", p.PubKey(),
3✔
4813
                        err)
3✔
4814
        }
4815

4816
        // Make an easy lookup map so that we can check if an address
4817
        // is already in the address list that we have stored for this peer.
4818
        existingAddrs := make(map[string]bool)
3✔
4819
        for _, addr := range s.persistentPeerAddrs[pubStr] {
6✔
4820
                existingAddrs[addr.String()] = true
3✔
4821
        }
3✔
4822

4823
        // Add any missing addresses for this peer to persistentPeerAddr.
4824
        for _, addr := range addrs {
6✔
4825
                if existingAddrs[addr.String()] {
3✔
4826
                        continue
×
4827
                }
4828

4829
                s.persistentPeerAddrs[pubStr] = append(
3✔
4830
                        s.persistentPeerAddrs[pubStr],
3✔
4831
                        &lnwire.NetAddress{
3✔
4832
                                IdentityKey: p.IdentityKey(),
3✔
4833
                                Address:     addr,
3✔
4834
                                ChainNet:    p.NetAddress().ChainNet,
3✔
4835
                        },
3✔
4836
                )
3✔
4837
        }
4838

4839
        // Record the computed backoff in the backoff map.
4840
        backoff := s.nextPeerBackoff(pubStr, p.StartTime())
3✔
4841
        s.persistentPeersBackoff[pubStr] = backoff
3✔
4842

3✔
4843
        // Initialize a retry canceller for this peer if one does not
3✔
4844
        // exist.
3✔
4845
        cancelChan, ok := s.persistentRetryCancels[pubStr]
3✔
4846
        if !ok {
6✔
4847
                cancelChan = make(chan struct{})
3✔
4848
                s.persistentRetryCancels[pubStr] = cancelChan
3✔
4849
        }
3✔
4850

4851
        // We choose not to wait group this go routine since the Connect
4852
        // call can stall for arbitrarily long if we shutdown while an
4853
        // outbound connection attempt is being made.
4854
        go func() {
6✔
4855
                srvrLog.Debugf("Scheduling connection re-establishment to "+
3✔
4856
                        "persistent peer %x in %s",
3✔
4857
                        p.IdentityKey().SerializeCompressed(), backoff)
3✔
4858

3✔
4859
                select {
3✔
4860
                case <-time.After(backoff):
3✔
4861
                case <-cancelChan:
3✔
4862
                        return
3✔
4863
                case <-s.quit:
3✔
4864
                        return
3✔
4865
                }
4866

4867
                srvrLog.Debugf("Attempting to re-establish persistent "+
3✔
4868
                        "connection to peer %x",
3✔
4869
                        p.IdentityKey().SerializeCompressed())
3✔
4870

3✔
4871
                s.connectToPersistentPeer(pubStr)
3✔
4872
        }()
4873
}
4874

4875
// connectToPersistentPeer uses all the stored addresses for a peer to attempt
4876
// to connect to the peer. It creates connection requests if there are
4877
// currently none for a given address and it removes old connection requests
4878
// if the associated address is no longer in the latest address list for the
4879
// peer.
4880
func (s *server) connectToPersistentPeer(pubKeyStr string) {
3✔
4881
        s.mu.Lock()
3✔
4882
        defer s.mu.Unlock()
3✔
4883

3✔
4884
        // Create an easy lookup map of the addresses we have stored for the
3✔
4885
        // peer. We will remove entries from this map if we have existing
3✔
4886
        // connection requests for the associated address and then any leftover
3✔
4887
        // entries will indicate which addresses we should create new
3✔
4888
        // connection requests for.
3✔
4889
        addrMap := make(map[string]*lnwire.NetAddress)
3✔
4890
        for _, addr := range s.persistentPeerAddrs[pubKeyStr] {
6✔
4891
                addrMap[addr.String()] = addr
3✔
4892
        }
3✔
4893

4894
        // Go through each of the existing connection requests and
4895
        // check if they correspond to the latest set of addresses. If
4896
        // there is a connection requests that does not use one of the latest
4897
        // advertised addresses then remove that connection request.
4898
        var updatedConnReqs []*connmgr.ConnReq
3✔
4899
        for _, connReq := range s.persistentConnReqs[pubKeyStr] {
6✔
4900
                lnAddr := connReq.Addr.(*lnwire.NetAddress).Address.String()
3✔
4901

3✔
4902
                switch _, ok := addrMap[lnAddr]; ok {
3✔
4903
                // If the existing connection request is using one of the
4904
                // latest advertised addresses for the peer then we add it to
4905
                // updatedConnReqs and remove the associated address from
4906
                // addrMap so that we don't recreate this connReq later on.
4907
                case true:
×
4908
                        updatedConnReqs = append(
×
4909
                                updatedConnReqs, connReq,
×
4910
                        )
×
4911
                        delete(addrMap, lnAddr)
×
4912

4913
                // If the existing connection request is using an address that
4914
                // is not one of the latest advertised addresses for the peer
4915
                // then we remove the connecting request from the connection
4916
                // manager.
4917
                case false:
3✔
4918
                        srvrLog.Info(
3✔
4919
                                "Removing conn req:", connReq.Addr.String(),
3✔
4920
                        )
3✔
4921
                        s.connMgr.Remove(connReq.ID())
3✔
4922
                }
4923
        }
4924

4925
        s.persistentConnReqs[pubKeyStr] = updatedConnReqs
3✔
4926

3✔
4927
        cancelChan, ok := s.persistentRetryCancels[pubKeyStr]
3✔
4928
        if !ok {
6✔
4929
                cancelChan = make(chan struct{})
3✔
4930
                s.persistentRetryCancels[pubKeyStr] = cancelChan
3✔
4931
        }
3✔
4932

4933
        // Any addresses left in addrMap are new ones that we have not made
4934
        // connection requests for. So create new connection requests for those.
4935
        // If there is more than one address in the address map, stagger the
4936
        // creation of the connection requests for those.
4937
        go func() {
6✔
4938
                ticker := time.NewTicker(multiAddrConnectionStagger)
3✔
4939
                defer ticker.Stop()
3✔
4940

3✔
4941
                for _, addr := range addrMap {
6✔
4942
                        // Send the persistent connection request to the
3✔
4943
                        // connection manager, saving the request itself so we
3✔
4944
                        // can cancel/restart the process as needed.
3✔
4945
                        connReq := &connmgr.ConnReq{
3✔
4946
                                Addr:      addr,
3✔
4947
                                Permanent: true,
3✔
4948
                        }
3✔
4949

3✔
4950
                        s.mu.Lock()
3✔
4951
                        s.persistentConnReqs[pubKeyStr] = append(
3✔
4952
                                s.persistentConnReqs[pubKeyStr], connReq,
3✔
4953
                        )
3✔
4954
                        s.mu.Unlock()
3✔
4955

3✔
4956
                        srvrLog.Debugf("Attempting persistent connection to "+
3✔
4957
                                "channel peer %v", addr)
3✔
4958

3✔
4959
                        go s.connMgr.Connect(connReq)
3✔
4960

3✔
4961
                        select {
3✔
4962
                        case <-s.quit:
3✔
4963
                                return
3✔
4964
                        case <-cancelChan:
3✔
4965
                                return
3✔
4966
                        case <-ticker.C:
3✔
4967
                        }
4968
                }
4969
        }()
4970
}
4971

4972
// removePeerUnsafe removes the passed peer from the server's state of all
4973
// active peers.
4974
//
4975
// NOTE: Server mutex must be held when calling this function.
4976
func (s *server) removePeerUnsafe(p *peer.Brontide) {
3✔
4977
        if p == nil {
3✔
4978
                return
×
4979
        }
×
4980

4981
        srvrLog.Debugf("Removing peer %v", p)
3✔
4982

3✔
4983
        // Exit early if we have already been instructed to shutdown, the peers
3✔
4984
        // will be disconnected in the server shutdown process.
3✔
4985
        if s.Stopped() {
3✔
4986
                return
×
4987
        }
×
4988

4989
        // Capture the peer's public key and string representation.
4990
        pKey := p.PubKey()
3✔
4991
        pubSer := pKey[:]
3✔
4992
        pubStr := string(pubSer)
3✔
4993

3✔
4994
        delete(s.peersByPub, pubStr)
3✔
4995

3✔
4996
        if p.Inbound() {
6✔
4997
                delete(s.inboundPeers, pubStr)
3✔
4998
        } else {
6✔
4999
                delete(s.outboundPeers, pubStr)
3✔
5000
        }
3✔
5001

5002
        // When removing the peer we make sure to disconnect it asynchronously
5003
        // to avoid blocking the main server goroutine because it is holding the
5004
        // server's mutex. Disconnecting the peer might block and wait until the
5005
        // peer has fully started up. This can happen if an inbound and outbound
5006
        // race condition occurs.
5007
        s.wg.Add(1)
3✔
5008
        go func() {
6✔
5009
                defer s.wg.Done()
3✔
5010

3✔
5011
                p.Disconnect(fmt.Errorf("server: disconnecting peer %v", p))
3✔
5012

3✔
5013
                // If this peer had an active persistent connection request,
3✔
5014
                // remove it.
3✔
5015
                if p.ConnReq() != nil {
6✔
5016
                        s.connMgr.Remove(p.ConnReq().ID())
3✔
5017
                }
3✔
5018

5019
                // Remove the peer's access permission from the access manager.
5020
                peerPubStr := string(p.IdentityKey().SerializeCompressed())
3✔
5021
                s.peerAccessMan.removePeerAccess(peerPubStr)
3✔
5022

3✔
5023
                // Copy the peer's error buffer across to the server if it has
3✔
5024
                // any items in it so that we can restore peer errors across
3✔
5025
                // connections. We need to look up the error after the peer has
3✔
5026
                // been disconnected because we write the error in the
3✔
5027
                // `Disconnect` method.
3✔
5028
                s.mu.Lock()
3✔
5029
                if p.ErrorBuffer().Total() > 0 {
6✔
5030
                        s.peerErrors[pubStr] = p.ErrorBuffer()
3✔
5031
                }
3✔
5032
                s.mu.Unlock()
3✔
5033

3✔
5034
                // Inform the peer notifier of a peer offline event so that it
3✔
5035
                // can be reported to clients listening for peer events.
3✔
5036
                var pubKey [33]byte
3✔
5037
                copy(pubKey[:], pubSer)
3✔
5038

3✔
5039
                s.peerNotifier.NotifyPeerOffline(pubKey)
3✔
5040
        }()
5041
}
5042

5043
// ConnectToPeer requests that the server connect to a Lightning Network peer
5044
// at the specified address. This function will *block* until either a
5045
// connection is established, or the initial handshake process fails.
5046
//
5047
// NOTE: This function is safe for concurrent access.
5048
func (s *server) ConnectToPeer(addr *lnwire.NetAddress,
5049
        perm bool, timeout time.Duration) error {
3✔
5050

3✔
5051
        targetPub := string(addr.IdentityKey.SerializeCompressed())
3✔
5052

3✔
5053
        // Acquire mutex, but use explicit unlocking instead of defer for
3✔
5054
        // better granularity.  In certain conditions, this method requires
3✔
5055
        // making an outbound connection to a remote peer, which requires the
3✔
5056
        // lock to be released, and subsequently reacquired.
3✔
5057
        s.mu.Lock()
3✔
5058

3✔
5059
        // Ensure we're not already connected to this peer.
3✔
5060
        peer, err := s.findPeerByPubStr(targetPub)
3✔
5061

3✔
5062
        // When there's no error it means we already have a connection with this
3✔
5063
        // peer. If this is a dev environment with the `--unsafeconnect` flag
3✔
5064
        // set, we will ignore the existing connection and continue.
3✔
5065
        if err == nil && !s.cfg.Dev.GetUnsafeConnect() {
6✔
5066
                s.mu.Unlock()
3✔
5067
                return &errPeerAlreadyConnected{peer: peer}
3✔
5068
        }
3✔
5069

5070
        // Peer was not found, continue to pursue connection with peer.
5071

5072
        // If there's already a pending connection request for this pubkey,
5073
        // then we ignore this request to ensure we don't create a redundant
5074
        // connection.
5075
        if reqs, ok := s.persistentConnReqs[targetPub]; ok {
6✔
5076
                srvrLog.Warnf("Already have %d persistent connection "+
3✔
5077
                        "requests for %v, connecting anyway.", len(reqs), addr)
3✔
5078
        }
3✔
5079

5080
        // If there's not already a pending or active connection to this node,
5081
        // then instruct the connection manager to attempt to establish a
5082
        // persistent connection to the peer.
5083
        srvrLog.Debugf("Connecting to %v", addr)
3✔
5084
        if perm {
6✔
5085
                connReq := &connmgr.ConnReq{
3✔
5086
                        Addr:      addr,
3✔
5087
                        Permanent: true,
3✔
5088
                }
3✔
5089

3✔
5090
                // Since the user requested a permanent connection, we'll set
3✔
5091
                // the entry to true which will tell the server to continue
3✔
5092
                // reconnecting even if the number of channels with this peer is
3✔
5093
                // zero.
3✔
5094
                s.persistentPeers[targetPub] = true
3✔
5095
                if _, ok := s.persistentPeersBackoff[targetPub]; !ok {
6✔
5096
                        s.persistentPeersBackoff[targetPub] = s.cfg.MinBackoff
3✔
5097
                }
3✔
5098
                s.persistentConnReqs[targetPub] = append(
3✔
5099
                        s.persistentConnReqs[targetPub], connReq,
3✔
5100
                )
3✔
5101
                s.mu.Unlock()
3✔
5102

3✔
5103
                go s.connMgr.Connect(connReq)
3✔
5104

3✔
5105
                return nil
3✔
5106
        }
5107
        s.mu.Unlock()
3✔
5108

3✔
5109
        // If we're not making a persistent connection, then we'll attempt to
3✔
5110
        // connect to the target peer. If the we can't make the connection, or
3✔
5111
        // the crypto negotiation breaks down, then return an error to the
3✔
5112
        // caller.
3✔
5113
        errChan := make(chan error, 1)
3✔
5114
        s.connectToPeer(addr, errChan, timeout)
3✔
5115

3✔
5116
        select {
3✔
5117
        case err := <-errChan:
3✔
5118
                return err
3✔
5119
        case <-s.quit:
×
5120
                return ErrServerShuttingDown
×
5121
        }
5122
}
5123

5124
// connectToPeer establishes a connection to a remote peer. errChan is used to
5125
// notify the caller if the connection attempt has failed. Otherwise, it will be
5126
// closed.
5127
func (s *server) connectToPeer(addr *lnwire.NetAddress,
5128
        errChan chan<- error, timeout time.Duration) {
3✔
5129

3✔
5130
        conn, err := brontide.Dial(
3✔
5131
                s.identityECDH, addr, timeout, s.cfg.net.Dial,
3✔
5132
        )
3✔
5133
        if err != nil {
6✔
5134
                srvrLog.Errorf("Unable to connect to %v: %v", addr, err)
3✔
5135
                select {
3✔
5136
                case errChan <- err:
3✔
5137
                case <-s.quit:
×
5138
                }
5139
                return
3✔
5140
        }
5141

5142
        close(errChan)
3✔
5143

3✔
5144
        srvrLog.Tracef("Brontide dialer made local=%v, remote=%v",
3✔
5145
                conn.LocalAddr(), conn.RemoteAddr())
3✔
5146

3✔
5147
        s.OutboundPeerConnected(nil, conn)
3✔
5148
}
5149

5150
// DisconnectPeer sends the request to server to close the connection with peer
5151
// identified by public key.
5152
//
5153
// NOTE: This function is safe for concurrent access.
5154
func (s *server) DisconnectPeer(pubKey *btcec.PublicKey) error {
3✔
5155
        pubBytes := pubKey.SerializeCompressed()
3✔
5156
        pubStr := string(pubBytes)
3✔
5157

3✔
5158
        s.mu.Lock()
3✔
5159
        defer s.mu.Unlock()
3✔
5160

3✔
5161
        // Check that were actually connected to this peer. If not, then we'll
3✔
5162
        // exit in an error as we can't disconnect from a peer that we're not
3✔
5163
        // currently connected to.
3✔
5164
        peer, err := s.findPeerByPubStr(pubStr)
3✔
5165
        if err == ErrPeerNotConnected {
6✔
5166
                return fmt.Errorf("peer %x is not connected", pubBytes)
3✔
5167
        }
3✔
5168

5169
        srvrLog.Infof("Disconnecting from %v", peer)
3✔
5170

3✔
5171
        s.cancelConnReqs(pubStr, nil)
3✔
5172

3✔
5173
        // If this peer was formerly a persistent connection, then we'll remove
3✔
5174
        // them from this map so we don't attempt to re-connect after we
3✔
5175
        // disconnect.
3✔
5176
        delete(s.persistentPeers, pubStr)
3✔
5177
        delete(s.persistentPeersBackoff, pubStr)
3✔
5178

3✔
5179
        // Remove the peer by calling Disconnect. Previously this was done with
3✔
5180
        // removePeerUnsafe, which bypassed the peerTerminationWatcher.
3✔
5181
        //
3✔
5182
        // NOTE: We call it in a goroutine to avoid blocking the main server
3✔
5183
        // goroutine because we might hold the server's mutex.
3✔
5184
        go peer.Disconnect(fmt.Errorf("server: DisconnectPeer called"))
3✔
5185

3✔
5186
        return nil
3✔
5187
}
5188

5189
// OpenChannel sends a request to the server to open a channel to the specified
5190
// peer identified by nodeKey with the passed channel funding parameters.
5191
//
5192
// NOTE: This function is safe for concurrent access.
5193
func (s *server) OpenChannel(
5194
        req *funding.InitFundingMsg) (chan *lnrpc.OpenStatusUpdate, chan error) {
3✔
5195

3✔
5196
        // The updateChan will have a buffer of 2, since we expect a ChanPending
3✔
5197
        // + a ChanOpen update, and we want to make sure the funding process is
3✔
5198
        // not blocked if the caller is not reading the updates.
3✔
5199
        req.Updates = make(chan *lnrpc.OpenStatusUpdate, 2)
3✔
5200
        req.Err = make(chan error, 1)
3✔
5201

3✔
5202
        // First attempt to locate the target peer to open a channel with, if
3✔
5203
        // we're unable to locate the peer then this request will fail.
3✔
5204
        pubKeyBytes := req.TargetPubkey.SerializeCompressed()
3✔
5205
        s.mu.RLock()
3✔
5206
        peer, ok := s.peersByPub[string(pubKeyBytes)]
3✔
5207
        if !ok {
3✔
5208
                s.mu.RUnlock()
×
5209

×
5210
                req.Err <- fmt.Errorf("peer %x is not online", pubKeyBytes)
×
5211
                return req.Updates, req.Err
×
5212
        }
×
5213
        req.Peer = peer
3✔
5214
        s.mu.RUnlock()
3✔
5215

3✔
5216
        // We'll wait until the peer is active before beginning the channel
3✔
5217
        // opening process.
3✔
5218
        select {
3✔
5219
        case <-peer.ActiveSignal():
3✔
5220
        case <-peer.QuitSignal():
×
5221
                req.Err <- fmt.Errorf("peer %x disconnected", pubKeyBytes)
×
5222
                return req.Updates, req.Err
×
5223
        case <-s.quit:
×
5224
                req.Err <- ErrServerShuttingDown
×
5225
                return req.Updates, req.Err
×
5226
        }
5227

5228
        // If the fee rate wasn't specified at this point we fail the funding
5229
        // because of the missing fee rate information. The caller of the
5230
        // `OpenChannel` method needs to make sure that default values for the
5231
        // fee rate are set beforehand.
5232
        if req.FundingFeePerKw == 0 {
3✔
5233
                req.Err <- fmt.Errorf("no FundingFeePerKw specified for " +
×
5234
                        "the channel opening transaction")
×
5235

×
5236
                return req.Updates, req.Err
×
5237
        }
×
5238

5239
        // Spawn a goroutine to send the funding workflow request to the funding
5240
        // manager. This allows the server to continue handling queries instead
5241
        // of blocking on this request which is exported as a synchronous
5242
        // request to the outside world.
5243
        go s.fundingMgr.InitFundingWorkflow(req)
3✔
5244

3✔
5245
        return req.Updates, req.Err
3✔
5246
}
5247

5248
// Peers returns a slice of all active peers.
5249
//
5250
// NOTE: This function is safe for concurrent access.
5251
func (s *server) Peers() []*peer.Brontide {
3✔
5252
        s.mu.RLock()
3✔
5253
        defer s.mu.RUnlock()
3✔
5254

3✔
5255
        peers := make([]*peer.Brontide, 0, len(s.peersByPub))
3✔
5256
        for _, peer := range s.peersByPub {
6✔
5257
                peers = append(peers, peer)
3✔
5258
        }
3✔
5259

5260
        return peers
3✔
5261
}
5262

5263
// computeNextBackoff uses a truncated exponential backoff to compute the next
5264
// backoff using the value of the exiting backoff. The returned duration is
5265
// randomized in either direction by 1/20 to prevent tight loops from
5266
// stabilizing.
5267
func computeNextBackoff(currBackoff, maxBackoff time.Duration) time.Duration {
3✔
5268
        // Double the current backoff, truncating if it exceeds our maximum.
3✔
5269
        nextBackoff := 2 * currBackoff
3✔
5270
        if nextBackoff > maxBackoff {
6✔
5271
                nextBackoff = maxBackoff
3✔
5272
        }
3✔
5273

5274
        // Using 1/10 of our duration as a margin, compute a random offset to
5275
        // avoid the nodes entering connection cycles.
5276
        margin := nextBackoff / 10
3✔
5277

3✔
5278
        var wiggle big.Int
3✔
5279
        wiggle.SetUint64(uint64(margin))
3✔
5280
        if _, err := rand.Int(rand.Reader, &wiggle); err != nil {
3✔
5281
                // Randomizing is not mission critical, so we'll just return the
×
5282
                // current backoff.
×
5283
                return nextBackoff
×
5284
        }
×
5285

5286
        // Otherwise add in our wiggle, but subtract out half of the margin so
5287
        // that the backoff can tweaked by 1/20 in either direction.
5288
        return nextBackoff + (time.Duration(wiggle.Uint64()) - margin/2)
3✔
5289
}
5290

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

5295
// fetchNodeAdvertisedAddrs attempts to fetch the advertised addresses of a node.
5296
func (s *server) fetchNodeAdvertisedAddrs(ctx context.Context,
5297
        pub *btcec.PublicKey) ([]net.Addr, error) {
3✔
5298

3✔
5299
        vertex, err := route.NewVertexFromBytes(pub.SerializeCompressed())
3✔
5300
        if err != nil {
3✔
5301
                return nil, err
×
5302
        }
×
5303

5304
        node, err := s.graphDB.FetchLightningNode(ctx, vertex)
3✔
5305
        if err != nil {
6✔
5306
                return nil, err
3✔
5307
        }
3✔
5308

5309
        if len(node.Addresses) == 0 {
6✔
5310
                return nil, errNoAdvertisedAddr
3✔
5311
        }
3✔
5312

5313
        return node.Addresses, nil
3✔
5314
}
5315

5316
// fetchLastChanUpdate returns a function which is able to retrieve our latest
5317
// channel update for a target channel.
5318
func (s *server) fetchLastChanUpdate() func(lnwire.ShortChannelID) (
5319
        *lnwire.ChannelUpdate1, error) {
3✔
5320

3✔
5321
        ourPubKey := s.identityECDH.PubKey().SerializeCompressed()
3✔
5322
        return func(cid lnwire.ShortChannelID) (*lnwire.ChannelUpdate1, error) {
6✔
5323
                info, edge1, edge2, err := s.graphBuilder.GetChannelByID(cid)
3✔
5324
                if err != nil {
6✔
5325
                        return nil, err
3✔
5326
                }
3✔
5327

5328
                return netann.ExtractChannelUpdate(
3✔
5329
                        ourPubKey[:], info, edge1, edge2,
3✔
5330
                )
3✔
5331
        }
5332
}
5333

5334
// applyChannelUpdate applies the channel update to the different sub-systems of
5335
// the server. The useAlias boolean denotes whether or not to send an alias in
5336
// place of the real SCID.
5337
func (s *server) applyChannelUpdate(update *lnwire.ChannelUpdate1,
5338
        op *wire.OutPoint, useAlias bool) error {
3✔
5339

3✔
5340
        var (
3✔
5341
                peerAlias    *lnwire.ShortChannelID
3✔
5342
                defaultAlias lnwire.ShortChannelID
3✔
5343
        )
3✔
5344

3✔
5345
        chanID := lnwire.NewChanIDFromOutPoint(*op)
3✔
5346

3✔
5347
        // Fetch the peer's alias from the lnwire.ChannelID so it can be used
3✔
5348
        // in the ChannelUpdate if it hasn't been announced yet.
3✔
5349
        if useAlias {
6✔
5350
                foundAlias, _ := s.aliasMgr.GetPeerAlias(chanID)
3✔
5351
                if foundAlias != defaultAlias {
6✔
5352
                        peerAlias = &foundAlias
3✔
5353
                }
3✔
5354
        }
5355

5356
        errChan := s.authGossiper.ProcessLocalAnnouncement(
3✔
5357
                update, discovery.RemoteAlias(peerAlias),
3✔
5358
        )
3✔
5359
        select {
3✔
5360
        case err := <-errChan:
3✔
5361
                return err
3✔
5362
        case <-s.quit:
×
5363
                return ErrServerShuttingDown
×
5364
        }
5365
}
5366

5367
// SendCustomMessage sends a custom message to the peer with the specified
5368
// pubkey.
5369
func (s *server) SendCustomMessage(peerPub [33]byte, msgType lnwire.MessageType,
5370
        data []byte) error {
3✔
5371

3✔
5372
        peer, err := s.FindPeerByPubStr(string(peerPub[:]))
3✔
5373
        if err != nil {
3✔
5374
                return err
×
5375
        }
×
5376

5377
        // We'll wait until the peer is active.
5378
        select {
3✔
5379
        case <-peer.ActiveSignal():
3✔
5380
        case <-peer.QuitSignal():
×
5381
                return fmt.Errorf("peer %x disconnected", peerPub)
×
5382
        case <-s.quit:
×
5383
                return ErrServerShuttingDown
×
5384
        }
5385

5386
        msg, err := lnwire.NewCustom(msgType, data)
3✔
5387
        if err != nil {
6✔
5388
                return err
3✔
5389
        }
3✔
5390

5391
        // Send the message as low-priority. For now we assume that all
5392
        // application-defined message are low priority.
5393
        return peer.SendMessageLazy(true, msg)
3✔
5394
}
5395

5396
// newSweepPkScriptGen creates closure that generates a new public key script
5397
// which should be used to sweep any funds into the on-chain wallet.
5398
// Specifically, the script generated is a version 0, pay-to-witness-pubkey-hash
5399
// (p2wkh) output.
5400
func newSweepPkScriptGen(
5401
        wallet lnwallet.WalletController,
5402
        netParams *chaincfg.Params) func() fn.Result[lnwallet.AddrWithKey] {
3✔
5403

3✔
5404
        return func() fn.Result[lnwallet.AddrWithKey] {
6✔
5405
                sweepAddr, err := wallet.NewAddress(
3✔
5406
                        lnwallet.TaprootPubkey, false,
3✔
5407
                        lnwallet.DefaultAccountName,
3✔
5408
                )
3✔
5409
                if err != nil {
3✔
5410
                        return fn.Err[lnwallet.AddrWithKey](err)
×
5411
                }
×
5412

5413
                addr, err := txscript.PayToAddrScript(sweepAddr)
3✔
5414
                if err != nil {
3✔
5415
                        return fn.Err[lnwallet.AddrWithKey](err)
×
5416
                }
×
5417

5418
                internalKeyDesc, err := lnwallet.InternalKeyForAddr(
3✔
5419
                        wallet, netParams, addr,
3✔
5420
                )
3✔
5421
                if err != nil {
3✔
5422
                        return fn.Err[lnwallet.AddrWithKey](err)
×
5423
                }
×
5424

5425
                return fn.Ok(lnwallet.AddrWithKey{
3✔
5426
                        DeliveryAddress: addr,
3✔
5427
                        InternalKey:     internalKeyDesc,
3✔
5428
                })
3✔
5429
        }
5430
}
5431

5432
// fetchClosedChannelSCIDs returns a set of SCIDs that have their force closing
5433
// finished.
5434
func (s *server) fetchClosedChannelSCIDs() map[lnwire.ShortChannelID]struct{} {
3✔
5435
        // Get a list of closed channels.
3✔
5436
        channels, err := s.chanStateDB.FetchClosedChannels(false)
3✔
5437
        if err != nil {
3✔
5438
                srvrLog.Errorf("Failed to fetch closed channels: %v", err)
×
5439
                return nil
×
5440
        }
×
5441

5442
        // Save the SCIDs in a map.
5443
        closedSCIDs := make(map[lnwire.ShortChannelID]struct{}, len(channels))
3✔
5444
        for _, c := range channels {
6✔
5445
                // If the channel is not pending, its FC has been finalized.
3✔
5446
                if !c.IsPending {
6✔
5447
                        closedSCIDs[c.ShortChanID] = struct{}{}
3✔
5448
                }
3✔
5449
        }
5450

5451
        // Double check whether the reported closed channel has indeed finished
5452
        // closing.
5453
        //
5454
        // NOTE: There are misalignments regarding when a channel's FC is
5455
        // marked as finalized. We double check the pending channels to make
5456
        // sure the returned SCIDs are indeed terminated.
5457
        //
5458
        // TODO(yy): fix the misalignments in `FetchClosedChannels`.
5459
        pendings, err := s.chanStateDB.FetchPendingChannels()
3✔
5460
        if err != nil {
3✔
5461
                srvrLog.Errorf("Failed to fetch pending channels: %v", err)
×
5462
                return nil
×
5463
        }
×
5464

5465
        for _, c := range pendings {
6✔
5466
                if _, ok := closedSCIDs[c.ShortChannelID]; !ok {
6✔
5467
                        continue
3✔
5468
                }
5469

5470
                // If the channel is still reported as pending, remove it from
5471
                // the map.
5472
                delete(closedSCIDs, c.ShortChannelID)
×
5473

×
5474
                srvrLog.Warnf("Channel=%v is prematurely marked as finalized",
×
5475
                        c.ShortChannelID)
×
5476
        }
5477

5478
        return closedSCIDs
3✔
5479
}
5480

5481
// getStartingBeat returns the current beat. This is used during the startup to
5482
// initialize blockbeat consumers.
5483
func (s *server) getStartingBeat() (*chainio.Beat, error) {
3✔
5484
        // beat is the current blockbeat.
3✔
5485
        var beat *chainio.Beat
3✔
5486

3✔
5487
        // If the node is configured with nochainbackend mode (remote signer),
3✔
5488
        // we will skip fetching the best block.
3✔
5489
        if s.cfg.Bitcoin.Node == "nochainbackend" {
3✔
5490
                srvrLog.Info("Skipping block notification for nochainbackend " +
×
5491
                        "mode")
×
5492

×
5493
                return &chainio.Beat{}, nil
×
5494
        }
×
5495

5496
        // We should get a notification with the current best block immediately
5497
        // by passing a nil block.
5498
        blockEpochs, err := s.cc.ChainNotifier.RegisterBlockEpochNtfn(nil)
3✔
5499
        if err != nil {
3✔
5500
                return beat, fmt.Errorf("register block epoch ntfn: %w", err)
×
5501
        }
×
5502
        defer blockEpochs.Cancel()
3✔
5503

3✔
5504
        // We registered for the block epochs with a nil request. The notifier
3✔
5505
        // should send us the current best block immediately. So we need to
3✔
5506
        // wait for it here because we need to know the current best height.
3✔
5507
        select {
3✔
5508
        case bestBlock := <-blockEpochs.Epochs:
3✔
5509
                srvrLog.Infof("Received initial block %v at height %d",
3✔
5510
                        bestBlock.Hash, bestBlock.Height)
3✔
5511

3✔
5512
                // Update the current blockbeat.
3✔
5513
                beat = chainio.NewBeat(*bestBlock)
3✔
5514

5515
        case <-s.quit:
×
5516
                srvrLog.Debug("LND shutting down")
×
5517
        }
5518

5519
        return beat, nil
3✔
5520
}
5521

5522
// ChanHasRbfCoopCloser returns true if the channel as identifier by the channel
5523
// point has an active RBF chan closer.
5524
func (s *server) ChanHasRbfCoopCloser(peerPub *btcec.PublicKey,
5525
        chanPoint wire.OutPoint) bool {
3✔
5526

3✔
5527
        pubBytes := peerPub.SerializeCompressed()
3✔
5528

3✔
5529
        s.mu.RLock()
3✔
5530
        targetPeer, ok := s.peersByPub[string(pubBytes)]
3✔
5531
        s.mu.RUnlock()
3✔
5532
        if !ok {
3✔
5533
                return false
×
5534
        }
×
5535

5536
        return targetPeer.ChanHasRbfCoopCloser(chanPoint)
3✔
5537
}
5538

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

3✔
5547
        // First, we'll attempt to look up the channel based on it's
3✔
5548
        // ChannelPoint.
3✔
5549
        channel, err := s.chanStateDB.FetchChannel(chanPoint)
3✔
5550
        if err != nil {
3✔
5551
                return nil, fmt.Errorf("unable to fetch channel: %w", err)
×
5552
        }
×
5553

5554
        // From the channel, we can now get the pubkey of the peer, then use
5555
        // that to eventually get the chan closer.
5556
        peerPub := channel.IdentityPub.SerializeCompressed()
3✔
5557

3✔
5558
        // Now that we have the peer pub, we can look up the peer itself.
3✔
5559
        s.mu.RLock()
3✔
5560
        targetPeer, ok := s.peersByPub[string(peerPub)]
3✔
5561
        s.mu.RUnlock()
3✔
5562
        if !ok {
3✔
5563
                return nil, fmt.Errorf("peer for ChannelPoint(%v) is "+
×
5564
                        "not online", chanPoint)
×
5565
        }
×
5566

5567
        closeUpdates, err := targetPeer.TriggerCoopCloseRbfBump(
3✔
5568
                ctx, chanPoint, feeRate, deliveryScript,
3✔
5569
        )
3✔
5570
        if err != nil {
3✔
5571
                return nil, fmt.Errorf("unable to trigger coop rbf fee bump: "+
×
5572
                        "%w", err)
×
5573
        }
×
5574

5575
        return closeUpdates, nil
3✔
5576
}
5577

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

3✔
5586
        // If the channel is present in the switch, then the request should flow
3✔
5587
        // through the switch instead.
3✔
5588
        chanID := lnwire.NewChanIDFromOutPoint(chanPoint)
3✔
5589
        if _, err := s.htlcSwitch.GetLink(chanID); err == nil {
3✔
5590
                return nil, fmt.Errorf("ChannelPoint(%v) is active in link, "+
×
5591
                        "invalid request", chanPoint)
×
5592
        }
×
5593

5594
        // At this point, we know that the channel isn't present in the link, so
5595
        // we'll check to see if we have an entry in the active chan closer map.
5596
        updates, err := s.attemptCoopRbfFeeBump(
3✔
5597
                ctx, chanPoint, feeRate, deliveryScript,
3✔
5598
        )
3✔
5599
        if err != nil {
3✔
5600
                return nil, fmt.Errorf("unable to attempt coop rbf fee bump "+
×
5601
                        "ChannelPoint(%v)", chanPoint)
×
5602
        }
×
5603

5604
        return updates, nil
3✔
5605
}
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