13985146952

Committed 21 Mar 2025 05:16AM UTC coverage: 57.925% (-1.2%) from 59.126%

Build # 13985146952

Build Type

Pull #9603

github

Committed by

web-flow

Commit Message

Merge 7ae2f3917 into 5d921723b

Pull Request Pull Request #9603: routerrpc: add validation to MPP params

Run Details

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

1989 existing lines in 35 files now uncovered.

94775 of 163617 relevant lines covered (57.92%)

0.61 hits per line

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

89.13

/contractcourt/anchor_resolver.go

package contractcourt

import (
        "errors"
        "fmt"
        "io"
        "sync"

        "github.com/btcsuite/btcd/btcutil"
        "github.com/btcsuite/btcd/chaincfg/chainhash"
        "github.com/btcsuite/btcd/wire"
        "github.com/lightningnetwork/lnd/channeldb"
        "github.com/lightningnetwork/lnd/fn/v2"
        "github.com/lightningnetwork/lnd/input"
        "github.com/lightningnetwork/lnd/sweep"
)

// anchorResolver is a resolver that will attempt to sweep our anchor output.
type anchorResolver struct {
        // anchorSignDescriptor contains the information that is required to
        // sweep the anchor.
        anchorSignDescriptor input.SignDescriptor

        // anchor is the outpoint on the commitment transaction.
        anchor wire.OutPoint

        // broadcastHeight is the height that the original contract was
        // broadcast to the main-chain at. We'll use this value to bound any
        // historical queries to the chain for spends/confirmations.
        broadcastHeight uint32

        // chanPoint is the channel point of the original contract.
        chanPoint wire.OutPoint

        // chanType denotes the type of channel the contract belongs to.
        chanType channeldb.ChannelType

        // currentReport stores the current state of the resolver for reporting
        // over the rpc interface.
        currentReport ContractReport

        // reportLock prevents concurrent access to the resolver report.
        reportLock sync.Mutex

        contractResolverKit
}

// newAnchorResolver instantiates a new anchor resolver.
func newAnchorResolver(anchorSignDescriptor input.SignDescriptor,
        anchor wire.OutPoint, broadcastHeight uint32,
        chanPoint wire.OutPoint, resCfg ResolverConfig) *anchorResolver {

        amt := btcutil.Amount(anchorSignDescriptor.Output.Value)

        report := ContractReport{
                Outpoint:         anchor,
                Type:             ReportOutputAnchor,
                Amount:           amt,
                LimboBalance:     amt,
                RecoveredBalance: 0,
        }

        r := &anchorResolver{
                contractResolverKit:  *newContractResolverKit(resCfg),
                anchorSignDescriptor: anchorSignDescriptor,
                anchor:               anchor,
                broadcastHeight:      broadcastHeight,
                chanPoint:            chanPoint,
                currentReport:        report,
        }

        r.initLogger(fmt.Sprintf("%T(%v)", r, r.anchor))

        return r
}

// ResolverKey returns an identifier which should be globally unique for this
// particular resolver within the chain the original contract resides within.
func (c *anchorResolver) ResolverKey() []byte {
        // The anchor resolver is stateless and doesn't need a database key.
        return nil
}

// Resolve waits for the output to be swept.
//
// NOTE: Part of the ContractResolver interface.
func (c *anchorResolver) Resolve() (ContractResolver, error) {
        // If we're already resolved, then we can exit early.
        if c.IsResolved() {
                c.log.Errorf("already resolved")
                return nil, nil
        }

        var (
                outcome channeldb.ResolverOutcome
                spendTx *chainhash.Hash
        )

        select {
        case sweepRes := <-c.sweepResultChan:
                err := sweepRes.Err

                switch {
                // Anchor was swept successfully.
                case err == nil:
                        sweepTxID := sweepRes.Tx.TxHash()

                        spendTx = &sweepTxID
                        outcome = channeldb.ResolverOutcomeClaimed

                // Anchor was swept by someone else. This is possible after the
                // 16 block csv lock.
                case errors.Is(err, sweep.ErrRemoteSpend),
                        errors.Is(err, sweep.ErrInputMissing):

                        c.log.Warnf("our anchor spent by someone else")
                        outcome = channeldb.ResolverOutcomeUnclaimed

                // An unexpected error occurred.
                default:
                        c.log.Errorf("unable to sweep anchor: %v", sweepRes.Err)

                        return nil, sweepRes.Err
                }

        case <-c.quit:
                return nil, errResolverShuttingDown
        }

        c.log.Infof("resolved in tx %v", spendTx)

        // Update report to reflect that funds are no longer in limbo.
        c.reportLock.Lock()
        if outcome == channeldb.ResolverOutcomeClaimed {
                c.currentReport.RecoveredBalance = c.currentReport.LimboBalance
        }
        c.currentReport.LimboBalance = 0
        report := c.currentReport.resolverReport(
                spendTx, channeldb.ResolverTypeAnchor, outcome,
        )
        c.reportLock.Unlock()

        c.markResolved()
        return nil, c.PutResolverReport(nil, report)
}

// Stop signals the resolver to cancel any current resolution processes, and
// suspend.
//
// NOTE: Part of the ContractResolver interface.
func (c *anchorResolver) Stop() {
        c.log.Debugf("stopping...")
        defer c.log.Debugf("stopped")

        close(c.quit)
}

// SupplementState allows the user of a ContractResolver to supplement it with
// state required for the proper resolution of a contract.
//
// NOTE: Part of the ContractResolver interface.
func (c *anchorResolver) SupplementState(state *channeldb.OpenChannel) {
        c.chanType = state.ChanType
}

// report returns a report on the resolution state of the contract.
func (c *anchorResolver) report() *ContractReport {
        c.reportLock.Lock()
        defer c.reportLock.Unlock()

        reportCopy := c.currentReport
        return &reportCopy
}

func (c *anchorResolver) Encode(w io.Writer) error {
        return errors.New("serialization not supported")
}

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

// Launch offers the anchor output to the sweeper.
func (c *anchorResolver) Launch() error {
        if c.isLaunched() {
                c.log.Tracef("already launched")
                return nil
        }

        c.log.Debugf("launching resolver...")
        c.markLaunched()

        // If we're already resolved, then we can exit early.
        if c.IsResolved() {
                c.log.Errorf("already resolved")
                return nil
        }

        // Attempt to update the sweep parameters to the post-confirmation
        // situation. We don't want to force sweep anymore, because the anchor
        // lost its special purpose to get the commitment confirmed. It is just
        // an output that we want to sweep only if it is economical to do so.
        //
        // An exclusive group is not necessary anymore, because we know that
        // this is the only anchor that can be swept.
        //
        // We also clear the parent tx information for cpfp, because the
        // commitment tx is confirmed.
        //
        // After a restart or when the remote force closes, the sweeper is not
        // yet aware of the anchor. In that case, it will be added as new input
        // to the sweeper.
        witnessType := input.CommitmentAnchor

        // For taproot channels, we need to use the proper witness type.
        if c.chanType.IsTaproot() {
                witnessType = input.TaprootAnchorSweepSpend
        }

        anchorInput := input.MakeBaseInput(
                &c.anchor, witnessType, &c.anchorSignDescriptor,
                c.broadcastHeight, nil,
        )

        resultChan, err := c.Sweeper.SweepInput(
                &anchorInput,
                sweep.Params{
                        // For normal anchor sweeping, the budget is 330 sats.
                        Budget: btcutil.Amount(
                                anchorInput.SignDesc().Output.Value,
                        ),

                        // There's no rush to sweep the anchor, so we use a nil
                        // deadline here.
                        DeadlineHeight: fn.None[int32](),
                },
        )

        if err != nil {
                return err
        }

        c.sweepResultChan = resultChan

        return nil
}

1	package contractcourt
2
3	import (
4	"errors"
5	"fmt"
6	"io"
7	"sync"
8
9	"github.com/btcsuite/btcd/btcutil"
10	"github.com/btcsuite/btcd/chaincfg/chainhash"
11	"github.com/btcsuite/btcd/wire"
12	"github.com/lightningnetwork/lnd/channeldb"
13	"github.com/lightningnetwork/lnd/fn/v2"
14	"github.com/lightningnetwork/lnd/input"
15	"github.com/lightningnetwork/lnd/sweep"
16	)
17
18	// anchorResolver is a resolver that will attempt to sweep our anchor output.
19	type anchorResolver struct {
20	// anchorSignDescriptor contains the information that is required to
21	// sweep the anchor.
22	anchorSignDescriptor input.SignDescriptor
23
24	// anchor is the outpoint on the commitment transaction.
25	anchor wire.OutPoint
26
27	// broadcastHeight is the height that the original contract was
28	// broadcast to the main-chain at. We'll use this value to bound any
29	// historical queries to the chain for spends/confirmations.
30	broadcastHeight uint32
31
32	// chanPoint is the channel point of the original contract.
33	chanPoint wire.OutPoint
34
35	// chanType denotes the type of channel the contract belongs to.
36	chanType channeldb.ChannelType
37
38	// currentReport stores the current state of the resolver for reporting
39	// over the rpc interface.
40	currentReport ContractReport
41
42	// reportLock prevents concurrent access to the resolver report.
43	reportLock sync.Mutex
44
45	contractResolverKit
46	}
47
48	// newAnchorResolver instantiates a new anchor resolver.
49	func newAnchorResolver(anchorSignDescriptor input.SignDescriptor,
50	anchor wire.OutPoint, broadcastHeight uint32,
51	chanPoint wire.OutPoint, resCfg ResolverConfig) *anchorResolver {	1✔
52		1✔
53	amt := btcutil.Amount(anchorSignDescriptor.Output.Value)	1✔
54		1✔
55	report := ContractReport{	1✔
56	Outpoint: anchor,	1✔
57	Type: ReportOutputAnchor,	1✔
58	Amount: amt,	1✔
59	LimboBalance: amt,	1✔
60	RecoveredBalance: 0,	1✔
61	}	1✔
62		1✔
63	r := &anchorResolver{	1✔
64	contractResolverKit: *newContractResolverKit(resCfg),	1✔
65	anchorSignDescriptor: anchorSignDescriptor,	1✔
66	anchor: anchor,	1✔
67	broadcastHeight: broadcastHeight,	1✔
68	chanPoint: chanPoint,	1✔
69	currentReport: report,	1✔
70	}	1✔
71		1✔
72	r.initLogger(fmt.Sprintf("%T(%v)", r, r.anchor))	1✔
73		1✔
74	return r	1✔
75	}	1✔
76
77	// ResolverKey returns an identifier which should be globally unique for this
78	// particular resolver within the chain the original contract resides within.
79	func (c *anchorResolver) ResolverKey() []byte {	1✔
80	// The anchor resolver is stateless and doesn't need a database key.	1✔
81	return nil	1✔
82	}	1✔
83
84	// Resolve waits for the output to be swept.
85	//
86	// NOTE: Part of the ContractResolver interface.
87	func (c *anchorResolver) Resolve() (ContractResolver, error) {	1✔
88	// If we're already resolved, then we can exit early.	1✔
89	if c.IsResolved() {	1✔
90	c.log.Errorf("already resolved")	×
91	return nil, nil	×
92	}	×
93
94	var (	1✔
95	outcome channeldb.ResolverOutcome	1✔
96	spendTx *chainhash.Hash	1✔
97	)	1✔
98		1✔
99	select {	1✔
100	case sweepRes := <-c.sweepResultChan:	1✔
101	err := sweepRes.Err	1✔
102		1✔
103	switch {	1✔
104	// Anchor was swept successfully.
105	case err == nil:	1✔
106	sweepTxID := sweepRes.Tx.TxHash()	1✔
107		1✔
108	spendTx = &sweepTxID	1✔
109	outcome = channeldb.ResolverOutcomeClaimed	1✔
110
111	// Anchor was swept by someone else. This is possible after the
112	// 16 block csv lock.
113	case errors.Is(err, sweep.ErrRemoteSpend),
114	errors.Is(err, sweep.ErrInputMissing):	1✔
115		1✔
116	c.log.Warnf("our anchor spent by someone else")	1✔
117	outcome = channeldb.ResolverOutcomeUnclaimed	1✔
118
119	// An unexpected error occurred.
UNCOV 120	default:	×
UNCOV 121	c.log.Errorf("unable to sweep anchor: %v", sweepRes.Err)	×
UNCOV 122		×
UNCOV 123	return nil, sweepRes.Err	×
124	}
125
126	case <-c.quit:	1✔
127	return nil, errResolverShuttingDown	1✔
128	}
129
130	c.log.Infof("resolved in tx %v", spendTx)	1✔
131		1✔
132	// Update report to reflect that funds are no longer in limbo.	1✔
133	c.reportLock.Lock()	1✔
134	if outcome == channeldb.ResolverOutcomeClaimed {	2✔
135	c.currentReport.RecoveredBalance = c.currentReport.LimboBalance	1✔
136	}	1✔
137	c.currentReport.LimboBalance = 0	1✔
138	report := c.currentReport.resolverReport(	1✔
139	spendTx, channeldb.ResolverTypeAnchor, outcome,	1✔
140	)	1✔
141	c.reportLock.Unlock()	1✔
142		1✔
143	c.markResolved()	1✔
144	return nil, c.PutResolverReport(nil, report)	1✔
145	}
146
147	// Stop signals the resolver to cancel any current resolution processes, and
148	// suspend.
149	//
150	// NOTE: Part of the ContractResolver interface.
151	func (c *anchorResolver) Stop() {	1✔
152	c.log.Debugf("stopping...")	1✔
153	defer c.log.Debugf("stopped")	1✔
154		1✔
155	close(c.quit)	1✔
156	}	1✔
157
158	// SupplementState allows the user of a ContractResolver to supplement it with
159	// state required for the proper resolution of a contract.
160	//
161	// NOTE: Part of the ContractResolver interface.
162	func (c anchorResolver) SupplementState(state channeldb.OpenChannel) {	1✔
163	c.chanType = state.ChanType	1✔
164	}	1✔
165
166	// report returns a report on the resolution state of the contract.
167	func (c anchorResolver) report() ContractReport {	1✔
168	c.reportLock.Lock()	1✔
169	defer c.reportLock.Unlock()	1✔
170		1✔
171	reportCopy := c.currentReport	1✔
172	return &reportCopy	1✔
173	}	1✔
174
175	func (c *anchorResolver) Encode(w io.Writer) error {	×
176	return errors.New("serialization not supported")	×
177	}	×
178
179	// A compile time assertion to ensure anchorResolver meets the
180	// ContractResolver interface.
181	var _ ContractResolver = (*anchorResolver)(nil)
182
183	// Launch offers the anchor output to the sweeper.
184	func (c *anchorResolver) Launch() error {	1✔
185	if c.isLaunched() {	2✔
186	c.log.Tracef("already launched")	1✔
187	return nil	1✔
188	}	1✔
189
190	c.log.Debugf("launching resolver...")	1✔
191	c.markLaunched()	1✔
192		1✔
193	// If we're already resolved, then we can exit early.	1✔
194	if c.IsResolved() {	1✔
195	c.log.Errorf("already resolved")	×
196	return nil	×
197	}	×
198
199	// Attempt to update the sweep parameters to the post-confirmation
200	// situation. We don't want to force sweep anymore, because the anchor
201	// lost its special purpose to get the commitment confirmed. It is just
202	// an output that we want to sweep only if it is economical to do so.
203	//
204	// An exclusive group is not necessary anymore, because we know that
205	// this is the only anchor that can be swept.
206	//
207	// We also clear the parent tx information for cpfp, because the
208	// commitment tx is confirmed.
209	//
210	// After a restart or when the remote force closes, the sweeper is not
211	// yet aware of the anchor. In that case, it will be added as new input
212	// to the sweeper.
213	witnessType := input.CommitmentAnchor	1✔
214		1✔
215	// For taproot channels, we need to use the proper witness type.	1✔
216	if c.chanType.IsTaproot() {	2✔
217	witnessType = input.TaprootAnchorSweepSpend	1✔
218	}	1✔
219
220	anchorInput := input.MakeBaseInput(	1✔
221	&c.anchor, witnessType, &c.anchorSignDescriptor,	1✔
222	c.broadcastHeight, nil,	1✔
223	)	1✔
224		1✔
225	resultChan, err := c.Sweeper.SweepInput(	1✔
226	&anchorInput,	1✔
227	sweep.Params{	1✔
228	// For normal anchor sweeping, the budget is 330 sats.	1✔
229	Budget: btcutil.Amount(	1✔
230	anchorInput.SignDesc().Output.Value,	1✔
231	),	1✔
232		1✔
233	// There's no rush to sweep the anchor, so we use a nil	1✔
234	// deadline here.	1✔
235	DeadlineHeight: fn.None[int32](),	1✔
236	},	1✔
237	)	1✔
238		1✔
239	if err != nil {	1✔
240	return err	×
241	}	×
242
243	c.sweepResultChan = resultChan	1✔
244		1✔
245	return nil	1✔
246	}

lightningnetwork / lnd / 13985146952

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