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

lightningnetwork / lnd / 17830307614

18 Sep 2025 01:29PM UTC coverage: 54.617% (-12.0%) from 66.637%
17830307614

Pull #10200

github

web-flow
Merge 181a0a7bc into b34fc964b
Pull Request #10200: github: change to form-based issue template

109249 of 200028 relevant lines covered (54.62%)

21896.43 hits per line

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

31.21
/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/lightningnetwork/lnd/buffer"
23
        "github.com/lightningnetwork/lnd/chainntnfs"
24
        "github.com/lightningnetwork/lnd/channeldb"
25
        "github.com/lightningnetwork/lnd/channelnotifier"
26
        "github.com/lightningnetwork/lnd/contractcourt"
27
        "github.com/lightningnetwork/lnd/discovery"
28
        "github.com/lightningnetwork/lnd/feature"
29
        "github.com/lightningnetwork/lnd/fn/v2"
30
        "github.com/lightningnetwork/lnd/funding"
31
        graphdb "github.com/lightningnetwork/lnd/graph/db"
32
        "github.com/lightningnetwork/lnd/graph/db/models"
33
        "github.com/lightningnetwork/lnd/htlcswitch"
34
        "github.com/lightningnetwork/lnd/htlcswitch/hodl"
35
        "github.com/lightningnetwork/lnd/htlcswitch/hop"
36
        "github.com/lightningnetwork/lnd/input"
37
        "github.com/lightningnetwork/lnd/invoices"
38
        "github.com/lightningnetwork/lnd/keychain"
39
        "github.com/lightningnetwork/lnd/lnpeer"
40
        "github.com/lightningnetwork/lnd/lntypes"
41
        "github.com/lightningnetwork/lnd/lnutils"
42
        "github.com/lightningnetwork/lnd/lnwallet"
43
        "github.com/lightningnetwork/lnd/lnwallet/chainfee"
44
        "github.com/lightningnetwork/lnd/lnwallet/chancloser"
45
        "github.com/lightningnetwork/lnd/lnwire"
46
        "github.com/lightningnetwork/lnd/msgmux"
47
        "github.com/lightningnetwork/lnd/netann"
48
        "github.com/lightningnetwork/lnd/pool"
49
        "github.com/lightningnetwork/lnd/protofsm"
50
        "github.com/lightningnetwork/lnd/queue"
51
        "github.com/lightningnetwork/lnd/subscribe"
52
        "github.com/lightningnetwork/lnd/ticker"
53
        "github.com/lightningnetwork/lnd/tlv"
54
        "github.com/lightningnetwork/lnd/watchtower/wtclient"
55
)
56

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

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

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

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

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

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

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

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

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

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

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

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

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

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

125
        err chan error
126
}
127

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

523
        pingManager *PingManager
524

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

532
        cfg Config
533

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

632
        startReady chan struct{}
633

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

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

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

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

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

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

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

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

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

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

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

723
                return lastSerializedBlockHeader[:]
×
724
        }
725

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

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

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

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

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

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

771
        return p
25✔
772
}
773

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

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

3✔
786
        p.log.Tracef("starting with conn[%v->%v]",
3✔
787
                p.cfg.Conn.LocalAddr(), p.cfg.Conn.RemoteAddr())
3✔
788

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

800
        if len(activeChans) == 0 {
4✔
801
                go p.cfg.PrunePersistentPeerConnection(p.cfg.PubKeyBytes)
1✔
802
        }
1✔
803

804
        // Quickly check if we have any existing legacy channels with this
805
        // peer.
806
        haveLegacyChan := false
3✔
807
        for _, c := range activeChans {
5✔
808
                if c.ChanType.IsTweakless() {
4✔
809
                        continue
2✔
810
                }
811

812
                haveLegacyChan = true
×
813
                break
×
814
        }
815

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

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

3✔
831
                msg, err := p.readNextMessage()
3✔
832
                if err != nil {
3✔
833
                        readErr <- err
×
834
                        msgChan <- nil
×
835
                        return
×
836
                }
×
837
                readErr <- nil
3✔
838
                msgChan <- msg
3✔
839
        }()
840

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

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

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

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

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

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

894
        p.startTime = time.Now()
3✔
895

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

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

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

918
        p.cg.WgAdd(4)
3✔
919
        go p.queueHandler()
3✔
920
        go p.writeHandler()
3✔
921
        go p.channelManager()
3✔
922
        go p.readHandler()
3✔
923

3✔
924
        // Signal to any external processes that the peer is now active.
3✔
925
        close(p.activeSignal)
3✔
926

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

3✔
942
        return nil
3✔
943
}
944

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

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

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

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

980
// rbfCoopCloseAllowed returns true if both parties have negotiated the new RBF
981
// coop close feature.
982
func (p *Brontide) rbfCoopCloseAllowed() bool {
7✔
983
        bothHaveBit := func(bit lnwire.FeatureBit) bool {
21✔
984
                return p.RemoteFeatures().HasFeature(bit) &&
14✔
985
                        p.LocalFeatures().HasFeature(bit)
14✔
986
        }
14✔
987

988
        return bothHaveBit(lnwire.RbfCoopCloseOptional) ||
7✔
989
                bothHaveBit(lnwire.RbfCoopCloseOptionalStaging)
7✔
990
}
991

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

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

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

1019
        return &chancloser.DeliveryAddrWithKey{
9✔
1020
                DeliveryAddress: deliveryScript,
9✔
1021
                InternalKey: fn.MapOption(
9✔
1022
                        func(desc keychain.KeyDescriptor) btcec.PublicKey {
9✔
1023
                                return *desc.PubKey
×
1024
                        },
×
1025
                )(internalKeyDesc),
1026
        }, nil
1027
}
1028

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

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

3✔
1040
        scidAliasNegotiated := p.hasNegotiatedScidAlias()
3✔
1041

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

1062
                                err = p.cfg.AddLocalAlias(
×
1063
                                        aliasScid, dbChan.ShortChanID(), false,
×
1064
                                        false,
×
1065
                                )
×
1066
                                if err != nil {
×
1067
                                        return nil, err
×
1068
                                }
×
1069

1070
                                chanID := lnwire.NewChanIDFromOutPoint(
×
1071
                                        dbChan.FundingOutpoint,
×
1072
                                )
×
1073

×
1074
                                // Fetch the second commitment point to send in
×
1075
                                // the channel_ready message.
×
1076
                                second, err := dbChan.SecondCommitmentPoint()
×
1077
                                if err != nil {
×
1078
                                        return nil, err
×
1079
                                }
×
1080

1081
                                channelReadyMsg := lnwire.NewChannelReady(
×
1082
                                        chanID, second,
×
1083
                                )
×
1084
                                channelReadyMsg.AliasScid = &aliasScid
×
1085

×
1086
                                msgs = append(msgs, channelReadyMsg)
×
1087
                        }
1088

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

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

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

1123
                chanPoint := dbChan.FundingOutpoint
2✔
1124

2✔
1125
                chanID := lnwire.NewChanIDFromOutPoint(chanPoint)
2✔
1126

2✔
1127
                p.log.Infof("Loading ChannelPoint(%v), isPending=%v",
2✔
1128
                        chanPoint, lnChan.IsPending())
2✔
1129

2✔
1130
                // Skip adding any permanently irreconcilable channels to the
2✔
1131
                // htlcswitch.
2✔
1132
                if !dbChan.HasChanStatus(channeldb.ChanStatusDefault) &&
2✔
1133
                        !dbChan.HasChanStatus(channeldb.ChanStatusRestored) {
4✔
1134

2✔
1135
                        p.log.Warnf("ChannelPoint(%v) has status %v, won't "+
2✔
1136
                                "start.", chanPoint, dbChan.ChanStatus())
2✔
1137

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

1152
                        msgs = append(msgs, chanSync)
2✔
1153

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

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

1169
                                if shutdownMsg == nil {
×
1170
                                        continue
×
1171
                                }
1172

1173
                                // Append the message to the set of messages to
1174
                                // send.
1175
                                msgs = append(msgs, shutdownMsg)
×
1176
                        }
1177

1178
                        continue
2✔
1179
                }
1180

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

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

×
1203
                        selfPolicy = p1
×
1204
                } else {
×
1205
                        selfPolicy = p2
×
1206
                }
×
1207

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

1231
                p.log.Tracef("Using link policy of: %v",
×
1232
                        lnutils.SpewLogClosure(forwardingPolicy))
×
1233

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

×
1243
                        continue
×
1244
                }
1245

1246
                shutdownInfo, err := lnChan.State().ShutdownInfo()
×
1247
                if err != nil && !errors.Is(err, channeldb.ErrNoShutdownInfo) {
×
1248
                        return nil, err
×
1249
                }
×
1250

1251
                isTaprootChan := lnChan.ChanType().IsTaproot()
×
1252

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

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

×
1273
                                return
×
1274
                        }
×
1275

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

×
1292
                                return
×
1293
                        }
×
1294

1295
                        chanID := lnwire.NewChanIDFromOutPoint(
×
1296
                                lnChan.State().FundingOutpoint,
×
1297
                        )
×
1298

×
1299
                        p.activeChanCloses.Store(chanID, makeNegotiateCloser(
×
1300
                                negotiateChanCloser,
×
1301
                        ))
×
1302

×
1303
                        // Create the Shutdown message.
×
1304
                        shutdown, err := negotiateChanCloser.ShutdownChan()
×
1305
                        if err != nil {
×
1306
                                p.activeChanCloses.Delete(chanID)
×
1307
                                shutdownInfoErr = err
×
1308

×
1309
                                return
×
1310
                        }
×
1311

1312
                        shutdownMsg = fn.Some(*shutdown)
×
1313
                })
1314
                if shutdownInfoErr != nil {
×
1315
                        return nil, shutdownInfoErr
×
1316
                }
×
1317

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

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

1335
                p.activeChannels.Store(chanID, lnChan)
×
1336

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

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

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

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

1374
        return msgs, nil
3✔
1375
}
1376

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

×
1384
        // onChannelFailure will be called by the link in case the channel
×
1385
        // fails for some reason.
×
1386
        onChannelFailure := func(chanID lnwire.ChannelID,
×
1387
                shortChanID lnwire.ShortChannelID,
×
1388
                linkErr htlcswitch.LinkFailureError) {
×
1389

×
1390
                failure := linkFailureReport{
×
1391
                        chanPoint:   *chanPoint,
×
1392
                        chanID:      chanID,
×
1393
                        shortChanID: shortChanID,
×
1394
                        linkErr:     linkErr,
×
1395
                }
×
1396

×
1397
                select {
×
1398
                case p.linkFailures <- failure:
×
1399
                case <-p.cg.Done():
×
1400
                case <-p.cfg.Quit:
×
1401
                }
1402
        }
1403

1404
        updateContractSignals := func(signals *contractcourt.ContractSignals) error {
×
1405
                return p.cfg.ChainArb.UpdateContractSignals(*chanPoint, signals)
×
1406
        }
×
1407

1408
        notifyContractUpdate := func(update *contractcourt.ContractUpdate) error {
×
1409
                return p.cfg.ChainArb.NotifyContractUpdate(*chanPoint, update)
×
1410
        }
×
1411

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

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

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

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

3✔
1479
        hasConfirmedPublicChan := false
3✔
1480
        for _, channel := range channels {
5✔
1481
                if channel.IsPending {
2✔
1482
                        continue
×
1483
                }
1484
                if channel.ChannelFlags&lnwire.FFAnnounceChannel == 0 {
4✔
1485
                        continue
2✔
1486
                }
1487

1488
                hasConfirmedPublicChan = true
×
1489
                break
×
1490
        }
1491
        if !hasConfirmedPublicChan {
6✔
1492
                return
3✔
1493
        }
3✔
1494

1495
        ourNodeAnn, err := p.cfg.GenNodeAnnouncement()
×
1496
        if err != nil {
×
1497
                p.log.Debugf("Unable to retrieve node announcement: %v", err)
×
1498
                return
×
1499
        }
×
1500

1501
        if err := p.SendMessageLazy(false, &ourNodeAnn); err != nil {
×
1502
                p.log.Debugf("Unable to resend node announcement: %v", err)
×
1503
        }
×
1504
}
1505

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

3✔
1511
        // If we don't have any active channels, then we can exit early.
3✔
1512
        if p.activeChannels.Len() == 0 {
4✔
1513
                return
1✔
1514
        }
1✔
1515

1516
        maybeSendUpd := func(cid lnwire.ChannelID,
2✔
1517
                lnChan *lnwallet.LightningChannel) error {
4✔
1518

2✔
1519
                // Nil channels are pending, so we'll skip them.
2✔
1520
                if lnChan == nil {
2✔
1521
                        return nil
×
1522
                }
×
1523

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

1532
                        // Otherwise, we can use the normal scid.
1533
                        default:
2✔
1534
                                return dbChan.ShortChanID()
2✔
1535
                        }
1536
                }()
1537

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

×
1548
                        return nil
×
1549
                }
×
1550

1551
                p.log.Debugf("Sending channel update for ChannelPoint(%v), "+
2✔
1552
                        "scid=%v", dbChan.FundingOutpoint, dbChan.ShortChanID)
2✔
1553

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

×
1563
                        return err
×
1564
                }
×
1565

1566
                return nil
2✔
1567
        }
1568

1569
        p.activeChannels.ForEach(maybeSendUpd)
2✔
1570
}
1571

1572
// WaitForDisconnect waits until the peer has disconnected. A peer may be
1573
// disconnected if the local or remote side terminates the connection, or an
1574
// irrecoverable protocol error has been encountered. This method will only
1575
// begin watching the peer's waitgroup after the ready channel or the peer's
1576
// quit channel are signaled. The ready channel should only be signaled if a
1577
// call to Start returns no error. Otherwise, if the peer fails to start,
1578
// calling Disconnect will signal the quit channel and the method will not
1579
// block, since no goroutines were spawned.
1580
func (p *Brontide) WaitForDisconnect(ready chan struct{}) {
×
1581
        // Before we try to call the `Wait` goroutine, we'll make sure the main
×
1582
        // set of goroutines are already active.
×
1583
        select {
×
1584
        case <-p.startReady:
×
1585
        case <-p.cg.Done():
×
1586
                return
×
1587
        }
1588

1589
        select {
×
1590
        case <-ready:
×
1591
        case <-p.cg.Done():
×
1592
        }
1593

1594
        p.cg.WgWait()
×
1595
}
1596

1597
// Disconnect terminates the connection with the remote peer. Additionally, a
1598
// signal is sent to the server and htlcSwitch indicating the resources
1599
// allocated to the peer can now be cleaned up.
1600
//
1601
// NOTE: Be aware that this method will block if the peer is still starting up.
1602
// Therefore consider starting it in a goroutine if you cannot guarantee that
1603
// the peer has finished starting up before calling this method.
1604
func (p *Brontide) Disconnect(reason error) {
×
1605
        if !atomic.CompareAndSwapInt32(&p.disconnect, 0, 1) {
×
1606
                return
×
1607
        }
×
1608

1609
        // Make sure initialization has completed before we try to tear things
1610
        // down.
1611
        //
1612
        // NOTE: We only read the `startReady` chan if the peer has been
1613
        // started, otherwise we will skip reading it as this chan won't be
1614
        // closed, hence blocks forever.
1615
        if atomic.LoadInt32(&p.started) == 1 {
×
1616
                p.log.Debugf("Peer hasn't finished starting up yet, waiting " +
×
1617
                        "on startReady signal before closing connection")
×
1618

×
1619
                select {
×
1620
                case <-p.startReady:
×
1621
                case <-p.cg.Done():
×
1622
                        return
×
1623
                }
1624
        }
1625

1626
        err := fmt.Errorf("disconnecting %s, reason: %v", p, reason)
×
1627
        p.storeError(err)
×
1628

×
1629
        p.log.Infof(err.Error())
×
1630

×
1631
        // Stop PingManager before closing TCP connection.
×
1632
        p.pingManager.Stop()
×
1633

×
1634
        // Ensure that the TCP connection is properly closed before continuing.
×
1635
        p.cfg.Conn.Close()
×
1636

×
1637
        p.cg.Quit()
×
1638

×
1639
        // If our msg router isn't global (local to this instance), then we'll
×
1640
        // stop it. Otherwise, we'll leave it running.
×
1641
        if !p.globalMsgRouter {
×
1642
                p.msgRouter.WhenSome(func(router msgmux.Router) {
×
1643
                        router.Stop()
×
1644
                })
×
1645
        }
1646
}
1647

1648
// String returns the string representation of this peer.
1649
func (p *Brontide) String() string {
×
1650
        return fmt.Sprintf("%x@%s", p.cfg.PubKeyBytes, p.cfg.Conn.RemoteAddr())
×
1651
}
×
1652

1653
// readNextMessage reads, and returns the next message on the wire along with
1654
// any additional raw payload.
1655
func (p *Brontide) readNextMessage() (lnwire.Message, error) {
7✔
1656
        noiseConn := p.cfg.Conn
7✔
1657
        err := noiseConn.SetReadDeadline(time.Time{})
7✔
1658
        if err != nil {
7✔
1659
                return nil, err
×
1660
        }
×
1661

1662
        pktLen, err := noiseConn.ReadNextHeader()
7✔
1663
        if err != nil {
7✔
1664
                return nil, fmt.Errorf("read next header: %w", err)
×
1665
        }
×
1666

1667
        // First we'll read the next _full_ message. We do this rather than
1668
        // reading incrementally from the stream as the Lightning wire protocol
1669
        // is message oriented and allows nodes to pad on additional data to
1670
        // the message stream.
1671
        var (
4✔
1672
                nextMsg lnwire.Message
4✔
1673
                msgLen  uint64
4✔
1674
        )
4✔
1675
        err = p.cfg.ReadPool.Submit(func(buf *buffer.Read) error {
8✔
1676
                // Before reading the body of the message, set the read timeout
4✔
1677
                // accordingly to ensure we don't block other readers using the
4✔
1678
                // pool. We do so only after the task has been scheduled to
4✔
1679
                // ensure the deadline doesn't expire while the message is in
4✔
1680
                // the process of being scheduled.
4✔
1681
                readDeadline := time.Now().Add(
4✔
1682
                        p.scaleTimeout(readMessageTimeout),
4✔
1683
                )
4✔
1684
                readErr := noiseConn.SetReadDeadline(readDeadline)
4✔
1685
                if readErr != nil {
4✔
1686
                        return readErr
×
1687
                }
×
1688

1689
                // The ReadNextBody method will actually end up re-using the
1690
                // buffer, so within this closure, we can continue to use
1691
                // rawMsg as it's just a slice into the buf from the buffer
1692
                // pool.
1693
                rawMsg, readErr := noiseConn.ReadNextBody(buf[:pktLen])
4✔
1694
                if readErr != nil {
4✔
1695
                        return fmt.Errorf("read next body: %w", readErr)
×
1696
                }
×
1697
                msgLen = uint64(len(rawMsg))
4✔
1698

4✔
1699
                // Next, create a new io.Reader implementation from the raw
4✔
1700
                // message, and use this to decode the message directly from.
4✔
1701
                msgReader := bytes.NewReader(rawMsg)
4✔
1702
                nextMsg, err = lnwire.ReadMessage(msgReader, 0)
4✔
1703
                if err != nil {
4✔
1704
                        return err
×
1705
                }
×
1706

1707
                // At this point, rawMsg and buf will be returned back to the
1708
                // buffer pool for re-use.
1709
                return nil
4✔
1710
        })
1711
        atomic.AddUint64(&p.bytesReceived, msgLen)
4✔
1712
        if err != nil {
4✔
1713
                return nil, err
×
1714
        }
×
1715

1716
        p.logWireMessage(nextMsg, true)
4✔
1717

4✔
1718
        return nextMsg, nil
4✔
1719
}
1720

1721
// msgStream implements a goroutine-safe, in-order stream of messages to be
1722
// delivered via closure to a receiver. These messages MUST be in order due to
1723
// the nature of the lightning channel commitment and gossiper state machines.
1724
// TODO(conner): use stream handler interface to abstract out stream
1725
// state/logging.
1726
type msgStream struct {
1727
        streamShutdown int32 // To be used atomically.
1728

1729
        peer *Brontide
1730

1731
        apply func(lnwire.Message)
1732

1733
        startMsg string
1734
        stopMsg  string
1735

1736
        msgCond *sync.Cond
1737
        msgs    []lnwire.Message
1738

1739
        mtx sync.Mutex
1740

1741
        producerSema chan struct{}
1742

1743
        wg   sync.WaitGroup
1744
        quit chan struct{}
1745
}
1746

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

3✔
1755
        stream := &msgStream{
3✔
1756
                peer:         p,
3✔
1757
                apply:        apply,
3✔
1758
                startMsg:     startMsg,
3✔
1759
                stopMsg:      stopMsg,
3✔
1760
                producerSema: make(chan struct{}, bufSize),
3✔
1761
                quit:         make(chan struct{}),
3✔
1762
        }
3✔
1763
        stream.msgCond = sync.NewCond(&stream.mtx)
3✔
1764

3✔
1765
        // Before we return the active stream, we'll populate the producer's
3✔
1766
        // semaphore channel. We'll use this to ensure that the producer won't
3✔
1767
        // attempt to allocate memory in the queue for an item until it has
3✔
1768
        // sufficient extra space.
3✔
1769
        for i := uint32(0); i < bufSize; i++ {
153✔
1770
                stream.producerSema <- struct{}{}
150✔
1771
        }
150✔
1772

1773
        return stream
3✔
1774
}
1775

1776
// Start starts the chanMsgStream.
1777
func (ms *msgStream) Start() {
3✔
1778
        ms.wg.Add(1)
3✔
1779
        go ms.msgConsumer()
3✔
1780
}
3✔
1781

1782
// Stop stops the chanMsgStream.
1783
func (ms *msgStream) Stop() {
×
1784
        // TODO(roasbeef): signal too?
×
1785

×
1786
        close(ms.quit)
×
1787

×
1788
        // Now that we've closed the channel, we'll repeatedly signal the msg
×
1789
        // consumer until we've detected that it has exited.
×
1790
        for atomic.LoadInt32(&ms.streamShutdown) == 0 {
×
1791
                ms.msgCond.Signal()
×
1792
                time.Sleep(time.Millisecond * 100)
×
1793
        }
×
1794

1795
        ms.wg.Wait()
×
1796
}
1797

1798
// msgConsumer is the main goroutine that streams messages from the peer's
1799
// readHandler directly to the target channel.
1800
func (ms *msgStream) msgConsumer() {
3✔
1801
        defer ms.wg.Done()
3✔
1802
        defer peerLog.Tracef(ms.stopMsg)
3✔
1803
        defer atomic.StoreInt32(&ms.streamShutdown, 1)
3✔
1804

3✔
1805
        peerLog.Tracef(ms.startMsg)
3✔
1806

3✔
1807
        for {
6✔
1808
                // First, we'll check our condition. If the queue of messages
3✔
1809
                // is empty, then we'll wait until a new item is added.
3✔
1810
                ms.msgCond.L.Lock()
3✔
1811
                for len(ms.msgs) == 0 {
6✔
1812
                        ms.msgCond.Wait()
3✔
1813

3✔
1814
                        // If we woke up in order to exit, then we'll do so.
3✔
1815
                        // Otherwise, we'll check the message queue for any new
3✔
1816
                        // items.
3✔
1817
                        select {
3✔
1818
                        case <-ms.peer.cg.Done():
×
1819
                                ms.msgCond.L.Unlock()
×
1820
                                return
×
1821
                        case <-ms.quit:
×
1822
                                ms.msgCond.L.Unlock()
×
1823
                                return
×
1824
                        default:
×
1825
                        }
1826
                }
1827

1828
                // Grab the message off the front of the queue, shifting the
1829
                // slice's reference down one in order to remove the message
1830
                // from the queue.
1831
                msg := ms.msgs[0]
×
1832
                ms.msgs[0] = nil // Set to nil to prevent GC leak.
×
1833
                ms.msgs = ms.msgs[1:]
×
1834

×
1835
                ms.msgCond.L.Unlock()
×
1836

×
1837
                ms.apply(msg)
×
1838

×
1839
                // We've just successfully processed an item, so we'll signal
×
1840
                // to the producer that a new slot in the buffer. We'll use
×
1841
                // this to bound the size of the buffer to avoid allowing it to
×
1842
                // grow indefinitely.
×
1843
                select {
×
1844
                case ms.producerSema <- struct{}{}:
×
1845
                case <-ms.peer.cg.Done():
×
1846
                        return
×
1847
                case <-ms.quit:
×
1848
                        return
×
1849
                }
1850
        }
1851
}
1852

1853
// AddMsg adds a new message to the msgStream. This function is safe for
1854
// concurrent access.
1855
func (ms *msgStream) AddMsg(msg lnwire.Message) {
×
1856
        // First, we'll attempt to receive from the producerSema struct. This
×
1857
        // acts as a semaphore to prevent us from indefinitely buffering
×
1858
        // incoming items from the wire. Either the msg queue isn't full, and
×
1859
        // we'll not block, or the queue is full, and we'll block until either
×
1860
        // we're signalled to quit, or a slot is freed up.
×
1861
        select {
×
1862
        case <-ms.producerSema:
×
1863
        case <-ms.peer.cg.Done():
×
1864
                return
×
1865
        case <-ms.quit:
×
1866
                return
×
1867
        }
1868

1869
        // Next, we'll lock the condition, and add the message to the end of
1870
        // the message queue.
1871
        ms.msgCond.L.Lock()
×
1872
        ms.msgs = append(ms.msgs, msg)
×
1873
        ms.msgCond.L.Unlock()
×
1874

×
1875
        // With the message added, we signal to the msgConsumer that there are
×
1876
        // additional messages to consume.
×
1877
        ms.msgCond.Signal()
×
1878
}
1879

1880
// waitUntilLinkActive waits until the target link is active and returns a
1881
// ChannelLink to pass messages to. It accomplishes this by subscribing to
1882
// an ActiveLinkEvent which is emitted by the link when it first starts up.
1883
func waitUntilLinkActive(p *Brontide,
1884
        cid lnwire.ChannelID) htlcswitch.ChannelUpdateHandler {
×
1885

×
1886
        p.log.Tracef("Waiting for link=%v to be active", cid)
×
1887

×
1888
        // Subscribe to receive channel events.
×
1889
        //
×
1890
        // NOTE: If the link is already active by SubscribeChannelEvents, then
×
1891
        // GetLink will retrieve the link and we can send messages. If the link
×
1892
        // becomes active between SubscribeChannelEvents and GetLink, then GetLink
×
1893
        // will retrieve the link. If the link becomes active after GetLink, then
×
1894
        // we will get an ActiveLinkEvent notification and retrieve the link. If
×
1895
        // the call to GetLink is before SubscribeChannelEvents, however, there
×
1896
        // will be a race condition.
×
1897
        sub, err := p.cfg.ChannelNotifier.SubscribeChannelEvents()
×
1898
        if err != nil {
×
1899
                // If we have a non-nil error, then the server is shutting down and we
×
1900
                // can exit here and return nil. This means no message will be delivered
×
1901
                // to the link.
×
1902
                return nil
×
1903
        }
×
1904
        defer sub.Cancel()
×
1905

×
1906
        // The link may already be active by this point, and we may have missed the
×
1907
        // ActiveLinkEvent. Check if the link exists.
×
1908
        link := p.fetchLinkFromKeyAndCid(cid)
×
1909
        if link != nil {
×
1910
                return link
×
1911
        }
×
1912

1913
        // If the link is nil, we must wait for it to be active.
1914
        for {
×
1915
                select {
×
1916
                // A new event has been sent by the ChannelNotifier. We first check
1917
                // whether the event is an ActiveLinkEvent. If it is, we'll check
1918
                // that the event is for this channel. Otherwise, we discard the
1919
                // message.
1920
                case e := <-sub.Updates():
×
1921
                        event, ok := e.(channelnotifier.ActiveLinkEvent)
×
1922
                        if !ok {
×
1923
                                // Ignore this notification.
×
1924
                                continue
×
1925
                        }
1926

1927
                        chanPoint := event.ChannelPoint
×
1928

×
1929
                        // Check whether the retrieved chanPoint matches the target
×
1930
                        // channel id.
×
1931
                        if !cid.IsChanPoint(chanPoint) {
×
1932
                                continue
×
1933
                        }
1934

1935
                        // The link shouldn't be nil as we received an
1936
                        // ActiveLinkEvent. If it is nil, we return nil and the
1937
                        // calling function should catch it.
1938
                        return p.fetchLinkFromKeyAndCid(cid)
×
1939

1940
                case <-p.cg.Done():
×
1941
                        return nil
×
1942
                }
1943
        }
1944
}
1945

1946
// newChanMsgStream is used to create a msgStream between the peer and
1947
// particular channel link in the htlcswitch. We utilize additional
1948
// synchronization with the fundingManager to ensure we don't attempt to
1949
// dispatch a message to a channel before it is fully active. A reference to the
1950
// channel this stream forwards to is held in scope to prevent unnecessary
1951
// lookups.
1952
func newChanMsgStream(p *Brontide, cid lnwire.ChannelID) *msgStream {
×
1953
        var chanLink htlcswitch.ChannelUpdateHandler
×
1954

×
1955
        apply := func(msg lnwire.Message) {
×
1956
                // This check is fine because if the link no longer exists, it will
×
1957
                // be removed from the activeChannels map and subsequent messages
×
1958
                // shouldn't reach the chan msg stream.
×
1959
                if chanLink == nil {
×
1960
                        chanLink = waitUntilLinkActive(p, cid)
×
1961

×
1962
                        // If the link is still not active and the calling function
×
1963
                        // errored out, just return.
×
1964
                        if chanLink == nil {
×
1965
                                p.log.Warnf("Link=%v is not active", cid)
×
1966
                                return
×
1967
                        }
×
1968
                }
1969

1970
                // In order to avoid unnecessarily delivering message
1971
                // as the peer is exiting, we'll check quickly to see
1972
                // if we need to exit.
1973
                select {
×
1974
                case <-p.cg.Done():
×
1975
                        return
×
1976
                default:
×
1977
                }
1978

1979
                chanLink.HandleChannelUpdate(msg)
×
1980
        }
1981

1982
        return newMsgStream(p,
×
1983
                fmt.Sprintf("Update stream for ChannelID(%x) created", cid[:]),
×
1984
                fmt.Sprintf("Update stream for ChannelID(%x) exiting", cid[:]),
×
1985
                msgStreamSize,
×
1986
                apply,
×
1987
        )
×
1988
}
1989

1990
// newDiscMsgStream is used to setup a msgStream between the peer and the
1991
// authenticated gossiper. This stream should be used to forward all remote
1992
// channel announcements.
1993
func newDiscMsgStream(p *Brontide) *msgStream {
3✔
1994
        apply := func(msg lnwire.Message) {
3✔
1995
                // TODO(elle): thread contexts through the peer system properly
×
1996
                // so that a parent context can be passed in here.
×
1997
                ctx := context.TODO()
×
1998

×
1999
                // Processing here means we send it to the gossiper which then
×
2000
                // decides whether this message is processed immediately or
×
2001
                // waits for dependent messages to be processed. It can also
×
2002
                // happen that the message is not processed at all if it is
×
2003
                // premature and the LRU cache fills up and the message is
×
2004
                // deleted.
×
2005
                p.log.Debugf("Processing remote msg %T", msg)
×
2006

×
2007
                // TODO(ziggie): ProcessRemoteAnnouncement returns an error
×
2008
                // channel, but we cannot rely on it being written to.
×
2009
                // Because some messages might never be processed (e.g.
×
2010
                // premature channel updates). We should change the design here
×
2011
                // and use the actor model pattern as soon as it is available.
×
2012
                // So for now we should NOT use the error channel.
×
2013
                // See https://github.com/lightningnetwork/lnd/pull/9820.
×
2014
                p.cfg.AuthGossiper.ProcessRemoteAnnouncement(ctx, msg, p)
×
2015
        }
×
2016

2017
        return newMsgStream(
3✔
2018
                p,
3✔
2019
                "Update stream for gossiper created",
3✔
2020
                "Update stream for gossiper exited",
3✔
2021
                msgStreamSize,
3✔
2022
                apply,
3✔
2023
        )
3✔
2024
}
2025

2026
// readHandler is responsible for reading messages off the wire in series, then
2027
// properly dispatching the handling of the message to the proper subsystem.
2028
//
2029
// NOTE: This method MUST be run as a goroutine.
2030
func (p *Brontide) readHandler() {
3✔
2031
        defer p.cg.WgDone()
3✔
2032

3✔
2033
        // We'll stop the timer after a new messages is received, and also
3✔
2034
        // reset it after we process the next message.
3✔
2035
        idleTimer := time.AfterFunc(idleTimeout, func() {
3✔
2036
                err := fmt.Errorf("peer %s no answer for %s -- disconnecting",
×
2037
                        p, idleTimeout)
×
2038
                p.Disconnect(err)
×
2039
        })
×
2040

2041
        // Initialize our negotiated gossip sync method before reading messages
2042
        // off the wire. When using gossip queries, this ensures a gossip
2043
        // syncer is active by the time query messages arrive.
2044
        //
2045
        // TODO(conner): have peer store gossip syncer directly and bypass
2046
        // gossiper?
2047
        p.initGossipSync()
3✔
2048

3✔
2049
        discStream := newDiscMsgStream(p)
3✔
2050
        discStream.Start()
3✔
2051
        defer discStream.Stop()
3✔
2052
out:
3✔
2053
        for atomic.LoadInt32(&p.disconnect) == 0 {
7✔
2054
                nextMsg, err := p.readNextMessage()
4✔
2055
                if !idleTimer.Stop() {
4✔
2056
                        select {
×
2057
                        case <-idleTimer.C:
×
2058
                        default:
×
2059
                        }
2060
                }
2061
                if err != nil {
1✔
2062
                        p.log.Infof("unable to read message from peer: %v", err)
×
2063

×
2064
                        // If we could not read our peer's message due to an
×
2065
                        // unknown type or invalid alias, we continue processing
×
2066
                        // as normal. We store unknown message and address
×
2067
                        // types, as they may provide debugging insight.
×
2068
                        switch e := err.(type) {
×
2069
                        // If this is just a message we don't yet recognize,
2070
                        // we'll continue processing as normal as this allows
2071
                        // us to introduce new messages in a forwards
2072
                        // compatible manner.
2073
                        case *lnwire.UnknownMessage:
×
2074
                                p.storeError(e)
×
2075
                                idleTimer.Reset(idleTimeout)
×
2076
                                continue
×
2077

2078
                        // If they sent us an address type that we don't yet
2079
                        // know of, then this isn't a wire error, so we'll
2080
                        // simply continue parsing the remainder of their
2081
                        // messages.
2082
                        case *lnwire.ErrUnknownAddrType:
×
2083
                                p.storeError(e)
×
2084
                                idleTimer.Reset(idleTimeout)
×
2085
                                continue
×
2086

2087
                        // If the NodeAnnouncement has an invalid alias, then
2088
                        // we'll log that error above and continue so we can
2089
                        // continue to read messages from the peer. We do not
2090
                        // store this error because it is of little debugging
2091
                        // value.
2092
                        case *lnwire.ErrInvalidNodeAlias:
×
2093
                                idleTimer.Reset(idleTimeout)
×
2094
                                continue
×
2095

2096
                        // If the error we encountered wasn't just a message we
2097
                        // didn't recognize, then we'll stop all processing as
2098
                        // this is a fatal error.
2099
                        default:
×
2100
                                break out
×
2101
                        }
2102
                }
2103

2104
                // If a message router is active, then we'll try to have it
2105
                // handle this message. If it can, then we're able to skip the
2106
                // rest of the message handling logic.
2107
                err = fn.MapOptionZ(p.msgRouter, func(r msgmux.Router) error {
2✔
2108
                        return r.RouteMsg(msgmux.PeerMsg{
1✔
2109
                                PeerPub: *p.IdentityKey(),
1✔
2110
                                Message: nextMsg,
1✔
2111
                        })
1✔
2112
                })
1✔
2113

2114
                // No error occurred, and the message was handled by the
2115
                // router.
2116
                if err == nil {
1✔
2117
                        continue
×
2118
                }
2119

2120
                var (
1✔
2121
                        targetChan   lnwire.ChannelID
1✔
2122
                        isLinkUpdate bool
1✔
2123
                )
1✔
2124

1✔
2125
                switch msg := nextMsg.(type) {
1✔
2126
                case *lnwire.Pong:
×
2127
                        // When we receive a Pong message in response to our
×
2128
                        // last ping message, we send it to the pingManager
×
2129
                        p.pingManager.ReceivedPong(msg)
×
2130

2131
                case *lnwire.Ping:
×
2132
                        // First, we'll store their latest ping payload within
×
2133
                        // the relevant atomic variable.
×
2134
                        p.lastPingPayload.Store(msg.PaddingBytes[:])
×
2135

×
2136
                        // Next, we'll send over the amount of specified pong
×
2137
                        // bytes.
×
2138
                        pong := lnwire.NewPong(p.cfg.PongBuf[0:msg.NumPongBytes])
×
2139
                        p.queueMsg(pong, nil)
×
2140

2141
                case *lnwire.OpenChannel,
2142
                        *lnwire.AcceptChannel,
2143
                        *lnwire.FundingCreated,
2144
                        *lnwire.FundingSigned,
2145
                        *lnwire.ChannelReady:
×
2146

×
2147
                        p.cfg.FundingManager.ProcessFundingMsg(msg, p)
×
2148

2149
                case *lnwire.Shutdown:
×
2150
                        select {
×
2151
                        case p.chanCloseMsgs <- &closeMsg{msg.ChannelID, msg}:
×
2152
                        case <-p.cg.Done():
×
2153
                                break out
×
2154
                        }
2155
                case *lnwire.ClosingSigned:
×
2156
                        select {
×
2157
                        case p.chanCloseMsgs <- &closeMsg{msg.ChannelID, msg}:
×
2158
                        case <-p.cg.Done():
×
2159
                                break out
×
2160
                        }
2161

2162
                case *lnwire.Warning:
×
2163
                        targetChan = msg.ChanID
×
2164
                        isLinkUpdate = p.handleWarningOrError(targetChan, msg)
×
2165

2166
                case *lnwire.Error:
×
2167
                        targetChan = msg.ChanID
×
2168
                        isLinkUpdate = p.handleWarningOrError(targetChan, msg)
×
2169

2170
                case *lnwire.ChannelReestablish:
×
2171
                        targetChan = msg.ChanID
×
2172
                        isLinkUpdate = p.hasChannel(targetChan)
×
2173

×
2174
                        // If we failed to find the link in question, and the
×
2175
                        // message received was a channel sync message, then
×
2176
                        // this might be a peer trying to resync closed channel.
×
2177
                        // In this case we'll try to resend our last channel
×
2178
                        // sync message, such that the peer can recover funds
×
2179
                        // from the closed channel.
×
2180
                        if !isLinkUpdate {
×
2181
                                err := p.resendChanSyncMsg(targetChan)
×
2182
                                if err != nil {
×
2183
                                        // TODO(halseth): send error to peer?
×
2184
                                        p.log.Errorf("resend failed: %v",
×
2185
                                                err)
×
2186
                                }
×
2187
                        }
2188

2189
                // For messages that implement the LinkUpdater interface, we
2190
                // will consider them as link updates and send them to
2191
                // chanStream. These messages will be queued inside chanStream
2192
                // if the channel is not active yet.
2193
                case lnwire.LinkUpdater:
×
2194
                        targetChan = msg.TargetChanID()
×
2195
                        isLinkUpdate = p.hasChannel(targetChan)
×
2196

×
2197
                        // Log an error if we don't have this channel. This
×
2198
                        // means the peer has sent us a message with unknown
×
2199
                        // channel ID.
×
2200
                        if !isLinkUpdate {
×
2201
                                p.log.Errorf("Unknown channel ID: %v found "+
×
2202
                                        "in received msg=%s", targetChan,
×
2203
                                        nextMsg.MsgType())
×
2204
                        }
×
2205

2206
                case *lnwire.ChannelUpdate1,
2207
                        *lnwire.ChannelAnnouncement1,
2208
                        *lnwire.NodeAnnouncement,
2209
                        *lnwire.AnnounceSignatures1,
2210
                        *lnwire.GossipTimestampRange,
2211
                        *lnwire.QueryShortChanIDs,
2212
                        *lnwire.QueryChannelRange,
2213
                        *lnwire.ReplyChannelRange,
2214
                        *lnwire.ReplyShortChanIDsEnd:
×
2215

×
2216
                        discStream.AddMsg(msg)
×
2217

2218
                case *lnwire.Custom:
1✔
2219
                        err := p.handleCustomMessage(msg)
1✔
2220
                        if err != nil {
1✔
2221
                                p.storeError(err)
×
2222
                                p.log.Errorf("%v", err)
×
2223
                        }
×
2224

2225
                default:
×
2226
                        // If the message we received is unknown to us, store
×
2227
                        // the type to track the failure.
×
2228
                        err := fmt.Errorf("unknown message type %v received",
×
2229
                                uint16(msg.MsgType()))
×
2230
                        p.storeError(err)
×
2231

×
2232
                        p.log.Errorf("%v", err)
×
2233
                }
2234

2235
                if isLinkUpdate {
1✔
2236
                        // If this is a channel update, then we need to feed it
×
2237
                        // into the channel's in-order message stream.
×
2238
                        p.sendLinkUpdateMsg(targetChan, nextMsg)
×
2239
                }
×
2240

2241
                idleTimer.Reset(idleTimeout)
1✔
2242
        }
2243

2244
        p.Disconnect(errors.New("read handler closed"))
×
2245

×
2246
        p.log.Trace("readHandler for peer done")
×
2247
}
2248

2249
// handleCustomMessage handles the given custom message if a handler is
2250
// registered.
2251
func (p *Brontide) handleCustomMessage(msg *lnwire.Custom) error {
1✔
2252
        if p.cfg.HandleCustomMessage == nil {
1✔
2253
                return fmt.Errorf("no custom message handler for "+
×
2254
                        "message type %v", uint16(msg.MsgType()))
×
2255
        }
×
2256

2257
        return p.cfg.HandleCustomMessage(p.PubKey(), msg)
1✔
2258
}
2259

2260
// isLoadedFromDisk returns true if the provided channel ID is loaded from
2261
// disk.
2262
//
2263
// NOTE: only returns true for pending channels.
2264
func (p *Brontide) isLoadedFromDisk(chanID lnwire.ChannelID) bool {
×
2265
        // If this is a newly added channel, no need to reestablish.
×
2266
        _, added := p.addedChannels.Load(chanID)
×
2267
        if added {
×
2268
                return false
×
2269
        }
×
2270

2271
        // Return false if the channel is unknown.
2272
        channel, ok := p.activeChannels.Load(chanID)
×
2273
        if !ok {
×
2274
                return false
×
2275
        }
×
2276

2277
        // During startup, we will use a nil value to mark a pending channel
2278
        // that's loaded from disk.
2279
        return channel == nil
×
2280
}
2281

2282
// isActiveChannel returns true if the provided channel id is active, otherwise
2283
// returns false.
2284
func (p *Brontide) isActiveChannel(chanID lnwire.ChannelID) bool {
8✔
2285
        // The channel would be nil if,
8✔
2286
        // - the channel doesn't exist, or,
8✔
2287
        // - the channel exists, but is pending. In this case, we don't
8✔
2288
        //   consider this channel active.
8✔
2289
        channel, _ := p.activeChannels.Load(chanID)
8✔
2290

8✔
2291
        return channel != nil
8✔
2292
}
8✔
2293

2294
// isPendingChannel returns true if the provided channel ID is pending, and
2295
// returns false if the channel is active or unknown.
2296
func (p *Brontide) isPendingChannel(chanID lnwire.ChannelID) bool {
6✔
2297
        // Return false if the channel is unknown.
6✔
2298
        channel, ok := p.activeChannels.Load(chanID)
6✔
2299
        if !ok {
9✔
2300
                return false
3✔
2301
        }
3✔
2302

2303
        return channel == nil
3✔
2304
}
2305

2306
// hasChannel returns true if the peer has a pending/active channel specified
2307
// by the channel ID.
2308
func (p *Brontide) hasChannel(chanID lnwire.ChannelID) bool {
×
2309
        _, ok := p.activeChannels.Load(chanID)
×
2310
        return ok
×
2311
}
×
2312

2313
// storeError stores an error in our peer's buffer of recent errors with the
2314
// current timestamp. Errors are only stored if we have at least one active
2315
// channel with the peer to mitigate a dos vector where a peer costlessly
2316
// connects to us and spams us with errors.
2317
func (p *Brontide) storeError(err error) {
×
2318
        var haveChannels bool
×
2319

×
2320
        p.activeChannels.Range(func(_ lnwire.ChannelID,
×
2321
                channel *lnwallet.LightningChannel) bool {
×
2322

×
2323
                // Pending channels will be nil in the activeChannels map.
×
2324
                if channel == nil {
×
2325
                        // Return true to continue the iteration.
×
2326
                        return true
×
2327
                }
×
2328

2329
                haveChannels = true
×
2330

×
2331
                // Return false to break the iteration.
×
2332
                return false
×
2333
        })
2334

2335
        // If we do not have any active channels with the peer, we do not store
2336
        // errors as a dos mitigation.
2337
        if !haveChannels {
×
2338
                p.log.Trace("no channels with peer, not storing err")
×
2339
                return
×
2340
        }
×
2341

2342
        p.cfg.ErrorBuffer.Add(
×
2343
                &TimestampedError{Timestamp: time.Now(), Error: err},
×
2344
        )
×
2345
}
2346

2347
// handleWarningOrError processes a warning or error msg and returns true if
2348
// msg should be forwarded to the associated channel link. False is returned if
2349
// any necessary forwarding of msg was already handled by this method. If msg is
2350
// an error from a peer with an active channel, we'll store it in memory.
2351
//
2352
// NOTE: This method should only be called from within the readHandler.
2353
func (p *Brontide) handleWarningOrError(chanID lnwire.ChannelID,
2354
        msg lnwire.Message) bool {
×
2355

×
2356
        if errMsg, ok := msg.(*lnwire.Error); ok {
×
2357
                p.storeError(errMsg)
×
2358
        }
×
2359

2360
        switch {
×
2361
        // Connection wide messages should be forwarded to all channel links
2362
        // with this peer.
2363
        case chanID == lnwire.ConnectionWideID:
×
2364
                for _, chanStream := range p.activeMsgStreams {
×
2365
                        chanStream.AddMsg(msg)
×
2366
                }
×
2367

2368
                return false
×
2369

2370
        // If the channel ID for the message corresponds to a pending channel,
2371
        // then the funding manager will handle it.
2372
        case p.cfg.FundingManager.IsPendingChannel(chanID, p):
×
2373
                p.cfg.FundingManager.ProcessFundingMsg(msg, p)
×
2374
                return false
×
2375

2376
        // If not we hand the message to the channel link for this channel.
2377
        case p.isActiveChannel(chanID):
×
2378
                return true
×
2379

2380
        default:
×
2381
                return false
×
2382
        }
2383
}
2384

2385
// messageSummary returns a human-readable string that summarizes a
2386
// incoming/outgoing message. Not all messages will have a summary, only those
2387
// which have additional data that can be informative at a glance.
2388
func messageSummary(msg lnwire.Message) string {
×
2389
        switch msg := msg.(type) {
×
2390
        case *lnwire.Init:
×
2391
                // No summary.
×
2392
                return ""
×
2393

2394
        case *lnwire.OpenChannel:
×
2395
                return fmt.Sprintf("temp_chan_id=%x, chain=%v, csv=%v, amt=%v, "+
×
2396
                        "push_amt=%v, reserve=%v, flags=%v",
×
2397
                        msg.PendingChannelID[:], msg.ChainHash,
×
2398
                        msg.CsvDelay, msg.FundingAmount, msg.PushAmount,
×
2399
                        msg.ChannelReserve, msg.ChannelFlags)
×
2400

2401
        case *lnwire.AcceptChannel:
×
2402
                return fmt.Sprintf("temp_chan_id=%x, reserve=%v, csv=%v, num_confs=%v",
×
2403
                        msg.PendingChannelID[:], msg.ChannelReserve, msg.CsvDelay,
×
2404
                        msg.MinAcceptDepth)
×
2405

2406
        case *lnwire.FundingCreated:
×
2407
                return fmt.Sprintf("temp_chan_id=%x, chan_point=%v",
×
2408
                        msg.PendingChannelID[:], msg.FundingPoint)
×
2409

2410
        case *lnwire.FundingSigned:
×
2411
                return fmt.Sprintf("chan_id=%v", msg.ChanID)
×
2412

2413
        case *lnwire.ChannelReady:
×
2414
                return fmt.Sprintf("chan_id=%v, next_point=%x",
×
2415
                        msg.ChanID, msg.NextPerCommitmentPoint.SerializeCompressed())
×
2416

2417
        case *lnwire.Shutdown:
×
2418
                return fmt.Sprintf("chan_id=%v, script=%x", msg.ChannelID,
×
2419
                        msg.Address[:])
×
2420

2421
        case *lnwire.ClosingComplete:
×
2422
                return fmt.Sprintf("chan_id=%v, fee_sat=%v, locktime=%v",
×
2423
                        msg.ChannelID, msg.FeeSatoshis, msg.LockTime)
×
2424

2425
        case *lnwire.ClosingSig:
×
2426
                return fmt.Sprintf("chan_id=%v", msg.ChannelID)
×
2427

2428
        case *lnwire.ClosingSigned:
×
2429
                return fmt.Sprintf("chan_id=%v, fee_sat=%v", msg.ChannelID,
×
2430
                        msg.FeeSatoshis)
×
2431

2432
        case *lnwire.UpdateAddHTLC:
×
2433
                var blindingPoint []byte
×
2434
                msg.BlindingPoint.WhenSome(
×
2435
                        func(b tlv.RecordT[lnwire.BlindingPointTlvType,
×
2436
                                *btcec.PublicKey]) {
×
2437

×
2438
                                blindingPoint = b.Val.SerializeCompressed()
×
2439
                        },
×
2440
                )
2441

2442
                return fmt.Sprintf("chan_id=%v, id=%v, amt=%v, expiry=%v, "+
×
2443
                        "hash=%x, blinding_point=%x, custom_records=%v",
×
2444
                        msg.ChanID, msg.ID, msg.Amount, msg.Expiry,
×
2445
                        msg.PaymentHash[:], blindingPoint, msg.CustomRecords)
×
2446

2447
        case *lnwire.UpdateFailHTLC:
×
2448
                return fmt.Sprintf("chan_id=%v, id=%v, reason=%x", msg.ChanID,
×
2449
                        msg.ID, msg.Reason)
×
2450

2451
        case *lnwire.UpdateFulfillHTLC:
×
2452
                return fmt.Sprintf("chan_id=%v, id=%v, preimage=%x, "+
×
2453
                        "custom_records=%v", msg.ChanID, msg.ID,
×
2454
                        msg.PaymentPreimage[:], msg.CustomRecords)
×
2455

2456
        case *lnwire.CommitSig:
×
2457
                return fmt.Sprintf("chan_id=%v, num_htlcs=%v", msg.ChanID,
×
2458
                        len(msg.HtlcSigs))
×
2459

2460
        case *lnwire.RevokeAndAck:
×
2461
                return fmt.Sprintf("chan_id=%v, rev=%x, next_point=%x",
×
2462
                        msg.ChanID, msg.Revocation[:],
×
2463
                        msg.NextRevocationKey.SerializeCompressed())
×
2464

2465
        case *lnwire.UpdateFailMalformedHTLC:
×
2466
                return fmt.Sprintf("chan_id=%v, id=%v, fail_code=%v",
×
2467
                        msg.ChanID, msg.ID, msg.FailureCode)
×
2468

2469
        case *lnwire.Warning:
×
2470
                return fmt.Sprintf("%v", msg.Warning())
×
2471

2472
        case *lnwire.Error:
×
2473
                return fmt.Sprintf("%v", msg.Error())
×
2474

2475
        case *lnwire.AnnounceSignatures1:
×
2476
                return fmt.Sprintf("chan_id=%v, short_chan_id=%v", msg.ChannelID,
×
2477
                        msg.ShortChannelID.ToUint64())
×
2478

2479
        case *lnwire.ChannelAnnouncement1:
×
2480
                return fmt.Sprintf("chain_hash=%v, short_chan_id=%v",
×
2481
                        msg.ChainHash, msg.ShortChannelID.ToUint64())
×
2482

2483
        case *lnwire.ChannelUpdate1:
×
2484
                return fmt.Sprintf("chain_hash=%v, short_chan_id=%v, "+
×
2485
                        "mflags=%v, cflags=%v, update_time=%v", msg.ChainHash,
×
2486
                        msg.ShortChannelID.ToUint64(), msg.MessageFlags,
×
2487
                        msg.ChannelFlags, time.Unix(int64(msg.Timestamp), 0))
×
2488

2489
        case *lnwire.NodeAnnouncement:
×
2490
                return fmt.Sprintf("node=%x, update_time=%v",
×
2491
                        msg.NodeID, time.Unix(int64(msg.Timestamp), 0))
×
2492

2493
        case *lnwire.Ping:
×
2494
                return fmt.Sprintf("ping_bytes=%x", msg.PaddingBytes[:])
×
2495

2496
        case *lnwire.Pong:
×
2497
                return fmt.Sprintf("len(pong_bytes)=%d", len(msg.PongBytes[:]))
×
2498

2499
        case *lnwire.UpdateFee:
×
2500
                return fmt.Sprintf("chan_id=%v, fee_update_sat=%v",
×
2501
                        msg.ChanID, int64(msg.FeePerKw))
×
2502

2503
        case *lnwire.ChannelReestablish:
×
2504
                return fmt.Sprintf("chan_id=%v, next_local_height=%v, "+
×
2505
                        "remote_tail_height=%v", msg.ChanID,
×
2506
                        msg.NextLocalCommitHeight, msg.RemoteCommitTailHeight)
×
2507

2508
        case *lnwire.ReplyShortChanIDsEnd:
×
2509
                return fmt.Sprintf("chain_hash=%v, complete=%v", msg.ChainHash,
×
2510
                        msg.Complete)
×
2511

2512
        case *lnwire.ReplyChannelRange:
×
2513
                return fmt.Sprintf("start_height=%v, end_height=%v, "+
×
2514
                        "num_chans=%v, encoding=%v", msg.FirstBlockHeight,
×
2515
                        msg.LastBlockHeight(), len(msg.ShortChanIDs),
×
2516
                        msg.EncodingType)
×
2517

2518
        case *lnwire.QueryShortChanIDs:
×
2519
                return fmt.Sprintf("chain_hash=%v, encoding=%v, num_chans=%v",
×
2520
                        msg.ChainHash, msg.EncodingType, len(msg.ShortChanIDs))
×
2521

2522
        case *lnwire.QueryChannelRange:
×
2523
                return fmt.Sprintf("chain_hash=%v, start_height=%v, "+
×
2524
                        "end_height=%v", msg.ChainHash, msg.FirstBlockHeight,
×
2525
                        msg.LastBlockHeight())
×
2526

2527
        case *lnwire.GossipTimestampRange:
×
2528
                return fmt.Sprintf("chain_hash=%v, first_stamp=%v, "+
×
2529
                        "stamp_range=%v", msg.ChainHash,
×
2530
                        time.Unix(int64(msg.FirstTimestamp), 0),
×
2531
                        msg.TimestampRange)
×
2532

2533
        case *lnwire.Stfu:
×
2534
                return fmt.Sprintf("chan_id=%v, initiator=%v", msg.ChanID,
×
2535
                        msg.Initiator)
×
2536

2537
        case *lnwire.Custom:
×
2538
                return fmt.Sprintf("type=%d", msg.Type)
×
2539
        }
2540

2541
        return fmt.Sprintf("unknown msg type=%T", msg)
×
2542
}
2543

2544
// logWireMessage logs the receipt or sending of particular wire message. This
2545
// function is used rather than just logging the message in order to produce
2546
// less spammy log messages in trace mode by setting the 'Curve" parameter to
2547
// nil. Doing this avoids printing out each of the field elements in the curve
2548
// parameters for secp256k1.
2549
func (p *Brontide) logWireMessage(msg lnwire.Message, read bool) {
17✔
2550
        summaryPrefix := "Received"
17✔
2551
        if !read {
30✔
2552
                summaryPrefix = "Sending"
13✔
2553
        }
13✔
2554

2555
        p.log.Debugf("%v", lnutils.NewLogClosure(func() string {
17✔
2556
                // Debug summary of message.
×
2557
                summary := messageSummary(msg)
×
2558
                if len(summary) > 0 {
×
2559
                        summary = "(" + summary + ")"
×
2560
                }
×
2561

2562
                preposition := "to"
×
2563
                if read {
×
2564
                        preposition = "from"
×
2565
                }
×
2566

2567
                var msgType string
×
2568
                if msg.MsgType() < lnwire.CustomTypeStart {
×
2569
                        msgType = msg.MsgType().String()
×
2570
                } else {
×
2571
                        msgType = "custom"
×
2572
                }
×
2573

2574
                return fmt.Sprintf("%v %v%s %v %s", summaryPrefix,
×
2575
                        msgType, summary, preposition, p)
×
2576
        }))
2577

2578
        prefix := "readMessage from peer"
17✔
2579
        if !read {
30✔
2580
                prefix = "writeMessage to peer"
13✔
2581
        }
13✔
2582

2583
        p.log.Tracef(prefix+": %v", lnutils.SpewLogClosure(msg))
17✔
2584
}
2585

2586
// writeMessage writes and flushes the target lnwire.Message to the remote peer.
2587
// If the passed message is nil, this method will only try to flush an existing
2588
// message buffered on the connection. It is safe to call this method again
2589
// with a nil message iff a timeout error is returned. This will continue to
2590
// flush the pending message to the wire.
2591
//
2592
// NOTE:
2593
// Besides its usage in Start, this function should not be used elsewhere
2594
// except in writeHandler. If multiple goroutines call writeMessage at the same
2595
// time, panics can occur because WriteMessage and Flush don't use any locking
2596
// internally.
2597
func (p *Brontide) writeMessage(msg lnwire.Message) error {
13✔
2598
        // Only log the message on the first attempt.
13✔
2599
        if msg != nil {
26✔
2600
                p.logWireMessage(msg, false)
13✔
2601
        }
13✔
2602

2603
        noiseConn := p.cfg.Conn
13✔
2604

13✔
2605
        flushMsg := func() error {
26✔
2606
                // Ensure the write deadline is set before we attempt to send
13✔
2607
                // the message.
13✔
2608
                writeDeadline := time.Now().Add(
13✔
2609
                        p.scaleTimeout(writeMessageTimeout),
13✔
2610
                )
13✔
2611
                err := noiseConn.SetWriteDeadline(writeDeadline)
13✔
2612
                if err != nil {
13✔
2613
                        return err
×
2614
                }
×
2615

2616
                // Flush the pending message to the wire. If an error is
2617
                // encountered, e.g. write timeout, the number of bytes written
2618
                // so far will be returned.
2619
                n, err := noiseConn.Flush()
13✔
2620

13✔
2621
                // Record the number of bytes written on the wire, if any.
13✔
2622
                if n > 0 {
13✔
2623
                        atomic.AddUint64(&p.bytesSent, uint64(n))
×
2624
                }
×
2625

2626
                return err
13✔
2627
        }
2628

2629
        // If the current message has already been serialized, encrypted, and
2630
        // buffered on the underlying connection we will skip straight to
2631
        // flushing it to the wire.
2632
        if msg == nil {
13✔
2633
                return flushMsg()
×
2634
        }
×
2635

2636
        // Otherwise, this is a new message. We'll acquire a write buffer to
2637
        // serialize the message and buffer the ciphertext on the connection.
2638
        err := p.cfg.WritePool.Submit(func(buf *bytes.Buffer) error {
26✔
2639
                // Using a buffer allocated by the write pool, encode the
13✔
2640
                // message directly into the buffer.
13✔
2641
                _, writeErr := lnwire.WriteMessage(buf, msg, 0)
13✔
2642
                if writeErr != nil {
13✔
2643
                        return writeErr
×
2644
                }
×
2645

2646
                // Finally, write the message itself in a single swoop. This
2647
                // will buffer the ciphertext on the underlying connection. We
2648
                // will defer flushing the message until the write pool has been
2649
                // released.
2650
                return noiseConn.WriteMessage(buf.Bytes())
13✔
2651
        })
2652
        if err != nil {
13✔
2653
                return err
×
2654
        }
×
2655

2656
        return flushMsg()
13✔
2657
}
2658

2659
// writeHandler is a goroutine dedicated to reading messages off of an incoming
2660
// queue, and writing them out to the wire. This goroutine coordinates with the
2661
// queueHandler in order to ensure the incoming message queue is quickly
2662
// drained.
2663
//
2664
// NOTE: This method MUST be run as a goroutine.
2665
func (p *Brontide) writeHandler() {
3✔
2666
        // We'll stop the timer after a new messages is sent, and also reset it
3✔
2667
        // after we process the next message.
3✔
2668
        idleTimer := time.AfterFunc(idleTimeout, func() {
3✔
2669
                err := fmt.Errorf("peer %s no write for %s -- disconnecting",
×
2670
                        p, idleTimeout)
×
2671
                p.Disconnect(err)
×
2672
        })
×
2673

2674
        var exitErr error
3✔
2675

3✔
2676
out:
3✔
2677
        for {
10✔
2678
                select {
7✔
2679
                case outMsg := <-p.sendQueue:
4✔
2680
                        // Record the time at which we first attempt to send the
4✔
2681
                        // message.
4✔
2682
                        startTime := time.Now()
4✔
2683

4✔
2684
                retry:
4✔
2685
                        // Write out the message to the socket. If a timeout
2686
                        // error is encountered, we will catch this and retry
2687
                        // after backing off in case the remote peer is just
2688
                        // slow to process messages from the wire.
2689
                        err := p.writeMessage(outMsg.msg)
4✔
2690
                        if nerr, ok := err.(net.Error); ok && nerr.Timeout() {
4✔
2691
                                p.log.Debugf("Write timeout detected for "+
×
2692
                                        "peer, first write for message "+
×
2693
                                        "attempted %v ago",
×
2694
                                        time.Since(startTime))
×
2695

×
2696
                                // If we received a timeout error, this implies
×
2697
                                // that the message was buffered on the
×
2698
                                // connection successfully and that a flush was
×
2699
                                // attempted. We'll set the message to nil so
×
2700
                                // that on a subsequent pass we only try to
×
2701
                                // flush the buffered message, and forgo
×
2702
                                // reserializing or reencrypting it.
×
2703
                                outMsg.msg = nil
×
2704

×
2705
                                goto retry
×
2706
                        }
2707

2708
                        // The write succeeded, reset the idle timer to prevent
2709
                        // us from disconnecting the peer.
2710
                        if !idleTimer.Stop() {
4✔
2711
                                select {
×
2712
                                case <-idleTimer.C:
×
2713
                                default:
×
2714
                                }
2715
                        }
2716
                        idleTimer.Reset(idleTimeout)
4✔
2717

4✔
2718
                        // If the peer requested a synchronous write, respond
4✔
2719
                        // with the error.
4✔
2720
                        if outMsg.errChan != nil {
5✔
2721
                                outMsg.errChan <- err
1✔
2722
                        }
1✔
2723

2724
                        if err != nil {
4✔
2725
                                exitErr = fmt.Errorf("unable to write "+
×
2726
                                        "message: %v", err)
×
2727
                                break out
×
2728
                        }
2729

2730
                case <-p.cg.Done():
×
2731
                        exitErr = lnpeer.ErrPeerExiting
×
2732
                        break out
×
2733
                }
2734
        }
2735

2736
        // Avoid an exit deadlock by ensuring WaitGroups are decremented before
2737
        // disconnect.
2738
        p.cg.WgDone()
×
2739

×
2740
        p.Disconnect(exitErr)
×
2741

×
2742
        p.log.Trace("writeHandler for peer done")
×
2743
}
2744

2745
// queueHandler is responsible for accepting messages from outside subsystems
2746
// to be eventually sent out on the wire by the writeHandler.
2747
//
2748
// NOTE: This method MUST be run as a goroutine.
2749
func (p *Brontide) queueHandler() {
3✔
2750
        defer p.cg.WgDone()
3✔
2751

3✔
2752
        // priorityMsgs holds an in order list of messages deemed high-priority
3✔
2753
        // to be added to the sendQueue. This predominately includes messages
3✔
2754
        // from the funding manager and htlcswitch.
3✔
2755
        priorityMsgs := list.New()
3✔
2756

3✔
2757
        // lazyMsgs holds an in order list of messages deemed low-priority to be
3✔
2758
        // added to the sendQueue only after all high-priority messages have
3✔
2759
        // been queued. This predominately includes messages from the gossiper.
3✔
2760
        lazyMsgs := list.New()
3✔
2761

3✔
2762
        for {
14✔
2763
                // Examine the front of the priority queue, if it is empty check
11✔
2764
                // the low priority queue.
11✔
2765
                elem := priorityMsgs.Front()
11✔
2766
                if elem == nil {
19✔
2767
                        elem = lazyMsgs.Front()
8✔
2768
                }
8✔
2769

2770
                if elem != nil {
15✔
2771
                        front := elem.Value.(outgoingMsg)
4✔
2772

4✔
2773
                        // There's an element on the queue, try adding
4✔
2774
                        // it to the sendQueue. We also watch for
4✔
2775
                        // messages on the outgoingQueue, in case the
4✔
2776
                        // writeHandler cannot accept messages on the
4✔
2777
                        // sendQueue.
4✔
2778
                        select {
4✔
2779
                        case p.sendQueue <- front:
4✔
2780
                                if front.priority {
7✔
2781
                                        priorityMsgs.Remove(elem)
3✔
2782
                                } else {
4✔
2783
                                        lazyMsgs.Remove(elem)
1✔
2784
                                }
1✔
2785
                        case msg := <-p.outgoingQueue:
×
2786
                                if msg.priority {
×
2787
                                        priorityMsgs.PushBack(msg)
×
2788
                                } else {
×
2789
                                        lazyMsgs.PushBack(msg)
×
2790
                                }
×
2791
                        case <-p.cg.Done():
×
2792
                                return
×
2793
                        }
2794
                } else {
7✔
2795
                        // If there weren't any messages to send to the
7✔
2796
                        // writeHandler, then we'll accept a new message
7✔
2797
                        // into the queue from outside sub-systems.
7✔
2798
                        select {
7✔
2799
                        case msg := <-p.outgoingQueue:
4✔
2800
                                if msg.priority {
7✔
2801
                                        priorityMsgs.PushBack(msg)
3✔
2802
                                } else {
4✔
2803
                                        lazyMsgs.PushBack(msg)
1✔
2804
                                }
1✔
2805
                        case <-p.cg.Done():
×
2806
                                return
×
2807
                        }
2808
                }
2809
        }
2810
}
2811

2812
// PingTime returns the estimated ping time to the peer in microseconds.
2813
func (p *Brontide) PingTime() int64 {
×
2814
        return p.pingManager.GetPingTimeMicroSeconds()
×
2815
}
×
2816

2817
// queueMsg adds the lnwire.Message to the back of the high priority send queue.
2818
// If the errChan is non-nil, an error is sent back if the msg failed to queue
2819
// or failed to write, and nil otherwise.
2820
func (p *Brontide) queueMsg(msg lnwire.Message, errChan chan error) {
25✔
2821
        p.queue(true, msg, errChan)
25✔
2822
}
25✔
2823

2824
// queueMsgLazy adds the lnwire.Message to the back of the low priority send
2825
// queue. If the errChan is non-nil, an error is sent back if the msg failed to
2826
// queue or failed to write, and nil otherwise.
2827
func (p *Brontide) queueMsgLazy(msg lnwire.Message, errChan chan error) {
1✔
2828
        p.queue(false, msg, errChan)
1✔
2829
}
1✔
2830

2831
// queue sends a given message to the queueHandler using the passed priority. If
2832
// the errChan is non-nil, an error is sent back if the msg failed to queue or
2833
// failed to write, and nil otherwise.
2834
func (p *Brontide) queue(priority bool, msg lnwire.Message,
2835
        errChan chan error) {
26✔
2836

26✔
2837
        select {
26✔
2838
        case p.outgoingQueue <- outgoingMsg{priority, msg, errChan}:
25✔
2839
        case <-p.cg.Done():
×
2840
                p.log.Tracef("Peer shutting down, could not enqueue msg: %v.",
×
2841
                        lnutils.SpewLogClosure(msg))
×
2842
                if errChan != nil {
×
2843
                        errChan <- lnpeer.ErrPeerExiting
×
2844
                }
×
2845
        }
2846
}
2847

2848
// ChannelSnapshots returns a slice of channel snapshots detailing all
2849
// currently active channels maintained with the remote peer.
2850
func (p *Brontide) ChannelSnapshots() []*channeldb.ChannelSnapshot {
×
2851
        snapshots := make(
×
2852
                []*channeldb.ChannelSnapshot, 0, p.activeChannels.Len(),
×
2853
        )
×
2854

×
2855
        p.activeChannels.ForEach(func(_ lnwire.ChannelID,
×
2856
                activeChan *lnwallet.LightningChannel) error {
×
2857

×
2858
                // If the activeChan is nil, then we skip it as the channel is
×
2859
                // pending.
×
2860
                if activeChan == nil {
×
2861
                        return nil
×
2862
                }
×
2863

2864
                // We'll only return a snapshot for channels that are
2865
                // *immediately* available for routing payments over.
2866
                if activeChan.RemoteNextRevocation() == nil {
×
2867
                        return nil
×
2868
                }
×
2869

2870
                snapshot := activeChan.StateSnapshot()
×
2871
                snapshots = append(snapshots, snapshot)
×
2872

×
2873
                return nil
×
2874
        })
2875

2876
        return snapshots
×
2877
}
2878

2879
// genDeliveryScript returns a new script to be used to send our funds to in
2880
// the case of a cooperative channel close negotiation.
2881
func (p *Brontide) genDeliveryScript() ([]byte, error) {
6✔
2882
        // We'll send a normal p2wkh address unless we've negotiated the
6✔
2883
        // shutdown-any-segwit feature.
6✔
2884
        addrType := lnwallet.WitnessPubKey
6✔
2885
        if p.taprootShutdownAllowed() {
6✔
2886
                addrType = lnwallet.TaprootPubkey
×
2887
        }
×
2888

2889
        deliveryAddr, err := p.cfg.Wallet.NewAddress(
6✔
2890
                addrType, false, lnwallet.DefaultAccountName,
6✔
2891
        )
6✔
2892
        if err != nil {
6✔
2893
                return nil, err
×
2894
        }
×
2895
        p.log.Infof("Delivery addr for channel close: %v",
6✔
2896
                deliveryAddr)
6✔
2897

6✔
2898
        return txscript.PayToAddrScript(deliveryAddr)
6✔
2899
}
2900

2901
// channelManager is goroutine dedicated to handling all requests/signals
2902
// pertaining to the opening, cooperative closing, and force closing of all
2903
// channels maintained with the remote peer.
2904
//
2905
// NOTE: This method MUST be run as a goroutine.
2906
func (p *Brontide) channelManager() {
17✔
2907
        defer p.cg.WgDone()
17✔
2908

17✔
2909
        // reenableTimeout will fire once after the configured channel status
17✔
2910
        // interval has elapsed. This will trigger us to sign new channel
17✔
2911
        // updates and broadcast them with the "disabled" flag unset.
17✔
2912
        reenableTimeout := time.After(p.cfg.ChanActiveTimeout)
17✔
2913

17✔
2914
out:
17✔
2915
        for {
55✔
2916
                select {
38✔
2917
                // A new pending channel has arrived which means we are about
2918
                // to complete a funding workflow and is waiting for the final
2919
                // `ChannelReady` messages to be exchanged. We will add this
2920
                // channel to the `activeChannels` with a nil value to indicate
2921
                // this is a pending channel.
2922
                case req := <-p.newPendingChannel:
1✔
2923
                        p.handleNewPendingChannel(req)
1✔
2924

2925
                // A new channel has arrived which means we've just completed a
2926
                // funding workflow. We'll initialize the necessary local
2927
                // state, and notify the htlc switch of a new link.
2928
                case req := <-p.newActiveChannel:
×
2929
                        p.handleNewActiveChannel(req)
×
2930

2931
                // The funding flow for a pending channel is failed, we will
2932
                // remove it from Brontide.
2933
                case req := <-p.removePendingChannel:
1✔
2934
                        p.handleRemovePendingChannel(req)
1✔
2935

2936
                // We've just received a local request to close an active
2937
                // channel. It will either kick of a cooperative channel
2938
                // closure negotiation, or be a notification of a breached
2939
                // contract that should be abandoned.
2940
                case req := <-p.localCloseChanReqs:
7✔
2941
                        p.handleLocalCloseReq(req)
7✔
2942

2943
                // We've received a link failure from a link that was added to
2944
                // the switch. This will initiate the teardown of the link, and
2945
                // initiate any on-chain closures if necessary.
2946
                case failure := <-p.linkFailures:
×
2947
                        p.handleLinkFailure(failure)
×
2948

2949
                // We've received a new cooperative channel closure related
2950
                // message from the remote peer, we'll use this message to
2951
                // advance the chan closer state machine.
2952
                case closeMsg := <-p.chanCloseMsgs:
13✔
2953
                        p.handleCloseMsg(closeMsg)
13✔
2954

2955
                // The channel reannounce delay has elapsed, broadcast the
2956
                // reenabled channel updates to the network. This should only
2957
                // fire once, so we set the reenableTimeout channel to nil to
2958
                // mark it for garbage collection. If the peer is torn down
2959
                // before firing, reenabling will not be attempted.
2960
                // TODO(conner): consolidate reenables timers inside chan status
2961
                // manager
2962
                case <-reenableTimeout:
×
2963
                        p.reenableActiveChannels()
×
2964

×
2965
                        // Since this channel will never fire again during the
×
2966
                        // lifecycle of the peer, we nil the channel to mark it
×
2967
                        // eligible for garbage collection, and make this
×
2968
                        // explicitly ineligible to receive in future calls to
×
2969
                        // select. This also shaves a few CPU cycles since the
×
2970
                        // select will ignore this case entirely.
×
2971
                        reenableTimeout = nil
×
2972

×
2973
                        // Once the reenabling is attempted, we also cancel the
×
2974
                        // channel event subscription to free up the overflow
×
2975
                        // queue used in channel notifier.
×
2976
                        //
×
2977
                        // NOTE: channelEventClient will be nil if the
×
2978
                        // reenableTimeout is greater than 1 minute.
×
2979
                        if p.channelEventClient != nil {
×
2980
                                p.channelEventClient.Cancel()
×
2981
                        }
×
2982

2983
                case <-p.cg.Done():
×
2984
                        // As, we've been signalled to exit, we'll reset all
×
2985
                        // our active channel back to their default state.
×
2986
                        p.activeChannels.ForEach(func(_ lnwire.ChannelID,
×
2987
                                lc *lnwallet.LightningChannel) error {
×
2988

×
2989
                                // Exit if the channel is nil as it's a pending
×
2990
                                // channel.
×
2991
                                if lc == nil {
×
2992
                                        return nil
×
2993
                                }
×
2994

2995
                                lc.ResetState()
×
2996

×
2997
                                return nil
×
2998
                        })
2999

3000
                        break out
×
3001
                }
3002
        }
3003
}
3004

3005
// reenableActiveChannels searches the index of channels maintained with this
3006
// peer, and reenables each public, non-pending channel. This is done at the
3007
// gossip level by broadcasting a new ChannelUpdate with the disabled bit unset.
3008
// No message will be sent if the channel is already enabled.
3009
func (p *Brontide) reenableActiveChannels() {
×
3010
        // First, filter all known channels with this peer for ones that are
×
3011
        // both public and not pending.
×
3012
        activePublicChans := p.filterChannelsToEnable()
×
3013

×
3014
        // Create a map to hold channels that needs to be retried.
×
3015
        retryChans := make(map[wire.OutPoint]struct{}, len(activePublicChans))
×
3016

×
3017
        // For each of the public, non-pending channels, set the channel
×
3018
        // disabled bit to false and send out a new ChannelUpdate. If this
×
3019
        // channel is already active, the update won't be sent.
×
3020
        for _, chanPoint := range activePublicChans {
×
3021
                err := p.cfg.ChanStatusMgr.RequestEnable(chanPoint, false)
×
3022

×
3023
                switch {
×
3024
                // No error occurred, continue to request the next channel.
3025
                case err == nil:
×
3026
                        continue
×
3027

3028
                // Cannot auto enable a manually disabled channel so we do
3029
                // nothing but proceed to the next channel.
3030
                case errors.Is(err, netann.ErrEnableManuallyDisabledChan):
×
3031
                        p.log.Debugf("Channel(%v) was manually disabled, "+
×
3032
                                "ignoring automatic enable request", chanPoint)
×
3033

×
3034
                        continue
×
3035

3036
                // If the channel is reported as inactive, we will give it
3037
                // another chance. When handling the request, ChanStatusManager
3038
                // will check whether the link is active or not. One of the
3039
                // conditions is whether the link has been marked as
3040
                // reestablished, which happens inside a goroutine(htlcManager)
3041
                // after the link is started. And we may get a false negative
3042
                // saying the link is not active because that goroutine hasn't
3043
                // reached the line to mark the reestablishment. Thus we give
3044
                // it a second chance to send the request.
3045
                case errors.Is(err, netann.ErrEnableInactiveChan):
×
3046
                        // If we don't have a client created, it means we
×
3047
                        // shouldn't retry enabling the channel.
×
3048
                        if p.channelEventClient == nil {
×
3049
                                p.log.Errorf("Channel(%v) request enabling "+
×
3050
                                        "failed due to inactive link",
×
3051
                                        chanPoint)
×
3052

×
3053
                                continue
×
3054
                        }
3055

3056
                        p.log.Warnf("Channel(%v) cannot be enabled as " +
×
3057
                                "ChanStatusManager reported inactive, retrying")
×
3058

×
3059
                        // Add the channel to the retry map.
×
3060
                        retryChans[chanPoint] = struct{}{}
×
3061
                }
3062
        }
3063

3064
        // Retry the channels if we have any.
3065
        if len(retryChans) != 0 {
×
3066
                p.retryRequestEnable(retryChans)
×
3067
        }
×
3068
}
3069

3070
// fetchActiveChanCloser attempts to fetch the active chan closer state machine
3071
// for the target channel ID. If the channel isn't active an error is returned.
3072
// Otherwise, either an existing state machine will be returned, or a new one
3073
// will be created.
3074
func (p *Brontide) fetchActiveChanCloser(chanID lnwire.ChannelID) (
3075
        *chanCloserFsm, error) {
13✔
3076

13✔
3077
        chanCloser, found := p.activeChanCloses.Load(chanID)
13✔
3078
        if found {
23✔
3079
                // An entry will only be found if the closer has already been
10✔
3080
                // created for a non-pending channel or for a channel that had
10✔
3081
                // previously started the shutdown process but the connection
10✔
3082
                // was restarted.
10✔
3083
                return &chanCloser, nil
10✔
3084
        }
10✔
3085

3086
        // First, we'll ensure that we actually know of the target channel. If
3087
        // not, we'll ignore this message.
3088
        channel, ok := p.activeChannels.Load(chanID)
3✔
3089

3✔
3090
        // If the channel isn't in the map or the channel is nil, return
3✔
3091
        // ErrChannelNotFound as the channel is pending.
3✔
3092
        if !ok || channel == nil {
3✔
3093
                return nil, ErrChannelNotFound
×
3094
        }
×
3095

3096
        // We'll create a valid closing state machine in order to respond to
3097
        // the initiated cooperative channel closure. First, we set the
3098
        // delivery script that our funds will be paid out to. If an upfront
3099
        // shutdown script was set, we will use it. Otherwise, we get a fresh
3100
        // delivery script.
3101
        //
3102
        // TODO: Expose option to allow upfront shutdown script from watch-only
3103
        // accounts.
3104
        deliveryScript := channel.LocalUpfrontShutdownScript()
3✔
3105
        if len(deliveryScript) == 0 {
6✔
3106
                var err error
3✔
3107
                deliveryScript, err = p.genDeliveryScript()
3✔
3108
                if err != nil {
3✔
3109
                        p.log.Errorf("unable to gen delivery script: %v",
×
3110
                                err)
×
3111
                        return nil, fmt.Errorf("close addr unavailable")
×
3112
                }
×
3113
        }
3114

3115
        // In order to begin fee negotiations, we'll first compute our target
3116
        // ideal fee-per-kw.
3117
        feePerKw, err := p.cfg.FeeEstimator.EstimateFeePerKW(
3✔
3118
                p.cfg.CoopCloseTargetConfs,
3✔
3119
        )
3✔
3120
        if err != nil {
3✔
3121
                p.log.Errorf("unable to query fee estimator: %v", err)
×
3122
                return nil, fmt.Errorf("unable to estimate fee")
×
3123
        }
×
3124

3125
        addr, err := p.addrWithInternalKey(deliveryScript)
3✔
3126
        if err != nil {
3✔
3127
                return nil, fmt.Errorf("unable to parse addr: %w", err)
×
3128
        }
×
3129
        negotiateChanCloser, err := p.createChanCloser(
3✔
3130
                channel, addr, feePerKw, nil, lntypes.Remote,
3✔
3131
        )
3✔
3132
        if err != nil {
3✔
3133
                p.log.Errorf("unable to create chan closer: %v", err)
×
3134
                return nil, fmt.Errorf("unable to create chan closer")
×
3135
        }
×
3136

3137
        chanCloser = makeNegotiateCloser(negotiateChanCloser)
3✔
3138

3✔
3139
        p.activeChanCloses.Store(chanID, chanCloser)
3✔
3140

3✔
3141
        return &chanCloser, nil
3✔
3142
}
3143

3144
// filterChannelsToEnable filters a list of channels to be enabled upon start.
3145
// The filtered channels are active channels that's neither private nor
3146
// pending.
3147
func (p *Brontide) filterChannelsToEnable() []wire.OutPoint {
×
3148
        var activePublicChans []wire.OutPoint
×
3149

×
3150
        p.activeChannels.Range(func(chanID lnwire.ChannelID,
×
3151
                lnChan *lnwallet.LightningChannel) bool {
×
3152

×
3153
                // If the lnChan is nil, continue as this is a pending channel.
×
3154
                if lnChan == nil {
×
3155
                        return true
×
3156
                }
×
3157

3158
                dbChan := lnChan.State()
×
3159
                isPublic := dbChan.ChannelFlags&lnwire.FFAnnounceChannel != 0
×
3160
                if !isPublic || dbChan.IsPending {
×
3161
                        return true
×
3162
                }
×
3163

3164
                // We'll also skip any channels added during this peer's
3165
                // lifecycle since they haven't waited out the timeout. Their
3166
                // first announcement will be enabled, and the chan status
3167
                // manager will begin monitoring them passively since they exist
3168
                // in the database.
3169
                if _, ok := p.addedChannels.Load(chanID); ok {
×
3170
                        return true
×
3171
                }
×
3172

3173
                activePublicChans = append(
×
3174
                        activePublicChans, dbChan.FundingOutpoint,
×
3175
                )
×
3176

×
3177
                return true
×
3178
        })
3179

3180
        return activePublicChans
×
3181
}
3182

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

×
3190
        // retryEnable is a helper closure that sends an enable request and
×
3191
        // removes the channel from the map if it's matched.
×
3192
        retryEnable := func(chanPoint wire.OutPoint) error {
×
3193
                // If this is an active channel event, check whether it's in
×
3194
                // our targeted channels map.
×
3195
                _, found := activeChans[chanPoint]
×
3196

×
3197
                // If this channel is irrelevant, return nil so the loop can
×
3198
                // jump to next iteration.
×
3199
                if !found {
×
3200
                        return nil
×
3201
                }
×
3202

3203
                // Otherwise we've just received an active signal for a channel
3204
                // that's previously failed to be enabled, we send the request
3205
                // again.
3206
                //
3207
                // We only give the channel one more shot, so we delete it from
3208
                // our map first to keep it from being attempted again.
3209
                delete(activeChans, chanPoint)
×
3210

×
3211
                // Send the request.
×
3212
                err := p.cfg.ChanStatusMgr.RequestEnable(chanPoint, false)
×
3213
                if err != nil {
×
3214
                        return fmt.Errorf("request enabling channel %v "+
×
3215
                                "failed: %w", chanPoint, err)
×
3216
                }
×
3217

3218
                return nil
×
3219
        }
3220

3221
        for {
×
3222
                // If activeChans is empty, we've done processing all the
×
3223
                // channels.
×
3224
                if len(activeChans) == 0 {
×
3225
                        p.log.Debug("Finished retry enabling channels")
×
3226
                        return
×
3227
                }
×
3228

3229
                select {
×
3230
                // A new event has been sent by the ChannelNotifier. We now
3231
                // check whether it's an active or inactive channel event.
3232
                case e := <-p.channelEventClient.Updates():
×
3233
                        // If this is an active channel event, try enable the
×
3234
                        // channel then jump to the next iteration.
×
3235
                        active, ok := e.(channelnotifier.ActiveChannelEvent)
×
3236
                        if ok {
×
3237
                                chanPoint := *active.ChannelPoint
×
3238

×
3239
                                // If we received an error for this particular
×
3240
                                // channel, we log an error and won't quit as
×
3241
                                // we still want to retry other channels.
×
3242
                                if err := retryEnable(chanPoint); err != nil {
×
3243
                                        p.log.Errorf("Retry failed: %v", err)
×
3244
                                }
×
3245

3246
                                continue
×
3247
                        }
3248

3249
                        // Otherwise check for inactive link event, and jump to
3250
                        // next iteration if it's not.
3251
                        inactive, ok := e.(channelnotifier.InactiveLinkEvent)
×
3252
                        if !ok {
×
3253
                                continue
×
3254
                        }
3255

3256
                        // Found an inactive link event, if this is our
3257
                        // targeted channel, remove it from our map.
3258
                        chanPoint := *inactive.ChannelPoint
×
3259
                        _, found := activeChans[chanPoint]
×
3260
                        if !found {
×
3261
                                continue
×
3262
                        }
3263

3264
                        delete(activeChans, chanPoint)
×
3265
                        p.log.Warnf("Re-enable channel %v failed, received "+
×
3266
                                "inactive link event", chanPoint)
×
3267

3268
                case <-p.cg.Done():
×
3269
                        p.log.Debugf("Peer shutdown during retry enabling")
×
3270
                        return
×
3271
                }
3272
        }
3273
}
3274

3275
// chooseDeliveryScript takes two optionally set shutdown scripts and returns
3276
// a suitable script to close out to. This may be nil if neither script is
3277
// set. If both scripts are set, this function will error if they do not match.
3278
func chooseDeliveryScript(upfront, requested lnwire.DeliveryAddress,
3279
        genDeliveryScript func() ([]byte, error),
3280
) (lnwire.DeliveryAddress, error) {
12✔
3281

12✔
3282
        switch {
12✔
3283
        // If no script was provided, then we'll generate a new delivery script.
3284
        case len(upfront) == 0 && len(requested) == 0:
4✔
3285
                return genDeliveryScript()
4✔
3286

3287
        // If no upfront shutdown script was provided, return the user
3288
        // requested address (which may be nil).
3289
        case len(upfront) == 0:
2✔
3290
                return requested, nil
2✔
3291

3292
        // If an upfront shutdown script was provided, and the user did not
3293
        // request a custom shutdown script, return the upfront address.
3294
        case len(requested) == 0:
2✔
3295
                return upfront, nil
2✔
3296

3297
        // If both an upfront shutdown script and a custom close script were
3298
        // provided, error if the user provided shutdown script does not match
3299
        // the upfront shutdown script (because closing out to a different
3300
        // script would violate upfront shutdown).
3301
        case !bytes.Equal(upfront, requested):
2✔
3302
                return nil, chancloser.ErrUpfrontShutdownScriptMismatch
2✔
3303

3304
        // The user requested script matches the upfront shutdown script, so we
3305
        // can return it without error.
3306
        default:
2✔
3307
                return upfront, nil
2✔
3308
        }
3309
}
3310

3311
// restartCoopClose checks whether we need to restart the cooperative close
3312
// process for a given channel.
3313
func (p *Brontide) restartCoopClose(lnChan *lnwallet.LightningChannel) (
3314
        *lnwire.Shutdown, error) {
×
3315

×
3316
        isTaprootChan := lnChan.ChanType().IsTaproot()
×
3317

×
3318
        // If this channel has status ChanStatusCoopBroadcasted and does not
×
3319
        // have a closing transaction, then the cooperative close process was
×
3320
        // started but never finished. We'll re-create the chanCloser state
×
3321
        // machine and resend Shutdown. BOLT#2 requires that we retransmit
×
3322
        // Shutdown exactly, but doing so would mean persisting the RPC
×
3323
        // provided close script. Instead use the LocalUpfrontShutdownScript
×
3324
        // or generate a script.
×
3325
        c := lnChan.State()
×
3326
        _, err := c.BroadcastedCooperative()
×
3327
        if err != nil && err != channeldb.ErrNoCloseTx {
×
3328
                // An error other than ErrNoCloseTx was encountered.
×
3329
                return nil, err
×
3330
        } else if err == nil && !p.rbfCoopCloseAllowed() {
×
3331
                // This is a channel that doesn't support RBF coop close, and it
×
3332
                // already had a coop close txn broadcast. As a result, we can
×
3333
                // just exit here as all we can do is wait for it to confirm.
×
3334
                return nil, nil
×
3335
        }
×
3336

3337
        chanID := lnwire.NewChanIDFromOutPoint(c.FundingOutpoint)
×
3338

×
3339
        var deliveryScript []byte
×
3340

×
3341
        shutdownInfo, err := c.ShutdownInfo()
×
3342
        switch {
×
3343
        // We have previously stored the delivery script that we need to use
3344
        // in the shutdown message. Re-use this script.
3345
        case err == nil:
×
3346
                shutdownInfo.WhenSome(func(info channeldb.ShutdownInfo) {
×
3347
                        deliveryScript = info.DeliveryScript.Val
×
3348
                })
×
3349

3350
        // An error other than ErrNoShutdownInfo was returned
3351
        case !errors.Is(err, channeldb.ErrNoShutdownInfo):
×
3352
                return nil, err
×
3353

3354
        case errors.Is(err, channeldb.ErrNoShutdownInfo):
×
3355
                deliveryScript = c.LocalShutdownScript
×
3356
                if len(deliveryScript) == 0 {
×
3357
                        var err error
×
3358
                        deliveryScript, err = p.genDeliveryScript()
×
3359
                        if err != nil {
×
3360
                                p.log.Errorf("unable to gen delivery script: "+
×
3361
                                        "%v", err)
×
3362

×
3363
                                return nil, fmt.Errorf("close addr unavailable")
×
3364
                        }
×
3365
                }
3366
        }
3367

3368
        // If the new RBF co-op close is negotiated, then we'll init and start
3369
        // that state machine, skipping the steps for the negotiate machine
3370
        // below. We don't support this close type for taproot channels though.
3371
        if p.rbfCoopCloseAllowed() && !isTaprootChan {
×
3372
                _, err := p.initRbfChanCloser(lnChan)
×
3373
                if err != nil {
×
3374
                        return nil, fmt.Errorf("unable to init rbf chan "+
×
3375
                                "closer during restart: %w", err)
×
3376
                }
×
3377

3378
                shutdownDesc := fn.MapOption(
×
3379
                        newRestartShutdownInit,
×
3380
                )(shutdownInfo)
×
3381

×
3382
                err = p.startRbfChanCloser(
×
3383
                        fn.FlattenOption(shutdownDesc), lnChan.ChannelPoint(),
×
3384
                )
×
3385

×
3386
                return nil, err
×
3387
        }
3388

3389
        // Compute an ideal fee.
3390
        feePerKw, err := p.cfg.FeeEstimator.EstimateFeePerKW(
×
3391
                p.cfg.CoopCloseTargetConfs,
×
3392
        )
×
3393
        if err != nil {
×
3394
                p.log.Errorf("unable to query fee estimator: %v", err)
×
3395
                return nil, fmt.Errorf("unable to estimate fee")
×
3396
        }
×
3397

3398
        // Determine whether we or the peer are the initiator of the coop
3399
        // close attempt by looking at the channel's status.
3400
        closingParty := lntypes.Remote
×
3401
        if c.HasChanStatus(channeldb.ChanStatusLocalCloseInitiator) {
×
3402
                closingParty = lntypes.Local
×
3403
        }
×
3404

3405
        addr, err := p.addrWithInternalKey(deliveryScript)
×
3406
        if err != nil {
×
3407
                return nil, fmt.Errorf("unable to parse addr: %w", err)
×
3408
        }
×
3409
        chanCloser, err := p.createChanCloser(
×
3410
                lnChan, addr, feePerKw, nil, closingParty,
×
3411
        )
×
3412
        if err != nil {
×
3413
                p.log.Errorf("unable to create chan closer: %v", err)
×
3414
                return nil, fmt.Errorf("unable to create chan closer")
×
3415
        }
×
3416

3417
        p.activeChanCloses.Store(chanID, makeNegotiateCloser(chanCloser))
×
3418

×
3419
        // Create the Shutdown message.
×
3420
        shutdownMsg, err := chanCloser.ShutdownChan()
×
3421
        if err != nil {
×
3422
                p.log.Errorf("unable to create shutdown message: %v", err)
×
3423
                p.activeChanCloses.Delete(chanID)
×
3424
                return nil, err
×
3425
        }
×
3426

3427
        return shutdownMsg, nil
×
3428
}
3429

3430
// createChanCloser constructs a ChanCloser from the passed parameters and is
3431
// used to de-duplicate code.
3432
func (p *Brontide) createChanCloser(channel *lnwallet.LightningChannel,
3433
        deliveryScript *chancloser.DeliveryAddrWithKey,
3434
        fee chainfee.SatPerKWeight, req *htlcswitch.ChanClose,
3435
        closer lntypes.ChannelParty) (*chancloser.ChanCloser, error) {
9✔
3436

9✔
3437
        _, startingHeight, err := p.cfg.ChainIO.GetBestBlock()
9✔
3438
        if err != nil {
9✔
3439
                p.log.Errorf("unable to obtain best block: %v", err)
×
3440
                return nil, fmt.Errorf("cannot obtain best block")
×
3441
        }
×
3442

3443
        // The req will only be set if we initiated the co-op closing flow.
3444
        var maxFee chainfee.SatPerKWeight
9✔
3445
        if req != nil {
15✔
3446
                maxFee = req.MaxFee
6✔
3447
        }
6✔
3448

3449
        chanCloser := chancloser.NewChanCloser(
9✔
3450
                chancloser.ChanCloseCfg{
9✔
3451
                        Channel:      channel,
9✔
3452
                        MusigSession: NewMusigChanCloser(channel),
9✔
3453
                        FeeEstimator: &chancloser.SimpleCoopFeeEstimator{},
9✔
3454
                        BroadcastTx:  p.cfg.Wallet.PublishTransaction,
9✔
3455
                        AuxCloser:    p.cfg.AuxChanCloser,
9✔
3456
                        DisableChannel: func(op wire.OutPoint) error {
18✔
3457
                                return p.cfg.ChanStatusMgr.RequestDisable(
9✔
3458
                                        op, false,
9✔
3459
                                )
9✔
3460
                        },
9✔
3461
                        MaxFee: maxFee,
3462
                        Disconnect: func() error {
×
3463
                                return p.cfg.DisconnectPeer(p.IdentityKey())
×
3464
                        },
×
3465
                        ChainParams: &p.cfg.Wallet.Cfg.NetParams,
3466
                },
3467
                *deliveryScript,
3468
                fee,
3469
                uint32(startingHeight),
3470
                req,
3471
                closer,
3472
        )
3473

3474
        return chanCloser, nil
9✔
3475
}
3476

3477
// initNegotiateChanCloser initializes the channel closer for a channel that is
3478
// using the original "negotiation" based protocol. This path is used when
3479
// we're the one initiating the channel close.
3480
//
3481
// TODO(roasbeef): can make a MsgEndpoint for existing handling logic to
3482
// further abstract.
3483
func (p *Brontide) initNegotiateChanCloser(req *htlcswitch.ChanClose,
3484
        channel *lnwallet.LightningChannel) error {
7✔
3485

7✔
3486
        // First, we'll choose a delivery address that we'll use to send the
7✔
3487
        // funds to in the case of a successful negotiation.
7✔
3488

7✔
3489
        // An upfront shutdown and user provided script are both optional, but
7✔
3490
        // must be equal if both set  (because we cannot serve a request to
7✔
3491
        // close out to a script which violates upfront shutdown). Get the
7✔
3492
        // appropriate address to close out to (which may be nil if neither are
7✔
3493
        // set) and error if they are both set and do not match.
7✔
3494
        deliveryScript, err := chooseDeliveryScript(
7✔
3495
                channel.LocalUpfrontShutdownScript(), req.DeliveryScript,
7✔
3496
                p.genDeliveryScript,
7✔
3497
        )
7✔
3498
        if err != nil {
8✔
3499
                return fmt.Errorf("cannot close channel %v: %w",
1✔
3500
                        req.ChanPoint, err)
1✔
3501
        }
1✔
3502

3503
        addr, err := p.addrWithInternalKey(deliveryScript)
6✔
3504
        if err != nil {
6✔
3505
                return fmt.Errorf("unable to parse addr for channel "+
×
3506
                        "%v: %w", req.ChanPoint, err)
×
3507
        }
×
3508

3509
        chanCloser, err := p.createChanCloser(
6✔
3510
                channel, addr, req.TargetFeePerKw, req, lntypes.Local,
6✔
3511
        )
6✔
3512
        if err != nil {
6✔
3513
                return fmt.Errorf("unable to make chan closer: %w", err)
×
3514
        }
×
3515

3516
        chanID := lnwire.NewChanIDFromOutPoint(channel.ChannelPoint())
6✔
3517
        p.activeChanCloses.Store(chanID, makeNegotiateCloser(chanCloser))
6✔
3518

6✔
3519
        // Finally, we'll initiate the channel shutdown within the
6✔
3520
        // chanCloser, and send the shutdown message to the remote
6✔
3521
        // party to kick things off.
6✔
3522
        shutdownMsg, err := chanCloser.ShutdownChan()
6✔
3523
        if err != nil {
6✔
3524
                // As we were unable to shutdown the channel, we'll return it
×
3525
                // back to its normal state.
×
3526
                defer channel.ResetState()
×
3527

×
3528
                p.activeChanCloses.Delete(chanID)
×
3529

×
3530
                return fmt.Errorf("unable to shutdown channel: %w", err)
×
3531
        }
×
3532

3533
        link := p.fetchLinkFromKeyAndCid(chanID)
6✔
3534
        if link == nil {
6✔
3535
                // If the link is nil then it means it was already removed from
×
3536
                // the switch or it never existed in the first place. The
×
3537
                // latter case is handled at the beginning of this function, so
×
3538
                // in the case where it has already been removed, we can skip
×
3539
                // adding the commit hook to queue a Shutdown message.
×
3540
                p.log.Warnf("link not found during attempted closure: "+
×
3541
                        "%v", chanID)
×
3542
                return nil
×
3543
        }
×
3544

3545
        if !link.DisableAdds(htlcswitch.Outgoing) {
6✔
3546
                p.log.Warnf("Outgoing link adds already "+
×
3547
                        "disabled: %v", link.ChanID())
×
3548
        }
×
3549

3550
        link.OnCommitOnce(htlcswitch.Outgoing, func() {
12✔
3551
                p.queueMsg(shutdownMsg, nil)
6✔
3552
        })
6✔
3553

3554
        return nil
6✔
3555
}
3556

3557
// chooseAddr returns the provided address if it is non-zero length, otherwise
3558
// None.
3559
func chooseAddr(addr lnwire.DeliveryAddress) fn.Option[lnwire.DeliveryAddress] {
×
3560
        if len(addr) == 0 {
×
3561
                return fn.None[lnwire.DeliveryAddress]()
×
3562
        }
×
3563

3564
        return fn.Some(addr)
×
3565
}
3566

3567
// observeRbfCloseUpdates observes the channel for any updates that may
3568
// indicate that a new txid has been broadcasted, or the channel fully closed
3569
// on chain.
3570
func (p *Brontide) observeRbfCloseUpdates(chanCloser *chancloser.RbfChanCloser,
3571
        closeReq *htlcswitch.ChanClose,
3572
        coopCloseStates chancloser.RbfStateSub) {
×
3573

×
3574
        newStateChan := coopCloseStates.NewItemCreated.ChanOut()
×
3575
        defer chanCloser.RemoveStateSub(coopCloseStates)
×
3576

×
3577
        var (
×
3578
                lastTxids    lntypes.Dual[chainhash.Hash]
×
3579
                lastFeeRates lntypes.Dual[chainfee.SatPerVByte]
×
3580
        )
×
3581

×
3582
        maybeNotifyTxBroadcast := func(state chancloser.AsymmetricPeerState,
×
3583
                party lntypes.ChannelParty) {
×
3584

×
3585
                // First, check to see if we have an error to report to the
×
3586
                // caller. If so, then we''ll return that error and exit, as the
×
3587
                // stream will exit as well.
×
3588
                if closeErr, ok := state.(*chancloser.CloseErr); ok {
×
3589
                        // We hit an error during the last state transition, so
×
3590
                        // we'll extract the error then send it to the
×
3591
                        // user.
×
3592
                        err := closeErr.Err()
×
3593

×
3594
                        peerLog.Warnf("ChannelPoint(%v): encountered close "+
×
3595
                                "err: %v", closeReq.ChanPoint, err)
×
3596

×
3597
                        select {
×
3598
                        case closeReq.Err <- err:
×
3599
                        case <-closeReq.Ctx.Done():
×
3600
                        case <-p.cg.Done():
×
3601
                        }
3602

3603
                        return
×
3604
                }
3605

3606
                closePending, ok := state.(*chancloser.ClosePending)
×
3607

×
3608
                // If this isn't the close pending state, we aren't at the
×
3609
                // terminal state yet.
×
3610
                if !ok {
×
3611
                        return
×
3612
                }
×
3613

3614
                // Only notify if the fee rate is greater.
3615
                newFeeRate := closePending.FeeRate
×
3616
                lastFeeRate := lastFeeRates.GetForParty(party)
×
3617
                if newFeeRate <= lastFeeRate {
×
3618
                        peerLog.Debugf("ChannelPoint(%v): remote party made "+
×
3619
                                "update for fee rate %v, but we already have "+
×
3620
                                "a higher fee rate of %v", closeReq.ChanPoint,
×
3621
                                newFeeRate, lastFeeRate)
×
3622

×
3623
                        return
×
3624
                }
×
3625

3626
                feeRate := closePending.FeeRate
×
3627
                lastFeeRates.SetForParty(party, feeRate)
×
3628

×
3629
                // At this point, we'll have a txid that we can use to notify
×
3630
                // the client, but only if it's different from the last one we
×
3631
                // sent. If the user attempted to bump, but was rejected due to
×
3632
                // RBF, then we'll send a redundant update.
×
3633
                closingTxid := closePending.CloseTx.TxHash()
×
3634
                lastTxid := lastTxids.GetForParty(party)
×
3635
                if closeReq != nil && closingTxid != lastTxid {
×
3636
                        select {
×
3637
                        case closeReq.Updates <- &PendingUpdate{
3638
                                Txid:        closingTxid[:],
3639
                                FeePerVbyte: fn.Some(closePending.FeeRate),
3640
                                IsLocalCloseTx: fn.Some(
3641
                                        party == lntypes.Local,
3642
                                ),
3643
                        }:
×
3644

3645
                        case <-closeReq.Ctx.Done():
×
3646
                                return
×
3647

3648
                        case <-p.cg.Done():
×
3649
                                return
×
3650
                        }
3651
                }
3652

3653
                lastTxids.SetForParty(party, closingTxid)
×
3654
        }
3655

3656
        peerLog.Infof("Observing RBF close updates for channel %v",
×
3657
                closeReq.ChanPoint)
×
3658

×
3659
        // We'll consume each new incoming state to send out the appropriate
×
3660
        // RPC update.
×
3661
        for {
×
3662
                select {
×
3663
                case newState := <-newStateChan:
×
3664

×
3665
                        switch closeState := newState.(type) {
×
3666
                        // Once we've reached the state of pending close, we
3667
                        // have a txid that we broadcasted.
3668
                        case *chancloser.ClosingNegotiation:
×
3669
                                peerState := closeState.PeerState
×
3670

×
3671
                                // Each side may have gained a new co-op close
×
3672
                                // tx, so we'll examine both to see if they've
×
3673
                                // changed.
×
3674
                                maybeNotifyTxBroadcast(
×
3675
                                        peerState.GetForParty(lntypes.Local),
×
3676
                                        lntypes.Local,
×
3677
                                )
×
3678
                                maybeNotifyTxBroadcast(
×
3679
                                        peerState.GetForParty(lntypes.Remote),
×
3680
                                        lntypes.Remote,
×
3681
                                )
×
3682

3683
                        // Otherwise, if we're transition to CloseFin, then we
3684
                        // know that we're done.
3685
                        case *chancloser.CloseFin:
×
3686
                                // To clean up, we'll remove the chan closer
×
3687
                                // from the active map, and send the final
×
3688
                                // update to the client.
×
3689
                                closingTxid := closeState.ConfirmedTx.TxHash()
×
3690
                                if closeReq != nil {
×
3691
                                        closeReq.Updates <- &ChannelCloseUpdate{
×
3692
                                                ClosingTxid: closingTxid[:],
×
3693
                                                Success:     true,
×
3694
                                        }
×
3695
                                }
×
3696
                                chanID := lnwire.NewChanIDFromOutPoint(
×
3697
                                        *closeReq.ChanPoint,
×
3698
                                )
×
3699
                                p.activeChanCloses.Delete(chanID)
×
3700

×
3701
                                return
×
3702
                        }
3703

3704
                case <-closeReq.Ctx.Done():
×
3705
                        return
×
3706

3707
                case <-p.cg.Done():
×
3708
                        return
×
3709
                }
3710
        }
3711
}
3712

3713
// chanErrorReporter is a simple implementation of the
3714
// chancloser.ErrorReporter. This is bound to a single channel by the channel
3715
// ID.
3716
type chanErrorReporter struct {
3717
        chanID lnwire.ChannelID
3718
        peer   *Brontide
3719
}
3720

3721
// newChanErrorReporter creates a new instance of the chanErrorReporter.
3722
func newChanErrorReporter(chanID lnwire.ChannelID,
3723
        peer *Brontide) *chanErrorReporter {
×
3724

×
3725
        return &chanErrorReporter{
×
3726
                chanID: chanID,
×
3727
                peer:   peer,
×
3728
        }
×
3729
}
×
3730

3731
// ReportError is a method that's used to report an error that occurred during
3732
// state machine execution. This is used by the RBF close state machine to
3733
// terminate the state machine and send an error to the remote peer.
3734
//
3735
// This is a part of the chancloser.ErrorReporter interface.
3736
func (c *chanErrorReporter) ReportError(chanErr error) {
×
3737
        c.peer.log.Errorf("coop close error for channel %v: %v",
×
3738
                c.chanID, chanErr)
×
3739

×
3740
        var errMsg []byte
×
3741
        if errors.Is(chanErr, chancloser.ErrInvalidStateTransition) {
×
3742
                errMsg = []byte("unexpected protocol message")
×
3743
        } else {
×
3744
                errMsg = []byte(chanErr.Error())
×
3745
        }
×
3746

3747
        err := c.peer.SendMessageLazy(false, &lnwire.Error{
×
3748
                ChanID: c.chanID,
×
3749
                Data:   errMsg,
×
3750
        })
×
3751
        if err != nil {
×
3752
                c.peer.log.Warnf("unable to send error message to peer: %v",
×
3753
                        err)
×
3754
        }
×
3755

3756
        // After we send the error message to the peer, we'll re-initialize the
3757
        // coop close state machine as they may send a shutdown message to
3758
        // retry the coop close.
3759
        lnChan, ok := c.peer.activeChannels.Load(c.chanID)
×
3760
        if !ok {
×
3761
                return
×
3762
        }
×
3763

3764
        if lnChan == nil {
×
3765
                c.peer.log.Debugf("channel %v is pending, not "+
×
3766
                        "re-initializing coop close state machine",
×
3767
                        c.chanID)
×
3768

×
3769
                return
×
3770
        }
×
3771

3772
        if _, err := c.peer.initRbfChanCloser(lnChan); err != nil {
×
3773
                c.peer.activeChanCloses.Delete(c.chanID)
×
3774

×
3775
                c.peer.log.Errorf("unable to init RBF chan closer after "+
×
3776
                        "error case: %v", err)
×
3777
        }
×
3778
}
3779

3780
// chanFlushEventSentinel is used to send the RBF coop close state machine the
3781
// channel flushed event. We'll wait until the state machine enters the
3782
// ChannelFlushing state, then request the link to send the event once flushed.
3783
//
3784
// NOTE: This MUST be run as a goroutine.
3785
func (p *Brontide) chanFlushEventSentinel(chanCloser *chancloser.RbfChanCloser,
3786
        link htlcswitch.ChannelUpdateHandler,
3787
        channel *lnwallet.LightningChannel) {
×
3788

×
3789
        defer p.cg.WgDone()
×
3790

×
3791
        // If there's no link, then the channel has already been flushed, so we
×
3792
        // don't need to continue.
×
3793
        if link == nil {
×
3794
                return
×
3795
        }
×
3796

3797
        coopCloseStates := chanCloser.RegisterStateEvents()
×
3798
        defer chanCloser.RemoveStateSub(coopCloseStates)
×
3799

×
3800
        newStateChan := coopCloseStates.NewItemCreated.ChanOut()
×
3801

×
3802
        sendChanFlushed := func() {
×
3803
                chanState := channel.StateSnapshot()
×
3804

×
3805
                peerLog.Infof("ChannelPoint(%v) has been flushed for co-op "+
×
3806
                        "close, sending event to chan closer",
×
3807
                        channel.ChannelPoint())
×
3808

×
3809
                chanBalances := chancloser.ShutdownBalances{
×
3810
                        LocalBalance:  chanState.LocalBalance,
×
3811
                        RemoteBalance: chanState.RemoteBalance,
×
3812
                }
×
3813
                ctx := context.Background()
×
3814
                chanCloser.SendEvent(ctx, &chancloser.ChannelFlushed{
×
3815
                        ShutdownBalances: chanBalances,
×
3816
                        FreshFlush:       true,
×
3817
                })
×
3818
        }
×
3819

3820
        // We'll wait until the channel enters the ChannelFlushing state. We
3821
        // exit after a success loop. As after the first RBF iteration, the
3822
        // channel will always be flushed.
3823
        for {
×
3824
                select {
×
3825
                case newState, ok := <-newStateChan:
×
3826
                        if !ok {
×
3827
                                return
×
3828
                        }
×
3829

3830
                        if _, ok := newState.(*chancloser.ChannelFlushing); ok {
×
3831
                                peerLog.Infof("ChannelPoint(%v): rbf coop "+
×
3832
                                        "close is awaiting a flushed state, "+
×
3833
                                        "registering with link..., ",
×
3834
                                        channel.ChannelPoint())
×
3835

×
3836
                                // Request the link to send the event once the
×
3837
                                // channel is flushed. We only need this event
×
3838
                                // sent once, so we can exit now.
×
3839
                                link.OnFlushedOnce(sendChanFlushed)
×
3840

×
3841
                                return
×
3842
                        }
×
3843

3844
                case <-p.cg.Done():
×
3845
                        return
×
3846
                }
3847
        }
3848
}
3849

3850
// initRbfChanCloser initializes the channel closer for a channel that
3851
// is using the new RBF based co-op close protocol. This only creates the chan
3852
// closer, but doesn't attempt to trigger any manual state transitions.
3853
func (p *Brontide) initRbfChanCloser(
3854
        channel *lnwallet.LightningChannel) (*chancloser.RbfChanCloser, error) {
×
3855

×
3856
        chanID := lnwire.NewChanIDFromOutPoint(channel.ChannelPoint())
×
3857

×
3858
        link := p.fetchLinkFromKeyAndCid(chanID)
×
3859

×
3860
        _, startingHeight, err := p.cfg.ChainIO.GetBestBlock()
×
3861
        if err != nil {
×
3862
                return nil, fmt.Errorf("cannot obtain best block: %w", err)
×
3863
        }
×
3864

3865
        defaultFeePerKw, err := p.cfg.FeeEstimator.EstimateFeePerKW(
×
3866
                p.cfg.CoopCloseTargetConfs,
×
3867
        )
×
3868
        if err != nil {
×
3869
                return nil, fmt.Errorf("unable to estimate fee: %w", err)
×
3870
        }
×
3871

3872
        thawHeight, err := channel.AbsoluteThawHeight()
×
3873
        if err != nil {
×
3874
                return nil, fmt.Errorf("unable to get thaw height: %w", err)
×
3875
        }
×
3876

3877
        peerPub := *p.IdentityKey()
×
3878

×
3879
        msgMapper := chancloser.NewRbfMsgMapper(
×
3880
                uint32(startingHeight), chanID, peerPub,
×
3881
        )
×
3882

×
3883
        initialState := chancloser.ChannelActive{}
×
3884

×
3885
        scid := channel.ZeroConfRealScid().UnwrapOr(
×
3886
                channel.ShortChanID(),
×
3887
        )
×
3888

×
3889
        env := chancloser.Environment{
×
3890
                ChainParams:    p.cfg.Wallet.Cfg.NetParams,
×
3891
                ChanPeer:       peerPub,
×
3892
                ChanPoint:      channel.ChannelPoint(),
×
3893
                ChanID:         chanID,
×
3894
                Scid:           scid,
×
3895
                ChanType:       channel.ChanType(),
×
3896
                DefaultFeeRate: defaultFeePerKw.FeePerVByte(),
×
3897
                ThawHeight:     fn.Some(thawHeight),
×
3898
                RemoteUpfrontShutdown: chooseAddr(
×
3899
                        channel.RemoteUpfrontShutdownScript(),
×
3900
                ),
×
3901
                LocalUpfrontShutdown: chooseAddr(
×
3902
                        channel.LocalUpfrontShutdownScript(),
×
3903
                ),
×
3904
                NewDeliveryScript: func() (lnwire.DeliveryAddress, error) {
×
3905
                        return p.genDeliveryScript()
×
3906
                },
×
3907
                FeeEstimator: &chancloser.SimpleCoopFeeEstimator{},
3908
                CloseSigner:  channel,
3909
                ChanObserver: newChanObserver(
3910
                        channel, link, p.cfg.ChanStatusMgr,
3911
                ),
3912
        }
3913

3914
        spendEvent := protofsm.RegisterSpend[chancloser.ProtocolEvent]{
×
3915
                OutPoint:   channel.ChannelPoint(),
×
3916
                PkScript:   channel.FundingTxOut().PkScript,
×
3917
                HeightHint: channel.DeriveHeightHint(),
×
3918
                PostSpendEvent: fn.Some[chancloser.RbfSpendMapper](
×
3919
                        chancloser.SpendMapper,
×
3920
                ),
×
3921
        }
×
3922

×
3923
        daemonAdapters := NewLndDaemonAdapters(LndAdapterCfg{
×
3924
                MsgSender:     newPeerMsgSender(peerPub, p),
×
3925
                TxBroadcaster: p.cfg.Wallet,
×
3926
                ChainNotifier: p.cfg.ChainNotifier,
×
3927
        })
×
3928

×
3929
        protoCfg := chancloser.RbfChanCloserCfg{
×
3930
                Daemon:        daemonAdapters,
×
3931
                InitialState:  &initialState,
×
3932
                Env:           &env,
×
3933
                InitEvent:     fn.Some[protofsm.DaemonEvent](&spendEvent),
×
3934
                ErrorReporter: newChanErrorReporter(chanID, p),
×
3935
                MsgMapper: fn.Some[protofsm.MsgMapper[chancloser.ProtocolEvent]]( //nolint:ll
×
3936
                        msgMapper,
×
3937
                ),
×
3938
        }
×
3939

×
3940
        ctx := context.Background()
×
3941
        chanCloser := protofsm.NewStateMachine(protoCfg)
×
3942
        chanCloser.Start(ctx)
×
3943

×
3944
        // Finally, we'll register this new endpoint with the message router so
×
3945
        // future co-op close messages are handled by this state machine.
×
3946
        err = fn.MapOptionZ(p.msgRouter, func(r msgmux.Router) error {
×
3947
                _ = r.UnregisterEndpoint(chanCloser.Name())
×
3948

×
3949
                return r.RegisterEndpoint(&chanCloser)
×
3950
        })
×
3951
        if err != nil {
×
3952
                chanCloser.Stop()
×
3953

×
3954
                return nil, fmt.Errorf("unable to register endpoint for co-op "+
×
3955
                        "close: %w", err)
×
3956
        }
×
3957

3958
        p.activeChanCloses.Store(chanID, makeRbfCloser(&chanCloser))
×
3959

×
3960
        // Now that we've created the rbf closer state machine, we'll launch a
×
3961
        // new goroutine to eventually send in the ChannelFlushed event once
×
3962
        // needed.
×
3963
        p.cg.WgAdd(1)
×
3964
        go p.chanFlushEventSentinel(&chanCloser, link, channel)
×
3965

×
3966
        return &chanCloser, nil
×
3967
}
3968

3969
// shutdownInit describes the two ways we can initiate a new shutdown. Either we
3970
// got an RPC request to do so (left), or we sent a shutdown message to the
3971
// party (for w/e reason), but crashed before the close was complete.
3972
//
3973
//nolint:ll
3974
type shutdownInit = fn.Option[fn.Either[*htlcswitch.ChanClose, channeldb.ShutdownInfo]]
3975

3976
// shutdownStartFeeRate returns the fee rate that should be used for the
3977
// shutdown.  This returns a doubly wrapped option as the shutdown info might
3978
// be none, and the fee rate is only defined for the user initiated shutdown.
3979
func shutdownStartFeeRate(s shutdownInit) fn.Option[chainfee.SatPerKWeight] {
×
3980
        feeRateOpt := fn.MapOption(func(init fn.Either[*htlcswitch.ChanClose,
×
3981
                channeldb.ShutdownInfo]) fn.Option[chainfee.SatPerKWeight] {
×
3982

×
3983
                var feeRate fn.Option[chainfee.SatPerKWeight]
×
3984
                init.WhenLeft(func(req *htlcswitch.ChanClose) {
×
3985
                        feeRate = fn.Some(req.TargetFeePerKw)
×
3986
                })
×
3987

3988
                return feeRate
×
3989
        })(s)
3990

3991
        return fn.FlattenOption(feeRateOpt)
×
3992
}
3993

3994
// shutdownStartAddr returns the delivery address that should be used when
3995
// restarting the shutdown process.  If we didn't send a shutdown before we
3996
// restarted, and the user didn't initiate one either, then None is returned.
3997
func shutdownStartAddr(s shutdownInit) fn.Option[lnwire.DeliveryAddress] {
×
3998
        addrOpt := fn.MapOption(func(init fn.Either[*htlcswitch.ChanClose,
×
3999
                channeldb.ShutdownInfo]) fn.Option[lnwire.DeliveryAddress] {
×
4000

×
4001
                var addr fn.Option[lnwire.DeliveryAddress]
×
4002
                init.WhenLeft(func(req *htlcswitch.ChanClose) {
×
4003
                        if len(req.DeliveryScript) != 0 {
×
4004
                                addr = fn.Some(req.DeliveryScript)
×
4005
                        }
×
4006
                })
4007
                init.WhenRight(func(info channeldb.ShutdownInfo) {
×
4008
                        addr = fn.Some(info.DeliveryScript.Val)
×
4009
                })
×
4010

4011
                return addr
×
4012
        })(s)
4013

4014
        return fn.FlattenOption(addrOpt)
×
4015
}
4016

4017
// whenRPCShutdown registers a callback to be executed when the shutdown init
4018
// type is and RPC request.
4019
func whenRPCShutdown(s shutdownInit, f func(r *htlcswitch.ChanClose)) {
×
4020
        s.WhenSome(func(init fn.Either[*htlcswitch.ChanClose,
×
4021
                channeldb.ShutdownInfo]) {
×
4022

×
4023
                init.WhenLeft(f)
×
4024
        })
×
4025
}
4026

4027
// newRestartShutdownInit creates a new shutdownInit for the case where we need
4028
// to restart the shutdown flow after a restart.
4029
func newRestartShutdownInit(info channeldb.ShutdownInfo) shutdownInit {
×
4030
        return fn.Some(fn.NewRight[*htlcswitch.ChanClose](info))
×
4031
}
×
4032

4033
// newRPCShutdownInit creates a new shutdownInit for the case where we
4034
// initiated the shutdown via an RPC client.
4035
func newRPCShutdownInit(req *htlcswitch.ChanClose) shutdownInit {
×
4036
        return fn.Some(
×
4037
                fn.NewLeft[*htlcswitch.ChanClose, channeldb.ShutdownInfo](req),
×
4038
        )
×
4039
}
×
4040

4041
// waitUntilRbfCoastClear waits until the RBF co-op close state machine has
4042
// advanced to a terminal state before attempting another fee bump.
4043
func waitUntilRbfCoastClear(ctx context.Context,
4044
        rbfCloser *chancloser.RbfChanCloser) error {
×
4045

×
4046
        coopCloseStates := rbfCloser.RegisterStateEvents()
×
4047
        newStateChan := coopCloseStates.NewItemCreated.ChanOut()
×
4048
        defer rbfCloser.RemoveStateSub(coopCloseStates)
×
4049

×
4050
        isTerminalState := func(newState chancloser.RbfState) bool {
×
4051
                // If we're not in the negotiation sub-state, then we aren't at
×
4052
                // the terminal state yet.
×
4053
                state, ok := newState.(*chancloser.ClosingNegotiation)
×
4054
                if !ok {
×
4055
                        return false
×
4056
                }
×
4057

4058
                localState := state.PeerState.GetForParty(lntypes.Local)
×
4059

×
4060
                // If this isn't the close pending state, we aren't at the
×
4061
                // terminal state yet.
×
4062
                _, ok = localState.(*chancloser.ClosePending)
×
4063

×
4064
                return ok
×
4065
        }
4066

4067
        // Before we enter the subscription loop below, check to see if we're
4068
        // already in the terminal state.
4069
        rbfState, err := rbfCloser.CurrentState()
×
4070
        if err != nil {
×
4071
                return err
×
4072
        }
×
4073
        if isTerminalState(rbfState) {
×
4074
                return nil
×
4075
        }
×
4076

4077
        peerLog.Debugf("Waiting for RBF iteration to complete...")
×
4078

×
4079
        for {
×
4080
                select {
×
4081
                case newState := <-newStateChan:
×
4082
                        if isTerminalState(newState) {
×
4083
                                return nil
×
4084
                        }
×
4085

4086
                case <-ctx.Done():
×
4087
                        return fmt.Errorf("context canceled")
×
4088
                }
4089
        }
4090
}
4091

4092
// startRbfChanCloser kicks off the co-op close process using the new RBF based
4093
// co-op close protocol. This is called when we're the one that's initiating
4094
// the cooperative channel close.
4095
//
4096
// TODO(roasbeef): just accept the two shutdown pointer params instead??
4097
func (p *Brontide) startRbfChanCloser(shutdown shutdownInit,
4098
        chanPoint wire.OutPoint) error {
×
4099

×
4100
        // Unlike the old negotiate chan closer, we'll always create the RBF
×
4101
        // chan closer on startup, so we can skip init here.
×
4102
        chanID := lnwire.NewChanIDFromOutPoint(chanPoint)
×
4103
        chanCloser, found := p.activeChanCloses.Load(chanID)
×
4104
        if !found {
×
4105
                return fmt.Errorf("rbf chan closer not found for channel %v",
×
4106
                        chanPoint)
×
4107
        }
×
4108

4109
        defaultFeePerKw, err := shutdownStartFeeRate(
×
4110
                shutdown,
×
4111
        ).UnwrapOrFuncErr(func() (chainfee.SatPerKWeight, error) {
×
4112
                return p.cfg.FeeEstimator.EstimateFeePerKW(
×
4113
                        p.cfg.CoopCloseTargetConfs,
×
4114
                )
×
4115
        })
×
4116
        if err != nil {
×
4117
                return fmt.Errorf("unable to estimate fee: %w", err)
×
4118
        }
×
4119

4120
        chanCloser.WhenRight(func(rbfCloser *chancloser.RbfChanCloser) {
×
4121
                peerLog.Infof("ChannelPoint(%v): rbf-coop close requested, "+
×
4122
                        "sending shutdown", chanPoint)
×
4123

×
4124
                rbfState, err := rbfCloser.CurrentState()
×
4125
                if err != nil {
×
4126
                        peerLog.Warnf("ChannelPoint(%v): unable to get "+
×
4127
                                "current state for rbf-coop close: %v",
×
4128
                                chanPoint, err)
×
4129

×
4130
                        return
×
4131
                }
×
4132

4133
                coopCloseStates := rbfCloser.RegisterStateEvents()
×
4134

×
4135
                // Before we send our event below, we'll launch a goroutine to
×
4136
                // watch for the final terminal state to send updates to the RPC
×
4137
                // client. We only need to do this if there's an RPC caller.
×
4138
                var rpcShutdown bool
×
4139
                whenRPCShutdown(shutdown, func(req *htlcswitch.ChanClose) {
×
4140
                        rpcShutdown = true
×
4141

×
4142
                        p.cg.WgAdd(1)
×
4143
                        go func() {
×
4144
                                defer p.cg.WgDone()
×
4145

×
4146
                                p.observeRbfCloseUpdates(
×
4147
                                        rbfCloser, req, coopCloseStates,
×
4148
                                )
×
4149
                        }()
×
4150
                })
4151

4152
                if !rpcShutdown {
×
4153
                        defer rbfCloser.RemoveStateSub(coopCloseStates)
×
4154
                }
×
4155

4156
                ctx, _ := p.cg.Create(context.Background())
×
4157
                feeRate := defaultFeePerKw.FeePerVByte()
×
4158

×
4159
                // Depending on the state of the state machine, we'll either
×
4160
                // kick things off by sending shutdown, or attempt to send a new
×
4161
                // offer to the remote party.
×
4162
                switch rbfState.(type) {
×
4163
                // The channel is still active, so we'll now kick off the co-op
4164
                // close process by instructing it to send a shutdown message to
4165
                // the remote party.
4166
                case *chancloser.ChannelActive:
×
4167
                        rbfCloser.SendEvent(
×
4168
                                context.Background(),
×
4169
                                &chancloser.SendShutdown{
×
4170
                                        IdealFeeRate: feeRate,
×
4171
                                        DeliveryAddr: shutdownStartAddr(
×
4172
                                                shutdown,
×
4173
                                        ),
×
4174
                                },
×
4175
                        )
×
4176

4177
                // If we haven't yet sent an offer (didn't have enough funds at
4178
                // the prior fee rate), or we've sent an offer, then we'll
4179
                // trigger a new offer event.
4180
                case *chancloser.ClosingNegotiation:
×
4181
                        // Before we send the event below, we'll wait until
×
4182
                        // we're in a semi-terminal state.
×
4183
                        err := waitUntilRbfCoastClear(ctx, rbfCloser)
×
4184
                        if err != nil {
×
4185
                                peerLog.Warnf("ChannelPoint(%v): unable to "+
×
4186
                                        "wait for coast to clear: %v",
×
4187
                                        chanPoint, err)
×
4188

×
4189
                                return
×
4190
                        }
×
4191

4192
                        event := chancloser.ProtocolEvent(
×
4193
                                &chancloser.SendOfferEvent{
×
4194
                                        TargetFeeRate: feeRate,
×
4195
                                },
×
4196
                        )
×
4197
                        rbfCloser.SendEvent(ctx, event)
×
4198

4199
                default:
×
4200
                        peerLog.Warnf("ChannelPoint(%v): unexpected state "+
×
4201
                                "for rbf-coop close: %T", chanPoint, rbfState)
×
4202
                }
4203
        })
4204

4205
        return nil
×
4206
}
4207

4208
// handleLocalCloseReq kicks-off the workflow to execute a cooperative or
4209
// forced unilateral closure of the channel initiated by a local subsystem.
4210
func (p *Brontide) handleLocalCloseReq(req *htlcswitch.ChanClose) {
7✔
4211
        chanID := lnwire.NewChanIDFromOutPoint(*req.ChanPoint)
7✔
4212

7✔
4213
        channel, ok := p.activeChannels.Load(chanID)
7✔
4214

7✔
4215
        // Though this function can't be called for pending channels, we still
7✔
4216
        // check whether channel is nil for safety.
7✔
4217
        if !ok || channel == nil {
7✔
4218
                err := fmt.Errorf("unable to close channel, ChannelID(%v) is "+
×
4219
                        "unknown", chanID)
×
4220
                p.log.Errorf(err.Error())
×
4221
                req.Err <- err
×
4222
                return
×
4223
        }
×
4224

4225
        isTaprootChan := channel.ChanType().IsTaproot()
7✔
4226

7✔
4227
        switch req.CloseType {
7✔
4228
        // A type of CloseRegular indicates that the user has opted to close
4229
        // out this channel on-chain, so we execute the cooperative channel
4230
        // closure workflow.
4231
        case contractcourt.CloseRegular:
7✔
4232
                var err error
7✔
4233
                switch {
7✔
4234
                // If this is the RBF coop state machine, then we'll instruct
4235
                // it to send the shutdown message. This also might be an RBF
4236
                // iteration, in which case we'll be obtaining a new
4237
                // transaction w/ a higher fee rate.
4238
                //
4239
                // We don't support this close type for taproot channels yet
4240
                // however.
4241
                case !isTaprootChan && p.rbfCoopCloseAllowed():
×
4242
                        err = p.startRbfChanCloser(
×
4243
                                newRPCShutdownInit(req), channel.ChannelPoint(),
×
4244
                        )
×
4245
                default:
7✔
4246
                        err = p.initNegotiateChanCloser(req, channel)
7✔
4247
                }
4248

4249
                if err != nil {
8✔
4250
                        p.log.Errorf(err.Error())
1✔
4251
                        req.Err <- err
1✔
4252
                }
1✔
4253

4254
        // A type of CloseBreach indicates that the counterparty has breached
4255
        // the channel therefore we need to clean up our local state.
4256
        case contractcourt.CloseBreach:
×
4257
                // TODO(roasbeef): no longer need with newer beach logic?
×
4258
                p.log.Infof("ChannelPoint(%v) has been breached, wiping "+
×
4259
                        "channel", req.ChanPoint)
×
4260
                p.WipeChannel(req.ChanPoint)
×
4261
        }
4262
}
4263

4264
// linkFailureReport is sent to the channelManager whenever a link reports a
4265
// link failure, and is forced to exit. The report houses the necessary
4266
// information to clean up the channel state, send back the error message, and
4267
// force close if necessary.
4268
type linkFailureReport struct {
4269
        chanPoint   wire.OutPoint
4270
        chanID      lnwire.ChannelID
4271
        shortChanID lnwire.ShortChannelID
4272
        linkErr     htlcswitch.LinkFailureError
4273
}
4274

4275
// handleLinkFailure processes a link failure report when a link in the switch
4276
// fails. It facilitates the removal of all channel state within the peer,
4277
// force closing the channel depending on severity, and sending the error
4278
// message back to the remote party.
4279
func (p *Brontide) handleLinkFailure(failure linkFailureReport) {
×
4280
        // Retrieve the channel from the map of active channels. We do this to
×
4281
        // have access to it even after WipeChannel remove it from the map.
×
4282
        chanID := lnwire.NewChanIDFromOutPoint(failure.chanPoint)
×
4283
        lnChan, _ := p.activeChannels.Load(chanID)
×
4284

×
4285
        // We begin by wiping the link, which will remove it from the switch,
×
4286
        // such that it won't be attempted used for any more updates.
×
4287
        //
×
4288
        // TODO(halseth): should introduce a way to atomically stop/pause the
×
4289
        // link and cancel back any adds in its mailboxes such that we can
×
4290
        // safely force close without the link being added again and updates
×
4291
        // being applied.
×
4292
        p.WipeChannel(&failure.chanPoint)
×
4293

×
4294
        // If the error encountered was severe enough, we'll now force close
×
4295
        // the channel to prevent reading it to the switch in the future.
×
4296
        if failure.linkErr.FailureAction == htlcswitch.LinkFailureForceClose {
×
4297
                p.log.Warnf("Force closing link(%v)", failure.shortChanID)
×
4298

×
4299
                closeTx, err := p.cfg.ChainArb.ForceCloseContract(
×
4300
                        failure.chanPoint,
×
4301
                )
×
4302
                if err != nil {
×
4303
                        p.log.Errorf("unable to force close "+
×
4304
                                "link(%v): %v", failure.shortChanID, err)
×
4305
                } else {
×
4306
                        p.log.Infof("channel(%v) force "+
×
4307
                                "closed with txid %v",
×
4308
                                failure.shortChanID, closeTx.TxHash())
×
4309
                }
×
4310
        }
4311

4312
        // If this is a permanent failure, we will mark the channel borked.
4313
        if failure.linkErr.PermanentFailure && lnChan != nil {
×
4314
                p.log.Warnf("Marking link(%v) borked due to permanent "+
×
4315
                        "failure", failure.shortChanID)
×
4316

×
4317
                if err := lnChan.State().MarkBorked(); err != nil {
×
4318
                        p.log.Errorf("Unable to mark channel %v borked: %v",
×
4319
                                failure.shortChanID, err)
×
4320
                }
×
4321
        }
4322

4323
        // Send an error to the peer, why we failed the channel.
4324
        if failure.linkErr.ShouldSendToPeer() {
×
4325
                // If SendData is set, send it to the peer. If not, we'll use
×
4326
                // the standard error messages in the payload. We only include
×
4327
                // sendData in the cases where the error data does not contain
×
4328
                // sensitive information.
×
4329
                data := []byte(failure.linkErr.Error())
×
4330
                if failure.linkErr.SendData != nil {
×
4331
                        data = failure.linkErr.SendData
×
4332
                }
×
4333

4334
                var networkMsg lnwire.Message
×
4335
                if failure.linkErr.Warning {
×
4336
                        networkMsg = &lnwire.Warning{
×
4337
                                ChanID: failure.chanID,
×
4338
                                Data:   data,
×
4339
                        }
×
4340
                } else {
×
4341
                        networkMsg = &lnwire.Error{
×
4342
                                ChanID: failure.chanID,
×
4343
                                Data:   data,
×
4344
                        }
×
4345
                }
×
4346

4347
                err := p.SendMessage(true, networkMsg)
×
4348
                if err != nil {
×
4349
                        p.log.Errorf("unable to send msg to "+
×
4350
                                "remote peer: %v", err)
×
4351
                }
×
4352
        }
4353

4354
        // If the failure action is disconnect, then we'll execute that now. If
4355
        // we had to send an error above, it was a sync call, so we expect the
4356
        // message to be flushed on the wire by now.
4357
        if failure.linkErr.FailureAction == htlcswitch.LinkFailureDisconnect {
×
4358
                p.Disconnect(fmt.Errorf("link requested disconnect"))
×
4359
        }
×
4360
}
4361

4362
// fetchLinkFromKeyAndCid fetches a link from the switch via the remote's
4363
// public key and the channel id.
4364
func (p *Brontide) fetchLinkFromKeyAndCid(
4365
        cid lnwire.ChannelID) htlcswitch.ChannelUpdateHandler {
19✔
4366

19✔
4367
        var chanLink htlcswitch.ChannelUpdateHandler
19✔
4368

19✔
4369
        // We don't need to check the error here, and can instead just loop
19✔
4370
        // over the slice and return nil.
19✔
4371
        links, _ := p.cfg.Switch.GetLinksByInterface(p.cfg.PubKeyBytes)
19✔
4372
        for _, link := range links {
37✔
4373
                if link.ChanID() == cid {
36✔
4374
                        chanLink = link
18✔
4375
                        break
18✔
4376
                }
4377
        }
4378

4379
        return chanLink
19✔
4380
}
4381

4382
// finalizeChanClosure performs the final clean up steps once the cooperative
4383
// closure transaction has been fully broadcast. The finalized closing state
4384
// machine should be passed in. Once the transaction has been sufficiently
4385
// confirmed, the channel will be marked as fully closed within the database,
4386
// and any clients will be notified of updates to the closing state.
4387
func (p *Brontide) finalizeChanClosure(chanCloser *chancloser.ChanCloser) {
4✔
4388
        closeReq := chanCloser.CloseRequest()
4✔
4389

4✔
4390
        // First, we'll clear all indexes related to the channel in question.
4✔
4391
        chanPoint := chanCloser.Channel().ChannelPoint()
4✔
4392
        p.WipeChannel(&chanPoint)
4✔
4393

4✔
4394
        // Also clear the activeChanCloses map of this channel.
4✔
4395
        cid := lnwire.NewChanIDFromOutPoint(chanPoint)
4✔
4396
        p.activeChanCloses.Delete(cid) // TODO(roasbeef): existing race
4✔
4397

4✔
4398
        // Next, we'll launch a goroutine which will request to be notified by
4✔
4399
        // the ChainNotifier once the closure transaction obtains a single
4✔
4400
        // confirmation.
4✔
4401
        notifier := p.cfg.ChainNotifier
4✔
4402

4✔
4403
        // If any error happens during waitForChanToClose, forward it to
4✔
4404
        // closeReq. If this channel closure is not locally initiated, closeReq
4✔
4405
        // will be nil, so just ignore the error.
4✔
4406
        errChan := make(chan error, 1)
4✔
4407
        if closeReq != nil {
6✔
4408
                errChan = closeReq.Err
2✔
4409
        }
2✔
4410

4411
        closingTx, err := chanCloser.ClosingTx()
4✔
4412
        if err != nil {
4✔
4413
                if closeReq != nil {
×
4414
                        p.log.Error(err)
×
4415
                        closeReq.Err <- err
×
4416
                }
×
4417
        }
4418

4419
        closingTxid := closingTx.TxHash()
4✔
4420

4✔
4421
        // If this is a locally requested shutdown, update the caller with a
4✔
4422
        // new event detailing the current pending state of this request.
4✔
4423
        if closeReq != nil {
6✔
4424
                closeReq.Updates <- &PendingUpdate{
2✔
4425
                        Txid: closingTxid[:],
2✔
4426
                }
2✔
4427
        }
2✔
4428

4429
        localOut := chanCloser.LocalCloseOutput()
4✔
4430
        remoteOut := chanCloser.RemoteCloseOutput()
4✔
4431
        auxOut := chanCloser.AuxOutputs()
4✔
4432
        go WaitForChanToClose(
4✔
4433
                chanCloser.NegotiationHeight(), notifier, errChan,
4✔
4434
                &chanPoint, &closingTxid, closingTx.TxOut[0].PkScript, func() {
8✔
4435
                        // Respond to the local subsystem which requested the
4✔
4436
                        // channel closure.
4✔
4437
                        if closeReq != nil {
6✔
4438
                                closeReq.Updates <- &ChannelCloseUpdate{
2✔
4439
                                        ClosingTxid:       closingTxid[:],
2✔
4440
                                        Success:           true,
2✔
4441
                                        LocalCloseOutput:  localOut,
2✔
4442
                                        RemoteCloseOutput: remoteOut,
2✔
4443
                                        AuxOutputs:        auxOut,
2✔
4444
                                }
2✔
4445
                        }
2✔
4446
                },
4447
        )
4448
}
4449

4450
// WaitForChanToClose uses the passed notifier to wait until the channel has
4451
// been detected as closed on chain and then concludes by executing the
4452
// following actions: the channel point will be sent over the settleChan, and
4453
// finally the callback will be executed. If any error is encountered within
4454
// the function, then it will be sent over the errChan.
4455
func WaitForChanToClose(bestHeight uint32, notifier chainntnfs.ChainNotifier,
4456
        errChan chan error, chanPoint *wire.OutPoint,
4457
        closingTxID *chainhash.Hash, closeScript []byte, cb func()) {
4✔
4458

4✔
4459
        peerLog.Infof("Waiting for confirmation of close of ChannelPoint(%v) "+
4✔
4460
                "with txid: %v", chanPoint, closingTxID)
4✔
4461

4✔
4462
        // TODO(roasbeef): add param for num needed confs
4✔
4463
        confNtfn, err := notifier.RegisterConfirmationsNtfn(
4✔
4464
                closingTxID, closeScript, 1, bestHeight,
4✔
4465
        )
4✔
4466
        if err != nil {
4✔
4467
                if errChan != nil {
×
4468
                        errChan <- err
×
4469
                }
×
4470
                return
×
4471
        }
4472

4473
        // In the case that the ChainNotifier is shutting down, all subscriber
4474
        // notification channels will be closed, generating a nil receive.
4475
        height, ok := <-confNtfn.Confirmed
4✔
4476
        if !ok {
4✔
4477
                return
×
4478
        }
×
4479

4480
        // The channel has been closed, remove it from any active indexes, and
4481
        // the database state.
4482
        peerLog.Infof("ChannelPoint(%v) is now closed at "+
4✔
4483
                "height %v", chanPoint, height.BlockHeight)
4✔
4484

4✔
4485
        // Finally, execute the closure call back to mark the confirmation of
4✔
4486
        // the transaction closing the contract.
4✔
4487
        cb()
4✔
4488
}
4489

4490
// WipeChannel removes the passed channel point from all indexes associated with
4491
// the peer and the switch.
4492
func (p *Brontide) WipeChannel(chanPoint *wire.OutPoint) {
4✔
4493
        chanID := lnwire.NewChanIDFromOutPoint(*chanPoint)
4✔
4494

4✔
4495
        p.activeChannels.Delete(chanID)
4✔
4496

4✔
4497
        // Instruct the HtlcSwitch to close this link as the channel is no
4✔
4498
        // longer active.
4✔
4499
        p.cfg.Switch.RemoveLink(chanID)
4✔
4500
}
4✔
4501

4502
// handleInitMsg handles the incoming init message which contains global and
4503
// local feature vectors. If feature vectors are incompatible then disconnect.
4504
func (p *Brontide) handleInitMsg(msg *lnwire.Init) error {
3✔
4505
        // First, merge any features from the legacy global features field into
3✔
4506
        // those presented in the local features fields.
3✔
4507
        err := msg.Features.Merge(msg.GlobalFeatures)
3✔
4508
        if err != nil {
3✔
4509
                return fmt.Errorf("unable to merge legacy global features: %w",
×
4510
                        err)
×
4511
        }
×
4512

4513
        // Then, finalize the remote feature vector providing the flattened
4514
        // feature bit namespace.
4515
        p.remoteFeatures = lnwire.NewFeatureVector(
3✔
4516
                msg.Features, lnwire.Features,
3✔
4517
        )
3✔
4518

3✔
4519
        // Now that we have their features loaded, we'll ensure that they
3✔
4520
        // didn't set any required bits that we don't know of.
3✔
4521
        err = feature.ValidateRequired(p.remoteFeatures)
3✔
4522
        if err != nil {
3✔
4523
                return fmt.Errorf("invalid remote features: %w", err)
×
4524
        }
×
4525

4526
        // Ensure the remote party's feature vector contains all transitive
4527
        // dependencies. We know ours are correct since they are validated
4528
        // during the feature manager's instantiation.
4529
        err = feature.ValidateDeps(p.remoteFeatures)
3✔
4530
        if err != nil {
3✔
4531
                return fmt.Errorf("invalid remote features: %w", err)
×
4532
        }
×
4533

4534
        // Now that we know we understand their requirements, we'll check to
4535
        // see if they don't support anything that we deem to be mandatory.
4536
        if !p.remoteFeatures.HasFeature(lnwire.DataLossProtectRequired) {
3✔
4537
                return fmt.Errorf("data loss protection required")
×
4538
        }
×
4539

4540
        return nil
3✔
4541
}
4542

4543
// LocalFeatures returns the set of global features that has been advertised by
4544
// the local node. This allows sub-systems that use this interface to gate their
4545
// behavior off the set of negotiated feature bits.
4546
//
4547
// NOTE: Part of the lnpeer.Peer interface.
4548
func (p *Brontide) LocalFeatures() *lnwire.FeatureVector {
×
4549
        return p.cfg.Features
×
4550
}
×
4551

4552
// RemoteFeatures returns the set of global features that has been advertised by
4553
// the remote node. This allows sub-systems that use this interface to gate
4554
// their behavior off the set of negotiated feature bits.
4555
//
4556
// NOTE: Part of the lnpeer.Peer interface.
4557
func (p *Brontide) RemoteFeatures() *lnwire.FeatureVector {
20✔
4558
        return p.remoteFeatures
20✔
4559
}
20✔
4560

4561
// hasNegotiatedScidAlias returns true if we've negotiated the
4562
// option-scid-alias feature bit with the peer.
4563
func (p *Brontide) hasNegotiatedScidAlias() bool {
3✔
4564
        peerHas := p.remoteFeatures.HasFeature(lnwire.ScidAliasOptional)
3✔
4565
        localHas := p.cfg.Features.HasFeature(lnwire.ScidAliasOptional)
3✔
4566
        return peerHas && localHas
3✔
4567
}
3✔
4568

4569
// sendInitMsg sends the Init message to the remote peer. This message contains
4570
// our currently supported local and global features.
4571
func (p *Brontide) sendInitMsg(legacyChan bool) error {
7✔
4572
        features := p.cfg.Features.Clone()
7✔
4573
        legacyFeatures := p.cfg.LegacyFeatures.Clone()
7✔
4574

7✔
4575
        // If we have a legacy channel open with a peer, we downgrade static
7✔
4576
        // remote required to optional in case the peer does not understand the
7✔
4577
        // required feature bit. If we do not do this, the peer will reject our
7✔
4578
        // connection because it does not understand a required feature bit, and
7✔
4579
        // our channel will be unusable.
7✔
4580
        if legacyChan && features.RequiresFeature(lnwire.StaticRemoteKeyRequired) {
8✔
4581
                p.log.Infof("Legacy channel open with peer, " +
1✔
4582
                        "downgrading static remote required feature bit to " +
1✔
4583
                        "optional")
1✔
4584

1✔
4585
                // Unset and set in both the local and global features to
1✔
4586
                // ensure both sets are consistent and merge able by old and
1✔
4587
                // new nodes.
1✔
4588
                features.Unset(lnwire.StaticRemoteKeyRequired)
1✔
4589
                legacyFeatures.Unset(lnwire.StaticRemoteKeyRequired)
1✔
4590

1✔
4591
                features.Set(lnwire.StaticRemoteKeyOptional)
1✔
4592
                legacyFeatures.Set(lnwire.StaticRemoteKeyOptional)
1✔
4593
        }
1✔
4594

4595
        msg := lnwire.NewInitMessage(
7✔
4596
                legacyFeatures.RawFeatureVector,
7✔
4597
                features.RawFeatureVector,
7✔
4598
        )
7✔
4599

7✔
4600
        return p.writeMessage(msg)
7✔
4601
}
4602

4603
// resendChanSyncMsg will attempt to find a channel sync message for the closed
4604
// channel and resend it to our peer.
4605
func (p *Brontide) resendChanSyncMsg(cid lnwire.ChannelID) error {
×
4606
        // If we already re-sent the mssage for this channel, we won't do it
×
4607
        // again.
×
4608
        if _, ok := p.resentChanSyncMsg[cid]; ok {
×
4609
                return nil
×
4610
        }
×
4611

4612
        // Check if we have any channel sync messages stored for this channel.
4613
        c, err := p.cfg.ChannelDB.FetchClosedChannelForID(cid)
×
4614
        if err != nil {
×
4615
                return fmt.Errorf("unable to fetch channel sync messages for "+
×
4616
                        "peer %v: %v", p, err)
×
4617
        }
×
4618

4619
        if c.LastChanSyncMsg == nil {
×
4620
                return fmt.Errorf("no chan sync message stored for channel %v",
×
4621
                        cid)
×
4622
        }
×
4623

4624
        if !c.RemotePub.IsEqual(p.IdentityKey()) {
×
4625
                return fmt.Errorf("ignoring channel reestablish from "+
×
4626
                        "peer=%x", p.IdentityKey().SerializeCompressed())
×
4627
        }
×
4628

4629
        p.log.Debugf("Re-sending channel sync message for channel %v to "+
×
4630
                "peer", cid)
×
4631

×
4632
        if err := p.SendMessage(true, c.LastChanSyncMsg); err != nil {
×
4633
                return fmt.Errorf("failed resending channel sync "+
×
4634
                        "message to peer %v: %v", p, err)
×
4635
        }
×
4636

4637
        p.log.Debugf("Re-sent channel sync message for channel %v to peer ",
×
4638
                cid)
×
4639

×
4640
        // Note down that we sent the message, so we won't resend it again for
×
4641
        // this connection.
×
4642
        p.resentChanSyncMsg[cid] = struct{}{}
×
4643

×
4644
        return nil
×
4645
}
4646

4647
// SendMessage sends a variadic number of high-priority messages to the remote
4648
// peer. The first argument denotes if the method should block until the
4649
// messages have been sent to the remote peer or an error is returned,
4650
// otherwise it returns immediately after queuing.
4651
//
4652
// NOTE: Part of the lnpeer.Peer interface.
4653
func (p *Brontide) SendMessage(sync bool, msgs ...lnwire.Message) error {
3✔
4654
        return p.sendMessage(sync, true, msgs...)
3✔
4655
}
3✔
4656

4657
// SendMessageLazy sends a variadic number of low-priority messages to the
4658
// remote peer. The first argument denotes if the method should block until
4659
// the messages have been sent to the remote peer or an error is returned,
4660
// otherwise it returns immediately after queueing.
4661
//
4662
// NOTE: Part of the lnpeer.Peer interface.
4663
func (p *Brontide) SendMessageLazy(sync bool, msgs ...lnwire.Message) error {
1✔
4664
        return p.sendMessage(sync, false, msgs...)
1✔
4665
}
1✔
4666

4667
// sendMessage queues a variadic number of messages using the passed priority
4668
// to the remote peer. If sync is true, this method will block until the
4669
// messages have been sent to the remote peer or an error is returned, otherwise
4670
// it returns immediately after queueing.
4671
func (p *Brontide) sendMessage(sync, priority bool, msgs ...lnwire.Message) error {
4✔
4672
        // Add all incoming messages to the outgoing queue. A list of error
4✔
4673
        // chans is populated for each message if the caller requested a sync
4✔
4674
        // send.
4✔
4675
        var errChans []chan error
4✔
4676
        if sync {
5✔
4677
                errChans = make([]chan error, 0, len(msgs))
1✔
4678
        }
1✔
4679
        for _, msg := range msgs {
8✔
4680
                // If a sync send was requested, create an error chan to listen
4✔
4681
                // for an ack from the writeHandler.
4✔
4682
                var errChan chan error
4✔
4683
                if sync {
5✔
4684
                        errChan = make(chan error, 1)
1✔
4685
                        errChans = append(errChans, errChan)
1✔
4686
                }
1✔
4687

4688
                if priority {
7✔
4689
                        p.queueMsg(msg, errChan)
3✔
4690
                } else {
4✔
4691
                        p.queueMsgLazy(msg, errChan)
1✔
4692
                }
1✔
4693
        }
4694

4695
        // Wait for all replies from the writeHandler. For async sends, this
4696
        // will be a NOP as the list of error chans is nil.
4697
        for _, errChan := range errChans {
5✔
4698
                select {
1✔
4699
                case err := <-errChan:
1✔
4700
                        return err
1✔
4701
                case <-p.cg.Done():
×
4702
                        return lnpeer.ErrPeerExiting
×
4703
                case <-p.cfg.Quit:
×
4704
                        return lnpeer.ErrPeerExiting
×
4705
                }
4706
        }
4707

4708
        return nil
3✔
4709
}
4710

4711
// PubKey returns the pubkey of the peer in compressed serialized format.
4712
//
4713
// NOTE: Part of the lnpeer.Peer interface.
4714
func (p *Brontide) PubKey() [33]byte {
2✔
4715
        return p.cfg.PubKeyBytes
2✔
4716
}
2✔
4717

4718
// IdentityKey returns the public key of the remote peer.
4719
//
4720
// NOTE: Part of the lnpeer.Peer interface.
4721
func (p *Brontide) IdentityKey() *btcec.PublicKey {
15✔
4722
        return p.cfg.Addr.IdentityKey
15✔
4723
}
15✔
4724

4725
// Address returns the network address of the remote peer.
4726
//
4727
// NOTE: Part of the lnpeer.Peer interface.
4728
func (p *Brontide) Address() net.Addr {
×
4729
        return p.cfg.Addr.Address
×
4730
}
×
4731

4732
// AddNewChannel adds a new channel to the peer. The channel should fail to be
4733
// added if the cancel channel is closed.
4734
//
4735
// NOTE: Part of the lnpeer.Peer interface.
4736
func (p *Brontide) AddNewChannel(newChan *lnpeer.NewChannel,
4737
        cancel <-chan struct{}) error {
×
4738

×
4739
        errChan := make(chan error, 1)
×
4740
        newChanMsg := &newChannelMsg{
×
4741
                channel: newChan,
×
4742
                err:     errChan,
×
4743
        }
×
4744

×
4745
        select {
×
4746
        case p.newActiveChannel <- newChanMsg:
×
4747
        case <-cancel:
×
4748
                return errors.New("canceled adding new channel")
×
4749
        case <-p.cg.Done():
×
4750
                return lnpeer.ErrPeerExiting
×
4751
        }
4752

4753
        // We pause here to wait for the peer to recognize the new channel
4754
        // before we close the channel barrier corresponding to the channel.
4755
        select {
×
4756
        case err := <-errChan:
×
4757
                return err
×
4758
        case <-p.cg.Done():
×
4759
                return lnpeer.ErrPeerExiting
×
4760
        }
4761
}
4762

4763
// AddPendingChannel adds a pending open channel to the peer. The channel
4764
// should fail to be added if the cancel channel is closed.
4765
//
4766
// NOTE: Part of the lnpeer.Peer interface.
4767
func (p *Brontide) AddPendingChannel(cid lnwire.ChannelID,
4768
        cancel <-chan struct{}) error {
×
4769

×
4770
        errChan := make(chan error, 1)
×
4771
        newChanMsg := &newChannelMsg{
×
4772
                channelID: cid,
×
4773
                err:       errChan,
×
4774
        }
×
4775

×
4776
        select {
×
4777
        case p.newPendingChannel <- newChanMsg:
×
4778

4779
        case <-cancel:
×
4780
                return errors.New("canceled adding pending channel")
×
4781

4782
        case <-p.cg.Done():
×
4783
                return lnpeer.ErrPeerExiting
×
4784
        }
4785

4786
        // We pause here to wait for the peer to recognize the new pending
4787
        // channel before we close the channel barrier corresponding to the
4788
        // channel.
4789
        select {
×
4790
        case err := <-errChan:
×
4791
                return err
×
4792

4793
        case <-cancel:
×
4794
                return errors.New("canceled adding pending channel")
×
4795

4796
        case <-p.cg.Done():
×
4797
                return lnpeer.ErrPeerExiting
×
4798
        }
4799
}
4800

4801
// RemovePendingChannel removes a pending open channel from the peer.
4802
//
4803
// NOTE: Part of the lnpeer.Peer interface.
4804
func (p *Brontide) RemovePendingChannel(cid lnwire.ChannelID) error {
×
4805
        errChan := make(chan error, 1)
×
4806
        newChanMsg := &newChannelMsg{
×
4807
                channelID: cid,
×
4808
                err:       errChan,
×
4809
        }
×
4810

×
4811
        select {
×
4812
        case p.removePendingChannel <- newChanMsg:
×
4813
        case <-p.cg.Done():
×
4814
                return lnpeer.ErrPeerExiting
×
4815
        }
4816

4817
        // We pause here to wait for the peer to respond to the cancellation of
4818
        // the pending channel before we close the channel barrier
4819
        // corresponding to the channel.
4820
        select {
×
4821
        case err := <-errChan:
×
4822
                return err
×
4823

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

4829
// StartTime returns the time at which the connection was established if the
4830
// peer started successfully, and zero otherwise.
4831
func (p *Brontide) StartTime() time.Time {
×
4832
        return p.startTime
×
4833
}
×
4834

4835
// handleCloseMsg is called when a new cooperative channel closure related
4836
// message is received from the remote peer. We'll use this message to advance
4837
// the chan closer state machine.
4838
func (p *Brontide) handleCloseMsg(msg *closeMsg) {
13✔
4839
        link := p.fetchLinkFromKeyAndCid(msg.cid)
13✔
4840

13✔
4841
        // We'll now fetch the matching closing state machine in order to
13✔
4842
        // continue, or finalize the channel closure process.
13✔
4843
        chanCloserE, err := p.fetchActiveChanCloser(msg.cid)
13✔
4844
        if err != nil {
13✔
4845
                // If the channel is not known to us, we'll simply ignore this
×
4846
                // message.
×
4847
                if err == ErrChannelNotFound {
×
4848
                        return
×
4849
                }
×
4850

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

×
4853
                errMsg := &lnwire.Error{
×
4854
                        ChanID: msg.cid,
×
4855
                        Data:   lnwire.ErrorData(err.Error()),
×
4856
                }
×
4857
                p.queueMsg(errMsg, nil)
×
4858
                return
×
4859
        }
4860

4861
        if chanCloserE.IsRight() {
13✔
4862
                // TODO(roasbeef): assert?
×
4863
                return
×
4864
        }
×
4865

4866
        // At this point, we'll only enter this call path if a negotiate chan
4867
        // closer was used. So we'll extract that from the either now.
4868
        //
4869
        // TODO(roabeef): need extra helper func for either to make cleaner
4870
        var chanCloser *chancloser.ChanCloser
13✔
4871
        chanCloserE.WhenLeft(func(c *chancloser.ChanCloser) {
26✔
4872
                chanCloser = c
13✔
4873
        })
13✔
4874

4875
        handleErr := func(err error) {
13✔
4876
                err = fmt.Errorf("unable to process close msg: %w", err)
×
4877
                p.log.Error(err)
×
4878

×
4879
                // As the negotiations failed, we'll reset the channel state
×
4880
                // machine to ensure we act to on-chain events as normal.
×
4881
                chanCloser.Channel().ResetState()
×
4882
                if chanCloser.CloseRequest() != nil {
×
4883
                        chanCloser.CloseRequest().Err <- err
×
4884
                }
×
4885

4886
                p.activeChanCloses.Delete(msg.cid)
×
4887

×
4888
                p.Disconnect(err)
×
4889
        }
4890

4891
        // Next, we'll process the next message using the target state machine.
4892
        // We'll either continue negotiation, or halt.
4893
        switch typed := msg.msg.(type) {
13✔
4894
        case *lnwire.Shutdown:
5✔
4895
                // Disable incoming adds immediately.
5✔
4896
                if link != nil && !link.DisableAdds(htlcswitch.Incoming) {
5✔
4897
                        p.log.Warnf("Incoming link adds already disabled: %v",
×
4898
                                link.ChanID())
×
4899
                }
×
4900

4901
                oShutdown, err := chanCloser.ReceiveShutdown(*typed)
5✔
4902
                if err != nil {
5✔
4903
                        handleErr(err)
×
4904
                        return
×
4905
                }
×
4906

4907
                oShutdown.WhenSome(func(msg lnwire.Shutdown) {
8✔
4908
                        // If the link is nil it means we can immediately queue
3✔
4909
                        // the Shutdown message since we don't have to wait for
3✔
4910
                        // commitment transaction synchronization.
3✔
4911
                        if link == nil {
4✔
4912
                                p.queueMsg(&msg, nil)
1✔
4913
                                return
1✔
4914
                        }
1✔
4915

4916
                        // Immediately disallow any new HTLC's from being added
4917
                        // in the outgoing direction.
4918
                        if !link.DisableAdds(htlcswitch.Outgoing) {
2✔
4919
                                p.log.Warnf("Outgoing link adds already "+
×
4920
                                        "disabled: %v", link.ChanID())
×
4921
                        }
×
4922

4923
                        // When we have a Shutdown to send, we defer it till the
4924
                        // next time we send a CommitSig to remain spec
4925
                        // compliant.
4926
                        link.OnCommitOnce(htlcswitch.Outgoing, func() {
4✔
4927
                                p.queueMsg(&msg, nil)
2✔
4928
                        })
2✔
4929
                })
4930

4931
                beginNegotiation := func() {
10✔
4932
                        oClosingSigned, err := chanCloser.BeginNegotiation()
5✔
4933
                        if err != nil {
5✔
4934
                                handleErr(err)
×
4935
                                return
×
4936
                        }
×
4937

4938
                        oClosingSigned.WhenSome(func(msg lnwire.ClosingSigned) {
10✔
4939
                                p.queueMsg(&msg, nil)
5✔
4940
                        })
5✔
4941
                }
4942

4943
                if link == nil {
6✔
4944
                        beginNegotiation()
1✔
4945
                } else {
5✔
4946
                        // Now we register a flush hook to advance the
4✔
4947
                        // ChanCloser and possibly send out a ClosingSigned
4✔
4948
                        // when the link finishes draining.
4✔
4949
                        link.OnFlushedOnce(func() {
8✔
4950
                                // Remove link in goroutine to prevent deadlock.
4✔
4951
                                go p.cfg.Switch.RemoveLink(msg.cid)
4✔
4952
                                beginNegotiation()
4✔
4953
                        })
4✔
4954
                }
4955

4956
        case *lnwire.ClosingSigned:
8✔
4957
                oClosingSigned, err := chanCloser.ReceiveClosingSigned(*typed)
8✔
4958
                if err != nil {
8✔
4959
                        handleErr(err)
×
4960
                        return
×
4961
                }
×
4962

4963
                oClosingSigned.WhenSome(func(msg lnwire.ClosingSigned) {
16✔
4964
                        p.queueMsg(&msg, nil)
8✔
4965
                })
8✔
4966

4967
        default:
×
4968
                panic("impossible closeMsg type")
×
4969
        }
4970

4971
        // If we haven't finished close negotiations, then we'll continue as we
4972
        // can't yet finalize the closure.
4973
        if _, err := chanCloser.ClosingTx(); err != nil {
20✔
4974
                return
8✔
4975
        }
8✔
4976

4977
        // Otherwise, we've agreed on a closing fee! In this case, we'll wrap up
4978
        // the channel closure by notifying relevant sub-systems and launching a
4979
        // goroutine to wait for close tx conf.
4980
        p.finalizeChanClosure(chanCloser)
4✔
4981
}
4982

4983
// HandleLocalCloseChanReqs accepts a *htlcswitch.ChanClose and passes it onto
4984
// the channelManager goroutine, which will shut down the link and possibly
4985
// close the channel.
4986
func (p *Brontide) HandleLocalCloseChanReqs(req *htlcswitch.ChanClose) {
×
4987
        select {
×
4988
        case p.localCloseChanReqs <- req:
×
4989
                p.log.Info("Local close channel request is going to be " +
×
4990
                        "delivered to the peer")
×
4991
        case <-p.cg.Done():
×
4992
                p.log.Info("Unable to deliver local close channel request " +
×
4993
                        "to peer")
×
4994
        }
4995
}
4996

4997
// NetAddress returns the network of the remote peer as an lnwire.NetAddress.
4998
func (p *Brontide) NetAddress() *lnwire.NetAddress {
×
4999
        return p.cfg.Addr
×
5000
}
×
5001

5002
// Inbound is a getter for the Brontide's Inbound boolean in cfg.
5003
func (p *Brontide) Inbound() bool {
×
5004
        return p.cfg.Inbound
×
5005
}
×
5006

5007
// ConnReq is a getter for the Brontide's connReq in cfg.
5008
func (p *Brontide) ConnReq() *connmgr.ConnReq {
×
5009
        return p.cfg.ConnReq
×
5010
}
×
5011

5012
// ErrorBuffer is a getter for the Brontide's errorBuffer in cfg.
5013
func (p *Brontide) ErrorBuffer() *queue.CircularBuffer {
×
5014
        return p.cfg.ErrorBuffer
×
5015
}
×
5016

5017
// SetAddress sets the remote peer's address given an address.
5018
func (p *Brontide) SetAddress(address net.Addr) {
×
5019
        p.cfg.Addr.Address = address
×
5020
}
×
5021

5022
// ActiveSignal returns the peer's active signal.
5023
func (p *Brontide) ActiveSignal() chan struct{} {
×
5024
        return p.activeSignal
×
5025
}
×
5026

5027
// Conn returns a pointer to the peer's connection struct.
5028
func (p *Brontide) Conn() net.Conn {
×
5029
        return p.cfg.Conn
×
5030
}
×
5031

5032
// BytesReceived returns the number of bytes received from the peer.
5033
func (p *Brontide) BytesReceived() uint64 {
×
5034
        return atomic.LoadUint64(&p.bytesReceived)
×
5035
}
×
5036

5037
// BytesSent returns the number of bytes sent to the peer.
5038
func (p *Brontide) BytesSent() uint64 {
×
5039
        return atomic.LoadUint64(&p.bytesSent)
×
5040
}
×
5041

5042
// LastRemotePingPayload returns the last payload the remote party sent as part
5043
// of their ping.
5044
func (p *Brontide) LastRemotePingPayload() []byte {
×
5045
        pingPayload := p.lastPingPayload.Load()
×
5046
        if pingPayload == nil {
×
5047
                return []byte{}
×
5048
        }
×
5049

5050
        pingBytes, ok := pingPayload.(lnwire.PingPayload)
×
5051
        if !ok {
×
5052
                return nil
×
5053
        }
×
5054

5055
        return pingBytes
×
5056
}
5057

5058
// attachChannelEventSubscription creates a channel event subscription and
5059
// attaches to client to Brontide if the reenableTimeout is no greater than 1
5060
// minute.
5061
func (p *Brontide) attachChannelEventSubscription() error {
3✔
5062
        // If the timeout is greater than 1 minute, it's unlikely that the link
3✔
5063
        // hasn't yet finished its reestablishment. Return a nil without
3✔
5064
        // creating the client to specify that we don't want to retry.
3✔
5065
        if p.cfg.ChanActiveTimeout > 1*time.Minute {
3✔
5066
                return nil
×
5067
        }
×
5068

5069
        // When the reenable timeout is less than 1 minute, it's likely the
5070
        // channel link hasn't finished its reestablishment yet. In that case,
5071
        // we'll give it a second chance by subscribing to the channel update
5072
        // events. Upon receiving the `ActiveLinkEvent`, we'll then request
5073
        // enabling the channel again.
5074
        sub, err := p.cfg.ChannelNotifier.SubscribeChannelEvents()
3✔
5075
        if err != nil {
3✔
5076
                return fmt.Errorf("SubscribeChannelEvents failed: %w", err)
×
5077
        }
×
5078

5079
        p.channelEventClient = sub
3✔
5080

3✔
5081
        return nil
3✔
5082
}
5083

5084
// updateNextRevocation updates the existing channel's next revocation if it's
5085
// nil.
5086
func (p *Brontide) updateNextRevocation(c *channeldb.OpenChannel) error {
3✔
5087
        chanPoint := c.FundingOutpoint
3✔
5088
        chanID := lnwire.NewChanIDFromOutPoint(chanPoint)
3✔
5089

3✔
5090
        // Read the current channel.
3✔
5091
        currentChan, loaded := p.activeChannels.Load(chanID)
3✔
5092

3✔
5093
        // currentChan should exist, but we perform a check anyway to avoid nil
3✔
5094
        // pointer dereference.
3✔
5095
        if !loaded {
4✔
5096
                return fmt.Errorf("missing active channel with chanID=%v",
1✔
5097
                        chanID)
1✔
5098
        }
1✔
5099

5100
        // currentChan should not be nil, but we perform a check anyway to
5101
        // avoid nil pointer dereference.
5102
        if currentChan == nil {
3✔
5103
                return fmt.Errorf("found nil active channel with chanID=%v",
1✔
5104
                        chanID)
1✔
5105
        }
1✔
5106

5107
        // If we're being sent a new channel, and our existing channel doesn't
5108
        // have the next revocation, then we need to update the current
5109
        // existing channel.
5110
        if currentChan.RemoteNextRevocation() != nil {
1✔
5111
                return nil
×
5112
        }
×
5113

5114
        p.log.Infof("Processing retransmitted ChannelReady for "+
1✔
5115
                "ChannelPoint(%v)", chanPoint)
1✔
5116

1✔
5117
        nextRevoke := c.RemoteNextRevocation
1✔
5118

1✔
5119
        err := currentChan.InitNextRevocation(nextRevoke)
1✔
5120
        if err != nil {
1✔
5121
                return fmt.Errorf("unable to init next revocation: %w", err)
×
5122
        }
×
5123

5124
        return nil
1✔
5125
}
5126

5127
// addActiveChannel adds a new active channel to the `activeChannels` map. It
5128
// takes a `channeldb.OpenChannel`, creates a `lnwallet.LightningChannel` from
5129
// it and assembles it with a channel link.
5130
func (p *Brontide) addActiveChannel(c *lnpeer.NewChannel) error {
×
5131
        chanPoint := c.FundingOutpoint
×
5132
        chanID := lnwire.NewChanIDFromOutPoint(chanPoint)
×
5133

×
5134
        // If we've reached this point, there are two possible scenarios.  If
×
5135
        // the channel was in the active channels map as nil, then it was
×
5136
        // loaded from disk and we need to send reestablish. Else, it was not
×
5137
        // loaded from disk and we don't need to send reestablish as this is a
×
5138
        // fresh channel.
×
5139
        shouldReestablish := p.isLoadedFromDisk(chanID)
×
5140

×
5141
        chanOpts := c.ChanOpts
×
5142
        if shouldReestablish {
×
5143
                // If we have to do the reestablish dance for this channel,
×
5144
                // ensure that we don't try to call InitRemoteMusigNonces twice
×
5145
                // by calling SkipNonceInit.
×
5146
                chanOpts = append(chanOpts, lnwallet.WithSkipNonceInit())
×
5147
        }
×
5148

5149
        p.cfg.AuxLeafStore.WhenSome(func(s lnwallet.AuxLeafStore) {
×
5150
                chanOpts = append(chanOpts, lnwallet.WithLeafStore(s))
×
5151
        })
×
5152
        p.cfg.AuxSigner.WhenSome(func(s lnwallet.AuxSigner) {
×
5153
                chanOpts = append(chanOpts, lnwallet.WithAuxSigner(s))
×
5154
        })
×
5155
        p.cfg.AuxResolver.WhenSome(func(s lnwallet.AuxContractResolver) {
×
5156
                chanOpts = append(chanOpts, lnwallet.WithAuxResolver(s))
×
5157
        })
×
5158

5159
        // If not already active, we'll add this channel to the set of active
5160
        // channels, so we can look it up later easily according to its channel
5161
        // ID.
5162
        lnChan, err := lnwallet.NewLightningChannel(
×
5163
                p.cfg.Signer, c.OpenChannel, p.cfg.SigPool, chanOpts...,
×
5164
        )
×
5165
        if err != nil {
×
5166
                return fmt.Errorf("unable to create LightningChannel: %w", err)
×
5167
        }
×
5168

5169
        // Store the channel in the activeChannels map.
5170
        p.activeChannels.Store(chanID, lnChan)
×
5171

×
5172
        p.log.Infof("New channel active ChannelPoint(%v) with peer", chanPoint)
×
5173

×
5174
        // Next, we'll assemble a ChannelLink along with the necessary items it
×
5175
        // needs to function.
×
5176
        chainEvents, err := p.cfg.ChainArb.SubscribeChannelEvents(chanPoint)
×
5177
        if err != nil {
×
5178
                return fmt.Errorf("unable to subscribe to chain events: %w",
×
5179
                        err)
×
5180
        }
×
5181

5182
        // We'll query the channel DB for the new channel's initial forwarding
5183
        // policies to determine the policy we start out with.
5184
        initialPolicy, err := p.cfg.ChannelDB.GetInitialForwardingPolicy(chanID)
×
5185
        if err != nil {
×
5186
                return fmt.Errorf("unable to query for initial forwarding "+
×
5187
                        "policy: %v", err)
×
5188
        }
×
5189

5190
        // Create the link and add it to the switch.
5191
        err = p.addLink(
×
5192
                &chanPoint, lnChan, initialPolicy, chainEvents,
×
5193
                shouldReestablish, fn.None[lnwire.Shutdown](),
×
5194
        )
×
5195
        if err != nil {
×
5196
                return fmt.Errorf("can't register new channel link(%v) with "+
×
5197
                        "peer", chanPoint)
×
5198
        }
×
5199

5200
        isTaprootChan := c.ChanType.IsTaproot()
×
5201

×
5202
        // We're using the old co-op close, so we don't need to init the new RBF
×
5203
        // chan closer. If this is a taproot channel, then we'll also fall
×
5204
        // through, as we don't support this type yet w/ rbf close.
×
5205
        if !p.rbfCoopCloseAllowed() || isTaprootChan {
×
5206
                return nil
×
5207
        }
×
5208

5209
        // Now that the link has been added above, we'll also init an RBF chan
5210
        // closer for this channel, but only if the new close feature is
5211
        // negotiated.
5212
        //
5213
        // Creating this here ensures that any shutdown messages sent will be
5214
        // automatically routed by the msg router.
5215
        if _, err := p.initRbfChanCloser(lnChan); err != nil {
×
5216
                p.activeChanCloses.Delete(chanID)
×
5217

×
5218
                return fmt.Errorf("unable to init RBF chan closer for new "+
×
5219
                        "chan: %w", err)
×
5220
        }
×
5221

5222
        return nil
×
5223
}
5224

5225
// handleNewActiveChannel handles a `newChannelMsg` request. Depending on we
5226
// know this channel ID or not, we'll either add it to the `activeChannels` map
5227
// or init the next revocation for it.
5228
func (p *Brontide) handleNewActiveChannel(req *newChannelMsg) {
×
5229
        newChan := req.channel
×
5230
        chanPoint := newChan.FundingOutpoint
×
5231
        chanID := lnwire.NewChanIDFromOutPoint(chanPoint)
×
5232

×
5233
        // Only update RemoteNextRevocation if the channel is in the
×
5234
        // activeChannels map and if we added the link to the switch. Only
×
5235
        // active channels will be added to the switch.
×
5236
        if p.isActiveChannel(chanID) {
×
5237
                p.log.Infof("Already have ChannelPoint(%v), ignoring",
×
5238
                        chanPoint)
×
5239

×
5240
                // Handle it and close the err chan on the request.
×
5241
                close(req.err)
×
5242

×
5243
                // Update the next revocation point.
×
5244
                err := p.updateNextRevocation(newChan.OpenChannel)
×
5245
                if err != nil {
×
5246
                        p.log.Errorf(err.Error())
×
5247
                }
×
5248

5249
                return
×
5250
        }
5251

5252
        // This is a new channel, we now add it to the map.
5253
        if err := p.addActiveChannel(req.channel); err != nil {
×
5254
                // Log and send back the error to the request.
×
5255
                p.log.Errorf(err.Error())
×
5256
                req.err <- err
×
5257

×
5258
                return
×
5259
        }
×
5260

5261
        // Close the err chan if everything went fine.
5262
        close(req.err)
×
5263
}
5264

5265
// handleNewPendingChannel takes a `newChannelMsg` request and add it to
5266
// `activeChannels` map with nil value. This pending channel will be saved as
5267
// it may become active in the future. Once active, the funding manager will
5268
// send it again via `AddNewChannel`, and we'd handle the link creation there.
5269
func (p *Brontide) handleNewPendingChannel(req *newChannelMsg) {
4✔
5270
        defer close(req.err)
4✔
5271

4✔
5272
        chanID := req.channelID
4✔
5273

4✔
5274
        // If we already have this channel, something is wrong with the funding
4✔
5275
        // flow as it will only be marked as active after `ChannelReady` is
4✔
5276
        // handled. In this case, we will do nothing but log an error, just in
4✔
5277
        // case this is a legit channel.
4✔
5278
        if p.isActiveChannel(chanID) {
5✔
5279
                p.log.Errorf("Channel(%v) is already active, ignoring "+
1✔
5280
                        "pending channel request", chanID)
1✔
5281

1✔
5282
                return
1✔
5283
        }
1✔
5284

5285
        // The channel has already been added, we will do nothing and return.
5286
        if p.isPendingChannel(chanID) {
4✔
5287
                p.log.Infof("Channel(%v) is already added, ignoring "+
1✔
5288
                        "pending channel request", chanID)
1✔
5289

1✔
5290
                return
1✔
5291
        }
1✔
5292

5293
        // This is a new channel, we now add it to the map `activeChannels`
5294
        // with nil value and mark it as a newly added channel in
5295
        // `addedChannels`.
5296
        p.activeChannels.Store(chanID, nil)
2✔
5297
        p.addedChannels.Store(chanID, struct{}{})
2✔
5298
}
5299

5300
// handleRemovePendingChannel takes a `newChannelMsg` request and removes it
5301
// from `activeChannels` map. The request will be ignored if the channel is
5302
// considered active by Brontide. Noop if the channel ID cannot be found.
5303
func (p *Brontide) handleRemovePendingChannel(req *newChannelMsg) {
4✔
5304
        defer close(req.err)
4✔
5305

4✔
5306
        chanID := req.channelID
4✔
5307

4✔
5308
        // If we already have this channel, something is wrong with the funding
4✔
5309
        // flow as it will only be marked as active after `ChannelReady` is
4✔
5310
        // handled. In this case, we will log an error and exit.
4✔
5311
        if p.isActiveChannel(chanID) {
5✔
5312
                p.log.Errorf("Channel(%v) is active, ignoring remove request",
1✔
5313
                        chanID)
1✔
5314
                return
1✔
5315
        }
1✔
5316

5317
        // The channel has not been added yet, we will log a warning as there
5318
        // is an unexpected call from funding manager.
5319
        if !p.isPendingChannel(chanID) {
4✔
5320
                p.log.Warnf("Channel(%v) not found, removing it anyway", chanID)
1✔
5321
        }
1✔
5322

5323
        // Remove the record of this pending channel.
5324
        p.activeChannels.Delete(chanID)
3✔
5325
        p.addedChannels.Delete(chanID)
3✔
5326
}
5327

5328
// sendLinkUpdateMsg sends a message that updates the channel to the
5329
// channel's message stream.
5330
func (p *Brontide) sendLinkUpdateMsg(cid lnwire.ChannelID, msg lnwire.Message) {
×
5331
        p.log.Tracef("Sending link update msg=%v", msg.MsgType())
×
5332

×
5333
        chanStream, ok := p.activeMsgStreams[cid]
×
5334
        if !ok {
×
5335
                // If a stream hasn't yet been created, then we'll do so, add
×
5336
                // it to the map, and finally start it.
×
5337
                chanStream = newChanMsgStream(p, cid)
×
5338
                p.activeMsgStreams[cid] = chanStream
×
5339
                chanStream.Start()
×
5340

×
5341
                // Stop the stream when quit.
×
5342
                go func() {
×
5343
                        <-p.cg.Done()
×
5344
                        chanStream.Stop()
×
5345
                }()
×
5346
        }
5347

5348
        // With the stream obtained, add the message to the stream so we can
5349
        // continue processing message.
5350
        chanStream.AddMsg(msg)
×
5351
}
5352

5353
// scaleTimeout multiplies the argument duration by a constant factor depending
5354
// on variious heuristics. Currently this is only used to check whether our peer
5355
// appears to be connected over Tor and relaxes the timout deadline. However,
5356
// this is subject to change and should be treated as opaque.
5357
func (p *Brontide) scaleTimeout(timeout time.Duration) time.Duration {
67✔
5358
        if p.isTorConnection {
67✔
5359
                return timeout * time.Duration(torTimeoutMultiplier)
×
5360
        }
×
5361

5362
        return timeout
67✔
5363
}
5364

5365
// CoopCloseUpdates is a struct used to communicate updates for an active close
5366
// to the caller.
5367
type CoopCloseUpdates struct {
5368
        UpdateChan chan interface{}
5369

5370
        ErrChan chan error
5371
}
5372

5373
// ChanHasRbfCoopCloser returns true if the channel as identifier by the channel
5374
// point has an active RBF chan closer.
5375
func (p *Brontide) ChanHasRbfCoopCloser(chanPoint wire.OutPoint) bool {
×
5376
        chanID := lnwire.NewChanIDFromOutPoint(chanPoint)
×
5377
        chanCloser, found := p.activeChanCloses.Load(chanID)
×
5378
        if !found {
×
5379
                return false
×
5380
        }
×
5381

5382
        return chanCloser.IsRight()
×
5383
}
5384

5385
// TriggerCoopCloseRbfBump given a chan ID, and the params needed to trigger a
5386
// new RBF co-op close update, a bump is attempted. A channel used for updates,
5387
// along with one used to o=communicate any errors is returned. If no chan
5388
// closer is found, then false is returned for the second argument.
5389
func (p *Brontide) TriggerCoopCloseRbfBump(ctx context.Context,
5390
        chanPoint wire.OutPoint, feeRate chainfee.SatPerKWeight,
5391
        deliveryScript lnwire.DeliveryAddress) (*CoopCloseUpdates, error) {
×
5392

×
5393
        // If RBF coop close isn't permitted, then we'll an error.
×
5394
        if !p.rbfCoopCloseAllowed() {
×
5395
                return nil, fmt.Errorf("rbf coop close not enabled for " +
×
5396
                        "channel")
×
5397
        }
×
5398

5399
        closeUpdates := &CoopCloseUpdates{
×
5400
                UpdateChan: make(chan interface{}, 1),
×
5401
                ErrChan:    make(chan error, 1),
×
5402
        }
×
5403

×
5404
        // We'll re-use the existing switch struct here, even though we're
×
5405
        // bypassing the switch entirely.
×
5406
        closeReq := htlcswitch.ChanClose{
×
5407
                CloseType:      contractcourt.CloseRegular,
×
5408
                ChanPoint:      &chanPoint,
×
5409
                TargetFeePerKw: feeRate,
×
5410
                DeliveryScript: deliveryScript,
×
5411
                Updates:        closeUpdates.UpdateChan,
×
5412
                Err:            closeUpdates.ErrChan,
×
5413
                Ctx:            ctx,
×
5414
        }
×
5415

×
5416
        err := p.startRbfChanCloser(newRPCShutdownInit(&closeReq), chanPoint)
×
5417
        if err != nil {
×
5418
                return nil, err
×
5419
        }
×
5420

5421
        return closeUpdates, nil
×
5422
}
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