watchtower pkg #2448
Merged
watchtower pkg #2448
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cfromknecht
added
watchtower
config
cfromknecht
force-pushed
the
watchtower-pkg
branch
2 times, most recently
from
6541aae
to
9957ed3
Compare
Roasbeef
reviewed
Jan 12, 2019
watchtower/watchtower.go
Outdated
| "github.com/lightningnetwork/lnd/watchtower/wtserver" | ||
| ) | ||
|
|
||
| // Watchtower encapsulates the server-side functionality required by watchtower |
There was a problem hiding this comment.
watchtower.Watchtower 🙃
The redundancy...Server perhaps? Not a blocking comment.
There was a problem hiding this comment.
I took a stab and went with Standalone, since it really couples a server and the breach monitoring services in one unit. In the future we could add the split implementations to this package, e.g. watchtower.Endpoint and watchtower.Monitor or something along those lines. Let me know what you think
cfromknecht
force-pushed
the
watchtower-pkg
branch
3 times, most recently
from
7ec50be
to
11049b0
Compare
|
Comments addressed, @Roasbeef PTAL |
cfromknecht
force-pushed
the
watchtower-pkg
branch
from
11049b0
to
b32afd9
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In this PR, we introduce the
watchtowerpackage used to configure and run a watchtower. The top levelwatchtower.Standalonestruct couples thelookoutandwtserversubsystems, enabling the full server-side protocol and breach monitoring. It also initializes the WTWR subsystem logger, which will be inherited by both the lookout and wtserver packages.In order to facilitate the package's use as an extension to LND or a standalone daemon, the
watchtower.Configprovides a common interface for all of the towers resources and configurable parameters. These resources are then passed down to the appropriate subsystems so that they can faithfully perform their duties. Some of these options are to be configured from the command line, which leads us to:Considerations for CLI Configuration
As these parameters begin to be exposed as CLI flags or config file options, we introduce the
watchtower.Confwhich exports the configurable parameters. This struct is meant to be embedded into a higher-level config struct and can be grouped according to the applications needs.For example, LND will use a small sub-config with an
Activeflag and be grouped under a "watchtower" prefix. If the watchtower is to run in a standalone daemon, thewatchtower.Confcan be embedded directly into the primary config, as it is already assumed that the tower is to be active. As more parameters are exposed, this will provide a common interface to users of the package.Assuming all other resources have been provided to a
watchtower.Config, any parameters parsed into awatchtower.Confcan then be applied to aConfigto generate the final config that should be passed towatchtower.New. If no CLI configuration is necessary, users of the package can set the values in theirwatchtower.Configdireclty.Note: This PR does not expose the watchtower configuration options in LND's config, it only adds the struct that will later be embedded. Further, the configuration options are only available in experimental builds as there are few moving parts of the protocol that should be solidified before attempting to operate a tower.