Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[bug]: lncli setmccfg --help options differ from the sample lnd.conf #7555

Open
Bitcoinite opened this issue Mar 30, 2023 · 2 comments
Open
Labels
bug Unintended code behaviour documentation Documentation changes that do not affect code behaviour needs triage

Comments

@Bitcoinite
Copy link

Background

Running lncli setmccfg --help gives the following explanations for the command options:

OPTIONS:
--pmtnr value the number of payments mission control should store (default: 0)
--failrelax value the amount of time to wait after a failure before raising failure amount (default: 0s)
--estimator value the probability estimator to use, choose between 'apriori' or 'bimodal' (bimodal is experimental)
--apriorihalflife value the amount of time taken to restore a node or channel to 50% probability of success. (default: 0s)
--apriorihopprob value the probability of success assigned to hops that we have no information about (default: 0)
--aprioriweight value the degree to which mission control should rely on historical results, expressed as value in [0, 1] (default: 0)
--aprioricapacityfraction value the fraction of channels' capacities that is considered liquid in pathfinding, a value between [0.75-1.0]. a value of 1.0 disables this feature. (default: 0)
--bimodaldecaytime value the time span after which we phase out learnings from previous payment attempts (default: 0s)
--bimodalscale value controls the assumed channel liquidity imbalance in the network, measured in msat. a low value (compared to typical channel capacity) anticipates unbalanced channels. (default: 0)
--bimodalweight value controls the degree to which the probability estimator takes into account other channels of a router (default: 0)

These explations, and especially the given defaults, differ from what is written in the sample lnd.conf:
https://github.com/lightningnetwork/lnd/blob/master/sample-lnd.conf

Also this doesn't make any sense:
--aprioricapacityfraction value the fraction of channels' capacities that is considered liquid in pathfinding, a value between [0.75-1.0]. a value of 1.0 disables this feature. (default: 0)

How can the default be 0, when the value has to be between [0.75-1.0]?

Your environment

lnd v0.16.0-beta

Steps to reproduce

Compare the results from lncli setmccfg --help with what is written in the sample lnd.conf

Expected behaviour

Both should state the same default values.

Actual behaviour

The information given differs.

@Bitcoinite Bitcoinite added bug Unintended code behaviour needs triage labels Mar 30, 2023
@bitromortac
Copy link
Collaborator

bitromortac commented Mar 30, 2023

Yes, this is misleading. If you only use lncli setmccfg --estimator=bimodal, the default values as in sample-lnd.conf are used. Perhaps we could set values in the cli flags to default values in order to have a better documentation.

@guggero
Copy link
Collaborator

guggero commented Mar 30, 2023

Unfortunately the "default" values in the CLI are notoriously hard to understand. 0 just means "the user did not enter a value" and often means you don't want to change that specific options in the backend by not specifying any flag in the CLI.
See #1523 and #6778 for more context.

@Roasbeef Roasbeef added the documentation Documentation changes that do not affect code behaviour label Apr 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Unintended code behaviour documentation Documentation changes that do not affect code behaviour needs triage
Projects
None yet
Development

No branches or pull requests

4 participants