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

lightningnetwork / lnd / 13984882175

21 Mar 2025 04:51AM UTC coverage: 59.143% (+0.02%) from 59.126%
13984882175

Pull #9626

github

web-flow
Merge a5a3772c3 into 5d921723b
Pull Request #9626: payment lifecycle small fix

21 of 30 new or added lines in 1 file covered. (70.0%)

54 existing lines in 9 files now uncovered.

96764 of 163609 relevant lines covered (59.14%)

1.84 hits per line

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

77.02
/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 = 5
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
        // MaxFeeExposure limits the number of outstanding fees in a channel.
442
        // This value will be passed to created links.
443
        MaxFeeExposure lnwire.MilliSatoshi
444

445
        // MsgRouter is an optional instance of the main message router that
446
        // the peer will use. If None, then a new default version will be used
447
        // in place.
448
        MsgRouter fn.Option[msgmux.Router]
449

450
        // AuxChanCloser is an optional instance of an abstraction that can be
451
        // used to modify the way the co-op close transaction is constructed.
452
        AuxChanCloser fn.Option[chancloser.AuxChanCloser]
453

454
        // ShouldFwdExpEndorsement is a closure that indicates whether
455
        // experimental endorsement signals should be set.
456
        ShouldFwdExpEndorsement func() bool
457

458
        // Quit is the server's quit channel. If this is closed, we halt operation.
459
        Quit chan struct{}
460
}
461

462
// chanCloserFsm is a union-like type that can hold the two versions of co-op
463
// close we support: negotiation, and RBF based.
464
//
465
// TODO(roasbeef): rename to chancloser.Negotiator and chancloser.RBF?
466
type chanCloserFsm = fn.Either[*chancloser.ChanCloser, *chancloser.RbfChanCloser] //nolint:ll
467

468
// makeNegotiateCloser creates a new negotiate closer from a
469
// chancloser.ChanCloser.
470
func makeNegotiateCloser(chanCloser *chancloser.ChanCloser) chanCloserFsm {
3✔
471
        return fn.NewLeft[*chancloser.ChanCloser, *chancloser.RbfChanCloser](
3✔
472
                chanCloser,
3✔
473
        )
3✔
474
}
3✔
475

476
// makeRbfCloser creates a new RBF closer from a chancloser.RbfChanCloser.
477
func makeRbfCloser(rbfCloser *chancloser.RbfChanCloser) chanCloserFsm {
3✔
478
        return fn.NewRight[*chancloser.ChanCloser](
3✔
479
                rbfCloser,
3✔
480
        )
3✔
481
}
3✔
482

483
// Brontide is an active peer on the Lightning Network. This struct is responsible
484
// for managing any channel state related to this peer. To do so, it has
485
// several helper goroutines to handle events such as HTLC timeouts, new
486
// funding workflow, and detecting an uncooperative closure of any active
487
// channels.
488
type Brontide struct {
489
        // MUST be used atomically.
490
        started    int32
491
        disconnect int32
492

493
        // MUST be used atomically.
494
        bytesReceived uint64
495
        bytesSent     uint64
496

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

514
        pingManager *PingManager
515

516
        // lastPingPayload stores an unsafe pointer wrapped as an atomic
517
        // variable which points to the last payload the remote party sent us
518
        // as their ping.
519
        //
520
        // MUST be used atomically.
521
        lastPingPayload atomic.Value
522

523
        cfg Config
524

525
        // activeSignal when closed signals that the peer is now active and
526
        // ready to process messages.
527
        activeSignal chan struct{}
528

529
        // startTime is the time this peer connection was successfully established.
530
        // It will be zero for peers that did not successfully call Start().
531
        startTime time.Time
532

533
        // sendQueue is the channel which is used to queue outgoing messages to be
534
        // written onto the wire. Note that this channel is unbuffered.
535
        sendQueue chan outgoingMsg
536

537
        // outgoingQueue is a buffered channel which allows second/third party
538
        // objects to queue messages to be sent out on the wire.
539
        outgoingQueue chan outgoingMsg
540

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

554
        // addedChannels tracks any new channels opened during this peer's
555
        // lifecycle. We use this to filter out these new channels when the time
556
        // comes to request a reenable for active channels, since they will have
557
        // waited a shorter duration.
558
        addedChannels *lnutils.SyncMap[lnwire.ChannelID, struct{}]
559

560
        // newActiveChannel is used by the fundingManager to send fully opened
561
        // channels to the source peer which handled the funding workflow.
562
        newActiveChannel chan *newChannelMsg
563

564
        // newPendingChannel is used by the fundingManager to send pending open
565
        // channels to the source peer which handled the funding workflow.
566
        newPendingChannel chan *newChannelMsg
567

568
        // removePendingChannel is used by the fundingManager to cancel pending
569
        // open channels to the source peer when the funding flow is failed.
570
        removePendingChannel chan *newChannelMsg
571

572
        // activeMsgStreams is a map from channel id to the channel streams that
573
        // proxy messages to individual, active links.
574
        activeMsgStreams map[lnwire.ChannelID]*msgStream
575

576
        // activeChanCloses is a map that keeps track of all the active
577
        // cooperative channel closures. Any channel closing messages are directed
578
        // to one of these active state machines. Once the channel has been closed,
579
        // the state machine will be deleted from the map.
580
        activeChanCloses *lnutils.SyncMap[lnwire.ChannelID, chanCloserFsm]
581

582
        // localCloseChanReqs is a channel in which any local requests to close
583
        // a particular channel are sent over.
584
        localCloseChanReqs chan *htlcswitch.ChanClose
585

586
        // linkFailures receives all reported channel failures from the switch,
587
        // and instructs the channelManager to clean remaining channel state.
588
        linkFailures chan linkFailureReport
589

590
        // chanCloseMsgs is a channel that any message related to channel
591
        // closures are sent over. This includes lnwire.Shutdown message as
592
        // well as lnwire.ClosingSigned messages.
593
        chanCloseMsgs chan *closeMsg
594

595
        // remoteFeatures is the feature vector received from the peer during
596
        // the connection handshake.
597
        remoteFeatures *lnwire.FeatureVector
598

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

605
        // channelEventClient is the channel event subscription client that's
606
        // used to assist retry enabling the channels. This client is only
607
        // created when the reenableTimeout is no greater than 1 minute. Once
608
        // created, it is canceled once the reenabling has been finished.
609
        //
610
        // NOTE: we choose to create the client conditionally to avoid
611
        // potentially holding lots of un-consumed events.
612
        channelEventClient *subscribe.Client
613

614
        // msgRouter is an instance of the msgmux.Router which is used to send
615
        // off new wire messages for handing.
616
        msgRouter fn.Option[msgmux.Router]
617

618
        // globalMsgRouter is a flag that indicates whether we have a global
619
        // msg router. If so, then we don't worry about stopping the msg router
620
        // when a peer disconnects.
621
        globalMsgRouter bool
622

623
        startReady chan struct{}
624

625
        // cg is a helper that encapsulates a wait group and quit channel and
626
        // allows contexts that either block or cancel on those depending on
627
        // the use case.
628
        cg *fn.ContextGuard
629

630
        // log is a peer-specific logging instance.
631
        log btclog.Logger
632
}
633

634
// A compile-time check to ensure that Brontide satisfies the lnpeer.Peer
635
// interface.
636
var _ lnpeer.Peer = (*Brontide)(nil)
637

638
// NewBrontide creates a new Brontide from a peer.Config struct.
639
func NewBrontide(cfg Config) *Brontide {
3✔
640
        logPrefix := fmt.Sprintf("Peer(%x):", cfg.PubKeyBytes)
3✔
641

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

3✔
647
        // We'll either use the msg router instance passed in, or create a new
3✔
648
        // blank instance.
3✔
649
        msgRouter := cfg.MsgRouter.Alt(fn.Some[msgmux.Router](
3✔
650
                msgmux.NewMultiMsgRouter(),
3✔
651
        ))
3✔
652

3✔
653
        p := &Brontide{
3✔
654
                cfg:           cfg,
3✔
655
                activeSignal:  make(chan struct{}),
3✔
656
                sendQueue:     make(chan outgoingMsg),
3✔
657
                outgoingQueue: make(chan outgoingMsg),
3✔
658
                addedChannels: &lnutils.SyncMap[lnwire.ChannelID, struct{}]{},
3✔
659
                activeChannels: &lnutils.SyncMap[
3✔
660
                        lnwire.ChannelID, *lnwallet.LightningChannel,
3✔
661
                ]{},
3✔
662
                newActiveChannel:     make(chan *newChannelMsg, 1),
3✔
663
                newPendingChannel:    make(chan *newChannelMsg, 1),
3✔
664
                removePendingChannel: make(chan *newChannelMsg),
3✔
665

3✔
666
                activeMsgStreams: make(map[lnwire.ChannelID]*msgStream),
3✔
667
                activeChanCloses: &lnutils.SyncMap[
3✔
668
                        lnwire.ChannelID, chanCloserFsm,
3✔
669
                ]{},
3✔
670
                localCloseChanReqs: make(chan *htlcswitch.ChanClose),
3✔
671
                linkFailures:       make(chan linkFailureReport),
3✔
672
                chanCloseMsgs:      make(chan *closeMsg),
3✔
673
                resentChanSyncMsg:  make(map[lnwire.ChannelID]struct{}),
3✔
674
                startReady:         make(chan struct{}),
3✔
675
                log:                peerLog.WithPrefix(logPrefix),
3✔
676
                msgRouter:          msgRouter,
3✔
677
                globalMsgRouter:    globalMsgRouter,
3✔
678
                cg:                 fn.NewContextGuard(),
3✔
679
        }
3✔
680

3✔
681
        if cfg.Conn != nil && cfg.Conn.RemoteAddr() != nil {
6✔
682
                remoteAddr := cfg.Conn.RemoteAddr().String()
3✔
683
                p.isTorConnection = strings.Contains(remoteAddr, ".onion") ||
3✔
684
                        strings.Contains(remoteAddr, "127.0.0.1")
3✔
685
        }
3✔
686

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

703
                buf := bytes.NewBuffer(lastSerializedBlockHeader[0:0])
×
704
                err = header.Serialize(buf)
×
705
                if err == nil {
×
706
                        lastBlockHeader = header
×
707
                } else {
×
708
                        p.log.Warn("unable to serialize current block" +
×
709
                                "header for ping payload generation." +
×
710
                                "This should be impossible and means" +
×
711
                                "there is an implementation bug.")
×
712
                }
×
713

714
                return lastSerializedBlockHeader[:]
×
715
        }
716

717
        // TODO(roasbeef): make dynamic in order to create fake cover traffic.
718
        //
719
        // NOTE(proofofkeags): this was changed to be dynamic to allow better
720
        // pong identification, however, more thought is needed to make this
721
        // actually usable as a traffic decoy.
722
        randPongSize := func() uint16 {
3✔
723
                return uint16(
×
724
                        // We don't need cryptographic randomness here.
×
725
                        /* #nosec */
×
726
                        rand.Intn(pongSizeCeiling) + 1,
×
727
                )
×
728
        }
×
729

730
        p.pingManager = NewPingManager(&PingManagerConfig{
3✔
731
                NewPingPayload:   newPingPayload,
3✔
732
                NewPongSize:      randPongSize,
3✔
733
                IntervalDuration: p.scaleTimeout(pingInterval),
3✔
734
                TimeoutDuration:  p.scaleTimeout(pingTimeout),
3✔
735
                SendPing: func(ping *lnwire.Ping) {
3✔
736
                        p.queueMsg(ping, nil)
×
737
                },
×
738
                OnPongFailure: func(err error) {
×
739
                        eStr := "pong response failure for %s: %v " +
×
740
                                "-- disconnecting"
×
741
                        p.log.Warnf(eStr, p, err)
×
742
                        go p.Disconnect(fmt.Errorf(eStr, p, err))
×
743
                },
×
744
        })
745

746
        return p
3✔
747
}
748

749
// Start starts all helper goroutines the peer needs for normal operations.  In
750
// the case this peer has already been started, then this function is a noop.
751
func (p *Brontide) Start() error {
3✔
752
        if atomic.AddInt32(&p.started, 1) != 1 {
3✔
753
                return nil
×
754
        }
×
755

756
        // Once we've finished starting up the peer, we'll signal to other
757
        // goroutines that the they can move forward to tear down the peer, or
758
        // carry out other relevant changes.
759
        defer close(p.startReady)
3✔
760

3✔
761
        p.log.Tracef("starting with conn[%v->%v]",
3✔
762
                p.cfg.Conn.LocalAddr(), p.cfg.Conn.RemoteAddr())
3✔
763

3✔
764
        // Fetch and then load all the active channels we have with this remote
3✔
765
        // peer from the database.
3✔
766
        activeChans, err := p.cfg.ChannelDB.FetchOpenChannels(
3✔
767
                p.cfg.Addr.IdentityKey,
3✔
768
        )
3✔
769
        if err != nil {
3✔
770
                p.log.Errorf("Unable to fetch active chans "+
×
771
                        "for peer: %v", err)
×
772
                return err
×
773
        }
×
774

775
        if len(activeChans) == 0 {
6✔
776
                go p.cfg.PrunePersistentPeerConnection(p.cfg.PubKeyBytes)
3✔
777
        }
3✔
778

779
        // Quickly check if we have any existing legacy channels with this
780
        // peer.
781
        haveLegacyChan := false
3✔
782
        for _, c := range activeChans {
6✔
783
                if c.ChanType.IsTweakless() {
6✔
784
                        continue
3✔
785
                }
786

787
                haveLegacyChan = true
3✔
788
                break
3✔
789
        }
790

791
        // Exchange local and global features, the init message should be very
792
        // first between two nodes.
793
        if err := p.sendInitMsg(haveLegacyChan); err != nil {
6✔
794
                return fmt.Errorf("unable to send init msg: %w", err)
3✔
795
        }
3✔
796

797
        // Before we launch any of the helper goroutines off the peer struct,
798
        // we'll first ensure proper adherence to the p2p protocol. The init
799
        // message MUST be sent before any other message.
800
        readErr := make(chan error, 1)
3✔
801
        msgChan := make(chan lnwire.Message, 1)
3✔
802
        p.cg.WgAdd(1)
3✔
803
        go func() {
6✔
804
                defer p.cg.WgDone()
3✔
805

3✔
806
                msg, err := p.readNextMessage()
3✔
807
                if err != nil {
3✔
UNCOV
808
                        readErr <- err
×
UNCOV
809
                        msgChan <- nil
×
UNCOV
810
                        return
×
UNCOV
811
                }
×
812
                readErr <- nil
3✔
813
                msgChan <- msg
3✔
814
        }()
815

816
        select {
3✔
817
        // In order to avoid blocking indefinitely, we'll give the other peer
818
        // an upper timeout to respond before we bail out early.
819
        case <-time.After(handshakeTimeout):
×
820
                return fmt.Errorf("peer did not complete handshake within %v",
×
821
                        handshakeTimeout)
×
822
        case err := <-readErr:
3✔
823
                if err != nil {
3✔
UNCOV
824
                        return fmt.Errorf("unable to read init msg: %w", err)
×
UNCOV
825
                }
×
826
        }
827

828
        // Once the init message arrives, we can parse it so we can figure out
829
        // the negotiation of features for this session.
830
        msg := <-msgChan
3✔
831
        if msg, ok := msg.(*lnwire.Init); ok {
6✔
832
                if err := p.handleInitMsg(msg); err != nil {
3✔
833
                        p.storeError(err)
×
834
                        return err
×
835
                }
×
836
        } else {
×
837
                return errors.New("very first message between nodes " +
×
838
                        "must be init message")
×
839
        }
×
840

841
        // Next, load all the active channels we have with this peer,
842
        // registering them with the switch and launching the necessary
843
        // goroutines required to operate them.
844
        p.log.Debugf("Loaded %v active channels from database",
3✔
845
                len(activeChans))
3✔
846

3✔
847
        // Conditionally subscribe to channel events before loading channels so
3✔
848
        // we won't miss events. This subscription is used to listen to active
3✔
849
        // channel event when reenabling channels. Once the reenabling process
3✔
850
        // is finished, this subscription will be canceled.
3✔
851
        //
3✔
852
        // NOTE: ChannelNotifier must be started before subscribing events
3✔
853
        // otherwise we'd panic here.
3✔
854
        if err := p.attachChannelEventSubscription(); err != nil {
3✔
855
                return err
×
856
        }
×
857

858
        // Register the message router now as we may need to register some
859
        // endpoints while loading the channels below.
860
        p.msgRouter.WhenSome(func(router msgmux.Router) {
6✔
861
                router.Start(context.Background())
3✔
862
        })
3✔
863

864
        msgs, err := p.loadActiveChannels(activeChans)
3✔
865
        if err != nil {
3✔
866
                return fmt.Errorf("unable to load channels: %w", err)
×
867
        }
×
868

869
        p.startTime = time.Now()
3✔
870

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

3✔
878
                // Send the messages directly via writeMessage and bypass the
3✔
879
                // writeHandler goroutine.
3✔
880
                for _, msg := range msgs {
6✔
881
                        if err := p.writeMessage(msg); err != nil {
3✔
882
                                return fmt.Errorf("unable to send "+
×
883
                                        "reestablish msg: %v", err)
×
884
                        }
×
885
                }
886
        }
887

888
        err = p.pingManager.Start()
3✔
889
        if err != nil {
3✔
890
                return fmt.Errorf("could not start ping manager %w", err)
×
891
        }
×
892

893
        p.cg.WgAdd(4)
3✔
894
        go p.queueHandler()
3✔
895
        go p.writeHandler()
3✔
896
        go p.channelManager()
3✔
897
        go p.readHandler()
3✔
898

3✔
899
        // Signal to any external processes that the peer is now active.
3✔
900
        close(p.activeSignal)
3✔
901

3✔
902
        // Node announcements don't propagate very well throughout the network
3✔
903
        // as there isn't a way to efficiently query for them through their
3✔
904
        // timestamp, mostly affecting nodes that were offline during the time
3✔
905
        // of broadcast. We'll resend our node announcement to the remote peer
3✔
906
        // as a best-effort delivery such that it can also propagate to their
3✔
907
        // peers. To ensure they can successfully process it in most cases,
3✔
908
        // we'll only resend it as long as we have at least one confirmed
3✔
909
        // advertised channel with the remote peer.
3✔
910
        //
3✔
911
        // TODO(wilmer): Remove this once we're able to query for node
3✔
912
        // announcements through their timestamps.
3✔
913
        p.cg.WgAdd(2)
3✔
914
        go p.maybeSendNodeAnn(activeChans)
3✔
915
        go p.maybeSendChannelUpdates()
3✔
916

3✔
917
        return nil
3✔
918
}
919

920
// initGossipSync initializes either a gossip syncer or an initial routing
921
// dump, depending on the negotiated synchronization method.
922
func (p *Brontide) initGossipSync() {
3✔
923
        // If the remote peer knows of the new gossip queries feature, then
3✔
924
        // we'll create a new gossipSyncer in the AuthenticatedGossiper for it.
3✔
925
        if p.remoteFeatures.HasFeature(lnwire.GossipQueriesOptional) {
6✔
926
                p.log.Info("Negotiated chan series queries")
3✔
927

3✔
928
                if p.cfg.AuthGossiper == nil {
3✔
929
                        // This should only ever be hit in the unit tests.
×
930
                        p.log.Warn("No AuthGossiper configured. Abandoning " +
×
931
                                "gossip sync.")
×
932
                        return
×
933
                }
×
934

935
                // Register the peer's gossip syncer with the gossiper.
936
                // This blocks synchronously to ensure the gossip syncer is
937
                // registered with the gossiper before attempting to read
938
                // messages from the remote peer.
939
                //
940
                // TODO(wilmer): Only sync updates from non-channel peers. This
941
                // requires an improved version of the current network
942
                // bootstrapper to ensure we can find and connect to non-channel
943
                // peers.
944
                p.cfg.AuthGossiper.InitSyncState(p)
3✔
945
        }
946
}
947

948
// taprootShutdownAllowed returns true if both parties have negotiated the
949
// shutdown-any-segwit feature.
950
func (p *Brontide) taprootShutdownAllowed() bool {
3✔
951
        return p.RemoteFeatures().HasFeature(lnwire.ShutdownAnySegwitOptional) &&
3✔
952
                p.LocalFeatures().HasFeature(lnwire.ShutdownAnySegwitOptional)
3✔
953
}
3✔
954

955
// rbfCoopCloseAllowed returns true if both parties have negotiated the new RBF
956
// coop close feature.
957
func (p *Brontide) rbfCoopCloseAllowed() bool {
3✔
958
        return p.RemoteFeatures().HasFeature(
3✔
959
                lnwire.RbfCoopCloseOptionalStaging,
3✔
960
        ) && p.LocalFeatures().HasFeature(
3✔
961
                lnwire.RbfCoopCloseOptionalStaging,
3✔
962
        )
3✔
963
}
3✔
964

965
// QuitSignal is a method that should return a channel which will be sent upon
966
// or closed once the backing peer exits. This allows callers using the
967
// interface to cancel any processing in the event the backing implementation
968
// exits.
969
//
970
// NOTE: Part of the lnpeer.Peer interface.
971
func (p *Brontide) QuitSignal() <-chan struct{} {
3✔
972
        return p.cg.Done()
3✔
973
}
3✔
974

975
// addrWithInternalKey takes a delivery script, then attempts to supplement it
976
// with information related to the internal key for the addr, but only if it's
977
// a taproot addr.
978
func (p *Brontide) addrWithInternalKey(
979
        deliveryScript []byte) (*chancloser.DeliveryAddrWithKey, error) {
3✔
980

3✔
981
        // Currently, custom channels cannot be created with external upfront
3✔
982
        // shutdown addresses, so this shouldn't be an issue. We only require
3✔
983
        // the internal key for taproot addresses to be able to provide a non
3✔
984
        // inclusion proof of any scripts.
3✔
985
        internalKeyDesc, err := lnwallet.InternalKeyForAddr(
3✔
986
                p.cfg.Wallet, &p.cfg.Wallet.Cfg.NetParams, deliveryScript,
3✔
987
        )
3✔
988
        if err != nil {
3✔
989
                return nil, fmt.Errorf("unable to fetch internal key: %w", err)
×
990
        }
×
991

992
        return &chancloser.DeliveryAddrWithKey{
3✔
993
                DeliveryAddress: deliveryScript,
3✔
994
                InternalKey: fn.MapOption(
3✔
995
                        func(desc keychain.KeyDescriptor) btcec.PublicKey {
6✔
996
                                return *desc.PubKey
3✔
997
                        },
3✔
998
                )(internalKeyDesc),
999
        }, nil
1000
}
1001

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

3✔
1009
        // Return a slice of messages to send to the peers in case the channel
3✔
1010
        // cannot be loaded normally.
3✔
1011
        var msgs []lnwire.Message
3✔
1012

3✔
1013
        scidAliasNegotiated := p.hasNegotiatedScidAlias()
3✔
1014

3✔
1015
        for _, dbChan := range chans {
6✔
1016
                hasScidFeature := dbChan.ChanType.HasScidAliasFeature()
3✔
1017
                if scidAliasNegotiated && !hasScidFeature {
6✔
1018
                        // We'll request and store an alias, making sure that a
3✔
1019
                        // gossiper mapping is not created for the alias to the
3✔
1020
                        // real SCID. This is done because the peer and funding
3✔
1021
                        // manager are not aware of each other's states and if
3✔
1022
                        // we did not do this, we would accept alias channel
3✔
1023
                        // updates after 6 confirmations, which would be buggy.
3✔
1024
                        // We'll queue a channel_ready message with the new
3✔
1025
                        // alias. This should technically be done *after* the
3✔
1026
                        // reestablish, but this behavior is pre-existing since
3✔
1027
                        // the funding manager may already queue a
3✔
1028
                        // channel_ready before the channel_reestablish.
3✔
1029
                        if !dbChan.IsPending {
6✔
1030
                                aliasScid, err := p.cfg.RequestAlias()
3✔
1031
                                if err != nil {
3✔
1032
                                        return nil, err
×
1033
                                }
×
1034

1035
                                err = p.cfg.AddLocalAlias(
3✔
1036
                                        aliasScid, dbChan.ShortChanID(), false,
3✔
1037
                                        false,
3✔
1038
                                )
3✔
1039
                                if err != nil {
3✔
1040
                                        return nil, err
×
1041
                                }
×
1042

1043
                                chanID := lnwire.NewChanIDFromOutPoint(
3✔
1044
                                        dbChan.FundingOutpoint,
3✔
1045
                                )
3✔
1046

3✔
1047
                                // Fetch the second commitment point to send in
3✔
1048
                                // the channel_ready message.
3✔
1049
                                second, err := dbChan.SecondCommitmentPoint()
3✔
1050
                                if err != nil {
3✔
1051
                                        return nil, err
×
1052
                                }
×
1053

1054
                                channelReadyMsg := lnwire.NewChannelReady(
3✔
1055
                                        chanID, second,
3✔
1056
                                )
3✔
1057
                                channelReadyMsg.AliasScid = &aliasScid
3✔
1058

3✔
1059
                                msgs = append(msgs, channelReadyMsg)
3✔
1060
                        }
1061

1062
                        // If we've negotiated the option-scid-alias feature
1063
                        // and this channel does not have ScidAliasFeature set
1064
                        // to true due to an upgrade where the feature bit was
1065
                        // turned on, we'll update the channel's database
1066
                        // state.
1067
                        err := dbChan.MarkScidAliasNegotiated()
3✔
1068
                        if err != nil {
3✔
1069
                                return nil, err
×
1070
                        }
×
1071
                }
1072

1073
                var chanOpts []lnwallet.ChannelOpt
3✔
1074
                p.cfg.AuxLeafStore.WhenSome(func(s lnwallet.AuxLeafStore) {
3✔
1075
                        chanOpts = append(chanOpts, lnwallet.WithLeafStore(s))
×
1076
                })
×
1077
                p.cfg.AuxSigner.WhenSome(func(s lnwallet.AuxSigner) {
3✔
1078
                        chanOpts = append(chanOpts, lnwallet.WithAuxSigner(s))
×
1079
                })
×
1080
                p.cfg.AuxResolver.WhenSome(
3✔
1081
                        func(s lnwallet.AuxContractResolver) {
3✔
1082
                                chanOpts = append(
×
1083
                                        chanOpts, lnwallet.WithAuxResolver(s),
×
1084
                                )
×
1085
                        },
×
1086
                )
1087

1088
                lnChan, err := lnwallet.NewLightningChannel(
3✔
1089
                        p.cfg.Signer, dbChan, p.cfg.SigPool, chanOpts...,
3✔
1090
                )
3✔
1091
                if err != nil {
3✔
1092
                        return nil, fmt.Errorf("unable to create channel "+
×
1093
                                "state machine: %w", err)
×
1094
                }
×
1095

1096
                chanPoint := dbChan.FundingOutpoint
3✔
1097

3✔
1098
                chanID := lnwire.NewChanIDFromOutPoint(chanPoint)
3✔
1099

3✔
1100
                p.log.Infof("Loading ChannelPoint(%v), isPending=%v",
3✔
1101
                        chanPoint, lnChan.IsPending())
3✔
1102

3✔
1103
                // Skip adding any permanently irreconcilable channels to the
3✔
1104
                // htlcswitch.
3✔
1105
                if !dbChan.HasChanStatus(channeldb.ChanStatusDefault) &&
3✔
1106
                        !dbChan.HasChanStatus(channeldb.ChanStatusRestored) {
6✔
1107

3✔
1108
                        p.log.Warnf("ChannelPoint(%v) has status %v, won't "+
3✔
1109
                                "start.", chanPoint, dbChan.ChanStatus())
3✔
1110

3✔
1111
                        // To help our peer recover from a potential data loss,
3✔
1112
                        // we resend our channel reestablish message if the
3✔
1113
                        // channel is in a borked state. We won't process any
3✔
1114
                        // channel reestablish message sent from the peer, but
3✔
1115
                        // that's okay since the assumption is that we did when
3✔
1116
                        // marking the channel borked.
3✔
1117
                        chanSync, err := dbChan.ChanSyncMsg()
3✔
1118
                        if err != nil {
3✔
1119
                                p.log.Errorf("Unable to create channel "+
×
1120
                                        "reestablish message for channel %v: "+
×
1121
                                        "%v", chanPoint, err)
×
1122
                                continue
×
1123
                        }
1124

1125
                        msgs = append(msgs, chanSync)
3✔
1126

3✔
1127
                        // Check if this channel needs to have the cooperative
3✔
1128
                        // close process restarted. If so, we'll need to send
3✔
1129
                        // the Shutdown message that is returned.
3✔
1130
                        if dbChan.HasChanStatus(
3✔
1131
                                channeldb.ChanStatusCoopBroadcasted,
3✔
1132
                        ) {
6✔
1133

3✔
1134
                                shutdownMsg, err := p.restartCoopClose(lnChan)
3✔
1135
                                if err != nil {
3✔
1136
                                        p.log.Errorf("Unable to restart "+
×
1137
                                                "coop close for channel: %v",
×
1138
                                                err)
×
1139
                                        continue
×
1140
                                }
1141

1142
                                if shutdownMsg == nil {
6✔
1143
                                        continue
3✔
1144
                                }
1145

1146
                                // Append the message to the set of messages to
1147
                                // send.
1148
                                msgs = append(msgs, shutdownMsg)
×
1149
                        }
1150

1151
                        continue
3✔
1152
                }
1153

1154
                // Before we register this new link with the HTLC Switch, we'll
1155
                // need to fetch its current link-layer forwarding policy from
1156
                // the database.
1157
                graph := p.cfg.ChannelGraph
3✔
1158
                info, p1, p2, err := graph.FetchChannelEdgesByOutpoint(
3✔
1159
                        &chanPoint,
3✔
1160
                )
3✔
1161
                if err != nil && !errors.Is(err, graphdb.ErrEdgeNotFound) {
3✔
1162
                        return nil, err
×
1163
                }
×
1164

1165
                // We'll filter out our policy from the directional channel
1166
                // edges based whom the edge connects to. If it doesn't connect
1167
                // to us, then we know that we were the one that advertised the
1168
                // policy.
1169
                //
1170
                // TODO(roasbeef): can add helper method to get policy for
1171
                // particular channel.
1172
                var selfPolicy *models.ChannelEdgePolicy
3✔
1173
                if info != nil && bytes.Equal(info.NodeKey1Bytes[:],
3✔
1174
                        p.cfg.ServerPubKey[:]) {
6✔
1175

3✔
1176
                        selfPolicy = p1
3✔
1177
                } else {
6✔
1178
                        selfPolicy = p2
3✔
1179
                }
3✔
1180

1181
                // If we don't yet have an advertised routing policy, then
1182
                // we'll use the current default, otherwise we'll translate the
1183
                // routing policy into a forwarding policy.
1184
                var forwardingPolicy *models.ForwardingPolicy
3✔
1185
                if selfPolicy != nil {
6✔
1186
                        var inboundWireFee lnwire.Fee
3✔
1187
                        _, err := selfPolicy.ExtraOpaqueData.ExtractRecords(
3✔
1188
                                &inboundWireFee,
3✔
1189
                        )
3✔
1190
                        if err != nil {
3✔
1191
                                return nil, err
×
1192
                        }
×
1193

1194
                        inboundFee := models.NewInboundFeeFromWire(
3✔
1195
                                inboundWireFee,
3✔
1196
                        )
3✔
1197

3✔
1198
                        forwardingPolicy = &models.ForwardingPolicy{
3✔
1199
                                MinHTLCOut:    selfPolicy.MinHTLC,
3✔
1200
                                MaxHTLC:       selfPolicy.MaxHTLC,
3✔
1201
                                BaseFee:       selfPolicy.FeeBaseMSat,
3✔
1202
                                FeeRate:       selfPolicy.FeeProportionalMillionths,
3✔
1203
                                TimeLockDelta: uint32(selfPolicy.TimeLockDelta),
3✔
1204

3✔
1205
                                InboundFee: inboundFee,
3✔
1206
                        }
3✔
1207
                } else {
3✔
1208
                        p.log.Warnf("Unable to find our forwarding policy "+
3✔
1209
                                "for channel %v, using default values",
3✔
1210
                                chanPoint)
3✔
1211
                        forwardingPolicy = &p.cfg.RoutingPolicy
3✔
1212
                }
3✔
1213

1214
                p.log.Tracef("Using link policy of: %v",
3✔
1215
                        spew.Sdump(forwardingPolicy))
3✔
1216

3✔
1217
                // If the channel is pending, set the value to nil in the
3✔
1218
                // activeChannels map. This is done to signify that the channel
3✔
1219
                // is pending. We don't add the link to the switch here - it's
3✔
1220
                // the funding manager's responsibility to spin up pending
3✔
1221
                // channels. Adding them here would just be extra work as we'll
3✔
1222
                // tear them down when creating + adding the final link.
3✔
1223
                if lnChan.IsPending() {
6✔
1224
                        p.activeChannels.Store(chanID, nil)
3✔
1225

3✔
1226
                        continue
3✔
1227
                }
1228

1229
                shutdownInfo, err := lnChan.State().ShutdownInfo()
3✔
1230
                if err != nil && !errors.Is(err, channeldb.ErrNoShutdownInfo) {
3✔
1231
                        return nil, err
×
1232
                }
×
1233

1234
                var (
3✔
1235
                        shutdownMsg     fn.Option[lnwire.Shutdown]
3✔
1236
                        shutdownInfoErr error
3✔
1237
                )
3✔
1238
                shutdownInfo.WhenSome(func(info channeldb.ShutdownInfo) {
6✔
1239
                        // If we can use the new RBF close feature, we don't
3✔
1240
                        // need to create the legacy closer.
3✔
1241
                        if p.rbfCoopCloseAllowed() {
6✔
1242
                                return
3✔
1243
                        }
3✔
1244

1245
                        // Compute an ideal fee.
1246
                        feePerKw, err := p.cfg.FeeEstimator.EstimateFeePerKW(
3✔
1247
                                p.cfg.CoopCloseTargetConfs,
3✔
1248
                        )
3✔
1249
                        if err != nil {
3✔
1250
                                shutdownInfoErr = fmt.Errorf("unable to "+
×
1251
                                        "estimate fee: %w", err)
×
1252

×
1253
                                return
×
1254
                        }
×
1255

1256
                        addr, err := p.addrWithInternalKey(
3✔
1257
                                info.DeliveryScript.Val,
3✔
1258
                        )
3✔
1259
                        if err != nil {
3✔
1260
                                shutdownInfoErr = fmt.Errorf("unable to make "+
×
1261
                                        "delivery addr: %w", err)
×
1262
                                return
×
1263
                        }
×
1264
                        negotiateChanCloser, err := p.createChanCloser(
3✔
1265
                                lnChan, addr, feePerKw, nil,
3✔
1266
                                info.Closer(),
3✔
1267
                        )
3✔
1268
                        if err != nil {
3✔
1269
                                shutdownInfoErr = fmt.Errorf("unable to "+
×
1270
                                        "create chan closer: %w", err)
×
1271

×
1272
                                return
×
1273
                        }
×
1274

1275
                        chanID := lnwire.NewChanIDFromOutPoint(
3✔
1276
                                lnChan.State().FundingOutpoint,
3✔
1277
                        )
3✔
1278

3✔
1279
                        p.activeChanCloses.Store(chanID, makeNegotiateCloser(
3✔
1280
                                negotiateChanCloser,
3✔
1281
                        ))
3✔
1282

3✔
1283
                        // Create the Shutdown message.
3✔
1284
                        shutdown, err := negotiateChanCloser.ShutdownChan()
3✔
1285
                        if err != nil {
3✔
1286
                                p.activeChanCloses.Delete(chanID)
×
1287
                                shutdownInfoErr = err
×
1288

×
1289
                                return
×
1290
                        }
×
1291

1292
                        shutdownMsg = fn.Some(*shutdown)
3✔
1293
                })
1294
                if shutdownInfoErr != nil {
3✔
1295
                        return nil, shutdownInfoErr
×
1296
                }
×
1297

1298
                // Subscribe to the set of on-chain events for this channel.
1299
                chainEvents, err := p.cfg.ChainArb.SubscribeChannelEvents(
3✔
1300
                        chanPoint,
3✔
1301
                )
3✔
1302
                if err != nil {
3✔
1303
                        return nil, err
×
1304
                }
×
1305

1306
                err = p.addLink(
3✔
1307
                        &chanPoint, lnChan, forwardingPolicy, chainEvents,
3✔
1308
                        true, shutdownMsg,
3✔
1309
                )
3✔
1310
                if err != nil {
3✔
1311
                        return nil, fmt.Errorf("unable to add link %v to "+
×
1312
                                "switch: %v", chanPoint, err)
×
1313
                }
×
1314

1315
                p.activeChannels.Store(chanID, lnChan)
3✔
1316

3✔
1317
                // We're using the old co-op close, so we don't need to init
3✔
1318
                // the new RBF chan closer.
3✔
1319
                if !p.rbfCoopCloseAllowed() {
6✔
1320
                        continue
3✔
1321
                }
1322

1323
                // Now that the link has been added above, we'll also init an
1324
                // RBF chan closer for this channel, but only if the new close
1325
                // feature is negotiated.
1326
                //
1327
                // Creating this here ensures that any shutdown messages sent
1328
                // will be automatically routed by the msg router.
1329
                if _, err := p.initRbfChanCloser(lnChan); err != nil {
3✔
1330
                        p.activeChanCloses.Delete(chanID)
×
1331

×
1332
                        return nil, fmt.Errorf("unable to init RBF chan "+
×
1333
                                "closer during peer connect: %w", err)
×
1334
                }
×
1335

1336
                // If the shutdown info isn't blank, then we should kick things
1337
                // off by sending a shutdown message to the remote party to
1338
                // continue the old shutdown flow.
1339
                restartShutdown := func(s channeldb.ShutdownInfo) error {
6✔
1340
                        return p.startRbfChanCloser(
3✔
1341
                                newRestartShutdownInit(s),
3✔
1342
                                lnChan.ChannelPoint(),
3✔
1343
                        )
3✔
1344
                }
3✔
1345
                err = fn.MapOptionZ(shutdownInfo, restartShutdown)
3✔
1346
                if err != nil {
3✔
1347
                        return nil, fmt.Errorf("unable to start RBF "+
×
1348
                                "chan closer: %w", err)
×
1349
                }
×
1350
        }
1351

1352
        return msgs, nil
3✔
1353
}
1354

1355
// addLink creates and adds a new ChannelLink from the specified channel.
1356
func (p *Brontide) addLink(chanPoint *wire.OutPoint,
1357
        lnChan *lnwallet.LightningChannel,
1358
        forwardingPolicy *models.ForwardingPolicy,
1359
        chainEvents *contractcourt.ChainEventSubscription,
1360
        syncStates bool, shutdownMsg fn.Option[lnwire.Shutdown]) error {
3✔
1361

3✔
1362
        // onChannelFailure will be called by the link in case the channel
3✔
1363
        // fails for some reason.
3✔
1364
        onChannelFailure := func(chanID lnwire.ChannelID,
3✔
1365
                shortChanID lnwire.ShortChannelID,
3✔
1366
                linkErr htlcswitch.LinkFailureError) {
6✔
1367

3✔
1368
                failure := linkFailureReport{
3✔
1369
                        chanPoint:   *chanPoint,
3✔
1370
                        chanID:      chanID,
3✔
1371
                        shortChanID: shortChanID,
3✔
1372
                        linkErr:     linkErr,
3✔
1373
                }
3✔
1374

3✔
1375
                select {
3✔
1376
                case p.linkFailures <- failure:
3✔
1377
                case <-p.cg.Done():
×
1378
                case <-p.cfg.Quit:
×
1379
                }
1380
        }
1381

1382
        updateContractSignals := func(signals *contractcourt.ContractSignals) error {
6✔
1383
                return p.cfg.ChainArb.UpdateContractSignals(*chanPoint, signals)
3✔
1384
        }
3✔
1385

1386
        notifyContractUpdate := func(update *contractcourt.ContractUpdate) error {
6✔
1387
                return p.cfg.ChainArb.NotifyContractUpdate(*chanPoint, update)
3✔
1388
        }
3✔
1389

1390
        //nolint:ll
1391
        linkCfg := htlcswitch.ChannelLinkConfig{
3✔
1392
                Peer:                   p,
3✔
1393
                DecodeHopIterators:     p.cfg.Sphinx.DecodeHopIterators,
3✔
1394
                ExtractErrorEncrypter:  p.cfg.Sphinx.ExtractErrorEncrypter,
3✔
1395
                FetchLastChannelUpdate: p.cfg.FetchLastChanUpdate,
3✔
1396
                HodlMask:               p.cfg.Hodl.Mask(),
3✔
1397
                Registry:               p.cfg.Invoices,
3✔
1398
                BestHeight:             p.cfg.Switch.BestHeight,
3✔
1399
                Circuits:               p.cfg.Switch.CircuitModifier(),
3✔
1400
                ForwardPackets:         p.cfg.InterceptSwitch.ForwardPackets,
3✔
1401
                FwrdingPolicy:          *forwardingPolicy,
3✔
1402
                FeeEstimator:           p.cfg.FeeEstimator,
3✔
1403
                PreimageCache:          p.cfg.WitnessBeacon,
3✔
1404
                ChainEvents:            chainEvents,
3✔
1405
                UpdateContractSignals:  updateContractSignals,
3✔
1406
                NotifyContractUpdate:   notifyContractUpdate,
3✔
1407
                OnChannelFailure:       onChannelFailure,
3✔
1408
                SyncStates:             syncStates,
3✔
1409
                BatchTicker:            ticker.New(p.cfg.ChannelCommitInterval),
3✔
1410
                FwdPkgGCTicker:         ticker.New(time.Hour),
3✔
1411
                PendingCommitTicker: ticker.New(
3✔
1412
                        p.cfg.PendingCommitInterval,
3✔
1413
                ),
3✔
1414
                BatchSize:               p.cfg.ChannelCommitBatchSize,
3✔
1415
                UnsafeReplay:            p.cfg.UnsafeReplay,
3✔
1416
                MinUpdateTimeout:        htlcswitch.DefaultMinLinkFeeUpdateTimeout,
3✔
1417
                MaxUpdateTimeout:        htlcswitch.DefaultMaxLinkFeeUpdateTimeout,
3✔
1418
                OutgoingCltvRejectDelta: p.cfg.OutgoingCltvRejectDelta,
3✔
1419
                TowerClient:             p.cfg.TowerClient,
3✔
1420
                MaxOutgoingCltvExpiry:   p.cfg.MaxOutgoingCltvExpiry,
3✔
1421
                MaxFeeAllocation:        p.cfg.MaxChannelFeeAllocation,
3✔
1422
                MaxAnchorsCommitFeeRate: p.cfg.MaxAnchorsCommitFeeRate,
3✔
1423
                NotifyActiveLink:        p.cfg.ChannelNotifier.NotifyActiveLinkEvent,
3✔
1424
                NotifyActiveChannel:     p.cfg.ChannelNotifier.NotifyActiveChannelEvent,
3✔
1425
                NotifyInactiveChannel:   p.cfg.ChannelNotifier.NotifyInactiveChannelEvent,
3✔
1426
                NotifyInactiveLinkEvent: p.cfg.ChannelNotifier.NotifyInactiveLinkEvent,
3✔
1427
                HtlcNotifier:            p.cfg.HtlcNotifier,
3✔
1428
                GetAliases:              p.cfg.GetAliases,
3✔
1429
                PreviouslySentShutdown:  shutdownMsg,
3✔
1430
                DisallowRouteBlinding:   p.cfg.DisallowRouteBlinding,
3✔
1431
                MaxFeeExposure:          p.cfg.MaxFeeExposure,
3✔
1432
                ShouldFwdExpEndorsement: p.cfg.ShouldFwdExpEndorsement,
3✔
1433
                DisallowQuiescence: p.cfg.DisallowQuiescence ||
3✔
1434
                        !p.remoteFeatures.HasFeature(lnwire.QuiescenceOptional),
3✔
1435
                AuxTrafficShaper: p.cfg.AuxTrafficShaper,
3✔
1436
        }
3✔
1437

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

3✔
1445
        // With the channel link created, we'll now notify the htlc switch so
3✔
1446
        // this channel can be used to dispatch local payments and also
3✔
1447
        // passively forward payments.
3✔
1448
        return p.cfg.Switch.CreateAndAddLink(linkCfg, lnChan)
3✔
1449
}
1450

1451
// maybeSendNodeAnn sends our node announcement to the remote peer if at least
1452
// one confirmed public channel exists with them.
1453
func (p *Brontide) maybeSendNodeAnn(channels []*channeldb.OpenChannel) {
3✔
1454
        defer p.cg.WgDone()
3✔
1455

3✔
1456
        hasConfirmedPublicChan := false
3✔
1457
        for _, channel := range channels {
6✔
1458
                if channel.IsPending {
6✔
1459
                        continue
3✔
1460
                }
1461
                if channel.ChannelFlags&lnwire.FFAnnounceChannel == 0 {
6✔
1462
                        continue
3✔
1463
                }
1464

1465
                hasConfirmedPublicChan = true
3✔
1466
                break
3✔
1467
        }
1468
        if !hasConfirmedPublicChan {
6✔
1469
                return
3✔
1470
        }
3✔
1471

1472
        ourNodeAnn, err := p.cfg.GenNodeAnnouncement()
3✔
1473
        if err != nil {
3✔
1474
                p.log.Debugf("Unable to retrieve node announcement: %v", err)
×
1475
                return
×
1476
        }
×
1477

1478
        if err := p.SendMessageLazy(false, &ourNodeAnn); err != nil {
3✔
1479
                p.log.Debugf("Unable to resend node announcement: %v", err)
×
1480
        }
×
1481
}
1482

1483
// maybeSendChannelUpdates sends our channel updates to the remote peer if we
1484
// have any active channels with them.
1485
func (p *Brontide) maybeSendChannelUpdates() {
3✔
1486
        defer p.cg.WgDone()
3✔
1487

3✔
1488
        // If we don't have any active channels, then we can exit early.
3✔
1489
        if p.activeChannels.Len() == 0 {
6✔
1490
                return
3✔
1491
        }
3✔
1492

1493
        maybeSendUpd := func(cid lnwire.ChannelID,
3✔
1494
                lnChan *lnwallet.LightningChannel) error {
6✔
1495

3✔
1496
                // Nil channels are pending, so we'll skip them.
3✔
1497
                if lnChan == nil {
6✔
1498
                        return nil
3✔
1499
                }
3✔
1500

1501
                dbChan := lnChan.State()
3✔
1502
                scid := func() lnwire.ShortChannelID {
6✔
1503
                        switch {
3✔
1504
                        // Otherwise if it's a zero conf channel and confirmed,
1505
                        // then we need to use the "real" scid.
1506
                        case dbChan.IsZeroConf() && dbChan.ZeroConfConfirmed():
3✔
1507
                                return dbChan.ZeroConfRealScid()
3✔
1508

1509
                        // Otherwise, we can use the normal scid.
1510
                        default:
3✔
1511
                                return dbChan.ShortChanID()
3✔
1512
                        }
1513
                }()
1514

1515
                // Now that we know the channel is in a good state, we'll try
1516
                // to fetch the update to send to the remote peer. If the
1517
                // channel is pending, and not a zero conf channel, we'll get
1518
                // an error here which we'll ignore.
1519
                chanUpd, err := p.cfg.FetchLastChanUpdate(scid)
3✔
1520
                if err != nil {
6✔
1521
                        p.log.Debugf("Unable to fetch channel update for "+
3✔
1522
                                "ChannelPoint(%v), scid=%v: %v",
3✔
1523
                                dbChan.FundingOutpoint, dbChan.ShortChanID, err)
3✔
1524

3✔
1525
                        return nil
3✔
1526
                }
3✔
1527

1528
                p.log.Debugf("Sending channel update for ChannelPoint(%v), "+
3✔
1529
                        "scid=%v", dbChan.FundingOutpoint, dbChan.ShortChanID)
3✔
1530

3✔
1531
                // We'll send it as a normal message instead of using the lazy
3✔
1532
                // queue to prioritize transmission of the fresh update.
3✔
1533
                if err := p.SendMessage(false, chanUpd); err != nil {
3✔
1534
                        err := fmt.Errorf("unable to send channel update for "+
×
1535
                                "ChannelPoint(%v), scid=%v: %w",
×
1536
                                dbChan.FundingOutpoint, dbChan.ShortChanID(),
×
1537
                                err)
×
1538
                        p.log.Errorf(err.Error())
×
1539

×
1540
                        return err
×
1541
                }
×
1542

1543
                return nil
3✔
1544
        }
1545

1546
        p.activeChannels.ForEach(maybeSendUpd)
3✔
1547
}
1548

1549
// WaitForDisconnect waits until the peer has disconnected. A peer may be
1550
// disconnected if the local or remote side terminates the connection, or an
1551
// irrecoverable protocol error has been encountered. This method will only
1552
// begin watching the peer's waitgroup after the ready channel or the peer's
1553
// quit channel are signaled. The ready channel should only be signaled if a
1554
// call to Start returns no error. Otherwise, if the peer fails to start,
1555
// calling Disconnect will signal the quit channel and the method will not
1556
// block, since no goroutines were spawned.
1557
func (p *Brontide) WaitForDisconnect(ready chan struct{}) {
3✔
1558
        // Before we try to call the `Wait` goroutine, we'll make sure the main
3✔
1559
        // set of goroutines are already active.
3✔
1560
        select {
3✔
1561
        case <-p.startReady:
3✔
1562
        case <-p.cg.Done():
×
1563
                return
×
1564
        }
1565

1566
        select {
3✔
1567
        case <-ready:
3✔
1568
        case <-p.cg.Done():
3✔
1569
        }
1570

1571
        p.cg.WgWait()
3✔
1572
}
1573

1574
// Disconnect terminates the connection with the remote peer. Additionally, a
1575
// signal is sent to the server and htlcSwitch indicating the resources
1576
// allocated to the peer can now be cleaned up.
1577
func (p *Brontide) Disconnect(reason error) {
3✔
1578
        if !atomic.CompareAndSwapInt32(&p.disconnect, 0, 1) {
6✔
1579
                return
3✔
1580
        }
3✔
1581

1582
        // Make sure initialization has completed before we try to tear things
1583
        // down.
1584
        //
1585
        // NOTE: We only read the `startReady` chan if the peer has been
1586
        // started, otherwise we will skip reading it as this chan won't be
1587
        // closed, hence blocks forever.
1588
        if atomic.LoadInt32(&p.started) == 1 {
6✔
1589
                p.log.Debugf("Started, waiting on startReady signal")
3✔
1590

3✔
1591
                select {
3✔
1592
                case <-p.startReady:
3✔
1593
                case <-p.cg.Done():
×
1594
                        return
×
1595
                }
1596
        }
1597

1598
        err := fmt.Errorf("disconnecting %s, reason: %v", p, reason)
3✔
1599
        p.storeError(err)
3✔
1600

3✔
1601
        p.log.Infof(err.Error())
3✔
1602

3✔
1603
        // Stop PingManager before closing TCP connection.
3✔
1604
        p.pingManager.Stop()
3✔
1605

3✔
1606
        // Ensure that the TCP connection is properly closed before continuing.
3✔
1607
        p.cfg.Conn.Close()
3✔
1608

3✔
1609
        p.cg.Quit()
3✔
1610

3✔
1611
        // If our msg router isn't global (local to this instance), then we'll
3✔
1612
        // stop it. Otherwise, we'll leave it running.
3✔
1613
        if !p.globalMsgRouter {
6✔
1614
                p.msgRouter.WhenSome(func(router msgmux.Router) {
6✔
1615
                        router.Stop()
3✔
1616
                })
3✔
1617
        }
1618
}
1619

1620
// String returns the string representation of this peer.
1621
func (p *Brontide) String() string {
3✔
1622
        return fmt.Sprintf("%x@%s", p.cfg.PubKeyBytes, p.cfg.Conn.RemoteAddr())
3✔
1623
}
3✔
1624

1625
// readNextMessage reads, and returns the next message on the wire along with
1626
// any additional raw payload.
1627
func (p *Brontide) readNextMessage() (lnwire.Message, error) {
3✔
1628
        noiseConn := p.cfg.Conn
3✔
1629
        err := noiseConn.SetReadDeadline(time.Time{})
3✔
1630
        if err != nil {
3✔
1631
                return nil, err
×
1632
        }
×
1633

1634
        pktLen, err := noiseConn.ReadNextHeader()
3✔
1635
        if err != nil {
6✔
1636
                return nil, fmt.Errorf("read next header: %w", err)
3✔
1637
        }
3✔
1638

1639
        // First we'll read the next _full_ message. We do this rather than
1640
        // reading incrementally from the stream as the Lightning wire protocol
1641
        // is message oriented and allows nodes to pad on additional data to
1642
        // the message stream.
1643
        var (
3✔
1644
                nextMsg lnwire.Message
3✔
1645
                msgLen  uint64
3✔
1646
        )
3✔
1647
        err = p.cfg.ReadPool.Submit(func(buf *buffer.Read) error {
6✔
1648
                // Before reading the body of the message, set the read timeout
3✔
1649
                // accordingly to ensure we don't block other readers using the
3✔
1650
                // pool. We do so only after the task has been scheduled to
3✔
1651
                // ensure the deadline doesn't expire while the message is in
3✔
1652
                // the process of being scheduled.
3✔
1653
                readDeadline := time.Now().Add(
3✔
1654
                        p.scaleTimeout(readMessageTimeout),
3✔
1655
                )
3✔
1656
                readErr := noiseConn.SetReadDeadline(readDeadline)
3✔
1657
                if readErr != nil {
3✔
1658
                        return readErr
×
1659
                }
×
1660

1661
                // The ReadNextBody method will actually end up re-using the
1662
                // buffer, so within this closure, we can continue to use
1663
                // rawMsg as it's just a slice into the buf from the buffer
1664
                // pool.
1665
                rawMsg, readErr := noiseConn.ReadNextBody(buf[:pktLen])
3✔
1666
                if readErr != nil {
3✔
1667
                        return fmt.Errorf("read next body: %w", readErr)
×
1668
                }
×
1669
                msgLen = uint64(len(rawMsg))
3✔
1670

3✔
1671
                // Next, create a new io.Reader implementation from the raw
3✔
1672
                // message, and use this to decode the message directly from.
3✔
1673
                msgReader := bytes.NewReader(rawMsg)
3✔
1674
                nextMsg, err = lnwire.ReadMessage(msgReader, 0)
3✔
1675
                if err != nil {
6✔
1676
                        return err
3✔
1677
                }
3✔
1678

1679
                // At this point, rawMsg and buf will be returned back to the
1680
                // buffer pool for re-use.
1681
                return nil
3✔
1682
        })
1683
        atomic.AddUint64(&p.bytesReceived, msgLen)
3✔
1684
        if err != nil {
6✔
1685
                return nil, err
3✔
1686
        }
3✔
1687

1688
        p.logWireMessage(nextMsg, true)
3✔
1689

3✔
1690
        return nextMsg, nil
3✔
1691
}
1692

1693
// msgStream implements a goroutine-safe, in-order stream of messages to be
1694
// delivered via closure to a receiver. These messages MUST be in order due to
1695
// the nature of the lightning channel commitment and gossiper state machines.
1696
// TODO(conner): use stream handler interface to abstract out stream
1697
// state/logging.
1698
type msgStream struct {
1699
        streamShutdown int32 // To be used atomically.
1700

1701
        peer *Brontide
1702

1703
        apply func(lnwire.Message)
1704

1705
        startMsg string
1706
        stopMsg  string
1707

1708
        msgCond *sync.Cond
1709
        msgs    []lnwire.Message
1710

1711
        mtx sync.Mutex
1712

1713
        producerSema chan struct{}
1714

1715
        wg   sync.WaitGroup
1716
        quit chan struct{}
1717
}
1718

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

3✔
1727
        stream := &msgStream{
3✔
1728
                peer:         p,
3✔
1729
                apply:        apply,
3✔
1730
                startMsg:     startMsg,
3✔
1731
                stopMsg:      stopMsg,
3✔
1732
                producerSema: make(chan struct{}, bufSize),
3✔
1733
                quit:         make(chan struct{}),
3✔
1734
        }
3✔
1735
        stream.msgCond = sync.NewCond(&stream.mtx)
3✔
1736

3✔
1737
        // Before we return the active stream, we'll populate the producer's
3✔
1738
        // semaphore channel. We'll use this to ensure that the producer won't
3✔
1739
        // attempt to allocate memory in the queue for an item until it has
3✔
1740
        // sufficient extra space.
3✔
1741
        for i := uint32(0); i < bufSize; i++ {
6✔
1742
                stream.producerSema <- struct{}{}
3✔
1743
        }
3✔
1744

1745
        return stream
3✔
1746
}
1747

1748
// Start starts the chanMsgStream.
1749
func (ms *msgStream) Start() {
3✔
1750
        ms.wg.Add(1)
3✔
1751
        go ms.msgConsumer()
3✔
1752
}
3✔
1753

1754
// Stop stops the chanMsgStream.
1755
func (ms *msgStream) Stop() {
3✔
1756
        // TODO(roasbeef): signal too?
3✔
1757

3✔
1758
        close(ms.quit)
3✔
1759

3✔
1760
        // Now that we've closed the channel, we'll repeatedly signal the msg
3✔
1761
        // consumer until we've detected that it has exited.
3✔
1762
        for atomic.LoadInt32(&ms.streamShutdown) == 0 {
6✔
1763
                ms.msgCond.Signal()
3✔
1764
                time.Sleep(time.Millisecond * 100)
3✔
1765
        }
3✔
1766

1767
        ms.wg.Wait()
3✔
1768
}
1769

1770
// msgConsumer is the main goroutine that streams messages from the peer's
1771
// readHandler directly to the target channel.
1772
func (ms *msgStream) msgConsumer() {
3✔
1773
        defer ms.wg.Done()
3✔
1774
        defer peerLog.Tracef(ms.stopMsg)
3✔
1775
        defer atomic.StoreInt32(&ms.streamShutdown, 1)
3✔
1776

3✔
1777
        peerLog.Tracef(ms.startMsg)
3✔
1778

3✔
1779
        for {
6✔
1780
                // First, we'll check our condition. If the queue of messages
3✔
1781
                // is empty, then we'll wait until a new item is added.
3✔
1782
                ms.msgCond.L.Lock()
3✔
1783
                for len(ms.msgs) == 0 {
6✔
1784
                        ms.msgCond.Wait()
3✔
1785

3✔
1786
                        // If we woke up in order to exit, then we'll do so.
3✔
1787
                        // Otherwise, we'll check the message queue for any new
3✔
1788
                        // items.
3✔
1789
                        select {
3✔
1790
                        case <-ms.peer.cg.Done():
3✔
1791
                                ms.msgCond.L.Unlock()
3✔
1792
                                return
3✔
1793
                        case <-ms.quit:
3✔
1794
                                ms.msgCond.L.Unlock()
3✔
1795
                                return
3✔
1796
                        default:
3✔
1797
                        }
1798
                }
1799

1800
                // Grab the message off the front of the queue, shifting the
1801
                // slice's reference down one in order to remove the message
1802
                // from the queue.
1803
                msg := ms.msgs[0]
3✔
1804
                ms.msgs[0] = nil // Set to nil to prevent GC leak.
3✔
1805
                ms.msgs = ms.msgs[1:]
3✔
1806

3✔
1807
                ms.msgCond.L.Unlock()
3✔
1808

3✔
1809
                ms.apply(msg)
3✔
1810

3✔
1811
                // We've just successfully processed an item, so we'll signal
3✔
1812
                // to the producer that a new slot in the buffer. We'll use
3✔
1813
                // this to bound the size of the buffer to avoid allowing it to
3✔
1814
                // grow indefinitely.
3✔
1815
                select {
3✔
1816
                case ms.producerSema <- struct{}{}:
3✔
1817
                case <-ms.peer.cg.Done():
3✔
1818
                        return
3✔
1819
                case <-ms.quit:
3✔
1820
                        return
3✔
1821
                }
1822
        }
1823
}
1824

1825
// AddMsg adds a new message to the msgStream. This function is safe for
1826
// concurrent access.
1827
func (ms *msgStream) AddMsg(msg lnwire.Message) {
3✔
1828
        // First, we'll attempt to receive from the producerSema struct. This
3✔
1829
        // acts as a semaphore to prevent us from indefinitely buffering
3✔
1830
        // incoming items from the wire. Either the msg queue isn't full, and
3✔
1831
        // we'll not block, or the queue is full, and we'll block until either
3✔
1832
        // we're signalled to quit, or a slot is freed up.
3✔
1833
        select {
3✔
1834
        case <-ms.producerSema:
3✔
1835
        case <-ms.peer.cg.Done():
×
1836
                return
×
1837
        case <-ms.quit:
×
1838
                return
×
1839
        }
1840

1841
        // Next, we'll lock the condition, and add the message to the end of
1842
        // the message queue.
1843
        ms.msgCond.L.Lock()
3✔
1844
        ms.msgs = append(ms.msgs, msg)
3✔
1845
        ms.msgCond.L.Unlock()
3✔
1846

3✔
1847
        // With the message added, we signal to the msgConsumer that there are
3✔
1848
        // additional messages to consume.
3✔
1849
        ms.msgCond.Signal()
3✔
1850
}
1851

1852
// waitUntilLinkActive waits until the target link is active and returns a
1853
// ChannelLink to pass messages to. It accomplishes this by subscribing to
1854
// an ActiveLinkEvent which is emitted by the link when it first starts up.
1855
func waitUntilLinkActive(p *Brontide,
1856
        cid lnwire.ChannelID) htlcswitch.ChannelUpdateHandler {
3✔
1857

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

3✔
1860
        // Subscribe to receive channel events.
3✔
1861
        //
3✔
1862
        // NOTE: If the link is already active by SubscribeChannelEvents, then
3✔
1863
        // GetLink will retrieve the link and we can send messages. If the link
3✔
1864
        // becomes active between SubscribeChannelEvents and GetLink, then GetLink
3✔
1865
        // will retrieve the link. If the link becomes active after GetLink, then
3✔
1866
        // we will get an ActiveLinkEvent notification and retrieve the link. If
3✔
1867
        // the call to GetLink is before SubscribeChannelEvents, however, there
3✔
1868
        // will be a race condition.
3✔
1869
        sub, err := p.cfg.ChannelNotifier.SubscribeChannelEvents()
3✔
1870
        if err != nil {
6✔
1871
                // If we have a non-nil error, then the server is shutting down and we
3✔
1872
                // can exit here and return nil. This means no message will be delivered
3✔
1873
                // to the link.
3✔
1874
                return nil
3✔
1875
        }
3✔
1876
        defer sub.Cancel()
3✔
1877

3✔
1878
        // The link may already be active by this point, and we may have missed the
3✔
1879
        // ActiveLinkEvent. Check if the link exists.
3✔
1880
        link := p.fetchLinkFromKeyAndCid(cid)
3✔
1881
        if link != nil {
6✔
1882
                return link
3✔
1883
        }
3✔
1884

1885
        // If the link is nil, we must wait for it to be active.
1886
        for {
6✔
1887
                select {
3✔
1888
                // A new event has been sent by the ChannelNotifier. We first check
1889
                // whether the event is an ActiveLinkEvent. If it is, we'll check
1890
                // that the event is for this channel. Otherwise, we discard the
1891
                // message.
1892
                case e := <-sub.Updates():
3✔
1893
                        event, ok := e.(channelnotifier.ActiveLinkEvent)
3✔
1894
                        if !ok {
6✔
1895
                                // Ignore this notification.
3✔
1896
                                continue
3✔
1897
                        }
1898

1899
                        chanPoint := event.ChannelPoint
3✔
1900

3✔
1901
                        // Check whether the retrieved chanPoint matches the target
3✔
1902
                        // channel id.
3✔
1903
                        if !cid.IsChanPoint(chanPoint) {
3✔
1904
                                continue
×
1905
                        }
1906

1907
                        // The link shouldn't be nil as we received an
1908
                        // ActiveLinkEvent. If it is nil, we return nil and the
1909
                        // calling function should catch it.
1910
                        return p.fetchLinkFromKeyAndCid(cid)
3✔
1911

1912
                case <-p.cg.Done():
3✔
1913
                        return nil
3✔
1914
                }
1915
        }
1916
}
1917

1918
// newChanMsgStream is used to create a msgStream between the peer and
1919
// particular channel link in the htlcswitch. We utilize additional
1920
// synchronization with the fundingManager to ensure we don't attempt to
1921
// dispatch a message to a channel before it is fully active. A reference to the
1922
// channel this stream forwards to is held in scope to prevent unnecessary
1923
// lookups.
1924
func newChanMsgStream(p *Brontide, cid lnwire.ChannelID) *msgStream {
3✔
1925
        var chanLink htlcswitch.ChannelUpdateHandler
3✔
1926

3✔
1927
        apply := func(msg lnwire.Message) {
6✔
1928
                // This check is fine because if the link no longer exists, it will
3✔
1929
                // be removed from the activeChannels map and subsequent messages
3✔
1930
                // shouldn't reach the chan msg stream.
3✔
1931
                if chanLink == nil {
6✔
1932
                        chanLink = waitUntilLinkActive(p, cid)
3✔
1933

3✔
1934
                        // If the link is still not active and the calling function
3✔
1935
                        // errored out, just return.
3✔
1936
                        if chanLink == nil {
6✔
1937
                                p.log.Warnf("Link=%v is not active", cid)
3✔
1938
                                return
3✔
1939
                        }
3✔
1940
                }
1941

1942
                // In order to avoid unnecessarily delivering message
1943
                // as the peer is exiting, we'll check quickly to see
1944
                // if we need to exit.
1945
                select {
3✔
1946
                case <-p.cg.Done():
×
1947
                        return
×
1948
                default:
3✔
1949
                }
1950

1951
                chanLink.HandleChannelUpdate(msg)
3✔
1952
        }
1953

1954
        return newMsgStream(p,
3✔
1955
                fmt.Sprintf("Update stream for ChannelID(%x) created", cid[:]),
3✔
1956
                fmt.Sprintf("Update stream for ChannelID(%x) exiting", cid[:]),
3✔
1957
                msgStreamSize,
3✔
1958
                apply,
3✔
1959
        )
3✔
1960
}
1961

1962
// newDiscMsgStream is used to setup a msgStream between the peer and the
1963
// authenticated gossiper. This stream should be used to forward all remote
1964
// channel announcements.
1965
func newDiscMsgStream(p *Brontide) *msgStream {
3✔
1966
        apply := func(msg lnwire.Message) {
6✔
1967
                // TODO(yy): `ProcessRemoteAnnouncement` returns an error chan
3✔
1968
                // and we need to process it.
3✔
1969
                p.cfg.AuthGossiper.ProcessRemoteAnnouncement(msg, p)
3✔
1970
        }
3✔
1971

1972
        return newMsgStream(
3✔
1973
                p,
3✔
1974
                "Update stream for gossiper created",
3✔
1975
                "Update stream for gossiper exited",
3✔
1976
                msgStreamSize,
3✔
1977
                apply,
3✔
1978
        )
3✔
1979
}
1980

1981
// readHandler is responsible for reading messages off the wire in series, then
1982
// properly dispatching the handling of the message to the proper subsystem.
1983
//
1984
// NOTE: This method MUST be run as a goroutine.
1985
func (p *Brontide) readHandler() {
3✔
1986
        defer p.cg.WgDone()
3✔
1987

3✔
1988
        // We'll stop the timer after a new messages is received, and also
3✔
1989
        // reset it after we process the next message.
3✔
1990
        idleTimer := time.AfterFunc(idleTimeout, func() {
3✔
1991
                err := fmt.Errorf("peer %s no answer for %s -- disconnecting",
×
1992
                        p, idleTimeout)
×
1993
                p.Disconnect(err)
×
1994
        })
×
1995

1996
        // Initialize our negotiated gossip sync method before reading messages
1997
        // off the wire. When using gossip queries, this ensures a gossip
1998
        // syncer is active by the time query messages arrive.
1999
        //
2000
        // TODO(conner): have peer store gossip syncer directly and bypass
2001
        // gossiper?
2002
        p.initGossipSync()
3✔
2003

3✔
2004
        discStream := newDiscMsgStream(p)
3✔
2005
        discStream.Start()
3✔
2006
        defer discStream.Stop()
3✔
2007
out:
3✔
2008
        for atomic.LoadInt32(&p.disconnect) == 0 {
6✔
2009
                nextMsg, err := p.readNextMessage()
3✔
2010
                if !idleTimer.Stop() {
6✔
2011
                        select {
3✔
2012
                        case <-idleTimer.C:
×
2013
                        default:
3✔
2014
                        }
2015
                }
2016
                if err != nil {
6✔
2017
                        p.log.Infof("unable to read message from peer: %v", err)
3✔
2018

3✔
2019
                        // If we could not read our peer's message due to an
3✔
2020
                        // unknown type or invalid alias, we continue processing
3✔
2021
                        // as normal. We store unknown message and address
3✔
2022
                        // types, as they may provide debugging insight.
3✔
2023
                        switch e := err.(type) {
3✔
2024
                        // If this is just a message we don't yet recognize,
2025
                        // we'll continue processing as normal as this allows
2026
                        // us to introduce new messages in a forwards
2027
                        // compatible manner.
2028
                        case *lnwire.UnknownMessage:
3✔
2029
                                p.storeError(e)
3✔
2030
                                idleTimer.Reset(idleTimeout)
3✔
2031
                                continue
3✔
2032

2033
                        // If they sent us an address type that we don't yet
2034
                        // know of, then this isn't a wire error, so we'll
2035
                        // simply continue parsing the remainder of their
2036
                        // messages.
2037
                        case *lnwire.ErrUnknownAddrType:
×
2038
                                p.storeError(e)
×
2039
                                idleTimer.Reset(idleTimeout)
×
2040
                                continue
×
2041

2042
                        // If the NodeAnnouncement has an invalid alias, then
2043
                        // we'll log that error above and continue so we can
2044
                        // continue to read messages from the peer. We do not
2045
                        // store this error because it is of little debugging
2046
                        // value.
2047
                        case *lnwire.ErrInvalidNodeAlias:
×
2048
                                idleTimer.Reset(idleTimeout)
×
2049
                                continue
×
2050

2051
                        // If the error we encountered wasn't just a message we
2052
                        // didn't recognize, then we'll stop all processing as
2053
                        // this is a fatal error.
2054
                        default:
3✔
2055
                                break out
3✔
2056
                        }
2057
                }
2058

2059
                // If a message router is active, then we'll try to have it
2060
                // handle this message. If it can, then we're able to skip the
2061
                // rest of the message handling logic.
2062
                err = fn.MapOptionZ(p.msgRouter, func(r msgmux.Router) error {
6✔
2063
                        return r.RouteMsg(msgmux.PeerMsg{
3✔
2064
                                PeerPub: *p.IdentityKey(),
3✔
2065
                                Message: nextMsg,
3✔
2066
                        })
3✔
2067
                })
3✔
2068

2069
                // No error occurred, and the message was handled by the
2070
                // router.
2071
                if err == nil {
6✔
2072
                        continue
3✔
2073
                }
2074

2075
                var (
3✔
2076
                        targetChan   lnwire.ChannelID
3✔
2077
                        isLinkUpdate bool
3✔
2078
                )
3✔
2079

3✔
2080
                switch msg := nextMsg.(type) {
3✔
2081
                case *lnwire.Pong:
×
2082
                        // When we receive a Pong message in response to our
×
2083
                        // last ping message, we send it to the pingManager
×
2084
                        p.pingManager.ReceivedPong(msg)
×
2085

2086
                case *lnwire.Ping:
×
2087
                        // First, we'll store their latest ping payload within
×
2088
                        // the relevant atomic variable.
×
2089
                        p.lastPingPayload.Store(msg.PaddingBytes[:])
×
2090

×
2091
                        // Next, we'll send over the amount of specified pong
×
2092
                        // bytes.
×
2093
                        pong := lnwire.NewPong(p.cfg.PongBuf[0:msg.NumPongBytes])
×
2094
                        p.queueMsg(pong, nil)
×
2095

2096
                case *lnwire.OpenChannel,
2097
                        *lnwire.AcceptChannel,
2098
                        *lnwire.FundingCreated,
2099
                        *lnwire.FundingSigned,
2100
                        *lnwire.ChannelReady:
3✔
2101

3✔
2102
                        p.cfg.FundingManager.ProcessFundingMsg(msg, p)
3✔
2103

2104
                case *lnwire.Shutdown:
3✔
2105
                        select {
3✔
2106
                        case p.chanCloseMsgs <- &closeMsg{msg.ChannelID, msg}:
3✔
2107
                        case <-p.cg.Done():
×
2108
                                break out
×
2109
                        }
2110
                case *lnwire.ClosingSigned:
3✔
2111
                        select {
3✔
2112
                        case p.chanCloseMsgs <- &closeMsg{msg.ChannelID, msg}:
3✔
2113
                        case <-p.cg.Done():
×
2114
                                break out
×
2115
                        }
2116

2117
                case *lnwire.Warning:
×
2118
                        targetChan = msg.ChanID
×
2119
                        isLinkUpdate = p.handleWarningOrError(targetChan, msg)
×
2120

2121
                case *lnwire.Error:
3✔
2122
                        targetChan = msg.ChanID
3✔
2123
                        isLinkUpdate = p.handleWarningOrError(targetChan, msg)
3✔
2124

2125
                case *lnwire.ChannelReestablish:
3✔
2126
                        targetChan = msg.ChanID
3✔
2127
                        isLinkUpdate = p.hasChannel(targetChan)
3✔
2128

3✔
2129
                        // If we failed to find the link in question, and the
3✔
2130
                        // message received was a channel sync message, then
3✔
2131
                        // this might be a peer trying to resync closed channel.
3✔
2132
                        // In this case we'll try to resend our last channel
3✔
2133
                        // sync message, such that the peer can recover funds
3✔
2134
                        // from the closed channel.
3✔
2135
                        if !isLinkUpdate {
6✔
2136
                                err := p.resendChanSyncMsg(targetChan)
3✔
2137
                                if err != nil {
6✔
2138
                                        // TODO(halseth): send error to peer?
3✔
2139
                                        p.log.Errorf("resend failed: %v",
3✔
2140
                                                err)
3✔
2141
                                }
3✔
2142
                        }
2143

2144
                // For messages that implement the LinkUpdater interface, we
2145
                // will consider them as link updates and send them to
2146
                // chanStream. These messages will be queued inside chanStream
2147
                // if the channel is not active yet.
2148
                case lnwire.LinkUpdater:
3✔
2149
                        targetChan = msg.TargetChanID()
3✔
2150
                        isLinkUpdate = p.hasChannel(targetChan)
3✔
2151

3✔
2152
                        // Log an error if we don't have this channel. This
3✔
2153
                        // means the peer has sent us a message with unknown
3✔
2154
                        // channel ID.
3✔
2155
                        if !isLinkUpdate {
6✔
2156
                                p.log.Errorf("Unknown channel ID: %v found "+
3✔
2157
                                        "in received msg=%s", targetChan,
3✔
2158
                                        nextMsg.MsgType())
3✔
2159
                        }
3✔
2160

2161
                case *lnwire.ChannelUpdate1,
2162
                        *lnwire.ChannelAnnouncement1,
2163
                        *lnwire.NodeAnnouncement,
2164
                        *lnwire.AnnounceSignatures1,
2165
                        *lnwire.GossipTimestampRange,
2166
                        *lnwire.QueryShortChanIDs,
2167
                        *lnwire.QueryChannelRange,
2168
                        *lnwire.ReplyChannelRange,
2169
                        *lnwire.ReplyShortChanIDsEnd:
3✔
2170

3✔
2171
                        discStream.AddMsg(msg)
3✔
2172

2173
                case *lnwire.Custom:
3✔
2174
                        err := p.handleCustomMessage(msg)
3✔
2175
                        if err != nil {
3✔
2176
                                p.storeError(err)
×
2177
                                p.log.Errorf("%v", err)
×
2178
                        }
×
2179

2180
                default:
×
2181
                        // If the message we received is unknown to us, store
×
2182
                        // the type to track the failure.
×
2183
                        err := fmt.Errorf("unknown message type %v received",
×
2184
                                uint16(msg.MsgType()))
×
2185
                        p.storeError(err)
×
2186

×
2187
                        p.log.Errorf("%v", err)
×
2188
                }
2189

2190
                if isLinkUpdate {
6✔
2191
                        // If this is a channel update, then we need to feed it
3✔
2192
                        // into the channel's in-order message stream.
3✔
2193
                        p.sendLinkUpdateMsg(targetChan, nextMsg)
3✔
2194
                }
3✔
2195

2196
                idleTimer.Reset(idleTimeout)
3✔
2197
        }
2198

2199
        p.Disconnect(errors.New("read handler closed"))
3✔
2200

3✔
2201
        p.log.Trace("readHandler for peer done")
3✔
2202
}
2203

2204
// handleCustomMessage handles the given custom message if a handler is
2205
// registered.
2206
func (p *Brontide) handleCustomMessage(msg *lnwire.Custom) error {
3✔
2207
        if p.cfg.HandleCustomMessage == nil {
3✔
2208
                return fmt.Errorf("no custom message handler for "+
×
2209
                        "message type %v", uint16(msg.MsgType()))
×
2210
        }
×
2211

2212
        return p.cfg.HandleCustomMessage(p.PubKey(), msg)
3✔
2213
}
2214

2215
// isLoadedFromDisk returns true if the provided channel ID is loaded from
2216
// disk.
2217
//
2218
// NOTE: only returns true for pending channels.
2219
func (p *Brontide) isLoadedFromDisk(chanID lnwire.ChannelID) bool {
3✔
2220
        // If this is a newly added channel, no need to reestablish.
3✔
2221
        _, added := p.addedChannels.Load(chanID)
3✔
2222
        if added {
6✔
2223
                return false
3✔
2224
        }
3✔
2225

2226
        // Return false if the channel is unknown.
2227
        channel, ok := p.activeChannels.Load(chanID)
3✔
2228
        if !ok {
3✔
2229
                return false
×
2230
        }
×
2231

2232
        // During startup, we will use a nil value to mark a pending channel
2233
        // that's loaded from disk.
2234
        return channel == nil
3✔
2235
}
2236

2237
// isActiveChannel returns true if the provided channel id is active, otherwise
2238
// returns false.
2239
func (p *Brontide) isActiveChannel(chanID lnwire.ChannelID) bool {
3✔
2240
        // The channel would be nil if,
3✔
2241
        // - the channel doesn't exist, or,
3✔
2242
        // - the channel exists, but is pending. In this case, we don't
3✔
2243
        //   consider this channel active.
3✔
2244
        channel, _ := p.activeChannels.Load(chanID)
3✔
2245

3✔
2246
        return channel != nil
3✔
2247
}
3✔
2248

2249
// isPendingChannel returns true if the provided channel ID is pending, and
2250
// returns false if the channel is active or unknown.
2251
func (p *Brontide) isPendingChannel(chanID lnwire.ChannelID) bool {
3✔
2252
        // Return false if the channel is unknown.
3✔
2253
        channel, ok := p.activeChannels.Load(chanID)
3✔
2254
        if !ok {
6✔
2255
                return false
3✔
2256
        }
3✔
2257

2258
        return channel == nil
3✔
2259
}
2260

2261
// hasChannel returns true if the peer has a pending/active channel specified
2262
// by the channel ID.
2263
func (p *Brontide) hasChannel(chanID lnwire.ChannelID) bool {
3✔
2264
        _, ok := p.activeChannels.Load(chanID)
3✔
2265
        return ok
3✔
2266
}
3✔
2267

2268
// storeError stores an error in our peer's buffer of recent errors with the
2269
// current timestamp. Errors are only stored if we have at least one active
2270
// channel with the peer to mitigate a dos vector where a peer costlessly
2271
// connects to us and spams us with errors.
2272
func (p *Brontide) storeError(err error) {
3✔
2273
        var haveChannels bool
3✔
2274

3✔
2275
        p.activeChannels.Range(func(_ lnwire.ChannelID,
3✔
2276
                channel *lnwallet.LightningChannel) bool {
6✔
2277

3✔
2278
                // Pending channels will be nil in the activeChannels map.
3✔
2279
                if channel == nil {
6✔
2280
                        // Return true to continue the iteration.
3✔
2281
                        return true
3✔
2282
                }
3✔
2283

2284
                haveChannels = true
3✔
2285

3✔
2286
                // Return false to break the iteration.
3✔
2287
                return false
3✔
2288
        })
2289

2290
        // If we do not have any active channels with the peer, we do not store
2291
        // errors as a dos mitigation.
2292
        if !haveChannels {
6✔
2293
                p.log.Trace("no channels with peer, not storing err")
3✔
2294
                return
3✔
2295
        }
3✔
2296

2297
        p.cfg.ErrorBuffer.Add(
3✔
2298
                &TimestampedError{Timestamp: time.Now(), Error: err},
3✔
2299
        )
3✔
2300
}
2301

2302
// handleWarningOrError processes a warning or error msg and returns true if
2303
// msg should be forwarded to the associated channel link. False is returned if
2304
// any necessary forwarding of msg was already handled by this method. If msg is
2305
// an error from a peer with an active channel, we'll store it in memory.
2306
//
2307
// NOTE: This method should only be called from within the readHandler.
2308
func (p *Brontide) handleWarningOrError(chanID lnwire.ChannelID,
2309
        msg lnwire.Message) bool {
3✔
2310

3✔
2311
        if errMsg, ok := msg.(*lnwire.Error); ok {
6✔
2312
                p.storeError(errMsg)
3✔
2313
        }
3✔
2314

2315
        switch {
3✔
2316
        // Connection wide messages should be forwarded to all channel links
2317
        // with this peer.
2318
        case chanID == lnwire.ConnectionWideID:
×
2319
                for _, chanStream := range p.activeMsgStreams {
×
2320
                        chanStream.AddMsg(msg)
×
2321
                }
×
2322

2323
                return false
×
2324

2325
        // If the channel ID for the message corresponds to a pending channel,
2326
        // then the funding manager will handle it.
2327
        case p.cfg.FundingManager.IsPendingChannel(chanID, p):
3✔
2328
                p.cfg.FundingManager.ProcessFundingMsg(msg, p)
3✔
2329
                return false
3✔
2330

2331
        // If not we hand the message to the channel link for this channel.
2332
        case p.isActiveChannel(chanID):
3✔
2333
                return true
3✔
2334

2335
        default:
3✔
2336
                return false
3✔
2337
        }
2338
}
2339

2340
// messageSummary returns a human-readable string that summarizes a
2341
// incoming/outgoing message. Not all messages will have a summary, only those
2342
// which have additional data that can be informative at a glance.
2343
func messageSummary(msg lnwire.Message) string {
3✔
2344
        switch msg := msg.(type) {
3✔
2345
        case *lnwire.Init:
3✔
2346
                // No summary.
3✔
2347
                return ""
3✔
2348

2349
        case *lnwire.OpenChannel:
3✔
2350
                return fmt.Sprintf("temp_chan_id=%x, chain=%v, csv=%v, amt=%v, "+
3✔
2351
                        "push_amt=%v, reserve=%v, flags=%v",
3✔
2352
                        msg.PendingChannelID[:], msg.ChainHash,
3✔
2353
                        msg.CsvDelay, msg.FundingAmount, msg.PushAmount,
3✔
2354
                        msg.ChannelReserve, msg.ChannelFlags)
3✔
2355

2356
        case *lnwire.AcceptChannel:
3✔
2357
                return fmt.Sprintf("temp_chan_id=%x, reserve=%v, csv=%v, num_confs=%v",
3✔
2358
                        msg.PendingChannelID[:], msg.ChannelReserve, msg.CsvDelay,
3✔
2359
                        msg.MinAcceptDepth)
3✔
2360

2361
        case *lnwire.FundingCreated:
3✔
2362
                return fmt.Sprintf("temp_chan_id=%x, chan_point=%v",
3✔
2363
                        msg.PendingChannelID[:], msg.FundingPoint)
3✔
2364

2365
        case *lnwire.FundingSigned:
3✔
2366
                return fmt.Sprintf("chan_id=%v", msg.ChanID)
3✔
2367

2368
        case *lnwire.ChannelReady:
3✔
2369
                return fmt.Sprintf("chan_id=%v, next_point=%x",
3✔
2370
                        msg.ChanID, msg.NextPerCommitmentPoint.SerializeCompressed())
3✔
2371

2372
        case *lnwire.Shutdown:
3✔
2373
                return fmt.Sprintf("chan_id=%v, script=%x", msg.ChannelID,
3✔
2374
                        msg.Address[:])
3✔
2375

2376
        case *lnwire.ClosingComplete:
3✔
2377
                return fmt.Sprintf("chan_id=%v, fee_sat=%v, locktime=%v",
3✔
2378
                        msg.ChannelID, msg.FeeSatoshis, msg.LockTime)
3✔
2379

2380
        case *lnwire.ClosingSig:
3✔
2381
                return fmt.Sprintf("chan_id=%v", msg.ChannelID)
3✔
2382

2383
        case *lnwire.ClosingSigned:
3✔
2384
                return fmt.Sprintf("chan_id=%v, fee_sat=%v", msg.ChannelID,
3✔
2385
                        msg.FeeSatoshis)
3✔
2386

2387
        case *lnwire.UpdateAddHTLC:
3✔
2388
                var blindingPoint []byte
3✔
2389
                msg.BlindingPoint.WhenSome(
3✔
2390
                        func(b tlv.RecordT[lnwire.BlindingPointTlvType,
3✔
2391
                                *btcec.PublicKey]) {
6✔
2392

3✔
2393
                                blindingPoint = b.Val.SerializeCompressed()
3✔
2394
                        },
3✔
2395
                )
2396

2397
                return fmt.Sprintf("chan_id=%v, id=%v, amt=%v, expiry=%v, "+
3✔
2398
                        "hash=%x, blinding_point=%x, custom_records=%v",
3✔
2399
                        msg.ChanID, msg.ID, msg.Amount, msg.Expiry,
3✔
2400
                        msg.PaymentHash[:], blindingPoint, msg.CustomRecords)
3✔
2401

2402
        case *lnwire.UpdateFailHTLC:
3✔
2403
                return fmt.Sprintf("chan_id=%v, id=%v, reason=%x", msg.ChanID,
3✔
2404
                        msg.ID, msg.Reason)
3✔
2405

2406
        case *lnwire.UpdateFulfillHTLC:
3✔
2407
                return fmt.Sprintf("chan_id=%v, id=%v, preimage=%x, "+
3✔
2408
                        "custom_records=%v", msg.ChanID, msg.ID,
3✔
2409
                        msg.PaymentPreimage[:], msg.CustomRecords)
3✔
2410

2411
        case *lnwire.CommitSig:
3✔
2412
                return fmt.Sprintf("chan_id=%v, num_htlcs=%v", msg.ChanID,
3✔
2413
                        len(msg.HtlcSigs))
3✔
2414

2415
        case *lnwire.RevokeAndAck:
3✔
2416
                return fmt.Sprintf("chan_id=%v, rev=%x, next_point=%x",
3✔
2417
                        msg.ChanID, msg.Revocation[:],
3✔
2418
                        msg.NextRevocationKey.SerializeCompressed())
3✔
2419

2420
        case *lnwire.UpdateFailMalformedHTLC:
3✔
2421
                return fmt.Sprintf("chan_id=%v, id=%v, fail_code=%v",
3✔
2422
                        msg.ChanID, msg.ID, msg.FailureCode)
3✔
2423

2424
        case *lnwire.Warning:
×
2425
                return fmt.Sprintf("%v", msg.Warning())
×
2426

2427
        case *lnwire.Error:
3✔
2428
                return fmt.Sprintf("%v", msg.Error())
3✔
2429

2430
        case *lnwire.AnnounceSignatures1:
3✔
2431
                return fmt.Sprintf("chan_id=%v, short_chan_id=%v", msg.ChannelID,
3✔
2432
                        msg.ShortChannelID.ToUint64())
3✔
2433

2434
        case *lnwire.ChannelAnnouncement1:
3✔
2435
                return fmt.Sprintf("chain_hash=%v, short_chan_id=%v",
3✔
2436
                        msg.ChainHash, msg.ShortChannelID.ToUint64())
3✔
2437

2438
        case *lnwire.ChannelUpdate1:
3✔
2439
                return fmt.Sprintf("chain_hash=%v, short_chan_id=%v, "+
3✔
2440
                        "mflags=%v, cflags=%v, update_time=%v", msg.ChainHash,
3✔
2441
                        msg.ShortChannelID.ToUint64(), msg.MessageFlags,
3✔
2442
                        msg.ChannelFlags, time.Unix(int64(msg.Timestamp), 0))
3✔
2443

2444
        case *lnwire.NodeAnnouncement:
3✔
2445
                return fmt.Sprintf("node=%x, update_time=%v",
3✔
2446
                        msg.NodeID, time.Unix(int64(msg.Timestamp), 0))
3✔
2447

2448
        case *lnwire.Ping:
×
2449
                return fmt.Sprintf("ping_bytes=%x", msg.PaddingBytes[:])
×
2450

2451
        case *lnwire.Pong:
×
2452
                return fmt.Sprintf("len(pong_bytes)=%d", len(msg.PongBytes[:]))
×
2453

2454
        case *lnwire.UpdateFee:
×
2455
                return fmt.Sprintf("chan_id=%v, fee_update_sat=%v",
×
2456
                        msg.ChanID, int64(msg.FeePerKw))
×
2457

2458
        case *lnwire.ChannelReestablish:
3✔
2459
                return fmt.Sprintf("chan_id=%v, next_local_height=%v, "+
3✔
2460
                        "remote_tail_height=%v", msg.ChanID,
3✔
2461
                        msg.NextLocalCommitHeight, msg.RemoteCommitTailHeight)
3✔
2462

2463
        case *lnwire.ReplyShortChanIDsEnd:
3✔
2464
                return fmt.Sprintf("chain_hash=%v, complete=%v", msg.ChainHash,
3✔
2465
                        msg.Complete)
3✔
2466

2467
        case *lnwire.ReplyChannelRange:
3✔
2468
                return fmt.Sprintf("start_height=%v, end_height=%v, "+
3✔
2469
                        "num_chans=%v, encoding=%v", msg.FirstBlockHeight,
3✔
2470
                        msg.LastBlockHeight(), len(msg.ShortChanIDs),
3✔
2471
                        msg.EncodingType)
3✔
2472

2473
        case *lnwire.QueryShortChanIDs:
3✔
2474
                return fmt.Sprintf("chain_hash=%v, encoding=%v, num_chans=%v",
3✔
2475
                        msg.ChainHash, msg.EncodingType, len(msg.ShortChanIDs))
3✔
2476

2477
        case *lnwire.QueryChannelRange:
3✔
2478
                return fmt.Sprintf("chain_hash=%v, start_height=%v, "+
3✔
2479
                        "end_height=%v", msg.ChainHash, msg.FirstBlockHeight,
3✔
2480
                        msg.LastBlockHeight())
3✔
2481

2482
        case *lnwire.GossipTimestampRange:
3✔
2483
                return fmt.Sprintf("chain_hash=%v, first_stamp=%v, "+
3✔
2484
                        "stamp_range=%v", msg.ChainHash,
3✔
2485
                        time.Unix(int64(msg.FirstTimestamp), 0),
3✔
2486
                        msg.TimestampRange)
3✔
2487

2488
        case *lnwire.Stfu:
3✔
2489
                return fmt.Sprintf("chan_id=%v, initiator=%v", msg.ChanID,
3✔
2490
                        msg.Initiator)
3✔
2491

2492
        case *lnwire.Custom:
3✔
2493
                return fmt.Sprintf("type=%d", msg.Type)
3✔
2494
        }
2495

2496
        return fmt.Sprintf("unknown msg type=%T", msg)
×
2497
}
2498

2499
// logWireMessage logs the receipt or sending of particular wire message. This
2500
// function is used rather than just logging the message in order to produce
2501
// less spammy log messages in trace mode by setting the 'Curve" parameter to
2502
// nil. Doing this avoids printing out each of the field elements in the curve
2503
// parameters for secp256k1.
2504
func (p *Brontide) logWireMessage(msg lnwire.Message, read bool) {
3✔
2505
        summaryPrefix := "Received"
3✔
2506
        if !read {
6✔
2507
                summaryPrefix = "Sending"
3✔
2508
        }
3✔
2509

2510
        p.log.Debugf("%v", lnutils.NewLogClosure(func() string {
6✔
2511
                // Debug summary of message.
3✔
2512
                summary := messageSummary(msg)
3✔
2513
                if len(summary) > 0 {
6✔
2514
                        summary = "(" + summary + ")"
3✔
2515
                }
3✔
2516

2517
                preposition := "to"
3✔
2518
                if read {
6✔
2519
                        preposition = "from"
3✔
2520
                }
3✔
2521

2522
                var msgType string
3✔
2523
                if msg.MsgType() < lnwire.CustomTypeStart {
6✔
2524
                        msgType = msg.MsgType().String()
3✔
2525
                } else {
6✔
2526
                        msgType = "custom"
3✔
2527
                }
3✔
2528

2529
                return fmt.Sprintf("%v %v%s %v %s", summaryPrefix,
3✔
2530
                        msgType, summary, preposition, p)
3✔
2531
        }))
2532

2533
        prefix := "readMessage from peer"
3✔
2534
        if !read {
6✔
2535
                prefix = "writeMessage to peer"
3✔
2536
        }
3✔
2537

2538
        p.log.Tracef(prefix+": %v", lnutils.SpewLogClosure(msg))
3✔
2539
}
2540

2541
// writeMessage writes and flushes the target lnwire.Message to the remote peer.
2542
// If the passed message is nil, this method will only try to flush an existing
2543
// message buffered on the connection. It is safe to call this method again
2544
// with a nil message iff a timeout error is returned. This will continue to
2545
// flush the pending message to the wire.
2546
//
2547
// NOTE:
2548
// Besides its usage in Start, this function should not be used elsewhere
2549
// except in writeHandler. If multiple goroutines call writeMessage at the same
2550
// time, panics can occur because WriteMessage and Flush don't use any locking
2551
// internally.
2552
func (p *Brontide) writeMessage(msg lnwire.Message) error {
3✔
2553
        // Only log the message on the first attempt.
3✔
2554
        if msg != nil {
6✔
2555
                p.logWireMessage(msg, false)
3✔
2556
        }
3✔
2557

2558
        noiseConn := p.cfg.Conn
3✔
2559

3✔
2560
        flushMsg := func() error {
6✔
2561
                // Ensure the write deadline is set before we attempt to send
3✔
2562
                // the message.
3✔
2563
                writeDeadline := time.Now().Add(
3✔
2564
                        p.scaleTimeout(writeMessageTimeout),
3✔
2565
                )
3✔
2566
                err := noiseConn.SetWriteDeadline(writeDeadline)
3✔
2567
                if err != nil {
3✔
2568
                        return err
×
2569
                }
×
2570

2571
                // Flush the pending message to the wire. If an error is
2572
                // encountered, e.g. write timeout, the number of bytes written
2573
                // so far will be returned.
2574
                n, err := noiseConn.Flush()
3✔
2575

3✔
2576
                // Record the number of bytes written on the wire, if any.
3✔
2577
                if n > 0 {
6✔
2578
                        atomic.AddUint64(&p.bytesSent, uint64(n))
3✔
2579
                }
3✔
2580

2581
                return err
3✔
2582
        }
2583

2584
        // If the current message has already been serialized, encrypted, and
2585
        // buffered on the underlying connection we will skip straight to
2586
        // flushing it to the wire.
2587
        if msg == nil {
3✔
2588
                return flushMsg()
×
2589
        }
×
2590

2591
        // Otherwise, this is a new message. We'll acquire a write buffer to
2592
        // serialize the message and buffer the ciphertext on the connection.
2593
        err := p.cfg.WritePool.Submit(func(buf *bytes.Buffer) error {
6✔
2594
                // Using a buffer allocated by the write pool, encode the
3✔
2595
                // message directly into the buffer.
3✔
2596
                _, writeErr := lnwire.WriteMessage(buf, msg, 0)
3✔
2597
                if writeErr != nil {
3✔
2598
                        return writeErr
×
2599
                }
×
2600

2601
                // Finally, write the message itself in a single swoop. This
2602
                // will buffer the ciphertext on the underlying connection. We
2603
                // will defer flushing the message until the write pool has been
2604
                // released.
2605
                return noiseConn.WriteMessage(buf.Bytes())
3✔
2606
        })
2607
        if err != nil {
3✔
2608
                return err
×
2609
        }
×
2610

2611
        return flushMsg()
3✔
2612
}
2613

2614
// writeHandler is a goroutine dedicated to reading messages off of an incoming
2615
// queue, and writing them out to the wire. This goroutine coordinates with the
2616
// queueHandler in order to ensure the incoming message queue is quickly
2617
// drained.
2618
//
2619
// NOTE: This method MUST be run as a goroutine.
2620
func (p *Brontide) writeHandler() {
3✔
2621
        // We'll stop the timer after a new messages is sent, and also reset it
3✔
2622
        // after we process the next message.
3✔
2623
        idleTimer := time.AfterFunc(idleTimeout, func() {
3✔
2624
                err := fmt.Errorf("peer %s no write for %s -- disconnecting",
×
2625
                        p, idleTimeout)
×
2626
                p.Disconnect(err)
×
2627
        })
×
2628

2629
        var exitErr error
3✔
2630

3✔
2631
out:
3✔
2632
        for {
6✔
2633
                select {
3✔
2634
                case outMsg := <-p.sendQueue:
3✔
2635
                        // Record the time at which we first attempt to send the
3✔
2636
                        // message.
3✔
2637
                        startTime := time.Now()
3✔
2638

3✔
2639
                retry:
3✔
2640
                        // Write out the message to the socket. If a timeout
2641
                        // error is encountered, we will catch this and retry
2642
                        // after backing off in case the remote peer is just
2643
                        // slow to process messages from the wire.
2644
                        err := p.writeMessage(outMsg.msg)
3✔
2645
                        if nerr, ok := err.(net.Error); ok && nerr.Timeout() {
3✔
2646
                                p.log.Debugf("Write timeout detected for "+
×
2647
                                        "peer, first write for message "+
×
2648
                                        "attempted %v ago",
×
2649
                                        time.Since(startTime))
×
2650

×
2651
                                // If we received a timeout error, this implies
×
2652
                                // that the message was buffered on the
×
2653
                                // connection successfully and that a flush was
×
2654
                                // attempted. We'll set the message to nil so
×
2655
                                // that on a subsequent pass we only try to
×
2656
                                // flush the buffered message, and forgo
×
2657
                                // reserializing or reencrypting it.
×
2658
                                outMsg.msg = nil
×
2659

×
2660
                                goto retry
×
2661
                        }
2662

2663
                        // The write succeeded, reset the idle timer to prevent
2664
                        // us from disconnecting the peer.
2665
                        if !idleTimer.Stop() {
3✔
2666
                                select {
×
2667
                                case <-idleTimer.C:
×
2668
                                default:
×
2669
                                }
2670
                        }
2671
                        idleTimer.Reset(idleTimeout)
3✔
2672

3✔
2673
                        // If the peer requested a synchronous write, respond
3✔
2674
                        // with the error.
3✔
2675
                        if outMsg.errChan != nil {
6✔
2676
                                outMsg.errChan <- err
3✔
2677
                        }
3✔
2678

2679
                        if err != nil {
3✔
2680
                                exitErr = fmt.Errorf("unable to write "+
×
2681
                                        "message: %v", err)
×
2682
                                break out
×
2683
                        }
2684

2685
                case <-p.cg.Done():
3✔
2686
                        exitErr = lnpeer.ErrPeerExiting
3✔
2687
                        break out
3✔
2688
                }
2689
        }
2690

2691
        // Avoid an exit deadlock by ensuring WaitGroups are decremented before
2692
        // disconnect.
2693
        p.cg.WgDone()
3✔
2694

3✔
2695
        p.Disconnect(exitErr)
3✔
2696

3✔
2697
        p.log.Trace("writeHandler for peer done")
3✔
2698
}
2699

2700
// queueHandler is responsible for accepting messages from outside subsystems
2701
// to be eventually sent out on the wire by the writeHandler.
2702
//
2703
// NOTE: This method MUST be run as a goroutine.
2704
func (p *Brontide) queueHandler() {
3✔
2705
        defer p.cg.WgDone()
3✔
2706

3✔
2707
        // priorityMsgs holds an in order list of messages deemed high-priority
3✔
2708
        // to be added to the sendQueue. This predominately includes messages
3✔
2709
        // from the funding manager and htlcswitch.
3✔
2710
        priorityMsgs := list.New()
3✔
2711

3✔
2712
        // lazyMsgs holds an in order list of messages deemed low-priority to be
3✔
2713
        // added to the sendQueue only after all high-priority messages have
3✔
2714
        // been queued. This predominately includes messages from the gossiper.
3✔
2715
        lazyMsgs := list.New()
3✔
2716

3✔
2717
        for {
6✔
2718
                // Examine the front of the priority queue, if it is empty check
3✔
2719
                // the low priority queue.
3✔
2720
                elem := priorityMsgs.Front()
3✔
2721
                if elem == nil {
6✔
2722
                        elem = lazyMsgs.Front()
3✔
2723
                }
3✔
2724

2725
                if elem != nil {
6✔
2726
                        front := elem.Value.(outgoingMsg)
3✔
2727

3✔
2728
                        // There's an element on the queue, try adding
3✔
2729
                        // it to the sendQueue. We also watch for
3✔
2730
                        // messages on the outgoingQueue, in case the
3✔
2731
                        // writeHandler cannot accept messages on the
3✔
2732
                        // sendQueue.
3✔
2733
                        select {
3✔
2734
                        case p.sendQueue <- front:
3✔
2735
                                if front.priority {
6✔
2736
                                        priorityMsgs.Remove(elem)
3✔
2737
                                } else {
6✔
2738
                                        lazyMsgs.Remove(elem)
3✔
2739
                                }
3✔
2740
                        case msg := <-p.outgoingQueue:
3✔
2741
                                if msg.priority {
6✔
2742
                                        priorityMsgs.PushBack(msg)
3✔
2743
                                } else {
6✔
2744
                                        lazyMsgs.PushBack(msg)
3✔
2745
                                }
3✔
2746
                        case <-p.cg.Done():
×
2747
                                return
×
2748
                        }
2749
                } else {
3✔
2750
                        // If there weren't any messages to send to the
3✔
2751
                        // writeHandler, then we'll accept a new message
3✔
2752
                        // into the queue from outside sub-systems.
3✔
2753
                        select {
3✔
2754
                        case msg := <-p.outgoingQueue:
3✔
2755
                                if msg.priority {
6✔
2756
                                        priorityMsgs.PushBack(msg)
3✔
2757
                                } else {
6✔
2758
                                        lazyMsgs.PushBack(msg)
3✔
2759
                                }
3✔
2760
                        case <-p.cg.Done():
3✔
2761
                                return
3✔
2762
                        }
2763
                }
2764
        }
2765
}
2766

2767
// PingTime returns the estimated ping time to the peer in microseconds.
2768
func (p *Brontide) PingTime() int64 {
3✔
2769
        return p.pingManager.GetPingTimeMicroSeconds()
3✔
2770
}
3✔
2771

2772
// queueMsg adds the lnwire.Message to the back of the high priority send queue.
2773
// If the errChan is non-nil, an error is sent back if the msg failed to queue
2774
// or failed to write, and nil otherwise.
2775
func (p *Brontide) queueMsg(msg lnwire.Message, errChan chan error) {
3✔
2776
        p.queue(true, msg, errChan)
3✔
2777
}
3✔
2778

2779
// queueMsgLazy adds the lnwire.Message to the back of the low priority send
2780
// queue. If the errChan is non-nil, an error is sent back if the msg failed to
2781
// queue or failed to write, and nil otherwise.
2782
func (p *Brontide) queueMsgLazy(msg lnwire.Message, errChan chan error) {
3✔
2783
        p.queue(false, msg, errChan)
3✔
2784
}
3✔
2785

2786
// queue sends a given message to the queueHandler using the passed priority. If
2787
// the errChan is non-nil, an error is sent back if the msg failed to queue or
2788
// failed to write, and nil otherwise.
2789
func (p *Brontide) queue(priority bool, msg lnwire.Message,
2790
        errChan chan error) {
3✔
2791

3✔
2792
        select {
3✔
2793
        case p.outgoingQueue <- outgoingMsg{priority, msg, errChan}:
3✔
2794
        case <-p.cg.Done():
×
2795
                p.log.Tracef("Peer shutting down, could not enqueue msg: %v.",
×
2796
                        spew.Sdump(msg))
×
2797
                if errChan != nil {
×
2798
                        errChan <- lnpeer.ErrPeerExiting
×
2799
                }
×
2800
        }
2801
}
2802

2803
// ChannelSnapshots returns a slice of channel snapshots detailing all
2804
// currently active channels maintained with the remote peer.
2805
func (p *Brontide) ChannelSnapshots() []*channeldb.ChannelSnapshot {
3✔
2806
        snapshots := make(
3✔
2807
                []*channeldb.ChannelSnapshot, 0, p.activeChannels.Len(),
3✔
2808
        )
3✔
2809

3✔
2810
        p.activeChannels.ForEach(func(_ lnwire.ChannelID,
3✔
2811
                activeChan *lnwallet.LightningChannel) error {
6✔
2812

3✔
2813
                // If the activeChan is nil, then we skip it as the channel is
3✔
2814
                // pending.
3✔
2815
                if activeChan == nil {
6✔
2816
                        return nil
3✔
2817
                }
3✔
2818

2819
                // We'll only return a snapshot for channels that are
2820
                // *immediately* available for routing payments over.
2821
                if activeChan.RemoteNextRevocation() == nil {
6✔
2822
                        return nil
3✔
2823
                }
3✔
2824

2825
                snapshot := activeChan.StateSnapshot()
3✔
2826
                snapshots = append(snapshots, snapshot)
3✔
2827

3✔
2828
                return nil
3✔
2829
        })
2830

2831
        return snapshots
3✔
2832
}
2833

2834
// genDeliveryScript returns a new script to be used to send our funds to in
2835
// the case of a cooperative channel close negotiation.
2836
func (p *Brontide) genDeliveryScript() ([]byte, error) {
3✔
2837
        // We'll send a normal p2wkh address unless we've negotiated the
3✔
2838
        // shutdown-any-segwit feature.
3✔
2839
        addrType := lnwallet.WitnessPubKey
3✔
2840
        if p.taprootShutdownAllowed() {
6✔
2841
                addrType = lnwallet.TaprootPubkey
3✔
2842
        }
3✔
2843

2844
        deliveryAddr, err := p.cfg.Wallet.NewAddress(
3✔
2845
                addrType, false, lnwallet.DefaultAccountName,
3✔
2846
        )
3✔
2847
        if err != nil {
3✔
2848
                return nil, err
×
2849
        }
×
2850
        p.log.Infof("Delivery addr for channel close: %v",
3✔
2851
                deliveryAddr)
3✔
2852

3✔
2853
        return txscript.PayToAddrScript(deliveryAddr)
3✔
2854
}
2855

2856
// channelManager is goroutine dedicated to handling all requests/signals
2857
// pertaining to the opening, cooperative closing, and force closing of all
2858
// channels maintained with the remote peer.
2859
//
2860
// NOTE: This method MUST be run as a goroutine.
2861
func (p *Brontide) channelManager() {
3✔
2862
        defer p.cg.WgDone()
3✔
2863

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

3✔
2869
out:
3✔
2870
        for {
6✔
2871
                select {
3✔
2872
                // A new pending channel has arrived which means we are about
2873
                // to complete a funding workflow and is waiting for the final
2874
                // `ChannelReady` messages to be exchanged. We will add this
2875
                // channel to the `activeChannels` with a nil value to indicate
2876
                // this is a pending channel.
2877
                case req := <-p.newPendingChannel:
3✔
2878
                        p.handleNewPendingChannel(req)
3✔
2879

2880
                // A new channel has arrived which means we've just completed a
2881
                // funding workflow. We'll initialize the necessary local
2882
                // state, and notify the htlc switch of a new link.
2883
                case req := <-p.newActiveChannel:
3✔
2884
                        p.handleNewActiveChannel(req)
3✔
2885

2886
                // The funding flow for a pending channel is failed, we will
2887
                // remove it from Brontide.
2888
                case req := <-p.removePendingChannel:
3✔
2889
                        p.handleRemovePendingChannel(req)
3✔
2890

2891
                // We've just received a local request to close an active
2892
                // channel. It will either kick of a cooperative channel
2893
                // closure negotiation, or be a notification of a breached
2894
                // contract that should be abandoned.
2895
                case req := <-p.localCloseChanReqs:
3✔
2896
                        p.handleLocalCloseReq(req)
3✔
2897

2898
                // We've received a link failure from a link that was added to
2899
                // the switch. This will initiate the teardown of the link, and
2900
                // initiate any on-chain closures if necessary.
2901
                case failure := <-p.linkFailures:
3✔
2902
                        p.handleLinkFailure(failure)
3✔
2903

2904
                // We've received a new cooperative channel closure related
2905
                // message from the remote peer, we'll use this message to
2906
                // advance the chan closer state machine.
2907
                case closeMsg := <-p.chanCloseMsgs:
3✔
2908
                        p.handleCloseMsg(closeMsg)
3✔
2909

2910
                // The channel reannounce delay has elapsed, broadcast the
2911
                // reenabled channel updates to the network. This should only
2912
                // fire once, so we set the reenableTimeout channel to nil to
2913
                // mark it for garbage collection. If the peer is torn down
2914
                // before firing, reenabling will not be attempted.
2915
                // TODO(conner): consolidate reenables timers inside chan status
2916
                // manager
2917
                case <-reenableTimeout:
3✔
2918
                        p.reenableActiveChannels()
3✔
2919

3✔
2920
                        // Since this channel will never fire again during the
3✔
2921
                        // lifecycle of the peer, we nil the channel to mark it
3✔
2922
                        // eligible for garbage collection, and make this
3✔
2923
                        // explicitly ineligible to receive in future calls to
3✔
2924
                        // select. This also shaves a few CPU cycles since the
3✔
2925
                        // select will ignore this case entirely.
3✔
2926
                        reenableTimeout = nil
3✔
2927

3✔
2928
                        // Once the reenabling is attempted, we also cancel the
3✔
2929
                        // channel event subscription to free up the overflow
3✔
2930
                        // queue used in channel notifier.
3✔
2931
                        //
3✔
2932
                        // NOTE: channelEventClient will be nil if the
3✔
2933
                        // reenableTimeout is greater than 1 minute.
3✔
2934
                        if p.channelEventClient != nil {
6✔
2935
                                p.channelEventClient.Cancel()
3✔
2936
                        }
3✔
2937

2938
                case <-p.cg.Done():
3✔
2939
                        // As, we've been signalled to exit, we'll reset all
3✔
2940
                        // our active channel back to their default state.
3✔
2941
                        p.activeChannels.ForEach(func(_ lnwire.ChannelID,
3✔
2942
                                lc *lnwallet.LightningChannel) error {
6✔
2943

3✔
2944
                                // Exit if the channel is nil as it's a pending
3✔
2945
                                // channel.
3✔
2946
                                if lc == nil {
6✔
2947
                                        return nil
3✔
2948
                                }
3✔
2949

2950
                                lc.ResetState()
3✔
2951

3✔
2952
                                return nil
3✔
2953
                        })
2954

2955
                        break out
3✔
2956
                }
2957
        }
2958
}
2959

2960
// reenableActiveChannels searches the index of channels maintained with this
2961
// peer, and reenables each public, non-pending channel. This is done at the
2962
// gossip level by broadcasting a new ChannelUpdate with the disabled bit unset.
2963
// No message will be sent if the channel is already enabled.
2964
func (p *Brontide) reenableActiveChannels() {
3✔
2965
        // First, filter all known channels with this peer for ones that are
3✔
2966
        // both public and not pending.
3✔
2967
        activePublicChans := p.filterChannelsToEnable()
3✔
2968

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

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

3✔
2978
                switch {
3✔
2979
                // No error occurred, continue to request the next channel.
2980
                case err == nil:
3✔
2981
                        continue
3✔
2982

2983
                // Cannot auto enable a manually disabled channel so we do
2984
                // nothing but proceed to the next channel.
2985
                case errors.Is(err, netann.ErrEnableManuallyDisabledChan):
3✔
2986
                        p.log.Debugf("Channel(%v) was manually disabled, "+
3✔
2987
                                "ignoring automatic enable request", chanPoint)
3✔
2988

3✔
2989
                        continue
3✔
2990

2991
                // If the channel is reported as inactive, we will give it
2992
                // another chance. When handling the request, ChanStatusManager
2993
                // will check whether the link is active or not. One of the
2994
                // conditions is whether the link has been marked as
2995
                // reestablished, which happens inside a goroutine(htlcManager)
2996
                // after the link is started. And we may get a false negative
2997
                // saying the link is not active because that goroutine hasn't
2998
                // reached the line to mark the reestablishment. Thus we give
2999
                // it a second chance to send the request.
3000
                case errors.Is(err, netann.ErrEnableInactiveChan):
×
3001
                        // If we don't have a client created, it means we
×
3002
                        // shouldn't retry enabling the channel.
×
3003
                        if p.channelEventClient == nil {
×
3004
                                p.log.Errorf("Channel(%v) request enabling "+
×
3005
                                        "failed due to inactive link",
×
3006
                                        chanPoint)
×
3007

×
3008
                                continue
×
3009
                        }
3010

3011
                        p.log.Warnf("Channel(%v) cannot be enabled as " +
×
3012
                                "ChanStatusManager reported inactive, retrying")
×
3013

×
3014
                        // Add the channel to the retry map.
×
3015
                        retryChans[chanPoint] = struct{}{}
×
3016
                }
3017
        }
3018

3019
        // Retry the channels if we have any.
3020
        if len(retryChans) != 0 {
3✔
3021
                p.retryRequestEnable(retryChans)
×
3022
        }
×
3023
}
3024

3025
// fetchActiveChanCloser attempts to fetch the active chan closer state machine
3026
// for the target channel ID. If the channel isn't active an error is returned.
3027
// Otherwise, either an existing state machine will be returned, or a new one
3028
// will be created.
3029
func (p *Brontide) fetchActiveChanCloser(chanID lnwire.ChannelID) (
3030
        *chanCloserFsm, error) {
3✔
3031

3✔
3032
        chanCloser, found := p.activeChanCloses.Load(chanID)
3✔
3033
        if found {
6✔
3034
                // An entry will only be found if the closer has already been
3✔
3035
                // created for a non-pending channel or for a channel that had
3✔
3036
                // previously started the shutdown process but the connection
3✔
3037
                // was restarted.
3✔
3038
                return &chanCloser, nil
3✔
3039
        }
3✔
3040

3041
        // First, we'll ensure that we actually know of the target channel. If
3042
        // not, we'll ignore this message.
3043
        channel, ok := p.activeChannels.Load(chanID)
3✔
3044

3✔
3045
        // If the channel isn't in the map or the channel is nil, return
3✔
3046
        // ErrChannelNotFound as the channel is pending.
3✔
3047
        if !ok || channel == nil {
6✔
3048
                return nil, ErrChannelNotFound
3✔
3049
        }
3✔
3050

3051
        // We'll create a valid closing state machine in order to respond to
3052
        // the initiated cooperative channel closure. First, we set the
3053
        // delivery script that our funds will be paid out to. If an upfront
3054
        // shutdown script was set, we will use it. Otherwise, we get a fresh
3055
        // delivery script.
3056
        //
3057
        // TODO: Expose option to allow upfront shutdown script from watch-only
3058
        // accounts.
3059
        deliveryScript := channel.LocalUpfrontShutdownScript()
3✔
3060
        if len(deliveryScript) == 0 {
6✔
3061
                var err error
3✔
3062
                deliveryScript, err = p.genDeliveryScript()
3✔
3063
                if err != nil {
3✔
3064
                        p.log.Errorf("unable to gen delivery script: %v",
×
3065
                                err)
×
3066
                        return nil, fmt.Errorf("close addr unavailable")
×
3067
                }
×
3068
        }
3069

3070
        // In order to begin fee negotiations, we'll first compute our target
3071
        // ideal fee-per-kw.
3072
        feePerKw, err := p.cfg.FeeEstimator.EstimateFeePerKW(
3✔
3073
                p.cfg.CoopCloseTargetConfs,
3✔
3074
        )
3✔
3075
        if err != nil {
3✔
3076
                p.log.Errorf("unable to query fee estimator: %v", err)
×
3077
                return nil, fmt.Errorf("unable to estimate fee")
×
3078
        }
×
3079

3080
        addr, err := p.addrWithInternalKey(deliveryScript)
3✔
3081
        if err != nil {
3✔
3082
                return nil, fmt.Errorf("unable to parse addr: %w", err)
×
3083
        }
×
3084
        negotiateChanCloser, err := p.createChanCloser(
3✔
3085
                channel, addr, feePerKw, nil, lntypes.Remote,
3✔
3086
        )
3✔
3087
        if err != nil {
3✔
3088
                p.log.Errorf("unable to create chan closer: %v", err)
×
3089
                return nil, fmt.Errorf("unable to create chan closer")
×
3090
        }
×
3091

3092
        chanCloser = makeNegotiateCloser(negotiateChanCloser)
3✔
3093

3✔
3094
        p.activeChanCloses.Store(chanID, chanCloser)
3✔
3095

3✔
3096
        return &chanCloser, nil
3✔
3097
}
3098

3099
// filterChannelsToEnable filters a list of channels to be enabled upon start.
3100
// The filtered channels are active channels that's neither private nor
3101
// pending.
3102
func (p *Brontide) filterChannelsToEnable() []wire.OutPoint {
3✔
3103
        var activePublicChans []wire.OutPoint
3✔
3104

3✔
3105
        p.activeChannels.Range(func(chanID lnwire.ChannelID,
3✔
3106
                lnChan *lnwallet.LightningChannel) bool {
6✔
3107

3✔
3108
                // If the lnChan is nil, continue as this is a pending channel.
3✔
3109
                if lnChan == nil {
6✔
3110
                        return true
3✔
3111
                }
3✔
3112

3113
                dbChan := lnChan.State()
3✔
3114
                isPublic := dbChan.ChannelFlags&lnwire.FFAnnounceChannel != 0
3✔
3115
                if !isPublic || dbChan.IsPending {
3✔
3116
                        return true
×
3117
                }
×
3118

3119
                // We'll also skip any channels added during this peer's
3120
                // lifecycle since they haven't waited out the timeout. Their
3121
                // first announcement will be enabled, and the chan status
3122
                // manager will begin monitoring them passively since they exist
3123
                // in the database.
3124
                if _, ok := p.addedChannels.Load(chanID); ok {
3✔
3125
                        return true
×
3126
                }
×
3127

3128
                activePublicChans = append(
3✔
3129
                        activePublicChans, dbChan.FundingOutpoint,
3✔
3130
                )
3✔
3131

3✔
3132
                return true
3✔
3133
        })
3134

3135
        return activePublicChans
3✔
3136
}
3137

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

×
3145
        // retryEnable is a helper closure that sends an enable request and
×
3146
        // removes the channel from the map if it's matched.
×
3147
        retryEnable := func(chanPoint wire.OutPoint) error {
×
3148
                // If this is an active channel event, check whether it's in
×
3149
                // our targeted channels map.
×
3150
                _, found := activeChans[chanPoint]
×
3151

×
3152
                // If this channel is irrelevant, return nil so the loop can
×
3153
                // jump to next iteration.
×
3154
                if !found {
×
3155
                        return nil
×
3156
                }
×
3157

3158
                // Otherwise we've just received an active signal for a channel
3159
                // that's previously failed to be enabled, we send the request
3160
                // again.
3161
                //
3162
                // We only give the channel one more shot, so we delete it from
3163
                // our map first to keep it from being attempted again.
3164
                delete(activeChans, chanPoint)
×
3165

×
3166
                // Send the request.
×
3167
                err := p.cfg.ChanStatusMgr.RequestEnable(chanPoint, false)
×
3168
                if err != nil {
×
3169
                        return fmt.Errorf("request enabling channel %v "+
×
3170
                                "failed: %w", chanPoint, err)
×
3171
                }
×
3172

3173
                return nil
×
3174
        }
3175

3176
        for {
×
3177
                // If activeChans is empty, we've done processing all the
×
3178
                // channels.
×
3179
                if len(activeChans) == 0 {
×
3180
                        p.log.Debug("Finished retry enabling channels")
×
3181
                        return
×
3182
                }
×
3183

3184
                select {
×
3185
                // A new event has been sent by the ChannelNotifier. We now
3186
                // check whether it's an active or inactive channel event.
3187
                case e := <-p.channelEventClient.Updates():
×
3188
                        // If this is an active channel event, try enable the
×
3189
                        // channel then jump to the next iteration.
×
3190
                        active, ok := e.(channelnotifier.ActiveChannelEvent)
×
3191
                        if ok {
×
3192
                                chanPoint := *active.ChannelPoint
×
3193

×
3194
                                // If we received an error for this particular
×
3195
                                // channel, we log an error and won't quit as
×
3196
                                // we still want to retry other channels.
×
3197
                                if err := retryEnable(chanPoint); err != nil {
×
3198
                                        p.log.Errorf("Retry failed: %v", err)
×
3199
                                }
×
3200

3201
                                continue
×
3202
                        }
3203

3204
                        // Otherwise check for inactive link event, and jump to
3205
                        // next iteration if it's not.
3206
                        inactive, ok := e.(channelnotifier.InactiveLinkEvent)
×
3207
                        if !ok {
×
3208
                                continue
×
3209
                        }
3210

3211
                        // Found an inactive link event, if this is our
3212
                        // targeted channel, remove it from our map.
3213
                        chanPoint := *inactive.ChannelPoint
×
3214
                        _, found := activeChans[chanPoint]
×
3215
                        if !found {
×
3216
                                continue
×
3217
                        }
3218

3219
                        delete(activeChans, chanPoint)
×
3220
                        p.log.Warnf("Re-enable channel %v failed, received "+
×
3221
                                "inactive link event", chanPoint)
×
3222

3223
                case <-p.cg.Done():
×
3224
                        p.log.Debugf("Peer shutdown during retry enabling")
×
3225
                        return
×
3226
                }
3227
        }
3228
}
3229

3230
// chooseDeliveryScript takes two optionally set shutdown scripts and returns
3231
// a suitable script to close out to. This may be nil if neither script is
3232
// set. If both scripts are set, this function will error if they do not match.
3233
func chooseDeliveryScript(upfront, requested lnwire.DeliveryAddress,
3234
        genDeliveryScript func() ([]byte, error),
3235
) (lnwire.DeliveryAddress, error) {
3✔
3236

3✔
3237
        switch {
3✔
3238
        // If no script was provided, then we'll generate a new delivery script.
3239
        case len(upfront) == 0 && len(requested) == 0:
3✔
3240
                return genDeliveryScript()
3✔
3241

3242
        // If no upfront shutdown script was provided, return the user
3243
        // requested address (which may be nil).
3244
        case len(upfront) == 0:
3✔
3245
                return requested, nil
3✔
3246

3247
        // If an upfront shutdown script was provided, and the user did not
3248
        // request a custom shutdown script, return the upfront address.
3249
        case len(requested) == 0:
3✔
3250
                return upfront, nil
3✔
3251

3252
        // If both an upfront shutdown script and a custom close script were
3253
        // provided, error if the user provided shutdown script does not match
3254
        // the upfront shutdown script (because closing out to a different
3255
        // script would violate upfront shutdown).
3256
        case !bytes.Equal(upfront, requested):
×
3257
                return nil, chancloser.ErrUpfrontShutdownScriptMismatch
×
3258

3259
        // The user requested script matches the upfront shutdown script, so we
3260
        // can return it without error.
3261
        default:
×
3262
                return upfront, nil
×
3263
        }
3264
}
3265

3266
// restartCoopClose checks whether we need to restart the cooperative close
3267
// process for a given channel.
3268
func (p *Brontide) restartCoopClose(lnChan *lnwallet.LightningChannel) (
3269
        *lnwire.Shutdown, error) {
3✔
3270

3✔
3271
        // If this channel has status ChanStatusCoopBroadcasted and does not
3✔
3272
        // have a closing transaction, then the cooperative close process was
3✔
3273
        // started but never finished. We'll re-create the chanCloser state
3✔
3274
        // machine and resend Shutdown. BOLT#2 requires that we retransmit
3✔
3275
        // Shutdown exactly, but doing so would mean persisting the RPC
3✔
3276
        // provided close script. Instead use the LocalUpfrontShutdownScript
3✔
3277
        // or generate a script.
3✔
3278
        c := lnChan.State()
3✔
3279
        _, err := c.BroadcastedCooperative()
3✔
3280
        if err != nil && err != channeldb.ErrNoCloseTx {
3✔
3281
                // An error other than ErrNoCloseTx was encountered.
×
3282
                return nil, err
×
3283
        } else if err == nil && !p.rbfCoopCloseAllowed() {
3✔
3284
                // This is a channel that doesn't support RBF coop close, and it
×
3285
                // already had a coop close txn broadcast. As a result, we can
×
3286
                // just exit here as all we can do is wait for it to confirm.
×
3287
                return nil, nil
×
3288
        }
×
3289

3290
        chanID := lnwire.NewChanIDFromOutPoint(c.FundingOutpoint)
3✔
3291

3✔
3292
        var deliveryScript []byte
3✔
3293

3✔
3294
        shutdownInfo, err := c.ShutdownInfo()
3✔
3295
        switch {
3✔
3296
        // We have previously stored the delivery script that we need to use
3297
        // in the shutdown message. Re-use this script.
3298
        case err == nil:
3✔
3299
                shutdownInfo.WhenSome(func(info channeldb.ShutdownInfo) {
6✔
3300
                        deliveryScript = info.DeliveryScript.Val
3✔
3301
                })
3✔
3302

3303
        // An error other than ErrNoShutdownInfo was returned
3304
        case !errors.Is(err, channeldb.ErrNoShutdownInfo):
×
3305
                return nil, err
×
3306

3307
        case errors.Is(err, channeldb.ErrNoShutdownInfo):
×
3308
                deliveryScript = c.LocalShutdownScript
×
3309
                if len(deliveryScript) == 0 {
×
3310
                        var err error
×
3311
                        deliveryScript, err = p.genDeliveryScript()
×
3312
                        if err != nil {
×
3313
                                p.log.Errorf("unable to gen delivery script: "+
×
3314
                                        "%v", err)
×
3315

×
3316
                                return nil, fmt.Errorf("close addr unavailable")
×
3317
                        }
×
3318
                }
3319
        }
3320

3321
        // If the new RBF co-op close is negotiated, then we'll init and start
3322
        // that state machine, skipping the steps for the negotiate machine
3323
        // below.
3324
        if p.rbfCoopCloseAllowed() {
6✔
3325
                _, err := p.initRbfChanCloser(lnChan)
3✔
3326
                if err != nil {
3✔
3327
                        return nil, fmt.Errorf("unable to init rbf chan "+
×
3328
                                "closer during restart: %w", err)
×
3329
                }
×
3330

3331
                shutdownDesc := fn.MapOption(
3✔
3332
                        newRestartShutdownInit,
3✔
3333
                )(shutdownInfo)
3✔
3334

3✔
3335
                err = p.startRbfChanCloser(
3✔
3336
                        fn.FlattenOption(shutdownDesc), lnChan.ChannelPoint(),
3✔
3337
                )
3✔
3338

3✔
3339
                return nil, err
3✔
3340
        }
3341

3342
        // Compute an ideal fee.
3343
        feePerKw, err := p.cfg.FeeEstimator.EstimateFeePerKW(
×
3344
                p.cfg.CoopCloseTargetConfs,
×
3345
        )
×
3346
        if err != nil {
×
3347
                p.log.Errorf("unable to query fee estimator: %v", err)
×
3348
                return nil, fmt.Errorf("unable to estimate fee")
×
3349
        }
×
3350

3351
        // Determine whether we or the peer are the initiator of the coop
3352
        // close attempt by looking at the channel's status.
3353
        closingParty := lntypes.Remote
×
3354
        if c.HasChanStatus(channeldb.ChanStatusLocalCloseInitiator) {
×
3355
                closingParty = lntypes.Local
×
3356
        }
×
3357

3358
        addr, err := p.addrWithInternalKey(deliveryScript)
×
3359
        if err != nil {
×
3360
                return nil, fmt.Errorf("unable to parse addr: %w", err)
×
3361
        }
×
3362
        chanCloser, err := p.createChanCloser(
×
3363
                lnChan, addr, feePerKw, nil, closingParty,
×
3364
        )
×
3365
        if err != nil {
×
3366
                p.log.Errorf("unable to create chan closer: %v", err)
×
3367
                return nil, fmt.Errorf("unable to create chan closer")
×
3368
        }
×
3369

3370
        p.activeChanCloses.Store(chanID, makeNegotiateCloser(chanCloser))
×
3371

×
3372
        // Create the Shutdown message.
×
3373
        shutdownMsg, err := chanCloser.ShutdownChan()
×
3374
        if err != nil {
×
3375
                p.log.Errorf("unable to create shutdown message: %v", err)
×
3376
                p.activeChanCloses.Delete(chanID)
×
3377
                return nil, err
×
3378
        }
×
3379

3380
        return shutdownMsg, nil
×
3381
}
3382

3383
// createChanCloser constructs a ChanCloser from the passed parameters and is
3384
// used to de-duplicate code.
3385
func (p *Brontide) createChanCloser(channel *lnwallet.LightningChannel,
3386
        deliveryScript *chancloser.DeliveryAddrWithKey,
3387
        fee chainfee.SatPerKWeight, req *htlcswitch.ChanClose,
3388
        closer lntypes.ChannelParty) (*chancloser.ChanCloser, error) {
3✔
3389

3✔
3390
        _, startingHeight, err := p.cfg.ChainIO.GetBestBlock()
3✔
3391
        if err != nil {
3✔
3392
                p.log.Errorf("unable to obtain best block: %v", err)
×
3393
                return nil, fmt.Errorf("cannot obtain best block")
×
3394
        }
×
3395

3396
        // The req will only be set if we initiated the co-op closing flow.
3397
        var maxFee chainfee.SatPerKWeight
3✔
3398
        if req != nil {
6✔
3399
                maxFee = req.MaxFee
3✔
3400
        }
3✔
3401

3402
        chanCloser := chancloser.NewChanCloser(
3✔
3403
                chancloser.ChanCloseCfg{
3✔
3404
                        Channel:      channel,
3✔
3405
                        MusigSession: NewMusigChanCloser(channel),
3✔
3406
                        FeeEstimator: &chancloser.SimpleCoopFeeEstimator{},
3✔
3407
                        BroadcastTx:  p.cfg.Wallet.PublishTransaction,
3✔
3408
                        AuxCloser:    p.cfg.AuxChanCloser,
3✔
3409
                        DisableChannel: func(op wire.OutPoint) error {
6✔
3410
                                return p.cfg.ChanStatusMgr.RequestDisable(
3✔
3411
                                        op, false,
3✔
3412
                                )
3✔
3413
                        },
3✔
3414
                        MaxFee: maxFee,
3415
                        Disconnect: func() error {
×
3416
                                return p.cfg.DisconnectPeer(p.IdentityKey())
×
3417
                        },
×
3418
                        ChainParams: &p.cfg.Wallet.Cfg.NetParams,
3419
                },
3420
                *deliveryScript,
3421
                fee,
3422
                uint32(startingHeight),
3423
                req,
3424
                closer,
3425
        )
3426

3427
        return chanCloser, nil
3✔
3428
}
3429

3430
// initNegotiateChanCloser initializes the channel closer for a channel that is
3431
// using the original "negotiation" based protocol. This path is used when
3432
// we're the one initiating the channel close.
3433
//
3434
// TODO(roasbeef): can make a MsgEndpoint for existing handling logic to
3435
// further abstract.
3436
func (p *Brontide) initNegotiateChanCloser(req *htlcswitch.ChanClose,
3437
        channel *lnwallet.LightningChannel) error {
3✔
3438

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

3✔
3442
        // An upfront shutdown and user provided script are both optional, but
3✔
3443
        // must be equal if both set  (because we cannot serve a request to
3✔
3444
        // close out to a script which violates upfront shutdown). Get the
3✔
3445
        // appropriate address to close out to (which may be nil if neither are
3✔
3446
        // set) and error if they are both set and do not match.
3✔
3447
        deliveryScript, err := chooseDeliveryScript(
3✔
3448
                channel.LocalUpfrontShutdownScript(), req.DeliveryScript,
3✔
3449
                p.genDeliveryScript,
3✔
3450
        )
3✔
3451
        if err != nil {
3✔
3452
                return fmt.Errorf("cannot close channel %v: %w",
×
3453
                        req.ChanPoint, err)
×
3454
        }
×
3455

3456
        addr, err := p.addrWithInternalKey(deliveryScript)
3✔
3457
        if err != nil {
3✔
3458
                return fmt.Errorf("unable to parse addr for channel "+
×
3459
                        "%v: %w", req.ChanPoint, err)
×
3460
        }
×
3461

3462
        chanCloser, err := p.createChanCloser(
3✔
3463
                channel, addr, req.TargetFeePerKw, req, lntypes.Local,
3✔
3464
        )
3✔
3465
        if err != nil {
3✔
3466
                return fmt.Errorf("unable to make chan closer: %w", err)
×
3467
        }
×
3468

3469
        chanID := lnwire.NewChanIDFromOutPoint(channel.ChannelPoint())
3✔
3470
        p.activeChanCloses.Store(chanID, makeNegotiateCloser(chanCloser))
3✔
3471

3✔
3472
        // Finally, we'll initiate the channel shutdown within the
3✔
3473
        // chanCloser, and send the shutdown message to the remote
3✔
3474
        // party to kick things off.
3✔
3475
        shutdownMsg, err := chanCloser.ShutdownChan()
3✔
3476
        if err != nil {
3✔
3477
                // As we were unable to shutdown the channel, we'll return it
×
3478
                // back to its normal state.
×
3479
                defer channel.ResetState()
×
3480

×
3481
                p.activeChanCloses.Delete(chanID)
×
3482

×
3483
                return fmt.Errorf("unable to shutdown channel: %w", err)
×
3484
        }
×
3485

3486
        link := p.fetchLinkFromKeyAndCid(chanID)
3✔
3487
        if link == nil {
3✔
3488
                // If the link is nil then it means it was already removed from
×
3489
                // the switch or it never existed in the first place. The
×
3490
                // latter case is handled at the beginning of this function, so
×
3491
                // in the case where it has already been removed, we can skip
×
3492
                // adding the commit hook to queue a Shutdown message.
×
3493
                p.log.Warnf("link not found during attempted closure: "+
×
3494
                        "%v", chanID)
×
3495
                return nil
×
3496
        }
×
3497

3498
        if !link.DisableAdds(htlcswitch.Outgoing) {
3✔
3499
                p.log.Warnf("Outgoing link adds already "+
×
3500
                        "disabled: %v", link.ChanID())
×
3501
        }
×
3502

3503
        link.OnCommitOnce(htlcswitch.Outgoing, func() {
6✔
3504
                p.queueMsg(shutdownMsg, nil)
3✔
3505
        })
3✔
3506

3507
        return nil
3✔
3508
}
3509

3510
// chooseAddr returns the provided address if it is non-zero length, otherwise
3511
// None.
3512
func chooseAddr(addr lnwire.DeliveryAddress) fn.Option[lnwire.DeliveryAddress] {
3✔
3513
        if len(addr) == 0 {
6✔
3514
                return fn.None[lnwire.DeliveryAddress]()
3✔
3515
        }
3✔
3516

3517
        return fn.Some(addr)
×
3518
}
3519

3520
// observeRbfCloseUpdates observes the channel for any updates that may
3521
// indicate that a new txid has been broadcasted, or the channel fully closed
3522
// on chain.
3523
func (p *Brontide) observeRbfCloseUpdates(chanCloser *chancloser.RbfChanCloser,
3524
        closeReq *htlcswitch.ChanClose,
3525
        coopCloseStates chancloser.RbfStateSub) {
3✔
3526

3✔
3527
        newStateChan := coopCloseStates.NewItemCreated.ChanOut()
3✔
3528
        defer chanCloser.RemoveStateSub(coopCloseStates)
3✔
3529

3✔
3530
        var (
3✔
3531
                lastTxids    lntypes.Dual[chainhash.Hash]
3✔
3532
                lastFeeRates lntypes.Dual[chainfee.SatPerVByte]
3✔
3533
        )
3✔
3534

3✔
3535
        maybeNotifyTxBroadcast := func(state chancloser.AsymmetricPeerState,
3✔
3536
                party lntypes.ChannelParty) {
6✔
3537

3✔
3538
                // First, check to see if we have an error to report to the
3✔
3539
                // caller. If so, then we''ll return that error and exit, as the
3✔
3540
                // stream will exit as well.
3✔
3541
                if closeErr, ok := state.(*chancloser.CloseErr); ok {
6✔
3542
                        // We hit an error during the last state transition, so
3✔
3543
                        // we'll extract the error then send it to the
3✔
3544
                        // user.
3✔
3545
                        err := closeErr.Err()
3✔
3546

3✔
3547
                        peerLog.Warnf("ChannelPoint(%v): encountered close "+
3✔
3548
                                "err: %v", closeReq.ChanPoint, err)
3✔
3549

3✔
3550
                        select {
3✔
3551
                        case closeReq.Err <- err:
3✔
3552
                        case <-closeReq.Ctx.Done():
×
3553
                        case <-p.cg.Done():
×
3554
                        }
3555

3556
                        return
3✔
3557
                }
3558

3559
                closePending, ok := state.(*chancloser.ClosePending)
3✔
3560

3✔
3561
                // If this isn't the close pending state, we aren't at the
3✔
3562
                // terminal state yet.
3✔
3563
                if !ok {
6✔
3564
                        return
3✔
3565
                }
3✔
3566

3567
                // Only notify if the fee rate is greater.
3568
                newFeeRate := closePending.FeeRate
3✔
3569
                lastFeeRate := lastFeeRates.GetForParty(party)
3✔
3570
                if newFeeRate <= lastFeeRate {
6✔
3571
                        peerLog.Debugf("ChannelPoint(%v): remote party made "+
3✔
3572
                                "update for fee rate %v, but we already have "+
3✔
3573
                                "a higher fee rate of %v", closeReq.ChanPoint,
3✔
3574
                                newFeeRate, lastFeeRate)
3✔
3575

3✔
3576
                        return
3✔
3577
                }
3✔
3578

3579
                feeRate := closePending.FeeRate
3✔
3580
                lastFeeRates.SetForParty(party, feeRate)
3✔
3581

3✔
3582
                // At this point, we'll have a txid that we can use to notify
3✔
3583
                // the client, but only if it's different from the last one we
3✔
3584
                // sent. If the user attempted to bump, but was rejected due to
3✔
3585
                // RBF, then we'll send a redundant update.
3✔
3586
                closingTxid := closePending.CloseTx.TxHash()
3✔
3587
                lastTxid := lastTxids.GetForParty(party)
3✔
3588
                if closeReq != nil && closingTxid != lastTxid {
6✔
3589
                        select {
3✔
3590
                        case closeReq.Updates <- &PendingUpdate{
3591
                                Txid:        closingTxid[:],
3592
                                FeePerVbyte: fn.Some(closePending.FeeRate),
3593
                                IsLocalCloseTx: fn.Some(
3594
                                        party == lntypes.Local,
3595
                                ),
3596
                        }:
3✔
3597

3598
                        case <-closeReq.Ctx.Done():
×
3599
                                return
×
3600

3601
                        case <-p.cg.Done():
×
3602
                                return
×
3603
                        }
3604
                }
3605

3606
                lastTxids.SetForParty(party, closingTxid)
3✔
3607
        }
3608

3609
        peerLog.Infof("Observing RBF close updates for channel %v",
3✔
3610
                closeReq.ChanPoint)
3✔
3611

3✔
3612
        // We'll consume each new incoming state to send out the appropriate
3✔
3613
        // RPC update.
3✔
3614
        for {
6✔
3615
                select {
3✔
3616
                case newState := <-newStateChan:
3✔
3617

3✔
3618
                        switch closeState := newState.(type) {
3✔
3619
                        // Once we've reached the state of pending close, we
3620
                        // have a txid that we broadcasted.
3621
                        case *chancloser.ClosingNegotiation:
3✔
3622
                                peerState := closeState.PeerState
3✔
3623

3✔
3624
                                // Each side may have gained a new co-op close
3✔
3625
                                // tx, so we'll examine both to see if they've
3✔
3626
                                // changed.
3✔
3627
                                maybeNotifyTxBroadcast(
3✔
3628
                                        peerState.GetForParty(lntypes.Local),
3✔
3629
                                        lntypes.Local,
3✔
3630
                                )
3✔
3631
                                maybeNotifyTxBroadcast(
3✔
3632
                                        peerState.GetForParty(lntypes.Remote),
3✔
3633
                                        lntypes.Remote,
3✔
3634
                                )
3✔
3635

3636
                        // Otherwise, if we're transition to CloseFin, then we
3637
                        // know that we're done.
3638
                        case *chancloser.CloseFin:
3✔
3639
                                // To clean up, we'll remove the chan closer
3✔
3640
                                // from the active map, and send the final
3✔
3641
                                // update to the client.
3✔
3642
                                closingTxid := closeState.ConfirmedTx.TxHash()
3✔
3643
                                if closeReq != nil {
6✔
3644
                                        closeReq.Updates <- &ChannelCloseUpdate{
3✔
3645
                                                ClosingTxid: closingTxid[:],
3✔
3646
                                                Success:     true,
3✔
3647
                                        }
3✔
3648
                                }
3✔
3649
                                chanID := lnwire.NewChanIDFromOutPoint(
3✔
3650
                                        *closeReq.ChanPoint,
3✔
3651
                                )
3✔
3652
                                p.activeChanCloses.Delete(chanID)
3✔
3653

3✔
3654
                                return
3✔
3655
                        }
3656

3657
                case <-closeReq.Ctx.Done():
3✔
3658
                        return
3✔
3659

3660
                case <-p.cg.Done():
3✔
3661
                        return
3✔
3662
                }
3663
        }
3664
}
3665

3666
// chanErrorReporter is a simple implementation of the
3667
// chancloser.ErrorReporter. This is bound to a single channel by the channel
3668
// ID.
3669
type chanErrorReporter struct {
3670
        chanID lnwire.ChannelID
3671
        peer   *Brontide
3672
}
3673

3674
// newChanErrorReporter creates a new instance of the chanErrorReporter.
3675
func newChanErrorReporter(chanID lnwire.ChannelID,
3676
        peer *Brontide) *chanErrorReporter {
3✔
3677

3✔
3678
        return &chanErrorReporter{
3✔
3679
                chanID: chanID,
3✔
3680
                peer:   peer,
3✔
3681
        }
3✔
3682
}
3✔
3683

3684
// ReportError is a method that's used to report an error that occurred during
3685
// state machine execution. This is used by the RBF close state machine to
3686
// terminate the state machine and send an error to the remote peer.
3687
//
3688
// This is a part of the chancloser.ErrorReporter interface.
3689
func (c *chanErrorReporter) ReportError(chanErr error) {
×
3690
        c.peer.log.Errorf("coop close error for channel %v: %v",
×
3691
                c.chanID, chanErr)
×
3692

×
3693
        var errMsg []byte
×
3694
        if errors.Is(chanErr, chancloser.ErrInvalidStateTransition) {
×
3695
                errMsg = []byte("unexpected protocol message")
×
3696
        } else {
×
3697
                errMsg = []byte(chanErr.Error())
×
3698
        }
×
3699

3700
        err := c.peer.SendMessageLazy(false, &lnwire.Error{
×
3701
                ChanID: c.chanID,
×
3702
                Data:   errMsg,
×
3703
        })
×
3704
        if err != nil {
×
3705
                c.peer.log.Warnf("unable to send error message to peer: %v",
×
3706
                        err)
×
3707
        }
×
3708

3709
        // After we send the error message to the peer, we'll re-initialize the
3710
        // coop close state machine as they may send a shutdown message to
3711
        // retry the coop close.
3712
        lnChan, ok := c.peer.activeChannels.Load(c.chanID)
×
3713
        if !ok {
×
3714
                return
×
3715
        }
×
3716

3717
        if lnChan == nil {
×
3718
                c.peer.log.Debugf("channel %v is pending, not "+
×
3719
                        "re-initializing coop close state machine",
×
3720
                        c.chanID)
×
3721

×
3722
                return
×
3723
        }
×
3724

3725
        if _, err := c.peer.initRbfChanCloser(lnChan); err != nil {
×
3726
                c.peer.activeChanCloses.Delete(c.chanID)
×
3727

×
3728
                c.peer.log.Errorf("unable to init RBF chan closer after "+
×
3729
                        "error case: %v", err)
×
3730
        }
×
3731
}
3732

3733
// chanFlushEventSentinel is used to send the RBF coop close state machine the
3734
// channel flushed event. We'll wait until the state machine enters the
3735
// ChannelFlushing state, then request the link to send the event once flushed.
3736
//
3737
// NOTE: This MUST be run as a goroutine.
3738
func (p *Brontide) chanFlushEventSentinel(chanCloser *chancloser.RbfChanCloser,
3739
        link htlcswitch.ChannelUpdateHandler,
3740
        channel *lnwallet.LightningChannel) {
3✔
3741

3✔
3742
        defer p.cg.WgDone()
3✔
3743

3✔
3744
        // If there's no link, then the channel has already been flushed, so we
3✔
3745
        // don't need to continue.
3✔
3746
        if link == nil {
6✔
3747
                return
3✔
3748
        }
3✔
3749

3750
        coopCloseStates := chanCloser.RegisterStateEvents()
3✔
3751
        defer chanCloser.RemoveStateSub(coopCloseStates)
3✔
3752

3✔
3753
        newStateChan := coopCloseStates.NewItemCreated.ChanOut()
3✔
3754

3✔
3755
        sendChanFlushed := func() {
6✔
3756
                chanState := channel.StateSnapshot()
3✔
3757

3✔
3758
                peerLog.Infof("ChannelPoint(%v) has been flushed for co-op "+
3✔
3759
                        "close, sending event to chan closer",
3✔
3760
                        channel.ChannelPoint())
3✔
3761

3✔
3762
                chanBalances := chancloser.ShutdownBalances{
3✔
3763
                        LocalBalance:  chanState.LocalBalance,
3✔
3764
                        RemoteBalance: chanState.RemoteBalance,
3✔
3765
                }
3✔
3766
                ctx := context.Background()
3✔
3767
                chanCloser.SendEvent(ctx, &chancloser.ChannelFlushed{
3✔
3768
                        ShutdownBalances: chanBalances,
3✔
3769
                        FreshFlush:       true,
3✔
3770
                })
3✔
3771
        }
3✔
3772

3773
        // We'll wait until the channel enters the ChannelFlushing state. We
3774
        // exit after a success loop. As after the first RBF iteration, the
3775
        // channel will always be flushed.
3776
        for newState := range newStateChan {
6✔
3777
                if _, ok := newState.(*chancloser.ChannelFlushing); ok {
6✔
3778
                        peerLog.Infof("ChannelPoint(%v): rbf coop "+
3✔
3779
                                "close is awaiting a flushed state, "+
3✔
3780
                                "registering with link..., ",
3✔
3781
                                channel.ChannelPoint())
3✔
3782

3✔
3783
                        // Request the link to send the event once the channel
3✔
3784
                        // is flushed. We only need this event sent once, so we
3✔
3785
                        // can exit now.
3✔
3786
                        link.OnFlushedOnce(sendChanFlushed)
3✔
3787

3✔
3788
                        return
3✔
3789
                }
3✔
3790
        }
3791
}
3792

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

3✔
3799
        chanID := lnwire.NewChanIDFromOutPoint(channel.ChannelPoint())
3✔
3800

3✔
3801
        link := p.fetchLinkFromKeyAndCid(chanID)
3✔
3802

3✔
3803
        _, startingHeight, err := p.cfg.ChainIO.GetBestBlock()
3✔
3804
        if err != nil {
3✔
3805
                return nil, fmt.Errorf("cannot obtain best block: %w", err)
×
3806
        }
×
3807

3808
        defaultFeePerKw, err := p.cfg.FeeEstimator.EstimateFeePerKW(
3✔
3809
                p.cfg.CoopCloseTargetConfs,
3✔
3810
        )
3✔
3811
        if err != nil {
3✔
3812
                return nil, fmt.Errorf("unable to estimate fee: %w", err)
×
3813
        }
×
3814

3815
        thawHeight, err := channel.AbsoluteThawHeight()
3✔
3816
        if err != nil {
3✔
3817
                return nil, fmt.Errorf("unable to get thaw height: %w", err)
×
3818
        }
×
3819

3820
        peerPub := *p.IdentityKey()
3✔
3821

3✔
3822
        msgMapper := chancloser.NewRbfMsgMapper(
3✔
3823
                uint32(startingHeight), chanID, peerPub,
3✔
3824
        )
3✔
3825

3✔
3826
        initialState := chancloser.ChannelActive{}
3✔
3827

3✔
3828
        scid := channel.ZeroConfRealScid().UnwrapOr(
3✔
3829
                channel.ShortChanID(),
3✔
3830
        )
3✔
3831

3✔
3832
        env := chancloser.Environment{
3✔
3833
                ChainParams:    p.cfg.Wallet.Cfg.NetParams,
3✔
3834
                ChanPeer:       peerPub,
3✔
3835
                ChanPoint:      channel.ChannelPoint(),
3✔
3836
                ChanID:         chanID,
3✔
3837
                Scid:           scid,
3✔
3838
                ChanType:       channel.ChanType(),
3✔
3839
                DefaultFeeRate: defaultFeePerKw.FeePerVByte(),
3✔
3840
                ThawHeight:     fn.Some(thawHeight),
3✔
3841
                RemoteUpfrontShutdown: chooseAddr(
3✔
3842
                        channel.RemoteUpfrontShutdownScript(),
3✔
3843
                ),
3✔
3844
                LocalUpfrontShutdown: chooseAddr(
3✔
3845
                        channel.LocalUpfrontShutdownScript(),
3✔
3846
                ),
3✔
3847
                NewDeliveryScript: func() (lnwire.DeliveryAddress, error) {
6✔
3848
                        return p.genDeliveryScript()
3✔
3849
                },
3✔
3850
                FeeEstimator: &chancloser.SimpleCoopFeeEstimator{},
3851
                CloseSigner:  channel,
3852
                ChanObserver: newChanObserver(
3853
                        channel, link, p.cfg.ChanStatusMgr,
3854
                ),
3855
        }
3856

3857
        spendEvent := protofsm.RegisterSpend[chancloser.ProtocolEvent]{
3✔
3858
                OutPoint:   channel.ChannelPoint(),
3✔
3859
                PkScript:   channel.FundingTxOut().PkScript,
3✔
3860
                HeightHint: channel.DeriveHeightHint(),
3✔
3861
                PostSpendEvent: fn.Some[chancloser.RbfSpendMapper](
3✔
3862
                        chancloser.SpendMapper,
3✔
3863
                ),
3✔
3864
        }
3✔
3865

3✔
3866
        daemonAdapters := NewLndDaemonAdapters(LndAdapterCfg{
3✔
3867
                MsgSender:     newPeerMsgSender(peerPub, p),
3✔
3868
                TxBroadcaster: p.cfg.Wallet,
3✔
3869
                ChainNotifier: p.cfg.ChainNotifier,
3✔
3870
        })
3✔
3871

3✔
3872
        protoCfg := chancloser.RbfChanCloserCfg{
3✔
3873
                Daemon:        daemonAdapters,
3✔
3874
                InitialState:  &initialState,
3✔
3875
                Env:           &env,
3✔
3876
                InitEvent:     fn.Some[protofsm.DaemonEvent](&spendEvent),
3✔
3877
                ErrorReporter: newChanErrorReporter(chanID, p),
3✔
3878
                MsgMapper: fn.Some[protofsm.MsgMapper[chancloser.ProtocolEvent]]( //nolint:ll
3✔
3879
                        msgMapper,
3✔
3880
                ),
3✔
3881
        }
3✔
3882

3✔
3883
        ctx := context.Background()
3✔
3884
        chanCloser := protofsm.NewStateMachine(protoCfg)
3✔
3885
        chanCloser.Start(ctx)
3✔
3886

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

3✔
3892
                return r.RegisterEndpoint(&chanCloser)
3✔
3893
        })
3✔
3894
        if err != nil {
3✔
3895
                chanCloser.Stop()
×
3896

×
3897
                return nil, fmt.Errorf("unable to register endpoint for co-op "+
×
3898
                        "close: %w", err)
×
3899
        }
×
3900

3901
        p.activeChanCloses.Store(chanID, makeRbfCloser(&chanCloser))
3✔
3902

3✔
3903
        // Now that we've created the rbf closer state machine, we'll launch a
3✔
3904
        // new goroutine to eventually send in the ChannelFlushed event once
3✔
3905
        // needed.
3✔
3906
        p.cg.WgAdd(1)
3✔
3907
        go p.chanFlushEventSentinel(&chanCloser, link, channel)
3✔
3908

3✔
3909
        return &chanCloser, nil
3✔
3910
}
3911

3912
// shutdownInit describes the two ways we can initiate a new shutdown. Either we
3913
// got an RPC request to do so (left), or we sent a shutdown message to the
3914
// party (for w/e reason), but crashed before the close was complete.
3915
//
3916
//nolint:ll
3917
type shutdownInit = fn.Option[fn.Either[*htlcswitch.ChanClose, channeldb.ShutdownInfo]]
3918

3919
// shutdownStartFeeRate returns the fee rate that should be used for the
3920
// shutdown.  This returns a doubly wrapped option as the shutdown info might
3921
// be none, and the fee rate is only defined for the user initiated shutdown.
3922
func shutdownStartFeeRate(s shutdownInit) fn.Option[chainfee.SatPerKWeight] {
3✔
3923
        feeRateOpt := fn.MapOption(func(init fn.Either[*htlcswitch.ChanClose,
3✔
3924
                channeldb.ShutdownInfo]) fn.Option[chainfee.SatPerKWeight] {
6✔
3925

3✔
3926
                var feeRate fn.Option[chainfee.SatPerKWeight]
3✔
3927
                init.WhenLeft(func(req *htlcswitch.ChanClose) {
6✔
3928
                        feeRate = fn.Some(req.TargetFeePerKw)
3✔
3929
                })
3✔
3930

3931
                return feeRate
3✔
3932
        })(s)
3933

3934
        return fn.FlattenOption(feeRateOpt)
3✔
3935
}
3936

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

3✔
3944
                var addr fn.Option[lnwire.DeliveryAddress]
3✔
3945
                init.WhenLeft(func(req *htlcswitch.ChanClose) {
6✔
3946
                        if len(req.DeliveryScript) != 0 {
6✔
3947
                                addr = fn.Some(req.DeliveryScript)
3✔
3948
                        }
3✔
3949
                })
3950
                init.WhenRight(func(info channeldb.ShutdownInfo) {
6✔
3951
                        addr = fn.Some(info.DeliveryScript.Val)
3✔
3952
                })
3✔
3953

3954
                return addr
3✔
3955
        })(s)
3956

3957
        return fn.FlattenOption(addrOpt)
3✔
3958
}
3959

3960
// whenRPCShutdown registers a callback to be executed when the shutdown init
3961
// type is and RPC request.
3962
func whenRPCShutdown(s shutdownInit, f func(r *htlcswitch.ChanClose)) {
3✔
3963
        s.WhenSome(func(init fn.Either[*htlcswitch.ChanClose,
3✔
3964
                channeldb.ShutdownInfo]) {
6✔
3965

3✔
3966
                init.WhenLeft(f)
3✔
3967
        })
3✔
3968
}
3969

3970
// newRestartShutdownInit creates a new shutdownInit for the case where we need
3971
// to restart the shutdown flow after a restart.
3972
func newRestartShutdownInit(info channeldb.ShutdownInfo) shutdownInit {
3✔
3973
        return fn.Some(fn.NewRight[*htlcswitch.ChanClose](info))
3✔
3974
}
3✔
3975

3976
// newRPCShutdownInit creates a new shutdownInit for the case where we
3977
// initiated the shutdown via an RPC client.
3978
func newRPCShutdownInit(req *htlcswitch.ChanClose) shutdownInit {
3✔
3979
        return fn.Some(
3✔
3980
                fn.NewLeft[*htlcswitch.ChanClose, channeldb.ShutdownInfo](req),
3✔
3981
        )
3✔
3982
}
3✔
3983

3984
// waitUntilRbfCoastClear waits until the RBF co-op close state machine has
3985
// advanced to a terminal state before attempting another fee bump.
3986
func waitUntilRbfCoastClear(ctx context.Context,
3987
        rbfCloser *chancloser.RbfChanCloser) error {
3✔
3988

3✔
3989
        coopCloseStates := rbfCloser.RegisterStateEvents()
3✔
3990
        newStateChan := coopCloseStates.NewItemCreated.ChanOut()
3✔
3991
        defer rbfCloser.RemoveStateSub(coopCloseStates)
3✔
3992

3✔
3993
        isTerminalState := func(newState chancloser.RbfState) bool {
6✔
3994
                // If we're not in the negotiation sub-state, then we aren't at
3✔
3995
                // the terminal state yet.
3✔
3996
                state, ok := newState.(*chancloser.ClosingNegotiation)
3✔
3997
                if !ok {
3✔
3998
                        return false
×
3999
                }
×
4000

4001
                localState := state.PeerState.GetForParty(lntypes.Local)
3✔
4002

3✔
4003
                // If this isn't the close pending state, we aren't at the
3✔
4004
                // terminal state yet.
3✔
4005
                _, ok = localState.(*chancloser.ClosePending)
3✔
4006

3✔
4007
                return ok
3✔
4008
        }
4009

4010
        // Before we enter the subscription loop below, check to see if we're
4011
        // already in the terminal state.
4012
        rbfState, err := rbfCloser.CurrentState()
3✔
4013
        if err != nil {
3✔
4014
                return err
×
4015
        }
×
4016
        if isTerminalState(rbfState) {
6✔
4017
                return nil
3✔
4018
        }
3✔
4019

4020
        peerLog.Debugf("Waiting for RBF iteration to complete...")
×
4021

×
4022
        for {
×
4023
                select {
×
4024
                case newState := <-newStateChan:
×
4025
                        if isTerminalState(newState) {
×
4026
                                return nil
×
4027
                        }
×
4028

4029
                case <-ctx.Done():
×
4030
                        return fmt.Errorf("context canceled")
×
4031
                }
4032
        }
4033
}
4034

4035
// startRbfChanCloser kicks off the co-op close process using the new RBF based
4036
// co-op close protocol. This is called when we're the one that's initiating
4037
// the cooperative channel close.
4038
//
4039
// TODO(roasbeef): just accept the two shutdown pointer params instead??
4040
func (p *Brontide) startRbfChanCloser(shutdown shutdownInit,
4041
        chanPoint wire.OutPoint) error {
3✔
4042

3✔
4043
        // Unlike the old negotiate chan closer, we'll always create the RBF
3✔
4044
        // chan closer on startup, so we can skip init here.
3✔
4045
        chanID := lnwire.NewChanIDFromOutPoint(chanPoint)
3✔
4046
        chanCloser, found := p.activeChanCloses.Load(chanID)
3✔
4047
        if !found {
3✔
4048
                return fmt.Errorf("rbf can closer not found for channel %v",
×
4049
                        chanPoint)
×
4050
        }
×
4051

4052
        defaultFeePerKw, err := shutdownStartFeeRate(
3✔
4053
                shutdown,
3✔
4054
        ).UnwrapOrFuncErr(func() (chainfee.SatPerKWeight, error) {
6✔
4055
                return p.cfg.FeeEstimator.EstimateFeePerKW(
3✔
4056
                        p.cfg.CoopCloseTargetConfs,
3✔
4057
                )
3✔
4058
        })
3✔
4059
        if err != nil {
3✔
4060
                return fmt.Errorf("unable to estimate fee: %w", err)
×
4061
        }
×
4062

4063
        chanCloser.WhenRight(func(rbfCloser *chancloser.RbfChanCloser) {
6✔
4064
                peerLog.Infof("ChannelPoint(%v): rbf-coop close requested, "+
3✔
4065
                        "sending shutdown", chanPoint)
3✔
4066

3✔
4067
                rbfState, err := rbfCloser.CurrentState()
3✔
4068
                if err != nil {
3✔
4069
                        peerLog.Warnf("ChannelPoint(%v): unable to get "+
×
4070
                                "current state for rbf-coop close: %v",
×
4071
                                chanPoint, err)
×
4072

×
4073
                        return
×
4074
                }
×
4075

4076
                coopCloseStates := rbfCloser.RegisterStateEvents()
3✔
4077

3✔
4078
                // Before we send our event below, we'll launch a goroutine to
3✔
4079
                // watch for the final terminal state to send updates to the RPC
3✔
4080
                // client. We only need to do this if there's an RPC caller.
3✔
4081
                var rpcShutdown bool
3✔
4082
                whenRPCShutdown(shutdown, func(req *htlcswitch.ChanClose) {
6✔
4083
                        rpcShutdown = true
3✔
4084

3✔
4085
                        p.cg.WgAdd(1)
3✔
4086
                        go func() {
6✔
4087
                                defer p.cg.WgDone()
3✔
4088

3✔
4089
                                p.observeRbfCloseUpdates(
3✔
4090
                                        rbfCloser, req, coopCloseStates,
3✔
4091
                                )
3✔
4092
                        }()
3✔
4093
                })
4094

4095
                if !rpcShutdown {
6✔
4096
                        defer rbfCloser.RemoveStateSub(coopCloseStates)
3✔
4097
                }
3✔
4098

4099
                ctx, _ := p.cg.Create(context.Background())
3✔
4100
                feeRate := defaultFeePerKw.FeePerVByte()
3✔
4101

3✔
4102
                // Depending on the state of the state machine, we'll either
3✔
4103
                // kick things off by sending shutdown, or attempt to send a new
3✔
4104
                // offer to the remote party.
3✔
4105
                switch rbfState.(type) {
3✔
4106
                // The channel is still active, so we'll now kick off the co-op
4107
                // close process by instructing it to send a shutdown message to
4108
                // the remote party.
4109
                case *chancloser.ChannelActive:
3✔
4110
                        rbfCloser.SendEvent(
3✔
4111
                                context.Background(),
3✔
4112
                                &chancloser.SendShutdown{
3✔
4113
                                        IdealFeeRate: feeRate,
3✔
4114
                                        DeliveryAddr: shutdownStartAddr(
3✔
4115
                                                shutdown,
3✔
4116
                                        ),
3✔
4117
                                },
3✔
4118
                        )
3✔
4119

4120
                // If we haven't yet sent an offer (didn't have enough funds at
4121
                // the prior fee rate), or we've sent an offer, then we'll
4122
                // trigger a new offer event.
4123
                case *chancloser.ClosingNegotiation:
3✔
4124
                        // Before we send the event below, we'll wait until
3✔
4125
                        // we're in a semi-terminal state.
3✔
4126
                        err := waitUntilRbfCoastClear(ctx, rbfCloser)
3✔
4127
                        if err != nil {
3✔
4128
                                peerLog.Warnf("ChannelPoint(%v): unable to "+
×
4129
                                        "wait for coast to clear: %v",
×
4130
                                        chanPoint, err)
×
4131

×
4132
                                return
×
4133
                        }
×
4134

4135
                        event := chancloser.ProtocolEvent(
3✔
4136
                                &chancloser.SendOfferEvent{
3✔
4137
                                        TargetFeeRate: feeRate,
3✔
4138
                                },
3✔
4139
                        )
3✔
4140
                        rbfCloser.SendEvent(ctx, event)
3✔
4141

4142
                default:
×
4143
                        peerLog.Warnf("ChannelPoint(%v): unexpected state "+
×
4144
                                "for rbf-coop close: %T", chanPoint, rbfState)
×
4145
                }
4146
        })
4147

4148
        return nil
3✔
4149
}
4150

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

3✔
4156
        channel, ok := p.activeChannels.Load(chanID)
3✔
4157

3✔
4158
        // Though this function can't be called for pending channels, we still
3✔
4159
        // check whether channel is nil for safety.
3✔
4160
        if !ok || channel == nil {
3✔
4161
                err := fmt.Errorf("unable to close channel, ChannelID(%v) is "+
×
4162
                        "unknown", chanID)
×
4163
                p.log.Errorf(err.Error())
×
4164
                req.Err <- err
×
4165
                return
×
4166
        }
×
4167

4168
        switch req.CloseType {
3✔
4169
        // A type of CloseRegular indicates that the user has opted to close
4170
        // out this channel on-chain, so we execute the cooperative channel
4171
        // closure workflow.
4172
        case contractcourt.CloseRegular:
3✔
4173
                var err error
3✔
4174
                switch {
3✔
4175
                // If this is the RBF coop state machine, then we'll instruct
4176
                // it to send the shutdown message. This also might be an RBF
4177
                // iteration, in which case we'll be obtaining a new
4178
                // transaction w/ a higher fee rate.
4179
                case p.rbfCoopCloseAllowed():
3✔
4180
                        err = p.startRbfChanCloser(
3✔
4181
                                newRPCShutdownInit(req), channel.ChannelPoint(),
3✔
4182
                        )
3✔
4183
                default:
3✔
4184
                        err = p.initNegotiateChanCloser(req, channel)
3✔
4185
                }
4186

4187
                if err != nil {
3✔
4188
                        p.log.Errorf(err.Error())
×
4189
                        req.Err <- err
×
4190
                }
×
4191

4192
        // A type of CloseBreach indicates that the counterparty has breached
4193
        // the channel therefore we need to clean up our local state.
4194
        case contractcourt.CloseBreach:
1✔
4195
                // TODO(roasbeef): no longer need with newer beach logic?
1✔
4196
                p.log.Infof("ChannelPoint(%v) has been breached, wiping "+
1✔
4197
                        "channel", req.ChanPoint)
1✔
4198
                p.WipeChannel(req.ChanPoint)
1✔
4199
        }
4200
}
4201

4202
// linkFailureReport is sent to the channelManager whenever a link reports a
4203
// link failure, and is forced to exit. The report houses the necessary
4204
// information to clean up the channel state, send back the error message, and
4205
// force close if necessary.
4206
type linkFailureReport struct {
4207
        chanPoint   wire.OutPoint
4208
        chanID      lnwire.ChannelID
4209
        shortChanID lnwire.ShortChannelID
4210
        linkErr     htlcswitch.LinkFailureError
4211
}
4212

4213
// handleLinkFailure processes a link failure report when a link in the switch
4214
// fails. It facilitates the removal of all channel state within the peer,
4215
// force closing the channel depending on severity, and sending the error
4216
// message back to the remote party.
4217
func (p *Brontide) handleLinkFailure(failure linkFailureReport) {
3✔
4218
        // Retrieve the channel from the map of active channels. We do this to
3✔
4219
        // have access to it even after WipeChannel remove it from the map.
3✔
4220
        chanID := lnwire.NewChanIDFromOutPoint(failure.chanPoint)
3✔
4221
        lnChan, _ := p.activeChannels.Load(chanID)
3✔
4222

3✔
4223
        // We begin by wiping the link, which will remove it from the switch,
3✔
4224
        // such that it won't be attempted used for any more updates.
3✔
4225
        //
3✔
4226
        // TODO(halseth): should introduce a way to atomically stop/pause the
3✔
4227
        // link and cancel back any adds in its mailboxes such that we can
3✔
4228
        // safely force close without the link being added again and updates
3✔
4229
        // being applied.
3✔
4230
        p.WipeChannel(&failure.chanPoint)
3✔
4231

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

3✔
4237
                closeTx, err := p.cfg.ChainArb.ForceCloseContract(
3✔
4238
                        failure.chanPoint,
3✔
4239
                )
3✔
4240
                if err != nil {
6✔
4241
                        p.log.Errorf("unable to force close "+
3✔
4242
                                "link(%v): %v", failure.shortChanID, err)
3✔
4243
                } else {
6✔
4244
                        p.log.Infof("channel(%v) force "+
3✔
4245
                                "closed with txid %v",
3✔
4246
                                failure.shortChanID, closeTx.TxHash())
3✔
4247
                }
3✔
4248
        }
4249

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

×
4255
                if err := lnChan.State().MarkBorked(); err != nil {
×
4256
                        p.log.Errorf("Unable to mark channel %v borked: %v",
×
4257
                                failure.shortChanID, err)
×
4258
                }
×
4259
        }
4260

4261
        // Send an error to the peer, why we failed the channel.
4262
        if failure.linkErr.ShouldSendToPeer() {
6✔
4263
                // If SendData is set, send it to the peer. If not, we'll use
3✔
4264
                // the standard error messages in the payload. We only include
3✔
4265
                // sendData in the cases where the error data does not contain
3✔
4266
                // sensitive information.
3✔
4267
                data := []byte(failure.linkErr.Error())
3✔
4268
                if failure.linkErr.SendData != nil {
3✔
4269
                        data = failure.linkErr.SendData
×
4270
                }
×
4271

4272
                var networkMsg lnwire.Message
3✔
4273
                if failure.linkErr.Warning {
3✔
4274
                        networkMsg = &lnwire.Warning{
×
4275
                                ChanID: failure.chanID,
×
4276
                                Data:   data,
×
4277
                        }
×
4278
                } else {
3✔
4279
                        networkMsg = &lnwire.Error{
3✔
4280
                                ChanID: failure.chanID,
3✔
4281
                                Data:   data,
3✔
4282
                        }
3✔
4283
                }
3✔
4284

4285
                err := p.SendMessage(true, networkMsg)
3✔
4286
                if err != nil {
3✔
4287
                        p.log.Errorf("unable to send msg to "+
×
4288
                                "remote peer: %v", err)
×
4289
                }
×
4290
        }
4291

4292
        // If the failure action is disconnect, then we'll execute that now. If
4293
        // we had to send an error above, it was a sync call, so we expect the
4294
        // message to be flushed on the wire by now.
4295
        if failure.linkErr.FailureAction == htlcswitch.LinkFailureDisconnect {
3✔
4296
                p.Disconnect(fmt.Errorf("link requested disconnect"))
×
4297
        }
×
4298
}
4299

4300
// fetchLinkFromKeyAndCid fetches a link from the switch via the remote's
4301
// public key and the channel id.
4302
func (p *Brontide) fetchLinkFromKeyAndCid(
4303
        cid lnwire.ChannelID) htlcswitch.ChannelUpdateHandler {
3✔
4304

3✔
4305
        var chanLink htlcswitch.ChannelUpdateHandler
3✔
4306

3✔
4307
        // We don't need to check the error here, and can instead just loop
3✔
4308
        // over the slice and return nil.
3✔
4309
        links, _ := p.cfg.Switch.GetLinksByInterface(p.cfg.PubKeyBytes)
3✔
4310
        for _, link := range links {
6✔
4311
                if link.ChanID() == cid {
6✔
4312
                        chanLink = link
3✔
4313
                        break
3✔
4314
                }
4315
        }
4316

4317
        return chanLink
3✔
4318
}
4319

4320
// finalizeChanClosure performs the final clean up steps once the cooperative
4321
// closure transaction has been fully broadcast. The finalized closing state
4322
// machine should be passed in. Once the transaction has been sufficiently
4323
// confirmed, the channel will be marked as fully closed within the database,
4324
// and any clients will be notified of updates to the closing state.
4325
func (p *Brontide) finalizeChanClosure(chanCloser *chancloser.ChanCloser) {
3✔
4326
        closeReq := chanCloser.CloseRequest()
3✔
4327

3✔
4328
        // First, we'll clear all indexes related to the channel in question.
3✔
4329
        chanPoint := chanCloser.Channel().ChannelPoint()
3✔
4330
        p.WipeChannel(&chanPoint)
3✔
4331

3✔
4332
        // Also clear the activeChanCloses map of this channel.
3✔
4333
        cid := lnwire.NewChanIDFromOutPoint(chanPoint)
3✔
4334
        p.activeChanCloses.Delete(cid) // TODO(roasbeef): existing race
3✔
4335

3✔
4336
        // Next, we'll launch a goroutine which will request to be notified by
3✔
4337
        // the ChainNotifier once the closure transaction obtains a single
3✔
4338
        // confirmation.
3✔
4339
        notifier := p.cfg.ChainNotifier
3✔
4340

3✔
4341
        // If any error happens during waitForChanToClose, forward it to
3✔
4342
        // closeReq. If this channel closure is not locally initiated, closeReq
3✔
4343
        // will be nil, so just ignore the error.
3✔
4344
        errChan := make(chan error, 1)
3✔
4345
        if closeReq != nil {
6✔
4346
                errChan = closeReq.Err
3✔
4347
        }
3✔
4348

4349
        closingTx, err := chanCloser.ClosingTx()
3✔
4350
        if err != nil {
3✔
4351
                if closeReq != nil {
×
4352
                        p.log.Error(err)
×
4353
                        closeReq.Err <- err
×
4354
                }
×
4355
        }
4356

4357
        closingTxid := closingTx.TxHash()
3✔
4358

3✔
4359
        // If this is a locally requested shutdown, update the caller with a
3✔
4360
        // new event detailing the current pending state of this request.
3✔
4361
        if closeReq != nil {
6✔
4362
                closeReq.Updates <- &PendingUpdate{
3✔
4363
                        Txid: closingTxid[:],
3✔
4364
                }
3✔
4365
        }
3✔
4366

4367
        localOut := chanCloser.LocalCloseOutput()
3✔
4368
        remoteOut := chanCloser.RemoteCloseOutput()
3✔
4369
        auxOut := chanCloser.AuxOutputs()
3✔
4370
        go WaitForChanToClose(
3✔
4371
                chanCloser.NegotiationHeight(), notifier, errChan,
3✔
4372
                &chanPoint, &closingTxid, closingTx.TxOut[0].PkScript, func() {
6✔
4373
                        // Respond to the local subsystem which requested the
3✔
4374
                        // channel closure.
3✔
4375
                        if closeReq != nil {
6✔
4376
                                closeReq.Updates <- &ChannelCloseUpdate{
3✔
4377
                                        ClosingTxid:       closingTxid[:],
3✔
4378
                                        Success:           true,
3✔
4379
                                        LocalCloseOutput:  localOut,
3✔
4380
                                        RemoteCloseOutput: remoteOut,
3✔
4381
                                        AuxOutputs:        auxOut,
3✔
4382
                                }
3✔
4383
                        }
3✔
4384
                },
4385
        )
4386
}
4387

4388
// WaitForChanToClose uses the passed notifier to wait until the channel has
4389
// been detected as closed on chain and then concludes by executing the
4390
// following actions: the channel point will be sent over the settleChan, and
4391
// finally the callback will be executed. If any error is encountered within
4392
// the function, then it will be sent over the errChan.
4393
func WaitForChanToClose(bestHeight uint32, notifier chainntnfs.ChainNotifier,
4394
        errChan chan error, chanPoint *wire.OutPoint,
4395
        closingTxID *chainhash.Hash, closeScript []byte, cb func()) {
3✔
4396

3✔
4397
        peerLog.Infof("Waiting for confirmation of close of ChannelPoint(%v) "+
3✔
4398
                "with txid: %v", chanPoint, closingTxID)
3✔
4399

3✔
4400
        // TODO(roasbeef): add param for num needed confs
3✔
4401
        confNtfn, err := notifier.RegisterConfirmationsNtfn(
3✔
4402
                closingTxID, closeScript, 1, bestHeight,
3✔
4403
        )
3✔
4404
        if err != nil {
3✔
4405
                if errChan != nil {
×
4406
                        errChan <- err
×
4407
                }
×
4408
                return
×
4409
        }
4410

4411
        // In the case that the ChainNotifier is shutting down, all subscriber
4412
        // notification channels will be closed, generating a nil receive.
4413
        height, ok := <-confNtfn.Confirmed
3✔
4414
        if !ok {
6✔
4415
                return
3✔
4416
        }
3✔
4417

4418
        // The channel has been closed, remove it from any active indexes, and
4419
        // the database state.
4420
        peerLog.Infof("ChannelPoint(%v) is now closed at "+
3✔
4421
                "height %v", chanPoint, height.BlockHeight)
3✔
4422

3✔
4423
        // Finally, execute the closure call back to mark the confirmation of
3✔
4424
        // the transaction closing the contract.
3✔
4425
        cb()
3✔
4426
}
4427

4428
// WipeChannel removes the passed channel point from all indexes associated with
4429
// the peer and the switch.
4430
func (p *Brontide) WipeChannel(chanPoint *wire.OutPoint) {
3✔
4431
        chanID := lnwire.NewChanIDFromOutPoint(*chanPoint)
3✔
4432

3✔
4433
        p.activeChannels.Delete(chanID)
3✔
4434

3✔
4435
        // Instruct the HtlcSwitch to close this link as the channel is no
3✔
4436
        // longer active.
3✔
4437
        p.cfg.Switch.RemoveLink(chanID)
3✔
4438
}
3✔
4439

4440
// handleInitMsg handles the incoming init message which contains global and
4441
// local feature vectors. If feature vectors are incompatible then disconnect.
4442
func (p *Brontide) handleInitMsg(msg *lnwire.Init) error {
3✔
4443
        // First, merge any features from the legacy global features field into
3✔
4444
        // those presented in the local features fields.
3✔
4445
        err := msg.Features.Merge(msg.GlobalFeatures)
3✔
4446
        if err != nil {
3✔
4447
                return fmt.Errorf("unable to merge legacy global features: %w",
×
4448
                        err)
×
4449
        }
×
4450

4451
        // Then, finalize the remote feature vector providing the flattened
4452
        // feature bit namespace.
4453
        p.remoteFeatures = lnwire.NewFeatureVector(
3✔
4454
                msg.Features, lnwire.Features,
3✔
4455
        )
3✔
4456

3✔
4457
        // Now that we have their features loaded, we'll ensure that they
3✔
4458
        // didn't set any required bits that we don't know of.
3✔
4459
        err = feature.ValidateRequired(p.remoteFeatures)
3✔
4460
        if err != nil {
3✔
4461
                return fmt.Errorf("invalid remote features: %w", err)
×
4462
        }
×
4463

4464
        // Ensure the remote party's feature vector contains all transitive
4465
        // dependencies. We know ours are correct since they are validated
4466
        // during the feature manager's instantiation.
4467
        err = feature.ValidateDeps(p.remoteFeatures)
3✔
4468
        if err != nil {
3✔
4469
                return fmt.Errorf("invalid remote features: %w", err)
×
4470
        }
×
4471

4472
        // Now that we know we understand their requirements, we'll check to
4473
        // see if they don't support anything that we deem to be mandatory.
4474
        if !p.remoteFeatures.HasFeature(lnwire.DataLossProtectRequired) {
3✔
4475
                return fmt.Errorf("data loss protection required")
×
4476
        }
×
4477

4478
        return nil
3✔
4479
}
4480

4481
// LocalFeatures returns the set of global features that has been advertised by
4482
// the local node. This allows sub-systems that use this interface to gate their
4483
// behavior off the set of negotiated feature bits.
4484
//
4485
// NOTE: Part of the lnpeer.Peer interface.
4486
func (p *Brontide) LocalFeatures() *lnwire.FeatureVector {
3✔
4487
        return p.cfg.Features
3✔
4488
}
3✔
4489

4490
// RemoteFeatures returns the set of global features that has been advertised by
4491
// the remote node. This allows sub-systems that use this interface to gate
4492
// their behavior off the set of negotiated feature bits.
4493
//
4494
// NOTE: Part of the lnpeer.Peer interface.
4495
func (p *Brontide) RemoteFeatures() *lnwire.FeatureVector {
3✔
4496
        return p.remoteFeatures
3✔
4497
}
3✔
4498

4499
// hasNegotiatedScidAlias returns true if we've negotiated the
4500
// option-scid-alias feature bit with the peer.
4501
func (p *Brontide) hasNegotiatedScidAlias() bool {
3✔
4502
        peerHas := p.remoteFeatures.HasFeature(lnwire.ScidAliasOptional)
3✔
4503
        localHas := p.cfg.Features.HasFeature(lnwire.ScidAliasOptional)
3✔
4504
        return peerHas && localHas
3✔
4505
}
3✔
4506

4507
// sendInitMsg sends the Init message to the remote peer. This message contains
4508
// our currently supported local and global features.
4509
func (p *Brontide) sendInitMsg(legacyChan bool) error {
3✔
4510
        features := p.cfg.Features.Clone()
3✔
4511
        legacyFeatures := p.cfg.LegacyFeatures.Clone()
3✔
4512

3✔
4513
        // If we have a legacy channel open with a peer, we downgrade static
3✔
4514
        // remote required to optional in case the peer does not understand the
3✔
4515
        // required feature bit. If we do not do this, the peer will reject our
3✔
4516
        // connection because it does not understand a required feature bit, and
3✔
4517
        // our channel will be unusable.
3✔
4518
        if legacyChan && features.RequiresFeature(lnwire.StaticRemoteKeyRequired) {
3✔
4519
                p.log.Infof("Legacy channel open with peer, " +
×
4520
                        "downgrading static remote required feature bit to " +
×
4521
                        "optional")
×
4522

×
4523
                // Unset and set in both the local and global features to
×
4524
                // ensure both sets are consistent and merge able by old and
×
4525
                // new nodes.
×
4526
                features.Unset(lnwire.StaticRemoteKeyRequired)
×
4527
                legacyFeatures.Unset(lnwire.StaticRemoteKeyRequired)
×
4528

×
4529
                features.Set(lnwire.StaticRemoteKeyOptional)
×
4530
                legacyFeatures.Set(lnwire.StaticRemoteKeyOptional)
×
4531
        }
×
4532

4533
        msg := lnwire.NewInitMessage(
3✔
4534
                legacyFeatures.RawFeatureVector,
3✔
4535
                features.RawFeatureVector,
3✔
4536
        )
3✔
4537

3✔
4538
        return p.writeMessage(msg)
3✔
4539
}
4540

4541
// resendChanSyncMsg will attempt to find a channel sync message for the closed
4542
// channel and resend it to our peer.
4543
func (p *Brontide) resendChanSyncMsg(cid lnwire.ChannelID) error {
3✔
4544
        // If we already re-sent the mssage for this channel, we won't do it
3✔
4545
        // again.
3✔
4546
        if _, ok := p.resentChanSyncMsg[cid]; ok {
3✔
4547
                return nil
×
4548
        }
×
4549

4550
        // Check if we have any channel sync messages stored for this channel.
4551
        c, err := p.cfg.ChannelDB.FetchClosedChannelForID(cid)
3✔
4552
        if err != nil {
6✔
4553
                return fmt.Errorf("unable to fetch channel sync messages for "+
3✔
4554
                        "peer %v: %v", p, err)
3✔
4555
        }
3✔
4556

4557
        if c.LastChanSyncMsg == nil {
3✔
4558
                return fmt.Errorf("no chan sync message stored for channel %v",
×
4559
                        cid)
×
4560
        }
×
4561

4562
        if !c.RemotePub.IsEqual(p.IdentityKey()) {
3✔
4563
                return fmt.Errorf("ignoring channel reestablish from "+
×
4564
                        "peer=%x", p.IdentityKey().SerializeCompressed())
×
4565
        }
×
4566

4567
        p.log.Debugf("Re-sending channel sync message for channel %v to "+
3✔
4568
                "peer", cid)
3✔
4569

3✔
4570
        if err := p.SendMessage(true, c.LastChanSyncMsg); err != nil {
3✔
4571
                return fmt.Errorf("failed resending channel sync "+
×
4572
                        "message to peer %v: %v", p, err)
×
4573
        }
×
4574

4575
        p.log.Debugf("Re-sent channel sync message for channel %v to peer ",
3✔
4576
                cid)
3✔
4577

3✔
4578
        // Note down that we sent the message, so we won't resend it again for
3✔
4579
        // this connection.
3✔
4580
        p.resentChanSyncMsg[cid] = struct{}{}
3✔
4581

3✔
4582
        return nil
3✔
4583
}
4584

4585
// SendMessage sends a variadic number of high-priority messages to the remote
4586
// peer. The first argument denotes if the method should block until the
4587
// messages have been sent to the remote peer or an error is returned,
4588
// otherwise it returns immediately after queuing.
4589
//
4590
// NOTE: Part of the lnpeer.Peer interface.
4591
func (p *Brontide) SendMessage(sync bool, msgs ...lnwire.Message) error {
3✔
4592
        return p.sendMessage(sync, true, msgs...)
3✔
4593
}
3✔
4594

4595
// SendMessageLazy sends a variadic number of low-priority messages to the
4596
// remote peer. The first argument denotes if the method should block until
4597
// the messages have been sent to the remote peer or an error is returned,
4598
// otherwise it returns immediately after queueing.
4599
//
4600
// NOTE: Part of the lnpeer.Peer interface.
4601
func (p *Brontide) SendMessageLazy(sync bool, msgs ...lnwire.Message) error {
3✔
4602
        return p.sendMessage(sync, false, msgs...)
3✔
4603
}
3✔
4604

4605
// sendMessage queues a variadic number of messages using the passed priority
4606
// to the remote peer. If sync is true, this method will block until the
4607
// messages have been sent to the remote peer or an error is returned, otherwise
4608
// it returns immediately after queueing.
4609
func (p *Brontide) sendMessage(sync, priority bool, msgs ...lnwire.Message) error {
3✔
4610
        // Add all incoming messages to the outgoing queue. A list of error
3✔
4611
        // chans is populated for each message if the caller requested a sync
3✔
4612
        // send.
3✔
4613
        var errChans []chan error
3✔
4614
        if sync {
6✔
4615
                errChans = make([]chan error, 0, len(msgs))
3✔
4616
        }
3✔
4617
        for _, msg := range msgs {
6✔
4618
                // If a sync send was requested, create an error chan to listen
3✔
4619
                // for an ack from the writeHandler.
3✔
4620
                var errChan chan error
3✔
4621
                if sync {
6✔
4622
                        errChan = make(chan error, 1)
3✔
4623
                        errChans = append(errChans, errChan)
3✔
4624
                }
3✔
4625

4626
                if priority {
6✔
4627
                        p.queueMsg(msg, errChan)
3✔
4628
                } else {
6✔
4629
                        p.queueMsgLazy(msg, errChan)
3✔
4630
                }
3✔
4631
        }
4632

4633
        // Wait for all replies from the writeHandler. For async sends, this
4634
        // will be a NOP as the list of error chans is nil.
4635
        for _, errChan := range errChans {
6✔
4636
                select {
3✔
4637
                case err := <-errChan:
3✔
4638
                        return err
3✔
4639
                case <-p.cg.Done():
×
4640
                        return lnpeer.ErrPeerExiting
×
4641
                case <-p.cfg.Quit:
×
4642
                        return lnpeer.ErrPeerExiting
×
4643
                }
4644
        }
4645

4646
        return nil
3✔
4647
}
4648

4649
// PubKey returns the pubkey of the peer in compressed serialized format.
4650
//
4651
// NOTE: Part of the lnpeer.Peer interface.
4652
func (p *Brontide) PubKey() [33]byte {
3✔
4653
        return p.cfg.PubKeyBytes
3✔
4654
}
3✔
4655

4656
// IdentityKey returns the public key of the remote peer.
4657
//
4658
// NOTE: Part of the lnpeer.Peer interface.
4659
func (p *Brontide) IdentityKey() *btcec.PublicKey {
3✔
4660
        return p.cfg.Addr.IdentityKey
3✔
4661
}
3✔
4662

4663
// Address returns the network address of the remote peer.
4664
//
4665
// NOTE: Part of the lnpeer.Peer interface.
4666
func (p *Brontide) Address() net.Addr {
3✔
4667
        return p.cfg.Addr.Address
3✔
4668
}
3✔
4669

4670
// AddNewChannel adds a new channel to the peer. The channel should fail to be
4671
// added if the cancel channel is closed.
4672
//
4673
// NOTE: Part of the lnpeer.Peer interface.
4674
func (p *Brontide) AddNewChannel(newChan *lnpeer.NewChannel,
4675
        cancel <-chan struct{}) error {
3✔
4676

3✔
4677
        errChan := make(chan error, 1)
3✔
4678
        newChanMsg := &newChannelMsg{
3✔
4679
                channel: newChan,
3✔
4680
                err:     errChan,
3✔
4681
        }
3✔
4682

3✔
4683
        select {
3✔
4684
        case p.newActiveChannel <- newChanMsg:
3✔
4685
        case <-cancel:
×
4686
                return errors.New("canceled adding new channel")
×
4687
        case <-p.cg.Done():
×
4688
                return lnpeer.ErrPeerExiting
×
4689
        }
4690

4691
        // We pause here to wait for the peer to recognize the new channel
4692
        // before we close the channel barrier corresponding to the channel.
4693
        select {
3✔
4694
        case err := <-errChan:
3✔
4695
                return err
3✔
4696
        case <-p.cg.Done():
×
4697
                return lnpeer.ErrPeerExiting
×
4698
        }
4699
}
4700

4701
// AddPendingChannel adds a pending open channel to the peer. The channel
4702
// should fail to be added if the cancel channel is closed.
4703
//
4704
// NOTE: Part of the lnpeer.Peer interface.
4705
func (p *Brontide) AddPendingChannel(cid lnwire.ChannelID,
4706
        cancel <-chan struct{}) error {
3✔
4707

3✔
4708
        errChan := make(chan error, 1)
3✔
4709
        newChanMsg := &newChannelMsg{
3✔
4710
                channelID: cid,
3✔
4711
                err:       errChan,
3✔
4712
        }
3✔
4713

3✔
4714
        select {
3✔
4715
        case p.newPendingChannel <- newChanMsg:
3✔
4716

4717
        case <-cancel:
×
4718
                return errors.New("canceled adding pending channel")
×
4719

4720
        case <-p.cg.Done():
×
4721
                return lnpeer.ErrPeerExiting
×
4722
        }
4723

4724
        // We pause here to wait for the peer to recognize the new pending
4725
        // channel before we close the channel barrier corresponding to the
4726
        // channel.
4727
        select {
3✔
4728
        case err := <-errChan:
3✔
4729
                return err
3✔
4730

4731
        case <-cancel:
×
4732
                return errors.New("canceled adding pending channel")
×
4733

4734
        case <-p.cg.Done():
×
4735
                return lnpeer.ErrPeerExiting
×
4736
        }
4737
}
4738

4739
// RemovePendingChannel removes a pending open channel from the peer.
4740
//
4741
// NOTE: Part of the lnpeer.Peer interface.
4742
func (p *Brontide) RemovePendingChannel(cid lnwire.ChannelID) error {
3✔
4743
        errChan := make(chan error, 1)
3✔
4744
        newChanMsg := &newChannelMsg{
3✔
4745
                channelID: cid,
3✔
4746
                err:       errChan,
3✔
4747
        }
3✔
4748

3✔
4749
        select {
3✔
4750
        case p.removePendingChannel <- newChanMsg:
3✔
4751
        case <-p.cg.Done():
×
4752
                return lnpeer.ErrPeerExiting
×
4753
        }
4754

4755
        // We pause here to wait for the peer to respond to the cancellation of
4756
        // the pending channel before we close the channel barrier
4757
        // corresponding to the channel.
4758
        select {
3✔
4759
        case err := <-errChan:
3✔
4760
                return err
3✔
4761

4762
        case <-p.cg.Done():
×
4763
                return lnpeer.ErrPeerExiting
×
4764
        }
4765
}
4766

4767
// StartTime returns the time at which the connection was established if the
4768
// peer started successfully, and zero otherwise.
4769
func (p *Brontide) StartTime() time.Time {
3✔
4770
        return p.startTime
3✔
4771
}
3✔
4772

4773
// handleCloseMsg is called when a new cooperative channel closure related
4774
// message is received from the remote peer. We'll use this message to advance
4775
// the chan closer state machine.
4776
func (p *Brontide) handleCloseMsg(msg *closeMsg) {
3✔
4777
        link := p.fetchLinkFromKeyAndCid(msg.cid)
3✔
4778

3✔
4779
        // We'll now fetch the matching closing state machine in order to
3✔
4780
        // continue, or finalize the channel closure process.
3✔
4781
        chanCloserE, err := p.fetchActiveChanCloser(msg.cid)
3✔
4782
        if err != nil {
6✔
4783
                // If the channel is not known to us, we'll simply ignore this
3✔
4784
                // message.
3✔
4785
                if err == ErrChannelNotFound {
6✔
4786
                        return
3✔
4787
                }
3✔
4788

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

×
4791
                errMsg := &lnwire.Error{
×
4792
                        ChanID: msg.cid,
×
4793
                        Data:   lnwire.ErrorData(err.Error()),
×
4794
                }
×
4795
                p.queueMsg(errMsg, nil)
×
4796
                return
×
4797
        }
4798

4799
        if chanCloserE.IsRight() {
3✔
4800
                // TODO(roasbeef): assert?
×
4801
                return
×
4802
        }
×
4803

4804
        // At this point, we'll only enter this call path if a negotiate chan
4805
        // closer was used. So we'll extract that from the either now.
4806
        //
4807
        // TODO(roabeef): need extra helper func for either to make cleaner
4808
        var chanCloser *chancloser.ChanCloser
3✔
4809
        chanCloserE.WhenLeft(func(c *chancloser.ChanCloser) {
6✔
4810
                chanCloser = c
3✔
4811
        })
3✔
4812

4813
        handleErr := func(err error) {
4✔
4814
                err = fmt.Errorf("unable to process close msg: %w", err)
1✔
4815
                p.log.Error(err)
1✔
4816

1✔
4817
                // As the negotiations failed, we'll reset the channel state
1✔
4818
                // machine to ensure we act to on-chain events as normal.
1✔
4819
                chanCloser.Channel().ResetState()
1✔
4820
                if chanCloser.CloseRequest() != nil {
1✔
4821
                        chanCloser.CloseRequest().Err <- err
×
4822
                }
×
4823

4824
                p.activeChanCloses.Delete(msg.cid)
1✔
4825

1✔
4826
                p.Disconnect(err)
1✔
4827
        }
4828

4829
        // Next, we'll process the next message using the target state machine.
4830
        // We'll either continue negotiation, or halt.
4831
        switch typed := msg.msg.(type) {
3✔
4832
        case *lnwire.Shutdown:
3✔
4833
                // Disable incoming adds immediately.
3✔
4834
                if link != nil && !link.DisableAdds(htlcswitch.Incoming) {
3✔
4835
                        p.log.Warnf("Incoming link adds already disabled: %v",
×
4836
                                link.ChanID())
×
4837
                }
×
4838

4839
                oShutdown, err := chanCloser.ReceiveShutdown(*typed)
3✔
4840
                if err != nil {
3✔
4841
                        handleErr(err)
×
4842
                        return
×
4843
                }
×
4844

4845
                oShutdown.WhenSome(func(msg lnwire.Shutdown) {
6✔
4846
                        // If the link is nil it means we can immediately queue
3✔
4847
                        // the Shutdown message since we don't have to wait for
3✔
4848
                        // commitment transaction synchronization.
3✔
4849
                        if link == nil {
3✔
4850
                                p.queueMsg(&msg, nil)
×
4851
                                return
×
4852
                        }
×
4853

4854
                        // Immediately disallow any new HTLC's from being added
4855
                        // in the outgoing direction.
4856
                        if !link.DisableAdds(htlcswitch.Outgoing) {
3✔
4857
                                p.log.Warnf("Outgoing link adds already "+
×
4858
                                        "disabled: %v", link.ChanID())
×
4859
                        }
×
4860

4861
                        // When we have a Shutdown to send, we defer it till the
4862
                        // next time we send a CommitSig to remain spec
4863
                        // compliant.
4864
                        link.OnCommitOnce(htlcswitch.Outgoing, func() {
6✔
4865
                                p.queueMsg(&msg, nil)
3✔
4866
                        })
3✔
4867
                })
4868

4869
                beginNegotiation := func() {
6✔
4870
                        oClosingSigned, err := chanCloser.BeginNegotiation()
3✔
4871
                        if err != nil {
3✔
4872
                                handleErr(err)
×
4873
                                return
×
4874
                        }
×
4875

4876
                        oClosingSigned.WhenSome(func(msg lnwire.ClosingSigned) {
6✔
4877
                                p.queueMsg(&msg, nil)
3✔
4878
                        })
3✔
4879
                }
4880

4881
                if link == nil {
3✔
4882
                        beginNegotiation()
×
4883
                } else {
3✔
4884
                        // Now we register a flush hook to advance the
3✔
4885
                        // ChanCloser and possibly send out a ClosingSigned
3✔
4886
                        // when the link finishes draining.
3✔
4887
                        link.OnFlushedOnce(func() {
6✔
4888
                                // Remove link in goroutine to prevent deadlock.
3✔
4889
                                go p.cfg.Switch.RemoveLink(msg.cid)
3✔
4890
                                beginNegotiation()
3✔
4891
                        })
3✔
4892
                }
4893

4894
        case *lnwire.ClosingSigned:
3✔
4895
                oClosingSigned, err := chanCloser.ReceiveClosingSigned(*typed)
3✔
4896
                if err != nil {
4✔
4897
                        handleErr(err)
1✔
4898
                        return
1✔
4899
                }
1✔
4900

4901
                oClosingSigned.WhenSome(func(msg lnwire.ClosingSigned) {
6✔
4902
                        p.queueMsg(&msg, nil)
3✔
4903
                })
3✔
4904

4905
        default:
×
4906
                panic("impossible closeMsg type")
×
4907
        }
4908

4909
        // If we haven't finished close negotiations, then we'll continue as we
4910
        // can't yet finalize the closure.
4911
        if _, err := chanCloser.ClosingTx(); err != nil {
6✔
4912
                return
3✔
4913
        }
3✔
4914

4915
        // Otherwise, we've agreed on a closing fee! In this case, we'll wrap up
4916
        // the channel closure by notifying relevant sub-systems and launching a
4917
        // goroutine to wait for close tx conf.
4918
        p.finalizeChanClosure(chanCloser)
3✔
4919
}
4920

4921
// HandleLocalCloseChanReqs accepts a *htlcswitch.ChanClose and passes it onto
4922
// the channelManager goroutine, which will shut down the link and possibly
4923
// close the channel.
4924
func (p *Brontide) HandleLocalCloseChanReqs(req *htlcswitch.ChanClose) {
3✔
4925
        select {
3✔
4926
        case p.localCloseChanReqs <- req:
3✔
4927
                p.log.Info("Local close channel request is going to be " +
3✔
4928
                        "delivered to the peer")
3✔
4929
        case <-p.cg.Done():
×
4930
                p.log.Info("Unable to deliver local close channel request " +
×
4931
                        "to peer")
×
4932
        }
4933
}
4934

4935
// NetAddress returns the network of the remote peer as an lnwire.NetAddress.
4936
func (p *Brontide) NetAddress() *lnwire.NetAddress {
3✔
4937
        return p.cfg.Addr
3✔
4938
}
3✔
4939

4940
// Inbound is a getter for the Brontide's Inbound boolean in cfg.
4941
func (p *Brontide) Inbound() bool {
3✔
4942
        return p.cfg.Inbound
3✔
4943
}
3✔
4944

4945
// ConnReq is a getter for the Brontide's connReq in cfg.
4946
func (p *Brontide) ConnReq() *connmgr.ConnReq {
3✔
4947
        return p.cfg.ConnReq
3✔
4948
}
3✔
4949

4950
// ErrorBuffer is a getter for the Brontide's errorBuffer in cfg.
4951
func (p *Brontide) ErrorBuffer() *queue.CircularBuffer {
3✔
4952
        return p.cfg.ErrorBuffer
3✔
4953
}
3✔
4954

4955
// SetAddress sets the remote peer's address given an address.
4956
func (p *Brontide) SetAddress(address net.Addr) {
×
4957
        p.cfg.Addr.Address = address
×
4958
}
×
4959

4960
// ActiveSignal returns the peer's active signal.
4961
func (p *Brontide) ActiveSignal() chan struct{} {
3✔
4962
        return p.activeSignal
3✔
4963
}
3✔
4964

4965
// Conn returns a pointer to the peer's connection struct.
4966
func (p *Brontide) Conn() net.Conn {
3✔
4967
        return p.cfg.Conn
3✔
4968
}
3✔
4969

4970
// BytesReceived returns the number of bytes received from the peer.
4971
func (p *Brontide) BytesReceived() uint64 {
3✔
4972
        return atomic.LoadUint64(&p.bytesReceived)
3✔
4973
}
3✔
4974

4975
// BytesSent returns the number of bytes sent to the peer.
4976
func (p *Brontide) BytesSent() uint64 {
3✔
4977
        return atomic.LoadUint64(&p.bytesSent)
3✔
4978
}
3✔
4979

4980
// LastRemotePingPayload returns the last payload the remote party sent as part
4981
// of their ping.
4982
func (p *Brontide) LastRemotePingPayload() []byte {
3✔
4983
        pingPayload := p.lastPingPayload.Load()
3✔
4984
        if pingPayload == nil {
6✔
4985
                return []byte{}
3✔
4986
        }
3✔
4987

4988
        pingBytes, ok := pingPayload.(lnwire.PingPayload)
×
4989
        if !ok {
×
4990
                return nil
×
4991
        }
×
4992

4993
        return pingBytes
×
4994
}
4995

4996
// attachChannelEventSubscription creates a channel event subscription and
4997
// attaches to client to Brontide if the reenableTimeout is no greater than 1
4998
// minute.
4999
func (p *Brontide) attachChannelEventSubscription() error {
3✔
5000
        // If the timeout is greater than 1 minute, it's unlikely that the link
3✔
5001
        // hasn't yet finished its reestablishment. Return a nil without
3✔
5002
        // creating the client to specify that we don't want to retry.
3✔
5003
        if p.cfg.ChanActiveTimeout > 1*time.Minute {
6✔
5004
                return nil
3✔
5005
        }
3✔
5006

5007
        // When the reenable timeout is less than 1 minute, it's likely the
5008
        // channel link hasn't finished its reestablishment yet. In that case,
5009
        // we'll give it a second chance by subscribing to the channel update
5010
        // events. Upon receiving the `ActiveLinkEvent`, we'll then request
5011
        // enabling the channel again.
5012
        sub, err := p.cfg.ChannelNotifier.SubscribeChannelEvents()
3✔
5013
        if err != nil {
3✔
5014
                return fmt.Errorf("SubscribeChannelEvents failed: %w", err)
×
5015
        }
×
5016

5017
        p.channelEventClient = sub
3✔
5018

3✔
5019
        return nil
3✔
5020
}
5021

5022
// updateNextRevocation updates the existing channel's next revocation if it's
5023
// nil.
5024
func (p *Brontide) updateNextRevocation(c *channeldb.OpenChannel) error {
3✔
5025
        chanPoint := c.FundingOutpoint
3✔
5026
        chanID := lnwire.NewChanIDFromOutPoint(chanPoint)
3✔
5027

3✔
5028
        // Read the current channel.
3✔
5029
        currentChan, loaded := p.activeChannels.Load(chanID)
3✔
5030

3✔
5031
        // currentChan should exist, but we perform a check anyway to avoid nil
3✔
5032
        // pointer dereference.
3✔
5033
        if !loaded {
3✔
5034
                return fmt.Errorf("missing active channel with chanID=%v",
×
5035
                        chanID)
×
5036
        }
×
5037

5038
        // currentChan should not be nil, but we perform a check anyway to
5039
        // avoid nil pointer dereference.
5040
        if currentChan == nil {
3✔
5041
                return fmt.Errorf("found nil active channel with chanID=%v",
×
5042
                        chanID)
×
5043
        }
×
5044

5045
        // If we're being sent a new channel, and our existing channel doesn't
5046
        // have the next revocation, then we need to update the current
5047
        // existing channel.
5048
        if currentChan.RemoteNextRevocation() != nil {
3✔
5049
                return nil
×
5050
        }
×
5051

5052
        p.log.Infof("Processing retransmitted ChannelReady for "+
3✔
5053
                "ChannelPoint(%v)", chanPoint)
3✔
5054

3✔
5055
        nextRevoke := c.RemoteNextRevocation
3✔
5056

3✔
5057
        err := currentChan.InitNextRevocation(nextRevoke)
3✔
5058
        if err != nil {
3✔
5059
                return fmt.Errorf("unable to init next revocation: %w", err)
×
5060
        }
×
5061

5062
        return nil
3✔
5063
}
5064

5065
// addActiveChannel adds a new active channel to the `activeChannels` map. It
5066
// takes a `channeldb.OpenChannel`, creates a `lnwallet.LightningChannel` from
5067
// it and assembles it with a channel link.
5068
func (p *Brontide) addActiveChannel(c *lnpeer.NewChannel) error {
3✔
5069
        chanPoint := c.FundingOutpoint
3✔
5070
        chanID := lnwire.NewChanIDFromOutPoint(chanPoint)
3✔
5071

3✔
5072
        // If we've reached this point, there are two possible scenarios.  If
3✔
5073
        // the channel was in the active channels map as nil, then it was
3✔
5074
        // loaded from disk and we need to send reestablish. Else, it was not
3✔
5075
        // loaded from disk and we don't need to send reestablish as this is a
3✔
5076
        // fresh channel.
3✔
5077
        shouldReestablish := p.isLoadedFromDisk(chanID)
3✔
5078

3✔
5079
        chanOpts := c.ChanOpts
3✔
5080
        if shouldReestablish {
6✔
5081
                // If we have to do the reestablish dance for this channel,
3✔
5082
                // ensure that we don't try to call InitRemoteMusigNonces twice
3✔
5083
                // by calling SkipNonceInit.
3✔
5084
                chanOpts = append(chanOpts, lnwallet.WithSkipNonceInit())
3✔
5085
        }
3✔
5086

5087
        p.cfg.AuxLeafStore.WhenSome(func(s lnwallet.AuxLeafStore) {
3✔
5088
                chanOpts = append(chanOpts, lnwallet.WithLeafStore(s))
×
5089
        })
×
5090
        p.cfg.AuxSigner.WhenSome(func(s lnwallet.AuxSigner) {
3✔
5091
                chanOpts = append(chanOpts, lnwallet.WithAuxSigner(s))
×
5092
        })
×
5093
        p.cfg.AuxResolver.WhenSome(func(s lnwallet.AuxContractResolver) {
3✔
5094
                chanOpts = append(chanOpts, lnwallet.WithAuxResolver(s))
×
5095
        })
×
5096

5097
        // If not already active, we'll add this channel to the set of active
5098
        // channels, so we can look it up later easily according to its channel
5099
        // ID.
5100
        lnChan, err := lnwallet.NewLightningChannel(
3✔
5101
                p.cfg.Signer, c.OpenChannel, p.cfg.SigPool, chanOpts...,
3✔
5102
        )
3✔
5103
        if err != nil {
3✔
5104
                return fmt.Errorf("unable to create LightningChannel: %w", err)
×
5105
        }
×
5106

5107
        // Store the channel in the activeChannels map.
5108
        p.activeChannels.Store(chanID, lnChan)
3✔
5109

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

3✔
5112
        // Next, we'll assemble a ChannelLink along with the necessary items it
3✔
5113
        // needs to function.
3✔
5114
        chainEvents, err := p.cfg.ChainArb.SubscribeChannelEvents(chanPoint)
3✔
5115
        if err != nil {
3✔
5116
                return fmt.Errorf("unable to subscribe to chain events: %w",
×
5117
                        err)
×
5118
        }
×
5119

5120
        // We'll query the channel DB for the new channel's initial forwarding
5121
        // policies to determine the policy we start out with.
5122
        initialPolicy, err := p.cfg.ChannelDB.GetInitialForwardingPolicy(chanID)
3✔
5123
        if err != nil {
3✔
5124
                return fmt.Errorf("unable to query for initial forwarding "+
×
5125
                        "policy: %v", err)
×
5126
        }
×
5127

5128
        // Create the link and add it to the switch.
5129
        err = p.addLink(
3✔
5130
                &chanPoint, lnChan, initialPolicy, chainEvents,
3✔
5131
                shouldReestablish, fn.None[lnwire.Shutdown](),
3✔
5132
        )
3✔
5133
        if err != nil {
3✔
5134
                return fmt.Errorf("can't register new channel link(%v) with "+
×
5135
                        "peer", chanPoint)
×
5136
        }
×
5137

5138
        // We're using the old co-op close, so we don't need to init the new
5139
        // RBF chan closer.
5140
        if !p.rbfCoopCloseAllowed() {
6✔
5141
                return nil
3✔
5142
        }
3✔
5143

5144
        // Now that the link has been added above, we'll also init an RBF chan
5145
        // closer for this channel, but only if the new close feature is
5146
        // negotiated.
5147
        //
5148
        // Creating this here ensures that any shutdown messages sent will be
5149
        // automatically routed by the msg router.
5150
        if _, err := p.initRbfChanCloser(lnChan); err != nil {
3✔
5151
                p.activeChanCloses.Delete(chanID)
×
5152

×
5153
                return fmt.Errorf("unable to init RBF chan closer for new "+
×
5154
                        "chan: %w", err)
×
5155
        }
×
5156

5157
        return nil
3✔
5158
}
5159

5160
// handleNewActiveChannel handles a `newChannelMsg` request. Depending on we
5161
// know this channel ID or not, we'll either add it to the `activeChannels` map
5162
// or init the next revocation for it.
5163
func (p *Brontide) handleNewActiveChannel(req *newChannelMsg) {
3✔
5164
        newChan := req.channel
3✔
5165
        chanPoint := newChan.FundingOutpoint
3✔
5166
        chanID := lnwire.NewChanIDFromOutPoint(chanPoint)
3✔
5167

3✔
5168
        // Only update RemoteNextRevocation if the channel is in the
3✔
5169
        // activeChannels map and if we added the link to the switch. Only
3✔
5170
        // active channels will be added to the switch.
3✔
5171
        if p.isActiveChannel(chanID) {
6✔
5172
                p.log.Infof("Already have ChannelPoint(%v), ignoring",
3✔
5173
                        chanPoint)
3✔
5174

3✔
5175
                // Handle it and close the err chan on the request.
3✔
5176
                close(req.err)
3✔
5177

3✔
5178
                // Update the next revocation point.
3✔
5179
                err := p.updateNextRevocation(newChan.OpenChannel)
3✔
5180
                if err != nil {
3✔
5181
                        p.log.Errorf(err.Error())
×
5182
                }
×
5183

5184
                return
3✔
5185
        }
5186

5187
        // This is a new channel, we now add it to the map.
5188
        if err := p.addActiveChannel(req.channel); err != nil {
3✔
5189
                // Log and send back the error to the request.
×
5190
                p.log.Errorf(err.Error())
×
5191
                req.err <- err
×
5192

×
5193
                return
×
5194
        }
×
5195

5196
        // Close the err chan if everything went fine.
5197
        close(req.err)
3✔
5198
}
5199

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

3✔
5207
        chanID := req.channelID
3✔
5208

3✔
5209
        // If we already have this channel, something is wrong with the funding
3✔
5210
        // flow as it will only be marked as active after `ChannelReady` is
3✔
5211
        // handled. In this case, we will do nothing but log an error, just in
3✔
5212
        // case this is a legit channel.
3✔
5213
        if p.isActiveChannel(chanID) {
3✔
5214
                p.log.Errorf("Channel(%v) is already active, ignoring "+
×
5215
                        "pending channel request", chanID)
×
5216

×
5217
                return
×
5218
        }
×
5219

5220
        // The channel has already been added, we will do nothing and return.
5221
        if p.isPendingChannel(chanID) {
3✔
5222
                p.log.Infof("Channel(%v) is already added, ignoring "+
×
5223
                        "pending channel request", chanID)
×
5224

×
5225
                return
×
5226
        }
×
5227

5228
        // This is a new channel, we now add it to the map `activeChannels`
5229
        // with nil value and mark it as a newly added channel in
5230
        // `addedChannels`.
5231
        p.activeChannels.Store(chanID, nil)
3✔
5232
        p.addedChannels.Store(chanID, struct{}{})
3✔
5233
}
5234

5235
// handleRemovePendingChannel takes a `newChannelMsg` request and removes it
5236
// from `activeChannels` map. The request will be ignored if the channel is
5237
// considered active by Brontide. Noop if the channel ID cannot be found.
5238
func (p *Brontide) handleRemovePendingChannel(req *newChannelMsg) {
3✔
5239
        defer close(req.err)
3✔
5240

3✔
5241
        chanID := req.channelID
3✔
5242

3✔
5243
        // If we already have this channel, something is wrong with the funding
3✔
5244
        // flow as it will only be marked as active after `ChannelReady` is
3✔
5245
        // handled. In this case, we will log an error and exit.
3✔
5246
        if p.isActiveChannel(chanID) {
3✔
5247
                p.log.Errorf("Channel(%v) is active, ignoring remove request",
×
5248
                        chanID)
×
5249
                return
×
5250
        }
×
5251

5252
        // The channel has not been added yet, we will log a warning as there
5253
        // is an unexpected call from funding manager.
5254
        if !p.isPendingChannel(chanID) {
6✔
5255
                p.log.Warnf("Channel(%v) not found, removing it anyway", chanID)
3✔
5256
        }
3✔
5257

5258
        // Remove the record of this pending channel.
5259
        p.activeChannels.Delete(chanID)
3✔
5260
        p.addedChannels.Delete(chanID)
3✔
5261
}
5262

5263
// sendLinkUpdateMsg sends a message that updates the channel to the
5264
// channel's message stream.
5265
func (p *Brontide) sendLinkUpdateMsg(cid lnwire.ChannelID, msg lnwire.Message) {
3✔
5266
        p.log.Tracef("Sending link update msg=%v", msg.MsgType())
3✔
5267

3✔
5268
        chanStream, ok := p.activeMsgStreams[cid]
3✔
5269
        if !ok {
6✔
5270
                // If a stream hasn't yet been created, then we'll do so, add
3✔
5271
                // it to the map, and finally start it.
3✔
5272
                chanStream = newChanMsgStream(p, cid)
3✔
5273
                p.activeMsgStreams[cid] = chanStream
3✔
5274
                chanStream.Start()
3✔
5275

3✔
5276
                // Stop the stream when quit.
3✔
5277
                go func() {
6✔
5278
                        <-p.cg.Done()
3✔
5279
                        chanStream.Stop()
3✔
5280
                }()
3✔
5281
        }
5282

5283
        // With the stream obtained, add the message to the stream so we can
5284
        // continue processing message.
5285
        chanStream.AddMsg(msg)
3✔
5286
}
5287

5288
// scaleTimeout multiplies the argument duration by a constant factor depending
5289
// on variious heuristics. Currently this is only used to check whether our peer
5290
// appears to be connected over Tor and relaxes the timout deadline. However,
5291
// this is subject to change and should be treated as opaque.
5292
func (p *Brontide) scaleTimeout(timeout time.Duration) time.Duration {
3✔
5293
        if p.isTorConnection {
6✔
5294
                return timeout * time.Duration(torTimeoutMultiplier)
3✔
5295
        }
3✔
5296

5297
        return timeout
×
5298
}
5299

5300
// CoopCloseUpdates is a struct used to communicate updates for an active close
5301
// to the caller.
5302
type CoopCloseUpdates struct {
5303
        UpdateChan chan interface{}
5304

5305
        ErrChan chan error
5306
}
5307

5308
// ChanHasRbfCoopCloser returns true if the channel as identifier by the channel
5309
// point has an active RBF chan closer.
5310
func (p *Brontide) ChanHasRbfCoopCloser(chanPoint wire.OutPoint) bool {
3✔
5311
        chanID := lnwire.NewChanIDFromOutPoint(chanPoint)
3✔
5312
        chanCloser, found := p.activeChanCloses.Load(chanID)
3✔
5313
        if !found {
6✔
5314
                return false
3✔
5315
        }
3✔
5316

5317
        return chanCloser.IsRight()
3✔
5318
}
5319

5320
// TriggerCoopCloseRbfBump given a chan ID, and the params needed to trigger a
5321
// new RBF co-op close update, a bump is attempted. A channel used for updates,
5322
// along with one used to o=communicate any errors is returned. If no chan
5323
// closer is found, then false is returned for the second argument.
5324
func (p *Brontide) TriggerCoopCloseRbfBump(ctx context.Context,
5325
        chanPoint wire.OutPoint, feeRate chainfee.SatPerKWeight,
5326
        deliveryScript lnwire.DeliveryAddress) (*CoopCloseUpdates, error) {
3✔
5327

3✔
5328
        // If RBF coop close isn't permitted, then we'll an error.
3✔
5329
        if !p.rbfCoopCloseAllowed() {
3✔
5330
                return nil, fmt.Errorf("rbf coop close not enabled for " +
×
5331
                        "channel")
×
5332
        }
×
5333

5334
        closeUpdates := &CoopCloseUpdates{
3✔
5335
                UpdateChan: make(chan interface{}, 1),
3✔
5336
                ErrChan:    make(chan error, 1),
3✔
5337
        }
3✔
5338

3✔
5339
        // We'll re-use the existing switch struct here, even though we're
3✔
5340
        // bypassing the switch entirely.
3✔
5341
        closeReq := htlcswitch.ChanClose{
3✔
5342
                CloseType:      contractcourt.CloseRegular,
3✔
5343
                ChanPoint:      &chanPoint,
3✔
5344
                TargetFeePerKw: feeRate,
3✔
5345
                DeliveryScript: deliveryScript,
3✔
5346
                Updates:        closeUpdates.UpdateChan,
3✔
5347
                Err:            closeUpdates.ErrChan,
3✔
5348
                Ctx:            ctx,
3✔
5349
        }
3✔
5350

3✔
5351
        err := p.startRbfChanCloser(newRPCShutdownInit(&closeReq), chanPoint)
3✔
5352
        if err != nil {
3✔
5353
                return nil, err
×
5354
        }
×
5355

5356
        return closeUpdates, nil
3✔
5357
}
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