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

lightningnetwork / lnd / 14047359686

24 Mar 2025 10:36PM UTC coverage: 69.0% (-0.01%) from 69.012%
14047359686

Pull #9636

github

web-flow
Merge b6ccc9d8a into f7b317748
Pull Request #9636: README+docs: add code review checklist

132932 of 192655 relevant lines covered (69.0%)

22275.1 hits per line

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

64.3
/server.go
1
package lnd
2

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

212
        start sync.Once
213
        stop  sync.Once
214

215
        cfg *Config
216

217
        implCfg *ImplementationCfg
218

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

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

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

230
        chanStatusMgr *netann.ChanStatusManager
231

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

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

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

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

252
        mu sync.RWMutex
253

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

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

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

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

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

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

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

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

304
        cc *chainreg.ChainControl
305

306
        fundingMgr *funding.Manager
307

308
        graphDB *graphdb.ChannelGraph
309

310
        chanStateDB *channeldb.ChannelStateDB
311

312
        addrSource channeldb.AddrSource
313

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

318
        invoicesDB invoices.InvoiceDB
319

320
        aliasMgr *aliasmgr.Manager
321

322
        htlcSwitch *htlcswitch.Switch
323

324
        interceptableSwitch *htlcswitch.InterceptableSwitch
325

326
        invoices *invoices.InvoiceRegistry
327

328
        invoiceHtlcModifier *invoices.HtlcModificationInterceptor
329

330
        channelNotifier *channelnotifier.ChannelNotifier
331

332
        peerNotifier *peernotifier.PeerNotifier
333

334
        htlcNotifier *htlcswitch.HtlcNotifier
335

336
        witnessBeacon contractcourt.WitnessBeacon
337

338
        breachArbitrator *contractcourt.BreachArbitrator
339

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

343
        graphBuilder *graph.Builder
344

345
        chanRouter *routing.ChannelRouter
346

347
        controlTower routing.ControlTower
348

349
        authGossiper *discovery.AuthenticatedGossiper
350

351
        localChanMgr *localchans.Manager
352

353
        utxoNursery *contractcourt.UtxoNursery
354

355
        sweeper *sweep.UtxoSweeper
356

357
        chainArb *contractcourt.ChainArbitrator
358

359
        sphinx *hop.OnionProcessor
360

361
        towerClientMgr *wtclient.Manager
362

363
        connMgr *connmgr.ConnManager
364

365
        sigPool *lnwallet.SigPool
366

367
        writePool *pool.Write
368

369
        readPool *pool.Read
370

371
        tlsManager *TLSManager
372

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

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

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

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

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

395
        hostAnn *netann.HostAnnouncer
396

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

400
        customMessageServer *subscribe.Server
401

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

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

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

412
        quit chan struct{}
413

414
        wg sync.WaitGroup
415
}
416

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

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

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

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

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

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

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

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

472
                                        s.mu.Lock()
3✔
473

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

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

488
                                        s.mu.Unlock()
3✔
489

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

496
        return nil
3✔
497
}
498

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

615
        // For now, the RBF coop close flag and the taproot channel type cannot
616
        // be used together.
617
        //
618
        // TODO(roasbeef): fix
619
        if cfg.ProtocolOptions.RbfCoopClose &&
3✔
620
                cfg.ProtocolOptions.TaprootChans {
3✔
621

×
622
                return nil, fmt.Errorf("RBF coop close and taproot " +
×
623
                        "channels cannot be used together")
×
624
        }
×
625

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

649
        invoiceHtlcModifier := invoices.NewHtlcModificationInterceptor()
3✔
650
        registryConfig := invoices.RegistryConfig{
3✔
651
                FinalCltvRejectDelta:        lncfg.DefaultFinalCltvRejectDelta,
3✔
652
                HtlcHoldDuration:            invoices.DefaultHtlcHoldDuration,
3✔
653
                Clock:                       clock.NewDefaultClock(),
3✔
654
                AcceptKeySend:               cfg.AcceptKeySend,
3✔
655
                AcceptAMP:                   cfg.AcceptAMP,
3✔
656
                GcCanceledInvoicesOnStartup: cfg.GcCanceledInvoicesOnStartup,
3✔
657
                GcCanceledInvoicesOnTheFly:  cfg.GcCanceledInvoicesOnTheFly,
3✔
658
                KeysendHoldTime:             cfg.KeysendHoldTime,
3✔
659
                HtlcInterceptor:             invoiceHtlcModifier,
3✔
660
        }
3✔
661

3✔
662
        addrSource := channeldb.NewMultiAddrSource(dbs.ChanStateDB, dbs.GraphDB)
3✔
663

3✔
664
        s := &server{
3✔
665
                cfg:            cfg,
3✔
666
                implCfg:        implCfg,
3✔
667
                graphDB:        dbs.GraphDB,
3✔
668
                chanStateDB:    dbs.ChanStateDB.ChannelStateDB(),
3✔
669
                addrSource:     addrSource,
3✔
670
                miscDB:         dbs.ChanStateDB,
3✔
671
                invoicesDB:     dbs.InvoiceDB,
3✔
672
                cc:             cc,
3✔
673
                sigPool:        lnwallet.NewSigPool(cfg.Workers.Sig, cc.Signer),
3✔
674
                writePool:      writePool,
3✔
675
                readPool:       readPool,
3✔
676
                chansToRestore: chansToRestore,
3✔
677

3✔
678
                blockbeatDispatcher: chainio.NewBlockbeatDispatcher(
3✔
679
                        cc.ChainNotifier,
3✔
680
                ),
3✔
681
                channelNotifier: channelnotifier.New(
3✔
682
                        dbs.ChanStateDB.ChannelStateDB(),
3✔
683
                ),
3✔
684

3✔
685
                identityECDH:   nodeKeyECDH,
3✔
686
                identityKeyLoc: nodeKeyDesc.KeyLocator,
3✔
687
                nodeSigner:     netann.NewNodeSigner(nodeKeySigner),
3✔
688

3✔
689
                listenAddrs: listenAddrs,
3✔
690

3✔
691
                // TODO(roasbeef): derive proper onion key based on rotation
3✔
692
                // schedule
3✔
693
                sphinx: hop.NewOnionProcessor(sphinxRouter),
3✔
694

3✔
695
                torController: torController,
3✔
696

3✔
697
                persistentPeers:         make(map[string]bool),
3✔
698
                persistentPeersBackoff:  make(map[string]time.Duration),
3✔
699
                persistentConnReqs:      make(map[string][]*connmgr.ConnReq),
3✔
700
                persistentPeerAddrs:     make(map[string][]*lnwire.NetAddress),
3✔
701
                persistentRetryCancels:  make(map[string]chan struct{}),
3✔
702
                peerErrors:              make(map[string]*queue.CircularBuffer),
3✔
703
                ignorePeerTermination:   make(map[*peer.Brontide]struct{}),
3✔
704
                scheduledPeerConnection: make(map[string]func()),
3✔
705
                pongBuf:                 make([]byte, lnwire.MaxPongBytes),
3✔
706

3✔
707
                peersByPub:                make(map[string]*peer.Brontide),
3✔
708
                inboundPeers:              make(map[string]*peer.Brontide),
3✔
709
                outboundPeers:             make(map[string]*peer.Brontide),
3✔
710
                peerConnectedListeners:    make(map[string][]chan<- lnpeer.Peer),
3✔
711
                peerDisconnectedListeners: make(map[string][]chan<- struct{}),
3✔
712

3✔
713
                invoiceHtlcModifier: invoiceHtlcModifier,
3✔
714

3✔
715
                customMessageServer: subscribe.NewServer(),
3✔
716

3✔
717
                tlsManager: tlsManager,
3✔
718

3✔
719
                featureMgr: featureMgr,
3✔
720
                quit:       make(chan struct{}),
3✔
721
        }
3✔
722

3✔
723
        // Start the low-level services once they are initialized.
3✔
724
        //
3✔
725
        // TODO(yy): break the server startup into four steps,
3✔
726
        // 1. init the low-level services.
3✔
727
        // 2. start the low-level services.
3✔
728
        // 3. init the high-level services.
3✔
729
        // 4. start the high-level services.
3✔
730
        if err := s.startLowLevelServices(); err != nil {
3✔
731
                return nil, err
×
732
        }
×
733

734
        currentHash, currentHeight, err := s.cc.ChainIO.GetBestBlock()
3✔
735
        if err != nil {
3✔
736
                return nil, err
×
737
        }
×
738

739
        expiryWatcher := invoices.NewInvoiceExpiryWatcher(
3✔
740
                clock.NewDefaultClock(), cfg.Invoices.HoldExpiryDelta,
3✔
741
                uint32(currentHeight), currentHash, cc.ChainNotifier,
3✔
742
        )
3✔
743
        s.invoices = invoices.NewRegistry(
3✔
744
                dbs.InvoiceDB, expiryWatcher, &registryConfig,
3✔
745
        )
3✔
746

3✔
747
        s.htlcNotifier = htlcswitch.NewHtlcNotifier(time.Now)
3✔
748

3✔
749
        thresholdSats := btcutil.Amount(cfg.MaxFeeExposure)
3✔
750
        thresholdMSats := lnwire.NewMSatFromSatoshis(thresholdSats)
3✔
751

3✔
752
        linkUpdater := func(shortID lnwire.ShortChannelID) error {
6✔
753
                link, err := s.htlcSwitch.GetLinkByShortID(shortID)
3✔
754
                if err != nil {
3✔
755
                        return err
×
756
                }
×
757

758
                s.htlcSwitch.UpdateLinkAliases(link)
3✔
759

3✔
760
                return nil
3✔
761
        }
762

763
        s.aliasMgr, err = aliasmgr.NewManager(dbs.ChanStateDB, linkUpdater)
3✔
764
        if err != nil {
3✔
765
                return nil, err
×
766
        }
×
767

768
        s.htlcSwitch, err = htlcswitch.New(htlcswitch.Config{
3✔
769
                DB:                   dbs.ChanStateDB,
3✔
770
                FetchAllOpenChannels: s.chanStateDB.FetchAllOpenChannels,
3✔
771
                FetchAllChannels:     s.chanStateDB.FetchAllChannels,
3✔
772
                FetchClosedChannels:  s.chanStateDB.FetchClosedChannels,
3✔
773
                LocalChannelClose: func(pubKey []byte,
3✔
774
                        request *htlcswitch.ChanClose) {
6✔
775

3✔
776
                        peer, err := s.FindPeerByPubStr(string(pubKey))
3✔
777
                        if err != nil {
3✔
778
                                srvrLog.Errorf("unable to close channel, peer"+
×
779
                                        " with %v id can't be found: %v",
×
780
                                        pubKey, err,
×
781
                                )
×
782
                                return
×
783
                        }
×
784

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

820
        s.witnessBeacon = newPreimageBeacon(
3✔
821
                dbs.ChanStateDB.NewWitnessCache(),
3✔
822
                s.interceptableSwitch.ForwardPacket,
3✔
823
        )
3✔
824

3✔
825
        chanStatusMgrCfg := &netann.ChanStatusConfig{
3✔
826
                ChanStatusSampleInterval: cfg.ChanStatusSampleInterval,
3✔
827
                ChanEnableTimeout:        cfg.ChanEnableTimeout,
3✔
828
                ChanDisableTimeout:       cfg.ChanDisableTimeout,
3✔
829
                OurPubKey:                nodeKeyDesc.PubKey,
3✔
830
                OurKeyLoc:                nodeKeyDesc.KeyLocator,
3✔
831
                MessageSigner:            s.nodeSigner,
3✔
832
                IsChannelActive:          s.htlcSwitch.HasActiveLink,
3✔
833
                ApplyChannelUpdate:       s.applyChannelUpdate,
3✔
834
                DB:                       s.chanStateDB,
3✔
835
                Graph:                    dbs.GraphDB,
3✔
836
        }
3✔
837

3✔
838
        chanStatusMgr, err := netann.NewChanStatusManager(chanStatusMgrCfg)
3✔
839
        if err != nil {
3✔
840
                return nil, err
×
841
        }
×
842
        s.chanStatusMgr = chanStatusMgr
3✔
843

3✔
844
        // If enabled, use either UPnP or NAT-PMP to automatically configure
3✔
845
        // port forwarding for users behind a NAT.
3✔
846
        if cfg.NAT {
3✔
847
                srvrLog.Info("Scanning local network for a UPnP enabled device")
×
848

×
849
                discoveryTimeout := time.Duration(10 * time.Second)
×
850

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

×
865
                        srvrLog.Info("Scanning local network for a NAT-PMP " +
×
866
                                "enabled device")
×
867

×
868
                        pmp, err := nat.DiscoverPMP(discoveryTimeout)
×
869
                        if err != nil {
×
870
                                err := fmt.Errorf("unable to discover a "+
×
871
                                        "NAT-PMP enabled device on the local "+
×
872
                                        "network: %v", err)
×
873
                                srvrLog.Error(err)
×
874
                                return nil, err
×
875
                        }
×
876

877
                        s.natTraversal = pmp
×
878
                }
879
        }
880

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

×
896
                        listenPorts = append(listenPorts, uint16(port))
×
897
                }
×
898

899
                ips, err := s.configurePortForwarding(listenPorts...)
×
900
                if err != nil {
×
901
                        srvrLog.Errorf("Unable to automatically set up port "+
×
902
                                "forwarding using %s: %v",
×
903
                                s.natTraversal.Name(), err)
×
904
                } else {
×
905
                        srvrLog.Infof("Automatically set up port forwarding "+
×
906
                                "using %s to advertise external IP",
×
907
                                s.natTraversal.Name())
×
908
                        externalIPStrings = append(externalIPStrings, ips...)
×
909
                }
×
910
        }
911

912
        // If external IP addresses have been specified, add those to the list
913
        // of this server's addresses.
914
        externalIPs, err := lncfg.NormalizeAddresses(
3✔
915
                externalIPStrings, strconv.Itoa(defaultPeerPort),
3✔
916
                cfg.net.ResolveTCPAddr,
3✔
917
        )
3✔
918
        if err != nil {
3✔
919
                return nil, err
×
920
        }
×
921

922
        selfAddrs := make([]net.Addr, 0, len(externalIPs))
3✔
923
        selfAddrs = append(selfAddrs, externalIPs...)
3✔
924

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

936
        // If no alias is provided, default to first 10 characters of public
937
        // key.
938
        alias := cfg.Alias
3✔
939
        if alias == "" {
6✔
940
                alias = hex.EncodeToString(serializedPubKey[:10])
3✔
941
        }
3✔
942
        nodeAlias, err := lnwire.NewNodeAlias(alias)
3✔
943
        if err != nil {
3✔
944
                return nil, err
×
945
        }
×
946
        selfNode := &models.LightningNode{
3✔
947
                HaveNodeAnnouncement: true,
3✔
948
                LastUpdate:           time.Now(),
3✔
949
                Addresses:            selfAddrs,
3✔
950
                Alias:                nodeAlias.String(),
3✔
951
                Features:             s.featureMgr.Get(feature.SetNodeAnn),
3✔
952
                Color:                color,
3✔
953
        }
3✔
954
        copy(selfNode.PubKeyBytes[:], nodeKeyDesc.PubKey.SerializeCompressed())
3✔
955

3✔
956
        // Based on the disk representation of the node announcement generated
3✔
957
        // above, we'll generate a node announcement that can go out on the
3✔
958
        // network so we can properly sign it.
3✔
959
        nodeAnn, err := selfNode.NodeAnnouncement(false)
3✔
960
        if err != nil {
3✔
961
                return nil, fmt.Errorf("unable to gen self node ann: %w", err)
×
962
        }
×
963

964
        // With the announcement generated, we'll sign it to properly
965
        // authenticate the message on the network.
966
        authSig, err := netann.SignAnnouncement(
3✔
967
                s.nodeSigner, nodeKeyDesc.KeyLocator, nodeAnn,
3✔
968
        )
3✔
969
        if err != nil {
3✔
970
                return nil, fmt.Errorf("unable to generate signature for "+
×
971
                        "self node announcement: %v", err)
×
972
        }
×
973
        selfNode.AuthSigBytes = authSig.Serialize()
3✔
974
        nodeAnn.Signature, err = lnwire.NewSigFromECDSARawSignature(
3✔
975
                selfNode.AuthSigBytes,
3✔
976
        )
3✔
977
        if err != nil {
3✔
978
                return nil, err
×
979
        }
×
980

981
        // Finally, we'll update the representation on disk, and update our
982
        // cached in-memory version as well.
983
        if err := dbs.GraphDB.SetSourceNode(selfNode); err != nil {
3✔
984
                return nil, fmt.Errorf("can't set self node: %w", err)
×
985
        }
×
986
        s.currentNodeAnn = nodeAnn
3✔
987

3✔
988
        // The router will get access to the payment ID sequencer, such that it
3✔
989
        // can generate unique payment IDs.
3✔
990
        sequencer, err := htlcswitch.NewPersistentSequencer(dbs.ChanStateDB)
3✔
991
        if err != nil {
3✔
992
                return nil, err
×
993
        }
×
994

995
        // Instantiate mission control with config from the sub server.
996
        //
997
        // TODO(joostjager): When we are further in the process of moving to sub
998
        // servers, the mission control instance itself can be moved there too.
999
        routingConfig := routerrpc.GetRoutingConfig(cfg.SubRPCServers.RouterRPC)
3✔
1000

3✔
1001
        // We only initialize a probability estimator if there's no custom one.
3✔
1002
        var estimator routing.Estimator
3✔
1003
        if cfg.Estimator != nil {
3✔
1004
                estimator = cfg.Estimator
×
1005
        } else {
3✔
1006
                switch routingConfig.ProbabilityEstimatorType {
3✔
1007
                case routing.AprioriEstimatorName:
3✔
1008
                        aCfg := routingConfig.AprioriConfig
3✔
1009
                        aprioriConfig := routing.AprioriConfig{
3✔
1010
                                AprioriHopProbability: aCfg.HopProbability,
3✔
1011
                                PenaltyHalfLife:       aCfg.PenaltyHalfLife,
3✔
1012
                                AprioriWeight:         aCfg.Weight,
3✔
1013
                                CapacityFraction:      aCfg.CapacityFraction,
3✔
1014
                        }
3✔
1015

3✔
1016
                        estimator, err = routing.NewAprioriEstimator(
3✔
1017
                                aprioriConfig,
3✔
1018
                        )
3✔
1019
                        if err != nil {
3✔
1020
                                return nil, err
×
1021
                        }
×
1022

1023
                case routing.BimodalEstimatorName:
×
1024
                        bCfg := routingConfig.BimodalConfig
×
1025
                        bimodalConfig := routing.BimodalConfig{
×
1026
                                BimodalNodeWeight: bCfg.NodeWeight,
×
1027
                                BimodalScaleMsat: lnwire.MilliSatoshi(
×
1028
                                        bCfg.Scale,
×
1029
                                ),
×
1030
                                BimodalDecayTime: bCfg.DecayTime,
×
1031
                        }
×
1032

×
1033
                        estimator, err = routing.NewBimodalEstimator(
×
1034
                                bimodalConfig,
×
1035
                        )
×
1036
                        if err != nil {
×
1037
                                return nil, err
×
1038
                        }
×
1039

1040
                default:
×
1041
                        return nil, fmt.Errorf("unknown estimator type %v",
×
1042
                                routingConfig.ProbabilityEstimatorType)
×
1043
                }
1044
        }
1045

1046
        mcCfg := &routing.MissionControlConfig{
3✔
1047
                OnConfigUpdate:          fn.Some(s.UpdateRoutingConfig),
3✔
1048
                Estimator:               estimator,
3✔
1049
                MaxMcHistory:            routingConfig.MaxMcHistory,
3✔
1050
                McFlushInterval:         routingConfig.McFlushInterval,
3✔
1051
                MinFailureRelaxInterval: routing.DefaultMinFailureRelaxInterval,
3✔
1052
        }
3✔
1053

3✔
1054
        s.missionController, err = routing.NewMissionController(
3✔
1055
                dbs.ChanStateDB, selfNode.PubKeyBytes, mcCfg,
3✔
1056
        )
3✔
1057
        if err != nil {
3✔
1058
                return nil, fmt.Errorf("can't create mission control "+
×
1059
                        "manager: %w", err)
×
1060
        }
×
1061
        s.defaultMC, err = s.missionController.GetNamespacedStore(
3✔
1062
                routing.DefaultMissionControlNamespace,
3✔
1063
        )
3✔
1064
        if err != nil {
3✔
1065
                return nil, fmt.Errorf("can't create mission control in the "+
×
1066
                        "default namespace: %w", err)
×
1067
        }
×
1068

1069
        srvrLog.Debugf("Instantiating payment session source with config: "+
3✔
1070
                "AttemptCost=%v + %v%%, MinRouteProbability=%v",
3✔
1071
                int64(routingConfig.AttemptCost),
3✔
1072
                float64(routingConfig.AttemptCostPPM)/10000,
3✔
1073
                routingConfig.MinRouteProbability)
3✔
1074

3✔
1075
        pathFindingConfig := routing.PathFindingConfig{
3✔
1076
                AttemptCost: lnwire.NewMSatFromSatoshis(
3✔
1077
                        routingConfig.AttemptCost,
3✔
1078
                ),
3✔
1079
                AttemptCostPPM: routingConfig.AttemptCostPPM,
3✔
1080
                MinProbability: routingConfig.MinRouteProbability,
3✔
1081
        }
3✔
1082

3✔
1083
        sourceNode, err := dbs.GraphDB.SourceNode()
3✔
1084
        if err != nil {
3✔
1085
                return nil, fmt.Errorf("error getting source node: %w", err)
×
1086
        }
×
1087
        paymentSessionSource := &routing.SessionSource{
3✔
1088
                GraphSessionFactory: dbs.GraphDB,
3✔
1089
                SourceNode:          sourceNode,
3✔
1090
                MissionControl:      s.defaultMC,
3✔
1091
                GetLink:             s.htlcSwitch.GetLinkByShortID,
3✔
1092
                PathFindingConfig:   pathFindingConfig,
3✔
1093
        }
3✔
1094

3✔
1095
        paymentControl := channeldb.NewPaymentControl(dbs.ChanStateDB)
3✔
1096

3✔
1097
        s.controlTower = routing.NewControlTower(paymentControl)
3✔
1098

3✔
1099
        strictPruning := cfg.Bitcoin.Node == "neutrino" ||
3✔
1100
                cfg.Routing.StrictZombiePruning
3✔
1101

3✔
1102
        s.graphBuilder, err = graph.NewBuilder(&graph.Config{
3✔
1103
                SelfNode:            selfNode.PubKeyBytes,
3✔
1104
                Graph:               dbs.GraphDB,
3✔
1105
                Chain:               cc.ChainIO,
3✔
1106
                ChainView:           cc.ChainView,
3✔
1107
                Notifier:            cc.ChainNotifier,
3✔
1108
                ChannelPruneExpiry:  graph.DefaultChannelPruneExpiry,
3✔
1109
                GraphPruneInterval:  time.Hour,
3✔
1110
                FirstTimePruneDelay: graph.DefaultFirstTimePruneDelay,
3✔
1111
                AssumeChannelValid:  cfg.Routing.AssumeChannelValid,
3✔
1112
                StrictZombiePruning: strictPruning,
3✔
1113
                IsAlias:             aliasmgr.IsAlias,
3✔
1114
        })
3✔
1115
        if err != nil {
3✔
1116
                return nil, fmt.Errorf("can't create graph builder: %w", err)
×
1117
        }
×
1118

1119
        s.chanRouter, err = routing.New(routing.Config{
3✔
1120
                SelfNode:           selfNode.PubKeyBytes,
3✔
1121
                RoutingGraph:       dbs.GraphDB,
3✔
1122
                Chain:              cc.ChainIO,
3✔
1123
                Payer:              s.htlcSwitch,
3✔
1124
                Control:            s.controlTower,
3✔
1125
                MissionControl:     s.defaultMC,
3✔
1126
                SessionSource:      paymentSessionSource,
3✔
1127
                GetLink:            s.htlcSwitch.GetLinkByShortID,
3✔
1128
                NextPaymentID:      sequencer.NextID,
3✔
1129
                PathFindingConfig:  pathFindingConfig,
3✔
1130
                Clock:              clock.NewDefaultClock(),
3✔
1131
                ApplyChannelUpdate: s.graphBuilder.ApplyChannelUpdate,
3✔
1132
                ClosedSCIDs:        s.fetchClosedChannelSCIDs(),
3✔
1133
                TrafficShaper:      implCfg.TrafficShaper,
3✔
1134
        })
3✔
1135
        if err != nil {
3✔
1136
                return nil, fmt.Errorf("can't create router: %w", err)
×
1137
        }
×
1138

1139
        chanSeries := discovery.NewChanSeries(s.graphDB)
3✔
1140
        gossipMessageStore, err := discovery.NewMessageStore(dbs.ChanStateDB)
3✔
1141
        if err != nil {
3✔
1142
                return nil, err
×
1143
        }
×
1144
        waitingProofStore, err := channeldb.NewWaitingProofStore(dbs.ChanStateDB)
3✔
1145
        if err != nil {
3✔
1146
                return nil, err
×
1147
        }
×
1148

1149
        scidCloserMan := discovery.NewScidCloserMan(s.graphDB, s.chanStateDB)
3✔
1150

3✔
1151
        s.authGossiper = discovery.New(discovery.Config{
3✔
1152
                Graph:                 s.graphBuilder,
3✔
1153
                ChainIO:               s.cc.ChainIO,
3✔
1154
                Notifier:              s.cc.ChainNotifier,
3✔
1155
                ChainHash:             *s.cfg.ActiveNetParams.GenesisHash,
3✔
1156
                Broadcast:             s.BroadcastMessage,
3✔
1157
                ChanSeries:            chanSeries,
3✔
1158
                NotifyWhenOnline:      s.NotifyWhenOnline,
3✔
1159
                NotifyWhenOffline:     s.NotifyWhenOffline,
3✔
1160
                FetchSelfAnnouncement: s.getNodeAnnouncement,
3✔
1161
                UpdateSelfAnnouncement: func() (lnwire.NodeAnnouncement,
3✔
1162
                        error) {
3✔
1163

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

1193
        accessCfg := &accessManConfig{
3✔
1194
                initAccessPerms: func() (map[string]channeldb.ChanCount,
3✔
1195
                        error) {
6✔
1196

3✔
1197
                        genesisHash := *s.cfg.ActiveNetParams.GenesisHash
3✔
1198
                        return s.chanStateDB.FetchPermAndTempPeers(
3✔
1199
                                genesisHash[:],
3✔
1200
                        )
3✔
1201
                },
3✔
1202
                shouldDisconnect:   s.authGossiper.ShouldDisconnect,
1203
                maxRestrictedSlots: int64(s.cfg.NumRestrictedSlots),
1204
        }
1205

1206
        peerAccessMan, err := newAccessMan(accessCfg)
3✔
1207
        if err != nil {
3✔
1208
                return nil, err
×
1209
        }
×
1210

1211
        s.peerAccessMan = peerAccessMan
3✔
1212

3✔
1213
        selfVertex := route.Vertex(nodeKeyDesc.PubKey.SerializeCompressed())
3✔
1214
        //nolint:ll
3✔
1215
        s.localChanMgr = &localchans.Manager{
3✔
1216
                SelfPub:              nodeKeyDesc.PubKey,
3✔
1217
                DefaultRoutingPolicy: cc.RoutingPolicy,
3✔
1218
                ForAllOutgoingChannels: func(cb func(*models.ChannelEdgeInfo,
3✔
1219
                        *models.ChannelEdgePolicy) error) error {
6✔
1220

3✔
1221
                        return s.graphDB.ForEachNodeChannel(selfVertex,
3✔
1222
                                func(_ kvdb.RTx, c *models.ChannelEdgeInfo,
3✔
1223
                                        e *models.ChannelEdgePolicy,
3✔
1224
                                        _ *models.ChannelEdgePolicy) error {
6✔
1225

3✔
1226
                                        // NOTE: The invoked callback here may
3✔
1227
                                        // receive a nil channel policy.
3✔
1228
                                        return cb(c, e)
3✔
1229
                                },
3✔
1230
                        )
1231
                },
1232
                PropagateChanPolicyUpdate: s.authGossiper.PropagateChanPolicyUpdate,
1233
                UpdateForwardingPolicies:  s.htlcSwitch.UpdateForwardingPolicies,
1234
                FetchChannel:              s.chanStateDB.FetchChannel,
1235
                AddEdge: func(edge *models.ChannelEdgeInfo) error {
×
1236
                        return s.graphBuilder.AddEdge(edge)
×
1237
                },
×
1238
        }
1239

1240
        utxnStore, err := contractcourt.NewNurseryStore(
3✔
1241
                s.cfg.ActiveNetParams.GenesisHash, dbs.ChanStateDB,
3✔
1242
        )
3✔
1243
        if err != nil {
3✔
1244
                srvrLog.Errorf("unable to create nursery store: %v", err)
×
1245
                return nil, err
×
1246
        }
×
1247

1248
        sweeperStore, err := sweep.NewSweeperStore(
3✔
1249
                dbs.ChanStateDB, s.cfg.ActiveNetParams.GenesisHash,
3✔
1250
        )
3✔
1251
        if err != nil {
3✔
1252
                srvrLog.Errorf("unable to create sweeper store: %v", err)
×
1253
                return nil, err
×
1254
        }
×
1255

1256
        aggregator := sweep.NewBudgetAggregator(
3✔
1257
                cc.FeeEstimator, sweep.DefaultMaxInputsPerTx,
3✔
1258
                s.implCfg.AuxSweeper,
3✔
1259
        )
3✔
1260

3✔
1261
        s.txPublisher = sweep.NewTxPublisher(sweep.TxPublisherConfig{
3✔
1262
                Signer:     cc.Wallet.Cfg.Signer,
3✔
1263
                Wallet:     cc.Wallet,
3✔
1264
                Estimator:  cc.FeeEstimator,
3✔
1265
                Notifier:   cc.ChainNotifier,
3✔
1266
                AuxSweeper: s.implCfg.AuxSweeper,
3✔
1267
        })
3✔
1268

3✔
1269
        s.sweeper = sweep.New(&sweep.UtxoSweeperConfig{
3✔
1270
                FeeEstimator: cc.FeeEstimator,
3✔
1271
                GenSweepScript: newSweepPkScriptGen(
3✔
1272
                        cc.Wallet, s.cfg.ActiveNetParams.Params,
3✔
1273
                ),
3✔
1274
                Signer:               cc.Wallet.Cfg.Signer,
3✔
1275
                Wallet:               newSweeperWallet(cc.Wallet),
3✔
1276
                Mempool:              cc.MempoolNotifier,
3✔
1277
                Notifier:             cc.ChainNotifier,
3✔
1278
                Store:                sweeperStore,
3✔
1279
                MaxInputsPerTx:       sweep.DefaultMaxInputsPerTx,
3✔
1280
                MaxFeeRate:           cfg.Sweeper.MaxFeeRate,
3✔
1281
                Aggregator:           aggregator,
3✔
1282
                Publisher:            s.txPublisher,
3✔
1283
                NoDeadlineConfTarget: cfg.Sweeper.NoDeadlineConfTarget,
3✔
1284
        })
3✔
1285

3✔
1286
        s.utxoNursery = contractcourt.NewUtxoNursery(&contractcourt.NurseryConfig{
3✔
1287
                ChainIO:             cc.ChainIO,
3✔
1288
                ConfDepth:           1,
3✔
1289
                FetchClosedChannels: s.chanStateDB.FetchClosedChannels,
3✔
1290
                FetchClosedChannel:  s.chanStateDB.FetchClosedChannel,
3✔
1291
                Notifier:            cc.ChainNotifier,
3✔
1292
                PublishTransaction:  cc.Wallet.PublishTransaction,
3✔
1293
                Store:               utxnStore,
3✔
1294
                SweepInput:          s.sweeper.SweepInput,
3✔
1295
                Budget:              s.cfg.Sweeper.Budget,
3✔
1296
        })
3✔
1297

3✔
1298
        // Construct a closure that wraps the htlcswitch's CloseLink method.
3✔
1299
        closeLink := func(chanPoint *wire.OutPoint,
3✔
1300
                closureType contractcourt.ChannelCloseType) {
6✔
1301
                // TODO(conner): Properly respect the update and error channels
3✔
1302
                // returned by CloseLink.
3✔
1303

3✔
1304
                // Instruct the switch to close the channel.  Provide no close out
3✔
1305
                // delivery script or target fee per kw because user input is not
3✔
1306
                // available when the remote peer closes the channel.
3✔
1307
                s.htlcSwitch.CloseLink(
3✔
1308
                        context.Background(), chanPoint, closureType, 0, 0, nil,
3✔
1309
                )
3✔
1310
        }
3✔
1311

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

3✔
1316
        s.breachArbitrator = contractcourt.NewBreachArbitrator(
3✔
1317
                &contractcourt.BreachConfig{
3✔
1318
                        CloseLink: closeLink,
3✔
1319
                        DB:        s.chanStateDB,
3✔
1320
                        Estimator: s.cc.FeeEstimator,
3✔
1321
                        GenSweepScript: newSweepPkScriptGen(
3✔
1322
                                cc.Wallet, s.cfg.ActiveNetParams.Params,
3✔
1323
                        ),
3✔
1324
                        Notifier:           cc.ChainNotifier,
3✔
1325
                        PublishTransaction: cc.Wallet.PublishTransaction,
3✔
1326
                        ContractBreaches:   contractBreaches,
3✔
1327
                        Signer:             cc.Wallet.Cfg.Signer,
3✔
1328
                        Store: contractcourt.NewRetributionStore(
3✔
1329
                                dbs.ChanStateDB,
3✔
1330
                        ),
3✔
1331
                        AuxSweeper: s.implCfg.AuxSweeper,
3✔
1332
                },
3✔
1333
        )
3✔
1334

3✔
1335
        //nolint:ll
3✔
1336
        s.chainArb = contractcourt.NewChainArbitrator(contractcourt.ChainArbitratorConfig{
3✔
1337
                ChainHash:              *s.cfg.ActiveNetParams.GenesisHash,
3✔
1338
                IncomingBroadcastDelta: lncfg.DefaultIncomingBroadcastDelta,
3✔
1339
                OutgoingBroadcastDelta: lncfg.DefaultOutgoingBroadcastDelta,
3✔
1340
                NewSweepAddr: func() ([]byte, error) {
3✔
1341
                        addr, err := newSweepPkScriptGen(
×
1342
                                cc.Wallet, netParams,
×
1343
                        )().Unpack()
×
1344
                        if err != nil {
×
1345
                                return nil, err
×
1346
                        }
×
1347

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

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

3✔
1386
                        // processACK will handle the BreachArbitrator ACKing
3✔
1387
                        // the event.
3✔
1388
                        finalErr := make(chan error, 1)
3✔
1389
                        processACK := func(brarErr error) {
6✔
1390
                                if brarErr != nil {
3✔
1391
                                        finalErr <- brarErr
×
1392
                                        return
×
1393
                                }
×
1394

1395
                                // If the BreachArbitrator successfully handled
1396
                                // the event, we can signal that the handoff
1397
                                // was successful.
1398
                                finalErr <- nil
3✔
1399
                        }
1400

1401
                        event := &contractcourt.ContractBreachEvent{
3✔
1402
                                ChanPoint:         chanPoint,
3✔
1403
                                ProcessACK:        processACK,
3✔
1404
                                BreachRetribution: breachRet,
3✔
1405
                        }
3✔
1406

3✔
1407
                        // Send the contract breach event to the
3✔
1408
                        // BreachArbitrator.
3✔
1409
                        select {
3✔
1410
                        case contractBreaches <- event:
3✔
1411
                        case <-s.quit:
×
1412
                                return ErrServerShuttingDown
×
1413
                        }
1414

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

1440
                // TODO(yy): remove this hack once PaymentCircuit is interfaced.
1441
                QueryIncomingCircuit: func(
1442
                        circuit models.CircuitKey) *models.CircuitKey {
3✔
1443

3✔
1444
                        // Get the circuit map.
3✔
1445
                        circuits := s.htlcSwitch.CircuitLookup()
3✔
1446

3✔
1447
                        // Lookup the outgoing circuit.
3✔
1448
                        pc := circuits.LookupOpenCircuit(circuit)
3✔
1449
                        if pc == nil {
5✔
1450
                                return nil
2✔
1451
                        }
2✔
1452

1453
                        return &pc.Incoming
3✔
1454
                },
1455
                AuxLeafStore: implCfg.AuxLeafStore,
1456
                AuxSigner:    implCfg.AuxSigner,
1457
                AuxResolver:  implCfg.AuxContractResolver,
1458
        }, dbs.ChanStateDB)
1459

1460
        // Select the configuration and funding parameters for Bitcoin.
1461
        chainCfg := cfg.Bitcoin
3✔
1462
        minRemoteDelay := funding.MinBtcRemoteDelay
3✔
1463
        maxRemoteDelay := funding.MaxBtcRemoteDelay
3✔
1464

3✔
1465
        var chanIDSeed [32]byte
3✔
1466
        if _, err := rand.Read(chanIDSeed[:]); err != nil {
3✔
1467
                return nil, err
×
1468
        }
×
1469

1470
        // Wrap the DeleteChannelEdges method so that the funding manager can
1471
        // use it without depending on several layers of indirection.
1472
        deleteAliasEdge := func(scid lnwire.ShortChannelID) (
3✔
1473
                *models.ChannelEdgePolicy, error) {
6✔
1474

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

1488
                // Grab our key to find our policy.
1489
                var ourKey [33]byte
3✔
1490
                copy(ourKey[:], nodeKeyDesc.PubKey.SerializeCompressed())
3✔
1491

3✔
1492
                var ourPolicy *models.ChannelEdgePolicy
3✔
1493
                if info != nil && info.NodeKey1Bytes == ourKey {
6✔
1494
                        ourPolicy = e1
3✔
1495
                } else {
6✔
1496
                        ourPolicy = e2
3✔
1497
                }
3✔
1498

1499
                if ourPolicy == nil {
3✔
1500
                        // Something is wrong, so return an error.
×
1501
                        return nil, fmt.Errorf("we don't have an edge")
×
1502
                }
×
1503

1504
                err = s.graphDB.DeleteChannelEdges(
3✔
1505
                        false, false, scid.ToUint64(),
3✔
1506
                )
3✔
1507
                return ourPolicy, err
3✔
1508
        }
1509

1510
        // For the reservationTimeout and the zombieSweeperInterval different
1511
        // values are set in case we are in a dev environment so enhance test
1512
        // capacilities.
1513
        reservationTimeout := chanfunding.DefaultReservationTimeout
3✔
1514
        zombieSweeperInterval := lncfg.DefaultZombieSweeperInterval
3✔
1515

3✔
1516
        // Get the development config for funding manager. If we are not in
3✔
1517
        // development mode, this would be nil.
3✔
1518
        var devCfg *funding.DevConfig
3✔
1519
        if lncfg.IsDevBuild() {
6✔
1520
                devCfg = &funding.DevConfig{
3✔
1521
                        ProcessChannelReadyWait: cfg.Dev.ChannelReadyWait(),
3✔
1522
                        MaxWaitNumBlocksFundingConf: cfg.Dev.
3✔
1523
                                GetMaxWaitNumBlocksFundingConf(),
3✔
1524
                }
3✔
1525

3✔
1526
                reservationTimeout = cfg.Dev.GetReservationTimeout()
3✔
1527
                zombieSweeperInterval = cfg.Dev.GetZombieSweeperInterval()
3✔
1528

3✔
1529
                srvrLog.Debugf("Using the dev config for the fundingMgr: %v, "+
3✔
1530
                        "reservationTimeout=%v, zombieSweeperInterval=%v",
3✔
1531
                        devCfg, reservationTimeout, zombieSweeperInterval)
3✔
1532
        }
3✔
1533

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

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

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

1580
                        minConf := uint64(3)
×
1581
                        maxConf := uint64(6)
×
1582

×
1583
                        // If this is a wumbo channel, then we'll require the
×
1584
                        // max amount of confirmations.
×
1585
                        if chanAmt > MaxFundingAmount {
×
1586
                                return uint16(maxConf)
×
1587
                        }
×
1588

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

3✔
1611
                        // In case the user has explicitly specified
3✔
1612
                        // a default value for the remote delay, we
3✔
1613
                        // use it.
3✔
1614
                        defaultDelay := uint16(chainCfg.DefaultRemoteDelay)
3✔
1615
                        if defaultDelay > 0 {
6✔
1616
                                return defaultDelay
3✔
1617
                        }
3✔
1618

1619
                        // If this is a wumbo channel, then we'll require the
1620
                        // max value.
1621
                        if chanAmt > MaxFundingAmount {
×
1622
                                return maxRemoteDelay
×
1623
                        }
×
1624

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

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

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

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

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

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

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

1738
        // Assemble a peer notifier which will provide clients with subscriptions
1739
        // to peer online and offline events.
1740
        s.peerNotifier = peernotifier.New()
3✔
1741

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

1757
        if cfg.WtClient.Active {
6✔
1758
                policy := wtpolicy.DefaultPolicy()
3✔
1759
                policy.MaxUpdates = cfg.WtClient.MaxUpdates
3✔
1760

3✔
1761
                // We expose the sweep fee rate in sat/vbyte, but the tower
3✔
1762
                // protocol operations on sat/kw.
3✔
1763
                sweepRateSatPerVByte := chainfee.SatPerKVByte(
3✔
1764
                        1000 * cfg.WtClient.SweepFeeRate,
3✔
1765
                )
3✔
1766

3✔
1767
                policy.SweepFeeRate = sweepRateSatPerVByte.FeePerKWeight()
3✔
1768

3✔
1769
                if err := policy.Validate(); err != nil {
3✔
1770
                        return nil, err
×
1771
                }
×
1772

1773
                // authDial is the wrapper around the btrontide.Dial for the
1774
                // watchtower.
1775
                authDial := func(localKey keychain.SingleKeyECDH,
3✔
1776
                        netAddr *lnwire.NetAddress,
3✔
1777
                        dialer tor.DialFunc) (wtserver.Peer, error) {
6✔
1778

3✔
1779
                        return brontide.Dial(
3✔
1780
                                localKey, netAddr, cfg.ConnectionTimeout, dialer,
3✔
1781
                        )
3✔
1782
                }
3✔
1783

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

3✔
1791
                        channel, err := s.chanStateDB.FetchChannelByID(
3✔
1792
                                nil, chanID,
3✔
1793
                        )
3✔
1794
                        if err != nil {
3✔
1795
                                return nil, 0, err
×
1796
                        }
×
1797

1798
                        br, err := lnwallet.NewBreachRetribution(
3✔
1799
                                channel, commitHeight, 0, nil,
3✔
1800
                                implCfg.AuxLeafStore,
3✔
1801
                                implCfg.AuxContractResolver,
3✔
1802
                        )
3✔
1803
                        if err != nil {
3✔
1804
                                return nil, 0, err
×
1805
                        }
×
1806

1807
                        return br, channel.ChanType, nil
3✔
1808
                }
1809

1810
                fetchClosedChannel := s.chanStateDB.FetchClosedChannelForID
3✔
1811

3✔
1812
                // Copy the policy for legacy channels and set the blob flag
3✔
1813
                // signalling support for anchor channels.
3✔
1814
                anchorPolicy := policy
3✔
1815
                anchorPolicy.BlobType |= blob.Type(blob.FlagAnchorChannel)
3✔
1816

3✔
1817
                // Copy the policy for legacy channels and set the blob flag
3✔
1818
                // signalling support for taproot channels.
3✔
1819
                taprootPolicy := policy
3✔
1820
                taprootPolicy.TxPolicy.BlobType |= blob.Type(
3✔
1821
                        blob.FlagTaprootChannel,
3✔
1822
                )
3✔
1823

3✔
1824
                s.towerClientMgr, err = wtclient.NewManager(&wtclient.Config{
3✔
1825
                        FetchClosedChannel:     fetchClosedChannel,
3✔
1826
                        BuildBreachRetribution: buildBreachRetribution,
3✔
1827
                        SessionCloseRange:      cfg.WtClient.SessionCloseRange,
3✔
1828
                        ChainNotifier:          s.cc.ChainNotifier,
3✔
1829
                        SubscribeChannelEvents: func() (subscribe.Subscription,
3✔
1830
                                error) {
6✔
1831

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

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

1860
        if len(cfg.ExternalHosts) != 0 {
3✔
1861
                advertisedIPs := make(map[string]struct{})
×
1862
                for _, addr := range s.currentNodeAnn.Addresses {
×
1863
                        advertisedIPs[addr.String()] = struct{}{}
×
1864
                }
×
1865

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

×
1880
                                        return s.genNodeAnnouncement(
×
1881
                                                nil, modifier...,
×
1882
                                        )
×
1883
                                }),
×
1884
                })
1885
        }
1886

1887
        // Create liveness monitor.
1888
        s.createLivenessMonitor(cfg, cc, leaderElector)
3✔
1889

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

3✔
1896
                // RESOLVE: We are actually partially accepting inbound
3✔
1897
                // connection requests when we call NewListener.
3✔
1898
                listeners[i], err = brontide.NewListener(
3✔
1899
                        nodeKeyECDH, listenAddr.String(),
3✔
1900
                        s.peerAccessMan.checkIncomingConnBanScore,
3✔
1901
                )
3✔
1902
                if err != nil {
3✔
1903
                        return nil, err
×
1904
                }
×
1905
        }
1906

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

3✔
1925
        // Finally, register the subsystems in blockbeat.
3✔
1926
        s.registerBlockConsumers()
3✔
1927

3✔
1928
        return s, nil
3✔
1929
}
1930

1931
// UpdateRoutingConfig is a callback function to update the routing config
1932
// values in the main cfg.
1933
func (s *server) UpdateRoutingConfig(cfg *routing.MissionControlConfig) {
3✔
1934
        routerCfg := s.cfg.SubRPCServers.RouterRPC
3✔
1935

3✔
1936
        switch c := cfg.Estimator.Config().(type) {
3✔
1937
        case routing.AprioriConfig:
3✔
1938
                routerCfg.ProbabilityEstimatorType =
3✔
1939
                        routing.AprioriEstimatorName
3✔
1940

3✔
1941
                targetCfg := routerCfg.AprioriConfig
3✔
1942
                targetCfg.PenaltyHalfLife = c.PenaltyHalfLife
3✔
1943
                targetCfg.Weight = c.AprioriWeight
3✔
1944
                targetCfg.CapacityFraction = c.CapacityFraction
3✔
1945
                targetCfg.HopProbability = c.AprioriHopProbability
3✔
1946

1947
        case routing.BimodalConfig:
3✔
1948
                routerCfg.ProbabilityEstimatorType =
3✔
1949
                        routing.BimodalEstimatorName
3✔
1950

3✔
1951
                targetCfg := routerCfg.BimodalConfig
3✔
1952
                targetCfg.Scale = int64(c.BimodalScaleMsat)
3✔
1953
                targetCfg.NodeWeight = c.BimodalNodeWeight
3✔
1954
                targetCfg.DecayTime = c.BimodalDecayTime
3✔
1955
        }
1956

1957
        routerCfg.MaxMcHistory = cfg.MaxMcHistory
3✔
1958
}
1959

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

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

3✔
1985
        data, err := u.DataToSign()
3✔
1986
        if err != nil {
3✔
1987
                return nil, err
×
1988
        }
×
1989

1990
        return s.cc.MsgSigner.SignMessage(s.identityKeyLoc, data, true)
3✔
1991
}
1992

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

3✔
2006
        chainBackendAttempts := cfg.HealthChecks.ChainCheck.Attempts
3✔
2007
        if cfg.Bitcoin.Node == "nochainbackend" {
3✔
2008
                srvrLog.Info("Disabling chain backend checks for " +
×
2009
                        "nochainbackend mode")
×
2010

×
2011
                chainBackendAttempts = 0
×
2012
        }
×
2013

2014
        chainHealthCheck := healthcheck.NewObservation(
3✔
2015
                "chain backend",
3✔
2016
                cc.HealthCheck,
3✔
2017
                cfg.HealthChecks.ChainCheck.Interval,
3✔
2018
                cfg.HealthChecks.ChainCheck.Timeout,
3✔
2019
                cfg.HealthChecks.ChainCheck.Backoff,
3✔
2020
                chainBackendAttempts,
3✔
2021
        )
3✔
2022

3✔
2023
        diskCheck := healthcheck.NewObservation(
3✔
2024
                "disk space",
3✔
2025
                func() error {
3✔
2026
                        free, err := healthcheck.AvailableDiskSpaceRatio(
×
2027
                                cfg.LndDir,
×
2028
                        )
×
2029
                        if err != nil {
×
2030
                                return err
×
2031
                        }
×
2032

2033
                        // If we have more free space than we require,
2034
                        // we return a nil error.
2035
                        if free > cfg.HealthChecks.DiskCheck.RequiredRemaining {
×
2036
                                return nil
×
2037
                        }
×
2038

2039
                        return fmt.Errorf("require: %v free space, got: %v",
×
2040
                                cfg.HealthChecks.DiskCheck.RequiredRemaining,
×
2041
                                free)
×
2042
                },
2043
                cfg.HealthChecks.DiskCheck.Interval,
2044
                cfg.HealthChecks.DiskCheck.Timeout,
2045
                cfg.HealthChecks.DiskCheck.Backoff,
2046
                cfg.HealthChecks.DiskCheck.Attempts,
2047
        )
2048

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

2063
                        // If the certificate is not outdated, no error needs
2064
                        // to be returned
2065
                        return nil
×
2066
                },
2067
                cfg.HealthChecks.TLSCheck.Interval,
2068
                cfg.HealthChecks.TLSCheck.Timeout,
2069
                cfg.HealthChecks.TLSCheck.Backoff,
2070
                cfg.HealthChecks.TLSCheck.Attempts,
2071
        )
2072

2073
        checks := []*healthcheck.Observation{
3✔
2074
                chainHealthCheck, diskCheck, tlsHealthCheck,
3✔
2075
        }
3✔
2076

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

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

3✔
2103
                remoteSignerConnectionCheck := healthcheck.NewObservation(
3✔
2104
                        "remote signer connection",
3✔
2105
                        rpcwallet.HealthCheck(
3✔
2106
                                s.cfg.RemoteSigner,
3✔
2107

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

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

×
2139
                                leader, err := leaderElector.IsLeader(
×
2140
                                        timeoutCtx,
×
2141
                                )
×
2142
                                if err != nil {
×
2143
                                        return fmt.Errorf("unable to check if "+
×
2144
                                                "still leader: %v", err)
×
2145
                                }
×
2146

2147
                                if !leader {
×
2148
                                        srvrLog.Debug("Not the current leader")
×
2149
                                        return fmt.Errorf("not the current " +
×
2150
                                                "leader")
×
2151
                                }
×
2152

2153
                                return nil
×
2154
                        },
2155
                        cfg.HealthChecks.LeaderCheck.Interval,
2156
                        cfg.HealthChecks.LeaderCheck.Timeout,
2157
                        cfg.HealthChecks.LeaderCheck.Backoff,
2158
                        cfg.HealthChecks.LeaderCheck.Attempts,
2159
                )
2160

2161
                checks = append(checks, leaderCheck)
×
2162
        }
2163

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

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

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

2186
// add is used to add a cleanup function to be called when
2187
// the run function is executed.
2188
func (c cleaner) add(cleanup func() error) cleaner {
3✔
2189
        return append(c, cleanup)
3✔
2190
}
3✔
2191

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

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

3✔
2210
        cleanup := cleaner{}
3✔
2211

3✔
2212
        cleanup = cleanup.add(s.cc.ChainNotifier.Stop)
3✔
2213
        if err := s.cc.ChainNotifier.Start(); err != nil {
3✔
2214
                startErr = err
×
2215
        }
×
2216

2217
        if startErr != nil {
3✔
2218
                cleanup.run()
×
2219
        }
×
2220

2221
        return startErr
3✔
2222
}
2223

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

2236
        var startErr error
3✔
2237

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

3✔
2243
        s.start.Do(func() {
6✔
2244
                cleanup = cleanup.add(s.customMessageServer.Stop)
3✔
2245
                if err := s.customMessageServer.Start(); err != nil {
3✔
2246
                        startErr = err
×
2247
                        return
×
2248
                }
×
2249

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

2258
                if s.livenessMonitor != nil {
6✔
2259
                        cleanup = cleanup.add(s.livenessMonitor.Stop)
3✔
2260
                        if err := s.livenessMonitor.Start(); err != nil {
3✔
2261
                                startErr = err
×
2262
                                return
×
2263
                        }
×
2264
                }
2265

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

2277
                cleanup = cleanup.add(s.writePool.Stop)
3✔
2278
                if err := s.writePool.Start(); err != nil {
3✔
2279
                        startErr = err
×
2280
                        return
×
2281
                }
×
2282

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

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

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

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

2309
                cleanup = cleanup.add(s.htlcNotifier.Stop)
3✔
2310
                if err := s.htlcNotifier.Start(); err != nil {
3✔
2311
                        startErr = err
×
2312
                        return
×
2313
                }
×
2314

2315
                if s.towerClientMgr != nil {
6✔
2316
                        cleanup = cleanup.add(s.towerClientMgr.Stop)
3✔
2317
                        if err := s.towerClientMgr.Start(); err != nil {
3✔
2318
                                startErr = err
×
2319
                                return
×
2320
                        }
×
2321
                }
2322

2323
                cleanup = cleanup.add(s.txPublisher.Stop)
3✔
2324
                if err := s.txPublisher.Start(beat); err != nil {
3✔
2325
                        startErr = err
×
2326
                        return
×
2327
                }
×
2328

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

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

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

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

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

2362
                cleanup = cleanup.add(s.interceptableSwitch.Stop)
3✔
2363
                if err := s.interceptableSwitch.Start(); err != nil {
3✔
2364
                        startErr = err
×
2365
                        return
×
2366
                }
×
2367

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

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

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

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

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

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

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

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

2423
                cleanup.add(func() error {
3✔
2424
                        s.missionController.StopStoreTickers()
×
2425
                        return nil
×
2426
                })
×
2427
                s.missionController.RunStoreTickers()
3✔
2428

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

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

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

2478
                if s.natTraversal != nil {
3✔
2479
                        s.wg.Add(1)
×
2480
                        go s.watchExternalIP()
×
2481
                }
×
2482

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

2489
                // RESOLVE: s.connMgr.Start() is called here, but
2490
                // brontide.NewListener() is called in newServer. This means
2491
                // that we are actually listening and partially accepting
2492
                // inbound connections even before the connMgr starts.
2493
                s.connMgr.Start()
3✔
2494

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

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

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

2532
                // Subscribe to NodeAnnouncements that advertise new addresses
2533
                // our persistent peers.
2534
                if err := s.updatePersistentPeerAddrs(); err != nil {
3✔
2535
                        startErr = err
×
2536
                        return
×
2537
                }
×
2538

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

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

2563
                        result := make([][2]string, len(tuples))
×
2564
                        for idx, tuple := range tuples {
×
2565
                                tuple = strings.TrimSpace(tuple)
×
2566
                                if len(tuple) == 0 {
×
2567
                                        return
×
2568
                                }
×
2569

2570
                                servers := strings.Split(tuple, ",")
×
2571
                                if len(servers) > 2 || len(servers) == 0 {
×
2572
                                        srvrLog.Warnf("Ignoring invalid DNS "+
×
2573
                                                "seed tuple: %v", servers)
×
2574
                                        return
×
2575
                                }
×
2576

2577
                                copy(result[idx][:], servers)
×
2578
                        }
2579

2580
                        chainreg.ChainDNSSeeds[genesisHash] = result
×
2581
                }
2582

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

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

2615
                        s.wg.Add(1)
×
2616
                        go s.peerBootstrapper(defaultMinPeers, bootstrappers)
×
2617
                } else {
3✔
2618
                        srvrLog.Infof("Auto peer bootstrapping is disabled")
3✔
2619
                }
3✔
2620

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

2632
                // Set the active flag now that we've completed the full
2633
                // startup.
2634
                atomic.StoreInt32(&s.active, 1)
3✔
2635
        })
2636

2637
        if startErr != nil {
3✔
2638
                cleanup.run()
×
2639
        }
×
2640
        return startErr
3✔
2641
}
2642

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

3✔
2651
                close(s.quit)
3✔
2652

3✔
2653
                // Shutdown connMgr first to prevent conns during shutdown.
3✔
2654
                s.connMgr.Stop()
3✔
2655

3✔
2656
                // Stop dispatching blocks to other systems immediately.
3✔
2657
                s.blockbeatDispatcher.Stop()
3✔
2658

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

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

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

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

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

2773
                if s.hostAnn != nil {
3✔
2774
                        if err := s.hostAnn.Stop(); err != nil {
×
2775
                                srvrLog.Warnf("unable to shut down host "+
×
2776
                                        "annoucner: %v", err)
×
2777
                        }
×
2778
                }
2779

2780
                if s.livenessMonitor != nil {
6✔
2781
                        if err := s.livenessMonitor.Stop(); err != nil {
3✔
2782
                                srvrLog.Warnf("unable to shutdown liveness "+
×
2783
                                        "monitor: %v", err)
×
2784
                        }
×
2785
                }
2786

2787
                // Wait for all lingering goroutines to quit.
2788
                srvrLog.Debug("Waiting for server to shutdown...")
3✔
2789
                s.wg.Wait()
3✔
2790

3✔
2791
                srvrLog.Debug("Stopping buffer pools...")
3✔
2792
                s.sigPool.Stop()
3✔
2793
                s.writePool.Stop()
3✔
2794
                s.readPool.Stop()
3✔
2795
        })
2796

2797
        return nil
3✔
2798
}
2799

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

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

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

2825
                hostIP := fmt.Sprintf("%v:%d", ip, port)
×
2826
                externalIPs = append(externalIPs, hostIP)
×
2827
        }
2828

2829
        return externalIPs, nil
×
2830
}
2831

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

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

×
2856
        // Before exiting, we'll make sure to remove the forwarding rules set
×
2857
        // up by the server.
×
2858
        defer s.removePortForwarding()
×
2859

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

2867
        forwardedPorts := s.natTraversal.ForwardedPorts()
×
2868

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

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

2899
                        if ip.Equal(s.lastDetectedIP) {
×
2900
                                continue
×
2901
                        }
2902

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

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

2920
                                newAddrs = append(newAddrs, addr)
×
2921
                        }
2922

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

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

×
2939
                        for _, addr := range currentNodeAnn.Addresses {
×
2940
                                host, _, err := net.SplitHostPort(addr.String())
×
2941
                                if err != nil {
×
2942
                                        srvrLog.Debugf("Unable to determine "+
×
2943
                                                "host from address %v: %v",
×
2944
                                                addr, err)
×
2945
                                        continue
×
2946
                                }
2947

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

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

2968
                        err = s.BroadcastMessage(nil, &newNodeAnn)
×
2969
                        if err != nil {
×
2970
                                srvrLog.Debugf("Unable to broadcast new node "+
×
2971
                                        "announcement to peers: %v", err)
×
2972
                                continue
×
2973
                        }
2974

2975
                        // Finally, update the last IP seen to the current one.
2976
                        s.lastDetectedIP = ip
×
2977
                case <-s.quit:
×
2978
                        break out
×
2979
                }
2980
        }
2981
}
2982

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

×
2989
        var bootStrappers []discovery.NetworkPeerBootstrapper
×
2990

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

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

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

×
3012
                        dnsBootStrapper := discovery.NewDNSSeedBootstrapper(
×
3013
                                dnsSeeds, s.cfg.net, s.cfg.ConnectionTimeout,
×
3014
                        )
×
3015
                        bootStrappers = append(bootStrappers, dnsBootStrapper)
×
3016
                }
×
3017
        }
3018

3019
        return bootStrappers, nil
×
3020
}
3021

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

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

×
3034
        // We should ignore ourselves from bootstrapping.
×
3035
        selfKey := autopilot.NewNodeID(s.identityECDH.PubKey())
×
3036
        ignore[selfKey] = struct{}{}
×
3037

×
3038
        // Ignore all connected peers.
×
3039
        for _, peer := range s.peersByPub {
×
3040
                nID := autopilot.NewNodeID(peer.IdentityKey())
×
3041
                ignore[nID] = struct{}{}
×
3042
        }
×
3043

3044
        // Ignore all persistent peers as they have a dedicated reconnecting
3045
        // process.
3046
        for pubKeyStr := range s.persistentPeers {
×
3047
                var nID autopilot.NodeID
×
3048
                copy(nID[:], []byte(pubKeyStr))
×
3049
                ignore[nID] = struct{}{}
×
3050
        }
×
3051

3052
        return ignore
×
3053
}
3054

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

×
3063
        defer s.wg.Done()
×
3064

×
3065
        // Before we continue, init the ignore peers map.
×
3066
        ignoreList := s.createBootstrapIgnorePeers()
×
3067

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

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

×
3079
        // We'll create a new ticker to wake us up every 15 seconds so we can
×
3080
        // see if we've reached our minimum number of peers.
×
3081
        sampleTicker := time.NewTicker(backOff)
×
3082
        defer sampleTicker.Stop()
×
3083

×
3084
        // We'll use the number of attempts and errors to determine if we need
×
3085
        // to increase the time between discovery epochs.
×
3086
        var epochErrors uint32 // To be used atomically.
×
3087
        var epochAttempts uint32
×
3088

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

×
3100
                        // If we have enough peers, then we can loop back
×
3101
                        // around to the next round as we're done here.
×
3102
                        if numActivePeers >= numTargetPeers {
×
3103
                                continue
×
3104
                        }
3105

3106
                        // If all of our attempts failed during this last back
3107
                        // off period, then will increase our backoff to 5
3108
                        // minute ceiling to avoid an excessive number of
3109
                        // queries
3110
                        //
3111
                        // TODO(roasbeef): add reverse policy too?
3112

3113
                        if epochAttempts > 0 &&
×
3114
                                atomic.LoadUint32(&epochErrors) >= epochAttempts {
×
3115

×
3116
                                sampleTicker.Stop()
×
3117

×
3118
                                backOff *= 2
×
3119
                                if backOff > bootstrapBackOffCeiling {
×
3120
                                        backOff = bootstrapBackOffCeiling
×
3121
                                }
×
3122

3123
                                srvrLog.Debugf("Backing off peer bootstrapper to "+
×
3124
                                        "%v", backOff)
×
3125
                                sampleTicker = time.NewTicker(backOff)
×
3126
                                continue
×
3127
                        }
3128

3129
                        atomic.StoreUint32(&epochErrors, 0)
×
3130
                        epochAttempts = 0
×
3131

×
3132
                        // Since we know need more peers, we'll compute the
×
3133
                        // exact number we need to reach our threshold.
×
3134
                        numNeeded := numTargetPeers - numActivePeers
×
3135

×
3136
                        srvrLog.Debugf("Attempting to obtain %v more network "+
×
3137
                                "peers", numNeeded)
×
3138

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

×
3147
                        peerAddrs, err := discovery.MultiSourceBootstrap(
×
3148
                                ignoreList, numNeeded*2, bootstrappers...,
×
3149
                        )
×
3150
                        if err != nil {
×
3151
                                srvrLog.Errorf("Unable to retrieve bootstrap "+
×
3152
                                        "peers: %v", err)
×
3153
                                continue
×
3154
                        }
3155

3156
                        // Finally, we'll launch a new goroutine for each
3157
                        // prospective peer candidates.
3158
                        for _, addr := range peerAddrs {
×
3159
                                epochAttempts++
×
3160

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

3175
                                                srvrLog.Errorf("Unable to "+
×
3176
                                                        "connect to %v: %v",
×
3177
                                                        a, err)
×
3178
                                                atomic.AddUint32(&epochErrors, 1)
×
3179
                                        case <-s.quit:
×
3180
                                        }
3181
                                }(addr)
3182
                        }
3183
                case <-s.quit:
×
3184
                        return
×
3185
                }
3186
        }
3187
}
3188

3189
// bootstrapBackOffCeiling is the maximum amount of time we'll wait between
3190
// failed attempts to locate a set of bootstrap peers. We'll slowly double our
3191
// query back off each time we encounter a failure.
3192
const bootstrapBackOffCeiling = time.Minute * 5
3193

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

×
3201
        srvrLog.Debugf("Init bootstrap with targetPeers=%v, bootstrappers=%v, "+
×
3202
                "ignore=%v", numTargetPeers, len(bootstrappers), len(ignore))
×
3203

×
3204
        // We'll start off by waiting 2 seconds between failed attempts, then
×
3205
        // double each time we fail until we hit the bootstrapBackOffCeiling.
×
3206
        var delaySignal <-chan time.Time
×
3207
        delayTime := time.Second * 2
×
3208

×
3209
        // As want to be more aggressive, we'll use a lower back off celling
×
3210
        // then the main peer bootstrap logic.
×
3211
        backOffCeiling := bootstrapBackOffCeiling / 5
×
3212

×
3213
        for attempts := 0; ; attempts++ {
×
3214
                // Check if the server has been requested to shut down in order
×
3215
                // to prevent blocking.
×
3216
                if s.Stopped() {
×
3217
                        return
×
3218
                }
×
3219

3220
                // We can exit our aggressive initial peer bootstrapping stage
3221
                // if we've reached out target number of peers.
3222
                s.mu.RLock()
×
3223
                numActivePeers := uint32(len(s.peersByPub))
×
3224
                s.mu.RUnlock()
×
3225

×
3226
                if numActivePeers >= numTargetPeers {
×
3227
                        return
×
3228
                }
×
3229

3230
                if attempts > 0 {
×
3231
                        srvrLog.Debugf("Waiting %v before trying to locate "+
×
3232
                                "bootstrap peers (attempt #%v)", delayTime,
×
3233
                                attempts)
×
3234

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

3245
                        // After our delay, we'll double the time we wait up to
3246
                        // the max back off period.
3247
                        delayTime *= 2
×
3248
                        if delayTime > backOffCeiling {
×
3249
                                delayTime = backOffCeiling
×
3250
                        }
×
3251
                }
3252

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

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

×
3273
                                errChan := make(chan error, 1)
×
3274
                                go s.connectToPeer(
×
3275
                                        addr, errChan, s.cfg.ConnectionTimeout,
×
3276
                                )
×
3277

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

3301
                wg.Wait()
×
3302
        }
3303
}
3304

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

3317
        encrypter, err := lnencrypt.KeyRingEncrypter(s.cc.KeyRing)
×
3318
        if err != nil {
×
3319
                return err
×
3320
        }
×
3321

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

×
3334
        switch {
×
3335
        case s.cfg.Tor.V2:
×
3336
                onionCfg.Type = tor.V2
×
3337
        case s.cfg.Tor.V3:
×
3338
                onionCfg.Type = tor.V3
×
3339
        }
3340

3341
        addr, err := s.torController.AddOnion(onionCfg)
×
3342
        if err != nil {
×
3343
                return err
×
3344
        }
×
3345

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

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

3376
        return nil
×
3377
}
3378

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

3✔
3385
        nodeChans, err := s.chanStateDB.FetchOpenChannels(node)
3✔
3386
        if err != nil {
3✔
3387
                return nil, err
×
3388
        }
×
3389

3390
        for _, channel := range nodeChans {
6✔
3391
                if chanID.IsChanPoint(&channel.FundingOutpoint) {
6✔
3392
                        return channel, nil
3✔
3393
                }
3✔
3394
        }
3395

3396
        return nil, fmt.Errorf("unable to find channel")
3✔
3397
}
3398

3399
// getNodeAnnouncement fetches the current, fully signed node announcement.
3400
func (s *server) getNodeAnnouncement() lnwire.NodeAnnouncement {
3✔
3401
        s.mu.Lock()
3✔
3402
        defer s.mu.Unlock()
3✔
3403

3✔
3404
        return *s.currentNodeAnn
3✔
3405
}
3✔
3406

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

3✔
3413
        s.mu.Lock()
3✔
3414
        defer s.mu.Unlock()
3✔
3415

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

3427
                // If we could successfully update our feature manager, add
3428
                // an update modifier to include these new features to our
3429
                // set.
3430
                modifiers = append(
3✔
3431
                        modifiers, netann.NodeAnnSetFeatures(features),
3✔
3432
                )
3✔
3433
        }
3434

3435
        // Always update the timestamp when refreshing to ensure the update
3436
        // propagates.
3437
        modifiers = append(modifiers, netann.NodeAnnSetTimestamp)
3✔
3438

3✔
3439
        // Apply the requested changes to the node announcement.
3✔
3440
        for _, modifier := range modifiers {
6✔
3441
                modifier(s.currentNodeAnn)
3✔
3442
        }
3✔
3443

3444
        // Sign a new update after applying all of the passed modifiers.
3445
        err := netann.SignNodeAnnouncement(
3✔
3446
                s.nodeSigner, s.identityKeyLoc, s.currentNodeAnn,
3✔
3447
        )
3✔
3448
        if err != nil {
3✔
3449
                return lnwire.NodeAnnouncement{}, err
×
3450
        }
×
3451

3452
        return *s.currentNodeAnn, nil
3✔
3453
}
3454

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

3✔
3462
        newNodeAnn, err := s.genNodeAnnouncement(features, modifiers...)
3✔
3463
        if err != nil {
6✔
3464
                return fmt.Errorf("unable to generate new node "+
3✔
3465
                        "announcement: %v", err)
3✔
3466
        }
3✔
3467

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

3476
        selfNode.HaveNodeAnnouncement = true
3✔
3477
        selfNode.LastUpdate = time.Unix(int64(newNodeAnn.Timestamp), 0)
3✔
3478
        selfNode.Addresses = newNodeAnn.Addresses
3✔
3479
        selfNode.Alias = newNodeAnn.Alias.String()
3✔
3480
        selfNode.Features = s.featureMgr.Get(feature.SetNodeAnn)
3✔
3481
        selfNode.Color = newNodeAnn.RGBColor
3✔
3482
        selfNode.AuthSigBytes = newNodeAnn.Signature.ToSignatureBytes()
3✔
3483

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

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

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

3498
        return nil
3✔
3499
}
3500

3501
type nodeAddresses struct {
3502
        pubKey    *btcec.PublicKey
3503
        addresses []net.Addr
3504
}
3505

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

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

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

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

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

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

3567
                pubStr := string(channelPeer.PubKeyBytes[:])
3✔
3568

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

3578
                        // We'll only attempt to connect to Tor addresses if Tor
3579
                        // outbound support is enabled.
3580
                        case *tor.OnionAddr:
×
3581
                                if s.cfg.Tor.Active {
×
3582
                                        addrSet[addr.String()] = addr
×
3583
                                }
×
3584
                        }
3585
                }
3586

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

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

3606
                // Construct a slice of the deduped addresses.
3607
                var addrs []net.Addr
3✔
3608
                for _, addr := range addrSet {
6✔
3609
                        addrs = append(addrs, addr)
3✔
3610
                }
3✔
3611

3612
                n := &nodeAddresses{
3✔
3613
                        addresses: addrs,
3✔
3614
                }
3✔
3615
                n.pubKey, err = channelPeer.PubKey()
3✔
3616
                if err != nil {
3✔
3617
                        return err
×
3618
                }
×
3619

3620
                nodeAddrsMap[pubStr] = n
3✔
3621
                return nil
3✔
3622
        })
3623
        if err != nil && !errors.Is(err, graphdb.ErrGraphNoEdgesFound) {
3✔
3624
                return err
×
3625
        }
×
3626

3627
        srvrLog.Debugf("Establishing %v persistent connections on start",
3✔
3628
                len(nodeAddrsMap))
3✔
3629

3✔
3630
        // Acquire and hold server lock until all persistent connection requests
3✔
3631
        // have been recorded and sent to the connection manager.
3✔
3632
        s.mu.Lock()
3✔
3633
        defer s.mu.Unlock()
3✔
3634

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

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

3✔
3658
                        s.persistentPeerAddrs[pubStr] = append(
3✔
3659
                                s.persistentPeerAddrs[pubStr], lnAddr)
3✔
3660
                }
3✔
3661

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

3✔
3672
                        go s.connectToPersistentPeer(pubStr)
3✔
3673
                } else {
3✔
3674
                        go s.delayInitialReconnect(pubStr)
×
3675
                }
×
3676

3677
                numOutboundConns++
3✔
3678
        }
3679

3680
        return nil
3✔
3681
}
3682

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

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

3✔
3702
        s.mu.Lock()
3✔
3703
        if perm, ok := s.persistentPeers[pubKeyStr]; ok && !perm {
6✔
3704
                delete(s.persistentPeers, pubKeyStr)
3✔
3705
                delete(s.persistentPeersBackoff, pubKeyStr)
3✔
3706
                delete(s.persistentPeerAddrs, pubKeyStr)
3✔
3707
                s.cancelConnReqs(pubKeyStr, nil)
3✔
3708
                s.mu.Unlock()
3✔
3709

3✔
3710
                srvrLog.Infof("Pruned peer %x from persistent connections, "+
3✔
3711
                        "peer has no open channels", compressedPubKey)
3✔
3712

3✔
3713
                return
3✔
3714
        }
3✔
3715
        s.mu.Unlock()
3✔
3716
}
3717

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

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

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

3758
                peers = append(peers, sPeer)
3✔
3759
        }
3760
        s.mu.RUnlock()
3✔
3761

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

3✔
3769
                // Dispatch a go routine to enqueue all messages to this peer.
3✔
3770
                wg.Add(1)
3✔
3771
                s.wg.Add(1)
3✔
3772
                go func(p lnpeer.Peer) {
6✔
3773
                        defer s.wg.Done()
3✔
3774
                        defer wg.Done()
3✔
3775

3✔
3776
                        p.SendMessageLazy(false, msgs...)
3✔
3777
                }(sPeer)
3✔
3778
        }
3779

3780
        // Wait for all messages to have been dispatched before returning to
3781
        // caller.
3782
        wg.Wait()
3✔
3783

3✔
3784
        return nil
3✔
3785
}
3786

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

3✔
3794
        s.mu.Lock()
3✔
3795

3✔
3796
        // Compute the target peer's identifier.
3✔
3797
        pubStr := string(peerKey[:])
3✔
3798

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

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

3821
                // Connected, can return early.
3822
                srvrLog.Debugf("Notifying that peer %x is online", peerKey)
3✔
3823

3✔
3824
                select {
3✔
3825
                case peerChan <- peer:
3✔
3826
                case <-s.quit:
×
3827
                }
3828

3829
                return
3✔
3830
        }
3831

3832
        // Not connected, store this listener such that it can be notified when
3833
        // the peer comes online.
3834
        s.peerConnectedListeners[pubStr] = append(
3✔
3835
                s.peerConnectedListeners[pubStr], peerChan,
3✔
3836
        )
3✔
3837
        s.mu.Unlock()
3✔
3838
}
3839

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

3✔
3847
        c := make(chan struct{})
3✔
3848

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

3858
        // Otherwise, the peer is online, so we'll keep track of the channel to
3859
        // trigger the notification once the server detects the peer
3860
        // disconnects.
3861
        s.peerDisconnectedListeners[peerPubKeyStr] = append(
3✔
3862
                s.peerDisconnectedListeners[peerPubKeyStr], c,
3✔
3863
        )
3✔
3864

3✔
3865
        return c
3✔
3866
}
3867

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

3✔
3877
        pubStr := string(peerKey.SerializeCompressed())
3✔
3878

3✔
3879
        return s.findPeerByPubStr(pubStr)
3✔
3880
}
3✔
3881

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

3✔
3891
        return s.findPeerByPubStr(pubStr)
3✔
3892
}
3✔
3893

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

3902
        return peer, nil
3✔
3903
}
3904

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

3✔
3911
        // Now, determine the appropriate backoff to use for the retry.
3✔
3912
        backoff, ok := s.persistentPeersBackoff[pubStr]
3✔
3913
        if !ok {
6✔
3914
                // If an existing backoff was unknown, use the default.
3✔
3915
                return s.cfg.MinBackoff
3✔
3916
        }
3✔
3917

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

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

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

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

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

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

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

3977
        nodePub := conn.(*brontide.Conn).RemotePub()
3✔
3978
        pubSer := nodePub.SerializeCompressed()
3✔
3979
        pubStr := string(pubSer)
3✔
3980

3✔
3981
        var pubBytes [33]byte
3✔
3982
        copy(pubBytes[:], pubSer)
3✔
3983

3✔
3984
        s.mu.Lock()
3✔
3985
        defer s.mu.Unlock()
3✔
3986

3✔
3987
        // If the remote node's public key is banned, drop the connection.
3✔
3988
        access, err := s.peerAccessMan.assignPeerPerms(nodePub)
3✔
3989
        if err != nil {
3✔
3990
                // Clean up the persistent peer maps if we're dropping this
×
3991
                // connection.
×
3992
                s.bannedPersistentPeerConnection(pubStr)
×
3993

×
3994
                srvrLog.Debugf("Dropping connection for %x since we are out "+
×
3995
                        "of restricted-access connection slots: %v.", pubSer,
×
3996
                        err)
×
3997

×
3998
                conn.Close()
×
3999

×
4000
                return
×
4001
        }
×
4002

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

3✔
4010
                conn.Close()
3✔
4011
                return
3✔
4012
        }
3✔
4013

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

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

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

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

×
4049
                        srvrLog.Warnf("Received inbound connection from "+
×
4050
                                "peer %v, but already have outbound "+
×
4051
                                "connection, dropping conn", connectedPeer)
×
4052
                        conn.Close()
×
4053
                        return
×
4054
                }
×
4055

4056
                // Otherwise, if we should drop the connection, then we'll
4057
                // disconnect our already connected peer.
4058
                srvrLog.Debugf("Disconnecting stale connection to %v",
×
4059
                        connectedPeer)
×
4060

×
4061
                s.cancelConnReqs(pubStr, nil)
×
4062

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

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

4084
        nodePub := conn.(*brontide.Conn).RemotePub()
3✔
4085
        pubSer := nodePub.SerializeCompressed()
3✔
4086
        pubStr := string(pubSer)
3✔
4087

3✔
4088
        var pubBytes [33]byte
3✔
4089
        copy(pubBytes[:], pubSer)
3✔
4090

3✔
4091
        s.mu.Lock()
3✔
4092
        defer s.mu.Unlock()
3✔
4093

3✔
4094
        access, err := s.peerAccessMan.assignPeerPerms(nodePub)
3✔
4095
        if err != nil {
3✔
4096
                // Clean up the persistent peer maps if we're dropping this
×
4097
                // connection.
×
4098
                s.bannedPersistentPeerConnection(pubStr)
×
4099

×
4100
                srvrLog.Debugf("Dropping connection for %x since we are out "+
×
4101
                        "of restricted-access connection slots: %v.", pubSer,
×
4102
                        err)
×
4103

×
4104
                if connReq != nil {
×
4105
                        s.connMgr.Remove(connReq.ID())
×
4106
                }
×
4107

4108
                conn.Close()
×
4109

×
4110
                return
×
4111
        }
4112

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

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

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

×
4139
                if connReq != nil {
×
4140
                        s.connMgr.Remove(connReq.ID())
×
4141
                }
×
4142

4143
                conn.Close()
×
4144
                return
×
4145
        }
4146

4147
        srvrLog.Infof("Established connection to: %x@%v", pubStr,
3✔
4148
                conn.RemoteAddr())
3✔
4149

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

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

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

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

4193
                // Otherwise, _their_ connection should be dropped. So we'll
4194
                // disconnect the peer and send the now obsolete peer to the
4195
                // server for garbage collection.
4196
                srvrLog.Debugf("Disconnecting stale connection to %v",
×
4197
                        connectedPeer)
×
4198

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

4210
// UnassignedConnID is the default connection ID that a request can have before
4211
// it actually is submitted to the connmgr.
4212
// TODO(conner): move into connmgr package, or better, add connmgr method for
4213
// generating atomic IDs
4214
const UnassignedConnID uint64 = 0
4215

4216
// cancelConnReqs stops all persistent connection requests for a given pubkey.
4217
// Any attempts initiated by the peerTerminationWatcher are canceled first.
4218
// Afterwards, each connection request removed from the connmgr. The caller can
4219
// optionally specify a connection ID to ignore, which prevents us from
4220
// canceling a successful request. All persistent connreqs for the provided
4221
// pubkey are discarded after the operationjw.
4222
func (s *server) cancelConnReqs(pubStr string, skip *uint64) {
3✔
4223
        // First, cancel any lingering persistent retry attempts, which will
3✔
4224
        // prevent retries for any with backoffs that are still maturing.
3✔
4225
        if cancelChan, ok := s.persistentRetryCancels[pubStr]; ok {
6✔
4226
                close(cancelChan)
3✔
4227
                delete(s.persistentRetryCancels, pubStr)
3✔
4228
        }
3✔
4229

4230
        // Next, check to see if we have any outstanding persistent connection
4231
        // requests to this peer. If so, then we'll remove all of these
4232
        // connection requests, and also delete the entry from the map.
4233
        connReqs, ok := s.persistentConnReqs[pubStr]
3✔
4234
        if !ok {
6✔
4235
                return
3✔
4236
        }
3✔
4237

4238
        for _, connReq := range connReqs {
6✔
4239
                srvrLog.Tracef("Canceling %s:", connReqs)
3✔
4240

3✔
4241
                // Atomically capture the current request identifier.
3✔
4242
                connID := connReq.ID()
3✔
4243

3✔
4244
                // Skip any zero IDs, this indicates the request has not
3✔
4245
                // yet been schedule.
3✔
4246
                if connID == UnassignedConnID {
3✔
4247
                        continue
×
4248
                }
4249

4250
                // Skip a particular connection ID if instructed.
4251
                if skip != nil && connID == *skip {
6✔
4252
                        continue
3✔
4253
                }
4254

4255
                s.connMgr.Remove(connID)
3✔
4256
        }
4257

4258
        delete(s.persistentConnReqs, pubStr)
3✔
4259
}
4260

4261
// handleCustomMessage dispatches an incoming custom peers message to
4262
// subscribers.
4263
func (s *server) handleCustomMessage(peer [33]byte, msg *lnwire.Custom) error {
3✔
4264
        srvrLog.Debugf("Custom message received: peer=%x, type=%d",
3✔
4265
                peer, msg.Type)
3✔
4266

3✔
4267
        return s.customMessageServer.SendUpdate(&CustomMessage{
3✔
4268
                Peer: peer,
3✔
4269
                Msg:  msg,
3✔
4270
        })
3✔
4271
}
3✔
4272

4273
// SubscribeCustomMessages subscribes to a stream of incoming custom peer
4274
// messages.
4275
func (s *server) SubscribeCustomMessages() (*subscribe.Client, error) {
3✔
4276
        return s.customMessageServer.Subscribe()
3✔
4277
}
3✔
4278

4279
// notifyOpenChannelPeerEvent updates the access manager's maps and then calls
4280
// the channelNotifier's NotifyOpenChannelEvent.
4281
func (s *server) notifyOpenChannelPeerEvent(op wire.OutPoint,
4282
        remotePub *btcec.PublicKey) error {
3✔
4283

3✔
4284
        // Call newOpenChan to update the access manager's maps for this peer.
3✔
4285
        if err := s.peerAccessMan.newOpenChan(remotePub); err != nil {
6✔
4286
                return err
3✔
4287
        }
3✔
4288

4289
        // Notify subscribers about this open channel event.
4290
        s.channelNotifier.NotifyOpenChannelEvent(op)
3✔
4291

3✔
4292
        return nil
3✔
4293
}
4294

4295
// notifyPendingOpenChannelPeerEvent updates the access manager's maps and then
4296
// calls the channelNotifier's NotifyPendingOpenChannelEvent.
4297
func (s *server) notifyPendingOpenChannelPeerEvent(op wire.OutPoint,
4298
        pendingChan *channeldb.OpenChannel, remotePub *btcec.PublicKey) error {
3✔
4299

3✔
4300
        // Call newPendingOpenChan to update the access manager's maps for this
3✔
4301
        // peer.
3✔
4302
        if err := s.peerAccessMan.newPendingOpenChan(remotePub); err != nil {
3✔
4303
                return err
×
4304
        }
×
4305

4306
        // Notify subscribers about this event.
4307
        s.channelNotifier.NotifyPendingOpenChannelEvent(op, pendingChan)
3✔
4308

3✔
4309
        return nil
3✔
4310
}
4311

4312
// notifyFundingTimeoutPeerEvent updates the access manager's maps and then
4313
// calls the channelNotifier's NotifyFundingTimeout.
4314
func (s *server) notifyFundingTimeoutPeerEvent(op wire.OutPoint,
4315
        remotePub *btcec.PublicKey) error {
3✔
4316

3✔
4317
        // Call newPendingCloseChan to potentially demote the peer.
3✔
4318
        err := s.peerAccessMan.newPendingCloseChan(remotePub)
3✔
4319
        if errors.Is(err, ErrNoMoreRestrictedAccessSlots) {
3✔
4320
                // If we encounter an error while attempting to disconnect the
×
4321
                // peer, log the error.
×
4322
                if dcErr := s.DisconnectPeer(remotePub); dcErr != nil {
×
4323
                        srvrLog.Errorf("Unable to disconnect peer: %v\n", err)
×
4324
                }
×
4325
        }
4326

4327
        // Notify subscribers about this event.
4328
        s.channelNotifier.NotifyFundingTimeout(op)
3✔
4329

3✔
4330
        return nil
3✔
4331
}
4332

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

3✔
4340
        brontideConn := conn.(*brontide.Conn)
3✔
4341
        addr := conn.RemoteAddr()
3✔
4342
        pubKey := brontideConn.RemotePub()
3✔
4343

3✔
4344
        srvrLog.Infof("Finalizing connection to %x@%s, inbound=%v",
3✔
4345
                pubKey.SerializeCompressed(), addr, inbound)
3✔
4346

3✔
4347
        peerAddr := &lnwire.NetAddress{
3✔
4348
                IdentityKey: pubKey,
3✔
4349
                Address:     addr,
3✔
4350
                ChainNet:    s.cfg.ActiveNetParams.Net,
3✔
4351
        }
3✔
4352

3✔
4353
        // With the brontide connection established, we'll now craft the feature
3✔
4354
        // vectors to advertise to the remote node.
3✔
4355
        initFeatures := s.featureMgr.Get(feature.SetInit)
3✔
4356
        legacyFeatures := s.featureMgr.Get(feature.SetLegacyGlobal)
3✔
4357

3✔
4358
        // Lookup past error caches for the peer in the server. If no buffer is
3✔
4359
        // found, create a fresh buffer.
3✔
4360
        pkStr := string(peerAddr.IdentityKey.SerializeCompressed())
3✔
4361
        errBuffer, ok := s.peerErrors[pkStr]
3✔
4362
        if !ok {
6✔
4363
                var err error
3✔
4364
                errBuffer, err = queue.NewCircularBuffer(peer.ErrorBufferSize)
3✔
4365
                if err != nil {
3✔
4366
                        srvrLog.Errorf("unable to create peer %v", err)
×
4367
                        return
×
4368
                }
×
4369
        }
4370

4371
        // If we directly set the peer.Config TowerClient member to the
4372
        // s.towerClientMgr then in the case that the s.towerClientMgr is nil,
4373
        // the peer.Config's TowerClient member will not evaluate to nil even
4374
        // though the underlying value is nil. To avoid this gotcha which can
4375
        // cause a panic, we need to explicitly pass nil to the peer.Config's
4376
        // TowerClient if needed.
4377
        var towerClient wtclient.ClientManager
3✔
4378
        if s.towerClientMgr != nil {
6✔
4379
                towerClient = s.towerClientMgr
3✔
4380
        }
3✔
4381

4382
        thresholdSats := btcutil.Amount(s.cfg.MaxFeeExposure)
3✔
4383
        thresholdMSats := lnwire.NewMSatFromSatoshis(thresholdSats)
3✔
4384

3✔
4385
        // Now that we've established a connection, create a peer, and it to the
3✔
4386
        // set of currently active peers. Configure the peer with the incoming
3✔
4387
        // and outgoing broadcast deltas to prevent htlcs from being accepted or
3✔
4388
        // offered that would trigger channel closure. In case of outgoing
3✔
4389
        // htlcs, an extra block is added to prevent the channel from being
3✔
4390
        // closed when the htlc is outstanding and a new block comes in.
3✔
4391
        pCfg := peer.Config{
3✔
4392
                Conn:                    brontideConn,
3✔
4393
                ConnReq:                 connReq,
3✔
4394
                Addr:                    peerAddr,
3✔
4395
                Inbound:                 inbound,
3✔
4396
                Features:                initFeatures,
3✔
4397
                LegacyFeatures:          legacyFeatures,
3✔
4398
                OutgoingCltvRejectDelta: lncfg.DefaultOutgoingCltvRejectDelta,
3✔
4399
                ChanActiveTimeout:       s.cfg.ChanEnableTimeout,
3✔
4400
                ErrorBuffer:             errBuffer,
3✔
4401
                WritePool:               s.writePool,
3✔
4402
                ReadPool:                s.readPool,
3✔
4403
                Switch:                  s.htlcSwitch,
3✔
4404
                InterceptSwitch:         s.interceptableSwitch,
3✔
4405
                ChannelDB:               s.chanStateDB,
3✔
4406
                ChannelGraph:            s.graphDB,
3✔
4407
                ChainArb:                s.chainArb,
3✔
4408
                AuthGossiper:            s.authGossiper,
3✔
4409
                ChanStatusMgr:           s.chanStatusMgr,
3✔
4410
                ChainIO:                 s.cc.ChainIO,
3✔
4411
                FeeEstimator:            s.cc.FeeEstimator,
3✔
4412
                Signer:                  s.cc.Wallet.Cfg.Signer,
3✔
4413
                SigPool:                 s.sigPool,
3✔
4414
                Wallet:                  s.cc.Wallet,
3✔
4415
                ChainNotifier:           s.cc.ChainNotifier,
3✔
4416
                BestBlockView:           s.cc.BestBlockTracker,
3✔
4417
                RoutingPolicy:           s.cc.RoutingPolicy,
3✔
4418
                Sphinx:                  s.sphinx,
3✔
4419
                WitnessBeacon:           s.witnessBeacon,
3✔
4420
                Invoices:                s.invoices,
3✔
4421
                ChannelNotifier:         s.channelNotifier,
3✔
4422
                HtlcNotifier:            s.htlcNotifier,
3✔
4423
                TowerClient:             towerClient,
3✔
4424
                DisconnectPeer:          s.DisconnectPeer,
3✔
4425
                GenNodeAnnouncement: func(...netann.NodeAnnModifier) (
3✔
4426
                        lnwire.NodeAnnouncement, error) {
6✔
4427

3✔
4428
                        return s.genNodeAnnouncement(nil)
3✔
4429
                },
3✔
4430

4431
                PongBuf: s.pongBuf,
4432

4433
                PrunePersistentPeerConnection: s.prunePersistentPeerConnection,
4434

4435
                FetchLastChanUpdate: s.fetchLastChanUpdate(),
4436

4437
                FundingManager: s.fundingMgr,
4438

4439
                Hodl:                    s.cfg.Hodl,
4440
                UnsafeReplay:            s.cfg.UnsafeReplay,
4441
                MaxOutgoingCltvExpiry:   s.cfg.MaxOutgoingCltvExpiry,
4442
                MaxChannelFeeAllocation: s.cfg.MaxChannelFeeAllocation,
4443
                CoopCloseTargetConfs:    s.cfg.CoopCloseTargetConfs,
4444
                MaxAnchorsCommitFeeRate: chainfee.SatPerKVByte(
4445
                        s.cfg.MaxCommitFeeRateAnchors * 1000).FeePerKWeight(),
4446
                ChannelCommitInterval:  s.cfg.ChannelCommitInterval,
4447
                PendingCommitInterval:  s.cfg.PendingCommitInterval,
4448
                ChannelCommitBatchSize: s.cfg.ChannelCommitBatchSize,
4449
                HandleCustomMessage:    s.handleCustomMessage,
4450
                GetAliases:             s.aliasMgr.GetAliases,
4451
                RequestAlias:           s.aliasMgr.RequestAlias,
4452
                AddLocalAlias:          s.aliasMgr.AddLocalAlias,
4453
                DisallowRouteBlinding:  s.cfg.ProtocolOptions.NoRouteBlinding(),
4454
                DisallowQuiescence:     s.cfg.ProtocolOptions.NoQuiescence(),
4455
                MaxFeeExposure:         thresholdMSats,
4456
                Quit:                   s.quit,
4457
                AuxLeafStore:           s.implCfg.AuxLeafStore,
4458
                AuxSigner:              s.implCfg.AuxSigner,
4459
                MsgRouter:              s.implCfg.MsgRouter,
4460
                AuxChanCloser:          s.implCfg.AuxChanCloser,
4461
                AuxResolver:            s.implCfg.AuxContractResolver,
4462
                AuxTrafficShaper:       s.implCfg.TrafficShaper,
4463
                ShouldFwdExpEndorsement: func() bool {
3✔
4464
                        if s.cfg.ProtocolOptions.NoExperimentalEndorsement() {
6✔
4465
                                return false
3✔
4466
                        }
3✔
4467

4468
                        return clock.NewDefaultClock().Now().Before(
3✔
4469
                                EndorsementExperimentEnd,
3✔
4470
                        )
3✔
4471
                },
4472
        }
4473

4474
        copy(pCfg.PubKeyBytes[:], peerAddr.IdentityKey.SerializeCompressed())
3✔
4475
        copy(pCfg.ServerPubKey[:], s.identityECDH.PubKey().SerializeCompressed())
3✔
4476

3✔
4477
        p := peer.NewBrontide(pCfg)
3✔
4478

3✔
4479
        // Update the access manager with the access permission for this peer.
3✔
4480
        s.peerAccessMan.addPeerAccess(pubKey, access)
3✔
4481

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

3✔
4485
        s.addPeer(p)
3✔
4486

3✔
4487
        // Once we have successfully added the peer to the server, we can
3✔
4488
        // delete the previous error buffer from the server's map of error
3✔
4489
        // buffers.
3✔
4490
        delete(s.peerErrors, pkStr)
3✔
4491

3✔
4492
        // Dispatch a goroutine to asynchronously start the peer. This process
3✔
4493
        // includes sending and receiving Init messages, which would be a DOS
3✔
4494
        // vector if we held the server's mutex throughout the procedure.
3✔
4495
        s.wg.Add(1)
3✔
4496
        go s.peerInitializer(p)
3✔
4497
}
4498

4499
// addPeer adds the passed peer to the server's global state of all active
4500
// peers.
4501
func (s *server) addPeer(p *peer.Brontide) {
3✔
4502
        if p == nil {
3✔
4503
                return
×
4504
        }
×
4505

4506
        pubBytes := p.IdentityKey().SerializeCompressed()
3✔
4507

3✔
4508
        // Ignore new peers if we're shutting down.
3✔
4509
        if s.Stopped() {
3✔
4510
                srvrLog.Infof("Server stopped, skipped adding peer=%x",
×
4511
                        pubBytes)
×
4512
                p.Disconnect(ErrServerShuttingDown)
×
4513

×
4514
                return
×
4515
        }
×
4516

4517
        // Track the new peer in our indexes so we can quickly look it up either
4518
        // according to its public key, or its peer ID.
4519
        // TODO(roasbeef): pipe all requests through to the
4520
        // queryHandler/peerManager
4521

4522
        // NOTE: This pubStr is a raw bytes to string conversion and will NOT
4523
        // be human-readable.
4524
        pubStr := string(pubBytes)
3✔
4525

3✔
4526
        s.peersByPub[pubStr] = p
3✔
4527

3✔
4528
        if p.Inbound() {
6✔
4529
                s.inboundPeers[pubStr] = p
3✔
4530
        } else {
6✔
4531
                s.outboundPeers[pubStr] = p
3✔
4532
        }
3✔
4533

4534
        // Inform the peer notifier of a peer online event so that it can be reported
4535
        // to clients listening for peer events.
4536
        var pubKey [33]byte
3✔
4537
        copy(pubKey[:], pubBytes)
3✔
4538

3✔
4539
        s.peerNotifier.NotifyPeerOnline(pubKey)
3✔
4540
}
4541

4542
// peerInitializer asynchronously starts a newly connected peer after it has
4543
// been added to the server's peer map. This method sets up a
4544
// peerTerminationWatcher for the given peer, and ensures that it executes even
4545
// if the peer failed to start. In the event of a successful connection, this
4546
// method reads the negotiated, local feature-bits and spawns the appropriate
4547
// graph synchronization method. Any registered clients of NotifyWhenOnline will
4548
// be signaled of the new peer once the method returns.
4549
//
4550
// NOTE: This MUST be launched as a goroutine.
4551
func (s *server) peerInitializer(p *peer.Brontide) {
3✔
4552
        defer s.wg.Done()
3✔
4553

3✔
4554
        pubBytes := p.IdentityKey().SerializeCompressed()
3✔
4555

3✔
4556
        // Avoid initializing peers while the server is exiting.
3✔
4557
        if s.Stopped() {
3✔
4558
                srvrLog.Infof("Server stopped, skipped initializing peer=%x",
×
4559
                        pubBytes)
×
4560
                return
×
4561
        }
×
4562

4563
        // Create a channel that will be used to signal a successful start of
4564
        // the link. This prevents the peer termination watcher from beginning
4565
        // its duty too early.
4566
        ready := make(chan struct{})
3✔
4567

3✔
4568
        // Before starting the peer, launch a goroutine to watch for the
3✔
4569
        // unexpected termination of this peer, which will ensure all resources
3✔
4570
        // are properly cleaned up, and re-establish persistent connections when
3✔
4571
        // necessary. The peer termination watcher will be short circuited if
3✔
4572
        // the peer is ever added to the ignorePeerTermination map, indicating
3✔
4573
        // that the server has already handled the removal of this peer.
3✔
4574
        s.wg.Add(1)
3✔
4575
        go s.peerTerminationWatcher(p, ready)
3✔
4576

3✔
4577
        // Start the peer! If an error occurs, we Disconnect the peer, which
3✔
4578
        // will unblock the peerTerminationWatcher.
3✔
4579
        if err := p.Start(); err != nil {
6✔
4580
                srvrLog.Warnf("Starting peer=%x got error: %v", pubBytes, err)
3✔
4581

3✔
4582
                p.Disconnect(fmt.Errorf("unable to start peer: %w", err))
3✔
4583
                return
3✔
4584
        }
3✔
4585

4586
        // Otherwise, signal to the peerTerminationWatcher that the peer startup
4587
        // was successful, and to begin watching the peer's wait group.
4588
        close(ready)
3✔
4589

3✔
4590
        s.mu.Lock()
3✔
4591
        defer s.mu.Unlock()
3✔
4592

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

3✔
4596
        // TODO(guggero): Do a proper conversion to a string everywhere, or use
3✔
4597
        // route.Vertex as the key type of peerConnectedListeners.
3✔
4598
        pubStr := string(pubBytes)
3✔
4599
        for _, peerChan := range s.peerConnectedListeners[pubStr] {
6✔
4600
                select {
3✔
4601
                case peerChan <- p:
3✔
4602
                case <-s.quit:
×
4603
                        return
×
4604
                }
4605
        }
4606
        delete(s.peerConnectedListeners, pubStr)
3✔
4607
}
4608

4609
// peerTerminationWatcher waits until a peer has been disconnected unexpectedly,
4610
// and then cleans up all resources allocated to the peer, notifies relevant
4611
// sub-systems of its demise, and finally handles re-connecting to the peer if
4612
// it's persistent. If the server intentionally disconnects a peer, it should
4613
// have a corresponding entry in the ignorePeerTermination map which will cause
4614
// the cleanup routine to exit early. The passed `ready` chan is used to
4615
// synchronize when WaitForDisconnect should begin watching on the peer's
4616
// waitgroup. The ready chan should only be signaled if the peer starts
4617
// successfully, otherwise the peer should be disconnected instead.
4618
//
4619
// NOTE: This MUST be launched as a goroutine.
4620
func (s *server) peerTerminationWatcher(p *peer.Brontide, ready chan struct{}) {
3✔
4621
        defer s.wg.Done()
3✔
4622

3✔
4623
        p.WaitForDisconnect(ready)
3✔
4624

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

3✔
4627
        // If the server is exiting then we can bail out early ourselves as all
3✔
4628
        // the other sub-systems will already be shutting down.
3✔
4629
        if s.Stopped() {
6✔
4630
                srvrLog.Debugf("Server quitting, exit early for peer %v", p)
3✔
4631
                return
3✔
4632
        }
3✔
4633

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

3✔
4640
        pubKey := p.IdentityKey()
3✔
4641

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

3✔
4646
        // Tell the switch to remove all links associated with this peer.
3✔
4647
        // Passing nil as the target link indicates that all links associated
3✔
4648
        // with this interface should be closed.
3✔
4649
        //
3✔
4650
        // TODO(roasbeef): instead add a PurgeInterfaceLinks function?
3✔
4651
        links, err := s.htlcSwitch.GetLinksByInterface(p.PubKey())
3✔
4652
        if err != nil && err != htlcswitch.ErrNoLinksFound {
3✔
4653
                srvrLog.Errorf("Unable to get channel links for %v: %v", p, err)
×
4654
        }
×
4655

4656
        for _, link := range links {
6✔
4657
                s.htlcSwitch.RemoveLink(link.ChanID())
3✔
4658
        }
3✔
4659

4660
        s.mu.Lock()
3✔
4661
        defer s.mu.Unlock()
3✔
4662

3✔
4663
        // If there were any notification requests for when this peer
3✔
4664
        // disconnected, we can trigger them now.
3✔
4665
        srvrLog.Debugf("Notifying that peer %v is offline", p)
3✔
4666
        pubStr := string(pubKey.SerializeCompressed())
3✔
4667
        for _, offlineChan := range s.peerDisconnectedListeners[pubStr] {
6✔
4668
                close(offlineChan)
3✔
4669
        }
3✔
4670
        delete(s.peerDisconnectedListeners, pubStr)
3✔
4671

3✔
4672
        // If the server has already removed this peer, we can short circuit the
3✔
4673
        // peer termination watcher and skip cleanup.
3✔
4674
        if _, ok := s.ignorePeerTermination[p]; ok {
3✔
4675
                delete(s.ignorePeerTermination, p)
×
4676

×
4677
                pubKey := p.PubKey()
×
4678
                pubStr := string(pubKey[:])
×
4679

×
4680
                // If a connection callback is present, we'll go ahead and
×
4681
                // execute it now that previous peer has fully disconnected. If
×
4682
                // the callback is not present, this likely implies the peer was
×
4683
                // purposefully disconnected via RPC, and that no reconnect
×
4684
                // should be attempted.
×
4685
                connCallback, ok := s.scheduledPeerConnection[pubStr]
×
4686
                if ok {
×
4687
                        delete(s.scheduledPeerConnection, pubStr)
×
4688
                        connCallback()
×
4689
                }
×
4690
                return
×
4691
        }
4692

4693
        // First, cleanup any remaining state the server has regarding the peer
4694
        // in question.
4695
        s.removePeer(p)
3✔
4696

3✔
4697
        // Next, check to see if this is a persistent peer or not.
3✔
4698
        if _, ok := s.persistentPeers[pubStr]; !ok {
6✔
4699
                return
3✔
4700
        }
3✔
4701

4702
        // Get the last address that we used to connect to the peer.
4703
        addrs := []net.Addr{
3✔
4704
                p.NetAddress().Address,
3✔
4705
        }
3✔
4706

3✔
4707
        // We'll ensure that we locate all the peers advertised addresses for
3✔
4708
        // reconnection purposes.
3✔
4709
        advertisedAddrs, err := s.fetchNodeAdvertisedAddrs(pubKey)
3✔
4710
        switch {
3✔
4711
        // We found advertised addresses, so use them.
4712
        case err == nil:
3✔
4713
                addrs = advertisedAddrs
3✔
4714

4715
        // The peer doesn't have an advertised address.
4716
        case err == errNoAdvertisedAddr:
3✔
4717
                // If it is an outbound peer then we fall back to the existing
3✔
4718
                // peer address.
3✔
4719
                if !p.Inbound() {
6✔
4720
                        break
3✔
4721
                }
4722

4723
                // Fall back to the existing peer address if
4724
                // we're not accepting connections over Tor.
4725
                if s.torController == nil {
6✔
4726
                        break
3✔
4727
                }
4728

4729
                // If we are, the peer's address won't be known
4730
                // to us (we'll see a private address, which is
4731
                // the address used by our onion service to dial
4732
                // to lnd), so we don't have enough information
4733
                // to attempt a reconnect.
4734
                srvrLog.Debugf("Ignoring reconnection attempt "+
×
4735
                        "to inbound peer %v without "+
×
4736
                        "advertised address", p)
×
4737
                return
×
4738

4739
        // We came across an error retrieving an advertised
4740
        // address, log it, and fall back to the existing peer
4741
        // address.
4742
        default:
3✔
4743
                srvrLog.Errorf("Unable to retrieve advertised "+
3✔
4744
                        "address for node %x: %v", p.PubKey(),
3✔
4745
                        err)
3✔
4746
        }
4747

4748
        // Make an easy lookup map so that we can check if an address
4749
        // is already in the address list that we have stored for this peer.
4750
        existingAddrs := make(map[string]bool)
3✔
4751
        for _, addr := range s.persistentPeerAddrs[pubStr] {
6✔
4752
                existingAddrs[addr.String()] = true
3✔
4753
        }
3✔
4754

4755
        // Add any missing addresses for this peer to persistentPeerAddr.
4756
        for _, addr := range addrs {
6✔
4757
                if existingAddrs[addr.String()] {
3✔
4758
                        continue
×
4759
                }
4760

4761
                s.persistentPeerAddrs[pubStr] = append(
3✔
4762
                        s.persistentPeerAddrs[pubStr],
3✔
4763
                        &lnwire.NetAddress{
3✔
4764
                                IdentityKey: p.IdentityKey(),
3✔
4765
                                Address:     addr,
3✔
4766
                                ChainNet:    p.NetAddress().ChainNet,
3✔
4767
                        },
3✔
4768
                )
3✔
4769
        }
4770

4771
        // Record the computed backoff in the backoff map.
4772
        backoff := s.nextPeerBackoff(pubStr, p.StartTime())
3✔
4773
        s.persistentPeersBackoff[pubStr] = backoff
3✔
4774

3✔
4775
        // Initialize a retry canceller for this peer if one does not
3✔
4776
        // exist.
3✔
4777
        cancelChan, ok := s.persistentRetryCancels[pubStr]
3✔
4778
        if !ok {
6✔
4779
                cancelChan = make(chan struct{})
3✔
4780
                s.persistentRetryCancels[pubStr] = cancelChan
3✔
4781
        }
3✔
4782

4783
        // We choose not to wait group this go routine since the Connect
4784
        // call can stall for arbitrarily long if we shutdown while an
4785
        // outbound connection attempt is being made.
4786
        go func() {
6✔
4787
                srvrLog.Debugf("Scheduling connection re-establishment to "+
3✔
4788
                        "persistent peer %x in %s",
3✔
4789
                        p.IdentityKey().SerializeCompressed(), backoff)
3✔
4790

3✔
4791
                select {
3✔
4792
                case <-time.After(backoff):
3✔
4793
                case <-cancelChan:
3✔
4794
                        return
3✔
4795
                case <-s.quit:
3✔
4796
                        return
3✔
4797
                }
4798

4799
                srvrLog.Debugf("Attempting to re-establish persistent "+
3✔
4800
                        "connection to peer %x",
3✔
4801
                        p.IdentityKey().SerializeCompressed())
3✔
4802

3✔
4803
                s.connectToPersistentPeer(pubStr)
3✔
4804
        }()
4805
}
4806

4807
// connectToPersistentPeer uses all the stored addresses for a peer to attempt
4808
// to connect to the peer. It creates connection requests if there are
4809
// currently none for a given address and it removes old connection requests
4810
// if the associated address is no longer in the latest address list for the
4811
// peer.
4812
func (s *server) connectToPersistentPeer(pubKeyStr string) {
3✔
4813
        s.mu.Lock()
3✔
4814
        defer s.mu.Unlock()
3✔
4815

3✔
4816
        // Create an easy lookup map of the addresses we have stored for the
3✔
4817
        // peer. We will remove entries from this map if we have existing
3✔
4818
        // connection requests for the associated address and then any leftover
3✔
4819
        // entries will indicate which addresses we should create new
3✔
4820
        // connection requests for.
3✔
4821
        addrMap := make(map[string]*lnwire.NetAddress)
3✔
4822
        for _, addr := range s.persistentPeerAddrs[pubKeyStr] {
6✔
4823
                addrMap[addr.String()] = addr
3✔
4824
        }
3✔
4825

4826
        // Go through each of the existing connection requests and
4827
        // check if they correspond to the latest set of addresses. If
4828
        // there is a connection requests that does not use one of the latest
4829
        // advertised addresses then remove that connection request.
4830
        var updatedConnReqs []*connmgr.ConnReq
3✔
4831
        for _, connReq := range s.persistentConnReqs[pubKeyStr] {
6✔
4832
                lnAddr := connReq.Addr.(*lnwire.NetAddress).Address.String()
3✔
4833

3✔
4834
                switch _, ok := addrMap[lnAddr]; ok {
3✔
4835
                // If the existing connection request is using one of the
4836
                // latest advertised addresses for the peer then we add it to
4837
                // updatedConnReqs and remove the associated address from
4838
                // addrMap so that we don't recreate this connReq later on.
4839
                case true:
×
4840
                        updatedConnReqs = append(
×
4841
                                updatedConnReqs, connReq,
×
4842
                        )
×
4843
                        delete(addrMap, lnAddr)
×
4844

4845
                // If the existing connection request is using an address that
4846
                // is not one of the latest advertised addresses for the peer
4847
                // then we remove the connecting request from the connection
4848
                // manager.
4849
                case false:
3✔
4850
                        srvrLog.Info(
3✔
4851
                                "Removing conn req:", connReq.Addr.String(),
3✔
4852
                        )
3✔
4853
                        s.connMgr.Remove(connReq.ID())
3✔
4854
                }
4855
        }
4856

4857
        s.persistentConnReqs[pubKeyStr] = updatedConnReqs
3✔
4858

3✔
4859
        cancelChan, ok := s.persistentRetryCancels[pubKeyStr]
3✔
4860
        if !ok {
6✔
4861
                cancelChan = make(chan struct{})
3✔
4862
                s.persistentRetryCancels[pubKeyStr] = cancelChan
3✔
4863
        }
3✔
4864

4865
        // Any addresses left in addrMap are new ones that we have not made
4866
        // connection requests for. So create new connection requests for those.
4867
        // If there is more than one address in the address map, stagger the
4868
        // creation of the connection requests for those.
4869
        go func() {
6✔
4870
                ticker := time.NewTicker(multiAddrConnectionStagger)
3✔
4871
                defer ticker.Stop()
3✔
4872

3✔
4873
                for _, addr := range addrMap {
6✔
4874
                        // Send the persistent connection request to the
3✔
4875
                        // connection manager, saving the request itself so we
3✔
4876
                        // can cancel/restart the process as needed.
3✔
4877
                        connReq := &connmgr.ConnReq{
3✔
4878
                                Addr:      addr,
3✔
4879
                                Permanent: true,
3✔
4880
                        }
3✔
4881

3✔
4882
                        s.mu.Lock()
3✔
4883
                        s.persistentConnReqs[pubKeyStr] = append(
3✔
4884
                                s.persistentConnReqs[pubKeyStr], connReq,
3✔
4885
                        )
3✔
4886
                        s.mu.Unlock()
3✔
4887

3✔
4888
                        srvrLog.Debugf("Attempting persistent connection to "+
3✔
4889
                                "channel peer %v", addr)
3✔
4890

3✔
4891
                        go s.connMgr.Connect(connReq)
3✔
4892

3✔
4893
                        select {
3✔
4894
                        case <-s.quit:
3✔
4895
                                return
3✔
4896
                        case <-cancelChan:
3✔
4897
                                return
3✔
4898
                        case <-ticker.C:
3✔
4899
                        }
4900
                }
4901
        }()
4902
}
4903

4904
// removePeer removes the passed peer from the server's state of all active
4905
// peers.
4906
func (s *server) removePeer(p *peer.Brontide) {
3✔
4907
        if p == nil {
3✔
4908
                return
×
4909
        }
×
4910

4911
        srvrLog.Debugf("removing peer %v", p)
3✔
4912

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

3✔
4917
        // If this peer had an active persistent connection request, remove it.
3✔
4918
        if p.ConnReq() != nil {
6✔
4919
                s.connMgr.Remove(p.ConnReq().ID())
3✔
4920
        }
3✔
4921

4922
        // Ignore deleting peers if we're shutting down.
4923
        if s.Stopped() {
3✔
4924
                return
×
4925
        }
×
4926

4927
        pKey := p.PubKey()
3✔
4928
        pubSer := pKey[:]
3✔
4929
        pubStr := string(pubSer)
3✔
4930

3✔
4931
        delete(s.peersByPub, pubStr)
3✔
4932

3✔
4933
        if p.Inbound() {
6✔
4934
                delete(s.inboundPeers, pubStr)
3✔
4935
        } else {
6✔
4936
                delete(s.outboundPeers, pubStr)
3✔
4937
        }
3✔
4938

4939
        // Remove the peer's access permission from the access manager.
4940
        s.peerAccessMan.removePeerAccess(p.IdentityKey())
3✔
4941

3✔
4942
        // Copy the peer's error buffer across to the server if it has any items
3✔
4943
        // in it so that we can restore peer errors across connections.
3✔
4944
        if p.ErrorBuffer().Total() > 0 {
6✔
4945
                s.peerErrors[pubStr] = p.ErrorBuffer()
3✔
4946
        }
3✔
4947

4948
        // Inform the peer notifier of a peer offline event so that it can be
4949
        // reported to clients listening for peer events.
4950
        var pubKey [33]byte
3✔
4951
        copy(pubKey[:], pubSer)
3✔
4952

3✔
4953
        s.peerNotifier.NotifyPeerOffline(pubKey)
3✔
4954
}
4955

4956
// ConnectToPeer requests that the server connect to a Lightning Network peer
4957
// at the specified address. This function will *block* until either a
4958
// connection is established, or the initial handshake process fails.
4959
//
4960
// NOTE: This function is safe for concurrent access.
4961
func (s *server) ConnectToPeer(addr *lnwire.NetAddress,
4962
        perm bool, timeout time.Duration) error {
3✔
4963

3✔
4964
        targetPub := string(addr.IdentityKey.SerializeCompressed())
3✔
4965

3✔
4966
        // Acquire mutex, but use explicit unlocking instead of defer for
3✔
4967
        // better granularity.  In certain conditions, this method requires
3✔
4968
        // making an outbound connection to a remote peer, which requires the
3✔
4969
        // lock to be released, and subsequently reacquired.
3✔
4970
        s.mu.Lock()
3✔
4971

3✔
4972
        // Ensure we're not already connected to this peer.
3✔
4973
        peer, err := s.findPeerByPubStr(targetPub)
3✔
4974
        if err == nil {
6✔
4975
                s.mu.Unlock()
3✔
4976
                return &errPeerAlreadyConnected{peer: peer}
3✔
4977
        }
3✔
4978

4979
        // Peer was not found, continue to pursue connection with peer.
4980

4981
        // If there's already a pending connection request for this pubkey,
4982
        // then we ignore this request to ensure we don't create a redundant
4983
        // connection.
4984
        if reqs, ok := s.persistentConnReqs[targetPub]; ok {
6✔
4985
                srvrLog.Warnf("Already have %d persistent connection "+
3✔
4986
                        "requests for %v, connecting anyway.", len(reqs), addr)
3✔
4987
        }
3✔
4988

4989
        // If there's not already a pending or active connection to this node,
4990
        // then instruct the connection manager to attempt to establish a
4991
        // persistent connection to the peer.
4992
        srvrLog.Debugf("Connecting to %v", addr)
3✔
4993
        if perm {
6✔
4994
                connReq := &connmgr.ConnReq{
3✔
4995
                        Addr:      addr,
3✔
4996
                        Permanent: true,
3✔
4997
                }
3✔
4998

3✔
4999
                // Since the user requested a permanent connection, we'll set
3✔
5000
                // the entry to true which will tell the server to continue
3✔
5001
                // reconnecting even if the number of channels with this peer is
3✔
5002
                // zero.
3✔
5003
                s.persistentPeers[targetPub] = true
3✔
5004
                if _, ok := s.persistentPeersBackoff[targetPub]; !ok {
6✔
5005
                        s.persistentPeersBackoff[targetPub] = s.cfg.MinBackoff
3✔
5006
                }
3✔
5007
                s.persistentConnReqs[targetPub] = append(
3✔
5008
                        s.persistentConnReqs[targetPub], connReq,
3✔
5009
                )
3✔
5010
                s.mu.Unlock()
3✔
5011

3✔
5012
                go s.connMgr.Connect(connReq)
3✔
5013

3✔
5014
                return nil
3✔
5015
        }
5016
        s.mu.Unlock()
3✔
5017

3✔
5018
        // If we're not making a persistent connection, then we'll attempt to
3✔
5019
        // connect to the target peer. If the we can't make the connection, or
3✔
5020
        // the crypto negotiation breaks down, then return an error to the
3✔
5021
        // caller.
3✔
5022
        errChan := make(chan error, 1)
3✔
5023
        s.connectToPeer(addr, errChan, timeout)
3✔
5024

3✔
5025
        select {
3✔
5026
        case err := <-errChan:
3✔
5027
                return err
3✔
5028
        case <-s.quit:
×
5029
                return ErrServerShuttingDown
×
5030
        }
5031
}
5032

5033
// connectToPeer establishes a connection to a remote peer. errChan is used to
5034
// notify the caller if the connection attempt has failed. Otherwise, it will be
5035
// closed.
5036
func (s *server) connectToPeer(addr *lnwire.NetAddress,
5037
        errChan chan<- error, timeout time.Duration) {
3✔
5038

3✔
5039
        conn, err := brontide.Dial(
3✔
5040
                s.identityECDH, addr, timeout, s.cfg.net.Dial,
3✔
5041
        )
3✔
5042
        if err != nil {
6✔
5043
                srvrLog.Errorf("Unable to connect to %v: %v", addr, err)
3✔
5044
                select {
3✔
5045
                case errChan <- err:
3✔
5046
                case <-s.quit:
×
5047
                }
5048
                return
3✔
5049
        }
5050

5051
        close(errChan)
3✔
5052

3✔
5053
        srvrLog.Tracef("Brontide dialer made local=%v, remote=%v",
3✔
5054
                conn.LocalAddr(), conn.RemoteAddr())
3✔
5055

3✔
5056
        s.OutboundPeerConnected(nil, conn)
3✔
5057
}
5058

5059
// DisconnectPeer sends the request to server to close the connection with peer
5060
// identified by public key.
5061
//
5062
// NOTE: This function is safe for concurrent access.
5063
func (s *server) DisconnectPeer(pubKey *btcec.PublicKey) error {
3✔
5064
        pubBytes := pubKey.SerializeCompressed()
3✔
5065
        pubStr := string(pubBytes)
3✔
5066

3✔
5067
        s.mu.Lock()
3✔
5068
        defer s.mu.Unlock()
3✔
5069

3✔
5070
        // Check that were actually connected to this peer. If not, then we'll
3✔
5071
        // exit in an error as we can't disconnect from a peer that we're not
3✔
5072
        // currently connected to.
3✔
5073
        peer, err := s.findPeerByPubStr(pubStr)
3✔
5074
        if err == ErrPeerNotConnected {
6✔
5075
                return fmt.Errorf("peer %x is not connected", pubBytes)
3✔
5076
        }
3✔
5077

5078
        srvrLog.Infof("Disconnecting from %v", peer)
3✔
5079

3✔
5080
        s.cancelConnReqs(pubStr, nil)
3✔
5081

3✔
5082
        // If this peer was formerly a persistent connection, then we'll remove
3✔
5083
        // them from this map so we don't attempt to re-connect after we
3✔
5084
        // disconnect.
3✔
5085
        delete(s.persistentPeers, pubStr)
3✔
5086
        delete(s.persistentPeersBackoff, pubStr)
3✔
5087

3✔
5088
        // Remove the peer by calling Disconnect. Previously this was done with
3✔
5089
        // removePeer, which bypassed the peerTerminationWatcher.
3✔
5090
        peer.Disconnect(fmt.Errorf("server: DisconnectPeer called"))
3✔
5091

3✔
5092
        return nil
3✔
5093
}
5094

5095
// OpenChannel sends a request to the server to open a channel to the specified
5096
// peer identified by nodeKey with the passed channel funding parameters.
5097
//
5098
// NOTE: This function is safe for concurrent access.
5099
func (s *server) OpenChannel(
5100
        req *funding.InitFundingMsg) (chan *lnrpc.OpenStatusUpdate, chan error) {
3✔
5101

3✔
5102
        // The updateChan will have a buffer of 2, since we expect a ChanPending
3✔
5103
        // + a ChanOpen update, and we want to make sure the funding process is
3✔
5104
        // not blocked if the caller is not reading the updates.
3✔
5105
        req.Updates = make(chan *lnrpc.OpenStatusUpdate, 2)
3✔
5106
        req.Err = make(chan error, 1)
3✔
5107

3✔
5108
        // First attempt to locate the target peer to open a channel with, if
3✔
5109
        // we're unable to locate the peer then this request will fail.
3✔
5110
        pubKeyBytes := req.TargetPubkey.SerializeCompressed()
3✔
5111
        s.mu.RLock()
3✔
5112
        peer, ok := s.peersByPub[string(pubKeyBytes)]
3✔
5113
        if !ok {
3✔
5114
                s.mu.RUnlock()
×
5115

×
5116
                req.Err <- fmt.Errorf("peer %x is not online", pubKeyBytes)
×
5117
                return req.Updates, req.Err
×
5118
        }
×
5119
        req.Peer = peer
3✔
5120
        s.mu.RUnlock()
3✔
5121

3✔
5122
        // We'll wait until the peer is active before beginning the channel
3✔
5123
        // opening process.
3✔
5124
        select {
3✔
5125
        case <-peer.ActiveSignal():
3✔
5126
        case <-peer.QuitSignal():
×
5127
                req.Err <- fmt.Errorf("peer %x disconnected", pubKeyBytes)
×
5128
                return req.Updates, req.Err
×
5129
        case <-s.quit:
×
5130
                req.Err <- ErrServerShuttingDown
×
5131
                return req.Updates, req.Err
×
5132
        }
5133

5134
        // If the fee rate wasn't specified at this point we fail the funding
5135
        // because of the missing fee rate information. The caller of the
5136
        // `OpenChannel` method needs to make sure that default values for the
5137
        // fee rate are set beforehand.
5138
        if req.FundingFeePerKw == 0 {
3✔
5139
                req.Err <- fmt.Errorf("no FundingFeePerKw specified for " +
×
5140
                        "the channel opening transaction")
×
5141

×
5142
                return req.Updates, req.Err
×
5143
        }
×
5144

5145
        // Spawn a goroutine to send the funding workflow request to the funding
5146
        // manager. This allows the server to continue handling queries instead
5147
        // of blocking on this request which is exported as a synchronous
5148
        // request to the outside world.
5149
        go s.fundingMgr.InitFundingWorkflow(req)
3✔
5150

3✔
5151
        return req.Updates, req.Err
3✔
5152
}
5153

5154
// Peers returns a slice of all active peers.
5155
//
5156
// NOTE: This function is safe for concurrent access.
5157
func (s *server) Peers() []*peer.Brontide {
3✔
5158
        s.mu.RLock()
3✔
5159
        defer s.mu.RUnlock()
3✔
5160

3✔
5161
        peers := make([]*peer.Brontide, 0, len(s.peersByPub))
3✔
5162
        for _, peer := range s.peersByPub {
6✔
5163
                peers = append(peers, peer)
3✔
5164
        }
3✔
5165

5166
        return peers
3✔
5167
}
5168

5169
// computeNextBackoff uses a truncated exponential backoff to compute the next
5170
// backoff using the value of the exiting backoff. The returned duration is
5171
// randomized in either direction by 1/20 to prevent tight loops from
5172
// stabilizing.
5173
func computeNextBackoff(currBackoff, maxBackoff time.Duration) time.Duration {
3✔
5174
        // Double the current backoff, truncating if it exceeds our maximum.
3✔
5175
        nextBackoff := 2 * currBackoff
3✔
5176
        if nextBackoff > maxBackoff {
6✔
5177
                nextBackoff = maxBackoff
3✔
5178
        }
3✔
5179

5180
        // Using 1/10 of our duration as a margin, compute a random offset to
5181
        // avoid the nodes entering connection cycles.
5182
        margin := nextBackoff / 10
3✔
5183

3✔
5184
        var wiggle big.Int
3✔
5185
        wiggle.SetUint64(uint64(margin))
3✔
5186
        if _, err := rand.Int(rand.Reader, &wiggle); err != nil {
3✔
5187
                // Randomizing is not mission critical, so we'll just return the
×
5188
                // current backoff.
×
5189
                return nextBackoff
×
5190
        }
×
5191

5192
        // Otherwise add in our wiggle, but subtract out half of the margin so
5193
        // that the backoff can tweaked by 1/20 in either direction.
5194
        return nextBackoff + (time.Duration(wiggle.Uint64()) - margin/2)
3✔
5195
}
5196

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

5201
// fetchNodeAdvertisedAddrs attempts to fetch the advertised addresses of a node.
5202
func (s *server) fetchNodeAdvertisedAddrs(pub *btcec.PublicKey) ([]net.Addr, error) {
3✔
5203
        vertex, err := route.NewVertexFromBytes(pub.SerializeCompressed())
3✔
5204
        if err != nil {
3✔
5205
                return nil, err
×
5206
        }
×
5207

5208
        node, err := s.graphDB.FetchLightningNode(vertex)
3✔
5209
        if err != nil {
6✔
5210
                return nil, err
3✔
5211
        }
3✔
5212

5213
        if len(node.Addresses) == 0 {
6✔
5214
                return nil, errNoAdvertisedAddr
3✔
5215
        }
3✔
5216

5217
        return node.Addresses, nil
3✔
5218
}
5219

5220
// fetchLastChanUpdate returns a function which is able to retrieve our latest
5221
// channel update for a target channel.
5222
func (s *server) fetchLastChanUpdate() func(lnwire.ShortChannelID) (
5223
        *lnwire.ChannelUpdate1, error) {
3✔
5224

3✔
5225
        ourPubKey := s.identityECDH.PubKey().SerializeCompressed()
3✔
5226
        return func(cid lnwire.ShortChannelID) (*lnwire.ChannelUpdate1, error) {
6✔
5227
                info, edge1, edge2, err := s.graphBuilder.GetChannelByID(cid)
3✔
5228
                if err != nil {
6✔
5229
                        return nil, err
3✔
5230
                }
3✔
5231

5232
                return netann.ExtractChannelUpdate(
3✔
5233
                        ourPubKey[:], info, edge1, edge2,
3✔
5234
                )
3✔
5235
        }
5236
}
5237

5238
// applyChannelUpdate applies the channel update to the different sub-systems of
5239
// the server. The useAlias boolean denotes whether or not to send an alias in
5240
// place of the real SCID.
5241
func (s *server) applyChannelUpdate(update *lnwire.ChannelUpdate1,
5242
        op *wire.OutPoint, useAlias bool) error {
3✔
5243

3✔
5244
        var (
3✔
5245
                peerAlias    *lnwire.ShortChannelID
3✔
5246
                defaultAlias lnwire.ShortChannelID
3✔
5247
        )
3✔
5248

3✔
5249
        chanID := lnwire.NewChanIDFromOutPoint(*op)
3✔
5250

3✔
5251
        // Fetch the peer's alias from the lnwire.ChannelID so it can be used
3✔
5252
        // in the ChannelUpdate if it hasn't been announced yet.
3✔
5253
        if useAlias {
6✔
5254
                foundAlias, _ := s.aliasMgr.GetPeerAlias(chanID)
3✔
5255
                if foundAlias != defaultAlias {
6✔
5256
                        peerAlias = &foundAlias
3✔
5257
                }
3✔
5258
        }
5259

5260
        errChan := s.authGossiper.ProcessLocalAnnouncement(
3✔
5261
                update, discovery.RemoteAlias(peerAlias),
3✔
5262
        )
3✔
5263
        select {
3✔
5264
        case err := <-errChan:
3✔
5265
                return err
3✔
5266
        case <-s.quit:
×
5267
                return ErrServerShuttingDown
×
5268
        }
5269
}
5270

5271
// SendCustomMessage sends a custom message to the peer with the specified
5272
// pubkey.
5273
func (s *server) SendCustomMessage(peerPub [33]byte, msgType lnwire.MessageType,
5274
        data []byte) error {
3✔
5275

3✔
5276
        peer, err := s.FindPeerByPubStr(string(peerPub[:]))
3✔
5277
        if err != nil {
3✔
5278
                return err
×
5279
        }
×
5280

5281
        // We'll wait until the peer is active.
5282
        select {
3✔
5283
        case <-peer.ActiveSignal():
3✔
5284
        case <-peer.QuitSignal():
×
5285
                return fmt.Errorf("peer %x disconnected", peerPub)
×
5286
        case <-s.quit:
×
5287
                return ErrServerShuttingDown
×
5288
        }
5289

5290
        msg, err := lnwire.NewCustom(msgType, data)
3✔
5291
        if err != nil {
6✔
5292
                return err
3✔
5293
        }
3✔
5294

5295
        // Send the message as low-priority. For now we assume that all
5296
        // application-defined message are low priority.
5297
        return peer.SendMessageLazy(true, msg)
3✔
5298
}
5299

5300
// newSweepPkScriptGen creates closure that generates a new public key script
5301
// which should be used to sweep any funds into the on-chain wallet.
5302
// Specifically, the script generated is a version 0, pay-to-witness-pubkey-hash
5303
// (p2wkh) output.
5304
func newSweepPkScriptGen(
5305
        wallet lnwallet.WalletController,
5306
        netParams *chaincfg.Params) func() fn.Result[lnwallet.AddrWithKey] {
3✔
5307

3✔
5308
        return func() fn.Result[lnwallet.AddrWithKey] {
6✔
5309
                sweepAddr, err := wallet.NewAddress(
3✔
5310
                        lnwallet.TaprootPubkey, false,
3✔
5311
                        lnwallet.DefaultAccountName,
3✔
5312
                )
3✔
5313
                if err != nil {
3✔
5314
                        return fn.Err[lnwallet.AddrWithKey](err)
×
5315
                }
×
5316

5317
                addr, err := txscript.PayToAddrScript(sweepAddr)
3✔
5318
                if err != nil {
3✔
5319
                        return fn.Err[lnwallet.AddrWithKey](err)
×
5320
                }
×
5321

5322
                internalKeyDesc, err := lnwallet.InternalKeyForAddr(
3✔
5323
                        wallet, netParams, addr,
3✔
5324
                )
3✔
5325
                if err != nil {
3✔
5326
                        return fn.Err[lnwallet.AddrWithKey](err)
×
5327
                }
×
5328

5329
                return fn.Ok(lnwallet.AddrWithKey{
3✔
5330
                        DeliveryAddress: addr,
3✔
5331
                        InternalKey:     internalKeyDesc,
3✔
5332
                })
3✔
5333
        }
5334
}
5335

5336
// shouldPeerBootstrap returns true if we should attempt to perform peer
5337
// bootstrapping to actively seek our peers using the set of active network
5338
// bootstrappers.
5339
func shouldPeerBootstrap(cfg *Config) bool {
9✔
5340
        isSimnet := cfg.Bitcoin.SimNet
9✔
5341
        isSignet := cfg.Bitcoin.SigNet
9✔
5342
        isRegtest := cfg.Bitcoin.RegTest
9✔
5343
        isDevNetwork := isSimnet || isSignet || isRegtest
9✔
5344

9✔
5345
        // TODO(yy): remove the check on simnet/regtest such that the itest is
9✔
5346
        // covering the bootstrapping process.
9✔
5347
        return !cfg.NoNetBootstrap && !isDevNetwork
9✔
5348
}
9✔
5349

5350
// fetchClosedChannelSCIDs returns a set of SCIDs that have their force closing
5351
// finished.
5352
func (s *server) fetchClosedChannelSCIDs() map[lnwire.ShortChannelID]struct{} {
3✔
5353
        // Get a list of closed channels.
3✔
5354
        channels, err := s.chanStateDB.FetchClosedChannels(false)
3✔
5355
        if err != nil {
3✔
5356
                srvrLog.Errorf("Failed to fetch closed channels: %v", err)
×
5357
                return nil
×
5358
        }
×
5359

5360
        // Save the SCIDs in a map.
5361
        closedSCIDs := make(map[lnwire.ShortChannelID]struct{}, len(channels))
3✔
5362
        for _, c := range channels {
6✔
5363
                // If the channel is not pending, its FC has been finalized.
3✔
5364
                if !c.IsPending {
6✔
5365
                        closedSCIDs[c.ShortChanID] = struct{}{}
3✔
5366
                }
3✔
5367
        }
5368

5369
        // Double check whether the reported closed channel has indeed finished
5370
        // closing.
5371
        //
5372
        // NOTE: There are misalignments regarding when a channel's FC is
5373
        // marked as finalized. We double check the pending channels to make
5374
        // sure the returned SCIDs are indeed terminated.
5375
        //
5376
        // TODO(yy): fix the misalignments in `FetchClosedChannels`.
5377
        pendings, err := s.chanStateDB.FetchPendingChannels()
3✔
5378
        if err != nil {
3✔
5379
                srvrLog.Errorf("Failed to fetch pending channels: %v", err)
×
5380
                return nil
×
5381
        }
×
5382

5383
        for _, c := range pendings {
6✔
5384
                if _, ok := closedSCIDs[c.ShortChannelID]; !ok {
6✔
5385
                        continue
3✔
5386
                }
5387

5388
                // If the channel is still reported as pending, remove it from
5389
                // the map.
5390
                delete(closedSCIDs, c.ShortChannelID)
×
5391

×
5392
                srvrLog.Warnf("Channel=%v is prematurely marked as finalized",
×
5393
                        c.ShortChannelID)
×
5394
        }
5395

5396
        return closedSCIDs
3✔
5397
}
5398

5399
// getStartingBeat returns the current beat. This is used during the startup to
5400
// initialize blockbeat consumers.
5401
func (s *server) getStartingBeat() (*chainio.Beat, error) {
3✔
5402
        // beat is the current blockbeat.
3✔
5403
        var beat *chainio.Beat
3✔
5404

3✔
5405
        // We should get a notification with the current best block immediately
3✔
5406
        // by passing a nil block.
3✔
5407
        blockEpochs, err := s.cc.ChainNotifier.RegisterBlockEpochNtfn(nil)
3✔
5408
        if err != nil {
3✔
5409
                return beat, fmt.Errorf("register block epoch ntfn: %w", err)
×
5410
        }
×
5411
        defer blockEpochs.Cancel()
3✔
5412

3✔
5413
        // We registered for the block epochs with a nil request. The notifier
3✔
5414
        // should send us the current best block immediately. So we need to
3✔
5415
        // wait for it here because we need to know the current best height.
3✔
5416
        select {
3✔
5417
        case bestBlock := <-blockEpochs.Epochs:
3✔
5418
                srvrLog.Infof("Received initial block %v at height %d",
3✔
5419
                        bestBlock.Hash, bestBlock.Height)
3✔
5420

3✔
5421
                // Update the current blockbeat.
3✔
5422
                beat = chainio.NewBeat(*bestBlock)
3✔
5423

5424
        case <-s.quit:
×
5425
                srvrLog.Debug("LND shutting down")
×
5426
        }
5427

5428
        return beat, nil
3✔
5429
}
5430

5431
// ChanHasRbfCoopCloser returns true if the channel as identifier by the channel
5432
// point has an active RBF chan closer.
5433
func (s *server) ChanHasRbfCoopCloser(peerPub *btcec.PublicKey,
5434
        chanPoint wire.OutPoint) bool {
3✔
5435

3✔
5436
        pubBytes := peerPub.SerializeCompressed()
3✔
5437

3✔
5438
        s.mu.RLock()
3✔
5439
        targetPeer, ok := s.peersByPub[string(pubBytes)]
3✔
5440
        s.mu.RUnlock()
3✔
5441
        if !ok {
3✔
5442
                return false
×
5443
        }
×
5444

5445
        return targetPeer.ChanHasRbfCoopCloser(chanPoint)
3✔
5446
}
5447

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

3✔
5456
        // First, we'll attempt to look up the channel based on it's
3✔
5457
        // ChannelPoint.
3✔
5458
        channel, err := s.chanStateDB.FetchChannel(chanPoint)
3✔
5459
        if err != nil {
3✔
5460
                return nil, fmt.Errorf("unable to fetch channel: %w", err)
×
5461
        }
×
5462

5463
        // From the channel, we can now get the pubkey of the peer, then use
5464
        // that to eventually get the chan closer.
5465
        peerPub := channel.IdentityPub.SerializeCompressed()
3✔
5466

3✔
5467
        // Now that we have the peer pub, we can look up the peer itself.
3✔
5468
        s.mu.RLock()
3✔
5469
        targetPeer, ok := s.peersByPub[string(peerPub)]
3✔
5470
        s.mu.RUnlock()
3✔
5471
        if !ok {
3✔
5472
                return nil, fmt.Errorf("peer for ChannelPoint(%v) is "+
×
5473
                        "not online", chanPoint)
×
5474
        }
×
5475

5476
        closeUpdates, err := targetPeer.TriggerCoopCloseRbfBump(
3✔
5477
                ctx, chanPoint, feeRate, deliveryScript,
3✔
5478
        )
3✔
5479
        if err != nil {
3✔
5480
                return nil, fmt.Errorf("unable to trigger coop rbf fee bump: "+
×
5481
                        "%w", err)
×
5482
        }
×
5483

5484
        return closeUpdates, nil
3✔
5485
}
5486

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

3✔
5495
        // If the channel is present in the switch, then the request should flow
3✔
5496
        // through the switch instead.
3✔
5497
        chanID := lnwire.NewChanIDFromOutPoint(chanPoint)
3✔
5498
        if _, err := s.htlcSwitch.GetLink(chanID); err == nil {
3✔
5499
                return nil, fmt.Errorf("ChannelPoint(%v) is active in link, "+
×
5500
                        "invalid request", chanPoint)
×
5501
        }
×
5502

5503
        // At this point, we know that the channel isn't present in the link, so
5504
        // we'll check to see if we have an entry in the active chan closer map.
5505
        updates, err := s.attemptCoopRbfFeeBump(
3✔
5506
                ctx, chanPoint, feeRate, deliveryScript,
3✔
5507
        )
3✔
5508
        if err != nil {
3✔
5509
                return nil, fmt.Errorf("unable to attempt coop rbf fee bump "+
×
5510
                        "ChannelPoint(%v)", chanPoint)
×
5511
        }
×
5512

5513
        return updates, nil
3✔
5514
}
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