12168656289

Committed 04 Dec 2024 09:30PM UTC coverage: 49.3% (-9.5%) from 58.789%

Build # 12168656289

Build Type

Pull #9316

github

Committed by

ziggie1984

Commit Message

docs: add release-notes.

Pull Request Pull Request #9316: routing: fix mc blinded path behaviour.

Run Details

75 of 79 new or added lines in 4 files covered. (94.94%)

26127 existing lines in 423 files now uncovered.

99116 of 201048 relevant lines covered (49.3%)

1.56 hits per line

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

59.85

/routing/bandwidth.go

package routing

import (
        "fmt"

        "github.com/lightningnetwork/lnd/fn"
        graphdb "github.com/lightningnetwork/lnd/graph/db"
        "github.com/lightningnetwork/lnd/htlcswitch"
        "github.com/lightningnetwork/lnd/lnwire"
        "github.com/lightningnetwork/lnd/routing/route"
        "github.com/lightningnetwork/lnd/tlv"
)

// bandwidthHints provides hints about the currently available balance in our
// channels.
type bandwidthHints interface {
        // availableChanBandwidth returns the total available bandwidth for a
        // channel and a bool indicating whether the channel hint was found.
        // The amount parameter is used to validate the outgoing htlc amount
        // that we wish to add to the channel against its flow restrictions. If
        // a zero amount is provided, the minimum htlc value for the channel
        // will be used. If the channel is unavailable, a zero amount is
        // returned.
        availableChanBandwidth(channelID uint64,
                amount lnwire.MilliSatoshi) (lnwire.MilliSatoshi, bool)

        // firstHopCustomBlob returns the custom blob for the first hop of the
        // payment, if available.
        firstHopCustomBlob() fn.Option[tlv.Blob]
}

// TlvTrafficShaper is an interface that allows the sender to determine if a
// payment should be carried by a channel based on the TLV records that may be
// present in the `update_add_htlc` message or the channel commitment itself.
type TlvTrafficShaper interface {
        AuxHtlcModifier

        // ShouldHandleTraffic is called in order to check if the channel
        // identified by the provided channel ID may have external mechanisms
        // that would allow it to carry out the payment.
        ShouldHandleTraffic(cid lnwire.ShortChannelID,
                fundingBlob fn.Option[tlv.Blob]) (bool, error)

        // PaymentBandwidth returns the available bandwidth for a custom channel
        // decided by the given channel aux blob and HTLC blob. A return value
        // of 0 means there is no bandwidth available. To find out if a channel
        // is a custom channel that should be handled by the traffic shaper, the
        // HandleTraffic method should be called first.
        PaymentBandwidth(htlcBlob, commitmentBlob fn.Option[tlv.Blob],
                linkBandwidth,
                htlcAmt lnwire.MilliSatoshi) (lnwire.MilliSatoshi, error)
}

// AuxHtlcModifier is an interface that allows the sender to modify the outgoing
// HTLC of a payment by changing the amount or the wire message tlv records.
type AuxHtlcModifier interface {
        // ProduceHtlcExtraData is a function that, based on the previous extra
        // data blob of an HTLC, may produce a different blob or modify the
        // amount of bitcoin this htlc should carry.
        ProduceHtlcExtraData(totalAmount lnwire.MilliSatoshi,
                htlcCustomRecords lnwire.CustomRecords) (lnwire.MilliSatoshi,
                lnwire.CustomRecords, error)
}

// getLinkQuery is the function signature used to lookup a link.
type getLinkQuery func(lnwire.ShortChannelID) (
        htlcswitch.ChannelLink, error)

// bandwidthManager is an implementation of the bandwidthHints interface which
// uses the link lookup provided to query the link for our latest local channel
// balances.
type bandwidthManager struct {
        getLink       getLinkQuery
        localChans    map[lnwire.ShortChannelID]struct{}
        firstHopBlob  fn.Option[tlv.Blob]
        trafficShaper fn.Option[TlvTrafficShaper]
}

// newBandwidthManager creates a bandwidth manager for the source node provided
// which is used to obtain hints from the lower layer w.r.t the available
// bandwidth of edges on the network. Currently, we'll only obtain bandwidth
// hints for the edges we directly have open ourselves. Obtaining these hints
// allows us to reduce the number of extraneous attempts as we can skip channels
// that are inactive, or just don't have enough bandwidth to carry the payment.
func newBandwidthManager(graph Graph, sourceNode route.Vertex,
        linkQuery getLinkQuery, firstHopBlob fn.Option[tlv.Blob],
        trafficShaper fn.Option[TlvTrafficShaper]) (*bandwidthManager, error) {

        manager := &bandwidthManager{
                getLink:       linkQuery,
                localChans:    make(map[lnwire.ShortChannelID]struct{}),
                firstHopBlob:  firstHopBlob,
                trafficShaper: trafficShaper,
        }

        // First, we'll collect the set of outbound edges from the target
        // source node and add them to our bandwidth manager's map of channels.
        err := graph.ForEachNodeChannel(sourceNode,
                func(channel *graphdb.DirectedChannel) error {
                        shortID := lnwire.NewShortChanIDFromInt(
                                channel.ChannelID,
                        )
                        manager.localChans[shortID] = struct{}{}

                        return nil
                })

        if err != nil {
                return nil, err
        }

        return manager, nil
}

// getBandwidth queries the current state of a link and gets its currently
// available bandwidth. Note that this function assumes that the channel being
// queried is one of our local channels, so any failure to retrieve the link
// is interpreted as the link being offline.
func (b *bandwidthManager) getBandwidth(cid lnwire.ShortChannelID,
        amount lnwire.MilliSatoshi) lnwire.MilliSatoshi {

        link, err := b.getLink(cid)
        if err != nil {
                // If the link isn't online, then we'll report that it has
                // zero bandwidth.
                log.Warnf("ShortChannelID=%v: link not found: %v", cid, err)
                return 0
        }

        // If the link is found within the switch, but it isn't yet eligible
        // to forward any HTLCs, then we'll treat it as if it isn't online in
        // the first place.
        if !link.EligibleToForward() {
                log.Warnf("ShortChannelID=%v: not eligible to forward", cid)
                return 0
        }

        // bandwidthResult is an inline type that we'll use to pass the
        // bandwidth result from the external traffic shaper to the main logic
        // below.
        type bandwidthResult struct {
                // bandwidth is the available bandwidth for the channel as
                // reported by the external traffic shaper. If the external
                // traffic shaper is not handling the channel, this value will
                // be fn.None
                bandwidth fn.Option[lnwire.MilliSatoshi]

                // htlcAmount is the amount we're going to use to check if we
                // can add another HTLC to the channel. If the external traffic
                // shaper is handling the channel, we'll use 0 to just sanity
                // check the number of HTLCs on the channel, since we don't know
                // the actual HTLC amount that will be sent.
                htlcAmount fn.Option[lnwire.MilliSatoshi]
        }

        var (
                // We will pass the link bandwidth to the external traffic
                // shaper. This is the current best estimate for the available
                // bandwidth for the link.
                linkBandwidth = link.Bandwidth()

                bandwidthErr = func(err error) fn.Result[bandwidthResult] {
                        return fn.Err[bandwidthResult](err)
                }
        )

        result, err := fn.MapOptionZ(
                b.trafficShaper,
                func(ts TlvTrafficShaper) fn.Result[bandwidthResult] {
                        fundingBlob := link.FundingCustomBlob()
                        shouldHandle, err := ts.ShouldHandleTraffic(
                                cid, fundingBlob,
                        )
                        if err != nil {
                                return bandwidthErr(fmt.Errorf("traffic "+
                                        "shaper failed to decide whether to "+
                                        "handle traffic: %w", err))
                        }

                        log.Debugf("ShortChannelID=%v: external traffic "+
                                "shaper is handling traffic: %v", cid,
                                shouldHandle)

                        // If this channel isn't handled by the external traffic
                        // shaper, we'll return early.
                        if !shouldHandle {
                                return fn.Ok(bandwidthResult{})
                        }

                        // Ask for a specific bandwidth to be used for the
                        // channel.
                        commitmentBlob := link.CommitmentCustomBlob()
                        auxBandwidth, err := ts.PaymentBandwidth(
                                b.firstHopBlob, commitmentBlob, linkBandwidth,
                                amount,
                        )
                        if err != nil {
                                return bandwidthErr(fmt.Errorf("failed to get "+
                                        "bandwidth from external traffic "+
                                        "shaper: %w", err))
                        }

                        log.Debugf("ShortChannelID=%v: external traffic "+
                                "shaper reported available bandwidth: %v", cid,
                                auxBandwidth)

                        // We don't know the actual HTLC amount that will be
                        // sent using the custom channel. But we'll still want
                        // to make sure we can add another HTLC, using the
                        // MayAddOutgoingHtlc method below. Passing 0 into that
                        // method will use the minimum HTLC value for the
                        // channel, which is okay to just check we don't exceed
                        // the max number of HTLCs on the channel. A proper
                        // balance check is done elsewhere.
                        return fn.Ok(bandwidthResult{
                                bandwidth:  fn.Some(auxBandwidth),
                                htlcAmount: fn.Some[lnwire.MilliSatoshi](0),
                        })
                },
        ).Unpack()
        if err != nil {
                log.Errorf("ShortChannelID=%v: failed to get bandwidth from "+
                        "external traffic shaper: %v", cid, err)

                return 0
        }

        htlcAmount := result.htlcAmount.UnwrapOr(amount)

        // If our link isn't currently in a state where it can add another
        // outgoing htlc, treat the link as unusable.
        if err := link.MayAddOutgoingHtlc(htlcAmount); err != nil {
                log.Warnf("ShortChannelID=%v: cannot add outgoing "+
                        "htlc with amount %v: %v", cid, htlcAmount, err)
                return 0
        }

        // If the external traffic shaper determined the bandwidth, we'll return
        // that value, even if it is zero (which would mean no bandwidth is
        // available on that channel).
        reportedBandwidth := result.bandwidth.UnwrapOr(linkBandwidth)

        return reportedBandwidth
}

// availableChanBandwidth returns the total available bandwidth for a channel
// and a bool indicating whether the channel hint was found. If the channel is
// unavailable, a zero amount is returned.
func (b *bandwidthManager) availableChanBandwidth(channelID uint64,
        amount lnwire.MilliSatoshi) (lnwire.MilliSatoshi, bool) {

        shortID := lnwire.NewShortChanIDFromInt(channelID)
        _, ok := b.localChans[shortID]
        if !ok {
                return 0, false
        }

        return b.getBandwidth(shortID, amount), true
}

// firstHopCustomBlob returns the custom blob for the first hop of the payment,
// if available.
func (b *bandwidthManager) firstHopCustomBlob() fn.Option[tlv.Blob] {
        return b.firstHopBlob
}

1	package routing
2
3	import (
4	"fmt"
5
6	"github.com/lightningnetwork/lnd/fn"
7	graphdb "github.com/lightningnetwork/lnd/graph/db"
8	"github.com/lightningnetwork/lnd/htlcswitch"
9	"github.com/lightningnetwork/lnd/lnwire"
10	"github.com/lightningnetwork/lnd/routing/route"
11	"github.com/lightningnetwork/lnd/tlv"
12	)
13
14	// bandwidthHints provides hints about the currently available balance in our
15	// channels.
16	type bandwidthHints interface {
17	// availableChanBandwidth returns the total available bandwidth for a
18	// channel and a bool indicating whether the channel hint was found.
19	// The amount parameter is used to validate the outgoing htlc amount
20	// that we wish to add to the channel against its flow restrictions. If
21	// a zero amount is provided, the minimum htlc value for the channel
22	// will be used. If the channel is unavailable, a zero amount is
23	// returned.
24	availableChanBandwidth(channelID uint64,
25	amount lnwire.MilliSatoshi) (lnwire.MilliSatoshi, bool)
26
27	// firstHopCustomBlob returns the custom blob for the first hop of the
28	// payment, if available.
29	firstHopCustomBlob() fn.Option[tlv.Blob]
30	}
31
32	// TlvTrafficShaper is an interface that allows the sender to determine if a
33	// payment should be carried by a channel based on the TLV records that may be
34	// present in the `update_add_htlc` message or the channel commitment itself.
35	type TlvTrafficShaper interface {
36	AuxHtlcModifier
37
38	// ShouldHandleTraffic is called in order to check if the channel
39	// identified by the provided channel ID may have external mechanisms
40	// that would allow it to carry out the payment.
41	ShouldHandleTraffic(cid lnwire.ShortChannelID,
42	fundingBlob fn.Option[tlv.Blob]) (bool, error)
43
44	// PaymentBandwidth returns the available bandwidth for a custom channel
45	// decided by the given channel aux blob and HTLC blob. A return value
46	// of 0 means there is no bandwidth available. To find out if a channel
47	// is a custom channel that should be handled by the traffic shaper, the
48	// HandleTraffic method should be called first.
49	PaymentBandwidth(htlcBlob, commitmentBlob fn.Option[tlv.Blob],
50	linkBandwidth,
51	htlcAmt lnwire.MilliSatoshi) (lnwire.MilliSatoshi, error)
52	}
53
54	// AuxHtlcModifier is an interface that allows the sender to modify the outgoing
55	// HTLC of a payment by changing the amount or the wire message tlv records.
56	type AuxHtlcModifier interface {
57	// ProduceHtlcExtraData is a function that, based on the previous extra
58	// data blob of an HTLC, may produce a different blob or modify the
59	// amount of bitcoin this htlc should carry.
60	ProduceHtlcExtraData(totalAmount lnwire.MilliSatoshi,
61	htlcCustomRecords lnwire.CustomRecords) (lnwire.MilliSatoshi,
62	lnwire.CustomRecords, error)
63	}
64
65	// getLinkQuery is the function signature used to lookup a link.
66	type getLinkQuery func(lnwire.ShortChannelID) (
67	htlcswitch.ChannelLink, error)
68
69	// bandwidthManager is an implementation of the bandwidthHints interface which
70	// uses the link lookup provided to query the link for our latest local channel
71	// balances.
72	type bandwidthManager struct {
73	getLink getLinkQuery
74	localChans map[lnwire.ShortChannelID]struct{}
75	firstHopBlob fn.Option[tlv.Blob]
76	trafficShaper fn.Option[TlvTrafficShaper]
77	}
78
79	// newBandwidthManager creates a bandwidth manager for the source node provided
80	// which is used to obtain hints from the lower layer w.r.t the available
81	// bandwidth of edges on the network. Currently, we'll only obtain bandwidth
82	// hints for the edges we directly have open ourselves. Obtaining these hints
83	// allows us to reduce the number of extraneous attempts as we can skip channels
84	// that are inactive, or just don't have enough bandwidth to carry the payment.
85	func newBandwidthManager(graph Graph, sourceNode route.Vertex,
86	linkQuery getLinkQuery, firstHopBlob fn.Option[tlv.Blob],
87	trafficShaper fn.Option[TlvTrafficShaper]) (*bandwidthManager, error) {	3✔
88		3✔
89	manager := &bandwidthManager{	3✔
90	getLink: linkQuery,	3✔
91	localChans: make(map[lnwire.ShortChannelID]struct{}),	3✔
92	firstHopBlob: firstHopBlob,	3✔
93	trafficShaper: trafficShaper,	3✔
94	}	3✔
95		3✔
96	// First, we'll collect the set of outbound edges from the target	3✔
97	// source node and add them to our bandwidth manager's map of channels.	3✔
98	err := graph.ForEachNodeChannel(sourceNode,	3✔
99	func(channel *graphdb.DirectedChannel) error {	6✔
100	shortID := lnwire.NewShortChanIDFromInt(	3✔
101	channel.ChannelID,	3✔
102	)	3✔
103	manager.localChans[shortID] = struct{}{}	3✔
104		3✔
105	return nil	3✔
106	})	3✔
107
108	if err != nil {	3✔
109	return nil, err	×
110	}	×
111
112	return manager, nil	3✔
113	}
114
115	// getBandwidth queries the current state of a link and gets its currently
116	// available bandwidth. Note that this function assumes that the channel being
117	// queried is one of our local channels, so any failure to retrieve the link
118	// is interpreted as the link being offline.
119	func (b *bandwidthManager) getBandwidth(cid lnwire.ShortChannelID,
120	amount lnwire.MilliSatoshi) lnwire.MilliSatoshi {	3✔
121		3✔
122	link, err := b.getLink(cid)	3✔
123	if err != nil {	6✔
124	// If the link isn't online, then we'll report that it has	3✔
125	// zero bandwidth.	3✔
126	log.Warnf("ShortChannelID=%v: link not found: %v", cid, err)	3✔
127	return 0	3✔
128	}	3✔
129
130	// If the link is found within the switch, but it isn't yet eligible
131	// to forward any HTLCs, then we'll treat it as if it isn't online in
132	// the first place.
133	if !link.EligibleToForward() {	6✔
134	log.Warnf("ShortChannelID=%v: not eligible to forward", cid)	3✔
135	return 0	3✔
136	}	3✔
137
138	// bandwidthResult is an inline type that we'll use to pass the
139	// bandwidth result from the external traffic shaper to the main logic
140	// below.
141	type bandwidthResult struct {	3✔
142	// bandwidth is the available bandwidth for the channel as	3✔
143	// reported by the external traffic shaper. If the external	3✔
144	// traffic shaper is not handling the channel, this value will	3✔
145	// be fn.None	3✔
146	bandwidth fn.Option[lnwire.MilliSatoshi]	3✔
147		3✔
148	// htlcAmount is the amount we're going to use to check if we	3✔
149	// can add another HTLC to the channel. If the external traffic	3✔
150	// shaper is handling the channel, we'll use 0 to just sanity	3✔
151	// check the number of HTLCs on the channel, since we don't know	3✔
152	// the actual HTLC amount that will be sent.	3✔
153	htlcAmount fn.Option[lnwire.MilliSatoshi]	3✔
154	}	3✔
155		3✔
156	var (	3✔
157	// We will pass the link bandwidth to the external traffic	3✔
158	// shaper. This is the current best estimate for the available	3✔
159	// bandwidth for the link.	3✔
160	linkBandwidth = link.Bandwidth()	3✔
161		3✔
162	bandwidthErr = func(err error) fn.Result[bandwidthResult] {	3✔
163	return fn.Err[bandwidthResult](err)	×
164	}	×
165	)
166
167	result, err := fn.MapOptionZ(	3✔
168	b.trafficShaper,	3✔
169	func(ts TlvTrafficShaper) fn.Result[bandwidthResult] {	3✔
UNCOV 170	fundingBlob := link.FundingCustomBlob()	×
UNCOV 171	shouldHandle, err := ts.ShouldHandleTraffic(	×
UNCOV 172	cid, fundingBlob,	×
UNCOV 173	)	×
UNCOV 174	if err != nil {	×
175	return bandwidthErr(fmt.Errorf("traffic "+	×
176	"shaper failed to decide whether to "+	×
177	"handle traffic: %w", err))	×
178	}	×
179
UNCOV 180	log.Debugf("ShortChannelID=%v: external traffic "+	×
UNCOV 181	"shaper is handling traffic: %v", cid,	×
UNCOV 182	shouldHandle)	×
UNCOV 183		×
UNCOV 184	// If this channel isn't handled by the external traffic	×
UNCOV 185	// shaper, we'll return early.	×
UNCOV 186	if !shouldHandle {	×
187	return fn.Ok(bandwidthResult{})	×
188	}	×
189
190	// Ask for a specific bandwidth to be used for the
191	// channel.
UNCOV 192	commitmentBlob := link.CommitmentCustomBlob()	×
UNCOV 193	auxBandwidth, err := ts.PaymentBandwidth(	×
UNCOV 194	b.firstHopBlob, commitmentBlob, linkBandwidth,	×
UNCOV 195	amount,	×
UNCOV 196	)	×
UNCOV 197	if err != nil {	×
198	return bandwidthErr(fmt.Errorf("failed to get "+	×
199	"bandwidth from external traffic "+	×
200	"shaper: %w", err))	×
201	}	×
202
UNCOV 203	log.Debugf("ShortChannelID=%v: external traffic "+	×
UNCOV 204	"shaper reported available bandwidth: %v", cid,	×
UNCOV 205	auxBandwidth)	×
UNCOV 206		×
UNCOV 207	// We don't know the actual HTLC amount that will be	×
UNCOV 208	// sent using the custom channel. But we'll still want	×
UNCOV 209	// to make sure we can add another HTLC, using the	×
UNCOV 210	// MayAddOutgoingHtlc method below. Passing 0 into that	×
UNCOV 211	// method will use the minimum HTLC value for the	×
UNCOV 212	// channel, which is okay to just check we don't exceed	×
UNCOV 213	// the max number of HTLCs on the channel. A proper	×
UNCOV 214	// balance check is done elsewhere.	×
UNCOV 215	return fn.Ok(bandwidthResult{	×
UNCOV 216	bandwidth: fn.Some(auxBandwidth),	×
UNCOV 217	htlcAmount: fn.Some[lnwire.MilliSatoshi](0),	×
UNCOV 218	})	×
219	},
220	).Unpack()
221	if err != nil {	3✔
222	log.Errorf("ShortChannelID=%v: failed to get bandwidth from "+	×
223	"external traffic shaper: %v", cid, err)	×
224		×
225	return 0	×
226	}	×
227
228	htlcAmount := result.htlcAmount.UnwrapOr(amount)	3✔
229		3✔
230	// If our link isn't currently in a state where it can add another	3✔
231	// outgoing htlc, treat the link as unusable.	3✔
232	if err := link.MayAddOutgoingHtlc(htlcAmount); err != nil {	6✔
233	log.Warnf("ShortChannelID=%v: cannot add outgoing "+	3✔
234	"htlc with amount %v: %v", cid, htlcAmount, err)	3✔
235	return 0	3✔
236	}	3✔
237
238	// If the external traffic shaper determined the bandwidth, we'll return
239	// that value, even if it is zero (which would mean no bandwidth is
240	// available on that channel).
241	reportedBandwidth := result.bandwidth.UnwrapOr(linkBandwidth)	3✔
242		3✔
243	return reportedBandwidth	3✔
244	}
245
246	// availableChanBandwidth returns the total available bandwidth for a channel
247	// and a bool indicating whether the channel hint was found. If the channel is
248	// unavailable, a zero amount is returned.
249	func (b *bandwidthManager) availableChanBandwidth(channelID uint64,
250	amount lnwire.MilliSatoshi) (lnwire.MilliSatoshi, bool) {	3✔
251		3✔
252	shortID := lnwire.NewShortChanIDFromInt(channelID)	3✔
253	_, ok := b.localChans[shortID]	3✔
254	if !ok {	3✔
UNCOV 255	return 0, false	×
UNCOV 256	}	×
257
258	return b.getBandwidth(shortID, amount), true	3✔
259	}
260
261	// firstHopCustomBlob returns the custom blob for the first hop of the payment,
262	// if available.
263	func (b *bandwidthManager) firstHopCustomBlob() fn.Option[tlv.Blob] {	3✔
264	return b.firstHopBlob	3✔
265	}	3✔

lightningnetwork / lnd / 12168656289

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