Skip to content

Conversation

@kstroobants
Copy link
Contributor

@kstroobants kstroobants commented Jul 23, 2025

Fixes #DXP-443

What

  • Replaced consensusMaxRotations with feesDistribution in various components.
  • Introduced new fees configuration in the .env.example file, including VITE_LEADER_TIMEOUT_FEE, VITE_VALIDATORS_TIMEOUT_FEE, VITE_APPEAL_ROUNDS_FEE, and VITE_ROTATIONS_FEE.
  • Added ConsensusInputSection component to manage consensus input settings.
  • Updated useConsensusStore to handle new fee-related state and logic.
  • Frontend look:
    • Red border=invalid value
    • Blue border=selected input
    • The number of rotations per round fields is equal to the value set in appeal rounds
    • Layout follows the provider section
Screenshot 2025-07-22 at 18 30 13 Screenshot 2025-07-22 at 18 30 04

Why

To add fees.

Testing done

Verified that the new fee settings are correctly loaded and stored in local storage.

Decisions made

Decided to store fee settings in local storage for persistence across sessions.

Checks

  • I have tested this code
  • I have reviewed my own PR
  • I have created an issue for this PR
  • I have set a descriptive PR title compliant with conventional commits

Reviewing tips

Focus on the changes.

Depends on

Implementation of DXP-445. That is why tests are failing.

User facing release notes

Introduced a fee structure for the consensus mechanism.

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features

    • Introduced separate configuration options for leader timeout fee, validators timeout fee, appeal rounds fee, and rotations fee.
    • Added a new component for grouped consensus fee inputs, allowing users to configure multiple fee parameters with validation.
    • Enhanced consensus settings UI with modular input sections and explanatory information.
  • Refactor

    • Replaced the previous single "max rotations" parameter with a structured fees distribution object throughout the simulator.
    • Updated contract deployment and write methods to use the new fees distribution structure.
    • Refactored consensus store to manage multiple fee states and persist them with localStorage.
  • Bug Fixes

    • Improved input validation for consensus fee parameters to ensure non-negative integer values.
  • Chores

    • Updated environment variable documentation to reflect new fee-related configuration keys.

@kstroobants kstroobants self-assigned this Jul 23, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 23, 2025

Walkthrough

The changes replace the single consensus rotation configuration with a more granular fee-based structure, introducing new parameters for leader timeout, validators timeout, appeal rounds, and rotations. This update propagates through environment configuration, store state, component props, and contract interaction logic, and introduces new types and modular input components for handling these settings.

Changes

File(s) Change Summary
.env.example Replaced VITE_MAX_ROTATIONS with four new fee-related config keys.
frontend/src/types/index.ts, frontend/src/types/store.ts Added new interfaces: FeesDistribution and ConsensusInput.
frontend/src/components/Simulator/ConstructorParameters.vue,
.../ContractMethodItem.vue,
.../ContractWriteMethods.vue
Updated prop signatures: replaced consensusMaxRotations with feesDistribution (type: FeesDistribution).
frontend/src/views/Simulator/RunDebugView.vue Replaced computed consensusMaxRotations with feesDistribution; updated props usage.
frontend/src/hooks/useContractQueries.ts Updated contract interaction functions to use feesDistribution instead of consensusMaxRotations.
frontend/src/stores/consensus.ts Replaced maxRotations state and setter with multiple fee states/setters; added logic for managing rotation fees.
frontend/src/components/Simulator/settings/ConsensusInputSection.vue Added new component for rendering grouped consensus fee inputs.
frontend/src/components/Simulator/settings/ConsensusSection.vue Refactored to use modular input sections for new fee parameters; removed old max rotations logic.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ConsensusSection
    participant ConsensusInputSection
    participant consensusStore
    participant RunDebugView
    participant ConstructorParameters
    participant ContractWriteMethods
    participant useContractQueries
    participant Backend

    User->>ConsensusSection: Update fee input
    ConsensusSection->>ConsensusInputSection: Pass input config
    ConsensusInputSection->>consensusStore: Call setter with new value
    consensusStore-->>ConsensusInputSection: Update state and persist
    ConsensusSection-->>RunDebugView: Store reflects new fees
    RunDebugView->>ConstructorParameters: Pass feesDistribution prop
    RunDebugView->>ContractWriteMethods: Pass feesDistribution prop
    ConstructorParameters->>useContractQueries: Deploy contract with feesDistribution
    ContractWriteMethods->>useContractQueries: Call write method with feesDistribution
    useContractQueries->>Backend: Send contract call with feesDistribution
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~45 minutes

Poem

In fields of code where carrots grow,
The fees now dance in tidy rows.
No more rotations, just fees to set,
For leaders, validators, and rounds unmet.
With sections neat and types anew,
This bunny hops to thank the crew!
🥕✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 37fb852 and 2d81a1b.

📒 Files selected for processing (1)
  • frontend/src/stores/consensus.ts (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • frontend/src/stores/consensus.ts
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Load Tests / load-test
  • GitHub Check: test
  • GitHub Check: backend-unit-tests
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch dxp-443-fees-parameters-frontend

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @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.

@kstroobants kstroobants changed the title Dxp 443 fees parameters frontend feat: fees parameters frontend Jul 23, 2025
coderabbitai[bot]

This comment was marked as resolved.

@sonarqubecloud
Copy link

Quality Gate Failed Quality Gate failed

Failed conditions
0.0% Coverage on New Code (required ≥ 80%)

See analysis details on SonarQube Cloud

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants