refactor: database and checkpoint dependencies #421
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
It declares the expected db interface by the checkpoint manager
…tabase interface declared in checkpoint package
najeal
requested review from
iansuvak,
feuGeneA,
geoff-vball,
minghinmatthewlam,
bernard-avalabs,
michaelkaplan13 and
cam-schultz
geoff-vball
reviewed
Aug 9, 2024
database/kvstore.go
Outdated
Comment on lines
33
to
36
| usedDB := "Redis" | ||
| if cfg.RedisURL != "" { | ||
| dbConnect = func() (keyValueDatabase, error) { return NewRedisDatabase(logger, cfg.StorageLocation, relayerIDs) } | ||
| usedDB = "JSON" |
There was a problem hiding this comment.
The usedDB values here are flipped.
geoff-vball
approved these changes
Aug 13, 2024
There was a problem hiding this comment.
LGTM, but @cam-schultz should take a look at this as well :)
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.
Why this should be merged
It closes #418
This PR is a proposition and open discussion for the refactoring of the database and the checkpoint packages.
How this works
This declares the DB interface that checkpoint manager is expecting.
It hides database complexity and implementation details.
Checkpoint package has no more dependency on database package, database has dependency on checkpoint.
RelayerID is a "business object", the declaration has been moved into the relayer package.
How this was tested
Existing tests have been adapted.
How is this documented