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

# Functions

ChannelCapacity is an optional field that lets the gossiper know of the capacity of a channel.
ChannelPoint is an optional field that lets the gossiper know of the outpoint of a channel.
DisableLog disables all library log output.
IsKeepAliveUpdate determines whether this channel update is considered a keep-alive update based on the previous channel update processed for the same direction.
MultiSourceBootstrap attempts to utilize a set of NetworkPeerBootstrapper passed in to return the target (numAddrs) number of peer addresses that can be used to bootstrap a peer just joining the Lightning Network.
New creates a new AuthenticatedGossiper instance, initialized with the passed configuration parameters.
NewChanSeries constructs a new ChanSeries backed by a channeldb.ChannelGraph.
NewDNSSeedBootstrapper returns a new instance of the DNSSeedBootstrapper.
NewGraphBootstrapper returns a new instance of a ChannelGraphBootstrapper backed by an active autopilot.ChannelGraph instance.
NewMessageStore creates a new message store backed by a channeldb instance.
NewScidCloserMan creates a new ScidCloserMan.
RemoteAlias is an optional field that lets the gossiper know that a locally sent channel update is actually an update for the peer that should replace the ShortChannelID field with the remote's alias.
TapscriptRoot is an optional field that lets the gossiper know of the root of the tapscript tree for a custom channel.
UseLogger uses a specified Logger to output package logging info.

# Constants

ActiveSync denotes that a gossip syncer: 1.
DefaultChannelUpdateInterval is the default interval we'll use to determine how often we should allow a new update for a specific channel and direction.
DefaultDelayedQueryReplyInterval is the length of time we will wait before responding to gossip queries after replying to maxUndelayedQueryReplies queries.
DefaultHistoricalSyncInterval is the default interval in which we'll force a historical sync to ensure we have as much of the public network as possible.
DefaultMaxChannelUpdateBurst is the default maximum number of updates for a specific channel and direction that we'll accept over an interval.
DefaultMaxUndelayedQueryReplies specifies how many gossip queries we will respond to immediately before starting to delay responses.
DefaultSubBatchDelay is the default delay we'll use when broadcasting the next announcement batch.
DefaultSyncerRotationInterval is the default interval in which we'll rotate a single active syncer.
PassiveSync denotes that a gossip syncer: 1.
PinnedSync denotes an ActiveSync that doesn't count towards the default active syncer limits and is always active throughout the duration of the peer's connection.

# Variables

ErrCorruptedMessageStore indicates that the on-disk bucketing structure has altered since the gossip message store instance was initialized.
ErrGossiperShuttingDown is an error that is returned if the gossiper is in the process of being shut down.
ErrGossipSyncerExiting signals that the syncer has been killed.
ErrGossipSyncerNotFound signals that we were unable to find an active gossip syncer corresponding to a gossip query message received from the remote peer.
No description provided by the author
ErrSyncManagerExiting is an error returned when we attempt to start/stop a gossip syncer for a connected/disconnected peer, but the SyncManager has already been stopped.
ErrSyncTransitionTimeout is an error returned when we've timed out attempting to perform a sync transition.
ErrUnsupportedMessage is an error returned when we attempt to add a message to the store that is not supported.

# Structs

AuthenticatedGossiper is a subsystem which is responsible for receiving announcements, validating them and applying the changes to router, syncing lightning network with newly connected nodes, broadcasting announcements after validation, negotiating the channel announcement proofs exchange and handling the premature announcements.
ChannelGraphBootstrapper is an implementation of the NetworkPeerBootstrapper which attempts to retrieve advertised peers directly from the active channel graph.
ChanSeries is an implementation of the ChannelGraphTimeSeries interface backed by the channeldb ChannelGraph database.
Config defines the configuration for the service.
DNSSeedBootstrapper as an implementation of the NetworkPeerBootstrapper interface which implements peer bootstrapping via a special DNS seed as defined in BOLT-0010.
EdgeWithInfo contains the information that is required to update an edge.
GossipSyncer is a struct that handles synchronizing the channel graph state with a remote peer.
MessageStore is an implementation of the GossipMessageStore interface backed by a channeldb instance.
ScidCloserMan helps the gossiper handle closed channels that are in the ChannelGraph.
SyncManager is a subsystem of the gossiper that manages the gossip syncers for peers currently connected.
SyncManagerCfg contains all of the dependencies required for the SyncManager to carry out its duties.

# Interfaces

ChannelGraphTimeSeries is an interface that provides time and block based querying into our view of the channel graph.
ClosedChannelTracker handles closed channels being gossiped to us.
GossipMessageStore is a store responsible for storing gossip messages which we should reliably send to our peers.
GraphCloser handles tracking closed channels by their scid.
NetworkPeerBootstrapper is an interface that represents an initial peer bootstrap mechanism.
NodeInfoInquirier handles queries relating to specific nodes and channels they may have with us.

# Type aliases

OptionalMsgField is a functional option parameter that can be used to provide external information that is not included within a network message but serves useful when processing it.
PinnedSyncers is a set of node pubkeys for which we will maintain an active syncer at all times.
SyncerType encapsulates the different types of syncing mechanisms for a gossip syncer.