Skip to content

Clarify field names for simplex p2p messages #4002

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 9, 2025

Conversation

samliok
Copy link
Contributor

@samliok samliok commented Jun 9, 2025

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 & metadata for more clarity.

How this works

How this was tested

Need to be documented in RELEASES.md?

no

@samliok samliok self-assigned this Jun 9, 2025
@Copilot Copilot AI review requested due to automatic review settings June 9, 2025 18:22
@samliok samliok requested a review from StephenButtolph as a code owner June 9, 2025 18:22
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 QuorumCertificate field name in p2p.proto
  • Regenerated p2p.pb.go to 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 finalizationblock_header in the message definition
proto/pb/p2p/p2p.pb.go Updated generated struct field and GetFinalizationGetBlockHeader
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 finalization or 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 .proto file to describe what block_header represents, improving readability and future maintenance.
BlockHeader block_header = 1;

@samliok samliok changed the title Change Name for QuorumCertificate Field Clarify field names for simplex p2p messages Jun 9, 2025
@StephenButtolph StephenButtolph enabled auto-merge June 9, 2025 18:44
@StephenButtolph StephenButtolph added this pull request to the merge queue Jun 9, 2025
Merged via the queue into master with commit a52b9e9 Jun 9, 2025
28 checks passed
@StephenButtolph StephenButtolph deleted the simplex-message-nit branch June 9, 2025 19:05
@github-project-automation github-project-automation bot moved this to Done 🎉 in avalanchego Jun 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants