package
0.5.1
Repository: https://github.com/sputn1ck/lnd.git
Documentation: pkg.go.dev

# Functions

AuthDial is the watchtower client's default method of dialing.
DeriveSessionKey accepts an session key index for an existing session and derives the HD private key to be used to authenticate the brontide transport and authenticate requests sent to the tower.
DisableLog disables all library log output.
New initializes a new TowerClient from the provide Config.
UseLogger uses a specified Logger to output package logging info.

# Constants

DefaultForceQuitDelay specifies the default duration after which the client should abandon any pending updates or session negotiations before terminating.
DefaultReadTimeout specifies the default duration we will wait during a read before breaking out of a blocking read.
DefaultStatInterval specifies the default interval between logging metrics about the client's operation.
DefaultWriteTimeout specifies the default duration we will wait during a write before breaking out of a blocking write.

# Variables

ErrClientExiting signals that the watchtower client is shutting down.
ErrFailedNegotiation signals that the session negotiator could not acquire a new session as requested.
ErrNegotiatorExiting signals that the SessionNegotiator is shutting down.
ErrNoTowerAddrs signals that the client could not be created because we have no addresses with which we can reach a tower.
ErrPermanentTowerFailure signals that the tower has reported that it has permanently failed or the client believes this has happened based on the tower's behavior.
ErrTowerCandidatesExhausted signals that a TowerCandidateIterator has cycled through all available candidates.
ErrUnregisteredChannel signals that the client was unable to backup a revoked state because the channel had not been previously registered with the client.

# Structs

ClientStats is a collection of in-memory statistics of the actions the client has performed since its creation.
Config provides the TowerClient with access to the resources it requires to perform its duty.
NegotiatorConfig provides access to the resources required by a SessionNegotiator to faithfully carry out its duties.
RegisteredTower encompasses information about a registered watchtower with the client.
TowerClient is a concrete implementation of the Client interface, offering a non-blocking, reliable subsystem for backing up revoked states to a specified private tower.

# Interfaces

Client is the primary interface used by the daemon to control a client's lifecycle and backup revoked states.
DB abstracts the required database operations required by the watchtower client.
SecretKeyRing abstracts the ability to derive HD private keys given a description of the derivation path.
SessionNegotiator is an interface for asynchronously requesting new sessions.
TowerCandidateIterator provides an abstraction for iterating through possible watchtower addresses when attempting to create a new session.

# Type aliases

AuthDialer connects to a remote node using an authenticated transport, such as brontide.
Dial connects to an addr using the specified net and returns the connection object.