refactor: improve key prefix constants and documentation #1570
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
tiendn
requested review from
rootulp and
evan-forbes
and removed request for
a team
rootulp
reviewed
Dec 20, 2024
Comment on lines
+497
to
+507
| // Key prefixes for different types of data | ||
| const ( | ||
| // Key prefixes | ||
| blockMetaPrefix = "H" // Height -> BlockMeta | ||
| blockPartPrefix = "P" // Height + index -> Block Part | ||
| blockCommitPrefix = "C" // Height -> Commit | ||
| seenCommitPrefix = "SC" // Height -> Seen Commit | ||
| blockHashPrefix = "BH" // Hash -> Height | ||
| txHashPrefix = "TH" // Hash -> TxInfo | ||
| stateKey = "blockStore" // Fixed key for block store state | ||
| ) |
There was a problem hiding this comment.
[question] what motivated this change? Can it be upstreamed to CometBFT so that we can pull it here? None of this seems specific to Celestia.
Ref: https://github.com/celestiaorg/celestia-core?tab=readme-ov-file#contributing
rootulp
changed the title
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.
Description
Add constants for key prefixes used in block store with clear documentation
of their purpose and format. This change:
This improves maintainability and reduces the chance of key collisions
in the database. The change is backwards compatible as the actual key
formats remain unchanged.
PR checklist
.changelog(we useunclog to manage our changelog)
docs/orspec/) and code comments