Skip to content

Conversation

@kstroobants
Copy link
Contributor

@kstroobants kstroobants commented Jul 23, 2025

Fixes #DXP-444

What

  • Added an on/off toggle button for fees in the simulator settings.
  • When the toggle is off, the application sends undefined for fees to deploy and write method and hides the fee fields.
  • Introduced a new feesEnabled state in the consensusStore to manage the toggle state.
  • Updated the feesDistribution prop to be optional in several components.
  • Modified the useContractQueries hook to handle the optional feesDistribution.

Why

To provide users with the ability to enable or disable fees dynamically.

Testing done

  • Tested the toggle button to ensure it correctly updates the state and UI.
  • Verified that when fees are disabled, undefined is sent and fee fields are hidden.
  • Checked that existing functionality remains unaffected when fees are enabled.

Decisions made

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

This PR contains code from PR #1265.
Tests are failing because it depends on genlayer-js DXP-445.

User facing release notes

  • Introduced a new toggle feature to enable or disable fees in the simulator settings.
  • When fees are disabled, related fields are hidden, and no fees are applied.

Summary by CodeRabbit

  • New Features

    • Introduced granular fee configuration options for consensus mechanisms, including leader timeout, validators timeout, appeal rounds, and rotations per round.
    • Added a global toggle to enable or disable fees in the consensus settings.
    • Added new input sections for configuring multiple fee categories in the consensus settings UI.
  • Improvements

    • Enhanced consensus settings UI for better modularity and clarity.
    • Fee-related settings are now persisted across sessions.
  • Refactor

    • Replaced the previous single "Max Rotations" parameter with a comprehensive fee distribution structure throughout the simulator interface.

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

coderabbitai bot commented Jul 23, 2025

Walkthrough

The changes restructure the consensus configuration in both environment and frontend code, replacing the single maxRotations parameter with a detailed fee distribution system. New environment variables and frontend state are introduced for granular fee control, with corresponding updates to types, components, and store logic. UI components are refactored to support these changes, including new input sections and persistent state management.

Changes

File(s) Change Summary
.env.example Replaced VITE_MAX_ROTATIONS with new fee-related variables and a global enable flag.
frontend/src/types/index.ts Added FeesDistribution interface.
frontend/src/types/store.ts Added ConsensusInput interface.
frontend/src/stores/consensus.ts Replaced maxRotations with granular, persistent fee state and setters; added localStorage sync logic.
frontend/src/hooks/useContractQueries.ts Updated function signatures and usage from consensusMaxRotations to feesDistribution.
frontend/src/views/Simulator/RunDebugView.vue Replaced consensusMaxRotations with computed feesDistribution; updated prop passing and minor styling.
frontend/src/components/Simulator/ConstructorParameters.vue Changed prop from consensusMaxRotations to feesDistribution; updated contract deployment logic.
frontend/src/components/Simulator/ContractMethodItem.vue Changed prop from consensusMaxRotations to feesDistribution; updated method invocation logic.
frontend/src/components/Simulator/ContractWriteMethods.vue Changed prop from consensusMaxRotations to feesDistribution; updated child component invocation.
frontend/src/components/Simulator/settings/ConsensusInputSection.vue New component: renders sectioned numeric fee inputs, validates, and updates state via setters.
frontend/src/components/Simulator/settings/ConsensusSection.vue Refactored UI: removed max rotations input, added fee enable toggle and grouped fee input sections.

Sequence Diagram(s)

sequenceDiagram
  participant User
  participant ConsensusSection
  participant ConsensusStore
  participant RunDebugView
  participant ContractComponent

  User->>ConsensusSection: Toggle fees, input fee values
  ConsensusSection->>ConsensusStore: setFeesEnabled/setFee values
  User->>RunDebugView: Initiate contract deploy/write
  RunDebugView->>ContractComponent: Pass feesDistribution prop
  ContractComponent->>useContractQueries: Deploy/write with feesDistribution
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~45 minutes

Poem

In the warren of code, a change takes root—
No more one rotation, but fees resolute!
Toggles and inputs, all shiny and new,
Granular controls for the consensus crew.
With carrots for fees, and settings that last,
This bunny hops forward, leaving max rotations in the past!
🥕✨

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 65b6624 and 361da58.

📒 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). (1)
  • 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-444-fees-mechanism-onoff

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.

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

@kstroobants kstroobants requested a review from danieljrc888 July 24, 2025 03:25
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