lncli+routerrpc: adapt mc api to dynamic estimator
The active probability estimator can be switched dynamically using the `Set/GetMissionControl` API, maintaining backward compatibility. The lncli commands `setmccfg` and `getmccfg` are updated around this functionality. Note that deprecated configuration parameters were removed from the commands.
This commit is contained in:
7 files changed
+1074
-336
No files matched your search
@@ -7,6 +7,7 @@ import (
|
||||
"github.com/btcsuite/btcd/btcutil"
|
||||
"github.com/lightningnetwork/lnd/lnrpc/routerrpc"
|
||||
"github.com/lightningnetwork/lnd/lnwire"
|
||||
"github.com/lightningnetwork/lnd/routing"
|
||||
"github.com/lightningnetwork/lnd/routing/route"
|
||||
"github.com/urfave/cli"
|
||||
)
|
||||
@@ -45,26 +46,12 @@ var setCfgCommand = cli.Command{
|
||||
Category: "Mission Control",
|
||||
Usage: "Set mission control's config.",
|
||||
Description: `
|
||||
Update the config values being used by mission control to calculate
|
||||
the probability that payment routes will succeed.
|
||||
`,
|
||||
Update the config values being used by mission control to calculate the
|
||||
probability that payment routes will succeed. The estimator type must be
|
||||
provided to set estimator-related parameters.`,
|
||||
Flags: []cli.Flag{
|
||||
cli.DurationFlag{
|
||||
Name: "halflife",
|
||||
Usage: "the amount of time taken to restore a node " +
|
||||
"or channel to 50% probability of success.",
|
||||
},
|
||||
cli.Float64Flag{
|
||||
Name: "hopprob",
|
||||
Usage: "the probability of success assigned " +
|
||||
"to hops that we have no information about",
|
||||
},
|
||||
cli.Float64Flag{
|
||||
Name: "weight",
|
||||
Usage: "the degree to which mission control should " +
|
||||
"rely on historical results, expressed as " +
|
||||
"value in [0;1]",
|
||||
}, cli.UintFlag{
|
||||
// General settings.
|
||||
cli.UintFlag{
|
||||
Name: "pmtnr",
|
||||
Usage: "the number of payments mission control " +
|
||||
"should store",
|
||||
@@ -74,6 +61,48 @@ var setCfgCommand = cli.Command{
|
||||
Usage: "the amount of time to wait after a failure " +
|
||||
"before raising failure amount",
|
||||
},
|
||||
// Probability estimator.
|
||||
cli.StringFlag{
|
||||
Name: "estimator",
|
||||
Usage: "the probability estimator to use, choose " +
|
||||
"between 'apriori' or 'bimodal'",
|
||||
},
|
||||
// Apriori config.
|
||||
cli.DurationFlag{
|
||||
Name: "apriorihalflife",
|
||||
Usage: "the amount of time taken to restore a node " +
|
||||
"or channel to 50% probability of success.",
|
||||
},
|
||||
cli.Float64Flag{
|
||||
Name: "apriorihopprob",
|
||||
Usage: "the probability of success assigned " +
|
||||
"to hops that we have no information about",
|
||||
},
|
||||
cli.Float64Flag{
|
||||
Name: "aprioriweight",
|
||||
Usage: "the degree to which mission control should " +
|
||||
"rely on historical results, expressed as " +
|
||||
"value in [0, 1]",
|
||||
},
|
||||
// Bimodal config.
|
||||
cli.DurationFlag{
|
||||
Name: "bimodaldecaytime",
|
||||
Usage: "the time span after which we phase out " +
|
||||
"learnings from previous payment attempts",
|
||||
},
|
||||
cli.Uint64Flag{
|
||||
Name: "bimodalscale",
|
||||
Usage: "controls the assumed channel liquidity " +
|
||||
"imbalance in the network, measured in msat. " +
|
||||
"a low value (compared to typical channel " +
|
||||
"capacity) anticipates unbalanced channels.",
|
||||
},
|
||||
cli.Float64Flag{
|
||||
Name: "bimodalweight",
|
||||
Usage: "controls the degree to which the probability " +
|
||||
"estimator takes into account other channels " +
|
||||
"of a router",
|
||||
},
|
||||
},
|
||||
Action: actionDecorator(setCfg),
|
||||
}
|
||||
@@ -85,51 +114,140 @@ func setCfg(ctx *cli.Context) error {
|
||||
|
||||
client := routerrpc.NewRouterClient(conn)
|
||||
|
||||
resp, err := client.GetMissionControlConfig(
|
||||
// Fetch current mission control config which we update to create our
|
||||
// response.
|
||||
mcCfg, err := client.GetMissionControlConfig(
|
||||
ctxc, &routerrpc.GetMissionControlConfigRequest{},
|
||||
)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// haveValue is a helper variable to determine if a flag has been set or
|
||||
// the help should be displayed.
|
||||
var haveValue bool
|
||||
|
||||
if ctx.IsSet("halflife") {
|
||||
haveValue = true
|
||||
resp.Config.HalfLifeSeconds = uint64(ctx.Duration(
|
||||
"halflife",
|
||||
).Seconds())
|
||||
}
|
||||
|
||||
if ctx.IsSet("hopprob") {
|
||||
haveValue = true
|
||||
resp.Config.HopProbability = float32(ctx.Float64("hopprob"))
|
||||
}
|
||||
|
||||
if ctx.IsSet("weight") {
|
||||
haveValue = true
|
||||
resp.Config.Weight = float32(ctx.Float64("weight"))
|
||||
}
|
||||
|
||||
// Handle general mission control settings.
|
||||
if ctx.IsSet("pmtnr") {
|
||||
haveValue = true
|
||||
resp.Config.MaximumPaymentResults = uint32(ctx.Int("pmtnr"))
|
||||
mcCfg.Config.MaximumPaymentResults = uint32(ctx.Int("pmtnr"))
|
||||
}
|
||||
|
||||
if ctx.IsSet("failrelax") {
|
||||
haveValue = true
|
||||
resp.Config.MinimumFailureRelaxInterval = uint64(ctx.Duration(
|
||||
mcCfg.Config.MinimumFailureRelaxInterval = uint64(ctx.Duration(
|
||||
"failrelax",
|
||||
).Seconds())
|
||||
}
|
||||
|
||||
// We switch between estimators and set corresponding configs. If
|
||||
// estimator is not set, we ignore the values.
|
||||
if ctx.IsSet("estimator") {
|
||||
switch ctx.String("estimator") {
|
||||
case routing.AprioriEstimatorName:
|
||||
haveValue = true
|
||||
|
||||
// If we switch from another estimator, initialize with
|
||||
// default values.
|
||||
if mcCfg.Config.Model !=
|
||||
routerrpc.MissionControlConfig_APRIORI {
|
||||
|
||||
dCfg := routing.DefaultAprioriConfig()
|
||||
aParams := &routerrpc.AprioriParameters{
|
||||
HalfLifeSeconds: uint64(
|
||||
dCfg.PenaltyHalfLife.Seconds(),
|
||||
),
|
||||
HopProbability: dCfg.AprioriHopProbability, //nolint:lll
|
||||
Weight: dCfg.AprioriWeight,
|
||||
}
|
||||
|
||||
// We make sure the correct config is set.
|
||||
mcCfg.Config.EstimatorConfig =
|
||||
&routerrpc.MissionControlConfig_Apriori{
|
||||
Apriori: aParams,
|
||||
}
|
||||
}
|
||||
|
||||
// We update all values for the apriori estimator.
|
||||
mcCfg.Config.Model = routerrpc.
|
||||
MissionControlConfig_APRIORI
|
||||
|
||||
aCfg := mcCfg.Config.GetApriori()
|
||||
if ctx.IsSet("apriorihalflife") {
|
||||
aCfg.HalfLifeSeconds = uint64(ctx.Duration(
|
||||
"apriorihalflife",
|
||||
).Seconds())
|
||||
}
|
||||
|
||||
if ctx.IsSet("apriorihopprob") {
|
||||
aCfg.HopProbability = ctx.Float64(
|
||||
"apriorihopprob",
|
||||
)
|
||||
}
|
||||
|
||||
if ctx.IsSet("aprioriweight") {
|
||||
aCfg.Weight = ctx.Float64("aprioriweight")
|
||||
}
|
||||
|
||||
case routing.BimodalEstimatorName:
|
||||
haveValue = true
|
||||
|
||||
// If we switch from another estimator, initialize with
|
||||
// default values.
|
||||
if mcCfg.Config.Model !=
|
||||
routerrpc.MissionControlConfig_BIMODAL {
|
||||
|
||||
dCfg := routing.DefaultBimodalConfig()
|
||||
bParams := &routerrpc.BimodalParameters{
|
||||
DecayTime: uint64(
|
||||
dCfg.BimodalDecayTime.Seconds(),
|
||||
),
|
||||
ScaleMsat: uint64(
|
||||
dCfg.BimodalScaleMsat,
|
||||
),
|
||||
NodeWeight: dCfg.BimodalNodeWeight,
|
||||
}
|
||||
|
||||
// We make sure the correct config is set.
|
||||
mcCfg.Config.EstimatorConfig =
|
||||
&routerrpc.MissionControlConfig_Bimodal{
|
||||
Bimodal: bParams,
|
||||
}
|
||||
}
|
||||
|
||||
// We update all values for the bimodal estimator.
|
||||
mcCfg.Config.Model = routerrpc.
|
||||
MissionControlConfig_BIMODAL
|
||||
|
||||
bCfg := mcCfg.Config.GetBimodal()
|
||||
if ctx.IsSet("bimodaldecaytime") {
|
||||
bCfg.DecayTime = uint64(ctx.Duration(
|
||||
"bimodaldecaytime",
|
||||
).Seconds())
|
||||
}
|
||||
|
||||
if ctx.IsSet("bimodalscale") {
|
||||
bCfg.ScaleMsat = ctx.Uint64("bimodalscale")
|
||||
}
|
||||
|
||||
if ctx.IsSet("bimodalweight") {
|
||||
bCfg.NodeWeight = ctx.Float64(
|
||||
"bimodalweight",
|
||||
)
|
||||
}
|
||||
|
||||
default:
|
||||
return fmt.Errorf("unknown estimator %v",
|
||||
ctx.String("estimator"))
|
||||
}
|
||||
}
|
||||
|
||||
if !haveValue {
|
||||
return cli.ShowCommandHelp(ctx, "setmccfg")
|
||||
}
|
||||
|
||||
_, err = client.SetMissionControlConfig(
|
||||
ctxc, &routerrpc.SetMissionControlConfigRequest{
|
||||
Config: resp.Config,
|
||||
Config: mcCfg.Config,
|
||||
},
|
||||
)
|
||||
return err
|
||||
|
||||
Reference in new issue
Block a user