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

lightningnetwork / lnd / 16293817609

15 Jul 2025 12:53PM UTC coverage: 57.584% (-9.8%) from 67.338%
16293817609

Pull #10031

github

web-flow
Merge 8fd26da8b into df6c02e3a
Pull Request #10031: Skip unnecessary disconnect and wait for disconnect to finish in shutdown

36 of 40 new or added lines in 2 files covered. (90.0%)

28482 existing lines in 458 files now uncovered.

98681 of 171370 relevant lines covered (57.58%)

1.79 hits per line

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

77.11
/peer/brontide.go
1
package peer
2

3
import (
4
        "bytes"
5
        "container/list"
6
        "context"
7
        "errors"
8
        "fmt"
9
        "math/rand"
10
        "net"
11
        "strings"
12
        "sync"
13
        "sync/atomic"
14
        "time"
15

16
        "github.com/btcsuite/btcd/btcec/v2"
17
        "github.com/btcsuite/btcd/chaincfg/chainhash"
18
        "github.com/btcsuite/btcd/connmgr"
19
        "github.com/btcsuite/btcd/txscript"
20
        "github.com/btcsuite/btcd/wire"
21
        "github.com/btcsuite/btclog/v2"
22
        "github.com/davecgh/go-spew/spew"
23
        "github.com/lightningnetwork/lnd/buffer"
24
        "github.com/lightningnetwork/lnd/chainntnfs"
25
        "github.com/lightningnetwork/lnd/channeldb"
26
        "github.com/lightningnetwork/lnd/channelnotifier"
27
        "github.com/lightningnetwork/lnd/contractcourt"
28
        "github.com/lightningnetwork/lnd/discovery"
29
        "github.com/lightningnetwork/lnd/feature"
30
        "github.com/lightningnetwork/lnd/fn/v2"
31
        "github.com/lightningnetwork/lnd/funding"
32
        graphdb "github.com/lightningnetwork/lnd/graph/db"
33
        "github.com/lightningnetwork/lnd/graph/db/models"
34
        "github.com/lightningnetwork/lnd/htlcswitch"
35
        "github.com/lightningnetwork/lnd/htlcswitch/hodl"
36
        "github.com/lightningnetwork/lnd/htlcswitch/hop"
37
        "github.com/lightningnetwork/lnd/input"
38
        "github.com/lightningnetwork/lnd/invoices"
39
        "github.com/lightningnetwork/lnd/keychain"
40
        "github.com/lightningnetwork/lnd/lnpeer"
41
        "github.com/lightningnetwork/lnd/lntypes"
42
        "github.com/lightningnetwork/lnd/lnutils"
43
        "github.com/lightningnetwork/lnd/lnwallet"
44
        "github.com/lightningnetwork/lnd/lnwallet/chainfee"
45
        "github.com/lightningnetwork/lnd/lnwallet/chancloser"
46
        "github.com/lightningnetwork/lnd/lnwire"
47
        "github.com/lightningnetwork/lnd/msgmux"
48
        "github.com/lightningnetwork/lnd/netann"
49
        "github.com/lightningnetwork/lnd/pool"
50
        "github.com/lightningnetwork/lnd/protofsm"
51
        "github.com/lightningnetwork/lnd/queue"
52
        "github.com/lightningnetwork/lnd/subscribe"
53
        "github.com/lightningnetwork/lnd/ticker"
54
        "github.com/lightningnetwork/lnd/tlv"
55
        "github.com/lightningnetwork/lnd/watchtower/wtclient"
56
)
57

58
const (
59
        // pingInterval is the interval at which ping messages are sent.
60
        pingInterval = 1 * time.Minute
61

62
        // pingTimeout is the amount of time we will wait for a pong response
63
        // before considering the peer to be unresponsive.
64
        //
65
        // This MUST be a smaller value than the pingInterval.
66
        pingTimeout = 30 * time.Second
67

68
        // idleTimeout is the duration of inactivity before we time out a peer.
69
        idleTimeout = 5 * time.Minute
70

71
        // writeMessageTimeout is the timeout used when writing a message to the
72
        // peer.
73
        writeMessageTimeout = 5 * time.Second
74

75
        // readMessageTimeout is the timeout used when reading a message from a
76
        // peer.
77
        readMessageTimeout = 5 * time.Second
78

79
        // handshakeTimeout is the timeout used when waiting for the peer's init
80
        // message.
81
        handshakeTimeout = 15 * time.Second
82

83
        // ErrorBufferSize is the number of historic peer errors that we store.
84
        ErrorBufferSize = 10
85

86
        // pongSizeCeiling is the upper bound on a uniformly distributed random
87
        // variable that we use for requesting pong responses. We don't use the
88
        // MaxPongBytes (upper bound accepted by the protocol) because it is
89
        // needlessly wasteful of precious Tor bandwidth for little to no gain.
90
        pongSizeCeiling = 4096
91

92
        // torTimeoutMultiplier is the scaling factor we use on network timeouts
93
        // for Tor peers.
94
        torTimeoutMultiplier = 3
95

96
        // msgStreamSize is the size of the message streams.
97
        msgStreamSize = 50
98
)
99

100
var (
101
        // ErrChannelNotFound is an error returned when a channel is queried and
102
        // either the Brontide doesn't know of it, or the channel in question
103
        // is pending.
104
        ErrChannelNotFound = fmt.Errorf("channel not found")
105
)
106

107
// outgoingMsg packages an lnwire.Message to be sent out on the wire, along with
108
// a buffered channel which will be sent upon once the write is complete. This
109
// buffered channel acts as a semaphore to be used for synchronization purposes.
110
type outgoingMsg struct {
111
        priority bool
112
        msg      lnwire.Message
113
        errChan  chan error // MUST be buffered.
114
}
115

116
// newChannelMsg packages a channeldb.OpenChannel with a channel that allows
117
// the receiver of the request to report when the channel creation process has
118
// completed.
119
type newChannelMsg struct {
120
        // channel is used when the pending channel becomes active.
121
        channel *lnpeer.NewChannel
122

123
        // channelID is used when there's a new pending channel.
124
        channelID lnwire.ChannelID
125

126
        err chan error
127
}
128

129
type customMsg struct {
130
        peer [33]byte
131
        msg  lnwire.Custom
132
}
133

134
// closeMsg is a wrapper struct around any wire messages that deal with the
135
// cooperative channel closure negotiation process. This struct includes the
136
// raw channel ID targeted along with the original message.
137
type closeMsg struct {
138
        cid lnwire.ChannelID
139
        msg lnwire.Message
140
}
141

142
// PendingUpdate describes the pending state of a closing channel.
143
type PendingUpdate struct {
144
        // Txid is the txid of the closing transaction.
145
        Txid []byte
146

147
        // OutputIndex is the output index of our output in the closing
148
        // transaction.
149
        OutputIndex uint32
150

151
        // FeePerVByte is an optional field, that is set only when the new RBF
152
        // coop close flow is used. This indicates the new closing fee rate on
153
        // the closing transaction.
154
        FeePerVbyte fn.Option[chainfee.SatPerVByte]
155

156
        // IsLocalCloseTx is an optional field that indicates if this update is
157
        // sent for our local close txn, or the close txn of the remote party.
158
        // This is only set if the new RBF coop close flow is used.
159
        IsLocalCloseTx fn.Option[bool]
160
}
161

162
// ChannelCloseUpdate contains the outcome of the close channel operation.
163
type ChannelCloseUpdate struct {
164
        ClosingTxid []byte
165
        Success     bool
166

167
        // LocalCloseOutput is an optional, additional output on the closing
168
        // transaction that the local party should be paid to. This will only be
169
        // populated if the local balance isn't dust.
170
        LocalCloseOutput fn.Option[chancloser.CloseOutput]
171

172
        // RemoteCloseOutput is an optional, additional output on the closing
173
        // transaction that the remote party should be paid to. This will only
174
        // be populated if the remote balance isn't dust.
175
        RemoteCloseOutput fn.Option[chancloser.CloseOutput]
176

177
        // AuxOutputs is an optional set of additional outputs that might be
178
        // included in the closing transaction. These are used for custom
179
        // channel types.
180
        AuxOutputs fn.Option[chancloser.AuxCloseOutputs]
181
}
182

183
// TimestampedError is a timestamped error that is used to store the most recent
184
// errors we have experienced with our peers.
185
type TimestampedError struct {
186
        Error     error
187
        Timestamp time.Time
188
}
189

190
// Config defines configuration fields that are necessary for a peer object
191
// to function.
192
type Config struct {
193
        // Conn is the underlying network connection for this peer.
194
        Conn MessageConn
195

196
        // ConnReq stores information related to the persistent connection request
197
        // for this peer.
198
        ConnReq *connmgr.ConnReq
199

200
        // PubKeyBytes is the serialized, compressed public key of this peer.
201
        PubKeyBytes [33]byte
202

203
        // Addr is the network address of the peer.
204
        Addr *lnwire.NetAddress
205

206
        // Inbound indicates whether or not the peer is an inbound peer.
207
        Inbound bool
208

209
        // Features is the set of features that we advertise to the remote party.
210
        Features *lnwire.FeatureVector
211

212
        // LegacyFeatures is the set of features that we advertise to the remote
213
        // peer for backwards compatibility. Nodes that have not implemented
214
        // flat features will still be able to read our feature bits from the
215
        // legacy global field, but we will also advertise everything in the
216
        // default features field.
217
        LegacyFeatures *lnwire.FeatureVector
218

219
        // OutgoingCltvRejectDelta defines the number of blocks before expiry of
220
        // an htlc where we don't offer it anymore.
221
        OutgoingCltvRejectDelta uint32
222

223
        // ChanActiveTimeout specifies the duration the peer will wait to request
224
        // a channel reenable, beginning from the time the peer was started.
225
        ChanActiveTimeout time.Duration
226

227
        // ErrorBuffer stores a set of errors related to a peer. It contains error
228
        // messages that our peer has recently sent us over the wire and records of
229
        // unknown messages that were sent to us so that we can have a full track
230
        // record of the communication errors we have had with our peer. If we
231
        // choose to disconnect from a peer, it also stores the reason we had for
232
        // disconnecting.
233
        ErrorBuffer *queue.CircularBuffer
234

235
        // WritePool is the task pool that manages reuse of write buffers. Write
236
        // tasks are submitted to the pool in order to conserve the total number of
237
        // write buffers allocated at any one time, and decouple write buffer
238
        // allocation from the peer life cycle.
239
        WritePool *pool.Write
240

241
        // ReadPool is the task pool that manages reuse of read buffers.
242
        ReadPool *pool.Read
243

244
        // Switch is a pointer to the htlcswitch. It is used to setup, get, and
245
        // tear-down ChannelLinks.
246
        Switch messageSwitch
247

248
        // InterceptSwitch is a pointer to the InterceptableSwitch, a wrapper around
249
        // the regular Switch. We only export it here to pass ForwardPackets to the
250
        // ChannelLinkConfig.
251
        InterceptSwitch *htlcswitch.InterceptableSwitch
252

253
        // ChannelDB is used to fetch opened channels, and closed channels.
254
        ChannelDB *channeldb.ChannelStateDB
255

256
        // ChannelGraph is a pointer to the channel graph which is used to
257
        // query information about the set of known active channels.
258
        ChannelGraph *graphdb.ChannelGraph
259

260
        // ChainArb is used to subscribe to channel events, update contract signals,
261
        // and force close channels.
262
        ChainArb *contractcourt.ChainArbitrator
263

264
        // AuthGossiper is needed so that the Brontide impl can register with the
265
        // gossiper and process remote channel announcements.
266
        AuthGossiper *discovery.AuthenticatedGossiper
267

268
        // ChanStatusMgr is used to set or un-set the disabled bit in channel
269
        // updates.
270
        ChanStatusMgr *netann.ChanStatusManager
271

272
        // ChainIO is used to retrieve the best block.
273
        ChainIO lnwallet.BlockChainIO
274

275
        // FeeEstimator is used to compute our target ideal fee-per-kw when
276
        // initializing the coop close process.
277
        FeeEstimator chainfee.Estimator
278

279
        // Signer is used when creating *lnwallet.LightningChannel instances.
280
        Signer input.Signer
281

282
        // SigPool is used when creating *lnwallet.LightningChannel instances.
283
        SigPool *lnwallet.SigPool
284

285
        // Wallet is used to publish transactions and generates delivery
286
        // scripts during the coop close process.
287
        Wallet *lnwallet.LightningWallet
288

289
        // ChainNotifier is used to receive confirmations of a coop close
290
        // transaction.
291
        ChainNotifier chainntnfs.ChainNotifier
292

293
        // BestBlockView is used to efficiently query for up-to-date
294
        // blockchain state information
295
        BestBlockView chainntnfs.BestBlockView
296

297
        // RoutingPolicy is used to set the forwarding policy for links created by
298
        // the Brontide.
299
        RoutingPolicy models.ForwardingPolicy
300

301
        // Sphinx is used when setting up ChannelLinks so they can decode sphinx
302
        // onion blobs.
303
        Sphinx *hop.OnionProcessor
304

305
        // WitnessBeacon is used when setting up ChannelLinks so they can add any
306
        // preimages that they learn.
307
        WitnessBeacon contractcourt.WitnessBeacon
308

309
        // Invoices is passed to the ChannelLink on creation and handles all
310
        // invoice-related logic.
311
        Invoices *invoices.InvoiceRegistry
312

313
        // ChannelNotifier is used by the link to notify other sub-systems about
314
        // channel-related events and by the Brontide to subscribe to
315
        // ActiveLinkEvents.
316
        ChannelNotifier *channelnotifier.ChannelNotifier
317

318
        // HtlcNotifier is used when creating a ChannelLink.
319
        HtlcNotifier *htlcswitch.HtlcNotifier
320

321
        // TowerClient is used to backup revoked states.
322
        TowerClient wtclient.ClientManager
323

324
        // DisconnectPeer is used to disconnect this peer if the cooperative close
325
        // process fails.
326
        DisconnectPeer func(*btcec.PublicKey) error
327

328
        // GenNodeAnnouncement is used to send our node announcement to the remote
329
        // on startup.
330
        GenNodeAnnouncement func(...netann.NodeAnnModifier) (
331
                lnwire.NodeAnnouncement, error)
332

333
        // PrunePersistentPeerConnection is used to remove all internal state
334
        // related to this peer in the server.
335
        PrunePersistentPeerConnection func([33]byte)
336

337
        // FetchLastChanUpdate fetches our latest channel update for a target
338
        // channel.
339
        FetchLastChanUpdate func(lnwire.ShortChannelID) (*lnwire.ChannelUpdate1,
340
                error)
341

342
        // FundingManager is an implementation of the funding.Controller interface.
343
        FundingManager funding.Controller
344

345
        // Hodl is used when creating ChannelLinks to specify HodlFlags as
346
        // breakpoints in dev builds.
347
        Hodl *hodl.Config
348

349
        // UnsafeReplay is used when creating ChannelLinks to specify whether or
350
        // not to replay adds on its commitment tx.
351
        UnsafeReplay bool
352

353
        // MaxOutgoingCltvExpiry is used when creating ChannelLinks and is the max
354
        // number of blocks that funds could be locked up for when forwarding
355
        // payments.
356
        MaxOutgoingCltvExpiry uint32
357

358
        // MaxChannelFeeAllocation is used when creating ChannelLinks and is the
359
        // maximum percentage of total funds that can be allocated to a channel's
360
        // commitment fee. This only applies for the initiator of the channel.
361
        MaxChannelFeeAllocation float64
362

363
        // MaxAnchorsCommitFeeRate is the maximum fee rate we'll use as an
364
        // initiator for anchor channel commitments.
365
        MaxAnchorsCommitFeeRate chainfee.SatPerKWeight
366

367
        // CoopCloseTargetConfs is the confirmation target that will be used
368
        // to estimate the fee rate to use during a cooperative channel
369
        // closure initiated by the remote peer.
370
        CoopCloseTargetConfs uint32
371

372
        // ServerPubKey is the serialized, compressed public key of our lnd node.
373
        // It is used to determine which policy (channel edge) to pass to the
374
        // ChannelLink.
375
        ServerPubKey [33]byte
376

377
        // ChannelCommitInterval is the maximum time that is allowed to pass between
378
        // receiving a channel state update and signing the next commitment.
379
        // Setting this to a longer duration allows for more efficient channel
380
        // operations at the cost of latency.
381
        ChannelCommitInterval time.Duration
382

383
        // PendingCommitInterval is the maximum time that is allowed to pass
384
        // while waiting for the remote party to revoke a locally initiated
385
        // commitment state. Setting this to a longer duration if a slow
386
        // response is expected from the remote party or large number of
387
        // payments are attempted at the same time.
388
        PendingCommitInterval time.Duration
389

390
        // ChannelCommitBatchSize is the maximum number of channel state updates
391
        // that is accumulated before signing a new commitment.
392
        ChannelCommitBatchSize uint32
393

394
        // HandleCustomMessage is called whenever a custom message is received
395
        // from the peer.
396
        HandleCustomMessage func(peer [33]byte, msg *lnwire.Custom) error
397

398
        // GetAliases is passed to created links so the Switch and link can be
399
        // aware of the channel's aliases.
400
        GetAliases func(base lnwire.ShortChannelID) []lnwire.ShortChannelID
401

402
        // RequestAlias allows the Brontide struct to request an alias to send
403
        // to the peer.
404
        RequestAlias func() (lnwire.ShortChannelID, error)
405

406
        // AddLocalAlias persists an alias to an underlying alias store.
407
        AddLocalAlias func(alias, base lnwire.ShortChannelID,
408
                gossip, liveUpdate bool) error
409

410
        // AuxLeafStore is an optional store that can be used to store auxiliary
411
        // leaves for certain custom channel types.
412
        AuxLeafStore fn.Option[lnwallet.AuxLeafStore]
413

414
        // AuxSigner is an optional signer that can be used to sign auxiliary
415
        // leaves for certain custom channel types.
416
        AuxSigner fn.Option[lnwallet.AuxSigner]
417

418
        // AuxResolver is an optional interface that can be used to modify the
419
        // way contracts are resolved.
420
        AuxResolver fn.Option[lnwallet.AuxContractResolver]
421

422
        // AuxTrafficShaper is an optional auxiliary traffic shaper that can be
423
        // used to manage the bandwidth of peer links.
424
        AuxTrafficShaper fn.Option[htlcswitch.AuxTrafficShaper]
425

426
        // PongBuf is a slice we'll reuse instead of allocating memory on the
427
        // heap. Since only reads will occur and no writes, there is no need
428
        // for any synchronization primitives. As a result, it's safe to share
429
        // this across multiple Peer struct instances.
430
        PongBuf []byte
431

432
        // Adds the option to disable forwarding payments in blinded routes
433
        // by failing back any blinding-related payloads as if they were
434
        // invalid.
435
        DisallowRouteBlinding bool
436

437
        // DisallowQuiescence is a flag that indicates whether the Brontide
438
        // should have the quiescence feature disabled.
439
        DisallowQuiescence bool
440

441
        // QuiescenceTimeout is the max duration that the channel can be
442
        // quiesced. Any dependent protocols (dynamic commitments, splicing,
443
        // etc.) must finish their operations under this timeout value,
444
        // otherwise the node will disconnect.
445
        QuiescenceTimeout time.Duration
446

447
        // MaxFeeExposure limits the number of outstanding fees in a channel.
448
        // This value will be passed to created links.
449
        MaxFeeExposure lnwire.MilliSatoshi
450

451
        // MsgRouter is an optional instance of the main message router that
452
        // the peer will use. If None, then a new default version will be used
453
        // in place.
454
        MsgRouter fn.Option[msgmux.Router]
455

456
        // AuxChanCloser is an optional instance of an abstraction that can be
457
        // used to modify the way the co-op close transaction is constructed.
458
        AuxChanCloser fn.Option[chancloser.AuxChanCloser]
459

460
        // ShouldFwdExpEndorsement is a closure that indicates whether
461
        // experimental endorsement signals should be set.
462
        ShouldFwdExpEndorsement func() bool
463

464
        // NoDisconnectOnPongFailure indicates whether the peer should *not* be
465
        // disconnected if a pong is not received in time or is mismatched.
466
        NoDisconnectOnPongFailure bool
467

468
        // Quit is the server's quit channel. If this is closed, we halt operation.
469
        Quit chan struct{}
470
}
471

472
// chanCloserFsm is a union-like type that can hold the two versions of co-op
473
// close we support: negotiation, and RBF based.
474
//
475
// TODO(roasbeef): rename to chancloser.Negotiator and chancloser.RBF?
476
type chanCloserFsm = fn.Either[*chancloser.ChanCloser, *chancloser.RbfChanCloser] //nolint:ll
477

478
// makeNegotiateCloser creates a new negotiate closer from a
479
// chancloser.ChanCloser.
480
func makeNegotiateCloser(chanCloser *chancloser.ChanCloser) chanCloserFsm {
3✔
481
        return fn.NewLeft[*chancloser.ChanCloser, *chancloser.RbfChanCloser](
3✔
482
                chanCloser,
3✔
483
        )
3✔
484
}
3✔
485

486
// makeRbfCloser creates a new RBF closer from a chancloser.RbfChanCloser.
487
func makeRbfCloser(rbfCloser *chancloser.RbfChanCloser) chanCloserFsm {
3✔
488
        return fn.NewRight[*chancloser.ChanCloser](
3✔
489
                rbfCloser,
3✔
490
        )
3✔
491
}
3✔
492

493
// Brontide is an active peer on the Lightning Network. This struct is responsible
494
// for managing any channel state related to this peer. To do so, it has
495
// several helper goroutines to handle events such as HTLC timeouts, new
496
// funding workflow, and detecting an uncooperative closure of any active
497
// channels.
498
type Brontide struct {
499
        // MUST be used atomically.
500
        started    int32
501
        disconnect int32
502

503
        // MUST be used atomically.
504
        bytesReceived uint64
505
        bytesSent     uint64
506

507
        // isTorConnection is a flag that indicates whether or not we believe
508
        // the remote peer is a tor connection. It is not always possible to
509
        // know this with certainty but we have heuristics we use that should
510
        // catch most cases.
511
        //
512
        // NOTE: We judge the tor-ness of a connection by if the remote peer has
513
        // ".onion" in the address OR if it's connected over localhost.
514
        // This will miss cases where our peer is connected to our clearnet
515
        // address over the tor network (via exit nodes). It will also misjudge
516
        // actual localhost connections as tor. We need to include this because
517
        // inbound connections to our tor address will appear to come from the
518
        // local socks5 proxy. This heuristic is only used to expand the timeout
519
        // window for peers so it is OK to misjudge this. If you use this field
520
        // for any other purpose you should seriously consider whether or not
521
        // this heuristic is good enough for your use case.
522
        isTorConnection bool
523

524
        pingManager *PingManager
525

526
        // lastPingPayload stores an unsafe pointer wrapped as an atomic
527
        // variable which points to the last payload the remote party sent us
528
        // as their ping.
529
        //
530
        // MUST be used atomically.
531
        lastPingPayload atomic.Value
532

533
        cfg Config
534

535
        // activeSignal when closed signals that the peer is now active and
536
        // ready to process messages.
537
        activeSignal chan struct{}
538

539
        // startTime is the time this peer connection was successfully established.
540
        // It will be zero for peers that did not successfully call Start().
541
        startTime time.Time
542

543
        // sendQueue is the channel which is used to queue outgoing messages to be
544
        // written onto the wire. Note that this channel is unbuffered.
545
        sendQueue chan outgoingMsg
546

547
        // outgoingQueue is a buffered channel which allows second/third party
548
        // objects to queue messages to be sent out on the wire.
549
        outgoingQueue chan outgoingMsg
550

551
        // activeChannels is a map which stores the state machines of all
552
        // active channels. Channels are indexed into the map by the txid of
553
        // the funding transaction which opened the channel.
554
        //
555
        // NOTE: On startup, pending channels are stored as nil in this map.
556
        // Confirmed channels have channel data populated in the map. This means
557
        // that accesses to this map should nil-check the LightningChannel to
558
        // see if this is a pending channel or not. The tradeoff here is either
559
        // having two maps everywhere (one for pending, one for confirmed chans)
560
        // or having an extra nil-check per access.
561
        activeChannels *lnutils.SyncMap[
562
                lnwire.ChannelID, *lnwallet.LightningChannel]
563

564
        // addedChannels tracks any new channels opened during this peer's
565
        // lifecycle. We use this to filter out these new channels when the time
566
        // comes to request a reenable for active channels, since they will have
567
        // waited a shorter duration.
568
        addedChannels *lnutils.SyncMap[lnwire.ChannelID, struct{}]
569

570
        // newActiveChannel is used by the fundingManager to send fully opened
571
        // channels to the source peer which handled the funding workflow.
572
        newActiveChannel chan *newChannelMsg
573

574
        // newPendingChannel is used by the fundingManager to send pending open
575
        // channels to the source peer which handled the funding workflow.
576
        newPendingChannel chan *newChannelMsg
577

578
        // removePendingChannel is used by the fundingManager to cancel pending
579
        // open channels to the source peer when the funding flow is failed.
580
        removePendingChannel chan *newChannelMsg
581

582
        // activeMsgStreams is a map from channel id to the channel streams that
583
        // proxy messages to individual, active links.
584
        activeMsgStreams map[lnwire.ChannelID]*msgStream
585

586
        // activeChanCloses is a map that keeps track of all the active
587
        // cooperative channel closures. Any channel closing messages are directed
588
        // to one of these active state machines. Once the channel has been closed,
589
        // the state machine will be deleted from the map.
590
        activeChanCloses *lnutils.SyncMap[lnwire.ChannelID, chanCloserFsm]
591

592
        // localCloseChanReqs is a channel in which any local requests to close
593
        // a particular channel are sent over.
594
        localCloseChanReqs chan *htlcswitch.ChanClose
595

596
        // linkFailures receives all reported channel failures from the switch,
597
        // and instructs the channelManager to clean remaining channel state.
598
        linkFailures chan linkFailureReport
599

600
        // chanCloseMsgs is a channel that any message related to channel
601
        // closures are sent over. This includes lnwire.Shutdown message as
602
        // well as lnwire.ClosingSigned messages.
603
        chanCloseMsgs chan *closeMsg
604

605
        // remoteFeatures is the feature vector received from the peer during
606
        // the connection handshake.
607
        remoteFeatures *lnwire.FeatureVector
608

609
        // resentChanSyncMsg is a set that keeps track of which channels we
610
        // have re-sent channel reestablishment messages for. This is done to
611
        // avoid getting into loop where both peers will respond to the other
612
        // peer's chansync message with its own over and over again.
613
        resentChanSyncMsg map[lnwire.ChannelID]struct{}
614

615
        // channelEventClient is the channel event subscription client that's
616
        // used to assist retry enabling the channels. This client is only
617
        // created when the reenableTimeout is no greater than 1 minute. Once
618
        // created, it is canceled once the reenabling has been finished.
619
        //
620
        // NOTE: we choose to create the client conditionally to avoid
621
        // potentially holding lots of un-consumed events.
622
        channelEventClient *subscribe.Client
623

624
        // msgRouter is an instance of the msgmux.Router which is used to send
625
        // off new wire messages for handing.
626
        msgRouter fn.Option[msgmux.Router]
627

628
        // globalMsgRouter is a flag that indicates whether we have a global
629
        // msg router. If so, then we don't worry about stopping the msg router
630
        // when a peer disconnects.
631
        globalMsgRouter bool
632

633
        startReady chan struct{}
634

635
        // cg is a helper that encapsulates a wait group and quit channel and
636
        // allows contexts that either block or cancel on those depending on
637
        // the use case.
638
        cg *fn.ContextGuard
639

640
        // log is a peer-specific logging instance.
641
        log btclog.Logger
642
}
643

644
// A compile-time check to ensure that Brontide satisfies the lnpeer.Peer
645
// interface.
646
var _ lnpeer.Peer = (*Brontide)(nil)
647

648
// NewBrontide creates a new Brontide from a peer.Config struct.
649
func NewBrontide(cfg Config) *Brontide {
3✔
650
        logPrefix := fmt.Sprintf("Peer(%x):", cfg.PubKeyBytes)
3✔
651

3✔
652
        // We have a global message router if one was passed in via the config.
3✔
653
        // In this case, we don't need to attempt to tear it down when the peer
3✔
654
        // is stopped.
3✔
655
        globalMsgRouter := cfg.MsgRouter.IsSome()
3✔
656

3✔
657
        // We'll either use the msg router instance passed in, or create a new
3✔
658
        // blank instance.
3✔
659
        msgRouter := cfg.MsgRouter.Alt(fn.Some[msgmux.Router](
3✔
660
                msgmux.NewMultiMsgRouter(),
3✔
661
        ))
3✔
662

3✔
663
        p := &Brontide{
3✔
664
                cfg:           cfg,
3✔
665
                activeSignal:  make(chan struct{}),
3✔
666
                sendQueue:     make(chan outgoingMsg),
3✔
667
                outgoingQueue: make(chan outgoingMsg),
3✔
668
                addedChannels: &lnutils.SyncMap[lnwire.ChannelID, struct{}]{},
3✔
669
                activeChannels: &lnutils.SyncMap[
3✔
670
                        lnwire.ChannelID, *lnwallet.LightningChannel,
3✔
671
                ]{},
3✔
672
                newActiveChannel:     make(chan *newChannelMsg, 1),
3✔
673
                newPendingChannel:    make(chan *newChannelMsg, 1),
3✔
674
                removePendingChannel: make(chan *newChannelMsg),
3✔
675

3✔
676
                activeMsgStreams: make(map[lnwire.ChannelID]*msgStream),
3✔
677
                activeChanCloses: &lnutils.SyncMap[
3✔
678
                        lnwire.ChannelID, chanCloserFsm,
3✔
679
                ]{},
3✔
680
                localCloseChanReqs: make(chan *htlcswitch.ChanClose),
3✔
681
                linkFailures:       make(chan linkFailureReport),
3✔
682
                chanCloseMsgs:      make(chan *closeMsg),
3✔
683
                resentChanSyncMsg:  make(map[lnwire.ChannelID]struct{}),
3✔
684
                startReady:         make(chan struct{}),
3✔
685
                log:                peerLog.WithPrefix(logPrefix),
3✔
686
                msgRouter:          msgRouter,
3✔
687
                globalMsgRouter:    globalMsgRouter,
3✔
688
                cg:                 fn.NewContextGuard(),
3✔
689
        }
3✔
690

3✔
691
        if cfg.Conn != nil && cfg.Conn.RemoteAddr() != nil {
6✔
692
                remoteAddr := cfg.Conn.RemoteAddr().String()
3✔
693
                p.isTorConnection = strings.Contains(remoteAddr, ".onion") ||
3✔
694
                        strings.Contains(remoteAddr, "127.0.0.1")
3✔
695
        }
3✔
696

697
        var (
3✔
698
                lastBlockHeader           *wire.BlockHeader
3✔
699
                lastSerializedBlockHeader [wire.MaxBlockHeaderPayload]byte
3✔
700
        )
3✔
701
        newPingPayload := func() []byte {
3✔
702
                // We query the BestBlockHeader from our BestBlockView each time
×
703
                // this is called, and update our serialized block header if
×
704
                // they differ.  Over time, we'll use this to disseminate the
×
705
                // latest block header between all our peers, which can later be
×
706
                // used to cross-check our own view of the network to mitigate
×
707
                // various types of eclipse attacks.
×
708
                header, err := p.cfg.BestBlockView.BestBlockHeader()
×
709
                if err != nil && header == lastBlockHeader {
×
710
                        return lastSerializedBlockHeader[:]
×
711
                }
×
712

713
                buf := bytes.NewBuffer(lastSerializedBlockHeader[0:0])
×
714
                err = header.Serialize(buf)
×
715
                if err == nil {
×
716
                        lastBlockHeader = header
×
717
                } else {
×
718
                        p.log.Warn("unable to serialize current block" +
×
719
                                "header for ping payload generation." +
×
720
                                "This should be impossible and means" +
×
721
                                "there is an implementation bug.")
×
722
                }
×
723

724
                return lastSerializedBlockHeader[:]
×
725
        }
726

727
        // TODO(roasbeef): make dynamic in order to create fake cover traffic.
728
        //
729
        // NOTE(proofofkeags): this was changed to be dynamic to allow better
730
        // pong identification, however, more thought is needed to make this
731
        // actually usable as a traffic decoy.
732
        randPongSize := func() uint16 {
3✔
733
                return uint16(
×
734
                        // We don't need cryptographic randomness here.
×
735
                        /* #nosec */
×
736
                        rand.Intn(pongSizeCeiling) + 1,
×
737
                )
×
738
        }
×
739

740
        p.pingManager = NewPingManager(&PingManagerConfig{
3✔
741
                NewPingPayload:   newPingPayload,
3✔
742
                NewPongSize:      randPongSize,
3✔
743
                IntervalDuration: p.scaleTimeout(pingInterval),
3✔
744
                TimeoutDuration:  p.scaleTimeout(pingTimeout),
3✔
745
                SendPing: func(ping *lnwire.Ping) {
3✔
746
                        p.queueMsg(ping, nil)
×
747
                },
×
748
                OnPongFailure: func(reason error,
749
                        timeWaitedForPong time.Duration,
750
                        lastKnownRTT time.Duration) {
×
751

×
752
                        logMsg := fmt.Sprintf("pong response "+
×
753
                                "failure for %s: %v. Time waited for this "+
×
754
                                "pong: %v. Last successful RTT: %v.",
×
755
                                p, reason, timeWaitedForPong, lastKnownRTT)
×
756

×
757
                        // If NoDisconnectOnPongFailure is true, we don't
×
758
                        // disconnect. Otherwise (if it's false, the default),
×
759
                        // we disconnect.
×
760
                        if p.cfg.NoDisconnectOnPongFailure {
×
761
                                p.log.Warnf("%s -- not disconnecting "+
×
762
                                        "due to config", logMsg)
×
763
                                return
×
764
                        }
×
765

766
                        p.log.Warnf("%s -- disconnecting", logMsg)
×
767

×
768
                        go p.Disconnect(fmt.Errorf("pong failure: %w", reason))
×
769
                },
770
        })
771

772
        return p
3✔
773
}
774

775
// Start starts all helper goroutines the peer needs for normal operations.  In
776
// the case this peer has already been started, then this function is a noop.
777
func (p *Brontide) Start() error {
3✔
778
        if !atomic.CompareAndSwapInt32(&p.started, 0, 1) {
3✔
NEW
779
                p.log.Warn("already started")
×
NEW
780

×
781
                return nil
×
782
        }
×
783

784
        // Once we've finished starting up the peer, we'll signal to other
785
        // goroutines that the they can move forward to tear down the peer, or
786
        // carry out other relevant changes.
787
        defer close(p.startReady)
3✔
788

3✔
789
        p.log.Tracef("starting with conn[%v->%v]",
3✔
790
                p.cfg.Conn.LocalAddr(), p.cfg.Conn.RemoteAddr())
3✔
791

3✔
792
        // Fetch and then load all the active channels we have with this remote
3✔
793
        // peer from the database.
3✔
794
        activeChans, err := p.cfg.ChannelDB.FetchOpenChannels(
3✔
795
                p.cfg.Addr.IdentityKey,
3✔
796
        )
3✔
797
        if err != nil {
3✔
798
                p.log.Errorf("Unable to fetch active chans "+
×
799
                        "for peer: %v", err)
×
800
                return err
×
801
        }
×
802

803
        if len(activeChans) == 0 {
6✔
804
                go p.cfg.PrunePersistentPeerConnection(p.cfg.PubKeyBytes)
3✔
805
        }
3✔
806

807
        // Quickly check if we have any existing legacy channels with this
808
        // peer.
809
        haveLegacyChan := false
3✔
810
        for _, c := range activeChans {
6✔
811
                if c.ChanType.IsTweakless() {
6✔
812
                        continue
3✔
813
                }
814

815
                haveLegacyChan = true
3✔
816
                break
3✔
817
        }
818

819
        // Exchange local and global features, the init message should be very
820
        // first between two nodes.
821
        if err := p.sendInitMsg(haveLegacyChan); err != nil {
6✔
822
                return fmt.Errorf("unable to send init msg: %w", err)
3✔
823
        }
3✔
824

825
        // Before we launch any of the helper goroutines off the peer struct,
826
        // we'll first ensure proper adherence to the p2p protocol. The init
827
        // message MUST be sent before any other message.
828
        readErr := make(chan error, 1)
3✔
829
        msgChan := make(chan lnwire.Message, 1)
3✔
830
        p.cg.WgAdd(1)
3✔
831
        go func() {
6✔
832
                defer p.cg.WgDone()
3✔
833

3✔
834
                msg, err := p.readNextMessage()
3✔
835
                if err != nil {
4✔
836
                        readErr <- err
1✔
837
                        msgChan <- nil
1✔
838
                        return
1✔
839
                }
1✔
840
                readErr <- nil
3✔
841
                msgChan <- msg
3✔
842
        }()
843

844
        select {
3✔
845
        // In order to avoid blocking indefinitely, we'll give the other peer
846
        // an upper timeout to respond before we bail out early.
847
        case <-time.After(handshakeTimeout):
×
848
                return fmt.Errorf("peer did not complete handshake within %v",
×
849
                        handshakeTimeout)
×
850
        case err := <-readErr:
3✔
851
                if err != nil {
4✔
852
                        return fmt.Errorf("unable to read init msg: %w", err)
1✔
853
                }
1✔
854
        }
855

856
        // Once the init message arrives, we can parse it so we can figure out
857
        // the negotiation of features for this session.
858
        msg := <-msgChan
3✔
859
        if msg, ok := msg.(*lnwire.Init); ok {
6✔
860
                if err := p.handleInitMsg(msg); err != nil {
3✔
861
                        p.storeError(err)
×
862
                        return err
×
863
                }
×
864
        } else {
×
865
                return errors.New("very first message between nodes " +
×
866
                        "must be init message")
×
867
        }
×
868

869
        // Next, load all the active channels we have with this peer,
870
        // registering them with the switch and launching the necessary
871
        // goroutines required to operate them.
872
        p.log.Debugf("Loaded %v active channels from database",
3✔
873
                len(activeChans))
3✔
874

3✔
875
        // Conditionally subscribe to channel events before loading channels so
3✔
876
        // we won't miss events. This subscription is used to listen to active
3✔
877
        // channel event when reenabling channels. Once the reenabling process
3✔
878
        // is finished, this subscription will be canceled.
3✔
879
        //
3✔
880
        // NOTE: ChannelNotifier must be started before subscribing events
3✔
881
        // otherwise we'd panic here.
3✔
882
        if err := p.attachChannelEventSubscription(); err != nil {
3✔
883
                return err
×
884
        }
×
885

886
        // Register the message router now as we may need to register some
887
        // endpoints while loading the channels below.
888
        p.msgRouter.WhenSome(func(router msgmux.Router) {
6✔
889
                router.Start(context.Background())
3✔
890
        })
3✔
891

892
        msgs, err := p.loadActiveChannels(activeChans)
3✔
893
        if err != nil {
3✔
894
                return fmt.Errorf("unable to load channels: %w", err)
×
895
        }
×
896

897
        p.startTime = time.Now()
3✔
898

3✔
899
        // Before launching the writeHandler goroutine, we send any channel
3✔
900
        // sync messages that must be resent for borked channels. We do this to
3✔
901
        // avoid data races with WriteMessage & Flush calls.
3✔
902
        if len(msgs) > 0 {
6✔
903
                p.log.Infof("Sending %d channel sync messages to peer after "+
3✔
904
                        "loading active channels", len(msgs))
3✔
905

3✔
906
                // Send the messages directly via writeMessage and bypass the
3✔
907
                // writeHandler goroutine.
3✔
908
                for _, msg := range msgs {
6✔
909
                        if err := p.writeMessage(msg); err != nil {
3✔
910
                                return fmt.Errorf("unable to send "+
×
911
                                        "reestablish msg: %v", err)
×
912
                        }
×
913
                }
914
        }
915

916
        err = p.pingManager.Start()
3✔
917
        if err != nil {
3✔
918
                return fmt.Errorf("could not start ping manager %w", err)
×
919
        }
×
920

921
        p.cg.WgAdd(4)
3✔
922
        go p.queueHandler()
3✔
923
        go p.writeHandler()
3✔
924
        go p.channelManager()
3✔
925
        go p.readHandler()
3✔
926

3✔
927
        // Signal to any external processes that the peer is now active.
3✔
928
        close(p.activeSignal)
3✔
929

3✔
930
        // Node announcements don't propagate very well throughout the network
3✔
931
        // as there isn't a way to efficiently query for them through their
3✔
932
        // timestamp, mostly affecting nodes that were offline during the time
3✔
933
        // of broadcast. We'll resend our node announcement to the remote peer
3✔
934
        // as a best-effort delivery such that it can also propagate to their
3✔
935
        // peers. To ensure they can successfully process it in most cases,
3✔
936
        // we'll only resend it as long as we have at least one confirmed
3✔
937
        // advertised channel with the remote peer.
3✔
938
        //
3✔
939
        // TODO(wilmer): Remove this once we're able to query for node
3✔
940
        // announcements through their timestamps.
3✔
941
        p.cg.WgAdd(2)
3✔
942
        go p.maybeSendNodeAnn(activeChans)
3✔
943
        go p.maybeSendChannelUpdates()
3✔
944

3✔
945
        return nil
3✔
946
}
947

948
// initGossipSync initializes either a gossip syncer or an initial routing
949
// dump, depending on the negotiated synchronization method.
950
func (p *Brontide) initGossipSync() {
3✔
951
        // If the remote peer knows of the new gossip queries feature, then
3✔
952
        // we'll create a new gossipSyncer in the AuthenticatedGossiper for it.
3✔
953
        if p.remoteFeatures.HasFeature(lnwire.GossipQueriesOptional) {
6✔
954
                p.log.Info("Negotiated chan series queries")
3✔
955

3✔
956
                if p.cfg.AuthGossiper == nil {
3✔
UNCOV
957
                        // This should only ever be hit in the unit tests.
×
UNCOV
958
                        p.log.Warn("No AuthGossiper configured. Abandoning " +
×
UNCOV
959
                                "gossip sync.")
×
UNCOV
960
                        return
×
UNCOV
961
                }
×
962

963
                // Register the peer's gossip syncer with the gossiper.
964
                // This blocks synchronously to ensure the gossip syncer is
965
                // registered with the gossiper before attempting to read
966
                // messages from the remote peer.
967
                //
968
                // TODO(wilmer): Only sync updates from non-channel peers. This
969
                // requires an improved version of the current network
970
                // bootstrapper to ensure we can find and connect to non-channel
971
                // peers.
972
                p.cfg.AuthGossiper.InitSyncState(p)
3✔
973
        }
974
}
975

976
// taprootShutdownAllowed returns true if both parties have negotiated the
977
// shutdown-any-segwit feature.
978
func (p *Brontide) taprootShutdownAllowed() bool {
3✔
979
        return p.RemoteFeatures().HasFeature(lnwire.ShutdownAnySegwitOptional) &&
3✔
980
                p.LocalFeatures().HasFeature(lnwire.ShutdownAnySegwitOptional)
3✔
981
}
3✔
982

983
// rbfCoopCloseAllowed returns true if both parties have negotiated the new RBF
984
// coop close feature.
985
func (p *Brontide) rbfCoopCloseAllowed() bool {
3✔
986
        bothHaveBit := func(bit lnwire.FeatureBit) bool {
6✔
987
                return p.RemoteFeatures().HasFeature(bit) &&
3✔
988
                        p.LocalFeatures().HasFeature(bit)
3✔
989
        }
3✔
990

991
        return bothHaveBit(lnwire.RbfCoopCloseOptional) ||
3✔
992
                bothHaveBit(lnwire.RbfCoopCloseOptionalStaging)
3✔
993
}
994

995
// QuitSignal is a method that should return a channel which will be sent upon
996
// or closed once the backing peer exits. This allows callers using the
997
// interface to cancel any processing in the event the backing implementation
998
// exits.
999
//
1000
// NOTE: Part of the lnpeer.Peer interface.
1001
func (p *Brontide) QuitSignal() <-chan struct{} {
3✔
1002
        return p.cg.Done()
3✔
1003
}
3✔
1004

1005
// addrWithInternalKey takes a delivery script, then attempts to supplement it
1006
// with information related to the internal key for the addr, but only if it's
1007
// a taproot addr.
1008
func (p *Brontide) addrWithInternalKey(
1009
        deliveryScript []byte) (*chancloser.DeliveryAddrWithKey, error) {
3✔
1010

3✔
1011
        // Currently, custom channels cannot be created with external upfront
3✔
1012
        // shutdown addresses, so this shouldn't be an issue. We only require
3✔
1013
        // the internal key for taproot addresses to be able to provide a non
3✔
1014
        // inclusion proof of any scripts.
3✔
1015
        internalKeyDesc, err := lnwallet.InternalKeyForAddr(
3✔
1016
                p.cfg.Wallet, &p.cfg.Wallet.Cfg.NetParams, deliveryScript,
3✔
1017
        )
3✔
1018
        if err != nil {
3✔
1019
                return nil, fmt.Errorf("unable to fetch internal key: %w", err)
×
1020
        }
×
1021

1022
        return &chancloser.DeliveryAddrWithKey{
3✔
1023
                DeliveryAddress: deliveryScript,
3✔
1024
                InternalKey: fn.MapOption(
3✔
1025
                        func(desc keychain.KeyDescriptor) btcec.PublicKey {
6✔
1026
                                return *desc.PubKey
3✔
1027
                        },
3✔
1028
                )(internalKeyDesc),
1029
        }, nil
1030
}
1031

1032
// loadActiveChannels creates indexes within the peer for tracking all active
1033
// channels returned by the database. It returns a slice of channel reestablish
1034
// messages that should be sent to the peer immediately, in case we have borked
1035
// channels that haven't been closed yet.
1036
func (p *Brontide) loadActiveChannels(chans []*channeldb.OpenChannel) (
1037
        []lnwire.Message, error) {
3✔
1038

3✔
1039
        // Return a slice of messages to send to the peers in case the channel
3✔
1040
        // cannot be loaded normally.
3✔
1041
        var msgs []lnwire.Message
3✔
1042

3✔
1043
        scidAliasNegotiated := p.hasNegotiatedScidAlias()
3✔
1044

3✔
1045
        for _, dbChan := range chans {
6✔
1046
                hasScidFeature := dbChan.ChanType.HasScidAliasFeature()
3✔
1047
                if scidAliasNegotiated && !hasScidFeature {
6✔
1048
                        // We'll request and store an alias, making sure that a
3✔
1049
                        // gossiper mapping is not created for the alias to the
3✔
1050
                        // real SCID. This is done because the peer and funding
3✔
1051
                        // manager are not aware of each other's states and if
3✔
1052
                        // we did not do this, we would accept alias channel
3✔
1053
                        // updates after 6 confirmations, which would be buggy.
3✔
1054
                        // We'll queue a channel_ready message with the new
3✔
1055
                        // alias. This should technically be done *after* the
3✔
1056
                        // reestablish, but this behavior is pre-existing since
3✔
1057
                        // the funding manager may already queue a
3✔
1058
                        // channel_ready before the channel_reestablish.
3✔
1059
                        if !dbChan.IsPending {
6✔
1060
                                aliasScid, err := p.cfg.RequestAlias()
3✔
1061
                                if err != nil {
3✔
1062
                                        return nil, err
×
1063
                                }
×
1064

1065
                                err = p.cfg.AddLocalAlias(
3✔
1066
                                        aliasScid, dbChan.ShortChanID(), false,
3✔
1067
                                        false,
3✔
1068
                                )
3✔
1069
                                if err != nil {
3✔
1070
                                        return nil, err
×
1071
                                }
×
1072

1073
                                chanID := lnwire.NewChanIDFromOutPoint(
3✔
1074
                                        dbChan.FundingOutpoint,
3✔
1075
                                )
3✔
1076

3✔
1077
                                // Fetch the second commitment point to send in
3✔
1078
                                // the channel_ready message.
3✔
1079
                                second, err := dbChan.SecondCommitmentPoint()
3✔
1080
                                if err != nil {
3✔
1081
                                        return nil, err
×
1082
                                }
×
1083

1084
                                channelReadyMsg := lnwire.NewChannelReady(
3✔
1085
                                        chanID, second,
3✔
1086
                                )
3✔
1087
                                channelReadyMsg.AliasScid = &aliasScid
3✔
1088

3✔
1089
                                msgs = append(msgs, channelReadyMsg)
3✔
1090
                        }
1091

1092
                        // If we've negotiated the option-scid-alias feature
1093
                        // and this channel does not have ScidAliasFeature set
1094
                        // to true due to an upgrade where the feature bit was
1095
                        // turned on, we'll update the channel's database
1096
                        // state.
1097
                        err := dbChan.MarkScidAliasNegotiated()
3✔
1098
                        if err != nil {
3✔
1099
                                return nil, err
×
1100
                        }
×
1101
                }
1102

1103
                var chanOpts []lnwallet.ChannelOpt
3✔
1104
                p.cfg.AuxLeafStore.WhenSome(func(s lnwallet.AuxLeafStore) {
3✔
1105
                        chanOpts = append(chanOpts, lnwallet.WithLeafStore(s))
×
1106
                })
×
1107
                p.cfg.AuxSigner.WhenSome(func(s lnwallet.AuxSigner) {
3✔
1108
                        chanOpts = append(chanOpts, lnwallet.WithAuxSigner(s))
×
1109
                })
×
1110
                p.cfg.AuxResolver.WhenSome(
3✔
1111
                        func(s lnwallet.AuxContractResolver) {
3✔
1112
                                chanOpts = append(
×
1113
                                        chanOpts, lnwallet.WithAuxResolver(s),
×
1114
                                )
×
1115
                        },
×
1116
                )
1117

1118
                lnChan, err := lnwallet.NewLightningChannel(
3✔
1119
                        p.cfg.Signer, dbChan, p.cfg.SigPool, chanOpts...,
3✔
1120
                )
3✔
1121
                if err != nil {
3✔
1122
                        return nil, fmt.Errorf("unable to create channel "+
×
1123
                                "state machine: %w", err)
×
1124
                }
×
1125

1126
                chanPoint := dbChan.FundingOutpoint
3✔
1127

3✔
1128
                chanID := lnwire.NewChanIDFromOutPoint(chanPoint)
3✔
1129

3✔
1130
                p.log.Infof("Loading ChannelPoint(%v), isPending=%v",
3✔
1131
                        chanPoint, lnChan.IsPending())
3✔
1132

3✔
1133
                // Skip adding any permanently irreconcilable channels to the
3✔
1134
                // htlcswitch.
3✔
1135
                if !dbChan.HasChanStatus(channeldb.ChanStatusDefault) &&
3✔
1136
                        !dbChan.HasChanStatus(channeldb.ChanStatusRestored) {
6✔
1137

3✔
1138
                        p.log.Warnf("ChannelPoint(%v) has status %v, won't "+
3✔
1139
                                "start.", chanPoint, dbChan.ChanStatus())
3✔
1140

3✔
1141
                        // To help our peer recover from a potential data loss,
3✔
1142
                        // we resend our channel reestablish message if the
3✔
1143
                        // channel is in a borked state. We won't process any
3✔
1144
                        // channel reestablish message sent from the peer, but
3✔
1145
                        // that's okay since the assumption is that we did when
3✔
1146
                        // marking the channel borked.
3✔
1147
                        chanSync, err := dbChan.ChanSyncMsg()
3✔
1148
                        if err != nil {
3✔
1149
                                p.log.Errorf("Unable to create channel "+
×
1150
                                        "reestablish message for channel %v: "+
×
1151
                                        "%v", chanPoint, err)
×
1152
                                continue
×
1153
                        }
1154

1155
                        msgs = append(msgs, chanSync)
3✔
1156

3✔
1157
                        // Check if this channel needs to have the cooperative
3✔
1158
                        // close process restarted. If so, we'll need to send
3✔
1159
                        // the Shutdown message that is returned.
3✔
1160
                        if dbChan.HasChanStatus(
3✔
1161
                                channeldb.ChanStatusCoopBroadcasted,
3✔
1162
                        ) {
6✔
1163

3✔
1164
                                shutdownMsg, err := p.restartCoopClose(lnChan)
3✔
1165
                                if err != nil {
3✔
1166
                                        p.log.Errorf("Unable to restart "+
×
1167
                                                "coop close for channel: %v",
×
1168
                                                err)
×
1169
                                        continue
×
1170
                                }
1171

1172
                                if shutdownMsg == nil {
6✔
1173
                                        continue
3✔
1174
                                }
1175

1176
                                // Append the message to the set of messages to
1177
                                // send.
1178
                                msgs = append(msgs, shutdownMsg)
×
1179
                        }
1180

1181
                        continue
3✔
1182
                }
1183

1184
                // Before we register this new link with the HTLC Switch, we'll
1185
                // need to fetch its current link-layer forwarding policy from
1186
                // the database.
1187
                graph := p.cfg.ChannelGraph
3✔
1188
                info, p1, p2, err := graph.FetchChannelEdgesByOutpoint(
3✔
1189
                        &chanPoint,
3✔
1190
                )
3✔
1191
                if err != nil && !errors.Is(err, graphdb.ErrEdgeNotFound) {
3✔
1192
                        return nil, err
×
1193
                }
×
1194

1195
                // We'll filter out our policy from the directional channel
1196
                // edges based whom the edge connects to. If it doesn't connect
1197
                // to us, then we know that we were the one that advertised the
1198
                // policy.
1199
                //
1200
                // TODO(roasbeef): can add helper method to get policy for
1201
                // particular channel.
1202
                var selfPolicy *models.ChannelEdgePolicy
3✔
1203
                if info != nil && bytes.Equal(info.NodeKey1Bytes[:],
3✔
1204
                        p.cfg.ServerPubKey[:]) {
6✔
1205

3✔
1206
                        selfPolicy = p1
3✔
1207
                } else {
6✔
1208
                        selfPolicy = p2
3✔
1209
                }
3✔
1210

1211
                // If we don't yet have an advertised routing policy, then
1212
                // we'll use the current default, otherwise we'll translate the
1213
                // routing policy into a forwarding policy.
1214
                var forwardingPolicy *models.ForwardingPolicy
3✔
1215
                if selfPolicy != nil {
6✔
1216
                        forwardingPolicy = &models.ForwardingPolicy{
3✔
1217
                                MinHTLCOut:    selfPolicy.MinHTLC,
3✔
1218
                                MaxHTLC:       selfPolicy.MaxHTLC,
3✔
1219
                                BaseFee:       selfPolicy.FeeBaseMSat,
3✔
1220
                                FeeRate:       selfPolicy.FeeProportionalMillionths,
3✔
1221
                                TimeLockDelta: uint32(selfPolicy.TimeLockDelta),
3✔
1222
                        }
3✔
1223
                        selfPolicy.InboundFee.WhenSome(func(fee lnwire.Fee) {
3✔
1224
                                inboundFee := models.NewInboundFeeFromWire(fee)
×
1225
                                forwardingPolicy.InboundFee = inboundFee
×
1226
                        })
×
1227
                } else {
3✔
1228
                        p.log.Warnf("Unable to find our forwarding policy "+
3✔
1229
                                "for channel %v, using default values",
3✔
1230
                                chanPoint)
3✔
1231
                        forwardingPolicy = &p.cfg.RoutingPolicy
3✔
1232
                }
3✔
1233

1234
                p.log.Tracef("Using link policy of: %v",
3✔
1235
                        spew.Sdump(forwardingPolicy))
3✔
1236

3✔
1237
                // If the channel is pending, set the value to nil in the
3✔
1238
                // activeChannels map. This is done to signify that the channel
3✔
1239
                // is pending. We don't add the link to the switch here - it's
3✔
1240
                // the funding manager's responsibility to spin up pending
3✔
1241
                // channels. Adding them here would just be extra work as we'll
3✔
1242
                // tear them down when creating + adding the final link.
3✔
1243
                if lnChan.IsPending() {
6✔
1244
                        p.activeChannels.Store(chanID, nil)
3✔
1245

3✔
1246
                        continue
3✔
1247
                }
1248

1249
                shutdownInfo, err := lnChan.State().ShutdownInfo()
3✔
1250
                if err != nil && !errors.Is(err, channeldb.ErrNoShutdownInfo) {
3✔
1251
                        return nil, err
×
1252
                }
×
1253

1254
                isTaprootChan := lnChan.ChanType().IsTaproot()
3✔
1255

3✔
1256
                var (
3✔
1257
                        shutdownMsg     fn.Option[lnwire.Shutdown]
3✔
1258
                        shutdownInfoErr error
3✔
1259
                )
3✔
1260
                shutdownInfo.WhenSome(func(info channeldb.ShutdownInfo) {
6✔
1261
                        // If we can use the new RBF close feature, we don't
3✔
1262
                        // need to create the legacy closer. However for taproot
3✔
1263
                        // channels, we'll continue to use the legacy closer.
3✔
1264
                        if p.rbfCoopCloseAllowed() && !isTaprootChan {
6✔
1265
                                return
3✔
1266
                        }
3✔
1267

1268
                        // Compute an ideal fee.
1269
                        feePerKw, err := p.cfg.FeeEstimator.EstimateFeePerKW(
3✔
1270
                                p.cfg.CoopCloseTargetConfs,
3✔
1271
                        )
3✔
1272
                        if err != nil {
3✔
1273
                                shutdownInfoErr = fmt.Errorf("unable to "+
×
1274
                                        "estimate fee: %w", err)
×
1275

×
1276
                                return
×
1277
                        }
×
1278

1279
                        addr, err := p.addrWithInternalKey(
3✔
1280
                                info.DeliveryScript.Val,
3✔
1281
                        )
3✔
1282
                        if err != nil {
3✔
1283
                                shutdownInfoErr = fmt.Errorf("unable to make "+
×
1284
                                        "delivery addr: %w", err)
×
1285
                                return
×
1286
                        }
×
1287
                        negotiateChanCloser, err := p.createChanCloser(
3✔
1288
                                lnChan, addr, feePerKw, nil,
3✔
1289
                                info.Closer(),
3✔
1290
                        )
3✔
1291
                        if err != nil {
3✔
1292
                                shutdownInfoErr = fmt.Errorf("unable to "+
×
1293
                                        "create chan closer: %w", err)
×
1294

×
1295
                                return
×
1296
                        }
×
1297

1298
                        chanID := lnwire.NewChanIDFromOutPoint(
3✔
1299
                                lnChan.State().FundingOutpoint,
3✔
1300
                        )
3✔
1301

3✔
1302
                        p.activeChanCloses.Store(chanID, makeNegotiateCloser(
3✔
1303
                                negotiateChanCloser,
3✔
1304
                        ))
3✔
1305

3✔
1306
                        // Create the Shutdown message.
3✔
1307
                        shutdown, err := negotiateChanCloser.ShutdownChan()
3✔
1308
                        if err != nil {
3✔
1309
                                p.activeChanCloses.Delete(chanID)
×
1310
                                shutdownInfoErr = err
×
1311

×
1312
                                return
×
1313
                        }
×
1314

1315
                        shutdownMsg = fn.Some(*shutdown)
3✔
1316
                })
1317
                if shutdownInfoErr != nil {
3✔
1318
                        return nil, shutdownInfoErr
×
1319
                }
×
1320

1321
                // Subscribe to the set of on-chain events for this channel.
1322
                chainEvents, err := p.cfg.ChainArb.SubscribeChannelEvents(
3✔
1323
                        chanPoint,
3✔
1324
                )
3✔
1325
                if err != nil {
3✔
1326
                        return nil, err
×
1327
                }
×
1328

1329
                err = p.addLink(
3✔
1330
                        &chanPoint, lnChan, forwardingPolicy, chainEvents,
3✔
1331
                        true, shutdownMsg,
3✔
1332
                )
3✔
1333
                if err != nil {
3✔
1334
                        return nil, fmt.Errorf("unable to add link %v to "+
×
1335
                                "switch: %v", chanPoint, err)
×
1336
                }
×
1337

1338
                p.activeChannels.Store(chanID, lnChan)
3✔
1339

3✔
1340
                // We're using the old co-op close, so we don't need to init
3✔
1341
                // the new RBF chan closer. If we have a taproot chan, then
3✔
1342
                // we'll also use the legacy type, so we don't need to make the
3✔
1343
                // new closer.
3✔
1344
                if !p.rbfCoopCloseAllowed() || isTaprootChan {
6✔
1345
                        continue
3✔
1346
                }
1347

1348
                // Now that the link has been added above, we'll also init an
1349
                // RBF chan closer for this channel, but only if the new close
1350
                // feature is negotiated.
1351
                //
1352
                // Creating this here ensures that any shutdown messages sent
1353
                // will be automatically routed by the msg router.
1354
                if _, err := p.initRbfChanCloser(lnChan); err != nil {
3✔
1355
                        p.activeChanCloses.Delete(chanID)
×
1356

×
1357
                        return nil, fmt.Errorf("unable to init RBF chan "+
×
1358
                                "closer during peer connect: %w", err)
×
1359
                }
×
1360

1361
                // If the shutdown info isn't blank, then we should kick things
1362
                // off by sending a shutdown message to the remote party to
1363
                // continue the old shutdown flow.
1364
                restartShutdown := func(s channeldb.ShutdownInfo) error {
6✔
1365
                        return p.startRbfChanCloser(
3✔
1366
                                newRestartShutdownInit(s),
3✔
1367
                                lnChan.ChannelPoint(),
3✔
1368
                        )
3✔
1369
                }
3✔
1370
                err = fn.MapOptionZ(shutdownInfo, restartShutdown)
3✔
1371
                if err != nil {
3✔
1372
                        return nil, fmt.Errorf("unable to start RBF "+
×
1373
                                "chan closer: %w", err)
×
1374
                }
×
1375
        }
1376

1377
        return msgs, nil
3✔
1378
}
1379

1380
// addLink creates and adds a new ChannelLink from the specified channel.
1381
func (p *Brontide) addLink(chanPoint *wire.OutPoint,
1382
        lnChan *lnwallet.LightningChannel,
1383
        forwardingPolicy *models.ForwardingPolicy,
1384
        chainEvents *contractcourt.ChainEventSubscription,
1385
        syncStates bool, shutdownMsg fn.Option[lnwire.Shutdown]) error {
3✔
1386

3✔
1387
        // onChannelFailure will be called by the link in case the channel
3✔
1388
        // fails for some reason.
3✔
1389
        onChannelFailure := func(chanID lnwire.ChannelID,
3✔
1390
                shortChanID lnwire.ShortChannelID,
3✔
1391
                linkErr htlcswitch.LinkFailureError) {
6✔
1392

3✔
1393
                failure := linkFailureReport{
3✔
1394
                        chanPoint:   *chanPoint,
3✔
1395
                        chanID:      chanID,
3✔
1396
                        shortChanID: shortChanID,
3✔
1397
                        linkErr:     linkErr,
3✔
1398
                }
3✔
1399

3✔
1400
                select {
3✔
1401
                case p.linkFailures <- failure:
3✔
1402
                case <-p.cg.Done():
×
1403
                case <-p.cfg.Quit:
×
1404
                }
1405
        }
1406

1407
        updateContractSignals := func(signals *contractcourt.ContractSignals) error {
6✔
1408
                return p.cfg.ChainArb.UpdateContractSignals(*chanPoint, signals)
3✔
1409
        }
3✔
1410

1411
        notifyContractUpdate := func(update *contractcourt.ContractUpdate) error {
6✔
1412
                return p.cfg.ChainArb.NotifyContractUpdate(*chanPoint, update)
3✔
1413
        }
3✔
1414

1415
        //nolint:ll
1416
        linkCfg := htlcswitch.ChannelLinkConfig{
3✔
1417
                Peer:                   p,
3✔
1418
                DecodeHopIterators:     p.cfg.Sphinx.DecodeHopIterators,
3✔
1419
                ExtractErrorEncrypter:  p.cfg.Sphinx.ExtractErrorEncrypter,
3✔
1420
                FetchLastChannelUpdate: p.cfg.FetchLastChanUpdate,
3✔
1421
                HodlMask:               p.cfg.Hodl.Mask(),
3✔
1422
                Registry:               p.cfg.Invoices,
3✔
1423
                BestHeight:             p.cfg.Switch.BestHeight,
3✔
1424
                Circuits:               p.cfg.Switch.CircuitModifier(),
3✔
1425
                ForwardPackets:         p.cfg.InterceptSwitch.ForwardPackets,
3✔
1426
                FwrdingPolicy:          *forwardingPolicy,
3✔
1427
                FeeEstimator:           p.cfg.FeeEstimator,
3✔
1428
                PreimageCache:          p.cfg.WitnessBeacon,
3✔
1429
                ChainEvents:            chainEvents,
3✔
1430
                UpdateContractSignals:  updateContractSignals,
3✔
1431
                NotifyContractUpdate:   notifyContractUpdate,
3✔
1432
                OnChannelFailure:       onChannelFailure,
3✔
1433
                SyncStates:             syncStates,
3✔
1434
                BatchTicker:            ticker.New(p.cfg.ChannelCommitInterval),
3✔
1435
                FwdPkgGCTicker:         ticker.New(time.Hour),
3✔
1436
                PendingCommitTicker: ticker.New(
3✔
1437
                        p.cfg.PendingCommitInterval,
3✔
1438
                ),
3✔
1439
                BatchSize:               p.cfg.ChannelCommitBatchSize,
3✔
1440
                UnsafeReplay:            p.cfg.UnsafeReplay,
3✔
1441
                MinUpdateTimeout:        htlcswitch.DefaultMinLinkFeeUpdateTimeout,
3✔
1442
                MaxUpdateTimeout:        htlcswitch.DefaultMaxLinkFeeUpdateTimeout,
3✔
1443
                OutgoingCltvRejectDelta: p.cfg.OutgoingCltvRejectDelta,
3✔
1444
                TowerClient:             p.cfg.TowerClient,
3✔
1445
                MaxOutgoingCltvExpiry:   p.cfg.MaxOutgoingCltvExpiry,
3✔
1446
                MaxFeeAllocation:        p.cfg.MaxChannelFeeAllocation,
3✔
1447
                MaxAnchorsCommitFeeRate: p.cfg.MaxAnchorsCommitFeeRate,
3✔
1448
                NotifyActiveLink:        p.cfg.ChannelNotifier.NotifyActiveLinkEvent,
3✔
1449
                NotifyActiveChannel:     p.cfg.ChannelNotifier.NotifyActiveChannelEvent,
3✔
1450
                NotifyInactiveChannel:   p.cfg.ChannelNotifier.NotifyInactiveChannelEvent,
3✔
1451
                NotifyInactiveLinkEvent: p.cfg.ChannelNotifier.NotifyInactiveLinkEvent,
3✔
1452
                HtlcNotifier:            p.cfg.HtlcNotifier,
3✔
1453
                GetAliases:              p.cfg.GetAliases,
3✔
1454
                PreviouslySentShutdown:  shutdownMsg,
3✔
1455
                DisallowRouteBlinding:   p.cfg.DisallowRouteBlinding,
3✔
1456
                MaxFeeExposure:          p.cfg.MaxFeeExposure,
3✔
1457
                ShouldFwdExpEndorsement: p.cfg.ShouldFwdExpEndorsement,
3✔
1458
                DisallowQuiescence: p.cfg.DisallowQuiescence ||
3✔
1459
                        !p.remoteFeatures.HasFeature(lnwire.QuiescenceOptional),
3✔
1460
                AuxTrafficShaper:  p.cfg.AuxTrafficShaper,
3✔
1461
                QuiescenceTimeout: p.cfg.QuiescenceTimeout,
3✔
1462
        }
3✔
1463

3✔
1464
        // Before adding our new link, purge the switch of any pending or live
3✔
1465
        // links going by the same channel id. If one is found, we'll shut it
3✔
1466
        // down to ensure that the mailboxes are only ever under the control of
3✔
1467
        // one link.
3✔
1468
        chanID := lnwire.NewChanIDFromOutPoint(*chanPoint)
3✔
1469
        p.cfg.Switch.RemoveLink(chanID)
3✔
1470

3✔
1471
        // With the channel link created, we'll now notify the htlc switch so
3✔
1472
        // this channel can be used to dispatch local payments and also
3✔
1473
        // passively forward payments.
3✔
1474
        return p.cfg.Switch.CreateAndAddLink(linkCfg, lnChan)
3✔
1475
}
1476

1477
// maybeSendNodeAnn sends our node announcement to the remote peer if at least
1478
// one confirmed public channel exists with them.
1479
func (p *Brontide) maybeSendNodeAnn(channels []*channeldb.OpenChannel) {
3✔
1480
        defer p.cg.WgDone()
3✔
1481

3✔
1482
        hasConfirmedPublicChan := false
3✔
1483
        for _, channel := range channels {
6✔
1484
                if channel.IsPending {
6✔
1485
                        continue
3✔
1486
                }
1487
                if channel.ChannelFlags&lnwire.FFAnnounceChannel == 0 {
6✔
1488
                        continue
3✔
1489
                }
1490

1491
                hasConfirmedPublicChan = true
3✔
1492
                break
3✔
1493
        }
1494
        if !hasConfirmedPublicChan {
6✔
1495
                return
3✔
1496
        }
3✔
1497

1498
        ourNodeAnn, err := p.cfg.GenNodeAnnouncement()
3✔
1499
        if err != nil {
3✔
1500
                p.log.Debugf("Unable to retrieve node announcement: %v", err)
×
1501
                return
×
1502
        }
×
1503

1504
        if err := p.SendMessageLazy(false, &ourNodeAnn); err != nil {
3✔
1505
                p.log.Debugf("Unable to resend node announcement: %v", err)
×
1506
        }
×
1507
}
1508

1509
// maybeSendChannelUpdates sends our channel updates to the remote peer if we
1510
// have any active channels with them.
1511
func (p *Brontide) maybeSendChannelUpdates() {
3✔
1512
        defer p.cg.WgDone()
3✔
1513

3✔
1514
        // If we don't have any active channels, then we can exit early.
3✔
1515
        if p.activeChannels.Len() == 0 {
6✔
1516
                return
3✔
1517
        }
3✔
1518

1519
        maybeSendUpd := func(cid lnwire.ChannelID,
3✔
1520
                lnChan *lnwallet.LightningChannel) error {
6✔
1521

3✔
1522
                // Nil channels are pending, so we'll skip them.
3✔
1523
                if lnChan == nil {
6✔
1524
                        return nil
3✔
1525
                }
3✔
1526

1527
                dbChan := lnChan.State()
3✔
1528
                scid := func() lnwire.ShortChannelID {
6✔
1529
                        switch {
3✔
1530
                        // Otherwise if it's a zero conf channel and confirmed,
1531
                        // then we need to use the "real" scid.
1532
                        case dbChan.IsZeroConf() && dbChan.ZeroConfConfirmed():
3✔
1533
                                return dbChan.ZeroConfRealScid()
3✔
1534

1535
                        // Otherwise, we can use the normal scid.
1536
                        default:
3✔
1537
                                return dbChan.ShortChanID()
3✔
1538
                        }
1539
                }()
1540

1541
                // Now that we know the channel is in a good state, we'll try
1542
                // to fetch the update to send to the remote peer. If the
1543
                // channel is pending, and not a zero conf channel, we'll get
1544
                // an error here which we'll ignore.
1545
                chanUpd, err := p.cfg.FetchLastChanUpdate(scid)
3✔
1546
                if err != nil {
6✔
1547
                        p.log.Debugf("Unable to fetch channel update for "+
3✔
1548
                                "ChannelPoint(%v), scid=%v: %v",
3✔
1549
                                dbChan.FundingOutpoint, dbChan.ShortChanID, err)
3✔
1550

3✔
1551
                        return nil
3✔
1552
                }
3✔
1553

1554
                p.log.Debugf("Sending channel update for ChannelPoint(%v), "+
3✔
1555
                        "scid=%v", dbChan.FundingOutpoint, dbChan.ShortChanID)
3✔
1556

3✔
1557
                // We'll send it as a normal message instead of using the lazy
3✔
1558
                // queue to prioritize transmission of the fresh update.
3✔
1559
                if err := p.SendMessage(false, chanUpd); err != nil {
3✔
1560
                        err := fmt.Errorf("unable to send channel update for "+
×
1561
                                "ChannelPoint(%v), scid=%v: %w",
×
1562
                                dbChan.FundingOutpoint, dbChan.ShortChanID(),
×
1563
                                err)
×
1564
                        p.log.Errorf(err.Error())
×
1565

×
1566
                        return err
×
1567
                }
×
1568

1569
                return nil
3✔
1570
        }
1571

1572
        p.activeChannels.ForEach(maybeSendUpd)
3✔
1573
}
1574

1575
// WaitForDisconnect waits until the peer has disconnected. A peer may be
1576
// disconnected if the local or remote side terminates the connection, or an
1577
// irrecoverable protocol error has been encountered. This method will only
1578
// begin watching the peer's waitgroup after the ready channel or the peer's
1579
// quit channel are signaled. The ready channel should only be signaled if a
1580
// call to Start returns no error. Otherwise, if the peer fails to start,
1581
// calling Disconnect will signal the quit channel and the method will not
1582
// block, since no goroutines were spawned.
1583
func (p *Brontide) WaitForDisconnect(ready chan struct{}) {
3✔
1584
        p.log.Trace("waiting for disconnect")
3✔
1585
        defer p.log.Trace("peer disconnected")
3✔
1586

3✔
1587
        // Before we try to call the `Wait` goroutine, we'll make sure the main
3✔
1588
        // set of goroutines are already active.
3✔
1589
        select {
3✔
1590
        case <-p.startReady:
3✔
1591
                p.log.Trace("startReady received, waiting for signal ready")
3✔
1592

1593
        case <-p.cg.Done():
1✔
1594
                p.log.Trace("peer quit, exit waiting for signal startReady")
1✔
1595

1✔
1596
                return
1✔
1597
        }
1598

1599
        select {
3✔
1600
        case <-ready:
3✔
1601
                p.log.Trace("ready received, waiting goroutines to finish")
3✔
1602

1603
        case <-p.cg.Done():
3✔
1604
                p.log.Trace("peer quit, exit waiting for signal ready")
3✔
1605

3✔
1606
                return
3✔
1607
        }
1608

1609
        p.cg.WgWait()
3✔
1610
}
1611

1612
// Disconnect terminates the connection with the remote peer. Additionally, a
1613
// signal is sent to the server and htlcSwitch indicating the resources
1614
// allocated to the peer can now be cleaned up.
1615
//
1616
// NOTE: Be aware that this method will block if the peer is still starting up.
1617
// Therefore consider starting it in a goroutine if you cannot guarantee that
1618
// the peer has finished starting up before calling this method.
1619
func (p *Brontide) Disconnect(reason error) {
3✔
1620
        if !atomic.CompareAndSwapInt32(&p.disconnect, 0, 1) {
6✔
1621
                p.log.Warnf("got disconnect reason [%v], but peer already "+
3✔
1622
                        "disconnected", reason)
3✔
1623

3✔
1624
                return
3✔
1625
        }
3✔
1626

1627
        // Make sure initialization has completed before we try to tear things
1628
        // down.
1629
        //
1630
        // NOTE: We only read the `startReady` chan if the peer has been
1631
        // started, otherwise we will skip reading it as this chan won't be
1632
        // closed, hence blocks forever.
1633
        if atomic.LoadInt32(&p.started) == 1 {
6✔
1634
                p.log.Debug("waiting on startReady signal before closing " +
3✔
1635
                        "connection")
3✔
1636

3✔
1637
                select {
3✔
1638
                case <-p.startReady:
3✔
1639
                        p.log.Debug("startReady received")
3✔
1640

1641
                case <-p.cg.Done():
×
1642
                        return
×
1643
                }
1644
        }
1645

1646
        err := fmt.Errorf("disconnecting %s, reason: %v", p, reason)
3✔
1647
        p.storeError(err)
3✔
1648

3✔
1649
        p.log.Infof(err.Error())
3✔
1650

3✔
1651
        // Stop PingManager before closing TCP connection.
3✔
1652
        p.pingManager.Stop()
3✔
1653

3✔
1654
        // Ensure that the TCP connection is properly closed before continuing.
3✔
1655
        p.cfg.Conn.Close()
3✔
1656

3✔
1657
        p.cg.Quit()
3✔
1658

3✔
1659
        // If our msg router isn't global (local to this instance), then we'll
3✔
1660
        // stop it. Otherwise, we'll leave it running.
3✔
1661
        if !p.globalMsgRouter {
6✔
1662
                p.msgRouter.WhenSome(func(router msgmux.Router) {
6✔
1663
                        router.Stop()
3✔
1664
                })
3✔
1665
        }
1666
}
1667

1668
// String returns the string representation of this peer.
1669
func (p *Brontide) String() string {
3✔
1670
        return fmt.Sprintf("%x@%s", p.cfg.PubKeyBytes, p.cfg.Conn.RemoteAddr())
3✔
1671
}
3✔
1672

1673
// readNextMessage reads, and returns the next message on the wire along with
1674
// any additional raw payload.
1675
func (p *Brontide) readNextMessage() (lnwire.Message, error) {
3✔
1676
        noiseConn := p.cfg.Conn
3✔
1677
        err := noiseConn.SetReadDeadline(time.Time{})
3✔
1678
        if err != nil {
3✔
1679
                return nil, err
×
1680
        }
×
1681

1682
        pktLen, err := noiseConn.ReadNextHeader()
3✔
1683
        if err != nil {
6✔
1684
                return nil, fmt.Errorf("read next header: %w", err)
3✔
1685
        }
3✔
1686

1687
        // First we'll read the next _full_ message. We do this rather than
1688
        // reading incrementally from the stream as the Lightning wire protocol
1689
        // is message oriented and allows nodes to pad on additional data to
1690
        // the message stream.
1691
        var (
3✔
1692
                nextMsg lnwire.Message
3✔
1693
                msgLen  uint64
3✔
1694
        )
3✔
1695
        err = p.cfg.ReadPool.Submit(func(buf *buffer.Read) error {
6✔
1696
                // Before reading the body of the message, set the read timeout
3✔
1697
                // accordingly to ensure we don't block other readers using the
3✔
1698
                // pool. We do so only after the task has been scheduled to
3✔
1699
                // ensure the deadline doesn't expire while the message is in
3✔
1700
                // the process of being scheduled.
3✔
1701
                readDeadline := time.Now().Add(
3✔
1702
                        p.scaleTimeout(readMessageTimeout),
3✔
1703
                )
3✔
1704
                readErr := noiseConn.SetReadDeadline(readDeadline)
3✔
1705
                if readErr != nil {
3✔
1706
                        return readErr
×
1707
                }
×
1708

1709
                // The ReadNextBody method will actually end up re-using the
1710
                // buffer, so within this closure, we can continue to use
1711
                // rawMsg as it's just a slice into the buf from the buffer
1712
                // pool.
1713
                rawMsg, readErr := noiseConn.ReadNextBody(buf[:pktLen])
3✔
1714
                if readErr != nil {
3✔
1715
                        return fmt.Errorf("read next body: %w", readErr)
×
1716
                }
×
1717
                msgLen = uint64(len(rawMsg))
3✔
1718

3✔
1719
                // Next, create a new io.Reader implementation from the raw
3✔
1720
                // message, and use this to decode the message directly from.
3✔
1721
                msgReader := bytes.NewReader(rawMsg)
3✔
1722
                nextMsg, err = lnwire.ReadMessage(msgReader, 0)
3✔
1723
                if err != nil {
6✔
1724
                        return err
3✔
1725
                }
3✔
1726

1727
                // At this point, rawMsg and buf will be returned back to the
1728
                // buffer pool for re-use.
1729
                return nil
3✔
1730
        })
1731
        atomic.AddUint64(&p.bytesReceived, msgLen)
3✔
1732
        if err != nil {
6✔
1733
                return nil, err
3✔
1734
        }
3✔
1735

1736
        p.logWireMessage(nextMsg, true)
3✔
1737

3✔
1738
        return nextMsg, nil
3✔
1739
}
1740

1741
// msgStream implements a goroutine-safe, in-order stream of messages to be
1742
// delivered via closure to a receiver. These messages MUST be in order due to
1743
// the nature of the lightning channel commitment and gossiper state machines.
1744
// TODO(conner): use stream handler interface to abstract out stream
1745
// state/logging.
1746
type msgStream struct {
1747
        streamShutdown int32 // To be used atomically.
1748

1749
        peer *Brontide
1750

1751
        apply func(lnwire.Message)
1752

1753
        startMsg string
1754
        stopMsg  string
1755

1756
        msgCond *sync.Cond
1757
        msgs    []lnwire.Message
1758

1759
        mtx sync.Mutex
1760

1761
        producerSema chan struct{}
1762

1763
        wg   sync.WaitGroup
1764
        quit chan struct{}
1765
}
1766

1767
// newMsgStream creates a new instance of a chanMsgStream for a particular
1768
// channel identified by its channel ID. bufSize is the max number of messages
1769
// that should be buffered in the internal queue. Callers should set this to a
1770
// sane value that avoids blocking unnecessarily, but doesn't allow an
1771
// unbounded amount of memory to be allocated to buffer incoming messages.
1772
func newMsgStream(p *Brontide, startMsg, stopMsg string, bufSize uint32,
1773
        apply func(lnwire.Message)) *msgStream {
3✔
1774

3✔
1775
        stream := &msgStream{
3✔
1776
                peer:         p,
3✔
1777
                apply:        apply,
3✔
1778
                startMsg:     startMsg,
3✔
1779
                stopMsg:      stopMsg,
3✔
1780
                producerSema: make(chan struct{}, bufSize),
3✔
1781
                quit:         make(chan struct{}),
3✔
1782
        }
3✔
1783
        stream.msgCond = sync.NewCond(&stream.mtx)
3✔
1784

3✔
1785
        // Before we return the active stream, we'll populate the producer's
3✔
1786
        // semaphore channel. We'll use this to ensure that the producer won't
3✔
1787
        // attempt to allocate memory in the queue for an item until it has
3✔
1788
        // sufficient extra space.
3✔
1789
        for i := uint32(0); i < bufSize; i++ {
6✔
1790
                stream.producerSema <- struct{}{}
3✔
1791
        }
3✔
1792

1793
        return stream
3✔
1794
}
1795

1796
// Start starts the chanMsgStream.
1797
func (ms *msgStream) Start() {
3✔
1798
        ms.wg.Add(1)
3✔
1799
        go ms.msgConsumer()
3✔
1800
}
3✔
1801

1802
// Stop stops the chanMsgStream.
1803
func (ms *msgStream) Stop() {
3✔
1804
        // TODO(roasbeef): signal too?
3✔
1805

3✔
1806
        close(ms.quit)
3✔
1807

3✔
1808
        // Now that we've closed the channel, we'll repeatedly signal the msg
3✔
1809
        // consumer until we've detected that it has exited.
3✔
1810
        for atomic.LoadInt32(&ms.streamShutdown) == 0 {
6✔
1811
                ms.msgCond.Signal()
3✔
1812
                time.Sleep(time.Millisecond * 100)
3✔
1813
        }
3✔
1814

1815
        ms.wg.Wait()
3✔
1816
}
1817

1818
// msgConsumer is the main goroutine that streams messages from the peer's
1819
// readHandler directly to the target channel.
1820
func (ms *msgStream) msgConsumer() {
3✔
1821
        defer ms.wg.Done()
3✔
1822
        defer peerLog.Tracef(ms.stopMsg)
3✔
1823
        defer atomic.StoreInt32(&ms.streamShutdown, 1)
3✔
1824

3✔
1825
        peerLog.Tracef(ms.startMsg)
3✔
1826

3✔
1827
        for {
6✔
1828
                // First, we'll check our condition. If the queue of messages
3✔
1829
                // is empty, then we'll wait until a new item is added.
3✔
1830
                ms.msgCond.L.Lock()
3✔
1831
                for len(ms.msgs) == 0 {
6✔
1832
                        ms.msgCond.Wait()
3✔
1833

3✔
1834
                        // If we woke up in order to exit, then we'll do so.
3✔
1835
                        // Otherwise, we'll check the message queue for any new
3✔
1836
                        // items.
3✔
1837
                        select {
3✔
1838
                        case <-ms.peer.cg.Done():
3✔
1839
                                ms.msgCond.L.Unlock()
3✔
1840
                                return
3✔
1841
                        case <-ms.quit:
3✔
1842
                                ms.msgCond.L.Unlock()
3✔
1843
                                return
3✔
1844
                        default:
3✔
1845
                        }
1846
                }
1847

1848
                // Grab the message off the front of the queue, shifting the
1849
                // slice's reference down one in order to remove the message
1850
                // from the queue.
1851
                msg := ms.msgs[0]
3✔
1852
                ms.msgs[0] = nil // Set to nil to prevent GC leak.
3✔
1853
                ms.msgs = ms.msgs[1:]
3✔
1854

3✔
1855
                ms.msgCond.L.Unlock()
3✔
1856

3✔
1857
                ms.apply(msg)
3✔
1858

3✔
1859
                // We've just successfully processed an item, so we'll signal
3✔
1860
                // to the producer that a new slot in the buffer. We'll use
3✔
1861
                // this to bound the size of the buffer to avoid allowing it to
3✔
1862
                // grow indefinitely.
3✔
1863
                select {
3✔
1864
                case ms.producerSema <- struct{}{}:
3✔
1865
                case <-ms.peer.cg.Done():
3✔
1866
                        return
3✔
1867
                case <-ms.quit:
1✔
1868
                        return
1✔
1869
                }
1870
        }
1871
}
1872

1873
// AddMsg adds a new message to the msgStream. This function is safe for
1874
// concurrent access.
1875
func (ms *msgStream) AddMsg(msg lnwire.Message) {
3✔
1876
        // First, we'll attempt to receive from the producerSema struct. This
3✔
1877
        // acts as a semaphore to prevent us from indefinitely buffering
3✔
1878
        // incoming items from the wire. Either the msg queue isn't full, and
3✔
1879
        // we'll not block, or the queue is full, and we'll block until either
3✔
1880
        // we're signalled to quit, or a slot is freed up.
3✔
1881
        select {
3✔
1882
        case <-ms.producerSema:
3✔
1883
        case <-ms.peer.cg.Done():
×
1884
                return
×
1885
        case <-ms.quit:
×
1886
                return
×
1887
        }
1888

1889
        // Next, we'll lock the condition, and add the message to the end of
1890
        // the message queue.
1891
        ms.msgCond.L.Lock()
3✔
1892
        ms.msgs = append(ms.msgs, msg)
3✔
1893
        ms.msgCond.L.Unlock()
3✔
1894

3✔
1895
        // With the message added, we signal to the msgConsumer that there are
3✔
1896
        // additional messages to consume.
3✔
1897
        ms.msgCond.Signal()
3✔
1898
}
1899

1900
// waitUntilLinkActive waits until the target link is active and returns a
1901
// ChannelLink to pass messages to. It accomplishes this by subscribing to
1902
// an ActiveLinkEvent which is emitted by the link when it first starts up.
1903
func waitUntilLinkActive(p *Brontide,
1904
        cid lnwire.ChannelID) htlcswitch.ChannelUpdateHandler {
3✔
1905

3✔
1906
        p.log.Tracef("Waiting for link=%v to be active", cid)
3✔
1907

3✔
1908
        // Subscribe to receive channel events.
3✔
1909
        //
3✔
1910
        // NOTE: If the link is already active by SubscribeChannelEvents, then
3✔
1911
        // GetLink will retrieve the link and we can send messages. If the link
3✔
1912
        // becomes active between SubscribeChannelEvents and GetLink, then GetLink
3✔
1913
        // will retrieve the link. If the link becomes active after GetLink, then
3✔
1914
        // we will get an ActiveLinkEvent notification and retrieve the link. If
3✔
1915
        // the call to GetLink is before SubscribeChannelEvents, however, there
3✔
1916
        // will be a race condition.
3✔
1917
        sub, err := p.cfg.ChannelNotifier.SubscribeChannelEvents()
3✔
1918
        if err != nil {
6✔
1919
                // If we have a non-nil error, then the server is shutting down and we
3✔
1920
                // can exit here and return nil. This means no message will be delivered
3✔
1921
                // to the link.
3✔
1922
                return nil
3✔
1923
        }
3✔
1924
        defer sub.Cancel()
3✔
1925

3✔
1926
        // The link may already be active by this point, and we may have missed the
3✔
1927
        // ActiveLinkEvent. Check if the link exists.
3✔
1928
        link := p.fetchLinkFromKeyAndCid(cid)
3✔
1929
        if link != nil {
6✔
1930
                return link
3✔
1931
        }
3✔
1932

1933
        // If the link is nil, we must wait for it to be active.
1934
        for {
6✔
1935
                select {
3✔
1936
                // A new event has been sent by the ChannelNotifier. We first check
1937
                // whether the event is an ActiveLinkEvent. If it is, we'll check
1938
                // that the event is for this channel. Otherwise, we discard the
1939
                // message.
1940
                case e := <-sub.Updates():
3✔
1941
                        event, ok := e.(channelnotifier.ActiveLinkEvent)
3✔
1942
                        if !ok {
6✔
1943
                                // Ignore this notification.
3✔
1944
                                continue
3✔
1945
                        }
1946

1947
                        chanPoint := event.ChannelPoint
2✔
1948

2✔
1949
                        // Check whether the retrieved chanPoint matches the target
2✔
1950
                        // channel id.
2✔
1951
                        if !cid.IsChanPoint(chanPoint) {
2✔
1952
                                continue
×
1953
                        }
1954

1955
                        // The link shouldn't be nil as we received an
1956
                        // ActiveLinkEvent. If it is nil, we return nil and the
1957
                        // calling function should catch it.
1958
                        return p.fetchLinkFromKeyAndCid(cid)
2✔
1959

1960
                case <-p.cg.Done():
3✔
1961
                        return nil
3✔
1962
                }
1963
        }
1964
}
1965

1966
// newChanMsgStream is used to create a msgStream between the peer and
1967
// particular channel link in the htlcswitch. We utilize additional
1968
// synchronization with the fundingManager to ensure we don't attempt to
1969
// dispatch a message to a channel before it is fully active. A reference to the
1970
// channel this stream forwards to is held in scope to prevent unnecessary
1971
// lookups.
1972
func newChanMsgStream(p *Brontide, cid lnwire.ChannelID) *msgStream {
3✔
1973
        var chanLink htlcswitch.ChannelUpdateHandler
3✔
1974

3✔
1975
        apply := func(msg lnwire.Message) {
6✔
1976
                // This check is fine because if the link no longer exists, it will
3✔
1977
                // be removed from the activeChannels map and subsequent messages
3✔
1978
                // shouldn't reach the chan msg stream.
3✔
1979
                if chanLink == nil {
6✔
1980
                        chanLink = waitUntilLinkActive(p, cid)
3✔
1981

3✔
1982
                        // If the link is still not active and the calling function
3✔
1983
                        // errored out, just return.
3✔
1984
                        if chanLink == nil {
6✔
1985
                                p.log.Warnf("Link=%v is not active", cid)
3✔
1986
                                return
3✔
1987
                        }
3✔
1988
                }
1989

1990
                // In order to avoid unnecessarily delivering message
1991
                // as the peer is exiting, we'll check quickly to see
1992
                // if we need to exit.
1993
                select {
3✔
1994
                case <-p.cg.Done():
×
1995
                        return
×
1996
                default:
3✔
1997
                }
1998

1999
                chanLink.HandleChannelUpdate(msg)
3✔
2000
        }
2001

2002
        return newMsgStream(p,
3✔
2003
                fmt.Sprintf("Update stream for ChannelID(%x) created", cid[:]),
3✔
2004
                fmt.Sprintf("Update stream for ChannelID(%x) exiting", cid[:]),
3✔
2005
                msgStreamSize,
3✔
2006
                apply,
3✔
2007
        )
3✔
2008
}
2009

2010
// newDiscMsgStream is used to setup a msgStream between the peer and the
2011
// authenticated gossiper. This stream should be used to forward all remote
2012
// channel announcements.
2013
func newDiscMsgStream(p *Brontide) *msgStream {
3✔
2014
        apply := func(msg lnwire.Message) {
6✔
2015
                // TODO(elle): thread contexts through the peer system properly
3✔
2016
                // so that a parent context can be passed in here.
3✔
2017
                ctx := context.TODO()
3✔
2018

3✔
2019
                // Processing here means we send it to the gossiper which then
3✔
2020
                // decides whether this message is processed immediately or
3✔
2021
                // waits for dependent messages to be processed. It can also
3✔
2022
                // happen that the message is not processed at all if it is
3✔
2023
                // premature and the LRU cache fills up and the message is
3✔
2024
                // deleted.
3✔
2025
                p.log.Debugf("Processing remote msg %T", msg)
3✔
2026

3✔
2027
                // TODO(ziggie): ProcessRemoteAnnouncement returns an error
3✔
2028
                // channel, but we cannot rely on it being written to.
3✔
2029
                // Because some messages might never be processed (e.g.
3✔
2030
                // premature channel updates). We should change the design here
3✔
2031
                // and use the actor model pattern as soon as it is available.
3✔
2032
                // So for now we should NOT use the error channel.
3✔
2033
                // See https://github.com/lightningnetwork/lnd/pull/9820.
3✔
2034
                p.cfg.AuthGossiper.ProcessRemoteAnnouncement(ctx, msg, p)
3✔
2035
        }
3✔
2036

2037
        return newMsgStream(
3✔
2038
                p,
3✔
2039
                "Update stream for gossiper created",
3✔
2040
                "Update stream for gossiper exited",
3✔
2041
                msgStreamSize,
3✔
2042
                apply,
3✔
2043
        )
3✔
2044
}
2045

2046
// readHandler is responsible for reading messages off the wire in series, then
2047
// properly dispatching the handling of the message to the proper subsystem.
2048
//
2049
// NOTE: This method MUST be run as a goroutine.
2050
func (p *Brontide) readHandler() {
3✔
2051
        defer p.cg.WgDone()
3✔
2052

3✔
2053
        // We'll stop the timer after a new messages is received, and also
3✔
2054
        // reset it after we process the next message.
3✔
2055
        idleTimer := time.AfterFunc(idleTimeout, func() {
3✔
2056
                err := fmt.Errorf("peer %s no answer for %s -- disconnecting",
×
2057
                        p, idleTimeout)
×
2058
                p.Disconnect(err)
×
2059
        })
×
2060

2061
        // Initialize our negotiated gossip sync method before reading messages
2062
        // off the wire. When using gossip queries, this ensures a gossip
2063
        // syncer is active by the time query messages arrive.
2064
        //
2065
        // TODO(conner): have peer store gossip syncer directly and bypass
2066
        // gossiper?
2067
        p.initGossipSync()
3✔
2068

3✔
2069
        // exitErr is the error to be used when disconnect the peer.
3✔
2070
        var exitErr error
3✔
2071

3✔
2072
        discStream := newDiscMsgStream(p)
3✔
2073
        discStream.Start()
3✔
2074
        defer discStream.Stop()
3✔
2075
out:
3✔
2076
        for atomic.LoadInt32(&p.disconnect) == 0 {
6✔
2077
                nextMsg, err := p.readNextMessage()
3✔
2078
                if !idleTimer.Stop() {
6✔
2079
                        select {
3✔
2080
                        case <-idleTimer.C:
×
2081
                        default:
3✔
2082
                        }
2083
                }
2084
                if err != nil {
6✔
2085
                        p.log.Debugf("unable to read message from peer: %v",
3✔
2086
                                err)
3✔
2087

3✔
2088
                        // If we could not read our peer's message due to an
3✔
2089
                        // unknown type or invalid alias, we continue processing
3✔
2090
                        // as normal. We store unknown message and address
3✔
2091
                        // types, as they may provide debugging insight.
3✔
2092
                        switch e := err.(type) {
3✔
2093
                        // If this is just a message we don't yet recognize,
2094
                        // we'll continue processing as normal as this allows
2095
                        // us to introduce new messages in a forwards
2096
                        // compatible manner.
2097
                        case *lnwire.UnknownMessage:
3✔
2098
                                p.storeError(e)
3✔
2099
                                idleTimer.Reset(idleTimeout)
3✔
2100
                                continue
3✔
2101

2102
                        // If they sent us an address type that we don't yet
2103
                        // know of, then this isn't a wire error, so we'll
2104
                        // simply continue parsing the remainder of their
2105
                        // messages.
2106
                        case *lnwire.ErrUnknownAddrType:
×
2107
                                p.storeError(e)
×
2108
                                idleTimer.Reset(idleTimeout)
×
2109
                                continue
×
2110

2111
                        // If the NodeAnnouncement has an invalid alias, then
2112
                        // we'll log that error above and continue so we can
2113
                        // continue to read messages from the peer. We do not
2114
                        // store this error because it is of little debugging
2115
                        // value.
2116
                        case *lnwire.ErrInvalidNodeAlias:
×
2117
                                idleTimer.Reset(idleTimeout)
×
2118
                                continue
×
2119

2120
                        // If the error we encountered wasn't just a message we
2121
                        // didn't recognize, then we'll stop all processing as
2122
                        // this is a fatal error.
2123
                        default:
3✔
2124
                                exitErr = err
3✔
2125
                                break out
3✔
2126
                        }
2127
                }
2128

2129
                // If a message router is active, then we'll try to have it
2130
                // handle this message. If it can, then we're able to skip the
2131
                // rest of the message handling logic.
2132
                err = fn.MapOptionZ(p.msgRouter, func(r msgmux.Router) error {
6✔
2133
                        return r.RouteMsg(msgmux.PeerMsg{
3✔
2134
                                PeerPub: *p.IdentityKey(),
3✔
2135
                                Message: nextMsg,
3✔
2136
                        })
3✔
2137
                })
3✔
2138

2139
                // No error occurred, and the message was handled by the
2140
                // router.
2141
                if err == nil {
6✔
2142
                        continue
3✔
2143
                }
2144

2145
                var (
3✔
2146
                        targetChan   lnwire.ChannelID
3✔
2147
                        isLinkUpdate bool
3✔
2148
                )
3✔
2149

3✔
2150
                switch msg := nextMsg.(type) {
3✔
2151
                case *lnwire.Pong:
×
2152
                        // When we receive a Pong message in response to our
×
2153
                        // last ping message, we send it to the pingManager
×
2154
                        p.pingManager.ReceivedPong(msg)
×
2155

2156
                case *lnwire.Ping:
×
2157
                        // First, we'll store their latest ping payload within
×
2158
                        // the relevant atomic variable.
×
2159
                        p.lastPingPayload.Store(msg.PaddingBytes[:])
×
2160

×
2161
                        // Next, we'll send over the amount of specified pong
×
2162
                        // bytes.
×
2163
                        pong := lnwire.NewPong(p.cfg.PongBuf[0:msg.NumPongBytes])
×
2164
                        p.queueMsg(pong, nil)
×
2165

2166
                case *lnwire.OpenChannel,
2167
                        *lnwire.AcceptChannel,
2168
                        *lnwire.FundingCreated,
2169
                        *lnwire.FundingSigned,
2170
                        *lnwire.ChannelReady:
3✔
2171

3✔
2172
                        p.cfg.FundingManager.ProcessFundingMsg(msg, p)
3✔
2173

2174
                case *lnwire.Shutdown:
3✔
2175
                        select {
3✔
2176
                        case p.chanCloseMsgs <- &closeMsg{msg.ChannelID, msg}:
3✔
2177
                        case <-p.cg.Done():
×
2178
                                break out
×
2179
                        }
2180
                case *lnwire.ClosingSigned:
3✔
2181
                        select {
3✔
2182
                        case p.chanCloseMsgs <- &closeMsg{msg.ChannelID, msg}:
3✔
2183
                        case <-p.cg.Done():
×
2184
                                break out
×
2185
                        }
2186

2187
                case *lnwire.Warning:
×
2188
                        targetChan = msg.ChanID
×
2189
                        isLinkUpdate = p.handleWarningOrError(targetChan, msg)
×
2190

2191
                case *lnwire.Error:
3✔
2192
                        targetChan = msg.ChanID
3✔
2193
                        isLinkUpdate = p.handleWarningOrError(targetChan, msg)
3✔
2194

2195
                case *lnwire.ChannelReestablish:
3✔
2196
                        targetChan = msg.ChanID
3✔
2197
                        isLinkUpdate = p.hasChannel(targetChan)
3✔
2198

3✔
2199
                        // If we failed to find the link in question, and the
3✔
2200
                        // message received was a channel sync message, then
3✔
2201
                        // this might be a peer trying to resync closed channel.
3✔
2202
                        // In this case we'll try to resend our last channel
3✔
2203
                        // sync message, such that the peer can recover funds
3✔
2204
                        // from the closed channel.
3✔
2205
                        if !isLinkUpdate {
6✔
2206
                                err := p.resendChanSyncMsg(targetChan)
3✔
2207
                                if err != nil {
6✔
2208
                                        // TODO(halseth): send error to peer?
3✔
2209
                                        p.log.Errorf("resend failed: %v", err)
3✔
2210
                                }
3✔
2211
                        }
2212

2213
                // For messages that implement the LinkUpdater interface, we
2214
                // will consider them as link updates and send them to
2215
                // chanStream. These messages will be queued inside chanStream
2216
                // if the channel is not active yet.
2217
                case lnwire.LinkUpdater:
3✔
2218
                        targetChan = msg.TargetChanID()
3✔
2219
                        isLinkUpdate = p.hasChannel(targetChan)
3✔
2220

3✔
2221
                        // Log an error if we don't have this channel. This
3✔
2222
                        // means the peer has sent us a message with unknown
3✔
2223
                        // channel ID.
3✔
2224
                        if !isLinkUpdate {
6✔
2225
                                p.log.Errorf("Unknown channel ID: %v found "+
3✔
2226
                                        "in received msg=%s", targetChan,
3✔
2227
                                        nextMsg.MsgType())
3✔
2228
                        }
3✔
2229

2230
                case *lnwire.ChannelUpdate1,
2231
                        *lnwire.ChannelAnnouncement1,
2232
                        *lnwire.NodeAnnouncement,
2233
                        *lnwire.AnnounceSignatures1,
2234
                        *lnwire.GossipTimestampRange,
2235
                        *lnwire.QueryShortChanIDs,
2236
                        *lnwire.QueryChannelRange,
2237
                        *lnwire.ReplyChannelRange,
2238
                        *lnwire.ReplyShortChanIDsEnd:
3✔
2239

3✔
2240
                        discStream.AddMsg(msg)
3✔
2241

2242
                case *lnwire.Custom:
3✔
2243
                        err := p.handleCustomMessage(msg)
3✔
2244
                        if err != nil {
3✔
2245
                                p.storeError(err)
×
2246
                                p.log.Errorf("%v", err)
×
2247
                        }
×
2248

2249
                default:
×
2250
                        // If the message we received is unknown to us, store
×
2251
                        // the type to track the failure.
×
2252
                        err := fmt.Errorf("unknown message type %v received",
×
2253
                                uint16(msg.MsgType()))
×
2254
                        p.storeError(err)
×
2255

×
2256
                        p.log.Errorf("%v", err)
×
2257
                }
2258

2259
                if isLinkUpdate {
6✔
2260
                        // If this is a channel update, then we need to feed it
3✔
2261
                        // into the channel's in-order message stream.
3✔
2262
                        p.sendLinkUpdateMsg(targetChan, nextMsg)
3✔
2263
                }
3✔
2264

2265
                idleTimer.Reset(idleTimeout)
3✔
2266
        }
2267

2268
        // Disconnect the peer on exitErr, but only if the peer hasn't been
2269
        // disconnected before.
2270
        if atomic.LoadInt32(&p.disconnect) == 0 {
6✔
2271
                p.Disconnect(exitErr)
3✔
2272
        }
3✔
2273

2274
        p.log.Debugf("peer quit, exit readHandler")
3✔
2275
}
2276

2277
// handleCustomMessage handles the given custom message if a handler is
2278
// registered.
2279
func (p *Brontide) handleCustomMessage(msg *lnwire.Custom) error {
3✔
2280
        if p.cfg.HandleCustomMessage == nil {
3✔
2281
                return fmt.Errorf("no custom message handler for "+
×
2282
                        "message type %v", uint16(msg.MsgType()))
×
2283
        }
×
2284

2285
        return p.cfg.HandleCustomMessage(p.PubKey(), msg)
3✔
2286
}
2287

2288
// isLoadedFromDisk returns true if the provided channel ID is loaded from
2289
// disk.
2290
//
2291
// NOTE: only returns true for pending channels.
2292
func (p *Brontide) isLoadedFromDisk(chanID lnwire.ChannelID) bool {
3✔
2293
        // If this is a newly added channel, no need to reestablish.
3✔
2294
        _, added := p.addedChannels.Load(chanID)
3✔
2295
        if added {
6✔
2296
                return false
3✔
2297
        }
3✔
2298

2299
        // Return false if the channel is unknown.
2300
        channel, ok := p.activeChannels.Load(chanID)
3✔
2301
        if !ok {
3✔
2302
                return false
×
2303
        }
×
2304

2305
        // During startup, we will use a nil value to mark a pending channel
2306
        // that's loaded from disk.
2307
        return channel == nil
3✔
2308
}
2309

2310
// isActiveChannel returns true if the provided channel id is active, otherwise
2311
// returns false.
2312
func (p *Brontide) isActiveChannel(chanID lnwire.ChannelID) bool {
3✔
2313
        // The channel would be nil if,
3✔
2314
        // - the channel doesn't exist, or,
3✔
2315
        // - the channel exists, but is pending. In this case, we don't
3✔
2316
        //   consider this channel active.
3✔
2317
        channel, _ := p.activeChannels.Load(chanID)
3✔
2318

3✔
2319
        return channel != nil
3✔
2320
}
3✔
2321

2322
// isPendingChannel returns true if the provided channel ID is pending, and
2323
// returns false if the channel is active or unknown.
2324
func (p *Brontide) isPendingChannel(chanID lnwire.ChannelID) bool {
3✔
2325
        // Return false if the channel is unknown.
3✔
2326
        channel, ok := p.activeChannels.Load(chanID)
3✔
2327
        if !ok {
6✔
2328
                return false
3✔
2329
        }
3✔
2330

2331
        return channel == nil
3✔
2332
}
2333

2334
// hasChannel returns true if the peer has a pending/active channel specified
2335
// by the channel ID.
2336
func (p *Brontide) hasChannel(chanID lnwire.ChannelID) bool {
3✔
2337
        _, ok := p.activeChannels.Load(chanID)
3✔
2338
        return ok
3✔
2339
}
3✔
2340

2341
// storeError stores an error in our peer's buffer of recent errors with the
2342
// current timestamp. Errors are only stored if we have at least one active
2343
// channel with the peer to mitigate a dos vector where a peer costlessly
2344
// connects to us and spams us with errors.
2345
func (p *Brontide) storeError(err error) {
3✔
2346
        var haveChannels bool
3✔
2347

3✔
2348
        p.activeChannels.Range(func(_ lnwire.ChannelID,
3✔
2349
                channel *lnwallet.LightningChannel) bool {
6✔
2350

3✔
2351
                // Pending channels will be nil in the activeChannels map.
3✔
2352
                if channel == nil {
6✔
2353
                        // Return true to continue the iteration.
3✔
2354
                        return true
3✔
2355
                }
3✔
2356

2357
                haveChannels = true
3✔
2358

3✔
2359
                // Return false to break the iteration.
3✔
2360
                return false
3✔
2361
        })
2362

2363
        // If we do not have any active channels with the peer, we do not store
2364
        // errors as a dos mitigation.
2365
        if !haveChannels {
6✔
2366
                p.log.Trace("no channels with peer, not storing err")
3✔
2367
                return
3✔
2368
        }
3✔
2369

2370
        p.cfg.ErrorBuffer.Add(
3✔
2371
                &TimestampedError{Timestamp: time.Now(), Error: err},
3✔
2372
        )
3✔
2373
}
2374

2375
// handleWarningOrError processes a warning or error msg and returns true if
2376
// msg should be forwarded to the associated channel link. False is returned if
2377
// any necessary forwarding of msg was already handled by this method. If msg is
2378
// an error from a peer with an active channel, we'll store it in memory.
2379
//
2380
// NOTE: This method should only be called from within the readHandler.
2381
func (p *Brontide) handleWarningOrError(chanID lnwire.ChannelID,
2382
        msg lnwire.Message) bool {
3✔
2383

3✔
2384
        if errMsg, ok := msg.(*lnwire.Error); ok {
6✔
2385
                p.storeError(errMsg)
3✔
2386
        }
3✔
2387

2388
        switch {
3✔
2389
        // Connection wide messages should be forwarded to all channel links
2390
        // with this peer.
2391
        case chanID == lnwire.ConnectionWideID:
×
2392
                for _, chanStream := range p.activeMsgStreams {
×
2393
                        chanStream.AddMsg(msg)
×
2394
                }
×
2395

2396
                return false
×
2397

2398
        // If the channel ID for the message corresponds to a pending channel,
2399
        // then the funding manager will handle it.
2400
        case p.cfg.FundingManager.IsPendingChannel(chanID, p):
3✔
2401
                p.cfg.FundingManager.ProcessFundingMsg(msg, p)
3✔
2402
                return false
3✔
2403

2404
        // If not we hand the message to the channel link for this channel.
2405
        case p.isActiveChannel(chanID):
3✔
2406
                return true
3✔
2407

2408
        default:
3✔
2409
                return false
3✔
2410
        }
2411
}
2412

2413
// messageSummary returns a human-readable string that summarizes a
2414
// incoming/outgoing message. Not all messages will have a summary, only those
2415
// which have additional data that can be informative at a glance.
2416
func messageSummary(msg lnwire.Message) string {
3✔
2417
        switch msg := msg.(type) {
3✔
2418
        case *lnwire.Init:
3✔
2419
                // No summary.
3✔
2420
                return ""
3✔
2421

2422
        case *lnwire.OpenChannel:
3✔
2423
                return fmt.Sprintf("temp_chan_id=%x, chain=%v, csv=%v, amt=%v, "+
3✔
2424
                        "push_amt=%v, reserve=%v, flags=%v",
3✔
2425
                        msg.PendingChannelID[:], msg.ChainHash,
3✔
2426
                        msg.CsvDelay, msg.FundingAmount, msg.PushAmount,
3✔
2427
                        msg.ChannelReserve, msg.ChannelFlags)
3✔
2428

2429
        case *lnwire.AcceptChannel:
3✔
2430
                return fmt.Sprintf("temp_chan_id=%x, reserve=%v, csv=%v, num_confs=%v",
3✔
2431
                        msg.PendingChannelID[:], msg.ChannelReserve, msg.CsvDelay,
3✔
2432
                        msg.MinAcceptDepth)
3✔
2433

2434
        case *lnwire.FundingCreated:
3✔
2435
                return fmt.Sprintf("temp_chan_id=%x, chan_point=%v",
3✔
2436
                        msg.PendingChannelID[:], msg.FundingPoint)
3✔
2437

2438
        case *lnwire.FundingSigned:
3✔
2439
                return fmt.Sprintf("chan_id=%v", msg.ChanID)
3✔
2440

2441
        case *lnwire.ChannelReady:
3✔
2442
                return fmt.Sprintf("chan_id=%v, next_point=%x",
3✔
2443
                        msg.ChanID, msg.NextPerCommitmentPoint.SerializeCompressed())
3✔
2444

2445
        case *lnwire.Shutdown:
3✔
2446
                return fmt.Sprintf("chan_id=%v, script=%x", msg.ChannelID,
3✔
2447
                        msg.Address[:])
3✔
2448

2449
        case *lnwire.ClosingComplete:
3✔
2450
                return fmt.Sprintf("chan_id=%v, fee_sat=%v, locktime=%v",
3✔
2451
                        msg.ChannelID, msg.FeeSatoshis, msg.LockTime)
3✔
2452

2453
        case *lnwire.ClosingSig:
3✔
2454
                return fmt.Sprintf("chan_id=%v", msg.ChannelID)
3✔
2455

2456
        case *lnwire.ClosingSigned:
3✔
2457
                return fmt.Sprintf("chan_id=%v, fee_sat=%v", msg.ChannelID,
3✔
2458
                        msg.FeeSatoshis)
3✔
2459

2460
        case *lnwire.UpdateAddHTLC:
3✔
2461
                var blindingPoint []byte
3✔
2462
                msg.BlindingPoint.WhenSome(
3✔
2463
                        func(b tlv.RecordT[lnwire.BlindingPointTlvType,
3✔
2464
                                *btcec.PublicKey]) {
6✔
2465

3✔
2466
                                blindingPoint = b.Val.SerializeCompressed()
3✔
2467
                        },
3✔
2468
                )
2469

2470
                return fmt.Sprintf("chan_id=%v, id=%v, amt=%v, expiry=%v, "+
3✔
2471
                        "hash=%x, blinding_point=%x, custom_records=%v",
3✔
2472
                        msg.ChanID, msg.ID, msg.Amount, msg.Expiry,
3✔
2473
                        msg.PaymentHash[:], blindingPoint, msg.CustomRecords)
3✔
2474

2475
        case *lnwire.UpdateFailHTLC:
3✔
2476
                return fmt.Sprintf("chan_id=%v, id=%v, reason=%x", msg.ChanID,
3✔
2477
                        msg.ID, msg.Reason)
3✔
2478

2479
        case *lnwire.UpdateFulfillHTLC:
3✔
2480
                return fmt.Sprintf("chan_id=%v, id=%v, preimage=%x, "+
3✔
2481
                        "custom_records=%v", msg.ChanID, msg.ID,
3✔
2482
                        msg.PaymentPreimage[:], msg.CustomRecords)
3✔
2483

2484
        case *lnwire.CommitSig:
3✔
2485
                return fmt.Sprintf("chan_id=%v, num_htlcs=%v", msg.ChanID,
3✔
2486
                        len(msg.HtlcSigs))
3✔
2487

2488
        case *lnwire.RevokeAndAck:
3✔
2489
                return fmt.Sprintf("chan_id=%v, rev=%x, next_point=%x",
3✔
2490
                        msg.ChanID, msg.Revocation[:],
3✔
2491
                        msg.NextRevocationKey.SerializeCompressed())
3✔
2492

2493
        case *lnwire.UpdateFailMalformedHTLC:
3✔
2494
                return fmt.Sprintf("chan_id=%v, id=%v, fail_code=%v",
3✔
2495
                        msg.ChanID, msg.ID, msg.FailureCode)
3✔
2496

2497
        case *lnwire.Warning:
×
2498
                return fmt.Sprintf("%v", msg.Warning())
×
2499

2500
        case *lnwire.Error:
3✔
2501
                return fmt.Sprintf("%v", msg.Error())
3✔
2502

2503
        case *lnwire.AnnounceSignatures1:
3✔
2504
                return fmt.Sprintf("chan_id=%v, short_chan_id=%v", msg.ChannelID,
3✔
2505
                        msg.ShortChannelID.ToUint64())
3✔
2506

2507
        case *lnwire.ChannelAnnouncement1:
3✔
2508
                return fmt.Sprintf("chain_hash=%v, short_chan_id=%v",
3✔
2509
                        msg.ChainHash, msg.ShortChannelID.ToUint64())
3✔
2510

2511
        case *lnwire.ChannelUpdate1:
3✔
2512
                return fmt.Sprintf("chain_hash=%v, short_chan_id=%v, "+
3✔
2513
                        "mflags=%v, cflags=%v, update_time=%v", msg.ChainHash,
3✔
2514
                        msg.ShortChannelID.ToUint64(), msg.MessageFlags,
3✔
2515
                        msg.ChannelFlags, time.Unix(int64(msg.Timestamp), 0))
3✔
2516

2517
        case *lnwire.NodeAnnouncement:
3✔
2518
                return fmt.Sprintf("node=%x, update_time=%v",
3✔
2519
                        msg.NodeID, time.Unix(int64(msg.Timestamp), 0))
3✔
2520

2521
        case *lnwire.Ping:
×
2522
                return fmt.Sprintf("ping_bytes=%x", msg.PaddingBytes[:])
×
2523

2524
        case *lnwire.Pong:
×
2525
                return fmt.Sprintf("len(pong_bytes)=%d", len(msg.PongBytes[:]))
×
2526

2527
        case *lnwire.UpdateFee:
×
2528
                return fmt.Sprintf("chan_id=%v, fee_update_sat=%v",
×
2529
                        msg.ChanID, int64(msg.FeePerKw))
×
2530

2531
        case *lnwire.ChannelReestablish:
3✔
2532
                return fmt.Sprintf("chan_id=%v, next_local_height=%v, "+
3✔
2533
                        "remote_tail_height=%v", msg.ChanID,
3✔
2534
                        msg.NextLocalCommitHeight, msg.RemoteCommitTailHeight)
3✔
2535

2536
        case *lnwire.ReplyShortChanIDsEnd:
3✔
2537
                return fmt.Sprintf("chain_hash=%v, complete=%v", msg.ChainHash,
3✔
2538
                        msg.Complete)
3✔
2539

2540
        case *lnwire.ReplyChannelRange:
3✔
2541
                return fmt.Sprintf("start_height=%v, end_height=%v, "+
3✔
2542
                        "num_chans=%v, encoding=%v", msg.FirstBlockHeight,
3✔
2543
                        msg.LastBlockHeight(), len(msg.ShortChanIDs),
3✔
2544
                        msg.EncodingType)
3✔
2545

2546
        case *lnwire.QueryShortChanIDs:
3✔
2547
                return fmt.Sprintf("chain_hash=%v, encoding=%v, num_chans=%v",
3✔
2548
                        msg.ChainHash, msg.EncodingType, len(msg.ShortChanIDs))
3✔
2549

2550
        case *lnwire.QueryChannelRange:
3✔
2551
                return fmt.Sprintf("chain_hash=%v, start_height=%v, "+
3✔
2552
                        "end_height=%v", msg.ChainHash, msg.FirstBlockHeight,
3✔
2553
                        msg.LastBlockHeight())
3✔
2554

2555
        case *lnwire.GossipTimestampRange:
3✔
2556
                return fmt.Sprintf("chain_hash=%v, first_stamp=%v, "+
3✔
2557
                        "stamp_range=%v", msg.ChainHash,
3✔
2558
                        time.Unix(int64(msg.FirstTimestamp), 0),
3✔
2559
                        msg.TimestampRange)
3✔
2560

2561
        case *lnwire.Stfu:
3✔
2562
                return fmt.Sprintf("chan_id=%v, initiator=%v", msg.ChanID,
3✔
2563
                        msg.Initiator)
3✔
2564

2565
        case *lnwire.Custom:
3✔
2566
                return fmt.Sprintf("type=%d", msg.Type)
3✔
2567
        }
2568

2569
        return fmt.Sprintf("unknown msg type=%T", msg)
×
2570
}
2571

2572
// logWireMessage logs the receipt or sending of particular wire message. This
2573
// function is used rather than just logging the message in order to produce
2574
// less spammy log messages in trace mode by setting the 'Curve" parameter to
2575
// nil. Doing this avoids printing out each of the field elements in the curve
2576
// parameters for secp256k1.
2577
func (p *Brontide) logWireMessage(msg lnwire.Message, read bool) {
3✔
2578
        summaryPrefix := "Received"
3✔
2579
        if !read {
6✔
2580
                summaryPrefix = "Sending"
3✔
2581
        }
3✔
2582

2583
        p.log.Debugf("%v", lnutils.NewLogClosure(func() string {
6✔
2584
                // Debug summary of message.
3✔
2585
                summary := messageSummary(msg)
3✔
2586
                if len(summary) > 0 {
6✔
2587
                        summary = "(" + summary + ")"
3✔
2588
                }
3✔
2589

2590
                preposition := "to"
3✔
2591
                if read {
6✔
2592
                        preposition = "from"
3✔
2593
                }
3✔
2594

2595
                var msgType string
3✔
2596
                if msg.MsgType() < lnwire.CustomTypeStart {
6✔
2597
                        msgType = msg.MsgType().String()
3✔
2598
                } else {
6✔
2599
                        msgType = "custom"
3✔
2600
                }
3✔
2601

2602
                return fmt.Sprintf("%v %v%s %v %s", summaryPrefix,
3✔
2603
                        msgType, summary, preposition, p)
3✔
2604
        }))
2605

2606
        prefix := "readMessage from peer"
3✔
2607
        if !read {
6✔
2608
                prefix = "writeMessage to peer"
3✔
2609
        }
3✔
2610

2611
        p.log.Tracef(prefix+": %v", lnutils.SpewLogClosure(msg))
3✔
2612
}
2613

2614
// writeMessage writes and flushes the target lnwire.Message to the remote peer.
2615
// If the passed message is nil, this method will only try to flush an existing
2616
// message buffered on the connection. It is safe to call this method again
2617
// with a nil message iff a timeout error is returned. This will continue to
2618
// flush the pending message to the wire.
2619
//
2620
// NOTE:
2621
// Besides its usage in Start, this function should not be used elsewhere
2622
// except in writeHandler. If multiple goroutines call writeMessage at the same
2623
// time, panics can occur because WriteMessage and Flush don't use any locking
2624
// internally.
2625
func (p *Brontide) writeMessage(msg lnwire.Message) error {
3✔
2626
        // Only log the message on the first attempt.
3✔
2627
        if msg != nil {
6✔
2628
                p.logWireMessage(msg, false)
3✔
2629
        }
3✔
2630

2631
        noiseConn := p.cfg.Conn
3✔
2632

3✔
2633
        flushMsg := func() error {
6✔
2634
                // Ensure the write deadline is set before we attempt to send
3✔
2635
                // the message.
3✔
2636
                writeDeadline := time.Now().Add(
3✔
2637
                        p.scaleTimeout(writeMessageTimeout),
3✔
2638
                )
3✔
2639
                err := noiseConn.SetWriteDeadline(writeDeadline)
3✔
2640
                if err != nil {
3✔
2641
                        return err
×
2642
                }
×
2643

2644
                // Flush the pending message to the wire. If an error is
2645
                // encountered, e.g. write timeout, the number of bytes written
2646
                // so far will be returned.
2647
                n, err := noiseConn.Flush()
3✔
2648

3✔
2649
                // Record the number of bytes written on the wire, if any.
3✔
2650
                if n > 0 {
6✔
2651
                        atomic.AddUint64(&p.bytesSent, uint64(n))
3✔
2652
                }
3✔
2653

2654
                return err
3✔
2655
        }
2656

2657
        // If the current message has already been serialized, encrypted, and
2658
        // buffered on the underlying connection we will skip straight to
2659
        // flushing it to the wire.
2660
        if msg == nil {
3✔
2661
                return flushMsg()
×
2662
        }
×
2663

2664
        // Otherwise, this is a new message. We'll acquire a write buffer to
2665
        // serialize the message and buffer the ciphertext on the connection.
2666
        err := p.cfg.WritePool.Submit(func(buf *bytes.Buffer) error {
6✔
2667
                // Using a buffer allocated by the write pool, encode the
3✔
2668
                // message directly into the buffer.
3✔
2669
                _, writeErr := lnwire.WriteMessage(buf, msg, 0)
3✔
2670
                if writeErr != nil {
3✔
2671
                        return writeErr
×
2672
                }
×
2673

2674
                // Finally, write the message itself in a single swoop. This
2675
                // will buffer the ciphertext on the underlying connection. We
2676
                // will defer flushing the message until the write pool has been
2677
                // released.
2678
                return noiseConn.WriteMessage(buf.Bytes())
3✔
2679
        })
2680
        if err != nil {
3✔
2681
                return err
×
2682
        }
×
2683

2684
        return flushMsg()
3✔
2685
}
2686

2687
// writeHandler is a goroutine dedicated to reading messages off of an incoming
2688
// queue, and writing them out to the wire. This goroutine coordinates with the
2689
// queueHandler in order to ensure the incoming message queue is quickly
2690
// drained.
2691
//
2692
// NOTE: This method MUST be run as a goroutine.
2693
func (p *Brontide) writeHandler() {
3✔
2694
        // We'll stop the timer after a new messages is sent, and also reset it
3✔
2695
        // after we process the next message.
3✔
2696
        idleTimer := time.AfterFunc(idleTimeout, func() {
3✔
2697
                err := fmt.Errorf("peer %s no write for %s -- disconnecting",
×
2698
                        p, idleTimeout)
×
2699
                p.Disconnect(err)
×
2700
        })
×
2701

2702
        var exitErr error
3✔
2703

3✔
2704
out:
3✔
2705
        for {
6✔
2706
                select {
3✔
2707
                case outMsg := <-p.sendQueue:
3✔
2708
                        // Record the time at which we first attempt to send the
3✔
2709
                        // message.
3✔
2710
                        startTime := time.Now()
3✔
2711

3✔
2712
                retry:
3✔
2713
                        // Write out the message to the socket. If a timeout
2714
                        // error is encountered, we will catch this and retry
2715
                        // after backing off in case the remote peer is just
2716
                        // slow to process messages from the wire.
2717
                        err := p.writeMessage(outMsg.msg)
3✔
2718
                        if nerr, ok := err.(net.Error); ok && nerr.Timeout() {
3✔
2719
                                p.log.Debugf("Write timeout detected for "+
×
2720
                                        "peer, first write for message "+
×
2721
                                        "attempted %v ago",
×
2722
                                        time.Since(startTime))
×
2723

×
2724
                                // If we received a timeout error, this implies
×
2725
                                // that the message was buffered on the
×
2726
                                // connection successfully and that a flush was
×
2727
                                // attempted. We'll set the message to nil so
×
2728
                                // that on a subsequent pass we only try to
×
2729
                                // flush the buffered message, and forgo
×
2730
                                // reserializing or reencrypting it.
×
2731
                                outMsg.msg = nil
×
2732

×
2733
                                goto retry
×
2734
                        }
2735

2736
                        // The write succeeded, reset the idle timer to prevent
2737
                        // us from disconnecting the peer.
2738
                        if !idleTimer.Stop() {
3✔
2739
                                select {
×
2740
                                case <-idleTimer.C:
×
2741
                                default:
×
2742
                                }
2743
                        }
2744
                        idleTimer.Reset(idleTimeout)
3✔
2745

3✔
2746
                        // If the peer requested a synchronous write, respond
3✔
2747
                        // with the error.
3✔
2748
                        if outMsg.errChan != nil {
6✔
2749
                                outMsg.errChan <- err
3✔
2750
                        }
3✔
2751

2752
                        if err != nil {
3✔
2753
                                exitErr = fmt.Errorf("unable to write "+
×
2754
                                        "message: %v", err)
×
2755
                                break out
×
2756
                        }
2757

2758
                case <-p.cg.Done():
3✔
2759
                        p.log.Debug("peer quit, exit writeHandler")
3✔
2760
                        break out
3✔
2761
                }
2762
        }
2763

2764
        // Avoid an exit deadlock by ensuring WaitGroups are decremented before
2765
        // disconnect.
2766
        p.cg.WgDone()
3✔
2767

3✔
2768
        if exitErr != nil {
3✔
NEW
2769
                p.Disconnect(exitErr)
×
NEW
2770
        }
×
2771

2772
        p.log.Trace("writeHandler for peer done")
3✔
2773
}
2774

2775
// queueHandler is responsible for accepting messages from outside subsystems
2776
// to be eventually sent out on the wire by the writeHandler.
2777
//
2778
// NOTE: This method MUST be run as a goroutine.
2779
func (p *Brontide) queueHandler() {
3✔
2780
        defer p.cg.WgDone()
3✔
2781

3✔
2782
        // priorityMsgs holds an in order list of messages deemed high-priority
3✔
2783
        // to be added to the sendQueue. This predominately includes messages
3✔
2784
        // from the funding manager and htlcswitch.
3✔
2785
        priorityMsgs := list.New()
3✔
2786

3✔
2787
        // lazyMsgs holds an in order list of messages deemed low-priority to be
3✔
2788
        // added to the sendQueue only after all high-priority messages have
3✔
2789
        // been queued. This predominately includes messages from the gossiper.
3✔
2790
        lazyMsgs := list.New()
3✔
2791

3✔
2792
        for {
6✔
2793
                // Examine the front of the priority queue, if it is empty check
3✔
2794
                // the low priority queue.
3✔
2795
                elem := priorityMsgs.Front()
3✔
2796
                if elem == nil {
6✔
2797
                        elem = lazyMsgs.Front()
3✔
2798
                }
3✔
2799

2800
                if elem != nil {
6✔
2801
                        front := elem.Value.(outgoingMsg)
3✔
2802

3✔
2803
                        // There's an element on the queue, try adding
3✔
2804
                        // it to the sendQueue. We also watch for
3✔
2805
                        // messages on the outgoingQueue, in case the
3✔
2806
                        // writeHandler cannot accept messages on the
3✔
2807
                        // sendQueue.
3✔
2808
                        select {
3✔
2809
                        case p.sendQueue <- front:
3✔
2810
                                if front.priority {
6✔
2811
                                        priorityMsgs.Remove(elem)
3✔
2812
                                } else {
6✔
2813
                                        lazyMsgs.Remove(elem)
3✔
2814
                                }
3✔
2815
                        case msg := <-p.outgoingQueue:
3✔
2816
                                if msg.priority {
6✔
2817
                                        priorityMsgs.PushBack(msg)
3✔
2818
                                } else {
6✔
2819
                                        lazyMsgs.PushBack(msg)
3✔
2820
                                }
3✔
2821
                        case <-p.cg.Done():
×
2822
                                return
×
2823
                        }
2824
                } else {
3✔
2825
                        // If there weren't any messages to send to the
3✔
2826
                        // writeHandler, then we'll accept a new message
3✔
2827
                        // into the queue from outside sub-systems.
3✔
2828
                        select {
3✔
2829
                        case msg := <-p.outgoingQueue:
3✔
2830
                                if msg.priority {
6✔
2831
                                        priorityMsgs.PushBack(msg)
3✔
2832
                                } else {
6✔
2833
                                        lazyMsgs.PushBack(msg)
3✔
2834
                                }
3✔
2835
                        case <-p.cg.Done():
3✔
2836
                                return
3✔
2837
                        }
2838
                }
2839
        }
2840
}
2841

2842
// PingTime returns the estimated ping time to the peer in microseconds.
2843
func (p *Brontide) PingTime() int64 {
3✔
2844
        return p.pingManager.GetPingTimeMicroSeconds()
3✔
2845
}
3✔
2846

2847
// queueMsg adds the lnwire.Message to the back of the high priority send queue.
2848
// If the errChan is non-nil, an error is sent back if the msg failed to queue
2849
// or failed to write, and nil otherwise.
2850
func (p *Brontide) queueMsg(msg lnwire.Message, errChan chan error) {
3✔
2851
        p.queue(true, msg, errChan)
3✔
2852
}
3✔
2853

2854
// queueMsgLazy adds the lnwire.Message to the back of the low priority send
2855
// queue. If the errChan is non-nil, an error is sent back if the msg failed to
2856
// queue or failed to write, and nil otherwise.
2857
func (p *Brontide) queueMsgLazy(msg lnwire.Message, errChan chan error) {
3✔
2858
        p.queue(false, msg, errChan)
3✔
2859
}
3✔
2860

2861
// queue sends a given message to the queueHandler using the passed priority. If
2862
// the errChan is non-nil, an error is sent back if the msg failed to queue or
2863
// failed to write, and nil otherwise.
2864
func (p *Brontide) queue(priority bool, msg lnwire.Message,
2865
        errChan chan error) {
3✔
2866

3✔
2867
        select {
3✔
2868
        case p.outgoingQueue <- outgoingMsg{priority, msg, errChan}:
3✔
2869
        case <-p.cg.Done():
×
2870
                p.log.Tracef("Peer shutting down, could not enqueue msg: %v.",
×
2871
                        spew.Sdump(msg))
×
2872
                if errChan != nil {
×
2873
                        errChan <- lnpeer.ErrPeerExiting
×
2874
                }
×
2875
        }
2876
}
2877

2878
// ChannelSnapshots returns a slice of channel snapshots detailing all
2879
// currently active channels maintained with the remote peer.
2880
func (p *Brontide) ChannelSnapshots() []*channeldb.ChannelSnapshot {
3✔
2881
        snapshots := make(
3✔
2882
                []*channeldb.ChannelSnapshot, 0, p.activeChannels.Len(),
3✔
2883
        )
3✔
2884

3✔
2885
        p.activeChannels.ForEach(func(_ lnwire.ChannelID,
3✔
2886
                activeChan *lnwallet.LightningChannel) error {
6✔
2887

3✔
2888
                // If the activeChan is nil, then we skip it as the channel is
3✔
2889
                // pending.
3✔
2890
                if activeChan == nil {
6✔
2891
                        return nil
3✔
2892
                }
3✔
2893

2894
                // We'll only return a snapshot for channels that are
2895
                // *immediately* available for routing payments over.
2896
                if activeChan.RemoteNextRevocation() == nil {
6✔
2897
                        return nil
3✔
2898
                }
3✔
2899

2900
                snapshot := activeChan.StateSnapshot()
3✔
2901
                snapshots = append(snapshots, snapshot)
3✔
2902

3✔
2903
                return nil
3✔
2904
        })
2905

2906
        return snapshots
3✔
2907
}
2908

2909
// genDeliveryScript returns a new script to be used to send our funds to in
2910
// the case of a cooperative channel close negotiation.
2911
func (p *Brontide) genDeliveryScript() ([]byte, error) {
3✔
2912
        // We'll send a normal p2wkh address unless we've negotiated the
3✔
2913
        // shutdown-any-segwit feature.
3✔
2914
        addrType := lnwallet.WitnessPubKey
3✔
2915
        if p.taprootShutdownAllowed() {
6✔
2916
                addrType = lnwallet.TaprootPubkey
3✔
2917
        }
3✔
2918

2919
        deliveryAddr, err := p.cfg.Wallet.NewAddress(
3✔
2920
                addrType, false, lnwallet.DefaultAccountName,
3✔
2921
        )
3✔
2922
        if err != nil {
3✔
2923
                return nil, err
×
2924
        }
×
2925
        p.log.Infof("Delivery addr for channel close: %v",
3✔
2926
                deliveryAddr)
3✔
2927

3✔
2928
        return txscript.PayToAddrScript(deliveryAddr)
3✔
2929
}
2930

2931
// channelManager is goroutine dedicated to handling all requests/signals
2932
// pertaining to the opening, cooperative closing, and force closing of all
2933
// channels maintained with the remote peer.
2934
//
2935
// NOTE: This method MUST be run as a goroutine.
2936
func (p *Brontide) channelManager() {
3✔
2937
        defer p.cg.WgDone()
3✔
2938

3✔
2939
        // reenableTimeout will fire once after the configured channel status
3✔
2940
        // interval has elapsed. This will trigger us to sign new channel
3✔
2941
        // updates and broadcast them with the "disabled" flag unset.
3✔
2942
        reenableTimeout := time.After(p.cfg.ChanActiveTimeout)
3✔
2943

3✔
2944
out:
3✔
2945
        for {
6✔
2946
                select {
3✔
2947
                // A new pending channel has arrived which means we are about
2948
                // to complete a funding workflow and is waiting for the final
2949
                // `ChannelReady` messages to be exchanged. We will add this
2950
                // channel to the `activeChannels` with a nil value to indicate
2951
                // this is a pending channel.
2952
                case req := <-p.newPendingChannel:
3✔
2953
                        p.handleNewPendingChannel(req)
3✔
2954

2955
                // A new channel has arrived which means we've just completed a
2956
                // funding workflow. We'll initialize the necessary local
2957
                // state, and notify the htlc switch of a new link.
2958
                case req := <-p.newActiveChannel:
3✔
2959
                        p.handleNewActiveChannel(req)
3✔
2960

2961
                // The funding flow for a pending channel is failed, we will
2962
                // remove it from Brontide.
2963
                case req := <-p.removePendingChannel:
3✔
2964
                        p.handleRemovePendingChannel(req)
3✔
2965

2966
                // We've just received a local request to close an active
2967
                // channel. It will either kick of a cooperative channel
2968
                // closure negotiation, or be a notification of a breached
2969
                // contract that should be abandoned.
2970
                case req := <-p.localCloseChanReqs:
3✔
2971
                        p.handleLocalCloseReq(req)
3✔
2972

2973
                // We've received a link failure from a link that was added to
2974
                // the switch. This will initiate the teardown of the link, and
2975
                // initiate any on-chain closures if necessary.
2976
                case failure := <-p.linkFailures:
3✔
2977
                        p.handleLinkFailure(failure)
3✔
2978

2979
                // We've received a new cooperative channel closure related
2980
                // message from the remote peer, we'll use this message to
2981
                // advance the chan closer state machine.
2982
                case closeMsg := <-p.chanCloseMsgs:
3✔
2983
                        p.handleCloseMsg(closeMsg)
3✔
2984

2985
                // The channel reannounce delay has elapsed, broadcast the
2986
                // reenabled channel updates to the network. This should only
2987
                // fire once, so we set the reenableTimeout channel to nil to
2988
                // mark it for garbage collection. If the peer is torn down
2989
                // before firing, reenabling will not be attempted.
2990
                // TODO(conner): consolidate reenables timers inside chan status
2991
                // manager
2992
                case <-reenableTimeout:
3✔
2993
                        p.reenableActiveChannels()
3✔
2994

3✔
2995
                        // Since this channel will never fire again during the
3✔
2996
                        // lifecycle of the peer, we nil the channel to mark it
3✔
2997
                        // eligible for garbage collection, and make this
3✔
2998
                        // explicitly ineligible to receive in future calls to
3✔
2999
                        // select. This also shaves a few CPU cycles since the
3✔
3000
                        // select will ignore this case entirely.
3✔
3001
                        reenableTimeout = nil
3✔
3002

3✔
3003
                        // Once the reenabling is attempted, we also cancel the
3✔
3004
                        // channel event subscription to free up the overflow
3✔
3005
                        // queue used in channel notifier.
3✔
3006
                        //
3✔
3007
                        // NOTE: channelEventClient will be nil if the
3✔
3008
                        // reenableTimeout is greater than 1 minute.
3✔
3009
                        if p.channelEventClient != nil {
6✔
3010
                                p.channelEventClient.Cancel()
3✔
3011
                        }
3✔
3012

3013
                case <-p.cg.Done():
3✔
3014
                        // As, we've been signalled to exit, we'll reset all
3✔
3015
                        // our active channel back to their default state.
3✔
3016
                        p.activeChannels.ForEach(func(_ lnwire.ChannelID,
3✔
3017
                                lc *lnwallet.LightningChannel) error {
6✔
3018

3✔
3019
                                // Exit if the channel is nil as it's a pending
3✔
3020
                                // channel.
3✔
3021
                                if lc == nil {
6✔
3022
                                        return nil
3✔
3023
                                }
3✔
3024

3025
                                lc.ResetState()
3✔
3026

3✔
3027
                                return nil
3✔
3028
                        })
3029

3030
                        break out
3✔
3031
                }
3032
        }
3033
}
3034

3035
// reenableActiveChannels searches the index of channels maintained with this
3036
// peer, and reenables each public, non-pending channel. This is done at the
3037
// gossip level by broadcasting a new ChannelUpdate with the disabled bit unset.
3038
// No message will be sent if the channel is already enabled.
3039
func (p *Brontide) reenableActiveChannels() {
3✔
3040
        // First, filter all known channels with this peer for ones that are
3✔
3041
        // both public and not pending.
3✔
3042
        activePublicChans := p.filterChannelsToEnable()
3✔
3043

3✔
3044
        // Create a map to hold channels that needs to be retried.
3✔
3045
        retryChans := make(map[wire.OutPoint]struct{}, len(activePublicChans))
3✔
3046

3✔
3047
        // For each of the public, non-pending channels, set the channel
3✔
3048
        // disabled bit to false and send out a new ChannelUpdate. If this
3✔
3049
        // channel is already active, the update won't be sent.
3✔
3050
        for _, chanPoint := range activePublicChans {
6✔
3051
                err := p.cfg.ChanStatusMgr.RequestEnable(chanPoint, false)
3✔
3052

3✔
3053
                switch {
3✔
3054
                // No error occurred, continue to request the next channel.
3055
                case err == nil:
3✔
3056
                        continue
3✔
3057

3058
                // Cannot auto enable a manually disabled channel so we do
3059
                // nothing but proceed to the next channel.
3060
                case errors.Is(err, netann.ErrEnableManuallyDisabledChan):
3✔
3061
                        p.log.Debugf("Channel(%v) was manually disabled, "+
3✔
3062
                                "ignoring automatic enable request", chanPoint)
3✔
3063

3✔
3064
                        continue
3✔
3065

3066
                // If the channel is reported as inactive, we will give it
3067
                // another chance. When handling the request, ChanStatusManager
3068
                // will check whether the link is active or not. One of the
3069
                // conditions is whether the link has been marked as
3070
                // reestablished, which happens inside a goroutine(htlcManager)
3071
                // after the link is started. And we may get a false negative
3072
                // saying the link is not active because that goroutine hasn't
3073
                // reached the line to mark the reestablishment. Thus we give
3074
                // it a second chance to send the request.
3075
                case errors.Is(err, netann.ErrEnableInactiveChan):
×
3076
                        // If we don't have a client created, it means we
×
3077
                        // shouldn't retry enabling the channel.
×
3078
                        if p.channelEventClient == nil {
×
3079
                                p.log.Errorf("Channel(%v) request enabling "+
×
3080
                                        "failed due to inactive link",
×
3081
                                        chanPoint)
×
3082

×
3083
                                continue
×
3084
                        }
3085

3086
                        p.log.Warnf("Channel(%v) cannot be enabled as " +
×
3087
                                "ChanStatusManager reported inactive, retrying")
×
3088

×
3089
                        // Add the channel to the retry map.
×
3090
                        retryChans[chanPoint] = struct{}{}
×
3091
                }
3092
        }
3093

3094
        // Retry the channels if we have any.
3095
        if len(retryChans) != 0 {
3✔
3096
                p.retryRequestEnable(retryChans)
×
3097
        }
×
3098
}
3099

3100
// fetchActiveChanCloser attempts to fetch the active chan closer state machine
3101
// for the target channel ID. If the channel isn't active an error is returned.
3102
// Otherwise, either an existing state machine will be returned, or a new one
3103
// will be created.
3104
func (p *Brontide) fetchActiveChanCloser(chanID lnwire.ChannelID) (
3105
        *chanCloserFsm, error) {
3✔
3106

3✔
3107
        chanCloser, found := p.activeChanCloses.Load(chanID)
3✔
3108
        if found {
6✔
3109
                // An entry will only be found if the closer has already been
3✔
3110
                // created for a non-pending channel or for a channel that had
3✔
3111
                // previously started the shutdown process but the connection
3✔
3112
                // was restarted.
3✔
3113
                return &chanCloser, nil
3✔
3114
        }
3✔
3115

3116
        // First, we'll ensure that we actually know of the target channel. If
3117
        // not, we'll ignore this message.
3118
        channel, ok := p.activeChannels.Load(chanID)
3✔
3119

3✔
3120
        // If the channel isn't in the map or the channel is nil, return
3✔
3121
        // ErrChannelNotFound as the channel is pending.
3✔
3122
        if !ok || channel == nil {
6✔
3123
                return nil, ErrChannelNotFound
3✔
3124
        }
3✔
3125

3126
        // We'll create a valid closing state machine in order to respond to
3127
        // the initiated cooperative channel closure. First, we set the
3128
        // delivery script that our funds will be paid out to. If an upfront
3129
        // shutdown script was set, we will use it. Otherwise, we get a fresh
3130
        // delivery script.
3131
        //
3132
        // TODO: Expose option to allow upfront shutdown script from watch-only
3133
        // accounts.
3134
        deliveryScript := channel.LocalUpfrontShutdownScript()
3✔
3135
        if len(deliveryScript) == 0 {
6✔
3136
                var err error
3✔
3137
                deliveryScript, err = p.genDeliveryScript()
3✔
3138
                if err != nil {
3✔
3139
                        p.log.Errorf("unable to gen delivery script: %v",
×
3140
                                err)
×
3141
                        return nil, fmt.Errorf("close addr unavailable")
×
3142
                }
×
3143
        }
3144

3145
        // In order to begin fee negotiations, we'll first compute our target
3146
        // ideal fee-per-kw.
3147
        feePerKw, err := p.cfg.FeeEstimator.EstimateFeePerKW(
3✔
3148
                p.cfg.CoopCloseTargetConfs,
3✔
3149
        )
3✔
3150
        if err != nil {
3✔
3151
                p.log.Errorf("unable to query fee estimator: %v", err)
×
3152
                return nil, fmt.Errorf("unable to estimate fee")
×
3153
        }
×
3154

3155
        addr, err := p.addrWithInternalKey(deliveryScript)
3✔
3156
        if err != nil {
3✔
3157
                return nil, fmt.Errorf("unable to parse addr: %w", err)
×
3158
        }
×
3159
        negotiateChanCloser, err := p.createChanCloser(
3✔
3160
                channel, addr, feePerKw, nil, lntypes.Remote,
3✔
3161
        )
3✔
3162
        if err != nil {
3✔
3163
                p.log.Errorf("unable to create chan closer: %v", err)
×
3164
                return nil, fmt.Errorf("unable to create chan closer")
×
3165
        }
×
3166

3167
        chanCloser = makeNegotiateCloser(negotiateChanCloser)
3✔
3168

3✔
3169
        p.activeChanCloses.Store(chanID, chanCloser)
3✔
3170

3✔
3171
        return &chanCloser, nil
3✔
3172
}
3173

3174
// filterChannelsToEnable filters a list of channels to be enabled upon start.
3175
// The filtered channels are active channels that's neither private nor
3176
// pending.
3177
func (p *Brontide) filterChannelsToEnable() []wire.OutPoint {
3✔
3178
        var activePublicChans []wire.OutPoint
3✔
3179

3✔
3180
        p.activeChannels.Range(func(chanID lnwire.ChannelID,
3✔
3181
                lnChan *lnwallet.LightningChannel) bool {
6✔
3182

3✔
3183
                // If the lnChan is nil, continue as this is a pending channel.
3✔
3184
                if lnChan == nil {
4✔
3185
                        return true
1✔
3186
                }
1✔
3187

3188
                dbChan := lnChan.State()
3✔
3189
                isPublic := dbChan.ChannelFlags&lnwire.FFAnnounceChannel != 0
3✔
3190
                if !isPublic || dbChan.IsPending {
3✔
3191
                        return true
×
3192
                }
×
3193

3194
                // We'll also skip any channels added during this peer's
3195
                // lifecycle since they haven't waited out the timeout. Their
3196
                // first announcement will be enabled, and the chan status
3197
                // manager will begin monitoring them passively since they exist
3198
                // in the database.
3199
                if _, ok := p.addedChannels.Load(chanID); ok {
4✔
3200
                        return true
1✔
3201
                }
1✔
3202

3203
                activePublicChans = append(
3✔
3204
                        activePublicChans, dbChan.FundingOutpoint,
3✔
3205
                )
3✔
3206

3✔
3207
                return true
3✔
3208
        })
3209

3210
        return activePublicChans
3✔
3211
}
3212

3213
// retryRequestEnable takes a map of channel outpoints and a channel event
3214
// client. It listens to the channel events and removes a channel from the map
3215
// if it's matched to the event. Upon receiving an active channel event, it
3216
// will send the enabling request again.
3217
func (p *Brontide) retryRequestEnable(activeChans map[wire.OutPoint]struct{}) {
×
3218
        p.log.Debugf("Retry enabling %v channels", len(activeChans))
×
3219

×
3220
        // retryEnable is a helper closure that sends an enable request and
×
3221
        // removes the channel from the map if it's matched.
×
3222
        retryEnable := func(chanPoint wire.OutPoint) error {
×
3223
                // If this is an active channel event, check whether it's in
×
3224
                // our targeted channels map.
×
3225
                _, found := activeChans[chanPoint]
×
3226

×
3227
                // If this channel is irrelevant, return nil so the loop can
×
3228
                // jump to next iteration.
×
3229
                if !found {
×
3230
                        return nil
×
3231
                }
×
3232

3233
                // Otherwise we've just received an active signal for a channel
3234
                // that's previously failed to be enabled, we send the request
3235
                // again.
3236
                //
3237
                // We only give the channel one more shot, so we delete it from
3238
                // our map first to keep it from being attempted again.
3239
                delete(activeChans, chanPoint)
×
3240

×
3241
                // Send the request.
×
3242
                err := p.cfg.ChanStatusMgr.RequestEnable(chanPoint, false)
×
3243
                if err != nil {
×
3244
                        return fmt.Errorf("request enabling channel %v "+
×
3245
                                "failed: %w", chanPoint, err)
×
3246
                }
×
3247

3248
                return nil
×
3249
        }
3250

3251
        for {
×
3252
                // If activeChans is empty, we've done processing all the
×
3253
                // channels.
×
3254
                if len(activeChans) == 0 {
×
3255
                        p.log.Debug("Finished retry enabling channels")
×
3256
                        return
×
3257
                }
×
3258

3259
                select {
×
3260
                // A new event has been sent by the ChannelNotifier. We now
3261
                // check whether it's an active or inactive channel event.
3262
                case e := <-p.channelEventClient.Updates():
×
3263
                        // If this is an active channel event, try enable the
×
3264
                        // channel then jump to the next iteration.
×
3265
                        active, ok := e.(channelnotifier.ActiveChannelEvent)
×
3266
                        if ok {
×
3267
                                chanPoint := *active.ChannelPoint
×
3268

×
3269
                                // If we received an error for this particular
×
3270
                                // channel, we log an error and won't quit as
×
3271
                                // we still want to retry other channels.
×
3272
                                if err := retryEnable(chanPoint); err != nil {
×
3273
                                        p.log.Errorf("Retry failed: %v", err)
×
3274
                                }
×
3275

3276
                                continue
×
3277
                        }
3278

3279
                        // Otherwise check for inactive link event, and jump to
3280
                        // next iteration if it's not.
3281
                        inactive, ok := e.(channelnotifier.InactiveLinkEvent)
×
3282
                        if !ok {
×
3283
                                continue
×
3284
                        }
3285

3286
                        // Found an inactive link event, if this is our
3287
                        // targeted channel, remove it from our map.
3288
                        chanPoint := *inactive.ChannelPoint
×
3289
                        _, found := activeChans[chanPoint]
×
3290
                        if !found {
×
3291
                                continue
×
3292
                        }
3293

3294
                        delete(activeChans, chanPoint)
×
3295
                        p.log.Warnf("Re-enable channel %v failed, received "+
×
3296
                                "inactive link event", chanPoint)
×
3297

3298
                case <-p.cg.Done():
×
3299
                        p.log.Debugf("Peer shutdown during retry enabling")
×
3300
                        return
×
3301
                }
3302
        }
3303
}
3304

3305
// chooseDeliveryScript takes two optionally set shutdown scripts and returns
3306
// a suitable script to close out to. This may be nil if neither script is
3307
// set. If both scripts are set, this function will error if they do not match.
3308
func chooseDeliveryScript(upfront, requested lnwire.DeliveryAddress,
3309
        genDeliveryScript func() ([]byte, error),
3310
) (lnwire.DeliveryAddress, error) {
3✔
3311

3✔
3312
        switch {
3✔
3313
        // If no script was provided, then we'll generate a new delivery script.
3314
        case len(upfront) == 0 && len(requested) == 0:
3✔
3315
                return genDeliveryScript()
3✔
3316

3317
        // If no upfront shutdown script was provided, return the user
3318
        // requested address (which may be nil).
3319
        case len(upfront) == 0:
3✔
3320
                return requested, nil
3✔
3321

3322
        // If an upfront shutdown script was provided, and the user did not
3323
        // request a custom shutdown script, return the upfront address.
3324
        case len(requested) == 0:
3✔
3325
                return upfront, nil
3✔
3326

3327
        // If both an upfront shutdown script and a custom close script were
3328
        // provided, error if the user provided shutdown script does not match
3329
        // the upfront shutdown script (because closing out to a different
3330
        // script would violate upfront shutdown).
UNCOV
3331
        case !bytes.Equal(upfront, requested):
×
UNCOV
3332
                return nil, chancloser.ErrUpfrontShutdownScriptMismatch
×
3333

3334
        // The user requested script matches the upfront shutdown script, so we
3335
        // can return it without error.
UNCOV
3336
        default:
×
UNCOV
3337
                return upfront, nil
×
3338
        }
3339
}
3340

3341
// restartCoopClose checks whether we need to restart the cooperative close
3342
// process for a given channel.
3343
func (p *Brontide) restartCoopClose(lnChan *lnwallet.LightningChannel) (
3344
        *lnwire.Shutdown, error) {
3✔
3345

3✔
3346
        isTaprootChan := lnChan.ChanType().IsTaproot()
3✔
3347

3✔
3348
        // If this channel has status ChanStatusCoopBroadcasted and does not
3✔
3349
        // have a closing transaction, then the cooperative close process was
3✔
3350
        // started but never finished. We'll re-create the chanCloser state
3✔
3351
        // machine and resend Shutdown. BOLT#2 requires that we retransmit
3✔
3352
        // Shutdown exactly, but doing so would mean persisting the RPC
3✔
3353
        // provided close script. Instead use the LocalUpfrontShutdownScript
3✔
3354
        // or generate a script.
3✔
3355
        c := lnChan.State()
3✔
3356
        _, err := c.BroadcastedCooperative()
3✔
3357
        if err != nil && err != channeldb.ErrNoCloseTx {
3✔
3358
                // An error other than ErrNoCloseTx was encountered.
×
3359
                return nil, err
×
3360
        } else if err == nil && !p.rbfCoopCloseAllowed() {
3✔
3361
                // This is a channel that doesn't support RBF coop close, and it
×
3362
                // already had a coop close txn broadcast. As a result, we can
×
3363
                // just exit here as all we can do is wait for it to confirm.
×
3364
                return nil, nil
×
3365
        }
×
3366

3367
        chanID := lnwire.NewChanIDFromOutPoint(c.FundingOutpoint)
3✔
3368

3✔
3369
        var deliveryScript []byte
3✔
3370

3✔
3371
        shutdownInfo, err := c.ShutdownInfo()
3✔
3372
        switch {
3✔
3373
        // We have previously stored the delivery script that we need to use
3374
        // in the shutdown message. Re-use this script.
3375
        case err == nil:
3✔
3376
                shutdownInfo.WhenSome(func(info channeldb.ShutdownInfo) {
6✔
3377
                        deliveryScript = info.DeliveryScript.Val
3✔
3378
                })
3✔
3379

3380
        // An error other than ErrNoShutdownInfo was returned
3381
        case !errors.Is(err, channeldb.ErrNoShutdownInfo):
×
3382
                return nil, err
×
3383

3384
        case errors.Is(err, channeldb.ErrNoShutdownInfo):
×
3385
                deliveryScript = c.LocalShutdownScript
×
3386
                if len(deliveryScript) == 0 {
×
3387
                        var err error
×
3388
                        deliveryScript, err = p.genDeliveryScript()
×
3389
                        if err != nil {
×
3390
                                p.log.Errorf("unable to gen delivery script: "+
×
3391
                                        "%v", err)
×
3392

×
3393
                                return nil, fmt.Errorf("close addr unavailable")
×
3394
                        }
×
3395
                }
3396
        }
3397

3398
        // If the new RBF co-op close is negotiated, then we'll init and start
3399
        // that state machine, skipping the steps for the negotiate machine
3400
        // below. We don't support this close type for taproot channels though.
3401
        if p.rbfCoopCloseAllowed() && !isTaprootChan {
6✔
3402
                _, err := p.initRbfChanCloser(lnChan)
3✔
3403
                if err != nil {
3✔
3404
                        return nil, fmt.Errorf("unable to init rbf chan "+
×
3405
                                "closer during restart: %w", err)
×
3406
                }
×
3407

3408
                shutdownDesc := fn.MapOption(
3✔
3409
                        newRestartShutdownInit,
3✔
3410
                )(shutdownInfo)
3✔
3411

3✔
3412
                err = p.startRbfChanCloser(
3✔
3413
                        fn.FlattenOption(shutdownDesc), lnChan.ChannelPoint(),
3✔
3414
                )
3✔
3415

3✔
3416
                return nil, err
3✔
3417
        }
3418

3419
        // Compute an ideal fee.
3420
        feePerKw, err := p.cfg.FeeEstimator.EstimateFeePerKW(
×
3421
                p.cfg.CoopCloseTargetConfs,
×
3422
        )
×
3423
        if err != nil {
×
3424
                p.log.Errorf("unable to query fee estimator: %v", err)
×
3425
                return nil, fmt.Errorf("unable to estimate fee")
×
3426
        }
×
3427

3428
        // Determine whether we or the peer are the initiator of the coop
3429
        // close attempt by looking at the channel's status.
3430
        closingParty := lntypes.Remote
×
3431
        if c.HasChanStatus(channeldb.ChanStatusLocalCloseInitiator) {
×
3432
                closingParty = lntypes.Local
×
3433
        }
×
3434

3435
        addr, err := p.addrWithInternalKey(deliveryScript)
×
3436
        if err != nil {
×
3437
                return nil, fmt.Errorf("unable to parse addr: %w", err)
×
3438
        }
×
3439
        chanCloser, err := p.createChanCloser(
×
3440
                lnChan, addr, feePerKw, nil, closingParty,
×
3441
        )
×
3442
        if err != nil {
×
3443
                p.log.Errorf("unable to create chan closer: %v", err)
×
3444
                return nil, fmt.Errorf("unable to create chan closer")
×
3445
        }
×
3446

3447
        p.activeChanCloses.Store(chanID, makeNegotiateCloser(chanCloser))
×
3448

×
3449
        // Create the Shutdown message.
×
3450
        shutdownMsg, err := chanCloser.ShutdownChan()
×
3451
        if err != nil {
×
3452
                p.log.Errorf("unable to create shutdown message: %v", err)
×
3453
                p.activeChanCloses.Delete(chanID)
×
3454
                return nil, err
×
3455
        }
×
3456

3457
        return shutdownMsg, nil
×
3458
}
3459

3460
// createChanCloser constructs a ChanCloser from the passed parameters and is
3461
// used to de-duplicate code.
3462
func (p *Brontide) createChanCloser(channel *lnwallet.LightningChannel,
3463
        deliveryScript *chancloser.DeliveryAddrWithKey,
3464
        fee chainfee.SatPerKWeight, req *htlcswitch.ChanClose,
3465
        closer lntypes.ChannelParty) (*chancloser.ChanCloser, error) {
3✔
3466

3✔
3467
        _, startingHeight, err := p.cfg.ChainIO.GetBestBlock()
3✔
3468
        if err != nil {
3✔
3469
                p.log.Errorf("unable to obtain best block: %v", err)
×
3470
                return nil, fmt.Errorf("cannot obtain best block")
×
3471
        }
×
3472

3473
        // The req will only be set if we initiated the co-op closing flow.
3474
        var maxFee chainfee.SatPerKWeight
3✔
3475
        if req != nil {
6✔
3476
                maxFee = req.MaxFee
3✔
3477
        }
3✔
3478

3479
        chanCloser := chancloser.NewChanCloser(
3✔
3480
                chancloser.ChanCloseCfg{
3✔
3481
                        Channel:      channel,
3✔
3482
                        MusigSession: NewMusigChanCloser(channel),
3✔
3483
                        FeeEstimator: &chancloser.SimpleCoopFeeEstimator{},
3✔
3484
                        BroadcastTx:  p.cfg.Wallet.PublishTransaction,
3✔
3485
                        AuxCloser:    p.cfg.AuxChanCloser,
3✔
3486
                        DisableChannel: func(op wire.OutPoint) error {
6✔
3487
                                return p.cfg.ChanStatusMgr.RequestDisable(
3✔
3488
                                        op, false,
3✔
3489
                                )
3✔
3490
                        },
3✔
3491
                        MaxFee: maxFee,
3492
                        Disconnect: func() error {
×
3493
                                return p.cfg.DisconnectPeer(p.IdentityKey())
×
3494
                        },
×
3495
                        ChainParams: &p.cfg.Wallet.Cfg.NetParams,
3496
                },
3497
                *deliveryScript,
3498
                fee,
3499
                uint32(startingHeight),
3500
                req,
3501
                closer,
3502
        )
3503

3504
        return chanCloser, nil
3✔
3505
}
3506

3507
// initNegotiateChanCloser initializes the channel closer for a channel that is
3508
// using the original "negotiation" based protocol. This path is used when
3509
// we're the one initiating the channel close.
3510
//
3511
// TODO(roasbeef): can make a MsgEndpoint for existing handling logic to
3512
// further abstract.
3513
func (p *Brontide) initNegotiateChanCloser(req *htlcswitch.ChanClose,
3514
        channel *lnwallet.LightningChannel) error {
3✔
3515

3✔
3516
        // First, we'll choose a delivery address that we'll use to send the
3✔
3517
        // funds to in the case of a successful negotiation.
3✔
3518

3✔
3519
        // An upfront shutdown and user provided script are both optional, but
3✔
3520
        // must be equal if both set  (because we cannot serve a request to
3✔
3521
        // close out to a script which violates upfront shutdown). Get the
3✔
3522
        // appropriate address to close out to (which may be nil if neither are
3✔
3523
        // set) and error if they are both set and do not match.
3✔
3524
        deliveryScript, err := chooseDeliveryScript(
3✔
3525
                channel.LocalUpfrontShutdownScript(), req.DeliveryScript,
3✔
3526
                p.genDeliveryScript,
3✔
3527
        )
3✔
3528
        if err != nil {
3✔
UNCOV
3529
                return fmt.Errorf("cannot close channel %v: %w",
×
UNCOV
3530
                        req.ChanPoint, err)
×
UNCOV
3531
        }
×
3532

3533
        addr, err := p.addrWithInternalKey(deliveryScript)
3✔
3534
        if err != nil {
3✔
3535
                return fmt.Errorf("unable to parse addr for channel "+
×
3536
                        "%v: %w", req.ChanPoint, err)
×
3537
        }
×
3538

3539
        chanCloser, err := p.createChanCloser(
3✔
3540
                channel, addr, req.TargetFeePerKw, req, lntypes.Local,
3✔
3541
        )
3✔
3542
        if err != nil {
3✔
3543
                return fmt.Errorf("unable to make chan closer: %w", err)
×
3544
        }
×
3545

3546
        chanID := lnwire.NewChanIDFromOutPoint(channel.ChannelPoint())
3✔
3547
        p.activeChanCloses.Store(chanID, makeNegotiateCloser(chanCloser))
3✔
3548

3✔
3549
        // Finally, we'll initiate the channel shutdown within the
3✔
3550
        // chanCloser, and send the shutdown message to the remote
3✔
3551
        // party to kick things off.
3✔
3552
        shutdownMsg, err := chanCloser.ShutdownChan()
3✔
3553
        if err != nil {
3✔
3554
                // As we were unable to shutdown the channel, we'll return it
×
3555
                // back to its normal state.
×
3556
                defer channel.ResetState()
×
3557

×
3558
                p.activeChanCloses.Delete(chanID)
×
3559

×
3560
                return fmt.Errorf("unable to shutdown channel: %w", err)
×
3561
        }
×
3562

3563
        link := p.fetchLinkFromKeyAndCid(chanID)
3✔
3564
        if link == nil {
3✔
3565
                // If the link is nil then it means it was already removed from
×
3566
                // the switch or it never existed in the first place. The
×
3567
                // latter case is handled at the beginning of this function, so
×
3568
                // in the case where it has already been removed, we can skip
×
3569
                // adding the commit hook to queue a Shutdown message.
×
3570
                p.log.Warnf("link not found during attempted closure: "+
×
3571
                        "%v", chanID)
×
3572
                return nil
×
3573
        }
×
3574

3575
        if !link.DisableAdds(htlcswitch.Outgoing) {
3✔
3576
                p.log.Warnf("Outgoing link adds already "+
×
3577
                        "disabled: %v", link.ChanID())
×
3578
        }
×
3579

3580
        link.OnCommitOnce(htlcswitch.Outgoing, func() {
6✔
3581
                p.queueMsg(shutdownMsg, nil)
3✔
3582
        })
3✔
3583

3584
        return nil
3✔
3585
}
3586

3587
// chooseAddr returns the provided address if it is non-zero length, otherwise
3588
// None.
3589
func chooseAddr(addr lnwire.DeliveryAddress) fn.Option[lnwire.DeliveryAddress] {
3✔
3590
        if len(addr) == 0 {
6✔
3591
                return fn.None[lnwire.DeliveryAddress]()
3✔
3592
        }
3✔
3593

3594
        return fn.Some(addr)
×
3595
}
3596

3597
// observeRbfCloseUpdates observes the channel for any updates that may
3598
// indicate that a new txid has been broadcasted, or the channel fully closed
3599
// on chain.
3600
func (p *Brontide) observeRbfCloseUpdates(chanCloser *chancloser.RbfChanCloser,
3601
        closeReq *htlcswitch.ChanClose,
3602
        coopCloseStates chancloser.RbfStateSub) {
3✔
3603

3✔
3604
        newStateChan := coopCloseStates.NewItemCreated.ChanOut()
3✔
3605
        defer chanCloser.RemoveStateSub(coopCloseStates)
3✔
3606

3✔
3607
        var (
3✔
3608
                lastTxids    lntypes.Dual[chainhash.Hash]
3✔
3609
                lastFeeRates lntypes.Dual[chainfee.SatPerVByte]
3✔
3610
        )
3✔
3611

3✔
3612
        maybeNotifyTxBroadcast := func(state chancloser.AsymmetricPeerState,
3✔
3613
                party lntypes.ChannelParty) {
6✔
3614

3✔
3615
                // First, check to see if we have an error to report to the
3✔
3616
                // caller. If so, then we''ll return that error and exit, as the
3✔
3617
                // stream will exit as well.
3✔
3618
                if closeErr, ok := state.(*chancloser.CloseErr); ok {
6✔
3619
                        // We hit an error during the last state transition, so
3✔
3620
                        // we'll extract the error then send it to the
3✔
3621
                        // user.
3✔
3622
                        err := closeErr.Err()
3✔
3623

3✔
3624
                        peerLog.Warnf("ChannelPoint(%v): encountered close "+
3✔
3625
                                "err: %v", closeReq.ChanPoint, err)
3✔
3626

3✔
3627
                        select {
3✔
3628
                        case closeReq.Err <- err:
3✔
3629
                        case <-closeReq.Ctx.Done():
×
3630
                        case <-p.cg.Done():
×
3631
                        }
3632

3633
                        return
3✔
3634
                }
3635

3636
                closePending, ok := state.(*chancloser.ClosePending)
3✔
3637

3✔
3638
                // If this isn't the close pending state, we aren't at the
3✔
3639
                // terminal state yet.
3✔
3640
                if !ok {
6✔
3641
                        return
3✔
3642
                }
3✔
3643

3644
                // Only notify if the fee rate is greater.
3645
                newFeeRate := closePending.FeeRate
3✔
3646
                lastFeeRate := lastFeeRates.GetForParty(party)
3✔
3647
                if newFeeRate <= lastFeeRate {
6✔
3648
                        peerLog.Debugf("ChannelPoint(%v): remote party made "+
3✔
3649
                                "update for fee rate %v, but we already have "+
3✔
3650
                                "a higher fee rate of %v", closeReq.ChanPoint,
3✔
3651
                                newFeeRate, lastFeeRate)
3✔
3652

3✔
3653
                        return
3✔
3654
                }
3✔
3655

3656
                feeRate := closePending.FeeRate
3✔
3657
                lastFeeRates.SetForParty(party, feeRate)
3✔
3658

3✔
3659
                // At this point, we'll have a txid that we can use to notify
3✔
3660
                // the client, but only if it's different from the last one we
3✔
3661
                // sent. If the user attempted to bump, but was rejected due to
3✔
3662
                // RBF, then we'll send a redundant update.
3✔
3663
                closingTxid := closePending.CloseTx.TxHash()
3✔
3664
                lastTxid := lastTxids.GetForParty(party)
3✔
3665
                if closeReq != nil && closingTxid != lastTxid {
6✔
3666
                        select {
3✔
3667
                        case closeReq.Updates <- &PendingUpdate{
3668
                                Txid:        closingTxid[:],
3669
                                FeePerVbyte: fn.Some(closePending.FeeRate),
3670
                                IsLocalCloseTx: fn.Some(
3671
                                        party == lntypes.Local,
3672
                                ),
3673
                        }:
3✔
3674

3675
                        case <-closeReq.Ctx.Done():
×
3676
                                return
×
3677

3678
                        case <-p.cg.Done():
×
3679
                                return
×
3680
                        }
3681
                }
3682

3683
                lastTxids.SetForParty(party, closingTxid)
3✔
3684
        }
3685

3686
        peerLog.Infof("Observing RBF close updates for channel %v",
3✔
3687
                closeReq.ChanPoint)
3✔
3688

3✔
3689
        // We'll consume each new incoming state to send out the appropriate
3✔
3690
        // RPC update.
3✔
3691
        for {
6✔
3692
                select {
3✔
3693
                case newState := <-newStateChan:
3✔
3694

3✔
3695
                        switch closeState := newState.(type) {
3✔
3696
                        // Once we've reached the state of pending close, we
3697
                        // have a txid that we broadcasted.
3698
                        case *chancloser.ClosingNegotiation:
3✔
3699
                                peerState := closeState.PeerState
3✔
3700

3✔
3701
                                // Each side may have gained a new co-op close
3✔
3702
                                // tx, so we'll examine both to see if they've
3✔
3703
                                // changed.
3✔
3704
                                maybeNotifyTxBroadcast(
3✔
3705
                                        peerState.GetForParty(lntypes.Local),
3✔
3706
                                        lntypes.Local,
3✔
3707
                                )
3✔
3708
                                maybeNotifyTxBroadcast(
3✔
3709
                                        peerState.GetForParty(lntypes.Remote),
3✔
3710
                                        lntypes.Remote,
3✔
3711
                                )
3✔
3712

3713
                        // Otherwise, if we're transition to CloseFin, then we
3714
                        // know that we're done.
3715
                        case *chancloser.CloseFin:
3✔
3716
                                // To clean up, we'll remove the chan closer
3✔
3717
                                // from the active map, and send the final
3✔
3718
                                // update to the client.
3✔
3719
                                closingTxid := closeState.ConfirmedTx.TxHash()
3✔
3720
                                if closeReq != nil {
6✔
3721
                                        closeReq.Updates <- &ChannelCloseUpdate{
3✔
3722
                                                ClosingTxid: closingTxid[:],
3✔
3723
                                                Success:     true,
3✔
3724
                                        }
3✔
3725
                                }
3✔
3726
                                chanID := lnwire.NewChanIDFromOutPoint(
3✔
3727
                                        *closeReq.ChanPoint,
3✔
3728
                                )
3✔
3729
                                p.activeChanCloses.Delete(chanID)
3✔
3730

3✔
3731
                                return
3✔
3732
                        }
3733

3734
                case <-closeReq.Ctx.Done():
3✔
3735
                        return
3✔
3736

3737
                case <-p.cg.Done():
3✔
3738
                        return
3✔
3739
                }
3740
        }
3741
}
3742

3743
// chanErrorReporter is a simple implementation of the
3744
// chancloser.ErrorReporter. This is bound to a single channel by the channel
3745
// ID.
3746
type chanErrorReporter struct {
3747
        chanID lnwire.ChannelID
3748
        peer   *Brontide
3749
}
3750

3751
// newChanErrorReporter creates a new instance of the chanErrorReporter.
3752
func newChanErrorReporter(chanID lnwire.ChannelID,
3753
        peer *Brontide) *chanErrorReporter {
3✔
3754

3✔
3755
        return &chanErrorReporter{
3✔
3756
                chanID: chanID,
3✔
3757
                peer:   peer,
3✔
3758
        }
3✔
3759
}
3✔
3760

3761
// ReportError is a method that's used to report an error that occurred during
3762
// state machine execution. This is used by the RBF close state machine to
3763
// terminate the state machine and send an error to the remote peer.
3764
//
3765
// This is a part of the chancloser.ErrorReporter interface.
3766
func (c *chanErrorReporter) ReportError(chanErr error) {
×
3767
        c.peer.log.Errorf("coop close error for channel %v: %v",
×
3768
                c.chanID, chanErr)
×
3769

×
3770
        var errMsg []byte
×
3771
        if errors.Is(chanErr, chancloser.ErrInvalidStateTransition) {
×
3772
                errMsg = []byte("unexpected protocol message")
×
3773
        } else {
×
3774
                errMsg = []byte(chanErr.Error())
×
3775
        }
×
3776

3777
        err := c.peer.SendMessageLazy(false, &lnwire.Error{
×
3778
                ChanID: c.chanID,
×
3779
                Data:   errMsg,
×
3780
        })
×
3781
        if err != nil {
×
3782
                c.peer.log.Warnf("unable to send error message to peer: %v",
×
3783
                        err)
×
3784
        }
×
3785

3786
        // After we send the error message to the peer, we'll re-initialize the
3787
        // coop close state machine as they may send a shutdown message to
3788
        // retry the coop close.
3789
        lnChan, ok := c.peer.activeChannels.Load(c.chanID)
×
3790
        if !ok {
×
3791
                return
×
3792
        }
×
3793

3794
        if lnChan == nil {
×
3795
                c.peer.log.Debugf("channel %v is pending, not "+
×
3796
                        "re-initializing coop close state machine",
×
3797
                        c.chanID)
×
3798

×
3799
                return
×
3800
        }
×
3801

3802
        if _, err := c.peer.initRbfChanCloser(lnChan); err != nil {
×
3803
                c.peer.activeChanCloses.Delete(c.chanID)
×
3804

×
3805
                c.peer.log.Errorf("unable to init RBF chan closer after "+
×
3806
                        "error case: %v", err)
×
3807
        }
×
3808
}
3809

3810
// chanFlushEventSentinel is used to send the RBF coop close state machine the
3811
// channel flushed event. We'll wait until the state machine enters the
3812
// ChannelFlushing state, then request the link to send the event once flushed.
3813
//
3814
// NOTE: This MUST be run as a goroutine.
3815
func (p *Brontide) chanFlushEventSentinel(chanCloser *chancloser.RbfChanCloser,
3816
        link htlcswitch.ChannelUpdateHandler,
3817
        channel *lnwallet.LightningChannel) {
3✔
3818

3✔
3819
        defer p.cg.WgDone()
3✔
3820

3✔
3821
        // If there's no link, then the channel has already been flushed, so we
3✔
3822
        // don't need to continue.
3✔
3823
        if link == nil {
6✔
3824
                return
3✔
3825
        }
3✔
3826

3827
        coopCloseStates := chanCloser.RegisterStateEvents()
3✔
3828
        defer chanCloser.RemoveStateSub(coopCloseStates)
3✔
3829

3✔
3830
        newStateChan := coopCloseStates.NewItemCreated.ChanOut()
3✔
3831

3✔
3832
        sendChanFlushed := func() {
6✔
3833
                chanState := channel.StateSnapshot()
3✔
3834

3✔
3835
                peerLog.Infof("ChannelPoint(%v) has been flushed for co-op "+
3✔
3836
                        "close, sending event to chan closer",
3✔
3837
                        channel.ChannelPoint())
3✔
3838

3✔
3839
                chanBalances := chancloser.ShutdownBalances{
3✔
3840
                        LocalBalance:  chanState.LocalBalance,
3✔
3841
                        RemoteBalance: chanState.RemoteBalance,
3✔
3842
                }
3✔
3843
                ctx := context.Background()
3✔
3844
                chanCloser.SendEvent(ctx, &chancloser.ChannelFlushed{
3✔
3845
                        ShutdownBalances: chanBalances,
3✔
3846
                        FreshFlush:       true,
3✔
3847
                })
3✔
3848
        }
3✔
3849

3850
        // We'll wait until the channel enters the ChannelFlushing state. We
3851
        // exit after a success loop. As after the first RBF iteration, the
3852
        // channel will always be flushed.
3853
        for {
6✔
3854
                select {
3✔
3855
                case newState, ok := <-newStateChan:
3✔
3856
                        if !ok {
3✔
3857
                                return
×
3858
                        }
×
3859

3860
                        if _, ok := newState.(*chancloser.ChannelFlushing); ok {
6✔
3861
                                peerLog.Infof("ChannelPoint(%v): rbf coop "+
3✔
3862
                                        "close is awaiting a flushed state, "+
3✔
3863
                                        "registering with link..., ",
3✔
3864
                                        channel.ChannelPoint())
3✔
3865

3✔
3866
                                // Request the link to send the event once the
3✔
3867
                                // channel is flushed. We only need this event
3✔
3868
                                // sent once, so we can exit now.
3✔
3869
                                link.OnFlushedOnce(sendChanFlushed)
3✔
3870

3✔
3871
                                return
3✔
3872
                        }
3✔
3873

3874
                case <-p.cg.Done():
3✔
3875
                        return
3✔
3876
                }
3877
        }
3878
}
3879

3880
// initRbfChanCloser initializes the channel closer for a channel that
3881
// is using the new RBF based co-op close protocol. This only creates the chan
3882
// closer, but doesn't attempt to trigger any manual state transitions.
3883
func (p *Brontide) initRbfChanCloser(
3884
        channel *lnwallet.LightningChannel) (*chancloser.RbfChanCloser, error) {
3✔
3885

3✔
3886
        chanID := lnwire.NewChanIDFromOutPoint(channel.ChannelPoint())
3✔
3887

3✔
3888
        link := p.fetchLinkFromKeyAndCid(chanID)
3✔
3889

3✔
3890
        _, startingHeight, err := p.cfg.ChainIO.GetBestBlock()
3✔
3891
        if err != nil {
3✔
3892
                return nil, fmt.Errorf("cannot obtain best block: %w", err)
×
3893
        }
×
3894

3895
        defaultFeePerKw, err := p.cfg.FeeEstimator.EstimateFeePerKW(
3✔
3896
                p.cfg.CoopCloseTargetConfs,
3✔
3897
        )
3✔
3898
        if err != nil {
3✔
3899
                return nil, fmt.Errorf("unable to estimate fee: %w", err)
×
3900
        }
×
3901

3902
        thawHeight, err := channel.AbsoluteThawHeight()
3✔
3903
        if err != nil {
3✔
3904
                return nil, fmt.Errorf("unable to get thaw height: %w", err)
×
3905
        }
×
3906

3907
        peerPub := *p.IdentityKey()
3✔
3908

3✔
3909
        msgMapper := chancloser.NewRbfMsgMapper(
3✔
3910
                uint32(startingHeight), chanID, peerPub,
3✔
3911
        )
3✔
3912

3✔
3913
        initialState := chancloser.ChannelActive{}
3✔
3914

3✔
3915
        scid := channel.ZeroConfRealScid().UnwrapOr(
3✔
3916
                channel.ShortChanID(),
3✔
3917
        )
3✔
3918

3✔
3919
        env := chancloser.Environment{
3✔
3920
                ChainParams:    p.cfg.Wallet.Cfg.NetParams,
3✔
3921
                ChanPeer:       peerPub,
3✔
3922
                ChanPoint:      channel.ChannelPoint(),
3✔
3923
                ChanID:         chanID,
3✔
3924
                Scid:           scid,
3✔
3925
                ChanType:       channel.ChanType(),
3✔
3926
                DefaultFeeRate: defaultFeePerKw.FeePerVByte(),
3✔
3927
                ThawHeight:     fn.Some(thawHeight),
3✔
3928
                RemoteUpfrontShutdown: chooseAddr(
3✔
3929
                        channel.RemoteUpfrontShutdownScript(),
3✔
3930
                ),
3✔
3931
                LocalUpfrontShutdown: chooseAddr(
3✔
3932
                        channel.LocalUpfrontShutdownScript(),
3✔
3933
                ),
3✔
3934
                NewDeliveryScript: func() (lnwire.DeliveryAddress, error) {
6✔
3935
                        return p.genDeliveryScript()
3✔
3936
                },
3✔
3937
                FeeEstimator: &chancloser.SimpleCoopFeeEstimator{},
3938
                CloseSigner:  channel,
3939
                ChanObserver: newChanObserver(
3940
                        channel, link, p.cfg.ChanStatusMgr,
3941
                ),
3942
        }
3943

3944
        spendEvent := protofsm.RegisterSpend[chancloser.ProtocolEvent]{
3✔
3945
                OutPoint:   channel.ChannelPoint(),
3✔
3946
                PkScript:   channel.FundingTxOut().PkScript,
3✔
3947
                HeightHint: channel.DeriveHeightHint(),
3✔
3948
                PostSpendEvent: fn.Some[chancloser.RbfSpendMapper](
3✔
3949
                        chancloser.SpendMapper,
3✔
3950
                ),
3✔
3951
        }
3✔
3952

3✔
3953
        daemonAdapters := NewLndDaemonAdapters(LndAdapterCfg{
3✔
3954
                MsgSender:     newPeerMsgSender(peerPub, p),
3✔
3955
                TxBroadcaster: p.cfg.Wallet,
3✔
3956
                ChainNotifier: p.cfg.ChainNotifier,
3✔
3957
        })
3✔
3958

3✔
3959
        protoCfg := chancloser.RbfChanCloserCfg{
3✔
3960
                Daemon:        daemonAdapters,
3✔
3961
                InitialState:  &initialState,
3✔
3962
                Env:           &env,
3✔
3963
                InitEvent:     fn.Some[protofsm.DaemonEvent](&spendEvent),
3✔
3964
                ErrorReporter: newChanErrorReporter(chanID, p),
3✔
3965
                MsgMapper: fn.Some[protofsm.MsgMapper[chancloser.ProtocolEvent]]( //nolint:ll
3✔
3966
                        msgMapper,
3✔
3967
                ),
3✔
3968
        }
3✔
3969

3✔
3970
        ctx := context.Background()
3✔
3971
        chanCloser := protofsm.NewStateMachine(protoCfg)
3✔
3972
        chanCloser.Start(ctx)
3✔
3973

3✔
3974
        // Finally, we'll register this new endpoint with the message router so
3✔
3975
        // future co-op close messages are handled by this state machine.
3✔
3976
        err = fn.MapOptionZ(p.msgRouter, func(r msgmux.Router) error {
6✔
3977
                _ = r.UnregisterEndpoint(chanCloser.Name())
3✔
3978

3✔
3979
                return r.RegisterEndpoint(&chanCloser)
3✔
3980
        })
3✔
3981
        if err != nil {
3✔
3982
                chanCloser.Stop()
×
3983

×
3984
                return nil, fmt.Errorf("unable to register endpoint for co-op "+
×
3985
                        "close: %w", err)
×
3986
        }
×
3987

3988
        p.activeChanCloses.Store(chanID, makeRbfCloser(&chanCloser))
3✔
3989

3✔
3990
        // Now that we've created the rbf closer state machine, we'll launch a
3✔
3991
        // new goroutine to eventually send in the ChannelFlushed event once
3✔
3992
        // needed.
3✔
3993
        p.cg.WgAdd(1)
3✔
3994
        go p.chanFlushEventSentinel(&chanCloser, link, channel)
3✔
3995

3✔
3996
        return &chanCloser, nil
3✔
3997
}
3998

3999
// shutdownInit describes the two ways we can initiate a new shutdown. Either we
4000
// got an RPC request to do so (left), or we sent a shutdown message to the
4001
// party (for w/e reason), but crashed before the close was complete.
4002
//
4003
//nolint:ll
4004
type shutdownInit = fn.Option[fn.Either[*htlcswitch.ChanClose, channeldb.ShutdownInfo]]
4005

4006
// shutdownStartFeeRate returns the fee rate that should be used for the
4007
// shutdown.  This returns a doubly wrapped option as the shutdown info might
4008
// be none, and the fee rate is only defined for the user initiated shutdown.
4009
func shutdownStartFeeRate(s shutdownInit) fn.Option[chainfee.SatPerKWeight] {
3✔
4010
        feeRateOpt := fn.MapOption(func(init fn.Either[*htlcswitch.ChanClose,
3✔
4011
                channeldb.ShutdownInfo]) fn.Option[chainfee.SatPerKWeight] {
6✔
4012

3✔
4013
                var feeRate fn.Option[chainfee.SatPerKWeight]
3✔
4014
                init.WhenLeft(func(req *htlcswitch.ChanClose) {
6✔
4015
                        feeRate = fn.Some(req.TargetFeePerKw)
3✔
4016
                })
3✔
4017

4018
                return feeRate
3✔
4019
        })(s)
4020

4021
        return fn.FlattenOption(feeRateOpt)
3✔
4022
}
4023

4024
// shutdownStartAddr returns the delivery address that should be used when
4025
// restarting the shutdown process.  If we didn't send a shutdown before we
4026
// restarted, and the user didn't initiate one either, then None is returned.
4027
func shutdownStartAddr(s shutdownInit) fn.Option[lnwire.DeliveryAddress] {
3✔
4028
        addrOpt := fn.MapOption(func(init fn.Either[*htlcswitch.ChanClose,
3✔
4029
                channeldb.ShutdownInfo]) fn.Option[lnwire.DeliveryAddress] {
6✔
4030

3✔
4031
                var addr fn.Option[lnwire.DeliveryAddress]
3✔
4032
                init.WhenLeft(func(req *htlcswitch.ChanClose) {
6✔
4033
                        if len(req.DeliveryScript) != 0 {
6✔
4034
                                addr = fn.Some(req.DeliveryScript)
3✔
4035
                        }
3✔
4036
                })
4037
                init.WhenRight(func(info channeldb.ShutdownInfo) {
6✔
4038
                        addr = fn.Some(info.DeliveryScript.Val)
3✔
4039
                })
3✔
4040

4041
                return addr
3✔
4042
        })(s)
4043

4044
        return fn.FlattenOption(addrOpt)
3✔
4045
}
4046

4047
// whenRPCShutdown registers a callback to be executed when the shutdown init
4048
// type is and RPC request.
4049
func whenRPCShutdown(s shutdownInit, f func(r *htlcswitch.ChanClose)) {
3✔
4050
        s.WhenSome(func(init fn.Either[*htlcswitch.ChanClose,
3✔
4051
                channeldb.ShutdownInfo]) {
6✔
4052

3✔
4053
                init.WhenLeft(f)
3✔
4054
        })
3✔
4055
}
4056

4057
// newRestartShutdownInit creates a new shutdownInit for the case where we need
4058
// to restart the shutdown flow after a restart.
4059
func newRestartShutdownInit(info channeldb.ShutdownInfo) shutdownInit {
3✔
4060
        return fn.Some(fn.NewRight[*htlcswitch.ChanClose](info))
3✔
4061
}
3✔
4062

4063
// newRPCShutdownInit creates a new shutdownInit for the case where we
4064
// initiated the shutdown via an RPC client.
4065
func newRPCShutdownInit(req *htlcswitch.ChanClose) shutdownInit {
3✔
4066
        return fn.Some(
3✔
4067
                fn.NewLeft[*htlcswitch.ChanClose, channeldb.ShutdownInfo](req),
3✔
4068
        )
3✔
4069
}
3✔
4070

4071
// waitUntilRbfCoastClear waits until the RBF co-op close state machine has
4072
// advanced to a terminal state before attempting another fee bump.
4073
func waitUntilRbfCoastClear(ctx context.Context,
4074
        rbfCloser *chancloser.RbfChanCloser) error {
3✔
4075

3✔
4076
        coopCloseStates := rbfCloser.RegisterStateEvents()
3✔
4077
        newStateChan := coopCloseStates.NewItemCreated.ChanOut()
3✔
4078
        defer rbfCloser.RemoveStateSub(coopCloseStates)
3✔
4079

3✔
4080
        isTerminalState := func(newState chancloser.RbfState) bool {
6✔
4081
                // If we're not in the negotiation sub-state, then we aren't at
3✔
4082
                // the terminal state yet.
3✔
4083
                state, ok := newState.(*chancloser.ClosingNegotiation)
3✔
4084
                if !ok {
3✔
4085
                        return false
×
4086
                }
×
4087

4088
                localState := state.PeerState.GetForParty(lntypes.Local)
3✔
4089

3✔
4090
                // If this isn't the close pending state, we aren't at the
3✔
4091
                // terminal state yet.
3✔
4092
                _, ok = localState.(*chancloser.ClosePending)
3✔
4093

3✔
4094
                return ok
3✔
4095
        }
4096

4097
        // Before we enter the subscription loop below, check to see if we're
4098
        // already in the terminal state.
4099
        rbfState, err := rbfCloser.CurrentState()
3✔
4100
        if err != nil {
3✔
4101
                return err
×
4102
        }
×
4103
        if isTerminalState(rbfState) {
6✔
4104
                return nil
3✔
4105
        }
3✔
4106

4107
        peerLog.Debugf("Waiting for RBF iteration to complete...")
×
4108

×
4109
        for {
×
4110
                select {
×
4111
                case newState := <-newStateChan:
×
4112
                        if isTerminalState(newState) {
×
4113
                                return nil
×
4114
                        }
×
4115

4116
                case <-ctx.Done():
×
4117
                        return fmt.Errorf("context canceled")
×
4118
                }
4119
        }
4120
}
4121

4122
// startRbfChanCloser kicks off the co-op close process using the new RBF based
4123
// co-op close protocol. This is called when we're the one that's initiating
4124
// the cooperative channel close.
4125
//
4126
// TODO(roasbeef): just accept the two shutdown pointer params instead??
4127
func (p *Brontide) startRbfChanCloser(shutdown shutdownInit,
4128
        chanPoint wire.OutPoint) error {
3✔
4129

3✔
4130
        // Unlike the old negotiate chan closer, we'll always create the RBF
3✔
4131
        // chan closer on startup, so we can skip init here.
3✔
4132
        chanID := lnwire.NewChanIDFromOutPoint(chanPoint)
3✔
4133
        chanCloser, found := p.activeChanCloses.Load(chanID)
3✔
4134
        if !found {
3✔
4135
                return fmt.Errorf("rbf chan closer not found for channel %v",
×
4136
                        chanPoint)
×
4137
        }
×
4138

4139
        defaultFeePerKw, err := shutdownStartFeeRate(
3✔
4140
                shutdown,
3✔
4141
        ).UnwrapOrFuncErr(func() (chainfee.SatPerKWeight, error) {
6✔
4142
                return p.cfg.FeeEstimator.EstimateFeePerKW(
3✔
4143
                        p.cfg.CoopCloseTargetConfs,
3✔
4144
                )
3✔
4145
        })
3✔
4146
        if err != nil {
3✔
4147
                return fmt.Errorf("unable to estimate fee: %w", err)
×
4148
        }
×
4149

4150
        chanCloser.WhenRight(func(rbfCloser *chancloser.RbfChanCloser) {
6✔
4151
                peerLog.Infof("ChannelPoint(%v): rbf-coop close requested, "+
3✔
4152
                        "sending shutdown", chanPoint)
3✔
4153

3✔
4154
                rbfState, err := rbfCloser.CurrentState()
3✔
4155
                if err != nil {
3✔
4156
                        peerLog.Warnf("ChannelPoint(%v): unable to get "+
×
4157
                                "current state for rbf-coop close: %v",
×
4158
                                chanPoint, err)
×
4159

×
4160
                        return
×
4161
                }
×
4162

4163
                coopCloseStates := rbfCloser.RegisterStateEvents()
3✔
4164

3✔
4165
                // Before we send our event below, we'll launch a goroutine to
3✔
4166
                // watch for the final terminal state to send updates to the RPC
3✔
4167
                // client. We only need to do this if there's an RPC caller.
3✔
4168
                var rpcShutdown bool
3✔
4169
                whenRPCShutdown(shutdown, func(req *htlcswitch.ChanClose) {
6✔
4170
                        rpcShutdown = true
3✔
4171

3✔
4172
                        p.cg.WgAdd(1)
3✔
4173
                        go func() {
6✔
4174
                                defer p.cg.WgDone()
3✔
4175

3✔
4176
                                p.observeRbfCloseUpdates(
3✔
4177
                                        rbfCloser, req, coopCloseStates,
3✔
4178
                                )
3✔
4179
                        }()
3✔
4180
                })
4181

4182
                if !rpcShutdown {
6✔
4183
                        defer rbfCloser.RemoveStateSub(coopCloseStates)
3✔
4184
                }
3✔
4185

4186
                ctx, _ := p.cg.Create(context.Background())
3✔
4187
                feeRate := defaultFeePerKw.FeePerVByte()
3✔
4188

3✔
4189
                // Depending on the state of the state machine, we'll either
3✔
4190
                // kick things off by sending shutdown, or attempt to send a new
3✔
4191
                // offer to the remote party.
3✔
4192
                switch rbfState.(type) {
3✔
4193
                // The channel is still active, so we'll now kick off the co-op
4194
                // close process by instructing it to send a shutdown message to
4195
                // the remote party.
4196
                case *chancloser.ChannelActive:
3✔
4197
                        rbfCloser.SendEvent(
3✔
4198
                                context.Background(),
3✔
4199
                                &chancloser.SendShutdown{
3✔
4200
                                        IdealFeeRate: feeRate,
3✔
4201
                                        DeliveryAddr: shutdownStartAddr(
3✔
4202
                                                shutdown,
3✔
4203
                                        ),
3✔
4204
                                },
3✔
4205
                        )
3✔
4206

4207
                // If we haven't yet sent an offer (didn't have enough funds at
4208
                // the prior fee rate), or we've sent an offer, then we'll
4209
                // trigger a new offer event.
4210
                case *chancloser.ClosingNegotiation:
3✔
4211
                        // Before we send the event below, we'll wait until
3✔
4212
                        // we're in a semi-terminal state.
3✔
4213
                        err := waitUntilRbfCoastClear(ctx, rbfCloser)
3✔
4214
                        if err != nil {
3✔
4215
                                peerLog.Warnf("ChannelPoint(%v): unable to "+
×
4216
                                        "wait for coast to clear: %v",
×
4217
                                        chanPoint, err)
×
4218

×
4219
                                return
×
4220
                        }
×
4221

4222
                        event := chancloser.ProtocolEvent(
3✔
4223
                                &chancloser.SendOfferEvent{
3✔
4224
                                        TargetFeeRate: feeRate,
3✔
4225
                                },
3✔
4226
                        )
3✔
4227
                        rbfCloser.SendEvent(ctx, event)
3✔
4228

4229
                default:
×
4230
                        peerLog.Warnf("ChannelPoint(%v): unexpected state "+
×
4231
                                "for rbf-coop close: %T", chanPoint, rbfState)
×
4232
                }
4233
        })
4234

4235
        return nil
3✔
4236
}
4237

4238
// handleLocalCloseReq kicks-off the workflow to execute a cooperative or
4239
// forced unilateral closure of the channel initiated by a local subsystem.
4240
func (p *Brontide) handleLocalCloseReq(req *htlcswitch.ChanClose) {
3✔
4241
        chanID := lnwire.NewChanIDFromOutPoint(*req.ChanPoint)
3✔
4242

3✔
4243
        channel, ok := p.activeChannels.Load(chanID)
3✔
4244

3✔
4245
        // Though this function can't be called for pending channels, we still
3✔
4246
        // check whether channel is nil for safety.
3✔
4247
        if !ok || channel == nil {
3✔
4248
                err := fmt.Errorf("unable to close channel, ChannelID(%v) is "+
×
4249
                        "unknown", chanID)
×
4250
                p.log.Errorf(err.Error())
×
4251
                req.Err <- err
×
4252
                return
×
4253
        }
×
4254

4255
        isTaprootChan := channel.ChanType().IsTaproot()
3✔
4256

3✔
4257
        switch req.CloseType {
3✔
4258
        // A type of CloseRegular indicates that the user has opted to close
4259
        // out this channel on-chain, so we execute the cooperative channel
4260
        // closure workflow.
4261
        case contractcourt.CloseRegular:
3✔
4262
                var err error
3✔
4263
                switch {
3✔
4264
                // If this is the RBF coop state machine, then we'll instruct
4265
                // it to send the shutdown message. This also might be an RBF
4266
                // iteration, in which case we'll be obtaining a new
4267
                // transaction w/ a higher fee rate.
4268
                //
4269
                // We don't support this close type for taproot channels yet
4270
                // however.
4271
                case !isTaprootChan && p.rbfCoopCloseAllowed():
3✔
4272
                        err = p.startRbfChanCloser(
3✔
4273
                                newRPCShutdownInit(req), channel.ChannelPoint(),
3✔
4274
                        )
3✔
4275
                default:
3✔
4276
                        err = p.initNegotiateChanCloser(req, channel)
3✔
4277
                }
4278

4279
                if err != nil {
3✔
UNCOV
4280
                        p.log.Errorf(err.Error())
×
UNCOV
4281
                        req.Err <- err
×
UNCOV
4282
                }
×
4283

4284
        // A type of CloseBreach indicates that the counterparty has breached
4285
        // the channel therefore we need to clean up our local state.
4286
        case contractcourt.CloseBreach:
×
4287
                // TODO(roasbeef): no longer need with newer beach logic?
×
4288
                p.log.Infof("ChannelPoint(%v) has been breached, wiping "+
×
4289
                        "channel", req.ChanPoint)
×
4290
                p.WipeChannel(req.ChanPoint)
×
4291
        }
4292
}
4293

4294
// linkFailureReport is sent to the channelManager whenever a link reports a
4295
// link failure, and is forced to exit. The report houses the necessary
4296
// information to clean up the channel state, send back the error message, and
4297
// force close if necessary.
4298
type linkFailureReport struct {
4299
        chanPoint   wire.OutPoint
4300
        chanID      lnwire.ChannelID
4301
        shortChanID lnwire.ShortChannelID
4302
        linkErr     htlcswitch.LinkFailureError
4303
}
4304

4305
// handleLinkFailure processes a link failure report when a link in the switch
4306
// fails. It facilitates the removal of all channel state within the peer,
4307
// force closing the channel depending on severity, and sending the error
4308
// message back to the remote party.
4309
func (p *Brontide) handleLinkFailure(failure linkFailureReport) {
3✔
4310
        // Retrieve the channel from the map of active channels. We do this to
3✔
4311
        // have access to it even after WipeChannel remove it from the map.
3✔
4312
        chanID := lnwire.NewChanIDFromOutPoint(failure.chanPoint)
3✔
4313
        lnChan, _ := p.activeChannels.Load(chanID)
3✔
4314

3✔
4315
        // We begin by wiping the link, which will remove it from the switch,
3✔
4316
        // such that it won't be attempted used for any more updates.
3✔
4317
        //
3✔
4318
        // TODO(halseth): should introduce a way to atomically stop/pause the
3✔
4319
        // link and cancel back any adds in its mailboxes such that we can
3✔
4320
        // safely force close without the link being added again and updates
3✔
4321
        // being applied.
3✔
4322
        p.WipeChannel(&failure.chanPoint)
3✔
4323

3✔
4324
        // If the error encountered was severe enough, we'll now force close
3✔
4325
        // the channel to prevent reading it to the switch in the future.
3✔
4326
        if failure.linkErr.FailureAction == htlcswitch.LinkFailureForceClose {
6✔
4327
                p.log.Warnf("Force closing link(%v)", failure.shortChanID)
3✔
4328

3✔
4329
                closeTx, err := p.cfg.ChainArb.ForceCloseContract(
3✔
4330
                        failure.chanPoint,
3✔
4331
                )
3✔
4332
                if err != nil {
6✔
4333
                        p.log.Errorf("unable to force close "+
3✔
4334
                                "link(%v): %v", failure.shortChanID, err)
3✔
4335
                } else {
6✔
4336
                        p.log.Infof("channel(%v) force "+
3✔
4337
                                "closed with txid %v",
3✔
4338
                                failure.shortChanID, closeTx.TxHash())
3✔
4339
                }
3✔
4340
        }
4341

4342
        // If this is a permanent failure, we will mark the channel borked.
4343
        if failure.linkErr.PermanentFailure && lnChan != nil {
3✔
4344
                p.log.Warnf("Marking link(%v) borked due to permanent "+
×
4345
                        "failure", failure.shortChanID)
×
4346

×
4347
                if err := lnChan.State().MarkBorked(); err != nil {
×
4348
                        p.log.Errorf("Unable to mark channel %v borked: %v",
×
4349
                                failure.shortChanID, err)
×
4350
                }
×
4351
        }
4352

4353
        // Send an error to the peer, why we failed the channel.
4354
        if failure.linkErr.ShouldSendToPeer() {
6✔
4355
                // If SendData is set, send it to the peer. If not, we'll use
3✔
4356
                // the standard error messages in the payload. We only include
3✔
4357
                // sendData in the cases where the error data does not contain
3✔
4358
                // sensitive information.
3✔
4359
                data := []byte(failure.linkErr.Error())
3✔
4360
                if failure.linkErr.SendData != nil {
3✔
4361
                        data = failure.linkErr.SendData
×
4362
                }
×
4363

4364
                var networkMsg lnwire.Message
3✔
4365
                if failure.linkErr.Warning {
3✔
4366
                        networkMsg = &lnwire.Warning{
×
4367
                                ChanID: failure.chanID,
×
4368
                                Data:   data,
×
4369
                        }
×
4370
                } else {
3✔
4371
                        networkMsg = &lnwire.Error{
3✔
4372
                                ChanID: failure.chanID,
3✔
4373
                                Data:   data,
3✔
4374
                        }
3✔
4375
                }
3✔
4376

4377
                err := p.SendMessage(true, networkMsg)
3✔
4378
                if err != nil {
3✔
4379
                        p.log.Errorf("unable to send msg to "+
×
4380
                                "remote peer: %v", err)
×
4381
                }
×
4382
        }
4383

4384
        // If the failure action is disconnect, then we'll execute that now. If
4385
        // we had to send an error above, it was a sync call, so we expect the
4386
        // message to be flushed on the wire by now.
4387
        if failure.linkErr.FailureAction == htlcswitch.LinkFailureDisconnect {
3✔
4388
                p.Disconnect(fmt.Errorf("link requested disconnect"))
×
4389
        }
×
4390
}
4391

4392
// fetchLinkFromKeyAndCid fetches a link from the switch via the remote's
4393
// public key and the channel id.
4394
func (p *Brontide) fetchLinkFromKeyAndCid(
4395
        cid lnwire.ChannelID) htlcswitch.ChannelUpdateHandler {
3✔
4396

3✔
4397
        var chanLink htlcswitch.ChannelUpdateHandler
3✔
4398

3✔
4399
        // We don't need to check the error here, and can instead just loop
3✔
4400
        // over the slice and return nil.
3✔
4401
        links, _ := p.cfg.Switch.GetLinksByInterface(p.cfg.PubKeyBytes)
3✔
4402
        for _, link := range links {
6✔
4403
                if link.ChanID() == cid {
6✔
4404
                        chanLink = link
3✔
4405
                        break
3✔
4406
                }
4407
        }
4408

4409
        return chanLink
3✔
4410
}
4411

4412
// finalizeChanClosure performs the final clean up steps once the cooperative
4413
// closure transaction has been fully broadcast. The finalized closing state
4414
// machine should be passed in. Once the transaction has been sufficiently
4415
// confirmed, the channel will be marked as fully closed within the database,
4416
// and any clients will be notified of updates to the closing state.
4417
func (p *Brontide) finalizeChanClosure(chanCloser *chancloser.ChanCloser) {
3✔
4418
        closeReq := chanCloser.CloseRequest()
3✔
4419

3✔
4420
        // First, we'll clear all indexes related to the channel in question.
3✔
4421
        chanPoint := chanCloser.Channel().ChannelPoint()
3✔
4422
        p.WipeChannel(&chanPoint)
3✔
4423

3✔
4424
        // Also clear the activeChanCloses map of this channel.
3✔
4425
        cid := lnwire.NewChanIDFromOutPoint(chanPoint)
3✔
4426
        p.activeChanCloses.Delete(cid) // TODO(roasbeef): existing race
3✔
4427

3✔
4428
        // Next, we'll launch a goroutine which will request to be notified by
3✔
4429
        // the ChainNotifier once the closure transaction obtains a single
3✔
4430
        // confirmation.
3✔
4431
        notifier := p.cfg.ChainNotifier
3✔
4432

3✔
4433
        // If any error happens during waitForChanToClose, forward it to
3✔
4434
        // closeReq. If this channel closure is not locally initiated, closeReq
3✔
4435
        // will be nil, so just ignore the error.
3✔
4436
        errChan := make(chan error, 1)
3✔
4437
        if closeReq != nil {
6✔
4438
                errChan = closeReq.Err
3✔
4439
        }
3✔
4440

4441
        closingTx, err := chanCloser.ClosingTx()
3✔
4442
        if err != nil {
3✔
4443
                if closeReq != nil {
×
4444
                        p.log.Error(err)
×
4445
                        closeReq.Err <- err
×
4446
                }
×
4447
        }
4448

4449
        closingTxid := closingTx.TxHash()
3✔
4450

3✔
4451
        // If this is a locally requested shutdown, update the caller with a
3✔
4452
        // new event detailing the current pending state of this request.
3✔
4453
        if closeReq != nil {
6✔
4454
                closeReq.Updates <- &PendingUpdate{
3✔
4455
                        Txid: closingTxid[:],
3✔
4456
                }
3✔
4457
        }
3✔
4458

4459
        localOut := chanCloser.LocalCloseOutput()
3✔
4460
        remoteOut := chanCloser.RemoteCloseOutput()
3✔
4461
        auxOut := chanCloser.AuxOutputs()
3✔
4462
        go WaitForChanToClose(
3✔
4463
                chanCloser.NegotiationHeight(), notifier, errChan,
3✔
4464
                &chanPoint, &closingTxid, closingTx.TxOut[0].PkScript, func() {
6✔
4465
                        // Respond to the local subsystem which requested the
3✔
4466
                        // channel closure.
3✔
4467
                        if closeReq != nil {
6✔
4468
                                closeReq.Updates <- &ChannelCloseUpdate{
3✔
4469
                                        ClosingTxid:       closingTxid[:],
3✔
4470
                                        Success:           true,
3✔
4471
                                        LocalCloseOutput:  localOut,
3✔
4472
                                        RemoteCloseOutput: remoteOut,
3✔
4473
                                        AuxOutputs:        auxOut,
3✔
4474
                                }
3✔
4475
                        }
3✔
4476
                },
4477
        )
4478
}
4479

4480
// WaitForChanToClose uses the passed notifier to wait until the channel has
4481
// been detected as closed on chain and then concludes by executing the
4482
// following actions: the channel point will be sent over the settleChan, and
4483
// finally the callback will be executed. If any error is encountered within
4484
// the function, then it will be sent over the errChan.
4485
func WaitForChanToClose(bestHeight uint32, notifier chainntnfs.ChainNotifier,
4486
        errChan chan error, chanPoint *wire.OutPoint,
4487
        closingTxID *chainhash.Hash, closeScript []byte, cb func()) {
3✔
4488

3✔
4489
        peerLog.Infof("Waiting for confirmation of close of ChannelPoint(%v) "+
3✔
4490
                "with txid: %v", chanPoint, closingTxID)
3✔
4491

3✔
4492
        // TODO(roasbeef): add param for num needed confs
3✔
4493
        confNtfn, err := notifier.RegisterConfirmationsNtfn(
3✔
4494
                closingTxID, closeScript, 1, bestHeight,
3✔
4495
        )
3✔
4496
        if err != nil {
3✔
4497
                if errChan != nil {
×
4498
                        errChan <- err
×
4499
                }
×
4500
                return
×
4501
        }
4502

4503
        // In the case that the ChainNotifier is shutting down, all subscriber
4504
        // notification channels will be closed, generating a nil receive.
4505
        height, ok := <-confNtfn.Confirmed
3✔
4506
        if !ok {
6✔
4507
                return
3✔
4508
        }
3✔
4509

4510
        // The channel has been closed, remove it from any active indexes, and
4511
        // the database state.
4512
        peerLog.Infof("ChannelPoint(%v) is now closed at "+
3✔
4513
                "height %v", chanPoint, height.BlockHeight)
3✔
4514

3✔
4515
        // Finally, execute the closure call back to mark the confirmation of
3✔
4516
        // the transaction closing the contract.
3✔
4517
        cb()
3✔
4518
}
4519

4520
// WipeChannel removes the passed channel point from all indexes associated with
4521
// the peer and the switch.
4522
func (p *Brontide) WipeChannel(chanPoint *wire.OutPoint) {
3✔
4523
        chanID := lnwire.NewChanIDFromOutPoint(*chanPoint)
3✔
4524

3✔
4525
        p.activeChannels.Delete(chanID)
3✔
4526

3✔
4527
        // Instruct the HtlcSwitch to close this link as the channel is no
3✔
4528
        // longer active.
3✔
4529
        p.cfg.Switch.RemoveLink(chanID)
3✔
4530
}
3✔
4531

4532
// handleInitMsg handles the incoming init message which contains global and
4533
// local feature vectors. If feature vectors are incompatible then disconnect.
4534
func (p *Brontide) handleInitMsg(msg *lnwire.Init) error {
3✔
4535
        // First, merge any features from the legacy global features field into
3✔
4536
        // those presented in the local features fields.
3✔
4537
        err := msg.Features.Merge(msg.GlobalFeatures)
3✔
4538
        if err != nil {
3✔
4539
                return fmt.Errorf("unable to merge legacy global features: %w",
×
4540
                        err)
×
4541
        }
×
4542

4543
        // Then, finalize the remote feature vector providing the flattened
4544
        // feature bit namespace.
4545
        p.remoteFeatures = lnwire.NewFeatureVector(
3✔
4546
                msg.Features, lnwire.Features,
3✔
4547
        )
3✔
4548

3✔
4549
        // Now that we have their features loaded, we'll ensure that they
3✔
4550
        // didn't set any required bits that we don't know of.
3✔
4551
        err = feature.ValidateRequired(p.remoteFeatures)
3✔
4552
        if err != nil {
3✔
4553
                return fmt.Errorf("invalid remote features: %w", err)
×
4554
        }
×
4555

4556
        // Ensure the remote party's feature vector contains all transitive
4557
        // dependencies. We know ours are correct since they are validated
4558
        // during the feature manager's instantiation.
4559
        err = feature.ValidateDeps(p.remoteFeatures)
3✔
4560
        if err != nil {
3✔
4561
                return fmt.Errorf("invalid remote features: %w", err)
×
4562
        }
×
4563

4564
        // Now that we know we understand their requirements, we'll check to
4565
        // see if they don't support anything that we deem to be mandatory.
4566
        if !p.remoteFeatures.HasFeature(lnwire.DataLossProtectRequired) {
3✔
4567
                return fmt.Errorf("data loss protection required")
×
4568
        }
×
4569

4570
        return nil
3✔
4571
}
4572

4573
// LocalFeatures returns the set of global features that has been advertised by
4574
// the local node. This allows sub-systems that use this interface to gate their
4575
// behavior off the set of negotiated feature bits.
4576
//
4577
// NOTE: Part of the lnpeer.Peer interface.
4578
func (p *Brontide) LocalFeatures() *lnwire.FeatureVector {
3✔
4579
        return p.cfg.Features
3✔
4580
}
3✔
4581

4582
// RemoteFeatures returns the set of global features that has been advertised by
4583
// the remote node. This allows sub-systems that use this interface to gate
4584
// their behavior off the set of negotiated feature bits.
4585
//
4586
// NOTE: Part of the lnpeer.Peer interface.
4587
func (p *Brontide) RemoteFeatures() *lnwire.FeatureVector {
3✔
4588
        return p.remoteFeatures
3✔
4589
}
3✔
4590

4591
// hasNegotiatedScidAlias returns true if we've negotiated the
4592
// option-scid-alias feature bit with the peer.
4593
func (p *Brontide) hasNegotiatedScidAlias() bool {
3✔
4594
        peerHas := p.remoteFeatures.HasFeature(lnwire.ScidAliasOptional)
3✔
4595
        localHas := p.cfg.Features.HasFeature(lnwire.ScidAliasOptional)
3✔
4596
        return peerHas && localHas
3✔
4597
}
3✔
4598

4599
// sendInitMsg sends the Init message to the remote peer. This message contains
4600
// our currently supported local and global features.
4601
func (p *Brontide) sendInitMsg(legacyChan bool) error {
3✔
4602
        features := p.cfg.Features.Clone()
3✔
4603
        legacyFeatures := p.cfg.LegacyFeatures.Clone()
3✔
4604

3✔
4605
        // If we have a legacy channel open with a peer, we downgrade static
3✔
4606
        // remote required to optional in case the peer does not understand the
3✔
4607
        // required feature bit. If we do not do this, the peer will reject our
3✔
4608
        // connection because it does not understand a required feature bit, and
3✔
4609
        // our channel will be unusable.
3✔
4610
        if legacyChan && features.RequiresFeature(lnwire.StaticRemoteKeyRequired) {
3✔
UNCOV
4611
                p.log.Infof("Legacy channel open with peer, " +
×
UNCOV
4612
                        "downgrading static remote required feature bit to " +
×
UNCOV
4613
                        "optional")
×
UNCOV
4614

×
UNCOV
4615
                // Unset and set in both the local and global features to
×
UNCOV
4616
                // ensure both sets are consistent and merge able by old and
×
UNCOV
4617
                // new nodes.
×
UNCOV
4618
                features.Unset(lnwire.StaticRemoteKeyRequired)
×
UNCOV
4619
                legacyFeatures.Unset(lnwire.StaticRemoteKeyRequired)
×
UNCOV
4620

×
UNCOV
4621
                features.Set(lnwire.StaticRemoteKeyOptional)
×
UNCOV
4622
                legacyFeatures.Set(lnwire.StaticRemoteKeyOptional)
×
UNCOV
4623
        }
×
4624

4625
        msg := lnwire.NewInitMessage(
3✔
4626
                legacyFeatures.RawFeatureVector,
3✔
4627
                features.RawFeatureVector,
3✔
4628
        )
3✔
4629

3✔
4630
        return p.writeMessage(msg)
3✔
4631
}
4632

4633
// resendChanSyncMsg will attempt to find a channel sync message for the closed
4634
// channel and resend it to our peer.
4635
func (p *Brontide) resendChanSyncMsg(cid lnwire.ChannelID) error {
3✔
4636
        // If we already re-sent the mssage for this channel, we won't do it
3✔
4637
        // again.
3✔
4638
        if _, ok := p.resentChanSyncMsg[cid]; ok {
4✔
4639
                return nil
1✔
4640
        }
1✔
4641

4642
        // Check if we have any channel sync messages stored for this channel.
4643
        c, err := p.cfg.ChannelDB.FetchClosedChannelForID(cid)
3✔
4644
        if err != nil {
6✔
4645
                return fmt.Errorf("unable to fetch channel sync messages for "+
3✔
4646
                        "peer %v: %v", p, err)
3✔
4647
        }
3✔
4648

4649
        if c.LastChanSyncMsg == nil {
3✔
4650
                return fmt.Errorf("no chan sync message stored for channel %v",
×
4651
                        cid)
×
4652
        }
×
4653

4654
        if !c.RemotePub.IsEqual(p.IdentityKey()) {
3✔
4655
                return fmt.Errorf("ignoring channel reestablish from "+
×
4656
                        "peer=%x", p.IdentityKey().SerializeCompressed())
×
4657
        }
×
4658

4659
        p.log.Debugf("Re-sending channel sync message for channel %v to "+
3✔
4660
                "peer", cid)
3✔
4661

3✔
4662
        if err := p.SendMessage(true, c.LastChanSyncMsg); err != nil {
3✔
4663
                return fmt.Errorf("failed resending channel sync "+
×
4664
                        "message to peer %v: %v", p, err)
×
4665
        }
×
4666

4667
        p.log.Debugf("Re-sent channel sync message for channel %v to peer ",
3✔
4668
                cid)
3✔
4669

3✔
4670
        // Note down that we sent the message, so we won't resend it again for
3✔
4671
        // this connection.
3✔
4672
        p.resentChanSyncMsg[cid] = struct{}{}
3✔
4673

3✔
4674
        return nil
3✔
4675
}
4676

4677
// SendMessage sends a variadic number of high-priority messages to the remote
4678
// peer. The first argument denotes if the method should block until the
4679
// messages have been sent to the remote peer or an error is returned,
4680
// otherwise it returns immediately after queuing.
4681
//
4682
// NOTE: Part of the lnpeer.Peer interface.
4683
func (p *Brontide) SendMessage(sync bool, msgs ...lnwire.Message) error {
3✔
4684
        return p.sendMessage(sync, true, msgs...)
3✔
4685
}
3✔
4686

4687
// SendMessageLazy sends a variadic number of low-priority messages to the
4688
// remote peer. The first argument denotes if the method should block until
4689
// the messages have been sent to the remote peer or an error is returned,
4690
// otherwise it returns immediately after queueing.
4691
//
4692
// NOTE: Part of the lnpeer.Peer interface.
4693
func (p *Brontide) SendMessageLazy(sync bool, msgs ...lnwire.Message) error {
3✔
4694
        return p.sendMessage(sync, false, msgs...)
3✔
4695
}
3✔
4696

4697
// sendMessage queues a variadic number of messages using the passed priority
4698
// to the remote peer. If sync is true, this method will block until the
4699
// messages have been sent to the remote peer or an error is returned, otherwise
4700
// it returns immediately after queueing.
4701
func (p *Brontide) sendMessage(sync, priority bool, msgs ...lnwire.Message) error {
3✔
4702
        // Add all incoming messages to the outgoing queue. A list of error
3✔
4703
        // chans is populated for each message if the caller requested a sync
3✔
4704
        // send.
3✔
4705
        var errChans []chan error
3✔
4706
        if sync {
6✔
4707
                errChans = make([]chan error, 0, len(msgs))
3✔
4708
        }
3✔
4709
        for _, msg := range msgs {
6✔
4710
                // If a sync send was requested, create an error chan to listen
3✔
4711
                // for an ack from the writeHandler.
3✔
4712
                var errChan chan error
3✔
4713
                if sync {
6✔
4714
                        errChan = make(chan error, 1)
3✔
4715
                        errChans = append(errChans, errChan)
3✔
4716
                }
3✔
4717

4718
                if priority {
6✔
4719
                        p.queueMsg(msg, errChan)
3✔
4720
                } else {
6✔
4721
                        p.queueMsgLazy(msg, errChan)
3✔
4722
                }
3✔
4723
        }
4724

4725
        // Wait for all replies from the writeHandler. For async sends, this
4726
        // will be a NOP as the list of error chans is nil.
4727
        for _, errChan := range errChans {
6✔
4728
                select {
3✔
4729
                case err := <-errChan:
3✔
4730
                        return err
3✔
4731
                case <-p.cg.Done():
×
4732
                        return lnpeer.ErrPeerExiting
×
4733
                case <-p.cfg.Quit:
×
4734
                        return lnpeer.ErrPeerExiting
×
4735
                }
4736
        }
4737

4738
        return nil
3✔
4739
}
4740

4741
// PubKey returns the pubkey of the peer in compressed serialized format.
4742
//
4743
// NOTE: Part of the lnpeer.Peer interface.
4744
func (p *Brontide) PubKey() [33]byte {
3✔
4745
        return p.cfg.PubKeyBytes
3✔
4746
}
3✔
4747

4748
// IdentityKey returns the public key of the remote peer.
4749
//
4750
// NOTE: Part of the lnpeer.Peer interface.
4751
func (p *Brontide) IdentityKey() *btcec.PublicKey {
3✔
4752
        return p.cfg.Addr.IdentityKey
3✔
4753
}
3✔
4754

4755
// Address returns the network address of the remote peer.
4756
//
4757
// NOTE: Part of the lnpeer.Peer interface.
4758
func (p *Brontide) Address() net.Addr {
3✔
4759
        return p.cfg.Addr.Address
3✔
4760
}
3✔
4761

4762
// AddNewChannel adds a new channel to the peer. The channel should fail to be
4763
// added if the cancel channel is closed.
4764
//
4765
// NOTE: Part of the lnpeer.Peer interface.
4766
func (p *Brontide) AddNewChannel(newChan *lnpeer.NewChannel,
4767
        cancel <-chan struct{}) error {
3✔
4768

3✔
4769
        errChan := make(chan error, 1)
3✔
4770
        newChanMsg := &newChannelMsg{
3✔
4771
                channel: newChan,
3✔
4772
                err:     errChan,
3✔
4773
        }
3✔
4774

3✔
4775
        select {
3✔
4776
        case p.newActiveChannel <- newChanMsg:
3✔
4777
        case <-cancel:
×
4778
                return errors.New("canceled adding new channel")
×
4779
        case <-p.cg.Done():
×
4780
                return lnpeer.ErrPeerExiting
×
4781
        }
4782

4783
        // We pause here to wait for the peer to recognize the new channel
4784
        // before we close the channel barrier corresponding to the channel.
4785
        select {
3✔
4786
        case err := <-errChan:
3✔
4787
                return err
3✔
4788
        case <-p.cg.Done():
×
4789
                return lnpeer.ErrPeerExiting
×
4790
        }
4791
}
4792

4793
// AddPendingChannel adds a pending open channel to the peer. The channel
4794
// should fail to be added if the cancel channel is closed.
4795
//
4796
// NOTE: Part of the lnpeer.Peer interface.
4797
func (p *Brontide) AddPendingChannel(cid lnwire.ChannelID,
4798
        cancel <-chan struct{}) error {
3✔
4799

3✔
4800
        errChan := make(chan error, 1)
3✔
4801
        newChanMsg := &newChannelMsg{
3✔
4802
                channelID: cid,
3✔
4803
                err:       errChan,
3✔
4804
        }
3✔
4805

3✔
4806
        select {
3✔
4807
        case p.newPendingChannel <- newChanMsg:
3✔
4808

4809
        case <-cancel:
×
4810
                return errors.New("canceled adding pending channel")
×
4811

4812
        case <-p.cg.Done():
×
4813
                return lnpeer.ErrPeerExiting
×
4814
        }
4815

4816
        // We pause here to wait for the peer to recognize the new pending
4817
        // channel before we close the channel barrier corresponding to the
4818
        // channel.
4819
        select {
3✔
4820
        case err := <-errChan:
3✔
4821
                return err
3✔
4822

4823
        case <-cancel:
×
4824
                return errors.New("canceled adding pending channel")
×
4825

4826
        case <-p.cg.Done():
×
4827
                return lnpeer.ErrPeerExiting
×
4828
        }
4829
}
4830

4831
// RemovePendingChannel removes a pending open channel from the peer.
4832
//
4833
// NOTE: Part of the lnpeer.Peer interface.
4834
func (p *Brontide) RemovePendingChannel(cid lnwire.ChannelID) error {
3✔
4835
        errChan := make(chan error, 1)
3✔
4836
        newChanMsg := &newChannelMsg{
3✔
4837
                channelID: cid,
3✔
4838
                err:       errChan,
3✔
4839
        }
3✔
4840

3✔
4841
        select {
3✔
4842
        case p.removePendingChannel <- newChanMsg:
3✔
4843
        case <-p.cg.Done():
×
4844
                return lnpeer.ErrPeerExiting
×
4845
        }
4846

4847
        // We pause here to wait for the peer to respond to the cancellation of
4848
        // the pending channel before we close the channel barrier
4849
        // corresponding to the channel.
4850
        select {
3✔
4851
        case err := <-errChan:
3✔
4852
                return err
3✔
4853

4854
        case <-p.cg.Done():
×
4855
                return lnpeer.ErrPeerExiting
×
4856
        }
4857
}
4858

4859
// StartTime returns the time at which the connection was established if the
4860
// peer started successfully, and zero otherwise.
4861
func (p *Brontide) StartTime() time.Time {
3✔
4862
        return p.startTime
3✔
4863
}
3✔
4864

4865
// handleCloseMsg is called when a new cooperative channel closure related
4866
// message is received from the remote peer. We'll use this message to advance
4867
// the chan closer state machine.
4868
func (p *Brontide) handleCloseMsg(msg *closeMsg) {
3✔
4869
        link := p.fetchLinkFromKeyAndCid(msg.cid)
3✔
4870

3✔
4871
        // We'll now fetch the matching closing state machine in order to
3✔
4872
        // continue, or finalize the channel closure process.
3✔
4873
        chanCloserE, err := p.fetchActiveChanCloser(msg.cid)
3✔
4874
        if err != nil {
6✔
4875
                // If the channel is not known to us, we'll simply ignore this
3✔
4876
                // message.
3✔
4877
                if err == ErrChannelNotFound {
6✔
4878
                        return
3✔
4879
                }
3✔
4880

4881
                p.log.Errorf("Unable to respond to remote close msg: %v", err)
×
4882

×
4883
                errMsg := &lnwire.Error{
×
4884
                        ChanID: msg.cid,
×
4885
                        Data:   lnwire.ErrorData(err.Error()),
×
4886
                }
×
4887
                p.queueMsg(errMsg, nil)
×
4888
                return
×
4889
        }
4890

4891
        if chanCloserE.IsRight() {
3✔
4892
                // TODO(roasbeef): assert?
×
4893
                return
×
4894
        }
×
4895

4896
        // At this point, we'll only enter this call path if a negotiate chan
4897
        // closer was used. So we'll extract that from the either now.
4898
        //
4899
        // TODO(roabeef): need extra helper func for either to make cleaner
4900
        var chanCloser *chancloser.ChanCloser
3✔
4901
        chanCloserE.WhenLeft(func(c *chancloser.ChanCloser) {
6✔
4902
                chanCloser = c
3✔
4903
        })
3✔
4904

4905
        handleErr := func(err error) {
4✔
4906
                err = fmt.Errorf("unable to process close msg: %w", err)
1✔
4907
                p.log.Error(err)
1✔
4908

1✔
4909
                // As the negotiations failed, we'll reset the channel state
1✔
4910
                // machine to ensure we act to on-chain events as normal.
1✔
4911
                chanCloser.Channel().ResetState()
1✔
4912
                if chanCloser.CloseRequest() != nil {
1✔
4913
                        chanCloser.CloseRequest().Err <- err
×
4914
                }
×
4915

4916
                p.activeChanCloses.Delete(msg.cid)
1✔
4917

1✔
4918
                p.Disconnect(err)
1✔
4919
        }
4920

4921
        // Next, we'll process the next message using the target state machine.
4922
        // We'll either continue negotiation, or halt.
4923
        switch typed := msg.msg.(type) {
3✔
4924
        case *lnwire.Shutdown:
3✔
4925
                // Disable incoming adds immediately.
3✔
4926
                if link != nil && !link.DisableAdds(htlcswitch.Incoming) {
3✔
4927
                        p.log.Warnf("Incoming link adds already disabled: %v",
×
4928
                                link.ChanID())
×
4929
                }
×
4930

4931
                oShutdown, err := chanCloser.ReceiveShutdown(*typed)
3✔
4932
                if err != nil {
3✔
4933
                        handleErr(err)
×
4934
                        return
×
4935
                }
×
4936

4937
                oShutdown.WhenSome(func(msg lnwire.Shutdown) {
6✔
4938
                        // If the link is nil it means we can immediately queue
3✔
4939
                        // the Shutdown message since we don't have to wait for
3✔
4940
                        // commitment transaction synchronization.
3✔
4941
                        if link == nil {
3✔
UNCOV
4942
                                p.queueMsg(&msg, nil)
×
UNCOV
4943
                                return
×
UNCOV
4944
                        }
×
4945

4946
                        // Immediately disallow any new HTLC's from being added
4947
                        // in the outgoing direction.
4948
                        if !link.DisableAdds(htlcswitch.Outgoing) {
3✔
4949
                                p.log.Warnf("Outgoing link adds already "+
×
4950
                                        "disabled: %v", link.ChanID())
×
4951
                        }
×
4952

4953
                        // When we have a Shutdown to send, we defer it till the
4954
                        // next time we send a CommitSig to remain spec
4955
                        // compliant.
4956
                        link.OnCommitOnce(htlcswitch.Outgoing, func() {
6✔
4957
                                p.queueMsg(&msg, nil)
3✔
4958
                        })
3✔
4959
                })
4960

4961
                beginNegotiation := func() {
6✔
4962
                        oClosingSigned, err := chanCloser.BeginNegotiation()
3✔
4963
                        if err != nil {
3✔
UNCOV
4964
                                handleErr(err)
×
UNCOV
4965
                                return
×
UNCOV
4966
                        }
×
4967

4968
                        oClosingSigned.WhenSome(func(msg lnwire.ClosingSigned) {
6✔
4969
                                p.queueMsg(&msg, nil)
3✔
4970
                        })
3✔
4971
                }
4972

4973
                if link == nil {
3✔
UNCOV
4974
                        beginNegotiation()
×
4975
                } else {
3✔
4976
                        // Now we register a flush hook to advance the
3✔
4977
                        // ChanCloser and possibly send out a ClosingSigned
3✔
4978
                        // when the link finishes draining.
3✔
4979
                        link.OnFlushedOnce(func() {
6✔
4980
                                // Remove link in goroutine to prevent deadlock.
3✔
4981
                                go p.cfg.Switch.RemoveLink(msg.cid)
3✔
4982
                                beginNegotiation()
3✔
4983
                        })
3✔
4984
                }
4985

4986
        case *lnwire.ClosingSigned:
3✔
4987
                oClosingSigned, err := chanCloser.ReceiveClosingSigned(*typed)
3✔
4988
                if err != nil {
4✔
4989
                        handleErr(err)
1✔
4990
                        return
1✔
4991
                }
1✔
4992

4993
                oClosingSigned.WhenSome(func(msg lnwire.ClosingSigned) {
6✔
4994
                        p.queueMsg(&msg, nil)
3✔
4995
                })
3✔
4996

4997
        default:
×
4998
                panic("impossible closeMsg type")
×
4999
        }
5000

5001
        // If we haven't finished close negotiations, then we'll continue as we
5002
        // can't yet finalize the closure.
5003
        if _, err := chanCloser.ClosingTx(); err != nil {
6✔
5004
                return
3✔
5005
        }
3✔
5006

5007
        // Otherwise, we've agreed on a closing fee! In this case, we'll wrap up
5008
        // the channel closure by notifying relevant sub-systems and launching a
5009
        // goroutine to wait for close tx conf.
5010
        p.finalizeChanClosure(chanCloser)
3✔
5011
}
5012

5013
// HandleLocalCloseChanReqs accepts a *htlcswitch.ChanClose and passes it onto
5014
// the channelManager goroutine, which will shut down the link and possibly
5015
// close the channel.
5016
func (p *Brontide) HandleLocalCloseChanReqs(req *htlcswitch.ChanClose) {
3✔
5017
        select {
3✔
5018
        case p.localCloseChanReqs <- req:
3✔
5019
                p.log.Info("Local close channel request is going to be " +
3✔
5020
                        "delivered to the peer")
3✔
5021
        case <-p.cg.Done():
×
5022
                p.log.Info("Unable to deliver local close channel request " +
×
5023
                        "to peer")
×
5024
        }
5025
}
5026

5027
// NetAddress returns the network of the remote peer as an lnwire.NetAddress.
5028
func (p *Brontide) NetAddress() *lnwire.NetAddress {
3✔
5029
        return p.cfg.Addr
3✔
5030
}
3✔
5031

5032
// Inbound is a getter for the Brontide's Inbound boolean in cfg.
5033
func (p *Brontide) Inbound() bool {
3✔
5034
        return p.cfg.Inbound
3✔
5035
}
3✔
5036

5037
// ConnReq is a getter for the Brontide's connReq in cfg.
5038
func (p *Brontide) ConnReq() *connmgr.ConnReq {
3✔
5039
        return p.cfg.ConnReq
3✔
5040
}
3✔
5041

5042
// ErrorBuffer is a getter for the Brontide's errorBuffer in cfg.
5043
func (p *Brontide) ErrorBuffer() *queue.CircularBuffer {
3✔
5044
        return p.cfg.ErrorBuffer
3✔
5045
}
3✔
5046

5047
// SetAddress sets the remote peer's address given an address.
5048
func (p *Brontide) SetAddress(address net.Addr) {
×
5049
        p.cfg.Addr.Address = address
×
5050
}
×
5051

5052
// ActiveSignal returns the peer's active signal.
5053
func (p *Brontide) ActiveSignal() chan struct{} {
3✔
5054
        return p.activeSignal
3✔
5055
}
3✔
5056

5057
// Conn returns a pointer to the peer's connection struct.
5058
func (p *Brontide) Conn() net.Conn {
3✔
5059
        return p.cfg.Conn
3✔
5060
}
3✔
5061

5062
// BytesReceived returns the number of bytes received from the peer.
5063
func (p *Brontide) BytesReceived() uint64 {
3✔
5064
        return atomic.LoadUint64(&p.bytesReceived)
3✔
5065
}
3✔
5066

5067
// BytesSent returns the number of bytes sent to the peer.
5068
func (p *Brontide) BytesSent() uint64 {
3✔
5069
        return atomic.LoadUint64(&p.bytesSent)
3✔
5070
}
3✔
5071

5072
// LastRemotePingPayload returns the last payload the remote party sent as part
5073
// of their ping.
5074
func (p *Brontide) LastRemotePingPayload() []byte {
3✔
5075
        pingPayload := p.lastPingPayload.Load()
3✔
5076
        if pingPayload == nil {
6✔
5077
                return []byte{}
3✔
5078
        }
3✔
5079

5080
        pingBytes, ok := pingPayload.(lnwire.PingPayload)
×
5081
        if !ok {
×
5082
                return nil
×
5083
        }
×
5084

5085
        return pingBytes
×
5086
}
5087

5088
// attachChannelEventSubscription creates a channel event subscription and
5089
// attaches to client to Brontide if the reenableTimeout is no greater than 1
5090
// minute.
5091
func (p *Brontide) attachChannelEventSubscription() error {
3✔
5092
        // If the timeout is greater than 1 minute, it's unlikely that the link
3✔
5093
        // hasn't yet finished its reestablishment. Return a nil without
3✔
5094
        // creating the client to specify that we don't want to retry.
3✔
5095
        if p.cfg.ChanActiveTimeout > 1*time.Minute {
6✔
5096
                return nil
3✔
5097
        }
3✔
5098

5099
        // When the reenable timeout is less than 1 minute, it's likely the
5100
        // channel link hasn't finished its reestablishment yet. In that case,
5101
        // we'll give it a second chance by subscribing to the channel update
5102
        // events. Upon receiving the `ActiveLinkEvent`, we'll then request
5103
        // enabling the channel again.
5104
        sub, err := p.cfg.ChannelNotifier.SubscribeChannelEvents()
3✔
5105
        if err != nil {
3✔
5106
                return fmt.Errorf("SubscribeChannelEvents failed: %w", err)
×
5107
        }
×
5108

5109
        p.channelEventClient = sub
3✔
5110

3✔
5111
        return nil
3✔
5112
}
5113

5114
// updateNextRevocation updates the existing channel's next revocation if it's
5115
// nil.
5116
func (p *Brontide) updateNextRevocation(c *channeldb.OpenChannel) error {
3✔
5117
        chanPoint := c.FundingOutpoint
3✔
5118
        chanID := lnwire.NewChanIDFromOutPoint(chanPoint)
3✔
5119

3✔
5120
        // Read the current channel.
3✔
5121
        currentChan, loaded := p.activeChannels.Load(chanID)
3✔
5122

3✔
5123
        // currentChan should exist, but we perform a check anyway to avoid nil
3✔
5124
        // pointer dereference.
3✔
5125
        if !loaded {
3✔
UNCOV
5126
                return fmt.Errorf("missing active channel with chanID=%v",
×
UNCOV
5127
                        chanID)
×
UNCOV
5128
        }
×
5129

5130
        // currentChan should not be nil, but we perform a check anyway to
5131
        // avoid nil pointer dereference.
5132
        if currentChan == nil {
3✔
UNCOV
5133
                return fmt.Errorf("found nil active channel with chanID=%v",
×
UNCOV
5134
                        chanID)
×
UNCOV
5135
        }
×
5136

5137
        // If we're being sent a new channel, and our existing channel doesn't
5138
        // have the next revocation, then we need to update the current
5139
        // existing channel.
5140
        if currentChan.RemoteNextRevocation() != nil {
3✔
5141
                return nil
×
5142
        }
×
5143

5144
        p.log.Infof("Processing retransmitted ChannelReady for "+
3✔
5145
                "ChannelPoint(%v)", chanPoint)
3✔
5146

3✔
5147
        nextRevoke := c.RemoteNextRevocation
3✔
5148

3✔
5149
        err := currentChan.InitNextRevocation(nextRevoke)
3✔
5150
        if err != nil {
3✔
5151
                return fmt.Errorf("unable to init next revocation: %w", err)
×
5152
        }
×
5153

5154
        return nil
3✔
5155
}
5156

5157
// addActiveChannel adds a new active channel to the `activeChannels` map. It
5158
// takes a `channeldb.OpenChannel`, creates a `lnwallet.LightningChannel` from
5159
// it and assembles it with a channel link.
5160
func (p *Brontide) addActiveChannel(c *lnpeer.NewChannel) error {
3✔
5161
        chanPoint := c.FundingOutpoint
3✔
5162
        chanID := lnwire.NewChanIDFromOutPoint(chanPoint)
3✔
5163

3✔
5164
        // If we've reached this point, there are two possible scenarios.  If
3✔
5165
        // the channel was in the active channels map as nil, then it was
3✔
5166
        // loaded from disk and we need to send reestablish. Else, it was not
3✔
5167
        // loaded from disk and we don't need to send reestablish as this is a
3✔
5168
        // fresh channel.
3✔
5169
        shouldReestablish := p.isLoadedFromDisk(chanID)
3✔
5170

3✔
5171
        chanOpts := c.ChanOpts
3✔
5172
        if shouldReestablish {
6✔
5173
                // If we have to do the reestablish dance for this channel,
3✔
5174
                // ensure that we don't try to call InitRemoteMusigNonces twice
3✔
5175
                // by calling SkipNonceInit.
3✔
5176
                chanOpts = append(chanOpts, lnwallet.WithSkipNonceInit())
3✔
5177
        }
3✔
5178

5179
        p.cfg.AuxLeafStore.WhenSome(func(s lnwallet.AuxLeafStore) {
3✔
5180
                chanOpts = append(chanOpts, lnwallet.WithLeafStore(s))
×
5181
        })
×
5182
        p.cfg.AuxSigner.WhenSome(func(s lnwallet.AuxSigner) {
3✔
5183
                chanOpts = append(chanOpts, lnwallet.WithAuxSigner(s))
×
5184
        })
×
5185
        p.cfg.AuxResolver.WhenSome(func(s lnwallet.AuxContractResolver) {
3✔
5186
                chanOpts = append(chanOpts, lnwallet.WithAuxResolver(s))
×
5187
        })
×
5188

5189
        // If not already active, we'll add this channel to the set of active
5190
        // channels, so we can look it up later easily according to its channel
5191
        // ID.
5192
        lnChan, err := lnwallet.NewLightningChannel(
3✔
5193
                p.cfg.Signer, c.OpenChannel, p.cfg.SigPool, chanOpts...,
3✔
5194
        )
3✔
5195
        if err != nil {
3✔
5196
                return fmt.Errorf("unable to create LightningChannel: %w", err)
×
5197
        }
×
5198

5199
        // Store the channel in the activeChannels map.
5200
        p.activeChannels.Store(chanID, lnChan)
3✔
5201

3✔
5202
        p.log.Infof("New channel active ChannelPoint(%v) with peer", chanPoint)
3✔
5203

3✔
5204
        // Next, we'll assemble a ChannelLink along with the necessary items it
3✔
5205
        // needs to function.
3✔
5206
        chainEvents, err := p.cfg.ChainArb.SubscribeChannelEvents(chanPoint)
3✔
5207
        if err != nil {
3✔
5208
                return fmt.Errorf("unable to subscribe to chain events: %w",
×
5209
                        err)
×
5210
        }
×
5211

5212
        // We'll query the channel DB for the new channel's initial forwarding
5213
        // policies to determine the policy we start out with.
5214
        initialPolicy, err := p.cfg.ChannelDB.GetInitialForwardingPolicy(chanID)
3✔
5215
        if err != nil {
3✔
5216
                return fmt.Errorf("unable to query for initial forwarding "+
×
5217
                        "policy: %v", err)
×
5218
        }
×
5219

5220
        // Create the link and add it to the switch.
5221
        err = p.addLink(
3✔
5222
                &chanPoint, lnChan, initialPolicy, chainEvents,
3✔
5223
                shouldReestablish, fn.None[lnwire.Shutdown](),
3✔
5224
        )
3✔
5225
        if err != nil {
3✔
5226
                return fmt.Errorf("can't register new channel link(%v) with "+
×
5227
                        "peer", chanPoint)
×
5228
        }
×
5229

5230
        isTaprootChan := c.ChanType.IsTaproot()
3✔
5231

3✔
5232
        // We're using the old co-op close, so we don't need to init the new RBF
3✔
5233
        // chan closer. If this is a taproot channel, then we'll also fall
3✔
5234
        // through, as we don't support this type yet w/ rbf close.
3✔
5235
        if !p.rbfCoopCloseAllowed() || isTaprootChan {
6✔
5236
                return nil
3✔
5237
        }
3✔
5238

5239
        // Now that the link has been added above, we'll also init an RBF chan
5240
        // closer for this channel, but only if the new close feature is
5241
        // negotiated.
5242
        //
5243
        // Creating this here ensures that any shutdown messages sent will be
5244
        // automatically routed by the msg router.
5245
        if _, err := p.initRbfChanCloser(lnChan); err != nil {
3✔
5246
                p.activeChanCloses.Delete(chanID)
×
5247

×
5248
                return fmt.Errorf("unable to init RBF chan closer for new "+
×
5249
                        "chan: %w", err)
×
5250
        }
×
5251

5252
        return nil
3✔
5253
}
5254

5255
// handleNewActiveChannel handles a `newChannelMsg` request. Depending on we
5256
// know this channel ID or not, we'll either add it to the `activeChannels` map
5257
// or init the next revocation for it.
5258
func (p *Brontide) handleNewActiveChannel(req *newChannelMsg) {
3✔
5259
        newChan := req.channel
3✔
5260
        chanPoint := newChan.FundingOutpoint
3✔
5261
        chanID := lnwire.NewChanIDFromOutPoint(chanPoint)
3✔
5262

3✔
5263
        // Only update RemoteNextRevocation if the channel is in the
3✔
5264
        // activeChannels map and if we added the link to the switch. Only
3✔
5265
        // active channels will be added to the switch.
3✔
5266
        if p.isActiveChannel(chanID) {
6✔
5267
                p.log.Infof("Already have ChannelPoint(%v), ignoring",
3✔
5268
                        chanPoint)
3✔
5269

3✔
5270
                // Handle it and close the err chan on the request.
3✔
5271
                close(req.err)
3✔
5272

3✔
5273
                // Update the next revocation point.
3✔
5274
                err := p.updateNextRevocation(newChan.OpenChannel)
3✔
5275
                if err != nil {
3✔
5276
                        p.log.Errorf(err.Error())
×
5277
                }
×
5278

5279
                return
3✔
5280
        }
5281

5282
        // This is a new channel, we now add it to the map.
5283
        if err := p.addActiveChannel(req.channel); err != nil {
3✔
5284
                // Log and send back the error to the request.
×
5285
                p.log.Errorf(err.Error())
×
5286
                req.err <- err
×
5287

×
5288
                return
×
5289
        }
×
5290

5291
        // Close the err chan if everything went fine.
5292
        close(req.err)
3✔
5293
}
5294

5295
// handleNewPendingChannel takes a `newChannelMsg` request and add it to
5296
// `activeChannels` map with nil value. This pending channel will be saved as
5297
// it may become active in the future. Once active, the funding manager will
5298
// send it again via `AddNewChannel`, and we'd handle the link creation there.
5299
func (p *Brontide) handleNewPendingChannel(req *newChannelMsg) {
3✔
5300
        defer close(req.err)
3✔
5301

3✔
5302
        chanID := req.channelID
3✔
5303

3✔
5304
        // If we already have this channel, something is wrong with the funding
3✔
5305
        // flow as it will only be marked as active after `ChannelReady` is
3✔
5306
        // handled. In this case, we will do nothing but log an error, just in
3✔
5307
        // case this is a legit channel.
3✔
5308
        if p.isActiveChannel(chanID) {
3✔
UNCOV
5309
                p.log.Errorf("Channel(%v) is already active, ignoring "+
×
UNCOV
5310
                        "pending channel request", chanID)
×
UNCOV
5311

×
UNCOV
5312
                return
×
UNCOV
5313
        }
×
5314

5315
        // The channel has already been added, we will do nothing and return.
5316
        if p.isPendingChannel(chanID) {
3✔
UNCOV
5317
                p.log.Infof("Channel(%v) is already added, ignoring "+
×
UNCOV
5318
                        "pending channel request", chanID)
×
UNCOV
5319

×
UNCOV
5320
                return
×
UNCOV
5321
        }
×
5322

5323
        // This is a new channel, we now add it to the map `activeChannels`
5324
        // with nil value and mark it as a newly added channel in
5325
        // `addedChannels`.
5326
        p.activeChannels.Store(chanID, nil)
3✔
5327
        p.addedChannels.Store(chanID, struct{}{})
3✔
5328
}
5329

5330
// handleRemovePendingChannel takes a `newChannelMsg` request and removes it
5331
// from `activeChannels` map. The request will be ignored if the channel is
5332
// considered active by Brontide. Noop if the channel ID cannot be found.
5333
func (p *Brontide) handleRemovePendingChannel(req *newChannelMsg) {
3✔
5334
        defer close(req.err)
3✔
5335

3✔
5336
        chanID := req.channelID
3✔
5337

3✔
5338
        // If we already have this channel, something is wrong with the funding
3✔
5339
        // flow as it will only be marked as active after `ChannelReady` is
3✔
5340
        // handled. In this case, we will log an error and exit.
3✔
5341
        if p.isActiveChannel(chanID) {
3✔
UNCOV
5342
                p.log.Errorf("Channel(%v) is active, ignoring remove request",
×
UNCOV
5343
                        chanID)
×
UNCOV
5344
                return
×
UNCOV
5345
        }
×
5346

5347
        // The channel has not been added yet, we will log a warning as there
5348
        // is an unexpected call from funding manager.
5349
        if !p.isPendingChannel(chanID) {
6✔
5350
                p.log.Warnf("Channel(%v) not found, removing it anyway", chanID)
3✔
5351
        }
3✔
5352

5353
        // Remove the record of this pending channel.
5354
        p.activeChannels.Delete(chanID)
3✔
5355
        p.addedChannels.Delete(chanID)
3✔
5356
}
5357

5358
// sendLinkUpdateMsg sends a message that updates the channel to the
5359
// channel's message stream.
5360
func (p *Brontide) sendLinkUpdateMsg(cid lnwire.ChannelID, msg lnwire.Message) {
3✔
5361
        p.log.Tracef("Sending link update msg=%v", msg.MsgType())
3✔
5362

3✔
5363
        chanStream, ok := p.activeMsgStreams[cid]
3✔
5364
        if !ok {
6✔
5365
                // If a stream hasn't yet been created, then we'll do so, add
3✔
5366
                // it to the map, and finally start it.
3✔
5367
                chanStream = newChanMsgStream(p, cid)
3✔
5368
                p.activeMsgStreams[cid] = chanStream
3✔
5369
                chanStream.Start()
3✔
5370

3✔
5371
                // Stop the stream when quit.
3✔
5372
                go func() {
6✔
5373
                        <-p.cg.Done()
3✔
5374
                        chanStream.Stop()
3✔
5375
                }()
3✔
5376
        }
5377

5378
        // With the stream obtained, add the message to the stream so we can
5379
        // continue processing message.
5380
        chanStream.AddMsg(msg)
3✔
5381
}
5382

5383
// scaleTimeout multiplies the argument duration by a constant factor depending
5384
// on variious heuristics. Currently this is only used to check whether our peer
5385
// appears to be connected over Tor and relaxes the timout deadline. However,
5386
// this is subject to change and should be treated as opaque.
5387
func (p *Brontide) scaleTimeout(timeout time.Duration) time.Duration {
3✔
5388
        if p.isTorConnection {
6✔
5389
                return timeout * time.Duration(torTimeoutMultiplier)
3✔
5390
        }
3✔
5391

UNCOV
5392
        return timeout
×
5393
}
5394

5395
// CoopCloseUpdates is a struct used to communicate updates for an active close
5396
// to the caller.
5397
type CoopCloseUpdates struct {
5398
        UpdateChan chan interface{}
5399

5400
        ErrChan chan error
5401
}
5402

5403
// ChanHasRbfCoopCloser returns true if the channel as identifier by the channel
5404
// point has an active RBF chan closer.
5405
func (p *Brontide) ChanHasRbfCoopCloser(chanPoint wire.OutPoint) bool {
3✔
5406
        chanID := lnwire.NewChanIDFromOutPoint(chanPoint)
3✔
5407
        chanCloser, found := p.activeChanCloses.Load(chanID)
3✔
5408
        if !found {
6✔
5409
                return false
3✔
5410
        }
3✔
5411

5412
        return chanCloser.IsRight()
3✔
5413
}
5414

5415
// TriggerCoopCloseRbfBump given a chan ID, and the params needed to trigger a
5416
// new RBF co-op close update, a bump is attempted. A channel used for updates,
5417
// along with one used to o=communicate any errors is returned. If no chan
5418
// closer is found, then false is returned for the second argument.
5419
func (p *Brontide) TriggerCoopCloseRbfBump(ctx context.Context,
5420
        chanPoint wire.OutPoint, feeRate chainfee.SatPerKWeight,
5421
        deliveryScript lnwire.DeliveryAddress) (*CoopCloseUpdates, error) {
3✔
5422

3✔
5423
        // If RBF coop close isn't permitted, then we'll an error.
3✔
5424
        if !p.rbfCoopCloseAllowed() {
3✔
5425
                return nil, fmt.Errorf("rbf coop close not enabled for " +
×
5426
                        "channel")
×
5427
        }
×
5428

5429
        closeUpdates := &CoopCloseUpdates{
3✔
5430
                UpdateChan: make(chan interface{}, 1),
3✔
5431
                ErrChan:    make(chan error, 1),
3✔
5432
        }
3✔
5433

3✔
5434
        // We'll re-use the existing switch struct here, even though we're
3✔
5435
        // bypassing the switch entirely.
3✔
5436
        closeReq := htlcswitch.ChanClose{
3✔
5437
                CloseType:      contractcourt.CloseRegular,
3✔
5438
                ChanPoint:      &chanPoint,
3✔
5439
                TargetFeePerKw: feeRate,
3✔
5440
                DeliveryScript: deliveryScript,
3✔
5441
                Updates:        closeUpdates.UpdateChan,
3✔
5442
                Err:            closeUpdates.ErrChan,
3✔
5443
                Ctx:            ctx,
3✔
5444
        }
3✔
5445

3✔
5446
        err := p.startRbfChanCloser(newRPCShutdownInit(&closeReq), chanPoint)
3✔
5447
        if err != nil {
3✔
5448
                return nil, err
×
5449
        }
×
5450

5451
        return closeUpdates, nil
3✔
5452
}
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