From 17a6175e8bf32e418cf77c30adb0e5f4db4cdf48 Mon Sep 17 00:00:00 2001 From: Joost Jager Date: Tue, 8 Sep 2020 13:07:35 +0200 Subject: [PATCH] routing+routerrpc: rename PaymentAttemptPenalty to AttemptCost Make field names consistent with the command line flag. --- lnrpc/routerrpc/config.go | 5 ++--- lnrpc/routerrpc/routing_config.go | 6 +++--- routing/integrated_routing_context_test.go | 4 ++-- routing/pathfind.go | 20 +++++++++----------- routing/pathfind_test.go | 6 +++--- routing/router_test.go | 4 ++-- server.go | 4 ++-- 7 files changed, 23 insertions(+), 26 deletions(-) diff --git a/lnrpc/routerrpc/config.go b/lnrpc/routerrpc/config.go index 045561dbf..0782c6855 100644 --- a/lnrpc/routerrpc/config.go +++ b/lnrpc/routerrpc/config.go @@ -46,9 +46,8 @@ func DefaultConfig() *Config { AprioriWeight: routing.DefaultAprioriWeight, MinRouteProbability: routing.DefaultMinRouteProbability, PenaltyHalfLife: routing.DefaultPenaltyHalfLife, - AttemptCost: routing.DefaultPaymentAttemptPenalty. - ToSatoshis(), - MaxMcHistory: routing.DefaultMaxMcHistory, + AttemptCost: routing.DefaultAttemptCost.ToSatoshis(), + MaxMcHistory: routing.DefaultMaxMcHistory, } return &Config{ diff --git a/lnrpc/routerrpc/routing_config.go b/lnrpc/routerrpc/routing_config.go index 98b3594cf..a6fb28014 100644 --- a/lnrpc/routerrpc/routing_config.go +++ b/lnrpc/routerrpc/routing_config.go @@ -29,9 +29,9 @@ type RoutingConfig struct { // channel is back at 50% probability. PenaltyHalfLife time.Duration `long:"penaltyhalflife" description:"Defines the duration after which a penalized node or channel is back at 50% probability"` - // AttemptCost is the virtual cost in path finding weight units of - // executing a payment attempt that fails. It is used to trade off - // potentially better routes against their probability of succeeding. + // AttemptCost is the fixed virtual cost in path finding of a failed + // payment attempt. It is used to trade off potentially better routes + // against their probability of succeeding. AttemptCost btcutil.Amount `long:"attemptcost" description:"The (virtual) cost in sats of a failed payment attempt"` // MaxMcHistory defines the maximum number of payment results that diff --git a/routing/integrated_routing_context_test.go b/routing/integrated_routing_context_test.go index b223668e6..8cbeea539 100644 --- a/routing/integrated_routing_context_test.go +++ b/routing/integrated_routing_context_test.go @@ -65,8 +65,8 @@ func newIntegratedRoutingContext(t *testing.T) *integratedRoutingContext { }, pathFindingCfg: PathFindingConfig{ - PaymentAttemptPenalty: 1000, - MinProbability: 0.01, + AttemptCost: 1000, + MinProbability: 0.01, }, source: source, diff --git a/routing/pathfind.go b/routing/pathfind.go index 6d5e9abd5..13c400720 100644 --- a/routing/pathfind.go +++ b/routing/pathfind.go @@ -45,11 +45,10 @@ type pathFinder = func(g *graphParams, r *RestrictParams, []*channeldb.ChannelEdgePolicy, error) var ( - // DefaultPaymentAttemptPenalty is the virtual cost in path finding weight - // units of executing a payment attempt that fails. It is used to trade - // off potentially better routes against their probability of - // succeeding. - DefaultPaymentAttemptPenalty = lnwire.NewMSatFromSatoshis(100) + // DefaultAttemptCost is the default virtual cost in path finding of a + // failed payment attempt. It is used to trade off potentially better + // routes against their probability of succeeding. + DefaultAttemptCost = lnwire.NewMSatFromSatoshis(100) // DefaultMinRouteProbability is the default minimum probability for routes // returned from findPath. @@ -315,11 +314,10 @@ type RestrictParams struct { // PathFindingConfig defines global parameters that control the trade-off in // path finding between fees and probabiity. type PathFindingConfig struct { - // PaymentAttemptPenalty is the virtual cost in path finding weight - // units of executing a payment attempt that fails. It is used to trade - // off potentially better routes against their probability of - // succeeding. - PaymentAttemptPenalty lnwire.MilliSatoshi + // AttemptCost is the virtual cost in path finding of a failed + // payment attempt. It is used to trade off potentially better routes + // against their probability of succeeding. + AttemptCost lnwire.MilliSatoshi // MinProbability defines the minimum success probability of the // returned route. @@ -644,7 +642,7 @@ func findPath(g *graphParams, r *RestrictParams, cfg *PathFindingConfig, // probability. tempDist := getProbabilityBasedDist( tempWeight, probability, - int64(cfg.PaymentAttemptPenalty), + int64(cfg.AttemptCost), ) // If there is already a best route stored, compare this diff --git a/routing/pathfind_test.go b/routing/pathfind_test.go index 92696ca38..6ba63aeb7 100644 --- a/routing/pathfind_test.go +++ b/routing/pathfind_test.go @@ -2582,8 +2582,8 @@ func testProbabilityRouting(t *testing.T, p10, p11, p20, minProbability float64, } ctx.pathFindingConfig = PathFindingConfig{ - PaymentAttemptPenalty: lnwire.NewMSatFromSatoshis(10), - MinProbability: minProbability, + AttemptCost: lnwire.NewMSatFromSatoshis(10), + MinProbability: minProbability, } path, err := ctx.findPath(target, paymentAmt) @@ -2656,7 +2656,7 @@ func TestEqualCostRouteSelection(t *testing.T) { } ctx.pathFindingConfig = PathFindingConfig{ - PaymentAttemptPenalty: lnwire.NewMSatFromSatoshis(1), + AttemptCost: lnwire.NewMSatFromSatoshis(1), } path, err := ctx.findPath(target, paymentAmt) diff --git a/routing/router_test.go b/routing/router_test.go index 9844b5268..400bace6a 100644 --- a/routing/router_test.go +++ b/routing/router_test.go @@ -79,8 +79,8 @@ func createTestCtxFromGraphInstance(startingHeight uint32, graphInstance *testGr chainView := newMockChainView(chain) pathFindingConfig := PathFindingConfig{ - MinProbability: 0.01, - PaymentAttemptPenalty: 100, + MinProbability: 0.01, + AttemptCost: 100, } mcConfig := &MissionControlConfig{ diff --git a/server.go b/server.go index cba47e395..f2308db85 100644 --- a/server.go +++ b/server.go @@ -724,12 +724,12 @@ func newServer(cfg *Config, listenAddrs []net.Addr, } srvrLog.Debugf("Instantiating payment session source with config: "+ - "PaymentAttemptPenalty=%v, MinRouteProbability=%v", + "AttemptCost=%v, MinRouteProbability=%v", int64(routingConfig.AttemptCost), routingConfig.MinRouteProbability) pathFindingConfig := routing.PathFindingConfig{ - PaymentAttemptPenalty: lnwire.NewMSatFromSatoshis( + AttemptCost: lnwire.NewMSatFromSatoshis( routingConfig.AttemptCost, ), MinProbability: routingConfig.MinRouteProbability,