add storage gap

[lirona]

also reordered some state vars

Summary by CodeRabbit

• Documentation

  • Improved and clarified comments describing contract variables and storage patterns for better understanding.

• Refactor

  • Updated the syntax and positioning of certain variable declarations for consistency and clarity.

• Chores

  • Added reserved storage slots to multiple contracts to support future upgrades without affecting contract storage layout.

No changes to user-facing functionality.

[coderabbitai]

Walkthrough

The changes update comments and storage patterns in three Solidity contracts: Hyperfund, HyperfundFactory, and Hyperstaker. Comments were revised for clarity, particularly regarding variable initialization and mapping purposes. All three contracts now include a private storage gap array at the end, following OpenZeppelin's upgradeable contract pattern to reserve space for future variables and maintain storage layout compatibility. In Hyperstaker, the stakes mapping declaration was updated to use the latest Solidity syntax with named keys, and the position of the TYPE_MASK constant was adjusted. No functional or control flow logic was modified.

Changes

File(s)	Change Summary
src/Hyperfund.sol	Updated comments clarifying initialization vs immutability; removed obsolete comments; added uint256[23] private __gap; storage gap.
src/HyperfundFactory.sol	Clarified comments on boolean mappings for Hyperfunds and Hyperstakers; added uint256[26] private __gap; storage gap.
src/Hyperstaker.sol	Moved TYPE_MASK constant; updated stakes mapping to named key syntax; removed mapping comment; added uint256[24] private __gap; storage gap with detailed comment.

Poem

In Solidity’s warren, the rabbits hop,
Tidying comments, making storage gaps pop.
With mappings renamed and constants in place,
Future-proof burrows keep contracts in grace.
No logic disturbed, just order and care—
A hop, a skip, and upgrades to spare!
🐇✨

---

📜 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 8705b9f and 46d6575.

📒 Files selected for processing (3)

• src/Hyperfund.sol (2 hunks)
• src/HyperfundFactory.sol (2 hunks)
• src/Hyperstaker.sol (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (3)

• src/HyperfundFactory.sol
• src/Hyperfund.sol
• src/Hyperstaker.sol

---

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.

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (3)

src/Hyperfund.sol (1)

12-12: Clarify use of “immutable” in comment
The comment refers to “immutable values,” yet these aren’t declared with Solidity’s immutable keyword. Consider rewording to “values set at initialization” or marking them immutable if set in the constructor.

src/Hyperstaker.sol (2)

23-24: Refine initialization comment
“Immutable values that are set on initialization” might be misread as using Solidity’s immutable feature. Consider clarifying to “values initialized once by the proxy” to avoid confusion.

🧰 Tools

🪛 GitHub Actions: CI

[error] 23-37: Prettier formatting check failed due to whitespace differences. Run 'forge fmt' to fix code style issues.

---

1-207: Fix formatting with forge fmt
CI indicates Prettier formatting mismatches around lines 23–37. Please run forge fmt (or your code formatter) to align whitespace and pass the formatting checks.

🧰 Tools

🪛 GitHub Actions: CI

[error] 23-37: Prettier formatting check failed due to whitespace differences. Run 'forge fmt' to fix code style issues.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0744ebd and 8705b9f.

📒 Files selected for processing (3)

• src/Hyperfund.sol (2 hunks)
• src/HyperfundFactory.sol (2 hunks)
• src/Hyperstaker.sol (2 hunks)

🧰 Additional context used

🪛 GitHub Actions: CI

src/Hyperstaker.sol

[error] 23-37: Prettier formatting check failed due to whitespace differences. Run 'forge fmt' to fix code style issues.

🔇 Additional comments (6)

src/HyperfundFactory.sol (2)

15-17: Update mapping comment for clarity
The revised comment accurately conveys that hyperfunds and hyperstakers map a hypercert ID to a boolean flag indicating deployment status—improving readability and reducing ambiguity.

---

135-141: Verify storage gap size
You’ve added uint256[26] private __gap; to reserve 26 slots. Please confirm that 26 plus the existing contract state variables aligns with your goal of 30 reserved slots as per OpenZeppelin’s upgradeable pattern.

src/Hyperfund.sol (1)

217-223: Confirm addition of storage gap
The uint256[23] private __gap; follows the OZ upgradeable‐contract pattern. Please verify that reserving 23 slots here, combined with your declared state variables, indeed yields 30 available slots for future growth.

src/Hyperstaker.sol (3)

28-29: Validate named-mapping syntax
You’ve switched to mapping(uint256 hypercertId => Stake stake). Ensure this named-key/value mapping syntax is supported by Solidity v0.8.28—otherwise revert to mapping(uint256 => Stake).

---

31-31: Approve relocation of TYPE_MASK constant
Moving the TYPE_MASK constant above the role declarations improves logical grouping and has no storage impact, since constants don’t occupy slots.

---

199-205: Verify storage gap alignment
The new uint256[24] private __gap; reserves 24 slots. Please double-check that when combined with your declared state variables, it maintains the intended 30-slot buffer for future upgrades.