package
0.0.3
Repository: https://github.com/bittap-protocol/lnd.git
Documentation: pkg.go.dev

# Functions

ChannelGraphFromCachedDatabase returns an instance of the autopilot.ChannelGraph backed by a live, open channeldb instance.
ChannelGraphFromDatabase returns an instance of the autopilot.ChannelGraph backed by a live, open channeldb instance.
DisableLog disables all library log output.
Median returns the median value in the slice of Amounts.
New creates a new instance of the Agent instantiated using the passed configuration and initial channel state.
NewBetweennessCentralityMetric creates a new BetweennessCentrality instance.
NewConstraints returns a new AgentConstraints with the given limits.
NewExternalScoreAttachment creates a new instance of an ExternalScoreAttachment.
NewManager creates a new instance of the Manager from the passed config.
NewNodeID creates a new nodeID from a passed public key.
NewPrefAttachment creates a new instance of a PrefAttachment heuristic.
NewSimpleGraph creates a simplified graph from the current channel graph.
NewTopCentrality constructs and returns a new TopCentrality heuristic.
NewWeightedCombAttachment creates a new instance of a WeightedCombAttachment.
UseLogger uses a specified Logger to output package logging info.

# Constants

DefaultConfTarget is the default confirmation target for autopilot channels.

# Variables

AvailableHeuristics is a map that holds the name of available heuristics to the actual heuristic for easy lookup.
ErrNoPositive is returned from weightedChoice when there are no positive weights left to choose from.

# Structs

Agent implements a closed-loop control system which seeks to autonomously optimize the allocation of satoshis within channels throughput the network's channel graph.
AttachmentDirective describes a channel attachment proscribed by an AttachmentHeuristic.
BetweennessCentrality is a NodeMetric that calculates node betweenness centrality using Brandes' algorithm.
ChannelEdge is a struct that holds details concerning a channel, but also contains a reference to the Node that this channel connects to as a directed edge within the graph.
Config couples all the items that an autopilot agent needs to function.
ExternalScoreAttachment is an implementation of the AttachmentHeuristic interface that allows an external source to provide it with node scores.
LocalChannel is a simple struct which contains relevant details of a particular channel the local node has.
Manager is struct that manages an autopilot agent, making it possible to enable and disable it at will, and hand it relevant external information.
ManagerCfg houses a set of values and methods that is passed to the Manager for it to properly manage its autopilot agent.
NodeScore is a tuple mapping a NodeID to a score indicating the preference of opening a channel with it.
PrefAttachment is an implementation of the AttachmentHeuristic interface that implement a non-linear preferential attachment heuristic.
SimpleGraph stores a simplified adj graph of a channel graph to speed up graph processing by eliminating all unnecessary hashing and map access.
TopCentrality is a simple greedy technique to create connections to nodes with the top betweenness centrality value.
WeightedCombAttachment is an implementation of the AttachmentHeuristic interface that combines the scores given by several sub-heuristics into one.
WeightedHeuristic is a tuple that associates a weight to an AttachmentHeuristic.

# Interfaces

AgentConstraints is an interface the agent will query to determine what limits it will need to stay inside when opening channels.
AttachmentHeuristic is one of the primary interfaces within this package.
ChannelController is a simple interface that allows an auto-pilot agent to open a channel within the graph to a target peer, close targeted channels, or add/remove funds from existing channels via a splice in/out mechanisms.
ChannelGraph in an interface that represents a traversable channel graph.
Node is an interface which represents n abstract vertex within the channel graph.
NodeMetric is a common interface for all graph metrics that are not directly used as autopilot node scores but may be used in compositional heuristics or statistical information exposed to users.
ScoreSettable is an interface that indicates that the scores returned by the heuristic can be mutated by an external caller.

# Type aliases

HeuristicScores is an alias for a map that maps heuristic names to a map of scores for pubkeys.
NodeID is a simple type that holds an EC public key serialized in compressed format.