12199391122

Committed 06 Dec 2024 01:10PM UTC coverage: 49.807% (-9.1%) from 58.933%

Build # 12199391122

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #9337 from Guayaba221/patch-1

chore: fix typo in ruby.md

Run Details

100137 of 201051 relevant lines covered (49.81%)

2.07 hits per line

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

78.95

/chanbackup/backup.go

package chanbackup

import (
        "fmt"

        "github.com/btcsuite/btcd/wire"
        "github.com/lightningnetwork/lnd/channeldb"
        "github.com/lightningnetwork/lnd/fn"
)

// LiveChannelSource is an interface that allows us to query for the set of
// live channels. A live channel is one that is open, and has not had a
// commitment transaction broadcast.
type LiveChannelSource interface {
        // FetchAllChannels returns all known live channels.
        FetchAllChannels() ([]*channeldb.OpenChannel, error)

        // FetchChannel attempts to locate a live channel identified by the
        // passed chanPoint. Optionally an existing db tx can be supplied.
        FetchChannel(chanPoint wire.OutPoint) (*channeldb.OpenChannel, error)
}

// assembleChanBackup attempts to assemble a static channel backup for the
// passed open channel. The backup includes all information required to restore
// the channel, as well as addressing information so we can find the peer and
// reconnect to them to initiate the protocol.
func assembleChanBackup(addrSource channeldb.AddrSource,
        openChan *channeldb.OpenChannel) (*Single, error) {

        log.Debugf("Crafting backup for ChannelPoint(%v)",
                openChan.FundingOutpoint)

        // First, we'll query the channel source to obtain all the addresses
        // that are associated with the peer for this channel.
        known, nodeAddrs, err := addrSource.AddrsForNode(openChan.IdentityPub)
        if err != nil {
                return nil, err
        }
        if !known {
                return nil, fmt.Errorf("node unknown by address source")
        }

        single := NewSingle(openChan, nodeAddrs)

        return &single, nil
}

// buildCloseTxInputs generates inputs needed to force close a channel from
// an open channel. Anyone having these inputs and the signer, can sign the
// force closure transaction. Warning! If the channel state updates, an attempt
// to close the channel using this method with outdated CloseTxInputs can result
// in loss of funds! This may happen if an outdated channel backup is attempted
// to be used to force close the channel.
func buildCloseTxInputs(
        targetChan *channeldb.OpenChannel) fn.Option[CloseTxInputs] {

        log.Debugf("Crafting CloseTxInputs for ChannelPoint(%v)",
                targetChan.FundingOutpoint)

        localCommit := targetChan.LocalCommitment

        if localCommit.CommitTx == nil {
                log.Infof("CommitTx is nil for ChannelPoint(%v), "+
                        "skipping CloseTxInputs. This is possible when "+
                        "DLP is active.", targetChan.FundingOutpoint)

                return fn.None[CloseTxInputs]()
        }

        // We need unsigned force close tx and the counterparty's signature.
        inputs := CloseTxInputs{
                CommitTx:  localCommit.CommitTx,
                CommitSig: localCommit.CommitSig,
        }

        // In case of a taproot channel, commit height is needed as well to
        // produce verification nonce for the taproot channel using shachain.
        if targetChan.ChanType.IsTaproot() {
                inputs.CommitHeight = localCommit.CommitHeight
        }

        // In case of a custom taproot channel, TapscriptRoot is needed as well.
        if targetChan.ChanType.HasTapscriptRoot() {
                inputs.TapscriptRoot = targetChan.TapscriptRoot
        }

        return fn.Some(inputs)
}

// FetchBackupForChan attempts to create a plaintext static channel backup for
// the target channel identified by its channel point. If we're unable to find
// the target channel, then an error will be returned.
func FetchBackupForChan(chanPoint wire.OutPoint, chanSource LiveChannelSource,
        addrSource channeldb.AddrSource) (*Single, error) {

        // First, we'll query the channel source to see if the channel is known
        // and open within the database.
        targetChan, err := chanSource.FetchChannel(chanPoint)
        if err != nil {
                // If we can't find the channel, then we return with an error,
                // as we have nothing to  backup.
                return nil, fmt.Errorf("unable to find target channel")
        }

        // Once we have the target channel, we can assemble the backup using
        // the source to obtain any extra information that we may need.
        staticChanBackup, err := assembleChanBackup(addrSource, targetChan)
        if err != nil {
                return nil, fmt.Errorf("unable to create chan backup: %w", err)
        }

        return staticChanBackup, nil
}

// FetchStaticChanBackups will return a plaintext static channel back up for
// all known active/open channels within the passed channel source.
func FetchStaticChanBackups(chanSource LiveChannelSource,
        addrSource channeldb.AddrSource) ([]Single, error) {

        // First, we'll query the backup source for information concerning all
        // currently open and available channels.
        openChans, err := chanSource.FetchAllChannels()
        if err != nil {
                return nil, err
        }

        // Now that we have all the channels, we'll use the chanSource to
        // obtain any auxiliary information we need to craft a backup for each
        // channel.
        staticChanBackups := make([]Single, 0, len(openChans))
        for _, openChan := range openChans {
                chanBackup, err := assembleChanBackup(addrSource, openChan)
                if err != nil {
                        return nil, err
                }

                staticChanBackups = append(staticChanBackups, *chanBackup)
        }

        return staticChanBackups, nil
}

1	package chanbackup
2
3	import (
4	"fmt"
5
6	"github.com/btcsuite/btcd/wire"
7	"github.com/lightningnetwork/lnd/channeldb"
8	"github.com/lightningnetwork/lnd/fn"
9	)
10
11	// LiveChannelSource is an interface that allows us to query for the set of
12	// live channels. A live channel is one that is open, and has not had a
13	// commitment transaction broadcast.
14	type LiveChannelSource interface {
15	// FetchAllChannels returns all known live channels.
16	FetchAllChannels() ([]*channeldb.OpenChannel, error)
17
18	// FetchChannel attempts to locate a live channel identified by the
19	// passed chanPoint. Optionally an existing db tx can be supplied.
20	FetchChannel(chanPoint wire.OutPoint) (*channeldb.OpenChannel, error)
21	}
22
23	// assembleChanBackup attempts to assemble a static channel backup for the
24	// passed open channel. The backup includes all information required to restore
25	// the channel, as well as addressing information so we can find the peer and
26	// reconnect to them to initiate the protocol.
27	func assembleChanBackup(addrSource channeldb.AddrSource,
28	openChan channeldb.OpenChannel) (Single, error) {	4✔
29		4✔
30	log.Debugf("Crafting backup for ChannelPoint(%v)",	4✔
31	openChan.FundingOutpoint)	4✔
32		4✔
33	// First, we'll query the channel source to obtain all the addresses	4✔
34	// that are associated with the peer for this channel.	4✔
35	known, nodeAddrs, err := addrSource.AddrsForNode(openChan.IdentityPub)	4✔
36	if err != nil {	4✔
37	return nil, err	×
38	}	×
39	if !known {	4✔
40	return nil, fmt.Errorf("node unknown by address source")	×
41	}	×
42
43	single := NewSingle(openChan, nodeAddrs)	4✔
44		4✔
45	return &single, nil	4✔
46	}
47
48	// buildCloseTxInputs generates inputs needed to force close a channel from
49	// an open channel. Anyone having these inputs and the signer, can sign the
50	// force closure transaction. Warning! If the channel state updates, an attempt
51	// to close the channel using this method with outdated CloseTxInputs can result
52	// in loss of funds! This may happen if an outdated channel backup is attempted
53	// to be used to force close the channel.
54	func buildCloseTxInputs(
55	targetChan *channeldb.OpenChannel) fn.Option[CloseTxInputs] {	4✔
56		4✔
57	log.Debugf("Crafting CloseTxInputs for ChannelPoint(%v)",	4✔
58	targetChan.FundingOutpoint)	4✔
59		4✔
60	localCommit := targetChan.LocalCommitment	4✔
61		4✔
62	if localCommit.CommitTx == nil {	8✔
63	log.Infof("CommitTx is nil for ChannelPoint(%v), "+	4✔
64	"skipping CloseTxInputs. This is possible when "+	4✔
65	"DLP is active.", targetChan.FundingOutpoint)	4✔
66		4✔
67	return fn.None[CloseTxInputs]()	4✔
68	}	4✔
69
70	// We need unsigned force close tx and the counterparty's signature.
71	inputs := CloseTxInputs{	4✔
72	CommitTx: localCommit.CommitTx,	4✔
73	CommitSig: localCommit.CommitSig,	4✔
74	}	4✔
75		4✔
76	// In case of a taproot channel, commit height is needed as well to	4✔
77	// produce verification nonce for the taproot channel using shachain.	4✔
78	if targetChan.ChanType.IsTaproot() {	8✔
79	inputs.CommitHeight = localCommit.CommitHeight	4✔
80	}	4✔
81
82	// In case of a custom taproot channel, TapscriptRoot is needed as well.
83	if targetChan.ChanType.HasTapscriptRoot() {	4✔
84	inputs.TapscriptRoot = targetChan.TapscriptRoot	×
85	}	×
86
87	return fn.Some(inputs)	4✔
88	}
89
90	// FetchBackupForChan attempts to create a plaintext static channel backup for
91	// the target channel identified by its channel point. If we're unable to find
92	// the target channel, then an error will be returned.
93	func FetchBackupForChan(chanPoint wire.OutPoint, chanSource LiveChannelSource,
94	addrSource channeldb.AddrSource) (*Single, error) {	4✔
95		4✔
96	// First, we'll query the channel source to see if the channel is known	4✔
97	// and open within the database.	4✔
98	targetChan, err := chanSource.FetchChannel(chanPoint)	4✔
99	if err != nil {	4✔
100	// If we can't find the channel, then we return with an error,	×
101	// as we have nothing to backup.	×
102	return nil, fmt.Errorf("unable to find target channel")	×
103	}	×
104
105	// Once we have the target channel, we can assemble the backup using
106	// the source to obtain any extra information that we may need.
107	staticChanBackup, err := assembleChanBackup(addrSource, targetChan)	4✔
108	if err != nil {	4✔
109	return nil, fmt.Errorf("unable to create chan backup: %w", err)	×
110	}	×
111
112	return staticChanBackup, nil	4✔
113	}
114
115	// FetchStaticChanBackups will return a plaintext static channel back up for
116	// all known active/open channels within the passed channel source.
117	func FetchStaticChanBackups(chanSource LiveChannelSource,
118	addrSource channeldb.AddrSource) ([]Single, error) {	4✔
119		4✔
120	// First, we'll query the backup source for information concerning all	4✔
121	// currently open and available channels.	4✔
122	openChans, err := chanSource.FetchAllChannels()	4✔
123	if err != nil {	4✔
124	return nil, err	×
125	}	×
126
127	// Now that we have all the channels, we'll use the chanSource to
128	// obtain any auxiliary information we need to craft a backup for each
129	// channel.
130	staticChanBackups := make([]Single, 0, len(openChans))	4✔
131	for _, openChan := range openChans {	8✔
132	chanBackup, err := assembleChanBackup(addrSource, openChan)	4✔
133	if err != nil {	4✔
134	return nil, err	×
135	}	×
136
137	staticChanBackups = append(staticChanBackups, *chanBackup)	4✔
138	}
139
140	return staticChanBackups, nil	4✔
141	}

lightningnetwork / lnd / 12199391122

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