package
0.2.14-alpha
Repository: https://github.com/lightninglabs/faraday.git
Documentation: pkg.go.dev

# Functions

OutlierRecommendations returns recommendations based on whether a value is a lower outlier within its current dataset.
ThresholdRecommendations returns a recommendations based on whether a value is below a given threshold.
UseLogger uses a specified Logger to output package logging info.

# Constants

IncomingVolume bases recommendations on the incoming volume that the channel has processed, scaled by funding transaction confirmations.
IncomingVolume bases recommendations on the incoming volume that the channel has processed, scaled by funding transaction confirmations.
RevenueMetric bases recommendations on the revenue that the channel has generated per block that our capital has been committed for.
Subsystem defines the logging code for this subsystem.
UptimeMetric bases recommendations on the uptime of the channel's remote peer.
Volume bases recommendations on the total volume that the channel has processed, scaled by funding transaction confirmations.

# Variables

DefaultOutlierMultiplier is the default value used in close recommendations based on outliers when there is no user provided value.
ErrNoMetric is returned when a close recommendations with no chosen metric is provided.

# Structs

CloseRecommendationConfig provides the functions and parameters required to provide close recommendations.
Recommendation provides the value that a close recommendation was based on, and a boolean indicating whether we recommend closing the channel.
Report contains a set of close recommendations and information about the number of channels considered for close.

# Type aliases

Metric is an enum which indicate what data point our recommendations should be based on.