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

lightningnetwork / lnd / 15380904630

02 Jun 2025 12:07AM UTC coverage: 58.379% (+0.05%) from 58.327%
15380904630

Pull #9883

github

web-flow
Merge 4109ecb05 into bff2f2440
Pull Request #9883: protofsm: add thread-safe IsRunning method to StateMachine

1 of 6 new or added lines in 1 file covered. (16.67%)

19 existing lines in 6 files now uncovered.

97496 of 167006 relevant lines covered (58.38%)

1.81 hits per line

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

76.96
/peer/brontide.go
1
package peer
2

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

126
        err chan error
127
}
128

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

441
        // MaxFeeExposure limits the number of outstanding fees in a channel.
442
        // This value will be passed to created links.
443
        MaxFeeExposure lnwire.MilliSatoshi
444

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

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

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

458
        // NoDisconnectOnPongFailure indicates whether the peer should *not* be
459
        // disconnected if a pong is not received in time or is mismatched.
460
        NoDisconnectOnPongFailure bool
461

462
        // Quit is the server's quit channel. If this is closed, we halt operation.
463
        Quit chan struct{}
464
}
465

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

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

480
// makeRbfCloser creates a new RBF closer from a chancloser.RbfChanCloser.
481
func makeRbfCloser(rbfCloser *chancloser.RbfChanCloser) chanCloserFsm {
3✔
482
        return fn.NewRight[*chancloser.ChanCloser](
3✔
483
                rbfCloser,
3✔
484
        )
3✔
485
}
3✔
486

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

497
        // MUST be used atomically.
498
        bytesReceived uint64
499
        bytesSent     uint64
500

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

518
        pingManager *PingManager
519

520
        // lastPingPayload stores an unsafe pointer wrapped as an atomic
521
        // variable which points to the last payload the remote party sent us
522
        // as their ping.
523
        //
524
        // MUST be used atomically.
525
        lastPingPayload atomic.Value
526

527
        cfg Config
528

529
        // activeSignal when closed signals that the peer is now active and
530
        // ready to process messages.
531
        activeSignal chan struct{}
532

533
        // startTime is the time this peer connection was successfully established.
534
        // It will be zero for peers that did not successfully call Start().
535
        startTime time.Time
536

537
        // sendQueue is the channel which is used to queue outgoing messages to be
538
        // written onto the wire. Note that this channel is unbuffered.
539
        sendQueue chan outgoingMsg
540

541
        // outgoingQueue is a buffered channel which allows second/third party
542
        // objects to queue messages to be sent out on the wire.
543
        outgoingQueue chan outgoingMsg
544

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

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

564
        // newActiveChannel is used by the fundingManager to send fully opened
565
        // channels to the source peer which handled the funding workflow.
566
        newActiveChannel chan *newChannelMsg
567

568
        // newPendingChannel is used by the fundingManager to send pending open
569
        // channels to the source peer which handled the funding workflow.
570
        newPendingChannel chan *newChannelMsg
571

572
        // removePendingChannel is used by the fundingManager to cancel pending
573
        // open channels to the source peer when the funding flow is failed.
574
        removePendingChannel chan *newChannelMsg
575

576
        // activeMsgStreams is a map from channel id to the channel streams that
577
        // proxy messages to individual, active links.
578
        activeMsgStreams map[lnwire.ChannelID]*msgStream
579

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

586
        // localCloseChanReqs is a channel in which any local requests to close
587
        // a particular channel are sent over.
588
        localCloseChanReqs chan *htlcswitch.ChanClose
589

590
        // linkFailures receives all reported channel failures from the switch,
591
        // and instructs the channelManager to clean remaining channel state.
592
        linkFailures chan linkFailureReport
593

594
        // chanCloseMsgs is a channel that any message related to channel
595
        // closures are sent over. This includes lnwire.Shutdown message as
596
        // well as lnwire.ClosingSigned messages.
597
        chanCloseMsgs chan *closeMsg
598

599
        // remoteFeatures is the feature vector received from the peer during
600
        // the connection handshake.
601
        remoteFeatures *lnwire.FeatureVector
602

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

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

618
        // msgRouter is an instance of the msgmux.Router which is used to send
619
        // off new wire messages for handing.
620
        msgRouter fn.Option[msgmux.Router]
621

622
        // globalMsgRouter is a flag that indicates whether we have a global
623
        // msg router. If so, then we don't worry about stopping the msg router
624
        // when a peer disconnects.
625
        globalMsgRouter bool
626

627
        startReady chan struct{}
628

629
        // cg is a helper that encapsulates a wait group and quit channel and
630
        // allows contexts that either block or cancel on those depending on
631
        // the use case.
632
        cg *fn.ContextGuard
633

634
        // log is a peer-specific logging instance.
635
        log btclog.Logger
636
}
637

638
// A compile-time check to ensure that Brontide satisfies the lnpeer.Peer
639
// interface.
640
var _ lnpeer.Peer = (*Brontide)(nil)
641

642
// NewBrontide creates a new Brontide from a peer.Config struct.
643
func NewBrontide(cfg Config) *Brontide {
3✔
644
        logPrefix := fmt.Sprintf("Peer(%x):", cfg.PubKeyBytes)
3✔
645

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

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

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

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

3✔
685
        if cfg.Conn != nil && cfg.Conn.RemoteAddr() != nil {
6✔
686
                remoteAddr := cfg.Conn.RemoteAddr().String()
3✔
687
                p.isTorConnection = strings.Contains(remoteAddr, ".onion") ||
3✔
688
                        strings.Contains(remoteAddr, "127.0.0.1")
3✔
689
        }
3✔
690

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

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

718
                return lastSerializedBlockHeader[:]
×
719
        }
720

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

734
        p.pingManager = NewPingManager(&PingManagerConfig{
3✔
735
                NewPingPayload:   newPingPayload,
3✔
736
                NewPongSize:      randPongSize,
3✔
737
                IntervalDuration: p.scaleTimeout(pingInterval),
3✔
738
                TimeoutDuration:  p.scaleTimeout(pingTimeout),
3✔
739
                SendPing: func(ping *lnwire.Ping) {
3✔
740
                        p.queueMsg(ping, nil)
×
741
                },
×
742
                OnPongFailure: func(reason error,
743
                        timeWaitedForPong time.Duration,
744
                        lastKnownRTT time.Duration) {
×
745

×
746
                        logMsg := fmt.Sprintf("pong response "+
×
747
                                "failure for %s: %v. Time waited for this "+
×
748
                                "pong: %v. Last successful RTT: %v.",
×
749
                                p, reason, timeWaitedForPong, lastKnownRTT)
×
750

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

760
                        p.log.Warnf("%s -- disconnecting", logMsg)
×
761

×
762
                        go p.Disconnect(fmt.Errorf("pong failure: %w", reason))
×
763
                },
764
        })
765

766
        return p
3✔
767
}
768

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

776
        // Once we've finished starting up the peer, we'll signal to other
777
        // goroutines that the they can move forward to tear down the peer, or
778
        // carry out other relevant changes.
779
        defer close(p.startReady)
3✔
780

3✔
781
        p.log.Tracef("starting with conn[%v->%v]",
3✔
782
                p.cfg.Conn.LocalAddr(), p.cfg.Conn.RemoteAddr())
3✔
783

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

795
        if len(activeChans) == 0 {
6✔
796
                go p.cfg.PrunePersistentPeerConnection(p.cfg.PubKeyBytes)
3✔
797
        }
3✔
798

799
        // Quickly check if we have any existing legacy channels with this
800
        // peer.
801
        haveLegacyChan := false
3✔
802
        for _, c := range activeChans {
6✔
803
                if c.ChanType.IsTweakless() {
6✔
804
                        continue
3✔
805
                }
806

807
                haveLegacyChan = true
3✔
808
                break
3✔
809
        }
810

811
        // Exchange local and global features, the init message should be very
812
        // first between two nodes.
813
        if err := p.sendInitMsg(haveLegacyChan); err != nil {
5✔
814
                return fmt.Errorf("unable to send init msg: %w", err)
2✔
815
        }
2✔
816

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

3✔
826
                msg, err := p.readNextMessage()
3✔
827
                if err != nil {
4✔
828
                        readErr <- err
1✔
829
                        msgChan <- nil
1✔
830
                        return
1✔
831
                }
1✔
832
                readErr <- nil
3✔
833
                msgChan <- msg
3✔
834
        }()
835

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

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

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

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

878
        // Register the message router now as we may need to register some
879
        // endpoints while loading the channels below.
880
        p.msgRouter.WhenSome(func(router msgmux.Router) {
6✔
881
                router.Start(context.Background())
3✔
882
        })
3✔
883

884
        msgs, err := p.loadActiveChannels(activeChans)
3✔
885
        if err != nil {
3✔
886
                return fmt.Errorf("unable to load channels: %w", err)
×
887
        }
×
888

889
        p.startTime = time.Now()
3✔
890

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

3✔
898
                // Send the messages directly via writeMessage and bypass the
3✔
899
                // writeHandler goroutine.
3✔
900
                for _, msg := range msgs {
6✔
901
                        if err := p.writeMessage(msg); err != nil {
3✔
902
                                return fmt.Errorf("unable to send "+
×
903
                                        "reestablish msg: %v", err)
×
904
                        }
×
905
                }
906
        }
907

908
        err = p.pingManager.Start()
3✔
909
        if err != nil {
3✔
910
                return fmt.Errorf("could not start ping manager %w", err)
×
911
        }
×
912

913
        p.cg.WgAdd(4)
3✔
914
        go p.queueHandler()
3✔
915
        go p.writeHandler()
3✔
916
        go p.channelManager()
3✔
917
        go p.readHandler()
3✔
918

3✔
919
        // Signal to any external processes that the peer is now active.
3✔
920
        close(p.activeSignal)
3✔
921

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

3✔
937
        return nil
3✔
938
}
939

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

3✔
948
                if p.cfg.AuthGossiper == nil {
3✔
949
                        // This should only ever be hit in the unit tests.
×
950
                        p.log.Warn("No AuthGossiper configured. Abandoning " +
×
951
                                "gossip sync.")
×
952
                        return
×
953
                }
×
954

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

968
// taprootShutdownAllowed returns true if both parties have negotiated the
969
// shutdown-any-segwit feature.
970
func (p *Brontide) taprootShutdownAllowed() bool {
3✔
971
        return p.RemoteFeatures().HasFeature(lnwire.ShutdownAnySegwitOptional) &&
3✔
972
                p.LocalFeatures().HasFeature(lnwire.ShutdownAnySegwitOptional)
3✔
973
}
3✔
974

975
// rbfCoopCloseAllowed returns true if both parties have negotiated the new RBF
976
// coop close feature.
977
func (p *Brontide) rbfCoopCloseAllowed() bool {
3✔
978
        return p.RemoteFeatures().HasFeature(
3✔
979
                lnwire.RbfCoopCloseOptionalStaging,
3✔
980
        ) && p.LocalFeatures().HasFeature(
3✔
981
                lnwire.RbfCoopCloseOptionalStaging,
3✔
982
        )
3✔
983
}
3✔
984

985
// QuitSignal is a method that should return a channel which will be sent upon
986
// or closed once the backing peer exits. This allows callers using the
987
// interface to cancel any processing in the event the backing implementation
988
// exits.
989
//
990
// NOTE: Part of the lnpeer.Peer interface.
991
func (p *Brontide) QuitSignal() <-chan struct{} {
3✔
992
        return p.cg.Done()
3✔
993
}
3✔
994

995
// addrWithInternalKey takes a delivery script, then attempts to supplement it
996
// with information related to the internal key for the addr, but only if it's
997
// a taproot addr.
998
func (p *Brontide) addrWithInternalKey(
999
        deliveryScript []byte) (*chancloser.DeliveryAddrWithKey, error) {
3✔
1000

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

1012
        return &chancloser.DeliveryAddrWithKey{
3✔
1013
                DeliveryAddress: deliveryScript,
3✔
1014
                InternalKey: fn.MapOption(
3✔
1015
                        func(desc keychain.KeyDescriptor) btcec.PublicKey {
6✔
1016
                                return *desc.PubKey
3✔
1017
                        },
3✔
1018
                )(internalKeyDesc),
1019
        }, nil
1020
}
1021

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

3✔
1029
        // Return a slice of messages to send to the peers in case the channel
3✔
1030
        // cannot be loaded normally.
3✔
1031
        var msgs []lnwire.Message
3✔
1032

3✔
1033
        scidAliasNegotiated := p.hasNegotiatedScidAlias()
3✔
1034

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

1055
                                err = p.cfg.AddLocalAlias(
3✔
1056
                                        aliasScid, dbChan.ShortChanID(), false,
3✔
1057
                                        false,
3✔
1058
                                )
3✔
1059
                                if err != nil {
3✔
1060
                                        return nil, err
×
1061
                                }
×
1062

1063
                                chanID := lnwire.NewChanIDFromOutPoint(
3✔
1064
                                        dbChan.FundingOutpoint,
3✔
1065
                                )
3✔
1066

3✔
1067
                                // Fetch the second commitment point to send in
3✔
1068
                                // the channel_ready message.
3✔
1069
                                second, err := dbChan.SecondCommitmentPoint()
3✔
1070
                                if err != nil {
3✔
1071
                                        return nil, err
×
1072
                                }
×
1073

1074
                                channelReadyMsg := lnwire.NewChannelReady(
3✔
1075
                                        chanID, second,
3✔
1076
                                )
3✔
1077
                                channelReadyMsg.AliasScid = &aliasScid
3✔
1078

3✔
1079
                                msgs = append(msgs, channelReadyMsg)
3✔
1080
                        }
1081

1082
                        // If we've negotiated the option-scid-alias feature
1083
                        // and this channel does not have ScidAliasFeature set
1084
                        // to true due to an upgrade where the feature bit was
1085
                        // turned on, we'll update the channel's database
1086
                        // state.
1087
                        err := dbChan.MarkScidAliasNegotiated()
3✔
1088
                        if err != nil {
3✔
1089
                                return nil, err
×
1090
                        }
×
1091
                }
1092

1093
                var chanOpts []lnwallet.ChannelOpt
3✔
1094
                p.cfg.AuxLeafStore.WhenSome(func(s lnwallet.AuxLeafStore) {
3✔
1095
                        chanOpts = append(chanOpts, lnwallet.WithLeafStore(s))
×
1096
                })
×
1097
                p.cfg.AuxSigner.WhenSome(func(s lnwallet.AuxSigner) {
3✔
1098
                        chanOpts = append(chanOpts, lnwallet.WithAuxSigner(s))
×
1099
                })
×
1100
                p.cfg.AuxResolver.WhenSome(
3✔
1101
                        func(s lnwallet.AuxContractResolver) {
3✔
1102
                                chanOpts = append(
×
1103
                                        chanOpts, lnwallet.WithAuxResolver(s),
×
1104
                                )
×
1105
                        },
×
1106
                )
1107

1108
                lnChan, err := lnwallet.NewLightningChannel(
3✔
1109
                        p.cfg.Signer, dbChan, p.cfg.SigPool, chanOpts...,
3✔
1110
                )
3✔
1111
                if err != nil {
3✔
1112
                        return nil, fmt.Errorf("unable to create channel "+
×
1113
                                "state machine: %w", err)
×
1114
                }
×
1115

1116
                chanPoint := dbChan.FundingOutpoint
3✔
1117

3✔
1118
                chanID := lnwire.NewChanIDFromOutPoint(chanPoint)
3✔
1119

3✔
1120
                p.log.Infof("Loading ChannelPoint(%v), isPending=%v",
3✔
1121
                        chanPoint, lnChan.IsPending())
3✔
1122

3✔
1123
                // Skip adding any permanently irreconcilable channels to the
3✔
1124
                // htlcswitch.
3✔
1125
                if !dbChan.HasChanStatus(channeldb.ChanStatusDefault) &&
3✔
1126
                        !dbChan.HasChanStatus(channeldb.ChanStatusRestored) {
6✔
1127

3✔
1128
                        p.log.Warnf("ChannelPoint(%v) has status %v, won't "+
3✔
1129
                                "start.", chanPoint, dbChan.ChanStatus())
3✔
1130

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

1145
                        msgs = append(msgs, chanSync)
3✔
1146

3✔
1147
                        // Check if this channel needs to have the cooperative
3✔
1148
                        // close process restarted. If so, we'll need to send
3✔
1149
                        // the Shutdown message that is returned.
3✔
1150
                        if dbChan.HasChanStatus(
3✔
1151
                                channeldb.ChanStatusCoopBroadcasted,
3✔
1152
                        ) {
6✔
1153

3✔
1154
                                shutdownMsg, err := p.restartCoopClose(lnChan)
3✔
1155
                                if err != nil {
3✔
1156
                                        p.log.Errorf("Unable to restart "+
×
1157
                                                "coop close for channel: %v",
×
1158
                                                err)
×
1159
                                        continue
×
1160
                                }
1161

1162
                                if shutdownMsg == nil {
6✔
1163
                                        continue
3✔
1164
                                }
1165

1166
                                // Append the message to the set of messages to
1167
                                // send.
1168
                                msgs = append(msgs, shutdownMsg)
×
1169
                        }
1170

1171
                        continue
3✔
1172
                }
1173

1174
                // Before we register this new link with the HTLC Switch, we'll
1175
                // need to fetch its current link-layer forwarding policy from
1176
                // the database.
1177
                graph := p.cfg.ChannelGraph
3✔
1178
                info, p1, p2, err := graph.FetchChannelEdgesByOutpoint(
3✔
1179
                        &chanPoint,
3✔
1180
                )
3✔
1181
                if err != nil && !errors.Is(err, graphdb.ErrEdgeNotFound) {
3✔
1182
                        return nil, err
×
1183
                }
×
1184

1185
                // We'll filter out our policy from the directional channel
1186
                // edges based whom the edge connects to. If it doesn't connect
1187
                // to us, then we know that we were the one that advertised the
1188
                // policy.
1189
                //
1190
                // TODO(roasbeef): can add helper method to get policy for
1191
                // particular channel.
1192
                var selfPolicy *models.ChannelEdgePolicy
3✔
1193
                if info != nil && bytes.Equal(info.NodeKey1Bytes[:],
3✔
1194
                        p.cfg.ServerPubKey[:]) {
6✔
1195

3✔
1196
                        selfPolicy = p1
3✔
1197
                } else {
6✔
1198
                        selfPolicy = p2
3✔
1199
                }
3✔
1200

1201
                // If we don't yet have an advertised routing policy, then
1202
                // we'll use the current default, otherwise we'll translate the
1203
                // routing policy into a forwarding policy.
1204
                var forwardingPolicy *models.ForwardingPolicy
3✔
1205
                if selfPolicy != nil {
6✔
1206
                        var inboundWireFee lnwire.Fee
3✔
1207
                        _, err := selfPolicy.ExtraOpaqueData.ExtractRecords(
3✔
1208
                                &inboundWireFee,
3✔
1209
                        )
3✔
1210
                        if err != nil {
3✔
1211
                                return nil, err
×
1212
                        }
×
1213

1214
                        inboundFee := models.NewInboundFeeFromWire(
3✔
1215
                                inboundWireFee,
3✔
1216
                        )
3✔
1217

3✔
1218
                        forwardingPolicy = &models.ForwardingPolicy{
3✔
1219
                                MinHTLCOut:    selfPolicy.MinHTLC,
3✔
1220
                                MaxHTLC:       selfPolicy.MaxHTLC,
3✔
1221
                                BaseFee:       selfPolicy.FeeBaseMSat,
3✔
1222
                                FeeRate:       selfPolicy.FeeProportionalMillionths,
3✔
1223
                                TimeLockDelta: uint32(selfPolicy.TimeLockDelta),
3✔
1224

3✔
1225
                                InboundFee: inboundFee,
3✔
1226
                        }
3✔
1227
                } else {
3✔
1228
                        p.log.Warnf("Unable to find our forwarding policy "+
3✔
1229
                                "for channel %v, using default values",
3✔
1230
                                chanPoint)
3✔
1231
                        forwardingPolicy = &p.cfg.RoutingPolicy
3✔
1232
                }
3✔
1233

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

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

3✔
1246
                        continue
3✔
1247
                }
1248

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

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

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

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

×
1276
                                return
×
1277
                        }
×
1278

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

×
1295
                                return
×
1296
                        }
×
1297

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

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

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

×
1312
                                return
×
1313
                        }
×
1314

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

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

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

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

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

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

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

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

1377
        return msgs, nil
3✔
1378
}
1379

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

3✔
1550
                        return nil
3✔
1551
                }
3✔
1552

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

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

×
1565
                        return err
×
1566
                }
×
1567

1568
                return nil
3✔
1569
        }
1570

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

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

1591
        select {
3✔
1592
        case <-ready:
3✔
1593
        case <-p.cg.Done():
3✔
1594
        }
1595

1596
        p.cg.WgWait()
3✔
1597
}
1598

1599
// Disconnect terminates the connection with the remote peer. Additionally, a
1600
// signal is sent to the server and htlcSwitch indicating the resources
1601
// allocated to the peer can now be cleaned up.
1602
func (p *Brontide) Disconnect(reason error) {
3✔
1603
        if !atomic.CompareAndSwapInt32(&p.disconnect, 0, 1) {
6✔
1604
                return
3✔
1605
        }
3✔
1606

1607
        // Make sure initialization has completed before we try to tear things
1608
        // down.
1609
        //
1610
        // NOTE: We only read the `startReady` chan if the peer has been
1611
        // started, otherwise we will skip reading it as this chan won't be
1612
        // closed, hence blocks forever.
1613
        if atomic.LoadInt32(&p.started) == 1 {
6✔
1614
                p.log.Debugf("Started, waiting on startReady signal")
3✔
1615

3✔
1616
                select {
3✔
1617
                case <-p.startReady:
3✔
1618
                case <-p.cg.Done():
×
1619
                        return
×
1620
                }
1621
        }
1622

1623
        err := fmt.Errorf("disconnecting %s, reason: %v", p, reason)
3✔
1624
        p.storeError(err)
3✔
1625

3✔
1626
        p.log.Infof(err.Error())
3✔
1627

3✔
1628
        // Stop PingManager before closing TCP connection.
3✔
1629
        p.pingManager.Stop()
3✔
1630

3✔
1631
        // Ensure that the TCP connection is properly closed before continuing.
3✔
1632
        p.cfg.Conn.Close()
3✔
1633

3✔
1634
        p.cg.Quit()
3✔
1635

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

1645
// String returns the string representation of this peer.
1646
func (p *Brontide) String() string {
3✔
1647
        return fmt.Sprintf("%x@%s", p.cfg.PubKeyBytes, p.cfg.Conn.RemoteAddr())
3✔
1648
}
3✔
1649

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

1659
        pktLen, err := noiseConn.ReadNextHeader()
3✔
1660
        if err != nil {
6✔
1661
                return nil, fmt.Errorf("read next header: %w", err)
3✔
1662
        }
3✔
1663

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

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

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

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

1713
        p.logWireMessage(nextMsg, true)
3✔
1714

3✔
1715
        return nextMsg, nil
3✔
1716
}
1717

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

1726
        peer *Brontide
1727

1728
        apply func(lnwire.Message)
1729

1730
        startMsg string
1731
        stopMsg  string
1732

1733
        msgCond *sync.Cond
1734
        msgs    []lnwire.Message
1735

1736
        mtx sync.Mutex
1737

1738
        producerSema chan struct{}
1739

1740
        wg   sync.WaitGroup
1741
        quit chan struct{}
1742
}
1743

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

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

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

1770
        return stream
3✔
1771
}
1772

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

1779
// Stop stops the chanMsgStream.
1780
func (ms *msgStream) Stop() {
3✔
1781
        // TODO(roasbeef): signal too?
3✔
1782

3✔
1783
        close(ms.quit)
3✔
1784

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

1792
        ms.wg.Wait()
3✔
1793
}
1794

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

3✔
1802
        peerLog.Tracef(ms.startMsg)
3✔
1803

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

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

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

3✔
1832
                ms.msgCond.L.Unlock()
3✔
1833

3✔
1834
                ms.apply(msg)
3✔
1835

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

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

1866
        // Next, we'll lock the condition, and add the message to the end of
1867
        // the message queue.
1868
        ms.msgCond.L.Lock()
3✔
1869
        ms.msgs = append(ms.msgs, msg)
3✔
1870
        ms.msgCond.L.Unlock()
3✔
1871

3✔
1872
        // With the message added, we signal to the msgConsumer that there are
3✔
1873
        // additional messages to consume.
3✔
1874
        ms.msgCond.Signal()
3✔
1875
}
1876

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

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

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

3✔
1903
        // The link may already be active by this point, and we may have missed the
3✔
1904
        // ActiveLinkEvent. Check if the link exists.
3✔
1905
        link := p.fetchLinkFromKeyAndCid(cid)
3✔
1906
        if link != nil {
6✔
1907
                return link
3✔
1908
        }
3✔
1909

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

1924
                        chanPoint := event.ChannelPoint
3✔
1925

3✔
1926
                        // Check whether the retrieved chanPoint matches the target
3✔
1927
                        // channel id.
3✔
1928
                        if !cid.IsChanPoint(chanPoint) {
3✔
1929
                                continue
×
1930
                        }
1931

1932
                        // The link shouldn't be nil as we received an
1933
                        // ActiveLinkEvent. If it is nil, we return nil and the
1934
                        // calling function should catch it.
1935
                        return p.fetchLinkFromKeyAndCid(cid)
3✔
1936

1937
                case <-p.cg.Done():
3✔
1938
                        return nil
3✔
1939
                }
1940
        }
1941
}
1942

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

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

3✔
1959
                        // If the link is still not active and the calling function
3✔
1960
                        // errored out, just return.
3✔
1961
                        if chanLink == nil {
6✔
1962
                                p.log.Warnf("Link=%v is not active", cid)
3✔
1963
                                return
3✔
1964
                        }
3✔
1965
                }
1966

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

1976
                chanLink.HandleChannelUpdate(msg)
3✔
1977
        }
1978

1979
        return newMsgStream(p,
3✔
1980
                fmt.Sprintf("Update stream for ChannelID(%x) created", cid[:]),
3✔
1981
                fmt.Sprintf("Update stream for ChannelID(%x) exiting", cid[:]),
3✔
1982
                msgStreamSize,
3✔
1983
                apply,
3✔
1984
        )
3✔
1985
}
1986

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

3✔
1996
                // TODO(yy): `ProcessRemoteAnnouncement` returns an error chan
3✔
1997
                // and we need to process it.
3✔
1998
                p.cfg.AuthGossiper.ProcessRemoteAnnouncement(ctx, msg, p)
3✔
1999
        }
3✔
2000

2001
        return newMsgStream(
3✔
2002
                p,
3✔
2003
                "Update stream for gossiper created",
3✔
2004
                "Update stream for gossiper exited",
3✔
2005
                msgStreamSize,
3✔
2006
                apply,
3✔
2007
        )
3✔
2008
}
2009

2010
// readHandler is responsible for reading messages off the wire in series, then
2011
// properly dispatching the handling of the message to the proper subsystem.
2012
//
2013
// NOTE: This method MUST be run as a goroutine.
2014
func (p *Brontide) readHandler() {
3✔
2015
        defer p.cg.WgDone()
3✔
2016

3✔
2017
        // We'll stop the timer after a new messages is received, and also
3✔
2018
        // reset it after we process the next message.
3✔
2019
        idleTimer := time.AfterFunc(idleTimeout, func() {
3✔
2020
                err := fmt.Errorf("peer %s no answer for %s -- disconnecting",
×
2021
                        p, idleTimeout)
×
2022
                p.Disconnect(err)
×
2023
        })
×
2024

2025
        // Initialize our negotiated gossip sync method before reading messages
2026
        // off the wire. When using gossip queries, this ensures a gossip
2027
        // syncer is active by the time query messages arrive.
2028
        //
2029
        // TODO(conner): have peer store gossip syncer directly and bypass
2030
        // gossiper?
2031
        p.initGossipSync()
3✔
2032

3✔
2033
        discStream := newDiscMsgStream(p)
3✔
2034
        discStream.Start()
3✔
2035
        defer discStream.Stop()
3✔
2036
out:
3✔
2037
        for atomic.LoadInt32(&p.disconnect) == 0 {
6✔
2038
                nextMsg, err := p.readNextMessage()
3✔
2039
                if !idleTimer.Stop() {
6✔
2040
                        select {
3✔
2041
                        case <-idleTimer.C:
×
2042
                        default:
3✔
2043
                        }
2044
                }
2045
                if err != nil {
6✔
2046
                        p.log.Infof("unable to read message from peer: %v", err)
3✔
2047

3✔
2048
                        // If we could not read our peer's message due to an
3✔
2049
                        // unknown type or invalid alias, we continue processing
3✔
2050
                        // as normal. We store unknown message and address
3✔
2051
                        // types, as they may provide debugging insight.
3✔
2052
                        switch e := err.(type) {
3✔
2053
                        // If this is just a message we don't yet recognize,
2054
                        // we'll continue processing as normal as this allows
2055
                        // us to introduce new messages in a forwards
2056
                        // compatible manner.
2057
                        case *lnwire.UnknownMessage:
3✔
2058
                                p.storeError(e)
3✔
2059
                                idleTimer.Reset(idleTimeout)
3✔
2060
                                continue
3✔
2061

2062
                        // If they sent us an address type that we don't yet
2063
                        // know of, then this isn't a wire error, so we'll
2064
                        // simply continue parsing the remainder of their
2065
                        // messages.
2066
                        case *lnwire.ErrUnknownAddrType:
×
2067
                                p.storeError(e)
×
2068
                                idleTimer.Reset(idleTimeout)
×
2069
                                continue
×
2070

2071
                        // If the NodeAnnouncement has an invalid alias, then
2072
                        // we'll log that error above and continue so we can
2073
                        // continue to read messages from the peer. We do not
2074
                        // store this error because it is of little debugging
2075
                        // value.
2076
                        case *lnwire.ErrInvalidNodeAlias:
×
2077
                                idleTimer.Reset(idleTimeout)
×
2078
                                continue
×
2079

2080
                        // If the error we encountered wasn't just a message we
2081
                        // didn't recognize, then we'll stop all processing as
2082
                        // this is a fatal error.
2083
                        default:
3✔
2084
                                break out
3✔
2085
                        }
2086
                }
2087

2088
                // If a message router is active, then we'll try to have it
2089
                // handle this message. If it can, then we're able to skip the
2090
                // rest of the message handling logic.
2091
                err = fn.MapOptionZ(p.msgRouter, func(r msgmux.Router) error {
6✔
2092
                        return r.RouteMsg(msgmux.PeerMsg{
3✔
2093
                                PeerPub: *p.IdentityKey(),
3✔
2094
                                Message: nextMsg,
3✔
2095
                        })
3✔
2096
                })
3✔
2097

2098
                // No error occurred, and the message was handled by the
2099
                // router.
2100
                if err == nil {
6✔
2101
                        continue
3✔
2102
                }
2103

2104
                var (
3✔
2105
                        targetChan   lnwire.ChannelID
3✔
2106
                        isLinkUpdate bool
3✔
2107
                )
3✔
2108

3✔
2109
                switch msg := nextMsg.(type) {
3✔
2110
                case *lnwire.Pong:
×
2111
                        // When we receive a Pong message in response to our
×
2112
                        // last ping message, we send it to the pingManager
×
2113
                        p.pingManager.ReceivedPong(msg)
×
2114

2115
                case *lnwire.Ping:
×
2116
                        // First, we'll store their latest ping payload within
×
2117
                        // the relevant atomic variable.
×
2118
                        p.lastPingPayload.Store(msg.PaddingBytes[:])
×
2119

×
2120
                        // Next, we'll send over the amount of specified pong
×
2121
                        // bytes.
×
2122
                        pong := lnwire.NewPong(p.cfg.PongBuf[0:msg.NumPongBytes])
×
2123
                        p.queueMsg(pong, nil)
×
2124

2125
                case *lnwire.OpenChannel,
2126
                        *lnwire.AcceptChannel,
2127
                        *lnwire.FundingCreated,
2128
                        *lnwire.FundingSigned,
2129
                        *lnwire.ChannelReady:
3✔
2130

3✔
2131
                        p.cfg.FundingManager.ProcessFundingMsg(msg, p)
3✔
2132

2133
                case *lnwire.Shutdown:
3✔
2134
                        select {
3✔
2135
                        case p.chanCloseMsgs <- &closeMsg{msg.ChannelID, msg}:
3✔
2136
                        case <-p.cg.Done():
×
2137
                                break out
×
2138
                        }
2139
                case *lnwire.ClosingSigned:
3✔
2140
                        select {
3✔
2141
                        case p.chanCloseMsgs <- &closeMsg{msg.ChannelID, msg}:
3✔
2142
                        case <-p.cg.Done():
×
2143
                                break out
×
2144
                        }
2145

2146
                case *lnwire.Warning:
×
2147
                        targetChan = msg.ChanID
×
2148
                        isLinkUpdate = p.handleWarningOrError(targetChan, msg)
×
2149

2150
                case *lnwire.Error:
3✔
2151
                        targetChan = msg.ChanID
3✔
2152
                        isLinkUpdate = p.handleWarningOrError(targetChan, msg)
3✔
2153

2154
                case *lnwire.ChannelReestablish:
3✔
2155
                        targetChan = msg.ChanID
3✔
2156
                        isLinkUpdate = p.hasChannel(targetChan)
3✔
2157

3✔
2158
                        // If we failed to find the link in question, and the
3✔
2159
                        // message received was a channel sync message, then
3✔
2160
                        // this might be a peer trying to resync closed channel.
3✔
2161
                        // In this case we'll try to resend our last channel
3✔
2162
                        // sync message, such that the peer can recover funds
3✔
2163
                        // from the closed channel.
3✔
2164
                        if !isLinkUpdate {
6✔
2165
                                err := p.resendChanSyncMsg(targetChan)
3✔
2166
                                if err != nil {
6✔
2167
                                        // TODO(halseth): send error to peer?
3✔
2168
                                        p.log.Errorf("resend failed: %v",
3✔
2169
                                                err)
3✔
2170
                                }
3✔
2171
                        }
2172

2173
                // For messages that implement the LinkUpdater interface, we
2174
                // will consider them as link updates and send them to
2175
                // chanStream. These messages will be queued inside chanStream
2176
                // if the channel is not active yet.
2177
                case lnwire.LinkUpdater:
3✔
2178
                        targetChan = msg.TargetChanID()
3✔
2179
                        isLinkUpdate = p.hasChannel(targetChan)
3✔
2180

3✔
2181
                        // Log an error if we don't have this channel. This
3✔
2182
                        // means the peer has sent us a message with unknown
3✔
2183
                        // channel ID.
3✔
2184
                        if !isLinkUpdate {
6✔
2185
                                p.log.Errorf("Unknown channel ID: %v found "+
3✔
2186
                                        "in received msg=%s", targetChan,
3✔
2187
                                        nextMsg.MsgType())
3✔
2188
                        }
3✔
2189

2190
                case *lnwire.ChannelUpdate1,
2191
                        *lnwire.ChannelAnnouncement1,
2192
                        *lnwire.NodeAnnouncement,
2193
                        *lnwire.AnnounceSignatures1,
2194
                        *lnwire.GossipTimestampRange,
2195
                        *lnwire.QueryShortChanIDs,
2196
                        *lnwire.QueryChannelRange,
2197
                        *lnwire.ReplyChannelRange,
2198
                        *lnwire.ReplyShortChanIDsEnd:
3✔
2199

3✔
2200
                        discStream.AddMsg(msg)
3✔
2201

2202
                case *lnwire.Custom:
3✔
2203
                        err := p.handleCustomMessage(msg)
3✔
2204
                        if err != nil {
3✔
2205
                                p.storeError(err)
×
2206
                                p.log.Errorf("%v", err)
×
2207
                        }
×
2208

2209
                default:
×
2210
                        // If the message we received is unknown to us, store
×
2211
                        // the type to track the failure.
×
2212
                        err := fmt.Errorf("unknown message type %v received",
×
2213
                                uint16(msg.MsgType()))
×
2214
                        p.storeError(err)
×
2215

×
2216
                        p.log.Errorf("%v", err)
×
2217
                }
2218

2219
                if isLinkUpdate {
6✔
2220
                        // If this is a channel update, then we need to feed it
3✔
2221
                        // into the channel's in-order message stream.
3✔
2222
                        p.sendLinkUpdateMsg(targetChan, nextMsg)
3✔
2223
                }
3✔
2224

2225
                idleTimer.Reset(idleTimeout)
3✔
2226
        }
2227

2228
        p.Disconnect(errors.New("read handler closed"))
3✔
2229

3✔
2230
        p.log.Trace("readHandler for peer done")
3✔
2231
}
2232

2233
// handleCustomMessage handles the given custom message if a handler is
2234
// registered.
2235
func (p *Brontide) handleCustomMessage(msg *lnwire.Custom) error {
3✔
2236
        if p.cfg.HandleCustomMessage == nil {
3✔
2237
                return fmt.Errorf("no custom message handler for "+
×
2238
                        "message type %v", uint16(msg.MsgType()))
×
2239
        }
×
2240

2241
        return p.cfg.HandleCustomMessage(p.PubKey(), msg)
3✔
2242
}
2243

2244
// isLoadedFromDisk returns true if the provided channel ID is loaded from
2245
// disk.
2246
//
2247
// NOTE: only returns true for pending channels.
2248
func (p *Brontide) isLoadedFromDisk(chanID lnwire.ChannelID) bool {
3✔
2249
        // If this is a newly added channel, no need to reestablish.
3✔
2250
        _, added := p.addedChannels.Load(chanID)
3✔
2251
        if added {
6✔
2252
                return false
3✔
2253
        }
3✔
2254

2255
        // Return false if the channel is unknown.
2256
        channel, ok := p.activeChannels.Load(chanID)
3✔
2257
        if !ok {
3✔
2258
                return false
×
2259
        }
×
2260

2261
        // During startup, we will use a nil value to mark a pending channel
2262
        // that's loaded from disk.
2263
        return channel == nil
3✔
2264
}
2265

2266
// isActiveChannel returns true if the provided channel id is active, otherwise
2267
// returns false.
2268
func (p *Brontide) isActiveChannel(chanID lnwire.ChannelID) bool {
3✔
2269
        // The channel would be nil if,
3✔
2270
        // - the channel doesn't exist, or,
3✔
2271
        // - the channel exists, but is pending. In this case, we don't
3✔
2272
        //   consider this channel active.
3✔
2273
        channel, _ := p.activeChannels.Load(chanID)
3✔
2274

3✔
2275
        return channel != nil
3✔
2276
}
3✔
2277

2278
// isPendingChannel returns true if the provided channel ID is pending, and
2279
// returns false if the channel is active or unknown.
2280
func (p *Brontide) isPendingChannel(chanID lnwire.ChannelID) bool {
3✔
2281
        // Return false if the channel is unknown.
3✔
2282
        channel, ok := p.activeChannels.Load(chanID)
3✔
2283
        if !ok {
6✔
2284
                return false
3✔
2285
        }
3✔
2286

2287
        return channel == nil
3✔
2288
}
2289

2290
// hasChannel returns true if the peer has a pending/active channel specified
2291
// by the channel ID.
2292
func (p *Brontide) hasChannel(chanID lnwire.ChannelID) bool {
3✔
2293
        _, ok := p.activeChannels.Load(chanID)
3✔
2294
        return ok
3✔
2295
}
3✔
2296

2297
// storeError stores an error in our peer's buffer of recent errors with the
2298
// current timestamp. Errors are only stored if we have at least one active
2299
// channel with the peer to mitigate a dos vector where a peer costlessly
2300
// connects to us and spams us with errors.
2301
func (p *Brontide) storeError(err error) {
3✔
2302
        var haveChannels bool
3✔
2303

3✔
2304
        p.activeChannels.Range(func(_ lnwire.ChannelID,
3✔
2305
                channel *lnwallet.LightningChannel) bool {
6✔
2306

3✔
2307
                // Pending channels will be nil in the activeChannels map.
3✔
2308
                if channel == nil {
6✔
2309
                        // Return true to continue the iteration.
3✔
2310
                        return true
3✔
2311
                }
3✔
2312

2313
                haveChannels = true
3✔
2314

3✔
2315
                // Return false to break the iteration.
3✔
2316
                return false
3✔
2317
        })
2318

2319
        // If we do not have any active channels with the peer, we do not store
2320
        // errors as a dos mitigation.
2321
        if !haveChannels {
6✔
2322
                p.log.Trace("no channels with peer, not storing err")
3✔
2323
                return
3✔
2324
        }
3✔
2325

2326
        p.cfg.ErrorBuffer.Add(
3✔
2327
                &TimestampedError{Timestamp: time.Now(), Error: err},
3✔
2328
        )
3✔
2329
}
2330

2331
// handleWarningOrError processes a warning or error msg and returns true if
2332
// msg should be forwarded to the associated channel link. False is returned if
2333
// any necessary forwarding of msg was already handled by this method. If msg is
2334
// an error from a peer with an active channel, we'll store it in memory.
2335
//
2336
// NOTE: This method should only be called from within the readHandler.
2337
func (p *Brontide) handleWarningOrError(chanID lnwire.ChannelID,
2338
        msg lnwire.Message) bool {
3✔
2339

3✔
2340
        if errMsg, ok := msg.(*lnwire.Error); ok {
6✔
2341
                p.storeError(errMsg)
3✔
2342
        }
3✔
2343

2344
        switch {
3✔
2345
        // Connection wide messages should be forwarded to all channel links
2346
        // with this peer.
2347
        case chanID == lnwire.ConnectionWideID:
×
2348
                for _, chanStream := range p.activeMsgStreams {
×
2349
                        chanStream.AddMsg(msg)
×
2350
                }
×
2351

2352
                return false
×
2353

2354
        // If the channel ID for the message corresponds to a pending channel,
2355
        // then the funding manager will handle it.
2356
        case p.cfg.FundingManager.IsPendingChannel(chanID, p):
3✔
2357
                p.cfg.FundingManager.ProcessFundingMsg(msg, p)
3✔
2358
                return false
3✔
2359

2360
        // If not we hand the message to the channel link for this channel.
2361
        case p.isActiveChannel(chanID):
3✔
2362
                return true
3✔
2363

2364
        default:
3✔
2365
                return false
3✔
2366
        }
2367
}
2368

2369
// messageSummary returns a human-readable string that summarizes a
2370
// incoming/outgoing message. Not all messages will have a summary, only those
2371
// which have additional data that can be informative at a glance.
2372
func messageSummary(msg lnwire.Message) string {
3✔
2373
        switch msg := msg.(type) {
3✔
2374
        case *lnwire.Init:
3✔
2375
                // No summary.
3✔
2376
                return ""
3✔
2377

2378
        case *lnwire.OpenChannel:
3✔
2379
                return fmt.Sprintf("temp_chan_id=%x, chain=%v, csv=%v, amt=%v, "+
3✔
2380
                        "push_amt=%v, reserve=%v, flags=%v",
3✔
2381
                        msg.PendingChannelID[:], msg.ChainHash,
3✔
2382
                        msg.CsvDelay, msg.FundingAmount, msg.PushAmount,
3✔
2383
                        msg.ChannelReserve, msg.ChannelFlags)
3✔
2384

2385
        case *lnwire.AcceptChannel:
3✔
2386
                return fmt.Sprintf("temp_chan_id=%x, reserve=%v, csv=%v, num_confs=%v",
3✔
2387
                        msg.PendingChannelID[:], msg.ChannelReserve, msg.CsvDelay,
3✔
2388
                        msg.MinAcceptDepth)
3✔
2389

2390
        case *lnwire.FundingCreated:
3✔
2391
                return fmt.Sprintf("temp_chan_id=%x, chan_point=%v",
3✔
2392
                        msg.PendingChannelID[:], msg.FundingPoint)
3✔
2393

2394
        case *lnwire.FundingSigned:
3✔
2395
                return fmt.Sprintf("chan_id=%v", msg.ChanID)
3✔
2396

2397
        case *lnwire.ChannelReady:
3✔
2398
                return fmt.Sprintf("chan_id=%v, next_point=%x",
3✔
2399
                        msg.ChanID, msg.NextPerCommitmentPoint.SerializeCompressed())
3✔
2400

2401
        case *lnwire.Shutdown:
3✔
2402
                return fmt.Sprintf("chan_id=%v, script=%x", msg.ChannelID,
3✔
2403
                        msg.Address[:])
3✔
2404

2405
        case *lnwire.ClosingComplete:
3✔
2406
                return fmt.Sprintf("chan_id=%v, fee_sat=%v, locktime=%v",
3✔
2407
                        msg.ChannelID, msg.FeeSatoshis, msg.LockTime)
3✔
2408

2409
        case *lnwire.ClosingSig:
3✔
2410
                return fmt.Sprintf("chan_id=%v", msg.ChannelID)
3✔
2411

2412
        case *lnwire.ClosingSigned:
3✔
2413
                return fmt.Sprintf("chan_id=%v, fee_sat=%v", msg.ChannelID,
3✔
2414
                        msg.FeeSatoshis)
3✔
2415

2416
        case *lnwire.UpdateAddHTLC:
3✔
2417
                var blindingPoint []byte
3✔
2418
                msg.BlindingPoint.WhenSome(
3✔
2419
                        func(b tlv.RecordT[lnwire.BlindingPointTlvType,
3✔
2420
                                *btcec.PublicKey]) {
6✔
2421

3✔
2422
                                blindingPoint = b.Val.SerializeCompressed()
3✔
2423
                        },
3✔
2424
                )
2425

2426
                return fmt.Sprintf("chan_id=%v, id=%v, amt=%v, expiry=%v, "+
3✔
2427
                        "hash=%x, blinding_point=%x, custom_records=%v",
3✔
2428
                        msg.ChanID, msg.ID, msg.Amount, msg.Expiry,
3✔
2429
                        msg.PaymentHash[:], blindingPoint, msg.CustomRecords)
3✔
2430

2431
        case *lnwire.UpdateFailHTLC:
3✔
2432
                return fmt.Sprintf("chan_id=%v, id=%v, reason=%x", msg.ChanID,
3✔
2433
                        msg.ID, msg.Reason)
3✔
2434

2435
        case *lnwire.UpdateFulfillHTLC:
3✔
2436
                return fmt.Sprintf("chan_id=%v, id=%v, preimage=%x, "+
3✔
2437
                        "custom_records=%v", msg.ChanID, msg.ID,
3✔
2438
                        msg.PaymentPreimage[:], msg.CustomRecords)
3✔
2439

2440
        case *lnwire.CommitSig:
3✔
2441
                return fmt.Sprintf("chan_id=%v, num_htlcs=%v", msg.ChanID,
3✔
2442
                        len(msg.HtlcSigs))
3✔
2443

2444
        case *lnwire.RevokeAndAck:
3✔
2445
                return fmt.Sprintf("chan_id=%v, rev=%x, next_point=%x",
3✔
2446
                        msg.ChanID, msg.Revocation[:],
3✔
2447
                        msg.NextRevocationKey.SerializeCompressed())
3✔
2448

2449
        case *lnwire.UpdateFailMalformedHTLC:
3✔
2450
                return fmt.Sprintf("chan_id=%v, id=%v, fail_code=%v",
3✔
2451
                        msg.ChanID, msg.ID, msg.FailureCode)
3✔
2452

2453
        case *lnwire.Warning:
×
2454
                return fmt.Sprintf("%v", msg.Warning())
×
2455

2456
        case *lnwire.Error:
3✔
2457
                return fmt.Sprintf("%v", msg.Error())
3✔
2458

2459
        case *lnwire.AnnounceSignatures1:
3✔
2460
                return fmt.Sprintf("chan_id=%v, short_chan_id=%v", msg.ChannelID,
3✔
2461
                        msg.ShortChannelID.ToUint64())
3✔
2462

2463
        case *lnwire.ChannelAnnouncement1:
3✔
2464
                return fmt.Sprintf("chain_hash=%v, short_chan_id=%v",
3✔
2465
                        msg.ChainHash, msg.ShortChannelID.ToUint64())
3✔
2466

2467
        case *lnwire.ChannelUpdate1:
3✔
2468
                return fmt.Sprintf("chain_hash=%v, short_chan_id=%v, "+
3✔
2469
                        "mflags=%v, cflags=%v, update_time=%v", msg.ChainHash,
3✔
2470
                        msg.ShortChannelID.ToUint64(), msg.MessageFlags,
3✔
2471
                        msg.ChannelFlags, time.Unix(int64(msg.Timestamp), 0))
3✔
2472

2473
        case *lnwire.NodeAnnouncement:
3✔
2474
                return fmt.Sprintf("node=%x, update_time=%v",
3✔
2475
                        msg.NodeID, time.Unix(int64(msg.Timestamp), 0))
3✔
2476

2477
        case *lnwire.Ping:
×
2478
                return fmt.Sprintf("ping_bytes=%x", msg.PaddingBytes[:])
×
2479

2480
        case *lnwire.Pong:
×
2481
                return fmt.Sprintf("len(pong_bytes)=%d", len(msg.PongBytes[:]))
×
2482

2483
        case *lnwire.UpdateFee:
×
2484
                return fmt.Sprintf("chan_id=%v, fee_update_sat=%v",
×
2485
                        msg.ChanID, int64(msg.FeePerKw))
×
2486

2487
        case *lnwire.ChannelReestablish:
3✔
2488
                return fmt.Sprintf("chan_id=%v, next_local_height=%v, "+
3✔
2489
                        "remote_tail_height=%v", msg.ChanID,
3✔
2490
                        msg.NextLocalCommitHeight, msg.RemoteCommitTailHeight)
3✔
2491

2492
        case *lnwire.ReplyShortChanIDsEnd:
3✔
2493
                return fmt.Sprintf("chain_hash=%v, complete=%v", msg.ChainHash,
3✔
2494
                        msg.Complete)
3✔
2495

2496
        case *lnwire.ReplyChannelRange:
3✔
2497
                return fmt.Sprintf("start_height=%v, end_height=%v, "+
3✔
2498
                        "num_chans=%v, encoding=%v", msg.FirstBlockHeight,
3✔
2499
                        msg.LastBlockHeight(), len(msg.ShortChanIDs),
3✔
2500
                        msg.EncodingType)
3✔
2501

2502
        case *lnwire.QueryShortChanIDs:
3✔
2503
                return fmt.Sprintf("chain_hash=%v, encoding=%v, num_chans=%v",
3✔
2504
                        msg.ChainHash, msg.EncodingType, len(msg.ShortChanIDs))
3✔
2505

2506
        case *lnwire.QueryChannelRange:
3✔
2507
                return fmt.Sprintf("chain_hash=%v, start_height=%v, "+
3✔
2508
                        "end_height=%v", msg.ChainHash, msg.FirstBlockHeight,
3✔
2509
                        msg.LastBlockHeight())
3✔
2510

2511
        case *lnwire.GossipTimestampRange:
3✔
2512
                return fmt.Sprintf("chain_hash=%v, first_stamp=%v, "+
3✔
2513
                        "stamp_range=%v", msg.ChainHash,
3✔
2514
                        time.Unix(int64(msg.FirstTimestamp), 0),
3✔
2515
                        msg.TimestampRange)
3✔
2516

2517
        case *lnwire.Stfu:
3✔
2518
                return fmt.Sprintf("chan_id=%v, initiator=%v", msg.ChanID,
3✔
2519
                        msg.Initiator)
3✔
2520

2521
        case *lnwire.Custom:
3✔
2522
                return fmt.Sprintf("type=%d", msg.Type)
3✔
2523
        }
2524

2525
        return fmt.Sprintf("unknown msg type=%T", msg)
×
2526
}
2527

2528
// logWireMessage logs the receipt or sending of particular wire message. This
2529
// function is used rather than just logging the message in order to produce
2530
// less spammy log messages in trace mode by setting the 'Curve" parameter to
2531
// nil. Doing this avoids printing out each of the field elements in the curve
2532
// parameters for secp256k1.
2533
func (p *Brontide) logWireMessage(msg lnwire.Message, read bool) {
3✔
2534
        summaryPrefix := "Received"
3✔
2535
        if !read {
6✔
2536
                summaryPrefix = "Sending"
3✔
2537
        }
3✔
2538

2539
        p.log.Debugf("%v", lnutils.NewLogClosure(func() string {
6✔
2540
                // Debug summary of message.
3✔
2541
                summary := messageSummary(msg)
3✔
2542
                if len(summary) > 0 {
6✔
2543
                        summary = "(" + summary + ")"
3✔
2544
                }
3✔
2545

2546
                preposition := "to"
3✔
2547
                if read {
6✔
2548
                        preposition = "from"
3✔
2549
                }
3✔
2550

2551
                var msgType string
3✔
2552
                if msg.MsgType() < lnwire.CustomTypeStart {
6✔
2553
                        msgType = msg.MsgType().String()
3✔
2554
                } else {
6✔
2555
                        msgType = "custom"
3✔
2556
                }
3✔
2557

2558
                return fmt.Sprintf("%v %v%s %v %s", summaryPrefix,
3✔
2559
                        msgType, summary, preposition, p)
3✔
2560
        }))
2561

2562
        prefix := "readMessage from peer"
3✔
2563
        if !read {
6✔
2564
                prefix = "writeMessage to peer"
3✔
2565
        }
3✔
2566

2567
        p.log.Tracef(prefix+": %v", lnutils.SpewLogClosure(msg))
3✔
2568
}
2569

2570
// writeMessage writes and flushes the target lnwire.Message to the remote peer.
2571
// If the passed message is nil, this method will only try to flush an existing
2572
// message buffered on the connection. It is safe to call this method again
2573
// with a nil message iff a timeout error is returned. This will continue to
2574
// flush the pending message to the wire.
2575
//
2576
// NOTE:
2577
// Besides its usage in Start, this function should not be used elsewhere
2578
// except in writeHandler. If multiple goroutines call writeMessage at the same
2579
// time, panics can occur because WriteMessage and Flush don't use any locking
2580
// internally.
2581
func (p *Brontide) writeMessage(msg lnwire.Message) error {
3✔
2582
        // Only log the message on the first attempt.
3✔
2583
        if msg != nil {
6✔
2584
                p.logWireMessage(msg, false)
3✔
2585
        }
3✔
2586

2587
        noiseConn := p.cfg.Conn
3✔
2588

3✔
2589
        flushMsg := func() error {
6✔
2590
                // Ensure the write deadline is set before we attempt to send
3✔
2591
                // the message.
3✔
2592
                writeDeadline := time.Now().Add(
3✔
2593
                        p.scaleTimeout(writeMessageTimeout),
3✔
2594
                )
3✔
2595
                err := noiseConn.SetWriteDeadline(writeDeadline)
3✔
2596
                if err != nil {
3✔
2597
                        return err
×
2598
                }
×
2599

2600
                // Flush the pending message to the wire. If an error is
2601
                // encountered, e.g. write timeout, the number of bytes written
2602
                // so far will be returned.
2603
                n, err := noiseConn.Flush()
3✔
2604

3✔
2605
                // Record the number of bytes written on the wire, if any.
3✔
2606
                if n > 0 {
6✔
2607
                        atomic.AddUint64(&p.bytesSent, uint64(n))
3✔
2608
                }
3✔
2609

2610
                return err
3✔
2611
        }
2612

2613
        // If the current message has already been serialized, encrypted, and
2614
        // buffered on the underlying connection we will skip straight to
2615
        // flushing it to the wire.
2616
        if msg == nil {
3✔
2617
                return flushMsg()
×
2618
        }
×
2619

2620
        // Otherwise, this is a new message. We'll acquire a write buffer to
2621
        // serialize the message and buffer the ciphertext on the connection.
2622
        err := p.cfg.WritePool.Submit(func(buf *bytes.Buffer) error {
6✔
2623
                // Using a buffer allocated by the write pool, encode the
3✔
2624
                // message directly into the buffer.
3✔
2625
                _, writeErr := lnwire.WriteMessage(buf, msg, 0)
3✔
2626
                if writeErr != nil {
3✔
2627
                        return writeErr
×
2628
                }
×
2629

2630
                // Finally, write the message itself in a single swoop. This
2631
                // will buffer the ciphertext on the underlying connection. We
2632
                // will defer flushing the message until the write pool has been
2633
                // released.
2634
                return noiseConn.WriteMessage(buf.Bytes())
3✔
2635
        })
2636
        if err != nil {
3✔
2637
                return err
×
2638
        }
×
2639

2640
        return flushMsg()
3✔
2641
}
2642

2643
// writeHandler is a goroutine dedicated to reading messages off of an incoming
2644
// queue, and writing them out to the wire. This goroutine coordinates with the
2645
// queueHandler in order to ensure the incoming message queue is quickly
2646
// drained.
2647
//
2648
// NOTE: This method MUST be run as a goroutine.
2649
func (p *Brontide) writeHandler() {
3✔
2650
        // We'll stop the timer after a new messages is sent, and also reset it
3✔
2651
        // after we process the next message.
3✔
2652
        idleTimer := time.AfterFunc(idleTimeout, func() {
3✔
2653
                err := fmt.Errorf("peer %s no write for %s -- disconnecting",
×
2654
                        p, idleTimeout)
×
2655
                p.Disconnect(err)
×
2656
        })
×
2657

2658
        var exitErr error
3✔
2659

3✔
2660
out:
3✔
2661
        for {
6✔
2662
                select {
3✔
2663
                case outMsg := <-p.sendQueue:
3✔
2664
                        // Record the time at which we first attempt to send the
3✔
2665
                        // message.
3✔
2666
                        startTime := time.Now()
3✔
2667

3✔
2668
                retry:
3✔
2669
                        // Write out the message to the socket. If a timeout
2670
                        // error is encountered, we will catch this and retry
2671
                        // after backing off in case the remote peer is just
2672
                        // slow to process messages from the wire.
2673
                        err := p.writeMessage(outMsg.msg)
3✔
2674
                        if nerr, ok := err.(net.Error); ok && nerr.Timeout() {
3✔
2675
                                p.log.Debugf("Write timeout detected for "+
×
2676
                                        "peer, first write for message "+
×
2677
                                        "attempted %v ago",
×
2678
                                        time.Since(startTime))
×
2679

×
2680
                                // If we received a timeout error, this implies
×
2681
                                // that the message was buffered on the
×
2682
                                // connection successfully and that a flush was
×
2683
                                // attempted. We'll set the message to nil so
×
2684
                                // that on a subsequent pass we only try to
×
2685
                                // flush the buffered message, and forgo
×
2686
                                // reserializing or reencrypting it.
×
2687
                                outMsg.msg = nil
×
2688

×
2689
                                goto retry
×
2690
                        }
2691

2692
                        // The write succeeded, reset the idle timer to prevent
2693
                        // us from disconnecting the peer.
2694
                        if !idleTimer.Stop() {
3✔
2695
                                select {
×
2696
                                case <-idleTimer.C:
×
2697
                                default:
×
2698
                                }
2699
                        }
2700
                        idleTimer.Reset(idleTimeout)
3✔
2701

3✔
2702
                        // If the peer requested a synchronous write, respond
3✔
2703
                        // with the error.
3✔
2704
                        if outMsg.errChan != nil {
6✔
2705
                                outMsg.errChan <- err
3✔
2706
                        }
3✔
2707

2708
                        if err != nil {
3✔
2709
                                exitErr = fmt.Errorf("unable to write "+
×
2710
                                        "message: %v", err)
×
2711
                                break out
×
2712
                        }
2713

2714
                case <-p.cg.Done():
3✔
2715
                        exitErr = lnpeer.ErrPeerExiting
3✔
2716
                        break out
3✔
2717
                }
2718
        }
2719

2720
        // Avoid an exit deadlock by ensuring WaitGroups are decremented before
2721
        // disconnect.
2722
        p.cg.WgDone()
3✔
2723

3✔
2724
        p.Disconnect(exitErr)
3✔
2725

3✔
2726
        p.log.Trace("writeHandler for peer done")
3✔
2727
}
2728

2729
// queueHandler is responsible for accepting messages from outside subsystems
2730
// to be eventually sent out on the wire by the writeHandler.
2731
//
2732
// NOTE: This method MUST be run as a goroutine.
2733
func (p *Brontide) queueHandler() {
3✔
2734
        defer p.cg.WgDone()
3✔
2735

3✔
2736
        // priorityMsgs holds an in order list of messages deemed high-priority
3✔
2737
        // to be added to the sendQueue. This predominately includes messages
3✔
2738
        // from the funding manager and htlcswitch.
3✔
2739
        priorityMsgs := list.New()
3✔
2740

3✔
2741
        // lazyMsgs holds an in order list of messages deemed low-priority to be
3✔
2742
        // added to the sendQueue only after all high-priority messages have
3✔
2743
        // been queued. This predominately includes messages from the gossiper.
3✔
2744
        lazyMsgs := list.New()
3✔
2745

3✔
2746
        for {
6✔
2747
                // Examine the front of the priority queue, if it is empty check
3✔
2748
                // the low priority queue.
3✔
2749
                elem := priorityMsgs.Front()
3✔
2750
                if elem == nil {
6✔
2751
                        elem = lazyMsgs.Front()
3✔
2752
                }
3✔
2753

2754
                if elem != nil {
6✔
2755
                        front := elem.Value.(outgoingMsg)
3✔
2756

3✔
2757
                        // There's an element on the queue, try adding
3✔
2758
                        // it to the sendQueue. We also watch for
3✔
2759
                        // messages on the outgoingQueue, in case the
3✔
2760
                        // writeHandler cannot accept messages on the
3✔
2761
                        // sendQueue.
3✔
2762
                        select {
3✔
2763
                        case p.sendQueue <- front:
3✔
2764
                                if front.priority {
6✔
2765
                                        priorityMsgs.Remove(elem)
3✔
2766
                                } else {
6✔
2767
                                        lazyMsgs.Remove(elem)
3✔
2768
                                }
3✔
2769
                        case msg := <-p.outgoingQueue:
3✔
2770
                                if msg.priority {
6✔
2771
                                        priorityMsgs.PushBack(msg)
3✔
2772
                                } else {
6✔
2773
                                        lazyMsgs.PushBack(msg)
3✔
2774
                                }
3✔
2775
                        case <-p.cg.Done():
×
2776
                                return
×
2777
                        }
2778
                } else {
3✔
2779
                        // If there weren't any messages to send to the
3✔
2780
                        // writeHandler, then we'll accept a new message
3✔
2781
                        // into the queue from outside sub-systems.
3✔
2782
                        select {
3✔
2783
                        case msg := <-p.outgoingQueue:
3✔
2784
                                if msg.priority {
6✔
2785
                                        priorityMsgs.PushBack(msg)
3✔
2786
                                } else {
6✔
2787
                                        lazyMsgs.PushBack(msg)
3✔
2788
                                }
3✔
2789
                        case <-p.cg.Done():
3✔
2790
                                return
3✔
2791
                        }
2792
                }
2793
        }
2794
}
2795

2796
// PingTime returns the estimated ping time to the peer in microseconds.
2797
func (p *Brontide) PingTime() int64 {
3✔
2798
        return p.pingManager.GetPingTimeMicroSeconds()
3✔
2799
}
3✔
2800

2801
// queueMsg adds the lnwire.Message to the back of the high priority send queue.
2802
// If the errChan is non-nil, an error is sent back if the msg failed to queue
2803
// or failed to write, and nil otherwise.
2804
func (p *Brontide) queueMsg(msg lnwire.Message, errChan chan error) {
3✔
2805
        p.queue(true, msg, errChan)
3✔
2806
}
3✔
2807

2808
// queueMsgLazy adds the lnwire.Message to the back of the low priority send
2809
// queue. If the errChan is non-nil, an error is sent back if the msg failed to
2810
// queue or failed to write, and nil otherwise.
2811
func (p *Brontide) queueMsgLazy(msg lnwire.Message, errChan chan error) {
3✔
2812
        p.queue(false, msg, errChan)
3✔
2813
}
3✔
2814

2815
// queue sends a given message to the queueHandler using the passed priority. If
2816
// the errChan is non-nil, an error is sent back if the msg failed to queue or
2817
// failed to write, and nil otherwise.
2818
func (p *Brontide) queue(priority bool, msg lnwire.Message,
2819
        errChan chan error) {
3✔
2820

3✔
2821
        select {
3✔
2822
        case p.outgoingQueue <- outgoingMsg{priority, msg, errChan}:
3✔
2823
        case <-p.cg.Done():
×
2824
                p.log.Tracef("Peer shutting down, could not enqueue msg: %v.",
×
2825
                        spew.Sdump(msg))
×
2826
                if errChan != nil {
×
2827
                        errChan <- lnpeer.ErrPeerExiting
×
2828
                }
×
2829
        }
2830
}
2831

2832
// ChannelSnapshots returns a slice of channel snapshots detailing all
2833
// currently active channels maintained with the remote peer.
2834
func (p *Brontide) ChannelSnapshots() []*channeldb.ChannelSnapshot {
3✔
2835
        snapshots := make(
3✔
2836
                []*channeldb.ChannelSnapshot, 0, p.activeChannels.Len(),
3✔
2837
        )
3✔
2838

3✔
2839
        p.activeChannels.ForEach(func(_ lnwire.ChannelID,
3✔
2840
                activeChan *lnwallet.LightningChannel) error {
6✔
2841

3✔
2842
                // If the activeChan is nil, then we skip it as the channel is
3✔
2843
                // pending.
3✔
2844
                if activeChan == nil {
6✔
2845
                        return nil
3✔
2846
                }
3✔
2847

2848
                // We'll only return a snapshot for channels that are
2849
                // *immediately* available for routing payments over.
2850
                if activeChan.RemoteNextRevocation() == nil {
6✔
2851
                        return nil
3✔
2852
                }
3✔
2853

2854
                snapshot := activeChan.StateSnapshot()
3✔
2855
                snapshots = append(snapshots, snapshot)
3✔
2856

3✔
2857
                return nil
3✔
2858
        })
2859

2860
        return snapshots
3✔
2861
}
2862

2863
// genDeliveryScript returns a new script to be used to send our funds to in
2864
// the case of a cooperative channel close negotiation.
2865
func (p *Brontide) genDeliveryScript() ([]byte, error) {
3✔
2866
        // We'll send a normal p2wkh address unless we've negotiated the
3✔
2867
        // shutdown-any-segwit feature.
3✔
2868
        addrType := lnwallet.WitnessPubKey
3✔
2869
        if p.taprootShutdownAllowed() {
6✔
2870
                addrType = lnwallet.TaprootPubkey
3✔
2871
        }
3✔
2872

2873
        deliveryAddr, err := p.cfg.Wallet.NewAddress(
3✔
2874
                addrType, false, lnwallet.DefaultAccountName,
3✔
2875
        )
3✔
2876
        if err != nil {
3✔
2877
                return nil, err
×
2878
        }
×
2879
        p.log.Infof("Delivery addr for channel close: %v",
3✔
2880
                deliveryAddr)
3✔
2881

3✔
2882
        return txscript.PayToAddrScript(deliveryAddr)
3✔
2883
}
2884

2885
// channelManager is goroutine dedicated to handling all requests/signals
2886
// pertaining to the opening, cooperative closing, and force closing of all
2887
// channels maintained with the remote peer.
2888
//
2889
// NOTE: This method MUST be run as a goroutine.
2890
func (p *Brontide) channelManager() {
3✔
2891
        defer p.cg.WgDone()
3✔
2892

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

3✔
2898
out:
3✔
2899
        for {
6✔
2900
                select {
3✔
2901
                // A new pending channel has arrived which means we are about
2902
                // to complete a funding workflow and is waiting for the final
2903
                // `ChannelReady` messages to be exchanged. We will add this
2904
                // channel to the `activeChannels` with a nil value to indicate
2905
                // this is a pending channel.
2906
                case req := <-p.newPendingChannel:
3✔
2907
                        p.handleNewPendingChannel(req)
3✔
2908

2909
                // A new channel has arrived which means we've just completed a
2910
                // funding workflow. We'll initialize the necessary local
2911
                // state, and notify the htlc switch of a new link.
2912
                case req := <-p.newActiveChannel:
3✔
2913
                        p.handleNewActiveChannel(req)
3✔
2914

2915
                // The funding flow for a pending channel is failed, we will
2916
                // remove it from Brontide.
2917
                case req := <-p.removePendingChannel:
3✔
2918
                        p.handleRemovePendingChannel(req)
3✔
2919

2920
                // We've just received a local request to close an active
2921
                // channel. It will either kick of a cooperative channel
2922
                // closure negotiation, or be a notification of a breached
2923
                // contract that should be abandoned.
2924
                case req := <-p.localCloseChanReqs:
3✔
2925
                        p.handleLocalCloseReq(req)
3✔
2926

2927
                // We've received a link failure from a link that was added to
2928
                // the switch. This will initiate the teardown of the link, and
2929
                // initiate any on-chain closures if necessary.
2930
                case failure := <-p.linkFailures:
3✔
2931
                        p.handleLinkFailure(failure)
3✔
2932

2933
                // We've received a new cooperative channel closure related
2934
                // message from the remote peer, we'll use this message to
2935
                // advance the chan closer state machine.
2936
                case closeMsg := <-p.chanCloseMsgs:
3✔
2937
                        p.handleCloseMsg(closeMsg)
3✔
2938

2939
                // The channel reannounce delay has elapsed, broadcast the
2940
                // reenabled channel updates to the network. This should only
2941
                // fire once, so we set the reenableTimeout channel to nil to
2942
                // mark it for garbage collection. If the peer is torn down
2943
                // before firing, reenabling will not be attempted.
2944
                // TODO(conner): consolidate reenables timers inside chan status
2945
                // manager
2946
                case <-reenableTimeout:
3✔
2947
                        p.reenableActiveChannels()
3✔
2948

3✔
2949
                        // Since this channel will never fire again during the
3✔
2950
                        // lifecycle of the peer, we nil the channel to mark it
3✔
2951
                        // eligible for garbage collection, and make this
3✔
2952
                        // explicitly ineligible to receive in future calls to
3✔
2953
                        // select. This also shaves a few CPU cycles since the
3✔
2954
                        // select will ignore this case entirely.
3✔
2955
                        reenableTimeout = nil
3✔
2956

3✔
2957
                        // Once the reenabling is attempted, we also cancel the
3✔
2958
                        // channel event subscription to free up the overflow
3✔
2959
                        // queue used in channel notifier.
3✔
2960
                        //
3✔
2961
                        // NOTE: channelEventClient will be nil if the
3✔
2962
                        // reenableTimeout is greater than 1 minute.
3✔
2963
                        if p.channelEventClient != nil {
6✔
2964
                                p.channelEventClient.Cancel()
3✔
2965
                        }
3✔
2966

2967
                case <-p.cg.Done():
3✔
2968
                        // As, we've been signalled to exit, we'll reset all
3✔
2969
                        // our active channel back to their default state.
3✔
2970
                        p.activeChannels.ForEach(func(_ lnwire.ChannelID,
3✔
2971
                                lc *lnwallet.LightningChannel) error {
6✔
2972

3✔
2973
                                // Exit if the channel is nil as it's a pending
3✔
2974
                                // channel.
3✔
2975
                                if lc == nil {
6✔
2976
                                        return nil
3✔
2977
                                }
3✔
2978

2979
                                lc.ResetState()
3✔
2980

3✔
2981
                                return nil
3✔
2982
                        })
2983

2984
                        break out
3✔
2985
                }
2986
        }
2987
}
2988

2989
// reenableActiveChannels searches the index of channels maintained with this
2990
// peer, and reenables each public, non-pending channel. This is done at the
2991
// gossip level by broadcasting a new ChannelUpdate with the disabled bit unset.
2992
// No message will be sent if the channel is already enabled.
2993
func (p *Brontide) reenableActiveChannels() {
3✔
2994
        // First, filter all known channels with this peer for ones that are
3✔
2995
        // both public and not pending.
3✔
2996
        activePublicChans := p.filterChannelsToEnable()
3✔
2997

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

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

3✔
3007
                switch {
3✔
3008
                // No error occurred, continue to request the next channel.
3009
                case err == nil:
3✔
3010
                        continue
3✔
3011

3012
                // Cannot auto enable a manually disabled channel so we do
3013
                // nothing but proceed to the next channel.
3014
                case errors.Is(err, netann.ErrEnableManuallyDisabledChan):
3✔
3015
                        p.log.Debugf("Channel(%v) was manually disabled, "+
3✔
3016
                                "ignoring automatic enable request", chanPoint)
3✔
3017

3✔
3018
                        continue
3✔
3019

3020
                // If the channel is reported as inactive, we will give it
3021
                // another chance. When handling the request, ChanStatusManager
3022
                // will check whether the link is active or not. One of the
3023
                // conditions is whether the link has been marked as
3024
                // reestablished, which happens inside a goroutine(htlcManager)
3025
                // after the link is started. And we may get a false negative
3026
                // saying the link is not active because that goroutine hasn't
3027
                // reached the line to mark the reestablishment. Thus we give
3028
                // it a second chance to send the request.
3029
                case errors.Is(err, netann.ErrEnableInactiveChan):
×
3030
                        // If we don't have a client created, it means we
×
3031
                        // shouldn't retry enabling the channel.
×
3032
                        if p.channelEventClient == nil {
×
3033
                                p.log.Errorf("Channel(%v) request enabling "+
×
3034
                                        "failed due to inactive link",
×
3035
                                        chanPoint)
×
3036

×
3037
                                continue
×
3038
                        }
3039

3040
                        p.log.Warnf("Channel(%v) cannot be enabled as " +
×
3041
                                "ChanStatusManager reported inactive, retrying")
×
3042

×
3043
                        // Add the channel to the retry map.
×
3044
                        retryChans[chanPoint] = struct{}{}
×
3045
                }
3046
        }
3047

3048
        // Retry the channels if we have any.
3049
        if len(retryChans) != 0 {
3✔
3050
                p.retryRequestEnable(retryChans)
×
3051
        }
×
3052
}
3053

3054
// fetchActiveChanCloser attempts to fetch the active chan closer state machine
3055
// for the target channel ID. If the channel isn't active an error is returned.
3056
// Otherwise, either an existing state machine will be returned, or a new one
3057
// will be created.
3058
func (p *Brontide) fetchActiveChanCloser(chanID lnwire.ChannelID) (
3059
        *chanCloserFsm, error) {
3✔
3060

3✔
3061
        chanCloser, found := p.activeChanCloses.Load(chanID)
3✔
3062
        if found {
6✔
3063
                // An entry will only be found if the closer has already been
3✔
3064
                // created for a non-pending channel or for a channel that had
3✔
3065
                // previously started the shutdown process but the connection
3✔
3066
                // was restarted.
3✔
3067
                return &chanCloser, nil
3✔
3068
        }
3✔
3069

3070
        // First, we'll ensure that we actually know of the target channel. If
3071
        // not, we'll ignore this message.
3072
        channel, ok := p.activeChannels.Load(chanID)
3✔
3073

3✔
3074
        // If the channel isn't in the map or the channel is nil, return
3✔
3075
        // ErrChannelNotFound as the channel is pending.
3✔
3076
        if !ok || channel == nil {
6✔
3077
                return nil, ErrChannelNotFound
3✔
3078
        }
3✔
3079

3080
        // We'll create a valid closing state machine in order to respond to
3081
        // the initiated cooperative channel closure. First, we set the
3082
        // delivery script that our funds will be paid out to. If an upfront
3083
        // shutdown script was set, we will use it. Otherwise, we get a fresh
3084
        // delivery script.
3085
        //
3086
        // TODO: Expose option to allow upfront shutdown script from watch-only
3087
        // accounts.
3088
        deliveryScript := channel.LocalUpfrontShutdownScript()
3✔
3089
        if len(deliveryScript) == 0 {
6✔
3090
                var err error
3✔
3091
                deliveryScript, err = p.genDeliveryScript()
3✔
3092
                if err != nil {
3✔
3093
                        p.log.Errorf("unable to gen delivery script: %v",
×
3094
                                err)
×
3095
                        return nil, fmt.Errorf("close addr unavailable")
×
3096
                }
×
3097
        }
3098

3099
        // In order to begin fee negotiations, we'll first compute our target
3100
        // ideal fee-per-kw.
3101
        feePerKw, err := p.cfg.FeeEstimator.EstimateFeePerKW(
3✔
3102
                p.cfg.CoopCloseTargetConfs,
3✔
3103
        )
3✔
3104
        if err != nil {
3✔
3105
                p.log.Errorf("unable to query fee estimator: %v", err)
×
3106
                return nil, fmt.Errorf("unable to estimate fee")
×
3107
        }
×
3108

3109
        addr, err := p.addrWithInternalKey(deliveryScript)
3✔
3110
        if err != nil {
3✔
3111
                return nil, fmt.Errorf("unable to parse addr: %w", err)
×
3112
        }
×
3113
        negotiateChanCloser, err := p.createChanCloser(
3✔
3114
                channel, addr, feePerKw, nil, lntypes.Remote,
3✔
3115
        )
3✔
3116
        if err != nil {
3✔
3117
                p.log.Errorf("unable to create chan closer: %v", err)
×
3118
                return nil, fmt.Errorf("unable to create chan closer")
×
3119
        }
×
3120

3121
        chanCloser = makeNegotiateCloser(negotiateChanCloser)
3✔
3122

3✔
3123
        p.activeChanCloses.Store(chanID, chanCloser)
3✔
3124

3✔
3125
        return &chanCloser, nil
3✔
3126
}
3127

3128
// filterChannelsToEnable filters a list of channels to be enabled upon start.
3129
// The filtered channels are active channels that's neither private nor
3130
// pending.
3131
func (p *Brontide) filterChannelsToEnable() []wire.OutPoint {
3✔
3132
        var activePublicChans []wire.OutPoint
3✔
3133

3✔
3134
        p.activeChannels.Range(func(chanID lnwire.ChannelID,
3✔
3135
                lnChan *lnwallet.LightningChannel) bool {
6✔
3136

3✔
3137
                // If the lnChan is nil, continue as this is a pending channel.
3✔
3138
                if lnChan == nil {
5✔
3139
                        return true
2✔
3140
                }
2✔
3141

3142
                dbChan := lnChan.State()
3✔
3143
                isPublic := dbChan.ChannelFlags&lnwire.FFAnnounceChannel != 0
3✔
3144
                if !isPublic || dbChan.IsPending {
3✔
3145
                        return true
×
3146
                }
×
3147

3148
                // We'll also skip any channels added during this peer's
3149
                // lifecycle since they haven't waited out the timeout. Their
3150
                // first announcement will be enabled, and the chan status
3151
                // manager will begin monitoring them passively since they exist
3152
                // in the database.
3153
                if _, ok := p.addedChannels.Load(chanID); ok {
4✔
3154
                        return true
1✔
3155
                }
1✔
3156

3157
                activePublicChans = append(
3✔
3158
                        activePublicChans, dbChan.FundingOutpoint,
3✔
3159
                )
3✔
3160

3✔
3161
                return true
3✔
3162
        })
3163

3164
        return activePublicChans
3✔
3165
}
3166

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

×
3174
        // retryEnable is a helper closure that sends an enable request and
×
3175
        // removes the channel from the map if it's matched.
×
3176
        retryEnable := func(chanPoint wire.OutPoint) error {
×
3177
                // If this is an active channel event, check whether it's in
×
3178
                // our targeted channels map.
×
3179
                _, found := activeChans[chanPoint]
×
3180

×
3181
                // If this channel is irrelevant, return nil so the loop can
×
3182
                // jump to next iteration.
×
3183
                if !found {
×
3184
                        return nil
×
3185
                }
×
3186

3187
                // Otherwise we've just received an active signal for a channel
3188
                // that's previously failed to be enabled, we send the request
3189
                // again.
3190
                //
3191
                // We only give the channel one more shot, so we delete it from
3192
                // our map first to keep it from being attempted again.
3193
                delete(activeChans, chanPoint)
×
3194

×
3195
                // Send the request.
×
3196
                err := p.cfg.ChanStatusMgr.RequestEnable(chanPoint, false)
×
3197
                if err != nil {
×
3198
                        return fmt.Errorf("request enabling channel %v "+
×
3199
                                "failed: %w", chanPoint, err)
×
3200
                }
×
3201

3202
                return nil
×
3203
        }
3204

3205
        for {
×
3206
                // If activeChans is empty, we've done processing all the
×
3207
                // channels.
×
3208
                if len(activeChans) == 0 {
×
3209
                        p.log.Debug("Finished retry enabling channels")
×
3210
                        return
×
3211
                }
×
3212

3213
                select {
×
3214
                // A new event has been sent by the ChannelNotifier. We now
3215
                // check whether it's an active or inactive channel event.
3216
                case e := <-p.channelEventClient.Updates():
×
3217
                        // If this is an active channel event, try enable the
×
3218
                        // channel then jump to the next iteration.
×
3219
                        active, ok := e.(channelnotifier.ActiveChannelEvent)
×
3220
                        if ok {
×
3221
                                chanPoint := *active.ChannelPoint
×
3222

×
3223
                                // If we received an error for this particular
×
3224
                                // channel, we log an error and won't quit as
×
3225
                                // we still want to retry other channels.
×
3226
                                if err := retryEnable(chanPoint); err != nil {
×
3227
                                        p.log.Errorf("Retry failed: %v", err)
×
3228
                                }
×
3229

3230
                                continue
×
3231
                        }
3232

3233
                        // Otherwise check for inactive link event, and jump to
3234
                        // next iteration if it's not.
3235
                        inactive, ok := e.(channelnotifier.InactiveLinkEvent)
×
3236
                        if !ok {
×
3237
                                continue
×
3238
                        }
3239

3240
                        // Found an inactive link event, if this is our
3241
                        // targeted channel, remove it from our map.
3242
                        chanPoint := *inactive.ChannelPoint
×
3243
                        _, found := activeChans[chanPoint]
×
3244
                        if !found {
×
3245
                                continue
×
3246
                        }
3247

3248
                        delete(activeChans, chanPoint)
×
3249
                        p.log.Warnf("Re-enable channel %v failed, received "+
×
3250
                                "inactive link event", chanPoint)
×
3251

3252
                case <-p.cg.Done():
×
3253
                        p.log.Debugf("Peer shutdown during retry enabling")
×
3254
                        return
×
3255
                }
3256
        }
3257
}
3258

3259
// chooseDeliveryScript takes two optionally set shutdown scripts and returns
3260
// a suitable script to close out to. This may be nil if neither script is
3261
// set. If both scripts are set, this function will error if they do not match.
3262
func chooseDeliveryScript(upfront, requested lnwire.DeliveryAddress,
3263
        genDeliveryScript func() ([]byte, error),
3264
) (lnwire.DeliveryAddress, error) {
3✔
3265

3✔
3266
        switch {
3✔
3267
        // If no script was provided, then we'll generate a new delivery script.
3268
        case len(upfront) == 0 && len(requested) == 0:
3✔
3269
                return genDeliveryScript()
3✔
3270

3271
        // If no upfront shutdown script was provided, return the user
3272
        // requested address (which may be nil).
3273
        case len(upfront) == 0:
3✔
3274
                return requested, nil
3✔
3275

3276
        // If an upfront shutdown script was provided, and the user did not
3277
        // request a custom shutdown script, return the upfront address.
3278
        case len(requested) == 0:
3✔
3279
                return upfront, nil
3✔
3280

3281
        // If both an upfront shutdown script and a custom close script were
3282
        // provided, error if the user provided shutdown script does not match
3283
        // the upfront shutdown script (because closing out to a different
3284
        // script would violate upfront shutdown).
3285
        case !bytes.Equal(upfront, requested):
×
3286
                return nil, chancloser.ErrUpfrontShutdownScriptMismatch
×
3287

3288
        // The user requested script matches the upfront shutdown script, so we
3289
        // can return it without error.
3290
        default:
×
3291
                return upfront, nil
×
3292
        }
3293
}
3294

3295
// restartCoopClose checks whether we need to restart the cooperative close
3296
// process for a given channel.
3297
func (p *Brontide) restartCoopClose(lnChan *lnwallet.LightningChannel) (
3298
        *lnwire.Shutdown, error) {
3✔
3299

3✔
3300
        isTaprootChan := lnChan.ChanType().IsTaproot()
3✔
3301

3✔
3302
        // If this channel has status ChanStatusCoopBroadcasted and does not
3✔
3303
        // have a closing transaction, then the cooperative close process was
3✔
3304
        // started but never finished. We'll re-create the chanCloser state
3✔
3305
        // machine and resend Shutdown. BOLT#2 requires that we retransmit
3✔
3306
        // Shutdown exactly, but doing so would mean persisting the RPC
3✔
3307
        // provided close script. Instead use the LocalUpfrontShutdownScript
3✔
3308
        // or generate a script.
3✔
3309
        c := lnChan.State()
3✔
3310
        _, err := c.BroadcastedCooperative()
3✔
3311
        if err != nil && err != channeldb.ErrNoCloseTx {
3✔
3312
                // An error other than ErrNoCloseTx was encountered.
×
3313
                return nil, err
×
3314
        } else if err == nil && !p.rbfCoopCloseAllowed() {
3✔
3315
                // This is a channel that doesn't support RBF coop close, and it
×
3316
                // already had a coop close txn broadcast. As a result, we can
×
3317
                // just exit here as all we can do is wait for it to confirm.
×
3318
                return nil, nil
×
3319
        }
×
3320

3321
        chanID := lnwire.NewChanIDFromOutPoint(c.FundingOutpoint)
3✔
3322

3✔
3323
        var deliveryScript []byte
3✔
3324

3✔
3325
        shutdownInfo, err := c.ShutdownInfo()
3✔
3326
        switch {
3✔
3327
        // We have previously stored the delivery script that we need to use
3328
        // in the shutdown message. Re-use this script.
3329
        case err == nil:
3✔
3330
                shutdownInfo.WhenSome(func(info channeldb.ShutdownInfo) {
6✔
3331
                        deliveryScript = info.DeliveryScript.Val
3✔
3332
                })
3✔
3333

3334
        // An error other than ErrNoShutdownInfo was returned
3335
        case !errors.Is(err, channeldb.ErrNoShutdownInfo):
×
3336
                return nil, err
×
3337

3338
        case errors.Is(err, channeldb.ErrNoShutdownInfo):
×
3339
                deliveryScript = c.LocalShutdownScript
×
3340
                if len(deliveryScript) == 0 {
×
3341
                        var err error
×
3342
                        deliveryScript, err = p.genDeliveryScript()
×
3343
                        if err != nil {
×
3344
                                p.log.Errorf("unable to gen delivery script: "+
×
3345
                                        "%v", err)
×
3346

×
3347
                                return nil, fmt.Errorf("close addr unavailable")
×
3348
                        }
×
3349
                }
3350
        }
3351

3352
        // If the new RBF co-op close is negotiated, then we'll init and start
3353
        // that state machine, skipping the steps for the negotiate machine
3354
        // below. We don't support this close type for taproot channels though.
3355
        if p.rbfCoopCloseAllowed() && !isTaprootChan {
6✔
3356
                _, err := p.initRbfChanCloser(lnChan)
3✔
3357
                if err != nil {
3✔
3358
                        return nil, fmt.Errorf("unable to init rbf chan "+
×
3359
                                "closer during restart: %w", err)
×
3360
                }
×
3361

3362
                shutdownDesc := fn.MapOption(
3✔
3363
                        newRestartShutdownInit,
3✔
3364
                )(shutdownInfo)
3✔
3365

3✔
3366
                err = p.startRbfChanCloser(
3✔
3367
                        fn.FlattenOption(shutdownDesc), lnChan.ChannelPoint(),
3✔
3368
                )
3✔
3369

3✔
3370
                return nil, err
3✔
3371
        }
3372

3373
        // Compute an ideal fee.
3374
        feePerKw, err := p.cfg.FeeEstimator.EstimateFeePerKW(
×
3375
                p.cfg.CoopCloseTargetConfs,
×
3376
        )
×
3377
        if err != nil {
×
3378
                p.log.Errorf("unable to query fee estimator: %v", err)
×
3379
                return nil, fmt.Errorf("unable to estimate fee")
×
3380
        }
×
3381

3382
        // Determine whether we or the peer are the initiator of the coop
3383
        // close attempt by looking at the channel's status.
3384
        closingParty := lntypes.Remote
×
3385
        if c.HasChanStatus(channeldb.ChanStatusLocalCloseInitiator) {
×
3386
                closingParty = lntypes.Local
×
3387
        }
×
3388

3389
        addr, err := p.addrWithInternalKey(deliveryScript)
×
3390
        if err != nil {
×
3391
                return nil, fmt.Errorf("unable to parse addr: %w", err)
×
3392
        }
×
3393
        chanCloser, err := p.createChanCloser(
×
3394
                lnChan, addr, feePerKw, nil, closingParty,
×
3395
        )
×
3396
        if err != nil {
×
3397
                p.log.Errorf("unable to create chan closer: %v", err)
×
3398
                return nil, fmt.Errorf("unable to create chan closer")
×
3399
        }
×
3400

3401
        p.activeChanCloses.Store(chanID, makeNegotiateCloser(chanCloser))
×
3402

×
3403
        // Create the Shutdown message.
×
3404
        shutdownMsg, err := chanCloser.ShutdownChan()
×
3405
        if err != nil {
×
3406
                p.log.Errorf("unable to create shutdown message: %v", err)
×
3407
                p.activeChanCloses.Delete(chanID)
×
3408
                return nil, err
×
3409
        }
×
3410

3411
        return shutdownMsg, nil
×
3412
}
3413

3414
// createChanCloser constructs a ChanCloser from the passed parameters and is
3415
// used to de-duplicate code.
3416
func (p *Brontide) createChanCloser(channel *lnwallet.LightningChannel,
3417
        deliveryScript *chancloser.DeliveryAddrWithKey,
3418
        fee chainfee.SatPerKWeight, req *htlcswitch.ChanClose,
3419
        closer lntypes.ChannelParty) (*chancloser.ChanCloser, error) {
3✔
3420

3✔
3421
        _, startingHeight, err := p.cfg.ChainIO.GetBestBlock()
3✔
3422
        if err != nil {
3✔
3423
                p.log.Errorf("unable to obtain best block: %v", err)
×
3424
                return nil, fmt.Errorf("cannot obtain best block")
×
3425
        }
×
3426

3427
        // The req will only be set if we initiated the co-op closing flow.
3428
        var maxFee chainfee.SatPerKWeight
3✔
3429
        if req != nil {
6✔
3430
                maxFee = req.MaxFee
3✔
3431
        }
3✔
3432

3433
        chanCloser := chancloser.NewChanCloser(
3✔
3434
                chancloser.ChanCloseCfg{
3✔
3435
                        Channel:      channel,
3✔
3436
                        MusigSession: NewMusigChanCloser(channel),
3✔
3437
                        FeeEstimator: &chancloser.SimpleCoopFeeEstimator{},
3✔
3438
                        BroadcastTx:  p.cfg.Wallet.PublishTransaction,
3✔
3439
                        AuxCloser:    p.cfg.AuxChanCloser,
3✔
3440
                        DisableChannel: func(op wire.OutPoint) error {
6✔
3441
                                return p.cfg.ChanStatusMgr.RequestDisable(
3✔
3442
                                        op, false,
3✔
3443
                                )
3✔
3444
                        },
3✔
3445
                        MaxFee: maxFee,
3446
                        Disconnect: func() error {
×
3447
                                return p.cfg.DisconnectPeer(p.IdentityKey())
×
3448
                        },
×
3449
                        ChainParams: &p.cfg.Wallet.Cfg.NetParams,
3450
                },
3451
                *deliveryScript,
3452
                fee,
3453
                uint32(startingHeight),
3454
                req,
3455
                closer,
3456
        )
3457

3458
        return chanCloser, nil
3✔
3459
}
3460

3461
// initNegotiateChanCloser initializes the channel closer for a channel that is
3462
// using the original "negotiation" based protocol. This path is used when
3463
// we're the one initiating the channel close.
3464
//
3465
// TODO(roasbeef): can make a MsgEndpoint for existing handling logic to
3466
// further abstract.
3467
func (p *Brontide) initNegotiateChanCloser(req *htlcswitch.ChanClose,
3468
        channel *lnwallet.LightningChannel) error {
3✔
3469

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

3✔
3473
        // An upfront shutdown and user provided script are both optional, but
3✔
3474
        // must be equal if both set  (because we cannot serve a request to
3✔
3475
        // close out to a script which violates upfront shutdown). Get the
3✔
3476
        // appropriate address to close out to (which may be nil if neither are
3✔
3477
        // set) and error if they are both set and do not match.
3✔
3478
        deliveryScript, err := chooseDeliveryScript(
3✔
3479
                channel.LocalUpfrontShutdownScript(), req.DeliveryScript,
3✔
3480
                p.genDeliveryScript,
3✔
3481
        )
3✔
3482
        if err != nil {
3✔
3483
                return fmt.Errorf("cannot close channel %v: %w",
×
3484
                        req.ChanPoint, err)
×
3485
        }
×
3486

3487
        addr, err := p.addrWithInternalKey(deliveryScript)
3✔
3488
        if err != nil {
3✔
3489
                return fmt.Errorf("unable to parse addr for channel "+
×
3490
                        "%v: %w", req.ChanPoint, err)
×
3491
        }
×
3492

3493
        chanCloser, err := p.createChanCloser(
3✔
3494
                channel, addr, req.TargetFeePerKw, req, lntypes.Local,
3✔
3495
        )
3✔
3496
        if err != nil {
3✔
3497
                return fmt.Errorf("unable to make chan closer: %w", err)
×
3498
        }
×
3499

3500
        chanID := lnwire.NewChanIDFromOutPoint(channel.ChannelPoint())
3✔
3501
        p.activeChanCloses.Store(chanID, makeNegotiateCloser(chanCloser))
3✔
3502

3✔
3503
        // Finally, we'll initiate the channel shutdown within the
3✔
3504
        // chanCloser, and send the shutdown message to the remote
3✔
3505
        // party to kick things off.
3✔
3506
        shutdownMsg, err := chanCloser.ShutdownChan()
3✔
3507
        if err != nil {
3✔
3508
                // As we were unable to shutdown the channel, we'll return it
×
3509
                // back to its normal state.
×
3510
                defer channel.ResetState()
×
3511

×
3512
                p.activeChanCloses.Delete(chanID)
×
3513

×
3514
                return fmt.Errorf("unable to shutdown channel: %w", err)
×
3515
        }
×
3516

3517
        link := p.fetchLinkFromKeyAndCid(chanID)
3✔
3518
        if link == nil {
3✔
3519
                // If the link is nil then it means it was already removed from
×
3520
                // the switch or it never existed in the first place. The
×
3521
                // latter case is handled at the beginning of this function, so
×
3522
                // in the case where it has already been removed, we can skip
×
3523
                // adding the commit hook to queue a Shutdown message.
×
3524
                p.log.Warnf("link not found during attempted closure: "+
×
3525
                        "%v", chanID)
×
3526
                return nil
×
3527
        }
×
3528

3529
        if !link.DisableAdds(htlcswitch.Outgoing) {
3✔
3530
                p.log.Warnf("Outgoing link adds already "+
×
3531
                        "disabled: %v", link.ChanID())
×
3532
        }
×
3533

3534
        link.OnCommitOnce(htlcswitch.Outgoing, func() {
6✔
3535
                p.queueMsg(shutdownMsg, nil)
3✔
3536
        })
3✔
3537

3538
        return nil
3✔
3539
}
3540

3541
// chooseAddr returns the provided address if it is non-zero length, otherwise
3542
// None.
3543
func chooseAddr(addr lnwire.DeliveryAddress) fn.Option[lnwire.DeliveryAddress] {
3✔
3544
        if len(addr) == 0 {
6✔
3545
                return fn.None[lnwire.DeliveryAddress]()
3✔
3546
        }
3✔
3547

3548
        return fn.Some(addr)
×
3549
}
3550

3551
// observeRbfCloseUpdates observes the channel for any updates that may
3552
// indicate that a new txid has been broadcasted, or the channel fully closed
3553
// on chain.
3554
func (p *Brontide) observeRbfCloseUpdates(chanCloser *chancloser.RbfChanCloser,
3555
        closeReq *htlcswitch.ChanClose,
3556
        coopCloseStates chancloser.RbfStateSub) {
3✔
3557

3✔
3558
        newStateChan := coopCloseStates.NewItemCreated.ChanOut()
3✔
3559
        defer chanCloser.RemoveStateSub(coopCloseStates)
3✔
3560

3✔
3561
        var (
3✔
3562
                lastTxids    lntypes.Dual[chainhash.Hash]
3✔
3563
                lastFeeRates lntypes.Dual[chainfee.SatPerVByte]
3✔
3564
        )
3✔
3565

3✔
3566
        maybeNotifyTxBroadcast := func(state chancloser.AsymmetricPeerState,
3✔
3567
                party lntypes.ChannelParty) {
6✔
3568

3✔
3569
                // First, check to see if we have an error to report to the
3✔
3570
                // caller. If so, then we''ll return that error and exit, as the
3✔
3571
                // stream will exit as well.
3✔
3572
                if closeErr, ok := state.(*chancloser.CloseErr); ok {
6✔
3573
                        // We hit an error during the last state transition, so
3✔
3574
                        // we'll extract the error then send it to the
3✔
3575
                        // user.
3✔
3576
                        err := closeErr.Err()
3✔
3577

3✔
3578
                        peerLog.Warnf("ChannelPoint(%v): encountered close "+
3✔
3579
                                "err: %v", closeReq.ChanPoint, err)
3✔
3580

3✔
3581
                        select {
3✔
3582
                        case closeReq.Err <- err:
3✔
3583
                        case <-closeReq.Ctx.Done():
×
3584
                        case <-p.cg.Done():
×
3585
                        }
3586

3587
                        return
3✔
3588
                }
3589

3590
                closePending, ok := state.(*chancloser.ClosePending)
3✔
3591

3✔
3592
                // If this isn't the close pending state, we aren't at the
3✔
3593
                // terminal state yet.
3✔
3594
                if !ok {
6✔
3595
                        return
3✔
3596
                }
3✔
3597

3598
                // Only notify if the fee rate is greater.
3599
                newFeeRate := closePending.FeeRate
3✔
3600
                lastFeeRate := lastFeeRates.GetForParty(party)
3✔
3601
                if newFeeRate <= lastFeeRate {
6✔
3602
                        peerLog.Debugf("ChannelPoint(%v): remote party made "+
3✔
3603
                                "update for fee rate %v, but we already have "+
3✔
3604
                                "a higher fee rate of %v", closeReq.ChanPoint,
3✔
3605
                                newFeeRate, lastFeeRate)
3✔
3606

3✔
3607
                        return
3✔
3608
                }
3✔
3609

3610
                feeRate := closePending.FeeRate
3✔
3611
                lastFeeRates.SetForParty(party, feeRate)
3✔
3612

3✔
3613
                // At this point, we'll have a txid that we can use to notify
3✔
3614
                // the client, but only if it's different from the last one we
3✔
3615
                // sent. If the user attempted to bump, but was rejected due to
3✔
3616
                // RBF, then we'll send a redundant update.
3✔
3617
                closingTxid := closePending.CloseTx.TxHash()
3✔
3618
                lastTxid := lastTxids.GetForParty(party)
3✔
3619
                if closeReq != nil && closingTxid != lastTxid {
6✔
3620
                        select {
3✔
3621
                        case closeReq.Updates <- &PendingUpdate{
3622
                                Txid:        closingTxid[:],
3623
                                FeePerVbyte: fn.Some(closePending.FeeRate),
3624
                                IsLocalCloseTx: fn.Some(
3625
                                        party == lntypes.Local,
3626
                                ),
3627
                        }:
3✔
3628

3629
                        case <-closeReq.Ctx.Done():
×
3630
                                return
×
3631

3632
                        case <-p.cg.Done():
×
3633
                                return
×
3634
                        }
3635
                }
3636

3637
                lastTxids.SetForParty(party, closingTxid)
3✔
3638
        }
3639

3640
        peerLog.Infof("Observing RBF close updates for channel %v",
3✔
3641
                closeReq.ChanPoint)
3✔
3642

3✔
3643
        // We'll consume each new incoming state to send out the appropriate
3✔
3644
        // RPC update.
3✔
3645
        for {
6✔
3646
                select {
3✔
3647
                case newState := <-newStateChan:
3✔
3648

3✔
3649
                        switch closeState := newState.(type) {
3✔
3650
                        // Once we've reached the state of pending close, we
3651
                        // have a txid that we broadcasted.
3652
                        case *chancloser.ClosingNegotiation:
3✔
3653
                                peerState := closeState.PeerState
3✔
3654

3✔
3655
                                // Each side may have gained a new co-op close
3✔
3656
                                // tx, so we'll examine both to see if they've
3✔
3657
                                // changed.
3✔
3658
                                maybeNotifyTxBroadcast(
3✔
3659
                                        peerState.GetForParty(lntypes.Local),
3✔
3660
                                        lntypes.Local,
3✔
3661
                                )
3✔
3662
                                maybeNotifyTxBroadcast(
3✔
3663
                                        peerState.GetForParty(lntypes.Remote),
3✔
3664
                                        lntypes.Remote,
3✔
3665
                                )
3✔
3666

3667
                        // Otherwise, if we're transition to CloseFin, then we
3668
                        // know that we're done.
3669
                        case *chancloser.CloseFin:
3✔
3670
                                // To clean up, we'll remove the chan closer
3✔
3671
                                // from the active map, and send the final
3✔
3672
                                // update to the client.
3✔
3673
                                closingTxid := closeState.ConfirmedTx.TxHash()
3✔
3674
                                if closeReq != nil {
6✔
3675
                                        closeReq.Updates <- &ChannelCloseUpdate{
3✔
3676
                                                ClosingTxid: closingTxid[:],
3✔
3677
                                                Success:     true,
3✔
3678
                                        }
3✔
3679
                                }
3✔
3680
                                chanID := lnwire.NewChanIDFromOutPoint(
3✔
3681
                                        *closeReq.ChanPoint,
3✔
3682
                                )
3✔
3683
                                p.activeChanCloses.Delete(chanID)
3✔
3684

3✔
3685
                                return
3✔
3686
                        }
3687

3688
                case <-closeReq.Ctx.Done():
3✔
3689
                        return
3✔
3690

3691
                case <-p.cg.Done():
3✔
3692
                        return
3✔
3693
                }
3694
        }
3695
}
3696

3697
// chanErrorReporter is a simple implementation of the
3698
// chancloser.ErrorReporter. This is bound to a single channel by the channel
3699
// ID.
3700
type chanErrorReporter struct {
3701
        chanID lnwire.ChannelID
3702
        peer   *Brontide
3703
}
3704

3705
// newChanErrorReporter creates a new instance of the chanErrorReporter.
3706
func newChanErrorReporter(chanID lnwire.ChannelID,
3707
        peer *Brontide) *chanErrorReporter {
3✔
3708

3✔
3709
        return &chanErrorReporter{
3✔
3710
                chanID: chanID,
3✔
3711
                peer:   peer,
3✔
3712
        }
3✔
3713
}
3✔
3714

3715
// ReportError is a method that's used to report an error that occurred during
3716
// state machine execution. This is used by the RBF close state machine to
3717
// terminate the state machine and send an error to the remote peer.
3718
//
3719
// This is a part of the chancloser.ErrorReporter interface.
3720
func (c *chanErrorReporter) ReportError(chanErr error) {
×
3721
        c.peer.log.Errorf("coop close error for channel %v: %v",
×
3722
                c.chanID, chanErr)
×
3723

×
3724
        var errMsg []byte
×
3725
        if errors.Is(chanErr, chancloser.ErrInvalidStateTransition) {
×
3726
                errMsg = []byte("unexpected protocol message")
×
3727
        } else {
×
3728
                errMsg = []byte(chanErr.Error())
×
3729
        }
×
3730

3731
        err := c.peer.SendMessageLazy(false, &lnwire.Error{
×
3732
                ChanID: c.chanID,
×
3733
                Data:   errMsg,
×
3734
        })
×
3735
        if err != nil {
×
3736
                c.peer.log.Warnf("unable to send error message to peer: %v",
×
3737
                        err)
×
3738
        }
×
3739

3740
        // After we send the error message to the peer, we'll re-initialize the
3741
        // coop close state machine as they may send a shutdown message to
3742
        // retry the coop close.
3743
        lnChan, ok := c.peer.activeChannels.Load(c.chanID)
×
3744
        if !ok {
×
3745
                return
×
3746
        }
×
3747

3748
        if lnChan == nil {
×
3749
                c.peer.log.Debugf("channel %v is pending, not "+
×
3750
                        "re-initializing coop close state machine",
×
3751
                        c.chanID)
×
3752

×
3753
                return
×
3754
        }
×
3755

3756
        if _, err := c.peer.initRbfChanCloser(lnChan); err != nil {
×
3757
                c.peer.activeChanCloses.Delete(c.chanID)
×
3758

×
3759
                c.peer.log.Errorf("unable to init RBF chan closer after "+
×
3760
                        "error case: %v", err)
×
3761
        }
×
3762
}
3763

3764
// chanFlushEventSentinel is used to send the RBF coop close state machine the
3765
// channel flushed event. We'll wait until the state machine enters the
3766
// ChannelFlushing state, then request the link to send the event once flushed.
3767
//
3768
// NOTE: This MUST be run as a goroutine.
3769
func (p *Brontide) chanFlushEventSentinel(chanCloser *chancloser.RbfChanCloser,
3770
        link htlcswitch.ChannelUpdateHandler,
3771
        channel *lnwallet.LightningChannel) {
3✔
3772

3✔
3773
        defer p.cg.WgDone()
3✔
3774

3✔
3775
        // If there's no link, then the channel has already been flushed, so we
3✔
3776
        // don't need to continue.
3✔
3777
        if link == nil {
6✔
3778
                return
3✔
3779
        }
3✔
3780

3781
        coopCloseStates := chanCloser.RegisterStateEvents()
3✔
3782
        defer chanCloser.RemoveStateSub(coopCloseStates)
3✔
3783

3✔
3784
        newStateChan := coopCloseStates.NewItemCreated.ChanOut()
3✔
3785

3✔
3786
        sendChanFlushed := func() {
6✔
3787
                chanState := channel.StateSnapshot()
3✔
3788

3✔
3789
                peerLog.Infof("ChannelPoint(%v) has been flushed for co-op "+
3✔
3790
                        "close, sending event to chan closer",
3✔
3791
                        channel.ChannelPoint())
3✔
3792

3✔
3793
                chanBalances := chancloser.ShutdownBalances{
3✔
3794
                        LocalBalance:  chanState.LocalBalance,
3✔
3795
                        RemoteBalance: chanState.RemoteBalance,
3✔
3796
                }
3✔
3797
                ctx := context.Background()
3✔
3798
                chanCloser.SendEvent(ctx, &chancloser.ChannelFlushed{
3✔
3799
                        ShutdownBalances: chanBalances,
3✔
3800
                        FreshFlush:       true,
3✔
3801
                })
3✔
3802
        }
3✔
3803

3804
        // We'll wait until the channel enters the ChannelFlushing state. We
3805
        // exit after a success loop. As after the first RBF iteration, the
3806
        // channel will always be flushed.
3807
        for newState := range newStateChan {
6✔
3808
                if _, ok := newState.(*chancloser.ChannelFlushing); ok {
6✔
3809
                        peerLog.Infof("ChannelPoint(%v): rbf coop "+
3✔
3810
                                "close is awaiting a flushed state, "+
3✔
3811
                                "registering with link..., ",
3✔
3812
                                channel.ChannelPoint())
3✔
3813

3✔
3814
                        // Request the link to send the event once the channel
3✔
3815
                        // is flushed. We only need this event sent once, so we
3✔
3816
                        // can exit now.
3✔
3817
                        link.OnFlushedOnce(sendChanFlushed)
3✔
3818

3✔
3819
                        return
3✔
3820
                }
3✔
3821
        }
3822
}
3823

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

3✔
3830
        chanID := lnwire.NewChanIDFromOutPoint(channel.ChannelPoint())
3✔
3831

3✔
3832
        link := p.fetchLinkFromKeyAndCid(chanID)
3✔
3833

3✔
3834
        _, startingHeight, err := p.cfg.ChainIO.GetBestBlock()
3✔
3835
        if err != nil {
3✔
3836
                return nil, fmt.Errorf("cannot obtain best block: %w", err)
×
3837
        }
×
3838

3839
        defaultFeePerKw, err := p.cfg.FeeEstimator.EstimateFeePerKW(
3✔
3840
                p.cfg.CoopCloseTargetConfs,
3✔
3841
        )
3✔
3842
        if err != nil {
3✔
3843
                return nil, fmt.Errorf("unable to estimate fee: %w", err)
×
3844
        }
×
3845

3846
        thawHeight, err := channel.AbsoluteThawHeight()
3✔
3847
        if err != nil {
3✔
3848
                return nil, fmt.Errorf("unable to get thaw height: %w", err)
×
3849
        }
×
3850

3851
        peerPub := *p.IdentityKey()
3✔
3852

3✔
3853
        msgMapper := chancloser.NewRbfMsgMapper(
3✔
3854
                uint32(startingHeight), chanID, peerPub,
3✔
3855
        )
3✔
3856

3✔
3857
        initialState := chancloser.ChannelActive{}
3✔
3858

3✔
3859
        scid := channel.ZeroConfRealScid().UnwrapOr(
3✔
3860
                channel.ShortChanID(),
3✔
3861
        )
3✔
3862

3✔
3863
        env := chancloser.Environment{
3✔
3864
                ChainParams:    p.cfg.Wallet.Cfg.NetParams,
3✔
3865
                ChanPeer:       peerPub,
3✔
3866
                ChanPoint:      channel.ChannelPoint(),
3✔
3867
                ChanID:         chanID,
3✔
3868
                Scid:           scid,
3✔
3869
                ChanType:       channel.ChanType(),
3✔
3870
                DefaultFeeRate: defaultFeePerKw.FeePerVByte(),
3✔
3871
                ThawHeight:     fn.Some(thawHeight),
3✔
3872
                RemoteUpfrontShutdown: chooseAddr(
3✔
3873
                        channel.RemoteUpfrontShutdownScript(),
3✔
3874
                ),
3✔
3875
                LocalUpfrontShutdown: chooseAddr(
3✔
3876
                        channel.LocalUpfrontShutdownScript(),
3✔
3877
                ),
3✔
3878
                NewDeliveryScript: func() (lnwire.DeliveryAddress, error) {
6✔
3879
                        return p.genDeliveryScript()
3✔
3880
                },
3✔
3881
                FeeEstimator: &chancloser.SimpleCoopFeeEstimator{},
3882
                CloseSigner:  channel,
3883
                ChanObserver: newChanObserver(
3884
                        channel, link, p.cfg.ChanStatusMgr,
3885
                ),
3886
        }
3887

3888
        spendEvent := protofsm.RegisterSpend[chancloser.ProtocolEvent]{
3✔
3889
                OutPoint:   channel.ChannelPoint(),
3✔
3890
                PkScript:   channel.FundingTxOut().PkScript,
3✔
3891
                HeightHint: channel.DeriveHeightHint(),
3✔
3892
                PostSpendEvent: fn.Some[chancloser.RbfSpendMapper](
3✔
3893
                        chancloser.SpendMapper,
3✔
3894
                ),
3✔
3895
        }
3✔
3896

3✔
3897
        daemonAdapters := NewLndDaemonAdapters(LndAdapterCfg{
3✔
3898
                MsgSender:     newPeerMsgSender(peerPub, p),
3✔
3899
                TxBroadcaster: p.cfg.Wallet,
3✔
3900
                ChainNotifier: p.cfg.ChainNotifier,
3✔
3901
        })
3✔
3902

3✔
3903
        protoCfg := chancloser.RbfChanCloserCfg{
3✔
3904
                Daemon:        daemonAdapters,
3✔
3905
                InitialState:  &initialState,
3✔
3906
                Env:           &env,
3✔
3907
                InitEvent:     fn.Some[protofsm.DaemonEvent](&spendEvent),
3✔
3908
                ErrorReporter: newChanErrorReporter(chanID, p),
3✔
3909
                MsgMapper: fn.Some[protofsm.MsgMapper[chancloser.ProtocolEvent]]( //nolint:ll
3✔
3910
                        msgMapper,
3✔
3911
                ),
3✔
3912
        }
3✔
3913

3✔
3914
        ctx := context.Background()
3✔
3915
        chanCloser := protofsm.NewStateMachine(protoCfg)
3✔
3916
        chanCloser.Start(ctx)
3✔
3917

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

3✔
3923
                return r.RegisterEndpoint(&chanCloser)
3✔
3924
        })
3✔
3925
        if err != nil {
3✔
3926
                chanCloser.Stop()
×
3927

×
3928
                return nil, fmt.Errorf("unable to register endpoint for co-op "+
×
3929
                        "close: %w", err)
×
3930
        }
×
3931

3932
        p.activeChanCloses.Store(chanID, makeRbfCloser(&chanCloser))
3✔
3933

3✔
3934
        // Now that we've created the rbf closer state machine, we'll launch a
3✔
3935
        // new goroutine to eventually send in the ChannelFlushed event once
3✔
3936
        // needed.
3✔
3937
        p.cg.WgAdd(1)
3✔
3938
        go p.chanFlushEventSentinel(&chanCloser, link, channel)
3✔
3939

3✔
3940
        return &chanCloser, nil
3✔
3941
}
3942

3943
// shutdownInit describes the two ways we can initiate a new shutdown. Either we
3944
// got an RPC request to do so (left), or we sent a shutdown message to the
3945
// party (for w/e reason), but crashed before the close was complete.
3946
//
3947
//nolint:ll
3948
type shutdownInit = fn.Option[fn.Either[*htlcswitch.ChanClose, channeldb.ShutdownInfo]]
3949

3950
// shutdownStartFeeRate returns the fee rate that should be used for the
3951
// shutdown.  This returns a doubly wrapped option as the shutdown info might
3952
// be none, and the fee rate is only defined for the user initiated shutdown.
3953
func shutdownStartFeeRate(s shutdownInit) fn.Option[chainfee.SatPerKWeight] {
3✔
3954
        feeRateOpt := fn.MapOption(func(init fn.Either[*htlcswitch.ChanClose,
3✔
3955
                channeldb.ShutdownInfo]) fn.Option[chainfee.SatPerKWeight] {
6✔
3956

3✔
3957
                var feeRate fn.Option[chainfee.SatPerKWeight]
3✔
3958
                init.WhenLeft(func(req *htlcswitch.ChanClose) {
6✔
3959
                        feeRate = fn.Some(req.TargetFeePerKw)
3✔
3960
                })
3✔
3961

3962
                return feeRate
3✔
3963
        })(s)
3964

3965
        return fn.FlattenOption(feeRateOpt)
3✔
3966
}
3967

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

3✔
3975
                var addr fn.Option[lnwire.DeliveryAddress]
3✔
3976
                init.WhenLeft(func(req *htlcswitch.ChanClose) {
6✔
3977
                        if len(req.DeliveryScript) != 0 {
6✔
3978
                                addr = fn.Some(req.DeliveryScript)
3✔
3979
                        }
3✔
3980
                })
3981
                init.WhenRight(func(info channeldb.ShutdownInfo) {
6✔
3982
                        addr = fn.Some(info.DeliveryScript.Val)
3✔
3983
                })
3✔
3984

3985
                return addr
3✔
3986
        })(s)
3987

3988
        return fn.FlattenOption(addrOpt)
3✔
3989
}
3990

3991
// whenRPCShutdown registers a callback to be executed when the shutdown init
3992
// type is and RPC request.
3993
func whenRPCShutdown(s shutdownInit, f func(r *htlcswitch.ChanClose)) {
3✔
3994
        s.WhenSome(func(init fn.Either[*htlcswitch.ChanClose,
3✔
3995
                channeldb.ShutdownInfo]) {
6✔
3996

3✔
3997
                init.WhenLeft(f)
3✔
3998
        })
3✔
3999
}
4000

4001
// newRestartShutdownInit creates a new shutdownInit for the case where we need
4002
// to restart the shutdown flow after a restart.
4003
func newRestartShutdownInit(info channeldb.ShutdownInfo) shutdownInit {
3✔
4004
        return fn.Some(fn.NewRight[*htlcswitch.ChanClose](info))
3✔
4005
}
3✔
4006

4007
// newRPCShutdownInit creates a new shutdownInit for the case where we
4008
// initiated the shutdown via an RPC client.
4009
func newRPCShutdownInit(req *htlcswitch.ChanClose) shutdownInit {
3✔
4010
        return fn.Some(
3✔
4011
                fn.NewLeft[*htlcswitch.ChanClose, channeldb.ShutdownInfo](req),
3✔
4012
        )
3✔
4013
}
3✔
4014

4015
// waitUntilRbfCoastClear waits until the RBF co-op close state machine has
4016
// advanced to a terminal state before attempting another fee bump.
4017
func waitUntilRbfCoastClear(ctx context.Context,
4018
        rbfCloser *chancloser.RbfChanCloser) error {
3✔
4019

3✔
4020
        coopCloseStates := rbfCloser.RegisterStateEvents()
3✔
4021
        newStateChan := coopCloseStates.NewItemCreated.ChanOut()
3✔
4022
        defer rbfCloser.RemoveStateSub(coopCloseStates)
3✔
4023

3✔
4024
        isTerminalState := func(newState chancloser.RbfState) bool {
6✔
4025
                // If we're not in the negotiation sub-state, then we aren't at
3✔
4026
                // the terminal state yet.
3✔
4027
                state, ok := newState.(*chancloser.ClosingNegotiation)
3✔
4028
                if !ok {
3✔
4029
                        return false
×
4030
                }
×
4031

4032
                localState := state.PeerState.GetForParty(lntypes.Local)
3✔
4033

3✔
4034
                // If this isn't the close pending state, we aren't at the
3✔
4035
                // terminal state yet.
3✔
4036
                _, ok = localState.(*chancloser.ClosePending)
3✔
4037

3✔
4038
                return ok
3✔
4039
        }
4040

4041
        // Before we enter the subscription loop below, check to see if we're
4042
        // already in the terminal state.
4043
        rbfState, err := rbfCloser.CurrentState()
3✔
4044
        if err != nil {
3✔
4045
                return err
×
4046
        }
×
4047
        if isTerminalState(rbfState) {
6✔
4048
                return nil
3✔
4049
        }
3✔
4050

4051
        peerLog.Debugf("Waiting for RBF iteration to complete...")
×
4052

×
4053
        for {
×
4054
                select {
×
4055
                case newState := <-newStateChan:
×
4056
                        if isTerminalState(newState) {
×
4057
                                return nil
×
4058
                        }
×
4059

4060
                case <-ctx.Done():
×
4061
                        return fmt.Errorf("context canceled")
×
4062
                }
4063
        }
4064
}
4065

4066
// startRbfChanCloser kicks off the co-op close process using the new RBF based
4067
// co-op close protocol. This is called when we're the one that's initiating
4068
// the cooperative channel close.
4069
//
4070
// TODO(roasbeef): just accept the two shutdown pointer params instead??
4071
func (p *Brontide) startRbfChanCloser(shutdown shutdownInit,
4072
        chanPoint wire.OutPoint) error {
3✔
4073

3✔
4074
        // Unlike the old negotiate chan closer, we'll always create the RBF
3✔
4075
        // chan closer on startup, so we can skip init here.
3✔
4076
        chanID := lnwire.NewChanIDFromOutPoint(chanPoint)
3✔
4077
        chanCloser, found := p.activeChanCloses.Load(chanID)
3✔
4078
        if !found {
3✔
4079
                return fmt.Errorf("rbf chan closer not found for channel %v",
×
4080
                        chanPoint)
×
4081
        }
×
4082

4083
        defaultFeePerKw, err := shutdownStartFeeRate(
3✔
4084
                shutdown,
3✔
4085
        ).UnwrapOrFuncErr(func() (chainfee.SatPerKWeight, error) {
6✔
4086
                return p.cfg.FeeEstimator.EstimateFeePerKW(
3✔
4087
                        p.cfg.CoopCloseTargetConfs,
3✔
4088
                )
3✔
4089
        })
3✔
4090
        if err != nil {
3✔
4091
                return fmt.Errorf("unable to estimate fee: %w", err)
×
4092
        }
×
4093

4094
        chanCloser.WhenRight(func(rbfCloser *chancloser.RbfChanCloser) {
6✔
4095
                peerLog.Infof("ChannelPoint(%v): rbf-coop close requested, "+
3✔
4096
                        "sending shutdown", chanPoint)
3✔
4097

3✔
4098
                rbfState, err := rbfCloser.CurrentState()
3✔
4099
                if err != nil {
3✔
4100
                        peerLog.Warnf("ChannelPoint(%v): unable to get "+
×
4101
                                "current state for rbf-coop close: %v",
×
4102
                                chanPoint, err)
×
4103

×
4104
                        return
×
4105
                }
×
4106

4107
                coopCloseStates := rbfCloser.RegisterStateEvents()
3✔
4108

3✔
4109
                // Before we send our event below, we'll launch a goroutine to
3✔
4110
                // watch for the final terminal state to send updates to the RPC
3✔
4111
                // client. We only need to do this if there's an RPC caller.
3✔
4112
                var rpcShutdown bool
3✔
4113
                whenRPCShutdown(shutdown, func(req *htlcswitch.ChanClose) {
6✔
4114
                        rpcShutdown = true
3✔
4115

3✔
4116
                        p.cg.WgAdd(1)
3✔
4117
                        go func() {
6✔
4118
                                defer p.cg.WgDone()
3✔
4119

3✔
4120
                                p.observeRbfCloseUpdates(
3✔
4121
                                        rbfCloser, req, coopCloseStates,
3✔
4122
                                )
3✔
4123
                        }()
3✔
4124
                })
4125

4126
                if !rpcShutdown {
6✔
4127
                        defer rbfCloser.RemoveStateSub(coopCloseStates)
3✔
4128
                }
3✔
4129

4130
                ctx, _ := p.cg.Create(context.Background())
3✔
4131
                feeRate := defaultFeePerKw.FeePerVByte()
3✔
4132

3✔
4133
                // Depending on the state of the state machine, we'll either
3✔
4134
                // kick things off by sending shutdown, or attempt to send a new
3✔
4135
                // offer to the remote party.
3✔
4136
                switch rbfState.(type) {
3✔
4137
                // The channel is still active, so we'll now kick off the co-op
4138
                // close process by instructing it to send a shutdown message to
4139
                // the remote party.
4140
                case *chancloser.ChannelActive:
3✔
4141
                        rbfCloser.SendEvent(
3✔
4142
                                context.Background(),
3✔
4143
                                &chancloser.SendShutdown{
3✔
4144
                                        IdealFeeRate: feeRate,
3✔
4145
                                        DeliveryAddr: shutdownStartAddr(
3✔
4146
                                                shutdown,
3✔
4147
                                        ),
3✔
4148
                                },
3✔
4149
                        )
3✔
4150

4151
                // If we haven't yet sent an offer (didn't have enough funds at
4152
                // the prior fee rate), or we've sent an offer, then we'll
4153
                // trigger a new offer event.
4154
                case *chancloser.ClosingNegotiation:
3✔
4155
                        // Before we send the event below, we'll wait until
3✔
4156
                        // we're in a semi-terminal state.
3✔
4157
                        err := waitUntilRbfCoastClear(ctx, rbfCloser)
3✔
4158
                        if err != nil {
3✔
4159
                                peerLog.Warnf("ChannelPoint(%v): unable to "+
×
4160
                                        "wait for coast to clear: %v",
×
4161
                                        chanPoint, err)
×
4162

×
4163
                                return
×
4164
                        }
×
4165

4166
                        event := chancloser.ProtocolEvent(
3✔
4167
                                &chancloser.SendOfferEvent{
3✔
4168
                                        TargetFeeRate: feeRate,
3✔
4169
                                },
3✔
4170
                        )
3✔
4171
                        rbfCloser.SendEvent(ctx, event)
3✔
4172

4173
                default:
×
4174
                        peerLog.Warnf("ChannelPoint(%v): unexpected state "+
×
4175
                                "for rbf-coop close: %T", chanPoint, rbfState)
×
4176
                }
4177
        })
4178

4179
        return nil
3✔
4180
}
4181

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

3✔
4187
        channel, ok := p.activeChannels.Load(chanID)
3✔
4188

3✔
4189
        // Though this function can't be called for pending channels, we still
3✔
4190
        // check whether channel is nil for safety.
3✔
4191
        if !ok || channel == nil {
3✔
4192
                err := fmt.Errorf("unable to close channel, ChannelID(%v) is "+
×
4193
                        "unknown", chanID)
×
4194
                p.log.Errorf(err.Error())
×
4195
                req.Err <- err
×
4196
                return
×
4197
        }
×
4198

4199
        isTaprootChan := channel.ChanType().IsTaproot()
3✔
4200

3✔
4201
        switch req.CloseType {
3✔
4202
        // A type of CloseRegular indicates that the user has opted to close
4203
        // out this channel on-chain, so we execute the cooperative channel
4204
        // closure workflow.
4205
        case contractcourt.CloseRegular:
3✔
4206
                var err error
3✔
4207
                switch {
3✔
4208
                // If this is the RBF coop state machine, then we'll instruct
4209
                // it to send the shutdown message. This also might be an RBF
4210
                // iteration, in which case we'll be obtaining a new
4211
                // transaction w/ a higher fee rate.
4212
                //
4213
                // We don't support this close type for taproot channels yet
4214
                // however.
4215
                case !isTaprootChan && p.rbfCoopCloseAllowed():
3✔
4216
                        err = p.startRbfChanCloser(
3✔
4217
                                newRPCShutdownInit(req), channel.ChannelPoint(),
3✔
4218
                        )
3✔
4219
                default:
3✔
4220
                        err = p.initNegotiateChanCloser(req, channel)
3✔
4221
                }
4222

4223
                if err != nil {
3✔
4224
                        p.log.Errorf(err.Error())
×
4225
                        req.Err <- err
×
4226
                }
×
4227

4228
        // A type of CloseBreach indicates that the counterparty has breached
4229
        // the channel therefore we need to clean up our local state.
UNCOV
4230
        case contractcourt.CloseBreach:
×
UNCOV
4231
                // TODO(roasbeef): no longer need with newer beach logic?
×
UNCOV
4232
                p.log.Infof("ChannelPoint(%v) has been breached, wiping "+
×
UNCOV
4233
                        "channel", req.ChanPoint)
×
UNCOV
4234
                p.WipeChannel(req.ChanPoint)
×
4235
        }
4236
}
4237

4238
// linkFailureReport is sent to the channelManager whenever a link reports a
4239
// link failure, and is forced to exit. The report houses the necessary
4240
// information to clean up the channel state, send back the error message, and
4241
// force close if necessary.
4242
type linkFailureReport struct {
4243
        chanPoint   wire.OutPoint
4244
        chanID      lnwire.ChannelID
4245
        shortChanID lnwire.ShortChannelID
4246
        linkErr     htlcswitch.LinkFailureError
4247
}
4248

4249
// handleLinkFailure processes a link failure report when a link in the switch
4250
// fails. It facilitates the removal of all channel state within the peer,
4251
// force closing the channel depending on severity, and sending the error
4252
// message back to the remote party.
4253
func (p *Brontide) handleLinkFailure(failure linkFailureReport) {
3✔
4254
        // Retrieve the channel from the map of active channels. We do this to
3✔
4255
        // have access to it even after WipeChannel remove it from the map.
3✔
4256
        chanID := lnwire.NewChanIDFromOutPoint(failure.chanPoint)
3✔
4257
        lnChan, _ := p.activeChannels.Load(chanID)
3✔
4258

3✔
4259
        // We begin by wiping the link, which will remove it from the switch,
3✔
4260
        // such that it won't be attempted used for any more updates.
3✔
4261
        //
3✔
4262
        // TODO(halseth): should introduce a way to atomically stop/pause the
3✔
4263
        // link and cancel back any adds in its mailboxes such that we can
3✔
4264
        // safely force close without the link being added again and updates
3✔
4265
        // being applied.
3✔
4266
        p.WipeChannel(&failure.chanPoint)
3✔
4267

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

3✔
4273
                closeTx, err := p.cfg.ChainArb.ForceCloseContract(
3✔
4274
                        failure.chanPoint,
3✔
4275
                )
3✔
4276
                if err != nil {
6✔
4277
                        p.log.Errorf("unable to force close "+
3✔
4278
                                "link(%v): %v", failure.shortChanID, err)
3✔
4279
                } else {
6✔
4280
                        p.log.Infof("channel(%v) force "+
3✔
4281
                                "closed with txid %v",
3✔
4282
                                failure.shortChanID, closeTx.TxHash())
3✔
4283
                }
3✔
4284
        }
4285

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

×
4291
                if err := lnChan.State().MarkBorked(); err != nil {
×
4292
                        p.log.Errorf("Unable to mark channel %v borked: %v",
×
4293
                                failure.shortChanID, err)
×
4294
                }
×
4295
        }
4296

4297
        // Send an error to the peer, why we failed the channel.
4298
        if failure.linkErr.ShouldSendToPeer() {
6✔
4299
                // If SendData is set, send it to the peer. If not, we'll use
3✔
4300
                // the standard error messages in the payload. We only include
3✔
4301
                // sendData in the cases where the error data does not contain
3✔
4302
                // sensitive information.
3✔
4303
                data := []byte(failure.linkErr.Error())
3✔
4304
                if failure.linkErr.SendData != nil {
3✔
4305
                        data = failure.linkErr.SendData
×
4306
                }
×
4307

4308
                var networkMsg lnwire.Message
3✔
4309
                if failure.linkErr.Warning {
3✔
4310
                        networkMsg = &lnwire.Warning{
×
4311
                                ChanID: failure.chanID,
×
4312
                                Data:   data,
×
4313
                        }
×
4314
                } else {
3✔
4315
                        networkMsg = &lnwire.Error{
3✔
4316
                                ChanID: failure.chanID,
3✔
4317
                                Data:   data,
3✔
4318
                        }
3✔
4319
                }
3✔
4320

4321
                err := p.SendMessage(true, networkMsg)
3✔
4322
                if err != nil {
3✔
4323
                        p.log.Errorf("unable to send msg to "+
×
4324
                                "remote peer: %v", err)
×
4325
                }
×
4326
        }
4327

4328
        // If the failure action is disconnect, then we'll execute that now. If
4329
        // we had to send an error above, it was a sync call, so we expect the
4330
        // message to be flushed on the wire by now.
4331
        if failure.linkErr.FailureAction == htlcswitch.LinkFailureDisconnect {
3✔
4332
                p.Disconnect(fmt.Errorf("link requested disconnect"))
×
4333
        }
×
4334
}
4335

4336
// fetchLinkFromKeyAndCid fetches a link from the switch via the remote's
4337
// public key and the channel id.
4338
func (p *Brontide) fetchLinkFromKeyAndCid(
4339
        cid lnwire.ChannelID) htlcswitch.ChannelUpdateHandler {
3✔
4340

3✔
4341
        var chanLink htlcswitch.ChannelUpdateHandler
3✔
4342

3✔
4343
        // We don't need to check the error here, and can instead just loop
3✔
4344
        // over the slice and return nil.
3✔
4345
        links, _ := p.cfg.Switch.GetLinksByInterface(p.cfg.PubKeyBytes)
3✔
4346
        for _, link := range links {
6✔
4347
                if link.ChanID() == cid {
6✔
4348
                        chanLink = link
3✔
4349
                        break
3✔
4350
                }
4351
        }
4352

4353
        return chanLink
3✔
4354
}
4355

4356
// finalizeChanClosure performs the final clean up steps once the cooperative
4357
// closure transaction has been fully broadcast. The finalized closing state
4358
// machine should be passed in. Once the transaction has been sufficiently
4359
// confirmed, the channel will be marked as fully closed within the database,
4360
// and any clients will be notified of updates to the closing state.
4361
func (p *Brontide) finalizeChanClosure(chanCloser *chancloser.ChanCloser) {
3✔
4362
        closeReq := chanCloser.CloseRequest()
3✔
4363

3✔
4364
        // First, we'll clear all indexes related to the channel in question.
3✔
4365
        chanPoint := chanCloser.Channel().ChannelPoint()
3✔
4366
        p.WipeChannel(&chanPoint)
3✔
4367

3✔
4368
        // Also clear the activeChanCloses map of this channel.
3✔
4369
        cid := lnwire.NewChanIDFromOutPoint(chanPoint)
3✔
4370
        p.activeChanCloses.Delete(cid) // TODO(roasbeef): existing race
3✔
4371

3✔
4372
        // Next, we'll launch a goroutine which will request to be notified by
3✔
4373
        // the ChainNotifier once the closure transaction obtains a single
3✔
4374
        // confirmation.
3✔
4375
        notifier := p.cfg.ChainNotifier
3✔
4376

3✔
4377
        // If any error happens during waitForChanToClose, forward it to
3✔
4378
        // closeReq. If this channel closure is not locally initiated, closeReq
3✔
4379
        // will be nil, so just ignore the error.
3✔
4380
        errChan := make(chan error, 1)
3✔
4381
        if closeReq != nil {
6✔
4382
                errChan = closeReq.Err
3✔
4383
        }
3✔
4384

4385
        closingTx, err := chanCloser.ClosingTx()
3✔
4386
        if err != nil {
3✔
4387
                if closeReq != nil {
×
4388
                        p.log.Error(err)
×
4389
                        closeReq.Err <- err
×
4390
                }
×
4391
        }
4392

4393
        closingTxid := closingTx.TxHash()
3✔
4394

3✔
4395
        // If this is a locally requested shutdown, update the caller with a
3✔
4396
        // new event detailing the current pending state of this request.
3✔
4397
        if closeReq != nil {
6✔
4398
                closeReq.Updates <- &PendingUpdate{
3✔
4399
                        Txid: closingTxid[:],
3✔
4400
                }
3✔
4401
        }
3✔
4402

4403
        localOut := chanCloser.LocalCloseOutput()
3✔
4404
        remoteOut := chanCloser.RemoteCloseOutput()
3✔
4405
        auxOut := chanCloser.AuxOutputs()
3✔
4406
        go WaitForChanToClose(
3✔
4407
                chanCloser.NegotiationHeight(), notifier, errChan,
3✔
4408
                &chanPoint, &closingTxid, closingTx.TxOut[0].PkScript, func() {
6✔
4409
                        // Respond to the local subsystem which requested the
3✔
4410
                        // channel closure.
3✔
4411
                        if closeReq != nil {
6✔
4412
                                closeReq.Updates <- &ChannelCloseUpdate{
3✔
4413
                                        ClosingTxid:       closingTxid[:],
3✔
4414
                                        Success:           true,
3✔
4415
                                        LocalCloseOutput:  localOut,
3✔
4416
                                        RemoteCloseOutput: remoteOut,
3✔
4417
                                        AuxOutputs:        auxOut,
3✔
4418
                                }
3✔
4419
                        }
3✔
4420
                },
4421
        )
4422
}
4423

4424
// WaitForChanToClose uses the passed notifier to wait until the channel has
4425
// been detected as closed on chain and then concludes by executing the
4426
// following actions: the channel point will be sent over the settleChan, and
4427
// finally the callback will be executed. If any error is encountered within
4428
// the function, then it will be sent over the errChan.
4429
func WaitForChanToClose(bestHeight uint32, notifier chainntnfs.ChainNotifier,
4430
        errChan chan error, chanPoint *wire.OutPoint,
4431
        closingTxID *chainhash.Hash, closeScript []byte, cb func()) {
3✔
4432

3✔
4433
        peerLog.Infof("Waiting for confirmation of close of ChannelPoint(%v) "+
3✔
4434
                "with txid: %v", chanPoint, closingTxID)
3✔
4435

3✔
4436
        // TODO(roasbeef): add param for num needed confs
3✔
4437
        confNtfn, err := notifier.RegisterConfirmationsNtfn(
3✔
4438
                closingTxID, closeScript, 1, bestHeight,
3✔
4439
        )
3✔
4440
        if err != nil {
3✔
4441
                if errChan != nil {
×
4442
                        errChan <- err
×
4443
                }
×
4444
                return
×
4445
        }
4446

4447
        // In the case that the ChainNotifier is shutting down, all subscriber
4448
        // notification channels will be closed, generating a nil receive.
4449
        height, ok := <-confNtfn.Confirmed
3✔
4450
        if !ok {
6✔
4451
                return
3✔
4452
        }
3✔
4453

4454
        // The channel has been closed, remove it from any active indexes, and
4455
        // the database state.
4456
        peerLog.Infof("ChannelPoint(%v) is now closed at "+
3✔
4457
                "height %v", chanPoint, height.BlockHeight)
3✔
4458

3✔
4459
        // Finally, execute the closure call back to mark the confirmation of
3✔
4460
        // the transaction closing the contract.
3✔
4461
        cb()
3✔
4462
}
4463

4464
// WipeChannel removes the passed channel point from all indexes associated with
4465
// the peer and the switch.
4466
func (p *Brontide) WipeChannel(chanPoint *wire.OutPoint) {
3✔
4467
        chanID := lnwire.NewChanIDFromOutPoint(*chanPoint)
3✔
4468

3✔
4469
        p.activeChannels.Delete(chanID)
3✔
4470

3✔
4471
        // Instruct the HtlcSwitch to close this link as the channel is no
3✔
4472
        // longer active.
3✔
4473
        p.cfg.Switch.RemoveLink(chanID)
3✔
4474
}
3✔
4475

4476
// handleInitMsg handles the incoming init message which contains global and
4477
// local feature vectors. If feature vectors are incompatible then disconnect.
4478
func (p *Brontide) handleInitMsg(msg *lnwire.Init) error {
3✔
4479
        // First, merge any features from the legacy global features field into
3✔
4480
        // those presented in the local features fields.
3✔
4481
        err := msg.Features.Merge(msg.GlobalFeatures)
3✔
4482
        if err != nil {
3✔
4483
                return fmt.Errorf("unable to merge legacy global features: %w",
×
4484
                        err)
×
4485
        }
×
4486

4487
        // Then, finalize the remote feature vector providing the flattened
4488
        // feature bit namespace.
4489
        p.remoteFeatures = lnwire.NewFeatureVector(
3✔
4490
                msg.Features, lnwire.Features,
3✔
4491
        )
3✔
4492

3✔
4493
        // Now that we have their features loaded, we'll ensure that they
3✔
4494
        // didn't set any required bits that we don't know of.
3✔
4495
        err = feature.ValidateRequired(p.remoteFeatures)
3✔
4496
        if err != nil {
3✔
4497
                return fmt.Errorf("invalid remote features: %w", err)
×
4498
        }
×
4499

4500
        // Ensure the remote party's feature vector contains all transitive
4501
        // dependencies. We know ours are correct since they are validated
4502
        // during the feature manager's instantiation.
4503
        err = feature.ValidateDeps(p.remoteFeatures)
3✔
4504
        if err != nil {
3✔
4505
                return fmt.Errorf("invalid remote features: %w", err)
×
4506
        }
×
4507

4508
        // Now that we know we understand their requirements, we'll check to
4509
        // see if they don't support anything that we deem to be mandatory.
4510
        if !p.remoteFeatures.HasFeature(lnwire.DataLossProtectRequired) {
3✔
4511
                return fmt.Errorf("data loss protection required")
×
4512
        }
×
4513

4514
        return nil
3✔
4515
}
4516

4517
// LocalFeatures returns the set of global features that has been advertised by
4518
// the local node. This allows sub-systems that use this interface to gate their
4519
// behavior off the set of negotiated feature bits.
4520
//
4521
// NOTE: Part of the lnpeer.Peer interface.
4522
func (p *Brontide) LocalFeatures() *lnwire.FeatureVector {
3✔
4523
        return p.cfg.Features
3✔
4524
}
3✔
4525

4526
// RemoteFeatures returns the set of global features that has been advertised by
4527
// the remote node. This allows sub-systems that use this interface to gate
4528
// their behavior off the set of negotiated feature bits.
4529
//
4530
// NOTE: Part of the lnpeer.Peer interface.
4531
func (p *Brontide) RemoteFeatures() *lnwire.FeatureVector {
3✔
4532
        return p.remoteFeatures
3✔
4533
}
3✔
4534

4535
// hasNegotiatedScidAlias returns true if we've negotiated the
4536
// option-scid-alias feature bit with the peer.
4537
func (p *Brontide) hasNegotiatedScidAlias() bool {
3✔
4538
        peerHas := p.remoteFeatures.HasFeature(lnwire.ScidAliasOptional)
3✔
4539
        localHas := p.cfg.Features.HasFeature(lnwire.ScidAliasOptional)
3✔
4540
        return peerHas && localHas
3✔
4541
}
3✔
4542

4543
// sendInitMsg sends the Init message to the remote peer. This message contains
4544
// our currently supported local and global features.
4545
func (p *Brontide) sendInitMsg(legacyChan bool) error {
3✔
4546
        features := p.cfg.Features.Clone()
3✔
4547
        legacyFeatures := p.cfg.LegacyFeatures.Clone()
3✔
4548

3✔
4549
        // If we have a legacy channel open with a peer, we downgrade static
3✔
4550
        // remote required to optional in case the peer does not understand the
3✔
4551
        // required feature bit. If we do not do this, the peer will reject our
3✔
4552
        // connection because it does not understand a required feature bit, and
3✔
4553
        // our channel will be unusable.
3✔
4554
        if legacyChan && features.RequiresFeature(lnwire.StaticRemoteKeyRequired) {
3✔
4555
                p.log.Infof("Legacy channel open with peer, " +
×
4556
                        "downgrading static remote required feature bit to " +
×
4557
                        "optional")
×
4558

×
4559
                // Unset and set in both the local and global features to
×
4560
                // ensure both sets are consistent and merge able by old and
×
4561
                // new nodes.
×
4562
                features.Unset(lnwire.StaticRemoteKeyRequired)
×
4563
                legacyFeatures.Unset(lnwire.StaticRemoteKeyRequired)
×
4564

×
4565
                features.Set(lnwire.StaticRemoteKeyOptional)
×
4566
                legacyFeatures.Set(lnwire.StaticRemoteKeyOptional)
×
4567
        }
×
4568

4569
        msg := lnwire.NewInitMessage(
3✔
4570
                legacyFeatures.RawFeatureVector,
3✔
4571
                features.RawFeatureVector,
3✔
4572
        )
3✔
4573

3✔
4574
        return p.writeMessage(msg)
3✔
4575
}
4576

4577
// resendChanSyncMsg will attempt to find a channel sync message for the closed
4578
// channel and resend it to our peer.
4579
func (p *Brontide) resendChanSyncMsg(cid lnwire.ChannelID) error {
3✔
4580
        // If we already re-sent the mssage for this channel, we won't do it
3✔
4581
        // again.
3✔
4582
        if _, ok := p.resentChanSyncMsg[cid]; ok {
3✔
UNCOV
4583
                return nil
×
UNCOV
4584
        }
×
4585

4586
        // Check if we have any channel sync messages stored for this channel.
4587
        c, err := p.cfg.ChannelDB.FetchClosedChannelForID(cid)
3✔
4588
        if err != nil {
6✔
4589
                return fmt.Errorf("unable to fetch channel sync messages for "+
3✔
4590
                        "peer %v: %v", p, err)
3✔
4591
        }
3✔
4592

4593
        if c.LastChanSyncMsg == nil {
3✔
4594
                return fmt.Errorf("no chan sync message stored for channel %v",
×
4595
                        cid)
×
4596
        }
×
4597

4598
        if !c.RemotePub.IsEqual(p.IdentityKey()) {
3✔
4599
                return fmt.Errorf("ignoring channel reestablish from "+
×
4600
                        "peer=%x", p.IdentityKey().SerializeCompressed())
×
4601
        }
×
4602

4603
        p.log.Debugf("Re-sending channel sync message for channel %v to "+
3✔
4604
                "peer", cid)
3✔
4605

3✔
4606
        if err := p.SendMessage(true, c.LastChanSyncMsg); err != nil {
3✔
4607
                return fmt.Errorf("failed resending channel sync "+
×
4608
                        "message to peer %v: %v", p, err)
×
4609
        }
×
4610

4611
        p.log.Debugf("Re-sent channel sync message for channel %v to peer ",
3✔
4612
                cid)
3✔
4613

3✔
4614
        // Note down that we sent the message, so we won't resend it again for
3✔
4615
        // this connection.
3✔
4616
        p.resentChanSyncMsg[cid] = struct{}{}
3✔
4617

3✔
4618
        return nil
3✔
4619
}
4620

4621
// SendMessage sends a variadic number of high-priority messages to the remote
4622
// peer. The first argument denotes if the method should block until the
4623
// messages have been sent to the remote peer or an error is returned,
4624
// otherwise it returns immediately after queuing.
4625
//
4626
// NOTE: Part of the lnpeer.Peer interface.
4627
func (p *Brontide) SendMessage(sync bool, msgs ...lnwire.Message) error {
3✔
4628
        return p.sendMessage(sync, true, msgs...)
3✔
4629
}
3✔
4630

4631
// SendMessageLazy sends a variadic number of low-priority messages to the
4632
// remote peer. The first argument denotes if the method should block until
4633
// the messages have been sent to the remote peer or an error is returned,
4634
// otherwise it returns immediately after queueing.
4635
//
4636
// NOTE: Part of the lnpeer.Peer interface.
4637
func (p *Brontide) SendMessageLazy(sync bool, msgs ...lnwire.Message) error {
3✔
4638
        return p.sendMessage(sync, false, msgs...)
3✔
4639
}
3✔
4640

4641
// sendMessage queues a variadic number of messages using the passed priority
4642
// to the remote peer. If sync is true, this method will block until the
4643
// messages have been sent to the remote peer or an error is returned, otherwise
4644
// it returns immediately after queueing.
4645
func (p *Brontide) sendMessage(sync, priority bool, msgs ...lnwire.Message) error {
3✔
4646
        // Add all incoming messages to the outgoing queue. A list of error
3✔
4647
        // chans is populated for each message if the caller requested a sync
3✔
4648
        // send.
3✔
4649
        var errChans []chan error
3✔
4650
        if sync {
6✔
4651
                errChans = make([]chan error, 0, len(msgs))
3✔
4652
        }
3✔
4653
        for _, msg := range msgs {
6✔
4654
                // If a sync send was requested, create an error chan to listen
3✔
4655
                // for an ack from the writeHandler.
3✔
4656
                var errChan chan error
3✔
4657
                if sync {
6✔
4658
                        errChan = make(chan error, 1)
3✔
4659
                        errChans = append(errChans, errChan)
3✔
4660
                }
3✔
4661

4662
                if priority {
6✔
4663
                        p.queueMsg(msg, errChan)
3✔
4664
                } else {
6✔
4665
                        p.queueMsgLazy(msg, errChan)
3✔
4666
                }
3✔
4667
        }
4668

4669
        // Wait for all replies from the writeHandler. For async sends, this
4670
        // will be a NOP as the list of error chans is nil.
4671
        for _, errChan := range errChans {
6✔
4672
                select {
3✔
4673
                case err := <-errChan:
3✔
4674
                        return err
3✔
4675
                case <-p.cg.Done():
×
4676
                        return lnpeer.ErrPeerExiting
×
4677
                case <-p.cfg.Quit:
×
4678
                        return lnpeer.ErrPeerExiting
×
4679
                }
4680
        }
4681

4682
        return nil
3✔
4683
}
4684

4685
// PubKey returns the pubkey of the peer in compressed serialized format.
4686
//
4687
// NOTE: Part of the lnpeer.Peer interface.
4688
func (p *Brontide) PubKey() [33]byte {
3✔
4689
        return p.cfg.PubKeyBytes
3✔
4690
}
3✔
4691

4692
// IdentityKey returns the public key of the remote peer.
4693
//
4694
// NOTE: Part of the lnpeer.Peer interface.
4695
func (p *Brontide) IdentityKey() *btcec.PublicKey {
3✔
4696
        return p.cfg.Addr.IdentityKey
3✔
4697
}
3✔
4698

4699
// Address returns the network address of the remote peer.
4700
//
4701
// NOTE: Part of the lnpeer.Peer interface.
4702
func (p *Brontide) Address() net.Addr {
3✔
4703
        return p.cfg.Addr.Address
3✔
4704
}
3✔
4705

4706
// AddNewChannel adds a new channel to the peer. The channel should fail to be
4707
// added if the cancel channel is closed.
4708
//
4709
// NOTE: Part of the lnpeer.Peer interface.
4710
func (p *Brontide) AddNewChannel(newChan *lnpeer.NewChannel,
4711
        cancel <-chan struct{}) error {
3✔
4712

3✔
4713
        errChan := make(chan error, 1)
3✔
4714
        newChanMsg := &newChannelMsg{
3✔
4715
                channel: newChan,
3✔
4716
                err:     errChan,
3✔
4717
        }
3✔
4718

3✔
4719
        select {
3✔
4720
        case p.newActiveChannel <- newChanMsg:
3✔
4721
        case <-cancel:
×
4722
                return errors.New("canceled adding new channel")
×
4723
        case <-p.cg.Done():
×
4724
                return lnpeer.ErrPeerExiting
×
4725
        }
4726

4727
        // We pause here to wait for the peer to recognize the new channel
4728
        // before we close the channel barrier corresponding to the channel.
4729
        select {
3✔
4730
        case err := <-errChan:
3✔
4731
                return err
3✔
4732
        case <-p.cg.Done():
×
4733
                return lnpeer.ErrPeerExiting
×
4734
        }
4735
}
4736

4737
// AddPendingChannel adds a pending open channel to the peer. The channel
4738
// should fail to be added if the cancel channel is closed.
4739
//
4740
// NOTE: Part of the lnpeer.Peer interface.
4741
func (p *Brontide) AddPendingChannel(cid lnwire.ChannelID,
4742
        cancel <-chan struct{}) error {
3✔
4743

3✔
4744
        errChan := make(chan error, 1)
3✔
4745
        newChanMsg := &newChannelMsg{
3✔
4746
                channelID: cid,
3✔
4747
                err:       errChan,
3✔
4748
        }
3✔
4749

3✔
4750
        select {
3✔
4751
        case p.newPendingChannel <- newChanMsg:
3✔
4752

4753
        case <-cancel:
×
4754
                return errors.New("canceled adding pending channel")
×
4755

4756
        case <-p.cg.Done():
×
4757
                return lnpeer.ErrPeerExiting
×
4758
        }
4759

4760
        // We pause here to wait for the peer to recognize the new pending
4761
        // channel before we close the channel barrier corresponding to the
4762
        // channel.
4763
        select {
3✔
4764
        case err := <-errChan:
3✔
4765
                return err
3✔
4766

4767
        case <-cancel:
×
4768
                return errors.New("canceled adding pending channel")
×
4769

4770
        case <-p.cg.Done():
×
4771
                return lnpeer.ErrPeerExiting
×
4772
        }
4773
}
4774

4775
// RemovePendingChannel removes a pending open channel from the peer.
4776
//
4777
// NOTE: Part of the lnpeer.Peer interface.
4778
func (p *Brontide) RemovePendingChannel(cid lnwire.ChannelID) error {
3✔
4779
        errChan := make(chan error, 1)
3✔
4780
        newChanMsg := &newChannelMsg{
3✔
4781
                channelID: cid,
3✔
4782
                err:       errChan,
3✔
4783
        }
3✔
4784

3✔
4785
        select {
3✔
4786
        case p.removePendingChannel <- newChanMsg:
3✔
4787
        case <-p.cg.Done():
×
4788
                return lnpeer.ErrPeerExiting
×
4789
        }
4790

4791
        // We pause here to wait for the peer to respond to the cancellation of
4792
        // the pending channel before we close the channel barrier
4793
        // corresponding to the channel.
4794
        select {
3✔
4795
        case err := <-errChan:
3✔
4796
                return err
3✔
4797

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

4803
// StartTime returns the time at which the connection was established if the
4804
// peer started successfully, and zero otherwise.
4805
func (p *Brontide) StartTime() time.Time {
3✔
4806
        return p.startTime
3✔
4807
}
3✔
4808

4809
// handleCloseMsg is called when a new cooperative channel closure related
4810
// message is received from the remote peer. We'll use this message to advance
4811
// the chan closer state machine.
4812
func (p *Brontide) handleCloseMsg(msg *closeMsg) {
3✔
4813
        link := p.fetchLinkFromKeyAndCid(msg.cid)
3✔
4814

3✔
4815
        // We'll now fetch the matching closing state machine in order to
3✔
4816
        // continue, or finalize the channel closure process.
3✔
4817
        chanCloserE, err := p.fetchActiveChanCloser(msg.cid)
3✔
4818
        if err != nil {
6✔
4819
                // If the channel is not known to us, we'll simply ignore this
3✔
4820
                // message.
3✔
4821
                if err == ErrChannelNotFound {
6✔
4822
                        return
3✔
4823
                }
3✔
4824

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

×
4827
                errMsg := &lnwire.Error{
×
4828
                        ChanID: msg.cid,
×
4829
                        Data:   lnwire.ErrorData(err.Error()),
×
4830
                }
×
4831
                p.queueMsg(errMsg, nil)
×
4832
                return
×
4833
        }
4834

4835
        if chanCloserE.IsRight() {
3✔
4836
                // TODO(roasbeef): assert?
×
4837
                return
×
4838
        }
×
4839

4840
        // At this point, we'll only enter this call path if a negotiate chan
4841
        // closer was used. So we'll extract that from the either now.
4842
        //
4843
        // TODO(roabeef): need extra helper func for either to make cleaner
4844
        var chanCloser *chancloser.ChanCloser
3✔
4845
        chanCloserE.WhenLeft(func(c *chancloser.ChanCloser) {
6✔
4846
                chanCloser = c
3✔
4847
        })
3✔
4848

4849
        handleErr := func(err error) {
4✔
4850
                err = fmt.Errorf("unable to process close msg: %w", err)
1✔
4851
                p.log.Error(err)
1✔
4852

1✔
4853
                // As the negotiations failed, we'll reset the channel state
1✔
4854
                // machine to ensure we act to on-chain events as normal.
1✔
4855
                chanCloser.Channel().ResetState()
1✔
4856
                if chanCloser.CloseRequest() != nil {
1✔
4857
                        chanCloser.CloseRequest().Err <- err
×
4858
                }
×
4859

4860
                p.activeChanCloses.Delete(msg.cid)
1✔
4861

1✔
4862
                p.Disconnect(err)
1✔
4863
        }
4864

4865
        // Next, we'll process the next message using the target state machine.
4866
        // We'll either continue negotiation, or halt.
4867
        switch typed := msg.msg.(type) {
3✔
4868
        case *lnwire.Shutdown:
3✔
4869
                // Disable incoming adds immediately.
3✔
4870
                if link != nil && !link.DisableAdds(htlcswitch.Incoming) {
3✔
4871
                        p.log.Warnf("Incoming link adds already disabled: %v",
×
4872
                                link.ChanID())
×
4873
                }
×
4874

4875
                oShutdown, err := chanCloser.ReceiveShutdown(*typed)
3✔
4876
                if err != nil {
3✔
4877
                        handleErr(err)
×
4878
                        return
×
4879
                }
×
4880

4881
                oShutdown.WhenSome(func(msg lnwire.Shutdown) {
6✔
4882
                        // If the link is nil it means we can immediately queue
3✔
4883
                        // the Shutdown message since we don't have to wait for
3✔
4884
                        // commitment transaction synchronization.
3✔
4885
                        if link == nil {
3✔
4886
                                p.queueMsg(&msg, nil)
×
4887
                                return
×
4888
                        }
×
4889

4890
                        // Immediately disallow any new HTLC's from being added
4891
                        // in the outgoing direction.
4892
                        if !link.DisableAdds(htlcswitch.Outgoing) {
3✔
4893
                                p.log.Warnf("Outgoing link adds already "+
×
4894
                                        "disabled: %v", link.ChanID())
×
4895
                        }
×
4896

4897
                        // When we have a Shutdown to send, we defer it till the
4898
                        // next time we send a CommitSig to remain spec
4899
                        // compliant.
4900
                        link.OnCommitOnce(htlcswitch.Outgoing, func() {
6✔
4901
                                p.queueMsg(&msg, nil)
3✔
4902
                        })
3✔
4903
                })
4904

4905
                beginNegotiation := func() {
6✔
4906
                        oClosingSigned, err := chanCloser.BeginNegotiation()
3✔
4907
                        if err != nil {
3✔
4908
                                handleErr(err)
×
4909
                                return
×
4910
                        }
×
4911

4912
                        oClosingSigned.WhenSome(func(msg lnwire.ClosingSigned) {
6✔
4913
                                p.queueMsg(&msg, nil)
3✔
4914
                        })
3✔
4915
                }
4916

4917
                if link == nil {
3✔
4918
                        beginNegotiation()
×
4919
                } else {
3✔
4920
                        // Now we register a flush hook to advance the
3✔
4921
                        // ChanCloser and possibly send out a ClosingSigned
3✔
4922
                        // when the link finishes draining.
3✔
4923
                        link.OnFlushedOnce(func() {
6✔
4924
                                // Remove link in goroutine to prevent deadlock.
3✔
4925
                                go p.cfg.Switch.RemoveLink(msg.cid)
3✔
4926
                                beginNegotiation()
3✔
4927
                        })
3✔
4928
                }
4929

4930
        case *lnwire.ClosingSigned:
3✔
4931
                oClosingSigned, err := chanCloser.ReceiveClosingSigned(*typed)
3✔
4932
                if err != nil {
4✔
4933
                        handleErr(err)
1✔
4934
                        return
1✔
4935
                }
1✔
4936

4937
                oClosingSigned.WhenSome(func(msg lnwire.ClosingSigned) {
6✔
4938
                        p.queueMsg(&msg, nil)
3✔
4939
                })
3✔
4940

4941
        default:
×
4942
                panic("impossible closeMsg type")
×
4943
        }
4944

4945
        // If we haven't finished close negotiations, then we'll continue as we
4946
        // can't yet finalize the closure.
4947
        if _, err := chanCloser.ClosingTx(); err != nil {
6✔
4948
                return
3✔
4949
        }
3✔
4950

4951
        // Otherwise, we've agreed on a closing fee! In this case, we'll wrap up
4952
        // the channel closure by notifying relevant sub-systems and launching a
4953
        // goroutine to wait for close tx conf.
4954
        p.finalizeChanClosure(chanCloser)
3✔
4955
}
4956

4957
// HandleLocalCloseChanReqs accepts a *htlcswitch.ChanClose and passes it onto
4958
// the channelManager goroutine, which will shut down the link and possibly
4959
// close the channel.
4960
func (p *Brontide) HandleLocalCloseChanReqs(req *htlcswitch.ChanClose) {
3✔
4961
        select {
3✔
4962
        case p.localCloseChanReqs <- req:
3✔
4963
                p.log.Info("Local close channel request is going to be " +
3✔
4964
                        "delivered to the peer")
3✔
4965
        case <-p.cg.Done():
×
4966
                p.log.Info("Unable to deliver local close channel request " +
×
4967
                        "to peer")
×
4968
        }
4969
}
4970

4971
// NetAddress returns the network of the remote peer as an lnwire.NetAddress.
4972
func (p *Brontide) NetAddress() *lnwire.NetAddress {
3✔
4973
        return p.cfg.Addr
3✔
4974
}
3✔
4975

4976
// Inbound is a getter for the Brontide's Inbound boolean in cfg.
4977
func (p *Brontide) Inbound() bool {
3✔
4978
        return p.cfg.Inbound
3✔
4979
}
3✔
4980

4981
// ConnReq is a getter for the Brontide's connReq in cfg.
4982
func (p *Brontide) ConnReq() *connmgr.ConnReq {
3✔
4983
        return p.cfg.ConnReq
3✔
4984
}
3✔
4985

4986
// ErrorBuffer is a getter for the Brontide's errorBuffer in cfg.
4987
func (p *Brontide) ErrorBuffer() *queue.CircularBuffer {
3✔
4988
        return p.cfg.ErrorBuffer
3✔
4989
}
3✔
4990

4991
// SetAddress sets the remote peer's address given an address.
4992
func (p *Brontide) SetAddress(address net.Addr) {
×
4993
        p.cfg.Addr.Address = address
×
4994
}
×
4995

4996
// ActiveSignal returns the peer's active signal.
4997
func (p *Brontide) ActiveSignal() chan struct{} {
3✔
4998
        return p.activeSignal
3✔
4999
}
3✔
5000

5001
// Conn returns a pointer to the peer's connection struct.
5002
func (p *Brontide) Conn() net.Conn {
3✔
5003
        return p.cfg.Conn
3✔
5004
}
3✔
5005

5006
// BytesReceived returns the number of bytes received from the peer.
5007
func (p *Brontide) BytesReceived() uint64 {
3✔
5008
        return atomic.LoadUint64(&p.bytesReceived)
3✔
5009
}
3✔
5010

5011
// BytesSent returns the number of bytes sent to the peer.
5012
func (p *Brontide) BytesSent() uint64 {
3✔
5013
        return atomic.LoadUint64(&p.bytesSent)
3✔
5014
}
3✔
5015

5016
// LastRemotePingPayload returns the last payload the remote party sent as part
5017
// of their ping.
5018
func (p *Brontide) LastRemotePingPayload() []byte {
3✔
5019
        pingPayload := p.lastPingPayload.Load()
3✔
5020
        if pingPayload == nil {
6✔
5021
                return []byte{}
3✔
5022
        }
3✔
5023

5024
        pingBytes, ok := pingPayload.(lnwire.PingPayload)
×
5025
        if !ok {
×
5026
                return nil
×
5027
        }
×
5028

5029
        return pingBytes
×
5030
}
5031

5032
// attachChannelEventSubscription creates a channel event subscription and
5033
// attaches to client to Brontide if the reenableTimeout is no greater than 1
5034
// minute.
5035
func (p *Brontide) attachChannelEventSubscription() error {
3✔
5036
        // If the timeout is greater than 1 minute, it's unlikely that the link
3✔
5037
        // hasn't yet finished its reestablishment. Return a nil without
3✔
5038
        // creating the client to specify that we don't want to retry.
3✔
5039
        if p.cfg.ChanActiveTimeout > 1*time.Minute {
6✔
5040
                return nil
3✔
5041
        }
3✔
5042

5043
        // When the reenable timeout is less than 1 minute, it's likely the
5044
        // channel link hasn't finished its reestablishment yet. In that case,
5045
        // we'll give it a second chance by subscribing to the channel update
5046
        // events. Upon receiving the `ActiveLinkEvent`, we'll then request
5047
        // enabling the channel again.
5048
        sub, err := p.cfg.ChannelNotifier.SubscribeChannelEvents()
3✔
5049
        if err != nil {
3✔
5050
                return fmt.Errorf("SubscribeChannelEvents failed: %w", err)
×
5051
        }
×
5052

5053
        p.channelEventClient = sub
3✔
5054

3✔
5055
        return nil
3✔
5056
}
5057

5058
// updateNextRevocation updates the existing channel's next revocation if it's
5059
// nil.
5060
func (p *Brontide) updateNextRevocation(c *channeldb.OpenChannel) error {
3✔
5061
        chanPoint := c.FundingOutpoint
3✔
5062
        chanID := lnwire.NewChanIDFromOutPoint(chanPoint)
3✔
5063

3✔
5064
        // Read the current channel.
3✔
5065
        currentChan, loaded := p.activeChannels.Load(chanID)
3✔
5066

3✔
5067
        // currentChan should exist, but we perform a check anyway to avoid nil
3✔
5068
        // pointer dereference.
3✔
5069
        if !loaded {
3✔
5070
                return fmt.Errorf("missing active channel with chanID=%v",
×
5071
                        chanID)
×
5072
        }
×
5073

5074
        // currentChan should not be nil, but we perform a check anyway to
5075
        // avoid nil pointer dereference.
5076
        if currentChan == nil {
3✔
5077
                return fmt.Errorf("found nil active channel with chanID=%v",
×
5078
                        chanID)
×
5079
        }
×
5080

5081
        // If we're being sent a new channel, and our existing channel doesn't
5082
        // have the next revocation, then we need to update the current
5083
        // existing channel.
5084
        if currentChan.RemoteNextRevocation() != nil {
3✔
5085
                return nil
×
5086
        }
×
5087

5088
        p.log.Infof("Processing retransmitted ChannelReady for "+
3✔
5089
                "ChannelPoint(%v)", chanPoint)
3✔
5090

3✔
5091
        nextRevoke := c.RemoteNextRevocation
3✔
5092

3✔
5093
        err := currentChan.InitNextRevocation(nextRevoke)
3✔
5094
        if err != nil {
3✔
5095
                return fmt.Errorf("unable to init next revocation: %w", err)
×
5096
        }
×
5097

5098
        return nil
3✔
5099
}
5100

5101
// addActiveChannel adds a new active channel to the `activeChannels` map. It
5102
// takes a `channeldb.OpenChannel`, creates a `lnwallet.LightningChannel` from
5103
// it and assembles it with a channel link.
5104
func (p *Brontide) addActiveChannel(c *lnpeer.NewChannel) error {
3✔
5105
        chanPoint := c.FundingOutpoint
3✔
5106
        chanID := lnwire.NewChanIDFromOutPoint(chanPoint)
3✔
5107

3✔
5108
        // If we've reached this point, there are two possible scenarios.  If
3✔
5109
        // the channel was in the active channels map as nil, then it was
3✔
5110
        // loaded from disk and we need to send reestablish. Else, it was not
3✔
5111
        // loaded from disk and we don't need to send reestablish as this is a
3✔
5112
        // fresh channel.
3✔
5113
        shouldReestablish := p.isLoadedFromDisk(chanID)
3✔
5114

3✔
5115
        chanOpts := c.ChanOpts
3✔
5116
        if shouldReestablish {
6✔
5117
                // If we have to do the reestablish dance for this channel,
3✔
5118
                // ensure that we don't try to call InitRemoteMusigNonces twice
3✔
5119
                // by calling SkipNonceInit.
3✔
5120
                chanOpts = append(chanOpts, lnwallet.WithSkipNonceInit())
3✔
5121
        }
3✔
5122

5123
        p.cfg.AuxLeafStore.WhenSome(func(s lnwallet.AuxLeafStore) {
3✔
5124
                chanOpts = append(chanOpts, lnwallet.WithLeafStore(s))
×
5125
        })
×
5126
        p.cfg.AuxSigner.WhenSome(func(s lnwallet.AuxSigner) {
3✔
5127
                chanOpts = append(chanOpts, lnwallet.WithAuxSigner(s))
×
5128
        })
×
5129
        p.cfg.AuxResolver.WhenSome(func(s lnwallet.AuxContractResolver) {
3✔
5130
                chanOpts = append(chanOpts, lnwallet.WithAuxResolver(s))
×
5131
        })
×
5132

5133
        // If not already active, we'll add this channel to the set of active
5134
        // channels, so we can look it up later easily according to its channel
5135
        // ID.
5136
        lnChan, err := lnwallet.NewLightningChannel(
3✔
5137
                p.cfg.Signer, c.OpenChannel, p.cfg.SigPool, chanOpts...,
3✔
5138
        )
3✔
5139
        if err != nil {
3✔
5140
                return fmt.Errorf("unable to create LightningChannel: %w", err)
×
5141
        }
×
5142

5143
        // Store the channel in the activeChannels map.
5144
        p.activeChannels.Store(chanID, lnChan)
3✔
5145

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

3✔
5148
        // Next, we'll assemble a ChannelLink along with the necessary items it
3✔
5149
        // needs to function.
3✔
5150
        chainEvents, err := p.cfg.ChainArb.SubscribeChannelEvents(chanPoint)
3✔
5151
        if err != nil {
3✔
5152
                return fmt.Errorf("unable to subscribe to chain events: %w",
×
5153
                        err)
×
5154
        }
×
5155

5156
        // We'll query the channel DB for the new channel's initial forwarding
5157
        // policies to determine the policy we start out with.
5158
        initialPolicy, err := p.cfg.ChannelDB.GetInitialForwardingPolicy(chanID)
3✔
5159
        if err != nil {
3✔
5160
                return fmt.Errorf("unable to query for initial forwarding "+
×
5161
                        "policy: %v", err)
×
5162
        }
×
5163

5164
        // Create the link and add it to the switch.
5165
        err = p.addLink(
3✔
5166
                &chanPoint, lnChan, initialPolicy, chainEvents,
3✔
5167
                shouldReestablish, fn.None[lnwire.Shutdown](),
3✔
5168
        )
3✔
5169
        if err != nil {
3✔
5170
                return fmt.Errorf("can't register new channel link(%v) with "+
×
5171
                        "peer", chanPoint)
×
5172
        }
×
5173

5174
        isTaprootChan := c.ChanType.IsTaproot()
3✔
5175

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

5183
        // Now that the link has been added above, we'll also init an RBF chan
5184
        // closer for this channel, but only if the new close feature is
5185
        // negotiated.
5186
        //
5187
        // Creating this here ensures that any shutdown messages sent will be
5188
        // automatically routed by the msg router.
5189
        if _, err := p.initRbfChanCloser(lnChan); err != nil {
3✔
5190
                p.activeChanCloses.Delete(chanID)
×
5191

×
5192
                return fmt.Errorf("unable to init RBF chan closer for new "+
×
5193
                        "chan: %w", err)
×
5194
        }
×
5195

5196
        return nil
3✔
5197
}
5198

5199
// handleNewActiveChannel handles a `newChannelMsg` request. Depending on we
5200
// know this channel ID or not, we'll either add it to the `activeChannels` map
5201
// or init the next revocation for it.
5202
func (p *Brontide) handleNewActiveChannel(req *newChannelMsg) {
3✔
5203
        newChan := req.channel
3✔
5204
        chanPoint := newChan.FundingOutpoint
3✔
5205
        chanID := lnwire.NewChanIDFromOutPoint(chanPoint)
3✔
5206

3✔
5207
        // Only update RemoteNextRevocation if the channel is in the
3✔
5208
        // activeChannels map and if we added the link to the switch. Only
3✔
5209
        // active channels will be added to the switch.
3✔
5210
        if p.isActiveChannel(chanID) {
6✔
5211
                p.log.Infof("Already have ChannelPoint(%v), ignoring",
3✔
5212
                        chanPoint)
3✔
5213

3✔
5214
                // Handle it and close the err chan on the request.
3✔
5215
                close(req.err)
3✔
5216

3✔
5217
                // Update the next revocation point.
3✔
5218
                err := p.updateNextRevocation(newChan.OpenChannel)
3✔
5219
                if err != nil {
3✔
5220
                        p.log.Errorf(err.Error())
×
5221
                }
×
5222

5223
                return
3✔
5224
        }
5225

5226
        // This is a new channel, we now add it to the map.
5227
        if err := p.addActiveChannel(req.channel); err != nil {
3✔
5228
                // Log and send back the error to the request.
×
5229
                p.log.Errorf(err.Error())
×
5230
                req.err <- err
×
5231

×
5232
                return
×
5233
        }
×
5234

5235
        // Close the err chan if everything went fine.
5236
        close(req.err)
3✔
5237
}
5238

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

3✔
5246
        chanID := req.channelID
3✔
5247

3✔
5248
        // If we already have this channel, something is wrong with the funding
3✔
5249
        // flow as it will only be marked as active after `ChannelReady` is
3✔
5250
        // handled. In this case, we will do nothing but log an error, just in
3✔
5251
        // case this is a legit channel.
3✔
5252
        if p.isActiveChannel(chanID) {
3✔
5253
                p.log.Errorf("Channel(%v) is already active, ignoring "+
×
5254
                        "pending channel request", chanID)
×
5255

×
5256
                return
×
5257
        }
×
5258

5259
        // The channel has already been added, we will do nothing and return.
5260
        if p.isPendingChannel(chanID) {
3✔
5261
                p.log.Infof("Channel(%v) is already added, ignoring "+
×
5262
                        "pending channel request", chanID)
×
5263

×
5264
                return
×
5265
        }
×
5266

5267
        // This is a new channel, we now add it to the map `activeChannels`
5268
        // with nil value and mark it as a newly added channel in
5269
        // `addedChannels`.
5270
        p.activeChannels.Store(chanID, nil)
3✔
5271
        p.addedChannels.Store(chanID, struct{}{})
3✔
5272
}
5273

5274
// handleRemovePendingChannel takes a `newChannelMsg` request and removes it
5275
// from `activeChannels` map. The request will be ignored if the channel is
5276
// considered active by Brontide. Noop if the channel ID cannot be found.
5277
func (p *Brontide) handleRemovePendingChannel(req *newChannelMsg) {
3✔
5278
        defer close(req.err)
3✔
5279

3✔
5280
        chanID := req.channelID
3✔
5281

3✔
5282
        // If we already have this channel, something is wrong with the funding
3✔
5283
        // flow as it will only be marked as active after `ChannelReady` is
3✔
5284
        // handled. In this case, we will log an error and exit.
3✔
5285
        if p.isActiveChannel(chanID) {
3✔
5286
                p.log.Errorf("Channel(%v) is active, ignoring remove request",
×
5287
                        chanID)
×
5288
                return
×
5289
        }
×
5290

5291
        // The channel has not been added yet, we will log a warning as there
5292
        // is an unexpected call from funding manager.
5293
        if !p.isPendingChannel(chanID) {
6✔
5294
                p.log.Warnf("Channel(%v) not found, removing it anyway", chanID)
3✔
5295
        }
3✔
5296

5297
        // Remove the record of this pending channel.
5298
        p.activeChannels.Delete(chanID)
3✔
5299
        p.addedChannels.Delete(chanID)
3✔
5300
}
5301

5302
// sendLinkUpdateMsg sends a message that updates the channel to the
5303
// channel's message stream.
5304
func (p *Brontide) sendLinkUpdateMsg(cid lnwire.ChannelID, msg lnwire.Message) {
3✔
5305
        p.log.Tracef("Sending link update msg=%v", msg.MsgType())
3✔
5306

3✔
5307
        chanStream, ok := p.activeMsgStreams[cid]
3✔
5308
        if !ok {
6✔
5309
                // If a stream hasn't yet been created, then we'll do so, add
3✔
5310
                // it to the map, and finally start it.
3✔
5311
                chanStream = newChanMsgStream(p, cid)
3✔
5312
                p.activeMsgStreams[cid] = chanStream
3✔
5313
                chanStream.Start()
3✔
5314

3✔
5315
                // Stop the stream when quit.
3✔
5316
                go func() {
6✔
5317
                        <-p.cg.Done()
3✔
5318
                        chanStream.Stop()
3✔
5319
                }()
3✔
5320
        }
5321

5322
        // With the stream obtained, add the message to the stream so we can
5323
        // continue processing message.
5324
        chanStream.AddMsg(msg)
3✔
5325
}
5326

5327
// scaleTimeout multiplies the argument duration by a constant factor depending
5328
// on variious heuristics. Currently this is only used to check whether our peer
5329
// appears to be connected over Tor and relaxes the timout deadline. However,
5330
// this is subject to change and should be treated as opaque.
5331
func (p *Brontide) scaleTimeout(timeout time.Duration) time.Duration {
3✔
5332
        if p.isTorConnection {
6✔
5333
                return timeout * time.Duration(torTimeoutMultiplier)
3✔
5334
        }
3✔
5335

5336
        return timeout
×
5337
}
5338

5339
// CoopCloseUpdates is a struct used to communicate updates for an active close
5340
// to the caller.
5341
type CoopCloseUpdates struct {
5342
        UpdateChan chan interface{}
5343

5344
        ErrChan chan error
5345
}
5346

5347
// ChanHasRbfCoopCloser returns true if the channel as identifier by the channel
5348
// point has an active RBF chan closer.
5349
func (p *Brontide) ChanHasRbfCoopCloser(chanPoint wire.OutPoint) bool {
3✔
5350
        chanID := lnwire.NewChanIDFromOutPoint(chanPoint)
3✔
5351
        chanCloser, found := p.activeChanCloses.Load(chanID)
3✔
5352
        if !found {
6✔
5353
                return false
3✔
5354
        }
3✔
5355

5356
        return chanCloser.IsRight()
3✔
5357
}
5358

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

3✔
5367
        // If RBF coop close isn't permitted, then we'll an error.
3✔
5368
        if !p.rbfCoopCloseAllowed() {
3✔
5369
                return nil, fmt.Errorf("rbf coop close not enabled for " +
×
5370
                        "channel")
×
5371
        }
×
5372

5373
        closeUpdates := &CoopCloseUpdates{
3✔
5374
                UpdateChan: make(chan interface{}, 1),
3✔
5375
                ErrChan:    make(chan error, 1),
3✔
5376
        }
3✔
5377

3✔
5378
        // We'll re-use the existing switch struct here, even though we're
3✔
5379
        // bypassing the switch entirely.
3✔
5380
        closeReq := htlcswitch.ChanClose{
3✔
5381
                CloseType:      contractcourt.CloseRegular,
3✔
5382
                ChanPoint:      &chanPoint,
3✔
5383
                TargetFeePerKw: feeRate,
3✔
5384
                DeliveryScript: deliveryScript,
3✔
5385
                Updates:        closeUpdates.UpdateChan,
3✔
5386
                Err:            closeUpdates.ErrChan,
3✔
5387
                Ctx:            ctx,
3✔
5388
        }
3✔
5389

3✔
5390
        err := p.startRbfChanCloser(newRPCShutdownInit(&closeReq), chanPoint)
3✔
5391
        if err != nil {
3✔
5392
                return nil, err
×
5393
        }
×
5394

5395
        return closeUpdates, nil
3✔
5396
}
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