feat: calculateReward to return 0 if claimed

[lirona]

Summary by CodeRabbit

• Bug Fixes

  • Improved reward calculation to ensure that once a reward for a round has been claimed, subsequent calculations for that round correctly return zero.

• Tests

  • Added a test to confirm that rewards cannot be recalculated after being claimed.
  • Updated an existing test to ensure proper setup for nonfinancial contributions before redemption attempts.

• Style

  • Reformatted a function for improved readability without changing its behavior.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes include a refactor in Hyperstaker.sol where the reward calculation logic is moved to a new internal function _calculateReward. The public calculateReward function now returns zero if the reward for a given round and Hypercert has already been claimed, otherwise it delegates to the internal function. The claimReward function is updated to call the internal calculation directly. In Hyperfund.sol, a function signature is reformatted for readability without altering logic. Tests are updated and expanded to ensure correct behavior, including a new test that checks calculateReward returns zero after a reward is claimed.

Changes

File(s)	Change Summary
src/Hyperfund.sol	Reformatted nonfinancialContribution function signature to multi-line style; no logic changes.
src/Hyperstaker.sol	Refactored reward calculation: added _calculateReward internal function, updated calculateReward and claimReward to use it. Added claimed-round check to calculateReward.
test/Hyperfund.t.sol	Added setup in test_RevertWhen_RedeemNotFraction to record a nonfinancial contribution before redeem test.
test/Hyperstaker.t.sol	Added test_CalculateReward_0WhenRoundClaimed to assert calculateReward returns zero after claim.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Hyperstaker

    User->>Hyperstaker: claimReward(_hypercertId, _roundId)
    Hyperstaker->>Hyperstaker: _calculateReward(_hypercertId, _roundId)
    Note right of Hyperstaker: Internal validation and calculation
    Hyperstaker-->>User: Reward amount

    User->>Hyperstaker: calculateReward(_hypercertId, _roundId)
    Hyperstaker->>Hyperstaker: Check if reward already claimed
    alt Already claimed
        Hyperstaker-->>User: 0
    else Not claimed
        Hyperstaker->>Hyperstaker: _calculateReward(_hypercertId, _roundId)
        Hyperstaker-->>User: Reward amount
    end

Loading

Possibly related issues

• calculate reward to return 0 if reward has been claimed #62: This change directly implements the request for calculateReward to return zero if the reward has already been claimed.

Possibly related PRs

• feat: hyperstaker multi round support #50: This PR builds on multi-round reward tracking and claimed-round logic, which is further refactored in the current changes.

Poem

In code we hop, from line to line,
Refactoring logic, rewards now align.
If claimed, it's zero—no double delight,
Internal helpers keep the calculation tight.
With tests that ensure all is sound,
The garden of contracts grows safe and profound!
🐇✨

---

📜 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 cea4bca and fbd95e5.

📒 Files selected for processing (4)

• src/Hyperfund.sol (1 hunks)
• src/Hyperstaker.sol (3 hunks)
• test/Hyperfund.t.sol (1 hunks)
• test/Hyperstaker.t.sol (1 hunks)

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

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 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.