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

lightningnetwork / lnd / 13315153898

13 Feb 2025 07:04PM UTC coverage: 58.791% (+9.4%) from 49.357%
13315153898

Pull #9458

github

Crypt-iQ
release-notes: update for 0.19.0
Pull Request #9458: multi+server.go: add initial permissions for some peers

332 of 551 new or added lines in 9 files covered. (60.25%)

25 existing lines in 8 files now uncovered.

136364 of 231946 relevant lines covered (58.79%)

19200.47 hits per line

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

63.26
/server.go
1
package lnd
2

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

213
        start sync.Once
214
        stop  sync.Once
215

216
        cfg *Config
217

218
        implCfg *ImplementationCfg
219

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

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

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

231
        chanStatusMgr *netann.ChanStatusManager
232

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

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

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

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

253
        mu sync.RWMutex
254

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

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

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

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

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

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

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

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

305
        cc *chainreg.ChainControl
306

307
        fundingMgr *funding.Manager
308

309
        graphDB *graphdb.ChannelGraph
310

311
        chanStateDB *channeldb.ChannelStateDB
312

313
        addrSource channeldb.AddrSource
314

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

319
        invoicesDB invoices.InvoiceDB
320

321
        aliasMgr *aliasmgr.Manager
322

323
        htlcSwitch *htlcswitch.Switch
324

325
        interceptableSwitch *htlcswitch.InterceptableSwitch
326

327
        invoices *invoices.InvoiceRegistry
328

329
        invoiceHtlcModifier *invoices.HtlcModificationInterceptor
330

331
        channelNotifier *channelnotifier.ChannelNotifier
332

333
        peerNotifier *peernotifier.PeerNotifier
334

335
        htlcNotifier *htlcswitch.HtlcNotifier
336

337
        witnessBeacon contractcourt.WitnessBeacon
338

339
        breachArbitrator *contractcourt.BreachArbitrator
340

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

344
        graphBuilder *graph.Builder
345

346
        chanRouter *routing.ChannelRouter
347

348
        controlTower routing.ControlTower
349

350
        authGossiper *discovery.AuthenticatedGossiper
351

352
        localChanMgr *localchans.Manager
353

354
        utxoNursery *contractcourt.UtxoNursery
355

356
        sweeper *sweep.UtxoSweeper
357

358
        chainArb *contractcourt.ChainArbitrator
359

360
        sphinx *hop.OnionProcessor
361

362
        towerClientMgr *wtclient.Manager
363

364
        connMgr *connmgr.ConnManager
365

366
        sigPool *lnwallet.SigPool
367

368
        writePool *pool.Write
369

370
        readPool *pool.Read
371

372
        tlsManager *TLSManager
373

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

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

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

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

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

396
        hostAnn *netann.HostAnnouncer
397

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

401
        customMessageServer *subscribe.Server
402

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

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

410
        // banScoreMtx is used for the server's ban tracking. If the server
411
        // mutex is also going to be locked, ensure that this is locked after
412
        // the server mutex.
413
        banScoreMtx sync.RWMutex
414

415
        // peerCounts is a mapping from remote public key to {bool, uint64}
416
        // where the bool indicates that we have an open/closed channel with
417
        // the peer and where the uint64 indicates the number of pending-open
418
        // channels we currently have with them. This mapping will be used to
419
        // determine access permissions for the peer.
420
        //
421
        // NOTE: This MUST be accessed with the banScoreMtx held.
422
        peerCounts map[string]channeldb.ChanCount
423

424
        // peerScores stores each connected peer's access status. This MUST be
425
        // accessed with the banScoreMtx held.
426
        peerScores map[string]peerSlotStatus
427

428
        // numRestricted tracks the number of peers with restricted access in
429
        // peerScores. This MUST be accessed with the banScoreMtx held.
430
        numRestricted uint64
431

432
        quit chan struct{}
433

434
        wg sync.WaitGroup
435
}
436

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

445
        s.wg.Add(1)
3✔
446
        go func() {
6✔
447
                defer func() {
6✔
448
                        graphSub.Cancel()
3✔
449
                        s.wg.Done()
3✔
450
                }()
3✔
451

452
                for {
6✔
453
                        select {
3✔
454
                        case <-s.quit:
3✔
455
                                return
3✔
456

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

464
                                for _, update := range topChange.NodeUpdates {
6✔
465
                                        pubKeyStr := string(
3✔
466
                                                update.IdentityKey.
3✔
467
                                                        SerializeCompressed(),
3✔
468
                                        )
3✔
469

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

479
                                        addrs := make([]*lnwire.NetAddress, 0,
3✔
480
                                                len(update.Addresses))
3✔
481

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

492
                                        s.mu.Lock()
3✔
493

3✔
494
                                        // Update the stored addresses for this
3✔
495
                                        // to peer to reflect the new set.
3✔
496
                                        s.persistentPeerAddrs[pubKeyStr] = addrs
3✔
497

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

508
                                        s.mu.Unlock()
3✔
509

3✔
510
                                        s.connectToPersistentPeer(pubKeyStr)
3✔
511
                                }
512
                        }
513
                }
514
        }()
515

516
        return nil
3✔
517
}
518

519
// CustomMessage is a custom message that is received from a peer.
520
type CustomMessage struct {
521
        // Peer is the peer pubkey
522
        Peer [33]byte
523

524
        // Msg is the custom wire message.
525
        Msg *lnwire.Custom
526
}
527

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

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

552
        if tor.IsOnionHost(host) {
3✔
553
                return &tor.OnionAddr{OnionService: host, Port: port}, nil
×
554
        }
×
555

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

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

3✔
569
        return func(a net.Addr) (net.Conn, error) {
6✔
570
                lnAddr := a.(*lnwire.NetAddress)
3✔
571
                return brontide.Dial(idKey, lnAddr, timeout, netCfg.Dial)
3✔
572
        }
3✔
573
}
574

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

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

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

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

3✔
600
        netParams := cfg.ActiveNetParams.Params
3✔
601

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

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

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

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

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

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

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

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

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

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

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

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

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

3✔
697
                listenAddrs: listenAddrs,
3✔
698

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

3✔
703
                torController: torController,
3✔
704

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

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

3✔
721
                invoiceHtlcModifier: invoiceHtlcModifier,
3✔
722

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

3✔
725
                tlsManager: tlsManager,
3✔
726

3✔
727
                peerCounts: make(map[string]channeldb.ChanCount),
3✔
728
                peerScores: make(map[string]peerSlotStatus),
3✔
729

3✔
730
                featureMgr: featureMgr,
3✔
731
                quit:       make(chan struct{}),
3✔
732
        }
3✔
733

3✔
734
        // Initialize the map that will contain ban scores.
3✔
735
        genesisHash := *s.cfg.ActiveNetParams.GenesisHash
3✔
736
        counts, err := s.chanStateDB.FetchPermAndTempPeers(genesisHash[:])
3✔
737
        if err != nil {
3✔
NEW
738
                return nil, err
×
NEW
739
        }
×
740

741
        // We'll populate the server's peerCounts map with the counts fetched
742
        // from channeldb. Also note that we haven't yet connected to these
743
        // peers.
744
        //
745
        // NOTE: We don't need to acquire banStoreMtx here or below.
746
        for peerHex, count := range counts {
6✔
747
                s.peerCounts[peerHex] = count
3✔
748
        }
3✔
749

750
        // Start the low-level services once they are initialized.
751
        //
752
        // TODO(yy): break the server startup into four steps,
753
        // 1. init the low-level services.
754
        // 2. start the low-level services.
755
        // 3. init the high-level services.
756
        // 4. start the high-level services.
757
        if err := s.startLowLevelServices(); err != nil {
3✔
758
                return nil, err
×
759
        }
×
760

761
        currentHash, currentHeight, err := s.cc.ChainIO.GetBestBlock()
3✔
762
        if err != nil {
3✔
763
                return nil, err
×
764
        }
×
765

766
        expiryWatcher := invoices.NewInvoiceExpiryWatcher(
3✔
767
                clock.NewDefaultClock(), cfg.Invoices.HoldExpiryDelta,
3✔
768
                uint32(currentHeight), currentHash, cc.ChainNotifier,
3✔
769
        )
3✔
770
        s.invoices = invoices.NewRegistry(
3✔
771
                dbs.InvoiceDB, expiryWatcher, &registryConfig,
3✔
772
        )
3✔
773

3✔
774
        s.htlcNotifier = htlcswitch.NewHtlcNotifier(time.Now)
3✔
775

3✔
776
        thresholdSats := btcutil.Amount(cfg.MaxFeeExposure)
3✔
777
        thresholdMSats := lnwire.NewMSatFromSatoshis(thresholdSats)
3✔
778

3✔
779
        linkUpdater := func(shortID lnwire.ShortChannelID) error {
6✔
780
                link, err := s.htlcSwitch.GetLinkByShortID(shortID)
3✔
781
                if err != nil {
3✔
782
                        return err
×
783
                }
×
784

785
                s.htlcSwitch.UpdateLinkAliases(link)
3✔
786

3✔
787
                return nil
3✔
788
        }
789

790
        s.aliasMgr, err = aliasmgr.NewManager(dbs.ChanStateDB, linkUpdater)
3✔
791
        if err != nil {
3✔
792
                return nil, err
×
793
        }
×
794

795
        s.htlcSwitch, err = htlcswitch.New(htlcswitch.Config{
3✔
796
                DB:                   dbs.ChanStateDB,
3✔
797
                FetchAllOpenChannels: s.chanStateDB.FetchAllOpenChannels,
3✔
798
                FetchAllChannels:     s.chanStateDB.FetchAllChannels,
3✔
799
                FetchClosedChannels:  s.chanStateDB.FetchClosedChannels,
3✔
800
                LocalChannelClose: func(pubKey []byte,
3✔
801
                        request *htlcswitch.ChanClose) {
6✔
802

3✔
803
                        peer, err := s.FindPeerByPubStr(string(pubKey))
3✔
804
                        if err != nil {
3✔
805
                                srvrLog.Errorf("unable to close channel, peer"+
×
806
                                        " with %v id can't be found: %v",
×
807
                                        pubKey, err,
×
808
                                )
×
809
                                return
×
810
                        }
×
811

812
                        peer.HandleLocalCloseChanReqs(request)
3✔
813
                },
814
                FwdingLog:              dbs.ChanStateDB.ForwardingLog(),
815
                SwitchPackager:         channeldb.NewSwitchPackager(),
816
                ExtractErrorEncrypter:  s.sphinx.ExtractErrorEncrypter,
817
                FetchLastChannelUpdate: s.fetchLastChanUpdate(),
818
                Notifier:               s.cc.ChainNotifier,
819
                HtlcNotifier:           s.htlcNotifier,
820
                FwdEventTicker:         ticker.New(htlcswitch.DefaultFwdEventInterval),
821
                LogEventTicker:         ticker.New(htlcswitch.DefaultLogInterval),
822
                AckEventTicker:         ticker.New(htlcswitch.DefaultAckInterval),
823
                AllowCircularRoute:     cfg.AllowCircularRoute,
824
                RejectHTLC:             cfg.RejectHTLC,
825
                Clock:                  clock.NewDefaultClock(),
826
                MailboxDeliveryTimeout: cfg.Htlcswitch.MailboxDeliveryTimeout,
827
                MaxFeeExposure:         thresholdMSats,
828
                SignAliasUpdate:        s.signAliasUpdate,
829
                IsAlias:                aliasmgr.IsAlias,
830
        }, uint32(currentHeight))
831
        if err != nil {
3✔
832
                return nil, err
×
833
        }
×
834
        s.interceptableSwitch, err = htlcswitch.NewInterceptableSwitch(
3✔
835
                &htlcswitch.InterceptableSwitchConfig{
3✔
836
                        Switch:             s.htlcSwitch,
3✔
837
                        CltvRejectDelta:    lncfg.DefaultFinalCltvRejectDelta,
3✔
838
                        CltvInterceptDelta: lncfg.DefaultCltvInterceptDelta,
3✔
839
                        RequireInterceptor: s.cfg.RequireInterceptor,
3✔
840
                        Notifier:           s.cc.ChainNotifier,
3✔
841
                },
3✔
842
        )
3✔
843
        if err != nil {
3✔
844
                return nil, err
×
845
        }
×
846

847
        s.witnessBeacon = newPreimageBeacon(
3✔
848
                dbs.ChanStateDB.NewWitnessCache(),
3✔
849
                s.interceptableSwitch.ForwardPacket,
3✔
850
        )
3✔
851

3✔
852
        chanStatusMgrCfg := &netann.ChanStatusConfig{
3✔
853
                ChanStatusSampleInterval: cfg.ChanStatusSampleInterval,
3✔
854
                ChanEnableTimeout:        cfg.ChanEnableTimeout,
3✔
855
                ChanDisableTimeout:       cfg.ChanDisableTimeout,
3✔
856
                OurPubKey:                nodeKeyDesc.PubKey,
3✔
857
                OurKeyLoc:                nodeKeyDesc.KeyLocator,
3✔
858
                MessageSigner:            s.nodeSigner,
3✔
859
                IsChannelActive:          s.htlcSwitch.HasActiveLink,
3✔
860
                ApplyChannelUpdate:       s.applyChannelUpdate,
3✔
861
                DB:                       s.chanStateDB,
3✔
862
                Graph:                    dbs.GraphDB,
3✔
863
        }
3✔
864

3✔
865
        chanStatusMgr, err := netann.NewChanStatusManager(chanStatusMgrCfg)
3✔
866
        if err != nil {
3✔
867
                return nil, err
×
868
        }
×
869
        s.chanStatusMgr = chanStatusMgr
3✔
870

3✔
871
        // If enabled, use either UPnP or NAT-PMP to automatically configure
3✔
872
        // port forwarding for users behind a NAT.
3✔
873
        if cfg.NAT {
3✔
874
                srvrLog.Info("Scanning local network for a UPnP enabled device")
×
875

×
876
                discoveryTimeout := time.Duration(10 * time.Second)
×
877

×
878
                ctx, cancel := context.WithTimeout(
×
879
                        context.Background(), discoveryTimeout,
×
880
                )
×
881
                defer cancel()
×
882
                upnp, err := nat.DiscoverUPnP(ctx)
×
883
                if err == nil {
×
884
                        s.natTraversal = upnp
×
885
                } else {
×
886
                        // If we were not able to discover a UPnP enabled device
×
887
                        // on the local network, we'll fall back to attempting
×
888
                        // to discover a NAT-PMP enabled device.
×
889
                        srvrLog.Errorf("Unable to discover a UPnP enabled "+
×
890
                                "device on the local network: %v", err)
×
891

×
892
                        srvrLog.Info("Scanning local network for a NAT-PMP " +
×
893
                                "enabled device")
×
894

×
895
                        pmp, err := nat.DiscoverPMP(discoveryTimeout)
×
896
                        if err != nil {
×
897
                                err := fmt.Errorf("unable to discover a "+
×
898
                                        "NAT-PMP enabled device on the local "+
×
899
                                        "network: %v", err)
×
900
                                srvrLog.Error(err)
×
901
                                return nil, err
×
902
                        }
×
903

904
                        s.natTraversal = pmp
×
905
                }
906
        }
907

908
        // If we were requested to automatically configure port forwarding,
909
        // we'll use the ports that the server will be listening on.
910
        externalIPStrings := make([]string, len(cfg.ExternalIPs))
3✔
911
        for idx, ip := range cfg.ExternalIPs {
6✔
912
                externalIPStrings[idx] = ip.String()
3✔
913
        }
3✔
914
        if s.natTraversal != nil {
3✔
915
                listenPorts := make([]uint16, 0, len(listenAddrs))
×
916
                for _, listenAddr := range listenAddrs {
×
917
                        // At this point, the listen addresses should have
×
918
                        // already been normalized, so it's safe to ignore the
×
919
                        // errors.
×
920
                        _, portStr, _ := net.SplitHostPort(listenAddr.String())
×
921
                        port, _ := strconv.Atoi(portStr)
×
922

×
923
                        listenPorts = append(listenPorts, uint16(port))
×
924
                }
×
925

926
                ips, err := s.configurePortForwarding(listenPorts...)
×
927
                if err != nil {
×
928
                        srvrLog.Errorf("Unable to automatically set up port "+
×
929
                                "forwarding using %s: %v",
×
930
                                s.natTraversal.Name(), err)
×
931
                } else {
×
932
                        srvrLog.Infof("Automatically set up port forwarding "+
×
933
                                "using %s to advertise external IP",
×
934
                                s.natTraversal.Name())
×
935
                        externalIPStrings = append(externalIPStrings, ips...)
×
936
                }
×
937
        }
938

939
        // If external IP addresses have been specified, add those to the list
940
        // of this server's addresses.
941
        externalIPs, err := lncfg.NormalizeAddresses(
3✔
942
                externalIPStrings, strconv.Itoa(defaultPeerPort),
3✔
943
                cfg.net.ResolveTCPAddr,
3✔
944
        )
3✔
945
        if err != nil {
3✔
946
                return nil, err
×
947
        }
×
948

949
        selfAddrs := make([]net.Addr, 0, len(externalIPs))
3✔
950
        selfAddrs = append(selfAddrs, externalIPs...)
3✔
951

3✔
952
        // We'll now reconstruct a node announcement based on our current
3✔
953
        // configuration so we can send it out as a sort of heart beat within
3✔
954
        // the network.
3✔
955
        //
3✔
956
        // We'll start by parsing the node color from configuration.
3✔
957
        color, err := lncfg.ParseHexColor(cfg.Color)
3✔
958
        if err != nil {
3✔
959
                srvrLog.Errorf("unable to parse color: %v\n", err)
×
960
                return nil, err
×
961
        }
×
962

963
        // If no alias is provided, default to first 10 characters of public
964
        // key.
965
        alias := cfg.Alias
3✔
966
        if alias == "" {
6✔
967
                alias = hex.EncodeToString(serializedPubKey[:10])
3✔
968
        }
3✔
969
        nodeAlias, err := lnwire.NewNodeAlias(alias)
3✔
970
        if err != nil {
3✔
971
                return nil, err
×
972
        }
×
973
        selfNode := &models.LightningNode{
3✔
974
                HaveNodeAnnouncement: true,
3✔
975
                LastUpdate:           time.Now(),
3✔
976
                Addresses:            selfAddrs,
3✔
977
                Alias:                nodeAlias.String(),
3✔
978
                Features:             s.featureMgr.Get(feature.SetNodeAnn),
3✔
979
                Color:                color,
3✔
980
        }
3✔
981
        copy(selfNode.PubKeyBytes[:], nodeKeyDesc.PubKey.SerializeCompressed())
3✔
982

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

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

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

3✔
1015
        // The router will get access to the payment ID sequencer, such that it
3✔
1016
        // can generate unique payment IDs.
3✔
1017
        sequencer, err := htlcswitch.NewPersistentSequencer(dbs.ChanStateDB)
3✔
1018
        if err != nil {
3✔
1019
                return nil, err
×
1020
        }
×
1021

1022
        // Instantiate mission control with config from the sub server.
1023
        //
1024
        // TODO(joostjager): When we are further in the process of moving to sub
1025
        // servers, the mission control instance itself can be moved there too.
1026
        routingConfig := routerrpc.GetRoutingConfig(cfg.SubRPCServers.RouterRPC)
3✔
1027

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

3✔
1043
                        estimator, err = routing.NewAprioriEstimator(
3✔
1044
                                aprioriConfig,
3✔
1045
                        )
3✔
1046
                        if err != nil {
3✔
1047
                                return nil, err
×
1048
                        }
×
1049

1050
                case routing.BimodalEstimatorName:
×
1051
                        bCfg := routingConfig.BimodalConfig
×
1052
                        bimodalConfig := routing.BimodalConfig{
×
1053
                                BimodalNodeWeight: bCfg.NodeWeight,
×
1054
                                BimodalScaleMsat: lnwire.MilliSatoshi(
×
1055
                                        bCfg.Scale,
×
1056
                                ),
×
1057
                                BimodalDecayTime: bCfg.DecayTime,
×
1058
                        }
×
1059

×
1060
                        estimator, err = routing.NewBimodalEstimator(
×
1061
                                bimodalConfig,
×
1062
                        )
×
1063
                        if err != nil {
×
1064
                                return nil, err
×
1065
                        }
×
1066

1067
                default:
×
1068
                        return nil, fmt.Errorf("unknown estimator type %v",
×
1069
                                routingConfig.ProbabilityEstimatorType)
×
1070
                }
1071
        }
1072

1073
        mcCfg := &routing.MissionControlConfig{
3✔
1074
                OnConfigUpdate:          fn.Some(s.UpdateRoutingConfig),
3✔
1075
                Estimator:               estimator,
3✔
1076
                MaxMcHistory:            routingConfig.MaxMcHistory,
3✔
1077
                McFlushInterval:         routingConfig.McFlushInterval,
3✔
1078
                MinFailureRelaxInterval: routing.DefaultMinFailureRelaxInterval,
3✔
1079
        }
3✔
1080

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

1096
        srvrLog.Debugf("Instantiating payment session source with config: "+
3✔
1097
                "AttemptCost=%v + %v%%, MinRouteProbability=%v",
3✔
1098
                int64(routingConfig.AttemptCost),
3✔
1099
                float64(routingConfig.AttemptCostPPM)/10000,
3✔
1100
                routingConfig.MinRouteProbability)
3✔
1101

3✔
1102
        pathFindingConfig := routing.PathFindingConfig{
3✔
1103
                AttemptCost: lnwire.NewMSatFromSatoshis(
3✔
1104
                        routingConfig.AttemptCost,
3✔
1105
                ),
3✔
1106
                AttemptCostPPM: routingConfig.AttemptCostPPM,
3✔
1107
                MinProbability: routingConfig.MinRouteProbability,
3✔
1108
        }
3✔
1109

3✔
1110
        sourceNode, err := dbs.GraphDB.SourceNode()
3✔
1111
        if err != nil {
3✔
1112
                return nil, fmt.Errorf("error getting source node: %w", err)
×
1113
        }
×
1114
        paymentSessionSource := &routing.SessionSource{
3✔
1115
                GraphSessionFactory: graphsession.NewGraphSessionFactory(
3✔
1116
                        dbs.GraphDB,
3✔
1117
                ),
3✔
1118
                SourceNode:        sourceNode,
3✔
1119
                MissionControl:    s.defaultMC,
3✔
1120
                GetLink:           s.htlcSwitch.GetLinkByShortID,
3✔
1121
                PathFindingConfig: pathFindingConfig,
3✔
1122
        }
3✔
1123

3✔
1124
        paymentControl := channeldb.NewPaymentControl(dbs.ChanStateDB)
3✔
1125

3✔
1126
        s.controlTower = routing.NewControlTower(paymentControl)
3✔
1127

3✔
1128
        strictPruning := cfg.Bitcoin.Node == "neutrino" ||
3✔
1129
                cfg.Routing.StrictZombiePruning
3✔
1130

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

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

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

1178
        scidCloserMan := discovery.NewScidCloserMan(s.graphDB, s.chanStateDB)
3✔
1179

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

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

1222
        selfVertex := route.Vertex(nodeKeyDesc.PubKey.SerializeCompressed())
3✔
1223
        //nolint:ll
3✔
1224
        s.localChanMgr = &localchans.Manager{
3✔
1225
                SelfPub:              nodeKeyDesc.PubKey,
3✔
1226
                DefaultRoutingPolicy: cc.RoutingPolicy,
3✔
1227
                ForAllOutgoingChannels: func(cb func(*models.ChannelEdgeInfo,
3✔
1228
                        *models.ChannelEdgePolicy) error) error {
6✔
1229

3✔
1230
                        return s.graphDB.ForEachNodeChannel(selfVertex,
3✔
1231
                                func(_ kvdb.RTx, c *models.ChannelEdgeInfo,
3✔
1232
                                        e *models.ChannelEdgePolicy,
3✔
1233
                                        _ *models.ChannelEdgePolicy) error {
6✔
1234

3✔
1235
                                        // NOTE: The invoked callback here may
3✔
1236
                                        // receive a nil channel policy.
3✔
1237
                                        return cb(c, e)
3✔
1238
                                },
3✔
1239
                        )
1240
                },
1241
                PropagateChanPolicyUpdate: s.authGossiper.PropagateChanPolicyUpdate,
1242
                UpdateForwardingPolicies:  s.htlcSwitch.UpdateForwardingPolicies,
1243
                FetchChannel:              s.chanStateDB.FetchChannel,
1244
                AddEdge: func(edge *models.ChannelEdgeInfo) error {
×
1245
                        return s.graphBuilder.AddEdge(edge)
×
1246
                },
×
1247
        }
1248

1249
        utxnStore, err := contractcourt.NewNurseryStore(
3✔
1250
                s.cfg.ActiveNetParams.GenesisHash, dbs.ChanStateDB,
3✔
1251
        )
3✔
1252
        if err != nil {
3✔
1253
                srvrLog.Errorf("unable to create nursery store: %v", err)
×
1254
                return nil, err
×
1255
        }
×
1256

1257
        sweeperStore, err := sweep.NewSweeperStore(
3✔
1258
                dbs.ChanStateDB, s.cfg.ActiveNetParams.GenesisHash,
3✔
1259
        )
3✔
1260
        if err != nil {
3✔
1261
                srvrLog.Errorf("unable to create sweeper store: %v", err)
×
1262
                return nil, err
×
1263
        }
×
1264

1265
        aggregator := sweep.NewBudgetAggregator(
3✔
1266
                cc.FeeEstimator, sweep.DefaultMaxInputsPerTx,
3✔
1267
                s.implCfg.AuxSweeper,
3✔
1268
        )
3✔
1269

3✔
1270
        s.txPublisher = sweep.NewTxPublisher(sweep.TxPublisherConfig{
3✔
1271
                Signer:     cc.Wallet.Cfg.Signer,
3✔
1272
                Wallet:     cc.Wallet,
3✔
1273
                Estimator:  cc.FeeEstimator,
3✔
1274
                Notifier:   cc.ChainNotifier,
3✔
1275
                AuxSweeper: s.implCfg.AuxSweeper,
3✔
1276
        })
3✔
1277

3✔
1278
        s.sweeper = sweep.New(&sweep.UtxoSweeperConfig{
3✔
1279
                FeeEstimator: cc.FeeEstimator,
3✔
1280
                GenSweepScript: newSweepPkScriptGen(
3✔
1281
                        cc.Wallet, s.cfg.ActiveNetParams.Params,
3✔
1282
                ),
3✔
1283
                Signer:               cc.Wallet.Cfg.Signer,
3✔
1284
                Wallet:               newSweeperWallet(cc.Wallet),
3✔
1285
                Mempool:              cc.MempoolNotifier,
3✔
1286
                Notifier:             cc.ChainNotifier,
3✔
1287
                Store:                sweeperStore,
3✔
1288
                MaxInputsPerTx:       sweep.DefaultMaxInputsPerTx,
3✔
1289
                MaxFeeRate:           cfg.Sweeper.MaxFeeRate,
3✔
1290
                Aggregator:           aggregator,
3✔
1291
                Publisher:            s.txPublisher,
3✔
1292
                NoDeadlineConfTarget: cfg.Sweeper.NoDeadlineConfTarget,
3✔
1293
        })
3✔
1294

3✔
1295
        s.utxoNursery = contractcourt.NewUtxoNursery(&contractcourt.NurseryConfig{
3✔
1296
                ChainIO:             cc.ChainIO,
3✔
1297
                ConfDepth:           1,
3✔
1298
                FetchClosedChannels: s.chanStateDB.FetchClosedChannels,
3✔
1299
                FetchClosedChannel:  s.chanStateDB.FetchClosedChannel,
3✔
1300
                Notifier:            cc.ChainNotifier,
3✔
1301
                PublishTransaction:  cc.Wallet.PublishTransaction,
3✔
1302
                Store:               utxnStore,
3✔
1303
                SweepInput:          s.sweeper.SweepInput,
3✔
1304
                Budget:              s.cfg.Sweeper.Budget,
3✔
1305
        })
3✔
1306

3✔
1307
        // Construct a closure that wraps the htlcswitch's CloseLink method.
3✔
1308
        closeLink := func(chanPoint *wire.OutPoint,
3✔
1309
                closureType contractcourt.ChannelCloseType) {
6✔
1310
                // TODO(conner): Properly respect the update and error channels
3✔
1311
                // returned by CloseLink.
3✔
1312

3✔
1313
                // Instruct the switch to close the channel.  Provide no close out
3✔
1314
                // delivery script or target fee per kw because user input is not
3✔
1315
                // available when the remote peer closes the channel.
3✔
1316
                s.htlcSwitch.CloseLink(chanPoint, closureType, 0, 0, nil)
3✔
1317
        }
3✔
1318

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

3✔
1323
        s.breachArbitrator = contractcourt.NewBreachArbitrator(
3✔
1324
                &contractcourt.BreachConfig{
3✔
1325
                        CloseLink: closeLink,
3✔
1326
                        DB:        s.chanStateDB,
3✔
1327
                        Estimator: s.cc.FeeEstimator,
3✔
1328
                        GenSweepScript: newSweepPkScriptGen(
3✔
1329
                                cc.Wallet, s.cfg.ActiveNetParams.Params,
3✔
1330
                        ),
3✔
1331
                        Notifier:           cc.ChainNotifier,
3✔
1332
                        PublishTransaction: cc.Wallet.PublishTransaction,
3✔
1333
                        ContractBreaches:   contractBreaches,
3✔
1334
                        Signer:             cc.Wallet.Cfg.Signer,
3✔
1335
                        Store: contractcourt.NewRetributionStore(
3✔
1336
                                dbs.ChanStateDB,
3✔
1337
                        ),
3✔
1338
                        AuxSweeper: s.implCfg.AuxSweeper,
3✔
1339
                },
3✔
1340
        )
3✔
1341

3✔
1342
        //nolint:ll
3✔
1343
        s.chainArb = contractcourt.NewChainArbitrator(contractcourt.ChainArbitratorConfig{
3✔
1344
                ChainHash:              *s.cfg.ActiveNetParams.GenesisHash,
3✔
1345
                IncomingBroadcastDelta: lncfg.DefaultIncomingBroadcastDelta,
3✔
1346
                OutgoingBroadcastDelta: lncfg.DefaultOutgoingBroadcastDelta,
3✔
1347
                NewSweepAddr: func() ([]byte, error) {
3✔
1348
                        addr, err := newSweepPkScriptGen(
×
1349
                                cc.Wallet, netParams,
×
1350
                        )().Unpack()
×
1351
                        if err != nil {
×
1352
                                return nil, err
×
1353
                        }
×
1354

1355
                        return addr.DeliveryAddress, nil
×
1356
                },
1357
                PublishTx: cc.Wallet.PublishTransaction,
1358
                DeliverResolutionMsg: func(msgs ...contractcourt.ResolutionMsg) error {
3✔
1359
                        for _, msg := range msgs {
6✔
1360
                                err := s.htlcSwitch.ProcessContractResolution(msg)
3✔
1361
                                if err != nil {
3✔
1362
                                        return err
×
1363
                                }
×
1364
                        }
1365
                        return nil
3✔
1366
                },
1367
                IncubateOutputs: func(chanPoint wire.OutPoint,
1368
                        outHtlcRes fn.Option[lnwallet.OutgoingHtlcResolution],
1369
                        inHtlcRes fn.Option[lnwallet.IncomingHtlcResolution],
1370
                        broadcastHeight uint32,
1371
                        deadlineHeight fn.Option[int32]) error {
3✔
1372

3✔
1373
                        return s.utxoNursery.IncubateOutputs(
3✔
1374
                                chanPoint, outHtlcRes, inHtlcRes,
3✔
1375
                                broadcastHeight, deadlineHeight,
3✔
1376
                        )
3✔
1377
                },
3✔
1378
                PreimageDB:   s.witnessBeacon,
1379
                Notifier:     cc.ChainNotifier,
1380
                Mempool:      cc.MempoolNotifier,
1381
                Signer:       cc.Wallet.Cfg.Signer,
1382
                FeeEstimator: cc.FeeEstimator,
1383
                ChainIO:      cc.ChainIO,
1384
                MarkLinkInactive: func(chanPoint wire.OutPoint) error {
3✔
1385
                        chanID := lnwire.NewChanIDFromOutPoint(chanPoint)
3✔
1386
                        s.htlcSwitch.RemoveLink(chanID)
3✔
1387
                        return nil
3✔
1388
                },
3✔
1389
                IsOurAddress: cc.Wallet.IsOurAddress,
1390
                ContractBreach: func(chanPoint wire.OutPoint,
1391
                        breachRet *lnwallet.BreachRetribution) error {
3✔
1392

3✔
1393
                        // processACK will handle the BreachArbitrator ACKing
3✔
1394
                        // the event.
3✔
1395
                        finalErr := make(chan error, 1)
3✔
1396
                        processACK := func(brarErr error) {
6✔
1397
                                if brarErr != nil {
3✔
1398
                                        finalErr <- brarErr
×
1399
                                        return
×
1400
                                }
×
1401

1402
                                // If the BreachArbitrator successfully handled
1403
                                // the event, we can signal that the handoff
1404
                                // was successful.
1405
                                finalErr <- nil
3✔
1406
                        }
1407

1408
                        event := &contractcourt.ContractBreachEvent{
3✔
1409
                                ChanPoint:         chanPoint,
3✔
1410
                                ProcessACK:        processACK,
3✔
1411
                                BreachRetribution: breachRet,
3✔
1412
                        }
3✔
1413

3✔
1414
                        // Send the contract breach event to the
3✔
1415
                        // BreachArbitrator.
3✔
1416
                        select {
3✔
1417
                        case contractBreaches <- event:
3✔
1418
                        case <-s.quit:
×
1419
                                return ErrServerShuttingDown
×
1420
                        }
1421

1422
                        // We'll wait for a final error to be available from
1423
                        // the BreachArbitrator.
1424
                        select {
3✔
1425
                        case err := <-finalErr:
3✔
1426
                                return err
3✔
1427
                        case <-s.quit:
×
1428
                                return ErrServerShuttingDown
×
1429
                        }
1430
                },
1431
                DisableChannel: func(chanPoint wire.OutPoint) error {
3✔
1432
                        return s.chanStatusMgr.RequestDisable(chanPoint, false)
3✔
1433
                },
3✔
1434
                Sweeper:                       s.sweeper,
1435
                Registry:                      s.invoices,
1436
                NotifyClosedChannel:           s.channelNotifier.NotifyClosedChannelEvent,
1437
                NotifyFullyResolvedChannel:    s.channelNotifier.NotifyFullyResolvedChannelEvent,
1438
                OnionProcessor:                s.sphinx,
1439
                PaymentsExpirationGracePeriod: cfg.PaymentsExpirationGracePeriod,
1440
                IsForwardedHTLC:               s.htlcSwitch.IsForwardedHTLC,
1441
                Clock:                         clock.NewDefaultClock(),
1442
                SubscribeBreachComplete:       s.breachArbitrator.SubscribeBreachComplete,
1443
                PutFinalHtlcOutcome:           s.chanStateDB.PutOnchainFinalHtlcOutcome,
1444
                HtlcNotifier:                  s.htlcNotifier,
1445
                Budget:                        *s.cfg.Sweeper.Budget,
1446

1447
                // TODO(yy): remove this hack once PaymentCircuit is interfaced.
1448
                QueryIncomingCircuit: func(
1449
                        circuit models.CircuitKey) *models.CircuitKey {
3✔
1450

3✔
1451
                        // Get the circuit map.
3✔
1452
                        circuits := s.htlcSwitch.CircuitLookup()
3✔
1453

3✔
1454
                        // Lookup the outgoing circuit.
3✔
1455
                        pc := circuits.LookupOpenCircuit(circuit)
3✔
1456
                        if pc == nil {
6✔
1457
                                return nil
3✔
1458
                        }
3✔
1459

1460
                        return &pc.Incoming
3✔
1461
                },
1462
                AuxLeafStore: implCfg.AuxLeafStore,
1463
                AuxSigner:    implCfg.AuxSigner,
1464
                AuxResolver:  implCfg.AuxContractResolver,
1465
        }, dbs.ChanStateDB)
1466

1467
        // Select the configuration and funding parameters for Bitcoin.
1468
        chainCfg := cfg.Bitcoin
3✔
1469
        minRemoteDelay := funding.MinBtcRemoteDelay
3✔
1470
        maxRemoteDelay := funding.MaxBtcRemoteDelay
3✔
1471

3✔
1472
        var chanIDSeed [32]byte
3✔
1473
        if _, err := rand.Read(chanIDSeed[:]); err != nil {
3✔
1474
                return nil, err
×
1475
        }
×
1476

1477
        // Wrap the DeleteChannelEdges method so that the funding manager can
1478
        // use it without depending on several layers of indirection.
1479
        deleteAliasEdge := func(scid lnwire.ShortChannelID) (
3✔
1480
                *models.ChannelEdgePolicy, error) {
6✔
1481

3✔
1482
                info, e1, e2, err := s.graphDB.FetchChannelEdgesByID(
3✔
1483
                        scid.ToUint64(),
3✔
1484
                )
3✔
1485
                if errors.Is(err, graphdb.ErrEdgeNotFound) {
3✔
1486
                        // This is unlikely but there is a slim chance of this
×
1487
                        // being hit if lnd was killed via SIGKILL and the
×
1488
                        // funding manager was stepping through the delete
×
1489
                        // alias edge logic.
×
1490
                        return nil, nil
×
1491
                } else if err != nil {
3✔
1492
                        return nil, err
×
1493
                }
×
1494

1495
                // Grab our key to find our policy.
1496
                var ourKey [33]byte
3✔
1497
                copy(ourKey[:], nodeKeyDesc.PubKey.SerializeCompressed())
3✔
1498

3✔
1499
                var ourPolicy *models.ChannelEdgePolicy
3✔
1500
                if info != nil && info.NodeKey1Bytes == ourKey {
6✔
1501
                        ourPolicy = e1
3✔
1502
                } else {
6✔
1503
                        ourPolicy = e2
3✔
1504
                }
3✔
1505

1506
                if ourPolicy == nil {
3✔
1507
                        // Something is wrong, so return an error.
×
1508
                        return nil, fmt.Errorf("we don't have an edge")
×
1509
                }
×
1510

1511
                err = s.graphDB.DeleteChannelEdges(
3✔
1512
                        false, false, scid.ToUint64(),
3✔
1513
                )
3✔
1514
                return ourPolicy, err
3✔
1515
        }
1516

1517
        // For the reservationTimeout and the zombieSweeperInterval different
1518
        // values are set in case we are in a dev environment so enhance test
1519
        // capacilities.
1520
        reservationTimeout := chanfunding.DefaultReservationTimeout
3✔
1521
        zombieSweeperInterval := lncfg.DefaultZombieSweeperInterval
3✔
1522

3✔
1523
        // Get the development config for funding manager. If we are not in
3✔
1524
        // development mode, this would be nil.
3✔
1525
        var devCfg *funding.DevConfig
3✔
1526
        if lncfg.IsDevBuild() {
6✔
1527
                devCfg = &funding.DevConfig{
3✔
1528
                        ProcessChannelReadyWait: cfg.Dev.ChannelReadyWait(),
3✔
1529
                }
3✔
1530

3✔
1531
                reservationTimeout = cfg.Dev.GetReservationTimeout()
3✔
1532
                zombieSweeperInterval = cfg.Dev.GetZombieSweeperInterval()
3✔
1533

3✔
1534
                srvrLog.Debugf("Using the dev config for the fundingMgr: %v, "+
3✔
1535
                        "reservationTimeout=%v, zombieSweeperInterval=%v",
3✔
1536
                        devCfg, reservationTimeout, zombieSweeperInterval)
3✔
1537
        }
3✔
1538

1539
        //nolint:ll
1540
        s.fundingMgr, err = funding.NewFundingManager(funding.Config{
3✔
1541
                Dev:                devCfg,
3✔
1542
                NoWumboChans:       !cfg.ProtocolOptions.Wumbo(),
3✔
1543
                IDKey:              nodeKeyDesc.PubKey,
3✔
1544
                IDKeyLoc:           nodeKeyDesc.KeyLocator,
3✔
1545
                Wallet:             cc.Wallet,
3✔
1546
                PublishTransaction: cc.Wallet.PublishTransaction,
3✔
1547
                UpdateLabel: func(hash chainhash.Hash, label string) error {
6✔
1548
                        return cc.Wallet.LabelTransaction(hash, label, true)
3✔
1549
                },
3✔
1550
                Notifier:     cc.ChainNotifier,
1551
                ChannelDB:    s.chanStateDB,
1552
                FeeEstimator: cc.FeeEstimator,
1553
                SignMessage:  cc.MsgSigner.SignMessage,
1554
                CurrentNodeAnnouncement: func() (lnwire.NodeAnnouncement,
1555
                        error) {
3✔
1556

3✔
1557
                        return s.genNodeAnnouncement(nil)
3✔
1558
                },
3✔
1559
                SendAnnouncement:     s.authGossiper.ProcessLocalAnnouncement,
1560
                NotifyWhenOnline:     s.NotifyWhenOnline,
1561
                TempChanIDSeed:       chanIDSeed,
1562
                FindChannel:          s.findChannel,
1563
                DefaultRoutingPolicy: cc.RoutingPolicy,
1564
                DefaultMinHtlcIn:     cc.MinHtlcIn,
1565
                NumRequiredConfs: func(chanAmt btcutil.Amount,
1566
                        pushAmt lnwire.MilliSatoshi) uint16 {
3✔
1567
                        // For large channels we increase the number
3✔
1568
                        // of confirmations we require for the
3✔
1569
                        // channel to be considered open. As it is
3✔
1570
                        // always the responder that gets to choose
3✔
1571
                        // value, the pushAmt is value being pushed
3✔
1572
                        // to us. This means we have more to lose
3✔
1573
                        // in the case this gets re-orged out, and
3✔
1574
                        // we will require more confirmations before
3✔
1575
                        // we consider it open.
3✔
1576

3✔
1577
                        // In case the user has explicitly specified
3✔
1578
                        // a default value for the number of
3✔
1579
                        // confirmations, we use it.
3✔
1580
                        defaultConf := uint16(chainCfg.DefaultNumChanConfs)
3✔
1581
                        if defaultConf != 0 {
6✔
1582
                                return defaultConf
3✔
1583
                        }
3✔
1584

1585
                        minConf := uint64(3)
×
1586
                        maxConf := uint64(6)
×
1587

×
1588
                        // If this is a wumbo channel, then we'll require the
×
1589
                        // max amount of confirmations.
×
1590
                        if chanAmt > MaxFundingAmount {
×
1591
                                return uint16(maxConf)
×
1592
                        }
×
1593

1594
                        // If not we return a value scaled linearly
1595
                        // between 3 and 6, depending on channel size.
1596
                        // TODO(halseth): Use 1 as minimum?
1597
                        maxChannelSize := uint64(
×
1598
                                lnwire.NewMSatFromSatoshis(MaxFundingAmount))
×
1599
                        stake := lnwire.NewMSatFromSatoshis(chanAmt) + pushAmt
×
1600
                        conf := maxConf * uint64(stake) / maxChannelSize
×
1601
                        if conf < minConf {
×
1602
                                conf = minConf
×
1603
                        }
×
1604
                        if conf > maxConf {
×
1605
                                conf = maxConf
×
1606
                        }
×
1607
                        return uint16(conf)
×
1608
                },
1609
                RequiredRemoteDelay: func(chanAmt btcutil.Amount) uint16 {
3✔
1610
                        // We scale the remote CSV delay (the time the
3✔
1611
                        // remote have to claim funds in case of a unilateral
3✔
1612
                        // close) linearly from minRemoteDelay blocks
3✔
1613
                        // for small channels, to maxRemoteDelay blocks
3✔
1614
                        // for channels of size MaxFundingAmount.
3✔
1615

3✔
1616
                        // In case the user has explicitly specified
3✔
1617
                        // a default value for the remote delay, we
3✔
1618
                        // use it.
3✔
1619
                        defaultDelay := uint16(chainCfg.DefaultRemoteDelay)
3✔
1620
                        if defaultDelay > 0 {
6✔
1621
                                return defaultDelay
3✔
1622
                        }
3✔
1623

1624
                        // If this is a wumbo channel, then we'll require the
1625
                        // max value.
1626
                        if chanAmt > MaxFundingAmount {
×
1627
                                return maxRemoteDelay
×
1628
                        }
×
1629

1630
                        // If not we scale according to channel size.
1631
                        delay := uint16(btcutil.Amount(maxRemoteDelay) *
×
1632
                                chanAmt / MaxFundingAmount)
×
1633
                        if delay < minRemoteDelay {
×
1634
                                delay = minRemoteDelay
×
1635
                        }
×
1636
                        if delay > maxRemoteDelay {
×
1637
                                delay = maxRemoteDelay
×
1638
                        }
×
1639
                        return delay
×
1640
                },
1641
                WatchNewChannel: func(channel *channeldb.OpenChannel,
1642
                        peerKey *btcec.PublicKey) error {
3✔
1643

3✔
1644
                        // First, we'll mark this new peer as a persistent peer
3✔
1645
                        // for re-connection purposes. If the peer is not yet
3✔
1646
                        // tracked or the user hasn't requested it to be perm,
3✔
1647
                        // we'll set false to prevent the server from continuing
3✔
1648
                        // to connect to this peer even if the number of
3✔
1649
                        // channels with this peer is zero.
3✔
1650
                        s.mu.Lock()
3✔
1651
                        pubStr := string(peerKey.SerializeCompressed())
3✔
1652
                        if _, ok := s.persistentPeers[pubStr]; !ok {
6✔
1653
                                s.persistentPeers[pubStr] = false
3✔
1654
                        }
3✔
1655
                        s.mu.Unlock()
3✔
1656

3✔
1657
                        // With that taken care of, we'll send this channel to
3✔
1658
                        // the chain arb so it can react to on-chain events.
3✔
1659
                        return s.chainArb.WatchNewChannel(channel)
3✔
1660
                },
1661
                ReportShortChanID: func(chanPoint wire.OutPoint) error {
3✔
1662
                        cid := lnwire.NewChanIDFromOutPoint(chanPoint)
3✔
1663
                        return s.htlcSwitch.UpdateShortChanID(cid)
3✔
1664
                },
3✔
1665
                RequiredRemoteChanReserve: func(chanAmt,
1666
                        dustLimit btcutil.Amount) btcutil.Amount {
3✔
1667

3✔
1668
                        // By default, we'll require the remote peer to maintain
3✔
1669
                        // at least 1% of the total channel capacity at all
3✔
1670
                        // times. If this value ends up dipping below the dust
3✔
1671
                        // limit, then we'll use the dust limit itself as the
3✔
1672
                        // reserve as required by BOLT #2.
3✔
1673
                        reserve := chanAmt / 100
3✔
1674
                        if reserve < dustLimit {
6✔
1675
                                reserve = dustLimit
3✔
1676
                        }
3✔
1677

1678
                        return reserve
3✔
1679
                },
1680
                RequiredRemoteMaxValue: func(chanAmt btcutil.Amount) lnwire.MilliSatoshi {
3✔
1681
                        // By default, we'll allow the remote peer to fully
3✔
1682
                        // utilize the full bandwidth of the channel, minus our
3✔
1683
                        // required reserve.
3✔
1684
                        reserve := lnwire.NewMSatFromSatoshis(chanAmt / 100)
3✔
1685
                        return lnwire.NewMSatFromSatoshis(chanAmt) - reserve
3✔
1686
                },
3✔
1687
                RequiredRemoteMaxHTLCs: func(chanAmt btcutil.Amount) uint16 {
3✔
1688
                        if cfg.DefaultRemoteMaxHtlcs > 0 {
6✔
1689
                                return cfg.DefaultRemoteMaxHtlcs
3✔
1690
                        }
3✔
1691

1692
                        // By default, we'll permit them to utilize the full
1693
                        // channel bandwidth.
1694
                        return uint16(input.MaxHTLCNumber / 2)
×
1695
                },
1696
                ZombieSweeperInterval:         zombieSweeperInterval,
1697
                ReservationTimeout:            reservationTimeout,
1698
                MinChanSize:                   btcutil.Amount(cfg.MinChanSize),
1699
                MaxChanSize:                   btcutil.Amount(cfg.MaxChanSize),
1700
                MaxPendingChannels:            cfg.MaxPendingChannels,
1701
                RejectPush:                    cfg.RejectPush,
1702
                MaxLocalCSVDelay:              chainCfg.MaxLocalDelay,
1703
                NotifyOpenChannelEvent:        s.notifyOpenChannelPeerEvent,
1704
                OpenChannelPredicate:          chanPredicate,
1705
                NotifyPendingOpenChannelEvent: s.notifyPendingOpenChannelPeerEvent,
1706
                NotifyFundingTimeout:          s.notifyFundingTimeoutPeerEvent,
1707
                EnableUpfrontShutdown:         cfg.EnableUpfrontShutdown,
1708
                MaxAnchorsCommitFeeRate: chainfee.SatPerKVByte(
1709
                        s.cfg.MaxCommitFeeRateAnchors * 1000).FeePerKWeight(),
1710
                DeleteAliasEdge:      deleteAliasEdge,
1711
                AliasManager:         s.aliasMgr,
1712
                IsSweeperOutpoint:    s.sweeper.IsSweeperOutpoint,
1713
                AuxFundingController: implCfg.AuxFundingController,
1714
                AuxSigner:            implCfg.AuxSigner,
1715
                AuxResolver:          implCfg.AuxContractResolver,
1716
        })
1717
        if err != nil {
3✔
1718
                return nil, err
×
1719
        }
×
1720

1721
        // Next, we'll assemble the sub-system that will maintain an on-disk
1722
        // static backup of the latest channel state.
1723
        chanNotifier := &channelNotifier{
3✔
1724
                chanNotifier: s.channelNotifier,
3✔
1725
                addrs:        s.addrSource,
3✔
1726
        }
3✔
1727
        backupFile := chanbackup.NewMultiFile(
3✔
1728
                cfg.BackupFilePath, cfg.NoBackupArchive,
3✔
1729
        )
3✔
1730
        startingChans, err := chanbackup.FetchStaticChanBackups(
3✔
1731
                s.chanStateDB, s.addrSource,
3✔
1732
        )
3✔
1733
        if err != nil {
3✔
1734
                return nil, err
×
1735
        }
×
1736
        s.chanSubSwapper, err = chanbackup.NewSubSwapper(
3✔
1737
                startingChans, chanNotifier, s.cc.KeyRing, backupFile,
3✔
1738
        )
3✔
1739
        if err != nil {
3✔
1740
                return nil, err
×
1741
        }
×
1742

1743
        // Assemble a peer notifier which will provide clients with subscriptions
1744
        // to peer online and offline events.
1745
        s.peerNotifier = peernotifier.New()
3✔
1746

3✔
1747
        // Create a channel event store which monitors all open channels.
3✔
1748
        s.chanEventStore = chanfitness.NewChannelEventStore(&chanfitness.Config{
3✔
1749
                SubscribeChannelEvents: func() (subscribe.Subscription, error) {
6✔
1750
                        return s.channelNotifier.SubscribeChannelEvents()
3✔
1751
                },
3✔
1752
                SubscribePeerEvents: func() (subscribe.Subscription, error) {
3✔
1753
                        return s.peerNotifier.SubscribePeerEvents()
3✔
1754
                },
3✔
1755
                GetOpenChannels: s.chanStateDB.FetchAllOpenChannels,
1756
                Clock:           clock.NewDefaultClock(),
1757
                ReadFlapCount:   s.miscDB.ReadFlapCount,
1758
                WriteFlapCount:  s.miscDB.WriteFlapCounts,
1759
                FlapCountTicker: ticker.New(chanfitness.FlapCountFlushRate),
1760
        })
1761

1762
        if cfg.WtClient.Active {
6✔
1763
                policy := wtpolicy.DefaultPolicy()
3✔
1764
                policy.MaxUpdates = cfg.WtClient.MaxUpdates
3✔
1765

3✔
1766
                // We expose the sweep fee rate in sat/vbyte, but the tower
3✔
1767
                // protocol operations on sat/kw.
3✔
1768
                sweepRateSatPerVByte := chainfee.SatPerKVByte(
3✔
1769
                        1000 * cfg.WtClient.SweepFeeRate,
3✔
1770
                )
3✔
1771

3✔
1772
                policy.SweepFeeRate = sweepRateSatPerVByte.FeePerKWeight()
3✔
1773

3✔
1774
                if err := policy.Validate(); err != nil {
3✔
1775
                        return nil, err
×
1776
                }
×
1777

1778
                // authDial is the wrapper around the btrontide.Dial for the
1779
                // watchtower.
1780
                authDial := func(localKey keychain.SingleKeyECDH,
3✔
1781
                        netAddr *lnwire.NetAddress,
3✔
1782
                        dialer tor.DialFunc) (wtserver.Peer, error) {
6✔
1783

3✔
1784
                        return brontide.Dial(
3✔
1785
                                localKey, netAddr, cfg.ConnectionTimeout, dialer,
3✔
1786
                        )
3✔
1787
                }
3✔
1788

1789
                // buildBreachRetribution is a call-back that can be used to
1790
                // query the BreachRetribution info and channel type given a
1791
                // channel ID and commitment height.
1792
                buildBreachRetribution := func(chanID lnwire.ChannelID,
3✔
1793
                        commitHeight uint64) (*lnwallet.BreachRetribution,
3✔
1794
                        channeldb.ChannelType, error) {
6✔
1795

3✔
1796
                        channel, err := s.chanStateDB.FetchChannelByID(
3✔
1797
                                nil, chanID,
3✔
1798
                        )
3✔
1799
                        if err != nil {
3✔
1800
                                return nil, 0, err
×
1801
                        }
×
1802

1803
                        br, err := lnwallet.NewBreachRetribution(
3✔
1804
                                channel, commitHeight, 0, nil,
3✔
1805
                                implCfg.AuxLeafStore,
3✔
1806
                                implCfg.AuxContractResolver,
3✔
1807
                        )
3✔
1808
                        if err != nil {
3✔
1809
                                return nil, 0, err
×
1810
                        }
×
1811

1812
                        return br, channel.ChanType, nil
3✔
1813
                }
1814

1815
                fetchClosedChannel := s.chanStateDB.FetchClosedChannelForID
3✔
1816

3✔
1817
                // Copy the policy for legacy channels and set the blob flag
3✔
1818
                // signalling support for anchor channels.
3✔
1819
                anchorPolicy := policy
3✔
1820
                anchorPolicy.BlobType |= blob.Type(blob.FlagAnchorChannel)
3✔
1821

3✔
1822
                // Copy the policy for legacy channels and set the blob flag
3✔
1823
                // signalling support for taproot channels.
3✔
1824
                taprootPolicy := policy
3✔
1825
                taprootPolicy.TxPolicy.BlobType |= blob.Type(
3✔
1826
                        blob.FlagTaprootChannel,
3✔
1827
                )
3✔
1828

3✔
1829
                s.towerClientMgr, err = wtclient.NewManager(&wtclient.Config{
3✔
1830
                        FetchClosedChannel:     fetchClosedChannel,
3✔
1831
                        BuildBreachRetribution: buildBreachRetribution,
3✔
1832
                        SessionCloseRange:      cfg.WtClient.SessionCloseRange,
3✔
1833
                        ChainNotifier:          s.cc.ChainNotifier,
3✔
1834
                        SubscribeChannelEvents: func() (subscribe.Subscription,
3✔
1835
                                error) {
6✔
1836

3✔
1837
                                return s.channelNotifier.
3✔
1838
                                        SubscribeChannelEvents()
3✔
1839
                        },
3✔
1840
                        Signer: cc.Wallet.Cfg.Signer,
1841
                        NewAddress: func() ([]byte, error) {
3✔
1842
                                addr, err := newSweepPkScriptGen(
3✔
1843
                                        cc.Wallet, netParams,
3✔
1844
                                )().Unpack()
3✔
1845
                                if err != nil {
3✔
1846
                                        return nil, err
×
1847
                                }
×
1848

1849
                                return addr.DeliveryAddress, nil
3✔
1850
                        },
1851
                        SecretKeyRing:      s.cc.KeyRing,
1852
                        Dial:               cfg.net.Dial,
1853
                        AuthDial:           authDial,
1854
                        DB:                 dbs.TowerClientDB,
1855
                        ChainHash:          *s.cfg.ActiveNetParams.GenesisHash,
1856
                        MinBackoff:         10 * time.Second,
1857
                        MaxBackoff:         5 * time.Minute,
1858
                        MaxTasksInMemQueue: cfg.WtClient.MaxTasksInMemQueue,
1859
                }, policy, anchorPolicy, taprootPolicy)
1860
                if err != nil {
3✔
1861
                        return nil, err
×
1862
                }
×
1863
        }
1864

1865
        if len(cfg.ExternalHosts) != 0 {
3✔
1866
                advertisedIPs := make(map[string]struct{})
×
1867
                for _, addr := range s.currentNodeAnn.Addresses {
×
1868
                        advertisedIPs[addr.String()] = struct{}{}
×
1869
                }
×
1870

1871
                s.hostAnn = netann.NewHostAnnouncer(netann.HostAnnouncerConfig{
×
1872
                        Hosts:         cfg.ExternalHosts,
×
1873
                        RefreshTicker: ticker.New(defaultHostSampleInterval),
×
1874
                        LookupHost: func(host string) (net.Addr, error) {
×
1875
                                return lncfg.ParseAddressString(
×
1876
                                        host, strconv.Itoa(defaultPeerPort),
×
1877
                                        cfg.net.ResolveTCPAddr,
×
1878
                                )
×
1879
                        },
×
1880
                        AdvertisedIPs: advertisedIPs,
1881
                        AnnounceNewIPs: netann.IPAnnouncer(
1882
                                func(modifier ...netann.NodeAnnModifier) (
1883
                                        lnwire.NodeAnnouncement, error) {
×
1884

×
1885
                                        return s.genNodeAnnouncement(
×
1886
                                                nil, modifier...,
×
1887
                                        )
×
1888
                                }),
×
1889
                })
1890
        }
1891

1892
        // Create liveness monitor.
1893
        s.createLivenessMonitor(cfg, cc, leaderElector)
3✔
1894

3✔
1895
        listeners := make([]net.Listener, len(listenAddrs))
3✔
1896
        for i, listenAddr := range listenAddrs {
6✔
1897
                // Note: though brontide.NewListener uses ResolveTCPAddr, it
3✔
1898
                // doesn't need to call the general lndResolveTCP function
3✔
1899
                // since we are resolving a local address.
3✔
1900

3✔
1901
                // RESOLVE: We are actually partially accepting inbound
3✔
1902
                // connection requests when we call NewListener.
3✔
1903
                listeners[i], err = brontide.NewListener(
3✔
1904
                        nodeKeyECDH, listenAddr.String(),
3✔
1905
                        s.checkIncomingConnBanScore,
3✔
1906
                )
3✔
1907
                if err != nil {
3✔
NEW
1908
                        return nil, err
×
NEW
1909
                }
×
1910
        }
1911

1912
        // Create the connection manager which will be responsible for
1913
        // maintaining persistent outbound connections and also accepting new
1914
        // incoming connections
1915
        cmgr, err := connmgr.New(&connmgr.Config{
3✔
1916
                Listeners:      listeners,
3✔
1917
                OnAccept:       s.InboundPeerConnected,
3✔
1918
                RetryDuration:  time.Second * 5,
3✔
1919
                TargetOutbound: 100,
3✔
1920
                Dial: noiseDial(
3✔
1921
                        nodeKeyECDH, s.cfg.net, s.cfg.ConnectionTimeout,
3✔
1922
                ),
3✔
1923
                OnConnection: s.OutboundPeerConnected,
3✔
1924
        })
3✔
1925
        if err != nil {
3✔
1926
                return nil, err
×
1927
        }
×
1928
        s.connMgr = cmgr
3✔
1929

3✔
1930
        // Finally, register the subsystems in blockbeat.
3✔
1931
        s.registerBlockConsumers()
3✔
1932

3✔
1933
        return s, nil
3✔
1934
}
1935

1936
// UpdateRoutingConfig is a callback function to update the routing config
1937
// values in the main cfg.
1938
func (s *server) UpdateRoutingConfig(cfg *routing.MissionControlConfig) {
3✔
1939
        routerCfg := s.cfg.SubRPCServers.RouterRPC
3✔
1940

3✔
1941
        switch c := cfg.Estimator.Config().(type) {
3✔
1942
        case routing.AprioriConfig:
3✔
1943
                routerCfg.ProbabilityEstimatorType =
3✔
1944
                        routing.AprioriEstimatorName
3✔
1945

3✔
1946
                targetCfg := routerCfg.AprioriConfig
3✔
1947
                targetCfg.PenaltyHalfLife = c.PenaltyHalfLife
3✔
1948
                targetCfg.Weight = c.AprioriWeight
3✔
1949
                targetCfg.CapacityFraction = c.CapacityFraction
3✔
1950
                targetCfg.HopProbability = c.AprioriHopProbability
3✔
1951

1952
        case routing.BimodalConfig:
3✔
1953
                routerCfg.ProbabilityEstimatorType =
3✔
1954
                        routing.BimodalEstimatorName
3✔
1955

3✔
1956
                targetCfg := routerCfg.BimodalConfig
3✔
1957
                targetCfg.Scale = int64(c.BimodalScaleMsat)
3✔
1958
                targetCfg.NodeWeight = c.BimodalNodeWeight
3✔
1959
                targetCfg.DecayTime = c.BimodalDecayTime
3✔
1960
        }
1961

1962
        routerCfg.MaxMcHistory = cfg.MaxMcHistory
3✔
1963
}
1964

1965
// registerBlockConsumers registers the subsystems that consume block events.
1966
// By calling `RegisterQueue`, a list of subsystems are registered in the
1967
// blockbeat for block notifications. When a new block arrives, the subsystems
1968
// in the same queue are notified sequentially, and different queues are
1969
// notified concurrently.
1970
//
1971
// NOTE: To put a subsystem in a different queue, create a slice and pass it to
1972
// a new `RegisterQueue` call.
1973
func (s *server) registerBlockConsumers() {
3✔
1974
        // In this queue, when a new block arrives, it will be received and
3✔
1975
        // processed in this order: chainArb -> sweeper -> txPublisher.
3✔
1976
        consumers := []chainio.Consumer{
3✔
1977
                s.chainArb,
3✔
1978
                s.sweeper,
3✔
1979
                s.txPublisher,
3✔
1980
        }
3✔
1981
        s.blockbeatDispatcher.RegisterQueue(consumers)
3✔
1982
}
3✔
1983

1984
// signAliasUpdate takes a ChannelUpdate and returns the signature. This is
1985
// used for option_scid_alias channels where the ChannelUpdate to be sent back
1986
// may differ from what is on disk.
1987
func (s *server) signAliasUpdate(u *lnwire.ChannelUpdate1) (*ecdsa.Signature,
1988
        error) {
3✔
1989

3✔
1990
        data, err := u.DataToSign()
3✔
1991
        if err != nil {
3✔
1992
                return nil, err
×
1993
        }
×
1994

1995
        return s.cc.MsgSigner.SignMessage(s.identityKeyLoc, data, true)
3✔
1996
}
1997

1998
// createLivenessMonitor creates a set of health checks using our configured
1999
// values and uses these checks to create a liveness monitor. Available
2000
// health checks,
2001
//   - chainHealthCheck (will be disabled for --nochainbackend mode)
2002
//   - diskCheck
2003
//   - tlsHealthCheck
2004
//   - torController, only created when tor is enabled.
2005
//
2006
// If a health check has been disabled by setting attempts to 0, our monitor
2007
// will not run it.
2008
func (s *server) createLivenessMonitor(cfg *Config, cc *chainreg.ChainControl,
2009
        leaderElector cluster.LeaderElector) {
3✔
2010

3✔
2011
        chainBackendAttempts := cfg.HealthChecks.ChainCheck.Attempts
3✔
2012
        if cfg.Bitcoin.Node == "nochainbackend" {
3✔
2013
                srvrLog.Info("Disabling chain backend checks for " +
×
2014
                        "nochainbackend mode")
×
2015

×
2016
                chainBackendAttempts = 0
×
2017
        }
×
2018

2019
        chainHealthCheck := healthcheck.NewObservation(
3✔
2020
                "chain backend",
3✔
2021
                cc.HealthCheck,
3✔
2022
                cfg.HealthChecks.ChainCheck.Interval,
3✔
2023
                cfg.HealthChecks.ChainCheck.Timeout,
3✔
2024
                cfg.HealthChecks.ChainCheck.Backoff,
3✔
2025
                chainBackendAttempts,
3✔
2026
        )
3✔
2027

3✔
2028
        diskCheck := healthcheck.NewObservation(
3✔
2029
                "disk space",
3✔
2030
                func() error {
3✔
2031
                        free, err := healthcheck.AvailableDiskSpaceRatio(
×
2032
                                cfg.LndDir,
×
2033
                        )
×
2034
                        if err != nil {
×
2035
                                return err
×
2036
                        }
×
2037

2038
                        // If we have more free space than we require,
2039
                        // we return a nil error.
2040
                        if free > cfg.HealthChecks.DiskCheck.RequiredRemaining {
×
2041
                                return nil
×
2042
                        }
×
2043

2044
                        return fmt.Errorf("require: %v free space, got: %v",
×
2045
                                cfg.HealthChecks.DiskCheck.RequiredRemaining,
×
2046
                                free)
×
2047
                },
2048
                cfg.HealthChecks.DiskCheck.Interval,
2049
                cfg.HealthChecks.DiskCheck.Timeout,
2050
                cfg.HealthChecks.DiskCheck.Backoff,
2051
                cfg.HealthChecks.DiskCheck.Attempts,
2052
        )
2053

2054
        tlsHealthCheck := healthcheck.NewObservation(
3✔
2055
                "tls",
3✔
2056
                func() error {
3✔
2057
                        expired, expTime, err := s.tlsManager.IsCertExpired(
×
2058
                                s.cc.KeyRing,
×
2059
                        )
×
2060
                        if err != nil {
×
2061
                                return err
×
2062
                        }
×
2063
                        if expired {
×
2064
                                return fmt.Errorf("TLS certificate is "+
×
2065
                                        "expired as of %v", expTime)
×
2066
                        }
×
2067

2068
                        // If the certificate is not outdated, no error needs
2069
                        // to be returned
2070
                        return nil
×
2071
                },
2072
                cfg.HealthChecks.TLSCheck.Interval,
2073
                cfg.HealthChecks.TLSCheck.Timeout,
2074
                cfg.HealthChecks.TLSCheck.Backoff,
2075
                cfg.HealthChecks.TLSCheck.Attempts,
2076
        )
2077

2078
        checks := []*healthcheck.Observation{
3✔
2079
                chainHealthCheck, diskCheck, tlsHealthCheck,
3✔
2080
        }
3✔
2081

3✔
2082
        // If Tor is enabled, add the healthcheck for tor connection.
3✔
2083
        if s.torController != nil {
3✔
2084
                torConnectionCheck := healthcheck.NewObservation(
×
2085
                        "tor connection",
×
2086
                        func() error {
×
2087
                                return healthcheck.CheckTorServiceStatus(
×
2088
                                        s.torController,
×
2089
                                        s.createNewHiddenService,
×
2090
                                )
×
2091
                        },
×
2092
                        cfg.HealthChecks.TorConnection.Interval,
2093
                        cfg.HealthChecks.TorConnection.Timeout,
2094
                        cfg.HealthChecks.TorConnection.Backoff,
2095
                        cfg.HealthChecks.TorConnection.Attempts,
2096
                )
2097
                checks = append(checks, torConnectionCheck)
×
2098
        }
2099

2100
        // If remote signing is enabled, add the healthcheck for the remote
2101
        // signing RPC interface.
2102
        if s.cfg.RemoteSigner != nil && s.cfg.RemoteSigner.Enable {
6✔
2103
                // Because we have two cascading timeouts here, we need to add
3✔
2104
                // some slack to the "outer" one of them in case the "inner"
3✔
2105
                // returns exactly on time.
3✔
2106
                overhead := time.Millisecond * 10
3✔
2107

3✔
2108
                remoteSignerConnectionCheck := healthcheck.NewObservation(
3✔
2109
                        "remote signer connection",
3✔
2110
                        rpcwallet.HealthCheck(
3✔
2111
                                s.cfg.RemoteSigner,
3✔
2112

3✔
2113
                                // For the health check we might to be even
3✔
2114
                                // stricter than the initial/normal connect, so
3✔
2115
                                // we use the health check timeout here.
3✔
2116
                                cfg.HealthChecks.RemoteSigner.Timeout,
3✔
2117
                        ),
3✔
2118
                        cfg.HealthChecks.RemoteSigner.Interval,
3✔
2119
                        cfg.HealthChecks.RemoteSigner.Timeout+overhead,
3✔
2120
                        cfg.HealthChecks.RemoteSigner.Backoff,
3✔
2121
                        cfg.HealthChecks.RemoteSigner.Attempts,
3✔
2122
                )
3✔
2123
                checks = append(checks, remoteSignerConnectionCheck)
3✔
2124
        }
3✔
2125

2126
        // If we have a leader elector, we add a health check to ensure we are
2127
        // still the leader. During normal operation, we should always be the
2128
        // leader, but there are circumstances where this may change, such as
2129
        // when we lose network connectivity for long enough expiring out lease.
2130
        if leaderElector != nil {
3✔
2131
                leaderCheck := healthcheck.NewObservation(
×
2132
                        "leader status",
×
2133
                        func() error {
×
2134
                                // Check if we are still the leader. Note that
×
2135
                                // we don't need to use a timeout context here
×
2136
                                // as the healthcheck observer will handle the
×
2137
                                // timeout case for us.
×
2138
                                timeoutCtx, cancel := context.WithTimeout(
×
2139
                                        context.Background(),
×
2140
                                        cfg.HealthChecks.LeaderCheck.Timeout,
×
2141
                                )
×
2142
                                defer cancel()
×
2143

×
2144
                                leader, err := leaderElector.IsLeader(
×
2145
                                        timeoutCtx,
×
2146
                                )
×
2147
                                if err != nil {
×
2148
                                        return fmt.Errorf("unable to check if "+
×
2149
                                                "still leader: %v", err)
×
2150
                                }
×
2151

2152
                                if !leader {
×
2153
                                        srvrLog.Debug("Not the current leader")
×
2154
                                        return fmt.Errorf("not the current " +
×
2155
                                                "leader")
×
2156
                                }
×
2157

2158
                                return nil
×
2159
                        },
2160
                        cfg.HealthChecks.LeaderCheck.Interval,
2161
                        cfg.HealthChecks.LeaderCheck.Timeout,
2162
                        cfg.HealthChecks.LeaderCheck.Backoff,
2163
                        cfg.HealthChecks.LeaderCheck.Attempts,
2164
                )
2165

2166
                checks = append(checks, leaderCheck)
×
2167
        }
2168

2169
        // If we have not disabled all of our health checks, we create a
2170
        // liveness monitor with our configured checks.
2171
        s.livenessMonitor = healthcheck.NewMonitor(
3✔
2172
                &healthcheck.Config{
3✔
2173
                        Checks:   checks,
3✔
2174
                        Shutdown: srvrLog.Criticalf,
3✔
2175
                },
3✔
2176
        )
3✔
2177
}
2178

2179
// Started returns true if the server has been started, and false otherwise.
2180
// NOTE: This function is safe for concurrent access.
2181
func (s *server) Started() bool {
3✔
2182
        return atomic.LoadInt32(&s.active) != 0
3✔
2183
}
3✔
2184

2185
// cleaner is used to aggregate "cleanup" functions during an operation that
2186
// starts several subsystems. In case one of the subsystem fails to start
2187
// and a proper resource cleanup is required, the "run" method achieves this
2188
// by running all these added "cleanup" functions.
2189
type cleaner []func() error
2190

2191
// add is used to add a cleanup function to be called when
2192
// the run function is executed.
2193
func (c cleaner) add(cleanup func() error) cleaner {
3✔
2194
        return append(c, cleanup)
3✔
2195
}
3✔
2196

2197
// run is used to run all the previousely added cleanup functions.
2198
func (c cleaner) run() {
×
2199
        for i := len(c) - 1; i >= 0; i-- {
×
2200
                if err := c[i](); err != nil {
×
2201
                        srvrLog.Infof("Cleanup failed: %v", err)
×
2202
                }
×
2203
        }
2204
}
2205

2206
// startLowLevelServices starts the low-level services of the server. These
2207
// services must be started successfully before running the main server. The
2208
// services are,
2209
// 1. the chain notifier.
2210
//
2211
// TODO(yy): identify and add more low-level services here.
2212
func (s *server) startLowLevelServices() error {
3✔
2213
        var startErr error
3✔
2214

3✔
2215
        cleanup := cleaner{}
3✔
2216

3✔
2217
        cleanup = cleanup.add(s.cc.ChainNotifier.Stop)
3✔
2218
        if err := s.cc.ChainNotifier.Start(); err != nil {
3✔
2219
                startErr = err
×
2220
        }
×
2221

2222
        if startErr != nil {
3✔
2223
                cleanup.run()
×
2224
        }
×
2225

2226
        return startErr
3✔
2227
}
2228

2229
// Start starts the main daemon server, all requested listeners, and any helper
2230
// goroutines.
2231
// NOTE: This function is safe for concurrent access.
2232
//
2233
//nolint:funlen
2234
func (s *server) Start() error {
3✔
2235
        // Get the current blockbeat.
3✔
2236
        beat, err := s.getStartingBeat()
3✔
2237
        if err != nil {
3✔
2238
                return err
×
2239
        }
×
2240

2241
        var startErr error
3✔
2242

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

3✔
2248
        s.start.Do(func() {
6✔
2249
                cleanup = cleanup.add(s.customMessageServer.Stop)
3✔
2250
                if err := s.customMessageServer.Start(); err != nil {
3✔
2251
                        startErr = err
×
2252
                        return
×
2253
                }
×
2254

2255
                if s.hostAnn != nil {
3✔
2256
                        cleanup = cleanup.add(s.hostAnn.Stop)
×
2257
                        if err := s.hostAnn.Start(); err != nil {
×
2258
                                startErr = err
×
2259
                                return
×
2260
                        }
×
2261
                }
2262

2263
                if s.livenessMonitor != nil {
6✔
2264
                        cleanup = cleanup.add(s.livenessMonitor.Stop)
3✔
2265
                        if err := s.livenessMonitor.Start(); err != nil {
3✔
2266
                                startErr = err
×
2267
                                return
×
2268
                        }
×
2269
                }
2270

2271
                // Start the notification server. This is used so channel
2272
                // management goroutines can be notified when a funding
2273
                // transaction reaches a sufficient number of confirmations, or
2274
                // when the input for the funding transaction is spent in an
2275
                // attempt at an uncooperative close by the counterparty.
2276
                cleanup = cleanup.add(s.sigPool.Stop)
3✔
2277
                if err := s.sigPool.Start(); err != nil {
3✔
2278
                        startErr = err
×
2279
                        return
×
2280
                }
×
2281

2282
                cleanup = cleanup.add(s.writePool.Stop)
3✔
2283
                if err := s.writePool.Start(); err != nil {
3✔
2284
                        startErr = err
×
2285
                        return
×
2286
                }
×
2287

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

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

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

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

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

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

2328
                cleanup = cleanup.add(s.txPublisher.Stop)
3✔
2329
                if err := s.txPublisher.Start(beat); err != nil {
3✔
2330
                        startErr = err
×
2331
                        return
×
2332
                }
×
2333

2334
                cleanup = cleanup.add(s.sweeper.Stop)
3✔
2335
                if err := s.sweeper.Start(beat); err != nil {
3✔
2336
                        startErr = err
×
2337
                        return
×
2338
                }
×
2339

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

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

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

2358
                // htlcSwitch must be started before chainArb since the latter
2359
                // relies on htlcSwitch to deliver resolution message upon
2360
                // start.
2361
                cleanup = cleanup.add(s.htlcSwitch.Stop)
3✔
2362
                if err := s.htlcSwitch.Start(); err != nil {
3✔
2363
                        startErr = err
×
2364
                        return
×
2365
                }
×
2366

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

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

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

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

2391
                cleanup = cleanup.add(s.chanRouter.Stop)
3✔
2392
                if err := s.chanRouter.Start(); err != nil {
3✔
2393
                        startErr = err
×
2394
                        return
×
2395
                }
×
2396
                // The authGossiper depends on the chanRouter and therefore
2397
                // should be started after it.
2398
                cleanup = cleanup.add(s.authGossiper.Stop)
3✔
2399
                if err := s.authGossiper.Start(); err != nil {
3✔
2400
                        startErr = err
×
2401
                        return
×
2402
                }
×
2403

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

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

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

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

2428
                cleanup.add(func() error {
3✔
2429
                        s.missionController.StopStoreTickers()
×
2430
                        return nil
×
2431
                })
×
2432
                s.missionController.RunStoreTickers()
3✔
2433

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

2466
                // chanSubSwapper must be started after the `channelNotifier`
2467
                // because it depends on channel events as a synchronization
2468
                // point.
2469
                cleanup = cleanup.add(s.chanSubSwapper.Stop)
3✔
2470
                if err := s.chanSubSwapper.Start(); err != nil {
3✔
2471
                        startErr = err
×
2472
                        return
×
2473
                }
×
2474

2475
                if s.torController != nil {
3✔
2476
                        cleanup = cleanup.add(s.torController.Stop)
×
2477
                        if err := s.createNewHiddenService(); err != nil {
×
2478
                                startErr = err
×
2479
                                return
×
2480
                        }
×
2481
                }
2482

2483
                if s.natTraversal != nil {
3✔
2484
                        s.wg.Add(1)
×
2485
                        go s.watchExternalIP()
×
2486
                }
×
2487

2488
                // Start connmgr last to prevent connections before init.
2489
                cleanup = cleanup.add(func() error {
3✔
2490
                        s.connMgr.Stop()
×
2491
                        return nil
×
2492
                })
×
2493

2494
                // RESOLVE: s.connMgr.Start() is called here, but
2495
                // brontide.NewListener() is called in newServer. This means
2496
                // that we are actually listening and partially accepting
2497
                // inbound connections even before the connMgr starts.
2498
                s.connMgr.Start()
3✔
2499

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

2519
                        peerAddr := &lnwire.NetAddress{
3✔
2520
                                IdentityKey: parsedPubkey,
3✔
2521
                                Address:     addr,
3✔
2522
                                ChainNet:    s.cfg.ActiveNetParams.Net,
3✔
2523
                        }
3✔
2524

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

2537
                // Subscribe to NodeAnnouncements that advertise new addresses
2538
                // our persistent peers.
2539
                if err := s.updatePersistentPeerAddrs(); err != nil {
3✔
2540
                        startErr = err
×
2541
                        return
×
2542
                }
×
2543

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

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

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

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

2582
                                copy(result[idx][:], servers)
×
2583
                        }
2584

2585
                        chainreg.ChainDNSSeeds[genesisHash] = result
×
2586
                }
2587

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

2609
                // If network bootstrapping hasn't been disabled, then we'll
2610
                // configure the set of active bootstrappers, and launch a
2611
                // dedicated goroutine to maintain a set of persistent
2612
                // connections.
2613
                if shouldPeerBootstrap(s.cfg) {
3✔
2614
                        bootstrappers, err := initNetworkBootstrappers(s)
×
2615
                        if err != nil {
×
2616
                                startErr = err
×
2617
                                return
×
2618
                        }
×
2619

2620
                        s.wg.Add(1)
×
2621
                        go s.peerBootstrapper(defaultMinPeers, bootstrappers)
×
2622
                } else {
3✔
2623
                        srvrLog.Infof("Auto peer bootstrapping is disabled")
3✔
2624
                }
3✔
2625

2626
                // Start the blockbeat after all other subsystems have been
2627
                // started so they are ready to receive new blocks.
2628
                cleanup = cleanup.add(func() error {
3✔
2629
                        s.blockbeatDispatcher.Stop()
×
2630
                        return nil
×
2631
                })
×
2632
                if err := s.blockbeatDispatcher.Start(); err != nil {
3✔
2633
                        startErr = err
×
2634
                        return
×
2635
                }
×
2636

2637
                // Set the active flag now that we've completed the full
2638
                // startup.
2639
                atomic.StoreInt32(&s.active, 1)
3✔
2640
        })
2641

2642
        if startErr != nil {
3✔
2643
                cleanup.run()
×
2644
        }
×
2645
        return startErr
3✔
2646
}
2647

2648
// Stop gracefully shutsdown the main daemon server. This function will signal
2649
// any active goroutines, or helper objects to exit, then blocks until they've
2650
// all successfully exited. Additionally, any/all listeners are closed.
2651
// NOTE: This function is safe for concurrent access.
2652
func (s *server) Stop() error {
3✔
2653
        s.stop.Do(func() {
6✔
2654
                atomic.StoreInt32(&s.stopping, 1)
3✔
2655

3✔
2656
                close(s.quit)
3✔
2657

3✔
2658
                // Shutdown connMgr first to prevent conns during shutdown.
3✔
2659
                s.connMgr.Stop()
3✔
2660

3✔
2661
                // Stop dispatching blocks to other systems immediately.
3✔
2662
                s.blockbeatDispatcher.Stop()
3✔
2663

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

2723
                // Update channel.backup file. Make sure to do it before
2724
                // stopping chanSubSwapper.
2725
                singles, err := chanbackup.FetchStaticChanBackups(
3✔
2726
                        s.chanStateDB, s.addrSource,
3✔
2727
                )
3✔
2728
                if err != nil {
3✔
2729
                        srvrLog.Warnf("failed to fetch channel states: %v",
×
2730
                                err)
×
2731
                } else {
3✔
2732
                        err := s.chanSubSwapper.ManualUpdate(singles)
3✔
2733
                        if err != nil {
6✔
2734
                                srvrLog.Warnf("Manual update of channel "+
3✔
2735
                                        "backup failed: %v", err)
3✔
2736
                        }
3✔
2737
                }
2738

2739
                if err := s.chanSubSwapper.Stop(); err != nil {
3✔
2740
                        srvrLog.Warnf("failed to stop chanSubSwapper: %v", err)
×
2741
                }
×
2742
                if err := s.cc.ChainNotifier.Stop(); err != nil {
3✔
2743
                        srvrLog.Warnf("Unable to stop ChainNotifier: %v", err)
×
2744
                }
×
2745
                if err := s.cc.BestBlockTracker.Stop(); err != nil {
3✔
2746
                        srvrLog.Warnf("Unable to stop BestBlockTracker: %v",
×
2747
                                err)
×
2748
                }
×
2749
                if err := s.chanEventStore.Stop(); err != nil {
3✔
2750
                        srvrLog.Warnf("Unable to stop ChannelEventStore: %v",
×
2751
                                err)
×
2752
                }
×
2753
                s.missionController.StopStoreTickers()
3✔
2754

3✔
2755
                // Disconnect from each active peers to ensure that
3✔
2756
                // peerTerminationWatchers signal completion to each peer.
3✔
2757
                for _, peer := range s.Peers() {
6✔
2758
                        err := s.DisconnectPeer(peer.IdentityKey())
3✔
2759
                        if err != nil {
3✔
2760
                                srvrLog.Warnf("could not disconnect peer: %v"+
×
2761
                                        "received error: %v", peer.IdentityKey(),
×
2762
                                        err,
×
2763
                                )
×
2764
                        }
×
2765
                }
2766

2767
                // Now that all connections have been torn down, stop the tower
2768
                // client which will reliably flush all queued states to the
2769
                // tower. If this is halted for any reason, the force quit timer
2770
                // will kick in and abort to allow this method to return.
2771
                if s.towerClientMgr != nil {
6✔
2772
                        if err := s.towerClientMgr.Stop(); err != nil {
3✔
2773
                                srvrLog.Warnf("Unable to shut down tower "+
×
2774
                                        "client manager: %v", err)
×
2775
                        }
×
2776
                }
2777

2778
                if s.hostAnn != nil {
3✔
2779
                        if err := s.hostAnn.Stop(); err != nil {
×
2780
                                srvrLog.Warnf("unable to shut down host "+
×
2781
                                        "annoucner: %v", err)
×
2782
                        }
×
2783
                }
2784

2785
                if s.livenessMonitor != nil {
6✔
2786
                        if err := s.livenessMonitor.Stop(); err != nil {
3✔
2787
                                srvrLog.Warnf("unable to shutdown liveness "+
×
2788
                                        "monitor: %v", err)
×
2789
                        }
×
2790
                }
2791

2792
                // Wait for all lingering goroutines to quit.
2793
                srvrLog.Debug("Waiting for server to shutdown...")
3✔
2794
                s.wg.Wait()
3✔
2795

3✔
2796
                srvrLog.Debug("Stopping buffer pools...")
3✔
2797
                s.sigPool.Stop()
3✔
2798
                s.writePool.Stop()
3✔
2799
                s.readPool.Stop()
3✔
2800
        })
2801

2802
        return nil
3✔
2803
}
2804

2805
// Stopped returns true if the server has been instructed to shutdown.
2806
// NOTE: This function is safe for concurrent access.
2807
func (s *server) Stopped() bool {
3✔
2808
        return atomic.LoadInt32(&s.stopping) != 0
3✔
2809
}
3✔
2810

2811
// configurePortForwarding attempts to set up port forwarding for the different
2812
// ports that the server will be listening on.
2813
//
2814
// NOTE: This should only be used when using some kind of NAT traversal to
2815
// automatically set up forwarding rules.
2816
func (s *server) configurePortForwarding(ports ...uint16) ([]string, error) {
×
2817
        ip, err := s.natTraversal.ExternalIP()
×
2818
        if err != nil {
×
2819
                return nil, err
×
2820
        }
×
2821
        s.lastDetectedIP = ip
×
2822

×
2823
        externalIPs := make([]string, 0, len(ports))
×
2824
        for _, port := range ports {
×
2825
                if err := s.natTraversal.AddPortMapping(port); err != nil {
×
2826
                        srvrLog.Debugf("Unable to forward port %d: %v", port, err)
×
2827
                        continue
×
2828
                }
2829

2830
                hostIP := fmt.Sprintf("%v:%d", ip, port)
×
2831
                externalIPs = append(externalIPs, hostIP)
×
2832
        }
2833

2834
        return externalIPs, nil
×
2835
}
2836

2837
// removePortForwarding attempts to clear the forwarding rules for the different
2838
// ports the server is currently listening on.
2839
//
2840
// NOTE: This should only be used when using some kind of NAT traversal to
2841
// automatically set up forwarding rules.
2842
func (s *server) removePortForwarding() {
×
2843
        forwardedPorts := s.natTraversal.ForwardedPorts()
×
2844
        for _, port := range forwardedPorts {
×
2845
                if err := s.natTraversal.DeletePortMapping(port); err != nil {
×
2846
                        srvrLog.Errorf("Unable to remove forwarding rules for "+
×
2847
                                "port %d: %v", port, err)
×
2848
                }
×
2849
        }
2850
}
2851

2852
// watchExternalIP continuously checks for an updated external IP address every
2853
// 15 minutes. Once a new IP address has been detected, it will automatically
2854
// handle port forwarding rules and send updated node announcements to the
2855
// currently connected peers.
2856
//
2857
// NOTE: This MUST be run as a goroutine.
2858
func (s *server) watchExternalIP() {
×
2859
        defer s.wg.Done()
×
2860

×
2861
        // Before exiting, we'll make sure to remove the forwarding rules set
×
2862
        // up by the server.
×
2863
        defer s.removePortForwarding()
×
2864

×
2865
        // Keep track of the external IPs set by the user to avoid replacing
×
2866
        // them when detecting a new IP.
×
2867
        ipsSetByUser := make(map[string]struct{})
×
2868
        for _, ip := range s.cfg.ExternalIPs {
×
2869
                ipsSetByUser[ip.String()] = struct{}{}
×
2870
        }
×
2871

2872
        forwardedPorts := s.natTraversal.ForwardedPorts()
×
2873

×
2874
        ticker := time.NewTicker(15 * time.Minute)
×
2875
        defer ticker.Stop()
×
2876
out:
×
2877
        for {
×
2878
                select {
×
2879
                case <-ticker.C:
×
2880
                        // We'll start off by making sure a new IP address has
×
2881
                        // been detected.
×
2882
                        ip, err := s.natTraversal.ExternalIP()
×
2883
                        if err != nil {
×
2884
                                srvrLog.Debugf("Unable to retrieve the "+
×
2885
                                        "external IP address: %v", err)
×
2886
                                continue
×
2887
                        }
2888

2889
                        // Periodically renew the NAT port forwarding.
2890
                        for _, port := range forwardedPorts {
×
2891
                                err := s.natTraversal.AddPortMapping(port)
×
2892
                                if err != nil {
×
2893
                                        srvrLog.Warnf("Unable to automatically "+
×
2894
                                                "re-create port forwarding using %s: %v",
×
2895
                                                s.natTraversal.Name(), err)
×
2896
                                } else {
×
2897
                                        srvrLog.Debugf("Automatically re-created "+
×
2898
                                                "forwarding for port %d using %s to "+
×
2899
                                                "advertise external IP",
×
2900
                                                port, s.natTraversal.Name())
×
2901
                                }
×
2902
                        }
2903

2904
                        if ip.Equal(s.lastDetectedIP) {
×
2905
                                continue
×
2906
                        }
2907

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

×
2910
                        // Next, we'll craft the new addresses that will be
×
2911
                        // included in the new node announcement and advertised
×
2912
                        // to the network. Each address will consist of the new
×
2913
                        // IP detected and one of the currently advertised
×
2914
                        // ports.
×
2915
                        var newAddrs []net.Addr
×
2916
                        for _, port := range forwardedPorts {
×
2917
                                hostIP := fmt.Sprintf("%v:%d", ip, port)
×
2918
                                addr, err := net.ResolveTCPAddr("tcp", hostIP)
×
2919
                                if err != nil {
×
2920
                                        srvrLog.Debugf("Unable to resolve "+
×
2921
                                                "host %v: %v", addr, err)
×
2922
                                        continue
×
2923
                                }
2924

2925
                                newAddrs = append(newAddrs, addr)
×
2926
                        }
2927

2928
                        // Skip the update if we weren't able to resolve any of
2929
                        // the new addresses.
2930
                        if len(newAddrs) == 0 {
×
2931
                                srvrLog.Debug("Skipping node announcement " +
×
2932
                                        "update due to not being able to " +
×
2933
                                        "resolve any new addresses")
×
2934
                                continue
×
2935
                        }
2936

2937
                        // Now, we'll need to update the addresses in our node's
2938
                        // announcement in order to propagate the update
2939
                        // throughout the network. We'll only include addresses
2940
                        // that have a different IP from the previous one, as
2941
                        // the previous IP is no longer valid.
2942
                        currentNodeAnn := s.getNodeAnnouncement()
×
2943

×
2944
                        for _, addr := range currentNodeAnn.Addresses {
×
2945
                                host, _, err := net.SplitHostPort(addr.String())
×
2946
                                if err != nil {
×
2947
                                        srvrLog.Debugf("Unable to determine "+
×
2948
                                                "host from address %v: %v",
×
2949
                                                addr, err)
×
2950
                                        continue
×
2951
                                }
2952

2953
                                // We'll also make sure to include external IPs
2954
                                // set manually by the user.
2955
                                _, setByUser := ipsSetByUser[addr.String()]
×
2956
                                if setByUser || host != s.lastDetectedIP.String() {
×
2957
                                        newAddrs = append(newAddrs, addr)
×
2958
                                }
×
2959
                        }
2960

2961
                        // Then, we'll generate a new timestamped node
2962
                        // announcement with the updated addresses and broadcast
2963
                        // it to our peers.
2964
                        newNodeAnn, err := s.genNodeAnnouncement(
×
2965
                                nil, netann.NodeAnnSetAddrs(newAddrs),
×
2966
                        )
×
2967
                        if err != nil {
×
2968
                                srvrLog.Debugf("Unable to generate new node "+
×
2969
                                        "announcement: %v", err)
×
2970
                                continue
×
2971
                        }
2972

2973
                        err = s.BroadcastMessage(nil, &newNodeAnn)
×
2974
                        if err != nil {
×
2975
                                srvrLog.Debugf("Unable to broadcast new node "+
×
2976
                                        "announcement to peers: %v", err)
×
2977
                                continue
×
2978
                        }
2979

2980
                        // Finally, update the last IP seen to the current one.
2981
                        s.lastDetectedIP = ip
×
2982
                case <-s.quit:
×
2983
                        break out
×
2984
                }
2985
        }
2986
}
2987

2988
// initNetworkBootstrappers initializes a set of network peer bootstrappers
2989
// based on the server, and currently active bootstrap mechanisms as defined
2990
// within the current configuration.
2991
func initNetworkBootstrappers(s *server) ([]discovery.NetworkPeerBootstrapper, error) {
×
2992
        srvrLog.Infof("Initializing peer network bootstrappers!")
×
2993

×
2994
        var bootStrappers []discovery.NetworkPeerBootstrapper
×
2995

×
2996
        // First, we'll create an instance of the ChannelGraphBootstrapper as
×
2997
        // this can be used by default if we've already partially seeded the
×
2998
        // network.
×
2999
        chanGraph := autopilot.ChannelGraphFromDatabase(s.graphDB)
×
3000
        graphBootstrapper, err := discovery.NewGraphBootstrapper(chanGraph)
×
3001
        if err != nil {
×
3002
                return nil, err
×
3003
        }
×
3004
        bootStrappers = append(bootStrappers, graphBootstrapper)
×
3005

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

×
3011
                // If we have a set of DNS seeds for this chain, then we'll add
×
3012
                // it as an additional bootstrapping source.
×
3013
                if ok {
×
3014
                        srvrLog.Infof("Creating DNS peer bootstrapper with "+
×
3015
                                "seeds: %v", dnsSeeds)
×
3016

×
3017
                        dnsBootStrapper := discovery.NewDNSSeedBootstrapper(
×
3018
                                dnsSeeds, s.cfg.net, s.cfg.ConnectionTimeout,
×
3019
                        )
×
3020
                        bootStrappers = append(bootStrappers, dnsBootStrapper)
×
3021
                }
×
3022
        }
3023

3024
        return bootStrappers, nil
×
3025
}
3026

3027
// createBootstrapIgnorePeers creates a map of peers that the bootstrap process
3028
// needs to ignore, which is made of three parts,
3029
//   - the node itself needs to be skipped as it doesn't make sense to connect
3030
//     to itself.
3031
//   - the peers that already have connections with, as in s.peersByPub.
3032
//   - the peers that we are attempting to connect, as in s.persistentPeers.
3033
func (s *server) createBootstrapIgnorePeers() map[autopilot.NodeID]struct{} {
×
3034
        s.mu.RLock()
×
3035
        defer s.mu.RUnlock()
×
3036

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

×
3039
        // We should ignore ourselves from bootstrapping.
×
3040
        selfKey := autopilot.NewNodeID(s.identityECDH.PubKey())
×
3041
        ignore[selfKey] = struct{}{}
×
3042

×
3043
        // Ignore all connected peers.
×
3044
        for _, peer := range s.peersByPub {
×
3045
                nID := autopilot.NewNodeID(peer.IdentityKey())
×
3046
                ignore[nID] = struct{}{}
×
3047
        }
×
3048

3049
        // Ignore all persistent peers as they have a dedicated reconnecting
3050
        // process.
3051
        for pubKeyStr := range s.persistentPeers {
×
3052
                var nID autopilot.NodeID
×
3053
                copy(nID[:], []byte(pubKeyStr))
×
3054
                ignore[nID] = struct{}{}
×
3055
        }
×
3056

3057
        return ignore
×
3058
}
3059

3060
// peerBootstrapper is a goroutine which is tasked with attempting to establish
3061
// and maintain a target minimum number of outbound connections. With this
3062
// invariant, we ensure that our node is connected to a diverse set of peers
3063
// and that nodes newly joining the network receive an up to date network view
3064
// as soon as possible.
3065
func (s *server) peerBootstrapper(numTargetPeers uint32,
3066
        bootstrappers []discovery.NetworkPeerBootstrapper) {
×
3067

×
3068
        defer s.wg.Done()
×
3069

×
3070
        // Before we continue, init the ignore peers map.
×
3071
        ignoreList := s.createBootstrapIgnorePeers()
×
3072

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

×
3077
        // Once done, we'll attempt to maintain our target minimum number of
×
3078
        // peers.
×
3079
        //
×
3080
        // We'll use a 15 second backoff, and double the time every time an
×
3081
        // epoch fails up to a ceiling.
×
3082
        backOff := time.Second * 15
×
3083

×
3084
        // We'll create a new ticker to wake us up every 15 seconds so we can
×
3085
        // see if we've reached our minimum number of peers.
×
3086
        sampleTicker := time.NewTicker(backOff)
×
3087
        defer sampleTicker.Stop()
×
3088

×
3089
        // We'll use the number of attempts and errors to determine if we need
×
3090
        // to increase the time between discovery epochs.
×
3091
        var epochErrors uint32 // To be used atomically.
×
3092
        var epochAttempts uint32
×
3093

×
3094
        for {
×
3095
                select {
×
3096
                // The ticker has just woken us up, so we'll need to check if
3097
                // we need to attempt to connect our to any more peers.
3098
                case <-sampleTicker.C:
×
3099
                        // Obtain the current number of peers, so we can gauge
×
3100
                        // if we need to sample more peers or not.
×
3101
                        s.mu.RLock()
×
3102
                        numActivePeers := uint32(len(s.peersByPub))
×
3103
                        s.mu.RUnlock()
×
3104

×
3105
                        // If we have enough peers, then we can loop back
×
3106
                        // around to the next round as we're done here.
×
3107
                        if numActivePeers >= numTargetPeers {
×
3108
                                continue
×
3109
                        }
3110

3111
                        // If all of our attempts failed during this last back
3112
                        // off period, then will increase our backoff to 5
3113
                        // minute ceiling to avoid an excessive number of
3114
                        // queries
3115
                        //
3116
                        // TODO(roasbeef): add reverse policy too?
3117

3118
                        if epochAttempts > 0 &&
×
3119
                                atomic.LoadUint32(&epochErrors) >= epochAttempts {
×
3120

×
3121
                                sampleTicker.Stop()
×
3122

×
3123
                                backOff *= 2
×
3124
                                if backOff > bootstrapBackOffCeiling {
×
3125
                                        backOff = bootstrapBackOffCeiling
×
3126
                                }
×
3127

3128
                                srvrLog.Debugf("Backing off peer bootstrapper to "+
×
3129
                                        "%v", backOff)
×
3130
                                sampleTicker = time.NewTicker(backOff)
×
3131
                                continue
×
3132
                        }
3133

3134
                        atomic.StoreUint32(&epochErrors, 0)
×
3135
                        epochAttempts = 0
×
3136

×
3137
                        // Since we know need more peers, we'll compute the
×
3138
                        // exact number we need to reach our threshold.
×
3139
                        numNeeded := numTargetPeers - numActivePeers
×
3140

×
3141
                        srvrLog.Debugf("Attempting to obtain %v more network "+
×
3142
                                "peers", numNeeded)
×
3143

×
3144
                        // With the number of peers we need calculated, we'll
×
3145
                        // query the network bootstrappers to sample a set of
×
3146
                        // random addrs for us.
×
3147
                        //
×
3148
                        // Before we continue, get a copy of the ignore peers
×
3149
                        // map.
×
3150
                        ignoreList = s.createBootstrapIgnorePeers()
×
3151

×
3152
                        peerAddrs, err := discovery.MultiSourceBootstrap(
×
3153
                                ignoreList, numNeeded*2, bootstrappers...,
×
3154
                        )
×
3155
                        if err != nil {
×
3156
                                srvrLog.Errorf("Unable to retrieve bootstrap "+
×
3157
                                        "peers: %v", err)
×
3158
                                continue
×
3159
                        }
3160

3161
                        // Finally, we'll launch a new goroutine for each
3162
                        // prospective peer candidates.
3163
                        for _, addr := range peerAddrs {
×
3164
                                epochAttempts++
×
3165

×
3166
                                go func(a *lnwire.NetAddress) {
×
3167
                                        // TODO(roasbeef): can do AS, subnet,
×
3168
                                        // country diversity, etc
×
3169
                                        errChan := make(chan error, 1)
×
3170
                                        s.connectToPeer(
×
3171
                                                a, errChan,
×
3172
                                                s.cfg.ConnectionTimeout,
×
3173
                                        )
×
3174
                                        select {
×
3175
                                        case err := <-errChan:
×
3176
                                                if err == nil {
×
3177
                                                        return
×
3178
                                                }
×
3179

3180
                                                srvrLog.Errorf("Unable to "+
×
3181
                                                        "connect to %v: %v",
×
3182
                                                        a, err)
×
3183
                                                atomic.AddUint32(&epochErrors, 1)
×
3184
                                        case <-s.quit:
×
3185
                                        }
3186
                                }(addr)
3187
                        }
3188
                case <-s.quit:
×
3189
                        return
×
3190
                }
3191
        }
3192
}
3193

3194
// bootstrapBackOffCeiling is the maximum amount of time we'll wait between
3195
// failed attempts to locate a set of bootstrap peers. We'll slowly double our
3196
// query back off each time we encounter a failure.
3197
const bootstrapBackOffCeiling = time.Minute * 5
3198

3199
// initialPeerBootstrap attempts to continuously connect to peers on startup
3200
// until the target number of peers has been reached. This ensures that nodes
3201
// receive an up to date network view as soon as possible.
3202
func (s *server) initialPeerBootstrap(ignore map[autopilot.NodeID]struct{},
3203
        numTargetPeers uint32,
3204
        bootstrappers []discovery.NetworkPeerBootstrapper) {
×
3205

×
3206
        srvrLog.Debugf("Init bootstrap with targetPeers=%v, bootstrappers=%v, "+
×
3207
                "ignore=%v", numTargetPeers, len(bootstrappers), len(ignore))
×
3208

×
3209
        // We'll start off by waiting 2 seconds between failed attempts, then
×
3210
        // double each time we fail until we hit the bootstrapBackOffCeiling.
×
3211
        var delaySignal <-chan time.Time
×
3212
        delayTime := time.Second * 2
×
3213

×
3214
        // As want to be more aggressive, we'll use a lower back off celling
×
3215
        // then the main peer bootstrap logic.
×
3216
        backOffCeiling := bootstrapBackOffCeiling / 5
×
3217

×
3218
        for attempts := 0; ; attempts++ {
×
3219
                // Check if the server has been requested to shut down in order
×
3220
                // to prevent blocking.
×
3221
                if s.Stopped() {
×
3222
                        return
×
3223
                }
×
3224

3225
                // We can exit our aggressive initial peer bootstrapping stage
3226
                // if we've reached out target number of peers.
3227
                s.mu.RLock()
×
3228
                numActivePeers := uint32(len(s.peersByPub))
×
3229
                s.mu.RUnlock()
×
3230

×
3231
                if numActivePeers >= numTargetPeers {
×
3232
                        return
×
3233
                }
×
3234

3235
                if attempts > 0 {
×
3236
                        srvrLog.Debugf("Waiting %v before trying to locate "+
×
3237
                                "bootstrap peers (attempt #%v)", delayTime,
×
3238
                                attempts)
×
3239

×
3240
                        // We've completed at least one iterating and haven't
×
3241
                        // finished, so we'll start to insert a delay period
×
3242
                        // between each attempt.
×
3243
                        delaySignal = time.After(delayTime)
×
3244
                        select {
×
3245
                        case <-delaySignal:
×
3246
                        case <-s.quit:
×
3247
                                return
×
3248
                        }
3249

3250
                        // After our delay, we'll double the time we wait up to
3251
                        // the max back off period.
3252
                        delayTime *= 2
×
3253
                        if delayTime > backOffCeiling {
×
3254
                                delayTime = backOffCeiling
×
3255
                        }
×
3256
                }
3257

3258
                // Otherwise, we'll request for the remaining number of peers
3259
                // in order to reach our target.
3260
                peersNeeded := numTargetPeers - numActivePeers
×
3261
                bootstrapAddrs, err := discovery.MultiSourceBootstrap(
×
3262
                        ignore, peersNeeded, bootstrappers...,
×
3263
                )
×
3264
                if err != nil {
×
3265
                        srvrLog.Errorf("Unable to retrieve initial bootstrap "+
×
3266
                                "peers: %v", err)
×
3267
                        continue
×
3268
                }
3269

3270
                // Then, we'll attempt to establish a connection to the
3271
                // different peer addresses retrieved by our bootstrappers.
3272
                var wg sync.WaitGroup
×
3273
                for _, bootstrapAddr := range bootstrapAddrs {
×
3274
                        wg.Add(1)
×
3275
                        go func(addr *lnwire.NetAddress) {
×
3276
                                defer wg.Done()
×
3277

×
3278
                                errChan := make(chan error, 1)
×
3279
                                go s.connectToPeer(
×
3280
                                        addr, errChan, s.cfg.ConnectionTimeout,
×
3281
                                )
×
3282

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

3306
                wg.Wait()
×
3307
        }
3308
}
3309

3310
// createNewHiddenService automatically sets up a v2 or v3 onion service in
3311
// order to listen for inbound connections over Tor.
3312
func (s *server) createNewHiddenService() error {
×
3313
        // Determine the different ports the server is listening on. The onion
×
3314
        // service's virtual port will map to these ports and one will be picked
×
3315
        // at random when the onion service is being accessed.
×
3316
        listenPorts := make([]int, 0, len(s.listenAddrs))
×
3317
        for _, listenAddr := range s.listenAddrs {
×
3318
                port := listenAddr.(*net.TCPAddr).Port
×
3319
                listenPorts = append(listenPorts, port)
×
3320
        }
×
3321

3322
        encrypter, err := lnencrypt.KeyRingEncrypter(s.cc.KeyRing)
×
3323
        if err != nil {
×
3324
                return err
×
3325
        }
×
3326

3327
        // Once the port mapping has been set, we can go ahead and automatically
3328
        // create our onion service. The service's private key will be saved to
3329
        // disk in order to regain access to this service when restarting `lnd`.
3330
        onionCfg := tor.AddOnionConfig{
×
3331
                VirtualPort: defaultPeerPort,
×
3332
                TargetPorts: listenPorts,
×
3333
                Store: tor.NewOnionFile(
×
3334
                        s.cfg.Tor.PrivateKeyPath, 0600, s.cfg.Tor.EncryptKey,
×
3335
                        encrypter,
×
3336
                ),
×
3337
        }
×
3338

×
3339
        switch {
×
3340
        case s.cfg.Tor.V2:
×
3341
                onionCfg.Type = tor.V2
×
3342
        case s.cfg.Tor.V3:
×
3343
                onionCfg.Type = tor.V3
×
3344
        }
3345

3346
        addr, err := s.torController.AddOnion(onionCfg)
×
3347
        if err != nil {
×
3348
                return err
×
3349
        }
×
3350

3351
        // Now that the onion service has been created, we'll add the onion
3352
        // address it can be reached at to our list of advertised addresses.
3353
        newNodeAnn, err := s.genNodeAnnouncement(
×
3354
                nil, func(currentAnn *lnwire.NodeAnnouncement) {
×
3355
                        currentAnn.Addresses = append(currentAnn.Addresses, addr)
×
3356
                },
×
3357
        )
3358
        if err != nil {
×
3359
                return fmt.Errorf("unable to generate new node "+
×
3360
                        "announcement: %v", err)
×
3361
        }
×
3362

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

3381
        return nil
×
3382
}
3383

3384
// findChannel finds a channel given a public key and ChannelID. It is an
3385
// optimization that is quicker than seeking for a channel given only the
3386
// ChannelID.
3387
func (s *server) findChannel(node *btcec.PublicKey, chanID lnwire.ChannelID) (
3388
        *channeldb.OpenChannel, error) {
3✔
3389

3✔
3390
        nodeChans, err := s.chanStateDB.FetchOpenChannels(node)
3✔
3391
        if err != nil {
3✔
3392
                return nil, err
×
3393
        }
×
3394

3395
        for _, channel := range nodeChans {
6✔
3396
                if chanID.IsChanPoint(&channel.FundingOutpoint) {
6✔
3397
                        return channel, nil
3✔
3398
                }
3✔
3399
        }
3400

3401
        return nil, fmt.Errorf("unable to find channel")
3✔
3402
}
3403

3404
// getNodeAnnouncement fetches the current, fully signed node announcement.
3405
func (s *server) getNodeAnnouncement() lnwire.NodeAnnouncement {
3✔
3406
        s.mu.Lock()
3✔
3407
        defer s.mu.Unlock()
3✔
3408

3✔
3409
        return *s.currentNodeAnn
3✔
3410
}
3✔
3411

3412
// genNodeAnnouncement generates and returns the current fully signed node
3413
// announcement. The time stamp of the announcement will be updated in order
3414
// to ensure it propagates through the network.
3415
func (s *server) genNodeAnnouncement(features *lnwire.RawFeatureVector,
3416
        modifiers ...netann.NodeAnnModifier) (lnwire.NodeAnnouncement, error) {
3✔
3417

3✔
3418
        s.mu.Lock()
3✔
3419
        defer s.mu.Unlock()
3✔
3420

3✔
3421
        // First, try to update our feature manager with the updated set of
3✔
3422
        // features.
3✔
3423
        if features != nil {
6✔
3424
                proposedFeatures := map[feature.Set]*lnwire.RawFeatureVector{
3✔
3425
                        feature.SetNodeAnn: features,
3✔
3426
                }
3✔
3427
                err := s.featureMgr.UpdateFeatureSets(proposedFeatures)
3✔
3428
                if err != nil {
6✔
3429
                        return lnwire.NodeAnnouncement{}, err
3✔
3430
                }
3✔
3431

3432
                // If we could successfully update our feature manager, add
3433
                // an update modifier to include these new features to our
3434
                // set.
3435
                modifiers = append(
3✔
3436
                        modifiers, netann.NodeAnnSetFeatures(features),
3✔
3437
                )
3✔
3438
        }
3439

3440
        // Always update the timestamp when refreshing to ensure the update
3441
        // propagates.
3442
        modifiers = append(modifiers, netann.NodeAnnSetTimestamp)
3✔
3443

3✔
3444
        // Apply the requested changes to the node announcement.
3✔
3445
        for _, modifier := range modifiers {
6✔
3446
                modifier(s.currentNodeAnn)
3✔
3447
        }
3✔
3448

3449
        // Sign a new update after applying all of the passed modifiers.
3450
        err := netann.SignNodeAnnouncement(
3✔
3451
                s.nodeSigner, s.identityKeyLoc, s.currentNodeAnn,
3✔
3452
        )
3✔
3453
        if err != nil {
3✔
3454
                return lnwire.NodeAnnouncement{}, err
×
3455
        }
×
3456

3457
        return *s.currentNodeAnn, nil
3✔
3458
}
3459

3460
// updateAndBroadcastSelfNode generates a new node announcement
3461
// applying the giving modifiers and updating the time stamp
3462
// to ensure it propagates through the network. Then it broadcasts
3463
// it to the network.
3464
func (s *server) updateAndBroadcastSelfNode(features *lnwire.RawFeatureVector,
3465
        modifiers ...netann.NodeAnnModifier) error {
3✔
3466

3✔
3467
        newNodeAnn, err := s.genNodeAnnouncement(features, modifiers...)
3✔
3468
        if err != nil {
6✔
3469
                return fmt.Errorf("unable to generate new node "+
3✔
3470
                        "announcement: %v", err)
3✔
3471
        }
3✔
3472

3473
        // Update the on-disk version of our announcement.
3474
        // Load and modify self node istead of creating anew instance so we
3475
        // don't risk overwriting any existing values.
3476
        selfNode, err := s.graphDB.SourceNode()
3✔
3477
        if err != nil {
3✔
3478
                return fmt.Errorf("unable to get current source node: %w", err)
×
3479
        }
×
3480

3481
        selfNode.HaveNodeAnnouncement = true
3✔
3482
        selfNode.LastUpdate = time.Unix(int64(newNodeAnn.Timestamp), 0)
3✔
3483
        selfNode.Addresses = newNodeAnn.Addresses
3✔
3484
        selfNode.Alias = newNodeAnn.Alias.String()
3✔
3485
        selfNode.Features = s.featureMgr.Get(feature.SetNodeAnn)
3✔
3486
        selfNode.Color = newNodeAnn.RGBColor
3✔
3487
        selfNode.AuthSigBytes = newNodeAnn.Signature.ToSignatureBytes()
3✔
3488

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

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

3495
        // Finally, propagate it to the nodes in the network.
3496
        err = s.BroadcastMessage(nil, &newNodeAnn)
3✔
3497
        if err != nil {
3✔
3498
                rpcsLog.Debugf("Unable to broadcast new node "+
×
3499
                        "announcement to peers: %v", err)
×
3500
                return err
×
3501
        }
×
3502

3503
        return nil
3✔
3504
}
3505

3506
type nodeAddresses struct {
3507
        pubKey    *btcec.PublicKey
3508
        addresses []net.Addr
3509
}
3510

3511
// establishPersistentConnections attempts to establish persistent connections
3512
// to all our direct channel collaborators. In order to promote liveness of our
3513
// active channels, we instruct the connection manager to attempt to establish
3514
// and maintain persistent connections to all our direct channel counterparties.
3515
func (s *server) establishPersistentConnections() error {
3✔
3516
        // nodeAddrsMap stores the combination of node public keys and addresses
3✔
3517
        // that we'll attempt to reconnect to. PubKey strings are used as keys
3✔
3518
        // since other PubKey forms can't be compared.
3✔
3519
        nodeAddrsMap := map[string]*nodeAddresses{}
3✔
3520

3✔
3521
        // Iterate through the list of LinkNodes to find addresses we should
3✔
3522
        // attempt to connect to based on our set of previous connections. Set
3✔
3523
        // the reconnection port to the default peer port.
3✔
3524
        linkNodes, err := s.chanStateDB.LinkNodeDB().FetchAllLinkNodes()
3✔
3525
        if err != nil && err != channeldb.ErrLinkNodesNotFound {
3✔
3526
                return err
×
3527
        }
×
3528
        for _, node := range linkNodes {
6✔
3529
                pubStr := string(node.IdentityPub.SerializeCompressed())
3✔
3530
                nodeAddrs := &nodeAddresses{
3✔
3531
                        pubKey:    node.IdentityPub,
3✔
3532
                        addresses: node.Addresses,
3✔
3533
                }
3✔
3534
                nodeAddrsMap[pubStr] = nodeAddrs
3✔
3535
        }
3✔
3536

3537
        // After checking our previous connections for addresses to connect to,
3538
        // iterate through the nodes in our channel graph to find addresses
3539
        // that have been added via NodeAnnouncement messages.
3540
        sourceNode, err := s.graphDB.SourceNode()
3✔
3541
        if err != nil {
3✔
3542
                return err
×
3543
        }
×
3544

3545
        // TODO(roasbeef): instead iterate over link nodes and query graph for
3546
        // each of the nodes.
3547
        selfPub := s.identityECDH.PubKey().SerializeCompressed()
3✔
3548
        err = s.graphDB.ForEachNodeChannel(sourceNode.PubKeyBytes, func(
3✔
3549
                tx kvdb.RTx,
3✔
3550
                chanInfo *models.ChannelEdgeInfo,
3✔
3551
                policy, _ *models.ChannelEdgePolicy) error {
6✔
3552

3✔
3553
                // If the remote party has announced the channel to us, but we
3✔
3554
                // haven't yet, then we won't have a policy. However, we don't
3✔
3555
                // need this to connect to the peer, so we'll log it and move on.
3✔
3556
                if policy == nil {
3✔
3557
                        srvrLog.Warnf("No channel policy found for "+
×
3558
                                "ChannelPoint(%v): ", chanInfo.ChannelPoint)
×
3559
                }
×
3560

3561
                // We'll now fetch the peer opposite from us within this
3562
                // channel so we can queue up a direct connection to them.
3563
                channelPeer, err := s.graphDB.FetchOtherNode(
3✔
3564
                        tx, chanInfo, selfPub,
3✔
3565
                )
3✔
3566
                if err != nil {
3✔
3567
                        return fmt.Errorf("unable to fetch channel peer for "+
×
3568
                                "ChannelPoint(%v): %v", chanInfo.ChannelPoint,
×
3569
                                err)
×
3570
                }
×
3571

3572
                pubStr := string(channelPeer.PubKeyBytes[:])
3✔
3573

3✔
3574
                // Add all unique addresses from channel
3✔
3575
                // graph/NodeAnnouncements to the list of addresses we'll
3✔
3576
                // connect to for this peer.
3✔
3577
                addrSet := make(map[string]net.Addr)
3✔
3578
                for _, addr := range channelPeer.Addresses {
6✔
3579
                        switch addr.(type) {
3✔
3580
                        case *net.TCPAddr:
3✔
3581
                                addrSet[addr.String()] = addr
3✔
3582

3583
                        // We'll only attempt to connect to Tor addresses if Tor
3584
                        // outbound support is enabled.
3585
                        case *tor.OnionAddr:
×
3586
                                if s.cfg.Tor.Active {
×
3587
                                        addrSet[addr.String()] = addr
×
3588
                                }
×
3589
                        }
3590
                }
3591

3592
                // If this peer is also recorded as a link node, we'll add any
3593
                // additional addresses that have not already been selected.
3594
                linkNodeAddrs, ok := nodeAddrsMap[pubStr]
3✔
3595
                if ok {
6✔
3596
                        for _, lnAddress := range linkNodeAddrs.addresses {
6✔
3597
                                switch lnAddress.(type) {
3✔
3598
                                case *net.TCPAddr:
3✔
3599
                                        addrSet[lnAddress.String()] = lnAddress
3✔
3600

3601
                                // We'll only attempt to connect to Tor
3602
                                // addresses if Tor outbound support is enabled.
3603
                                case *tor.OnionAddr:
×
3604
                                        if s.cfg.Tor.Active {
×
3605
                                                addrSet[lnAddress.String()] = lnAddress
×
3606
                                        }
×
3607
                                }
3608
                        }
3609
                }
3610

3611
                // Construct a slice of the deduped addresses.
3612
                var addrs []net.Addr
3✔
3613
                for _, addr := range addrSet {
6✔
3614
                        addrs = append(addrs, addr)
3✔
3615
                }
3✔
3616

3617
                n := &nodeAddresses{
3✔
3618
                        addresses: addrs,
3✔
3619
                }
3✔
3620
                n.pubKey, err = channelPeer.PubKey()
3✔
3621
                if err != nil {
3✔
3622
                        return err
×
3623
                }
×
3624

3625
                nodeAddrsMap[pubStr] = n
3✔
3626
                return nil
3✔
3627
        })
3628
        if err != nil && !errors.Is(err, graphdb.ErrGraphNoEdgesFound) {
3✔
3629
                return err
×
3630
        }
×
3631

3632
        srvrLog.Debugf("Establishing %v persistent connections on start",
3✔
3633
                len(nodeAddrsMap))
3✔
3634

3✔
3635
        // Acquire and hold server lock until all persistent connection requests
3✔
3636
        // have been recorded and sent to the connection manager.
3✔
3637
        s.mu.Lock()
3✔
3638
        defer s.mu.Unlock()
3✔
3639

3✔
3640
        // Iterate through the combined list of addresses from prior links and
3✔
3641
        // node announcements and attempt to reconnect to each node.
3✔
3642
        var numOutboundConns int
3✔
3643
        for pubStr, nodeAddr := range nodeAddrsMap {
6✔
3644
                // Add this peer to the set of peers we should maintain a
3✔
3645
                // persistent connection with. We set the value to false to
3✔
3646
                // indicate that we should not continue to reconnect if the
3✔
3647
                // number of channels returns to zero, since this peer has not
3✔
3648
                // been requested as perm by the user.
3✔
3649
                s.persistentPeers[pubStr] = false
3✔
3650
                if _, ok := s.persistentPeersBackoff[pubStr]; !ok {
6✔
3651
                        s.persistentPeersBackoff[pubStr] = s.cfg.MinBackoff
3✔
3652
                }
3✔
3653

3654
                for _, address := range nodeAddr.addresses {
6✔
3655
                        // Create a wrapper address which couples the IP and
3✔
3656
                        // the pubkey so the brontide authenticated connection
3✔
3657
                        // can be established.
3✔
3658
                        lnAddr := &lnwire.NetAddress{
3✔
3659
                                IdentityKey: nodeAddr.pubKey,
3✔
3660
                                Address:     address,
3✔
3661
                        }
3✔
3662

3✔
3663
                        s.persistentPeerAddrs[pubStr] = append(
3✔
3664
                                s.persistentPeerAddrs[pubStr], lnAddr)
3✔
3665
                }
3✔
3666

3667
                // We'll connect to the first 10 peers immediately, then
3668
                // randomly stagger any remaining connections if the
3669
                // stagger initial reconnect flag is set. This ensures
3670
                // that mobile nodes or nodes with a small number of
3671
                // channels obtain connectivity quickly, but larger
3672
                // nodes are able to disperse the costs of connecting to
3673
                // all peers at once.
3674
                if numOutboundConns < numInstantInitReconnect ||
3✔
3675
                        !s.cfg.StaggerInitialReconnect {
6✔
3676

3✔
3677
                        go s.connectToPersistentPeer(pubStr)
3✔
3678
                } else {
3✔
3679
                        go s.delayInitialReconnect(pubStr)
×
3680
                }
×
3681

3682
                numOutboundConns++
3✔
3683
        }
3684

3685
        return nil
3✔
3686
}
3687

3688
// delayInitialReconnect will attempt a reconnection to the given peer after
3689
// sampling a value for the delay between 0s and the maxInitReconnectDelay.
3690
//
3691
// NOTE: This method MUST be run as a goroutine.
3692
func (s *server) delayInitialReconnect(pubStr string) {
×
3693
        delay := time.Duration(prand.Intn(maxInitReconnectDelay)) * time.Second
×
3694
        select {
×
3695
        case <-time.After(delay):
×
3696
                s.connectToPersistentPeer(pubStr)
×
3697
        case <-s.quit:
×
3698
        }
3699
}
3700

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

3✔
3707
        s.mu.Lock()
3✔
3708
        if perm, ok := s.persistentPeers[pubKeyStr]; ok && !perm {
6✔
3709
                delete(s.persistentPeers, pubKeyStr)
3✔
3710
                delete(s.persistentPeersBackoff, pubKeyStr)
3✔
3711
                delete(s.persistentPeerAddrs, pubKeyStr)
3✔
3712
                s.cancelConnReqs(pubKeyStr, nil)
3✔
3713
                s.mu.Unlock()
3✔
3714

3✔
3715
                srvrLog.Infof("Pruned peer %x from persistent connections, "+
3✔
3716
                        "peer has no open channels", compressedPubKey)
3✔
3717

3✔
3718
                return
3✔
3719
        }
3✔
3720
        s.mu.Unlock()
3✔
3721
}
3722

3723
// bannedPersistentPeerConnection does not actually "ban" a persistent peer. It
3724
// is instead used to remove persistent peer state for a peer that has been
3725
// disconnected for good cause by the server. Currently, a gossip ban from
3726
// sending garbage and the server running out of restricted-access
3727
// (i.e. "free") connection slots are the only way this logic gets hit. In the
3728
// future, this function may expand when more ban criteria is added.
3729
//
3730
// NOTE: The server's write lock MUST be held when this is called.
NEW
3731
func (s *server) bannedPersistentPeerConnection(remotePub string) {
×
NEW
3732
        if perm, ok := s.persistentPeers[remotePub]; ok && !perm {
×
NEW
3733
                delete(s.persistentPeers, remotePub)
×
NEW
3734
                delete(s.persistentPeersBackoff, remotePub)
×
NEW
3735
                delete(s.persistentPeerAddrs, remotePub)
×
NEW
3736
                s.cancelConnReqs(remotePub, nil)
×
NEW
3737
        }
×
3738
}
3739

3740
// BroadcastMessage sends a request to the server to broadcast a set of
3741
// messages to all peers other than the one specified by the `skips` parameter.
3742
// All messages sent via BroadcastMessage will be queued for lazy delivery to
3743
// the target peers.
3744
//
3745
// NOTE: This function is safe for concurrent access.
3746
func (s *server) BroadcastMessage(skips map[route.Vertex]struct{},
3747
        msgs ...lnwire.Message) error {
3✔
3748

3✔
3749
        // Filter out peers found in the skips map. We synchronize access to
3✔
3750
        // peersByPub throughout this process to ensure we deliver messages to
3✔
3751
        // exact set of peers present at the time of invocation.
3✔
3752
        s.mu.RLock()
3✔
3753
        peers := make([]*peer.Brontide, 0, len(s.peersByPub))
3✔
3754
        for pubStr, sPeer := range s.peersByPub {
6✔
3755
                if skips != nil {
6✔
3756
                        if _, ok := skips[sPeer.PubKey()]; ok {
6✔
3757
                                srvrLog.Tracef("Skipping %x in broadcast with "+
3✔
3758
                                        "pubStr=%x", sPeer.PubKey(), pubStr)
3✔
3759
                                continue
3✔
3760
                        }
3761
                }
3762

3763
                peers = append(peers, sPeer)
3✔
3764
        }
3765
        s.mu.RUnlock()
3✔
3766

3✔
3767
        // Iterate over all known peers, dispatching a go routine to enqueue
3✔
3768
        // all messages to each of peers.
3✔
3769
        var wg sync.WaitGroup
3✔
3770
        for _, sPeer := range peers {
6✔
3771
                srvrLog.Debugf("Sending %v messages to peer %x", len(msgs),
3✔
3772
                        sPeer.PubKey())
3✔
3773

3✔
3774
                // Dispatch a go routine to enqueue all messages to this peer.
3✔
3775
                wg.Add(1)
3✔
3776
                s.wg.Add(1)
3✔
3777
                go func(p lnpeer.Peer) {
6✔
3778
                        defer s.wg.Done()
3✔
3779
                        defer wg.Done()
3✔
3780

3✔
3781
                        p.SendMessageLazy(false, msgs...)
3✔
3782
                }(sPeer)
3✔
3783
        }
3784

3785
        // Wait for all messages to have been dispatched before returning to
3786
        // caller.
3787
        wg.Wait()
3✔
3788

3✔
3789
        return nil
3✔
3790
}
3791

3792
// NotifyWhenOnline can be called by other subsystems to get notified when a
3793
// particular peer comes online. The peer itself is sent across the peerChan.
3794
//
3795
// NOTE: This function is safe for concurrent access.
3796
func (s *server) NotifyWhenOnline(peerKey [33]byte,
3797
        peerChan chan<- lnpeer.Peer) {
3✔
3798

3✔
3799
        s.mu.Lock()
3✔
3800

3✔
3801
        // Compute the target peer's identifier.
3✔
3802
        pubStr := string(peerKey[:])
3✔
3803

3✔
3804
        // Check if peer is connected.
3✔
3805
        peer, ok := s.peersByPub[pubStr]
3✔
3806
        if ok {
6✔
3807
                // Unlock here so that the mutex isn't held while we are
3✔
3808
                // waiting for the peer to become active.
3✔
3809
                s.mu.Unlock()
3✔
3810

3✔
3811
                // Wait until the peer signals that it is actually active
3✔
3812
                // rather than only in the server's maps.
3✔
3813
                select {
3✔
3814
                case <-peer.ActiveSignal():
3✔
3815
                case <-peer.QuitSignal():
×
3816
                        // The peer quit, so we'll add the channel to the slice
×
3817
                        // and return.
×
3818
                        s.mu.Lock()
×
3819
                        s.peerConnectedListeners[pubStr] = append(
×
3820
                                s.peerConnectedListeners[pubStr], peerChan,
×
3821
                        )
×
3822
                        s.mu.Unlock()
×
3823
                        return
×
3824
                }
3825

3826
                // Connected, can return early.
3827
                srvrLog.Debugf("Notifying that peer %x is online", peerKey)
3✔
3828

3✔
3829
                select {
3✔
3830
                case peerChan <- peer:
3✔
3831
                case <-s.quit:
×
3832
                }
3833

3834
                return
3✔
3835
        }
3836

3837
        // Not connected, store this listener such that it can be notified when
3838
        // the peer comes online.
3839
        s.peerConnectedListeners[pubStr] = append(
3✔
3840
                s.peerConnectedListeners[pubStr], peerChan,
3✔
3841
        )
3✔
3842
        s.mu.Unlock()
3✔
3843
}
3844

3845
// NotifyWhenOffline delivers a notification to the caller of when the peer with
3846
// the given public key has been disconnected. The notification is signaled by
3847
// closing the channel returned.
3848
func (s *server) NotifyWhenOffline(peerPubKey [33]byte) <-chan struct{} {
3✔
3849
        s.mu.Lock()
3✔
3850
        defer s.mu.Unlock()
3✔
3851

3✔
3852
        c := make(chan struct{})
3✔
3853

3✔
3854
        // If the peer is already offline, we can immediately trigger the
3✔
3855
        // notification.
3✔
3856
        peerPubKeyStr := string(peerPubKey[:])
3✔
3857
        if _, ok := s.peersByPub[peerPubKeyStr]; !ok {
3✔
3858
                srvrLog.Debugf("Notifying that peer %x is offline", peerPubKey)
×
3859
                close(c)
×
3860
                return c
×
3861
        }
×
3862

3863
        // Otherwise, the peer is online, so we'll keep track of the channel to
3864
        // trigger the notification once the server detects the peer
3865
        // disconnects.
3866
        s.peerDisconnectedListeners[peerPubKeyStr] = append(
3✔
3867
                s.peerDisconnectedListeners[peerPubKeyStr], c,
3✔
3868
        )
3✔
3869

3✔
3870
        return c
3✔
3871
}
3872

3873
// FindPeer will return the peer that corresponds to the passed in public key.
3874
// This function is used by the funding manager, allowing it to update the
3875
// daemon's local representation of the remote peer.
3876
//
3877
// NOTE: This function is safe for concurrent access.
3878
func (s *server) FindPeer(peerKey *btcec.PublicKey) (*peer.Brontide, error) {
3✔
3879
        s.mu.RLock()
3✔
3880
        defer s.mu.RUnlock()
3✔
3881

3✔
3882
        pubStr := string(peerKey.SerializeCompressed())
3✔
3883

3✔
3884
        return s.findPeerByPubStr(pubStr)
3✔
3885
}
3✔
3886

3887
// FindPeerByPubStr will return the peer that corresponds to the passed peerID,
3888
// which should be a string representation of the peer's serialized, compressed
3889
// public key.
3890
//
3891
// NOTE: This function is safe for concurrent access.
3892
func (s *server) FindPeerByPubStr(pubStr string) (*peer.Brontide, error) {
3✔
3893
        s.mu.RLock()
3✔
3894
        defer s.mu.RUnlock()
3✔
3895

3✔
3896
        return s.findPeerByPubStr(pubStr)
3✔
3897
}
3✔
3898

3899
// findPeerByPubStr is an internal method that retrieves the specified peer from
3900
// the server's internal state using.
3901
func (s *server) findPeerByPubStr(pubStr string) (*peer.Brontide, error) {
3✔
3902
        peer, ok := s.peersByPub[pubStr]
3✔
3903
        if !ok {
6✔
3904
                return nil, ErrPeerNotConnected
3✔
3905
        }
3✔
3906

3907
        return peer, nil
3✔
3908
}
3909

3910
// nextPeerBackoff computes the next backoff duration for a peer's pubkey using
3911
// exponential backoff. If no previous backoff was known, the default is
3912
// returned.
3913
func (s *server) nextPeerBackoff(pubStr string,
3914
        startTime time.Time) time.Duration {
3✔
3915

3✔
3916
        // Now, determine the appropriate backoff to use for the retry.
3✔
3917
        backoff, ok := s.persistentPeersBackoff[pubStr]
3✔
3918
        if !ok {
6✔
3919
                // If an existing backoff was unknown, use the default.
3✔
3920
                return s.cfg.MinBackoff
3✔
3921
        }
3✔
3922

3923
        // If the peer failed to start properly, we'll just use the previous
3924
        // backoff to compute the subsequent randomized exponential backoff
3925
        // duration. This will roughly double on average.
3926
        if startTime.IsZero() {
3✔
3927
                return computeNextBackoff(backoff, s.cfg.MaxBackoff)
×
3928
        }
×
3929

3930
        // The peer succeeded in starting. If the connection didn't last long
3931
        // enough to be considered stable, we'll continue to back off retries
3932
        // with this peer.
3933
        connDuration := time.Since(startTime)
3✔
3934
        if connDuration < defaultStableConnDuration {
6✔
3935
                return computeNextBackoff(backoff, s.cfg.MaxBackoff)
3✔
3936
        }
3✔
3937

3938
        // The peer succeed in starting and this was stable peer, so we'll
3939
        // reduce the timeout duration by the length of the connection after
3940
        // applying randomized exponential backoff. We'll only apply this in the
3941
        // case that:
3942
        //   reb(curBackoff) - connDuration > cfg.MinBackoff
3943
        relaxedBackoff := computeNextBackoff(backoff, s.cfg.MaxBackoff) - connDuration
×
3944
        if relaxedBackoff > s.cfg.MinBackoff {
×
3945
                return relaxedBackoff
×
3946
        }
×
3947

3948
        // Lastly, if reb(currBackoff) - connDuration <= cfg.MinBackoff, meaning
3949
        // the stable connection lasted much longer than our previous backoff.
3950
        // To reward such good behavior, we'll reconnect after the default
3951
        // timeout.
3952
        return s.cfg.MinBackoff
×
3953
}
3954

3955
// shouldDropLocalConnection determines if our local connection to a remote peer
3956
// should be dropped in the case of concurrent connection establishment. In
3957
// order to deterministically decide which connection should be dropped, we'll
3958
// utilize the ordering of the local and remote public key. If we didn't use
3959
// such a tie breaker, then we risk _both_ connections erroneously being
3960
// dropped.
3961
func shouldDropLocalConnection(local, remote *btcec.PublicKey) bool {
×
3962
        localPubBytes := local.SerializeCompressed()
×
3963
        remotePubPbytes := remote.SerializeCompressed()
×
3964

×
3965
        // The connection that comes from the node with a "smaller" pubkey
×
3966
        // should be kept. Therefore, if our pubkey is "greater" than theirs, we
×
3967
        // should drop our established connection.
×
3968
        return bytes.Compare(localPubBytes, remotePubPbytes) > 0
×
3969
}
×
3970

3971
// InboundPeerConnected initializes a new peer in response to a new inbound
3972
// connection.
3973
//
3974
// NOTE: This function is safe for concurrent access.
3975
func (s *server) InboundPeerConnected(conn net.Conn) {
3✔
3976
        // Exit early if we have already been instructed to shutdown, this
3✔
3977
        // prevents any delayed callbacks from accidentally registering peers.
3✔
3978
        if s.Stopped() {
3✔
3979
                return
×
3980
        }
×
3981

3982
        nodePub := conn.(*brontide.Conn).RemotePub()
3✔
3983
        pubSer := nodePub.SerializeCompressed()
3✔
3984
        pubStr := string(pubSer)
3✔
3985

3✔
3986
        var pubBytes [33]byte
3✔
3987
        copy(pubBytes[:], pubSer)
3✔
3988

3✔
3989
        s.mu.Lock()
3✔
3990
        defer s.mu.Unlock()
3✔
3991

3✔
3992
        // If the remote node's public key is banned, drop the connection.
3✔
3993
        access, err := s.assignPeerPerms(nodePub)
3✔
3994
        if err != nil {
3✔
NEW
3995
                // Clean up the persistent peer maps if we're dropping this
×
NEW
3996
                // connection.
×
NEW
3997
                s.bannedPersistentPeerConnection(pubStr)
×
UNCOV
3998

×
NEW
3999
                srvrLog.Debugf("Dropping connection for %v since we are out "+
×
NEW
4000
                        "of restricted-access connection slots: %v.", pubSer,
×
NEW
4001
                        err)
×
4002

×
4003
                conn.Close()
×
4004

×
4005
                return
×
4006
        }
×
4007

4008
        // If we already have an outbound connection to this peer, then ignore
4009
        // this new connection.
4010
        if p, ok := s.outboundPeers[pubStr]; ok {
6✔
4011
                srvrLog.Debugf("Already have outbound connection for %v, "+
3✔
4012
                        "ignoring inbound connection from local=%v, remote=%v",
3✔
4013
                        p, conn.LocalAddr(), conn.RemoteAddr())
3✔
4014

3✔
4015
                conn.Close()
3✔
4016
                return
3✔
4017
        }
3✔
4018

4019
        // If we already have a valid connection that is scheduled to take
4020
        // precedence once the prior peer has finished disconnecting, we'll
4021
        // ignore this connection.
4022
        if p, ok := s.scheduledPeerConnection[pubStr]; ok {
3✔
4023
                srvrLog.Debugf("Ignoring connection from %v, peer %v already "+
×
4024
                        "scheduled", conn.RemoteAddr(), p)
×
4025
                conn.Close()
×
4026
                return
×
4027
        }
×
4028

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

3✔
4031
        // Check to see if we already have a connection with this peer. If so,
3✔
4032
        // we may need to drop our existing connection. This prevents us from
3✔
4033
        // having duplicate connections to the same peer. We forgo adding a
3✔
4034
        // default case as we expect these to be the only error values returned
3✔
4035
        // from findPeerByPubStr.
3✔
4036
        connectedPeer, err := s.findPeerByPubStr(pubStr)
3✔
4037
        switch err {
3✔
4038
        case ErrPeerNotConnected:
3✔
4039
                // We were unable to locate an existing connection with the
3✔
4040
                // target peer, proceed to connect.
3✔
4041
                s.cancelConnReqs(pubStr, nil)
3✔
4042
                s.peerConnected(conn, nil, true, access)
3✔
4043

4044
        case nil:
×
4045
                // We already have a connection with the incoming peer. If the
×
4046
                // connection we've already established should be kept and is
×
4047
                // not of the same type of the new connection (inbound), then
×
4048
                // we'll close out the new connection s.t there's only a single
×
4049
                // connection between us.
×
4050
                localPub := s.identityECDH.PubKey()
×
4051
                if !connectedPeer.Inbound() &&
×
4052
                        !shouldDropLocalConnection(localPub, nodePub) {
×
4053

×
4054
                        srvrLog.Warnf("Received inbound connection from "+
×
4055
                                "peer %v, but already have outbound "+
×
4056
                                "connection, dropping conn", connectedPeer)
×
4057
                        conn.Close()
×
4058
                        return
×
4059
                }
×
4060

4061
                // Otherwise, if we should drop the connection, then we'll
4062
                // disconnect our already connected peer.
4063
                srvrLog.Debugf("Disconnecting stale connection to %v",
×
4064
                        connectedPeer)
×
4065

×
4066
                s.cancelConnReqs(pubStr, nil)
×
4067

×
4068
                // Remove the current peer from the server's internal state and
×
4069
                // signal that the peer termination watcher does not need to
×
4070
                // execute for this peer.
×
4071
                s.removePeer(connectedPeer)
×
4072
                s.ignorePeerTermination[connectedPeer] = struct{}{}
×
4073
                s.scheduledPeerConnection[pubStr] = func() {
×
NEW
4074
                        s.peerConnected(conn, nil, true, access)
×
4075
                }
×
4076
        }
4077
}
4078

4079
// OutboundPeerConnected initializes a new peer in response to a new outbound
4080
// connection.
4081
// NOTE: This function is safe for concurrent access.
4082
func (s *server) OutboundPeerConnected(connReq *connmgr.ConnReq, conn net.Conn) {
3✔
4083
        // Exit early if we have already been instructed to shutdown, this
3✔
4084
        // prevents any delayed callbacks from accidentally registering peers.
3✔
4085
        if s.Stopped() {
3✔
4086
                return
×
4087
        }
×
4088

4089
        nodePub := conn.(*brontide.Conn).RemotePub()
3✔
4090
        pubSer := nodePub.SerializeCompressed()
3✔
4091
        pubStr := string(pubSer)
3✔
4092

3✔
4093
        var pubBytes [33]byte
3✔
4094
        copy(pubBytes[:], pubSer)
3✔
4095

3✔
4096
        s.mu.Lock()
3✔
4097
        defer s.mu.Unlock()
3✔
4098

3✔
4099
        access, err := s.assignPeerPerms(nodePub)
3✔
4100
        if err != nil {
3✔
NEW
4101
                // Clean up the persistent peer maps if we're dropping this
×
NEW
4102
                // connection.
×
NEW
4103
                s.bannedPersistentPeerConnection(pubStr)
×
UNCOV
4104

×
NEW
4105
                srvrLog.Debugf("Dropping connection for %v since we are out "+
×
NEW
4106
                        "of restricted-access connection slots: %v.", pubSer,
×
NEW
4107
                        err)
×
4108

×
4109
                if connReq != nil {
×
4110
                        s.connMgr.Remove(connReq.ID())
×
4111
                }
×
4112

4113
                conn.Close()
×
4114

×
4115
                return
×
4116
        }
4117

4118
        // If we already have an inbound connection to this peer, then ignore
4119
        // this new connection.
4120
        if p, ok := s.inboundPeers[pubStr]; ok {
6✔
4121
                srvrLog.Debugf("Already have inbound connection for %v, "+
3✔
4122
                        "ignoring outbound connection from local=%v, remote=%v",
3✔
4123
                        p, conn.LocalAddr(), conn.RemoteAddr())
3✔
4124

3✔
4125
                if connReq != nil {
6✔
4126
                        s.connMgr.Remove(connReq.ID())
3✔
4127
                }
3✔
4128
                conn.Close()
3✔
4129
                return
3✔
4130
        }
4131
        if _, ok := s.persistentConnReqs[pubStr]; !ok && connReq != nil {
3✔
4132
                srvrLog.Debugf("Ignoring canceled outbound connection")
×
4133
                s.connMgr.Remove(connReq.ID())
×
4134
                conn.Close()
×
4135
                return
×
4136
        }
×
4137

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

×
4144
                if connReq != nil {
×
4145
                        s.connMgr.Remove(connReq.ID())
×
4146
                }
×
4147

4148
                conn.Close()
×
4149
                return
×
4150
        }
4151

4152
        srvrLog.Infof("Established connection to: %x@%v", pubStr,
3✔
4153
                conn.RemoteAddr())
3✔
4154

3✔
4155
        if connReq != nil {
6✔
4156
                // A successful connection was returned by the connmgr.
3✔
4157
                // Immediately cancel all pending requests, excluding the
3✔
4158
                // outbound connection we just established.
3✔
4159
                ignore := connReq.ID()
3✔
4160
                s.cancelConnReqs(pubStr, &ignore)
3✔
4161
        } else {
6✔
4162
                // This was a successful connection made by some other
3✔
4163
                // subsystem. Remove all requests being managed by the connmgr.
3✔
4164
                s.cancelConnReqs(pubStr, nil)
3✔
4165
        }
3✔
4166

4167
        // If we already have a connection with this peer, decide whether or not
4168
        // we need to drop the stale connection. We forgo adding a default case
4169
        // as we expect these to be the only error values returned from
4170
        // findPeerByPubStr.
4171
        connectedPeer, err := s.findPeerByPubStr(pubStr)
3✔
4172
        switch err {
3✔
4173
        case ErrPeerNotConnected:
3✔
4174
                // We were unable to locate an existing connection with the
3✔
4175
                // target peer, proceed to connect.
3✔
4176
                s.peerConnected(conn, connReq, false, access)
3✔
4177

4178
        case nil:
×
4179
                // We already have a connection with the incoming peer. If the
×
4180
                // connection we've already established should be kept and is
×
4181
                // not of the same type of the new connection (outbound), then
×
4182
                // we'll close out the new connection s.t there's only a single
×
4183
                // connection between us.
×
4184
                localPub := s.identityECDH.PubKey()
×
4185
                if connectedPeer.Inbound() &&
×
4186
                        shouldDropLocalConnection(localPub, nodePub) {
×
4187

×
4188
                        srvrLog.Warnf("Established outbound connection to "+
×
4189
                                "peer %v, but already have inbound "+
×
4190
                                "connection, dropping conn", connectedPeer)
×
4191
                        if connReq != nil {
×
4192
                                s.connMgr.Remove(connReq.ID())
×
4193
                        }
×
4194
                        conn.Close()
×
4195
                        return
×
4196
                }
4197

4198
                // Otherwise, _their_ connection should be dropped. So we'll
4199
                // disconnect the peer and send the now obsolete peer to the
4200
                // server for garbage collection.
4201
                srvrLog.Debugf("Disconnecting stale connection to %v",
×
4202
                        connectedPeer)
×
4203

×
4204
                // Remove the current peer from the server's internal state and
×
4205
                // signal that the peer termination watcher does not need to
×
4206
                // execute for this peer.
×
4207
                s.removePeer(connectedPeer)
×
4208
                s.ignorePeerTermination[connectedPeer] = struct{}{}
×
4209
                s.scheduledPeerConnection[pubStr] = func() {
×
NEW
4210
                        s.peerConnected(conn, connReq, false, access)
×
4211
                }
×
4212
        }
4213
}
4214

4215
// assignPeerPerms assigns a new peer its permissions.
4216
func (s *server) assignPeerPerms(remotePub *btcec.PublicKey) (peerAccessStatus,
4217
        error) {
3✔
4218

3✔
4219
        // Default is restricted unless the below filters say otherwise.
3✔
4220
        access := peerStatusRestricted
3✔
4221

3✔
4222
        shouldDisconnect, err := s.authGossiper.ShouldDisconnect(remotePub)
3✔
4223
        if err != nil {
3✔
NEW
4224
                // Access is restricted here.
×
NEW
4225
                return access, err
×
NEW
4226
        }
×
4227

4228
        if shouldDisconnect {
3✔
NEW
4229
                // Access is restricted here.
×
NEW
4230
                return access, ErrGossiperBan
×
NEW
4231
        }
×
4232

4233
        remoteHex := hex.EncodeToString(remotePub.SerializeCompressed())
3✔
4234

3✔
4235
        // Lock banScoreMtx for reading so that we can update the banning maps
3✔
4236
        // below.
3✔
4237
        s.banScoreMtx.RLock()
3✔
4238
        defer s.banScoreMtx.RUnlock()
3✔
4239

3✔
4240
        if count, found := s.peerCounts[remoteHex]; found {
6✔
4241
                if count.HasOpenOrClosedChan {
6✔
4242
                        access = peerStatusProtected
3✔
4243
                } else if count.PendingOpenCount != 0 {
9✔
4244
                        access = peerStatusTemporary
3✔
4245
                }
3✔
4246
        }
4247

4248
        // If we've reached this point and access hasn't changed from
4249
        // restricted, then we need to check if we even have a slot for this
4250
        // peer.
4251
        if s.numRestricted >= s.cfg.NumRestrictedSlots &&
3✔
4252
                access == peerStatusRestricted {
3✔
NEW
4253

×
NEW
4254
                return access, ErrNoMoreRestrictedAccessSlots
×
NEW
4255
        }
×
4256

4257
        return access, nil
3✔
4258
}
4259

4260
// UnassignedConnID is the default connection ID that a request can have before
4261
// it actually is submitted to the connmgr.
4262
// TODO(conner): move into connmgr package, or better, add connmgr method for
4263
// generating atomic IDs
4264
const UnassignedConnID uint64 = 0
4265

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

4280
        // Next, check to see if we have any outstanding persistent connection
4281
        // requests to this peer. If so, then we'll remove all of these
4282
        // connection requests, and also delete the entry from the map.
4283
        connReqs, ok := s.persistentConnReqs[pubStr]
3✔
4284
        if !ok {
6✔
4285
                return
3✔
4286
        }
3✔
4287

4288
        for _, connReq := range connReqs {
6✔
4289
                srvrLog.Tracef("Canceling %s:", connReqs)
3✔
4290

3✔
4291
                // Atomically capture the current request identifier.
3✔
4292
                connID := connReq.ID()
3✔
4293

3✔
4294
                // Skip any zero IDs, this indicates the request has not
3✔
4295
                // yet been schedule.
3✔
4296
                if connID == UnassignedConnID {
3✔
4297
                        continue
×
4298
                }
4299

4300
                // Skip a particular connection ID if instructed.
4301
                if skip != nil && connID == *skip {
6✔
4302
                        continue
3✔
4303
                }
4304

4305
                s.connMgr.Remove(connID)
3✔
4306
        }
4307

4308
        delete(s.persistentConnReqs, pubStr)
3✔
4309
}
4310

4311
// handleCustomMessage dispatches an incoming custom peers message to
4312
// subscribers.
4313
func (s *server) handleCustomMessage(peer [33]byte, msg *lnwire.Custom) error {
3✔
4314
        srvrLog.Debugf("Custom message received: peer=%x, type=%d",
3✔
4315
                peer, msg.Type)
3✔
4316

3✔
4317
        return s.customMessageServer.SendUpdate(&CustomMessage{
3✔
4318
                Peer: peer,
3✔
4319
                Msg:  msg,
3✔
4320
        })
3✔
4321
}
3✔
4322

4323
// SubscribeCustomMessages subscribes to a stream of incoming custom peer
4324
// messages.
4325
func (s *server) SubscribeCustomMessages() (*subscribe.Client, error) {
3✔
4326
        return s.customMessageServer.Subscribe()
3✔
4327
}
3✔
4328

4329
// notifyOpenChannelPeerEvent updates the server's peer maps and then calls
4330
// the channelNotifier's NotifyOpenChannelEvent.
4331
func (s *server) notifyOpenChannelPeerEvent(op wire.OutPoint,
4332
        remotePub string) error {
3✔
4333

3✔
4334
        // Call NewOpenChan to update the server's maps for this peer.
3✔
4335
        if err := s.NewOpenChan(remotePub); err != nil {
6✔
4336
                return err
3✔
4337
        }
3✔
4338

4339
        // Notify subscribers about this open channel event.
4340
        s.channelNotifier.NotifyOpenChannelEvent(op)
3✔
4341

3✔
4342
        return nil
3✔
4343
}
4344

4345
// notifyPendingOpenChannelPeerEvent updates the server's maps and then calls
4346
// the channelNotifier's NotifyPendingOpenChannelEvent.
4347
func (s *server) notifyPendingOpenChannelPeerEvent(op wire.OutPoint,
4348
        pendingChan *channeldb.OpenChannel, remotePub string) error {
3✔
4349

3✔
4350
        // Call NewPendingOpenChan to update the server's maps for this peer.
3✔
4351
        if err := s.NewPendingOpenChan(remotePub); err != nil {
3✔
NEW
4352
                return err
×
NEW
4353
        }
×
4354

4355
        // Notify subscribers about this event.
4356
        s.channelNotifier.NotifyPendingOpenChannelEvent(op, pendingChan)
3✔
4357

3✔
4358
        return nil
3✔
4359
}
4360

4361
// notifyFundingTimeoutPeerEvent updates the server's maps and then calls the
4362
// channelNotifier's NotifyFundingTimeout.
4363
func (s *server) notifyFundingTimeoutPeerEvent(op wire.OutPoint,
NEW
4364
        remotePub string) error {
×
NEW
4365

×
NEW
4366
        // Call NewPendingCloseChan to potentially demote the peer.
×
NEW
4367
        if err := s.NewPendingCloseChan(remotePub); err != nil {
×
NEW
4368
                return err
×
NEW
4369
        }
×
4370

4371
        // Notify subscribers about this event.
NEW
4372
        s.channelNotifier.NotifyFundingTimeout(op)
×
NEW
4373

×
NEW
4374
        return nil
×
4375
}
4376

4377
// NewPendingOpenChan is called after the pending-open channel has been
4378
// committed to the database. This may transition a restricted-access peer to a
4379
// temporary-access peer.
4380
func (s *server) NewPendingOpenChan(remoteHex string) error {
3✔
4381
        s.banScoreMtx.Lock()
3✔
4382
        defer s.banScoreMtx.Unlock()
3✔
4383

3✔
4384
        // Fetch the peer's access status from peerScores.
3✔
4385
        status, found := s.peerScores[remoteHex]
3✔
4386
        if !found {
3✔
NEW
4387
                // If we didn't find the peer, we'll return an error.
×
NEW
4388
                return ErrNoPeerScore
×
NEW
4389
        }
×
4390

4391
        switch status.state {
3✔
4392
        case peerStatusProtected:
3✔
4393
                // If this peer's access status is protected, we don't need to
3✔
4394
                // do anything.
3✔
4395
                return nil
3✔
4396

4397
        case peerStatusTemporary:
3✔
4398
                // If this peer's access status is temporary, we'll need to
3✔
4399
                // update the peerCounts map. The peer's access status will
3✔
4400
                // stay temporary.
3✔
4401
                peerCount, found := s.peerCounts[remoteHex]
3✔
4402
                if !found {
3✔
NEW
4403
                        // Error if we did not find any info in peerCounts.
×
NEW
4404
                        return ErrNoPendingPeerInfo
×
NEW
4405
                }
×
4406

4407
                // Increment the pending channel amount.
4408
                peerCount.PendingOpenCount += 1
3✔
4409
                s.peerCounts[remoteHex] = peerCount
3✔
4410

4411
        case peerStatusRestricted:
3✔
4412
                // If the peer's access status is restricted, then we can
3✔
4413
                // transition it to a temporary-access peer. We'll need to
3✔
4414
                // update numRestricted and also peerScores. We'll also need to
3✔
4415
                // update peerCounts.
3✔
4416
                peerCount := channeldb.ChanCount{
3✔
4417
                        HasOpenOrClosedChan: false,
3✔
4418
                        PendingOpenCount:    1,
3✔
4419
                }
3✔
4420

3✔
4421
                s.peerCounts[remoteHex] = peerCount
3✔
4422

3✔
4423
                // A restricted-access slot has opened up.
3✔
4424
                s.numRestricted -= 1
3✔
4425

3✔
4426
                s.peerScores[remoteHex] = peerSlotStatus{
3✔
4427
                        state: peerStatusTemporary,
3✔
4428
                }
3✔
4429

NEW
4430
        default:
×
NEW
4431
                // This should not be possible.
×
NEW
4432
                return fmt.Errorf("invalid peer access status")
×
4433
        }
4434

4435
        return nil
3✔
4436
}
4437

4438
// NewPendingCloseChan is called when a pending-open channel prematurely closes
4439
// before the funding transaction has confirmed. This potentially demotes a
4440
// temporary-access peer to a restricted-access peer. If no restricted-access
4441
// slots are available, the peer will be disconnected.
NEW
4442
func (s *server) NewPendingCloseChan(remoteHex string) error {
×
NEW
4443
        // Ensure that we don't lock banScoreMtx and _then_ lock the server
×
NEW
4444
        // mutex. This could lead to deadlock.
×
NEW
4445
        s.banScoreMtx.Lock()
×
NEW
4446

×
NEW
4447
        // Fetch the peer's access status from peerScores.
×
NEW
4448
        status, found := s.peerScores[remoteHex]
×
NEW
4449
        if !found {
×
NEW
4450
                s.banScoreMtx.Unlock()
×
NEW
4451

×
NEW
4452
                // If we didn't find the peer, we'll return an error.
×
NEW
4453
                return ErrNoPeerScore
×
NEW
4454
        }
×
4455

NEW
4456
        switch status.state {
×
NEW
4457
        case peerStatusProtected:
×
NEW
4458
                s.banScoreMtx.Unlock()
×
NEW
4459

×
NEW
4460
                // If this peer is protected, we don't do anything.
×
NEW
4461
                return nil
×
4462

NEW
4463
        case peerStatusTemporary:
×
NEW
4464
                // If this peer is temporary, we need to check if it will revert
×
NEW
4465
                // to a restricted-access peer.
×
NEW
4466
                peerCount, found := s.peerCounts[remoteHex]
×
NEW
4467
                if !found {
×
NEW
4468
                        s.banScoreMtx.Unlock()
×
NEW
4469

×
NEW
4470
                        // Error if we did not find any info in peerCounts.
×
NEW
4471
                        return ErrNoPendingPeerInfo
×
NEW
4472
                }
×
NEW
4473
                currentNumPending := peerCount.PendingOpenCount - 1
×
NEW
4474

×
NEW
4475
                if currentNumPending == 0 {
×
NEW
4476
                        // Remove the entry from peerCounts.
×
NEW
4477
                        delete(s.peerCounts, remoteHex)
×
NEW
4478

×
NEW
4479
                        // If this is the only pending-open channel for this
×
NEW
4480
                        // peer and it's getting removed, attempt to demote
×
NEW
4481
                        // this peer to a restricted peer.
×
NEW
4482
                        if s.numRestricted == s.cfg.NumRestrictedSlots {
×
NEW
4483
                                // There are no available restricted slots, so
×
NEW
4484
                                // we need to disconnect this peer.
×
NEW
4485
                                s.banScoreMtx.Unlock()
×
NEW
4486

×
NEW
4487
                                hexBytes, err := hex.DecodeString(remoteHex)
×
NEW
4488
                                if err != nil {
×
NEW
4489
                                        return err
×
NEW
4490
                                }
×
4491

NEW
4492
                                remotePub, err := btcec.ParsePubKey(hexBytes)
×
NEW
4493
                                if err != nil {
×
NEW
4494
                                        return err
×
NEW
4495
                                }
×
4496

4497
                                // The banScoreMtx cannot be held when the
4498
                                // below DisconnectPeer call occurs.
NEW
4499
                                return s.DisconnectPeer(remotePub)
×
4500
                        }
4501

4502
                        // Otherwise, there is an available restricted-access
4503
                        // slot, so we can demote this peer.
NEW
4504
                        s.peerScores[remoteHex] = peerSlotStatus{
×
NEW
4505
                                state: peerStatusRestricted,
×
NEW
4506
                        }
×
NEW
4507

×
NEW
4508
                        // Update numRestricted.
×
NEW
4509
                        s.numRestricted++
×
NEW
4510

×
NEW
4511
                        s.banScoreMtx.Unlock()
×
NEW
4512

×
NEW
4513
                        return nil
×
4514
                }
4515

4516
                // Else, we don't need to demote this peer since it has other
4517
                // pending-open channels with us.
NEW
4518
                peerCount.PendingOpenCount = currentNumPending
×
NEW
4519
                s.peerCounts[remoteHex] = peerCount
×
NEW
4520

×
NEW
4521
                s.banScoreMtx.Unlock()
×
NEW
4522

×
NEW
4523
                return nil
×
4524

NEW
4525
        case peerStatusRestricted:
×
NEW
4526
                s.banScoreMtx.Unlock()
×
NEW
4527

×
NEW
4528
                // This should not be possible. This indicates an error.
×
NEW
4529
                return fmt.Errorf("invalid peer access state transition")
×
4530

NEW
4531
        default:
×
NEW
4532
                s.banScoreMtx.Unlock()
×
NEW
4533

×
NEW
4534
                // This should not be possible.
×
NEW
4535
                return fmt.Errorf("invalid peer access status")
×
4536
        }
4537
}
4538

4539
// NewOpenChan is called when a pending-open channel becomes an open channel
4540
// (i.e. the funding transaction has confirmed). If the remote peer is a
4541
// temporary-access peer, it will be promoted to a protected-access peer.
4542
func (s *server) NewOpenChan(remoteHex string) error {
3✔
4543
        s.banScoreMtx.Lock()
3✔
4544
        defer s.banScoreMtx.Unlock()
3✔
4545

3✔
4546
        // Fetch the peer's access status from peerScores.
3✔
4547
        status, found := s.peerScores[remoteHex]
3✔
4548
        if !found {
6✔
4549
                // If we didn't find the peer, we'll return an error.
3✔
4550
                return ErrNoPeerScore
3✔
4551
        }
3✔
4552

4553
        switch status.state {
3✔
4554
        case peerStatusProtected:
3✔
4555
                // If the peer's state is already protected, we don't need to
3✔
4556
                // do anything more.
3✔
4557
                return nil
3✔
4558

4559
        case peerStatusTemporary:
3✔
4560
                // If the peer's state is temporary, we'll upgrade the peer to
3✔
4561
                // a protected peer.
3✔
4562
                peerCount, found := s.peerCounts[remoteHex]
3✔
4563
                if !found {
3✔
NEW
4564
                        // Error if we did not find any info in peerCounts.
×
NEW
4565
                        return ErrNoPendingPeerInfo
×
NEW
4566
                }
×
4567

4568
                peerCount.HasOpenOrClosedChan = true
3✔
4569
                s.peerCounts[remoteHex] = peerCount
3✔
4570

3✔
4571
                newStatus := peerSlotStatus{
3✔
4572
                        state: peerStatusProtected,
3✔
4573
                }
3✔
4574
                s.peerScores[remoteHex] = newStatus
3✔
4575

3✔
4576
                return nil
3✔
4577

NEW
4578
        case peerStatusRestricted:
×
NEW
4579
                // This should not be possible. For the server to receive a
×
NEW
4580
                // state-transition event via NewOpenChan, the server must have
×
NEW
4581
                // previously granted this peer "temporary" access. This
×
NEW
4582
                // temporary access would not have been revoked or downgraded
×
NEW
4583
                // without `CloseChannel` being called with the pending
×
NEW
4584
                // argument set to true. This means that an open-channel state
×
NEW
4585
                // transition would be impossible. Therefore, we can return an
×
NEW
4586
                // error.
×
NEW
4587
                return fmt.Errorf("invalid peer access status")
×
4588

NEW
4589
        default:
×
NEW
4590
                // This should not be possible.
×
NEW
4591
                return fmt.Errorf("invalid peer access status")
×
4592
        }
4593
}
4594

4595
// checkIncomingConnBanScore checks whether, given the remote's public hex-
4596
// encoded key, we should accept this incoming connection or immediately
4597
// disconnect. This does not assign to the server's peerScores maps. This is
4598
// just an inbound filter that the brontide listeners use.
4599
func (s *server) checkIncomingConnBanScore(remoteHex string) (bool, error) {
3✔
4600
        s.banScoreMtx.RLock()
3✔
4601
        defer s.banScoreMtx.RUnlock()
3✔
4602

3✔
4603
        if _, found := s.peerCounts[remoteHex]; !found {
6✔
4604
                // Check numRestricted to see if there is an available slot.
3✔
4605
                // RESOLVE: Consider logic to rotate out slot connections?
3✔
4606
                if s.numRestricted < s.cfg.NumRestrictedSlots {
6✔
4607
                        // There is an available slot.
3✔
4608
                        return true, nil
3✔
4609
                }
3✔
4610

4611
                // If there are no slots left, then we reject this connection.
4612
                return false, ErrNoMoreRestrictedAccessSlots
3✔
4613
        }
4614

4615
        // Else, the peer is either protected or temporary.
4616
        return true, nil
3✔
4617
}
4618

4619
// peerConnected is a function that handles initialization a newly connected
4620
// peer by adding it to the server's global list of all active peers, and
4621
// starting all the goroutines the peer needs to function properly. The inbound
4622
// boolean should be true if the peer initiated the connection to us.
4623
func (s *server) peerConnected(conn net.Conn, connReq *connmgr.ConnReq,
4624
        inbound bool, access peerAccessStatus,
4625
) {
3✔
4626
        brontideConn := conn.(*brontide.Conn)
3✔
4627
        addr := conn.RemoteAddr()
3✔
4628
        pubKey := brontideConn.RemotePub()
3✔
4629

3✔
4630
        srvrLog.Infof("Finalizing connection to %x@%s, inbound=%v",
3✔
4631
                pubKey.SerializeCompressed(), addr, inbound)
3✔
4632

3✔
4633
        peerAddr := &lnwire.NetAddress{
3✔
4634
                IdentityKey: pubKey,
3✔
4635
                Address:     addr,
3✔
4636
                ChainNet:    s.cfg.ActiveNetParams.Net,
3✔
4637
        }
3✔
4638

3✔
4639
        // With the brontide connection established, we'll now craft the feature
3✔
4640
        // vectors to advertise to the remote node.
3✔
4641
        initFeatures := s.featureMgr.Get(feature.SetInit)
3✔
4642
        legacyFeatures := s.featureMgr.Get(feature.SetLegacyGlobal)
3✔
4643

3✔
4644
        // Lookup past error caches for the peer in the server. If no buffer is
3✔
4645
        // found, create a fresh buffer.
3✔
4646
        pkStr := string(peerAddr.IdentityKey.SerializeCompressed())
3✔
4647
        errBuffer, ok := s.peerErrors[pkStr]
3✔
4648
        if !ok {
6✔
4649
                var err error
3✔
4650
                errBuffer, err = queue.NewCircularBuffer(peer.ErrorBufferSize)
3✔
4651
                if err != nil {
3✔
4652
                        srvrLog.Errorf("unable to create peer %v", err)
×
4653
                        return
×
4654
                }
×
4655
        }
4656

4657
        // If we directly set the peer.Config TowerClient member to the
4658
        // s.towerClientMgr then in the case that the s.towerClientMgr is nil,
4659
        // the peer.Config's TowerClient member will not evaluate to nil even
4660
        // though the underlying value is nil. To avoid this gotcha which can
4661
        // cause a panic, we need to explicitly pass nil to the peer.Config's
4662
        // TowerClient if needed.
4663
        var towerClient wtclient.ClientManager
3✔
4664
        if s.towerClientMgr != nil {
6✔
4665
                towerClient = s.towerClientMgr
3✔
4666
        }
3✔
4667

4668
        thresholdSats := btcutil.Amount(s.cfg.MaxFeeExposure)
3✔
4669
        thresholdMSats := lnwire.NewMSatFromSatoshis(thresholdSats)
3✔
4670

3✔
4671
        // Now that we've established a connection, create a peer, and it to the
3✔
4672
        // set of currently active peers. Configure the peer with the incoming
3✔
4673
        // and outgoing broadcast deltas to prevent htlcs from being accepted or
3✔
4674
        // offered that would trigger channel closure. In case of outgoing
3✔
4675
        // htlcs, an extra block is added to prevent the channel from being
3✔
4676
        // closed when the htlc is outstanding and a new block comes in.
3✔
4677
        pCfg := peer.Config{
3✔
4678
                Conn:                    brontideConn,
3✔
4679
                ConnReq:                 connReq,
3✔
4680
                Addr:                    peerAddr,
3✔
4681
                Inbound:                 inbound,
3✔
4682
                Features:                initFeatures,
3✔
4683
                LegacyFeatures:          legacyFeatures,
3✔
4684
                OutgoingCltvRejectDelta: lncfg.DefaultOutgoingCltvRejectDelta,
3✔
4685
                ChanActiveTimeout:       s.cfg.ChanEnableTimeout,
3✔
4686
                ErrorBuffer:             errBuffer,
3✔
4687
                WritePool:               s.writePool,
3✔
4688
                ReadPool:                s.readPool,
3✔
4689
                Switch:                  s.htlcSwitch,
3✔
4690
                InterceptSwitch:         s.interceptableSwitch,
3✔
4691
                ChannelDB:               s.chanStateDB,
3✔
4692
                ChannelGraph:            s.graphDB,
3✔
4693
                ChainArb:                s.chainArb,
3✔
4694
                AuthGossiper:            s.authGossiper,
3✔
4695
                ChanStatusMgr:           s.chanStatusMgr,
3✔
4696
                ChainIO:                 s.cc.ChainIO,
3✔
4697
                FeeEstimator:            s.cc.FeeEstimator,
3✔
4698
                Signer:                  s.cc.Wallet.Cfg.Signer,
3✔
4699
                SigPool:                 s.sigPool,
3✔
4700
                Wallet:                  s.cc.Wallet,
3✔
4701
                ChainNotifier:           s.cc.ChainNotifier,
3✔
4702
                BestBlockView:           s.cc.BestBlockTracker,
3✔
4703
                RoutingPolicy:           s.cc.RoutingPolicy,
3✔
4704
                Sphinx:                  s.sphinx,
3✔
4705
                WitnessBeacon:           s.witnessBeacon,
3✔
4706
                Invoices:                s.invoices,
3✔
4707
                ChannelNotifier:         s.channelNotifier,
3✔
4708
                HtlcNotifier:            s.htlcNotifier,
3✔
4709
                TowerClient:             towerClient,
3✔
4710
                DisconnectPeer:          s.DisconnectPeer,
3✔
4711
                GenNodeAnnouncement: func(...netann.NodeAnnModifier) (
3✔
4712
                        lnwire.NodeAnnouncement, error) {
6✔
4713

3✔
4714
                        return s.genNodeAnnouncement(nil)
3✔
4715
                },
3✔
4716

4717
                PongBuf: s.pongBuf,
4718

4719
                PrunePersistentPeerConnection: s.prunePersistentPeerConnection,
4720

4721
                FetchLastChanUpdate: s.fetchLastChanUpdate(),
4722

4723
                FundingManager: s.fundingMgr,
4724

4725
                Hodl:                    s.cfg.Hodl,
4726
                UnsafeReplay:            s.cfg.UnsafeReplay,
4727
                MaxOutgoingCltvExpiry:   s.cfg.MaxOutgoingCltvExpiry,
4728
                MaxChannelFeeAllocation: s.cfg.MaxChannelFeeAllocation,
4729
                CoopCloseTargetConfs:    s.cfg.CoopCloseTargetConfs,
4730
                MaxAnchorsCommitFeeRate: chainfee.SatPerKVByte(
4731
                        s.cfg.MaxCommitFeeRateAnchors * 1000).FeePerKWeight(),
4732
                ChannelCommitInterval:  s.cfg.ChannelCommitInterval,
4733
                PendingCommitInterval:  s.cfg.PendingCommitInterval,
4734
                ChannelCommitBatchSize: s.cfg.ChannelCommitBatchSize,
4735
                HandleCustomMessage:    s.handleCustomMessage,
4736
                GetAliases:             s.aliasMgr.GetAliases,
4737
                RequestAlias:           s.aliasMgr.RequestAlias,
4738
                AddLocalAlias:          s.aliasMgr.AddLocalAlias,
4739
                DisallowRouteBlinding:  s.cfg.ProtocolOptions.NoRouteBlinding(),
4740
                DisallowQuiescence:     s.cfg.ProtocolOptions.NoQuiescence(),
4741
                MaxFeeExposure:         thresholdMSats,
4742
                Quit:                   s.quit,
4743
                AuxLeafStore:           s.implCfg.AuxLeafStore,
4744
                AuxSigner:              s.implCfg.AuxSigner,
4745
                MsgRouter:              s.implCfg.MsgRouter,
4746
                AuxChanCloser:          s.implCfg.AuxChanCloser,
4747
                AuxResolver:            s.implCfg.AuxContractResolver,
4748
                AuxTrafficShaper:       s.implCfg.TrafficShaper,
4749
                ShouldFwdExpEndorsement: func() bool {
3✔
4750
                        if s.cfg.ProtocolOptions.NoExperimentalEndorsement() {
6✔
4751
                                return false
3✔
4752
                        }
3✔
4753

4754
                        return clock.NewDefaultClock().Now().Before(
3✔
4755
                                EndorsementExperimentEnd,
3✔
4756
                        )
3✔
4757
                },
4758
        }
4759

4760
        copy(pCfg.PubKeyBytes[:], peerAddr.IdentityKey.SerializeCompressed())
3✔
4761
        copy(pCfg.ServerPubKey[:], s.identityECDH.PubKey().SerializeCompressed())
3✔
4762

3✔
4763
        p := peer.NewBrontide(pCfg)
3✔
4764

3✔
4765
        // Get the remote's hex encoded public key.
3✔
4766
        remotePubHex := hex.EncodeToString(pubKey.SerializeCompressed())
3✔
4767

3✔
4768
        remoteStatus := peerSlotStatus{
3✔
4769
                state: access,
3✔
4770
        }
3✔
4771

3✔
4772
        // Add the remote public key to peerScores.
3✔
4773
        s.banScoreMtx.Lock()
3✔
4774
        s.peerScores[remotePubHex] = remoteStatus
3✔
4775

3✔
4776
        // Increment numRestricted.
3✔
4777
        if access == peerStatusRestricted {
6✔
4778
                s.numRestricted++
3✔
4779
        }
3✔
4780

4781
        s.banScoreMtx.Unlock()
3✔
4782

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

3✔
4786
        s.addPeer(p)
3✔
4787

3✔
4788
        // Once we have successfully added the peer to the server, we can
3✔
4789
        // delete the previous error buffer from the server's map of error
3✔
4790
        // buffers.
3✔
4791
        delete(s.peerErrors, pkStr)
3✔
4792

3✔
4793
        // Dispatch a goroutine to asynchronously start the peer. This process
3✔
4794
        // includes sending and receiving Init messages, which would be a DOS
3✔
4795
        // vector if we held the server's mutex throughout the procedure.
3✔
4796
        s.wg.Add(1)
3✔
4797
        go s.peerInitializer(p)
3✔
4798
}
4799

4800
// addPeer adds the passed peer to the server's global state of all active
4801
// peers.
4802
func (s *server) addPeer(p *peer.Brontide) {
3✔
4803
        if p == nil {
3✔
4804
                return
×
4805
        }
×
4806

4807
        pubBytes := p.IdentityKey().SerializeCompressed()
3✔
4808

3✔
4809
        // Ignore new peers if we're shutting down.
3✔
4810
        if s.Stopped() {
3✔
4811
                srvrLog.Infof("Server stopped, skipped adding peer=%x",
×
4812
                        pubBytes)
×
4813
                p.Disconnect(ErrServerShuttingDown)
×
4814

×
4815
                return
×
4816
        }
×
4817

4818
        // Track the new peer in our indexes so we can quickly look it up either
4819
        // according to its public key, or its peer ID.
4820
        // TODO(roasbeef): pipe all requests through to the
4821
        // queryHandler/peerManager
4822

4823
        // NOTE: This pubStr is a raw bytes to string conversion and will NOT
4824
        // be human-readable.
4825
        pubStr := string(pubBytes)
3✔
4826

3✔
4827
        s.peersByPub[pubStr] = p
3✔
4828

3✔
4829
        if p.Inbound() {
6✔
4830
                s.inboundPeers[pubStr] = p
3✔
4831
        } else {
6✔
4832
                s.outboundPeers[pubStr] = p
3✔
4833
        }
3✔
4834

4835
        // Inform the peer notifier of a peer online event so that it can be reported
4836
        // to clients listening for peer events.
4837
        var pubKey [33]byte
3✔
4838
        copy(pubKey[:], pubBytes)
3✔
4839

3✔
4840
        s.peerNotifier.NotifyPeerOnline(pubKey)
3✔
4841
}
4842

4843
// peerInitializer asynchronously starts a newly connected peer after it has
4844
// been added to the server's peer map. This method sets up a
4845
// peerTerminationWatcher for the given peer, and ensures that it executes even
4846
// if the peer failed to start. In the event of a successful connection, this
4847
// method reads the negotiated, local feature-bits and spawns the appropriate
4848
// graph synchronization method. Any registered clients of NotifyWhenOnline will
4849
// be signaled of the new peer once the method returns.
4850
//
4851
// NOTE: This MUST be launched as a goroutine.
4852
func (s *server) peerInitializer(p *peer.Brontide) {
3✔
4853
        defer s.wg.Done()
3✔
4854

3✔
4855
        pubBytes := p.IdentityKey().SerializeCompressed()
3✔
4856

3✔
4857
        // Avoid initializing peers while the server is exiting.
3✔
4858
        if s.Stopped() {
3✔
4859
                srvrLog.Infof("Server stopped, skipped initializing peer=%x",
×
4860
                        pubBytes)
×
4861
                return
×
4862
        }
×
4863

4864
        // Create a channel that will be used to signal a successful start of
4865
        // the link. This prevents the peer termination watcher from beginning
4866
        // its duty too early.
4867
        ready := make(chan struct{})
3✔
4868

3✔
4869
        // Before starting the peer, launch a goroutine to watch for the
3✔
4870
        // unexpected termination of this peer, which will ensure all resources
3✔
4871
        // are properly cleaned up, and re-establish persistent connections when
3✔
4872
        // necessary. The peer termination watcher will be short circuited if
3✔
4873
        // the peer is ever added to the ignorePeerTermination map, indicating
3✔
4874
        // that the server has already handled the removal of this peer.
3✔
4875
        s.wg.Add(1)
3✔
4876
        go s.peerTerminationWatcher(p, ready)
3✔
4877

3✔
4878
        // Start the peer! If an error occurs, we Disconnect the peer, which
3✔
4879
        // will unblock the peerTerminationWatcher.
3✔
4880
        if err := p.Start(); err != nil {
6✔
4881
                srvrLog.Warnf("Starting peer=%x got error: %v", pubBytes, err)
3✔
4882

3✔
4883
                p.Disconnect(fmt.Errorf("unable to start peer: %w", err))
3✔
4884
                return
3✔
4885
        }
3✔
4886

4887
        // Otherwise, signal to the peerTerminationWatcher that the peer startup
4888
        // was successful, and to begin watching the peer's wait group.
4889
        close(ready)
3✔
4890

3✔
4891
        s.mu.Lock()
3✔
4892
        defer s.mu.Unlock()
3✔
4893

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

3✔
4897
        // TODO(guggero): Do a proper conversion to a string everywhere, or use
3✔
4898
        // route.Vertex as the key type of peerConnectedListeners.
3✔
4899
        pubStr := string(pubBytes)
3✔
4900
        for _, peerChan := range s.peerConnectedListeners[pubStr] {
6✔
4901
                select {
3✔
4902
                case peerChan <- p:
3✔
4903
                case <-s.quit:
×
4904
                        return
×
4905
                }
4906
        }
4907
        delete(s.peerConnectedListeners, pubStr)
3✔
4908
}
4909

4910
// peerTerminationWatcher waits until a peer has been disconnected unexpectedly,
4911
// and then cleans up all resources allocated to the peer, notifies relevant
4912
// sub-systems of its demise, and finally handles re-connecting to the peer if
4913
// it's persistent. If the server intentionally disconnects a peer, it should
4914
// have a corresponding entry in the ignorePeerTermination map which will cause
4915
// the cleanup routine to exit early. The passed `ready` chan is used to
4916
// synchronize when WaitForDisconnect should begin watching on the peer's
4917
// waitgroup. The ready chan should only be signaled if the peer starts
4918
// successfully, otherwise the peer should be disconnected instead.
4919
//
4920
// NOTE: This MUST be launched as a goroutine.
4921
func (s *server) peerTerminationWatcher(p *peer.Brontide, ready chan struct{}) {
3✔
4922
        defer s.wg.Done()
3✔
4923

3✔
4924
        p.WaitForDisconnect(ready)
3✔
4925

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

3✔
4928
        // If the server is exiting then we can bail out early ourselves as all
3✔
4929
        // the other sub-systems will already be shutting down.
3✔
4930
        if s.Stopped() {
6✔
4931
                srvrLog.Debugf("Server quitting, exit early for peer %v", p)
3✔
4932
                return
3✔
4933
        }
3✔
4934

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

3✔
4941
        pubKey := p.IdentityKey()
3✔
4942

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

3✔
4947
        // Tell the switch to remove all links associated with this peer.
3✔
4948
        // Passing nil as the target link indicates that all links associated
3✔
4949
        // with this interface should be closed.
3✔
4950
        //
3✔
4951
        // TODO(roasbeef): instead add a PurgeInterfaceLinks function?
3✔
4952
        links, err := s.htlcSwitch.GetLinksByInterface(p.PubKey())
3✔
4953
        if err != nil && err != htlcswitch.ErrNoLinksFound {
3✔
4954
                srvrLog.Errorf("Unable to get channel links for %v: %v", p, err)
×
4955
        }
×
4956

4957
        for _, link := range links {
6✔
4958
                s.htlcSwitch.RemoveLink(link.ChanID())
3✔
4959
        }
3✔
4960

4961
        s.mu.Lock()
3✔
4962
        defer s.mu.Unlock()
3✔
4963

3✔
4964
        // If there were any notification requests for when this peer
3✔
4965
        // disconnected, we can trigger them now.
3✔
4966
        srvrLog.Debugf("Notifying that peer %v is offline", p)
3✔
4967
        pubStr := string(pubKey.SerializeCompressed())
3✔
4968
        for _, offlineChan := range s.peerDisconnectedListeners[pubStr] {
6✔
4969
                close(offlineChan)
3✔
4970
        }
3✔
4971
        delete(s.peerDisconnectedListeners, pubStr)
3✔
4972

3✔
4973
        // If the server has already removed this peer, we can short circuit the
3✔
4974
        // peer termination watcher and skip cleanup.
3✔
4975
        if _, ok := s.ignorePeerTermination[p]; ok {
3✔
4976
                delete(s.ignorePeerTermination, p)
×
4977

×
4978
                pubKey := p.PubKey()
×
4979
                pubStr := string(pubKey[:])
×
4980

×
4981
                // If a connection callback is present, we'll go ahead and
×
4982
                // execute it now that previous peer has fully disconnected. If
×
4983
                // the callback is not present, this likely implies the peer was
×
4984
                // purposefully disconnected via RPC, and that no reconnect
×
4985
                // should be attempted.
×
4986
                connCallback, ok := s.scheduledPeerConnection[pubStr]
×
4987
                if ok {
×
4988
                        delete(s.scheduledPeerConnection, pubStr)
×
4989
                        connCallback()
×
4990
                }
×
4991
                return
×
4992
        }
4993

4994
        // First, cleanup any remaining state the server has regarding the peer
4995
        // in question.
4996
        s.removePeer(p)
3✔
4997

3✔
4998
        // Next, check to see if this is a persistent peer or not.
3✔
4999
        if _, ok := s.persistentPeers[pubStr]; !ok {
6✔
5000
                return
3✔
5001
        }
3✔
5002

5003
        // Get the last address that we used to connect to the peer.
5004
        addrs := []net.Addr{
3✔
5005
                p.NetAddress().Address,
3✔
5006
        }
3✔
5007

3✔
5008
        // We'll ensure that we locate all the peers advertised addresses for
3✔
5009
        // reconnection purposes.
3✔
5010
        advertisedAddrs, err := s.fetchNodeAdvertisedAddrs(pubKey)
3✔
5011
        switch {
3✔
5012
        // We found advertised addresses, so use them.
5013
        case err == nil:
3✔
5014
                addrs = advertisedAddrs
3✔
5015

5016
        // The peer doesn't have an advertised address.
5017
        case err == errNoAdvertisedAddr:
3✔
5018
                // If it is an outbound peer then we fall back to the existing
3✔
5019
                // peer address.
3✔
5020
                if !p.Inbound() {
6✔
5021
                        break
3✔
5022
                }
5023

5024
                // Fall back to the existing peer address if
5025
                // we're not accepting connections over Tor.
5026
                if s.torController == nil {
6✔
5027
                        break
3✔
5028
                }
5029

5030
                // If we are, the peer's address won't be known
5031
                // to us (we'll see a private address, which is
5032
                // the address used by our onion service to dial
5033
                // to lnd), so we don't have enough information
5034
                // to attempt a reconnect.
5035
                srvrLog.Debugf("Ignoring reconnection attempt "+
×
5036
                        "to inbound peer %v without "+
×
5037
                        "advertised address", p)
×
5038
                return
×
5039

5040
        // We came across an error retrieving an advertised
5041
        // address, log it, and fall back to the existing peer
5042
        // address.
5043
        default:
3✔
5044
                srvrLog.Errorf("Unable to retrieve advertised "+
3✔
5045
                        "address for node %x: %v", p.PubKey(),
3✔
5046
                        err)
3✔
5047
        }
5048

5049
        // Make an easy lookup map so that we can check if an address
5050
        // is already in the address list that we have stored for this peer.
5051
        existingAddrs := make(map[string]bool)
3✔
5052
        for _, addr := range s.persistentPeerAddrs[pubStr] {
6✔
5053
                existingAddrs[addr.String()] = true
3✔
5054
        }
3✔
5055

5056
        // Add any missing addresses for this peer to persistentPeerAddr.
5057
        for _, addr := range addrs {
6✔
5058
                if existingAddrs[addr.String()] {
3✔
5059
                        continue
×
5060
                }
5061

5062
                s.persistentPeerAddrs[pubStr] = append(
3✔
5063
                        s.persistentPeerAddrs[pubStr],
3✔
5064
                        &lnwire.NetAddress{
3✔
5065
                                IdentityKey: p.IdentityKey(),
3✔
5066
                                Address:     addr,
3✔
5067
                                ChainNet:    p.NetAddress().ChainNet,
3✔
5068
                        },
3✔
5069
                )
3✔
5070
        }
5071

5072
        // Record the computed backoff in the backoff map.
5073
        backoff := s.nextPeerBackoff(pubStr, p.StartTime())
3✔
5074
        s.persistentPeersBackoff[pubStr] = backoff
3✔
5075

3✔
5076
        // Initialize a retry canceller for this peer if one does not
3✔
5077
        // exist.
3✔
5078
        cancelChan, ok := s.persistentRetryCancels[pubStr]
3✔
5079
        if !ok {
6✔
5080
                cancelChan = make(chan struct{})
3✔
5081
                s.persistentRetryCancels[pubStr] = cancelChan
3✔
5082
        }
3✔
5083

5084
        // We choose not to wait group this go routine since the Connect
5085
        // call can stall for arbitrarily long if we shutdown while an
5086
        // outbound connection attempt is being made.
5087
        go func() {
6✔
5088
                srvrLog.Debugf("Scheduling connection re-establishment to "+
3✔
5089
                        "persistent peer %x in %s",
3✔
5090
                        p.IdentityKey().SerializeCompressed(), backoff)
3✔
5091

3✔
5092
                select {
3✔
5093
                case <-time.After(backoff):
3✔
5094
                case <-cancelChan:
3✔
5095
                        return
3✔
5096
                case <-s.quit:
3✔
5097
                        return
3✔
5098
                }
5099

5100
                srvrLog.Debugf("Attempting to re-establish persistent "+
3✔
5101
                        "connection to peer %x",
3✔
5102
                        p.IdentityKey().SerializeCompressed())
3✔
5103

3✔
5104
                s.connectToPersistentPeer(pubStr)
3✔
5105
        }()
5106
}
5107

5108
// connectToPersistentPeer uses all the stored addresses for a peer to attempt
5109
// to connect to the peer. It creates connection requests if there are
5110
// currently none for a given address and it removes old connection requests
5111
// if the associated address is no longer in the latest address list for the
5112
// peer.
5113
func (s *server) connectToPersistentPeer(pubKeyStr string) {
3✔
5114
        s.mu.Lock()
3✔
5115
        defer s.mu.Unlock()
3✔
5116

3✔
5117
        // Create an easy lookup map of the addresses we have stored for the
3✔
5118
        // peer. We will remove entries from this map if we have existing
3✔
5119
        // connection requests for the associated address and then any leftover
3✔
5120
        // entries will indicate which addresses we should create new
3✔
5121
        // connection requests for.
3✔
5122
        addrMap := make(map[string]*lnwire.NetAddress)
3✔
5123
        for _, addr := range s.persistentPeerAddrs[pubKeyStr] {
6✔
5124
                addrMap[addr.String()] = addr
3✔
5125
        }
3✔
5126

5127
        // Go through each of the existing connection requests and
5128
        // check if they correspond to the latest set of addresses. If
5129
        // there is a connection requests that does not use one of the latest
5130
        // advertised addresses then remove that connection request.
5131
        var updatedConnReqs []*connmgr.ConnReq
3✔
5132
        for _, connReq := range s.persistentConnReqs[pubKeyStr] {
6✔
5133
                lnAddr := connReq.Addr.(*lnwire.NetAddress).Address.String()
3✔
5134

3✔
5135
                switch _, ok := addrMap[lnAddr]; ok {
3✔
5136
                // If the existing connection request is using one of the
5137
                // latest advertised addresses for the peer then we add it to
5138
                // updatedConnReqs and remove the associated address from
5139
                // addrMap so that we don't recreate this connReq later on.
5140
                case true:
×
5141
                        updatedConnReqs = append(
×
5142
                                updatedConnReqs, connReq,
×
5143
                        )
×
5144
                        delete(addrMap, lnAddr)
×
5145

5146
                // If the existing connection request is using an address that
5147
                // is not one of the latest advertised addresses for the peer
5148
                // then we remove the connecting request from the connection
5149
                // manager.
5150
                case false:
3✔
5151
                        srvrLog.Info(
3✔
5152
                                "Removing conn req:", connReq.Addr.String(),
3✔
5153
                        )
3✔
5154
                        s.connMgr.Remove(connReq.ID())
3✔
5155
                }
5156
        }
5157

5158
        s.persistentConnReqs[pubKeyStr] = updatedConnReqs
3✔
5159

3✔
5160
        cancelChan, ok := s.persistentRetryCancels[pubKeyStr]
3✔
5161
        if !ok {
6✔
5162
                cancelChan = make(chan struct{})
3✔
5163
                s.persistentRetryCancels[pubKeyStr] = cancelChan
3✔
5164
        }
3✔
5165

5166
        // Any addresses left in addrMap are new ones that we have not made
5167
        // connection requests for. So create new connection requests for those.
5168
        // If there is more than one address in the address map, stagger the
5169
        // creation of the connection requests for those.
5170
        go func() {
6✔
5171
                ticker := time.NewTicker(multiAddrConnectionStagger)
3✔
5172
                defer ticker.Stop()
3✔
5173

3✔
5174
                for _, addr := range addrMap {
6✔
5175
                        // Send the persistent connection request to the
3✔
5176
                        // connection manager, saving the request itself so we
3✔
5177
                        // can cancel/restart the process as needed.
3✔
5178
                        connReq := &connmgr.ConnReq{
3✔
5179
                                Addr:      addr,
3✔
5180
                                Permanent: true,
3✔
5181
                        }
3✔
5182

3✔
5183
                        s.mu.Lock()
3✔
5184
                        s.persistentConnReqs[pubKeyStr] = append(
3✔
5185
                                s.persistentConnReqs[pubKeyStr], connReq,
3✔
5186
                        )
3✔
5187
                        s.mu.Unlock()
3✔
5188

3✔
5189
                        srvrLog.Debugf("Attempting persistent connection to "+
3✔
5190
                                "channel peer %v", addr)
3✔
5191

3✔
5192
                        go s.connMgr.Connect(connReq)
3✔
5193

3✔
5194
                        select {
3✔
5195
                        case <-s.quit:
3✔
5196
                                return
3✔
5197
                        case <-cancelChan:
3✔
5198
                                return
3✔
5199
                        case <-ticker.C:
3✔
5200
                        }
5201
                }
5202
        }()
5203
}
5204

5205
// removePeer removes the passed peer from the server's state of all active
5206
// peers.
5207
func (s *server) removePeer(p *peer.Brontide) {
3✔
5208
        if p == nil {
3✔
5209
                return
×
5210
        }
×
5211

5212
        srvrLog.Debugf("removing peer %v", p)
3✔
5213

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

3✔
5218
        // If this peer had an active persistent connection request, remove it.
3✔
5219
        if p.ConnReq() != nil {
6✔
5220
                s.connMgr.Remove(p.ConnReq().ID())
3✔
5221
        }
3✔
5222

5223
        // Ignore deleting peers if we're shutting down.
5224
        if s.Stopped() {
3✔
5225
                return
×
5226
        }
×
5227

5228
        pKey := p.PubKey()
3✔
5229
        pubSer := pKey[:]
3✔
5230
        pubStr := string(pubSer)
3✔
5231

3✔
5232
        delete(s.peersByPub, pubStr)
3✔
5233

3✔
5234
        if p.Inbound() {
6✔
5235
                delete(s.inboundPeers, pubStr)
3✔
5236
        } else {
6✔
5237
                delete(s.outboundPeers, pubStr)
3✔
5238
        }
3✔
5239

5240
        // Delete from peerScores.
5241
        remoteHex := hex.EncodeToString(pKey[:])
3✔
5242

3✔
5243
        s.banScoreMtx.Lock()
3✔
5244

3✔
5245
        status, found := s.peerScores[remoteHex]
3✔
5246
        if !found {
3✔
NEW
5247
                s.banScoreMtx.Unlock()
×
NEW
5248
                srvrLog.Errorf("unable to find peer score for %v", remoteHex)
×
NEW
5249
                return
×
NEW
5250
        }
×
5251

5252
        if status.state == peerStatusRestricted {
6✔
5253
                // If the status is restricted, then we decrement from
3✔
5254
                // numRestrictedSlots.
3✔
5255
                s.numRestricted--
3✔
5256
        }
3✔
5257

5258
        delete(s.peerScores, remoteHex)
3✔
5259

3✔
5260
        s.banScoreMtx.Unlock()
3✔
5261

3✔
5262
        // Copy the peer's error buffer across to the server if it has any items
3✔
5263
        // in it so that we can restore peer errors across connections.
3✔
5264
        if p.ErrorBuffer().Total() > 0 {
6✔
5265
                s.peerErrors[pubStr] = p.ErrorBuffer()
3✔
5266
        }
3✔
5267

5268
        // Inform the peer notifier of a peer offline event so that it can be
5269
        // reported to clients listening for peer events.
5270
        var pubKey [33]byte
3✔
5271
        copy(pubKey[:], pubSer)
3✔
5272

3✔
5273
        s.peerNotifier.NotifyPeerOffline(pubKey)
3✔
5274
}
5275

5276
// ConnectToPeer requests that the server connect to a Lightning Network peer
5277
// at the specified address. This function will *block* until either a
5278
// connection is established, or the initial handshake process fails.
5279
//
5280
// NOTE: This function is safe for concurrent access.
5281
func (s *server) ConnectToPeer(addr *lnwire.NetAddress,
5282
        perm bool, timeout time.Duration) error {
3✔
5283

3✔
5284
        targetPub := string(addr.IdentityKey.SerializeCompressed())
3✔
5285

3✔
5286
        // Acquire mutex, but use explicit unlocking instead of defer for
3✔
5287
        // better granularity.  In certain conditions, this method requires
3✔
5288
        // making an outbound connection to a remote peer, which requires the
3✔
5289
        // lock to be released, and subsequently reacquired.
3✔
5290
        s.mu.Lock()
3✔
5291

3✔
5292
        // Ensure we're not already connected to this peer.
3✔
5293
        peer, err := s.findPeerByPubStr(targetPub)
3✔
5294
        if err == nil {
6✔
5295
                s.mu.Unlock()
3✔
5296
                return &errPeerAlreadyConnected{peer: peer}
3✔
5297
        }
3✔
5298

5299
        // Peer was not found, continue to pursue connection with peer.
5300

5301
        // If there's already a pending connection request for this pubkey,
5302
        // then we ignore this request to ensure we don't create a redundant
5303
        // connection.
5304
        if reqs, ok := s.persistentConnReqs[targetPub]; ok {
6✔
5305
                srvrLog.Warnf("Already have %d persistent connection "+
3✔
5306
                        "requests for %v, connecting anyway.", len(reqs), addr)
3✔
5307
        }
3✔
5308

5309
        // If there's not already a pending or active connection to this node,
5310
        // then instruct the connection manager to attempt to establish a
5311
        // persistent connection to the peer.
5312
        srvrLog.Debugf("Connecting to %v", addr)
3✔
5313
        if perm {
6✔
5314
                connReq := &connmgr.ConnReq{
3✔
5315
                        Addr:      addr,
3✔
5316
                        Permanent: true,
3✔
5317
                }
3✔
5318

3✔
5319
                // Since the user requested a permanent connection, we'll set
3✔
5320
                // the entry to true which will tell the server to continue
3✔
5321
                // reconnecting even if the number of channels with this peer is
3✔
5322
                // zero.
3✔
5323
                s.persistentPeers[targetPub] = true
3✔
5324
                if _, ok := s.persistentPeersBackoff[targetPub]; !ok {
6✔
5325
                        s.persistentPeersBackoff[targetPub] = s.cfg.MinBackoff
3✔
5326
                }
3✔
5327
                s.persistentConnReqs[targetPub] = append(
3✔
5328
                        s.persistentConnReqs[targetPub], connReq,
3✔
5329
                )
3✔
5330
                s.mu.Unlock()
3✔
5331

3✔
5332
                go s.connMgr.Connect(connReq)
3✔
5333

3✔
5334
                return nil
3✔
5335
        }
5336
        s.mu.Unlock()
3✔
5337

3✔
5338
        // If we're not making a persistent connection, then we'll attempt to
3✔
5339
        // connect to the target peer. If the we can't make the connection, or
3✔
5340
        // the crypto negotiation breaks down, then return an error to the
3✔
5341
        // caller.
3✔
5342
        errChan := make(chan error, 1)
3✔
5343
        s.connectToPeer(addr, errChan, timeout)
3✔
5344

3✔
5345
        select {
3✔
5346
        case err := <-errChan:
3✔
5347
                return err
3✔
5348
        case <-s.quit:
×
5349
                return ErrServerShuttingDown
×
5350
        }
5351
}
5352

5353
// connectToPeer establishes a connection to a remote peer. errChan is used to
5354
// notify the caller if the connection attempt has failed. Otherwise, it will be
5355
// closed.
5356
func (s *server) connectToPeer(addr *lnwire.NetAddress,
5357
        errChan chan<- error, timeout time.Duration) {
3✔
5358

3✔
5359
        conn, err := brontide.Dial(
3✔
5360
                s.identityECDH, addr, timeout, s.cfg.net.Dial,
3✔
5361
        )
3✔
5362
        if err != nil {
6✔
5363
                srvrLog.Errorf("Unable to connect to %v: %v", addr, err)
3✔
5364
                select {
3✔
5365
                case errChan <- err:
3✔
5366
                case <-s.quit:
×
5367
                }
5368
                return
3✔
5369
        }
5370

5371
        close(errChan)
3✔
5372

3✔
5373
        srvrLog.Tracef("Brontide dialer made local=%v, remote=%v",
3✔
5374
                conn.LocalAddr(), conn.RemoteAddr())
3✔
5375

3✔
5376
        s.OutboundPeerConnected(nil, conn)
3✔
5377
}
5378

5379
// DisconnectPeer sends the request to server to close the connection with peer
5380
// identified by public key.
5381
//
5382
// NOTE: This function is safe for concurrent access.
5383
func (s *server) DisconnectPeer(pubKey *btcec.PublicKey) error {
3✔
5384
        pubBytes := pubKey.SerializeCompressed()
3✔
5385
        pubStr := string(pubBytes)
3✔
5386

3✔
5387
        s.mu.Lock()
3✔
5388
        defer s.mu.Unlock()
3✔
5389

3✔
5390
        // Check that were actually connected to this peer. If not, then we'll
3✔
5391
        // exit in an error as we can't disconnect from a peer that we're not
3✔
5392
        // currently connected to.
3✔
5393
        peer, err := s.findPeerByPubStr(pubStr)
3✔
5394
        if err == ErrPeerNotConnected {
6✔
5395
                return fmt.Errorf("peer %x is not connected", pubBytes)
3✔
5396
        }
3✔
5397

5398
        srvrLog.Infof("Disconnecting from %v", peer)
3✔
5399

3✔
5400
        s.cancelConnReqs(pubStr, nil)
3✔
5401

3✔
5402
        // If this peer was formerly a persistent connection, then we'll remove
3✔
5403
        // them from this map so we don't attempt to re-connect after we
3✔
5404
        // disconnect.
3✔
5405
        delete(s.persistentPeers, pubStr)
3✔
5406
        delete(s.persistentPeersBackoff, pubStr)
3✔
5407

3✔
5408
        // Remove the peer by calling Disconnect. Previously this was done with
3✔
5409
        // removePeer, which bypassed the peerTerminationWatcher.
3✔
5410
        peer.Disconnect(fmt.Errorf("server: DisconnectPeer called"))
3✔
5411

3✔
5412
        return nil
3✔
5413
}
5414

5415
// OpenChannel sends a request to the server to open a channel to the specified
5416
// peer identified by nodeKey with the passed channel funding parameters.
5417
//
5418
// NOTE: This function is safe for concurrent access.
5419
func (s *server) OpenChannel(
5420
        req *funding.InitFundingMsg) (chan *lnrpc.OpenStatusUpdate, chan error) {
3✔
5421

3✔
5422
        // The updateChan will have a buffer of 2, since we expect a ChanPending
3✔
5423
        // + a ChanOpen update, and we want to make sure the funding process is
3✔
5424
        // not blocked if the caller is not reading the updates.
3✔
5425
        req.Updates = make(chan *lnrpc.OpenStatusUpdate, 2)
3✔
5426
        req.Err = make(chan error, 1)
3✔
5427

3✔
5428
        // First attempt to locate the target peer to open a channel with, if
3✔
5429
        // we're unable to locate the peer then this request will fail.
3✔
5430
        pubKeyBytes := req.TargetPubkey.SerializeCompressed()
3✔
5431
        s.mu.RLock()
3✔
5432
        peer, ok := s.peersByPub[string(pubKeyBytes)]
3✔
5433
        if !ok {
3✔
5434
                s.mu.RUnlock()
×
5435

×
5436
                req.Err <- fmt.Errorf("peer %x is not online", pubKeyBytes)
×
5437
                return req.Updates, req.Err
×
5438
        }
×
5439
        req.Peer = peer
3✔
5440
        s.mu.RUnlock()
3✔
5441

3✔
5442
        // We'll wait until the peer is active before beginning the channel
3✔
5443
        // opening process.
3✔
5444
        select {
3✔
5445
        case <-peer.ActiveSignal():
3✔
5446
        case <-peer.QuitSignal():
×
5447
                req.Err <- fmt.Errorf("peer %x disconnected", pubKeyBytes)
×
5448
                return req.Updates, req.Err
×
5449
        case <-s.quit:
×
5450
                req.Err <- ErrServerShuttingDown
×
5451
                return req.Updates, req.Err
×
5452
        }
5453

5454
        // If the fee rate wasn't specified at this point we fail the funding
5455
        // because of the missing fee rate information. The caller of the
5456
        // `OpenChannel` method needs to make sure that default values for the
5457
        // fee rate are set beforehand.
5458
        if req.FundingFeePerKw == 0 {
3✔
5459
                req.Err <- fmt.Errorf("no FundingFeePerKw specified for " +
×
5460
                        "the channel opening transaction")
×
5461

×
5462
                return req.Updates, req.Err
×
5463
        }
×
5464

5465
        // Spawn a goroutine to send the funding workflow request to the funding
5466
        // manager. This allows the server to continue handling queries instead
5467
        // of blocking on this request which is exported as a synchronous
5468
        // request to the outside world.
5469
        go s.fundingMgr.InitFundingWorkflow(req)
3✔
5470

3✔
5471
        return req.Updates, req.Err
3✔
5472
}
5473

5474
// Peers returns a slice of all active peers.
5475
//
5476
// NOTE: This function is safe for concurrent access.
5477
func (s *server) Peers() []*peer.Brontide {
3✔
5478
        s.mu.RLock()
3✔
5479
        defer s.mu.RUnlock()
3✔
5480

3✔
5481
        peers := make([]*peer.Brontide, 0, len(s.peersByPub))
3✔
5482
        for _, peer := range s.peersByPub {
6✔
5483
                peers = append(peers, peer)
3✔
5484
        }
3✔
5485

5486
        return peers
3✔
5487
}
5488

5489
// computeNextBackoff uses a truncated exponential backoff to compute the next
5490
// backoff using the value of the exiting backoff. The returned duration is
5491
// randomized in either direction by 1/20 to prevent tight loops from
5492
// stabilizing.
5493
func computeNextBackoff(currBackoff, maxBackoff time.Duration) time.Duration {
3✔
5494
        // Double the current backoff, truncating if it exceeds our maximum.
3✔
5495
        nextBackoff := 2 * currBackoff
3✔
5496
        if nextBackoff > maxBackoff {
6✔
5497
                nextBackoff = maxBackoff
3✔
5498
        }
3✔
5499

5500
        // Using 1/10 of our duration as a margin, compute a random offset to
5501
        // avoid the nodes entering connection cycles.
5502
        margin := nextBackoff / 10
3✔
5503

3✔
5504
        var wiggle big.Int
3✔
5505
        wiggle.SetUint64(uint64(margin))
3✔
5506
        if _, err := rand.Int(rand.Reader, &wiggle); err != nil {
3✔
5507
                // Randomizing is not mission critical, so we'll just return the
×
5508
                // current backoff.
×
5509
                return nextBackoff
×
5510
        }
×
5511

5512
        // Otherwise add in our wiggle, but subtract out half of the margin so
5513
        // that the backoff can tweaked by 1/20 in either direction.
5514
        return nextBackoff + (time.Duration(wiggle.Uint64()) - margin/2)
3✔
5515
}
5516

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

5521
// fetchNodeAdvertisedAddrs attempts to fetch the advertised addresses of a node.
5522
func (s *server) fetchNodeAdvertisedAddrs(pub *btcec.PublicKey) ([]net.Addr, error) {
3✔
5523
        vertex, err := route.NewVertexFromBytes(pub.SerializeCompressed())
3✔
5524
        if err != nil {
3✔
5525
                return nil, err
×
5526
        }
×
5527

5528
        node, err := s.graphDB.FetchLightningNode(vertex)
3✔
5529
        if err != nil {
6✔
5530
                return nil, err
3✔
5531
        }
3✔
5532

5533
        if len(node.Addresses) == 0 {
6✔
5534
                return nil, errNoAdvertisedAddr
3✔
5535
        }
3✔
5536

5537
        return node.Addresses, nil
3✔
5538
}
5539

5540
// fetchLastChanUpdate returns a function which is able to retrieve our latest
5541
// channel update for a target channel.
5542
func (s *server) fetchLastChanUpdate() func(lnwire.ShortChannelID) (
5543
        *lnwire.ChannelUpdate1, error) {
3✔
5544

3✔
5545
        ourPubKey := s.identityECDH.PubKey().SerializeCompressed()
3✔
5546
        return func(cid lnwire.ShortChannelID) (*lnwire.ChannelUpdate1, error) {
6✔
5547
                info, edge1, edge2, err := s.graphBuilder.GetChannelByID(cid)
3✔
5548
                if err != nil {
6✔
5549
                        return nil, err
3✔
5550
                }
3✔
5551

5552
                return netann.ExtractChannelUpdate(
3✔
5553
                        ourPubKey[:], info, edge1, edge2,
3✔
5554
                )
3✔
5555
        }
5556
}
5557

5558
// applyChannelUpdate applies the channel update to the different sub-systems of
5559
// the server. The useAlias boolean denotes whether or not to send an alias in
5560
// place of the real SCID.
5561
func (s *server) applyChannelUpdate(update *lnwire.ChannelUpdate1,
5562
        op *wire.OutPoint, useAlias bool) error {
3✔
5563

3✔
5564
        var (
3✔
5565
                peerAlias    *lnwire.ShortChannelID
3✔
5566
                defaultAlias lnwire.ShortChannelID
3✔
5567
        )
3✔
5568

3✔
5569
        chanID := lnwire.NewChanIDFromOutPoint(*op)
3✔
5570

3✔
5571
        // Fetch the peer's alias from the lnwire.ChannelID so it can be used
3✔
5572
        // in the ChannelUpdate if it hasn't been announced yet.
3✔
5573
        if useAlias {
6✔
5574
                foundAlias, _ := s.aliasMgr.GetPeerAlias(chanID)
3✔
5575
                if foundAlias != defaultAlias {
6✔
5576
                        peerAlias = &foundAlias
3✔
5577
                }
3✔
5578
        }
5579

5580
        errChan := s.authGossiper.ProcessLocalAnnouncement(
3✔
5581
                update, discovery.RemoteAlias(peerAlias),
3✔
5582
        )
3✔
5583
        select {
3✔
5584
        case err := <-errChan:
3✔
5585
                return err
3✔
5586
        case <-s.quit:
×
5587
                return ErrServerShuttingDown
×
5588
        }
5589
}
5590

5591
// SendCustomMessage sends a custom message to the peer with the specified
5592
// pubkey.
5593
func (s *server) SendCustomMessage(peerPub [33]byte, msgType lnwire.MessageType,
5594
        data []byte) error {
3✔
5595

3✔
5596
        peer, err := s.FindPeerByPubStr(string(peerPub[:]))
3✔
5597
        if err != nil {
3✔
5598
                return err
×
5599
        }
×
5600

5601
        // We'll wait until the peer is active.
5602
        select {
3✔
5603
        case <-peer.ActiveSignal():
3✔
5604
        case <-peer.QuitSignal():
×
5605
                return fmt.Errorf("peer %x disconnected", peerPub)
×
5606
        case <-s.quit:
×
5607
                return ErrServerShuttingDown
×
5608
        }
5609

5610
        msg, err := lnwire.NewCustom(msgType, data)
3✔
5611
        if err != nil {
6✔
5612
                return err
3✔
5613
        }
3✔
5614

5615
        // Send the message as low-priority. For now we assume that all
5616
        // application-defined message are low priority.
5617
        return peer.SendMessageLazy(true, msg)
3✔
5618
}
5619

5620
// newSweepPkScriptGen creates closure that generates a new public key script
5621
// which should be used to sweep any funds into the on-chain wallet.
5622
// Specifically, the script generated is a version 0, pay-to-witness-pubkey-hash
5623
// (p2wkh) output.
5624
func newSweepPkScriptGen(
5625
        wallet lnwallet.WalletController,
5626
        netParams *chaincfg.Params) func() fn.Result[lnwallet.AddrWithKey] {
3✔
5627

3✔
5628
        return func() fn.Result[lnwallet.AddrWithKey] {
6✔
5629
                sweepAddr, err := wallet.NewAddress(
3✔
5630
                        lnwallet.TaprootPubkey, false,
3✔
5631
                        lnwallet.DefaultAccountName,
3✔
5632
                )
3✔
5633
                if err != nil {
3✔
5634
                        return fn.Err[lnwallet.AddrWithKey](err)
×
5635
                }
×
5636

5637
                addr, err := txscript.PayToAddrScript(sweepAddr)
3✔
5638
                if err != nil {
3✔
5639
                        return fn.Err[lnwallet.AddrWithKey](err)
×
5640
                }
×
5641

5642
                internalKeyDesc, err := lnwallet.InternalKeyForAddr(
3✔
5643
                        wallet, netParams, addr,
3✔
5644
                )
3✔
5645
                if err != nil {
3✔
5646
                        return fn.Err[lnwallet.AddrWithKey](err)
×
5647
                }
×
5648

5649
                return fn.Ok(lnwallet.AddrWithKey{
3✔
5650
                        DeliveryAddress: addr,
3✔
5651
                        InternalKey:     internalKeyDesc,
3✔
5652
                })
3✔
5653
        }
5654
}
5655

5656
// shouldPeerBootstrap returns true if we should attempt to perform peer
5657
// bootstrapping to actively seek our peers using the set of active network
5658
// bootstrappers.
5659
func shouldPeerBootstrap(cfg *Config) bool {
9✔
5660
        isSimnet := cfg.Bitcoin.SimNet
9✔
5661
        isSignet := cfg.Bitcoin.SigNet
9✔
5662
        isRegtest := cfg.Bitcoin.RegTest
9✔
5663
        isDevNetwork := isSimnet || isSignet || isRegtest
9✔
5664

9✔
5665
        // TODO(yy): remove the check on simnet/regtest such that the itest is
9✔
5666
        // covering the bootstrapping process.
9✔
5667
        return !cfg.NoNetBootstrap && !isDevNetwork
9✔
5668
}
9✔
5669

5670
// fetchClosedChannelSCIDs returns a set of SCIDs that have their force closing
5671
// finished.
5672
func (s *server) fetchClosedChannelSCIDs() map[lnwire.ShortChannelID]struct{} {
3✔
5673
        // Get a list of closed channels.
3✔
5674
        channels, err := s.chanStateDB.FetchClosedChannels(false)
3✔
5675
        if err != nil {
3✔
5676
                srvrLog.Errorf("Failed to fetch closed channels: %v", err)
×
5677
                return nil
×
5678
        }
×
5679

5680
        // Save the SCIDs in a map.
5681
        closedSCIDs := make(map[lnwire.ShortChannelID]struct{}, len(channels))
3✔
5682
        for _, c := range channels {
6✔
5683
                // If the channel is not pending, its FC has been finalized.
3✔
5684
                if !c.IsPending {
6✔
5685
                        closedSCIDs[c.ShortChanID] = struct{}{}
3✔
5686
                }
3✔
5687
        }
5688

5689
        // Double check whether the reported closed channel has indeed finished
5690
        // closing.
5691
        //
5692
        // NOTE: There are misalignments regarding when a channel's FC is
5693
        // marked as finalized. We double check the pending channels to make
5694
        // sure the returned SCIDs are indeed terminated.
5695
        //
5696
        // TODO(yy): fix the misalignments in `FetchClosedChannels`.
5697
        pendings, err := s.chanStateDB.FetchPendingChannels()
3✔
5698
        if err != nil {
3✔
5699
                srvrLog.Errorf("Failed to fetch pending channels: %v", err)
×
5700
                return nil
×
5701
        }
×
5702

5703
        for _, c := range pendings {
6✔
5704
                if _, ok := closedSCIDs[c.ShortChannelID]; !ok {
6✔
5705
                        continue
3✔
5706
                }
5707

5708
                // If the channel is still reported as pending, remove it from
5709
                // the map.
5710
                delete(closedSCIDs, c.ShortChannelID)
×
5711

×
5712
                srvrLog.Warnf("Channel=%v is prematurely marked as finalized",
×
5713
                        c.ShortChannelID)
×
5714
        }
5715

5716
        return closedSCIDs
3✔
5717
}
5718

5719
// getStartingBeat returns the current beat. This is used during the startup to
5720
// initialize blockbeat consumers.
5721
func (s *server) getStartingBeat() (*chainio.Beat, error) {
3✔
5722
        // beat is the current blockbeat.
3✔
5723
        var beat *chainio.Beat
3✔
5724

3✔
5725
        // We should get a notification with the current best block immediately
3✔
5726
        // by passing a nil block.
3✔
5727
        blockEpochs, err := s.cc.ChainNotifier.RegisterBlockEpochNtfn(nil)
3✔
5728
        if err != nil {
3✔
5729
                return beat, fmt.Errorf("register block epoch ntfn: %w", err)
×
5730
        }
×
5731
        defer blockEpochs.Cancel()
3✔
5732

3✔
5733
        // We registered for the block epochs with a nil request. The notifier
3✔
5734
        // should send us the current best block immediately. So we need to
3✔
5735
        // wait for it here because we need to know the current best height.
3✔
5736
        select {
3✔
5737
        case bestBlock := <-blockEpochs.Epochs:
3✔
5738
                srvrLog.Infof("Received initial block %v at height %d",
3✔
5739
                        bestBlock.Hash, bestBlock.Height)
3✔
5740

3✔
5741
                // Update the current blockbeat.
3✔
5742
                beat = chainio.NewBeat(*bestBlock)
3✔
5743

5744
        case <-s.quit:
×
5745
                srvrLog.Debug("LND shutting down")
×
5746
        }
5747

5748
        return beat, nil
3✔
5749
}
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