Skip to content
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

fix(drive-abci): rebroadcasting should not only take first 2 quorums too #2425

Merged
merged 1 commit into from
Jan 15, 2025

Conversation

QuantumExplorer
Copy link
Member

@QuantumExplorer QuantumExplorer commented Jan 15, 2025

Issue being fixed or feature implemented

We forgot to up the version used here to 2.

What was done?

How Has This Been Tested?

Breaking Changes

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added or updated relevant unit/integration/functional/e2e tests
  • I have added "!" to the title and described breaking changes in the corresponding section if my code contains any
  • I have made corresponding changes to the documentation if needed

For repository code-owners and collaborators only

  • I have assigned this pull request to a milestone

Summary by CodeRabbit

  • New Features
    • Updated method versions for withdrawal and voting processes
    • Enhanced flexibility for pooling withdrawals across validator quorums
    • Improved handling of expired withdrawal documents and contested resource vote poll cleanup

@QuantumExplorer QuantumExplorer added this to the v1.8.0 milestone Jan 15, 2025
Copy link
Contributor

coderabbitai bot commented Jan 15, 2025

Walkthrough

The pull request introduces version updates for specific methods in the Drive ABCI versioning system. These changes modify the versioning for methods related to withdrawal processing and voting mechanisms. The updates include changes to pool_withdrawals_into_transactions_queue, rebroadcast_expired_withdrawal_documents, and clean_up_after_contested_resources_vote_poll_end methods, incrementing their versions from 0 to 1. This suggests modifications in how withdrawals are processed and how voting-related cleanup operations are handled across validator quorums.

Changes

File Change Summary
packages/rs-platform-version/src/version/drive_abci_versions/drive_abci_method_versions/v5.rs - Updated pool_withdrawals_into_transactions_queue method version from 0 to 1
- Updated rebroadcast_expired_withdrawal_documents method version from 0 to 1
- Updated clean_up_after_contested_resources_vote_poll_end method version from 0 to 1

Suggested Reviewers

  • lklimek

Poem

🐰 Versions dance, a rabbit's delight,
Methods leap from zero to one so bright!
Withdrawals pool, votes clean with grace,
Quorums expand their coding space 🌟
A version update, swift and neat! 🚀


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
packages/rs-platform-version/src/version/drive_abci_versions/drive_abci_method_versions/v5.rs (1)

Line range hint 95-95: Document the rationale for voting method version update.

The version update for clean_up_after_contested_resources_vote_poll_end lacks documentation explaining the changes in behavior between v0 and v1. Please add a comment similar to the withdrawal methods to explain the rationale for this version bump.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2abce8e and 2185db9.

📒 Files selected for processing (1)
  • packages/rs-platform-version/src/version/drive_abci_versions/drive_abci_method_versions/v5.rs (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (18)
  • GitHub Check: Rust packages (drive) / Tests
  • GitHub Check: Rust packages (drive) / Unused dependencies
  • GitHub Check: Rust packages (drive) / Linting
  • GitHub Check: Rust packages (drive) / Formatting
  • GitHub Check: Rust packages (dpp) / Tests
  • GitHub Check: Rust packages (dpp) / Check each feature
  • GitHub Check: Rust packages (dpp) / Unused dependencies
  • GitHub Check: Rust packages (dpp) / Linting
  • GitHub Check: Rust packages (dash-sdk) / Tests
  • GitHub Check: Rust packages (dash-sdk) / Check each feature
  • GitHub Check: Rust packages (dash-sdk) / Linting
  • GitHub Check: Rust packages (dapi-grpc) / Tests
  • GitHub Check: Rust packages (dapi-grpc) / Check each feature
  • GitHub Check: Rust packages (dapi-grpc) / Linting
  • GitHub Check: Build Docker images (Drive, drive, drive-abci) / Build Drive image
  • GitHub Check: Build Docker images (Dashmate helper, dashmate-helper, dashmate-helper) / Build Dashmate helper image
  • GitHub Check: Build Docker images (DAPI, dapi, dapi) / Build DAPI image
  • GitHub Check: Build JS packages / Build JS
🔇 Additional comments (2)
packages/rs-platform-version/src/version/drive_abci_versions/drive_abci_method_versions/v5.rs (2)

87-88: LGTM! Clear rationale for version updates.

The version updates for withdrawal-related methods are well-documented and consistently applied. The changes remove the temporary restriction of using only the first two quorums, which was a workaround for a Core v21 bug.


87-88: Verify intended version numbers.

The PR description mentions that "version used should be updated to 2", but the changes update methods from version 0 to 1. Please verify if:

  1. These methods should be updated to version 2 instead of 1, or
  2. The PR description needs to be updated to reflect the correct version numbers.

Also applies to: 95-95

@QuantumExplorer QuantumExplorer changed the title fix: rebroadcasting should not only take first 2 quorums too fix(drive-abci): rebroadcasting should not only take first 2 quorums too Jan 15, 2025
@QuantumExplorer QuantumExplorer merged commit 410eb09 into v1.8-dev Jan 15, 2025
79 checks passed
@QuantumExplorer QuantumExplorer deleted the fix/rebroadcastingMoreQuorums branch January 15, 2025 23:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant