package
0.18.4-beta.rc2
Repository: https://github.com/lightningnetwork/lnd.git
Documentation: pkg.go.dev

# Functions

ChannelUpdateFromEdge reconstructs a signed ChannelUpdate from the given edge info and policy.
ChanUpdSetDisable is a functional option that sets the disabled channel flag if disabled is true, and clears the bit otherwise.
ChanUpdSetTimestamp is a functional option that sets the timestamp of the update to the current time, or increments it if the timestamp is already in the future.
CreateChanAnnouncement is a helper function which creates all channel announcements given the necessary channel related database items.
DisableLog disables all library log output.
ExtractChannelUpdate attempts to retrieve a lnwire.ChannelUpdate message from an edge's info and a set of routing policies.
IPAnnouncer is a factory function that generates a new function that uses the passed annUpdater function to to announce new IP changes for a given host.
NewChanStatusManager initializes a new ChanStatusManager using the given configuration.
NewHostAnnouncer returns a new instance of the HostAnnouncer.
NewNodeSigner creates a new instance of the NodeSigner backed by the target private key.
NodeAnnSetAddrs is a functional option that allows updating the addresses of the given node announcement.
NodeAnnSetAlias is a functional option that sets the alias of the given node announcement.
NodeAnnSetColor is a functional option that sets the color of the given node announcement.
NodeAnnSetFeatures is a functional option that allows updating the features of the given node announcement.
NodeAnnSetTimestamp is a functional option that sets the timestamp of the announcement to the current time, or increments it if the timestamp is already in the future.
SignAnnouncement signs any type of gossip message that is announced on the network.
SignChannelUpdate applies the given modifiers to the passed lnwire.ChannelUpdate, then signs the resulting update.
SignNodeAnnouncement signs the lnwire.NodeAnnouncement provided, which should be the most recent, valid update, otherwise the timestamp may not monotonically increase from the prior.
UnsignedChannelUpdateFromEdge reconstructs an unsigned ChannelUpdate from the given edge info and policy.
UseLogger uses a specified Logger to output package logging info.

# Constants

ChanStatusDisabled indicates that the channel's last announcement has the disabled bit set.
ChanStatusEnabled indicates that the channel's last announcement has the disabled bit cleared.
ChanStatusManuallyDisabled indicates that the channel's last announcement had the disabled bit set, and that a user manually requested disabling the channel.
ChanStatusPendingDisabled indicates that the channel's last announcement has the disabled bit cleared, but that the channel was detected in an inactive state.

# Variables

ErrChanStatusManagerExiting signals that a shutdown of the ChanStatusManager has already been requested.
ErrEnableInactiveChan signals that a request to enable a channel could not be completed because the channel isn't actually active at the time of the request.
ErrEnableManuallyDisabledChan signals that an automatic / background request to enable a channel could not be completed because the channel was manually disabled.
ErrInvalidTimeoutConstraints signals that the ChanStatusManager could not be initialized because the timeouts and sample intervals were malformed.
ErrUnableToExtractChanUpdate is returned when a channel update cannot be found for one of our active channels.

# Structs

ChannelState describes the ChanStatusManager's view of a channel, and describes the current state the channel's disabled status on the network.
ChanStatusConfig holds parameters and resources required by the ChanStatusManager to perform its duty.
ChanStatusManager facilitates requests to enable or disable a channel via a network announcement that sets the disable bit on the ChannelUpdate accordingly.
HostAnnouncer is a sub-system that allows a user to specify a set of hosts for lnd that will be continually resolved to notice any IP address changes.
HostAnnouncerConfig is the main config for the HostAnnouncer.
NodeSigner is an implementation of the MessageSigner interface backed by the identity private key of running lnd node.

# Interfaces

ChannelGraph abstracts the required channel graph queries used by the ChanStatusManager.
DB abstracts the required database functionality needed by the ChanStatusManager.

# Type aliases

ChannelUpdateModifier is a closure that makes in-place modifications to an lnwire.ChannelUpdate.
ChanStatus is a type that enumerates the possible states a ChanStatusManager tracks for its known channels.
NodeAnnModifier is a closure that makes in-place modifications to an lnwire.NodeAnnouncement.
NodeAnnUpdater describes a function that's able to update our current node announcement on disk.