Clarify field names for simplex p2p messages#4002
Merged
StephenButtolph merged 2 commits intomasterfrom Jun 9, 2025
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
Renames the finalization field in the QuorumCertificate message to block_header for better clarity in both the .proto definition and generated Go code.
- Changed the
QuorumCertificatefield name inp2p.proto - Regenerated
p2p.pb.goto update struct field and accessor method
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| proto/p2p/p2p.proto | Renamed finalization → block_header in the message definition |
| proto/pb/p2p/p2p.pb.go | Updated generated struct field and GetFinalization → GetBlockHeader |
Comments suppressed due to low confidence (2)
proto/p2p/p2p.proto:486
- Renaming this field is a backward-incompatible change for existing protobuf consumers; consider providing a deprecated alias for
finalizationor documenting a clear migration path in your release notes.
BlockHeader block_header = 1;
proto/p2p/p2p.proto:486
- [nitpick] Add a comment above this field in the
.protofile to describe whatblock_headerrepresents, improving readability and future maintenance.
BlockHeader block_header = 1;
yacovm
approved these changes
Jun 9, 2025
samliok
changed the title
StephenButtolph
approved these changes
Jun 9, 2025
This file contains hidden or 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
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
Small nit that was not found in the last merged simplex pr. Quorum certificates can be notarizations or finalizations so the old field name doesn't make sense. Similarly, changed names for other fields to
block_header&metadatafor more clarity.How this works
How this was tested
Need to be documented in RELEASES.md?
no