13035292482

Committed 29 Jan 2025 03:59PM UTC coverage: 49.3% (-9.5%) from 58.777%

Build # 13035292482

Build Type

Pull #9456

github

Committed by

mohamedawnallah

Commit Message

docs: update release-notes-0.19.0.md

In this commit, we warn users about the removal
of RPCs `SendToRoute`, `SendToRouteSync`, `SendPayment`,
and `SendPaymentSync` in the next release 0.20.

Pull Request Pull Request #9456: lnrpc+docs: deprecate warning `SendToRoute`, `SendToRouteSync`, `SendPayment`, and `SendPaymentSync` in Release 0.19

Run Details

100634 of 204126 relevant lines covered (49.3%)

1.54 hits per line

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

77.61

/routing/unified_edges.go

package routing

import (
        "math"

        "github.com/btcsuite/btcd/btcutil"
        graphdb "github.com/lightningnetwork/lnd/graph/db"
        "github.com/lightningnetwork/lnd/graph/db/models"
        "github.com/lightningnetwork/lnd/lntypes"
        "github.com/lightningnetwork/lnd/lnwire"
        "github.com/lightningnetwork/lnd/routing/route"
)

// nodeEdgeUnifier holds all edge unifiers for connections towards a node.
type nodeEdgeUnifier struct {
        // edgeUnifiers contains an edge unifier for every from node.
        edgeUnifiers map[route.Vertex]*edgeUnifier

        // sourceNode is the sender of a payment. The rules to pick the final
        // policy are different for local channels.
        sourceNode route.Vertex

        // toNode is the node for which the edge unifiers are instantiated.
        toNode route.Vertex

        // useInboundFees indicates whether to take inbound fees into account.
        useInboundFees bool

        // outChanRestr is an optional outgoing channel restriction for the
        // local channel to use.
        outChanRestr map[uint64]struct{}
}

// newNodeEdgeUnifier instantiates a new nodeEdgeUnifier object. Channel
// policies can be added to this object.
func newNodeEdgeUnifier(sourceNode, toNode route.Vertex, useInboundFees bool,
        outChanRestr map[uint64]struct{}) *nodeEdgeUnifier {

        return &nodeEdgeUnifier{
                edgeUnifiers:   make(map[route.Vertex]*edgeUnifier),
                toNode:         toNode,
                useInboundFees: useInboundFees,
                sourceNode:     sourceNode,
                outChanRestr:   outChanRestr,
        }
}

// addPolicy adds a single channel policy. Capacity may be zero if unknown
// (light clients). We expect a non-nil payload size function and will request a
// graceful shutdown if it is not provided as this indicates that edges are
// incorrectly specified.
func (u *nodeEdgeUnifier) addPolicy(fromNode route.Vertex,
        edge *models.CachedEdgePolicy, inboundFee models.InboundFee,
        capacity btcutil.Amount, hopPayloadSizeFn PayloadSizeFunc,
        blindedPayment *BlindedPayment) {

        localChan := fromNode == u.sourceNode

        // Skip channels if there is an outgoing channel restriction.
        if localChan && u.outChanRestr != nil {
                if _, ok := u.outChanRestr[edge.ChannelID]; !ok {
                        return
                }
        }

        // Update the edgeUnifiers map.
        unifier, ok := u.edgeUnifiers[fromNode]
        if !ok {
                unifier = &edgeUnifier{
                        localChan: localChan,
                }
                u.edgeUnifiers[fromNode] = unifier
        }

        // In case no payload size function was provided a graceful shutdown
        // is requested, because this function is not used as intended.
        if hopPayloadSizeFn == nil {
                log.Criticalf("No payloadsize function was provided for the "+
                        "edge (chanid=%v) when adding it to the edge unifier "+
                        "of node: %v", edge.ChannelID, fromNode)

                return
        }

        // Zero inbound fee for exit hops.
        if !u.useInboundFees {
                inboundFee = models.InboundFee{}
        }

        unifier.edges = append(unifier.edges, newUnifiedEdge(
                edge, capacity, inboundFee, hopPayloadSizeFn, blindedPayment,
        ))
}

// addGraphPolicies adds all policies that are known for the toNode in the
// graph.
func (u *nodeEdgeUnifier) addGraphPolicies(g Graph) error {
        cb := func(channel *graphdb.DirectedChannel) error {
                // If there is no edge policy for this candidate node, skip.
                // Note that we are searching backwards so this node would have
                // come prior to the pivot node in the route.
                if channel.InPolicy == nil {
                        return nil
                }

                // Add this policy to the corresponding edgeUnifier. We default
                // to the clear hop payload size function because
                // `addGraphPolicies` is only used for cleartext intermediate
                // hops in a route.
                inboundFee := models.NewInboundFeeFromWire(
                        channel.InboundFee,
                )

                u.addPolicy(
                        channel.OtherNode, channel.InPolicy, inboundFee,
                        channel.Capacity, defaultHopPayloadSize, nil,
                )

                return nil
        }

        // Iterate over all channels of the to node.
        return g.ForEachNodeChannel(u.toNode, cb)
}

// unifiedEdge is the individual channel data that is kept inside an edgeUnifier
// object.
type unifiedEdge struct {
        policy      *models.CachedEdgePolicy
        capacity    btcutil.Amount
        inboundFees models.InboundFee

        // hopPayloadSize supplies an edge with the ability to calculate the
        // exact payload size if this edge would be included in a route. This
        // is needed because hops of a blinded path differ in their payload
        // structure compared to cleartext hops.
        hopPayloadSizeFn PayloadSizeFunc

        // blindedPayment if set, is the BlindedPayment that this edge was
        // derived from originally.
        blindedPayment *BlindedPayment
}

// newUnifiedEdge constructs a new unifiedEdge.
func newUnifiedEdge(policy *models.CachedEdgePolicy, capacity btcutil.Amount,
        inboundFees models.InboundFee, hopPayloadSizeFn PayloadSizeFunc,
        blindedPayment *BlindedPayment) *unifiedEdge {

        return &unifiedEdge{
                policy:           policy,
                capacity:         capacity,
                inboundFees:      inboundFees,
                hopPayloadSizeFn: hopPayloadSizeFn,
                blindedPayment:   blindedPayment,
        }
}

// amtInRange checks whether an amount falls within the valid range for a
// channel.
func (u *unifiedEdge) amtInRange(amt lnwire.MilliSatoshi) bool {
        // If the capacity is available (non-light clients), skip channels that
        // are too small.
        if u.capacity > 0 &&
                amt > lnwire.NewMSatFromSatoshis(u.capacity) {

                log.Tracef("Not enough capacity: amt=%v, capacity=%v",
                        amt, u.capacity)
                return false
        }

        // Skip channels for which this htlc is too large.
        if u.policy.MessageFlags.HasMaxHtlc() &&
                amt > u.policy.MaxHTLC {

                log.Tracef("Exceeds policy's MaxHTLC: amt=%v, MaxHTLC=%v",
                        amt, u.policy.MaxHTLC)
                return false
        }

        // Skip channels for which this htlc is too small.
        if amt < u.policy.MinHTLC {
                log.Tracef("below policy's MinHTLC: amt=%v, MinHTLC=%v",
                        amt, u.policy.MinHTLC)
                return false
        }

        return true
}

// edgeUnifier is an object that covers all channels between a pair of nodes.
type edgeUnifier struct {
        edges     []*unifiedEdge
        localChan bool
}

// getEdge returns the optimal unified edge to use for this connection given a
// specific amount to send. It differentiates between local and network
// channels.
func (u *edgeUnifier) getEdge(netAmtReceived lnwire.MilliSatoshi,
        bandwidthHints bandwidthHints,
        nextOutFee lnwire.MilliSatoshi) *unifiedEdge {

        if u.localChan {
                return u.getEdgeLocal(
                        netAmtReceived, bandwidthHints, nextOutFee,
                )
        }

        return u.getEdgeNetwork(netAmtReceived, nextOutFee)
}

// calcCappedInboundFee calculates the inbound fee for a channel, taking into
// account the total node fee for the "to" node.
func calcCappedInboundFee(edge *unifiedEdge, amt lnwire.MilliSatoshi,
        nextOutFee lnwire.MilliSatoshi) int64 {

        // Calculate the inbound fee charged for the amount that passes over the
        // channel.
        inboundFee := edge.inboundFees.CalcFee(amt)

        // Take into account that the total node fee cannot be negative.
        if inboundFee < -int64(nextOutFee) {
                inboundFee = -int64(nextOutFee)
        }

        return inboundFee
}

// getEdgeLocal returns the optimal unified edge to use for this local
// connection given a specific amount to send.
func (u *edgeUnifier) getEdgeLocal(netAmtReceived lnwire.MilliSatoshi,
        bandwidthHints bandwidthHints,
        nextOutFee lnwire.MilliSatoshi) *unifiedEdge {

        var (
                bestEdge     *unifiedEdge
                maxBandwidth lnwire.MilliSatoshi
        )

        for _, edge := range u.edges {
                // Calculate the inbound fee charged at the receiving node.
                inboundFee := calcCappedInboundFee(
                        edge, netAmtReceived, nextOutFee,
                )

                // Add inbound fee to get to the amount that is sent over the
                // local channel.
                amt := netAmtReceived + lnwire.MilliSatoshi(inboundFee)

                // Check valid amount range for the channel. We skip this test
                // for payments with custom HTLC data, as the amount sent on
                // the BTC layer may differ from the amount that is actually
                // forwarded in custom channels.
                if bandwidthHints.firstHopCustomBlob().IsNone() &&
                        !edge.amtInRange(amt) {

                        log.Debugf("Amount %v not in range for edge %v",
                                netAmtReceived, edge.policy.ChannelID)

                        continue
                }

                // For local channels, there is no fee to pay or an extra time
                // lock. We only consider the currently available bandwidth for
                // channel selection. The disabled flag is ignored for local
                // channels.

                // Retrieve bandwidth for this local channel. If not
                // available, assume this channel has enough bandwidth.
                //
                // TODO(joostjager): Possibly change to skipping this
                // channel. The bandwidth hint is expected to be
                // available.
                bandwidth, ok := bandwidthHints.availableChanBandwidth(
                        edge.policy.ChannelID, amt,
                )
                if !ok {
                        log.Debugf("Cannot get bandwidth for edge %v, use max "+
                                "instead", edge.policy.ChannelID)
                        bandwidth = lnwire.MaxMilliSatoshi
                }

                // TODO(yy): if the above `!ok` is chosen, we'd have
                // `bandwidth` to be the max value, which will end up having
                // the `maxBandwidth` to be have the largest value and this
                // edge will be the chosen one. This is wrong in two ways,
                // 1. we need to understand why `availableChanBandwidth` cannot
                // find bandwidth for this edge as something is wrong with this
                // channel, and,
                // 2. this edge is likely NOT the local channel with the
                // highest available bandwidth.
                //
                // Skip channels that can't carry the payment.
                if amt > bandwidth {
                        log.Debugf("Skipped edge %v: not enough bandwidth, "+
                                "bandwidth=%v, amt=%v", edge.policy.ChannelID,
                                bandwidth, amt)

                        continue
                }

                // We pick the local channel with the highest available
                // bandwidth, to maximize the success probability. It can be
                // that the channel state changes between querying the bandwidth
                // hints and sending out the htlc.
                if bandwidth < maxBandwidth {
                        log.Debugf("Skipped edge %v: not max bandwidth, "+
                                "bandwidth=%v, maxBandwidth=%v",
                                edge.policy.ChannelID, bandwidth, maxBandwidth)

                        continue
                }
                maxBandwidth = bandwidth

                // Update best edge.
                bestEdge = newUnifiedEdge(
                        edge.policy, edge.capacity, edge.inboundFees,
                        edge.hopPayloadSizeFn, edge.blindedPayment,
                )
        }

        return bestEdge
}

// getEdgeNetwork returns the optimal unified edge to use for this connection
// given a specific amount to send. The goal is to return a unified edge with a
// policy that maximizes the probability of a successful forward in a non-strict
// forwarding context.
func (u *edgeUnifier) getEdgeNetwork(netAmtReceived lnwire.MilliSatoshi,
        nextOutFee lnwire.MilliSatoshi) *unifiedEdge {

        var (
                bestPolicy       *unifiedEdge
                maxFee           int64 = math.MinInt64
                maxTimelock      uint16
                maxCapMsat       lnwire.MilliSatoshi
                hopPayloadSizeFn PayloadSizeFunc
        )

        for _, edge := range u.edges {
                // Calculate the inbound fee charged at the receiving node.
                inboundFee := calcCappedInboundFee(
                        edge, netAmtReceived, nextOutFee,
                )

                // Add inbound fee to get to the amount that is sent over the
                // channel.
                amt := netAmtReceived + lnwire.MilliSatoshi(inboundFee)

                // Check valid amount range for the channel.
                if !edge.amtInRange(amt) {
                        log.Debugf("Amount %v not in range for edge %v",
                                amt, edge.policy.ChannelID)
                        continue
                }

                // For network channels, skip the disabled ones.
                edgeFlags := edge.policy.ChannelFlags
                isDisabled := edgeFlags&lnwire.ChanUpdateDisabled != 0
                if isDisabled {
                        log.Debugf("Skipped edge %v due to it being disabled",
                                edge.policy.ChannelID)
                        continue
                }

                // Track the maximal capacity for usable channels. If we don't
                // know the capacity, we fall back to MaxHTLC.
                capMsat := lnwire.NewMSatFromSatoshis(edge.capacity)
                if capMsat == 0 && edge.policy.MessageFlags.HasMaxHtlc() {
                        log.Tracef("No capacity available for channel %v, "+
                                "using MaxHtlcMsat (%v) as a fallback.",
                                edge.policy.ChannelID, edge.policy.MaxHTLC)

                        capMsat = edge.policy.MaxHTLC
                }
                maxCapMsat = lntypes.Max(capMsat, maxCapMsat)

                // Track the maximum time lock of all channels that are
                // candidate for non-strict forwarding at the routing node.
                maxTimelock = lntypes.Max(
                        maxTimelock, edge.policy.TimeLockDelta,
                )

                outboundFee := int64(edge.policy.ComputeFee(amt))
                fee := outboundFee + inboundFee

                // Use the policy that results in the highest fee for this
                // specific amount.
                if fee < maxFee {
                        log.Debugf("Skipped edge %v due to it produces less "+
                                "fee: fee=%v, maxFee=%v",
                                edge.policy.ChannelID, fee, maxFee)

                        continue
                }
                maxFee = fee

                bestPolicy = newUnifiedEdge(
                        edge.policy, 0, edge.inboundFees, nil,
                        edge.blindedPayment,
                )

                // The payload size function for edges to a connected peer is
                // always the same hence there is not need to find the maximum.
                // This also counts for blinded edges where we only have one
                // edge to a blinded peer.
                hopPayloadSizeFn = edge.hopPayloadSizeFn
        }

        // Return early if no channel matches.
        if bestPolicy == nil {
                return nil
        }

        // We have already picked the highest fee that could be required for
        // non-strict forwarding. To also cover the case where a lower fee
        // channel requires a longer time lock, we modify the policy by setting
        // the maximum encountered time lock. Note that this results in a
        // synthetic policy that is not actually present on the routing node.
        //
        // The reason we do this, is that we try to maximize the chance that we
        // get forwarded. Because we penalize pair-wise, there won't be a second
        // chance for this node pair. But this is all only needed for nodes that
        // have distinct policies for channels to the same peer.
        policyCopy := *bestPolicy.policy
        policyCopy.TimeLockDelta = maxTimelock
        modifiedEdge := newUnifiedEdge(
                &policyCopy, maxCapMsat.ToSatoshis(), bestPolicy.inboundFees,
                hopPayloadSizeFn, bestPolicy.blindedPayment,
        )

        return modifiedEdge
}

// minAmt returns the minimum amount that can be forwarded on this connection.
func (u *edgeUnifier) minAmt() lnwire.MilliSatoshi {
        min := lnwire.MaxMilliSatoshi
        for _, edge := range u.edges {
                min = lntypes.Min(min, edge.policy.MinHTLC)
        }

        return min
}

1	package routing
2
3	import (
4	"math"
5
6	"github.com/btcsuite/btcd/btcutil"
7	graphdb "github.com/lightningnetwork/lnd/graph/db"
8	"github.com/lightningnetwork/lnd/graph/db/models"
9	"github.com/lightningnetwork/lnd/lntypes"
10	"github.com/lightningnetwork/lnd/lnwire"
11	"github.com/lightningnetwork/lnd/routing/route"
12	)
13
14	// nodeEdgeUnifier holds all edge unifiers for connections towards a node.
15	type nodeEdgeUnifier struct {
16	// edgeUnifiers contains an edge unifier for every from node.
17	edgeUnifiers map[route.Vertex]*edgeUnifier
18
19	// sourceNode is the sender of a payment. The rules to pick the final
20	// policy are different for local channels.
21	sourceNode route.Vertex
22
23	// toNode is the node for which the edge unifiers are instantiated.
24	toNode route.Vertex
25
26	// useInboundFees indicates whether to take inbound fees into account.
27	useInboundFees bool
28
29	// outChanRestr is an optional outgoing channel restriction for the
30	// local channel to use.
31	outChanRestr map[uint64]struct{}
32	}
33
34	// newNodeEdgeUnifier instantiates a new nodeEdgeUnifier object. Channel
35	// policies can be added to this object.
36	func newNodeEdgeUnifier(sourceNode, toNode route.Vertex, useInboundFees bool,
37	outChanRestr map[uint64]struct{}) *nodeEdgeUnifier {	3✔
38		3✔
39	return &nodeEdgeUnifier{	3✔
40	edgeUnifiers: make(map[route.Vertex]*edgeUnifier),	3✔
41	toNode: toNode,	3✔
42	useInboundFees: useInboundFees,	3✔
43	sourceNode: sourceNode,	3✔
44	outChanRestr: outChanRestr,	3✔
45	}	3✔
46	}	3✔
47
48	// addPolicy adds a single channel policy. Capacity may be zero if unknown
49	// (light clients). We expect a non-nil payload size function and will request a
50	// graceful shutdown if it is not provided as this indicates that edges are
51	// incorrectly specified.
52	func (u *nodeEdgeUnifier) addPolicy(fromNode route.Vertex,
53	edge *models.CachedEdgePolicy, inboundFee models.InboundFee,
54	capacity btcutil.Amount, hopPayloadSizeFn PayloadSizeFunc,
55	blindedPayment *BlindedPayment) {	3✔
56		3✔
57	localChan := fromNode == u.sourceNode	3✔
58		3✔
59	// Skip channels if there is an outgoing channel restriction.	3✔
60	if localChan && u.outChanRestr != nil {	3✔
61	if _, ok := u.outChanRestr[edge.ChannelID]; !ok {	×
62	return	×
63	}	×
64	}	×
65		×
66	// Update the edgeUnifiers map.	×
67	unifier, ok := u.edgeUnifiers[fromNode]
68	if !ok {
69	unifier = &edgeUnifier{
70	localChan: localChan,	3✔
71	}	6✔
72	u.edgeUnifiers[fromNode] = unifier	3✔
73	}	3✔
74		3✔
75	// In case no payload size function was provided a graceful shutdown	3✔
76	// is requested, because this function is not used as intended.	3✔
77	if hopPayloadSizeFn == nil {
78	log.Criticalf("No payloadsize function was provided for the "+
79	"edge (chanid=%v) when adding it to the edge unifier "+
80	"of node: %v", edge.ChannelID, fromNode)	3✔
81		×
82	return	×
83	}	×
84		×
85	// Zero inbound fee for exit hops.	×
86	if !u.useInboundFees {	×
87	inboundFee = models.InboundFee{}
88	}
89		6✔
90	unifier.edges = append(unifier.edges, newUnifiedEdge(	3✔
91	edge, capacity, inboundFee, hopPayloadSizeFn, blindedPayment,	3✔
92	))
93	}	3✔
94		3✔
95	// addGraphPolicies adds all policies that are known for the toNode in the	3✔
96	// graph.
97	func (u *nodeEdgeUnifier) addGraphPolicies(g Graph) error {
98	cb := func(channel *graphdb.DirectedChannel) error {
99	// If there is no edge policy for this candidate node, skip.
100	// Note that we are searching backwards so this node would have	3✔
101	// come prior to the pivot node in the route.	6✔
102	if channel.InPolicy == nil {	3✔
103	return nil	3✔
104	}	3✔
105		3✔
106	// Add this policy to the corresponding edgeUnifier. We default	×
107	// to the clear hop payload size function because	×
108	// `addGraphPolicies` is only used for cleartext intermediate	×
109	// hops in a route.	×
110	inboundFee := models.NewInboundFeeFromWire(	×
111	channel.InboundFee,
112	)
113
114	u.addPolicy(
115	channel.OtherNode, channel.InPolicy, inboundFee,
116	channel.Capacity, defaultHopPayloadSize, nil,	3✔
117	)	3✔
118		3✔
119	return nil	3✔
120	}	3✔
121		3✔
122	// Iterate over all channels of the to node.	3✔
123	return g.ForEachNodeChannel(u.toNode, cb)	3✔
124	}	3✔
125		3✔
126	// unifiedEdge is the individual channel data that is kept inside an edgeUnifier
127	// object.
128	type unifiedEdge struct {
129	policy *models.CachedEdgePolicy	3✔
130	capacity btcutil.Amount
131	inboundFees models.InboundFee
132
133	// hopPayloadSize supplies an edge with the ability to calculate the
134	// exact payload size if this edge would be included in a route. This
135	// is needed because hops of a blinded path differ in their payload
136	// structure compared to cleartext hops.
137	hopPayloadSizeFn PayloadSizeFunc
138
139	// blindedPayment if set, is the BlindedPayment that this edge was
140	// derived from originally.
141	blindedPayment *BlindedPayment
142	}
143
144	// newUnifiedEdge constructs a new unifiedEdge.
145	func newUnifiedEdge(policy *models.CachedEdgePolicy, capacity btcutil.Amount,
146	inboundFees models.InboundFee, hopPayloadSizeFn PayloadSizeFunc,
147	blindedPayment BlindedPayment) unifiedEdge {
148
149	return &unifiedEdge{
150	policy: policy,
151	capacity: capacity,
152	inboundFees: inboundFees,
153	hopPayloadSizeFn: hopPayloadSizeFn,	3✔
154	blindedPayment: blindedPayment,	3✔
155	}	3✔
156	}	3✔
157		3✔
158	// amtInRange checks whether an amount falls within the valid range for a	3✔
159	// channel.	3✔
160	func (u *unifiedEdge) amtInRange(amt lnwire.MilliSatoshi) bool {	3✔
161	// If the capacity is available (non-light clients), skip channels that	3✔
162	// are too small.	3✔
163	if u.capacity > 0 &&
164	amt > lnwire.NewMSatFromSatoshis(u.capacity) {
165
166	log.Tracef("Not enough capacity: amt=%v, capacity=%v",	3✔
167	amt, u.capacity)	3✔
168	return false	3✔
169	}	3✔
170		3✔
171	// Skip channels for which this htlc is too large.	×
172	if u.policy.MessageFlags.HasMaxHtlc() &&	×
173	amt > u.policy.MaxHTLC {	×
174		×
175	log.Tracef("Exceeds policy's MaxHTLC: amt=%v, MaxHTLC=%v",	×
176	amt, u.policy.MaxHTLC)
177	return false
178	}	3✔
179		6✔
180	// Skip channels for which this htlc is too small.	3✔
181	if amt < u.policy.MinHTLC {	3✔
182	log.Tracef("below policy's MinHTLC: amt=%v, MinHTLC=%v",	3✔
183	amt, u.policy.MinHTLC)	3✔
184	return false	3✔
185	}
186
187	return true	6✔
188	}	3✔
189		3✔
190	// edgeUnifier is an object that covers all channels between a pair of nodes.	3✔
191	type edgeUnifier struct {	3✔
192	edges []*unifiedEdge
193	localChan bool	3✔
194	}
195
196	// getEdge returns the optimal unified edge to use for this connection given a
197	// specific amount to send. It differentiates between local and network
198	// channels.
199	func (u *edgeUnifier) getEdge(netAmtReceived lnwire.MilliSatoshi,
200	bandwidthHints bandwidthHints,
201	nextOutFee lnwire.MilliSatoshi) *unifiedEdge {
202
203	if u.localChan {
204	return u.getEdgeLocal(
205	netAmtReceived, bandwidthHints, nextOutFee,
206	)
207	}	3✔
208		3✔
209	return u.getEdgeNetwork(netAmtReceived, nextOutFee)	6✔
210	}	3✔
211		3✔
212	// calcCappedInboundFee calculates the inbound fee for a channel, taking into	3✔
213	// account the total node fee for the "to" node.	3✔
214	func calcCappedInboundFee(edge *unifiedEdge, amt lnwire.MilliSatoshi,
215	nextOutFee lnwire.MilliSatoshi) int64 {	3✔
216
217	// Calculate the inbound fee charged for the amount that passes over the
218	// channel.
219	inboundFee := edge.inboundFees.CalcFee(amt)
220
221	// Take into account that the total node fee cannot be negative.	3✔
222	if inboundFee < -int64(nextOutFee) {	3✔
223	inboundFee = -int64(nextOutFee)	3✔
224	}	3✔
225		3✔
226	return inboundFee	3✔
227	}	3✔
228		3✔
229	// getEdgeLocal returns the optimal unified edge to use for this local	×
230	// connection given a specific amount to send.	×
231	func (u *edgeUnifier) getEdgeLocal(netAmtReceived lnwire.MilliSatoshi,
232	bandwidthHints bandwidthHints,	3✔
233	nextOutFee lnwire.MilliSatoshi) *unifiedEdge {
234
235	var (
236	bestEdge *unifiedEdge
237	maxBandwidth lnwire.MilliSatoshi
238	)
239		3✔
240	for _, edge := range u.edges {	3✔
241	// Calculate the inbound fee charged at the receiving node.	3✔
242	inboundFee := calcCappedInboundFee(	3✔
243	edge, netAmtReceived, nextOutFee,	3✔
244	)	3✔
245		3✔
246	// Add inbound fee to get to the amount that is sent over the	6✔
247	// local channel.	3✔
248	amt := netAmtReceived + lnwire.MilliSatoshi(inboundFee)	3✔
249		3✔
250	// Check valid amount range for the channel. We skip this test	3✔
251	// for payments with custom HTLC data, as the amount sent on	3✔
252	// the BTC layer may differ from the amount that is actually	3✔
253	// forwarded in custom channels.	3✔
254	if bandwidthHints.firstHopCustomBlob().IsNone() &&	3✔
255	!edge.amtInRange(amt) {	3✔
256		3✔
257	log.Debugf("Amount %v not in range for edge %v",	3✔
258	netAmtReceived, edge.policy.ChannelID)	3✔
259		3✔
260	continue	3✔
261	}	3✔
262		×
263	// For local channels, there is no fee to pay or an extra time	×
264	// lock. We only consider the currently available bandwidth for	×
265	// channel selection. The disabled flag is ignored for local	×
266	// channels.	×
267
268	// Retrieve bandwidth for this local channel. If not
269	// available, assume this channel has enough bandwidth.
270	//
271	// TODO(joostjager): Possibly change to skipping this
272	// channel. The bandwidth hint is expected to be
273	// available.
274	bandwidth, ok := bandwidthHints.availableChanBandwidth(
275	edge.policy.ChannelID, amt,
276	)
277	if !ok {
278	log.Debugf("Cannot get bandwidth for edge %v, use max "+
279	"instead", edge.policy.ChannelID)
280	bandwidth = lnwire.MaxMilliSatoshi	3✔
281	}	3✔
282		3✔
283	// TODO(yy): if the above `!ok` is chosen, we'd have	3✔
284	// `bandwidth` to be the max value, which will end up having	×
285	// the `maxBandwidth` to be have the largest value and this	×
286	// edge will be the chosen one. This is wrong in two ways,	×
287	// 1. we need to understand why `availableChanBandwidth` cannot	×
288	// find bandwidth for this edge as something is wrong with this
289	// channel, and,
290	// 2. this edge is likely NOT the local channel with the
291	// highest available bandwidth.
292	//
293	// Skip channels that can't carry the payment.
294	if amt > bandwidth {
295	log.Debugf("Skipped edge %v: not enough bandwidth, "+
296	"bandwidth=%v, amt=%v", edge.policy.ChannelID,
297	bandwidth, amt)
298
299	continue
300	}	6✔
301		3✔
302	// We pick the local channel with the highest available	3✔
303	// bandwidth, to maximize the success probability. It can be	3✔
304	// that the channel state changes between querying the bandwidth	3✔
305	// hints and sending out the htlc.	3✔
306	if bandwidth < maxBandwidth {
307	log.Debugf("Skipped edge %v: not max bandwidth, "+
308	"bandwidth=%v, maxBandwidth=%v",
309	edge.policy.ChannelID, bandwidth, maxBandwidth)
310
311	continue
312	}	3✔
313	maxBandwidth = bandwidth	×
314		×
315	// Update best edge.	×
316	bestEdge = newUnifiedEdge(	×
317	edge.policy, edge.capacity, edge.inboundFees,	×
318	edge.hopPayloadSizeFn, edge.blindedPayment,
319	)	3✔
320	}	3✔
321		3✔
322	return bestEdge	3✔
323	}	3✔
324		3✔
325	// getEdgeNetwork returns the optimal unified edge to use for this connection	3✔
326	// given a specific amount to send. The goal is to return a unified edge with a
327	// policy that maximizes the probability of a successful forward in a non-strict
328	// forwarding context.	3✔
329	func (u *edgeUnifier) getEdgeNetwork(netAmtReceived lnwire.MilliSatoshi,
330	nextOutFee lnwire.MilliSatoshi) *unifiedEdge {
331
332	var (
333	bestPolicy *unifiedEdge
334	maxFee int64 = math.MinInt64
335	maxTimelock uint16
336	maxCapMsat lnwire.MilliSatoshi	3✔
337	hopPayloadSizeFn PayloadSizeFunc	3✔
338	)	3✔
339		3✔
340	for _, edge := range u.edges {	3✔
341	// Calculate the inbound fee charged at the receiving node.	3✔
342	inboundFee := calcCappedInboundFee(	3✔
343	edge, netAmtReceived, nextOutFee,	3✔
344	)	3✔
345		3✔
346	// Add inbound fee to get to the amount that is sent over the	6✔
347	// channel.	3✔
348	amt := netAmtReceived + lnwire.MilliSatoshi(inboundFee)	3✔
349		3✔
350	// Check valid amount range for the channel.	3✔
351	if !edge.amtInRange(amt) {	3✔
352	log.Debugf("Amount %v not in range for edge %v",	3✔
353	amt, edge.policy.ChannelID)	3✔
354	continue	3✔
355	}	3✔
356		3✔
357	// For network channels, skip the disabled ones.	6✔
358	edgeFlags := edge.policy.ChannelFlags	3✔
359	isDisabled := edgeFlags&lnwire.ChanUpdateDisabled != 0	3✔
360	if isDisabled {	3✔
361	log.Debugf("Skipped edge %v due to it being disabled",
362	edge.policy.ChannelID)
363	continue
364	}	3✔
365		3✔
366	// Track the maximal capacity for usable channels. If we don't	3✔
367	// know the capacity, we fall back to MaxHTLC.	×
368	capMsat := lnwire.NewMSatFromSatoshis(edge.capacity)	×
369	if capMsat == 0 && edge.policy.MessageFlags.HasMaxHtlc() {	×
370	log.Tracef("No capacity available for channel %v, "+
371	"using MaxHtlcMsat (%v) as a fallback.",
372	edge.policy.ChannelID, edge.policy.MaxHTLC)
373
374	capMsat = edge.policy.MaxHTLC	3✔
375	}	3✔
376	maxCapMsat = lntypes.Max(capMsat, maxCapMsat)	×
377		×
378	// Track the maximum time lock of all channels that are	×
379	// candidate for non-strict forwarding at the routing node.	×
380	maxTimelock = lntypes.Max(	×
381	maxTimelock, edge.policy.TimeLockDelta,	×
382	)	3✔
383		3✔
384	outboundFee := int64(edge.policy.ComputeFee(amt))	3✔
385	fee := outboundFee + inboundFee	3✔
386		3✔
387	// Use the policy that results in the highest fee for this	3✔
388	// specific amount.	3✔
389	if fee < maxFee {	3✔
390	log.Debugf("Skipped edge %v due to it produces less "+	3✔
391	"fee: fee=%v, maxFee=%v",	3✔
392	edge.policy.ChannelID, fee, maxFee)	3✔
393		3✔
394	continue	3✔
395	}	3✔
396	maxFee = fee	×
397		×
398	bestPolicy = newUnifiedEdge(	×
399	edge.policy, 0, edge.inboundFees, nil,	×
400	edge.blindedPayment,	×
401	)
402		3✔
403	// The payload size function for edges to a connected peer is	3✔
404	// always the same hence there is not need to find the maximum.	3✔
405	// This also counts for blinded edges where we only have one	3✔
406	// edge to a blinded peer.	3✔
407	hopPayloadSizeFn = edge.hopPayloadSizeFn	3✔
408	}	3✔
409		3✔
410	// Return early if no channel matches.	3✔
411	if bestPolicy == nil {	3✔
412	return nil	3✔
413	}	3✔
414
415	// We have already picked the highest fee that could be required for
416	// non-strict forwarding. To also cover the case where a lower fee
417	// channel requires a longer time lock, we modify the policy by setting	6✔
418	// the maximum encountered time lock. Note that this results in a	3✔
419	// synthetic policy that is not actually present on the routing node.	3✔
420	//
421	// The reason we do this, is that we try to maximize the chance that we
422	// get forwarded. Because we penalize pair-wise, there won't be a second
423	// chance for this node pair. But this is all only needed for nodes that
424	// have distinct policies for channels to the same peer.
425	policyCopy := *bestPolicy.policy
426	policyCopy.TimeLockDelta = maxTimelock
427	modifiedEdge := newUnifiedEdge(
428	&policyCopy, maxCapMsat.ToSatoshis(), bestPolicy.inboundFees,
429	hopPayloadSizeFn, bestPolicy.blindedPayment,
430	)
431		3✔
432	return modifiedEdge	3✔
433	}	3✔
434		3✔
435	// minAmt returns the minimum amount that can be forwarded on this connection.	3✔
436	func (u *edgeUnifier) minAmt() lnwire.MilliSatoshi {	3✔
437	min := lnwire.MaxMilliSatoshi	3✔
438	for _, edge := range u.edges {	3✔
439	min = lntypes.Min(min, edge.policy.MinHTLC)
440	}
441
442	return min	×
443	}	×

lightningnetwork / lnd / 13035292482

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