12371948523

Committed 17 Dec 2024 11:19AM UTC coverage: 58.595% (-0.04%) from 58.632%

Build # 12371948523

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #9303 from yyforyongyu/fix-circuit-closed

htlcswitch+routing: handle nil pointer dereference properly

Run Details

34 of 34 new or added lines in 4 files covered. (100.0%)

136 existing lines in 23 files now uncovered.

134361 of 229306 relevant lines covered (58.59%)

19293.66 hits per line

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

88.33

/contractcourt/breach_resolver.go

package contractcourt

import (
        "encoding/binary"
        "io"

        "github.com/lightningnetwork/lnd/channeldb"
)

// breachResolver is a resolver that will handle breached closes. In the
// future, this will likely take over the duties the current BreachArbitrator
// has.
type breachResolver struct {
        // resolved reflects if the contract has been fully resolved or not.
        resolved bool

        // subscribed denotes whether or not the breach resolver has subscribed
        // to the BreachArbitrator for breach resolution.
        subscribed bool

        // replyChan is closed when the breach arbiter has completed serving
        // justice.
        replyChan chan struct{}

        contractResolverKit
}

// newBreachResolver instantiates a new breach resolver.
func newBreachResolver(resCfg ResolverConfig) *breachResolver {
        r := &breachResolver{
                contractResolverKit: *newContractResolverKit(resCfg),
                replyChan:           make(chan struct{}),
        }

        r.initLogger(r)

        return r
}

// ResolverKey returns the unique identifier for this resolver.
func (b *breachResolver) ResolverKey() []byte {
        key := newResolverID(b.ChanPoint)
        return key[:]
}

// Resolve queries the BreachArbitrator to see if the justice transaction has
// been broadcast.
//
// TODO(yy): let sweeper handle the breach inputs.
func (b *breachResolver) Resolve(_ bool) (ContractResolver, error) {
        if !b.subscribed {
                complete, err := b.SubscribeBreachComplete(
                        &b.ChanPoint, b.replyChan,
                )
                if err != nil {
                        return nil, err
                }

                // If the breach resolution process is already complete, then
                // we can cleanup and checkpoint the resolved state.
                if complete {
                        b.resolved = true
                        return nil, b.Checkpoint(b)
                }

                // Prevent duplicate subscriptions.
                b.subscribed = true
        }

        select {
        case <-b.replyChan:
                // The replyChan has been closed, signalling that the breach
                // has been fully resolved. Checkpoint the resolved state and
                // exit.
                b.resolved = true
                return nil, b.Checkpoint(b)
        case <-b.quit:
        }

        return nil, errResolverShuttingDown
}

// Stop signals the breachResolver to stop.
func (b *breachResolver) Stop() {
        close(b.quit)
}

// IsResolved returns true if the breachResolver is fully resolved and cleanup
// can occur.
func (b *breachResolver) IsResolved() bool {
        return b.resolved
}

// SupplementState adds additional state to the breachResolver.
func (b *breachResolver) SupplementState(_ *channeldb.OpenChannel) {
}

// Encode encodes the breachResolver to the passed writer.
func (b *breachResolver) Encode(w io.Writer) error {
        return binary.Write(w, endian, b.resolved)
}

// newBreachResolverFromReader attempts to decode an encoded breachResolver
// from the passed Reader instance, returning an active breachResolver.
func newBreachResolverFromReader(r io.Reader, resCfg ResolverConfig) (
        *breachResolver, error) {

        b := &breachResolver{
                contractResolverKit: *newContractResolverKit(resCfg),
                replyChan:           make(chan struct{}),
        }

        if err := binary.Read(r, endian, &b.resolved); err != nil {
                return nil, err
        }

        b.initLogger(b)

        return b, nil
}

// A compile time assertion to ensure breachResolver meets the ContractResolver
// interface.
var _ ContractResolver = (*breachResolver)(nil)

1	package contractcourt
2
3	import (
4	"encoding/binary"
5	"io"
6
7	"github.com/lightningnetwork/lnd/channeldb"
8	)
9
10	// breachResolver is a resolver that will handle breached closes. In the
11	// future, this will likely take over the duties the current BreachArbitrator
12	// has.
13	type breachResolver struct {
14	// resolved reflects if the contract has been fully resolved or not.
15	resolved bool
16
17	// subscribed denotes whether or not the breach resolver has subscribed
18	// to the BreachArbitrator for breach resolution.
19	subscribed bool
20
21	// replyChan is closed when the breach arbiter has completed serving
22	// justice.
23	replyChan chan struct{}
24
25	contractResolverKit
26	}
27
28	// newBreachResolver instantiates a new breach resolver.
29	func newBreachResolver(resCfg ResolverConfig) *breachResolver {	5✔
30	r := &breachResolver{	5✔
31	contractResolverKit: *newContractResolverKit(resCfg),	5✔
32	replyChan: make(chan struct{}),	5✔
33	}	5✔
34		5✔
35	r.initLogger(r)	5✔
36		5✔
37	return r	5✔
38	}	5✔
39
40	// ResolverKey returns the unique identifier for this resolver.
41	func (b *breachResolver) ResolverKey() []byte {	7✔
42	key := newResolverID(b.ChanPoint)	7✔
43	return key[:]	7✔
44	}	7✔
45
46	// Resolve queries the BreachArbitrator to see if the justice transaction has
47	// been broadcast.
48	//
49	// TODO(yy): let sweeper handle the breach inputs.
50	func (b *breachResolver) Resolve(_ bool) (ContractResolver, error) {	5✔
51	if !b.subscribed {	10✔
52	complete, err := b.SubscribeBreachComplete(	5✔
53	&b.ChanPoint, b.replyChan,	5✔
54	)	5✔
55	if err != nil {	5✔
56	return nil, err	×
57	}	×
58
59	// If the breach resolution process is already complete, then
60	// we can cleanup and checkpoint the resolved state.
61	if complete {	5✔
UNCOV 62	b.resolved = true	×
UNCOV 63	return nil, b.Checkpoint(b)	×
UNCOV 64	}	×
65
66	// Prevent duplicate subscriptions.
67	b.subscribed = true	5✔
68	}
69
70	select {	5✔
71	case <-b.replyChan:	5✔
72	// The replyChan has been closed, signalling that the breach	5✔
73	// has been fully resolved. Checkpoint the resolved state and	5✔
74	// exit.	5✔
75	b.resolved = true	5✔
76	return nil, b.Checkpoint(b)	5✔
77	case <-b.quit:	3✔
78	}
79
80	return nil, errResolverShuttingDown	3✔
81	}
82
83	// Stop signals the breachResolver to stop.
84	func (b *breachResolver) Stop() {	5✔
85	close(b.quit)	5✔
86	}	5✔
87
88	// IsResolved returns true if the breachResolver is fully resolved and cleanup
89	// can occur.
90	func (b *breachResolver) IsResolved() bool {	9✔
91	return b.resolved	9✔
92	}	9✔
93
94	// SupplementState adds additional state to the breachResolver.
95	func (b breachResolver) SupplementState(_ channeldb.OpenChannel) {	3✔
96	}	3✔
97
98	// Encode encodes the breachResolver to the passed writer.
99	func (b *breachResolver) Encode(w io.Writer) error {	3✔
100	return binary.Write(w, endian, b.resolved)	3✔
101	}	3✔
102
103	// newBreachResolverFromReader attempts to decode an encoded breachResolver
104	// from the passed Reader instance, returning an active breachResolver.
105	func newBreachResolverFromReader(r io.Reader, resCfg ResolverConfig) (
106	*breachResolver, error) {	3✔
107		3✔
108	b := &breachResolver{	3✔
109	contractResolverKit: *newContractResolverKit(resCfg),	3✔
110	replyChan: make(chan struct{}),	3✔
111	}	3✔
112		3✔
113	if err := binary.Read(r, endian, &b.resolved); err != nil {	3✔
114	return nil, err	×
115	}	×
116
117	b.initLogger(b)	3✔
118		3✔
119	return b, nil	3✔
120	}
121
122	// A compile time assertion to ensure breachResolver meets the ContractResolver
123	// interface.
124	var _ ContractResolver = (*breachResolver)(nil)

lightningnetwork / lnd / 12371948523

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

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