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

# Functions

DisableLog disables all library log output.
EncodeHexColor takes a color and returns it in hex code format.
IsError is a helper function which is needed to have ability to check that returned error has specific error code.
NewBuilder constructs a new Builder.
NewErrf creates a Error by the given error formatted description and its corresponding error code.
NewValidationBarrier creates a new instance of a validation barrier given the total number of active requests, and a quit channel which will be used to know when to kill pending, but unfilled jobs.
UseLogger uses a specified Logger to output package logging info.
ValidateChannelAnn validates the channel announcement message and checks that node signatures covers the announcement message, and that the bitcoin signatures covers the node keys.
ValidateChannelUpdateAnn validates the channel update announcement by checking (1) that the included signature covers the announcement and has been signed by the node's private key, and (2) that the announcement's message flags and optional fields are sane.
ValidateChannelUpdateFields validates a channel update's message flags and corresponding update fields.
ValidateNodeAnn validates the node announcement by ensuring that the attached signature is needed a signature of the node announcement under the specified node public key.
VerifyChannelUpdateSignature verifies that the channel update message was signed by the party with the given node public key.

# Constants

DefaultChannelPruneExpiry is the default duration used to determine if a channel should be pruned or not.
DefaultFirstTimePruneDelay is the time we'll wait after startup before attempting to prune the graph for zombie channels.
ErrChannelSpent is returned when we go to validate a channel, but the purported funding output has actually already been spent on chain.
ErrIgnored is returned when the update have been ignored because this update can't bring us something new, or because a node announcement was given for node not found in any channel.
ErrInvalidFundingOutput is returned if the channel funding output fails validation.
ErrNoFundingTransaction is returned when we are unable to find the funding transaction described by the short channel ID on chain.
ErrOutdated is returned when the routing update already have been applied, or a newer update is already known.
ErrParentValidationFailed signals that the validation of a dependent's parent failed, so the dependent must not be processed.
ErrVBarrierShuttingDown signals that the barrier has been requested to shutdown, and that the caller should not treat the wait condition as fulfilled.
No description provided by the author

# Variables

ErrGraphBuilderShuttingDown is returned if the graph builder is in the process of shutting down.

# Structs

Builder builds and maintains a view of the Lightning Network graph.
ChannelEdgeUpdate is an update for a new channel within the ChannelGraph.
ClosedChanSummary is a summary of a channel that was detected as being closed by monitoring the blockchain.
Config holds the configuration required by the Builder.
Error is a structure that represent the error inside the graph package, this structure carries additional information about error code in order to be able distinguish errors outside of the current package.
NetworkNodeUpdate is an update for a node within the Lightning Network.
TopologyChange represents a new set of modifications to the channel graph.
TopologyClient represents an intent to receive notifications from the channel router regarding changes to the topology of the channel graph.
ValidationBarrier is a barrier used to ensure proper validation order while concurrently validating new announcements for channel edges, and the attributes of channel edges.

# Interfaces

ChannelGraphSource represents the source of information about the topology of the lightning network.
DB is an interface describing a persisted Lightning Network graph.

# Type aliases

ErrorCode is used to represent the various errors that can occur within this package.